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, 2005,
   4    2007, 2008, 2009, 2010 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 3 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, see <http://www.gnu.org/licenses/>.  */
  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 /* A tuple, (symbol, block), representing one instance of a
  83  * symbol-lookup operation. */
  84 struct ada_symbol_info {
  85   struct symbol* sym;
  86   struct block* block;
  87 };
  88
  89 /* Denotes a type of renaming symbol (see ada_parse_renaming).  */
  90 enum ada_renaming_category
  91   {
  92     /* Indicates a symbol that does not encode a renaming.  */
  93     ADA_NOT_RENAMING,
  94
  95     /* For symbols declared
  96          Foo : TYPE renamed OBJECT;  */
  97     ADA_OBJECT_RENAMING,
  98
  99     /* For symbols declared
 100          Foo : exception renames EXCEPTION;  */
 101     ADA_EXCEPTION_RENAMING,
 102     /* For packages declared
 103           package Foo renames PACKAGE; */
 104     ADA_PACKAGE_RENAMING,
 105     /* For subprograms declared
 106           SUBPROGRAM_SPEC renames SUBPROGRAM;
 107        (Currently not used).  */
 108     ADA_SUBPROGRAM_RENAMING
 109   };
 110
 111 /* Ada task structures.  */
 112
 113 struct ada_task_info
 114 {
 115   /* The PTID of the thread that this task runs on.  This ptid is computed
 116      in a target-dependent way from the associated Task Control Block.  */
 117   ptid_t ptid;
 118
 119   /* The ID of the task.  */
 120   CORE_ADDR task_id;
 121
 122   /* The name of the task.  */
 123   char name[257];
 124
 125   /* The current state of the task.  */
 126   int state;
 127
 128   /* The priority associated to the task.  */
 129   int priority;
 130
 131   /* If non-zero, the task ID of the parent task.  */
 132   CORE_ADDR parent;
 133
 134   /* If the task is waiting on a task entry, this field contains
 135      the ID of the other task.  Zero otherwise.  */
 136   CORE_ADDR called_task;
 137
 138   /* If the task is accepting a rendezvous with another task, this field
 139      contains the ID of the calling task.  Zero otherwise.  */
 140   CORE_ADDR caller_task;
 141 };
 142
 143 /* Assuming V points to an array of S objects,  make sure that it contains at
 144    least M objects, updating V and S as necessary. */
 145
 146 #define GROW_VECT(v, s, m)                                              \
 147    if ((s) < (m)) (v) = grow_vect (v, &(s), m, sizeof *(v));
 148
 149 extern void *grow_vect (void *, size_t *, size_t, int);
 150
 151 extern int ada_get_field_index (const struct type *type,
 152                                 const char *field_name,
 153                                 int maybe_missing);
 154
 155 extern int ada_parse (void);    /* Defined in ada-exp.y */
 156
 157 extern void ada_error (char *); /* Defined in ada-exp.y */
 158
 159                         /* Defined in ada-typeprint.c */
 160 extern void ada_print_type (struct type *, char *, struct ui_file *, int,
 161                             int);
 162
 163 extern int ada_val_print (struct type *, const gdb_byte *, int, CORE_ADDR,
 164                           struct ui_file *, int,
 165                           const struct value_print_options *);
 166
 167 extern int ada_value_print (struct value *, struct ui_file *,
 168                             const struct value_print_options *);
 169
 170                                 /* Defined in ada-lang.c */
 171
 172 extern void ada_emit_char (int, struct type *, struct ui_file *, int, int);
 173
 174 extern void ada_printchar (int, struct type *, struct ui_file *);
 175
 176 extern void ada_printstr (struct ui_file *, struct type *, const gdb_byte *,
 177                           unsigned int, int,
 178                           const struct value_print_options *);
 179
 180 struct value *ada_convert_actual (struct value *actual,
 181                                   struct type *formal_type0,
 182                                   struct gdbarch *gdbarch,
 183                                   CORE_ADDR *sp);
 184
 185 extern struct value *ada_value_subscript (struct value *, int,
 186                                           struct value **);
 187
 188 extern struct type *ada_array_element_type (struct type *, int);
 189
 190 extern int ada_array_arity (struct type *);
 191
 192 struct type *ada_type_of_array (struct value *, int);
 193
 194 extern struct value *ada_coerce_to_simple_array_ptr (struct value *);
 195
 196 extern int ada_is_simple_array_type (struct type *);
 197
 198 extern int ada_is_array_descriptor_type (struct type *);
 199
 200 extern int ada_is_bogus_array_descriptor (struct type *);
 201
 202 extern LONGEST ada_discrete_type_low_bound (struct type *);
 203
 204 extern LONGEST ada_discrete_type_high_bound (struct type *);
 205
 206 extern char *ada_decode_symbol (const struct general_symbol_info*);
 207
 208 extern const char *ada_decode (const char*);
 209
 210 extern enum language ada_update_initial_language (enum language,
 211                                                   struct partial_symtab*);
 212
 213 extern void clear_ada_sym_cache (void);
 214
 215 extern int ada_lookup_symbol_list (const char *, const struct block *,
 216                                    domain_enum, struct ada_symbol_info**);
 217
 218 extern char *ada_fold_name (const char *);
 219
 220 extern struct symbol *ada_lookup_symbol (const char *, const struct block *,
 221                                          domain_enum, int *);
 222
 223 extern struct symbol *
 224 ada_lookup_encoded_symbol (const char *, const struct block *,
 225                            domain_enum namespace, struct block **);
 226
 227 extern struct minimal_symbol *ada_lookup_simple_minsym (const char *);
 228
 229 extern void ada_fill_in_ada_prototype (struct symbol *);
 230
 231 extern int user_select_syms (struct ada_symbol_info *, int, int);
 232
 233 extern int get_selections (int *, int, int, int, char *);
 234
 235 extern char *ada_start_decode_line_1 (char *);
 236
 237 extern struct symtabs_and_lines ada_finish_decode_line_1 (char **,
 238                                                           struct symtab *,
 239                                                           int, char ***);
 240
 241 extern struct symtabs_and_lines ada_sals_for_line (const char*, int,
 242                                                    int, char***, int);
 243
 244 extern int ada_scan_number (const char *, int, LONGEST *, int *);
 245
 246 extern struct type *ada_parent_type (struct type *);
 247
 248 extern int ada_is_ignored_field (struct type *, int);
 249
 250 extern int ada_is_constrained_packed_array_type (struct type *);
 251
 252 extern struct value *ada_value_primitive_packed_val (struct value *,
 253                                                      const gdb_byte *,
 254                                                      long, int, int,
 255                                                      struct type *);
 256
 257 extern struct type *ada_coerce_to_simple_array_type (struct type *);
 258
 259 extern int ada_is_character_type (struct type *);
 260
 261 extern int ada_is_string_type (struct type *);
 262
 263 extern int ada_is_tagged_type (struct type *, int);
 264
 265 extern int ada_is_tag_type (struct type *);
 266
 267 extern struct type *ada_tag_type (struct value *);
 268
 269 extern struct value *ada_value_tag (struct value *);
 270
 271 extern const char *ada_tag_name (struct value *);
 272
 273 extern int ada_is_parent_field (struct type *, int);
 274
 275 extern int ada_is_wrapper_field (struct type *, int);
 276
 277 extern int ada_is_variant_part (struct type *, int);
 278
 279 extern struct type *ada_variant_discrim_type (struct type *, struct type *);
 280
 281 extern int ada_is_others_clause (struct type *, int);
 282
 283 extern int ada_in_variant (LONGEST, struct type *, int);
 284
 285 extern char *ada_variant_discrim_name (struct type *);
 286
 287 extern struct value *ada_value_struct_elt (struct value *, char *, int);
 288
 289 extern int ada_is_aligner_type (struct type *);
 290
 291 extern struct type *ada_aligned_type (struct type *);
 292
 293 extern const gdb_byte *ada_aligned_value_addr (struct type *,
 294                                                const gdb_byte *);
 295
 296 extern const char *ada_attribute_name (enum exp_opcode);
 297
 298 extern int ada_is_fixed_point_type (struct type *);
 299
 300 extern int ada_is_system_address_type (struct type *);
 301
 302 extern DOUBLEST ada_delta (struct type *);
 303
 304 extern DOUBLEST ada_fixed_to_float (struct type *, LONGEST);
 305
 306 extern LONGEST ada_float_to_fixed (struct type *, DOUBLEST);
 307
 308 extern int ada_is_vax_floating_type (struct type *);
 309
 310 extern int ada_vax_float_type_suffix (struct type *);
 311
 312 extern struct value *ada_vax_float_print_function (struct type *);
 313
 314 extern struct type *ada_system_address_type (void);
 315
 316 extern int ada_which_variant_applies (struct type *, struct type *,
 317                                       const gdb_byte *);
 318
 319 extern struct type *ada_to_fixed_type (struct type *, const gdb_byte *,
 320                                        CORE_ADDR, struct value *,
 321                                        int check_tag);
 322
 323 extern struct type *ada_template_to_fixed_record_type_1 (struct type *type,
 324                                                          const gdb_byte *valaddr,
 325                                                          CORE_ADDR address,
 326                                                          struct value *dval0,
 327                                                          int keep_dynamic_fields);
 328
 329 extern int ada_name_prefix_len (const char *);
 330
 331 extern char *ada_type_name (struct type *);
 332
 333 extern struct type *ada_find_parallel_type (struct type *,
 334                                             const char *suffix);
 335
 336 extern LONGEST get_int_var_value (char *, int *);
 337
 338 extern struct symbol *ada_find_any_symbol (const char *name);
 339
 340 extern struct type *ada_find_any_type (const char *name);
 341
 342 extern struct symbol *ada_find_renaming_symbol (const char *name,
 343                                                 struct block *block);
 344
 345 extern int ada_prefer_type (struct type *, struct type *);
 346
 347 extern struct type *ada_get_base_type (struct type *);
 348
 349 extern struct type *ada_check_typedef (struct type *);
 350
 351 extern char *ada_encode (const char *);
 352
 353 extern const char *ada_enum_name (const char *);
 354
 355 extern int ada_is_modular_type (struct type *);
 356
 357 extern ULONGEST ada_modulus (struct type *);
 358
 359 extern struct value *ada_value_ind (struct value *);
 360
 361 extern void ada_print_scalar (struct type *, LONGEST, struct ui_file *);
 362
 363 extern int ada_is_range_type_name (const char *);
 364
 365 extern enum ada_renaming_category ada_parse_renaming (struct symbol *,
 366                                                       const char **,
 367                                                       int *, const char **);
 368
 369 extern void ada_find_printable_frame (struct frame_info *fi);
 370
 371 extern char *ada_breakpoint_rewrite (char *, int *);
 372
 373 extern char *ada_main_name (void);
 374
 375 /* Tasking-related: ada-tasks.c */
 376
 377 extern int valid_task_id (int);
 378
 379 extern int ada_get_task_number (ptid_t);
 380
 381 extern int ada_build_task_list (int warn_if_null);
 382
 383 extern int ada_exception_catchpoint_p (struct breakpoint *b);
 384
 385 extern struct symtab_and_line
 386   ada_decode_exception_location (char *args, char **addr_string,
 387                                  char **exp_string, char **cond_string,
 388                                  struct expression **cond,
 389                                  struct breakpoint_ops **ops);
 390
 391 extern struct symtab_and_line
 392   ada_decode_assert_location (char *args, char **addr_string,
 393                               struct breakpoint_ops **ops);
 394
 395
 396 #endif