]> 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 6c90ee919ed4ac5f26e2df9a34e603227932cb13..483910cb793d123fdfa2c3e8e1de64b071c11ad6 100644 (file)
@@ -1,25 +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"
-#include "socket.h"
-#include "hash_map.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.
  *******************************************************/
-using namespace std;
-using irc::sockets::insp_aton;
-using irc::sockets::insp_ntoa;
-using irc::sockets::insp_inaddr;
 
-namespace nspace
-{
-        template<> struct hash<insp_inaddr>
-        {
-                size_t operator()(const insp_inaddr &a) const;
-        };
-
-        template<> struct hash<std::string>
-        {
-                size_t operator()(const string &s) const;
-        };
-}
+/** 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;
+
+/** 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];
+
+/** 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'
@@ -67,19 +92,107 @@ 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 insp_inaddr 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 insp_inaddr &s1, const insp_inaddr &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);
+
+               /** 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();
+
+               /** 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();
+
+               /** 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
+                */
+               commasepstream(const std::string &source, bool allowempty = false) : sepstream(source, ',', allowempty)
+               {
+               }
+       };
+
+       /** A derived form of sepstream, which separates 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.
@@ -94,97 +207,86 @@ namespace irc
         * list will be ":item". This is to allow for parsing 'source' fields
         * from data.
         */
-       class tokenstream
+       class CoreExport tokenstream
        {
-        private:
-               std::string tokens;
-               std::string::iterator last_starting_position;
-               std::string::iterator n;
-               bool last_pushed;
+       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
+               /** 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.
                 */
-               tokenstream(const std::string &source);
-               ~tokenstream();
+               bool GetMiddle(std::string& token);
 
-               /** Fetch the next token from the stream
-                * @returns The next token is returned, or an empty string 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.
                 */
-               const std::string GetToken();
+               bool GetTrailing(std::string& token);
        };
 
-       /** irc::commasepstream allows for splitting comma seperated lists.
-        * Lists passed to irc::commasepstream should not contain spaces
-        * after the commas, or this will be taken to be part of the item
-        * data. Each successive call to commasepstream::GetToken() returns
-        * the next token, until none remain, at which point the method returns
-        * an empty string.
+       /** 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.
         */
-       class commasepstream
+       class CoreExport portparser
        {
         private:
-               std::string tokens;
-               std::string::iterator last_starting_position;
-               std::string::iterator n;
-        public:
-               /** Create a commasepstream and fill it with the provided data
+
+               /** Used to split on commas
                 */
-               commasepstream(const std::string &source);
-               ~commasepstream();
+               commasepstream sep;
 
-               /** Fetch the next token from the stream
-                * @returns The next token is returned, or an empty string if none remain
+               /** Current position in a range of ports
                 */
-               const std::string GetToken();
-       };
+               long in_range;
 
+               /** Starting port in a range of ports
+                */
+               long range_begin;
 
-       /** 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> {
+               /** Ending port in a range of ports
+                */
+               long range_end;
 
-               /** Check if two chars match
+               /** Allow overlapped port ranges
                 */
-               static bool eq(char c1st, char c2nd);
+               bool overlapped;
 
-               /** Check if two chars do NOT match
+               /** Used to determine overlapping of ports
+                * without O(n) algorithm being used
                 */
-               static bool ne(char c1st, char c2nd);
+               std::set<long> overlap_set;
 
-               /** Check if one char is less than another
+               /** Returns true if val overlaps an existing range
                 */
-               static bool lt(char c1st, char c2nd);
+               bool Overlaps(long val);
+        public:
 
-               /** Compare two strings of size n
+               /** Create a portparser and fill it with the provided data
+                * @param source The source text to parse from
+                * @param allow_overlapped Allow overlapped ranges
                 */
-               static int compare(const char* str1, const char* str2, size_t n);
+               portparser(const std::string &source, bool allow_overlapped = true);
 
-               /** Find a char within a string up to position n
-                */
-               static const char* find(const char* s1, int  n, char c);
+               /** Fetch the next token from the stream
+                * @return The next port number is returned, or 0 if none remain
+                */
+               long GetToken();
        };
-
-       /** This typedef declares irc::string based upon irc_char_traits
-        */
-       typedef basic_string<char, irc_char_traits, allocator<char> > string;
 }
-
-/* Define operators for using >> and << with irc::string to an ostream on an istream. */
-/* This was endless fun. No. Really. */
-/* It was also the first core change Ommeh made, if anyone cares */
-
-std::ostream& operator<<(std::ostream &os, const irc::string &str);
-std::istream& operator>>(std::istream &is, irc::string &str);
-
-/* Define operators for + and == with irc::string to std::string for easy assignment
- * and comparison - Brain
- */
-
-std::string operator+ (std::string& leftval, irc::string& rightval);
-irc::string operator+ (irc::string& leftval, std::string& rightval);
-bool operator== (std::string& leftval, irc::string& rightval);
-bool operator== (irc::string& leftval, std::string& rightval);
-
-#endif