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
  41 namespace nspace
  42 {
  43 #ifdef GCC34
  44         template<> struct hash<in_addr>
  45 #else
  46         template<> struct nspace::hash<in_addr>
  47 #endif
  48         {
  49                 size_t operator()(const struct in_addr &a) const;
  50         };
  51 #ifdef GCC34
  52         template<> struct hash<string>
  53 #else
  54         template<> struct nspace::hash<string>
  55 #endif
  56         {
  57                 size_t operator()(const string &s) const;
  58         };
  59 }
  60
  61 /** The irc namespace contains a number of helper classes.
  62  */
  63 namespace irc
  64 {
  65
  66         /** This class returns true if two strings match.
  67          * Case sensitivity is ignored, and the RFC 'character set'
  68          * is adhered to
  69          */
  70         struct StrHashComp
  71         {
  72                 /** The operator () does the actual comparison in hash_map
  73                  */
  74                 bool operator()(const std::string& s1, const std::string& s2) const;
  75         };
  76
  77
  78         /** This class returns true if two in_addr structs match.
  79          * Checking is done by copying both into a size_t then doing a
  80          * numeric comparison of the two.
  81          */
  82         struct InAddr_HashComp
  83         {
  84                 /** The operator () does the actual comparison in hash_map
  85                  */
  86                 bool operator()(const in_addr &s1, const in_addr &s2) const;
  87         };
  88
  89
  90         /** The irc_char_traits class is used for RFC-style comparison of strings.
  91          * This class is used to implement irc::string, a case-insensitive, RFC-
  92          * comparing string class.
  93          */
  94         struct irc_char_traits : std::char_traits<char> {
  95
  96                 /** Check if two chars match
  97                  */
  98                 static bool eq(char c1st, char c2nd);
  99
 100                 /** Check if two chars do NOT match
 101                  */
 102                 static bool ne(char c1st, char c2nd);
 103
 104                 /** Check if one char is less than another
 105                  */
 106                 static bool lt(char c1st, char c2nd);
 107
 108                 /** Compare two strings of size n
 109                  */
 110                 static int compare(const char* str1, const char* str2, size_t n);
 111
 112                 /** Find a char within a string up to position n
 113                  */
 114                 static const char* find(const char* s1, int  n, char c);
 115         };
 116
 117         /** This typedef declares irc::string based upon irc_char_traits
 118          */
 119         typedef basic_string<char, irc_char_traits, allocator<char> > string;
 120 }
 121
 122 /* Define operators for using >> and << with irc::string to an ostream on an istream. */
 123 /* This was endless fun. No. Really. */
 124 /* It was also the first core change Ommeh made, if anyone cares */
 125
 126 std::ostream& operator<<(std::ostream &os, const irc::string &str);
 127 std::istream& operator>>(std::istream &is, irc::string &str);
 128
 129 /* Define operators for + and == with irc::string to std::string for easy assignment
 130  * and comparison - Brain
 131  */
 132
 133 std::string operator+ (std::string& leftval, irc::string& rightval);
 134 irc::string operator+ (irc::string& leftval, std::string& rightval);
 135 bool operator== (std::string& leftval, irc::string& rightval);
 136 bool operator== (irc::string& leftval, std::string& rightval);
 137
 138 #endif