Bump the ABI version.

[user/henk/code/inspircd.git] / include / hashcomp.h

diff --git a/include/hashcomp.h b/include/hashcomp.h
index 71f900654bfc12a3f587db36726f949387a47de4..5626a389df339ddf84882c299fe0b8ff48435449 100644 (file)
--- a/include/hashcomp.h
+++ b/include/hashcomp.h
@@ -1,12 +1,17 @@
 /*
  * InspIRCd -- Internet Relay Chat Daemon
  *
- *   Copyright (C) 2011 Adam <Adam@anope.org>
+ *   Copyright (C) 2019 linuxdaemon <linuxdaemon.irc@gmail.com>
+ *   Copyright (C) 2013, 2018-2019 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2013 Adam <Adam@anope.org>
+ *   Copyright (C) 2012-2013, 2016 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
- *   Copyright (C) 2007, 2009 Dennis Friis <peavey@inspircd.org>
- *   Copyright (C) 2005-2009 Craig Edwards <craigedwards@brainbox.cc>
- *   Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
  *   Copyright (C) 2008 Pippijn van Steenhoven <pip88nl@gmail.com>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2006-2010 Craig Edwards <brain@inspircd.org>
  *
  * This file is part of InspIRCd.  InspIRCd is free software: you can
  * redistribute it and/or modify it under the terms of the GNU General Public
@@ -31,6 +36,7 @@
 #include <map>
 #include <set>
 #include "inspircd.h"
+#include "convto.h"
 
 /*******************************************************
  * This file contains classes and templates that deal
@@ -139,6 +145,21 @@ namespace irc
                 */
                bool GetToken(std::string& token);
 
+               /** Fetch the next numeric 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
+                */
+               template<typename Numeric>
+               bool GetNumericToken(Numeric& token)
+               {
+                       std::string str;
+                       if (!GetToken(str))
+                               return false;
+
+                       token = ConvToNum<Numeric>(str);
+                       return true;
+               }
+
                /** Fetch the entire remaining stream, without tokenizing
                 * @return The remaining part of the stream
                 */
@@ -148,6 +169,12 @@ namespace irc
                 * @return True if the end of the stream has been reached, otherwise false
                 */
                bool StreamEnd();
+
+               /** Returns true if the specified value exists in the stream
+                * @param value The value to search for
+                * @return True if the value was found, False otherwise
+                */
+               bool Contains(const std::string& value);
        };
 
        /** A derived form of sepstream, which seperates on commas
@@ -186,30 +213,33 @@ namespace irc
         * list will be ":item". This is to allow for parsing 'source' fields
         * from data.
         */
-       class CoreExport tokenstream : private spacesepstream
+       class CoreExport tokenstream
        {
+       private:
+               /** The message we are parsing tokens from. */
+               std::string message;
+
+               /** The current position within the message. */
+               size_t position;
+
         public:
-               /** Create a tokenstream and fill it with the provided data
-                */
-               tokenstream(const std::string &source);
+               /** Create a tokenstream and fill it with the provided data. */
+               tokenstream(const std::string& msg, size_t start = 0, size_t end = std::string::npos);
 
-               /** 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);
+               /** Retrieves the underlying message. */
+               std::string& GetMessage() { return message; }
 
-               /** Fetch the next token from the stream as an integer
-                * @param token The next token available, or undefined if none remain
+               /** Retrieve the next \<middle> token in the token stream.
+                * @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(int &token);
+               bool GetMiddle(std::string& token);
 
-               /** Fetch the next token from the stream as a long integer
-                * @param token The next token available, or undefined if none remain
+               /** Retrieve the next \<trailing> token in the token stream.
+                * @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(long &token);
+               bool GetTrailing(std::string& token);
        };
 
        /** The portparser class seperates out a port range into integers.