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