]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/mode.h
Remove SpanningTreeProtocolInterface::SendOperNotice - it was translated to a SendSNO...
[user/henk/code/inspircd.git] / include / mode.h
index 8da8d8b5891c171f3267790411b36399f5d313e5..e15ddeeb0bd416d5022b1d28252ea3d16a2c5ad6 100644 (file)
@@ -2,7 +2,7 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
  * See: http://www.inspircd.org/wiki/index.php/Credits
  *
  * This program is free but copyrighted software; see
 #ifndef __MODE_H
 #define __MODE_H
 
-#include <string>
-#include <deque>
-#include <vector>
-#include "ctables.h"
+/* Forward declarations. */
+class User;
 
-class InspIRCd;
+#include "channels.h"
 
 /**
  * Holds the values for different type of modes
@@ -141,6 +139,11 @@ class CoreExport ModeHandler : public Extensible
         */
        unsigned int count;
 
+       /** The prefix char needed on channel to use this mode,
+        * only checked for channel modes
+        */
+       char prefixneeded;
+
  public:
        /**
         * The constructor for ModeHandler initalizes the mode handler.
@@ -158,7 +161,7 @@ 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);
+       ModeHandler(InspIRCd* Instance, char modeletter, int parameters_on, int parameters_off, bool listmode, ModeType type, bool operonly, char mprefix = 0, char prefixrequired = '%');
        /**
         * The default destructor does nothing
         */
@@ -220,7 +223,7 @@ class CoreExport ModeHandler : public Extensible
         * @param adding This value is true when the mode is being set, or false when it is being unset.
         * @return MODEACTION_ALLOW to allow the mode, or MODEACTION_DENY to prevent the mode, also see the description of 'parameter'.
         */
-       virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding); /* Can change the mode parameter as its a ref */
+       virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding, bool servermode = false); /* Can change the mode parameter as its a ref */
        /**
         * If your mode is a listmode, then this method will be called for displaying an item list, e.g. on MODE #channel +modechar
         * without any parameter or other modes in the command.
@@ -273,7 +276,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.
@@ -283,7 +286,11 @@ 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);
 };
 
 /**
@@ -342,7 +349,7 @@ class CoreExport ModeWatcher : public Extensible
         * @return True to allow the mode change to go ahead, false to abort it. If you abort the
         * change, the mode handler (and ModeWatcher::AfterMode()) will never see the mode change.
         */
-       virtual bool BeforeMode(User* source, User* dest, Channel* channel, std::string &parameter, bool adding, ModeType type);
+       virtual bool BeforeMode(User* source, User* dest, Channel* channel, std::string &parameter, bool adding, ModeType type, bool servermode = false);
        /**
         * After the mode character has been processed by the ModeHandler, this method will be called.
         * @param source The sender of the mode
@@ -353,7 +360,7 @@ class CoreExport ModeWatcher : public Extensible
         * @param adding True if the mode is being added and false if it is being removed
         * @type The mode type, either MODETYPE_USER or MODETYPE_CHANNEL
         */
-       virtual void AfterMode(User* source, User* dest, Channel* channel, const std::string &parameter, bool adding, ModeType type);
+       virtual void AfterMode(User* source, User* dest, Channel* channel, const std::string &parameter, bool adding, ModeType type, bool servermode = false);
 };
 
 typedef std::vector<ModeWatcher*>::iterator ModeWatchIter;
@@ -465,7 +472,7 @@ class CoreExport ModeParser : public classbase
         * and *user->server == NULL.
         * @param servermode True if a server is setting the mode.
         */
-       void Process(const char** parameters, int pcnt, User *user, bool servermode);
+       void Process(const char* const* parameters, int pcnt, User *user, bool servermode);
 
        /** Find the mode handler for a given mode and type.
         * @param modeletter mode letter to search for
@@ -513,9 +520,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