X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fhashcomp.h;h=ed285c783ff97f535ba7b18d042b738301ef95b9;hb=dd36852a52e8541306b76c5b88bce8ab9b36654c;hp=805929f5d1530992f0cf737ad86c0c87555f0b49;hpb=77300844a4607a7ad97e0a1c0907770f22e7b4af;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/hashcomp.h b/include/hashcomp.h index 805929f5d..ed285c783 100644 --- a/include/hashcomp.h +++ b/include/hashcomp.h @@ -2,14 +2,11 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev. - * E-mail: - * - * + * InspIRCd: (C) 2002-2008 InspIRCd Development Team + * See: http://www.inspircd.org/wiki/index.php/Credits * - * Written by Craig Edwards, Craig McLure, and others. * This program is free but copyrighted software; see - * the file COPYING for details. + * the file COPYING for details. * * --------------------------------------------------- */ @@ -17,8 +14,8 @@ #ifndef _HASHCOMP_H_ #define _HASHCOMP_H_ -#include "inspircd_config.h" -#include "socket.h" +//#include "inspircd_config.h" +//#include "socket.h" #include "hash_map.h" /******************************************************* @@ -35,11 +32,6 @@ * backwards compatible with other code which is not * aware of irc::string. *******************************************************/ - -using namespace std; -using irc::sockets::insp_aton; -using irc::sockets::insp_ntoa; -using irc::sockets::insp_inaddr; #ifndef LOWERMAP #define LOWERMAP @@ -62,39 +54,6 @@ unsigned const char lowermap[256] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, }; #endif -/** Because of weirdness in g++, before 3.x this was namespace std. It's now __gnu_cxx. - * This is a #define'd alias. - */ -namespace nspace -{ - /** Convert a string to lower case respecting RFC1459 - * @param n A string to lowercase - */ - void strlower(char *n); - - /** Hashing function to hash insp_inaddr structs - */ - template<> struct hash - { - /** Hash an insp_inaddr - * @param a An insp_inaddr to hash - * @return The hash value - */ - size_t operator()(const insp_inaddr &a) const; - }; - - /** Hashing function to hash std::string without respect to case - */ - template<> struct hash - { - /** Hash a std::string using RFC1459 case sensitivity rules - * @param s A string to hash - * @return The hash value - */ - size_t operator()(const string &s) const; - }; -} - /** The irc namespace contains a number of helper classes. */ namespace irc @@ -108,28 +67,72 @@ 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; }; - - /** 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. + /** 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 InAddr_HashComp - { - /** The operator () does the actual comparison in hash_map + struct irc_char_traits : std::char_traits { + + /** 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. */ - bool operator()(const insp_inaddr &s1, const insp_inaddr &s2) const; + static CoreExport 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 CoreExport const char* find(const char* s1, int n, char c); }; + /** Compose a hex string from raw data. + * @param raw The raw data to compose hex from + * @pram rawsz The size of the raw data buffer + * @return The hex string. + */ + CoreExport std::string hex(const unsigned char *raw, size_t rawsz); + + /** This typedef declares irc::string based upon irc_char_traits. + */ + typedef std::basic_string > string; + /** irc::stringjoiner joins string lists into a string, using * the given seperator string. * This class can join a vector of std::string, a deque of - * std::string, or a const char** array, using overloaded + * std::string, or a const char* const* array, using overloaded * constructors. */ - class stringjoiner + class CoreExport stringjoiner { private: /** Output string @@ -156,7 +159,7 @@ namespace irc * @param begin The starting element in the sequence to be joined * @param end The ending element in the sequence to be joined */ - stringjoiner(const std::string &seperator, const char** sequence, int begin, int end); + stringjoiner(const std::string &seperator, const char* const* sequence, int begin, int end); /** Get the joined sequence * @return A reference to the joined string @@ -168,7 +171,7 @@ namespace irc * It can then reproduce this list, clamped to a maximum of MAXMODES * values per line. */ - class modestacker + class CoreExport modestacker { private: /** The mode sequence and its parameters @@ -210,13 +213,21 @@ namespace irc void PushMinus(); /** Return zero or more elements which form the * mode line. This will be clamped to a max of - * MAXMODES+1 items (MAXMODES mode parameters and - * one mode sequence string). + * MAXMODES items (MAXMODES-1 mode parameters and + * one mode sequence string), and max_line_size + * characters. As specified below, this function + * should be called in a loop until it returns zero, + * indicating there are no more modes to return. * @param result The deque to populate. This will * be cleared before it is used. - * @return The number of elements in the deque - */ - int GetStackedLine(std::deque &result); + * @param max_line_size The maximum size of the line + * to build, in characters, seperate to MAXMODES. + * @return The number of elements in the deque. + * The function should be called repeatedly until it + * returns 0, in case there are multiple lines of + * mode changes to be obtained. + */ + int GetStackedLine(std::deque &result, int max_line_size = 360); }; /** irc::tokenstream reads a string formatted as per RFC1459 and RFC2812. @@ -231,7 +242,7 @@ namespace irc * list will be ":item". This is to allow for parsing 'source' fields * from data. */ - class tokenstream + class CoreExport tokenstream { private: /** Original string @@ -252,10 +263,29 @@ namespace irc tokenstream(const std::string &source); ~tokenstream(); - /** Fetch the next token from the stream - * @return The next token is returned, or an empty string if none remain + /** 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); + + /** Fetch the next token from the stream as an irc::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. */ - const std::string GetToken(); + bool GetToken(irc::string &token); + + /** Fetch the next token from the stream as an integer + * @param token The next token available, or undefined if none remain + * @return True if tokens are left to be read, false if the last token was just retrieved. + */ + bool GetToken(int &token); + + /** Fetch the next token from the stream as a long integer + * @param token The next token available, or undefined if none remain + * @return True if tokens are left to be read, false if the last token was just retrieved. + */ + bool GetToken(long &token); }; /** irc::sepstream allows for splitting token seperated lists. @@ -263,10 +293,10 @@ namespace irc * the next token, until none remain, at which point the method returns * an empty string. */ - class sepstream : public classbase + class CoreExport sepstream : public classbase { private: - /** Original string + /** Original string. */ std::string tokens; /** Last position of a seperator token @@ -285,16 +315,29 @@ namespace irc virtual ~sepstream(); /** Fetch the next token from the stream - * @return The next token is returned, or an empty string if none remain + * @param token The next token from the stream is placed here + * @return True if tokens still remain, false if there are none left */ - virtual const std::string GetToken(); + virtual bool GetToken(std::string &token); + + /** Fetch the entire remaining stream, without tokenizing + * @return The remaining part of the stream + */ + virtual 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 + */ + virtual bool StreamEnd(); }; /** A derived form of sepstream, which seperates on commas */ - class commasepstream : public sepstream + class CoreExport commasepstream : public sepstream { public: + /** Initialize with comma seperator + */ commasepstream(const std::string &source) : sepstream(source, ',') { } @@ -302,9 +345,11 @@ namespace irc /** A derived form of sepstream, which seperates on spaces */ - class spacesepstream : public sepstream + class CoreExport spacesepstream : public sepstream { public: + /** Initialize with space seperator + */ spacesepstream(const std::string &source) : sepstream(source, ' ') { } @@ -318,7 +363,7 @@ namespace irc * start or end < 0) then GetToken() will return the first element * of the pair of numbers. */ - class portparser : public classbase + class CoreExport portparser : public classbase { private: /** Used to split on commas @@ -378,8 +423,51 @@ namespace irc * bit values in a bitmap dynamically, rather than having to define * costs in a fixed size unsigned integer and having the possibility * of collisions of values in different third party modules. + * + * IMPORTANT NOTE: + * + * To use this class, you must derive from it. + * This is because each derived instance has its own freebits array + * which can determine what bitfields are allocated on a TYPE BY TYPE + * basis, e.g. an irc::dynamicbitmask type for Users, and one for + * Channels, etc. You should inheret it in a very simple way as follows. + * The base class will resize and maintain freebits as required, you are + * just required to make the pointer static and specific to this class + * type. + * + * \code + * class mydbitmask : public irc::dynamicbitmask + * { + * private: + * + * static unsigned char* freebits; + * + * public: + * + * mydbitmask() : irc::dynamicbitmask() + * { + * freebits = new unsigned char[this->bits_size]; + * memset(freebits, 0, this->bits_size); + * } + * + * ~mydbitmask() + * { + * delete[] freebits; + * } + * + * unsigned char* GetFreeBits() + * { + * return freebits; + * } + * + * void SetFreeBits(unsigned char* freebt) + * { + * freebits = freebt; + * } + * }; + * \endcode */ - class dynamicbitmask : public classbase + class CoreExport dynamicbitmask : public classbase { private: /** Data bits. We start with four of these, @@ -387,12 +475,7 @@ namespace irc * more than 32 entries with Allocate(). */ unsigned char* bits; - /** A bitmask containing 1's for allocated - * bits and 0's for free bits. When we - * allocate a bit using Allocate(), we OR - * its position in here to 1. - */ - unsigned char* freebits; + protected: /** Current set size (size of freebits and bits). * Both freebits and bits will ALWAYS be the * same length. @@ -406,7 +489,7 @@ namespace irc /** Free the memory used by bits and freebits */ - ~dynamicbitmask(); + virtual ~dynamicbitmask(); /** Allocate an irc::bitfield. * @return An irc::bitfield which can be used @@ -447,56 +530,187 @@ namespace irc * for the freebits array. */ unsigned char GetSize(); - }; - - /** 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 { - - /** Check if two chars match - */ - static bool eq(char c1st, char c2nd); - - /** Check if two chars do NOT match - */ - static bool ne(char c1st, char c2nd); - /** Check if one char is less than another + /** Get free bits mask */ - static bool lt(char c1st, char c2nd); + virtual unsigned char* GetFreeBits() { return NULL; } - /** Compare two strings of size n + /** Set free bits mask */ - static int compare(const char* str1, const char* str2, size_t n); - - /** Find a char within a string up to position n - */ - static const char* find(const char* s1, int n, char c); + virtual void SetFreeBits(unsigned char* freebits) { freebits = freebits; } }; - std::string hex(const unsigned char *raw, size_t rawsz); - - /** This typedef declares irc::string based upon irc_char_traits + /** Turn _ characters in a string into spaces + * @param n String to translate + * @return The new value with _ translated to space. */ - typedef basic_string > string; - - const char* Spacify(char* n); + 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 */ -std::ostream& operator<<(std::ostream &os, const irc::string &str); -std::istream& operator>>(std::istream &is, irc::string &str); + +/** Operator << for irc::string + */ +inline std::ostream& operator<<(std::ostream &os, const irc::string &str) { return os << str.c_str(); } + +/** Operator >> for irc::string + */ +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 - Brain + * 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); +} + +/** Assign an irc::string to a std::string. + */ +inline std::string assign(const irc::string &other) { return other.c_str(); } + +/** Assign a std::string to an irc::string. */ -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); +inline irc::string assign(const std::string &other) { return other.c_str(); } +/** Trim the leading and trailing spaces from a std::string. + */ +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; +} + +/** Hashing stuff is totally different on vc++'s hash_map implementation, so to save a buttload of + * #ifdefs we'll just do it all at once + */ +namespace nspace +{ + /** Hashing function to hash irc::string + */ +#ifdef WINDOWS + template<> class CoreExport hash_compare > + { + public: + enum { bucket_size = 4, min_buckets = 8 }; /* Got these numbers from the CRT source, if anyone wants to change them feel free. */ + + /** Compare two irc::string values for hashing in hash_map + */ + 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); + } + + /** Hash an irc::string value for hash_map + */ + size_t operator()(const irc::string & s) const; + }; + + template<> class CoreExport hash_compare > + { + public: + enum { bucket_size = 4, min_buckets = 8 }; /* Again, from the CRT source */ + + /** Compare two std::string values for hashing in hash_map + */ + 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); + } + + /** Hash a std::string using RFC1459 case sensitivity rules + * @param s A string to hash + * @return The hash value + */ + size_t operator()(const std::string & s) const; + }; +#else + template<> struct hash + { + /** Hash an irc::string using RFC1459 case sensitivity rules + * @param s A string to hash + * @return The hash value + */ + size_t operator()(const irc::string &s) const; + }; + + template<> struct hash + { + /** Hash a std::string using RFC1459 case sensitivity rules + * @param s A string to hash + * @return The hash value + */ + size_t operator()(const std::string &s) const; + }; #endif + + /** Convert a string to lower case respecting RFC1459 + * @param n A string to lowercase + */ + void strlower(char *n); +} + +#endif +