cli.h File Reference

#include <stdarg.h>

Go to the source code of this file.

Data Structures
struct	ast_cli_entry
	A command line entry */. More...
Defines
#define	RESULT_SUCCESS   0
#define	RESULT_SHOWUSAGE   1
#define	RESULT_FAILURE   2
#define	AST_MAX_CMD_LEN   16
#define	AST_MAX_ARGS   64
#define	AST_CLI_COMPLETE_EOF   "_EOF_"
Functions
void	ast_cli (int fd, char *fmt,...) __attribute__((format(printf
int	ast_cli_command (int fd, char *s)
	Interprets a command.
int	ast_cli_register (struct ast_cli_entry *e)
	Registers a command.
int	ast_cli_unregister (struct ast_cli_entry *e)
	Unregisters a command.
char *	ast_cli_generator (char *, char *, int)
	Readline madness.
int	ast_cli_generatornummatches (char *, char *)
char **	ast_cli_completion_matches (char *, char *)

---

Define Documentation

#define AST_CLI_COMPLETE_EOF   "_EOF_"

Definition at line 34 of file cli.h.

#define AST_MAX_ARGS   64

Definition at line 32 of file cli.h. Referenced by ast_cli_command().

#define AST_MAX_CMD_LEN   16

Definition at line 30 of file cli.h.

#define RESULT_FAILURE   2

Definition at line 28 of file cli.h.

#define RESULT_SHOWUSAGE   1

Definition at line 27 of file cli.h. Referenced by ast_cli_command().

#define RESULT_SUCCESS   0

Definition at line 26 of file cli.h.

---

Function Documentation

void ast_cli (  int  fd, char *  fmt,   ... )

int ast_cli_command (  int  fd, char *  s )

Interprets a command. Interpret a command s, sending output to fd Returns 0 on succes, -1 on failure Definition at line 1134 of file cli.c. References ast_cli(), ast_log(), AST_MAX_ARGS, ast_mutex_lock, ast_mutex_unlock, free, ast_cli_entry::handler, ast_cli_entry::inuse, LOG_WARNING, RESULT_SHOWUSAGE, and ast_cli_entry::usage. { char *argv[AST_MAX_ARGS]; struct ast_cli_entry *e; int x; char *dup; if ((dup = parse_args(s, &x, argv, sizeof(argv) / sizeof(argv[0])))) { /* We need at least one entry, or ignore */ if (x > 0) { ast_mutex_lock(&clilock); e = find_cli(argv, 0); if (e) e->inuse++; ast_mutex_unlock(&clilock); if (e) { switch(e->handler(fd, x, argv)) { case RESULT_SHOWUSAGE: ast_cli(fd, e->usage); break; } } else ast_cli(fd, "No such command '%s' (type 'help' for help)\n", find_best(argv)); if (e) { ast_mutex_lock(&clilock); e->inuse--; ast_mutex_unlock(&clilock); } } free(dup); } else { ast_log(LOG_WARNING, "Out of memory\n"); return -1; } return 0; }

char** ast_cli_completion_matches (  char *  , char *  )

Definition at line 1018 of file cli.c. References ast_cli_generator(), malloc, and realloc. { char **match_list = NULL, *retstr, *prevstr; size_t match_list_len, max_equal, which, i; int matches = 0; match_list_len = 1; while ((retstr = ast_cli_generator(text, word, matches)) != NULL) { if (matches + 1 >= match_list_len) { match_list_len <<= 1; match_list = realloc(match_list, match_list_len * sizeof(char *)); } match_list[++matches] = retstr; } if (!match_list) return (char **) NULL; which = 2; prevstr = match_list[1]; max_equal = strlen(prevstr); for (; which <= matches; which++) { for (i = 0; i < max_equal && toupper(prevstr[i]) == toupper(match_list[which][i]); i++) continue; max_equal = i; } retstr = malloc(max_equal + 1); (void) strncpy(retstr, match_list[1], max_equal); retstr[max_equal] = '\0'; match_list[0] = retstr; if (matches + 1 >= match_list_len) match_list = realloc(match_list, (match_list_len + 1) * sizeof(char *)); match_list[matches + 1] = (char *) NULL; return (match_list); }

char* ast_cli_generator (  char *  , char *  , int  )

Readline madness. Definition at line 1129 of file cli.c. Referenced by ast_cli_completion_matches(), and ast_cli_generatornummatches(). { return __ast_cli_generator(text, word, state, 1); }

int ast_cli_generatornummatches (  char *  , char *  )

Definition at line 1002 of file cli.c. References ast_cli_generator(). { int matches = 0, i = 0; char *buf = NULL, *oldbuf = NULL; while ( (buf = ast_cli_generator(text, word, i)) ) { if (++i > 1 && strcmp(buf,oldbuf) == 0) { continue; } oldbuf = buf; matches++; } return matches; }

int ast_cli_register (  struct ast_cli_entry *  e  )

Registers a command. Parameters: fd  File descriptor that I/O is done to s  string given at prompt Register your own command Returns 0 on success, -1 on failure Definition at line 830 of file cli.c. References ast_log(), ast_mutex_lock, ast_mutex_unlock, ast_cli_entry::cmda, LOG_WARNING, and ast_cli_entry::next. Referenced by ast_file_init(), ast_image_init(), ast_register_translator(), astdb_init(), init_framer(), init_logger(), init_manager(), load_pbx(), main(), and register_config_cli(). { struct ast_cli_entry *cur, *l=NULL; char fulle[80] ="", fulltst[80] =""; static int len; ast_mutex_lock(&clilock); join2(fulle, sizeof(fulle), e->cmda); if (find_cli(e->cmda, -1)) { ast_mutex_unlock(&clilock); ast_log(LOG_WARNING, "Command '%s' already registered (or something close enough)\n", fulle); return -1; } cur = helpers; while(cur) { join2(fulltst, sizeof(fulltst), cur->cmda); len = strlen(fulltst); if (strlen(fulle) < len) len = strlen(fulle); if (strncasecmp(fulle, fulltst, len) < 0) { if (l) { e->next = l->next; l->next = e; } else { e->next = helpers; helpers = e; } break; } l = cur; cur = cur->next; } if (!cur) { if (l) l->next = e; else helpers = e; e->next = NULL; } ast_mutex_unlock(&clilock); return 0; }

int ast_cli_unregister (  struct ast_cli_entry *  e  )

Unregisters a command. Parameters: e  which cli entry to unregister Unregister your own command. You must pass a completed ast_cli_entry structur Returns 0 on success, -1 on failure Definition at line 804 of file cli.c. References ast_log(), ast_mutex_lock, ast_mutex_unlock, ast_cli_entry::inuse, LOG_WARNING, and ast_cli_entry::next. { struct ast_cli_entry *cur, *l=NULL; ast_mutex_lock(&clilock); cur = helpers; while(cur) { if (e == cur) { if (e->inuse) { ast_log(LOG_WARNING, "Can't remove command that is in use\n"); } else { /* Rewrite */ if (l) l->next = e->next; else helpers = e->next; e->next = NULL; break; } } l = cur; cur = cur->next; } ast_mutex_unlock(&clilock); return 0; }

---