react-native-quick-crypto 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (92) hide show
  1. package/QuickCrypto.podspec +19 -52
  2. package/android/CMakeLists.txt +4 -2
  3. package/android/build.gradle +1 -1
  4. package/cpp/cipher/HybridCipher.cpp +20 -3
  5. package/cpp/cipher/HybridRsaCipher.cpp +20 -1
  6. package/cpp/ed25519/HybridEdKeyPair.cpp +8 -2
  7. package/cpp/keys/HybridKeyObjectHandle.cpp +8 -0
  8. package/cpp/keys/KeyObjectData.hpp +1 -1
  9. package/cpp/mldsa/HybridMlDsaKeyPair.cpp +264 -0
  10. package/cpp/mldsa/HybridMlDsaKeyPair.hpp +47 -0
  11. package/cpp/sign/HybridSignHandle.cpp +97 -22
  12. package/cpp/sign/HybridVerifyHandle.cpp +90 -21
  13. package/deps/ncrypto/.bazelignore +4 -0
  14. package/deps/ncrypto/.bazelrc +2 -0
  15. package/deps/ncrypto/.bazelversion +1 -0
  16. package/deps/ncrypto/.clang-format +111 -0
  17. package/deps/ncrypto/.github/workflows/bazel.yml +58 -0
  18. package/deps/ncrypto/.github/workflows/linter.yml +38 -0
  19. package/deps/ncrypto/.github/workflows/macos.yml +43 -0
  20. package/deps/ncrypto/.github/workflows/ubuntu.yml +46 -0
  21. package/deps/ncrypto/.github/workflows/visual-studio.yml +49 -0
  22. package/deps/ncrypto/.python-version +1 -0
  23. package/deps/ncrypto/BUILD.bazel +36 -0
  24. package/deps/ncrypto/CMakeLists.txt +55 -0
  25. package/deps/ncrypto/LICENSE +21 -0
  26. package/deps/ncrypto/MODULE.bazel +1 -0
  27. package/deps/ncrypto/MODULE.bazel.lock +280 -0
  28. package/deps/ncrypto/README.md +18 -0
  29. package/deps/ncrypto/WORKSPACE +15 -0
  30. package/deps/ncrypto/cmake/CPM.cmake +1225 -0
  31. package/deps/ncrypto/cmake/ncrypto-flags.cmake +16 -0
  32. package/deps/ncrypto/include/dh-primes.h +67 -0
  33. package/deps/ncrypto/{ncrypto.h → include/ncrypto.h} +361 -89
  34. package/deps/ncrypto/patches/0001-Expose-libdecrepit-so-NodeJS-can-use-it-for-ncrypto.patch +28 -0
  35. package/deps/ncrypto/pyproject.toml +38 -0
  36. package/deps/ncrypto/src/CMakeLists.txt +15 -0
  37. package/deps/ncrypto/src/engine.cpp +93 -0
  38. package/deps/ncrypto/{ncrypto.cc → src/ncrypto.cpp} +1168 -234
  39. package/deps/ncrypto/tests/BUILD.bazel +9 -0
  40. package/deps/ncrypto/tests/CMakeLists.txt +7 -0
  41. package/deps/ncrypto/tests/basic.cpp +86 -0
  42. package/deps/ncrypto/tools/run-clang-format.sh +42 -0
  43. package/lib/commonjs/ed.js +68 -0
  44. package/lib/commonjs/ed.js.map +1 -1
  45. package/lib/commonjs/keys/classes.js +6 -0
  46. package/lib/commonjs/keys/classes.js.map +1 -1
  47. package/lib/commonjs/mldsa.js +69 -0
  48. package/lib/commonjs/mldsa.js.map +1 -0
  49. package/lib/commonjs/specs/mlDsaKeyPair.nitro.js +6 -0
  50. package/lib/commonjs/specs/mlDsaKeyPair.nitro.js.map +1 -0
  51. package/lib/commonjs/subtle.js +483 -13
  52. package/lib/commonjs/subtle.js.map +1 -1
  53. package/lib/commonjs/utils/types.js.map +1 -1
  54. package/lib/module/ed.js +66 -0
  55. package/lib/module/ed.js.map +1 -1
  56. package/lib/module/keys/classes.js +6 -0
  57. package/lib/module/keys/classes.js.map +1 -1
  58. package/lib/module/mldsa.js +63 -0
  59. package/lib/module/mldsa.js.map +1 -0
  60. package/lib/module/specs/mlDsaKeyPair.nitro.js +4 -0
  61. package/lib/module/specs/mlDsaKeyPair.nitro.js.map +1 -0
  62. package/lib/module/subtle.js +484 -14
  63. package/lib/module/subtle.js.map +1 -1
  64. package/lib/module/utils/types.js.map +1 -1
  65. package/lib/tsconfig.tsbuildinfo +1 -1
  66. package/lib/typescript/ed.d.ts +4 -1
  67. package/lib/typescript/ed.d.ts.map +1 -1
  68. package/lib/typescript/index.d.ts +2 -0
  69. package/lib/typescript/index.d.ts.map +1 -1
  70. package/lib/typescript/keys/classes.d.ts +2 -0
  71. package/lib/typescript/keys/classes.d.ts.map +1 -1
  72. package/lib/typescript/mldsa.d.ts +18 -0
  73. package/lib/typescript/mldsa.d.ts.map +1 -0
  74. package/lib/typescript/specs/mlDsaKeyPair.nitro.d.ts +16 -0
  75. package/lib/typescript/specs/mlDsaKeyPair.nitro.d.ts.map +1 -0
  76. package/lib/typescript/subtle.d.ts +4 -1
  77. package/lib/typescript/subtle.d.ts.map +1 -1
  78. package/lib/typescript/utils/types.d.ts +14 -6
  79. package/lib/typescript/utils/types.d.ts.map +1 -1
  80. package/nitrogen/generated/android/QuickCrypto+autolinking.cmake +1 -0
  81. package/nitrogen/generated/android/QuickCryptoOnLoad.cpp +10 -0
  82. package/nitrogen/generated/ios/QuickCryptoAutolinking.mm +10 -0
  83. package/nitrogen/generated/shared/c++/AsymmetricKeyType.hpp +12 -0
  84. package/nitrogen/generated/shared/c++/HybridMlDsaKeyPairSpec.cpp +29 -0
  85. package/nitrogen/generated/shared/c++/HybridMlDsaKeyPairSpec.hpp +73 -0
  86. package/package.json +7 -3
  87. package/src/ed.ts +102 -0
  88. package/src/keys/classes.ts +9 -0
  89. package/src/mldsa.ts +125 -0
  90. package/src/specs/mlDsaKeyPair.nitro.ts +29 -0
  91. package/src/subtle.ts +667 -17
  92. package/src/utils/types.ts +27 -6
@@ -0,0 +1,1225 @@
1
+ # CPM.cmake - CMake's missing package manager
2
+ # ===========================================
3
+ # See https://github.com/cpm-cmake/CPM.cmake for usage and update instructions.
4
+ #
5
+ # MIT License
6
+ # -----------
7
+ #[[
8
+ Copyright (c) 2019-2023 Lars Melchior and contributors
9
+
10
+ Permission is hereby granted, free of charge, to any person obtaining a copy
11
+ of this software and associated documentation files (the "Software"), to deal
12
+ in the Software without restriction, including without limitation the rights
13
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14
+ copies of the Software, and to permit persons to whom the Software is
15
+ furnished to do so, subject to the following conditions:
16
+
17
+ The above copyright notice and this permission notice shall be included in all
18
+ copies or substantial portions of the Software.
19
+
20
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26
+ SOFTWARE.
27
+ ]]
28
+
29
+ cmake_minimum_required(VERSION 3.14 FATAL_ERROR)
30
+
31
+ # Initialize logging prefix
32
+ if(NOT CPM_INDENT)
33
+ set(CPM_INDENT
34
+ "CPM:"
35
+ CACHE INTERNAL ""
36
+ )
37
+ endif()
38
+
39
+ if(NOT COMMAND cpm_message)
40
+ function(cpm_message)
41
+ message(${ARGV})
42
+ endfunction()
43
+ endif()
44
+
45
+ set(CURRENT_CPM_VERSION 0.40.0)
46
+
47
+ get_filename_component(CPM_CURRENT_DIRECTORY "${CMAKE_CURRENT_LIST_DIR}" REALPATH)
48
+ if(CPM_DIRECTORY)
49
+ if(NOT CPM_DIRECTORY STREQUAL CPM_CURRENT_DIRECTORY)
50
+ if(CPM_VERSION VERSION_LESS CURRENT_CPM_VERSION)
51
+ message(
52
+ AUTHOR_WARNING
53
+ "${CPM_INDENT} \
54
+ A dependency is using a more recent CPM version (${CURRENT_CPM_VERSION}) than the current project (${CPM_VERSION}). \
55
+ It is recommended to upgrade CPM to the most recent version. \
56
+ See https://github.com/cpm-cmake/CPM.cmake for more information."
57
+ )
58
+ endif()
59
+ if(${CMAKE_VERSION} VERSION_LESS "3.17.0")
60
+ include(FetchContent)
61
+ endif()
62
+ return()
63
+ endif()
64
+
65
+ get_property(
66
+ CPM_INITIALIZED GLOBAL ""
67
+ PROPERTY CPM_INITIALIZED
68
+ SET
69
+ )
70
+ if(CPM_INITIALIZED)
71
+ return()
72
+ endif()
73
+ endif()
74
+
75
+ if(CURRENT_CPM_VERSION MATCHES "development-version")
76
+ message(
77
+ WARNING "${CPM_INDENT} Your project is using an unstable development version of CPM.cmake. \
78
+ Please update to a recent release if possible. \
79
+ See https://github.com/cpm-cmake/CPM.cmake for details."
80
+ )
81
+ endif()
82
+
83
+ set_property(GLOBAL PROPERTY CPM_INITIALIZED true)
84
+
85
+ macro(cpm_set_policies)
86
+ # the policy allows us to change options without caching
87
+ cmake_policy(SET CMP0077 NEW)
88
+ set(CMAKE_POLICY_DEFAULT_CMP0077 NEW)
89
+
90
+ # the policy allows us to change set(CACHE) without caching
91
+ if(POLICY CMP0126)
92
+ cmake_policy(SET CMP0126 NEW)
93
+ set(CMAKE_POLICY_DEFAULT_CMP0126 NEW)
94
+ endif()
95
+
96
+ # The policy uses the download time for timestamp, instead of the timestamp in the archive. This
97
+ # allows for proper rebuilds when a projects url changes
98
+ if(POLICY CMP0135)
99
+ cmake_policy(SET CMP0135 NEW)
100
+ set(CMAKE_POLICY_DEFAULT_CMP0135 NEW)
101
+ endif()
102
+
103
+ # treat relative git repository paths as being relative to the parent project's remote
104
+ if(POLICY CMP0150)
105
+ cmake_policy(SET CMP0150 NEW)
106
+ set(CMAKE_POLICY_DEFAULT_CMP0150 NEW)
107
+ endif()
108
+ endmacro()
109
+ cpm_set_policies()
110
+
111
+ option(CPM_USE_LOCAL_PACKAGES "Always try to use `find_package` to get dependencies"
112
+ $ENV{CPM_USE_LOCAL_PACKAGES}
113
+ )
114
+ option(CPM_LOCAL_PACKAGES_ONLY "Only use `find_package` to get dependencies"
115
+ $ENV{CPM_LOCAL_PACKAGES_ONLY}
116
+ )
117
+ option(CPM_DOWNLOAD_ALL "Always download dependencies from source" $ENV{CPM_DOWNLOAD_ALL})
118
+ option(CPM_DONT_UPDATE_MODULE_PATH "Don't update the module path to allow using find_package"
119
+ $ENV{CPM_DONT_UPDATE_MODULE_PATH}
120
+ )
121
+ option(CPM_DONT_CREATE_PACKAGE_LOCK "Don't create a package lock file in the binary path"
122
+ $ENV{CPM_DONT_CREATE_PACKAGE_LOCK}
123
+ )
124
+ option(CPM_INCLUDE_ALL_IN_PACKAGE_LOCK
125
+ "Add all packages added through CPM.cmake to the package lock"
126
+ $ENV{CPM_INCLUDE_ALL_IN_PACKAGE_LOCK}
127
+ )
128
+ option(CPM_USE_NAMED_CACHE_DIRECTORIES
129
+ "Use additional directory of package name in cache on the most nested level."
130
+ $ENV{CPM_USE_NAMED_CACHE_DIRECTORIES}
131
+ )
132
+
133
+ set(CPM_VERSION
134
+ ${CURRENT_CPM_VERSION}
135
+ CACHE INTERNAL ""
136
+ )
137
+ set(CPM_DIRECTORY
138
+ ${CPM_CURRENT_DIRECTORY}
139
+ CACHE INTERNAL ""
140
+ )
141
+ set(CPM_FILE
142
+ ${CMAKE_CURRENT_LIST_FILE}
143
+ CACHE INTERNAL ""
144
+ )
145
+ set(CPM_PACKAGES
146
+ ""
147
+ CACHE INTERNAL ""
148
+ )
149
+ set(CPM_DRY_RUN
150
+ OFF
151
+ CACHE INTERNAL "Don't download or configure dependencies (for testing)"
152
+ )
153
+
154
+ if(DEFINED ENV{CPM_SOURCE_CACHE})
155
+ set(CPM_SOURCE_CACHE_DEFAULT $ENV{CPM_SOURCE_CACHE})
156
+ else()
157
+ set(CPM_SOURCE_CACHE_DEFAULT OFF)
158
+ endif()
159
+
160
+ set(CPM_SOURCE_CACHE
161
+ ${CPM_SOURCE_CACHE_DEFAULT}
162
+ CACHE PATH "Directory to download CPM dependencies"
163
+ )
164
+
165
+ if(NOT CPM_DONT_UPDATE_MODULE_PATH)
166
+ set(CPM_MODULE_PATH
167
+ "${CMAKE_BINARY_DIR}/CPM_modules"
168
+ CACHE INTERNAL ""
169
+ )
170
+ # remove old modules
171
+ file(REMOVE_RECURSE ${CPM_MODULE_PATH})
172
+ file(MAKE_DIRECTORY ${CPM_MODULE_PATH})
173
+ # locally added CPM modules should override global packages
174
+ set(CMAKE_MODULE_PATH "${CPM_MODULE_PATH};${CMAKE_MODULE_PATH}")
175
+ endif()
176
+
177
+ if(NOT CPM_DONT_CREATE_PACKAGE_LOCK)
178
+ set(CPM_PACKAGE_LOCK_FILE
179
+ "${CMAKE_BINARY_DIR}/cpm-package-lock.cmake"
180
+ CACHE INTERNAL ""
181
+ )
182
+ file(WRITE ${CPM_PACKAGE_LOCK_FILE}
183
+ "# CPM Package Lock\n# This file should be committed to version control\n\n"
184
+ )
185
+ endif()
186
+
187
+ include(FetchContent)
188
+
189
+ # Try to infer package name from git repository uri (path or url)
190
+ function(cpm_package_name_from_git_uri URI RESULT)
191
+ if("${URI}" MATCHES "([^/:]+)/?.git/?$")
192
+ set(${RESULT}
193
+ ${CMAKE_MATCH_1}
194
+ PARENT_SCOPE
195
+ )
196
+ else()
197
+ unset(${RESULT} PARENT_SCOPE)
198
+ endif()
199
+ endfunction()
200
+
201
+ # Try to infer package name and version from a url
202
+ function(cpm_package_name_and_ver_from_url url outName outVer)
203
+ if(url MATCHES "[/\\?]([a-zA-Z0-9_\\.-]+)\\.(tar|tar\\.gz|tar\\.bz2|zip|ZIP)(\\?|/|$)")
204
+ # We matched an archive
205
+ set(filename "${CMAKE_MATCH_1}")
206
+
207
+ if(filename MATCHES "([a-zA-Z0-9_\\.-]+)[_-]v?(([0-9]+\\.)*[0-9]+[a-zA-Z0-9]*)")
208
+ # We matched <name>-<version> (ie foo-1.2.3)
209
+ set(${outName}
210
+ "${CMAKE_MATCH_1}"
211
+ PARENT_SCOPE
212
+ )
213
+ set(${outVer}
214
+ "${CMAKE_MATCH_2}"
215
+ PARENT_SCOPE
216
+ )
217
+ elseif(filename MATCHES "(([0-9]+\\.)+[0-9]+[a-zA-Z0-9]*)")
218
+ # We couldn't find a name, but we found a version
219
+ #
220
+ # In many cases (which we don't handle here) the url would look something like
221
+ # `irrelevant/ACTUAL_PACKAGE_NAME/irrelevant/1.2.3.zip`. In such a case we can't possibly
222
+ # distinguish the package name from the irrelevant bits. Moreover if we try to match the
223
+ # package name from the filename, we'd get bogus at best.
224
+ unset(${outName} PARENT_SCOPE)
225
+ set(${outVer}
226
+ "${CMAKE_MATCH_1}"
227
+ PARENT_SCOPE
228
+ )
229
+ else()
230
+ # Boldly assume that the file name is the package name.
231
+ #
232
+ # Yes, something like `irrelevant/ACTUAL_NAME/irrelevant/download.zip` will ruin our day, but
233
+ # such cases should be quite rare. No popular service does this... we think.
234
+ set(${outName}
235
+ "${filename}"
236
+ PARENT_SCOPE
237
+ )
238
+ unset(${outVer} PARENT_SCOPE)
239
+ endif()
240
+ else()
241
+ # No ideas yet what to do with non-archives
242
+ unset(${outName} PARENT_SCOPE)
243
+ unset(${outVer} PARENT_SCOPE)
244
+ endif()
245
+ endfunction()
246
+
247
+ function(cpm_find_package NAME VERSION)
248
+ string(REPLACE " " ";" EXTRA_ARGS "${ARGN}")
249
+ find_package(${NAME} ${VERSION} ${EXTRA_ARGS} QUIET)
250
+ if(${CPM_ARGS_NAME}_FOUND)
251
+ if(DEFINED ${CPM_ARGS_NAME}_VERSION)
252
+ set(VERSION ${${CPM_ARGS_NAME}_VERSION})
253
+ endif()
254
+ cpm_message(STATUS "${CPM_INDENT} Using local package ${CPM_ARGS_NAME}@${VERSION}")
255
+ CPMRegisterPackage(${CPM_ARGS_NAME} "${VERSION}")
256
+ set(CPM_PACKAGE_FOUND
257
+ YES
258
+ PARENT_SCOPE
259
+ )
260
+ else()
261
+ set(CPM_PACKAGE_FOUND
262
+ NO
263
+ PARENT_SCOPE
264
+ )
265
+ endif()
266
+ endfunction()
267
+
268
+ # Create a custom FindXXX.cmake module for a CPM package This prevents `find_package(NAME)` from
269
+ # finding the system library
270
+ function(cpm_create_module_file Name)
271
+ if(NOT CPM_DONT_UPDATE_MODULE_PATH)
272
+ # erase any previous modules
273
+ file(WRITE ${CPM_MODULE_PATH}/Find${Name}.cmake
274
+ "include(\"${CPM_FILE}\")\n${ARGN}\nset(${Name}_FOUND TRUE)"
275
+ )
276
+ endif()
277
+ endfunction()
278
+
279
+ # Find a package locally or fallback to CPMAddPackage
280
+ function(CPMFindPackage)
281
+ set(oneValueArgs NAME VERSION GIT_TAG FIND_PACKAGE_ARGUMENTS)
282
+
283
+ cmake_parse_arguments(CPM_ARGS "" "${oneValueArgs}" "" ${ARGN})
284
+
285
+ if(NOT DEFINED CPM_ARGS_VERSION)
286
+ if(DEFINED CPM_ARGS_GIT_TAG)
287
+ cpm_get_version_from_git_tag("${CPM_ARGS_GIT_TAG}" CPM_ARGS_VERSION)
288
+ endif()
289
+ endif()
290
+
291
+ set(downloadPackage ${CPM_DOWNLOAD_ALL})
292
+ if(DEFINED CPM_DOWNLOAD_${CPM_ARGS_NAME})
293
+ set(downloadPackage ${CPM_DOWNLOAD_${CPM_ARGS_NAME}})
294
+ elseif(DEFINED ENV{CPM_DOWNLOAD_${CPM_ARGS_NAME}})
295
+ set(downloadPackage $ENV{CPM_DOWNLOAD_${CPM_ARGS_NAME}})
296
+ endif()
297
+ if(downloadPackage)
298
+ CPMAddPackage(${ARGN})
299
+ cpm_export_variables(${CPM_ARGS_NAME})
300
+ return()
301
+ endif()
302
+
303
+ cpm_find_package(${CPM_ARGS_NAME} "${CPM_ARGS_VERSION}" ${CPM_ARGS_FIND_PACKAGE_ARGUMENTS})
304
+
305
+ if(NOT CPM_PACKAGE_FOUND)
306
+ CPMAddPackage(${ARGN})
307
+ cpm_export_variables(${CPM_ARGS_NAME})
308
+ endif()
309
+
310
+ endfunction()
311
+
312
+ # checks if a package has been added before
313
+ function(cpm_check_if_package_already_added CPM_ARGS_NAME CPM_ARGS_VERSION)
314
+ if("${CPM_ARGS_NAME}" IN_LIST CPM_PACKAGES)
315
+ CPMGetPackageVersion(${CPM_ARGS_NAME} CPM_PACKAGE_VERSION)
316
+ if("${CPM_PACKAGE_VERSION}" VERSION_LESS "${CPM_ARGS_VERSION}")
317
+ message(
318
+ WARNING
319
+ "${CPM_INDENT} Requires a newer version of ${CPM_ARGS_NAME} (${CPM_ARGS_VERSION}) than currently included (${CPM_PACKAGE_VERSION})."
320
+ )
321
+ endif()
322
+ cpm_get_fetch_properties(${CPM_ARGS_NAME})
323
+ set(${CPM_ARGS_NAME}_ADDED NO)
324
+ set(CPM_PACKAGE_ALREADY_ADDED
325
+ YES
326
+ PARENT_SCOPE
327
+ )
328
+ cpm_export_variables(${CPM_ARGS_NAME})
329
+ else()
330
+ set(CPM_PACKAGE_ALREADY_ADDED
331
+ NO
332
+ PARENT_SCOPE
333
+ )
334
+ endif()
335
+ endfunction()
336
+
337
+ # Parse the argument of CPMAddPackage in case a single one was provided and convert it to a list of
338
+ # arguments which can then be parsed idiomatically. For example gh:foo/bar@1.2.3 will be converted
339
+ # to: GITHUB_REPOSITORY;foo/bar;VERSION;1.2.3
340
+ function(cpm_parse_add_package_single_arg arg outArgs)
341
+ # Look for a scheme
342
+ if("${arg}" MATCHES "^([a-zA-Z]+):(.+)$")
343
+ string(TOLOWER "${CMAKE_MATCH_1}" scheme)
344
+ set(uri "${CMAKE_MATCH_2}")
345
+
346
+ # Check for CPM-specific schemes
347
+ if(scheme STREQUAL "gh")
348
+ set(out "GITHUB_REPOSITORY;${uri}")
349
+ set(packageType "git")
350
+ elseif(scheme STREQUAL "gl")
351
+ set(out "GITLAB_REPOSITORY;${uri}")
352
+ set(packageType "git")
353
+ elseif(scheme STREQUAL "bb")
354
+ set(out "BITBUCKET_REPOSITORY;${uri}")
355
+ set(packageType "git")
356
+ # A CPM-specific scheme was not found. Looks like this is a generic URL so try to determine
357
+ # type
358
+ elseif(arg MATCHES ".git/?(@|#|$)")
359
+ set(out "GIT_REPOSITORY;${arg}")
360
+ set(packageType "git")
361
+ else()
362
+ # Fall back to a URL
363
+ set(out "URL;${arg}")
364
+ set(packageType "archive")
365
+
366
+ # We could also check for SVN since FetchContent supports it, but SVN is so rare these days.
367
+ # We just won't bother with the additional complexity it will induce in this function. SVN is
368
+ # done by multi-arg
369
+ endif()
370
+ else()
371
+ if(arg MATCHES ".git/?(@|#|$)")
372
+ set(out "GIT_REPOSITORY;${arg}")
373
+ set(packageType "git")
374
+ else()
375
+ # Give up
376
+ message(FATAL_ERROR "${CPM_INDENT} Can't determine package type of '${arg}'")
377
+ endif()
378
+ endif()
379
+
380
+ # For all packages we interpret @... as version. Only replace the last occurrence. Thus URIs
381
+ # containing '@' can be used
382
+ string(REGEX REPLACE "@([^@]+)$" ";VERSION;\\1" out "${out}")
383
+
384
+ # Parse the rest according to package type
385
+ if(packageType STREQUAL "git")
386
+ # For git repos we interpret #... as a tag or branch or commit hash
387
+ string(REGEX REPLACE "#([^#]+)$" ";GIT_TAG;\\1" out "${out}")
388
+ elseif(packageType STREQUAL "archive")
389
+ # For archives we interpret #... as a URL hash.
390
+ string(REGEX REPLACE "#([^#]+)$" ";URL_HASH;\\1" out "${out}")
391
+ # We don't try to parse the version if it's not provided explicitly. cpm_get_version_from_url
392
+ # should do this at a later point
393
+ else()
394
+ # We should never get here. This is an assertion and hitting it means there's a problem with the
395
+ # code above. A packageType was set, but not handled by this if-else.
396
+ message(FATAL_ERROR "${CPM_INDENT} Unsupported package type '${packageType}' of '${arg}'")
397
+ endif()
398
+
399
+ set(${outArgs}
400
+ ${out}
401
+ PARENT_SCOPE
402
+ )
403
+ endfunction()
404
+
405
+ # Check that the working directory for a git repo is clean
406
+ function(cpm_check_git_working_dir_is_clean repoPath gitTag isClean)
407
+
408
+ find_package(Git REQUIRED)
409
+
410
+ if(NOT GIT_EXECUTABLE)
411
+ # No git executable, assume directory is clean
412
+ set(${isClean}
413
+ TRUE
414
+ PARENT_SCOPE
415
+ )
416
+ return()
417
+ endif()
418
+
419
+ # check for uncommitted changes
420
+ execute_process(
421
+ COMMAND ${GIT_EXECUTABLE} status --porcelain
422
+ RESULT_VARIABLE resultGitStatus
423
+ OUTPUT_VARIABLE repoStatus
424
+ OUTPUT_STRIP_TRAILING_WHITESPACE ERROR_QUIET
425
+ WORKING_DIRECTORY ${repoPath}
426
+ )
427
+ if(resultGitStatus)
428
+ # not supposed to happen, assume clean anyway
429
+ message(WARNING "${CPM_INDENT} Calling git status on folder ${repoPath} failed")
430
+ set(${isClean}
431
+ TRUE
432
+ PARENT_SCOPE
433
+ )
434
+ return()
435
+ endif()
436
+
437
+ if(NOT "${repoStatus}" STREQUAL "")
438
+ set(${isClean}
439
+ FALSE
440
+ PARENT_SCOPE
441
+ )
442
+ return()
443
+ endif()
444
+
445
+ # check for committed changes
446
+ execute_process(
447
+ COMMAND ${GIT_EXECUTABLE} diff -s --exit-code ${gitTag}
448
+ RESULT_VARIABLE resultGitDiff
449
+ OUTPUT_STRIP_TRAILING_WHITESPACE OUTPUT_QUIET
450
+ WORKING_DIRECTORY ${repoPath}
451
+ )
452
+
453
+ if(${resultGitDiff} EQUAL 0)
454
+ set(${isClean}
455
+ TRUE
456
+ PARENT_SCOPE
457
+ )
458
+ else()
459
+ set(${isClean}
460
+ FALSE
461
+ PARENT_SCOPE
462
+ )
463
+ endif()
464
+
465
+ endfunction()
466
+
467
+ # Add PATCH_COMMAND to CPM_ARGS_UNPARSED_ARGUMENTS. This method consumes a list of files in ARGN
468
+ # then generates a `PATCH_COMMAND` appropriate for `ExternalProject_Add()`. This command is appended
469
+ # to the parent scope's `CPM_ARGS_UNPARSED_ARGUMENTS`.
470
+ function(cpm_add_patches)
471
+ # Return if no patch files are supplied.
472
+ if(NOT ARGN)
473
+ return()
474
+ endif()
475
+
476
+ # Find the patch program.
477
+ find_program(PATCH_EXECUTABLE patch)
478
+ if(WIN32 AND NOT PATCH_EXECUTABLE)
479
+ # The Windows git executable is distributed with patch.exe. Find the path to the executable, if
480
+ # it exists, then search `../../usr/bin` for patch.exe.
481
+ find_package(Git QUIET)
482
+ if(GIT_EXECUTABLE)
483
+ get_filename_component(extra_search_path ${GIT_EXECUTABLE} DIRECTORY)
484
+ get_filename_component(extra_search_path ${extra_search_path} DIRECTORY)
485
+ get_filename_component(extra_search_path ${extra_search_path} DIRECTORY)
486
+ find_program(PATCH_EXECUTABLE patch HINTS "${extra_search_path}/usr/bin")
487
+ endif()
488
+ endif()
489
+ if(NOT PATCH_EXECUTABLE)
490
+ message(FATAL_ERROR "Couldn't find `patch` executable to use with PATCHES keyword.")
491
+ endif()
492
+
493
+ # Create a temporary
494
+ set(temp_list ${CPM_ARGS_UNPARSED_ARGUMENTS})
495
+
496
+ # Ensure each file exists (or error out) and add it to the list.
497
+ set(first_item True)
498
+ foreach(PATCH_FILE ${ARGN})
499
+ # Make sure the patch file exists, if we can't find it, try again in the current directory.
500
+ if(NOT EXISTS "${PATCH_FILE}")
501
+ if(NOT EXISTS "${CMAKE_CURRENT_LIST_DIR}/${PATCH_FILE}")
502
+ message(FATAL_ERROR "Couldn't find patch file: '${PATCH_FILE}'")
503
+ endif()
504
+ set(PATCH_FILE "${CMAKE_CURRENT_LIST_DIR}/${PATCH_FILE}")
505
+ endif()
506
+
507
+ # Convert to absolute path for use with patch file command.
508
+ get_filename_component(PATCH_FILE "${PATCH_FILE}" ABSOLUTE)
509
+
510
+ # The first patch entry must be preceded by "PATCH_COMMAND" while the following items are
511
+ # preceded by "&&".
512
+ if(first_item)
513
+ set(first_item False)
514
+ list(APPEND temp_list "PATCH_COMMAND")
515
+ else()
516
+ list(APPEND temp_list "&&")
517
+ endif()
518
+ # Add the patch command to the list
519
+ list(APPEND temp_list "${PATCH_EXECUTABLE}" "-p1" "<" "${PATCH_FILE}")
520
+ endforeach()
521
+
522
+ # Move temp out into parent scope.
523
+ set(CPM_ARGS_UNPARSED_ARGUMENTS
524
+ ${temp_list}
525
+ PARENT_SCOPE
526
+ )
527
+
528
+ endfunction()
529
+
530
+ # method to overwrite internal FetchContent properties, to allow using CPM.cmake to overload
531
+ # FetchContent calls. As these are internal cmake properties, this method should be used carefully
532
+ # and may need modification in future CMake versions. Source:
533
+ # https://github.com/Kitware/CMake/blob/dc3d0b5a0a7d26d43d6cfeb511e224533b5d188f/Modules/FetchContent.cmake#L1152
534
+ function(cpm_override_fetchcontent contentName)
535
+ cmake_parse_arguments(PARSE_ARGV 1 arg "" "SOURCE_DIR;BINARY_DIR" "")
536
+ if(NOT "${arg_UNPARSED_ARGUMENTS}" STREQUAL "")
537
+ message(FATAL_ERROR "${CPM_INDENT} Unsupported arguments: ${arg_UNPARSED_ARGUMENTS}")
538
+ endif()
539
+
540
+ string(TOLOWER ${contentName} contentNameLower)
541
+ set(prefix "_FetchContent_${contentNameLower}")
542
+
543
+ set(propertyName "${prefix}_sourceDir")
544
+ define_property(
545
+ GLOBAL
546
+ PROPERTY ${propertyName}
547
+ BRIEF_DOCS "Internal implementation detail of FetchContent_Populate()"
548
+ FULL_DOCS "Details used by FetchContent_Populate() for ${contentName}"
549
+ )
550
+ set_property(GLOBAL PROPERTY ${propertyName} "${arg_SOURCE_DIR}")
551
+
552
+ set(propertyName "${prefix}_binaryDir")
553
+ define_property(
554
+ GLOBAL
555
+ PROPERTY ${propertyName}
556
+ BRIEF_DOCS "Internal implementation detail of FetchContent_Populate()"
557
+ FULL_DOCS "Details used by FetchContent_Populate() for ${contentName}"
558
+ )
559
+ set_property(GLOBAL PROPERTY ${propertyName} "${arg_BINARY_DIR}")
560
+
561
+ set(propertyName "${prefix}_populated")
562
+ define_property(
563
+ GLOBAL
564
+ PROPERTY ${propertyName}
565
+ BRIEF_DOCS "Internal implementation detail of FetchContent_Populate()"
566
+ FULL_DOCS "Details used by FetchContent_Populate() for ${contentName}"
567
+ )
568
+ set_property(GLOBAL PROPERTY ${propertyName} TRUE)
569
+ endfunction()
570
+
571
+ # Download and add a package from source
572
+ function(CPMAddPackage)
573
+ cpm_set_policies()
574
+
575
+ list(LENGTH ARGN argnLength)
576
+ if(argnLength EQUAL 1)
577
+ cpm_parse_add_package_single_arg("${ARGN}" ARGN)
578
+
579
+ # The shorthand syntax implies EXCLUDE_FROM_ALL and SYSTEM
580
+ set(ARGN "${ARGN};EXCLUDE_FROM_ALL;YES;SYSTEM;YES;")
581
+ endif()
582
+
583
+ set(oneValueArgs
584
+ NAME
585
+ FORCE
586
+ VERSION
587
+ GIT_TAG
588
+ DOWNLOAD_ONLY
589
+ GITHUB_REPOSITORY
590
+ GITLAB_REPOSITORY
591
+ BITBUCKET_REPOSITORY
592
+ GIT_REPOSITORY
593
+ SOURCE_DIR
594
+ FIND_PACKAGE_ARGUMENTS
595
+ NO_CACHE
596
+ SYSTEM
597
+ GIT_SHALLOW
598
+ EXCLUDE_FROM_ALL
599
+ SOURCE_SUBDIR
600
+ CUSTOM_CACHE_KEY
601
+ )
602
+
603
+ set(multiValueArgs URL OPTIONS DOWNLOAD_COMMAND PATCHES)
604
+
605
+ cmake_parse_arguments(CPM_ARGS "" "${oneValueArgs}" "${multiValueArgs}" "${ARGN}")
606
+
607
+ # Set default values for arguments
608
+
609
+ if(NOT DEFINED CPM_ARGS_VERSION)
610
+ if(DEFINED CPM_ARGS_GIT_TAG)
611
+ cpm_get_version_from_git_tag("${CPM_ARGS_GIT_TAG}" CPM_ARGS_VERSION)
612
+ endif()
613
+ endif()
614
+
615
+ if(CPM_ARGS_DOWNLOAD_ONLY)
616
+ set(DOWNLOAD_ONLY ${CPM_ARGS_DOWNLOAD_ONLY})
617
+ else()
618
+ set(DOWNLOAD_ONLY NO)
619
+ endif()
620
+
621
+ if(DEFINED CPM_ARGS_GITHUB_REPOSITORY)
622
+ set(CPM_ARGS_GIT_REPOSITORY "https://github.com/${CPM_ARGS_GITHUB_REPOSITORY}.git")
623
+ elseif(DEFINED CPM_ARGS_GITLAB_REPOSITORY)
624
+ set(CPM_ARGS_GIT_REPOSITORY "https://gitlab.com/${CPM_ARGS_GITLAB_REPOSITORY}.git")
625
+ elseif(DEFINED CPM_ARGS_BITBUCKET_REPOSITORY)
626
+ set(CPM_ARGS_GIT_REPOSITORY "https://bitbucket.org/${CPM_ARGS_BITBUCKET_REPOSITORY}.git")
627
+ endif()
628
+
629
+ if(DEFINED CPM_ARGS_GIT_REPOSITORY)
630
+ list(APPEND CPM_ARGS_UNPARSED_ARGUMENTS GIT_REPOSITORY ${CPM_ARGS_GIT_REPOSITORY})
631
+ if(NOT DEFINED CPM_ARGS_GIT_TAG)
632
+ set(CPM_ARGS_GIT_TAG v${CPM_ARGS_VERSION})
633
+ endif()
634
+
635
+ # If a name wasn't provided, try to infer it from the git repo
636
+ if(NOT DEFINED CPM_ARGS_NAME)
637
+ cpm_package_name_from_git_uri(${CPM_ARGS_GIT_REPOSITORY} CPM_ARGS_NAME)
638
+ endif()
639
+ endif()
640
+
641
+ set(CPM_SKIP_FETCH FALSE)
642
+
643
+ if(DEFINED CPM_ARGS_GIT_TAG)
644
+ list(APPEND CPM_ARGS_UNPARSED_ARGUMENTS GIT_TAG ${CPM_ARGS_GIT_TAG})
645
+ # If GIT_SHALLOW is explicitly specified, honor the value.
646
+ if(DEFINED CPM_ARGS_GIT_SHALLOW)
647
+ list(APPEND CPM_ARGS_UNPARSED_ARGUMENTS GIT_SHALLOW ${CPM_ARGS_GIT_SHALLOW})
648
+ endif()
649
+ endif()
650
+
651
+ if(DEFINED CPM_ARGS_URL)
652
+ # If a name or version aren't provided, try to infer them from the URL
653
+ list(GET CPM_ARGS_URL 0 firstUrl)
654
+ cpm_package_name_and_ver_from_url(${firstUrl} nameFromUrl verFromUrl)
655
+ # If we fail to obtain name and version from the first URL, we could try other URLs if any.
656
+ # However multiple URLs are expected to be quite rare, so for now we won't bother.
657
+
658
+ # If the caller provided their own name and version, they trump the inferred ones.
659
+ if(NOT DEFINED CPM_ARGS_NAME)
660
+ set(CPM_ARGS_NAME ${nameFromUrl})
661
+ endif()
662
+ if(NOT DEFINED CPM_ARGS_VERSION)
663
+ set(CPM_ARGS_VERSION ${verFromUrl})
664
+ endif()
665
+
666
+ list(APPEND CPM_ARGS_UNPARSED_ARGUMENTS URL "${CPM_ARGS_URL}")
667
+ endif()
668
+
669
+ # Check for required arguments
670
+
671
+ if(NOT DEFINED CPM_ARGS_NAME)
672
+ message(
673
+ FATAL_ERROR
674
+ "${CPM_INDENT} 'NAME' was not provided and couldn't be automatically inferred for package added with arguments: '${ARGN}'"
675
+ )
676
+ endif()
677
+
678
+ # Check if package has been added before
679
+ cpm_check_if_package_already_added(${CPM_ARGS_NAME} "${CPM_ARGS_VERSION}")
680
+ if(CPM_PACKAGE_ALREADY_ADDED)
681
+ cpm_export_variables(${CPM_ARGS_NAME})
682
+ return()
683
+ endif()
684
+
685
+ # Check for manual overrides
686
+ if(NOT CPM_ARGS_FORCE AND NOT "${CPM_${CPM_ARGS_NAME}_SOURCE}" STREQUAL "")
687
+ set(PACKAGE_SOURCE ${CPM_${CPM_ARGS_NAME}_SOURCE})
688
+ set(CPM_${CPM_ARGS_NAME}_SOURCE "")
689
+ CPMAddPackage(
690
+ NAME "${CPM_ARGS_NAME}"
691
+ SOURCE_DIR "${PACKAGE_SOURCE}"
692
+ EXCLUDE_FROM_ALL "${CPM_ARGS_EXCLUDE_FROM_ALL}"
693
+ SYSTEM "${CPM_ARGS_SYSTEM}"
694
+ PATCHES "${CPM_ARGS_PATCHES}"
695
+ OPTIONS "${CPM_ARGS_OPTIONS}"
696
+ SOURCE_SUBDIR "${CPM_ARGS_SOURCE_SUBDIR}"
697
+ DOWNLOAD_ONLY "${DOWNLOAD_ONLY}"
698
+ FORCE True
699
+ )
700
+ cpm_export_variables(${CPM_ARGS_NAME})
701
+ return()
702
+ endif()
703
+
704
+ # Check for available declaration
705
+ if(NOT CPM_ARGS_FORCE AND NOT "${CPM_DECLARATION_${CPM_ARGS_NAME}}" STREQUAL "")
706
+ set(declaration ${CPM_DECLARATION_${CPM_ARGS_NAME}})
707
+ set(CPM_DECLARATION_${CPM_ARGS_NAME} "")
708
+ CPMAddPackage(${declaration})
709
+ cpm_export_variables(${CPM_ARGS_NAME})
710
+ # checking again to ensure version and option compatibility
711
+ cpm_check_if_package_already_added(${CPM_ARGS_NAME} "${CPM_ARGS_VERSION}")
712
+ return()
713
+ endif()
714
+
715
+ if(NOT CPM_ARGS_FORCE)
716
+ if(CPM_USE_LOCAL_PACKAGES OR CPM_LOCAL_PACKAGES_ONLY)
717
+ cpm_find_package(${CPM_ARGS_NAME} "${CPM_ARGS_VERSION}" ${CPM_ARGS_FIND_PACKAGE_ARGUMENTS})
718
+
719
+ if(CPM_PACKAGE_FOUND)
720
+ cpm_export_variables(${CPM_ARGS_NAME})
721
+ return()
722
+ endif()
723
+
724
+ if(CPM_LOCAL_PACKAGES_ONLY)
725
+ message(
726
+ SEND_ERROR
727
+ "${CPM_INDENT} ${CPM_ARGS_NAME} not found via find_package(${CPM_ARGS_NAME} ${CPM_ARGS_VERSION})"
728
+ )
729
+ endif()
730
+ endif()
731
+ endif()
732
+
733
+ CPMRegisterPackage("${CPM_ARGS_NAME}" "${CPM_ARGS_VERSION}")
734
+
735
+ if(DEFINED CPM_ARGS_GIT_TAG)
736
+ set(PACKAGE_INFO "${CPM_ARGS_GIT_TAG}")
737
+ elseif(DEFINED CPM_ARGS_SOURCE_DIR)
738
+ set(PACKAGE_INFO "${CPM_ARGS_SOURCE_DIR}")
739
+ else()
740
+ set(PACKAGE_INFO "${CPM_ARGS_VERSION}")
741
+ endif()
742
+
743
+ if(DEFINED FETCHCONTENT_BASE_DIR)
744
+ # respect user's FETCHCONTENT_BASE_DIR if set
745
+ set(CPM_FETCHCONTENT_BASE_DIR ${FETCHCONTENT_BASE_DIR})
746
+ else()
747
+ set(CPM_FETCHCONTENT_BASE_DIR ${CMAKE_BINARY_DIR}/_deps)
748
+ endif()
749
+
750
+ cpm_add_patches(${CPM_ARGS_PATCHES})
751
+
752
+ if(DEFINED CPM_ARGS_DOWNLOAD_COMMAND)
753
+ list(APPEND CPM_ARGS_UNPARSED_ARGUMENTS DOWNLOAD_COMMAND ${CPM_ARGS_DOWNLOAD_COMMAND})
754
+ elseif(DEFINED CPM_ARGS_SOURCE_DIR)
755
+ list(APPEND CPM_ARGS_UNPARSED_ARGUMENTS SOURCE_DIR ${CPM_ARGS_SOURCE_DIR})
756
+ if(NOT IS_ABSOLUTE ${CPM_ARGS_SOURCE_DIR})
757
+ # Expand `CPM_ARGS_SOURCE_DIR` relative path. This is important because EXISTS doesn't work
758
+ # for relative paths.
759
+ get_filename_component(
760
+ source_directory ${CPM_ARGS_SOURCE_DIR} REALPATH BASE_DIR ${CMAKE_CURRENT_BINARY_DIR}
761
+ )
762
+ else()
763
+ set(source_directory ${CPM_ARGS_SOURCE_DIR})
764
+ endif()
765
+ if(NOT EXISTS ${source_directory})
766
+ string(TOLOWER ${CPM_ARGS_NAME} lower_case_name)
767
+ # remove timestamps so CMake will re-download the dependency
768
+ file(REMOVE_RECURSE "${CPM_FETCHCONTENT_BASE_DIR}/${lower_case_name}-subbuild")
769
+ endif()
770
+ elseif(CPM_SOURCE_CACHE AND NOT CPM_ARGS_NO_CACHE)
771
+ string(TOLOWER ${CPM_ARGS_NAME} lower_case_name)
772
+ set(origin_parameters ${CPM_ARGS_UNPARSED_ARGUMENTS})
773
+ list(SORT origin_parameters)
774
+ if(CPM_ARGS_CUSTOM_CACHE_KEY)
775
+ # Application set a custom unique directory name
776
+ set(download_directory ${CPM_SOURCE_CACHE}/${lower_case_name}/${CPM_ARGS_CUSTOM_CACHE_KEY})
777
+ elseif(CPM_USE_NAMED_CACHE_DIRECTORIES)
778
+ string(SHA1 origin_hash "${origin_parameters};NEW_CACHE_STRUCTURE_TAG")
779
+ set(download_directory ${CPM_SOURCE_CACHE}/${lower_case_name}/${origin_hash}/${CPM_ARGS_NAME})
780
+ else()
781
+ string(SHA1 origin_hash "${origin_parameters}")
782
+ set(download_directory ${CPM_SOURCE_CACHE}/${lower_case_name}/${origin_hash})
783
+ endif()
784
+ # Expand `download_directory` relative path. This is important because EXISTS doesn't work for
785
+ # relative paths.
786
+ get_filename_component(download_directory ${download_directory} ABSOLUTE)
787
+ list(APPEND CPM_ARGS_UNPARSED_ARGUMENTS SOURCE_DIR ${download_directory})
788
+
789
+ if(CPM_SOURCE_CACHE)
790
+ file(LOCK ${download_directory}/../cmake.lock)
791
+ endif()
792
+
793
+ if(EXISTS ${download_directory})
794
+ if(CPM_SOURCE_CACHE)
795
+ file(LOCK ${download_directory}/../cmake.lock RELEASE)
796
+ endif()
797
+
798
+ cpm_store_fetch_properties(
799
+ ${CPM_ARGS_NAME} "${download_directory}"
800
+ "${CPM_FETCHCONTENT_BASE_DIR}/${lower_case_name}-build"
801
+ )
802
+ cpm_get_fetch_properties("${CPM_ARGS_NAME}")
803
+
804
+ if(DEFINED CPM_ARGS_GIT_TAG AND NOT (PATCH_COMMAND IN_LIST CPM_ARGS_UNPARSED_ARGUMENTS))
805
+ # warn if cache has been changed since checkout
806
+ cpm_check_git_working_dir_is_clean(${download_directory} ${CPM_ARGS_GIT_TAG} IS_CLEAN)
807
+ if(NOT ${IS_CLEAN})
808
+ message(
809
+ WARNING "${CPM_INDENT} Cache for ${CPM_ARGS_NAME} (${download_directory}) is dirty"
810
+ )
811
+ endif()
812
+ endif()
813
+
814
+ cpm_add_subdirectory(
815
+ "${CPM_ARGS_NAME}"
816
+ "${DOWNLOAD_ONLY}"
817
+ "${${CPM_ARGS_NAME}_SOURCE_DIR}/${CPM_ARGS_SOURCE_SUBDIR}"
818
+ "${${CPM_ARGS_NAME}_BINARY_DIR}"
819
+ "${CPM_ARGS_EXCLUDE_FROM_ALL}"
820
+ "${CPM_ARGS_SYSTEM}"
821
+ "${CPM_ARGS_OPTIONS}"
822
+ )
823
+ set(PACKAGE_INFO "${PACKAGE_INFO} at ${download_directory}")
824
+
825
+ # As the source dir is already cached/populated, we override the call to FetchContent.
826
+ set(CPM_SKIP_FETCH TRUE)
827
+ cpm_override_fetchcontent(
828
+ "${lower_case_name}" SOURCE_DIR "${${CPM_ARGS_NAME}_SOURCE_DIR}/${CPM_ARGS_SOURCE_SUBDIR}"
829
+ BINARY_DIR "${${CPM_ARGS_NAME}_BINARY_DIR}"
830
+ )
831
+
832
+ else()
833
+ # Enable shallow clone when GIT_TAG is not a commit hash. Our guess may not be accurate, but
834
+ # it should guarantee no commit hash get mis-detected.
835
+ if(NOT DEFINED CPM_ARGS_GIT_SHALLOW)
836
+ cpm_is_git_tag_commit_hash("${CPM_ARGS_GIT_TAG}" IS_HASH)
837
+ if(NOT ${IS_HASH})
838
+ list(APPEND CPM_ARGS_UNPARSED_ARGUMENTS GIT_SHALLOW TRUE)
839
+ endif()
840
+ endif()
841
+
842
+ # remove timestamps so CMake will re-download the dependency
843
+ file(REMOVE_RECURSE ${CPM_FETCHCONTENT_BASE_DIR}/${lower_case_name}-subbuild)
844
+ set(PACKAGE_INFO "${PACKAGE_INFO} to ${download_directory}")
845
+ endif()
846
+ endif()
847
+
848
+ cpm_create_module_file(${CPM_ARGS_NAME} "CPMAddPackage(\"${ARGN}\")")
849
+
850
+ if(CPM_PACKAGE_LOCK_ENABLED)
851
+ if((CPM_ARGS_VERSION AND NOT CPM_ARGS_SOURCE_DIR) OR CPM_INCLUDE_ALL_IN_PACKAGE_LOCK)
852
+ cpm_add_to_package_lock(${CPM_ARGS_NAME} "${ARGN}")
853
+ elseif(CPM_ARGS_SOURCE_DIR)
854
+ cpm_add_comment_to_package_lock(${CPM_ARGS_NAME} "local directory")
855
+ else()
856
+ cpm_add_comment_to_package_lock(${CPM_ARGS_NAME} "${ARGN}")
857
+ endif()
858
+ endif()
859
+
860
+ cpm_message(
861
+ STATUS "${CPM_INDENT} Adding package ${CPM_ARGS_NAME}@${CPM_ARGS_VERSION} (${PACKAGE_INFO})"
862
+ )
863
+
864
+ if(NOT CPM_SKIP_FETCH)
865
+ cpm_declare_fetch(
866
+ "${CPM_ARGS_NAME}" "${CPM_ARGS_VERSION}" "${PACKAGE_INFO}" "${CPM_ARGS_UNPARSED_ARGUMENTS}"
867
+ )
868
+ cpm_fetch_package("${CPM_ARGS_NAME}" populated)
869
+ if(CPM_SOURCE_CACHE AND download_directory)
870
+ file(LOCK ${download_directory}/../cmake.lock RELEASE)
871
+ endif()
872
+ if(${populated})
873
+ cpm_add_subdirectory(
874
+ "${CPM_ARGS_NAME}"
875
+ "${DOWNLOAD_ONLY}"
876
+ "${${CPM_ARGS_NAME}_SOURCE_DIR}/${CPM_ARGS_SOURCE_SUBDIR}"
877
+ "${${CPM_ARGS_NAME}_BINARY_DIR}"
878
+ "${CPM_ARGS_EXCLUDE_FROM_ALL}"
879
+ "${CPM_ARGS_SYSTEM}"
880
+ "${CPM_ARGS_OPTIONS}"
881
+ )
882
+ endif()
883
+ cpm_get_fetch_properties("${CPM_ARGS_NAME}")
884
+ endif()
885
+
886
+ set(${CPM_ARGS_NAME}_ADDED YES)
887
+ cpm_export_variables("${CPM_ARGS_NAME}")
888
+ endfunction()
889
+
890
+ # Fetch a previously declared package
891
+ macro(CPMGetPackage Name)
892
+ if(DEFINED "CPM_DECLARATION_${Name}")
893
+ CPMAddPackage(NAME ${Name})
894
+ else()
895
+ message(SEND_ERROR "${CPM_INDENT} Cannot retrieve package ${Name}: no declaration available")
896
+ endif()
897
+ endmacro()
898
+
899
+ # export variables available to the caller to the parent scope expects ${CPM_ARGS_NAME} to be set
900
+ macro(cpm_export_variables name)
901
+ set(${name}_SOURCE_DIR
902
+ "${${name}_SOURCE_DIR}"
903
+ PARENT_SCOPE
904
+ )
905
+ set(${name}_BINARY_DIR
906
+ "${${name}_BINARY_DIR}"
907
+ PARENT_SCOPE
908
+ )
909
+ set(${name}_ADDED
910
+ "${${name}_ADDED}"
911
+ PARENT_SCOPE
912
+ )
913
+ set(CPM_LAST_PACKAGE_NAME
914
+ "${name}"
915
+ PARENT_SCOPE
916
+ )
917
+ endmacro()
918
+
919
+ # declares a package, so that any call to CPMAddPackage for the package name will use these
920
+ # arguments instead. Previous declarations will not be overridden.
921
+ macro(CPMDeclarePackage Name)
922
+ if(NOT DEFINED "CPM_DECLARATION_${Name}")
923
+ set("CPM_DECLARATION_${Name}" "${ARGN}")
924
+ endif()
925
+ endmacro()
926
+
927
+ function(cpm_add_to_package_lock Name)
928
+ if(NOT CPM_DONT_CREATE_PACKAGE_LOCK)
929
+ cpm_prettify_package_arguments(PRETTY_ARGN false ${ARGN})
930
+ file(APPEND ${CPM_PACKAGE_LOCK_FILE} "# ${Name}\nCPMDeclarePackage(${Name}\n${PRETTY_ARGN})\n")
931
+ endif()
932
+ endfunction()
933
+
934
+ function(cpm_add_comment_to_package_lock Name)
935
+ if(NOT CPM_DONT_CREATE_PACKAGE_LOCK)
936
+ cpm_prettify_package_arguments(PRETTY_ARGN true ${ARGN})
937
+ file(APPEND ${CPM_PACKAGE_LOCK_FILE}
938
+ "# ${Name} (unversioned)\n# CPMDeclarePackage(${Name}\n${PRETTY_ARGN}#)\n"
939
+ )
940
+ endif()
941
+ endfunction()
942
+
943
+ # includes the package lock file if it exists and creates a target `cpm-update-package-lock` to
944
+ # update it
945
+ macro(CPMUsePackageLock file)
946
+ if(NOT CPM_DONT_CREATE_PACKAGE_LOCK)
947
+ get_filename_component(CPM_ABSOLUTE_PACKAGE_LOCK_PATH ${file} ABSOLUTE)
948
+ if(EXISTS ${CPM_ABSOLUTE_PACKAGE_LOCK_PATH})
949
+ include(${CPM_ABSOLUTE_PACKAGE_LOCK_PATH})
950
+ endif()
951
+ if(NOT TARGET cpm-update-package-lock)
952
+ add_custom_target(
953
+ cpm-update-package-lock COMMAND ${CMAKE_COMMAND} -E copy ${CPM_PACKAGE_LOCK_FILE}
954
+ ${CPM_ABSOLUTE_PACKAGE_LOCK_PATH}
955
+ )
956
+ endif()
957
+ set(CPM_PACKAGE_LOCK_ENABLED true)
958
+ endif()
959
+ endmacro()
960
+
961
+ # registers a package that has been added to CPM
962
+ function(CPMRegisterPackage PACKAGE VERSION)
963
+ list(APPEND CPM_PACKAGES ${PACKAGE})
964
+ set(CPM_PACKAGES
965
+ ${CPM_PACKAGES}
966
+ CACHE INTERNAL ""
967
+ )
968
+ set("CPM_PACKAGE_${PACKAGE}_VERSION"
969
+ ${VERSION}
970
+ CACHE INTERNAL ""
971
+ )
972
+ endfunction()
973
+
974
+ # retrieve the current version of the package to ${OUTPUT}
975
+ function(CPMGetPackageVersion PACKAGE OUTPUT)
976
+ set(${OUTPUT}
977
+ "${CPM_PACKAGE_${PACKAGE}_VERSION}"
978
+ PARENT_SCOPE
979
+ )
980
+ endfunction()
981
+
982
+ # declares a package in FetchContent_Declare
983
+ function(cpm_declare_fetch PACKAGE VERSION INFO)
984
+ if(${CPM_DRY_RUN})
985
+ cpm_message(STATUS "${CPM_INDENT} Package not declared (dry run)")
986
+ return()
987
+ endif()
988
+
989
+ FetchContent_Declare(${PACKAGE} ${ARGN})
990
+ endfunction()
991
+
992
+ # returns properties for a package previously defined by cpm_declare_fetch
993
+ function(cpm_get_fetch_properties PACKAGE)
994
+ if(${CPM_DRY_RUN})
995
+ return()
996
+ endif()
997
+
998
+ set(${PACKAGE}_SOURCE_DIR
999
+ "${CPM_PACKAGE_${PACKAGE}_SOURCE_DIR}"
1000
+ PARENT_SCOPE
1001
+ )
1002
+ set(${PACKAGE}_BINARY_DIR
1003
+ "${CPM_PACKAGE_${PACKAGE}_BINARY_DIR}"
1004
+ PARENT_SCOPE
1005
+ )
1006
+ endfunction()
1007
+
1008
+ function(cpm_store_fetch_properties PACKAGE source_dir binary_dir)
1009
+ if(${CPM_DRY_RUN})
1010
+ return()
1011
+ endif()
1012
+
1013
+ set(CPM_PACKAGE_${PACKAGE}_SOURCE_DIR
1014
+ "${source_dir}"
1015
+ CACHE INTERNAL ""
1016
+ )
1017
+ set(CPM_PACKAGE_${PACKAGE}_BINARY_DIR
1018
+ "${binary_dir}"
1019
+ CACHE INTERNAL ""
1020
+ )
1021
+ endfunction()
1022
+
1023
+ # adds a package as a subdirectory if viable, according to provided options
1024
+ function(
1025
+ cpm_add_subdirectory
1026
+ PACKAGE
1027
+ DOWNLOAD_ONLY
1028
+ SOURCE_DIR
1029
+ BINARY_DIR
1030
+ EXCLUDE
1031
+ SYSTEM
1032
+ OPTIONS
1033
+ )
1034
+
1035
+ if(NOT DOWNLOAD_ONLY AND EXISTS ${SOURCE_DIR}/CMakeLists.txt)
1036
+ set(addSubdirectoryExtraArgs "")
1037
+ if(EXCLUDE)
1038
+ list(APPEND addSubdirectoryExtraArgs EXCLUDE_FROM_ALL)
1039
+ endif()
1040
+ if("${SYSTEM}" AND "${CMAKE_VERSION}" VERSION_GREATER_EQUAL "3.25")
1041
+ # https://cmake.org/cmake/help/latest/prop_dir/SYSTEM.html#prop_dir:SYSTEM
1042
+ list(APPEND addSubdirectoryExtraArgs SYSTEM)
1043
+ endif()
1044
+ if(OPTIONS)
1045
+ foreach(OPTION ${OPTIONS})
1046
+ cpm_parse_option("${OPTION}")
1047
+ set(${OPTION_KEY} "${OPTION_VALUE}")
1048
+ endforeach()
1049
+ endif()
1050
+ set(CPM_OLD_INDENT "${CPM_INDENT}")
1051
+ set(CPM_INDENT "${CPM_INDENT} ${PACKAGE}:")
1052
+ add_subdirectory(${SOURCE_DIR} ${BINARY_DIR} ${addSubdirectoryExtraArgs})
1053
+ set(CPM_INDENT "${CPM_OLD_INDENT}")
1054
+ endif()
1055
+ endfunction()
1056
+
1057
+ # downloads a previously declared package via FetchContent and exports the variables
1058
+ # `${PACKAGE}_SOURCE_DIR` and `${PACKAGE}_BINARY_DIR` to the parent scope
1059
+ function(cpm_fetch_package PACKAGE populated)
1060
+ set(${populated}
1061
+ FALSE
1062
+ PARENT_SCOPE
1063
+ )
1064
+ if(${CPM_DRY_RUN})
1065
+ cpm_message(STATUS "${CPM_INDENT} Package ${PACKAGE} not fetched (dry run)")
1066
+ return()
1067
+ endif()
1068
+
1069
+ FetchContent_GetProperties(${PACKAGE})
1070
+
1071
+ string(TOLOWER "${PACKAGE}" lower_case_name)
1072
+
1073
+ if(NOT ${lower_case_name}_POPULATED)
1074
+ FetchContent_Populate(${PACKAGE})
1075
+ set(${populated}
1076
+ TRUE
1077
+ PARENT_SCOPE
1078
+ )
1079
+ endif()
1080
+
1081
+ cpm_store_fetch_properties(
1082
+ ${CPM_ARGS_NAME} ${${lower_case_name}_SOURCE_DIR} ${${lower_case_name}_BINARY_DIR}
1083
+ )
1084
+
1085
+ set(${PACKAGE}_SOURCE_DIR
1086
+ ${${lower_case_name}_SOURCE_DIR}
1087
+ PARENT_SCOPE
1088
+ )
1089
+ set(${PACKAGE}_BINARY_DIR
1090
+ ${${lower_case_name}_BINARY_DIR}
1091
+ PARENT_SCOPE
1092
+ )
1093
+ endfunction()
1094
+
1095
+ # splits a package option
1096
+ function(cpm_parse_option OPTION)
1097
+ string(REGEX MATCH "^[^ ]+" OPTION_KEY "${OPTION}")
1098
+ string(LENGTH "${OPTION}" OPTION_LENGTH)
1099
+ string(LENGTH "${OPTION_KEY}" OPTION_KEY_LENGTH)
1100
+ if(OPTION_KEY_LENGTH STREQUAL OPTION_LENGTH)
1101
+ # no value for key provided, assume user wants to set option to "ON"
1102
+ set(OPTION_VALUE "ON")
1103
+ else()
1104
+ math(EXPR OPTION_KEY_LENGTH "${OPTION_KEY_LENGTH}+1")
1105
+ string(SUBSTRING "${OPTION}" "${OPTION_KEY_LENGTH}" "-1" OPTION_VALUE)
1106
+ endif()
1107
+ set(OPTION_KEY
1108
+ "${OPTION_KEY}"
1109
+ PARENT_SCOPE
1110
+ )
1111
+ set(OPTION_VALUE
1112
+ "${OPTION_VALUE}"
1113
+ PARENT_SCOPE
1114
+ )
1115
+ endfunction()
1116
+
1117
+ # guesses the package version from a git tag
1118
+ function(cpm_get_version_from_git_tag GIT_TAG RESULT)
1119
+ string(LENGTH ${GIT_TAG} length)
1120
+ if(length EQUAL 40)
1121
+ # GIT_TAG is probably a git hash
1122
+ set(${RESULT}
1123
+ 0
1124
+ PARENT_SCOPE
1125
+ )
1126
+ else()
1127
+ string(REGEX MATCH "v?([0123456789.]*).*" _ ${GIT_TAG})
1128
+ set(${RESULT}
1129
+ ${CMAKE_MATCH_1}
1130
+ PARENT_SCOPE
1131
+ )
1132
+ endif()
1133
+ endfunction()
1134
+
1135
+ # guesses if the git tag is a commit hash or an actual tag or a branch name.
1136
+ function(cpm_is_git_tag_commit_hash GIT_TAG RESULT)
1137
+ string(LENGTH "${GIT_TAG}" length)
1138
+ # full hash has 40 characters, and short hash has at least 7 characters.
1139
+ if(length LESS 7 OR length GREATER 40)
1140
+ set(${RESULT}
1141
+ 0
1142
+ PARENT_SCOPE
1143
+ )
1144
+ else()
1145
+ if(${GIT_TAG} MATCHES "^[a-fA-F0-9]+$")
1146
+ set(${RESULT}
1147
+ 1
1148
+ PARENT_SCOPE
1149
+ )
1150
+ else()
1151
+ set(${RESULT}
1152
+ 0
1153
+ PARENT_SCOPE
1154
+ )
1155
+ endif()
1156
+ endif()
1157
+ endfunction()
1158
+
1159
+ function(cpm_prettify_package_arguments OUT_VAR IS_IN_COMMENT)
1160
+ set(oneValueArgs
1161
+ NAME
1162
+ FORCE
1163
+ VERSION
1164
+ GIT_TAG
1165
+ DOWNLOAD_ONLY
1166
+ GITHUB_REPOSITORY
1167
+ GITLAB_REPOSITORY
1168
+ BITBUCKET_REPOSITORY
1169
+ GIT_REPOSITORY
1170
+ SOURCE_DIR
1171
+ FIND_PACKAGE_ARGUMENTS
1172
+ NO_CACHE
1173
+ SYSTEM
1174
+ GIT_SHALLOW
1175
+ EXCLUDE_FROM_ALL
1176
+ SOURCE_SUBDIR
1177
+ )
1178
+ set(multiValueArgs URL OPTIONS DOWNLOAD_COMMAND)
1179
+ cmake_parse_arguments(CPM_ARGS "" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
1180
+
1181
+ foreach(oneArgName ${oneValueArgs})
1182
+ if(DEFINED CPM_ARGS_${oneArgName})
1183
+ if(${IS_IN_COMMENT})
1184
+ string(APPEND PRETTY_OUT_VAR "#")
1185
+ endif()
1186
+ if(${oneArgName} STREQUAL "SOURCE_DIR")
1187
+ string(REPLACE ${CMAKE_SOURCE_DIR} "\${CMAKE_SOURCE_DIR}" CPM_ARGS_${oneArgName}
1188
+ ${CPM_ARGS_${oneArgName}}
1189
+ )
1190
+ endif()
1191
+ string(APPEND PRETTY_OUT_VAR " ${oneArgName} ${CPM_ARGS_${oneArgName}}\n")
1192
+ endif()
1193
+ endforeach()
1194
+ foreach(multiArgName ${multiValueArgs})
1195
+ if(DEFINED CPM_ARGS_${multiArgName})
1196
+ if(${IS_IN_COMMENT})
1197
+ string(APPEND PRETTY_OUT_VAR "#")
1198
+ endif()
1199
+ string(APPEND PRETTY_OUT_VAR " ${multiArgName}\n")
1200
+ foreach(singleOption ${CPM_ARGS_${multiArgName}})
1201
+ if(${IS_IN_COMMENT})
1202
+ string(APPEND PRETTY_OUT_VAR "#")
1203
+ endif()
1204
+ string(APPEND PRETTY_OUT_VAR " \"${singleOption}\"\n")
1205
+ endforeach()
1206
+ endif()
1207
+ endforeach()
1208
+
1209
+ if(NOT "${CPM_ARGS_UNPARSED_ARGUMENTS}" STREQUAL "")
1210
+ if(${IS_IN_COMMENT})
1211
+ string(APPEND PRETTY_OUT_VAR "#")
1212
+ endif()
1213
+ string(APPEND PRETTY_OUT_VAR " ")
1214
+ foreach(CPM_ARGS_UNPARSED_ARGUMENT ${CPM_ARGS_UNPARSED_ARGUMENTS})
1215
+ string(APPEND PRETTY_OUT_VAR " ${CPM_ARGS_UNPARSED_ARGUMENT}")
1216
+ endforeach()
1217
+ string(APPEND PRETTY_OUT_VAR "\n")
1218
+ endif()
1219
+
1220
+ set(${OUT_VAR}
1221
+ ${PRETTY_OUT_VAR}
1222
+ PARENT_SCOPE
1223
+ )
1224
+
1225
+ endfunction()