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 *******************************************************/
40 using irc::sockets::insp_aton;
41 using irc::sockets::insp_ntoa;
42 using irc::sockets::insp_inaddr;
44 /** Because of weirdness in g++, before 3.x this was namespace std. It's now __gnu_cxx.
45 * This is a #define'd alias.
49 /** Convert a string to lower case respecting RFC1459
50 * @param n A string to lowercase
52 void strlower(char *n);
54 /** Hashing function to hash insp_inaddr structs
56 template<> struct hash<insp_inaddr>
58 /** Hash an insp_inaddr
59 * @param a An insp_inaddr to hash
60 * @return The hash value
62 size_t operator()(const insp_inaddr &a) const;
65 /** Hashing function to hash std::string without respect to case
67 template<> struct hash<std::string>
69 /** Hash a std::string using RFC1459 case sensitivity rules
70 * @param s A string to hash
71 * @return The hash value
73 size_t operator()(const string &s) const;
77 /** The irc namespace contains a number of helper classes.
82 /** This class returns true if two strings match.
83 * Case sensitivity is ignored, and the RFC 'character set'
88 /** The operator () does the actual comparison in hash_map
90 bool operator()(const std::string& s1, const std::string& s2) const;
94 /** This class returns true if two insp_inaddr structs match.
95 * Checking is done by copying both into a size_t then doing a
96 * numeric comparison of the two.
98 struct InAddr_HashComp
100 /** The operator () does the actual comparison in hash_map
102 bool operator()(const insp_inaddr &s1, const insp_inaddr &s2) const;
105 /** irc::tokenstream reads a string formatted as per RFC1459 and RFC2812.
106 * It will split the string into 'tokens' each containing one parameter
108 * For instance, if it is instantiated with the string:
109 * "PRIVMSG #test :foo bar baz qux"
110 * then each successive call to tokenstream::GetToken() will return
111 * "PRIVMSG", "#test", "foo bar baz qux", "".
112 * Note that if the whole string starts with a colon this is not taken
113 * to mean the string is all one parameter, and the first item in the
114 * list will be ":item". This is to allow for parsing 'source' fields
121 std::string::iterator last_starting_position;
122 std::string::iterator n;
125 /** Create a tokenstream and fill it with the provided data
127 tokenstream(const std::string &source);
130 /** Fetch the next token from the stream
131 * @returns The next token is returned, or an empty string if none remain
133 const std::string GetToken();
136 /** irc::commasepstream allows for splitting comma seperated lists.
137 * Lists passed to irc::commasepstream should not contain spaces
138 * after the commas, or this will be taken to be part of the item
139 * data. Each successive call to commasepstream::GetToken() returns
140 * the next token, until none remain, at which point the method returns
147 std::string::iterator last_starting_position;
148 std::string::iterator n;
150 /** Create a commasepstream and fill it with the provided data
152 commasepstream(const std::string &source);
155 /** Fetch the next token from the stream
156 * @returns The next token is returned, or an empty string if none remain
158 const std::string GetToken();
162 /** The irc_char_traits class is used for RFC-style comparison of strings.
163 * This class is used to implement irc::string, a case-insensitive, RFC-
164 * comparing string class.
166 struct irc_char_traits : std::char_traits<char> {
168 /** Check if two chars match
170 static bool eq(char c1st, char c2nd);
172 /** Check if two chars do NOT match
174 static bool ne(char c1st, char c2nd);
176 /** Check if one char is less than another
178 static bool lt(char c1st, char c2nd);
180 /** Compare two strings of size n
182 static int compare(const char* str1, const char* str2, size_t n);
184 /** Find a char within a string up to position n
186 static const char* find(const char* s1, int n, char c);
189 /** This typedef declares irc::string based upon irc_char_traits
191 typedef basic_string<char, irc_char_traits, allocator<char> > string;
194 /* Define operators for using >> and << with irc::string to an ostream on an istream. */
195 /* This was endless fun. No. Really. */
196 /* It was also the first core change Ommeh made, if anyone cares */
197 std::ostream& operator<<(std::ostream &os, const irc::string &str);
198 std::istream& operator>>(std::istream &is, irc::string &str);
200 /* Define operators for + and == with irc::string to std::string for easy assignment
201 * and comparison - Brain
203 std::string operator+ (std::string& leftval, irc::string& rightval);
204 irc::string operator+ (irc::string& leftval, std::string& rightval);
205 bool operator== (std::string& leftval, irc::string& rightval);
206 bool operator== (irc::string& leftval, std::string& rightval);