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
|
Specifying Types
----------------
.. _typesystem:
typesystem
^^^^^^^^^^
This is the root node containing all the type system information. It can
have a number of attributes, described below.
.. code-block:: xml
<typesystem package="..." default-superclass="...">
</typesystem>
The **package** attribute is a string describing the package to be used,
e.g. "QtCore".
The *optional* **default-superclass** attribute is the canonical C++ base class
name of all objects, e.g., "object".
load-typesystem
^^^^^^^^^^^^^^^
The load-typesystem node specifies which type systems to load when mapping
multiple libraries to another language or basing one library on another, and
it is a child of the typesystem node.
.. code-block:: xml
<typesystem>
<load-typesystem name="..." generate="yes | no" />
</typesystem>
The **name** attribute is the filename of the typesystem to load, the
**generate** attribute specifies whether code should be generated or not. The
later must be specified when basing one library on another, making the generator
able to understand inheritance hierarchies, primitive mapping, parameter types
in functions, etc.
Most libraries will be based on both the QtCore and QtGui modules, in which
case code generation for these libraries will be disabled.
rejection
^^^^^^^^^
The rejection node rejects the given class, or the specified function or
field, and it is a child of the typesystem node.
.. code-block:: xml
<typesystem>
<rejection class="..."
function-name="..."
field-name="..." />
</typesystem>
The **class** attribute is the C++ class name of the class to reject. Use the
*optional* **function-name** or **field-name** attributes to reject a particular
function or field. Note that the **field-name** and **function-name** cannot
be specified at the same time. To remove all occurrences of a given field or
function, set the class attribute to \*. You can use an empty class field
to denote a global function.
primitive-type
^^^^^^^^^^^^^^
The primitive-type node describes how a primitive type is mapped from C++ to
the target language, and is a child of the typesystem node. Note that most
primitives are already specified in the QtCore typesystem.
.. code-block:: xml
<typesystem>
<primitive-type name="..."
target-name="..."
preferred-conversion="yes | no" />
</typesystem>
The **name** attribute is the name of the primitive in C++, the optimal
**target-name** attribute is the name of the primitive type in the target
language. If the later two attributes are not specified their default value
will be the same as the **name** attribute.
If the *optional* **preferred-conversion** attribute is set to *no*, it
indicates that this version of the primitive type is not the preferred C++
equivalent of the target language type. For example, in Python both "qint64"
and "long long" become "long" but we should prefer the "qint64" version. For
this reason we mark "long long" with preferred-conversion="no".
.. _namespace:
namespace-type
^^^^^^^^^^^^^^
The namespace-type node maps the given C++ namespace to the target language,
and it is a child of the typesystem node. Note that within namespaces, the
generator only supports enums (i.e., no functions or classes).
.. code-block:: xml
<typesystem>
<namespace-type name="..."
package="..." />
</typesystem>
The **name** attribute is the name of the namespace, e.g., "Qt". The **package**
attribute can be used to override the package of the type system.
enum-type
^^^^^^^^^
The enum-type node maps the given enum from C++ to the target language,
and it is a child of the typesystem node. Use the reject-enum-value to
reject values.
.. code-block:: xml
<typesystem>
<enum-type name="..."
flags="yes | no"
lower-bound="..."
upper-bound="..."
force-integer="yes | no"
extensible="yes | no" />
</typesystem>
The **name** attribute is the fully qualified C++ name of the enum
(e.g.,"Qt::FillRule"). If the *optional* **flags** attribute is set to *yes*
(the default is *no*), the generator will expect an existing QFlags<T> for the
given enum type. The **lower-bound** and **upper-bound** attributes are used
to specify runtime bounds checking for the enum value. The value must be a
compilable target language statement, such as "QGradient.Spread.PadSpread"
(taking again Python as an example). If the **force-integer** attribute is
set to *yes* (the default is *no*), the generated target language code will
use the target language integers instead of enums. And finally, the
**extensible** attribute specifies whether the given enum can be extended
with user values (the default is *no*).
reject-enum-value
^^^^^^^^^^^^^^^^^
The reject-enum-value node rejects the enum value specified by the **name**
attribute, and it is a child of the enum-type node.
.. code-block:: xml
<enum-type>
<reject-enum-value name="..."/>
</enum-type>
This node is used when a C++ enum implementation has several identical numeric
values, some of which are typically obsolete.
.. _value-type:
value-type
^^^^^^^^^^
The value-type node indicates that the given C++ type is mapped onto the target
language as a value type. This means that it is an object passed by value on C++,
i.e. it is stored in the function call stack. It is a child of the :ref:`typesystem` node.
.. code-block:: xml
<typesystem>
<value-type name="..."
copyable="yes | no"
hash-function="..." />
</typesystem>
The **name** attribute is the fully qualified C++ class name, such as
"QMatrix" or "QPainterPath::Element". The **copyable** attribute is used to
force or not specify if this type is copyable. The *optional* **hash-function**
attribute informs the function name of a hash function for the type.
.. _object-type:
object-type
^^^^^^^^^^^
The object-type node indicates that the given C++ type is mapped onto the target
language as an object type. This means that it is an object passed by pointer on
C++ and it is stored on the heap. It is a child of the :ref:`typesystem` node.
.. code-block:: xml
<typesystem>
<object-type name="..."
copyable="yes | no"
hash-function="..." />
</typesystem>
The **name** attribute is the fully qualified C++ class name. If there is no
C++ base class, the default-superclass attribute can be used to specify a
superclass for the given type, in the generated target language API. The
**copyable** and **hash-function** attributes are the same as described for
:ref:`value-type`.
interface-type
^^^^^^^^^^^^^^
The interface-type node indicates that the given class is replaced by an
interface pattern when mapping from C++ to the target language. Using the
interface-type node implicitly makes the given type an :ref:`object type`.
.. code-block:: xml
<typesystem>
<interface-type name="..."
package ="..."
default-superclass ="..." />
</typesystem>
The **name** attribute is the fully qualified C++ class name. The *optional*
**package** attribute can be used to override the package of the type system.
If there is no C++ base class, the *optional* **default-superclass** attribute
can be used to specify a superclass in the generated target language API, for
the given class.
|
