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