* tracepoint.c (trace_actions_command): Update.
[platform/upstream/binutils.git] / gdb / cli / cli-utils.h
1 /* CLI utilities.
2
3    Copyright (c) 2011 Free Software Foundation, Inc.
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
9    the Free Software Foundation; either version 3 of the License, or
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
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
19
20 #ifndef CLI_UTILS_H
21 #define CLI_UTILS_H
22
23 /* *PP is a string denoting a number.  Get the number of the.  Advance
24    *PP after the string and any trailing whitespace.
25
26    Currently the string can either be a number,  or "$" followed by the
27    name of a convenience variable, or ("$" or "$$") followed by digits.  */
28
29 extern int get_number (char **);
30
31 /* An object of this type is passed to get_number_or_range.  It must
32    be initialized by calling init_number_or_range.  This type is
33    defined here so that it can be stack-allocated, but all members
34    other than `finished' and `string' should be treated as opaque.  */
35
36 struct get_number_or_range_state
37 {
38   /* Non-zero if parsing has completed.  */
39   int finished;
40
41   /* The string being parsed.  When parsing has finished, this points
42      past the last parsed token.  */
43   char *string;
44
45   /* Last value returned.  */
46   int last_retval;
47
48   /* When parsing a range, the final value in the range.  */
49   int end_value;
50
51   /* When parsing a range, a pointer past the final token in the
52      range.  */
53   char *end_ptr;
54
55   /* Non-zero when parsing a range.  */
56   int in_range;
57 };
58
59 /* Initialize a get_number_or_range_state for use with
60    get_number_or_range_state.  STRING is the string to be parsed.  */
61
62 extern void init_number_or_range (struct get_number_or_range_state *state,
63                                   char *string);
64
65 /* Parse a number or a range.
66    A number will be of the form handled by get_number.
67    A range will be of the form <number1> - <number2>, and 
68    will represent all the integers between number1 and number2,
69    inclusive.
70
71    While processing a range, this fuction is called iteratively;
72    At each call it will return the next value in the range.
73
74    At the beginning of parsing a range, the char pointer STATE->string will
75    be advanced past <number1> and left pointing at the '-' token.
76    Subsequent calls will not advance the pointer until the range
77    is completed.  The call that completes the range will advance
78    the pointer past <number2>.  */
79
80 extern int get_number_or_range (struct get_number_or_range_state *state);
81
82 /* Accept a number and a string-form list of numbers such as is 
83    accepted by get_number_or_range.  Return TRUE if the number is
84    in the list.
85
86    By definition, an empty list includes all numbers.  This is to 
87    be interpreted as typing a command such as "delete break" with 
88    no arguments.  */
89
90 extern int number_is_in_list (char *list, int number);
91
92 /* Skip leading whitespace characters in INP, returning an updated
93    pointer.  If INP is NULL, return NULL.  */
94
95 extern char *skip_spaces (char *inp);
96
97 /* Skip leading non-whitespace characters in INP, returning an updated
98    pointer.  If INP is NULL, return NULL.  */
99
100 extern char *skip_to_space (char *inp);
101
102 #endif /* CLI_UTILS_H */