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