templates/native/etc/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
  28 # Generic useful macro
  29 # -----------------------
  30 macro(PROJECT_TARGET_ADD TARGET_NAME)
  31         set(PROJECT_TARGETS ${PROJECT_TARGETS} ${TARGET_NAME} CACHE INTERNAL PROJECT_TARGETS)
  32         set(TARGET_NAME ${TARGET_NAME})
  33
  34         # Cmake does not maintain targets list before 3.7
  35         # -------------------------------------------------
  36         if(${CMAKE_VERSION} VERSION_LESS 3.7)
  37                 set(GLOBAL_TARGET_LIST ${PROJECT_TARGETS} CACHE INTERNAL "Hold project targets")
  38         else()
  39                 get_property(GLOBAL_TARGET_LIST GLOBAL PROPERTY GlobalTargetList)
  40         endif()
  41 endmacro(PROJECT_TARGET_ADD)
  42
  43 # Check GCC minimal version version
  44 if (gcc_minimal_version)
  45    message ("-- Check gcc_minimal_version (found gcc version ${CMAKE_C_COMPILER_VERSION})  (found g++ version ${CMAKE_CXX_COMPILER_VERSION})")
  46 if (CMAKE_CXX_COMPILER_VERSION VERSION_LESS ${gcc_minimal_version} OR CMAKE_C_COMPILER_VERSION VERSION_LESS ${gcc_minimal_version})
  47     message(FATAL_ERROR "**** FATAL: Require at least gcc-${gcc_minimal_version} please set CMAKE_C[XX]_COMPILER")
  48 endif()
  49 endif(gcc_minimal_version)
  50
  51 macro(defstr name value)
  52         add_definitions(-D${name}=${value})
  53 endmacro(defstr)
  54
  55 # WGT packaging
  56 macro(project_targets_populate)
  57         add_custom_target(MAIN_POPULATE)
  58         foreach(TARGET ${PROJECT_TARGETS})
  59                 get_target_property(T ${TARGET} LABELS)
  60                 if(T)
  61                         # Declaration of a custom command that will populate widget tree with the target
  62                         set(POPULE_WIDGET_TARGET "project_populate_${TARGET}")
  63
  64                         get_target_property(P ${TARGET} PREFIX)
  65                         get_target_property(BD ${TARGET} BINARY_DIR)
  66                         get_target_property(OUT ${TARGET} OUTPUT_NAME)
  67
  68                         if(P MATCHES "NOTFOUND$")
  69                                 if (${T} STREQUAL "BINDING")
  70                                         set(P "lib")
  71                                 else()
  72                                         set(P "")
  73                                 endif()
  74                         endif()
  75
  76                         if(${T} STREQUAL "BINDING")
  77                                 add_custom_command(OUTPUT ${WIDGET_LIBDIR}/${P}${TARGET}.so
  78                                         DEPENDS ${TARGET}
  79                                         COMMAND mkdir -p ${WIDGET_LIBDIR}
  80                                         COMMAND cp ${BD}/${P}${OUT}.so ${WIDGET_LIBDIR}
  81                                 )
  82                                 add_custom_target(${POPULE_WIDGET_TARGET} DEPENDS ${WIDGET_LIBDIR}/${P}${TARGET}.so)
  83                                 add_dependencies(MAIN_POPULATE ${POPULE_WIDGET_TARGET})
  84                         elseif(${T} STREQUAL "EXECUTABLE")
  85                                 add_custom_command(OUTPUT ${WIDGET_BINDIR}/${P}${TARGET}
  86                                         DEPENDS ${TARGET}
  87                                         COMMAND mkdir -p ${WIDGET_BINDIR}
  88                                         COMMAND cp ${BD}/${P}${OUT} ${WIDGET_BINDIR}
  89                                 )
  90                                 add_custom_target(${POPULE_WIDGET_TARGET} DEPENDS ${WIDGET_BINDIR}/${P}${TARGET})
  91                                 add_dependencies(MAIN_POPULATE ${POPULE_WIDGET_TARGET})
  92                         elseif(${T} STREQUAL "HTDOCS")
  93                                 add_custom_command(OUTPUT ${WIDGET_HTTPDIR}
  94                                         DEPENDS ${TARGET}
  95                                         COMMAND cp -r ${BD}/${P}${OUT} ${WIDGET_HTTPDIR}
  96                                         )
  97                                         add_custom_target(${POPULE_WIDGET_TARGET} DEPENDS ${WIDGET_HTTPDIR})
  98                                         add_dependencies(MAIN_POPULATE ${POPULE_WIDGET_TARGET})
  99                         elseif(${T} STREQUAL "DATA")
 100                                 add_custom_command(OUTPUT ${WIDGET_DATADIR}
 101                                         DEPENDS ${TARGET}
 102                                         COMMAND cp -r ${BD}/${P}${OUT} ${WIDGET_DATADIR}
 103                                         )
 104                                         add_custom_target(${POPULE_WIDGET_TARGET} DEPENDS ${WIDGET_HTTPDIR})
 105                                         add_dependencies(MAIN_POPULATE ${POPULE_WIDGET_TARGET})
 106                         endif(${T} STREQUAL "BINDING")
 107 #               elseif(${CMAKE_BUILD_TYPE} MATCHES "[Dd][Ee][Bb][Uu][Gg]")
 108 #                                       MESSAGE(WARNING "This target, ${TARGET}, will be not be included in the package.")
 109                 endif()
 110         endforeach()
 111 endmacro(project_targets_populate)
 112
 113 macro(project_package_build)
 114                 if(NOT EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/${PROJECT_WGT_DIR}/config.xml.in OR NOT EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/${PROJECT_WGT_DIR}/${PROJECT_ICON}.in)
 115                         MESSAGE(FATAL_ERROR "Missing mandatory files: you need config.xml.in and ${PROJECT_ICON}.in files in ${CMAKE_CURRENT_SOURCE_DIR}/${PROJECT_WGT_DIR} folder.")
 116                 endif()
 117
 118                 if(NOT EXISTS ${WIDGET_DIR}/config.xml.in OR NOT EXISTS ${WIDGET_DIR}/${PROJECT_ICON}.in)
 119                         configure_file(${PROJECT_WGT_DIR}/config.xml.in ${WIDGET_DIR}/config.xml)
 120                         file(COPY ${PROJECT_WGT_DIR}/${PROJECT_ICON}.in DESTINATION ${WIDGET_DIR}/${PROJECT_ICON})
 121                 endif(NOT EXISTS ${WIDGET_DIR}/config.xml.in OR NOT EXISTS ${WIDGET_DIR}/${PROJECT_ICON}.in)
 122
 123                 file(GLOB PROJECT_CONF_FILES "${PROJECT_WGT_DIR}/etc/*")
 124                 if(${PROJECT_CONF_FILES})
 125                         file(COPY "${PROJECT_WGT_DIR}/etc/*" DESTINATION ${WIDGET_ETCDIR}/)
 126                 endif(${PROJECT_CONF_FILES})
 127
 128                 add_custom_command(OUTPUT ${PROJECT_NAME}.wgt
 129                         DEPENDS ${PROJECT_TARGETS}
 130                         COMMAND wgtpkg-pack -f -o ${PROJECT_NAME}.wgt ${WIDGET_DIR}
 131                 )
 132
 133                 add_custom_target(widget DEPENDS ${PROJECT_NAME}.wgt)
 134                 add_dependencies(widget MAIN_POPULATE)
 135                 set(ADDITIONAL_MAKE_CLEAN_FILES, "${PROJECT_NAME}.wgt")
 136
 137                 if(WIDGET_MESSAGE)
 138                 add_custom_command(TARGET widget
 139                         POST_BUILD
 140                         COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --cyan "++ ${WIDGET_MESSAGE}")
 141                 endif()
 142 endmacro(project_package_build)
 143
 144 macro(project_subdirs_add)
 145         if(${ARGV0})
 146                 file(GLOB filelist "${ARGV0}")
 147         else()
 148                 file(GLOB filelist "*")
 149         endif(${ARGV0})
 150
 151         foreach(filename ${filelist})
 152                 if(EXISTS "${filename}/CMakeLists.txt")
 153                         add_subdirectory(${filename})
 154                 endif(EXISTS "${filename}/CMakeLists.txt")
 155         endforeach()
 156 endmacro(project_subdirs_add)
 157
 158 set(CMAKE_BUILD_TYPE Debug CACHE STRING "the type of build")
 159 set(CMAKE_POSITION_INDEPENDENT_CODE ON)
 160 set(CMP0048 1)
 161
 162 # Include project configuration
 163 # ------------------------------
 164 project(${PROJECT_NAME} VERSION ${PROJECT_VERSION} LANGUAGES ${PROJECT_LANGUAGES})
 165 set(PROJECT_WGT_DIR "packaging/wgt" CACHE PATH "Subpath to the widget directory")
 166 set(PROJECT_LIBDIR "libs" CACHE PATH "Subpath to libraries")
 167 set(PROJECT_RESOURCES "data" CACHE PATH "Subpath to data")
 168
 169 INCLUDE(FindPkgConfig)
 170 INCLUDE(CheckIncludeFiles)
 171 INCLUDE(CheckLibraryExists)
 172 INCLUDE(GNUInstallDirs)
 173
 174 # Default compilation options
 175 ############################################################################
 176 link_libraries(-Wl,--as-needed -Wl,--gc-sections)
 177 add_compile_options(-Wall -Wextra -Wconversion)
 178 add_compile_options(-Wno-unused-parameter) # frankly not using a parameter does it care?
 179 add_compile_options(-Wno-sign-compare -Wno-sign-conversion)
 180 add_compile_options(-Werror=maybe-uninitialized)
 181 add_compile_options(-Werror=implicit-function-declaration)
 182 add_compile_options(-ffunction-sections -fdata-sections)
 183 add_compile_options(-fPIC)
 184 add_compile_options(-g)
 185
 186 set(CMAKE_C_FLAGS_PROFILING   "-g -O2 -pg -Wp,-U_FORTIFY_SOURCE" CACHE STRING "Flags for profiling")
 187 set(CMAKE_C_FLAGS_DEBUG       "-g -O2 -ggdb -Wp,-U_FORTIFY_SOURCE" CACHE STRING "Flags for debugging")
 188 set(CMAKE_C_FLAGS_RELEASE     "-O2" CACHE STRING "Flags for releasing")
 189 set(CMAKE_C_FLAGS_CCOV        "-g -O2 --coverage" CACHE STRING "Flags for coverage test")
 190
 191 set(CMAKE_CXX_FLAGS_PROFILING    "-g -O0 -pg -Wp,-U_FORTIFY_SOURCE")
 192 set(CMAKE_CXX_FLAGS_DEBUG        "-g -O0 -ggdb -Wp,-U_FORTIFY_SOURCE")
 193 set(CMAKE_CXX_FLAGS_RELEASE      "-g -O2")
 194 set(CMAKE_CXX_FLAGS_CCOV "-g -O2 --coverage")
 195
 196 set(CMAKE_INSTALL_PREFIX      "${CMAKE_SOURCE_DIR}/Install" CACHE PATH "The path where to install")
 197
 198 # (BUG!!!) as PKG_CONFIG_PATH does not work [should be en env variable]
 199 set(PKG_CONFIG_USE_CMAKE_PREFIX_PATH ON CACHE BOOLEAN "Flag for using prefix path")
 200
 201 # Loop on required package and add options
 202 foreach (PKG_CONFIG ${PKG_REQUIRED_LIST})
 203         PKG_CHECK_MODULES(${PKG_CONFIG} REQUIRED ${PKG_CONFIG})
 204
 205         INCLUDE_DIRECTORIES(${${PKG_CONFIG}_INCLUDE_DIRS})
 206         list (APPEND link_libraries ${${PKG_CONFIG}_LIBRARIES})
 207         add_compile_options (${${PKG_CONFIG}_CFLAGS})
 208 endforeach(PKG_CONFIG)
 209
 210 # Optional LibEfence Malloc debug library
 211 IF(CMAKE_BUILD_TYPE MATCHES DEBUG)
 212 CHECK_LIBRARY_EXISTS(efence malloc "" HAVE_LIBEFENCE)
 213 IF(HAVE_LIBEFENCE)
 214         MESSAGE(STATUS "Linking with ElectricFence for debugging purposes...")
 215         SET(libefence_LIBRARIES "-lefence")
 216         list (APPEND link_libraries ${libefence_LIBRARIES})
 217 ENDIF(HAVE_LIBEFENCE)
 218 ENDIF(CMAKE_BUILD_TYPE MATCHES DEBUG)
 219
 220 # set default include directories
 221 INCLUDE_DIRECTORIES(${EXTRA_INCLUDE_DIRS})
 222
 223 # If no install dir try to guess some smart default
 224 if(BINDINGS_INSTALL_PREFIX)
 225         set(BINDINGS_INSTALL_DIR ${BINDINGS_INSTALL_PREFIX}/${PROJECT_NAME})
 226 else()
 227         set(BINDINGS_INSTALL_DIR ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME})
 228 endif()
 229
 230 # Define a default package directory
 231 if(WIDGET_PREFIX)
 232         set(WIDGET_DIR ${WIDGET_PREFIX}/package)
 233 else()
 234         set(WIDGET_DIR ${CMAKE_CURRENT_BINARY_DIR}/package)
 235 endif()
 236
 237 # and their subsequent subdir
 238 set(WIDGET_BINDIR ${WIDGET_DIR}/bin)
 239 set(WIDGET_ETCDIR ${WIDGET_DIR}/etc)
 240 set(WIDGET_LIBDIR ${WIDGET_DIR}/lib)
 241 set(WIDGET_HTTPDIR ${WIDGET_DIR}/htdocs)
 242 set(WIDGET_DATADIR ${WIDGET_DIR}/data)
 243
 244 # Default Linkflag
 245 if(NOT BINDINGS_LINK_FLAG)
 246         set(BINDINGS_LINK_FLAG "-Wl,--version-script=${CMAKE_SOURCE_DIR}/etc/export.map")
 247 endif()
 248
 249 # Add a dummy target to enable global dependency order
 250 # -----------------------------------------------------
 251 if(EXTRA_DEPENDENCIES_ORDER)
 252         set(DEPENDENCIES_TARGET ${PROJECT_NAME}_extra_dependencies)
 253         add_custom_target(${DEPENDENCIES_TARGET} ALL
 254                 DEPENDS ${EXTRA_DEPENDENCY_ORDER}
 255         )
 256 endif()
 257
 258 # Print developer helper message when build is done
 259 # -------------------------------------------------------
 260 macro(project_closing_msg)
 261         if(CLOSING_MESSAGE AND GLOBAL_TARGET_LIST)
 262                 add_custom_target(${PROJECT_NAME}_build_done ALL
 263                         COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --cyan "++ ${CLOSING_MESSAGE}"
 264                 )
 265                  add_dependencies(${PROJECT_NAME}_build_done
 266                         ${DEPENDENCIES_TARGET} ${GLOBAL_TARGET_LIST})
 267         endif()
 268 endmacro()