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 macro(PROJECT_PKGDEP_ADD PKG_NAME)
56 set_property(GLOBAL APPEND PROPERTY PROJECT_PKG_DEPS ${PKG_NAME})
57 endmacro(PROJECT_PKGDEP_ADD)
59 # Check GCC minimal version
60 if (gcc_minimal_version)
61 message (STATUS "${Blue}-- Check gcc_minimal_version (found gcc version ${CMAKE_C_COMPILER_VERSION}) (found g++ version ${CMAKE_CXX_COMPILER_VERSION})${ColourReset}")
62 if (CMAKE_CXX_COMPILER_VERSION VERSION_LESS ${gcc_minimal_version} OR CMAKE_C_COMPILER_VERSION VERSION_LESS ${gcc_minimal_version})
63 message(FATAL_ERROR "${Red}**** FATAL: Require at least gcc-${gcc_minimal_version} please set CMAKE_C[XX]_COMPILER")
65 endif(gcc_minimal_version)
67 # Check Kernel minimal version
68 if (kernel_minimal_version)
69 message (STATUS "${Blue}-- Check kernel_minimal_version (found kernel version ${CMAKE_SYSTEM_VERSION})${ColourReset}")
70 if (CMAKE_SYSTEM_VERSION VERSION_LESS ${kernel_minimal_version})
71 message(FATAL_ERROR "${Red}**** FATAL: Require at least ${kernel_minimal_version} please use a recent kernel.")
73 endif(kernel_minimal_version)
75 macro(defstr name value)
76 add_definitions(-D${name}=${value})
80 macro(project_targets_populate)
82 # Default Widget default directory
83 set(PACKAGE_BINDIR ${PROJECT_PKG_BUILD_DIR}/bin)
84 set(PACKAGE_ETCDIR ${PROJECT_PKG_BUILD_DIR}/etc)
85 set(PACKAGE_LIBDIR ${PROJECT_PKG_BUILD_DIR}/lib)
86 set(PACKAGE_HTTPDIR ${PROJECT_PKG_BUILD_DIR}/htdocs)
87 set(PACKAGE_DATADIR ${PROJECT_PKG_BUILD_DIR}/data)
89 add_custom_target(populate)
90 get_property(PROJECT_TARGETS GLOBAL PROPERTY PROJECT_TARGETS)
91 foreach(TARGET ${PROJECT_TARGETS})
92 get_target_property(T ${TARGET} LABELS)
94 # Declaration of a custom command that will populate widget tree with the target
95 set(POPULE_PACKAGE_TARGET "project_populate_${TARGET}")
97 get_target_property(P ${TARGET} PREFIX)
98 get_target_property(BD ${TARGET} BINARY_DIR)
99 get_target_property(OUT ${TARGET} OUTPUT_NAME)
101 if(P MATCHES "NOTFOUND$")
102 if (${T} STREQUAL "BINDING")
109 if(${T} STREQUAL "BINDING")
110 add_custom_command(OUTPUT ${PACKAGE_LIBDIR}/${P}${TARGET}.so
112 COMMAND mkdir -p ${PACKAGE_LIBDIR}
113 COMMAND cp ${BD}/${P}${OUT}.so ${PACKAGE_LIBDIR}
115 add_custom_target(${POPULE_PACKAGE_TARGET} DEPENDS ${PACKAGE_LIBDIR}/${P}${TARGET}.so)
116 add_dependencies(populate ${POPULE_PACKAGE_TARGET})
117 elseif(${T} STREQUAL "EXECUTABLE")
118 add_custom_command(OUTPUT ${PACKAGE_BINDIR}/${P}${TARGET}
120 COMMAND mkdir -p ${PACKAGE_BINDIR}
121 COMMAND cp ${BD}/${P}${OUT} ${PACKAGE_BINDIR}
123 add_custom_target(${POPULE_PACKAGE_TARGET} DEPENDS ${PACKAGE_BINDIR}/${P}${TARGET})
124 add_dependencies(populate ${POPULE_PACKAGE_TARGET})
125 elseif(${T} STREQUAL "HTDOCS")
126 add_custom_command(OUTPUT ${PACKAGE_HTTPDIR}
128 COMMAND mkdir -p ${PACKAGE_HTTPDIR}
129 COMMAND cp -r ${BD}/${P}${OUT}/* ${PACKAGE_HTTPDIR}
131 add_custom_target(${POPULE_PACKAGE_TARGET} DEPENDS ${PACKAGE_HTTPDIR})
132 add_dependencies(populate ${POPULE_PACKAGE_TARGET})
133 elseif(${T} STREQUAL "DATA")
134 add_custom_command(OUTPUT ${PACKAGE_DATADIR}
136 COMMAND mkdir -p ${PACKAGE_DATADIR}
137 COMMAND cp -r ${BD}/${P}${OUT} ${PACKAGE_DATADIR}
139 add_custom_target(${POPULE_PACKAGE_TARGET} DEPENDS ${PACKAGE_DATADIR})
140 add_dependencies(populate ${POPULE_PACKAGE_TARGET})
141 endif(${T} STREQUAL "BINDING")
142 elseif(${CMAKE_BUILD_TYPE} MATCHES "[Dd][Ee][Bb][Uu][Gg]")
143 MESSAGE(".. Warning: ${TARGET} ignored when packaging.")
146 endmacro(project_targets_populate)
148 macro(remote_targets_populate)
149 if (DEFINED ENV{RSYNC_TARGET})
150 set (RSYNC_TARGET $ENV{RSYNC_TARGET})
152 if (DEFINED ENV{RSYNC_PREFIX})
153 set (RSYNC_PREFIX $ENV{RSYNC_PREFIX})
157 REMOTE_LAUNCH "Test on target with: ${CMAKE_CURRENT_BINARY_DIR}/target/start-on-${RSYNC_TARGET}.sh"
158 CACHE STRING "Command to start ${PROJECT_NAME} on remote target ${RSYNC_TARGET}"
161 if(NOT RSYNC_TARGET OR NOT RSYNC_PREFIX)
162 message ("${Yellow}.. Warning: RSYNC_TARGET RSYNC_PREFIX not defined 'make remote-target-populate' not instanciated${ColourReset}")
163 add_custom_target(remote-target-populate
164 COMMENT "${Red}*** Fatal: RSYNC_TARGET RSYNC_PREFIX environment variables required with 'make remote-target-populate'${ColourReset}"
169 configure_file(${SSH_TEMPLATE_DIR}/start-on-target.in ${CMAKE_CURRENT_BINARY_DIR}/target/start-on-${RSYNC_TARGET}.sh)
170 configure_file(${GDB_TEMPLATE_DIR}/gdb-on-target.in ${CMAKE_CURRENT_BINARY_DIR}/target/gdb-on-${RSYNC_TARGET}.ini)
172 add_custom_target(remote-target-populate
174 COMMAND chmod +x ${CMAKE_CURRENT_BINARY_DIR}/target/start-on-${RSYNC_TARGET}.sh
175 COMMAND rsync --archive --delete ${PROJECT_PKG_BUILD_DIR}/ ${RSYNC_TARGET}:${RSYNC_PREFIX}/${PROJECT_NAME}
176 COMMENT "${REMOTE_LAUNCH}"
179 endmacro(remote_targets_populate)
181 macro(wgt_package_build)
182 if(NOT EXISTS ${TEMPLATE_WGT_DIR}/config.xml.in OR NOT EXISTS ${TEMPLATE_WGT_DIR}/icon-default.png)
183 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}")
185 # Build widget spec file from template only once (Fulup good idea or should depend on time ????)
186 if(NOT EXISTS ${TEMPLATE_WGT_DIR}/config.xml.in OR NOT EXISTS ${TEMPLATE_WGT_DIR}/${PROJECT_ICON})
187 configure_file(${TEMPLATE_WGT_DIR}/config.xml.in ${PROJECT_PKG_BUILD_DIR}/config.xml)
188 configure_file(${TEMPLATE_WGT_DIR}/config.xml.in ${PROJECT_PKG_ENTRY_POINT}/config.xml)
189 file(COPY ${TEMPLATE_WGT_DIR}/icon-default.png DESTINATION ${PROJECT_PKG_BUILD_DIR}/${PROJECT_ICON})
190 endif(NOT EXISTS ${TEMPLATE_WGT_DIR}/config.xml.in OR NOT EXISTS ${TEMPLATE_WGT_DIR}/${PROJECT_ICON})
192 # Fulup ??? copy any extra file in wgt/etc into populate package before building the widget
193 file(GLOB PROJECT_CONF_FILES "${TEMPLATE_WGT_DIR}/etc/*")
194 if(${PROJECT_CONF_FILES})
195 file(COPY "${TEMPLATE_WGT_DIR}/etc/*" DESTINATION ${PROJECT_PKG_BUILD_DIR}/etc/)
196 endif(${PROJECT_CONF_FILES})
198 add_custom_command(OUTPUT ${PROJECT_NAME}.wgt
199 DEPENDS ${PROJECT_TARGETS}
200 COMMAND wgtpkg-pack -f -o ${PROJECT_NAME}.wgt ${PROJECT_PKG_BUILD_DIR}
203 add_custom_target(widget DEPENDS ${PROJECT_NAME}.wgt)
204 add_dependencies(widget populate)
205 set(ADDITIONAL_MAKE_CLEAN_FILES, "${PROJECT_NAME}.wgt")
208 add_custom_command(TARGET widget
210 COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --cyan "++ ${PACKAGE_MESSAGE}")
213 endmacro(wgt_package_build)
215 macro(rpm_package_build)
216 if(NOT EXISTS ${TEMPLATE_RPM_DIR}/config.spec.in)
217 MESSAGE(STATUS "Missing mandatory files: you need config.spec.in in ${TEMPLATE_RPM_DIR} folder.")
219 # extract PROJECT_PKG_DEPS and replace ; by , for RPM spec file
220 get_property(PROJECT_PKG_DEPS GLOBAL PROPERTY PROJECT_PKG_DEPS)
221 foreach (PKFCONF ${PROJECT_PKG_DEPS})
222 set(RPM_PKG_DEPS "${RPM_PKG_DEPS}, pkgconfig(${PKFCONF})")
225 # build rpm spec file from template
226 configure_file(${TEMPLATE_RPM_DIR}/config.spec.in ${PROJECT_PKG_BUILD_DIR}/config.spec)
228 add_custom_command(OUTPUT ${PROJECT_NAME}.spec
229 DEPENDS ${PROJECT_TARGETS}
230 COMMAND rpmbuild -ba ${PROJECT_PKG_BUILD_DIR}/config.spec
233 add_custom_target(rpm DEPENDS ${PROJECT_NAME}.spec)
234 add_dependencies(rpm populate)
235 set(ADDITIONAL_MAKE_CLEAN_FILES, "${PROJECT_NAME}.spec")
238 add_custom_command(TARGET rpm
240 COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --cyan "++ ${PACKAGE_MESSAGE}")
243 endmacro(rpm_package_build)
245 macro(project_package_build)
246 if(EXISTS ${RPM_TEMPLATE_DIR})
250 if(EXISTS ${WGT_TEMPLATE_DIR})
254 if(EXISTS ${DEB_TEMPLATE_DIR})
257 endmacro(project_package_build)
259 macro(project_subdirs_add)
260 set (ARGSLIST ${ARGN})
261 list(LENGTH ARGSLIST ARGSNUM)
262 if(${ARGSNUM} GREATER 0)
263 file(GLOB filelist "${ARGV0}")
265 file(GLOB filelist "*")
268 foreach(filename ${filelist})
269 if(EXISTS "${filename}/CMakeLists.txt")
270 add_subdirectory(${filename})
271 endif(EXISTS "${filename}/CMakeLists.txt")
273 endmacro(project_subdirs_add)
275 set(CMAKE_BUILD_TYPE Debug CACHE STRING "the type of build")
276 set(CMAKE_POSITION_INDEPENDENT_CODE ON)
279 # Include project configuration
280 # ------------------------------
281 project(${PROJECT_NAME} VERSION ${PROJECT_VERSION} LANGUAGES ${PROJECT_LANGUAGES})
282 set(PROJECT_LIBDIR "${CMAKE_SOURCE_DIR}/libs" CACHE PATH "Subpath to libraries")
283 set(PROJECT_RESOURCES "${CMAKE_SOURCE_DIR}/data" CACHE PATH "Subpath to data")
285 set(AFB_TOKEN "" CACHE PATH "Default AFB_TOKEN")
286 set(AFB_REMPORT "1234" CACHE PATH "Default AFB_TOKEN")
288 INCLUDE(FindPkgConfig)
289 INCLUDE(CheckIncludeFiles)
290 INCLUDE(CheckLibraryExists)
291 INCLUDE(GNUInstallDirs)
293 # Default compilation options
294 ############################################################################
295 link_libraries(-Wl,--as-needed -Wl,--gc-sections)
296 add_compile_options(-Wall -Wextra -Wconversion)
297 add_compile_options(-Wno-unused-parameter) # frankly not using a parameter does it care?
298 add_compile_options(-Wno-sign-compare -Wno-sign-conversion)
299 add_compile_options(-Werror=maybe-uninitialized)
300 add_compile_options(-Werror=implicit-function-declaration)
301 add_compile_options(-ffunction-sections -fdata-sections)
302 add_compile_options(-fPIC)
303 add_compile_options(-g)
305 set(CMAKE_C_FLAGS_PROFILING "-g -O2 -pg -Wp,-U_FORTIFY_SOURCE" CACHE STRING "Flags for profiling")
306 set(CMAKE_C_FLAGS_DEBUG "-g -O2 -ggdb -Wp,-U_FORTIFY_SOURCE" CACHE STRING "Flags for debugging")
307 set(CMAKE_C_FLAGS_RELEASE "-O2" CACHE STRING "Flags for releasing")
308 set(CMAKE_C_FLAGS_CCOV "-g -O2 --coverage" CACHE STRING "Flags for coverage test")
310 set(CMAKE_CXX_FLAGS_PROFILING "-g -O0 -pg -Wp,-U_FORTIFY_SOURCE")
311 set(CMAKE_CXX_FLAGS_DEBUG "-g -O0 -ggdb -Wp,-U_FORTIFY_SOURCE")
312 set(CMAKE_CXX_FLAGS_RELEASE "-g -O2")
313 set(CMAKE_CXX_FLAGS_CCOV "-g -O2 --coverage")
315 set(CMAKE_INSTALL_PREFIX "${CMAKE_SOURCE_DIR}/Install" CACHE PATH "The path where to install")
317 # (BUG!!!) as PKG_CONFIG_PATH does not work [should be en env variable]
318 set(PKG_CONFIG_USE_CMAKE_PREFIX_PATH ON CACHE BOOLEAN "Flag for using prefix path")
320 # Loop on required package and add options
321 foreach (PKG_CONFIG ${PKG_REQUIRED_LIST})
322 string(REGEX REPLACE "[<>]?=.*$" "" XPREFIX ${PKG_CONFIG})
323 PKG_CHECK_MODULES(${XPREFIX} REQUIRED ${PKG_CONFIG})
325 INCLUDE_DIRECTORIES(${${XPREFIX}_INCLUDE_DIRS})
326 list (APPEND link_libraries ${${XPREFIX}_LIBRARIES})
327 add_compile_options (${${XPREFIX}_CFLAGS})
328 endforeach(PKG_CONFIG)
330 # Optional LibEfence Malloc debug library
331 IF(CMAKE_BUILD_TYPE MATCHES DEBUG)
332 CHECK_LIBRARY_EXISTS(efence malloc "" HAVE_LIBEFENCE)
334 MESSAGE(STATUS "Linking with ElectricFence for debugging purposes...")
335 SET(libefence_LIBRARIES "-lefence")
336 list (APPEND link_libraries ${libefence_LIBRARIES})
337 ENDIF(HAVE_LIBEFENCE)
338 ENDIF(CMAKE_BUILD_TYPE MATCHES DEBUG)
340 # set default include directories
341 INCLUDE_DIRECTORIES(${EXTRA_INCLUDE_DIRS})
343 # If no install dir try to guess some smart default
344 if(BINDINGS_INSTALL_PREFIX)
345 set(BINDINGS_INSTALL_DIR ${BINDINGS_INSTALL_PREFIX}/${PROJECT_NAME} CACHE PATH "Where the binding will be installed in your system")
347 set(BINDINGS_INSTALL_DIR ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME} CACHE PATH "Where the binding will be installed in your system")
350 # Define a default package directory
352 set(PROJECT_PKG_BUILD_DIR ${PKG_PREFIX}/package CACHE PATH "Where the package will be built.")
354 set(PROJECT_PKG_BUILD_DIR ${CMAKE_CURRENT_BINARY_DIR}/package CACHE PATH "Where the package will be built")
357 set (PKG_TEMPLATE_PREFIX ${CMAKE_SOURCE_DIR}/${PROJECT_APP_TEMPLATES_DIR} CACHE PATH "Default Package Templates Directory")
358 set(SSH_TEMPLATE_DIR "${PKG_TEMPLATE_PREFIX}/ssh" CACHE PATH "Subpath to a directory where are stored needed files to launch on remote target to debuging purposes")
359 set(GDB_TEMPLATE_DIR "${PKG_TEMPLATE_PREFIX}/gdb" CACHE PATH "Subpath to a directory where are stored needed files to launch debuging server on a remote target. Use gdbserver.")
360 set(WGT_TEMPLATE_DIR "${PKG_TEMPLATE_PREFIX}/wgt" CACHE PATH "Subpath to a directory where are stored needed files to build widget")
361 set(RPM_TEMPLATE_DIR "${PKG_TEMPLATE_PREFIX}/rpm" CACHE PATH "Subpath to a directory where are stored needed files to build rpm package")
362 set(DEB_TEMPLATE_DIR "${PKG_TEMPLATE_PREFIX}/deb" CACHE PATH "Subpath to a directory where are stored needed files to build deb package")
364 string(REGEX REPLACE "^(.*)/.*$" "\\1" ENTRY_POINT "${PKG_TEMPLATE_PREFIX}")
365 set(PROJECT_PKG_ENTRY_POINT ${ENTRY_POINT}/packaging CACHE PATH "Where package build files, like rpm.spec file or config.xml, are write.")
368 if(NOT BINDINGS_LINK_FLAG)
369 set(BINDINGS_LINK_FLAG "-Wl,--version-script=${PKG_TEMPLATE_PREFIX}/cmake/export.map")
372 # Add a dummy target to enable global dependency order
373 # -----------------------------------------------------
374 if(EXTRA_DEPENDENCIES_ORDER)
375 set(DEPENDENCIES_TARGET ${PROJECT_NAME}_extra_dependencies)
376 add_custom_target(${DEPENDENCIES_TARGET} ALL
377 DEPENDS ${EXTRA_DEPENDENCY_ORDER}
381 # Print developer helper message when build is done
382 # -------------------------------------------------------
383 macro(project_closing_msg)
384 get_property(PROJECT_TARGETS_SET GLOBAL PROPERTY PROJECT_TARGETS SET)
385 get_property(PROJECT_TARGETS GLOBAL PROPERTY PROJECT_TARGETS)
386 if(CLOSING_MESSAGE AND ${PROJECT_TARGETS_SET})
387 add_custom_target(${PROJECT_NAME}_build_done ALL
388 COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --cyan "++ ${CLOSING_MESSAGE}"
390 add_dependencies(${PROJECT_NAME}_build_done
391 ${DEPENDENCIES_TARGET} ${PROJECT_TARGETS})
396 remote_targets_populate()