2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2011 Adam <Adam@anope.org>
5 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
6 * Copyright (C) 2007, 2009 Dennis Friis <peavey@inspircd.org>
7 * Copyright (C) 2005-2009 Craig Edwards <craigedwards@brainbox.cc>
8 * Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
9 * Copyright (C) 2008 Pippijn van Steenhoven <pip88nl@gmail.com>
11 * This file is part of InspIRCd. InspIRCd is free software: you can
12 * redistribute it and/or modify it under the terms of the GNU General Public
13 * License as published by the Free Software Foundation, version 2.
15 * This program is distributed in the hope that it will be useful, but WITHOUT
16 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
17 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
20 * You should have received a copy of the GNU General Public License
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
35 /*******************************************************
36 * This file contains classes and templates that deal
37 * with the comparison and hashing of 'irc strings'.
38 * An 'irc string' is a string which compares in a
39 * case insensitive manner, and as per RFC 1459 will
40 * treat [ identical to {, ] identical to }, and \
43 * Our hashing functions are designed to accept
44 * std::string and compare/hash them as type irc::string
45 * by converting them internally. This makes them
46 * backwards compatible with other code which is not
47 * aware of irc::string.
48 *******************************************************/
50 /** Seperate from the other casemap tables so that code *can* still exclusively rely on RFC casemapping
53 * This is provided as a pointer so that modules can change it to their custom mapping tables,
54 * e.g. for national character support.
56 CoreExport extern unsigned const char *national_case_insensitive_map;
58 /** A mapping of uppercase to lowercase, including scandinavian
59 * 'oddities' as specified by RFC1459, e.g. { -> [, and | -> \
61 CoreExport extern unsigned const char rfc_case_insensitive_map[256];
63 /** Case insensitive map, ASCII rules.
67 CoreExport extern unsigned const char ascii_case_insensitive_map[256];
69 /** Case sensitive (identity) map.
71 CoreExport extern unsigned const char rfc_case_sensitive_map[256];
73 template<typename T> const T& SearchAndReplace(T& text, const T& pattern, const T& replace)
76 if ((!pattern.empty()) && (!text.empty()))
78 for (std::string::size_type n = 0; n != text.length(); ++n)
80 if (text.length() >= pattern.length() && text.substr(n, pattern.length()) == pattern)
82 // Found the pattern in the text, replace it, and advance
83 replacement.append(replace);
84 n = n + pattern.length() - 1;
88 replacement += text[n];
96 /** The irc namespace contains a number of helper classes.
101 /** Check if two IRC object (e.g. nick or channel) names are equal.
102 * This function uses national_case_insensitive_map to determine equality, which, by default does comparison
103 * according to RFC 1459, treating certain otherwise non-identical characters as identical.
104 * @param s1 First string to compare
105 * @param s2 Second string to compare
106 * @return True if the two names are equal, false otherwise
108 CoreExport bool equals(const std::string& s1, const std::string& s2);
110 /** This class returns true if two strings match.
111 * Case sensitivity is ignored, and the RFC 'character set'
116 /** The operator () does the actual comparison in hash_map
118 bool operator()(const std::string& s1, const std::string& s2) const
120 return equals(s1, s2);
126 size_t CoreExport operator()(const std::string &s) const;
129 struct insensitive_swo
131 bool CoreExport operator()(const std::string& a, const std::string& b) const;
134 /** The irc_char_traits class is used for RFC-style comparison of strings.
135 * This class is used to implement irc::string, a case-insensitive, RFC-
136 * comparing string class.
138 struct CoreExport irc_char_traits : public std::char_traits<char>
140 /** Check if two chars match.
141 * @param c1st First character
142 * @param c2nd Second character
143 * @return true if the characters are equal
145 static bool eq(char c1st, char c2nd);
147 /** Check if two chars do NOT match.
148 * @param c1st First character
149 * @param c2nd Second character
150 * @return true if the characters are unequal
152 static bool ne(char c1st, char c2nd);
154 /** Check if one char is less than another.
155 * @param c1st First character
156 * @param c2nd Second character
157 * @return true if c1st is less than c2nd
159 static bool lt(char c1st, char c2nd);
161 /** Compare two strings of size n.
162 * @param str1 First string
163 * @param str2 Second string
164 * @param n Length to compare to
165 * @return similar to strcmp, zero for equal, less than zero for str1
166 * being less and greater than zero for str1 being greater than str2.
168 static int compare(const char* str1, const char* str2, size_t n);
170 /** Find a char within a string up to position n.
171 * @param s1 String to find in
172 * @param n Position to search up to
173 * @param c Character to search for
174 * @return Pointer to the first occurance of c in s1
176 static const char* find(const char* s1, int n, char c);
179 /** This typedef declares irc::string based upon irc_char_traits.
181 typedef std::basic_string<char, irc_char_traits, std::allocator<char> > string;
183 /** Joins the contents of a vector to a string.
184 * @param sequence Zero or more items to join.
185 * @separator The character to place between the items.
187 std::string CoreExport stringjoiner(const std::vector<std::string>& sequence, char separator = ' ');
189 /** irc::sepstream allows for splitting token seperated lists.
190 * Each successive call to sepstream::GetToken() returns
191 * the next token, until none remain, at which point the method returns
194 class CoreExport sepstream
203 /** Current string position
206 /** If set then GetToken() can return an empty string
210 /** Create a sepstream and fill it with the provided data
212 sepstream(const std::string &source, char separator, bool allowempty = false);
214 /** Fetch the next token from the stream
215 * @param token The next token from the stream is placed here
216 * @return True if tokens still remain, false if there are none left
218 bool GetToken(std::string& token);
220 /** Fetch the entire remaining stream, without tokenizing
221 * @return The remaining part of the stream
223 const std::string GetRemaining();
225 /** Returns true if the end of the stream has been reached
226 * @return True if the end of the stream has been reached, otherwise false
231 /** A derived form of sepstream, which seperates on commas
233 class CoreExport commasepstream : public sepstream
236 /** Initialize with comma separator
238 commasepstream(const std::string &source, bool allowempty = false) : sepstream(source, ',', allowempty)
243 /** A derived form of sepstream, which seperates on spaces
245 class CoreExport spacesepstream : public sepstream
248 /** Initialize with space separator
250 spacesepstream(const std::string &source, bool allowempty = false) : sepstream(source, ' ', allowempty)
255 /** irc::tokenstream reads a string formatted as per RFC1459 and RFC2812.
256 * It will split the string into 'tokens' each containing one parameter
258 * For instance, if it is instantiated with the string:
259 * "PRIVMSG #test :foo bar baz qux"
260 * then each successive call to tokenstream::GetToken() will return
261 * "PRIVMSG", "#test", "foo bar baz qux", "".
262 * Note that if the whole string starts with a colon this is not taken
263 * to mean the string is all one parameter, and the first item in the
264 * list will be ":item". This is to allow for parsing 'source' fields
267 class CoreExport tokenstream : private spacesepstream
270 /** Create a tokenstream and fill it with the provided data
272 tokenstream(const std::string &source);
274 /** Fetch the next token from the stream as a std::string
275 * @param token The next token available, or an empty string if none remain
276 * @return True if tokens are left to be read, false if the last token was just retrieved.
278 bool GetToken(std::string &token);
280 /** Fetch the next token from the stream as an integer
281 * @param token The next token available, or undefined if none remain
282 * @return True if tokens are left to be read, false if the last token was just retrieved.
284 bool GetToken(int &token);
286 /** Fetch the next token from the stream as a long integer
287 * @param token The next token available, or undefined if none remain
288 * @return True if tokens are left to be read, false if the last token was just retrieved.
290 bool GetToken(long &token);
293 /** The portparser class seperates out a port range into integers.
294 * A port range may be specified in the input string in the form
295 * "6660,6661,6662-6669,7020". The end of the stream is indicated by
296 * a return value of 0 from portparser::GetToken(). If you attempt
297 * to specify an illegal range (e.g. one where start >= end, or
298 * start or end < 0) then GetToken() will return the first element
299 * of the pair of numbers.
301 class CoreExport portparser
305 /** Used to split on commas
309 /** Current position in a range of ports
313 /** Starting port in a range of ports
317 /** Ending port in a range of ports
321 /** Allow overlapped port ranges
325 /** Used to determine overlapping of ports
326 * without O(n) algorithm being used
328 std::set<long> overlap_set;
330 /** Returns true if val overlaps an existing range
332 bool Overlaps(long val);
335 /** Create a portparser and fill it with the provided data
336 * @param source The source text to parse from
337 * @param allow_overlapped Allow overlapped ranges
339 portparser(const std::string &source, bool allow_overlapped = true);
341 /** Fetch the next token from the stream
342 * @return The next port number is returned, or 0 if none remain
348 /* Define operators for using >> and << with irc::string to an ostream on an istream. */
349 /* This was endless fun. No. Really. */
350 /* It was also the first core change Ommeh made, if anyone cares */
352 /** Operator << for irc::string
354 inline std::ostream& operator<<(std::ostream &os, const irc::string &str) { return os << str.c_str(); }
356 /** Operator >> for irc::string
358 inline std::istream& operator>>(std::istream &is, irc::string &str)
366 /* Define operators for + and == with irc::string to std::string for easy assignment
371 inline std::string operator+ (std::string& leftval, irc::string& rightval)
373 return leftval + std::string(rightval.c_str());
376 /* Define operators for + and == with irc::string to std::string for easy assignment
381 inline irc::string operator+ (irc::string& leftval, std::string& rightval)
383 return leftval + irc::string(rightval.c_str());
386 /* Define operators for + and == with irc::string to std::string for easy assignment
391 inline bool operator== (const std::string& leftval, const irc::string& rightval)
393 return (leftval.c_str() == rightval);
396 /* Define operators for + and == with irc::string to std::string for easy assignment
401 inline bool operator== (const irc::string& leftval, const std::string& rightval)
403 return (leftval == rightval.c_str());
406 /* Define operators != for irc::string to std::string for easy comparison
408 inline bool operator!= (const irc::string& leftval, const std::string& rightval)
410 return !(leftval == rightval.c_str());
413 /* Define operators != for std::string to irc::string for easy comparison
415 inline bool operator!= (const std::string& leftval, const irc::string& rightval)
417 return !(leftval.c_str() == rightval);
420 /** Assign an irc::string to a std::string.
422 inline std::string assign(const irc::string &other) { return other.c_str(); }
424 /** Assign a std::string to an irc::string.
426 inline irc::string assign(const std::string &other) { return other.c_str(); }