gdb/gdbtypes.h

   1 /* Internal type definitions for GDB.
   2    Copyright (C) 1992 Free Software Foundation, Inc.
   3    Contributed by Cygnus Support, using pieces from other GDB modules.
   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 2 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, write to the Free Software
  19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
  20
  21 #if !defined (GDBTYPES_H)
  22 #define GDBTYPES_H 1
  23
  24 /* When gdb creates fundamental types, it uses one of the following
  25    type identifiers.  The identifiers are used to index a vector of
  26    pointers to any types that are created. */
  27
  28 #define FT_VOID                 0
  29 #define FT_BOOLEAN              1
  30 #define FT_CHAR                 2
  31 #define FT_SIGNED_CHAR          3
  32 #define FT_UNSIGNED_CHAR        4
  33 #define FT_SHORT                5
  34 #define FT_SIGNED_SHORT         6
  35 #define FT_UNSIGNED_SHORT       7
  36 #define FT_INTEGER              8
  37 #define FT_SIGNED_INTEGER       9
  38 #define FT_UNSIGNED_INTEGER     10
  39 #define FT_LONG                 11
  40 #define FT_SIGNED_LONG          12
  41 #define FT_UNSIGNED_LONG        13
  42 #define FT_LONG_LONG            14
  43 #define FT_SIGNED_LONG_LONG     15
  44 #define FT_UNSIGNED_LONG_LONG   16
  45 #define FT_FLOAT                17
  46 #define FT_DBL_PREC_FLOAT       18
  47 #define FT_EXT_PREC_FLOAT       19
  48 #define FT_COMPLEX              20
  49 #define FT_DBL_PREC_COMPLEX     21
  50 #define FT_EXT_PREC_COMPLEX     22
  51 #define FT_STRING               23
  52 #define FT_FIXED_DECIMAL        24
  53 #define FT_FLOAT_DECIMAL        25
  54
  55 #define FT_NUM_MEMBERS          26
  56
  57 /* Different kinds of data types are distinguished by the `code' field.  */
  58
  59 enum type_code
  60 {
  61   TYPE_CODE_UNDEF,              /* Not used; catches errors */
  62   TYPE_CODE_PTR,                /* Pointer type */
  63   TYPE_CODE_ARRAY,              /* Array type, lower bound zero */
  64   TYPE_CODE_STRUCT,             /* C struct or Pascal record */
  65   TYPE_CODE_UNION,              /* C union or Pascal variant part */
  66   TYPE_CODE_ENUM,               /* Enumeration type */
  67   TYPE_CODE_FUNC,               /* Function type */
  68   TYPE_CODE_INT,                /* Integer type */
  69   TYPE_CODE_FLT,                /* Floating type */
  70   TYPE_CODE_VOID,               /* Void type (values zero length) */
  71   TYPE_CODE_SET,                /* Pascal sets */
  72   TYPE_CODE_RANGE,              /* Range (integers within spec'd bounds) */
  73   TYPE_CODE_PASCAL_ARRAY,       /* Array with explicit type of index */
  74   TYPE_CODE_ERROR,              /* Unknown type */
  75
  76   /* C++ */
  77   TYPE_CODE_MEMBER,             /* Member type */
  78   TYPE_CODE_METHOD,             /* Method type */
  79   TYPE_CODE_REF,                /* C++ Reference types */
  80
  81   /* Modula-2 */
  82   TYPE_CODE_CHAR,               /* *real* character type */
  83   TYPE_CODE_BOOL                /* Builtin Modula-2 BOOLEAN */
  84 };
  85
  86 /* Some bits for the type's flags word. */
  87
  88 /* Explicitly unsigned integer type */
  89
  90 #define TYPE_FLAG_UNSIGNED      (1 << 0)
  91
  92 /* Explicitly signed integer type */
  93
  94 #define TYPE_FLAG_SIGNED        (1 << 1)
  95
  96 /* This appears in a type's flags word if it is a stub type (eg. if
  97    someone referenced a type that wasn't defined in a source file
  98    via (struct sir_not_appearing_in_this_film *)).  */
  99
 100 #define TYPE_FLAG_STUB          (1 << 2)
 101
 102
 103 struct type
 104 {
 105
 106   /* Code for kind of type */
 107
 108   enum type_code code;
 109
 110   /* Name of this type, or NULL if none.
 111      This is used for printing only, except by poorly designed C++ code.
 112      Type names specified as input are defined by symbols.  */
 113
 114   char *name;
 115
 116   /* Length in bytes of storage for a value of this type */
 117
 118   unsigned length;
 119
 120   /* Every type is now associated with a particular objfile, and the
 121      type is allocated on the type_obstack for that objfile.  One problem
 122      however, is that there are times when gdb allocates new types while
 123      it is not in the process of reading symbols from a particular objfile.
 124      Fortunately, these happen when the type being created is a derived
 125      type of an existing type, such as in lookup_pointer_type().  So
 126      we can just allocate the new type using the same objfile as the
 127      existing type, but to do this we need a backpointer to the objfile
 128      from the existing type.  Yes this is somewhat ugly, but without
 129      major overhaul of the internal type system, it can't be avoided
 130      for now. */
 131
 132   struct objfile *objfile;
 133
 134   /* For a pointer type, describes the type of object pointed to.
 135      For an array type, describes the type of the elements.
 136      For a function or method type, describes the type of the return value.
 137      For a range type, describes the type of the full range.
 138      Unused otherwise.  */
 139
 140   struct type *target_type;
 141
 142   /* Type that is a pointer to this type.
 143      NULL if no such pointer-to type is known yet.
 144      The debugger may add the address of such a type
 145      if it has to construct one later.  */
 146
 147   struct type *pointer_type;
 148
 149   /* C++: also need a reference type.  */
 150
 151   struct type *reference_type;
 152
 153   /* Type that is a function returning this type.
 154      NULL if no such function type is known here.
 155      The debugger may add the address of such a type
 156      if it has to construct one later.  */
 157
 158   struct type *function_type;
 159
 160   /* Flags about this type.  */
 161
 162   short flags;
 163
 164   /* Number of fields described for this type */
 165
 166   short nfields;
 167
 168   /* For structure and union types, a description of each field.
 169      For set and pascal array types, there is one "field",
 170      whose type is the domain type of the set or array.
 171      For range types, there are two "fields",
 172      the minimum and maximum values (both inclusive).
 173      For enum types, each possible value is described by one "field".
 174
 175      Using a pointer to a separate array of fields
 176      allows all types to have the same size, which is useful
 177      because we can allocate the space for a type before
 178      we know what to put in it.  */
 179
 180   struct field
 181     {
 182
 183       /* Position of this field, counting in bits from start of
 184          containing structure.  For a function type, this is the
 185          position in the argument list of this argument.
 186          For a range bound or enum value, this is the value itself.  */
 187
 188       int bitpos;
 189
 190       /* Size of this field, in bits, or zero if not packed.
 191          For an unpacked field, the field's type's length
 192          says how many bytes the field occupies.  */
 193
 194       int bitsize;
 195
 196       /* In a struct or enum type, type of this field.
 197          In a function type, type of this argument.
 198          In an array type, the domain-type of the array.  */
 199
 200       struct type *type;
 201
 202       /* Name of field, value or argument.
 203          NULL for range bounds and array domains.  */
 204
 205       char *name;
 206
 207     } *fields;
 208
 209   /* For types with virtual functions, VPTR_BASETYPE is the base class which
 210      defined the virtual function table pointer.  VPTR_FIELDNO is
 211      the field number of that pointer in the structure.
 212
 213      For types that are pointer to member types, VPTR_BASETYPE
 214      is the type that this pointer is a member of.
 215
 216      Unused otherwise.  */
 217
 218   struct type *vptr_basetype;
 219
 220   int vptr_fieldno;
 221
 222   /* Slot to point to additional language-specific fields of this type.  */
 223
 224   union type_specific
 225     {
 226
 227       /* ARG_TYPES is for TYPE_CODE_METHOD and TYPE_CODE_FUNC.  */
 228
 229       struct type **arg_types;
 230
 231       /* CPLUS_STUFF is for TYPE_CODE_STRUCT.  */
 232
 233       struct cplus_struct_type *cplus_stuff;
 234
 235     } type_specific;
 236 };
 237
 238 #define NULL_TYPE ((struct type *) 0)
 239
 240 /* C++ language-specific information for TYPE_CODE_STRUCT and TYPE_CODE_UNION
 241    nodes.  */
 242
 243 struct cplus_struct_type
 244 {
 245
 246   B_TYPE *virtual_field_bits; /* if base class is virtual */
 247
 248   B_TYPE *private_field_bits;
 249
 250   B_TYPE *protected_field_bits;
 251
 252   /* Number of methods described for this type */
 253
 254   short nfn_fields;
 255
 256   /* Number of base classes this type derives from. */
 257
 258   short n_baseclasses;
 259
 260   /* Number of methods described for this type plus all the
 261      methods that it derives from.  */
 262
 263   int nfn_fields_total;
 264
 265   /* For classes, structures, and unions, a description of each field,
 266      which consists of an overloaded name, followed by the types of
 267      arguments that the method expects, and then the name after it
 268      has been renamed to make it distinct.  */
 269
 270   struct fn_fieldlist
 271     {
 272
 273       /* The overloaded name.  */
 274
 275       char *name;
 276
 277       /* The number of methods with this name.  */
 278
 279       int length;
 280
 281       /* The list of methods.  */
 282
 283       struct fn_field
 284         {
 285
 286           /* The return value of the method */
 287
 288           struct type *type;
 289
 290           /* The argument list */
 291
 292           struct type **args;
 293
 294           /* The name after it has been processed */
 295
 296           char *physname;
 297
 298           /* For virtual functions.   */
 299           /* First baseclass that defines this virtual function.   */
 300
 301           struct type *fcontext;
 302
 303           unsigned int is_const : 1;
 304           unsigned int is_volatile : 1;
 305           unsigned int is_private : 1;
 306           unsigned int is_protected : 1;
 307           unsigned int is_stub : 1;
 308           unsigned int dummy : 3;
 309
 310           /* Index into that baseclass's virtual function table,
 311              minus 2; else if static: VOFFSET_STATIC; else: 0.  */
 312
 313           unsigned voffset : 24;
 314
 315 #         define VOFFSET_STATIC 1
 316
 317         } *fn_fields;
 318
 319     } *fn_fieldlists;
 320
 321   unsigned char via_protected;
 322
 323   unsigned char via_public;
 324 };
 325
 326 /* The default value of TYPE_CPLUS_SPECIFIC(T) points to the
 327    this shared static structure. */
 328
 329 extern const struct cplus_struct_type cplus_struct_default;
 330
 331 extern void
 332 allocate_cplus_struct_type PARAMS ((struct type *));
 333
 334 #define INIT_CPLUS_SPECIFIC(type) \
 335   (TYPE_CPLUS_SPECIFIC(type)=(struct cplus_struct_type*)&cplus_struct_default)
 336 #define ALLOCATE_CPLUS_STRUCT_TYPE(type) allocate_cplus_struct_type (type)
 337 #define HAVE_CPLUS_STRUCT(type) \
 338   (TYPE_CPLUS_SPECIFIC(type) != &cplus_struct_default)
 339
 340 #define TYPE_NAME(thistype) (thistype)->name
 341 #define TYPE_TARGET_TYPE(thistype) (thistype)->target_type
 342 #define TYPE_POINTER_TYPE(thistype) (thistype)->pointer_type
 343 #define TYPE_REFERENCE_TYPE(thistype) (thistype)->reference_type
 344 #define TYPE_FUNCTION_TYPE(thistype) (thistype)->function_type
 345 #define TYPE_LENGTH(thistype) (thistype)->length
 346 #define TYPE_OBJFILE(thistype) (thistype)->objfile
 347 #define TYPE_FLAGS(thistype) (thistype)->flags
 348 #define TYPE_UNSIGNED(thistype) ((thistype)->flags & TYPE_FLAG_UNSIGNED)
 349 #define TYPE_CODE(thistype) (thistype)->code
 350 #define TYPE_NFIELDS(thistype) (thistype)->nfields
 351 #define TYPE_FIELDS(thistype) (thistype)->fields
 352
 353 /* C++ */
 354
 355 #define TYPE_VPTR_BASETYPE(thistype) (thistype)->vptr_basetype
 356 #define TYPE_DOMAIN_TYPE(thistype) (thistype)->vptr_basetype
 357 #define TYPE_VPTR_FIELDNO(thistype) (thistype)->vptr_fieldno
 358 #define TYPE_FN_FIELDS(thistype) TYPE_CPLUS_SPECIFIC(thistype)->fn_fields
 359 #define TYPE_NFN_FIELDS(thistype) TYPE_CPLUS_SPECIFIC(thistype)->nfn_fields
 360 #define TYPE_NFN_FIELDS_TOTAL(thistype) TYPE_CPLUS_SPECIFIC(thistype)->nfn_fields_total
 361 #define TYPE_TYPE_SPECIFIC(thistype) (thistype)->type_specific
 362 #define TYPE_ARG_TYPES(thistype) (thistype)->type_specific.arg_types
 363 #define TYPE_CPLUS_SPECIFIC(thistype) (thistype)->type_specific.cplus_stuff
 364 #define TYPE_BASECLASS(thistype,index) (thistype)->fields[index].type
 365 #define TYPE_N_BASECLASSES(thistype) TYPE_CPLUS_SPECIFIC(thistype)->n_baseclasses
 366 #define TYPE_BASECLASS_NAME(thistype,index) (thistype)->fields[index].name
 367 #define TYPE_BASECLASS_BITPOS(thistype,index) (thistype)->fields[index].bitpos
 368 #define BASETYPE_VIA_PUBLIC(thistype, index) (!TYPE_FIELD_PRIVATE(thistype, index))
 369 #define BASETYPE_VIA_VIRTUAL(thistype, index) \
 370   B_TST(TYPE_CPLUS_SPECIFIC(thistype)->virtual_field_bits, (index))
 371
 372 #define TYPE_FIELD(thistype, n) (thistype)->fields[n]
 373 #define TYPE_FIELD_TYPE(thistype, n) (thistype)->fields[n].type
 374 #define TYPE_FIELD_NAME(thistype, n) (thistype)->fields[n].name
 375 #define TYPE_FIELD_VALUE(thistype, n) (* (int*) &(thistype)->fields[n].type)
 376 #define TYPE_FIELD_BITPOS(thistype, n) (thistype)->fields[n].bitpos
 377 #define TYPE_FIELD_BITSIZE(thistype, n) (thistype)->fields[n].bitsize
 378 #define TYPE_FIELD_PACKED(thistype, n) (thistype)->fields[n].bitsize
 379
 380 #define TYPE_FIELD_PRIVATE_BITS(thistype) \
 381   TYPE_CPLUS_SPECIFIC(thistype)->private_field_bits
 382 #define TYPE_FIELD_PROTECTED_BITS(thistype) \
 383   TYPE_CPLUS_SPECIFIC(thistype)->protected_field_bits
 384 #define TYPE_FIELD_VIRTUAL_BITS(thistype) \
 385   TYPE_CPLUS_SPECIFIC(thistype)->virtual_field_bits
 386 #define SET_TYPE_FIELD_PRIVATE(thistype, n) \
 387   B_SET (TYPE_CPLUS_SPECIFIC(thistype)->private_field_bits, (n))
 388 #define SET_TYPE_FIELD_PROTECTED(thistype, n) \
 389   B_SET (TYPE_CPLUS_SPECIFIC(thistype)->protected_field_bits, (n))
 390 #define SET_TYPE_FIELD_VIRTUAL(thistype, n) \
 391   B_SET (TYPE_CPLUS_SPECIFIC(thistype)->virtual_field_bits, (n))
 392 #define TYPE_FIELD_PRIVATE(thistype, n) \
 393   (TYPE_CPLUS_SPECIFIC(thistype)->private_field_bits == NULL ? 0 \
 394     : B_TST(TYPE_CPLUS_SPECIFIC(thistype)->private_field_bits, (n)))
 395 #define TYPE_FIELD_PROTECTED(thistype, n) \
 396   (TYPE_CPLUS_SPECIFIC(thistype)->protected_field_bits == NULL ? 0 \
 397     : B_TST(TYPE_CPLUS_SPECIFIC(thistype)->protected_field_bits, (n)))
 398 #define TYPE_FIELD_VIRTUAL(thistype, n) \
 399        B_TST(TYPE_CPLUS_SPECIFIC(thistype)->virtual_field_bits, (n))
 400
 401 #define TYPE_FIELD_STATIC(thistype, n) ((thistype)->fields[n].bitpos == -1)
 402 #define TYPE_FIELD_STATIC_PHYSNAME(thistype, n) ((char *)(thistype)->fields[n].bitsize)
 403
 404 #define TYPE_FN_FIELDLISTS(thistype) TYPE_CPLUS_SPECIFIC(thistype)->fn_fieldlists
 405 #define TYPE_FN_FIELDLIST(thistype, n) TYPE_CPLUS_SPECIFIC(thistype)->fn_fieldlists[n]
 406 #define TYPE_FN_FIELDLIST1(thistype, n) TYPE_CPLUS_SPECIFIC(thistype)->fn_fieldlists[n].fn_fields
 407 #define TYPE_FN_FIELDLIST_NAME(thistype, n) TYPE_CPLUS_SPECIFIC(thistype)->fn_fieldlists[n].name
 408 #define TYPE_FN_FIELDLIST_LENGTH(thistype, n) TYPE_CPLUS_SPECIFIC(thistype)->fn_fieldlists[n].length
 409
 410 #define TYPE_FN_FIELD(thisfn, n) (thisfn)[n]
 411 #define TYPE_FN_FIELD_NAME(thisfn, n) (thisfn)[n].name
 412 #define TYPE_FN_FIELD_TYPE(thisfn, n) (thisfn)[n].type
 413 #define TYPE_FN_FIELD_ARGS(thisfn, n) TYPE_ARG_TYPES ((thisfn)[n].type)
 414 #define TYPE_FN_FIELD_PHYSNAME(thisfn, n) (thisfn)[n].physname
 415 #define TYPE_FN_FIELD_VIRTUAL_P(thisfn, n) ((thisfn)[n].voffset > 1)
 416 #define TYPE_FN_FIELD_STATIC_P(thisfn, n) ((thisfn)[n].voffset == VOFFSET_STATIC)
 417 #define TYPE_FN_FIELD_VOFFSET(thisfn, n) ((thisfn)[n].voffset-2)
 418 #define TYPE_FN_FIELD_FCONTEXT(thisfn, n) ((thisfn)[n].fcontext)
 419 #define TYPE_FN_FIELD_STUB(thisfn, n) ((thisfn)[n].is_stub)
 420 #define TYPE_FN_FIELD_PRIVATE(thisfn, n) ((thisfn)[n].is_private)
 421 #define TYPE_FN_FIELD_PROTECTED(thisfn, n) ((thisfn)[n].is_protected)
 422
 423 extern struct type *builtin_type_void;
 424 extern struct type *builtin_type_char;
 425 extern struct type *builtin_type_short;
 426 extern struct type *builtin_type_int;
 427 extern struct type *builtin_type_long;
 428 extern struct type *builtin_type_signed_char;
 429 extern struct type *builtin_type_unsigned_char;
 430 extern struct type *builtin_type_unsigned_short;
 431 extern struct type *builtin_type_unsigned_int;
 432 extern struct type *builtin_type_unsigned_long;
 433 extern struct type *builtin_type_float;
 434 extern struct type *builtin_type_double;
 435 extern struct type *builtin_type_long_double;
 436 extern struct type *builtin_type_complex;
 437 extern struct type *builtin_type_double_complex;
 438
 439 /* This type represents a type that was unrecognized in symbol
 440    read-in.  */
 441
 442 extern struct type *builtin_type_error;
 443
 444 extern struct type *builtin_type_long_long;
 445 extern struct type *builtin_type_unsigned_long_long;
 446
 447 /* Modula-2 types */
 448
 449 extern struct type *builtin_type_m2_char;
 450 extern struct type *builtin_type_m2_int;
 451 extern struct type *builtin_type_m2_card;
 452 extern struct type *builtin_type_m2_real;
 453 extern struct type *builtin_type_m2_bool;
 454
 455 /* LONG_LONG is defined if the host has "long long".  */
 456
 457 #ifdef LONG_LONG
 458
 459 #define BUILTIN_TYPE_LONGEST builtin_type_long_long
 460 #define BUILTIN_TYPE_UNSIGNED_LONGEST builtin_type_unsigned_long_long
 461
 462 #else /* not LONG_LONG.  */
 463
 464 #define BUILTIN_TYPE_LONGEST builtin_type_long
 465 #define BUILTIN_TYPE_UNSIGNED_LONGEST builtin_type_unsigned_long
 466
 467 #endif /* not LONG_LONG.  */
 468
 469 /* Maximum and minimum values of built-in types */
 470
 471 #define MAX_OF_TYPE(t)  \
 472    TYPE_UNSIGNED(t) ? UMAX_OF_SIZE(TYPE_LENGTH(t)) \
 473     : MAX_OF_SIZE(TYPE_LENGTH(t))
 474
 475 #define MIN_OF_TYPE(t)  \
 476    TYPE_UNSIGNED(t) ? UMIN_OF_SIZE(TYPE_LENGTH(t)) \
 477     : MIN_OF_SIZE(TYPE_LENGTH(t))
 478
 479 extern struct type *
 480 alloc_type PARAMS ((struct objfile *));
 481
 482 extern struct type *
 483 init_type PARAMS ((enum type_code, int, int, char *, struct objfile *));
 484
 485 extern struct type *
 486 lookup_reference_type PARAMS ((struct type *));
 487
 488 extern struct type *
 489 make_reference_type PARAMS ((struct type *, struct type **));
 490
 491 extern struct type *
 492 lookup_member_type PARAMS ((struct type *, struct type *));
 493
 494 extern void
 495 smash_to_method_type PARAMS ((struct type *, struct type *, struct type *,
 496                               struct type **));
 497
 498 extern void
 499 smash_to_member_type PARAMS ((struct type *, struct type *, struct type *));
 500
 501 extern struct type *
 502 allocate_stub_method PARAMS ((struct type *));
 503
 504 extern char *
 505 type_name_no_tag PARAMS ((const struct type *));
 506
 507 extern struct type *
 508 lookup_struct_elt_type PARAMS ((struct type *, char *, int));
 509
 510 extern struct type *
 511 make_pointer_type PARAMS ((struct type *, struct type **));
 512
 513 extern struct type *
 514 lookup_pointer_type PARAMS ((struct type *));
 515
 516 extern struct type *
 517 make_function_type PARAMS ((struct type *, struct type **));
 518
 519 extern struct type *
 520 lookup_function_type PARAMS ((struct type *));
 521
 522 extern struct type *
 523 create_array_type PARAMS ((struct type *, int));
 524
 525 extern struct type *
 526 lookup_unsigned_typename PARAMS ((char *));
 527
 528 extern void
 529 check_stub_type PARAMS ((struct type *));
 530
 531 extern void
 532 check_stub_method PARAMS ((struct type *, int, int));
 533
 534 extern struct type *
 535 lookup_primitive_typename PARAMS ((char *));
 536
 537 extern char *
 538 gdb_mangle_name PARAMS ((struct type *, int, int));
 539
 540 extern struct type *
 541 builtin_type PARAMS ((char **));
 542
 543 extern struct type *
 544 error_type PARAMS ((char **));
 545
 546 extern struct type *
 547 lookup_typename PARAMS ((char *, struct block *, int));
 548
 549 extern struct type *
 550 lookup_template_type PARAMS ((char *, struct type *, struct block *));
 551
 552 extern struct type *
 553 lookup_fundamental_type PARAMS ((struct objfile *, int));
 554
 555 extern void
 556 fill_in_vptr_fieldno PARAMS ((struct type *));
 557
 558 /* printcmd.c */
 559
 560 extern void
 561 print_scalar_formatted PARAMS ((char *, struct type *, int, int, FILE *));
 562
 563 #endif  /* GDBTYPES_H */