X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fmodules.h;h=ce2402964c4516a1f065f7b0d8a0255f53965017;hb=1dca8b79edf65c0e5e846cc120f1321fb0a1d15c;hp=7acab3cf691dba566158e922218f0bf25ffc5e2e;hpb=b9e11915a976daaf790ebc763aff56e19fd49e0f;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/modules.h b/include/modules.h index 7acab3cf6..ce2402964 100644 --- a/include/modules.h +++ b/include/modules.h @@ -35,14 +35,23 @@ #include "timer.h" #include "mode.h" -/** Used to define a set of behavior bits for a module - */ -enum ModuleFlags { - VF_NONE = 0, // module is not special at all - VF_VENDOR = 2, // module is a vendor module (came in the original tarball, not 3rd party) - VF_COMMON = 4, // module needs to be common on all servers in a network to link - VF_OPTCOMMON = 8, // module should be common on all servers for unsurprising behavior - VF_CORE = 16 // module is a core command, can be assumed loaded on all servers +/** Used to specify the behaviour of a module. */ +enum ModuleFlags +{ + /** The module has no special attributes. */ + VF_NONE = 0, + + /** The module is a coremod and can be assumed to be loaded on all servers. */ + VF_CORE = 1, + + /* The module is included with InspIRCd. */ + VF_VENDOR = 2, + + /** The module MUST be loaded on all servers on a network to link. */ + VF_COMMON = 4, + + /** The module SHOULD be loaded on all servers on a network for consistency. */ + VF_OPTCOMMON = 8 }; /** Used to represent an event type, for user, channel or server @@ -234,6 +243,7 @@ enum Implementation I_OnBuildNeighborList, I_OnGarbageCollect, I_OnSetConnectClass, I_OnText, I_OnPassCompare, I_OnNamesListItem, I_OnNumeric, I_OnPreRehash, I_OnModuleRehash, I_OnSendWhoLine, I_OnChangeIdent, I_OnSetUserIP, + I_OnServiceAdd, I_OnServiceDel, I_END }; @@ -276,7 +286,7 @@ class CoreExport Module : public classbase, public usecountbase /** Clean up prior to destruction * If you override, you must call this AFTER your module's cleanup */ - virtual CullResult cull(); + CullResult cull() CXX11_OVERRIDE; /** Default destructor. * destroys a module class @@ -649,16 +659,15 @@ class CoreExport Module : public classbase, public usecountbase */ virtual void OnExpireLine(XLine *line); - /** Called before your module is unloaded to clean up Extensibles. - * This method is called once for every user and channel on the network, - * so that when your module unloads it may clear up any remaining data - * in the form of Extensibles added using Extensible::Extend(). - * If the target_type variable is TYPE_USER, then void* item refers to - * a User*, otherwise it refers to a Channel*. - * @param target_type The type of item being cleaned - * @param item A pointer to the item's class + /** Called before the module is unloaded to clean up extensibles. + * This method is called once for every channel, membership, and user. + * so that you can clear up any data relating to the specified extensible. + * @param type The type of extensible being cleaned up. If this is EXT_CHANNEL + * then item is a Channel*, EXT_MEMBERSHIP then item is a Membership*, + * and EXT_USER then item is a User*. + * @param item A pointer to the extensible which is being cleaned up. */ - virtual void OnCleanup(int target_type, void* item); + virtual void OnCleanup(ExtensionItem::ExtensibleType type, Extensible* item); /** Called after any nickchange, local or remote. This can be used to track users after nickchanges * have been applied. Please note that although you can see remote nickchanges through this function, you should @@ -989,7 +998,7 @@ class CoreExport Module : public classbase, public usecountbase * @param user The user that this line of the query is about * @param memb The member shown in this line, NULL if no channel is in this line * @param numeric Numeric to send; modifiable. - * @param Return MOD_RES_PASSTHRU to allow the line to be displayed, MOD_RES_DENY to hide it + * @return MOD_RES_PASSTHRU to allow the line to be displayed, MOD_RES_DENY to hide it */ virtual ModResult OnSendWhoLine(User* source, const std::vector& params, User* user, Membership* memb, Numeric::Numeric& numeric); @@ -998,16 +1007,22 @@ class CoreExport Module : public classbase, public usecountbase * @param user The user whose IP is being set */ virtual void OnSetUserIP(LocalUser* user); + + /** Called whenever a ServiceProvider is registered. + * @param service ServiceProvider being registered. + */ + virtual void OnServiceAdd(ServiceProvider& service); + + /** Called whenever a ServiceProvider is unregistered. + * @param service ServiceProvider being unregistered. + */ + virtual void OnServiceDel(ServiceProvider& service); }; /** A list of modules */ typedef std::vector IntModuleList; -/** An event handler iterator - */ -typedef IntModuleList::iterator EventHandlerIter; - /** ModuleManager takes care of all things module-related * in the core. */ @@ -1032,7 +1047,7 @@ class CoreExport ModuleManager : public fakederef PRIO_STATE_LAST } prioritizationState; - /** Loads all core modules (cmd_*) + /** Loads all core modules (core_*) */ void LoadCoreModules(std::map& servicemap); @@ -1041,6 +1056,12 @@ class CoreExport ModuleManager : public fakederef */ bool PrioritizeHooks(); + /** Unregister all user modes or all channel modes owned by a module + * @param mod Module whose modes to unregister + * @param modetype MODETYPE_USER to unregister user modes, MODETYPE_CHANNEL to unregister channel modes + */ + void UnregisterModes(Module* mod, ModeType modetype); + public: typedef std::map ModuleMap; @@ -1275,7 +1296,7 @@ struct AllModuleList { } \ return TRUE; \ } \ - extern "C" DllExport const char inspircd_src_version[] = INSPIRCD_VERSION " " INSPIRCD_REVISION; + extern "C" DllExport const char inspircd_src_version[] = INSPIRCD_VERSION; #else @@ -1284,7 +1305,7 @@ struct AllModuleList { { \ return new y; \ } \ - extern "C" DllExport const char inspircd_src_version[] = INSPIRCD_VERSION " " INSPIRCD_REVISION; + extern "C" DllExport const char inspircd_src_version[] = INSPIRCD_VERSION; #endif #define COMMAND_INIT(c) MODULE_INIT(CommandModule)