gdb/ada-lang.h

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