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) 2018 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 PathProbe
\inqmlmodule QbsProbes
\ingroup list-of-items
\keyword QML.PathProbe
\brief Locates files outside the project.
Finds files that have the specified file name suffix, such as \e .exe, from the specified
locations.
PathProbe takes as input lists of paths to search files from and file name patterns. The paths
are specified by using the environmentPaths, searchPaths, platformEnvironmentPaths and
platformSearchPaths properties; the path are searched in the same order as listed. The file
name patterns are specified by the \l names and nameSuffixes properties. Returns the first file
that matches the file name patterns. If no such file is found, the
\l {Probe::found}{probe.found} property is set to \c false.
For example, a simple PathProbe that searches for the stdio.h header can be used as follows:
\code
Product {
Depends { name: "cpp" }
PathProbe {
id: probe
pathSuffixes: ["include"]
names: ["stdio.h"]
}
cpp.includePaths: probe.found ? [probe.path] : []
}
\endcode
*/
/*!
\qmlproperty varList PathProbe::allResults
This property contains the list of objects, each object representing a single found file:
\code
{
found: true,
candidatePaths: ["path1/to/file", "path2/to/file", ...]
filePath: "path/to/file"
fileName: "file"
path: "path/to"
}
\endcode
\sa {PathProbe::filePath}{filePath}, {PathProbe::fileName}{fileName},
{PathProbe::path}{path}
*/
/*!
\qmlproperty var PathProbe::candidateFilter
This property holds the function that can be used to filter out unsuitable candidates.
For example, when searching for a library, it might be necessary to check its architecture:
\code
PathProbe {
pathSuffixes: [".so", ".dll", ".dylib"]
candidateFilter: {
function getLibraryArchitecture(file) { ... }
return function(file) {
return Utilities.isSharedLibrary(file)
&& getLibraryArchitecture(file) == qbs.architecture;
}
}
}
\endcode
*/
/*!
\qmlproperty stringList PathProbe::names
The list of file names to search for.
\nodefaultvalue
*/
/*!
\qmlproperty stringList PathProbe::nameSuffixes
The list of file suffixes to search for. These suffixes are appended to every file name passed
via the \l names property.
\nodefaultvalue
*/
/*!
\qmlproperty script PathProbe::nameFilter
A script that is executed for each file name before prepending file suffixes. Can be used to
transform file names.
*/
/*!
\qmlproperty pathList PathProbe::searchPaths
The list of paths where to search files.
\nodefaultvalue
*/
/*!
\qmlproperty pathList PathProbe::platformSearchPaths
The list of platform paths where to search files.
\defaultvalue \c {['/usr', '/usr/local']} on Unix hosts, empty otherwise
*/
/*!
\qmlproperty stringList PathProbe::pathSuffixes
A list of relative paths that are appended to each path where PathProbe searches for files.
That is, the file should be located within one of the subfolders passed using this
property.
\nodefaultvalue
*/
/*!
\qmlproperty stringList PathProbe::environmentPaths
The list of environment variables that contains paths where to search files. Paths in the
environment variable should be separated using
\l{pathListSeparator}{FileInfo.pathListSeparator()}.
\nodefaultvalue
*/
/*!
\qmlproperty stringList PathProbe::platformEnvironmentPaths
The list of platform environment variables that contains paths where to search files. Paths in
the environment variable should be separated using
\l{pathListSeparator}{FileInfo.pathListSeparator()}.
\nodefaultvalue
*/
/*!
\qmlproperty stringList PathProbe::candidatePaths
This property contains the result list of all paths that were checked before a file was found
(including the file names).
This property is set even if the Probe didn't find anything and can be used to give the user
a hint what went wrong:
\code
Module {
Probes.BinaryProbe {
id: pythonProbe
names: "python"
}
validate: {
if (!pythonProbe.found) {
throw ModUtils.ModuleError(
"Could not find python binary at any of the following locations:\n\t" +
pythonProbe.candidatePaths.join("\n\t"));
}
}
}
\endcode
\nodefaultvalue
*/
/*!
\qmlproperty string PathProbe::path
This property contains the full path where the found file is located
(that is, the file directory).
\nodefaultvalue
*/
/*!
\qmlproperty string PathProbe::filePath
This property contains the full path to the found file, including the file name.
\nodefaultvalue
*/
/*!
\qmlproperty string PathProbe::fileName
This property contains the found file's name (excluding the path).
\nodefaultvalue
*/
/*!
\qmlproperty varList PathProbe::selectors
This property should be used to search for multiple files. It contains the list of selectors
each of which describes a single file to search for. A selector can be either a string, a
stringList, or a dictionary.
The following example searches for three files and illustrates different ways to specify
selectors:
\code
selectors: [
// 1st file with a single name
"header.h",
// 2nd file with possible name variants
["config.h", "foo-config.h", "bar-config.h"],
// 3rd file with possible name and suffix variants
{names: ["footk", "footk-version"], nameSuffixes: [".h", ".hpp"]}
]
\endcode
*/
|
