1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
.. Copyright (C) 2014-2016 Free Software Foundation, Inc.
Originally contributed by David Malcolm <dmalcolm@redhat.com>
This is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see
<http://www.gnu.org/licenses/>.
.. default-domain:: c
Types
=====
.. c:type:: gcc_jit_type
gcc_jit_type represents a type within the library.
.. function:: gcc_jit_object *gcc_jit_type_as_object (gcc_jit_type *type)
Upcast a type to an object.
Types can be created in several ways:
* fundamental types can be accessed using
:func:`gcc_jit_context_get_type`:
.. code-block:: c
gcc_jit_type *int_type = gcc_jit_context_get_type (GCC_JIT_TYPE_INT);
See :func:`gcc_jit_context_get_type` for the available types.
* derived types can be accessed by using functions such as
:func:`gcc_jit_type_get_pointer` and :func:`gcc_jit_type_get_const`:
.. code-block:: c
gcc_jit_type *const_int_star = gcc_jit_type_get_pointer (gcc_jit_type_get_const (int_type));
gcc_jit_type *int_const_star = gcc_jit_type_get_const (gcc_jit_type_get_pointer (int_type));
* by creating structures (see below).
Standard types
--------------
.. function:: gcc_jit_type *gcc_jit_context_get_type (gcc_jit_context *ctxt, \
enum gcc_jit_types type_)
Access a specific type. The available types are:
========================================== ================================
`enum gcc_jit_types` value Meaning
========================================== ================================
:c:data:`GCC_JIT_TYPE_VOID` C's ``void`` type.
:c:data:`GCC_JIT_TYPE_VOID_PTR` C's ``void *``.
:c:data:`GCC_JIT_TYPE_BOOL` C++'s ``bool`` type; also C99's
``_Bool`` type, aka ``bool`` if
using stdbool.h.
:c:data:`GCC_JIT_TYPE_CHAR` C's ``char`` (of some signedness)
:c:data:`GCC_JIT_TYPE_SIGNED_CHAR` C's ``signed char``
:c:data:`GCC_JIT_TYPE_UNSIGNED_CHAR` C's ``unsigned char``
:c:data:`GCC_JIT_TYPE_SHORT` C's ``short`` (signed)
:c:data:`GCC_JIT_TYPE_UNSIGNED_SHORT` C's ``unsigned short``
:c:data:`GCC_JIT_TYPE_INT` C's ``int`` (signed)
:c:data:`GCC_JIT_TYPE_UNSIGNED_INT` C's ``unsigned int``
:c:data:`GCC_JIT_TYPE_LONG` C's ``long`` (signed)
:c:data:`GCC_JIT_TYPE_UNSIGNED_LONG` C's ``unsigned long``
:c:data:`GCC_JIT_TYPE_LONG_LONG` C99's ``long long`` (signed)
:c:data:`GCC_JIT_TYPE_UNSIGNED_LONG_LONG` C99's ``unsigned long long``
:c:data:`GCC_JIT_TYPE_FLOAT`
:c:data:`GCC_JIT_TYPE_DOUBLE`
:c:data:`GCC_JIT_TYPE_LONG_DOUBLE`
:c:data:`GCC_JIT_TYPE_CONST_CHAR_PTR` C type: ``(const char *)``
:c:data:`GCC_JIT_TYPE_SIZE_T` C's ``size_t`` type
:c:data:`GCC_JIT_TYPE_FILE_PTR` C type: ``(FILE *)``
:c:data:`GCC_JIT_TYPE_COMPLEX_FLOAT` C99's ``_Complex float``
:c:data:`GCC_JIT_TYPE_COMPLEX_DOUBLE` C99's ``_Complex double``
:c:data:`GCC_JIT_TYPE_COMPLEX_LONG_DOUBLE` C99's ``_Complex long double``
========================================== ================================
.. function:: gcc_jit_type *\
gcc_jit_context_get_int_type (gcc_jit_context *ctxt, \
int num_bytes, int is_signed)
Access the integer type of the given size.
Pointers, `const`, and `volatile`
---------------------------------
.. function:: gcc_jit_type *gcc_jit_type_get_pointer (gcc_jit_type *type)
Given type "T", get type "T*".
.. function:: gcc_jit_type *gcc_jit_type_get_const (gcc_jit_type *type)
Given type "T", get type "const T".
.. function:: gcc_jit_type *gcc_jit_type_get_volatile (gcc_jit_type *type)
Given type "T", get type "volatile T".
.. function:: gcc_jit_type *\
gcc_jit_context_new_array_type (gcc_jit_context *ctxt, \
gcc_jit_location *loc, \
gcc_jit_type *element_type, \
int num_elements)
Given type "T", get type "T[N]" (for a constant N).
Structures and unions
---------------------
.. c:type:: gcc_jit_struct
A compound type analagous to a C `struct`.
.. c:type:: gcc_jit_field
A field within a :c:type:`gcc_jit_struct`.
You can model C `struct` types by creating :c:type:`gcc_jit_struct *` and
:c:type:`gcc_jit_field` instances, in either order:
* by creating the fields, then the structure. For example, to model:
.. code-block:: c
struct coord {double x; double y; };
you could call:
.. code-block:: c
gcc_jit_field *field_x =
gcc_jit_context_new_field (ctxt, NULL, double_type, "x");
gcc_jit_field *field_y =
gcc_jit_context_new_field (ctxt, NULL, double_type, "y");
gcc_jit_field *fields[2] = {field_x, field_y};
gcc_jit_struct *coord =
gcc_jit_context_new_struct_type (ctxt, NULL, "coord", 2, fields);
* by creating the structure, then populating it with fields, typically
to allow modelling self-referential structs such as:
.. code-block:: c
struct node { int m_hash; struct node *m_next; };
like this:
.. code-block:: c
gcc_jit_type *node =
gcc_jit_context_new_opaque_struct (ctxt, NULL, "node");
gcc_jit_type *node_ptr =
gcc_jit_type_get_pointer (node);
gcc_jit_field *field_hash =
gcc_jit_context_new_field (ctxt, NULL, int_type, "m_hash");
gcc_jit_field *field_next =
gcc_jit_context_new_field (ctxt, NULL, node_ptr, "m_next");
gcc_jit_field *fields[2] = {field_hash, field_next};
gcc_jit_struct_set_fields (node, NULL, 2, fields);
.. function:: gcc_jit_field *\
gcc_jit_context_new_field (gcc_jit_context *ctxt,\
gcc_jit_location *loc,\
gcc_jit_type *type,\
const char *name)
Construct a new field, with the given type and name.
The parameter ``name`` must be non-NULL. The call takes a copy of the
underlying string, so it is valid to pass in a pointer to an on-stack
buffer.
.. function:: gcc_jit_object *\
gcc_jit_field_as_object (gcc_jit_field *field)
Upcast from field to object.
.. function:: gcc_jit_struct *\
gcc_jit_context_new_struct_type (gcc_jit_context *ctxt,\
gcc_jit_location *loc,\
const char *name,\
int num_fields,\
gcc_jit_field **fields)
Construct a new struct type, with the given name and fields.
The parameter ``name`` must be non-NULL. The call takes a copy of
the underlying string, so it is valid to pass in a pointer to an
on-stack buffer.
.. function:: gcc_jit_struct *\
gcc_jit_context_new_opaque_struct (gcc_jit_context *ctxt,\
gcc_jit_location *loc,\
const char *name)
Construct a new struct type, with the given name, but without
specifying the fields. The fields can be omitted (in which case the
size of the struct is not known), or later specified using
:c:func:`gcc_jit_struct_set_fields`.
The parameter ``name`` must be non-NULL. The call takes a copy of
the underlying string, so it is valid to pass in a pointer to an
on-stack buffer.
.. function:: gcc_jit_type *\
gcc_jit_struct_as_type (gcc_jit_struct *struct_type)
Upcast from struct to type.
.. function:: void\
gcc_jit_struct_set_fields (gcc_jit_struct *struct_type,\
gcc_jit_location *loc,\
int num_fields,\
gcc_jit_field **fields)
Populate the fields of a formerly-opaque struct type.
This can only be called once on a given struct type.
.. function:: gcc_jit_type *\
gcc_jit_context_new_union_type (gcc_jit_context *ctxt,\
gcc_jit_location *loc,\
const char *name,\
int num_fields,\
gcc_jit_field **fields)
Construct a new union type, with the given name and fields.
The parameter ``name`` must be non-NULL. It is copied, so the input
buffer does not need to outlive the call.
Example of use:
.. literalinclude:: ../../../testsuite/jit.dg/test-accessing-union.c
:start-after: /* Quote from here in docs/topics/types.rst. */
:end-before: /* Quote up to here in docs/topics/types.rst. */
:language: c
|
