* emultempl/mmixelf.em: Remove incorrect '#line' directive.
[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 Free Software Foundation, Inc.
5
6This file is part of GDB.
7
8This program is free software; you can redistribute it and/or modify
9it under the terms of the GNU General Public License as published by
10the Free Software Foundation; either version 2 of the License, or
11(at your option) any later version.
12
13This program is distributed in the hope that it will be useful,
14but WITHOUT ANY WARRANTY; without even the implied warranty of
15MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16GNU General Public License for more details.
17
18You should have received a copy of the GNU General Public License
19along with this program; if not, write to the Free Software
20Foundation, Inc., 51 Franklin Street, Fifth Floor,
21Boston, MA 02110-1301, USA. */
22
23#if !defined (ADA_LANG_H)
24#define ADA_LANG_H 1
25
26struct partial_symbol;
27struct frame_info;
28
29#include "value.h"
30#include "gdbtypes.h"
31#include "breakpoint.h"
32
33/* Names of specific files known to be part of the runtime
34 system and that might consider (confusing) debugging information.
35 Each name (a basic regular expression string) is followed by a
36 comma. FIXME: Should be part of a configuration file. */
37#if defined(__alpha__) && defined(__osf__)
38#define ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS \
39 "^[agis]-.*\\.ad[bs]$", \
40 "/usr/shlib/libpthread\\.so",
41#elif defined (__linux__)
42#define ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS \
43 "^[agis]-.*\\.ad[bs]$", \
44 "/lib.*/libpthread\\.so[.0-9]*$", "/lib.*/libpthread\\.a$", \
45 "/lib.*/libc\\.so[.0-9]*$", "/lib.*/libc\\.a$",
46#endif
47
48#if !defined (ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS)
49#define ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS \
50 "^[agis]-.*\\.ad[bs]$",
51#endif
52
53/* Names of compiler-generated auxiliary functions probably of no
54 interest to users. Each name (a basic regular expression string)
55 is followed by a comma. */
56#define ADA_KNOWN_AUXILIARY_FUNCTION_NAME_PATTERNS \
57 "___clean[.$a-zA-Z0-9_]*$",
58
59/* The maximum number of frame levels searched for non-local,
60 * non-global symbols. This limit exists as a precaution to prevent
61 * infinite search loops when the stack is screwed up. */
62#define MAX_ENCLOSING_FRAME_LEVELS 7
63
64/* Maximum number of steps followed in looking for the ultimate
65 referent of a renaming. This prevents certain infinite loops that
66 can otherwise result. */
67#define MAX_RENAMING_CHAIN_LENGTH 10
68
69struct block;
70
71/* Corresponding encoded/decoded names and opcodes for Ada user-definable
72 operators. */
73struct ada_opname_map
74{
75 const char *encoded;
76 const char *decoded;
77 enum exp_opcode op;
78};
79
80/* Table of Ada operators in encoded and decoded forms. */
81/* Defined in ada-lang.c */
82extern const struct ada_opname_map ada_opname_table[];
83
84enum ada_operator
85 {
86 /* X IN A'RANGE(N). N is an immediate operand, surrounded by
87 BINOP_IN_BOUNDS before and after. A is an array, X an index
88 value. Evaluates to true iff X is within range of the Nth
89 dimension (1-based) of A. (A multi-dimensional array
90 type is represented as array of array of ...) */
91 BINOP_IN_BOUNDS = OP_EXTENDED0,
92
93 /* X IN L .. U. True iff L <= X <= U. */
94 TERNOP_IN_RANGE,
95
96 /* Ada attributes ('Foo). */
97 OP_ATR_FIRST,
98 OP_ATR_LAST,
99 OP_ATR_LENGTH,
100 OP_ATR_IMAGE,
101 OP_ATR_MAX,
102 OP_ATR_MIN,
103 OP_ATR_MODULUS,
104 OP_ATR_POS,
105 OP_ATR_SIZE,
106 OP_ATR_TAG,
107 OP_ATR_VAL,
108
109 /* Ada type qualification. It is encoded as for UNOP_CAST, above,
110 and denotes the TYPE'(EXPR) construct. */
111 UNOP_QUAL,
112
113 /* X IN TYPE. The `TYPE' argument is immediate, with
114 UNOP_IN_RANGE before and after it. True iff X is a member of
115 type TYPE (typically a subrange). */
116 UNOP_IN_RANGE,
117
118 /* An aggregate. A single immediate operand, N>0, gives
119 the number of component specifications that follow. The
120 immediate operand is followed by a second OP_AGGREGATE.
121 Next come N component specifications. A component
122 specification is either an OP_OTHERS (others=>...), an
123 OP_CHOICES (for named associations), or other expression (for
124 positional aggregates only). Aggregates currently
125 occur only as the right sides of assignments. */
126 OP_AGGREGATE,
127
128 /* An others clause. Followed by a single expression. */
129 OP_OTHERS,
130
131 /* An aggregate component association. A single immediate operand, N,
132 gives the number of choices that follow. This is followed by a second
133 OP_CHOICES operator. Next come N operands, each of which is an
134 expression, an OP_DISCRETE_RANGE, or an OP_NAME---the latter
135 for a simple name that must be a record component name and does
136 not correspond to a single existing symbol. After the N choice
137 indicators comes an expression giving the value.
138
139 In an aggregate such as (X => E1, ...), where X is a simple
140 name, X could syntactically be either a component_selector_name
141 or an expression used as a discrete_choice, depending on the
142 aggregate's type context. Since this is not known at parsing
143 time, we don't attempt to disambiguate X if it has multiple
144 definitions, but instead supply an OP_NAME. If X has a single
145 definition, we represent it with an OP_VAR_VALUE, even though
146 it may turn out to be within a record aggregate. Aggregate
147 evaluation can use either OP_NAMEs or OP_VAR_VALUEs to get a
148 record field name, and can evaluate OP_VAR_VALUE normally to
149 get its value as an expression. Unfortunately, we lose out in
150 cases where X has multiple meanings and is part of an array
151 aggregate. I hope these are not common enough to annoy users,
152 who can work around the problem in any case by putting
153 parentheses around X. */
154 OP_CHOICES,
155
156 /* A positional aggregate component association. The operator is
157 followed by a single integer indicating the position in the
158 aggregate (0-based), followed by a second OP_POSITIONAL. Next
159 follows a single expression giving the component value. */
160 OP_POSITIONAL,
161
162 /* A range of values. Followed by two expressions giving the
163 upper and lower bounds of the range. */
164 OP_DISCRETE_RANGE,
165
166 /* End marker */
167 OP_ADA_LAST
168 };
169
170/* A triple, (symbol, block, symtab), representing one instance of a
171 * symbol-lookup operation. */
172struct ada_symbol_info {
173 struct symbol* sym;
174 struct block* block;
175 struct symtab* symtab;
176};
177
178/* Ada task structures. */
179
180/* Ada task control block, as defined in the GNAT runt-time library. */
181
182struct task_control_block
183{
184 char state;
185 CORE_ADDR parent;
186 int priority;
187 char image [32];
188 int image_len; /* This field is not always present in the ATCB. */
189 CORE_ADDR call;
190 CORE_ADDR thread;
191 CORE_ADDR lwp; /* This field is not always present in the ATCB. */
192
193 /* If the task is waiting on a task entry, this field contains the
194 task_id of the other task. */
195 CORE_ADDR called_task;
196};
197
198struct task_ptid
199{
200 int pid; /* The Process id */
201 long lwp; /* The Light Weight Process id */
202 long tid; /* The Thread id */
203};
204typedef struct task_ptid task_ptid_t;
205
206struct task_entry
207{
208 CORE_ADDR task_id;
209 struct task_control_block atcb;
210 int task_num;
211 int known_tasks_index;
212 struct task_entry *next_task;
213 task_ptid_t task_ptid;
214 int stack_per;
215};
216
217/* task entry list. */
218extern struct task_entry *task_list;
219
220
221/* Assuming V points to an array of S objects, make sure that it contains at
222 least M objects, updating V and S as necessary. */
223
224#define GROW_VECT(v, s, m) \
225 if ((s) < (m)) (v) = grow_vect (v, &(s), m, sizeof *(v));
226
227extern void *grow_vect (void *, size_t *, size_t, int);
228
229extern int ada_get_field_index (const struct type *type,
230 const char *field_name,
231 int maybe_missing);
232
233extern int ada_parse (void); /* Defined in ada-exp.y */
234
235extern void ada_error (char *); /* Defined in ada-exp.y */
236
237 /* Defined in ada-typeprint.c */
238extern void ada_print_type (struct type *, char *, struct ui_file *, int,
239 int);
240
241extern int ada_val_print (struct type *, const gdb_byte *, int, CORE_ADDR,
242 struct ui_file *, int, int, int,
243 enum val_prettyprint);
244
245extern int ada_value_print (struct value *, struct ui_file *, int,
246 enum val_prettyprint);
247
248 /* Defined in ada-lang.c */
249
250extern struct value *value_from_contents_and_address (struct type *,
251 const gdb_byte *,
252 CORE_ADDR);
253
254extern void ada_emit_char (int, struct ui_file *, int, int);
255
256extern void ada_printchar (int, struct ui_file *);
257
258extern void ada_printstr (struct ui_file *, const gdb_byte *,
259 unsigned int, int, int);
260
261extern void ada_convert_actuals (struct value *, int, struct value **,
262 CORE_ADDR *);
263
264extern struct value *ada_value_subscript (struct value *, int,
265 struct value **);
266
267extern struct type *ada_array_element_type (struct type *, int);
268
269extern int ada_array_arity (struct type *);
270
271struct type *ada_type_of_array (struct value *, int);
272
273extern struct value *ada_coerce_to_simple_array_ptr (struct value *);
274
275extern int ada_is_simple_array_type (struct type *);
276
277extern int ada_is_array_descriptor_type (struct type *);
278
279extern int ada_is_bogus_array_descriptor (struct type *);
280
281extern struct type *ada_index_type (struct type *, int);
282
283extern struct value *ada_array_bound (struct value *, int, int);
284
285extern char *ada_decode_symbol (const struct general_symbol_info*);
286
287extern const char *ada_decode (const char*);
288
289extern enum language ada_update_initial_language (enum language,
290 struct partial_symtab*);
291
292extern void clear_ada_sym_cache (void);
293
294extern char **ada_make_symbol_completion_list (const char *text0,
295 const char *word);
296
297extern int ada_lookup_symbol_list (const char *, const struct block *,
298 domain_enum, struct ada_symbol_info**);
299
300extern char *ada_fold_name (const char *);
301
302extern struct symbol *ada_lookup_symbol (const char *, const struct block *,
303 domain_enum, int *,
304 struct symtab **);
305
306extern struct minimal_symbol *ada_lookup_simple_minsym (const char *);
307
308extern void ada_fill_in_ada_prototype (struct symbol *);
309
310extern int user_select_syms (struct ada_symbol_info *, int, int);
311
312extern int get_selections (int *, int, int, int, char *);
313
314extern char *ada_start_decode_line_1 (char *);
315
316extern struct symtabs_and_lines ada_finish_decode_line_1 (char **,
317 struct symtab *,
318 int, char ***);
319
320extern struct symtabs_and_lines ada_sals_for_line (const char*, int,
321 int, char***, int);
322
323extern int ada_scan_number (const char *, int, LONGEST *, int *);
324
325extern struct type *ada_parent_type (struct type *);
326
327extern int ada_is_ignored_field (struct type *, int);
328
329extern int ada_is_packed_array_type (struct type *);
330
331extern struct value *ada_value_primitive_packed_val (struct value *,
332 const gdb_byte *,
333 long, int, int,
334 struct type *);
335
336extern struct type *ada_coerce_to_simple_array_type (struct type *);
337
338extern int ada_is_character_type (struct type *);
339
340extern int ada_is_string_type (struct type *);
341
342extern int ada_is_tagged_type (struct type *, int);
343
344extern int ada_is_tag_type (struct type *);
345
346extern struct type *ada_tag_type (struct value *);
347
348extern struct value *ada_value_tag (struct value *);
349
350extern const char *ada_tag_name (struct value *);
351
352extern int ada_is_parent_field (struct type *, int);
353
354extern int ada_is_wrapper_field (struct type *, int);
355
356extern int ada_is_variant_part (struct type *, int);
357
358extern struct type *ada_variant_discrim_type (struct type *, struct type *);
359
360extern int ada_is_others_clause (struct type *, int);
361
362extern int ada_in_variant (LONGEST, struct type *, int);
363
364extern char *ada_variant_discrim_name (struct type *);
365
366extern struct value *ada_value_struct_elt (struct value *, char *, int);
367
368extern int ada_is_aligner_type (struct type *);
369
370extern struct type *ada_aligned_type (struct type *);
371
372extern const gdb_byte *ada_aligned_value_addr (struct type *,
373 const gdb_byte *);
374
375extern const char *ada_attribute_name (enum exp_opcode);
376
377extern int ada_is_fixed_point_type (struct type *);
378
379extern int ada_is_system_address_type (struct type *);
380
381extern DOUBLEST ada_delta (struct type *);
382
383extern DOUBLEST ada_fixed_to_float (struct type *, LONGEST);
384
385extern LONGEST ada_float_to_fixed (struct type *, DOUBLEST);
386
387extern int ada_is_vax_floating_type (struct type *);
388
389extern int ada_vax_float_type_suffix (struct type *);
390
391extern struct value *ada_vax_float_print_function (struct type *);
392
393extern struct type *ada_system_address_type (void);
394
395extern int ada_which_variant_applies (struct type *, struct type *,
396 const gdb_byte *);
397
398extern struct type *ada_to_fixed_type (struct type *, const gdb_byte *,
399 CORE_ADDR, struct value *);
400
401extern struct type *ada_template_to_fixed_record_type_1 (struct type *type,
402 const gdb_byte *valaddr,
403 CORE_ADDR address,
404 struct value *dval0,
405 int keep_dynamic_fields);
406
407extern int ada_name_prefix_len (const char *);
408
409extern char *ada_type_name (struct type *);
410
411extern struct type *ada_find_parallel_type (struct type *,
412 const char *suffix);
413
414extern LONGEST get_int_var_value (char *, int *);
415
416extern struct symbol *ada_find_any_symbol (const char *name);
417
418extern struct type *ada_find_any_type (const char *name);
419
420extern struct symbol *ada_find_renaming_symbol (const char *name,
421 struct block *block);
422
423extern int ada_prefer_type (struct type *, struct type *);
424
425extern struct type *ada_get_base_type (struct type *);
426
427extern struct type *ada_check_typedef (struct type *);
428
429extern char *ada_encode (const char *);
430
431extern const char *ada_enum_name (const char *);
432
433extern int ada_is_modular_type (struct type *);
434
435extern ULONGEST ada_modulus (struct type *);
436
437extern struct value *ada_value_ind (struct value *);
438
439extern void ada_print_scalar (struct type *, LONGEST, struct ui_file *);
440
441extern int ada_is_range_type_name (const char *);
442
443extern const char *ada_renaming_type (struct type *);
444
445extern int ada_is_object_renaming (struct symbol *);
446
447extern char *ada_simple_renamed_entity (struct symbol *);
448
449extern char *ada_breakpoint_rewrite (char *, int *);
450
451extern char *ada_main_name (void);
452
453/* Tasking-related: ada-tasks.c */
454
455extern int valid_task_id (int);
456
457extern void init_task_list (void);
458
459extern int ada_is_exception_breakpoint (bpstat bs);
460
461extern void ada_adjust_exception_stop (bpstat bs);
462
463extern void ada_print_exception_stop (bpstat bs);
464
465extern int ada_get_current_task (ptid_t);
466
467extern int breakpoint_ada_task_match (CORE_ADDR, ptid_t);
468
469extern int ada_print_exception_breakpoint_nontask (struct breakpoint *);
470
471extern void ada_print_exception_breakpoint_task (struct breakpoint *);
472
473extern void ada_reset_thread_registers (void);
474
475extern int ada_build_task_list (void);
476
477/* Look up a symbol by name using the search conventions of
478 a specific language (optional block, optional symtab).
479 FIXME: Should be symtab.h. */
480
481extern struct symbol *lookup_symbol_in_language (const char *,
482 const struct block *,
483 domain_enum,
484 enum language,
485 int *,
486 struct symtab **);
487
488extern int ada_exception_catchpoint_p (struct breakpoint *b);
489
490extern struct symtab_and_line
491 ada_decode_exception_location (char *args, char **addr_string,
492 char **exp_string, char **cond_string,
493 struct expression **cond,
494 struct breakpoint_ops **ops);
495
496extern struct symtab_and_line
497 ada_decode_assert_location (char *args, char **addr_string,
498 struct breakpoint_ops **ops);
499
500
501#endif
This page took 0.023339 seconds and 4 git commands to generate.