4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2014, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * libcfs/include/libcfs/util/parser.h
38 * A command line parser.
45 #define HISTORY 100 /* Don't let history grow unbounded */
48 #define CMD_COMPLETE 0
49 #define CMD_INCOMPLETE 1
54 typedef struct parser_cmd {
56 int (* pc_func)(int, char **);
57 struct parser_cmd * pc_sub_cmd;
61 typedef struct argcmd {
63 int (*ac_func)(int, char **);
67 typedef struct network {
73 int Parser_quit(int argc, char **argv);
74 int Parser_version(int argc, char **argv);
75 void Parser_init(char *, command_t *); /* Set prompt and load command list */
76 int Parser_commands(void); /* Start the command parser */
77 void Parser_qhelp(int, char **); /* Quick help routine */
78 int Parser_help(int, char **); /* Detailed help routine */
79 void Parser_ignore_errors(int ignore); /* Set the ignore errors flag */
80 void Parser_printhelp(char *); /* Detailed help routine */
81 void Parser_exit(int, char **); /* Shuts down command parser */
82 int Parser_execarg(int argc, char **argv, command_t cmds[]);
83 int execute_line(char * line);
85 /* Converts a string to an integer */
86 int Parser_int(char *, int *);
88 /* Prompts for a string, with default values and a maximum length */
89 char *Parser_getstr(const char *prompt, const char *deft, char *res,
92 /* Prompts for an integer, with minimum, maximum and default values and base */
93 int Parser_getint(const char *prompt, long min, long max, long deft,
96 /* Prompts for a yes/no, with default */
97 int Parser_getbool(const char *prompt, int deft);
99 /* Extracts an integer from a string, or prompts if it cannot get one */
100 long Parser_intarg(const char *inp, const char *prompt, int deft,
101 int min, int max, int base);
103 /* Extracts a word from the input, or propmts if it cannot get one */
104 char *Parser_strarg(char *inp, const char *prompt, const char *deft,
105 char *answer, int len);
107 /* Extracts an integer from a string with a base */
108 int Parser_arg2int(const char *inp, long *result, int base);
110 /* Convert human readable size string to and int; "1k" -> 1000 */
111 int Parser_size(int *sizep, char *str);
113 /* Convert a string boolean to an int; "enable" -> 1 */
114 int Parser_bool(int *b, char *str);