nsz Git - cparser/blob - type.h

   1 /*
   2  * This file is part of cparser.
   3  * Copyright (C) 2007-2009 Matthias Braun <matze@braunis.de>
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  18  * 02111-1307, USA.
  19  */
  20 #ifndef TYPE_H
  21 #define TYPE_H
  22
  23 #include <stdio.h>
  24 #include <stdbool.h>
  25 #include "ast.h"
  26 #include "symbol.h"
  27
  28 /** Type used to express sizes. */
  29 typedef unsigned long il_size_t;
  30 typedef unsigned char il_alignment_t;
  31
  32 /* note that the constant values represent the rank of the types as defined
  33  * in § 6.3.1 */
  34 typedef enum atomic_type_kind_t {
  35         ATOMIC_TYPE_INVALID = 0,
  36         ATOMIC_TYPE_VOID,
  37         ATOMIC_TYPE_BOOL,
  38         ATOMIC_TYPE_WCHAR_T,
  39         ATOMIC_TYPE_CHAR,
  40         ATOMIC_TYPE_SCHAR,
  41         ATOMIC_TYPE_UCHAR,
  42         ATOMIC_TYPE_SHORT,
  43         ATOMIC_TYPE_USHORT,
  44         ATOMIC_TYPE_INT,
  45         ATOMIC_TYPE_UINT,
  46         ATOMIC_TYPE_LONG,
  47         ATOMIC_TYPE_ULONG,
  48         ATOMIC_TYPE_LONGLONG,
  49         ATOMIC_TYPE_ULONGLONG,
  50         ATOMIC_TYPE_FLOAT,
  51         ATOMIC_TYPE_DOUBLE,
  52         ATOMIC_TYPE_LONG_DOUBLE,
  53
  54         ATOMIC_TYPE_LAST = ATOMIC_TYPE_LONG_DOUBLE
  55 } atomic_type_kind_t;
  56
  57 typedef enum atomic_type_flag_t {
  58         ATOMIC_TYPE_FLAG_NONE       = 0,
  59         ATOMIC_TYPE_FLAG_SIGNED     = 1 << 0,
  60         ATOMIC_TYPE_FLAG_INTEGER    = 1 << 1,
  61         ATOMIC_TYPE_FLAG_FLOAT      = 1 << 2,
  62         ATOMIC_TYPE_FLAG_ARITHMETIC = 1 << 3,
  63         ATOMIC_TYPE_FLAG_COMPLEX    = 1 << 4,
  64 } atomic_type_flag_t;
  65
  66 typedef enum type_qualifier_t {
  67         TYPE_QUALIFIER_NONE     = 0,
  68         TYPE_QUALIFIER_CONST    = 1 << 0,
  69         TYPE_QUALIFIER_RESTRICT = 1 << 1,
  70         TYPE_QUALIFIER_VOLATILE = 1 << 2,
  71         /* microsoft extended qualifiers */
  72         TYPE_QUALIFIER_W64      = 1 << 3,
  73         TYPE_QUALIFIER_PTR32    = 1 << 4,
  74         TYPE_QUALIFIER_PTR64    = 1 << 5,
  75         TYPE_QUALIFIER_SPTR     = 1 << 6,
  76         TYPE_QUALIFIER_UPTR     = 1 << 7,
  77 } type_qualifier_t;
  78 typedef unsigned short type_qualifiers_t;
  79
  80 typedef struct type_base_t           type_base_t;
  81 typedef struct atomic_type_t         atomic_type_t;
  82 typedef struct complex_type_t        complex_type_t;
  83 typedef struct imaginary_type_t      imaginary_type_t;
  84 typedef struct pointer_type_t        pointer_type_t;
  85 typedef struct reference_type_t      reference_type_t;
  86 typedef struct function_parameter_t  function_parameter_t;
  87 typedef struct function_type_t       function_type_t;
  88 typedef struct compound_type_t       compound_type_t;
  89 typedef struct enum_type_t           enum_type_t;
  90 typedef struct builtin_type_t        builtin_type_t;
  91 typedef struct array_type_t          array_type_t;
  92 typedef struct typedef_type_t        typedef_type_t;
  93 typedef struct bitfield_type_t       bitfield_type_t;
  94 typedef struct typeof_type_t         typeof_type_t;
  95 typedef union  type_t                type_t;
  96
  97 /**
  98  * Initializes the type system. Attempts to set some defaults on the atomic
  99  * types based on a given machine size.
 100  * These type properties are not final but you should adapt them to your system
 101  * as your architecture and operating systems application binary interface (ABI)
 102  * requires.
 103  */
 104 void init_types(unsigned machine_size);
 105 void exit_types(void);
 106
 107 /**
 108  * Prints a type.
 109  *
 110  * @param type   The type.
 111  */
 112 void print_type(const type_t *type);
 113
 114 /**
 115  * prints a human readable form of @p type. prints an abstract typename
 116  * if symbol is NULL
 117  */
 118 void print_type_ext(const type_t *type, const symbol_t *symbol,
 119                     const scope_t *parameters);
 120
 121 typedef enum QualifierSeparators {
 122         QUAL_SEP_NONE  = 0,
 123         QUAL_SEP_START = 1U << 0,
 124         QUAL_SEP_END   = 1U << 1
 125 } QualifierSeparators;
 126
 127 void print_type_qualifiers(type_qualifiers_t qualifiers, QualifierSeparators);
 128
 129 /**
 130  * Prints an enum definition.
 131  *
 132  * @param declaration  The enum's type declaration.
 133  */
 134 void print_enum_definition(const enum_t *enume);
 135
 136 /**
 137  * Print the compound part of a compound type.
 138  */
 139 void print_compound_definition(const compound_t *compound);
 140
 141 void inc_type_visited(void);
 142
 143 /**
 144  * Returns true if the given type is an integer type.
 145  *
 146  * @param type  The type to check.
 147  * @return True if type is an integer type.
 148  */
 149 bool is_type_integer(const type_t *type);
 150
 151 /**
 152  * Returns true if the given type is an enum type.
 153  *
 154  * @param type  The type to check.
 155  * @return True if type is an enum type.
 156  */
 157 bool is_type_enum(const type_t *type);
 158
 159 /**
 160  * Returns true if the given type is a signed type.
 161  *
 162  * @param type  The type to check.
 163  * @return True if type is a signed type.
 164  */
 165 bool is_type_signed(const type_t *type);
 166
 167 /**
 168  * Returns true if the given type is a floating point type.
 169  *
 170  * @param type  The type to check.
 171  * @return True if type is a floating point type.
 172  */
 173 bool is_type_float(const type_t *type);
 174
 175 /**
 176  * Returns true if the given type is a complex type.
 177  *
 178  * @param type  The type to check.
 179  * @return True if type is a complex type.
 180  */
 181 bool is_type_complex(const type_t *type);
 182
 183 /**
 184  * Returns true if the given type is an integer or float type.
 185  *
 186  * @param type  The type to check.
 187  * @return True if type is an integer or float type.
 188  */
 189 bool is_type_real(const type_t *type);
 190
 191 /**
 192  * Returns true if the type is an arithmetic type (§6.2.5 clause 18)
 193  *
 194  * @param type  The type to check.
 195  * @return True if type represents an arithmetic type.
 196  */
 197 bool is_type_arithmetic(const type_t *type);
 198
 199 /**
 200  * Returns true if the type is a scalar type (§6.2.5 clause 21)
 201  *
 202  * @param type  The type to check.
 203  * @return True if type represents a scalar type.
 204  */
 205 bool is_type_scalar(const type_t *type);
 206
 207 /**
 208  * Check if a given type is incomplete.
 209  *
 210  * @param type  The type to check.
 211  * @return True if the given type is incomplete (ie. just forward).
 212  */
 213 bool is_type_incomplete(const type_t *type);
 214
 215 bool is_type_object(const type_t *type);
 216
 217 /**
 218  * Check if two types are compatible.
 219  */
 220 bool types_compatible(const type_t *type1, const type_t *type2);
 221
 222 /**
 223  * Returns the unqualified type of a given type.
 224  *
 225  * @param type  The type.
 226  * @returns The unqualified type.
 227  */
 228 type_t *get_unqualified_type(type_t *type);
 229
 230 type_t *get_qualified_type(type_t*, type_qualifiers_t);
 231 type_t *skip_typeref(type_t *type);
 232
 233 /**
 234  * Return the type qualifier set of a type. If skip_array_type
 235  * is true, skip all array types.
 236  */
 237 type_qualifiers_t get_type_qualifier(const type_t *type, bool skip_array_type);
 238
 239 /**
 240  * returns size of an atomic type kind in bytes
 241  */
 242 unsigned get_atomic_type_size(atomic_type_kind_t kind);
 243
 244 /**
 245  * returns alignment of an atomic type kind in bytes
 246  */
 247 unsigned get_atomic_type_alignment(atomic_type_kind_t kind);
 248
 249 unsigned         get_type_alignment(type_t *type);
 250 unsigned         get_type_size(type_t *type);
 251 decl_modifiers_t get_type_modifiers(const type_t *type);
 252
 253 /**
 254  * returns flags of an atomic type kind
 255  */
 256 unsigned get_atomic_type_flags(atomic_type_kind_t kind);
 257
 258 /**
 259  * Find the atomic type kind representing a given size (signed).
 260  */
 261 atomic_type_kind_t find_signed_int_atomic_type_kind_for_size(unsigned size);
 262
 263 /**
 264  * Find the atomic type kind representing a given size (unsigned).
 265  */
 266 atomic_type_kind_t find_unsigned_int_atomic_type_kind_for_size(unsigned size);
 267
 268 const char *get_atomic_kind_name(atomic_type_kind_t kind);
 269
 270 /**
 271  * Finish the construction of a struct type by calculating its size, offsets,
 272  * alignment.
 273  */
 274 void layout_struct_type(compound_type_t *type);
 275
 276 /**
 277  * Finish the construction of an union type by calculating
 278  * its size and alignment.
 279  */
 280 void layout_union_type(compound_type_t *type);
 281
 282 #endif