include/hashcomp.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
   6  *                       E-mail:
   7  *                <brain@chatspike.net>
   8  *                <Craig@chatspike.net>
   9  *
  10  * Written by Craig Edwards, Craig McLure, and others.
  11  * This program is free but copyrighted software; see
  12  *            the file COPYING for details.
  13  *
  14  * ---------------------------------------------------
  15  */
  16
  17 #ifndef _HASHCOMP_H_
  18 #define _HASHCOMP_H_
  19
  20 #include "inspircd_config.h"
  21 #include "socket.h"
  22 #include "hash_map.h"
  23
  24 /*******************************************************
  25  * This file contains classes and templates that deal
  26  * with the comparison and hashing of 'irc strings'.
  27  * An 'irc string' is a string which compares in a
  28  * case insensitive manner, and as per RFC 1459 will
  29  * treat [ identical to {, ] identical to }, and \
  30  * as identical to |.
  31  *
  32  * Our hashing functions are designed  to accept
  33  * std::string and compare/hash them as type irc::string
  34  * by converting them internally. This makes them
  35  * backwards compatible with other code which is not
  36  * aware of irc::string.
  37  *******************************************************/
  38
  39 using namespace std;
  40
  41 namespace nspace
  42 {
  43         template<> struct hash<insp_inaddr>
  44         {
  45                 size_t operator()(const insp_inaddr &a) const;
  46         };
  47
  48         template<> struct hash<std::string>
  49         {
  50                 size_t operator()(const string &s) const;
  51         };
  52 }
  53
  54 /** The irc namespace contains a number of helper classes.
  55  */
  56 namespace irc
  57 {
  58
  59         /** This class returns true if two strings match.
  60          * Case sensitivity is ignored, and the RFC 'character set'
  61          * is adhered to
  62          */
  63         struct StrHashComp
  64         {
  65                 /** The operator () does the actual comparison in hash_map
  66                  */
  67                 bool operator()(const std::string& s1, const std::string& s2) const;
  68         };
  69
  70
  71         /** This class returns true if two insp_inaddr structs match.
  72          * Checking is done by copying both into a size_t then doing a
  73          * numeric comparison of the two.
  74          */
  75         struct InAddr_HashComp
  76         {
  77                 /** The operator () does the actual comparison in hash_map
  78                  */
  79                 bool operator()(const insp_inaddr &s1, const insp_inaddr &s2) const;
  80         };
  81
  82         /** irc::tokenstream reads a string formatted as per RFC1459 and RFC2812.
  83          * It will split the string into 'tokens' each containing one parameter
  84          * from the string.
  85          * For instance, if it is instantiated with the string:
  86          * "PRIVMSG #test :foo bar baz qux"
  87          * then each successive call to tokenstream::GetToken() will return
  88          * "PRIVMSG", "#test", "foo bar baz qux", "".
  89          * Note that if the whole string starts with a colon this is not taken
  90          * to mean the string is all one parameter, and the first item in the
  91          * list will be ":item". This is to allow for parsing 'source' fields
  92          * from data.
  93          */
  94         class tokenstream
  95         {
  96          private:
  97                 std::string tokens;
  98                 std::string::iterator last_starting_position;
  99                 std::string::iterator n;
 100                 bool last_pushed;
 101          public:
 102                 /** Create a tokenstream and fill it with the provided data
 103                  */
 104                 tokenstream(const std::string &source);
 105                 ~tokenstream();
 106
 107                 /** Fetch the next token from the stream
 108                  * @returns The next token is returned, or an empty string if none remain
 109                  */
 110                 const std::string GetToken();
 111         };
 112
 113         /** irc::commasepstream allows for splitting comma seperated lists.
 114          * Lists passed to irc::commasepstream should not contain spaces
 115          * after the commas, or this will be taken to be part of the item
 116          * data. Each successive call to commasepstream::GetToken() returns
 117          * the next token, until none remain, at which point the method returns
 118          * an empty string.
 119          */
 120         class commasepstream
 121         {
 122          private:
 123                 std::string tokens;
 124                 std::string::iterator last_starting_position;
 125                 std::string::iterator n;
 126          public:
 127                 /** Create a commasepstream and fill it with the provided data
 128                  */
 129                 commasepstream(const std::string &source);
 130                 ~commasepstream();
 131
 132                 /** Fetch the next token from the stream
 133                  * @returns The next token is returned, or an empty string if none remain
 134                  */
 135                 const std::string GetToken();
 136         };
 137
 138
 139         /** The irc_char_traits class is used for RFC-style comparison of strings.
 140          * This class is used to implement irc::string, a case-insensitive, RFC-
 141          * comparing string class.
 142          */
 143         struct irc_char_traits : std::char_traits<char> {
 144
 145                 /** Check if two chars match
 146                  */
 147                 static bool eq(char c1st, char c2nd);
 148
 149                 /** Check if two chars do NOT match
 150                  */
 151                 static bool ne(char c1st, char c2nd);
 152
 153                 /** Check if one char is less than another
 154                  */
 155                 static bool lt(char c1st, char c2nd);
 156
 157                 /** Compare two strings of size n
 158                  */
 159                 static int compare(const char* str1, const char* str2, size_t n);
 160
 161                 /** Find a char within a string up to position n
 162                  */
 163                 static const char* find(const char* s1, int  n, char c);
 164         };
 165
 166         /** This typedef declares irc::string based upon irc_char_traits
 167          */
 168         typedef basic_string<char, irc_char_traits, allocator<char> > string;
 169 }
 170
 171 /* Define operators for using >> and << with irc::string to an ostream on an istream. */
 172 /* This was endless fun. No. Really. */
 173 /* It was also the first core change Ommeh made, if anyone cares */
 174
 175 std::ostream& operator<<(std::ostream &os, const irc::string &str);
 176 std::istream& operator>>(std::istream &is, irc::string &str);
 177
 178 /* Define operators for + and == with irc::string to std::string for easy assignment
 179  * and comparison - Brain
 180  */
 181
 182 std::string operator+ (std::string& leftval, irc::string& rightval);
 183 irc::string operator+ (irc::string& leftval, std::string& rightval);
 184 bool operator== (std::string& leftval, irc::string& rightval);
 185 bool operator== (irc::string& leftval, std::string& rightval);
 186
 187 #endif