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