Commit | Line | Data |
---|---|---|
fb40c209 | 1 | /* MI Option Parser. |
9b254dd1 | 2 | Copyright (C) 2000, 2007, 2008 Free Software Foundation, Inc. |
ab91fdd5 | 3 | Contributed by Cygnus Solutions (a Red Hat company). |
fb40c209 AC |
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 | |
a9762ec7 | 9 | the Free Software Foundation; either version 3 of the License, or |
fb40c209 AC |
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 | |
a9762ec7 | 18 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
fb40c209 AC |
19 | |
20 | #ifndef MI_GETOPT_H | |
21 | #define MI_GETOPT_H | |
22 | ||
23 | /* Like getopt() but with simpler semantics. | |
24 | ||
25 | An option has the form ``-<name>''. The special option ``--'' | |
26 | denotes the end of the option list. An option can be followed by a | |
27 | separate argument (on a per option basis). | |
28 | ||
29 | On entry OPTIND contains the index of the next element of ARGV that | |
30 | needs parsing. OPTIND is updated to indicate the index of the next | |
31 | argument before mi_getopt() returns. | |
32 | ||
33 | If ARGV[OPTIND] is an option, that options INDEX is returned. | |
34 | OPTARG is set to the options argument or NULL. OPTIND is updated. | |
35 | ||
36 | If ARGV[OPTIND] is not an option, -1 is returned and OPTIND updated | |
37 | to specify the non-option argument. OPTARG is set to NULL. | |
38 | ||
39 | mi_getopt() calls ``error("%s: Unknown option %c", prefix, | |
40 | option)'' if an unknown option is encountered. */ | |
41 | ||
42 | struct mi_opt; | |
43 | extern int mi_getopt (const char *prefix, int argc, char **argv, | |
44 | struct mi_opt *opt, int *optind, char **optarg); | |
45 | ||
46 | /* The option list. Terminated by NAME==NULL. ARG_P that the option | |
47 | requires an argument. INDEX is returned to identify th option. */ | |
48 | ||
49 | struct mi_opt | |
50 | { | |
51 | const char *name; | |
52 | int index; | |
53 | int arg_p; | |
54 | }; | |
55 | ||
56 | struct mi_opt; | |
57 | ||
1abaf70c BR |
58 | /* mi_valid_noargs |
59 | ||
60 | Determines if ARGC/ARGV are a valid set of parameters to satisfy | |
61 | an MI function that is not supposed to recieve any arguments. | |
62 | ||
63 | An MI function that should not recieve 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 | ||
fb40c209 | 78 | #endif |