]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/mode.h
Assign an id to user modes, parameter chanmodes and simple chanmodes
[user/henk/code/inspircd.git] / include / mode.h
index f0609fec215a170121fd677fffff5d2cd14293da..d71423ecff5e2e54cb7c35244d69df9a51afc831 100644 (file)
@@ -45,17 +45,6 @@ enum ModeAction
        MODEACTION_ALLOW = 1 /* Allow the mode */
 };
 
-/**
- * Used to mask off the mode types in the mode handler
- * array. Used in a simple two instruction hashing function
- * "(modeletter - 65) OR mask"
- */
-enum ModeMasks
-{
-       MASK_USER = 128,        /* A user mode */
-       MASK_CHANNEL = 0        /* A channel mode */
-};
-
 /**
  * These fixed values can be used to proportionally compare module-defined prefixes to known values.
  * For example, if your module queries a Channel, and is told that user 'joebloggs' has the prefix
@@ -105,6 +94,8 @@ class ParamModeBase;
 class CoreExport ModeHandler : public ServiceProvider
 {
  public:
+       typedef size_t Id;
+
        enum Class
        {
                MC_PREFIX,
@@ -113,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
@@ -224,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);
@@ -306,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;
 };
 
 /**
@@ -485,13 +488,32 @@ typedef std::multimap<std::string, ModeWatcher*>::iterator ModeWatchIter;
  */
 class CoreExport ModeParser
 {
+ public:
+       static const ModeHandler::Id MODEID_MAX = 64;
+
  private:
+       /** Last item in the ModeType enum
+        */
+       static const unsigned int MODETYPE_LAST = 2;
+
+       /** Type of the container that maps mode names to ModeHandlers
+        */
+       typedef TR1NS::unordered_map<std::string, ModeHandler*, irc::insensitive, irc::StrHashComp> ModeHandlerMap;
+
        /** 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
         * or a channel mode, so we have 256 of them not 64.
         */
-       ModeHandler* modehandlers[256];
+       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];
 
        /** Lists of mode handlers by type
         */
@@ -538,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.
         */
@@ -648,6 +676,13 @@ class CoreExport ModeParser
         */
        void Process(const std::vector<std::string>& parameters, User* user, ModeProcessFlag flags = MODE_NONE);
 
+       /** Find the mode handler for a given mode name and type.
+        * @param modename The mode name to search for.
+        * @param mt Type of mode to search for, user or channel.
+        * @return A pointer to a ModeHandler class, or NULL of there isn't a handler for the given mode name.
+        */
+       ModeHandler* FindMode(const std::string& modename, ModeType mt);
+
        /** Find the mode handler for a given mode and type.
         * @param modeletter mode letter to search for
         * @param mt type of mode to search for, user or channel