mlReleaseToolsString.h

Go to the documentation of this file.

// Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
// **InsertLicense** code
//----------------------------------------------------------------------------------

//----------------------------------------------------------------------------------
#pragma once
 
#include "MLReleaseToolsSystem.h"
#include <mlTypeDefs.h>
#include <FMEThirdPartyWarningsDisable.h>
#include <string>
#include <vector>
#include <FMEThirdPartyWarningsRestore.h>
 
ML_START_NAMESPACE
 
class PagedImage;
 
//----------------------------------------------------------------------------------
//----------------------------------------------------------------------------------
namespace ReleaseToolsString {

  extern MLRELEASE_TOOLS_EXPORT const std::string DefaultLineSeparator;

  typedef std::vector< std::string  > StringVector;

  typedef std::vector< StringVector > StringVectorVector;
  
  MLRELEASE_TOOLS_EXPORT std::string replaceAllChars(const std::string &str, 
                                                     char ch1, 
                                                     char ch2);

  MLRELEASE_TOOLS_EXPORT std::string escapeString(const std::string &str);

  MLRELEASE_TOOLS_EXPORT std::string unescapeString(const std::string &str);

  MLRELEASE_TOOLS_EXPORT void replaceAllStr1ByStr2InStr(std::string &inStr,
                                                        const std::string &str1,
                                                        const std::string &str2);
  
  MLRELEASE_TOOLS_EXPORT std::string replaceAllStr1ByStr2(const std::string &inStr,
                                                          const std::string &str1,
                                                          const std::string &str2);
  
  MLRELEASE_TOOLS_EXPORT std::string replaceNewLinesByBrs(const std::string &inStr);

  MLRELEASE_TOOLS_EXPORT std::string replaceBrsByNewLines(const std::string &inStr);

  MLRELEASE_TOOLS_EXPORT bool        endsWith(const std::string &str, const std::string &endStr);

  MLRELEASE_TOOLS_EXPORT std::string terminateWithSingleEndString(const std::string &inStr, 
                                                                  const std::string &endStr);

  MLRELEASE_TOOLS_EXPORT std::string terminateWithSingleEndString(const std::string &inStr,
                                                                  const std::string &endStr,
                                                                  const std::string &endStr2);

  MLRELEASE_TOOLS_EXPORT std::string makeSingleNewlineTerminated(const std::string &inStr);

  MLRELEASE_TOOLS_EXPORT std::string convertLineEndingsToNewLinesOnly(const std::string &inStr);

  MLRELEASE_TOOLS_EXPORT StringVector split(const std::string &value, 
                                            const std::string &sep);

  MLRELEASE_TOOLS_EXPORT StringVector splitAtLineBreaks(const std::string &value);

  MLRELEASE_TOOLS_EXPORT void         removeElements(StringVector &strVec, 
                                                     const std::string &str=std::string());

  
  MLRELEASE_TOOLS_EXPORT std::string toIntStr(int         val, 
                                              signed char fieldWidth=-1, 
                                              bool        padWithZeros=false);

  MLRELEASE_TOOLS_EXPORT std::string toMLIntStr(MLint        val, 
                                                signed char  fieldWidth=-1, 
                                                bool         padWithZeros=false);

  MLRELEASE_TOOLS_EXPORT std::string toMLUIntStr(MLuint      val, 
                                                 signed char fieldWidth=-1, 
                                                 bool        padWithZeros=false);

  MLRELEASE_TOOLS_EXPORT std::string toSize_tStr(size_t      val, 
                                                 signed char fieldWidth=-1, 
                                                 bool        padWithZeros=false);

  MLRELEASE_TOOLS_EXPORT std::string toDblStr(MLdouble    val, 
                                              signed char fieldWidth=-1, 
                                              signed char numDecimalPlaces=-1, 
                                              bool        padWithZeros=false,
                                              bool        considerValAsFloat=false);
 

  MLRELEASE_TOOLS_EXPORT std::vector<size_t> createIndexList(size_t      numIndexes,
                                                             std::string idxExp,
                                                             std::string &resultInfo);

  MLRELEASE_TOOLS_EXPORT void removeDuplicates(std::string &strToShrink, 
                                               char ch = ' ');

  MLRELEASE_TOOLS_EXPORT std::string replaceValuePlaceholders(const std::string              &taggedStr, 
                                                              const PagedImage               *inImg=nullptr,
                                                              const std::vector<std::string> &inputValues = std::vector<std::string>(),
                                                              const std::string              &defaultTagContent="",
                                                              const std::string              &fileType="",
                                                              size_t                         idx=0,
                                                              size_t                         padSize=5);
};
 
ML_END_NAMESPACE