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 frame_info;
  25
  26 #include "value.h"
  27 #include "gdbtypes.h"
  28 #include "breakpoint.h"
  29
  30 /* Names of specific files known to be part of the runtime
  31    system and that might consider (confusing) debugging information.
  32    Each name (a basic regular expression string) is followed by a
  33    comma.  FIXME: Should be part of a configuration file. */
  34 #if defined(__alpha__) && defined(__osf__)
  35 #define ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS \
  36    "^[agis]-.*\\.ad[bs]$", \
  37    "/usr/shlib/libpthread\\.so",
  38 #elif defined (__linux__)
  39 #define ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS \
  40    "^[agis]-.*\\.ad[bs]$", \
  41    "/lib.*/libpthread\\.so[.0-9]*$", "/lib.*/libpthread\\.a$", \
  42    "/lib.*/libc\\.so[.0-9]*$", "/lib.*/libc\\.a$",
  43 #endif
  44
  45 #if !defined (ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS)
  46 #define ADA_KNOWN_RUNTIME_FILE_NAME_PATTERNS \
  47    "^[agis]-.*\\.ad[bs]$",
  48 #endif
  49
  50 /* Names of compiler-generated auxiliary functions probably of no
  51    interest to users. Each name (a basic regular expression string)
  52    is followed by a comma. */
  53 #define ADA_KNOWN_AUXILIARY_FUNCTION_NAME_PATTERNS \
  54    "___clean[.$a-zA-Z0-9_]*$", \
  55    "___finalizer[.$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 *, const char *, struct ui_file *, int,
 161                             int);
 162
 163 extern void ada_print_typedef (struct type *type, struct symbol *new_symbol,
 164                                struct ui_file *stream);
 165
 166 extern int ada_val_print (struct type *, const gdb_byte *, int, CORE_ADDR,
 167                           struct ui_file *, int,
 168                           const struct value *,
 169                           const struct value_print_options *);
 170
 171 extern int ada_value_print (struct value *, struct ui_file *,
 172                             const struct value_print_options *);
 173
 174                                 /* Defined in ada-lang.c */
 175
 176 extern void ada_emit_char (int, struct type *, struct ui_file *, int, int);
 177
 178 extern void ada_printchar (int, struct type *, struct ui_file *);
 179
 180 extern void ada_printstr (struct ui_file *, struct type *, const gdb_byte *,
 181                           unsigned int, const char *, int,
 182                           const struct value_print_options *);
 183
 184 struct value *ada_convert_actual (struct value *actual,
 185                                   struct type *formal_type0);
 186
 187 extern struct value *ada_value_subscript (struct value *, int,
 188                                           struct value **);
 189
 190 extern void ada_fixup_array_indexes_type (struct type *index_desc_type);
 191
 192 extern struct type *ada_array_element_type (struct type *, int);
 193
 194 extern int ada_array_arity (struct type *);
 195
 196 struct type *ada_type_of_array (struct value *, int);
 197
 198 extern struct value *ada_coerce_to_simple_array_ptr (struct value *);
 199
 200 extern int ada_is_simple_array_type (struct type *);
 201
 202 extern int ada_is_array_descriptor_type (struct type *);
 203
 204 extern int ada_is_bogus_array_descriptor (struct type *);
 205
 206 extern LONGEST ada_discrete_type_low_bound (struct type *);
 207
 208 extern LONGEST ada_discrete_type_high_bound (struct type *);
 209
 210 extern char *ada_decode_symbol (const struct general_symbol_info*);
 211
 212 extern const char *ada_decode (const char*);
 213
 214 extern enum language ada_update_initial_language (enum language);
 215
 216 extern void clear_ada_sym_cache (void);
 217
 218 extern int ada_lookup_symbol_list (const char *, const struct block *,
 219                                    domain_enum, struct ada_symbol_info**);
 220
 221 extern char *ada_fold_name (const char *);
 222
 223 extern struct symbol *ada_lookup_symbol (const char *, const struct block *,
 224                                          domain_enum, int *);
 225
 226 extern struct symbol *
 227 ada_lookup_encoded_symbol (const char *, const struct block *,
 228                            domain_enum namespace, struct block **);
 229
 230 extern struct minimal_symbol *ada_lookup_simple_minsym (const char *);
 231
 232 extern void ada_fill_in_ada_prototype (struct symbol *);
 233
 234 extern int user_select_syms (struct ada_symbol_info *, int, int);
 235
 236 extern int get_selections (int *, int, int, int, char *);
 237
 238 extern char *ada_start_decode_line_1 (char *);
 239
 240 extern struct symtabs_and_lines ada_finish_decode_line_1 (char **,
 241                                                           struct symtab *,
 242                                                           int, char ***);
 243
 244 extern struct symtabs_and_lines ada_sals_for_line (const char*, int,
 245                                                    int, char***, int);
 246
 247 extern int ada_scan_number (const char *, int, LONGEST *, int *);
 248
 249 extern struct type *ada_parent_type (struct type *);
 250
 251 extern int ada_is_ignored_field (struct type *, int);
 252
 253 extern int ada_is_constrained_packed_array_type (struct type *);
 254
 255 extern struct value *ada_value_primitive_packed_val (struct value *,
 256                                                      const gdb_byte *,
 257                                                      long, int, int,
 258                                                      struct type *);
 259
 260 extern struct type *ada_coerce_to_simple_array_type (struct type *);
 261
 262 extern int ada_is_character_type (struct type *);
 263
 264 extern int ada_is_string_type (struct type *);
 265
 266 extern int ada_is_tagged_type (struct type *, int);
 267
 268 extern int ada_is_tag_type (struct type *);
 269
 270 extern struct type *ada_tag_type (struct value *);
 271
 272 extern struct value *ada_value_tag (struct value *);
 273
 274 extern const char *ada_tag_name (struct value *);
 275
 276 extern int ada_is_parent_field (struct type *, int);
 277
 278 extern int ada_is_wrapper_field (struct type *, int);
 279
 280 extern int ada_is_variant_part (struct type *, int);
 281
 282 extern struct type *ada_variant_discrim_type (struct type *, struct type *);
 283
 284 extern int ada_is_others_clause (struct type *, int);
 285
 286 extern int ada_in_variant (LONGEST, struct type *, int);
 287
 288 extern char *ada_variant_discrim_name (struct type *);
 289
 290 extern struct value *ada_value_struct_elt (struct value *, char *, int);
 291
 292 extern int ada_is_aligner_type (struct type *);
 293
 294 extern struct type *ada_aligned_type (struct type *);
 295
 296 extern const gdb_byte *ada_aligned_value_addr (struct type *,
 297                                                const gdb_byte *);
 298
 299 extern const char *ada_attribute_name (enum exp_opcode);
 300
 301 extern int ada_is_fixed_point_type (struct type *);
 302
 303 extern int ada_is_system_address_type (struct type *);
 304
 305 extern DOUBLEST ada_delta (struct type *);
 306
 307 extern DOUBLEST ada_fixed_to_float (struct type *, LONGEST);
 308
 309 extern LONGEST ada_float_to_fixed (struct type *, DOUBLEST);
 310
 311 extern struct type *ada_system_address_type (void);
 312
 313 extern int ada_which_variant_applies (struct type *, struct type *,
 314                                       const gdb_byte *);
 315
 316 extern struct type *ada_to_fixed_type (struct type *, const gdb_byte *,
 317                                        CORE_ADDR, struct value *,
 318                                        int check_tag);
 319
 320 extern struct value *ada_to_fixed_value (struct value *val);
 321
 322 extern struct type *ada_template_to_fixed_record_type_1 (struct type *type,
 323                                                          const gdb_byte *valaddr,
 324                                                          CORE_ADDR address,
 325                                                          struct value *dval0,
 326                                                          int keep_dynamic_fields);
 327
 328 extern int ada_name_prefix_len (const char *);
 329
 330 extern char *ada_type_name (struct type *);
 331
 332 extern struct type *ada_find_parallel_type (struct type *,
 333                                             const char *suffix);
 334
 335 extern LONGEST get_int_var_value (char *, int *);
 336
 337 extern struct symbol *ada_find_any_symbol (const char *name);
 338
 339 extern struct type *ada_find_any_type (const char *name);
 340
 341 extern struct symbol *ada_find_renaming_symbol (const char *name,
 342                                                 struct block *block);
 343
 344 extern int ada_prefer_type (struct type *, struct type *);
 345
 346 extern struct type *ada_get_base_type (struct type *);
 347
 348 extern struct type *ada_check_typedef (struct type *);
 349
 350 extern char *ada_encode (const char *);
 351
 352 extern const char *ada_enum_name (const char *);
 353
 354 extern int ada_is_modular_type (struct type *);
 355
 356 extern ULONGEST ada_modulus (struct type *);
 357
 358 extern struct value *ada_value_ind (struct value *);
 359
 360 extern void ada_print_scalar (struct type *, LONGEST, struct ui_file *);
 361
 362 extern int ada_is_range_type_name (const char *);
 363
 364 extern enum ada_renaming_category ada_parse_renaming (struct symbol *,
 365                                                       const char **,
 366                                                       int *, const char **);
 367
 368 extern void ada_find_printable_frame (struct frame_info *fi);
 369
 370 extern char *ada_breakpoint_rewrite (char *, int *);
 371
 372 extern char *ada_main_name (void);
 373
 374 /* Tasking-related: ada-tasks.c */
 375
 376 extern int valid_task_id (int);
 377
 378 extern int ada_get_task_number (ptid_t);
 379
 380 typedef void (ada_task_list_iterator_ftype) (struct ada_task_info *task);
 381 extern void iterate_over_live_ada_tasks
 382   (ada_task_list_iterator_ftype *iterator);
 383
 384 extern int ada_build_task_list (int warn_if_null);
 385
 386 extern int ada_exception_catchpoint_p (struct breakpoint *b);
 387
 388 extern struct symtab_and_line
 389   ada_decode_exception_location (char *args, char **addr_string,
 390                                  char **exp_string, char **cond_string,
 391                                  struct expression **cond,
 392                                  struct breakpoint_ops **ops);
 393
 394 extern struct symtab_and_line
 395   ada_decode_assert_location (char *args, char **addr_string,
 396                               struct breakpoint_ops **ops);
 397
 398
 399 #endif