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