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