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.
27 #include <sys/param.h>
30 #define READLINE_LIBRARY
31 #include <readline/readline.h>
33 //extern char **completion_matches __P((char *, rl_compentry_func_t *));
34 extern void using_history(void);
35 extern void stifle_history(int);
36 extern void add_history(char *);
39 #define CMD_COMPLETE 0
40 #define CMD_INCOMPLETE 1
44 static command_t * top_level; /* Top level of commands, initialized by
46 static command_t * match_tbl; /* Command completion against this table */
47 static char * parser_prompt = NULL;/* Parser prompt, set by InitParser */
48 static int done; /* Set to 1 if user types exit or quit */
51 /* static functions */
52 static char *skipwhitespace(char *s);
53 static char *skiptowhitespace(char *s);
54 static command_t *find_cmd(char *name, command_t cmds[], char **next);
55 static int process(char *s, char **next, command_t *lookup, command_t **result, char **prev);
56 static char *command_generator(const char *text, int state);
57 static char **command_completion(char *text, int start, int end);
58 static void print_commands(char *str, command_t *table);
60 static char * skipwhitespace(char * s)
66 for (t = s; t <= s + len && isspace(*t); t++);
71 static char * skiptowhitespace(char * s)
75 for (t = s; *t && !isspace(*t); t++);
79 static int line2args(char *line, char **argv, int maxargs)
84 arg = strtok(line, " \t");
91 while( (arg = strtok(NULL, " \t")) && (i <= maxargs)) {
98 /* find a command -- return it if unique otherwise print alternatives */
99 static command_t *Parser_findargcmd(char *name, command_t cmds[])
103 for (cmd = cmds; cmd->pc_name; cmd++) {
104 if (strcmp(name, cmd->pc_name) == 0)
110 int Parser_execarg(int argc, char **argv, command_t cmds[])
114 cmd = Parser_findargcmd(argv[0], cmds);
116 return (cmd->pc_func)(argc, argv);
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 static char * command_generator(const char * text, int state)
192 /* Do we have a match table? */
196 /* If this is the first time called on this word, state is 0 */
199 len = (int)strlen(text);
202 /* Return the next name in the command list that paritally matches test */
203 while ( (name = (match_tbl + index)->pc_name) ) {
206 if (strncasecmp(name, text, len) == 0) {
207 return(strdup(name));
211 /* No more matches */
215 /* probably called by readline */
216 static char **command_completion(char * text, int start, int end)
221 match_tbl = top_level;
222 for (table = find_cmd(rl_line_buffer, match_tbl, &pos);
224 table = find_cmd(pos, match_tbl, &pos)) {
226 if (*(pos - 1) == ' ') match_tbl = table->pc_sub_cmd;
229 return(completion_matches(text, command_generator));
232 /* take a string and execute the function or print help */
233 int execute_line(char * line)
235 command_t *cmd, *ambig;
242 switch( process(line, &next, top_level, &cmd, &prev) ) {
244 fprintf(stderr, "Ambiguous command \'%s\'\nOptions: ", line);
245 while( (ambig = find_cmd(prev, cmd, &tmp)) ) {
246 fprintf(stderr, "%s ", ambig->pc_name);
249 fprintf(stderr, "\n");
252 fprintf(stderr, "No such command, type help\n");
256 "'%s' incomplete command. Use '%s x' where x is one of:\n",
258 fprintf(stderr, "\t");
259 for (i = 0; cmd->pc_sub_cmd[i].pc_name; i++) {
260 fprintf(stderr, "%s ", cmd->pc_sub_cmd[i].pc_name);
262 fprintf(stderr, "\n");
265 i = line2args(line, argv, MAXARGS);
266 rc = (cmd->pc_func)(i, argv);
273 /* this is the command execution machine */
274 int Parser_commands(void)
280 stifle_history(HISTORY);
282 rl_attempted_completion_function = (CPPFunction *)command_completion;
283 rl_completion_entry_function = (void *)command_generator;
286 line = readline(parser_prompt);
290 s = skipwhitespace(line);
294 rc = execute_line(s);
303 /* sets the parser prompt */
304 void Parser_init(char * prompt, command_t * cmds)
308 if (parser_prompt) free(parser_prompt);
309 parser_prompt = strdup(prompt);
312 /* frees the parser prompt */
313 void Parser_exit(int argc, char *argv[])
317 parser_prompt = NULL;
320 /* convert a string to an integer */
321 int Parser_int(char *s, int *val)
326 ret = sscanf(s, "%d", val);
327 else if (*(s+1) != 'x')
328 ret = sscanf(s, "%o", val);
331 ret = sscanf(++s, "%x", val);
338 void Parser_qhelp(int argc, char *argv[]) {
340 printf("Available commands are:\n");
342 print_commands(NULL, top_level);
343 printf("For more help type: help command-name\n");
346 int Parser_help(int argc, char **argv)
349 char *next, *prev, *tmp;
350 command_t *result, *ambig;
354 Parser_qhelp(argc, argv);
359 for ( i = 1 ; i < argc ; i++ ) {
360 strcat(line, argv[i]);
363 switch ( process(line, &next, top_level, &result, &prev) ) {
365 fprintf(stderr, "%s: %s\n",line, result->pc_help);
368 fprintf(stderr, "%s: Unknown command.\n", line);
372 "'%s' incomplete command. Use '%s x' where x is one of:\n",
374 fprintf(stderr, "\t");
375 for (i = 0; result->pc_sub_cmd[i].pc_name; i++) {
376 fprintf(stderr, "%s ", result->pc_sub_cmd[i].pc_name);
378 fprintf(stderr, "\n");
381 fprintf(stderr, "Ambiguous command \'%s\'\nOptions: ", line);
382 while( (ambig = find_cmd(prev, result, &tmp)) ) {
383 fprintf(stderr, "%s ", ambig->pc_name);
386 fprintf(stderr, "\n");
392 /*************************************************************************
394 *************************************************************************/
397 static void print_commands(char * str, command_t * table) {
401 for (cmds = table; cmds->pc_name; cmds++) {
403 if (str) printf("\t%s %s\n", str, cmds->pc_name);
404 else printf("\t%s\n", cmds->pc_name);
406 if (cmds->pc_sub_cmd) {
408 sprintf(buf, "%s %s", str, cmds->pc_name);
409 print_commands(buf, cmds->pc_sub_cmd);
411 print_commands(cmds->pc_name, cmds->pc_sub_cmd);
417 char *Parser_getstr(const char *prompt, const char *deft, char *res,
421 int size = strlen(prompt) + strlen(deft) + 8;
423 theprompt = malloc(size);
426 sprintf(theprompt, "%s [%s]: ", prompt, deft);
428 line = readline(theprompt);
431 if ( line == NULL || *line == '\0' ) {
432 strncpy(res, deft, len);
434 strncpy(res, line, len);
445 /* get integer from prompt, loop forever to get it */
446 int Parser_getint(const char *prompt, long min, long max, long deft, int base)
451 int size = strlen(prompt) + 40;
452 char *theprompt = malloc(size);
454 sprintf(theprompt,"%s [%ld, (0x%lx)]: ", prompt, deft, deft);
460 line = readline(theprompt);
462 fprintf(stdout, "Please enter an integer.\n");
466 if ( *line == '\0' ) {
471 rc = Parser_arg2int(line, &result, base);
474 fprintf(stdout, "Invalid string.\n");
476 } else if ( result > max || result < min ) {
477 fprintf(stdout, "Error: response must lie between %ld and %ld.\n",
491 /* get boolean (starting with YyNn; loop forever */
492 int Parser_getbool(const char *prompt, int deft)
496 int size = strlen(prompt) + 8;
497 char *theprompt = malloc(size);
502 if ( deft != 0 && deft != 1 ) {
503 fprintf(stderr, "Error: Parser_getbool given bad default (%d).\n",
507 sprintf(theprompt, "%s [%s]: ", prompt, (deft==0)? "N" : "Y");
511 line = readline(theprompt);
512 if ( line == NULL ) {
516 if ( *line == '\0' ) {
520 if ( *line == 'y' || *line == 'Y' ) {
524 if ( *line == 'n' || *line == 'N' ) {
530 fprintf(stdout, "Invalid string. Must start with yY or nN\n");
541 /* parse int out of a string or prompt for it */
542 long Parser_intarg(const char *inp, const char *prompt, int deft,
543 int min, int max, int base)
548 rc = Parser_arg2int(inp, &result, base);
553 return Parser_getint(prompt, deft, min, max, base);
557 /* parse int out of a string or prompt for it */
558 char *Parser_strarg(char *inp, const char *prompt, const char *deft,
559 char *answer, int len)
561 if ( inp == NULL || *inp == '\0' ) {
562 return Parser_getstr(prompt, deft, answer, len);
567 /* change a string into a number: return 0 on success. No invalid characters
568 allowed. The processing of base and validity follows strtol(3)*/
569 int Parser_arg2int(const char *inp, long *result, int base)
573 if ( (base !=0) && (base < 2 || base > 36) )
576 *result = strtol(inp, &endptr, base);
578 if ( *inp != '\0' && *endptr == '\0' )
584 int Parser_quit(int argc, char **argv)