+ /** This typedef declares irc::string based upon irc_char_traits.
+ */
+ typedef std::basic_string<char, irc_char_traits, std::allocator<char> > string;
+
+ /** Joins the contents of a vector to a string.
+ * @param sequence Zero or more items to join.
+ * @separator The character to place between the items.
+ */
+ std::string CoreExport stringjoiner(const std::vector<std::string>& sequence, char separator = ' ');
+
+ /** irc::modestacker stacks mode sequences into a list.
+ * It can then reproduce this list, clamped to a maximum of MAXMODES
+ * values per line.
+ */
+ 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);
+
+ };
+
+ /** 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
+ {
+ protected:
+ /** Original string.
+ */
+ std::string tokens;
+ /** Separator value
+ */
+ char sep;
+ /** Current string position
+ */
+ size_t pos;
+ /** If set then GetToken() can return an empty string
+ */
+ bool allow_empty;
+ public:
+ /** Create a sepstream and fill it with the provided data
+ */
+ sepstream(const std::string &source, char separator, bool allowempty = false);
+
+ /** 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
+ */
+ bool GetToken(std::string& token);
+
+ /** Fetch the entire remaining stream, without tokenizing
+ * @return The remaining part of the stream
+ */
+ 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
+ */
+ bool StreamEnd();
+ };
+
+ /** A derived form of sepstream, which seperates on commas
+ */
+ class CoreExport commasepstream : public sepstream
+ {
+ public:
+ /** Initialize with comma separator
+ */
+ commasepstream(const std::string &source, bool allowempty = false) : sepstream(source, ',', allowempty)
+ {
+ }
+ };
+
+ /** A derived form of sepstream, which seperates on spaces
+ */
+ class CoreExport spacesepstream : public sepstream
+ {
+ public:
+ /** Initialize with space separator
+ */
+ spacesepstream(const std::string &source, bool allowempty = false) : sepstream(source, ' ', allowempty)
+ {
+ }
+ };
+
+ /** 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 spacesepstream
+ {
+ public:
+ /** Create a tokenstream and fill it with the provided data
+ */
+ tokenstream(const std::string &source);
+
+ /** 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);
+ };
+
+ /** 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.