/*
 * SPDX-FileCopyrightText: 2003-2026 Sébastien Helleu <flashcode@flashtux.org>
 * SPDX-FileCopyrightText: 2005-2006 Emmanuel Bouthenot <kolter@openics.org>
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 */

#ifndef WEECHAT_COMMAND_H
#define WEECHAT_COMMAND_H

struct t_gui_buffer;

#define COMMAND_CALLBACK(__command)                                     \
    int                                                                 \
    command_##__command (const void *pointer, void *data,               \
                         struct t_gui_buffer *buffer,                   \
                         int argc, char **argv, char **argv_eol)

/*
 * This macro is used to create an "empty" command in WeeChat core:
 * command does nothing, but plugins or scripts can catch it when it
 * is used by user, with weechat_hook_command_run("/xxx", ...)
 * where "xxx" is command name.
 */
#define COMMAND_EMPTY(__command)                                        \
    int                                                                 \
    command_##__command (const void *pointer, void *data,               \
                         struct t_gui_buffer *buffer,                   \
                         int argc, char **argv, char **argv_eol)        \
    {                                                                   \
        (void) pointer;                                                 \
        (void) data;                                                    \
        (void) buffer;                                                  \
        (void) argc;                                                    \
        (void) argv;                                                    \
        (void) argv_eol;                                                \
        return WEECHAT_RC_OK;                                           \
    }

/*
 * Macro to return error in case of missing arguments in callback of
 * hook_command.
 */
#define COMMAND_MIN_ARGS(__min_args, __option)                          \
    if (argc < __min_args)                                              \
    {                                                                   \
        gui_chat_printf_date_tags (                                     \
            NULL, 0, GUI_FILTER_TAG_NO_FILTER,                          \
            _("%sToo few arguments for command \"%s%s%s\" "             \
              "(help on command: /help %s)"),                           \
            gui_chat_prefix[GUI_CHAT_PREFIX_ERROR],                     \
            argv[0],                                                    \
            (__option && __option[0]) ? " " : "",                       \
            (__option && __option[0]) ? __option : "",                  \
            utf8_next_char (argv[0]));                                  \
        return WEECHAT_RC_ERROR;                                        \
    }

/* Macro to return error in callback of hook_command. */
#define COMMAND_ERROR                                                   \
    {                                                                   \
        gui_chat_printf_date_tags (                                     \
            NULL, 0, GUI_FILTER_TAG_NO_FILTER,                          \
            _("%sError with command \"%s\" "                            \
              "(help on command: /help %s)"),                           \
            gui_chat_prefix[GUI_CHAT_PREFIX_ERROR],                     \
            argv_eol[0],                                                \
            utf8_next_char (argv[0]));                                  \
        return WEECHAT_RC_ERROR;                                        \
    }

#define CMD_ARGS_DESC(args...)                                          \
    STR_CONCAT("\n", WEECHAT_HOOK_COMMAND_STR_FORMATTED, ##args)

#define COMMAND_KEEP_SPACES hook_set (ptr_hook, "keep_spaces_right", "1")

struct t_command_repeat
{
    char *buffer_name;                 /* full buffer name                  */
    char *command;                     /* cmd to exec (or text for buffer)  */
    char *commands_allowed;            /* commands currently allowed        */
    int count;                         /* number of times the cmd is exec.  */
    int index;                         /* current index (starts at 1)       */
};

extern const char *command_help_option_color_values (void);
extern void command_version_display (struct t_gui_buffer *buffer,
                                     int send_to_buffer_as_input,
                                     int translated_string,
                                     int display_git_version,
                                     int display_upgrades);
extern void command_init (void);
extern void command_startup (int plugins_loaded);

#endif /* WEECHAT_COMMAND_H */
