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 * There are functors that accept std::string and
44 * compare/hash them as type irc::string by using
45 * mapping arrays internally.
46 *******************************************************/
48 /** Seperate from the other casemap tables so that code *can* still exclusively rely on RFC casemapping
51 * This is provided as a pointer so that modules can change it to their custom mapping tables,
52 * e.g. for national character support.
54 CoreExport extern unsigned const char *national_case_insensitive_map;
56 /** A mapping of uppercase to lowercase, including scandinavian
57 * 'oddities' as specified by RFC1459, e.g. { -> [, and | -> \
59 CoreExport extern unsigned const char rfc_case_insensitive_map[256];
61 /** Case insensitive map, ASCII rules.
65 CoreExport extern unsigned const char ascii_case_insensitive_map[256];
67 /** The irc namespace contains a number of helper classes.
71 /** Check if two IRC object (e.g. nick or channel) names are equal.
72 * This function uses national_case_insensitive_map to determine equality, which, by default does comparison
73 * according to RFC 1459, treating certain otherwise non-identical characters as identical.
74 * @param s1 First string to compare
75 * @param s2 Second string to compare
76 * @return True if the two names are equal, false otherwise
78 CoreExport bool equals(const std::string& s1, const std::string& s2);
80 /** This class returns true if two strings match.
81 * Case sensitivity is ignored, and the RFC 'character set'
86 /** The operator () does the actual comparison in hash_map
88 bool operator()(const std::string& s1, const std::string& s2) const
90 return equals(s1, s2);
96 size_t CoreExport operator()(const std::string &s) const;
99 struct insensitive_swo
101 bool CoreExport operator()(const std::string& a, const std::string& b) const;
104 /** The irc_char_traits class is used for RFC-style comparison of strings.
105 * This class is used to implement irc::string, a case-insensitive, RFC-
106 * comparing string class.
108 struct CoreExport irc_char_traits : public std::char_traits<char>
110 /** Check if two chars match.
111 * @param c1st First character
112 * @param c2nd Second character
113 * @return true if the characters are equal
115 static bool eq(char c1st, char c2nd);
117 /** Check if two chars do NOT match.
118 * @param c1st First character
119 * @param c2nd Second character
120 * @return true if the characters are unequal
122 static bool ne(char c1st, char c2nd);
124 /** Check if one char is less than another.
125 * @param c1st First character
126 * @param c2nd Second character
127 * @return true if c1st is less than c2nd
129 static bool lt(char c1st, char c2nd);
131 /** Compare two strings of size n.
132 * @param str1 First string
133 * @param str2 Second string
134 * @param n Length to compare to
135 * @return similar to strcmp, zero for equal, less than zero for str1
136 * being less and greater than zero for str1 being greater than str2.
138 static int compare(const char* str1, const char* str2, size_t n);
140 /** Find a char within a string up to position n.
141 * @param s1 String to find in
142 * @param n Position to search up to
143 * @param c Character to search for
144 * @return Pointer to the first occurance of c in s1
146 static const char* find(const char* s1, int n, char c);
149 /** This typedef declares irc::string based upon irc_char_traits.
151 typedef std::basic_string<char, irc_char_traits, std::allocator<char> > string;
153 /** Joins the contents of a vector to a string.
154 * @param sequence Zero or more items to join.
155 * @param separator The character to place between the items, defaults to ' ' (space).
156 * @return Joined string.
158 std::string CoreExport stringjoiner(const std::vector<std::string>& sequence, char separator = ' ');
160 /** irc::sepstream allows for splitting token seperated lists.
161 * Each successive call to sepstream::GetToken() returns
162 * the next token, until none remain, at which point the method returns
165 class CoreExport sepstream
174 /** Current string position
177 /** If set then GetToken() can return an empty string
181 /** Create a sepstream and fill it with the provided data
183 sepstream(const std::string &source, char separator, bool allowempty = false);
185 /** Fetch the next token from the stream
186 * @param token The next token from the stream is placed here
187 * @return True if tokens still remain, false if there are none left
189 bool GetToken(std::string& token);
191 /** Fetch the entire remaining stream, without tokenizing
192 * @return The remaining part of the stream
194 const std::string GetRemaining();
196 /** Returns true if the end of the stream has been reached
197 * @return True if the end of the stream has been reached, otherwise false
202 /** A derived form of sepstream, which seperates on commas
204 class CoreExport commasepstream : public sepstream
207 /** Initialize with comma separator
209 commasepstream(const std::string &source, bool allowempty = false) : sepstream(source, ',', allowempty)
214 /** A derived form of sepstream, which seperates on spaces
216 class CoreExport spacesepstream : public sepstream
219 /** Initialize with space separator
221 spacesepstream(const std::string &source, bool allowempty = false) : sepstream(source, ' ', allowempty)
226 /** irc::tokenstream reads a string formatted as per RFC1459 and RFC2812.
227 * It will split the string into 'tokens' each containing one parameter
229 * For instance, if it is instantiated with the string:
230 * "PRIVMSG #test :foo bar baz qux"
231 * then each successive call to tokenstream::GetToken() will return
232 * "PRIVMSG", "#test", "foo bar baz qux", "".
233 * Note that if the whole string starts with a colon this is not taken
234 * to mean the string is all one parameter, and the first item in the
235 * list will be ":item". This is to allow for parsing 'source' fields
238 class CoreExport tokenstream : private spacesepstream
241 /** Create a tokenstream and fill it with the provided data
243 tokenstream(const std::string &source);
245 /** Fetch the next token from the stream as a std::string
246 * @param token The next token available, or an empty string if none remain
247 * @return True if tokens are left to be read, false if the last token was just retrieved.
249 bool GetToken(std::string &token);
251 /** Fetch the next token from the stream as an integer
252 * @param token The next token available, or undefined if none remain
253 * @return True if tokens are left to be read, false if the last token was just retrieved.
255 bool GetToken(int &token);
257 /** Fetch the next token from the stream as a long integer
258 * @param token The next token available, or undefined if none remain
259 * @return True if tokens are left to be read, false if the last token was just retrieved.
261 bool GetToken(long &token);
264 /** The portparser class seperates out a port range into integers.
265 * A port range may be specified in the input string in the form
266 * "6660,6661,6662-6669,7020". The end of the stream is indicated by
267 * a return value of 0 from portparser::GetToken(). If you attempt
268 * to specify an illegal range (e.g. one where start >= end, or
269 * start or end < 0) then GetToken() will return the first element
270 * of the pair of numbers.
272 class CoreExport portparser
276 /** Used to split on commas
280 /** Current position in a range of ports
284 /** Starting port in a range of ports
288 /** Ending port in a range of ports
292 /** Allow overlapped port ranges
296 /** Used to determine overlapping of ports
297 * without O(n) algorithm being used
299 std::set<long> overlap_set;
301 /** Returns true if val overlaps an existing range
303 bool Overlaps(long val);
306 /** Create a portparser and fill it with the provided data
307 * @param source The source text to parse from
308 * @param allow_overlapped Allow overlapped ranges
310 portparser(const std::string &source, bool allow_overlapped = true);
312 /** Fetch the next token from the stream
313 * @return The next port number is returned, or 0 if none remain