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 EXTERN
struct subfile
*current_subfile
;
69 /* Record the symbols defined for each context in a list. We don't
70 create a struct block for the context until we know how long to
73 #define PENDINGSIZE 100
79 struct symbol
*symbol
[PENDINGSIZE
];
82 /* Here are the three lists that symbols are put on. */
84 /* static at top level, and types */
86 EXTERN
struct pending
*file_symbols
;
88 /* global functions and variables */
90 EXTERN
struct pending
*global_symbols
;
92 /* everything local to lexical context */
94 EXTERN
struct pending
*local_symbols
;
96 /* Stack representing unclosed lexical contexts (that will become
97 blocks, eventually). */
101 /* Outer locals at the time we entered */
103 struct pending
*locals
;
105 /* Pending using directives at the time we entered. */
107 struct using_direct
*local_using_directives
;
109 /* Pointer into blocklist as of entry */
111 struct pending_block
*old_blocks
;
113 /* Name of function, if any, defining context */
117 /* Expression that computes the frame base of the lexically enclosing
118 function, if any. NULL otherwise. */
120 struct dynamic_prop
*static_link
;
122 /* PC where this context starts */
124 CORE_ADDR start_addr
;
126 /* Temp slot for exception handling. */
130 /* For error-checking matching push/pop */
136 EXTERN
struct context_stack
*context_stack
;
138 /* Index of first unused entry in context stack. */
140 EXTERN
int context_stack_depth
;
142 /* Non-zero if the context stack is empty. */
143 #define outermost_context_p() (context_stack_depth == 0)
145 /* The type of the record_line function. */
146 typedef void (record_line_ftype
) (struct subfile
*subfile
, int line
,
151 extern void add_symbol_to_list (struct symbol
*symbol
,
152 struct pending
**listhead
);
154 extern struct symbol
*find_symbol_in_list (struct pending
*list
,
155 char *name
, int length
);
157 extern struct block
*finish_block (struct symbol
*symbol
,
158 struct pending
**listhead
,
159 struct pending_block
*old_blocks
,
160 const struct dynamic_prop
*static_link
,
164 extern void record_block_range (struct block
*,
165 CORE_ADDR start
, CORE_ADDR end_inclusive
);
167 class scoped_free_pendings
171 scoped_free_pendings ();
172 ~scoped_free_pendings ();
174 DISABLE_COPY_AND_ASSIGN (scoped_free_pendings
);
177 extern void start_subfile (const char *name
);
179 extern void patch_subfile_names (struct subfile
*subfile
, const char *name
);
181 extern void push_subfile ();
183 extern const char *pop_subfile ();
185 extern struct block
*end_symtab_get_static_block (CORE_ADDR end_addr
,
189 extern struct compunit_symtab
*
190 end_symtab_from_static_block (struct block
*static_block
,
191 int section
, int expandable
);
193 extern struct compunit_symtab
*end_symtab (CORE_ADDR end_addr
, int section
);
195 extern struct compunit_symtab
*end_expandable_symtab (CORE_ADDR end_addr
,
198 extern void augment_type_symtab (void);
200 extern void buildsym_init ();
202 extern struct context_stack
*push_context (int desc
, CORE_ADDR valu
);
204 extern struct context_stack
*pop_context (void);
206 extern record_line_ftype record_line
;
208 extern struct compunit_symtab
*start_symtab (struct objfile
*objfile
,
210 const char *comp_dir
,
211 CORE_ADDR start_addr
,
212 enum language language
);
214 extern void restart_symtab (struct compunit_symtab
*cust
,
215 const char *name
, CORE_ADDR start_addr
);
217 /* Record the name of the debug format in the current pending symbol
218 table. FORMAT must be a string with a lifetime at least as long as
219 the symtab's objfile. */
221 extern void record_debugformat (const char *format
);
223 /* Record the name of the debuginfo producer (usually the compiler) in
224 the current pending symbol table. PRODUCER must be a string with a
225 lifetime at least as long as the symtab's objfile. */
227 extern void record_producer (const char *producer
);
229 /* Set the name of the last source file. NAME is copied by this
232 extern void set_last_source_file (const char *name
);
234 /* Fetch the name of the last source file. */
236 extern const char *get_last_source_file (void);
238 /* Return the compunit symtab object.
239 It is only valid to call this between calls to start_symtab and the
240 end_symtab* functions. */
242 extern struct compunit_symtab
*buildsym_compunit_symtab (void);
244 /* Return the macro table.
245 Initialize it if this is the first use.
246 It is only valid to call this between calls to start_symtab and the
247 end_symtab* functions. */
249 extern struct macro_table
*get_macro_table (void);
251 /* Set the last source start address. Can only be used between
252 start_symtab and end_symtab* calls. */
254 extern void set_last_source_start_addr (CORE_ADDR addr
);
256 /* Get the last source start address. Can only be used between
257 start_symtab and end_symtab* calls. */
259 extern CORE_ADDR
get_last_source_start_addr ();
261 /* Return the local using directives. */
263 extern struct using_direct
**get_local_using_directives ();
265 /* Set the list of local using directives. */
267 extern void set_local_using_directives (struct using_direct
*new_local
);
269 /* Return the global using directives. */
271 extern struct using_direct
**get_global_using_directives ();
275 #endif /* defined (BUILDSYM_H) */