1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
|
/* Data structures and API for event locations in GDB.
Copyright (C) 2013-2016 Free Software Foundation, Inc.
This file is part of GDB.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
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 LOCATIONS_H
#define LOCATIONS_H 1
struct language_defn;
struct event_location;
/* An enumeration of possible signs for a line offset. */
enum offset_relative_sign
{
/* No sign */
LINE_OFFSET_NONE,
/* A plus sign ("+") */
LINE_OFFSET_PLUS,
/* A minus sign ("-") */
LINE_OFFSET_MINUS,
/* A special "sign" for unspecified offset. */
LINE_OFFSET_UNKNOWN
};
/* A line offset in a location. */
struct line_offset
{
/* Line offset and any specified sign. */
int offset;
enum offset_relative_sign sign;
};
/* An enumeration of the various ways to specify a stop event
location (used with create_breakpoint). */
enum event_location_type
{
/* A traditional linespec. */
LINESPEC_LOCATION,
/* An address in the inferior. */
ADDRESS_LOCATION,
/* An explicit location. */
EXPLICIT_LOCATION,
/* A probe location. */
PROBE_LOCATION
};
/* An explicit location. This structure is used to bypass the
parsing done on linespecs. It still has the same requirements
as linespecs, though. For example, source_filename requires
at least one other field. */
struct explicit_location
{
/* The source filename. Malloc'd. */
char *source_filename;
/* The function name. Malloc'd. */
char *function_name;
/* The name of a label. Malloc'd. */
char *label_name;
/* A line offset relative to the start of the symbol
identified by the above fields or the current symtab
if the other fields are NULL. */
struct line_offset line_offset;
};
/* Return the type of the given event location. */
extern enum event_location_type
event_location_type (const struct event_location *);
/* Return a malloc'd explicit string representation of the given
explicit location. The location must already be canonicalized/valid. */
extern char *
explicit_location_to_string (const struct explicit_location *explicit_loc);
/* Return a malloc'd linespec string representation of the given
explicit location. The location must already be canonicalized/valid. */
extern char *
explicit_location_to_linespec (const struct explicit_location *explicit_loc);
/* Return a string representation of the LOCATION.
This function may return NULL for unspecified linespecs,
e.g, LOCATION_LINESPEC and addr_string is NULL.
The result is cached in LOCATION. */
extern const char *
event_location_to_string (struct event_location *location);
/* Create a new linespec location. The return result is malloc'd
and should be freed with delete_event_location. */
extern struct event_location *
new_linespec_location (char **linespec);
/* Return the linespec location (a string) of the given event_location
(which must be of type LINESPEC_LOCATION). */
extern const char *
get_linespec_location (const struct event_location *location);
/* Create a new address location.
ADDR is the address corresponding to this event_location.
ADDR_STRING, a string of ADDR_STRING_LEN characters, is
the expression that was parsed to determine the address ADDR. */
extern struct event_location *
new_address_location (CORE_ADDR addr, const char *addr_string,
int addr_string_len);
/* Return the address location (a CORE_ADDR) of the given event_location
(which must be of type ADDRESS_LOCATION). */
extern CORE_ADDR
get_address_location (const struct event_location *location);
/* Return the expression (a string) that was used to compute the address
of the given event_location (which must be of type ADDRESS_LOCATION). */
extern const char *
get_address_string_location (const struct event_location *location);
/* Create a new probe location. The return result is malloc'd
and should be freed with delete_event_location. */
extern struct event_location *
new_probe_location (const char *probe);
/* Return the probe location (a string) of the given event_location
(which must be of type PROBE_LOCATION). */
extern const char *
get_probe_location (const struct event_location *location);
/* Initialize the given explicit location. */
extern void
initialize_explicit_location (struct explicit_location *explicit_loc);
/* Create a new explicit location. If not NULL, EXPLICIT is checked for
validity. If invalid, an exception is thrown.
The return result is malloc'd and should be freed with
delete_event_location. */
extern struct event_location *
new_explicit_location (const struct explicit_location *explicit_loc);
/* Return the explicit location of the given event_location
(which must be of type EXPLICIT_LOCATION). */
extern struct explicit_location *
get_explicit_location (struct event_location *location);
/* A const version of the above. */
extern const struct explicit_location *
get_explicit_location_const (const struct event_location *location);
/* Free an event location and any associated data. */
extern void delete_event_location (struct event_location *location);
/* Make a cleanup to free LOCATION. */
extern struct cleanup *
make_cleanup_delete_event_location (struct event_location *location);
/* Return a copy of the given SRC location. */
extern struct event_location *
copy_event_location (const struct event_location *src);
/* Attempt to convert the input string in *ARGP into an event_location.
ARGP is advanced past any processed input. Returns an event_location
(malloc'd) if an event location was successfully found in *ARGP,
NULL otherwise.
This function may call error() if *ARGP looks like properly formed,
but invalid, input, e.g., if it is called with missing argument parameters
or invalid options.
The return result must be freed with delete_event_location.
This function is intended to be used by CLI commands and will parse
explicit locations in a CLI-centric way. Other interfaces should use
string_to_event_location_basic if they want to maintain support for
legacy specifications of probe, address, and linespec locations. */
extern struct event_location *
string_to_event_location (char **argp,
const struct language_defn *langauge);
/* Like string_to_event_location, but does not attempt to parse explicit
locations. */
extern struct event_location *
string_to_event_location_basic (char **argp,
const struct language_defn *language);
/* Attempt to convert the input string in *ARGP into an explicit location.
ARGP is advanced past any processed input. Returns an event_location
(malloc'd) if an explicit location was successfully found in *ARGP,
NULL otherwise.
IF !DONT_THROW, this function may call error() if *ARGP looks like
properly formed input, e.g., if it is called with missing argument
parameters or invalid options. If DONT_THROW is non-zero, this function
will not throw any exceptions. */
extern struct event_location *
string_to_explicit_location (const char **argp,
const struct language_defn *langauge,
int dont_throw);
/* A convenience function for testing for unset locations. */
extern int event_location_empty_p (const struct event_location *location);
/* Set the location's string representation. If STRING is NULL, clear
the string representation. */
extern void
set_event_location_string (struct event_location *location,
const char *string);
#endif /* LOCATIONS_H */
|
