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>
31 #ifdef HAVE_LIBREADLINE
32 #define READLINE_LIBRARY
33 #include <readline/readline.h>
35 /* completion_matches() is #if 0-ed out in modern glibc */
36 #ifndef completion_matches
37 # define completion_matches rl_completion_matches
41 extern void using_history(void);
42 extern void stifle_history(int);
43 extern void add_history(char *);
47 static command_t * top_level; /* Top level of commands, initialized by
49 static char * parser_prompt = NULL;/* Parser prompt, set by InitParser */
50 static int done; /* Set to 1 if user types exit or quit */
53 /* static functions */
54 static char *skipwhitespace(char *s);
55 static char *skiptowhitespace(char *s);
56 static command_t *find_cmd(char *name, command_t cmds[], char **next);
57 static int process(char *s, char **next, command_t *lookup, command_t **result,
59 static void print_commands(char *str, command_t *table);
61 static char * skipwhitespace(char * s)
67 for (t = s; t <= s + len && isspace(*t); t++);
72 static char * skiptowhitespace(char * s)
76 for (t = s; *t && !isspace(*t); t++);
80 static int line2args(char *line, char **argv, int maxargs)
85 arg = strtok(line, " \t");
92 while( (arg = strtok(NULL, " \t")) && (i <= maxargs)) {
99 /* find a command -- return it if unique otherwise print alternatives */
100 static command_t *Parser_findargcmd(char *name, command_t cmds[])
104 for (cmd = cmds; cmd->pc_name; cmd++) {
105 if (strcmp(name, cmd->pc_name) == 0)
111 int Parser_execarg(int argc, char **argv, command_t cmds[])
115 cmd = Parser_findargcmd(argv[0], cmds);
117 int rc = (cmd->pc_func)(argc, argv);
119 fprintf(stderr, "%s\n", cmd->pc_help);
122 printf("Try interactive use without arguments or use one of:\n");
123 for (cmd = cmds; cmd->pc_name; cmd++)
124 printf("\"%s\" ", cmd->pc_name);
125 printf("\nas argument.\n");
130 /* returns the command_t * (NULL if not found) corresponding to a
131 _partial_ match with the first token in name. It sets *next to
132 point to the following token. Does not modify *name. */
133 static command_t * find_cmd(char * name, command_t cmds[], char ** next)
140 /* This sets name to point to the first non-white space character,
141 and next to the first whitespace after name, len to the length: do
143 name = skipwhitespace(name);
144 *next = skiptowhitespace(name);
149 for (i = 0; cmds[i].pc_name; i++) {
150 if (strncasecmp(name, cmds[i].pc_name, len) == 0) {
151 *next = skipwhitespace(*next);
158 /* Recursively process a command line string s and find the command
159 corresponding to it. This can be ambiguous, full, incomplete,
161 static int process(char *s, char ** next, command_t *lookup,
162 command_t **result, char **prev)
164 *result = find_cmd(s, lookup, next);
171 /* found entry: is it ambigous, i.e. not exact command name and
172 more than one command in the list matches. Note that find_cmd
173 points to the first ambiguous entry */
174 if ( strncasecmp(s, (*result)->pc_name, strlen((*result)->pc_name)) &&
175 find_cmd(s, (*result) + 1, next))
178 /* found a unique command: component or full? */
179 if ( (*result)->pc_func ) {
182 if ( *next == '\0' ) {
183 return CMD_INCOMPLETE;
185 return process(*next, next, (*result)->pc_sub_cmd, result, prev);
190 #ifdef HAVE_LIBREADLINE
191 static command_t * match_tbl; /* Command completion against this table */
192 static char * command_generator(const char * text, int state)
198 /* Do we have a match table? */
202 /* If this is the first time called on this word, state is 0 */
205 len = (int)strlen(text);
208 /* Return next name in the command list that paritally matches test */
209 while ( (name = (match_tbl + index)->pc_name) ) {
212 if (strncasecmp(name, text, len) == 0) {
213 return(strdup(name));
217 /* No more matches */
221 /* probably called by readline */
222 static char **command_completion(char * text, int start, int end)
227 match_tbl = top_level;
229 for (table = find_cmd(rl_line_buffer, match_tbl, &pos);
230 table; table = find_cmd(pos, match_tbl, &pos))
233 if (*(pos - 1) == ' ') match_tbl = table->pc_sub_cmd;
236 return completion_matches(text, command_generator);
240 /* take a string and execute the function or print help */
241 int execute_line(char * line)
243 command_t *cmd, *ambig;
250 switch( process(line, &next, top_level, &cmd, &prev) ) {
252 fprintf(stderr, "Ambiguous command \'%s\'\nOptions: ", line);
253 while( (ambig = find_cmd(prev, cmd, &tmp)) ) {
254 fprintf(stderr, "%s ", ambig->pc_name);
257 fprintf(stderr, "\n");
260 fprintf(stderr, "No such command, type help\n");
264 "'%s' incomplete command. Use '%s x' where x is one of:\n",
266 fprintf(stderr, "\t");
267 for (i = 0; cmd->pc_sub_cmd[i].pc_name; i++) {
268 fprintf(stderr, "%s ", cmd->pc_sub_cmd[i].pc_name);
270 fprintf(stderr, "\n");
273 i = line2args(line, argv, MAXARGS);
274 rc = (cmd->pc_func)(i, argv);
277 fprintf(stderr, "%s\n", cmd->pc_help);
291 /* just in case you're ever in an airplane and discover you
292 forgot to install readline-dev. :) */
295 int interactive = isatty (fileno (stdin));
297 #ifdef HAVE_LIBREADLINE
299 stifle_history(HISTORY);
303 rl_prep_term_function = (rl_vintfunc_t *)noop_fn;
304 rl_deprep_term_function = (rl_voidfunc_t *)noop_fn;
307 rl_attempted_completion_function = (CPPFunction *)command_completion;
308 rl_completion_entry_function = (void *)command_generator;
313 #ifndef HAVE_LIBREADLINE
314 #define add_history(s)
315 char * readline(char * prompt)
320 printf ("%s", prompt);
321 if (fgets(line, sizeof(line), stdin) == NULL)
324 if (n && line[n-1] == '\n')
330 /* this is the command execution machine */
331 int Parser_commands(void)
337 interactive = init_input();
340 line = readline(interactive ? parser_prompt : NULL);
344 s = skipwhitespace(line);
348 rc = execute_line(s);
357 /* sets the parser prompt */
358 void Parser_init(char * prompt, command_t * cmds)
362 if (parser_prompt) free(parser_prompt);
363 parser_prompt = strdup(prompt);
366 /* frees the parser prompt */
367 void Parser_exit(int argc, char *argv[])
371 parser_prompt = NULL;
374 /* convert a string to an integer */
375 int Parser_int(char *s, int *val)
380 ret = sscanf(s, "%d", val);
381 else if (*(s+1) != 'x')
382 ret = sscanf(s, "%o", val);
385 ret = sscanf(++s, "%x", val);
392 void Parser_qhelp(int argc, char *argv[]) {
394 printf("Available commands are:\n");
396 print_commands(NULL, top_level);
397 printf("For more help type: help command-name\n");
400 int Parser_help(int argc, char **argv)
403 char *next, *prev, *tmp;
404 command_t *result, *ambig;
408 Parser_qhelp(argc, argv);
413 for ( i = 1 ; i < argc ; i++ ) {
414 strcat(line, argv[i]);
417 switch ( process(line, &next, top_level, &result, &prev) ) {
419 fprintf(stderr, "%s: %s\n",line, result->pc_help);
422 fprintf(stderr, "%s: Unknown command.\n", line);
426 "'%s' incomplete command. Use '%s x' where x is one of:\n",
428 fprintf(stderr, "\t");
429 for (i = 0; result->pc_sub_cmd[i].pc_name; i++) {
430 fprintf(stderr, "%s ", result->pc_sub_cmd[i].pc_name);
432 fprintf(stderr, "\n");
435 fprintf(stderr, "Ambiguous command \'%s\'\nOptions: ", line);
436 while( (ambig = find_cmd(prev, result, &tmp)) ) {
437 fprintf(stderr, "%s ", ambig->pc_name);
440 fprintf(stderr, "\n");
447 void Parser_printhelp(char *cmd)
449 char *argv[] = { "help", cmd };
450 Parser_help(2, argv);
453 /*************************************************************************
455 *************************************************************************/
458 static void print_commands(char * str, command_t * table) {
462 for (cmds = table; cmds->pc_name; cmds++) {
464 if (str) printf("\t%s %s\n", str, cmds->pc_name);
465 else printf("\t%s\n", cmds->pc_name);
467 if (cmds->pc_sub_cmd) {
469 sprintf(buf, "%s %s", str, cmds->pc_name);
470 print_commands(buf, cmds->pc_sub_cmd);
472 print_commands(cmds->pc_name, cmds->pc_sub_cmd);
478 char *Parser_getstr(const char *prompt, const char *deft, char *res,
482 int size = strlen(prompt) + strlen(deft) + 8;
484 theprompt = malloc(size);
487 sprintf(theprompt, "%s [%s]: ", prompt, deft);
489 line = readline(theprompt);
492 if ( line == NULL || *line == '\0' ) {
493 strncpy(res, deft, len);
495 strncpy(res, line, len);
506 /* get integer from prompt, loop forever to get it */
507 int Parser_getint(const char *prompt, long min, long max, long deft, int base)
512 int size = strlen(prompt) + 40;
513 char *theprompt = malloc(size);
515 sprintf(theprompt,"%s [%ld, (0x%lx)]: ", prompt, deft, deft);
521 line = readline(theprompt);
523 fprintf(stdout, "Please enter an integer.\n");
527 if ( *line == '\0' ) {
532 rc = Parser_arg2int(line, &result, base);
535 fprintf(stdout, "Invalid string.\n");
537 } else if ( result > max || result < min ) {
538 fprintf(stdout, "Error: response must lie between %ld and %ld.\n",
552 /* get boolean (starting with YyNn; loop forever */
553 int Parser_getbool(const char *prompt, int deft)
557 int size = strlen(prompt) + 8;
558 char *theprompt = malloc(size);
563 if ( deft != 0 && deft != 1 ) {
564 fprintf(stderr, "Error: Parser_getbool given bad default (%d).\n",
568 sprintf(theprompt, "%s [%s]: ", prompt, (deft==0)? "N" : "Y");
572 line = readline(theprompt);
573 if ( line == NULL ) {
577 if ( *line == '\0' ) {
581 if ( *line == 'y' || *line == 'Y' ) {
585 if ( *line == 'n' || *line == 'N' ) {
591 fprintf(stdout, "Invalid string. Must start with yY or nN\n");
602 /* parse int out of a string or prompt for it */
603 long Parser_intarg(const char *inp, const char *prompt, int deft,
604 int min, int max, int base)
609 rc = Parser_arg2int(inp, &result, base);
614 return Parser_getint(prompt, deft, min, max, base);
618 /* parse int out of a string or prompt for it */
619 char *Parser_strarg(char *inp, const char *prompt, const char *deft,
620 char *answer, int len)
622 if ( inp == NULL || *inp == '\0' ) {
623 return Parser_getstr(prompt, deft, answer, len);
628 /* change a string into a number: return 0 on success. No invalid characters
629 allowed. The processing of base and validity follows strtol(3)*/
630 int Parser_arg2int(const char *inp, long *result, int base)
634 if ( (base !=0) && (base < 2 || base > 36) )
637 *result = strtol(inp, &endptr, base);
639 if ( *inp != '\0' && *endptr == '\0' )
645 int Parser_quit(int argc, char **argv)