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