gdb/ada-lang.h

   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
  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__) && !defined(VXWORKS_TARGET)
  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 enum ada_operator
  82   {
  83     /* X IN A'RANGE(N).  N is an immediate operand, surrounded by
  84        BINOP_IN_BOUNDS before and after.  A is an array, X an index
  85        value.  Evaluates to true iff X is within range of the Nth
  86        dimension (1-based) of A.  (A multi-dimensional array
  87        type is represented as array of array of ...) */
  88     BINOP_IN_BOUNDS = OP_EXTENDED0,
  89
  90     /* X IN L .. U.  True iff L <= X <= U.  */
  91     TERNOP_IN_RANGE,
  92
  93     /* Ada attributes ('Foo). */
  94     OP_ATR_FIRST,
  95     OP_ATR_LAST,
  96     OP_ATR_LENGTH,
  97     OP_ATR_IMAGE,
  98     OP_ATR_MAX,
  99     OP_ATR_MIN,
 100     OP_ATR_MODULUS,
 101     OP_ATR_POS,
 102     OP_ATR_SIZE,
 103     OP_ATR_TAG,
 104     OP_ATR_VAL,
 105
 106     /* Ada type qualification.  It is encoded as for UNOP_CAST, above,
 107        and denotes the TYPE'(EXPR) construct. */
 108     UNOP_QUAL,
 109
 110     /* X IN TYPE.  The `TYPE' argument is immediate, with
 111        UNOP_IN_RANGE before and after it. True iff X is a member of
 112        type TYPE (typically a subrange). */
 113     UNOP_IN_RANGE,
 114
 115     /* End marker */
 116     OP_ADA_LAST
 117   };
 118
 119 /* A triple, (symbol, block, symtab), representing one instance of a
 120  * symbol-lookup operation. */
 121 struct ada_symbol_info {
 122   struct symbol* sym;
 123   struct block* block;
 124   struct symtab* symtab;
 125 };
 126
 127 extern struct type *builtin_type_ada_int;
 128 extern struct type *builtin_type_ada_short;
 129 extern struct type *builtin_type_ada_long;
 130 extern struct type *builtin_type_ada_long_long;
 131 extern struct type *builtin_type_ada_char;
 132 extern struct type *builtin_type_ada_float;
 133 extern struct type *builtin_type_ada_double;
 134 extern struct type *builtin_type_ada_long_double;
 135 extern struct type *builtin_type_ada_natural;
 136 extern struct type *builtin_type_ada_positive;
 137 extern struct type *builtin_type_ada_system_address;
 138
 139 /* The maximum number of tasks known to the Ada runtime */
 140 extern const int MAX_NUMBER_OF_KNOWN_TASKS;
 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)) grow_vect ((void**) &(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 *, char *, struct ui_file *, int,
 160                             int);
 161
 162 extern int ada_val_print (struct type *, char *, int, CORE_ADDR,
 163                           struct ui_file *, int, int, int,
 164                           enum val_prettyprint);
 165
 166 extern int ada_value_print (struct value *, struct ui_file *, int,
 167                             enum val_prettyprint);
 168
 169                                 /* Defined in ada-lang.c */
 170
 171 extern struct value *value_from_contents_and_address (struct type *, char *,
 172                                                       CORE_ADDR);
 173
 174 extern void ada_emit_char (int, struct ui_file *, int, int);
 175
 176 extern void ada_printchar (int, struct ui_file *);
 177
 178 extern void ada_printstr (struct ui_file *, char *, unsigned int, int, int);
 179
 180 extern void ada_convert_actuals (struct value *, int, struct value **,
 181                                  CORE_ADDR *);
 182
 183 extern struct value *ada_value_subscript (struct value *, int,
 184                                           struct value **);
 185
 186 extern struct type *ada_array_element_type (struct type *, int);
 187
 188 extern int ada_array_arity (struct type *);
 189
 190 struct type *ada_type_of_array (struct value *, int);
 191
 192 extern struct value *ada_coerce_to_simple_array_ptr (struct value *);
 193
 194 extern int ada_is_simple_array_type (struct type *);
 195
 196 extern int ada_is_array_descriptor_type (struct type *);
 197
 198 extern int ada_is_bogus_array_descriptor (struct type *);
 199
 200 extern struct type *ada_index_type (struct type *, int);
 201
 202 extern struct value *ada_array_bound (struct value *, int, int);
 203
 204 extern char *ada_decode_symbol (const struct general_symbol_info*);
 205
 206 extern const char *ada_decode (const char*);
 207
 208 extern enum language ada_update_initial_language (enum language,
 209                                                   struct partial_symtab*);
 210
 211 extern void clear_ada_sym_cache (void);
 212
 213 extern char **ada_make_symbol_completion_list (const char *text0,
 214                                                const char *word);
 215
 216 extern int ada_lookup_symbol_list (const char *, const struct block *,
 217                                    domain_enum, struct ada_symbol_info**);
 218
 219 extern char *ada_fold_name (const char *);
 220
 221 extern struct symbol *ada_lookup_symbol (const char *, const struct block *,
 222                                          domain_enum, int *,
 223                                          struct symtab **);
 224
 225 extern struct minimal_symbol *ada_lookup_simple_minsym (const char *);
 226
 227 extern void ada_fill_in_ada_prototype (struct symbol *);
 228
 229 extern int user_select_syms (struct ada_symbol_info *, int, int);
 230
 231 extern int get_selections (int *, int, int, int, char *);
 232
 233 extern char *ada_start_decode_line_1 (char *);
 234
 235 extern struct symtabs_and_lines ada_finish_decode_line_1 (char **,
 236                                                           struct symtab *,
 237                                                           int, char ***);
 238
 239 extern struct symtabs_and_lines ada_sals_for_line (const char*, int,
 240                                                    int, char***, int);
 241
 242 extern int ada_scan_number (const char *, int, LONGEST *, int *);
 243
 244 extern struct type *ada_parent_type (struct type *);
 245
 246 extern int ada_is_ignored_field (struct type *, int);
 247
 248 extern int ada_is_packed_array_type (struct type *);
 249
 250 extern struct value *ada_value_primitive_packed_val (struct value *, char *,
 251                                                      long, int, int,
 252                                                      struct type *);
 253
 254 extern struct type *ada_coerce_to_simple_array_type (struct type *);
 255
 256 extern int ada_is_character_type (struct type *);
 257
 258 extern int ada_is_string_type (struct type *);
 259
 260 extern int ada_is_tagged_type (struct type *, int);
 261
 262 extern int ada_is_tag_type (struct type *);
 263
 264 extern struct type *ada_tag_type (struct value *);
 265
 266 extern struct value *ada_value_tag (struct value *);
 267
 268 extern const char *ada_tag_name (struct value *);
 269
 270 extern int ada_is_parent_field (struct type *, int);
 271
 272 extern int ada_is_wrapper_field (struct type *, int);
 273
 274 extern int ada_is_variant_part (struct type *, int);
 275
 276 extern struct type *ada_variant_discrim_type (struct type *, struct type *);
 277
 278 extern int ada_is_others_clause (struct type *, int);
 279
 280 extern int ada_in_variant (LONGEST, struct type *, int);
 281
 282 extern char *ada_variant_discrim_name (struct type *);
 283
 284 extern struct value *ada_value_struct_elt (struct value *, char *, char *);
 285
 286 extern int ada_is_aligner_type (struct type *);
 287
 288 extern struct type *ada_aligned_type (struct type *);
 289
 290 extern char *ada_aligned_value_addr (struct type *, char *);
 291
 292 extern const char *ada_attribute_name (enum exp_opcode);
 293
 294 extern int ada_is_fixed_point_type (struct type *);
 295
 296 extern int ada_is_system_address_type (struct type *);
 297
 298 extern DOUBLEST ada_delta (struct type *);
 299
 300 extern DOUBLEST ada_fixed_to_float (struct type *, LONGEST);
 301
 302 extern LONGEST ada_float_to_fixed (struct type *, DOUBLEST);
 303
 304 extern int ada_is_vax_floating_type (struct type *);
 305
 306 extern int ada_vax_float_type_suffix (struct type *);
 307
 308 extern struct value *ada_vax_float_print_function (struct type *);
 309
 310 extern struct type *ada_system_address_type (void);
 311
 312 extern int ada_which_variant_applies (struct type *, struct type *, char *);
 313
 314 extern struct type *ada_to_fixed_type (struct type *, char *, CORE_ADDR,
 315                                        struct value *);
 316
 317 extern struct type *
 318   ada_template_to_fixed_record_type_1 (struct type *type, char *valaddr,
 319                                        CORE_ADDR address, struct value *dval0,
 320                                        int keep_dynamic_fields);
 321
 322 extern int ada_name_prefix_len (const char *);
 323
 324 extern char *ada_type_name (struct type *);
 325
 326 extern struct type *ada_find_parallel_type (struct type *,
 327                                             const char *suffix);
 328
 329 extern LONGEST get_int_var_value (char *, int *);
 330
 331 extern struct symbol *ada_find_any_symbol (const char *name);
 332
 333 extern struct type *ada_find_any_type (const char *name);
 334
 335 extern struct symbol *ada_find_renaming_symbol (const char *name,
 336                                                 struct block *block);
 337
 338 extern int ada_prefer_type (struct type *, struct type *);
 339
 340 extern struct type *ada_get_base_type (struct type *);
 341
 342 extern struct type *ada_completed_type (struct type *);
 343
 344 extern char *ada_encode (const char *);
 345
 346 extern const char *ada_enum_name (const char *);
 347
 348 extern int ada_is_modular_type (struct type *);
 349
 350 extern LONGEST ada_modulus (struct type *);
 351
 352 extern struct value *ada_value_ind (struct value *);
 353
 354 extern void ada_print_scalar (struct type *, LONGEST, struct ui_file *);
 355
 356 extern int ada_is_range_type_name (const char *);
 357
 358 extern const char *ada_renaming_type (struct type *);
 359
 360 extern int ada_is_object_renaming (struct symbol *);
 361
 362 extern char *ada_simple_renamed_entity (struct symbol *);
 363
 364 extern char *ada_breakpoint_rewrite (char *, int *);
 365
 366 extern char *ada_main_name (void);
 367
 368 /* Tasking-related: ada-tasks.c */
 369
 370 extern int valid_task_id (int);
 371
 372 extern void init_task_list (void);
 373
 374 extern int ada_is_exception_breakpoint (bpstat bs);
 375
 376 extern void ada_adjust_exception_stop (bpstat bs);
 377
 378 extern void ada_print_exception_stop (bpstat bs);
 379
 380 extern int ada_get_current_task (ptid_t);
 381
 382 extern int breakpoint_ada_task_match (CORE_ADDR, ptid_t);
 383
 384 extern int ada_print_exception_breakpoint_nontask (struct breakpoint *);
 385
 386 extern void ada_print_exception_breakpoint_task (struct breakpoint *);
 387
 388 extern int ada_maybe_exception_partial_symbol (struct partial_symbol *sym);
 389
 390 extern int ada_is_exception_sym (struct symbol *sym);
 391
 392 extern void ada_find_printable_frame (struct frame_info *fi);
 393
 394 extern void ada_reset_thread_registers (void);
 395
 396 #endif