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
|
# SPDX-License-Identifier: MIT
# MIT License (a.k.a. the "Expat License")
#
# Copyright (c) 2019 Peter Jonas
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
###############################################################################
# This file contains generic functions that are useful for any CMake project.
# Function names start with "fn__" so you can recognise them in other files.
#
# Unless otherwise stated, all relative file paths are assumed to be relative
# to ${CMAKE_CURRENT_BINARY_DIR}. If your file is elsewhere then you must use
# an absolute path, e.g. by prepending ${CMAKE_CURRENT_SOURCE_DIR}.
#
# Some of the functions create custom commands. Remember, a custom command
# will not run unless its OUTPUT is depended on by a custom target or another
# custom command. The same applies to the other custom command, so there must
# be a custom target involved somewhere.
#
# For example, if you write this in a CMake file then nothing will happen:
#
# fn__copy_during_build("my_source_file.txt" "my_dest_file.txt")
#
# One way to make sure the file is copied would be to follow that line with:
#
# add_custom_target("my_target_name" ALL DEPENDS "my_dest_file.txt")
# Where are we? Need to set these variables for use inside functions.
set(_FUNCTIONS_FILE "${CMAKE_CURRENT_LIST_FILE}") # path to this file
set(_FUNCTIONS_DIR "${CMAKE_CURRENT_LIST_DIR}") # path to this directory
function(fn__copy_during_build # copy a file at build time
SOURCE_FILE # relative or absolute path to file being copied
DEST_FILE # relative or absolute path to the new copy
)
# need absolute path for use with add_custom_command's DEPENDS argument
get_filename_component(
SOURCE_FILE_ABS # equals SOURCE_FILE if SOURCE_FILE is already absolute
"${SOURCE_FILE}"
ABSOLUTE
BASE_DIR "${CMAKE_CURRENT_BINARY_DIR}"
)
add_custom_command(
OUTPUT "${DEST_FILE}"
DEPENDS "${SOURCE_FILE_ABS}" # absolute path required for DEPENDS
COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${SOURCE_FILE}" "${DEST_FILE}"
COMMENT "Copying '${SOURCE_FILE}' to '${DEST_FILE}'"
VERBATIM
)
endfunction(fn__copy_during_build)
function(fn__build_zip # create zip archive at build time
PATH_OUT # final path to the archive
DIR_IN # the directory that all input file paths are relative to
FILE_IN # one file to go in the archive, with path relative to DIR_IN
# ARGN remaining arguments are more files to go in the archive
)
# need absolute path for use with add_custom_command's DEPENDS argument
get_filename_component(
DIR_IN_ABS
"${DIR_IN}"
ABSOLUTE
BASE_DIR "${CMAKE_CURRENT_BINARY_DIR}"
)
set(FILES_IN "${FILE_IN};${ARGN}")
set(FILES_IN_ABS "")
foreach(FILE IN LISTS FILES_IN)
list(APPEND FILES_IN_ABS "${DIR_IN_ABS}/${FILE}")
endforeach(FILE)
# we're about to change directory, so a relative PATH_OUT would not work
get_filename_component(
PATH_OUT_ABS
"${PATH_OUT}"
ABSOLUTE
BASE_DIR "${CMAKE_CURRENT_BINARY_DIR}"
)
add_custom_command(
OUTPUT "${PATH_OUT}" # still relative to CMAKE_CURRENT_BINARY_DIR
DEPENDS ${FILES_IN_ABS} # absolute paths required for DEPENDS
COMMAND "${CMAKE_COMMAND}" -E tar cf "${PATH_OUT_ABS}" --format=zip -- ${FILES_IN}
WORKING_DIRECTORY "${DIR_IN}" # run command in this directory
COMMENT "Compressing '${PATH_OUT}'"
VERBATIM
)
endfunction(fn__build_zip)
function(fn__build_container # create zip archive with META_INF/container.xml
PATH_OUT # final path to the container archive
DIR_IN # the directory that all input file paths are relative to
ROOTFILE # the file to be referenced in META_INF/container.xml
# ARGN remaining arguments are more files to go in the archive
)
configure_file(
"${_FUNCTIONS_DIR}/container.xml.in" # substitute @ROOTFILE@
"${DIR_IN}/META-INF/container.xml"
)
fn__build_zip(
"${PATH_OUT}"
"${DIR_IN}"
"META-INF/container.xml"
"${ROOTFILE}"
${ARGN}
)
endfunction(fn__build_container)
|
