Commit | Line | Data |
---|---|---|
0e23f538 TJ |
1 | /* |
2 | The software in this package is distributed under the GNU General | |
3 | Public License version 2 (with a special exception described below). | |
4 | ||
5 | A copy of GNU General Public License (GPL) is included in this distribution, | |
6 | in the file COPYING.GPL. | |
7 | ||
8 | As a special exception, if other files instantiate templates or use macros | |
9 | or inline functions from this file, or you compile this file and link it | |
10 | with other works to produce a work based on this file, this file | |
11 | does not by itself cause the resulting work to be covered | |
12 | by the GNU General Public License. | |
13 | ||
14 | However the source code for this file must still be made available | |
15 | in accordance with section (3) of the GNU General Public License. | |
16 | ||
17 | This exception does not invalidate any other reasons why a work based | |
18 | on this file might be covered by the GNU General Public License. | |
19 | */ | |
6a93d84a TJ |
20 | /** @file |
21 | * @brief collection of string tools (/ functions). | |
22 | * | |
23 | * contains a collection of miscellaneous functions for dealing with strings. | |
24 | * | |
25 | * some functions (like trim, lower case, upper case ...) are available in two versions: | |
26 | * - a modifying one (suffix "Mod") which modifies the given string argument in place. | |
27 | * - a non modifying one which take a constant string reference and returns a new string. | |
28 | * . | |
29 | * | |
30 | * | |
31 | * (c) Copyright 2007-2008 by Intra2net AG | |
6a93d84a | 32 | */ |
e93545dd GE |
33 | |
34 | #ifndef __STRINGFUNC_HXX | |
35 | #define __STRINGFUNC_HXX | |
36 | ||
5ad80381 | 37 | #include <stdio.h> |
6a93d84a | 38 | #include <list> |
5ad80381 | 39 | #include <numeric> |
0aaf13b5 | 40 | #include <set> |
376ec4fa | 41 | #include <vector> |
e93545dd | 42 | #include <string> |
6a93d84a TJ |
43 | #include <sstream> |
44 | #include <stdexcept> | |
b04b4f7e | 45 | #include <sys/types.h> |
6a93d84a | 46 | |
6ab3bc95 RP |
47 | namespace I2n |
48 | { | |
6a93d84a TJ |
49 | |
50 | /* | |
51 | ** some useful constants: | |
52 | */ | |
53 | ||
6ab3bc95 RP |
54 | extern const std::string Whitespaces; |
55 | extern const std::string LineEndings; | |
6a93d84a TJ |
56 | |
57 | ||
58 | /* | |
59 | ** predicates: | |
60 | */ | |
61 | ||
62 | ||
6ab3bc95 | 63 | bool has_prefix(const std::string& str, const std::string& prefix); |
6a93d84a | 64 | |
6ab3bc95 | 65 | bool has_suffix(const std::string& str, const std::string& suffix); |
6a93d84a TJ |
66 | |
67 | ||
68 | /* | |
6ab3bc95 | 69 | ** tool functions(modifying): |
6a93d84a TJ |
70 | */ |
71 | ||
6ab3bc95 | 72 | std::string trim_mod(std::string& str, const std::string& charlist = Whitespaces); |
6a93d84a | 73 | |
6ab3bc95 | 74 | std::string chomp_mod(std::string& str, const std::string& what= LineEndings ); |
6a93d84a | 75 | |
6ab3bc95 | 76 | std::string to_lower_mod(std::string& str); |
6a93d84a | 77 | |
6ab3bc95 | 78 | std::string to_upper_mod(std::string& str); |
6a93d84a TJ |
79 | |
80 | ||
81 | /* | |
82 | ** tool functions (not modifying): | |
83 | */ | |
84 | ||
6ab3bc95 | 85 | std::string trim(const std::string& str, const std::string& charlist = Whitespaces); |
6a93d84a | 86 | |
6ab3bc95 | 87 | std::string chomp(const std::string& str, const std::string& what= LineEndings ); |
6a93d84a | 88 | |
6ab3bc95 | 89 | std::string to_lower(const std::string& str); |
6a93d84a | 90 | |
6ab3bc95 | 91 | std::string to_upper(const std::string& str); |
6a93d84a TJ |
92 | |
93 | ||
6ab3bc95 | 94 | std::string remove_suffix(const std::string& str, const std::string& suffix); |
6a93d84a | 95 | |
6ab3bc95 | 96 | std::string remove_prefix(const std::string& str, const std::string& prefix); |
6a93d84a TJ |
97 | |
98 | ||
99 | ||
100 | /* | |
101 | ** split and join: | |
102 | */ | |
103 | ||
104 | ||
6ab3bc95 RP |
105 | bool pair_split( |
106 | const std::string& str, | |
107 | std::string& key, | |
108 | std::string& value, | |
109 | char delimiter = '='); | |
6a93d84a TJ |
110 | |
111 | ||
6ab3bc95 RP |
112 | void split_string( |
113 | const std::string& str, | |
114 | std::list< std::string >& result, | |
115 | const std::string& delimiter= "\n", | |
116 | bool omit_empty= false, | |
117 | const std::string& trim_list= std::string() | |
6a93d84a TJ |
118 | ); |
119 | ||
338da253 CH |
120 | void split_string( |
121 | const std::string& str, | |
122 | std::vector< std::string >& result, | |
123 | const std::string& delimiter= "\n", | |
124 | bool omit_empty= false, | |
125 | const std::string& trim_list= std::string() | |
126 | ); | |
127 | ||
6ab3bc95 RP |
128 | std::list< std::string > split_string( |
129 | const std::string& str, | |
130 | const std::string& delimiter = "\n", | |
131 | bool omit_empty= false, | |
132 | const std::string& trim_list= std::string() | |
6a93d84a TJ |
133 | ); |
134 | ||
5ad80381 PG |
135 | struct concatenator { |
136 | std::string delim; | |
6a93d84a | 137 | |
5ad80381 | 138 | concatenator (const std::string &delim) : delim (delim) { } |
6a93d84a | 139 | |
5ad80381 PG |
140 | inline std::string operator() (const std::string &acc, const std::string &elt) const |
141 | { return acc + delim + elt; } | |
142 | }; | |
376ec4fa | 143 | |
5ad80381 PG |
144 | template<typename Iter> |
145 | std::string | |
146 | join_string ( | |
147 | Iter first, | |
148 | Iter last, | |
149 | const std::string &delimiter = "\n" | |
150 | ) | |
151 | { | |
152 | if (first == last) { return ""; } | |
153 | ||
154 | const std::string &init = *first++; | |
155 | if (first == last) { return init; } | |
156 | ||
157 | return std::accumulate (first, last, init, concatenator (delimiter)); | |
158 | } | |
159 | ||
160 | /** | |
161 | * @brief joins a container of strings into a single string. | |
162 | * | |
163 | * This funtion is (basically) the reverse operation of @a split_string. | |
164 | * | |
165 | * @param parts the container of strings. | |
166 | * @param delimiter the delimiter to insert between the strings. | |
167 | * @return the joined string. | |
168 | */ | |
169 | template<typename Cont> | |
170 | inline std::string join_string( | |
171 | const Cont& parts, | |
0aaf13b5 | 172 | const std::string& delimiter = "\n" |
5ad80381 PG |
173 | ) |
174 | { return join_string (parts.begin (), parts.end (), delimiter); } | |
0aaf13b5 PG |
175 | |
176 | std::string join_string( | |
4f7a7b9f PG |
177 | const char *const parts [], |
178 | const std::string& delimiter = "\n" | |
179 | ); | |
180 | ||
6a93d84a TJ |
181 | /* |
182 | ** conversions: | |
183 | */ | |
184 | ||
185 | ||
6ab3bc95 | 186 | std::string convert_binary_to_hex(const std::string&str, bool upper_case_digits= false); |
6a93d84a | 187 | |
6ab3bc95 | 188 | std::string convert_hex_to_binary(const std::string& str) throw(std::runtime_error); |
6a93d84a TJ |
189 | |
190 | ||
6a93d84a TJ |
191 | /* |
192 | ** "type conversions": | |
193 | */ | |
194 | ||
195 | ||
196 | /** | |
197 | * convert a datatype @a T to a string via string stream. | |
198 | * | |
1fe2e899 CH |
199 | * This will not report trouble in conversion; for example: |
200 | * string_to<int>("christian") | |
201 | * will return 0 and not throw an error. | |
202 | * Use boost::lexical_cast<T>(string) to get error-checked results. | |
203 | * | |
6a93d84a TJ |
204 | * @param s the string which should be converted to @a T. |
205 | * @return the value of type T. | |
206 | */ | |
207 | template< | |
6ab3bc95 | 208 | class T |
6a93d84a | 209 | > |
6ab3bc95 | 210 | T string_to(const std::string& s) |
6a93d84a | 211 | { |
6ab3bc95 RP |
212 | std::istringstream istr(s); |
213 | T result; | |
214 | istr >> result; | |
215 | return result; | |
216 | } // eo string_to(const std::string&) | |
6a93d84a TJ |
217 | |
218 | ||
219 | /** | |
220 | * convert a datatype @a T to a string via string stream. | |
221 | * | |
222 | * @param s the string which should be converted to @a T. | |
223 | * @param result the resulting value of type @a T. | |
224 | * @return @a true iff the internal string stream was EOF after the conversion. | |
08f2d184 GE |
225 | * |
226 | * @attention: does not return if the conversion was successful. So check for empty strings before. | |
6a93d84a TJ |
227 | */ |
228 | template< | |
6ab3bc95 | 229 | class T |
6a93d84a | 230 | > |
6ab3bc95 | 231 | bool string_to(const std::string& s, T& result) |
6a93d84a | 232 | { |
6ab3bc95 RP |
233 | std::istringstream istr(s); |
234 | istr >> result; | |
235 | return istr.eof(); | |
236 | } // eo string_to(const std::string&) | |
6a93d84a TJ |
237 | |
238 | ||
239 | /** | |
3bcc713f GE |
240 | * convert string in hexadecimal notation to a datatype @a T |
241 | * supports strings with and without "0x" notation, e.g. 0xff and FF are both valid | |
242 | * | |
243 | * @param s the hex string which should be converted to @a T. | |
244 | * @return the value of type T. | |
245 | */ | |
246 | template< | |
247 | class T | |
248 | > | |
249 | T hex_string_to(const std::string& s) | |
250 | { | |
251 | std::istringstream istr(s); | |
252 | T result; | |
253 | istr >> std::hex >> result; | |
254 | return result; | |
255 | } // eo string_to(const std::string&) | |
256 | ||
257 | ||
258 | /** | |
259 | * convert string in hexadecimal notation to a datatype @a T | |
260 | * supports strings with and without "0x" notation, e.g. 0xff and FF are both valid | |
261 | * | |
262 | * @param s the hex string which should be converted to @a T. | |
263 | * @param result the resulting value of type @a T. | |
264 | * @return @a true iff the internal string stream was EOF after the conversion. | |
265 | * | |
266 | * @attention: does not return if the conversion was successful. So check for empty strings before. | |
267 | */ | |
268 | template< | |
269 | class T | |
270 | > | |
271 | bool hex_string_to(const std::string& s, T& result) | |
272 | { | |
273 | std::istringstream istr(s); | |
274 | istr >> std::hex >> result; | |
275 | return istr.eof(); | |
276 | } // eo string_to(const std::string&) | |
277 | ||
278 | ||
279 | /** | |
6a93d84a TJ |
280 | * convert a string to another datatype @a T via string stream. |
281 | * | |
282 | * @param v the value (of type @a T) which should be converted to a string. | |
283 | * @return the resulting string. | |
284 | */ | |
285 | template< | |
6ab3bc95 | 286 | class T |
6a93d84a | 287 | > |
6ab3bc95 | 288 | std::string to_string(const T& v) |
6a93d84a | 289 | { |
6ab3bc95 RP |
290 | std::ostringstream ostr; |
291 | ostr << v; | |
292 | return ostr.str(); | |
293 | } // eo to_string(const T&) | |
294 | ||
295 | ||
1a0267e5 CH |
296 | /** |
297 | * Create a string with types shortened in texts describing C++ types | |
298 | * | |
299 | * for example: std::list<some_long_type, std::allocator<some_long_type> > | |
300 | * --> std::list<some_long_type, _alloc_> | |
301 | * | |
302 | * and std::basic_string<char, std::char_traits<char>, std::allocator<char> > | |
303 | * --> std::string | |
304 | */ | |
305 | std::string shorten_stl_types(const std::string &input); | |
306 | ||
1ebab1e3 TJ |
307 | std::string base64_encode(const std::string &input, bool one_line=true); |
308 | std::string base64_decode(const std::string &input, bool one_line=true); | |
1a0267e5 | 309 | |
6ab3bc95 RP |
310 | } // eo namespace I2n |
311 | ||
6a93d84a | 312 | |
e5b21dbb | 313 | #if 0 |
6ab3bc95 RP |
314 | std::string to_lower(const std::string &src); |
315 | std::string to_upper(const std::string &src); | |
e5b21dbb RP |
316 | #else |
317 | // compatibility: import lower/upper funcs from I2n: | |
318 | using I2n::to_lower; | |
319 | using I2n::to_upper; | |
320 | #endif | |
e93545dd | 321 | |
81267544 | 322 | |
8f296924 GMF |
323 | enum UnitBase { |
324 | UnitBase1000, // SI decimal, composed by multiples of 1000 (KB, MB, etc.) | |
325 | UnitBase1024 // IEC binary, composed by multiples of 1024 (KiB, MiB, etc. ) | |
81267544 GMF |
326 | }; |
327 | ||
8f296924 GMF |
328 | enum UnitFormat { |
329 | ShortUnitFormat, // B, KB, MB, ... | |
330 | LongUnitFormat // Byte, KByte, MByte, ... | |
d1ea9075 GMF |
331 | }; |
332 | ||
81267544 GMF |
333 | std::string nice_unit_format( |
334 | const int64_t input, | |
ee037ee3 GMF |
335 | const UnitFormat format = ShortUnitFormat, |
336 | const UnitBase base = UnitBase1024 | |
81267544 | 337 | ); |
e93545dd | 338 | |
5cd64148 CH |
339 | std::string nice_unit_format( |
340 | const double input, | |
341 | const UnitFormat format = ShortUnitFormat, | |
342 | const UnitBase base = UnitBase1024 | |
343 | ); | |
344 | ||
e93545dd GE |
345 | bool replace_all(std::string &base, const std::string *ist, const std::string *soll); |
346 | bool replace_all(std::string &base, const char *ist, const char *soll); | |
347 | bool replace_all(std::string &base, const char *ist, const std::string *soll); | |
348 | bool replace_all(std::string &base, const std::string &ist, const char *soll); | |
349 | bool replace_all(std::string &base, const std::string &ist, const std::string &soll); | |
350 | ||
351 | std::string iso_to_utf8(const std::string& isostring); | |
352 | std::string utf8_to_iso(const std::string& utf8string); | |
13cc4db1 | 353 | std::string utf7imap_to_utf8(const std::string &utf7imapstring); |
6a2b6dd1 | 354 | std::string utf8_to_utf7imap(const std::string &utf8string); |
118e216e TJ |
355 | |
356 | std::string strip_html_tags(const std::string &input); | |
357 | std::string smart_html_entities(const std::string &input); | |
358 | std::string html_entities(std::string str); | |
554f813d | 359 | std::string html_entities_to_console(std::string str); |
118e216e | 360 | |
dfc07029 PG |
361 | inline std::string html_entities_iso (const std::string &str) |
362 | { | |
363 | return html_entities (iso_to_utf8 (str)); | |
364 | } | |
365 | ||
3f5c5ccd | 366 | typedef std::pair<std::string::size_type, std::string::size_type> CommentZone; |
46dd1321 | 367 | std::vector<CommentZone> find_html_comments(const std::string &str); |
3f5c5ccd CH |
368 | void remove_html_comments(std::string &str); |
369 | void remove_html_comments(std::string &str, const std::vector<CommentZone> &comments); | |
370 | ||
b953bf36 GE |
371 | std::string sanitize_for_logging(const std::string &str, const char replace_with='?'); |
372 | ||
47c07fba GE |
373 | std::string escape(const std::string &s); |
374 | ||
375 | std::string descape(const std::string &s, int startpos, int &endpos); | |
e6da286a | 376 | inline std::string descape(const std::string &s) |
47c07fba | 377 | { |
6ab3bc95 RP |
378 | int endpos; |
379 | return descape(s,0,endpos); | |
47c07fba GE |
380 | } |
381 | ||
382 | std::string escape_shellarg(const std::string &input); | |
383 | ||
e93545dd | 384 | #endif |