Change the OnNamesListItem() hook to return ModResult

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

diff --git a/include/mode.h b/include/mode.h
index d3fdabde11f975128f10c63eaf16885c35e69a4c..7c5682135c7475f3d09353dbe0b734ac0230e8f2 100644 (file)
--- a/include/mode.h
+++ b/include/mode.h
@@ -94,6 +94,8 @@ class ParamModeBase;
 class CoreExport ModeHandler : public ServiceProvider
 {
  public:
+       typedef size_t Id;
+
        enum Class
        {
                MC_PREFIX,
@@ -102,6 +104,11 @@ class CoreExport ModeHandler : public ServiceProvider
                MC_OTHER
        };
 
+ private:
+       /** The opaque id of this mode assigned by the mode parser
+        */
+       Id modeid;
+
  protected:
        /**
         * The mode parameter translation type
@@ -213,6 +220,11 @@ class CoreExport ModeHandler : public ServiceProvider
         */
        inline char GetModeChar() { return mode; }
 
+       /** Return the id of this mode which is used in User::modes and
+        * Channel::modes as the index to determine whether a mode is set.
+        */
+       Id GetId() const { return modeid; }
+
        /** For user modes, return the current parameter, if any
         */
        virtual std::string GetUserParameter(User* useor);
@@ -295,6 +307,8 @@ class CoreExport ModeHandler : public ServiceProvider
        virtual void RemoveMode(Channel* channel, irc::modestacker& stack);
 
        inline unsigned int GetLevelRequired() const { return levelrequired; }
+
+       friend class ModeParser;
 };
 
 /**
@@ -474,15 +488,18 @@ typedef std::multimap<std::string, ModeWatcher*>::iterator ModeWatchIter;
  */
 class CoreExport ModeParser
 {
- private:
-       /** Last item in the ModeType enum
-        */
-       static const unsigned int MODETYPE_LAST = 2;
+ public:
+       static const ModeHandler::Id MODEID_MAX = 64;
 
        /** Type of the container that maps mode names to ModeHandlers
         */
        typedef TR1NS::unordered_map<std::string, ModeHandler*, irc::insensitive, irc::StrHashComp> ModeHandlerMap;
 
+ private:
+       /** Last item in the ModeType enum
+        */
+       static const unsigned int MODETYPE_LAST = 2;
+
        /** Mode handlers for each mode, to access a handler subtract
         * 65 from the ascii value of the mode letter.
         * The upper bit of the value indicates if its a usermode
@@ -490,6 +507,10 @@ class CoreExport ModeParser
         */
        ModeHandler* modehandlers[MODETYPE_LAST][128];
 
+       /** An array of mode handlers indexed by the mode id
+        */
+       ModeHandler* modehandlersbyid[MODETYPE_LAST][MODEID_MAX];
+
        /** A map of mode handlers keyed by their name
         */
        ModeHandlerMap modehandlersbyname[MODETYPE_LAST];
@@ -539,6 +560,12 @@ class CoreExport ModeParser
         */
        void RecreateModeListFor004Numeric();
 
+       /** Allocates an unused id for the given mode type, throws a ModuleException if out of ids.
+        * @param mt The type of the mode to allocate the id for
+        * @return The id
+        */
+       ModeHandler::Id AllocateModeId(ModeType mt);
+
        /** The string representing the last set of modes to be parsed.
         * Use GetLastParse() to get this value, to be used for  display purposes.
         */
@@ -610,10 +637,12 @@ class CoreExport ModeParser
        const std::string& GetLastParse() const { return LastParse; }
        const std::vector<std::string>& GetLastParseParams() { return LastParseParams; }
        const std::vector<TranslateType>& GetLastParseTranslate() { return LastParseTranslate; }
+
        /** Add a mode to the mode parser.
-        * @return True if the mode was successfully added.
+        * Throws a ModuleException if the mode cannot be added.
         */
-       bool AddMode(ModeHandler* mh);
+       void AddMode(ModeHandler* mh);
+
        /** 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
@@ -706,6 +735,12 @@ class CoreExport ModeParser
         * @return A list containing all prefix modes
         */
        const PrefixModeList& GetPrefixModes() const { return mhlist.prefix; }
+
+       /** Get a mode name -> ModeHandler* map containing all modes of the given type
+        * @param mt Type of modes to return, MODETYPE_USER or MODETYPE_CHANNEL
+        * @return A map of mode handlers of the given type
+        */
+       const ModeHandlerMap& GetModes(ModeType mt) const { return modehandlersbyname[mt]; }
 };
 
 inline const std::string& ModeParser::GetModeListFor004Numeric()