1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * Copyright (C) 2001 Cluster File Systems, Inc.
6 * This file is part of Lustre, http://www.sf.net/projects/lustre/
8 * Lustre is free software; you can redistribute it and/or
9 * modify it under the terms of version 2 of the GNU General Public
10 * License as published by the Free Software Foundation.
12 * Lustre is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Lustre; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 #include <libcfs/libcfsutil.h>
25 static command_t * top_level; /* Top level of commands, initialized by
27 static char * parser_prompt = NULL;/* Parser prompt, set by InitParser */
28 static int done; /* Set to 1 if user types exit or quit */
29 static int ignore_errors; /* Normally, the parser will quit when
30 an error occurs in non-interacive
31 mode. Setting this to non-zero will
32 force it to keep buggering on. */
35 /* static functions */
36 static char *skipwhitespace(char *s);
37 static char *skiptowhitespace(char *s);
38 static command_t *find_cmd(char *name, command_t cmds[], char **next);
39 static int process(char *s, char **next, command_t *lookup, command_t **result,
41 static void print_commands(char *str, command_t *table);
43 static char * skipwhitespace(char * s)
49 for (t = s; t <= s + len && isspace(*t); t++);
54 static char * skiptowhitespace(char * s)
58 for (t = s; *t && !isspace(*t); t++);
62 static int line2args(char *line, char **argv, int maxargs)
67 arg = strtok(line, " \t");
74 while( (arg = strtok(NULL, " \t")) && (i <= maxargs)) {
81 /* find a command -- return it if unique otherwise print alternatives */
82 static command_t *Parser_findargcmd(char *name, command_t cmds[])
86 for (cmd = cmds; cmd->pc_name; cmd++) {
87 if (strcmp(name, cmd->pc_name) == 0)
93 void Parser_ignore_errors(int ignore)
95 ignore_errors = ignore;
98 int Parser_execarg(int argc, char **argv, command_t cmds[])
102 cmd = Parser_findargcmd(argv[0], cmds);
104 int rc = (cmd->pc_func)(argc, argv);
106 fprintf(stderr, "%s\n", cmd->pc_help);
109 printf("Try interactive use without arguments or use one of:\n");
110 for (cmd = cmds; cmd->pc_name; cmd++)
111 printf("\"%s\"\n", cmd->pc_name);
112 printf("as argument.\n");
117 /* returns the command_t * (NULL if not found) corresponding to a
118 _partial_ match with the first token in name. It sets *next to
119 point to the following token. Does not modify *name. */
120 static command_t * find_cmd(char * name, command_t cmds[], char ** next)
127 /* This sets name to point to the first non-white space character,
128 and next to the first whitespace after name, len to the length: do
130 name = skipwhitespace(name);
131 *next = skiptowhitespace(name);
132 len = (int)(*next - name);
136 for (i = 0; cmds[i].pc_name; i++) {
137 if (strncasecmp(name, cmds[i].pc_name, len) == 0) {
138 *next = skipwhitespace(*next);
145 /* Recursively process a command line string s and find the command
146 corresponding to it. This can be ambiguous, full, incomplete,
148 static int process(char *s, char ** next, command_t *lookup,
149 command_t **result, char **prev)
151 *result = find_cmd(s, lookup, next);
158 /* found entry: is it ambigous, i.e. not exact command name and
159 more than one command in the list matches. Note that find_cmd
160 points to the first ambiguous entry */
161 if (strncasecmp(s, (*result)->pc_name, strlen((*result)->pc_name))) {
163 command_t *another_result = find_cmd(s, (*result) + 1,
165 int found_another = 0;
167 while (another_result) {
168 if (strncasecmp(s, another_result->pc_name,
169 strlen(another_result->pc_name)) == 0){
170 *result = another_result;
171 *next = another_next;
174 another_result = find_cmd(s, another_result + 1,
183 /* found a unique command: component or full? */
184 if ( (*result)->pc_func ) {
187 if ( *next == '\0' ) {
188 return CMD_INCOMPLETE;
190 return process(*next, next, (*result)->pc_sub_cmd,
196 #ifdef HAVE_LIBREADLINE
197 static command_t * match_tbl; /* Command completion against this table */
198 static char * command_generator(const char * text, int state)
204 /* Do we have a match table? */
208 /* If this is the first time called on this word, state is 0 */
211 len = (int)strlen(text);
214 /* Return next name in the command list that paritally matches test */
215 while ( (name = (match_tbl + index)->pc_name) ) {
218 if (strncasecmp(name, text, len) == 0) {
219 return(strdup(name));
223 /* No more matches */
227 /* probably called by readline */
228 static char **command_completion(char * text, int start, int end)
233 match_tbl = top_level;
235 for (table = find_cmd(rl_line_buffer, match_tbl, &pos);
236 table; table = find_cmd(pos, match_tbl, &pos))
239 if (*(pos - 1) == ' ') match_tbl = table->pc_sub_cmd;
242 return completion_matches(text, command_generator);
246 /* take a string and execute the function or print help */
247 int execute_line(char * line)
249 command_t *cmd, *ambig;
256 switch (process(line, &next, top_level, &cmd, &prev)) {
258 fprintf(stderr, "Ambiguous command \'%s\'\nOptions: ", line);
259 while( (ambig = find_cmd(prev, cmd, &tmp)) ) {
260 fprintf(stderr, "%s ", ambig->pc_name);
263 fprintf(stderr, "\n");
266 fprintf(stderr, "No such command, type help\n");
270 "'%s' incomplete command. Use '%s x' where x is one of:\n",
272 fprintf(stderr, "\t");
273 for (i = 0; cmd->pc_sub_cmd[i].pc_name; i++) {
274 fprintf(stderr, "%s ", cmd->pc_sub_cmd[i].pc_name);
276 fprintf(stderr, "\n");
279 i = line2args(line, argv, MAXARGS);
280 rc = (cmd->pc_func)(i, argv);
283 fprintf(stderr, "%s\n", cmd->pc_help);
297 /* just in case you're ever in an airplane and discover you
298 forgot to install readline-dev. :) */
301 int interactive = isatty (fileno (stdin));
303 #ifdef HAVE_LIBREADLINE
305 stifle_history(HISTORY);
309 rl_prep_term_function = (rl_vintfunc_t *)noop_fn;
310 rl_deprep_term_function = (rl_voidfunc_t *)noop_fn;
313 rl_attempted_completion_function = (CPPFunction *)command_completion;
314 rl_completion_entry_function = (void *)command_generator;
319 #ifndef HAVE_LIBREADLINE
320 #define add_history(s)
321 char * readline(char * prompt)
324 char *line = malloc(size);
332 printf ("%s", prompt);
335 if ((c = fgetc(stdin)) != EOF) {
340 if (ptr - line >= size - 1) {
347 memcpy(tmp, line, ptr - line);
348 ptr = tmp + (ptr - line);
354 if (ferror(stdin) || feof(stdin))
361 if (eof && (strlen(line) == 0)) {
372 /* this is the command execution machine */
373 int Parser_commands(void)
376 int rc = 0, save_error = 0;
379 interactive = init_input();
382 line = readline(interactive ? parser_prompt : NULL);
386 s = skipwhitespace(line);
390 rc = execute_line(s);
392 /* stop on error if not-interactive */
393 if (rc != 0 && !interactive) {
408 /* sets the parser prompt */
409 void Parser_init(char * prompt, command_t * cmds)
413 if (parser_prompt) free(parser_prompt);
414 parser_prompt = strdup(prompt);
417 /* frees the parser prompt */
418 void Parser_exit(int argc, char *argv[])
422 parser_prompt = NULL;
425 /* convert a string to an integer */
426 int Parser_int(char *s, int *val)
431 ret = sscanf(s, "%d", val);
432 else if (*(s+1) != 'x')
433 ret = sscanf(s, "%o", val);
436 ret = sscanf(++s, "%x", val);
443 void Parser_qhelp(int argc, char *argv[]) {
445 printf("Available commands are:\n");
447 print_commands(NULL, top_level);
448 printf("For more help type: help command-name\n");
451 int Parser_help(int argc, char **argv)
454 char *next, *prev, *tmp;
455 command_t *result, *ambig;
459 Parser_qhelp(argc, argv);
464 for ( i = 1 ; i < argc ; i++ ) {
465 strcat(line, argv[i]);
468 switch ( process(line, &next, top_level, &result, &prev) ) {
470 fprintf(stderr, "%s: %s\n",line, result->pc_help);
473 fprintf(stderr, "%s: Unknown command.\n", line);
477 "'%s' incomplete command. Use '%s x' where x is one of:\n",
479 fprintf(stderr, "\t");
480 for (i = 0; result->pc_sub_cmd[i].pc_name; i++) {
481 fprintf(stderr, "%s ", result->pc_sub_cmd[i].pc_name);
483 fprintf(stderr, "\n");
486 fprintf(stderr, "Ambiguous command \'%s\'\nOptions: ", line);
487 while( (ambig = find_cmd(prev, result, &tmp)) ) {
488 fprintf(stderr, "%s ", ambig->pc_name);
491 fprintf(stderr, "\n");
498 void Parser_printhelp(char *cmd)
500 char *argv[] = { "help", cmd };
501 Parser_help(2, argv);
505 /*************************************************************************
507 *************************************************************************/
508 static void print_commands(char * str, command_t * table) {
512 for (cmds = table; cmds->pc_name; cmds++) {
514 if (str) printf("\t%s %s\n", str, cmds->pc_name);
515 else printf("\t%s\n", cmds->pc_name);
517 if (cmds->pc_sub_cmd) {
519 sprintf(buf, "%s %s", str, cmds->pc_name);
520 print_commands(buf, cmds->pc_sub_cmd);
522 print_commands(cmds->pc_name, cmds->pc_sub_cmd);
528 char *Parser_getstr(const char *prompt, const char *deft, char *res,
532 int size = strlen(prompt) + strlen(deft) + 8;
534 theprompt = malloc(size);
537 sprintf(theprompt, "%s [%s]: ", prompt, deft);
539 line = readline(theprompt);
542 if ( line == NULL || *line == '\0' ) {
543 strncpy(res, deft, len);
545 strncpy(res, line, len);
556 /* get integer from prompt, loop forever to get it */
557 int Parser_getint(const char *prompt, long min, long max, long deft, int base)
562 int size = strlen(prompt) + 40;
563 char *theprompt = malloc(size);
565 sprintf(theprompt,"%s [%ld, (0x%lx)]: ", prompt, deft, deft);
571 line = readline(theprompt);
573 fprintf(stdout, "Please enter an integer.\n");
577 if ( *line == '\0' ) {
582 rc = Parser_arg2int(line, &result, base);
585 fprintf(stdout, "Invalid string.\n");
587 } else if ( result > max || result < min ) {
588 fprintf(stdout, "Error: response must lie between %ld and %ld.\n",
602 /* get boolean (starting with YyNn; loop forever */
603 int Parser_getbool(const char *prompt, int deft)
607 int size = strlen(prompt) + 8;
608 char *theprompt = malloc(size);
613 if ( deft != 0 && deft != 1 ) {
614 fprintf(stderr, "Error: Parser_getbool given bad default %d\n",
618 sprintf(theprompt, "%s [%s]: ", prompt, (deft==0)? "N" : "Y");
622 line = readline(theprompt);
623 if ( line == NULL ) {
627 if ( *line == '\0' ) {
631 if ( *line == 'y' || *line == 'Y' ) {
635 if ( *line == 'n' || *line == 'N' ) {
641 fprintf(stdout, "Invalid string. Must start with yY or nN\n");
652 /* parse int out of a string or prompt for it */
653 long Parser_intarg(const char *inp, const char *prompt, int deft,
654 int min, int max, int base)
659 rc = Parser_arg2int(inp, &result, base);
664 return Parser_getint(prompt, deft, min, max, base);
668 /* parse int out of a string or prompt for it */
669 char *Parser_strarg(char *inp, const char *prompt, const char *deft,
670 char *answer, int len)
672 if ( inp == NULL || *inp == '\0' ) {
673 return Parser_getstr(prompt, deft, answer, len);
678 /* change a string into a number: return 0 on success. No invalid characters
679 allowed. The processing of base and validity follows strtol(3)*/
680 int Parser_arg2int(const char *inp, long *result, int base)
684 if ( (base !=0) && (base < 2 || base > 36) )
687 *result = strtol(inp, &endptr, base);
689 if ( *inp != '\0' && *endptr == '\0' )
695 /* Convert human readable size string to and int; "1k" -> 1000 */
696 int Parser_size (int *sizep, char *str) {
700 switch (sscanf (str, "%d%1[gGmMkK]", &size, mod)) {
732 /* Convert a string boolean to an int; "enable" -> 1 */
733 int Parser_bool (int *b, char *str) {
734 if (!strcasecmp (str, "no") ||
735 !strcasecmp (str, "n") ||
736 !strcasecmp (str, "off") ||
737 !strcasecmp (str, "down") ||
738 !strcasecmp (str, "disable"))
744 if (!strcasecmp (str, "yes") ||
745 !strcasecmp (str, "y") ||
746 !strcasecmp (str, "on") ||
747 !strcasecmp (str, "up") ||
748 !strcasecmp (str, "enable"))
757 int Parser_quit(int argc, char **argv)