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