gdb/ada-lang.h

   1 /* Ada language support definitions for GDB, the GNU debugger.
   2
   3    Copyright (C) 1992-2013 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 3 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, see <http://www.gnu.org/licenses/>.  */
  19
  20 #if !defined (ADA_LANG_H)
  21 #define ADA_LANG_H 1
  22
  23 struct frame_info;
  24 struct inferior;
  25 struct type_print_options;
  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    "^unwind-seh.c$", \
  49    "^[agis]-.*\\.ad[bs]$",
  50 #endif
  51
  52 /* Names of compiler-generated auxiliary functions probably of no
  53    interest to users.  Each name (a basic regular expression string)
  54    is followed by a comma.  */
  55 #define ADA_KNOWN_AUXILIARY_FUNCTION_NAME_PATTERNS \
  56    "___clean[.$a-zA-Z0-9_]*$", \
  57    "___finalizer[.$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 /* A tuple representing one instance of a symbol-lookup operation.  */
  85
  86 struct ada_symbol_info
  87 {
  88   /* The symbol that was found.  */
  89   struct symbol *sym;
  90
  91   /* The block where the symbol was found.  */
  92   const struct block *block;
  93 };
  94
  95 /* Denotes a type of renaming symbol (see ada_parse_renaming).  */
  96 enum ada_renaming_category
  97   {
  98     /* Indicates a symbol that does not encode a renaming.  */
  99     ADA_NOT_RENAMING,
 100
 101     /* For symbols declared
 102          Foo : TYPE renamed OBJECT;  */
 103     ADA_OBJECT_RENAMING,
 104
 105     /* For symbols declared
 106          Foo : exception renames EXCEPTION;  */
 107     ADA_EXCEPTION_RENAMING,
 108     /* For packages declared
 109           package Foo renames PACKAGE; */
 110     ADA_PACKAGE_RENAMING,
 111     /* For subprograms declared
 112           SUBPROGRAM_SPEC renames SUBPROGRAM;
 113        (Currently not used).  */
 114     ADA_SUBPROGRAM_RENAMING
 115   };
 116
 117 /* Ada task structures.  */
 118
 119 struct ada_task_info
 120 {
 121   /* The PTID of the thread that this task runs on.  This ptid is computed
 122      in a target-dependent way from the associated Task Control Block.  */
 123   ptid_t ptid;
 124
 125   /* The ID of the task.  */
 126   CORE_ADDR task_id;
 127
 128   /* The name of the task.  */
 129   char name[257];
 130
 131   /* The current state of the task.  */
 132   int state;
 133
 134   /* The priority associated to the task.  */
 135   int priority;
 136
 137   /* If non-zero, the task ID of the parent task.  */
 138   CORE_ADDR parent;
 139
 140   /* If the task is waiting on a task entry, this field contains
 141      the ID of the other task.  Zero otherwise.  */
 142   CORE_ADDR called_task;
 143
 144   /* If the task is accepting a rendezvous with another task, this field
 145      contains the ID of the calling task.  Zero otherwise.  */
 146   CORE_ADDR caller_task;
 147 };
 148
 149 /* Assuming V points to an array of S objects,  make sure that it contains at
 150    least M objects, updating V and S as necessary.  */
 151
 152 #define GROW_VECT(v, s, m)                                    \
 153    if ((s) < (m)) (v) = grow_vect (v, &(s), m, sizeof *(v));
 154
 155 extern void *grow_vect (void *, size_t *, size_t, int);
 156
 157 extern int ada_get_field_index (const struct type *type,
 158                                 const char *field_name,
 159                                 int maybe_missing);
 160
 161 extern int ada_parse (void);    /* Defined in ada-exp.y */
 162
 163 extern void ada_error (char *); /* Defined in ada-exp.y */
 164
 165                         /* Defined in ada-typeprint.c */
 166 extern void ada_print_type (struct type *, const char *, struct ui_file *, int,
 167                             int, const struct type_print_options *);
 168
 169 extern void ada_print_typedef (struct type *type, struct symbol *new_symbol,
 170                                struct ui_file *stream);
 171
 172 extern void ada_val_print (struct type *, const gdb_byte *, int, CORE_ADDR,
 173                            struct ui_file *, int,
 174                            const struct value *,
 175                            const struct value_print_options *);
 176
 177 extern void ada_value_print (struct value *, struct ui_file *,
 178                              const struct value_print_options *);
 179
 180                                 /* Defined in ada-lang.c */
 181
 182 extern void ada_emit_char (int, struct type *, struct ui_file *, int, int);
 183
 184 extern void ada_printchar (int, struct type *, struct ui_file *);
 185
 186 extern void ada_printstr (struct ui_file *, struct type *, const gdb_byte *,
 187                           unsigned int, const char *, int,
 188                           const struct value_print_options *);
 189
 190 struct value *ada_convert_actual (struct value *actual,
 191                                   struct type *formal_type0);
 192
 193 extern struct value *ada_value_subscript (struct value *, int,
 194                                           struct value **);
 195
 196 extern void ada_fixup_array_indexes_type (struct type *index_desc_type);
 197
 198 extern struct type *ada_array_element_type (struct type *, int);
 199
 200 extern int ada_array_arity (struct type *);
 201
 202 struct type *ada_type_of_array (struct value *, int);
 203
 204 extern struct value *ada_coerce_to_simple_array_ptr (struct value *);
 205
 206 struct value *ada_coerce_to_simple_array (struct value *);
 207
 208 extern int ada_is_simple_array_type (struct type *);
 209
 210 extern int ada_is_array_descriptor_type (struct type *);
 211
 212 extern int ada_is_bogus_array_descriptor (struct type *);
 213
 214 extern LONGEST ada_discrete_type_low_bound (struct type *);
 215
 216 extern LONGEST ada_discrete_type_high_bound (struct type *);
 217
 218 extern struct value *ada_get_decoded_value (struct value *value);
 219
 220 extern struct type *ada_get_decoded_type (struct type *type);
 221
 222 extern const char *ada_decode_symbol (const struct general_symbol_info *);
 223
 224 extern const char *ada_decode (const char*);
 225
 226 extern enum language ada_update_initial_language (enum language);
 227
 228 extern void clear_ada_sym_cache (void);
 229
 230 extern int ada_lookup_symbol_list (const char *, const struct block *,
 231                                    domain_enum, struct ada_symbol_info**);
 232
 233 extern char *ada_fold_name (const char *);
 234
 235 extern struct symbol *ada_lookup_symbol (const char *, const struct block *,
 236                                          domain_enum, int *);
 237
 238 extern void ada_lookup_encoded_symbol
 239   (const char *name, const struct block *block, domain_enum namespace,
 240    struct ada_symbol_info *symbol_info);
 241
 242 extern struct minimal_symbol *ada_lookup_simple_minsym (const char *);
 243
 244 extern void ada_fill_in_ada_prototype (struct symbol *);
 245
 246 extern int user_select_syms (struct ada_symbol_info *, int, int);
 247
 248 extern int get_selections (int *, int, int, int, char *);
 249
 250 extern int ada_scan_number (const char *, int, LONGEST *, int *);
 251
 252 extern struct type *ada_parent_type (struct type *);
 253
 254 extern int ada_is_ignored_field (struct type *, int);
 255
 256 extern int ada_is_constrained_packed_array_type (struct type *);
 257
 258 extern struct value *ada_value_primitive_packed_val (struct value *,
 259                                                      const gdb_byte *,
 260                                                      long, int, int,
 261                                                      struct type *);
 262
 263 extern struct type *ada_coerce_to_simple_array_type (struct type *);
 264
 265 extern int ada_is_character_type (struct type *);
 266
 267 extern int ada_is_string_type (struct type *);
 268
 269 extern int ada_is_tagged_type (struct type *, int);
 270
 271 extern int ada_is_tag_type (struct type *);
 272
 273 extern struct type *ada_tag_type (struct value *);
 274
 275 extern struct value *ada_value_tag (struct value *);
 276
 277 extern const char *ada_tag_name (struct value *);
 278
 279 extern struct value *ada_tag_value_at_base_address (struct value *obj);
 280
 281 extern int ada_is_parent_field (struct type *, int);
 282
 283 extern int ada_is_wrapper_field (struct type *, int);
 284
 285 extern int ada_is_variant_part (struct type *, int);
 286
 287 extern struct type *ada_variant_discrim_type (struct type *, struct type *);
 288
 289 extern int ada_is_others_clause (struct type *, int);
 290
 291 extern int ada_in_variant (LONGEST, struct type *, int);
 292
 293 extern char *ada_variant_discrim_name (struct type *);
 294
 295 extern struct value *ada_value_struct_elt (struct value *, char *, int);
 296
 297 extern int ada_is_aligner_type (struct type *);
 298
 299 extern struct type *ada_aligned_type (struct type *);
 300
 301 extern const gdb_byte *ada_aligned_value_addr (struct type *,
 302                                                const gdb_byte *);
 303
 304 extern const char *ada_attribute_name (enum exp_opcode);
 305
 306 extern int ada_is_fixed_point_type (struct type *);
 307
 308 extern int ada_is_system_address_type (struct type *);
 309
 310 extern DOUBLEST ada_delta (struct type *);
 311
 312 extern DOUBLEST ada_fixed_to_float (struct type *, LONGEST);
 313
 314 extern LONGEST ada_float_to_fixed (struct type *, DOUBLEST);
 315
 316 extern struct type *ada_system_address_type (void);
 317
 318 extern int ada_which_variant_applies (struct type *, struct type *,
 319                                       const gdb_byte *);
 320
 321 extern struct type *ada_to_fixed_type (struct type *, const gdb_byte *,
 322                                        CORE_ADDR, struct value *,
 323                                        int check_tag);
 324
 325 extern struct value *ada_to_fixed_value (struct value *val);
 326
 327 extern struct type *ada_template_to_fixed_record_type_1 (struct type *type,
 328                                                          const gdb_byte *valaddr,
 329                                                          CORE_ADDR address,
 330                                                          struct value *dval0,
 331                                                          int keep_dynamic_fields);
 332
 333 extern int ada_name_prefix_len (const char *);
 334
 335 extern const char *ada_type_name (struct type *);
 336
 337 extern struct type *ada_find_parallel_type (struct type *,
 338                                             const char *suffix);
 339
 340 extern LONGEST get_int_var_value (char *, int *);
 341
 342 extern struct symbol *ada_find_renaming_symbol (struct symbol *name_sym,
 343                                                 const 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 extern char *ada_name_for_lookup (const char *name);
 376
 377 /* Tasking-related: ada-tasks.c */
 378
 379 extern int valid_task_id (int);
 380
 381 extern int ada_get_task_number (ptid_t);
 382
 383 typedef void (ada_task_list_iterator_ftype) (struct ada_task_info *task);
 384 extern void iterate_over_live_ada_tasks
 385   (ada_task_list_iterator_ftype *iterator);
 386
 387 extern int ada_build_task_list (void);
 388
 389 extern void print_ada_task_info (struct ui_out *uiout,
 390                                  char *taskno_str,
 391                                  struct inferior *inf);
 392
 393 #endif