1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
7 * <brain@chatspike.net>
8 * <Craig@chatspike.net>
10 * Written by Craig Edwards, Craig McLure, and others.
11 * This program is free but copyrighted software; see
12 * the file COPYING for details.
14 * ---------------------------------------------------
20 #include "inspircd_config.h"
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 \
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 *******************************************************/
44 template<> struct hash<in_addr>
46 template<> struct nspace::hash<in_addr>
49 size_t operator()(const struct in_addr &a) const;
52 template<> struct hash<string>
54 template<> struct nspace::hash<string>
57 size_t operator()(const string &s) const;
61 /** The irc namespace contains a number of helper classes.
66 /** This class returns true if two strings match.
67 * Case sensitivity is ignored, and the RFC 'character set'
72 /** The operator () does the actual comparison in hash_map
74 bool operator()(const std::string& s1, const std::string& s2) const;
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.
82 struct InAddr_HashComp
84 /** The operator () does the actual comparison in hash_map
86 bool operator()(const in_addr &s1, const in_addr &s2) const;
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.
94 struct irc_char_traits : std::char_traits<char> {
96 /** Check if two chars match
98 static bool eq(char c1st, char c2nd);
100 /** Check if two chars do NOT match
102 static bool ne(char c1st, char c2nd);
104 /** Check if one char is less than another
106 static bool lt(char c1st, char c2nd);
108 /** Compare two strings of size n
110 static int compare(const char* str1, const char* str2, size_t n);
112 /** Find a char within a string up to position n
114 static const char* find(const char* s1, int n, char c);
117 /** This typedef declares irc::string based upon irc_char_traits
119 typedef basic_string<char, irc_char_traits, allocator<char> > string;
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 */
126 std::ostream& operator<<(std::ostream &os, const irc::string &str);
127 std::istream& operator>>(std::istream &is, irc::string &str);
129 /* Define operators for + and == with irc::string to std::string for easy assignment
130 * and comparison - Brain
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);