1 /* Ada language support definitions for GDB, the GNU debugger.
2    Copyright 1992, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
3    Free Software Foundation, Inc.
4 
5 This file is part of GDB.
6 
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
11 
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 GNU General Public License for more details.
16 
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
20 
21 #if !defined (ADA_LANG_H)
22 #define ADA_LANG_H 1
23 
24 struct partial_symbol;
25 struct frame_info;
26 
27 #include "value.h"
28 #include "gdbtypes.h"
29 #include "breakpoint.h"
30 
31 /* Names of specific files known to be part of the runtime
32    system and that might consider (confusing) debugging information.
33    Each name (a basic regular expression string) is followed by a
34    comma.  FIXME: Should be part of a configuration file. */
35 #if defined(__alpha__) && defined(__osf__) && !defined(VXWORKS_TARGET)
36 #define ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS \
37    "^[agis]-.*\\.ad[bs]$", \
38    "/usr/shlib/libpthread\\.so",
39 #elif defined (__linux__)
40 #define ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS \
41    "^[agis]-.*\\.ad[bs]$", \
42    "/lib.*/libpthread\\.so[.0-9]*$", "/lib.*/libpthread\\.a$", \
43    "/lib.*/libc\\.so[.0-9]*$", "/lib.*/libc\\.a$",
44 #endif
45 
46 #if !defined (ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS)
47 #define ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS \
48    "^[agis]-.*\\.ad[bs]$",
49 #endif
50 
51 /* Names of compiler-generated auxiliary functions probably of no
52    interest to users. Each name (a basic regular expression string)
53    is followed by a comma. */
54 #define ADA_KNOWN_AUXILIARY_FUNCTION_NAME_PATTERNS \
55    "___clean[.a-zA-Z0-9_]*$",
56 
57 /* The maximum number of frame levels searched for non-local,
58  * non-global symbols.  This limit exists as a precaution to prevent
59  * infinite search loops when the stack is screwed up. */
60 #define MAX_ENCLOSING_FRAME_LEVELS 7
61 
62 /* Maximum number of steps followed in looking for the ultimate
63    referent of a renaming.  This prevents certain infinite loops that
64    can otherwise result. */
65 #define MAX_RENAMING_CHAIN_LENGTH 10
66 
67 struct block;
68 
69 /* Corresponding encoded/decoded names and opcodes for Ada user-definable
70    operators. */
71 struct ada_opname_map
72 {
73   const char *encoded;
74   const char *decoded;
75   enum exp_opcode op;
76 };
77 
78 /* Table of Ada operators in encoded and decoded forms. */
79 /* Defined in ada-lang.c */
80 extern const struct ada_opname_map ada_opname_table[];
81 
82 enum ada_operator
83   {
84     /* X IN A'RANGE(N).  N is an immediate operand, surrounded by
85        BINOP_IN_BOUNDS before and after.  A is an array, X an index
86        value.  Evaluates to true iff X is within range of the Nth
87        dimension (1-based) of A.  (A multi-dimensional array
88        type is represented as array of array of ...) */
89     BINOP_IN_BOUNDS = OP_EXTENDED0,
90 
91     /* X IN L .. U.  True iff L <= X <= U.  */
92     TERNOP_IN_RANGE,
93 
94     /* Ada attributes ('Foo). */
95     OP_ATR_FIRST,
96     OP_ATR_LAST,
97     OP_ATR_LENGTH,
98     OP_ATR_IMAGE,
99     OP_ATR_MAX,
100     OP_ATR_MIN,
101     OP_ATR_MODULUS,
102     OP_ATR_POS,
103     OP_ATR_SIZE,
104     OP_ATR_TAG,
105     OP_ATR_VAL,
106 
107     /* Ada type qualification.  It is encoded as for UNOP_CAST, above,
108        and denotes the TYPE'(EXPR) construct. */
109     UNOP_QUAL,
110 
111     /* X IN TYPE.  The `TYPE' argument is immediate, with
112        UNOP_IN_RANGE before and after it. True iff X is a member of
113        type TYPE (typically a subrange). */
114     UNOP_IN_RANGE,
115 
116     /* End marker */
117     OP_ADA_LAST
118   };
119 
120 /* A triple, (symbol, block, symtab), representing one instance of a
121  * symbol-lookup operation. */
122 struct ada_symbol_info {
123   struct symbol* sym;
124   struct block* block;
125   struct symtab* symtab;
126 };
127 
128 /* Ada task structures.  */
129 
130 /* Ada task control block, as defined in the GNAT runt-time library.  */
131 
132 struct task_control_block
133 {
134   char state;
135   CORE_ADDR parent;
136   int priority;
137   char image [32];
138   int image_len;    /* This field is not always present in the ATCB.  */
139   CORE_ADDR call;
140   CORE_ADDR thread;
141   CORE_ADDR lwp;    /* This field is not always present in the ATCB.  */
142 };
143 
144 struct task_ptid
145 {
146   int pid;                      /* The Process id */
147   long lwp;                     /* The Light Weight Process id */
148   long tid;                     /* The Thread id */
149 };
150 typedef struct task_ptid task_ptid_t;
151 
152 struct task_entry
153 {
154   CORE_ADDR task_id;
155   struct task_control_block atcb;
156   int task_num;
157   int known_tasks_index;
158   struct task_entry *next_task;
159   task_ptid_t task_ptid;
160   int stack_per;
161 };
162 
163 extern struct type *builtin_type_ada_int;
164 extern struct type *builtin_type_ada_short;
165 extern struct type *builtin_type_ada_long;
166 extern struct type *builtin_type_ada_long_long;
167 extern struct type *builtin_type_ada_char;
168 extern struct type *builtin_type_ada_float;
169 extern struct type *builtin_type_ada_double;
170 extern struct type *builtin_type_ada_long_double;
171 extern struct type *builtin_type_ada_natural;
172 extern struct type *builtin_type_ada_positive;
173 extern struct type *builtin_type_ada_system_address;
174 
175 /* The maximum number of tasks known to the Ada runtime.  */
176 extern const int MAX_NUMBER_OF_KNOWN_TASKS;
177 
178 /* task entry list.  */
179 extern struct task_entry *task_list;
180 
181 
182 /* Assuming V points to an array of S objects,  make sure that it contains at
183    least M objects, updating V and S as necessary. */
184 
185 #define GROW_VECT(v, s, m)                                              \
186    if ((s) < (m)) grow_vect ((void**) &(v), &(s), (m), sizeof(*(v)));
187 
188 extern void grow_vect (void **, size_t *, size_t, int);
189 
190 extern int ada_get_field_index (const struct type *type,
191                                 const char *field_name,
192                                 int maybe_missing);
193 
194 extern int ada_parse (void);    /* Defined in ada-exp.y */
195 
196 extern void ada_error (char *); /* Defined in ada-exp.y */
197 
198                         /* Defined in ada-typeprint.c */
199 extern void ada_print_type (struct type *, char *, struct ui_file *, int,
200                             int);
201 
202 extern int ada_val_print (struct type *, char *, int, CORE_ADDR,
203                           struct ui_file *, int, int, int,
204                           enum val_prettyprint);
205 
206 extern int ada_value_print (struct value *, struct ui_file *, int,
207                             enum val_prettyprint);
208 
209                                 /* Defined in ada-lang.c */
210 
211 extern struct value *value_from_contents_and_address (struct type *, char *,
212                                                       CORE_ADDR);
213 
214 extern void ada_emit_char (int, struct ui_file *, int, int);
215 
216 extern void ada_printchar (int, struct ui_file *);
217 
218 extern void ada_printstr (struct ui_file *, char *, unsigned int, int, int);
219 
220 extern void ada_convert_actuals (struct value *, int, struct value **,
221                                  CORE_ADDR *);
222 
223 extern struct value *ada_value_subscript (struct value *, int,
224                                           struct value **);
225 
226 extern struct type *ada_array_element_type (struct type *, int);
227 
228 extern int ada_array_arity (struct type *);
229 
230 struct type *ada_type_of_array (struct value *, int);
231 
232 extern struct value *ada_coerce_to_simple_array_ptr (struct value *);
233 
234 extern int ada_is_simple_array_type (struct type *);
235 
236 extern int ada_is_array_descriptor_type (struct type *);
237 
238 extern int ada_is_bogus_array_descriptor (struct type *);
239 
240 extern struct type *ada_index_type (struct type *, int);
241 
242 extern struct value *ada_array_bound (struct value *, int, int);
243 
244 extern char *ada_decode_symbol (const struct general_symbol_info*);
245 
246 extern const char *ada_decode (const char*);
247 
248 extern enum language ada_update_initial_language (enum language,
249 						  struct partial_symtab*);
250 
251 extern void clear_ada_sym_cache (void);
252 
253 extern char **ada_make_symbol_completion_list (const char *text0,
254                                                const char *word);
255 
256 extern int ada_lookup_symbol_list (const char *, const struct block *,
257                                    domain_enum, struct ada_symbol_info**);
258 
259 extern char *ada_fold_name (const char *);
260 
261 extern struct symbol *ada_lookup_symbol (const char *, const struct block *,
262                                          domain_enum, int *,
263 					 struct symtab **);
264 
265 extern struct minimal_symbol *ada_lookup_simple_minsym (const char *);
266 
267 extern void ada_fill_in_ada_prototype (struct symbol *);
268 
269 extern int user_select_syms (struct ada_symbol_info *, int, int);
270 
271 extern int get_selections (int *, int, int, int, char *);
272 
273 extern char *ada_start_decode_line_1 (char *);
274 
275 extern struct symtabs_and_lines ada_finish_decode_line_1 (char **,
276                                                           struct symtab *,
277                                                           int, char ***);
278 
279 extern struct symtabs_and_lines ada_sals_for_line (const char*, int,
280 						   int, char***, int);
281 
282 extern int ada_scan_number (const char *, int, LONGEST *, int *);
283 
284 extern struct type *ada_parent_type (struct type *);
285 
286 extern int ada_is_ignored_field (struct type *, int);
287 
288 extern int ada_is_packed_array_type (struct type *);
289 
290 extern struct value *ada_value_primitive_packed_val (struct value *, char *,
291                                                      long, int, int,
292                                                      struct type *);
293 
294 extern struct type *ada_coerce_to_simple_array_type (struct type *);
295 
296 extern int ada_is_character_type (struct type *);
297 
298 extern int ada_is_string_type (struct type *);
299 
300 extern int ada_is_tagged_type (struct type *, int);
301 
302 extern int ada_is_tag_type (struct type *);
303 
304 extern struct type *ada_tag_type (struct value *);
305 
306 extern struct value *ada_value_tag (struct value *);
307 
308 extern const char *ada_tag_name (struct value *);
309 
310 extern int ada_is_parent_field (struct type *, int);
311 
312 extern int ada_is_wrapper_field (struct type *, int);
313 
314 extern int ada_is_variant_part (struct type *, int);
315 
316 extern struct type *ada_variant_discrim_type (struct type *, struct type *);
317 
318 extern int ada_is_others_clause (struct type *, int);
319 
320 extern int ada_in_variant (LONGEST, struct type *, int);
321 
322 extern char *ada_variant_discrim_name (struct type *);
323 
324 extern struct value *ada_value_struct_elt (struct value *, char *, char *);
325 
326 extern int ada_is_aligner_type (struct type *);
327 
328 extern struct type *ada_aligned_type (struct type *);
329 
330 extern char *ada_aligned_value_addr (struct type *, char *);
331 
332 extern const char *ada_attribute_name (enum exp_opcode);
333 
334 extern int ada_is_fixed_point_type (struct type *);
335 
336 extern int ada_is_system_address_type (struct type *);
337 
338 extern DOUBLEST ada_delta (struct type *);
339 
340 extern DOUBLEST ada_fixed_to_float (struct type *, LONGEST);
341 
342 extern LONGEST ada_float_to_fixed (struct type *, DOUBLEST);
343 
344 extern int ada_is_vax_floating_type (struct type *);
345 
346 extern int ada_vax_float_type_suffix (struct type *);
347 
348 extern struct value *ada_vax_float_print_function (struct type *);
349 
350 extern struct type *ada_system_address_type (void);
351 
352 extern int ada_which_variant_applies (struct type *, struct type *, char *);
353 
354 extern struct type *ada_to_fixed_type (struct type *, char *, CORE_ADDR,
355                                        struct value *);
356 
357 extern struct type *
358   ada_template_to_fixed_record_type_1 (struct type *type, char *valaddr,
359                                        CORE_ADDR address, struct value *dval0,
360                                        int keep_dynamic_fields);
361 
362 extern int ada_name_prefix_len (const char *);
363 
364 extern char *ada_type_name (struct type *);
365 
366 extern struct type *ada_find_parallel_type (struct type *,
367                                             const char *suffix);
368 
369 extern LONGEST get_int_var_value (char *, int *);
370 
371 extern struct symbol *ada_find_any_symbol (const char *name);
372 
373 extern struct type *ada_find_any_type (const char *name);
374 
375 extern struct symbol *ada_find_renaming_symbol (const char *name,
376                                                 struct block *block);
377 
378 extern int ada_prefer_type (struct type *, struct type *);
379 
380 extern struct type *ada_get_base_type (struct type *);
381 
382 extern struct type *ada_completed_type (struct type *);
383 
384 extern char *ada_encode (const char *);
385 
386 extern const char *ada_enum_name (const char *);
387 
388 extern int ada_is_modular_type (struct type *);
389 
390 extern LONGEST ada_modulus (struct type *);
391 
392 extern struct value *ada_value_ind (struct value *);
393 
394 extern void ada_print_scalar (struct type *, LONGEST, struct ui_file *);
395 
396 extern int ada_is_range_type_name (const char *);
397 
398 extern const char *ada_renaming_type (struct type *);
399 
400 extern int ada_is_object_renaming (struct symbol *);
401 
402 extern char *ada_simple_renamed_entity (struct symbol *);
403 
404 extern char *ada_breakpoint_rewrite (char *, int *);
405 
406 extern char *ada_main_name (void);
407 
408 /* Tasking-related: ada-tasks.c */
409 
410 extern int valid_task_id (int);
411 
412 extern void init_task_list (void);
413 
414 extern int ada_is_exception_breakpoint (bpstat bs);
415 
416 extern void ada_adjust_exception_stop (bpstat bs);
417 
418 extern void ada_print_exception_stop (bpstat bs);
419 
420 extern int ada_get_current_task (ptid_t);
421 
422 extern int breakpoint_ada_task_match (CORE_ADDR, ptid_t);
423 
424 extern int ada_print_exception_breakpoint_nontask (struct breakpoint *);
425 
426 extern void ada_print_exception_breakpoint_task (struct breakpoint *);
427 
428 extern int ada_maybe_exception_partial_symbol (struct partial_symbol *sym);
429 
430 extern int ada_is_exception_sym (struct symbol *sym);
431 
432 extern void ada_find_printable_frame (struct frame_info *fi);
433 
434 extern void ada_reset_thread_registers (void);
435 
436 extern int ada_build_task_list (void);
437 
438 /* Look up a symbol by name using the search conventions of
439    a specific language (optional block, optional symtab).
440    FIXME: Should be symtab.h. */
441 
442 extern struct symbol *lookup_symbol_in_language (const char *,
443 						 const struct block *,
444 						 domain_enum,
445 						 enum language,
446 						 int *,
447 						 struct symtab **);
448 #endif
449