Use correctly-cased CMake variables for better compatibility (#825)

* Use the correct casing for <PackageName>_FOUND
* Add a CI test with CMake very latest (currently 4.1.2). This job also sets DCMAKE_POLICY_VERSION_MINIMUM to verify that we don't break any future policies, greater than our minimum version 3.15.
* Tidy the ncurses support for libreadline to use READLINE_LIBRARIES

Author: NWilson

.github/workflows/dev.yml

@@ -11,9 +11,10 @@ on:
         - all
         - canary
         - dragon
-        - greatawk
+        - puffin
         - dodo
         - passenger
+        - greatawk
         - wasp
         - bat
         - pterodactyl
@@ -97,27 +98,52 @@ jobs:
           ulimit -S -s 49152 # Raise stack limit; ASAN with -O0 is very stack-hungry
           (make check; rc=$?; for i in test-suite.log Run*Test.log pcre2*_test.log; do echo "== $i =="; cat $i; done; exit $rc)
 
-  greatawk:
-    # Tests with: GCC, -O3, oldest supported Ubuntu (in non-extended support)
-    name: GCC -O3
+  puffin:
+    # Tests with: GCC, -O3, very latest CMake, libedit
+    name: GCC -O3, CMake
     runs-on: ubuntu-latest
-    container: ubuntu:22.04
-    if: github.event_name != 'workflow_dispatch' || (inputs.job_id == 'all' || inputs.job_id == 'greatawk')
+    if: github.event_name != 'workflow_dispatch' || (inputs.job_id == 'all' || inputs.job_id == 'puffin')
     steps:
       - name: Setup
         run: |
-          echo "set man-db/auto-update false" | debconf-communicate && dpkg-reconfigure man-db
-          export DEBIAN_FRONTEND=noninteractive TZ=Etc/UTC
-          apt-get -qq update
-          apt-get -qq install -y git build-essential cmake
+          echo "set man-db/auto-update false" | sudo debconf-communicate && sudo dpkg-reconfigure man-db
+          sudo apt-get -qq update
+          sudo apt-get -qq install -y git build-essential cmake zlib1g-dev libbz2-dev libedit-dev
 
       - name: Checkout
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           submodules: true
 
+      - name: Check latest CMake
+        id: get-cmake-ver
+        run: |
+          CMAKE_VER=$(curl -s https://api.github.com/repos/Kitware/CMake/releases/latest | jq -r '.tag_name' | sed 's/^v//')
+          if ! echo "$CMAKE_VER" | grep -qE '^[0-9]+\.[0-9]+\.[0-9]+$' ; then
+            echo "Extracted CMake version: '$CMAKE_VER'" >&2
+            echo "This does not match the expected version format" >&2
+            exit 1
+          fi
+          echo "CMAKE_VER=$CMAKE_VER" >> $GITHUB_OUTPUT
+          echo "CMAKE_VER=$CMAKE_VER" >> $GITHUB_ENV
+          echo "Latest CMake version is $CMAKE_VER"
+
+      - name: Cache CMake
+        uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0
+        with:
+          key: cmake-${{ steps.get-cmake-ver.outputs.CMAKE_VER }}-linux-x86_64
+          path: cmake-${{ steps.get-cmake-ver.outputs.CMAKE_VER }}-linux-x86_64.tar.gz
+
+      - name: Install CMake
+        run: |
+          [ -f cmake-${CMAKE_VER}-linux-x86_64.tar.gz ] || curl -L -S -O "https://github.com/Kitware/CMake/releases/download/v${CMAKE_VER}/cmake-${CMAKE_VER}-linux-x86_64.tar.gz"
+          tar -xz -f cmake-${CMAKE_VER}-linux-x86_64.tar.gz -C "$RUNNER_TEMP"
+          realpath "$RUNNER_TEMP/cmake-${CMAKE_VER}-linux-x86_64/bin" >> "$GITHUB_PATH"
+
       - name: Configure
-        run: cmake $CMAKE_FLAGS -DPCRE2_SUPPORT_JIT=ON -DPCRE2_BUILD_PCRE2_16=ON -DPCRE2_BUILD_PCRE2_32=ON -DBUILD_SHARED_LIBS=ON -DBUILD_STATIC_LIBS=ON -DPCRE2_DEBUG=ON -DCMAKE_C_FLAGS="$CFLAGS_GCC_STYLE" -DCMAKE_COMPILE_WARNING_AS_ERROR=ON -DCMAKE_BUILD_TYPE=Release -B build
+        run: |
+          cmake --version | grep "version ${CMAKE_VER}" || (echo "CMake version mismatch" && exit 1)
+          cmake $CMAKE_FLAGS -DPCRE2_SUPPORT_JIT=ON -DPCRE2_BUILD_PCRE2_16=ON -DPCRE2_BUILD_PCRE2_32=ON -DBUILD_SHARED_LIBS=ON -DBUILD_STATIC_LIBS=ON -DPCRE2_DEBUG=ON -DPCRE2_SUPPORT_LIBEDIT=ON -DPCRE2_SUPPORT_LIBREADLINE=OFF -DCMAKE_C_FLAGS="$CFLAGS_GCC_STYLE" -DCMAKE_POLICY_VERSION_MINIMUM=$CMAKE_VER -DCMAKE_COMPILE_WARNING_AS_ERROR=ON -DCMAKE_BUILD_TYPE=Release -B build
 
       - name: Build
         run: cd build && make -j3
@@ -251,9 +277,88 @@ jobs:
           maint/RunManifestTest install-dir maint/manifest-makeinstall-linux
           maint/RunSymbolTest install-dir/usr/local/lib/ maint/
 
+  greatawk:
+    # Tests with: GCC, -O2, oldest supported Ubuntu (in non-extended support)
+    name: GCC -O2, old CMake
+    runs-on: ubuntu-latest
+    container: ubuntu:22.04
+    if: github.event_name != 'workflow_dispatch' || (inputs.job_id == 'all' || inputs.job_id == 'greatawk')
+    steps:
+      - name: Setup
+        run: |
+          echo "set man-db/auto-update false" | debconf-communicate && dpkg-reconfigure man-db
+          export DEBIAN_FRONTEND=noninteractive TZ=Etc/UTC
+          apt-get -qq update
+          apt-get -qq install -y git build-essential cmake zlib1g-dev libbz2-dev libreadline-dev
+
+      - name: Checkout
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          submodules: true
+
+      - name: Configure
+        run: cmake $CMAKE_FLAGS -DPCRE2_SUPPORT_JIT=ON -DPCRE2_BUILD_PCRE2_16=ON -DPCRE2_BUILD_PCRE2_32=ON -DBUILD_SHARED_LIBS=ON -DBUILD_STATIC_LIBS=ON -DPCRE2_DEBUG=ON -DCMAKE_C_FLAGS="$CFLAGS_GCC_STYLE" -DCMAKE_COMPILE_WARNING_AS_ERROR=ON -DCMAKE_BUILD_TYPE=RelWithDebInfo -B build
+
+      - name: Build
+        run: cd build && make -j3
+
+      - name: Test
+        run: cd build && ctest -j3 --output-on-failure && (cat ./Testing/Temporary/LastTest.log || true)
+
+      - name: Install
+        run: |
+          cd build
+          cmake --install . --prefix install-dir
+          ../maint/RunManifestTest install-dir ../maint/manifest-cmakeinstall-linux relwithdebinfo
+          ../maint/RunSymbolTest install-dir/lib/ ../maint/
+
+      - name: Test CMake install interface
+        run: |
+          INSTALL_PREFIX=`pwd`/build/install-dir
+          cd maint/cmake-tests/install-interface
+
+          for useStaticLibs in ON OFF; do
+            echo "== Testing CMake install interface with PCRE2_USE_STATIC_LIBS=$useStaticLibs =="
+            rm -rf build
+            cmake $CMAKE_FLAGS -DCMAKE_BUILD_TYPE=RelWithDebInfo -DCMAKE_PREFIX_PATH="$INSTALL_PREFIX" -DPCRE2_USE_STATIC_LIBS=$useStaticLibs -B build
+            (cd build; make)
+            ./build/test_executable
+            ldd ./build/test_executable
+            if [ $useStaticLibs = ON ]; then
+              (ldd ./build/test_executable | grep -q "pcre2") && (echo "Error: PCRE2 found in ldd output" && exit 1)
+            else
+              # Test that the shared library is actually linked in
+              (ldd ./build/test_executable | grep -q "$INSTALL_PREFIX/lib/libpcre2-8.so.0") || (echo "Error: Shared library not linked in" && exit 1)
+            fi
+          done
+
+      - name: Test CMake build interface
+        run: |
+          BUILD_DIR=`pwd`
+          cp -rp maint/cmake-tests/build-interface ../cmake-tests-build-interface
+          cd ../cmake-tests-build-interface
+          ln -s "$BUILD_DIR" pcre2
+
+          for buildLibs in "ON;OFF" "OFF;ON"; do
+            static=`echo $buildLibs | cut -d';' -f1`
+            shared=`echo $buildLibs | cut -d';' -f2`
+            echo "== Testing CMake build interface with BUILD_STATIC_LIBS=$static and BUILD_SHARED_LIBS=$shared =="
+            rm -rf build
+            cmake $CMAKE_FLAGS -DCMAKE_BUILD_TYPE=Debug -DBUILD_STATIC_LIBS=$static -DBUILD_SHARED_LIBS=$shared -B build
+            (cd build; make)
+            ./build/test_executable
+            ldd ./build/test_executable
+            if [ $static = ON ]; then
+              (ldd ./build/test_executable | grep -q "pcre2") && (echo "Error: PCRE2 found in ldd output" && exit 1)
+            else
+              # Test that the shared library is actually linked in
+              (ldd ./build/test_executable | grep -q "`pwd`/build/pcre2/libpcre2-8.so.0") || (echo "Error: Shared library not linked in" && exit 1)
+            fi
+          done
+
   wasp:
     # Tests with: French locale; oldest supported CMake; no JIT; -Os; libreadline
-    name: GCC -Os, CMake+ninja, no JIT
+    name: GCC -Os, very old CMake, ninja, no JIT
     runs-on: ubuntu-latest
     if: github.event_name != 'workflow_dispatch' || (inputs.job_id == 'all' || inputs.job_id == 'wasp')
     env:
@@ -263,7 +368,7 @@ jobs:
         run: |
           echo "set man-db/auto-update false" | sudo debconf-communicate && sudo dpkg-reconfigure man-db
           sudo apt-get -qq update
-          sudo apt-get -qq install -y language-pack-fr ninja-build libreadline-dev
+          sudo apt-get -qq install -y language-pack-fr ninja-build zlib1g-dev libbz2-dev libreadline-dev
 
       - name: Checkout
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
@@ -274,14 +379,13 @@ jobs:
         uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0
         with:
           key: cmake-${{ env.CMAKE_VER }}-Linux-x86_64
-          path: ../cmake-${{ env.CMAKE_VER }}-Linux-x86_64.tar.gz
+          path: cmake-${{ env.CMAKE_VER }}-Linux-x86_64.tar.gz
 
       - name: Install CMake
         run: |
-          cd ..
           [ -f cmake-${CMAKE_VER}-Linux-x86_64.tar.gz ] || curl -L -S -O "https://github.com/Kitware/CMake/releases/download/v${CMAKE_VER}/cmake-${CMAKE_VER}-Linux-x86_64.tar.gz"
-          tar -xz -f cmake-${CMAKE_VER}-Linux-x86_64.tar.gz
-          realpath "cmake-${CMAKE_VER}-Linux-x86_64/bin" >> "$GITHUB_PATH"
+          tar -xz -f cmake-${CMAKE_VER}-Linux-x86_64.tar.gz -C "$RUNNER_TEMP"
+          realpath "$RUNNER_TEMP/cmake-${CMAKE_VER}-Linux-x86_64/bin" >> "$GITHUB_PATH"
 
       - name: Configure
         run: |
@@ -511,7 +615,7 @@ jobs:
           install: |
             echo "set man-db/auto-update false" | debconf-communicate && dpkg-reconfigure man-db
             apt-get -qq update
-            apt-get -qq install -y gcc cmake ninja-build zlib1g-dev libbz2-dev
+            apt-get -qq install -y gcc cmake ninja-build zlib1g-dev libbz2-dev libreadline-dev
 
           run: |
             set -e

CMakeLists.txt

@@ -146,7 +146,7 @@ endif()
 # setting CMAKE_MODULE_PATH on the command line.
 list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)
 
-# external packages
+# External packages
 find_package(BZip2)
 find_package(ZLIB)
 find_package(Readline)
@@ -446,7 +446,7 @@ if(HAVE_VSCRIPT)
 endif()
 
 # bzip2 lib
-if(BZIP2_FOUND)
+if(BZip2_FOUND)
   option(PCRE2_SUPPORT_LIBBZ2 "Enable support for linking pcre2grep with libbz2." ON)
 endif()
 
@@ -456,12 +456,12 @@ if(ZLIB_FOUND)
 endif()
 
 # editline lib
-if(EDITLINE_FOUND)
+if(Editline_FOUND)
   option(PCRE2_SUPPORT_LIBEDIT "Enable support for linking pcre2test with libedit." OFF)
 endif()
 
 # readline lib
-if(READLINE_FOUND)
+if(Readline_FOUND)
   option(PCRE2_SUPPORT_LIBREADLINE "Enable support for linking pcre2test with libreadline." ON)
 endif()
 
@@ -498,55 +498,55 @@ if(PCRE2_BUILD_PCRE2GREP AND NOT PCRE2_BUILD_PCRE2_8)
 endif()
 
 if(PCRE2_SUPPORT_LIBBZ2)
-  if(BZIP2_FOUND)
-    include_directories(${BZIP2_INCLUDE_DIR})
+  if(BZip2_FOUND)
+    include_directories(${BZIP2_INCLUDE_DIRS})
   else()
     message(
       FATAL_ERROR
-      " libbz2 not found. Set BZIP2_INCLUDE_DIR to a compatible header\n"
+      " libbz2 not found. Set BZIP2_INCLUDE_DIRS to a compatible header\n"
       " or set BZip2_ROOT to a full bzip2 installed tree, as needed."
     )
   endif()
 endif()
 
 if(PCRE2_SUPPORT_LIBZ)
   if(ZLIB_FOUND)
-    include_directories(${ZLIB_INCLUDE_DIR})
+    include_directories(${ZLIB_INCLUDE_DIRS})
   else()
     message(
       FATAL_ERROR
-      " zlib not found. Set ZLIB_INCLUDE_DIR to a compatible header\n"
+      " zlib not found. Set ZLIB_INCLUDE_DIRS to a compatible header\n"
       " or set ZLIB_ROOT to a full zlib installed tree, as needed."
     )
   endif()
 endif()
 
 if(PCRE2_SUPPORT_LIBEDIT)
-  if(EDITLINE_FOUND)
-    include_directories(${EDITLINE_INCLUDE_DIR})
+  if(Editline_FOUND)
+    include_directories(${EDITLINE_INCLUDE_DIRS})
   else()
     message(
       FATAL_ERROR
-      " libedit not found. Set EDITLINE_INCLUDE_DIR to a compatible header\n"
+      " libedit not found. Set EDITLINE_INCLUDE_DIRS to a compatible header\n"
       " or set Editline_ROOT to a full libedit installed tree, as needed."
     )
   endif()
 endif()
 
 if(PCRE2_SUPPORT_LIBREADLINE)
-  if(READLINE_FOUND)
-    include_directories(${READLINE_INCLUDE_DIR})
+  if(Readline_FOUND)
+    include_directories(${READLINE_INCLUDE_DIRS})
   else()
     message(
       FATAL_ERROR
-      " libreadline not found. Set READLINE_INCLUDE_DIR to a compatible header\n"
+      " libreadline not found. Set READLINE_INCLUDE_DIRS to a compatible header\n"
       " or set Readline_ROOT to a full libreadline installed tree, as needed."
     )
   endif()
 endif()
 
 if(PCRE2_SUPPORT_LIBREADLINE AND PCRE2_SUPPORT_LIBEDIT)
-  if(READLINE_FOUND)
+  if(Readline_FOUND)
     message(
       FATAL_ERROR
       " Only one of the readline compatible libraries can be enabled.\n"
@@ -603,24 +603,16 @@ endif()
 set(PCRE2TEST_LIBS)
 set(PCRE2GREP_LIBS)
 
-# This next one used to reference ${READLINE_LIBRARY})
-# but I was advised to add the NCURSES test as well, along with
-# some modifications to cmake/FindReadline.cmake which should
-# make it possible to override the default if necessary. PH
-
 if(PCRE2_SUPPORT_LIBREADLINE)
   set(SUPPORT_LIBREADLINE 1)
-  list(APPEND PCRE2TEST_LIBS ${READLINE_LIBRARY})
-  if(DEFINED NCURSES_LIBRARY)
-    list(APPEND PCRE2TEST_LIBS ${NCURSES_LIBRARY})
-  endif()
+  list(APPEND PCRE2TEST_LIBS ${READLINE_LIBRARIES})
 endif()
 
 # libedit is a plug-compatible alternative to libreadline
 
 if(PCRE2_SUPPORT_LIBEDIT)
   set(SUPPORT_LIBEDIT 1)
-  list(APPEND PCRE2TEST_LIBS ${EDITLINE_LIBRARY})
+  list(APPEND PCRE2TEST_LIBS ${EDITLINE_LIBRARIES})
 endif()
 
 if(PCRE2_SUPPORT_LIBZ)
@@ -1589,17 +1581,17 @@ if(PCRE2_SHOW_REPORT)
   else()
     message(STATUS "  Link pcre2grep with libz .......... : Library not found")
   endif()
-  if(BZIP2_FOUND)
+  if(BZip2_FOUND)
     message(STATUS "  Link pcre2grep with libbz2 ........ : ${PCRE2_SUPPORT_LIBBZ2}")
   else()
     message(STATUS "  Link pcre2grep with libbz2 ........ : Library not found")
   endif()
-  if(EDITLINE_FOUND)
+  if(Editline_FOUND)
     message(STATUS "  Link pcre2test with libeditline ... : ${PCRE2_SUPPORT_LIBEDIT}")
   else()
     message(STATUS "  Link pcre2test with libeditline ... : Library not found")
   endif()
-  if(READLINE_FOUND)
+  if(Readline_FOUND)
     message(STATUS "  Link pcre2test with libreadline ... : ${PCRE2_SUPPORT_LIBREADLINE}")
   else()
     message(STATUS "  Link pcre2test with libreadline ... : Library not found")

cmake/FindEditline.cmake

@@ -8,3 +8,8 @@ mark_as_advanced(EDITLINE_LIBRARY)
 
 include(FindPackageHandleStandardArgs)
 find_package_handle_standard_args(Editline DEFAULT_MSG EDITLINE_LIBRARY EDITLINE_INCLUDE_DIR)
+
+if(Editline_FOUND)
+  set(EDITLINE_LIBRARIES "${EDITLINE_LIBRARY}")
+  set(EDITLINE_INCLUDE_DIRS "${EDITLINE_INCLUDE_DIR}")
+endif()

cmake/FindReadline.cmake

@@ -16,6 +16,11 @@ if(READLINE_INCLUDE_DIR AND READLINE_LIBRARY)
   include(CheckSymbolExists)
   include(CMakePushCheckState)
 
+  set(first_run FALSE)
+  if(NOT DEFINED HAVE_READLINE_FUNC)
+    set(first_run TRUE)
+  endif()
+
   cmake_push_check_state(RESET)
   set(CMAKE_REQUIRED_LIBRARIES "${READLINE_LIBRARY}")
   set(CMAKE_REQUIRED_INCLUDES "${READLINE_INCLUDE_DIR}")
@@ -36,7 +41,9 @@ if(READLINE_INCLUDE_DIR AND READLINE_LIBRARY)
         check_symbol_exists("readline" "stdio.h;readline/readline.h" HAVE_READLINE_FUNC_${lib})
 
         if(HAVE_READLINE_FUNC_${lib})
-          message(STATUS "Looking for readline - readline needs ${lib}")
+          if(first_run)
+            message(STATUS "Looking for readline - readline needs ${lib}")
+          endif()
           set(NCURSES_LIBRARY "${NCURSES_LIBRARY_${lib}}" CACHE FILEPATH "Path to the ncurses library")
           mark_as_advanced(NCURSES_LIBRARY)
           break()
@@ -50,3 +57,11 @@ endif()
 
 include(FindPackageHandleStandardArgs)
 find_package_handle_standard_args(Readline DEFAULT_MSG READLINE_LIBRARY READLINE_INCLUDE_DIR)
+
+if(Readline_FOUND)
+  set(READLINE_LIBRARIES "${READLINE_LIBRARY}")
+  if(DEFINED NCURSES_LIBRARY)
+    list(APPEND READLINE_LIBRARIES "${NCURSES_LIBRARY}")
+  endif()
+  set(READLINE_INCLUDE_DIRS "${READLINE_INCLUDE_DIR}")
+endif()