gdb/ada-lang.h

   1 /* Ada language support definitions for GDB, the GNU debugger.
   2
   3    Copyright (C) 1992, 1997-2005, 2007-2012 Free Software Foundation,
   4    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 frame_info;
  25 struct inferior;
  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    "___finalizer[.$a-zA-Z0-9_]*$",
  57
  58 /* The maximum number of frame levels searched for non-local,
  59  * non-global symbols.  This limit exists as a precaution to prevent
  60  * infinite search loops when the stack is screwed up.  */
  61 #define MAX_ENCLOSING_FRAME_LEVELS 7
  62
  63 /* Maximum number of steps followed in looking for the ultimate
  64    referent of a renaming.  This prevents certain infinite loops that
  65    can otherwise result.  */
  66 #define MAX_RENAMING_CHAIN_LENGTH 10
  67
  68 struct block;
  69
  70 /* Corresponding encoded/decoded names and opcodes for Ada user-definable
  71    operators.  */
  72 struct ada_opname_map
  73 {
  74   const char *encoded;
  75   const char *decoded;
  76   enum exp_opcode op;
  77 };
  78
  79 /* Table of Ada operators in encoded and decoded forms.  */
  80 /* Defined in ada-lang.c */
  81 extern const struct ada_opname_map ada_opname_table[];
  82
  83 /* A tuple, (symbol, block), representing one instance of a
  84  * symbol-lookup operation.  */
  85 struct ada_symbol_info {
  86   struct symbol* sym;
  87   struct block* block;
  88 };
  89
  90 /* Denotes a type of renaming symbol (see ada_parse_renaming).  */
  91 enum ada_renaming_category
  92   {
  93     /* Indicates a symbol that does not encode a renaming.  */
  94     ADA_NOT_RENAMING,
  95
  96     /* For symbols declared
  97          Foo : TYPE renamed OBJECT;  */
  98     ADA_OBJECT_RENAMING,
  99
 100     /* For symbols declared
 101          Foo : exception renames EXCEPTION;  */
 102     ADA_EXCEPTION_RENAMING,
 103     /* For packages declared
 104           package Foo renames PACKAGE; */
 105     ADA_PACKAGE_RENAMING,
 106     /* For subprograms declared
 107           SUBPROGRAM_SPEC renames SUBPROGRAM;
 108        (Currently not used).  */
 109     ADA_SUBPROGRAM_RENAMING
 110   };
 111
 112 /* Ada task structures.  */
 113
 114 struct ada_task_info
 115 {
 116   /* The PTID of the thread that this task runs on.  This ptid is computed
 117      in a target-dependent way from the associated Task Control Block.  */
 118   ptid_t ptid;
 119
 120   /* The ID of the task.  */
 121   CORE_ADDR task_id;
 122
 123   /* The name of the task.  */
 124   char name[257];
 125
 126   /* The current state of the task.  */
 127   int state;
 128
 129   /* The priority associated to the task.  */
 130   int priority;
 131
 132   /* If non-zero, the task ID of the parent task.  */
 133   CORE_ADDR parent;
 134
 135   /* If the task is waiting on a task entry, this field contains
 136      the ID of the other task.  Zero otherwise.  */
 137   CORE_ADDR called_task;
 138
 139   /* If the task is accepting a rendezvous with another task, this field
 140      contains the ID of the calling task.  Zero otherwise.  */
 141   CORE_ADDR caller_task;
 142 };
 143
 144 /* Assuming V points to an array of S objects,  make sure that it contains at
 145    least M objects, updating V and S as necessary.  */
 146
 147 #define GROW_VECT(v, s, m)                                    \
 148    if ((s) < (m)) (v) = grow_vect (v, &(s), m, sizeof *(v));
 149
 150 extern void *grow_vect (void *, size_t *, size_t, int);
 151
 152 extern int ada_get_field_index (const struct type *type,
 153                                 const char *field_name,
 154                                 int maybe_missing);
 155
 156 extern int ada_parse (void);    /* Defined in ada-exp.y */
 157
 158 extern void ada_error (char *); /* Defined in ada-exp.y */
 159
 160                         /* Defined in ada-typeprint.c */
 161 extern void ada_print_type (struct type *, const char *, struct ui_file *, int,
 162                             int);
 163
 164 extern void ada_print_typedef (struct type *type, struct symbol *new_symbol,
 165                                struct ui_file *stream);
 166
 167 extern int ada_val_print (struct type *, const gdb_byte *, int, CORE_ADDR,
 168                           struct ui_file *, int,
 169                           const struct value *,
 170                           const struct value_print_options *);
 171
 172 extern int ada_value_print (struct value *, struct ui_file *,
 173                             const struct value_print_options *);
 174
 175                                 /* Defined in ada-lang.c */
 176
 177 extern void ada_emit_char (int, struct type *, struct ui_file *, int, int);
 178
 179 extern void ada_printchar (int, struct type *, struct ui_file *);
 180
 181 extern void ada_printstr (struct ui_file *, struct type *, const gdb_byte *,
 182                           unsigned int, const char *, int,
 183                           const struct value_print_options *);
 184
 185 struct value *ada_convert_actual (struct value *actual,
 186                                   struct type *formal_type0);
 187
 188 extern struct value *ada_value_subscript (struct value *, int,
 189                                           struct value **);
 190
 191 extern void ada_fixup_array_indexes_type (struct type *index_desc_type);
 192
 193 extern struct type *ada_array_element_type (struct type *, int);
 194
 195 extern int ada_array_arity (struct type *);
 196
 197 struct type *ada_type_of_array (struct value *, int);
 198
 199 extern struct value *ada_coerce_to_simple_array_ptr (struct value *);
 200
 201 struct value *ada_coerce_to_simple_array (struct value *);
 202
 203 extern int ada_is_simple_array_type (struct type *);
 204
 205 extern int ada_is_array_descriptor_type (struct type *);
 206
 207 extern int ada_is_bogus_array_descriptor (struct type *);
 208
 209 extern LONGEST ada_discrete_type_low_bound (struct type *);
 210
 211 extern LONGEST ada_discrete_type_high_bound (struct type *);
 212
 213 extern char *ada_decode_symbol (const struct general_symbol_info*);
 214
 215 extern const char *ada_decode (const char*);
 216
 217 extern enum language ada_update_initial_language (enum language);
 218
 219 extern void clear_ada_sym_cache (void);
 220
 221 extern int ada_lookup_symbol_list (const char *, const struct block *,
 222                                    domain_enum, struct ada_symbol_info**);
 223
 224 extern char *ada_fold_name (const char *);
 225
 226 extern struct symbol *ada_lookup_symbol (const char *, const struct block *,
 227                                          domain_enum, int *);
 228
 229 extern struct symbol *
 230 ada_lookup_encoded_symbol (const char *, const struct block *,
 231                            domain_enum namespace, struct block **);
 232
 233 extern struct minimal_symbol *ada_lookup_simple_minsym (const char *);
 234
 235 extern void ada_fill_in_ada_prototype (struct symbol *);
 236
 237 extern int user_select_syms (struct ada_symbol_info *, int, int);
 238
 239 extern int get_selections (int *, int, int, int, char *);
 240
 241 extern int ada_scan_number (const char *, int, LONGEST *, int *);
 242
 243 extern struct type *ada_parent_type (struct type *);
 244
 245 extern int ada_is_ignored_field (struct type *, int);
 246
 247 extern int ada_is_constrained_packed_array_type (struct type *);
 248
 249 extern struct value *ada_value_primitive_packed_val (struct value *,
 250                                                      const gdb_byte *,
 251                                                      long, int, int,
 252                                                      struct type *);
 253
 254 extern struct type *ada_coerce_to_simple_array_type (struct type *);
 255
 256 extern int ada_is_character_type (struct type *);
 257
 258 extern int ada_is_string_type (struct type *);
 259
 260 extern int ada_is_tagged_type (struct type *, int);
 261
 262 extern int ada_is_tag_type (struct type *);
 263
 264 extern struct type *ada_tag_type (struct value *);
 265
 266 extern struct value *ada_value_tag (struct value *);
 267
 268 extern const char *ada_tag_name (struct value *);
 269
 270 extern int ada_is_parent_field (struct type *, int);
 271
 272 extern int ada_is_wrapper_field (struct type *, int);
 273
 274 extern int ada_is_variant_part (struct type *, int);
 275
 276 extern struct type *ada_variant_discrim_type (struct type *, struct type *);
 277
 278 extern int ada_is_others_clause (struct type *, int);
 279
 280 extern int ada_in_variant (LONGEST, struct type *, int);
 281
 282 extern char *ada_variant_discrim_name (struct type *);
 283
 284 extern struct value *ada_value_struct_elt (struct value *, char *, int);
 285
 286 extern int ada_is_aligner_type (struct type *);
 287
 288 extern struct type *ada_aligned_type (struct type *);
 289
 290 extern const gdb_byte *ada_aligned_value_addr (struct type *,
 291                                                const gdb_byte *);
 292
 293 extern const char *ada_attribute_name (enum exp_opcode);
 294
 295 extern int ada_is_fixed_point_type (struct type *);
 296
 297 extern int ada_is_system_address_type (struct type *);
 298
 299 extern DOUBLEST ada_delta (struct type *);
 300
 301 extern DOUBLEST ada_fixed_to_float (struct type *, LONGEST);
 302
 303 extern LONGEST ada_float_to_fixed (struct type *, DOUBLEST);
 304
 305 extern struct type *ada_system_address_type (void);
 306
 307 extern int ada_which_variant_applies (struct type *, struct type *,
 308                                       const gdb_byte *);
 309
 310 extern struct type *ada_to_fixed_type (struct type *, const gdb_byte *,
 311                                        CORE_ADDR, struct value *,
 312                                        int check_tag);
 313
 314 extern struct value *ada_to_fixed_value (struct value *val);
 315
 316 extern struct type *ada_template_to_fixed_record_type_1 (struct type *type,
 317                                                          const gdb_byte *valaddr,
 318                                                          CORE_ADDR address,
 319                                                          struct value *dval0,
 320                                                          int keep_dynamic_fields);
 321
 322 extern int ada_name_prefix_len (const char *);
 323
 324 extern char *ada_type_name (struct type *);
 325
 326 extern struct type *ada_find_parallel_type (struct type *,
 327                                             const char *suffix);
 328
 329 extern LONGEST get_int_var_value (char *, int *);
 330
 331 extern struct symbol *ada_find_any_symbol (const char *name);
 332
 333 extern struct type *ada_find_any_type (const char *name);
 334
 335 extern struct symbol *ada_find_renaming_symbol (const char *name,
 336                                                 struct block *block);
 337
 338 extern int ada_prefer_type (struct type *, struct type *);
 339
 340 extern struct type *ada_get_base_type (struct type *);
 341
 342 extern struct type *ada_check_typedef (struct type *);
 343
 344 extern char *ada_encode (const char *);
 345
 346 extern const char *ada_enum_name (const char *);
 347
 348 extern int ada_is_modular_type (struct type *);
 349
 350 extern ULONGEST ada_modulus (struct type *);
 351
 352 extern struct value *ada_value_ind (struct value *);
 353
 354 extern void ada_print_scalar (struct type *, LONGEST, struct ui_file *);
 355
 356 extern int ada_is_range_type_name (const char *);
 357
 358 extern enum ada_renaming_category ada_parse_renaming (struct symbol *,
 359                                                       const char **,
 360                                                       int *, const char **);
 361
 362 extern void ada_find_printable_frame (struct frame_info *fi);
 363
 364 extern char *ada_breakpoint_rewrite (char *, int *);
 365
 366 extern char *ada_main_name (void);
 367
 368 extern char *ada_name_for_lookup (const char *name);
 369
 370 /* Tasking-related: ada-tasks.c */
 371
 372 extern int valid_task_id (int);
 373
 374 extern int ada_get_task_number (ptid_t);
 375
 376 typedef void (ada_task_list_iterator_ftype) (struct ada_task_info *task);
 377 extern void iterate_over_live_ada_tasks
 378   (ada_task_list_iterator_ftype *iterator);
 379
 380 extern int ada_build_task_list (void);
 381
 382 extern void print_ada_task_info (struct ui_out *uiout,
 383                                  char *taskno_str,
 384                                  struct inferior *inf);
 385
 386 #endif