-
Notifications
You must be signed in to change notification settings - Fork 12
/
Copy pathSubProject.cmake
293 lines (264 loc) · 11.5 KB
/
SubProject.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
# Copyright (c) 2016 John Biddiscombe
# Copyright (c) 2013-2016 Eyescale & HBP project
# https://github.com/Eyescale/CMake.git
#
# Redistributed with permission under the Boost license
#
# Distributed under the Boost Software License, Version 1.0. (See accompanying
# file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
# Include this file in a top-level CMakeLists to build several CMake
# subprojects (which may depend on each other).
#
# When included, it will automatically parse a .gitsubprojects file if one is
# present in the same CMake source directory. The .gitsubprojects file
# contains lines in the form:
# "git_subproject(<project> <giturl> <gittag>)"
# Will also parse Buildyard config files in the current directory and
# activate all configurations which have <NAME>_SUBPROJECT set.
#
# All the subprojects will be cloned and configured during the CMake configure
# step thanks to the 'git_subproject(project giturl gittag)' macro
# (also usable separately).
# The latter relies on the add_subproject(name) function to add projects as
# sub directories. See also: cmake command 'add_subdirectory'.
#
# The following targets are created by SubProject.cmake:
# - An 'update_git_subprojects_${PROJECT_NAME}' target to update the <gittag> of
# all the .gitsubprojects entries to their latest respective origin/master ref
# - A generic 'update' target to execute 'update_git_subrojects' recursively
# - A <project>-all target to build only the given sub project
#
# To be compatible with the SubProject feature, (sub)projects might need to
# adapt their CMake scripts in the following way:
# - CMAKE_BINARY_DIR should be changed to PROJECT_BINARY_DIR
# - CMAKE_SOURCE_DIR should be changed to PROJECT_SOURCE_DIR
#
# Respects the following variables:
# - DISABLE_SUBPROJECTS: when set, does not load sub projects. Useful for
# example for continuous integration builds
# - INSTALL_PACKAGES: command line cache variable which will "apt-get" or
# "port install" the known system packages. Will be unset after installation.
# - COMMON_SOURCE_DIR: When set, the source code of subprojects will be
# downloaded in this path instead of CMAKE_SOURCE_DIR.
# A sample project can be found at https://github.com/Eyescale/Collage.git
#
# How to create a dependency graph:
# cmake --graphviz=graph.dot
# tred graph.dot > graph2.dot
# neato -Goverlap=prism -Goutputorder=edgesfirst graph2.dot -Tpdf -o graph.pdf
include(${CMAKE_CURRENT_LIST_DIR}/GitExternal.cmake)
if(TARGET git_subproject_${PROJECT_NAME}_done)
return()
endif()
add_custom_target(git_subproject_${PROJECT_NAME}_done)
set_target_properties(git_subproject_${PROJECT_NAME}_done PROPERTIES
EXCLUDE_FROM_DEFAULT_BUILD ON FOLDER ${PROJECT_NAME}/zzphony)
set(COMMON_SOURCE_DIR "${CMAKE_SOURCE_DIR}" CACHE PATH
"Location of common directory of all sources")
set(__common_source_dir ${COMMON_SOURCE_DIR})
get_filename_component(__common_source_dir ${__common_source_dir} ABSOLUTE)
file(MAKE_DIRECTORY ${__common_source_dir})
function(subproject_install_packages file name)
if(NOT INSTALL_PACKAGES)
return()
endif()
if(EXISTS ${file})
include(${file})
endif()
string(TOUPPER ${name} NAME)
list(APPEND ${NAME}_DEB_DEPENDS pkg-config git subversion cmake autoconf
automake git-review doxygen ${OPTIONAL_DEBS})
set(${NAME}_BUILD_DEBS ${NAME}_DEB_DEPENDS)
list(APPEND ${NAME}_DEB_DEPENDS ninja-build lcov cppcheck git-svn clang
clang-format-3.5) # optional deb packages, not added to build spec
list(APPEND ${NAME}_PORT_DEPENDS cppcheck)
if(${NAME}_DEB_DEPENDS AND CMAKE_SYSTEM_NAME MATCHES "Linux" )
list(SORT ${NAME}_DEB_DEPENDS)
list(REMOVE_DUPLICATES ${NAME}_DEB_DEPENDS)
message("Running 'sudo apt-get install ${${NAME}_DEB_DEPENDS}'")
execute_process(COMMAND sudo apt-get install ${${NAME}_DEB_DEPENDS})
endif()
if(${NAME}_PORT_DEPENDS AND APPLE)
list(SORT ${NAME}_PORT_DEPENDS)
list(REMOVE_DUPLICATES ${NAME}_PORT_DEPENDS)
set(${NAME}_PORT_DEPENDS_UNI)
foreach(__port ${${NAME}_PORT_DEPENDS})
list(APPEND ${NAME}_PORT_DEPENDS_UNI ${__port} +universal)
endforeach()
message(
"Running 'sudo port install ${${NAME}_PORT_DEPENDS} (+universal)'")
execute_process(COMMAND sudo port install -p
${${NAME}_PORT_DEPENDS_UNI})
endif()
endfunction()
function(add_subproject name)
string(TOUPPER ${name} NAME)
if(CMAKE_MODULE_PATH)
# We're adding a sub project here: Remove parent's CMake
# directories so they don't take precendence over the sub project
# directories. Change is scoped to this function.
list(REMOVE_ITEM CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/CMake)
endif()
list(LENGTH ARGN argc)
if(argc GREATER 0)
list(GET ARGN 0 path)
else()
set(path ${name})
endif ()
if(NOT EXISTS "${__common_source_dir}/${path}/")
message(FATAL_ERROR
"Sub project ${path} not found in ${__common_source_dir}")
endif()
option(SUBPROJECT_${name} "Build ${name} " ON)
if(SUBPROJECT_${name})
# if the project needs to do anything special when configured as a
# sub project then it can check the variable ${PROJECT}_IS_SUBPROJECT
set(${name}_IS_SUBPROJECT ON)
# set ${PROJECT}_DIR to the location of the new build dir for the project
if(NOT ${name}_DIR)
set(${name}_DIR "${CMAKE_BINARY_DIR}/${name}" CACHE PATH
"Location of ${name} project" FORCE)
# update CMAKE_PREFIX_PATH with path of package in this scope and parent scope
set(CMAKE_PREFIX_PATH "${CMAKE_BINARY_DIR}/${name}" ${CMAKE_PREFIX_PATH})
set(CMAKE_PREFIX_PATH "${CMAKE_BINARY_DIR}/${name}" ${CMAKE_PREFIX_PATH} PARENT_SCOPE)
endif()
subproject_install_packages(
"${__common_source_dir}/${path}/CMake/${name}.cmake" ${name})
# add the source sub directory to our build and set the binary dir
# to the build tree
add_subdirectory("${__common_source_dir}/${path}"
"${CMAKE_BINARY_DIR}/${name}")
if(NOT ${name}_SKIP_FIND)
# find subproject "package"
find_package(${name} REQUIRED QUIET)
include_directories(${${NAME}_INCLUDE_DIRS})
endif()
set(${name}_IS_SUBPROJECT ON PARENT_SCOPE)
# Mark globally that we've already used name as a sub project
set_property(GLOBAL PROPERTY ${name}_IS_SUBPROJECT ON)
# Create <project>-all target
get_property(__targets GLOBAL PROPERTY ${name}_ALL_DEP_TARGETS)
if(__targets)
add_custom_target(${name}-all DEPENDS ${__targets})
set_target_properties(${name}-all PROPERTIES FOLDER ${name})
endif()
endif()
endfunction()
macro(git_subproject name url tag)
if(NOT BUILDYARD AND NOT DISABLE_SUBPROJECTS)
string(TOUPPER ${name} NAME)
set(TAG ${tag})
if(SUBPROJECT_TAG AND "${tag}" MATCHES "^[0-9a-f]+$")
set(TAG ${SUBPROJECT_TAG})
endif()
if(NOT ${NAME}_FOUND)
get_property(__included GLOBAL PROPERTY ${name}_IS_SUBPROJECT)
if(__included) # already used as a sub project, just find it:
find_package(${name} QUIET REQUIRED CONFIG
HINTS ${CMAKE_BINARY_DIR}/${NAME})
else()
if(NOT EXISTS ${__common_source_dir}/${name})
# Always try first using Config mode, then Module mode.
find_package(${name} QUIET CONFIG)
if(NOT ${name}_FOUND)
find_package(${name} QUIET MODULE)
endif()
endif()
if(NOT ${NAME}_FOUND OR ${NAME}_FOUND_SUBPROJECT)
# not found externally, add as sub project
git_external(${__common_source_dir}/${name} ${url} ${TAG})
add_subproject(${name})
endif()
endif()
endif()
get_property(__included GLOBAL PROPERTY ${name}_IS_SUBPROJECT)
if(__included)
list(APPEND __subprojects "${name} ${url} ${tag}")
endif()
endif()
endmacro()
# Interpret .gitsubprojects
if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/.gitsubprojects")
subproject_install_packages(
"${CMAKE_SOURCE_DIR}/CMake/${PROJECT_NAME}.cmake" ${PROJECT_NAME})
set(__subprojects) # appended on each git_subproject invocation
include(.gitsubprojects)
if(__subprojects)
set(GIT_SUBPROJECTS_SCRIPT
"${CMAKE_CURRENT_BINARY_DIR}/UpdateSubprojects.cmake")
file(WRITE "${GIT_SUBPROJECTS_SCRIPT}"
"file(WRITE .gitsubprojects \"# -*- mode: cmake -*-\n\")\n")
foreach(__subproject ${__subprojects})
string(REPLACE " " ";" __subproject_list ${__subproject})
list(GET __subproject_list 0 __subproject_name)
list(GET __subproject_list 1 __subproject_repo)
set(__subproject_dir "${__common_source_dir}/${__subproject_name}")
file(APPEND "${GIT_SUBPROJECTS_SCRIPT}"
"execute_process(COMMAND \"${GIT_EXECUTABLE}\" fetch origin -q\n"
" WORKING_DIRECTORY ${__subproject_dir})\n"
"execute_process(COMMAND \n"
" \"${GIT_EXECUTABLE}\" show-ref --hash=7 refs/remotes/origin/master\n"
" OUTPUT_VARIABLE newref OUTPUT_STRIP_TRAILING_WHITESPACE\n"
" WORKING_DIRECTORY \"${__subproject_dir}\")\n"
"if(newref)\n"
" file(APPEND .gitsubprojects\n"
" \"git_subproject(${__subproject_name} ${__subproject_repo} \${newref})\\n\")\n"
"else()\n"
" file(APPEND .gitsubprojects \"git_subproject(${__subproject})\n\")\n"
"endif()\n")
endforeach()
add_custom_target(update_git_subprojects_${PROJECT_NAME}
COMMAND ${CMAKE_COMMAND} -P ${GIT_SUBPROJECTS_SCRIPT}
COMMENT "Update ${PROJECT_NAME}/.gitsubprojects"
WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}")
set_target_properties(update_git_subprojects_${PROJECT_NAME} PROPERTIES
EXCLUDE_FROM_DEFAULT_BUILD ON FOLDER ${PROJECT_NAME}/zzphony)
if(NOT TARGET update)
add_custom_target(update)
set_target_properties(update PROPERTIES EXCLUDE_FROM_DEFAULT_BUILD ON)
endif()
add_dependencies(update update_git_subprojects_${PROJECT_NAME})
endif()
endif()
function(subproject_configure)
# interpret Buildyard project.cmake and depends.txt configurations
if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/depends.txt")
file(READ depends.txt SUBPROJECT_DEPENDS)
string(REGEX REPLACE "#[^\n]*" "" SUBPROJECT_DEPENDS
"${SUBPROJECT_DEPENDS}")
string(REGEX REPLACE "^\n" "" SUBPROJECT_DEPENDS "${SUBPROJECT_DEPENDS}")
string(REGEX REPLACE "[ \n]" ";" SUBPROJECT_DEPENDS "${SUBPROJECT_DEPENDS}")
list(LENGTH SUBPROJECT_DEPENDS SUBPROJECT_DEPENDS_LEFT)
while(SUBPROJECT_DEPENDS_LEFT GREATER 2)
list(GET SUBPROJECT_DEPENDS 0 SUBPROJECT_DEPENDS_DIR)
list(GET SUBPROJECT_DEPENDS 1 SUBPROJECT_DEPENDS_REPO)
list(GET SUBPROJECT_DEPENDS 2 SUBPROJECT_DEPENDS_TAG)
list(REMOVE_AT SUBPROJECT_DEPENDS 0 1 2)
list(LENGTH SUBPROJECT_DEPENDS SUBPROJECT_DEPENDS_LEFT)
# Skip find in git_subproject after add_subproject
set(${SUBPROJECT_DEPENDS_DIR}_SKIP_FIND ON)
git_subproject(${SUBPROJECT_DEPENDS_DIR} ${SUBPROJECT_DEPENDS_REPO}
${SUBPROJECT_DEPENDS_TAG})
endwhile()
endif()
file(GLOB _files *.cmake)
list(SORT _files)
foreach(_file ${_files})
string(REPLACE "${CMAKE_CURRENT_SOURCE_DIR}/" "" _config ${_file})
list(APPEND _localFiles ${_config})
string(REPLACE ".cmake" "" Name ${_config})
get_filename_component(NAME ${Name} NAME)
string(TOUPPER ${NAME} NAME)
set(${NAME}_DIR ${BASEDIR})
include(${_file})
if(${NAME}_SUBPROJECT)
if(NOT ${NAME}_REPO_TAG)
set(${NAME}_REPO_TAG master)
endif()
git_subproject(${Name} ${${NAME}_REPO_URL} ${${NAME}_REPO_TAG})
endif()
endforeach()
if("${CMAKE_SOURCE_DIR}" STREQUAL "${CMAKE_CURRENT_SOURCE_DIR}")
unset(INSTALL_PACKAGES CACHE) # Remove after install in SubProject.cmake
endif()
endfunction()