klish/klish/kparam.h

/** @file kparam.h
 *
 * @brief Klish scheme's "param" entry
 */

#ifndef _klish_kparam_h
#define _klish_kparam_h

#include <faux/list.h>
#include <klish/kptype.h>

typedef struct kparam_s kparam_t;

typedef faux_list_node_t kparam_params_node_t;

typedef enum {
	KPARAM_NONE, // Illegal
	KPARAM_COMMON, // Common parameter
	KPARAM_SUBCOMMAND, // The value of this parameter is its name
	KPARAM_SWITCH, // User can choose one of nested parameters
	KPARAM_MULTI, // Nested parameters can be used several times
} kparam_mode_e;


C_DECL_BEGIN

kparam_t *kparam_new(const char *name);
void kparam_free(kparam_t *param);

const char *kparam_name(const kparam_t *param);
const char *kparam_help(const kparam_t *param);
bool_t kparam_set_help(kparam_t *param, const char *help);
const char *kparam_ptype_ref(const kparam_t *param);
bool_t kparam_set_ptype_ref(kparam_t *param, const char *ptype_ref);
kptype_t *kparam_ptype(const kparam_t *param);
bool_t kparam_set_ptype(kparam_t *param, kptype_t *ptype);
kparam_mode_e kparam_mode(const kparam_t *param);
bool_t kparam_set_mode(kparam_t *param, kparam_mode_e mode);

// PARAMs
faux_list_t *kparam_params(const kparam_t *param);
bool_t kparam_add_params(kparam_t *param, kparam_t *nested_param);
kparam_t *kparam_find_param(const kparam_t *param, const char *name);
ssize_t kparam_params_len(const kparam_t *param);
kparam_params_node_t *kparam_params_iter(const kparam_t *param);
kparam_t *kparam_params_each(kparam_params_node_t **iter);

C_DECL_END

#endif // _klish_kparam_h