]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - include/hashcomp.h
Integrate K/Gline into the bancache system by making some modifications to DefaultApp...
[user/henk/code/inspircd.git] / include / hashcomp.h
1 /*       +------------------------------------+
2  *       | Inspire Internet Relay Chat Daemon |
3  *       +------------------------------------+
4  *
5  *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
6  * See: http://www.inspircd.org/wiki/index.php/Credits
7  *
8  * This program is free but copyrighted software; see
9  *          the file COPYING for details.
10  *
11  * ---------------------------------------------------
12  */
13
14 #ifndef _HASHCOMP_H_
15 #define _HASHCOMP_H_
16
17 #include "inspircd_config.h"
18 #include "socket.h"
19 #include "hash_map.h"
20
21 /*******************************************************
22  * This file contains classes and templates that deal
23  * with the comparison and hashing of 'irc strings'.
24  * An 'irc string' is a string which compares in a
25  * case insensitive manner, and as per RFC 1459 will
26  * treat [ identical to {, ] identical to }, and \
27  * as identical to |.
28  *
29  * Our hashing functions are designed  to accept
30  * std::string and compare/hash them as type irc::string
31  * by converting them internally. This makes them
32  * backwards compatible with other code which is not
33  * aware of irc::string.
34  *******************************************************/
35
36 /** Required namespaces and symbols */
37 using namespace std;
38
39 /** aton() */
40 using irc::sockets::insp_aton;
41
42 /** nota() */
43 using irc::sockets::insp_ntoa;
44
45 #ifndef LOWERMAP
46 #define LOWERMAP
47 /** A mapping of uppercase to lowercase, including scandinavian
48  * 'oddities' as specified by RFC1459, e.g. { -> [, and | -> \
49  */
50 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 */
51                                 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39,                         /* 20-39 */
52                                 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,                         /* 40-59 */
53                                 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111,             /* 60-79 */
54                                 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 94, 95, 96, 97, 98, 99,           /* 80-99 */
55                                 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,     /* 100-119 */
56                                 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139,     /* 120-139 */
57                                 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159,     /* 140-159 */
58                                 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,     /* 160-179 */
59                                 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199,     /* 180-199 */
60                                 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219,     /* 200-219 */
61                                 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,     /* 220-239 */
62                                 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254, 255                          /* 240-255 */
63 };
64 #endif
65
66 /** The irc namespace contains a number of helper classes.
67  */
68 namespace irc
69 {
70
71         /** This class returns true if two strings match.
72          * Case sensitivity is ignored, and the RFC 'character set'
73          * is adhered to
74          */
75         struct StrHashComp
76         {
77                 /** The operator () does the actual comparison in hash_map
78                  */
79                 bool operator()(const std::string& s1, const std::string& s2) const;
80         };
81
82         /** The irc_char_traits class is used for RFC-style comparison of strings.
83          * This class is used to implement irc::string, a case-insensitive, RFC-
84          * comparing string class.
85          */
86         struct irc_char_traits : std::char_traits<char> {
87
88                 /** Check if two chars match.
89                  * @param c1st First character
90                  * @param c2nd Second character
91                  * @return true if the characters are equal
92                  */
93                 static bool eq(char c1st, char c2nd);
94
95                 /** Check if two chars do NOT match.
96                  * @param c1st First character
97                  * @param c2nd Second character
98                  * @return true if the characters are unequal
99                  */
100                 static bool ne(char c1st, char c2nd);
101
102                 /** Check if one char is less than another.
103                  * @param c1st First character
104                  * @param c2nd Second character
105                  * @return true if c1st is less than c2nd
106                  */
107                 static bool lt(char c1st, char c2nd);
108
109                 /** Compare two strings of size n.
110                  * @param str1 First string
111                  * @param str2 Second string
112                  * @param n Length to compare to
113                  * @return similar to strcmp, zero for equal, less than zero for str1
114                  * being less and greater than zero for str1 being greater than str2.
115                  */
116                 static CoreExport int compare(const char* str1, const char* str2, size_t n);
117
118                 /** Find a char within a string up to position n.
119                  * @param s1 String to find in
120                  * @param n Position to search up to
121                  * @param c Character to search for
122                  * @return Pointer to the first occurance of c in s1
123                  */
124                 static CoreExport const char* find(const char* s1, int  n, char c);
125         };
126
127         /** Compose a hex string from raw data.
128          * @param raw The raw data to compose hex from
129          * @pram rawsz The size of the raw data buffer
130          * @return The hex string.
131          */
132         CoreExport std::string hex(const unsigned char *raw, size_t rawsz);
133
134         /** This typedef declares irc::string based upon irc_char_traits.
135          */
136         typedef basic_string<char, irc_char_traits, allocator<char> > string;
137
138         /** irc::stringjoiner joins string lists into a string, using
139          * the given seperator string.
140          * This class can join a vector of std::string, a deque of
141          * std::string, or a const char** array, using overloaded
142          * constructors.
143          */
144         class CoreExport stringjoiner
145         {
146          private:
147                 /** Output string
148                  */
149                 std::string joined;
150          public:
151                 /** Join elements of a vector, between (and including) begin and end
152                  * @param seperator The string to seperate values with
153                  * @param sequence One or more items to seperate
154                  * @param begin The starting element in the sequence to be joined
155                  * @param end The ending element in the sequence to be joined
156                  */
157                 stringjoiner(const std::string &seperator, const std::vector<std::string> &sequence, int begin, int end);
158                 /** Join elements of a deque, between (and including) begin and end
159                  * @param seperator The string to seperate values with
160                  * @param sequence One or more items to seperate
161                  * @param begin The starting element in the sequence to be joined
162                  * @param end The ending element in the sequence to be joined
163                  */
164                 stringjoiner(const std::string &seperator, const std::deque<std::string> &sequence, int begin, int end);
165                 /** Join elements of an array of char arrays, between (and including) begin and end
166                  * @param seperator The string to seperate values with
167                  * @param sequence One or more items to seperate
168                  * @param begin The starting element in the sequence to be joined
169                  * @param end The ending element in the sequence to be joined
170                  */
171                 stringjoiner(const std::string &seperator, const char** sequence, int begin, int end);
172
173                 /** Get the joined sequence
174                  * @return A reference to the joined string
175                  */
176                 std::string& GetJoined();
177         };
178
179         /** irc::modestacker stacks mode sequences into a list.
180          * It can then reproduce this list, clamped to a maximum of MAXMODES
181          * values per line.
182          */
183         class CoreExport modestacker
184         {
185          private:
186                 /** The mode sequence and its parameters
187                  */
188                 std::deque<std::string> sequence;
189                 /** True if the mode sequence is initially adding
190                  * characters, false if it is initially removing
191                  * them
192                  */
193                 bool adding;
194          public:
195                 /** Construct a new modestacker.
196                  * @param add True if the stack is adding modes,
197                  * false if it is removing them
198                  */
199                 modestacker(bool add);
200                 /** Push a modeletter and its parameter onto the stack.
201                  * No checking is performed as to if this mode actually
202                  * requires a parameter. If you stack invalid mode
203                  * sequences, they will be tidied if and when they are
204                  * passed to a mode parser.
205                  * @param modeletter The mode letter to insert
206                  * @param parameter The parameter for the mode
207                  */
208                 void Push(char modeletter, const std::string &parameter);
209                 /** Push a modeletter without parameter onto the stack.
210                  * No checking is performed as to if this mode actually
211                  * requires a parameter. If you stack invalid mode
212                  * sequences, they will be tidied if and when they are
213                  * passed to a mode parser.
214                  * @param modeletter The mode letter to insert
215                  */
216                 void Push(char modeletter);
217                 /** Push a '+' symbol onto the stack.
218                  */
219                 void PushPlus();
220                 /** Push a '-' symbol onto the stack.
221                  */
222                 void PushMinus();
223                 /** Return zero or more elements which form the
224                  * mode line. This will be clamped to a max of
225                  * MAXMODES items (MAXMODES-1 mode parameters and
226                  * one mode sequence string), and max_line_size
227                  * characters. As specified below, this function
228                  * should be called in a loop until it returns zero,
229                  * indicating there are no more modes to return.
230                  * @param result The deque to populate. This will
231                  * be cleared before it is used.
232                  * @param max_line_size The maximum size of the line
233                  * to build, in characters, seperate to MAXMODES.
234                  * @return The number of elements in the deque.
235                  * The function should be called repeatedly until it
236                  * returns 0, in case there are multiple lines of
237                  * mode changes to be obtained.
238                  */
239                 int GetStackedLine(std::deque<std::string> &result, int max_line_size = 360);
240         };
241
242         /** irc::tokenstream reads a string formatted as per RFC1459 and RFC2812.
243          * It will split the string into 'tokens' each containing one parameter
244          * from the string.
245          * For instance, if it is instantiated with the string:
246          * "PRIVMSG #test :foo bar baz qux"
247          * then each successive call to tokenstream::GetToken() will return
248          * "PRIVMSG", "#test", "foo bar baz qux", "".
249          * Note that if the whole string starts with a colon this is not taken
250          * to mean the string is all one parameter, and the first item in the
251          * list will be ":item". This is to allow for parsing 'source' fields
252          * from data.
253          */
254         class CoreExport tokenstream
255         {
256          private:
257                 /** Original string
258                  */
259                 std::string tokens;
260                 /** Last position of a seperator token
261                  */
262                 std::string::iterator last_starting_position;
263                 /** Current string position
264                  */
265                 std::string::iterator n;
266                 /** True if the last value was an ending value
267                  */
268                 bool last_pushed;
269          public:
270                 /** Create a tokenstream and fill it with the provided data
271                  */
272                 tokenstream(const std::string &source);
273                 ~tokenstream();
274
275                 /** Fetch the next token from the stream as a std::string
276                  * @param token The next token available, or an empty string if none remain
277                  * @return True if tokens are left to be read, false if the last token was just retrieved.
278                  */
279                 bool GetToken(std::string &token);
280
281                 /** Fetch the next token from the stream as an irc::string
282                  * @param token The next token available, or an empty string if none remain
283                  * @return True if tokens are left to be read, false if the last token was just retrieved.
284                  */
285                 bool GetToken(irc::string &token);
286
287                 /** Fetch the next token from the stream as an integer
288                  * @param token The next token available, or undefined if none remain
289                  * @return True if tokens are left to be read, false if the last token was just retrieved.
290                  */
291                 bool GetToken(int &token);
292
293                 /** Fetch the next token from the stream as a long integer
294                  * @param token The next token available, or undefined if none remain
295                  * @return True if tokens are left to be read, false if the last token was just retrieved.
296                  */
297                 bool GetToken(long &token);
298         };
299
300         /** irc::sepstream allows for splitting token seperated lists.
301          * Each successive call to sepstream::GetToken() returns
302          * the next token, until none remain, at which point the method returns
303          * an empty string.
304          */
305         class CoreExport sepstream : public classbase
306         {
307          private:
308                 /** Original string.
309                  */
310                 std::string tokens;
311                 /** Last position of a seperator token
312                  */
313                 std::string::iterator last_starting_position;
314                 /** Current string position
315                  */
316                 std::string::iterator n;
317                 /** Seperator value
318                  */
319                 char sep;
320          public:
321                 /** Create a sepstream and fill it with the provided data
322                  */
323                 sepstream(const std::string &source, char seperator);
324                 virtual ~sepstream();
325
326                 /** Fetch the next token from the stream
327                  * @param token The next token from the stream is placed here
328                  * @return True if tokens still remain, false if there are none left
329                  */
330                 virtual bool GetToken(std::string &token);
331                 
332                 /** Fetch the entire remaining stream, without tokenizing
333                  * @return The remaining part of the stream
334                  */
335                 virtual const std::string GetRemaining();
336                 
337                 /** Returns true if the end of the stream has been reached
338                  * @return True if the end of the stream has been reached, otherwise false
339                  */
340                 virtual bool StreamEnd();
341         };
342
343         /** A derived form of sepstream, which seperates on commas
344          */
345         class CoreExport commasepstream : public sepstream
346         {
347          public:
348                 /** Initialize with comma seperator
349                  */
350                 commasepstream(const std::string &source) : sepstream(source, ',')
351                 {
352                 }
353         };
354
355         /** A derived form of sepstream, which seperates on spaces
356          */
357         class CoreExport spacesepstream : public sepstream
358         {
359          public:
360                 /** Initialize with space seperator
361                  */
362                 spacesepstream(const std::string &source) : sepstream(source, ' ')
363                 {
364                 }
365         };
366
367         /** The portparser class seperates out a port range into integers.
368          * A port range may be specified in the input string in the form
369          * "6660,6661,6662-6669,7020". The end of the stream is indicated by
370          * a return value of 0 from portparser::GetToken(). If you attempt
371          * to specify an illegal range (e.g. one where start >= end, or
372          * start or end < 0) then GetToken() will return the first element
373          * of the pair of numbers.
374          */
375         class CoreExport portparser : public classbase
376         {
377          private:
378                 /** Used to split on commas
379                  */
380                 commasepstream* sep;
381                 /** Current position in a range of ports
382                  */
383                 long in_range;
384                 /** Starting port in a range of ports
385                  */
386                 long range_begin;
387                 /** Ending port in a range of ports
388                  */
389                 long range_end;
390                 /** Allow overlapped port ranges
391                  */
392                 bool overlapped;
393                 /** Used to determine overlapping of ports
394                  * without O(n) algorithm being used
395                  */
396                 std::map<long, bool> overlap_set;
397                 /** Returns true if val overlaps an existing range
398                  */
399                 bool Overlaps(long val);
400          public:
401                 /** Create a portparser and fill it with the provided data
402                  * @param source The source text to parse from
403                  * @param allow_overlapped Allow overlapped ranges
404                  */
405                 portparser(const std::string &source, bool allow_overlapped = true);
406                 /** Frees the internal commasepstream object
407                  */
408                 ~portparser();
409                 /** Fetch the next token from the stream
410                  * @return The next port number is returned, or 0 if none remain
411                  */
412                 long GetToken();
413         };
414
415         /** Used to hold a bitfield definition in dynamicbitmask.
416          * You must be allocated one of these by dynamicbitmask::Allocate(),
417          * you should not fill the values yourself!
418          */
419         typedef std::pair<size_t, unsigned char> bitfield;
420
421         /** The irc::dynamicbitmask class is used to maintain a bitmap of
422          * boolean values, which can grow to any reasonable size no matter
423          * how many bitfields are in it.
424          *
425          * It starts off at 32 bits in size, large enough to hold 32 boolean
426          * values, with a memory allocation of 8 bytes. If you allocate more
427          * than 32 bits, the class will grow the bitmap by 8 bytes at a time
428          * for each set of 8 bitfields you allocate with the Allocate()
429          * method.
430          *
431          * This method is designed so that multiple modules can be allocated
432          * bit values in a bitmap dynamically, rather than having to define
433          * costs in a fixed size unsigned integer and having the possibility
434          * of collisions of values in different third party modules.
435          *
436          * IMPORTANT NOTE:
437          *
438          * To use this class, you must derive from it.
439          * This is because each derived instance has its own freebits array
440          * which can determine what bitfields are allocated on a TYPE BY TYPE
441          * basis, e.g. an irc::dynamicbitmask type for Users, and one for
442          * Channels, etc. You should inheret it in a very simple way as follows.
443          * The base class will resize and maintain freebits as required, you are
444          * just required to make the pointer static and specific to this class
445          * type.
446          *
447          * \code
448          * class mydbitmask : public irc::dynamicbitmask
449          * {
450          *  private:
451          *
452          *      static unsigned char* freebits;
453          *
454          *  public:
455          *
456          *      mydbitmask() : irc::dynamicbitmask()
457          *      {
458          *        freebits = new unsigned char[this->bits_size];
459          *        memset(freebits, 0, this->bits_size);
460          *      }
461          *
462          *      ~mydbitmask()
463          *      {
464          *        delete[] freebits;
465          *      }
466          *
467          *      unsigned char* GetFreeBits()
468          *      {
469          *        return freebits;
470          *      }
471          *
472          *      void SetFreeBits(unsigned char* freebt)
473          *      {
474          *        freebits = freebt;
475          *      }
476          * };
477          * \endcode
478          */
479         class CoreExport dynamicbitmask : public classbase
480         {
481          private:
482                 /** Data bits. We start with four of these,
483                  * and we grow the bitfield as we allocate
484                  * more than 32 entries with Allocate().
485                  */
486                 unsigned char* bits;
487          protected:
488                 /** Current set size (size of freebits and bits).
489                  * Both freebits and bits will ALWAYS be the
490                  * same length.
491                  */
492                 unsigned char bits_size;
493          public:
494                 /** Allocate the initial memory for bits and
495                  * freebits and zero the memory.
496                  */
497                 dynamicbitmask();
498
499                 /** Free the memory used by bits and freebits
500                  */
501                 virtual ~dynamicbitmask();
502
503                 /** Allocate an irc::bitfield.
504                  * @return An irc::bitfield which can be used
505                  * with Get, Deallocate and Toggle methods.
506                  * @throw Can throw std::bad_alloc if there is
507                  * no ram left to grow the bitmask.
508                  */
509                 bitfield Allocate();
510
511                 /** Deallocate an irc::bitfield.
512                  * @param An irc::bitfield to deallocate.
513                  * @return True if the bitfield could be
514                  * deallocated, false if it could not.
515                  */
516                 bool Deallocate(bitfield &pos);
517
518                 /** Toggle the value of a bitfield.
519                  * @param pos A bitfield to allocate, previously
520                  * allocated by dyamicbitmask::Allocate().
521                  * @param state The state to set the field to.
522                  */
523                 void Toggle(bitfield &pos, bool state);
524
525                 /** Get the value of a bitfield.
526                  * @param pos A bitfield to retrieve, previously
527                  * allocated by dyamicbitmask::Allocate().
528                  * @return The value of the bitfield.
529                  * @throw Will throw ModuleException if the bitfield
530                  * you provide is outside of the range
531                  * 0 >= bitfield.first < size_bits.
532                  */
533                 bool Get(bitfield &pos);
534
535                 /** Return the size in bytes allocated to the bits
536                  * array.
537                  * Note that the actual allocation is twice this,
538                  * as there are an equal number of bytes allocated
539                  * for the freebits array.
540                  */
541                 unsigned char GetSize();
542
543                 /** Get free bits mask
544                  */
545                 virtual unsigned char* GetFreeBits() { return NULL; }
546
547                 /** Set free bits mask
548                  */
549                 virtual void SetFreeBits(unsigned char* freebits) { freebits = freebits; }
550         };
551
552         /** Turn _ characters in a string into spaces
553          * @param n String to translate
554          * @return The new value with _ translated to space.
555          */
556         CoreExport const char* Spacify(const char* n);
557 }
558
559 /* Define operators for using >> and << with irc::string to an ostream on an istream. */
560 /* This was endless fun. No. Really. */
561 /* It was also the first core change Ommeh made, if anyone cares */
562
563 /** Operator << for irc::string
564  */
565 inline std::ostream& operator<<(std::ostream &os, const irc::string &str) { return os << str.c_str(); }
566
567 /** Operator >> for irc::string
568  */
569 inline std::istream& operator>>(std::istream &is, irc::string &str)
570 {
571         std::string tmp;
572         is >> tmp;
573         str = tmp.c_str();
574         return is;
575 }
576
577 /* Define operators for + and == with irc::string to std::string for easy assignment
578  * and comparison
579  *
580  * Operator +
581  */
582 inline std::string operator+ (std::string& leftval, irc::string& rightval)
583 {
584         return leftval + std::string(rightval.c_str());
585 }
586
587 /* Define operators for + and == with irc::string to std::string for easy assignment
588  * and comparison
589  *
590  * Operator +
591  */
592 inline irc::string operator+ (irc::string& leftval, std::string& rightval)
593 {
594         return leftval + irc::string(rightval.c_str());
595 }
596
597 /* Define operators for + and == with irc::string to std::string for easy assignment
598  * and comparison
599  *
600  * Operator ==
601  */
602 inline bool operator== (const std::string& leftval, const irc::string& rightval)
603 {
604         return (leftval.c_str() == rightval);
605 }
606
607 /* Define operators for + and == with irc::string to std::string for easy assignment
608  * and comparison
609  *
610  * Operator ==
611  */
612 inline bool operator== (const irc::string& leftval, const std::string& rightval)
613 {
614         return (leftval == rightval.c_str());
615 }
616
617 /* Define operators != for irc::string to std::string for easy comparison
618  */
619 inline bool operator!= (const irc::string& leftval, const std::string& rightval)
620 {
621         return !(leftval == rightval.c_str());
622 }
623
624 /* Define operators != for std::string to irc::string for easy comparison
625  */
626 inline bool operator!= (const std::string& leftval, const irc::string& rightval)
627 {
628         return !(leftval.c_str() == rightval);
629 }
630
631 /** Assign an irc::string to a std::string.
632  */
633 inline std::string assign(const irc::string &other) { return other.c_str(); }
634
635 /** Assign a std::string to an irc::string.
636  */
637 inline irc::string assign(const std::string &other) { return other.c_str(); }
638
639 /** Trim the leading and trailing spaces from a std::string.
640  */
641 inline std::string& trim(std::string &str)
642 {
643         std::string::size_type start = str.find_first_not_of(" ");
644         std::string::size_type end = str.find_last_not_of(" ");
645         if (start == std::string::npos || end == std::string::npos)
646                 str = "";
647         else
648                 str = str.substr(start, end-start+1);
649
650         return str;
651 }
652
653 /** Hashing stuff is totally different on vc++'s hash_map implementation, so to save a buttload of
654  * #ifdefs we'll just do it all at once
655  */
656 namespace nspace
657 {
658         /** Hashing function to hash irc::string
659          */
660 #ifdef WINDOWS
661         template<> class CoreExport hash_compare<irc::string, std::less<irc::string> >
662         {
663         public:
664                 enum { bucket_size = 4, min_buckets = 8 }; /* Got these numbers from the CRT source, if anyone wants to change them feel free. */
665
666                 /** Compare two irc::string values for hashing in hash_map
667                  */
668                 bool operator()(const irc::string & s1, const irc::string & s2) const
669                 {
670                         if(s1.length() != s2.length()) return true;
671                         return (irc::irc_char_traits::compare(s1.c_str(), s2.c_str(), s1.length()) < 0);
672                 }
673                 
674                 /** Hash an irc::string value for hash_map
675                  */
676                 size_t operator()(const irc::string & s) const;
677         };
678
679         template<> class CoreExport hash_compare<std::string, std::less<std::string> >
680         {
681         public:
682                 enum { bucket_size = 4, min_buckets = 8 }; /* Again, from the CRT source */
683
684                 /** Compare two std::string values for hashing in hash_map
685                  */
686                 bool operator()(const std::string & s1, const std::string & s2) const
687                 {
688                         if(s1.length() != s2.length()) return true;
689                         return (irc::irc_char_traits::compare(s1.c_str(), s2.c_str(), s1.length()) < 0);
690                 }
691                 
692                 /** Hash a std::string using RFC1459 case sensitivity rules
693                 * @param s A string to hash
694                 * @return The hash value
695                 */
696                 size_t operator()(const std::string & s) const;
697         };
698 #else
699         template<> struct hash<irc::string>
700         {
701                 /** Hash an irc::string using RFC1459 case sensitivity rules
702                  * @param s A string to hash
703                  * @return The hash value
704                  */
705                 size_t operator()(const irc::string &s) const;
706         };
707
708         template<> struct hash<std::string>
709         {
710                 /** Hash a std::string using RFC1459 case sensitivity rules
711                 * @param s A string to hash
712                 * @return The hash value
713                 */
714                 size_t operator()(const string &s) const;
715         };
716 #endif
717
718         /** Convert a string to lower case respecting RFC1459
719         * @param n A string to lowercase
720         */
721         void strlower(char *n);
722 }
723
724 #endif
725