File 0002-cmake-Improve-FindPoDoFo.patch of Package krename
From 8544fc544b76b4b29dd26d29d4449c40b538c0df Mon Sep 17 00:00:00 2001
From: Heiko Becker <heiko.becker@kde.org>
Date: Sat, 15 Jul 2023 18:20:06 +0200
Subject: [PATCH] cmake: Improve FindPoDoFo
Add some rst based documentation and provide an imported target for
example.
I've dropped -DUSING_SHARED_PODOFO, which looks weird nowadays and
seems to exist because of Windows, which I can't test. So comment it out
for now, but it'll probably be removed in the future, if nobody turns up
who cares about Windows and can comment on it.
---
CMakeLists.txt | 5 +-
cmake/modules/FindPoDoFo.cmake | 195 ++++++++++++++++++++-------------
src/CMakeLists.txt | 7 +-
3 files changed, 118 insertions(+), 89 deletions(-)
diff --git a/CMakeLists.txt b/CMakeLists.txt
index a696009..10de0a5 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -59,10 +59,7 @@ set_package_properties(LibExiv2 PROPERTIES TYPE OPTIONAL)
# Find podofo
find_package(PoDoFo)
-set_package_properties(PoDoFo PROPERTIES
- DESCRIPTION "A library to access PDF metadata"
- URL "http://podofo.sourceforge.net/"
- TYPE OPTIONAL)
+set_package_properties(PoDoFo PROPERTIES TYPE OPTIONAL)
# Find freetype
find_package(Freetype)
diff --git a/cmake/modules/FindPoDoFo.cmake b/cmake/modules/FindPoDoFo.cmake
index c771149..27aa6ee 100644
--- a/cmake/modules/FindPoDoFo.cmake
+++ b/cmake/modules/FindPoDoFo.cmake
@@ -1,86 +1,123 @@
-# - Try to find the PoDoFo library
+# SPDX-FileCopyrightText: 2016 Pino Toscano <pino@kde.org>
+# SPDX-FileCopyrightText: 2023 Heiko Becker <heiko.becker@kde.org>
#
-# Windows users MUST set when building:
-#
-# PoDoFo_USE_SHARED - whether use PoDoFo as shared library
-#
-# Once done this will define:
-#
-# PoDoFo_FOUND - system has the PoDoFo library
-# PoDoFo_INCLUDE_DIRS - the PoDoFo include directory
-# PoDoFo_LIBRARIES - the libraries needed to use PoDoFo
-# PoDoFo_DEFINITIONS - the definitions needed to use PoDoFo
-#
-# Copyright 2016 Pino Toscano <pino@kde.org>
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions
-# are met:
-#
-# 1. Redistributions of source code must retain the copyright
-# notice, this list of conditions and the following disclaimer.
-# 2. Redistributions in binary form must reproduce the copyright
-# notice, this list of conditions and the following disclaimer in the
-# documentation and/or other materials provided with the distribution.
-# 3. The name of the author may not be used to endorse or promote products
-# derived from this software without specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
-
-include(FindPkgConfig)
-pkg_search_module(PoDoFo libpodofo libpodofo-0)
-
-set(PoDoFo_DEFINITIONS)
-if(PoDoFo_FOUND)
- if(WIN32)
- if(NOT DEFINED PoDoFo_USE_SHARED)
- message(SEND_ERROR "Win32 users MUST set PoDoFo_USE_SHARED")
- message(SEND_ERROR "Set -DPoDoFo_USE_SHARED=0 if linking to a static library PoDoFo")
- message(SEND_ERROR "or -DPoDoFo_USE_SHARED=1 if linking to a DLL build of PoDoFo")
- message(FATAL_ERROR "PoDoFo_USE_SHARED unset on win32 build")
- else()
- if(PoDoFo_USE_SHARED)
- set(PoDoFo_DEFINITIONS "${PoDoFo_DEFINITIONS} -DUSING_SHARED_PODOFO")
- endif(PoDoFo_USE_SHARED)
- endif()
- endif()
-
- find_file(PoDoFo_CONFIG podofo_config.h PATHS ${PoDoFo_INCLUDE_DIRS} PATH_SUFFIXES auxiliary base)
- file(STRINGS "${PoDoFo_CONFIG}" PoDoFo_MAJOR_VER_LINE REGEX "^#define[ \t]+PODOFO_VERSION_MAJOR[ \t]+[0-9]+$")
- file(STRINGS "${PoDoFo_CONFIG}" PoDoFo_MINOR_VER_LINE REGEX "^#define[ \t]+PODOFO_VERSION_MINOR[ \t]+[0-9]+$")
- file(STRINGS "${PoDoFo_CONFIG}" PoDoFo_PATCH_VER_LINE REGEX "^#define[ \t]+PODOFO_VERSION_PATCH[ \t]+[0-9]+$")
- string(REGEX REPLACE "^#define[ \t]+PODOFO_VERSION_MAJOR[ \t]+([0-9]+)$" "\\1" PoDoFo_MAJOR_VER "${PoDoFo_MAJOR_VER_LINE}")
- string(REGEX REPLACE "^#define[ \t]+PODOFO_VERSION_MINOR[ \t]+([0-9]+)$" "\\1" PoDoFo_MINOR_VER "${PoDoFo_MINOR_VER_LINE}")
- string(REGEX REPLACE "^#define[ \t]+PODOFO_VERSION_PATCH[ \t]+([0-9]+)$" "\\1" PoDoFo_PATCH_VER "${PoDoFo_PATCH_VER_LINE}")
- set(PoDoFo_VERSION "${PoDoFo_MAJOR_VER}.${PoDoFo_MINOR_VER}.${PoDoFo_PATCH_VER}")
-
- # PoDoFo-0.9.5 unconditionally includes openssl/opensslconf.h in a public
- # header. The fix is in https://sourceforge.net/p/podofo/code/1830/ and will
- # hopefully be released soon with 0.9.6. Note that krename doesn't use
- # OpenSSL in any way.
- if(PoDoFo_VERSION VERSION_EQUAL "0.9.5")
- find_package(OpenSSL)
- if (OpenSSL_FOUND)
- message("OpenSSL found, which is required for this version of PoDofo (0.9.5)")
- set(PoDoFo_INCLUDE_DIRS ${PoDoFo_INCLUDE_DIRS} ${OPENSSL_INCLUDE_DIR})
- else()
- unset(PoDoFo_FOUND)
- message("OpenSSL NOT found, which is required for this version of PoDofo (0.9.5)")
+# SPDX-License-Identifier: BSD-3-Clause
+
+
+#[=======================================================================[.rst:
+FindPoDoFo
+------------
+
+Try to find PoDoFo, a C++ library to work with the PDF file format
+
+This will define the following variables:
+
+``PoDoFo_FOUND``
+ True if PoDoFo is available
+``PoDoFo_VERSION``
+ The version of PoDoFo
+``PoDoFo_LIBRARIES``
+ The libraries of PoDoFofor use with target_link_libraries()
+``PoDoFo_INCLUDE_DIRS``
+ The include dirs of PoDoFo for use with target_include_directories()
+
+If ``PoDoFo_FOUND`` is TRUE, it will also define the following imported
+target:
+
+``PoDoFo::PoDoFo``
+ The PoDoFo library
+
+In general we recommend using the imported target, as it is easier to use.
+Bear in mind, however, that if the target is in the link interface of an
+exported library, it must be made available by the package config file.
+
+#]=======================================================================]
+
+find_package(PkgConfig QUIET)
+pkg_search_module(PC_PoDoFo QUIET libpodofo libpodofo-0)
+
+find_library(PoDoFo_LIBRARIES
+ NAMES podofo
+ HINTS ${PC_PoDoFo_LIBRARY_DIRS}
+)
+
+find_path(PoDoFo_INCLUDE_DIRS
+ NAMES podofo.h
+ HINTS ${PC_PoDoFo_INCLUDE_DIRS}
+)
+
+if(PoDoFo_INCLUDE_DIRS)
+ # NOTE: I have no idea if that's still needed and no possibility to test on
+ # Windows.
+ #if(WIN32)
+ # if(NOT DEFINED PoDoFo_USE_SHARED)
+ # message(SEND_ERROR "Win32 users MUST set PoDoFo_USE_SHARED")
+ # message(SEND_ERROR "Set -DPoDoFo_USE_SHARED=0 if linking to a static library PoDoFo")
+ # message(SEND_ERROR "or -DPoDoFo_USE_SHARED=1 if linking to a DLL build of PoDoFo")
+ # message(FATAL_ERROR "PoDoFo_USE_SHARED unset on win32 build")
+ # else()
+ # if(PoDoFo_USE_SHARED)
+ # set(PoDoFo_DEFINITIONS "${PoDoFo_DEFINITIONS} -DUSING_SHARED_PODOFO")
+ # endif(PoDoFo_USE_SHARED)
+ # endif()
+ #endif()
+
+ find_file(PoDoFo_CONFIG podofo_config.h PATHS ${PoDoFo_INCLUDE_DIRS} PATH_SUFFIXES auxiliary base)
+ file(STRINGS "${PoDoFo_CONFIG}" PoDoFo_MAJOR_VER_LINE REGEX "^#define[ \t]+PODOFO_VERSION_MAJOR[ \t]+[0-9]+$")
+ file(STRINGS "${PoDoFo_CONFIG}" PoDoFo_MINOR_VER_LINE REGEX "^#define[ \t]+PODOFO_VERSION_MINOR[ \t]+[0-9]+$")
+ file(STRINGS "${PoDoFo_CONFIG}" PoDoFo_PATCH_VER_LINE REGEX "^#define[ \t]+PODOFO_VERSION_PATCH[ \t]+[0-9]+$")
+ string(REGEX REPLACE "^#define[ \t]+PODOFO_VERSION_MAJOR[ \t]+([0-9]+)$" "\\1" PoDoFo_MAJOR_VER "${PoDoFo_MAJOR_VER_LINE}")
+ string(REGEX REPLACE "^#define[ \t]+PODOFO_VERSION_MINOR[ \t]+([0-9]+)$" "\\1" PoDoFo_MINOR_VER "${PoDoFo_MINOR_VER_LINE}")
+ string(REGEX REPLACE "^#define[ \t]+PODOFO_VERSION_PATCH[ \t]+([0-9]+)$" "\\1" PoDoFo_PATCH_VER "${PoDoFo_PATCH_VER_LINE}")
+ set(PoDoFo_VERSION "${PoDoFo_MAJOR_VER}.${PoDoFo_MINOR_VER}.${PoDoFo_PATCH_VER}")
+
+ # PoDoFo-0.9.5 unconditionally includes openssl/opensslconf.h in a public
+ # header. The fix is in https://sourceforge.net/p/podofo/code/1830/ and will
+ # hopefully be released soon with 0.9.6. Note that krename doesn't use
+ # OpenSSL in any way.
+ if(PoDoFo_VERSION VERSION_EQUAL "0.9.5")
+ find_package(OpenSSL)
+ if(OpenSSL_FOUND)
+ message("OpenSSL found, which is required for this version of PoDofo (0.9.5)")
+ set(PoDoFo_INCLUDE_DIRS ${PoDoFo_INCLUDE_DIRS} ${OPENSSL_INCLUDE_DIR})
+ else()
+ unset(PoDoFo_FOUND)
+ message("OpenSSL NOT found, which is required for this version of PoDofo (0.9.5)")
+ endif()
endif()
- endif()
endif()
if(PoDoFo_VERSION VERSION_GREATER_EQUAL 0.10.0)
- set(CMAKE_CXX_STANDARD 17)
+ set(CMAKE_CXX_STANDARD 17)
endif()
-mark_as_advanced(PoDoFo_INCLUDE_DIRS PoDoFo_LIBRARIES PoDoFo_DEFINITIONS)
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(PoDoFo
+ FOUND_VAR
+ PoDoFo_FOUND
+ REQUIRED_VARS
+ PoDoFo_LIBRARIES
+ PoDoFo_INCLUDE_DIRS
+ VERSION_VAR
+ PoDoFo_VERSION
+)
+
+if(PoDoFo_FOUND AND NOT TARGET PoDoFo::PoDoFo)
+ add_library(PoDoFo::PoDoFo UNKNOWN IMPORTED)
+ set_target_properties(PoDoFo::PoDoFo PROPERTIES
+ IMPORTED_LOCATION "${PoDoFo_LIBRARIES}"
+ INTERFACE_COMPILE_OPTIONS "${PC_PoDoFo_CFLAGS}"
+ INTERFACE_INCLUDE_DIRECTORIES "${PoDoFo_INCLUDE_DIRS}"
+ )
+ if(TARGET PkgConfig::PC_PoDoFo)
+ target_link_libraries(PoDoFo::PoDoFo INTERFACE PkgConfig::PC_PoDoFo)
+ endif()
+endif()
+
+mark_as_advanced(PoDoFo_LIBRARIES PoDoFo_INCLUDE_DIRS PoDoFo_VERSION)
+
+include(FeatureSummary)
+set_package_properties(PoDoFo PROPERTIES
+ DESCRIPTION "A C++ libary to work with the PDF file format"
+ URL "https://github.com/podofo/podofo"
+)
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
index 631d852..cb606af 100644
--- a/src/CMakeLists.txt
+++ b/src/CMakeLists.txt
@@ -14,11 +14,6 @@ if(EXIV2_FOUND)
include_directories(${EXIV2_INCLUDE_DIR})
endif()
-if(PoDoFo_FOUND)
- include_directories(${PoDoFo_INCLUDE_DIRS})
- add_definitions(${PoDoFo_DEFINITIONS})
-endif()
-
if(FREETYPE_FOUND)
include_directories(${FREETYPE_INCLUDE_DIRS})
endif()
@@ -137,7 +132,7 @@ if(LibExiv2_FOUND)
endif()
if(PoDoFo_FOUND)
target_link_libraries(krename
- ${PoDoFo_LIBRARIES}
+ PoDoFo::PoDoFo
)
endif()
if(FREETYPE_FOUND)
--
2.41.0