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 using irc::sockets::insp_aton;
  41 using irc::sockets::insp_ntoa;
  42 using irc::sockets::insp_inaddr;
  43
  44 /** Because of weirdness in g++, before 3.x this was namespace std. It's now __gnu_cxx.
  45  * This is a #define'd alias.
  46  */
  47 namespace nspace
  48 {
  49         /** Convert a string to lower case respecting RFC1459
  50          * @param n A string to lowercase
  51          */
  52         void strlower(char *n);
  53
  54         /** Hashing function to hash insp_inaddr structs
  55          */
  56         template<> struct hash<insp_inaddr>
  57         {
  58                 /** Hash an insp_inaddr
  59                  * @param a An insp_inaddr to hash
  60                  * @return The hash value
  61                  */
  62                 size_t operator()(const insp_inaddr &a) const;
  63         };
  64
  65         /** Hashing function to hash std::string without respect to case
  66          */
  67         template<> struct hash<std::string>
  68         {
  69                 /** Hash a std::string using RFC1459 case sensitivity rules
  70                  * @param s A string to hash
  71                  * @return The hash value
  72                  */
  73                 size_t operator()(const string &s) const;
  74         };
  75 }
  76
  77 /** The irc namespace contains a number of helper classes.
  78  */
  79 namespace irc
  80 {
  81
  82         /** This class returns true if two strings match.
  83          * Case sensitivity is ignored, and the RFC 'character set'
  84          * is adhered to
  85          */
  86         struct StrHashComp
  87         {
  88                 /** The operator () does the actual comparison in hash_map
  89                  */
  90                 bool operator()(const std::string& s1, const std::string& s2) const;
  91         };
  92
  93
  94         /** This class returns true if two insp_inaddr structs match.
  95          * Checking is done by copying both into a size_t then doing a
  96          * numeric comparison of the two.
  97          */
  98         struct InAddr_HashComp
  99         {
 100                 /** The operator () does the actual comparison in hash_map
 101                  */
 102                 bool operator()(const insp_inaddr &s1, const insp_inaddr &s2) const;
 103         };
 104
 105         /** irc::tokenstream reads a string formatted as per RFC1459 and RFC2812.
 106          * It will split the string into 'tokens' each containing one parameter
 107          * from the string.
 108          * For instance, if it is instantiated with the string:
 109          * "PRIVMSG #test :foo bar baz qux"
 110          * then each successive call to tokenstream::GetToken() will return
 111          * "PRIVMSG", "#test", "foo bar baz qux", "".
 112          * Note that if the whole string starts with a colon this is not taken
 113          * to mean the string is all one parameter, and the first item in the
 114          * list will be ":item". This is to allow for parsing 'source' fields
 115          * from data.
 116          */
 117         class tokenstream
 118         {
 119          private:
 120                 std::string tokens;
 121                 std::string::iterator last_starting_position;
 122                 std::string::iterator n;
 123                 bool last_pushed;
 124          public:
 125                 /** Create a tokenstream and fill it with the provided data
 126                  */
 127                 tokenstream(const std::string &source);
 128                 ~tokenstream();
 129
 130                 /** Fetch the next token from the stream
 131                  * @returns The next token is returned, or an empty string if none remain
 132                  */
 133                 const std::string GetToken();
 134         };
 135
 136         /** irc::commasepstream allows for splitting comma seperated lists.
 137          * Lists passed to irc::commasepstream should not contain spaces
 138          * after the commas, or this will be taken to be part of the item
 139          * data. Each successive call to commasepstream::GetToken() returns
 140          * the next token, until none remain, at which point the method returns
 141          * an empty string.
 142          */
 143         class commasepstream
 144         {
 145          private:
 146                 std::string tokens;
 147                 std::string::iterator last_starting_position;
 148                 std::string::iterator n;
 149          public:
 150                 /** Create a commasepstream and fill it with the provided data
 151                  */
 152                 commasepstream(const std::string &source);
 153                 ~commasepstream();
 154
 155                 /** Fetch the next token from the stream
 156                  * @returns The next token is returned, or an empty string if none remain
 157                  */
 158                 const std::string GetToken();
 159         };
 160
 161
 162         /** The irc_char_traits class is used for RFC-style comparison of strings.
 163          * This class is used to implement irc::string, a case-insensitive, RFC-
 164          * comparing string class.
 165          */
 166         struct irc_char_traits : std::char_traits<char> {
 167
 168                 /** Check if two chars match
 169                  */
 170                 static bool eq(char c1st, char c2nd);
 171
 172                 /** Check if two chars do NOT match
 173                  */
 174                 static bool ne(char c1st, char c2nd);
 175
 176                 /** Check if one char is less than another
 177                  */
 178                 static bool lt(char c1st, char c2nd);
 179
 180                 /** Compare two strings of size n
 181                  */
 182                 static int compare(const char* str1, const char* str2, size_t n);
 183
 184                 /** Find a char within a string up to position n
 185                  */
 186                 static const char* find(const char* s1, int  n, char c);
 187         };
 188
 189         /** This typedef declares irc::string based upon irc_char_traits
 190          */
 191         typedef basic_string<char, irc_char_traits, allocator<char> > string;
 192 }
 193
 194 /* Define operators for using >> and << with irc::string to an ostream on an istream. */
 195 /* This was endless fun. No. Really. */
 196 /* It was also the first core change Ommeh made, if anyone cares */
 197 std::ostream& operator<<(std::ostream &os, const irc::string &str);
 198 std::istream& operator>>(std::istream &is, irc::string &str);
 199
 200 /* Define operators for + and == with irc::string to std::string for easy assignment
 201  * and comparison - Brain
 202  */
 203 std::string operator+ (std::string& leftval, irc::string& rightval);
 204 irc::string operator+ (irc::string& leftval, std::string& rightval);
 205 bool operator== (std::string& leftval, irc::string& rightval);
 206 bool operator== (irc::string& leftval, std::string& rightval);
 207
 208 #endif