+ class CoreExport modestacker
+ {
+ private:
+ /** The mode sequence and its parameters
+ */
+ std::deque<std::string> sequence;
+
+ /** True if the mode sequence is initially adding
+ * characters, false if it is initially removing
+ * them
+ */
+ bool adding;
+ public:
+
+ /** Construct a new modestacker.
+ * @param add True if the stack is adding modes,
+ * false if it is removing them
+ */
+ modestacker(bool add);
+
+ /** Push a modeletter and its parameter onto the stack.
+ * No checking is performed as to if this mode actually
+ * requires a parameter. If you stack invalid mode
+ * sequences, they will be tidied if and when they are
+ * passed to a mode parser.
+ * @param modeletter The mode letter to insert
+ * @param parameter The parameter for the mode
+ */
+ void Push(char modeletter, const std::string ¶meter);
+
+ /** Push a modeletter without parameter onto the stack.
+ * No checking is performed as to if this mode actually
+ * requires a parameter. If you stack invalid mode
+ * sequences, they will be tidied if and when they are
+ * passed to a mode parser.
+ * @param modeletter The mode letter to insert
+ */
+ void Push(char modeletter);
+
+ /** Push a '+' symbol onto the stack.
+ */
+ void PushPlus();
+
+ /** Push a '-' symbol onto the stack.
+ */
+ void PushMinus();
+
+ /** Return zero or more elements which form the
+ * mode line. This will be clamped to a max of
+ * MAXMODES items (MAXMODES-1 mode parameters and
+ * one mode sequence string), and max_line_size
+ * characters. As specified below, this function
+ * should be called in a loop until it returns zero,
+ * indicating there are no more modes to return.
+ * @param result The vector to populate. This will not
+ * be cleared before it is used.
+ * @param max_line_size The maximum size of the line
+ * to build, in characters, seperate to MAXMODES.
+ * @return The number of elements in the deque.
+ * The function should be called repeatedly until it
+ * returns 0, in case there are multiple lines of
+ * mode changes to be obtained.
+ */
+ int GetStackedLine(std::vector<std::string> &result, int max_line_size = 360);
+
+ /** deprecated compatability interface - TODO remove */
+ int GetStackedLine(std::deque<std::string> &result, int max_line_size = 360) {
+ std::vector<std::string> r;
+ int n = GetStackedLine(r, max_line_size);
+ result.clear();
+ result.insert(result.end(), r.begin(), r.end());
+ return n;
+ }
+ };
+
+ /** irc::tokenstream reads a string formatted as per RFC1459 and RFC2812.
+ * It will split the string into 'tokens' each containing one parameter
+ * from the string.
+ * For instance, if it is instantiated with the string:
+ * "PRIVMSG #test :foo bar baz qux"
+ * then each successive call to tokenstream::GetToken() will return
+ * "PRIVMSG", "#test", "foo bar baz qux", "".
+ * Note that if the whole string starts with a colon this is not taken
+ * to mean the string is all one parameter, and the first item in the
+ * list will be ":item". This is to allow for parsing 'source' fields
+ * from data.
+ */
+ class CoreExport tokenstream
+ {
+ private:
+
+ /** Original string
+ */
+ std::string tokens;
+
+ /** Last position of a seperator token
+ */
+ std::string::iterator last_starting_position;
+
+ /** Current string position
+ */
+ std::string::iterator n;
+
+ /** True if the last value was an ending value
+ */
+ bool last_pushed;
+ public:
+
+ /** Create a tokenstream and fill it with the provided data
+ */
+ tokenstream(const std::string &source);
+
+ /** Destructor
+ */
+ ~tokenstream();
+
+ /** Fetch the next token from the stream as a std::string
+ * @param token The next token available, or an empty string if none remain
+ * @return True if tokens are left to be read, false if the last token was just retrieved.
+ */
+ bool GetToken(std::string &token);
+
+ /** Fetch the next token from the stream as an irc::string
+ * @param token The next token available, or an empty string if none remain
+ * @return True if tokens are left to be read, false if the last token was just retrieved.
+ */
+ bool GetToken(irc::string &token);
+
+ /** Fetch the next token from the stream as an integer
+ * @param token The next token available, or undefined if none remain
+ * @return True if tokens are left to be read, false if the last token was just retrieved.
+ */
+ bool GetToken(int &token);
+
+ /** Fetch the next token from the stream as a long integer
+ * @param token The next token available, or undefined if none remain
+ * @return True if tokens are left to be read, false if the last token was just retrieved.
+ */
+ bool GetToken(long &token);
+ };
+
+ /** irc::sepstream allows for splitting token seperated lists.
+ * Each successive call to sepstream::GetToken() returns
+ * the next token, until none remain, at which point the method returns
+ * an empty string.
+ */
+ class CoreExport sepstream
+ {
+ private:
+ /** Original string.
+ */
+ std::string tokens;
+ /** Last position of a seperator token
+ */
+ std::string::iterator last_starting_position;
+ /** Current string position
+ */
+ std::string::iterator n;
+ /** Seperator value
+ */
+ char sep;
+ public:
+ /** Create a sepstream and fill it with the provided data
+ */
+ sepstream(const std::string &source, char seperator);
+
+ /** Destructor
+ */
+ virtual ~sepstream();
+
+ /** Fetch the next token from the stream
+ * @param token The next token from the stream is placed here
+ * @return True if tokens still remain, false if there are none left
+ */
+ virtual bool GetToken(std::string &token);
+
+ /** Fetch the entire remaining stream, without tokenizing
+ * @return The remaining part of the stream
+ */
+ virtual const std::string GetRemaining();
+
+ /** Returns true if the end of the stream has been reached
+ * @return True if the end of the stream has been reached, otherwise false
+ */
+ virtual bool StreamEnd();
+ };
+
+ /** A derived form of sepstream, which seperates on commas
+ */
+ class CoreExport commasepstream : public sepstream
+ {
+ public:
+ /** Initialize with comma seperator
+ */
+ commasepstream(const std::string &source) : sepstream(source, ',')
+ {
+ }
+ };
+
+ /** A derived form of sepstream, which seperates on spaces
+ */
+ class CoreExport spacesepstream : public sepstream
+ {
+ public:
+ /** Initialize with space seperator
+ */
+ spacesepstream(const std::string &source) : sepstream(source, ' ')
+ {
+ }
+ };
+
+ /** The portparser class seperates out a port range into integers.
+ * A port range may be specified in the input string in the form
+ * "6660,6661,6662-6669,7020". The end of the stream is indicated by
+ * a return value of 0 from portparser::GetToken(). If you attempt
+ * to specify an illegal range (e.g. one where start >= end, or
+ * start or end < 0) then GetToken() will return the first element
+ * of the pair of numbers.
+ */
+ class CoreExport portparser
+ {
+ private:
+
+ /** Used to split on commas
+ */
+ commasepstream* sep;
+
+ /** Current position in a range of ports
+ */
+ long in_range;
+
+ /** Starting port in a range of ports
+ */
+ long range_begin;
+
+ /** Ending port in a range of ports
+ */
+ long range_end;
+
+ /** Allow overlapped port ranges
+ */
+ bool overlapped;
+
+ /** Used to determine overlapping of ports
+ * without O(n) algorithm being used
+ */
+ std::map<long, bool> overlap_set;
+
+ /** Returns true if val overlaps an existing range
+ */
+ bool Overlaps(long val);
+ public:
+
+ /** Create a portparser and fill it with the provided data
+ * @param source The source text to parse from
+ * @param allow_overlapped Allow overlapped ranges
+ */
+ portparser(const std::string &source, bool allow_overlapped = true);
+
+ /** Frees the internal commasepstream object
+ */
+ ~portparser();
+
+ /** Fetch the next token from the stream
+ * @return The next port number is returned, or 0 if none remain
+ */
+ long GetToken();
+ };
+
+ /** Turn _ characters in a string into spaces
+ * @param n String to translate
+ * @return The new value with _ translated to space.
+ */
+ CoreExport const char* Spacify(const char* n);
+
+ struct hash
+ {
+ /** Hash an irc::string using RFC1459 case sensitivity rules
+ * @param s A string to hash
+ * @return The hash value
+ */
+ size_t CoreExport operator()(const irc::string &s) const;
+ };