GDB (xrefs)

mi-getopt.h
Go to the documentation of this file.
1 /* MI Option Parser.
2 Copyright (C) 2000-2018 Free Software Foundation, Inc.
3 Contributed by Cygnus Solutions (a Red Hat company).
4
5 This file is part of GDB.
6
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
11
12 This program 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 this program. If not, see <http://www.gnu.org/licenses/>. */
19
20 #ifndef MI_GETOPT_H
21 #define MI_GETOPT_H
22
23 /* The option list. Terminated by NAME==NULL. ARG_P that the option
24 requires an argument. INDEX is returned to identify the option. */
25
26 struct mi_opt
27 {
28 const char *name;
29 int index;
30 int arg_p;
31 };
32
33 /* Like getopt() but with simpler semantics.
34
35 An option has the form ``-<name>''. The special option ``--''
36 denotes the end of the option list. An option can be followed by a
37 separate argument (on a per option basis).
38
39 On entry OPTIND contains the index of the next element of ARGV that
40 needs parsing. OPTIND is updated to indicate the index of the next
41 argument before mi_getopt() returns.
42
43 If ARGV[OPTIND] is an option, that options INDEX is returned.
44 OPTARG is set to the options argument or NULL. OPTIND is updated.
45
46 If ARGV[OPTIND] is not an option, -1 is returned and OPTIND updated
47 to specify the non-option argument. OPTARG is set to NULL.
48
49 If an unknown option is encountered, mi_getopt() calls
50 ``error("%s: Unknown option %c", prefix, option)'' while
51 mi_getopt_allow_unknown returns -1. */
52
53 extern int mi_getopt (const char *prefix, int argc, char **argv,
54 const struct mi_opt *opt, int *optind, char **optarg);
55 extern int mi_getopt_allow_unknown (const char *prefix, int argc,
56 char **argv, const struct mi_opt *opts,
57 int *oind, char **oarg);
58
59 /* mi_valid_noargs determines if ARGC/ARGV are a valid set of
60 parameters to satisfy an MI function that is not supposed to
61 recieve any arguments.
62
63 An MI function that should not receive arguments can still be
64 passed parameters after the special option '--' such as below.
65
66 Example: The MI function -exec-run takes no args.
67 However, the client may pass '-exec-run -- -a ...'
68 See PR-783
69
70 PREFIX is passed to mi_getopt for an error message.
71
72 This function Returns 1 if the parameter pair ARGC/ARGV are valid
73 for an MI function that takes no arguments. Otherwise, it returns 0
74 and the appropriate error message is displayed by mi_getopt. */
75
76 extern int mi_valid_noargs (const char *prefix, int argc, char **argv);
77
78 #endif
mi_opt::name
const char * name
Definition: mi-getopt.h:28
mi_opt::arg_p
int arg_p
Definition: mi-getopt.h:30
mi_getopt
int mi_getopt(const char *prefix, int argc, char **argv, const struct mi_opt *opt, int *optind, char **optarg)
Definition: mi-getopt.c:83
mi_valid_noargs
int mi_valid_noargs(const char *prefix, int argc, char **argv)
Definition: mi-getopt.c:99
mi_opt::index
int index
Definition: mi-getopt.h:29
gdb.argv
argv
Definition: __init__.py:63
mi_getopt_allow_unknown
int mi_getopt_allow_unknown(const char *prefix, int argc, char **argv, const struct mi_opt *opts, int *oind, char **oarg)
Definition: mi-getopt.c:92
mi_opt
Definition: mi-getopt.h:26