+/*
+The software in this package is distributed under the GNU General
+Public License version 2 (with a special exception described below).
+
+A copy of GNU General Public License (GPL) is included in this distribution,
+in the file COPYING.GPL.
+
+As a special exception, if other files instantiate templates or use macros
+or inline functions from this file, or you compile this file and link it
+with other works to produce a work based on this file, this file
+does not by itself cause the resulting work to be covered
+by the GNU General Public License.
+
+However the source code for this file must still be made available
+in accordance with section (3) of the GNU General Public License.
+
+This exception does not invalidate any other reasons why a work based
+on this file might be covered by the GNU General Public License.
+*/
/** @file
* @brief collection of string tools (/ functions).
*
*
*
* (c) Copyright 2007-2008 by Intra2net AG
- *
- * info@intra2net.com
*/
#ifndef __STRINGFUNC_HXX
#define __STRINGFUNC_HXX
#include <list>
+#include <vector>
#include <string>
#include <sstream>
#include <stdexcept>
const std::string& delimiter = "\n"
);
+std::string join_string(
+ const std::vector< std::string >& parts,
+ const std::string& delimiter = "\n"
+);
+
/*
** conversions:
std::string convert_hex_to_binary(const std::string& str) throw(std::runtime_error);
-
/*
** "type conversions":
*/
/**
* convert a datatype @a T to a string via string stream.
*
+ * This will not report trouble in conversion; for example:
+ * string_to<int>("christian")
+ * will return 0 and not throw an error.
+ * Use boost::lexical_cast<T>(string) to get error-checked results.
+ *
* @param s the string which should be converted to @a T.
* @return the value of type T.
*/
* @param s the string which should be converted to @a T.
* @param result the resulting value of type @a T.
* @return @a true iff the internal string stream was EOF after the conversion.
+ *
+ * @attention: does not return if the conversion was successful. So check for empty strings before.
*/
template<
class T
/**
+ * convert string in hexadecimal notation to a datatype @a T
+ * supports strings with and without "0x" notation, e.g. 0xff and FF are both valid
+ *
+ * @param s the hex string which should be converted to @a T.
+ * @return the value of type T.
+ */
+template<
+class T
+>
+T hex_string_to(const std::string& s)
+{
+ std::istringstream istr(s);
+ T result;
+ istr >> std::hex >> result;
+ return result;
+} // eo string_to(const std::string&)
+
+
+/**
+ * convert string in hexadecimal notation to a datatype @a T
+ * supports strings with and without "0x" notation, e.g. 0xff and FF are both valid
+ *
+ * @param s the hex string which should be converted to @a T.
+ * @param result the resulting value of type @a T.
+ * @return @a true iff the internal string stream was EOF after the conversion.
+ *
+ * @attention: does not return if the conversion was successful. So check for empty strings before.
+ */
+template<
+class T
+>
+bool hex_string_to(const std::string& s, T& result)
+{
+ std::istringstream istr(s);
+ istr >> std::hex >> result;
+ return istr.eof();
+} // eo string_to(const std::string&)
+
+
+/**
* convert a string to another datatype @a T via string stream.
*
* @param v the value (of type @a T) which should be converted to a string.
#endif
-enum UnitSystem {
- SI, // SI decimal, composed by multiples of 1000 (KB, MB, etc.)
- IEC // IEC binary, composed by multiples of 1024 (KiB, MiB, etc. )
+enum UnitBase {
+ UnitBase1000, // SI decimal, composed by multiples of 1000 (KB, MB, etc.)
+ UnitBase1024 // IEC binary, composed by multiples of 1024 (KiB, MiB, etc. )
+};
+
+enum UnitFormat {
+ ShortUnitFormat, // B, KB, MB, ...
+ LongUnitFormat // Byte, KByte, MByte, ...
};
std::string nice_unit_format(
const int64_t input,
- const UnitSystem system = SI
+ const UnitFormat format = ShortUnitFormat,
+ const UnitBase base = UnitBase1024
+);
+
+std::string nice_unit_format(
+ const double input,
+ const UnitFormat format = ShortUnitFormat,
+ const UnitBase base = UnitBase1024
);
bool replace_all(std::string &base, const std::string *ist, const std::string *soll);
std::string strip_html_tags(const std::string &input);
std::string smart_html_entities(const std::string &input);
std::string html_entities(std::string str);
+std::string html_entities_to_console(std::string str);
+
+typedef std::pair<std::string::size_type, std::string::size_type> CommentZone;
+void find_html_comments(const std::string &str, std::vector<CommentZone> &result);
+void remove_html_comments(std::string &str);
+void remove_html_comments(std::string &str, const std::vector<CommentZone> &comments);
+
+std::string sanitize_for_logging(const std::string &str, const char replace_with='?');
std::string escape(const std::string &s);