Mercurial > dovecot > core-2.2
view src/doveadm/doveadm-cmd.h @ 19824:533b0cebf685
doveadm: Minor code cleanup - rename doveadm_cmd_find*() to doveadm_cmd_find_with_args*()
author | Timo Sirainen <timo.sirainen@dovecot.fi> |
---|---|
date | Mon, 22 Feb 2016 21:28:24 +0200 |
parents | 4247beae5c8d |
children | 4d0c03e449e2 |
line wrap: on
line source
#ifndef DOVEADM_CMD_H #define DOVEADM_CMD_H #define DOVEADM_CMD_PARAMS_START .parameters = (const struct doveadm_cmd_param[]){ #define DOVEADM_CMD_PARAM(optP, nameP, typeP, flagP ) { .short_opt = optP, .name = nameP, .type = typeP, .flags = flagP }, #define DOVEADM_CMD_PARAMS_END { .short_opt = '\0', .name = NULL, .type = CMD_PARAM_BOOL, .flags = CMD_PARAM_FLAG_NONE } } struct doveadm_cmd_ver2; struct doveadm_mail_cmd_context; typedef void doveadm_command_t(int argc, char *argv[]); typedef enum { CMD_PARAM_BOOL = 0, /* value will contain 1 (not pointer) */ CMD_PARAM_INT64, /* ditto but contains number (not pointer) */ CMD_PARAM_STR, /* value contains const char* */ CMD_PARAM_ARRAY, /* value contains const char*[] */ CMD_PARAM_ISTREAM /* value contains struct istream* */ } doveadm_cmd_param_t; typedef enum { CMD_PARAM_FLAG_NONE = 0x0, CMD_PARAM_FLAG_POSITIONAL = 0x1, CMD_PARAM_FLAG_DO_NOT_EXPOSE = 0x2, } doveadm_cmd_param_flag_t; struct doveadm_cmd_param { char short_opt; const char *name; doveadm_cmd_param_t type; bool value_set; struct { bool v_bool; int64_t v_int64; const char* v_string; ARRAY_TYPE(const_string) v_array; struct istream* v_istream; } value; doveadm_cmd_param_flag_t flags; }; ARRAY_DEFINE_TYPE(doveadm_cmd_param_arr_t, struct doveadm_cmd_param); typedef int doveadm_command_ver2_t(const struct doveadm_cmd_ver2* cmd, int argc, const struct doveadm_cmd_param[]); struct doveadm_cmd { doveadm_command_t *cmd; const char *name; const char *short_usage; }; struct doveadm_cmd_ver2 { doveadm_command_ver2_t *cmd; doveadm_command_t *old_cmd; struct doveadm_mail_cmd_context *(*mail_cmd)(void); const char *name; const char *usage; const struct doveadm_cmd_param *parameters; }; ARRAY_DEFINE_TYPE(doveadm_cmd, struct doveadm_cmd); extern ARRAY_TYPE(doveadm_cmd) doveadm_cmds; ARRAY_DEFINE_TYPE(doveadm_cmd_ver2, struct doveadm_cmd_ver2); extern ARRAY_TYPE(doveadm_cmd_ver2) doveadm_cmds_ver2; extern struct doveadm_cmd doveadm_cmd_dump; extern struct doveadm_cmd doveadm_cmd_pw; extern struct doveadm_cmd doveadm_cmd_who; extern struct doveadm_cmd doveadm_cmd_penalty; extern struct doveadm_cmd doveadm_cmd_kick; extern struct doveadm_cmd doveadm_cmd_mailbox_mutf7; extern struct doveadm_cmd doveadm_cmd_sis_deduplicate; extern struct doveadm_cmd doveadm_cmd_sis_find; extern struct doveadm_cmd doveadm_cmd_zlibconnect; void doveadm_register_cmd(const struct doveadm_cmd *cmd); const struct doveadm_cmd * doveadm_cmd_find_with_args(const char *cmd_name, int *argc, char **argv[]); void doveadm_register_auth_commands(void); void doveadm_register_director_commands(void); void doveadm_register_proxy_commands(void); void doveadm_register_log_commands(void); void doveadm_register_instance_commands(void); void doveadm_register_mount_commands(void); void doveadm_register_replicator_commands(void); void doveadm_register_dict_commands(void); void doveadm_register_fs_commands(void); void doveadm_cmds_init(void); void doveadm_cmds_deinit(void); int doveadm_cmd_ver2_to_cmd_wrapper(const struct doveadm_cmd_ver2* cmd, int argc, const struct doveadm_cmd_param[]); int doveadm_cmd_ver2_to_mail_cmd_wrapper(const struct doveadm_cmd_ver2* cmd, int argc, const struct doveadm_cmd_param argv[]); void doveadm_cmd_register_ver2(struct doveadm_cmd_ver2 *cmd); const struct doveadm_cmd_ver2 * doveadm_cmd_find_with_args_ver2(const char *cmd_name, int argc, const char *argv[]); /* Returns FALSE if cmd_name doesn't exist, TRUE if it exists. */ bool doveadm_cmd_try_run_ver2(const char *cmd_name, int argc, const char *argv[]); /* Returns 0 if success, -1 if parameters were invalid. */ int doveadm_cmd_run_ver2(const struct doveadm_cmd_ver2 *cmd, int argc, const char *argv[]); bool doveadm_cmd_param_bool(int argc, const struct doveadm_cmd_param* params, const char *name, bool* value); bool doveadm_cmd_param_int64(int argc, const struct doveadm_cmd_param* params, const char *name, int64_t* value); bool doveadm_cmd_param_str(int argc, const struct doveadm_cmd_param* params, const char *name, const char** value); bool doveadm_cmd_param_array(int argc, struct doveadm_cmd_param* params, const char *name, ARRAY_TYPE(const_string)** value); bool doveadm_cmd_param_istream(int argc, struct doveadm_cmd_param* params, const char *name, struct istream** value); extern struct doveadm_cmd_ver2 doveadm_cmd_stop_ver2; extern struct doveadm_cmd_ver2 doveadm_cmd_reload_ver2; extern struct doveadm_cmd_ver2 doveadm_cmd_stats_reset_ver2; extern struct doveadm_cmd_ver2 doveadm_cmd_stats_dump_ver2; extern struct doveadm_cmd_ver2 doveadm_cmd_stats_top_ver2; #endif