path: root/src/plugins/scripts/script-api.h

/*
 * Copyright (C) 2003-2011 Sebastien Helleu <flashcode@flashtux.org>
 *
 * This file is part of WeeChat, the extensible chat client.
 *
 * WeeChat 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.
 *
 * WeeChat 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 WeeChat.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef __WEECHAT_SCRIPT_API_H
#define __WEECHAT_SCRIPT_API_H 1

extern void script_api_charset_set (struct t_plugin_script *script,
                                    const char *charset);
extern struct t_config_file *script_api_config_new (struct t_weechat_plugin *weechat_plugin,
                                                    struct t_plugin_script *script,
                                                    const char *name,
                                                    int (*callback_reload)(void *data,
                                                                           struct t_config_file *config_file),
                                                    const char *function,
                                                    const char *data);
extern struct t_config_section *script_api_config_new_section (struct t_weechat_plugin *weechat_plugin,
                                                               struct t_plugin_script *script,
                                                               struct t_config_file *config_file,
                                                               const char *name,
                                                               int user_can_add_options,
                                                               int user_can_delete_options,
                                                               int (*callback_read)(void *data,
                                                                                    struct t_config_file *config_file,
                                                                                    struct t_config_section *section,
                                                                                    const char *option_name,
                                                                                    const char *value),
                                                               const char *function_read,
                                                               const char *data_read,
                                                               int (*callback_write)(void *data,
                                                                                      struct t_config_file *config_file,
                                                                                      const char *section_name),
                                                               const char *function_write,
                                                               const char *data_write,
                                                               int (*callback_write_default)(void *data,
                                                                                              struct t_config_file *config_file,
                                                                                              const char *section_name),
                                                               const char *function_write_default,
                                                               const char *data_write_default,
                                                               int (*callback_create_option)(void *data,
                                                                                             struct t_config_file *config_file,
                                                                                             struct t_config_section *section,
                                                                                             const char *option_name,
                                                                                             const char *value),
                                                               const char *function_create_option,
                                                               const char *data_create_option,
                                                               int (*callback_delete_option)(void *data,
                                                                                             struct t_config_file *config_file,
                                                                                             struct t_config_section *section,
                                                                                             struct t_config_option *option),
                                                               const char *function_delete_option,
                                                               const char *data_delete_option);
extern struct t_config_option *script_api_config_new_option (struct t_weechat_plugin *weechat_plugin,
                                                             struct t_plugin_script *script,
                                                             struct t_config_file *config_file,
                                                             struct t_config_section *section,
                                                             const char *name,
                                                             const char *type,
                                                             const char *description,
                                                             const char *string_values,
                                                             int min, int max,
                                                             const char *default_value,
                                                             const char *value,
                                                             int null_value_allowed,
                                                             int (*callback_check_value)(void *data,
                                                                                         struct t_config_option *option,
                                                                                         const char *value),
                                                             const char *function_check_value,
                                                             const char *data_check_value,
                                                             void (*callback_change)(void *data,
                                                                                     struct t_config_option *option),
                                                             const char *function_change,
                                                             const char *data_change,
                                                             void (*callback_delete)(void *data,
                                                                                     struct t_config_option *option),
                                                             const char *function_delete,
                                                             const char *data_delete);
extern void script_api_config_option_free (struct t_weechat_plugin *weechat_plugin,
                                           struct t_plugin_script *script,
                                           struct t_config_option *option);
extern void script_api_config_section_free_options (struct t_weechat_plugin *weechat_plugin,
                                                    struct t_plugin_script *script,
                                                    struct t_config_section *section);
extern void script_api_config_section_free (struct t_weechat_plugin *weechat_plugin,
                                            struct t_plugin_script *script,
                                            struct t_config_section *section);
extern void script_api_config_free (struct t_weechat_plugin *weechat_plugin,
                                    struct t_plugin_script *script,
                                    struct t_config_file *config_file);
extern void script_api_printf (struct t_weechat_plugin *weechat_plugin,
                               struct t_plugin_script *script,
                               struct t_gui_buffer *buffer,
                               const char *format, ...);
extern void script_api_printf_date_tags (struct t_weechat_plugin *weechat_plugin,
                                         struct t_plugin_script *script,
                                         struct t_gui_buffer *buffer,
                                         time_t date, const char *tags,
                                         const char *format, ...);
extern void script_api_printf_y (struct t_weechat_plugin *weechat_plugin,
                                 struct t_plugin_script *script,
                                 struct t_gui_buffer *buffer,
                                 int y, const char *format, ...);
extern void script_api_log_printf (struct t_weechat_plugin *weechat_plugin,
                                   struct t_plugin_script *script,
                                   const char *format, ...);
extern struct t_hook *script_api_hook_command (struct t_weechat_plugin *weechat_plugin,
                                               struct t_plugin_script *script,
                                               const char *command, const char *description,
                                               const char *args, const char *args_description,
                                               const char *completion,
                                               int (*callback)(void *data,
                                                               struct t_gui_buffer *buffer,
                                                               int argc, char **argv,
                                                               char **argv_eol),
                                               const char *function,
                                               const char *data);
extern struct t_hook *script_api_hook_command_run (struct t_weechat_plugin *weechat_plugin,
                                                   struct t_plugin_script *script,
                                                   const char *command,
                                                   int (*callback)(void *data,
                                                                   struct t_gui_buffer *buffer,
                                                                   const char *command),
                                                   const char *function,
                                                   const char *data);
extern struct t_hook *script_api_hook_timer (struct t_weechat_plugin *weechat_plugin,
                                             struct t_plugin_script *script,
                                             int interval, int align_second,
                                             int max_calls,
                                             int (*callback)(void *data,
                                                             int remaining_calls),
                                             const char *function,
                                             const char *data);
extern struct t_hook *script_api_hook_fd (struct t_weechat_plugin *weechat_plugin,
                                          struct t_plugin_script *script,
                                          int fd, int flag_read,
                                          int flag_write, int flag_exception,
                                          int (*callback)(void *data, int fd),
                                          const char *function,
                                          const char *data);
extern struct t_hook *script_api_hook_process (struct t_weechat_plugin *weechat_plugin,
                                               struct t_plugin_script *script,
                                               const char *command,
                                               int timeout,
                                               int (*callback)(void *data,
                                                               const char *command,
                                                               int return_code,
                                                               const char *out,
                                                               const char *err),
                                               const char *function,
                                               const char *data);
extern struct t_hook *script_api_hook_connect (struct t_weechat_plugin *weechat_plugin,
                                               struct t_plugin_script *script,
                                               const char *proxy,
                                               const char *address,
                                               int port,
                                               int sock,
                                               int ipv6,
                                               void *gnutls_sess, void *gnutls_cb,
                                               int gnutls_dhkey_size,
                                               const char *local_hostname,
                                               int (*callback)(void *data,
                                                               int status,
                                                               int gnutls_rc,
                                                               const char *error,
                                                               const char *ip_address),
                                               const char *function,
                                               const char *data);
extern struct t_hook *script_api_hook_print (struct t_weechat_plugin *weechat_plugin,
                                             struct t_plugin_script *script,
                                             struct t_gui_buffer *buffer,
                                             const char *tags,
                                             const char *message,
                                             int strip_colors,
                                             int (*callback)(void *data,
                                                             struct t_gui_buffer *buffer,
                                                             time_t date,
                                                             int tags_count,
                                                             const char **tags,
                                                             int displayed,
                                                             int highlight,
                                                             const char *prefix,
                                                             const char *message),
                                             const char *function,
                                             const char *data);
extern struct t_hook *script_api_hook_signal (struct t_weechat_plugin *weechat_plugin,
                                              struct t_plugin_script *script,
                                              const char *signal,
                                              int (*callback)(void *data,
                                                              const char *signal,
                                                              const char *type_data,
                                                              void *signal_data),
                                              const char *function,
                                              const char *data);
extern struct t_hook *script_api_hook_hsignal (struct t_weechat_plugin *weechat_plugin,
                                               struct t_plugin_script *script,
                                               const char *signal,
                                               int (*callback)(void *data,
                                                               const char *signal,
                                                               struct t_hashtable *hashtable),
                                               const char *function,
                                               const char *data);
extern struct t_hook *script_api_hook_config (struct t_weechat_plugin *weechat_plugin,
                                              struct t_plugin_script *script,
                                              const char *option,
                                              int (*callback)(void *data,
                                                              const char *option,
                                                              const char *value),
                                              const char *function,
                                              const char *data);
extern struct t_hook *script_api_hook_completion (struct t_weechat_plugin *weechat_plugin,
                                                  struct t_plugin_script *script,
                                                  const char *completion,
                                                  const char *description,
                                                  int (*callback)(void *data,
                                                                  const char *completion_item,
                                                                  struct t_gui_buffer *buffer,
                                                                  struct t_gui_completion *completion),
                                                  const char *function,
                                                  const char *data);
extern struct t_hook *script_api_hook_modifier (struct t_weechat_plugin *weechat_plugin,
                                                struct t_plugin_script *script,
                                                const char *modifier,
                                                char *(*callback)(void *data,
                                                                  const char *modifier,
                                                                  const char *modifier_data,
                                                                  const char *string),
                                                const char *function,
                                                const char *data);
extern struct t_hook *script_api_hook_info (struct t_weechat_plugin *weechat_plugin,
                                            struct t_plugin_script *script,
                                            const char *info_name,
                                            const char *description,
                                            const char *args_description,
                                            const char *(*callback)(void *data,
                                                                    const char *info_name,
                                                                    const char *arguments),
                                            const char *function,
                                            const char *data);
extern struct t_hook *script_api_hook_info_hashtable (struct t_weechat_plugin *weechat_plugin,
                                                      struct t_plugin_script *script,
                                                      const char *info_name,
                                                      const char *description,
                                                      const char *args_description,
                                                      const char *output_description,
                                                      struct t_hashtable *(*callback)(void *data,
                                                                                      const char *info_name,
                                                                                      struct t_hashtable *hashtable),
                                                      const char *function,
                                                      const char *data);
extern struct t_hook *script_api_hook_infolist (struct t_weechat_plugin *weechat_plugin,
                                                struct t_plugin_script *script,
                                                const char *infolist_name,
                                                const char *description,
                                                const char *pointer_description,
                                                const char *args_description,
                                                struct t_infolist *(*callback)(void *data,
                                                                               const char *infolist_name,
                                                                               void *pointer,
                                                                               const char *arguments),
                                                const char *function,
                                                const char *data);
extern void script_api_unhook (struct t_weechat_plugin *weechat_plugin,
                               struct t_plugin_script *script,
                               struct t_hook *hook);
extern void script_api_unhook_all (struct t_plugin_script *script);
extern struct t_gui_buffer *script_api_buffer_new (struct t_weechat_plugin *weechat_plugin,
                                                   struct t_plugin_script *script,
                                                   const char *name,
                                                   int (*input_callback)(void *data,
                                                                         struct t_gui_buffer *buffer,
                                                                         const char *input_data),
                                                   const char *function_input,
                                                   const char *data_input,
                                                   int (*close_callback)(void *data,
                                                                         struct t_gui_buffer *buffer),
                                                   const char *function_close,
                                                   const char *data_close);
extern void script_api_buffer_close (struct t_weechat_plugin *weechat_plugin,
                                     struct t_plugin_script *script,
                                     struct t_gui_buffer *buffer);
extern struct t_gui_bar_item *script_api_bar_item_new (struct t_weechat_plugin *weechat_plugin,
                                                       struct t_plugin_script *script,
                                                       const char *name,
                                                       char *(*build_callback)(void *data,
                                                                               struct t_gui_bar_item *item,
                                                                               struct t_gui_window *window),
                                                       const char *function,
                                                       const char *data);
extern void script_api_bar_item_remove (struct t_weechat_plugin *weechat_plugin,
                                        struct t_plugin_script *script,
                                        struct t_gui_bar_item *item);
extern void script_api_command (struct t_weechat_plugin *weechat_plugin,
                                struct t_plugin_script *script,
                                struct t_gui_buffer *buffer,
                                const char *command);
extern const char *script_api_config_get_plugin (struct t_weechat_plugin *weechat_plugin,
                                                 struct t_plugin_script *script,
                                                 const char *option);
extern int script_api_config_is_set_plugin (struct t_weechat_plugin *weechat_plugin,
                                            struct t_plugin_script *script,
                                            const char *option);
extern int script_api_config_set_plugin (struct t_weechat_plugin *weechat_plugin,
                                         struct t_plugin_script *script,
                                         const char *option, const char *value);
extern void script_api_config_set_desc_plugin (struct t_weechat_plugin *weechat_plugin,
                                               struct t_plugin_script *script,
                                               const char *option,
                                               const char *description);
extern int script_api_config_unset_plugin (struct t_weechat_plugin *weechat_plugin,
                                           struct t_plugin_script *script,
                                           const char *option);
extern int script_api_upgrade_read (struct t_weechat_plugin *weechat_plugin,
                                    struct t_plugin_script *script,
                                    struct t_upgrade_file *upgrade_file,
                                    int (*callback_read)(void *data,
                                                         struct t_upgrade_file *upgrade_file,
                                                         int object_id,
                                                         struct t_infolist *infolist),
                                    const char *function,
                                    const char *data);

#endif /* __WEECHAT_SCRIPT_API_H */