1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
|
/*
* Copyright (c) 2003-2007 by FlashCode <flashcode@flashtux.org>
* See README for License detail, AUTHORS for developers list.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/* This header is designed to be distributed with WeeChat plugins */
#ifndef __WEECHAT_WEECHAT_PLUGIN_H
#define __WEECHAT_WEECHAT_PLUGIN_H 1
#include <sys/types.h>
/* return codes for init function and handlers */
#define PLUGIN_RC_FAILED -1 /* function/handler failed */
#define PLUGIN_RC_SUCCESS 0 /* function/handler ok */
/* return codes specific to message handlers: messages can be discarded for
WeeChat, for plugins, or both */
#define PLUGIN_RC_IGNORE_WEECHAT 1 /* ignore WeeChat for this message */
#define PLUGIN_RC_IGNORE_PLUGINS 2 /* ignore other plugins for msg */
#define PLUGIN_RC_IGNORE_ALL (PLUGIN_RC_OK_IGNORE_WEECHAT \
| PLUGIN_RC_OK_IGNORE_PLUGINS)
/* ignore WeeChat and other plugins*/
#define PLUGIN_RC_WITH_HIGHLIGHT 4 /* ok and ask for highlight */
/* (for message handler only) */
struct t_weechat_plugin
{
/* plugin variables */
char *filename; /* name of plugin on disk */
void *handle; /* handle of plugin (given by dlopen)*/
char *name; /* plugin name */
char *description; /* plugin description */
char *version; /* plugin version */
char *charset; /* charset used by plugin */
struct t_weechat_plugin *prev_plugin; /* link to previous plugin */
struct t_weechat_plugin *next_plugin; /* link to next plugin */
/* plugin functions (API) */
/* IMPORTANT NOTE for WeeChat developers: always add new API functions
at the END of functions, for keeping backward compatibility with
existing plugins */
/* strings */
void (*charset_set) (struct t_weechat_plugin *, char *);
char *(*iconv_to_internal) (struct t_weechat_plugin *, char *, char *);
char *(*iconv_from_internal) (struct t_weechat_plugin *, char *, char *);
char *(*gettext) (struct t_weechat_plugin *, char *);
char *(*ngettext) (struct t_weechat_plugin *, char *, char *, int);
int (*strcasecmp) (struct t_weechat_plugin *, char *, char *);
int (*strncasecmp) (struct t_weechat_plugin *, char *, char *, int);
char *(*string_replace) (struct t_weechat_plugin *, char *, char *, char *);
char **(*string_explode) (struct t_weechat_plugin *, char *, char *, int,
int, int *);
void (*string_free_exploded) (struct t_weechat_plugin *, char **);
char **(*string_split_command) (struct t_weechat_plugin *, char *, char);
void (*string_free_splitted_command) (struct t_weechat_plugin *, char **);
/* directories */
int (*mkdir_home) (struct t_weechat_plugin *, char *, int);
int (*mkdir) (struct t_weechat_plugin *, char *, int);
void (*exec_on_files) (struct t_weechat_plugin *, char *,
int (*)(char *));
/* util */
long (*timeval_diff) (struct t_weechat_plugin *, void *, void *);
/* sorted list */
struct t_weelist *(*list_new) (struct t_weechat_plugin *);
char *(*list_add) (struct t_weechat_plugin *, void *, char *,
char *);
struct t_weelist_item *(*list_search) (struct t_weechat_plugin *, void *,
char *);
struct t_weelist_item *(*list_casesearch) (struct t_weechat_plugin *, void *,
char *);
struct t_weelist_item *(*list_get) (struct t_weechat_plugin *, void *, int);
struct t_weelist_item *(*list_next) (struct t_weechat_plugin *, void *);
struct t_weelist_item *(*list_prev) (struct t_weechat_plugin *, void *);
char *(*list_string) (struct t_weechat_plugin *, void *);
int (*list_size) (struct t_weechat_plugin *, void *);
void (*list_remove) (struct t_weechat_plugin *, void *, void *);
void (*list_remove_all) (struct t_weechat_plugin *, void *);
void (*list_free) (struct t_weechat_plugin *, void *);
/* config files */
struct t_config_file *(*config_new) (struct t_weechat_plugin *, char *);
struct t_config_section *(*config_new_section) (struct t_weechat_plugin *,
void *, char *,
void (*)(void *, char *, char *),
void (*)(void *, char *),
void (*)(void *, char *));
struct t_config_section *(*config_search_section) (struct t_weechat_plugin *,
void *, char *);
struct t_config_option *(*config_new_option) (struct t_weechat_plugin *,
void *, char *, char *,
char *, char *, int, int,
char *, void (*)());
struct t_config_option *(*config_search_option) (struct t_weechat_plugin *,
void *, void *, char *);
int (*config_option_set) (struct t_weechat_plugin *, void *, char *);
char (*config_string_to_boolean) (struct t_weechat_plugin *, char *);
char (*config_boolean) (struct t_weechat_plugin *, void *);
int (*config_integer) (struct t_weechat_plugin *, void *);
char *(*config_string) (struct t_weechat_plugin *, void *);
int (*config_color) (struct t_weechat_plugin *, void *);
int (*config_read) (struct t_weechat_plugin *, void *);
int (*config_reload) (struct t_weechat_plugin *, void *);
int (*config_write) (struct t_weechat_plugin *, void *);
void (*config_write_line) (struct t_weechat_plugin *, void *,
char *, char *, ...);
void (*config_free) (struct t_weechat_plugin *, void *);
struct t_config_option *(*config_get) (struct t_weechat_plugin *, char *);
char *(*plugin_config_get) (struct t_weechat_plugin *, char *);
int (*plugin_config_set) (struct t_weechat_plugin *, char *, char *);
/* display */
char *(*prefix) (struct t_weechat_plugin *, char *);
char *(*color) (struct t_weechat_plugin *, char *);
void (*printf) (struct t_weechat_plugin *, void *, char *, ...);
void (*printf_date) (struct t_weechat_plugin *, void *, time_t,
char *, ...);
void (*log_printf) (struct t_weechat_plugin *, char *, ...);
void (*print_infobar) (struct t_weechat_plugin *, int, char *, ...);
void (*infobar_remove) (struct t_weechat_plugin *, int);
/* hooks */
struct t_hook *(*hook_command) (struct t_weechat_plugin *, char *, char *,
char *, char *, char *,
int (*)(void *, void *, int, char **, char **),
void *);
struct t_hook *(*hook_timer) (struct t_weechat_plugin *, long, int,
int (*)(void *), void *);
struct t_hook *(*hook_fd) (struct t_weechat_plugin *, int, int, int, int,
int (*)(void *), void *);
struct t_hook *(*hook_print) (struct t_weechat_plugin *, void *, char *,
int,
int (*)(void *, void *, time_t, char *, char *),
void *);
struct t_hook *(*hook_event) (struct t_weechat_plugin *, char *,
int (*)(void *, char *, void *), void *);
struct t_hook *(*hook_config) (struct t_weechat_plugin *, char *, char *,
int (*)(void *, char *, char *, char *),
void *);
struct t_hook *(*hook_completion) (struct t_weechat_plugin *, char *,
int (*)(void *, char *, void *),
void *);
void (*unhook) (struct t_weechat_plugin *, void *);
void (*unhook_all) (struct t_weechat_plugin *);
/* buffers */
struct t_gui_buffer *(*buffer_new) (struct t_weechat_plugin *,
char *, char *,
void (*)(struct t_gui_buffer *, char *));
struct t_gui_buffer *(*buffer_search) (struct t_weechat_plugin *,
char *, char *);
void (*buffer_close) (struct t_weechat_plugin *, void *);
void (*buffer_set) (struct t_weechat_plugin *, void *, char *, char *);
void (*buffer_nick_add) (struct t_weechat_plugin *, void *, char *, int,
char *, char, char *);
void (*buffer_nick_remove) (struct t_weechat_plugin *, char *);
/* command */
void (*command) (struct t_weechat_plugin *, void *, char *);
/* infos */
char *(*info_get) (struct t_weechat_plugin *, char *);
/* infolists */
struct t_plugin_infolist *(*infolist_get) (struct t_weechat_plugin *,
char *, void *);
int (*infolist_next) (struct t_weechat_plugin *, void *);
int (*infolist_prev) (struct t_weechat_plugin *, void *);
char *(*infolist_fields) (struct t_weechat_plugin *, void *);
int (*infolist_integer) (struct t_weechat_plugin *, void *, char *);
char *(*infolist_string) (struct t_weechat_plugin *, void *, char *);
void *(*infolist_pointer) (struct t_weechat_plugin *, void *, char *);
time_t (*infolist_time) (struct t_weechat_plugin *, void *, char *);
void (*infolist_free) (struct t_weechat_plugin *, void *);
/* log */
void (*log) (struct t_weechat_plugin *, char *, char *, char *, ...);
/* WeeChat developers: ALWAYS add new functions at the end */
};
/* macros for easy call to plugin API */
/* strings */
#define weechat_charset_set(__charset) \
weechat_plugin->charset_set(weechat_plugin, __charset)
#define weechat_iconv_to_internal(__charset, __string) \
weechat_plugin->iconv_to_internal(weechat_plugin, \
__charset, __string)
#define weechat_iconv_from_internal(__charset, __string) \
weechat_plugin->iconv_from_internal(weechat_plugin, \
__charset, __string)
#ifndef __WEECHAT_H
#define _(string) weechat_plugin->gettext(weechat_plugin, string)
#define N_(string) (string)
#define NG_(single,plural,number) \
weechat_plugin->ngettext(weechat_plugin, single, plural, number)
#endif
#define weechat_strcasecmp(__string1, __string2) \
weechat_plugin->strcasecmp(weechat_plugin, __string1, __string2)
#define weechat_strncasecmp(__string1, __string2, __max) \
weechat_plugin->strncasecmp(weechat_plugin, __string1, \
__string2, __max)
#define weechat_string_replace(__string1, __search1, __replace1) \
weechat_plugin->string_replace(weechat_plugin, __string1, \
__search1, __replace1)
#define weechat_string_explode(__string1, __separator, __eol, __max, \
__num_items) \
weechat_plugin->string_explode(weechat_plugin, __string1, \
__separator, __eol, __max, \
__num_items)
#define weechat_string_free_exploded(__array_str) \
weechat_plugin->string_free_exploded(weechat_plugin, __array_str)
#define weechat_string_split_command(__string1, __separator) \
weechat_plugin->string_split_command(weechat_plugin, __string1, \
__separator)
#define weechat_string_free_splitted_command(__array_str) \
weechat_plugin->string_free_splitted_command(weechat_plugin, \
__array_str)
/* directories */
#define weechat_mkdir_home(__directory, __mode) \
weechat_plugin->mkdir_home(weechat_plugin, __directory, __mode)
#define weechat_mkdir(__directory, __mode) \
weechat_plugin->mkdir(weechat_plugin, __directory, __mode)
#define weechat_exec_on_files(__directory, __callback) \
weechat_plugin->exec_on_files(weechat_plugin, __directory, \
__callback)
/* util */
#define weechat_timeval_diff(__time1, __time2) \
weechat_plugin->timeval_diff(weechat_plugin, __time1, __time2)
/* sorted list */
#define weechat_list_new() \
weechat_plugin->list_new(weechat_plugin)
#define weechat_list_add(__list, __string, __sort) \
weechat_plugin->list_add(weechat_plugin, __list, __string, __sort)
#define weechat_list_search(__list, __string) \
weechat_plugin->list_search(weechat_plugin, __list, __string)
#define weechat_list_casesearch(__list, __string) \
weechat_plugin->list_casesearch(weechat_plugin, __list, __string)
#define weechat_list_get(__list, __index) \
weechat_plugin->list_get(weechat_plugin, __list, __index)
#define weechat_list_next(__item) \
weechat_plugin->list_next(weechat_plugin, __item)
#define weechat_list_prev(__item) \
weechat_plugin->list_prev(weechat_plugin, __item)
#define weechat_list_string(__item) \
weechat_plugin->list_string(weechat_plugin, __item)
#define weechat_list_size(__list) \
weechat_plugin->list_size(weechat_plugin, __list)
#define weechat_list_remove(__list, __item) \
weechat_plugin->list_remove(weechat_plugin, __list, __item)
#define weechat_list_remove_all(__list) \
weechat_plugin->list_remove_all(weechat_plugin, __list)
#define weechat_list_free(__list) \
weechat_plugin->list_free(weechat_plugin, __list)
/* config files */
#define weechat_config_new(__filename) \
weechat_plugin->config_new(weechat_plugin, __filename)
#define weechat_config_new_section(__config, __name, __cb_read, \
__cb_write_std, __cb_write_def) \
weechat_plugin->config_new_section(weechat_plugin, \
__config, __name, __cb_read, \
__cb_write_std, __cb_write_def)
#define weechat_config_search_section(__config, __name) \
weechat_plugin->config_search_section(weechat_plugin, \
__config, __name)
#define weechat_config_new_option(__section, __name, __type, __desc, \
__string_values, __min, __max, \
__default, __callback) \
weechat_plugin->config_new_option(weechat_plugin, \
__section, __name, __type, \
__desc, __string_values, \
__min, __max, __default, \
__callback)
#define weechat_config_search_option(__config, __section, __name) \
weechat_plugin->config_search_option(weechat_plugin, \
__config, __section, __name)
#define weechat_config_option_set(__option, __value) \
weechat_plugin->config_option_set(weechat_plugin, __option, \
__value)
#define weechat_config_string_to_boolean(__string) \
weechat_plugin->config_string_to_boolean(weechat_plugin, __string)
#define weechat_config_boolean(__option) \
weechat_plugin->config_boolean(weechat_plugin, __option)
#define weechat_config_integer(__option) \
weechat_plugin->config_integer(weechat_plugin, __option)
#define weechat_config_string(__option) \
weechat_plugin->config_string(weechat_plugin, __option)
#define weechat_config_color(__option) \
weechat_plugin->config_color(weechat_plugin, __option)
#define weechat_config_read(__config) \
weechat_plugin->config_read(weechat_plugin, __config)
#define weechat_config_reload(__config) \
weechat_plugin->config_reload(weechat_plugin, __config)
#define weechat_config_write(__config) \
weechat_plugin->config_write(weechat_plugin, __config)
#define weechat_config_write_line(__config, __option, \
__value...) \
weechat_plugin->config_write_line(weechat_plugin, \
__config, __option, \
##__value)
#define weechat_config_free(__config) \
weechat_plugin->config_free(weechat_plugin, __config)
#define weechat_config_get(__option) \
weechat_plugin->config_get(weechat_plugin, __option)
#define weechat_plugin_config_get(__option) \
weechat_plugin->plugin_config_get(weechat_plugin, __option)
#define weechat_plugin_config_set(__option, __value) \
weechat_plugin->plugin_config_set(weechat_plugin, __option, __value)
/* display */
#define weechat_prefix(__prefix_name) \
weechat_plugin->prefix(weechat_plugin, __prefix_name)
#define weechat_color(__color_name) \
weechat_plugin->color(weechat_plugin, __color_name)
#define weechat_printf(__buffer, __argz...) \
weechat_plugin->printf(weechat_plugin, __buffer, ##__argz)
#define weechat_printf_date(__buffer, __datetime, __argz...) \
weechat_plugin->printf_date(weechat_plugin, __buffer, __datetime, \
##__argz)
#define weechat_log_printf(__argz...) \
weechat_plugin->log_printf(weechat_plugin, ##__argz)
/* hooks */
#define weechat_hook_command(__command, __description, __args, \
__args_desc, __completion, __callback, \
__data) \
weechat_plugin->hook_command(weechat_plugin, __command, __description, \
__args, __args_desc, __completion, \
__callback, __data)
#define weechat_hook_timer(__interval, __max_calls, __callback, __data) \
weechat_plugin->hook_timer(weechat_plugin, __interval, __max_calls, \
__callback, __data)
#define weechat_hook_fd(__fd, __flag_read, __flag_write, \
__flag_exception, __callback, __data) \
weechat_plugin->hook_fd(weechat_plugin, __fd, __flag_read, \
__flag_write, __flag_exception, __callback, \
__data)
#define weechat_hook_print(__buffer, __msg, __stri__colors, __callback, \
__data) \
weechat_plugin->hook_print(weechat_plugin, __buffer, __msg, \
__stri__colors, __callback, __data)
#define weechat_hook_event(__event, __callback, __data) \
weechat_plugin->hook_event(weechat_plugin, __event, __callback, __data)
#define weechat_hook_config(__type, __option, __callback, __data) \
weechat_plugin->hook_config(weechat_plugin, __type, __option, \
__callback, __data)
#define weechat_hook_completion(__completion, __callback, __data) \
weechat_plugin->hook_completion(weechat_plugin, __completion, \
__callback, __data)
#define weechat_unhook(__hook) \
weechat_plugin->unhook(weechat_plugin, __hook)
#define weechat_unhook_all() \
weechat_plugin->unhook(weechat_plugin)
/* buffers */
#define weechat_buffer_new(__category, __name, __input_data_cb) \
weechat_plugin->buffer_new(weechat_plugin, __category, __name, \
__input_data_cb)
#define weechat_buffer_search(__category, __name) \
weechat_plugin->buffer_search(weechat_plugin, __category, __name)
#define weechat_current_buffer \
weechat_plugin->buffer_search(weechat_plugin, NULL, NULL)
#define weechat_buffer_close(__buffer) \
weechat_plugin->buffer_close(weechat_plugin, __buffer)
#define weechat_buffer_set(__buffer, __property, __value) \
weechat_plugin->buffer_set(weechat_plugin, __buffer, \
__property, __value)
/* command */
#define weechat_command(__buffer, __command) \
weechat_plugin->command(weechat_plugin, __buffer, __command)
/* infos */
#define weechat_info_get(__name) \
weechat_plugin->info_get(weechat_plugin, __name)
/* infolists */
#define weechat_infolist_get(__name, __pointer) \
weechat_plugin->infolist_get(weechat_plugin, __name, __pointer)
#define weechat_infolist_next(__list) \
weechat_plugin->infolist_next(weechat_plugin, __list)
#define weechat_infolist_prev(__list) \
weechat_plugin->infolist_prev(weechat_plugin, __list)
#define weechat_infolist_fields(__list) \
weechat_plugin->infolist_fields(weechat_plugin, __list)
#define weechat_infolist_integer(__item, __var) \
weechat_plugin->infolist_integer(weechat_plugin, __item, __var)
#define weechat_infolist_string(__item, __var) \
weechat_plugin->infolist_string(weechat_plugin, __item, __var)
#define weechat_infolist_pointer(__item, __var) \
weechat_plugin->infolist_pointer(weechat_plugin, __item, __var)
#define weechat_infolist_time(__item, __var) \
weechat_plugin->infolist_time(weechat_plugin, __item, __var)
#define weechat_infolist_free(__list) \
weechat_plugin->infolist_free(weechat_plugin, __list)
#endif /* weechat-plugin.h */
|
