]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/modules.h
Add ModeHandler::IsListModeBase() and MC_LIST
[user/henk/code/inspircd.git] / include / modules.h
index 52e41a1fc49f1a47332045c04a51a96474a9fc38..d7b46ad4834b6552333605b79010396b9dec7b9a 100644 (file)
@@ -122,12 +122,10 @@ struct ModResult {
  * 'FOREACH_MOD(OnConnect,(user));'
  */
 #define FOREACH_MOD(y,x) do { \
-       EventHandlerIter safei; \
-       IntModuleList& _handlers = ServerInstance->Modules->EventHandlers[I_ ## y]; \
-       for (EventHandlerIter _i = _handlers.begin(); _i != _handlers.end(); ) \
+       const IntModuleList& _handlers = ServerInstance->Modules->EventHandlers[I_ ## y]; \
+       for (IntModuleList::const_reverse_iterator _i = _handlers.rbegin(), _next; _i != _handlers.rend(); _i = _next) \
        { \
-               safei = _i; \
-               ++safei; \
+               _next = _i+1; \
                try \
                { \
                        (*_i)->y x ; \
@@ -136,7 +134,6 @@ struct ModResult {
                { \
                        ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "Exception caught: %s",modexcept.GetReason()); \
                } \
-               _i = safei; \
        } \
 } while (0);
 
@@ -148,9 +145,10 @@ struct ModResult {
  */
 #define DO_EACH_HOOK(n,v,args) \
 do { \
-       IntModuleList& _handlers = ServerInstance->Modules->EventHandlers[I_ ## n]; \
-       for (EventHandlerIter _i = _handlers.begin(); _i != _handlers.end(); ++_i) \
+       const IntModuleList& _handlers = ServerInstance->Modules->EventHandlers[I_ ## n]; \
+       for (IntModuleList::const_reverse_iterator _i = _handlers.rbegin(), _next; _i != _handlers.rend(); _i = _next) \
        { \
+               _next = _i+1; \
                try \
                { \
                        v = (*_i)->n args;
@@ -252,7 +250,7 @@ enum Priority { PRIORITY_FIRST, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER }
 enum Implementation
 {
        I_BEGIN,
-       I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash,
+       I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart,
        I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois,
        I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNick,
        I_OnUserMessage, I_OnMode, I_OnGetServerDescription, I_OnSyncUser,
@@ -278,6 +276,11 @@ enum Implementation
  */
 class CoreExport Module : public classbase, public usecountbase
 {
+       /** Detach an event from this module
+        * @param i Event type to detach
+        */
+       void DetachEvent(Implementation i);
+
  public:
        /** File that this module was loaded from
         */
@@ -316,6 +319,13 @@ class CoreExport Module : public classbase, public usecountbase
        {
        }
 
+       /** This method is called when you should reload module specific configuration:
+        * on boot, on a /REHASH and on module load.
+        * @param status The current status, can be inspected for more information;
+        * also used for reporting configuration errors and warnings.
+        */
+       virtual void ReadConfig(ConfigStatus& status);
+
        /** Returns the version number of a Module.
         * The method should return a Version object with its version information assigned via
         * Version::Version
@@ -406,14 +416,6 @@ class CoreExport Module : public classbase, public usecountbase
         */
        virtual void OnModuleRehash(User* user, const std::string &parameter);
 
-       /** Called on rehash.
-        * This method is called after a rehash has completed. You should use it to reload any module
-        * configuration from the main configuration file.
-        * @param user The user that performed the rehash, if it was initiated by a user and that user
-        * is still connected.
-        */
-       virtual void OnRehash(User* user);
-
        /** Called whenever a snotice is about to be sent to a snomask.
         * snomask and type may both be modified; the message may not.
         * @param snomask The snomask the message is going to (e.g. 'A')
@@ -1166,15 +1168,14 @@ typedef IntModuleList::iterator EventHandlerIter;
  */
 class CoreExport ModuleManager
 {
+ public:
+       typedef std::vector<ServiceProvider*> ServiceList;
+
  private:
        /** Holds a string describing the last module error to occur
         */
        std::string LastModuleError;
 
-       /** Total number of modules loaded into the ircd
-        */
-       int ModCount;
-
        /** List of loaded modules and shared object/dll handles
         * keyed by module name
         */
@@ -1188,7 +1189,18 @@ class CoreExport ModuleManager
 
        /** Internal unload module hook */
        bool CanUnload(Module*);
+
+       /** Loads all core modules (cmd_*)
+        */
+       void LoadCoreModules(std::map<std::string, ServiceList>& servicemap);
+
+       /** Calls the Prioritize() method in all loaded modules
+        * @return True if all went well, false if a dependency loop was detected
+        */
+       bool PrioritizeHooks();
+
  public:
+       typedef std::map<std::string, Module*> ModuleMap;
 
        /** Event handler hooks.
         * This needs to be public to be used by FOREACH_MOD and friends.
@@ -1198,6 +1210,16 @@ class CoreExport ModuleManager
        /** List of data services keyed by name */
        std::multimap<std::string, ServiceProvider*> DataProviders;
 
+       /** A list of ServiceProviders waiting to be registered.
+        * Non-NULL when constructing a Module, NULL otherwise.
+        * When non-NULL ServiceProviders add themselves to this list on creation and the core
+        * automatically registers them (that is, call AddService()) after the Module is constructed,
+        * and before Module::init() is called.
+        * If a service is created after the construction of the Module (for example in init()) it
+        * has to be registered manually.
+        */
+       ServiceList* NewServices;
+
        /** Simple, bog-standard, boring constructor.
         */
        ModuleManager();
@@ -1270,6 +1292,11 @@ class CoreExport ModuleManager
         */
        void DetachAll(Module* mod);
 
+       /** Attach all events to a module (used on module load)
+        * @param mod Module to attach to all events
+        */
+       void AttachAll(Module* mod);
+
        /** Returns text describing the last module error
         * @return The last error message to occur
         */
@@ -1301,14 +1328,6 @@ class CoreExport ModuleManager
        void UnloadAll();
        void DoSafeUnload(Module*);
 
-       /** Get the total number of currently loaded modules
-        * @return The number of loaded modules
-        */
-       int GetCount()
-       {
-               return this->ModCount;
-       }
-
        /** Find a module by name, and return a Module* to it.
         * This is preferred over iterating the module lists yourself.
         * @param name The module name to look up
@@ -1322,6 +1341,11 @@ class CoreExport ModuleManager
        /** Unregister a service provided by a module */
        void DelService(ServiceProvider&);
 
+       /** Register all services in a given ServiceList
+        * @param list The list containing the services to register
+        */
+       void AddServices(const ServiceList& list);
+
        inline void AddServices(ServiceProvider** list, int count)
        {
                for(int i=0; i < count; i++)
@@ -1338,13 +1362,10 @@ class CoreExport ModuleManager
                return static_cast<T*>(FindService(SERVICE_DATA, name));
        }
 
-       /** Return a list of all modules matching the given filter
-        * @param filter This int is a bitmask of flags set in Module::Flags,
-        * such as VF_VENDOR or VF_STATIC. If you wish to receive a list of
-        * all modules with no filtering, set this to 0.
-        * @return The list of module names
+       /** Get a map of all loaded modules keyed by their name
+        * @return A ModuleMap containing all loaded modules
         */
-       const std::vector<std::string> GetAllModuleNames(int filter);
+       const ModuleMap& GetModules() const { return Modules; }
 };
 
 /** Do not mess with these functions unless you know the C preprocessor
@@ -1374,11 +1395,7 @@ struct AllModuleList {
 };
 
 #define MODULE_INIT(x) static Module* MK_ ## x() { return new x; } \
-       static const AllModuleList PREP_ ## x(&MK_ ## x, MODNAMESTR);
-
-#define MODNAMESTR MODNAMESTR_FN_2(MODNAME)
-#define MODNAMESTR_FN_2(x) MODNAMESTR_FN_1(x)
-#define MODNAMESTR_FN_1(x) #x
+       static const AllModuleList PREP_ ## x(&MK_ ## x, MODNAME ".so");
 
 #else
 
@@ -1411,7 +1428,7 @@ struct AllModuleList {
        { \
                return new y; \
        } \
-       extern "C" const char inspircd_src_version[] = VERSION " r" REVISION;
+       extern "C" DllExport const char inspircd_src_version[] = VERSION " " REVISION;
 #endif
 
 #define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)