Disallow build in-source.
[staging/xdg-launcher.git] / cmake / cmake.d / 03-macros.cmake
index 0bab354..bf297a2 100644 (file)
 #     Customise your preferences in "./conf.d/cmake/config.cmake"
 #--------------------------------------------------------------------------
 # CMake 3.6 imported macros to simulate list(FILTER ...) subcommand
-# -----------------------
+#--------------------------------------------------------------------------
+MACRO(prevent_in_source_build)
+       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)
+
+       get_filename_component(srcdir "${CMAKE_SOURCE_DIR}" REALPATH)
+       get_filename_component(bindir "${CMAKE_BINARY_DIR}" REALPATH)
+
+       if(${srcdir} STREQUAL ${bindir})
+               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")
+       endif()
+ENDMACRO(prevent_in_source_build)
+
 MACRO(PARSE_ARGUMENTS prefix arg_names option_names)
-SET(DEFAULT_ARGS)
-FOREACH(arg_name ${arg_names})
-  SET(${prefix}_${arg_name})
-ENDFOREACH(arg_name)
-FOREACH(option ${option_names})
-  SET(${prefix}_${option} FALSE)
-ENDFOREACH(option)
-
-SET(current_arg_name DEFAULT_ARGS)
-SET(current_arg_list)
-FOREACH(arg ${ARGN})
-  LIST_CONTAINS(is_arg_name ${arg} ${arg_names})
-  IF (is_arg_name)
-       SET(${prefix}_${current_arg_name} ${current_arg_list})
-       SET(current_arg_name ${arg})
+       SET(DEFAULT_ARGS)
+       FOREACH(arg_name ${arg_names})
+       SET(${prefix}_${arg_name})
+       ENDFOREACH(arg_name)
+       FOREACH(option ${option_names})
+       SET(${prefix}_${option} FALSE)
+       ENDFOREACH(option)
+
+       SET(current_arg_name DEFAULT_ARGS)
        SET(current_arg_list)
-  ELSE (is_arg_name)
-       LIST_CONTAINS(is_option ${arg} ${option_names})
-       IF (is_option)
-  SET(${prefix}_${arg} TRUE)
-       ELSE (is_option)
-  SET(current_arg_list ${current_arg_list} ${arg})
-       ENDIF (is_option)
-  ENDIF (is_arg_name)
-ENDFOREACH(arg)
-SET(${prefix}_${current_arg_name} ${current_arg_list})
+       FOREACH(arg ${ARGN})
+       LIST_CONTAINS(is_arg_name ${arg} ${arg_names})
+       IF (is_arg_name)
+               SET(${prefix}_${current_arg_name} ${current_arg_list})
+               SET(current_arg_name ${arg})
+               SET(current_arg_list)
+       ELSE (is_arg_name)
+               LIST_CONTAINS(is_option ${arg} ${option_names})
+               IF (is_option)
+       SET(${prefix}_${arg} TRUE)
+               ELSE (is_option)
+       SET(current_arg_list ${current_arg_list} ${arg})
+               ENDIF (is_option)
+       ENDIF (is_arg_name)
+       ENDFOREACH(arg)
+       SET(${prefix}_${current_arg_name} ${current_arg_list})
 ENDMACRO(PARSE_ARGUMENTS)
 
 MACRO(LIST_CONTAINS var value)
@@ -121,31 +132,37 @@ macro(configure_files_in_dir dir)
        endforeach()
 endmacro(configure_files_in_dir)
 
-macro(add_required_module PKG_CONFIG)
-       string(REGEX REPLACE "[<>]?=.*$" "" XPREFIX ${PKG_CONFIG})
-       PKG_CHECK_MODULES(${XPREFIX} REQUIRED ${PKG_CONFIG})
-
-       INCLUDE_DIRECTORIES(${${XPREFIX}_INCLUDE_DIRS})
-       list(APPEND link_libraries ${${XPREFIX}_LDFLAGS})
-       add_compile_options (${${XPREFIX}_CFLAGS})
-endmacro(add_required_module)
-
 # Create custom target dedicated for HTML5 and DATA AGL target type
 macro(add_input_files INPUT_FILES)
        if(NOT DEFINED XML_FILES)
                set(ext_reg "xml$")
                set(XML_LIST ${INPUT_FILES})
                list_filter(XML_LIST ext_reg)
+               execute_process(
+                       COMMAND which ${XML_CHECKER}
+                       RESULT_VARIABLE XML_CHECKER_PRESENT
+                       OUTPUT_QUIET ERROR_QUIET
+               )
        endif()
        if(NOT DEFINED LUA_LIST)
                set(ext_reg "lua$")
                set(LUA_LIST ${INPUT_FILES})
                list_filter(LUA_LIST ext_reg)
+               execute_process(
+                       COMMAND which ${LUA_CHECKER}
+                       RESULT_VARIABLE LUA_CHECKER_PRESENT
+                       OUTPUT_QUIET ERROR_QUIET
+               )
        endif()
        if(NOT DEFINED JSON_FILES)
                set(ext_reg "json$")
                set(JSON_LIST ${INPUT_FILES})
                list_filter(JSON_LIST ext_reg)
+               execute_process(
+                       COMMAND which ${JSON_CHECKER}
+                       RESULT_VARIABLE JSON_CHECKER_PRESENT
+                       OUTPUT_QUIET ERROR_QUIET
+               )
        endif()
 
        # These are v3.6 subcommand. Not used as default for now as
@@ -154,31 +171,52 @@ macro(add_input_files INPUT_FILES)
        #list(FILTER LUA_LIST INCLUDE REGEX "lua$")
        #list(FILTER JSON_LIST INCLUDE REGEX "json$")
 
-       add_custom_target(${TARGET_NAME}
+       add_custom_target(${TARGET_NAME} ALL
        DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME}
        )
 
-       foreach(file ${XML_LIST})
+       if(XML_CHECKER_PRESENT EQUAL 0)
+               foreach(file ${XML_LIST})
+                       add_custom_command(TARGET ${TARGET_NAME}
+                               PRE_BUILD
+                               WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+                               COMMAND ${XML_CHECKER} ${file}
+                       )
+               endforeach()
+       elseif(XML_LIST)
+       add_custom_command(TARGET ${TARGET_NAME}
+       PRE_BUILD
+       WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+       COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --red "Warning: XML_CHECKER not found. Not verification made on files !")
+       endif()
+       if(LUA_CHECKER_PRESENT EQUAL 0)
+               foreach(file ${LUA_LIST})
                add_custom_command(TARGET ${TARGET_NAME}
                        PRE_BUILD
                        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-                       COMMAND ${XML_CHECKER} ${file}
+                       COMMAND ${LUA_CHECKER} ${file}
                )
-       endforeach()
-       foreach(file ${LUA_LIST})
-       add_custom_command(TARGET ${TARGET_NAME}
-               PRE_BUILD
-               WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-               COMMAND ${LUA_CHECKER} ${file}
-       )
-       endforeach()
-       foreach(file ${JSON_LIST})
+               endforeach()
+       elseif(LUA_LIST)
+               add_custom_command(TARGET ${TARGET_NAME}
+                       PRE_BUILD
+                       WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+                       COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --red "Warning: LUA_CHECKER not found. Not verification made on files !")
+       endif()
+       if(JSON_CHECKER_PRESENT EQUAL 0)
+               foreach(file ${JSON_LIST})
+               add_custom_command(TARGET ${TARGET_NAME}
+                       PRE_BUILD
+                       WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+                       COMMAND ${JSON_CHECKER} ${file}
+               )
+               endforeach()
+       elseif(JSON_LIST)
        add_custom_command(TARGET ${TARGET_NAME}
-               PRE_BUILD
-               WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-               COMMAND cat ${file} | ${JSON_CHECKER}
-       )
-       endforeach()
+       PRE_BUILD
+       WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+       COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --red "Warning: JSON_CHECKER not found. Not verification made on files !")
+       endif()
 
        add_custom_command(OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME}
        DEPENDS ${INPUT_FILES}
@@ -193,6 +231,41 @@ macro(set_openapi_filename openapi_filename)
        set(OPENAPI_DEF ${openapi_filename} CACHE STRING "OpenAPI JSON file name used to generate binding header file before building a binding v2 target.")
 endmacro()
 
+# Common command to call inside project_targets_populate macro
+macro(generate_one_populate_target OUTPUTFILES PKG_DESTDIR)
+       add_custom_command(OUTPUT ${PKG_DESTDIR}/${OUTPUTFILES}
+               DEPENDS ${BD}/${OUTPUTFILES}
+               COMMAND mkdir -p ${PKG_DESTDIR}
+               COMMAND touch ${PKG_DESTDIR}
+               COMMAND cp -r ${BD}/${OUTPUTFILES}/* ${PKG_DESTDIR} 2> /dev/null || cp ${BD}/${OUTPUTFILES} ${PKG_DESTDIR}
+       )
+
+       add_custom_target(${POPULE_PACKAGE_TARGET} DEPENDS ${PKG_DESTDIR}/${OUTPUTFILES})
+       add_dependencies(populate ${POPULE_PACKAGE_TARGET})
+       add_dependencies(${POPULE_PACKAGE_TARGET} ${TARGET})
+endmacro()
+
+# To be call inside project_targets_populate macro
+macro(afb_genskel)
+       if (OPENAPI_DEF)
+               add_custom_command(OUTPUT ${SD}/${OPENAPI_DEF}.h
+                       DEPENDS ${SD}/${OPENAPI_DEF}.json
+                       COMMAND afb-genskel ${SD}/${OPENAPI_DEF}.json > ${SD}/${OPENAPI_DEF}.h
+               )
+               add_custom_target("${TARGET}_GENSKEL" DEPENDS ${SD}/${OPENAPI_DEF}.h
+                       COMMENT "Generating OpenAPI header file ${OPENAPI_DEF}.h")
+               add_dependencies(${TARGET} "${TARGET}_GENSKEL")
+       else()
+               add_custom_command(OUTPUT ${SD}/${OUT}-apidef.h
+                       DEPENDS ${SD}/${OUT}-apidef.json
+                       COMMAND afb-genskel ${SD}/${OUT}-apidef.json > ${SD}/${OUT}-apidef.h
+               )
+               add_custom_target("${TARGET}_GENSKEL" DEPENDS ${SD}/${OUT}-apidef.h
+                       COMMENT "Generating OpenAPI header file ${OUT}-apidef.h")
+               add_dependencies(${TARGET} "${TARGET}_GENSKEL")
+       endif()
+endmacro()
+
 # Pre-packaging
 macro(project_targets_populate)
        # Default Widget default directory
@@ -211,106 +284,80 @@ macro(project_targets_populate)
                COMMAND mkdir -p ${PACKAGE_BINDIR} ${PACKAGE_ETCDIR} ${PACKAGE_LIBDIR} ${PACKAGE_HTTPDIR} ${PACKAGE_DATADIR})
        add_custom_target(populate DEPENDS ${PACKAGE_BINDIR} ${PACKAGE_ETCDIR} ${PACKAGE_LIBDIR} ${PACKAGE_HTTPDIR} ${PACKAGE_DATADIR})
 
+       # Dirty trick to define a default INSTALL command for app-templates handled
+       # targets
        INSTALL(CODE "execute_process(COMMAND make populate)")
-       INSTALL(DIRECTORY ${PROJECT_PKG_BUILD_DIR}/
-               DESTINATION ${CMAKE_INSTALL_PREFIX}/${PROJECT_NAME}
-       )
+       if(NO_DEDICATED_INSTALL_DIR)
+               INSTALL(DIRECTORY ${PROJECT_PKG_BUILD_DIR}/
+                       DESTINATION ${CMAKE_INSTALL_PREFIX}
+               )
+       else()
+               INSTALL(DIRECTORY ${PROJECT_PKG_BUILD_DIR}/
+                       DESTINATION ${CMAKE_INSTALL_PREFIX}/${PROJECT_NAME}
+               )
+       endif()
 
        get_property(PROJECT_TARGETS GLOBAL PROPERTY PROJECT_TARGETS)
        foreach(TARGET ${PROJECT_TARGETS})
-       get_target_property(T ${TARGET} LABELS)
-       if(T)
                # Declaration of a custom command that will populate widget tree with the target
                set(POPULE_PACKAGE_TARGET "project_populate_${TARGET}")
-
-               get_target_property(P ${TARGET} PREFIX)
-               get_target_property(BD ${TARGET} BINARY_DIR)
-               get_target_property(SD ${TARGET} SOURCE_DIR)
-               get_target_property(OUT ${TARGET} OUTPUT_NAME)
-
-               if(P MATCHES "NOTFOUND$")
-                       if (${T} STREQUAL "BINDING")
-                               set(P "lib")
-                       else()
-                               set(P "")
+               get_target_property(T ${TARGET} LABELS)
+
+               if(T)
+                       get_target_property(P ${TARGET} PREFIX)
+                       get_target_property(S ${TARGET} SUFFIX)
+                       get_target_property(BD ${TARGET} BINARY_DIR)
+                       get_target_property(SD ${TARGET} SOURCE_DIR)
+                       get_target_property(OUT ${TARGET} OUTPUT_NAME)
+
+                       if(P MATCHES "NOTFOUND$")
+                               if (${T} STREQUAL "LIBRARY")
+                                       set(P "lib")
+                               else()
+                                       set(P "")
+                               endif()
                        endif()
-               endif()
 
-               if(${T} STREQUAL "BINDING")
-                       list(APPEND BINDINGS_LIST "${P}${OUT}")
-                       add_custom_command(OUTPUT ${PACKAGE_LIBDIR}/${P}${OUT}.so
-                               DEPENDS ${BD}/${P}${OUT}.so
-                               COMMAND mkdir -p ${PACKAGE_LIBDIR}
-                               COMMAND cp ${BD}/${P}${OUT}.so ${PACKAGE_LIBDIR}
-                       )
-                       add_custom_target(${POPULE_PACKAGE_TARGET} DEPENDS ${PACKAGE_LIBDIR}/${P}${OUT}.so)
-                       add_dependencies(populate ${POPULE_PACKAGE_TARGET})
-                       add_dependencies(${POPULE_PACKAGE_TARGET} ${TARGET})
-               elseif(${T} STREQUAL "BINDINGV2")
-                       if (OPENAPI_DEF)
-                               add_custom_command(OUTPUT ${SD}/${OPENAPI_DEF}.h
-                                       DEPENDS ${SD}/${OPENAPI_DEF}.json
-                                       COMMAND afb-genskel ${SD}/${OPENAPI_DEF}.json > ${SD}/${OPENAPI_DEF}.h
-                               )
-                               add_custom_target("${TARGET}_GENSKEL" DEPENDS ${SD}/${OPENAPI_DEF}.h
-                                       COMMENT "Generating OpenAPI header file ${OPENAPI_DEF}.h")
-                               add_dependencies(${TARGET} "${TARGET}_GENSKEL")
-                       else()
-                               add_custom_command(OUTPUT ${SD}/${OUT}-apidef.h
-                                       DEPENDS ${SD}/${OUT}-apidef.json
-                                       COMMAND afb-genskel ${SD}/${OUT}-apidef.json > ${SD}/${OUT}-apidef.h
-                               )
-                               add_custom_target("${TARGET}_GENSKEL" DEPENDS ${SD}/${OUT}-apidef.h
-                                       COMMENT "Generating OpenAPI header file ${OUT}-apidef.h")
-                               add_dependencies(${TARGET} "${TARGET}_GENSKEL")
+                       get_target_property(IMPPATH ${TARGET} IMPORTED_LOCATION)
+                       if(${T} STREQUAL "LIBRARY")
+                               unset(BD)
+                               generate_one_populate_target(${IMPPATH} ${PACKAGE_LIBDIR})
+                       elseif(${T} STREQUAL "PLUGIN")
+                               if(NOT S)
+                                       set(S ".ctlso")
+                               endif()
+                               generate_one_populate_target(${P}${OUT}${S} "${PACKAGE_LIBDIR}/plugins")
+                       elseif(${T} STREQUAL "BINDING")
+                               if(NOT S)
+                                       set(S ".so")
+                               endif()
+                               list(APPEND BINDINGS_LIST "${P}${OUT}${S}")
+                               generate_one_populate_target(${P}${OUT}${S} ${PACKAGE_LIBDIR})
+                       elseif(${T} STREQUAL "BINDINGV2")
+                               if(NOT S)
+                                       set(S ".so")
+                               endif()
+                               afb_genskel()
+                               generate_one_populate_target(${P}${OUT}${S} ${PACKAGE_LIBDIR})
+                       elseif(${T} STREQUAL "EXECUTABLE")
+                               if(NOT S)
+                                       set(S "")
+                               endif()
+                               if(NOT OUT AND IMPPATH)
+                                       unset(BD)
+                                       generate_one_populate_target(${IMPPATH} ${PACKAGE_BINDIR})
+                               else()
+                                       generate_one_populate_target(${P}${OUT}${S} ${PACKAGE_BINDIR})
+                               endif()
+                       elseif(${T} STREQUAL "HTDOCS")
+                               generate_one_populate_target(${P}${OUT} ${PACKAGE_HTTPDIR})
+                       elseif(${T} STREQUAL "DATA")
+                               generate_one_populate_target(${TARGET} ${PACKAGE_DATADIR})
+                       elseif(${T} STREQUAL "BINDING-CONFIG")
+                               generate_one_populate_target(${TARGET} ${PACKAGE_ETCDIR})
                        endif()
-
-                       add_custom_command(OUTPUT ${PACKAGE_LIBDIR}/${P}${OUT}.so
-                                       DEPENDS ${BD}/${P}${OUT}.so
-                                       COMMAND mkdir -p ${PACKAGE_LIBDIR}
-                                       COMMAND cp ${BD}/${P}${OUT}.so ${PACKAGE_LIBDIR}
-                               )
-                               add_custom_target(${POPULE_PACKAGE_TARGET} DEPENDS ${PACKAGE_LIBDIR}/${P}${OUT}.so)
-                               add_dependencies(populate ${POPULE_PACKAGE_TARGET})
-                               add_dependencies(${POPULE_PACKAGE_TARGET} ${TARGET})
-               elseif(${T} STREQUAL "EXECUTABLE")
-                       add_custom_command(OUTPUT ${PACKAGE_BINDIR}/${P}${OUT}
-                               DEPENDS ${BD}/${P}${OUT}
-                               COMMAND mkdir -p ${PACKAGE_BINDIR}
-                               COMMAND cp ${BD}/${P}${OUT} ${PACKAGE_BINDIR}
-                       )
-                       add_custom_target(${POPULE_PACKAGE_TARGET} DEPENDS ${PACKAGE_BINDIR}/${P}${OUT})
-                       add_dependencies(populate ${POPULE_PACKAGE_TARGET})
-                       add_dependencies(${POPULE_PACKAGE_TARGET} ${TARGET})
-               elseif(${T} STREQUAL "HTDOCS")
-                       add_custom_command(OUTPUT ${PACKAGE_HTTPDIR}-xx
-                               DEPENDS ${BD}/${P}${OUT}
-                               COMMAND mkdir -p ${PACKAGE_HTTPDIR}
-                               COMMAND touch ${PACKAGE_HTTPDIR}
-                               COMMAND cp -r ${BD}/${P}${OUT}/* ${PACKAGE_HTTPDIR}
-                       )
-                       add_custom_target(${POPULE_PACKAGE_TARGET} DEPENDS ${PACKAGE_HTTPDIR}-xx)
-                       add_dependencies(populate ${POPULE_PACKAGE_TARGET})
-                       add_dependencies(${POPULE_PACKAGE_TARGET} ${TARGET})
-               elseif(${T} STREQUAL "DATA")
-                       # Generate list of output files instead of just one output directory
-                       get_target_property(SF ${TARGET} SOURCES)
-                       foreach(file ${SF})
-                               get_filename_component(JUST_FILENAME ${file} NAME)
-                               list(APPEND OUTPUT_FILES ${PACKAGE_DATADIR}/${JUST_FILENAME})
-                       endforeach()
-                       add_custom_target(${POPULE_PACKAGE_TARGET})
-                       add_custom_command(TARGET ${POPULE_PACKAGE_TARGET}
-                               POST_BUILD
-                               COMMAND mkdir -p ${PACKAGE_DATADIR}
-                               COMMAND touch ${PACKAGE_DATADIR}
-                               COMMAND cp -r ${BD}/${TARGET} ${PACKAGE_DATADIR}
-                       )
-                       add_dependencies(populate ${POPULE_PACKAGE_TARGET})
-                       add_dependencies(${POPULE_PACKAGE_TARGET} ${TARGET})
-               endif(${T} STREQUAL "BINDING")
-               elseif(${CMAKE_BUILD_TYPE} MATCHES "[Dd][Ee][Bb][Uu][Gg]")
-                       MESSAGE("${Yellow}.. Warning: ${TARGET} ignored when packaging.${ColourReset}")
+                       elseif(${CMAKE_BUILD_TYPE} MATCHES "[Dd][Ee][Bb][Uu][Gg]")
+                               MESSAGE("${Yellow}.. Warning: ${TARGET} ignored when packaging.${ColourReset}")
                endif()
        endforeach()
 endmacro(project_targets_populate)
@@ -355,8 +402,13 @@ macro(remote_targets_populate)
                add_custom_target(remote-target-populate
                        COMMAND chmod +x ${CMAKE_CURRENT_BINARY_DIR}/target/*.sh
                        COMMAND rsync -e "ssh -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null" --archive --delete ${PROJECT_PKG_BUILD_DIR}/ ${RSYNC_TARGET}:${RSYNC_PREFIX}/${PROJECT_NAME}
-                       COMMENT "${REMOTE_LAUNCH}"
                )
+
+               add_custom_command(TARGET remote-target-populate
+               POST_BUILD
+               COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --green --bold ${REMOTE_LAUNCH}
+               )
+
                add_dependencies(remote-target-populate populate)
        endif()
 endmacro(remote_targets_populate)
@@ -452,22 +504,10 @@ macro(rpm_package_build)
        endif()
 endmacro(rpm_package_build)
 
-macro(deb_package_build)
-#TODO
-endmacro(deb_package_build)
-
 macro(project_package_build)
-       if(EXISTS ${TEMPLATE_DIR})
-               rpm_package_build()
-       endif()
-
        if(EXISTS ${TEMPLATE_DIR})
                wgt_package_build()
        endif()
-
-       if(EXISTS ${TEMPLATE_DIR})
-               deb_package_build()
-       endif()
 endmacro(project_package_build)
 
 macro(project_subdirs_add)