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