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