1 ###########################################################################
2 # Copyright 2015, 2016, 2017 IoT.bzh
4 # author: Fulup Ar Foll <fulup@iot.bzh>
5 # contrib: Romain Forlot <romain.forlot@iot.bzh>
7 # Licensed under the Apache License, Version 2.0 (the "License");
8 # you may not use this file except in compliance with the License.
9 # You may obtain a copy of the License at
11 # http://www.apache.org/licenses/LICENSE-2.0
13 # Unless required by applicable law or agreed to in writing, software
14 # distributed under the License is distributed on an "AS IS" BASIS,
15 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 # See the License for the specific language governing permissions and
17 # limitations under the License.
18 ###########################################################################
21 #--------------------------------------------------------------------------
23 # Do not change this cmake template
24 # Customise your preferences in "./etc/config.cmake"
25 #--------------------------------------------------------------------------
27 # Get colorized message output non Windows OS. You know bash ? :)
30 set(ColourReset "${Esc}[m")
31 set(ColourBold "${Esc}[1m")
33 set(Green "${Esc}[32m")
34 set(Yellow "${Esc}[33m")
35 set(Blue "${Esc}[34m")
36 set(Magenta "${Esc}[35m")
37 set(Cyan "${Esc}[36m")
38 set(White "${Esc}[37m")
39 set(BoldRed "${Esc}[1;31m")
40 set(BoldGreen "${Esc}[1;32m")
41 set(BoldYellow "${Esc}[1;33m")
42 set(BoldBlue "${Esc}[1;34m")
43 set(BoldMagenta "${Esc}[1;35m")
44 set(BoldCyan "${Esc}[1;36m")
45 set(BoldWhite "${Esc}[1;37m")
48 # Generic useful macro
49 # -----------------------
50 macro(PROJECT_TARGET_ADD TARGET_NAME)
51 set_property(GLOBAL APPEND PROPERTY PROJECT_TARGETS ${TARGET_NAME})
52 set(TARGET_NAME ${TARGET_NAME})
53 endmacro(PROJECT_TARGET_ADD)
55 # Check GCC minimal version version
56 if (gcc_minimal_version)
57 message (STATUS "${Blue}-- Check gcc_minimal_version (found gcc version ${CMAKE_C_COMPILER_VERSION}) (found g++ version ${CMAKE_CXX_COMPILER_VERSION})${ColourReset}")
58 if (CMAKE_CXX_COMPILER_VERSION VERSION_LESS ${gcc_minimal_version} OR CMAKE_C_COMPILER_VERSION VERSION_LESS ${gcc_minimal_version})
59 message(FATAL_ERROR "${Red}**** FATAL: Require at least gcc-${gcc_minimal_version} please set CMAKE_C[XX]_COMPILER")
61 endif(gcc_minimal_version)
63 macro(defstr name value)
64 add_definitions(-D${name}=${value})
68 macro(project_targets_populate)
70 # Default Widget default directory
71 set(PACKAGE_BINDIR ${PROJECT_PKG_BUILD_DIR}/bin)
72 set(PACKAGE_ETCDIR ${PROJECT_PKG_BUILD_DIR}/etc)
73 set(PACKAGE_LIBDIR ${PROJECT_PKG_BUILD_DIR}/lib)
74 set(PACKAGE_HTTPDIR ${PROJECT_PKG_BUILD_DIR}/htdocs)
75 set(PACKAGE_DATADIR ${PROJECT_PKG_BUILD_DIR}/data)
77 add_custom_target(populate)
78 get_property(PROJECT_TARGETS GLOBAL PROPERTY PROJECT_TARGETS)
79 foreach(TARGET ${PROJECT_TARGETS})
80 get_target_property(T ${TARGET} LABELS)
82 # Declaration of a custom command that will populate widget tree with the target
83 set(POPULE_PACKAGE_TARGET "project_populate_${TARGET}")
85 get_target_property(P ${TARGET} PREFIX)
86 get_target_property(BD ${TARGET} BINARY_DIR)
87 get_target_property(OUT ${TARGET} OUTPUT_NAME)
89 if(P MATCHES "NOTFOUND$")
90 if (${T} STREQUAL "BINDING")
97 if(${T} STREQUAL "BINDING")
98 add_custom_command(OUTPUT ${PACKAGE_LIBDIR}/${P}${TARGET}.so
100 COMMAND mkdir -p ${PACKAGE_LIBDIR}
101 COMMAND cp ${BD}/${P}${OUT}.so ${PACKAGE_LIBDIR}
103 add_custom_target(${POPULE_PACKAGE_TARGET} DEPENDS ${PACKAGE_LIBDIR}/${P}${TARGET}.so)
104 add_dependencies(populate ${POPULE_PACKAGE_TARGET})
105 elseif(${T} STREQUAL "EXECUTABLE")
106 add_custom_command(OUTPUT ${PACKAGE_BINDIR}/${P}${TARGET}
108 COMMAND mkdir -p ${PACKAGE_BINDIR}
109 COMMAND cp ${BD}/${P}${OUT} ${PACKAGE_BINDIR}
111 add_custom_target(${POPULE_PACKAGE_TARGET} DEPENDS ${PACKAGE_BINDIR}/${P}${TARGET})
112 add_dependencies(populate ${POPULE_PACKAGE_TARGET})
113 elseif(${T} STREQUAL "HTDOCS")
114 add_custom_command(OUTPUT ${PACKAGE_HTTPDIR}
116 COMMAND mkdir -p ${PACKAGE_HTTPDIR}
117 COMMAND cp -r ${BD}/${P}${OUT}/* ${PACKAGE_HTTPDIR}
119 add_custom_target(${POPULE_PACKAGE_TARGET} DEPENDS ${PACKAGE_HTTPDIR})
120 add_dependencies(populate ${POPULE_PACKAGE_TARGET})
121 elseif(${T} STREQUAL "DATA")
122 add_custom_command(OUTPUT ${PACKAGE_DATADIR}
124 COMMAND mkdir -p ${PACKAGE_DATADIR}
125 COMMAND cp -r ${BD}/${P}${OUT} ${PACKAGE_DATADIR}
127 add_custom_target(${POPULE_PACKAGE_TARGET} DEPENDS ${PACKAGE_DATADIR})
128 add_dependencies(populate ${POPULE_PACKAGE_TARGET})
129 endif(${T} STREQUAL "BINDING")
130 elseif(${CMAKE_BUILD_TYPE} MATCHES "[Dd][Ee][Bb][Uu][Gg]")
131 MESSAGE(".. Warning: ${TARGET} ignored when packaging.")
134 endmacro(project_targets_populate)
136 macro(remote_targets_populate)
137 if (DEFINED ENV{RSYNC_TARGET})
138 set (RSYNC_TARGET $ENV{RSYNC_TARGET})
140 if (DEFINED ENV{RSYNC_PREFIX})
141 set (RSYNC_PREFIX $ENV{RSYNC_PREFIX})
145 REMOTE_LAUNCH "Test on target with: ${CMAKE_CURRENT_BINARY_DIR}/target/start-on-${RSYNC_TARGET}.sh"
146 CACHE STRING "Command to start ${PROJECT_NAME} on remote target ${RSYNC_TARGET}"
149 if(NOT RSYNC_TARGET OR NOT RSYNC_PREFIX)
150 message (".. Warning: RSYNC_TARGET RSYNC_PREFIX not defined 'make remote-target-populate' not instanciated")
151 add_custom_target(remote-target-populate
152 COMMENT "*** Fatal: RSYNC_TARGET RSYNC_PREFIX required with 'make remote-target-populate'"
157 configure_file(${SSH_TEMPLATE_DIR}/start-on-target.in ${CMAKE_CURRENT_BINARY_DIR}/target/start-on-${RSYNC_TARGET}.sh)
158 configure_file(${GDB_TEMPLATE_DIR}/gdb-on-target.in ${CMAKE_CURRENT_BINARY_DIR}/target/gdb-on-${RSYNC_TARGET}.ini)
160 add_custom_target(remote-target-populate
162 COMMAND chmod +x ${CMAKE_CURRENT_BINARY_DIR}/target/start-on-${RSYNC_TARGET}.sh
163 COMMAND rsync --archive --delete ${PROJECT_PKG_DIR}/ ${RSYNC_TARGET}:${RSYNC_PREFIX}/${PROJECT_NAME}
164 COMMENT "${REMOTE_LAUNCH}"
167 endmacro(remote_targets_populate)
169 macro(wgt_package_build)
170 if(NOT EXISTS ${TEMPLATE_WGT_DIR}/config.xml.in OR NOT EXISTS ${TEMPLATE_WGT_DIR}/${PROJECT_ICON})
171 MESSAGE(SEND_ERROR "${Red}WARNING ! Missing mandatory files to build widget file.\nYou need config.xml.in and ${PROJECT_ICON} files in ${TEMPLATE_WGT_DIR} folder.${ColourReset}")
173 # Build widget spec file from template only once (Fulup good idea or should depend on time ????)
174 if(NOT EXISTS ${TEMPLATE_WGT_DIR}/config.xml.in OR NOT EXISTS ${TEMPLATE_WGT_DIR}/${PROJECT_ICON})
175 configure_file(${TEMPLATE_WGT_DIR}/config.xml.in ${PROJECT_PKG_BUILD_DIR}/config.xml)
176 configure_file(${TEMPLATE_WGT_DIR}/config.xml.in ${PROJECT_PKG_ENTRY_POINT}/config.xml)
177 file(COPY ${TEMPLATE_WGT_DIR}/${PROJECT_ICON} DESTINATION ${PROJECT_PKG_BUILD_DIR}/${PROJECT_ICON})
178 endif(NOT EXISTS ${TEMPLATE_WGT_DIR}/config.xml.in OR NOT EXISTS ${TEMPLATE_WGT_DIR}/${PROJECT_ICON})
180 # Fulup ??? copy any extra file in wgt/etc into populate package before building the widget
181 file(GLOB PROJECT_CONF_FILES "${TEMPLATE_WGT_DIR}/etc/*")
182 if(${PROJECT_CONF_FILES})
183 file(COPY "${TEMPLATE_WGT_DIR}/etc/*" DESTINATION ${PROJECT_PKG_BUILD_DIR}/etc/)
184 endif(${PROJECT_CONF_FILES})
186 add_custom_command(OUTPUT ${PROJECT_NAME}.wgt
187 DEPENDS ${PROJECT_TARGETS}
188 COMMAND wgtpkg-pack -f -o ${PROJECT_NAME}.wgt ${PROJECT_PKG_BUILD_DIR}
191 add_custom_target(widget DEPENDS ${PROJECT_NAME}.wgt)
192 add_dependencies(widget populate)
193 set(ADDITIONAL_MAKE_CLEAN_FILES, "${PROJECT_NAME}.wgt")
196 add_custom_command(TARGET widget
198 COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --cyan "++ ${PACKAGE_MESSAGE}")
201 endmacro(wgt_package_build)
203 macro(rpm_package_build)
204 if(NOT EXISTS ${TEMPLATE_RPM_DIR}/config.spec.in)
205 MESSAGE(STATUS "Missing mandatory files: you need config.spec.in in ${TEMPLATE_RPM_DIR} folder.")
207 # extract PROJECT_PKG_DEPS and replace ; by , for RPM spec file
208 get_property(PROJECT_PKG_DEPS GLOBAL PROPERTY PROJECT_PKG_DEPS)
209 foreach (PKFCONF ${PROJECT_PKG_DEPS})
210 set(RPM_PKG_DEPS "${RPM_PKG_DEPS}, pkgconfig(${PKFCONF})")
213 # build rpm spec file from template
214 configure_file(${TEMPLATE_RPM_DIR}/config.spec.in ${PROJECT_PKG_BUILD_DIR}/config.spec)
215 configure_file(${TEMPLATE_RPM_DIR}/config.xml.in ${PROJECT_PKG_ENTRY_POINT}/config.xml)
217 add_custom_command(OUTPUT ${PROJECT_NAME}.spec
218 DEPENDS ${PROJECT_TARGETS}
219 COMMAND rpmbuild -ba ${PROJECT_PKG_BUILD_DIR}/config.spec
222 add_custom_target(rpm DEPENDS ${PROJECT_NAME}.spec)
223 add_dependencies(rpm populate)
224 set(ADDITIONAL_MAKE_CLEAN_FILES, "${PROJECT_NAME}.spec")
227 add_custom_command(TARGET rpm
229 COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --cyan "++ ${PACKAGE_MESSAGE}")
232 endmacro(rpm_package_build)
234 macro(project_package_build)
235 if(EXISTS ${TEMPLATE_RPM_DIR})
239 if(EXISTS ${TEMPLATE_WGT_DIR})
243 if(EXISTS ${TEMPLATE_DEB_DIR})
246 endmacro(project_package_build)
248 macro(project_subdirs_add)
250 file(GLOB filelist "${ARGV0}")
252 file(GLOB filelist "*")
255 foreach(filename ${filelist})
256 if(EXISTS "${filename}/CMakeLists.txt")
257 add_subdirectory(${filename})
258 endif(EXISTS "${filename}/CMakeLists.txt")
260 endmacro(project_subdirs_add)
262 set(CMAKE_BUILD_TYPE Debug CACHE STRING "the type of build")
263 set(CMAKE_POSITION_INDEPENDENT_CODE ON)
266 # Include project configuration
267 # ------------------------------
268 project(${PROJECT_NAME} VERSION ${PROJECT_VERSION} LANGUAGES ${PROJECT_LANGUAGES})
269 set(PROJECT_LIBDIR "${CMAKE_SOURCE_DIR}/libs" CACHE PATH "Subpath to libraries")
270 set(PROJECT_RESOURCES "${CMAKE_SOURCE_DIR}/data" CACHE PATH "Subpath to data")
272 INCLUDE(FindPkgConfig)
273 INCLUDE(CheckIncludeFiles)
274 INCLUDE(CheckLibraryExists)
275 INCLUDE(GNUInstallDirs)
277 # Default compilation options
278 ############################################################################
279 link_libraries(-Wl,--as-needed -Wl,--gc-sections)
280 add_compile_options(-Wall -Wextra -Wconversion)
281 add_compile_options(-Wno-unused-parameter) # frankly not using a parameter does it care?
282 add_compile_options(-Wno-sign-compare -Wno-sign-conversion)
283 add_compile_options(-Werror=maybe-uninitialized)
284 add_compile_options(-Werror=implicit-function-declaration)
285 add_compile_options(-ffunction-sections -fdata-sections)
286 add_compile_options(-fPIC)
287 add_compile_options(-g)
289 set(CMAKE_C_FLAGS_PROFILING "-g -O2 -pg -Wp,-U_FORTIFY_SOURCE" CACHE STRING "Flags for profiling")
290 set(CMAKE_C_FLAGS_DEBUG "-g -O2 -ggdb -Wp,-U_FORTIFY_SOURCE" CACHE STRING "Flags for debugging")
291 set(CMAKE_C_FLAGS_RELEASE "-O2" CACHE STRING "Flags for releasing")
292 set(CMAKE_C_FLAGS_CCOV "-g -O2 --coverage" CACHE STRING "Flags for coverage test")
294 set(CMAKE_CXX_FLAGS_PROFILING "-g -O0 -pg -Wp,-U_FORTIFY_SOURCE")
295 set(CMAKE_CXX_FLAGS_DEBUG "-g -O0 -ggdb -Wp,-U_FORTIFY_SOURCE")
296 set(CMAKE_CXX_FLAGS_RELEASE "-g -O2")
297 set(CMAKE_CXX_FLAGS_CCOV "-g -O2 --coverage")
299 set(CMAKE_INSTALL_PREFIX "${CMAKE_SOURCE_DIR}/Install" CACHE PATH "The path where to install")
301 # (BUG!!!) as PKG_CONFIG_PATH does not work [should be en env variable]
302 set(PKG_CONFIG_USE_CMAKE_PREFIX_PATH ON CACHE BOOLEAN "Flag for using prefix path")
304 # Loop on required package and add options
305 foreach (PKG_CONFIG ${PKG_REQUIRED_LIST})
306 string(REGEX REPLACE "[<>]?=.*$" "" XPREFIX ${PKG_CONFIG})
307 PKG_CHECK_MODULES(${XPREFIX} REQUIRED ${PKG_CONFIG})
309 INCLUDE_DIRECTORIES(${${XPREFIX}_INCLUDE_DIRS})
310 list (APPEND link_libraries ${${XPREFIX}_LIBRARIES})
311 add_compile_options (${${XPREFIX}_CFLAGS})
312 endforeach(PKG_CONFIG)
314 # Optional LibEfence Malloc debug library
315 IF(CMAKE_BUILD_TYPE MATCHES DEBUG)
316 CHECK_LIBRARY_EXISTS(efence malloc "" HAVE_LIBEFENCE)
318 MESSAGE(STATUS "Linking with ElectricFence for debugging purposes...")
319 SET(libefence_LIBRARIES "-lefence")
320 list (APPEND link_libraries ${libefence_LIBRARIES})
321 ENDIF(HAVE_LIBEFENCE)
322 ENDIF(CMAKE_BUILD_TYPE MATCHES DEBUG)
324 # set default include directories
325 INCLUDE_DIRECTORIES(${EXTRA_INCLUDE_DIRS})
327 # If no install dir try to guess some smart default
328 if(BINDINGS_INSTALL_PREFIX)
329 set(BINDINGS_INSTALL_DIR ${BINDINGS_INSTALL_PREFIX}/${PROJECT_NAME} CACHE PATH "Where the binding will be installed in your system")
331 set(BINDINGS_INSTALL_DIR ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME} CACHE PATH "Where the binding will be installed in your system")
334 # Define a default package directory
336 set(PROJECT_PKG_BUILD_DIR ${PKG_PREFIX}/package CACHE PATH "Where the package will be built.")
338 set(PROJECT_PKG_BUILD_DIR ${CMAKE_CURRENT_BINARY_DIR}/package CACHE PATH "Where the package will be built")
340 set(PROJECT_PKG_ENTRY_POINT ${CMAKE_SOURCE_DIR}/packaging CACHE PATH "Where package build files, like rpm.spec file or config.xml, are write.")
342 set (PKG_TEMPLATE_PREFIX ${CMAKE_SOURCE_DIR}/etc CACHE PATH "Default Package Templates Directory")
343 set(TEMPLATE_WGT_DIR "${CMAKE_SOURCE_DIR}/${PROJECT_APP_TEMPLATES_DIR}/default/wgt" CACHE PATH "Subpath to a directory where are stored needed files to build widget")
344 set(TEMPLATE_RPM_DIR "${CMAKE_SOURCE_DIR}/${PROJECT_APP_TEMPLATES_DIR}/default/rpm" CACHE PATH "Subpath to a directory where are stored needed files to build rpm package")
345 set(TEMPLATE_DEB_DIR "${CMAKE_SOURCE_DIR}/${PROJECT_APP_TEMPLATES_DIR}/default/deb" CACHE PATH "Subpath to a directory where are stored needed files to build deb package")
348 if(NOT BINDINGS_LINK_FLAG)
349 set(BINDINGS_LINK_FLAG "-Wl,--version-script=${CMAKE_SOURCE_DIR}/${PROJECT_APP_TEMPLATES_DIR}/default/cmake/export.map")
352 # Add a dummy target to enable global dependency order
353 # -----------------------------------------------------
354 if(EXTRA_DEPENDENCIES_ORDER)
355 set(DEPENDENCIES_TARGET ${PROJECT_NAME}_extra_dependencies)
356 add_custom_target(${DEPENDENCIES_TARGET} ALL
357 DEPENDS ${EXTRA_DEPENDENCY_ORDER}
361 # Print developer helper message when build is done
362 # -------------------------------------------------------
363 macro(project_closing_msg)
364 get_property(PROJECT_TARGETS_SET GLOBAL PROPERTY PROJECT_TARGETS SET)
365 get_property(PROJECT_TARGETS GLOBAL PROPERTY PROJECT_TARGETS)
366 if(CLOSING_MESSAGE AND ${PROJECT_TARGETS_SET})
367 add_custom_target(${PROJECT_NAME}_build_done ALL
368 COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --cyan "++ ${CLOSING_MESSAGE}"
370 add_dependencies(${PROJECT_NAME}_build_done
371 ${DEPENDENCIES_TARGET} ${PROJECT_TARGETS})