]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/inspircd.h
Fix warnings from Doxygen.
[user/henk/code/inspircd.git] / include / inspircd.h
index 839cccb6ae9f3fffec2aebcddc18e0b43cd114d8..1e0ca19259dad3fb74d61fb4b39a01fe8b58d043 100644 (file)
@@ -25,6 +25,7 @@
 
 #pragma once
 
+#include <cfloat>
 #include <climits>
 #include <cmath>
 #include <csignal>
@@ -49,6 +50,7 @@
 #include "compat.h"
 #include "aligned_storage.h"
 #include "typedefs.h"
+#include "convto.h"
 #include "stdalgo.h"
 
 CoreExport extern InspIRCd* ServerInstance;
@@ -65,13 +67,12 @@ struct fakederef
 };
 
 #include "config.h"
-#include "convto.h"
 #include "dynref.h"
 #include "consolecolors.h"
-#include "caller.h"
 #include "cull_list.h"
 #include "extensible.h"
 #include "fileutils.h"
+#include "ctables.h"
 #include "numerics.h"
 #include "numeric.h"
 #include "uid.h"
@@ -83,13 +84,14 @@ struct fakederef
 #include "logger.h"
 #include "usermanager.h"
 #include "socket.h"
-#include "ctables.h"
 #include "command_parse.h"
 #include "mode.h"
 #include "socketengine.h"
 #include "snomasks.h"
 #include "filelogger.h"
+#include "message.h"
 #include "modules.h"
+#include "clientprotocol.h"
 #include "threadengine.h"
 #include "configreader.h"
 #include "inspstring.h"
@@ -165,11 +167,6 @@ class serverstats
        }
 };
 
-DEFINE_HANDLER1(IsNickHandler, bool, const std::string&);
-DEFINE_HANDLER2(GenRandomHandler, void, char*, size_t);
-DEFINE_HANDLER1(IsIdentHandler, bool, const std::string&);
-DEFINE_HANDLER1(IsChannelHandler, bool, const std::string&);
-
 /** The main class of the irc server.
  * This class contains instances of all the other classes in this software.
  * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser
@@ -197,6 +194,8 @@ class CoreExport InspIRCd
         */
        char ReadBuffer[65535];
 
+       ClientProtocol::RFCEvents rfcevents;
+
        /** Check we aren't running as root, and exit if we are
         * with exit code EXIT_STATUS_ROOT.
         */
@@ -212,13 +211,6 @@ class CoreExport InspIRCd
        /** Actions that must happen outside of the current call stack */
        ActionList AtomicActions;
 
-       /**** Functors ****/
-
-       IsNickHandler HandleIsNick;
-       IsIdentHandler HandleIsIdent;
-       IsChannelHandler HandleIsChannel;
-       GenRandomHandler HandleGenRandom;
-
        /** Globally accessible fake user record. This is used to force mode changes etc across s2s, etc.. bit ugly, but.. better than how this was done in 1.1
         * Reason for it:
         * kludge alert!
@@ -339,14 +331,28 @@ class CoreExport InspIRCd
         * @param printable if false, the string will use characters 0-255; otherwise,
         * it will be limited to 0x30-0x7E ('0'-'~', nonspace printable characters)
         */
-       std::string GenRandomStr(int length, bool printable = true);
+       std::string GenRandomStr(unsigned int length, bool printable = true);
        /** Generate a random integer.
         * This is generally more secure than rand()
         */
        unsigned long GenRandomInt(unsigned long max);
 
        /** Fill a buffer with random bits */
-       caller2<void, char*, size_t> GenRandom;
+       TR1NS::function<void(char*, size_t)> GenRandom;
+
+       /** Fills the output buffer with the specified number of random characters.
+        * This is the default function for InspIRCd::GenRandom.
+        * @param output The output buffer to store random characters in.
+        * @param max The maximum number of random characters to put in the buffer.
+        */
+       static void DefaultGenRandom(char* output, size_t max);
+
+       /** Bind to a specific port from a config tag.
+        * @param tag the tag that contains bind information.
+        * @param sa The endpoint to listen on.
+        * @param old_ports Previously listening ports that may be on the same endpoint.
+        */
+       bool BindPort(ConfigTag* tag, const irc::sockets::sockaddrs& sa, std::vector<ListenSocket*>& old_ports);
 
        /** Bind all ports specified in the configuration file.
         * @return The number of ports bound without error
@@ -375,11 +381,21 @@ class CoreExport InspIRCd
         */
        chan_hash& GetChans() { return chanlist; }
 
-       /** Return true if a channel name is valid
-        * @param chname A channel name to verify
-        * @return True if the name is valid
+       /** Determines whether an channel name is valid. */
+       TR1NS::function<bool(const std::string&)> IsChannel;
+
+       /** Determines whether a channel name is valid according to the RFC 1459 rules.
+        * This is the default function for InspIRCd::IsChannel.
+        * @param channel The channel name to validate.
+        * @return True if the channel name is valid according to RFC 1459 rules; otherwise, false.
+       */
+       static bool DefaultIsChannel(const std::string& channel);
+
+       /** Determines whether a hostname is valid according to RFC 5891 rules.
+        * @param host The hostname to validate.
+        * @return True if the hostname is valid; otherwise, false.
         */
-       caller1<bool, const std::string&> IsChannel;
+       static bool IsHost(const std::string& host);
 
        /** Return true if str looks like a server ID
         * @param sid string to check against
@@ -404,30 +420,33 @@ class CoreExport InspIRCd
         */
        void Exit(int status);
 
-       /** Causes the server to exit immediately with exit code 0.
-        * The status code is required for signal handlers, and ignored.
-        */
-       static void QuickExit(int status);
-
        /** Formats the input string with the specified arguments.
        * @param formatString The string to format
        * @param ... A variable number of format arguments.
        * @return The formatted string
        */
-       static const char* Format(const char* formatString, ...) CUSTOM_PRINTF(1, 2);
-       static const char* Format(va_list &vaList, const char* formatString) CUSTOM_PRINTF(2, 0);
+       static std::string Format(const char* formatString, ...) CUSTOM_PRINTF(1, 2);
+       static std::string Format(va_list& vaList, const char* formatString) CUSTOM_PRINTF(2, 0);
 
-       /** Return true if a nickname is valid
-        * @param n A nickname to verify
-        * @return True if the nick is valid
-        */
-       caller1<bool, const std::string&> IsNick;
+       /** Determines whether a nickname is valid. */
+       TR1NS::function<bool(const std::string&)> IsNick;
 
-       /** Return true if an ident is valid
-        * @param An ident to verify
-        * @return True if the ident is valid
+       /** Determines whether a nickname is valid according to the RFC 1459 rules.
+        * This is the default function for InspIRCd::IsNick.
+        * @param nick The nickname to validate.
+        * @return True if the nickname is valid according to RFC 1459 rules; otherwise, false.
         */
-       caller1<bool, const std::string&> IsIdent;
+       static bool DefaultIsNick(const std::string& nick);
+
+       /** Determines whether an ident is valid. */
+       TR1NS::function<bool(const std::string&)> IsIdent;
+
+       /** Determines whether a ident is valid according to the RFC 1459 rules.
+        * This is the default function for InspIRCd::IsIdent.
+        * @param ident The ident to validate.
+        * @return True if the ident is valid according to RFC 1459 rules; otherwise, false.
+       */
+       static bool DefaultIsIdent(const std::string& ident);
 
        /** Match two strings using pattern matching, optionally, with a map
         * to check case against (may be NULL). If map is null, match will be case insensitive.
@@ -549,31 +568,30 @@ class CoreExport InspIRCd
        {
                return this->ReadBuffer;
        }
+
+       ClientProtocol::RFCEvents& GetRFCEvents() { return rfcevents; }
 };
 
 ENTRYPOINT;
 
-template<class Cmd>
-class CommandModule : public Module
-{
-       Cmd cmd;
- public:
-       CommandModule() : cmd(this)
-       {
-       }
-
-       Version GetVersion()
-       {
-               return Version(cmd.name, VF_VENDOR|VF_CORE);
-       }
-};
-
 inline void stdalgo::culldeleter::operator()(classbase* item)
 {
        if (item)
                ServerInstance->GlobalCulls.AddItem(item);
 }
 
+inline void Channel::Write(ClientProtocol::EventProvider& protoevprov, ClientProtocol::Message& msg, char status, const CUList& except_list)
+{
+       ClientProtocol::Event event(protoevprov, msg);
+       Write(event, status, except_list);
+}
+
+inline void LocalUser::Send(ClientProtocol::EventProvider& protoevprov, ClientProtocol::Message& msg)
+{
+       ClientProtocol::Event event(protoevprov, msg);
+       Send(event);
+}
+
 #include "numericbuilder.h"
-#include "modules/whois.h"
-#include "modules/stats.h"
+#include "clientprotocolmsg.h"
+#include "clientprotocolevent.h"