Eclipse SUMO - Simulation of Urban MObility
StringUtils.h
Go to the documentation of this file.
1 /****************************************************************************/
2 // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
3 // Copyright (C) 2001-2024 German Aerospace Center (DLR) and others.
4 // This program and the accompanying materials are made available under the
5 // terms of the Eclipse Public License 2.0 which is available at
6 // https://www.eclipse.org/legal/epl-2.0/
7 // This Source Code may also be made available under the following Secondary
8 // Licenses when the conditions for such availability set forth in the Eclipse
9 // Public License 2.0 are satisfied: GNU General Public License, version 2
10 // or later which is available at
11 // https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
12 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
13 /****************************************************************************/
21 // Some static methods for string processing
22 /****************************************************************************/
23 #pragma once
24 #include <config.h>
25 #include <string>
26 #include <chrono>
27 #include <sstream>
28 #include <iomanip>
29 #include <xercesc/util/XMLString.hpp>
30 #include <utils/common/StdDefs.h>
31 
32 
33 // ===========================================================================
34 // class definitions
35 // ===========================================================================
40 class StringUtils {
41 
42 public:
43 
45  static std::string prune(const std::string& str);
46 
48  static std::string pruneZeros(const std::string& str, int max);
49 
51  static std::string to_lower_case(const std::string& str);
52 
54  static std::string latin1_to_utf8(std::string str);
55 
57  static std::string convertUmlaute(std::string str);
58 
60  static std::string replace(std::string str, const std::string& what, const std::string& by);
61 
63  static std::string substituteEnvironment(const std::string& str, const std::chrono::time_point<std::chrono::system_clock>* const timeRef = nullptr);
64 
66  static bool startsWith(const std::string& str, const std::string prefix);
67 
69  static bool endsWith(const std::string& str, const std::string suffix);
70 
72  static std::string padFront(const std::string& str, int length, char padding);
73 
83  static std::string escapeXML(const std::string& orig, const bool maskDoubleHyphen = false);
84 
86  static std::string emptyString;
87 
89  static std::string urlEncode(const std::string& url, const std::string encodeWhich = "");
90 
92  static std::string urlDecode(const std::string& encoded);
93 
95  static std::string charToHex(unsigned char c);
96 
98  static unsigned char hexToChar(const std::string& str);
99 
104  static int toInt(const std::string& sData);
105 
108  static int toIntSecure(const std::string& sData, int def);
109 
114  static long long int toLong(const std::string& sData);
115 
120  static int hexToInt(const std::string& sData);
121 
126  static double toDouble(const std::string& sData);
127 
130  static double toDoubleSecure(const std::string& sData, const double def);
131 
138  static bool toBool(const std::string& sData);
139 
141  static MMVersion toVersion(const std::string& sData);
142 
146  static inline std::string transcode(const XMLCh* const data) {
147  return transcode(data, (int)XERCES_CPP_NAMESPACE::XMLString::stringLen(data));
148  }
149 
153  static std::string transcode(const XMLCh* const data, int length);
154 
156  static std::string transcodeFromLocal(const std::string& localString);
157 
159  static std::string transcodeToLocal(const std::string& utf8String);
160 
162  static std::string trim_left(const std::string s, const std::string& t = " \t\n");
163 
165  static std::string trim_right(const std::string s, const std::string& t = " \t\n");
166 
168  static std::string trim(const std::string s, const std::string& t = " \t\n");
169 
171  static void resetTranscoder();
172 
174  // variadic function
175  template<typename T, typename... Targs>
176  static const std::string format(const std::string& format, T value, Targs... Fargs) {
177  std::ostringstream os;
178  os << std::fixed << std::setprecision(gPrecision);
179  _format(format.c_str(), os, value, Fargs...);
180  return os.str();
181  }
182 
183 private:
184  static void _format(const char* format, std::ostringstream& os) {
185  os << format;
186  }
187 
189  // variadic function
190  template<typename T, typename... Targs>
191  static void _format(const char* format, std::ostringstream& os, T value, Targs... Fargs) {
192  for (; *format != '\0'; format++) {
193  if (*format == '%') {
194  os << value;
195  _format(format + 1, os, Fargs...); // recursive call
196  return;
197  }
198  os << *format;
199  }
200  }
201 
202  static XERCES_CPP_NAMESPACE::XMLLCPTranscoder* myLCPTranscoder;
203 };
int gPrecision
the precision for floating point outputs
Definition: StdDefs.cpp:26
std::pair< int, double > MMVersion
(M)ajor/(M)inor version for written networks and default version for loading
Definition: StdDefs.h:67
Some static methods for string processing.
Definition: StringUtils.h:40
static std::string pruneZeros(const std::string &str, int max)
Removes trailing zeros (at most 'max')
Definition: StringUtils.cpp:67
static std::string urlEncode(const std::string &url, const std::string encodeWhich="")
encode url (stem from http://bogomip.net/blog/cpp-url-encoding-and-decoding/)
static MMVersion toVersion(const std::string &sData)
to version
static std::string charToHex(unsigned char c)
char to hexadecimal
static std::string urlDecode(const std::string &encoded)
decode url (stem from http://bogomip.net/blog/cpp-url-encoding-and-decoding/)
static long long int toLong(const std::string &sData)
converts a string into the long value described by it by calling the char-type converter,...
static double toDoubleSecure(const std::string &sData, const double def)
converts a string into the integer value described by it
static std::string trim(const std::string s, const std::string &t=" \t\n")
remove leading and trailing whitespace
static std::string to_lower_case(const std::string &str)
Transfers the content to lower case.
Definition: StringUtils.cpp:77
static void _format(const char *format, std::ostringstream &os, T value, Targs... Fargs)
adds a new formatted message
Definition: StringUtils.h:191
static void resetTranscoder()
must be called when shutting down the xml subsystem
static XERCES_CPP_NAMESPACE::XMLLCPTranscoder * myLCPTranscoder
Definition: StringUtils.h:202
static std::string trim_right(const std::string s, const std::string &t=" \t\n")
remove trailing whitespace from string
static void _format(const char *format, std::ostringstream &os)
Definition: StringUtils.h:184
static std::string trim_left(const std::string s, const std::string &t=" \t\n")
remove leading whitespace from string
static std::string replace(std::string str, const std::string &what, const std::string &by)
Replaces all occurrences of the second string by the third string within the first string.
static int hexToInt(const std::string &sData)
converts a string with a hex value into the integer value described by it by calling the char-type co...
static double toDouble(const std::string &sData)
converts a string into the double value described by it by calling the char-type converter
static std::string escapeXML(const std::string &orig, const bool maskDoubleHyphen=false)
Replaces the standard escapes by their XML entities.
static std::string latin1_to_utf8(std::string str)
Transfers from Latin 1 (ISO-8859-1) to UTF-8.
Definition: StringUtils.cpp:87
static std::string prune(const std::string &str)
Removes trailing and leading whitechars.
Definition: StringUtils.cpp:56
static std::string padFront(const std::string &str, int length, char padding)
static std::string convertUmlaute(std::string str)
Converts german "Umlaute" to their latin-version.
static unsigned char hexToChar(const std::string &str)
hexadecimal to char
static const std::string format(const std::string &format, T value, Targs... Fargs)
adds a new formatted message
Definition: StringUtils.h:176
static bool startsWith(const std::string &str, const std::string prefix)
Checks whether a given string starts with the prefix.
static std::string emptyString
An empty string.
Definition: StringUtils.h:86
static bool endsWith(const std::string &str, const std::string suffix)
Checks whether a given string ends with the suffix.
static std::string substituteEnvironment(const std::string &str, const std::chrono::time_point< std::chrono::system_clock > *const timeRef=nullptr)
Replaces an environment variable with its value (similar to bash); syntax for a variable is ${NAME}.
static std::string transcode(const XMLCh *const data)
converts a 0-terminated XMLCh* array (usually UTF-16, stemming from Xerces) into std::string in UTF-8
Definition: StringUtils.h:146
static std::string transcodeToLocal(const std::string &utf8String)
convert a string from UTF-8 to the local codepage
static int toIntSecure(const std::string &sData, int def)
converts a string into the integer value described by it
static std::string transcodeFromLocal(const std::string &localString)
convert a string from the local codepage to UTF-8
static int toInt(const std::string &sData)
converts a string into the integer value described by it by calling the char-type converter,...
static bool toBool(const std::string &sData)
converts a string into the bool value described by it by calling the char-type converter