diff --git a/CMakeLists.txt b/CMakeLists.txt index d91e3a6c3b..de2329f6f1 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -25,7 +25,15 @@ set(PNGLIB_VERSION ${PNGLIB_MAJOR}.${PNGLIB_MINOR}.${PNGLIB_REVISION}) set(PNGLIB_ABI_VERSION ${PNGLIB_MAJOR}${PNGLIB_MINOR}) set(PNGLIB_SHARED_VERSION ${PNGLIB_ABI_VERSION}.${PNGLIB_REVISION}.${PNGLIB_SUBREVISION}) -project(libpng +set(CMAKE_ALLOW_LOOSE_LOOP_CONSTRUCTS true) + +include("cmake/HunterGate.cmake") +HunterGate( + URL "https://github.com/cpp-pm/hunter/archive/v0.26.1.tar.gz" + SHA1 "e41ac7a18c49b35ebac99ff2b5244317b2638a65" +) + +project(PNG VERSION ${PNGLIB_VERSION} LANGUAGES C ASM) @@ -33,6 +41,18 @@ include(CheckCSourceCompiles) include(CheckLibraryExists) include(GNUInstallDirs) +set(TARGET_NAME png) + +if(${CMAKE_MAJOR_VERSION} GREATER 3 OR + (${CMAKE_MAJOR_VERSION} EQUAL 3 AND ${CMAKE_MINOR_VERSION} GREATER_EQUAL 12)) + # For CMake >= 3.12, find_package() searches prefixes given by + # _ROOT CMake variable and _ROOT + # environment variable. + cmake_policy(SET CMP0074 NEW) +endif() +hunter_add_package(ZLIB) +find_package(ZLIB CONFIG REQUIRED) + # Allow the users to specify an application-specific API prefix for libpng # vendoring purposes. A standard libpng build should have no such prefix. set(PNG_PREFIX @@ -43,9 +63,11 @@ set(PNG_PREFIX # Previously, we used to set CMAKE_DEBUG_POSTFIX globally. That variable should # not be cached, however, because doing so would affect all projects processed # after libpng, in unexpected and undesirable ways. -set(PNG_DEBUG_POSTFIX - "d" - CACHE STRING "Postfix to append to library file names under the Debug configuration") +if(NOT DEFINED CMAKE_DEBUG_POSTFIX) + set(PNG_DEBUG_POSTFIX + "d" + CACHE STRING "Postfix to append to library file names under the Debug configuration") +endif() # Allow the users to import their own extra configuration settings. # Those settings can be either passed via DFA_XTRA if they are in DFA form @@ -70,10 +92,8 @@ if((NOT DFA_XTRA STREQUAL "") AND (NOT PNG_LIBCONF_HEADER STREQUAL "")) endif() # Allow the users to switch on/off various library build types. -option(PNG_SHARED "Build libpng as a shared library" ON) -option(PNG_STATIC "Build libpng as a static library" ON) if(APPLE) - option(PNG_FRAMEWORK "Build libpng as a framework bundle" ON) + option(PNG_FRAMEWORK "Build libpng as a framework bundle" OFF) else() option(PNG_FRAMEWORK "Build libpng as a framework bundle (not available on this platform)" OFF) endif() @@ -124,27 +144,18 @@ else() endif() message(STATUS "Building for target architecture: ${PNG_TARGET_ARCHITECTURE}") -# Allow the users to specify a custom location of zlib. -# With CMake 3.12 and newer, this option is no longer necessary. -option(PNG_BUILD_ZLIB "[Deprecated; please use ZLIB_ROOT]" OFF) -if(PNG_BUILD_ZLIB) - if("x${ZLIB_ROOT}" STREQUAL "x") - message(SEND_ERROR "The option PNG_BUILD_ZLIB=${PNG_BUILD_ZLIB} is no longer supported; " - "please use ZLIB_ROOT instead") - else() - message(SEND_ERROR "The option PNG_BUILD_ZLIB=${PNG_BUILD_ZLIB} is no longer supported; " - "using ZLIB_ROOT=\"${ZLIB_ROOT}\"") - endif() -endif() - # Find the zlib library. find_package(ZLIB REQUIRED) set(PNG_LINK_LIBRARIES ZLIB::ZLIB) # Find the math library (unless we already know it's not available or # not needed). +set(M_LIBRARY "") if(UNIX AND NOT (APPLE OR BEOS OR HAIKU OR EMSCRIPTEN)) check_library_exists(m pow "" PNG_HAVE_LIBM_POW) + if(LIB_M_REQUIRED) + set(M_LIBRARY m) + endif() endif() if(PNG_HAVE_LIBM_POW) list(APPEND PNG_LINK_LIBRARIES m) @@ -664,60 +675,22 @@ else() set(PNG_STATIC_OUTPUT_NAME "libpng${PNGLIB_ABI_VERSION}_static") endif() -if(PNG_SHARED) - add_library(png_shared SHARED ${libpng_sources}) - add_dependencies(png_shared png_genfiles) - list(APPEND PNG_LIBRARY_TARGETS png_shared) - set_target_properties(png_shared - PROPERTIES OUTPUT_NAME "${PNG_SHARED_OUTPUT_NAME}" - DEBUG_POSTFIX "${PNG_DEBUG_POSTFIX}" - VERSION "${PNGLIB_SHARED_VERSION}" - SOVERSION "${PNGLIB_ABI_VERSION}") - if(UNIX AND AWK) - if(HAVE_LD_VERSION_SCRIPT) - set_target_properties(png_shared - PROPERTIES LINK_FLAGS "-Wl,--version-script='${CMAKE_CURRENT_BINARY_DIR}/libpng.vers'") - elseif(HAVE_SOLARIS_LD_VERSION_SCRIPT) - set_target_properties(png_shared - PROPERTIES LINK_FLAGS "-Wl,-M -Wl,'${CMAKE_CURRENT_BINARY_DIR}/libpng.vers'") - endif() - endif() - if(APPLE) - # Avoid CMake's implicit compile definition "png_shared_EXPORTS". - set_target_properties(png_shared - PROPERTIES DEFINE_SYMBOL "") - elseif(WIN32) - # Use the explicit compile definition "PNG_BUILD_DLL" for Windows DLLs. - set_target_properties(png_shared - PROPERTIES DEFINE_SYMBOL PNG_BUILD_DLL) - endif() - target_include_directories(png_shared - PUBLIC "$") - target_include_directories(png_shared - PUBLIC "$") - target_include_directories(png_shared - SYSTEM - INTERFACE "$") - target_link_libraries(png_shared - PUBLIC ${PNG_LINK_LIBRARIES}) -endif() +include_directories(${CMAKE_CURRENT_SOURCE_DIR}) -if(PNG_STATIC) - add_library(png_static STATIC ${libpng_sources}) - add_dependencies(png_static png_genfiles) - list(APPEND PNG_LIBRARY_TARGETS png_static) - set_target_properties(png_static - PROPERTIES OUTPUT_NAME "${PNG_STATIC_OUTPUT_NAME}" - DEBUG_POSTFIX "${PNG_DEBUG_POSTFIX}") - target_include_directories(png_static - PUBLIC "$") - target_include_directories(png_static - PUBLIC "$") - target_include_directories(png_static - SYSTEM - INTERFACE "$") - target_link_libraries(png_static - PUBLIC ${PNG_LINK_LIBRARIES}) +add_library(${TARGET_NAME} ${libpng_sources}) +add_dependencies(${TARGET_NAME} png_genfiles) + +target_include_directories(${TARGET_NAME} PUBLIC + "$" + "$" +) + +if("${CMAKE_SYSTEM_NAME}" STREQUAL "WindowsStore") + # ExitProcess not available + target_compile_definitions(${TARGET_NAME} PRIVATE -DPNG_WINDOWS_STORE) +elseif(MSVC) + # ExitProcess + target_link_libraries(${TARGET_NAME} PUBLIC Kernel32) endif() if(PNG_FRAMEWORK AND NOT APPLE) @@ -750,16 +723,14 @@ if(PNG_FRAMEWORK) SYSTEM INTERFACE "$") target_link_libraries(png_framework - PUBLIC ${PNG_LINK_LIBRARIES}) + PRIVATE ZLIB::zlib ${M_LIBRARY}) endif() -if(NOT PNG_LIBRARY_TARGETS) - message(SEND_ERROR "No library variant selected to build. " - "Please enable at least one of the following options: " - "PNG_SHARED, PNG_STATIC, PNG_FRAMEWORK") -endif() +target_link_libraries(${TARGET_NAME} PRIVATE ZLIB::zlib ${M_LIBRARY}) -if(PNG_TESTS AND PNG_SHARED) +target_compile_definitions(${TARGET_NAME} PUBLIC "$<$:PNG_DEBUG>") + +if(PNG_TESTS) enable_testing() # Include the internal module PNGTest.cmake @@ -778,7 +749,7 @@ if(PNG_TESTS AND PNG_SHARED) add_executable(pngtest ${pngtest_sources}) target_link_libraries(pngtest - PRIVATE png_shared) + PRIVATE png ZLIB::zlib ${M_LIBRARY}) png_add_test(NAME pngtest COMMAND pngtest @@ -790,7 +761,7 @@ if(PNG_TESTS AND PNG_SHARED) add_executable(pngvalid ${pngvalid_sources}) target_link_libraries(pngvalid - PRIVATE png_shared) + PRIVATE ZLIB::zlib ${M_LIBRARY}) png_add_test(NAME pngvalid-gamma-16-to-8 COMMAND pngvalid @@ -837,7 +808,7 @@ if(PNG_TESTS AND PNG_SHARED) add_executable(pngstest ${pngstest_sources}) target_link_libraries(pngstest - PRIVATE png_shared) + PRIVATE ${M_LIBRARY}) foreach(gamma_type 1.8 linear none sRGB) foreach(alpha_type none alpha) @@ -893,7 +864,7 @@ if(PNG_TESTS AND PNG_SHARED) add_executable(pngunknown ${pngunknown_sources}) target_link_libraries(pngunknown - PRIVATE png_shared) + PRIVATE ${TARGET_NAME}) png_add_test(NAME pngunknown-discard COMMAND pngunknown @@ -927,7 +898,7 @@ if(PNG_TESTS AND PNG_SHARED) add_executable(pngimage ${pngimage_sources}) target_link_libraries(pngimage - PRIVATE png_shared) + PRIVATE ${TARGET_NAME}) png_add_test(NAME pngimage-quick COMMAND pngimage @@ -939,10 +910,10 @@ if(PNG_TESTS AND PNG_SHARED) FILES ${PNGSUITE_PNGS}) endif() -if(PNG_SHARED AND PNG_TOOLS) +if(BUILD_SHARED_LIBS) add_executable(pngfix ${pngfix_sources}) target_link_libraries(pngfix - PRIVATE png_shared) + PRIVATE png ZLIB::zlib ${M_LIBRARY}) set(PNG_BIN_TARGETS pngfix) add_executable(png-fix-itxt ${png_fix_itxt_sources}) @@ -1019,127 +990,57 @@ configure_file("${CMAKE_CURRENT_SOURCE_DIR}/scripts/cmake/gensrc.cmake.in" "${CMAKE_CURRENT_BINARY_DIR}/scripts/cmake/gensrc.cmake" @ONLY) -# libpng is a library so default to 'lib' -if(NOT DEFINED CMAKE_INSTALL_LIBDIR) - set(CMAKE_INSTALL_LIBDIR lib) -endif() +#### +# Installation (https://github.com/forexample/package-example) -# Create pkgconfig files. -# We use the same files like ./configure, so we have to set its vars. -# Only do this on Windows for Cygwin - the files don't make much sense -# outside of a UNIX look-alike. -if(NOT WIN32 OR CYGWIN OR MINGW) - set(prefix "${CMAKE_INSTALL_PREFIX}") - set(exec_prefix "${CMAKE_INSTALL_PREFIX}") - set(libdir "${CMAKE_INSTALL_FULL_LIBDIR}") - set(includedir "${CMAKE_INSTALL_FULL_INCLUDEDIR}") - set(LIBS "-lz -lm") - configure_file("${CMAKE_CURRENT_SOURCE_DIR}/libpng.pc.in" - "${CMAKE_CURRENT_BINARY_DIR}/libpng${PNGLIB_ABI_VERSION}.pc" - @ONLY) - create_symlink(libpng.pc FILE libpng${PNGLIB_ABI_VERSION}.pc) - configure_file("${CMAKE_CURRENT_SOURCE_DIR}/libpng-config.in" - "${CMAKE_CURRENT_BINARY_DIR}/libpng${PNGLIB_ABI_VERSION}-config" - @ONLY) - create_symlink(libpng-config FILE libpng${PNGLIB_ABI_VERSION}-config) -endif() +set(config_install_dir "lib/cmake/${PROJECT_NAME}") +set(include_install_dir "include") -# Install. -if(NOT SKIP_INSTALL_LIBRARIES AND NOT SKIP_INSTALL_ALL) - install(TARGETS ${PNG_LIBRARY_TARGETS} - EXPORT libpng - RUNTIME DESTINATION "${CMAKE_INSTALL_BINDIR}" - LIBRARY DESTINATION "${CMAKE_INSTALL_LIBDIR}" - ARCHIVE DESTINATION "${CMAKE_INSTALL_LIBDIR}" - FRAMEWORK DESTINATION "${CMAKE_INSTALL_LIBDIR}") - - if(PNG_SHARED) - # Create a symlink for libpng.dll.a => libpng16.dll.a on Cygwin - if(NOT WIN32 OR CYGWIN OR MINGW) - create_symlink(libpng${CMAKE_SHARED_LIBRARY_SUFFIX} TARGET png_shared) - install(FILES "$/libpng${CMAKE_SHARED_LIBRARY_SUFFIX}" - DESTINATION "${CMAKE_INSTALL_LIBDIR}") - endif() - endif() +set(generated_dir "${CMAKE_CURRENT_BINARY_DIR}/generated") - if(PNG_STATIC) - if(NOT WIN32 OR CYGWIN OR MINGW) - create_symlink(libpng${CMAKE_STATIC_LIBRARY_SUFFIX} TARGET png_static) - install(FILES "$/libpng${CMAKE_STATIC_LIBRARY_SUFFIX}" - DESTINATION "${CMAKE_INSTALL_LIBDIR}") - endif() - endif() -endif() +set(version_config "${generated_dir}/${PROJECT_NAME}ConfigVersion.cmake") +set(project_config "${generated_dir}/${PROJECT_NAME}Config.cmake") +set(targets_export_name "${PROJECT_NAME}Targets") +set(namespace "${PROJECT_NAME}::") -if(NOT SKIP_INSTALL_HEADERS AND NOT SKIP_INSTALL_ALL) - install(FILES ${libpng_public_hdrs} - DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}") - install(FILES ${libpng_public_hdrs} - DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}/libpng${PNGLIB_ABI_VERSION}") -endif() -if(NOT SKIP_INSTALL_EXECUTABLES AND NOT SKIP_INSTALL_ALL) - if(NOT WIN32 OR CYGWIN OR MINGW) - install(PROGRAMS "${CMAKE_CURRENT_BINARY_DIR}/libpng-config" - DESTINATION "${CMAKE_INSTALL_BINDIR}") - install(PROGRAMS "${CMAKE_CURRENT_BINARY_DIR}/libpng${PNGLIB_ABI_VERSION}-config" - DESTINATION "${CMAKE_INSTALL_BINDIR}") - endif() -endif() +include(CMakePackageConfigHelpers) -if(NOT SKIP_INSTALL_PROGRAMS AND NOT SKIP_INSTALL_ALL) - install(TARGETS ${PNG_BIN_TARGETS} - RUNTIME DESTINATION "${CMAKE_INSTALL_BINDIR}") -endif() +# Note: PROJECT_VERSION is used as a VERSION +write_basic_package_version_file( + "${version_config}" COMPATIBILITY SameMajorVersion +) -if(NOT SKIP_INSTALL_FILES AND NOT SKIP_INSTALL_ALL) - # Install the man pages. - install(FILES libpng.3 libpngpf.3 - DESTINATION "${CMAKE_INSTALL_MANDIR}/man3") - install(FILES png.5 - DESTINATION "${CMAKE_INSTALL_MANDIR}/man5") - # Install the pkg-config files. - if(NOT CMAKE_HOST_WIN32 OR CYGWIN OR MINGW) - install(FILES "${CMAKE_CURRENT_BINARY_DIR}/libpng.pc" - DESTINATION "${CMAKE_INSTALL_LIBDIR}/pkgconfig") - install(PROGRAMS "${CMAKE_CURRENT_BINARY_DIR}/libpng-config" - DESTINATION "${CMAKE_INSTALL_BINDIR}") - install(FILES "${CMAKE_CURRENT_BINARY_DIR}/libpng${PNGLIB_ABI_VERSION}.pc" - DESTINATION "${CMAKE_INSTALL_LIBDIR}/pkgconfig") - install(PROGRAMS "${CMAKE_CURRENT_BINARY_DIR}/libpng${PNGLIB_ABI_VERSION}-config" - DESTINATION "${CMAKE_INSTALL_BINDIR}") - endif() -endif() +# Note: variable 'targets_export_name' used +configure_package_config_file( + "cmake/Config.cmake.in" + "${project_config}" + INSTALL_DESTINATION "${config_install_dir}" + ) + +install( + TARGETS ${TARGET_NAME} + EXPORT "${targets_export_name}" + LIBRARY DESTINATION "lib" + ARCHIVE DESTINATION "lib" + RUNTIME DESTINATION "bin" + INCLUDES DESTINATION "${include_install_dir}" +) -# Create an export file that CMake users can include() to import our targets. -if(NOT SKIP_INSTALL_EXPORT AND NOT SKIP_INSTALL_ALL) - install(EXPORT libpng - DESTINATION "${CMAKE_INSTALL_LIBDIR}/libpng" - FILE libpng${PNGLIB_ABI_VERSION}.cmake) -endif() +install( + FILES ${libpng_public_hdrs} + DESTINATION "${include_install_dir}" +) -# Create a CMake Config File that can be used via find_package(PNG CONFIG) -if(NOT SKIP_INSTALL_CONFIG_FILE AND NOT SKIP_INSTALL_ALL) - install(TARGETS ${PNG_LIBRARY_TARGETS} - EXPORT PNGTargets - RUNTIME DESTINATION "${CMAKE_INSTALL_BINDIR}" - LIBRARY DESTINATION "${CMAKE_INSTALL_LIBDIR}" - ARCHIVE DESTINATION "${CMAKE_INSTALL_LIBDIR}" - FRAMEWORK DESTINATION "${CMAKE_INSTALL_LIBDIR}") - - include(CMakePackageConfigHelpers) - write_basic_package_version_file(PNGConfigVersion.cmake - VERSION ${PNGLIB_VERSION} - COMPATIBILITY SameMinorVersion) - - install(EXPORT PNGTargets - FILE PNGTargets.cmake - NAMESPACE PNG:: - DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/PNG") - - install(FILES "${CMAKE_CURRENT_SOURCE_DIR}/scripts/cmake/PNGConfig.cmake" - "${CMAKE_CURRENT_BINARY_DIR}/PNGConfigVersion.cmake" - DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/PNG") -endif() +install( + FILES "${project_config}" "${version_config}" + DESTINATION "${config_install_dir}" +) + +install( + EXPORT "${targets_export_name}" + NAMESPACE "${namespace}" + DESTINATION "${config_install_dir}" +) # TODO: Create MSVC import lib for MinGW-compiled shared lib. # pexports libpng.dll > libpng.def diff --git a/cmake/Config.cmake.in b/cmake/Config.cmake.in new file mode 100644 index 0000000000..5c343beb0b --- /dev/null +++ b/cmake/Config.cmake.in @@ -0,0 +1,16 @@ +include(CMakeFindDependencyMacro) + +find_dependency(ZLIB CONFIG) + +include("${CMAKE_CURRENT_LIST_DIR}/@targets_export_name@.cmake") + +# ALIAS for imported target requires CMake >= 3.11: +# - https://cmake.org/cmake/help/latest/release/3.11.html#other +if(NOT CMAKE_VERSION VERSION_LESS 3.11 AND NOT TARGET PNG::PNG) + set_target_properties( + PNG::png + PROPERTIES + IMPORTED_GLOBAL True + ) + add_library(PNG::PNG ALIAS PNG::png) +endif() diff --git a/cmake/HunterGate.cmake b/cmake/HunterGate.cmake new file mode 100644 index 0000000000..b597ea5c0f --- /dev/null +++ b/cmake/HunterGate.cmake @@ -0,0 +1,543 @@ +# Copyright (c) 2013-2019, Ruslan Baratov +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, this +# list of conditions and the following disclaimer. +# +# * Redistributions in binary form must reproduce the above copyright notice, +# this list of conditions and the following disclaimer in the documentation +# and/or other materials provided with the distribution. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +# This is a gate file to Hunter package manager. +# Include this file using `include` command and add package you need, example: +# +# cmake_minimum_required(VERSION 3.10) +# +# include("cmake/HunterGate.cmake") +# HunterGate( +# URL "https://github.com/path/to/hunter/archive.tar.gz" +# SHA1 "798501e983f14b28b10cda16afa4de69eee1da1d" +# ) +# +# project(MyProject) +# +# hunter_add_package(Foo) +# hunter_add_package(Boo COMPONENTS Bar Baz) +# +# Projects: +# * https://github.com/cpp-pm/gate/ +# * https://github.com/cpp-pm/hunter + +option(HUNTER_ENABLED "Enable Hunter package manager support" ON) + +if(HUNTER_ENABLED) + if(CMAKE_VERSION VERSION_LESS "3.10") + message( + FATAL_ERROR + "At least CMake version 3.10 required for Hunter dependency management." + " Update CMake or set HUNTER_ENABLED to OFF." + ) + endif() +endif() + +include(CMakeParseArguments) # cmake_parse_arguments + +option(HUNTER_STATUS_PRINT "Print working status" ON) +option(HUNTER_STATUS_DEBUG "Print a lot info" OFF) +option(HUNTER_TLS_VERIFY "Enable/disable TLS certificate checking on downloads" ON) +set(HUNTER_ROOT "" CACHE FILEPATH "Override the HUNTER_ROOT.") + +set(HUNTER_ERROR_PAGE "https://hunter.readthedocs.io/en/latest/reference/errors") + +function(hunter_gate_status_print) + if(HUNTER_STATUS_PRINT OR HUNTER_STATUS_DEBUG) + foreach(print_message ${ARGV}) + message(STATUS "[hunter] ${print_message}") + endforeach() + endif() +endfunction() + +function(hunter_gate_status_debug) + if(HUNTER_STATUS_DEBUG) + foreach(print_message ${ARGV}) + string(TIMESTAMP timestamp) + message(STATUS "[hunter *** DEBUG *** ${timestamp}] ${print_message}") + endforeach() + endif() +endfunction() + +function(hunter_gate_error_page error_page) + message("------------------------------ ERROR ------------------------------") + message(" ${HUNTER_ERROR_PAGE}/${error_page}.html") + message("-------------------------------------------------------------------") + message("") + message(FATAL_ERROR "") +endfunction() + +function(hunter_gate_internal_error) + message("") + foreach(print_message ${ARGV}) + message("[hunter ** INTERNAL **] ${print_message}") + endforeach() + message("[hunter ** INTERNAL **] [Directory:${CMAKE_CURRENT_LIST_DIR}]") + message("") + hunter_gate_error_page("error.internal") +endfunction() + +function(hunter_gate_fatal_error) + cmake_parse_arguments(hunter "" "ERROR_PAGE" "" "${ARGV}") + if("${hunter_ERROR_PAGE}" STREQUAL "") + hunter_gate_internal_error("Expected ERROR_PAGE") + endif() + message("") + foreach(x ${hunter_UNPARSED_ARGUMENTS}) + message("[hunter ** FATAL ERROR **] ${x}") + endforeach() + message("[hunter ** FATAL ERROR **] [Directory:${CMAKE_CURRENT_LIST_DIR}]") + message("") + hunter_gate_error_page("${hunter_ERROR_PAGE}") +endfunction() + +function(hunter_gate_user_error) + hunter_gate_fatal_error(${ARGV} ERROR_PAGE "error.incorrect.input.data") +endfunction() + +function(hunter_gate_self root version sha1 result) + string(COMPARE EQUAL "${root}" "" is_bad) + if(is_bad) + hunter_gate_internal_error("root is empty") + endif() + + string(COMPARE EQUAL "${version}" "" is_bad) + if(is_bad) + hunter_gate_internal_error("version is empty") + endif() + + string(COMPARE EQUAL "${sha1}" "" is_bad) + if(is_bad) + hunter_gate_internal_error("sha1 is empty") + endif() + + string(SUBSTRING "${sha1}" 0 7 archive_id) + + if(EXISTS "${root}/cmake/Hunter") + set(hunter_self "${root}") + else() + set( + hunter_self + "${root}/_Base/Download/Hunter/${version}/${archive_id}/Unpacked" + ) + endif() + + set("${result}" "${hunter_self}" PARENT_SCOPE) +endfunction() + +# Set HUNTER_GATE_ROOT cmake variable to suitable value. +function(hunter_gate_detect_root) + # Check CMake variable + if(HUNTER_ROOT) + set(HUNTER_GATE_ROOT "${HUNTER_ROOT}" PARENT_SCOPE) + hunter_gate_status_debug("HUNTER_ROOT detected by cmake variable") + return() + endif() + + # Check environment variable + if(DEFINED ENV{HUNTER_ROOT}) + set(HUNTER_GATE_ROOT "$ENV{HUNTER_ROOT}" PARENT_SCOPE) + hunter_gate_status_debug("HUNTER_ROOT detected by environment variable") + return() + endif() + + # Check HOME environment variable + if(DEFINED ENV{HOME}) + set(HUNTER_GATE_ROOT "$ENV{HOME}/.hunter" PARENT_SCOPE) + hunter_gate_status_debug("HUNTER_ROOT set using HOME environment variable") + return() + endif() + + # Check SYSTEMDRIVE and USERPROFILE environment variable (windows only) + if(WIN32) + if(DEFINED ENV{SYSTEMDRIVE}) + set(HUNTER_GATE_ROOT "$ENV{SYSTEMDRIVE}/.hunter" PARENT_SCOPE) + hunter_gate_status_debug( + "HUNTER_ROOT set using SYSTEMDRIVE environment variable" + ) + return() + endif() + + if(DEFINED ENV{USERPROFILE}) + set(HUNTER_GATE_ROOT "$ENV{USERPROFILE}/.hunter" PARENT_SCOPE) + hunter_gate_status_debug( + "HUNTER_ROOT set using USERPROFILE environment variable" + ) + return() + endif() + endif() + + hunter_gate_fatal_error( + "Can't detect HUNTER_ROOT" + ERROR_PAGE "error.detect.hunter.root" + ) +endfunction() + +function(hunter_gate_download dir) + string( + COMPARE + NOTEQUAL + "$ENV{HUNTER_DISABLE_AUTOINSTALL}" + "" + disable_autoinstall + ) + if(disable_autoinstall AND NOT HUNTER_RUN_INSTALL) + hunter_gate_fatal_error( + "Hunter not found in '${dir}'" + "Set HUNTER_RUN_INSTALL=ON to auto-install it from '${HUNTER_GATE_URL}'" + "Settings:" + " HUNTER_ROOT: ${HUNTER_GATE_ROOT}" + " HUNTER_SHA1: ${HUNTER_GATE_SHA1}" + ERROR_PAGE "error.run.install" + ) + endif() + string(COMPARE EQUAL "${dir}" "" is_bad) + if(is_bad) + hunter_gate_internal_error("Empty 'dir' argument") + endif() + + string(COMPARE EQUAL "${HUNTER_GATE_SHA1}" "" is_bad) + if(is_bad) + hunter_gate_internal_error("HUNTER_GATE_SHA1 empty") + endif() + + string(COMPARE EQUAL "${HUNTER_GATE_URL}" "" is_bad) + if(is_bad) + hunter_gate_internal_error("HUNTER_GATE_URL empty") + endif() + + set(done_location "${dir}/DONE") + set(sha1_location "${dir}/SHA1") + + set(build_dir "${dir}/Build") + set(cmakelists "${dir}/CMakeLists.txt") + + hunter_gate_status_debug("Locking directory: ${dir}") + file(LOCK "${dir}" DIRECTORY GUARD FUNCTION) + hunter_gate_status_debug("Lock done") + + if(EXISTS "${done_location}") + # while waiting for lock other instance can do all the job + hunter_gate_status_debug("File '${done_location}' found, skip install") + return() + endif() + + file(REMOVE_RECURSE "${build_dir}") + file(REMOVE_RECURSE "${cmakelists}") + + file(MAKE_DIRECTORY "${build_dir}") # check directory permissions + + # Disabling languages speeds up a little bit, reduces noise in the output + # and avoids path too long windows error + file( + WRITE + "${cmakelists}" + "cmake_minimum_required(VERSION 3.10)\n" + "if(POLICY CMP0114)\n" + " cmake_policy(SET CMP0114 NEW)\n" + "endif()\n" + "if(POLICY CMP0135)\n" + " cmake_policy(SET CMP0135 NEW)\n" + "endif()\n" + "project(HunterDownload LANGUAGES NONE)\n" + "include(ExternalProject)\n" + "ExternalProject_Add(\n" + " Hunter\n" + " URL\n" + " \"${HUNTER_GATE_URL}\"\n" + " URL_HASH\n" + " SHA1=${HUNTER_GATE_SHA1}\n" + " DOWNLOAD_DIR\n" + " \"${dir}\"\n" + " TLS_VERIFY\n" + " ${HUNTER_TLS_VERIFY}\n" + " SOURCE_DIR\n" + " \"${dir}/Unpacked\"\n" + " CONFIGURE_COMMAND\n" + " \"\"\n" + " BUILD_COMMAND\n" + " \"\"\n" + " INSTALL_COMMAND\n" + " \"\"\n" + ")\n" + ) + + if(HUNTER_STATUS_DEBUG) + set(logging_params "") + else() + set(logging_params OUTPUT_QUIET) + endif() + + hunter_gate_status_debug("Run generate") + + # Need to add toolchain file too. + # Otherwise on Visual Studio + MDD this will fail with error: + # "Could not find an appropriate version of the Windows 10 SDK installed on this machine" + if(EXISTS "${CMAKE_TOOLCHAIN_FILE}") + get_filename_component(absolute_CMAKE_TOOLCHAIN_FILE "${CMAKE_TOOLCHAIN_FILE}" ABSOLUTE) + set(toolchain_arg "-DCMAKE_TOOLCHAIN_FILE=${absolute_CMAKE_TOOLCHAIN_FILE}") + else() + # 'toolchain_arg' can't be empty + set(toolchain_arg "-DCMAKE_TOOLCHAIN_FILE=") + endif() + + string(COMPARE EQUAL "${CMAKE_MAKE_PROGRAM}" "" no_make) + if(no_make) + set(make_arg "") + else() + # Test case: remove Ninja from PATH but set it via CMAKE_MAKE_PROGRAM + set(make_arg "-DCMAKE_MAKE_PROGRAM=${CMAKE_MAKE_PROGRAM}") + endif() + + execute_process( + COMMAND + "${CMAKE_COMMAND}" + "-H${dir}" + "-B${build_dir}" + "-G${CMAKE_GENERATOR}" + "${toolchain_arg}" + ${make_arg} + WORKING_DIRECTORY "${dir}" + RESULT_VARIABLE download_result + ${logging_params} + ) + + if(NOT download_result EQUAL 0) + hunter_gate_internal_error( + "Configure project failed." + "To reproduce the error run: ${CMAKE_COMMAND} -H${dir} -B${build_dir} -G${CMAKE_GENERATOR} ${toolchain_arg} ${make_arg}" + "In directory ${dir}" + ) + endif() + + hunter_gate_status_print( + "Initializing Hunter workspace (${HUNTER_GATE_SHA1})" + " ${HUNTER_GATE_URL}" + " -> ${dir}" + ) + execute_process( + COMMAND "${CMAKE_COMMAND}" --build "${build_dir}" + WORKING_DIRECTORY "${dir}" + RESULT_VARIABLE download_result + ${logging_params} + ) + + if(NOT download_result EQUAL 0) + hunter_gate_internal_error("Build project failed") + endif() + + file(REMOVE_RECURSE "${build_dir}") + file(REMOVE_RECURSE "${cmakelists}") + + file(WRITE "${sha1_location}" "${HUNTER_GATE_SHA1}") + file(WRITE "${done_location}" "DONE") + + hunter_gate_status_debug("Finished") +endfunction() + +# Must be a macro so master file 'cmake/Hunter' can +# apply all variables easily just by 'include' command +# (otherwise PARENT_SCOPE magic needed) +macro(HunterGate) + if(HUNTER_GATE_DONE) + # variable HUNTER_GATE_DONE set explicitly for external project + # (see `hunter_download`) + set_property(GLOBAL PROPERTY HUNTER_GATE_DONE YES) + endif() + + # First HunterGate command will init Hunter, others will be ignored + get_property(_hunter_gate_done GLOBAL PROPERTY HUNTER_GATE_DONE SET) + + if(NOT HUNTER_ENABLED) + # Empty function to avoid error "unknown function" + function(hunter_add_package) + endfunction() + + set( + _hunter_gate_disabled_mode_dir + "${CMAKE_CURRENT_LIST_DIR}/cmake/Hunter/disabled-mode" + ) + if(EXISTS "${_hunter_gate_disabled_mode_dir}") + hunter_gate_status_debug( + "Adding \"disabled-mode\" modules: ${_hunter_gate_disabled_mode_dir}" + ) + list(APPEND CMAKE_PREFIX_PATH "${_hunter_gate_disabled_mode_dir}") + endif() + elseif(_hunter_gate_done) + hunter_gate_status_debug("Secondary HunterGate (use old settings)") + hunter_gate_self( + "${HUNTER_CACHED_ROOT}" + "${HUNTER_VERSION}" + "${HUNTER_SHA1}" + _hunter_self + ) + include("${_hunter_self}/cmake/Hunter") + else() + set(HUNTER_GATE_LOCATION "${CMAKE_CURRENT_SOURCE_DIR}") + + string(COMPARE NOTEQUAL "${PROJECT_NAME}" "" _have_project_name) + if(_have_project_name) + hunter_gate_fatal_error( + "Please set HunterGate *before* 'project' command. " + "Detected project: ${PROJECT_NAME}" + ERROR_PAGE "error.huntergate.before.project" + ) + endif() + + cmake_parse_arguments( + HUNTER_GATE "LOCAL" "URL;SHA1;GLOBAL;FILEPATH" "" ${ARGV} + ) + + string(COMPARE EQUAL "${HUNTER_GATE_SHA1}" "" _empty_sha1) + string(COMPARE EQUAL "${HUNTER_GATE_URL}" "" _empty_url) + string( + COMPARE + NOTEQUAL + "${HUNTER_GATE_UNPARSED_ARGUMENTS}" + "" + _have_unparsed + ) + string(COMPARE NOTEQUAL "${HUNTER_GATE_GLOBAL}" "" _have_global) + string(COMPARE NOTEQUAL "${HUNTER_GATE_FILEPATH}" "" _have_filepath) + + if(_have_unparsed) + hunter_gate_user_error( + "HunterGate unparsed arguments: ${HUNTER_GATE_UNPARSED_ARGUMENTS}" + ) + endif() + if(_empty_sha1) + hunter_gate_user_error("SHA1 suboption of HunterGate is mandatory") + endif() + if(_empty_url) + hunter_gate_user_error("URL suboption of HunterGate is mandatory") + endif() + if(_have_global) + if(HUNTER_GATE_LOCAL) + hunter_gate_user_error("Unexpected LOCAL (already has GLOBAL)") + endif() + if(_have_filepath) + hunter_gate_user_error("Unexpected FILEPATH (already has GLOBAL)") + endif() + endif() + if(HUNTER_GATE_LOCAL) + if(_have_global) + hunter_gate_user_error("Unexpected GLOBAL (already has LOCAL)") + endif() + if(_have_filepath) + hunter_gate_user_error("Unexpected FILEPATH (already has LOCAL)") + endif() + endif() + if(_have_filepath) + if(_have_global) + hunter_gate_user_error("Unexpected GLOBAL (already has FILEPATH)") + endif() + if(HUNTER_GATE_LOCAL) + hunter_gate_user_error("Unexpected LOCAL (already has FILEPATH)") + endif() + endif() + + hunter_gate_detect_root() # set HUNTER_GATE_ROOT + + # Beautify path, fix probable problems with windows path slashes + get_filename_component( + HUNTER_GATE_ROOT "${HUNTER_GATE_ROOT}" ABSOLUTE + ) + hunter_gate_status_debug("HUNTER_ROOT: ${HUNTER_GATE_ROOT}") + if(NOT HUNTER_ALLOW_SPACES_IN_PATH) + string(FIND "${HUNTER_GATE_ROOT}" " " _contain_spaces) + if(NOT _contain_spaces EQUAL -1) + hunter_gate_fatal_error( + "HUNTER_ROOT (${HUNTER_GATE_ROOT}) contains spaces." + "Set HUNTER_ALLOW_SPACES_IN_PATH=ON to skip this error" + "(Use at your own risk!)" + ERROR_PAGE "error.spaces.in.hunter.root" + ) + endif() + endif() + + string( + REGEX + MATCH + "[0-9]+\\.[0-9]+\\.[0-9]+[-_a-z0-9]*" + HUNTER_GATE_VERSION + "${HUNTER_GATE_URL}" + ) + string(COMPARE EQUAL "${HUNTER_GATE_VERSION}" "" _is_empty) + if(_is_empty) + set(HUNTER_GATE_VERSION "unknown") + endif() + + hunter_gate_self( + "${HUNTER_GATE_ROOT}" + "${HUNTER_GATE_VERSION}" + "${HUNTER_GATE_SHA1}" + _hunter_self + ) + + set(_master_location "${_hunter_self}/cmake/Hunter") + if(EXISTS "${HUNTER_GATE_ROOT}/cmake/Hunter") + # Hunter downloaded manually (e.g. by 'git clone') + set(_unused "xxxxxxxxxx") + set(HUNTER_GATE_SHA1 "${_unused}") + set(HUNTER_GATE_VERSION "${_unused}") + else() + get_filename_component(_archive_id_location "${_hunter_self}/.." ABSOLUTE) + set(_done_location "${_archive_id_location}/DONE") + set(_sha1_location "${_archive_id_location}/SHA1") + + # Check Hunter already downloaded by HunterGate + if(NOT EXISTS "${_done_location}") + hunter_gate_download("${_archive_id_location}") + endif() + + if(NOT EXISTS "${_done_location}") + hunter_gate_internal_error("hunter_gate_download failed") + endif() + + if(NOT EXISTS "${_sha1_location}") + hunter_gate_internal_error("${_sha1_location} not found") + endif() + file(READ "${_sha1_location}" _sha1_value) + string(TOLOWER "${_sha1_value}" _sha1_value_lower) + string(TOLOWER "${HUNTER_GATE_SHA1}" _HUNTER_GATE_SHA1_lower) + string(COMPARE EQUAL "${_sha1_value_lower}" "${_HUNTER_GATE_SHA1_lower}" _is_equal) + if(NOT _is_equal) + hunter_gate_internal_error( + "Short SHA1 collision:" + " ${_sha1_value} (from ${_sha1_location})" + " ${HUNTER_GATE_SHA1} (HunterGate)" + ) + endif() + if(NOT EXISTS "${_master_location}") + hunter_gate_user_error( + "Master file not found:" + " ${_master_location}" + "try to update Hunter/HunterGate" + ) + endif() + endif() + include("${_master_location}") + set_property(GLOBAL PROPERTY HUNTER_GATE_DONE YES) + endif() +endmacro()