1 /* Parser for linespec for the GNU debugger, GDB.
3 Copyright (C) 1986-2018 Free Software Foundation, Inc.
5 This file is part of GDB.
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.
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.
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/>. */
29 #include "completer.h"
31 #include "cp-support.h"
32 #include "parser-defs.h"
34 #include "objc-lang.h"
38 #include "mi/mi-cmds.h"
40 #include "arch-utils.h"
42 #include "cli/cli-utils.h"
43 #include "filenames.h"
47 #include "common/function-view.h"
48 #include "common/def-vector.h"
51 /* An enumeration of the various things a user might attempt to
52 complete for a linespec location. */
54 enum class linespec_complete_what
56 /* Nothing, no possible completion. */
59 /* A function/method name. Due to ambiguity between
65 this can also indicate a source filename, iff we haven't seen a
66 separate source filename component, as in "b source.c:function". */
69 /* A label symbol. E.g., break file.c:function:LABEL. */
72 /* An expression. E.g., "break foo if EXPR", or "break *EXPR". */
75 /* A linespec keyword ("if"/"thread"/"task").
76 E.g., "break func threa<tab>". */
80 typedef struct symbol
*symbolp
;
83 typedef struct type
*typep
;
86 /* An address entry is used to ensure that any given location is only
87 added to the result a single time. It holds an address and the
88 program space from which the address came. */
92 struct program_space
*pspace
;
96 typedef struct bound_minimal_symbol bound_minimal_symbol_d
;
98 DEF_VEC_O (bound_minimal_symbol_d
);
100 /* A linespec. Elements of this structure are filled in by a parser
101 (either parse_linespec or some other function). The structure is
102 then converted into SALs by convert_linespec_to_sals. */
106 /* An explicit location describing the SaLs. */
107 struct explicit_location explicit_loc
;
109 /* The list of symtabs to search to which to limit the search. May not
110 be NULL. If explicit.SOURCE_FILENAME is NULL (no user-specified
111 filename), FILE_SYMTABS should contain one single NULL member. This
112 will cause the code to use the default symtab. */
113 VEC (symtab_ptr
) *file_symtabs
;
115 /* A list of matching function symbols and minimal symbols. Both lists
116 may be NULL if no matching symbols were found. */
117 VEC (symbolp
) *function_symbols
;
118 VEC (bound_minimal_symbol_d
) *minimal_symbols
;
120 /* A structure of matching label symbols and the corresponding
121 function symbol in which the label was found. Both may be NULL
122 or both must be non-NULL. */
125 VEC (symbolp
) *label_symbols
;
126 VEC (symbolp
) *function_symbols
;
129 typedef struct linespec
*linespec_p
;
131 /* A canonical linespec represented as a symtab-related string.
133 Each entry represents the "SYMTAB:SUFFIX" linespec string.
134 SYMTAB can be converted for example by symtab_to_fullname or
135 symtab_to_filename_for_display as needed. */
137 struct linespec_canonical_name
139 /* Remaining text part of the linespec string. */
142 /* If NULL then SUFFIX is the whole linespec string. */
143 struct symtab
*symtab
;
146 /* An instance of this is used to keep all state while linespec
147 operates. This instance is passed around as a 'this' pointer to
148 the various implementation methods. */
150 struct linespec_state
152 /* The language in use during linespec processing. */
153 const struct language_defn
*language
;
155 /* The program space as seen when the module was entered. */
156 struct program_space
*program_space
;
158 /* If not NULL, the search is restricted to just this program
160 struct program_space
*search_pspace
;
162 /* The default symtab to use, if no other symtab is specified. */
163 struct symtab
*default_symtab
;
165 /* The default line to use. */
168 /* The 'funfirstline' value that was passed in to decode_line_1 or
172 /* Nonzero if we are running in 'list' mode; see decode_line_list. */
175 /* The 'canonical' value passed to decode_line_full, or NULL. */
176 struct linespec_result
*canonical
;
178 /* Canonical strings that mirror the std::vector<symtab_and_line> result. */
179 struct linespec_canonical_name
*canonical_names
;
181 /* This is a set of address_entry objects which is used to prevent
182 duplicate symbols from being entered into the result. */
185 /* Are we building a linespec? */
189 /* This is a helper object that is used when collecting symbols into a
194 /* The linespec object in use. */
195 struct linespec_state
*state
;
197 /* A list of symtabs to which to restrict matches. */
198 VEC (symtab_ptr
) *file_symtabs
;
200 /* The result being accumulated. */
203 VEC (symbolp
) *symbols
;
204 VEC (bound_minimal_symbol_d
) *minimal_symbols
;
207 /* Possibly add a symbol to the results. */
208 bool add_symbol (symbol
*sym
);
212 collect_info::add_symbol (symbol
*sym
)
214 /* In list mode, add all matching symbols, regardless of class.
215 This allows the user to type "list a_global_variable". */
216 if (SYMBOL_CLASS (sym
) == LOC_BLOCK
|| this->state
->list_mode
)
217 VEC_safe_push (symbolp
, this->result
.symbols
, sym
);
219 /* Continue iterating. */
230 /* A colon "separator" */
242 /* EOI (end of input) */
248 typedef enum ls_token_type linespec_token_type
;
250 /* List of keywords. This is NULL-terminated so that it can be used
251 as enum completer. */
252 const char * const linespec_keywords
[] = { "if", "thread", "task", NULL
};
253 #define IF_KEYWORD_INDEX 0
255 /* A token of the linespec lexer */
259 /* The type of the token */
260 linespec_token_type type
;
262 /* Data for the token */
265 /* A string, given as a stoken */
266 struct stoken string
;
272 typedef struct ls_token linespec_token
;
274 #define LS_TOKEN_STOKEN(TOK) (TOK).data.string
275 #define LS_TOKEN_KEYWORD(TOK) (TOK).data.keyword
277 /* An instance of the linespec parser. */
281 /* Lexer internal data */
284 /* Save head of input stream. */
285 const char *saved_arg
;
287 /* Head of the input stream. */
289 #define PARSER_STREAM(P) ((P)->lexer.stream)
291 /* The current token. */
292 linespec_token current
;
295 /* Is the entire linespec quote-enclosed? */
296 int is_quote_enclosed
;
298 /* The state of the parse. */
299 struct linespec_state state
;
300 #define PARSER_STATE(PPTR) (&(PPTR)->state)
302 /* The result of the parse. */
303 struct linespec result
;
304 #define PARSER_RESULT(PPTR) (&(PPTR)->result)
306 /* What the parser believes the current word point should complete
308 linespec_complete_what complete_what
;
310 /* The completion word point. The parser advances this as it skips
311 tokens. At some point the input string will end or parsing will
312 fail, and then we attempt completion at the captured completion
313 word point, interpreting the string at completion_word as
315 const char *completion_word
;
317 /* If the current token was a quoted string, then this is the
318 quoting character (either " or '). */
319 int completion_quote_char
;
321 /* If the current token was a quoted string, then this points at the
322 end of the quoted string. */
323 const char *completion_quote_end
;
325 /* If parsing for completion, then this points at the completion
326 tracker. Otherwise, this is NULL. */
327 struct completion_tracker
*completion_tracker
;
329 typedef struct ls_parser linespec_parser
;
331 /* A convenience macro for accessing the explicit location result of
333 #define PARSER_EXPLICIT(PPTR) (&PARSER_RESULT ((PPTR))->explicit_loc)
335 /* Prototypes for local functions. */
337 static void iterate_over_file_blocks
338 (struct symtab
*symtab
, const lookup_name_info
&name
,
340 gdb::function_view
<symbol_found_callback_ftype
> callback
);
342 static void initialize_defaults (struct symtab
**default_symtab
,
345 CORE_ADDR
linespec_expression_to_pc (const char **exp_ptr
);
347 static std::vector
<symtab_and_line
> decode_objc (struct linespec_state
*self
,
351 static VEC (symtab_ptr
) *symtabs_from_filename (const char *,
352 struct program_space
*pspace
);
354 static VEC (symbolp
) *find_label_symbols (struct linespec_state
*self
,
355 VEC (symbolp
) *function_symbols
,
356 VEC (symbolp
) **label_funcs_ret
,
358 bool completion_mode
= false);
360 static void find_linespec_symbols (struct linespec_state
*self
,
361 VEC (symtab_ptr
) *file_symtabs
,
363 symbol_name_match_type name_match_type
,
364 VEC (symbolp
) **symbols
,
365 VEC (bound_minimal_symbol_d
) **minsyms
);
367 static struct line_offset
368 linespec_parse_variable (struct linespec_state
*self
,
369 const char *variable
);
371 static int symbol_to_sal (struct symtab_and_line
*result
,
372 int funfirstline
, struct symbol
*sym
);
374 static void add_matching_symbols_to_info (const char *name
,
375 symbol_name_match_type name_match_type
,
376 enum search_domain search_domain
,
377 struct collect_info
*info
,
378 struct program_space
*pspace
);
380 static void add_all_symbol_names_from_pspace (struct collect_info
*info
,
381 struct program_space
*pspace
,
382 VEC (const_char_ptr
) *names
,
383 enum search_domain search_domain
);
385 static VEC (symtab_ptr
) *
386 collect_symtabs_from_filename (const char *file
,
387 struct program_space
*pspace
);
389 static std::vector
<symtab_and_line
> decode_digits_ordinary
390 (struct linespec_state
*self
,
393 linetable_entry
**best_entry
);
395 static std::vector
<symtab_and_line
> decode_digits_list_mode
396 (struct linespec_state
*self
,
398 struct symtab_and_line val
);
400 static void minsym_found (struct linespec_state
*self
, struct objfile
*objfile
,
401 struct minimal_symbol
*msymbol
,
402 std::vector
<symtab_and_line
> *result
);
404 static int compare_symbols (const void *a
, const void *b
);
406 static int compare_msymbols (const void *a
, const void *b
);
408 /* Permitted quote characters for the parser. This is different from the
409 completer's quote characters to allow backward compatibility with the
411 static const char *const linespec_quote_characters
= "\"\'";
413 /* Lexer functions. */
415 /* Lex a number from the input in PARSER. This only supports
418 Return true if input is decimal numbers. Return false if not. */
421 linespec_lexer_lex_number (linespec_parser
*parser
, linespec_token
*tokenp
)
423 tokenp
->type
= LSTOKEN_NUMBER
;
424 LS_TOKEN_STOKEN (*tokenp
).length
= 0;
425 LS_TOKEN_STOKEN (*tokenp
).ptr
= PARSER_STREAM (parser
);
427 /* Keep any sign at the start of the stream. */
428 if (*PARSER_STREAM (parser
) == '+' || *PARSER_STREAM (parser
) == '-')
430 ++LS_TOKEN_STOKEN (*tokenp
).length
;
431 ++(PARSER_STREAM (parser
));
434 while (isdigit (*PARSER_STREAM (parser
)))
436 ++LS_TOKEN_STOKEN (*tokenp
).length
;
437 ++(PARSER_STREAM (parser
));
440 /* If the next character in the input buffer is not a space, comma,
441 quote, or colon, this input does not represent a number. */
442 if (*PARSER_STREAM (parser
) != '\0'
443 && !isspace (*PARSER_STREAM (parser
)) && *PARSER_STREAM (parser
) != ','
444 && *PARSER_STREAM (parser
) != ':'
445 && !strchr (linespec_quote_characters
, *PARSER_STREAM (parser
)))
447 PARSER_STREAM (parser
) = LS_TOKEN_STOKEN (*tokenp
).ptr
;
454 /* See linespec.h. */
457 linespec_lexer_lex_keyword (const char *p
)
463 for (i
= 0; linespec_keywords
[i
] != NULL
; ++i
)
465 int len
= strlen (linespec_keywords
[i
]);
467 /* If P begins with one of the keywords and the next
468 character is whitespace, we may have found a keyword.
469 It is only a keyword if it is not followed by another
471 if (strncmp (p
, linespec_keywords
[i
], len
) == 0
476 /* Special case: "if" ALWAYS stops the lexer, since it
477 is not possible to predict what is going to appear in
478 the condition, which can only be parsed after SaLs have
480 if (i
!= IF_KEYWORD_INDEX
)
484 for (j
= 0; linespec_keywords
[j
] != NULL
; ++j
)
486 int nextlen
= strlen (linespec_keywords
[j
]);
488 if (strncmp (p
, linespec_keywords
[j
], nextlen
) == 0
489 && isspace (p
[nextlen
]))
494 return linespec_keywords
[i
];
502 /* See description in linespec.h. */
505 is_ada_operator (const char *string
)
507 const struct ada_opname_map
*mapping
;
509 for (mapping
= ada_opname_table
;
510 mapping
->encoded
!= NULL
511 && !startswith (string
, mapping
->decoded
); ++mapping
)
514 return mapping
->decoded
== NULL
? 0 : strlen (mapping
->decoded
);
517 /* Find QUOTE_CHAR in STRING, accounting for the ':' terminal. Return
518 the location of QUOTE_CHAR, or NULL if not found. */
521 skip_quote_char (const char *string
, char quote_char
)
523 const char *p
, *last
;
525 p
= last
= find_toplevel_char (string
, quote_char
);
526 while (p
&& *p
!= '\0' && *p
!= ':')
528 p
= find_toplevel_char (p
, quote_char
);
536 /* Make a writable copy of the string given in TOKEN, trimming
537 any trailing whitespace. */
539 static gdb::unique_xmalloc_ptr
<char>
540 copy_token_string (linespec_token token
)
544 if (token
.type
== LSTOKEN_KEYWORD
)
545 return gdb::unique_xmalloc_ptr
<char> (xstrdup (LS_TOKEN_KEYWORD (token
)));
547 str
= LS_TOKEN_STOKEN (token
).ptr
;
548 s
= remove_trailing_whitespace (str
, str
+ LS_TOKEN_STOKEN (token
).length
);
550 return gdb::unique_xmalloc_ptr
<char> (savestring (str
, s
- str
));
553 /* Does P represent the end of a quote-enclosed linespec? */
556 is_closing_quote_enclosed (const char *p
)
558 if (strchr (linespec_quote_characters
, *p
))
560 p
= skip_spaces ((char *) p
);
561 return (*p
== '\0' || linespec_lexer_lex_keyword (p
));
564 /* Find the end of the parameter list that starts with *INPUT.
565 This helper function assists with lexing string segments
566 which might contain valid (non-terminating) commas. */
569 find_parameter_list_end (const char *input
)
571 char end_char
, start_char
;
576 if (start_char
== '(')
578 else if (start_char
== '<')
587 if (*p
== start_char
)
589 else if (*p
== end_char
)
603 /* If the [STRING, STRING_LEN) string ends with what looks like a
604 keyword, return the keyword start offset in STRING. Return -1
608 string_find_incomplete_keyword_at_end (const char * const *keywords
,
609 const char *string
, size_t string_len
)
611 const char *end
= string
+ string_len
;
614 while (p
> string
&& *p
!= ' ')
619 size_t len
= end
- p
;
620 for (size_t i
= 0; keywords
[i
] != NULL
; ++i
)
621 if (strncmp (keywords
[i
], p
, len
) == 0)
628 /* Lex a string from the input in PARSER. */
630 static linespec_token
631 linespec_lexer_lex_string (linespec_parser
*parser
)
633 linespec_token token
;
634 const char *start
= PARSER_STREAM (parser
);
636 token
.type
= LSTOKEN_STRING
;
638 /* If the input stream starts with a quote character, skip to the next
639 quote character, regardless of the content. */
640 if (strchr (linespec_quote_characters
, *PARSER_STREAM (parser
)))
643 char quote_char
= *PARSER_STREAM (parser
);
645 /* Special case: Ada operators. */
646 if (PARSER_STATE (parser
)->language
->la_language
== language_ada
647 && quote_char
== '\"')
649 int len
= is_ada_operator (PARSER_STREAM (parser
));
653 /* The input is an Ada operator. Return the quoted string
655 LS_TOKEN_STOKEN (token
).ptr
= PARSER_STREAM (parser
);
656 LS_TOKEN_STOKEN (token
).length
= len
;
657 PARSER_STREAM (parser
) += len
;
661 /* The input does not represent an Ada operator -- fall through
662 to normal quoted string handling. */
665 /* Skip past the beginning quote. */
666 ++(PARSER_STREAM (parser
));
668 /* Mark the start of the string. */
669 LS_TOKEN_STOKEN (token
).ptr
= PARSER_STREAM (parser
);
671 /* Skip to the ending quote. */
672 end
= skip_quote_char (PARSER_STREAM (parser
), quote_char
);
674 /* This helps the completer mode decide whether we have a
676 parser
->completion_quote_char
= quote_char
;
677 parser
->completion_quote_end
= end
;
679 /* Error if the input did not terminate properly, unless in
683 if (parser
->completion_tracker
== NULL
)
684 error (_("unmatched quote"));
686 /* In completion mode, we'll try to complete the incomplete
688 token
.type
= LSTOKEN_STRING
;
689 while (*PARSER_STREAM (parser
) != '\0')
690 PARSER_STREAM (parser
)++;
691 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - 1 - start
;
695 /* Skip over the ending quote and mark the length of the string. */
696 PARSER_STREAM (parser
) = (char *) ++end
;
697 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - 2 - start
;
704 /* Otherwise, only identifier characters are permitted.
705 Spaces are the exception. In general, we keep spaces,
706 but only if the next characters in the input do not resolve
707 to one of the keywords.
709 This allows users to forgo quoting CV-qualifiers, template arguments,
710 and similar common language constructs. */
714 if (isspace (*PARSER_STREAM (parser
)))
716 p
= skip_spaces (PARSER_STREAM (parser
));
717 /* When we get here we know we've found something followed by
718 a space (we skip over parens and templates below).
719 So if we find a keyword now, we know it is a keyword and not,
720 say, a function name. */
721 if (linespec_lexer_lex_keyword (p
) != NULL
)
723 LS_TOKEN_STOKEN (token
).ptr
= start
;
724 LS_TOKEN_STOKEN (token
).length
725 = PARSER_STREAM (parser
) - start
;
729 /* Advance past the whitespace. */
730 PARSER_STREAM (parser
) = p
;
733 /* If the next character is EOI or (single) ':', the
734 string is complete; return the token. */
735 if (*PARSER_STREAM (parser
) == 0)
737 LS_TOKEN_STOKEN (token
).ptr
= start
;
738 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - start
;
741 else if (PARSER_STREAM (parser
)[0] == ':')
743 /* Do not tokenize the C++ scope operator. */
744 if (PARSER_STREAM (parser
)[1] == ':')
745 ++(PARSER_STREAM (parser
));
747 /* Do not tokenize ABI tags such as "[abi:cxx11]". */
748 else if (PARSER_STREAM (parser
) - start
> 4
749 && startswith (PARSER_STREAM (parser
) - 4, "[abi"))
750 ++(PARSER_STREAM (parser
));
752 /* Do not tokenify if the input length so far is one
753 (i.e, a single-letter drive name) and the next character
754 is a directory separator. This allows Windows-style
755 paths to be recognized as filenames without quoting it. */
756 else if ((PARSER_STREAM (parser
) - start
) != 1
757 || !IS_DIR_SEPARATOR (PARSER_STREAM (parser
)[1]))
759 LS_TOKEN_STOKEN (token
).ptr
= start
;
760 LS_TOKEN_STOKEN (token
).length
761 = PARSER_STREAM (parser
) - start
;
765 /* Special case: permit quote-enclosed linespecs. */
766 else if (parser
->is_quote_enclosed
767 && strchr (linespec_quote_characters
,
768 *PARSER_STREAM (parser
))
769 && is_closing_quote_enclosed (PARSER_STREAM (parser
)))
771 LS_TOKEN_STOKEN (token
).ptr
= start
;
772 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - start
;
775 /* Because commas may terminate a linespec and appear in
776 the middle of valid string input, special cases for
777 '<' and '(' are necessary. */
778 else if (*PARSER_STREAM (parser
) == '<'
779 || *PARSER_STREAM (parser
) == '(')
781 /* Don't interpret 'operator<' / 'operator<<' as a
782 template parameter list though. */
783 if (*PARSER_STREAM (parser
) == '<'
784 && (PARSER_STATE (parser
)->language
->la_language
786 && (PARSER_STREAM (parser
) - start
) >= CP_OPERATOR_LEN
)
788 const char *p
= PARSER_STREAM (parser
);
790 while (p
> start
&& isspace (p
[-1]))
792 if (p
- start
>= CP_OPERATOR_LEN
)
794 p
-= CP_OPERATOR_LEN
;
795 if (strncmp (p
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0
797 || !(isalnum (p
[-1]) || p
[-1] == '_')))
799 /* This is an operator name. Keep going. */
800 ++(PARSER_STREAM (parser
));
801 if (*PARSER_STREAM (parser
) == '<')
802 ++(PARSER_STREAM (parser
));
808 const char *p
= find_parameter_list_end (PARSER_STREAM (parser
));
809 PARSER_STREAM (parser
) = p
;
811 /* Don't loop around to the normal \0 case above because
812 we don't want to misinterpret a potential keyword at
813 the end of the token when the string isn't
814 "()<>"-balanced. This handles "b
815 function(thread<tab>" in completion mode. */
818 LS_TOKEN_STOKEN (token
).ptr
= start
;
819 LS_TOKEN_STOKEN (token
).length
820 = PARSER_STREAM (parser
) - start
;
826 /* Commas are terminators, but not if they are part of an
828 else if (*PARSER_STREAM (parser
) == ',')
830 if ((PARSER_STATE (parser
)->language
->la_language
832 && (PARSER_STREAM (parser
) - start
) > CP_OPERATOR_LEN
)
834 const char *p
= strstr (start
, CP_OPERATOR_STR
);
836 if (p
!= NULL
&& is_operator_name (p
))
838 /* This is an operator name. Keep going. */
839 ++(PARSER_STREAM (parser
));
844 /* Comma terminates the string. */
845 LS_TOKEN_STOKEN (token
).ptr
= start
;
846 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - start
;
850 /* Advance the stream. */
851 ++(PARSER_STREAM (parser
));
858 /* Lex a single linespec token from PARSER. */
860 static linespec_token
861 linespec_lexer_lex_one (linespec_parser
*parser
)
865 if (parser
->lexer
.current
.type
== LSTOKEN_CONSUMED
)
867 /* Skip any whitespace. */
868 PARSER_STREAM (parser
) = skip_spaces (PARSER_STREAM (parser
));
870 /* Check for a keyword, they end the linespec. */
871 keyword
= linespec_lexer_lex_keyword (PARSER_STREAM (parser
));
874 parser
->lexer
.current
.type
= LSTOKEN_KEYWORD
;
875 LS_TOKEN_KEYWORD (parser
->lexer
.current
) = keyword
;
876 /* We do not advance the stream here intentionally:
877 we would like lexing to stop when a keyword is seen.
879 PARSER_STREAM (parser) += strlen (keyword); */
881 return parser
->lexer
.current
;
884 /* Handle other tokens. */
885 switch (*PARSER_STREAM (parser
))
888 parser
->lexer
.current
.type
= LSTOKEN_EOI
;
892 case '0': case '1': case '2': case '3': case '4':
893 case '5': case '6': case '7': case '8': case '9':
894 if (!linespec_lexer_lex_number (parser
, &(parser
->lexer
.current
)))
895 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
899 /* If we have a scope operator, lex the input as a string.
900 Otherwise, return LSTOKEN_COLON. */
901 if (PARSER_STREAM (parser
)[1] == ':')
902 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
905 parser
->lexer
.current
.type
= LSTOKEN_COLON
;
906 ++(PARSER_STREAM (parser
));
910 case '\'': case '\"':
911 /* Special case: permit quote-enclosed linespecs. */
912 if (parser
->is_quote_enclosed
913 && is_closing_quote_enclosed (PARSER_STREAM (parser
)))
915 ++(PARSER_STREAM (parser
));
916 parser
->lexer
.current
.type
= LSTOKEN_EOI
;
919 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
923 parser
->lexer
.current
.type
= LSTOKEN_COMMA
;
924 LS_TOKEN_STOKEN (parser
->lexer
.current
).ptr
925 = PARSER_STREAM (parser
);
926 LS_TOKEN_STOKEN (parser
->lexer
.current
).length
= 1;
927 ++(PARSER_STREAM (parser
));
931 /* If the input is not a number, it must be a string.
932 [Keywords were already considered above.] */
933 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
938 return parser
->lexer
.current
;
941 /* Consume the current token and return the next token in PARSER's
942 input stream. Also advance the completion word for completion
945 static linespec_token
946 linespec_lexer_consume_token (linespec_parser
*parser
)
948 gdb_assert (parser
->lexer
.current
.type
!= LSTOKEN_EOI
);
950 bool advance_word
= (parser
->lexer
.current
.type
!= LSTOKEN_STRING
951 || *PARSER_STREAM (parser
) != '\0');
953 /* If we're moving past a string to some other token, it must be the
954 quote was terminated. */
955 if (parser
->completion_quote_char
)
957 gdb_assert (parser
->lexer
.current
.type
== LSTOKEN_STRING
);
959 /* If the string was the last (non-EOI) token, we're past the
960 quote, but remember that for later. */
961 if (*PARSER_STREAM (parser
) != '\0')
963 parser
->completion_quote_char
= '\0';
964 parser
->completion_quote_end
= NULL
;;
968 parser
->lexer
.current
.type
= LSTOKEN_CONSUMED
;
969 linespec_lexer_lex_one (parser
);
971 if (parser
->lexer
.current
.type
== LSTOKEN_STRING
)
973 /* Advance the completion word past a potential initial
975 parser
->completion_word
= LS_TOKEN_STOKEN (parser
->lexer
.current
).ptr
;
977 else if (advance_word
)
979 /* Advance the completion word past any whitespace. */
980 parser
->completion_word
= PARSER_STREAM (parser
);
983 return parser
->lexer
.current
;
986 /* Return the next token without consuming the current token. */
988 static linespec_token
989 linespec_lexer_peek_token (linespec_parser
*parser
)
992 const char *saved_stream
= PARSER_STREAM (parser
);
993 linespec_token saved_token
= parser
->lexer
.current
;
994 int saved_completion_quote_char
= parser
->completion_quote_char
;
995 const char *saved_completion_quote_end
= parser
->completion_quote_end
;
996 const char *saved_completion_word
= parser
->completion_word
;
998 next
= linespec_lexer_consume_token (parser
);
999 PARSER_STREAM (parser
) = saved_stream
;
1000 parser
->lexer
.current
= saved_token
;
1001 parser
->completion_quote_char
= saved_completion_quote_char
;
1002 parser
->completion_quote_end
= saved_completion_quote_end
;
1003 parser
->completion_word
= saved_completion_word
;
1007 /* Helper functions. */
1009 /* Add SAL to SALS, and also update SELF->CANONICAL_NAMES to reflect
1010 the new sal, if needed. If not NULL, SYMNAME is the name of the
1011 symbol to use when constructing the new canonical name.
1013 If LITERAL_CANONICAL is non-zero, SYMNAME will be used as the
1014 canonical name for the SAL. */
1017 add_sal_to_sals (struct linespec_state
*self
,
1018 std::vector
<symtab_and_line
> *sals
,
1019 struct symtab_and_line
*sal
,
1020 const char *symname
, int literal_canonical
)
1022 sals
->push_back (*sal
);
1024 if (self
->canonical
)
1026 struct linespec_canonical_name
*canonical
;
1028 self
->canonical_names
= XRESIZEVEC (struct linespec_canonical_name
,
1029 self
->canonical_names
,
1031 canonical
= &self
->canonical_names
[sals
->size () - 1];
1032 if (!literal_canonical
&& sal
->symtab
)
1034 symtab_to_fullname (sal
->symtab
);
1036 /* Note that the filter doesn't have to be a valid linespec
1037 input. We only apply the ":LINE" treatment to Ada for
1039 if (symname
!= NULL
&& sal
->line
!= 0
1040 && self
->language
->la_language
== language_ada
)
1041 canonical
->suffix
= xstrprintf ("%s:%d", symname
, sal
->line
);
1042 else if (symname
!= NULL
)
1043 canonical
->suffix
= xstrdup (symname
);
1045 canonical
->suffix
= xstrprintf ("%d", sal
->line
);
1046 canonical
->symtab
= sal
->symtab
;
1050 if (symname
!= NULL
)
1051 canonical
->suffix
= xstrdup (symname
);
1053 canonical
->suffix
= xstrdup ("<unknown>");
1054 canonical
->symtab
= NULL
;
1059 /* A hash function for address_entry. */
1062 hash_address_entry (const void *p
)
1064 const struct address_entry
*aep
= (const struct address_entry
*) p
;
1067 hash
= iterative_hash_object (aep
->pspace
, 0);
1068 return iterative_hash_object (aep
->addr
, hash
);
1071 /* An equality function for address_entry. */
1074 eq_address_entry (const void *a
, const void *b
)
1076 const struct address_entry
*aea
= (const struct address_entry
*) a
;
1077 const struct address_entry
*aeb
= (const struct address_entry
*) b
;
1079 return aea
->pspace
== aeb
->pspace
&& aea
->addr
== aeb
->addr
;
1082 /* Check whether the address, represented by PSPACE and ADDR, is
1083 already in the set. If so, return 0. Otherwise, add it and return
1087 maybe_add_address (htab_t set
, struct program_space
*pspace
, CORE_ADDR addr
)
1089 struct address_entry e
, *p
;
1094 slot
= htab_find_slot (set
, &e
, INSERT
);
1098 p
= XNEW (struct address_entry
);
1099 memcpy (p
, &e
, sizeof (struct address_entry
));
1105 /* A helper that walks over all matching symtabs in all objfiles and
1106 calls CALLBACK for each symbol matching NAME. If SEARCH_PSPACE is
1107 not NULL, then the search is restricted to just that program
1108 space. If INCLUDE_INLINE is true then symbols representing
1109 inlined instances of functions will be included in the result. */
1112 iterate_over_all_matching_symtabs
1113 (struct linespec_state
*state
,
1114 const lookup_name_info
&lookup_name
,
1115 const domain_enum name_domain
,
1116 enum search_domain search_domain
,
1117 struct program_space
*search_pspace
, bool include_inline
,
1118 gdb::function_view
<symbol_found_callback_ftype
> callback
)
1120 struct objfile
*objfile
;
1121 struct program_space
*pspace
;
1123 ALL_PSPACES (pspace
)
1125 if (search_pspace
!= NULL
&& search_pspace
!= pspace
)
1127 if (pspace
->executing_startup
)
1130 set_current_program_space (pspace
);
1132 ALL_OBJFILES (objfile
)
1134 struct compunit_symtab
*cu
;
1137 objfile
->sf
->qf
->expand_symtabs_matching (objfile
,
1143 ALL_OBJFILE_COMPUNITS (objfile
, cu
)
1145 struct symtab
*symtab
= COMPUNIT_FILETABS (cu
);
1147 iterate_over_file_blocks (symtab
, lookup_name
, name_domain
, callback
);
1151 struct block
*block
;
1154 for (i
= FIRST_LOCAL_BLOCK
;
1155 i
< BLOCKVECTOR_NBLOCKS (SYMTAB_BLOCKVECTOR (symtab
));
1158 block
= BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab
), i
);
1159 state
->language
->la_iterate_over_symbols
1160 (block
, lookup_name
, name_domain
, [&] (symbol
*sym
)
1162 /* Restrict calls to CALLBACK to symbols
1163 representing inline symbols only. */
1164 if (SYMBOL_INLINED (sym
))
1165 return callback (sym
);
1175 /* Returns the block to be used for symbol searches from
1176 the current location. */
1178 static const struct block
*
1179 get_current_search_block (void)
1181 const struct block
*block
;
1182 enum language save_language
;
1184 /* get_selected_block can change the current language when there is
1185 no selected frame yet. */
1186 save_language
= current_language
->la_language
;
1187 block
= get_selected_block (0);
1188 set_language (save_language
);
1193 /* Iterate over static and global blocks. */
1196 iterate_over_file_blocks
1197 (struct symtab
*symtab
, const lookup_name_info
&name
,
1198 domain_enum domain
, gdb::function_view
<symbol_found_callback_ftype
> callback
)
1200 struct block
*block
;
1202 for (block
= BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab
), STATIC_BLOCK
);
1204 block
= BLOCK_SUPERBLOCK (block
))
1205 LA_ITERATE_OVER_SYMBOLS (block
, name
, domain
, callback
);
1208 /* A helper for find_method. This finds all methods in type T of
1209 language T_LANG which match NAME. It adds matching symbol names to
1210 RESULT_NAMES, and adds T's direct superclasses to SUPERCLASSES. */
1213 find_methods (struct type
*t
, enum language t_lang
, const char *name
,
1214 VEC (const_char_ptr
) **result_names
,
1215 VEC (typep
) **superclasses
)
1218 const char *class_name
= type_name_no_tag (t
);
1220 /* Ignore this class if it doesn't have a name. This is ugly, but
1221 unless we figure out how to get the physname without the name of
1222 the class, then the loop can't do any good. */
1226 lookup_name_info
lookup_name (name
, symbol_name_match_type::FULL
);
1227 symbol_name_matcher_ftype
*symbol_name_compare
1228 = get_symbol_name_matcher (language_def (t_lang
), lookup_name
);
1230 t
= check_typedef (t
);
1232 /* Loop over each method name. At this level, all overloads of a name
1233 are counted as a single name. There is an inner loop which loops over
1236 for (method_counter
= TYPE_NFN_FIELDS (t
) - 1;
1237 method_counter
>= 0;
1240 const char *method_name
= TYPE_FN_FIELDLIST_NAME (t
, method_counter
);
1241 char dem_opname
[64];
1243 if (startswith (method_name
, "__") ||
1244 startswith (method_name
, "op") ||
1245 startswith (method_name
, "type"))
1247 if (cplus_demangle_opname (method_name
, dem_opname
, DMGL_ANSI
))
1248 method_name
= dem_opname
;
1249 else if (cplus_demangle_opname (method_name
, dem_opname
, 0))
1250 method_name
= dem_opname
;
1253 if (symbol_name_compare (method_name
, lookup_name
, NULL
))
1257 for (field_counter
= (TYPE_FN_FIELDLIST_LENGTH (t
, method_counter
)
1263 const char *phys_name
;
1265 f
= TYPE_FN_FIELDLIST1 (t
, method_counter
);
1266 if (TYPE_FN_FIELD_STUB (f
, field_counter
))
1268 phys_name
= TYPE_FN_FIELD_PHYSNAME (f
, field_counter
);
1269 VEC_safe_push (const_char_ptr
, *result_names
, phys_name
);
1275 for (ibase
= 0; ibase
< TYPE_N_BASECLASSES (t
); ibase
++)
1276 VEC_safe_push (typep
, *superclasses
, TYPE_BASECLASS (t
, ibase
));
1279 /* Find an instance of the character C in the string S that is outside
1280 of all parenthesis pairs, single-quoted strings, and double-quoted
1281 strings. Also, ignore the char within a template name, like a ','
1282 within foo<int, int>, while considering C++ operator</operator<<. */
1285 find_toplevel_char (const char *s
, char c
)
1287 int quoted
= 0; /* zero if we're not in quotes;
1288 '"' if we're in a double-quoted string;
1289 '\'' if we're in a single-quoted string. */
1290 int depth
= 0; /* Number of unclosed parens we've seen. */
1293 for (scan
= s
; *scan
; scan
++)
1297 if (*scan
== quoted
)
1299 else if (*scan
== '\\' && *(scan
+ 1))
1302 else if (*scan
== c
&& ! quoted
&& depth
== 0)
1304 else if (*scan
== '"' || *scan
== '\'')
1306 else if (*scan
== '(' || *scan
== '<')
1308 else if ((*scan
== ')' || *scan
== '>') && depth
> 0)
1310 else if (*scan
== 'o' && !quoted
&& depth
== 0)
1312 /* Handle C++ operator names. */
1313 if (strncmp (scan
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0)
1315 scan
+= CP_OPERATOR_LEN
;
1318 while (isspace (*scan
))
1329 /* Skip over one less than the appropriate number of
1330 characters: the for loop will skip over the last
1356 /* The string equivalent of find_toplevel_char. Returns a pointer
1357 to the location of NEEDLE in HAYSTACK, ignoring any occurrences
1358 inside "()" and "<>". Returns NULL if NEEDLE was not found. */
1361 find_toplevel_string (const char *haystack
, const char *needle
)
1363 const char *s
= haystack
;
1367 s
= find_toplevel_char (s
, *needle
);
1371 /* Found first char in HAYSTACK; check rest of string. */
1372 if (startswith (s
, needle
))
1375 /* Didn't find it; loop over HAYSTACK, looking for the next
1376 instance of the first character of NEEDLE. */
1380 while (s
!= NULL
&& *s
!= '\0');
1382 /* NEEDLE was not found in HAYSTACK. */
1386 /* Convert CANONICAL to its string representation using
1387 symtab_to_fullname for SYMTAB. */
1390 canonical_to_fullform (const struct linespec_canonical_name
*canonical
)
1392 if (canonical
->symtab
== NULL
)
1393 return canonical
->suffix
;
1395 return string_printf ("%s:%s", symtab_to_fullname (canonical
->symtab
),
1399 /* Given FILTERS, a list of canonical names, filter the sals in RESULT
1400 and store the result in SELF->CANONICAL. */
1403 filter_results (struct linespec_state
*self
,
1404 std::vector
<symtab_and_line
> *result
,
1405 VEC (const_char_ptr
) *filters
)
1410 for (i
= 0; VEC_iterate (const_char_ptr
, filters
, i
, name
); ++i
)
1414 for (size_t j
= 0; j
< result
->size (); ++j
)
1416 const struct linespec_canonical_name
*canonical
;
1418 canonical
= &self
->canonical_names
[j
];
1419 std::string fullform
= canonical_to_fullform (canonical
);
1421 if (name
== fullform
)
1422 lsal
.sals
.push_back ((*result
)[j
]);
1425 if (!lsal
.sals
.empty ())
1427 lsal
.canonical
= xstrdup (name
);
1428 self
->canonical
->lsals
.push_back (std::move (lsal
));
1432 self
->canonical
->pre_expanded
= 0;
1435 /* Store RESULT into SELF->CANONICAL. */
1438 convert_results_to_lsals (struct linespec_state
*self
,
1439 std::vector
<symtab_and_line
> *result
)
1441 struct linespec_sals lsal
;
1443 lsal
.canonical
= NULL
;
1444 lsal
.sals
= std::move (*result
);
1445 self
->canonical
->lsals
.push_back (std::move (lsal
));
1448 /* A structure that contains two string representations of a struct
1449 linespec_canonical_name:
1450 - one where the the symtab's fullname is used;
1451 - one where the filename followed the "set filename-display"
1454 struct decode_line_2_item
1456 decode_line_2_item (std::string
&&fullform_
, std::string
&&displayform_
,
1458 : fullform (std::move (fullform_
)),
1459 displayform (std::move (displayform_
)),
1460 selected (selected_
)
1464 /* The form using symtab_to_fullname. */
1465 std::string fullform
;
1467 /* The form using symtab_to_filename_for_display. */
1468 std::string displayform
;
1470 /* Field is initialized to zero and it is set to one if the user
1471 requested breakpoint for this entry. */
1472 unsigned int selected
: 1;
1475 /* Helper for std::sort to sort decode_line_2_item entries by
1476 DISPLAYFORM and secondarily by FULLFORM. */
1479 decode_line_2_compare_items (const decode_line_2_item
&a
,
1480 const decode_line_2_item
&b
)
1482 if (a
.displayform
!= b
.displayform
)
1483 return a
.displayform
< b
.displayform
;
1484 return a
.fullform
< b
.fullform
;
1487 /* Handle multiple results in RESULT depending on SELECT_MODE. This
1488 will either return normally, throw an exception on multiple
1489 results, or present a menu to the user. On return, the SALS vector
1490 in SELF->CANONICAL is set up properly. */
1493 decode_line_2 (struct linespec_state
*self
,
1494 std::vector
<symtab_and_line
> *result
,
1495 const char *select_mode
)
1500 struct cleanup
*old_chain
;
1501 VEC (const_char_ptr
) *filters
= NULL
;
1502 std::vector
<struct decode_line_2_item
> items
;
1504 gdb_assert (select_mode
!= multiple_symbols_all
);
1505 gdb_assert (self
->canonical
!= NULL
);
1506 gdb_assert (!result
->empty ());
1508 old_chain
= make_cleanup (VEC_cleanup (const_char_ptr
), &filters
);
1510 /* Prepare ITEMS array. */
1511 for (i
= 0; i
< result
->size (); ++i
)
1513 const struct linespec_canonical_name
*canonical
;
1514 struct decode_line_2_item
*item
;
1516 std::string displayform
;
1518 canonical
= &self
->canonical_names
[i
];
1519 gdb_assert (canonical
->suffix
!= NULL
);
1521 std::string fullform
= canonical_to_fullform (canonical
);
1523 if (canonical
->symtab
== NULL
)
1524 displayform
= canonical
->suffix
;
1527 const char *fn_for_display
;
1529 fn_for_display
= symtab_to_filename_for_display (canonical
->symtab
);
1530 displayform
= string_printf ("%s:%s", fn_for_display
,
1534 items
.emplace_back (std::move (fullform
), std::move (displayform
),
1538 /* Sort the list of method names. */
1539 std::sort (items
.begin (), items
.end (), decode_line_2_compare_items
);
1541 /* Remove entries with the same FULLFORM. */
1542 items
.erase (std::unique (items
.begin (), items
.end (),
1543 [] (const struct decode_line_2_item
&a
,
1544 const struct decode_line_2_item
&b
)
1546 return a
.fullform
== b
.fullform
;
1550 if (select_mode
== multiple_symbols_cancel
&& items
.size () > 1)
1551 error (_("canceled because the command is ambiguous\n"
1552 "See set/show multiple-symbol."));
1554 if (select_mode
== multiple_symbols_all
|| items
.size () == 1)
1556 do_cleanups (old_chain
);
1557 convert_results_to_lsals (self
, result
);
1561 printf_unfiltered (_("[0] cancel\n[1] all\n"));
1562 for (i
= 0; i
< items
.size (); i
++)
1563 printf_unfiltered ("[%d] %s\n", i
+ 2, items
[i
].displayform
.c_str ());
1565 prompt
= getenv ("PS2");
1570 args
= command_line_input (prompt
, 0, "overload-choice");
1572 if (args
== 0 || *args
== 0)
1573 error_no_arg (_("one or more choice numbers"));
1575 number_or_range_parser
parser (args
);
1576 while (!parser
.finished ())
1578 int num
= parser
.get_number ();
1581 error (_("canceled"));
1584 /* We intentionally make this result in a single breakpoint,
1585 contrary to what older versions of gdb did. The
1586 rationale is that this lets a user get the
1587 multiple_symbols_all behavior even with the 'ask'
1588 setting; and he can get separate breakpoints by entering
1589 "2-57" at the query. */
1590 do_cleanups (old_chain
);
1591 convert_results_to_lsals (self
, result
);
1596 if (num
>= items
.size ())
1597 printf_unfiltered (_("No choice number %d.\n"), num
);
1600 struct decode_line_2_item
*item
= &items
[num
];
1602 if (!item
->selected
)
1604 VEC_safe_push (const_char_ptr
, filters
, item
->fullform
.c_str ());
1609 printf_unfiltered (_("duplicate request for %d ignored.\n"),
1615 filter_results (self
, result
, filters
);
1616 do_cleanups (old_chain
);
1621 /* The parser of linespec itself. */
1623 /* Throw an appropriate error when SYMBOL is not found (optionally in
1626 static void ATTRIBUTE_NORETURN
1627 symbol_not_found_error (const char *symbol
, const char *filename
)
1632 if (!have_full_symbols ()
1633 && !have_partial_symbols ()
1634 && !have_minimal_symbols ())
1635 throw_error (NOT_FOUND_ERROR
,
1636 _("No symbol table is loaded. Use the \"file\" command."));
1638 /* If SYMBOL starts with '$', the user attempted to either lookup
1639 a function/variable in his code starting with '$' or an internal
1640 variable of that name. Since we do not know which, be concise and
1641 explain both possibilities. */
1645 throw_error (NOT_FOUND_ERROR
,
1646 _("Undefined convenience variable or function \"%s\" "
1647 "not defined in \"%s\"."), symbol
, filename
);
1649 throw_error (NOT_FOUND_ERROR
,
1650 _("Undefined convenience variable or function \"%s\" "
1651 "not defined."), symbol
);
1656 throw_error (NOT_FOUND_ERROR
,
1657 _("Function \"%s\" not defined in \"%s\"."),
1660 throw_error (NOT_FOUND_ERROR
,
1661 _("Function \"%s\" not defined."), symbol
);
1665 /* Throw an appropriate error when an unexpected token is encountered
1668 static void ATTRIBUTE_NORETURN
1669 unexpected_linespec_error (linespec_parser
*parser
)
1671 linespec_token token
;
1672 static const char * token_type_strings
[]
1673 = {"keyword", "colon", "string", "number", "comma", "end of input"};
1675 /* Get the token that generated the error. */
1676 token
= linespec_lexer_lex_one (parser
);
1678 /* Finally, throw the error. */
1679 if (token
.type
== LSTOKEN_STRING
|| token
.type
== LSTOKEN_NUMBER
1680 || token
.type
== LSTOKEN_KEYWORD
)
1682 gdb::unique_xmalloc_ptr
<char> string
= copy_token_string (token
);
1683 throw_error (GENERIC_ERROR
,
1684 _("malformed linespec error: unexpected %s, \"%s\""),
1685 token_type_strings
[token
.type
], string
.get ());
1688 throw_error (GENERIC_ERROR
,
1689 _("malformed linespec error: unexpected %s"),
1690 token_type_strings
[token
.type
]);
1693 /* Throw an undefined label error. */
1695 static void ATTRIBUTE_NORETURN
1696 undefined_label_error (const char *function
, const char *label
)
1698 if (function
!= NULL
)
1699 throw_error (NOT_FOUND_ERROR
,
1700 _("No label \"%s\" defined in function \"%s\"."),
1703 throw_error (NOT_FOUND_ERROR
,
1704 _("No label \"%s\" defined in current function."),
1708 /* Throw a source file not found error. */
1710 static void ATTRIBUTE_NORETURN
1711 source_file_not_found_error (const char *name
)
1713 throw_error (NOT_FOUND_ERROR
, _("No source file named %s."), name
);
1716 /* Unless at EIO, save the current stream position as completion word
1717 point, and consume the next token. */
1719 static linespec_token
1720 save_stream_and_consume_token (linespec_parser
*parser
)
1722 if (linespec_lexer_peek_token (parser
).type
!= LSTOKEN_EOI
)
1723 parser
->completion_word
= PARSER_STREAM (parser
);
1724 return linespec_lexer_consume_token (parser
);
1727 /* See description in linespec.h. */
1730 linespec_parse_line_offset (const char *string
)
1732 const char *start
= string
;
1733 struct line_offset line_offset
= {0, LINE_OFFSET_NONE
};
1737 line_offset
.sign
= LINE_OFFSET_PLUS
;
1740 else if (*string
== '-')
1742 line_offset
.sign
= LINE_OFFSET_MINUS
;
1746 if (*string
!= '\0' && !isdigit (*string
))
1747 error (_("malformed line offset: \"%s\""), start
);
1749 /* Right now, we only allow base 10 for offsets. */
1750 line_offset
.offset
= atoi (string
);
1754 /* In completion mode, if the user is still typing the number, there's
1755 no possible completion to offer. But if there's already input past
1756 the number, setup to expect NEXT. */
1759 set_completion_after_number (linespec_parser
*parser
,
1760 linespec_complete_what next
)
1762 if (*PARSER_STREAM (parser
) == ' ')
1764 parser
->completion_word
= skip_spaces (PARSER_STREAM (parser
) + 1);
1765 parser
->complete_what
= next
;
1769 parser
->completion_word
= PARSER_STREAM (parser
);
1770 parser
->complete_what
= linespec_complete_what::NOTHING
;
1774 /* Parse the basic_spec in PARSER's input. */
1777 linespec_parse_basic (linespec_parser
*parser
)
1779 gdb::unique_xmalloc_ptr
<char> name
;
1780 linespec_token token
;
1781 VEC (symbolp
) *symbols
, *labels
;
1782 VEC (bound_minimal_symbol_d
) *minimal_symbols
;
1784 /* Get the next token. */
1785 token
= linespec_lexer_lex_one (parser
);
1787 /* If it is EOI or KEYWORD, issue an error. */
1788 if (token
.type
== LSTOKEN_KEYWORD
)
1790 parser
->complete_what
= linespec_complete_what::NOTHING
;
1791 unexpected_linespec_error (parser
);
1793 else if (token
.type
== LSTOKEN_EOI
)
1795 unexpected_linespec_error (parser
);
1797 /* If it is a LSTOKEN_NUMBER, we have an offset. */
1798 else if (token
.type
== LSTOKEN_NUMBER
)
1800 set_completion_after_number (parser
, linespec_complete_what::KEYWORD
);
1802 /* Record the line offset and get the next token. */
1803 name
= copy_token_string (token
);
1804 PARSER_EXPLICIT (parser
)->line_offset
1805 = linespec_parse_line_offset (name
.get ());
1807 /* Get the next token. */
1808 token
= linespec_lexer_consume_token (parser
);
1810 /* If the next token is a comma, stop parsing and return. */
1811 if (token
.type
== LSTOKEN_COMMA
)
1813 parser
->complete_what
= linespec_complete_what::NOTHING
;
1817 /* If the next token is anything but EOI or KEYWORD, issue
1819 if (token
.type
!= LSTOKEN_KEYWORD
&& token
.type
!= LSTOKEN_EOI
)
1820 unexpected_linespec_error (parser
);
1823 if (token
.type
== LSTOKEN_KEYWORD
|| token
.type
== LSTOKEN_EOI
)
1826 /* Next token must be LSTOKEN_STRING. */
1827 if (token
.type
!= LSTOKEN_STRING
)
1829 parser
->complete_what
= linespec_complete_what::NOTHING
;
1830 unexpected_linespec_error (parser
);
1833 /* The current token will contain the name of a function, method,
1835 name
= copy_token_string (token
);
1837 if (parser
->completion_tracker
!= NULL
)
1839 /* If the function name ends with a ":", then this may be an
1840 incomplete "::" scope operator instead of a label separator.
1843 which should expand to:
1846 Do a tentative completion assuming the later. If we find
1847 completions, advance the stream past the colon token and make
1848 it part of the function name/token. */
1850 if (!parser
->completion_quote_char
1851 && strcmp (PARSER_STREAM (parser
), ":") == 0)
1853 completion_tracker tmp_tracker
;
1854 const char *source_filename
1855 = PARSER_EXPLICIT (parser
)->source_filename
;
1856 symbol_name_match_type match_type
1857 = PARSER_EXPLICIT (parser
)->func_name_match_type
;
1859 linespec_complete_function (tmp_tracker
,
1860 parser
->completion_word
,
1864 if (tmp_tracker
.have_completions ())
1866 PARSER_STREAM (parser
)++;
1867 LS_TOKEN_STOKEN (token
).length
++;
1869 name
.reset (savestring (parser
->completion_word
,
1870 (PARSER_STREAM (parser
)
1871 - parser
->completion_word
)));
1875 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1879 /* Try looking it up as a function/method. */
1880 find_linespec_symbols (PARSER_STATE (parser
),
1881 PARSER_RESULT (parser
)->file_symtabs
, name
.get (),
1882 PARSER_EXPLICIT (parser
)->func_name_match_type
,
1883 &symbols
, &minimal_symbols
);
1885 if (symbols
!= NULL
|| minimal_symbols
!= NULL
)
1887 PARSER_RESULT (parser
)->function_symbols
= symbols
;
1888 PARSER_RESULT (parser
)->minimal_symbols
= minimal_symbols
;
1889 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1894 /* NAME was not a function or a method. So it must be a label
1895 name or user specified variable like "break foo.c:$zippo". */
1896 labels
= find_label_symbols (PARSER_STATE (parser
), NULL
,
1897 &symbols
, name
.get ());
1900 PARSER_RESULT (parser
)->labels
.label_symbols
= labels
;
1901 PARSER_RESULT (parser
)->labels
.function_symbols
= symbols
;
1902 PARSER_EXPLICIT (parser
)->label_name
= name
.release ();
1905 else if (token
.type
== LSTOKEN_STRING
1906 && *LS_TOKEN_STOKEN (token
).ptr
== '$')
1908 /* User specified a convenience variable or history value. */
1909 PARSER_EXPLICIT (parser
)->line_offset
1910 = linespec_parse_variable (PARSER_STATE (parser
), name
.get ());
1912 if (PARSER_EXPLICIT (parser
)->line_offset
.sign
== LINE_OFFSET_UNKNOWN
)
1914 /* The user-specified variable was not valid. Do not
1915 throw an error here. parse_linespec will do it for us. */
1916 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1922 /* The name is also not a label. Abort parsing. Do not throw
1923 an error here. parse_linespec will do it for us. */
1925 /* Save a copy of the name we were trying to lookup. */
1926 PARSER_EXPLICIT (parser
)->function_name
= name
.release ();
1932 int previous_qc
= parser
->completion_quote_char
;
1934 /* Get the next token. */
1935 token
= linespec_lexer_consume_token (parser
);
1937 if (token
.type
== LSTOKEN_EOI
)
1939 if (previous_qc
&& !parser
->completion_quote_char
)
1940 parser
->complete_what
= linespec_complete_what::KEYWORD
;
1942 else if (token
.type
== LSTOKEN_COLON
)
1944 /* User specified a label or a lineno. */
1945 token
= linespec_lexer_consume_token (parser
);
1947 if (token
.type
== LSTOKEN_NUMBER
)
1949 /* User specified an offset. Record the line offset and
1950 get the next token. */
1951 set_completion_after_number (parser
, linespec_complete_what::KEYWORD
);
1953 name
= copy_token_string (token
);
1954 PARSER_EXPLICIT (parser
)->line_offset
1955 = linespec_parse_line_offset (name
.get ());
1957 /* Get the next token. */
1958 token
= linespec_lexer_consume_token (parser
);
1960 else if (token
.type
== LSTOKEN_EOI
&& parser
->completion_tracker
!= NULL
)
1962 parser
->complete_what
= linespec_complete_what::LABEL
;
1964 else if (token
.type
== LSTOKEN_STRING
)
1966 parser
->complete_what
= linespec_complete_what::LABEL
;
1968 /* If we have text after the label separated by whitespace
1969 (e.g., "b func():lab i<tab>"), don't consider it part of
1970 the label. In completion mode that should complete to
1971 "if", in normal mode, the 'i' should be treated as
1973 if (parser
->completion_quote_char
== '\0')
1975 const char *ptr
= LS_TOKEN_STOKEN (token
).ptr
;
1976 for (size_t i
= 0; i
< LS_TOKEN_STOKEN (token
).length
; i
++)
1980 LS_TOKEN_STOKEN (token
).length
= i
;
1981 PARSER_STREAM (parser
) = skip_spaces (ptr
+ i
+ 1);
1987 if (parser
->completion_tracker
!= NULL
)
1989 if (PARSER_STREAM (parser
)[-1] == ' ')
1991 parser
->completion_word
= PARSER_STREAM (parser
);
1992 parser
->complete_what
= linespec_complete_what::KEYWORD
;
1997 /* Grab a copy of the label's name and look it up. */
1998 name
= copy_token_string (token
);
2000 = find_label_symbols (PARSER_STATE (parser
),
2001 PARSER_RESULT (parser
)->function_symbols
,
2002 &symbols
, name
.get ());
2006 PARSER_RESULT (parser
)->labels
.label_symbols
= labels
;
2007 PARSER_RESULT (parser
)->labels
.function_symbols
= symbols
;
2008 PARSER_EXPLICIT (parser
)->label_name
= name
.release ();
2013 /* We don't know what it was, but it isn't a label. */
2014 undefined_label_error
2015 (PARSER_EXPLICIT (parser
)->function_name
, name
.get ());
2020 /* Check for a line offset. */
2021 token
= save_stream_and_consume_token (parser
);
2022 if (token
.type
== LSTOKEN_COLON
)
2024 /* Get the next token. */
2025 token
= linespec_lexer_consume_token (parser
);
2027 /* It must be a line offset. */
2028 if (token
.type
!= LSTOKEN_NUMBER
)
2029 unexpected_linespec_error (parser
);
2031 /* Record the line offset and get the next token. */
2032 name
= copy_token_string (token
);
2034 PARSER_EXPLICIT (parser
)->line_offset
2035 = linespec_parse_line_offset (name
.get ());
2037 /* Get the next token. */
2038 token
= linespec_lexer_consume_token (parser
);
2043 /* Trailing ':' in the input. Issue an error. */
2044 unexpected_linespec_error (parser
);
2049 /* Canonicalize the linespec contained in LS. The result is saved into
2050 STATE->canonical. This function handles both linespec and explicit
2054 canonicalize_linespec (struct linespec_state
*state
, const linespec_p ls
)
2056 struct event_location
*canon
;
2057 struct explicit_location
*explicit_loc
;
2059 /* If canonicalization was not requested, no need to do anything. */
2060 if (!state
->canonical
)
2063 /* Save everything as an explicit location. */
2064 state
->canonical
->location
2065 = new_explicit_location (&ls
->explicit_loc
);
2066 canon
= state
->canonical
->location
.get ();
2067 explicit_loc
= get_explicit_location (canon
);
2069 if (explicit_loc
->label_name
!= NULL
)
2071 state
->canonical
->special_display
= 1;
2073 if (explicit_loc
->function_name
== NULL
)
2077 /* No function was specified, so add the symbol name. */
2078 gdb_assert (ls
->labels
.function_symbols
!= NULL
2079 && (VEC_length (symbolp
, ls
->labels
.function_symbols
)
2081 s
= VEC_index (symbolp
, ls
->labels
.function_symbols
, 0);
2082 explicit_loc
->function_name
= xstrdup (SYMBOL_NATURAL_NAME (s
));
2086 /* If this location originally came from a linespec, save a string
2087 representation of it for display and saving to file. */
2088 if (state
->is_linespec
)
2090 char *linespec
= explicit_location_to_linespec (explicit_loc
);
2092 set_event_location_string (canon
, linespec
);
2097 /* Given a line offset in LS, construct the relevant SALs. */
2099 static std::vector
<symtab_and_line
>
2100 create_sals_line_offset (struct linespec_state
*self
,
2103 int use_default
= 0;
2105 /* This is where we need to make sure we have good defaults.
2106 We must guarantee that this section of code is never executed
2107 when we are called with just a function name, since
2108 set_default_source_symtab_and_line uses
2109 select_source_symtab that calls us with such an argument. */
2111 if (VEC_length (symtab_ptr
, ls
->file_symtabs
) == 1
2112 && VEC_index (symtab_ptr
, ls
->file_symtabs
, 0) == NULL
)
2114 const char *fullname
;
2116 set_current_program_space (self
->program_space
);
2118 /* Make sure we have at least a default source line. */
2119 set_default_source_symtab_and_line ();
2120 initialize_defaults (&self
->default_symtab
, &self
->default_line
);
2121 fullname
= symtab_to_fullname (self
->default_symtab
);
2122 VEC_pop (symtab_ptr
, ls
->file_symtabs
);
2123 VEC_free (symtab_ptr
, ls
->file_symtabs
);
2124 ls
->file_symtabs
= collect_symtabs_from_filename (fullname
,
2125 self
->search_pspace
);
2129 symtab_and_line val
;
2130 val
.line
= ls
->explicit_loc
.line_offset
.offset
;
2131 switch (ls
->explicit_loc
.line_offset
.sign
)
2133 case LINE_OFFSET_PLUS
:
2134 if (ls
->explicit_loc
.line_offset
.offset
== 0)
2137 val
.line
= self
->default_line
+ val
.line
;
2140 case LINE_OFFSET_MINUS
:
2141 if (ls
->explicit_loc
.line_offset
.offset
== 0)
2144 val
.line
= self
->default_line
- val
.line
;
2146 val
.line
= -val
.line
;
2149 case LINE_OFFSET_NONE
:
2150 break; /* No need to adjust val.line. */
2153 std::vector
<symtab_and_line
> values
;
2154 if (self
->list_mode
)
2155 values
= decode_digits_list_mode (self
, ls
, val
);
2158 struct linetable_entry
*best_entry
= NULL
;
2161 std::vector
<symtab_and_line
> intermediate_results
2162 = decode_digits_ordinary (self
, ls
, val
.line
, &best_entry
);
2163 if (intermediate_results
.empty () && best_entry
!= NULL
)
2164 intermediate_results
= decode_digits_ordinary (self
, ls
,
2168 /* For optimized code, the compiler can scatter one source line
2169 across disjoint ranges of PC values, even when no duplicate
2170 functions or inline functions are involved. For example,
2171 'for (;;)' inside a non-template, non-inline, and non-ctor-or-dtor
2172 function can result in two PC ranges. In this case, we don't
2173 want to set a breakpoint on the first PC of each range. To filter
2174 such cases, we use containing blocks -- for each PC found
2175 above, we see if there are other PCs that are in the same
2176 block. If yes, the other PCs are filtered out. */
2178 gdb::def_vector
<int> filter (intermediate_results
.size ());
2179 gdb::def_vector
<const block
*> blocks (intermediate_results
.size ());
2181 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2183 set_current_program_space (intermediate_results
[i
].pspace
);
2186 blocks
[i
] = block_for_pc_sect (intermediate_results
[i
].pc
,
2187 intermediate_results
[i
].section
);
2190 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2192 if (blocks
[i
] != NULL
)
2193 for (j
= i
+ 1; j
< intermediate_results
.size (); ++j
)
2195 if (blocks
[j
] == blocks
[i
])
2203 for (i
= 0; i
< intermediate_results
.size (); ++i
)
2206 struct symbol
*sym
= (blocks
[i
]
2207 ? block_containing_function (blocks
[i
])
2210 if (self
->funfirstline
)
2211 skip_prologue_sal (&intermediate_results
[i
]);
2212 add_sal_to_sals (self
, &values
, &intermediate_results
[i
],
2213 sym
? SYMBOL_NATURAL_NAME (sym
) : NULL
, 0);
2217 if (values
.empty ())
2219 if (ls
->explicit_loc
.source_filename
)
2220 throw_error (NOT_FOUND_ERROR
, _("No line %d in file \"%s\"."),
2221 val
.line
, ls
->explicit_loc
.source_filename
);
2223 throw_error (NOT_FOUND_ERROR
, _("No line %d in the current file."),
2230 /* Convert the given ADDRESS into SaLs. */
2232 static std::vector
<symtab_and_line
>
2233 convert_address_location_to_sals (struct linespec_state
*self
,
2236 symtab_and_line sal
= find_pc_line (address
, 0);
2238 sal
.section
= find_pc_overlay (address
);
2239 sal
.explicit_pc
= 1;
2241 std::vector
<symtab_and_line
> sals
;
2242 add_sal_to_sals (self
, &sals
, &sal
, core_addr_to_string (address
), 1);
2247 /* Create and return SALs from the linespec LS. */
2249 static std::vector
<symtab_and_line
>
2250 convert_linespec_to_sals (struct linespec_state
*state
, linespec_p ls
)
2252 std::vector
<symtab_and_line
> sals
;
2254 if (ls
->labels
.label_symbols
!= NULL
)
2256 /* We have just a bunch of functions/methods or labels. */
2258 struct symtab_and_line sal
;
2261 for (i
= 0; VEC_iterate (symbolp
, ls
->labels
.label_symbols
, i
, sym
); ++i
)
2263 struct program_space
*pspace
= SYMTAB_PSPACE (symbol_symtab (sym
));
2265 if (symbol_to_sal (&sal
, state
->funfirstline
, sym
)
2266 && maybe_add_address (state
->addr_set
, pspace
, sal
.pc
))
2267 add_sal_to_sals (state
, &sals
, &sal
,
2268 SYMBOL_NATURAL_NAME (sym
), 0);
2271 else if (ls
->function_symbols
!= NULL
|| ls
->minimal_symbols
!= NULL
)
2273 /* We have just a bunch of functions and/or methods. */
2275 struct symtab_and_line sal
;
2277 bound_minimal_symbol_d
*elem
;
2278 struct program_space
*pspace
;
2280 if (ls
->function_symbols
!= NULL
)
2282 /* Sort symbols so that symbols with the same program space are next
2284 qsort (VEC_address (symbolp
, ls
->function_symbols
),
2285 VEC_length (symbolp
, ls
->function_symbols
),
2286 sizeof (symbolp
), compare_symbols
);
2288 for (i
= 0; VEC_iterate (symbolp
, ls
->function_symbols
, i
, sym
); ++i
)
2290 pspace
= SYMTAB_PSPACE (symbol_symtab (sym
));
2291 set_current_program_space (pspace
);
2292 if (symbol_to_sal (&sal
, state
->funfirstline
, sym
)
2293 && maybe_add_address (state
->addr_set
, pspace
, sal
.pc
))
2294 add_sal_to_sals (state
, &sals
, &sal
,
2295 SYMBOL_NATURAL_NAME (sym
), 0);
2299 if (ls
->minimal_symbols
!= NULL
)
2301 /* Sort minimal symbols by program space, too. */
2302 qsort (VEC_address (bound_minimal_symbol_d
, ls
->minimal_symbols
),
2303 VEC_length (bound_minimal_symbol_d
, ls
->minimal_symbols
),
2304 sizeof (bound_minimal_symbol_d
), compare_msymbols
);
2307 VEC_iterate (bound_minimal_symbol_d
, ls
->minimal_symbols
,
2311 pspace
= elem
->objfile
->pspace
;
2312 set_current_program_space (pspace
);
2313 minsym_found (state
, elem
->objfile
, elem
->minsym
, &sals
);
2317 else if (ls
->explicit_loc
.line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2319 /* Only an offset was specified. */
2320 sals
= create_sals_line_offset (state
, ls
);
2322 /* Make sure we have a filename for canonicalization. */
2323 if (ls
->explicit_loc
.source_filename
== NULL
)
2325 const char *fullname
= symtab_to_fullname (state
->default_symtab
);
2327 /* It may be more appropriate to keep DEFAULT_SYMTAB in its symtab
2328 form so that displaying SOURCE_FILENAME can follow the current
2329 FILENAME_DISPLAY_STRING setting. But as it is used only rarely
2330 it has been kept for code simplicity only in absolute form. */
2331 ls
->explicit_loc
.source_filename
= xstrdup (fullname
);
2336 /* We haven't found any results... */
2340 canonicalize_linespec (state
, ls
);
2342 if (!sals
.empty () && state
->canonical
!= NULL
)
2343 state
->canonical
->pre_expanded
= 1;
2348 /* Build RESULT from the explicit location components SOURCE_FILENAME,
2349 FUNCTION_NAME, LABEL_NAME and LINE_OFFSET. */
2352 convert_explicit_location_to_linespec (struct linespec_state
*self
,
2354 const char *source_filename
,
2355 const char *function_name
,
2356 symbol_name_match_type fname_match_type
,
2357 const char *label_name
,
2358 struct line_offset line_offset
)
2360 VEC (symbolp
) *symbols
, *labels
;
2361 VEC (bound_minimal_symbol_d
) *minimal_symbols
;
2363 result
->explicit_loc
.func_name_match_type
= fname_match_type
;
2365 if (source_filename
!= NULL
)
2369 result
->file_symtabs
2370 = symtabs_from_filename (source_filename
, self
->search_pspace
);
2372 CATCH (except
, RETURN_MASK_ERROR
)
2374 source_file_not_found_error (source_filename
);
2377 result
->explicit_loc
.source_filename
= xstrdup (source_filename
);
2381 /* A NULL entry means to use the default symtab. */
2382 VEC_safe_push (symtab_ptr
, result
->file_symtabs
, NULL
);
2385 if (function_name
!= NULL
)
2387 find_linespec_symbols (self
, result
->file_symtabs
,
2388 function_name
, fname_match_type
,
2389 &symbols
, &minimal_symbols
);
2391 if (symbols
== NULL
&& minimal_symbols
== NULL
)
2392 symbol_not_found_error (function_name
,
2393 result
->explicit_loc
.source_filename
);
2395 result
->explicit_loc
.function_name
= xstrdup (function_name
);
2396 result
->function_symbols
= symbols
;
2397 result
->minimal_symbols
= minimal_symbols
;
2400 if (label_name
!= NULL
)
2403 labels
= find_label_symbols (self
, result
->function_symbols
,
2404 &symbols
, label_name
);
2407 undefined_label_error (result
->explicit_loc
.function_name
,
2410 result
->explicit_loc
.label_name
= xstrdup (label_name
);
2411 result
->labels
.label_symbols
= labels
;
2412 result
->labels
.function_symbols
= symbols
;
2415 if (line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2416 result
->explicit_loc
.line_offset
= line_offset
;
2419 /* Convert the explicit location EXPLICIT_LOC into SaLs. */
2421 static std::vector
<symtab_and_line
>
2422 convert_explicit_location_to_sals (struct linespec_state
*self
,
2424 const struct explicit_location
*explicit_loc
)
2426 convert_explicit_location_to_linespec (self
, result
,
2427 explicit_loc
->source_filename
,
2428 explicit_loc
->function_name
,
2429 explicit_loc
->func_name_match_type
,
2430 explicit_loc
->label_name
,
2431 explicit_loc
->line_offset
);
2432 return convert_linespec_to_sals (self
, result
);
2435 /* Parse a string that specifies a linespec.
2437 The basic grammar of linespecs:
2439 linespec -> var_spec | basic_spec
2440 var_spec -> '$' (STRING | NUMBER)
2442 basic_spec -> file_offset_spec | function_spec | label_spec
2443 file_offset_spec -> opt_file_spec offset_spec
2444 function_spec -> opt_file_spec function_name_spec opt_label_spec
2445 label_spec -> label_name_spec
2447 opt_file_spec -> "" | file_name_spec ':'
2448 opt_label_spec -> "" | ':' label_name_spec
2450 file_name_spec -> STRING
2451 function_name_spec -> STRING
2452 label_name_spec -> STRING
2453 function_name_spec -> STRING
2454 offset_spec -> NUMBER
2458 This may all be followed by several keywords such as "if EXPR",
2461 A comma will terminate parsing.
2463 The function may be an undebuggable function found in minimal symbol table.
2465 If the argument FUNFIRSTLINE is nonzero, we want the first line
2466 of real code inside a function when a function is specified, and it is
2467 not OK to specify a variable or type to get its line number.
2469 DEFAULT_SYMTAB specifies the file to use if none is specified.
2470 It defaults to current_source_symtab.
2471 DEFAULT_LINE specifies the line number to use for relative
2472 line numbers (that start with signs). Defaults to current_source_line.
2473 If CANONICAL is non-NULL, store an array of strings containing the canonical
2474 line specs there if necessary. Currently overloaded member functions and
2475 line numbers or static functions without a filename yield a canonical
2476 line spec. The array and the line spec strings are allocated on the heap,
2477 it is the callers responsibility to free them.
2479 Note that it is possible to return zero for the symtab
2480 if no file is validly specified. Callers must check that.
2481 Also, the line number returned may be invalid. */
2483 /* Parse the linespec in ARG. MATCH_TYPE indicates how function names
2484 should be matched. */
2486 static std::vector
<symtab_and_line
>
2487 parse_linespec (linespec_parser
*parser
, const char *arg
,
2488 symbol_name_match_type match_type
)
2490 linespec_token token
;
2491 struct gdb_exception file_exception
= exception_none
;
2493 /* A special case to start. It has become quite popular for
2494 IDEs to work around bugs in the previous parser by quoting
2495 the entire linespec, so we attempt to deal with this nicely. */
2496 parser
->is_quote_enclosed
= 0;
2497 if (parser
->completion_tracker
== NULL
2498 && !is_ada_operator (arg
)
2499 && strchr (linespec_quote_characters
, *arg
) != NULL
)
2503 end
= skip_quote_char (arg
+ 1, *arg
);
2504 if (end
!= NULL
&& is_closing_quote_enclosed (end
))
2506 /* Here's the special case. Skip ARG past the initial
2509 parser
->is_quote_enclosed
= 1;
2513 parser
->lexer
.saved_arg
= arg
;
2514 parser
->lexer
.stream
= arg
;
2515 parser
->completion_word
= arg
;
2516 parser
->complete_what
= linespec_complete_what::FUNCTION
;
2517 PARSER_EXPLICIT (parser
)->func_name_match_type
= match_type
;
2519 /* Initialize the default symtab and line offset. */
2520 initialize_defaults (&PARSER_STATE (parser
)->default_symtab
,
2521 &PARSER_STATE (parser
)->default_line
);
2523 /* Objective-C shortcut. */
2524 if (parser
->completion_tracker
== NULL
)
2526 std::vector
<symtab_and_line
> values
2527 = decode_objc (PARSER_STATE (parser
), PARSER_RESULT (parser
), arg
);
2528 if (!values
.empty ())
2533 /* "-"/"+" is either an objc selector, or a number. There's
2534 nothing to complete the latter to, so just let the caller
2535 complete on functions, which finds objc selectors, if there's
2537 if ((arg
[0] == '-' || arg
[0] == '+') && arg
[1] == '\0')
2541 /* Start parsing. */
2543 /* Get the first token. */
2544 token
= linespec_lexer_consume_token (parser
);
2546 /* It must be either LSTOKEN_STRING or LSTOKEN_NUMBER. */
2547 if (token
.type
== LSTOKEN_STRING
&& *LS_TOKEN_STOKEN (token
).ptr
== '$')
2549 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2550 if (parser
->completion_tracker
== NULL
)
2551 VEC_safe_push (symtab_ptr
, PARSER_RESULT (parser
)->file_symtabs
, NULL
);
2553 /* User specified a convenience variable or history value. */
2554 gdb::unique_xmalloc_ptr
<char> var
= copy_token_string (token
);
2555 PARSER_EXPLICIT (parser
)->line_offset
2556 = linespec_parse_variable (PARSER_STATE (parser
), var
.get ());
2558 /* If a line_offset wasn't found (VAR is the name of a user
2559 variable/function), then skip to normal symbol processing. */
2560 if (PARSER_EXPLICIT (parser
)->line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2562 /* Consume this token. */
2563 linespec_lexer_consume_token (parser
);
2565 goto convert_to_sals
;
2568 else if (token
.type
== LSTOKEN_EOI
&& parser
->completion_tracker
!= NULL
)
2570 /* Let the default linespec_complete_what::FUNCTION kick in. */
2571 unexpected_linespec_error (parser
);
2573 else if (token
.type
!= LSTOKEN_STRING
&& token
.type
!= LSTOKEN_NUMBER
)
2575 parser
->complete_what
= linespec_complete_what::NOTHING
;
2576 unexpected_linespec_error (parser
);
2579 /* Shortcut: If the next token is not LSTOKEN_COLON, we know that
2580 this token cannot represent a filename. */
2581 token
= linespec_lexer_peek_token (parser
);
2583 if (token
.type
== LSTOKEN_COLON
)
2585 /* Get the current token again and extract the filename. */
2586 token
= linespec_lexer_lex_one (parser
);
2587 gdb::unique_xmalloc_ptr
<char> user_filename
= copy_token_string (token
);
2589 /* Check if the input is a filename. */
2592 PARSER_RESULT (parser
)->file_symtabs
2593 = symtabs_from_filename (user_filename
.get (),
2594 PARSER_STATE (parser
)->search_pspace
);
2596 CATCH (ex
, RETURN_MASK_ERROR
)
2598 file_exception
= ex
;
2602 if (file_exception
.reason
>= 0)
2604 /* Symtabs were found for the file. Record the filename. */
2605 PARSER_EXPLICIT (parser
)->source_filename
= user_filename
.release ();
2607 /* Get the next token. */
2608 token
= linespec_lexer_consume_token (parser
);
2610 /* This is LSTOKEN_COLON; consume it. */
2611 linespec_lexer_consume_token (parser
);
2615 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2616 VEC_safe_push (symtab_ptr
, PARSER_RESULT (parser
)->file_symtabs
, NULL
);
2619 /* If the next token is not EOI, KEYWORD, or COMMA, issue an error. */
2620 else if (parser
->completion_tracker
== NULL
2621 && (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
2622 && token
.type
!= LSTOKEN_COMMA
))
2624 /* TOKEN is the _next_ token, not the one currently in the parser.
2625 Consuming the token will give the correct error message. */
2626 linespec_lexer_consume_token (parser
);
2627 unexpected_linespec_error (parser
);
2631 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2632 VEC_safe_push (symtab_ptr
, PARSER_RESULT (parser
)->file_symtabs
, NULL
);
2635 /* Parse the rest of the linespec. */
2636 linespec_parse_basic (parser
);
2638 if (parser
->completion_tracker
== NULL
2639 && PARSER_RESULT (parser
)->function_symbols
== NULL
2640 && PARSER_RESULT (parser
)->labels
.label_symbols
== NULL
2641 && PARSER_EXPLICIT (parser
)->line_offset
.sign
== LINE_OFFSET_UNKNOWN
2642 && PARSER_RESULT (parser
)->minimal_symbols
== NULL
)
2644 /* The linespec didn't parse. Re-throw the file exception if
2646 if (file_exception
.reason
< 0)
2647 throw_exception (file_exception
);
2649 /* Otherwise, the symbol is not found. */
2650 symbol_not_found_error (PARSER_EXPLICIT (parser
)->function_name
,
2651 PARSER_EXPLICIT (parser
)->source_filename
);
2656 /* Get the last token and record how much of the input was parsed,
2658 token
= linespec_lexer_lex_one (parser
);
2659 if (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
)
2660 unexpected_linespec_error (parser
);
2661 else if (token
.type
== LSTOKEN_KEYWORD
)
2663 /* Setup the completion word past the keyword. Lexing never
2664 advances past a keyword automatically, so skip it
2666 parser
->completion_word
2667 = skip_spaces (skip_to_space (PARSER_STREAM (parser
)));
2668 parser
->complete_what
= linespec_complete_what::EXPRESSION
;
2671 /* Convert the data in PARSER_RESULT to SALs. */
2672 if (parser
->completion_tracker
== NULL
)
2673 return convert_linespec_to_sals (PARSER_STATE (parser
),
2674 PARSER_RESULT (parser
));
2680 /* A constructor for linespec_state. */
2683 linespec_state_constructor (struct linespec_state
*self
,
2684 int flags
, const struct language_defn
*language
,
2685 struct program_space
*search_pspace
,
2686 struct symtab
*default_symtab
,
2688 struct linespec_result
*canonical
)
2690 memset (self
, 0, sizeof (*self
));
2691 self
->language
= language
;
2692 self
->funfirstline
= (flags
& DECODE_LINE_FUNFIRSTLINE
) ? 1 : 0;
2693 self
->list_mode
= (flags
& DECODE_LINE_LIST_MODE
) ? 1 : 0;
2694 self
->search_pspace
= search_pspace
;
2695 self
->default_symtab
= default_symtab
;
2696 self
->default_line
= default_line
;
2697 self
->canonical
= canonical
;
2698 self
->program_space
= current_program_space
;
2699 self
->addr_set
= htab_create_alloc (10, hash_address_entry
, eq_address_entry
,
2700 xfree
, xcalloc
, xfree
);
2701 self
->is_linespec
= 0;
2704 /* Initialize a new linespec parser. */
2707 linespec_parser_new (linespec_parser
*parser
,
2708 int flags
, const struct language_defn
*language
,
2709 struct program_space
*search_pspace
,
2710 struct symtab
*default_symtab
,
2712 struct linespec_result
*canonical
)
2714 memset (parser
, 0, sizeof (linespec_parser
));
2715 parser
->lexer
.current
.type
= LSTOKEN_CONSUMED
;
2716 memset (PARSER_RESULT (parser
), 0, sizeof (struct linespec
));
2717 PARSER_EXPLICIT (parser
)->func_name_match_type
2718 = symbol_name_match_type::WILD
;
2719 PARSER_EXPLICIT (parser
)->line_offset
.sign
= LINE_OFFSET_UNKNOWN
;
2720 linespec_state_constructor (PARSER_STATE (parser
), flags
, language
,
2722 default_symtab
, default_line
, canonical
);
2725 /* A destructor for linespec_state. */
2728 linespec_state_destructor (struct linespec_state
*self
)
2730 htab_delete (self
->addr_set
);
2733 /* Delete a linespec parser. */
2736 linespec_parser_delete (void *arg
)
2738 linespec_parser
*parser
= (linespec_parser
*) arg
;
2740 xfree (PARSER_EXPLICIT (parser
)->source_filename
);
2741 xfree (PARSER_EXPLICIT (parser
)->label_name
);
2742 xfree (PARSER_EXPLICIT (parser
)->function_name
);
2744 if (PARSER_RESULT (parser
)->file_symtabs
!= NULL
)
2745 VEC_free (symtab_ptr
, PARSER_RESULT (parser
)->file_symtabs
);
2747 if (PARSER_RESULT (parser
)->function_symbols
!= NULL
)
2748 VEC_free (symbolp
, PARSER_RESULT (parser
)->function_symbols
);
2750 if (PARSER_RESULT (parser
)->minimal_symbols
!= NULL
)
2751 VEC_free (bound_minimal_symbol_d
, PARSER_RESULT (parser
)->minimal_symbols
);
2753 if (PARSER_RESULT (parser
)->labels
.label_symbols
!= NULL
)
2754 VEC_free (symbolp
, PARSER_RESULT (parser
)->labels
.label_symbols
);
2756 if (PARSER_RESULT (parser
)->labels
.function_symbols
!= NULL
)
2757 VEC_free (symbolp
, PARSER_RESULT (parser
)->labels
.function_symbols
);
2759 linespec_state_destructor (PARSER_STATE (parser
));
2762 /* See description in linespec.h. */
2765 linespec_lex_to_end (const char **stringp
)
2767 linespec_parser parser
;
2768 struct cleanup
*cleanup
;
2769 linespec_token token
;
2772 if (stringp
== NULL
|| *stringp
== NULL
)
2775 linespec_parser_new (&parser
, 0, current_language
, NULL
, NULL
, 0, NULL
);
2776 cleanup
= make_cleanup (linespec_parser_delete
, &parser
);
2777 parser
.lexer
.saved_arg
= *stringp
;
2778 PARSER_STREAM (&parser
) = orig
= *stringp
;
2782 /* Stop before any comma tokens; we need it to keep it
2783 as the next token in the string. */
2784 token
= linespec_lexer_peek_token (&parser
);
2785 if (token
.type
== LSTOKEN_COMMA
)
2787 token
= linespec_lexer_consume_token (&parser
);
2789 while (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
);
2791 *stringp
+= PARSER_STREAM (&parser
) - orig
;
2792 do_cleanups (cleanup
);
2795 /* See linespec.h. */
2798 linespec_complete_function (completion_tracker
&tracker
,
2799 const char *function
,
2800 symbol_name_match_type func_match_type
,
2801 const char *source_filename
)
2803 complete_symbol_mode mode
= complete_symbol_mode::LINESPEC
;
2805 if (source_filename
!= NULL
)
2807 collect_file_symbol_completion_matches (tracker
, mode
, func_match_type
,
2808 function
, function
, source_filename
);
2812 collect_symbol_completion_matches (tracker
, mode
, func_match_type
,
2813 function
, function
);
2818 /* Helper for complete_linespec to simplify it. SOURCE_FILENAME is
2819 only meaningful if COMPONENT is FUNCTION. */
2822 complete_linespec_component (linespec_parser
*parser
,
2823 completion_tracker
&tracker
,
2825 linespec_complete_what component
,
2826 const char *source_filename
)
2828 if (component
== linespec_complete_what::KEYWORD
)
2830 complete_on_enum (tracker
, linespec_keywords
, text
, text
);
2832 else if (component
== linespec_complete_what::EXPRESSION
)
2835 = advance_to_expression_complete_word_point (tracker
, text
);
2836 complete_expression (tracker
, text
, word
);
2838 else if (component
== linespec_complete_what::FUNCTION
)
2840 completion_list fn_list
;
2842 symbol_name_match_type match_type
2843 = PARSER_EXPLICIT (parser
)->func_name_match_type
;
2844 linespec_complete_function (tracker
, text
, match_type
, source_filename
);
2845 if (source_filename
== NULL
)
2847 /* Haven't seen a source component, like in "b
2848 file.c:function[TAB]". Maybe this wasn't a function, but
2849 a filename instead, like "b file.[TAB]". */
2850 fn_list
= complete_source_filenames (text
);
2853 /* If we only have a single filename completion, append a ':' for
2854 the user, since that's the only thing that can usefully follow
2856 if (fn_list
.size () == 1 && !tracker
.have_completions ())
2858 char *fn
= fn_list
[0].release ();
2860 /* If we also need to append a quote char, it needs to be
2861 appended before the ':'. Append it now, and make ':' the
2862 new "quote" char. */
2863 if (tracker
.quote_char ())
2865 char quote_char_str
[2] = { tracker
.quote_char () };
2867 fn
= reconcat (fn
, fn
, quote_char_str
, (char *) NULL
);
2868 tracker
.set_quote_char (':');
2871 fn
= reconcat (fn
, fn
, ":", (char *) NULL
);
2872 fn_list
[0].reset (fn
);
2874 /* Tell readline to skip appending a space. */
2875 tracker
.set_suppress_append_ws (true);
2877 tracker
.add_completions (std::move (fn_list
));
2881 /* Helper for linespec_complete_label. Find labels that match
2882 LABEL_NAME in the function symbols listed in the PARSER, and add
2883 them to the tracker. */
2886 complete_label (completion_tracker
&tracker
,
2887 linespec_parser
*parser
,
2888 const char *label_name
)
2890 VEC (symbolp
) *label_function_symbols
= NULL
;
2891 VEC (symbolp
) *labels
2892 = find_label_symbols (PARSER_STATE (parser
),
2893 PARSER_RESULT (parser
)->function_symbols
,
2894 &label_function_symbols
,
2899 VEC_iterate (symbolp
, labels
, ix
, label
); ++ix
)
2901 char *match
= xstrdup (SYMBOL_SEARCH_NAME (label
));
2902 tracker
.add_completion (gdb::unique_xmalloc_ptr
<char> (match
));
2904 VEC_free (symbolp
, labels
);
2907 /* See linespec.h. */
2910 linespec_complete_label (completion_tracker
&tracker
,
2911 const struct language_defn
*language
,
2912 const char *source_filename
,
2913 const char *function_name
,
2914 symbol_name_match_type func_name_match_type
,
2915 const char *label_name
)
2917 linespec_parser parser
;
2918 struct cleanup
*cleanup
;
2920 linespec_parser_new (&parser
, 0, language
, NULL
, NULL
, 0, NULL
);
2921 cleanup
= make_cleanup (linespec_parser_delete
, &parser
);
2923 line_offset unknown_offset
= { 0, LINE_OFFSET_UNKNOWN
};
2927 convert_explicit_location_to_linespec (PARSER_STATE (&parser
),
2928 PARSER_RESULT (&parser
),
2931 func_name_match_type
,
2932 NULL
, unknown_offset
);
2934 CATCH (ex
, RETURN_MASK_ERROR
)
2936 do_cleanups (cleanup
);
2941 complete_label (tracker
, &parser
, label_name
);
2943 do_cleanups (cleanup
);
2946 /* See description in linespec.h. */
2949 linespec_complete (completion_tracker
&tracker
, const char *text
,
2950 symbol_name_match_type match_type
)
2952 linespec_parser parser
;
2953 struct cleanup
*cleanup
;
2954 const char *orig
= text
;
2956 linespec_parser_new (&parser
, 0, current_language
, NULL
, NULL
, 0, NULL
);
2957 cleanup
= make_cleanup (linespec_parser_delete
, &parser
);
2958 parser
.lexer
.saved_arg
= text
;
2959 PARSER_EXPLICIT (&parser
)->func_name_match_type
= match_type
;
2960 PARSER_STREAM (&parser
) = text
;
2962 parser
.completion_tracker
= &tracker
;
2963 PARSER_STATE (&parser
)->is_linespec
= 1;
2965 /* Parse as much as possible. parser.completion_word will hold
2966 furthest completion point we managed to parse to. */
2969 parse_linespec (&parser
, text
, match_type
);
2971 CATCH (except
, RETURN_MASK_ERROR
)
2976 if (parser
.completion_quote_char
!= '\0'
2977 && parser
.completion_quote_end
!= NULL
2978 && parser
.completion_quote_end
[1] == '\0')
2980 /* If completing a quoted string with the cursor right at
2981 terminating quote char, complete the completion word without
2982 interpretation, so that readline advances the cursor one
2983 whitespace past the quote, even if there's no match. This
2984 makes these cases behave the same:
2986 before: "b function()"
2987 after: "b function() "
2989 before: "b 'function()'"
2990 after: "b 'function()' "
2992 and trusts the user in this case:
2994 before: "b 'not_loaded_function_yet()'"
2995 after: "b 'not_loaded_function_yet()' "
2997 parser
.complete_what
= linespec_complete_what::NOTHING
;
2998 parser
.completion_quote_char
= '\0';
3000 gdb::unique_xmalloc_ptr
<char> text_copy
3001 (xstrdup (parser
.completion_word
));
3002 tracker
.add_completion (std::move (text_copy
));
3005 tracker
.set_quote_char (parser
.completion_quote_char
);
3007 if (parser
.complete_what
== linespec_complete_what::LABEL
)
3009 parser
.complete_what
= linespec_complete_what::NOTHING
;
3011 const char *func_name
= PARSER_EXPLICIT (&parser
)->function_name
;
3013 VEC (symbolp
) *function_symbols
;
3014 VEC (bound_minimal_symbol_d
) *minimal_symbols
;
3015 find_linespec_symbols (PARSER_STATE (&parser
),
3016 PARSER_RESULT (&parser
)->file_symtabs
,
3017 func_name
, match_type
,
3018 &function_symbols
, &minimal_symbols
);
3020 PARSER_RESULT (&parser
)->function_symbols
= function_symbols
;
3021 PARSER_RESULT (&parser
)->minimal_symbols
= minimal_symbols
;
3023 complete_label (tracker
, &parser
, parser
.completion_word
);
3025 else if (parser
.complete_what
== linespec_complete_what::FUNCTION
)
3027 /* While parsing/lexing, we didn't know whether the completion
3028 word completes to a unique function/source name already or
3032 "b function() <tab>"
3033 may need to complete either to:
3034 "b function() const"
3036 "b function() if/thread/task"
3040 may need to complete either to:
3041 "b foo template_fun<T>()"
3042 with "foo" being the template function's return type, or to:
3047 may need to complete either to a source file name:
3049 or this, also a filename, but a unique completion:
3051 or to a function name:
3054 Address that by completing assuming source or function, and
3055 seeing if we find a completion that matches exactly the
3056 completion word. If so, then it must be a function (see note
3057 below) and we advance the completion word to the end of input
3058 and switch to KEYWORD completion mode.
3060 Note: if we find a unique completion for a source filename,
3061 then it won't match the completion word, because the LCD will
3062 contain a trailing ':'. And if we're completing at or after
3063 the ':', then complete_linespec_component won't try to
3064 complete on source filenames. */
3066 const char *word
= parser
.completion_word
;
3068 complete_linespec_component (&parser
, tracker
,
3069 parser
.completion_word
,
3070 linespec_complete_what::FUNCTION
,
3071 PARSER_EXPLICIT (&parser
)->source_filename
);
3073 parser
.complete_what
= linespec_complete_what::NOTHING
;
3075 if (tracker
.quote_char ())
3077 /* The function/file name was not close-quoted, so this
3078 can't be a keyword. Note: complete_linespec_component
3079 may have swapped the original quote char for ':' when we
3080 get here, but that still indicates the same. */
3082 else if (!tracker
.have_completions ())
3085 size_t wordlen
= strlen (parser
.completion_word
);
3088 = string_find_incomplete_keyword_at_end (linespec_keywords
,
3089 parser
.completion_word
,
3094 && parser
.completion_word
[wordlen
- 1] == ' '))
3096 parser
.completion_word
+= key_start
;
3097 parser
.complete_what
= linespec_complete_what::KEYWORD
;
3100 else if (tracker
.completes_to_completion_word (word
))
3102 /* Skip the function and complete on keywords. */
3103 parser
.completion_word
+= strlen (word
);
3104 parser
.complete_what
= linespec_complete_what::KEYWORD
;
3105 tracker
.discard_completions ();
3109 tracker
.advance_custom_word_point_by (parser
.completion_word
- orig
);
3111 complete_linespec_component (&parser
, tracker
,
3112 parser
.completion_word
,
3113 parser
.complete_what
,
3114 PARSER_EXPLICIT (&parser
)->source_filename
);
3116 /* If we're past the "filename:function:label:offset" linespec, and
3117 didn't find any match, then assume the user might want to create
3118 a pending breakpoint anyway and offer the keyword
3120 if (!parser
.completion_quote_char
3121 && (parser
.complete_what
== linespec_complete_what::FUNCTION
3122 || parser
.complete_what
== linespec_complete_what::LABEL
3123 || parser
.complete_what
== linespec_complete_what::NOTHING
)
3124 && !tracker
.have_completions ())
3127 = parser
.completion_word
+ strlen (parser
.completion_word
);
3129 if (end
> orig
&& end
[-1] == ' ')
3131 tracker
.advance_custom_word_point_by (end
- parser
.completion_word
);
3133 complete_linespec_component (&parser
, tracker
, end
,
3134 linespec_complete_what::KEYWORD
,
3139 do_cleanups (cleanup
);
3142 /* A helper function for decode_line_full and decode_line_1 to
3143 turn LOCATION into std::vector<symtab_and_line>. */
3145 static std::vector
<symtab_and_line
>
3146 event_location_to_sals (linespec_parser
*parser
,
3147 const struct event_location
*location
)
3149 std::vector
<symtab_and_line
> result
;
3151 switch (event_location_type (location
))
3153 case LINESPEC_LOCATION
:
3155 PARSER_STATE (parser
)->is_linespec
= 1;
3158 const linespec_location
*ls
= get_linespec_location (location
);
3159 result
= parse_linespec (parser
,
3160 ls
->spec_string
, ls
->match_type
);
3162 CATCH (except
, RETURN_MASK_ERROR
)
3164 throw_exception (except
);
3170 case ADDRESS_LOCATION
:
3172 const char *addr_string
= get_address_string_location (location
);
3173 CORE_ADDR addr
= get_address_location (location
);
3175 if (addr_string
!= NULL
)
3177 char *expr
= xstrdup (addr_string
);
3178 const char *const_expr
= expr
;
3179 struct cleanup
*cleanup
= make_cleanup (xfree
, expr
);
3181 addr
= linespec_expression_to_pc (&const_expr
);
3182 if (PARSER_STATE (parser
)->canonical
!= NULL
)
3183 PARSER_STATE (parser
)->canonical
->location
3184 = copy_event_location (location
);
3186 do_cleanups (cleanup
);
3189 result
= convert_address_location_to_sals (PARSER_STATE (parser
),
3194 case EXPLICIT_LOCATION
:
3196 const struct explicit_location
*explicit_loc
;
3198 explicit_loc
= get_explicit_location_const (location
);
3199 result
= convert_explicit_location_to_sals (PARSER_STATE (parser
),
3200 PARSER_RESULT (parser
),
3205 case PROBE_LOCATION
:
3206 /* Probes are handled by their own decoders. */
3207 gdb_assert_not_reached ("attempt to decode probe location");
3211 gdb_assert_not_reached ("unhandled event location type");
3217 /* See linespec.h. */
3220 decode_line_full (const struct event_location
*location
, int flags
,
3221 struct program_space
*search_pspace
,
3222 struct symtab
*default_symtab
,
3223 int default_line
, struct linespec_result
*canonical
,
3224 const char *select_mode
,
3227 struct cleanup
*cleanups
;
3228 VEC (const_char_ptr
) *filters
= NULL
;
3229 linespec_parser parser
;
3230 struct linespec_state
*state
;
3232 gdb_assert (canonical
!= NULL
);
3233 /* The filter only makes sense for 'all'. */
3234 gdb_assert (filter
== NULL
|| select_mode
== multiple_symbols_all
);
3235 gdb_assert (select_mode
== NULL
3236 || select_mode
== multiple_symbols_all
3237 || select_mode
== multiple_symbols_ask
3238 || select_mode
== multiple_symbols_cancel
);
3239 gdb_assert ((flags
& DECODE_LINE_LIST_MODE
) == 0);
3241 linespec_parser_new (&parser
, flags
, current_language
,
3242 search_pspace
, default_symtab
,
3243 default_line
, canonical
);
3244 cleanups
= make_cleanup (linespec_parser_delete
, &parser
);
3246 scoped_restore_current_program_space restore_pspace
;
3248 std::vector
<symtab_and_line
> result
= event_location_to_sals (&parser
,
3250 state
= PARSER_STATE (&parser
);
3252 gdb_assert (result
.size () == 1 || canonical
->pre_expanded
);
3253 canonical
->pre_expanded
= 1;
3255 /* Arrange for allocated canonical names to be freed. */
3256 if (!result
.empty ())
3260 make_cleanup (xfree
, state
->canonical_names
);
3261 for (i
= 0; i
< result
.size (); ++i
)
3263 gdb_assert (state
->canonical_names
[i
].suffix
!= NULL
);
3264 make_cleanup (xfree
, state
->canonical_names
[i
].suffix
);
3268 if (select_mode
== NULL
)
3270 if (interp_ui_out (top_level_interpreter ())->is_mi_like_p ())
3271 select_mode
= multiple_symbols_all
;
3273 select_mode
= multiple_symbols_select_mode ();
3276 if (select_mode
== multiple_symbols_all
)
3280 make_cleanup (VEC_cleanup (const_char_ptr
), &filters
);
3281 VEC_safe_push (const_char_ptr
, filters
, filter
);
3282 filter_results (state
, &result
, filters
);
3285 convert_results_to_lsals (state
, &result
);
3288 decode_line_2 (state
, &result
, select_mode
);
3290 do_cleanups (cleanups
);
3293 /* See linespec.h. */
3295 std::vector
<symtab_and_line
>
3296 decode_line_1 (const struct event_location
*location
, int flags
,
3297 struct program_space
*search_pspace
,
3298 struct symtab
*default_symtab
,
3301 linespec_parser parser
;
3302 struct cleanup
*cleanups
;
3304 linespec_parser_new (&parser
, flags
, current_language
,
3305 search_pspace
, default_symtab
,
3306 default_line
, NULL
);
3307 cleanups
= make_cleanup (linespec_parser_delete
, &parser
);
3309 scoped_restore_current_program_space restore_pspace
;
3311 std::vector
<symtab_and_line
> result
= event_location_to_sals (&parser
,
3314 do_cleanups (cleanups
);
3318 /* See linespec.h. */
3320 std::vector
<symtab_and_line
>
3321 decode_line_with_current_source (const char *string
, int flags
)
3324 error (_("Empty line specification."));
3326 /* We use whatever is set as the current source line. We do not try
3327 and get a default source symtab+line or it will recursively call us! */
3328 symtab_and_line cursal
= get_current_source_symtab_and_line ();
3330 event_location_up location
= string_to_event_location (&string
,
3332 std::vector
<symtab_and_line
> sals
3333 = decode_line_1 (location
.get (), flags
, NULL
, cursal
.symtab
, cursal
.line
);
3336 error (_("Junk at end of line specification: %s"), string
);
3341 /* See linespec.h. */
3343 std::vector
<symtab_and_line
>
3344 decode_line_with_last_displayed (const char *string
, int flags
)
3347 error (_("Empty line specification."));
3349 event_location_up location
= string_to_event_location (&string
,
3351 std::vector
<symtab_and_line
> sals
3352 = (last_displayed_sal_is_valid ()
3353 ? decode_line_1 (location
.get (), flags
, NULL
,
3354 get_last_displayed_symtab (),
3355 get_last_displayed_line ())
3356 : decode_line_1 (location
.get (), flags
, NULL
,
3357 (struct symtab
*) NULL
, 0));
3360 error (_("Junk at end of line specification: %s"), string
);
3367 /* First, some functions to initialize stuff at the beggining of the
3371 initialize_defaults (struct symtab
**default_symtab
, int *default_line
)
3373 if (*default_symtab
== 0)
3375 /* Use whatever we have for the default source line. We don't use
3376 get_current_or_default_symtab_and_line as it can recurse and call
3378 struct symtab_and_line cursal
=
3379 get_current_source_symtab_and_line ();
3381 *default_symtab
= cursal
.symtab
;
3382 *default_line
= cursal
.line
;
3388 /* Evaluate the expression pointed to by EXP_PTR into a CORE_ADDR,
3389 advancing EXP_PTR past any parsed text. */
3392 linespec_expression_to_pc (const char **exp_ptr
)
3394 if (current_program_space
->executing_startup
)
3395 /* The error message doesn't really matter, because this case
3396 should only hit during breakpoint reset. */
3397 throw_error (NOT_FOUND_ERROR
, _("cannot evaluate expressions while "
3398 "program space is in startup"));
3401 return value_as_address (parse_to_comma_and_eval (exp_ptr
));
3406 /* Here's where we recognise an Objective-C Selector. An Objective C
3407 selector may be implemented by more than one class, therefore it
3408 may represent more than one method/function. This gives us a
3409 situation somewhat analogous to C++ overloading. If there's more
3410 than one method that could represent the selector, then use some of
3411 the existing C++ code to let the user choose one. */
3413 static std::vector
<symtab_and_line
>
3414 decode_objc (struct linespec_state
*self
, linespec_p ls
, const char *arg
)
3416 struct collect_info info
;
3417 VEC (const_char_ptr
) *symbol_names
= NULL
;
3418 const char *new_argptr
;
3419 struct cleanup
*cleanup
= make_cleanup (VEC_cleanup (const_char_ptr
),
3423 info
.file_symtabs
= NULL
;
3424 VEC_safe_push (symtab_ptr
, info
.file_symtabs
, NULL
);
3425 make_cleanup (VEC_cleanup (symtab_ptr
), &info
.file_symtabs
);
3426 info
.result
.symbols
= NULL
;
3427 info
.result
.minimal_symbols
= NULL
;
3429 new_argptr
= find_imps (arg
, &symbol_names
);
3430 if (VEC_empty (const_char_ptr
, symbol_names
))
3432 do_cleanups (cleanup
);
3436 add_all_symbol_names_from_pspace (&info
, NULL
, symbol_names
,
3439 std::vector
<symtab_and_line
> values
;
3440 if (!VEC_empty (symbolp
, info
.result
.symbols
)
3441 || !VEC_empty (bound_minimal_symbol_d
, info
.result
.minimal_symbols
))
3445 saved_arg
= (char *) alloca (new_argptr
- arg
+ 1);
3446 memcpy (saved_arg
, arg
, new_argptr
- arg
);
3447 saved_arg
[new_argptr
- arg
] = '\0';
3449 ls
->explicit_loc
.function_name
= xstrdup (saved_arg
);
3450 ls
->function_symbols
= info
.result
.symbols
;
3451 ls
->minimal_symbols
= info
.result
.minimal_symbols
;
3452 values
= convert_linespec_to_sals (self
, ls
);
3454 if (self
->canonical
)
3459 self
->canonical
->pre_expanded
= 1;
3461 if (ls
->explicit_loc
.source_filename
)
3463 holder
= string_printf ("%s:%s",
3464 ls
->explicit_loc
.source_filename
,
3466 str
= holder
.c_str ();
3471 self
->canonical
->location
3472 = new_linespec_location (&str
, symbol_name_match_type::FULL
);
3476 do_cleanups (cleanup
);
3483 /* A function object that serves as symbol_found_callback_ftype
3484 callback for iterate_over_symbols. This is used by
3485 lookup_prefix_sym to collect type symbols. */
3486 class decode_compound_collector
3489 decode_compound_collector ()
3492 m_unique_syms
= htab_create_alloc (1, htab_hash_pointer
,
3493 htab_eq_pointer
, NULL
,
3497 ~decode_compound_collector ()
3499 if (m_unique_syms
!= NULL
)
3500 htab_delete (m_unique_syms
);
3503 /* Releases ownership of the collected symbols and returns them. */
3504 VEC (symbolp
) *release_symbols ()
3506 VEC (symbolp
) *res
= m_symbols
;
3511 /* Callable as a symbol_found_callback_ftype callback. */
3512 bool operator () (symbol
*sym
);
3515 /* A hash table of all symbols we found. We use this to avoid
3516 adding any symbol more than once. */
3517 htab_t m_unique_syms
;
3519 /* The result vector. */
3520 VEC (symbolp
) *m_symbols
;
3524 decode_compound_collector::operator () (symbol
*sym
)
3529 if (SYMBOL_CLASS (sym
) != LOC_TYPEDEF
)
3530 return true; /* Continue iterating. */
3532 t
= SYMBOL_TYPE (sym
);
3533 t
= check_typedef (t
);
3534 if (TYPE_CODE (t
) != TYPE_CODE_STRUCT
3535 && TYPE_CODE (t
) != TYPE_CODE_UNION
3536 && TYPE_CODE (t
) != TYPE_CODE_NAMESPACE
)
3537 return true; /* Continue iterating. */
3539 slot
= htab_find_slot (m_unique_syms
, sym
, INSERT
);
3543 VEC_safe_push (symbolp
, m_symbols
, sym
);
3546 return true; /* Continue iterating. */
3551 /* Return any symbols corresponding to CLASS_NAME in FILE_SYMTABS. */
3553 static VEC (symbolp
) *
3554 lookup_prefix_sym (struct linespec_state
*state
, VEC (symtab_ptr
) *file_symtabs
,
3555 const char *class_name
)
3559 decode_compound_collector collector
;
3561 lookup_name_info
lookup_name (class_name
, symbol_name_match_type::FULL
);
3563 for (ix
= 0; VEC_iterate (symtab_ptr
, file_symtabs
, ix
, elt
); ++ix
)
3567 iterate_over_all_matching_symtabs (state
, lookup_name
,
3568 STRUCT_DOMAIN
, ALL_DOMAIN
,
3569 NULL
, false, collector
);
3570 iterate_over_all_matching_symtabs (state
, lookup_name
,
3571 VAR_DOMAIN
, ALL_DOMAIN
,
3572 NULL
, false, collector
);
3576 /* Program spaces that are executing startup should have
3577 been filtered out earlier. */
3578 gdb_assert (!SYMTAB_PSPACE (elt
)->executing_startup
);
3579 set_current_program_space (SYMTAB_PSPACE (elt
));
3580 iterate_over_file_blocks (elt
, lookup_name
, STRUCT_DOMAIN
, collector
);
3581 iterate_over_file_blocks (elt
, lookup_name
, VAR_DOMAIN
, collector
);
3585 return collector
.release_symbols ();
3588 /* A qsort comparison function for symbols. The resulting order does
3589 not actually matter; we just need to be able to sort them so that
3590 symbols with the same program space end up next to each other. */
3593 compare_symbols (const void *a
, const void *b
)
3595 struct symbol
* const *sa
= (struct symbol
* const*) a
;
3596 struct symbol
* const *sb
= (struct symbol
* const*) b
;
3599 uia
= (uintptr_t) SYMTAB_PSPACE (symbol_symtab (*sa
));
3600 uib
= (uintptr_t) SYMTAB_PSPACE (symbol_symtab (*sb
));
3607 uia
= (uintptr_t) *sa
;
3608 uib
= (uintptr_t) *sb
;
3618 /* Like compare_symbols but for minimal symbols. */
3621 compare_msymbols (const void *a
, const void *b
)
3623 const struct bound_minimal_symbol
*sa
3624 = (const struct bound_minimal_symbol
*) a
;
3625 const struct bound_minimal_symbol
*sb
3626 = (const struct bound_minimal_symbol
*) b
;
3629 uia
= (uintptr_t) sa
->objfile
->pspace
;
3630 uib
= (uintptr_t) sa
->objfile
->pspace
;
3637 uia
= (uintptr_t) sa
->minsym
;
3638 uib
= (uintptr_t) sb
->minsym
;
3648 /* Look for all the matching instances of each symbol in NAMES. Only
3649 instances from PSPACE are considered; other program spaces are
3650 handled by our caller. If PSPACE is NULL, then all program spaces
3651 are considered. Results are stored into INFO. */
3654 add_all_symbol_names_from_pspace (struct collect_info
*info
,
3655 struct program_space
*pspace
,
3656 VEC (const_char_ptr
) *names
,
3657 enum search_domain search_domain
)
3662 for (ix
= 0; VEC_iterate (const_char_ptr
, names
, ix
, iter
); ++ix
)
3663 add_matching_symbols_to_info (iter
,
3664 symbol_name_match_type::FULL
,
3665 search_domain
, info
, pspace
);
3669 find_superclass_methods (VEC (typep
) *superclasses
,
3670 const char *name
, enum language name_lang
,
3671 VEC (const_char_ptr
) **result_names
)
3673 int old_len
= VEC_length (const_char_ptr
, *result_names
);
3674 VEC (typep
) *iter_classes
;
3675 struct cleanup
*cleanup
= make_cleanup (null_cleanup
, NULL
);
3677 iter_classes
= superclasses
;
3680 VEC (typep
) *new_supers
= NULL
;
3684 make_cleanup (VEC_cleanup (typep
), &new_supers
);
3685 for (ix
= 0; VEC_iterate (typep
, iter_classes
, ix
, t
); ++ix
)
3686 find_methods (t
, name_lang
, name
, result_names
, &new_supers
);
3688 if (VEC_length (const_char_ptr
, *result_names
) != old_len
3689 || VEC_empty (typep
, new_supers
))
3692 iter_classes
= new_supers
;
3695 do_cleanups (cleanup
);
3698 /* This finds the method METHOD_NAME in the class CLASS_NAME whose type is
3699 given by one of the symbols in SYM_CLASSES. Matches are returned
3700 in SYMBOLS (for debug symbols) and MINSYMS (for minimal symbols). */
3703 find_method (struct linespec_state
*self
, VEC (symtab_ptr
) *file_symtabs
,
3704 const char *class_name
, const char *method_name
,
3705 VEC (symbolp
) *sym_classes
, VEC (symbolp
) **symbols
,
3706 VEC (bound_minimal_symbol_d
) **minsyms
)
3709 struct cleanup
*cleanup
= make_cleanup (null_cleanup
, NULL
);
3711 int last_result_len
;
3712 VEC (typep
) *superclass_vec
;
3713 VEC (const_char_ptr
) *result_names
;
3714 struct collect_info info
;
3716 /* Sort symbols so that symbols with the same program space are next
3718 qsort (VEC_address (symbolp
, sym_classes
),
3719 VEC_length (symbolp
, sym_classes
),
3724 info
.file_symtabs
= file_symtabs
;
3725 info
.result
.symbols
= NULL
;
3726 info
.result
.minimal_symbols
= NULL
;
3728 /* Iterate over all the types, looking for the names of existing
3729 methods matching METHOD_NAME. If we cannot find a direct method in a
3730 given program space, then we consider inherited methods; this is
3731 not ideal (ideal would be to respect C++ hiding rules), but it
3732 seems good enough and is what GDB has historically done. We only
3733 need to collect the names because later we find all symbols with
3734 those names. This loop is written in a somewhat funny way
3735 because we collect data across the program space before deciding
3737 superclass_vec
= NULL
;
3738 make_cleanup (VEC_cleanup (typep
), &superclass_vec
);
3739 result_names
= NULL
;
3740 make_cleanup (VEC_cleanup (const_char_ptr
), &result_names
);
3741 last_result_len
= 0;
3742 for (ix
= 0; VEC_iterate (symbolp
, sym_classes
, ix
, sym
); ++ix
)
3745 struct program_space
*pspace
;
3747 /* Program spaces that are executing startup should have
3748 been filtered out earlier. */
3749 pspace
= SYMTAB_PSPACE (symbol_symtab (sym
));
3750 gdb_assert (!pspace
->executing_startup
);
3751 set_current_program_space (pspace
);
3752 t
= check_typedef (SYMBOL_TYPE (sym
));
3753 find_methods (t
, SYMBOL_LANGUAGE (sym
),
3754 method_name
, &result_names
, &superclass_vec
);
3756 /* Handle all items from a single program space at once; and be
3757 sure not to miss the last batch. */
3758 if (ix
== VEC_length (symbolp
, sym_classes
) - 1
3760 != SYMTAB_PSPACE (symbol_symtab (VEC_index (symbolp
, sym_classes
,
3763 /* If we did not find a direct implementation anywhere in
3764 this program space, consider superclasses. */
3765 if (VEC_length (const_char_ptr
, result_names
) == last_result_len
)
3766 find_superclass_methods (superclass_vec
, method_name
,
3767 SYMBOL_LANGUAGE (sym
), &result_names
);
3769 /* We have a list of candidate symbol names, so now we
3770 iterate over the symbol tables looking for all
3771 matches in this pspace. */
3772 add_all_symbol_names_from_pspace (&info
, pspace
, result_names
,
3775 VEC_truncate (typep
, superclass_vec
, 0);
3776 last_result_len
= VEC_length (const_char_ptr
, result_names
);
3780 if (!VEC_empty (symbolp
, info
.result
.symbols
)
3781 || !VEC_empty (bound_minimal_symbol_d
, info
.result
.minimal_symbols
))
3783 *symbols
= info
.result
.symbols
;
3784 *minsyms
= info
.result
.minimal_symbols
;
3785 do_cleanups (cleanup
);
3789 /* Throw an NOT_FOUND_ERROR. This will be caught by the caller
3790 and other attempts to locate the symbol will be made. */
3791 throw_error (NOT_FOUND_ERROR
, _("see caller, this text doesn't matter"));
3798 /* This function object is a callback for iterate_over_symtabs, used
3799 when collecting all matching symtabs. */
3801 class symtab_collector
3807 m_symtab_table
= htab_create (1, htab_hash_pointer
, htab_eq_pointer
,
3811 ~symtab_collector ()
3813 if (m_symtab_table
!= NULL
)
3814 htab_delete (m_symtab_table
);
3817 /* Callable as a symbol_found_callback_ftype callback. */
3818 bool operator () (symtab
*sym
);
3820 /* Releases ownership of the collected symtabs and returns them. */
3821 VEC (symtab_ptr
) *release_symtabs ()
3823 VEC (symtab_ptr
) *res
= m_symtabs
;
3829 /* The result vector of symtabs. */
3830 VEC (symtab_ptr
) *m_symtabs
;
3832 /* This is used to ensure the symtabs are unique. */
3833 htab_t m_symtab_table
;
3837 symtab_collector::operator () (struct symtab
*symtab
)
3841 slot
= htab_find_slot (m_symtab_table
, symtab
, INSERT
);
3845 VEC_safe_push (symtab_ptr
, m_symtabs
, symtab
);
3853 /* Given a file name, return a VEC of all matching symtabs. If
3854 SEARCH_PSPACE is not NULL, the search is restricted to just that
3857 static VEC (symtab_ptr
) *
3858 collect_symtabs_from_filename (const char *file
,
3859 struct program_space
*search_pspace
)
3861 symtab_collector collector
;
3863 /* Find that file's data. */
3864 if (search_pspace
== NULL
)
3866 struct program_space
*pspace
;
3868 ALL_PSPACES (pspace
)
3870 if (pspace
->executing_startup
)
3873 set_current_program_space (pspace
);
3874 iterate_over_symtabs (file
, collector
);
3879 set_current_program_space (search_pspace
);
3880 iterate_over_symtabs (file
, collector
);
3883 return collector
.release_symtabs ();
3886 /* Return all the symtabs associated to the FILENAME. If SEARCH_PSPACE is
3887 not NULL, the search is restricted to just that program space. */
3889 static VEC (symtab_ptr
) *
3890 symtabs_from_filename (const char *filename
,
3891 struct program_space
*search_pspace
)
3893 VEC (symtab_ptr
) *result
;
3895 result
= collect_symtabs_from_filename (filename
, search_pspace
);
3897 if (VEC_empty (symtab_ptr
, result
))
3899 if (!have_full_symbols () && !have_partial_symbols ())
3900 throw_error (NOT_FOUND_ERROR
,
3901 _("No symbol table is loaded. "
3902 "Use the \"file\" command."));
3903 source_file_not_found_error (filename
);
3909 /* Look up a function symbol named NAME in symtabs FILE_SYMTABS. Matching
3910 debug symbols are returned in SYMBOLS. Matching minimal symbols are
3911 returned in MINSYMS. */
3914 find_function_symbols (struct linespec_state
*state
,
3915 VEC (symtab_ptr
) *file_symtabs
, const char *name
,
3916 symbol_name_match_type name_match_type
,
3917 VEC (symbolp
) **symbols
,
3918 VEC (bound_minimal_symbol_d
) **minsyms
)
3920 struct collect_info info
;
3921 VEC (const_char_ptr
) *symbol_names
= NULL
;
3922 struct cleanup
*cleanup
= make_cleanup (VEC_cleanup (const_char_ptr
),
3926 info
.result
.symbols
= NULL
;
3927 info
.result
.minimal_symbols
= NULL
;
3928 info
.file_symtabs
= file_symtabs
;
3930 /* Try NAME as an Objective-C selector. */
3931 find_imps (name
, &symbol_names
);
3932 if (!VEC_empty (const_char_ptr
, symbol_names
))
3933 add_all_symbol_names_from_pspace (&info
, state
->search_pspace
,
3934 symbol_names
, FUNCTIONS_DOMAIN
);
3936 add_matching_symbols_to_info (name
, name_match_type
, FUNCTIONS_DOMAIN
,
3937 &info
, state
->search_pspace
);
3939 do_cleanups (cleanup
);
3941 if (VEC_empty (symbolp
, info
.result
.symbols
))
3943 VEC_free (symbolp
, info
.result
.symbols
);
3947 *symbols
= info
.result
.symbols
;
3949 if (VEC_empty (bound_minimal_symbol_d
, info
.result
.minimal_symbols
))
3951 VEC_free (bound_minimal_symbol_d
, info
.result
.minimal_symbols
);
3955 *minsyms
= info
.result
.minimal_symbols
;
3958 /* Find all symbols named NAME in FILE_SYMTABS, returning debug symbols
3959 in SYMBOLS and minimal symbols in MINSYMS. */
3962 find_linespec_symbols (struct linespec_state
*state
,
3963 VEC (symtab_ptr
) *file_symtabs
,
3964 const char *lookup_name
,
3965 symbol_name_match_type name_match_type
,
3966 VEC (symbolp
) **symbols
,
3967 VEC (bound_minimal_symbol_d
) **minsyms
)
3969 std::string canon
= cp_canonicalize_string_no_typedefs (lookup_name
);
3970 if (!canon
.empty ())
3971 lookup_name
= canon
.c_str ();
3973 /* It's important to not call expand_symtabs_matching unnecessarily
3974 as it can really slow things down (by unnecessarily expanding
3975 potentially 1000s of symtabs, which when debugging some apps can
3976 cost 100s of seconds). Avoid this to some extent by *first* calling
3977 find_function_symbols, and only if that doesn't find anything
3978 *then* call find_method. This handles two important cases:
3979 1) break (anonymous namespace)::foo
3980 2) break class::method where method is in class (and not a baseclass) */
3982 find_function_symbols (state
, file_symtabs
, lookup_name
,
3986 /* If we were unable to locate a symbol of the same name, try dividing
3987 the name into class and method names and searching the class and its
3989 if (VEC_empty (symbolp
, *symbols
)
3990 && VEC_empty (bound_minimal_symbol_d
, *minsyms
))
3992 std::string klass
, method
;
3993 const char *last
, *p
, *scope_op
;
3994 VEC (symbolp
) *classes
;
3996 /* See if we can find a scope operator and break this symbol
3997 name into namespaces${SCOPE_OPERATOR}class_name and method_name. */
3999 p
= find_toplevel_string (lookup_name
, scope_op
);
4005 p
= find_toplevel_string (p
+ strlen (scope_op
), scope_op
);
4008 /* If no scope operator was found, there is nothing more we can do;
4009 we already attempted to lookup the entire name as a symbol
4014 /* LOOKUP_NAME points to the class name.
4015 LAST points to the method name. */
4016 klass
= std::string (lookup_name
, last
- lookup_name
);
4018 /* Skip past the scope operator. */
4019 last
+= strlen (scope_op
);
4022 /* Find a list of classes named KLASS. */
4023 classes
= lookup_prefix_sym (state
, file_symtabs
, klass
.c_str ());
4024 struct cleanup
*old_chain
4025 = make_cleanup (VEC_cleanup (symbolp
), &classes
);
4027 if (!VEC_empty (symbolp
, classes
))
4029 /* Now locate a list of suitable methods named METHOD. */
4032 find_method (state
, file_symtabs
,
4033 klass
.c_str (), method
.c_str (),
4034 classes
, symbols
, minsyms
);
4037 /* If successful, we're done. If NOT_FOUND_ERROR
4038 was not thrown, rethrow the exception that we did get. */
4039 CATCH (except
, RETURN_MASK_ERROR
)
4041 if (except
.error
!= NOT_FOUND_ERROR
)
4042 throw_exception (except
);
4047 do_cleanups (old_chain
);
4051 /* Helper for find_label_symbols. Find all labels that match name
4052 NAME in BLOCK. Return all labels that match in FUNCTION_SYMBOLS.
4053 Return the actual function symbol in which the label was found in
4054 LABEL_FUNC_RET. If COMPLETION_MODE is true, then NAME is
4055 interpreted as a label name prefix. Otherwise, only a label named
4056 exactly NAME match. */
4059 find_label_symbols_in_block (const struct block
*block
,
4060 const char *name
, struct symbol
*fn_sym
,
4061 bool completion_mode
,
4062 VEC (symbolp
) **result
,
4063 VEC (symbolp
) **label_funcs_ret
)
4065 if (completion_mode
)
4067 struct block_iterator iter
;
4069 size_t name_len
= strlen (name
);
4071 int (*cmp
) (const char *, const char *, size_t);
4072 cmp
= case_sensitivity
== case_sensitive_on
? strncmp
: strncasecmp
;
4074 ALL_BLOCK_SYMBOLS (block
, iter
, sym
)
4076 if (symbol_matches_domain (SYMBOL_LANGUAGE (sym
),
4077 SYMBOL_DOMAIN (sym
), LABEL_DOMAIN
)
4078 && cmp (SYMBOL_SEARCH_NAME (sym
), name
, name_len
) == 0)
4080 VEC_safe_push (symbolp
, *result
, sym
);
4081 VEC_safe_push (symbolp
, *label_funcs_ret
, fn_sym
);
4087 struct symbol
*sym
= lookup_symbol (name
, block
, LABEL_DOMAIN
, 0).symbol
;
4091 VEC_safe_push (symbolp
, *result
, sym
);
4092 VEC_safe_push (symbolp
, *label_funcs_ret
, fn_sym
);
4097 /* Return all labels that match name NAME in FUNCTION_SYMBOLS. Return
4098 the actual function symbol in which the label was found in
4099 LABEL_FUNC_RET. If COMPLETION_MODE is true, then NAME is
4100 interpreted as a label name prefix. Otherwise, only labels named
4101 exactly NAME match. */
4103 static VEC (symbolp
) *
4104 find_label_symbols (struct linespec_state
*self
,
4105 VEC (symbolp
) *function_symbols
,
4106 VEC (symbolp
) **label_funcs_ret
, const char *name
,
4107 bool completion_mode
)
4110 const struct block
*block
;
4111 struct symbol
*fn_sym
;
4112 VEC (symbolp
) *result
= NULL
;
4114 if (function_symbols
== NULL
)
4116 set_current_program_space (self
->program_space
);
4117 block
= get_current_search_block ();
4120 block
&& !BLOCK_FUNCTION (block
);
4121 block
= BLOCK_SUPERBLOCK (block
))
4125 fn_sym
= BLOCK_FUNCTION (block
);
4127 find_label_symbols_in_block (block
, name
, fn_sym
, completion_mode
,
4128 &result
, label_funcs_ret
);
4133 VEC_iterate (symbolp
, function_symbols
, ix
, fn_sym
); ++ix
)
4135 set_current_program_space (SYMTAB_PSPACE (symbol_symtab (fn_sym
)));
4136 block
= SYMBOL_BLOCK_VALUE (fn_sym
);
4138 find_label_symbols_in_block (block
, name
, fn_sym
, completion_mode
,
4139 &result
, label_funcs_ret
);
4148 /* A helper for create_sals_line_offset that handles the 'list_mode' case. */
4150 static std::vector
<symtab_and_line
>
4151 decode_digits_list_mode (struct linespec_state
*self
,
4153 struct symtab_and_line val
)
4158 gdb_assert (self
->list_mode
);
4160 std::vector
<symtab_and_line
> values
;
4162 for (ix
= 0; VEC_iterate (symtab_ptr
, ls
->file_symtabs
, ix
, elt
);
4165 /* The logic above should ensure this. */
4166 gdb_assert (elt
!= NULL
);
4168 set_current_program_space (SYMTAB_PSPACE (elt
));
4170 /* Simplistic search just for the list command. */
4171 val
.symtab
= find_line_symtab (elt
, val
.line
, NULL
, NULL
);
4172 if (val
.symtab
== NULL
)
4174 val
.pspace
= SYMTAB_PSPACE (elt
);
4176 val
.explicit_line
= 1;
4178 add_sal_to_sals (self
, &values
, &val
, NULL
, 0);
4184 /* A helper for create_sals_line_offset that iterates over the symtabs,
4185 adding lines to the VEC. */
4187 static std::vector
<symtab_and_line
>
4188 decode_digits_ordinary (struct linespec_state
*self
,
4191 struct linetable_entry
**best_entry
)
4196 std::vector
<symtab_and_line
> sals
;
4197 for (ix
= 0; VEC_iterate (symtab_ptr
, ls
->file_symtabs
, ix
, elt
); ++ix
)
4199 std::vector
<CORE_ADDR
> pcs
;
4201 /* The logic above should ensure this. */
4202 gdb_assert (elt
!= NULL
);
4204 set_current_program_space (SYMTAB_PSPACE (elt
));
4206 pcs
= find_pcs_for_symtab_line (elt
, line
, best_entry
);
4207 for (CORE_ADDR pc
: pcs
)
4209 symtab_and_line sal
;
4210 sal
.pspace
= SYMTAB_PSPACE (elt
);
4214 sals
.push_back (std::move (sal
));
4223 /* Return the line offset represented by VARIABLE. */
4225 static struct line_offset
4226 linespec_parse_variable (struct linespec_state
*self
, const char *variable
)
4230 struct line_offset offset
= {0, LINE_OFFSET_NONE
};
4232 p
= (variable
[1] == '$') ? variable
+ 2 : variable
+ 1;
4235 while (*p
>= '0' && *p
<= '9')
4237 if (!*p
) /* Reached end of token without hitting non-digit. */
4239 /* We have a value history reference. */
4240 struct value
*val_history
;
4242 sscanf ((variable
[1] == '$') ? variable
+ 2 : variable
+ 1, "%d", &index
);
4244 = access_value_history ((variable
[1] == '$') ? -index
: index
);
4245 if (TYPE_CODE (value_type (val_history
)) != TYPE_CODE_INT
)
4246 error (_("History values used in line "
4247 "specs must have integer values."));
4248 offset
.offset
= value_as_long (val_history
);
4252 /* Not all digits -- may be user variable/function or a
4253 convenience variable. */
4255 struct internalvar
*ivar
;
4257 /* Try it as a convenience variable. If it is not a convenience
4258 variable, return and allow normal symbol lookup to occur. */
4259 ivar
= lookup_only_internalvar (variable
+ 1);
4261 /* No internal variable with that name. Mark the offset
4262 as unknown to allow the name to be looked up as a symbol. */
4263 offset
.sign
= LINE_OFFSET_UNKNOWN
;
4266 /* We found a valid variable name. If it is not an integer,
4268 if (!get_internalvar_integer (ivar
, &valx
))
4269 error (_("Convenience variables used in line "
4270 "specs must have integer values."));
4272 offset
.offset
= valx
;
4280 /* We've found a minimal symbol MSYMBOL in OBJFILE to associate with our
4281 linespec; return the SAL in RESULT. This function should return SALs
4282 matching those from find_function_start_sal, otherwise false
4283 multiple-locations breakpoints could be placed. */
4286 minsym_found (struct linespec_state
*self
, struct objfile
*objfile
,
4287 struct minimal_symbol
*msymbol
,
4288 std::vector
<symtab_and_line
> *result
)
4290 struct symtab_and_line sal
;
4292 CORE_ADDR func_addr
;
4293 if (msymbol_is_function (objfile
, msymbol
, &func_addr
))
4295 sal
= find_pc_sect_line (func_addr
, NULL
, 0);
4297 if (self
->funfirstline
)
4299 if (sal
.symtab
!= NULL
4300 && (COMPUNIT_LOCATIONS_VALID (SYMTAB_COMPUNIT (sal
.symtab
))
4301 || SYMTAB_LANGUAGE (sal
.symtab
) == language_asm
))
4303 struct gdbarch
*gdbarch
= get_objfile_arch (objfile
);
4306 if (gdbarch_skip_entrypoint_p (gdbarch
))
4307 sal
.pc
= gdbarch_skip_entrypoint (gdbarch
, sal
.pc
);
4310 skip_prologue_sal (&sal
);
4315 sal
.objfile
= objfile
;
4316 sal
.pc
= MSYMBOL_VALUE_ADDRESS (objfile
, msymbol
);
4317 sal
.pspace
= current_program_space
;
4320 sal
.section
= MSYMBOL_OBJ_SECTION (objfile
, msymbol
);
4322 if (maybe_add_address (self
->addr_set
, objfile
->pspace
, sal
.pc
))
4323 add_sal_to_sals (self
, result
, &sal
, MSYMBOL_NATURAL_NAME (msymbol
), 0);
4326 /* A helper function to classify a minimal_symbol_type according to
4330 classify_mtype (enum minimal_symbol_type t
)
4337 /* Intermediate priority. */
4340 case mst_solib_trampoline
:
4341 /* Lowest priority. */
4345 /* Highest priority. */
4350 /* Callback for std::sort that sorts symbols by priority. */
4353 compare_msyms (const bound_minimal_symbol
&a
, const bound_minimal_symbol
&b
)
4355 enum minimal_symbol_type ta
= MSYMBOL_TYPE (a
.minsym
);
4356 enum minimal_symbol_type tb
= MSYMBOL_TYPE (b
.minsym
);
4358 return classify_mtype (ta
) < classify_mtype (tb
);
4361 /* Helper for search_minsyms_for_name that adds the symbol to the
4365 add_minsym (struct minimal_symbol
*minsym
, struct objfile
*objfile
,
4366 struct symtab
*symtab
, int list_mode
,
4367 std::vector
<struct bound_minimal_symbol
> *msyms
)
4371 /* We're looking for a label for which we don't have debug
4373 CORE_ADDR func_addr
;
4374 if (msymbol_is_function (objfile
, minsym
, &func_addr
))
4376 symtab_and_line sal
= find_pc_sect_line (func_addr
, NULL
, 0);
4378 if (symtab
!= sal
.symtab
)
4383 /* Exclude data symbols when looking for breakpoint locations. */
4384 if (!list_mode
&& !msymbol_is_function (objfile
, minsym
))
4387 struct bound_minimal_symbol mo
= {minsym
, objfile
};
4388 msyms
->push_back (mo
);
4391 /* Search for minimal symbols called NAME. If SEARCH_PSPACE
4392 is not NULL, the search is restricted to just that program
4395 If SYMTAB is NULL, search all objfiles, otherwise
4396 restrict results to the given SYMTAB. */
4399 search_minsyms_for_name (struct collect_info
*info
,
4400 const lookup_name_info
&name
,
4401 struct program_space
*search_pspace
,
4402 struct symtab
*symtab
)
4404 std::vector
<struct bound_minimal_symbol
> minsyms
;
4408 struct program_space
*pspace
;
4410 ALL_PSPACES (pspace
)
4412 struct objfile
*objfile
;
4414 if (search_pspace
!= NULL
&& search_pspace
!= pspace
)
4416 if (pspace
->executing_startup
)
4419 set_current_program_space (pspace
);
4421 ALL_OBJFILES (objfile
)
4423 iterate_over_minimal_symbols (objfile
, name
,
4424 [&] (struct minimal_symbol
*msym
)
4426 add_minsym (msym
, objfile
, nullptr,
4427 info
->state
->list_mode
,
4435 if (search_pspace
== NULL
|| SYMTAB_PSPACE (symtab
) == search_pspace
)
4437 set_current_program_space (SYMTAB_PSPACE (symtab
));
4438 iterate_over_minimal_symbols
4439 (SYMTAB_OBJFILE (symtab
), name
,
4440 [&] (struct minimal_symbol
*msym
)
4442 add_minsym (msym
, SYMTAB_OBJFILE (symtab
), symtab
,
4443 info
->state
->list_mode
, &minsyms
);
4448 if (!minsyms
.empty ())
4452 std::sort (minsyms
.begin (), minsyms
.end (), compare_msyms
);
4454 /* Now the minsyms are in classification order. So, we walk
4455 over them and process just the minsyms with the same
4456 classification as the very first minsym in the list. */
4457 classification
= classify_mtype (MSYMBOL_TYPE (minsyms
[0].minsym
));
4459 for (const struct bound_minimal_symbol
&item
: minsyms
)
4461 if (classify_mtype (MSYMBOL_TYPE (item
.minsym
)) != classification
)
4464 VEC_safe_push (bound_minimal_symbol_d
,
4465 info
->result
.minimal_symbols
, &item
);
4470 /* A helper function to add all symbols matching NAME to INFO. If
4471 PSPACE is not NULL, the search is restricted to just that program
4475 add_matching_symbols_to_info (const char *name
,
4476 symbol_name_match_type name_match_type
,
4477 enum search_domain search_domain
,
4478 struct collect_info
*info
,
4479 struct program_space
*pspace
)
4484 lookup_name_info
lookup_name (name
, name_match_type
);
4486 for (ix
= 0; VEC_iterate (symtab_ptr
, info
->file_symtabs
, ix
, elt
); ++ix
)
4490 iterate_over_all_matching_symtabs (info
->state
, lookup_name
,
4491 VAR_DOMAIN
, search_domain
,
4492 pspace
, true, [&] (symbol
*sym
)
4493 { return info
->add_symbol (sym
); });
4494 search_minsyms_for_name (info
, lookup_name
, pspace
, NULL
);
4496 else if (pspace
== NULL
|| pspace
== SYMTAB_PSPACE (elt
))
4498 int prev_len
= VEC_length (symbolp
, info
->result
.symbols
);
4500 /* Program spaces that are executing startup should have
4501 been filtered out earlier. */
4502 gdb_assert (!SYMTAB_PSPACE (elt
)->executing_startup
);
4503 set_current_program_space (SYMTAB_PSPACE (elt
));
4504 iterate_over_file_blocks (elt
, lookup_name
, VAR_DOMAIN
,
4506 { return info
->add_symbol (sym
); });
4508 /* If no new symbols were found in this iteration and this symtab
4509 is in assembler, we might actually be looking for a label for
4510 which we don't have debug info. Check for a minimal symbol in
4512 if (prev_len
== VEC_length (symbolp
, info
->result
.symbols
)
4513 && elt
->language
== language_asm
)
4514 search_minsyms_for_name (info
, lookup_name
, pspace
, elt
);
4521 /* Now come some functions that are called from multiple places within
4525 symbol_to_sal (struct symtab_and_line
*result
,
4526 int funfirstline
, struct symbol
*sym
)
4528 if (SYMBOL_CLASS (sym
) == LOC_BLOCK
)
4530 *result
= find_function_start_sal (sym
, funfirstline
);
4535 if (SYMBOL_CLASS (sym
) == LOC_LABEL
&& SYMBOL_VALUE_ADDRESS (sym
) != 0)
4538 result
->symtab
= symbol_symtab (sym
);
4539 result
->symbol
= sym
;
4540 result
->line
= SYMBOL_LINE (sym
);
4541 result
->pc
= SYMBOL_VALUE_ADDRESS (sym
);
4542 result
->pspace
= SYMTAB_PSPACE (result
->symtab
);
4543 result
->explicit_pc
= 1;
4546 else if (funfirstline
)
4550 else if (SYMBOL_LINE (sym
) != 0)
4552 /* We know its line number. */
4554 result
->symtab
= symbol_symtab (sym
);
4555 result
->symbol
= sym
;
4556 result
->line
= SYMBOL_LINE (sym
);
4557 result
->pc
= SYMBOL_VALUE_ADDRESS (sym
);
4558 result
->pspace
= SYMTAB_PSPACE (result
->symtab
);
4566 linespec_result::~linespec_result ()
4568 for (linespec_sals
&lsal
: lsals
)
4569 xfree (lsal
.canonical
);
4572 /* Return the quote characters permitted by the linespec parser. */
4575 get_gdb_linespec_parser_quote_characters (void)
4577 return linespec_quote_characters
;