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 struct type_print_options;
  27
  28 #include "value.h"
  29 #include "gdbtypes.h"
  30 #include "breakpoint.h"
  31
  32 /* Names of specific files known to be part of the runtime
  33    system and that might consider (confusing) debugging information.
  34    Each name (a basic regular expression string) is followed by a
  35    comma.  FIXME: Should be part of a configuration file.  */
  36 #if defined(__alpha__) && defined(__osf__)
  37 #define ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS \
  38    "^[agis]-.*\\.ad[bs]$", \
  39    "/usr/shlib/libpthread\\.so",
  40 #elif defined (__linux__)
  41 #define ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS \
  42    "^[agis]-.*\\.ad[bs]$", \
  43    "/lib.*/libpthread\\.so[.0-9]*$", "/lib.*/libpthread\\.a$", \
  44    "/lib.*/libc\\.so[.0-9]*$", "/lib.*/libc\\.a$",
  45 #endif
  46
  47 #if !defined (ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS)
  48 #define ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS \
  49    "^unwind-seh.c$", \
  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    "___finalizer[.$a-zA-Z0-9_]*$",
  59
  60 /* The maximum number of frame levels searched for non-local,
  61  * non-global symbols.  This limit exists as a precaution to prevent
  62  * infinite search loops when the stack is screwed up.  */
  63 #define MAX_ENCLOSING_FRAME_LEVELS 7
  64
  65 /* Maximum number of steps followed in looking for the ultimate
  66    referent of a renaming.  This prevents certain infinite loops that
  67    can otherwise result.  */
  68 #define MAX_RENAMING_CHAIN_LENGTH 10
  69
  70 struct block;
  71
  72 /* Corresponding encoded/decoded names and opcodes for Ada user-definable
  73    operators.  */
  74 struct ada_opname_map
  75 {
  76   const char *encoded;
  77   const char *decoded;
  78   enum exp_opcode op;
  79 };
  80
  81 /* Table of Ada operators in encoded and decoded forms.  */
  82 /* Defined in ada-lang.c */
  83 extern const struct ada_opname_map ada_opname_table[];
  84
  85 /* A tuple representing one instance of a symbol-lookup operation.  */
  86
  87 struct ada_symbol_info
  88 {
  89   /* The symbol that was found.  */
  90   struct symbol *sym;
  91
  92   /* The block where the symbol was found.  */
  93   struct block *block;
  94 };
  95
  96 /* Denotes a type of renaming symbol (see ada_parse_renaming).  */
  97 enum ada_renaming_category
  98   {
  99     /* Indicates a symbol that does not encode a renaming.  */
 100     ADA_NOT_RENAMING,
 101
 102     /* For symbols declared
 103          Foo : TYPE renamed OBJECT;  */
 104     ADA_OBJECT_RENAMING,
 105
 106     /* For symbols declared
 107          Foo : exception renames EXCEPTION;  */
 108     ADA_EXCEPTION_RENAMING,
 109     /* For packages declared
 110           package Foo renames PACKAGE; */
 111     ADA_PACKAGE_RENAMING,
 112     /* For subprograms declared
 113           SUBPROGRAM_SPEC renames SUBPROGRAM;
 114        (Currently not used).  */
 115     ADA_SUBPROGRAM_RENAMING
 116   };
 117
 118 /* Ada task structures.  */
 119
 120 struct ada_task_info
 121 {
 122   /* The PTID of the thread that this task runs on.  This ptid is computed
 123      in a target-dependent way from the associated Task Control Block.  */
 124   ptid_t ptid;
 125
 126   /* The ID of the task.  */
 127   CORE_ADDR task_id;
 128
 129   /* The name of the task.  */
 130   char name[257];
 131
 132   /* The current state of the task.  */
 133   int state;
 134
 135   /* The priority associated to the task.  */
 136   int priority;
 137
 138   /* If non-zero, the task ID of the parent task.  */
 139   CORE_ADDR parent;
 140
 141   /* If the task is waiting on a task entry, this field contains
 142      the ID of the other task.  Zero otherwise.  */
 143   CORE_ADDR called_task;
 144
 145   /* If the task is accepting a rendezvous with another task, this field
 146      contains the ID of the calling task.  Zero otherwise.  */
 147   CORE_ADDR caller_task;
 148 };
 149
 150 /* Assuming V points to an array of S objects,  make sure that it contains at
 151    least M objects, updating V and S as necessary.  */
 152
 153 #define GROW_VECT(v, s, m)                                    \
 154    if ((s) < (m)) (v) = grow_vect (v, &(s), m, sizeof *(v));
 155
 156 extern void *grow_vect (void *, size_t *, size_t, int);
 157
 158 extern int ada_get_field_index (const struct type *type,
 159                                 const char *field_name,
 160                                 int maybe_missing);
 161
 162 extern int ada_parse (void);    /* Defined in ada-exp.y */
 163
 164 extern void ada_error (char *); /* Defined in ada-exp.y */
 165
 166                         /* Defined in ada-typeprint.c */
 167 extern void ada_print_type (struct type *, const char *, struct ui_file *, int,
 168                             int, const struct type_print_options *);
 169
 170 extern void ada_print_typedef (struct type *type, struct symbol *new_symbol,
 171                                struct ui_file *stream);
 172
 173 extern void ada_val_print (struct type *, const gdb_byte *, int, CORE_ADDR,
 174                            struct ui_file *, int,
 175                            const struct value *,
 176                            const struct value_print_options *);
 177
 178 extern void ada_value_print (struct value *, struct ui_file *,
 179                              const struct value_print_options *);
 180
 181                                 /* Defined in ada-lang.c */
 182
 183 extern void ada_emit_char (int, struct type *, struct ui_file *, int, int);
 184
 185 extern void ada_printchar (int, struct type *, struct ui_file *);
 186
 187 extern void ada_printstr (struct ui_file *, struct type *, const gdb_byte *,
 188                           unsigned int, const char *, int,
 189                           const struct value_print_options *);
 190
 191 struct value *ada_convert_actual (struct value *actual,
 192                                   struct type *formal_type0);
 193
 194 extern struct value *ada_value_subscript (struct value *, int,
 195                                           struct value **);
 196
 197 extern void ada_fixup_array_indexes_type (struct type *index_desc_type);
 198
 199 extern struct type *ada_array_element_type (struct type *, int);
 200
 201 extern int ada_array_arity (struct type *);
 202
 203 struct type *ada_type_of_array (struct value *, int);
 204
 205 extern struct value *ada_coerce_to_simple_array_ptr (struct value *);
 206
 207 struct value *ada_coerce_to_simple_array (struct value *);
 208
 209 extern int ada_is_simple_array_type (struct type *);
 210
 211 extern int ada_is_array_descriptor_type (struct type *);
 212
 213 extern int ada_is_bogus_array_descriptor (struct type *);
 214
 215 extern LONGEST ada_discrete_type_low_bound (struct type *);
 216
 217 extern LONGEST ada_discrete_type_high_bound (struct type *);
 218
 219 extern struct value *ada_get_decoded_value (struct value *value);
 220
 221 extern struct type *ada_get_decoded_type (struct type *type);
 222
 223 extern char *ada_decode_symbol (const struct general_symbol_info*);
 224
 225 extern const char *ada_decode (const char*);
 226
 227 extern enum language ada_update_initial_language (enum language);
 228
 229 extern void clear_ada_sym_cache (void);
 230
 231 extern int ada_lookup_symbol_list (const char *, const struct block *,
 232                                    domain_enum, struct ada_symbol_info**,
 233                                    int);
 234
 235 extern char *ada_fold_name (const char *);
 236
 237 extern struct symbol *ada_lookup_symbol (const char *, const struct block *,
 238                                          domain_enum, int *);
 239
 240 extern void ada_lookup_encoded_symbol
 241   (const char *name, const struct block *block, domain_enum namespace,
 242    struct ada_symbol_info *symbol_info);
 243
 244 extern struct minimal_symbol *ada_lookup_simple_minsym (const char *);
 245
 246 extern void ada_fill_in_ada_prototype (struct symbol *);
 247
 248 extern int user_select_syms (struct ada_symbol_info *, int, int);
 249
 250 extern int get_selections (int *, int, int, int, char *);
 251
 252 extern int ada_scan_number (const char *, int, LONGEST *, int *);
 253
 254 extern struct type *ada_parent_type (struct type *);
 255
 256 extern int ada_is_ignored_field (struct type *, int);
 257
 258 extern int ada_is_constrained_packed_array_type (struct type *);
 259
 260 extern struct value *ada_value_primitive_packed_val (struct value *,
 261                                                      const gdb_byte *,
 262                                                      long, int, int,
 263                                                      struct type *);
 264
 265 extern struct type *ada_coerce_to_simple_array_type (struct type *);
 266
 267 extern int ada_is_character_type (struct type *);
 268
 269 extern int ada_is_string_type (struct type *);
 270
 271 extern int ada_is_tagged_type (struct type *, int);
 272
 273 extern int ada_is_tag_type (struct type *);
 274
 275 extern struct type *ada_tag_type (struct value *);
 276
 277 extern struct value *ada_value_tag (struct value *);
 278
 279 extern const char *ada_tag_name (struct value *);
 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                                                 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