Commit | Line | Data |
---|---|---|
c5f0f3d0 | 1 | /* Header for GDB line completion. |
ecd75fc8 | 2 | Copyright (C) 2000-2014 Free Software Foundation, Inc. |
c5f0f3d0 FN |
3 | |
4 | This program is free software; you can redistribute it and/or modify | |
5 | it under the terms of the GNU General Public License as published by | |
a9762ec7 | 6 | the Free Software Foundation; either version 3 of the License, or |
c5f0f3d0 FN |
7 | (at your option) any later version. |
8 | ||
9 | This program is distributed in the hope that it will be useful, | |
10 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
12 | GNU General Public License for more details. | |
13 | ||
14 | You should have received a copy of the GNU General Public License | |
a9762ec7 | 15 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
c5f0f3d0 FN |
16 | |
17 | #if !defined (LINESPEC_H) | |
18 | #define LINESPEC_H 1 | |
19 | ||
da3331ec AC |
20 | struct symtab; |
21 | ||
f8eba3c6 TT |
22 | #include "vec.h" |
23 | ||
24 | /* Flags to pass to decode_line_1 and decode_line_full. */ | |
25 | ||
26 | enum decode_line_flags | |
27 | { | |
28 | /* Set this flag if you want the resulting SALs to describe the | |
29 | first line of indicated functions. */ | |
30 | DECODE_LINE_FUNFIRSTLINE = 1, | |
31 | ||
32 | /* Set this flag if you want "list mode". In this mode, a | |
33 | FILE:LINE linespec will always return a result, and such | |
34 | linespecs will not be expanded to all matches. */ | |
35 | DECODE_LINE_LIST_MODE = 2 | |
36 | }; | |
37 | ||
38 | /* decode_line_full returns a vector of these. */ | |
39 | ||
40 | struct linespec_sals | |
41 | { | |
42 | /* This is the linespec corresponding to the sals contained in this | |
43 | object. It can be passed as the FILTER argument to future calls | |
44 | to decode_line_full. This is freed by | |
45 | destroy_linespec_result. */ | |
46 | char *canonical; | |
47 | ||
48 | /* Sals. The 'sals' field is destroyed by | |
49 | destroy_linespec_result. */ | |
50 | struct symtabs_and_lines sals; | |
51 | }; | |
52 | ||
53 | typedef struct linespec_sals linespec_sals; | |
54 | DEF_VEC_O (linespec_sals); | |
55 | ||
7efd8fc2 | 56 | /* An instance of this may be filled in by decode_line_1. The caller |
f8eba3c6 TT |
57 | must call init_linespec_result to initialize it and |
58 | destroy_linespec_result to destroy it. The caller must make copies | |
59 | of any data that it needs to keep. */ | |
7efd8fc2 TT |
60 | |
61 | struct linespec_result | |
62 | { | |
56435ebe TT |
63 | /* If non-zero, the linespec should be displayed to the user. This |
64 | is used by "unusual" linespecs where the ordinary `info break' | |
65 | display mechanism would do the wrong thing. */ | |
66 | int special_display; | |
67 | ||
f8eba3c6 TT |
68 | /* If non-zero, the linespec result should be considered to be a |
69 | "pre-expanded" multi-location linespec. A pre-expanded linespec | |
70 | holds all matching locations in a single linespec_sals | |
71 | object. */ | |
72 | int pre_expanded; | |
73 | ||
74 | /* If PRE_EXPANDED is non-zero, this is set to the linespec entered | |
75 | by the user. This will be freed by destroy_linespec_result. */ | |
76 | char *addr_string; | |
77 | ||
78 | /* The sals. The vector will be freed by | |
79 | destroy_linespec_result. */ | |
80 | VEC (linespec_sals) *sals; | |
7efd8fc2 TT |
81 | }; |
82 | ||
83 | /* Initialize a linespec_result. */ | |
84 | ||
85 | extern void init_linespec_result (struct linespec_result *); | |
86 | ||
f8eba3c6 TT |
87 | /* Destroy a linespec_result. */ |
88 | ||
89 | extern void destroy_linespec_result (struct linespec_result *); | |
90 | ||
91 | /* Return a cleanup that destroys a linespec_result. */ | |
92 | ||
93 | extern struct cleanup * | |
94 | make_cleanup_destroy_linespec_result (struct linespec_result *); | |
95 | ||
39cf75f7 DE |
96 | /* Decode a linespec using the provided default symtab and line. */ |
97 | ||
c5f0f3d0 | 98 | extern struct symtabs_and_lines |
f8eba3c6 TT |
99 | decode_line_1 (char **argptr, int flags, |
100 | struct symtab *default_symtab, int default_line); | |
101 | ||
102 | /* Parse *ARGPTR as a linespec and return results. This is the "full" | |
103 | interface to this module, which handles multiple results | |
104 | properly. | |
105 | ||
106 | For FLAGS, see decode_line_flags. DECODE_LINE_LIST_MODE is not | |
107 | valid for this function. | |
108 | ||
109 | DEFAULT_SYMTAB and DEFAULT_LINE describe the default location. | |
110 | DEFAULT_SYMTAB can be NULL, in which case the current symtab and | |
111 | line are used. | |
112 | ||
113 | CANONICAL is where the results are stored. It must not be NULL. | |
114 | ||
115 | SELECT_MODE must be one of the multiple_symbols_* constants, or | |
116 | NULL. It determines how multiple results will be handled. If | |
117 | NULL, the appropriate CLI value will be used. | |
118 | ||
119 | FILTER can either be NULL or a string holding a canonical name. | |
120 | This is only valid when SELECT_MODE is multiple_symbols_all. | |
121 | ||
122 | Multiple results are handled differently depending on the | |
123 | arguments: | |
124 | ||
125 | . With multiple_symbols_cancel, an exception is thrown. | |
126 | ||
127 | . With multiple_symbols_ask, a menu is presented to the user. The | |
128 | user may select none, in which case an exception is thrown; or all, | |
129 | which is handled like multiple_symbols_all, below. Otherwise, | |
130 | CANONICAL->SALS will have one entry for each name the user chose. | |
131 | ||
132 | . With multiple_symbols_all, CANONICAL->SALS will have a single | |
133 | entry describing all the matching locations. If FILTER is | |
134 | non-NULL, then only locations whose canonical name is equal (in the | |
135 | strcmp sense) to FILTER will be returned; all others will be | |
136 | filtered out. */ | |
137 | ||
138 | extern void decode_line_full (char **argptr, int flags, | |
139 | struct symtab *default_symtab, int default_line, | |
140 | struct linespec_result *canonical, | |
141 | const char *select_mode, | |
142 | const char *filter); | |
c5f0f3d0 | 143 | |
39cf75f7 DE |
144 | /* Given a string, return the line specified by it, using the current |
145 | source symtab and line as defaults. | |
146 | This is for commands like "list" and "breakpoint". */ | |
147 | ||
148 | extern struct symtabs_and_lines decode_line_with_current_source (char *, int); | |
149 | ||
150 | /* Given a string, return the line specified by it, using the last displayed | |
151 | codepoint's values as defaults, or nothing if they aren't valid. */ | |
152 | ||
153 | extern struct symtabs_and_lines decode_line_with_last_displayed (char *, int); | |
154 | ||
c5f0f3d0 | 155 | #endif /* defined (LINESPEC_H) */ |