3 Copyright (C) 2011-2019 Free Software Foundation, Inc.
5 This file is part of GDB.
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.
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.
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/>. */
20 #ifndef CLI_CLI_UTILS_H
21 #define CLI_CLI_UTILS_H
23 /* *PP is a string denoting a number. Get the number. Advance *PP
24 after the string and any trailing whitespace.
26 The string can either be a number, or "$" followed by the name of a
27 convenience variable, or ("$" or "$$") followed by digits.
29 TRAILER is a character which can be found after the number; most
30 commonly this is `-'. If you don't want a trailer, use \0. */
32 extern int get_number_trailer (const char **pp
, int trailer
);
34 /* Convenience. Like get_number_trailer, but with no TRAILER. */
36 extern int get_number (const char **);
38 /* Like the above, but takes a non-const "char **". */
40 extern int get_number (char **);
42 /* Like get_number_trailer, but works with ULONGEST, and throws on
43 error instead of returning 0. */
44 extern ULONGEST
get_ulongest (const char **pp
, int trailer
= '\0');
46 /* Extract from ARGS the arguments [-q] [-t TYPEREGEXP] [--] NAMEREGEXP.
48 The caller is responsible to initialize *QUIET to false, *REGEXP
50 extract_info_print_args can then be called iteratively to search
51 for valid arguments, as part of a 'main parsing loop' searching for
52 -q/-t/-- arguments together with other flags and options.
54 Returns true and updates *ARGS + one of *QUIET, *REGEXP, *T_REGEXP if
55 it finds a valid argument.
56 Returns false if no valid argument is found at the beginning of ARGS. */
58 extern bool extract_info_print_args (const char **args
,
61 std::string
*t_regexp
);
63 /* Throws an error telling the user that ARGS starts with an option
64 unrecognized by COMMAND. */
66 extern void report_unrecognized_option_error (const char *command
,
70 /* Builds the help string for a command documented by PREFIX,
71 followed by the extract_info_print_args help for ENTITY_KIND. */
73 const char *info_print_args_help (const char *prefix
,
74 const char *entity_kind
);
76 /* Parse a number or a range.
77 A number will be of the form handled by get_number.
78 A range will be of the form <number1> - <number2>, and
79 will represent all the integers between number1 and number2,
82 class number_or_range_parser
85 /* Default construction. Must call init before calling
87 number_or_range_parser () {}
89 /* Calls init automatically. */
90 number_or_range_parser (const char *string
);
92 /* STRING is the string to be parsed. */
93 void init (const char *string
);
95 /* While processing a range, this fuction is called iteratively; At
96 each call it will return the next value in the range.
98 At the beginning of parsing a range, the char pointer
99 STATE->m_cur_tok will be advanced past <number1> and left
100 pointing at the '-' token. Subsequent calls will not advance the
101 pointer until the range is completed. The call that completes
102 the range will advance the pointer past <number2>. */
105 /* Setup internal state such that get_next() returns numbers in the
106 START_VALUE to END_VALUE range. END_PTR is where the string is
107 advanced to when get_next() returns END_VALUE. */
108 void setup_range (int start_value
, int end_value
,
109 const char *end_ptr
);
111 /* Returns true if parsing has completed. */
112 bool finished () const;
114 /* Return the string being parsed. When parsing has finished, this
115 points past the last parsed token. */
116 const char *cur_tok () const
117 { return m_cur_tok
; }
119 /* True when parsing a range. */
120 bool in_range () const
121 { return m_in_range
; }
123 /* When parsing a range, the final value in the range. */
124 int end_value () const
125 { return m_end_value
; }
127 /* When parsing a range, skip past the final token in the range. */
130 gdb_assert (m_in_range
);
131 m_cur_tok
= m_end_ptr
;
136 /* No need for these. They are intentionally not defined anywhere. */
137 number_or_range_parser (const number_or_range_parser
&);
138 number_or_range_parser
&operator= (const number_or_range_parser
&);
140 /* The string being parsed. When parsing has finished, this points
141 past the last parsed token. */
142 const char *m_cur_tok
;
144 /* Last value returned. */
147 /* When parsing a range, the final value in the range. */
150 /* When parsing a range, a pointer past the final token in the
152 const char *m_end_ptr
;
154 /* True when parsing a range. */
158 /* Accept a number and a string-form list of numbers such as is
159 accepted by get_number_or_range. Return TRUE if the number is
162 By definition, an empty list includes all numbers. This is to
163 be interpreted as typing a command such as "delete break" with
166 extern int number_is_in_list (const char *list
, int number
);
168 /* Reverse S to the last non-whitespace character without skipping past
171 extern const char *remove_trailing_whitespace (const char *start
,
174 /* Same, for non-const S. */
177 remove_trailing_whitespace (const char *start
, char *s
)
179 return (char *) remove_trailing_whitespace (start
, (const char *) s
);
182 /* A helper function to extract an argument from *ARG. An argument is
183 delimited by whitespace. The return value is empty if no argument
186 extern std::string
extract_arg (char **arg
);
188 /* A const-correct version of the above. */
190 extern std::string
extract_arg (const char **arg
);
192 /* A helper function that looks for an argument at the start of a
193 string. The argument must also either be at the end of the string,
194 or be followed by whitespace. Returns 1 if it finds the argument,
195 0 otherwise. If the argument is found, it updates *STR to point
196 past the argument and past any whitespace following the
198 extern int check_for_argument (const char **str
, const char *arg
, int arg_len
);
200 /* Same as above, but ARG's length is computed. */
203 check_for_argument (const char **str
, const char *arg
)
205 return check_for_argument (str
, arg
, strlen (arg
));
208 /* Same, for non-const STR. */
211 check_for_argument (char **str
, const char *arg
, int arg_len
)
213 return check_for_argument (const_cast<const char **> (str
),
218 check_for_argument (char **str
, const char *arg
)
220 return check_for_argument (str
, arg
, strlen (arg
));
223 /* A helper function that looks for a set of flags at the start of a
224 string. The possible flags are given as a null terminated string.
225 A flag in STR must either be at the end of the string,
226 or be followed by whitespace.
227 Returns 0 if no valid flag is found at the start of STR.
228 Otherwise updates *STR, and returns N (which is > 0),
229 such that FLAGS [N - 1] is the valid found flag. */
230 extern int parse_flags (const char **str
, const char *flags
);
232 /* qcs_flags struct regroups the flags parsed by parse_flags_qcs. */
241 /* A helper function that uses parse_flags to handle the flags qcs :
242 A flag -q sets FLAGS->QUIET to true.
243 A flag -c sets FLAGS->CONT to true.
244 A flag -s sets FLAGS->SILENT to true.
246 The caller is responsible to initialize *FLAGS to false before the (first)
247 call to parse_flags_qcs.
248 parse_flags_qcs can then be called iteratively to search for more
249 valid flags, as part of a 'main parsing loop' searching for -q/-c/-s
250 flags together with other flags and options.
252 Returns true and updates *STR and one of FLAGS->QUIET, FLAGS->CONT,
253 FLAGS->SILENT if it finds a valid flag.
254 Returns false if no valid flag is found at the beginning of STR.
256 Throws an error if a flag is found such that both FLAGS->CONT and
257 FLAGS->SILENT are true. */
259 extern bool parse_flags_qcs (const char *which_command
, const char **str
,
262 #endif /* CLI_CLI_UTILS_H */
This page took 0.035386 seconds and 5 git commands to generate.