]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/hashcomp.h
Fix warnings from Doxygen.
[user/henk/code/inspircd.git] / include / hashcomp.h
index f3b1ba6e99275614b74546cee9dc60c2ab49c420..f0e092729d9618cec08e4b01972280721af3a022 100644 (file)
@@ -64,10 +64,6 @@ CoreExport extern unsigned const char rfc_case_insensitive_map[256];
  */
 CoreExport extern unsigned const char ascii_case_insensitive_map[256];
 
-/** Case sensitive (identity) map.
- */
-CoreExport extern unsigned const char rfc_case_sensitive_map[256];
-
 /** The irc namespace contains a number of helper classes.
  */
 namespace irc
@@ -81,6 +77,13 @@ namespace irc
         */
        CoreExport bool equals(const std::string& s1, const std::string& s2);
 
+       /** Check whether \p needle exists within \p haystack.
+        * @param haystack The string to search within.
+        * @param needle The string to search for.
+        * @return Either the index at which \p needle was found or std::string::npos.
+        */
+       CoreExport size_t find(const std::string& haystack, const std::string& needle);
+
        /** This class returns true if two strings match.
         * Case sensitivity is ignored, and the RFC 'character set'
         * is adhered to
@@ -105,62 +108,6 @@ namespace irc
                bool CoreExport operator()(const std::string& a, const std::string& b) const;
        };
 
-       /** The irc_char_traits class is used for RFC-style comparison of strings.
-        * This class is used to implement irc::string, a case-insensitive, RFC-
-        * comparing string class.
-        */
-       struct CoreExport irc_char_traits : public std::char_traits<char>
-       {
-               /** Check if two chars match.
-                * @param c1st First character
-                * @param c2nd Second character
-                * @return true if the characters are equal
-                */
-               static bool eq(char c1st, char c2nd);
-
-               /** Check if two chars do NOT match.
-                * @param c1st First character
-                * @param c2nd Second character
-                * @return true if the characters are unequal
-                */
-               static bool ne(char c1st, char c2nd);
-
-               /** Check if one char is less than another.
-                * @param c1st First character
-                * @param c2nd Second character
-                * @return true if c1st is less than c2nd
-                */
-               static bool lt(char c1st, char c2nd);
-
-               /** Compare two strings of size n.
-                * @param str1 First string
-                * @param str2 Second string
-                * @param n Length to compare to
-                * @return similar to strcmp, zero for equal, less than zero for str1
-                * being less and greater than zero for str1 being greater than str2.
-                */
-               static int compare(const char* str1, const char* str2, size_t n);
-
-               /** Find a char within a string up to position n.
-                * @param s1 String to find in
-                * @param n Position to search up to
-                * @param c Character to search for
-                * @return Pointer to the first occurance of c in s1
-                */
-               static const char* find(const char* s1, int  n, char c);
-       };
-
-       /** This typedef declares irc::string based upon irc_char_traits.
-        */
-       typedef std::basic_string<char, irc_char_traits, std::allocator<char> > string;
-
-       /** Joins the contents of a vector to a string.
-        * @param sequence Zero or more items to join.
-        * @param separator The character to place between the items, defaults to ' ' (space).
-        * @return Joined string.
-        */
-       std::string CoreExport stringjoiner(const std::vector<std::string>& sequence, char separator = ' ');
-
        /** irc::sepstream allows for splitting token seperated lists.
         * Each successive call to sepstream::GetToken() returns
         * the next token, until none remain, at which point the method returns
@@ -239,30 +186,30 @@ namespace irc
         * list will be ":item". This is to allow for parsing 'source' fields
         * from data.
         */
-       class CoreExport tokenstream : private spacesepstream
+       class CoreExport tokenstream
        {
-        public:
-               /** Create a tokenstream and fill it with the provided data
-                */
-               tokenstream(const std::string &source);
+       private:
+               /** The message we are parsing tokens from. */
+               std::string message;
 
-               /** Fetch the next token from the stream as a std::string
-                * @param token The next token available, or an empty string if none remain
-                * @return True if tokens are left to be read, false if the last token was just retrieved.
-                */
-               bool GetToken(std::string &token);
+               /** The current position within the message. */
+               size_t position;
+
+        public:
+               /** Create a tokenstream and fill it with the provided data. */
+               tokenstream(const std::string& msg, size_t start = 0);
 
-               /** Fetch the next token from the stream as an integer
-                * @param token The next token available, or undefined if none remain
+               /** Retrieve the next \<middle> token in the token stream.
+                * @param token The next token available, or an empty string if none remain.
                 * @return True if tokens are left to be read, false if the last token was just retrieved.
                 */
-               bool GetToken(int &token);
+               bool GetMiddle(std::string& token);
 
-               /** Fetch the next token from the stream as a long integer
-                * @param token The next token available, or undefined if none remain
+               /** Retrieve the next \<trailing> token in the token stream.
+                * @param token The next token available, or an empty string if none remain.
                 * @return True if tokens are left to be read, false if the last token was just retrieved.
                 */
-               bool GetToken(long &token);
+               bool GetTrailing(std::string& token);
        };
 
        /** The portparser class seperates out a port range into integers.