gdb
[deliverable/binutils-gdb.git] / gdb / ada-lang.h
... / ...
CommitLineData
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 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
24struct partial_symbol;
25struct 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__)
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
67struct block;
68
69/* Corresponding encoded/decoded names and opcodes for Ada user-definable
70 operators. */
71struct 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 */
80extern const struct ada_opname_map ada_opname_table[];
81
82enum 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 /* An aggregate. A single immediate operand, N>0, gives
117 the number of component specifications that follow. The
118 immediate operand is followed by a second OP_AGGREGATE.
119 Next come N component specifications. A component
120 specification is either an OP_OTHERS (others=>...), an
121 OP_CHOICES (for named associations), or other expression (for
122 positional aggregates only). Aggregates currently
123 occur only as the right sides of assignments. */
124 OP_AGGREGATE,
125
126 /* An others clause. Followed by a single expression. */
127 OP_OTHERS,
128
129 /* An aggregate component association. A single immediate operand, N,
130 gives the number of choices that follow. This is followed by a second
131 OP_CHOICES operator. Next come N operands, each of which is an
132 expression, an OP_DISCRETE_RANGE, or an OP_NAME---the latter
133 for a simple name that must be a record component name and does
134 not correspond to a single existing symbol. After the N choice
135 indicators comes an expression giving the value.
136
137 In an aggregate such as (X => E1, ...), where X is a simple
138 name, X could syntactically be either a component_selector_name
139 or an expression used as a discrete_choice, depending on the
140 aggregate's type context. Since this is not known at parsing
141 time, we don't attempt to disambiguate X if it has multiple
142 definitions, but instead supply an OP_NAME. If X has a single
143 definition, we represent it with an OP_VAR_VALUE, even though
144 it may turn out to be within a record aggregate. Aggregate
145 evaluation can use either OP_NAMEs or OP_VAR_VALUEs to get a
146 record field name, and can evaluate OP_VAR_VALUE normally to
147 get its value as an expression. Unfortunately, we lose out in
148 cases where X has multiple meanings and is part of an array
149 aggregate. I hope these are not common enough to annoy users,
150 who can work around the problem in any case by putting
151 parentheses around X. */
152 OP_CHOICES,
153
154 /* A positional aggregate component association. The operator is
155 followed by a single integer indicating the position in the
156 aggregate (0-based), followed by a second OP_POSITIONAL. Next
157 follows a single expression giving the component value. */
158 OP_POSITIONAL,
159
160 /* A range of values. Followed by two expressions giving the
161 upper and lower bounds of the range. */
162 OP_DISCRETE_RANGE,
163
164 /* End marker */
165 OP_ADA_LAST
166 };
167
168/* A tuple, (symbol, block), representing one instance of a
169 * symbol-lookup operation. */
170struct ada_symbol_info {
171 struct symbol* sym;
172 struct block* block;
173};
174
175/* Denotes a type of renaming symbol (see ada_parse_renaming). */
176enum ada_renaming_category
177 {
178 /* Indicates a symbol that does not encode a renaming. */
179 ADA_NOT_RENAMING,
180
181 /* For symbols declared
182 Foo : TYPE renamed OBJECT; */
183 ADA_OBJECT_RENAMING,
184
185 /* For symbols declared
186 Foo : exception renames EXCEPTION; */
187 ADA_EXCEPTION_RENAMING,
188 /* For packages declared
189 package Foo renames PACKAGE; */
190 ADA_PACKAGE_RENAMING,
191 /* For subprograms declared
192 SUBPROGRAM_SPEC renames SUBPROGRAM;
193 (Currently not used). */
194 ADA_SUBPROGRAM_RENAMING
195 };
196
197/* Ada task structures. */
198
199/* Ada task control block, as defined in the GNAT runt-time library. */
200
201struct task_control_block
202{
203 char state;
204 CORE_ADDR parent;
205 int priority;
206 char image [32];
207 int image_len; /* This field is not always present in the ATCB. */
208 CORE_ADDR call;
209 CORE_ADDR thread;
210 CORE_ADDR lwp; /* This field is not always present in the ATCB. */
211
212 /* If the task is waiting on a task entry, this field contains the
213 task_id of the other task. */
214 CORE_ADDR called_task;
215};
216
217struct task_ptid
218{
219 int pid; /* The Process id */
220 long lwp; /* The Light Weight Process id */
221 long tid; /* The Thread id */
222};
223typedef struct task_ptid task_ptid_t;
224
225struct task_entry
226{
227 CORE_ADDR task_id;
228 struct task_control_block atcb;
229 int task_num;
230 int known_tasks_index;
231 struct task_entry *next_task;
232 task_ptid_t task_ptid;
233 int stack_per;
234};
235
236/* task entry list. */
237extern struct task_entry *task_list;
238
239
240/* Assuming V points to an array of S objects, make sure that it contains at
241 least M objects, updating V and S as necessary. */
242
243#define GROW_VECT(v, s, m) \
244 if ((s) < (m)) (v) = grow_vect (v, &(s), m, sizeof *(v));
245
246extern void *grow_vect (void *, size_t *, size_t, int);
247
248extern int ada_get_field_index (const struct type *type,
249 const char *field_name,
250 int maybe_missing);
251
252extern int ada_parse (void); /* Defined in ada-exp.y */
253
254extern void ada_error (char *); /* Defined in ada-exp.y */
255
256 /* Defined in ada-typeprint.c */
257extern void ada_print_type (struct type *, char *, struct ui_file *, int,
258 int);
259
260extern int ada_val_print (struct type *, const gdb_byte *, int, CORE_ADDR,
261 struct ui_file *, int, int, int,
262 enum val_prettyprint);
263
264extern int ada_value_print (struct value *, struct ui_file *, int,
265 enum val_prettyprint);
266
267 /* Defined in ada-lang.c */
268
269extern struct value *value_from_contents_and_address (struct type *,
270 const gdb_byte *,
271 CORE_ADDR);
272
273extern void ada_emit_char (int, struct ui_file *, int, int);
274
275extern void ada_printchar (int, struct ui_file *);
276
277extern void ada_printstr (struct ui_file *, const gdb_byte *,
278 unsigned int, int, int);
279
280struct value *ada_convert_actual (struct value *actual,
281 struct type *formal_type0,
282 CORE_ADDR *sp);
283
284extern struct value *ada_value_subscript (struct value *, int,
285 struct value **);
286
287extern struct type *ada_array_element_type (struct type *, int);
288
289extern int ada_array_arity (struct type *);
290
291struct type *ada_type_of_array (struct value *, int);
292
293extern struct value *ada_coerce_to_simple_array_ptr (struct value *);
294
295extern int ada_is_simple_array_type (struct type *);
296
297extern int ada_is_array_descriptor_type (struct type *);
298
299extern int ada_is_bogus_array_descriptor (struct type *);
300
301extern struct type *ada_index_type (struct type *, int);
302
303extern struct value *ada_array_bound (struct value *, int, int);
304
305extern char *ada_decode_symbol (const struct general_symbol_info*);
306
307extern const char *ada_decode (const char*);
308
309extern enum language ada_update_initial_language (enum language,
310 struct partial_symtab*);
311
312extern void clear_ada_sym_cache (void);
313
314extern int ada_lookup_symbol_list (const char *, const struct block *,
315 domain_enum, struct ada_symbol_info**);
316
317extern char *ada_fold_name (const char *);
318
319extern struct symbol *ada_lookup_symbol (const char *, const struct block *,
320 domain_enum, int *);
321
322extern struct symbol *
323ada_lookup_encoded_symbol (const char *, const struct block *,
324 domain_enum namespace, struct block **);
325
326extern struct minimal_symbol *ada_lookup_simple_minsym (const char *);
327
328extern void ada_fill_in_ada_prototype (struct symbol *);
329
330extern int user_select_syms (struct ada_symbol_info *, int, int);
331
332extern int get_selections (int *, int, int, int, char *);
333
334extern char *ada_start_decode_line_1 (char *);
335
336extern struct symtabs_and_lines ada_finish_decode_line_1 (char **,
337 struct symtab *,
338 int, char ***);
339
340extern struct symtabs_and_lines ada_sals_for_line (const char*, int,
341 int, char***, int);
342
343extern int ada_scan_number (const char *, int, LONGEST *, int *);
344
345extern struct type *ada_parent_type (struct type *);
346
347extern int ada_is_ignored_field (struct type *, int);
348
349extern int ada_is_packed_array_type (struct type *);
350
351extern struct value *ada_value_primitive_packed_val (struct value *,
352 const gdb_byte *,
353 long, int, int,
354 struct type *);
355
356extern struct type *ada_coerce_to_simple_array_type (struct type *);
357
358extern int ada_is_character_type (struct type *);
359
360extern int ada_is_string_type (struct type *);
361
362extern int ada_is_tagged_type (struct type *, int);
363
364extern int ada_is_tag_type (struct type *);
365
366extern struct type *ada_tag_type (struct value *);
367
368extern struct value *ada_value_tag (struct value *);
369
370extern const char *ada_tag_name (struct value *);
371
372extern int ada_is_parent_field (struct type *, int);
373
374extern int ada_is_wrapper_field (struct type *, int);
375
376extern int ada_is_variant_part (struct type *, int);
377
378extern struct type *ada_variant_discrim_type (struct type *, struct type *);
379
380extern int ada_is_others_clause (struct type *, int);
381
382extern int ada_in_variant (LONGEST, struct type *, int);
383
384extern char *ada_variant_discrim_name (struct type *);
385
386extern struct value *ada_value_struct_elt (struct value *, char *, int);
387
388extern int ada_is_aligner_type (struct type *);
389
390extern struct type *ada_aligned_type (struct type *);
391
392extern const gdb_byte *ada_aligned_value_addr (struct type *,
393 const gdb_byte *);
394
395extern const char *ada_attribute_name (enum exp_opcode);
396
397extern int ada_is_fixed_point_type (struct type *);
398
399extern int ada_is_system_address_type (struct type *);
400
401extern DOUBLEST ada_delta (struct type *);
402
403extern DOUBLEST ada_fixed_to_float (struct type *, LONGEST);
404
405extern LONGEST ada_float_to_fixed (struct type *, DOUBLEST);
406
407extern int ada_is_vax_floating_type (struct type *);
408
409extern int ada_vax_float_type_suffix (struct type *);
410
411extern struct value *ada_vax_float_print_function (struct type *);
412
413extern struct type *ada_system_address_type (void);
414
415extern int ada_which_variant_applies (struct type *, struct type *,
416 const gdb_byte *);
417
418extern struct type *ada_to_fixed_type (struct type *, const gdb_byte *,
419 CORE_ADDR, struct value *,
420 int check_tag);
421
422extern struct type *ada_template_to_fixed_record_type_1 (struct type *type,
423 const gdb_byte *valaddr,
424 CORE_ADDR address,
425 struct value *dval0,
426 int keep_dynamic_fields);
427
428extern int ada_name_prefix_len (const char *);
429
430extern char *ada_type_name (struct type *);
431
432extern struct type *ada_find_parallel_type (struct type *,
433 const char *suffix);
434
435extern LONGEST get_int_var_value (char *, int *);
436
437extern struct symbol *ada_find_any_symbol (const char *name);
438
439extern struct type *ada_find_any_type (const char *name);
440
441extern struct symbol *ada_find_renaming_symbol (const char *name,
442 struct block *block);
443
444extern int ada_prefer_type (struct type *, struct type *);
445
446extern struct type *ada_get_base_type (struct type *);
447
448extern struct type *ada_check_typedef (struct type *);
449
450extern char *ada_encode (const char *);
451
452extern const char *ada_enum_name (const char *);
453
454extern int ada_is_modular_type (struct type *);
455
456extern ULONGEST ada_modulus (struct type *);
457
458extern struct value *ada_value_ind (struct value *);
459
460extern void ada_print_scalar (struct type *, LONGEST, struct ui_file *);
461
462extern int ada_is_range_type_name (const char *);
463
464extern enum ada_renaming_category ada_parse_renaming (struct symbol *,
465 const char **,
466 int *, const char **);
467
468extern char *ada_breakpoint_rewrite (char *, int *);
469
470extern char *ada_main_name (void);
471
472/* Tasking-related: ada-tasks.c */
473
474extern int valid_task_id (int);
475
476extern void init_task_list (void);
477
478extern int ada_is_exception_breakpoint (bpstat bs);
479
480extern void ada_adjust_exception_stop (bpstat bs);
481
482extern void ada_print_exception_stop (bpstat bs);
483
484extern int ada_get_current_task (ptid_t);
485
486extern int breakpoint_ada_task_match (CORE_ADDR, ptid_t);
487
488extern int ada_print_exception_breakpoint_nontask (struct breakpoint *);
489
490extern void ada_print_exception_breakpoint_task (struct breakpoint *);
491
492extern void ada_reset_thread_registers (void);
493
494extern int ada_build_task_list (void);
495
496extern int ada_exception_catchpoint_p (struct breakpoint *b);
497
498extern struct symtab_and_line
499 ada_decode_exception_location (char *args, char **addr_string,
500 char **exp_string, char **cond_string,
501 struct expression **cond,
502 struct breakpoint_ops **ops);
503
504extern struct symtab_and_line
505 ada_decode_assert_location (char *args, char **addr_string,
506 struct breakpoint_ops **ops);
507
508
509#endif
This page took 0.02363 seconds and 4 git commands to generate.