nsz Git - cparser/blob - type.h

   1 /*
   2  * This file is part of cparser.
   3  * Copyright (C) 2007-2008 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_CHAR,
  38         ATOMIC_TYPE_SCHAR,
  39         ATOMIC_TYPE_UCHAR,
  40         ATOMIC_TYPE_SHORT,
  41         ATOMIC_TYPE_USHORT,
  42         ATOMIC_TYPE_INT,
  43         ATOMIC_TYPE_UINT,
  44         ATOMIC_TYPE_LONG,
  45         ATOMIC_TYPE_ULONG,
  46         ATOMIC_TYPE_LONGLONG,
  47         ATOMIC_TYPE_ULONGLONG,
  48         ATOMIC_TYPE_FLOAT,
  49         ATOMIC_TYPE_DOUBLE,
  50         ATOMIC_TYPE_LONG_DOUBLE,
  51         ATOMIC_TYPE_BOOL,
  52
  53         ATOMIC_TYPE_LAST = ATOMIC_TYPE_BOOL
  54 } atomic_type_kind_t;
  55
  56 typedef enum atomic_type_flag_t {
  57         ATOMIC_TYPE_FLAG_NONE       = 0,
  58         ATOMIC_TYPE_FLAG_SIGNED     = 1 << 0,
  59         ATOMIC_TYPE_FLAG_INTEGER    = 1 << 1,
  60         ATOMIC_TYPE_FLAG_FLOAT      = 1 << 2,
  61         ATOMIC_TYPE_FLAG_ARITHMETIC = 1 << 3,
  62         ATOMIC_TYPE_FLAG_COMPLEX    = 1 << 4,
  63 } atomic_type_flag_t;
  64
  65 typedef enum type_qualifier_t {
  66         TYPE_QUALIFIER_NONE     = 0,
  67         TYPE_QUALIFIER_CONST    = 1 << 0,
  68         TYPE_QUALIFIER_RESTRICT = 1 << 1,
  69         TYPE_QUALIFIER_VOLATILE = 1 << 2,
  70         /* microsoft extended qualifiers */
  71         TYPE_QUALIFIER_W64      = 1 << 3,
  72         TYPE_QUALIFIER_PTR32    = 1 << 4,
  73         TYPE_QUALIFIER_PTR64    = 1 << 5,
  74         TYPE_QUALIFIER_SPTR     = 1 << 6,
  75         TYPE_QUALIFIER_UPTR     = 1 << 7,
  76 } type_qualifier_t;
  77 typedef unsigned short type_qualifiers_t;
  78
  79 typedef struct type_base_t           type_base_t;
  80 typedef struct atomic_type_t         atomic_type_t;
  81 typedef struct complex_type_t        complex_type_t;
  82 typedef struct imaginary_type_t      imaginary_type_t;
  83 typedef struct pointer_type_t        pointer_type_t;
  84 typedef struct reference_type_t      reference_type_t;
  85 typedef struct function_parameter_t  function_parameter_t;
  86 typedef struct function_type_t       function_type_t;
  87 typedef struct compound_type_t       compound_type_t;
  88 typedef struct enum_type_t           enum_type_t;
  89 typedef struct builtin_type_t        builtin_type_t;
  90 typedef struct array_type_t          array_type_t;
  91 typedef struct typedef_type_t        typedef_type_t;
  92 typedef struct bitfield_type_t       bitfield_type_t;
  93 typedef struct typeof_type_t         typeof_type_t;
  94 typedef union  type_t                type_t;
  95
  96 void init_types(void);
  97 void exit_types(void);
  98
  99 void print_type(const type_t *type);
 100
 101 /**
 102  * prints a human readable form of @p type. prints an abstract typename
 103  * if symbol is NULL
 104  */
 105 void print_type_ext(const type_t *type, const symbol_t *symbol,
 106                     const scope_t *parameters);
 107
 108 void print_type_qualifiers(type_qualifiers_t qualifiers);
 109
 110 void print_enum_definition(const enum_t *enume);
 111 void print_compound_definition(const compound_t *compound);
 112
 113 /**
 114  * set output stream for the type printer
 115  */
 116 void type_set_output(FILE *out);
 117
 118 void inc_type_visited(void);
 119
 120 /**
 121  * returns true if type contains integer numbers
 122  */
 123 bool is_type_integer(const type_t *type);
 124
 125 /**
 126  * Returns true if the given type is an enum type.
 127  */
 128 bool is_type_enum(const type_t *type);
 129
 130 /**
 131  * return true if type contains signed numbers
 132  */
 133 bool is_type_signed(const type_t *type);
 134
 135 /**
 136  * returns true if type contains floating point numbers
 137  */
 138 bool is_type_float(const type_t *type);
 139
 140 /**
 141  * returns true if type contains complex numbers
 142  */
 143 bool is_type_complex(const type_t *type);
 144
 145 bool is_type_real(const type_t *type);
 146
 147 /**
 148  * returns true if the type is valid. A type is valid if it contains no
 149  * unresolved references anymore and is not of TYPE_INVALID.
 150  */
 151 bool type_valid(const type_t *type);
 152
 153 /**
 154  * returns true if the type is an arithmetic type (§6.2.5 clause 18)
 155  */
 156 bool is_type_arithmetic(const type_t *type);
 157
 158 /**
 159  * returns true if the type is a scalar type (§6.2.5 clause 21)
 160  */
 161 bool is_type_scalar(const type_t *type);
 162
 163 bool is_type_incomplete(const type_t *type);
 164
 165 bool is_type_object(const type_t *type);
 166
 167 bool types_compatible(const type_t *type1, const type_t *type2);
 168
 169 type_t *get_unqualified_type(type_t *type);
 170 type_t *get_qualified_type(type_t*, type_qualifiers_t);
 171 type_t *skip_typeref(type_t *type);
 172
 173 /**
 174  * Return the type qualifier set of a type. If skip_array_type
 175  * is true, skip all array types.
 176  */
 177 type_qualifiers_t get_type_qualifier(const type_t *type, bool skip_array_type);
 178
 179 /**
 180  * returns size of an atomic type kind in bytes
 181  */
 182 unsigned get_atomic_type_size(atomic_type_kind_t kind);
 183
 184 /**
 185  * returns alignment of an atomic type kind in bytes
 186  */
 187 unsigned get_atomic_type_alignment(atomic_type_kind_t kind);
 188
 189 /**
 190  * returns flags of an atomic type kind
 191  */
 192 unsigned get_atomic_type_flags(atomic_type_kind_t kind);
 193
 194 atomic_type_kind_t get_intptr_kind(void);
 195 atomic_type_kind_t get_uintptr_kind(void);
 196
 197 /**
 198  * Find the atomic type kind representing a given size (signed).
 199  */
 200 atomic_type_kind_t find_signed_int_atomic_type_kind_for_size(unsigned size);
 201
 202 /**
 203  * Find the atomic type kind representing a given size (unsigned).
 204  */
 205 atomic_type_kind_t find_unsigned_int_atomic_type_kind_for_size(unsigned size);
 206
 207 const char *get_atomic_kind_name(atomic_type_kind_t kind);
 208
 209 #endif