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