do correct semantic check for pointer arithmetic, support gcc void* arithmetic extension
[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 /* note that the constant values represent the rank of the types as defined
29  * in ยง 6.3.1 */
30 typedef enum {
31         ATOMIC_TYPE_INVALID = 0,
32         ATOMIC_TYPE_VOID,
33         ATOMIC_TYPE_CHAR,
34         ATOMIC_TYPE_SCHAR,
35         ATOMIC_TYPE_UCHAR,
36         ATOMIC_TYPE_SHORT,
37         ATOMIC_TYPE_USHORT,
38         ATOMIC_TYPE_INT,
39         ATOMIC_TYPE_UINT,
40         ATOMIC_TYPE_LONG,
41         ATOMIC_TYPE_ULONG,
42         ATOMIC_TYPE_LONGLONG,
43         ATOMIC_TYPE_ULONGLONG,
44         ATOMIC_TYPE_FLOAT,
45         ATOMIC_TYPE_DOUBLE,
46         ATOMIC_TYPE_LONG_DOUBLE,
47         ATOMIC_TYPE_BOOL,
48
49         ATOMIC_TYPE_LAST = ATOMIC_TYPE_BOOL
50 } atomic_type_kind_t;
51
52 typedef enum {
53         ATOMIC_TYPE_FLAG_NONE       = 0,
54         ATOMIC_TYPE_FLAG_SIGNED     = 1 << 0,
55         ATOMIC_TYPE_FLAG_INTEGER    = 1 << 1,
56         ATOMIC_TYPE_FLAG_FLOAT      = 1 << 2,
57         ATOMIC_TYPE_FLAG_ARITHMETIC = 1 << 3,
58         ATOMIC_TYPE_FLAG_COMPLEX    = 1 << 4,
59 } atomic_type_flag_t;
60
61 typedef struct type_base_t           type_base_t;
62 typedef struct atomic_type_t         atomic_type_t;
63 typedef struct complex_type_t        complex_type_t;
64 typedef struct imaginary_type_t      imaginary_type_t;
65 typedef struct pointer_type_t        pointer_type_t;
66 typedef struct function_parameter_t  function_parameter_t;
67 typedef struct function_type_t       function_type_t;
68 typedef struct compound_type_t       compound_type_t;
69 typedef struct enum_type_t           enum_type_t;
70 typedef struct builtin_type_t        builtin_type_t;
71 typedef struct array_type_t          array_type_t;
72 typedef struct typedef_type_t        typedef_type_t;
73 typedef struct bitfield_type_t       bitfield_type_t;
74 typedef struct typeof_type_t         typeof_type_t;
75 typedef union  type_t                type_t;
76
77 void init_types(void);
78 void exit_types(void);
79
80 void print_type(const type_t *type);
81
82 /**
83  * prints a human readable form of @p type. prints an abstract typename
84  * if symbol is NULL
85  */
86 void print_type_ext(const type_t *type, const symbol_t *symbol,
87                     const scope_t *scope);
88
89 void print_type_qualifiers(unsigned qualifiers);
90
91 void print_enum_definition(const declaration_t *declaration);
92 void print_compound_definition(const declaration_t *declaration);
93
94 /**
95  * set output stream for the type printer
96  */
97 void type_set_output(FILE *out);
98
99 void inc_type_visited(void);
100
101 /**
102  * returns true if type contains integer numbers
103  */
104 bool is_type_integer(const type_t *type);
105
106 /**
107  * return true if type contains signed numbers
108  */
109 bool is_type_signed(const type_t *type);
110
111 /**
112  * returns true if type contains floating point numbers
113  */
114 bool is_type_float(const type_t *type);
115
116 bool is_type_real(const type_t *type);
117
118 /**
119  * returns true if the type is valid. A type is valid if it contains no
120  * unresolved references anymore and is not of TYPE_INVALID.
121  */
122 bool type_valid(const type_t *type);
123
124 /**
125  * returns true if the type is an arithmetic type (6.2.18)
126  */
127 bool is_type_arithmetic(const type_t *type);
128
129 /**
130  * returns true if the type is a scalar type (6.2.21)
131  */
132 bool is_type_scalar(const type_t *type);
133
134 bool is_type_incomplete(const type_t *type);
135
136 bool is_type_object(const type_t *type);
137
138 bool types_compatible(const type_t *type1, const type_t *type2);
139
140 bool pointers_compatible(const type_t *type1, const type_t *type2);
141
142 type_t *get_unqualified_type(type_t *type);
143 type_t *skip_typeref(type_t *type);
144
145 /**
146  * returns size of an atomic type kind in bytes
147  */
148 unsigned get_atomic_type_size(atomic_type_kind_t kind);
149
150 /**
151  * returns alignment of an atomic type kind in bytes
152  */
153 unsigned get_atomic_type_alignment(atomic_type_kind_t kind);
154
155 /**
156  * returns flags of an atomic type kind
157  */
158 unsigned get_atomic_type_flags(atomic_type_kind_t kind);
159
160 atomic_type_kind_t get_intptr_kind(void);
161 atomic_type_kind_t get_uintptr_kind(void);
162
163 /**
164  * Find the atomic type kind representing a given size (signed).
165  */
166 atomic_type_kind_t find_signed_int_atomic_type_kind_for_size(unsigned size);
167
168 /**
169  * Find the atomic type kind representing a given size (unsigned).
170  */
171 atomic_type_kind_t find_unsigned_int_atomic_type_kind_for_size(unsigned size);
172
173 #endif