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
|
/****************************************************************************
**
** Copyright (C) 2016 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$
**
****************************************************************************/
/*!
\contentspage list-of-items.html
\previouspage cppapplication-item.html
\page depends-item.html
\nextpage dynamiclibrary-item.html
\ingroup list-of-items
\title Depends Item
\brief Represents dependencies between products and modules.
A \c Depends item can appear inside a \l{Product Item} or \l{Module Item}.
For example, the following product will load the \c cpp module. In addition, it will try
to load modules that may or may not exist, and in the latter case use a fallback.
\code
Product {
Depends { name: "cpp" }
Depends {
name: "awesome_module"
versionAtLeast: "2.0"
required: false
}
Depends {
name: "adequate_module"
condition: !awesome_module.present
required: false
}
Depends {
name: "crappy_module"
condition: !awesome_module.present && !adequate_module.present
}
// ...
}
\endcode
\section1 Depends Properties
\table
\header
\li Property
\li Type
\li Default
\li Description
\row
\li condition
\li bool
\li true
\li Determines whether the dependency will actually be applied.
\row
\li versionAtLeast
\li string
\li undefined
\li The minimum value that the dependency's \c version property needs to have. If the
actual version is lower than that, loading the dependency will fail.
The value consists of integers separated by dots.
\row
\li versionBelow
\li string
\li undefined
\li A value that the dependency's \c version property must be lower than. If the
actual version is equal to or higher than that, loading the dependency will fail.
The value consists of integers separated by dots.
\row
\li productTypes
\li stringList
\li undefined
\li A list of product types. Any enabled product in the project that has a matching type
will become a dependency of the product containing the \c Depends item.
This property is mutually exclusive with the \c name and \c submodules properties.
The \c required and \c profiles properties are ignored if \c productTypes is set.
\row
\li required
\li bool
\li \c true
\li Setting this property to \c false creates a \e{soft dependency}, meaning that it is not
considered an error if the given module cannot be found. In such a case, an instance of
the respective module will be created, but only the \c present property will be
available for querying, and it will be set to \c false.
\row
\li name
\li string
\li undefined
\li The name of the dependent product or module.
\row
\li profiles
\li stringList
\li \c{[product.profile]}
\li If the dependency is on a product and that product is going to be built for more than
one profile, then you can specify here which instance of the product the dependency is on.
See the \c profiles property of the \c Product item for more information.
An empty list means a dependency on all instances of the product with the given name,
regardless of their profile.
\row
\li limitToSubProject
\li bool
\li \c false
\li If \c productTypes is set and this property is \c true, then only products that
are in the same sub-project as the product containing the \c Depends item are
considered.
\row
\li submodules
\li stringList
\li undefined
\li The submodules of \c module to depend on, if applicable.
\endtable
*/
|
