Allow unloading of modules which implement modes!

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

diff --git a/include/mode.h b/include/mode.h
index b26c0d9c3891b54c91be32fd011a362c3c1686bd..27cdd890f40f735c532a83d1d92ab99f54c53ae1 100644 (file)
--- a/include/mode.h
+++ b/include/mode.h
@@ -18,11 +18,8 @@
 #define __MODE_H
 
 /* include the common header files */
-#include <typeinfo>
-#include <iostream>
 #include <string>
 #include <deque>
-#include <sstream>
 #include <vector>
 #include "users.h"
 #include "channels.h"
@@ -247,6 +244,26 @@ class ModeHandler : public Extensible
         * This allows the local server to enforce our locally set parameters back to a remote server.
         */
        virtual ModePair ModeSet(userrec* source, userrec* dest, chanrec* channel, const std::string &parameter);
+
+       /**
+        * When a MODETYPE_USER mode handler is being removed, the server will call this method for every user on the server.
+        * Your mode handler should remove its user mode from the user by sending the appropriate server modes using
+        * InspIRCd::SendMode(). The default implementation of this method can remove simple modes which have no parameters,
+        * and can be used when your mode is of this type, otherwise you must implement a more advanced version of it to remove
+        * your mode properly from each user.
+        * @param user The user which the server wants to remove your mode from
+        */
+       virtual void RemoveMode(userrec* user);
+
+       /**
+        * When a MODETYPE_CHANNEL mode handler is being removed, the server will call this method for every channel on the server.
+        * Your mode handler should remove its user mode from the channel by sending the appropriate server modes using
+        * InspIRCd::SendMode(). The default implementation of this method can remove simple modes which have no parameters,
+        * and can be used when your mode is of this type, otherwise you must implement a more advanced version of it to remove
+        * 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(chanrec* channel);
 };
 
 /**
@@ -379,6 +396,15 @@ class ModeParser : public classbase
         * @return True if the mode was successfully added.
         */
        bool AddMode(ModeHandler* mh, unsigned const char modeletter);
+       /** Delete a mode from the mode parser.
+        * When a mode is deleted, the mode handler will be called
+        * for every user (if it is a user mode) or for every  channel
+        * (if it is a channel mode) to unset the mode on all objects.
+        * This prevents modes staying in the system which no longer exist.
+        * @param mh The mode handler to remove
+        * @return True if the mode was successfully removed.
+        */
+       bool DelMode(ModeHandler* mh);
        /** Add a mode watcher.
         * A mode watcher is triggered before and after a mode handler is
         * triggered. See the documentation of class ModeWatcher for more
@@ -440,11 +466,21 @@ class ModeParser : public classbase
        std::string ChanModes();
        /** Used by this class internally during std::sort and 005 generation
         */
-       static bool ModeParser::PrefixComparison(const prefixtype one, const prefixtype two);
+       static bool PrefixComparison(const prefixtype one, const prefixtype two);
 
        /** This returns the PREFIX=(ohv)@%+ section of the 005 numeric.
         */
        std::string BuildPrefixes();
+
+       /** This returns the privilages of a user upon a channel, in the format of a mode change.
+        * For example, if a user has privilages +avh, this will return the string "avh nick nick nick".
+        * This is used by the core when cycling a user to refresh their hostname. You may use it for
+        * similar purposes.
+        * @param user The username to look up
+        * @param channel The channel name to look up the privilages of the user for
+        * @return The mode string.
+        */
+       std::string ModeString(userrec* user, chanrec* channel);
 };
 
 /** Command handler class for the MODE command.