]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - include/hashcomp.h
mmmm dinner break, oh and document and make use of modestacker.
[user/henk/code/inspircd.git] / 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 #ifndef LOWERMAP
45 #define LOWERMAP
46 /** A mapping of uppercase to lowercase, including scandinavian
47  * 'oddities' as specified by RFC1459, e.g. { -> [, and | -> \
48  */
49 unsigned const char lowermap[256] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19,                             /* 0-19 */
50                                 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39,                         /* 20-39 */
51                                 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,                         /* 40-59 */
52                                 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111,             /* 60-79 */
53                                 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 94, 95, 96, 97, 98, 99,           /* 80-99 */
54                                 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,     /* 100-119 */
55                                 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139,     /* 120-139 */
56                                 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159,     /* 140-159 */
57                                 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,     /* 160-179 */
58                                 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199,     /* 180-199 */
59                                 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219,     /* 200-219 */
60                                 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,     /* 220-239 */
61                                 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254, 255                          /* 240-255 */
62 };
63 #endif
64
65 /** Because of weirdness in g++, before 3.x this was namespace std. It's now __gnu_cxx.
66  * This is a #define'd alias.
67  */
68 namespace nspace
69 {
70         /** Convert a string to lower case respecting RFC1459
71          * @param n A string to lowercase
72          */
73         void strlower(char *n);
74
75         /** Hashing function to hash insp_inaddr structs
76          */
77         template<> struct hash<insp_inaddr>
78         {
79                 /** Hash an insp_inaddr
80                  * @param a An insp_inaddr to hash
81                  * @return The hash value
82                  */
83                 size_t operator()(const insp_inaddr &a) const;
84         };
85
86         /** Hashing function to hash std::string without respect to case
87          */
88         template<> struct hash<std::string>
89         {
90                 /** Hash a std::string using RFC1459 case sensitivity rules
91                  * @param s A string to hash
92                  * @return The hash value
93                  */
94                 size_t operator()(const string &s) const;
95         };
96 }
97
98 /** The irc namespace contains a number of helper classes.
99  */
100 namespace irc
101 {
102
103         /** This class returns true if two strings match.
104          * Case sensitivity is ignored, and the RFC 'character set'
105          * is adhered to
106          */
107         struct StrHashComp
108         {
109                 /** The operator () does the actual comparison in hash_map
110                  */
111                 bool operator()(const std::string& s1, const std::string& s2) const;
112         };
113
114
115         /** This class returns true if two insp_inaddr structs match.
116          * Checking is done by copying both into a size_t then doing a
117          * numeric comparison of the two.
118          */
119         struct InAddr_HashComp
120         {
121                 /** The operator () does the actual comparison in hash_map
122                  */
123                 bool operator()(const insp_inaddr &s1, const insp_inaddr &s2) const;
124         };
125
126         /** irc::modestacker stacks mode sequences into a list.
127          * It can then reproduce this list, clamped to a maximum of MAXMODES
128          * values per line.
129          */
130         class modestacker
131         {
132          private:
133                 /** The mode sequence and its parameters
134                  */
135                 std::deque<std::string> sequence;
136                 /** True if the mode sequence is initially adding
137                  * characters, false if it is initially removing
138                  * them
139                  */
140                 bool adding;
141          public:
142                 /** Construct a new modestacker.
143                  * @param add True if the stack is adding modes,
144                  * false if it is removing them
145                  */
146                 modestacker(bool add);
147                 /** Push a modeletter and its parameter onto the stack.
148                  * No checking is performed as to if this mode actually
149                  * requires a parameter. If you stack invalid mode
150                  * sequences, they will be tidied if and when they are
151                  * passed to a mode parser.
152                  * @param modeletter The mode letter to insert
153                  * @param parameter The parameter for the mode
154                  */
155                 void Push(char modeletter, const std::string &parameter);
156                 /** Push a modeletter without parameter onto the stack.
157                  * No checking is performed as to if this mode actually
158                  * requires a parameter. If you stack invalid mode
159                  * sequences, they will be tidied if and when they are
160                  * passed to a mode parser.
161                  * @param modeletter The mode letter to insert
162                  */
163                 void Push(char modeletter);
164                 /** Push a '+' symbol onto the stack.
165                  */
166                 void PushPlus();
167                 /** Push a '-' symbol onto the stack.
168                  */
169                 void PushMinus();
170                 /** Return zero or more elements which form the
171                  * mode line. This will be clamped to a max of
172                  * MAXMODES+1 items (MAXMODES mode parameters and
173                  * one mode dequence string).
174                  * @param result The deque to populate. This will
175                  * be cleared before it is used.
176                  * @return The number of elements in the deque
177                  */
178                 int GetStackedLine(std::deque<std::string> &result);
179         };
180
181         /** irc::tokenstream reads a string formatted as per RFC1459 and RFC2812.
182          * It will split the string into 'tokens' each containing one parameter
183          * from the string.
184          * For instance, if it is instantiated with the string:
185          * "PRIVMSG #test :foo bar baz qux"
186          * then each successive call to tokenstream::GetToken() will return
187          * "PRIVMSG", "#test", "foo bar baz qux", "".
188          * Note that if the whole string starts with a colon this is not taken
189          * to mean the string is all one parameter, and the first item in the
190          * list will be ":item". This is to allow for parsing 'source' fields
191          * from data.
192          */
193         class tokenstream
194         {
195          private:
196                 std::string tokens;
197                 std::string::iterator last_starting_position;
198                 std::string::iterator n;
199                 bool last_pushed;
200          public:
201                 /** Create a tokenstream and fill it with the provided data
202                  */
203                 tokenstream(const std::string &source);
204                 ~tokenstream();
205
206                 /** Fetch the next token from the stream
207                  * @returns The next token is returned, or an empty string if none remain
208                  */
209                 const std::string GetToken();
210         };
211
212         /** irc::commasepstream allows for splitting comma seperated lists.
213          * Lists passed to irc::commasepstream should not contain spaces
214          * after the commas, or this will be taken to be part of the item
215          * data. Each successive call to commasepstream::GetToken() returns
216          * the next token, until none remain, at which point the method returns
217          * an empty string.
218          */
219         class sepstream : public classbase
220         {
221          private:
222                 std::string tokens;
223                 std::string::iterator last_starting_position;
224                 std::string::iterator n;
225                 char sep;
226          public:
227                 /** Create a commasepstream and fill it with the provided data
228                  */
229                 sepstream(const std::string &source, char seperator);
230                 virtual ~sepstream();
231
232                 /** Fetch the next token from the stream
233                  * @returns The next token is returned, or an empty string if none remain
234                  */
235                 virtual const std::string GetToken();
236         };
237
238         class commasepstream : public sepstream
239         {
240          public:
241                 commasepstream(const std::string &source) : sepstream(source, ',')
242                 {
243                 }
244         };
245
246         class spacesepstream : public sepstream
247         {
248          public:
249                 spacesepstream(const std::string &source) : sepstream(source, ' ')
250                 {
251                 }
252         };
253
254
255         /** The irc_char_traits class is used for RFC-style comparison of strings.
256          * This class is used to implement irc::string, a case-insensitive, RFC-
257          * comparing string class.
258          */
259         struct irc_char_traits : std::char_traits<char> {
260
261                 /** Check if two chars match
262                  */
263                 static bool eq(char c1st, char c2nd);
264
265                 /** Check if two chars do NOT match
266                  */
267                 static bool ne(char c1st, char c2nd);
268
269                 /** Check if one char is less than another
270                  */
271                 static bool lt(char c1st, char c2nd);
272
273                 /** Compare two strings of size n
274                  */
275                 static int compare(const char* str1, const char* str2, size_t n);
276
277                 /** Find a char within a string up to position n
278                  */
279                 static const char* find(const char* s1, int  n, char c);
280         };
281
282         std::string hex(const unsigned char *raw, size_t rawsz);
283
284         /** This typedef declares irc::string based upon irc_char_traits
285          */
286         typedef basic_string<char, irc_char_traits, allocator<char> > string;
287
288         const char* Spacify(char* n);
289 }
290
291 /* Define operators for using >> and << with irc::string to an ostream on an istream. */
292 /* This was endless fun. No. Really. */
293 /* It was also the first core change Ommeh made, if anyone cares */
294 std::ostream& operator<<(std::ostream &os, const irc::string &str);
295 std::istream& operator>>(std::istream &is, irc::string &str);
296
297 /* Define operators for + and == with irc::string to std::string for easy assignment
298  * and comparison - Brain
299  */
300 std::string operator+ (std::string& leftval, irc::string& rightval);
301 irc::string operator+ (irc::string& leftval, std::string& rightval);
302 bool operator== (std::string& leftval, irc::string& rightval);
303 bool operator== (irc::string& leftval, std::string& rightval);
304
305 #endif