X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fmode.h;h=2524c11ddf3f583afcfb89d3a888d7fe43efb47c;hb=b80d1be349a5a5dbb16cde08d59543a553f9a382;hp=d548ea8d73b4959fa8ef8aba86bfb26c8e3d0adb;hpb=4874c63f738fd1139e0c6a889d02de6b4cc30187;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/mode.h b/include/mode.h index d548ea8d7..2524c11dd 100644 --- a/include/mode.h +++ b/include/mode.h @@ -30,7 +30,9 @@ class InspIRCd; */ enum ModeType { + /** User mode */ MODETYPE_USER = 0, + /** Channel mode */ MODETYPE_CHANNEL = 1 }; @@ -56,7 +58,7 @@ enum ModeMasks /** * These fixed values can be used to proportionally compare module-defined prefixes to known values. - * For example, if your module queries a chanrec, and is told that user 'joebloggs' has the prefix + * For example, if your module queries a Channel, and is told that user 'joebloggs' has the prefix * '$', and you dont know what $ means, then you can compare it to these three values to determine * its worth against them. For example if '$' had a value of 15000, you would know it is of higher * status than voice, but lower status than halfop. @@ -64,8 +66,11 @@ enum ModeMasks */ enum PrefixModeValue { + /* +v */ VOICE_VALUE = 10000, + /* +h */ HALFOP_VALUE = 20000, + /* +o */ OP_VALUE = 30000 }; @@ -93,6 +98,9 @@ typedef std::pair ModePair; class CoreExport ModeHandler : public Extensible { protected: + /** + * Creator/owner pointer + */ InspIRCd* ServerInstance; /** * The mode letter you're implementing. @@ -178,7 +186,7 @@ class CoreExport ModeHandler : public Extensible * Get the 'value' of this modes prefix. * determines which to display when there are multiple. * The mode with the highest value is ranked first. See the - * PrefixModeValue enum and chanrec::GetPrefixValue() for + * PrefixModeValue enum and Channel::GetPrefixValue() for * more information. */ virtual unsigned int GetPrefixRank(); @@ -215,14 +223,22 @@ class CoreExport ModeHandler : public Extensible * @param adding This value is true when the mode is being set, or false when it is being unset. * @return MODEACTION_ALLOW to allow the mode, or MODEACTION_DENY to prevent the mode, also see the description of 'parameter'. */ - virtual ModeAction OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string ¶meter, bool adding); /* Can change the mode parameter as its a ref */ + virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding); /* Can change the mode parameter as its a ref */ /** * If your mode is a listmode, then this method will be called for displaying an item list, e.g. on MODE #channel +modechar * without any parameter or other modes in the command. * @param user The user issuing the command - * @parameter channel The channel they're requesting an item list of (e.g. a banlist, or an exception list etc) + * @param channel The channel they're requesting an item list of (e.g. a banlist, or an exception list etc) + */ + virtual void DisplayList(User* user, Channel* channel); + + /** + * If your mode is a listmode, this method will be called to display an empty list (just the end of list numeric) + * @param user The user issuing the command + * @param channel The channel tehy're requesting an item list of (e.g. a banlist, or an exception list etc) */ - virtual void DisplayList(userrec* user, chanrec* channel); + virtual void DisplayEmptyList(User* user, Channel* channel); + /** * If your mode needs special action during a server sync to determine which side wins when comparing timestamps, * override this function and use it to return true or false. The default implementation just returns true if @@ -235,7 +251,7 @@ class CoreExport ModeHandler : public Extensible * @param channel The channel we are checking against * @return True if the other side wins the merge, false if we win the merge for this mode. */ - virtual bool CheckTimeStamp(time_t theirs, time_t ours, const std::string &their_param, const std::string &our_param, chanrec* channel); + virtual bool CheckTimeStamp(time_t theirs, time_t ours, const std::string &their_param, const std::string &our_param, Channel* channel); /** * When a remote server needs to bounce a set of modes, it will call this method for every mode @@ -250,7 +266,7 @@ class CoreExport ModeHandler : public Extensible * the current setting for this mode set locally, when the bool is true, or, the parameter given. * 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 ¶meter); + virtual ModePair ModeSet(User* source, User* dest, Channel* channel, const std::string ¶meter); /** * When a MODETYPE_USER mode handler is being removed, the server will call this method for every user on the server. @@ -260,7 +276,7 @@ class CoreExport ModeHandler : public Extensible * your mode properly from each user. * @param user The user which the server wants to remove your mode from */ - virtual void RemoveMode(userrec* user); + virtual void RemoveMode(User* user); /** * When a MODETYPE_CHANNEL mode handler is being removed, the server will call this method for every channel on the server. @@ -270,7 +286,7 @@ class CoreExport ModeHandler : public Extensible * 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); + virtual void RemoveMode(Channel* channel); }; /** @@ -282,6 +298,9 @@ class CoreExport ModeHandler : public Extensible class CoreExport ModeWatcher : public Extensible { protected: + /** + * Creator/owner pointer + */ InspIRCd* ServerInstance; /** * The mode letter this class is watching @@ -326,7 +345,7 @@ class CoreExport ModeWatcher : public Extensible * @return True to allow the mode change to go ahead, false to abort it. If you abort the * change, the mode handler (and ModeWatcher::AfterMode()) will never see the mode change. */ - virtual bool BeforeMode(userrec* source, userrec* dest, chanrec* channel, std::string ¶meter, bool adding, ModeType type); + virtual bool BeforeMode(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding, ModeType type); /** * After the mode character has been processed by the ModeHandler, this method will be called. * @param source The sender of the mode @@ -337,7 +356,7 @@ class CoreExport ModeWatcher : public Extensible * @param adding True if the mode is being added and false if it is being removed * @type The mode type, either MODETYPE_USER or MODETYPE_CHANNEL */ - virtual void AfterMode(userrec* source, userrec* dest, chanrec* channel, const std::string ¶meter, bool adding, ModeType type); + virtual void AfterMode(User* source, User* dest, Channel* channel, const std::string ¶meter, bool adding, ModeType type); }; typedef std::vector::iterator ModeWatchIter; @@ -350,6 +369,9 @@ typedef std::vector::iterator ModeWatchIter; class CoreExport ModeParser : public classbase { private: + /** + * Creator/owner pointer + */ InspIRCd* ServerInstance; /** Mode handlers for each mode, to access a handler subtract * 65 from the ascii value of the mode letter. @@ -365,7 +387,7 @@ class CoreExport ModeParser : public classbase /** Displays the current modes of a channel or user. * Used by ModeParser::Process. */ - void DisplayCurrentModes(userrec *user, userrec* targetuser, chanrec* targetchannel, const char* text); + void DisplayCurrentModes(User *user, User* targetuser, Channel* targetchannel, const char* text); /** The string representing the last set of modes to be parsed. * Use GetLastParse() to get this value, to be used for display purposes. @@ -381,13 +403,13 @@ class CoreExport ModeParser : public classbase /** 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'. */ - userrec* SanityChecks(userrec *user,const char *dest,chanrec *chan,int status); + 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(userrec *d,chanrec *chan,int MASK); + 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(userrec *d,chanrec *chan,int MASK); + const char* Revoke(User *d,Channel *chan,int MASK); /** Tidy a banmask. This makes a banmask 'acceptable' if fields are left out. * E.g. * @@ -444,11 +466,11 @@ class CoreExport ModeParser : public classbase * 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' userrec is used, where *user::nick == NULL + * 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, userrec *user, bool servermode); + 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 @@ -498,7 +520,8 @@ class CoreExport ModeParser : public classbase * @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); + std::string ModeString(User* user, Channel* channel); }; #endif +