Change std::pair<bool,std::string> to neater typedef "ModePair"

[user/henk/code/inspircd.git] / include / hashcomp.h

diff --git a/include/hashcomp.h b/include/hashcomp.h
index 32d155e30b9df5b04224190c8bec3fccf70b9a88..1d3a5d0b1d8494ae43fba75a6cbf1757af91f404 100644 (file)
--- a/include/hashcomp.h
+++ b/include/hashcomp.h
@@ -2,7 +2,7 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  Inspire is copyright (C) 2002-2005 ChatSpike-Dev.
+ *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
  *                       E-mail:
  *                <brain@chatspike.net>
  *                <Craig@chatspike.net>
@@ -18,47 +18,34 @@
 #define _HASHCOMP_H_
 
 #include "inspircd_config.h"
+#include "socket.h"
+#include "hash_map.h"
 
-/**
+/*******************************************************
  * This file contains classes and templates that deal
  * with the comparison and hashing of 'irc strings'.
  * An 'irc string' is a string which compares in a
  * case insensitive manner, and as per RFC 1459 will
  * treat [ identical to {, ] identical to }, and \
- * as identical to |. Our hashing functions are designed
- * to accept std::string and compare/hash them in an irc
- * type way, irc::string is a seperate class type currently.
- */
-
-#ifdef GCC3
-#include <ext/hash_map>
-#else
-#include <hash_map>
-#endif
-
-#ifdef GCC3
-#define nspace __gnu_cxx
-#else
-#define nspace std
-#endif
-
+ * as identical to |.
+ *
+ * Our hashing functions are designed  to accept
+ * std::string and compare/hash them as type irc::string
+ * by converting them internally. This makes them
+ * backwards compatible with other code which is not
+ * aware of irc::string.
+ *******************************************************/
+ 
 using namespace std;
 
 namespace nspace
 {
-#ifdef GCC34
         template<> struct hash<in_addr>
-#else
-        template<> struct nspace::hash<in_addr>
-#endif
         {
                 size_t operator()(const struct in_addr &a) const;
         };
-#ifdef GCC34
-        template<> struct hash<string>
-#else
-        template<> struct nspace::hash<string>
-#endif
+
+        template<> struct hash<std::string>
         {
                 size_t operator()(const string &s) const;
         };
@@ -92,6 +79,62 @@ namespace irc
                bool operator()(const in_addr &s1, const in_addr &s2) const;
        };
 
+       /** irc::tokenstream reads a string formatted as per RFC1459 and RFC2812.
+        * It will split the string into 'tokens' each containing one parameter
+        * from the string.
+        * For instance, if it is instantiated with the string:
+        * "PRIVMSG #test :foo bar baz qux"
+        * then each successive call to tokenstream::GetToken() will return
+        * "PRIVMSG", "#test", "foo bar baz qux", "".
+        * Note that if the whole string starts with a colon this is not taken
+        * to mean the string is all one parameter, and the first item in the
+        * list will be ":item". This is to allow for parsing 'source' fields
+        * from data.
+        */
+       class tokenstream
+       {
+        private:
+               std::string tokens;
+               std::string::iterator last_starting_position;
+               std::string::iterator n;
+               bool last_pushed;
+        public:
+               /** Create a tokenstream and fill it with the provided data
+                */
+               tokenstream(const std::string &source);
+               ~tokenstream();
+
+               /** Fetch the next token from the stream
+                * @returns The next token is returned, or an empty string if none remain
+                */
+               const std::string GetToken();
+       };
+
+       /** irc::commasepstream allows for splitting comma seperated lists.
+        * Lists passed to irc::commasepstream should not contain spaces
+        * after the commas, or this will be taken to be part of the item
+        * data. Each successive call to commasepstream::GetToken() returns
+        * the next token, until none remain, at which point the method returns
+        * an empty string.
+        */
+       class commasepstream
+       {
+        private:
+               std::string tokens;
+               std::string::iterator last_starting_position;
+               std::string::iterator n;
+        public:
+               /** Create a commasepstream and fill it with the provided data
+                */
+               commasepstream(const std::string &source);
+               ~commasepstream();
+
+               /** Fetch the next token from the stream
+                * @returns The next token is returned, or an empty string if none remain
+                */
+               const std::string GetToken();
+       };
+
 
        /** 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-
@@ -125,4 +168,20 @@ namespace irc
        typedef basic_string<char, irc_char_traits, allocator<char> > string;
 }
 
+/* Define operators for using >> and << with irc::string to an ostream on an istream. */
+/* This was endless fun. No. Really. */
+/* It was also the first core change Ommeh made, if anyone cares */
+
+std::ostream& operator<<(std::ostream &os, const irc::string &str);
+std::istream& operator>>(std::istream &is, irc::string &str);
+
+/* Define operators for + and == with irc::string to std::string for easy assignment
+ * and comparison - Brain
+ */
+
+std::string operator+ (std::string& leftval, irc::string& rightval);
+irc::string operator+ (irc::string& leftval, std::string& rightval);
+bool operator== (std::string& leftval, irc::string& rightval);
+bool operator== (irc::string& leftval, std::string& rightval);
+
 #endif