]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/mode.h
Remove unused ProtocolInterface::SendTopic()
[user/henk/code/inspircd.git] / include / mode.h
index fbc880129dcbd53a1bc2e482a211b0ba2213c3c5..e7ac756ecdaa636faf524166a272776f3fcea400 100644 (file)
@@ -168,6 +168,11 @@ class CoreExport ModeHandler : public ServiceProvider
        ModeHandler(Module* me, const std::string& name, char modeletter, ParamSpec params, ModeType type, Class mclass = MC_OTHER);
        virtual CullResult cull();
        virtual ~ModeHandler();
+
+       /** Register this object in the ModeParser
+        */
+       void RegisterService() CXX11_OVERRIDE;
+
        /**
         * Returns true if the mode is a list mode
         */
@@ -294,9 +299,9 @@ class CoreExport ModeHandler : public ServiceProvider
         * so if you inherit from it or your mode can be removed by the default implementation then you do not have to implement
         * this function).
         * @param channel The channel which the server wants to remove your mode from
-        * @param stack The mode stack to add the mode change to
+        * @param changelist Mode change list to populate with the removal of this mode
         */
-       virtual void RemoveMode(Channel* channel, irc::modestacker& stack);
+       virtual void RemoveMode(Channel* channel, Modes::ChangeList& changelist);
 
        inline unsigned int GetLevelRequired() const { return levelrequired; }
 
@@ -359,9 +364,9 @@ class CoreExport PrefixMode : public ModeHandler
        /**
         * Removes this prefix mode from all users on the given channel
         * @param chan The channel which the server wants to remove your mode from
-        * @param stack The mode stack to add the mode change to
+        * @param changelist Mode change list to populate with the removal of this mode
         */
-       void RemoveMode(Channel* chan, irc::modestacker& stack);
+       void RemoveMode(Channel* channel, Modes::ChangeList& changelist);
 
        /**
         * Mode prefix or 0. If this is defined, you should
@@ -473,8 +478,6 @@ class CoreExport ModeWatcher : public classbase
        virtual void AfterMode(User* source, User* dest, Channel* channel, const std::string& parameter, bool adding);
 };
 
-typedef std::multimap<std::string, ModeWatcher*>::iterator ModeWatchIter;
-
 /** The mode parser handles routing of modes and handling of mode strings.
  * It marshalls, controls and maintains both ModeWatcher and ModeHandler classes,
  * parses client to server MODE strings for user and channel modes, and performs
@@ -490,6 +493,10 @@ class CoreExport ModeParser : public fakederef<ModeParser>
        typedef TR1NS::unordered_map<std::string, ModeHandler*, irc::insensitive, irc::StrHashComp> ModeHandlerMap;
 
  private:
+       /** Type of the container that maps mode names to ModeWatchers
+        */
+       typedef insp::flat_multimap<std::string, ModeWatcher*> ModeWatcherMap;
+
        /** Last item in the ModeType enum
         */
        static const unsigned int MODETYPE_LAST = 2;
@@ -524,21 +531,12 @@ class CoreExport ModeParser : public fakederef<ModeParser>
 
        /** Mode watcher classes
         */
-       std::multimap<std::string, ModeWatcher*> modewatchermap;
+       ModeWatcherMap modewatchermap;
 
        /** Last processed mode change
         */
        Modes::ChangeList LastChangeList;
 
-       /** Displays the current modes of a channel or user.
-        * Used by ModeParser::Process.
-        */
-       void DisplayCurrentModes(User *user, User* targetuser, Channel* targetchannel, const char* text);
-       /** Displays the value of a list mode
-        * Used by ModeParser::Process.
-        */
-       void DisplayListModes(User* user, Channel* chan, const std::string& mode_sequence);
-
        /**
         * Attempts to apply a mode change to a user or channel
         */
@@ -569,10 +567,6 @@ class CoreExport ModeParser : public fakederef<ModeParser>
         */
        std::string LastParse;
 
-       unsigned int sent[256];
-
-       unsigned int seq;
-
        /** Cached mode list for use in 004 numeric
         */
        std::string Cached004ModeList;
@@ -671,14 +665,17 @@ class CoreExport ModeParser : public fakederef<ModeParser>
         * @return True if the ModeWatcher was deleted correctly
         */
        bool DelModeWatcher(ModeWatcher* mw);
-       /** 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.
+
+       /** Process a list of mode changes entirely. If the mode changes do not fit into one MODE line
+        * then multiple MODE lines are generated.
         * @param user The source of the mode change, can be a server user.
+        * @param targetchannel Channel to apply the mode change on. NULL if changing modes on a channel.
+        * @param targetuser User to apply the mode change on. NULL if changing modes on a user.
+        * @param changelist Modes to change in form of a Modes::ChangeList.
         * @param flags Optional flags controlling how the mode change is processed,
         * defaults to MODE_NONE.
         */
-       void Process(const std::vector<std::string>& parameters, User* user, ModeProcessFlag flags = MODE_NONE);
+       void Process(User* user, Channel* targetchannel, User* targetuser, Modes::ChangeList& changelist, ModeProcessFlag flags = MODE_NONE);
 
        /** Process a single MODE line's worth of mode changes, taking max modes and line length limits
         * into consideration. Return value indicates how many modes were processed.
@@ -705,8 +702,12 @@ class CoreExport ModeParser : public fakederef<ModeParser>
         * @param parameters List of strings describing the mode change to convert to a ChangeList.
         * Must be using the same format as the parameters of a MODE command.
         * @param changelist ChangeList object to populate.
+        * @param beginindex Index of the first element that is part of the MODE list in the parameters
+        * container. Defaults to 1.
+        * @param endindex Index of the first element that is not part of the MODE list. By default,
+        * the entire container is considered part of the MODE list.
         */
-       void ModeParamsToChangeList(User* user, ModeType type, const std::vector<std::string>& parameters, Modes::ChangeList& changelist);
+       void ModeParamsToChangeList(User* user, ModeType type, const std::vector<std::string>& parameters, Modes::ChangeList& changelist, unsigned int beginindex = 1, unsigned int endindex = UINT_MAX);
 
        /** Find the mode handler for a given mode name and type.
         * @param modename The mode name to search for.
@@ -771,6 +772,13 @@ class CoreExport ModeParser : public fakederef<ModeParser>
         * @return A map of mode handlers of the given type
         */
        const ModeHandlerMap& GetModes(ModeType mt) const { return modehandlersbyname[mt]; }
+
+       /** Show the list of a list mode to a user. Modules can deny the listing.
+        * @param user User to show the list to.
+        * @param chan Channel to show the list of.
+        * @param mh List mode to show the list of.
+        */
+       void ShowListModeList(User* user, Channel* chan, ModeHandler* mh);
 };
 
 inline const std::string& ModeParser::GetModeListFor004Numeric()