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