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
|
## # vcpkg_check_features
## Check if one or more features are a part of a package installation.
##
## ## Usage
## ```cmake
## vcpkg_check_features(
## OUT_FEATURE_OPTIONS <FEATURE_OPTIONS>
## [FEATURES
## <cuda> <WITH_CUDA>
## [<opencv> <WITH_OPENCV>]
## ...]
## [INVERTED_FEATURES
## <cuda> <IGNORE_PACKAGE_CUDA>
## [<opencv> <IGNORE_PACKAGE_OPENCV>]
## ...]
## )
## ```
## `vcpkg_check_features()` accepts these parameters:
##
## * `OUT_FEATURE_OPTIONS`:
## An output variable, the function will clear the variable passed to `OUT_FEATURE_OPTIONS`
## and then set it to contain a list of option definitions (`-D<OPTION_NAME>=ON|OFF`).
##
## This should be set to `FEATURE_OPTIONS` by convention.
##
## * `FEATURES`:
## A list of (`FEATURE_NAME`, `OPTION_NAME`) pairs.
## For each `FEATURE_NAME` a definition is added to `OUT_FEATURE_OPTIONS` in the form of:
##
## * `-D<OPTION_NAME>=ON`, if a feature is specified for installation,
## * `-D<OPTION_NAME>=OFF`, otherwise.
##
## * `INVERTED_FEATURES`:
## A list of (`FEATURE_NAME`, `OPTION_NAME`) pairs, uses reversed logic from `FEATURES`.
## For each `FEATURE_NAME` a definition is added to `OUT_FEATURE_OPTIONS` in the form of:
##
## * `-D<OPTION_NAME>=OFF`, if a feature is specified for installation,
## * `-D<OPTION_NAME>=ON`, otherwise.
##
##
## ## Notes
##
## The `FEATURES` name parameter can be omitted if no `INVERTED_FEATURES` are used.
##
## At least one (`FEATURE_NAME`, `OPTION_NAME`) pair must be passed to the function call.
##
## Arguments passed to `FEATURES` and `INVERTED_FEATURES` are not validated to prevent duplication.
## If the same (`FEATURE_NAME`, `OPTION_NAME`) pair is passed to both lists,
## two conflicting definitions are added to `OUT_FEATURE_OPTIONS`.
##
##
## ## Examples
##
## ### Example 1: Regular features
##
## ```cmake
## $ ./vcpkg install mimalloc[asm,secure]
##
## # ports/mimalloc/portfile.cmake
## vcpkg_check_features(OUT_FEATURE_OPTIONS FEATURE_OPTIONS
## # Keyword FEATURES is optional if INVERTED_FEATURES are not used
## asm MI_SEE_ASM
## override MI_OVERRIDE
## secure MI_SECURE
## )
##
## vcpkg_configure_cmake(
## SOURCE_PATH ${SOURCE_PATH}
## PREFER_NINJA
## OPTIONS
## # Expands to "-DMI_SEE_ASM=ON; -DMI_OVERRIDE=OFF; -DMI_SECURE=ON"
## ${FEATURE_OPTIONS}
## )
## ```
##
## ### Example 2: Inverted features
##
## ```cmake
## $ ./vcpkg install cpprestsdk[websockets]
##
## # ports/cpprestsdk/portfile.cmake
## vcpkg_check_features(OUT_FEATURE_OPTIONS FEATURE_OPTIONS
## INVERTED_FEATURES # <- Keyword INVERTED_FEATURES required
## brotli CPPREST_EXCLUDE_BROTLI
## websockets CPPREST_EXCLUDE_WEBSOCKETS
## )
##
## vcpkg_configure_cmake(
## SOURCE_PATH ${SOURCE_PATH}
## PREFER_NINJA
## OPTIONS
## # Expands to "-DCPPREST_EXCLUDE_BROTLI=ON; -DCPPREST_EXCLUDE_WEBSOCKETS=OFF"
## ${FEATURE_OPTIONS}
## )
## ```
##
## ### Example 3: Set multiple options for same feature
##
## ```cmake
## $ ./vcpkg install pcl[cuda]
##
## # ports/pcl/portfile.cmake
## vcpkg_check_features(OUT_FEATURE_OPTIONS FEATURE_OPTIONS
## cuda WITH_CUDA
## cuda BUILD_CUDA
## cuda BUILD_GPU
## )
##
## vcpkg_configure_cmake(
## SOURCE_PATH ${SOURCE_PATH}
## PREFER_NINJA
## OPTIONS
## # Expands to "-DWITH_CUDA=ON; -DBUILD_CUDA=ON; -DBUILD_GPU=ON"
## ${FEATURE_OPTIONS}
## )
## ```
##
## ### Example 4: Use regular and inverted features
##
## ```cmake
## $ ./vcpkg install rocksdb[tbb]
##
## # ports/rocksdb/portfile.cmake
## vcpkg_check_features(OUT_FEATURE_OPTIONS FEATURE_OPTIONS
## FEATURES # <- Keyword FEATURES is required because INVERTED_FEATURES are being used
## tbb WITH_TBB
## INVERTED_FEATURES
## tbb ROCKSDB_IGNORE_PACKAGE_TBB
## )
##
## vcpkg_configure_cmake(
## SOURCE_PATH ${SOURCE_PATH}
## PREFER_NINJA
## OPTIONS
## # Expands to "-DWITH_TBB=ON; -DROCKSDB_IGNORE_PACKAGE_TBB=OFF"
## ${FEATURE_OPTIONS}
## )
## ```
##
## ## Examples in portfiles
##
## * [cpprestsdk](https://github.com/microsoft/vcpkg/blob/master/ports/cpprestsdk/portfile.cmake)
## * [pcl](https://github.com/microsoft/vcpkg/blob/master/ports/pcl/portfile.cmake)
## * [rocksdb](https://github.com/microsoft/vcpkg/blob/master/ports/rocksdb/portfile.cmake)
##
function(vcpkg_check_features)
cmake_parse_arguments(_vcf "" "OUT_FEATURE_OPTIONS" "FEATURES;INVERTED_FEATURES" ${ARGN})
if (NOT DEFINED _vcf_OUT_FEATURE_OPTIONS)
message(FATAL_ERROR "OUT_FEATURE_OPTIONS must be specified.")
endif()
macro(_check_features _vcf_ARGUMENT _set_if _set_else)
list(LENGTH ${_vcf_ARGUMENT} FEATURES_SET_LEN)
math(EXPR _vcf_INCORRECT_ARGN "${FEATURES_SET_LEN} % 2")
if(_vcf_INCORRECT_ARGN)
message(FATAL_ERROR "Called with incorrect number of arguments.")
endif()
set(_vcf_IS_FEATURE_NAME_ARG ON)
foreach(_vcf_ARG ${${_vcf_ARGUMENT}})
if(_vcf_IS_FEATURE_NAME_ARG)
set(_vcf_FEATURE_NAME ${_vcf_ARG})
if(NOT ${_vcf_FEATURE_NAME} IN_LIST ALL_FEATURES)
message(FATAL_ERROR "Unknown feature: ${_vcf_FEATURE_NAME}")
endif()
set(_vcf_IS_FEATURE_NAME_ARG OFF)
else()
set(_vcf_FEATURE_VARIABLE ${_vcf_ARG})
if(${_vcf_FEATURE_NAME} IN_LIST FEATURES)
list(APPEND _vcf_FEATURE_OPTIONS "-D${_vcf_FEATURE_VARIABLE}=${_set_if}")
else()
list(APPEND _vcf_FEATURE_OPTIONS "-D${_vcf_FEATURE_VARIABLE}=${_set_else}")
endif()
set(_vcf_IS_FEATURE_NAME_ARG ON)
endif()
endforeach()
endmacro()
set(_vcf_FEATURE_OPTIONS)
if (DEFINED _vcf_FEATURES OR DEFINED _vcf_INVERTED_FEATURES)
_check_features(_vcf_FEATURES ON OFF)
_check_features(_vcf_INVERTED_FEATURES OFF ON)
else()
# Skip arguments that correspond to OUT_FEATURE_OPTIONS and its value.
list(SUBLIST ARGN 2 -1 _vcf_ARGN)
_check_features(_vcf_ARGN ON OFF)
endif()
set(${_vcf_OUT_FEATURE_OPTIONS} "${_vcf_FEATURE_OPTIONS}" PARENT_SCOPE)
endfunction()
|
