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