|
| 1 | +#[=============================================================================[ |
| 2 | +# PHP/Package/LibXml2 |
| 3 | +
|
| 4 | +Finds and downloads the `libxml2` library: |
| 5 | +
|
| 6 | +```cmake |
| 7 | +include(PHP/Package/LibXml2) |
| 8 | +``` |
| 9 | +
|
| 10 | +This module first tries to find the `libxml2` library on the system. If not |
| 11 | +successful it tries to download it from the upstream source with |
| 12 | +`ExternalProject` module and build it together with the PHP build. |
| 13 | +
|
| 14 | +See: https://cmake.org/cmake/help/latest/module/FindLibXml2.html |
| 15 | +
|
| 16 | +## Examples |
| 17 | +
|
| 18 | +Basic usage: |
| 19 | +
|
| 20 | +```cmake |
| 21 | +# CMakeLists.txt |
| 22 | +include(PHP/Package/LibXml2) |
| 23 | +target_link_libraries(example PRIVATE LibXml2::LibXml2) |
| 24 | +``` |
| 25 | +#]=============================================================================] |
| 26 | + |
| 27 | +include(FeatureSummary) |
| 28 | +include(ExternalProject) |
| 29 | + |
| 30 | +set_package_properties( |
| 31 | + LibXml2 |
| 32 | + PROPERTIES |
| 33 | + URL "https://gitlab.gnome.org/GNOME/libxml2" |
| 34 | + DESCRIPTION "XML parser and toolkit" |
| 35 | +) |
| 36 | + |
| 37 | +# Minimum required version for the libxml2 dependency. |
| 38 | +set(PHP_LIBXML2_MIN_VERSION 2.9.0) |
| 39 | + |
| 40 | +# Download version when system dependency is not found. |
| 41 | +set(PHP_LIBXML2_DOWNLOAD_VERSION 2.14.4) |
| 42 | + |
| 43 | +if(TARGET LibXml2::LibXml2) |
| 44 | + set(LibXml2_FOUND TRUE) |
| 45 | + get_property(LibXml2_DOWNLOADED GLOBAL PROPERTY _PHP_LibXml2_DOWNLOADED) |
| 46 | + return() |
| 47 | +endif() |
| 48 | + |
| 49 | +find_package(LibXml2 ${PHP_LIBXML2_MIN_VERSION}) |
| 50 | + |
| 51 | +if(NOT LibXml2_FOUND) |
| 52 | + message( |
| 53 | + STATUS |
| 54 | + "LibXml2 ${PHP_LIBXML2_DOWNLOAD_VERSION} will be downloaded at build phase" |
| 55 | + ) |
| 56 | + |
| 57 | + include(PHP/Package/ZLIB) |
| 58 | + |
| 59 | + set(options "-DCMAKE_INSTALL_PREFIX=<INSTALL_DIR>") |
| 60 | + list(APPEND options -DLIBXML2_WITH_PYTHON=OFF -DLIBXML2_WITH_LZMA=OFF) |
| 61 | + |
| 62 | + ExternalProject_Add( |
| 63 | + LibXml2 |
| 64 | + STEP_TARGETS build install |
| 65 | + URL |
| 66 | + https://github.com/GNOME/libxml2/archive/refs/tags/v${PHP_LIBXML2_DOWNLOAD_VERSION}.tar.gz |
| 67 | + CMAKE_ARGS ${options} |
| 68 | + INSTALL_DIR ${CMAKE_CURRENT_BINARY_DIR}/libxml2-installation |
| 69 | + INSTALL_BYPRODUCTS <INSTALL_DIR>/lib/libxml2${CMAKE_STATIC_LIBRARY_SUFFIX} |
| 70 | + ) |
| 71 | + |
| 72 | + add_dependencies(LibXml2 ZLIB::ZLIB) |
| 73 | + |
| 74 | + # Move dependency to PACKAGES_FOUND. |
| 75 | + block() |
| 76 | + set(package "LibXml2") |
| 77 | + get_property(packagesNotFound GLOBAL PROPERTY PACKAGES_NOT_FOUND) |
| 78 | + list(REMOVE_ITEM packagesNotFound ${package}) |
| 79 | + set_property(GLOBAL PROPERTY PACKAGES_NOT_FOUND ${packagesNotFound}) |
| 80 | + get_property(packagesFound GLOBAL PROPERTY PACKAGES_FOUND) |
| 81 | + list(FIND packagesFound ${package} found) |
| 82 | + if(found EQUAL -1) |
| 83 | + set_property(GLOBAL APPEND PROPERTY PACKAGES_FOUND ${package}) |
| 84 | + endif() |
| 85 | + endblock() |
| 86 | + |
| 87 | + ExternalProject_Get_Property(LibXml2 INSTALL_DIR) |
| 88 | + |
| 89 | + # Bypass issue with non-existing include directory for the imported target. |
| 90 | + file(MAKE_DIRECTORY ${INSTALL_DIR}/include) |
| 91 | + |
| 92 | + add_library(LibXml2::LibXml2 STATIC IMPORTED GLOBAL) |
| 93 | + set_target_properties( |
| 94 | + LibXml2::LibXml2 |
| 95 | + PROPERTIES |
| 96 | + IMPORTED_LOCATION "${INSTALL_DIR}/lib/libxml2${CMAKE_STATIC_LIBRARY_SUFFIX}" |
| 97 | + INTERFACE_INCLUDE_DIRECTORIES "${INSTALL_DIR}/include" |
| 98 | + ) |
| 99 | + add_dependencies(LibXml2::LibXml2 LibXml2-install) |
| 100 | + |
| 101 | + # Mark package as found. |
| 102 | + set(LibXml2_FOUND TRUE) |
| 103 | + |
| 104 | + define_property( |
| 105 | + GLOBAL |
| 106 | + PROPERTY _PHP_LibXml2_DOWNLOADED |
| 107 | + BRIEF_DOCS "Marker that LibXml2 library will be downloaded" |
| 108 | + ) |
| 109 | + |
| 110 | + set_property(GLOBAL PROPERTY _PHP_LibXml2_DOWNLOADED TRUE) |
| 111 | + set(LibXml2_DOWNLOADED TRUE) |
| 112 | +endif() |
0 commit comments