developer.intra2net.com Git - libi2ncommon/blob - src/stringfunc.hxx

   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 */
  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
  32  */
  33
  34 #ifndef __STRINGFUNC_HXX
  35 #define __STRINGFUNC_HXX
  36
  37 #include <list>
  38 #include <string>
  39 #include <sstream>
  40 #include <stdexcept>
  41 #include <sys/types.h>
  42
  43 namespace I2n
  44 {
  45
  46 /*
  47 ** some useful constants:
  48 */
  49
  50 extern const std::string Whitespaces;
  51 extern const std::string LineEndings;
  52
  53
  54 /*
  55 ** predicates:
  56 */
  57
  58
  59 bool has_prefix(const std::string& str, const std::string& prefix);
  60
  61 bool has_suffix(const std::string& str, const std::string& suffix);
  62
  63
  64 /*
  65 ** tool functions(modifying):
  66 */
  67
  68 std::string trim_mod(std::string& str, const std::string& charlist = Whitespaces);
  69
  70 std::string chomp_mod(std::string& str, const std::string& what= LineEndings );
  71
  72 std::string to_lower_mod(std::string& str);
  73
  74 std::string to_upper_mod(std::string& str);
  75
  76
  77 /*
  78 ** tool functions (not modifying):
  79 */
  80
  81 std::string trim(const std::string& str, const std::string& charlist = Whitespaces);
  82
  83 std::string chomp(const std::string& str, const std::string& what= LineEndings );
  84
  85 std::string to_lower(const std::string& str);
  86
  87 std::string to_upper(const std::string& str);
  88
  89
  90 std::string remove_suffix(const std::string& str, const std::string& suffix);
  91
  92 std::string remove_prefix(const std::string& str, const std::string& prefix);
  93
  94
  95
  96 /*
  97 ** split and join:
  98 */
  99
 100
 101 bool pair_split(
 102    const std::string& str,
 103    std::string& key,
 104    std::string& value,
 105    char delimiter = '=');
 106
 107
 108 void split_string(
 109    const std::string& str,
 110    std::list< std::string >& result,
 111    const std::string& delimiter= "\n",
 112    bool omit_empty= false,
 113    const std::string& trim_list= std::string()
 114 );
 115
 116 std::list< std::string > split_string(
 117    const std::string& str,
 118    const std::string& delimiter = "\n",
 119    bool omit_empty= false,
 120    const std::string& trim_list= std::string()
 121 );
 122
 123
 124 std::string join_string(
 125    const std::list< std::string >& parts,
 126    const std::string& delimiter = "\n"
 127 );
 128
 129
 130 /*
 131 ** conversions:
 132 */
 133
 134
 135 std::string convert_binary_to_hex(const std::string&str, bool upper_case_digits= false);
 136
 137 std::string convert_hex_to_binary(const std::string& str) throw(std::runtime_error);
 138
 139
 140 /*
 141 ** "type conversions":
 142 */
 143
 144
 145 /**
 146  * convert a datatype @a T to a string via string stream.
 147  *
 148  * @param s the string which should be converted to @a T.
 149  * @return the value of type T.
 150  */
 151 template<
 152 class T
 153 >
 154 T string_to(const std::string& s)
 155 {
 156    std::istringstream istr(s);
 157    T result;
 158    istr >> result;
 159    return result;
 160 } // eo string_to(const std::string&)
 161
 162
 163 /**
 164  * convert a datatype @a T to a string via string stream.
 165  *
 166  * @param s the string which should be converted to @a T.
 167  * @param result the resulting value of type @a T.
 168  * @return @a true iff the internal string stream was EOF after the conversion.
 169  *
 170  * @attention: does not return if the conversion was successful. So check for empty strings before.
 171  */
 172 template<
 173 class T
 174 >
 175 bool string_to(const std::string& s, T& result)
 176 {
 177    std::istringstream istr(s);
 178    istr >> result;
 179    return istr.eof();
 180 } // eo string_to(const std::string&)
 181
 182
 183 /**
 184  * convert string in hexadecimal notation to a datatype @a T
 185  * supports strings with and without "0x" notation, e.g. 0xff and FF are both valid
 186  *
 187  * @param s the hex string which should be converted to @a T.
 188  * @return the value of type T.
 189  */
 190 template<
 191 class T
 192 >
 193 T hex_string_to(const std::string& s)
 194 {
 195    std::istringstream istr(s);
 196    T result;
 197    istr >> std::hex >> result;
 198    return result;
 199 } // eo string_to(const std::string&)
 200
 201
 202 /**
 203  * convert string in hexadecimal notation to a datatype @a T
 204  * supports strings with and without "0x" notation, e.g. 0xff and FF are both valid
 205  *
 206  * @param s the hex string which should be converted to @a T.
 207  * @param result the resulting value of type @a T.
 208  * @return @a true iff the internal string stream was EOF after the conversion.
 209  *
 210  * @attention: does not return if the conversion was successful. So check for empty strings before.
 211  */
 212 template<
 213 class T
 214 >
 215 bool hex_string_to(const std::string& s, T& result)
 216 {
 217    std::istringstream istr(s);
 218    istr >> std::hex >> result;
 219    return istr.eof();
 220 } // eo string_to(const std::string&)
 221
 222
 223 /**
 224  * convert a string to another datatype @a T via string stream.
 225  *
 226  * @param v the value (of type @a T) which should be converted to a string.
 227  * @return the resulting string.
 228  */
 229 template<
 230 class T
 231 >
 232 std::string to_string(const T& v)
 233 {
 234    std::ostringstream ostr;
 235    ostr << v;
 236    return ostr.str();
 237 } // eo to_string(const T&)
 238
 239
 240 } // eo namespace I2n
 241
 242
 243 #if 0
 244 std::string to_lower(const std::string &src);
 245 std::string to_upper(const std::string &src);
 246 #else
 247 // compatibility: import lower/upper funcs from I2n:
 248 using I2n::to_lower;
 249 using I2n::to_upper;
 250 #endif
 251
 252
 253 enum UnitBase {
 254     UnitBase1000, // SI decimal, composed by multiples of 1000 (KB, MB, etc.)
 255     UnitBase1024 // IEC binary, composed by multiples of 1024 (KiB, MiB, etc. )
 256 };
 257
 258 enum UnitFormat {
 259     ShortUnitFormat, // B, KB, MB, ...
 260     LongUnitFormat // Byte, KByte, MByte, ...
 261 };
 262
 263 std::string nice_unit_format(
 264         const int64_t input,
 265         const UnitFormat format = ShortUnitFormat,
 266         const UnitBase base = UnitBase1024
 267 );
 268
 269 std::string nice_unit_format(
 270         const double input,
 271         const UnitFormat format = ShortUnitFormat,
 272         const UnitBase base = UnitBase1024
 273 );
 274
 275 bool replace_all(std::string &base, const std::string *ist, const std::string *soll);
 276 bool replace_all(std::string &base, const char *ist, const char *soll);
 277 bool replace_all(std::string &base, const char *ist, const std::string *soll);
 278 bool replace_all(std::string &base, const std::string &ist, const char *soll);
 279 bool replace_all(std::string &base, const std::string &ist, const std::string &soll);
 280
 281 std::string iso_to_utf8(const std::string& isostring);
 282 std::string utf8_to_iso(const std::string& utf8string);
 283 std::string utf7imap_to_utf8(const std::string &utf7imapstring);
 284 std::string utf8_to_utf7imap(const std::string &utf8string);
 285
 286 std::string strip_html_tags(const std::string &input);
 287 std::string smart_html_entities(const std::string &input);
 288 std::string html_entities(std::string str);
 289 std::string html_entities_to_console(std::string str);
 290
 291 std::string sanitize_for_logging(const std::string &str, const char replace_with='?');
 292
 293 std::string escape(const std::string &s);
 294
 295 std::string descape(const std::string &s, int startpos, int &endpos);
 296 inline std::string descape(const std::string &s)
 297 {
 298    int endpos;
 299    return descape(s,0,endpos);
 300 }
 301
 302 std::string escape_shellarg(const std::string &input);
 303
 304 #endif