]>
Commit | Line | Data |
---|---|---|
212380e3 AC |
1 | /* |
2 | * ircd-ratbox: A slightly useful ircd. | |
3 | * modules.h: A header for the modules functions. | |
4 | * | |
5 | * Copyright (C) 1990 Jarkko Oikarinen and University of Oulu, Co Center | |
6 | * Copyright (C) 1996-2002 Hybrid Development Team | |
7 | * Copyright (C) 2002-2004 ircd-ratbox development team | |
8 | * | |
9 | * This program is free software; you can redistribute it and/or modify | |
10 | * it under the terms of the GNU General Public License as published by | |
11 | * the Free Software Foundation; either version 2 of the License, or | |
12 | * (at your option) any later version. | |
13 | * | |
14 | * This program is distributed in the hope that it will be useful, | |
15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 | * GNU General Public License for more details. | |
18 | * | |
19 | * You should have received a copy of the GNU General Public License | |
20 | * along with this program; if not, write to the Free Software | |
21 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 | |
22 | * USA | |
212380e3 AC |
23 | */ |
24 | ||
25 | #ifndef INCLUDED_modules_h | |
26 | #define INCLUDED_modules_h | |
81204be8 | 27 | #include "serno.h" |
9b8e9eb3 | 28 | #include "defaults.h" |
212380e3 AC |
29 | #include "setup.h" |
30 | #include "parse.h" | |
31 | ||
8e9c6a75 | 32 | #define MAPI_CHARYBDIS 2 |
212380e3 | 33 | |
f272e7ab | 34 | #include <ltdl.h> |
212380e3 AC |
35 | |
36 | #include "msg.h" | |
212380e3 AC |
37 | #include "hook.h" |
38 | ||
39 | struct module | |
40 | { | |
41 | char *name; | |
42 | const char *version; | |
0eb7d9c0 | 43 | const char *description; |
f272e7ab | 44 | lt_dlhandle address; |
aa483e55 EM |
45 | int core; /* This is int for backwards compat reasons */ |
46 | int origin; /* Ditto */ | |
212380e3 | 47 | int mapi_version; |
8e9c6a75 | 48 | void *mapi_header; /* actually struct mapi_mheader_av<mapi_version> */ |
e55a9d6a | 49 | rb_dlink_node node; |
212380e3 AC |
50 | }; |
51 | ||
212380e3 AC |
52 | #define MAPI_MAGIC_HDR 0x4D410000 |
53 | ||
54 | #define MAPI_V1 (MAPI_MAGIC_HDR | 0x1) | |
8e9c6a75 | 55 | #define MAPI_V2 (MAPI_MAGIC_HDR | 0x2) |
212380e3 AC |
56 | |
57 | #define MAPI_MAGIC(x) ((x) & 0xffff0000) | |
58 | #define MAPI_VERSION(x) ((x) & 0x0000ffff) | |
59 | ||
60 | typedef struct Message* mapi_clist_av1; | |
61 | ||
62 | typedef struct | |
63 | { | |
8e9c6a75 EM |
64 | const char *hapi_name; |
65 | int *hapi_id; | |
212380e3 AC |
66 | } mapi_hlist_av1; |
67 | ||
68 | typedef struct | |
69 | { | |
8e9c6a75 EM |
70 | const char *hapi_name; |
71 | hookfn fn; | |
212380e3 AC |
72 | } mapi_hfn_list_av1; |
73 | ||
8e9c6a75 EM |
74 | |
75 | #define MAPI_CAP_CLIENT 1 | |
76 | #define MAPI_CAP_SERVER 2 | |
77 | ||
78 | typedef struct | |
79 | { | |
80 | int cap_index; /* Which cap index does this belong to? */ | |
81 | const char *cap_name; /* Capability name */ | |
82 | void *cap_ownerdata; /* Not used much but why not... */ | |
eeabf33a | 83 | unsigned int *cap_id; /* May be set to non-NULL to store cap id */ |
8e9c6a75 EM |
84 | } mapi_cap_list_av2; |
85 | ||
212380e3 AC |
86 | struct mapi_mheader_av1 |
87 | { | |
8e9c6a75 EM |
88 | int mapi_version; /* Module API version */ |
89 | int (*mapi_register)(void); /* Register function; ret -1 = failure (unload) */ | |
90 | void (*mapi_unregister)(void); /* Unregister function. */ | |
91 | mapi_clist_av1 *mapi_command_list; /* List of commands to add. */ | |
92 | mapi_hlist_av1 *mapi_hook_list; /* List of hooks to add. */ | |
93 | mapi_hfn_list_av1 *mapi_hfn_list; /* List of hook_add_hook's to do */ | |
94 | const char *mapi_module_version; /* Module's version (freeform) */ | |
212380e3 AC |
95 | }; |
96 | ||
c63aeb44 | 97 | #define MAPI_ORIGIN_UNKNOWN 0 /* Unknown provenance (AV1 etc.) */ |
216d70e9 EM |
98 | #define MAPI_ORIGIN_EXTENSION 1 /* Charybdis extension */ |
99 | #define MAPI_ORIGIN_CORE 2 /* Charybdis core module */ | |
c63aeb44 | 100 | |
8e9c6a75 EM |
101 | struct mapi_mheader_av2 |
102 | { | |
103 | int mapi_version; /* Module API version */ | |
104 | int (*mapi_register)(void); /* Register function; ret -1 = failure (unload) */ | |
105 | void (*mapi_unregister)(void); /* Unregister function. */ | |
106 | mapi_clist_av1 *mapi_command_list; /* List of commands to add. */ | |
107 | mapi_hlist_av1 *mapi_hook_list; /* List of hooks to add. */ | |
108 | mapi_hfn_list_av1 *mapi_hfn_list; /* List of hook_add_hook's to do */ | |
109 | mapi_cap_list_av2 *mapi_cap_list; /* List of CAPs to add */ | |
110 | const char *mapi_module_version; /* Module's version (freeform), replaced with ircd version if NULL */ | |
111 | const char *mapi_module_description; /* Module's description (freeform) */ | |
81204be8 | 112 | unsigned long int mapi_datecode; /* Unix timestamp of module's build */ |
8e9c6a75 EM |
113 | }; |
114 | ||
115 | #define DECLARE_MODULE_AV1(name, reg, unreg, cl, hl, hfnlist, v) \ | |
212380e3 | 116 | struct mapi_mheader_av1 _mheader = { MAPI_V1, reg, unreg, cl, hl, hfnlist, v} |
212380e3 | 117 | |
216d70e9 | 118 | #define DECLARE_MODULE_AV2(name, reg, unreg, cl, hl, hfnlist, caplist, v, desc) \ |
81204be8 | 119 | struct mapi_mheader_av2 _mheader = { MAPI_V2, reg, unreg, cl, hl, hfnlist, caplist, v, desc, DATECODE} |
8e9c6a75 | 120 | |
212380e3 AC |
121 | /* add a path */ |
122 | void mod_add_path(const char *path); | |
123 | void mod_clear_paths(void); | |
124 | ||
125 | /* load a module */ | |
126 | extern void load_module(char *path); | |
127 | ||
128 | /* load all modules */ | |
aa483e55 | 129 | extern void load_all_modules(bool warn); |
212380e3 AC |
130 | |
131 | /* load core modules */ | |
aa483e55 | 132 | extern void load_core_modules(bool); |
212380e3 | 133 | |
aa483e55 EM |
134 | extern bool unload_one_module(const char *, bool); |
135 | extern bool load_one_module(const char *, int, bool); | |
136 | extern bool load_a_module(const char *, bool, int, bool); | |
e55a9d6a | 137 | extern struct module *findmodule_byname(const char *); |
92dad483 | 138 | extern void init_modules(void); |
212380e3 | 139 | |
e55a9d6a AC |
140 | extern rb_dlink_list module_list; |
141 | extern rb_dlink_list mod_paths; | |
78946542 | 142 | |
212380e3 | 143 | #endif /* INCLUDED_modules_h */ |