]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/hashcomp.h
Fix a bunch of really obvious unnecessary includes.
[user/henk/code/inspircd.git] / include / hashcomp.h
index 1dd1b3b9835d699df41ac5f72d106aaa2c278caf..483910cb793d123fdfa2c3e8e1de64b071c11ad6 100644 (file)
@@ -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-2009 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) 2005-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
 
 #pragma once
 
-#include <cstring>
-#include <string>
-#include <vector>
-#include <deque>
-#include <map>
-#include <set>
 #include "inspircd.h"
+#include "convto.h"
 
 /*******************************************************
  * This file contains classes and templates that deal
@@ -45,7 +45,7 @@
  * mapping arrays internally.
  *******************************************************/
 
-/** Seperate from the other casemap tables so that code *can* still exclusively rely on RFC casemapping
+/** Separate from the other casemap tables so that code *can* still exclusively rely on RFC casemapping
  * if it must.
  *
  * This is provided as a pointer so that modules can change it to their custom mapping tables,
@@ -77,6 +77,13 @@ namespace irc
         */
        CoreExport bool equals(const std::string& s1, const std::string& s2);
 
+       /** Check whether \p needle exists within \p haystack.
+        * @param haystack The string to search within.
+        * @param needle The string to search for.
+        * @return Either the index at which \p needle was found or std::string::npos.
+        */
+       CoreExport size_t find(const std::string& haystack, const std::string& needle);
+
        /** This class returns true if two strings match.
         * Case sensitivity is ignored, and the RFC 'character set'
         * is adhered to
@@ -101,63 +108,7 @@ namespace irc
                bool CoreExport operator()(const std::string& a, const std::string& b) const;
        };
 
-       /** The irc_char_traits class is used for RFC-style comparison of strings.
-        * This class is used to implement irc::string, a case-insensitive, RFC-
-        * comparing string class.
-        */
-       struct CoreExport irc_char_traits : public std::char_traits<char>
-       {
-               /** Check if two chars match.
-                * @param c1st First character
-                * @param c2nd Second character
-                * @return true if the characters are equal
-                */
-               static bool eq(char c1st, char c2nd);
-
-               /** Check if two chars do NOT match.
-                * @param c1st First character
-                * @param c2nd Second character
-                * @return true if the characters are unequal
-                */
-               static bool ne(char c1st, char c2nd);
-
-               /** Check if one char is less than another.
-                * @param c1st First character
-                * @param c2nd Second character
-                * @return true if c1st is less than c2nd
-                */
-               static bool lt(char c1st, char c2nd);
-
-               /** Compare two strings of size n.
-                * @param str1 First string
-                * @param str2 Second string
-                * @param n Length to compare to
-                * @return similar to strcmp, zero for equal, less than zero for str1
-                * being less and greater than zero for str1 being greater than str2.
-                */
-               static int compare(const char* str1, const char* str2, size_t n);
-
-               /** Find a char within a string up to position n.
-                * @param s1 String to find in
-                * @param n Position to search up to
-                * @param c Character to search for
-                * @return Pointer to the first occurance of c in s1
-                */
-               static const char* find(const char* s1, int  n, char c);
-       };
-
-       /** 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.
-        * @param separator The character to place between the items, defaults to ' ' (space).
-        * @return Joined string.
-        */
-       std::string CoreExport stringjoiner(const std::vector<std::string>& sequence, char separator = ' ');
-
-       /** irc::sepstream allows for splitting token seperated lists.
+       /** irc::sepstream allows for splitting token separated lists.
         * Each successive call to sepstream::GetToken() returns
         * the next token, until none remain, at which point the method returns
         * false.
@@ -188,6 +139,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
                 */
@@ -197,9 +163,15 @@ 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
+       /** A derived form of sepstream, which separates on commas
         */
        class CoreExport commasepstream : public sepstream
        {
@@ -211,7 +183,7 @@ namespace irc
                }
        };
 
-       /** A derived form of sepstream, which seperates on spaces
+       /** A derived form of sepstream, which separates on spaces
         */
        class CoreExport spacesepstream : public sepstream
        {
@@ -235,33 +207,36 @@ 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.
+       /** The portparser class separates 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