X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fhashcomp.h;h=1d3a5d0b1d8494ae43fba75a6cbf1757af91f404;hb=a1f073f66f4b985bf776b9be2015136209c0c311;hp=42954fc37886f9937a614353c382b9decd979a92;hpb=eb7125445e8740e177ad05a74a5cc90324a35f98;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/hashcomp.h b/include/hashcomp.h index 42954fc37..1d3a5d0b1 100644 --- a/include/hashcomp.h +++ b/include/hashcomp.h @@ -1,54 +1,187 @@ +/* +------------------------------------+ + * | Inspire Internet Relay Chat Daemon | + * +------------------------------------+ + * + * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev. + * E-mail: + * + * + * + * Written by Craig Edwards, Craig McLure, and others. + * This program is free but copyrighted software; see + * the file COPYING for details. + * + * --------------------------------------------------- + */ + #ifndef _HASHCOMP_H_ #define _HASHCOMP_H_ #include "inspircd_config.h" +#include "socket.h" +#include "hash_map.h" -#ifdef GCC3 -#include -#else -#include -#endif - -#ifdef GCC3 -#define nspace __gnu_cxx -#else -#define nspace std -#endif - +/******************************************************* + * 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. + *******************************************************/ + using namespace std; namespace nspace { -#ifdef GCC34 template<> struct hash -#else - template<> struct nspace::hash -#endif { size_t operator()(const struct in_addr &a) const; }; -#ifdef GCC34 - template<> struct hash -#else - template<> struct nspace::hash -#endif + + template<> struct hash { size_t operator()(const string &s) const; }; } - -struct StrHashComp +/** The irc namespace contains a number of helper classes. + */ +namespace irc { - bool operator()(const string& s1, const string& s2) const; -}; + /** This class returns true if two strings match. + * Case sensitivity is ignored, and the RFC 'character set' + * is adhered to + */ + struct StrHashComp + { + /** The operator () does the actual comparison in hash_map + */ + bool operator()(const std::string& s1, const std::string& s2) const; + }; -struct InAddr_HashComp -{ - bool operator()(const in_addr &s1, const in_addr &s2) 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. + */ + struct InAddr_HashComp + { + /** The operator () does the actual comparison in hash_map + */ + bool operator()(const in_addr &s1, const in_addr &s2) const; + }; + + /** 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 tokenstream + { + private: + std::string tokens; + std::string::iterator last_starting_position; + std::string::iterator n; + bool last_pushed; + public: + /** Create a tokenstream and fill it with the provided data + */ + tokenstream(const std::string &source); + ~tokenstream(); + + /** Fetch the next token from the stream + * @returns The next token is returned, or an empty string if none remain + */ + const std::string GetToken(); + }; + + /** 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. + */ + class commasepstream + { + 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 + */ + commasepstream(const std::string &source); + ~commasepstream(); + + /** Fetch the next token from the stream + * @returns The next token is returned, or an empty string if none remain + */ + const std::string GetToken(); + }; + + + /** 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 + */ + static bool lt(char c1st, char c2nd); + + /** Compare two strings of size n + */ + 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); + }; + + /** This typedef declares irc::string based upon irc_char_traits + */ + typedef basic_string > 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