+
+ /** The constructor initializes all the RFC basic modes by using ModeParserAddMode().
+ */
+ ModeParser(InspIRCd* Instance);
+
+ /** Used to check if user 'd' should be allowed to do operation 'MASK' on channel 'chan'.
+ * for example, should 'user A' be able to 'op' on 'channel B'.
+ */
+ User* SanityChecks(User *user,const char *dest,Channel *chan,int status);
+ /** Grant a built in privilage (e.g. ops, halfops, voice) to a user on a channel
+ */
+ const char* Grant(User *d,Channel *chan,int MASK);
+ /** Revoke a built in privilage (e.g. ops, halfops, voice) to a user on a channel
+ */
+ const char* Revoke(User *d,Channel *chan,int MASK);
+ /** Tidy a banmask. This makes a banmask 'acceptable' if fields are left out.
+ * E.g.
+ *
+ * nick -> nick!*@*
+ *
+ * nick!ident -> nick!ident@*
+ *
+ * host.name -> *!*@host.name
+ *
+ * ident@host.name -> *!ident@host.name
+ *
+ * This method can be used on both IPV4 and IPV6 user masks.
+ */
+ static void CleanMask(std::string &mask);
+ /** Get the last string to be processed, as it was sent to the user or channel.
+ * Use this to display a string you just sent to be parsed, as the actual output
+ * may be different to what you sent after it has been 'cleaned up' by the parser.
+ * @return Last parsed string, as seen by users.
+ */
+ const std::string& GetLastParse();
+ /** Add a mode to the mode parser.
+ * @return True if the mode was successfully added.
+ */
+ bool 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
+ * (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
+ * information.
+ * @param mw The ModeWatcher you want to add
+ * @return True if the ModeWatcher was added correctly
+ */
+ bool AddModeWatcher(ModeWatcher* mw);
+ /** Delete a mode watcher.
+ * A mode watcher is triggered before and after a mode handler is
+ * triggered. See the documentation of class ModeWatcher for more
+ * information.
+ * @param mw The ModeWatcher you want to delete
+ * @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.
+ * @param pcnt The number of items in the parameters array
+ * @param user The user setting or removing the modes. When the modes are set
+ * by a server, an 'uninitialized' User is used, where *user::nick == NULL
+ * 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);
+
+ /** Find the mode handler for a given mode and type.
+ * @param modeletter mode letter to search for
+ * @param type of mode to search for, user or channel
+ * @returns a pointer to a ModeHandler class, or NULL of there isnt a handler for the given mode
+ */
+ ModeHandler* FindMode(unsigned const char modeletter, ModeType mt);
+
+ /** Find a mode handler by its prefix.
+ * If there is no mode handler with the given prefix, NULL will be returned.
+ * @param pfxletter The prefix to find, e.g. '@'
+ * @return The mode handler which handles this prefix, or NULL if there is none.
+ */
+ ModeHandler* FindPrefix(unsigned const char pfxletter);
+
+ /** Returns a list of mode characters which are usermodes.
+ * This is used in the 004 numeric when users connect.
+ */
+ std::string UserModeList();
+
+ /** Returns a list of channel mode characters which are listmodes.
+ * This is used in the 004 numeric when users connect.
+ */
+ std::string ChannelModeList();
+
+ /** Returns a list of channel mode characters which take parameters.
+ * This is used in the 004 numeric when users connect.
+ */
+ std::string ParaModeList();
+
+ /** Generates the CHANMODES= 005 sequence
+ */
+ std::string ChanModes();
+ /** Used by this class internally during std::sort and 005 generation
+ */
+ static bool PrefixComparison(prefixtype one, 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(User* user, Channel* channel);