a mechanism for registering and controlling display of commands More...

#include <stdlib.h>
#include <stddef.h>
#include <stdint.h>
#include "obj.h"

Classes
struct	co_cmd_t
	a struct containing all the relevant information for a specific command More...

Macros
#define	CMD(N) static int cmd_##N(co_obj_t self, co_obj_t output, co_obj_t params)

#define	CMD_REGISTER(N, U, D) co_cmd_register(#N, sizeof(#N), U, sizeof(U), D, sizeof(D), cmd_##N )

#define	CMD_OUTPUT(K, V) if(output == NULL) output = co_tree16_create(); co_tree_insert(*output, K, sizeof(K), V)

#define	HOOK(N) static int hook_##N##(co_obj_t self, co_obj_t output, co_obj_t params)

#define	HOOK_REGISTER(N, C) co_cmd_hook_str(N, sizeof(N), hook_##N)

Typedefs
typedef struct co_cmd_t	co_cmd_t

Functions
void	co_cmds_shutdown (void)

int	co_cmds_init (const size_t index_size)

struct co_cmd_t	__attribute__ ((packed))

int	co_cmd_register (const char name, const size_t nlen, const char usage, const size_t ulen, const char *desc, const size_t dlen, co_cb_t handler)

int	co_cmd_exec (co_obj_t key, co_obj_t output, co_obj_t param)
	executes a command by running the function linked to in the command struct More...

co_obj_t *	co_cmd_usage (co_obj_t *key)
	returns command usage format More...

co_obj_t *	co_cmd_desc (co_obj_t *key)
	returns command description (what the command does) More...

int	co_cmd_hook (const co_obj_t key, co_obj_t cb)
	hooks callback function into a command More...

int	co_cmd_hook_str (const char key, const size_t klen, co_obj_t cb)
	hooks callback function into a command More...

int	co_cmd_process (co_iter_t iter, void *context)
	process all registered commands with given iterator More...

Variables
co_obj_t	_header

uint8_t	_exttype

uint8_t	_len

co_cb_t	exec

co_obj_t *	name

co_obj_t *	usage

co_obj_t *	desc

co_obj_t *	hooks

Detailed Description

a mechanism for registering and controlling display of commands

Author: Josh King (jheretic), jking.nosp@m.@cha.nosp@m.mbana.nosp@m..net

Function Documentation

co_obj_t* co_cmd_desc ( co_obj_t * key )

returns command description (what the command does)

Parameters

key	the name of the command

References co_tree_find(), and co_cmd_t::desc.

 {
   char *kstr = NULL;
   size_t klen = co_obj_data(&kstr, key);
   co_cmd_t *cmd = (co_cmd_t *)co_tree_find(_cmds, kstr, klen - 1);
   
   CHECK((cmd != NULL), "No such command!");
   return cmd->desc;
 error:
   return NULL;
 }

int co_cmd_exec	(	co_obj_t *	key,
		co_obj_t **	output,
		co_obj_t *	param
	)

executes a command by running the function linked to in the command struct

Parameters

key	the name of the command
output	return object of command

References co_tree_find(), and co_cmd_t::exec.

Referenced by dispatcher_cb().

 {
   char *kstr = NULL;
   size_t klen = co_obj_data(&kstr, key);
   co_cmd_t *cmd = (co_cmd_t *)co_tree_find(_cmds, kstr, klen - 1);
   
   CHECK((cmd != NULL), "No such command!");
   return cmd->exec((co_obj_t *)cmd, output, param);
 error:
   return 0;
 }

int co_cmd_hook	(	const co_obj_t *	key,
		co_obj_t *	cb
	)

hooks callback function into a command

Parameters

key	the name of the command
cb	reference to callback function

References co_list_append(), and co_tree_find().

 {
   char *kstr = NULL;
   size_t klen = co_obj_data(&kstr, key);
   co_cmd_t *cmd = (co_cmd_t *)co_tree_find(_cmds, kstr, klen);
 
   CHECK((cmd != NULL), "No such command!");
   if(cmd->hooks == NULL)
   {
     cmd->hooks = co_tree16_create();
   }
   CHECK(co_list_append(cmd->hooks, cb), "Failed to add hook to command.");
   return 1;
 error:
   return 0;
 }

int co_cmd_hook_str	(	const char *	key,
		const size_t	klen,
		co_obj_t *	cb
	)

hooks callback function into a command

Parameters

key	the name of the command
klen	length of key string
cb	reference to callback function

References co_list_append(), and co_tree_find().

 {
   co_cmd_t *cmd = (co_cmd_t *)co_tree_find(_cmds, key, klen);
 
   CHECK((cmd != NULL), "No such command!");
   if(cmd->hooks == NULL)
   {
     cmd->hooks = co_tree16_create();
   }
   CHECK(co_list_append(cmd->hooks, cb), "Failed to add hook to command.");
   return 1;
 error:
   return 0;
 }

int co_cmd_process	(	co_iter_t	iter,
		void *	context
	)

process all registered commands with given iterator

Parameters

iter	iterator function reference
context	other parameters passed to iterator

References co_tree_process().

 {
   CHECK(co_tree_process(_cmds, iter, context), "Failed to process commands.");
   return 1;
 error:
   return 0;
 }

co_obj_t* co_cmd_usage ( co_obj_t * key )

returns command usage format

Parameters

key	command name

References co_tree_find(), and co_cmd_t::usage.

 {
   char *kstr = NULL;
   size_t klen = co_obj_data(&kstr, key);
   co_cmd_t *cmd = (co_cmd_t *)co_tree_find(_cmds, kstr, klen - 1);
   
   CHECK((cmd != NULL), "No such command!");
   return cmd->usage;
 error:
   return NULL;
 }