Convert more by-values to const references, optimise ConfigReader a bit

[user/henk/code/inspircd.git] / include / hashcomp.h

diff --git a/include/hashcomp.h b/include/hashcomp.h
index c9debd6988f5c57ce59c7d72be6800ab06bc104d..7ec813ad6b7db5557ed0e2187ae0df210052d54a 100644 (file)
--- a/include/hashcomp.h
+++ b/include/hashcomp.h
@@ -2,7 +2,7 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  Inspire is copyright (C) 2002-2005 ChatSpike-Dev.
+ *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
  *                       E-mail:
  *                <brain@chatspike.net>
  *                <Craig@chatspike.net>
@@ -19,6 +19,21 @@
 
 #include "inspircd_config.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.
+ *******************************************************/
+
 #ifdef GCC3
 #include <ext/hash_map>
 #else
@@ -53,32 +68,35 @@ namespace nspace
         };
 }
 
-/** This class returns true if two strings match.
- * Case sensitivity is ignored, and the RFC 'character set'
- * is adhered to
+/** The irc namespace contains a number of helper classes.
  */
-struct StrHashComp
+namespace irc
 {
-       /** The operator () does the actual comparison in hash_map
+
+       /** This class returns true if two strings match.
+        * Case sensitivity is ignored, and the RFC 'character set'
+        * is adhered to
         */
-        bool operator()(const string& s1, const string& s2) const;
-};
+       struct StrHashComp
+       {
+               /** The operator () does the actual comparison in hash_map
+                */
+               bool operator()(const std::string& s1, const std::string& 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
+
+       /** 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.
         */
-        bool operator()(const in_addr &s1, const in_addr &s2) const;
-};
+       struct InAddr_HashComp
+       {
+               /** The operator () does the actual comparison in hash_map
+                */
+               bool operator()(const in_addr &s1, const in_addr &s2) const;
+       };
+
 
-/** The irc namespace contains a number of helper classes.
- */
-namespace irc
-{
        /** 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.
@@ -111,4 +129,20 @@ namespace irc
        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