-
Notifications
You must be signed in to change notification settings - Fork 6
/
c4Project.cmake
3810 lines (3546 loc) · 149 KB
/
c4Project.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
if(NOT _c4_project_included)
set(_c4_project_included ON)
set(_c4_project_file ${CMAKE_CURRENT_LIST_FILE})
set(_c4_project_dir ${CMAKE_CURRENT_LIST_DIR})
# "I didn't have time to write a short letter, so I wrote a long one
# instead." -- Mark Twain
#
# ... Eg, hopefully this code will be cleaned up. There's a lot of
# code here that can be streamlined into a more intuitive arrangement.
cmake_minimum_required(VERSION 3.12 FATAL_ERROR)
list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR})
set_property(GLOBAL PROPERTY USE_FOLDERS ON)
include(CMakeDependentOption)
include(ConfigurationTypes)
include(CreateSourceGroup)
include(c4StaticAnalysis)
include(PrintVar)
include(c4CatSources)
include(c4Doxygen)
include(PatchUtils)
#------------------------------------------------------------------------------
#------------------------------------------------------------------------------
#------------------------------------------------------------------------------
# define c4 project settings
set(C4_EXTERN_DIR "$ENV{C4_EXTERN_DIR}" CACHE PATH "the directory where imported projects should be looked for (or cloned in when not found)")
set(C4_DBG_ENABLED OFF CACHE BOOL "enable detailed cmake logs in c4Project code")
set(C4_LIBRARY_TYPE "" CACHE STRING "default library type: either \"\"(defer to BUILD_SHARED_LIBS),INTERFACE,STATIC,SHARED,MODULE")
set(C4_SOURCE_TRANSFORM NONE CACHE STRING "global source transform method")
set(C4_HDR_EXTS "h;hpp;hh;h++;hxx" CACHE STRING "list of header extensions for determining which files are headers")
set(C4_SRC_EXTS "c;cpp;cc;c++;cxx;cu;" CACHE STRING "list of compilation unit extensions for determining which files are sources")
set(C4_ADD_EXTS "natvis" CACHE STRING "list of additional file extensions that might be added as sources to targets")
set(C4_GEN_SRC_EXT "cpp" CACHE STRING "the extension of the output source files resulting from concatenation")
set(C4_GEN_HDR_EXT "hpp" CACHE STRING "the extension of the output header files resulting from concatenation")
set(C4_CXX_STANDARDS "20;17;14;11" CACHE STRING "list of CXX standards")
set(C4_CXX_STANDARD_DEFAULT "11" CACHE STRING "the default CXX standard for projects not specifying one")
#------------------------------------------------------------------------------
#------------------------------------------------------------------------------
#------------------------------------------------------------------------------
macro(c4_log)
message(STATUS "${_c4_prefix}: ${ARGN}")
endmacro()
macro(c4_err)
message(FATAL_ERROR "${_c4_prefix}: ${ARGN}")
endmacro()
macro(c4_dbg)
if(C4_DBG_ENABLED)
message(STATUS "${_c4_prefix}: ${ARGN}")
endif()
endmacro()
macro(c4_log_var varname)
c4_log("${varname}=${${varname}} ${ARGN}")
endmacro()
macro(c4_log_vars)
set(____s____)
foreach(varname ${ARGN})
set(____s____ "${____s____}${varname}=${${varname}} ")
endforeach()
c4_log("${____s____}")
endmacro()
macro(c4_dbg_var varname)
c4_dbg("${varname}=${${varname}} ${ARGN}")
endmacro()
macro(c4_log_var_if varname)
if(${varname})
c4_log("${varname}=${${varname}} ${ARGN}")
endif()
endmacro()
macro(c4_dbg_var_if varname)
if(${varname})
c4_dbg("${varname}=${${varname}} ${ARGN}")
endif()
endmacro()
macro(_c4_show_pfx_vars)
if(NOT ("${ARGN}" STREQUAL ""))
c4_log("prefix vars: ${ARGN}")
endif()
print_var(_c4_prefix)
print_var(_c4_ocprefix)
print_var(_c4_ucprefix)
print_var(_c4_lcprefix)
print_var(_c4_oprefix)
print_var(_c4_uprefix)
print_var(_c4_lprefix)
endmacro()
function(c4_zero_pad padded size str)
string(LENGTH "${str}" len)
math(EXPR numchars "${size} - ${len}")
if(numchars EQUAL 0)
set(${padded} "${str}" PARENT_SCOPE)
else()
set(out "${str}")
math(EXPR ncm1 "${numchars} - 1")
foreach(z RANGE ${ncm1})
set(out "0${out}")
endforeach()
set(${padded} "${out}" PARENT_SCOPE)
endif()
endfunction()
#------------------------------------------------------------------------------
#------------------------------------------------------------------------------
#------------------------------------------------------------------------------
# handy macro for dealing with arguments in one single statement.
# look for example usage cases below.
macro(_c4_handle_args)
set(opt0arg
)
set(opt1arg
_PREFIX
)
set(optNarg
_ARGS0
_ARGS1
_ARGSN
_ARGS
_DEPRECATE
)
# parse the arguments to this macro to find out the required arguments
cmake_parse_arguments("__c4ha" "${opt0arg}" "${opt1arg}" "${optNarg}" ${ARGN})
# now parse the required arguments
cmake_parse_arguments("${__c4ha__PREFIX}" "${__c4ha__ARGS0}" "${__c4ha__ARGS1}" "${__c4ha__ARGSN}" ${__c4ha__ARGS})
# raise an error on deprecated arguments
foreach(a ${__c4ha__DEPRECATE})
list(FIND __c4ha__ARGS ${a} contains)
if(NOT (${contains} EQUAL -1))
c4err("${a} is deprecated")
endif()
endforeach()
endmacro()
# fallback to provided default(s) if argument is not set
macro(_c4_handle_arg argname)
if("${_${argname}}" STREQUAL "")
set(_${argname} "${ARGN}")
else()
set(_${argname} "${_${argname}}")
endif()
endmacro()
macro(_c4_handle_arg_no_pfx argname)
if("${${argname}}" STREQUAL "")
set(${argname} "${ARGN}")
else()
set(${argname} "${${argname}}")
endif()
endmacro()
# if ${_${argname}} is non empty, return it
# otherwise, fallback to ${_c4_uprefix}${argname}
# otherwise, fallback to C4_${argname}
# otherwise, fallback to provided default through ${ARGN}
macro(_c4_handle_arg_or_fallback argname)
if(NOT ("${_${argname}}" STREQUAL ""))
c4_dbg("handle arg ${argname}: picking explicit value _${argname}=${_${argname}}")
else()
foreach(_c4haf_varname "${_c4_uprefix}${argname}" "C4_${argname}" "${argname}" "CMAKE_${argname}")
set(v ${${_c4haf_varname}})
if("${v}" STREQUAL "")
c4_dbg("handle arg ${argname}: ${_c4haf_varname}: empty, continuing")
else()
c4_dbg("handle arg ${argname}: ${_c4haf_varname}=${v} not empty!")
c4_setg(_${argname} "${v}")
break()
endif()
endforeach()
if("${_${argname}}" STREQUAL "")
c4_dbg("handle arg ${argname}: picking default: ${ARGN}")
c4_setg(_${argname} "${ARGN}")
endif()
endif()
endmacro()
#------------------------------------------------------------------------------
#------------------------------------------------------------------------------
#------------------------------------------------------------------------------
function(c4_get_config var name)
c4_dbg("get_config: ${var} ${name}")
c4_get_from_first_of(config ${ARGN} VARS ${_c4_uprefix}${name} C4_${name} ${name})
c4_dbg("get_config: ${var} ${name}=${config}")
set(${var} ${config} PARENT_SCOPE)
endfunction()
function(c4_get_from_first_of var)
_c4_handle_args(_ARGS ${ARGN}
_ARGS0
REQUIRED # raise an error if no set variable was found
ENV # if none of the provided vars is given,
# then search next on environment variables
# of the same name, using the same sequence
_ARGS1
DEFAULT
_ARGSN
VARS
)
c4_dbg("get_from_first_of(): searching ${var}")
foreach(_var ${_VARS})
set(val ${${_var}})
c4_dbg("${var}: searching ${_var}=${val}")
if(NOT ("${val}" STREQUAL ""))
set(${var} "${val}" PARENT_SCOPE)
return()
endif()
endforeach()
if(_ENV)
foreach(_envvar ${_VARS})
set(val $ENV{${_envvar}})
c4_dbg("${var}: searching environment variable ${_envvar}=${val}")
if(NOT ("${val}" STREQUAL ""))
c4_dbg("${var}: picking ${val} from ${_envvar}")
set(${var} "${val}" PARENT_SCOPE)
return()
endif()
endforeach()
endif()
if(_REQUIRED)
c4_err("could not find a value for the variable ${var}")
endif()
set(${var} ${_DEFAULT} PARENT_SCOPE)
endfunction()
#------------------------------------------------------------------------------
#------------------------------------------------------------------------------
#------------------------------------------------------------------------------
# assumes a prior call to project()
function(c4_project)
_c4_handle_args(_ARGS ${ARGN}
_ARGS0 # zero-value macro arguments
STANDALONE # Declare that targets from this project MAY be
# compiled in standalone mode. In this mode, any
# designated libraries on which a target depends
# will be incorporated into the target instead of
# being linked with it. The effect is to "flatten"
# those libraries into the requesting library, with
# their sources now becoming part of the requesting
# library; their dependencies are transitively handled.
# Note that requesting targets must explicitly
# opt-in to this behavior via the INCORPORATE
# argument to c4_add_library() or
# c4_add_executable(). Note also that this behavior
# is only enabled if this project's option
# ${prefix}_STANDALONE or C4_STANDALONE is set to ON.
_ARGS1 # one-value macro arguments
AUTHOR # specify author(s); used in cpack
VERSION # cmake does not accept semantic versioning so we provide
# that here (see https://gitlab.kitware.com/cmake/cmake/-/issues/16716)
CXX_STANDARD # one of latest;${C4_VALID_CXX_STANDARDS}
# if this is not provided, falls back on
# ${uprefix}CXX_STANDARD, then C4_CXX_STANDARD,
# then CXX_STANDARD. if none are provided,
# defaults to 11
_ARGSN # multi-value macro arguments
)
# get the prefix from the call to project()
set(prefix ${PROJECT_NAME})
string(TOUPPER "${prefix}" ucprefix) # ucprefix := upper case prefix
string(TOLOWER "${prefix}" lcprefix) # lcprefix := lower case prefix
if(NOT _c4_prefix)
c4_setg(_c4_is_root_proj ON)
c4_setg(_c4_root_proj ${prefix})
c4_setg(_c4_root_uproj ${ucprefix})
c4_setg(_c4_root_lproj ${lcprefix})
c4_setg(_c4_curr_path "")
else()
c4_setg(_c4_is_root_proj OFF)
if(_c4_curr_path)
c4_setg(_c4_curr_path "${_c4_curr_path}/${prefix}")
else()
c4_setg(_c4_curr_path "${prefix}")
endif()
endif()
c4_setg(_c4_curr_subproject ${prefix})
# get the several prefix flavors
c4_setg(_c4_ucprefix ${ucprefix})
c4_setg(_c4_lcprefix ${lcprefix})
c4_setg(_c4_ocprefix ${prefix}) # ocprefix := original case prefix
c4_setg(_c4_prefix ${prefix}) # prefix := original prefix
c4_setg(_c4_oprefix ${prefix}) # oprefix := original prefix
c4_setg(_c4_uprefix ${_c4_ucprefix}) # upper prefix: for variables
c4_setg(_c4_lprefix ${_c4_lcprefix}) # lower prefix: for targets
if(_c4_oprefix)
c4_setg(_c4_oprefix "${_c4_oprefix}_")
endif()
if(_c4_uprefix)
c4_setg(_c4_uprefix "${_c4_uprefix}_")
endif()
if(_c4_lprefix)
c4_setg(_c4_lprefix "${_c4_lprefix}-")
endif()
#
if(_STANDALONE)
option(${_c4_uprefix}STANDALONE
"Enable compilation of opting-in targets from ${_c4_lcprefix} in standalone mode (ie, incorporate subprojects as specified in the INCORPORATE clause to c4_add_library/c4_add_target)"
${_c4_is_root_proj})
c4_setg(_c4_root_proj_standalone ${_c4_uprefix}STANDALONE)
endif()
_c4_handle_arg_or_fallback(CXX_STANDARD ${C4_CXX_STANDARD_DEFAULT})
_c4_handle_arg(VERSION 0.0.0-pre0)
_c4_handle_arg(AUTHOR "")
_c4_handle_semantic_version(${_VERSION})
#
# make sure project-wide settings are defined -- see cmake's
# documentation for project(), which defines these and other
# variables
if("${PROJECT_DESCRIPTION}" STREQUAL "")
c4_setg(PROJECT_DESCRIPTION "${prefix}")
c4_setg(${prefix}_DESCRIPTION "${prefix}")
endif()
if("${PROJECT_HOMEPAGE_URL}" STREQUAL "")
c4_setg(PROJECT_HOMEPAGE_URL "")
c4_setg(${prefix}_HOMEPAGE_URL "")
endif()
# other specific c4_project properties
c4_setg(PROJECT_AUTHOR "${_AUTHOR}")
c4_setg(${prefix}_AUTHOR "${_AUTHOR}")
# CXX standard
if("${_CXX_STANDARD}" STREQUAL "latest")
_c4_find_latest_supported_cxx_standard(_CXX_STANDARD)
endif()
c4_log("using C++ standard: C++${_CXX_STANDARD}")
c4_set_proj_prop(CXX_STANDARD "${_CXX_STANDARD}")
c4_setg(${_c4_uprefix}CXX_STANDARD "${_CXX_STANDARD}")
if(${_CXX_STANDARD})
c4_set_cxx(${_CXX_STANDARD})
endif()
# we are opinionated with respect to directory structure
c4_setg(${_c4_uprefix}SRC_DIR ${CMAKE_CURRENT_LIST_DIR}/src)
c4_setg(${_c4_uprefix}EXT_DIR ${CMAKE_CURRENT_LIST_DIR}/ext)
c4_setg(${_c4_uprefix}API_DIR ${CMAKE_CURRENT_LIST_DIR}/api)
# opionionated also for directory test
# opionionated also for directory bm (benchmarks)
if("${C4_DEV}" STREQUAL "")
option(C4_DEV "enable development targets for all c4 projects" OFF)
endif()
option(${_c4_uprefix}DEV "enable development targets: tests, benchmarks, static analysis, coverage" ${C4_DEV})
if(EXISTS "${CMAKE_CURRENT_LIST_DIR}/test")
cmake_dependent_option(${_c4_uprefix}BUILD_TESTS "build unit tests" ON ${_c4_uprefix}DEV OFF)
else()
c4_dbg("no tests: directory does not exist: ${CMAKE_CURRENT_LIST_DIR}/test")
endif()
if(EXISTS "${CMAKE_CURRENT_LIST_DIR}/bm")
cmake_dependent_option(${_c4_uprefix}BUILD_BENCHMARKS "build benchmarks" ON ${_c4_uprefix}DEV OFF)
else()
c4_dbg("no benchmarks: directory does not exist: ${CMAKE_CURRENT_LIST_DIR}/bm")
endif()
if(EXISTS "${CMAKE_CURRENT_LIST_DIR}/api")
cmake_dependent_option(${_c4_uprefix}BUILD_API "build API" OFF ${_c4_uprefix}DEV OFF)
else()
c4_dbg("no API generation: directory does not exist: ${CMAKE_CURRENT_LIST_DIR}/api")
endif()
if(_c4_is_root_proj)
c4_setup_coverage()
endif()
c4_setup_sanitize()
c4_setup_valgrind(${_c4_uprefix}DEV)
c4_setup_static_analysis(${_c4_uprefix}DEV)
c4_setup_doxygen(${_c4_uprefix}DEV)
# option to use libc++
option(${_c4_uprefix}USE_LIBCXX "use libc++ instead of the default standard library" OFF)
if(${_c4_uprefix}USE_LIBCXX)
if(CMAKE_CXX_COMPILER_ID MATCHES ".*Clang")
c4_log("using libc++")
list(APPEND CMAKE_CXX_FLAGS -stdlib=libc++)
list(APPEND CMAKE_EXE_LINKER_FLAGS -lc++)
list(APPEND CMAKE_MODULE_LINKER_FLAGS -lc++)
list(APPEND CMAKE_SHARED_LINKER_FLAGS -lc++)
list(APPEND CMAKE_STATIC_LINKER_FLAGS -lc++)
else()
c4_err("libc++ can only be used with clang")
endif()
endif()
# default compilation flags
set(${_c4_uprefix}CXX_FLAGS "${${_c4_uprefix}CXX_FLAGS_FWD}" CACHE STRING "compilation flags for ${_c4_prefix} targets")
set(${_c4_uprefix}CXX_LINKER_FLAGS "${${_c4_uprefix}CXX_LINKER_FLAGS_FWD}" CACHE STRING "linker flags for ${_c4_prefix} targets")
c4_dbg_var_if(${_c4_uprefix}CXX_LINKER_FLAGS_FWD)
c4_dbg_var_if(${_c4_uprefix}CXX_FLAGS_FWD)
c4_dbg_var_if(${_c4_uprefix}CXX_LINKER_FLAGS)
c4_dbg_var_if(${_c4_uprefix}CXX_FLAGS)
# Dev compilation flags, appended to the project's flags. They
# are enabled when in dev mode, but provided as a (default-disabled)
# option when not in dev mode
c4_dbg_var_if(${_c4_uprefix}CXX_FLAGS_OPT_FWD)
c4_setg(${_c4_uprefix}CXX_FLAGS_OPT "${${_c4_uprefix}CXX_FLAGS_OPT_FWD}")
c4_optional_compile_flags_dev(WERROR "Compile with warnings as errors"
GCC_CLANG -Werror -pedantic-errors
MSVC /WX
)
c4_optional_compile_flags_dev(STRICT_ALIASING "Enable strict aliasing"
GCC_CLANG -fstrict-aliasing
MSVC # does it have this?
)
c4_optional_compile_flags_dev(PEDANTIC "Compile in pedantic mode"
GCC ${_C4_PEDANTIC_FLAGS_GCC}
CLANG ${_C4_PEDANTIC_FLAGS_CLANG}
MSVC ${_C4_PEDANTIC_FLAGS_MSVC}
)
c4_dbg_var_if(${_c4_uprefix}CXX_FLAGS_OPT)
endfunction(c4_project)
#------------------------------------------------------------------------------
#------------------------------------------------------------------------------
#------------------------------------------------------------------------------
macro(c4_setup_sanitize)
if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME)
set(_c4_enable_sanitize ON)
if(NOT ((CMAKE_CXX_COMPILER_ID MATCHES ".*Clang") OR (CMAKE_CXX_COMPILER_ID STREQUAL "GNU")))
set(_c4_enable_sanitize OFF)
endif()
if("${CMAKE_BUILD_TYPE}" STREQUAL "Coverage")
set(_c4_enable_sanitize OFF)
endif()
if(_c4_enable_sanitize)
if("${CMAKE_BUILD_TYPE}" STREQUAL "")
set(CMAKE_BUILD_TYPE Release)
endif()
if(CMAKE_C_COMPILER_ID STREQUAL "GNU") # is there coverage?
set(CMAKE_BUILD_TYPE ${CMAKE_BUILD_TYPE} CACHE
STRING "Choose the type of build, options are: None Debug Release RelWithDebInfo MinSizeRel Coverage tsan asan lsan msan ubsan" FORCE)
else()
set(CMAKE_BUILD_TYPE ${CMAKE_BUILD_TYPE} CACHE
STRING "Choose the type of build, options are: None Debug Release RelWithDebInfo MinSizeRel tsan asan lsan msan ubsan" FORCE)
endif()
_c4_add_sanitizer_build_type(AddressSanitizer ASAN
# https://clang.llvm.org/docs/AddressSanitizer.html
"-fsanitize=address -g -O1 -fno-omit-frame-pointer -fno-optimize-sibling-calls -fsanitize-address-use-after-scope -DC4_ASAN"
)
_c4_add_sanitizer_build_type(LeakSanitizer LSAN
# https://clang.llvm.org/docs/LeakSanitizer.html
"-fsanitize=leak -g -O1 -fno-omit-frame-pointer -DC4_LSAN"
)
if(NOT (CMAKE_CXX_COMPILER_ID STREQUAL "GNU"))
_c4_add_sanitizer_build_type(MemorySanitizer MSAN
# https://clang.llvm.org/docs/MemorySanitizer.html
"-fsanitize=memory -g -O1 -fno-omit-frame-pointer -fno-optimize-sibling-calls -fsanitize-memory-track-origins=2 -DC4_MSAN"
)
endif()
_c4_add_sanitizer_build_type(ThreadSanitizer TSAN
# https://clang.llvm.org/docs/ThreadSanitizer.html
"-fsanitize=thread -g -O1 -DC4_TSAN"
)
_c4_add_sanitizer_build_type(UndefinedBehaviorSanitizer UBSAN
# https://clang.llvm.org/docs/UndefinedBehaviorSanitizer.html
"-fsanitize=undefined -g -O1 -fno-omit-frame-pointer -DC4_UBSAN"
# these flags added only in the CLANG ubsan
CLANG "-fsanitize=implicit-conversion -fsanitize=local-bounds"
)
endif()
endif()
endmacro()
function(_c4_add_sanitizer_build_type sanitizer build_type _sanflags)
# add compiler-specific flags
cmake_parse_arguments("" "" "" "GCC CLANG" ${ARGN})
if((CMAKE_CXX_COMPILER_ID STREQUAL "Clang") OR (CMAKE_CXX_COMPILER_ID STREQUAL "GNU"))
set(_sanflags "${_sanflags} ${_CLANG}")
elseif (CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
set(_sanflags "${_sanflags} ${_GCC}")
endif()
# force an error exit when any problem is detected:
set(_sanflags "${_sanflags} -fno-sanitize-recover=all")
# add a suppression file
set(do_it ON)
if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
if(${sanitizer} STREQUAL MemorySanitizer)
set(do_it ON)
else()
set(do_it OFF)
endif()
endif()
if(do_it)
set(supprfile ${CMAKE_BINARY_DIR}/c4_suppressions_${sanitizer}.txt)
file(WRITE ${supprfile})
set(_sanflags "${_sanflags} -fsanitize-ignorelist=${supprfile}")
endif()
# set the compile flags
set(CMAKE_C_FLAGS_${build_type} "${_sanflags}" CACHE
STRING "Flags used by the C compiler on ${sanitizer} builds." FORCE)
set(CMAKE_CXX_FLAGS_${build_type} "${_sanflags}" CACHE
STRING "Flags used by the C++ compiler on ${sanitizer} builds." FORCE)
# need to link using the compiler, and not ld
string(TOUPPER "${CMAKE_BUILD_TYPE}" upper)
if("${upper}" STREQUAL "${build_type}")
set(CMAKE_LINKER ${CMAKE_CXX_COMPILER} CACHE FILEPATH "Linker" FORCE)
set(SANITIZER_ENVIRONMENT "${upper}_OPTIONS=print_stacktrace=1" PARENT_SCOPE)
endif()
# this is not needed because we're using the C compiler to link,
# and CMAKE_C_FLAGS will be used with it:
#set(CMAKE_EXE_LINKER_FLAGS_${build_type} "${_sanflags}" CACHE
# STRING "Flags used by the linker on ${sanitizer} builds." FORCE)
endfunction()
function(c4_add_sanitizer_suppression sanitizer suppression)
set(supprfile ${CMAKE_BINARY_DIR}/c4_suppressions_${sanitizer}.txt)
file(APPEND ${supprfile} "#
${suppression}
")
endfunction()
#------------------------------------------------------------------------------
#------------------------------------------------------------------------------
#------------------------------------------------------------------------------
# cmake: VERSION argument in project() does not accept semantic versioning
# see: https://gitlab.kitware.com/cmake/cmake/-/issues/16716
macro(_c4_handle_semantic_version version)
# https://stackoverflow.com/questions/18658233/split-string-to-3-variables-in-cmake
string(REPLACE "." ";" version_list ${version})
list(GET version_list 0 _major)
list(GET version_list 1 _minor)
list(GET version_list 2 _patch)
if("${_patch}" STREQUAL "")
set(_patch 1)
set(_tweak)
else()
string(REGEX REPLACE "([0-9]+)[-_.]?(.*)" "\\2" _tweak ${_patch}) # do this first
string(REGEX REPLACE "([0-9]+)[-_.]?(.*)" "\\1" _patch ${_patch}) # ... because this replaces _patch
endif()
# because cmake handles only numeric tweak fields, make sure to skip our
# semantic tweak field if it is not numeric
if(${_tweak} MATCHES "^[0-9]+$")
set(_safe_tweak ${_tweak})
set(_safe_version ${_major}.${_minor}.${_patch}.${_tweak})
else()
set(_safe_tweak)
set(_safe_version ${_major}.${_minor}.${_patch})
endif()
c4_setg(PROJECT_VERSION_FULL ${version})
c4_setg(PROJECT_VERSION ${_safe_version})
c4_setg(PROJECT_VERSION_MAJOR ${_major})
c4_setg(PROJECT_VERSION_MINOR ${_minor})
c4_setg(PROJECT_VERSION_PATCH ${_patch})
c4_setg(PROJECT_VERSION_TWEAK "${_safe_tweak}")
c4_setg(PROJECT_VERSION_TWEAK_FULL "${_tweak}")
c4_setg(${prefix}_VERSION_FULL ${version})
c4_setg(${prefix}_VERSION ${_safe_version})
c4_setg(${prefix}_VERSION_MAJOR ${_major})
c4_setg(${prefix}_VERSION_MINOR ${_minor})
c4_setg(${prefix}_VERSION_PATCH ${_patch})
c4_setg(${prefix}_VERSION_TWEAK "${_safe_tweak}")
c4_setg(${prefix}_VERSION_TWEAK_FULL "${_tweak}")
endmacro()
# Add targets for testing (dir=./test), benchmark (dir=./bm) and API (dir=./api).
# Call this macro towards the end of the project's main CMakeLists.txt.
# Experimental feature: docs.
function(c4_add_dev_targets)
if(NOT CMAKE_CURRENT_LIST_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
c4_err("this macro needs to be called on the project's main CMakeLists.txt file")
endif()
#
if(${_c4_uprefix}BUILD_TESTS)
if(EXISTS "${CMAKE_CURRENT_LIST_DIR}/test")
c4_dbg("adding tests: ${CMAKE_CURRENT_LIST_DIR}/test")
enable_testing() # this must be done here (and not inside the
# test dir) so that the cmake-generated test
# targets are available at the top level
add_subdirectory(test)
endif()
endif()
#
if(${_c4_uprefix}BUILD_BENCHMARKS)
if(EXISTS "${CMAKE_CURRENT_LIST_DIR}/bm")
c4_dbg("adding benchmarks: ${CMAKE_CURRENT_LIST_DIR}/bm")
add_subdirectory(bm)
endif()
endif()
#
if(${_c4_uprefix}BUILD_API)
if(EXISTS "${CMAKE_CURRENT_LIST_DIR}/api")
c4_dbg("adding API: ${d}")
add_subdirectory(api)
endif()
endif()
#
# FIXME
c4_add_doxygen(doc DOXYFILE_IN ${_c4_project_dir}/Doxyfile.in
PROJ c4core
INPUT ${${_c4_uprefix}SRC_DIR}
EXCLUDE ${${_c4_uprefix}EXT_DIR} ${${_c4_uprefix}SRC_DIR}/c4/ext
STRIP_FROM_PATH ${${_c4_uprefix}SRC_DIR}
STRIP_FROM_INC_PATH ${${_c4_uprefix}SRC_DIR}
CLANG_DATABASE_PATH ${CMAKE_BINARY_DIR}
)
c4_add_doxygen(doc-full DOXYFILE_IN ${_c4_project_dir}/Doxyfile.full.in
PROJ c4core
INPUT ${${_c4_uprefix}SRC_DIR}
EXCLUDE ${${_c4_uprefix}EXT_DIR} ${${_c4_uprefix}SRC_DIR}/c4/ext
STRIP_FROM_PATH ${${_c4_uprefix}SRC_DIR}
STRIP_FROM_INC_PATH ${${_c4_uprefix}SRC_DIR}
CLANG_DATABASE_PATH ${CMAKE_BINARY_DIR}
)
endfunction()
# -----------------------------------------------------------------------------
# -----------------------------------------------------------------------------
# -----------------------------------------------------------------------------
# utilities for compilation flags and defines
# flags enabled only on dev mode
macro(c4_optional_compile_flags_dev tag desc)
_c4_handle_args(_ARGS ${ARGN}
_ARGS0
_ARGS1
_ARGSN
MSVC # flags for Visual Studio compilers
GCC # flags for gcc compilers
CLANG # flags for clang compilers
GCC_CLANG # flags common to gcc and clang
_DEPRECATE
)
if(${CMAKE_VERSION} VERSION_GREATER_EQUAL 3.22)
cmake_policy(PUSH)
cmake_policy(SET CMP0127 NEW)
endif()
cmake_dependent_option(${_c4_uprefix}${tag} "${desc}" ON ${_c4_uprefix}DEV OFF)
if(${CMAKE_VERSION} VERSION_GREATER_EQUAL 3.22)
cmake_policy(POP)
endif()
set(optname ${_c4_uprefix}${tag})
if(${optname})
c4_dbg("${optname} is enabled. Adding flags...")
if(MSVC)
set(flags ${_MSVC})
elseif(CMAKE_CXX_COMPILER_ID MATCHES ".*Clang")
set(flags ${_GCC_CLANG};${_CLANG})
elseif(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
set(flags ${_GCC_CLANG};${_GCC})
elseif(CMAKE_CXX_COMPILER_ID STREQUAL "Intel")
set(flags ${_ALL};${_GCC_CLANG};${_GCC}) # FIXME
elseif(CMAKE_CXX_COMPILER_ID STREQUAL "IntelLLVM")
set(flags ${_ALL};${_GCC_CLANG};${_CLANG}) # FIXME
else()
c4_err("unknown compiler")
endif()
else()
c4_dbg("${optname} is disabled.")
endif()
if(flags)
c4_log("${tag} flags [${desc}]: ${flags}")
c4_setg(${_c4_uprefix}CXX_FLAGS_OPT "${${_c4_uprefix}CXX_FLAGS_OPT};${flags}")
endif()
endmacro()
function(c4_target_compile_flags target)
_c4_handle_args(_ARGS ${ARGN}
_ARGS0
PUBLIC
PRIVATE
INTERFACE
AFTER # this is the default
BEFORE
_ARGS1
_ARGSN
ALL # flags for all compilers
MSVC # flags for Visual Studio compilers
GCC # flags for gcc compilers
CLANG # flags for clang compilers
GCC_CLANG # flags common to gcc and clang
_DEPRECATE
)
if(MSVC)
set(flags ${_ALL};${_MSVC})
elseif(CMAKE_CXX_COMPILER_ID MATCHES ".*Clang")
set(flags ${_ALL};${_GCC_CLANG};${_CLANG})
elseif(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
set(flags ${_ALL};${_GCC_CLANG};${_GCC})
elseif(CMAKE_CXX_COMPILER_ID STREQUAL "Intel")
set(flags ${_ALL};${_GCC_CLANG};${_GCC}) # FIXME
elseif(CMAKE_CXX_COMPILER_ID STREQUAL "IntelLLVM")
set(flags ${_ALL};${_GCC_CLANG};${_CLANG}) # FIXME
else()
c4_err("unknown compiler")
endif()
if(NOT flags)
c4_dbg("no compile flags to be set")
return()
endif()
if(_AFTER OR (NOT _BEFORE))
set(mode)
c4_log("${target}: adding compile flags AFTER: ${flags}")
elseif(_BEFORE)
set(mode BEFORE)
c4_log("${target}: adding compile flags BEFORE: ${flags}")
endif()
if(_PUBLIC)
target_compile_options(${target} ${mode} PUBLIC ${flags})
elseif(_PRIVATE)
target_compile_options(${target} ${mode} PRIVATE ${flags})
elseif(_INTERFACE)
target_compile_options(${target} ${mode} INTERFACE ${flags})
else()
c4_err("${target}: must have one of PUBLIC, PRIVATE or INTERFACE")
endif()
endfunction()
function(c4_target_definitions target)
_c4_handle_args(_ARGS ${ARGN}
_ARGS0
PUBLIC
PRIVATE
INTERFACE
_ARGS1
_ARGSN
ALL # defines for all compilers
MSVC # defines for Visual Studio compilers
GCC # defines for gcc compilers
CLANG # defines for clang compilers
GCC_CLANG # defines common to gcc and clang
_DEPRECATE
)
if(MSVC)
set(flags ${_ALL};${_MSVC})
elseif(CMAKE_CXX_COMPILER_ID MATCHES ".*Clang")
set(flags ${_ALL};${_GCC_CLANG};${_CLANG})
elseif(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
set(flags ${_ALL};${_GCC_CLANG};${_GCC})
else()
c4_err("unknown compiler")
endif()
if(NOT flags)
c4_dbg("no compile flags to be set")
return()
endif()
if(_AFTER OR (NOT _BEFORE))
set(mode)
c4_log("${target}: adding definitions AFTER: ${flags}")
elseif(_BEFORE)
set(mode BEFORE)
c4_log("${target}: adding definitions BEFORE: ${flags}")
endif()
if(_PUBLIC)
target_compile_definitions(${target} ${mode} PUBLIC ${flags})
elseif(_PRIVATE)
target_compile_definitions(${target} ${mode} PRIVATE ${flags})
elseif(_INTERFACE)
target_compile_definitions(${target} ${mode} INTERFACE ${flags})
else()
c4_err("${target}: must have one of PUBLIC, PRIVATE or INTERFACE")
endif()
endfunction()
function(c4_target_remove_compile_flags target)
_c4_handle_args(_ARGS ${ARGN}
_ARGS0
PUBLIC # remove only from public compile options
INTERFACE # remove only from interface compile options
_ARGS1
_ARGSN
MSVC # flags for Visual Studio compilers
GCC # flags for gcc compilers
CLANG # flags for clang compilers
GCC_CLANG # flags common to gcc and clang
_DEPRECATE
)
if(MSVC)
set(flags ${_MSVC})
elseif(CMAKE_CXX_COMPILER_ID MATCHES ".*Clang")
set(flags ${_GCC_CLANG};${_CLANG})
elseif(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
set(flags ${_GCC_CLANG};${_GCC})
else()
c4_err("unknown compiler")
endif()
if(NOT flags)
return()
endif()
if(_PUBLIC OR (NOT _INTERFACE))
get_target_property(co ${target} COMPILE_OPTIONS)
if(co)
_c4_remove_entries_from_list("${flags}" co)
set_target_properties(${target} PROPERTIES COMPILE_OPTIONS "${co}")
endif()
endif()
if(_INTERFACE OR (NOT _PUBLIC))
get_target_property(ico ${target} INTERFACE_COMPILE_OPTIONS)
if(ico)
_c4_remove_entries_from_list("${flags}" ico)
set_target_properties(${target} PROPERTIES INTERFACE_COMPILE_OPTIONS "${ico}")
endif()
endif()
endfunction()
function(_c4_remove_entries_from_list entries_to_remove list)
set(str ${${list}})
string(REPLACE ";" "==?==" str "${str}")
foreach(entry ${entries_to_remove})
string(REPLACE "${entry}" "" str "${str}")
endforeach()
string(REPLACE "==?==" ";" str "${str}")
string(REPLACE ";;" ";" str "${str}")
set(${list} "${str}" PARENT_SCOPE)
endfunction()
# pedantic flags...
# default pedantic flags taken from:
# https://github.com/lefticus/cpp_starter_project/blob/master/cmake/CompilerWarnings.cmake
set(_C4_PEDANTIC_FLAGS_MSVC
/W4 # Baseline reasonable warnings
/w14242 # 'identifier': conversion from 'type1' to 'type1', possible loss of data
/w14254 # 'operator': conversion from 'type1:field_bits' to 'type2:field_bits', possible loss of data
/w14263 # 'function': member function does not override any base class virtual member function
/w14265 # 'classname': class has virtual functions, but destructor is not virtual instances of this class may not
# be destructed correctly
/w14287 # 'operator': unsigned/negative constant mismatch
/we4289 # nonstandard extension used: 'variable': loop control variable declared in the for-loop is used outside
# the for-loop scope
/w14296 # 'operator': expression is always 'boolean_value'
/w14311 # 'variable': pointer truncation from 'type1' to 'type2'
/w14545 # expression before comma evaluates to a function which is missing an argument list
/w14546 # function call before comma missing argument list
/w14547 # 'operator': operator before comma has no effect; expected operator with side-effect
/w14549 # 'operator': operator before comma has no effect; did you intend 'operator'?
/w14555 # expression has no effect; expected expression with side- effect
/w14619 # pragma warning: there is no warning number 'number'
/w14640 # Enable warning on thread un-safe static member initialization
/w14826 # Conversion from 'type1' to 'type_2' is sign-extended. This may cause unexpected runtime behavior.
/w14905 # wide string literal cast to 'LPSTR'
/w14906 # string literal cast to 'LPWSTR'
/w14928 # illegal copy-initialization; more than one user-defined conversion has been implicitly applied
$<$<VERSION_GREATER:${MSVC_VERSION},1900>:/permissive-> # standards conformance mode for MSVC compiler (only vs2017+)
)
set(_C4_PEDANTIC_FLAGS_COMMON
-Wall
-Wextra
-pedantic
-Wpedantic
-Wshadow # warn the user if a variable declaration shadows one from a parent context
-Wnon-virtual-dtor # warn the user if a class with virtual functions has a non-virtual destructor. This helps
# catch hard to track down memory errors
-Wold-style-cast # warn for c-style casts
-Wcast-align # warn for potential performance problem casts
-Wcast-qual
-Wunused # warn on anything being unused
-Wunused-function
-Wunused-variable
-Woverloaded-virtual # warn if you overload (not override) a virtual function
-Wpedantic # warn if non-standard C++ is used
-Wconversion # warn on type conversions that may lose data
-Wsign-conversion # warn on sign conversions
-Wdouble-promotion # warn if float is implicitly promoted to double
-Wfloat-equal # warn if comparing floats
-Wempty-body
-Wformat=2 # warn on security issues around functions that format output (ie printf)
-Wformat-security
# only available for C files:
$<$<COMPILE_LANGUAGE:C>:-Wbad-function-cast>
$<$<COMPILE_LANGUAGE:C>:-Wmissing-prototypes>
$<$<COMPILE_LANGUAGE:C>:-Wold-style-definition>
$<$<COMPILE_LANGUAGE:C>:-Wstrict-prototypes>
$<$<COMPILE_LANGUAGE:C>:-Wpointer-sign>
)
set(_C4_PEDANTIC_FLAGS_CLANG ${_C4_PEDANTIC_FLAGS_COMMON})
set(_C4_PEDANTIC_FLAGS_GCC ${_C4_PEDANTIC_FLAGS_COMMON}
-Wlogical-op # logical operations are used where bitwise were probably wanted
-Wuseless-cast # cast to the same type
)
if(CMAKE_CXX_COMPILER_ID STREQUAL "")
message(FATAL_ERROR "project() must be called before including this file")
elseif(CMAKE_CXX_COMPILER_ID STREQUAL GNU)
if(CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 6.0)
list(APPEND _C4_PEDANTIC_FLAGS_GCC
-Wunused-const-variable
-Wignored-attributes
-Wnull-dereference # warn if a null dereference is detected
-Wmisleading-indentation # where indentation implies blocks where blocks do not exist
-Wduplicated-cond # where if-else chain has duplicated conditions
$<$<COMPILE_LANGUAGE:C>:-Wabsolute-value>
)
endif()
if(CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 7.0)
list(APPEND _C4_PEDANTIC_FLAGS_GCC
-Wduplicated-branches # where if-else branches have duplicated code
)
endif()
if(CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 8.0)
list(APPEND _C4_PEDANTIC_FLAGS_GCC
)
endif()
if(CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 9.0)
list(APPEND _C4_PEDANTIC_FLAGS_GCC
-Waddress-of-packed-member
)
endif()
elseif(CMAKE_CXX_COMPILER_ID STREQUAL Clang)
if(CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 6.0)
list(APPEND _C4_PEDANTIC_FLAGS_CLANG
-Wself-assign
-Wparentheses-equality
-Wgnu-variable-sized-type-not-at-end
-Winconsistent-missing-override
-Wbitfield-constant-conversion
-Wsometimes-uninitialized
-Wextern-initializer
-Wmissing-braces
)
endif()
if(CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 11.0)
list(APPEND _C4_PEDANTIC_FLAGS_CLANG
-Wexcess-initializers
)
endif()
endif()
#------------------------------------------------------------------------------
#------------------------------------------------------------------------------
#------------------------------------------------------------------------------
function(c4_pack_project)
# if this is the top-level project... pack it.
if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME)
c4_log("packing the project: ${ARGN}")
c4_set_default_pack_properties(${ARGN})
include(CPack)
endif()
endfunction()
# [WIP] set convenient defaults for the properties used by CPack
function(c4_set_default_pack_properties)
_c4_handle_args(_ARGS ${ARGN}
_ARGS0 # zero-value macro arguments
_ARGS1 # one-value macro arguments
TYPE # one of LIBRARY, EXECUTABLE
_ARGSN # multi-value macro arguments
)
set(pd "${PROJECT_SOURCE_DIR}")
_c4_handle_arg(TYPE EXECUTABLE) # default to EXECUTABLE
#
_c4_get_platform_tag(platform_tag)
if("${_TYPE}" STREQUAL "LIBRARY")
if(BUILD_SHARED_LIBS)
set(build_tag "-shared")
else()
set(build_tag "-static")
endif()
get_property(multi_config GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
if(multi_config)
# doesn't work because generators are not evaluated: set(build_tag "${build_tag}-$<CONFIG>")
# doesn't work because generators are not evaluated: set(build_tag "${build_tag}$<$<CONFIG:Debug>:-Debug>$<$<CONFIG:MinSizeRel>:-MinSizeRel>$<$<CONFIG:Release>:-Release>$<$<CONFIG:RelWithDebInfo>:-RelWithDebInfo>")
# see also https://stackoverflow.com/questions/44153730/how-to-change-cpack-package-file-name-based-on-configuration
if(CMAKE_BUILD_TYPE) # in the off-chance it was explicitly set
set(build_tag "${build_tag}-${CMAKE_BUILD_TYPE}")
endif()
else()
set(build_tag "${build_tag}-${CMAKE_BUILD_TYPE}")
endif()
elseif("${_TYPE}" STREQUAL "EXECUTABLE")
set(build_tag)