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