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
|
/****************************************************************************
**
** Copyright (C) 2024 Ivan Komissarov (abbapoh@gmail.com)
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qbs.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\qmltype flatbuf.cpp
\inqmlmodule QbsModules
\since Qbs 2.4
\brief Provides support for \l{https://google.github.io/flatbuf/}{flatbuf} for the
C++ language.
The \c flatbuf.cpp module provides support for generating C++ headers
and sources from flatbuf definition files using the \c flatc tool.
A simple qbs file that uses flatbuf can be written as follows:
\code
CppApplication {
Depends { name: "flatbuf.cpp" }
files: ["foo.fbs", "main.cpp"]
}
\endcode
A generated header now can be included in the C++ sources:
\code
#include <foo_generated.h>
int main(int argc, char* argv[]) {
flatbuf::FlatBufferBuilder builder;
auto foo = QbsTest::CreateFoo(builder, 42);
return 0;
}
\endcode
\section2 Relevant File Tags
\table
\header
\li Tag
\li Auto-tagged File Names
\li Since
\li Description
\row
\li \c{"flatbuf.input"}
\li \c{*.fbs}
\li 2.4.0
\li Source files with this tag are considered inputs to the \c flatc compiler.
\endtable
\section2 Dependencies
This module depends on the \c flatbuffers module which can be created via the \l{conan}{Conan}
module provider.
*/
/*!
\qmlproperty string flatbuf.cpp::compilerName
The name of the \c flatc binary.
\defaultvalue \c "flatc"
*/
/*!
\qmlproperty string flatbuf.cpp::compilerPath
The path to the \c flatc binary.
Use this property to override the auto-detected location.
\defaultvalue \c auto-detected
*/
/*!
\qmlproperty string flatbuf.cpp::filenameExtension
The extension appended to the generated file names. If not specified, the default extension
(\c ".h") is used.
This property corresponds to the \c --filename-ext option of the \c flatc tool.
\nodefaultvalue
*/
/*!
\qmlproperty string flatbuf.cpp::filenameSuffix
The suffix appended to the generated file names. If not specified, the default suffix
(\c "_generated") is used.
This property corresponds to the \c --filename-suffix option of the \c flatc tool.
\nodefaultvalue
*/
/*!
\qmlproperty pathList flatbuf.cpp::importPaths
The list of import paths that are passed to the \c flatc tool via the \c -I option.
\defaultvalue \c []
*/
/*!
\qmlproperty string flatbuf.cpp::includePrefix
Prefix path prepended to any generated include statements.
This property corresponds to the \c --include-prefix option of the \c flatc tool.
\nodefaultvalue
*/
/*!
\qmlproperty bool flatbuf.cpp::keepPrefix
Whether to keep original prefix of schema include statement.
This property corresponds to the \c --keep-prefix option of the \c flatc tool.
\defaultvalue \c false
*/
|
