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