]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/mode.h
Include explicit parameter list in ProtocolInterface::SendMode
[user/henk/code/inspircd.git] / include / mode.h
index dcd8cc0040d3cd051d39a92683ac90c328aeb6b9..94d9f3dfe2695bce688742c4490a239db346d9b8 100644 (file)
@@ -2,7 +2,7 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
+ *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
  * See: http://www.inspircd.org/wiki/index.php/Credits
  *
  * This program is free but copyrighted software; see
@@ -17,6 +17,7 @@
 /* Forward declarations. */
 class User;
 
+#include "ctables.h"
 #include "channels.h"
 
 /**
@@ -125,6 +126,10 @@ class CoreExport ModeHandler : public Extensible
         * MODETYPE_CHANNEL.
         */
        ModeType m_type;
+       /**
+        * The mode parameter translation type
+        */
+       TranslateType m_paramtype;
        /**
         * True if the mode requires oper status
         * to set.
@@ -161,7 +166,8 @@ class CoreExport ModeHandler : public Extensible
         * and the rank values OP_VALUE, HALFOP_VALUE and VOICE_VALUE respectively. Any prefixes you define should have unique values proportional
         * to these three defaults or proportional to another mode in a module you depend on. See src/cmode_o.cpp as an example.
         */
-       ModeHandler(InspIRCd* Instance, char modeletter, int parameters_on, int parameters_off, bool listmode, ModeType type, bool operonly, char mprefix = 0, char prefixrequired = '%');
+       ModeHandler(InspIRCd* Instance, char modeletter, int parameters_on, int parameters_off, bool listmode, ModeType type, bool operonly,
+               char mprefix = 0, char prefixrequired = '%', TranslateType translate = TR_TEXT);
        /**
         * The default destructor does nothing
         */
@@ -191,9 +197,13 @@ class CoreExport ModeHandler : public Extensible
         */
        virtual unsigned int GetPrefixRank();
        /**
-        * Returns the modes type
+        * Returns the mode's type
         */
        ModeType GetModeType();
+       /**
+        * Returns the mode's parameter translation type
+        */
+       TranslateType GetTranslateType();
        /**
         * Returns true if the mode can only be set/unset by an oper
         */
@@ -211,6 +221,10 @@ class CoreExport ModeHandler : public Extensible
         */
        char GetModeChar();
 
+       /** For user modes, return the current parameter, if any
+        */
+       virtual std::string GetUserParameter(User* useor);
+
        /**
         * Called when a mode change for your mode occurs.
         * @param source Contains the user setting the mode.
@@ -232,6 +246,14 @@ class CoreExport ModeHandler : public Extensible
         */
        virtual void DisplayList(User* user, Channel* channel);
 
+       /** In the event that the mode should be given a parameter, and no parameter was provided, this method is called.
+        * This allows you to give special information to the user, or handle this any way you like.
+        * @param user The user issuing the mode change
+        * @param dest For user mode changes, the target of the mode. For channel mode changes, NULL.
+        * @param channel For channel mode changes, the target of the mode. For user mode changes, NULL.
+        */
+       virtual void OnParameterMissing(User* user, User* dest, Channel* channel);
+
        /**
         * If your mode is a listmode, this method will be called to display an empty list (just the end of list numeric)
         * @param user The user issuing the command
@@ -423,6 +445,12 @@ class CoreExport ModeParser : public classbase
         * Use GetLastParse() to get this value, to be used for  display purposes.
         */
        std::string LastParse;
+       std::deque<std::string> LastParseParams;
+       std::deque<TranslateType> LastParseTranslate;
+
+       unsigned int sent[256];
+
+       unsigned int seq;
 
  public:
 
@@ -444,22 +472,24 @@ class CoreExport ModeParser : public classbase
         * E.g.
         *
         * nick -> nick!*@*
-        * 
+        *
         * nick!ident -> nick!ident@*
-        * 
+        *
         * host.name -> *!*@host.name
-        * 
+        *
         * ident@host.name -> *!ident@host.name
         *
         * This method can be used on both IPV4 and IPV6 user masks.
         */
        static void CleanMask(std::string &mask);
-       /** Get the last string to be processed, as it was sent to the user or channel. 
+       /** Get the last string to be processed, as it was sent to the user or channel.
         * Use this to display a string you just sent to be parsed, as the actual output
         * may be different to what you sent after it has been 'cleaned up' by the parser.
         * @return Last parsed string, as seen by users.
         */
        const std::string& GetLastParse();
+       const std::deque<std::string>& GetLastParseParams() { return LastParseParams; }
+       const std::deque<TranslateType>& GetLastParseTranslate() { return LastParseTranslate; }
        /** Add a mode to the mode parser.
         * @return True if the mode was successfully added.
         */
@@ -492,13 +522,12 @@ class CoreExport ModeParser : public classbase
        /** Process a set of mode changes from a server or user.
         * @param parameters The parameters of the mode change, in the format
         * they would be from a MODE command.
-        * @param pcnt The number of items in the parameters array
         * @param user The user setting or removing the modes. When the modes are set
         * by a server, an 'uninitialized' User is used, where *user::nick == NULL
         * and *user->server == NULL.
         * @param servermode True if a server is setting the mode.
         */
-       void Process(const char* const* parameters, int pcnt, User *user, bool servermode);
+       void Process(const std::vector<std::string>& parameters, User *user, bool servermode);
 
        /** Find the mode handler for a given mode and type.
         * @param modeletter mode letter to search for
@@ -529,9 +558,14 @@ class CoreExport ModeParser : public classbase
         */
        std::string ParaModeList();
 
-       /** Generates the CHANMODES= 005 sequence
+       /** Generates a list of modes, comma seperated by type:
+        *  1; Listmodes EXCEPT those with a prefix
+        *  2; Modes that take a param when adding or removing
+        *  3; Modes that only take a param when adding
+        *  4; Modes that dont take a param
         */
-       std::string ChanModes();
+       std::string GiveModeList(ModeMasks m);
+
        /** Used by this class internally during std::sort and 005 generation
         */
        static bool PrefixComparison(prefixtype one, prefixtype two);
@@ -554,4 +588,3 @@ class CoreExport ModeParser : public classbase
 };
 
 #endif
-