blob: 75c87ba579e004007f7d41570a08ca40aaddc031 (
plain)
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
|
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** 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 protobuf.nanopb
\inqmlmodule QbsModules
\since Qbs 1.18
\brief Provides support for protocol buffers for embedded systems.
The \c protobuf.nanopb module provides support for generating nanopb C headers
and sources from proto definition files using the \l nanopb plugin for the
\l protoc tool suitable for embedded systems.
A simple qbs file that uses protobuf can be written as follows:
\code
CppApplication {
Depends { name: "protobuf.nanopb" }
files: ["foo.proto", "main.cpp"]
}
\endcode
A generated header now can be included in the C++ sources:
\code
#include <foo.pb.h>
int main(int argc, char* argv[]) {
Foo bar;
bar.has_answer = true;
bar.answer = 42;
return 0;
}
\endcode
Nanopb .options files to define nanopb specific proto options are supported.
\section2 Relevant File Tags
\table
\header
\li Tag
\li Auto-tagged File Names
\li Since
\li Description
\row
\li \c{"protobuf.input"}
\li \c{*.proto}
\li 1.13.0
\li Source files with this tag are considered inputs to the \c protoc compiler.
\row
\li \c{"protobuf.hpp"}
\li
\li 1.18.0
\li This tag is attached to the header files generated by \c protoc compiler.
\endtable
*/
/*!
\qmlproperty string protobuf.nanopb::compilerName
The name of the protoc binary.
\defaultvalue \c "protoc"
*/
/*!
\qmlproperty string protobuf.nanopb::compilerPath
The path to the protoc binary.
Use this property to override the auto-detected location.
\defaultvalue \c auto-detected
*/
/*!
\qmlproperty pathList protobuf.nanopb::importPaths
The list of imports that are passed to the \c protoc tool via the \c --proto_path option.
These imports should contain the proto files. They are used to determine
the relative structure of the generated files.
\note The paths are passed to \c protoc in the same order as specified in this property and
\c protoc output may differ depending on that order.
\defaultvalue \c []
*/
/*!
\qmlproperty string protobuf.nanopb::includePath
The path where protobuf nanopb C headers are located. Set this property to override the
default location.
\defaultvalue \c auto-detected
*/
/*!
\qmlproperty string protobuf.nanopb::libraryPath
The path where the protobuf nanopb runtime library is located. Set this property to override the
default location.
\defaultvalue \c auto-detected
*/
/*!
\qmlproperty string protobuf.nanopb::outputDir
\readonly
The directory where the \c protoc compiler generated files are placed.
The value of this property is automatically set by \QBS and cannot be
changed by the user.
*/
/*!
\qmlproperty string protobuf.nanopb::pluginName
The name of the nanopb protoc plugin.
\defaultvalue \c "protoc-gen-nanopb"
*/
/*!
\qmlproperty string protobuf.nanopb::pluginPath
The path to the nanopb protoc plugin.
Use this property to override the auto-detected location.
\defaultvalue \c auto-detected
*/
|
