]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/inspircd.h
Fix some minor Doxygen errors.
[user/henk/code/inspircd.git] / include / inspircd.h
index 303d24745664ef2936e7c145e4ad17b1cf24a809..95da70e54321a011ce8e68930afc35c8d352c923 100644 (file)
@@ -68,7 +68,6 @@ struct fakederef
 #include "convto.h"
 #include "dynref.h"
 #include "consolecolors.h"
-#include "caller.h"
 #include "cull_list.h"
 #include "extensible.h"
 #include "fileutils.h"
@@ -89,6 +88,7 @@ struct fakederef
 #include "socketengine.h"
 #include "snomasks.h"
 #include "filelogger.h"
+#include "message.h"
 #include "modules.h"
 #include "threadengine.h"
 #include "configreader.h"
@@ -165,12 +165,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&);
-DEFINE_HANDLER3(OnCheckExemptionHandler, ModResult, User*, Channel*, 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
@@ -213,14 +207,6 @@ class CoreExport InspIRCd
        /** Actions that must happen outside of the current call stack */
        ActionList AtomicActions;
 
-       /**** Functors ****/
-
-       IsNickHandler HandleIsNick;
-       IsIdentHandler HandleIsIdent;
-       OnCheckExemptionHandler HandleOnCheckExemption;
-       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!
@@ -322,10 +308,6 @@ class CoreExport InspIRCd
         */
        ProtocolInterface DefaultProtocolInterface;
 
-       /** Holds extensible for user operquit
-        */
-       StringExtItem OperQuit;
-
        /** Manages the generation and transmission of ISUPPORT. */
        ISupportManager ISupport;
 
@@ -345,14 +327,21 @@ 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 all ports specified in the configuration file.
         * @return The number of ports bound without error
@@ -381,11 +370,15 @@ 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
-        */
-       caller1<bool, const std::string&> IsChannel;
+       /** 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);
 
        /** Return true if str looks like a server ID
         * @param sid string to check against
@@ -410,30 +403,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.
@@ -521,13 +517,6 @@ class CoreExport InspIRCd
         */
        InspIRCd(int argc, char** argv);
 
-       /** Called to check whether a channel restriction mode applies to a user
-        * @param User that is attempting some action
-        * @param Channel that the action is being performed on
-        * @param Action name
-        */
-       caller3<ModResult, User*, Channel*, const std::string&> OnCheckExemption;
-
        /** Prepare the ircd for restart or shutdown.
         * This function unloads all modules which can be unloaded,
         * closes all open sockets, and closes the logfile.
@@ -537,6 +526,7 @@ class CoreExport InspIRCd
        /** Return a time_t as a human-readable string.
         * @param format The format to retrieve the date/time in. See `man 3 strftime`
         * for more information. If NULL, "%a %b %d %T %Y" is assumed.
+        * @param curtime The timestamp to convert to a human-readable string.
         * @param utc True to convert the time to string as-is, false to convert it to local time first.
         * @return A string representing the given date/time.
         */
@@ -574,7 +564,7 @@ class CommandModule : public Module
        {
        }
 
-       Version GetVersion()
+       Version GetVersion() CXX11_OVERRIDE
        {
                return Version(cmd.name, VF_VENDOR|VF_CORE);
        }