-
Notifications
You must be signed in to change notification settings - Fork 577
/
Copy pathTribitsGlobalMacros.cmake
2221 lines (1838 loc) · 82 KB
/
TribitsGlobalMacros.cmake
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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# @HEADER
# *****************************************************************************
# TriBITS: Tribal Build, Integrate, and Test System
#
# Copyright 2013-2016 NTESS and the TriBITS contributors.
# SPDX-License-Identifier: BSD-3-Clause
# *****************************************************************************
# @HEADER
# Standard TriBITS system includes
include("${CMAKE_CURRENT_LIST_DIR}/../utils/TribitsGitRepoVersionInfo.cmake")
include("${CMAKE_CURRENT_LIST_DIR}/../common/TribitsConstants.cmake")
include("${CMAKE_CURRENT_LIST_DIR}/../test_support/TribitsTestCategories.cmake")
include("${CMAKE_CURRENT_LIST_DIR}/../test_support/TribitsAddTestHelpers.cmake")
include(TribitsSetupMPI)
include(TribitsGeneralMacros)
include(TribitsVerbosePrintVar)
include(TribitsProcessEnabledTpls)
include(TribitsInstallHeaders)
include(TribitsGetVersionDate)
include(TribitsReportInvalidTribitsUsage)
include(TribitsReadAllProjectDepsFilesCreateDepsGraph)
include(TribitsAdjustPackageEnables)
include(TribitsSetUpEnabledOnlyDependencies)
include(TribitsConfigureTiming)
# Standard TriBITS utilities includes
include(TribitsAddOptionAndDefine)
include(TribitsAddEnumCacheVar)
include(AdvancedOption)
include(AdvancedSet)
include(AppendStringVar)
include(AppendStringVarWithSep)
include(AssertAndTouchDefined)
include(CMakeBuildTypesList)
include(FindListElement)
include(GlobalNullSet)
include(PrintNonemptyVar)
include(PrintVar)
include(RemoveGlobalDuplicates)
include(Split)
include(TimingUtils)
include(SetDefaultAndFromEnv) # Used by some call-back files
include(TribitsFilepathHelpers)
include(TribitsDeprecatedHelpers)
# Standard CMake includes
include(CheckIncludeFileCXX)
# Include here so it does not need to be included in each individual
# FindTPL<TPLNAME>.cmake file over and over.
include(TribitsTplFindIncludeDirsAndLibraries)
include(TribitsTplDeclareLibraries) # Deprecated
# ABOVE: We need to include TribitsTplDeclareLibraries.cmake until all client
# projects stop using it.
# Assert and setup project binary directory and other project variables
#
macro(tribits_assert_and_setup_project_and_static_system_vars)
string(APPEND IN_SOURCE_ERROR_COMMON_MSG
"\nYou must now run something like:\n"
" $ cd ${CMAKE_CURRENT_SOURCE_DIR}/\n"
" $ rm -r CMakeCache.txt CMakeFiles/"
"\n"
"Please create a different directory and configure ${PROJECT_NAME}"
" under that such as:\n"
" $ cd ${CMAKE_CURRENT_SOURCE_DIR}/\n"
" $ mkdir MY_BUILD\n"
" $ cd MY_BUILD\n"
" $ cmake [OPTIONS] .."
)
if (EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/CMakeCache.txt")
message(FATAL_ERROR "ERROR! "
"The file ${CMAKE_CURRENT_SOURCE_DIR}/CMakeCache.txt exists from a"
" likely prior attempt to do an in-source build."
"${IN_SOURCE_ERROR_COMMON_MSG}"
)
endif()
if ("${CMAKE_CURRENT_SOURCE_DIR}" STREQUAL "${CMAKE_CURRENT_BINARY_DIR}")
message(FATAL_ERROR "ERROR! "
"CMAKE_CURRENT_SOURCE_DIR=${CMAKE_CURRENT_SOURCE_DIR}"
" == CMAKE_CURRENT_BINARY_DIR=${CMAKE_CURRENT_BINARY_DIR}"
"\n${PROJECT_NAME} does not support in source builds!\n"
"NOTE: You must now delete the CMakeCache.txt file and the CMakeFiles/ directory under"
" the source directory for ${PROJECT_NAME} or you will not be able to configure ${PROJECT_NAME} correctly!"
"${IN_SOURCE_ERROR_COMMON_MSG}"
)
endif()
string(TOUPPER ${PROJECT_NAME} PROJECT_NAME_UC)
set(PROJECT_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR} CACHE INTERNAL "")
set(PROJECT_BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR} CACHE INTERNAL "")
print_var(PROJECT_SOURCE_DIR)
print_var(PROJECT_BINARY_DIR)
print_var(${PROJECT_NAME}_TRIBITS_DIR)
print_var(TriBITS_VERSION_STRING)
# Above, we put these in the cache so we can grep them out of the cache file
#
# Print some basic static info provided by CMake automatically
#
print_var(CMAKE_VERSION)
print_var(CMAKE_GENERATOR)
endmacro()
# Set up some really basic system variables
#
# This macro needs to be called *before* the user *.cmake option files are
# read in so that there is an opportunity to override these.
#
macro(tribits_setup_basic_system_vars)
# CMAKE_HOST_SYSTEM_NAME is provided by CMake automatically but can actually
# be overridden in the cache.
print_var(CMAKE_HOST_SYSTEM_NAME)
site_name(${PROJECT_NAME}_HOSTNAME)
mark_as_advanced(${PROJECT_NAME}_HOSTNAME)
print_var(${PROJECT_NAME}_HOSTNAME)
# NOTE: CMAKE_HOST_SYSTEM_NAME and ${PROJECT_NAME}_HOSTNAME are used by
# TRIBITS_ADD[_ADVANCED]_test() to include/exclude tests based in the
# arguments HOSTS, XHOSTS, HOSTTYPES, AND XHOSTTYPES.
endmacro()
# Define an option to include a file that reads in a bunch of options and read
# those files
#
macro(tribits_read_in_options_from_file)
set( ${PROJECT_NAME}_CONFIGURE_OPTIONS_FILE "" CACHE FILEPATH
"Name of an optional file that is included first to define any cmake options with set( ... CACHE ...) calls. NOTE: paths can be separated by commas instead of semicolons but paths cannot contain commas."
)
split("${${PROJECT_NAME}_CONFIGURE_OPTIONS_FILE}" ","
${PROJECT_NAME}_CONFIGURE_OPTIONS_FILE)
set( ${PROJECT_NAME}_CONFIGURE_OPTIONS_FILE_ALL
${${PROJECT_NAME}_CONFIGURE_OPTIONS_FILE}
${${PROJECT_NAME}_CONFIGURE_OPTIONS_FILE_APPEND})
foreach (CONFIG_OPTS_FILE ${${PROJECT_NAME}_CONFIGURE_OPTIONS_FILE_ALL})
message("-- " "Reading in configuration options from ${CONFIG_OPTS_FILE} ...")
tribits_trace_file_processing(PROJECT INCLUDE "${CONFIG_OPTS_FILE}")
include(${CONFIG_OPTS_FILE})
endforeach()
endmacro()
# Assert ${PROJECT_NAME}_SET_GROUP_AND_PERMISSIONS_ON_INSTALL_BASE_DIR set
# correctly
#
function(assert_project_set_group_and_permissions_on_install_base_dir)
if (
(NOT "${CMAKE_INSTALL_PREFIX}" STREQUAL "")
AND
(NOT "${${PROJECT_NAME}_SET_GROUP_AND_PERMISSIONS_ON_INSTALL_BASE_DIR}" STREQUAL "")
)
tribits_dir_is_basedir(
"${${PROJECT_NAME}_SET_GROUP_AND_PERMISSIONS_ON_INSTALL_BASE_DIR}"
"${CMAKE_INSTALL_PREFIX}"
isBaseDir)
if (NOT isBaseDir)
message(FATAL_ERROR
"\n"
"***\n"
"*** ERROR in ${PROJECT_NAME}_SET_GROUP_AND_PERMISSIONS_ON_INSTALL_BASE_DIR!\n"
"***\n"
"\n"
"${PROJECT_NAME}_SET_GROUP_AND_PERMISSIONS_ON_INSTALL_BASE_DIR=${${PROJECT_NAME}_SET_GROUP_AND_PERMISSIONS_ON_INSTALL_BASE_DIR}\n"
"\n"
"is not a strict base dir of:\n"
"\n"
"CMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX}\n"
"\n"
"Either remove ${PROJECT_NAME}_SET_GROUP_AND_PERMISSIONS_ON_INSTALL_BASE_DIR from the cache or set it to be a base dir of CMAKE_INSTALL_PREFIX!\n"
"\n"
)
endif()
endif()
endfunction()
# Define all of the standard global package architecture options.
#
macro(tribits_define_global_options_and_define_extra_repos)
set( ${PROJECT_NAME}_ENABLE_ALL_PACKAGES OFF CACHE BOOL
"Enable all packages PT packages (ST packages as well if ${PROJECT_NAME}_ENABLE_SECONDARY_TESTED_CODE is true)." )
set(${PROJECT_NAME}_ENABLE_ALL_OPTIONAL_PACKAGES ON CACHE BOOL
"Recursively enable all optional packages for set of enabled packages." )
set( ${PROJECT_NAME}_INSTALL_EXECUTABLES ON CACHE BOOL
"Enable the installation of executables provided by the ${PROJECT_NAME} packages." )
advanced_set(${PROJECT_NAME}_ENABLE_ALL_FORWARD_DEP_PACKAGES OFF CACHE BOOL
"Recursively enable all packages that have required or optional dependencies for set of enabled packages." )
if (${PROJECT_NAME}_DISABLE_ENABLED_FORWARD_DEP_PACKAGES_DEFAULT STREQUAL "")
set(${PROJECT_NAME}_DISABLE_ENABLED_FORWARD_DEP_PACKAGES_DEFAULT OFF)
endif()
set(${PROJECT_NAME}_DISABLE_ENABLED_FORWARD_DEP_PACKAGES
${${PROJECT_NAME}_DISABLE_ENABLED_FORWARD_DEP_PACKAGES_DEFAULT}
CACHE BOOL
"Disable (and printing warning) for enabled packages that have hard-disabled upstream dependencies. Otherwise, is to raises a fatal configure failure." )
set_cache_on_off_empty( ${PROJECT_NAME}_ENABLE_TESTS ""
"Enable tests (execs and ctest add_test()) in all packages (set to ON, OFF, or leave empty)." )
set_cache_on_off_empty(${PROJECT_NAME}_ENABLE_EXAMPLES ""
"Enable examples (exec and ctest add_test()) in all packages (set to ON, OFF, or leave empty). If left empty, then this will be set to ON if ${PROJECT_NAME}_ENABLE_TESTS=ON" )
set(${PROJECT_NAME}_SKIP_CTEST_ADD_TEST OFF CACHE BOOL
"Skip ctest add_test() for all defined tests (but still build any enabled test or example executable targets)." )
if (${PROJECT_NAME}_ENABLE_TESTS AND ${PROJECT_NAME}_ENABLE_EXAMPLES STREQUAL "")
message(STATUS "Setting ${PROJECT_NAME}_ENABLE_EXAMPLES=ON because ${PROJECT_NAME}_ENABLE_TESTS=ON")
set(${PROJECT_NAME}_ENABLE_EXAMPLES ON)
endif()
advanced_set( ${PROJECT_NAME}_UNENABLE_ENABLED_PACKAGES OFF CACHE BOOL
"Set to empty all package enables (set to OFF at end)." )
advanced_option(${PROJECT_NAME}_REMOVE_DEFAULT_PACKAGE_DISABLES
"Removes all default disables from the packages list. Used for testing etc."
OFF )
if ("${${PROJECT_NAME}_ENABLE_C_DEFAULT}" STREQUAL "")
set(${PROJECT_NAME}_ENABLE_C_DEFAULT ON)
endif()
advanced_option(${PROJECT_NAME}_ENABLE_C
"Enable the C compiler and related code"
${${PROJECT_NAME}_ENABLE_C_DEFAULT} )
if ("${${PROJECT_NAME}_C_Standard_DEFAULT}" STREQUAL "")
set(${PROJECT_NAME}_C_Standard_DEFAULT c99)
endif()
advanced_set(${PROJECT_NAME}_C_Standard
${${PROJECT_NAME}_C_Standard_DEFAULT}
CACHE STRING
"The standard <cstd> to use in --std=<cstd> for GCC compilers." )
if ("${${PROJECT_NAME}_ENABLE_CXX_DEFAULT}" STREQUAL "")
set(${PROJECT_NAME}_ENABLE_CXX_DEFAULT ON)
endif()
advanced_option(${PROJECT_NAME}_ENABLE_CXX
"Enable the C++ compiler and related code"
${${PROJECT_NAME}_ENABLE_CXX_DEFAULT} )
# Hard-code a variable with the same name as a now-removed option that is always enabled.
# This can be removed after clients have been updated.
set(${PROJECT_NAME}_ENABLE_CXX11 ON)
if ("${${PROJECT_NAME}_ENABLE_Fortran_DEFAULT}" STREQUAL "")
if (WIN32)
set(${PROJECT_NAME}_ENABLE_Fortran_DEFAULT OFF)
else()
set(${PROJECT_NAME}_ENABLE_Fortran_DEFAULT ON)
endif()
endif()
option(${PROJECT_NAME}_ENABLE_Fortran
"Enable the Fortran compiler and related code"
${${PROJECT_NAME}_ENABLE_Fortran_DEFAULT} )
advanced_option(${PROJECT_NAME}_SKIP_FORTRANCINTERFACE_VERIFY_TEST
"Skip the Fortran/C++ compatibility test"
OFF )
advanced_set(
${PROJECT_NAME}_MAKE_INSTALL_WORLD_READABLE
"${${PROJECT_NAME}_MAKE_INSTALL_WORLD_READABLE_DEFAULT}"
CACHE BOOL
"If TRUE, the directory and file permissions on the installed directories and files will be set to world readable. NOTE: Empty '' (the default) leaves default CMake permissions in place."
)
advanced_set(
${PROJECT_NAME}_MAKE_INSTALL_GROUP_WRITABLE ""
CACHE BOOL
"If TRUE, the directory and file permissions on the installed directories and files will be set to group-writable. Setting to TRUE also implies ${PROJECT_NAME}_MAKE_INSTALL_GROUP_READABLE=TRUE. NOTE: Empty '' (the default) avoid adding the group write permission."
)
if ("${${PROJECT_NAME}_MAKE_INSTALL_GROUP_READABLE_DEFAULT}" STREQUAL "")
if (${PROJECT_NAME}_MAKE_INSTALL_GROUP_WRITABLE)
set(${PROJECT_NAME}_MAKE_INSTALL_GROUP_READABLE_DEFAULT TRUE)
else()
set(${PROJECT_NAME}_MAKE_INSTALL_GROUP_READABLE_DEFAULT
"${${PROJECT_NAME}_MAKE_INSTALL_WORLD_READABLE}")
endif()
endif()
advanced_set(
${PROJECT_NAME}_MAKE_INSTALL_GROUP_READABLE
"${${PROJECT_NAME}_MAKE_INSTALL_GROUP_READABLE_DEFAULT}"
CACHE BOOL
"If TRUE, the directory and file permissions on the installed directories and files will be set to group readable. Setting ${PROJECT_NAME}_MAKE_INSTALL_WORLD_READABLE=ON implies this is 'ON' as well. NOTE: Empty '' (the default) leaves default CMake permissions in place."
)
advanced_set(
${PROJECT_NAME}_MAKE_INSTALL_GROUP ""
CACHE STRING
"If set, then the installed files and directories from ${PROJECT_NAME}_SET_GROUP_AND_PERMISSIONS_ON_INSTALL_BASE_DIR on down will be given over to this owning group. The default is empty '' which means the default group will not be changed."
)
advanced_set(
${PROJECT_NAME}_SET_GROUP_AND_PERMISSIONS_ON_INSTALL_BASE_DIR
"${CMAKE_INSTALL_PREFIX}"
CACHE FILEPATH
"Set the base path for which a recursive chmod and chgrp will be called to set the group and permissions after the install is complete. The default directory is give by CMAKE_INSTALL_PREFIX."
)
assert_project_set_group_and_permissions_on_install_base_dir()
if ("${${PROJECT_NAME}_SET_INSTALL_RPATH_DEFAULT}" STREQUAL "")
set(${PROJECT_NAME}_SET_INSTALL_RPATH_DEFAULT TRUE)
else()
set(${PROJECT_NAME}_SET_INSTALL_RPATH_DEFAULT FALSE)
endif()
advanced_set(
${PROJECT_NAME}_SET_INSTALL_RPATH ${${PROJECT_NAME}_SET_INSTALL_RPATH_DEFAULT}
CACHE BOOL
"If TRUE, then set RPATH on installed binaries will set to ${PROJECT_NAME}_INSTALL_LIB_DIR automatically"
)
if ("${CMAKE_INSTALL_RPATH_USE_LINK_PATH_DEFAULT}" STREQUAL "")
set(CMAKE_INSTALL_RPATH_USE_LINK_PATH_DEFAULT TRUE)
else()
set(CMAKE_INSTALL_RPATH_USE_LINK_PATH_DEFAULT FALSE)
endif()
advanced_set(
CMAKE_INSTALL_RPATH_USE_LINK_PATH ${CMAKE_INSTALL_RPATH_USE_LINK_PATH_DEFAULT}
CACHE BOOL
"If set to TRUE, then the RPATH for external shared libs will be embedded in installed libs and execs."
)
advanced_set(${PROJECT_NAME}_EXTRA_LINK_FLAGS ""
CACHE STRING
"Extra flags added to the end of every linked executable"
)
# OpenMP is similar to a TPL in some respects, but requires only compiler
# flags to enable
option(${PROJECT_NAME}_ENABLE_OpenMP
"Build with OpenMP support." OFF)
if (CMAKE_GENERATOR STREQUAL "Ninja")
if("${${PROJECT_NAME}_WRITE_NINJA_MAKEFILES_DEFAULT}" STREQUAL "")
set(${PROJECT_NAME}_WRITE_NINJA_MAKEFILES_DEFAULT ON)
endif()
set(${PROJECT_NAME}_WRITE_NINJA_MAKEFILES
${${PROJECT_NAME}_WRITE_NINJA_MAKEFILES_DEFAULT} CACHE BOOL
"Generate dummy makefiles to call ninja in every build subdirectory (requires CMake 3.7.0 or newer)." )
endif()
if ("${${PROJECT_NAME}_WRITE_NINJA_MAKEFILES}" STREQUAL "")
set(${PROJECT_NAME}_WRITE_NINJA_MAKEFILES OFF)
endif()
advanced_set(${PROJECT_NAME}_PARALLEL_COMPILE_JOBS_LIMIT "" CACHE STRING
"If not empty '', gives an integer for the max number of object compile jobs for Ninja builds. (Default empty for no limit)")
advanced_set(${PROJECT_NAME}_PARALLEL_LINK_JOBS_LIMIT "" CACHE STRING
"If not empty '', gives an integer for the max number of lib and exe link jobs for Ninja builds. (Default empty for no limit)")
if (CMAKE_BUILD_TYPE STREQUAL "DEBUG")
set(${PROJECT_NAME}_ENABLE_DEBUG_DEFAULT ON)
else()
set(${PROJECT_NAME}_ENABLE_DEBUG_DEFAULT OFF)
endif()
set(${PROJECT_NAME}_ENABLE_DEBUG ${${PROJECT_NAME}_ENABLE_DEBUG_DEFAULT} CACHE BOOL
"Enable debug checking for ${PROJECT_NAME} packages. Off by default unless CMAKE_BUILD_TYPE=\"DEBUG\"." )
if (${PROJECT_NAME}_ENABLE_DEBUG)
set(${PROJECT_NAME}_ENABLE_CONFIGURE_DEBUG_DEFAULT ON)
else()
set(${PROJECT_NAME}_ENABLE_CONFIGURE_DEBUG_DEFAULT OFF)
endif()
set(${PROJECT_NAME}_ENABLE_CONFIGURE_DEBUG
${${PROJECT_NAME}_ENABLE_CONFIGURE_DEBUG_DEFAULT} CACHE BOOL
"Enable debug checking of the process which finds errors in the project's CMake files (off by default unless ${PROJECT_NAME}_ENABLE_DEBUG=ON)." )
if ("${${PROJECT_NAME}_CHECK_FOR_UNPARSED_ARGUMENTS_DEFAULT}" STREQUAL "")
set(${PROJECT_NAME}_CHECK_FOR_UNPARSED_ARGUMENTS_DEFAULT "WARNING")
endif()
advanced_set(${PROJECT_NAME}_CHECK_FOR_UNPARSED_ARGUMENTS
${${PROJECT_NAME}_CHECK_FOR_UNPARSED_ARGUMENTS_DEFAULT}
CACHE STRING
"Determines how unparsed arguments for TriBITS functions that use cmake_parase_aruments() internally are handled. Valid choices are 'WARNING', 'SEND_ERROR', and 'FATAL_ERROR'. The default is 'SEND_ERROR'."
)
if (
(NOT ${PROJECT_NAME}_CHECK_FOR_UNPARSED_ARGUMENTS STREQUAL "WARNING")
AND
(NOT ${PROJECT_NAME}_CHECK_FOR_UNPARSED_ARGUMENTS STREQUAL "SEND_ERROR")
AND
(NOT ${PROJECT_NAME}_CHECK_FOR_UNPARSED_ARGUMENTS STREQUAL "FATAL_ERROR")
)
message(FATAL_ERROR "Error, the value of"
" ${PROJECT_NAME}_CHECK_FOR_UNPARSED_ARGUMENTS ="
" '${${PROJECT_NAME}_CHECK_FOR_UNPARSED_ARGUMENTS}' is invalid!"
" Valid values include 'WARNING', 'SEND_ERROR', and 'FATAL_ERROR'"
)
endif()
set(${PROJECT_NAME}_ENABLE_TEUCHOS_TIME_MONITOR ON
CACHE BOOL
"Enable support for Teuchos Time Monitors in all Trilinos packages that support it."
)
advanced_set(${PROJECT_NAME}_SHOW_DEPRECATED_WARNINGS ON
CACHE BOOL
"Show warnings about deprecated code"
)
advanced_set(${PROJECT_NAME}_HIDE_DEPRECATED_CODE OFF
CACHE BOOL
"Show warnings about deprecated code"
)
advanced_set(${PROJECT_NAME}_VERBOSE_CONFIGURE OFF
CACHE BOOL
"Make the ${PROJECT_NAME} configure process verbose."
)
advanced_option(${PROJECT_NAME}_DUMP_LINK_LIBS
"Dump the link libraries for every library and executable created."
"${${PROJECT_NAME}_VERBOSE_CONFIGURE}" )
advanced_set(${PROJECT_NAME}_TRACE_FILE_PROCESSING
${${PROJECT_NAME}_VERBOSE_CONFIGURE}
CACHE BOOL
"Print out when all of the various files get processed."
)
advanced_set(${PROJECT_NAME}_ENABLE_EXPLICIT_INSTANTIATION ON
CACHE BOOL
"Enable explicit template instantiation in all packages that support it"
)
advanced_set(${PROJECT_NAME}_AUTOGENERATE_TEST_RESOURCE_FILE OFF
CACHE BOOL
"Auto-generate a resource spec file for use with CTest."
)
advanced_set(${PROJECT_NAME}_CUDA_NUM_GPUS 1
CACHE STRING
"Number of GPUS to make available in the auto-generated resource spec file."
)
advanced_set(${PROJECT_NAME}_CUDA_SLOTS_PER_GPU 1
CACHE STRING
"Number of slots per GPU in the auto-generated resource spec file."
)
set(CTEST_RESOURCE_SPEC_FILE_DOC_EXTRA "")
if (${PROJECT_NAME}_AUTOGENERATE_TEST_RESOURCE_FILE)
set(CTEST_RESOURCE_SPEC_FILE_DEFAULT ${CMAKE_BINARY_DIR}/ctest_resources.json)
if ("${CTEST_RESOURCE_SPEC_FILE}" STREQUAL "")
set(CTEST_RESOURCE_SPEC_FILE_DOC_EXTRA
" This file is autogenerated by default since ${PROJECT_NAME}_AUTOGENERATE_TEST_RESOURCE_FILE=${${PROJECT_NAME}_AUTOGENERATE_TEST_RESOURCE_FILE}!" )
endif()
else()
set(CTEST_RESOURCE_SPEC_FILE_DEFAULT "")
endif()
advanced_set(CTEST_RESOURCE_SPEC_FILE
"${CTEST_RESOURCE_SPEC_FILE_DEFAULT}"
CACHE FILEPATH
"Resource spec file for CTest.${CTEST_RESOURCE_SPEC_FILE_DOC_EXTRA}"
)
if (USE_XSDK_DEFAULTS)
# Need to set BUILD_SHARED_LIBS default here based on USE_XSDK_DEFAULTS
# and not in tribits_setup_env() in case there is logic in TriBITS or
# project-specific files that depends on this var getting set here!
set(BUILD_SHARED_LIBS_DEFAULT TRUE)
if ("${BUILD_SHARED_LIBS}" STREQUAL "")
message("-- " "XSDK: Setting default BUILD_SHARED_LIBS=TRUE")
endif()
else()
set(BUILD_SHARED_LIBS_DEFAULT FALSE)
endif()
set(BUILD_SHARED_LIBS ${BUILD_SHARED_LIBS_DEFAULT}
CACHE BOOL "Build shared libraries or not.")
if ("${${PROJECT_NAME}_TPL_SYSTEM_INCLUDE_DIRS_DEFAULT}" STREQUAL "")
set(${PROJECT_NAME}_TPL_SYSTEM_INCLUDE_DIRS_DEFAULT FALSE)
endif()
advanced_set(${PROJECT_NAME}_TPL_SYSTEM_INCLUDE_DIRS
${${PROJECT_NAME}_TPL_SYSTEM_INCLUDE_DIRS_DEFAULT}
CACHE BOOL
"If set TRUE, then 'SYSTEM' will be passed into include_directories() for TPL includes.")
if ("${${PROJECT_NAME}_IMPORTED_NO_SYSTEM_DEFAULT}" STREQUAL "")
set(${PROJECT_NAME}_IMPORTED_NO_SYSTEM_DEFAULT FALSE)
endif()
advanced_set(${PROJECT_NAME}_IMPORTED_NO_SYSTEM
${${PROJECT_NAME}_IMPORTED_NO_SYSTEM_DEFAULT}
CACHE BOOL
"If set TRUE, then set IMPORTED_NO_SYSTEM property on all exported libraries.")
if (CMAKE_VERSION VERSION_LESS 3.23 AND ${PROJECT_NAME}_IMPORTED_NO_SYSTEM)
message(FATAL_ERROR "Error, setting ${PROJECT_NAME}_IMPORTED_NO_SYSTEM='${${PROJECT_NAME}_IMPORTED_NO_SYSTEM}' for CMake version '${CMAKE_VERSION}' < 3.23 is not allowed!")
endif()
advanced_set(TPL_FIND_SHARED_LIBS ON CACHE BOOL
"If ON, then the TPL system will find shared libs if they exist, otherwise will only find static libs." )
advanced_set(${PROJECT_NAME}_LINK_SEARCH_START_STATIC OFF CACHE BOOL
"If ON, then the property LINK_SEARCH_START_STATIC will be added to all executables." )
advanced_set(${PROJECT_NAME}_LIBRARY_NAME_PREFIX ""
CACHE STRING
"Prefix for all ${PROJECT_NAME} library names. If set to, for example, 'prefix_',
libraries will be named and installed as 'prefix_<libname>.*'. Default is '' (no prefix)."
)
if ("${${PROJECT_NAME}_MUST_FIND_ALL_TPL_LIBS_DEFAULT}" STREQUAL "")
set(${PROJECT_NAME}_MUST_FIND_ALL_TPL_LIBS_DEFAULT FALSE)
endif()
advanced_set( ${PROJECT_NAME}_MUST_FIND_ALL_TPL_LIBS
${${PROJECT_NAME}_MUST_FIND_ALL_TPL_LIBS_DEFAULT}
CACHE BOOL
"If set to TRUE, then all of the TPL libs must be found for every enabled TPL."
)
if ("${${PROJECT_NAME}_USE_GNUINSTALLDIRS_DEFAULT}" STREQUAL "")
set(${PROJECT_NAME}_USE_GNUINSTALLDIRS_DEFAULT FALSE) # Maintain backward compatibility
endif()
advanced_set( ${PROJECT_NAME}_USE_GNUINSTALLDIRS
${${PROJECT_NAME}_USE_GNUINSTALLDIRS_DEFAULT}
CACHE BOOL
"If set to TRUE, then CMake GNUInstallDris modules is used to pick standard install paths by default."
)
if ("${${PROJECT_NAME}_INSTALL_LIBRARIES_AND_HEADERS_DEFAULT}" STREQUAL "")
# Assume the TriBITS project wants to install headers and libraries by default
set(${PROJECT_NAME}_INSTALL_LIBRARIES_AND_HEADERS_DEFAULT ON)
endif()
advanced_set(${PROJECT_NAME}_INSTALL_LIBRARIES_AND_HEADERS
${${PROJECT_NAME}_INSTALL_LIBRARIES_AND_HEADERS_DEFAULT}
CACHE BOOL
"Install libraries and headers (default is ${${PROJECT_NAME}_INSTALL_LIBRARIES_AND_HEADERS_DEFAULT}). NOTE: Shared libraries are always installed since they are needed by executables."
)
# Creating <Package>Config.cmake files is currently *very* expensive for large
# TriBITS projects so we disable this by default for TriBITS.
if ("${${PROJECT_NAME}_ENABLE_INSTALL_CMAKE_CONFIG_FILES_DEFAULT}" STREQUAL "")
set(${PROJECT_NAME}_ENABLE_INSTALL_CMAKE_CONFIG_FILES_DEFAULT OFF)
endif()
advanced_set(${PROJECT_NAME}_ENABLE_INSTALL_CMAKE_CONFIG_FILES
${${PROJECT_NAME}_ENABLE_INSTALL_CMAKE_CONFIG_FILES_DEFAULT}
CACHE BOOL
"Determines if ${PROJECT_NAME}Config.cmake and <PACKAGE>Config.cmake files are created or not."
)
if ("${${PROJECT_NAME}_SKIP_INSTALL_PROJECT_CMAKE_CONFIG_FILES_DEFAULT}" STREQUAL "")
set(${PROJECT_NAME}_SKIP_INSTALL_PROJECT_CMAKE_CONFIG_FILES_DEFAULT OFF)
endif()
advanced_set(${PROJECT_NAME}_SKIP_INSTALL_PROJECT_CMAKE_CONFIG_FILES
${${PROJECT_NAME}_SKIP_INSTALL_PROJECT_CMAKE_CONFIG_FILES_DEFAULT}
CACHE BOOL
"Skip installing the file ${PROJECT_NAME}Config.cmake."
)
if (NOT ${PROJECT_NAME}_GENERATE_EXPORT_FILE_DEPENDENCIES_DEFAULT)
# We need to generate the dependency logic for export dependency files if
# asked.
if (${PROJECT_NAME}_ENABLE_INSTALL_CMAKE_CONFIG_FILES)
set(${PROJECT_NAME}_GENERATE_EXPORT_FILE_DEPENDENCIES_DEFAULT ON)
else()
set(${PROJECT_NAME}_GENERATE_EXPORT_FILE_DEPENDENCIES_DEFAULT OFF)
endif()
endif()
advanced_set(${PROJECT_NAME}_GENERATE_EXPORT_FILE_DEPENDENCIES
${${PROJECT_NAME}_GENERATE_EXPORT_FILE_DEPENDENCIES_DEFAULT} CACHE BOOL
"Generate packages dependency data-structures needed for dependency export files." )
# ${PROJECT_NAME}_ELEVATE_SS_TO_PS is depreciated!
if (${PROJECT_NAME}_ELEVATE_SS_TO_PS_DEFAULT)
if (${PROJECT_NAME}_VERBOSE_CONFIGURE)
message("-- " "WARNING: ${PROJECT_NAME}_ELEVATE_SS_TO_PS_DEFAULT is deprecated."
" Use ${PROJECT_NAME}_ELEVATE_ST_TO_PT_DEFAULT instead!")
endif()
set(${PROJECT_NAME}_ELEVATE_ST_TO_PT_DEFAULT ON)
endif()
if ("${${PROJECT_NAME}_ELEVATE_ST_TO_PT_DEFAULT}" STREQUAL "")
set(${PROJECT_NAME}_ELEVATE_ST_TO_PT_DEFAULT OFF)
endif()
advanced_set( ${PROJECT_NAME}_ELEVATE_ST_TO_PT
${${PROJECT_NAME}_ELEVATE_ST_TO_PT_DEFAULT}
CACHE BOOL
"Elevate all defined ST packages to PT packages." )
if ("${${PROJECT_NAME}_ENABLE_CPACK_PACKAGING_DEFAULT}" STREQUAL "")
set(${PROJECT_NAME}_ENABLE_CPACK_PACKAGING_DEFAULT OFF)
endif()
advanced_set( ${PROJECT_NAME}_ENABLE_CPACK_PACKAGING
${${PROJECT_NAME}_ENABLE_CPACK_PACKAGING_DEFAULT}
CACHE BOOL
"Enable support for creating a distribution using CPack" )
if ("${${PROJECT_NAME}_EXCLUDE_DISABLED_SUBPACKAGES_FROM_DISTRIBUTION_DEFAULT}" STREQUAL "")
set(${PROJECT_NAME}_EXCLUDE_DISABLED_SUBPACKAGES_FROM_DISTRIBUTION_DEFAULT TRUE)
endif()
advanced_set( ${PROJECT_NAME}_EXCLUDE_DISABLED_SUBPACKAGES_FROM_DISTRIBUTION
${${PROJECT_NAME}_EXCLUDE_DISABLED_SUBPACKAGES_FROM_DISTRIBUTION_DEFAULT}
CACHE BOOL
"Excluded disabled packages from the CPack-generated distribution.")
if ("${${PROJECT_NAME}_ENABLE_SECONDARY_TESTED_CODE_DEFAULT}" STREQUAL "")
set(${PROJECT_NAME}_ENABLE_SECONDARY_TESTED_CODE_DEFAULT OFF)
endif()
advanced_set(
${PROJECT_NAME}_ENABLE_SECONDARY_TESTED_CODE
${${PROJECT_NAME}_ENABLE_SECONDARY_TESTED_CODE_DEFAULT}
CACHE BOOL
"Allow Secondary Tested (ST) packages and code to be implicitly enabled." )
if ("${${PROJECT_NAME}_TEST_CATEGORIES_DEFAULT}" STREQUAL "")
set(${PROJECT_NAME}_TEST_CATEGORIES_DEFAULT NIGHTLY)
endif()
advanced_set(${PROJECT_NAME}_TEST_CATEGORIES
${${PROJECT_NAME}_TEST_CATEGORIES_DEFAULT}
CACHE STRING
"List of categories of tests to enable: '${${PROJECT_NAME}_VALID_CATEGORIES_STR}' (default `${${PROJECT_NAME}_TEST_CATEGORIES_DEFAULT}`)."
)
tribits_get_invalid_categories(${PROJECT_NAME}_TEST_CATEGORIES)
if (NOT GIT_EXECUTABLE)
set(${PROJECT_NAME}_GENERATE_REPO_VERSION_FILE_DEFAULT OFF)
elseif ("${${PROJECT_NAME}_GENERATE_REPO_VERSION_FILE_DEFAULT}" STREQUAL "" )
set(${PROJECT_NAME}_GENERATE_REPO_VERSION_FILE_DEFAULT OFF)
endif()
advanced_set(
${PROJECT_NAME}_GENERATE_REPO_VERSION_FILE
${${PROJECT_NAME}_GENERATE_REPO_VERSION_FILE_DEFAULT}
CACHE BOOL
"Generate the ${PROJECT_NAME}RepoVersion.txt file.")
tribits_advanced_set_cache_var_and_default(${PROJECT_NAME}_SHOW_GIT_COMMIT_PARENTS
BOOL OFF "Show parents' commit info in the repo version output.")
if ("${${PROJECT_NAME}_GENERATE_VERSION_DATE_FILES_DEFAULT}" STREQUAL "")
set(${PROJECT_NAME}_GENERATE_VERSION_DATE_FILES_DEFAULT OFF)
endif()
advanced_set(
${PROJECT_NAME}_GENERATE_VERSION_DATE_FILES
${${PROJECT_NAME}_GENERATE_VERSION_DATE_FILES_DEFAULT}
CACHE BOOL
"Generate VersionDate.cmake and <RepoName>_version_date.h files.")
if ("${DART_TESTING_TIMEOUT_DEFAULT}" STREQUAL "")
set(DART_TESTING_TIMEOUT_DEFAULT 1500)
endif()
advanced_set(
DART_TESTING_TIMEOUT ${DART_TESTING_TIMEOUT_DEFAULT}
CACHE STRING
"Raw CMake/CTest global default test timeout (default 1500). (NOTE: Does not impact timeouts of tests that have the TIMEOUT property set on a test-by-test basis.)"
)
# NOTE: 1500 is the CMake default set in Modules/CTest.cmake. We need to
# set the default here because we need to be able to scale it correctly in
# case the user does not explicitly set this var in the cache.
advanced_set(${PROJECT_NAME}_SCALE_TEST_TIMEOUT 1.0 CACHE STRING
"Scale factor for global DART_TESTING_TIMEOUT and individual test TIMEOUT (default 1.0)."
)
# NOTE: This value is 1.0, *NOT* 1! This is used in tribits_scale_timeout()
# and there are unit tests that rely on this default!
advanced_set(${PROJECT_NAME}_REL_CPU_SPEED 1.0 CACHE STRING
"Relative CPU speed of the computer used to scale performance tests (default 1.0)."
)
if ("${${PROJECT_NAME}_ENABLE_DEVELOPMENT_MODE_DEFAULT}" STREQUAL "")
set(${PROJECT_NAME}_ENABLE_DEVELOPMENT_MODE_DEFAULT ON)
endif()
advanced_set( ${PROJECT_NAME}_ENABLE_DEVELOPMENT_MODE
${${PROJECT_NAME}_ENABLE_DEVELOPMENT_MODE_DEFAULT}
CACHE BOOL
"Determines if a variety of development mode checks are turned on by default or not."
)
if (NOT "${${PROJECT_NAME}_ASSERT_MISSING_PACKAGES}" STREQUAL "")
tribits_deprecated("Warning, ${PROJECT_NAME}_ASSERT_MISSING_PACKAGES="
"'${${PROJECT_NAME}_ASSERT_MISSING_PACKAGES}' is set and is no"
" longer supported! Please set"
" ${PROJECT_NAME}_ASSERT_DEFINED_DEPENDENCIES instead (see build ref)!" )
if (${PROJECT_NAME}_ASSERT_MISSING_PACKAGES)
set(${PROJECT_NAME}_ASSERT_DEFINED_DEPENDENCIES_DEFAULT FATAL_ERROR)
else()
set(${PROJECT_NAME}_ASSERT_DEFINED_DEPENDENCIES_DEFAULT IGNORE)
endif()
endif()
if ("${${PROJECT_NAME}_ASSERT_DEFINED_DEPENDENCIES_DEFAULT}" STREQUAL "")
if (${PROJECT_NAME}_ENABLE_DEVELOPMENT_MODE)
set(${PROJECT_NAME}_ASSERT_DEFINED_DEPENDENCIES_DEFAULT FATAL_ERROR)
else()
set(${PROJECT_NAME}_ASSERT_DEFINED_DEPENDENCIES_DEFAULT IGNORE)
endif()
endif()
set(${PROJECT_NAME}_ASSERT_DEFINED_DEPENDENCIES_ERROR_VALUES_LIST
"FATAL_ERROR" "SEND_ERROR" )
set(${PROJECT_NAME}_ASSERT_DEFINED_DEPENDENCIES_VALUES_LIST
${${PROJECT_NAME}_ASSERT_DEFINED_DEPENDENCIES_ERROR_VALUES_LIST}
"WARNING" "NOTICE" "IGNORE" "OFF" )
tribits_add_enum_cache_var( ${PROJECT_NAME}_ASSERT_DEFINED_DEPENDENCIES
DEFAULT_VAL ${${PROJECT_NAME}_ASSERT_DEFINED_DEPENDENCIES_DEFAULT}
DOC_STRING
"Assert that all external and internal dependencies are defined in the project"
ALLOWED_STRINGS_LIST
${${PROJECT_NAME}_ASSERT_DEFINED_DEPENDENCIES_VALUES_LIST}
IS_ADVANCED )
if ("${${PROJECT_NAME}_ASSERT_CORRECT_TRIBITS_USAGE_DEFAULT}" STREQUAL "")
if (${PROJECT_NAME}_ENABLE_DEVELOPMENT_MODE)
set(${PROJECT_NAME}_ASSERT_CORRECT_TRIBITS_USAGE_DEFAULT FATAL_ERROR)
else()
set(${PROJECT_NAME}_ASSERT_CORRECT_TRIBITS_USAGE_DEFAULT IGNORE)
endif()
endif()
set(${PROJECT_NAME}_ASSERT_CORRECT_TRIBITS_USAGE_VALUES_LIST
"FATAL_ERROR" "SEND_ERROR" "WARNING" "IGNORE" "OFF")
tribits_add_enum_cache_var( ${PROJECT_NAME}_ASSERT_CORRECT_TRIBITS_USAGE
DEFAULT_VAL "${${PROJECT_NAME}_ASSERT_CORRECT_TRIBITS_USAGE_DEFAULT}"
DOC_STRING
"Assert correct usage of TriBITS"
ALLOWED_STRINGS_LIST
${${PROJECT_NAME}_ASSERT_CORRECT_TRIBITS_USAGE_VALUES_LIST}
IS_ADVANCED )
advanced_set( ${PROJECT_NAME}_WARN_ABOUT_MISSING_EXTERNAL_PACKAGES
FALSE CACHE BOOL
"If set to TRUE, a 'NOTE' is printed for each missing package that is ignored." )
advanced_set( ${PROJECT_NAME}_ENABLE_STRONG_C_COMPILE_WARNINGS
${${PROJECT_NAME}_ENABLE_DEVELOPMENT_MODE}
CACHE BOOL "Enable strong compiler warnings for C code for supported compilers." )
advanced_set( ${PROJECT_NAME}_ENABLE_STRONG_CXX_COMPILE_WARNINGS
${${PROJECT_NAME}_ENABLE_DEVELOPMENT_MODE}
CACHE BOOL "Enable strong compiler warnings for C++ code for supported compilers." )
multiline_set( ENABLE_SHADOW_WARNINGS_DOC
"Turn ON or OFF shadowing warnings for all packages where strong warnings have"
" not been explicitly disabled. Setting the empty '' let's each package decide." )
set_cache_on_off_empty( ${PROJECT_NAME}_ENABLE_SHADOW_WARNINGS ""
"${ENABLE_SHADOW_WARNINGS_DOC}" )
mark_as_advanced(${PROJECT_NAME}_ENABLE_SHADOW_WARNINGS)
advanced_set( ${PROJECT_NAME}_ENABLE_COVERAGE_TESTING OFF
CACHE BOOL "Enable support for coverage testing by setting needed compiler/linker options." )
advanced_set( ${PROJECT_NAME}_ENABLE_CHECKED_STL OFF
CACHE BOOL "Turn on checked STL checking (e.g. -D_GLIBCXX_DEBUG) or not." )
advanced_set( ${PROJECT_NAME}_ENABLE_DEBUG_SYMBOLS OFF
CACHE BOOL "Turn on debugging symbols (e.g. -g) or not if not a full debug build." )
if (CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
set(${PROJECT_NAME}_WARNINGS_AS_ERRORS_FLAGS_DEFAULT "-Werror")
else()
set(${PROJECT_NAME}_WARNINGS_AS_ERRORS_FLAGS_DEFAULT "")
endif()
advanced_set( ${PROJECT_NAME}_WARNINGS_AS_ERRORS_FLAGS
"${${PROJECT_NAME}_WARNINGS_AS_ERRORS_FLAGS_DEFAULT}"
CACHE STRING "Flags for treating warnings as errors (for all compilers, -Werror by default for GNU). To turn off warnings as errors set to ''")
advanced_set(${PROJECT_NAME}_ENABLE_CIRCULAR_REF_DETECTION_FAILURE OFF CACHE BOOL
"If test output complaining about circular references is found, then the test will fail." )
advanced_set(${PROJECT_NAME}_DEPS_DEFAULT_OUTPUT_DIR ""
CACHE FILEPATH
"If set to non-null, this is the default directory where package dependency files will be written.")
if (${PROJECT_NAME}_DEPS_DEFAULT_OUTPUT_DIR)
set(${PROJECT_NAME}_DEPS_XML_OUTPUT_FILE_DEFAULT
"${${PROJECT_NAME}_DEPS_DEFAULT_OUTPUT_DIR}/${${PROJECT_NAME}_PACKAGE_DEPS_XML_FILE_NAME}")
else()
set(${PROJECT_NAME}_DEPS_XML_OUTPUT_FILE_DEFAULT "")
endif()
advanced_set(${PROJECT_NAME}_DEPS_XML_OUTPUT_FILE
"${${PROJECT_NAME}_DEPS_XML_OUTPUT_FILE_DEFAULT}"
CACHE STRING
"Output XML file containing ${PROJECT_NAME} dependenices used by tools (if not empty)." )
if(${PROJECT_NAME}_DEPS_DEFAULT_OUTPUT_DIR AND
${PROJECT_NAME}_DEPS_XML_OUTPUT_FILE AND Python3_EXECUTABLE
)
set(${PROJECT_NAME}_CDASH_DEPS_XML_OUTPUT_FILE_DEFAULT
"${${PROJECT_NAME}_DEPS_DEFAULT_OUTPUT_DIR}/${${PROJECT_NAME}_CDASH_SUBPROJECT_DEPS_XML_FILE_NAME}" )
else()
set(${PROJECT_NAME}_CDASH_DEPS_XML_OUTPUT_FILE_DEFAULT "")
endif()
advanced_set(${PROJECT_NAME}_CDASH_DEPS_XML_OUTPUT_FILE
"${${PROJECT_NAME}_CDASH_DEPS_XML_OUTPUT_FILE_DEFAULT}"
CACHE STRING
"Output XML file used by CDash in ${PROJECT_NAME}-independent format (if not empty)." )
if(${PROJECT_NAME}_DEPS_DEFAULT_OUTPUT_DIR AND
${PROJECT_NAME}_DEPS_XML_OUTPUT_FILE AND Python3_EXECUTABLE
)
set(${PROJECT_NAME}_DEPS_HTML_OUTPUT_FILE_DEFAULT
"${${PROJECT_NAME}_DEPS_DEFAULT_OUTPUT_DIR}/${${PROJECT_NAME}_PACKAGE_DEPS_TABLE_HTML_FILE_NAME}" )
else()
set(${PROJECT_NAME}_DEPS_HTML_OUTPUT_FILE_DEFAULT "")
endif()
advanced_set(${PROJECT_NAME}_DEPS_HTML_OUTPUT_FILE
"${${PROJECT_NAME}_DEPS_HTML_OUTPUT_FILE_DEFAULT}"
CACHE STRING
"HTML ${PROJECT_NAME} dependenices file that will be written to (if not empty)." )
#
# Extra repositories
#
assert_defined(${PROJECT_NAME}_EXTRA_EXTERNAL_REPOS_FILE_NAME)
set(DEFAULT_EXTRA_REPOS_FILE
"${PROJECT_SOURCE_DIR}/cmake/${${PROJECT_NAME}_EXTRA_EXTERNAL_REPOS_FILE_NAME}")
if (EXISTS ${DEFAULT_EXTRA_REPOS_FILE})
#message("${DEFAULT_EXTRA_REPOS_FILE} does exist!")
set(${PROJECT_NAME}_EXTRAREPOS_FILE_DEFAULT ${DEFAULT_EXTRA_REPOS_FILE})
else()
#message("${DEFAULT_EXTRA_REPOS_FILE} does *NOT* exist!")
set(${PROJECT_NAME}_EXTRAREPOS_FILE_DEFAULT)
endif()
advanced_set(${PROJECT_NAME}_EXTRAREPOS_FILE
"${${PROJECT_NAME}_EXTRAREPOS_FILE_DEFAULT}"
CACHE STRING
"File containing the list of extra repositories containing add-on packages to process")
#print_var(${PROJECT_NAME}_EXTRAREPOS_FILE)
advanced_set(${PROJECT_NAME}_ENABLE_KNOWN_EXTERNAL_REPOS_TYPE
""
CACHE STRING
"Type of testing to pull in extra repositories (Continuous, or Nightly)" )
advanced_set(${PROJECT_NAME}_IGNORE_MISSING_EXTRA_REPOSITORIES
FALSE CACHE BOOL
"Set if to ignore missing extra repositories (or fail hard)" )
# Even if a project does not support an extra repos file, it can always
# support extra repositories defined by the user by the very nature of
# Tribits.
advanced_set(${PROJECT_NAME}_PRE_REPOSITORIES
""
CACHE STRING
"List of pre-extra repositories that contain extra ${PROJECT_NAME} packages."
)
split("${${PROJECT_NAME}_PRE_REPOSITORIES}" "," ${PROJECT_NAME}_PRE_REPOSITORIES)
advanced_set(${PROJECT_NAME}_EXTRA_REPOSITORIES
""
CACHE STRING
"List of post-extra repositories that contain extra ${PROJECT_NAME} packages."
)
split("${${PROJECT_NAME}_EXTRA_REPOSITORIES}" "," ${PROJECT_NAME}_EXTRA_REPOSITORIES)
if ("${${PROJECT_NAME}_CHECK_EXTRAREPOS_EXIST}" STREQUAL "")
set(${PROJECT_NAME}_CHECK_EXTRAREPOS_EXIST TRUE)
endif()
tribits_get_and_process_extra_repositories_lists()
advanced_set(${PROJECT_NAME}_INSTALLATION_DIR
"" CACHE STRING
"Location of an installed version of ${PROJECT_NAME} that will be built against during installation testing"
)
#
# More options
#
if("${${PROJECT_NAME}_INSTALLATION_DIR}" STREQUAL "")
set(${PROJECT_NAME}_ENABLE_INSTALLATION_TESTING_DEFAULT OFF)
else()
set(${PROJECT_NAME}_ENABLE_INSTALLATION_TESTING_DEFAULT ON)
endif()
advanced_set(${PROJECT_NAME}_ENABLE_INSTALLATION_TESTING
${${PROJECT_NAME}_ENABLE_INSTALLATION_TESTING_DEFAULT}
CACHE STRING
"Enable testing against an installed version of ${PROJECT_NAME}."
)
advanced_option(${PROJECT_NAME}_SHORTCIRCUIT_AFTER_DEPENDENCY_HANDLING
"Short-circuit after dependency handling is complete"
OFF )
advanced_option(${PROJECT_NAME}_TRACE_DEPENDENCY_HANDLING_ONLY
"Only trace dependency handling. Don't configure to build anything!"
OFF )
advanced_set(${PROJECT_NAME}_ENABLE_CONFIGURE_TIMING
FALSE CACHE BOOL
"Set to 'ON' to see configure times (Unix/Linux systems only)" )
advanced_set(${PROJECT_NAME}_ENABLE_PACKAGE_CONFIGURE_TIMING
FALSE CACHE BOOL
"Set to 'ON' to see configure times for individual packages" )
if ("${${PROJECT_NAME}_SHOW_TEST_START_END_DATE_TIME_DEFAULT}"
STREQUAL ""
)
set(${PROJECT_NAME}_SHOW_TEST_START_END_DATE_TIME_DEFAULT OFF)
endif()
advanced_set(${PROJECT_NAME}_SHOW_TEST_START_END_DATE_TIME
${${PROJECT_NAME}_SHOW_TEST_START_END_DATE_TIME_DEFAULT}
CACHE BOOL
"Set to 'ON' to see start and end date/time for advanced tests." )
if ("${${PROJECT_NAME}_SHOW_MACHINE_LOAD_IN_TEST_DEFAULT}"
STREQUAL ""
)
set(${PROJECT_NAME}_SHOW_MACHINE_LOAD_IN_TEST_DEFAULT OFF)
endif()
advanced_set(${PROJECT_NAME}_SHOW_MACHINE_LOAD_IN_TEST
${${PROJECT_NAME}_SHOW_MACHINE_LOAD_IN_TEST_DEFAULT}
CACHE BOOL
"Set to 'ON' to see the machine load for advanced tests." )
if ("${TRIBITS_HANDLE_TRIBITS_DEPRECATED_CODE_DEFAULT}" STREQUAL "")
set(TRIBITS_HANDLE_TRIBITS_DEPRECATED_CODE_DEFAULT "DEPRECATION")
endif()
tribits_add_enum_cache_var(TRIBITS_HANDLE_TRIBITS_DEPRECATED_CODE
DEFAULT_VAL "${TRIBITS_HANDLE_TRIBITS_DEPRECATED_CODE_DEFAULT}"
DOC_STRING "Mode for dealing with usage of TriBITS deprecated functionality"
ALLOWED_STRINGS_LIST ${TRIBITS_HANDLE_TRIBITS_DEPRECATED_CODE_ALL_VALID_VALUES}
IS_ADVANCED
)
mark_as_advanced(BUILD_TESTING)
mark_as_advanced(CMAKE_BACKWARDS_COMPATIBILITY)
mark_as_advanced(DART_TESTING_TIMEOUT)
mark_as_advanced(EXECUTABLE_OUTPUT_PATH)
mark_as_advanced(LIBRARY_OUTPUT_PATH)
mark_as_advanced(CMAKE_OSX_ARCHITECTURES)
mark_as_advanced(CMAKE_OSX_SYSROOT)
endmacro()
macro(tribits_setup_installation_paths)
#
# A) Determine if we are going to be using default paths from GNUInstallDirs module
#
set(TRIBITS_USE_GNUINSTALLDIRS TRUE)
if (NOT ${PROJECT_NAME}_USE_GNUINSTALLDIRS)
# For backward compatibility and unit testing
set(TRIBITS_USE_GNUINSTALLDIRS FALSE)
endif()
#
# B) Pick the defaults for the install dirs
#
if (TRIBITS_USE_GNUINSTALLDIRS)
include(GNUInstallDirs)
set(${PROJECT_NAME}_INSTALL_INCLUDE_DIR_DEFAULT ${CMAKE_INSTALL_INCLUDEDIR})
set(${PROJECT_NAME}_INSTALL_LIB_DIR_DEFAULT ${CMAKE_INSTALL_LIBDIR})
set(${PROJECT_NAME}_INSTALL_RUNTIME_DIR_DEFAULT ${CMAKE_INSTALL_BINDIR})
set(${PROJECT_NAME}_INSTALL_EXAMPLE_DIR_DEFAULT "example")
else()
set(${PROJECT_NAME}_INSTALL_INCLUDE_DIR_DEFAULT "include")
set(${PROJECT_NAME}_INSTALL_LIB_DIR_DEFAULT "lib")
set(${PROJECT_NAME}_INSTALL_RUNTIME_DIR_DEFAULT "bin")
set(${PROJECT_NAME}_INSTALL_EXAMPLE_DIR_DEFAULT "example")
endif()
#
# C) Set the cache variables for the install dirs