/* * Copyright (c) 2003-2006 by FlashCode * 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 2 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, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */ /* This header is designed to be distributed with WeeChat plugins */ #ifndef __WEECHAT_WEECHAT_PLUGIN_H #define __WEECHAT_WEECHAT_PLUGIN_H 1 #include /* return codes for init function and handlers */ #define PLUGIN_RC_KO -1 /* function/handler failed */ #define PLUGIN_RC_OK 0 /* function/handler ok */ /* return codes specific to message handlers: messages can be discarded for WeeChat, for plugins, or both */ #define PLUGIN_RC_OK_IGNORE_WEECHAT 1 /* ignore WeeChat for this message */ #define PLUGIN_RC_OK_IGNORE_PLUGINS 2 /* ignore other plugins for this msg */ #define PLUGIN_RC_OK_IGNORE_ALL (PLUGIN_RC_OK_IGNORE_WEECHAT \ | PLUGIN_RC_OK_IGNORE_PLUGINS) /* ignore WeeChat and other plugins */ typedef struct t_plugin_dcc_info t_plugin_dcc_info; struct t_plugin_dcc_info { char *server; /* irc server */ char *channel; /* irc channel (for DCC chat only) */ int type; /* DCC type (send or receive) */ int status; /* DCC status (waiting, sending, ..) */ time_t start_time; /* the time when DCC started */ time_t start_transfer; /* the time when DCC transfer started */ unsigned long addr; /* IP address */ int port; /* port */ char *nick; /* remote nick */ char *filename; /* filename (given by sender) */ char *local_filename; /* local filename (with path) */ int filename_suffix; /* suffix (.1 for ex) if renaming file */ unsigned long size; /* file size */ unsigned long pos; /* number of bytes received/sent */ unsigned long start_resume; /* start of resume (in bytes) */ unsigned long bytes_per_sec; /* bytes per second */ t_plugin_dcc_info *prev_dcc; /* link to previous dcc file/chat */ t_plugin_dcc_info *next_dcc; /* link to next dcc file/chat */ }; typedef struct t_weechat_plugin t_weechat_plugin; typedef int (t_plugin_handler_func) (t_weechat_plugin *, char *, char *, char *, char *, void *); /* handlers */ typedef enum t_handler_type t_handler_type; enum t_handler_type { HANDLER_MESSAGE, HANDLER_COMMAND }; typedef struct t_plugin_handler t_plugin_handler; struct t_plugin_handler { t_handler_type type; /* handler type */ /* data for message handler */ char *irc_command; /* name of IRC command (PRIVMSG, ..) */ /* data for command handler */ char *command; /* name of command (without first '/') */ char *description; /* (for /help) short cmd description */ char *arguments; /* (for /help) command arguments */ char *arguments_description; /* (for /help) args long description */ char *completion_template; /* template for completion */ /* data common to all handlers */ t_plugin_handler_func *handler; /* pointer to handler */ char *handler_args; /* arguments sent to handler */ void *handler_pointer; /* pointer sent to handler */ /* for internal use */ int running; /* 1 if currently running */ /* (used to prevent circular call) */ t_plugin_handler *prev_handler; /* link to previous handler */ t_plugin_handler *next_handler; /* link to next handler */ }; /* plugin, a WeeChat plugin, which is a dynamic library */ 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 */ /* plugin handlers */ t_plugin_handler *handlers; /* pointer to first handler */ t_plugin_handler *last_handler; /* pointer to last handler */ /* links to previous/next plugins */ t_weechat_plugin *prev_plugin; /* link to previous plugin */ t_weechat_plugin *next_plugin; /* link to next plugin */ /* plugin functions (interface) */ /* IMPORTANT NOTE for WeeChat developers: always add new interface functions at the END of functions, for keeping backward compatibility with existing plugins */ int (*ascii_strcasecmp) (t_weechat_plugin *, char *, char *); int (*ascii_strncasecmp) (t_weechat_plugin *, char *, char *, int); char **(*explode_string) (t_weechat_plugin *, char *, char *, int, int *); void (*free_exploded_string) (t_weechat_plugin *, char **); int (*mkdir_home) (t_weechat_plugin *, char *); void (*exec_on_files) (t_weechat_plugin *, char *, int (*)(t_weechat_plugin *, char *)); void (*printf) (t_weechat_plugin *, char *, char *, char *, ...); void (*printf_server) (t_weechat_plugin *, char *, ...); void (*infobar_printf) (t_weechat_plugin *, int, char *, ...); t_plugin_handler *(*msg_handler_add) (t_weechat_plugin *, char *, t_plugin_handler_func *, char *, void *); t_plugin_handler *(*cmd_handler_add) (t_weechat_plugin *, char *, char *, char *, char *, char *, t_plugin_handler_func *, char *, void *); void (*handler_remove) (t_weechat_plugin *, t_plugin_handler *); void (*handler_remove_all) (t_weechat_plugin *); void (*exec_command) (t_weechat_plugin *, char *, char *, char *); char *(*get_info) (t_weechat_plugin *, char *, char *); t_plugin_dcc_info *(*get_dcc_info) (t_weechat_plugin *); void (*free_dcc_info) (t_weechat_plugin *, t_plugin_dcc_info *); char *(*get_config) (t_weechat_plugin *, char *); int (*set_config) (t_weechat_plugin *, char *, char *); char *(*get_plugin_config) (t_weechat_plugin *, char *); int (*set_plugin_config) (t_weechat_plugin *, char *, char *); /* WeeChat developers: ALWAYS add new functions at the end */ }; /* general useful functions */ extern int weechat_ascii_strcasecmp (t_weechat_plugin *,char *, char *); extern int weechat_ascii_strncasecmp (t_weechat_plugin *,char *, char *, int); extern char **weechat_explode_string (t_weechat_plugin *, char *, char *, int, int *); extern void weechat_free_exploded_string (t_weechat_plugin *, char **); extern int weechat_plugin_mkdir_home (t_weechat_plugin *, char *); extern void weechat_plugin_exec_on_files (t_weechat_plugin *, char *, int (*)(t_weechat_plugin *, char *)); /* display functions */ extern void weechat_plugin_printf (t_weechat_plugin *, char *, char *, char *, ...); extern void weechat_plugin_printf_server (t_weechat_plugin *, char *, ...); extern void weechat_plugin_infobar_printf (t_weechat_plugin *, int, char *, ...); /* handler functions */ extern t_plugin_handler *weechat_plugin_msg_handler_add (t_weechat_plugin *, char *, t_plugin_handler_func *, char *, void *); extern t_plugin_handler *weechat_plugin_cmd_handler_add (t_weechat_plugin *, char *, char *, char *, char *, char *, t_plugin_handler_func *, char *, void *); extern void weechat_plugin_handler_remove (t_weechat_plugin *, t_plugin_handler *); extern void weechat_plugin_handler_remove_all (t_weechat_plugin *); /* other functions */ extern void weechat_plugin_exec_command (t_weechat_plugin *, char *, char *, char *); extern char *weechat_plugin_get_info (t_weechat_plugin *, char *, char *); extern t_plugin_dcc_info *weechat_plugin_get_dcc_info (t_weechat_plugin *); extern void weechat_plugin_free_dcc_info (t_weechat_plugin *, t_plugin_dcc_info *); extern char *weechat_plugin_get_config (t_weechat_plugin *, char *); extern int weechat_plugin_set_config (t_weechat_plugin *, char *, char *); extern char *weechat_plugin_get_plugin_config (t_weechat_plugin *, char *); extern int weechat_plugin_set_plugin_config (t_weechat_plugin *, char *, char *); #endif /* weechat-plugin.h */