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