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