Tons of comments

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

diff --git a/include/hashcomp.h b/include/hashcomp.h
index 7ec813ad6b7db5557ed0e2187ae0df210052d54a..714d3286f78ddbdbea1a916f904edbbc72b7eb54 100644 (file)
--- a/include/hashcomp.h
+++ b/include/hashcomp.h
@@ -18,6 +18,8 @@
 #define _HASHCOMP_H_
 
 #include "inspircd_config.h"
+#include "socket.h"
+#include "hash_map.h"
 
 /*******************************************************
  * This file contains classes and templates that deal
@@ -33,36 +35,17 @@
  * backwards compatible with other code which is not
  * aware of irc::string.
  *******************************************************/
-
-#ifdef GCC3
-#include <ext/hash_map>
-#else
-#include <hash_map>
-#endif
-
-#ifdef GCC3
-#define nspace __gnu_cxx
-#else
-#define nspace std
-#endif
-
+ 
 using namespace std;
 
 namespace nspace
 {
-#ifdef GCC34
-        template<> struct hash<in_addr>
-#else
-        template<> struct nspace::hash<in_addr>
-#endif
+        template<> struct hash<insp_inaddr>
         {
-                size_t operator()(const struct in_addr &a) const;
+                size_t operator()(const insp_inaddr &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;
         };
@@ -85,7 +68,7 @@ namespace irc
        };
 
 
-       /** This class returns true if two in_addr structs match.
+       /** This class returns true if two insp_inaddr structs match.
         * Checking is done by copying both into a size_t then doing a
         * numeric comparison of the two.
         */
@@ -93,7 +76,63 @@ namespace irc
        {
                /** The operator () does the actual comparison in hash_map
                 */
-               bool operator()(const in_addr &s1, const in_addr &s2) const;
+               bool operator()(const insp_inaddr &s1, const insp_inaddr &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();
        };