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
|
/****************************************************************************
**
** Copyright (C) 2019 Ivan Komissarov
** 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$
**
****************************************************************************/
/*!
\contentspage list-of-probes.html
\qmltype PkgConfigProbe
\ingroup list-of-probes
\ingroup list-of-items
\keyword QML.PkgConfigProbe
\brief Retrieves the information about installed packages using the pkg-config binary.
This probe takes the package name or the list of package names as input and returns the
information that is required to compile and link using those packages.
Usually, you can simply use a Depends item as described in
\l{How do I build against libraries that provide pkg-config files?}.
Alternatively, the probe can be used directly as follows:
\code
CppApplication {
name: project.name
Probes.PkgConfigProbe {
id: pkgConfig
name: "QtCore"
minVersion: '4.0.0'
maxVersion: '5.99.99'
}
files: 'main.cpp'
cpp.cxxFlags: pkgConfig.cflags
cpp.linkerFlags: pkgConfig.libs
}
\endcode
*/
/*!
\qmlproperty string PkgConfigProbe::sysroot
This property sets the value of the \c PKG_CONFIG_SYSROOT_DIR environment variable passed to
the \c pkg-config binary. This variable modifies -I and -L flags to use the directories located
in target sysroot.
This property is useful when cross-compiling packages that use \c pkg-config to determine CFLAGS
and LDFLAGS. For example, if \c sysroot is set to \c /var/target, a \c -I/usr/include/libfoo
will become \c -I/var/target/usr/include/libfoo.
\defaultvalue \c qbs.sysroot
*/
/*!
\qmlproperty string PkgConfigProbe::executable
The name of or the path to the pkg-config executable.
\defaultvalue "pkg-config"
*/
/*!
\qmlproperty string PkgConfigProbe::name
The name this probe. This property is used as
\l{PkgConfigProbe::packageNames}{PkgConfigProbe.packageNames} value by default.
\nodefaultvalue
*/
/*!
\qmlproperty stringList PkgConfigProbe::packageNames
The list of package names to pass to the pkg-config executable. For each package, pkg-config
will return the information required to compile and link to this package.
\defaultvalue [\l{PkgConfigProbe::name}{PkgConfigProbe.name}]
*/
/*!
\qmlproperty string PkgConfigProbe::minVersion
The minimum version of the required package. If set, pkg-config will ignore packages with
version less than the value of this property.
\nodefaultvalue
*/
/*!
\qmlproperty string PkgConfigProbe::exactVersion
The exact version of the required package. If set, pkg-config will ignore packages with
version greater than the value of this property.
\nodefaultvalue
*/
/*!
\qmlproperty string PkgConfigProbe::maxVersion
The maximum version of the required package. If set, pkg-config will ignore packages with
version that is not equal to the value of this property.
\nodefaultvalue
*/
/*!
\qmlproperty bool PkgConfigProbe::forStaticBuild
If \c true, pkg-config will return linker flags for a static linking instead of dynamic.
\defaultvalue \c false
*/
/*!
\qmlproperty stringList PkgConfigProbe::libDirs
List of full, non-sysrooted paths where pkg-config should search for .pc files. This overrides
the built-in path (which is usually /usr/lib/pkgconfig).
This property sets the value of the \c PKG_CONFIG_LIBDIR environment variable passed to
the \c pkg-config binary.
\nodefaultvalue
*/
/*!
\qmlproperty stringList PkgConfigProbe::cflags
\internal
This property contains the unparsed output from "pkg-config --cflags" call. Usually, you should
use \l{PkgConfigProbe::defines}{PkgConfigProbe.defines},
\l{PkgConfigProbe::includePaths}{PkgConfigProbe.includePaths} and
\l{PkgConfigProbe::compilerFlags}{PkgConfigProbe.compilerFlags} properties instead.
\nodefaultvalue
*/
/*!
\qmlproperty stringList PkgConfigProbe::libs
\internal
This property contains the unparsed output from "pkg-config --libs" call. Usually, you should
use \l{PkgConfigProbe::libraries}{PkgConfigProbe.libraries},
\l{PkgConfigProbe::libraryPaths}{PkgConfigProbe.libraryPaths} and
\l{PkgConfigProbe::linkerFlags}{PkgConfigProbe.linkerFlags} properties instead.
\nodefaultvalue
*/
/*!
\qmlproperty stringList PkgConfigProbe::defines
This output property contains the list of defines that should be passed to a compiler when
using requested package.
\nodefaultvalue
*/
/*!
\qmlproperty stringList PkgConfigProbe::libraries
This output property contains the list of library names that should be passed to a linker when
using requested package.
\nodefaultvalue
*/
/*!
\qmlproperty stringList PkgConfigProbe::libraryPaths
This output property contains the list of library paths that should be passed to a linker when
using requested package.
This property sets the value of the PKG_CONFIG_LIBDIR environment variable passed to
the \c pkg-config binary.
\nodefaultvalue
*/
/*!
\qmlproperty stringList PkgConfigProbe::includePaths
This output property contains the list of include paths that should be passed to a compiler when
using requested package.
\nodefaultvalue
*/
/*!
\qmlproperty stringList PkgConfigProbe::compilerFlags
This output property contains the list of flags that should be passed to a compiler when
using requested package.
\nodefaultvalue
*/
/*!
\qmlproperty stringList PkgConfigProbe::linkerFlags
This output property contains the list of flags that should be passed to a linker when
using requested package.
\nodefaultvalue
*/
/*!
\qmlproperty stringList PkgConfigProbe::modversion
This output property contains the version of the found package.
\nodefaultvalue
*/
|
