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 /** Check whether \p needle exists within \p haystack.
81 * @param haystack The string to search within.
82 * @param needle The string to search for.
83 * @return Either the index at which \p needle was found or std::string::npos.
85 CoreExport size_t find(const std::string& haystack, const std::string& needle);
87 /** This class returns true if two strings match.
88 * Case sensitivity is ignored, and the RFC 'character set'
93 /** The operator () does the actual comparison in hash_map
95 bool operator()(const std::string& s1, const std::string& s2) const
97 return equals(s1, s2);
103 size_t CoreExport operator()(const std::string &s) const;
106 struct insensitive_swo
108 bool CoreExport operator()(const std::string& a, const std::string& b) const;
111 /** Joins the contents of a vector to a string.
112 * @param sequence Zero or more items to join.
113 * @param separator The character to place between the items, defaults to ' ' (space).
114 * @return Joined string.
116 std::string CoreExport stringjoiner(const std::vector<std::string>& sequence, char separator = ' ');
118 /** irc::sepstream allows for splitting token seperated lists.
119 * Each successive call to sepstream::GetToken() returns
120 * the next token, until none remain, at which point the method returns
123 class CoreExport sepstream
132 /** Current string position
135 /** If set then GetToken() can return an empty string
139 /** Create a sepstream and fill it with the provided data
141 sepstream(const std::string &source, char separator, bool allowempty = false);
143 /** Fetch the next token from the stream
144 * @param token The next token from the stream is placed here
145 * @return True if tokens still remain, false if there are none left
147 bool GetToken(std::string& token);
149 /** Fetch the entire remaining stream, without tokenizing
150 * @return The remaining part of the stream
152 const std::string GetRemaining();
154 /** Returns true if the end of the stream has been reached
155 * @return True if the end of the stream has been reached, otherwise false
160 /** A derived form of sepstream, which seperates on commas
162 class CoreExport commasepstream : public sepstream
165 /** Initialize with comma separator
167 commasepstream(const std::string &source, bool allowempty = false) : sepstream(source, ',', allowempty)
172 /** A derived form of sepstream, which seperates on spaces
174 class CoreExport spacesepstream : public sepstream
177 /** Initialize with space separator
179 spacesepstream(const std::string &source, bool allowempty = false) : sepstream(source, ' ', allowempty)
184 /** irc::tokenstream reads a string formatted as per RFC1459 and RFC2812.
185 * It will split the string into 'tokens' each containing one parameter
187 * For instance, if it is instantiated with the string:
188 * "PRIVMSG #test :foo bar baz qux"
189 * then each successive call to tokenstream::GetToken() will return
190 * "PRIVMSG", "#test", "foo bar baz qux", "".
191 * Note that if the whole string starts with a colon this is not taken
192 * to mean the string is all one parameter, and the first item in the
193 * list will be ":item". This is to allow for parsing 'source' fields
196 class CoreExport tokenstream : private spacesepstream
199 /** Create a tokenstream and fill it with the provided data
201 tokenstream(const std::string &source);
203 /** Fetch the next token from the stream as a std::string
204 * @param token The next token available, or an empty string if none remain
205 * @return True if tokens are left to be read, false if the last token was just retrieved.
207 bool GetToken(std::string &token);
209 /** Fetch the next token from the stream as an integer
210 * @param token The next token available, or undefined if none remain
211 * @return True if tokens are left to be read, false if the last token was just retrieved.
213 bool GetToken(int &token);
215 /** Fetch the next token from the stream as a long integer
216 * @param token The next token available, or undefined if none remain
217 * @return True if tokens are left to be read, false if the last token was just retrieved.
219 bool GetToken(long &token);
222 /** The portparser class seperates out a port range into integers.
223 * A port range may be specified in the input string in the form
224 * "6660,6661,6662-6669,7020". The end of the stream is indicated by
225 * a return value of 0 from portparser::GetToken(). If you attempt
226 * to specify an illegal range (e.g. one where start >= end, or
227 * start or end < 0) then GetToken() will return the first element
228 * of the pair of numbers.
230 class CoreExport portparser
234 /** Used to split on commas
238 /** Current position in a range of ports
242 /** Starting port in a range of ports
246 /** Ending port in a range of ports
250 /** Allow overlapped port ranges
254 /** Used to determine overlapping of ports
255 * without O(n) algorithm being used
257 std::set<long> overlap_set;
259 /** Returns true if val overlaps an existing range
261 bool Overlaps(long val);
264 /** Create a portparser and fill it with the provided data
265 * @param source The source text to parse from
266 * @param allow_overlapped Allow overlapped ranges
268 portparser(const std::string &source, bool allow_overlapped = true);
270 /** Fetch the next token from the stream
271 * @return The next port number is returned, or 0 if none remain