Merge pull request #550 from Adam-/master+sepstream

Rewrote sepstream and tokenstream to be less ugly

1 files changed, 58 insertions, 76 deletions

diff --git a/include/hashcomp.h b/include/hashcomp.h
index e142dcfd3..0d3857d56 100644
--- a/include/hashcomp.h
+++ b/include/hashcomp.h
@@ -164,7 +164,7 @@ namespace irc
 	typedef std::basic_string<char, irc_char_traits, std::allocator<char> > string;
 
 	/** irc::stringjoiner joins string lists into a string, using
-	 * the given seperator string.
+	 * the given separator string.
 	 * This class can join a vector of std::string, a deque of
 	 * std::string, or a const char* const* array, using overloaded
 	 * constructors.
@@ -180,12 +180,12 @@ namespace irc
 	 public:
 
 		/** Join elements of a vector, between (and including) begin and end
-		 * @param seperator The string to seperate values with
+		 * @param separator The string to seperate values with
 		 * @param sequence One or more items to seperate
 		 * @param begin The starting element in the sequence to be joined
 		 * @param end The ending element in the sequence to be joined
 		 */
-		stringjoiner(const std::string& seperator, const std::vector<std::string>& sequence, unsigned int begin, unsigned int end);
+		stringjoiner(const std::string& separator, const std::vector<std::string>& sequence, unsigned int begin, unsigned int end);
 
 		/** Get the joined sequence
 		 * @return A constant reference to the joined string
@@ -264,68 +264,6 @@ namespace irc
 
 	};
 
-	/** 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);
-
-		/** 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
@@ -333,23 +271,23 @@ namespace irc
 	 */
 	class CoreExport sepstream
 	{
-	 private:
+	 protected:
 		/** Original string.
 		 */
 		std::string tokens;
-		/** Last position of a seperator token
+		/** Separator value
 		 */
-		std::string::iterator last_starting_position;
+		char sep;
 		/** Current string position
 		 */
-		std::string::iterator n;
-		/** Seperator value
+		size_t pos;
+		/** If set then GetToken() can return an empty string
 		 */
-		char sep;
+		bool allow_empty;
 	 public:
 		/** Create a sepstream and fill it with the provided data
 		 */
-		sepstream(const std::string &source, char seperator);
+		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
@@ -373,9 +311,9 @@ namespace irc
 	class CoreExport commasepstream : public sepstream
 	{
 	 public:
-		/** Initialize with comma seperator
+		/** Initialize with comma separator
 		 */
-		commasepstream(const std::string &source) : sepstream(source, ',')
+		commasepstream(const std::string &source, bool allowempty = false) : sepstream(source, ',', allowempty)
 		{
 		}
 	};
@@ -385,13 +323,57 @@ namespace irc
 	class CoreExport spacesepstream : public sepstream
 	{
 	 public:
-		/** Initialize with space seperator
+		/** Initialize with space separator
 		 */
-		spacesepstream(const std::string &source) : sepstream(source, ' ')
+		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