1 /* Header for GDB line completion.
2 Copyright (C) 2000-2017 Free Software Foundation, Inc.
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.
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.
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/>. */
17 #if !defined (LINESPEC_H)
25 /* Flags to pass to decode_line_1 and decode_line_full. */
27 enum decode_line_flags
29 /* Set this flag if you want the resulting SALs to describe the
30 first line of indicated functions. */
31 DECODE_LINE_FUNFIRSTLINE = 1,
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
39 /* decode_line_full returns a vector of these. */
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
50 std::vector<symtab_and_line> sals;
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. */
56 struct linespec_result
58 linespec_result () = default;
61 DISABLE_COPY_AND_ASSIGN (linespec_result);
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;
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
72 bool pre_expanded = false;
74 /* If PRE_EXPANDED is non-zero, this is set to the location entered
76 event_location_up location;
78 /* The sals. The vector will be freed by the destructor. */
79 std::vector<linespec_sals> lsals;
82 /* Decode a linespec using the provided default symtab and line. */
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);
89 /* Parse LOCATION and return results. This is the "full"
90 interface to this module, which handles multiple results
93 For FLAGS, see decode_line_flags. DECODE_LINE_LIST_MODE is not
94 valid for this function.
96 If SEARCH_PSPACE is not NULL, symbol search is restricted to just
99 DEFAULT_SYMTAB and DEFAULT_LINE describe the default location.
100 DEFAULT_SYMTAB can be NULL, in which case the current symtab and
103 CANONICAL is where the results are stored. It must not be NULL.
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.
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.
112 Multiple results are handled differently depending on the
115 . With multiple_symbols_cancel, an exception is thrown.
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.
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
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,
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". */
139 extern std::vector<symtab_and_line> decode_line_with_current_source
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. */
145 extern std::vector<symtab_and_line> decode_line_with_last_displayed
148 /* Does P represent one of the keywords? If so, return
149 the keyword. If not, return NULL. */
151 extern const char *linespec_lexer_lex_keyword (const char *p);
153 /* Parse a line offset from STRING. */
155 extern struct line_offset linespec_parse_line_offset (const char *string);
157 /* Return the quote characters permitted by the linespec parser. */
159 extern const char *get_gdb_linespec_parser_quote_characters (void);
161 /* Does STRING represent an Ada operator? If so, return the length
162 of the decoded operator name. If not, return 0. */
164 extern int is_ada_operator (const char *string);
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>. */
171 extern const char *find_toplevel_char (const char *s, char c);
173 /* Find the end of the (first) linespec pointed to by *STRINGP.
174 STRINGP will be advanced to this point. */
176 extern void linespec_lex_to_end (const char **stringp);
178 extern const char * const linespec_keywords[];
180 /* Complete a linespec. */
182 extern void linespec_complete (completion_tracker &tracker,
184 symbol_name_match_type match_type);
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
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);
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. */
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);
208 /* Evaluate the expression pointed to by EXP_PTR into a CORE_ADDR,
209 advancing EXP_PTR past any parsed text. */
211 extern CORE_ADDR linespec_expression_to_pc (const char **exp_ptr);
212 #endif /* defined (LINESPEC_H) */