include/modules.h

   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
  23  */
  24
  25 #ifndef INCLUDED_modules_h
  26 #define INCLUDED_modules_h
  27 #include "config.h"
  28 #include "setup.h"
  29 #include "parse.h"
  30
  31 #define MAPI_CHARYBDIS 2
  32
  33 #include <ltdl.h>
  34
  35 #include "msg.h"
  36 #include "hook.h"
  37
  38 struct module
  39 {
  40         char *name;
  41         const char *version;
  42         const char *description;
  43         lt_dlhandle address;
  44         int core;
  45         int origin;
  46         int mapi_version;
  47         void *mapi_header; /* actually struct mapi_mheader_av<mapi_version> */
  48 };
  49
  50 #define MAPI_MAGIC_HDR  0x4D410000
  51
  52 #define MAPI_V1         (MAPI_MAGIC_HDR | 0x1)
  53 #define MAPI_V2         (MAPI_MAGIC_HDR | 0x2)
  54
  55 #define MAPI_MAGIC(x)   ((x) & 0xffff0000)
  56 #define MAPI_VERSION(x) ((x) & 0x0000ffff)
  57
  58 typedef struct Message* mapi_clist_av1;
  59
  60 typedef struct
  61 {
  62         const char *hapi_name;
  63         int *hapi_id;
  64 } mapi_hlist_av1;
  65
  66 typedef struct
  67 {
  68         const char *hapi_name;
  69         hookfn fn;
  70 } mapi_hfn_list_av1;
  71
  72
  73 #define MAPI_CAP_CLIENT         1
  74 #define MAPI_CAP_SERVER         2
  75
  76 typedef struct
  77 {
  78         int cap_index;          /* Which cap index does this belong to? */
  79         const char *cap_name;   /* Capability name */
  80         void *cap_ownerdata;    /* Not used much but why not... */
  81         int *cap_id;            /* May be set to non-NULL to store cap id */
  82 } mapi_cap_list_av2;
  83
  84 struct mapi_mheader_av1
  85 {
  86         int mapi_version;                       /* Module API version */
  87         int (*mapi_register)(void);             /* Register function; ret -1 = failure (unload) */
  88         void (*mapi_unregister)(void);          /* Unregister function. */
  89         mapi_clist_av1 *mapi_command_list;      /* List of commands to add. */
  90         mapi_hlist_av1 *mapi_hook_list;         /* List of hooks to add. */
  91         mapi_hfn_list_av1 *mapi_hfn_list;       /* List of hook_add_hook's to do */
  92         const char *mapi_module_version;        /* Module's version (freeform) */
  93 };
  94
  95 #define MAPI_ORIGIN_UNKNOWN     0               /* Unknown provenance (AV1 etc.) */
  96 #define MAPI_ORIGIN_EXTERNAL    1               /* Came from outside charybdis */
  97 #define MAPI_ORIGIN_EXTENSION   2               /* Charybdis bundled extension */
  98 #define MAPI_ORIGIN_CORE        3               /* Charybdis core module */
  99
 100 struct mapi_mheader_av2
 101 {
 102         int mapi_version;                       /* Module API version */
 103         int mapi_origin;                        /* Module provenance */
 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) */
 112 };
 113
 114 #define DECLARE_MODULE_AV1(name, reg, unreg, cl, hl, hfnlist, v) \
 115         struct mapi_mheader_av1 _mheader = { MAPI_V1, reg, unreg, cl, hl, hfnlist, v}
 116
 117 #define DECLARE_MODULE_AV2(name, origin, reg, unreg, cl, hl, hfnlist, caplist, v, desc) \
 118         struct mapi_mheader_av2 _mheader = { MAPI_V2, origin, reg, unreg, cl, hl, hfnlist, caplist, v, desc}
 119
 120 /* add a path */
 121 void mod_add_path(const char *path);
 122 void mod_clear_paths(void);
 123
 124 /* load a module */
 125 extern void load_module(char *path);
 126
 127 /* load all modules */
 128 extern void load_all_modules(int warn);
 129
 130 /* load core modules */
 131 extern void load_core_modules(int);
 132
 133 extern int unload_one_module(const char *, int);
 134 extern int load_one_module(const char *, int);
 135 extern int load_a_module(const char *, int, int);
 136 extern int findmodule_byname(const char *);
 137 extern void modules_init(void);
 138
 139 #endif /* INCLUDED_modules_h */