GDB (xrefs)

/tmp/gdb-8.1/gdb/linespec.h
Go to the documentation of this file.
1 /* Header for GDB line completion.
2 Copyright (C) 2000-2018 Free Software Foundation, Inc.
3
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 3 of the License, or
7 (at your option) any later version.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
13
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>. */
16
17 #if !defined (LINESPEC_H)
18 #define LINESPEC_H 1
19
20 struct symtab;
21
22 #include "location.h"
23 #include "vec.h"
24
25 /* Flags to pass to decode_line_1 and decode_line_full. */
26
27 enum decode_line_flags
28 {
29 /* Set this flag if you want the resulting SALs to describe the
30 first line of indicated functions. */
31 DECODE_LINE_FUNFIRSTLINE = 1,
32
33 /* Set this flag if you want "list mode". In this mode, a
34 FILE:LINE linespec will always return a result, and such
35 linespecs will not be expanded to all matches. */
36 DECODE_LINE_LIST_MODE = 2
37 };
38
39 /* decode_line_full returns a vector of these. */
40
41 struct linespec_sals
42 {
43 /* This is the location corresponding to the sals contained in this
44 object. It can be passed as the FILTER argument to future calls
45 to decode_line_full. This is freed by the linespec_result
46 destructor. */
47 char *canonical;
48
49 /* Sals. */
50 std::vector<symtab_and_line> sals;
51 };
52
53 /* An instance of this may be filled in by decode_line_1. The caller
54 must make copies of any data that it needs to keep. */
55
56 struct linespec_result
57 {
58 linespec_result () = default;
59 ~linespec_result ();
60
61 DISABLE_COPY_AND_ASSIGN (linespec_result);
62
63 /* If true, the linespec should be displayed to the user. This
64 is used by "unusual" linespecs where the ordinary `info break'
65 display mechanism would do the wrong thing. */
66 bool special_display = false;
67
68 /* If true, the linespec result should be considered to be a
69 "pre-expanded" multi-location linespec. A pre-expanded linespec
70 holds all matching locations in a single linespec_sals
71 object. */
72 bool pre_expanded = false;
73
74 /* If PRE_EXPANDED is non-zero, this is set to the location entered
75 by the user. */
76 event_location_up location;
77
78 /* The sals. The vector will be freed by the destructor. */
79 std::vector<linespec_sals> lsals;
80 };
81
82 /* Decode a linespec using the provided default symtab and line. */
83
84 extern std::vector<symtab_and_line>
85 decode_line_1 (const struct event_location *location, int flags,
86 struct program_space *search_pspace,
87 struct symtab *default_symtab, int default_line);
88
89 /* Parse LOCATION and return results. This is the "full"
90 interface to this module, which handles multiple results
91 properly.
92
93 For FLAGS, see decode_line_flags. DECODE_LINE_LIST_MODE is not
94 valid for this function.
95
96 If SEARCH_PSPACE is not NULL, symbol search is restricted to just
97 that program space.
98
99 DEFAULT_SYMTAB and DEFAULT_LINE describe the default location.
100 DEFAULT_SYMTAB can be NULL, in which case the current symtab and
101 line are used.
102
103 CANONICAL is where the results are stored. It must not be NULL.
104
105 SELECT_MODE must be one of the multiple_symbols_* constants, or
106 NULL. It determines how multiple results will be handled. If
107 NULL, the appropriate CLI value will be used.
108
109 FILTER can either be NULL or a string holding a canonical name.
110 This is only valid when SELECT_MODE is multiple_symbols_all.
111
112 Multiple results are handled differently depending on the
113 arguments:
114
115 . With multiple_symbols_cancel, an exception is thrown.
116
117 . With multiple_symbols_ask, a menu is presented to the user. The
118 user may select none, in which case an exception is thrown; or all,
119 which is handled like multiple_symbols_all, below. Otherwise,
120 CANONICAL->SALS will have one entry for each name the user chose.
121
122 . With multiple_symbols_all, CANONICAL->SALS will have a single
123 entry describing all the matching locations. If FILTER is
124 non-NULL, then only locations whose canonical name is equal (in the
125 strcmp sense) to FILTER will be returned; all others will be
126 filtered out. */
127
128 extern void decode_line_full (const struct event_location *location, int flags,
129 struct program_space *search_pspace,
130 struct symtab *default_symtab, int default_line,
131 struct linespec_result *canonical,
132 const char *select_mode,
133 const char *filter);
134
135 /* Given a string, return the line specified by it, using the current
136 source symtab and line as defaults.
137 This is for commands like "list" and "breakpoint". */
138
139 extern std::vector<symtab_and_line> decode_line_with_current_source
140 (const char *, int);
141
142 /* Given a string, return the line specified by it, using the last displayed
143 codepoint's values as defaults, or nothing if they aren't valid. */
144
145 extern std::vector<symtab_and_line> decode_line_with_last_displayed
146 (const char *, int);
147
148 /* Does P represent one of the keywords? If so, return
149 the keyword. If not, return NULL. */
150
151 extern const char *linespec_lexer_lex_keyword (const char *p);
152
153 /* Parse a line offset from STRING. */
154
155 extern struct line_offset linespec_parse_line_offset (const char *string);
156
157 /* Return the quote characters permitted by the linespec parser. */
158
159 extern const char *get_gdb_linespec_parser_quote_characters (void);
160
161 /* Does STRING represent an Ada operator? If so, return the length
162 of the decoded operator name. If not, return 0. */
163
164 extern int is_ada_operator (const char *string);
165
166 /* Find an instance of the character C in the string S that is outside
167 of all parenthesis pairs, single-quoted strings, and double-quoted
168 strings. Also, ignore the char within a template name, like a ','
169 within foo<int, int>. */
170
171 extern const char *find_toplevel_char (const char *s, char c);
172
173 /* Find the end of the (first) linespec pointed to by *STRINGP.
174 STRINGP will be advanced to this point. */
175
176 extern void linespec_lex_to_end (const char **stringp);
177
178 extern const char * const linespec_keywords[];
179
180 /* Complete a linespec. */
181
182 extern void linespec_complete (completion_tracker &tracker,
183 const char *text,
184 symbol_name_match_type match_type);
185
186 /* Complete a function symbol, in linespec mode, according to
187 FUNC_MATCH_TYPE. If SOURCE_FILENAME is non-NULL, limits completion
188 to the list of functions defined in source files that match
189 SOURCE_FILENAME. */
190
191 extern void linespec_complete_function (completion_tracker &tracker,
192 const char *function,
193 symbol_name_match_type func_match_type,
194 const char *source_filename);
195
196 /* Complete a label symbol, in linespec mode. Only labels of
197 functions named FUNCTION_NAME are considered. If SOURCE_FILENAME
198 is non-NULL, limits completion to labels of functions defined in
199 source files that match SOURCE_FILENAME. */
200
201 extern void linespec_complete_label (completion_tracker &tracker,
202 const struct language_defn *language,
203 const char *source_filename,
204 const char *function_name,
205 symbol_name_match_type name_match_type,
206 const char *label_name);
207
208 /* Evaluate the expression pointed to by EXP_PTR into a CORE_ADDR,
209 advancing EXP_PTR past any parsed text. */
210
211 extern CORE_ADDR linespec_expression_to_pc (const char **exp_ptr);
212 #endif /* defined (LINESPEC_H) */
string
const char * string
Definition: signals.c:50
CORE_ADDR
bfd_vma CORE_ADDR
Definition: common-types.h:41
linespec_complete_function
void linespec_complete_function(completion_tracker &tracker, const char *function, symbol_name_match_type func_match_type, const char *source_filename)
Definition: linespec.c:2848
decode_line_1
std::vector< symtab_and_line > decode_line_1(const struct event_location *location, int flags, struct program_space *search_pspace, struct symtab *default_symtab, int default_line)
Definition: linespec.c:3346
linespec_lex_to_end
void linespec_lex_to_end(const char **stringp)
Definition: linespec.c:2815
linespec_result::location
event_location_up location
Definition: linespec.h:76
linespec_complete_label
void linespec_complete_label(completion_tracker &tracker, const struct language_defn *language, const char *source_filename, const char *function_name, symbol_name_match_type name_match_type, const char *label_name)
Definition: linespec.c:2960
DECODE_LINE_FUNFIRSTLINE
Definition: linespec.h:31
linespec_result::pre_expanded
bool pre_expanded
Definition: linespec.h:72
language_defn
Definition: language.h:132
flags
mach_port_t kern_return_t mach_port_t msgports mach_port_t kern_return_t pid_t pid mach_port_t kern_return_t mach_port_t task mach_port_t kern_return_t int flags
Definition: gnu-nat.c:1891
linespec_complete
void linespec_complete(completion_tracker &tracker, const char *text, symbol_name_match_type match_type)
Definition: linespec.c:2999
linespec_sals::sals
std::vector< symtab_and_line > sals
Definition: linespec.h:50
DECODE_LINE_LIST_MODE
Definition: linespec.h:36
linespec_lexer_lex_keyword
const char * linespec_lexer_lex_keyword(const char *p)
Definition: linespec.c:456
linespec_keywords
const char *const linespec_keywords[]
Definition: linespec.c:251
linespec_result::linespec_result
linespec_result()=default
linespec_sals
Definition: linespec.h:41
line_offset
Definition: location.h:44
event_location
Definition: location.c:36
event_location_up
std::unique_ptr< event_location, event_location_deleter > event_location_up
Definition: location.h:140
symtab
Definition: symtab.h:1291
linespec_result::lsals
std::vector< linespec_sals > lsals
Definition: linespec.h:79
decode_line_full
void decode_line_full(const struct event_location *location, int flags, struct program_space *search_pspace, struct symtab *default_symtab, int default_line, struct linespec_result *canonical, const char *select_mode, const char *filter)
Definition: linespec.c:3270
decode_line_flags
decode_line_flags
Definition: linespec.h:27
get_gdb_linespec_parser_quote_characters
const char * get_gdb_linespec_parser_quote_characters(void)
Definition: linespec.c:4656
linespec_sals::canonical
char * canonical
Definition: linespec.h:47
linespec_result::special_display
bool special_display
Definition: linespec.h:66
linespec_result
Definition: linespec.h:56
is_ada_operator
int is_ada_operator(const char *string)
Definition: linespec.c:504
linespec_result::~linespec_result
~linespec_result()
Definition: linespec.c:4647
location.h
language
language
Definition: defs.h:203
decode_line_with_last_displayed
std::vector< symtab_and_line > decode_line_with_last_displayed(const char *, int)
Definition: linespec.c:3394
linespec_parse_line_offset
struct line_offset linespec_parse_line_offset(const char *string)
Definition: linespec.c:1745
completion_tracker
Definition: completer.h:310
find_toplevel_char
const char * find_toplevel_char(const char *s, char c)
Definition: linespec.c:1286
linespec_expression_to_pc
CORE_ADDR linespec_expression_to_pc(const char **exp_ptr)
Definition: linespec.c:3442
linespec_result::DISABLE_COPY_AND_ASSIGN
DISABLE_COPY_AND_ASSIGN(linespec_result)
decode_line_with_current_source
std::vector< symtab_and_line > decode_line_with_current_source(const char *, int)
Definition: linespec.c:3371
program_space
Definition: progspace.h:137
symbol_name_match_type
symbol_name_match_type
Definition: symtab.h:52
vec.h