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_WCHAR_T,
  38         ATOMIC_TYPE_CHAR,
  39         ATOMIC_TYPE_SCHAR,
  40         ATOMIC_TYPE_UCHAR,
  41         ATOMIC_TYPE_SHORT,
  42         ATOMIC_TYPE_USHORT,
  43         ATOMIC_TYPE_INT,
  44         ATOMIC_TYPE_UINT,
  45         ATOMIC_TYPE_LONG,
  46         ATOMIC_TYPE_ULONG,
  47         ATOMIC_TYPE_LONGLONG,
  48         ATOMIC_TYPE_ULONGLONG,
  49         ATOMIC_TYPE_FLOAT,
  50         ATOMIC_TYPE_DOUBLE,
  51         ATOMIC_TYPE_LONG_DOUBLE,
  52         ATOMIC_TYPE_BOOL,
  53
  54         ATOMIC_TYPE_LAST = ATOMIC_TYPE_BOOL
  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 void print_type(const type_t *type);
 108
 109 /**
 110  * prints a human readable form of @p type. prints an abstract typename
 111  * if symbol is NULL
 112  */
 113 void print_type_ext(const type_t *type, const symbol_t *symbol,
 114                     const scope_t *parameters);
 115
 116 typedef enum QualifierSeparators {
 117         QUAL_SEP_NONE  = 0,
 118         QUAL_SEP_START = 1U << 0,
 119         QUAL_SEP_END   = 1U << 1
 120 } QualifierSeparators;
 121
 122 void print_type_qualifiers(type_qualifiers_t qualifiers, QualifierSeparators);
 123
 124 void print_enum_definition(const enum_t *enume);
 125 void print_compound_definition(const compound_t *compound);
 126
 127 void inc_type_visited(void);
 128
 129 /**
 130  * returns true if type contains integer numbers
 131  */
 132 bool is_type_integer(const type_t *type);
 133
 134 /**
 135  * Returns true if the given type is an enum type.
 136  */
 137 bool is_type_enum(const type_t *type);
 138
 139 /**
 140  * return true if type contains signed numbers
 141  */
 142 bool is_type_signed(const type_t *type);
 143
 144 /**
 145  * returns true if type contains floating point numbers
 146  */
 147 bool is_type_float(const type_t *type);
 148
 149 /**
 150  * returns true if type contains complex numbers
 151  */
 152 bool is_type_complex(const type_t *type);
 153
 154 bool is_type_real(const type_t *type);
 155
 156 /**
 157  * returns true if the type is valid. A type is valid if it contains no
 158  * unresolved references anymore and is not of TYPE_INVALID.
 159  */
 160 bool type_valid(const type_t *type);
 161
 162 /**
 163  * returns true if the type is an arithmetic type (§6.2.5 clause 18)
 164  */
 165 bool is_type_arithmetic(const type_t *type);
 166
 167 /**
 168  * returns true if the type is a scalar type (§6.2.5 clause 21)
 169  */
 170 bool is_type_scalar(const type_t *type);
 171
 172 bool is_type_incomplete(const type_t *type);
 173
 174 bool is_type_object(const type_t *type);
 175
 176 bool types_compatible(const type_t *type1, const type_t *type2);
 177
 178 type_t *get_unqualified_type(type_t *type);
 179 type_t *get_qualified_type(type_t*, type_qualifiers_t);
 180 type_t *skip_typeref(type_t *type);
 181
 182 /**
 183  * Return the type qualifier set of a type. If skip_array_type
 184  * is true, skip all array types.
 185  */
 186 type_qualifiers_t get_type_qualifier(const type_t *type, bool skip_array_type);
 187
 188 /**
 189  * returns size of an atomic type kind in bytes
 190  */
 191 unsigned get_atomic_type_size(atomic_type_kind_t kind);
 192
 193 /**
 194  * returns alignment of an atomic type kind in bytes
 195  */
 196 unsigned get_atomic_type_alignment(atomic_type_kind_t kind);
 197
 198 unsigned         get_type_alignment(type_t *type);
 199 unsigned         get_type_size(type_t *type);
 200 decl_modifiers_t get_type_modifiers(const type_t *type);
 201
 202 /**
 203  * get alignment of a type when used inside a compound.
 204  * Some ABIs are broken and alignment inside a compound is different from
 205  * recommended alignment of a type
 206  */
 207 unsigned         get_type_alignment_compound(type_t *type);
 208
 209 /**
 210  * returns flags of an atomic type kind
 211  */
 212 unsigned get_atomic_type_flags(atomic_type_kind_t kind);
 213
 214 /**
 215  * Find the atomic type kind representing a given size (signed).
 216  */
 217 atomic_type_kind_t find_signed_int_atomic_type_kind_for_size(unsigned size);
 218
 219 /**
 220  * Find the atomic type kind representing a given size (unsigned).
 221  */
 222 atomic_type_kind_t find_unsigned_int_atomic_type_kind_for_size(unsigned size);
 223
 224 const char *get_atomic_kind_name(atomic_type_kind_t kind);
 225
 226 /**
 227  * Finish the construction of a struct type by calculating its size, offsets,
 228  * alignment.
 229  */
 230 void layout_struct_type(compound_type_t *type);
 231
 232 /**
 233  * Finish the construction of an union type by calculating
 234  * its size and alignment.
 235  */
 236 void layout_union_type(compound_type_t *type);
 237
 238 #endif