lustre/utils/parser.c

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * Copyright (C) 2001 Cluster File Systems, Inc.
   5  *
   6  *   This file is part of Lustre, http://www.sf.net/projects/lustre/
   7  *
   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.
  11  *
  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.
  16  *
  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.
  20  *
  21  */
  22 #include <stdio.h>
  23 #include <stdlib.h>
  24 #include <ctype.h>
  25 #include <string.h>
  26 #include <stddef.h>
  27 #include <sys/param.h>
  28 #include <assert.h>
  29
  30 #define READLINE_LIBRARY
  31 #include <readline/readline.h>
  32
  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 *);
  37
  38 #include "parser.h"
  39 #define CMD_COMPLETE 0
  40 #define CMD_INCOMPLETE 1
  41 #define CMD_NONE 2
  42 #define CMD_AMBIG 3
  43
  44 static command_t * top_level;           /* Top level of commands, initialized by
  45                                     * InitParser                              */
  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   */
  49
  50
  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);
  59
  60 static char * skipwhitespace(char * s)
  61 {
  62         char * t;
  63         int    len;
  64
  65         len = (int)strlen(s);
  66         for (t = s; t <= s + len && isspace(*t); t++);
  67         return(t);
  68 }
  69
  70
  71 static char * skiptowhitespace(char * s)
  72 {
  73         char * t;
  74
  75         for (t = s; *t && !isspace(*t); t++);
  76         return(t);
  77 }
  78
  79 static int line2args(char *line, char **argv, int maxargs)
  80 {
  81         char *arg;
  82         int i = 0;
  83
  84         arg = strtok(line, " \t");
  85         if ( arg ) {
  86                 argv[i] = arg;
  87                 i++;
  88         } else
  89                 return 0;
  90
  91         while( (arg = strtok(NULL, " \t")) && (i <= maxargs)) {
  92                 argv[i] = arg;
  93                 i++;
  94         }
  95         return i;
  96 }
  97
  98 /* find a command -- return it if unique otherwise print alternatives */
  99
 100 static command_t *Parser_findargcmd(char *name, command_t cmds[])
 101 {
 102         command_t *cmd;
 103         int i;
 104
 105         for (i = 0; cmds[i].pc_name; i++) {
 106                 cmd = &cmds[i];
 107
 108                 if (strlen(name) != strlen(cmd->pc_name))
 109                         continue;
 110
 111                 if (strlen(name) == strlen(cmd->pc_name)) {
 112                         if (strcmp(name, cmd->pc_name) == 0)
 113                                 return cmd;
 114                         else
 115                                 continue;
 116                 }
 117
 118         }
 119         return NULL;
 120 }
 121
 122 int Parser_execarg(int argc, char **argv, command_t cmds[])
 123 {
 124         command_t *cmd;
 125         int i;
 126
 127         cmd = Parser_findargcmd(argv[0], cmds);
 128         if ( cmd ) {
 129                 return (cmd->pc_func)(argc, argv);
 130         } else {
 131                 printf("Try interactive use without arguments or use one of: ");
 132                 for (i=0 ; cmds[i].pc_name ; i++) {
 133                         cmd = &cmds[i];
 134                         printf("\"%s\" ", cmd->pc_name);
 135                 }
 136                 printf("as argument.\n");
 137         }
 138         return -1;
 139 }
 140
 141 /* returns the command_t * (NULL if not found) corresponding to a
 142    _partial_ match with the first token in name.  It sets *next to
 143    point to the following token. Does not modify *name. */
 144 static command_t * find_cmd(char * name, command_t cmds[], char ** next)
 145 {
 146         int    i, len;
 147
 148         if (!cmds || !name )
 149                 return NULL;
 150
 151         /* This sets name to point to the first non-white space character,
 152            and next to the first whitespace after name, len to the length: do
 153            this with strtok*/
 154         name = skipwhitespace(name);
 155         *next = skiptowhitespace(name);
 156         len = *next - name;
 157         if (len == 0)
 158                 return NULL;
 159
 160         for (i = 0; cmds[i].pc_name; i++) {
 161                 if (strncasecmp(name, cmds[i].pc_name, len) == 0) {
 162                         *next = skipwhitespace(*next);
 163                         return(&cmds[i]);
 164                 }
 165         }
 166         return NULL;
 167 }
 168
 169 /* Recursively process a command line string s and find the command
 170    corresponding to it. This can be ambiguous, full, incomplete,
 171    non-existent. */
 172 static int process(char *s, char ** next, command_t *lookup,
 173                    command_t **result, char **prev)
 174 {
 175         *result = find_cmd(s, lookup, next);
 176         *prev = s;
 177
 178         /* non existent */
 179         if ( ! *result )
 180                 return CMD_NONE;
 181
 182         /* found entry: is it ambigous, i.e. not exact command name and
 183            more than one command in the list matches.  Note that find_cmd
 184            points to the first ambiguous entry */
 185         if ( strncasecmp(s, (*result)->pc_name, strlen((*result)->pc_name)) &&
 186              find_cmd(s, (*result) + 1, next))
 187                 return CMD_AMBIG;
 188
 189         /* found a unique command: component or full? */
 190         if ( (*result)->pc_func ) {
 191                 return CMD_COMPLETE;
 192         } else {
 193                 if ( *next == '\0' ) {
 194                         return CMD_INCOMPLETE;
 195                 } else {
 196                         return process(*next, next, (*result)->pc_sub_cmd, result, prev);
 197                 }
 198         }
 199 }
 200
 201 static char * command_generator(const char * text, int state)
 202 {
 203         static int index,
 204                 len;
 205         char       *name;
 206
 207         /* Do we have a match table? */
 208         if (!match_tbl)
 209                 return NULL;
 210
 211         /* If this is the first time called on this word, state is 0 */
 212         if (!state) {
 213                 index = 0;
 214                 len = (int)strlen(text);
 215         }
 216
 217         /* Return the next name in the command list that paritally matches test */
 218         while ( (name = (match_tbl + index)->pc_name) ) {
 219                 index++;
 220
 221                 if (strncasecmp(name, text, len) == 0) {
 222                         return(strdup(name));
 223                 }
 224         }
 225
 226         /* No more matches */
 227         return NULL;
 228 }
 229
 230 /* probably called by readline */
 231 static char **command_completion(char * text, int start, int end)
 232 {
 233         command_t         * table;
 234         char        * pos;
 235
 236         match_tbl = top_level;
 237         for (table = find_cmd(rl_line_buffer, match_tbl, &pos);
 238              table;
 239              table = find_cmd(pos, match_tbl, &pos)) {
 240
 241                 if (*(pos - 1) == ' ') match_tbl = table->pc_sub_cmd;
 242         }
 243
 244         return(completion_matches(text, command_generator));
 245 }
 246
 247 /* take a string and execute the function or print help */
 248 int execute_line(char * line)
 249 {
 250         command_t         *cmd, *ambig;
 251         char *prev;
 252         char *next, *tmp;
 253         char *argv[MAXARGS];
 254         int         i;
 255         int rc = 0;
 256
 257         switch( process(line, &next, top_level, &cmd, &prev) ) {
 258         case CMD_AMBIG:
 259                 fprintf(stderr, "Ambiguous command \'%s\'\nOptions: ", line);
 260                 while( (ambig = find_cmd(prev, cmd, &tmp)) ) {
 261                         fprintf(stderr, "%s ", ambig->pc_name);
 262                         cmd = ambig + 1;
 263                 }
 264                 fprintf(stderr, "\n");
 265                 break;
 266         case CMD_NONE:
 267                 fprintf(stderr, "No such command, type help\n");
 268                 break;
 269         case CMD_INCOMPLETE:
 270                 fprintf(stderr,
 271                         "'%s' incomplete command.  Use '%s x' where x is one of:\n",
 272                         line, line);
 273                 fprintf(stderr, "\t");
 274                 for (i = 0; cmd->pc_sub_cmd[i].pc_name; i++) {
 275                         fprintf(stderr, "%s ", cmd->pc_sub_cmd[i].pc_name);
 276                 }
 277                 fprintf(stderr, "\n");
 278                 break;
 279         case CMD_COMPLETE:
 280                 i = line2args(line, argv, MAXARGS);
 281                 rc = (cmd->pc_func)(i, argv);
 282                 break;
 283         }
 284
 285         return rc;
 286 }
 287
 288 /* this is the command execution machine */
 289 int Parser_commands(void)
 290 {
 291         char *line, *s;
 292         int rc = 0;
 293
 294         using_history();
 295         stifle_history(HISTORY);
 296
 297         rl_attempted_completion_function =
 298                 (CPPFunction *)command_completion;
 299         rl_completion_entry_function = (void *)command_generator;
 300
 301         while(!done) {
 302                 line = readline(parser_prompt);
 303
 304                 if (!line) break;
 305
 306                 s = skipwhitespace(line);
 307
 308                 if (*s) {
 309                         add_history(s);
 310                         rc = execute_line(s);
 311                 }
 312
 313                 free(line);
 314         }
 315         return rc;
 316 }
 317
 318
 319 /* sets the parser prompt */
 320 void Parser_init(char * prompt, command_t * cmds)
 321 {
 322         done = 0;
 323         top_level = cmds;
 324         if (parser_prompt) free(parser_prompt);
 325         parser_prompt = strdup(prompt);
 326 }
 327
 328 /* frees the parser prompt */
 329 void Parser_exit(int argc, char *argv[])
 330 {
 331         done = 1;
 332         free(parser_prompt);
 333         parser_prompt = NULL;
 334 }
 335
 336 /* convert a string to an integer */
 337 int Parser_int(char *s, int *val)
 338 {
 339         int ret;
 340
 341         if (*s != '0')
 342                 ret = sscanf(s, "%d", val);
 343         else if (*(s+1) != 'x')
 344                 ret = sscanf(s, "%o", val);
 345         else {
 346                 s++;
 347                 ret = sscanf(++s, "%x", val);
 348         }
 349
 350         return(ret);
 351 }
 352
 353
 354
 355 void Parser_qhelp(int argc, char *argv[]) {
 356
 357         printf("Available commands are:\n");
 358
 359         print_commands(NULL, top_level);
 360         printf("For more help type: help command-name\n");
 361 }
 362
 363 int Parser_help(int argc, char **argv)
 364 {
 365         char line[1024];
 366         char *next, *prev, *tmp;
 367         command_t *result, *ambig;
 368         int i;
 369
 370         if ( argc == 1 ) {
 371                 Parser_qhelp(argc, argv);
 372                 return 0;
 373         }
 374
 375         line[0]='\0';
 376         for ( i = 1 ;  i < argc ; i++ ) {
 377                 strcat(line, argv[i]);
 378         }
 379
 380         switch ( process(line, &next, top_level, &result, &prev) ) {
 381         case CMD_COMPLETE:
 382                 fprintf(stderr, "%s: %s\n",line, result->pc_help);
 383                 break;
 384         case CMD_NONE:
 385                 fprintf(stderr, "%s: Unknown command.\n", line);
 386                 break;
 387         case CMD_INCOMPLETE:
 388                 fprintf(stderr,
 389                         "'%s' incomplete command.  Use '%s x' where x is one of:\n",
 390                         line, line);
 391                 fprintf(stderr, "\t");
 392                 for (i = 0; result->pc_sub_cmd[i].pc_name; i++) {
 393                         fprintf(stderr, "%s ", result->pc_sub_cmd[i].pc_name);
 394                 }
 395                 fprintf(stderr, "\n");
 396                 break;
 397         case CMD_AMBIG:
 398                 fprintf(stderr, "Ambiguous command \'%s\'\nOptions: ", line);
 399                 while( (ambig = find_cmd(prev, result, &tmp)) ) {
 400                         fprintf(stderr, "%s ", ambig->pc_name);
 401                         result = ambig + 1;
 402                 }
 403                 fprintf(stderr, "\n");
 404                 break;
 405         }
 406         return 0;
 407 }
 408
 409 /*************************************************************************
 410  * COMMANDS                                                                 *
 411  *************************************************************************/
 412
 413
 414 static void print_commands(char * str, command_t * table) {
 415         command_t * cmds;
 416         char         buf[80];
 417
 418         for (cmds = table; cmds->pc_name; cmds++) {
 419                 if (cmds->pc_func) {
 420                         if (str) printf("\t%s %s\n", str, cmds->pc_name);
 421                         else printf("\t%s\n", cmds->pc_name);
 422                 }
 423                 if (cmds->pc_sub_cmd) {
 424                         if (str) {
 425                                 sprintf(buf, "%s %s", str, cmds->pc_name);
 426                                 print_commands(buf, cmds->pc_sub_cmd);
 427                         } else {
 428                                 print_commands(cmds->pc_name, cmds->pc_sub_cmd);
 429                         }
 430                 }
 431         }
 432 }
 433
 434 char *Parser_getstr(const char *prompt, const char *deft, char *res,
 435                     size_t len)
 436 {
 437         char *line = NULL;
 438         int size = strlen(prompt) + strlen(deft) + 8;
 439         char *theprompt;
 440         theprompt = malloc(size);
 441         assert(theprompt);
 442
 443         sprintf(theprompt, "%s [%s]: ", prompt, deft);
 444
 445         line  = readline(theprompt);
 446         free(theprompt);
 447
 448         if ( line == NULL || *line == '\0' ) {
 449                 strncpy(res, deft, len);
 450         } else {
 451                 strncpy(res, line, len);
 452         }
 453
 454         if ( line ) {
 455                 free(line);
 456                 return res;
 457         } else {
 458                 return NULL;
 459         }
 460 }
 461
 462 /* get integer from prompt, loop forever to get it */
 463 int Parser_getint(const char *prompt, long min, long max, long deft, int base)
 464 {
 465         int rc;
 466         long result;
 467         char *line;
 468         int size = strlen(prompt) + 40;
 469         char *theprompt = malloc(size);
 470         assert(theprompt);
 471         sprintf(theprompt,"%s [%ld, (0x%lx)]: ", prompt, deft, deft);
 472
 473         fflush(stdout);
 474
 475         do {
 476                 line = NULL;
 477                 line = readline(theprompt);
 478                 if ( !line ) {
 479                         fprintf(stdout, "Please enter an integer.\n");
 480                         fflush(stdout);
 481                         continue;
 482                 }
 483                 if ( *line == '\0' ) {
 484                         free(line);
 485                         result =  deft;
 486                         break;
 487                 }
 488                 rc = Parser_arg2int(line, &result, base);
 489                 free(line);
 490                 if ( rc != 0 ) {
 491                         fprintf(stdout, "Invalid string.\n");
 492                         fflush(stdout);
 493                 } else if ( result > max || result < min ) {
 494                         fprintf(stdout, "Error: response must lie between %ld and %ld.\n",
 495                                 min, max);
 496                         fflush(stdout);
 497                 } else {
 498                         break;
 499                 }
 500         } while ( 1 ) ;
 501
 502         if (theprompt)
 503                 free(theprompt);
 504         return result;
 505
 506 }
 507
 508 /* get boolean (starting with YyNn; loop forever */
 509 int Parser_getbool(const char *prompt, int deft)
 510 {
 511         int result = 0;
 512         char *line;
 513         int size = strlen(prompt) + 8;
 514         char *theprompt = malloc(size);
 515         assert(theprompt);
 516
 517         fflush(stdout);
 518
 519         if ( deft != 0 && deft != 1 ) {
 520                 fprintf(stderr, "Error: Parser_getbool given bad default (%d).\n",
 521                         deft);
 522                 assert ( 0 );
 523         }
 524         sprintf(theprompt, "%s [%s]: ", prompt, (deft==0)? "N" : "Y");
 525
 526         do {
 527                 line = NULL;
 528                 line = readline(theprompt);
 529                 if ( line == NULL ) {
 530                         result = deft;
 531                         break;
 532                 }
 533                 if ( *line == '\0' ) {
 534                         result = deft;
 535                         break;
 536                 }
 537                 if ( *line == 'y' || *line == 'Y' ) {
 538                         result = 1;
 539                         break;
 540                 }
 541                 if ( *line == 'n' || *line == 'N' ) {
 542                         result = 0;
 543                         break;
 544                 }
 545                 if ( line )
 546                         free(line);
 547                 fprintf(stdout, "Invalid string. Must start with yY or nN\n");
 548                 fflush(stdout);
 549         } while ( 1 );
 550
 551         if ( line )
 552                 free(line);
 553         if ( theprompt )
 554                 free(theprompt);
 555         return result;
 556 }
 557
 558 /* parse int out of a string or prompt for it */
 559 long Parser_intarg(const char *inp, const char *prompt, int deft,
 560                    int min, int max, int base)
 561 {
 562         long result;
 563         int rc;
 564
 565         rc = Parser_arg2int(inp, &result, base);
 566
 567         if ( rc == 0 ) {
 568                 return result;
 569         } else {
 570                 return Parser_getint(prompt, deft, min, max, base);
 571         }
 572 }
 573
 574 /* parse int out of a string or prompt for it */
 575 char *Parser_strarg(char *inp, const char *prompt, const char *deft,
 576                     char *answer, int len)
 577 {
 578
 579         if ( inp == NULL || *inp == '\0' ) {
 580                 return Parser_getstr(prompt, deft, answer, len);
 581         } else
 582                 return inp;
 583 }
 584
 585 /* change a string into a number: return 0 on success. No invalid characters
 586    allowed. The processing of base and validity follows strtol(3)*/
 587 int Parser_arg2int(const char *inp, long *result, int base)
 588 {
 589         char *endptr;
 590
 591         if ( (base !=0) && (base < 2 || base > 36) )
 592                 return 1;
 593
 594         *result = strtol(inp, &endptr, base);
 595
 596         if ( *inp != '\0' && *endptr == '\0' )
 597                 return 0;
 598         else
 599                 return 1;
 600 }
 601
 602 int Parser_quit(int argc, char **argv)
 603 {
 604         argc = argc;
 605         argv = argv;
 606         done = 1;
 607         return 0;
 608 }