Create functions find/remove_html_comments

[libi2ncommon] / src / stringfunc.hxx

diff --git a/src/stringfunc.hxx b/src/stringfunc.hxx
index b91a18f..5d3455c 100644 (file)
--- a/src/stringfunc.hxx
+++ b/src/stringfunc.hxx
@@ -35,6 +35,7 @@ on this file might be covered by the GNU General Public License.
 #define __STRINGFUNC_HXX
 
 #include <list>
+#include <vector>
 #include <string>
 #include <sstream>
 #include <stdexcept>
@@ -126,6 +127,11 @@ std::string join_string(
    const std::string& delimiter = "\n"
 );
 
+std::string join_string(
+   const std::vector< std::string >& parts,
+   const std::string& delimiter = "\n"
+);
+
 
 /*
 ** conversions:
@@ -137,7 +143,6 @@ std::string convert_binary_to_hex(const std::string&str, bool upper_case_digits=
 std::string convert_hex_to_binary(const std::string& str) throw(std::runtime_error);
 
 
-
 /*
 ** "type conversions":
 */
@@ -146,6 +151,11 @@ std::string convert_hex_to_binary(const std::string& str) throw(std::runtime_err
 /**
  * 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.
  */
@@ -182,6 +192,46 @@ bool string_to(const std::string& s, T& result)
 
 
 /**
+ * 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.
@@ -227,6 +277,12 @@ std::string nice_unit_format(
         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);
 bool replace_all(std::string &base, const char *ist, const char *soll);
 bool replace_all(std::string &base, const char *ist, const std::string *soll);
@@ -243,6 +299,13 @@ 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);
 
 std::string descape(const std::string &s, int startpos, int &endpos);