Line data Source code
1 : /****************************************************************************/
2 : // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
3 : // Copyright (C) 2001-2025 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 : /****************************************************************************/
14 : /// @file StringUtils.h
15 : /// @author Daniel Krajzewicz
16 : /// @author Jakob Erdmann
17 : /// @author Michael Behrisch
18 : /// @author Robert Hilbrich
19 : /// @date unknown
20 : ///
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 : // ===========================================================================
36 : /**
37 : * @class StringUtils
38 : * @brief Some static methods for string processing
39 : */
40 : class StringUtils {
41 :
42 : public:
43 :
44 : /// @brief Removes trailing and leading whitechars
45 : static std::string prune(const std::string& str);
46 :
47 : /// @brief Removes trailing zeros (at most 'max')
48 : static std::string pruneZeros(const std::string& str, int max);
49 :
50 : /// @brief Transfers the content to lower case
51 : static std::string to_lower_case(const std::string& str);
52 :
53 : /// @brief Transfers from Latin 1 (ISO-8859-1) to UTF-8
54 : static std::string latin1_to_utf8(std::string str);
55 :
56 : /// @brief Converts german "Umlaute" to their latin-version
57 : static std::string convertUmlaute(std::string str);
58 :
59 : /// @brief Replaces all occurrences of the second string by the third string within the first string
60 : static std::string replace(std::string str, const std::string& what, const std::string& by);
61 :
62 : /// @brief Replaces an environment variable with its value (similar to bash); syntax for a variable is ${NAME}
63 : static std::string substituteEnvironment(const std::string& str, const std::chrono::time_point<std::chrono::system_clock>* const timeRef = nullptr);
64 :
65 : /// @brief Returns an ISO8601 formatted time string with microsecond precision
66 : static std::string isoTimeString(const std::chrono::time_point<std::chrono::system_clock>* const timeRef = nullptr);
67 :
68 : ///@brief Checks whether a given string starts with the prefix
69 : static bool startsWith(const std::string& str, const std::string prefix);
70 :
71 : /// @brief Checks whether a given string ends with the suffix
72 : static bool endsWith(const std::string& str, const std::string suffix);
73 :
74 : //// @brief pads the given string with padding character up to the given total length
75 : static std::string padFront(const std::string& str, int length, char padding);
76 :
77 : /**
78 : * @brief Replaces the standard escapes by their XML entities.
79 : *
80 : * The strings &, <, >, ", and ' are replaced by &, <, >, ", and '
81 : *
82 : * @param[in] orig The original string
83 : * @param[in] maskDoubleHyphen Whether -- in input shall be converted to -- (semantically equivalent but allowed in XML comments)
84 : * @return the string with the escaped sequences
85 : */
86 : static std::string escapeXML(const std::string& orig, const bool maskDoubleHyphen = false);
87 :
88 : /**
89 : * @brief Escape special characters with backslash
90 : */
91 : static std::string escapeShell(const std::string& orig);
92 :
93 : /// @brief An empty string
94 : static std::string emptyString;
95 :
96 : /// @brief encode url (stem from http://bogomip.net/blog/cpp-url-encoding-and-decoding/)
97 : static std::string urlEncode(const std::string& url, const std::string encodeWhich = "");
98 :
99 : /// @brief decode url (stem from http://bogomip.net/blog/cpp-url-encoding-and-decoding/)
100 : static std::string urlDecode(const std::string& encoded);
101 :
102 : /// @brief char to hexadecimal
103 : static std::string charToHex(unsigned char c);
104 :
105 : /// @brief hexadecimal to char
106 : static unsigned char hexToChar(const std::string& str);
107 :
108 : /**@brief converts a string into the integer value described by it by calling the char-type converter, which
109 : * @throw an EmptyData - exception if the given string is empty
110 : * @throw NumberFormatException - exception when the string does not contain an integer
111 : */
112 : static int toInt(const std::string& sData);
113 :
114 : /// @brief check if the given sData can be converted to int
115 : static bool isInt(const std::string& sData);
116 :
117 : /// @brief converts a string into the integer value described by it
118 : /// @return the default value if the data is empty
119 : static int toIntSecure(const std::string& sData, int def);
120 :
121 : /**@brief converts a string into the long value described by it by calling the char-type converter, which
122 : * @throw an EmptyData - exception if the given string is empty
123 : * @throw NumberFormatException - exception when the string does not contain a long integer
124 : */
125 : static long long int toLong(const std::string& sData);
126 :
127 : /// @brief Check if the given sData can be converted to long
128 : static bool isLong(const std::string& sData);
129 :
130 : /**@brief converts a string with a hex value into the integer value described by it by calling the char-type converter
131 : * @throw an EmptyData - exception if the given string is empty
132 : * @throw a NumberFormatException - exception when the string does not contain an integer
133 : */
134 : static int hexToInt(const std::string& sData);
135 :
136 : /// @brief check if the given string can be converted to hex
137 : static bool isHex(std::string sData);
138 :
139 : /**@brief converts a string into the double value described by it by calling the char-type converter
140 : * @throw an EmptyData - exception if the given string is empty
141 : * @throw a NumberFormatException - exception when the string does not contain a double
142 : */
143 : static double toDouble(const std::string& sData);
144 :
145 : /// @brief check if the given sData can be conveted to double
146 : static bool isDouble(const std::string& sData);
147 :
148 : /// @brief converts a string into the integer value described by it
149 : /// @return the default value if the data is empty
150 : static double toDoubleSecure(const std::string& sData, const double def);
151 :
152 : /**@brief converts a string into the bool value described by it by calling the char-type converter
153 : * @return true if the sData is one of the following (case insensitive): '1', 'x', 'true', 'yes', 'on', 't'
154 : * @return false if the sData is one of the following (case insensitive): '0', '-', 'false', 'no', 'off', 'f'
155 : * @throw EmptyData - exception if the given string is empty
156 : * @throw BoolFormatException in any other case
157 : */
158 : static bool toBool(const std::string& sData);
159 :
160 : /// @brief check if the given value can be converted to bool
161 : static bool isBool(const std::string& sData);
162 :
163 : /// @brief parse a (network) version string
164 : static MMVersion toVersion(const std::string& sData);
165 :
166 : /// @brief parse a distance, length or width value with a unit
167 : static double parseDist(const std::string& sData);
168 :
169 : /// @brief parse a speed value with a unit
170 : static double parseSpeed(const std::string& sData, const bool defaultKmph = true);
171 :
172 : /**@brief converts a 0-terminated XMLCh* array (usually UTF-16, stemming from Xerces) into std::string in UTF-8
173 : * @throw an EmptyData - exception if the given pointer is 0
174 : */
175 94225139 : static inline std::string transcode(const XMLCh* const data) {
176 94225139 : return transcode(data, (int)XERCES_CPP_NAMESPACE::XMLString::stringLen(data));
177 : }
178 :
179 : /**@brief converts a 0-terminated XMLCh* array (usually UTF-16, stemming from Xerces) into std::string in UTF-8 considering the given length
180 : * @throw EmptyData if the given pointer is 0
181 : */
182 : static std::string transcode(const XMLCh* const data, int length);
183 :
184 : /// @brief convert a string from the local codepage to UTF-8
185 : static std::string transcodeFromLocal(const std::string& localString);
186 :
187 : /// @brief convert a string from UTF-8 to the local codepage
188 : static std::string transcodeToLocal(const std::string& utf8String);
189 :
190 : /// @brief remove leading whitespace from string
191 : static std::string trim_left(const std::string s, const std::string& t = " \t\n");
192 :
193 : /// @brief remove trailing whitespace from string
194 : static std::string trim_right(const std::string s, const std::string& t = " \t\n");
195 :
196 : /// @brief remove leading and trailing whitespace
197 : static std::string trim(const std::string s, const std::string& t = " \t\n");
198 :
199 : /// @brief remove leading and trailing whitespace
200 : static std::string wrapText(const std::string s, int width);
201 :
202 : /// @brief write with maximum precision if needed but remove trailing zeros
203 : static std::string adjustDecimalValue(double value, int precision);
204 :
205 : /// @brief must be called when shutting down the xml subsystem
206 : static void resetTranscoder();
207 :
208 : /// @brief adds a new formatted message
209 : // variadic function
210 : template<typename T, typename... Targs>
211 2227816 : static const std::string format(const std::string& format, T value, Targs... Fargs) {
212 2227816 : std::ostringstream os;
213 2227816 : os << std::fixed << std::setprecision(gPrecision);
214 4454580 : _format(format.c_str(), os, value, Fargs...);
215 2227816 : return os.str();
216 2227816 : }
217 :
218 : private:
219 : static void _format(const char* format, std::ostringstream& os) {
220 2227816 : os << format;
221 : }
222 :
223 : /// @brief adds a new formatted message
224 : // variadic function
225 : template<typename T, typename... Targs>
226 5990772 : static void _format(const char* format, std::ostringstream& os, T value, Targs... Fargs) {
227 93472015 : for (; *format != '\0'; format++) {
228 93472015 : if (*format == '%') {
229 5990772 : os << value;
230 7770511 : _format(format + 1, os, Fargs...); // recursive call
231 5990772 : return;
232 : }
233 87481243 : os << *format;
234 : }
235 : }
236 :
237 : static XERCES_CPP_NAMESPACE::XMLLCPTranscoder* myLCPTranscoder;
238 : };
|
