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