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 /* Ada task structures.  */
 128
 129 /* Ada task control block, as defined in the GNAT runt-time library.  */
 130
 131 struct task_control_block
 132 {
 133   char state;
 134   CORE_ADDR parent;
 135   int priority;
 136   char image [32];
 137   int image_len;    /* This field is not always present in the ATCB.  */
 138   CORE_ADDR call;
 139   CORE_ADDR thread;
 140   CORE_ADDR lwp;    /* This field is not always present in the ATCB.  */
 141 };
 142
 143 struct task_ptid
 144 {
 145   int pid;                      /* The Process id */
 146   long lwp;                     /* The Light Weight Process id */
 147   long tid;                     /* The Thread id */
 148 };
 149 typedef struct task_ptid task_ptid_t;
 150
 151 struct task_entry
 152 {
 153   CORE_ADDR task_id;
 154   struct task_control_block atcb;
 155   int task_num;
 156   int known_tasks_index;
 157   struct task_entry *next_task;
 158   task_ptid_t task_ptid;
 159   int stack_per;
 160 };
 161
 162 extern struct type *builtin_type_ada_int;
 163 extern struct type *builtin_type_ada_short;
 164 extern struct type *builtin_type_ada_long;
 165 extern struct type *builtin_type_ada_long_long;
 166 extern struct type *builtin_type_ada_char;
 167 extern struct type *builtin_type_ada_float;
 168 extern struct type *builtin_type_ada_double;
 169 extern struct type *builtin_type_ada_long_double;
 170 extern struct type *builtin_type_ada_natural;
 171 extern struct type *builtin_type_ada_positive;
 172 extern struct type *builtin_type_ada_system_address;
 173
 174 /* The maximum number of tasks known to the Ada runtime.  */
 175 extern const int MAX_NUMBER_OF_KNOWN_TASKS;
 176
 177 /* task entry list.  */
 178 extern struct task_entry *task_list;
 179
 180
 181 /* Assuming V points to an array of S objects,  make sure that it contains at
 182    least M objects, updating V and S as necessary. */
 183
 184 #define GROW_VECT(v, s, m)                                              \
 185    if ((s) < (m)) grow_vect ((void**) &(v), &(s), (m), sizeof(*(v)));
 186
 187 extern void grow_vect (void **, size_t *, size_t, int);
 188
 189 extern int ada_get_field_index (const struct type *type,
 190                                 const char *field_name,
 191                                 int maybe_missing);
 192
 193 extern int ada_parse (void);    /* Defined in ada-exp.y */
 194
 195 extern void ada_error (char *); /* Defined in ada-exp.y */
 196
 197                         /* Defined in ada-typeprint.c */
 198 extern void ada_print_type (struct type *, char *, struct ui_file *, int,
 199                             int);
 200
 201 extern int ada_val_print (struct type *, char *, int, CORE_ADDR,
 202                           struct ui_file *, int, int, int,
 203                           enum val_prettyprint);
 204
 205 extern int ada_value_print (struct value *, struct ui_file *, int,
 206                             enum val_prettyprint);
 207
 208                                 /* Defined in ada-lang.c */
 209
 210 extern struct value *value_from_contents_and_address (struct type *, char *,
 211                                                       CORE_ADDR);
 212
 213 extern void ada_emit_char (int, struct ui_file *, int, int);
 214
 215 extern void ada_printchar (int, struct ui_file *);
 216
 217 extern void ada_printstr (struct ui_file *, char *, unsigned int, int, int);
 218
 219 extern void ada_convert_actuals (struct value *, int, struct value **,
 220                                  CORE_ADDR *);
 221
 222 extern struct value *ada_value_subscript (struct value *, int,
 223                                           struct value **);
 224
 225 extern struct type *ada_array_element_type (struct type *, int);
 226
 227 extern int ada_array_arity (struct type *);
 228
 229 struct type *ada_type_of_array (struct value *, int);
 230
 231 extern struct value *ada_coerce_to_simple_array_ptr (struct value *);
 232
 233 extern int ada_is_simple_array_type (struct type *);
 234
 235 extern int ada_is_array_descriptor_type (struct type *);
 236
 237 extern int ada_is_bogus_array_descriptor (struct type *);
 238
 239 extern struct type *ada_index_type (struct type *, int);
 240
 241 extern struct value *ada_array_bound (struct value *, int, int);
 242
 243 extern char *ada_decode_symbol (const struct general_symbol_info*);
 244
 245 extern const char *ada_decode (const char*);
 246
 247 extern enum language ada_update_initial_language (enum language,
 248                                                   struct partial_symtab*);
 249
 250 extern void clear_ada_sym_cache (void);
 251
 252 extern char **ada_make_symbol_completion_list (const char *text0,
 253                                                const char *word);
 254
 255 extern int ada_lookup_symbol_list (const char *, const struct block *,
 256                                    domain_enum, struct ada_symbol_info**);
 257
 258 extern char *ada_fold_name (const char *);
 259
 260 extern struct symbol *ada_lookup_symbol (const char *, const struct block *,
 261                                          domain_enum, int *,
 262                                          struct symtab **);
 263
 264 extern struct minimal_symbol *ada_lookup_simple_minsym (const char *);
 265
 266 extern void ada_fill_in_ada_prototype (struct symbol *);
 267
 268 extern int user_select_syms (struct ada_symbol_info *, int, int);
 269
 270 extern int get_selections (int *, int, int, int, char *);
 271
 272 extern char *ada_start_decode_line_1 (char *);
 273
 274 extern struct symtabs_and_lines ada_finish_decode_line_1 (char **,
 275                                                           struct symtab *,
 276                                                           int, char ***);
 277
 278 extern struct symtabs_and_lines ada_sals_for_line (const char*, int,
 279                                                    int, char***, int);
 280
 281 extern int ada_scan_number (const char *, int, LONGEST *, int *);
 282
 283 extern struct type *ada_parent_type (struct type *);
 284
 285 extern int ada_is_ignored_field (struct type *, int);
 286
 287 extern int ada_is_packed_array_type (struct type *);
 288
 289 extern struct value *ada_value_primitive_packed_val (struct value *, char *,
 290                                                      long, int, int,
 291                                                      struct type *);
 292
 293 extern struct type *ada_coerce_to_simple_array_type (struct type *);
 294
 295 extern int ada_is_character_type (struct type *);
 296
 297 extern int ada_is_string_type (struct type *);
 298
 299 extern int ada_is_tagged_type (struct type *, int);
 300
 301 extern int ada_is_tag_type (struct type *);
 302
 303 extern struct type *ada_tag_type (struct value *);
 304
 305 extern struct value *ada_value_tag (struct value *);
 306
 307 extern const char *ada_tag_name (struct value *);
 308
 309 extern int ada_is_parent_field (struct type *, int);
 310
 311 extern int ada_is_wrapper_field (struct type *, int);
 312
 313 extern int ada_is_variant_part (struct type *, int);
 314
 315 extern struct type *ada_variant_discrim_type (struct type *, struct type *);
 316
 317 extern int ada_is_others_clause (struct type *, int);
 318
 319 extern int ada_in_variant (LONGEST, struct type *, int);
 320
 321 extern char *ada_variant_discrim_name (struct type *);
 322
 323 extern struct value *ada_value_struct_elt (struct value *, char *, char *);
 324
 325 extern int ada_is_aligner_type (struct type *);
 326
 327 extern struct type *ada_aligned_type (struct type *);
 328
 329 extern char *ada_aligned_value_addr (struct type *, char *);
 330
 331 extern const char *ada_attribute_name (enum exp_opcode);
 332
 333 extern int ada_is_fixed_point_type (struct type *);
 334
 335 extern int ada_is_system_address_type (struct type *);
 336
 337 extern DOUBLEST ada_delta (struct type *);
 338
 339 extern DOUBLEST ada_fixed_to_float (struct type *, LONGEST);
 340
 341 extern LONGEST ada_float_to_fixed (struct type *, DOUBLEST);
 342
 343 extern int ada_is_vax_floating_type (struct type *);
 344
 345 extern int ada_vax_float_type_suffix (struct type *);
 346
 347 extern struct value *ada_vax_float_print_function (struct type *);
 348
 349 extern struct type *ada_system_address_type (void);
 350
 351 extern int ada_which_variant_applies (struct type *, struct type *, char *);
 352
 353 extern struct type *ada_to_fixed_type (struct type *, char *, CORE_ADDR,
 354                                        struct value *);
 355
 356 extern struct type *
 357   ada_template_to_fixed_record_type_1 (struct type *type, char *valaddr,
 358                                        CORE_ADDR address, struct value *dval0,
 359                                        int keep_dynamic_fields);
 360
 361 extern int ada_name_prefix_len (const char *);
 362
 363 extern char *ada_type_name (struct type *);
 364
 365 extern struct type *ada_find_parallel_type (struct type *,
 366                                             const char *suffix);
 367
 368 extern LONGEST get_int_var_value (char *, int *);
 369
 370 extern struct symbol *ada_find_any_symbol (const char *name);
 371
 372 extern struct type *ada_find_any_type (const char *name);
 373
 374 extern struct symbol *ada_find_renaming_symbol (const char *name,
 375                                                 struct block *block);
 376
 377 extern int ada_prefer_type (struct type *, struct type *);
 378
 379 extern struct type *ada_get_base_type (struct type *);
 380
 381 extern struct type *ada_completed_type (struct type *);
 382
 383 extern char *ada_encode (const char *);
 384
 385 extern const char *ada_enum_name (const char *);
 386
 387 extern int ada_is_modular_type (struct type *);
 388
 389 extern LONGEST ada_modulus (struct type *);
 390
 391 extern struct value *ada_value_ind (struct value *);
 392
 393 extern void ada_print_scalar (struct type *, LONGEST, struct ui_file *);
 394
 395 extern int ada_is_range_type_name (const char *);
 396
 397 extern const char *ada_renaming_type (struct type *);
 398
 399 extern int ada_is_object_renaming (struct symbol *);
 400
 401 extern char *ada_simple_renamed_entity (struct symbol *);
 402
 403 extern char *ada_breakpoint_rewrite (char *, int *);
 404
 405 extern char *ada_main_name (void);
 406
 407 /* Tasking-related: ada-tasks.c */
 408
 409 extern int valid_task_id (int);
 410
 411 extern void init_task_list (void);
 412
 413 extern int ada_is_exception_breakpoint (bpstat bs);
 414
 415 extern void ada_adjust_exception_stop (bpstat bs);
 416
 417 extern void ada_print_exception_stop (bpstat bs);
 418
 419 extern int ada_get_current_task (ptid_t);
 420
 421 extern int breakpoint_ada_task_match (CORE_ADDR, ptid_t);
 422
 423 extern int ada_print_exception_breakpoint_nontask (struct breakpoint *);
 424
 425 extern void ada_print_exception_breakpoint_task (struct breakpoint *);
 426
 427 extern int ada_maybe_exception_partial_symbol (struct partial_symbol *sym);
 428
 429 extern int ada_is_exception_sym (struct symbol *sym);
 430
 431 extern void ada_find_printable_frame (struct frame_info *fi);
 432
 433 extern void ada_reset_thread_registers (void);
 434
 435 extern int ada_build_task_list (void);
 436
 437 /* Look up a symbol by name using the search conventions of
 438    a specific language (optional block, optional symtab).
 439    FIXME: Should be symtab.h. */
 440
 441 extern struct symbol *lookup_symbol_in_language (const char *,
 442                                                  const struct block *,
 443                                                  domain_enum,
 444                                                  enum language,
 445                                                  int *,
 446                                                  struct symtab **);
 447 #endif