Properly name the windows service error constants and put proper descriptions in...

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

diff --git a/include/mode.h b/include/mode.h
index ca610e46a0f28157dca75f3d57030d4ffb9f017f..3ea4f6d0601e9c73974059347b5f7445b804ec6a 100644 (file)
--- a/include/mode.h
+++ b/include/mode.h
@@ -14,6 +14,11 @@
 #ifndef __MODE_H
 #define __MODE_H
 
+/* Forward declarations. */
+class User;
+
+#include "channels.h"
+
 /**
  * Holds the values for different type of modes
  * that can exist, USER or CHANNEL type.
@@ -227,6 +232,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
@@ -271,7 +284,7 @@ class CoreExport ModeHandler : public Extensible
         * your mode properly from each user.
         * @param user The user which the server wants to remove your mode from
         */
-       virtual void RemoveMode(User* user);
+       virtual void RemoveMode(User* user, irc::modestacker* stack = NULL);
 
        /**
         * When a MODETYPE_CHANNEL mode handler is being removed, the server will call this method for every channel on the server.
@@ -281,13 +294,39 @@ class CoreExport ModeHandler : public Extensible
         * your mode properly from each channel. Note that in the case of listmodes, you should remove the entire list of items.
         * @param channel The channel which the server wants to remove your mode from
         */
-       virtual void RemoveMode(Channel* channel);
+       virtual void RemoveMode(Channel* channel, irc::modestacker* stack = NULL);
 
        char GetNeededPrefix();
 
        void SetNeededPrefix(char needsprefix);
 };
 
+/** A prebuilt mode handler which handles a simple user mode, e.g. no parameters, usable by any user, with no extra
+ * behaviour to the mode beyond the basic setting and unsetting of the mode, not allowing the mode to be set if it
+ * is already set and not allowing it to be unset if it is already unset.
+ * An example of a simple user mode is user mode +w.
+ */
+class CoreExport SimpleUserModeHandler : public ModeHandler
+{
+ public:
+       SimpleUserModeHandler(InspIRCd* Instance, char modeletter);
+       virtual ~SimpleUserModeHandler();
+       virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding, bool servermode = false);
+};
+
+/** A prebuilt mode handler which handles a simple channel mode, e.g. no parameters, usable by any user, with no extra
+ * behaviour to the mode beyond the basic setting and unsetting of the mode, not allowing the mode to be set if it
+ * is already set and not allowing it to be unset if it is already unset.
+ * An example of a simple channel mode is channel mode +s.
+ */
+class CoreExport SimpleChannelModeHandler : public ModeHandler
+{
+ public:
+       SimpleChannelModeHandler(InspIRCd* Instance, char modeletter);
+       virtual ~SimpleChannelModeHandler();
+       virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding, bool servermode = false);
+};
+
 /**
  * The ModeWatcher class can be used to alter the behaviour of a mode implemented
  * by the core or by another module. To use ModeWatcher, derive a class from it,
@@ -393,6 +432,10 @@ class CoreExport ModeParser : public classbase
         */
        std::string LastParse;
 
+       unsigned int sent[256];
+
+       unsigned int seq;
+
  public:
 
        /** The constructor initializes all the RFC basic modes by using ModeParserAddMode().
@@ -461,13 +504,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
@@ -515,9 +557,11 @@ class CoreExport ModeParser : public classbase
         * similar purposes.
         * @param user The username to look up
         * @param channel The channel name to look up the privilages of the user for
+        * @param nick_suffix true (the default) if you want nicknames in the mode string, for easy
+        * use with the mode stacker, false if you just want the "avh" part of "avh nick nick nick".
         * @return The mode string.
         */
-       std::string ModeString(User* user, Channel* channel);
+       std::string ModeString(User* user, Channel* channel, bool nick_suffix = true);
 };
 
 #endif