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.
5 This file is part of GDB.
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.
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.
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. */
21 #if !defined (GDBTYPES_H)
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. */
31 #define FT_SIGNED_CHAR 3
32 #define FT_UNSIGNED_CHAR 4
34 #define FT_SIGNED_SHORT 6
35 #define FT_UNSIGNED_SHORT 7
37 #define FT_SIGNED_INTEGER 9
38 #define FT_UNSIGNED_INTEGER 10
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
46 #define FT_DBL_PREC_FLOAT 18
47 #define FT_EXT_PREC_FLOAT 19
49 #define FT_DBL_PREC_COMPLEX 21
50 #define FT_EXT_PREC_COMPLEX 22
52 #define FT_FIXED_DECIMAL 24
53 #define FT_FLOAT_DECIMAL 25
55 #define FT_UNSIGNED_BYTE 27
57 #define FT_NUM_MEMBERS 28 /* Highest FT_* above, plus one. */
59 /* Some macros for char-based bitfields. */
61 #define B_SET(a,x) ((a)[(x)>>3] |= (1 << ((x)&7)))
62 #define B_CLR(a,x) ((a)[(x)>>3] &= ~(1 << ((x)&7)))
63 #define B_TST(a,x) ((a)[(x)>>3] & (1 << ((x)&7)))
64 #define B_TYPE unsigned char
65 #define B_BYTES(x) ( 1 + ((x)>>3) )
66 #define B_CLRALL(a,x) memset ((a), 0, B_BYTES(x))
68 /* Different kinds of data types are distinguished by the `code' field. */
72 TYPE_CODE_UNDEF, /* Not used; catches errors */
73 TYPE_CODE_PTR, /* Pointer type */
74 TYPE_CODE_ARRAY, /* Array type with lower & upper bounds. */
75 TYPE_CODE_STRUCT, /* C struct or Pascal record */
76 TYPE_CODE_UNION, /* C union or Pascal variant part */
77 TYPE_CODE_ENUM, /* Enumeration type */
78 TYPE_CODE_FUNC, /* Function type */
79 TYPE_CODE_INT, /* Integer type */
81 /* Floating type. This is *NOT* a complex type. Complex types, when
82 we have them, will have their own type code (or TYPE_CODE_ERROR if
83 we can parse a complex type but not manipulate it). There are parts
84 of GDB which bogusly assume that TYPE_CODE_FLT can mean complex. */
87 /* Void type (values zero length; the length field is ignored). */
90 TYPE_CODE_SET, /* Pascal sets */
91 TYPE_CODE_RANGE, /* Range (integers within spec'd bounds) */
92 TYPE_CODE_STRING, /* String types, distinct from array of char */
93 TYPE_CODE_BITSTRING, /* String of bits, distinct from bool array */
95 /* Unknown type. The length field is valid if we were able to
96 deduce that much about the type, or 0 if we don't even know that. */
100 TYPE_CODE_MEMBER, /* Member type */
101 TYPE_CODE_METHOD, /* Method type */
102 TYPE_CODE_REF, /* C++ Reference types */
105 TYPE_CODE_CHAR, /* *real* character type */
106 TYPE_CODE_BOOL /* BOOLEAN type */
109 /* For now allow source to use TYPE_CODE_CLASS for C++ classes, as an
110 alias for TYPE_CODE_STRUCT. Eventually these should probably be
111 officially distinct types within gdb. */
113 #define TYPE_CODE_CLASS TYPE_CODE_STRUCT
115 /* Some bits for the type's flags word. */
117 /* Explicitly unsigned integer type */
119 #define TYPE_FLAG_UNSIGNED (1 << 0)
121 /* Explicitly signed integer type */
123 #define TYPE_FLAG_SIGNED (1 << 1)
125 /* This appears in a type's flags word if it is a stub type (eg. if
126 someone referenced a type that wasn't defined in a source file
127 via (struct sir_not_appearing_in_this_film *)). */
129 #define TYPE_FLAG_STUB (1 << 2)
135 /* Code for kind of type */
139 /* Name of this type, or NULL if none.
140 This is used for printing only, except by poorly designed C++ code.
141 Type names specified as input are defined by symbols. */
145 /* Tag name for this type, or NULL if none. This is a feature which is
146 specific to C/C++ for structs, unions, or enums.
147 This is used for printing only, except by poorly designed C++ code. */
151 /* Length, in units of TARGET_CHAR_BIT bits,
152 of storage for a value of this type */
156 /* Every type is now associated with a particular objfile, and the
157 type is allocated on the type_obstack for that objfile. One problem
158 however, is that there are times when gdb allocates new types while
159 it is not in the process of reading symbols from a particular objfile.
160 Fortunately, these happen when the type being created is a derived
161 type of an existing type, such as in lookup_pointer_type(). So
162 we can just allocate the new type using the same objfile as the
163 existing type, but to do this we need a backpointer to the objfile
164 from the existing type. Yes this is somewhat ugly, but without
165 major overhaul of the internal type system, it can't be avoided
168 struct objfile *objfile;
170 /* For a pointer type, describes the type of object pointed to.
171 For an array type, describes the type of the elements.
172 For a function or method type, describes the type of the return value.
173 For a range type, describes the type of the full range.
176 struct type *target_type;
178 /* Type that is a pointer to this type.
179 NULL if no such pointer-to type is known yet.
180 The debugger may add the address of such a type
181 if it has to construct one later. */
183 struct type *pointer_type;
185 /* C++: also need a reference type. */
187 struct type *reference_type;
189 /* Type that is a function returning this type.
190 NULL if no such function type is known here.
191 The debugger may add the address of such a type
192 if it has to construct one later. */
194 struct type *function_type;
196 /* Flags about this type. */
200 /* Number of fields described for this type */
204 /* For structure and union types, a description of each field.
205 For set and pascal array types, there is one "field",
206 whose type is the domain type of the set or array.
207 For range types, there are two "fields",
208 the minimum and maximum values (both inclusive).
209 For enum types, each possible value is described by one "field".
210 For C++ classes, there is one field for each base class (if it is
211 a derived class) plus one field for each class data member. Member
212 functions are recorded elsewhere.
214 Using a pointer to a separate array of fields
215 allows all types to have the same size, which is useful
216 because we can allocate the space for a type before
217 we know what to put in it. */
222 /* Position of this field, counting in bits from start of
223 containing structure. For a function type, this is the
224 position in the argument list of this argument.
225 For a range bound or enum value, this is the value itself.
226 (FIXME: What about ranges larger than host int size?)
227 For BITS_BIG_ENDIAN=1 targets, it is the bit offset to the MSB.
228 For BITS_BIG_ENDIAN=0 targets, it is the bit offset to the LSB. */
232 /* Size of this field, in bits, or zero if not packed.
233 For an unpacked field, the field's type's length
234 says how many bytes the field occupies. */
238 /* In a struct or enum type, type of this field.
239 In a function type, type of this argument.
240 In an array type, the domain-type of the array. */
244 /* Name of field, value or argument.
245 NULL for range bounds and array domains. */
251 /* For types with virtual functions, VPTR_BASETYPE is the base class which
252 defined the virtual function table pointer. VPTR_FIELDNO is
253 the field number of that pointer in the structure.
255 For types that are pointer to member types, VPTR_BASETYPE
256 is the type that this pointer is a member of.
260 struct type *vptr_basetype;
264 /* Slot to point to additional language-specific fields of this type. */
269 /* ARG_TYPES is for TYPE_CODE_METHOD and TYPE_CODE_FUNC. */
271 struct type **arg_types;
273 /* CPLUS_STUFF is for TYPE_CODE_STRUCT. It is initialized to point to
274 cplus_struct_default, a default static instance of a struct
275 cplus_struct_type. */
277 struct cplus_struct_type *cplus_stuff;
282 #define NULL_TYPE ((struct type *) 0)
284 /* C++ language-specific information for TYPE_CODE_STRUCT and TYPE_CODE_UNION
287 struct cplus_struct_type
289 /* Number of base classes this type derives from. */
293 /* Number of methods with unique names. All overloaded methods with
294 the same name count only once. */
298 /* Number of methods described for this type plus all the
299 methods that it derives from. */
301 int nfn_fields_total;
303 /* For derived classes, the number of base classes is given by n_baseclasses
304 and virtual_field_bits is a bit vector containing one bit per base class.
305 If the base class is virtual, the corresponding bit will be set.
310 class C : public B, public virtual A {};
312 B is a baseclass of C; A is a virtual baseclass for C.
313 This is a C++ 2.0 language feature. */
315 B_TYPE *virtual_field_bits;
317 /* For classes with private fields, the number of fields is given by
318 nfields and private_field_bits is a bit vector containing one bit
320 If the field is private, the corresponding bit will be set. */
322 B_TYPE *private_field_bits;
324 /* For classes with protected fields, the number of fields is given by
325 nfields and protected_field_bits is a bit vector containing one bit
327 If the field is private, the corresponding bit will be set. */
329 B_TYPE *protected_field_bits;
331 /* For classes, structures, and unions, a description of each field,
332 which consists of an overloaded name, followed by the types of
333 arguments that the method expects, and then the name after it
334 has been renamed to make it distinct.
336 fn_fieldlists points to an array of nfn_fields of these. */
341 /* The overloaded name. */
345 /* The number of methods with this name. */
349 /* The list of methods. */
354 /* The name after it has been processed */
358 /* The return value of the method */
362 /* The argument list */
366 /* For virtual functions.
367 First baseclass that defines this virtual function. */
369 struct type *fcontext;
373 unsigned int is_const : 1;
374 unsigned int is_volatile : 1;
375 unsigned int is_private : 1;
376 unsigned int is_protected : 1;
377 unsigned int is_stub : 1;
378 unsigned int dummy : 3;
380 /* Index into that baseclass's virtual function table,
381 minus 2; else if static: VOFFSET_STATIC; else: 0. */
383 unsigned int voffset : 24;
385 # define VOFFSET_STATIC 1
393 /* The default value of TYPE_CPLUS_SPECIFIC(T) points to the
394 this shared static structure. */
396 extern const struct cplus_struct_type cplus_struct_default;
399 allocate_cplus_struct_type PARAMS ((struct type *));
401 #define INIT_CPLUS_SPECIFIC(type) \
402 (TYPE_CPLUS_SPECIFIC(type)=(struct cplus_struct_type*)&cplus_struct_default)
403 #define ALLOCATE_CPLUS_STRUCT_TYPE(type) allocate_cplus_struct_type (type)
404 #define HAVE_CPLUS_STRUCT(type) \
405 (TYPE_CPLUS_SPECIFIC(type) != &cplus_struct_default)
407 #define TYPE_NAME(thistype) (thistype)->name
408 #define TYPE_TAG_NAME(type) ((type)->tag_name)
409 #define TYPE_TARGET_TYPE(thistype) (thistype)->target_type
410 #define TYPE_POINTER_TYPE(thistype) (thistype)->pointer_type
411 #define TYPE_REFERENCE_TYPE(thistype) (thistype)->reference_type
412 #define TYPE_FUNCTION_TYPE(thistype) (thistype)->function_type
413 #define TYPE_LENGTH(thistype) (thistype)->length
414 #define TYPE_OBJFILE(thistype) (thistype)->objfile
415 #define TYPE_FLAGS(thistype) (thistype)->flags
416 #define TYPE_UNSIGNED(thistype) ((thistype)->flags & TYPE_FLAG_UNSIGNED)
417 #define TYPE_CODE(thistype) (thistype)->code
418 #define TYPE_NFIELDS(thistype) (thistype)->nfields
419 #define TYPE_FIELDS(thistype) (thistype)->fields
423 #define TYPE_VPTR_BASETYPE(thistype) (thistype)->vptr_basetype
424 #define TYPE_DOMAIN_TYPE(thistype) (thistype)->vptr_basetype
425 #define TYPE_VPTR_FIELDNO(thistype) (thistype)->vptr_fieldno
426 #define TYPE_FN_FIELDS(thistype) TYPE_CPLUS_SPECIFIC(thistype)->fn_fields
427 #define TYPE_NFN_FIELDS(thistype) TYPE_CPLUS_SPECIFIC(thistype)->nfn_fields
428 #define TYPE_NFN_FIELDS_TOTAL(thistype) TYPE_CPLUS_SPECIFIC(thistype)->nfn_fields_total
429 #define TYPE_TYPE_SPECIFIC(thistype) (thistype)->type_specific
430 #define TYPE_ARG_TYPES(thistype) (thistype)->type_specific.arg_types
431 #define TYPE_CPLUS_SPECIFIC(thistype) (thistype)->type_specific.cplus_stuff
432 #define TYPE_BASECLASS(thistype,index) (thistype)->fields[index].type
433 #define TYPE_N_BASECLASSES(thistype) TYPE_CPLUS_SPECIFIC(thistype)->n_baseclasses
434 #define TYPE_BASECLASS_NAME(thistype,index) (thistype)->fields[index].name
435 #define TYPE_BASECLASS_BITPOS(thistype,index) (thistype)->fields[index].bitpos
436 #define BASETYPE_VIA_PUBLIC(thistype, index) (!TYPE_FIELD_PRIVATE(thistype, index))
437 #define BASETYPE_VIA_VIRTUAL(thistype, index) \
438 B_TST(TYPE_CPLUS_SPECIFIC(thistype)->virtual_field_bits, (index))
440 #define TYPE_FIELD(thistype, n) (thistype)->fields[n]
441 #define TYPE_FIELD_TYPE(thistype, n) (thistype)->fields[n].type
442 #define TYPE_FIELD_NAME(thistype, n) (thistype)->fields[n].name
443 #define TYPE_FIELD_VALUE(thistype, n) (* (int*) &(thistype)->fields[n].type)
444 #define TYPE_FIELD_BITPOS(thistype, n) (thistype)->fields[n].bitpos
445 #define TYPE_FIELD_BITSIZE(thistype, n) (thistype)->fields[n].bitsize
446 #define TYPE_FIELD_PACKED(thistype, n) (thistype)->fields[n].bitsize
448 #define TYPE_FIELD_PRIVATE_BITS(thistype) \
449 TYPE_CPLUS_SPECIFIC(thistype)->private_field_bits
450 #define TYPE_FIELD_PROTECTED_BITS(thistype) \
451 TYPE_CPLUS_SPECIFIC(thistype)->protected_field_bits
452 #define TYPE_FIELD_VIRTUAL_BITS(thistype) \
453 TYPE_CPLUS_SPECIFIC(thistype)->virtual_field_bits
454 #define SET_TYPE_FIELD_PRIVATE(thistype, n) \
455 B_SET (TYPE_CPLUS_SPECIFIC(thistype)->private_field_bits, (n))
456 #define SET_TYPE_FIELD_PROTECTED(thistype, n) \
457 B_SET (TYPE_CPLUS_SPECIFIC(thistype)->protected_field_bits, (n))
458 #define SET_TYPE_FIELD_VIRTUAL(thistype, n) \
459 B_SET (TYPE_CPLUS_SPECIFIC(thistype)->virtual_field_bits, (n))
460 #define TYPE_FIELD_PRIVATE(thistype, n) \
461 (TYPE_CPLUS_SPECIFIC(thistype)->private_field_bits == NULL ? 0 \
462 : B_TST(TYPE_CPLUS_SPECIFIC(thistype)->private_field_bits, (n)))
463 #define TYPE_FIELD_PROTECTED(thistype, n) \
464 (TYPE_CPLUS_SPECIFIC(thistype)->protected_field_bits == NULL ? 0 \
465 : B_TST(TYPE_CPLUS_SPECIFIC(thistype)->protected_field_bits, (n)))
466 #define TYPE_FIELD_VIRTUAL(thistype, n) \
467 B_TST(TYPE_CPLUS_SPECIFIC(thistype)->virtual_field_bits, (n))
469 #define TYPE_FIELD_STATIC(thistype, n) ((thistype)->fields[n].bitpos == -1)
470 #define TYPE_FIELD_STATIC_PHYSNAME(thistype, n) ((char *)(thistype)->fields[n].bitsize)
472 #define TYPE_FN_FIELDLISTS(thistype) TYPE_CPLUS_SPECIFIC(thistype)->fn_fieldlists
473 #define TYPE_FN_FIELDLIST(thistype, n) TYPE_CPLUS_SPECIFIC(thistype)->fn_fieldlists[n]
474 #define TYPE_FN_FIELDLIST1(thistype, n) TYPE_CPLUS_SPECIFIC(thistype)->fn_fieldlists[n].fn_fields
475 #define TYPE_FN_FIELDLIST_NAME(thistype, n) TYPE_CPLUS_SPECIFIC(thistype)->fn_fieldlists[n].name
476 #define TYPE_FN_FIELDLIST_LENGTH(thistype, n) TYPE_CPLUS_SPECIFIC(thistype)->fn_fieldlists[n].length
478 #define TYPE_FN_FIELD(thisfn, n) (thisfn)[n]
479 #define TYPE_FN_FIELD_PHYSNAME(thisfn, n) (thisfn)[n].physname
480 #define TYPE_FN_FIELD_TYPE(thisfn, n) (thisfn)[n].type
481 #define TYPE_FN_FIELD_ARGS(thisfn, n) TYPE_ARG_TYPES ((thisfn)[n].type)
482 #define TYPE_FN_FIELD_CONST(thisfn, n) ((thisfn)[n].is_const)
483 #define TYPE_FN_FIELD_VOLATILE(thisfn, n) ((thisfn)[n].is_volatile)
484 #define TYPE_FN_FIELD_PRIVATE(thisfn, n) ((thisfn)[n].is_private)
485 #define TYPE_FN_FIELD_PROTECTED(thisfn, n) ((thisfn)[n].is_protected)
486 #define TYPE_FN_FIELD_STUB(thisfn, n) ((thisfn)[n].is_stub)
487 #define TYPE_FN_FIELD_FCONTEXT(thisfn, n) ((thisfn)[n].fcontext)
488 #define TYPE_FN_FIELD_VOFFSET(thisfn, n) ((thisfn)[n].voffset-2)
489 #define TYPE_FN_FIELD_VIRTUAL_P(thisfn, n) ((thisfn)[n].voffset > 1)
490 #define TYPE_FN_FIELD_STATIC_P(thisfn, n) ((thisfn)[n].voffset == VOFFSET_STATIC)
492 extern struct type *builtin_type_void;
493 extern struct type *builtin_type_char;
494 extern struct type *builtin_type_short;
495 extern struct type *builtin_type_int;
496 extern struct type *builtin_type_long;
497 extern struct type *builtin_type_signed_char;
498 extern struct type *builtin_type_unsigned_char;
499 extern struct type *builtin_type_unsigned_short;
500 extern struct type *builtin_type_unsigned_int;
501 extern struct type *builtin_type_unsigned_long;
502 extern struct type *builtin_type_float;
503 extern struct type *builtin_type_double;
504 extern struct type *builtin_type_long_double;
505 extern struct type *builtin_type_complex;
506 extern struct type *builtin_type_double_complex;
507 extern struct type *builtin_type_string;
509 /* This type represents a type that was unrecognized in symbol
512 extern struct type *builtin_type_error;
514 extern struct type *builtin_type_long_long;
515 extern struct type *builtin_type_unsigned_long_long;
519 extern struct type *builtin_type_m2_char;
520 extern struct type *builtin_type_m2_int;
521 extern struct type *builtin_type_m2_card;
522 extern struct type *builtin_type_m2_real;
523 extern struct type *builtin_type_m2_bool;
527 extern struct type *builtin_type_chill_bool;
528 extern struct type *builtin_type_chill_char;
529 extern struct type *builtin_type_chill_long;
530 extern struct type *builtin_type_chill_ulong;
531 extern struct type *builtin_type_chill_real;
533 /* CC_HAS_LONG_LONG is defined if the host has "long long". */
535 #ifdef CC_HAS_LONG_LONG
537 #define BUILTIN_TYPE_LONGEST builtin_type_long_long
538 #define BUILTIN_TYPE_UNSIGNED_LONGEST builtin_type_unsigned_long_long
540 #else /* not CC_HAS_LONG_LONG. */
542 #define BUILTIN_TYPE_LONGEST builtin_type_long
543 #define BUILTIN_TYPE_UNSIGNED_LONGEST builtin_type_unsigned_long
545 #endif /* not CC_HAS_LONG_LONG. */
547 /* Maximum and minimum values of built-in types */
549 #define MAX_OF_TYPE(t) \
550 TYPE_UNSIGNED(t) ? UMAX_OF_SIZE(TYPE_LENGTH(t)) \
551 : MAX_OF_SIZE(TYPE_LENGTH(t))
553 #define MIN_OF_TYPE(t) \
554 TYPE_UNSIGNED(t) ? UMIN_OF_SIZE(TYPE_LENGTH(t)) \
555 : MIN_OF_SIZE(TYPE_LENGTH(t))
557 /* Allocate space for storing data associated with a particular type.
558 We ensure that the space is allocated using the same mechanism that
559 was used to allocate the space for the type structure itself. I.E.
560 if the type is on an objfile's type_obstack, then the space for data
561 associated with that type will also be allocated on the type_obstack.
562 If the type is not associated with any particular objfile (such as
563 builtin types), then the data space will be allocated with xmalloc,
564 the same as for the type structure. */
566 #define TYPE_ALLOC(t,size) \
567 (TYPE_OBJFILE (t) != NULL \
568 ? obstack_alloc (&TYPE_OBJFILE (t) -> type_obstack, size) \
572 alloc_type PARAMS ((struct objfile *));
575 init_type PARAMS ((enum type_code, int, int, char *, struct objfile *));
578 lookup_reference_type PARAMS ((struct type *));
581 make_reference_type PARAMS ((struct type *, struct type **));
584 lookup_member_type PARAMS ((struct type *, struct type *));
587 smash_to_method_type PARAMS ((struct type *, struct type *, struct type *,
591 smash_to_member_type PARAMS ((struct type *, struct type *, struct type *));
594 allocate_stub_method PARAMS ((struct type *));
597 type_name_no_tag PARAMS ((const struct type *));
600 lookup_struct_elt_type PARAMS ((struct type *, char *, int));
603 make_pointer_type PARAMS ((struct type *, struct type **));
606 lookup_pointer_type PARAMS ((struct type *));
609 make_function_type PARAMS ((struct type *, struct type **));
612 lookup_function_type PARAMS ((struct type *));
615 create_range_type PARAMS ((struct type *, struct type *, int, int));
618 create_array_type PARAMS ((struct type *, struct type *, struct type *));
621 create_string_type PARAMS ((struct type *, struct type *));
624 lookup_unsigned_typename PARAMS ((char *));
627 lookup_signed_typename PARAMS ((char *));
630 check_stub_type PARAMS ((struct type *));
633 check_stub_method PARAMS ((struct type *, int, int));
636 lookup_primitive_typename PARAMS ((char *));
639 gdb_mangle_name PARAMS ((struct type *, int, int));
642 builtin_type PARAMS ((char **));
645 lookup_typename PARAMS ((char *, struct block *, int));
648 lookup_template_type PARAMS ((char *, struct type *, struct block *));
651 lookup_fundamental_type PARAMS ((struct objfile *, int));
654 fill_in_vptr_fieldno PARAMS ((struct type *));
657 extern void recursive_dump_type PARAMS ((struct type *, int));
663 print_scalar_formatted PARAMS ((char *, struct type *, int, int, FILE *));
666 extern void maintenance_print_type PARAMS ((char *, int));
669 #endif /* GDBTYPES_H */