Merge branch 'vendor/GDB'
[dragonfly.git] / contrib / gdb-7 / gdb / gdbtypes.h
1 /* Internal type definitions for GDB.
2
3    Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
4    2002, 2003, 2004, 2006, 2007, 2008, 2009, 2010, 2011
5    Free Software Foundation, Inc.
6
7    Contributed by Cygnus Support, using pieces from other GDB modules.
8
9    This file is part of GDB.
10
11    This program is free software; you can redistribute it and/or modify
12    it under the terms of the GNU General Public License as published by
13    the Free Software Foundation; either version 3 of the License, or
14    (at your option) any later version.
15
16    This program is distributed in the hope that it will be useful,
17    but WITHOUT ANY WARRANTY; without even the implied warranty of
18    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19    GNU General Public License for more details.
20
21    You should have received a copy of the GNU General Public License
22    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
23
24 #if !defined (GDBTYPES_H)
25 #define GDBTYPES_H 1
26
27 #include "hashtab.h"
28
29 /* Forward declarations for prototypes.  */
30 struct field;
31 struct block;
32 struct value_print_options;
33 struct language_defn;
34
35 /* Some macros for char-based bitfields.  */
36
37 #define B_SET(a,x)      ((a)[(x)>>3] |= (1 << ((x)&7)))
38 #define B_CLR(a,x)      ((a)[(x)>>3] &= ~(1 << ((x)&7)))
39 #define B_TST(a,x)      ((a)[(x)>>3] & (1 << ((x)&7)))
40 #define B_TYPE          unsigned char
41 #define B_BYTES(x)      ( 1 + ((x)>>3) )
42 #define B_CLRALL(a,x)   memset ((a), 0, B_BYTES(x))
43
44 /* Different kinds of data types are distinguished by the `code' field.  */
45
46 enum type_code
47   {
48     TYPE_CODE_UNDEF,            /* Not used; catches errors */
49     TYPE_CODE_PTR,              /* Pointer type */
50
51     /* Array type with lower & upper bounds.
52
53        Regardless of the language, GDB represents multidimensional
54        array types the way C does: as arrays of arrays.  So an
55        instance of a GDB array type T can always be seen as a series
56        of instances of TYPE_TARGET_TYPE (T) laid out sequentially in
57        memory.
58
59        Row-major languages like C lay out multi-dimensional arrays so
60        that incrementing the rightmost index in a subscripting
61        expression results in the smallest change in the address of the
62        element referred to.  Column-major languages like Fortran lay
63        them out so that incrementing the leftmost index results in the
64        smallest change.
65
66        This means that, in column-major languages, working our way
67        from type to target type corresponds to working through indices
68        from right to left, not left to right.  */
69     TYPE_CODE_ARRAY,
70
71     TYPE_CODE_STRUCT,           /* C struct or Pascal record */
72     TYPE_CODE_UNION,            /* C union or Pascal variant part */
73     TYPE_CODE_ENUM,             /* Enumeration type */
74     TYPE_CODE_FLAGS,            /* Bit flags type */
75     TYPE_CODE_FUNC,             /* Function type */
76     TYPE_CODE_INT,              /* Integer type */
77
78     /* Floating type.  This is *NOT* a complex type.  Beware, there are parts
79        of GDB which bogusly assume that TYPE_CODE_FLT can mean complex.  */
80     TYPE_CODE_FLT,
81
82     /* Void type.  The length field specifies the length (probably always
83        one) which is used in pointer arithmetic involving pointers to
84        this type, but actually dereferencing such a pointer is invalid;
85        a void type has no length and no actual representation in memory
86        or registers.  A pointer to a void type is a generic pointer.  */
87     TYPE_CODE_VOID,
88
89     TYPE_CODE_SET,              /* Pascal sets */
90     TYPE_CODE_RANGE,            /* Range (integers within spec'd bounds).  */
91
92     /* A string type which is like an array of character but prints
93        differently (at least for (the deleted) CHILL).  It does not
94        contain a length field as Pascal strings (for many Pascals,
95        anyway) do; if we want to deal with such strings, we should use
96        a new type code.  */
97     TYPE_CODE_STRING,
98
99     /* String of bits; like TYPE_CODE_SET but prints differently (at
100        least for (the deleted) CHILL).  */
101     TYPE_CODE_BITSTRING,
102
103     /* Unknown type.  The length field is valid if we were able to
104        deduce that much about the type, or 0 if we don't even know that.  */
105     TYPE_CODE_ERROR,
106
107     /* C++ */
108     TYPE_CODE_METHOD,           /* Method type */
109
110     /* Pointer-to-member-function type.  This describes how to access a
111        particular member function of a class (possibly a virtual
112        member function).  The representation may vary between different
113        C++ ABIs.  */
114     TYPE_CODE_METHODPTR,
115
116     /* Pointer-to-member type.  This is the offset within a class to some
117        particular data member.  The only currently supported representation
118        uses an unbiased offset, with -1 representing NULL; this is used
119        by the Itanium C++ ABI (used by GCC on all platforms).  */
120     TYPE_CODE_MEMBERPTR,
121
122     TYPE_CODE_REF,              /* C++ Reference types */
123
124     TYPE_CODE_CHAR,             /* *real* character type */
125
126     /* Boolean type.  0 is false, 1 is true, and other values are non-boolean
127        (e.g. FORTRAN "logical" used as unsigned int).  */
128     TYPE_CODE_BOOL,
129
130     /* Fortran */
131     TYPE_CODE_COMPLEX,          /* Complex float */
132
133     TYPE_CODE_TYPEDEF,
134
135     TYPE_CODE_NAMESPACE,        /* C++ namespace.  */
136
137     TYPE_CODE_DECFLOAT,         /* Decimal floating point.  */
138
139     TYPE_CODE_MODULE,           /* Fortran module.  */
140
141     /* Internal function type.  */
142     TYPE_CODE_INTERNAL_FUNCTION
143   };
144
145 /* For now allow source to use TYPE_CODE_CLASS for C++ classes, as an
146    alias for TYPE_CODE_STRUCT.  This is for DWARF, which has a distinct
147    "class" attribute.  Perhaps we should actually have a separate TYPE_CODE
148    so that we can print "class" or "struct" depending on what the debug
149    info said.  It's not clear we should bother.  */
150
151 #define TYPE_CODE_CLASS TYPE_CODE_STRUCT
152
153 /* Some constants representing each bit field in the main_type.  See
154    the bit-field-specific macros, below, for documentation of each
155    constant in this enum.  These enum values are only used with
156    init_type.  Note that the values are chosen not to conflict with
157    type_instance_flag_value; this lets init_type error-check its
158    input.  */
159
160 enum type_flag_value
161 {
162   TYPE_FLAG_UNSIGNED = (1 << 7),
163   TYPE_FLAG_NOSIGN = (1 << 8),
164   TYPE_FLAG_STUB = (1 << 9),
165   TYPE_FLAG_TARGET_STUB = (1 << 10),
166   TYPE_FLAG_STATIC = (1 << 11),
167   TYPE_FLAG_PROTOTYPED = (1 << 12),
168   TYPE_FLAG_INCOMPLETE = (1 << 13),
169   TYPE_FLAG_VARARGS = (1 << 14),
170   TYPE_FLAG_VECTOR = (1 << 15),
171   TYPE_FLAG_FIXED_INSTANCE = (1 << 16),
172   TYPE_FLAG_STUB_SUPPORTED = (1 << 17),
173   TYPE_FLAG_GNU_IFUNC = (1 << 18),
174
175   /* Used for error-checking.  */
176   TYPE_FLAG_MIN = TYPE_FLAG_UNSIGNED
177 };
178
179 /* Some bits for the type's instance_flags word.  See the macros below
180    for documentation on each bit.  Note that if you add a value here,
181    you must update the enum type_flag_value as well.  */
182 enum type_instance_flag_value
183 {
184   TYPE_INSTANCE_FLAG_CONST = (1 << 0),
185   TYPE_INSTANCE_FLAG_VOLATILE = (1 << 1),
186   TYPE_INSTANCE_FLAG_CODE_SPACE = (1 << 2),
187   TYPE_INSTANCE_FLAG_DATA_SPACE = (1 << 3),
188   TYPE_INSTANCE_FLAG_ADDRESS_CLASS_1 = (1 << 4),
189   TYPE_INSTANCE_FLAG_ADDRESS_CLASS_2 = (1 << 5),
190   TYPE_INSTANCE_FLAG_NOTTEXT = (1 << 6),
191 };
192
193 /* Unsigned integer type.  If this is not set for a TYPE_CODE_INT, the
194    type is signed (unless TYPE_FLAG_NOSIGN (below) is set).  */
195
196 #define TYPE_UNSIGNED(t)        (TYPE_MAIN_TYPE (t)->flag_unsigned)
197
198 /* No sign for this type.  In C++, "char", "signed char", and "unsigned
199    char" are distinct types; so we need an extra flag to indicate the
200    absence of a sign!  */
201
202 #define TYPE_NOSIGN(t)          (TYPE_MAIN_TYPE (t)->flag_nosign)
203
204 /* This appears in a type's flags word if it is a stub type (e.g., if
205    someone referenced a type that wasn't defined in a source file
206    via (struct sir_not_appearing_in_this_film *)).  */
207
208 #define TYPE_STUB(t)            (TYPE_MAIN_TYPE (t)->flag_stub)
209
210 /* The target type of this type is a stub type, and this type needs to
211    be updated if it gets un-stubbed in check_typedef.
212    Used for arrays and ranges, in which TYPE_LENGTH of the array/range
213    gets set based on the TYPE_LENGTH of the target type.
214    Also, set for TYPE_CODE_TYPEDEF.  */
215
216 #define TYPE_TARGET_STUB(t)     (TYPE_MAIN_TYPE (t)->flag_target_stub)
217
218 /* Static type.  If this is set, the corresponding type had 
219    a static modifier.
220    Note: This may be unnecessary, since static data members
221    are indicated by other means (bitpos == -1).  */
222
223 #define TYPE_STATIC(t)          (TYPE_MAIN_TYPE (t)->flag_static)
224
225 /* This is a function type which appears to have a prototype.  We need
226    this for function calls in order to tell us if it's necessary to
227    coerce the args, or to just do the standard conversions.  This is
228    used with a short field.  */
229
230 #define TYPE_PROTOTYPED(t)      (TYPE_MAIN_TYPE (t)->flag_prototyped)
231
232 /* This flag is used to indicate that processing for this type
233    is incomplete.
234
235    (Mostly intended for HP platforms, where class methods, for
236    instance, can be encountered before their classes in the debug
237    info; the incomplete type has to be marked so that the class and
238    the method can be assigned correct types.)  */
239
240 #define TYPE_INCOMPLETE(t)      (TYPE_MAIN_TYPE (t)->flag_incomplete)
241
242 /* FIXME drow/2002-06-03:  Only used for methods, but applies as well
243    to functions.  */
244
245 #define TYPE_VARARGS(t)         (TYPE_MAIN_TYPE (t)->flag_varargs)
246
247 /* Identify a vector type.  Gcc is handling this by adding an extra
248    attribute to the array type.  We slurp that in as a new flag of a
249    type.  This is used only in dwarf2read.c.  */
250 #define TYPE_VECTOR(t)          (TYPE_MAIN_TYPE (t)->flag_vector)
251
252 /* The debugging formats (especially STABS) do not contain enough information
253    to represent all Ada types---especially those whose size depends on
254    dynamic quantities.  Therefore, the GNAT Ada compiler includes
255    extra information in the form of additional type definitions
256    connected by naming conventions.  This flag indicates that the 
257    type is an ordinary (unencoded) GDB type that has been created from 
258    the necessary run-time information, and does not need further 
259    interpretation.  Optionally marks ordinary, fixed-size GDB 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 we have to
264    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 guessed
266    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 determines the
277    final returned function type to be presented to user.  */
278
279 #define TYPE_GNU_IFUNC(t)       (TYPE_MAIN_TYPE (t)->flag_gnu_ifunc)
280
281 /* Type owner.  If TYPE_OBJFILE_OWNED is true, the type is owned by
282    the objfile retrieved as TYPE_OBJFILE.  Otherweise, the type is
283    owned by an architecture; TYPE_OBJFILE is NULL in this case.  */
284
285 #define TYPE_OBJFILE_OWNED(t) (TYPE_MAIN_TYPE (t)->flag_objfile_owned)
286 #define TYPE_OWNER(t) TYPE_MAIN_TYPE(t)->owner
287 #define TYPE_OBJFILE(t) (TYPE_OBJFILE_OWNED(t)? TYPE_OWNER(t).objfile : NULL)
288
289 /* True if this type was declared using the "class" keyword.  This is
290    only valid for C++ structure types, and only used for displaying
291    the type.  If false, the structure was declared as a "struct".  */
292
293 #define TYPE_DECLARED_CLASS(t) (TYPE_MAIN_TYPE (t)->flag_declared_class)
294
295 /* Constant type.  If this is set, the corresponding type has a
296    const modifier.  */
297
298 #define TYPE_CONST(t) (TYPE_INSTANCE_FLAGS (t) & TYPE_INSTANCE_FLAG_CONST)
299
300 /* Volatile type.  If this is set, the corresponding type has a
301    volatile modifier.  */
302
303 #define TYPE_VOLATILE(t) \
304   (TYPE_INSTANCE_FLAGS (t) & TYPE_INSTANCE_FLAG_VOLATILE)
305
306 /* Instruction-space delimited type.  This is for Harvard architectures
307    which have separate instruction and data address spaces (and perhaps
308    others).
309
310    GDB usually defines a flat address space that is a superset of the
311    architecture's two (or more) address spaces, but this is an extension
312    of the architecture's model.
313
314    If TYPE_FLAG_INST is set, an object of the corresponding type
315    resides in instruction memory, even if its address (in the extended
316    flat address space) does not reflect this.
317
318    Similarly, if TYPE_FLAG_DATA is set, then an object of the 
319    corresponding type resides in the data memory space, even if
320    this is not indicated by its (flat address space) address.
321
322    If neither flag is set, the default space for functions / methods
323    is instruction space, and for data objects is data memory.  */
324
325 #define TYPE_CODE_SPACE(t) \
326   (TYPE_INSTANCE_FLAGS (t) & TYPE_INSTANCE_FLAG_CODE_SPACE)
327
328 #define TYPE_DATA_SPACE(t) \
329   (TYPE_INSTANCE_FLAGS (t) & TYPE_INSTANCE_FLAG_DATA_SPACE)
330
331 /* Address class flags.  Some environments provide for pointers whose
332    size is different from that of a normal pointer or address types
333    where the bits are interpreted differently than normal addresses.  The
334    TYPE_FLAG_ADDRESS_CLASS_n flags may be used in target specific
335    ways to represent these different types of address classes.  */
336 #define TYPE_ADDRESS_CLASS_1(t) (TYPE_INSTANCE_FLAGS(t) \
337                                  & TYPE_INSTANCE_FLAG_ADDRESS_CLASS_1)
338 #define TYPE_ADDRESS_CLASS_2(t) (TYPE_INSTANCE_FLAGS(t) \
339                                  & TYPE_INSTANCE_FLAG_ADDRESS_CLASS_2)
340 #define TYPE_INSTANCE_FLAG_ADDRESS_CLASS_ALL \
341   (TYPE_INSTANCE_FLAG_ADDRESS_CLASS_1 | TYPE_INSTANCE_FLAG_ADDRESS_CLASS_2)
342 #define TYPE_ADDRESS_CLASS_ALL(t) (TYPE_INSTANCE_FLAGS(t) \
343                                    & TYPE_INSTANCE_FLAG_ADDRESS_CLASS_ALL)
344
345 /* Determine which field of the union main_type.fields[x].loc is used.  */
346
347 enum field_loc_kind
348   {
349     FIELD_LOC_KIND_BITPOS,      /* bitpos */
350     FIELD_LOC_KIND_PHYSADDR,    /* physaddr */
351     FIELD_LOC_KIND_PHYSNAME     /* physname */
352   };
353
354 /* A discriminant to determine which field in the main_type.type_specific
355    union is being used, if any.
356
357    For types such as TYPE_CODE_FLT or TYPE_CODE_FUNC, the use of this
358    discriminant is really redundant, as we know from the type code
359    which field is going to be used.  As such, it would be possible to
360    reduce the size of this enum in order to save a bit or two for
361    other fields of struct main_type.  But, since we still have extra
362    room , and for the sake of clarity and consistency, we treat all fields
363    of the union the same way.  */
364
365 enum type_specific_kind
366 {
367   TYPE_SPECIFIC_NONE,
368   TYPE_SPECIFIC_CPLUS_STUFF,
369   TYPE_SPECIFIC_GNAT_STUFF,
370   TYPE_SPECIFIC_FLOATFORMAT,
371   TYPE_SPECIFIC_CALLING_CONVENTION
372 };
373
374 /* This structure is space-critical.
375    Its layout has been tweaked to reduce the space used.  */
376
377 struct main_type
378 {
379   /* Code for kind of type.  */
380
381   ENUM_BITFIELD(type_code) code : 8;
382
383   /* Flags about this type.  These fields appear at this location
384      because they packs nicely here.  See the TYPE_* macros for
385      documentation about these fields.  */
386
387   unsigned int flag_unsigned : 1;
388   unsigned int flag_nosign : 1;
389   unsigned int flag_stub : 1;
390   unsigned int flag_target_stub : 1;
391   unsigned int flag_static : 1;
392   unsigned int flag_prototyped : 1;
393   unsigned int flag_incomplete : 1;
394   unsigned int flag_varargs : 1;
395   unsigned int flag_vector : 1;
396   unsigned int flag_stub_supported : 1;
397   unsigned int flag_gnu_ifunc : 1;
398   unsigned int flag_fixed_instance : 1;
399   unsigned int flag_objfile_owned : 1;
400   /* True if this type was declared with "class" rather than
401      "struct".  */
402   unsigned int flag_declared_class : 1;
403
404   /* A discriminant telling us which field of the type_specific union
405      is being used for this type, if any.  */
406   ENUM_BITFIELD(type_specific_kind) type_specific_field : 3;
407
408   /* Number of fields described for this type.  This field appears at
409      this location because it packs nicely here.  */
410
411   short nfields;
412
413   /* Field number of the virtual function table pointer in
414      VPTR_BASETYPE.  If -1, we were unable to find the virtual
415      function table pointer in initial symbol reading, and
416      get_vptr_fieldno should be called to find it if possible.
417      get_vptr_fieldno will update this field if possible.
418      Otherwise the value is left at -1.
419
420      Unused if this type does not have virtual functions.
421
422      This field appears at this location because it packs nicely here.  */
423
424   short vptr_fieldno;
425
426   /* Name of this type, or NULL if none.
427
428      This is used for printing only, except by poorly designed C++ code.
429      For looking up a name, look for a symbol in the VAR_DOMAIN.  */
430
431   char *name;
432
433   /* Tag name for this type, or NULL if none.  This means that the
434      name of the type consists of a keyword followed by the tag name.
435      Which keyword is determined by the type code ("struct" for
436      TYPE_CODE_STRUCT, etc.).  As far as I know C/C++ are the only languages
437      with this feature.
438
439      This is used for printing only, except by poorly designed C++ code.
440      For looking up a name, look for a symbol in the STRUCT_DOMAIN.
441      One more legitimate use is that if TYPE_FLAG_STUB is set, this is
442      the name to use to look for definitions in other files.  */
443
444   char *tag_name;
445
446   /* Every type is now associated with a particular objfile, and the
447      type is allocated on the objfile_obstack for that objfile.  One problem
448      however, is that there are times when gdb allocates new types while
449      it is not in the process of reading symbols from a particular objfile.
450      Fortunately, these happen when the type being created is a derived
451      type of an existing type, such as in lookup_pointer_type().  So
452      we can just allocate the new type using the same objfile as the
453      existing type, but to do this we need a backpointer to the objfile
454      from the existing type.  Yes this is somewhat ugly, but without
455      major overhaul of the internal type system, it can't be avoided
456      for now.  */
457
458   union type_owner
459     {
460       struct objfile *objfile;
461       struct gdbarch *gdbarch;
462     } owner;
463
464   /* For a pointer type, describes the type of object pointed to.
465      For an array type, describes the type of the elements.
466      For a function or method type, describes the type of the return value.
467      For a range type, describes the type of the full range.
468      For a complex type, describes the type of each coordinate.
469      For a special record or union type encoding a dynamic-sized type
470      in GNAT, a memoized pointer to a corresponding static version of
471      the type.
472      Unused otherwise.  */
473
474   struct type *target_type;
475
476   /* For structure and union types, a description of each field.
477      For set and pascal array types, there is one "field",
478      whose type is the domain type of the set or array.
479      For range types, there are two "fields",
480      the minimum and maximum values (both inclusive).
481      For enum types, each possible value is described by one "field".
482      For a function or method type, a "field" for each parameter.
483      For C++ classes, there is one field for each base class (if it is
484      a derived class) plus one field for each class data member.  Member
485      functions are recorded elsewhere.
486
487      Using a pointer to a separate array of fields
488      allows all types to have the same size, which is useful
489      because we can allocate the space for a type before
490      we know what to put in it.  */
491
492   union 
493   {
494     struct field
495     {
496       union field_location
497       {
498         /* Position of this field, counting in bits from start of
499            containing structure.  For gdbarch_bits_big_endian=1
500            targets, it is the bit offset to the MSB.  For
501            gdbarch_bits_big_endian=0 targets, it is the bit offset to
502            the LSB.  For a range bound or enum value, this is the
503            value itself.  */
504
505         int bitpos;
506
507         /* For a static field, if TYPE_FIELD_STATIC_HAS_ADDR then physaddr
508            is the location (in the target) of the static field.
509            Otherwise, physname is the mangled label of the static field.  */
510
511         CORE_ADDR physaddr;
512         char *physname;
513       }
514       loc;
515
516       /* For a function or member type, this is 1 if the argument is marked
517          artificial.  Artificial arguments should not be shown to the
518          user.  For TYPE_CODE_RANGE it is set if the specific bound is not
519          defined.  */
520       unsigned int artificial : 1;
521
522       /* Discriminant for union field_location.  */
523       ENUM_BITFIELD(field_loc_kind) loc_kind : 2;
524
525       /* Size of this field, in bits, or zero if not packed.
526          If non-zero in an array type, indicates the element size in
527          bits (used only in Ada at the moment).
528          For an unpacked field, the field's type's length
529          says how many bytes the field occupies.  */
530
531       unsigned int bitsize : 29;
532
533       /* In a struct or union type, type of this field.
534          In a function or member type, type of this argument.
535          In an array type, the domain-type of the array.  */
536
537       struct type *type;
538
539       /* Name of field, value or argument.
540          NULL for range bounds, array domains, and member function
541          arguments.  */
542
543       char *name;
544     } *fields;
545
546     /* Union member used for range types.  */
547
548     struct range_bounds
549     {
550       /* Low bound of range.  */
551
552       LONGEST low;
553
554       /* High bound of range.  */
555
556       LONGEST high;
557
558       /* Flags indicating whether the values of low and high are
559          valid.  When true, the respective range value is
560          undefined.  Currently used only for FORTRAN arrays.  */
561            
562       char low_undefined;
563       char high_undefined;
564
565     } *bounds;
566
567   } flds_bnds;
568
569   /* For types with virtual functions (TYPE_CODE_STRUCT), VPTR_BASETYPE
570      is the base class which defined the virtual function table pointer.  
571
572      For types that are pointer to member types (TYPE_CODE_METHODPTR,
573      TYPE_CODE_MEMBERPTR), VPTR_BASETYPE is the type that this pointer
574      is a member of.
575
576      For method types (TYPE_CODE_METHOD), VPTR_BASETYPE is the aggregate
577      type that contains the method.
578
579      Unused otherwise.  */
580
581   struct type *vptr_basetype;
582
583   /* Slot to point to additional language-specific fields of this type.  */
584
585   union type_specific
586   {
587     /* CPLUS_STUFF is for TYPE_CODE_STRUCT.  It is initialized to point to
588        cplus_struct_default, a default static instance of a struct
589        cplus_struct_type.  */
590
591     struct cplus_struct_type *cplus_stuff;
592
593     /* GNAT_STUFF is for types for which the GNAT Ada compiler
594        provides additional information.  */
595     struct gnat_aux_type *gnat_stuff;
596
597     /* FLOATFORMAT is for TYPE_CODE_FLT.  It is a pointer to two
598        floatformat objects that describe the floating-point value
599        that resides within the type.  The first is for big endian
600        targets and the second is for little endian targets.  */
601
602     const struct floatformat **floatformat;
603
604     /* For TYPE_CODE_FUNC types, the calling convention for targets
605        supporting multiple ABIs.  Right now this is only fetched from
606        the Dwarf-2 DW_AT_calling_convention attribute.  */
607     unsigned calling_convention;
608   } type_specific;
609 };
610
611 /* A ``struct type'' describes a particular instance of a type, with
612    some particular qualification.  */
613 struct type
614 {
615   /* Type that is a pointer to this type.
616      NULL if no such pointer-to type is known yet.
617      The debugger may add the address of such a type
618      if it has to construct one later.  */
619
620   struct type *pointer_type;
621
622   /* C++: also need a reference type.  */
623
624   struct type *reference_type;
625
626   /* Variant chain.  This points to a type that differs from this one only
627      in qualifiers and length.  Currently, the possible qualifiers are
628      const, volatile, code-space, data-space, and address class.  The
629      length may differ only when one of the address class flags are set.
630      The variants are linked in a circular ring and share MAIN_TYPE.  */
631   struct type *chain;
632
633   /* Flags specific to this instance of the type, indicating where
634      on the ring we are.
635
636      For TYPE_CODE_TYPEDEF the flags of the typedef type should be binary
637      or-ed with the target type, with a special case for address class and
638      space class.  For example if this typedef does not specify any new
639      qualifiers, TYPE_INSTANCE_FLAGS is 0 and the instance flags are
640      completely inherited from the target type.  No qualifiers can be cleared
641      by the typedef.  See also check_typedef.  */
642   int instance_flags;
643
644   /* Length of storage for a value of this type.  This is what
645      sizeof(type) would return; use it for address arithmetic,
646      memory reads and writes, etc.  This size includes padding.  For
647      example, an i386 extended-precision floating point value really
648      only occupies ten bytes, but most ABI's declare its size to be
649      12 bytes, to preserve alignment.  A `struct type' representing
650      such a floating-point type would have a `length' value of 12,
651      even though the last two bytes are unused.
652
653      There's a bit of a host/target mess here, if you're concerned
654      about machines whose bytes aren't eight bits long, or who don't
655      have byte-addressed memory.  Various places pass this to memcpy
656      and such, meaning it must be in units of host bytes.  Various
657      other places expect they can calculate addresses by adding it
658      and such, meaning it must be in units of target bytes.  For
659      some DSP targets, in which HOST_CHAR_BIT will (presumably) be 8
660      and TARGET_CHAR_BIT will be (say) 32, this is a problem.
661
662      One fix would be to make this field in bits (requiring that it
663      always be a multiple of HOST_CHAR_BIT and TARGET_CHAR_BIT) ---
664      the other choice would be to make it consistently in units of
665      HOST_CHAR_BIT.  However, this would still fail to address
666      machines based on a ternary or decimal representation.  */
667   
668   unsigned length;
669
670   /* Core type, shared by a group of qualified types.  */
671   struct main_type *main_type;
672 };
673
674 #define NULL_TYPE ((struct type *) 0)
675
676 /* C++ language-specific information for TYPE_CODE_STRUCT and TYPE_CODE_UNION
677    nodes.  */
678
679 struct cplus_struct_type
680   {
681     /* Number of base classes this type derives from.  The baseclasses are
682        stored in the first N_BASECLASSES fields (i.e. the `fields' field of
683        the struct type).  I think only the `type' field of such a field has
684        any meaning.  */
685
686     short n_baseclasses;
687
688     /* Number of methods with unique names.  All overloaded methods with
689        the same name count only once.  */
690
691     short nfn_fields;
692
693     /* Number of methods described for this type, not including the
694        methods that it derives from.  */
695
696     short nfn_fields_total;
697
698     /* Number of template arguments.  */
699     unsigned short n_template_arguments;
700
701     /* One if this struct is a dynamic class, as defined by the
702        Itanium C++ ABI: if it requires a virtual table pointer,
703        because it or any of its base classes have one or more virtual
704        member functions or virtual base classes.  Minus one if not
705        dynamic.  Zero if not yet computed.  */
706     int is_dynamic : 2;
707
708     /* For derived classes, the number of base classes is given by
709        n_baseclasses and virtual_field_bits is a bit vector containing
710        one bit per base class.  If the base class is virtual, the
711        corresponding bit will be set.
712        I.E, given:
713
714        class A{};
715        class B{};
716        class C : public B, public virtual A {};
717
718        B is a baseclass of C; A is a virtual baseclass for C.
719        This is a C++ 2.0 language feature.  */
720
721     B_TYPE *virtual_field_bits;
722
723     /* For classes with private fields, the number of fields is given by
724        nfields and private_field_bits is a bit vector containing one bit
725        per field.
726        If the field is private, the corresponding bit will be set.  */
727
728     B_TYPE *private_field_bits;
729
730     /* For classes with protected fields, the number of fields is given by
731        nfields and protected_field_bits is a bit vector containing one bit
732        per field.
733        If the field is private, the corresponding bit will be set.  */
734
735     B_TYPE *protected_field_bits;
736
737     /* For classes with fields to be ignored, either this is optimized out
738        or this field has length 0.  */
739
740     B_TYPE *ignore_field_bits;
741
742     /* For classes, structures, and unions, a description of each field,
743        which consists of an overloaded name, followed by the types of
744        arguments that the method expects, and then the name after it
745        has been renamed to make it distinct.
746
747        fn_fieldlists points to an array of nfn_fields of these.  */
748
749     struct fn_fieldlist
750       {
751
752         /* The overloaded name.  */
753
754         char *name;
755
756         /* The number of methods with this name.  */
757
758         int length;
759
760         /* The list of methods.  */
761
762         struct fn_field
763           {
764
765             /* If is_stub is clear, this is the mangled name which we can
766                look up to find the address of the method (FIXME: it would
767                be cleaner to have a pointer to the struct symbol here
768                instead).  */
769
770             /* If is_stub is set, this is the portion of the mangled
771                name which specifies the arguments.  For example, "ii",
772                if there are two int arguments, or "" if there are no
773                arguments.  See gdb_mangle_name for the conversion from this
774                format to the one used if is_stub is clear.  */
775
776             char *physname;
777
778             /* The function type for the method.
779                (This comment used to say "The return value of the method",
780                but that's wrong.  The function type 
781                is expected here, i.e. something with TYPE_CODE_FUNC,
782                and *not* the return-value type).  */
783
784             struct type *type;
785
786             /* For virtual functions.
787                First baseclass that defines this virtual function.  */
788
789             struct type *fcontext;
790
791             /* Attributes.  */
792
793             unsigned int is_const:1;
794             unsigned int is_volatile:1;
795             unsigned int is_private:1;
796             unsigned int is_protected:1;
797             unsigned int is_public:1;
798             unsigned int is_abstract:1;
799             unsigned int is_static:1;
800             unsigned int is_final:1;
801             unsigned int is_synchronized:1;
802             unsigned int is_native:1;
803             unsigned int is_artificial:1;
804
805             /* A stub method only has some fields valid (but they are enough
806                to reconstruct the rest of the fields).  */
807             unsigned int is_stub:1;
808
809             /* Unused.  */
810             unsigned int dummy:4;
811
812             /* Index into that baseclass's virtual function table,
813                minus 2; else if static: VOFFSET_STATIC; else: 0.  */
814
815             unsigned int voffset:16;
816
817 #define VOFFSET_STATIC 1
818
819           }
820          *fn_fields;
821
822       }
823      *fn_fieldlists;
824
825     /* Pointer to information about enclosing scope, if this is a
826        local type.  If it is not a local type, this is NULL. */
827     struct local_type_info
828       {
829         char *file;
830         int line;
831       }
832      *localtype_ptr;
833
834     /* typedefs defined inside this class.  TYPEDEF_FIELD points to an array of
835        TYPEDEF_FIELD_COUNT elements.  */
836     struct typedef_field
837       {
838         /* Unqualified name to be prefixed by owning class qualified name.  */
839         const char *name;
840
841         /* Type this typedef named NAME represents.  */
842         struct type *type;
843       }
844     *typedef_field;
845     unsigned typedef_field_count;
846
847     /* The template arguments.  This is an array with
848        N_TEMPLATE_ARGUMENTS elements.  This is NULL for non-template
849        classes.  */
850     struct symbol **template_arguments;
851   };
852
853 /* Struct used in computing virtual base list.  */
854 struct vbase
855   {
856     struct type *vbasetype;     /* pointer to virtual base */
857     struct vbase *next;         /* next in chain */
858   };
859
860 /* Struct used to store conversion rankings.  */
861 struct rank
862   {
863     short rank;
864
865     /* When two conversions are of the same type and therefore have the same
866        rank, subrank is used to differentiate the two.
867        Eg: Two derived-class-pointer to base-class-pointer conversions would
868        both have base pointer conversion rank, but the conversion with the
869        shorter distance to the ancestor is preferable.  'subrank' would be used
870        to reflect that.  */
871     short subrank;
872   };
873
874 /* Struct used for ranking a function for overload resolution.  */
875 struct badness_vector
876   {
877     int length;
878     struct rank *rank;
879   };
880
881 /* GNAT Ada-specific information for various Ada types.  */
882 struct gnat_aux_type
883   {
884     /* Parallel type used to encode information about dynamic types
885        used in Ada (such as variant records, variable-size array,
886        etc).  */
887     struct type* descriptive_type;
888   };
889
890 /* The default value of TYPE_CPLUS_SPECIFIC(T) points to the
891    this shared static structure.  */
892
893 extern const struct cplus_struct_type cplus_struct_default;
894
895 extern void allocate_cplus_struct_type (struct type *);
896
897 #define INIT_CPLUS_SPECIFIC(type) \
898   (TYPE_SPECIFIC_FIELD (type) = TYPE_SPECIFIC_CPLUS_STUFF, \
899    TYPE_RAW_CPLUS_SPECIFIC (type) = (struct cplus_struct_type*) \
900    &cplus_struct_default)
901
902 #define ALLOCATE_CPLUS_STRUCT_TYPE(type) allocate_cplus_struct_type (type)
903
904 #define HAVE_CPLUS_STRUCT(type) \
905   (TYPE_SPECIFIC_FIELD (type) == TYPE_SPECIFIC_CPLUS_STUFF \
906    && TYPE_RAW_CPLUS_SPECIFIC (type) !=  &cplus_struct_default)
907
908 extern const struct gnat_aux_type gnat_aux_default;
909
910 extern void allocate_gnat_aux_type (struct type *);
911
912 #define INIT_GNAT_SPECIFIC(type) \
913   (TYPE_SPECIFIC_FIELD (type) = TYPE_SPECIFIC_GNAT_STUFF, \
914    TYPE_GNAT_SPECIFIC (type) = (struct gnat_aux_type *) &gnat_aux_default)
915 #define ALLOCATE_GNAT_AUX_TYPE(type) allocate_gnat_aux_type (type)
916 /* A macro that returns non-zero if the type-specific data should be
917    read as "gnat-stuff".  */
918 #define HAVE_GNAT_AUX_INFO(type) \
919   (TYPE_SPECIFIC_FIELD (type) == TYPE_SPECIFIC_GNAT_STUFF)
920
921 #define TYPE_INSTANCE_FLAGS(thistype) (thistype)->instance_flags
922 #define TYPE_MAIN_TYPE(thistype) (thistype)->main_type
923 #define TYPE_NAME(thistype) TYPE_MAIN_TYPE(thistype)->name
924 #define TYPE_TAG_NAME(type) TYPE_MAIN_TYPE(type)->tag_name
925 #define TYPE_TARGET_TYPE(thistype) TYPE_MAIN_TYPE(thistype)->target_type
926 #define TYPE_POINTER_TYPE(thistype) (thistype)->pointer_type
927 #define TYPE_REFERENCE_TYPE(thistype) (thistype)->reference_type
928 #define TYPE_CHAIN(thistype) (thistype)->chain
929 /* Note that if thistype is a TYPEDEF type, you have to call check_typedef.
930    But check_typedef does set the TYPE_LENGTH of the TYPEDEF type,
931    so you only have to call check_typedef once.  Since allocate_value
932    calls check_typedef, TYPE_LENGTH (VALUE_TYPE (X)) is safe.  */
933 #define TYPE_LENGTH(thistype) (thistype)->length
934 /* Note that TYPE_CODE can be TYPE_CODE_TYPEDEF, so if you want the real
935    type, you need to do TYPE_CODE (check_type (this_type)).  */
936 #define TYPE_CODE(thistype) TYPE_MAIN_TYPE(thistype)->code
937 #define TYPE_NFIELDS(thistype) TYPE_MAIN_TYPE(thistype)->nfields
938 #define TYPE_FIELDS(thistype) TYPE_MAIN_TYPE(thistype)->flds_bnds.fields
939
940 #define TYPE_INDEX_TYPE(type) TYPE_FIELD_TYPE (type, 0)
941 #define TYPE_RANGE_DATA(thistype) TYPE_MAIN_TYPE(thistype)->flds_bnds.bounds
942 #define TYPE_LOW_BOUND(range_type) TYPE_RANGE_DATA(range_type)->low
943 #define TYPE_HIGH_BOUND(range_type) TYPE_RANGE_DATA(range_type)->high
944 #define TYPE_LOW_BOUND_UNDEFINED(range_type) \
945    TYPE_RANGE_DATA(range_type)->low_undefined
946 #define TYPE_HIGH_BOUND_UNDEFINED(range_type) \
947    TYPE_RANGE_DATA(range_type)->high_undefined
948
949 /* Moto-specific stuff for FORTRAN arrays.  */
950
951 #define TYPE_ARRAY_UPPER_BOUND_IS_UNDEFINED(arraytype) \
952    TYPE_HIGH_BOUND_UNDEFINED(TYPE_INDEX_TYPE(arraytype))
953 #define TYPE_ARRAY_LOWER_BOUND_IS_UNDEFINED(arraytype) \
954    TYPE_LOW_BOUND_UNDEFINED(TYPE_INDEX_TYPE(arraytype))
955
956 #define TYPE_ARRAY_UPPER_BOUND_VALUE(arraytype) \
957    (TYPE_HIGH_BOUND(TYPE_INDEX_TYPE((arraytype))))
958
959 #define TYPE_ARRAY_LOWER_BOUND_VALUE(arraytype) \
960    (TYPE_LOW_BOUND(TYPE_INDEX_TYPE((arraytype))))
961
962 /* C++ */
963
964 #define TYPE_VPTR_BASETYPE(thistype) TYPE_MAIN_TYPE(thistype)->vptr_basetype
965 #define TYPE_DOMAIN_TYPE(thistype) TYPE_MAIN_TYPE(thistype)->vptr_basetype
966 #define TYPE_VPTR_FIELDNO(thistype) TYPE_MAIN_TYPE(thistype)->vptr_fieldno
967 #define TYPE_FN_FIELDS(thistype) TYPE_CPLUS_SPECIFIC(thistype)->fn_fields
968 #define TYPE_NFN_FIELDS(thistype) TYPE_CPLUS_SPECIFIC(thistype)->nfn_fields
969 #define TYPE_NFN_FIELDS_TOTAL(thistype) TYPE_CPLUS_SPECIFIC(thistype)->nfn_fields_total
970 #define TYPE_SPECIFIC_FIELD(thistype) \
971   TYPE_MAIN_TYPE(thistype)->type_specific_field
972 #define TYPE_TYPE_SPECIFIC(thistype) TYPE_MAIN_TYPE(thistype)->type_specific
973 /* We need this tap-dance with the TYPE_RAW_SPECIFIC because of the case
974    where we're trying to print an Ada array using the C language.
975    In that case, there is no "cplus_stuff", but the C language assumes
976    that there is.  What we do, in that case, is pretend that there is
977    an implicit one which is the default cplus stuff.  */
978 #define TYPE_CPLUS_SPECIFIC(thistype) \
979    (!HAVE_CPLUS_STRUCT(thistype) \
980     ? (struct cplus_struct_type*)&cplus_struct_default \
981     : TYPE_RAW_CPLUS_SPECIFIC(thistype))
982 #define TYPE_RAW_CPLUS_SPECIFIC(thistype) TYPE_MAIN_TYPE(thistype)->type_specific.cplus_stuff
983 #define TYPE_FLOATFORMAT(thistype) TYPE_MAIN_TYPE(thistype)->type_specific.floatformat
984 #define TYPE_GNAT_SPECIFIC(thistype) TYPE_MAIN_TYPE(thistype)->type_specific.gnat_stuff
985 #define TYPE_DESCRIPTIVE_TYPE(thistype) TYPE_GNAT_SPECIFIC(thistype)->descriptive_type
986 #define TYPE_CALLING_CONVENTION(thistype) TYPE_MAIN_TYPE(thistype)->type_specific.calling_convention
987 #define TYPE_BASECLASS(thistype,index) TYPE_FIELD_TYPE(thistype, index)
988 #define TYPE_N_BASECLASSES(thistype) TYPE_CPLUS_SPECIFIC(thistype)->n_baseclasses
989 #define TYPE_BASECLASS_NAME(thistype,index) TYPE_FIELD_NAME(thistype, index)
990 #define TYPE_BASECLASS_BITPOS(thistype,index) TYPE_FIELD_BITPOS(thistype,index)
991 #define BASETYPE_VIA_PUBLIC(thistype, index) \
992   ((!TYPE_FIELD_PRIVATE(thistype, index)) && (!TYPE_FIELD_PROTECTED(thistype, index)))
993 #define TYPE_CPLUS_DYNAMIC(thistype) TYPE_CPLUS_SPECIFIC (thistype)->is_dynamic
994
995 #define BASETYPE_VIA_VIRTUAL(thistype, index) \
996   (TYPE_CPLUS_SPECIFIC(thistype)->virtual_field_bits == NULL ? 0 \
997     : B_TST(TYPE_CPLUS_SPECIFIC(thistype)->virtual_field_bits, (index)))
998
999 #define FIELD_TYPE(thisfld) ((thisfld).type)
1000 #define FIELD_NAME(thisfld) ((thisfld).name)
1001 #define FIELD_LOC_KIND(thisfld) ((thisfld).loc_kind)
1002 #define FIELD_BITPOS(thisfld) ((thisfld).loc.bitpos)
1003 #define FIELD_STATIC_PHYSNAME(thisfld) ((thisfld).loc.physname)
1004 #define FIELD_STATIC_PHYSADDR(thisfld) ((thisfld).loc.physaddr)
1005 #define SET_FIELD_BITPOS(thisfld, bitpos)                       \
1006   (FIELD_LOC_KIND (thisfld) = FIELD_LOC_KIND_BITPOS,            \
1007    FIELD_BITPOS (thisfld) = (bitpos))
1008 #define SET_FIELD_PHYSNAME(thisfld, name)                       \
1009   (FIELD_LOC_KIND (thisfld) = FIELD_LOC_KIND_PHYSNAME,          \
1010    FIELD_STATIC_PHYSNAME (thisfld) = (name))
1011 #define SET_FIELD_PHYSADDR(thisfld, addr)                       \
1012   (FIELD_LOC_KIND (thisfld) = FIELD_LOC_KIND_PHYSADDR,          \
1013    FIELD_STATIC_PHYSADDR (thisfld) = (addr))
1014 #define FIELD_ARTIFICIAL(thisfld) ((thisfld).artificial)
1015 #define FIELD_BITSIZE(thisfld) ((thisfld).bitsize)
1016
1017 #define TYPE_FIELD(thistype, n) TYPE_MAIN_TYPE(thistype)->flds_bnds.fields[n]
1018 #define TYPE_FIELD_TYPE(thistype, n) FIELD_TYPE(TYPE_FIELD(thistype, n))
1019 #define TYPE_FIELD_NAME(thistype, n) FIELD_NAME(TYPE_FIELD(thistype, n))
1020 #define TYPE_FIELD_LOC_KIND(thistype, n) FIELD_LOC_KIND (TYPE_FIELD (thistype, n))
1021 #define TYPE_FIELD_BITPOS(thistype, n) FIELD_BITPOS (TYPE_FIELD (thistype, n))
1022 #define TYPE_FIELD_STATIC_PHYSNAME(thistype, n) FIELD_STATIC_PHYSNAME (TYPE_FIELD (thistype, n))
1023 #define TYPE_FIELD_STATIC_PHYSADDR(thistype, n) FIELD_STATIC_PHYSADDR (TYPE_FIELD (thistype, n))
1024 #define TYPE_FIELD_ARTIFICIAL(thistype, n) FIELD_ARTIFICIAL(TYPE_FIELD(thistype,n))
1025 #define TYPE_FIELD_BITSIZE(thistype, n) FIELD_BITSIZE(TYPE_FIELD(thistype,n))
1026 #define TYPE_FIELD_PACKED(thistype, n) (FIELD_BITSIZE(TYPE_FIELD(thistype,n))!=0)
1027
1028 #define TYPE_FIELD_PRIVATE_BITS(thistype) \
1029   TYPE_CPLUS_SPECIFIC(thistype)->private_field_bits
1030 #define TYPE_FIELD_PROTECTED_BITS(thistype) \
1031   TYPE_CPLUS_SPECIFIC(thistype)->protected_field_bits
1032 #define TYPE_FIELD_IGNORE_BITS(thistype) \
1033   TYPE_CPLUS_SPECIFIC(thistype)->ignore_field_bits
1034 #define TYPE_FIELD_VIRTUAL_BITS(thistype) \
1035   TYPE_CPLUS_SPECIFIC(thistype)->virtual_field_bits
1036 #define SET_TYPE_FIELD_PRIVATE(thistype, n) \
1037   B_SET (TYPE_CPLUS_SPECIFIC(thistype)->private_field_bits, (n))
1038 #define SET_TYPE_FIELD_PROTECTED(thistype, n) \
1039   B_SET (TYPE_CPLUS_SPECIFIC(thistype)->protected_field_bits, (n))
1040 #define SET_TYPE_FIELD_IGNORE(thistype, n) \
1041   B_SET (TYPE_CPLUS_SPECIFIC(thistype)->ignore_field_bits, (n))
1042 #define SET_TYPE_FIELD_VIRTUAL(thistype, n) \
1043   B_SET (TYPE_CPLUS_SPECIFIC(thistype)->virtual_field_bits, (n))
1044 #define TYPE_FIELD_PRIVATE(thistype, n) \
1045   (TYPE_CPLUS_SPECIFIC(thistype)->private_field_bits == NULL ? 0 \
1046     : B_TST(TYPE_CPLUS_SPECIFIC(thistype)->private_field_bits, (n)))
1047 #define TYPE_FIELD_PROTECTED(thistype, n) \
1048   (TYPE_CPLUS_SPECIFIC(thistype)->protected_field_bits == NULL ? 0 \
1049     : B_TST(TYPE_CPLUS_SPECIFIC(thistype)->protected_field_bits, (n)))
1050 #define TYPE_FIELD_IGNORE(thistype, n) \
1051   (TYPE_CPLUS_SPECIFIC(thistype)->ignore_field_bits == NULL ? 0 \
1052     : B_TST(TYPE_CPLUS_SPECIFIC(thistype)->ignore_field_bits, (n)))
1053 #define TYPE_FIELD_VIRTUAL(thistype, n) \
1054   (TYPE_CPLUS_SPECIFIC(thistype)->virtual_field_bits == NULL ? 0 \
1055     : B_TST(TYPE_CPLUS_SPECIFIC(thistype)->virtual_field_bits, (n)))
1056
1057 #define TYPE_FN_FIELDLISTS(thistype) TYPE_CPLUS_SPECIFIC(thistype)->fn_fieldlists
1058 #define TYPE_FN_FIELDLIST(thistype, n) TYPE_CPLUS_SPECIFIC(thistype)->fn_fieldlists[n]
1059 #define TYPE_FN_FIELDLIST1(thistype, n) TYPE_CPLUS_SPECIFIC(thistype)->fn_fieldlists[n].fn_fields
1060 #define TYPE_FN_FIELDLIST_NAME(thistype, n) TYPE_CPLUS_SPECIFIC(thistype)->fn_fieldlists[n].name
1061 #define TYPE_FN_FIELDLIST_LENGTH(thistype, n) TYPE_CPLUS_SPECIFIC(thistype)->fn_fieldlists[n].length
1062
1063 #define TYPE_N_TEMPLATE_ARGUMENTS(thistype) \
1064   TYPE_CPLUS_SPECIFIC (thistype)->n_template_arguments
1065 #define TYPE_TEMPLATE_ARGUMENTS(thistype) \
1066   TYPE_CPLUS_SPECIFIC (thistype)->template_arguments
1067 #define TYPE_TEMPLATE_ARGUMENT(thistype, n) \
1068   TYPE_CPLUS_SPECIFIC (thistype)->template_arguments[n]
1069
1070 #define TYPE_FN_FIELD(thisfn, n) (thisfn)[n]
1071 #define TYPE_FN_FIELD_PHYSNAME(thisfn, n) (thisfn)[n].physname
1072 #define TYPE_FN_FIELD_TYPE(thisfn, n) (thisfn)[n].type
1073 #define TYPE_FN_FIELD_ARGS(thisfn, n) TYPE_FIELDS ((thisfn)[n].type)
1074 #define TYPE_FN_FIELD_CONST(thisfn, n) ((thisfn)[n].is_const)
1075 #define TYPE_FN_FIELD_VOLATILE(thisfn, n) ((thisfn)[n].is_volatile)
1076 #define TYPE_FN_FIELD_PRIVATE(thisfn, n) ((thisfn)[n].is_private)
1077 #define TYPE_FN_FIELD_PROTECTED(thisfn, n) ((thisfn)[n].is_protected)
1078 #define TYPE_FN_FIELD_PUBLIC(thisfn, n) ((thisfn)[n].is_public)
1079 #define TYPE_FN_FIELD_STATIC(thisfn, n) ((thisfn)[n].is_static)
1080 #define TYPE_FN_FIELD_FINAL(thisfn, n) ((thisfn)[n].is_final)
1081 #define TYPE_FN_FIELD_SYNCHRONIZED(thisfn, n) ((thisfn)[n].is_synchronized)
1082 #define TYPE_FN_FIELD_NATIVE(thisfn, n) ((thisfn)[n].is_native)
1083 #define TYPE_FN_FIELD_ARTIFICIAL(thisfn, n) ((thisfn)[n].is_artificial)
1084 #define TYPE_FN_FIELD_ABSTRACT(thisfn, n) ((thisfn)[n].is_abstract)
1085 #define TYPE_FN_FIELD_STUB(thisfn, n) ((thisfn)[n].is_stub)
1086 #define TYPE_FN_FIELD_FCONTEXT(thisfn, n) ((thisfn)[n].fcontext)
1087 #define TYPE_FN_FIELD_VOFFSET(thisfn, n) ((thisfn)[n].voffset-2)
1088 #define TYPE_FN_FIELD_VIRTUAL_P(thisfn, n) ((thisfn)[n].voffset > 1)
1089 #define TYPE_FN_FIELD_STATIC_P(thisfn, n) ((thisfn)[n].voffset == VOFFSET_STATIC)
1090
1091 #define TYPE_LOCALTYPE_PTR(thistype) (TYPE_CPLUS_SPECIFIC(thistype)->localtype_ptr)
1092 #define TYPE_LOCALTYPE_FILE(thistype) (TYPE_CPLUS_SPECIFIC(thistype)->localtype_ptr->file)
1093 #define TYPE_LOCALTYPE_LINE(thistype) (TYPE_CPLUS_SPECIFIC(thistype)->localtype_ptr->line)
1094
1095 #define TYPE_TYPEDEF_FIELD_ARRAY(thistype) \
1096   TYPE_CPLUS_SPECIFIC (thistype)->typedef_field
1097 #define TYPE_TYPEDEF_FIELD(thistype, n) \
1098   TYPE_CPLUS_SPECIFIC (thistype)->typedef_field[n]
1099 #define TYPE_TYPEDEF_FIELD_NAME(thistype, n) \
1100   TYPE_TYPEDEF_FIELD (thistype, n).name
1101 #define TYPE_TYPEDEF_FIELD_TYPE(thistype, n) \
1102   TYPE_TYPEDEF_FIELD (thistype, n).type
1103 #define TYPE_TYPEDEF_FIELD_COUNT(thistype) \
1104   TYPE_CPLUS_SPECIFIC (thistype)->typedef_field_count
1105
1106 #define TYPE_IS_OPAQUE(thistype) \
1107   (((TYPE_CODE (thistype) == TYPE_CODE_STRUCT) \
1108     || (TYPE_CODE (thistype) == TYPE_CODE_UNION)) \
1109    && (TYPE_NFIELDS (thistype) == 0) \
1110    && (!HAVE_CPLUS_STRUCT (thistype) \
1111        || TYPE_NFN_FIELDS (thistype) == 0) \
1112    && (TYPE_STUB (thistype) || !TYPE_STUB_SUPPORTED (thistype)))
1113
1114 /* A helper macro that returns the name of an error type.  If the type
1115    has a name, it is used; otherwise, a default is used.  */
1116 #define TYPE_ERROR_NAME(type) \
1117   (TYPE_NAME (type) ? TYPE_NAME (type) : _("<error type>"))
1118
1119 struct builtin_type
1120 {
1121   /* Integral types.  */
1122
1123   /* Implicit size/sign (based on the architecture's ABI).  */
1124   struct type *builtin_void;
1125   struct type *builtin_char;
1126   struct type *builtin_short;
1127   struct type *builtin_int;
1128   struct type *builtin_long;
1129   struct type *builtin_signed_char;
1130   struct type *builtin_unsigned_char;
1131   struct type *builtin_unsigned_short;
1132   struct type *builtin_unsigned_int;
1133   struct type *builtin_unsigned_long;
1134   struct type *builtin_float;
1135   struct type *builtin_double;
1136   struct type *builtin_long_double;
1137   struct type *builtin_complex;
1138   struct type *builtin_double_complex;
1139   struct type *builtin_string;
1140   struct type *builtin_bool;
1141   struct type *builtin_long_long;
1142   struct type *builtin_unsigned_long_long;
1143   struct type *builtin_decfloat;
1144   struct type *builtin_decdouble;
1145   struct type *builtin_declong;
1146
1147   /* "True" character types.
1148       We use these for the '/c' print format, because c_char is just a
1149       one-byte integral type, which languages less laid back than C
1150       will print as ... well, a one-byte integral type.  */
1151   struct type *builtin_true_char;
1152   struct type *builtin_true_unsigned_char;
1153
1154   /* Explicit sizes - see C9X <intypes.h> for naming scheme.  The "int0"
1155      is for when an architecture needs to describe a register that has
1156      no size.  */
1157   struct type *builtin_int0;
1158   struct type *builtin_int8;
1159   struct type *builtin_uint8;
1160   struct type *builtin_int16;
1161   struct type *builtin_uint16;
1162   struct type *builtin_int32;
1163   struct type *builtin_uint32;
1164   struct type *builtin_int64;
1165   struct type *builtin_uint64;
1166   struct type *builtin_int128;
1167   struct type *builtin_uint128;
1168
1169   /* Wide character types.  */
1170   struct type *builtin_char16;
1171   struct type *builtin_char32;
1172
1173   /* Pointer types.  */
1174
1175   /* `pointer to data' type.  Some target platforms use an implicitly
1176      {sign,zero} -extended 32-bit ABI pointer on a 64-bit ISA.  */
1177   struct type *builtin_data_ptr;
1178
1179   /* `pointer to function (returning void)' type.  Harvard
1180      architectures mean that ABI function and code pointers are not
1181      interconvertible.  Similarly, since ANSI, C standards have
1182      explicitly said that pointers to functions and pointers to data
1183      are not interconvertible --- that is, you can't cast a function
1184      pointer to void * and back, and expect to get the same value.
1185      However, all function pointer types are interconvertible, so void
1186      (*) () can server as a generic function pointer.  */
1187   struct type *builtin_func_ptr;
1188
1189   /* `function returning pointer to function (returning void)' type.
1190      The final void return type is not significant for it.  */
1191   struct type *builtin_func_func;
1192
1193
1194   /* Special-purpose types.  */
1195
1196   /* This type is used to represent a GDB internal function.  */
1197   struct type *internal_fn;
1198 };
1199
1200 /* Return the type table for the specified architecture.  */
1201 extern const struct builtin_type *builtin_type (struct gdbarch *gdbarch);
1202
1203
1204 /* Per-objfile types used by symbol readers.  */
1205
1206 struct objfile_type
1207 {
1208   /* Basic types based on the objfile architecture.  */
1209   struct type *builtin_void;
1210   struct type *builtin_char;
1211   struct type *builtin_short;
1212   struct type *builtin_int;
1213   struct type *builtin_long;
1214   struct type *builtin_long_long;
1215   struct type *builtin_signed_char;
1216   struct type *builtin_unsigned_char;
1217   struct type *builtin_unsigned_short;
1218   struct type *builtin_unsigned_int;
1219   struct type *builtin_unsigned_long;
1220   struct type *builtin_unsigned_long_long;
1221   struct type *builtin_float;
1222   struct type *builtin_double;
1223   struct type *builtin_long_double;
1224
1225   /* This type is used to represent symbol addresses.  */
1226   struct type *builtin_core_addr;
1227
1228   /* This type represents a type that was unrecognized in symbol read-in.  */
1229   struct type *builtin_error;
1230
1231   /* Types used for symbols with no debug information.  */
1232   struct type *nodebug_text_symbol;
1233   struct type *nodebug_text_gnu_ifunc_symbol;
1234   struct type *nodebug_got_plt_symbol;
1235   struct type *nodebug_data_symbol;
1236   struct type *nodebug_unknown_symbol;
1237   struct type *nodebug_tls_symbol;
1238 };
1239
1240 /* Return the type table for the specified objfile.  */
1241 extern const struct objfile_type *objfile_type (struct objfile *objfile);
1242
1243  
1244 /* Explicit floating-point formats.  See "floatformat.h".  */
1245 extern const struct floatformat *floatformats_ieee_half[BFD_ENDIAN_UNKNOWN];
1246 extern const struct floatformat *floatformats_ieee_single[BFD_ENDIAN_UNKNOWN];
1247 extern const struct floatformat *floatformats_ieee_double[BFD_ENDIAN_UNKNOWN];
1248 extern const struct floatformat *floatformats_ieee_double_littlebyte_bigword[BFD_ENDIAN_UNKNOWN];
1249 extern const struct floatformat *floatformats_i387_ext[BFD_ENDIAN_UNKNOWN];
1250 extern const struct floatformat *floatformats_m68881_ext[BFD_ENDIAN_UNKNOWN];
1251 extern const struct floatformat *floatformats_arm_ext[BFD_ENDIAN_UNKNOWN];
1252 extern const struct floatformat *floatformats_ia64_spill[BFD_ENDIAN_UNKNOWN];
1253 extern const struct floatformat *floatformats_ia64_quad[BFD_ENDIAN_UNKNOWN];
1254 extern const struct floatformat *floatformats_vax_f[BFD_ENDIAN_UNKNOWN];
1255 extern const struct floatformat *floatformats_vax_d[BFD_ENDIAN_UNKNOWN];
1256 extern const struct floatformat *floatformats_ibm_long_double[BFD_ENDIAN_UNKNOWN];
1257
1258
1259 /* Allocate space for storing data associated with a particular type.
1260    We ensure that the space is allocated using the same mechanism that
1261    was used to allocate the space for the type structure itself.  I.e.
1262    if the type is on an objfile's objfile_obstack, then the space for data
1263    associated with that type will also be allocated on the objfile_obstack.
1264    If the type is not associated with any particular objfile (such as
1265    builtin types), then the data space will be allocated with xmalloc,
1266    the same as for the type structure.  */
1267
1268 #define TYPE_ALLOC(t,size)  \
1269    (TYPE_OBJFILE_OWNED (t) \
1270     ? obstack_alloc (&TYPE_OBJFILE (t) -> objfile_obstack, size) \
1271     : xmalloc (size))
1272
1273 #define TYPE_ZALLOC(t,size)  \
1274    (TYPE_OBJFILE_OWNED (t) \
1275     ? memset (obstack_alloc (&TYPE_OBJFILE (t)->objfile_obstack, size),  \
1276               0, size)  \
1277     : xzalloc (size))
1278
1279 /* Use alloc_type to allocate a type owned by an objfile.
1280    Use alloc_type_arch to allocate a type owned by an architecture.
1281    Use alloc_type_copy to allocate a type with the same owner as a
1282    pre-existing template type, no matter whether objfile or gdbarch.  */
1283 extern struct type *alloc_type (struct objfile *);
1284 extern struct type *alloc_type_arch (struct gdbarch *);
1285 extern struct type *alloc_type_copy (const struct type *);
1286
1287 /* Return the type's architecture.  For types owned by an architecture,
1288    that architecture is returned.  For types owned by an objfile, that
1289    objfile's architecture is returned.  */
1290 extern struct gdbarch *get_type_arch (const struct type *);
1291
1292 /* Helper function to construct objfile-owned types.  */
1293 extern struct type *init_type (enum type_code, int, int, char *,
1294                                struct objfile *);
1295
1296 /* Helper functions to construct architecture-owned types.  */
1297 extern struct type *arch_type (struct gdbarch *, enum type_code, int, char *);
1298 extern struct type *arch_integer_type (struct gdbarch *, int, int, char *);
1299 extern struct type *arch_character_type (struct gdbarch *, int, int, char *);
1300 extern struct type *arch_boolean_type (struct gdbarch *, int, int, char *);
1301 extern struct type *arch_float_type (struct gdbarch *, int, char *,
1302                                      const struct floatformat **);
1303 extern struct type *arch_complex_type (struct gdbarch *, char *,
1304                                        struct type *);
1305
1306 /* Helper functions to construct a struct or record type.  An
1307    initially empty type is created using arch_composite_type().
1308    Fields are then added using append_composite_type_field*().  A union
1309    type has its size set to the largest field.  A struct type has each
1310    field packed against the previous.  */
1311
1312 extern struct type *arch_composite_type (struct gdbarch *gdbarch,
1313                                          char *name, enum type_code code);
1314 extern void append_composite_type_field (struct type *t, char *name,
1315                                          struct type *field);
1316 extern void append_composite_type_field_aligned (struct type *t,
1317                                                  char *name,
1318                                                  struct type *field,
1319                                                  int alignment);
1320 struct field *append_composite_type_field_raw (struct type *t, char *name,
1321                                                struct type *field);
1322
1323 /* Helper functions to construct a bit flags type.  An initially empty
1324    type is created using arch_flag_type().  Flags are then added using
1325    append_flag_type_flag().  */
1326 extern struct type *arch_flags_type (struct gdbarch *gdbarch,
1327                                      char *name, int length);
1328 extern void append_flags_type_flag (struct type *type, int bitpos, char *name);
1329
1330 extern void make_vector_type (struct type *array_type);
1331 extern struct type *init_vector_type (struct type *elt_type, int n);
1332
1333 extern struct type *lookup_reference_type (struct type *);
1334
1335 extern struct type *make_reference_type (struct type *, struct type **);
1336
1337 extern struct type *make_cv_type (int, int, struct type *, struct type **);
1338
1339 extern void replace_type (struct type *, struct type *);
1340
1341 extern int address_space_name_to_int (struct gdbarch *, char *);
1342
1343 extern const char *address_space_int_to_name (struct gdbarch *, int);
1344
1345 extern struct type *make_type_with_address_space (struct type *type, 
1346                                                   int space_identifier);
1347
1348 extern struct type *lookup_memberptr_type (struct type *, struct type *);
1349
1350 extern struct type *lookup_methodptr_type (struct type *);
1351
1352 extern void smash_to_method_type (struct type *type, struct type *domain,
1353                                   struct type *to_type, struct field *args,
1354                                   int nargs, int varargs);
1355
1356 extern void smash_to_memberptr_type (struct type *, struct type *,
1357                                      struct type *);
1358
1359 extern void smash_to_methodptr_type (struct type *, struct type *);
1360
1361 extern struct type *allocate_stub_method (struct type *);
1362
1363 extern char *type_name_no_tag (const struct type *);
1364
1365 extern struct type *lookup_struct_elt_type (struct type *, char *, int);
1366
1367 extern struct type *make_pointer_type (struct type *, struct type **);
1368
1369 extern struct type *lookup_pointer_type (struct type *);
1370
1371 extern struct type *make_function_type (struct type *, struct type **);
1372
1373 extern struct type *lookup_function_type (struct type *);
1374
1375 extern struct type *create_range_type (struct type *, struct type *, LONGEST,
1376                                        LONGEST);
1377
1378 extern struct type *create_array_type (struct type *, struct type *,
1379                                        struct type *);
1380 extern struct type *lookup_array_range_type (struct type *, int, int);
1381
1382 extern struct type *create_string_type (struct type *, struct type *,
1383                                         struct type *);
1384 extern struct type *lookup_string_range_type (struct type *, int, int);
1385
1386 extern struct type *create_set_type (struct type *, struct type *);
1387
1388 extern struct type *lookup_unsigned_typename (const struct language_defn *,
1389                                               struct gdbarch *,char *);
1390
1391 extern struct type *lookup_signed_typename (const struct language_defn *,
1392                                             struct gdbarch *,char *);
1393
1394 extern struct type *check_typedef (struct type *);
1395
1396 #define CHECK_TYPEDEF(TYPE)                     \
1397   do {                                          \
1398     (TYPE) = check_typedef (TYPE);              \
1399   } while (0)
1400
1401 extern void check_stub_method_group (struct type *, int);
1402
1403 extern char *gdb_mangle_name (struct type *, int, int);
1404
1405 extern struct type *lookup_typename (const struct language_defn *,
1406                                      struct gdbarch *, char *,
1407                                      const struct block *, int);
1408
1409 extern struct type *lookup_template_type (char *, struct type *,
1410                                           struct block *);
1411
1412 extern int get_vptr_fieldno (struct type *, struct type **);
1413
1414 extern int get_discrete_bounds (struct type *, LONGEST *, LONGEST *);
1415
1416 extern int get_array_bounds (struct type *type, LONGEST *low_bound,
1417                              LONGEST *high_bound);
1418
1419 extern int class_types_same_p (const struct type *, const struct type *);
1420
1421 extern int is_ancestor (struct type *, struct type *);
1422
1423 extern int is_public_ancestor (struct type *, struct type *);
1424
1425 extern int is_unique_ancestor (struct type *, struct value *);
1426
1427 /* Overload resolution */
1428
1429 #define LENGTH_MATCH(bv) ((bv)->rank[0])
1430
1431 /* Badness if parameter list length doesn't match arg list length.  */
1432 extern const struct rank LENGTH_MISMATCH_BADNESS;
1433
1434 /* Dummy badness value for nonexistent parameter positions.  */
1435 extern const struct rank TOO_FEW_PARAMS_BADNESS;
1436 /* Badness if no conversion among types.  */
1437 extern const struct rank INCOMPATIBLE_TYPE_BADNESS;
1438
1439 /* Badness of an exact match.  */
1440 extern const struct rank EXACT_MATCH_BADNESS;
1441
1442 /* Badness of integral promotion.  */
1443 extern const struct rank INTEGER_PROMOTION_BADNESS;
1444 /* Badness of floating promotion.  */
1445 extern const struct rank FLOAT_PROMOTION_BADNESS;
1446 /* Badness of converting a derived class pointer
1447    to a base class pointer.  */
1448 extern const struct rank BASE_PTR_CONVERSION_BADNESS;
1449 /* Badness of integral conversion.  */
1450 extern const struct rank INTEGER_CONVERSION_BADNESS;
1451 /* Badness of floating conversion.  */
1452 extern const struct rank FLOAT_CONVERSION_BADNESS;
1453 /* Badness of integer<->floating conversions.  */
1454 extern const struct rank INT_FLOAT_CONVERSION_BADNESS;
1455 /* Badness of conversion of pointer to void pointer.  */
1456 extern const struct rank VOID_PTR_CONVERSION_BADNESS;
1457 /* Badness of conversion of pointer to boolean.  */
1458 extern const struct rank BOOL_PTR_CONVERSION_BADNESS;
1459 /* Badness of converting derived to base class.  */
1460 extern const struct rank BASE_CONVERSION_BADNESS;
1461 /* Badness of converting from non-reference to reference.  */
1462 extern const struct rank REFERENCE_CONVERSION_BADNESS;
1463
1464 /* Non-standard conversions allowed by the debugger */
1465 /* Converting a pointer to an int is usually OK.  */
1466 extern const struct rank NS_POINTER_CONVERSION_BADNESS;
1467
1468
1469 extern struct rank sum_ranks (struct rank a, struct rank b);
1470 extern int compare_ranks (struct rank a, struct rank b);
1471
1472 extern int compare_badness (struct badness_vector *, struct badness_vector *);
1473
1474 extern struct badness_vector *rank_function (struct type **, int,
1475                                              struct type **, int);
1476
1477 extern struct rank rank_one_type (struct type *, struct type *);
1478
1479 extern void recursive_dump_type (struct type *, int);
1480
1481 extern int field_is_static (struct field *);
1482
1483 /* printcmd.c */
1484
1485 extern void print_scalar_formatted (const void *, struct type *,
1486                                     const struct value_print_options *,
1487                                     int, struct ui_file *);
1488
1489 extern int can_dereference (struct type *);
1490
1491 extern int is_integral_type (struct type *);
1492
1493 extern int is_scalar_type_recursive (struct type *);
1494
1495 extern void maintenance_print_type (char *, int);
1496
1497 extern htab_t create_copied_types_hash (struct objfile *objfile);
1498
1499 extern struct type *copy_type_recursive (struct objfile *objfile,
1500                                          struct type *type,
1501                                          htab_t copied_types);
1502
1503 extern struct type *copy_type (const struct type *type);
1504
1505 #endif /* GDBTYPES_H */