From 872ccadd8ad47a51f6d1fca5f5f5aa63f1467132 Mon Sep 17 00:00:00 2001 From: Carsten Teibes Date: Sun, 31 Dec 2023 06:43:30 +0100 Subject: [PATCH] Update workflow and cmakery Better use as submodule, without install target (useful for flatpak) Prevent in-source builds --- .github/workflows/stable-compilation.yml | 22 ++-- CMakeLists.txt | 158 ++++++++++++----------- builds/cmake/Modules/MiscUtils.cmake | 12 ++ 3 files changed, 103 insertions(+), 89 deletions(-) create mode 100644 builds/cmake/Modules/MiscUtils.cmake diff --git a/.github/workflows/stable-compilation.yml b/.github/workflows/stable-compilation.yml index a0ab67d8..33b1f833 100644 --- a/.github/workflows/stable-compilation.yml +++ b/.github/workflows/stable-compilation.yml @@ -5,6 +5,10 @@ on: pull_request: workflow_dispatch: +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + defaults: run: shell: bash @@ -20,17 +24,12 @@ jobs: fail-fast: false matrix: image: - - debian:10 # CMake 3.13.4 - g++ 8.3.0 - oldstable - ubuntu:20.04 # CMake 3.16.3 - g++ 9.3.0 - LTS - - debian:11 # CMake 3.18.4 - g++ 10.2.1 - stable + - debian:11 # CMake 3.18.4 - g++ 10.2.1 - oldstable - ubuntu:22.04 # CMake 3.22.1 - g++ 11.2.0 - LTS - steps: - - name: Cancel Previous Runs - uses: styfle/cancel-workflow-action@0.8.0 - - - name: Checkout - uses: actions/checkout@v2 + - debian:12 # CMake 3.25.1 - g++ 12.2.0 - stable + steps: - name: Install dependencies run: | export DEBIAN_FRONTEND="noninteractive" @@ -39,6 +38,9 @@ jobs: build-essential cmake ninja-build git \ libicu-dev libexpat1-dev + - name: Clone Repository + uses: actions/checkout@v4 + - name: Compile run: | cmake -G Ninja -B build . \ @@ -47,9 +49,7 @@ jobs: - name: Install run: | - export DESTDIR=$PWD/local-install - # cmake < 3.16 does not support '--install' - cmake --build build --target install + cmake --install build - name: Test run: cmake --build build --target check diff --git a/CMakeLists.txt b/CMakeLists.txt index 14ab6bf7..96462856 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,25 +1,22 @@ -cmake_minimum_required(VERSION 3.10...3.20 FATAL_ERROR) -if(${CMAKE_VERSION} VERSION_LESS 3.12) - # Use most recent policies, even for older cmake - cmake_policy(VERSION ${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION}) -endif() +cmake_minimum_required(VERSION 3.16...3.28 FATAL_ERROR) project(liblcf VERSION 0.8 LANGUAGES CXX) +list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/builds/cmake/Modules) +include(ConfigureWindows) +include(MiscUtils) + # Compilation options option(BUILD_SHARED_LIBS "Build shared library, disable for building the static library (default: ON)" ON) option(LIBLCF_WITH_ICU "ICU encoding handling (when disabled only windows-1252 is supported, default: ON)" ON) option(LIBLCF_WITH_XML "XML reading support (expat, default: ON)" ON) option(LIBLCF_UPDATE_MIMEDB "Whether to run update-mime-database after install (default: ON)" ON) -option(LIBLCF_ENABLE_TOOLS "Whether to build the tools (default: ON)" ON) -option(LIBLCF_ENABLE_TESTS "Whetner to build the unit tests (default: ON)" ON) +option(LIBLCF_ENABLE_TOOLS "Whether to build the tools (default: ON)" ${LIBLCF_MAIN_PROJECT}) +option(LIBLCF_ENABLE_TESTS "Whether to build the unit tests (default: ON)" ${LIBLCF_MAIN_PROJECT}) option(LIBLCF_ENABLE_BENCHMARKS "Whether to build the benchmarks (default: OFF)" OFF) - +option(LIBLCF_ENABLE_INSTALL "Whether to add an install target (default: ON)" ${LIBLCF_MAIN_PROJECT}) set(CMAKE_DEBUG_POSTFIX "d" CACHE STRING "Override CMAKE_DEBUG_POSTFIX.") -list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/builds/cmake/Modules) -include(ConfigureWindows) - # C++17 is required set(CMAKE_CXX_STANDARD 17) set(CMAKE_CXX_STANDARD_REQUIRED ON) @@ -379,80 +376,83 @@ target_sources(lcf PRIVATE ${CMAKE_CURRENT_BINARY_DIR}/src/lcf/config.h) set_property(TARGET lcf PROPERTY SOVERSION 0) # installation +if(LIBLCF_ENABLE_INSTALL) -# pkg-config file generation -set(LCF_LIBDIR ${CMAKE_INSTALL_LIBDIR}) -if(IS_ABSOLUTE ${LCF_LIBDIR}) - file(RELATIVE_PATH LCF_LIBDIR ${CMAKE_INSTALL_PREFIX} ${LCF_LIBDIR}) -endif() -set(LCF_INCLUDEDIR ${CMAKE_INSTALL_INCLUDEDIR}) -if(IS_ABSOLUTE ${LCF_INCLUDEDIR}) - file(RELATIVE_PATH LCF_INCLUDEDIR ${CMAKE_INSTALL_PREFIX} ${LCF_INCLUDEDIR}) -endif() -set(PACKAGE_TARNAME ${PROJECT_NAME}) -set(PACKAGE_VERSION ${PROJECT_VERSION}) -set(prefix "${CMAKE_INSTALL_PREFIX}") -set(exec_prefix "\${prefix}") -set(libdir "\${exec_prefix}/${LCF_LIBDIR}") -set(includedir "\${prefix}/${LCF_INCLUDEDIR}") -string(REPLACE ";" " " AX_PACKAGE_REQUIRES_PRIVATE "${LIBLCF_DEPS}") -configure_file(builds/${PROJECT_NAME}.pc.in builds/${PROJECT_NAME}.pc @ONLY) - -# Cmake-config file generation -install( - TARGETS lcf - EXPORT lcf-export - ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} - LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} - RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}) - -set(LCF_INSTALL_HEADERS ${LCF_HEADERS} ${CMAKE_CURRENT_BINARY_DIR}/src/lcf/config.h) -foreach(S ldb lmt lmu lsd rpg third_party) - set(SUBDIR_HEADERS ${LCF_INSTALL_HEADERS}) - list(FILTER SUBDIR_HEADERS INCLUDE REGEX "/${S}/") - install(FILES ${SUBDIR_HEADERS} DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/lcf/${S}) - list(REMOVE_ITEM LCF_INSTALL_HEADERS ${SUBDIR_HEADERS}) -endforeach() -install(FILES ${LCF_INSTALL_HEADERS} DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/lcf) + # pkg-config file generation + set(LCF_LIBDIR ${CMAKE_INSTALL_LIBDIR}) + if(IS_ABSOLUTE ${LCF_LIBDIR}) + file(RELATIVE_PATH LCF_LIBDIR ${CMAKE_INSTALL_PREFIX} ${LCF_LIBDIR}) + endif() + set(LCF_INCLUDEDIR ${CMAKE_INSTALL_INCLUDEDIR}) + if(IS_ABSOLUTE ${LCF_INCLUDEDIR}) + file(RELATIVE_PATH LCF_INCLUDEDIR ${CMAKE_INSTALL_PREFIX} ${LCF_INCLUDEDIR}) + endif() + set(PACKAGE_TARNAME ${PROJECT_NAME}) + set(PACKAGE_VERSION ${PROJECT_VERSION}) + set(prefix "${CMAKE_INSTALL_PREFIX}") + set(exec_prefix "\${prefix}") + set(libdir "\${exec_prefix}/${LCF_LIBDIR}") + set(includedir "\${prefix}/${LCF_INCLUDEDIR}") + string(REPLACE ";" " " AX_PACKAGE_REQUIRES_PRIVATE "${LIBLCF_DEPS}") + configure_file(builds/${PROJECT_NAME}.pc.in builds/${PROJECT_NAME}.pc @ONLY) + + # Cmake-config file generation + install( + TARGETS lcf + EXPORT lcf-export + ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} + LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} + RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}) + + set(LCF_INSTALL_HEADERS ${LCF_HEADERS} ${CMAKE_CURRENT_BINARY_DIR}/src/lcf/config.h) + foreach(S ldb lmt lmu lsd rpg third_party) + set(SUBDIR_HEADERS ${LCF_INSTALL_HEADERS}) + list(FILTER SUBDIR_HEADERS INCLUDE REGEX "/${S}/") + install(FILES ${SUBDIR_HEADERS} DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/lcf/${S}) + list(REMOVE_ITEM LCF_INSTALL_HEADERS ${SUBDIR_HEADERS}) + endforeach() + install(FILES ${LCF_INSTALL_HEADERS} DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/lcf) -install( - FILES ${CMAKE_CURRENT_BINARY_DIR}/builds/${PROJECT_NAME}.pc - DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig -) + install( + FILES ${CMAKE_CURRENT_BINARY_DIR}/builds/${PROJECT_NAME}.pc + DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig + ) -install( - EXPORT lcf-export FILE liblcf-targets.cmake - NAMESPACE liblcf:: DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/liblcf -) + install( + EXPORT lcf-export FILE liblcf-targets.cmake + NAMESPACE liblcf:: DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/liblcf + ) -include(CMakePackageConfigHelpers) -configure_package_config_file( - ${CMAKE_CURRENT_SOURCE_DIR}/builds/cmake/liblcf-config.cmake.in - ${CMAKE_CURRENT_BINARY_DIR}/liblcf-config.cmake - INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/liblcf -) + include(CMakePackageConfigHelpers) + configure_package_config_file( + ${CMAKE_CURRENT_SOURCE_DIR}/builds/cmake/liblcf-config.cmake.in + ${CMAKE_CURRENT_BINARY_DIR}/liblcf-config.cmake + INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/liblcf + ) -write_basic_package_version_file( - ${CMAKE_CURRENT_BINARY_DIR}/liblcf-config-version.cmake - COMPATIBILITY ExactVersion -) + write_basic_package_version_file( + ${CMAKE_CURRENT_BINARY_DIR}/liblcf-config-version.cmake + COMPATIBILITY ExactVersion + ) -install(FILES - ${CMAKE_CURRENT_BINARY_DIR}/liblcf-config.cmake - ${CMAKE_CURRENT_BINARY_DIR}/liblcf-config-version.cmake - DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/liblcf -) + install(FILES + ${CMAKE_CURRENT_BINARY_DIR}/liblcf-config.cmake + ${CMAKE_CURRENT_BINARY_DIR}/liblcf-config-version.cmake + DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/liblcf + ) -# mime types -install( - FILES ${CMAKE_CURRENT_SOURCE_DIR}/mime/${PROJECT_NAME}.xml - DESTINATION ${CMAKE_INSTALL_DATADIR}/mime/packages -) -if(LIBLCF_UPDATE_MIMEDB AND UPDATE_MIME_DATABASE) - install(CODE - "execute_process(COMMAND ${UPDATE_MIME_DATABASE} - \$ENV{DESTDIR}\${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_DATADIR}/mime)" + # mime types + install( + FILES ${CMAKE_CURRENT_SOURCE_DIR}/mime/${PROJECT_NAME}.xml + DESTINATION ${CMAKE_INSTALL_DATADIR}/mime/packages ) + if(LIBLCF_UPDATE_MIMEDB AND UPDATE_MIME_DATABASE) + install(CODE + "execute_process(COMMAND ${UPDATE_MIME_DATABASE} + \$ENV{DESTDIR}\${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_DATADIR}/mime)" + ) + endif() + endif() # tests @@ -492,7 +492,9 @@ if(LIBLCF_ENABLE_TOOLS) add_executable(${tool} tools/${tool}.cpp) target_link_libraries(${tool} lcf) add_dependencies(tools ${tool}) - install(TARGETS ${tool} RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}) + if(LIBLCF_ENABLE_INSTALL) + install(TARGETS ${tool} RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}) + endif() endforeach() endif() diff --git a/builds/cmake/Modules/MiscUtils.cmake b/builds/cmake/Modules/MiscUtils.cmake new file mode 100644 index 00000000..a6f0b3a3 --- /dev/null +++ b/builds/cmake/Modules/MiscUtils.cmake @@ -0,0 +1,12 @@ + +# check if we are a submodule +if(${CMAKE_CURRENT_SOURCE_DIR} STREQUAL ${CMAKE_SOURCE_DIR}) + set(LIBLCF_MAIN_PROJECT ON) +else() + set(LIBLCF_MAIN_PROJECT OFF) +endif() + +# prevent in-source builds +if(${CMAKE_SOURCE_DIR} STREQUAL ${CMAKE_BINARY_DIR}) + message(FATAL_ERROR "In-source builds are disabled.") +endif()