pegasus/weechat
1
0
Fork 0
mirror of https://github.com/weechat/weechat.git synced 2026-06-26 12:56:37 +02:00
Code Activity
Files
2e74526bb9691389160b8174a69f272c4c3fc1e2
weechat/src/plugins/weechat-plugin.h
T
Sebastien Helleu 2e74526bb9 Renamed hook "event" to "signal"
2007-12-13 11:47:12 +01:00

480 lines
27 KiB
C
Raw Blame History

/*
* 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 plugin functions */
#define WEECHAT_RC_ERROR -1 /* function failed with an error */
#define WEECHAT_RC_OK 0 /* function ok */
/* return codes specific to message handlers: messages can be discarded for
WeeChat, for plugins, or both */
#define WEECHAT_RC_IGNORE_WEECHAT 1 /* ignore WeeChat for this message */
#define WEECHAT_RC_IGNORE_PLUGINS 2 /* ignore other plugins for msg */
#define WEECHAT_RC_IGNORE_ALL (PLUGIN_RC_OK_IGNORE_WEECHAT \
| PLUGIN_RC_OK_IGNORE_PLUGINS)
/* ignore WeeChat and other plugins */
#define WEECHAT_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 *(*strcasestr) (struct t_weechat_plugin *, char *, char *);
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 **);
/* UTF-8 strings */
int (*utf8_has_8bits) (struct t_weechat_plugin *, char *);
int (*utf8_is_valid) (struct t_weechat_plugin *, char *, char **);
void (*utf8_normalize) (struct t_weechat_plugin *, char *, char);
char *(*utf8_prev_char) (struct t_weechat_plugin *, char *, char *);
char *(*utf8_next_char) (struct t_weechat_plugin *, char *);
int (*utf8_char_size) (struct t_weechat_plugin *, char *);
int (*utf8_strlen) (struct t_weechat_plugin *, char *);
int (*utf8_strnlen) (struct t_weechat_plugin *, char *, int);
int (*utf8_strlen_screen) (struct t_weechat_plugin *, char *);
int (*utf8_charcasecmp) (struct t_weechat_plugin *, char *, char *);
int (*utf8_char_size_screen) (struct t_weechat_plugin *, char *);
char *(*utf8_add_offset) (struct t_weechat_plugin *, char *, int);
int (*utf8_real_pos) (struct t_weechat_plugin *, char *, int);
int (*utf8_pos) (struct t_weechat_plugin *, char *, int);
/* 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 (*infobar_printf) (struct t_weechat_plugin *, int, char *,
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_signal) (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 *);
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_get) (struct t_weechat_plugin *, void *, char *);
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_strcasestr(__string1, __string2) \
weechat_plugin->strcasestr(weechat_plugin, __string1, __string2)
#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)
/* UTF-8 strings */
#define weechat_utf8_has_8bits(__string) \
weechat_plugin->utf8_has_8bits(weechat_plugin, __string)
#define weechat_utf8_is_valid(__string, __error) \
weechat_plugin->utf8_is_valid(weechat_plugin, __string, __error)
#define weechat_utf8_normalize(__string, __char) \
weechat_plugin->utf8_normalize(weechat_plugin, __string, __char)
#define weechat_utf8_prev_char(__start, __string) \
weechat_plugin->utf8_prev_char(weechat_plugin, __start, __string)
#define weechat_utf8_next_char(__string) \
weechat_plugin->utf8_next_char(weechat_plugin, __string)
#define weechat_utf8_char_size(__string) \
weechat_plugin->utf8_char_size(weechat_plugin, __string)
#define weechat_utf8_strlen(__string) \
weechat_plugin->utf8_strlen(weechat_plugin, __string)
#define weechat_utf8_strnlen(__string, __bytes) \
weechat_plugin->utf8_strnlen(weechat_plugin, __string, __bytes)
#define weechat_utf8_strlen_screen(__string) \
weechat_plugin->utf8_strlen_screen(weechat_plugin, __string)
#define weechat_utf8_charcasecmp(__string) \
weechat_plugin->utf8_charcasecmp(weechat_plugin, __string)
#define weechat_utf8_char_size_screen(__string) \
weechat_plugin->utf8_char_size_screen(weechat_plugin, __string)
#define weechat_utf8_add_offset(__string, __offset) \
weechat_plugin->utf8_add_offset(weechat_plugin, __string, __offset)
#define weechat_utf8_real_pos(__string, __pos) \
weechat_plugin->utf8_real_pos(weechat_plugin, __string, __pos)
#define weechat_utf8_pos(__string, __real_pos) \
weechat_plugin->utf8_pos(weechat_plugin, __string, __real_pos)
/* 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)
#define weechat_infobar_printf(__delay, __color, __argz...) \
weechat_plugin->infobar_printf(weechat_plugin, __delay, __color, \
##__argz)
#define weechat_infobar_remove(__number) \
weechat_plugin->infobar_remove(weechat_plugin, __number)
/* 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_signal(__signal, __callback, __data) \
weechat_plugin->hook_signal(weechat_plugin, __signal, __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_get(__buffer, __property) \
weechat_plugin->buffer_get(weechat_plugin, __buffer, __property)
#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 */
View Git Blame Copy Permalink