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.
28 #include <sys/param.h>
32 #ifdef HAVE_LIBREADLINE
33 #define READLINE_LIBRARY
34 #include <readline/readline.h>
36 //extern char **completion_matches __P((char *, rl_compentry_func_t *));
37 extern void using_history(void);
38 extern void stifle_history(int);
39 extern void add_history(char *);
43 static command_t * top_level; /* Top level of commands, initialized by
45 static char * parser_prompt = NULL;/* Parser prompt, set by InitParser */
46 static int done; /* Set to 1 if user types exit or quit */
49 /* static functions */
50 static char *skipwhitespace(char *s);
51 static char *skiptowhitespace(char *s);
52 static command_t *find_cmd(char *name, command_t cmds[], char **next);
53 static int process(char *s, char **next, command_t *lookup, command_t **result,
55 static void print_commands(char *str, command_t *table);
57 static char * skipwhitespace(char * s)
63 for (t = s; t <= s + len && isspace(*t); t++);
68 static char * skiptowhitespace(char * s)
72 for (t = s; *t && !isspace(*t); t++);
76 static int line2args(char *line, char **argv, int maxargs)
81 arg = strtok(line, " \t");
88 while( (arg = strtok(NULL, " \t")) && (i <= maxargs)) {
95 /* find a command -- return it if unique otherwise print alternatives */
96 static command_t *Parser_findargcmd(char *name, command_t cmds[])
100 for (cmd = cmds; cmd->pc_name; cmd++) {
101 if (strcmp(name, cmd->pc_name) == 0)
107 int Parser_execarg(int argc, char **argv, command_t cmds[])
111 cmd = Parser_findargcmd(argv[0], cmds);
113 int rc = (cmd->pc_func)(argc, argv);
115 fprintf(stderr, "%s\n", cmd->pc_help);
118 printf("Try interactive use without arguments or use one of:\n");
119 for (cmd = cmds; cmd->pc_name; cmd++)
120 printf("\"%s\" ", cmd->pc_name);
121 printf("\nas argument.\n");
126 /* returns the command_t * (NULL if not found) corresponding to a
127 _partial_ match with the first token in name. It sets *next to
128 point to the following token. Does not modify *name. */
129 static command_t * find_cmd(char * name, command_t cmds[], char ** next)
136 /* This sets name to point to the first non-white space character,
137 and next to the first whitespace after name, len to the length: do
139 name = skipwhitespace(name);
140 *next = skiptowhitespace(name);
145 for (i = 0; cmds[i].pc_name; i++) {
146 if (strncasecmp(name, cmds[i].pc_name, len) == 0) {
147 *next = skipwhitespace(*next);
154 /* Recursively process a command line string s and find the command
155 corresponding to it. This can be ambiguous, full, incomplete,
157 static int process(char *s, char ** next, command_t *lookup,
158 command_t **result, char **prev)
160 *result = find_cmd(s, lookup, next);
167 /* found entry: is it ambigous, i.e. not exact command name and
168 more than one command in the list matches. Note that find_cmd
169 points to the first ambiguous entry */
170 if ( strncasecmp(s, (*result)->pc_name, strlen((*result)->pc_name)) &&
171 find_cmd(s, (*result) + 1, next))
174 /* found a unique command: component or full? */
175 if ( (*result)->pc_func ) {
178 if ( *next == '\0' ) {
179 return CMD_INCOMPLETE;
181 return process(*next, next, (*result)->pc_sub_cmd, result, prev);
186 #ifdef HAVE_LIBREADLINE
187 static command_t * match_tbl; /* Command completion against this table */
188 static char * command_generator(const char * text, int state)
194 /* Do we have a match table? */
198 /* If this is the first time called on this word, state is 0 */
201 len = (int)strlen(text);
204 /* Return next name in the command list that paritally matches test */
205 while ( (name = (match_tbl + index)->pc_name) ) {
208 if (strncasecmp(name, text, len) == 0) {
209 return(strdup(name));
213 /* No more matches */
217 /* probably called by readline */
218 static char **command_completion(char * text, int start, int end)
223 match_tbl = top_level;
224 for (table = find_cmd(rl_line_buffer, match_tbl, &pos);
226 table = find_cmd(pos, match_tbl, &pos)) {
228 if (*(pos - 1) == ' ') match_tbl = table->pc_sub_cmd;
231 return(completion_matches(text, command_generator));
235 /* take a string and execute the function or print help */
236 int execute_line(char * line)
238 command_t *cmd, *ambig;
245 switch( process(line, &next, top_level, &cmd, &prev) ) {
247 fprintf(stderr, "Ambiguous command \'%s\'\nOptions: ", line);
248 while( (ambig = find_cmd(prev, cmd, &tmp)) ) {
249 fprintf(stderr, "%s ", ambig->pc_name);
252 fprintf(stderr, "\n");
255 fprintf(stderr, "No such command, type help\n");
259 "'%s' incomplete command. Use '%s x' where x is one of:\n",
261 fprintf(stderr, "\t");
262 for (i = 0; cmd->pc_sub_cmd[i].pc_name; i++) {
263 fprintf(stderr, "%s ", cmd->pc_sub_cmd[i].pc_name);
265 fprintf(stderr, "\n");
268 i = line2args(line, argv, MAXARGS);
269 rc = (cmd->pc_func)(i, argv);
272 fprintf(stderr, "%s\n", cmd->pc_help);
286 /* just in case you're ever in an airplane and discover you
287 forgot to install readline-dev. :) */
290 int interactive = isatty (fileno (stdin));
292 #ifdef HAVE_LIBREADLINE
294 stifle_history(HISTORY);
298 rl_prep_term_function = (rl_vintfunc_t *)noop_fn;
299 rl_deprep_term_function = (rl_voidfunc_t *)noop_fn;
302 rl_attempted_completion_function = (CPPFunction *)command_completion;
303 rl_completion_entry_function = (void *)command_generator;
308 #ifndef HAVE_LIBREADLINE
309 #define add_history(s)
310 char * readline(char * prompt)
315 printf ("%s", prompt);
316 if (fgets(line, sizeof(line), stdin) == NULL)
319 if (n && line[n-1] == '\n')
325 /* this is the command execution machine */
326 int Parser_commands(void)
332 interactive = init_input();
335 line = readline(interactive ? parser_prompt : NULL);
339 s = skipwhitespace(line);
343 rc = execute_line(s);
352 /* sets the parser prompt */
353 void Parser_init(char * prompt, command_t * cmds)
357 if (parser_prompt) free(parser_prompt);
358 parser_prompt = strdup(prompt);
361 /* frees the parser prompt */
362 void Parser_exit(int argc, char *argv[])
366 parser_prompt = NULL;
369 /* convert a string to an integer */
370 int Parser_int(char *s, int *val)
375 ret = sscanf(s, "%d", val);
376 else if (*(s+1) != 'x')
377 ret = sscanf(s, "%o", val);
380 ret = sscanf(++s, "%x", val);
387 void Parser_qhelp(int argc, char *argv[]) {
389 printf("Available commands are:\n");
391 print_commands(NULL, top_level);
392 printf("For more help type: help command-name\n");
395 int Parser_help(int argc, char **argv)
398 char *next, *prev, *tmp;
399 command_t *result, *ambig;
403 Parser_qhelp(argc, argv);
408 for ( i = 1 ; i < argc ; i++ ) {
409 strcat(line, argv[i]);
412 switch ( process(line, &next, top_level, &result, &prev) ) {
414 fprintf(stderr, "%s: %s\n",line, result->pc_help);
417 fprintf(stderr, "%s: Unknown command.\n", line);
421 "'%s' incomplete command. Use '%s x' where x is one of:\n",
423 fprintf(stderr, "\t");
424 for (i = 0; result->pc_sub_cmd[i].pc_name; i++) {
425 fprintf(stderr, "%s ", result->pc_sub_cmd[i].pc_name);
427 fprintf(stderr, "\n");
430 fprintf(stderr, "Ambiguous command \'%s\'\nOptions: ", line);
431 while( (ambig = find_cmd(prev, result, &tmp)) ) {
432 fprintf(stderr, "%s ", ambig->pc_name);
435 fprintf(stderr, "\n");
442 void Parser_printhelp(char *cmd)
444 char *argv[] = { "help", cmd };
445 Parser_help(2, argv);
448 /*************************************************************************
450 *************************************************************************/
453 static void print_commands(char * str, command_t * table) {
457 for (cmds = table; cmds->pc_name; cmds++) {
459 if (str) printf("\t%s %s\n", str, cmds->pc_name);
460 else printf("\t%s\n", cmds->pc_name);
462 if (cmds->pc_sub_cmd) {
464 sprintf(buf, "%s %s", str, cmds->pc_name);
465 print_commands(buf, cmds->pc_sub_cmd);
467 print_commands(cmds->pc_name, cmds->pc_sub_cmd);
473 char *Parser_getstr(const char *prompt, const char *deft, char *res,
477 int size = strlen(prompt) + strlen(deft) + 8;
479 theprompt = malloc(size);
482 sprintf(theprompt, "%s [%s]: ", prompt, deft);
484 line = readline(theprompt);
487 if ( line == NULL || *line == '\0' ) {
488 strncpy(res, deft, len);
490 strncpy(res, line, len);
501 /* get integer from prompt, loop forever to get it */
502 int Parser_getint(const char *prompt, long min, long max, long deft, int base)
507 int size = strlen(prompt) + 40;
508 char *theprompt = malloc(size);
510 sprintf(theprompt,"%s [%ld, (0x%lx)]: ", prompt, deft, deft);
516 line = readline(theprompt);
518 fprintf(stdout, "Please enter an integer.\n");
522 if ( *line == '\0' ) {
527 rc = Parser_arg2int(line, &result, base);
530 fprintf(stdout, "Invalid string.\n");
532 } else if ( result > max || result < min ) {
533 fprintf(stdout, "Error: response must lie between %ld and %ld.\n",
547 /* get boolean (starting with YyNn; loop forever */
548 int Parser_getbool(const char *prompt, int deft)
552 int size = strlen(prompt) + 8;
553 char *theprompt = malloc(size);
558 if ( deft != 0 && deft != 1 ) {
559 fprintf(stderr, "Error: Parser_getbool given bad default (%d).\n",
563 sprintf(theprompt, "%s [%s]: ", prompt, (deft==0)? "N" : "Y");
567 line = readline(theprompt);
568 if ( line == NULL ) {
572 if ( *line == '\0' ) {
576 if ( *line == 'y' || *line == 'Y' ) {
580 if ( *line == 'n' || *line == 'N' ) {
586 fprintf(stdout, "Invalid string. Must start with yY or nN\n");
597 /* parse int out of a string or prompt for it */
598 long Parser_intarg(const char *inp, const char *prompt, int deft,
599 int min, int max, int base)
604 rc = Parser_arg2int(inp, &result, base);
609 return Parser_getint(prompt, deft, min, max, base);
613 /* parse int out of a string or prompt for it */
614 char *Parser_strarg(char *inp, const char *prompt, const char *deft,
615 char *answer, int len)
617 if ( inp == NULL || *inp == '\0' ) {
618 return Parser_getstr(prompt, deft, answer, len);
623 /* change a string into a number: return 0 on success. No invalid characters
624 allowed. The processing of base and validity follows strtol(3)*/
625 int Parser_arg2int(const char *inp, long *result, int base)
629 if ( (base !=0) && (base < 2 || base > 36) )
632 *result = strtol(inp, &endptr, base);
634 if ( *inp != '\0' && *endptr == '\0' )
640 /* Convert human readable size string to and int; "1k" -> 1000 */
641 int Parser_size (int *sizep, char *str) {
645 switch (sscanf (str, "%d%1[gGmMkK]", &size, mod)) {
677 /* Convert a string boolean to an int; "enable" -> 1 */
678 int Parser_bool (int *b, char *str) {
679 if (!strcasecmp (str, "no") ||
680 !strcasecmp (str, "n") ||
681 !strcasecmp (str, "off") ||
682 !strcasecmp (str, "down") ||
683 !strcasecmp (str, "disable"))
689 if (!strcasecmp (str, "yes") ||
690 !strcasecmp (str, "y") ||
691 !strcasecmp (str, "on") ||
692 !strcasecmp (str, "up") ||
693 !strcasecmp (str, "enable"))
702 int Parser_quit(int argc, char **argv)