cmake/cmake.d/02-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 #  WARNING:
  22 #     Do not change this cmake template
  23 #     Customise your preferences in "./conf.d/cmake/config.cmake"
  24 #--------------------------------------------------------------------------
  25 # Generic useful macro
  26 # -----------------------
  27 macro(PROJECT_TARGET_ADD TARGET_NAME)
  28         set_property(GLOBAL APPEND PROPERTY PROJECT_TARGETS ${TARGET_NAME})
  29         set(TARGET_NAME ${TARGET_NAME})
  30 endmacro(PROJECT_TARGET_ADD)
  31
  32 macro(PROJECT_PKGDEP_ADD PKG_NAME)
  33         set_property(GLOBAL APPEND PROPERTY PROJECT_PKG_DEPS ${PKG_NAME})
  34 endmacro(PROJECT_PKGDEP_ADD)
  35
  36 macro(defstr name value)
  37         add_definitions(-D${name}=${value})
  38 endmacro(defstr)
  39
  40 macro(configure_files_in_dir dir)
  41         file(GLOB filelist "${dir}/*in")
  42         foreach(file ${filelist})
  43                 get_filename_component(filename ${file} NAME)
  44                 string(REGEX REPLACE "target" "${RSYNC_TARGET}" destinationfile ${filename})
  45                 string(REGEX REPLACE ".in$" "" destinationfile ${destinationfile})
  46                 configure_file(${file} ${CMAKE_CURRENT_BINARY_DIR}/target/${destinationfile})
  47                 set_property(DIRECTORY APPEND PROPERTY ADDITIONAL_MAKE_CLEAN_FILES "${CMAKE_CURRENT_BINARY_DIR}/target/${destinationfile}")
  48         endforeach()
  49 endmacro(configure_files_in_dir)
  50
  51 # Pre-packaging
  52 macro(project_targets_populate)
  53         # Default Widget default directory
  54         set(PACKAGE_BINDIR  ${PROJECT_PKG_BUILD_DIR}/bin)
  55         set(PACKAGE_ETCDIR  ${PROJECT_PKG_BUILD_DIR}/etc)
  56         set(PACKAGE_LIBDIR  ${PROJECT_PKG_BUILD_DIR}/lib)
  57         set(PACKAGE_HTTPDIR ${PROJECT_PKG_BUILD_DIR}/htdocs)
  58         set(PACKAGE_DATADIR ${PROJECT_PKG_BUILD_DIR}/data)
  59
  60         add_custom_target(populate)
  61                 get_property(PROJECT_TARGETS GLOBAL PROPERTY PROJECT_TARGETS)
  62         foreach(TARGET ${PROJECT_TARGETS})
  63                 get_target_property(T ${TARGET} LABELS)
  64                 if(T)
  65                         # Declaration of a custom command that will populate widget tree with the target
  66                         set(POPULE_PACKAGE_TARGET "project_populate_${TARGET}")
  67
  68                         get_target_property(P ${TARGET} PREFIX)
  69                         get_target_property(BD ${TARGET} BINARY_DIR)
  70                         get_target_property(SD ${TARGET} SOURCE_DIR)
  71                         get_target_property(OUT ${TARGET} OUTPUT_NAME)
  72
  73                         if(P MATCHES "NOTFOUND$")
  74                                 if (${T} STREQUAL "BINDING")
  75                                         set(P "lib")
  76                                 else()
  77                                         set(P "")
  78                                 endif()
  79                         endif()
  80
  81                         if(${T} STREQUAL "BINDING")
  82                                 add_custom_command(OUTPUT ${PACKAGE_LIBDIR}/${P}${OUT}.so
  83                                         COMMAND mkdir -p ${PACKAGE_LIBDIR}
  84                                         COMMAND cp ${BD}/${P}${OUT}.so ${PACKAGE_LIBDIR}
  85                                 )
  86                                 add_custom_target(${POPULE_PACKAGE_TARGET} DEPENDS ${PACKAGE_LIBDIR}/${P}${TARGET}.so)
  87                                 add_dependencies(populate ${POPULE_PACKAGE_TARGET} ${TARGET})
  88                         elseif(${T} STREQUAL "EXECUTABLE")
  89                                 add_custom_command(OUTPUT ${PACKAGE_BINDIR}/${P}${OUT}
  90                                         COMMAND mkdir -p ${PACKAGE_BINDIR}
  91                                         COMMAND cp ${BD}/${P}${OUT} ${PACKAGE_BINDIR}
  92                                 )
  93                                 add_custom_target(${POPULE_PACKAGE_TARGET} DEPENDS ${PACKAGE_BINDIR}/${P}${TARGET})
  94                                 add_dependencies(populate ${POPULE_PACKAGE_TARGET} ${TARGET})
  95                         elseif(${T} STREQUAL "HTDOCS")
  96                                 add_custom_command(OUTPUT ${PACKAGE_HTTPDIR}-xx
  97                                         COMMAND mkdir -p ${PACKAGE_HTTPDIR}
  98                                         COMMAND touch ${PACKAGE_HTTPDIR}
  99                                         COMMAND cp -r ${BD}/${P}${OUT}/* ${PACKAGE_HTTPDIR}
 100                                 )
 101                                         add_custom_target(${POPULE_PACKAGE_TARGET} DEPENDS ${PACKAGE_HTTPDIR}-xx)
 102                                         add_dependencies(populate ${POPULE_PACKAGE_TARGET} ${TARGET})
 103                         elseif(${T} STREQUAL "DATA")
 104                                 add_custom_command(OUTPUT ${PACKAGE_DATADIR}-xx
 105                                         COMMAND mkdir -p ${PACKAGE_DATADIR}
 106                                         COMMAND touch ${PACKAGE_DATADIR}
 107                                         COMMAND cp -r ${BD}/${P}${OUT}/* ${PACKAGE_DATADIR}
 108                                 )
 109                                         add_custom_target(${POPULE_PACKAGE_TARGET} DEPENDS ${PACKAGE_DATADIR}-xx)
 110                                         add_dependencies(populate ${POPULE_PACKAGE_TARGET} ${TARGET})
 111                         endif(${T} STREQUAL "BINDING")
 112                 elseif(${CMAKE_BUILD_TYPE} MATCHES "[Dd][Ee][Bb][Uu][Gg]")
 113                         MESSAGE(".. Warning: ${TARGET} ignored when packaging.")
 114                 endif()
 115         endforeach()
 116 endmacro(project_targets_populate)
 117
 118 macro(remote_targets_populate)
 119         if (DEFINED ENV{RSYNC_TARGET})
 120         set (RSYNC_TARGET $ENV{RSYNC_TARGET})
 121         endif()
 122         if (DEFINED ENV{RSYNC_PREFIX})
 123         set (RSYNC_PREFIX $ENV{RSYNC_PREFIX})
 124         endif()
 125
 126         set(
 127                 REMOTE_LAUNCH "Test on target with: ${CMAKE_CURRENT_BINARY_DIR}/target/start-on-${RSYNC_TARGET}.sh"
 128                 CACHE STRING "Command to start ${PROJECT_NAME} on remote target ${RSYNC_TARGET}"
 129         )
 130
 131         if(NOT RSYNC_TARGET OR NOT RSYNC_PREFIX)
 132                 message ("${Yellow}.. Warning: RSYNC_TARGET RSYNC_PREFIX not defined 'make remote-target-populate' not instanciated${ColourReset}")
 133                 add_custom_target(remote-target-populate
 134                         COMMENT "${Red}*** Fatal: RSYNC_TARGET RSYNC_PREFIX environment variables required with 'make remote-target-populate'${ColourReset}"
 135                         COMMAND exit -1
 136                 )
 137         else()
 138
 139                 configure_files_in_dir(${SSH_TEMPLATE_DIR})
 140                 configure_files_in_dir(${GDB_TEMPLATE_DIR})
 141
 142                 add_custom_target(remote-target-populate
 143                         COMMAND chmod +x ${CMAKE_CURRENT_BINARY_DIR}/target/*.sh
 144                         COMMAND rsync -e "ssh -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null" --archive --delete ${PROJECT_PKG_BUILD_DIR}/ ${RSYNC_TARGET}:${RSYNC_PREFIX}/${PROJECT_NAME}
 145                         COMMENT "${REMOTE_LAUNCH}"
 146                 )
 147                 add_dependencies(remote-target-populate populate)
 148         endif()
 149 endmacro(remote_targets_populate)
 150
 151 macro(wgt_package_build)
 152         if(NOT EXISTS ${WIDGET_CONFIG_TEMPLATE})
 153                 MESSAGE(FATAL_ERROR "${Red}WARNING ! Missing mandatory files to build widget file.\nYou need a config.xml template: please specify WIDGET_CONFIG_TEMPLATE correctly.${ColourReset}")
 154         endif()
 155         if(NOT EXISTS ${WGT_TEMPLATE_DIR}/icon-default.png)
 156                 MESSAGE(FATAL_ERROR "${Red}WARNING ! Missing mandatory files to build widget file.\nYou need ${PROJECT_ICON} file in ${WGT_TEMPLATE_DIR} folder.${ColourReset}")
 157         endif()
 158     if(NOT WIDGET_TYPE)
 159         MESSAGE(FATAL_ERROR "WIDGET_TYPE must be set in your config.cmake.\neg.: set(WIDGET_TYPE application/vnd.agl.service)")
 160     endif()
 161
 162         if(NOT WIDGET_ENTRY_POINT)
 163                 set(WIDGET_ENTRY_POINT lib)
 164         endif()
 165
 166         add_custom_command(OUTPUT ${PROJECT_PKG_BUILD_DIR}/config.xml
 167                 COMMAND ${CMAKE_COMMAND} -DINFILE=${WIDGET_CONFIG_TEMPLATE} -DOUTFILE=${PROJECT_PKG_BUILD_DIR}/config.xml -DPROJECT_BINARY_DIR=${CMAKE_CURRENT_BINARY_DIR} -P ${CMAKE_CURRENT_SOURCE_DIR}/${PROJECT_APP_TEMPLATES_DIR}/cmake/configure_file.cmake
 168                 COMMAND cp ${WGT_TEMPLATE_DIR}/icon-default.png ${PROJECT_PKG_BUILD_DIR}/${PROJECT_ICON}
 169
 170         )
 171         add_custom_target(packaging_wgt DEPENDS ${PROJECT_PKG_BUILD_DIR}/config.xml)
 172
 173         # Fulup ??? copy any extra file in wgt/etc into populate package before building the widget
 174         file(GLOB PROJECT_CONF_FILES "${WGT_TEMPLATE_DIR}/etc/*")
 175         if(${PROJECT_CONF_FILES})
 176                 file(COPY "${WGT_TEMPLATE_DIR}/etc/*" DESTINATION ${PROJECT_PKG_BUILD_DIR}/etc/)
 177         endif(${PROJECT_CONF_FILES})
 178
 179         add_custom_command(OUTPUT ${PROJECT_NAME}.wgt
 180                 DEPENDS ${PROJECT_TARGETS}
 181                 COMMAND wgtpkg-pack -f -o ${PROJECT_NAME}.wgt ${PROJECT_PKG_BUILD_DIR}
 182         )
 183
 184         add_custom_target(widget DEPENDS ${PROJECT_NAME}.wgt)
 185         add_dependencies(widget populate packaging_wgt)
 186         set_property(DIRECTORY APPEND PROPERTY ADDITIONAL_MAKE_CLEAN_FILES "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.wgt")
 187
 188         if(NOT RSYNC_TARGET)
 189                 message ("${Yellow}.. Warning: RSYNC_TARGET not defined 'make widget-target-install' not instanciated${ColourReset}")
 190                 add_custom_target(widget-target-install
 191                         COMMENT "${Red}*** Fatal: RSYNC_TARGET RSYNC_PREFIX environment variables required with 'make widget-target-install'${ColourReset}"
 192                         COMMAND exit -1
 193                 )
 194         else()
 195         configure_files_in_dir(${WGT_TEMPLATE_DIR})
 196         add_custom_target(widget-target-install
 197         DEPENDS widget
 198         COMMAND chmod +x ${CMAKE_CURRENT_BINARY_DIR}/target/install-wgt-on-${RSYNC_TARGET}.sh
 199         COMMAND ${CMAKE_CURRENT_BINARY_DIR}/target/install-wgt-on-${RSYNC_TARGET}.sh
 200         )
 201 endif()
 202
 203         if(PACKAGE_MESSAGE)
 204         add_custom_command(TARGET widget
 205                 POST_BUILD
 206                 COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --cyan "++ ${PACKAGE_MESSAGE}")
 207         endif()
 208 endmacro(wgt_package_build)
 209
 210 macro(rpm_package_build)
 211         add_custom_command(OUTPUT ${NPKG_PROJECT_NAME}.spec
 212                 DEPENDS ${PROJECT_TARGETS}
 213                                 archive
 214                                 packaging
 215                 COMMAND rpmbuild --define=\"%_sourcedir ${PROJECT_PKG_ENTRY_POINT}\" -ba  ${PROJECT_PKG_ENTRY_POINT}/${NPKG_PROJECT_NAME}.spec
 216         )
 217
 218         add_custom_target(rpm DEPENDS ${NPKG_PROJECT_NAME}.spec)
 219         add_dependencies(rpm populate packaging)
 220
 221         if(PACKAGE_MESSAGE)
 222         add_custom_command(TARGET rpm
 223                 POST_BUILD
 224                 COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --cyan "++ ${PACKAGE_MESSAGE}")
 225         endif()
 226 endmacro(rpm_package_build)
 227
 228 macro(deb_package_build)
 229 #TODO
 230 endmacro(deb_package_build)
 231
 232 macro(project_package_build)
 233         if(EXISTS ${RPM_TEMPLATE_DIR})
 234                 rpm_package_build()
 235         endif()
 236
 237         if(EXISTS ${WGT_TEMPLATE_DIR})
 238                 wgt_package_build()
 239         endif()
 240
 241         if(EXISTS ${DEB_TEMPLATE_DIR})
 242                 deb_package_build()
 243         endif()
 244 endmacro(project_package_build)
 245
 246 macro(project_subdirs_add)
 247         set (ARGSLIST ${ARGN})
 248         list(LENGTH ARGSLIST ARGSNUM)
 249         if(${ARGSNUM} GREATER 0)
 250                 file(GLOB filelist "${ARGV0}")
 251         else()
 252         file(GLOB filelist "*")
 253         endif()
 254
 255         foreach(filename ${filelist})
 256                 if(EXISTS "${filename}/CMakeLists.txt")
 257                         add_subdirectory(${filename})
 258                 endif(EXISTS "${filename}/CMakeLists.txt")
 259         endforeach()
 260 endmacro(project_subdirs_add)
 261
 262 # Print developer helper message when build is done
 263 # -------------------------------------------------------
 264 macro(project_closing_msg)
 265         get_property(PROJECT_TARGETS_SET GLOBAL PROPERTY PROJECT_TARGETS SET)
 266         get_property(PROJECT_TARGETS GLOBAL PROPERTY PROJECT_TARGETS)
 267         if(CLOSING_MESSAGE AND ${PROJECT_TARGETS_SET})
 268                 add_custom_target(${PROJECT_NAME}_build_done ALL
 269                         COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --cyan "++ ${CLOSING_MESSAGE}"
 270                 )
 271                  add_dependencies(${PROJECT_NAME}_build_done
 272                         ${DEPENDENCIES_TARGET} ${PROJECT_TARGETS})
 273         endif()
 274 endmacro()