--- libaitcli/inc/aitcli.h 2013/05/30 09:16:42 1.6 +++ libaitcli/inc/aitcli.h 2013/08/12 09:50:28 1.7 @@ -3,7 +3,7 @@ * by Michael Pounov * * $Author: misho $ -* $Id: aitcli.h,v 1.6 2013/05/30 09:16:42 misho Exp $ +* $Id: aitcli.h,v 1.7 2013/08/12 09:50:28 misho Exp $ * ************************************************************************** The ELWIX and AITNET software is distributed under the following @@ -195,7 +195,7 @@ typedef TAILQ_HEAD(tqHistoryHead, tagHistory) history_ /* Bind keys structure types */ -typedef int (*bindkey_func_t)(int idx, /*linebuffer_t **/ void * __restrict buffer); +typedef int (*bindkey_func_t)(int idx, /* linebuffer_t * */ void * __restrict cli_buffer); typedef struct { int key_len; unsigned char key_ch[8]; @@ -205,7 +205,8 @@ typedef struct { /* Commands structure for CLI */ -typedef int (*cmd_func_t)(/*linebuffer_t **/ void * __restrict buffer, int idx, char ** __restrict args); +typedef int (*cmd_func_t)(/*linebuffer_t **/ void * __restrict cli_buffer, int idx, + char ** __restrict args); struct tagCommand { int cmd_level; @@ -377,12 +378,12 @@ int cli_telnet_Answer(unsigned char *caps, int nCaps, /* * cli_Cmd_Unsupported() - Builtin helper function for unsupported commands * - * @buffer = CLI buffer + * @cli_buffer = CLI buffer * @idx = Selected command ID * @args = Parsed arguments array * return: RETCODE_OK ok */ -int cli_Cmd_Unsupported(void * __restrict buffer, int idx, char ** __restrict args); +int cli_Cmd_Unsupported(void * __restrict cli_buffer, int idx, char ** __restrict args); /* CLI Functions */ @@ -391,16 +392,16 @@ int cli_Cmd_Unsupported(void * __restrict buffer, int * cli_BindKey() - Bind function to key * * @key = key structure - * @buffer = CLI buffer + * @cli_buffer = CLI buffer * return: RETCODE_ERR error, RETCODE_OK ok, >0 bind at position */ -int cli_BindKey(bindkey_t * __restrict key, linebuffer_t * __restrict buffer); +int cli_BindKey(bindkey_t * __restrict key, linebuffer_t * __restrict cli_buffer); /* * cli_addCommand() - Add command to CLI session * - * @buffer = CLI buffer + * @cli_buffer = CLI buffer * @csCmd = Command name * @cliLevel = Level in CLI, -1 unprivi(view from all), 0 main config, 1 sub config ... * @funcCmd = Callback function when user call command @@ -409,22 +410,23 @@ int cli_BindKey(bindkey_t * __restrict key, linebuffer * return: RETCODE_ERR error, RETCODE_OK ok */ int -cli_addCommand(linebuffer_t * __restrict buffer, const char *csCmd, int cliLevel, cmd_func_t funcCmd, +cli_addCommand(linebuffer_t * __restrict cli_buffer, const char *csCmd, + int cliLevel, cmd_func_t funcCmd, const char *csInfo, const char *csHelp); /* * cli_delCommand() - Delete command from CLI session * - * @buffer = CLI buffer + * @cli_buffer = CLI buffer * @csCmd = Command name * @cliLevel = Level in CLI, -1 unprivi(view from all), 0 main config, 1 sub config ... * return: RETCODE_ERR error, RETCODE_OK ok */ int -cli_delCommand(linebuffer_t * __restrict buffer, const char *csCmd, int cliLevel); +cli_delCommand(linebuffer_t * __restrict cli_buffer, const char *csCmd, int cliLevel); /* * cli_updCommand() - Update command in CLI session * - * @buffer = CLI buffer + * @cli_buffer = CLI buffer * @csCmd = Command name * @cliLevel = Level in CLI, -1 unprivi(view from all), 0 main config, 1 sub config ... * @funcCmd = Callback function when user call command @@ -433,82 +435,83 @@ cli_delCommand(linebuffer_t * __restrict buffer, const * return: RETCODE_ERR error, RETCODE_OK ok */ int -cli_updCommand(linebuffer_t * __restrict buffer, const char *csCmd, int cliLevel, cmd_func_t funcCmd, +cli_updCommand(linebuffer_t * __restrict cli_buffer, const char *csCmd, + int cliLevel, cmd_func_t funcCmd, const char *csInfo, const char *csHelp); /* * cli_addHistory() - Add line to history * - * @buffer = CLI buffer + * @cli_buffer = CLI buffer * @str = Add custom text or if NULL use readed line from CLI buffer * return: RETCODE_ERR error, RETCODE_OK ok */ -int cli_addHistory(linebuffer_t * __restrict buffer, const char * __restrict str); +int cli_addHistory(linebuffer_t * __restrict cli_buffer, const char * __restrict str); /* * cli_saveHistory() - Save history to file * - * @buffer = CLI buffer + * @cli_buffer = CLI buffer * @histfile = History filename, if NULL will be use default name * @lines = Maximum history lines to save * return: RETCODE_ERR error, RETCODE_OK ok */ -int cli_saveHistory(linebuffer_t * __restrict buffer, const char *histfile, int lines); +int cli_saveHistory(linebuffer_t * __restrict cli_buffer, const char *histfile, int lines); /* * cli_loadHistory() - Load history from file * - * @buffer = CLI buffer + * @cli_buffer = CLI buffer * @histfile = History filename, if NULL will be use default name * return: RETCODE_ERR error, RETCODE_OK ok */ -int cli_loadHistory(linebuffer_t * __restrict buffer, const char *histfile); +int cli_loadHistory(linebuffer_t * __restrict cli_buffer, const char *histfile); /* * cli_resetHistory() - Reset history search in CLI session * - * @buffer = CLI buffer + * @cli_buffer = CLI buffer * return: none */ -void cli_resetHistory(linebuffer_t * __restrict buffer); +void cli_resetHistory(linebuffer_t * __restrict cli_buffer); /* * cli_freeLine() - Clear entire line * - * @buffer = CLI buffer + * @cli_buffer = CLI buffer * return: RETCODE_ERR error, RETCODE_OK ok */ -int cli_freeLine(linebuffer_t * __restrict buffer); +int cli_freeLine(linebuffer_t * __restrict cli_buffer); /* * cli_setPrompt() - Set new prompt for CLI session * - * @buffer = CLI buffer + * @cli_buffer = CLI buffer * @prompt = new text for prompt or if NULL disable prompt * return: none */ -void cli_setPrompt(linebuffer_t * __restrict buffer, const char *prompt); +void cli_setPrompt(linebuffer_t * __restrict cli_buffer, const char *prompt); /* * cli_Printf() - Send message to CLI session * - * @buffer = CLI buffer + * @cli_buffer = CLI buffer * @fmt = printf format string * @... = arguments defined in fmt * return: none */ -void cli_Printf(linebuffer_t * __restrict buffer, char *fmt, ...); +void cli_Printf(linebuffer_t * __restrict cli_buffer, char *fmt, ...); /* * cli_PrintHelp() - Print help screen * - * @buffer = CLI buffer + * @cli_buffer = CLI buffer * return: none */ -void cli_PrintHelp(linebuffer_t * __restrict buffer); +void cli_PrintHelp(linebuffer_t * __restrict cli_buffer); /* * cliEnd() - Clear data, Free resources and close CLI session * - * @buffer = CLI buffer + * @cli_buffer = CLI buffer * return: RETCODE_ERR error, RETCODE_OK ok */ -void cliEnd(linebuffer_t * __restrict buffer); +void cliEnd(linebuffer_t * __restrict cli_buffer); /* * cliInit() - Start CLI session, allocate memory for resources and bind keys * @@ -522,37 +525,37 @@ linebuffer_t *cliInit(int fin, int fout, const char *p /* * cliInitLine() - Init CLI input line terminal * - * @buffer = CLI buffer + * @cli_buffer = CLI buffer * return: none */ -int cliInitLine(linebuffer_t * __restrict buffer); +int cliInitLine(linebuffer_t * __restrict cli_buffer); /* * cliReadLine() - Read line from opened CLI session * - * @buffer = CLI buffer + * @cli_buffer = CLI buffer * return: NULL if error or !=NULL readed line, must be e_free after use! */ -char *cliReadLine(linebuffer_t * __restrict buffer); +char *cliReadLine(linebuffer_t * __restrict cli_buffer); /* * cliLoop() - CLI main loop * - * @buffer = CLI buffer + * @cli_buffer = CLI buffer * @csHistFile = History file name * return: RETCODE_ERR error, RETCODE_OK ok */ -int cliLoop(linebuffer_t * __restrict buffer, const char *csHistFile); +int cliLoop(linebuffer_t * __restrict cli_buffer, const char *csHistFile); /* * cliNetLoop() - CLI network main loop binded to socket * - * @buffer = CLI buffer + * @cli_buffer = CLI buffer * @csHistFile = History file name * @sock = client socket * @term = stdin termios * @win = window size of tty * return: RETCODE_ERR error, RETCODE_OK ok */ -int cliNetLoop(linebuffer_t * __restrict buffer, const char *csHistFile, int sock); +int cliNetLoop(linebuffer_t * __restrict cli_buffer, const char *csHistFile, int sock); #endif