]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/hashcomp.h
Remove the Kiwi links from the readme.
[user/henk/code/inspircd.git] / include / hashcomp.h
index 8e077a732a7383f8d80baa0a589b7e6e0a303f81..483910cb793d123fdfa2c3e8e1de64b071c11ad6 100644 (file)
@@ -1,23 +1,36 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- *                       E-mail:
- *                <brain@chatspike.net>
- *                <Craig@chatspike.net>
+ *   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) 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>
  *
- * Written by Craig Edwards, Craig McLure, and others.
- * This program is free but copyrighted software; see
- *            the file COPYING for details.
+ * 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
+ * License as published by the Free Software Foundation, version 2.
  *
- * ---------------------------------------------------
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#ifndef _HASHCOMP_H_
-#define _HASHCOMP_H_
 
-#include "inspircd_config.h"
+#pragma once
+
+#include "inspircd.h"
+#include "convto.h"
 
 /*******************************************************
  * This file contains classes and templates that deal
  * treat [ identical to {, ] identical to }, and \
  * as identical to |.
  *
- * Our hashing functions are designed  to accept
- * std::string and compare/hash them as type irc::string
- * by converting them internally. This makes them
- * backwards compatible with other code which is not
- * aware of irc::string.
+ * There are functors that accept std::string and
+ * compare/hash them as type irc::string by using
+ * mapping arrays internally.
  *******************************************************/
 
-#ifdef GCC3
-#include <ext/hash_map>
-#else
-#include <hash_map>
-#endif
-
-#ifdef GCC3
-#define nspace __gnu_cxx
-#else
-#define nspace std
-#endif
+/** 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,
+ * e.g. for national character support.
+ */
+CoreExport extern unsigned const char *national_case_insensitive_map;
 
-using namespace std;
+/** A mapping of uppercase to lowercase, including scandinavian
+ * 'oddities' as specified by RFC1459, e.g. { -> [, and | -> \
+ */
+CoreExport extern unsigned const char rfc_case_insensitive_map[256];
 
-namespace nspace
-{
-#ifdef GCC34
-        template<> struct hash<in_addr>
-#else
-        template<> struct nspace::hash<in_addr>
-#endif
-        {
-                size_t operator()(const struct in_addr &a) const;
-        };
-#ifdef GCC34
-        template<> struct hash<string>
-#else
-        template<> struct nspace::hash<string>
-#endif
-        {
-                size_t operator()(const string &s) const;
-        };
-}
+/** Case insensitive map, ASCII rules.
+ * That is;
+ * [ != {, but A == a.
+ */
+CoreExport extern unsigned const char ascii_case_insensitive_map[256];
 
 /** The irc namespace contains a number of helper classes.
  */
 namespace irc
 {
+       /** Check if two IRC object (e.g. nick or channel) names are equal.
+        * This function uses national_case_insensitive_map to determine equality, which, by default does comparison
+        * according to RFC 1459, treating certain otherwise non-identical characters as identical.
+        * @param s1 First string to compare
+        * @param s2 Second string to compare
+        * @return True if the two names are equal, false otherwise
+        */
+       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'
@@ -81,52 +92,201 @@ namespace irc
        {
                /** The operator () does the actual comparison in hash_map
                 */
-               bool operator()(const std::string& s1, const std::string& s2) const;
+               bool operator()(const std::string& s1, const std::string& s2) const
+               {
+                       return equals(s1, s2);
+               }
+       };
+
+       struct insensitive
+       {
+               size_t CoreExport operator()(const std::string &s) const;
        };
 
+       struct insensitive_swo
+       {
+               bool CoreExport operator()(const std::string& a, const std::string& b) const;
+       };
 
-       /** This class returns true if two in_addr structs match.
-        * Checking is done by copying both into a size_t then doing a
-        * numeric comparison of the two.
+       /** 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.
         */
-       struct InAddr_HashComp
+       class CoreExport sepstream
        {
-               /** The operator () does the actual comparison in hash_map
+        protected:
+               /** Original string.
                 */
-               bool operator()(const in_addr &s1, const in_addr &s2) const;
-       };
+               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);
 
-       /** 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 irc_char_traits : std::char_traits<char> {
+               /** 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
+                */
+               const std::string GetRemaining();
 
-               /** Check if two chars match
+               /** Returns true if the end of the stream has been reached
+                * @return True if the end of the stream has been reached, otherwise false
                 */
-               static bool eq(char c1st, char c2nd);
+               bool StreamEnd();
 
-               /** Check if two chars do NOT match
+               /** 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 separates on commas
+        */
+       class CoreExport commasepstream : public sepstream
+       {
+        public:
+               /** Initialize with comma separator
                 */
-               static bool ne(char c1st, char c2nd);
+               commasepstream(const std::string &source, bool allowempty = false) : sepstream(source, ',', allowempty)
+               {
+               }
+       };
 
-               /** Check if one char is less than another
+       /** A derived form of sepstream, which separates on spaces
+        */
+       class CoreExport spacesepstream : public sepstream
+       {
+        public:
+               /** Initialize with space separator
                 */
-               static bool lt(char c1st, char c2nd);
+               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:
+               /** The message we are parsing tokens from. */
+               std::string message;
+
+               /** The current position within the message. */
+               size_t position;
 
-               /** Compare two strings of size n
+        public:
+               /** 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);
+
+               /** Retrieves the underlying message. */
+               std::string& GetMessage() { return message; }
+
+               /** 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.
                 */
-               static int compare(const char* str1, const char* str2, size_t n);
+               bool GetMiddle(std::string& token);
 
-               /** Find a char within a string up to position n
-                */
-               static const char* find(const char* s1, int  n, char c);
+               /** 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 GetTrailing(std::string& token);
        };
 
-       /** This typedef declares irc::string based upon irc_char_traits
+       /** 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
+        * 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.
         */
-       typedef basic_string<char, irc_char_traits, allocator<char> > string;
-}
+       class CoreExport portparser
+       {
+        private:
+
+               /** Used to split on commas
+                */
+               commasepstream sep;
 
-#endif
+               /** 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::set<long> 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);
+
+               /** Fetch the next token from the stream
+                * @return The next port number is returned, or 0 if none remain
+                */
+               long GetToken();
+       };
+}