cmake/cmake.d/03-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 # CMake 3.6 imported macros to simulate list(FILTER ...) subcommand
  26 #--------------------------------------------------------------------------
  27 MACRO(prevent_in_source_build)
  28         execute_process(COMMAND rm -rf ${CMAKE_SOURCE_DIR}/CMakeCache.txt ${CMAKE_SOURCE_DIR}/CMakeCacheForScript.cmake ${CMAKE_SOURCE_DIR}/CMakeFiles ${CMAKE_SOURCE_DIR}/cmake_install.cmake)
  29
  30         get_filename_component(srcdir "${CMAKE_SOURCE_DIR}" REALPATH)
  31         get_filename_component(bindir "${CMAKE_BINARY_DIR}" REALPATH)
  32
  33         if(${srcdir} STREQUAL ${bindir})
  34                 message(FATAL_ERROR "${Red}**** ERROR: You trying to build the project from the source directory or a previous build in-source occured. This isn't allowed, you have to clean CMakeCache.txt file from your source directory (${srcdir}), and build from a separate directory. ****\n")
  35         endif()
  36 ENDMACRO(prevent_in_source_build)
  37
  38 MACRO(PARSE_ARGUMENTS prefix arg_names option_names)
  39         SET(DEFAULT_ARGS)
  40         FOREACH(arg_name ${arg_names})
  41         SET(${prefix}_${arg_name})
  42         ENDFOREACH(arg_name)
  43         FOREACH(option ${option_names})
  44         SET(${prefix}_${option} FALSE)
  45         ENDFOREACH(option)
  46
  47         SET(current_arg_name DEFAULT_ARGS)
  48         SET(current_arg_list)
  49         FOREACH(arg ${ARGN})
  50         LIST_CONTAINS(is_arg_name ${arg} ${arg_names})
  51         IF (is_arg_name)
  52                 SET(${prefix}_${current_arg_name} ${current_arg_list})
  53                 SET(current_arg_name ${arg})
  54                 SET(current_arg_list)
  55         ELSE (is_arg_name)
  56                 LIST_CONTAINS(is_option ${arg} ${option_names})
  57                 IF (is_option)
  58         SET(${prefix}_${arg} TRUE)
  59                 ELSE (is_option)
  60         SET(current_arg_list ${current_arg_list} ${arg})
  61                 ENDIF (is_option)
  62         ENDIF (is_arg_name)
  63         ENDFOREACH(arg)
  64         SET(${prefix}_${current_arg_name} ${current_arg_list})
  65 ENDMACRO(PARSE_ARGUMENTS)
  66
  67 MACRO(LIST_CONTAINS var value)
  68 SET(${var})
  69 FOREACH (value2 ${ARGN})
  70   IF (${value} STREQUAL ${value2})
  71         SET(${var} TRUE)
  72   ENDIF (${value} STREQUAL ${value2})
  73 ENDFOREACH (value2)
  74 ENDMACRO(LIST_CONTAINS)
  75
  76 MACRO(LIST_FILTER)
  77 PARSE_ARGUMENTS(LIST_FILTER "OUTPUT_VARIABLE" "" ${ARGV})
  78 # Check arguments.
  79 LIST(LENGTH LIST_FILTER_DEFAULT_ARGS LIST_FILTER_default_length)
  80 IF(${LIST_FILTER_default_length} EQUAL 0)
  81   MESSAGE(FATAL_ERROR "LIST_FILTER: missing list variable.")
  82 ENDIF(${LIST_FILTER_default_length} EQUAL 0)
  83 IF(${LIST_FILTER_default_length} EQUAL 1)
  84   MESSAGE(FATAL_ERROR "LIST_FILTER: missing regular expression variable.")
  85 ENDIF(${LIST_FILTER_default_length} EQUAL 1)
  86 # Reset output variable
  87 IF(NOT LIST_FILTER_OUTPUT_VARIABLE)
  88   SET(LIST_FILTER_OUTPUT_VARIABLE "LIST_FILTER_internal_output")
  89 ENDIF(NOT LIST_FILTER_OUTPUT_VARIABLE)
  90 SET(${LIST_FILTER_OUTPUT_VARIABLE})
  91 # Extract input list from arguments
  92 LIST(GET LIST_FILTER_DEFAULT_ARGS 0 LIST_FILTER_input_list)
  93 LIST(REMOVE_AT LIST_FILTER_DEFAULT_ARGS 0)
  94 FOREACH(LIST_FILTER_item ${${LIST_FILTER_input_list}})
  95   FOREACH(LIST_FILTER_regexp_var ${LIST_FILTER_DEFAULT_ARGS})
  96         FOREACH(LIST_FILTER_regexp ${${LIST_FILTER_regexp_var}})
  97           IF(${LIST_FILTER_item} MATCHES ${LIST_FILTER_regexp})
  98                 LIST(APPEND ${LIST_FILTER_OUTPUT_VARIABLE} ${LIST_FILTER_item})
  99           ENDIF(${LIST_FILTER_item} MATCHES ${LIST_FILTER_regexp})
 100         ENDFOREACH(LIST_FILTER_regexp ${${LIST_FILTER_regexp_var}})
 101   ENDFOREACH(LIST_FILTER_regexp_var)
 102 ENDFOREACH(LIST_FILTER_item)
 103 # If OUTPUT_VARIABLE is not specified, overwrite the input list.
 104 IF(${LIST_FILTER_OUTPUT_VARIABLE} STREQUAL "LIST_FILTER_internal_output")
 105   SET(${LIST_FILTER_input_list} ${${LIST_FILTER_OUTPUT_VARIABLE}})
 106 ENDIF(${LIST_FILTER_OUTPUT_VARIABLE} STREQUAL "LIST_FILTER_internal_output")
 107 ENDMACRO(LIST_FILTER)
 108
 109 # Generic useful macro
 110 # -----------------------
 111 macro(set_install_prefix)
 112         if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT AND INSTALL_PREFIX)
 113                 message(STATUS "-- Overwrite the CMAKE default install prefix with ${INSTALL_PREFIX}")
 114                 set(CMAKE_INSTALL_PREFIX ${INSTALL_PREFIX} CACHE PATH "Install prefix" FORCE)
 115         endif()
 116         # (BUG!!!) as PKG_CONFIG_PATH does not work [should be an env variable]
 117         # ---------------------------------------------------------------------
 118         set(CMAKE_PREFIX_PATH ${CMAKE_INSTALL_PREFIX}/lib64/pkgconfig ${CMAKE_INSTALL_PREFIX}/lib/pkgconfig CACHE PATH 'Prefix Path list used by pkgconfig module')
 119         set(LD_LIBRARY_PATH ${CMAKE_INSTALL_PREFIX}/lib64 ${CMAKE_INSTALL_PREFIX}/lib CACHE PATH 'Path list where to search for libraries')
 120 endmacro()
 121
 122 macro(PROJECT_TARGET_ADD TARGET_NAME)
 123         set_property(GLOBAL APPEND PROPERTY PROJECT_TARGETS ${TARGET_NAME})
 124         set(TARGET_NAME ${TARGET_NAME})
 125 endmacro(PROJECT_TARGET_ADD)
 126
 127 macro(PROJECT_HAS_TESTS)
 128         foreach(T ${PROJECT_TARGETS})
 129                 get_target_property(TL ${T} "LABELS")
 130                 if(TL AND "${TL}" MATCHES "^TEST-")
 131                         set(HAS_TESTS TRUE)
 132                 endif()
 133         endforeach()
 134 endmacro()
 135
 136 macro(PROJECT_PKGDEP_ADD PKG_NAME)
 137         set_property(GLOBAL APPEND PROPERTY PROJECT_PKG_DEPS ${PKG_NAME})
 138 endmacro(PROJECT_PKGDEP_ADD)
 139
 140 macro(defstr name value)
 141         add_definitions(-D${name}=${value})
 142 endmacro(defstr)
 143
 144 macro(configure_files_in_dir dir)
 145         file(GLOB filelist "${dir}/*in")
 146         foreach(file ${filelist})
 147                 get_filename_component(filename ${file} NAME)
 148                 string(REGEX REPLACE "target" "${RSYNC_TARGET}" destinationfile ${filename})
 149                 string(REGEX REPLACE ".in$" "" destinationfile ${destinationfile})
 150                 configure_file(${file} ${CMAKE_CURRENT_BINARY_DIR}/target/${destinationfile})
 151                 set_property(DIRECTORY APPEND PROPERTY ADDITIONAL_MAKE_CLEAN_FILES "${CMAKE_CURRENT_BINARY_DIR}/target/${destinationfile}")
 152         endforeach()
 153 endmacro(configure_files_in_dir)
 154
 155 # Create custom target dedicated for HTML5 and DATA AGL target type
 156 macro(add_input_files INPUT_FILES)
 157         if(NOT DEFINED XML_FILES)
 158                 set(ext_reg "xml$")
 159                 set(XML_LIST ${INPUT_FILES})
 160                 list_filter(XML_LIST ext_reg)
 161                 execute_process(
 162                         COMMAND which ${XML_CHECKER}
 163                         RESULT_VARIABLE XML_CHECKER_PRESENT
 164                         OUTPUT_QUIET ERROR_QUIET
 165                 )
 166         endif()
 167         if(NOT DEFINED LUA_LIST)
 168                 set(ext_reg "lua$")
 169                 set(LUA_LIST ${INPUT_FILES})
 170                 list_filter(LUA_LIST ext_reg)
 171                 execute_process(
 172                         COMMAND which ${LUA_CHECKER}
 173                         RESULT_VARIABLE LUA_CHECKER_PRESENT
 174                         OUTPUT_QUIET ERROR_QUIET
 175                 )
 176         endif()
 177         if(NOT DEFINED JSON_FILES)
 178                 set(ext_reg "json$")
 179                 set(JSON_LIST ${INPUT_FILES})
 180                 list_filter(JSON_LIST ext_reg)
 181                 execute_process(
 182                         COMMAND which ${JSON_CHECKER}
 183                         RESULT_VARIABLE JSON_CHECKER_PRESENT
 184                         OUTPUT_QUIET ERROR_QUIET
 185                 )
 186         endif()
 187
 188         # These are v3.6 subcommand. Not used as default for now as
 189         # many dev use Ubuntu 16.04 which have only 3.5 version
 190         #list(FILTER XML_LIST INCLUDE REGEX "xml$")
 191         #list(FILTER LUA_LIST INCLUDE REGEX "lua$")
 192         #list(FILTER JSON_LIST INCLUDE REGEX "json$")
 193
 194         add_custom_target(${TARGET_NAME} ALL
 195         DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME}
 196         )
 197
 198         if(XML_CHECKER_PRESENT EQUAL 0)
 199                 foreach(file ${XML_LIST})
 200                         add_custom_command(TARGET ${TARGET_NAME}
 201                                 PRE_BUILD
 202                                 WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
 203                                 COMMAND ${XML_CHECKER} ${file}
 204                         )
 205                 endforeach()
 206         elseif(XML_LIST)
 207         add_custom_command(TARGET ${TARGET_NAME}
 208         PRE_BUILD
 209         WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
 210         COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --red "Warning: XML_CHECKER not found. Not verification made on files !")
 211         endif()
 212         if(LUA_CHECKER_PRESENT EQUAL 0)
 213                 foreach(file ${LUA_LIST})
 214                 add_custom_command(TARGET ${TARGET_NAME}
 215                         PRE_BUILD
 216                         WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
 217                         COMMAND ${LUA_CHECKER} ${file}
 218                 )
 219                 endforeach()
 220         elseif(LUA_LIST)
 221                 add_custom_command(TARGET ${TARGET_NAME}
 222                         PRE_BUILD
 223                         WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
 224                         COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --red "Warning: LUA_CHECKER not found. Not verification made on files !")
 225         endif()
 226         if(JSON_CHECKER_PRESENT EQUAL 0)
 227                 foreach(file ${JSON_LIST})
 228                 add_custom_command(TARGET ${TARGET_NAME}
 229                         PRE_BUILD
 230                         WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
 231                         COMMAND ${JSON_CHECKER} ${file}
 232                 )
 233                 endforeach()
 234         elseif(JSON_LIST)
 235         add_custom_command(TARGET ${TARGET_NAME}
 236         PRE_BUILD
 237         WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
 238         COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --red "Warning: JSON_CHECKER not found. Not verification made on files !")
 239         endif()
 240
 241         add_custom_command(OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME}
 242         DEPENDS ${INPUT_FILES}
 243         COMMAND mkdir -p ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME}
 244         COMMAND touch ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME}
 245         COMMAND cp -r ${INPUT_FILES} ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME}
 246         )
 247 endmacro()
 248
 249 # Set the name of the OPENAPI definition JSON file for binding v2
 250 macro(set_openapi_filename openapi_filename)
 251         set(OPENAPI_DEF ${openapi_filename} CACHE STRING "OpenAPI JSON file name used to generate binding header file before building a binding v2 target.")
 252 endmacro()
 253
 254 # Common command to call inside project_targets_populate macro
 255 macro(generate_one_populate_target OUTPUTFILES PKG_DESTDIR)
 256         add_custom_command(OUTPUT ${PKG_DESTDIR}/${OUTPUTFILES}
 257                 DEPENDS ${BD}/${OUTPUTFILES}
 258                 COMMAND mkdir -p ${PKG_DESTDIR}
 259                 COMMAND touch ${PKG_DESTDIR}
 260                 COMMAND cp -r ${BD}/${OUTPUTFILES}/* ${PKG_DESTDIR} 2> /dev/null || cp ${BD}/${OUTPUTFILES} ${PKG_DESTDIR}
 261         )
 262
 263         add_custom_target(${POPULE_PACKAGE_TARGET} DEPENDS ${PKG_DESTDIR}/${OUTPUTFILES})
 264         add_dependencies(populate ${POPULE_PACKAGE_TARGET})
 265         add_dependencies(${POPULE_PACKAGE_TARGET} ${TARGET})
 266 endmacro()
 267
 268 # To be call inside project_targets_populate macro
 269 macro(afb_genskel)
 270         set (ARGSLIST ${ARGN})
 271
 272         if ("${PROJECT_LANGUAGES}" MATCHES "CXX")
 273                 list(APPEND ARGSLIST "--cpp")
 274         endif()
 275
 276         if (OPENAPI_DEF)
 277                 add_custom_command(OUTPUT ${SD}/${OPENAPI_DEF}.h
 278                         DEPENDS ${SD}/${OPENAPI_DEF}.json
 279                         COMMAND afb-genskel ${ARGSLIST} ${SD}/${OPENAPI_DEF}.json > ${SD}/${OPENAPI_DEF}.h
 280                 )
 281                 add_custom_target("${TARGET}_GENSKEL" DEPENDS ${SD}/${OPENAPI_DEF}.h
 282                         COMMENT "Generating OpenAPI header file ${OPENAPI_DEF}.h")
 283                 add_dependencies(${TARGET} "${TARGET}_GENSKEL")
 284         else()
 285                 add_custom_command(OUTPUT ${SD}/${OUT}-apidef.h
 286                         DEPENDS ${SD}/${OUT}-apidef.json
 287                         COMMAND afb-genskel ${ARGSLIST} ${SD}/${OUT}-apidef.json > ${SD}/${OUT}-apidef.h
 288                 )
 289                 add_custom_target("${TARGET}_GENSKEL" DEPENDS ${SD}/${OUT}-apidef.h
 290                         COMMENT "Generating OpenAPI header file ${OUT}-apidef.h")
 291                 add_dependencies(${TARGET} "${TARGET}_GENSKEL")
 292         endif()
 293 endmacro()
 294
 295 # Pre-packaging
 296 macro(project_targets_populate)
 297         # Default Widget default directory
 298         set(PACKAGE_BINDIR  ${PROJECT_PKG_BUILD_DIR}/${BINDIR})
 299         set(PACKAGE_ETCDIR  ${PROJECT_PKG_BUILD_DIR}/${ETCDIR})
 300         set(PACKAGE_LIBDIR  ${PROJECT_PKG_BUILD_DIR}/${LIBDIR})
 301         set(PACKAGE_HTTPDIR ${PROJECT_PKG_BUILD_DIR}/${HTTPDIR})
 302         set(PACKAGE_DATADIR ${PROJECT_PKG_BUILD_DIR}/${DATADIR})
 303         # Default test Widget default directory
 304         string(REGEX REPLACE "/([^/]*)$" "/\\1-test" PROJECT_PKG_TEST_DIR "${PROJECT_PKG_BUILD_DIR}")
 305         set(PACKAGE_TEST_BINDIR  ${PROJECT_PKG_TEST_DIR}/${BINDIR})
 306         set(PACKAGE_TEST_ETCDIR  ${PROJECT_PKG_TEST_DIR}/${ETCDIR})
 307         set(PACKAGE_TEST_LIBDIR  ${PROJECT_PKG_TEST_DIR}/${LIBDIR})
 308         set(PACKAGE_TEST_HTTPDIR ${PROJECT_PKG_TEST_DIR}/${HTTPDIR})
 309         set(PACKAGE_TEST_DATADIR ${PROJECT_PKG_TEST_DIR}/${DATADIR})
 310
 311         if(NOT ${CMAKE_BUILD_TYPE} STREQUAL "RELEASE")
 312                 add_custom_target(populate
 313                         COMMAND mkdir -p ${PACKAGE_BINDIR} ${PACKAGE_ETCDIR} ${PACKAGE_LIBDIR} ${PACKAGE_HTTPDIR} ${PACKAGE_DATADIR}
 314                         COMMAND mkdir -p ${PACKAGE_TEST_BINDIR} ${PACKAGE_TEST_ETCDIR} ${PACKAGE_TEST_LIBDIR} ${PACKAGE_TEST_HTTPDIR} ${PACKAGE_TEST_DATADIR})
 315         else()
 316                 add_custom_target(populate
 317                         COMMAND mkdir -p ${PACKAGE_BINDIR} ${PACKAGE_ETCDIR} ${PACKAGE_LIBDIR} ${PACKAGE_HTTPDIR} ${PACKAGE_DATADIR})
 318         endif()
 319
 320         # Dirty trick to define a default INSTALL command for app-templates handled
 321         # targets
 322         INSTALL(CODE "execute_process(COMMAND make populate)")
 323         if(NO_DEDICATED_INSTALL_DIR)
 324                 INSTALL(DIRECTORY ${PROJECT_PKG_BUILD_DIR}/
 325                         DESTINATION ${CMAKE_INSTALL_PREFIX}
 326                 )
 327         else()
 328                 INSTALL(DIRECTORY ${PROJECT_PKG_BUILD_DIR}/
 329                         DESTINATION ${CMAKE_INSTALL_PREFIX}/${PROJECT_NAME}
 330                 )
 331         endif()
 332
 333         get_property(PROJECT_TARGETS GLOBAL PROPERTY PROJECT_TARGETS)
 334         foreach(TARGET ${PROJECT_TARGETS})
 335                 # Declaration of a custom command that will populate widget tree with the target
 336                 set(POPULE_PACKAGE_TARGET "project_populate_${TARGET}")
 337                 get_target_property(T ${TARGET} LABELS)
 338
 339                 if(T)
 340                         get_target_property(P ${TARGET} PREFIX)
 341                         get_target_property(S ${TARGET} SUFFIX)
 342                         get_target_property(BD ${TARGET} BINARY_DIR)
 343                         get_target_property(SD ${TARGET} SOURCE_DIR)
 344                         get_target_property(OUT ${TARGET} OUTPUT_NAME)
 345
 346                         if(P MATCHES "NOTFOUND$")
 347                                 if (${T} STREQUAL "LIBRARY")
 348                                         set(P "lib")
 349                                 else()
 350                                         set(P "")
 351                                 endif()
 352                         endif()
 353
 354                         get_target_property(IMPPATH ${TARGET} IMPORTED_LOCATION)
 355                         if(${T} STREQUAL "LIBRARY")
 356                                 unset(BD)
 357                                 generate_one_populate_target(${IMPPATH} ${PACKAGE_LIBDIR})
 358                         elseif(${T} STREQUAL "TEST-LIBRARY")
 359                                 unset(BD)
 360                                 generate_one_populate_target(${IMPPATH} ${PACKAGE_TEST_LIBDIR})
 361                         elseif(${T} STREQUAL "PLUGIN")
 362                                 if(NOT S)
 363                                         set(S ".ctlso")
 364                                 endif()
 365                                 generate_one_populate_target(${P}${OUT}${S} "${PACKAGE_LIBDIR}/plugins")
 366                         elseif(NOT ${CMAKE_BUILD_TYPE} STREQUAL "RELEASE" AND ${T} STREQUAL "TEST-PLUGIN")
 367                                 if(NOT S)
 368                                         set(S ".ctlso")
 369                                 endif()
 370                                 generate_one_populate_target(${P}${OUT}${S} "${PACKAGE_TEST_LIBDIR}/plugins")
 371                         elseif(${T} STREQUAL "BINDING")
 372                                 if(NOT S)
 373                                         set(S ".so")
 374                                 endif()
 375                                 list(APPEND BINDINGS_LIST "${P}${OUT}${S}")
 376                                 generate_one_populate_target(${P}${OUT}${S} ${PACKAGE_LIBDIR})
 377                         elseif(${T} STREQUAL "BINDINGV2")
 378                                 if(NOT S)
 379                                         set(S ".so")
 380                                 endif()
 381                                 afb_genskel("-2")
 382                                 generate_one_populate_target(${P}${OUT}${S} ${PACKAGE_LIBDIR})
 383                         elseif(${T} STREQUAL "BINDINGV3")
 384                                 if(NOT S)
 385                                         set(S ".so")
 386                                 endif()
 387                                 afb_genskel("-3")
 388                                 generate_one_populate_target(${P}${OUT}${S} ${PACKAGE_LIBDIR})
 389                         elseif(${T} STREQUAL "EXECUTABLE")
 390                                 if(NOT S)
 391                                         set(S "")
 392                                 endif()
 393                                 if(NOT OUT AND IMPPATH)
 394                                         unset(BD)
 395                                         generate_one_populate_target(${IMPPATH} ${PACKAGE_BINDIR})
 396                                 else()
 397                                         generate_one_populate_target(${P}${OUT}${S} ${PACKAGE_BINDIR})
 398                                 endif()
 399                         elseif(NOT ${CMAKE_BUILD_TYPE} STREQUAL "RELEASE" AND ${T} STREQUAL "TEST-EXECUTABLE")
 400                                 if(NOT S)
 401                                         set(S "")
 402                                 endif()
 403                                 if(NOT OUT AND IMPPATH)
 404                                         unset(BD)
 405                                         generate_one_populate_target(${IMPPATH} ${PACKAGE_TEST_BINDIR})
 406                                 else()
 407                                         generate_one_populate_target(${P}${OUT}${S} ${PACKAGE_TEST_BINDIR})
 408                                 endif()
 409                         elseif(${T} STREQUAL "HTDOCS")
 410                                 generate_one_populate_target(${P}${OUT} ${PACKAGE_HTTPDIR})
 411                         elseif(NOT ${CMAKE_BUILD_TYPE} STREQUAL "RELEASE" AND ${T} STREQUAL "TEST-HTDOCS")
 412                                 generate_one_populate_target(${P}${OUT} ${PACKAGE_HTTPDIR})
 413                         elseif(${T} STREQUAL "DATA" )
 414                                 generate_one_populate_target(${TARGET} ${PACKAGE_DATADIR})
 415                         elseif(NOT ${CMAKE_BUILD_TYPE} STREQUAL "RELEASE" AND ${T} STREQUAL "TEST-DATA")
 416                                 generate_one_populate_target(${TARGET} ${PACKAGE_TEST_DATADIR})
 417                         elseif(${T} STREQUAL "BINDING-CONFIG" )
 418                                 generate_one_populate_target(${TARGET} ${PACKAGE_ETCDIR})
 419                         elseif(NOT ${CMAKE_BUILD_TYPE} STREQUAL "RELEASE" AND ${T} STREQUAL "TEST-CONFIG")
 420                                 generate_one_populate_target(${TARGET} ${PACKAGE_TEST_ETCDIR})
 421                         endif()
 422                         elseif(${CMAKE_BUILD_TYPE} MATCHES "[Dd][Ee][Bb][Uu][Gg]")
 423                                 MESSAGE("${Yellow}.. Warning: ${TARGET} ignored when packaging.${ColourReset}")
 424                 endif()
 425         endforeach()
 426 endmacro(project_targets_populate)
 427
 428 macro(remote_targets_populate)
 429         if (DEFINED ENV{RSYNC_TARGET})
 430                 set (RSYNC_TARGET $ENV{RSYNC_TARGET})
 431         endif()
 432         if (DEFINED ENV{RSYNC_PREFIX})
 433                 set (RSYNC_PREFIX $ENV{RSYNC_PREFIX})
 434         endif()
 435
 436         set(
 437                 REMOTE_LAUNCH "Test on target with: ${CMAKE_CURRENT_BINARY_DIR}/target/start-on-${RSYNC_TARGET}.sh"
 438                 CACHE STRING "Command to start ${PROJECT_NAME} on remote target ${RSYNC_TARGET}"
 439         )
 440
 441         if(NOT RSYNC_TARGET OR NOT RSYNC_PREFIX)
 442                 message ("${Yellow}.. Warning: RSYNC_TARGET RSYNC_PREFIX not defined 'make remote-target-populate' not instanciated${ColourReset}")
 443                 add_custom_target(remote-target-populate
 444                         COMMENT "${Red}*** Fatal: RSYNC_TARGET RSYNC_PREFIX environment variables required with 'make remote-target-populate'${ColourReset}"
 445                         COMMAND exit -1
 446                 )
 447         else()
 448                 set(BINDINGS_REGEX "not_set")
 449                 if(DEFINED BINDINGS_LIST)
 450                         list(LENGTH BINDINGS_LIST BINDINGS_LIST_LENGTH)
 451                         if(BINDINGS_LIST_LENGTH EQUAL 1)
 452                                 list(GET BINDINGS_LIST 0 BINDINGS_REGEX)
 453                                 string(APPEND BINDINGS_REGEX ".so")
 454                         elseif(BINDINGS_LIST_LENGTH GREATER 1)
 455                                 foreach(B IN LISTS BINDINGS_LIST)
 456                                         STRING(APPEND BINDINGS_STR "${B}|")
 457                                 endforeach()
 458                                         STRING(REGEX REPLACE "^(.*)\\|$" "(\\1).so" BINDINGS_REGEX ${BINDINGS_STR})
 459                         endif()
 460                 endif()
 461
 462                 configure_files_in_dir(${TEMPLATE_DIR})
 463                 configure_files_in_dir(${TEMPLATE_DIR})
 464
 465                 add_custom_target(remote-target-populate
 466                         COMMAND chmod +x ${CMAKE_CURRENT_BINARY_DIR}/target/*.sh
 467                         COMMAND rsync -e "ssh -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null" --archive --delete ${PROJECT_PKG_BUILD_DIR}/ ${RSYNC_TARGET}:${RSYNC_PREFIX}/${PROJECT_NAME}
 468                 )
 469
 470                 add_custom_command(TARGET remote-target-populate
 471                 POST_BUILD
 472                 COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --green --bold ${REMOTE_LAUNCH}
 473                 )
 474
 475                 add_dependencies(remote-target-populate populate)
 476         endif()
 477 endmacro(remote_targets_populate)
 478
 479 macro(wgt_package_build)
 480         if(NOT EXISTS ${WIDGET_CONFIG_TEMPLATE})
 481                 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}")
 482         endif()
 483         if(NOT WIDGET_TYPE)
 484                 MESSAGE(FATAL_ERROR "WIDGET_TYPE must be set in your config.cmake.\neg.: set(WIDGET_TYPE application/vnd.agl.service)")
 485         endif()
 486         if(NOT DEFINED PROJECT_ICON)
 487                 if( ${WIDGET_TYPE} MATCHES "agl.native")
 488                         set(ICON_PATH ${PKG_APP_TEMPLATE_DIR}/wgt/icon-native.png)
 489                 elseif( ${WIDGET_TYPE} MATCHES "agl.service")
 490                         set(ICON_PATH ${PKG_APP_TEMPLATE_DIR}/wgt/icon-service.png)
 491                 elseif( ${WIDGET_TYPE} MATCHES "x-executable")
 492                         set(ICON_PATH ${PKG_APP_TEMPLATE_DIR}/wgt/icon-qml.png)
 493                 elseif( ${WIDGET_TYPE} MATCHES "text/html")
 494                         set(ICON_PATH ${PKG_APP_TEMPLATE_DIR}/wgt/icon-html5.png)
 495                 endif()
 496         elseif(EXISTS "${CMAKE_SOURCE_DIR}/${WIDGET_ICON}")
 497                 set(ICON_PATH "${CMAKE_SOURCE_DIR}/${WIDGET_ICON}")
 498         elseif(EXISTS "${WIDGET_ICON}")
 499                 set(ICON_PATH "${WIDGET_ICON}")
 500         else()
 501                 set(ICON_PATH ${CMAKE_SOURCE_DIR}/${PROJECT_APP_TEMPLATES_DIR}/wgt/icon-default.png)
 502         endif()
 503
 504         if(NOT WIDGET_ENTRY_POINT)
 505                 set(WIDGET_ENTRY_POINT lib)
 506         endif()
 507
 508         add_custom_command(OUTPUT ${PROJECT_PKG_BUILD_DIR}/config.xml
 509                 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
 510                 COMMAND cp ${ICON_PATH} ${PROJECT_PKG_BUILD_DIR}/${PROJECT_ICON}
 511         )
 512         add_custom_command(OUTPUT ${PROJECT_PKG_TEST_DIR}/test-config.xml ${PROJECT_PKG_TEST_DIR}/bin/launcher
 513                 COMMAND ${CMAKE_COMMAND} -DINFILE=${CMAKE_SOURCE_DIR}/${PROJECT_APP_TEMPLATES_DIR}/test-widget/test-config.xml.in -DOUTFILE=${PROJECT_PKG_TEST_DIR}/config.xml -DPROJECT_BINARY_DIR=${CMAKE_CURRENT_BINARY_DIR} -P ${CMAKE_CURRENT_SOURCE_DIR}/${PROJECT_APP_TEMPLATES_DIR}/cmake/configure_file.cmake
 514                 COMMAND cp ${ICON_PATH} ${PROJECT_PKG_TEST_DIR}/${PROJECT_ICON}
 515                 COMMAND cp ${CMAKE_SOURCE_DIR}/${PROJECT_APP_TEMPLATES_DIR}//test-widget/launcher.sh.in ${PROJECT_PKG_TEST_DIR}/bin/launcher
 516         )
 517
 518         if(NOT ${CMAKE_BUILD_TYPE} STREQUAL "RELEASE")
 519                 string(TOLOWER "${PROJECT_NAME}-${CMAKE_BUILD_TYPE}" WGT_NAME)
 520                 add_custom_target(packaging_wgt DEPENDS ${PROJECT_PKG_BUILD_DIR}/config.xml ${PROJECT_PKG_TEST_DIR}/test-config.xml ${PROJECT_PKG_TEST_DIR}/bin/launcher)
 521         else()
 522                 string(TOLOWER "${PROJECT_NAME}" WGT_NAME)
 523                 add_custom_target(packaging_wgt DEPENDS ${PROJECT_PKG_BUILD_DIR}/config.xml)
 524         endif()
 525
 526         # Fulup ??? copy any extra file in wgt/etc into populate package before building the widget
 527         file(GLOB PROJECT_CONF_FILES "${TEMPLATE_DIR}/etc/*")
 528         if(${PROJECT_CONF_FILES})
 529                 file(COPY "${TEMPLATE_DIR}/etc/*" DESTINATION ${PROJECT_PKG_BUILD_DIR}/etc/)
 530         endif(${PROJECT_CONF_FILES})
 531
 532         find_program(wgtpkgCMD "wgtpkg-pack")
 533         if(wgtpkgCMD)
 534                 set(packCMD ${wgtpkgCMD} "-f" "-o" "${WGT_NAME}.wgt" ${PROJECT_PKG_BUILD_DIR})
 535                 set(packCMDTest ${wgtpkgCMD} "-f" "-o" "${WGT_NAME}-test.wgt" ${PROJECT_PKG_TEST_DIR})
 536         else()
 537                 find_program(wgtpkgCMD "zip")
 538                 if(wgtpkgCMD)
 539                         set(packCMD ${CMAKE_COMMAND} -E cmake_echo_color --yellow "Warning: Widget will be built using Zip, NOT using the Application Framework widget pack command." && cd ${PROJECT_PKG_BUILD_DIR} && ${wgtpkgCMD} "../${WGT_NAME}.wgt" "*")
 540                         set(packCMDTest ${CMAKE_COMMAND} -E cmake_echo_color --yellow "Warning: Test widget will be built using Zip, NOT using the Application Framework widget pack command." && cd ${PROJECT_PKG_TEST_DIR} && ${wgtpkgCMD} "../${WGT_NAME}-test.wgt" "*")
 541                 else()
 542                         set(packCMD ${CMAKE_COMMAND} -E cmake_echo_color --red "Error: No utility found to build a widget. Either install wgtpkg-pack from App Framework or zip command")
 543                 endif()
 544         endif()
 545
 546         add_custom_command(OUTPUT ${WGT_NAME}.wgt
 547                 DEPENDS ${PROJECT_TARGETS}
 548                 COMMAND ${packCMD}
 549         )
 550
 551         add_custom_command(OUTPUT ${WGT_NAME}-test.wgt
 552                 DEPENDS ${PROJECT_TARGETS}
 553                 COMMAND ${packCMDTest}
 554         )
 555
 556         PROJECT_HAS_TESTS()
 557         if(NOT ${CMAKE_BUILD_TYPE} STREQUAL "RELEASE" AND HAS_TESTS)
 558                 add_custom_target(widget DEPENDS ${WGT_NAME}.wgt ${WGT_NAME}-test.wgt)
 559                 set_property(DIRECTORY APPEND PROPERTY ADDITIONAL_MAKE_CLEAN_FILES "${CMAKE_CURRENT_BINARY_DIR}/${WGT_NAME}-test.wgt")
 560         else()
 561                 add_custom_target(widget DEPENDS ${WGT_NAME}.wgt)
 562         endif()
 563
 564         add_dependencies(widget populate packaging_wgt)
 565         set_property(DIRECTORY APPEND PROPERTY ADDITIONAL_MAKE_CLEAN_FILES "${CMAKE_CURRENT_BINARY_DIR}/${WGT_NAME}.wgt")
 566
 567         if(NOT RSYNC_TARGET)
 568                 message ("${Yellow}.. Warning: RSYNC_TARGET not defined 'make widget-target-install' not instanciated${ColourReset}")
 569                 add_custom_target(widget-target-install
 570                         COMMENT "${Red}*** Fatal: RSYNC_TARGET RSYNC_PREFIX environment variables required with 'make widget-target-install'${ColourReset}"
 571                         COMMAND exit -1
 572                 )
 573         else()
 574                 configure_files_in_dir(${TEMPLATE_DIR})
 575                 add_custom_target(widget-target-install
 576                         DEPENDS widget
 577                         COMMAND chmod +x ${CMAKE_CURRENT_BINARY_DIR}/target/install-wgt-on-${RSYNC_TARGET}.sh
 578                         COMMAND ${CMAKE_CURRENT_BINARY_DIR}/target/install-wgt-on-${RSYNC_TARGET}.sh
 579                 )
 580         endif()
 581
 582         if(PACKAGE_MESSAGE)
 583         add_custom_command(TARGET widget
 584                 POST_BUILD
 585                 COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --cyan "++ ${PACKAGE_MESSAGE}")
 586         endif()
 587 endmacro(wgt_package_build)
 588
 589 macro(rpm_package_build)
 590         add_custom_command(OUTPUT ${NPKG_PROJECT_NAME}.spec
 591                 DEPENDS ${PROJECT_TARGETS}
 592                                 archive
 593                                 packaging
 594                 COMMAND rpmbuild --define=\"%_sourcedir ${PROJECT_PKG_ENTRY_POINT}\" -ba  ${PROJECT_PKG_ENTRY_POINT}/${NPKG_PROJECT_NAME}.spec
 595         )
 596
 597         add_custom_target(rpm DEPENDS ${NPKG_PROJECT_NAME}.spec)
 598         add_dependencies(rpm populate packaging)
 599
 600         if(PACKAGE_MESSAGE)
 601         add_custom_command(TARGET rpm
 602                 POST_BUILD
 603                 COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --cyan "++ ${PACKAGE_MESSAGE}")
 604         endif()
 605 endmacro(rpm_package_build)
 606
 607 macro(project_package_build)
 608         if(EXISTS ${TEMPLATE_DIR})
 609                 wgt_package_build()
 610         endif()
 611 endmacro(project_package_build)
 612
 613 macro(project_subdirs_add)
 614         set (ARGSLIST ${ARGN})
 615         list(LENGTH ARGSLIST ARGSNUM)
 616         if(${ARGSNUM} GREATER 0)
 617                 file(GLOB filelist "${ARGV0}")
 618         else()
 619         file(GLOB filelist "*")
 620         endif()
 621
 622         foreach(filename ${filelist})
 623                 if(EXISTS "${filename}/CMakeLists.txt")
 624                         add_subdirectory(${filename})
 625                 elseif(${filename} MATCHES "^.*\\.cmake$")
 626                         include(${filename})
 627                 endif(EXISTS "${filename}/CMakeLists.txt")
 628         endforeach()
 629 endmacro(project_subdirs_add)
 630
 631 # Print developer helper message when build is done
 632 # -------------------------------------------------------
 633 macro(project_closing_msg)
 634         get_property(PROJECT_TARGETS_SET GLOBAL PROPERTY PROJECT_TARGETS SET)
 635         get_property(PROJECT_TARGETS GLOBAL PROPERTY PROJECT_TARGETS)
 636         if(CLOSING_MESSAGE AND ${PROJECT_TARGETS_SET})
 637                 add_custom_target(${PROJECT_NAME}_build_done ALL
 638                         COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --cyan "++ ${CLOSING_MESSAGE}"
 639                 )
 640                 add_dependencies(${PROJECT_NAME}_build_done
 641                         ${PROJECT_TARGETS} populate)
 642         endif()
 643 endmacro()
 644
 645 macro(check_version)
 646         if(GIT_PROJECT_VERSION)
 647                 if(${GIT_PROJECT_VERSION} VERSION_GREATER ${APP_TEMPLATES_VERSION})
 648                         message(STATUS "${Yellow}.. Your app-templates submodule version seems outdated. You should update it with 'git submodule update --remote ${PROJECT_APP_TEMPLATES_DIR}'.
 649                 - App-templates version: ${APP_TEMPLATES_VERSION}
 650                 - Project version according AGL Git tag: ${GIT_PROJECT_VERSION}"
 651                 )
 652                 endif()
 653         elseif(PROJECT_VERSION)
 654                 if(${PROJECT_VERSION} VERSION_GREATER ${APP_TEMPLATES_VERSION})
 655                         message(STATUS "${Yellow}.. Your app-templates submodule version seems outdated. You should update it with 'git submodule update --remote ${PROJECT_APP_TEMPLATES_DIR}'.
 656                 - App-templates version: ${APP_TEMPLATES_VERSION}
 657                 - Project version according AGL Git tag: ${PROJECT_VERSION}"
 658                 )
 659                 endif()
 660         else()
 661                 message(STATUS "${Yellow} Your git project repo doesn't have any version tags nor hosted by AGL gerrit infrastructure. Can't compare version between project and app-templates ${APP_TEMPLATES_VERSION} ${ColourReset}")
 662         endif()
 663 endmacro()