]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/hashcomp.h
Remove now unused assign() functions
[user/henk/code/inspircd.git] / include / hashcomp.h
index d9516e7fa4707936997e6468f3c52466404c9d0b..464fb16deddb36513fcd74fc4b0dd9c5b5be6d11 100644 (file)
@@ -22,8 +22,7 @@
  */
 
 
-#ifndef HASHCOMP_H
-#define HASHCOMP_H
+#pragma once
 
 #include <cstring>
 #include <string>
@@ -31,7 +30,7 @@
 #include <deque>
 #include <map>
 #include <set>
-#include "hash_map.h"
+#include "inspircd.h"
 
 /*******************************************************
  * This file contains classes and templates that deal
@@ -73,25 +72,25 @@ CoreExport extern unsigned const char rfc_case_sensitive_map[256];
 
 template<typename T> const T& SearchAndReplace(T& text, const T& pattern, const T& replace)
 {
-        T replacement;
-        if ((!pattern.empty()) && (!text.empty()))
-        {
-                for (std::string::size_type n = 0; n != text.length(); ++n)
-                {
-                        if (text.length() >= pattern.length() && text.substr(n, pattern.length()) == pattern)
-                        {
-                                /* Found the pattern in the text, replace it, and advance */
-                                replacement.append(replace);
-                                n = n + pattern.length() - 1;
-                        }
-                        else
-                        {
-                                replacement += text[n];
-                        }
-                }
-        }
-        text = replacement;
-        return text;
+       T replacement;
+       if ((!pattern.empty()) && (!text.empty()))
+       {
+               for (std::string::size_type n = 0; n != text.length(); ++n)
+               {
+                       if (text.length() >= pattern.length() && text.substr(n, pattern.length()) == pattern)
+                       {
+                               // Found the pattern in the text, replace it, and advance
+                               replacement.append(replace);
+                               n = n + pattern.length() - 1;
+                       }
+                       else
+                       {
+                               replacement += text[n];
+                       }
+               }
+       }
+       text = replacement;
+       return text;
 }
 
 /** The irc namespace contains a number of helper classes.
@@ -99,23 +98,45 @@ template<typename T> const T& SearchAndReplace(T& text, const T& pattern, const
 namespace irc
 {
 
+       /** Check if two IRC object (e.g. nick or channel) names are equal.
+        * This function uses national_case_insensitive_map to determine equality, which, by default does comparison
+        * according to RFC 1459, treating certain otherwise non-identical characters as identical.
+        * @param s1 First string to compare
+        * @param s2 Second string to compare
+        * @return True if the two names are equal, false otherwise
+        */
+       CoreExport bool equals(const std::string& s1, const std::string& s2);
+
        /** This class returns true if two strings match.
         * Case sensitivity is ignored, and the RFC 'character set'
         * is adhered to
         */
-       struct CoreExport StrHashComp
+       struct StrHashComp
        {
                /** The operator () does the actual comparison in hash_map
                 */
-               bool operator()(const std::string& s1, const std::string& s2) const;
+               bool operator()(const std::string& s1, const std::string& s2) const
+               {
+                       return equals(s1, s2);
+               }
+       };
+
+       struct insensitive
+       {
+               size_t CoreExport operator()(const std::string &s) const;
+       };
+
+       struct insensitive_swo
+       {
+               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 irc_char_traits : std::char_traits<char> {
-
+       struct CoreExport irc_char_traits : public std::char_traits<char>
+       {
                /** Check if two chars match.
                 * @param c1st First character
                 * @param c2nd Second character
@@ -144,7 +165,7 @@ namespace irc
                 * @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 CoreExport int compare(const char* str1, const char* str2, size_t n);
+               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
@@ -152,142 +173,82 @@ namespace irc
                 * @param c Character to search for
                 * @return Pointer to the first occurance of c in s1
                 */
-               static CoreExport const char* find(const char* s1, int  n, char c);
+               static const char* find(const char* s1, int  n, char c);
        };
 
-       /** Compose a hex string from raw data.
-        * @param raw The raw data to compose hex from
-        * @pram rawsz The size of the raw data buffer
-        * @return The hex string.
-        */
-       CoreExport std::string hex(const unsigned char *raw, size_t rawsz);
-
        /** This typedef declares irc::string based upon irc_char_traits.
         */
        typedef std::basic_string<char, irc_char_traits, std::allocator<char> > string;
 
-       /** irc::stringjoiner joins string lists into a string, using
-        * the given seperator string.
-        * This class can join a vector of std::string, a deque of
-        * std::string, or a const char* const* array, using overloaded
-        * constructors.
+       /** Joins the contents of a vector to a string.
+        * @param sequence Zero or more items to join.
+        * @separator The character to place between the items.
         */
-       class CoreExport stringjoiner
-       {
-        private:
+       std::string CoreExport stringjoiner(const std::vector<std::string>& sequence, char separator = ' ');
 
-               /** Output string
+       /** 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
+        * an empty string.
+        */
+       class CoreExport sepstream
+       {
+        protected:
+               /** Original string.
                 */
-               std::string joined;
-
+               std::string tokens;
+               /** Separator value
+                */
+               char sep;
+               /** Current string position
+                */
+               size_t pos;
+               /** If set then GetToken() can return an empty string
+                */
+               bool allow_empty;
         public:
-
-               /** Join elements of a vector, between (and including) begin and end
-                * @param seperator The string to seperate values with
-                * @param sequence One or more items to seperate
-                * @param begin The starting element in the sequence to be joined
-                * @param end The ending element in the sequence to be joined
+               /** Create a sepstream and fill it with the provided data
                 */
-               stringjoiner(const std::string &seperator, const std::vector<std::string> &sequence, int begin, int end);
+               sepstream(const std::string &source, char separator, bool allowempty = false);
 
-               /** Join elements of a deque, between (and including) begin and end
-                * @param seperator The string to seperate values with
-                * @param sequence One or more items to seperate
-                * @param begin The starting element in the sequence to be joined
-                * @param end The ending element in the sequence to be joined
+               /** Fetch the next token from the stream
+                * @param token The next token from the stream is placed here
+                * @return True if tokens still remain, false if there are none left
                 */
-               stringjoiner(const std::string &seperator, const std::deque<std::string> &sequence, int begin, int end);
+               bool GetToken(std::string& token);
 
-               /** Join elements of an array of char arrays, between (and including) begin and end
-                * @param seperator The string to seperate values with
-                * @param sequence One or more items to seperate
-                * @param begin The starting element in the sequence to be joined
-                * @param end The ending element in the sequence to be joined
+               /** Fetch the entire remaining stream, without tokenizing
+                * @return The remaining part of the stream
                 */
-               stringjoiner(const std::string &seperator, const char* const* sequence, int begin, int end);
+               const std::string GetRemaining();
 
-               /** Get the joined sequence
-                * @return A reference to the joined string
+               /** Returns true if the end of the stream has been reached
+                * @return True if the end of the stream has been reached, otherwise false
                 */
-               std::string& GetJoined();
+               bool StreamEnd();
        };
 
-       /** irc::modestacker stacks mode sequences into a list.
-        * It can then reproduce this list, clamped to a maximum of MAXMODES
-        * values per line.
+       /** A derived form of sepstream, which seperates on commas
         */
-       class CoreExport modestacker
+       class CoreExport commasepstream : public sepstream
        {
-        private:
-               /** The mode sequence and its parameters
-                */
-               std::deque<std::string> sequence;
-
-               /** True if the mode sequence is initially adding
-                * characters, false if it is initially removing
-                * them
-                */
-               bool adding;
         public:
-
-               /** Construct a new modestacker.
-                * @param add True if the stack is adding modes,
-                * false if it is removing them
-                */
-               modestacker(bool add);
-
-               /** Push a modeletter and its parameter onto the stack.
-                * No checking is performed as to if this mode actually
-                * requires a parameter. If you stack invalid mode
-                * sequences, they will be tidied if and when they are
-                * passed to a mode parser.
-                * @param modeletter The mode letter to insert
-                * @param parameter The parameter for the mode
+               /** Initialize with comma separator
                 */
-               void Push(char modeletter, const std::string &parameter);
-
-               /** Push a modeletter without parameter onto the stack.
-                * No checking is performed as to if this mode actually
-                * requires a parameter. If you stack invalid mode
-                * sequences, they will be tidied if and when they are
-                * passed to a mode parser.
-                * @param modeletter The mode letter to insert
-                */
-               void Push(char modeletter);
-
-               /** Push a '+' symbol onto the stack.
-                */
-               void PushPlus();
+               commasepstream(const std::string &source, bool allowempty = false) : sepstream(source, ',', allowempty)
+               {
+               }
+       };
 
-               /** Push a '-' symbol onto the stack.
-                */
-               void PushMinus();
-
-               /** Return zero or more elements which form the
-                * mode line. This will be clamped to a max of
-                * MAXMODES items (MAXMODES-1 mode parameters and
-                * one mode sequence string), and max_line_size
-                * characters. As specified below, this function
-                * should be called in a loop until it returns zero,
-                * indicating there are no more modes to return.
-                * @param result The vector to populate. This will not
-                * be cleared before it is used.
-                * @param max_line_size The maximum size of the line
-                * to build, in characters, seperate to MAXMODES.
-                * @return The number of elements in the deque.
-                * The function should be called repeatedly until it
-                * returns 0, in case there are multiple lines of
-                * mode changes to be obtained.
+       /** A derived form of sepstream, which seperates on spaces
+        */
+       class CoreExport spacesepstream : public sepstream
+       {
+        public:
+               /** Initialize with space separator
                 */
-               int GetStackedLine(std::vector<std::string> &result, int max_line_size = 360);
-
-               /** deprecated compatability interface - TODO remove */
-               int GetStackedLine(std::deque<std::string> &result, int max_line_size = 360) {
-                       std::vector<std::string> r;
-                       int n = GetStackedLine(r, max_line_size);
-                       result.clear();
-                       result.insert(result.end(), r.begin(), r.end());
-                       return n;
+               spacesepstream(const std::string &source, bool allowempty = false) : sepstream(source, ' ', allowempty)
+               {
                }
        };
 
@@ -303,47 +264,19 @@ namespace irc
         * list will be ":item". This is to allow for parsing 'source' fields
         * from data.
         */
-       class CoreExport tokenstream
+       class CoreExport tokenstream : private spacesepstream
        {
-        private:
-
-               /** Original string
-                */
-               std::string tokens;
-
-               /** Last position of a seperator token
-                */
-               std::string::iterator last_starting_position;
-
-               /** Current string position
-                */
-               std::string::iterator n;
-
-               /** True if the last value was an ending value
-                */
-               bool last_pushed;
         public:
-
                /** Create a tokenstream and fill it with the provided data
                 */
                tokenstream(const std::string &source);
 
-               /** Destructor
-                */
-               ~tokenstream();
-
                /** 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);
 
-               /** Fetch the next token from the stream as an irc::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(irc::string &token);
-
                /** Fetch the next token from the stream as an integer
                 * @param token The next token available, or undefined if none remain
                 * @return True if tokens are left to be read, false if the last token was just retrieved.
@@ -357,76 +290,6 @@ namespace irc
                bool GetToken(long &token);
        };
 
-       /** 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
-        * an empty string.
-        */
-       class CoreExport sepstream
-       {
-        private:
-               /** Original string.
-                */
-               std::string tokens;
-               /** Last position of a seperator token
-                */
-               std::string::iterator last_starting_position;
-               /** Current string position
-                */
-               std::string::iterator n;
-               /** Seperator value
-                */
-               char sep;
-        public:
-               /** Create a sepstream and fill it with the provided data
-                */
-               sepstream(const std::string &source, char seperator);
-
-               /** Destructor
-                */
-               virtual ~sepstream();
-
-               /** Fetch the next token from the stream
-                * @param token The next token from the stream is placed here
-                * @return True if tokens still remain, false if there are none left
-                */
-               virtual bool GetToken(std::string &token);
-
-               /** Fetch the entire remaining stream, without tokenizing
-                * @return The remaining part of the stream
-                */
-               virtual const std::string GetRemaining();
-
-               /** Returns true if the end of the stream has been reached
-                * @return True if the end of the stream has been reached, otherwise false
-                */
-               virtual bool StreamEnd();
-       };
-
-       /** A derived form of sepstream, which seperates on commas
-        */
-       class CoreExport commasepstream : public sepstream
-       {
-        public:
-               /** Initialize with comma seperator
-                */
-               commasepstream(const std::string &source) : sepstream(source, ',')
-               {
-               }
-       };
-
-       /** A derived form of sepstream, which seperates on spaces
-        */
-       class CoreExport spacesepstream : public sepstream
-       {
-        public:
-               /** Initialize with space seperator
-                */
-               spacesepstream(const std::string &source) : sepstream(source, ' ')
-               {
-               }
-       };
-
        /** The portparser class seperates out a port range into integers.
         * A port range may be specified in the input string in the form
         * "6660,6661,6662-6669,7020". The end of the stream is indicated by
@@ -441,7 +304,7 @@ namespace irc
 
                /** Used to split on commas
                 */
-               commasepstream* sep;
+               commasepstream sep;
 
                /** Current position in a range of ports
                 */
@@ -462,7 +325,7 @@ namespace irc
                /** Used to determine overlapping of ports
                 * without O(n) algorithm being used
                 */
-               std::map<long, bool> overlap_set;
+               std::set<long> overlap_set;
 
                /** Returns true if val overlaps an existing range
                 */
@@ -475,30 +338,11 @@ namespace irc
                 */
                portparser(const std::string &source, bool allow_overlapped = true);
 
-               /** Frees the internal commasepstream object
-                */
-               ~portparser();
-
                /** Fetch the next token from the stream
                 * @return The next port number is returned, or 0 if none remain
                 */
                long GetToken();
        };
-
-       /** Turn _ characters in a string into spaces
-        * @param n String to translate
-        * @return The new value with _ translated to space.
-        */
-       CoreExport const char* Spacify(const char* n);
-
-       struct hash
-       {
-               /** Hash an irc::string using RFC1459 case sensitivity rules
-                * @param s A string to hash
-                * @return The hash value
-                */
-               size_t CoreExport operator()(const irc::string &s) const;
-       };
 }
 
 /* Define operators for using >> and << with irc::string to an ostream on an istream. */
@@ -572,94 +416,3 @@ inline bool operator!= (const std::string& leftval, const irc::string& rightval)
 {
        return !(leftval.c_str() == rightval);
 }
-
-/** Assign an irc::string to a std::string.
- */
-inline std::string assign(const irc::string &other) { return other.c_str(); }
-
-/** Assign a std::string to an irc::string.
- */
-inline irc::string assign(const std::string &other) { return other.c_str(); }
-
-/** Trim the leading and trailing spaces from a std::string.
- */
-inline std::string& trim(std::string &str)
-{
-       std::string::size_type start = str.find_first_not_of(" ");
-       std::string::size_type end = str.find_last_not_of(" ");
-       if (start == std::string::npos || end == std::string::npos)
-               str = "";
-       else
-               str = str.substr(start, end-start+1);
-
-       return str;
-}
-
-/** Hashing stuff is totally different on vc++'s hash_map implementation, so to save a buttload of
- * #ifdefs we'll just do it all at once. Except, of course, with TR1, when it's the same as GCC.
- */
-BEGIN_HASHMAP_NAMESPACE
-
-       /** Hashing function to hash irc::string
-        */
-#if defined(WINDOWS) && !defined(HAS_TR1_UNORDERED)
-       template<> class CoreExport hash_compare<irc::string, std::less<irc::string> >
-       {
-       public:
-               enum { bucket_size = 4, min_buckets = 8 }; /* Got these numbers from the CRT source, if anyone wants to change them feel free. */
-
-               /** Compare two irc::string values for hashing in hash_map
-                */
-               bool operator()(const irc::string & s1, const irc::string & s2) const
-               {
-                       if(s1.length() != s2.length()) return true;
-                       return (irc::irc_char_traits::compare(s1.c_str(), s2.c_str(), (size_t)s1.length()) < 0);
-               }
-
-               /** Hash an irc::string value for hash_map
-                */
-               size_t operator()(const irc::string & s) const;
-       };
-
-       template<> class CoreExport hash_compare<std::string, std::less<std::string> >
-       {
-       public:
-               enum { bucket_size = 4, min_buckets = 8 }; /* Again, from the CRT source */
-
-               /** Compare two std::string values for hashing in hash_map
-                */
-               bool operator()(const std::string & s1, const std::string & s2) const
-               {
-                       if(s1.length() != s2.length()) return true;
-                       return (irc::irc_char_traits::compare(s1.c_str(), s2.c_str(), (size_t)s1.length()) < 0);
-               }
-
-               /** Hash a std::string using RFC1459 case sensitivity rules
-               * @param s A string to hash
-               * @return The hash value
-               */
-               size_t operator()(const std::string & s) const;
-       };
-#else
-
-       /* XXX FIXME: Implement a hash function overriding std::string's that works with TR1! */
-
-#ifdef HASHMAP_DEPRECATED
-       struct insensitive
-#else
-       CoreExport template<> struct hash<std::string>
-#endif
-       {
-               size_t CoreExport operator()(const std::string &s) const;
-       };
-
-#endif
-
-       /** Convert a string to lower case respecting RFC1459
-       * @param n A string to lowercase
-       */
-       void strlower(char *n);
-
-END_HASHMAP_NAMESPACE
-
-#endif