Avoid a data copy decoding base64 data.

[simgear.git] / simgear / misc / strutils.hxx

diff --git a/simgear/misc/strutils.hxx b/simgear/misc/strutils.hxx
index 59051df40cb90050954341b071fe482e1510ef1f..7fce94a5f2728681d84d03eade76a8d94c009091 100644 (file)
--- a/simgear/misc/strutils.hxx
+++ b/simgear/misc/strutils.hxx
@@ -30,16 +30,13 @@
 #include <simgear/compiler.h>
 
 #include <string>
-
 #include <vector>
-SG_USING_STD(vector);
-
 #include <cstdlib>
 
-SG_USING_STD(string);
+typedef std::vector < std::string > string_list;
 
 namespace simgear {
-    namespace strutils {
+  namespace strutils {
 
 //     /** 
 //      * atof() wrapper for "string" type
@@ -64,9 +61,27 @@ namespace simgear {
         * @param s String to strip.
         * @return The stripped string.
         */
-       string lstrip( const string& s );
-       string rstrip( const string& s );
-       string strip( const string& s );
+       std::string lstrip( const std::string& s );
+       std::string rstrip( const std::string& s );
+       std::string strip( const std::string& s );
+
+        /**
+         * Right-padding of a string to a given length
+         * @param s String to pad
+         * @param length The total length of the resulting string
+         * @param c The character to pad with
+         * @return The padded string
+         */
+        std::string rpad( const std::string & s, size_t length, char c );
+
+        /**
+         * Left-padding of a string to a given length
+         * @param s String to pad
+         * @param length The total length of the resulting string
+         * @param c The character to pad with
+         * @return The padded string
+         */
+        std::string lpad( const std::string & s, size_t length, char c );
 
        /**
         * Split a string into a words using 'sep' as the delimiter string.
@@ -79,12 +94,101 @@ namespace simgear {
         * resulting in at most maxsplit+1 words.
         * @return Array of words.
         */
-       vector<string>
-       split( const string& s,
+       string_list
+       split( const std::string& s,
               const char* sep = 0,
               int maxsplit = 0 );
 
-    } // end namespace strutils
+       /**
+        * create a single string by joining the elements of a list with
+        * another string.
+        */
+       std::string join(const string_list& l, const std::string& joinWith = "");
+
+       /**
+        * Test if a string starts with a string 
+        *
+        * @param s The string to be tested
+        * @param substr The string to test
+        * @return True, if s starts with substr, False otherwise
+        */
+       bool starts_with( const std::string & s, const std::string & substr );
+
+       /**
+        * Test if a string ends with a string 
+        *
+        * @param s The string to be tested
+        * @param substr The string to test
+        * @return True, if s ends with substr, False otherwise
+        */
+       bool ends_with( const std::string & s, const std::string & substr );
+  
+    /**
+     * Strip all leading/trailing whitespace, and transform all interal
+     * whitespace into a single ' ' character - i.e newlines/carriage returns/
+     * tabs/multiple spaces will be condensed.
+     */
+    std::string simplify(const std::string& s);
+    
+    /**
+     * convert a string representing a decimal number, to an int
+     */
+    int to_int(const std::string& s, int base = 10);
+    
+    /**
+     * Like strcmp(), but for dotted versions strings NN.NN.NN
+     * any number of terms are supported.
+     * @return 0 if versions match, -ve number if v1 is lower, +ve if v1
+     * is greater
+     */
+    int compare_versions(const std::string& v1, const std::string& v2);
+
+    /**
+     * Convert a string to upper case.
+     * @return upper case string
+     */
+    std::string uppercase(const std::string &s);
+
+       /**
+     * convert a string in the local Windows 8-bit encoding to UTF-8
+     * (no-op on other platforms)
+     */
+    std::string convertWindowsLocal8BitToUtf8(const std::string& a);
+
+    /**
+     * convert base-64 encoded data to raw bytes (possibly with embedded
+     * NULs). Throws an exception if input data is not base64, or is
+     * malformed
+     */
+      void decodeBase64(const std::string& a, std::vector<unsigned char>& output);
+    
+    /**
+     * convert bytes to hexadecimal equivalent
+     */
+    std::string encodeHex(const std::string& bytes);
+    
+    std::string encodeHex(const unsigned char* rawBytes, unsigned int length);
+
+    /**
+     * Unescape string.
+     *
+     * @param str String possibly containing escaped characters.
+     * @return string with escaped characters replaced by single character
+     *         values.
+     */
+    std::string unescape(const char* str);
+
+    inline std::string unescape(const std::string& str)
+    { return unescape(str.c_str()); }
+      
+      /**
+       * Check a printf-style format string for dangerous (buffer-overflowing,
+       * memory re-writing) format tokens. If a problematic token is
+       * found, logs an error (SG_WARN) and returns an empty format string.
+       */
+      std::string sanitizePrintfFormat(const std::string& input);
+
+  } // end namespace strutils
 } // end namespace simgear
 
 #endif // STRUTILS_H