klish/clish/nspace.h

/*
 * nspace.h
 */
/**
\ingroup clish
\defgroup clish_nspace nspace
@{

\brief This class represents an instance of a namespace type.

Namespace instances are assocated with a view to make view's commands available
within current view.

*/
#ifndef _clish_nspace_h
#define _clish_nspace_h

typedef struct clish_nspace_s clish_nspace_t;

typedef enum {
	CLISH_NSPACE_NONE,
	CLISH_NSPACE_HELP,
	CLISH_NSPACE_COMPLETION,
	CLISH_NSPACE_CHELP
} clish_nspace_visibility_t;

typedef enum {
	CLISH_RESTORE_NONE,
	CLISH_RESTORE_DEPTH,
	CLISH_RESTORE_VIEW
} clish_nspace_restore_t;

#include "clish/view.h"

/*=====================================
 * NSPACE INTERFACE
 *===================================== */
/*-----------------
 * meta functions
 *----------------- */
clish_nspace_t *clish_nspace_new(clish_view_t * view);
/*-----------------
 * methods
 *----------------- */
void clish_nspace_delete(clish_nspace_t * instance);
const clish_command_t *clish_nspace_find_next_completion(clish_nspace_t *
	instance, const char *iter_cmd, const char *line,
	clish_nspace_visibility_t field);
clish_command_t *clish_nspace_find_command(clish_nspace_t * instance, const char *name);
void clish_nspace_dump(const clish_nspace_t * instance);
/*-----------------
 * attributes
 *----------------- */
const char *clish_nspace__get_prefix(const clish_nspace_t * instance);
bool_t clish_nspace__get_help(const clish_nspace_t * instance);
bool_t clish_nspace__get_completion(const clish_nspace_t * instance);
bool_t clish_nspace__get_context_help(const clish_nspace_t * instance);
bool_t clish_nspace__get_inherit(const clish_nspace_t * instance);
bool_t
clish_nspace__get_visibility(const clish_nspace_t * instance,
			     clish_nspace_visibility_t field);
clish_view_t *clish_nspace__get_view(const clish_nspace_t * instance);
void clish_nspace__set_prefix(clish_nspace_t * instance, const char *prefix);
void clish_nspace__set_help(clish_nspace_t * instance, bool_t help);
void clish_nspace__set_completion(clish_nspace_t * instance, bool_t help);
void clish_nspace__set_context_help(clish_nspace_t * instance, bool_t help);
void clish_nspace__set_inherit(clish_nspace_t * instance, bool_t inherit);
void clish_nspace__set_restore(clish_nspace_t * instance,
	clish_nspace_restore_t restore);
clish_nspace_restore_t clish_nspace__get_restore(const clish_nspace_t * instance);

#endif				/* _clish_nspace_h */
/** @} clish_nspace */