mcabber: mcabber/doc/HOWTO_modules.txt annotate

annotate mcabber/doc/HOWTO_modules.txt @ 1735:5093b5ca1572

New modules loading scheme

author	Myhailo Danylenko <isbear@ukrpost.net>
date	Thu, 04 Mar 2010 13:03:20 +0200
parents	b09f82f61745
children	4a7c7900f600

rev	line source
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	1
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	2 ===========================================
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	3
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	4 Mcabber module writing brief howto
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	5
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	6 ===========================================
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	7
1735 5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	8 To obtain information on module mcabber uses struct
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	9 module_info_t, that module should provide in public
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	10 variable with name info_<modulename>. If module name
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	11 contains any extra symbols except [a-z0-9_] they should
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	12 be replaced with '_'.
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	13
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	14 --------------------------------------------------------
1735 5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	15 #include <mcabber/modules.h>
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	16
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	17 typedef void (*module_init_t)(void);
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	18 typedef void (*module_uninit_t)(void);
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	19
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	20 typedef struct {
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	21 const gchar *mcabber_version;
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	22 module_init_t init;
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	23 module_uninit_t uninit;
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	24 const gchar **requires;
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	25 } module_info_t;
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	26 --------------------------------------------------------
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	27
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	28 Callbacks init and uninit will be called after module
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	29 and it's dependencies loading. 'requires' should contain
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	30 NULL-terminated list of module names, that should be loaded
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	31 before this. 'mcabber_version' is required and should contain
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	32 mcabber version, that this module is designed to work with.
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	33 Three other fields may be NULL.
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	34
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	35 To load modules, mcabber uses glib's GModule, thus, in your
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	36 module you can also use functions
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	37
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	38 --------------------------------------------------------
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	39 #include <glib.h>
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	40 #include <gmodule.h>
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	41
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	42 const gchar* g_module_check_init (GModule *module);
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	43 void g_module_unload (GModule *module);
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	44 --------------------------------------------------------
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	45
1735 5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	46 to do something before any version/dependency checks will
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	47 be performed when module is loaded/unloaded. On success
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	48 g_module_check_init should return NULL, and error message
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	49 otherwise.
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	50
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	51 As module is loaded, you can use mcabber functions,
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	52 declared in mcabber's header files (though you should
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	53 consider, that they may change their calling conventions
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	54 some day).
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	55
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	56 I will not explain them all, there are too much of
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	57 them, but will provide description for those, provided
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	58 especially for module writers.
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	59
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	60 --------------------------------------------------------
1735 5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	61 #include <mcabber/modules.h>
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	62
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	63 const gchar module_load (const gchar name,
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	64 gboolean manual,
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	65 gboolean force);
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	66 const gchar module_unload (const gchar name,
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	67 gboolean manual,
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	68 gboolean force);
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	69 --------------------------------------------------------
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	70
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	71 These functions load and unload modules respectively.
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	72 You can use them to handle optional dependencies. What
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	73 happens, when module is loaded:
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	74 - check if module is present, and if present just
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	75 increase it's reference count
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	76 - load .so via glib (and call g_module_check_init, if
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	77 present)
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	78 - check for information structure presence
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	79 - check target mcabber version compatibility
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	80 - load modules, that this module requires (note, that
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	81 dependency problems will be reported as error
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	82 invariably, force flag have no effect on this check)
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	83 - module placed into a list of modules
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	84 - module init routine is called
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	85 And when unloaded:
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	86 - check if module is present
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	87 - decrease reference count, if it is not zero, return
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	88 - run module uninit routine
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	89 - unload modules, that were loaded as dependencies for
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	90 this
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	91 - remove from modules list
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	92 They return error message or NULL in case of success.
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	93 'manual' flag indicates, that module will be loaded by
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	94 direct user request. It serves the purpose of tracking
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	95 user and automatic references (user can have only one).
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	96 'force' flag on module loading causes mcabber to ignore
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	97 most of the loading errors. On unload it forces
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	98 unloading even if reference count is not zero.
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	99
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	100 --------------------------------------------------------
1669 004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	101 #include <mcabber/commands.h>
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	102
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	103 void cmd_add (const char name, const char help,
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	104 guint flags1, guint flags2,
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	105 void (f)(char), gpointer userdata);
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	106 void cmd_del (const char *name);
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	107 --------------------------------------------------------
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	108
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	109 These two functions are provided to declare mcabber
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	110 commands, offered by your module.
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	111 - name is a command name.
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	112 - help is a short description of your command, however
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	113 for now it is not used at all and can be omitted.
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	114 - flags are completion identifiers for first and second
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	115 command arguments, for list of built-in completions,
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	116 see compl.h. You can declare your own completion
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	117 lists, using functions from compl.h, described later.
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	118 - f is a user-provided callback function, that will be
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	119 called upon executing mcabber command. If you will
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	120 provide non-NULL userdata, function must be of type
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	121 void (f) (char commandline, gpointer userdata).
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	122 - userdata is a pointer to data, transparently passed
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	123 to callback. See f description.
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	124
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	125 --------------------------------------------------------
1669 004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	126 #include <mcabber/compl.h>
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	127
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	128 guint compl_new_category (void);
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	129 void compl_del_category (guint id);
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	130
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	131 void compl_add_category_word (guint categ,
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	132 const char *command);
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	133 void compl_del_category_word (guint categ,
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	134 const char *word);
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	135 GSList *compl_get_category_list (guint cat_flags,
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	136 guint *dynlist);
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	137 --------------------------------------------------------
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	138
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	139 These functions allow you to define and manage word
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	140 lists for completion categories, used by your commands.
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	141 First you need to obtain handle for completion type,
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	142 that you later will supply as flags, when declaring
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	143 your commands. For that use function compl_new_category.
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	144 It returns new category id or zero, if mcabber runs
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	145 out of completion ids (for now there are only 32 ids
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	146 available, and 20 of them are already taken by builtin
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	147 commands). compl_del_category allows you to delete
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	148 user-defined category, deleting all words in it too.
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	149
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	150 Now, that you have a completion category, you can at any
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	151 time add or delete words from it's completion list.
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	152 For that use functions compl_add_category_word and
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	153 compl_del_category_word. You can obtain current contents
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	154 of category by using gompl_get_category_list. If after
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	155 execution dynlist is TRUE, you should free obtained
1625 e3b93594ee6c Howto fixes Myhailo Danylenko <isbear@ukrpost.net> parents: 1624 diff changeset	156 list of words (both, words and list).
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	157
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	158 --------------------------------------------------------
1669 004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	159 #include <mcabber/hooks.h>
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	160
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	161 typedef struct {
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	162 const char *name;
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	163 const char *value;
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	164 } hk_arg_t;
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	165
1624 a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	166 typedef void (*hk_handler_t) (guint32 hookid,
a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	167 hk_arg_t *args,
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	168 gpointer userdata);
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	169
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	170 void hk_add_handler (hk_handler_t handler,
1624 a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	171 guint32 flags,
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	172 gpointer userdata);
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	173 void hk_del_handler (hk_handler_t handler,
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	174 gpointer userdata);
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	175 --------------------------------------------------------
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	176
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	177 These functions allow your module to react to events,
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	178 such as incoming and outgoing messages, buddy status
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	179 changes and sever connection establishment or breakup.
1624 a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	180 Flags field specifies mask of events, upon which this
a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	181 handler should be called. Flags, that comprise this
a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	182 mask can be found in hooks.h. You can specify not yet
a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	183 used flags in mask, if you need to handle all events.
a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	184 Handler can determine, which event is occured by
a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	185 hookid argument and by a "hook" field in args, that
a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	186 may provide more precise information in some cases.
a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	187 Args argument is a list of hk_arg_t structures,
a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	188 terminated by structure, whose name field is set to
a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	189 NULL. Usually the "hook" field is in the first
a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	190 structure of the list, however it is not guaranted,
a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	191 that this will be so forever.
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	192
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	193 Currently there are next events possible:
1624 a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	194 - hook-message-in (HOOK_MESSAGE_IN) with parameters
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	195 * jid - sender of the incoming message
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	196 * message - message body, converted to locale
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	197 charset
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	198 * groupchat ("true" or "false")
1624 a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	199 - hook-message-out (HOOK_MESSAGE_OUT) with parameters
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	200 * jid - recipient of the outgoing message
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	201 * message - message body, converted to locale
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	202 charset
1624 a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	203 - hook-status-change (HOOK_STATUS_CHANGE) with
a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	204 parameters
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	205 * jid - buddy, whose status has changed
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	206 * resource - resource, whose status has changed
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	207 * old_status - old status of the buddy, one-char
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	208 string, representing mcabber status letter -
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	209 one of 'ofdna?_'.
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	210 * new_status - new buddy status. The same as
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	211 old_status.
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	212 * message - new status message. Old one should be
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	213 still available to module as the current buddy's
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	214 message.
1624 a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	215 - hook-my-status-change (HOOK_MY_STATUS_CHANGE) with
a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	216 parameters
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	217 * new_status - user's new status, see
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	218 hook-status-change. Old one should still be
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	219 available as the current status of the user.
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	220 * message - new status message
1683 b09f82f61745 Split HOOK_INTERNAL Myhailo Danylenko <isbear@ukrpost.net> parents: 1669 diff changeset	221 - hook-post-connect (HOOK_POST_CONNECT) with no parameters
b09f82f61745 Split HOOK_INTERNAL Myhailo Danylenko <isbear@ukrpost.net> parents: 1669 diff changeset	222 - hook-pre-disconnect (HOOK_PRE_DICSONNECT) with no
1624 a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	223 parameters
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	224
1624 a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	225 --------------------------------------------------------
1669 004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	226 #include <mcabber/xmpp_helper.h>
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	227
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	228 void xmpp_add_feature (const char *xmlns);
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	229 void xmpp_del_feature (const char *xmlns);
1624 a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	230 --------------------------------------------------------
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	231
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	232 These functions may be useful, if your module implements
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	233 some additional functionality to mcabber, that should be
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	234 advertised in a client's discovery features list.
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	235
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	236 =====================
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	237
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	238 Example: hello
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	239
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	240 =====================
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	241
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	242 Now, let's write a simple module, called "hello", that
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	243 will do no more than just print something on loading
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	244 and unloading.
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	245
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	246 --------------------------------------------------------
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	247 #include <glib.h>
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	248 #include <gmodule.h>
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	249
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	250 /* We will use scr_LogPrint mcabber function,
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	251 that does mcabber's messages output */
1669 004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	252 #include <mcabber/logprint.h>
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	253
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	254 /* Print something on module loading */
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	255 const gchar* g_module_check_init (GModule *module)
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	256 {
1669 004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	257 scr_LogPrint (LPRINT_NORMAL, "Hello, World!");
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	258 return NULL;
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	259 }
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	260
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	261 /* ... and unloading */
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	262 void g_module_unload (GModule *module)
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	263 {
1669 004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	264 scr_LogPrint (LPRINT_NORMAL, "Bye, World!");
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	265 }
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	266
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	267 /* The End */
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	268 --------------------------------------------------------
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	269
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	270 Now, compile this file (hello.c) with
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	271
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	272 libtool --mode=compile gcc `pkg-config --cflags glib-2.0 \
1735 5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	273 gmodule-2.0 mcabber` -c hello.c
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	274 libtool --mode=link gcc -module -rpath /usr/lib/mcabber/ \
1735 5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	275 `pkg-config --libs glib-2.0 gmodule-2.0 mcabber` \
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	276 -o libhello.la hello.lo
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	277
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	278 (you should substitute /usr/lib/mcabber to directory, where
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	279 your modules are located) and then install obtained module with
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	280
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	281 libtool --mode=install install libhello.la \
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	282 /usr/lib/mcabber/libhello.la
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	283
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	284 Note, that you, most likely need not run suggested by libtool
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	285 finish action, as we're working with module object, not system-
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	286 wide library, but maybe some systems require that.
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	287
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	288 Now, set modules_dir mcabber variable to point to your modules
1735 5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	289 dir, and try to run /module -f load hello. If all goes well,
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	290 you should see in status buffer message "Hello World!" (as
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	291 well as some complaints, as we forced module loading).
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	292 Now unload module by running command /module unload hello,
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	293 that should bring up message "Bye, World!".
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	294
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	295 That's it, you just created very simple dynamically loadable
1735 5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	296 mcabber module. But, as you noticed, it needs force to be
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	297 loaded. Now, let's add information structure, that mcabber
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	298 wants.
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	299
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	300 ==========================
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	301
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	302 Example: info struct
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	303
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	304 ==========================
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	305
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	306 --------------------------------------------------------
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	307 #include <mcabber/logprint.h>
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	308 /* module_info_t definition */
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	309 #include <mcabber/modules.h>
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	310
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	311 /* Print something on module loading */
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	312 void hello_init (void)
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	313 {
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	314 scr_LogPrint (LPRINT_NORMAL, "Hello, World!");
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	315 }
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	316
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	317 /* ... and unloading */
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	318 void hello_uninit (void)
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	319 {
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	320 scr_LogPrint (LPRINT_NORMAL, "Bye, World!");
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	321 }
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	322
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	323 module_info_t info_hello = {
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	324 .mcabber_version = "0.10.0",
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	325 .requires = NULL,
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	326 .init = hello_init,
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	327 .uninit = hello_uninit,
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	328 };
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	329
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	330 /* The End */
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	331 --------------------------------------------------------
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	332
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	333 Here we now do not use glib nor gmodule, so, we can omit
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	334 them in compilation lines:
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	335
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	336 libtool --mode=compile gcc `pkg-config --cflags mcabber` \
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	337 -c hello.c
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	338 libtool --mode=link gcc -module -rpath /usr/lib/mcabber/ \
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	339 `pkg-config --libs mcabber` -o libhello.la hello.lo
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	340
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	341 Again compile it, copy, and try to load, now without -f
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	342 flag. As you may notice, when loading previous example,
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	343 mcabber first printed "Hello, World!", and only then
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	344 complaint about module not having information struct.
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	345 That's because g_module_check_init is called right
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	346 after module loading, before mcabber even have a chance
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	347 to look at module, while .init from info struct is
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	348 called afterwards by mcabber itself. You can try to
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	349 introduce some error (eg too high or missing target
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	350 mcabber version) and see the difference.
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	351
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	352 =======================
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	353
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	354 Example: command
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	355
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	356 =======================
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	357
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	358 Now, let's allow our module to do some real work.
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	359
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	360 --------------------------------------------------------
1669 004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	361 #include <mcabber/logprint.h>
004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	362 #include <mcabber/commands.h>
1735 5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	363 #include <mcabber/modules.h>
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	364
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	365 /* Handler for command */
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	366 void do_hello (char *args)
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	367 {
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	368 /* args contains command line with command
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	369 * name and any spaces after it stripped */
1669 004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	370 scr_LogPrint (LPRINT_NORMAL, "Hello, %s!",
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	371 *args != '\0' ? args : "World");
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	372 }
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	373
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	374 /* Register command */
1735 5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	375 void hello_init (void)
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	376 {
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	377 cmd_add ("hello", "", 0, 0, do_hello, NULL);
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	378 }
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	379
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	380 /* Unregister command */
1735 5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	381 void hello_uninit (void)
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	382 {
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	383 cmd_del ("hello");
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	384 }
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	385
1735 5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	386 module_info_t hello_info = {
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	387 .mcabber_version = "0.10.0",
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	388 .requires = NULL,
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	389 .init = hello_init,
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	390 .uninit = hello_uninit,
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	391 }
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	392
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	393 /* The End */
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	394 --------------------------------------------------------
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	395
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	396 Now, compile it and try to load and run /hello with some
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	397 arguments.
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	398
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	399 Note, that we used one-argument version of command
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	400 handler, as we specified no userdata.
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	401
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	402 ==========================
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	403
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	404 Example: completion
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	405
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	406 ==========================
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	407
1669 004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	408 Now let's investigate how to provide custom completion to
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	409 your commands. You can as well use built-in completions,
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	410 their IDs are listed in compl.h.
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	411
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	412 --------------------------------------------------------
1669 004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	413 #include <mcabber/logprint.h>
004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	414 #include <mcabber/commands.h>
1735 5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	415 #include <mcabber/modules.h>
1669 004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	416 #include <mcabber/compl.h>
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	417
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	418 static guint hello_cid = 0;
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	419
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	420 /* hello command handler */
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	421 void do_hello (char *args)
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	422 {
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	423 /* If argument is provided, add it to
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	424 * completions list. */
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	425 if (hello_cid && *args != '\0')
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	426 compl_add_category_word (hello_cid,
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	427 args);
1669 004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	428 scr_LogPrint (LPRINT_NORMAL, "Hello, %s!",
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	429 *args != '\0' ? args : "World");
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	430 }
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	431
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	432 /* Initialization */
1735 5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	433 void hello_init (void)
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	434 {
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	435 /* Obtain handle for our completion
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	436 * category */
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	437 hello_cid = compl_new_category ();
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	438 if (hello_cid)
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	439 /* Add known default word to
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	440 * completion list */
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	441 compl_add_category_word (hello_cid,
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	442 "World");
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	443 cmd_add ("hello", "", hello_cid, 0, do_hello,
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	444 NULL);
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	445 }
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	446
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	447 /* Deinitialization */
1735 5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	448 void hello_uninit (void)
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	449 {
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	450 /* Give back category handle */
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	451 if (hello_cid)
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	452 compl_del_category (hello_cid);
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	453 cmd_del ("hello");
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	454 }
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	455
1735 5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	456 module_info_t hello_info = {
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	457 .mcabber_version = "0.10.0",
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	458 .requires = NULL,
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	459 .init = hello_init,
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	460 .uninit = hello_uninit,
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	461 }
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	462
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	463 /* The End */
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	464 --------------------------------------------------------
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	465
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	466 Now you can use completion for hello command. Note, that
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	467 this code have some serious simplifications, made for
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	468 simplicity reasons. For now, compl_add_category_word
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	469 does not checks, if word already exists in completions
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	470 list (although it is marked as TODO, so, some day it
1669 004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	471 will), so, we should check it ourselves.
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	472
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	473 =====================
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	474
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	475 Example: hooks
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	476
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	477 =====================
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	478
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	479 Now let's implement our own beeper. Why anyone may wish
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	480 to do this? I am not satisfied with default mcabber's
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	481 builtin beeper flexibility. I wanted beeping on any
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	482 muc conference message, not just ones, directed to me.
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	483
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	484 --------------------------------------------------------
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	485 #include <string.h>
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	486
1669 004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	487 #include <mcabber/logprint.h>
004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	488 #include <mcabber/commands.h>
004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	489 #include <mcabber/compl.h>
004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	490 #include <mcabber/hooks.h>
004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	491 #include <mcabber/screen.h>
004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	492 #include <mcabber/settings.h>
1735 5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	493 #include <mcabber/module.h>
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	494
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	495 static guint beep_cid = 0;
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	496
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	497 /* Event handler */
1624 a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	498 void beep_hh (guint32 hid, hk_arg_t *args, gpointer userdata)
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	499 {
1624 a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	500 /* Check if beeping is enabled */
a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	501 if (settings_opt_get_int ("beep_enable"))
a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	502 /* BEEP! */
a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	503 scr_Beep ();
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	504 }
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	505
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	506 /* beep command handler */
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	507 void do_beep (char *args)
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	508 {
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	509 /* Check arguments, and if recognized,
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	510 * set mcabber option accordingly */
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	511 if (!strcmp (args, "enable") \|\|
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	512 !strcmp (args, "on") \|\|
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	513 !strcmp (args, "yes") \|\|
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	514 !strcmp (args, "1"))
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	515 settings_set (SETTINGS_TYPE_OPTION,
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	516 "beep_enable", "1");
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	517 else if (!strcmp (args, "disable") \|\|
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	518 !strcmp (args, "off") \|\|
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	519 !strcmp (args, "no") \|\|
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	520 !strcmp (args, "0"))
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	521 settings_set (SETTINGS_TYPE_OPTION,
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	522 "beep_enable", "0");
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	523
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	524 /* Output current state, either if state is
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	525 * changed and if argument is not recognized */
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	526 if (settings_opt_get_int ("beep_enable"))
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	527 scr_LogPrint (LPRINT_NORMAL,
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	528 "Beep on messages is enabled");
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	529 else
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	530 scr_LogPrint (LPRINT_NORMAL,
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	531 "Beep on messages is disabled");
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	532 }
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	533
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	534 /* Initialization */
1735 5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	535 void beep_init (void)
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	536 {
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	537 /* Create completions */
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	538 beep_cid = compl_new_category ();
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	539 if (beep_cid) {
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	540 compl_add_category_word (beep_cid, "enable");
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	541 compl_add_category_word (beep_cid, "disable");
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	542 }
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	543 /* Add command */
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	544 cmd_add ("beep", "", beep_cid, 0, do_beep, NULL);
1624 a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	545 /* Add handler
a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	546 * We are only interested in incoming message events
a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	547 */
a75611931642 Hook handler flags updates to howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1619 diff changeset	548 hk_add_handler (beep_hh, HOOK_MESSAGE_IN, NULL);
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	549 }
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	550
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	551 /* Deinitialization */
1735 5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	552 void beep_uninit (void)
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	553 {
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	554 /* Unregister event handler */
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	555 hk_del_handler (beep_hh, NULL);
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	556 /* Unregister command */
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	557 cmd_del ("beep");
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	558 /* Give back completion handle */
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	559 if (beep_cid)
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	560 compl_del_category (beep_cid);
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	561 }
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	562
1735 5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	563 module_info_t beep_info = {
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	564 .mcabber_version = "0.10.0",
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	565 .requires = NULL,
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	566 .init = beep_init,
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	567 .uninit = beep_uninit,
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	568 }
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	569
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	570 /* The End */
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	571 --------------------------------------------------------
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	572
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	573 If you use CMake (as do I), corresponding CMakeLists.txt
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	574 snippet:
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	575
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	576 --------------------------------------------------------
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	577 cmake_minimum_required(VERSION 2.6)
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	578 project(beep C)
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	579
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	580 find_package(PkgConfig REQUIRED)
1735 5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	581 pkg_check_modules(MCABBER REQUIRED mcabber)
1669 004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	582 # this one should be before any target definitions
1735 5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	583 link_directories(${MCABBER_LIBRARY_DIRS})
1669 004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	584
004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	585 add_library(beep MODULE beep.c)
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	586
1735 5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	587 include_directories(SYSTEM ${MCABBER_INCLUDE_DIRS})
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	588 target_link_libraries(beep ${MCABBER_LIBRARIES)
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	589 include_directories(${beep_SOURCE_DIR}
1669 004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	590 ${beep_BINARY_DIR})
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	591
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	592 install(TARGETS beep DESTINATION lib/mcabber)
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	593 --------------------------------------------------------
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	594
1735 5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	595 ===========================
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	596
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	597 Example: dependencies
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	598
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	599 ===========================
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	600
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	601 I will not provide here a complete example of two
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	602 modules, one of which depends on other, only some
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	603 use cases.
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	604
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	605 Info struct for module, that depends on two other
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	606 modules:
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	607
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	608 --------------------------------------------------------
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	609 #include <mcabber/modules.h>
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	610
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	611 const gchar *a_deps[] = { "b", "c", NULL };
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	612
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	613 module_info_t info_a = {
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	614 .mcabber_version = "0.10.0",
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	615 .requires = a_deps,
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	616 .init = a_init,
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	617 .uninit = a_uninit,
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	618 };
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	619 --------------------------------------------------------
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	620
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	621 If your module needs to "authenticate" mcabber version
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	622 too, this can be done in g_module_check_init:
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	623
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	624 --------------------------------------------------------
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	625 #include <glib.h>
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	626 #include <gmodule.h>
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	627
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	628 #include <mcabber/main.h>
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	629
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	630 const gchar g_module_check_init (GModule module)
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	631 {
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	632 char *ver = mcabber_version ();
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	633
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	634 // ver now contains version in format
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	635 // X.X.X[-xxx][ (XXXXXXXXX)]
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	636 if (...)
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	637 return "Incompatible mcabber version";
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	638
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	639 g_free (ver);
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	640 return NULL;
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	641 }
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	642 --------------------------------------------------------
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	643
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	644 Also you can use glib check_init routine to modify
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	645 module information, that will be checked by mcabber,
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	646 eg. if you want your module to always pass mcabber
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	647 version check, you can assign version, obtained from
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	648 mcabber_version() to corresponding field in your struct.
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	649 Or you can modify your module's dependencies, though
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	650 direct module_load() will have the same effect, and
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	651 can be used for optional dependencies, that your module
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	652 can work without.
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	653
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	654 Note: remember, that g_module_check_init will be always
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	655 called, even if later module will not pass checks, thus:
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	656 - do not use functions from other modules there;
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	657 - provide g_module_unload to undo anything, check_init
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	658 has done.
5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	659
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	660 ==============
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	661
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	662 Further
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	663
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	664 ==============
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	665
1625 e3b93594ee6c Howto fixes Myhailo Danylenko <isbear@ukrpost.net> parents: 1624 diff changeset	666 As mcabber now uses glib mainloop, you can use glib's
1669 004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	667 event sources, for example, fifo reading already uses
004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	668 GIOChannels for non-blocking IO.
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	669
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	670 You can extend xmpp part of mcabber functionality by
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	671 providing lm message handlers with high priority and
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	672 allowing unhandled by your handler messages be taken
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	673 care by mcabber's handlers on normal priority level.
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	674 This is where you may need to modify set of advertised
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	675 supported disco features.
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	676
1669 004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	677 Many useful examples can be found in my modules, that
004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	678 can be found at http://isbear.unixzone.org.ua/source.
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	679
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	680 If you think, that your module needs to change
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	681 something, hardcoded in current implementation - feel
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	682 free to mail me or join mcabber's MUC room and
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	683 discuss this - for now I have only implemented things,
1669 004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	684 that I found necessary for written by me modules.
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	685
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	686 Also I am not native English speaker, so, if you find
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	687 some errors or non-natural constructs in this howto,
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	688 please, inform me (I will be glad, if you also provide
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	689 a more suitable version of text in question).
2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	690
1669 004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	691 -- Myhailo Danylenko
004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	692 -- mailto:isbear@ukrpost.net
004739237999 Update modules howto Myhailo Danylenko <isbear@ukrpost.net> parents: 1625 diff changeset	693 -- xmpp:isbear@unixzone.org.ua
1735 5093b5ca1572 New modules loading scheme Myhailo Danylenko <isbear@ukrpost.net> parents: 1683 diff changeset	694 -- Thu, 04 Mar 2010 09:32:38 +0200
1619 2a82e6654c04 Add a module writing howto Myhailo Danylenko <isbear@ukrpost.net> parents: diff changeset	695

Mercurial > ~mikael > mcabber > hg

annotate mcabber/doc/HOWTO_modules.txt @ 1735:5093b5ca1572