Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

home » brain » inspircd-cvs » inspircd » include

hashcomp.h

Go to the documentation of this file.

/*       +------------------------------------+
 *       | Inspire Internet Relay Chat Daemon |
 *       +------------------------------------+
 *
 *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
 * See: http://www.inspircd.org/wiki/index.php/Credits
 *
 * This program is free but copyrighted software; see
 *          the file COPYING for details.
 *
 * ---------------------------------------------------
 */

#ifndef _HASHCOMP_H_
#define _HASHCOMP_H_

#include <cstring>
//#include "inspircd_config.h"
//#include "socket.h"
#include "hash_map.h"

/*******************************************************
 * This file contains classes and templates that deal
 * with the comparison and hashing of 'irc strings'.
 * An 'irc string' is a string which compares in a
 * case insensitive manner, and as per RFC 1459 will
 * 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.
 *******************************************************/

#ifndef LOWERMAP
#define LOWERMAP

unsigned const char rfc_case_insensitive_map[256] = {
        0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19,                                   /* 0-19 */
        20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39,                         /* 20-39 */
        40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,                         /* 40-59 */
        60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111,             /* 60-79 */
        112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 94, 95, 96, 97, 98, 99,           /* 80-99 */
        100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,     /* 100-119 */
        120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139,     /* 120-139 */
        140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159,     /* 140-159 */
        160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,     /* 160-179 */
        180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199,     /* 180-199 */
        200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219,     /* 200-219 */
        220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,     /* 220-239 */
        240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254, 255                          /* 240-255 */
};

/*
 * case sensitive map.
 */
unsigned const char case_sensitive_map[256] = {
        0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20,
        21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40,
        41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60,
        61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80,
        81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100,
        101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120,
        121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140,
        141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160,
        161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180,
        181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200,
        201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220,
        221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240,
        241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254, 255
};

#endif

namespace irc
{

        struct StrHashComp
        {
                bool operator()(const std::string& s1, const std::string& s2) const;
        };

        struct irc_char_traits : std::char_traits<char> {

                static bool eq(char c1st, char c2nd);

                static bool ne(char c1st, char c2nd);

                static bool lt(char c1st, char c2nd);

                static CoreExport int compare(const char* str1, const char* str2, size_t n);

                static CoreExport const char* find(const char* s1, int  n, char c);
        };

        CoreExport std::string hex(const unsigned char *raw, size_t rawsz);

        typedef std::basic_string<char, irc_char_traits, std::allocator<char> > string;

        class CoreExport stringjoiner : public classbase
        {
         private:
                std::string joined;
         public:
                stringjoiner(const std::string &seperator, const std::vector<std::string> &sequence, int begin, int end);
                stringjoiner(const std::string &seperator, const std::deque<std::string> &sequence, int begin, int end);
                stringjoiner(const std::string &seperator, const char* const* sequence, int begin, int end);

                std::string& GetJoined();
        };

        class CoreExport modestacker : public classbase
        {
         private:
                InspIRCd* ServerInstance;
                std::deque<std::string> sequence;
                bool adding;
         public:
                modestacker(InspIRCd* Instance, bool add);
                void Push(char modeletter, const std::string &parameter);
                void Push(char modeletter);
                void PushPlus();
                void PushMinus();
                int GetStackedLine(std::deque<std::string> &result, int max_line_size = 360);
        };

        class CoreExport tokenstream : public classbase
        {
         private:
                std::string tokens;
                std::string::iterator last_starting_position;
                std::string::iterator n;
                bool last_pushed;
         public:
                tokenstream(const std::string &source);
                ~tokenstream();

                bool GetToken(std::string &token);

                bool GetToken(irc::string &token);

                bool GetToken(int &token);

                bool GetToken(long &token);
        };

        class CoreExport sepstream : public classbase
        {
         private:
                std::string tokens;
                std::string::iterator last_starting_position;
                std::string::iterator n;
                char sep;
         public:
                sepstream(const std::string &source, char seperator);
                virtual ~sepstream();

                virtual bool GetToken(std::string &token);

                virtual const std::string GetRemaining();

                virtual bool StreamEnd();
        };

        class CoreExport commasepstream : public sepstream
        {
         public:
                commasepstream(const std::string &source) : sepstream(source, ',')
                {
                }
        };

        class CoreExport spacesepstream : public sepstream
        {
         public:
                spacesepstream(const std::string &source) : sepstream(source, ' ')
                {
                }
        };

        class CoreExport portparser : public classbase
        {
         private:
                commasepstream* sep;
                long in_range;
                long range_begin;
                long range_end;
                bool overlapped;
                std::map<long, bool> overlap_set;
                bool Overlaps(long val);
         public:
                portparser(const std::string &source, bool allow_overlapped = true);
                ~portparser();
                long GetToken();
        };

        typedef std::pair<size_t, unsigned char> bitfield;

        class CoreExport dynamicbitmask : public classbase
        {
         private:
                unsigned char* bits;
         protected:
                unsigned char bits_size;
         public:
                dynamicbitmask();

                virtual ~dynamicbitmask();

                bitfield Allocate();

                bool Deallocate(bitfield &pos);

                void Toggle(bitfield &pos, bool state);

                bool Get(bitfield &pos);

                unsigned char GetSize();

                virtual unsigned char* GetFreeBits() { return NULL; }

                virtual void SetFreeBits(unsigned char* freebits) { freebits = freebits; }
        };

        CoreExport const char* Spacify(const char* n);
}

/* 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 */

inline std::ostream& operator<<(std::ostream &os, const irc::string &str) { return os << str.c_str(); }

inline std::istream& operator>>(std::istream &is, irc::string &str)
{
        std::string tmp;
        is >> tmp;
        str = tmp.c_str();
        return is;
}

/* Define operators for + and == with irc::string to std::string for easy assignment
 * and comparison
 *
 * Operator +
 */
inline std::string operator+ (std::string& leftval, irc::string& rightval)
{
        return leftval + std::string(rightval.c_str());
}

/* Define operators for + and == with irc::string to std::string for easy assignment
 * and comparison
 *
 * Operator +
 */
inline irc::string operator+ (irc::string& leftval, std::string& rightval)
{
        return leftval + irc::string(rightval.c_str());
}

/* Define operators for + and == with irc::string to std::string for easy assignment
 * and comparison
 *
 * Operator ==
 */
inline bool operator== (const std::string& leftval, const irc::string& rightval)
{
        return (leftval.c_str() == rightval);
}

/* Define operators for + and == with irc::string to std::string for easy assignment
 * and comparison
 *
 * Operator ==
 */
inline bool operator== (const irc::string& leftval, const std::string& rightval)
{
        return (leftval == rightval.c_str());
}

/* Define operators != for irc::string to std::string for easy comparison
 */
inline bool operator!= (const irc::string& leftval, const std::string& rightval)
{
        return !(leftval == rightval.c_str());
}

/* Define operators != for std::string to irc::string for easy comparison
 */
inline bool operator!= (const std::string& leftval, const irc::string& rightval)
{
        return !(leftval.c_str() == rightval);
}

// FIXME MAXBUF messes up these
#if 0
template<std::size_t N>
static inline bool operator == (std::string const &lhs, char const (&rhs)[N])
{
        return lhs.length() == N - 1 && !std::memcmp(lhs.data(), rhs, N - 1);
}

template<std::size_t N>
static inline bool operator != (std::string const &lhs, char const (&rhs)[N])
{
        return !(lhs == rhs);
}
#endif

inline std::string assign(const irc::string &other) { return other.c_str(); }

inline irc::string assign(const std::string &other) { return other.c_str(); }

inline std::string& trim(std::string &str)
{
        std::string::size_type start = str.find_first_not_of(" ");
        std::string::size_type end = str.find_last_not_of(" ");
        if (start == std::string::npos || end == std::string::npos)
                str = "";
        else
                str = str.substr(start, end-start+1);

        return str;
}

BEGIN_HASHMAP_NAMESPACE

#ifdef WINDOWS
        template<> class CoreExport hash_compare<irc::string, std::less<irc::string> >
        {
        public:
                enum { bucket_size = 4, min_buckets = 8 }; /* Got these numbers from the CRT source, if anyone wants to change them feel free. */

                bool operator()(const irc::string & s1, const irc::string & s2) const
                {
                        if(s1.length() != s2.length()) return true;
                        return (irc::irc_char_traits::compare(s1.c_str(), s2.c_str(), s1.length()) < 0);
                }

                size_t operator()(const irc::string & s) const;
        };

        template<> class CoreExport hash_compare<std::string, std::less<std::string> >
        {
        public:
                enum { bucket_size = 4, min_buckets = 8 }; /* Again, from the CRT source */

                bool operator()(const std::string & s1, const std::string & s2) const
                {
                        if(s1.length() != s2.length()) return true;
                        return (irc::irc_char_traits::compare(s1.c_str(), s2.c_str(), s1.length()) < 0);
                }

                size_t operator()(const std::string & s) const;
        };
#else

        template<> struct hash<irc::string>
        {
                size_t operator()(const irc::string &s) const;
        };

        /* XXX FIXME: Implement a hash function overriding std::string's that works with TR1! */

#ifdef HASHMAP_DEPRECATED
        struct insensitive
#else
        template<> struct hash<std::string>
#endif
        {
                size_t operator()(const std::string &s) const;
        };

#endif

        void strlower(char *n);

END_HASHMAP_NAMESPACE

#endif