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 void init_types(void);
  98 void exit_types(void);
  99
 100 void print_type(const type_t *type);
 101
 102 /**
 103  * prints a human readable form of @p type. prints an abstract typename
 104  * if symbol is NULL
 105  */
 106 void print_type_ext(const type_t *type, const symbol_t *symbol,
 107                     const scope_t *parameters);
 108
 109 void print_type_qualifiers(type_qualifiers_t qualifiers);
 110
 111 void print_enum_definition(const enum_t *enume);
 112 void print_compound_definition(const compound_t *compound);
 113
 114 /**
 115  * set output stream for the type printer
 116  */
 117 void type_set_output(FILE *out);
 118
 119 void inc_type_visited(void);
 120
 121 /**
 122  * returns true if type contains integer numbers
 123  */
 124 bool is_type_integer(const type_t *type);
 125
 126 /**
 127  * Returns true if the given type is an enum type.
 128  */
 129 bool is_type_enum(const type_t *type);
 130
 131 /**
 132  * return true if type contains signed numbers
 133  */
 134 bool is_type_signed(const type_t *type);
 135
 136 /**
 137  * returns true if type contains floating point numbers
 138  */
 139 bool is_type_float(const type_t *type);
 140
 141 /**
 142  * returns true if type contains complex numbers
 143  */
 144 bool is_type_complex(const type_t *type);
 145
 146 bool is_type_real(const type_t *type);
 147
 148 /**
 149  * returns true if the type is valid. A type is valid if it contains no
 150  * unresolved references anymore and is not of TYPE_INVALID.
 151  */
 152 bool type_valid(const type_t *type);
 153
 154 /**
 155  * returns true if the type is an arithmetic type (§6.2.5 clause 18)
 156  */
 157 bool is_type_arithmetic(const type_t *type);
 158
 159 /**
 160  * returns true if the type is a scalar type (§6.2.5 clause 21)
 161  */
 162 bool is_type_scalar(const type_t *type);
 163
 164 bool is_type_incomplete(const type_t *type);
 165
 166 bool is_type_object(const type_t *type);
 167
 168 /**
 169  * returns true if teh type is the builtin va_list type.
 170  */
 171 bool is_builtin_va_list(type_t *type);
 172
 173 bool types_compatible(const type_t *type1, const type_t *type2);
 174
 175 type_t *get_unqualified_type(type_t *type);
 176 type_t *get_qualified_type(type_t*, type_qualifiers_t);
 177 type_t *skip_typeref(type_t *type);
 178
 179 /**
 180  * Return the type qualifier set of a type. If skip_array_type
 181  * is true, skip all array types.
 182  */
 183 type_qualifiers_t get_type_qualifier(const type_t *type, bool skip_array_type);
 184
 185 /**
 186  * returns size of an atomic type kind in bytes
 187  */
 188 unsigned get_atomic_type_size(atomic_type_kind_t kind);
 189
 190 /**
 191  * returns alignment of an atomic type kind in bytes
 192  */
 193 unsigned get_atomic_type_alignment(atomic_type_kind_t kind);
 194
 195 unsigned         get_type_alignment(type_t *type);
 196 unsigned         get_type_size(type_t *type);
 197 decl_modifiers_t get_type_modifiers(const type_t *type);
 198
 199 /**
 200  * returns flags of an atomic type kind
 201  */
 202 unsigned get_atomic_type_flags(atomic_type_kind_t kind);
 203
 204 atomic_type_kind_t get_intptr_kind(void);
 205 atomic_type_kind_t get_uintptr_kind(void);
 206
 207 /**
 208  * Find the atomic type kind representing a given size (signed).
 209  */
 210 atomic_type_kind_t find_signed_int_atomic_type_kind_for_size(unsigned size);
 211
 212 /**
 213  * Find the atomic type kind representing a given size (unsigned).
 214  */
 215 atomic_type_kind_t find_unsigned_int_atomic_type_kind_for_size(unsigned size);
 216
 217 const char *get_atomic_kind_name(atomic_type_kind_t kind);
 218
 219 void layout_struct_type(compound_type_t *type);
 220 void layout_union_type(compound_type_t *type);
 221
 222 #endif