Copyright updates for 2007.
[external/binutils.git] / gdb / stabsread.h
1 /* Include file for stabs debugging format support functions.
2    Copyright (C) 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995,
3    1996, 1997, 1999, 2000, 2001, 2002, 2003, 2007
4    Free Software Foundation, Inc.
5
6    This file is part of GDB.
7
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 2 of the License, or
11    (at your option) any later version.
12
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with this program; if not, write to the Free Software
20    Foundation, Inc., 51 Franklin Street, Fifth Floor,
21    Boston, MA 02110-1301, USA.  */
22
23 struct objfile;
24
25 /* Definitions, prototypes, etc for stabs debugging format support
26    functions.
27
28    Variables declared in this file can be defined by #define-ing
29    the name EXTERN to null.  It is used to declare variables that
30    are normally extern, but which get defined in a single module
31    using this technique.  */
32
33 #ifndef EXTERN
34 #define EXTERN extern
35 #endif
36
37 /* Hash table of global symbols whose values are not known yet.
38    They are chained thru the SYMBOL_VALUE_CHAIN, since we don't
39    have the correct data for that slot yet.
40
41    The use of the LOC_BLOCK code in this chain is nonstandard--
42    it refers to a FORTRAN common block rather than the usual meaning, and
43    the such LOC_BLOCK symbols use their fields in nonstandard ways.  */
44
45 EXTERN struct symbol *global_sym_chain[HASHSIZE];
46
47 extern void common_block_start (char *, struct objfile *);
48 extern void common_block_end (struct objfile *);
49
50 /* Kludge for xcoffread.c */
51
52 struct pending_stabs
53   {
54     int count;
55     int length;
56     char *stab[1];
57   };
58
59 EXTERN struct pending_stabs *global_stabs;
60
61 /* The type code that process_one_symbol saw on its previous invocation.
62    Used to detect pairs of N_SO symbols. */
63
64 EXTERN int previous_stab_code;
65 \f
66 /* Support for Sun changes to dbx symbol format */
67
68 /* For each identified header file, we have a table of types defined
69    in that header file.
70
71    header_files maps header file names to their type tables.
72    It is a vector of n_header_files elements.
73    Each element describes one header file.
74    It contains a vector of types.
75
76    Sometimes it can happen that the same header file produces
77    different results when included in different places.
78    This can result from conditionals or from different
79    things done before including the file.
80    When this happens, there are multiple entries for the file in this table,
81    one entry for each distinct set of results.
82    The entries are distinguished by the INSTANCE field.
83    The INSTANCE field appears in the N_BINCL and N_EXCL symbol table and is
84    used to match header-file references to their corresponding data.  */
85
86 struct header_file
87   {
88
89     /* Name of header file */
90
91     char *name;
92
93     /* Numeric code distinguishing instances of one header file that produced
94        different results when included.  It comes from the N_BINCL or N_EXCL. */
95
96     int instance;
97
98     /* Pointer to vector of types */
99
100     struct type **vector;
101
102     /* Allocated length (# elts) of that vector */
103
104     int length;
105
106   };
107
108 /* The table of header_files of this OBJFILE. */
109 #define HEADER_FILES(OBJFILE) (DBX_SYMFILE_INFO (OBJFILE)->header_files)
110
111 /* The actual length of HEADER_FILES. */
112 #define N_HEADER_FILES(OBJFILE) (DBX_SYMFILE_INFO (OBJFILE)->n_header_files)
113
114 /* The allocated lengh of HEADER_FILES. */
115 #define N_ALLOCATED_HEADER_FILES(OBJFILE) \
116   (DBX_SYMFILE_INFO (OBJFILE)->n_allocated_header_files)
117
118 /* Within each object file, various header files are assigned numbers.
119    A type is defined or referred to with a pair of numbers
120    (FILENUM,TYPENUM) where FILENUM is the number of the header file
121    and TYPENUM is the number within that header file.
122    TYPENUM is the index within the vector of types for that header file.
123
124    FILENUM == 0 is special; it refers to the main source of the object file,
125    and not to any header file.  FILENUM != 1 is interpreted by looking it up
126    in the following table, which contains indices in header_files.  */
127
128 EXTERN int *this_object_header_files;
129
130 EXTERN int n_this_object_header_files;
131
132 EXTERN int n_allocated_this_object_header_files;
133
134 extern void cleanup_undefined_types (void);
135
136 extern long read_number (char **, int);
137
138 extern struct symbol *define_symbol (CORE_ADDR, char *, int, int,
139                                      struct objfile *);
140
141 extern void stabsread_init (void);
142
143 extern void stabsread_new_init (void);
144
145 extern void start_stabs (void);
146
147 extern void end_stabs (void);
148
149 extern void finish_global_stabs (struct objfile *objfile);
150 \f
151 /* COFF files can have multiple .stab sections, if they are linked
152    using --split-by-reloc.  This linked list is used to pass the
153    information into the functions in dbxread.c.  */
154 struct stab_section_list
155   {
156     /* Next in list.  */
157     struct stab_section_list *next;
158
159     /* Stab section.  */
160     asection *section;
161   };
162 \f
163 /* Functions exported by dbxread.c.  These are not in stabsread.c because
164    they are only used by some stabs readers.  */
165
166 extern struct partial_symtab *end_psymtab (struct partial_symtab *pst,
167                                            char **include_list,
168                                            int num_includes,
169                                            int capping_symbol_offset,
170                                            CORE_ADDR capping_text,
171                                            struct partial_symtab
172                                            **dependency_list,
173                                            int number_dependencies,
174                                            int textlow_not_set);
175
176 extern void process_one_symbol (int, int, CORE_ADDR, char *,
177                                 struct section_offsets *, struct objfile *);
178
179 extern void elfstab_build_psymtabs (struct objfile *objfile,
180                                     int mainline,
181                                     asection *stabsect,
182                                     file_ptr stabstroffset,
183                                     unsigned int stabstrsize);
184
185 extern void coffstab_build_psymtabs
186   (struct objfile *objfile,
187    int mainline,
188    CORE_ADDR textaddr, unsigned int textsize,
189    struct stab_section_list *stabs,
190    file_ptr stabstroffset, unsigned int stabstrsize);
191
192 extern void stabsect_build_psymtabs
193   (struct objfile *objfile,
194    int mainline, char *stab_name, char *stabstr_name, char *text_name);
195
196 extern void elfstab_offset_sections (struct objfile *,
197                                      struct partial_symtab *);
198 extern int symbol_reference_defined (char **);
199
200 extern void ref_add (int, struct symbol *, char *, CORE_ADDR);
201
202 extern struct symbol *ref_search (int);
203
204 extern void free_header_files (void);
205
206 extern void init_header_files (void);
207
208 #undef EXTERN