forked from AliceO2Group/AliceO2
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathO2Utils.cmake
More file actions
693 lines (619 loc) · 28 KB
/
Copy pathO2Utils.cmake
File metadata and controls
693 lines (619 loc) · 28 KB
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
include(CMakeParseArguments)
#------------------------------------------------------------------------------
# O2_SETUP
# The modules register themselves using this macro.
# Developer note : we use a macro because we want to access the variables of the caller.
# arg NAME - Module name
macro(O2_SETUP)
cmake_parse_arguments(
PARSED_ARGS
"" # bool args
"NAME" # mono-valued arguments
"" # multi-valued arguments
${ARGN} # arguments
)
CHECK_VARIABLE(PARSED_ARGS_NAME "You must provide a name")
# set the variable to be used within parsing of this module
set(MODULE_NAME ${PARSED_ARGS_NAME})
# add a local target for the man page generation and make the
# global man target dpending on it
add_custom_target(${PARSED_ARGS_NAME}.man ALL)
add_dependencies(man ${PARSED_ARGS_NAME}.man)
endmacro()
#------------------------------------------------------------------------------
# O2_DEFINE_BUCKET
# arg NAME
# arg DEPENDENCIES # either libraries or buckets
# arg INCLUDE_DIRECTORIES # project include directories
# arg SYSTEMINCLUDE_DIRECTORIES # system include directories (no compiler warnings)
function(O2_DEFINE_BUCKET)
cmake_parse_arguments(
PARSED_ARGS
"" # bool args
"NAME" # mono-valued arguments
"DEPENDENCIES;INCLUDE_DIRECTORIES;SYSTEMINCLUDE_DIRECTORIES" # multi-valued arguments
${ARGN} # arguments
)
CHECK_VARIABLE(PARSED_ARGS_NAME "You must provide a name")
# message(STATUS "o2_define_bucket : ${PARSED_ARGS_NAME}")
# foreach (library ${PARSED_ARGS_DEPENDENCIES})
# message(STATUS " - ${library} (lib or bucket)")
# endforeach ()
# foreach (inc_dir ${PARSED_ARGS_INCLUDE_DIRECTORIES})
# message(STATUS " - ${inc_dir} (inc_dir)")
# endforeach ()
# Save this information
set("bucket_map_${PARSED_ARGS_NAME}" "${PARSED_ARGS_NAME}" PARENT_SCOPE) # emulation of a map
set("bucket_map_libs_${PARSED_ARGS_NAME}" "${PARSED_ARGS_DEPENDENCIES}" PARENT_SCOPE) # emulation of a map
set("bucket_map_inc_dirs_${PARSED_ARGS_NAME}" "${PARSED_ARGS_INCLUDE_DIRECTORIES}" PARENT_SCOPE) # emulation of a map
set("bucket_map_systeminc_dirs_${PARSED_ARGS_NAME}" "${PARSED_ARGS_SYSTEMINCLUDE_DIRECTORIES}" PARENT_SCOPE) # emulation of a map
endfunction()
macro(INDENT NUMBER_SPACES INDENTATION)
foreach (i RANGE ${NUMBER_SPACES})
set(${INDENTATION} "${${INDENTATION}} ")
endforeach ()
endmacro()
#------------------------------------------------------------------------------
# GET_BUCKET_CONTENT
# Returns the list of libraries defined in the bucket, including the ones
# part of other buckets referenced by this one.
# We allow a maximum of 10 levels of recursion.
# arg BUCKET_NAME -
# arg RESULT_LIBS_VAR_NAME - Name of the variable in the parent scope that should be populated with list of libraries.
# arg RESULT_INC_DIRS_VAR_NAME - Name of the variable in the parent scope that should be populated with list of include directories.
# arg RESULT_SYSTEMINC_DIRS_VAR_NAME - Name of the variable in the parent scope that should be populated with list of system include directories.
# arg DEPTH - Use 0 when calling the first time (can be omitted).
function(GET_BUCKET_CONTENT
BUCKET_NAME
RESULT_LIBS_VAR_NAME
RESULT_INC_DIRS_VAR_NAME
RESULT_SYSTEMINC_DIRS_VAR_NAME
)
INDENT(0 INDENTATION)
# message("${INDENTATION}Get content of bucket ${BUCKET_NAME} (from parent(s): ${RECURSIVE_BUCKETS})")
# message("${INDENTATION} RESULT_LIBS_VAR_NAME = ${RESULT_LIBS_VAR_NAME} ")
# message("${INDENTATION} RESULT_INC_DIRS_VAR_NAME = ${RESULT_INC_DIRS_VAR_NAME} ")
# message("${INDENTATION} RESULT_SYSTEMINC_DIRS_VAR_NAME = ${RESULT_SYSTEMINC_DIRS_VAR_NAME}")
if (NOT DEFINED bucket_map_${BUCKET_NAME})
message(FATAL_ERROR "${INDENTATION}bucket ${BUCKET_NAME} not defined. Use o2_define_bucket to define it in `cmake/O2Dependencies.cmake'.")
endif ()
list (FIND RECURSIVE_BUCKETS ${BUCKET_NAME} _index)
if (${_index} GREATER -1)
message(FATAL_ERROR "circular dependency detected for bucket ${BUCKET_NAME} from parent(s):${RECURSIVE_BUCKETS}")
endif ()
# Fetch the content (recursively)
set(libs ${bucket_map_libs_${BUCKET_NAME}})
set(inc_dirs ${bucket_map_inc_dirs_${BUCKET_NAME}})
set(systeminc_dirs ${bucket_map_systeminc_dirs_${BUCKET_NAME}})
set(LOCAL_VARIABLE_EXTENSION "_${BUCKET_NAME}")
set(LOCAL_RESULT_libs${LOCAL_VARIABLE_EXTENSION} "")
set(LOCAL_RESULT_inc_dirs${LOCAL_VARIABLE_EXTENSION} "")
set(LOCAL_RESULT_systeminc_dirs${LOCAL_VARIABLE_EXTENSION} "")
foreach (dependency ${libs})
# message("${INDENTATION}- ${dependency} (lib or bucket)")
# if it is a bucket we call recursively
if (DEFINED bucket_map_${dependency})
list(APPEND RECURSIVE_BUCKETS ${BUCKET_NAME})
GET_BUCKET_CONTENT(${dependency}
LOCAL_RESULT_libs${LOCAL_VARIABLE_EXTENSION}
LOCAL_RESULT_inc_dirs${LOCAL_VARIABLE_EXTENSION}
LOCAL_RESULT_systeminc_dirs${LOCAL_VARIABLE_EXTENSION}
)
list(REMOVE_ITEM RECURSIVE_BUCKETS ${BUCKET_NAME})
# message(" ${INDENTATION}dependencies ${LOCAL_RESULT_libs${LOCAL_VARIABLE_EXTENSION}}")
# message(" ${INDENTATION}include ${LOCAL_RESULT_inc_dirs${LOCAL_VARIABLE_EXTENSION}}")
# message(" ${INDENTATION}systeminclude ${LOCAL_RESULT_systeminc_dirs${LOCAL_VARIABLE_EXTENSION}}")
else ()
# else we add the dependency to the results
set(LOCAL_RESULT_libs${LOCAL_VARIABLE_EXTENSION} "${LOCAL_RESULT_libs${LOCAL_VARIABLE_EXTENSION}};${dependency}")
endif ()
endforeach ()
if (LOCAL_RESULT_inc_dirs${LOCAL_VARIABLE_EXTENSION} AND inc_dirs)
set(LOCAL_RESULT_inc_dirs${LOCAL_VARIABLE_EXTENSION} "${LOCAL_RESULT_inc_dirs${LOCAL_VARIABLE_EXTENSION}};")
endif ()
set(LOCAL_RESULT_inc_dirs${LOCAL_VARIABLE_EXTENSION} "${LOCAL_RESULT_inc_dirs${LOCAL_VARIABLE_EXTENSION}}${inc_dirs}")
if (LOCAL_RESULT_systeminc_dirs${LOCAL_VARIABLE_EXTENSION} AND systeminc_dirs)
set(LOCAL_RESULT_systeminc_dirs${LOCAL_VARIABLE_EXTENSION} "${LOCAL_RESULT_systeminc_dirs${LOCAL_VARIABLE_EXTENSION}};")
endif ()
set(LOCAL_RESULT_systeminc_dirs${LOCAL_VARIABLE_EXTENSION} "${LOCAL_RESULT_systeminc_dirs${LOCAL_VARIABLE_EXTENSION}}${systeminc_dirs}")
# foreach (inc_dir ${inc_dirs})
# message("${INDENTATION}- ${inc_dir} (inc_dir)")
# endforeach ()
# foreach (inc_dir ${systeminc_dirs})
# message("${INDENTATION}- ${inc_dir} (systeminc_dir)")
# endforeach ()
if (LOCAL_RESULT_libs${LOCAL_VARIABLE_EXTENSION})
set(${RESULT_LIBS_VAR_NAME} "${${RESULT_LIBS_VAR_NAME}};${LOCAL_RESULT_libs${LOCAL_VARIABLE_EXTENSION}}" PARENT_SCOPE)
endif ()
if (LOCAL_RESULT_inc_dirs${LOCAL_VARIABLE_EXTENSION})
set(${RESULT_INC_DIRS_VAR_NAME} "${${RESULT_INC_DIRS_VAR_NAME}};${LOCAL_RESULT_inc_dirs${LOCAL_VARIABLE_EXTENSION}}" PARENT_SCOPE)
endif ()
if (LOCAL_RESULT_systeminc_dirs${LOCAL_VARIABLE_EXTENSION})
set(${RESULT_SYSTEMINC_DIRS_VAR_NAME} "${${RESULT_SYSTEMINC_DIRS_VAR_NAME}};${LOCAL_RESULT_systeminc_dirs${LOCAL_VARIABLE_EXTENSION}}" PARENT_SCOPE)
endif ()
endfunction()
#------------------------------------------------------------------------------
# O2_TARGET_LINK_BUCKET
# arg TARGET
# arg BUCKET
# arg EXE - true indicates that it is an executable. (not used for the time being/anymore)
# arg MODULE_LIBRARY_NAME - Only used for executables. It should indicate the library of the module.
function(O2_TARGET_LINK_BUCKET)
cmake_parse_arguments(
PARSED_ARGS
"EXE" # bool args
"TARGET;BUCKET;MODULE_LIBRARY_NAME" # mono-valued arguments
"" # multi-valued arguments
${ARGN} # arguments
)
# errors if missing arguments
CHECK_VARIABLE(PARSED_ARGS_TARGET "You must provide a target name")
CHECK_VARIABLE(PARSED_ARGS_BUCKET "You must provide a bucket name")
# message(STATUS "Add dependency bucket for target ${PARSED_ARGS_TARGET} : ${PARSED_ARGS_BUCKET}")
# find the bucket
if (NOT DEFINED bucket_map_libs_${PARSED_ARGS_BUCKET})
message(FATAL_ERROR "bucket ${PARSED_ARGS_BUCKET} not defined.
Use o2_define_bucket to define it.")
endif ()
set(RESULT_libs "")
set(RESULT_inc_dirs "")
set(RESULT_systeminc_dirs "")
GET_BUCKET_CONTENT(${PARSED_ARGS_BUCKET} RESULT_libs RESULT_inc_dirs RESULT_systeminc_dirs) # RESULT_lib_dirs)
# message(STATUS "All dependencies of the bucket : ${RESULT_libs}")
# message(STATUS "All inc_dirs of the bucket ${PARSED_ARGS_BUCKET} : ${RESULT_inc_dirs}")
list(REMOVE_DUPLICATES RESULT_libs)
list(REMOVE_DUPLICATES RESULT_inc_dirs)
list(REMOVE_DUPLICATES RESULT_systeminc_dirs)
# for each dependency in the bucket invoke target_link_library
# set(DEPENDENCIES ${bucket_map_libs_${PARSED_ARGS_BUCKET}})
# message(STATUS " invoke target_link_libraries for target ${PARSED_ARGS_TARGET} : ${RESULT_libs} ${PARSED_ARGS_MODULE_LIBRARY_NAME}")
target_link_libraries(${PARSED_ARGS_TARGET} ${RESULT_libs} ${PARSED_ARGS_MODULE_LIBRARY_NAME})
# Same thing for lib_dirs and inc_dirs
target_include_directories(${PARSED_ARGS_TARGET} PUBLIC ${RESULT_inc_dirs})
target_include_directories(${PARSED_ARGS_TARGET} SYSTEM PUBLIC ${RESULT_systeminc_dirs})
endfunction()
#------------------------------------------------------------------------------
# O2_GENERATE_LIBRARY
# TODO use arguments, do NOT modify the parent's scope variables.
# This macro
# - Generate a ROOT dictionary if LINKDEF is defined and install it,
# - Create the library named LIBRARY_NAME with sources SRCS using headers HEADERS and install it,
# - Install
macro(O2_GENERATE_LIBRARY)
# cmake_parse_arguments(
# ARGS
# "" # bool args
# "LIBRARY_NAME;BUCKET_NAME;DICTIONARY;LINKDEF" # mono-valued arguments
# "SOURCES;NO_DICT_SOURCES;HEADERS;INCLUDE_DIRECTORIES" # multi-valued arguments
# ${ARGN} # arguments
# )
############### Preparation - Arguments #####################
# CHECK_VARIABLE(ARGS_LIBRARY_NAME "You must provide the name of the library" )
# CHECK_VARIABLE(ARGS_BUCKET_NAME "You must provide a bucket name" )
if("${LIBRARY_NAME}" MATCHES "O2")
set(Int_LIB ${LIBRARY_NAME})
else()
set(Int_LIB "O2${LIBRARY_NAME}")
endif()
Set(HeaderRuleName "${Int_LIB}_HEADER_RULES")
Set(DictName "G__${Int_LIB}Dict.cxx")
if (NOT DICTIONARY)
Set(DICTIONARY ${CMAKE_CURRENT_BINARY_DIR}/${DictName})
endif (NOT DICTIONARY)
if (IS_ABSOLUTE ${DICTIONARY})
Set(Int_DICTIONARY ${DICTIONARY})
else (IS_ABSOLUTE ${DICTIONARY})
Set(Int_DICTIONARY ${CMAKE_CURRENT_SOURCE_DIR}/${DICTIONARY})
endif (IS_ABSOLUTE ${DICTIONARY})
Set(Int_SRCS ${SRCS})
# If headers are defined we use them otherwise we search for the headers
if (HEADERS)
set(HDRS ${HEADERS})
else (HEADERS)
file(GLOB_RECURSE HDRS *.h)
endif (HEADERS)
# ???
if (IWYU_FOUND)
Set(_INCLUDE_DIRS ${INCLUDE_DIRECTORIES} ${SYSTEM_INCLUDE_DIRECTORIES})
CHECK_HEADERS("${Int_SRCS}" "${_INCLUDE_DIRS}" ${HeaderRuleName})
endif (IWYU_FOUND)
############### build the dictionary #####################
if (LINKDEF)
if(NOT HEADERS)
message(FATAL_ERROR "GENERATE_LIBRARY(\"${LIBRARY_NAME}\") : HEADERS variable must set if LINKDEF is provided.")
endif()
if (IS_ABSOLUTE ${LINKDEF})
Set(LINKDEF ${LINKDEF})
else (IS_ABSOLUTE ${LINKDEF})
Set(LINKDEF ${CMAKE_CURRENT_SOURCE_DIR}/${LINKDEF})
endif (IS_ABSOLUTE ${LINKDEF})
O2_ROOT_GENERATE_DICTIONARY()
SET(Int_SRCS ${Int_SRCS} ${Int_DICTIONARY})
endif (LINKDEF)
# ????
set(Int_DEPENDENCIES)
foreach (d ${DEPENDENCIES})
get_filename_component(_ext ${d} EXT)
if (NOT _ext MATCHES a$)
set(Int_DEPENDENCIES ${Int_DEPENDENCIES} ${d})
else ()
Message("Found Static library with extension ${_ext}")
get_filename_component(_lib ${d} NAME_WE)
set(Int_DEPENDENCIES ${Int_DEPENDENCIES} ${_lib})
endif ()
endforeach ()
############### build the library #####################
Add_Library(${Int_LIB} SHARED ${Int_SRCS} ${NO_DICT_SRCS} ${HDRS} ${LINKDEF})
############### Add dependencies ######################
o2_target_link_bucket(TARGET ${Int_LIB} BUCKET ${BUCKET_NAME})
target_include_directories(
${Int_LIB}
PUBLIC
${CMAKE_CURRENT_SOURCE_DIR}/include
PRIVATE
${CMAKE_CURRENT_SOURCE_DIR}/src # internal headers
${CMAKE_CURRENT_SOURCE_DIR} # For the modules that generate a dictionary
)
############### install the library ###################
install(TARGETS ${Int_LIB} DESTINATION lib)
# public header files must be in include/${MODULE_NAME}, make sure there
# are no header files directly in include
# TODO: this should probably be combined with what has been defined as
# HEADERS.
file(GLOB PUBLIC_HEADERS_IN_WRONG_PLACE ${CMAKE_CURRENT_SOURCE_DIR}/include/*.h)
if(PUBLIC_HEADERS_IN_WRONG_PLACE)
Message("found header files: ${PUBLIC_HEADERS_IN_WRONG_PLACE}")
Message(FATAL_ERROR "public header files required to be in 'include/<modulename>'")
endif()
# Install all the public headers
if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/include/${MODULE_NAME})
install(DIRECTORY include/${MODULE_NAME} DESTINATION include)
endif()
endmacro(O2_GENERATE_LIBRARY)
#------------------------------------------------------------------------------
# O2_GENERATE_EXECUTABLE
# arg EXE_NAME
# arg BUCKET_NAME
# arg SOURCES
# arg MODULE_LIBRARY_NAME - Name of the library of the module this executable belongs to. Optional.
# arg INSTALL - True to install (default), false otherwise. Optional.
function(O2_GENERATE_EXECUTABLE)
cmake_parse_arguments(
PARSED_ARGS
"NO_INSTALL" # bool args
"EXE_NAME;BUCKET_NAME;MODULE_LIBRARY_NAME" # mono-valued arguments
"SOURCES" # multi-valued arguments
${ARGN} # arguments
)
CHECK_VARIABLE(PARSED_ARGS_EXE_NAME "You must provide an executable name")
CHECK_VARIABLE(PARSED_ARGS_BUCKET_NAME "You must provide a bucket name")
CHECK_VARIABLE(PARSED_ARGS_SOURCES "You must provide the list of sources")
# note: LIBRARY_NAME is not mandatory
#######################################################
# check that the module/directory name and application name can be distinguished
# on case insensitive file systems
string(FIND ${CMAKE_CURRENT_BINARY_DIR} "/" CURRENT_BINARY_DIR_START REVERSE)
string(LENGTH ${CMAKE_CURRENT_BINARY_DIR} CURRENT_BINARY_DIR_LENGTH)
math(EXPR CURRENT_BINARY_DIR_START "${CURRENT_BINARY_DIR_START}+1")
math(EXPR CURRENT_BINARY_DIR_LENGTH "${CURRENT_BINARY_DIR_LENGTH}-${CURRENT_BINARY_DIR_START}")
string(SUBSTRING ${CMAKE_CURRENT_BINARY_DIR} ${CURRENT_BINARY_DIR_START} ${CURRENT_BINARY_DIR_LENGTH} CURRENT_BINARY_DIR_NAME)
string(TOLOWER ${CURRENT_BINARY_DIR_NAME} CURRENT_BINARY_DIR_NAME_LOWER)
string(TOLOWER ${PARSED_ARGS_EXE_NAME} EXE_NAME_LOWER)
if (CURRENT_BINARY_DIR_NAME_LOWER STREQUAL EXE_NAME_LOWER)
message(FATAL_ERROR "module name ${CURRENT_BINARY_DIR_NAME} and application name ${PARSED_ARGS_EXE_NAME} can not be distinguished on case-insensitive file systems. Please choose different names to avoid compilation errors")
endif()
set(MODULE_LIBNAME ${PARSED_ARGS_MODULE_LIBRARY_NAME})
if("${MODULE_LIBNAME}" STREQUAL "")
else()
# Add O2 tag to library name (if needed)
if("${MODULE_LIBNAME}" MATCHES "O2")
else()
set(MODULE_LIBNAME "O2${MODULE_LIBNAME}")
endif()
endif()
############### build the library #####################
ADD_EXECUTABLE(${PARSED_ARGS_EXE_NAME} ${PARSED_ARGS_SOURCES})
O2_TARGET_LINK_BUCKET(
TARGET ${PARSED_ARGS_EXE_NAME}
BUCKET ${PARSED_ARGS_BUCKET_NAME}
EXE TRUE
MODULE_LIBRARY_NAME ${MODULE_LIBNAME}
)
if (NOT ${PARSED_ARGS_NO_INSTALL})
############### install the executable #################
get_filename_component(filename ${PARSED_ARGS_EXE_NAME} NAME)
string(REGEX MATCH "^test" isTest ${filename})
if(NOT "${isTest}" STREQUAL "")
install(TARGETS ${PARSED_ARGS_EXE_NAME} DESTINATION tests)
else()
install(TARGETS ${PARSED_ARGS_EXE_NAME} DESTINATION bin)
endif()
############### install the library ###################
install(TARGETS ${MODULE_LIBNAME} DESTINATION lib)
endif ()
endfunction(O2_GENERATE_EXECUTABLE)
function(O2_FRAMEWORK_WORKFLOW)
cmake_parse_arguments(
PARSED_ARGS
"NO_INSTALL" # bool args
"WORKFLOW_NAME" # mono-valued arguments
"DETECTOR_BUCKETS;SOURCES" # multi-valued arguments
${ARGN} # arguments
)
CHECK_VARIABLE(PARSED_ARGS_WORKFLOW_NAME "You must provide an executable name")
CHECK_VARIABLE(PARSED_ARGS_DETECTOR_BUCKETS "You must provide a bucket name")
CHECK_VARIABLE(PARSED_ARGS_SOURCES "You must provide the list of sources")
############### build the executable #####################
ADD_EXECUTABLE(${PARSED_ARGS_WORKFLOW_NAME} ${PARSED_ARGS_SOURCES})
FOREACH(bucket ${PARSED_ARGS_DETECTOR_BUCKETS})
O2_TARGET_LINK_BUCKET(
TARGET ${PARSED_ARGS_WORKFLOW_NAME}
BUCKET ${bucket}
EXE TRUE
)
ENDFOREACH()
O2_TARGET_LINK_BUCKET(
TARGET ${PARSED_ARGS_WORKFLOW_NAME}
BUCKET FrameworkApplication_bucket
EXE TRUE
)
set(MODULE_LIBNAME ${PARSED_ARGS_MODULE_LIBRARY_NAME})
if("${MODULE_LIBNAME}" STREQUAL "")
else()
# Add O2 tag to library name (if needed)
if("${MODULE_LIBNAME}" MATCHES "O2")
else()
set(MODULE_LIBNAME "O2${MODULE_LIBNAME}")
endif()
endif()
if (NOT ${PARSED_ARGS_NO_INSTALL})
############### install the executable #################
install(TARGETS ${PARSED_ARGS_EXE_NAME} DESTINATION bin)
############### install the library ###################
install(TARGETS ${MODULE_LIBNAME} DESTINATION lib)
endif ()
endfunction(O2_FRAMEWORK_WORKFLOW)
#------------------------------------------------------------------------------
# add_test_wrap
# Same as add_test() but optionally retry up to MAX_ATTEMPTS times upon failure.
# This is achieved by using a shell script wrapper
# arg NAME
# arg COMMAND
# arg WORKING_DIRECTORY
# arg CONFIGURATIONS
# arg DONT_FAIL_ON_TIMEOUT - if specified, it will not fail on timeouts
# arg MAX_ATTEMPTS - the maximum number of attempts
# arg TIMEOUT - the maximum number of attempts
function(add_test_wrap)
cmake_parse_arguments(PARSE_ARGV 0 "L"
"DONT_FAIL_ON_TIMEOUT;NON_FATAL"
"NAME;WORKING_DIRECTORY;MAX_ATTEMPTS;TIMEOUT"
"COMMAND;CONFIGURATIONS")
if("${L_MAX_ATTEMPTS}" GREATER 1)
# Warn only for tests where retry has been requested
message(WARNING "Test ${L_NAME} will be retried max ${L_MAX_ATTEMPTS} times")
endif()
if(L_NON_FATAL)
message(WARNING "Failure of test ${L_NAME} will not be fatal")
endif()
if(NOT L_TIMEOUT)
set(L_TIMEOUT 100) # default timeout (seconds)
endif()
if(NOT L_MAX_ATTEMPTS)
set(L_MAX_ATTEMPTS 1) # default number of attempts
endif()
if(L_DONT_FAIL_ON_TIMEOUT)
set(L_DONT_FAIL_ON_TIMEOUT "--dont-fail-on-timeout")
else()
set(L_DONT_FAIL_ON_TIMEOUT "")
endif()
if(L_NON_FATAL)
set(L_NON_FATAL "--non-fatal")
else()
set(L_NON_FATAL "")
endif()
math(EXPR CTEST_TIMEOUT "(20 + ${L_TIMEOUT}) * ${L_MAX_ATTEMPTS}")
if(WIN32)
# Shell script does not work on Windows. Use plain add_test() with no retry, use plain timeout
add_test(NAME "${L_NAME}"
COMMAND ${L_COMMAND}
WORKING_DIRECTORY "${L_WORKING_DIRECTORY}"
CONFIGURATIONS "${L_CONFIGURATIONS}")
set_tests_properties(${L_NAME} PROPERTIES TIMEOUT ${L_TIMEOUT})
else()
add_test(NAME "${L_NAME}"
COMMAND "${CMAKE_BINARY_DIR}/tests-wrapper.sh" "--name" "${L_NAME}" "--max-attempts" "${L_MAX_ATTEMPTS}" "--timeout" "${L_TIMEOUT}" ${L_DONT_FAIL_ON_TIMEOUT} ${L_NON_FATAL} "--" ${L_COMMAND}
WORKING_DIRECTORY "${L_WORKING_DIRECTORY}"
CONFIGURATIONS "${L_CONFIGURATIONS}")
set_tests_properties(${L_NAME} PROPERTIES TIMEOUT ${CTEST_TIMEOUT})
endif()
endfunction()
#------------------------------------------------------------------------------
# O2_GENERATE_TESTS
# Generate tests for all source files listed in TEST_SRCS
# arg BUCKET_NAME
# arg TEST_SRCS
# arg MODULE_LIBRARY_NAME - Name of the library of the module this executable belongs to.
function(O2_GENERATE_TESTS)
cmake_parse_arguments(
PARSED_ARGS
"" # bool args
"BUCKET_NAME;MODULE_LIBRARY_NAME;TIMEOUT;MAX_ATTEMPTS" # mono-valued arguments
"TEST_SRCS;COMMAND_LINE_ARGS" # multi-valued arguments
${ARGN} # arguments
)
# Note: the BUCKET_NAME and MODULE_LIBRARY_NAME are optional arguments
CHECK_VARIABLE(PARSED_ARGS_TEST_SRCS "You must provide the list of sources")
foreach (test ${PARSED_ARGS_TEST_SRCS})
string(REGEX REPLACE ".*/" "" test_name ${test})
string(REGEX REPLACE "\\..*" "" test_name ${test_name})
set(test_name test_${MODULE_NAME}_${test_name})
set(MODULE_LIBNAME ${PARSED_ARGS_MODULE_LIBRARY_NAME})
if("${MODULE_LIBNAME}" STREQUAL "")
else()
# Add O2 tag to library name (if needed)
if("${MODULE_LIBNAME}" MATCHES "O2")
else()
set(MODULE_LIBNAME "O2${MODULE_LIBNAME}")
endif()
endif()
O2_GENERATE_EXECUTABLE(
EXE_NAME ${test_name}
SOURCES ${test}
MODULE_LIBRARY_NAME ${MODULE_LIBNAME}
BUCKET_NAME ${PARSED_ARGS_BUCKET_NAME}
NO_INSTALL FALSE
)
target_link_libraries(${test_name} Boost::unit_test_framework)
add_test_wrap(NAME ${test_name}
DONT_FAIL_ON_TIMEOUT
MAX_ATTEMPTS "${PARSED_ARGS_MAX_ATTEMPTS}"
TIMEOUT "${PARSED_ARGS_TIMEOUT}"
COMMAND ${test_name} ${PARSED_ARGS_COMMAND_LINE_ARGS})
endforeach ()
endfunction()
#------------------------------------------------------------------------------
# CHECK_VARIABLE
macro(CHECK_VARIABLE VARIABLE_NAME ERROR_MESSAGE)
if (NOT ${VARIABLE_NAME})
message(FATAL_ERROR "${ERROR_MESSAGE}")
endif (NOT ${VARIABLE_NAME})
endmacro(CHECK_VARIABLE)
#------------------------------------------------------------------------------
# O2_FORMAT
function(O2_FORMAT _output input prefix suffix)
# DevNotes - input should be put in quotes or the complete list does not get passed to the function
set(format)
foreach (arg ${input})
set(item ${arg})
if (prefix)
string(REGEX MATCH "^${prefix}" pre ${arg})
endif (prefix)
if (suffix)
string(REGEX MATCH "${suffix}$" suf ${arg})
endif (suffix)
if (NOT pre)
set(item "${prefix}${item}")
endif (NOT pre)
if (NOT suf)
set(item "${item}${suffix}")
endif (NOT suf)
list(APPEND format ${item})
endforeach (arg)
set(${_output} ${format} PARENT_SCOPE)
endfunction(O2_FORMAT)
#------------------------------------------------------------------------------
# O2_ROOT_GENERATE_DICTIONARY
# TODO use arguments, do NOT modify the parent's scope variables.
macro(O2_ROOT_GENERATE_DICTIONARY)
# All Arguments needed for this new version of the macro are defined
# in the parent scope, namely in the CMakeLists.txt of the submodule
set(Int_LINKDEF ${LINKDEF})
set(Int_DICTIONARY ${DICTIONARY})
# Add O2 tag to library name (if needed)
if("${LIBRARY_NAME}" MATCHES "O2")
set(Int_LIB ${LIBRARY_NAME})
else()
set(Int_LIB "O2${LIBRARY_NAME}")
endif()
set(Int_HDRS ${HDRS})
set(Int_DEF ${DEFINITIONS})
# Convert the values of the variable to a semi-colon separated list
separate_arguments(Int_HDRS)
separate_arguments(Int_DEF)
# Get the include directories (from the bucket and from the internal dependencies)
set(RESULT_libs "")
set(Int_INC "")
set(Int_SYSTEMINC "")
GET_BUCKET_CONTENT(${BUCKET_NAME} RESULT_libs Int_INC Int_SYSTEMINC)
list(REMOVE_DUPLICATES RESULT_libs)
list(REMOVE_DUPLICATES Int_INC)
list(REMOVE_DUPLICATES Int_SYSTEMINC)
set(Int_INC ${Int_INC} ${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_SOURCE_DIR}/include)
set(Int_INC ${Int_INC} ${CMAKE_CURRENT_SOURCE_DIR}/src) # internal headers
set(Int_INC ${Int_INC} ${GLOBAL_ALL_MODULES_INCLUDE_DIRECTORIES})
set(Int_INC ${Int_INC} ${Int_SYSTEMINC})
# Format neccesary arguments
# Add -I and -D to include directories and definitions
O2_FORMAT(Int_INC "${Int_INC}" "-I" "")
O2_FORMAT(Int_DEF "${Int_DEF}" "-D" "")
#---call rootcint / cling --------------------------------
set(OUTPUT_FILES ${Int_DICTIONARY})
set(EXTRA_DICT_PARAMETERS "")
set(Int_ROOTMAPFILE ${LIBRARY_OUTPUT_PATH}/lib${Int_LIB}.rootmap)
set(Int_PCMFILE G__${Int_LIB}Dict_rdict.pcm)
set(OUTPUT_FILES ${OUTPUT_FILES} ${Int_PCMFILE} ${Int_ROOTMAPFILE})
set(EXTRA_DICT_PARAMETERS ${EXTRA_DICT_PARAMETERS}
-inlineInputHeader -rmf ${Int_ROOTMAPFILE}
-rml lib${Int_LIB}${CMAKE_SHARED_LIBRARY_SUFFIX})
set_source_files_properties(${OUTPUT_FILES} PROPERTIES GENERATED TRUE)
if (CMAKE_SYSTEM_NAME MATCHES Linux)
# Note : ROOT_CINT_EXECUTABLE is ok with ROOT6 (rootcint == rootcling)
add_custom_command(OUTPUT ${OUTPUT_FILES}
COMMAND LD_LIBRARY_PATH=${ROOT_LIBRARY_DIR}:${_intel_lib_dirs}:$ENV{LD_LIBRARY_PATH} ROOTSYS=${ROOTSYS}
${ROOT_CINT_EXECUTABLE} -f ${Int_DICTIONARY} ${EXTRA_DICT_PARAMETERS} -c ${Int_DEF} ${Int_INC} ${Int_HDRS} ${Int_LINKDEF}
COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_CURRENT_BINARY_DIR}/${Int_PCMFILE} ${LIBRARY_OUTPUT_PATH}/${Int_PCMFILE}
DEPENDS ${Int_HDRS} ${Int_LINKDEF}
)
else (CMAKE_SYSTEM_NAME MATCHES Linux)
if (CMAKE_SYSTEM_NAME MATCHES Darwin)
add_custom_command(OUTPUT ${OUTPUT_FILES}
COMMAND DYLD_LIBRARY_PATH=${ROOT_LIBRARY_DIR}:$ENV{DYLD_LIBRARY_PATH} ROOTSYS=${ROOTSYS} ${ROOT_CINT_EXECUTABLE}
-f ${Int_DICTIONARY} ${EXTRA_DICT_PARAMETERS} -c ${Int_DEF} ${Int_INC} ${Int_HDRS} ${Int_LINKDEF}
COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_CURRENT_BINARY_DIR}/${Int_PCMFILE} ${LIBRARY_OUTPUT_PATH}/${Int_PCMFILE}
DEPENDS ${Int_HDRS} ${Int_LINKDEF}
)
endif (CMAKE_SYSTEM_NAME MATCHES Darwin)
endif (CMAKE_SYSTEM_NAME MATCHES Linux)
install(FILES ${LIBRARY_OUTPUT_PATH}/${Int_PCMFILE} ${Int_ROOTMAPFILE} DESTINATION lib)
if (CMAKE_COMPILER_IS_GNUCXX)
exec_program(${CMAKE_C_COMPILER} ARGS "-dumpversion" OUTPUT_VARIABLE _gcc_version_info)
string(REGEX REPLACE "^([0-9]+).*$" "\\1" GCC_MAJOR ${_gcc_version_info})
if (${GCC_MAJOR} GREATER 4)
set_source_files_properties(${Int_DICTIONARY} PROPERTIES COMPILE_DEFINITIONS R__ACCESS_IN_SYMBOL)
endif ()
endif ()
endmacro(O2_ROOT_GENERATE_DICTIONARY)
# Generate a man page
# Make sure we have nroff. If that is not the case
# we will not generate man pages
find_program(
NROFF_FOUND
nroff)
function(O2_GENERATE_MAN)
cmake_parse_arguments(
PARSED_ARGS
"" # bool args
"NAME;SECTION;MODULE" # mono-valued arguments
"" # multi-valued arguments
${ARGN} # arguments
)
if(NOT PARSED_ARGS_SECTION)
set(PARSED_ARGS_SECTION 1)
endif()
CHECK_VARIABLE(PARSED_ARGS_NAME "You must provide the name of the input man file in doc/<name>.<section>.in")
if(NROFF_FOUND)
ADD_CUSTOM_COMMAND(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${PARSED_ARGS_NAME}.${PARSED_ARGS_SECTION}
MAIN_DEPENDENCY ${CMAKE_CURRENT_SOURCE_DIR}/doc/${PARSED_ARGS_NAME}.${PARSED_ARGS_SECTION}.in
COMMAND nroff -Tascii -man ${CMAKE_CURRENT_SOURCE_DIR}/doc/${PARSED_ARGS_NAME}.${PARSED_ARGS_SECTION}.in > ${CMAKE_CURRENT_BINARY_DIR}/${PARSED_ARGS_NAME}.${PARSED_ARGS_SECTION}
VERBATIM
)
# the prefix man. for the target name avoids circular dependencies for the
# man pages added at top level. Simply droping the dependency for those
# does not invoke the custom command on all systems.
set(CUSTOM_TARGET_NAME man.${PARSED_ARGS_NAME}.${PARSED_ARGS_SECTION})
ADD_CUSTOM_TARGET(${CUSTOM_TARGET_NAME} DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${PARSED_ARGS_NAME}.${PARSED_ARGS_SECTION})
if (PARSED_ARGS_MODULE)
# add to the man target of specified module
add_dependencies(${PARSED_ARGS_MODULE}.man ${CUSTOM_TARGET_NAME})
elseif(MODULE_NAME)
# add to the man target of current module
add_dependencies(${MODULE_NAME}.man ${CUSTOM_TARGET_NAME})
else()
# add to top level target otherwise
add_dependencies(man ${CUSTOM_TARGET_NAME})
endif()
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/${PARSED_ARGS_NAME}.${PARSED_ARGS_SECTION} DESTINATION share/man/man${PARSED_ARGS_SECTION})
endif(NROFF_FOUND)
endfunction(O2_GENERATE_MAN)