/* CLI utilities.
- Copyright (c) 2011 Free Software Foundation, Inc.
+ Copyright (C) 2011-2013 Free Software Foundation, Inc.
This file is part of GDB.
/* *PP is a string denoting a number. Get the number of the. Advance
*PP after the string and any trailing whitespace.
- Currently the string can either be a number or "$" followed by the
- name of a convenience variable. */
+ Currently the string can either be a number, or "$" followed by the
+ name of a convenience variable, or ("$" or "$$") followed by digits. */
extern int get_number (char **);
+/* 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. */
+
+struct get_number_or_range_state
+{
+ /* Non-zero if parsing has completed. */
+ int finished;
+
+ /* The string being parsed. When parsing has finished, this points
+ past the last parsed token. */
+ char *string;
+
+ /* Last value returned. */
+ int last_retval;
+
+ /* When parsing a range, the final value in the range. */
+ int end_value;
+
+ /* When parsing a range, a pointer past the final token in the
+ range. */
+ char *end_ptr;
+
+ /* Non-zero when parsing a range. */
+ int in_range;
+};
+
+/* Initialize a get_number_or_range_state for use with
+ get_number_or_range_state. STRING is the string to be parsed. */
+
+extern void init_number_or_range (struct get_number_or_range_state *state,
+ char *string);
+
/* 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
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 PP will
+ 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
- pointer PP past <number2>. */
+ the pointer past <number2>. */
+
+extern int get_number_or_range (struct get_number_or_range_state *state);
+
+/* 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
+ in the list.
-extern int get_number_or_range (char **);
+ By definition, an empty list includes all numbers. This is to
+ 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 char *skip_spaces (char *inp);
+/* A const-correct version of the above. */
+
+extern const char *skip_spaces_const (const char *inp);
+
/* Skip leading non-whitespace characters in INP, returning an updated
pointer. If INP is NULL, return NULL. */
-extern char *skip_to_space (char *inp);
+#define skip_to_space(INP) ((char *) skip_to_space_const (INP))
+
+/* A const-correct version of the above. */
+
+extern const char *skip_to_space_const (const char *inp);
+
+/* Reverse S to the last non-whitespace character without skipping past
+ START. */
+
+extern char *remove_trailing_whitespace (const char *start, char *s);
+
+/* 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. */
+
+extern char *extract_arg (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);
#endif /* CLI_UTILS_H */