Tons more docs

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

diff --git a/include/mode.h b/include/mode.h
index 6e2f03788ac416743fd4ad9950652d9c9aa6a799..121969fefbcc59da347cf9b21577866a63c98a6d 100644 (file)
--- a/include/mode.h
+++ b/include/mode.h
@@ -28,6 +28,8 @@
 #include "channels.h"
 #include "ctables.h"
 
+class InspIRCd;
+
 /**
  * Holds the values for different type of modes
  * that can exist, USER or CHANNEL type.
@@ -55,6 +57,13 @@ enum ModeMasks {
        MASK_CHANNEL = 0        /* A channel mode */
 };
 
+/**
+ * Used by ModeHandler::ModeSet() to return the state of a mode upon a channel or user.
+ * The pair contains an activity flag, true if the mode is set with the given parameter,
+ * and the parameter of the mode (or the parameter provided) in the std::string.
+ */
+typedef std::pair<bool,std::string> ModePair;
+
 /** Each mode is implemented by ONE ModeHandler class.
  * You must derive ModeHandler and add the child class to
  * the list of modes handled by the ircd, using
@@ -72,6 +81,7 @@ enum ModeMasks {
 class ModeHandler : public Extensible
 {
  protected:
+       InspIRCd* ServerInstance;
        /**
         * The mode letter you're implementing.
         */
@@ -118,7 +128,7 @@ class ModeHandler : public Extensible
         * @param ModeType Set this to MODETYPE_USER for a usermode, or MODETYPE_CHANNEL for a channelmode.
         * @param operonly Set this to true if only opers should be allowed to set or unset the mode.
         */
-       ModeHandler(char modeletter, int parameters_on, int parameters_off, bool listmode, ModeType type, bool operonly);
+       ModeHandler(InspIRCd* Instance, char modeletter, int parameters_on, int parameters_off, bool listmode, ModeType type, bool operonly);
        /**
         * The default destructor does nothing
         */
@@ -172,7 +182,8 @@ class ModeHandler : public Extensible
        /**
         * If your mode needs special action during a server sync to determine which side wins when comparing timestamps,
         * override this function and use it to return true or false. The default implementation just returns true if
-        * theirs < ours.
+        * theirs < ours. This will only be called for non-listmodes with parameters, when adding the mode and where
+        * theirs == ours (therefore the default implementation will always return false).
         * @param theirs The timestamp of the remote side
         * @param ours The timestamp of the local side
         * @param their_param Their parameter if the mode has a parameter
@@ -195,7 +206,7 @@ class ModeHandler : public Extensible
         * the current setting for this mode set locally, when the bool is true, or, the parameter given.
         * This allows the local server to enforce our locally set parameters back to a remote server.
         */
-       virtual std::pair<bool,std::string> ModeSet(userrec* source, userrec* dest, chanrec* channel, const std::string &parameter);
+       virtual ModePair ModeSet(userrec* source, userrec* dest, chanrec* channel, const std::string &parameter);
 };
 
 /**
@@ -207,6 +218,7 @@ class ModeHandler : public Extensible
 class ModeWatcher : public Extensible
 {
  protected:
+       InspIRCd* ServerInstance;
        /**
         * The mode letter this class is watching
         */
@@ -220,7 +232,7 @@ class ModeWatcher : public Extensible
        /**
         * The constructor initializes the mode and the mode type
         */
-       ModeWatcher(char modeletter, ModeType type);
+       ModeWatcher(InspIRCd* Instance, char modeletter, ModeType type);
        /**
         * The default destructor does nothing.
         */
@@ -269,6 +281,7 @@ typedef std::vector<ModeWatcher*>::iterator ModeWatchIter;
 class ModeParser : public classbase
 {
  private:
+       InspIRCd* ServerInstance;
        /**
         * Mode handlers for each mode, to access a handler subtract
         * 65 from the ascii value of the mode letter.
@@ -293,21 +306,21 @@ class ModeParser : public classbase
        /**
         * The constructor initializes all the RFC basic modes by using ModeParserAddMode().
         */
-       ModeParser();
+       ModeParser(InspIRCd* Instance);
 
        /**
         * Used to check if user 'd' should be allowed to do operation 'MASK' on channel 'chan'.
         * for example, should 'user A' be able to 'op' on 'channel B'.
         */
-       static userrec* SanityChecks(userrec *user,const char *dest,chanrec *chan,int status);
+       userrec* SanityChecks(userrec *user,const char *dest,chanrec *chan,int status);
        /**
         * Grant a built in privilage (e.g. ops, halfops, voice) to a user on a channel
         */
-       static const char* Grant(userrec *d,chanrec *chan,int MASK);
+       const char* Grant(userrec *d,chanrec *chan,int MASK);
        /**
         * Revoke a built in privilage (e.g. ops, halfops, voice) to a user on a channel
         */
-       static const char* Revoke(userrec *d,chanrec *chan,int MASK);
+       const char* Revoke(userrec *d,chanrec *chan,int MASK);
        /**
         * Tidy a banmask. This makes a banmask 'acceptable' if fields are left out.
         * E.g.
@@ -367,6 +380,14 @@ class ModeParser : public classbase
         * @returns a pointer to a ModeHandler class, or NULL of there isnt a handler for the given mode
         */
        ModeHandler* FindMode(unsigned const char modeletter, ModeType mt);
+
+       std::string UserModeList();
+
+       std::string ChannelModeList();
+
+       std::string ParaModeList();
+
+       bool InsertMode(std::string &output, const char* mode, unsigned short section);
 };
 
 /**
@@ -379,7 +400,7 @@ class cmd_mode : public command_t
        /**
         * Standard constructor
         */
-       cmd_mode () : command_t("MODE",0,1) { }
+       cmd_mode (InspIRCd* Instance) : command_t(Instance,"MODE",0,1) { syntax = "<target> <modes> {<mode-parameters>}"; }
        /**
         * Handle MODE
         */