1 /* Parser for linespec for the GNU debugger, GDB.
3 Copyright (C) 1986-2017 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"
49 /* An enumeration of the various things a user might attempt to
50 complete for a linespec location. */
52 enum class linespec_complete_what
54 /* Nothing, no possible completion. */
57 /* A function/method name. Due to ambiguity between
63 this can also indicate a source filename, iff we haven't seen a
64 separate source filename component, as in "b source.c:function". */
67 /* A label symbol. E.g., break file.c:function:LABEL. */
70 /* An expression. E.g., "break foo if EXPR", or "break *EXPR". */
73 /* A linespec keyword ("if"/"thread"/"task").
74 E.g., "break func threa<tab>". */
78 typedef struct symbol
*symbolp
;
81 typedef struct type
*typep
;
84 /* An address entry is used to ensure that any given location is only
85 added to the result a single time. It holds an address and the
86 program space from which the address came. */
90 struct program_space
*pspace
;
94 typedef struct bound_minimal_symbol bound_minimal_symbol_d
;
96 DEF_VEC_O (bound_minimal_symbol_d
);
98 /* A linespec. Elements of this structure are filled in by a parser
99 (either parse_linespec or some other function). The structure is
100 then converted into SALs by convert_linespec_to_sals. */
104 /* An explicit location describing the SaLs. */
105 struct explicit_location explicit_loc
;
107 /* The list of symtabs to search to which to limit the search. May not
108 be NULL. If explicit.SOURCE_FILENAME is NULL (no user-specified
109 filename), FILE_SYMTABS should contain one single NULL member. This
110 will cause the code to use the default symtab. */
111 VEC (symtab_ptr
) *file_symtabs
;
113 /* A list of matching function symbols and minimal symbols. Both lists
114 may be NULL if no matching symbols were found. */
115 VEC (symbolp
) *function_symbols
;
116 VEC (bound_minimal_symbol_d
) *minimal_symbols
;
118 /* A structure of matching label symbols and the corresponding
119 function symbol in which the label was found. Both may be NULL
120 or both must be non-NULL. */
123 VEC (symbolp
) *label_symbols
;
124 VEC (symbolp
) *function_symbols
;
127 typedef struct linespec
*linespec_p
;
129 /* A canonical linespec represented as a symtab-related string.
131 Each entry represents the "SYMTAB:SUFFIX" linespec string.
132 SYMTAB can be converted for example by symtab_to_fullname or
133 symtab_to_filename_for_display as needed. */
135 struct linespec_canonical_name
137 /* Remaining text part of the linespec string. */
140 /* If NULL then SUFFIX is the whole linespec string. */
141 struct symtab
*symtab
;
144 /* An instance of this is used to keep all state while linespec
145 operates. This instance is passed around as a 'this' pointer to
146 the various implementation methods. */
148 struct linespec_state
150 /* The language in use during linespec processing. */
151 const struct language_defn
*language
;
153 /* The program space as seen when the module was entered. */
154 struct program_space
*program_space
;
156 /* If not NULL, the search is restricted to just this program
158 struct program_space
*search_pspace
;
160 /* The default symtab to use, if no other symtab is specified. */
161 struct symtab
*default_symtab
;
163 /* The default line to use. */
166 /* The 'funfirstline' value that was passed in to decode_line_1 or
170 /* Nonzero if we are running in 'list' mode; see decode_line_list. */
173 /* The 'canonical' value passed to decode_line_full, or NULL. */
174 struct linespec_result
*canonical
;
176 /* Canonical strings that mirror the symtabs_and_lines result. */
177 struct linespec_canonical_name
*canonical_names
;
179 /* This is a set of address_entry objects which is used to prevent
180 duplicate symbols from being entered into the result. */
183 /* Are we building a linespec? */
187 /* This is a helper object that is used when collecting symbols into a
192 /* The linespec object in use. */
193 struct linespec_state
*state
;
195 /* A list of symtabs to which to restrict matches. */
196 VEC (symtab_ptr
) *file_symtabs
;
198 /* The result being accumulated. */
201 VEC (symbolp
) *symbols
;
202 VEC (bound_minimal_symbol_d
) *minimal_symbols
;
205 /* Possibly add a symbol to the results. */
206 bool add_symbol (symbol
*sym
);
210 collect_info::add_symbol (symbol
*sym
)
212 /* In list mode, add all matching symbols, regardless of class.
213 This allows the user to type "list a_global_variable". */
214 if (SYMBOL_CLASS (sym
) == LOC_BLOCK
|| this->state
->list_mode
)
215 VEC_safe_push (symbolp
, this->result
.symbols
, sym
);
217 /* Continue iterating. */
228 /* A colon "separator" */
240 /* EOI (end of input) */
246 typedef enum ls_token_type linespec_token_type
;
248 /* List of keywords. This is NULL-terminated so that it can be used
249 as enum completer. */
250 const char * const linespec_keywords
[] = { "if", "thread", "task", NULL
};
251 #define IF_KEYWORD_INDEX 0
253 /* A token of the linespec lexer */
257 /* The type of the token */
258 linespec_token_type type
;
260 /* Data for the token */
263 /* A string, given as a stoken */
264 struct stoken string
;
270 typedef struct ls_token linespec_token
;
272 #define LS_TOKEN_STOKEN(TOK) (TOK).data.string
273 #define LS_TOKEN_KEYWORD(TOK) (TOK).data.keyword
275 /* An instance of the linespec parser. */
279 /* Lexer internal data */
282 /* Save head of input stream. */
283 const char *saved_arg
;
285 /* Head of the input stream. */
287 #define PARSER_STREAM(P) ((P)->lexer.stream)
289 /* The current token. */
290 linespec_token current
;
293 /* Is the entire linespec quote-enclosed? */
294 int is_quote_enclosed
;
296 /* The state of the parse. */
297 struct linespec_state state
;
298 #define PARSER_STATE(PPTR) (&(PPTR)->state)
300 /* The result of the parse. */
301 struct linespec result
;
302 #define PARSER_RESULT(PPTR) (&(PPTR)->result)
304 /* What the parser believes the current word point should complete
306 linespec_complete_what complete_what
;
308 /* The completion word point. The parser advances this as it skips
309 tokens. At some point the input string will end or parsing will
310 fail, and then we attempt completion at the captured completion
311 word point, interpreting the string at completion_word as
313 const char *completion_word
;
315 /* If the current token was a quoted string, then this is the
316 quoting character (either " or '). */
317 int completion_quote_char
;
319 /* If the current token was a quoted string, then this points at the
320 end of the quoted string. */
321 const char *completion_quote_end
;
323 /* If parsing for completion, then this points at the completion
324 tracker. Otherwise, this is NULL. */
325 struct completion_tracker
*completion_tracker
;
327 typedef struct ls_parser linespec_parser
;
329 /* A convenience macro for accessing the explicit location result of
331 #define PARSER_EXPLICIT(PPTR) (&PARSER_RESULT ((PPTR))->explicit_loc)
333 /* Prototypes for local functions. */
335 static void iterate_over_file_blocks
336 (struct symtab
*symtab
, const char *name
, domain_enum domain
,
337 gdb::function_view
<symbol_found_callback_ftype
> callback
);
339 static void initialize_defaults (struct symtab
**default_symtab
,
342 CORE_ADDR
linespec_expression_to_pc (const char **exp_ptr
);
344 static struct symtabs_and_lines
decode_objc (struct linespec_state
*self
,
348 static VEC (symtab_ptr
) *symtabs_from_filename (const char *,
349 struct program_space
*pspace
);
351 static VEC (symbolp
) *find_label_symbols (struct linespec_state
*self
,
352 VEC (symbolp
) *function_symbols
,
353 VEC (symbolp
) **label_funcs_ret
,
355 bool completion_mode
= false);
357 static void find_linespec_symbols (struct linespec_state
*self
,
358 VEC (symtab_ptr
) *file_symtabs
,
360 VEC (symbolp
) **symbols
,
361 VEC (bound_minimal_symbol_d
) **minsyms
);
363 static struct line_offset
364 linespec_parse_variable (struct linespec_state
*self
,
365 const char *variable
);
367 static int symbol_to_sal (struct symtab_and_line
*result
,
368 int funfirstline
, struct symbol
*sym
);
370 static void add_matching_symbols_to_info (const char *name
,
371 struct collect_info
*info
,
372 struct program_space
*pspace
);
374 static void add_all_symbol_names_from_pspace (struct collect_info
*info
,
375 struct program_space
*pspace
,
376 VEC (const_char_ptr
) *names
);
378 static VEC (symtab_ptr
) *
379 collect_symtabs_from_filename (const char *file
,
380 struct program_space
*pspace
);
382 static void decode_digits_ordinary (struct linespec_state
*self
,
385 struct symtabs_and_lines
*sals
,
386 struct linetable_entry
**best_entry
);
388 static void decode_digits_list_mode (struct linespec_state
*self
,
390 struct symtabs_and_lines
*values
,
391 struct symtab_and_line val
);
393 static void minsym_found (struct linespec_state
*self
, struct objfile
*objfile
,
394 struct minimal_symbol
*msymbol
,
395 struct symtabs_and_lines
*result
);
397 static int compare_symbols (const void *a
, const void *b
);
399 static int compare_msymbols (const void *a
, const void *b
);
401 /* Permitted quote characters for the parser. This is different from the
402 completer's quote characters to allow backward compatibility with the
404 static const char *const linespec_quote_characters
= "\"\'";
406 /* Lexer functions. */
408 /* Lex a number from the input in PARSER. This only supports
411 Return true if input is decimal numbers. Return false if not. */
414 linespec_lexer_lex_number (linespec_parser
*parser
, linespec_token
*tokenp
)
416 tokenp
->type
= LSTOKEN_NUMBER
;
417 LS_TOKEN_STOKEN (*tokenp
).length
= 0;
418 LS_TOKEN_STOKEN (*tokenp
).ptr
= PARSER_STREAM (parser
);
420 /* Keep any sign at the start of the stream. */
421 if (*PARSER_STREAM (parser
) == '+' || *PARSER_STREAM (parser
) == '-')
423 ++LS_TOKEN_STOKEN (*tokenp
).length
;
424 ++(PARSER_STREAM (parser
));
427 while (isdigit (*PARSER_STREAM (parser
)))
429 ++LS_TOKEN_STOKEN (*tokenp
).length
;
430 ++(PARSER_STREAM (parser
));
433 /* If the next character in the input buffer is not a space, comma,
434 quote, or colon, this input does not represent a number. */
435 if (*PARSER_STREAM (parser
) != '\0'
436 && !isspace (*PARSER_STREAM (parser
)) && *PARSER_STREAM (parser
) != ','
437 && *PARSER_STREAM (parser
) != ':'
438 && !strchr (linespec_quote_characters
, *PARSER_STREAM (parser
)))
440 PARSER_STREAM (parser
) = LS_TOKEN_STOKEN (*tokenp
).ptr
;
447 /* See linespec.h. */
450 linespec_lexer_lex_keyword (const char *p
)
456 for (i
= 0; linespec_keywords
[i
] != NULL
; ++i
)
458 int len
= strlen (linespec_keywords
[i
]);
460 /* If P begins with one of the keywords and the next
461 character is whitespace, we may have found a keyword.
462 It is only a keyword if it is not followed by another
464 if (strncmp (p
, linespec_keywords
[i
], len
) == 0
469 /* Special case: "if" ALWAYS stops the lexer, since it
470 is not possible to predict what is going to appear in
471 the condition, which can only be parsed after SaLs have
473 if (i
!= IF_KEYWORD_INDEX
)
476 p
= skip_spaces_const (p
);
477 for (j
= 0; linespec_keywords
[j
] != NULL
; ++j
)
479 int nextlen
= strlen (linespec_keywords
[j
]);
481 if (strncmp (p
, linespec_keywords
[j
], nextlen
) == 0
482 && isspace (p
[nextlen
]))
487 return linespec_keywords
[i
];
495 /* See description in linespec.h. */
498 is_ada_operator (const char *string
)
500 const struct ada_opname_map
*mapping
;
502 for (mapping
= ada_opname_table
;
503 mapping
->encoded
!= NULL
504 && !startswith (string
, mapping
->decoded
); ++mapping
)
507 return mapping
->decoded
== NULL
? 0 : strlen (mapping
->decoded
);
510 /* Find QUOTE_CHAR in STRING, accounting for the ':' terminal. Return
511 the location of QUOTE_CHAR, or NULL if not found. */
514 skip_quote_char (const char *string
, char quote_char
)
516 const char *p
, *last
;
518 p
= last
= find_toplevel_char (string
, quote_char
);
519 while (p
&& *p
!= '\0' && *p
!= ':')
521 p
= find_toplevel_char (p
, quote_char
);
529 /* Make a writable copy of the string given in TOKEN, trimming
530 any trailing whitespace. */
533 copy_token_string (linespec_token token
)
537 if (token
.type
== LSTOKEN_KEYWORD
)
538 return xstrdup (LS_TOKEN_KEYWORD (token
));
540 str
= savestring (LS_TOKEN_STOKEN (token
).ptr
,
541 LS_TOKEN_STOKEN (token
).length
);
542 s
= remove_trailing_whitespace (str
, str
+ LS_TOKEN_STOKEN (token
).length
);
548 /* Does P represent the end of a quote-enclosed linespec? */
551 is_closing_quote_enclosed (const char *p
)
553 if (strchr (linespec_quote_characters
, *p
))
555 p
= skip_spaces ((char *) p
);
556 return (*p
== '\0' || linespec_lexer_lex_keyword (p
));
559 /* Find the end of the parameter list that starts with *INPUT.
560 This helper function assists with lexing string segments
561 which might contain valid (non-terminating) commas. */
564 find_parameter_list_end (const char *input
)
566 char end_char
, start_char
;
571 if (start_char
== '(')
573 else if (start_char
== '<')
582 if (*p
== start_char
)
584 else if (*p
== end_char
)
598 /* If the [STRING, STRING_LEN) string ends with what looks like a
599 keyword, return the keyword start offset in STRING. Return -1
603 string_find_incomplete_keyword_at_end (const char * const *keywords
,
604 const char *string
, size_t string_len
)
606 const char *end
= string
+ string_len
;
609 while (p
> string
&& *p
!= ' ')
614 size_t len
= end
- p
;
615 for (size_t i
= 0; keywords
[i
] != NULL
; ++i
)
616 if (strncmp (keywords
[i
], p
, len
) == 0)
623 /* Lex a string from the input in PARSER. */
625 static linespec_token
626 linespec_lexer_lex_string (linespec_parser
*parser
)
628 linespec_token token
;
629 const char *start
= PARSER_STREAM (parser
);
631 token
.type
= LSTOKEN_STRING
;
633 /* If the input stream starts with a quote character, skip to the next
634 quote character, regardless of the content. */
635 if (strchr (linespec_quote_characters
, *PARSER_STREAM (parser
)))
638 char quote_char
= *PARSER_STREAM (parser
);
640 /* Special case: Ada operators. */
641 if (PARSER_STATE (parser
)->language
->la_language
== language_ada
642 && quote_char
== '\"')
644 int len
= is_ada_operator (PARSER_STREAM (parser
));
648 /* The input is an Ada operator. Return the quoted string
650 LS_TOKEN_STOKEN (token
).ptr
= PARSER_STREAM (parser
);
651 LS_TOKEN_STOKEN (token
).length
= len
;
652 PARSER_STREAM (parser
) += len
;
656 /* The input does not represent an Ada operator -- fall through
657 to normal quoted string handling. */
660 /* Skip past the beginning quote. */
661 ++(PARSER_STREAM (parser
));
663 /* Mark the start of the string. */
664 LS_TOKEN_STOKEN (token
).ptr
= PARSER_STREAM (parser
);
666 /* Skip to the ending quote. */
667 end
= skip_quote_char (PARSER_STREAM (parser
), quote_char
);
669 /* This helps the completer mode decide whether we have a
671 parser
->completion_quote_char
= quote_char
;
672 parser
->completion_quote_end
= end
;
674 /* Error if the input did not terminate properly, unless in
678 if (parser
->completion_tracker
== NULL
)
679 error (_("unmatched quote"));
681 /* In completion mode, we'll try to complete the incomplete
683 token
.type
= LSTOKEN_STRING
;
684 while (*PARSER_STREAM (parser
) != '\0')
685 PARSER_STREAM (parser
)++;
686 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - 1 - start
;
690 /* Skip over the ending quote and mark the length of the string. */
691 PARSER_STREAM (parser
) = (char *) ++end
;
692 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - 2 - start
;
699 /* Otherwise, only identifier characters are permitted.
700 Spaces are the exception. In general, we keep spaces,
701 but only if the next characters in the input do not resolve
702 to one of the keywords.
704 This allows users to forgo quoting CV-qualifiers, template arguments,
705 and similar common language constructs. */
709 if (isspace (*PARSER_STREAM (parser
)))
711 p
= skip_spaces_const (PARSER_STREAM (parser
));
712 /* When we get here we know we've found something followed by
713 a space (we skip over parens and templates below).
714 So if we find a keyword now, we know it is a keyword and not,
715 say, a function name. */
716 if (linespec_lexer_lex_keyword (p
) != NULL
)
718 LS_TOKEN_STOKEN (token
).ptr
= start
;
719 LS_TOKEN_STOKEN (token
).length
720 = PARSER_STREAM (parser
) - start
;
724 /* Advance past the whitespace. */
725 PARSER_STREAM (parser
) = p
;
728 /* If the next character is EOI or (single) ':', the
729 string is complete; return the token. */
730 if (*PARSER_STREAM (parser
) == 0)
732 LS_TOKEN_STOKEN (token
).ptr
= start
;
733 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - start
;
736 else if (PARSER_STREAM (parser
)[0] == ':')
738 /* Do not tokenize the C++ scope operator. */
739 if (PARSER_STREAM (parser
)[1] == ':')
740 ++(PARSER_STREAM (parser
));
742 /* Do not tokenify if the input length so far is one
743 (i.e, a single-letter drive name) and the next character
744 is a directory separator. This allows Windows-style
745 paths to be recognized as filenames without quoting it. */
746 else if ((PARSER_STREAM (parser
) - start
) != 1
747 || !IS_DIR_SEPARATOR (PARSER_STREAM (parser
)[1]))
749 LS_TOKEN_STOKEN (token
).ptr
= start
;
750 LS_TOKEN_STOKEN (token
).length
751 = PARSER_STREAM (parser
) - start
;
755 /* Special case: permit quote-enclosed linespecs. */
756 else if (parser
->is_quote_enclosed
757 && strchr (linespec_quote_characters
,
758 *PARSER_STREAM (parser
))
759 && is_closing_quote_enclosed (PARSER_STREAM (parser
)))
761 LS_TOKEN_STOKEN (token
).ptr
= start
;
762 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - start
;
765 /* Because commas may terminate a linespec and appear in
766 the middle of valid string input, special cases for
767 '<' and '(' are necessary. */
768 else if (*PARSER_STREAM (parser
) == '<'
769 || *PARSER_STREAM (parser
) == '(')
771 /* Don't interpret 'operator<' / 'operator<<' as a
772 template parameter list though. */
773 if (*PARSER_STREAM (parser
) == '<'
774 && (PARSER_STATE (parser
)->language
->la_language
776 && (PARSER_STREAM (parser
) - start
) >= CP_OPERATOR_LEN
)
778 const char *p
= PARSER_STREAM (parser
);
780 while (p
> start
&& isspace (p
[-1]))
782 if (p
- start
>= CP_OPERATOR_LEN
)
784 p
-= CP_OPERATOR_LEN
;
785 if (strncmp (p
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0
787 || !(isalnum (p
[-1]) || p
[-1] == '_')))
789 /* This is an operator name. Keep going. */
790 ++(PARSER_STREAM (parser
));
791 if (*PARSER_STREAM (parser
) == '<')
792 ++(PARSER_STREAM (parser
));
798 const char *p
= find_parameter_list_end (PARSER_STREAM (parser
));
799 PARSER_STREAM (parser
) = p
;
801 /* Don't loop around to the normal \0 case above because
802 we don't want to misinterpret a potential keyword at
803 the end of the token when the string isn't
804 "()<>"-balanced. This handles "b
805 function(thread<tab>" in completion mode. */
808 LS_TOKEN_STOKEN (token
).ptr
= start
;
809 LS_TOKEN_STOKEN (token
).length
810 = PARSER_STREAM (parser
) - start
;
816 /* Commas are terminators, but not if they are part of an
818 else if (*PARSER_STREAM (parser
) == ',')
820 if ((PARSER_STATE (parser
)->language
->la_language
822 && (PARSER_STREAM (parser
) - start
) > CP_OPERATOR_LEN
)
824 const char *p
= strstr (start
, CP_OPERATOR_STR
);
826 if (p
!= NULL
&& is_operator_name (p
))
828 /* This is an operator name. Keep going. */
829 ++(PARSER_STREAM (parser
));
834 /* Comma terminates the string. */
835 LS_TOKEN_STOKEN (token
).ptr
= start
;
836 LS_TOKEN_STOKEN (token
).length
= PARSER_STREAM (parser
) - start
;
840 /* Advance the stream. */
841 ++(PARSER_STREAM (parser
));
848 /* Lex a single linespec token from PARSER. */
850 static linespec_token
851 linespec_lexer_lex_one (linespec_parser
*parser
)
855 if (parser
->lexer
.current
.type
== LSTOKEN_CONSUMED
)
857 /* Skip any whitespace. */
858 PARSER_STREAM (parser
) = skip_spaces_const (PARSER_STREAM (parser
));
860 /* Check for a keyword, they end the linespec. */
861 keyword
= linespec_lexer_lex_keyword (PARSER_STREAM (parser
));
864 parser
->lexer
.current
.type
= LSTOKEN_KEYWORD
;
865 LS_TOKEN_KEYWORD (parser
->lexer
.current
) = keyword
;
866 /* We do not advance the stream here intentionally:
867 we would like lexing to stop when a keyword is seen.
869 PARSER_STREAM (parser) += strlen (keyword); */
871 return parser
->lexer
.current
;
874 /* Handle other tokens. */
875 switch (*PARSER_STREAM (parser
))
878 parser
->lexer
.current
.type
= LSTOKEN_EOI
;
882 case '0': case '1': case '2': case '3': case '4':
883 case '5': case '6': case '7': case '8': case '9':
884 if (!linespec_lexer_lex_number (parser
, &(parser
->lexer
.current
)))
885 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
889 /* If we have a scope operator, lex the input as a string.
890 Otherwise, return LSTOKEN_COLON. */
891 if (PARSER_STREAM (parser
)[1] == ':')
892 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
895 parser
->lexer
.current
.type
= LSTOKEN_COLON
;
896 ++(PARSER_STREAM (parser
));
900 case '\'': case '\"':
901 /* Special case: permit quote-enclosed linespecs. */
902 if (parser
->is_quote_enclosed
903 && is_closing_quote_enclosed (PARSER_STREAM (parser
)))
905 ++(PARSER_STREAM (parser
));
906 parser
->lexer
.current
.type
= LSTOKEN_EOI
;
909 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
913 parser
->lexer
.current
.type
= LSTOKEN_COMMA
;
914 LS_TOKEN_STOKEN (parser
->lexer
.current
).ptr
915 = PARSER_STREAM (parser
);
916 LS_TOKEN_STOKEN (parser
->lexer
.current
).length
= 1;
917 ++(PARSER_STREAM (parser
));
921 /* If the input is not a number, it must be a string.
922 [Keywords were already considered above.] */
923 parser
->lexer
.current
= linespec_lexer_lex_string (parser
);
928 return parser
->lexer
.current
;
931 /* Consume the current token and return the next token in PARSER's
932 input stream. Also advance the completion word for completion
935 static linespec_token
936 linespec_lexer_consume_token (linespec_parser
*parser
)
938 gdb_assert (parser
->lexer
.current
.type
!= LSTOKEN_EOI
);
940 bool advance_word
= (parser
->lexer
.current
.type
!= LSTOKEN_STRING
941 || *PARSER_STREAM (parser
) != '\0');
943 /* If we're moving past a string to some other token, it must be the
944 quote was terminated. */
945 if (parser
->completion_quote_char
)
947 gdb_assert (parser
->lexer
.current
.type
== LSTOKEN_STRING
);
949 /* If the string was the last (non-EOI) token, we're past the
950 quote, but remember that for later. */
951 if (*PARSER_STREAM (parser
) != '\0')
953 parser
->completion_quote_char
= '\0';
954 parser
->completion_quote_end
= NULL
;;
958 parser
->lexer
.current
.type
= LSTOKEN_CONSUMED
;
959 linespec_lexer_lex_one (parser
);
961 if (parser
->lexer
.current
.type
== LSTOKEN_STRING
)
963 /* Advance the completion word past a potential initial
965 parser
->completion_word
= LS_TOKEN_STOKEN (parser
->lexer
.current
).ptr
;
967 else if (advance_word
)
969 /* Advance the completion word past any whitespace. */
970 parser
->completion_word
= PARSER_STREAM (parser
);
973 return parser
->lexer
.current
;
976 /* Return the next token without consuming the current token. */
978 static linespec_token
979 linespec_lexer_peek_token (linespec_parser
*parser
)
982 const char *saved_stream
= PARSER_STREAM (parser
);
983 linespec_token saved_token
= parser
->lexer
.current
;
984 int saved_completion_quote_char
= parser
->completion_quote_char
;
985 const char *saved_completion_quote_end
= parser
->completion_quote_end
;
986 const char *saved_completion_word
= parser
->completion_word
;
988 next
= linespec_lexer_consume_token (parser
);
989 PARSER_STREAM (parser
) = saved_stream
;
990 parser
->lexer
.current
= saved_token
;
991 parser
->completion_quote_char
= saved_completion_quote_char
;
992 parser
->completion_quote_end
= saved_completion_quote_end
;
993 parser
->completion_word
= saved_completion_word
;
997 /* Helper functions. */
999 /* Add SAL to SALS. */
1002 add_sal_to_sals_basic (struct symtabs_and_lines
*sals
,
1003 struct symtab_and_line
*sal
)
1006 sals
->sals
= XRESIZEVEC (struct symtab_and_line
, sals
->sals
, sals
->nelts
);
1007 sals
->sals
[sals
->nelts
- 1] = *sal
;
1010 /* Add SAL to SALS, and also update SELF->CANONICAL_NAMES to reflect
1011 the new sal, if needed. If not NULL, SYMNAME is the name of the
1012 symbol to use when constructing the new canonical name.
1014 If LITERAL_CANONICAL is non-zero, SYMNAME will be used as the
1015 canonical name for the SAL. */
1018 add_sal_to_sals (struct linespec_state
*self
,
1019 struct symtabs_and_lines
*sals
,
1020 struct symtab_and_line
*sal
,
1021 const char *symname
, int literal_canonical
)
1023 add_sal_to_sals_basic (sals
, sal
);
1025 if (self
->canonical
)
1027 struct linespec_canonical_name
*canonical
;
1029 self
->canonical_names
= XRESIZEVEC (struct linespec_canonical_name
,
1030 self
->canonical_names
, sals
->nelts
);
1031 canonical
= &self
->canonical_names
[sals
->nelts
- 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
, const char *name
, const domain_enum domain
,
1114 struct program_space
*search_pspace
, bool include_inline
,
1115 gdb::function_view
<symbol_found_callback_ftype
> callback
)
1117 struct objfile
*objfile
;
1118 struct program_space
*pspace
;
1120 /* The routine to be used for comparison. */
1121 symbol_name_cmp_ftype symbol_name_cmp
1122 = (state
->language
->la_get_symbol_name_cmp
!= NULL
1123 ? state
->language
->la_get_symbol_name_cmp (name
)
1126 ALL_PSPACES (pspace
)
1128 if (search_pspace
!= NULL
&& search_pspace
!= pspace
)
1130 if (pspace
->executing_startup
)
1133 set_current_program_space (pspace
);
1135 ALL_OBJFILES (objfile
)
1137 struct compunit_symtab
*cu
;
1140 objfile
->sf
->qf
->expand_symtabs_matching
1143 [&] (const char *symbol_name
)
1145 return symbol_name_cmp (symbol_name
, name
) == 0;
1150 ALL_OBJFILE_COMPUNITS (objfile
, cu
)
1152 struct symtab
*symtab
= COMPUNIT_FILETABS (cu
);
1154 iterate_over_file_blocks (symtab
, name
, domain
, callback
);
1158 struct block
*block
;
1161 for (i
= FIRST_LOCAL_BLOCK
;
1162 i
< BLOCKVECTOR_NBLOCKS (SYMTAB_BLOCKVECTOR (symtab
));
1165 block
= BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab
), i
);
1166 state
->language
->la_iterate_over_symbols
1167 (block
, name
, domain
, [&] (symbol
*sym
)
1169 /* Restrict calls to CALLBACK to symbols
1170 representing inline symbols only. */
1171 if (SYMBOL_INLINED (sym
))
1172 return callback (sym
);
1182 /* Returns the block to be used for symbol searches from
1183 the current location. */
1185 static const struct block
*
1186 get_current_search_block (void)
1188 const struct block
*block
;
1189 enum language save_language
;
1191 /* get_selected_block can change the current language when there is
1192 no selected frame yet. */
1193 save_language
= current_language
->la_language
;
1194 block
= get_selected_block (0);
1195 set_language (save_language
);
1200 /* Iterate over static and global blocks. */
1203 iterate_over_file_blocks
1204 (struct symtab
*symtab
, const char *name
, domain_enum domain
,
1205 gdb::function_view
<symbol_found_callback_ftype
> callback
)
1207 struct block
*block
;
1209 for (block
= BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (symtab
), STATIC_BLOCK
);
1211 block
= BLOCK_SUPERBLOCK (block
))
1212 LA_ITERATE_OVER_SYMBOLS (block
, name
, domain
, callback
);
1215 /* A helper for find_method. This finds all methods in type T which
1216 match NAME. It adds matching symbol names to RESULT_NAMES, and
1217 adds T's direct superclasses to SUPERCLASSES. */
1220 find_methods (struct type
*t
, const char *name
,
1221 VEC (const_char_ptr
) **result_names
,
1222 VEC (typep
) **superclasses
)
1225 const char *class_name
= type_name_no_tag (t
);
1227 /* Ignore this class if it doesn't have a name. This is ugly, but
1228 unless we figure out how to get the physname without the name of
1229 the class, then the loop can't do any good. */
1234 t
= check_typedef (t
);
1236 /* Loop over each method name. At this level, all overloads of a name
1237 are counted as a single name. There is an inner loop which loops over
1240 for (method_counter
= TYPE_NFN_FIELDS (t
) - 1;
1241 method_counter
>= 0;
1244 const char *method_name
= TYPE_FN_FIELDLIST_NAME (t
, method_counter
);
1245 char dem_opname
[64];
1247 if (startswith (method_name
, "__") ||
1248 startswith (method_name
, "op") ||
1249 startswith (method_name
, "type"))
1251 if (cplus_demangle_opname (method_name
, dem_opname
, DMGL_ANSI
))
1252 method_name
= dem_opname
;
1253 else if (cplus_demangle_opname (method_name
, dem_opname
, 0))
1254 method_name
= dem_opname
;
1257 if (strcmp_iw (method_name
, name
) == 0)
1261 for (field_counter
= (TYPE_FN_FIELDLIST_LENGTH (t
, method_counter
)
1267 const char *phys_name
;
1269 f
= TYPE_FN_FIELDLIST1 (t
, method_counter
);
1270 if (TYPE_FN_FIELD_STUB (f
, field_counter
))
1272 phys_name
= TYPE_FN_FIELD_PHYSNAME (f
, field_counter
);
1273 VEC_safe_push (const_char_ptr
, *result_names
, phys_name
);
1279 for (ibase
= 0; ibase
< TYPE_N_BASECLASSES (t
); ibase
++)
1280 VEC_safe_push (typep
, *superclasses
, TYPE_BASECLASS (t
, ibase
));
1283 /* Find an instance of the character C in the string S that is outside
1284 of all parenthesis pairs, single-quoted strings, and double-quoted
1285 strings. Also, ignore the char within a template name, like a ','
1286 within foo<int, int>, while considering C++ operator</operator<<. */
1289 find_toplevel_char (const char *s
, char c
)
1291 int quoted
= 0; /* zero if we're not in quotes;
1292 '"' if we're in a double-quoted string;
1293 '\'' if we're in a single-quoted string. */
1294 int depth
= 0; /* Number of unclosed parens we've seen. */
1297 for (scan
= s
; *scan
; scan
++)
1301 if (*scan
== quoted
)
1303 else if (*scan
== '\\' && *(scan
+ 1))
1306 else if (*scan
== c
&& ! quoted
&& depth
== 0)
1308 else if (*scan
== '"' || *scan
== '\'')
1310 else if (*scan
== '(' || *scan
== '<')
1312 else if ((*scan
== ')' || *scan
== '>') && depth
> 0)
1314 else if (*scan
== 'o' && !quoted
&& depth
== 0)
1316 /* Handle C++ operator names. */
1317 if (strncmp (scan
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0)
1319 scan
+= CP_OPERATOR_LEN
;
1322 while (isspace (*scan
))
1333 /* Skip over one less than the appropriate number of
1334 characters: the for loop will skip over the last
1360 /* The string equivalent of find_toplevel_char. Returns a pointer
1361 to the location of NEEDLE in HAYSTACK, ignoring any occurrences
1362 inside "()" and "<>". Returns NULL if NEEDLE was not found. */
1365 find_toplevel_string (const char *haystack
, const char *needle
)
1367 const char *s
= haystack
;
1371 s
= find_toplevel_char (s
, *needle
);
1375 /* Found first char in HAYSTACK; check rest of string. */
1376 if (startswith (s
, needle
))
1379 /* Didn't find it; loop over HAYSTACK, looking for the next
1380 instance of the first character of NEEDLE. */
1384 while (s
!= NULL
&& *s
!= '\0');
1386 /* NEEDLE was not found in HAYSTACK. */
1390 /* Convert CANONICAL to its string representation using
1391 symtab_to_fullname for SYMTAB. The caller must xfree the result. */
1394 canonical_to_fullform (const struct linespec_canonical_name
*canonical
)
1396 if (canonical
->symtab
== NULL
)
1397 return xstrdup (canonical
->suffix
);
1399 return xstrprintf ("%s:%s", symtab_to_fullname (canonical
->symtab
),
1403 /* Given FILTERS, a list of canonical names, filter the sals in RESULT
1404 and store the result in SELF->CANONICAL. */
1407 filter_results (struct linespec_state
*self
,
1408 struct symtabs_and_lines
*result
,
1409 VEC (const_char_ptr
) *filters
)
1414 for (i
= 0; VEC_iterate (const_char_ptr
, filters
, i
, name
); ++i
)
1416 struct linespec_sals lsal
;
1419 memset (&lsal
, 0, sizeof (lsal
));
1421 for (j
= 0; j
< result
->nelts
; ++j
)
1423 const struct linespec_canonical_name
*canonical
;
1425 struct cleanup
*cleanup
;
1427 canonical
= &self
->canonical_names
[j
];
1428 fullform
= canonical_to_fullform (canonical
);
1429 cleanup
= make_cleanup (xfree
, fullform
);
1431 if (strcmp (name
, fullform
) == 0)
1432 add_sal_to_sals_basic (&lsal
.sals
, &result
->sals
[j
]);
1434 do_cleanups (cleanup
);
1437 if (lsal
.sals
.nelts
> 0)
1439 lsal
.canonical
= xstrdup (name
);
1440 VEC_safe_push (linespec_sals
, self
->canonical
->sals
, &lsal
);
1444 self
->canonical
->pre_expanded
= 0;
1447 /* Store RESULT into SELF->CANONICAL. */
1450 convert_results_to_lsals (struct linespec_state
*self
,
1451 struct symtabs_and_lines
*result
)
1453 struct linespec_sals lsal
;
1455 lsal
.canonical
= NULL
;
1456 lsal
.sals
= *result
;
1457 VEC_safe_push (linespec_sals
, self
->canonical
->sals
, &lsal
);
1460 /* A structure that contains two string representations of a struct
1461 linespec_canonical_name:
1462 - one where the the symtab's fullname is used;
1463 - one where the filename followed the "set filename-display"
1466 struct decode_line_2_item
1468 /* The form using symtab_to_fullname.
1469 It must be xfree'ed after use. */
1472 /* The form using symtab_to_filename_for_display.
1473 It must be xfree'ed after use. */
1476 /* Field is initialized to zero and it is set to one if the user
1477 requested breakpoint for this entry. */
1478 unsigned int selected
: 1;
1481 /* Helper for qsort to sort decode_line_2_item entries by DISPLAYFORM and
1482 secondarily by FULLFORM. */
1485 decode_line_2_compare_items (const void *ap
, const void *bp
)
1487 const struct decode_line_2_item
*a
= (const struct decode_line_2_item
*) ap
;
1488 const struct decode_line_2_item
*b
= (const struct decode_line_2_item
*) bp
;
1491 retval
= strcmp (a
->displayform
, b
->displayform
);
1495 return strcmp (a
->fullform
, b
->fullform
);
1498 /* Handle multiple results in RESULT depending on SELECT_MODE. This
1499 will either return normally, throw an exception on multiple
1500 results, or present a menu to the user. On return, the SALS vector
1501 in SELF->CANONICAL is set up properly. */
1504 decode_line_2 (struct linespec_state
*self
,
1505 struct symtabs_and_lines
*result
,
1506 const char *select_mode
)
1511 struct cleanup
*old_chain
;
1512 VEC (const_char_ptr
) *filters
= NULL
;
1513 struct decode_line_2_item
*items
;
1516 gdb_assert (select_mode
!= multiple_symbols_all
);
1517 gdb_assert (self
->canonical
!= NULL
);
1518 gdb_assert (result
->nelts
>= 1);
1520 old_chain
= make_cleanup (VEC_cleanup (const_char_ptr
), &filters
);
1522 /* Prepare ITEMS array. */
1523 items_count
= result
->nelts
;
1524 items
= XNEWVEC (struct decode_line_2_item
, items_count
);
1525 make_cleanup (xfree
, items
);
1526 for (i
= 0; i
< items_count
; ++i
)
1528 const struct linespec_canonical_name
*canonical
;
1529 struct decode_line_2_item
*item
;
1531 canonical
= &self
->canonical_names
[i
];
1532 gdb_assert (canonical
->suffix
!= NULL
);
1535 item
->fullform
= canonical_to_fullform (canonical
);
1536 make_cleanup (xfree
, item
->fullform
);
1538 if (canonical
->symtab
== NULL
)
1539 item
->displayform
= canonical
->suffix
;
1542 const char *fn_for_display
;
1544 fn_for_display
= symtab_to_filename_for_display (canonical
->symtab
);
1545 item
->displayform
= xstrprintf ("%s:%s", fn_for_display
,
1547 make_cleanup (xfree
, item
->displayform
);
1553 /* Sort the list of method names. */
1554 qsort (items
, items_count
, sizeof (*items
), decode_line_2_compare_items
);
1556 /* Remove entries with the same FULLFORM. */
1557 if (items_count
>= 2)
1559 struct decode_line_2_item
*dst
, *src
;
1562 for (src
= &items
[1]; src
< &items
[items_count
]; src
++)
1563 if (strcmp (src
->fullform
, dst
->fullform
) != 0)
1565 items_count
= dst
+ 1 - items
;
1568 if (select_mode
== multiple_symbols_cancel
&& items_count
> 1)
1569 error (_("canceled because the command is ambiguous\n"
1570 "See set/show multiple-symbol."));
1572 if (select_mode
== multiple_symbols_all
|| items_count
== 1)
1574 do_cleanups (old_chain
);
1575 convert_results_to_lsals (self
, result
);
1579 printf_unfiltered (_("[0] cancel\n[1] all\n"));
1580 for (i
= 0; i
< items_count
; i
++)
1581 printf_unfiltered ("[%d] %s\n", i
+ 2, items
[i
].displayform
);
1583 prompt
= getenv ("PS2");
1588 args
= command_line_input (prompt
, 0, "overload-choice");
1590 if (args
== 0 || *args
== 0)
1591 error_no_arg (_("one or more choice numbers"));
1593 number_or_range_parser
parser (args
);
1594 while (!parser
.finished ())
1596 int num
= parser
.get_number ();
1599 error (_("canceled"));
1602 /* We intentionally make this result in a single breakpoint,
1603 contrary to what older versions of gdb did. The
1604 rationale is that this lets a user get the
1605 multiple_symbols_all behavior even with the 'ask'
1606 setting; and he can get separate breakpoints by entering
1607 "2-57" at the query. */
1608 do_cleanups (old_chain
);
1609 convert_results_to_lsals (self
, result
);
1614 if (num
>= items_count
)
1615 printf_unfiltered (_("No choice number %d.\n"), num
);
1618 struct decode_line_2_item
*item
= &items
[num
];
1620 if (!item
->selected
)
1622 VEC_safe_push (const_char_ptr
, filters
, item
->fullform
);
1627 printf_unfiltered (_("duplicate request for %d ignored.\n"),
1633 filter_results (self
, result
, filters
);
1634 do_cleanups (old_chain
);
1639 /* The parser of linespec itself. */
1641 /* Throw an appropriate error when SYMBOL is not found (optionally in
1644 static void ATTRIBUTE_NORETURN
1645 symbol_not_found_error (const char *symbol
, const char *filename
)
1650 if (!have_full_symbols ()
1651 && !have_partial_symbols ()
1652 && !have_minimal_symbols ())
1653 throw_error (NOT_FOUND_ERROR
,
1654 _("No symbol table is loaded. Use the \"file\" command."));
1656 /* If SYMBOL starts with '$', the user attempted to either lookup
1657 a function/variable in his code starting with '$' or an internal
1658 variable of that name. Since we do not know which, be concise and
1659 explain both possibilities. */
1663 throw_error (NOT_FOUND_ERROR
,
1664 _("Undefined convenience variable or function \"%s\" "
1665 "not defined in \"%s\"."), symbol
, filename
);
1667 throw_error (NOT_FOUND_ERROR
,
1668 _("Undefined convenience variable or function \"%s\" "
1669 "not defined."), symbol
);
1674 throw_error (NOT_FOUND_ERROR
,
1675 _("Function \"%s\" not defined in \"%s\"."),
1678 throw_error (NOT_FOUND_ERROR
,
1679 _("Function \"%s\" not defined."), symbol
);
1683 /* Throw an appropriate error when an unexpected token is encountered
1686 static void ATTRIBUTE_NORETURN
1687 unexpected_linespec_error (linespec_parser
*parser
)
1689 linespec_token token
;
1690 static const char * token_type_strings
[]
1691 = {"keyword", "colon", "string", "number", "comma", "end of input"};
1693 /* Get the token that generated the error. */
1694 token
= linespec_lexer_lex_one (parser
);
1696 /* Finally, throw the error. */
1697 if (token
.type
== LSTOKEN_STRING
|| token
.type
== LSTOKEN_NUMBER
1698 || token
.type
== LSTOKEN_KEYWORD
)
1702 string
= copy_token_string (token
);
1703 make_cleanup (xfree
, string
);
1704 throw_error (GENERIC_ERROR
,
1705 _("malformed linespec error: unexpected %s, \"%s\""),
1706 token_type_strings
[token
.type
], string
);
1709 throw_error (GENERIC_ERROR
,
1710 _("malformed linespec error: unexpected %s"),
1711 token_type_strings
[token
.type
]);
1714 /* Throw an undefined label error. */
1716 static void ATTRIBUTE_NORETURN
1717 undefined_label_error (const char *function
, const char *label
)
1719 if (function
!= NULL
)
1720 throw_error (NOT_FOUND_ERROR
,
1721 _("No label \"%s\" defined in function \"%s\"."),
1724 throw_error (NOT_FOUND_ERROR
,
1725 _("No label \"%s\" defined in current function."),
1729 /* Throw a source file not found error. */
1731 static void ATTRIBUTE_NORETURN
1732 source_file_not_found_error (const char *name
)
1734 throw_error (NOT_FOUND_ERROR
, _("No source file named %s."), name
);
1737 /* Unless at EIO, save the current stream position as completion word
1738 point, and consume the next token. */
1740 static linespec_token
1741 save_stream_and_consume_token (linespec_parser
*parser
)
1743 if (linespec_lexer_peek_token (parser
).type
!= LSTOKEN_EOI
)
1744 parser
->completion_word
= PARSER_STREAM (parser
);
1745 return linespec_lexer_consume_token (parser
);
1748 /* See description in linespec.h. */
1751 linespec_parse_line_offset (const char *string
)
1753 const char *start
= string
;
1754 struct line_offset line_offset
= {0, LINE_OFFSET_NONE
};
1758 line_offset
.sign
= LINE_OFFSET_PLUS
;
1761 else if (*string
== '-')
1763 line_offset
.sign
= LINE_OFFSET_MINUS
;
1767 if (*string
!= '\0' && !isdigit (*string
))
1768 error (_("malformed line offset: \"%s\""), start
);
1770 /* Right now, we only allow base 10 for offsets. */
1771 line_offset
.offset
= atoi (string
);
1775 /* In completion mode, if the user is still typing the number, there's
1776 no possible completion to offer. But if there's already input past
1777 the number, setup to expect NEXT. */
1780 set_completion_after_number (linespec_parser
*parser
,
1781 linespec_complete_what next
)
1783 if (*PARSER_STREAM (parser
) == ' ')
1785 parser
->completion_word
= skip_spaces_const (PARSER_STREAM (parser
) + 1);
1786 parser
->complete_what
= next
;
1790 parser
->completion_word
= PARSER_STREAM (parser
);
1791 parser
->complete_what
= linespec_complete_what::NOTHING
;
1795 /* Parse the basic_spec in PARSER's input. */
1798 linespec_parse_basic (linespec_parser
*parser
)
1801 linespec_token token
;
1802 VEC (symbolp
) *symbols
, *labels
;
1803 VEC (bound_minimal_symbol_d
) *minimal_symbols
;
1804 struct cleanup
*cleanup
;
1806 /* Get the next token. */
1807 token
= linespec_lexer_lex_one (parser
);
1809 /* If it is EOI or KEYWORD, issue an error. */
1810 if (token
.type
== LSTOKEN_KEYWORD
)
1812 parser
->complete_what
= linespec_complete_what::NOTHING
;
1813 unexpected_linespec_error (parser
);
1815 else if (token
.type
== LSTOKEN_EOI
)
1817 unexpected_linespec_error (parser
);
1819 /* If it is a LSTOKEN_NUMBER, we have an offset. */
1820 else if (token
.type
== LSTOKEN_NUMBER
)
1822 set_completion_after_number (parser
, linespec_complete_what::KEYWORD
);
1824 /* Record the line offset and get the next token. */
1825 name
= copy_token_string (token
);
1826 cleanup
= make_cleanup (xfree
, name
);
1827 PARSER_EXPLICIT (parser
)->line_offset
= linespec_parse_line_offset (name
);
1828 do_cleanups (cleanup
);
1830 /* Get the next token. */
1831 token
= linespec_lexer_consume_token (parser
);
1833 /* If the next token is a comma, stop parsing and return. */
1834 if (token
.type
== LSTOKEN_COMMA
)
1836 parser
->complete_what
= linespec_complete_what::NOTHING
;
1840 /* If the next token is anything but EOI or KEYWORD, issue
1842 if (token
.type
!= LSTOKEN_KEYWORD
&& token
.type
!= LSTOKEN_EOI
)
1843 unexpected_linespec_error (parser
);
1846 if (token
.type
== LSTOKEN_KEYWORD
|| token
.type
== LSTOKEN_EOI
)
1849 /* Next token must be LSTOKEN_STRING. */
1850 if (token
.type
!= LSTOKEN_STRING
)
1852 parser
->complete_what
= linespec_complete_what::NOTHING
;
1853 unexpected_linespec_error (parser
);
1856 /* The current token will contain the name of a function, method,
1858 name
= copy_token_string (token
);
1859 cleanup
= make_cleanup (free_current_contents
, &name
);
1861 if (parser
->completion_tracker
!= NULL
)
1863 /* If the function name ends with a ":", then this may be an
1864 incomplete "::" scope operator instead of a label separator.
1867 which should expand to:
1870 Do a tentative completion assuming the later. If we find
1871 completions, advance the stream past the colon token and make
1872 it part of the function name/token. */
1874 if (!parser
->completion_quote_char
1875 && strcmp (PARSER_STREAM (parser
), ":") == 0)
1877 completion_tracker tmp_tracker
;
1878 const char *source_filename
1879 = PARSER_EXPLICIT (parser
)->source_filename
;
1881 linespec_complete_function (tmp_tracker
,
1882 parser
->completion_word
,
1885 if (tmp_tracker
.have_completions ())
1887 PARSER_STREAM (parser
)++;
1888 LS_TOKEN_STOKEN (token
).length
++;
1891 name
= savestring (parser
->completion_word
,
1892 (PARSER_STREAM (parser
)
1893 - parser
->completion_word
));
1897 PARSER_EXPLICIT (parser
)->function_name
= name
;
1898 discard_cleanups (cleanup
);
1902 /* XXX Reindent before pushing. */
1904 /* Try looking it up as a function/method. */
1905 find_linespec_symbols (PARSER_STATE (parser
),
1906 PARSER_RESULT (parser
)->file_symtabs
, name
,
1907 &symbols
, &minimal_symbols
);
1909 if (symbols
!= NULL
|| minimal_symbols
!= NULL
)
1911 PARSER_RESULT (parser
)->function_symbols
= symbols
;
1912 PARSER_RESULT (parser
)->minimal_symbols
= minimal_symbols
;
1913 PARSER_EXPLICIT (parser
)->function_name
= name
;
1915 discard_cleanups (cleanup
);
1919 /* NAME was not a function or a method. So it must be a label
1920 name or user specified variable like "break foo.c:$zippo". */
1921 labels
= find_label_symbols (PARSER_STATE (parser
), NULL
,
1925 PARSER_RESULT (parser
)->labels
.label_symbols
= labels
;
1926 PARSER_RESULT (parser
)->labels
.function_symbols
= symbols
;
1927 PARSER_EXPLICIT (parser
)->label_name
= name
;
1929 discard_cleanups (cleanup
);
1931 else if (token
.type
== LSTOKEN_STRING
1932 && *LS_TOKEN_STOKEN (token
).ptr
== '$')
1934 /* User specified a convenience variable or history value. */
1935 PARSER_EXPLICIT (parser
)->line_offset
1936 = linespec_parse_variable (PARSER_STATE (parser
), name
);
1938 if (PARSER_EXPLICIT (parser
)->line_offset
.sign
== LINE_OFFSET_UNKNOWN
)
1940 /* The user-specified variable was not valid. Do not
1941 throw an error here. parse_linespec will do it for us. */
1942 PARSER_EXPLICIT (parser
)->function_name
= name
;
1943 discard_cleanups (cleanup
);
1947 /* The convenience variable/history value parsed correctly.
1948 NAME is no longer needed. */
1949 do_cleanups (cleanup
);
1953 /* The name is also not a label. Abort parsing. Do not throw
1954 an error here. parse_linespec will do it for us. */
1956 /* Save a copy of the name we were trying to lookup. */
1957 PARSER_EXPLICIT (parser
)->function_name
= name
;
1958 discard_cleanups (cleanup
);
1964 int previous_qc
= parser
->completion_quote_char
;
1966 /* Get the next token. */
1967 token
= linespec_lexer_consume_token (parser
);
1969 if (token
.type
== LSTOKEN_EOI
)
1971 if (previous_qc
&& !parser
->completion_quote_char
)
1972 parser
->complete_what
= linespec_complete_what::KEYWORD
;
1974 else if (token
.type
== LSTOKEN_COLON
)
1976 /* User specified a label or a lineno. */
1977 token
= linespec_lexer_consume_token (parser
);
1979 if (token
.type
== LSTOKEN_NUMBER
)
1981 /* User specified an offset. Record the line offset and
1982 get the next token. */
1983 set_completion_after_number (parser
, linespec_complete_what::KEYWORD
);
1985 name
= copy_token_string (token
);
1986 cleanup
= make_cleanup (xfree
, name
);
1987 PARSER_EXPLICIT (parser
)->line_offset
1988 = linespec_parse_line_offset (name
);
1989 do_cleanups (cleanup
);
1991 /* Get the next token. */
1992 token
= linespec_lexer_consume_token (parser
);
1994 else if (token
.type
== LSTOKEN_EOI
&& parser
->completion_tracker
!= NULL
)
1996 parser
->complete_what
= linespec_complete_what::LABEL
;
1998 else if (token
.type
== LSTOKEN_STRING
)
2000 parser
->complete_what
= linespec_complete_what::LABEL
;
2002 /* If we have text after the label separated by whitespace
2003 (e.g., "b func():lab i<tab>"), don't consider it part of
2004 the label. In completion mode that should complete to
2005 "if", in normal mode, the 'i' should be treated as
2007 if (parser
->completion_quote_char
== '\0')
2009 const char *ptr
= LS_TOKEN_STOKEN (token
).ptr
;
2010 for (size_t i
= 0; i
< LS_TOKEN_STOKEN (token
).length
; i
++)
2014 LS_TOKEN_STOKEN (token
).length
= i
;
2015 PARSER_STREAM (parser
) = skip_spaces_const (ptr
+ i
+ 1);
2021 if (parser
->completion_tracker
!= NULL
)
2023 if (PARSER_STREAM (parser
)[-1] == ' ')
2025 parser
->completion_word
= PARSER_STREAM (parser
);
2026 parser
->complete_what
= linespec_complete_what::KEYWORD
;
2031 /* XXX Reindent before pushing. */
2033 /* Grab a copy of the label's name and look it up. */
2034 name
= copy_token_string (token
);
2035 cleanup
= make_cleanup (xfree
, name
);
2036 labels
= find_label_symbols (PARSER_STATE (parser
),
2037 PARSER_RESULT (parser
)->function_symbols
,
2042 PARSER_RESULT (parser
)->labels
.label_symbols
= labels
;
2043 PARSER_RESULT (parser
)->labels
.function_symbols
= symbols
;
2044 PARSER_EXPLICIT (parser
)->label_name
= name
;
2046 discard_cleanups (cleanup
);
2050 /* We don't know what it was, but it isn't a label. */
2051 undefined_label_error (PARSER_EXPLICIT (parser
)->function_name
,
2057 /* Check for a line offset. */
2058 token
= save_stream_and_consume_token (parser
);
2059 if (token
.type
== LSTOKEN_COLON
)
2061 /* Get the next token. */
2062 token
= linespec_lexer_consume_token (parser
);
2064 /* It must be a line offset. */
2065 if (token
.type
!= LSTOKEN_NUMBER
)
2066 unexpected_linespec_error (parser
);
2068 /* Record the line offset and get the next token. */
2069 name
= copy_token_string (token
);
2070 cleanup
= make_cleanup (xfree
, name
);
2072 PARSER_EXPLICIT (parser
)->line_offset
2073 = linespec_parse_line_offset (name
);
2074 do_cleanups (cleanup
);
2076 /* Get the next token. */
2077 token
= linespec_lexer_consume_token (parser
);
2082 /* Trailing ':' in the input. Issue an error. */
2083 unexpected_linespec_error (parser
);
2088 /* Canonicalize the linespec contained in LS. The result is saved into
2089 STATE->canonical. This function handles both linespec and explicit
2093 canonicalize_linespec (struct linespec_state
*state
, const linespec_p ls
)
2095 struct event_location
*canon
;
2096 struct explicit_location
*explicit_loc
;
2098 /* If canonicalization was not requested, no need to do anything. */
2099 if (!state
->canonical
)
2102 /* Save everything as an explicit location. */
2103 state
->canonical
->location
2104 = new_explicit_location (&ls
->explicit_loc
);
2105 canon
= state
->canonical
->location
.get ();
2106 explicit_loc
= get_explicit_location (canon
);
2108 if (explicit_loc
->label_name
!= NULL
)
2110 state
->canonical
->special_display
= 1;
2112 if (explicit_loc
->function_name
== NULL
)
2116 /* No function was specified, so add the symbol name. */
2117 gdb_assert (ls
->labels
.function_symbols
!= NULL
2118 && (VEC_length (symbolp
, ls
->labels
.function_symbols
)
2120 s
= VEC_index (symbolp
, ls
->labels
.function_symbols
, 0);
2121 explicit_loc
->function_name
= xstrdup (SYMBOL_NATURAL_NAME (s
));
2125 /* If this location originally came from a linespec, save a string
2126 representation of it for display and saving to file. */
2127 if (state
->is_linespec
)
2129 char *linespec
= explicit_location_to_linespec (explicit_loc
);
2131 set_event_location_string (canon
, linespec
);
2136 /* Given a line offset in LS, construct the relevant SALs. */
2138 static struct symtabs_and_lines
2139 create_sals_line_offset (struct linespec_state
*self
,
2142 struct symtabs_and_lines values
;
2143 struct symtab_and_line val
;
2144 int use_default
= 0;
2150 /* This is where we need to make sure we have good defaults.
2151 We must guarantee that this section of code is never executed
2152 when we are called with just a function name, since
2153 set_default_source_symtab_and_line uses
2154 select_source_symtab that calls us with such an argument. */
2156 if (VEC_length (symtab_ptr
, ls
->file_symtabs
) == 1
2157 && VEC_index (symtab_ptr
, ls
->file_symtabs
, 0) == NULL
)
2159 const char *fullname
;
2161 set_current_program_space (self
->program_space
);
2163 /* Make sure we have at least a default source line. */
2164 set_default_source_symtab_and_line ();
2165 initialize_defaults (&self
->default_symtab
, &self
->default_line
);
2166 fullname
= symtab_to_fullname (self
->default_symtab
);
2167 VEC_pop (symtab_ptr
, ls
->file_symtabs
);
2168 VEC_free (symtab_ptr
, ls
->file_symtabs
);
2169 ls
->file_symtabs
= collect_symtabs_from_filename (fullname
,
2170 self
->search_pspace
);
2174 val
.line
= ls
->explicit_loc
.line_offset
.offset
;
2175 switch (ls
->explicit_loc
.line_offset
.sign
)
2177 case LINE_OFFSET_PLUS
:
2178 if (ls
->explicit_loc
.line_offset
.offset
== 0)
2181 val
.line
= self
->default_line
+ val
.line
;
2184 case LINE_OFFSET_MINUS
:
2185 if (ls
->explicit_loc
.line_offset
.offset
== 0)
2188 val
.line
= self
->default_line
- val
.line
;
2190 val
.line
= -val
.line
;
2193 case LINE_OFFSET_NONE
:
2194 break; /* No need to adjust val.line. */
2197 if (self
->list_mode
)
2198 decode_digits_list_mode (self
, ls
, &values
, val
);
2201 struct linetable_entry
*best_entry
= NULL
;
2203 const struct block
**blocks
;
2204 struct cleanup
*cleanup
;
2205 struct symtabs_and_lines intermediate_results
;
2208 intermediate_results
.sals
= NULL
;
2209 intermediate_results
.nelts
= 0;
2211 decode_digits_ordinary (self
, ls
, val
.line
, &intermediate_results
,
2213 if (intermediate_results
.nelts
== 0 && best_entry
!= NULL
)
2214 decode_digits_ordinary (self
, ls
, best_entry
->line
,
2215 &intermediate_results
, &best_entry
);
2217 cleanup
= make_cleanup (xfree
, intermediate_results
.sals
);
2219 /* For optimized code, the compiler can scatter one source line
2220 across disjoint ranges of PC values, even when no duplicate
2221 functions or inline functions are involved. For example,
2222 'for (;;)' inside a non-template, non-inline, and non-ctor-or-dtor
2223 function can result in two PC ranges. In this case, we don't
2224 want to set a breakpoint on the first PC of each range. To filter
2225 such cases, we use containing blocks -- for each PC found
2226 above, we see if there are other PCs that are in the same
2227 block. If yes, the other PCs are filtered out. */
2229 filter
= XNEWVEC (int, intermediate_results
.nelts
);
2230 make_cleanup (xfree
, filter
);
2231 blocks
= XNEWVEC (const struct block
*, intermediate_results
.nelts
);
2232 make_cleanup (xfree
, blocks
);
2234 for (i
= 0; i
< intermediate_results
.nelts
; ++i
)
2236 set_current_program_space (intermediate_results
.sals
[i
].pspace
);
2239 blocks
[i
] = block_for_pc_sect (intermediate_results
.sals
[i
].pc
,
2240 intermediate_results
.sals
[i
].section
);
2243 for (i
= 0; i
< intermediate_results
.nelts
; ++i
)
2245 if (blocks
[i
] != NULL
)
2246 for (j
= i
+ 1; j
< intermediate_results
.nelts
; ++j
)
2248 if (blocks
[j
] == blocks
[i
])
2256 for (i
= 0; i
< intermediate_results
.nelts
; ++i
)
2259 struct symbol
*sym
= (blocks
[i
]
2260 ? block_containing_function (blocks
[i
])
2263 if (self
->funfirstline
)
2264 skip_prologue_sal (&intermediate_results
.sals
[i
]);
2265 /* Make sure the line matches the request, not what was
2267 intermediate_results
.sals
[i
].line
= val
.line
;
2268 add_sal_to_sals (self
, &values
, &intermediate_results
.sals
[i
],
2269 sym
? SYMBOL_NATURAL_NAME (sym
) : NULL
, 0);
2272 do_cleanups (cleanup
);
2275 if (values
.nelts
== 0)
2277 if (ls
->explicit_loc
.source_filename
)
2278 throw_error (NOT_FOUND_ERROR
, _("No line %d in file \"%s\"."),
2279 val
.line
, ls
->explicit_loc
.source_filename
);
2281 throw_error (NOT_FOUND_ERROR
, _("No line %d in the current file."),
2288 /* Convert the given ADDRESS into SaLs. */
2290 static struct symtabs_and_lines
2291 convert_address_location_to_sals (struct linespec_state
*self
,
2294 struct symtab_and_line sal
;
2295 struct symtabs_and_lines sals
= {NULL
, 0};
2297 sal
= find_pc_line (address
, 0);
2299 sal
.section
= find_pc_overlay (address
);
2300 sal
.explicit_pc
= 1;
2301 add_sal_to_sals (self
, &sals
, &sal
, core_addr_to_string (address
), 1);
2306 /* Create and return SALs from the linespec LS. */
2308 static struct symtabs_and_lines
2309 convert_linespec_to_sals (struct linespec_state
*state
, linespec_p ls
)
2311 struct symtabs_and_lines sals
= {NULL
, 0};
2313 if (ls
->labels
.label_symbols
!= NULL
)
2315 /* We have just a bunch of functions/methods or labels. */
2317 struct symtab_and_line sal
;
2320 for (i
= 0; VEC_iterate (symbolp
, ls
->labels
.label_symbols
, i
, sym
); ++i
)
2322 struct program_space
*pspace
= SYMTAB_PSPACE (symbol_symtab (sym
));
2324 if (symbol_to_sal (&sal
, state
->funfirstline
, sym
)
2325 && maybe_add_address (state
->addr_set
, pspace
, sal
.pc
))
2326 add_sal_to_sals (state
, &sals
, &sal
,
2327 SYMBOL_NATURAL_NAME (sym
), 0);
2330 else if (ls
->function_symbols
!= NULL
|| ls
->minimal_symbols
!= NULL
)
2332 /* We have just a bunch of functions and/or methods. */
2334 struct symtab_and_line sal
;
2336 bound_minimal_symbol_d
*elem
;
2337 struct program_space
*pspace
;
2339 if (ls
->function_symbols
!= NULL
)
2341 /* Sort symbols so that symbols with the same program space are next
2343 qsort (VEC_address (symbolp
, ls
->function_symbols
),
2344 VEC_length (symbolp
, ls
->function_symbols
),
2345 sizeof (symbolp
), compare_symbols
);
2347 for (i
= 0; VEC_iterate (symbolp
, ls
->function_symbols
, i
, sym
); ++i
)
2349 pspace
= SYMTAB_PSPACE (symbol_symtab (sym
));
2350 set_current_program_space (pspace
);
2351 if (symbol_to_sal (&sal
, state
->funfirstline
, sym
)
2352 && maybe_add_address (state
->addr_set
, pspace
, sal
.pc
))
2353 add_sal_to_sals (state
, &sals
, &sal
,
2354 SYMBOL_NATURAL_NAME (sym
), 0);
2358 if (ls
->minimal_symbols
!= NULL
)
2360 /* Sort minimal symbols by program space, too. */
2361 qsort (VEC_address (bound_minimal_symbol_d
, ls
->minimal_symbols
),
2362 VEC_length (bound_minimal_symbol_d
, ls
->minimal_symbols
),
2363 sizeof (bound_minimal_symbol_d
), compare_msymbols
);
2366 VEC_iterate (bound_minimal_symbol_d
, ls
->minimal_symbols
,
2370 pspace
= elem
->objfile
->pspace
;
2371 set_current_program_space (pspace
);
2372 minsym_found (state
, elem
->objfile
, elem
->minsym
, &sals
);
2376 else if (ls
->explicit_loc
.line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2378 /* Only an offset was specified. */
2379 sals
= create_sals_line_offset (state
, ls
);
2381 /* Make sure we have a filename for canonicalization. */
2382 if (ls
->explicit_loc
.source_filename
== NULL
)
2384 const char *fullname
= symtab_to_fullname (state
->default_symtab
);
2386 /* It may be more appropriate to keep DEFAULT_SYMTAB in its symtab
2387 form so that displaying SOURCE_FILENAME can follow the current
2388 FILENAME_DISPLAY_STRING setting. But as it is used only rarely
2389 it has been kept for code simplicity only in absolute form. */
2390 ls
->explicit_loc
.source_filename
= xstrdup (fullname
);
2395 /* We haven't found any results... */
2399 canonicalize_linespec (state
, ls
);
2401 if (sals
.nelts
> 0 && state
->canonical
!= NULL
)
2402 state
->canonical
->pre_expanded
= 1;
2407 /* Build RESULT from the explicit location components SOURCE_FILENAME,
2408 FUNCTION_NAME, LABEL_NAME and LINE_OFFSET. */
2411 convert_explicit_location_to_linespec (struct linespec_state
*self
,
2413 const char *source_filename
,
2414 const char *function_name
,
2415 const char *label_name
,
2416 struct line_offset line_offset
)
2418 VEC (symbolp
) *symbols
, *labels
;
2419 VEC (bound_minimal_symbol_d
) *minimal_symbols
;
2421 if (source_filename
!= NULL
)
2425 result
->file_symtabs
2426 = symtabs_from_filename (source_filename
, self
->search_pspace
);
2428 CATCH (except
, RETURN_MASK_ERROR
)
2430 source_file_not_found_error (source_filename
);
2433 result
->explicit_loc
.source_filename
= xstrdup (source_filename
);
2437 /* A NULL entry means to use the default symtab. */
2438 VEC_safe_push (symtab_ptr
, result
->file_symtabs
, NULL
);
2441 if (function_name
!= NULL
)
2443 find_linespec_symbols (self
, result
->file_symtabs
,
2444 function_name
, &symbols
,
2447 if (symbols
== NULL
&& minimal_symbols
== NULL
)
2448 symbol_not_found_error (function_name
,
2449 result
->explicit_loc
.source_filename
);
2451 result
->explicit_loc
.function_name
= xstrdup (function_name
);
2452 result
->function_symbols
= symbols
;
2453 result
->minimal_symbols
= minimal_symbols
;
2456 if (label_name
!= NULL
)
2459 labels
= find_label_symbols (self
, result
->function_symbols
,
2460 &symbols
, label_name
);
2463 undefined_label_error (result
->explicit_loc
.function_name
,
2466 result
->explicit_loc
.label_name
= xstrdup (label_name
);
2467 result
->labels
.label_symbols
= labels
;
2468 result
->labels
.function_symbols
= symbols
;
2471 if (line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2472 result
->explicit_loc
.line_offset
= line_offset
;
2475 /* Convert the explicit location EXPLICIT_LOC into SaLs. */
2477 static struct symtabs_and_lines
2478 convert_explicit_location_to_sals (struct linespec_state
*self
,
2480 const struct explicit_location
*explicit_loc
)
2482 convert_explicit_location_to_linespec (self
, result
,
2483 explicit_loc
->source_filename
,
2484 explicit_loc
->function_name
,
2485 explicit_loc
->label_name
,
2486 explicit_loc
->line_offset
);
2487 return convert_linespec_to_sals (self
, result
);
2490 /* Parse a string that specifies a linespec.
2492 The basic grammar of linespecs:
2494 linespec -> var_spec | basic_spec
2495 var_spec -> '$' (STRING | NUMBER)
2497 basic_spec -> file_offset_spec | function_spec | label_spec
2498 file_offset_spec -> opt_file_spec offset_spec
2499 function_spec -> opt_file_spec function_name_spec opt_label_spec
2500 label_spec -> label_name_spec
2502 opt_file_spec -> "" | file_name_spec ':'
2503 opt_label_spec -> "" | ':' label_name_spec
2505 file_name_spec -> STRING
2506 function_name_spec -> STRING
2507 label_name_spec -> STRING
2508 function_name_spec -> STRING
2509 offset_spec -> NUMBER
2513 This may all be followed by several keywords such as "if EXPR",
2516 A comma will terminate parsing.
2518 The function may be an undebuggable function found in minimal symbol table.
2520 If the argument FUNFIRSTLINE is nonzero, we want the first line
2521 of real code inside a function when a function is specified, and it is
2522 not OK to specify a variable or type to get its line number.
2524 DEFAULT_SYMTAB specifies the file to use if none is specified.
2525 It defaults to current_source_symtab.
2526 DEFAULT_LINE specifies the line number to use for relative
2527 line numbers (that start with signs). Defaults to current_source_line.
2528 If CANONICAL is non-NULL, store an array of strings containing the canonical
2529 line specs there if necessary. Currently overloaded member functions and
2530 line numbers or static functions without a filename yield a canonical
2531 line spec. The array and the line spec strings are allocated on the heap,
2532 it is the callers responsibility to free them.
2534 Note that it is possible to return zero for the symtab
2535 if no file is validly specified. Callers must check that.
2536 Also, the line number returned may be invalid. */
2538 /* Parse the linespec in ARG. */
2540 static struct symtabs_and_lines
2541 parse_linespec (linespec_parser
*parser
, const char *arg
)
2543 linespec_token token
;
2544 struct symtabs_and_lines values
;
2545 struct gdb_exception file_exception
= exception_none
;
2546 struct cleanup
*cleanup
;
2551 /* A special case to start. It has become quite popular for
2552 IDEs to work around bugs in the previous parser by quoting
2553 the entire linespec, so we attempt to deal with this nicely. */
2554 parser
->is_quote_enclosed
= 0;
2555 if (parser
->completion_tracker
== NULL
2556 && !is_ada_operator (arg
)
2557 && strchr (linespec_quote_characters
, *arg
) != NULL
)
2561 end
= skip_quote_char (arg
+ 1, *arg
);
2562 if (end
!= NULL
&& is_closing_quote_enclosed (end
))
2564 /* Here's the special case. Skip ARG past the initial
2567 parser
->is_quote_enclosed
= 1;
2571 parser
->lexer
.saved_arg
= arg
;
2572 parser
->lexer
.stream
= arg
;
2573 parser
->completion_word
= arg
;
2574 parser
->complete_what
= linespec_complete_what::FUNCTION
;
2576 /* Initialize the default symtab and line offset. */
2577 initialize_defaults (&PARSER_STATE (parser
)->default_symtab
,
2578 &PARSER_STATE (parser
)->default_line
);
2580 /* Objective-C shortcut. */
2581 if (parser
->completion_tracker
== NULL
)
2583 values
= decode_objc (PARSER_STATE (parser
), PARSER_RESULT (parser
), arg
);
2584 if (values
.sals
!= NULL
)
2589 /* "-"/"+" is either an objc selector, or a number. There's
2590 nothing to complete the latter to, so just let the caller
2591 complete on functions, which finds objc selectors, if there's
2593 if ((arg
[0] == '-' || arg
[0] == '+') && arg
[1] == '\0')
2597 /* Start parsing. */
2599 /* Get the first token. */
2600 token
= linespec_lexer_consume_token (parser
);
2602 /* It must be either LSTOKEN_STRING or LSTOKEN_NUMBER. */
2603 if (token
.type
== LSTOKEN_STRING
&& *LS_TOKEN_STOKEN (token
).ptr
== '$')
2607 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2608 if (parser
->completion_tracker
== NULL
)
2609 VEC_safe_push (symtab_ptr
, PARSER_RESULT (parser
)->file_symtabs
, NULL
);
2611 /* User specified a convenience variable or history value. */
2612 var
= copy_token_string (token
);
2613 cleanup
= make_cleanup (xfree
, var
);
2614 PARSER_EXPLICIT (parser
)->line_offset
2615 = linespec_parse_variable (PARSER_STATE (parser
), var
);
2616 do_cleanups (cleanup
);
2618 /* If a line_offset wasn't found (VAR is the name of a user
2619 variable/function), then skip to normal symbol processing. */
2620 if (PARSER_EXPLICIT (parser
)->line_offset
.sign
!= LINE_OFFSET_UNKNOWN
)
2622 /* Consume this token. */
2623 linespec_lexer_consume_token (parser
);
2625 goto convert_to_sals
;
2628 else if (token
.type
== LSTOKEN_EOI
&& parser
->completion_tracker
!= NULL
)
2630 /* Let the default linespec_complete_what::FUNCTION kick in. */
2631 unexpected_linespec_error (parser
);
2633 else if (token
.type
!= LSTOKEN_STRING
&& token
.type
!= LSTOKEN_NUMBER
)
2635 parser
->complete_what
= linespec_complete_what::NOTHING
;
2636 unexpected_linespec_error (parser
);
2639 /* Shortcut: If the next token is not LSTOKEN_COLON, we know that
2640 this token cannot represent a filename. */
2641 token
= linespec_lexer_peek_token (parser
);
2643 if (token
.type
== LSTOKEN_COLON
)
2645 char *user_filename
;
2647 /* Get the current token again and extract the filename. */
2648 token
= linespec_lexer_lex_one (parser
);
2649 user_filename
= copy_token_string (token
);
2651 /* Check if the input is a filename. */
2654 PARSER_RESULT (parser
)->file_symtabs
2655 = symtabs_from_filename (user_filename
,
2656 PARSER_STATE (parser
)->search_pspace
);
2658 CATCH (ex
, RETURN_MASK_ERROR
)
2660 file_exception
= ex
;
2664 if (file_exception
.reason
>= 0)
2666 /* Symtabs were found for the file. Record the filename. */
2667 PARSER_EXPLICIT (parser
)->source_filename
= user_filename
;
2669 /* Get the next token. */
2670 token
= linespec_lexer_consume_token (parser
);
2672 /* This is LSTOKEN_COLON; consume it. */
2673 linespec_lexer_consume_token (parser
);
2677 /* No symtabs found -- discard user_filename. */
2678 xfree (user_filename
);
2680 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2681 VEC_safe_push (symtab_ptr
, PARSER_RESULT (parser
)->file_symtabs
, NULL
);
2684 /* If the next token is not EOI, KEYWORD, or COMMA, issue an error. */
2685 else if (parser
->completion_tracker
== NULL
2686 && (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
2687 && token
.type
!= LSTOKEN_COMMA
))
2689 /* TOKEN is the _next_ token, not the one currently in the parser.
2690 Consuming the token will give the correct error message. */
2691 linespec_lexer_consume_token (parser
);
2692 unexpected_linespec_error (parser
);
2696 /* A NULL entry means to use GLOBAL_DEFAULT_SYMTAB. */
2697 VEC_safe_push (symtab_ptr
, PARSER_RESULT (parser
)->file_symtabs
, NULL
);
2700 /* Parse the rest of the linespec. */
2701 linespec_parse_basic (parser
);
2703 if (parser
->completion_tracker
== NULL
2704 && PARSER_RESULT (parser
)->function_symbols
== NULL
2705 && PARSER_RESULT (parser
)->labels
.label_symbols
== NULL
2706 && PARSER_EXPLICIT (parser
)->line_offset
.sign
== LINE_OFFSET_UNKNOWN
2707 && PARSER_RESULT (parser
)->minimal_symbols
== NULL
)
2709 /* The linespec didn't parse. Re-throw the file exception if
2711 if (file_exception
.reason
< 0)
2712 throw_exception (file_exception
);
2714 /* Otherwise, the symbol is not found. */
2715 symbol_not_found_error (PARSER_EXPLICIT (parser
)->function_name
,
2716 PARSER_EXPLICIT (parser
)->source_filename
);
2721 /* Get the last token and record how much of the input was parsed,
2723 token
= linespec_lexer_lex_one (parser
);
2724 if (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
)
2725 unexpected_linespec_error (parser
);
2726 else if (token
.type
== LSTOKEN_KEYWORD
)
2728 /* Setup the completion word past the keyword. Lexing never
2729 advances past a keyword automatically, so skip it
2731 parser
->completion_word
2732 = skip_spaces_const (skip_to_space_const (PARSER_STREAM (parser
)));
2733 parser
->complete_what
= linespec_complete_what::EXPRESSION
;
2736 /* Convert the data in PARSER_RESULT to SALs. */
2737 if (parser
->completion_tracker
== NULL
)
2738 values
= convert_linespec_to_sals (PARSER_STATE (parser
),
2739 PARSER_RESULT (parser
));
2745 /* A constructor for linespec_state. */
2748 linespec_state_constructor (struct linespec_state
*self
,
2749 int flags
, const struct language_defn
*language
,
2750 struct program_space
*search_pspace
,
2751 struct symtab
*default_symtab
,
2753 struct linespec_result
*canonical
)
2755 memset (self
, 0, sizeof (*self
));
2756 self
->language
= language
;
2757 self
->funfirstline
= (flags
& DECODE_LINE_FUNFIRSTLINE
) ? 1 : 0;
2758 self
->list_mode
= (flags
& DECODE_LINE_LIST_MODE
) ? 1 : 0;
2759 self
->search_pspace
= search_pspace
;
2760 self
->default_symtab
= default_symtab
;
2761 self
->default_line
= default_line
;
2762 self
->canonical
= canonical
;
2763 self
->program_space
= current_program_space
;
2764 self
->addr_set
= htab_create_alloc (10, hash_address_entry
, eq_address_entry
,
2765 xfree
, xcalloc
, xfree
);
2766 self
->is_linespec
= 0;
2769 /* Initialize a new linespec parser. */
2772 linespec_parser_new (linespec_parser
*parser
,
2773 int flags
, const struct language_defn
*language
,
2774 struct program_space
*search_pspace
,
2775 struct symtab
*default_symtab
,
2777 struct linespec_result
*canonical
)
2779 memset (parser
, 0, sizeof (linespec_parser
));
2780 parser
->lexer
.current
.type
= LSTOKEN_CONSUMED
;
2781 memset (PARSER_RESULT (parser
), 0, sizeof (struct linespec
));
2782 PARSER_EXPLICIT (parser
)->line_offset
.sign
= LINE_OFFSET_UNKNOWN
;
2783 linespec_state_constructor (PARSER_STATE (parser
), flags
, language
,
2785 default_symtab
, default_line
, canonical
);
2788 /* A destructor for linespec_state. */
2791 linespec_state_destructor (struct linespec_state
*self
)
2793 htab_delete (self
->addr_set
);
2796 /* Delete a linespec parser. */
2799 linespec_parser_delete (void *arg
)
2801 linespec_parser
*parser
= (linespec_parser
*) arg
;
2803 xfree (PARSER_EXPLICIT (parser
)->source_filename
);
2804 xfree (PARSER_EXPLICIT (parser
)->label_name
);
2805 xfree (PARSER_EXPLICIT (parser
)->function_name
);
2807 if (PARSER_RESULT (parser
)->file_symtabs
!= NULL
)
2808 VEC_free (symtab_ptr
, PARSER_RESULT (parser
)->file_symtabs
);
2810 if (PARSER_RESULT (parser
)->function_symbols
!= NULL
)
2811 VEC_free (symbolp
, PARSER_RESULT (parser
)->function_symbols
);
2813 if (PARSER_RESULT (parser
)->minimal_symbols
!= NULL
)
2814 VEC_free (bound_minimal_symbol_d
, PARSER_RESULT (parser
)->minimal_symbols
);
2816 if (PARSER_RESULT (parser
)->labels
.label_symbols
!= NULL
)
2817 VEC_free (symbolp
, PARSER_RESULT (parser
)->labels
.label_symbols
);
2819 if (PARSER_RESULT (parser
)->labels
.function_symbols
!= NULL
)
2820 VEC_free (symbolp
, PARSER_RESULT (parser
)->labels
.function_symbols
);
2822 linespec_state_destructor (PARSER_STATE (parser
));
2825 /* See description in linespec.h. */
2828 linespec_lex_to_end (char **stringp
)
2830 linespec_parser parser
;
2831 struct cleanup
*cleanup
;
2832 linespec_token token
;
2835 if (stringp
== NULL
|| *stringp
== NULL
)
2838 linespec_parser_new (&parser
, 0, current_language
, NULL
, NULL
, 0, NULL
);
2839 cleanup
= make_cleanup (linespec_parser_delete
, &parser
);
2840 parser
.lexer
.saved_arg
= *stringp
;
2841 PARSER_STREAM (&parser
) = orig
= *stringp
;
2845 /* Stop before any comma tokens; we need it to keep it
2846 as the next token in the string. */
2847 token
= linespec_lexer_peek_token (&parser
);
2848 if (token
.type
== LSTOKEN_COMMA
)
2850 token
= linespec_lexer_consume_token (&parser
);
2852 while (token
.type
!= LSTOKEN_EOI
&& token
.type
!= LSTOKEN_KEYWORD
);
2854 *stringp
+= PARSER_STREAM (&parser
) - orig
;
2855 do_cleanups (cleanup
);
2858 /* See linespec.h. */
2861 linespec_complete_function (completion_tracker
&tracker
,
2862 const char *function
,
2863 const char *source_filename
)
2865 complete_symbol_mode mode
= complete_symbol_mode::LINESPEC
;
2867 if (source_filename
!= NULL
)
2869 collect_file_symbol_completion_matches (tracker
, mode
,
2874 collect_symbol_completion_matches (tracker
, mode
, function
, function
);
2877 /* Helper for complete_linespec to simplify it. SOURCE_FILENAME is
2878 only meaningful if COMPONENT is FUNCTION. */
2881 complete_linespec_component (linespec_parser
*parser
,
2882 completion_tracker
&tracker
,
2884 linespec_complete_what component
,
2885 const char *source_filename
)
2887 if (component
== linespec_complete_what::KEYWORD
)
2889 complete_on_enum (tracker
, linespec_keywords
, text
, text
);
2891 else if (component
== linespec_complete_what::EXPRESSION
)
2894 = advance_to_expression_complete_word_point (tracker
, text
);
2895 complete_expression (tracker
, text
, word
);
2897 else if (component
== linespec_complete_what::FUNCTION
)
2899 completion_list fn_list
;
2901 linespec_complete_function (tracker
, text
, source_filename
);
2902 if (source_filename
== NULL
)
2904 /* Haven't seen a source component, like in "b
2905 file.c:function[TAB]". Maybe this wasn't a function, but
2906 a filename instead, like "b file.[TAB]". */
2907 fn_list
= complete_source_filenames (text
);
2910 /* If we only have a single filename completion, append a ':' for
2911 the user, since that's the only thing that can usefully follow
2913 if (fn_list
.size () == 1 && !tracker
.have_completions ())
2915 char *fn
= fn_list
[0].release ();
2917 /* If we also need to append a quote char, it needs to be
2918 appended before the ':'. Append it now, and make ':' the
2919 new "quote" char. */
2920 if (tracker
.quote_char ())
2922 char quote_char_str
[2] = { tracker
.quote_char () };
2924 fn
= reconcat (fn
, fn
, quote_char_str
, (char *) NULL
);
2925 tracker
.set_quote_char (':');
2928 fn
= reconcat (fn
, fn
, ":", (char *) NULL
);
2929 fn_list
[0].reset (fn
);
2931 /* Tell readline to skip appending a space. */
2932 tracker
.set_suppress_append_ws (true);
2934 tracker
.add_completions (std::move (fn_list
));
2938 /* Helper for linespec_complete_label. Find labels that match
2939 LABEL_NAME in the function symbols listed in the PARSER, and add
2940 them to the tracker. */
2943 complete_label (completion_tracker
&tracker
,
2944 linespec_parser
*parser
,
2945 const char *label_name
)
2947 VEC (symbolp
) *label_function_symbols
= NULL
;
2948 VEC (symbolp
) *labels
2949 = find_label_symbols (PARSER_STATE (parser
),
2950 PARSER_RESULT (parser
)->function_symbols
,
2951 &label_function_symbols
,
2956 VEC_iterate (symbolp
, labels
, ix
, label
); ++ix
)
2958 char *match
= xstrdup (SYMBOL_SEARCH_NAME (label
));
2959 tracker
.add_completion (gdb::unique_xmalloc_ptr
<char> (match
));
2961 VEC_free (symbolp
, labels
);
2964 /* See linespec.h. */
2967 linespec_complete_label (completion_tracker
&tracker
,
2968 const struct language_defn
*language
,
2969 const char *source_filename
,
2970 const char *function_name
,
2971 const char *label_name
)
2973 linespec_parser parser
;
2974 struct cleanup
*cleanup
;
2976 linespec_parser_new (&parser
, 0, language
, NULL
, NULL
, 0, NULL
);
2977 cleanup
= make_cleanup (linespec_parser_delete
, &parser
);
2979 line_offset unknown_offset
= { 0, LINE_OFFSET_UNKNOWN
};
2983 convert_explicit_location_to_linespec (PARSER_STATE (&parser
),
2984 PARSER_RESULT (&parser
),
2987 NULL
, unknown_offset
);
2989 CATCH (ex
, RETURN_MASK_ERROR
)
2991 do_cleanups (cleanup
);
2996 complete_label (tracker
, &parser
, label_name
);
2998 do_cleanups (cleanup
);
3001 /* See description in linespec.h. */
3004 linespec_complete (completion_tracker
&tracker
, const char *text
)
3006 linespec_parser parser
;
3007 struct cleanup
*cleanup
;
3008 const char *orig
= text
;
3010 linespec_parser_new (&parser
, 0, current_language
, NULL
, NULL
, 0, NULL
);
3011 cleanup
= make_cleanup (linespec_parser_delete
, &parser
);
3012 parser
.lexer
.saved_arg
= text
;
3013 PARSER_STREAM (&parser
) = text
;
3015 parser
.completion_tracker
= &tracker
;
3016 PARSER_STATE (&parser
)->is_linespec
= 1;
3018 /* Parse as much as possible. parser.completion_word will hold
3019 furthest completion point we managed to parse to. */
3022 parse_linespec (&parser
, text
);
3024 CATCH (except
, RETURN_MASK_ERROR
)
3029 if (parser
.completion_quote_char
!= '\0'
3030 && parser
.completion_quote_end
!= NULL
3031 && parser
.completion_quote_end
[1] == '\0')
3033 /* If completing a quoted string with the cursor right at
3034 terminating quote char, complete the completion word without
3035 interpretation, so that readline advances the cursor one
3036 whitespace past the quote, even if there's no match. This
3037 makes these cases behave the same:
3039 before: "b function()"
3040 after: "b function() "
3042 before: "b 'function()'"
3043 after: "b 'function()' "
3045 and trusts the user in this case:
3047 before: "b 'not_loaded_function_yet()'"
3048 after: "b 'not_loaded_function_yet()' "
3050 parser
.complete_what
= linespec_complete_what::NOTHING
;
3051 parser
.completion_quote_char
= '\0';
3053 gdb::unique_xmalloc_ptr
<char> text_copy
3054 (xstrdup (parser
.completion_word
));
3055 tracker
.add_completion (std::move (text_copy
));
3058 tracker
.set_quote_char (parser
.completion_quote_char
);
3060 if (parser
.complete_what
== linespec_complete_what::LABEL
)
3062 parser
.complete_what
= linespec_complete_what::NOTHING
;
3064 const char *func_name
= PARSER_EXPLICIT (&parser
)->function_name
;
3066 VEC (symbolp
) *function_symbols
;
3067 VEC (bound_minimal_symbol_d
) *minimal_symbols
;
3068 find_linespec_symbols (PARSER_STATE (&parser
),
3069 PARSER_RESULT (&parser
)->file_symtabs
,
3071 &function_symbols
, &minimal_symbols
);
3073 PARSER_RESULT (&parser
)->function_symbols
= function_symbols
;
3074 PARSER_RESULT (&parser
)->minimal_symbols
= minimal_symbols
;
3076 complete_label (tracker
, &parser
, parser
.completion_word
);
3078 else if (parser
.complete_what
== linespec_complete_what::FUNCTION
)
3080 /* While parsing/lexing, we didn't know whether the completion
3081 word completes to a unique function/source name already or
3085 "b function() <tab>"
3086 may need to complete either to:
3087 "b function() const"
3089 "b function() if/thread/task"
3093 may need to complete either to:
3094 "b foo template_fun<T>()"
3095 with "foo" being the template function's return type, or to:
3100 may need to complete either to a source file name:
3102 or this, also a filename, but a unique completion:
3104 or to a function name:
3107 Address that by completing assuming source or function, and
3108 seeing if we find a completion that matches exactly the
3109 completion word. If so, then it must be a function (see note
3110 below) and we advance the completion word to the end of input
3111 and switch to KEYWORD completion mode.
3113 Note: if we find a unique completion for a source filename,
3114 then it won't match the completion word, because the LCD will
3115 contain a trailing ':'. And if we're completing at or after
3116 the ':', then complete_linespec_component won't try to
3117 complete on source filenames. */
3119 const char *text
= parser
.completion_word
;
3120 const char *word
= parser
.completion_word
;
3122 complete_linespec_component (&parser
, tracker
,
3123 parser
.completion_word
,
3124 linespec_complete_what::FUNCTION
,
3125 PARSER_EXPLICIT (&parser
)->source_filename
);
3127 parser
.complete_what
= linespec_complete_what::NOTHING
;
3129 if (tracker
.quote_char ())
3131 /* The function/file name was not close-quoted, so this
3132 can't be a keyword. Note: complete_linespec_component
3133 may have swapped the original quote char for ':' when we
3134 get here, but that still indicates the same. */
3136 else if (!tracker
.have_completions ())
3139 size_t wordlen
= strlen (parser
.completion_word
);
3142 = string_find_incomplete_keyword_at_end (linespec_keywords
,
3143 parser
.completion_word
,
3148 && parser
.completion_word
[wordlen
- 1] == ' '))
3150 parser
.completion_word
+= key_start
;
3151 parser
.complete_what
= linespec_complete_what::KEYWORD
;
3154 else if (tracker
.completes_to_completion_word (word
))
3156 /* Skip the function and complete on keywords. */
3157 parser
.completion_word
+= strlen (word
);
3158 parser
.complete_what
= linespec_complete_what::KEYWORD
;
3159 tracker
.discard_completions ();
3163 tracker
.advance_custom_word_point_by (parser
.completion_word
- orig
);
3165 complete_linespec_component (&parser
, tracker
,
3166 parser
.completion_word
,
3167 parser
.complete_what
,
3168 PARSER_EXPLICIT (&parser
)->source_filename
);
3170 /* If we're past the "filename:function:label:offset" linespec, and
3171 didn't find any match, then assume the user might want to create
3172 a pending breakpoint anyway and offer the keyword
3174 if (!parser
.completion_quote_char
3175 && (parser
.complete_what
== linespec_complete_what::FUNCTION
3176 || parser
.complete_what
== linespec_complete_what::LABEL
3177 || parser
.complete_what
== linespec_complete_what::NOTHING
)
3178 && !tracker
.have_completions ())
3181 = parser
.completion_word
+ strlen (parser
.completion_word
);
3183 if (end
> orig
&& end
[-1] == ' ')
3185 tracker
.advance_custom_word_point_by (end
- parser
.completion_word
);
3187 complete_linespec_component (&parser
, tracker
, end
,
3188 linespec_complete_what::KEYWORD
,
3193 do_cleanups (cleanup
);
3196 /* A helper function for decode_line_full and decode_line_1 to
3197 turn LOCATION into symtabs_and_lines. */
3199 static struct symtabs_and_lines
3200 event_location_to_sals (linespec_parser
*parser
,
3201 const struct event_location
*location
)
3203 struct symtabs_and_lines result
= {NULL
, 0};
3205 switch (event_location_type (location
))
3207 case LINESPEC_LOCATION
:
3209 PARSER_STATE (parser
)->is_linespec
= 1;
3212 result
= parse_linespec (parser
, get_linespec_location (location
));
3214 CATCH (except
, RETURN_MASK_ERROR
)
3216 throw_exception (except
);
3222 case ADDRESS_LOCATION
:
3224 const char *addr_string
= get_address_string_location (location
);
3225 CORE_ADDR addr
= get_address_location (location
);
3227 if (addr_string
!= NULL
)
3229 char *expr
= xstrdup (addr_string
);
3230 const char *const_expr
= expr
;
3231 struct cleanup
*cleanup
= make_cleanup (xfree
, expr
);
3233 addr
= linespec_expression_to_pc (&const_expr
);
3234 if (PARSER_STATE (parser
)->canonical
!= NULL
)
3235 PARSER_STATE (parser
)->canonical
->location
3236 = copy_event_location (location
);
3238 do_cleanups (cleanup
);
3241 result
= convert_address_location_to_sals (PARSER_STATE (parser
),
3246 case EXPLICIT_LOCATION
:
3248 const struct explicit_location
*explicit_loc
;
3250 explicit_loc
= get_explicit_location_const (location
);
3251 result
= convert_explicit_location_to_sals (PARSER_STATE (parser
),
3252 PARSER_RESULT (parser
),
3257 case PROBE_LOCATION
:
3258 /* Probes are handled by their own decoders. */
3259 gdb_assert_not_reached ("attempt to decode probe location");
3263 gdb_assert_not_reached ("unhandled event location type");
3269 /* See linespec.h. */
3272 decode_line_full (const struct event_location
*location
, int flags
,
3273 struct program_space
*search_pspace
,
3274 struct symtab
*default_symtab
,
3275 int default_line
, struct linespec_result
*canonical
,
3276 const char *select_mode
,
3279 struct symtabs_and_lines result
;
3280 struct cleanup
*cleanups
;
3281 VEC (const_char_ptr
) *filters
= NULL
;
3282 linespec_parser parser
;
3283 struct linespec_state
*state
;
3285 gdb_assert (canonical
!= NULL
);
3286 /* The filter only makes sense for 'all'. */
3287 gdb_assert (filter
== NULL
|| select_mode
== multiple_symbols_all
);
3288 gdb_assert (select_mode
== NULL
3289 || select_mode
== multiple_symbols_all
3290 || select_mode
== multiple_symbols_ask
3291 || select_mode
== multiple_symbols_cancel
);
3292 gdb_assert ((flags
& DECODE_LINE_LIST_MODE
) == 0);
3294 linespec_parser_new (&parser
, flags
, current_language
,
3295 search_pspace
, default_symtab
,
3296 default_line
, canonical
);
3297 cleanups
= make_cleanup (linespec_parser_delete
, &parser
);
3299 scoped_restore_current_program_space restore_pspace
;
3301 result
= event_location_to_sals (&parser
, location
);
3302 state
= PARSER_STATE (&parser
);
3304 gdb_assert (result
.nelts
== 1 || canonical
->pre_expanded
);
3305 canonical
->pre_expanded
= 1;
3307 /* Arrange for allocated canonical names to be freed. */
3308 if (result
.nelts
> 0)
3312 make_cleanup (xfree
, state
->canonical_names
);
3313 for (i
= 0; i
< result
.nelts
; ++i
)
3315 gdb_assert (state
->canonical_names
[i
].suffix
!= NULL
);
3316 make_cleanup (xfree
, state
->canonical_names
[i
].suffix
);
3320 if (select_mode
== NULL
)
3322 if (interp_ui_out (top_level_interpreter ())->is_mi_like_p ())
3323 select_mode
= multiple_symbols_all
;
3325 select_mode
= multiple_symbols_select_mode ();
3328 if (select_mode
== multiple_symbols_all
)
3332 make_cleanup (VEC_cleanup (const_char_ptr
), &filters
);
3333 VEC_safe_push (const_char_ptr
, filters
, filter
);
3334 filter_results (state
, &result
, filters
);
3337 convert_results_to_lsals (state
, &result
);
3340 decode_line_2 (state
, &result
, select_mode
);
3342 do_cleanups (cleanups
);
3345 /* See linespec.h. */
3347 struct symtabs_and_lines
3348 decode_line_1 (const struct event_location
*location
, int flags
,
3349 struct program_space
*search_pspace
,
3350 struct symtab
*default_symtab
,
3353 struct symtabs_and_lines result
;
3354 linespec_parser parser
;
3355 struct cleanup
*cleanups
;
3357 linespec_parser_new (&parser
, flags
, current_language
,
3358 search_pspace
, default_symtab
,
3359 default_line
, NULL
);
3360 cleanups
= make_cleanup (linespec_parser_delete
, &parser
);
3362 scoped_restore_current_program_space restore_pspace
;
3364 result
= event_location_to_sals (&parser
, location
);
3366 do_cleanups (cleanups
);
3370 /* See linespec.h. */
3372 struct symtabs_and_lines
3373 decode_line_with_current_source (char *string
, int flags
)
3375 struct symtabs_and_lines sals
;
3376 struct symtab_and_line cursal
;
3379 error (_("Empty line specification."));
3381 /* We use whatever is set as the current source line. We do not try
3382 and get a default source symtab+line or it will recursively call us! */
3383 cursal
= get_current_source_symtab_and_line ();
3385 event_location_up location
= string_to_event_location (&string
,
3387 sals
= decode_line_1 (location
.get (), flags
, NULL
,
3388 cursal
.symtab
, cursal
.line
);
3391 error (_("Junk at end of line specification: %s"), string
);
3396 /* See linespec.h. */
3398 struct symtabs_and_lines
3399 decode_line_with_last_displayed (char *string
, int flags
)
3401 struct symtabs_and_lines sals
;
3404 error (_("Empty line specification."));
3406 event_location_up location
= string_to_event_location (&string
,
3408 if (last_displayed_sal_is_valid ())
3409 sals
= decode_line_1 (location
.get (), flags
, NULL
,
3410 get_last_displayed_symtab (),
3411 get_last_displayed_line ());
3413 sals
= decode_line_1 (location
.get (), flags
, NULL
,
3414 (struct symtab
*) NULL
, 0);
3417 error (_("Junk at end of line specification: %s"), string
);
3424 /* First, some functions to initialize stuff at the beggining of the
3428 initialize_defaults (struct symtab
**default_symtab
, int *default_line
)
3430 if (*default_symtab
== 0)
3432 /* Use whatever we have for the default source line. We don't use
3433 get_current_or_default_symtab_and_line as it can recurse and call
3435 struct symtab_and_line cursal
=
3436 get_current_source_symtab_and_line ();
3438 *default_symtab
= cursal
.symtab
;
3439 *default_line
= cursal
.line
;
3445 /* Evaluate the expression pointed to by EXP_PTR into a CORE_ADDR,
3446 advancing EXP_PTR past any parsed text. */
3449 linespec_expression_to_pc (const char **exp_ptr
)
3451 if (current_program_space
->executing_startup
)
3452 /* The error message doesn't really matter, because this case
3453 should only hit during breakpoint reset. */
3454 throw_error (NOT_FOUND_ERROR
, _("cannot evaluate expressions while "
3455 "program space is in startup"));
3458 return value_as_address (parse_to_comma_and_eval (exp_ptr
));
3463 /* Here's where we recognise an Objective-C Selector. An Objective C
3464 selector may be implemented by more than one class, therefore it
3465 may represent more than one method/function. This gives us a
3466 situation somewhat analogous to C++ overloading. If there's more
3467 than one method that could represent the selector, then use some of
3468 the existing C++ code to let the user choose one. */
3470 static struct symtabs_and_lines
3471 decode_objc (struct linespec_state
*self
, linespec_p ls
, const char *arg
)
3473 struct collect_info info
;
3474 VEC (const_char_ptr
) *symbol_names
= NULL
;
3475 struct symtabs_and_lines values
;
3476 const char *new_argptr
;
3477 struct cleanup
*cleanup
= make_cleanup (VEC_cleanup (const_char_ptr
),
3481 info
.file_symtabs
= NULL
;
3482 VEC_safe_push (symtab_ptr
, info
.file_symtabs
, NULL
);
3483 make_cleanup (VEC_cleanup (symtab_ptr
), &info
.file_symtabs
);
3484 info
.result
.symbols
= NULL
;
3485 info
.result
.minimal_symbols
= NULL
;
3489 new_argptr
= find_imps (arg
, &symbol_names
);
3490 if (VEC_empty (const_char_ptr
, symbol_names
))
3492 do_cleanups (cleanup
);
3496 add_all_symbol_names_from_pspace (&info
, NULL
, symbol_names
);
3498 if (!VEC_empty (symbolp
, info
.result
.symbols
)
3499 || !VEC_empty (bound_minimal_symbol_d
, info
.result
.minimal_symbols
))
3503 saved_arg
= (char *) alloca (new_argptr
- arg
+ 1);
3504 memcpy (saved_arg
, arg
, new_argptr
- arg
);
3505 saved_arg
[new_argptr
- arg
] = '\0';
3507 ls
->explicit_loc
.function_name
= xstrdup (saved_arg
);
3508 ls
->function_symbols
= info
.result
.symbols
;
3509 ls
->minimal_symbols
= info
.result
.minimal_symbols
;
3510 values
= convert_linespec_to_sals (self
, ls
);
3512 if (self
->canonical
)
3516 self
->canonical
->pre_expanded
= 1;
3518 if (ls
->explicit_loc
.source_filename
)
3520 str
= xstrprintf ("%s:%s",
3521 ls
->explicit_loc
.source_filename
, saved_arg
);
3524 str
= xstrdup (saved_arg
);
3526 make_cleanup (xfree
, str
);
3527 self
->canonical
->location
= new_linespec_location (&str
);
3531 do_cleanups (cleanup
);
3538 /* A function object that serves as symbol_found_callback_ftype
3539 callback for iterate_over_symbols. This is used by
3540 lookup_prefix_sym to collect type symbols. */
3541 class decode_compound_collector
3544 decode_compound_collector ()
3547 m_unique_syms
= htab_create_alloc (1, htab_hash_pointer
,
3548 htab_eq_pointer
, NULL
,
3552 ~decode_compound_collector ()
3554 if (m_unique_syms
!= NULL
)
3555 htab_delete (m_unique_syms
);
3558 /* Releases ownership of the collected symbols and returns them. */
3559 VEC (symbolp
) *release_symbols ()
3561 VEC (symbolp
) *res
= m_symbols
;
3566 /* Callable as a symbol_found_callback_ftype callback. */
3567 bool operator () (symbol
*sym
);
3570 /* A hash table of all symbols we found. We use this to avoid
3571 adding any symbol more than once. */
3572 htab_t m_unique_syms
;
3574 /* The result vector. */
3575 VEC (symbolp
) *m_symbols
;
3579 decode_compound_collector::operator () (symbol
*sym
)
3584 if (SYMBOL_CLASS (sym
) != LOC_TYPEDEF
)
3585 return true; /* Continue iterating. */
3587 t
= SYMBOL_TYPE (sym
);
3588 t
= check_typedef (t
);
3589 if (TYPE_CODE (t
) != TYPE_CODE_STRUCT
3590 && TYPE_CODE (t
) != TYPE_CODE_UNION
3591 && TYPE_CODE (t
) != TYPE_CODE_NAMESPACE
)
3592 return true; /* Continue iterating. */
3594 slot
= htab_find_slot (m_unique_syms
, sym
, INSERT
);
3598 VEC_safe_push (symbolp
, m_symbols
, sym
);
3601 return true; /* Continue iterating. */
3606 /* Return any symbols corresponding to CLASS_NAME in FILE_SYMTABS. */
3608 static VEC (symbolp
) *
3609 lookup_prefix_sym (struct linespec_state
*state
, VEC (symtab_ptr
) *file_symtabs
,
3610 const char *class_name
)
3614 decode_compound_collector collector
;
3616 for (ix
= 0; VEC_iterate (symtab_ptr
, file_symtabs
, ix
, elt
); ++ix
)
3620 iterate_over_all_matching_symtabs (state
, class_name
, STRUCT_DOMAIN
,
3621 NULL
, false, collector
);
3622 iterate_over_all_matching_symtabs (state
, class_name
, VAR_DOMAIN
,
3623 NULL
, false, collector
);
3627 /* Program spaces that are executing startup should have
3628 been filtered out earlier. */
3629 gdb_assert (!SYMTAB_PSPACE (elt
)->executing_startup
);
3630 set_current_program_space (SYMTAB_PSPACE (elt
));
3631 iterate_over_file_blocks (elt
, class_name
, STRUCT_DOMAIN
, collector
);
3632 iterate_over_file_blocks (elt
, class_name
, VAR_DOMAIN
, collector
);
3636 return collector
.release_symbols ();
3639 /* A qsort comparison function for symbols. The resulting order does
3640 not actually matter; we just need to be able to sort them so that
3641 symbols with the same program space end up next to each other. */
3644 compare_symbols (const void *a
, const void *b
)
3646 struct symbol
* const *sa
= (struct symbol
* const*) a
;
3647 struct symbol
* const *sb
= (struct symbol
* const*) b
;
3650 uia
= (uintptr_t) SYMTAB_PSPACE (symbol_symtab (*sa
));
3651 uib
= (uintptr_t) SYMTAB_PSPACE (symbol_symtab (*sb
));
3658 uia
= (uintptr_t) *sa
;
3659 uib
= (uintptr_t) *sb
;
3669 /* Like compare_symbols but for minimal symbols. */
3672 compare_msymbols (const void *a
, const void *b
)
3674 const struct bound_minimal_symbol
*sa
3675 = (const struct bound_minimal_symbol
*) a
;
3676 const struct bound_minimal_symbol
*sb
3677 = (const struct bound_minimal_symbol
*) b
;
3680 uia
= (uintptr_t) sa
->objfile
->pspace
;
3681 uib
= (uintptr_t) sa
->objfile
->pspace
;
3688 uia
= (uintptr_t) sa
->minsym
;
3689 uib
= (uintptr_t) sb
->minsym
;
3699 /* Look for all the matching instances of each symbol in NAMES. Only
3700 instances from PSPACE are considered; other program spaces are
3701 handled by our caller. If PSPACE is NULL, then all program spaces
3702 are considered. Results are stored into INFO. */
3705 add_all_symbol_names_from_pspace (struct collect_info
*info
,
3706 struct program_space
*pspace
,
3707 VEC (const_char_ptr
) *names
)
3712 for (ix
= 0; VEC_iterate (const_char_ptr
, names
, ix
, iter
); ++ix
)
3713 add_matching_symbols_to_info (iter
, info
, pspace
);
3717 find_superclass_methods (VEC (typep
) *superclasses
,
3719 VEC (const_char_ptr
) **result_names
)
3721 int old_len
= VEC_length (const_char_ptr
, *result_names
);
3722 VEC (typep
) *iter_classes
;
3723 struct cleanup
*cleanup
= make_cleanup (null_cleanup
, NULL
);
3725 iter_classes
= superclasses
;
3728 VEC (typep
) *new_supers
= NULL
;
3732 make_cleanup (VEC_cleanup (typep
), &new_supers
);
3733 for (ix
= 0; VEC_iterate (typep
, iter_classes
, ix
, t
); ++ix
)
3734 find_methods (t
, name
, result_names
, &new_supers
);
3736 if (VEC_length (const_char_ptr
, *result_names
) != old_len
3737 || VEC_empty (typep
, new_supers
))
3740 iter_classes
= new_supers
;
3743 do_cleanups (cleanup
);
3746 /* This finds the method METHOD_NAME in the class CLASS_NAME whose type is
3747 given by one of the symbols in SYM_CLASSES. Matches are returned
3748 in SYMBOLS (for debug symbols) and MINSYMS (for minimal symbols). */
3751 find_method (struct linespec_state
*self
, VEC (symtab_ptr
) *file_symtabs
,
3752 const char *class_name
, const char *method_name
,
3753 VEC (symbolp
) *sym_classes
, VEC (symbolp
) **symbols
,
3754 VEC (bound_minimal_symbol_d
) **minsyms
)
3757 struct cleanup
*cleanup
= make_cleanup (null_cleanup
, NULL
);
3759 int last_result_len
;
3760 VEC (typep
) *superclass_vec
;
3761 VEC (const_char_ptr
) *result_names
;
3762 struct collect_info info
;
3764 /* Sort symbols so that symbols with the same program space are next
3766 qsort (VEC_address (symbolp
, sym_classes
),
3767 VEC_length (symbolp
, sym_classes
),
3772 info
.file_symtabs
= file_symtabs
;
3773 info
.result
.symbols
= NULL
;
3774 info
.result
.minimal_symbols
= NULL
;
3776 /* Iterate over all the types, looking for the names of existing
3777 methods matching METHOD_NAME. If we cannot find a direct method in a
3778 given program space, then we consider inherited methods; this is
3779 not ideal (ideal would be to respect C++ hiding rules), but it
3780 seems good enough and is what GDB has historically done. We only
3781 need to collect the names because later we find all symbols with
3782 those names. This loop is written in a somewhat funny way
3783 because we collect data across the program space before deciding
3785 superclass_vec
= NULL
;
3786 make_cleanup (VEC_cleanup (typep
), &superclass_vec
);
3787 result_names
= NULL
;
3788 make_cleanup (VEC_cleanup (const_char_ptr
), &result_names
);
3789 last_result_len
= 0;
3790 for (ix
= 0; VEC_iterate (symbolp
, sym_classes
, ix
, sym
); ++ix
)
3793 struct program_space
*pspace
;
3795 /* Program spaces that are executing startup should have
3796 been filtered out earlier. */
3797 pspace
= SYMTAB_PSPACE (symbol_symtab (sym
));
3798 gdb_assert (!pspace
->executing_startup
);
3799 set_current_program_space (pspace
);
3800 t
= check_typedef (SYMBOL_TYPE (sym
));
3801 find_methods (t
, method_name
, &result_names
, &superclass_vec
);
3803 /* Handle all items from a single program space at once; and be
3804 sure not to miss the last batch. */
3805 if (ix
== VEC_length (symbolp
, sym_classes
) - 1
3807 != SYMTAB_PSPACE (symbol_symtab (VEC_index (symbolp
, sym_classes
,
3810 /* If we did not find a direct implementation anywhere in
3811 this program space, consider superclasses. */
3812 if (VEC_length (const_char_ptr
, result_names
) == last_result_len
)
3813 find_superclass_methods (superclass_vec
, method_name
,
3816 /* We have a list of candidate symbol names, so now we
3817 iterate over the symbol tables looking for all
3818 matches in this pspace. */
3819 add_all_symbol_names_from_pspace (&info
, pspace
, result_names
);
3821 VEC_truncate (typep
, superclass_vec
, 0);
3822 last_result_len
= VEC_length (const_char_ptr
, result_names
);
3826 if (!VEC_empty (symbolp
, info
.result
.symbols
)
3827 || !VEC_empty (bound_minimal_symbol_d
, info
.result
.minimal_symbols
))
3829 *symbols
= info
.result
.symbols
;
3830 *minsyms
= info
.result
.minimal_symbols
;
3831 do_cleanups (cleanup
);
3835 /* Throw an NOT_FOUND_ERROR. This will be caught by the caller
3836 and other attempts to locate the symbol will be made. */
3837 throw_error (NOT_FOUND_ERROR
, _("see caller, this text doesn't matter"));
3844 /* This function object is a callback for iterate_over_symtabs, used
3845 when collecting all matching symtabs. */
3847 class symtab_collector
3853 m_symtab_table
= htab_create (1, htab_hash_pointer
, htab_eq_pointer
,
3857 ~symtab_collector ()
3859 if (m_symtab_table
!= NULL
)
3860 htab_delete (m_symtab_table
);
3863 /* Callable as a symbol_found_callback_ftype callback. */
3864 bool operator () (symtab
*sym
);
3866 /* Releases ownership of the collected symtabs and returns them. */
3867 VEC (symtab_ptr
) *release_symtabs ()
3869 VEC (symtab_ptr
) *res
= m_symtabs
;
3875 /* The result vector of symtabs. */
3876 VEC (symtab_ptr
) *m_symtabs
;
3878 /* This is used to ensure the symtabs are unique. */
3879 htab_t m_symtab_table
;
3883 symtab_collector::operator () (struct symtab
*symtab
)
3887 slot
= htab_find_slot (m_symtab_table
, symtab
, INSERT
);
3891 VEC_safe_push (symtab_ptr
, m_symtabs
, symtab
);
3899 /* Given a file name, return a VEC of all matching symtabs. If
3900 SEARCH_PSPACE is not NULL, the search is restricted to just that
3903 static VEC (symtab_ptr
) *
3904 collect_symtabs_from_filename (const char *file
,
3905 struct program_space
*search_pspace
)
3907 symtab_collector collector
;
3909 /* Find that file's data. */
3910 if (search_pspace
== NULL
)
3912 struct program_space
*pspace
;
3914 ALL_PSPACES (pspace
)
3916 if (pspace
->executing_startup
)
3919 set_current_program_space (pspace
);
3920 iterate_over_symtabs (file
, collector
);
3925 set_current_program_space (search_pspace
);
3926 iterate_over_symtabs (file
, collector
);
3929 return collector
.release_symtabs ();
3932 /* Return all the symtabs associated to the FILENAME. If SEARCH_PSPACE is
3933 not NULL, the search is restricted to just that program space. */
3935 static VEC (symtab_ptr
) *
3936 symtabs_from_filename (const char *filename
,
3937 struct program_space
*search_pspace
)
3939 VEC (symtab_ptr
) *result
;
3941 result
= collect_symtabs_from_filename (filename
, search_pspace
);
3943 if (VEC_empty (symtab_ptr
, result
))
3945 if (!have_full_symbols () && !have_partial_symbols ())
3946 throw_error (NOT_FOUND_ERROR
,
3947 _("No symbol table is loaded. "
3948 "Use the \"file\" command."));
3949 source_file_not_found_error (filename
);
3955 /* Look up a function symbol named NAME in symtabs FILE_SYMTABS. Matching
3956 debug symbols are returned in SYMBOLS. Matching minimal symbols are
3957 returned in MINSYMS. */
3960 find_function_symbols (struct linespec_state
*state
,
3961 VEC (symtab_ptr
) *file_symtabs
, const char *name
,
3962 VEC (symbolp
) **symbols
,
3963 VEC (bound_minimal_symbol_d
) **minsyms
)
3965 struct collect_info info
;
3966 VEC (const_char_ptr
) *symbol_names
= NULL
;
3967 struct cleanup
*cleanup
= make_cleanup (VEC_cleanup (const_char_ptr
),
3971 info
.result
.symbols
= NULL
;
3972 info
.result
.minimal_symbols
= NULL
;
3973 info
.file_symtabs
= file_symtabs
;
3975 /* Try NAME as an Objective-C selector. */
3976 find_imps (name
, &symbol_names
);
3977 if (!VEC_empty (const_char_ptr
, symbol_names
))
3978 add_all_symbol_names_from_pspace (&info
, state
->search_pspace
,
3981 add_matching_symbols_to_info (name
, &info
, state
->search_pspace
);
3983 do_cleanups (cleanup
);
3985 if (VEC_empty (symbolp
, info
.result
.symbols
))
3987 VEC_free (symbolp
, info
.result
.symbols
);
3991 *symbols
= info
.result
.symbols
;
3993 if (VEC_empty (bound_minimal_symbol_d
, info
.result
.minimal_symbols
))
3995 VEC_free (bound_minimal_symbol_d
, info
.result
.minimal_symbols
);
3999 *minsyms
= info
.result
.minimal_symbols
;
4002 /* Find all symbols named NAME in FILE_SYMTABS, returning debug symbols
4003 in SYMBOLS and minimal symbols in MINSYMS. */
4006 find_linespec_symbols (struct linespec_state
*state
,
4007 VEC (symtab_ptr
) *file_symtabs
,
4009 VEC (symbolp
) **symbols
,
4010 VEC (bound_minimal_symbol_d
) **minsyms
)
4012 demangle_result_storage demangle_storage
;
4013 std::string ada_lookup_storage
;
4014 const char *lookup_name
;
4016 if (state
->language
->la_language
== language_ada
)
4018 /* In Ada, the symbol lookups are performed using the encoded
4019 name rather than the demangled name. */
4020 ada_lookup_storage
= ada_name_for_lookup (name
);
4021 lookup_name
= ada_lookup_storage
.c_str ();
4025 lookup_name
= demangle_for_lookup (name
,
4026 state
->language
->la_language
,
4030 std::string canon
= cp_canonicalize_string_no_typedefs (lookup_name
);
4031 if (!canon
.empty ())
4032 lookup_name
= canon
.c_str ();
4034 /* It's important to not call expand_symtabs_matching unnecessarily
4035 as it can really slow things down (by unnecessarily expanding
4036 potentially 1000s of symtabs, which when debugging some apps can
4037 cost 100s of seconds). Avoid this to some extent by *first* calling
4038 find_function_symbols, and only if that doesn't find anything
4039 *then* call find_method. This handles two important cases:
4040 1) break (anonymous namespace)::foo
4041 2) break class::method where method is in class (and not a baseclass) */
4043 find_function_symbols (state
, file_symtabs
, lookup_name
,
4046 /* If we were unable to locate a symbol of the same name, try dividing
4047 the name into class and method names and searching the class and its
4049 if (VEC_empty (symbolp
, *symbols
)
4050 && VEC_empty (bound_minimal_symbol_d
, *minsyms
))
4052 std::string klass
, method
;
4053 const char *last
, *p
, *scope_op
;
4054 VEC (symbolp
) *classes
;
4056 /* See if we can find a scope operator and break this symbol
4057 name into namespaces${SCOPE_OPERATOR}class_name and method_name. */
4059 p
= find_toplevel_string (lookup_name
, scope_op
);
4065 p
= find_toplevel_string (p
+ strlen (scope_op
), scope_op
);
4068 /* If no scope operator was found, there is nothing more we can do;
4069 we already attempted to lookup the entire name as a symbol
4074 /* LOOKUP_NAME points to the class name.
4075 LAST points to the method name. */
4076 klass
= std::string (lookup_name
, last
- lookup_name
);
4078 /* Skip past the scope operator. */
4079 last
+= strlen (scope_op
);
4082 /* Find a list of classes named KLASS. */
4083 classes
= lookup_prefix_sym (state
, file_symtabs
, klass
.c_str ());
4084 struct cleanup
*old_chain
4085 = make_cleanup (VEC_cleanup (symbolp
), &classes
);
4087 if (!VEC_empty (symbolp
, classes
))
4089 /* Now locate a list of suitable methods named METHOD. */
4092 find_method (state
, file_symtabs
,
4093 klass
.c_str (), method
.c_str (),
4094 classes
, symbols
, minsyms
);
4097 /* If successful, we're done. If NOT_FOUND_ERROR
4098 was not thrown, rethrow the exception that we did get. */
4099 CATCH (except
, RETURN_MASK_ERROR
)
4101 if (except
.error
!= NOT_FOUND_ERROR
)
4102 throw_exception (except
);
4107 do_cleanups (old_chain
);
4111 /* Helper for find_label_symbols. Find all labels that match name
4112 NAME in BLOCK. Return all labels that match in FUNCTION_SYMBOLS.
4113 Return the actual function symbol in which the label was found in
4114 LABEL_FUNC_RET. If COMPLETION_MODE is true, then NAME is
4115 interpreted as a label name prefix. Otherwise, only a label named
4116 exactly NAME match. */
4119 find_label_symbols_in_block (const struct block
*block
,
4120 const char *name
, struct symbol
*fn_sym
,
4121 bool completion_mode
,
4122 VEC (symbolp
) **result
,
4123 VEC (symbolp
) **label_funcs_ret
)
4125 if (completion_mode
)
4127 struct block_iterator iter
;
4129 size_t name_len
= strlen (name
);
4131 int (*cmp
) (const char *, const char *, size_t);
4132 cmp
= case_sensitivity
== case_sensitive_on
? strncmp
: strncasecmp
;
4134 ALL_BLOCK_SYMBOLS (block
, iter
, sym
)
4136 if (symbol_matches_domain (SYMBOL_LANGUAGE (sym
),
4137 SYMBOL_DOMAIN (sym
), LABEL_DOMAIN
)
4138 && cmp (SYMBOL_SEARCH_NAME (sym
), name
, name_len
) == 0)
4140 VEC_safe_push (symbolp
, *result
, sym
);
4141 VEC_safe_push (symbolp
, *label_funcs_ret
, fn_sym
);
4147 struct symbol
*sym
= lookup_symbol (name
, block
, LABEL_DOMAIN
, 0).symbol
;
4151 VEC_safe_push (symbolp
, *result
, sym
);
4152 VEC_safe_push (symbolp
, *label_funcs_ret
, fn_sym
);
4157 /* Return all labels that match name NAME in FUNCTION_SYMBOLS. Return
4158 the actual function symbol in which the label was found in
4159 LABEL_FUNC_RET. If COMPLETION_MODE is true, then NAME is
4160 interpreted as a label name prefix. Otherwise, only labels named
4161 exactly NAME match. */
4163 static VEC (symbolp
) *
4164 find_label_symbols (struct linespec_state
*self
,
4165 VEC (symbolp
) *function_symbols
,
4166 VEC (symbolp
) **label_funcs_ret
, const char *name
,
4167 bool completion_mode
)
4170 const struct block
*block
;
4172 struct symbol
*fn_sym
;
4173 VEC (symbolp
) *result
= NULL
;
4175 if (function_symbols
== NULL
)
4177 set_current_program_space (self
->program_space
);
4178 block
= get_current_search_block ();
4181 block
&& !BLOCK_FUNCTION (block
);
4182 block
= BLOCK_SUPERBLOCK (block
))
4186 fn_sym
= BLOCK_FUNCTION (block
);
4188 find_label_symbols_in_block (block
, name
, fn_sym
, completion_mode
,
4189 &result
, label_funcs_ret
);
4194 VEC_iterate (symbolp
, function_symbols
, ix
, fn_sym
); ++ix
)
4196 set_current_program_space (SYMTAB_PSPACE (symbol_symtab (fn_sym
)));
4197 block
= SYMBOL_BLOCK_VALUE (fn_sym
);
4199 find_label_symbols_in_block (block
, name
, fn_sym
, completion_mode
,
4200 &result
, label_funcs_ret
);
4209 /* A helper for create_sals_line_offset that handles the 'list_mode' case. */
4212 decode_digits_list_mode (struct linespec_state
*self
,
4214 struct symtabs_and_lines
*values
,
4215 struct symtab_and_line val
)
4220 gdb_assert (self
->list_mode
);
4222 for (ix
= 0; VEC_iterate (symtab_ptr
, ls
->file_symtabs
, ix
, elt
);
4225 /* The logic above should ensure this. */
4226 gdb_assert (elt
!= NULL
);
4228 set_current_program_space (SYMTAB_PSPACE (elt
));
4230 /* Simplistic search just for the list command. */
4231 val
.symtab
= find_line_symtab (elt
, val
.line
, NULL
, NULL
);
4232 if (val
.symtab
== NULL
)
4234 val
.pspace
= SYMTAB_PSPACE (elt
);
4236 val
.explicit_line
= 1;
4238 add_sal_to_sals (self
, values
, &val
, NULL
, 0);
4242 /* A helper for create_sals_line_offset that iterates over the symtabs,
4243 adding lines to the VEC. */
4246 decode_digits_ordinary (struct linespec_state
*self
,
4249 struct symtabs_and_lines
*sals
,
4250 struct linetable_entry
**best_entry
)
4255 for (ix
= 0; VEC_iterate (symtab_ptr
, ls
->file_symtabs
, ix
, elt
); ++ix
)
4257 std::vector
<CORE_ADDR
> pcs
;
4259 /* The logic above should ensure this. */
4260 gdb_assert (elt
!= NULL
);
4262 set_current_program_space (SYMTAB_PSPACE (elt
));
4264 pcs
= find_pcs_for_symtab_line (elt
, line
, best_entry
);
4265 for (CORE_ADDR pc
: pcs
)
4267 struct symtab_and_line sal
;
4270 sal
.pspace
= SYMTAB_PSPACE (elt
);
4274 add_sal_to_sals_basic (sals
, &sal
);
4281 /* Return the line offset represented by VARIABLE. */
4283 static struct line_offset
4284 linespec_parse_variable (struct linespec_state
*self
, const char *variable
)
4288 struct line_offset offset
= {0, LINE_OFFSET_NONE
};
4290 p
= (variable
[1] == '$') ? variable
+ 2 : variable
+ 1;
4293 while (*p
>= '0' && *p
<= '9')
4295 if (!*p
) /* Reached end of token without hitting non-digit. */
4297 /* We have a value history reference. */
4298 struct value
*val_history
;
4300 sscanf ((variable
[1] == '$') ? variable
+ 2 : variable
+ 1, "%d", &index
);
4302 = access_value_history ((variable
[1] == '$') ? -index
: index
);
4303 if (TYPE_CODE (value_type (val_history
)) != TYPE_CODE_INT
)
4304 error (_("History values used in line "
4305 "specs must have integer values."));
4306 offset
.offset
= value_as_long (val_history
);
4310 /* Not all digits -- may be user variable/function or a
4311 convenience variable. */
4313 struct internalvar
*ivar
;
4315 /* Try it as a convenience variable. If it is not a convenience
4316 variable, return and allow normal symbol lookup to occur. */
4317 ivar
= lookup_only_internalvar (variable
+ 1);
4319 /* No internal variable with that name. Mark the offset
4320 as unknown to allow the name to be looked up as a symbol. */
4321 offset
.sign
= LINE_OFFSET_UNKNOWN
;
4324 /* We found a valid variable name. If it is not an integer,
4326 if (!get_internalvar_integer (ivar
, &valx
))
4327 error (_("Convenience variables used in line "
4328 "specs must have integer values."));
4330 offset
.offset
= valx
;
4338 /* We've found a minimal symbol MSYMBOL in OBJFILE to associate with our
4339 linespec; return the SAL in RESULT. This function should return SALs
4340 matching those from find_function_start_sal, otherwise false
4341 multiple-locations breakpoints could be placed. */
4344 minsym_found (struct linespec_state
*self
, struct objfile
*objfile
,
4345 struct minimal_symbol
*msymbol
,
4346 struct symtabs_and_lines
*result
)
4348 struct gdbarch
*gdbarch
= get_objfile_arch (objfile
);
4350 struct symtab_and_line sal
;
4352 sal
= find_pc_sect_line (MSYMBOL_VALUE_ADDRESS (objfile
, msymbol
),
4353 (struct obj_section
*) 0, 0);
4354 sal
.section
= MSYMBOL_OBJ_SECTION (objfile
, msymbol
);
4356 /* The minimal symbol might point to a function descriptor;
4357 resolve it to the actual code address instead. */
4358 pc
= gdbarch_convert_from_func_ptr_addr (gdbarch
, sal
.pc
, ¤t_target
);
4360 sal
= find_pc_sect_line (pc
, NULL
, 0);
4362 if (self
->funfirstline
)
4364 if (sal
.symtab
!= NULL
4365 && (COMPUNIT_LOCATIONS_VALID (SYMTAB_COMPUNIT (sal
.symtab
))
4366 || SYMTAB_LANGUAGE (sal
.symtab
) == language_asm
))
4368 /* If gdbarch_convert_from_func_ptr_addr does not apply then
4369 sal.SECTION, sal.LINE&co. will stay correct from above.
4370 If gdbarch_convert_from_func_ptr_addr applies then
4371 sal.SECTION is cleared from above and sal.LINE&co. will
4372 stay correct from the last find_pc_sect_line above. */
4373 sal
.pc
= MSYMBOL_VALUE_ADDRESS (objfile
, msymbol
);
4374 sal
.pc
= gdbarch_convert_from_func_ptr_addr (gdbarch
, sal
.pc
,
4376 if (gdbarch_skip_entrypoint_p (gdbarch
))
4377 sal
.pc
= gdbarch_skip_entrypoint (gdbarch
, sal
.pc
);
4380 skip_prologue_sal (&sal
);
4383 if (maybe_add_address (self
->addr_set
, objfile
->pspace
, sal
.pc
))
4384 add_sal_to_sals (self
, result
, &sal
, MSYMBOL_NATURAL_NAME (msymbol
), 0);
4387 /* A helper struct to pass some data through
4388 iterate_over_minimal_symbols. */
4390 struct collect_minsyms
4392 /* The objfile we're examining. */
4393 struct objfile
*objfile
;
4395 /* Only search the given symtab, or NULL to search for all symbols. */
4396 struct symtab
*symtab
;
4398 /* The funfirstline setting from the initial call. */
4401 /* The list_mode setting from the initial call. */
4404 /* The resulting symbols. */
4405 VEC (bound_minimal_symbol_d
) *msyms
;
4408 /* A helper function to classify a minimal_symbol_type according to
4412 classify_mtype (enum minimal_symbol_type t
)
4419 /* Intermediate priority. */
4422 case mst_solib_trampoline
:
4423 /* Lowest priority. */
4427 /* Highest priority. */
4432 /* Callback for qsort that sorts symbols by priority. */
4435 compare_msyms (const void *a
, const void *b
)
4437 const bound_minimal_symbol_d
*moa
= (const bound_minimal_symbol_d
*) a
;
4438 const bound_minimal_symbol_d
*mob
= (const bound_minimal_symbol_d
*) b
;
4439 enum minimal_symbol_type ta
= MSYMBOL_TYPE (moa
->minsym
);
4440 enum minimal_symbol_type tb
= MSYMBOL_TYPE (mob
->minsym
);
4442 return classify_mtype (ta
) - classify_mtype (tb
);
4445 /* Callback for iterate_over_minimal_symbols that adds the symbol to
4449 add_minsym (struct minimal_symbol
*minsym
, void *d
)
4451 struct collect_minsyms
*info
= (struct collect_minsyms
*) d
;
4452 bound_minimal_symbol_d mo
;
4455 mo
.objfile
= info
->objfile
;
4457 if (info
->symtab
!= NULL
)
4460 struct symtab_and_line sal
;
4461 struct gdbarch
*gdbarch
= get_objfile_arch (info
->objfile
);
4463 sal
= find_pc_sect_line (MSYMBOL_VALUE_ADDRESS (info
->objfile
, minsym
),
4465 sal
.section
= MSYMBOL_OBJ_SECTION (info
->objfile
, minsym
);
4467 = gdbarch_convert_from_func_ptr_addr (gdbarch
, sal
.pc
, ¤t_target
);
4469 sal
= find_pc_sect_line (pc
, NULL
, 0);
4471 if (info
->symtab
!= sal
.symtab
)
4475 /* Exclude data symbols when looking for breakpoint locations. */
4476 if (!info
->list_mode
)
4477 switch (minsym
->type
)
4479 case mst_slot_got_plt
:
4486 /* Make sure this minsym is not a function descriptor
4487 before we decide to discard it. */
4488 struct gdbarch
*gdbarch
= get_objfile_arch (info
->objfile
);
4489 CORE_ADDR addr
= gdbarch_convert_from_func_ptr_addr
4490 (gdbarch
, BMSYMBOL_VALUE_ADDRESS (mo
),
4493 if (addr
== BMSYMBOL_VALUE_ADDRESS (mo
))
4498 VEC_safe_push (bound_minimal_symbol_d
, info
->msyms
, &mo
);
4501 /* Search for minimal symbols called NAME. If SEARCH_PSPACE
4502 is not NULL, the search is restricted to just that program
4505 If SYMTAB is NULL, search all objfiles, otherwise
4506 restrict results to the given SYMTAB. */
4509 search_minsyms_for_name (struct collect_info
*info
, const char *name
,
4510 struct program_space
*search_pspace
,
4511 struct symtab
*symtab
)
4513 struct collect_minsyms local
;
4514 struct cleanup
*cleanup
;
4516 memset (&local
, 0, sizeof (local
));
4517 local
.funfirstline
= info
->state
->funfirstline
;
4518 local
.list_mode
= info
->state
->list_mode
;
4519 local
.symtab
= symtab
;
4521 cleanup
= make_cleanup (VEC_cleanup (bound_minimal_symbol_d
), &local
.msyms
);
4525 struct program_space
*pspace
;
4527 ALL_PSPACES (pspace
)
4529 struct objfile
*objfile
;
4531 if (search_pspace
!= NULL
&& search_pspace
!= pspace
)
4533 if (pspace
->executing_startup
)
4536 set_current_program_space (pspace
);
4538 ALL_OBJFILES (objfile
)
4540 local
.objfile
= objfile
;
4541 iterate_over_minimal_symbols (objfile
, name
, add_minsym
, &local
);
4547 if (search_pspace
== NULL
|| SYMTAB_PSPACE (symtab
) == search_pspace
)
4549 set_current_program_space (SYMTAB_PSPACE (symtab
));
4550 local
.objfile
= SYMTAB_OBJFILE(symtab
);
4551 iterate_over_minimal_symbols (local
.objfile
, name
, add_minsym
,
4556 if (!VEC_empty (bound_minimal_symbol_d
, local
.msyms
))
4560 bound_minimal_symbol_d
*item
;
4562 qsort (VEC_address (bound_minimal_symbol_d
, local
.msyms
),
4563 VEC_length (bound_minimal_symbol_d
, local
.msyms
),
4564 sizeof (bound_minimal_symbol_d
),
4567 /* Now the minsyms are in classification order. So, we walk
4568 over them and process just the minsyms with the same
4569 classification as the very first minsym in the list. */
4570 item
= VEC_index (bound_minimal_symbol_d
, local
.msyms
, 0);
4571 classification
= classify_mtype (MSYMBOL_TYPE (item
->minsym
));
4574 VEC_iterate (bound_minimal_symbol_d
, local
.msyms
, ix
, item
);
4577 if (classify_mtype (MSYMBOL_TYPE (item
->minsym
)) != classification
)
4580 VEC_safe_push (bound_minimal_symbol_d
,
4581 info
->result
.minimal_symbols
, item
);
4585 do_cleanups (cleanup
);
4588 /* A helper function to add all symbols matching NAME to INFO. If
4589 PSPACE is not NULL, the search is restricted to just that program
4593 add_matching_symbols_to_info (const char *name
,
4594 struct collect_info
*info
,
4595 struct program_space
*pspace
)
4600 for (ix
= 0; VEC_iterate (symtab_ptr
, info
->file_symtabs
, ix
, elt
); ++ix
)
4604 iterate_over_all_matching_symtabs (info
->state
, name
, VAR_DOMAIN
,
4605 pspace
, true, [&] (symbol
*sym
)
4606 { return info
->add_symbol (sym
); });
4607 search_minsyms_for_name (info
, name
, pspace
, NULL
);
4609 else if (pspace
== NULL
|| pspace
== SYMTAB_PSPACE (elt
))
4611 int prev_len
= VEC_length (symbolp
, info
->result
.symbols
);
4613 /* Program spaces that are executing startup should have
4614 been filtered out earlier. */
4615 gdb_assert (!SYMTAB_PSPACE (elt
)->executing_startup
);
4616 set_current_program_space (SYMTAB_PSPACE (elt
));
4617 iterate_over_file_blocks (elt
, name
, VAR_DOMAIN
, [&] (symbol
*sym
)
4618 { return info
->add_symbol (sym
); });
4620 /* If no new symbols were found in this iteration and this symtab
4621 is in assembler, we might actually be looking for a label for
4622 which we don't have debug info. Check for a minimal symbol in
4624 if (prev_len
== VEC_length (symbolp
, info
->result
.symbols
)
4625 && elt
->language
== language_asm
)
4626 search_minsyms_for_name (info
, name
, pspace
, elt
);
4633 /* Now come some functions that are called from multiple places within
4637 symbol_to_sal (struct symtab_and_line
*result
,
4638 int funfirstline
, struct symbol
*sym
)
4640 if (SYMBOL_CLASS (sym
) == LOC_BLOCK
)
4642 *result
= find_function_start_sal (sym
, funfirstline
);
4647 if (SYMBOL_CLASS (sym
) == LOC_LABEL
&& SYMBOL_VALUE_ADDRESS (sym
) != 0)
4650 result
->symtab
= symbol_symtab (sym
);
4651 result
->line
= SYMBOL_LINE (sym
);
4652 result
->pc
= SYMBOL_VALUE_ADDRESS (sym
);
4653 result
->pspace
= SYMTAB_PSPACE (result
->symtab
);
4654 result
->explicit_pc
= 1;
4657 else if (funfirstline
)
4661 else if (SYMBOL_LINE (sym
) != 0)
4663 /* We know its line number. */
4665 result
->symtab
= symbol_symtab (sym
);
4666 result
->line
= SYMBOL_LINE (sym
);
4667 result
->pspace
= SYMTAB_PSPACE (result
->symtab
);
4675 linespec_result::~linespec_result ()
4678 struct linespec_sals
*lsal
;
4680 for (i
= 0; VEC_iterate (linespec_sals
, sals
, i
, lsal
); ++i
)
4682 xfree (lsal
->canonical
);
4683 xfree (lsal
->sals
.sals
);
4685 VEC_free (linespec_sals
, sals
);
4688 /* Return the quote characters permitted by the linespec parser. */
4691 get_gdb_linespec_parser_quote_characters (void)
4693 return linespec_quote_characters
;