/* CLI utilities.
- Copyright (C) 2011-2013 Free Software Foundation, Inc.
+ Copyright (C) 2011-2019 Free Software Foundation, Inc.
This file is part of GDB.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */
-#ifndef CLI_UTILS_H
-#define CLI_UTILS_H
+#ifndef CLI_CLI_UTILS_H
+#define CLI_CLI_UTILS_H
-/* *PP is a string denoting a number. Get the number of the. Advance
- *PP after the string and any trailing whitespace.
+#include "completer.h"
- Currently the string can either be a number, or "$" followed by the
- name of a convenience variable, or ("$" or "$$") followed by digits. */
+struct cmd_list_element;
-extern int get_number (char **);
+/* *PP is a string denoting a number. Get the number. Advance *PP
+ after the string and any trailing whitespace.
-/* An object of this type is passed to get_number_or_range. It must
- be initialized by calling init_number_or_range. This type is
- defined here so that it can be stack-allocated, but all members
- other than `finished' and `string' should be treated as opaque. */
+ The string can either be a number, or "$" followed by the name of a
+ convenience variable, or ("$" or "$$") followed by digits.
-struct get_number_or_range_state
-{
- /* Non-zero if parsing has completed. */
- int finished;
+ TRAILER is a character which can be found after the number; most
+ commonly this is `-'. If you don't want a trailer, use \0. */
- /* The string being parsed. When parsing has finished, this points
- past the last parsed token. */
- char *string;
+extern int get_number_trailer (const char **pp, int trailer);
- /* Last value returned. */
- int last_retval;
+/* Convenience. Like get_number_trailer, but with no TRAILER. */
- /* When parsing a range, the final value in the range. */
- int end_value;
+extern int get_number (const char **);
- /* When parsing a range, a pointer past the final token in the
- range. */
- char *end_ptr;
+/* Like the above, but takes a non-const "char **". */
- /* Non-zero when parsing a range. */
- int in_range;
-};
+extern int get_number (char **);
+
+/* Like get_number_trailer, but works with ULONGEST, and throws on
+ error instead of returning 0. */
+extern ULONGEST get_ulongest (const char **pp, int trailer = '\0');
+
+/* Throws an error telling the user that ARGS starts with an option
+ unrecognized by COMMAND. */
-/* Initialize a get_number_or_range_state for use with
- get_number_or_range_state. STRING is the string to be parsed. */
+extern void report_unrecognized_option_error (const char *command,
+ const char *args);
-extern void init_number_or_range (struct get_number_or_range_state *state,
- char *string);
+
+/* Builds the help string for a command documented by PREFIX,
+ followed by the extract_info_print_args help for ENTITY_KIND. If
+ DOCUMENT_N_FLAG is true then help text descibing the -n flag is also
+ included. */
+
+const char *info_print_args_help (const char *prefix,
+ const char *entity_kind,
+ bool document_n_flag);
/* Parse a number or a range.
A number will be of the form handled by get_number.
- A range will be of the form <number1> - <number2>, and
+ A range will be of the form <number1> - <number2>, and
will represent all the integers between number1 and number2,
- inclusive.
+ inclusive. */
+
+class number_or_range_parser
+{
+public:
+ /* Default construction. Must call init before calling
+ get_next. */
+ number_or_range_parser () {}
+
+ /* Calls init automatically. */
+ number_or_range_parser (const char *string);
+
+ /* STRING is the string to be parsed. */
+ void init (const char *string);
+
+ /* While processing a range, this fuction is called iteratively; At
+ each call it will return the next value in the range.
- While processing a range, this fuction is called iteratively;
- At each call it will return the next value in the range.
+ At the beginning of parsing a range, the char pointer
+ STATE->m_cur_tok will be advanced past <number1> and left
+ pointing at the '-' token. Subsequent calls will not advance the
+ pointer until the range is completed. The call that completes
+ the range will advance the pointer past <number2>. */
+ int get_number ();
- At the beginning of parsing a range, the char pointer STATE->string will
- be advanced past <number1> and left pointing at the '-' token.
- Subsequent calls will not advance the pointer until the range
- is completed. The call that completes the range will advance
- the pointer past <number2>. */
+ /* Setup internal state such that get_next() returns numbers in the
+ START_VALUE to END_VALUE range. END_PTR is where the string is
+ advanced to when get_next() returns END_VALUE. */
+ void setup_range (int start_value, int end_value,
+ const char *end_ptr);
-extern int get_number_or_range (struct get_number_or_range_state *state);
+ /* Returns true if parsing has completed. */
+ bool finished () const;
+
+ /* Return the string being parsed. When parsing has finished, this
+ points past the last parsed token. */
+ const char *cur_tok () const
+ { return m_cur_tok; }
+
+ /* True when parsing a range. */
+ bool in_range () const
+ { return m_in_range; }
+
+ /* When parsing a range, the final value in the range. */
+ int end_value () const
+ { return m_end_value; }
+
+ /* When parsing a range, skip past the final token in the range. */
+ void skip_range ()
+ {
+ gdb_assert (m_in_range);
+ m_cur_tok = m_end_ptr;
+ m_in_range = false;
+ }
+
+private:
+ /* No need for these. They are intentionally not defined anywhere. */
+ number_or_range_parser (const number_or_range_parser &);
+ number_or_range_parser &operator= (const number_or_range_parser &);
+
+ /* The string being parsed. When parsing has finished, this points
+ past the last parsed token. */
+ const char *m_cur_tok;
+
+ /* Last value returned. */
+ int m_last_retval;
+
+ /* When parsing a range, the final value in the range. */
+ int m_end_value;
+
+ /* When parsing a range, a pointer past the final token in the
+ range. */
+ const char *m_end_ptr;
+
+ /* True when parsing a range. */
+ bool m_in_range;
+};
/* Accept a number and a string-form list of numbers such as is
accepted by get_number_or_range. Return TRUE if the number is
be interpreted as typing a command such as "delete break" with
no arguments. */
-extern int number_is_in_list (char *list, int number);
-
-/* Skip leading whitespace characters in INP, returning an updated
- pointer. If INP is NULL, return NULL. */
+extern int number_is_in_list (const char *list, int number);
-extern char *skip_spaces (char *inp);
-
-/* A const-correct version of the above. */
+/* Reverse S to the last non-whitespace character without skipping past
+ START. */
-extern const char *skip_spaces_const (const char *inp);
+extern const char *remove_trailing_whitespace (const char *start,
+ const char *s);
-/* Skip leading non-whitespace characters in INP, returning an updated
- pointer. If INP is NULL, return NULL. */
+/* Same, for non-const S. */
-extern char *skip_to_space (char *inp);
+static inline char *
+remove_trailing_whitespace (const char *start, char *s)
+{
+ return (char *) remove_trailing_whitespace (start, (const char *) s);
+}
-/* Reverse S to the last non-whitespace character without skipping past
- START. */
+/* A helper function to extract an argument from *ARG. An argument is
+ delimited by whitespace. The return value is empty if no argument
+ was found. */
-extern char *remove_trailing_whitespace (const char *start, char *s);
+extern std::string extract_arg (char **arg);
-/* A helper function to extract an argument from *ARG. An argument is
- delimited by whitespace. The return value is either NULL if no
- argument was found, or an xmalloc'd string. */
+/* A const-correct version of the above. */
-extern char *extract_arg (char **arg);
+extern std::string extract_arg (const char **arg);
/* A helper function that looks for an argument at the start of a
string. The argument must also either be at the end of the string,
or be followed by whitespace. Returns 1 if it finds the argument,
- 0 otherwise. If the argument is found, it updates *STR. */
-extern int check_for_argument (char **str, char *arg, int arg_len);
+ 0 otherwise. If the argument is found, it updates *STR to point
+ past the argument and past any whitespace following the
+ argument. */
+extern int check_for_argument (const char **str, const char *arg, int arg_len);
+
+/* Same as above, but ARG's length is computed. */
+
+static inline int
+check_for_argument (const char **str, const char *arg)
+{
+ return check_for_argument (str, arg, strlen (arg));
+}
+
+/* Same, for non-const STR. */
+
+static inline int
+check_for_argument (char **str, const char *arg, int arg_len)
+{
+ return check_for_argument (const_cast<const char **> (str),
+ arg, arg_len);
+}
+
+static inline int
+check_for_argument (char **str, const char *arg)
+{
+ return check_for_argument (str, arg, strlen (arg));
+}
+
+/* qcs_flags struct groups the -q, -c, and -s flags parsed by "thread
+ apply" and "frame apply" commands */
+
+struct qcs_flags
+{
+ int quiet = false;
+ int cont = false;
+ int silent = false;
+};
+
+/* Validate FLAGS. Throws an error if both FLAGS->CONT and
+ FLAGS->SILENT are true. WHICH_COMMAND is included in the error
+ message. */
+extern void validate_flags_qcs (const char *which_command, qcs_flags *flags);
-#endif /* CLI_UTILS_H */
+#endif /* CLI_CLI_UTILS_H */
projects / deliverable / binutils-gdb.git / blobdiff