klish/klish/ksym.h

/** @file ksym.h
 *
 * @brief Klish symbol
 */

#ifndef _klish_ksym_h
#define _klish_ksym_h

#include <klish/kcontext_base.h>

typedef struct ksym_s ksym_t;

// Callback function prototype
typedef int (*ksym_fn)(kcontext_t *context);

// Aliases for permanent flag
#define KSYM_USERDEFINED_PERMANENT TRI_UNDEFINED
#define KSYM_NONPERMANENT TRI_FALSE
#define KSYM_PERMANENT TRI_TRUE

// Aliases for sync flag
#define KSYM_USERDEFINED_SYNC TRI_UNDEFINED
#define KSYM_UNSYNC TRI_FALSE
#define KSYM_SYNC TRI_TRUE

// Aliases for silent flag
#define KSYM_SILENT BOOL_TRUE
#define KSYM_NONSILENT BOOL_FALSE


C_DECL_BEGIN

// ksym_t
ksym_t *ksym_new_ext(const char *name, ksym_fn function,
	tri_t permanent, tri_t sync, bool_t silent);
void ksym_free(ksym_t *sym);


// Typical sym definition for external plugins.
static inline ksym_t *ksym_new(const char *name, ksym_fn function)
{
	return ksym_new_ext(name, function, KSYM_USERDEFINED_PERMANENT,
		KSYM_USERDEFINED_SYNC, KSYM_NONSILENT);
}


// Typical definition for internal syms like PTYPE checkers, simple completion
// and help functions that can write to text buffer but not to stdout.
static inline ksym_t *ksym_new_fast(const char *name, ksym_fn function)
{
	return ksym_new_ext(name, function, KSYM_USERDEFINED_PERMANENT,
		KSYM_SYNC, KSYM_SILENT);
}


const char *ksym_name(const ksym_t *sym);

ksym_fn ksym_function(const ksym_t *sym);
bool_t ksym_set_function(ksym_t *sym, ksym_fn fn);

tri_t ksym_permanent(const ksym_t *sym);
bool_t ksym_set_permanent(ksym_t *sym, tri_t permanent);

tri_t ksym_sync(const ksym_t *sym);
bool_t ksym_set_sync(ksym_t *sym, tri_t sync);

bool_t ksym_silent(const ksym_t *sym);
bool_t ksym_set_silent(ksym_t *sym, bool_t silent);

C_DECL_END

#endif // _klish_ksym_h