xref: /dragonfly/contrib/gdb-7/gdb/ada-lang.h (revision 92fc8b5c)
1 /* Ada language support definitions for GDB, the GNU debugger.
2 
3    Copyright (C) 1992, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
4    2007, 2008, 2009, 2010 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 3 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, see <http://www.gnu.org/licenses/>.  */
20 
21 #if !defined (ADA_LANG_H)
22 #define ADA_LANG_H 1
23 
24 struct frame_info;
25 
26 #include "value.h"
27 #include "gdbtypes.h"
28 #include "breakpoint.h"
29 
30 /* Names of specific files known to be part of the runtime
31    system and that might consider (confusing) debugging information.
32    Each name (a basic regular expression string) is followed by a
33    comma.  FIXME: Should be part of a configuration file. */
34 #if defined(__alpha__) && defined(__osf__)
35 #define ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS \
36    "^[agis]-.*\\.ad[bs]$", \
37    "/usr/shlib/libpthread\\.so",
38 #elif defined (__linux__)
39 #define ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS \
40    "^[agis]-.*\\.ad[bs]$", \
41    "/lib.*/libpthread\\.so[.0-9]*$", "/lib.*/libpthread\\.a$", \
42    "/lib.*/libc\\.so[.0-9]*$", "/lib.*/libc\\.a$",
43 #endif
44 
45 #if !defined (ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS)
46 #define ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS \
47    "^[agis]-.*\\.ad[bs]$",
48 #endif
49 
50 /* Names of compiler-generated auxiliary functions probably of no
51    interest to users. Each name (a basic regular expression string)
52    is followed by a comma. */
53 #define ADA_KNOWN_AUXILIARY_FUNCTION_NAME_PATTERNS \
54    "___clean[.$a-zA-Z0-9_]*$",
55 
56 /* The maximum number of frame levels searched for non-local,
57  * non-global symbols.  This limit exists as a precaution to prevent
58  * infinite search loops when the stack is screwed up. */
59 #define MAX_ENCLOSING_FRAME_LEVELS 7
60 
61 /* Maximum number of steps followed in looking for the ultimate
62    referent of a renaming.  This prevents certain infinite loops that
63    can otherwise result. */
64 #define MAX_RENAMING_CHAIN_LENGTH 10
65 
66 struct block;
67 
68 /* Corresponding encoded/decoded names and opcodes for Ada user-definable
69    operators. */
70 struct ada_opname_map
71 {
72   const char *encoded;
73   const char *decoded;
74   enum exp_opcode op;
75 };
76 
77 /* Table of Ada operators in encoded and decoded forms. */
78 /* Defined in ada-lang.c */
79 extern const struct ada_opname_map ada_opname_table[];
80 
81 /* A tuple, (symbol, block), representing one instance of a
82  * symbol-lookup operation. */
83 struct ada_symbol_info {
84   struct symbol* sym;
85   struct block* block;
86 };
87 
88 /* Denotes a type of renaming symbol (see ada_parse_renaming).  */
89 enum ada_renaming_category
90   {
91     /* Indicates a symbol that does not encode a renaming.  */
92     ADA_NOT_RENAMING,
93 
94     /* For symbols declared
95          Foo : TYPE renamed OBJECT;  */
96     ADA_OBJECT_RENAMING,
97 
98     /* For symbols declared
99          Foo : exception renames EXCEPTION;  */
100     ADA_EXCEPTION_RENAMING,
101     /* For packages declared
102           package Foo renames PACKAGE; */
103     ADA_PACKAGE_RENAMING,
104     /* For subprograms declared
105           SUBPROGRAM_SPEC renames SUBPROGRAM;
106        (Currently not used).  */
107     ADA_SUBPROGRAM_RENAMING
108   };
109 
110 /* Ada task structures.  */
111 
112 struct ada_task_info
113 {
114   /* The PTID of the thread that this task runs on.  This ptid is computed
115      in a target-dependent way from the associated Task Control Block.  */
116   ptid_t ptid;
117 
118   /* The ID of the task.  */
119   CORE_ADDR task_id;
120 
121   /* The name of the task.  */
122   char name[257];
123 
124   /* The current state of the task.  */
125   int state;
126 
127   /* The priority associated to the task.  */
128   int priority;
129 
130   /* If non-zero, the task ID of the parent task.  */
131   CORE_ADDR parent;
132 
133   /* If the task is waiting on a task entry, this field contains
134      the ID of the other task.  Zero otherwise.  */
135   CORE_ADDR called_task;
136 
137   /* If the task is accepting a rendezvous with another task, this field
138      contains the ID of the calling task.  Zero otherwise.  */
139   CORE_ADDR caller_task;
140 };
141 
142 /* Assuming V points to an array of S objects,  make sure that it contains at
143    least M objects, updating V and S as necessary. */
144 
145 #define GROW_VECT(v, s, m)                                              \
146    if ((s) < (m)) (v) = grow_vect (v, &(s), m, sizeof *(v));
147 
148 extern void *grow_vect (void *, size_t *, size_t, int);
149 
150 extern int ada_get_field_index (const struct type *type,
151                                 const char *field_name,
152                                 int maybe_missing);
153 
154 extern int ada_parse (void);    /* Defined in ada-exp.y */
155 
156 extern void ada_error (char *); /* Defined in ada-exp.y */
157 
158                         /* Defined in ada-typeprint.c */
159 extern void ada_print_type (struct type *, const char *, struct ui_file *, int,
160                             int);
161 
162 extern void ada_print_typedef (struct type *type, struct symbol *new_symbol,
163 			       struct ui_file *stream);
164 
165 extern int ada_val_print (struct type *, const gdb_byte *, int, CORE_ADDR,
166                           struct ui_file *, int,
167 			  const struct value *,
168 			  const struct value_print_options *);
169 
170 extern int ada_value_print (struct value *, struct ui_file *,
171 			    const struct value_print_options *);
172 
173                                 /* Defined in ada-lang.c */
174 
175 extern void ada_emit_char (int, struct type *, struct ui_file *, int, int);
176 
177 extern void ada_printchar (int, struct type *, struct ui_file *);
178 
179 extern void ada_printstr (struct ui_file *, struct type *, const gdb_byte *,
180 			  unsigned int, const char *, int,
181 			  const struct value_print_options *);
182 
183 struct value *ada_convert_actual (struct value *actual,
184                                   struct type *formal_type0,
185 				  struct gdbarch *gdbarch,
186                                   CORE_ADDR *sp);
187 
188 extern struct value *ada_value_subscript (struct value *, int,
189                                           struct value **);
190 
191 extern void ada_fixup_array_indexes_type (struct type *index_desc_type);
192 
193 extern struct type *ada_array_element_type (struct type *, int);
194 
195 extern int ada_array_arity (struct type *);
196 
197 struct type *ada_type_of_array (struct value *, int);
198 
199 extern struct value *ada_coerce_to_simple_array_ptr (struct value *);
200 
201 extern int ada_is_simple_array_type (struct type *);
202 
203 extern int ada_is_array_descriptor_type (struct type *);
204 
205 extern int ada_is_bogus_array_descriptor (struct type *);
206 
207 extern LONGEST ada_discrete_type_low_bound (struct type *);
208 
209 extern LONGEST ada_discrete_type_high_bound (struct type *);
210 
211 extern char *ada_decode_symbol (const struct general_symbol_info*);
212 
213 extern const char *ada_decode (const char*);
214 
215 extern enum language ada_update_initial_language (enum language);
216 
217 extern void clear_ada_sym_cache (void);
218 
219 extern int ada_lookup_symbol_list (const char *, const struct block *,
220                                    domain_enum, struct ada_symbol_info**);
221 
222 extern char *ada_fold_name (const char *);
223 
224 extern struct symbol *ada_lookup_symbol (const char *, const struct block *,
225                                          domain_enum, int *);
226 
227 extern struct symbol *
228 ada_lookup_encoded_symbol (const char *, const struct block *,
229 			   domain_enum namespace, struct block **);
230 
231 extern struct minimal_symbol *ada_lookup_simple_minsym (const char *);
232 
233 extern void ada_fill_in_ada_prototype (struct symbol *);
234 
235 extern int user_select_syms (struct ada_symbol_info *, int, int);
236 
237 extern int get_selections (int *, int, int, int, char *);
238 
239 extern char *ada_start_decode_line_1 (char *);
240 
241 extern struct symtabs_and_lines ada_finish_decode_line_1 (char **,
242                                                           struct symtab *,
243                                                           int, char ***);
244 
245 extern struct symtabs_and_lines ada_sals_for_line (const char*, int,
246 						   int, char***, int);
247 
248 extern int ada_scan_number (const char *, int, LONGEST *, int *);
249 
250 extern struct type *ada_parent_type (struct type *);
251 
252 extern int ada_is_ignored_field (struct type *, int);
253 
254 extern int ada_is_constrained_packed_array_type (struct type *);
255 
256 extern struct value *ada_value_primitive_packed_val (struct value *,
257 						     const gdb_byte *,
258                                                      long, int, int,
259                                                      struct type *);
260 
261 extern struct type *ada_coerce_to_simple_array_type (struct type *);
262 
263 extern int ada_is_character_type (struct type *);
264 
265 extern int ada_is_string_type (struct type *);
266 
267 extern int ada_is_tagged_type (struct type *, int);
268 
269 extern int ada_is_tag_type (struct type *);
270 
271 extern struct type *ada_tag_type (struct value *);
272 
273 extern struct value *ada_value_tag (struct value *);
274 
275 extern const char *ada_tag_name (struct value *);
276 
277 extern int ada_is_parent_field (struct type *, int);
278 
279 extern int ada_is_wrapper_field (struct type *, int);
280 
281 extern int ada_is_variant_part (struct type *, int);
282 
283 extern struct type *ada_variant_discrim_type (struct type *, struct type *);
284 
285 extern int ada_is_others_clause (struct type *, int);
286 
287 extern int ada_in_variant (LONGEST, struct type *, int);
288 
289 extern char *ada_variant_discrim_name (struct type *);
290 
291 extern struct value *ada_value_struct_elt (struct value *, char *, int);
292 
293 extern int ada_is_aligner_type (struct type *);
294 
295 extern struct type *ada_aligned_type (struct type *);
296 
297 extern const gdb_byte *ada_aligned_value_addr (struct type *,
298 					       const gdb_byte *);
299 
300 extern const char *ada_attribute_name (enum exp_opcode);
301 
302 extern int ada_is_fixed_point_type (struct type *);
303 
304 extern int ada_is_system_address_type (struct type *);
305 
306 extern DOUBLEST ada_delta (struct type *);
307 
308 extern DOUBLEST ada_fixed_to_float (struct type *, LONGEST);
309 
310 extern LONGEST ada_float_to_fixed (struct type *, DOUBLEST);
311 
312 extern struct type *ada_system_address_type (void);
313 
314 extern int ada_which_variant_applies (struct type *, struct type *,
315 				      const gdb_byte *);
316 
317 extern struct type *ada_to_fixed_type (struct type *, const gdb_byte *,
318 				       CORE_ADDR, struct value *,
319                                        int check_tag);
320 
321 extern struct value *ada_to_fixed_value (struct value *val);
322 
323 extern struct type *ada_template_to_fixed_record_type_1 (struct type *type,
324 							 const gdb_byte *valaddr,
325 							 CORE_ADDR address,
326 							 struct value *dval0,
327 							 int keep_dynamic_fields);
328 
329 extern int ada_name_prefix_len (const char *);
330 
331 extern char *ada_type_name (struct type *);
332 
333 extern struct type *ada_find_parallel_type (struct type *,
334                                             const char *suffix);
335 
336 extern LONGEST get_int_var_value (char *, int *);
337 
338 extern struct symbol *ada_find_any_symbol (const char *name);
339 
340 extern struct type *ada_find_any_type (const char *name);
341 
342 extern struct symbol *ada_find_renaming_symbol (const char *name,
343                                                 struct block *block);
344 
345 extern int ada_prefer_type (struct type *, struct type *);
346 
347 extern struct type *ada_get_base_type (struct type *);
348 
349 extern struct type *ada_check_typedef (struct type *);
350 
351 extern char *ada_encode (const char *);
352 
353 extern const char *ada_enum_name (const char *);
354 
355 extern int ada_is_modular_type (struct type *);
356 
357 extern ULONGEST ada_modulus (struct type *);
358 
359 extern struct value *ada_value_ind (struct value *);
360 
361 extern void ada_print_scalar (struct type *, LONGEST, struct ui_file *);
362 
363 extern int ada_is_range_type_name (const char *);
364 
365 extern enum ada_renaming_category ada_parse_renaming (struct symbol *,
366 						      const char **,
367 						      int *, const char **);
368 
369 extern void ada_find_printable_frame (struct frame_info *fi);
370 
371 extern char *ada_breakpoint_rewrite (char *, int *);
372 
373 extern char *ada_main_name (void);
374 
375 /* Tasking-related: ada-tasks.c */
376 
377 extern int valid_task_id (int);
378 
379 extern int ada_get_task_number (ptid_t);
380 
381 extern int ada_build_task_list (int warn_if_null);
382 
383 extern int ada_exception_catchpoint_p (struct breakpoint *b);
384 
385 extern struct symtab_and_line
386   ada_decode_exception_location (char *args, char **addr_string,
387                                  char **exp_string, char **cond_string,
388                                  struct expression **cond,
389                                  struct breakpoint_ops **ops);
390 
391 extern struct symtab_and_line
392   ada_decode_assert_location (char *args, char **addr_string,
393                               struct breakpoint_ops **ops);
394 
395 
396 #endif
397