1 /* Build symbol tables in GDB's internal format.
2 Copyright (C) 1986-2018 Free Software Foundation, Inc.
4 This file is part of GDB.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
19 #if !defined (BUILDSYM_H)
25 struct compunit_symtab;
28 /* This module provides definitions used for creating and adding to
29 the symbol table. These routines are called from various symbol-
30 file-reading routines.
32 They originated in dbxread.c of gdb-4.2, and were split out to
33 make xcoffread.c more maintainable by sharing code.
35 Variables declared in this file can be defined by #define-ing the
36 name EXTERN to null. It is used to declare variables that are
37 normally extern, but which get defined in a single module using
49 /* The list of sub-source-files within the current individual
50 compilation. Each file gets its own symtab with its own linetable
51 and associated info, but they all share one blockvector. */
56 /* Space for this is malloc'd. */
58 /* Space for this is malloc'd. */
59 struct linetable *line_vector;
60 int line_vector_length;
61 /* The "containing" compunit. */
62 struct buildsym_compunit *buildsym_compunit;
63 enum language language;
64 struct symtab *symtab;
67 /* Record the symbols defined for each context in a list. We don't
68 create a struct block for the context until we know how long to
71 #define PENDINGSIZE 100
77 struct symbol *symbol[PENDINGSIZE];
80 /* Stack representing unclosed lexical contexts (that will become
81 blocks, eventually). */
85 /* Outer locals at the time we entered */
87 struct pending *locals;
89 /* Pending using directives at the time we entered. */
91 struct using_direct *local_using_directives;
93 /* Pointer into blocklist as of entry */
95 struct pending_block *old_blocks;
97 /* Name of function, if any, defining context */
101 /* Expression that computes the frame base of the lexically enclosing
102 function, if any. NULL otherwise. */
104 struct dynamic_prop *static_link;
106 /* PC where this context starts */
108 CORE_ADDR start_addr;
110 /* Temp slot for exception handling. */
114 /* For error-checking matching push/pop */
120 /* The type of the record_line function. */
121 typedef void (record_line_ftype) (struct subfile *subfile, int line,
126 extern void add_symbol_to_list (struct symbol *symbol,
127 struct pending **listhead);
129 extern struct symbol *find_symbol_in_list (struct pending *list,
130 char *name, int length);
132 extern struct block *finish_block (struct symbol *symbol,
133 struct pending_block *old_blocks,
134 const struct dynamic_prop *static_link,
138 extern void record_block_range (struct block *,
139 CORE_ADDR start, CORE_ADDR end_inclusive);
141 class scoped_free_pendings
145 scoped_free_pendings () = default;
146 ~scoped_free_pendings ();
148 DISABLE_COPY_AND_ASSIGN (scoped_free_pendings);
151 extern void start_subfile (const char *name);
153 extern void patch_subfile_names (struct subfile *subfile, const char *name);
155 extern void push_subfile ();
157 extern const char *pop_subfile ();
159 extern struct block *end_symtab_get_static_block (CORE_ADDR end_addr,
163 extern struct compunit_symtab *
164 end_symtab_from_static_block (struct block *static_block,
165 int section, int expandable);
167 extern struct compunit_symtab *end_symtab (CORE_ADDR end_addr, int section);
169 extern struct compunit_symtab *end_expandable_symtab (CORE_ADDR end_addr,
172 extern void augment_type_symtab (void);
174 extern void buildsym_init ();
176 extern struct context_stack *push_context (int desc, CORE_ADDR valu);
178 extern struct context_stack pop_context ();
180 extern record_line_ftype record_line;
182 extern struct compunit_symtab *start_symtab (struct objfile *objfile,
184 const char *comp_dir,
185 CORE_ADDR start_addr,
186 enum language language);
188 extern void restart_symtab (struct compunit_symtab *cust,
189 const char *name, CORE_ADDR start_addr);
191 /* Record the name of the debug format in the current pending symbol
192 table. FORMAT must be a string with a lifetime at least as long as
193 the symtab's objfile. */
195 extern void record_debugformat (const char *format);
197 /* Record the name of the debuginfo producer (usually the compiler) in
198 the current pending symbol table. PRODUCER must be a string with a
199 lifetime at least as long as the symtab's objfile. */
201 extern void record_producer (const char *producer);
203 /* Set the name of the last source file. NAME is copied by this
206 extern void set_last_source_file (const char *name);
208 /* Fetch the name of the last source file. */
210 extern const char *get_last_source_file (void);
212 /* Return the compunit symtab object.
213 It is only valid to call this between calls to start_symtab and the
214 end_symtab* functions. */
216 extern struct compunit_symtab *buildsym_compunit_symtab (void);
218 /* Return the macro table.
219 Initialize it if this is the first use.
220 It is only valid to call this between calls to start_symtab and the
221 end_symtab* functions. */
223 extern struct macro_table *get_macro_table (void);
225 /* Set the last source start address. Can only be used between
226 start_symtab and end_symtab* calls. */
228 extern void set_last_source_start_addr (CORE_ADDR addr);
230 /* Get the last source start address. Can only be used between
231 start_symtab and end_symtab* calls. */
233 extern CORE_ADDR get_last_source_start_addr ();
235 /* Return the local using directives. */
237 extern struct using_direct **get_local_using_directives ();
239 /* Set the list of local using directives. */
241 extern void set_local_using_directives (struct using_direct *new_local);
243 /* Return the global using directives. */
245 extern struct using_direct **get_global_using_directives ();
247 /* True if the context stack is empty. */
249 extern bool outermost_context_p ();
251 /* Return the top of the context stack, or nullptr if there is an
254 extern struct context_stack *get_current_context_stack ();
256 /* Return the context stack depth. */
258 extern int get_context_stack_depth ();
260 /* Return the current subfile. */
262 extern struct subfile *get_current_subfile ();
264 /* Return the local symbol list. */
266 extern struct pending **get_local_symbols ();
268 /* Return the file symbol list. */
270 extern struct pending **get_file_symbols ();
272 /* Return the global symbol list. */
274 extern struct pending **get_global_symbols ();
278 #endif /* defined (BUILDSYM_H) */