17cdd842b2f0936e34f102d80ccd8b557b34fdf2
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 #include "completer.h"
25 struct cmd_list_element
;
27 /* *PP is a string denoting a number. Get the number. Advance *PP
28 after the string and any trailing whitespace.
30 The string can either be a number, or "$" followed by the name of a
31 convenience variable, or ("$" or "$$") followed by digits.
33 TRAILER is a character which can be found after the number; most
34 commonly this is `-'. If you don't want a trailer, use \0. */
36 extern int get_number_trailer (const char **pp
, int trailer
);
38 /* Convenience. Like get_number_trailer, but with no TRAILER. */
40 extern int get_number (const char **);
42 /* Like the above, but takes a non-const "char **". */
44 extern int get_number (char **);
46 /* Like get_number_trailer, but works with ULONGEST, and throws on
47 error instead of returning 0. */
48 extern ULONGEST
get_ulongest (const char **pp
, int trailer
= '\0');
50 /* Structure to hold the values of the options used by the 'info
51 variables' command and other similar commands. These correspond to the
54 struct info_print_options
57 char *type_regexp
= nullptr;
59 ~info_print_options ()
65 /* Extract options from ARGS for commands like 'info variables', placing
66 the options into OPTS. ARGS is updated to point to the first character
67 after the options, or, if there is nothing after the options, then ARGS
70 extern void extract_info_print_options (info_print_options
*opts
,
73 /* Function that can be used as a command completer for 'info variable'
74 and friends. This offers command option completion as well as symbol
75 completion. At the moment all symbols are offered for all commands. */
77 extern void info_print_command_completer (struct cmd_list_element
*ignore
,
78 completion_tracker
&tracker
,
80 const char * /* word */);
82 /* Throws an error telling the user that ARGS starts with an option
83 unrecognized by COMMAND. */
85 extern void report_unrecognized_option_error (const char *command
,
89 /* Builds the help string for a command documented by PREFIX,
90 followed by the extract_info_print_args help for ENTITY_KIND. */
92 const char *info_print_args_help (const char *prefix
,
93 const char *entity_kind
);
95 /* Parse a number or a range.
96 A number will be of the form handled by get_number.
97 A range will be of the form <number1> - <number2>, and
98 will represent all the integers between number1 and number2,
101 class number_or_range_parser
104 /* Default construction. Must call init before calling
106 number_or_range_parser () {}
108 /* Calls init automatically. */
109 number_or_range_parser (const char *string
);
111 /* STRING is the string to be parsed. */
112 void init (const char *string
);
114 /* While processing a range, this fuction is called iteratively; At
115 each call it will return the next value in the range.
117 At the beginning of parsing a range, the char pointer
118 STATE->m_cur_tok will be advanced past <number1> and left
119 pointing at the '-' token. Subsequent calls will not advance the
120 pointer until the range is completed. The call that completes
121 the range will advance the pointer past <number2>. */
124 /* Setup internal state such that get_next() returns numbers in the
125 START_VALUE to END_VALUE range. END_PTR is where the string is
126 advanced to when get_next() returns END_VALUE. */
127 void setup_range (int start_value
, int end_value
,
128 const char *end_ptr
);
130 /* Returns true if parsing has completed. */
131 bool finished () const;
133 /* Return the string being parsed. When parsing has finished, this
134 points past the last parsed token. */
135 const char *cur_tok () const
136 { return m_cur_tok
; }
138 /* True when parsing a range. */
139 bool in_range () const
140 { return m_in_range
; }
142 /* When parsing a range, the final value in the range. */
143 int end_value () const
144 { return m_end_value
; }
146 /* When parsing a range, skip past the final token in the range. */
149 gdb_assert (m_in_range
);
150 m_cur_tok
= m_end_ptr
;
155 /* No need for these. They are intentionally not defined anywhere. */
156 number_or_range_parser (const number_or_range_parser
&);
157 number_or_range_parser
&operator= (const number_or_range_parser
&);
159 /* The string being parsed. When parsing has finished, this points
160 past the last parsed token. */
161 const char *m_cur_tok
;
163 /* Last value returned. */
166 /* When parsing a range, the final value in the range. */
169 /* When parsing a range, a pointer past the final token in the
171 const char *m_end_ptr
;
173 /* True when parsing a range. */
177 /* Accept a number and a string-form list of numbers such as is
178 accepted by get_number_or_range. Return TRUE if the number is
181 By definition, an empty list includes all numbers. This is to
182 be interpreted as typing a command such as "delete break" with
185 extern int number_is_in_list (const char *list
, int number
);
187 /* Reverse S to the last non-whitespace character without skipping past
190 extern const char *remove_trailing_whitespace (const char *start
,
193 /* Same, for non-const S. */
196 remove_trailing_whitespace (const char *start
, char *s
)
198 return (char *) remove_trailing_whitespace (start
, (const char *) s
);
201 /* A helper function to extract an argument from *ARG. An argument is
202 delimited by whitespace. The return value is empty if no argument
205 extern std::string
extract_arg (char **arg
);
207 /* A const-correct version of the above. */
209 extern std::string
extract_arg (const char **arg
);
211 /* A helper function that looks for an argument at the start of a
212 string. The argument must also either be at the end of the string,
213 or be followed by whitespace. Returns 1 if it finds the argument,
214 0 otherwise. If the argument is found, it updates *STR to point
215 past the argument and past any whitespace following the
217 extern int check_for_argument (const char **str
, const char *arg
, int arg_len
);
219 /* Same as above, but ARG's length is computed. */
222 check_for_argument (const char **str
, const char *arg
)
224 return check_for_argument (str
, arg
, strlen (arg
));
227 /* Same, for non-const STR. */
230 check_for_argument (char **str
, const char *arg
, int arg_len
)
232 return check_for_argument (const_cast<const char **> (str
),
237 check_for_argument (char **str
, const char *arg
)
239 return check_for_argument (str
, arg
, strlen (arg
));
242 /* qcs_flags struct groups the -q, -c, and -s flags parsed by "thread
243 apply" and "frame apply" commands */
252 /* Validate FLAGS. Throws an error if both FLAGS->CONT and
253 FLAGS->SILENT are true. WHICH_COMMAND is included in the error
255 extern void validate_flags_qcs (const char *which_command
, qcs_flags
*flags
);
257 #endif /* CLI_CLI_UTILS_H */
This page took 0.046291 seconds and 4 git commands to generate.