cmake/macros.cmake

   1 ###########################################################################
   2 # Copyright 2015, 2016, 2017 IoT.bzh
   3 #
   4 # author: Fulup Ar Foll <fulup@iot.bzh>
   5 # contrib: Romain Forlot <romain.forlot@iot.bzh>
   6 #
   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
  10 #
  11 #     http://www.apache.org/licenses/LICENSE-2.0
  12 #
  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 ###########################################################################
  19
  20
  21 #--------------------------------------------------------------------------
  22 #  WARNING:
  23 #     Do not change this cmake template
  24 #     Customise your preferences in "./etc/config.cmake"
  25 #--------------------------------------------------------------------------
  26
  27 # Get colorized message output non Windows OS. You know bash ? :)
  28 if(NOT WIN32)
  29   string(ASCII 27 Esc)
  30   set(ColourReset "${Esc}[m")
  31   set(ColourBold  "${Esc}[1m")
  32   set(Red         "${Esc}[31m")
  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")
  46 endif()
  47
  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)
  54
  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")
  60 endif()
  61 endif(gcc_minimal_version)
  62
  63 macro(defstr name value)
  64         add_definitions(-D${name}=${value})
  65 endmacro(defstr)
  66
  67 # WGT packaging
  68 macro(project_targets_populate)
  69         # Default Widget default directory
  70         set(PACKAGE_BINDIR  ${PROJECT_PKG_DIR}/bin)
  71         set(PACKAGE_ETCDIR  ${PROJECT_PKG_DIR}/etc)
  72         set(PACKAGE_LIBDIR  ${PROJECT_PKG_DIR}/lib)
  73         set(PACKAGE_HTTPDIR ${PROJECT_PKG_DIR}/htdocs)
  74         set(PACKAGE_DATADIR ${PROJECT_PKG_DIR}/data)
  75
  76         add_custom_target(populate)
  77         get_property(PROJECT_TARGETS GLOBAL PROPERTY PROJECT_TARGETS)
  78         foreach(TARGET ${PROJECT_TARGETS})
  79                 get_target_property(T ${TARGET} LABELS)
  80                 if(T)
  81                         # Declaration of a custom command that will populate widget tree with the target
  82                         set(POPULE_PACKAGE_TARGET "project_populate_${TARGET}")
  83
  84                         get_target_property(P ${TARGET} PREFIX)
  85                         get_target_property(BD ${TARGET} BINARY_DIR)
  86                         get_target_property(OUT ${TARGET} OUTPUT_NAME)
  87
  88                         if(P MATCHES "NOTFOUND$")
  89                                 if (${T} STREQUAL "BINDING")
  90                                         set(P "lib")
  91                                 else()
  92                                         set(P "")
  93                                 endif()
  94                         endif()
  95
  96                         if(${T} STREQUAL "BINDING")
  97                                 add_custom_command(OUTPUT ${PACKAGE_LIBDIR}/${P}${TARGET}.so
  98                                         DEPENDS ${TARGET}
  99                                         COMMAND mkdir -p ${PACKAGE_LIBDIR}
 100                                         COMMAND cp ${BD}/${P}${OUT}.so ${PACKAGE_LIBDIR}
 101                                 )
 102                                 add_custom_target(${POPULE_PACKAGE_TARGET} DEPENDS ${PACKAGE_LIBDIR}/${P}${TARGET}.so)
 103                                 add_dependencies(populate ${POPULE_PACKAGE_TARGET})
 104                         elseif(${T} STREQUAL "EXECUTABLE")
 105                                 add_custom_command(OUTPUT ${PACKAGE_BINDIR}/${P}${TARGET}
 106                                         DEPENDS ${TARGET}
 107                                         COMMAND mkdir -p ${PACKAGE_BINDIR}
 108                                         COMMAND cp ${BD}/${P}${OUT} ${PACKAGE_BINDIR}
 109                                 )
 110                                 add_custom_target(${POPULE_PACKAGE_TARGET} DEPENDS ${PACKAGE_BINDIR}/${P}${TARGET})
 111                                 add_dependencies(populate ${POPULE_PACKAGE_TARGET})
 112                         elseif(${T} STREQUAL "HTDOCS")
 113                                 add_custom_command(OUTPUT ${PACKAGE_HTTPDIR}
 114                                         DEPENDS ${TARGET}
 115                                         COMMAND mkdir -p ${PROJECT_PKG_DIR}
 116                                         COMMAND cp -r ${BD}/${P}${OUT} ${PACKAGE_HTTPDIR}
 117                                         )
 118                                         add_custom_target(${POPULE_PACKAGE_TARGET} DEPENDS ${PACKAGE_HTTPDIR})
 119                                         add_dependencies(populate ${POPULE_PACKAGE_TARGET})
 120                         elseif(${T} STREQUAL "DATA")
 121                                 add_custom_command(OUTPUT ${PACKAGE_DATADIR}
 122                                         DEPENDS ${TARGET}
 123                                         COMMAND mkdir -p ${PROJECT_PKG_DIR}
 124                                         COMMAND cp -r ${BD}/${P}${OUT} ${PACKAGE_DATADIR}
 125                                         )
 126                                         add_custom_target(${POPULE_PACKAGE_TARGET} DEPENDS ${PACKAGE_HTTPDIR})
 127                                         add_dependencies(populate ${POPULE_PACKAGE_TARGET})
 128                         endif(${T} STREQUAL "BINDING")
 129 #               elseif(${CMAKE_BUILD_TYPE} MATCHES "[Dd][Ee][Bb][Uu][Gg]")
 130 #                                       MESSAGE(WARNING "This target, ${TARGET}, will be not be included in the package.")
 131                 endif()
 132         endforeach()
 133 endmacro(project_targets_populate)
 134
 135 macro(wgt_package_build)
 136         if(NOT EXISTS ${TEMPLATE_WGT_DIR}/config.xml.in OR NOT EXISTS ${TEMPLATE_WGT_DIR}/${PROJECT_ICON})
 137                 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}")
 138         else()
 139                 # Build widget spec file from template only once (Fulup good idea or should depend on time ????)
 140                 if(NOT EXISTS ${TEMPLATE_WGT_DIR}/config.xml.in OR NOT EXISTS ${TEMPLATE_WGT_DIR}/${PROJECT_ICON})
 141                                 configure_file(${TEMPLATE_WGT_DIR}/config.xml.in ${PROJECT_PKG_DIR}/config.xml)
 142                                 file(COPY ${TEMPLATE_WGT_DIR}/${PROJECT_ICON} DESTINATION ${PROJECT_PKG_DIR}/${PROJECT_ICON})
 143                 endif(NOT EXISTS ${TEMPLATE_WGT_DIR}/config.xml.in OR NOT EXISTS ${TEMPLATE_WGT_DIR}/${PROJECT_ICON})
 144
 145                 # Fulup ??? copy any extra file in wgt/etc into populate package before building the widget
 146                 file(GLOB PROJECT_CONF_FILES "${TEMPLATE_WGT_DIR}/etc/*")
 147                 if(${PROJECT_CONF_FILES})
 148                                 file(COPY "${TEMPLATE_WGT_DIR}/etc/*" DESTINATION ${PROJECT_PKG_DIR}/etc/)
 149                 endif(${PROJECT_CONF_FILES})
 150
 151                 add_custom_command(OUTPUT ${PROJECT_NAME}.wgt
 152                                 DEPENDS ${PROJECT_TARGETS}
 153                                 COMMAND wgtpkg-pack -f -o ${PROJECT_NAME}.wgt ${PROJECT_PKG_DIR}
 154                 )
 155
 156                 add_custom_target(widget DEPENDS ${PROJECT_NAME}.wgt)
 157                 add_dependencies(widget populate)
 158                 set(ADDITIONAL_MAKE_CLEAN_FILES, "${PROJECT_NAME}.wgt")
 159
 160                 if(PACKAGE_MESSAGE)
 161                 add_custom_command(TARGET widget
 162                                 POST_BUILD
 163                                 COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --cyan "++ ${PACKAGE_MESSAGE}")
 164                 endif()
 165         endif()
 166 endmacro(wgt_package_build)
 167
 168 macro(rpm_package_build)
 169         if(NOT EXISTS ${PROJECT_RPM_DIR}/config.rpm.in)
 170                         MESSAGE(STATUS "Missing mandatory files: you needconfig.rpm.in in ${PROJECT_RPM_DIR} folder.")
 171         else()
 172                 # extract PROJECT_PKG_DEPS and replace ; by , for RPM spec file
 173                 get_property(PROJECT_PKG_DEPS GLOBAL PROPERTY PROJECT_PKG_DEPS)
 174                 foreach (PKFCONF ${PROJECT_PKG_DEPS})
 175                 set(RPM_PKG_DEPS "${RPM_PKG_DEPS}, pkgconfig(${PKFCONF})")
 176                 endforeach()
 177
 178                 # build rpm spec file from template
 179                 configure_file(${PROJECT_RPM_DIR}/config.rpm.in ${PROJECT_PKG_DIR}/config.rpm)
 180
 181                 add_custom_command(OUTPUT ${PROJECT_NAME}.rpm
 182                                 DEPENDS ${PROJECT_TARGETS}
 183                                 COMMAND rpmbuild -ba  ${PROJECT_PKG_DIR}/config.rpm
 184                 )
 185
 186                 add_custom_target(rpm DEPENDS ${PROJECT_NAME}.rpm)
 187                 add_dependencies(rpm populate)
 188                 set(ADDITIONAL_MAKE_CLEAN_FILES, "${PROJECT_NAME}.rpm")
 189
 190                 if(PACKAGE_MESSAGE)
 191                 add_custom_command(TARGET rpm
 192                                 POST_BUILD
 193                                 COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --cyan "++ ${PACKAGE_MESSAGE}")
 194                 endif()
 195         endif()
 196 endmacro(rpm_package_build)
 197
 198 macro(project_package_build)
 199         if(EXISTS ${TEMPLATE_RPM_DIR})
 200                 rpm_package_build()
 201         endif()
 202
 203         if(EXISTS ${TEMPLATE_WGT_DIR})
 204                 wgt_package_build()
 205         endif()
 206
 207         if(EXISTS ${TEMPLATE_DEB_DIR})
 208                 deb_package_build()
 209         endif()
 210 endmacro(project_package_build)
 211
 212 macro(project_subdirs_add)
 213         if(${ARGV0})
 214                 file(GLOB filelist "${ARGV0}")
 215         else()
 216                 file(GLOB filelist "*")
 217         endif(${ARGV0})
 218
 219         foreach(filename ${filelist})
 220                 if(EXISTS "${filename}/CMakeLists.txt")
 221                         add_subdirectory(${filename})
 222                 endif(EXISTS "${filename}/CMakeLists.txt")
 223         endforeach()
 224 endmacro(project_subdirs_add)
 225
 226 set(CMAKE_BUILD_TYPE Debug CACHE STRING "the type of build")
 227 set(CMAKE_POSITION_INDEPENDENT_CODE ON)
 228 set(CMP0048 1)
 229
 230 # Include project configuration
 231 # ------------------------------
 232 project(${PROJECT_NAME} VERSION ${PROJECT_VERSION} LANGUAGES ${PROJECT_LANGUAGES})
 233 set(PROJECT_LIBDIR "libs" CACHE PATH "Subpath to libraries")
 234 set(PROJECT_RESOURCES "data" CACHE PATH "Subpath to data")
 235
 236 INCLUDE(FindPkgConfig)
 237 INCLUDE(CheckIncludeFiles)
 238 INCLUDE(CheckLibraryExists)
 239 INCLUDE(GNUInstallDirs)
 240
 241 # Default compilation options
 242 ############################################################################
 243 link_libraries(-Wl,--as-needed -Wl,--gc-sections)
 244 add_compile_options(-Wall -Wextra -Wconversion)
 245 add_compile_options(-Wno-unused-parameter) # frankly not using a parameter does it care?
 246 add_compile_options(-Wno-sign-compare -Wno-sign-conversion)
 247 add_compile_options(-Werror=maybe-uninitialized)
 248 add_compile_options(-Werror=implicit-function-declaration)
 249 add_compile_options(-ffunction-sections -fdata-sections)
 250 add_compile_options(-fPIC)
 251 add_compile_options(-g)
 252
 253 set(CMAKE_C_FLAGS_PROFILING   "-g -O2 -pg -Wp,-U_FORTIFY_SOURCE" CACHE STRING "Flags for profiling")
 254 set(CMAKE_C_FLAGS_DEBUG       "-g -O2 -ggdb -Wp,-U_FORTIFY_SOURCE" CACHE STRING "Flags for debugging")
 255 set(CMAKE_C_FLAGS_RELEASE     "-O2" CACHE STRING "Flags for releasing")
 256 set(CMAKE_C_FLAGS_CCOV        "-g -O2 --coverage" CACHE STRING "Flags for coverage test")
 257
 258 set(CMAKE_CXX_FLAGS_PROFILING    "-g -O0 -pg -Wp,-U_FORTIFY_SOURCE")
 259 set(CMAKE_CXX_FLAGS_DEBUG        "-g -O0 -ggdb -Wp,-U_FORTIFY_SOURCE")
 260 set(CMAKE_CXX_FLAGS_RELEASE      "-g -O2")
 261 set(CMAKE_CXX_FLAGS_CCOV "-g -O2 --coverage")
 262
 263 set(CMAKE_INSTALL_PREFIX      "${CMAKE_SOURCE_DIR}/Install" CACHE PATH "The path where to install")
 264
 265 # (BUG!!!) as PKG_CONFIG_PATH does not work [should be en env variable]
 266 set(PKG_CONFIG_USE_CMAKE_PREFIX_PATH ON CACHE BOOLEAN "Flag for using prefix path")
 267
 268 # Loop on required package and add options
 269 foreach (PKG_CONFIG ${PKG_REQUIRED_LIST})
 270         PKG_CHECK_MODULES(${PKG_CONFIG} REQUIRED ${PKG_CONFIG})
 271
 272         INCLUDE_DIRECTORIES(${${PKG_CONFIG}_INCLUDE_DIRS})
 273         list (APPEND link_libraries ${${PKG_CONFIG}_LIBRARIES})
 274         add_compile_options (${${PKG_CONFIG}_CFLAGS})
 275 endforeach(PKG_CONFIG)
 276
 277 # Optional LibEfence Malloc debug library
 278 IF(CMAKE_BUILD_TYPE MATCHES DEBUG)
 279 CHECK_LIBRARY_EXISTS(efence malloc "" HAVE_LIBEFENCE)
 280 IF(HAVE_LIBEFENCE)
 281         MESSAGE(STATUS "Linking with ElectricFence for debugging purposes...")
 282         SET(libefence_LIBRARIES "-lefence")
 283         list (APPEND link_libraries ${libefence_LIBRARIES})
 284 ENDIF(HAVE_LIBEFENCE)
 285 ENDIF(CMAKE_BUILD_TYPE MATCHES DEBUG)
 286
 287 # set default include directories
 288 INCLUDE_DIRECTORIES(${EXTRA_INCLUDE_DIRS})
 289
 290 # If no install dir try to guess some smart default
 291 if(BINDINGS_INSTALL_PREFIX)
 292         set(BINDINGS_INSTALL_DIR ${BINDINGS_INSTALL_PREFIX}/${PROJECT_NAME} CACHE PATH "Where the binding will be installed in your system")
 293 else()
 294         set(BINDINGS_INSTALL_DIR ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME} CACHE PATH "Where the binding will be installed in your system")
 295 endif()
 296
 297 # Define a default package directory
 298 if(PACKAGE_PREFIX)
 299         set(PROJECT_PKG_DIR ${PKG_PREFIX}/package CACHE PATH "Where the package will be built.")
 300 else()
 301         set(PROJECT_PKG_DIR ${CMAKE_CURRENT_BINARY_DIR}/package CACHE PATH "Where the package will be built")
 302 endif()
 303
 304 set (PKG_TEMPLATE_PREFIX ${CMAKE_SOURCE_DIR}/etc CACHE PATH "Default Package Templates Directory")
 305 set(TEMPLATE_WGT_DIR "${CMAKE_SOURCE_DIR}/conf.d/app-templates/wgt" CACHE PATH "Subpath to a directory where are stored needed files to build widget")
 306 set(TEMPLATE_RPM_DIR "${CMAKE_SOURCE_DIR}/conf.d/app-templates/rpm" CACHE PATH "Subpath to a directory where are stored needed files to build rpm package")
 307 set(TEMPLATE_DEB_DIR "${CMAKE_SOURCE_DIR}/conf.d/app-templates/deb" CACHE PATH "Subpath to a directory where are stored needed files to build deb package")
 308
 309 # Default Linkflag
 310 if(NOT BINDINGS_LINK_FLAG)
 311         set(BINDINGS_LINK_FLAG "-Wl,--version-script=${CMAKE_SOURCE_DIR}/conf.d/app-templates/cmake/export.map")
 312 endif()
 313
 314 # Add a dummy target to enable global dependency order
 315 # -----------------------------------------------------
 316 if(EXTRA_DEPENDENCIES_ORDER)
 317         set(DEPENDENCIES_TARGET ${PROJECT_NAME}_extra_dependencies)
 318         add_custom_target(${DEPENDENCIES_TARGET} ALL
 319                 DEPENDS ${EXTRA_DEPENDENCY_ORDER}
 320         )
 321 endif()
 322
 323 # Print developer helper message when build is done
 324 # -------------------------------------------------------
 325 macro(project_closing_msg)
 326         get_property(PROJECT_TARGETS_SET GLOBAL PROPERTY PROJECT_TARGETS SET)
 327         get_property(PROJECT_TARGETS GLOBAL PROPERTY PROJECT_TARGETS)
 328         if(CLOSING_MESSAGE AND ${PROJECT_TARGETS_SET})
 329                 add_custom_target(${PROJECT_NAME}_build_done ALL
 330                         COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --cyan "++ ${CLOSING_MESSAGE}"
 331                 )
 332                  add_dependencies(${PROJECT_NAME}_build_done
 333                         ${DEPENDENCIES_TARGET} ${PROJECT_TARGETS})
 334         endif()
 335 endmacro()