/
common.cmake
1201 lines (894 loc) · 44.7 KB
/
common.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
macro(configure_clang_and_clang_tidy TARGET_NAME)
# Configure Clang and Clang-Tidy for the given target
if(APPLE)
# Note #1: the full list of diagnostic flags for Clang can be found at
# https://clang.llvm.org/docs/DiagnosticsReference.html...
# Note #2: besides C++98 compatibility, which we are not after, some
# warnings are disabled so that Qt-related files can be
# compiled without any problems...
set(COMPILE_OPTIONS
-Weverything
-Wno-c++98-compat
-Wno-c++98-compat-pedantic
-Wno-documentation
-Wno-exit-time-destructors
-Wno-extra-semi-stmt
-Wno-global-constructors
-Wno-header-hygiene
-Wno-missing-prototypes
-Wno-padded
-Wno-redundant-parens
-Wno-sign-conversion
-Wno-unknown-warning-option
-Wno-used-but-marked-unused
-Wno-zero-as-null-pointer-constant
)
set_target_properties(${TARGET_NAME} PROPERTIES
COMPILE_OPTIONS "${COMPILE_OPTIONS}"
)
endif()
if(ENABLE_CLANG_TIDY)
# Note: Clang-Tidy does, by default, only report issues with C++ files.
# When it comes to header files, we must specify the ones for
# which we want issues to be reported, this using `-header-filter`
# and/or `-line-filter`. The problem is that the format of the
# path reported by Clang-Tidy depends on the CMake generator that
# is used. For example, with Ninja, we have a path that looks like
# /a/b/build/../src while with Make it looks like /a/b/src. Also,
# the regular expression needed by `-header-filter` follows the
# POSIX ERE standard rather than the PCRE one, which is a big
# limitation. Indeed, we are not interested in some header files
# that are located in specific folders. Using a PCRE regular
# expression, we could easily filter them out with something like
# ^(?:(?!xxx|yyy|zzz).)*$, i.e. a regular expression with a
# non-capturing group and a negative lookahead, but we can't since
# we need a POSIX ERE regulard expression. So, in the end, we ask
# for issues related to header files located under ../src, which
# means that it only works with Ninja and from [OpenCOR]/build.
# Then, there are some header files that are under [OpenCOR]/src,
# but for which we don't want to see issues. So, we filter them
# out using `-line-filter`, which is normally used to show issues
# present between a given set of lines (!?). So, here, we ask for
# issues between lines 9999999 and 9999999 (!!). We finish our
# list with `.h`, so that issues with other header files can get
# reported...
set_target_properties(${TARGET_NAME} PROPERTIES
CXX_CLANG_TIDY "${CLANG_TIDY};-header-filter=\\\.\\\.\\\/src\\\/.*;-line-filter=[{'name':'diff_match_patch.h','lines':[[9999999,9999999]]},{'name':'qzipreader_p.h','lines':[[9999999,9999999]]},{'name':'.h'}]"
)
endif()
endmacro()
#===============================================================================
macro(track_files)
# Keep track of the given files
# Note: indeed, some files (e.g. versiondate.txt) are 'manually' generated
# and then used to build other files. Now, the 'problem' is that
# Ninja needs to know about those files (see CMake policy CMP0058),
# which we ensure it does through the below...
foreach(FILENAME ${ARGN})
add_custom_command(OUTPUT ${FILENAME}
COMMAND ${CMAKE_COMMAND} -E sleep 0)
endforeach()
endmacro()
#===============================================================================
macro(update_language_files TARGET_NAME)
# Update the translation (.ts) files (if they exist) and generate the
# language (.qm) files, which will later on be embedded in the project
set(LANGUAGES fr)
set(INPUT_FILES)
foreach(INPUT_FILE ${ARGN})
list(APPEND INPUT_FILES ${INPUT_FILE})
endforeach()
foreach(LANGUAGE ${LANGUAGES})
set(LANGUAGE_FILE ${TARGET_NAME}_${LANGUAGE})
set(TS_FILE i18n/${LANGUAGE_FILE}.ts)
set(QM_FILE ${PROJECT_BUILD_DIR}/${LANGUAGE_FILE}.qm)
if(EXISTS ${PROJECT_SOURCE_DIR}/${TS_FILE})
execute_process(COMMAND ${QT_BINARY_DIR}/lupdate -no-obsolete ${INPUT_FILES}
-ts ${TS_FILE}
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
OUTPUT_QUIET)
execute_process(COMMAND ${QT_BINARY_DIR}/lrelease ${PROJECT_SOURCE_DIR}/${TS_FILE}
-qm ${QM_FILE}
OUTPUT_QUIET)
track_files(${QM_FILE})
endif()
endforeach()
endmacro()
#===============================================================================
macro(build_documentation DOCUMENTATION_NAME)
# Build the given documentation as an external project and have it copied to
# our final documentation directory, but only if we have a target for our
# Python and PythonPackages plugins (since we need both Python and Sphinx)
if(TARGET PythonPlugin AND TARGET PythonPackagesPlugin)
set(DOCUMENTATION_BUILD ${DOCUMENTATION_NAME}DocumentationBuild)
string(REPLACE ";" "|"
DOCUMENTATION_SPHINX_EXECUTABLE "${SPHINX_EXECUTABLE}")
ExternalProject_Add(${DOCUMENTATION_BUILD}
SOURCE_DIR
${CMAKE_SOURCE_DIR}/ext/doc/${DOCUMENTATION_NAME}
GIT_REPOSITORY
https://github.com/opencor/${DOCUMENTATION_NAME}-documentation
CMAKE_ARGS
-DPYTHON_EXECUTABLE=${PYTHON_EXECUTABLE}
-DSPHINX_EXECUTABLE=${DOCUMENTATION_SPHINX_EXECUTABLE}
-DPYTHON_PACKAGES_BIN_DIR=${PYTHON_PACKAGES_BIN_DIR}
LIST_SEPARATOR
|
INSTALL_COMMAND
${CMAKE_COMMAND} -E copy_directory ${PROJECT_BUILD_DIR}/ext/Build/${DOCUMENTATION_BUILD}/html
${PROJECT_BUILD_DIR}/doc/${DOCUMENTATION_NAME}
)
# Make our local target depend on our project build target and make our
# documentation build target depend on our local target
add_dependencies(${DOCUMENTATION_BUILD} ${PROJECT_BUILD_TARGET})
add_dependencies(${DOCUMENTATION_BUILD_TARGET} ${DOCUMENTATION_BUILD})
endif()
endmacro()
#===============================================================================
macro(strip_file PROJECT_TARGET FILENAME)
# Strip the given file of all its local symbols
# Note: to strip QScintilla and Qwt when building them on Linux results in
# an error due to patchelf having been used on them. So, we use a
# wrapper that ignores errors and returns 0, so that our build doesn't
# break...
if("${PROJECT_TARGET}" STREQUAL "DIRECT")
execute_process(COMMAND ${CMAKE_SOURCE_DIR}/scripts/strip -x ${FILENAME})
else()
add_custom_command(TARGET ${PROJECT_TARGET} POST_BUILD
COMMAND ${CMAKE_SOURCE_DIR}/scripts/strip -x ${FILENAME})
endif()
endmacro()
#===============================================================================
macro(add_plugin PLUGIN_NAME)
# Various initialisations
set(PLUGIN_NAME ${PLUGIN_NAME})
set(OPTIONS)
set(ONE_VALUE_KEYWORDS
EXTERNAL_BINARIES_DIR
EXTERNAL_DESTINATION_DIR
EXTERNAL_SOURCE_DIR
)
set(MULTI_VALUE_KEYWORDS
SOURCES
UIS
DEFINITIONS
PLUGINS
QT_MODULES
EXTERNAL_BINARIES
SYSTEM_BINARIES
DEPENDS_ON
TESTS
BYPRODUCTS
)
cmake_parse_arguments(ARG "${OPTIONS}" "${ONE_VALUE_KEYWORDS}" "${MULTI_VALUE_KEYWORDS}" ${ARGN})
# Resource files, if any
# Note: ideally, we would have our resource files named i18n.qrc.in and
# ui.qrc for all our plugins, but this is causing problems on Linux
# with Qt apparently accepting only one file called i18n.qrc.in or
# ui.qrc. The end result is that, on a development machine, plugin
# resources (e.g. icons, translations) are not available while,
# strangely enough, they are on a deployment machine...
set(RESOURCES)
set(I18N_QRC_IN_FILENAME ${PROJECT_SOURCE_DIR}/res/${PLUGIN_NAME}_i18n.qrc.in)
set(UI_QRC_FILENAME ${PROJECT_SOURCE_DIR}/res/${PLUGIN_NAME}_ui.qrc)
if(EXISTS ${I18N_QRC_IN_FILENAME})
string(REPLACE "${CMAKE_SOURCE_DIR}" "${PROJECT_BUILD_DIR}"
I18N_QRC_FILENAME "${PROJECT_SOURCE_DIR}/res/${PLUGIN_NAME}_i18n.qrc")
configure_file(${I18N_QRC_IN_FILENAME}
${I18N_QRC_FILENAME})
list(APPEND RESOURCES ${I18N_QRC_FILENAME})
# Update the translation (.ts) files and generate the language (.qm)
# files, which will later on be embedded in the plugin
update_language_files(${PLUGIN_NAME} ${ARG_SOURCES} ${ARG_UIS})
endif()
if(EXISTS ${UI_QRC_FILENAME})
list(APPEND RESOURCES ${UI_QRC_FILENAME})
endif()
# Definition to make sure that the plugin can be used by other plugins
add_definitions(-D${PLUGIN_NAME}_PLUGIN)
# Some plugin-specific definitions
foreach(ARG_DEFINITION ${ARG_DEFINITIONS})
add_definitions(-D${ARG_DEFINITION})
endforeach()
# On Linux, set the RPATH value to use by the plugin
if(NOT WIN32 AND NOT APPLE)
set(PLUGIN_LINK_RPATH_FLAG "-Wl,-rpath,'$ORIGIN' -Wl,-rpath,'$ORIGIN/../../lib'")
string(REPLACE "${LINK_RPATH_FLAG}" "${PLUGIN_LINK_RPATH_FLAG}"
LINK_FLAGS_PROPERTIES "${LINK_FLAGS_PROPERTIES}")
endif()
# Generate and add the different files needed by the plugin
add_library(${PROJECT_NAME} SHARED
${ARG_SOURCES}
${RESOURCES}
)
set_target_properties(${PROJECT_NAME} PROPERTIES
OUTPUT_NAME ${PLUGIN_NAME}
LINK_FLAGS "${LINK_FLAGS_PROPERTIES}"
)
configure_clang_and_clang_tidy(${PROJECT_NAME})
# OpenCOR plugins
foreach(ARG_PLUGIN ${ARG_PLUGINS})
target_link_libraries(${PROJECT_NAME}
${ARG_PLUGIN}Plugin
)
endforeach()
# Qt modules
foreach(ARG_QT_MODULE ${ARG_QT_MODULES})
find_package(Qt5${ARG_QT_MODULE} REQUIRED)
target_link_libraries(${PROJECT_NAME}
Qt5::${ARG_QT_MODULE}
)
endforeach()
IF((NOT "${ARG_EXTERNAL_BINARIES_DIR}" STREQUAL "")
OR ( NOT "${ARG_EXTERNAL_DESTINATION_DIR}" STREQUAL ""
AND NOT "${ARG_EXTERNAL_SOURCE_DIR}" STREQUAL ""))
# Create a custom target for installing files
# Note: this is to prevent Ninja from getting confused with circular
# references...
# Note: we use this target in Python build scripts when setting
# the PYTHON_DEPENDENCIES list
SET(INSTALL_EXTERNAL_FILES_TARGET "${PROJECT_NAME}_INSTALL_EXTERNAL_FILES")
ADD_CUSTOM_TARGET(${INSTALL_EXTERNAL_FILES_TARGET})
ADD_DEPENDENCIES(${PROJECT_NAME} ${INSTALL_EXTERNAL_FILES_TARGET})
IF(NOT "${ARG_DEPENDS_ON}" STREQUAL "")
ADD_DEPENDENCIES(${INSTALL_EXTERNAL_FILES_TARGET} ${ARG_DEPENDS_ON})
ENDIF()
ENDIF()
# External binaries
if(NOT "${ARG_EXTERNAL_BINARIES_DIR}" STREQUAL "")
foreach(ARG_EXTERNAL_BINARY ${ARG_EXTERNAL_BINARIES})
# Make sure that the external binary exists
set(FULL_EXTERNAL_BINARY "${ARG_EXTERNAL_BINARIES_DIR}/${ARG_EXTERNAL_BINARY}")
# Only do a direct copy if the file exists and the plugin doesn't
# depend on any targets
if( EXISTS ${FULL_EXTERNAL_BINARY}
AND "${ARG_DEPENDS_ON}" STREQUAL "")
set(COPY_TARGET DIRECT)
else()
set(COPY_TARGET ${INSTALL_EXTERNAL_FILES_TARGET})
endif()
# Copy the external binary to its destination directory, so we can
# test things without first having to deploy OpenCOR
# Note: on Windows, we also need to copy it to the build directory
# so that we can test things from within Qt Creator...
if(WIN32)
copy_file_to_build_dir(${COPY_TARGET} ${ARG_EXTERNAL_BINARIES_DIR} . ${ARG_EXTERNAL_BINARY})
endif()
copy_file_to_build_dir(${COPY_TARGET} ${ARG_EXTERNAL_BINARIES_DIR} ${DEST_EXTERNAL_BINARIES_DIR} ${ARG_EXTERNAL_BINARY})
# Strip the external library of all its local symbols, if possible
if(NOT WIN32 AND RELEASE_MODE)
strip_file(${COPY_TARGET} ${FULL_DEST_EXTERNAL_BINARIES_DIR}/${ARG_EXTERNAL_BINARY})
endif()
# Link the plugin to the external library
if(WIN32)
string(REGEX REPLACE "${CMAKE_SHARED_LIBRARY_SUFFIX}$" "${CMAKE_IMPORT_LIBRARY_SUFFIX}"
IMPORT_EXTERNAL_BINARY "${FULL_EXTERNAL_BINARY}")
target_link_libraries(${PROJECT_NAME}
${IMPORT_EXTERNAL_BINARY}
)
elseif(APPLE)
target_link_libraries(${PROJECT_NAME}
${FULL_DEST_EXTERNAL_BINARIES_DIR}/${ARG_EXTERNAL_BINARY}
)
else()
target_link_libraries(${PROJECT_NAME}
${FULL_EXTERNAL_BINARY}
)
endif()
# On macOS, ensure that @rpath is set in the external library's id
# and that it references the correct Qt libraries, if any at all
if(APPLE)
if("${COPY_TARGET}" STREQUAL "DIRECT")
execute_process(COMMAND install_name_tool -id @rpath/${ARG_EXTERNAL_BINARY} ${FULL_DEST_EXTERNAL_BINARIES_DIR}/${ARG_EXTERNAL_BINARY})
else()
add_custom_command(TARGET ${COPY_TARGET} POST_BUILD
COMMAND install_name_tool -id @rpath/${ARG_EXTERNAL_BINARY} ${FULL_DEST_EXTERNAL_BINARIES_DIR}/${ARG_EXTERNAL_BINARY})
endif()
macos_clean_up_file_with_qt_dependencies(${COPY_TARGET} ${FULL_DEST_EXTERNAL_BINARIES_DIR} ${ARG_EXTERNAL_BINARY})
endif()
# Package the external library, if needed
if(WIN32)
install(FILES ${FULL_EXTERNAL_BINARY}
DESTINATION bin)
elseif(NOT APPLE)
install(FILES ${FULL_EXTERNAL_BINARY}
DESTINATION lib)
endif()
endforeach()
endif()
# Check whether an external package has files to install
if( NOT "${ARG_EXTERNAL_DESTINATION_DIR}" STREQUAL ""
AND NOT "${ARG_EXTERNAL_SOURCE_DIR}" STREQUAL "")
# Copy the entire source directory to the destination
add_custom_command(TARGET ${INSTALL_EXTERNAL_FILES_TARGET}
COMMAND ${CMAKE_COMMAND} -E copy_directory ${ARG_EXTERNAL_SOURCE_DIR}
${ARG_EXTERNAL_DESTINATION_DIR}
BYPRODUCTS ${ARG_BYPRODUCTS})
endif()
# System binaries
foreach(ARG_SYSTEM_BINARY ${ARG_SYSTEM_BINARIES})
target_link_libraries(${PROJECT_NAME}
${ARG_SYSTEM_BINARY}
)
endforeach()
# Add some dependencies, if any
if(NOT "${ARG_DEPENDS_ON}" STREQUAL "")
add_dependencies(${PROJECT_NAME} ${ARG_DEPENDS_ON})
endif()
foreach(ARG_PLUGIN ${ARG_PLUGINS})
add_dependencies(${PROJECT_NAME} ${ARG_PLUGIN}Plugin)
endforeach()
# Some settings
if(XCODE)
set(PLUGIN_BUILD_DIR ${PROJECT_BUILD_DIR})
else()
string(REPLACE "${${CMAKE_PROJECT_NAME}_SOURCE_DIR}/" ""
PLUGIN_BUILD_DIR "${PROJECT_SOURCE_DIR}")
set(PLUGIN_BUILD_DIR ${PROJECT_BUILD_DIR}/${PLUGIN_BUILD_DIR})
if(NOT "${CMAKE_CFG_INTDIR}" STREQUAL ".")
set(PLUGIN_BUILD_DIR ${PLUGIN_BUILD_DIR}/${CMAKE_CFG_INTDIR})
endif()
endif()
set(PLUGIN_FILENAME ${CMAKE_SHARED_LIBRARY_PREFIX}${PLUGIN_NAME}${CMAKE_SHARED_LIBRARY_SUFFIX})
# Copy the plugin to our plugins directory
# Note: this is done so that we can, on Windows and Linux, test the use of
# plugins in OpenCOR without first having to package OpenCOR, as well
# as, on Windows, test things from within Qt Creator...
add_custom_command(TARGET ${PROJECT_NAME} POST_BUILD
COMMAND ${CMAKE_COMMAND} -E copy ${PLUGIN_BUILD_DIR}/${PLUGIN_FILENAME}
${DEST_PLUGINS_DIR}/${PLUGIN_FILENAME})
# Clean up our plugin, if we are on macOS, our make sure that it uses RPATH
# rather than RUNPATH on Linux
if(APPLE)
macos_clean_up_file_with_qt_dependencies(${PROJECT_NAME} ${DEST_PLUGINS_DIR} ${PLUGIN_FILENAME})
elseif(NOT WIN32)
runpath2rpath(${PROJECT_NAME} ${PLUGIN_BUILD_DIR}/${PLUGIN_FILENAME})
endif()
# Package the plugin, but only if we are not on macOS since it will have
# already been packaged (copied)
if(NOT APPLE)
install(FILES ${PLUGIN_BUILD_DIR}/${PLUGIN_FILENAME}
DESTINATION plugins/${CMAKE_PROJECT_NAME})
endif()
# Create some tests, if any and if required
if(ENABLE_TESTS)
foreach(ARG_TEST ${ARG_TESTS})
# Keep track of the test (for later use by our main test program)
file(APPEND ${TESTS_LIST_FILENAME} "${PLUGIN_NAME}|${ARG_TEST}|")
# Build our test, if possible
set(TEST_NAME ${PLUGIN_NAME}_${ARG_TEST})
set(TEST_SOURCE tests/${ARG_TEST}.cpp)
set(TEST_HEADER tests/${ARG_TEST}.h)
if( EXISTS ${PROJECT_SOURCE_DIR}/${TEST_SOURCE}
AND EXISTS ${PROJECT_SOURCE_DIR}/${TEST_HEADER})
# The test exists, so build it, but first set the RPATH and
# RPATH link values to use by the test, if on Linux
if(NOT WIN32 AND NOT APPLE)
string(REPLACE "${PLUGIN_LINK_RPATH_FLAG}" "-Wl,-rpath-link,${PROJECT_BUILD_DIR}/lib ${LINK_RPATH_FLAG} -Wl,-rpath,'$ORIGIN/../plugins/${CMAKE_PROJECT_NAME}'"
LINK_FLAGS_PROPERTIES "${LINK_FLAGS_PROPERTIES}")
endif()
add_executable(${TEST_NAME}
../../../tests/src/testsutils.cpp
${ARG_SOURCES}
${RESOURCES}
${TEST_SOURCE}
${TESTS_QRC_FILENAME}
)
set_target_properties(${TEST_NAME} PROPERTIES
OUTPUT_NAME ${TEST_NAME}
LINK_FLAGS "${LINK_FLAGS_PROPERTIES}"
)
configure_clang_and_clang_tidy(${TEST_NAME})
# OpenCOR plugins
foreach(ARG_PLUGIN ${ARG_PLUGINS})
target_link_libraries(${TEST_NAME}
${ARG_PLUGIN}Plugin
)
endforeach()
# Qt modules
foreach(ARG_QT_MODULE ${ARG_QT_MODULES} Test)
target_link_libraries(${TEST_NAME}
Qt5::${ARG_QT_MODULE}
)
endforeach()
# External binaries
if(NOT "${ARG_EXTERNAL_BINARIES_DIR}" STREQUAL "")
foreach(ARG_EXTERNAL_BINARY ${ARG_EXTERNAL_BINARIES})
set(FULL_EXTERNAL_BINARY "${ARG_EXTERNAL_BINARIES_DIR}/${ARG_EXTERNAL_BINARY}")
if(WIN32)
string(REGEX REPLACE "${CMAKE_SHARED_LIBRARY_SUFFIX}$" "${CMAKE_IMPORT_LIBRARY_SUFFIX}"
IMPORT_EXTERNAL_BINARY "${FULL_EXTERNAL_BINARY}")
target_link_libraries(${TEST_NAME}
${IMPORT_EXTERNAL_BINARY}
)
elseif(APPLE)
target_link_libraries(${TEST_NAME}
${FULL_DEST_EXTERNAL_BINARIES_DIR}/${ARG_EXTERNAL_BINARY}
)
else()
target_link_libraries(${TEST_NAME}
${FULL_EXTERNAL_BINARY}
)
endif()
endforeach()
endif()
# System binaries
foreach(ARG_SYSTEM_BINARY ${ARG_SYSTEM_BINARIES})
target_link_libraries(${TEST_NAME}
${ARG_SYSTEM_BINARY}
)
endforeach()
# Add some dependencies, if any
if(NOT "${ARG_DEPENDS_ON}" STREQUAL "")
add_dependencies(${TEST_NAME} ${ARG_DEPENDS_ON})
endif()
foreach(ARG_PLUGIN ${ARG_PLUGINS})
add_dependencies(${TEST_NAME} ${ARG_PLUGIN}Plugin)
endforeach()
# Copy the test to our tests directory
# Note: DEST_TESTS_DIR is defined in our main CMake file...
set(TEST_FILENAME ${TEST_NAME}${CMAKE_EXECUTABLE_SUFFIX})
if(WIN32)
add_custom_command(TARGET ${TEST_NAME} POST_BUILD
COMMAND ${CMAKE_COMMAND} -E copy ${PLUGIN_BUILD_DIR}/${TEST_FILENAME}
${PROJECT_BUILD_DIR}/${TEST_FILENAME})
endif()
add_custom_command(TARGET ${TEST_NAME} POST_BUILD
COMMAND ${CMAKE_COMMAND} -E copy ${PLUGIN_BUILD_DIR}/${TEST_FILENAME}
${DEST_TESTS_DIR}/${TEST_FILENAME})
# Clean up our plugin's tests, if we are on macOS, our make sure
# that it uses RPATH rather than RUNPATH on Linux
if(APPLE)
macos_clean_up_file_with_qt_dependencies(${TEST_NAME} ${DEST_TESTS_DIR} ${TEST_FILENAME})
elseif(NOT WIN32)
runpath2rpath(${TEST_NAME} ${DEST_TESTS_DIR}/${TEST_FILENAME})
endif()
else()
message(AUTHOR_WARNING "The '${ARG_TEST}' test for the '${PLUGIN_NAME}' plugin does not exist...")
endif()
endforeach()
endif()
endmacro()
#===============================================================================
macro(copy_file_to_build_dir PROJECT_TARGET ORIG_DIRNAME DEST_DIRNAME FILENAME)
# Copy the file (renaming it, if needed) to the destination folder
# Note: DIRECT is used to copy a file that doesn't first need to be built.
# This means that we can then use execute_process() rather than
# add_custom_command(), and thus reduce the length of the
# PROJECT_TARGET command, something that can be useful on Windows
# since the command might otherwise end up being too long for Windows
# to handle...
if("${ARGN}" STREQUAL "")
set(FULL_DEST_FILENAME ${PROJECT_BUILD_DIR}/${DEST_DIRNAME}/${FILENAME})
else()
# An argument was passed so use it to rename the file, which is to be
# copied
set(FULL_DEST_FILENAME ${PROJECT_BUILD_DIR}/${DEST_DIRNAME}/${ARGN})
endif()
if("${PROJECT_TARGET}" STREQUAL "DIRECT")
execute_process(COMMAND ${CMAKE_COMMAND} -E copy ${ORIG_DIRNAME}/${FILENAME}
${FULL_DEST_FILENAME})
else()
add_custom_command(TARGET ${PROJECT_TARGET} POST_BUILD
COMMAND ${CMAKE_COMMAND} -E copy ${ORIG_DIRNAME}/${FILENAME}
${FULL_DEST_FILENAME}
BYPRODUCTS ${FULL_DEST_FILENAME})
endif()
endmacro()
#===============================================================================
macro(windows_deploy_qt_library LIBRARY_NAME)
# Copy the Qt library to both the build and build/bin folders, so we can
# test things both from within Qt Creator and without first having to deploy
# OpenCOR
if( "${LIBRARY_NAME}" STREQUAL "Qt5WebKit"
OR "${LIBRARY_NAME}" STREQUAL "Qt5WebKitWidgets"
OR "${LIBRARY_NAME}" STREQUAL "icudt${ICU_VERSION}"
OR "${LIBRARY_NAME}" STREQUAL "icuin${ICU_VERSION}"
OR "${LIBRARY_NAME}" STREQUAL "icuuc${ICU_VERSION}")
set(REAL_QT_BINARY_DIR ${QTWEBKIT_BINARIES_DIR})
else()
set(REAL_QT_BINARY_DIR ${QT_BINARY_DIR})
endif()
set(LIBRARY_RELEASE_FILENAME ${CMAKE_SHARED_LIBRARY_PREFIX}${LIBRARY_NAME}${CMAKE_SHARED_LIBRARY_SUFFIX})
if("${LIBRARY_NAME}" STREQUAL "icudt${ICU_VERSION}")
set(LIBRARY_DEBUG_FILENAME ${CMAKE_SHARED_LIBRARY_PREFIX}icudtd${ICU_VERSION}${CMAKE_SHARED_LIBRARY_SUFFIX})
elseif("${LIBRARY_NAME}" STREQUAL "icuin${ICU_VERSION}")
set(LIBRARY_DEBUG_FILENAME ${CMAKE_SHARED_LIBRARY_PREFIX}icuind${ICU_VERSION}${CMAKE_SHARED_LIBRARY_SUFFIX})
elseif("${LIBRARY_NAME}" STREQUAL "icuuc${ICU_VERSION}")
set(LIBRARY_DEBUG_FILENAME ${CMAKE_SHARED_LIBRARY_PREFIX}icuucd${ICU_VERSION}${CMAKE_SHARED_LIBRARY_SUFFIX})
else()
set(LIBRARY_DEBUG_FILENAME ${CMAKE_SHARED_LIBRARY_PREFIX}${LIBRARY_NAME}d${CMAKE_SHARED_LIBRARY_SUFFIX})
endif()
if(NOT EXISTS ${REAL_QT_BINARY_DIR}/${LIBRARY_DEBUG_FILENAME})
# No debug version of the Qt library exists, so use its release version
# instead
set(LIBRARY_DEBUG_FILENAME ${LIBRARY_RELEASE_FILENAME})
endif()
if(RELEASE_MODE)
set(LIBRARY_FILENAME ${LIBRARY_RELEASE_FILENAME})
else()
set(LIBRARY_FILENAME ${LIBRARY_DEBUG_FILENAME})
endif()
copy_file_to_build_dir(DIRECT ${REAL_QT_BINARY_DIR} . ${LIBRARY_FILENAME})
copy_file_to_build_dir(DIRECT ${REAL_QT_BINARY_DIR} bin ${LIBRARY_FILENAME})
# Deploy the Qt library
install(FILES ${REAL_QT_BINARY_DIR}/${LIBRARY_FILENAME}
DESTINATION bin)
endmacro()
#===============================================================================
macro(windows_deploy_qt_plugin PLUGIN_CATEGORY)
foreach(PLUGIN_NAME ${ARGN})
# Copy the Qt plugin to the plugins folder
set(PLUGIN_ORIG_DIRNAME ${QT_PLUGINS_DIR}/${PLUGIN_CATEGORY})
set(PLUGIN_DEST_DIRNAME plugins/${PLUGIN_CATEGORY})
set(PLUGIN_RELEASE_FILENAME ${CMAKE_SHARED_LIBRARY_PREFIX}${PLUGIN_NAME}${CMAKE_SHARED_LIBRARY_SUFFIX})
set(PLUGIN_DEBUG_FILENAME ${CMAKE_SHARED_LIBRARY_PREFIX}${PLUGIN_NAME}d${CMAKE_SHARED_LIBRARY_SUFFIX})
if(RELEASE_MODE)
set(PLUGIN_FILENAME ${PLUGIN_RELEASE_FILENAME})
else()
set(PLUGIN_FILENAME ${PLUGIN_DEBUG_FILENAME})
endif()
copy_file_to_build_dir(DIRECT ${PLUGIN_ORIG_DIRNAME} ${PLUGIN_DEST_DIRNAME} ${PLUGIN_FILENAME})
# Deploy the Qt plugin
install(FILES ${PLUGIN_ORIG_DIRNAME}/${PLUGIN_FILENAME}
DESTINATION ${PLUGIN_DEST_DIRNAME})
endforeach()
endmacro()
#===============================================================================
macro(runpath2rpath PROJECT_TARGET FILENAME)
# Convert the RUNPATH value, if any, of the given ELF file to an RPATH value
if("${PROJECT_TARGET}" STREQUAL "DIRECT")
execute_process(COMMAND ${RUNPATH2RPATH} ${FILENAME}
RESULT_VARIABLE RESULT)
if(NOT RESULT EQUAL 0)
message(FATAL_ERROR "The RUNPATH value of '${FILENAME}' could not be converted to an RPATH value...")
endif()
else()
add_custom_command(TARGET ${PROJECT_TARGET} POST_BUILD
COMMAND ${RUNPATH2RPATH} ${FILENAME})
endif()
endmacro()
#===============================================================================
macro(linux_deploy_qt_library PROJECT_TARGET DIRNAME FILENAME)
# Copy the Qt library to the build/lib folder, so we can test things without
# first having to deploy OpenCOR
# Note: this is particularly useful when the Linux machine has different
# versions of Qt...
copy_file_to_build_dir(${PROJECT_TARGET} ${DIRNAME} lib ${FILENAME})
# Make sure that the RUNPATH value is converted to an RPATH value
runpath2rpath(${PROJECT_TARGET} ${PROJECT_BUILD_DIR}/lib/${FILENAME})
# Strip the Qt library of all its local symbols
if(RELEASE_MODE)
strip_file(${PROJECT_TARGET} ${PROJECT_BUILD_DIR}/lib/${FILENAME})
endif()
# Deploy the Qt library
install(FILES ${PROJECT_BUILD_DIR}/lib/${FILENAME}
DESTINATION lib)
endmacro()
#===============================================================================
macro(linux_deploy_qt_plugin PLUGIN_CATEGORY)
foreach(PLUGIN_NAME ${ARGN})
# Copy the Qt plugin to the plugins folder
set(PLUGIN_ORIG_DIRNAME ${QT_PLUGINS_DIR}/${PLUGIN_CATEGORY})
set(PLUGIN_DEST_DIRNAME plugins/${PLUGIN_CATEGORY})
set(PLUGIN_FILENAME ${CMAKE_SHARED_LIBRARY_PREFIX}${PLUGIN_NAME}${CMAKE_SHARED_LIBRARY_SUFFIX})
copy_file_to_build_dir(DIRECT ${PLUGIN_ORIG_DIRNAME} ${PLUGIN_DEST_DIRNAME} ${PLUGIN_FILENAME})
# Make sure that the RUNPATH value is converted to an RPATH value
runpath2rpath(DIRECT ${PROJECT_BUILD_DIR}/${PLUGIN_DEST_DIRNAME}/${PLUGIN_FILENAME})
# Strip the Qt plugin of all its local symbols
if(RELEASE_MODE)
strip_file(DIRECT ${PROJECT_BUILD_DIR}/${PLUGIN_DEST_DIRNAME}/${PLUGIN_FILENAME})
endif()
# Deploy the Qt plugin
install(FILES ${PROJECT_BUILD_DIR}/${PLUGIN_DEST_DIRNAME}/${PLUGIN_FILENAME}
DESTINATION ${PLUGIN_DEST_DIRNAME})
endforeach()
endmacro()
#===============================================================================
macro(linux_deploy_system_library FILENAME NEW_FILENAME)
# Copy the system library to the build/lib folder, so we can test things
# without first having to deploy OpenCOR
get_filename_component(REAL_FULL_FILENAME ${FILENAME} REALPATH)
get_filename_component(REAL_DIRNAME ${REAL_FULL_FILENAME} DIRECTORY)
get_filename_component(REAL_FILENAME ${REAL_FULL_FILENAME} NAME)
copy_file_to_build_dir(DIRECT ${REAL_DIRNAME} lib ${REAL_FILENAME} ${NEW_FILENAME})
# Deploy the system library
install(FILES ${REAL_FULL_FILENAME}
DESTINATION lib
RENAME ${NEW_FILENAME})
endmacro()
#===============================================================================
macro(macos_clean_up_file PROJECT_TARGET DIRNAME FILENAME)
# Strip the file of all its local symbols
set(FULL_FILENAME ${DIRNAME}/${FILENAME})
if(RELEASE_MODE)
strip_file(${PROJECT_TARGET} ${FULL_FILENAME})
endif()
# Clean up the file's id
if("${PROJECT_TARGET}" STREQUAL "DIRECT")
execute_process(COMMAND install_name_tool -id @rpath/${FILENAME} ${FULL_FILENAME})
else()
add_custom_command(TARGET ${PROJECT_TARGET} POST_BUILD
COMMAND install_name_tool -id @rpath/${FILENAME} ${FULL_FILENAME})
endif()
endmacro()
#===============================================================================
macro(macos_clean_up_file_with_qt_dependencies PROJECT_TARGET DIRNAME FILENAME)
# Clean up the file
macos_clean_up_file(${PROJECT_TARGET} ${DIRNAME} ${FILENAME})
# Make sure that the file refers to our embedded copy of the Qt libraries
foreach(MACOS_QT_LIBRARY ${MACOS_QT_LIBRARIES})
set(MACOS_QT_LIBRARY_FILENAME ${MACOS_QT_LIBRARY}.framework/Versions/${QT_VERSION_MAJOR}/${MACOS_QT_LIBRARY})
set(OLD_REFERENCE ${QT_LIBRARY_DIR}/${MACOS_QT_LIBRARY_FILENAME})
set(NEW_REFERENCE @rpath/${MACOS_QT_LIBRARY_FILENAME})
if("${PROJECT_TARGET}" STREQUAL "DIRECT")
execute_process(COMMAND install_name_tool -change ${OLD_REFERENCE} ${NEW_REFERENCE} ${FULL_FILENAME})
else()
add_custom_command(TARGET ${PROJECT_TARGET} POST_BUILD
COMMAND install_name_tool -change ${OLD_REFERENCE} ${NEW_REFERENCE} ${FULL_FILENAME})
endif()
endforeach()
endmacro()
#===============================================================================
macro(macos_deploy_qt_file ORIG_DIRNAME DEST_DIRNAME FILENAME)
# Copy the Qt file
execute_process(COMMAND ${CMAKE_COMMAND} -E copy ${ORIG_DIRNAME}/${FILENAME}
${DEST_DIRNAME}/${FILENAME})
# Clean up the Qt file
macos_clean_up_file_with_qt_dependencies(DIRECT ${DEST_DIRNAME} ${FILENAME})
endmacro()
#===============================================================================
macro(macos_deploy_qt_library LIBRARY_NAME)
# Deploy the Qt library
set(QT_FRAMEWORK_DIR ${LIBRARY_NAME}.framework/Versions/${QT_VERSION_MAJOR})
if( "${LIBRARY_NAME}" STREQUAL "${QTWEBKIT}"
OR "${LIBRARY_NAME}" STREQUAL "${QTWEBKITWIDGETS}")
set(REAL_QT_LIBRARY_DIR ${QTWEBKIT_LIBRARIES_DIR})
else()
set(REAL_QT_LIBRARY_DIR ${QT_LIBRARY_DIR})
endif()
macos_deploy_qt_file(${REAL_QT_LIBRARY_DIR}/${QT_FRAMEWORK_DIR}
${PROJECT_BUILD_DIR}/${CMAKE_PROJECT_NAME}.app/Contents/Frameworks/${QT_FRAMEWORK_DIR}
${LIBRARY_NAME})
endmacro()
#===============================================================================
macro(macos_deploy_qt_plugin PLUGIN_CATEGORY)
foreach(PLUGIN_NAME ${ARGN})
# Deploy the Qt plugin
macos_deploy_qt_file(${QT_PLUGINS_DIR}/${PLUGIN_CATEGORY}
${PROJECT_BUILD_DIR}/${CMAKE_PROJECT_NAME}.app/Contents/PlugIns/${PLUGIN_CATEGORY}
${CMAKE_SHARED_LIBRARY_PREFIX}${PLUGIN_NAME}${CMAKE_SHARED_LIBRARY_SUFFIX})
endforeach()
endmacro()
#===============================================================================
macro(create_package_file PACKAGE_NAME PACKAGE_VERSION)
# Various initialisations
set(OPTIONS)
set(ONE_VALUE_KEYWORDS
PACKAGE_REPOSITORY
RELEASE_TAG
TARGET_PLATFORM
TARGET
)
set(MULTI_VALUE_KEYWORDS
PACKAGED_FILES
SHA1_FILES
)
cmake_parse_arguments(ARG "${OPTIONS}" "${ONE_VALUE_KEYWORDS}" "${MULTI_VALUE_KEYWORDS}" ${ARGN})
# Make sure that we have at least one file for which we want to check the
# SHA-1 value
list(LENGTH ARG_SHA1_FILES ARG_SHA1_FILES_COUNT)
if(ARG_SHA1_FILES_COUNT EQUAL 0)
message(FATAL_ERROR "At least one file must have its SHA-1 value calculated in order to create the '${PACKAGE_NAME}' package...")
endif()
# The full path to the package's files
string(REPLACE "${CMAKE_SOURCE_DIR}" "${CMAKE_SOURCE_DIR}/ext"
DIRNAME "${PROJECT_SOURCE_DIR}/${EXTERNAL_PACKAGE_DIR}")
# Remove any historical package archive
if(NOT "${ARG_TARGET_PLATFORM}" STREQUAL "")
set(REAL_TARGET_PLATFORM ${ARG_TARGET_PLATFORM})
else()
set(REAL_TARGET_PLATFORM ${TARGET_PLATFORM})
endif()
set(COMPRESSED_FILENAME ${PROJECT_BUILD_DIR}/${PACKAGE_NAME}.${PACKAGE_VERSION}.${REAL_TARGET_PLATFORM}.tar.gz)
file(REMOVE ${COMPRESSED_FILENAME})
# The actual packaging code goes into a separate CMake script file that is
# run as a POST_BUILD step
set(CMAKE_CODE "cmake_minimum_required(VERSION 3.3)
# Files and directories to package
set(PACKAGED_FILES")
foreach(FILENAME IN LISTS ARG_PACKAGED_FILES)
set(CMAKE_CODE "${CMAKE_CODE}\n ${FILENAME}")
endforeach()
set(CMAKE_CODE "${CMAKE_CODE}\n)
# Files to have their SHA-1 value checked
set(SHA1_FILES")
foreach(FILENAME IN LISTS ARG_SHA1_FILES)
set(CMAKE_CODE "${CMAKE_CODE}\n ${FILENAME}")
endforeach()
set(CMAKE_CODE "${CMAKE_CODE}\n)
# Calculate the SHA-1 value of our different files, after having stripped them,
# if needed
set(SHA1_VALUES)
foreach(SHA1_FILE IN LISTS SHA1_FILES)
set(REAL_SHA1_FILENAME \"${DIRNAME}/\$\{SHA1_FILE\}\")
if(NOT EXISTS \$\{REAL_SHA1_FILENAME\})
message(FATAL_ERROR \"'\$\{REAL_SHA1_FILENAME\}' is missing from the '${PACKAGE_NAME}' package...\")
endif()
if(NOT WIN32 AND RELEASE_MODE)
execute_process(COMMAND ${CMAKE_SOURCE_DIR}/scripts/strip -x \$\{REAL_SHA1_FILENAME\})
endif()
file(SHA1 \$\{REAL_SHA1_FILENAME\} SHA1_VALUE)
list(APPEND SHA1_VALUES \$\{SHA1_VALUE\})
endforeach()
# Compress our package
execute_process(COMMAND ${CMAKE_COMMAND} -E tar -czf ${COMPRESSED_FILENAME} \$\{PACKAGED_FILES\}
WORKING_DIRECTORY ${DIRNAME}
OUTPUT_QUIET)
# Make sure that the compressed version of our package exists
if(EXISTS ${COMPRESSED_FILENAME})
# The compressed version of our package exists, so calculate its SHA-1 value
# and let people know how we should call the retrieve_package_file() macro
file(SHA1 ${COMPRESSED_FILENAME} SHA1_VALUE)
string(REPLACE \"\;\" \"\\n \"
SHA1_VALUES \"\$\{SHA1_VALUES\}\")
message(\"To retrieve the '${PACKAGE_NAME}' package, use:
retrieve_package_file(\\$\\{PACKAGE_NAME\\} \\$\\{PACKAGE_VERSION\\}
\\$\\{FULL_LOCAL_EXTERNAL_PACKAGE_DIR\\} \$\{SHA1_VALUE\}")
if(NOT "${ARG_PACKAGE_REPOSITORY}" STREQUAL "")
set(CMAKE_CODE "${CMAKE_CODE}\n PACKAGE_REPOSITORY \\$\\{PACKAGE_REPOSITORY\\}")
endif()
if(NOT "${ARG_RELEASE_TAG}" STREQUAL "")
set(CMAKE_CODE "${CMAKE_CODE}\n RELEASE_TAG \\$\\{RELEASE_TAG\\}")
endif()
if(NOT "${ARG_TARGET_PLATFORM}" STREQUAL "")
set(CMAKE_CODE "${CMAKE_CODE}\n TARGET_PLATFORM \\$\\{TARGET_PLATFORM\\}")
endif()
set(CMAKE_CODE "${CMAKE_CODE}\n SHA1_FILES \\$\\{SHA1_FILES\\}
SHA1_VALUES \$\{SHA1_VALUES\})\")
else()
message(FATAL_ERROR \"The compressed version of the '${PACKAGE_NAME}' package could not be generated...\")
endif()
")