--- libaitcli/inc/aitcli.h 2013/08/12 09:50:28 1.7 +++ libaitcli/inc/aitcli.h 2025/12/21 23:21:40 1.14.4.2 @@ -3,7 +3,7 @@ * by Michael Pounov * * $Author: misho $ -* $Id: aitcli.h,v 1.7 2013/08/12 09:50:28 misho Exp $ +* $Id: aitcli.h,v 1.14.4.2 2025/12/21 23:21:40 misho Exp $ * ************************************************************************** The ELWIX and AITNET software is distributed under the following @@ -12,7 +12,7 @@ terms: All of the documentation and software included in the ELWIX and AITNET Releases is copyrighted by ELWIX - Sofia/Bulgaria -Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 +Copyright 2004 - 2025 by Michael Pounov . All rights reserved. Redistribution and use in source and binary forms, with or without @@ -205,6 +205,7 @@ typedef struct { /* Commands structure for CLI */ +#define CLI_CMD_DEFINE(x) int (x)(void *, int, char **) typedef int (*cmd_func_t)(/*linebuffer_t **/ void * __restrict cli_buffer, int idx, char ** __restrict args); struct tagCommand { @@ -226,19 +227,23 @@ typedef SLIST_HEAD(slCommandHead, tagCommand) commands /* Main structure, Buffer for CLI work with thread models ;-) special designed by M.Punov */ typedef struct { + int line_kill; char line_mode; + char line_porigin[STRSIZ]; char *line_prompt; int line_bol; int line_eol; int line_len; char *line_buf; + char *line_input; const struct tagHistory *line_h; history_t line_history; bindkey_t *line_keys; + bindkey_t *line_inkeys; int line_level; commands_t line_cmds; @@ -247,6 +252,9 @@ typedef struct { int line_out; } linebuffer_t; +#ifdef __cplusplus +extern "C" { +#endif /* Error support functions */ @@ -342,13 +350,13 @@ unsigned int cli_telnet_GetCmd(struct telnetAttrs *att * * @attr = input attribute * @cmd = command - * @opt = option, if 0xff not specified + * @optz = option, if 0xff not specified * @arg1 = sub-option code, if 0xff not specified * @arg2 = sub-option data, if NULL not specified * @arg3 = sub-option data size, if 0 not specified data * return: -1 can`t set command; !=-1 ok */ -int cli_telnet_SetCmd(struct telnetAttrs *attr, unsigned char cmd, unsigned char opt, ...); +int cli_telnet_SetCmd(struct telnetAttrs *attr, unsigned char cmd, int optz, ...); /* * cli_telnet_Answer() - Automatic generate commands answer to send from telnet @@ -379,7 +387,7 @@ int cli_telnet_Answer(unsigned char *caps, int nCaps, * cli_Cmd_Unsupported() - Builtin helper function for unsupported commands * * @cli_buffer = CLI buffer - * @idx = Selected command ID + * @idx = Config level * @args = Parsed arguments array * return: RETCODE_OK ok */ @@ -403,7 +411,7 @@ int cli_BindKey(bindkey_t * __restrict key, linebuffer * * @cli_buffer = CLI buffer * @csCmd = Command name - * @cliLevel = Level in CLI, -1 unprivi(view from all), 0 main config, 1 sub config ... + * @cliLevel = Level in CLI, -1 view from all levels, 0 hidden, >0 mask levels * @funcCmd = Callback function when user call command * @csInfo = Inline information for command * @csHelp = Help line when call help @@ -418,7 +426,7 @@ cli_addCommand(linebuffer_t * __restrict cli_buffer, c * * @cli_buffer = CLI buffer * @csCmd = Command name - * @cliLevel = Level in CLI, -1 unprivi(view from all), 0 main config, 1 sub config ... + * @cliLevel = Level in CLI, -1 view from all levels, 0 hidden, >0 mask levels * return: RETCODE_ERR error, RETCODE_OK ok */ int @@ -428,7 +436,7 @@ cli_delCommand(linebuffer_t * __restrict cli_buffer, c * * @cli_buffer = CLI buffer * @csCmd = Command name - * @cliLevel = Level in CLI, -1 unprivi(view from all), 0 main config, 1 sub config ... + * @cliLevel = Level in CLI, -1 view from all levels, 0 hidden, >0 mask levels * @funcCmd = Callback function when user call command * @csInfo = Inline information for command * @csHelp = Help line when call help @@ -523,39 +531,72 @@ void cliEnd(linebuffer_t * __restrict cli_buffer); linebuffer_t *cliInit(int fin, int fout, const char *prompt); /* - * cliInitLine() - Init CLI input line terminal + * cliSetLine() - Set CLI input line terminal * * @cli_buffer = CLI buffer - * return: none + * @old = Old terminal settings + * return: -1 error or 0 ok */ -int cliInitLine(linebuffer_t * __restrict cli_buffer); +int cliSetLine(linebuffer_t * __restrict cli_buffer, struct termios * __restrict old); /* + * cliResetLine() - Reset CLI input line terminal + * + * @cli_buffer = CLI buffer + * @old = Original terminal settings + * return: -1 error or 0 ok +*/ +int cliResetLine(linebuffer_t * __restrict cli_buffer, struct termios * __restrict orig); +/* + * cliEcho() - Switch echo on or off + * + * @cli_buffer = CLI buffer + * @on = On or off for echo on input handler + * return: -1 error or 0 ok +*/ +int cliEcho(linebuffer_t * __restrict cli_buffer, int on); +/* * cliReadLine() - Read line from opened CLI session * * @cli_buffer = CLI buffer + * @timeout = Session timeout (-1 infinit) * return: NULL if error or !=NULL readed line, must be e_free after use! */ -char *cliReadLine(linebuffer_t * __restrict cli_buffer); +char *cliReadLine(linebuffer_t * __restrict cli_buffer, int timeout); /* + * cliRun() - CLI run command line + * + * @cli_buffer = CLI buffer + * @psInput = Input command line + * @prompt = Display prompt after command + * return: RETCODE_ERR error, RETCODE_OK ok +*/ +int cliRun(linebuffer_t * __restrict cli_buffer, char *psInput, int prompt); + +/* * cliLoop() - CLI main loop * * @cli_buffer = CLI buffer * @csHistFile = History file name + * @timeout = Session timeout (-1 infinit) * return: RETCODE_ERR error, RETCODE_OK ok */ -int cliLoop(linebuffer_t * __restrict cli_buffer, const char *csHistFile); +int cliLoop(linebuffer_t * __restrict cli_buffer, const char *csHistFile, int timeout); /* * cliNetLoop() - CLI network main loop binded to socket * * @cli_buffer = CLI buffer * @csHistFile = History file name * @sock = client socket - * @term = stdin termios - * @win = window size of tty + * @timeout = Session timeout (-1 infinit) * return: RETCODE_ERR error, RETCODE_OK ok */ -int cliNetLoop(linebuffer_t * __restrict cli_buffer, const char *csHistFile, int sock); +int cliNetLoop(linebuffer_t * __restrict cli_buffer, const char *csHistFile, + int sock, int timeout); +#define cliKillLoop(_x) (assert((_x)), (_x)->line_kill = 1) +#ifdef __cplusplus +} +#endif #endif