Add initial type alignment support
[external/binutils.git] / gdb / gdbtypes.h
1
2 /* Internal type definitions for GDB.
3
4    Copyright (C) 1992-2018 Free Software Foundation, Inc.
5
6    Contributed by Cygnus Support, using pieces from other GDB modules.
7
8    This file is part of GDB.
9
10    This program is free software; you can redistribute it and/or modify
11    it under the terms of the GNU General Public License as published by
12    the Free Software Foundation; either version 3 of the License, or
13    (at your option) any later version.
14
15    This program is distributed in the hope that it will be useful,
16    but WITHOUT ANY WARRANTY; without even the implied warranty of
17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18    GNU General Public License for more details.
19
20    You should have received a copy of the GNU General Public License
21    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
22
23 #if !defined (GDBTYPES_H)
24 #define GDBTYPES_H 1
25
26 /* * \page gdbtypes GDB Types
27
28    GDB represents all the different kinds of types in programming
29    languages using a common representation defined in gdbtypes.h.
30
31    The main data structure is main_type; it consists of a code (such
32    as #TYPE_CODE_ENUM for enumeration types), a number of
33    generally-useful fields such as the printable name, and finally a
34    field main_type::type_specific that is a union of info specific to
35    particular languages or other special cases (such as calling
36    convention).
37
38    The available type codes are defined in enum #type_code.  The enum
39    includes codes both for types that are common across a variety
40    of languages, and for types that are language-specific.
41
42    Most accesses to type fields go through macros such as
43    #TYPE_CODE(thistype) and #TYPE_FN_FIELD_CONST(thisfn, n).  These are
44    written such that they can be used as both rvalues and lvalues.
45  */
46
47 #include "hashtab.h"
48 #include "common/offset-type.h"
49 #include "common/enum-flags.h"
50 #include "common/underlying.h"
51 #include "common/print-utils.h"
52
53 /* Forward declarations for prototypes.  */
54 struct field;
55 struct block;
56 struct value_print_options;
57 struct language_defn;
58
59 /* These declarations are DWARF-specific as some of the gdbtypes.h data types
60    are already DWARF-specific.  */
61
62 /* * Offset relative to the start of its containing CU (compilation
63    unit).  */
64 DEFINE_OFFSET_TYPE (cu_offset, unsigned int);
65
66 /* * Offset relative to the start of its .debug_info or .debug_types
67    section.  */
68 DEFINE_OFFSET_TYPE (sect_offset, uint64_t);
69
70 static inline char *
71 sect_offset_str (sect_offset offset)
72 {
73   return hex_string (to_underlying (offset));
74 }
75
76 /* Some macros for char-based bitfields.  */
77
78 #define B_SET(a,x)      ((a)[(x)>>3] |= (1 << ((x)&7)))
79 #define B_CLR(a,x)      ((a)[(x)>>3] &= ~(1 << ((x)&7)))
80 #define B_TST(a,x)      ((a)[(x)>>3] & (1 << ((x)&7)))
81 #define B_TYPE          unsigned char
82 #define B_BYTES(x)      ( 1 + ((x)>>3) )
83 #define B_CLRALL(a,x)   memset ((a), 0, B_BYTES(x))
84
85 /* * Different kinds of data types are distinguished by the `code'
86    field.  */
87
88 enum type_code
89   {
90     TYPE_CODE_BITSTRING = -1,   /**< Deprecated  */
91     TYPE_CODE_UNDEF = 0,        /**< Not used; catches errors */
92     TYPE_CODE_PTR,              /**< Pointer type */
93
94     /* * Array type with lower & upper bounds.
95
96        Regardless of the language, GDB represents multidimensional
97        array types the way C does: as arrays of arrays.  So an
98        instance of a GDB array type T can always be seen as a series
99        of instances of TYPE_TARGET_TYPE (T) laid out sequentially in
100        memory.
101
102        Row-major languages like C lay out multi-dimensional arrays so
103        that incrementing the rightmost index in a subscripting
104        expression results in the smallest change in the address of the
105        element referred to.  Column-major languages like Fortran lay
106        them out so that incrementing the leftmost index results in the
107        smallest change.
108
109        This means that, in column-major languages, working our way
110        from type to target type corresponds to working through indices
111        from right to left, not left to right.  */
112     TYPE_CODE_ARRAY,
113
114     TYPE_CODE_STRUCT,           /**< C struct or Pascal record */
115     TYPE_CODE_UNION,            /**< C union or Pascal variant part */
116     TYPE_CODE_ENUM,             /**< Enumeration type */
117     TYPE_CODE_FLAGS,            /**< Bit flags type */
118     TYPE_CODE_FUNC,             /**< Function type */
119     TYPE_CODE_INT,              /**< Integer type */
120
121     /* * Floating type.  This is *NOT* a complex type.  Beware, there
122        are parts of GDB which bogusly assume that TYPE_CODE_FLT can
123        mean complex.  */
124     TYPE_CODE_FLT,
125
126     /* * Void type.  The length field specifies the length (probably
127        always one) which is used in pointer arithmetic involving
128        pointers to this type, but actually dereferencing such a
129        pointer is invalid; a void type has no length and no actual
130        representation in memory or registers.  A pointer to a void
131        type is a generic pointer.  */
132     TYPE_CODE_VOID,
133
134     TYPE_CODE_SET,              /**< Pascal sets */
135     TYPE_CODE_RANGE,            /**< Range (integers within spec'd bounds).  */
136
137     /* * A string type which is like an array of character but prints
138        differently.  It does not contain a length field as Pascal
139        strings (for many Pascals, anyway) do; if we want to deal with
140        such strings, we should use a new type code.  */
141     TYPE_CODE_STRING,
142
143     /* * Unknown type.  The length field is valid if we were able to
144        deduce that much about the type, or 0 if we don't even know
145        that.  */
146     TYPE_CODE_ERROR,
147
148     /* C++ */
149     TYPE_CODE_METHOD,           /**< Method type */
150
151     /* * Pointer-to-member-function type.  This describes how to access a
152        particular member function of a class (possibly a virtual
153        member function).  The representation may vary between different
154        C++ ABIs.  */
155     TYPE_CODE_METHODPTR,
156
157     /* * Pointer-to-member type.  This is the offset within a class to
158        some particular data member.  The only currently supported
159        representation uses an unbiased offset, with -1 representing
160        NULL; this is used by the Itanium C++ ABI (used by GCC on all
161        platforms).  */
162     TYPE_CODE_MEMBERPTR,
163
164     TYPE_CODE_REF,              /**< C++ Reference types */
165
166     TYPE_CODE_RVALUE_REF,       /**< C++ rvalue reference types */
167
168     TYPE_CODE_CHAR,             /**< *real* character type */
169
170     /* * Boolean type.  0 is false, 1 is true, and other values are
171        non-boolean (e.g. FORTRAN "logical" used as unsigned int).  */
172     TYPE_CODE_BOOL,
173
174     /* Fortran */
175     TYPE_CODE_COMPLEX,          /**< Complex float */
176
177     TYPE_CODE_TYPEDEF,
178
179     TYPE_CODE_NAMESPACE,        /**< C++ namespace.  */
180
181     TYPE_CODE_DECFLOAT,         /**< Decimal floating point.  */
182
183     TYPE_CODE_MODULE,           /**< Fortran module.  */
184
185     /* * Internal function type.  */
186     TYPE_CODE_INTERNAL_FUNCTION,
187
188     /* * Methods implemented in extension languages.  */
189     TYPE_CODE_XMETHOD
190   };
191
192 /* * Some bits for the type's instance_flags word.  See the macros
193    below for documentation on each bit.  */
194
195 enum type_instance_flag_value
196 {
197   TYPE_INSTANCE_FLAG_CONST = (1 << 0),
198   TYPE_INSTANCE_FLAG_VOLATILE = (1 << 1),
199   TYPE_INSTANCE_FLAG_CODE_SPACE = (1 << 2),
200   TYPE_INSTANCE_FLAG_DATA_SPACE = (1 << 3),
201   TYPE_INSTANCE_FLAG_ADDRESS_CLASS_1 = (1 << 4),
202   TYPE_INSTANCE_FLAG_ADDRESS_CLASS_2 = (1 << 5),
203   TYPE_INSTANCE_FLAG_NOTTEXT = (1 << 6),
204   TYPE_INSTANCE_FLAG_RESTRICT = (1 << 7),
205   TYPE_INSTANCE_FLAG_ATOMIC = (1 << 8)
206 };
207
208 DEF_ENUM_FLAGS_TYPE (enum type_instance_flag_value, type_instance_flags);
209
210 /* * Unsigned integer type.  If this is not set for a TYPE_CODE_INT,
211    the type is signed (unless TYPE_NOSIGN (below) is set).  */
212
213 #define TYPE_UNSIGNED(t)        (TYPE_MAIN_TYPE (t)->flag_unsigned)
214
215 /* * No sign for this type.  In C++, "char", "signed char", and
216    "unsigned char" are distinct types; so we need an extra flag to
217    indicate the absence of a sign!  */
218
219 #define TYPE_NOSIGN(t)          (TYPE_MAIN_TYPE (t)->flag_nosign)
220
221 /* * This appears in a type's flags word if it is a stub type (e.g.,
222    if someone referenced a type that wasn't defined in a source file
223    via (struct sir_not_appearing_in_this_film *)).  */
224
225 #define TYPE_STUB(t)            (TYPE_MAIN_TYPE (t)->flag_stub)
226
227 /* * The target type of this type is a stub type, and this type needs
228    to be updated if it gets un-stubbed in check_typedef.  Used for
229    arrays and ranges, in which TYPE_LENGTH of the array/range gets set
230    based on the TYPE_LENGTH of the target type.  Also, set for
231    TYPE_CODE_TYPEDEF.  */
232
233 #define TYPE_TARGET_STUB(t)     (TYPE_MAIN_TYPE (t)->flag_target_stub)
234
235 /* * This is a function type which appears to have a prototype.  We
236    need this for function calls in order to tell us if it's necessary
237    to coerce the args, or to just do the standard conversions.  This
238    is used with a short field.  */
239
240 #define TYPE_PROTOTYPED(t)      (TYPE_MAIN_TYPE (t)->flag_prototyped)
241
242 /* * This flag is used to indicate that processing for this type
243    is incomplete.
244
245    (Mostly intended for HP platforms, where class methods, for
246    instance, can be encountered before their classes in the debug
247    info; the incomplete type has to be marked so that the class and
248    the method can be assigned correct types.)  */
249
250 #define TYPE_INCOMPLETE(t)      (TYPE_MAIN_TYPE (t)->flag_incomplete)
251
252 /* * FIXME drow/2002-06-03:  Only used for methods, but applies as well
253    to functions.  */
254
255 #define TYPE_VARARGS(t)         (TYPE_MAIN_TYPE (t)->flag_varargs)
256
257 /* * Identify a vector type.  Gcc is handling this by adding an extra
258    attribute to the array type.  We slurp that in as a new flag of a
259    type.  This is used only in dwarf2read.c.  */
260 #define TYPE_VECTOR(t)          (TYPE_MAIN_TYPE (t)->flag_vector)
261
262 /* * The debugging formats (especially STABS) do not contain enough
263    information to represent all Ada types---especially those whose
264    size depends on dynamic quantities.  Therefore, the GNAT Ada
265    compiler includes extra information in the form of additional type
266    definitions connected by naming conventions.  This flag indicates
267    that the type is an ordinary (unencoded) GDB type that has been
268    created from the necessary run-time information, and does not need
269    further interpretation.  Optionally marks ordinary, fixed-size GDB
270    type.  */
271
272 #define TYPE_FIXED_INSTANCE(t) (TYPE_MAIN_TYPE (t)->flag_fixed_instance)
273
274 /* * This debug target supports TYPE_STUB(t).  In the unsupported case
275    we have to rely on NFIELDS to be zero etc., see TYPE_IS_OPAQUE().
276    TYPE_STUB(t) with !TYPE_STUB_SUPPORTED(t) may exist if we only
277    guessed the TYPE_STUB(t) value (see dwarfread.c).  */
278
279 #define TYPE_STUB_SUPPORTED(t)   (TYPE_MAIN_TYPE (t)->flag_stub_supported)
280
281 /* * Not textual.  By default, GDB treats all single byte integers as
282    characters (or elements of strings) unless this flag is set.  */
283
284 #define TYPE_NOTTEXT(t) (TYPE_INSTANCE_FLAGS (t) & TYPE_INSTANCE_FLAG_NOTTEXT)
285
286 /* * Used only for TYPE_CODE_FUNC where it specifies the real function
287    address is returned by this function call.  TYPE_TARGET_TYPE
288    determines the final returned function type to be presented to
289    user.  */
290
291 #define TYPE_GNU_IFUNC(t)       (TYPE_MAIN_TYPE (t)->flag_gnu_ifunc)
292
293 /* * Type owner.  If TYPE_OBJFILE_OWNED is true, the type is owned by
294    the objfile retrieved as TYPE_OBJFILE.  Otherweise, the type is
295    owned by an architecture; TYPE_OBJFILE is NULL in this case.  */
296
297 #define TYPE_OBJFILE_OWNED(t) (TYPE_MAIN_TYPE (t)->flag_objfile_owned)
298 #define TYPE_OWNER(t) TYPE_MAIN_TYPE(t)->owner
299 #define TYPE_OBJFILE(t) (TYPE_OBJFILE_OWNED(t)? TYPE_OWNER(t).objfile : NULL)
300
301 /* * True if this type was declared using the "class" keyword.  This is
302    only valid for C++ structure and enum types.  If false, a structure
303    was declared as a "struct"; if true it was declared "class".  For
304    enum types, this is true when "enum class" or "enum struct" was
305    used to declare the type..  */
306
307 #define TYPE_DECLARED_CLASS(t) (TYPE_MAIN_TYPE (t)->flag_declared_class)
308
309 /* * True if this type is a "flag" enum.  A flag enum is one where all
310    the values are pairwise disjoint when "and"ed together.  This
311    affects how enum values are printed.  */
312
313 #define TYPE_FLAG_ENUM(t) (TYPE_MAIN_TYPE (t)->flag_flag_enum)
314
315 /* * True if this type is a discriminated union type.  Only valid for
316    TYPE_CODE_UNION.  A discriminated union stores a reference to the
317    discriminant field along with the discriminator values in a dynamic
318    property.  */
319
320 #define TYPE_FLAG_DISCRIMINATED_UNION(t) \
321   (TYPE_MAIN_TYPE (t)->flag_discriminated_union)
322
323 /* * Constant type.  If this is set, the corresponding type has a
324    const modifier.  */
325
326 #define TYPE_CONST(t) ((TYPE_INSTANCE_FLAGS (t) & TYPE_INSTANCE_FLAG_CONST) != 0)
327
328 /* * Volatile type.  If this is set, the corresponding type has a
329    volatile modifier.  */
330
331 #define TYPE_VOLATILE(t) \
332   ((TYPE_INSTANCE_FLAGS (t) & TYPE_INSTANCE_FLAG_VOLATILE) != 0)
333
334 /* * Restrict type.  If this is set, the corresponding type has a
335    restrict modifier.  */
336
337 #define TYPE_RESTRICT(t) \
338   ((TYPE_INSTANCE_FLAGS (t) & TYPE_INSTANCE_FLAG_RESTRICT) != 0)
339
340 /* * Atomic type.  If this is set, the corresponding type has an
341    _Atomic modifier.  */
342
343 #define TYPE_ATOMIC(t) \
344   ((TYPE_INSTANCE_FLAGS (t) & TYPE_INSTANCE_FLAG_ATOMIC) != 0)
345
346 /* * True if this type represents either an lvalue or lvalue reference type.  */
347
348 #define TYPE_IS_REFERENCE(t) \
349   (TYPE_CODE (t) == TYPE_CODE_REF || TYPE_CODE (t) == TYPE_CODE_RVALUE_REF)
350
351 /* * Instruction-space delimited type.  This is for Harvard architectures
352    which have separate instruction and data address spaces (and perhaps
353    others).
354
355    GDB usually defines a flat address space that is a superset of the
356    architecture's two (or more) address spaces, but this is an extension
357    of the architecture's model.
358
359    If TYPE_INSTANCE_FLAG_CODE_SPACE is set, an object of the corresponding type
360    resides in instruction memory, even if its address (in the extended
361    flat address space) does not reflect this.
362
363    Similarly, if TYPE_INSTANCE_FLAG_DATA_SPACE is set, then an object of the
364    corresponding type resides in the data memory space, even if
365    this is not indicated by its (flat address space) address.
366
367    If neither flag is set, the default space for functions / methods
368    is instruction space, and for data objects is data memory.  */
369
370 #define TYPE_CODE_SPACE(t) \
371   ((TYPE_INSTANCE_FLAGS (t) & TYPE_INSTANCE_FLAG_CODE_SPACE) != 0)
372
373 #define TYPE_DATA_SPACE(t) \
374   ((TYPE_INSTANCE_FLAGS (t) & TYPE_INSTANCE_FLAG_DATA_SPACE) != 0)
375
376 /* * Address class flags.  Some environments provide for pointers
377    whose size is different from that of a normal pointer or address
378    types where the bits are interpreted differently than normal
379    addresses.  The TYPE_INSTANCE_FLAG_ADDRESS_CLASS_n flags may be used in
380    target specific ways to represent these different types of address
381    classes.  */
382
383 #define TYPE_ADDRESS_CLASS_1(t) (TYPE_INSTANCE_FLAGS(t) \
384                                  & TYPE_INSTANCE_FLAG_ADDRESS_CLASS_1)
385 #define TYPE_ADDRESS_CLASS_2(t) (TYPE_INSTANCE_FLAGS(t) \
386                                  & TYPE_INSTANCE_FLAG_ADDRESS_CLASS_2)
387 #define TYPE_INSTANCE_FLAG_ADDRESS_CLASS_ALL \
388   (TYPE_INSTANCE_FLAG_ADDRESS_CLASS_1 | TYPE_INSTANCE_FLAG_ADDRESS_CLASS_2)
389 #define TYPE_ADDRESS_CLASS_ALL(t) (TYPE_INSTANCE_FLAGS(t) \
390                                    & TYPE_INSTANCE_FLAG_ADDRESS_CLASS_ALL)
391
392 /* * Information needed for a discriminated union.  A discriminated
393    union is handled somewhat differently from an ordinary union.
394
395    One field is designated as the discriminant.  Only one other field
396    is active at a time; which one depends on the value of the
397    discriminant and the data in this structure.
398
399    Additionally, it is possible to have a univariant discriminated
400    union.  In this case, the union has just a single field, which is
401    assumed to be the only active variant -- in this case no
402    discriminant is provided.  */
403
404 struct discriminant_info
405 {
406   /* * The index of the discriminant field.  If -1, then this union
407      must have just a single field.  */
408
409   int discriminant_index;
410
411   /* * The index of the default branch of the union.  If -1, then
412      there is no default branch.  */
413
414   int default_index;
415
416   /* * The discriminant values corresponding to each branch.  This has
417      a number of entries equal to the number of fields in this union.
418      If discriminant_index is not -1, then that entry in this array is
419      not used.  If default_index is not -1, then that entry in this
420      array is not used.  */
421
422   ULONGEST discriminants[1];
423 };
424
425 enum dynamic_prop_kind
426 {
427   PROP_UNDEFINED, /* Not defined.  */
428   PROP_CONST,     /* Constant.  */
429   PROP_ADDR_OFFSET, /* Address offset.  */
430   PROP_LOCEXPR,   /* Location expression.  */
431   PROP_LOCLIST    /* Location list.  */
432 };
433
434 union dynamic_prop_data
435 {
436   /* Storage for constant property.  */
437
438   LONGEST const_val;
439
440   /* Storage for dynamic property.  */
441
442   void *baton;
443 };
444
445 /* * Used to store a dynamic property.  */
446
447 struct dynamic_prop
448 {
449   /* Determine which field of the union dynamic_prop.data is used.  */
450   enum dynamic_prop_kind kind;
451
452   /* Storage for dynamic or static value.  */
453   union dynamic_prop_data data;
454 };
455
456 /* Compare two dynamic_prop objects for equality.  dynamic_prop
457    instances are equal iff they have the same type and storage.  */
458 extern bool operator== (const dynamic_prop &l, const dynamic_prop &r);
459
460 /* Compare two dynamic_prop objects for inequality.  */
461 static inline bool operator!= (const dynamic_prop &l, const dynamic_prop &r)
462 {
463   return !(l == r);
464 }
465
466 /* * Define a type's dynamic property node kind.  */
467 enum dynamic_prop_node_kind
468 {
469   /* A property providing a type's data location.
470      Evaluating this field yields to the location of an object's data.  */
471   DYN_PROP_DATA_LOCATION,
472
473   /* A property representing DW_AT_allocated.  The presence of this attribute
474      indicates that the object of the type can be allocated/deallocated.  */
475   DYN_PROP_ALLOCATED,
476
477   /* A property representing DW_AT_allocated.  The presence of this attribute
478      indicated that the object of the type can be associated.  */
479   DYN_PROP_ASSOCIATED,
480
481   /* A property providing an array's byte stride.  */
482   DYN_PROP_BYTE_STRIDE,
483
484   /* A property holding information about a discriminated union.  */
485   DYN_PROP_DISCRIMINATED,
486 };
487
488 /* * List for dynamic type attributes.  */
489 struct dynamic_prop_list
490 {
491   /* The kind of dynamic prop in this node.  */
492   enum dynamic_prop_node_kind prop_kind;
493
494   /* The dynamic property itself.  */
495   struct dynamic_prop prop;
496
497   /* A pointer to the next dynamic property.  */
498   struct dynamic_prop_list *next;
499 };
500
501 /* * Determine which field of the union main_type.fields[x].loc is
502    used.  */
503
504 enum field_loc_kind
505   {
506     FIELD_LOC_KIND_BITPOS,      /**< bitpos */
507     FIELD_LOC_KIND_ENUMVAL,     /**< enumval */
508     FIELD_LOC_KIND_PHYSADDR,    /**< physaddr */
509     FIELD_LOC_KIND_PHYSNAME,    /**< physname */
510     FIELD_LOC_KIND_DWARF_BLOCK  /**< dwarf_block */
511   };
512
513 /* * A discriminant to determine which field in the
514    main_type.type_specific union is being used, if any.
515
516    For types such as TYPE_CODE_FLT, the use of this
517    discriminant is really redundant, as we know from the type code
518    which field is going to be used.  As such, it would be possible to
519    reduce the size of this enum in order to save a bit or two for
520    other fields of struct main_type.  But, since we still have extra
521    room , and for the sake of clarity and consistency, we treat all fields
522    of the union the same way.  */
523
524 enum type_specific_kind
525 {
526   TYPE_SPECIFIC_NONE,
527   TYPE_SPECIFIC_CPLUS_STUFF,
528   TYPE_SPECIFIC_GNAT_STUFF,
529   TYPE_SPECIFIC_FLOATFORMAT,
530   /* Note: This is used by TYPE_CODE_FUNC and TYPE_CODE_METHOD.  */
531   TYPE_SPECIFIC_FUNC,
532   TYPE_SPECIFIC_SELF_TYPE
533 };
534
535 union type_owner
536 {
537   struct objfile *objfile;
538   struct gdbarch *gdbarch;
539 };
540
541 union field_location
542 {
543   /* * Position of this field, counting in bits from start of
544      containing structure.  For gdbarch_bits_big_endian=1
545      targets, it is the bit offset to the MSB.  For
546      gdbarch_bits_big_endian=0 targets, it is the bit offset to
547      the LSB.  */
548
549   LONGEST bitpos;
550
551   /* * Enum value.  */
552   LONGEST enumval;
553
554   /* * For a static field, if TYPE_FIELD_STATIC_HAS_ADDR then
555      physaddr is the location (in the target) of the static
556      field.  Otherwise, physname is the mangled label of the
557      static field.  */
558
559   CORE_ADDR physaddr;
560   const char *physname;
561
562   /* * The field location can be computed by evaluating the
563      following DWARF block.  Its DATA is allocated on
564      objfile_obstack - no CU load is needed to access it.  */
565
566   struct dwarf2_locexpr_baton *dwarf_block;
567 };
568
569 struct field
570 {
571   union field_location loc;
572
573   /* * For a function or member type, this is 1 if the argument is
574      marked artificial.  Artificial arguments should not be shown
575      to the user.  For TYPE_CODE_RANGE it is set if the specific
576      bound is not defined.  */
577
578   unsigned int artificial : 1;
579
580   /* * Discriminant for union field_location.  */
581
582   ENUM_BITFIELD(field_loc_kind) loc_kind : 3;
583
584   /* * Size of this field, in bits, or zero if not packed.
585      If non-zero in an array type, indicates the element size in
586      bits (used only in Ada at the moment).
587      For an unpacked field, the field's type's length
588      says how many bytes the field occupies.  */
589
590   unsigned int bitsize : 28;
591
592   /* * In a struct or union type, type of this field.
593      - In a function or member type, type of this argument.
594      - In an array type, the domain-type of the array.  */
595
596   struct type *type;
597
598   /* * Name of field, value or argument.
599      NULL for range bounds, array domains, and member function
600      arguments.  */
601
602   const char *name;
603 };
604
605 struct range_bounds
606 {
607   /* * Low bound of range.  */
608
609   struct dynamic_prop low;
610
611   /* * High bound of range.  */
612
613   struct dynamic_prop high;
614
615   /* True if HIGH range bound contains the number of elements in the
616      subrange. This affects how the final hight bound is computed.  */
617
618   int flag_upper_bound_is_count : 1;
619
620   /* True if LOW or/and HIGH are resolved into a static bound from
621      a dynamic one.  */
622
623   int flag_bound_evaluated : 1;
624 };
625
626 /* Compare two range_bounds objects for equality.  Simply does
627    memberwise comparison.  */
628 extern bool operator== (const range_bounds &l, const range_bounds &r);
629
630 /* Compare two range_bounds objects for inequality.  */
631 static inline bool operator!= (const range_bounds &l, const range_bounds &r)
632 {
633   return !(l == r);
634 }
635
636 union type_specific
637 {
638   /* * CPLUS_STUFF is for TYPE_CODE_STRUCT.  It is initialized to
639      point to cplus_struct_default, a default static instance of a
640      struct cplus_struct_type.  */
641
642   struct cplus_struct_type *cplus_stuff;
643
644   /* * GNAT_STUFF is for types for which the GNAT Ada compiler
645      provides additional information.  */
646
647   struct gnat_aux_type *gnat_stuff;
648
649   /* * FLOATFORMAT is for TYPE_CODE_FLT.  It is a pointer to a
650      floatformat object that describes the floating-point value
651      that resides within the type.  */
652
653   const struct floatformat *floatformat;
654
655   /* * For TYPE_CODE_FUNC and TYPE_CODE_METHOD types.  */
656
657   struct func_type *func_stuff;
658
659   /* * For types that are pointer to member types (TYPE_CODE_METHODPTR,
660      TYPE_CODE_MEMBERPTR), SELF_TYPE is the type that this pointer
661      is a member of.  */
662
663   struct type *self_type;
664 };
665
666 /* * Main structure representing a type in GDB.
667
668    This structure is space-critical.  Its layout has been tweaked to
669    reduce the space used.  */
670
671 struct main_type
672 {
673   /* * Code for kind of type.  */
674
675   ENUM_BITFIELD(type_code) code : 8;
676
677   /* * Flags about this type.  These fields appear at this location
678      because they packs nicely here.  See the TYPE_* macros for
679      documentation about these fields.  */
680
681   unsigned int flag_unsigned : 1;
682   unsigned int flag_nosign : 1;
683   unsigned int flag_stub : 1;
684   unsigned int flag_target_stub : 1;
685   unsigned int flag_static : 1;
686   unsigned int flag_prototyped : 1;
687   unsigned int flag_incomplete : 1;
688   unsigned int flag_varargs : 1;
689   unsigned int flag_vector : 1;
690   unsigned int flag_stub_supported : 1;
691   unsigned int flag_gnu_ifunc : 1;
692   unsigned int flag_fixed_instance : 1;
693   unsigned int flag_objfile_owned : 1;
694
695   /* * True if this type was declared with "class" rather than
696      "struct".  */
697
698   unsigned int flag_declared_class : 1;
699
700   /* * True if this is an enum type with disjoint values.  This
701      affects how the enum is printed.  */
702
703   unsigned int flag_flag_enum : 1;
704
705   /* * True if this type is a discriminated union type.  Only valid
706      for TYPE_CODE_UNION.  A discriminated union stores a reference to
707      the discriminant field along with the discriminator values in a
708      dynamic property.  */
709
710   unsigned int flag_discriminated_union : 1;
711
712   /* * A discriminant telling us which field of the type_specific
713      union is being used for this type, if any.  */
714
715   ENUM_BITFIELD(type_specific_kind) type_specific_field : 3;
716
717   /* * Number of fields described for this type.  This field appears
718      at this location because it packs nicely here.  */
719
720   short nfields;
721
722   /* * Name of this type, or NULL if none.
723
724      This is used for printing only, except by poorly designed C++
725      code.  For looking up a name, look for a symbol in the
726      VAR_DOMAIN.  This is generally allocated in the objfile's
727      obstack.  However coffread.c uses malloc.  */
728
729   const char *name;
730
731   /* * Tag name for this type, or NULL if none.  This means that the
732      name of the type consists of a keyword followed by the tag name.
733      Which keyword is determined by the type code ("struct" for
734      TYPE_CODE_STRUCT, etc.).  As far as I know C/C++ are the only
735      languages with this feature.
736
737      This is used for printing only, except by poorly designed C++ code.
738      For looking up a name, look for a symbol in the STRUCT_DOMAIN.
739      One more legitimate use is that if TYPE_STUB is set, this is
740      the name to use to look for definitions in other files.  */
741
742   const char *tag_name;
743
744   /* * Every type is now associated with a particular objfile, and the
745      type is allocated on the objfile_obstack for that objfile.  One
746      problem however, is that there are times when gdb allocates new
747      types while it is not in the process of reading symbols from a
748      particular objfile.  Fortunately, these happen when the type
749      being created is a derived type of an existing type, such as in
750      lookup_pointer_type().  So we can just allocate the new type
751      using the same objfile as the existing type, but to do this we
752      need a backpointer to the objfile from the existing type.  Yes
753      this is somewhat ugly, but without major overhaul of the internal
754      type system, it can't be avoided for now.  */
755
756   union type_owner owner;
757
758   /* * For a pointer type, describes the type of object pointed to.
759      - For an array type, describes the type of the elements.
760      - For a function or method type, describes the type of the return value.
761      - For a range type, describes the type of the full range.
762      - For a complex type, describes the type of each coordinate.
763      - For a special record or union type encoding a dynamic-sized type
764      in GNAT, a memoized pointer to a corresponding static version of
765      the type.
766      - Unused otherwise.  */
767
768   struct type *target_type;
769
770   /* * For structure and union types, a description of each field.
771      For set and pascal array types, there is one "field",
772      whose type is the domain type of the set or array.
773      For range types, there are two "fields",
774      the minimum and maximum values (both inclusive).
775      For enum types, each possible value is described by one "field".
776      For a function or method type, a "field" for each parameter.
777      For C++ classes, there is one field for each base class (if it is
778      a derived class) plus one field for each class data member.  Member
779      functions are recorded elsewhere.
780
781      Using a pointer to a separate array of fields
782      allows all types to have the same size, which is useful
783      because we can allocate the space for a type before
784      we know what to put in it.  */
785
786   union 
787   {
788     struct field *fields;
789
790     /* * Union member used for range types.  */
791
792     struct range_bounds *bounds;
793
794   } flds_bnds;
795
796   /* * Slot to point to additional language-specific fields of this
797      type.  */
798
799   union type_specific type_specific;
800
801   /* * Contains all dynamic type properties.  */
802   struct dynamic_prop_list *dyn_prop_list;
803 };
804
805 /* * Number of bits allocated for alignment.  */
806
807 #define TYPE_ALIGN_BITS 8
808
809 /* * A ``struct type'' describes a particular instance of a type, with
810    some particular qualification.  */
811
812 struct type
813 {
814   /* * Type that is a pointer to this type.
815      NULL if no such pointer-to type is known yet.
816      The debugger may add the address of such a type
817      if it has to construct one later.  */
818
819   struct type *pointer_type;
820
821   /* * C++: also need a reference type.  */
822
823   struct type *reference_type;
824
825   /* * A C++ rvalue reference type added in C++11. */
826
827   struct type *rvalue_reference_type;
828
829   /* * Variant chain.  This points to a type that differs from this
830      one only in qualifiers and length.  Currently, the possible
831      qualifiers are const, volatile, code-space, data-space, and
832      address class.  The length may differ only when one of the
833      address class flags are set.  The variants are linked in a
834      circular ring and share MAIN_TYPE.  */
835
836   struct type *chain;
837
838   /* * The alignment for this type.  Zero means that the alignment was
839      not specified in the debug info.  Note that this is stored in a
840      funny way: as the log base 2 (plus 1) of the alignment; so a
841      value of 1 means the alignment is 1, and a value of 9 means the
842      alignment is 256.  */
843
844   unsigned align_log2 : TYPE_ALIGN_BITS;
845
846   /* * Flags specific to this instance of the type, indicating where
847      on the ring we are.
848
849      For TYPE_CODE_TYPEDEF the flags of the typedef type should be
850      binary or-ed with the target type, with a special case for
851      address class and space class.  For example if this typedef does
852      not specify any new qualifiers, TYPE_INSTANCE_FLAGS is 0 and the
853      instance flags are completely inherited from the target type.  No
854      qualifiers can be cleared by the typedef.  See also
855      check_typedef.  */
856   unsigned instance_flags : 9;
857
858   /* * Length of storage for a value of this type.  The value is the
859      expression in host bytes of what sizeof(type) would return.  This
860      size includes padding.  For example, an i386 extended-precision
861      floating point value really only occupies ten bytes, but most
862      ABI's declare its size to be 12 bytes, to preserve alignment.
863      A `struct type' representing such a floating-point type would
864      have a `length' value of 12, even though the last two bytes are
865      unused.
866
867      Since this field is expressed in host bytes, its value is appropriate
868      to pass to memcpy and such (it is assumed that GDB itself always runs
869      on an 8-bits addressable architecture).  However, when using it for
870      target address arithmetic (e.g. adding it to a target address), the
871      type_length_units function should be used in order to get the length
872      expressed in target addressable memory units.  */
873
874   unsigned int length;
875
876   /* * Core type, shared by a group of qualified types.  */
877
878   struct main_type *main_type;
879 };
880
881 #define NULL_TYPE ((struct type *) 0)
882
883 struct fn_fieldlist
884 {
885
886   /* * The overloaded name.
887      This is generally allocated in the objfile's obstack.
888      However stabsread.c sometimes uses malloc.  */
889
890   const char *name;
891
892   /* * The number of methods with this name.  */
893
894   int length;
895
896   /* * The list of methods.  */
897
898   struct fn_field *fn_fields;
899 };
900
901
902
903 struct fn_field
904 {
905   /* * If is_stub is clear, this is the mangled name which we can look
906      up to find the address of the method (FIXME: it would be cleaner
907      to have a pointer to the struct symbol here instead).
908
909      If is_stub is set, this is the portion of the mangled name which
910      specifies the arguments.  For example, "ii", if there are two int
911      arguments, or "" if there are no arguments.  See gdb_mangle_name
912      for the conversion from this format to the one used if is_stub is
913      clear.  */
914
915   const char *physname;
916
917   /* * The function type for the method.
918                
919      (This comment used to say "The return value of the method", but
920      that's wrong.  The function type is expected here, i.e. something
921      with TYPE_CODE_METHOD, and *not* the return-value type).  */
922
923   struct type *type;
924
925   /* * For virtual functions.  First baseclass that defines this
926      virtual function.  */
927
928   struct type *fcontext;
929
930   /* Attributes.  */
931
932   unsigned int is_const:1;
933   unsigned int is_volatile:1;
934   unsigned int is_private:1;
935   unsigned int is_protected:1;
936   unsigned int is_artificial:1;
937
938   /* * A stub method only has some fields valid (but they are enough
939      to reconstruct the rest of the fields).  */
940
941   unsigned int is_stub:1;
942
943   /* * True if this function is a constructor, false otherwise.  */
944
945   unsigned int is_constructor : 1;
946
947   /* * Unused.  */
948
949   unsigned int dummy:9;
950
951   /* * Index into that baseclass's virtual function table, minus 2;
952      else if static: VOFFSET_STATIC; else: 0.  */
953
954   unsigned int voffset:16;
955
956 #define VOFFSET_STATIC 1
957
958 };
959
960 struct decl_field
961 {
962   /* * Unqualified name to be prefixed by owning class qualified
963      name.  */
964
965   const char *name;
966
967   /* * Type this typedef named NAME represents.  */
968
969   struct type *type;
970
971   /* * True if this field was declared protected, false otherwise.  */
972   unsigned int is_protected : 1;
973
974   /* * True if this field was declared private, false otherwise.  */
975   unsigned int is_private : 1;
976 };
977
978 /* * C++ language-specific information for TYPE_CODE_STRUCT and
979    TYPE_CODE_UNION nodes.  */
980
981 struct cplus_struct_type
982   {
983     /* * Number of base classes this type derives from.  The
984        baseclasses are stored in the first N_BASECLASSES fields
985        (i.e. the `fields' field of the struct type).  The only fields
986        of struct field that are used are: type, name, loc.bitpos.  */
987
988     short n_baseclasses;
989
990     /* * Field number of the virtual function table pointer in VPTR_BASETYPE.
991        All access to this field must be through TYPE_VPTR_FIELDNO as one
992        thing it does is check whether the field has been initialized.
993        Initially TYPE_RAW_CPLUS_SPECIFIC has the value of cplus_struct_default,
994        which for portability reasons doesn't initialize this field.
995        TYPE_VPTR_FIELDNO returns -1 for this case.
996
997        If -1, we were unable to find the virtual function table pointer in
998        initial symbol reading, and get_vptr_fieldno should be called to find
999        it if possible.  get_vptr_fieldno will update this field if possible.
1000        Otherwise the value is left at -1.
1001
1002        Unused if this type does not have virtual functions.  */
1003
1004     short vptr_fieldno;
1005
1006     /* * Number of methods with unique names.  All overloaded methods
1007        with the same name count only once.  */
1008
1009     short nfn_fields;
1010
1011     /* * Number of template arguments.  */
1012
1013     unsigned short n_template_arguments;
1014
1015     /* * One if this struct is a dynamic class, as defined by the
1016        Itanium C++ ABI: if it requires a virtual table pointer,
1017        because it or any of its base classes have one or more virtual
1018        member functions or virtual base classes.  Minus one if not
1019        dynamic.  Zero if not yet computed.  */
1020
1021     int is_dynamic : 2;
1022
1023     /* * The base class which defined the virtual function table pointer.  */
1024
1025     struct type *vptr_basetype;
1026
1027     /* * For derived classes, the number of base classes is given by
1028        n_baseclasses and virtual_field_bits is a bit vector containing
1029        one bit per base class.  If the base class is virtual, the
1030        corresponding bit will be set.
1031        I.E, given:
1032
1033        class A{};
1034        class B{};
1035        class C : public B, public virtual A {};
1036
1037        B is a baseclass of C; A is a virtual baseclass for C.
1038        This is a C++ 2.0 language feature.  */
1039
1040     B_TYPE *virtual_field_bits;
1041
1042     /* * For classes with private fields, the number of fields is
1043        given by nfields and private_field_bits is a bit vector
1044        containing one bit per field.
1045
1046        If the field is private, the corresponding bit will be set.  */
1047
1048     B_TYPE *private_field_bits;
1049
1050     /* * For classes with protected fields, the number of fields is
1051        given by nfields and protected_field_bits is a bit vector
1052        containing one bit per field.
1053
1054        If the field is private, the corresponding bit will be set.  */
1055
1056     B_TYPE *protected_field_bits;
1057
1058     /* * For classes with fields to be ignored, either this is
1059        optimized out or this field has length 0.  */
1060
1061     B_TYPE *ignore_field_bits;
1062
1063     /* * For classes, structures, and unions, a description of each
1064        field, which consists of an overloaded name, followed by the
1065        types of arguments that the method expects, and then the name
1066        after it has been renamed to make it distinct.
1067
1068        fn_fieldlists points to an array of nfn_fields of these.  */
1069
1070     struct fn_fieldlist *fn_fieldlists;
1071
1072     /* * typedefs defined inside this class.  typedef_field points to
1073        an array of typedef_field_count elements.  */
1074
1075     struct decl_field *typedef_field;
1076
1077     unsigned typedef_field_count;
1078
1079     /* * The nested types defined by this type.  nested_types points to
1080        an array of nested_types_count elements.  */
1081
1082     struct decl_field *nested_types;
1083
1084     unsigned nested_types_count;
1085
1086     /* * The template arguments.  This is an array with
1087        N_TEMPLATE_ARGUMENTS elements.  This is NULL for non-template
1088        classes.  */
1089
1090     struct symbol **template_arguments;
1091   };
1092
1093 /* * Struct used to store conversion rankings.  */
1094
1095 struct rank
1096   {
1097     short rank;
1098
1099     /* * When two conversions are of the same type and therefore have
1100        the same rank, subrank is used to differentiate the two.
1101
1102        Eg: Two derived-class-pointer to base-class-pointer conversions
1103        would both have base pointer conversion rank, but the
1104        conversion with the shorter distance to the ancestor is
1105        preferable.  'subrank' would be used to reflect that.  */
1106
1107     short subrank;
1108   };
1109
1110 /* * Struct used for ranking a function for overload resolution.  */
1111
1112 struct badness_vector
1113   {
1114     int length;
1115     struct rank *rank;
1116   };
1117
1118 /* * GNAT Ada-specific information for various Ada types.  */
1119
1120 struct gnat_aux_type
1121   {
1122     /* * Parallel type used to encode information about dynamic types
1123        used in Ada (such as variant records, variable-size array,
1124        etc).  */
1125     struct type* descriptive_type;
1126   };
1127
1128 /* * For TYPE_CODE_FUNC and TYPE_CODE_METHOD types.  */
1129
1130 struct func_type
1131   {
1132     /* * The calling convention for targets supporting multiple ABIs.
1133        Right now this is only fetched from the Dwarf-2
1134        DW_AT_calling_convention attribute.  The value is one of the
1135        DW_CC enum dwarf_calling_convention constants.  */
1136
1137     unsigned calling_convention : 8;
1138
1139     /* * Whether this function normally returns to its caller.  It is
1140        set from the DW_AT_noreturn attribute if set on the
1141        DW_TAG_subprogram.  */
1142
1143     unsigned int is_noreturn : 1;
1144
1145     /* * Only those DW_TAG_call_site's in this function that have
1146        DW_AT_call_tail_call set are linked in this list.  Function
1147        without its tail call list complete
1148        (DW_AT_call_all_tail_calls or its superset
1149        DW_AT_call_all_calls) has TAIL_CALL_LIST NULL, even if some
1150        DW_TAG_call_site's exist in such function. */
1151
1152     struct call_site *tail_call_list;
1153
1154     /* * For method types (TYPE_CODE_METHOD), the aggregate type that
1155        contains the method.  */
1156
1157     struct type *self_type;
1158   };
1159
1160 /* struct call_site_parameter can be referenced in callees by several ways.  */
1161
1162 enum call_site_parameter_kind
1163 {
1164   /* * Use field call_site_parameter.u.dwarf_reg.  */
1165   CALL_SITE_PARAMETER_DWARF_REG,
1166
1167   /* * Use field call_site_parameter.u.fb_offset.  */
1168   CALL_SITE_PARAMETER_FB_OFFSET,
1169
1170   /* * Use field call_site_parameter.u.param_offset.  */
1171   CALL_SITE_PARAMETER_PARAM_OFFSET
1172 };
1173
1174 struct call_site_target
1175 {
1176   union field_location loc;
1177
1178   /* * Discriminant for union field_location.  */
1179
1180   ENUM_BITFIELD(field_loc_kind) loc_kind : 3;
1181 };
1182
1183 union call_site_parameter_u
1184 {
1185   /* * DW_TAG_formal_parameter's DW_AT_location's DW_OP_regX
1186      as DWARF register number, for register passed
1187      parameters.  */
1188
1189   int dwarf_reg;
1190
1191   /* * Offset from the callee's frame base, for stack passed
1192      parameters.  This equals offset from the caller's stack
1193      pointer.  */
1194
1195   CORE_ADDR fb_offset;
1196
1197   /* * Offset relative to the start of this PER_CU to
1198      DW_TAG_formal_parameter which is referenced by both
1199      caller and the callee.  */
1200
1201   cu_offset param_cu_off;
1202 };
1203
1204 struct call_site_parameter
1205 {
1206   ENUM_BITFIELD (call_site_parameter_kind) kind : 2;
1207
1208   union call_site_parameter_u u;
1209
1210   /* * DW_TAG_formal_parameter's DW_AT_call_value.  It is never NULL.  */
1211
1212   const gdb_byte *value;
1213   size_t value_size;
1214
1215   /* * DW_TAG_formal_parameter's DW_AT_call_data_value.
1216      It may be NULL if not provided by DWARF.  */
1217
1218   const gdb_byte *data_value;
1219   size_t data_value_size;
1220 };
1221
1222 /* * A place where a function gets called from, represented by
1223    DW_TAG_call_site.  It can be looked up from symtab->call_site_htab.  */
1224
1225 struct call_site
1226   {
1227     /* * Address of the first instruction after this call.  It must be
1228        the first field as we overload core_addr_hash and core_addr_eq
1229        for it.  */
1230
1231     CORE_ADDR pc;
1232
1233     /* * List successor with head in FUNC_TYPE.TAIL_CALL_LIST.  */
1234
1235     struct call_site *tail_call_next;
1236
1237     /* * Describe DW_AT_call_target.  Missing attribute uses
1238        FIELD_LOC_KIND_DWARF_BLOCK with FIELD_DWARF_BLOCK == NULL.  */
1239
1240     struct call_site_target target;
1241
1242     /* * Size of the PARAMETER array.  */
1243
1244     unsigned parameter_count;
1245
1246     /* * CU of the function where the call is located.  It gets used
1247        for DWARF blocks execution in the parameter array below.  */
1248
1249     struct dwarf2_per_cu_data *per_cu;
1250
1251     /* * Describe DW_TAG_call_site's DW_TAG_formal_parameter.  */
1252
1253     struct call_site_parameter parameter[1];
1254   };
1255
1256 /* * The default value of TYPE_CPLUS_SPECIFIC(T) points to this shared
1257    static structure.  */
1258
1259 extern const struct cplus_struct_type cplus_struct_default;
1260
1261 extern void allocate_cplus_struct_type (struct type *);
1262
1263 #define INIT_CPLUS_SPECIFIC(type) \
1264   (TYPE_SPECIFIC_FIELD (type) = TYPE_SPECIFIC_CPLUS_STUFF, \
1265    TYPE_RAW_CPLUS_SPECIFIC (type) = (struct cplus_struct_type*) \
1266    &cplus_struct_default)
1267
1268 #define ALLOCATE_CPLUS_STRUCT_TYPE(type) allocate_cplus_struct_type (type)
1269
1270 #define HAVE_CPLUS_STRUCT(type) \
1271   (TYPE_SPECIFIC_FIELD (type) == TYPE_SPECIFIC_CPLUS_STUFF \
1272    && TYPE_RAW_CPLUS_SPECIFIC (type) !=  &cplus_struct_default)
1273
1274 extern const struct gnat_aux_type gnat_aux_default;
1275
1276 extern void allocate_gnat_aux_type (struct type *);
1277
1278 #define INIT_GNAT_SPECIFIC(type) \
1279   (TYPE_SPECIFIC_FIELD (type) = TYPE_SPECIFIC_GNAT_STUFF, \
1280    TYPE_GNAT_SPECIFIC (type) = (struct gnat_aux_type *) &gnat_aux_default)
1281 #define ALLOCATE_GNAT_AUX_TYPE(type) allocate_gnat_aux_type (type)
1282 /* * A macro that returns non-zero if the type-specific data should be
1283    read as "gnat-stuff".  */
1284 #define HAVE_GNAT_AUX_INFO(type) \
1285   (TYPE_SPECIFIC_FIELD (type) == TYPE_SPECIFIC_GNAT_STUFF)
1286
1287 #define INIT_FUNC_SPECIFIC(type)                                               \
1288   (TYPE_SPECIFIC_FIELD (type) = TYPE_SPECIFIC_FUNC,                            \
1289    TYPE_MAIN_TYPE (type)->type_specific.func_stuff = (struct func_type *)      \
1290      TYPE_ZALLOC (type,                                                        \
1291                   sizeof (*TYPE_MAIN_TYPE (type)->type_specific.func_stuff)))
1292
1293 #define TYPE_INSTANCE_FLAGS(thistype) (thistype)->instance_flags
1294 #define TYPE_MAIN_TYPE(thistype) (thistype)->main_type
1295 #define TYPE_NAME(thistype) TYPE_MAIN_TYPE(thistype)->name
1296 #define TYPE_TAG_NAME(type) TYPE_MAIN_TYPE(type)->tag_name
1297 #define TYPE_TARGET_TYPE(thistype) TYPE_MAIN_TYPE(thistype)->target_type
1298 #define TYPE_POINTER_TYPE(thistype) (thistype)->pointer_type
1299 #define TYPE_REFERENCE_TYPE(thistype) (thistype)->reference_type
1300 #define TYPE_RVALUE_REFERENCE_TYPE(thistype) (thistype)->rvalue_reference_type
1301 #define TYPE_CHAIN(thistype) (thistype)->chain
1302 /* * Note that if thistype is a TYPEDEF type, you have to call check_typedef.
1303    But check_typedef does set the TYPE_LENGTH of the TYPEDEF type,
1304    so you only have to call check_typedef once.  Since allocate_value
1305    calls check_typedef, TYPE_LENGTH (VALUE_TYPE (X)) is safe.  */
1306 #define TYPE_LENGTH(thistype) (thistype)->length
1307
1308 /* * Return the alignment of the type in target addressable memory
1309    units, or 0 if no alignment was specified.  */
1310 #define TYPE_RAW_ALIGN(thistype) type_raw_align (thistype)
1311
1312 /* * Return the alignment of the type in target addressable memory
1313    units, or 0 if no alignment was specified.  */
1314 extern unsigned type_raw_align (struct type *);
1315
1316 /* * Return the alignment of the type in target addressable memory
1317    units.  Return 0 if the alignment cannot be determined; but note
1318    that this makes an effort to compute the alignment even it it was
1319    not specified in the debug info.  */
1320 extern unsigned type_align (struct type *);
1321
1322 /* * Set the alignment of the type.  The alignment must be a power of
1323    2.  Returns false if the given value does not fit in the available
1324    space in struct type.  */
1325 extern bool set_type_align (struct type *, ULONGEST);
1326
1327 /* * Note that TYPE_CODE can be TYPE_CODE_TYPEDEF, so if you want the real
1328    type, you need to do TYPE_CODE (check_type (this_type)).  */
1329 #define TYPE_CODE(thistype) TYPE_MAIN_TYPE(thistype)->code
1330 #define TYPE_NFIELDS(thistype) TYPE_MAIN_TYPE(thistype)->nfields
1331 #define TYPE_FIELDS(thistype) TYPE_MAIN_TYPE(thistype)->flds_bnds.fields
1332
1333 #define TYPE_INDEX_TYPE(type) TYPE_FIELD_TYPE (type, 0)
1334 #define TYPE_RANGE_DATA(thistype) TYPE_MAIN_TYPE(thistype)->flds_bnds.bounds
1335 #define TYPE_LOW_BOUND(range_type) \
1336   TYPE_RANGE_DATA(range_type)->low.data.const_val
1337 #define TYPE_HIGH_BOUND(range_type) \
1338   TYPE_RANGE_DATA(range_type)->high.data.const_val
1339 #define TYPE_LOW_BOUND_UNDEFINED(range_type) \
1340   (TYPE_RANGE_DATA(range_type)->low.kind == PROP_UNDEFINED)
1341 #define TYPE_HIGH_BOUND_UNDEFINED(range_type) \
1342   (TYPE_RANGE_DATA(range_type)->high.kind == PROP_UNDEFINED)
1343 #define TYPE_HIGH_BOUND_KIND(range_type) \
1344   TYPE_RANGE_DATA(range_type)->high.kind
1345 #define TYPE_LOW_BOUND_KIND(range_type) \
1346   TYPE_RANGE_DATA(range_type)->low.kind
1347
1348 /* Property accessors for the type data location.  */
1349 #define TYPE_DATA_LOCATION(thistype) \
1350   get_dyn_prop (DYN_PROP_DATA_LOCATION, thistype)
1351 #define TYPE_DATA_LOCATION_BATON(thistype) \
1352   TYPE_DATA_LOCATION (thistype)->data.baton
1353 #define TYPE_DATA_LOCATION_ADDR(thistype) \
1354   TYPE_DATA_LOCATION (thistype)->data.const_val
1355 #define TYPE_DATA_LOCATION_KIND(thistype) \
1356   TYPE_DATA_LOCATION (thistype)->kind
1357
1358 /* Property accessors for the type allocated/associated.  */
1359 #define TYPE_ALLOCATED_PROP(thistype) \
1360   get_dyn_prop (DYN_PROP_ALLOCATED, thistype)
1361 #define TYPE_ASSOCIATED_PROP(thistype) \
1362   get_dyn_prop (DYN_PROP_ASSOCIATED, thistype)
1363
1364 /* Attribute accessors for dynamic properties.  */
1365 #define TYPE_DYN_PROP_LIST(thistype) \
1366   TYPE_MAIN_TYPE(thistype)->dyn_prop_list
1367 #define TYPE_DYN_PROP_BATON(dynprop) \
1368   dynprop->data.baton
1369 #define TYPE_DYN_PROP_ADDR(dynprop) \
1370   dynprop->data.const_val
1371 #define TYPE_DYN_PROP_KIND(dynprop) \
1372   dynprop->kind
1373
1374
1375 /* Moto-specific stuff for FORTRAN arrays.  */
1376
1377 #define TYPE_ARRAY_UPPER_BOUND_IS_UNDEFINED(arraytype) \
1378    TYPE_HIGH_BOUND_UNDEFINED(TYPE_INDEX_TYPE(arraytype))
1379 #define TYPE_ARRAY_LOWER_BOUND_IS_UNDEFINED(arraytype) \
1380    TYPE_LOW_BOUND_UNDEFINED(TYPE_INDEX_TYPE(arraytype))
1381
1382 #define TYPE_ARRAY_UPPER_BOUND_VALUE(arraytype) \
1383    (TYPE_HIGH_BOUND(TYPE_INDEX_TYPE((arraytype))))
1384
1385 #define TYPE_ARRAY_LOWER_BOUND_VALUE(arraytype) \
1386    (TYPE_LOW_BOUND(TYPE_INDEX_TYPE((arraytype))))
1387
1388 /* C++ */
1389
1390 #define TYPE_SELF_TYPE(thistype) internal_type_self_type (thistype)
1391 /* Do not call this, use TYPE_SELF_TYPE.  */
1392 extern struct type *internal_type_self_type (struct type *);
1393 extern void set_type_self_type (struct type *, struct type *);
1394
1395 extern int internal_type_vptr_fieldno (struct type *);
1396 extern void set_type_vptr_fieldno (struct type *, int);
1397 extern struct type *internal_type_vptr_basetype (struct type *);
1398 extern void set_type_vptr_basetype (struct type *, struct type *);
1399 #define TYPE_VPTR_FIELDNO(thistype) internal_type_vptr_fieldno (thistype)
1400 #define TYPE_VPTR_BASETYPE(thistype) internal_type_vptr_basetype (thistype)
1401
1402 #define TYPE_NFN_FIELDS(thistype) TYPE_CPLUS_SPECIFIC(thistype)->nfn_fields
1403 #define TYPE_SPECIFIC_FIELD(thistype) \
1404   TYPE_MAIN_TYPE(thistype)->type_specific_field
1405 /* We need this tap-dance with the TYPE_RAW_SPECIFIC because of the case
1406    where we're trying to print an Ada array using the C language.
1407    In that case, there is no "cplus_stuff", but the C language assumes
1408    that there is.  What we do, in that case, is pretend that there is
1409    an implicit one which is the default cplus stuff.  */
1410 #define TYPE_CPLUS_SPECIFIC(thistype) \
1411    (!HAVE_CPLUS_STRUCT(thistype) \
1412     ? (struct cplus_struct_type*)&cplus_struct_default \
1413     : TYPE_RAW_CPLUS_SPECIFIC(thistype))
1414 #define TYPE_RAW_CPLUS_SPECIFIC(thistype) TYPE_MAIN_TYPE(thistype)->type_specific.cplus_stuff
1415 #define TYPE_FLOATFORMAT(thistype) TYPE_MAIN_TYPE(thistype)->type_specific.floatformat
1416 #define TYPE_GNAT_SPECIFIC(thistype) TYPE_MAIN_TYPE(thistype)->type_specific.gnat_stuff
1417 #define TYPE_DESCRIPTIVE_TYPE(thistype) TYPE_GNAT_SPECIFIC(thistype)->descriptive_type
1418 #define TYPE_CALLING_CONVENTION(thistype) TYPE_MAIN_TYPE(thistype)->type_specific.func_stuff->calling_convention
1419 #define TYPE_NO_RETURN(thistype) TYPE_MAIN_TYPE(thistype)->type_specific.func_stuff->is_noreturn
1420 #define TYPE_TAIL_CALL_LIST(thistype) TYPE_MAIN_TYPE(thistype)->type_specific.func_stuff->tail_call_list
1421 #define TYPE_BASECLASS(thistype,index) TYPE_FIELD_TYPE(thistype, index)
1422 #define TYPE_N_BASECLASSES(thistype) TYPE_CPLUS_SPECIFIC(thistype)->n_baseclasses
1423 #define TYPE_BASECLASS_NAME(thistype,index) TYPE_FIELD_NAME(thistype, index)
1424 #define TYPE_BASECLASS_BITPOS(thistype,index) TYPE_FIELD_BITPOS(thistype,index)
1425 #define BASETYPE_VIA_PUBLIC(thistype, index) \
1426   ((!TYPE_FIELD_PRIVATE(thistype, index)) && (!TYPE_FIELD_PROTECTED(thistype, index)))
1427 #define TYPE_CPLUS_DYNAMIC(thistype) TYPE_CPLUS_SPECIFIC (thistype)->is_dynamic
1428
1429 #define BASETYPE_VIA_VIRTUAL(thistype, index) \
1430   (TYPE_CPLUS_SPECIFIC(thistype)->virtual_field_bits == NULL ? 0 \
1431     : B_TST(TYPE_CPLUS_SPECIFIC(thistype)->virtual_field_bits, (index)))
1432
1433 #define FIELD_TYPE(thisfld) ((thisfld).type)
1434 #define FIELD_NAME(thisfld) ((thisfld).name)
1435 #define FIELD_LOC_KIND(thisfld) ((thisfld).loc_kind)
1436 #define FIELD_BITPOS_LVAL(thisfld) ((thisfld).loc.bitpos)
1437 #define FIELD_BITPOS(thisfld) (FIELD_BITPOS_LVAL (thisfld) + 0)
1438 #define FIELD_ENUMVAL_LVAL(thisfld) ((thisfld).loc.enumval)
1439 #define FIELD_ENUMVAL(thisfld) (FIELD_ENUMVAL_LVAL (thisfld) + 0)
1440 #define FIELD_STATIC_PHYSNAME(thisfld) ((thisfld).loc.physname)
1441 #define FIELD_STATIC_PHYSADDR(thisfld) ((thisfld).loc.physaddr)
1442 #define FIELD_DWARF_BLOCK(thisfld) ((thisfld).loc.dwarf_block)
1443 #define SET_FIELD_BITPOS(thisfld, bitpos)                       \
1444   (FIELD_LOC_KIND (thisfld) = FIELD_LOC_KIND_BITPOS,            \
1445    FIELD_BITPOS_LVAL (thisfld) = (bitpos))
1446 #define SET_FIELD_ENUMVAL(thisfld, enumval)                     \
1447   (FIELD_LOC_KIND (thisfld) = FIELD_LOC_KIND_ENUMVAL,           \
1448    FIELD_ENUMVAL_LVAL (thisfld) = (enumval))
1449 #define SET_FIELD_PHYSNAME(thisfld, name)                       \
1450   (FIELD_LOC_KIND (thisfld) = FIELD_LOC_KIND_PHYSNAME,          \
1451    FIELD_STATIC_PHYSNAME (thisfld) = (name))
1452 #define SET_FIELD_PHYSADDR(thisfld, addr)                       \
1453   (FIELD_LOC_KIND (thisfld) = FIELD_LOC_KIND_PHYSADDR,          \
1454    FIELD_STATIC_PHYSADDR (thisfld) = (addr))
1455 #define SET_FIELD_DWARF_BLOCK(thisfld, addr)                    \
1456   (FIELD_LOC_KIND (thisfld) = FIELD_LOC_KIND_DWARF_BLOCK,       \
1457    FIELD_DWARF_BLOCK (thisfld) = (addr))
1458 #define FIELD_ARTIFICIAL(thisfld) ((thisfld).artificial)
1459 #define FIELD_BITSIZE(thisfld) ((thisfld).bitsize)
1460
1461 #define TYPE_FIELD(thistype, n) TYPE_MAIN_TYPE(thistype)->flds_bnds.fields[n]
1462 #define TYPE_FIELD_TYPE(thistype, n) FIELD_TYPE(TYPE_FIELD(thistype, n))
1463 #define TYPE_FIELD_NAME(thistype, n) FIELD_NAME(TYPE_FIELD(thistype, n))
1464 #define TYPE_FIELD_LOC_KIND(thistype, n) FIELD_LOC_KIND (TYPE_FIELD (thistype, n))
1465 #define TYPE_FIELD_BITPOS(thistype, n) FIELD_BITPOS (TYPE_FIELD (thistype, n))
1466 #define TYPE_FIELD_ENUMVAL(thistype, n) FIELD_ENUMVAL (TYPE_FIELD (thistype, n))
1467 #define TYPE_FIELD_STATIC_PHYSNAME(thistype, n) FIELD_STATIC_PHYSNAME (TYPE_FIELD (thistype, n))
1468 #define TYPE_FIELD_STATIC_PHYSADDR(thistype, n) FIELD_STATIC_PHYSADDR (TYPE_FIELD (thistype, n))
1469 #define TYPE_FIELD_DWARF_BLOCK(thistype, n) FIELD_DWARF_BLOCK (TYPE_FIELD (thistype, n))
1470 #define TYPE_FIELD_ARTIFICIAL(thistype, n) FIELD_ARTIFICIAL(TYPE_FIELD(thistype,n))
1471 #define TYPE_FIELD_BITSIZE(thistype, n) FIELD_BITSIZE(TYPE_FIELD(thistype,n))
1472 #define TYPE_FIELD_PACKED(thistype, n) (FIELD_BITSIZE(TYPE_FIELD(thistype,n))!=0)
1473
1474 #define TYPE_FIELD_PRIVATE_BITS(thistype) \
1475   TYPE_CPLUS_SPECIFIC(thistype)->private_field_bits
1476 #define TYPE_FIELD_PROTECTED_BITS(thistype) \
1477   TYPE_CPLUS_SPECIFIC(thistype)->protected_field_bits
1478 #define TYPE_FIELD_IGNORE_BITS(thistype) \
1479   TYPE_CPLUS_SPECIFIC(thistype)->ignore_field_bits
1480 #define TYPE_FIELD_VIRTUAL_BITS(thistype) \
1481   TYPE_CPLUS_SPECIFIC(thistype)->virtual_field_bits
1482 #define SET_TYPE_FIELD_PRIVATE(thistype, n) \
1483   B_SET (TYPE_CPLUS_SPECIFIC(thistype)->private_field_bits, (n))
1484 #define SET_TYPE_FIELD_PROTECTED(thistype, n) \
1485   B_SET (TYPE_CPLUS_SPECIFIC(thistype)->protected_field_bits, (n))
1486 #define SET_TYPE_FIELD_IGNORE(thistype, n) \
1487   B_SET (TYPE_CPLUS_SPECIFIC(thistype)->ignore_field_bits, (n))
1488 #define SET_TYPE_FIELD_VIRTUAL(thistype, n) \
1489   B_SET (TYPE_CPLUS_SPECIFIC(thistype)->virtual_field_bits, (n))
1490 #define TYPE_FIELD_PRIVATE(thistype, n) \
1491   (TYPE_CPLUS_SPECIFIC(thistype)->private_field_bits == NULL ? 0 \
1492     : B_TST(TYPE_CPLUS_SPECIFIC(thistype)->private_field_bits, (n)))
1493 #define TYPE_FIELD_PROTECTED(thistype, n) \
1494   (TYPE_CPLUS_SPECIFIC(thistype)->protected_field_bits == NULL ? 0 \
1495     : B_TST(TYPE_CPLUS_SPECIFIC(thistype)->protected_field_bits, (n)))
1496 #define TYPE_FIELD_IGNORE(thistype, n) \
1497   (TYPE_CPLUS_SPECIFIC(thistype)->ignore_field_bits == NULL ? 0 \
1498     : B_TST(TYPE_CPLUS_SPECIFIC(thistype)->ignore_field_bits, (n)))
1499 #define TYPE_FIELD_VIRTUAL(thistype, n) \
1500   (TYPE_CPLUS_SPECIFIC(thistype)->virtual_field_bits == NULL ? 0 \
1501     : B_TST(TYPE_CPLUS_SPECIFIC(thistype)->virtual_field_bits, (n)))
1502
1503 #define TYPE_FN_FIELDLISTS(thistype) TYPE_CPLUS_SPECIFIC(thistype)->fn_fieldlists
1504 #define TYPE_FN_FIELDLIST(thistype, n) TYPE_CPLUS_SPECIFIC(thistype)->fn_fieldlists[n]
1505 #define TYPE_FN_FIELDLIST1(thistype, n) TYPE_CPLUS_SPECIFIC(thistype)->fn_fieldlists[n].fn_fields
1506 #define TYPE_FN_FIELDLIST_NAME(thistype, n) TYPE_CPLUS_SPECIFIC(thistype)->fn_fieldlists[n].name
1507 #define TYPE_FN_FIELDLIST_LENGTH(thistype, n) TYPE_CPLUS_SPECIFIC(thistype)->fn_fieldlists[n].length
1508
1509 #define TYPE_N_TEMPLATE_ARGUMENTS(thistype) \
1510   TYPE_CPLUS_SPECIFIC (thistype)->n_template_arguments
1511 #define TYPE_TEMPLATE_ARGUMENTS(thistype) \
1512   TYPE_CPLUS_SPECIFIC (thistype)->template_arguments
1513 #define TYPE_TEMPLATE_ARGUMENT(thistype, n) \
1514   TYPE_CPLUS_SPECIFIC (thistype)->template_arguments[n]
1515
1516 #define TYPE_FN_FIELD(thisfn, n) (thisfn)[n]
1517 #define TYPE_FN_FIELD_PHYSNAME(thisfn, n) (thisfn)[n].physname
1518 #define TYPE_FN_FIELD_TYPE(thisfn, n) (thisfn)[n].type
1519 #define TYPE_FN_FIELD_ARGS(thisfn, n) TYPE_FIELDS ((thisfn)[n].type)
1520 #define TYPE_FN_FIELD_CONST(thisfn, n) ((thisfn)[n].is_const)
1521 #define TYPE_FN_FIELD_VOLATILE(thisfn, n) ((thisfn)[n].is_volatile)
1522 #define TYPE_FN_FIELD_PRIVATE(thisfn, n) ((thisfn)[n].is_private)
1523 #define TYPE_FN_FIELD_PROTECTED(thisfn, n) ((thisfn)[n].is_protected)
1524 #define TYPE_FN_FIELD_ARTIFICIAL(thisfn, n) ((thisfn)[n].is_artificial)
1525 #define TYPE_FN_FIELD_STUB(thisfn, n) ((thisfn)[n].is_stub)
1526 #define TYPE_FN_FIELD_CONSTRUCTOR(thisfn, n) ((thisfn)[n].is_constructor)
1527 #define TYPE_FN_FIELD_FCONTEXT(thisfn, n) ((thisfn)[n].fcontext)
1528 #define TYPE_FN_FIELD_VOFFSET(thisfn, n) ((thisfn)[n].voffset-2)
1529 #define TYPE_FN_FIELD_VIRTUAL_P(thisfn, n) ((thisfn)[n].voffset > 1)
1530 #define TYPE_FN_FIELD_STATIC_P(thisfn, n) ((thisfn)[n].voffset == VOFFSET_STATIC)
1531
1532 /* Accessors for typedefs defined by a class.  */
1533 #define TYPE_TYPEDEF_FIELD_ARRAY(thistype) \
1534   TYPE_CPLUS_SPECIFIC (thistype)->typedef_field
1535 #define TYPE_TYPEDEF_FIELD(thistype, n) \
1536   TYPE_CPLUS_SPECIFIC (thistype)->typedef_field[n]
1537 #define TYPE_TYPEDEF_FIELD_NAME(thistype, n) \
1538   TYPE_TYPEDEF_FIELD (thistype, n).name
1539 #define TYPE_TYPEDEF_FIELD_TYPE(thistype, n) \
1540   TYPE_TYPEDEF_FIELD (thistype, n).type
1541 #define TYPE_TYPEDEF_FIELD_COUNT(thistype) \
1542   TYPE_CPLUS_SPECIFIC (thistype)->typedef_field_count
1543 #define TYPE_TYPEDEF_FIELD_PROTECTED(thistype, n) \
1544   TYPE_TYPEDEF_FIELD (thistype, n).is_protected
1545 #define TYPE_TYPEDEF_FIELD_PRIVATE(thistype, n)        \
1546   TYPE_TYPEDEF_FIELD (thistype, n).is_private
1547
1548 #define TYPE_NESTED_TYPES_ARRAY(thistype)       \
1549   TYPE_CPLUS_SPECIFIC (thistype)->nested_types
1550 #define TYPE_NESTED_TYPES_FIELD(thistype, n) \
1551   TYPE_CPLUS_SPECIFIC (thistype)->nested_types[n]
1552 #define TYPE_NESTED_TYPES_FIELD_NAME(thistype, n) \
1553   TYPE_NESTED_TYPES_FIELD (thistype, n).name
1554 #define TYPE_NESTED_TYPES_FIELD_TYPE(thistype, n) \
1555   TYPE_NESTED_TYPES_FIELD (thistype, n).type
1556 #define TYPE_NESTED_TYPES_COUNT(thistype) \
1557   TYPE_CPLUS_SPECIFIC (thistype)->nested_types_count
1558 #define TYPE_NESTED_TYPES_FIELD_PROTECTED(thistype, n) \
1559   TYPE_NESTED_TYPES_FIELD (thistype, n).is_protected
1560 #define TYPE_NESTED_TYPES_FIELD_PRIVATE(thistype, n)    \
1561   TYPE_NESTED_TYPES_FIELD (thistype, n).is_private
1562
1563 #define TYPE_IS_OPAQUE(thistype) \
1564   (((TYPE_CODE (thistype) == TYPE_CODE_STRUCT) \
1565     || (TYPE_CODE (thistype) == TYPE_CODE_UNION)) \
1566    && (TYPE_NFIELDS (thistype) == 0) \
1567    && (!HAVE_CPLUS_STRUCT (thistype) \
1568        || TYPE_NFN_FIELDS (thistype) == 0) \
1569    && (TYPE_STUB (thistype) || !TYPE_STUB_SUPPORTED (thistype)))
1570
1571 /* * A helper macro that returns the name of a type or "unnamed type"
1572    if the type has no name.  */
1573
1574 #define TYPE_SAFE_NAME(type) \
1575   (TYPE_NAME (type) ? TYPE_NAME (type) : _("<unnamed type>"))
1576
1577 /* * A helper macro that returns the name of an error type.  If the
1578    type has a name, it is used; otherwise, a default is used.  */
1579
1580 #define TYPE_ERROR_NAME(type) \
1581   (TYPE_NAME (type) ? TYPE_NAME (type) : _("<error type>"))
1582
1583 /* Given TYPE, return its floatformat.  */
1584 const struct floatformat *floatformat_from_type (const struct type *type);
1585
1586 struct builtin_type
1587 {
1588   /* Integral types.  */
1589
1590   /* Implicit size/sign (based on the architecture's ABI).  */
1591   struct type *builtin_void;
1592   struct type *builtin_char;
1593   struct type *builtin_short;
1594   struct type *builtin_int;
1595   struct type *builtin_long;
1596   struct type *builtin_signed_char;
1597   struct type *builtin_unsigned_char;
1598   struct type *builtin_unsigned_short;
1599   struct type *builtin_unsigned_int;
1600   struct type *builtin_unsigned_long;
1601   struct type *builtin_float;
1602   struct type *builtin_double;
1603   struct type *builtin_long_double;
1604   struct type *builtin_complex;
1605   struct type *builtin_double_complex;
1606   struct type *builtin_string;
1607   struct type *builtin_bool;
1608   struct type *builtin_long_long;
1609   struct type *builtin_unsigned_long_long;
1610   struct type *builtin_decfloat;
1611   struct type *builtin_decdouble;
1612   struct type *builtin_declong;
1613
1614   /* "True" character types.
1615       We use these for the '/c' print format, because c_char is just a
1616       one-byte integral type, which languages less laid back than C
1617       will print as ... well, a one-byte integral type.  */
1618   struct type *builtin_true_char;
1619   struct type *builtin_true_unsigned_char;
1620
1621   /* Explicit sizes - see C9X <intypes.h> for naming scheme.  The "int0"
1622      is for when an architecture needs to describe a register that has
1623      no size.  */
1624   struct type *builtin_int0;
1625   struct type *builtin_int8;
1626   struct type *builtin_uint8;
1627   struct type *builtin_int16;
1628   struct type *builtin_uint16;
1629   struct type *builtin_int32;
1630   struct type *builtin_uint32;
1631   struct type *builtin_int64;
1632   struct type *builtin_uint64;
1633   struct type *builtin_int128;
1634   struct type *builtin_uint128;
1635
1636   /* Wide character types.  */
1637   struct type *builtin_char16;
1638   struct type *builtin_char32;
1639   struct type *builtin_wchar;
1640
1641   /* Pointer types.  */
1642
1643   /* * `pointer to data' type.  Some target platforms use an implicitly
1644      {sign,zero} -extended 32-bit ABI pointer on a 64-bit ISA.  */
1645   struct type *builtin_data_ptr;
1646
1647   /* * `pointer to function (returning void)' type.  Harvard
1648      architectures mean that ABI function and code pointers are not
1649      interconvertible.  Similarly, since ANSI, C standards have
1650      explicitly said that pointers to functions and pointers to data
1651      are not interconvertible --- that is, you can't cast a function
1652      pointer to void * and back, and expect to get the same value.
1653      However, all function pointer types are interconvertible, so void
1654      (*) () can server as a generic function pointer.  */
1655
1656   struct type *builtin_func_ptr;
1657
1658   /* * `function returning pointer to function (returning void)' type.
1659      The final void return type is not significant for it.  */
1660
1661   struct type *builtin_func_func;
1662
1663   /* Special-purpose types.  */
1664
1665   /* * This type is used to represent a GDB internal function.  */
1666
1667   struct type *internal_fn;
1668
1669   /* * This type is used to represent an xmethod.  */
1670   struct type *xmethod;
1671 };
1672
1673 /* * Return the type table for the specified architecture.  */
1674
1675 extern const struct builtin_type *builtin_type (struct gdbarch *gdbarch);
1676
1677 /* * Per-objfile types used by symbol readers.  */
1678
1679 struct objfile_type
1680 {
1681   /* Basic types based on the objfile architecture.  */
1682   struct type *builtin_void;
1683   struct type *builtin_char;
1684   struct type *builtin_short;
1685   struct type *builtin_int;
1686   struct type *builtin_long;
1687   struct type *builtin_long_long;
1688   struct type *builtin_signed_char;
1689   struct type *builtin_unsigned_char;
1690   struct type *builtin_unsigned_short;
1691   struct type *builtin_unsigned_int;
1692   struct type *builtin_unsigned_long;
1693   struct type *builtin_unsigned_long_long;
1694   struct type *builtin_float;
1695   struct type *builtin_double;
1696   struct type *builtin_long_double;
1697
1698   /* * This type is used to represent symbol addresses.  */
1699   struct type *builtin_core_addr;
1700
1701   /* * This type represents a type that was unrecognized in symbol
1702      read-in.  */
1703   struct type *builtin_error;
1704
1705   /* * Types used for symbols with no debug information.  */
1706   struct type *nodebug_text_symbol;
1707   struct type *nodebug_text_gnu_ifunc_symbol;
1708   struct type *nodebug_got_plt_symbol;
1709   struct type *nodebug_data_symbol;
1710   struct type *nodebug_unknown_symbol;
1711   struct type *nodebug_tls_symbol;
1712 };
1713
1714 /* * Return the type table for the specified objfile.  */
1715
1716 extern const struct objfile_type *objfile_type (struct objfile *objfile);
1717  
1718 /* Explicit floating-point formats.  See "floatformat.h".  */
1719 extern const struct floatformat *floatformats_ieee_half[BFD_ENDIAN_UNKNOWN];
1720 extern const struct floatformat *floatformats_ieee_single[BFD_ENDIAN_UNKNOWN];
1721 extern const struct floatformat *floatformats_ieee_double[BFD_ENDIAN_UNKNOWN];
1722 extern const struct floatformat *floatformats_ieee_double_littlebyte_bigword[BFD_ENDIAN_UNKNOWN];
1723 extern const struct floatformat *floatformats_i387_ext[BFD_ENDIAN_UNKNOWN];
1724 extern const struct floatformat *floatformats_m68881_ext[BFD_ENDIAN_UNKNOWN];
1725 extern const struct floatformat *floatformats_arm_ext[BFD_ENDIAN_UNKNOWN];
1726 extern const struct floatformat *floatformats_ia64_spill[BFD_ENDIAN_UNKNOWN];
1727 extern const struct floatformat *floatformats_ia64_quad[BFD_ENDIAN_UNKNOWN];
1728 extern const struct floatformat *floatformats_vax_f[BFD_ENDIAN_UNKNOWN];
1729 extern const struct floatformat *floatformats_vax_d[BFD_ENDIAN_UNKNOWN];
1730 extern const struct floatformat *floatformats_ibm_long_double[BFD_ENDIAN_UNKNOWN];
1731
1732
1733 /* * Allocate space for storing data associated with a particular
1734    type.  We ensure that the space is allocated using the same
1735    mechanism that was used to allocate the space for the type
1736    structure itself.  I.e.  if the type is on an objfile's
1737    objfile_obstack, then the space for data associated with that type
1738    will also be allocated on the objfile_obstack.  If the type is not
1739    associated with any particular objfile (such as builtin types),
1740    then the data space will be allocated with xmalloc, the same as for
1741    the type structure.  */
1742
1743 #define TYPE_ALLOC(t,size)  \
1744    (TYPE_OBJFILE_OWNED (t) \
1745     ? obstack_alloc (&TYPE_OBJFILE (t) -> objfile_obstack, size) \
1746     : xmalloc (size))
1747
1748 #define TYPE_ZALLOC(t,size)  \
1749    (TYPE_OBJFILE_OWNED (t) \
1750     ? memset (obstack_alloc (&TYPE_OBJFILE (t)->objfile_obstack, size),  \
1751               0, size)  \
1752     : xzalloc (size))
1753
1754 /* Use alloc_type to allocate a type owned by an objfile.  Use
1755    alloc_type_arch to allocate a type owned by an architecture.  Use
1756    alloc_type_copy to allocate a type with the same owner as a
1757    pre-existing template type, no matter whether objfile or
1758    gdbarch.  */
1759 extern struct type *alloc_type (struct objfile *);
1760 extern struct type *alloc_type_arch (struct gdbarch *);
1761 extern struct type *alloc_type_copy (const struct type *);
1762
1763 /* * Return the type's architecture.  For types owned by an
1764    architecture, that architecture is returned.  For types owned by an
1765    objfile, that objfile's architecture is returned.  */
1766
1767 extern struct gdbarch *get_type_arch (const struct type *);
1768
1769 /* * This returns the target type (or NULL) of TYPE, also skipping
1770    past typedefs.  */
1771
1772 extern struct type *get_target_type (struct type *type);
1773
1774 /* Return the equivalent of TYPE_LENGTH, but in number of target
1775    addressable memory units of the associated gdbarch instead of bytes.  */
1776
1777 extern unsigned int type_length_units (struct type *type);
1778
1779 /* * Helper function to construct objfile-owned types.  */
1780
1781 extern struct type *init_type (struct objfile *, enum type_code, int,
1782                                const char *);
1783 extern struct type *init_integer_type (struct objfile *, int, int,
1784                                        const char *);
1785 extern struct type *init_character_type (struct objfile *, int, int,
1786                                          const char *);
1787 extern struct type *init_boolean_type (struct objfile *, int, int,
1788                                        const char *);
1789 extern struct type *init_float_type (struct objfile *, int, const char *,
1790                                      const struct floatformat **);
1791 extern struct type *init_decfloat_type (struct objfile *, int, const char *);
1792 extern struct type *init_complex_type (struct objfile *, const char *,
1793                                        struct type *);
1794 extern struct type *init_pointer_type (struct objfile *, int, const char *,
1795                                        struct type *);
1796
1797 /* Helper functions to construct architecture-owned types.  */
1798 extern struct type *arch_type (struct gdbarch *, enum type_code, int,
1799                                const char *);
1800 extern struct type *arch_integer_type (struct gdbarch *, int, int,
1801                                        const char *);
1802 extern struct type *arch_character_type (struct gdbarch *, int, int,
1803                                          const char *);
1804 extern struct type *arch_boolean_type (struct gdbarch *, int, int,
1805                                        const char *);
1806 extern struct type *arch_float_type (struct gdbarch *, int, const char *,
1807                                      const struct floatformat **);
1808 extern struct type *arch_decfloat_type (struct gdbarch *, int, const char *);
1809 extern struct type *arch_complex_type (struct gdbarch *, const char *,
1810                                        struct type *);
1811 extern struct type *arch_pointer_type (struct gdbarch *, int, const char *,
1812                                        struct type *);
1813
1814 /* Helper functions to construct a struct or record type.  An
1815    initially empty type is created using arch_composite_type().
1816    Fields are then added using append_composite_type_field*().  A union
1817    type has its size set to the largest field.  A struct type has each
1818    field packed against the previous.  */
1819
1820 extern struct type *arch_composite_type (struct gdbarch *gdbarch,
1821                                          const char *name, enum type_code code);
1822 extern void append_composite_type_field (struct type *t, const char *name,
1823                                          struct type *field);
1824 extern void append_composite_type_field_aligned (struct type *t,
1825                                                  const char *name,
1826                                                  struct type *field,
1827                                                  int alignment);
1828 struct field *append_composite_type_field_raw (struct type *t, const char *name,
1829                                                struct type *field);
1830
1831 /* Helper functions to construct a bit flags type.  An initially empty
1832    type is created using arch_flag_type().  Flags are then added using
1833    append_flag_type_field() and append_flag_type_flag().  */
1834 extern struct type *arch_flags_type (struct gdbarch *gdbarch,
1835                                      const char *name, int bit);
1836 extern void append_flags_type_field (struct type *type,
1837                                      int start_bitpos, int nr_bits,
1838                                      struct type *field_type, const char *name);
1839 extern void append_flags_type_flag (struct type *type, int bitpos,
1840                                     const char *name);
1841
1842 extern void make_vector_type (struct type *array_type);
1843 extern struct type *init_vector_type (struct type *elt_type, int n);
1844
1845 extern struct type *lookup_reference_type (struct type *, enum type_code);
1846 extern struct type *lookup_lvalue_reference_type (struct type *);
1847 extern struct type *lookup_rvalue_reference_type (struct type *);
1848
1849
1850 extern struct type *make_reference_type (struct type *, struct type **,
1851                                          enum type_code);
1852
1853 extern struct type *make_cv_type (int, int, struct type *, struct type **);
1854
1855 extern struct type *make_restrict_type (struct type *);
1856
1857 extern struct type *make_unqualified_type (struct type *);
1858
1859 extern struct type *make_atomic_type (struct type *);
1860
1861 extern void replace_type (struct type *, struct type *);
1862
1863 extern int address_space_name_to_int (struct gdbarch *, char *);
1864
1865 extern const char *address_space_int_to_name (struct gdbarch *, int);
1866
1867 extern struct type *make_type_with_address_space (struct type *type, 
1868                                                   int space_identifier);
1869
1870 extern struct type *lookup_memberptr_type (struct type *, struct type *);
1871
1872 extern struct type *lookup_methodptr_type (struct type *);
1873
1874 extern void smash_to_method_type (struct type *type, struct type *self_type,
1875                                   struct type *to_type, struct field *args,
1876                                   int nargs, int varargs);
1877
1878 extern void smash_to_memberptr_type (struct type *, struct type *,
1879                                      struct type *);
1880
1881 extern void smash_to_methodptr_type (struct type *, struct type *);
1882
1883 extern struct type *allocate_stub_method (struct type *);
1884
1885 extern const char *type_name_no_tag (const struct type *);
1886
1887 extern const char *type_name_no_tag_or_error (struct type *type);
1888
1889 extern struct type *lookup_struct_elt_type (struct type *, const char *, int);
1890
1891 extern struct type *make_pointer_type (struct type *, struct type **);
1892
1893 extern struct type *lookup_pointer_type (struct type *);
1894
1895 extern struct type *make_function_type (struct type *, struct type **);
1896
1897 extern struct type *lookup_function_type (struct type *);
1898
1899 extern struct type *lookup_function_type_with_arguments (struct type *,
1900                                                          int,
1901                                                          struct type **);
1902
1903 extern struct type *create_static_range_type (struct type *, struct type *,
1904                                               LONGEST, LONGEST);
1905
1906
1907 extern struct type *create_array_type_with_stride
1908   (struct type *, struct type *, struct type *,
1909    struct dynamic_prop *, unsigned int);
1910
1911 extern struct type *create_range_type (struct type *, struct type *,
1912                                        const struct dynamic_prop *,
1913                                        const struct dynamic_prop *);
1914
1915 extern struct type *create_array_type (struct type *, struct type *,
1916                                        struct type *);
1917
1918 extern struct type *lookup_array_range_type (struct type *, LONGEST, LONGEST);
1919
1920 extern struct type *create_string_type (struct type *, struct type *,
1921                                         struct type *);
1922 extern struct type *lookup_string_range_type (struct type *, LONGEST, LONGEST);
1923
1924 extern struct type *create_set_type (struct type *, struct type *);
1925
1926 extern struct type *lookup_unsigned_typename (const struct language_defn *,
1927                                               struct gdbarch *, const char *);
1928
1929 extern struct type *lookup_signed_typename (const struct language_defn *,
1930                                             struct gdbarch *, const char *);
1931
1932 extern void get_unsigned_type_max (struct type *, ULONGEST *);
1933
1934 extern void get_signed_type_minmax (struct type *, LONGEST *, LONGEST *);
1935
1936 /* * Resolve all dynamic values of a type e.g. array bounds to static values.
1937    ADDR specifies the location of the variable the type is bound to.
1938    If TYPE has no dynamic properties return TYPE; otherwise a new type with
1939    static properties is returned.  */
1940 extern struct type *resolve_dynamic_type (struct type *type,
1941                                           const gdb_byte *valaddr,
1942                                           CORE_ADDR addr);
1943
1944 /* * Predicate if the type has dynamic values, which are not resolved yet.  */
1945 extern int is_dynamic_type (struct type *type);
1946
1947 /* * Return the dynamic property of the requested KIND from TYPE's
1948    list of dynamic properties.  */
1949 extern struct dynamic_prop *get_dyn_prop
1950   (enum dynamic_prop_node_kind kind, const struct type *type);
1951
1952 /* * Given a dynamic property PROP of a given KIND, add this dynamic
1953    property to the given TYPE.
1954
1955    This function assumes that TYPE is objfile-owned.  */
1956 extern void add_dyn_prop
1957   (enum dynamic_prop_node_kind kind, struct dynamic_prop prop,
1958    struct type *type);
1959
1960 extern void remove_dyn_prop (enum dynamic_prop_node_kind prop_kind,
1961                              struct type *type);
1962
1963 extern struct type *check_typedef (struct type *);
1964
1965 extern void check_stub_method_group (struct type *, int);
1966
1967 extern char *gdb_mangle_name (struct type *, int, int);
1968
1969 extern struct type *lookup_typename (const struct language_defn *,
1970                                      struct gdbarch *, const char *,
1971                                      const struct block *, int);
1972
1973 extern struct type *lookup_template_type (char *, struct type *,
1974                                           const struct block *);
1975
1976 extern int get_vptr_fieldno (struct type *, struct type **);
1977
1978 extern int get_discrete_bounds (struct type *, LONGEST *, LONGEST *);
1979
1980 extern int get_array_bounds (struct type *type, LONGEST *low_bound,
1981                              LONGEST *high_bound);
1982
1983 extern int discrete_position (struct type *type, LONGEST val, LONGEST *pos);
1984
1985 extern int class_types_same_p (const struct type *, const struct type *);
1986
1987 extern int is_ancestor (struct type *, struct type *);
1988
1989 extern int is_public_ancestor (struct type *, struct type *);
1990
1991 extern int is_unique_ancestor (struct type *, struct value *);
1992
1993 /* Overload resolution */
1994
1995 #define LENGTH_MATCH(bv) ((bv)->rank[0])
1996
1997 /* * Badness if parameter list length doesn't match arg list length.  */
1998 extern const struct rank LENGTH_MISMATCH_BADNESS;
1999
2000 /* * Dummy badness value for nonexistent parameter positions.  */
2001 extern const struct rank TOO_FEW_PARAMS_BADNESS;
2002 /* * Badness if no conversion among types.  */
2003 extern const struct rank INCOMPATIBLE_TYPE_BADNESS;
2004
2005 /* * Badness of an exact match.  */
2006 extern const struct rank EXACT_MATCH_BADNESS;
2007
2008 /* * Badness of integral promotion.  */
2009 extern const struct rank INTEGER_PROMOTION_BADNESS;
2010 /* * Badness of floating promotion.  */
2011 extern const struct rank FLOAT_PROMOTION_BADNESS;
2012 /* * Badness of converting a derived class pointer
2013    to a base class pointer.  */
2014 extern const struct rank BASE_PTR_CONVERSION_BADNESS;
2015 /* * Badness of integral conversion.  */
2016 extern const struct rank INTEGER_CONVERSION_BADNESS;
2017 /* * Badness of floating conversion.  */
2018 extern const struct rank FLOAT_CONVERSION_BADNESS;
2019 /* * Badness of integer<->floating conversions.  */
2020 extern const struct rank INT_FLOAT_CONVERSION_BADNESS;
2021 /* * Badness of conversion of pointer to void pointer.  */
2022 extern const struct rank VOID_PTR_CONVERSION_BADNESS;
2023 /* * Badness of conversion to boolean.  */
2024 extern const struct rank BOOL_CONVERSION_BADNESS;
2025 /* * Badness of converting derived to base class.  */
2026 extern const struct rank BASE_CONVERSION_BADNESS;
2027 /* * Badness of converting from non-reference to reference.  Subrank
2028    is the type of reference conversion being done.  */
2029 extern const struct rank REFERENCE_CONVERSION_BADNESS;
2030 /* * Conversion to rvalue reference.  */
2031 #define REFERENCE_CONVERSION_RVALUE 1
2032 /* * Conversion to const lvalue reference.  */
2033 #define REFERENCE_CONVERSION_CONST_LVALUE 2
2034
2035 /* * Badness of converting integer 0 to NULL pointer.  */
2036 extern const struct rank NULL_POINTER_CONVERSION;
2037 /* * Badness of cv-conversion.  Subrank is a flag describing the conversions
2038    being done.  */
2039 extern const struct rank CV_CONVERSION_BADNESS;
2040 #define CV_CONVERSION_CONST 1
2041 #define CV_CONVERSION_VOLATILE 2
2042
2043 /* Non-standard conversions allowed by the debugger */
2044
2045 /* * Converting a pointer to an int is usually OK.  */
2046 extern const struct rank NS_POINTER_CONVERSION_BADNESS;
2047
2048 /* * Badness of converting a (non-zero) integer constant
2049    to a pointer.  */
2050 extern const struct rank NS_INTEGER_POINTER_CONVERSION_BADNESS;
2051
2052 extern struct rank sum_ranks (struct rank a, struct rank b);
2053 extern int compare_ranks (struct rank a, struct rank b);
2054
2055 extern int compare_badness (struct badness_vector *, struct badness_vector *);
2056
2057 extern struct badness_vector *rank_function (struct type **, int,
2058                                              struct value **, int);
2059
2060 extern struct rank rank_one_type (struct type *, struct type *,
2061                                   struct value *);
2062
2063 extern void recursive_dump_type (struct type *, int);
2064
2065 extern int field_is_static (struct field *);
2066
2067 /* printcmd.c */
2068
2069 extern void print_scalar_formatted (const gdb_byte *, struct type *,
2070                                     const struct value_print_options *,
2071                                     int, struct ui_file *);
2072
2073 extern int can_dereference (struct type *);
2074
2075 extern int is_integral_type (struct type *);
2076
2077 extern int is_floating_type (struct type *);
2078
2079 extern int is_scalar_type (struct type *type);
2080
2081 extern int is_scalar_type_recursive (struct type *);
2082
2083 extern int class_or_union_p (const struct type *);
2084
2085 extern void maintenance_print_type (const char *, int);
2086
2087 extern htab_t create_copied_types_hash (struct objfile *objfile);
2088
2089 extern struct type *copy_type_recursive (struct objfile *objfile,
2090                                          struct type *type,
2091                                          htab_t copied_types);
2092
2093 extern struct type *copy_type (const struct type *type);
2094
2095 extern int types_equal (struct type *, struct type *);
2096
2097 extern int types_deeply_equal (struct type *, struct type *);
2098
2099 extern int type_not_allocated (const struct type *type);
2100
2101 extern int type_not_associated (const struct type *type);
2102
2103 #endif /* GDBTYPES_H */