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