aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--.idea/.gitignore1
-rw-r--r--CMakeLists.txt2
-rw-r--r--ChangeLog20
-rw-r--r--appimage/Dockerfile12
-rwxr-xr-xappimage/build-appimage4
-rw-r--r--examples/CMakeLists.txt7
-rw-r--r--examples/extend-c-api-impl.cc29
-rw-r--r--examples/extend-c-api.c67
-rw-r--r--examples/extend-c-api.h25
-rw-r--r--examples/qtest/extend-c-api.test30
-rw-r--r--examples/qtest/extend-c-api/bad.out5
-rw-r--r--examples/qtest/extend-c-api/bad.pdf1
-rw-r--r--examples/qtest/extend-c-api/good.out1
-rw-r--r--examples/qtest/extend-c-api/good.pdf64
-rw-r--r--include/qpdf/DLL.h6
-rw-r--r--include/qpdf/qpdf-c.h33
-rw-r--r--job.sums2
-rw-r--r--libqpdf/CMakeLists.txt2
-rw-r--r--libqpdf/qpdf-c.cc12
-rw-r--r--manual/cli.rst4
-rw-r--r--manual/conf.py2
-rw-r--r--manual/release-notes.rst19
22 files changed, 326 insertions, 22 deletions
diff --git a/.idea/.gitignore b/.idea/.gitignore
index 13566b81..55b97637 100644
--- a/.idea/.gitignore
+++ b/.idea/.gitignore
@@ -6,3 +6,4 @@
# Datasource local storage ignored files
/dataSources/
/dataSources.local.xml
+/inspectionProfiles
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 3e9f47a0..31ee01ef 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -5,7 +5,7 @@ cmake_minimum_required(VERSION 3.16)
# the project line. When updating the version, check make_dist for all
# the places it has to be updated.
project(qpdf
- VERSION 11.6.3
+ VERSION 11.7.0
LANGUAGES C CXX)
# Enable correct rpath handling for MacOSX
diff --git a/ChangeLog b/ChangeLog
index 696a3567..19be25a3 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,23 @@
+2023-12-16 Jay Berkenbilt <ejb@ql.org>
+
+ * Add new C++ functions "qpdf_c_get_qpdf" and "qpdf_c_wrap" to
+ qpdf-c.h that make it possible to write your own extern "C"
+ functions in C++ that interoperate with the C API. See
+ examples/extend-c-api for more information.
+
+2023-12-10 Jay Berkenbilt <ejb@ql.org>
+
+ * 11.6.4: release
+
+2023-12-09 Jay Berkenbilt <ejb@ql.org>
+
+ * Install fix: include cmake files with the dev component.
+
+2023-11-20 Jay Berkenbilt <ejb@ql.org>
+
+ * Build AppImage with an older Linux distribution to support AWS
+ Lambda. Fixes #1086.
+
2023-10-15 Jay Berkenbilt <ejb@ql.org>
* 11.6.3: release
diff --git a/appimage/Dockerfile b/appimage/Dockerfile
index c1914144..24c9c672 100644
--- a/appimage/Dockerfile
+++ b/appimage/Dockerfile
@@ -1,13 +1,19 @@
-FROM ubuntu:20.04
+FROM ubuntu:18.04
ENV DEBIAN_FRONTEND=noninteractive
RUN apt-get update
RUN apt-get -y install screen git sudo \
- build-essential pkg-config cmake \
+ build-essential pkg-config \
zlib1g-dev libjpeg-dev libgnutls28-dev \
python3-pip texlive-latex-extra latexmk \
inkscape imagemagick busybox-static wget fuse && \
apt-get clean && rm -rf /var/lib/apt/lists/*
-RUN pip3 install sphinx sphinx_rtd_theme
+# Get cmake from pypi. We need to keep Ubuntu 18.04 for a while longer
+# since the glibc in Ubuntu 20.04 is too new (as of late 2023) for
+# Amazon Linux 2 in Lambda and for some supported CentOS versions.
+# When we are ready to update to 20.04 or newer, remove the version
+# constraint on sphinx, and install the OS package for cmake.
+RUN pip3 install --upgrade pip
+RUN pip3 install sphinx==4 sphinx_rtd_theme cmake
COPY entrypoint /entrypoint
RUN chmod +x /entrypoint
ENTRYPOINT [ "/entrypoint" ]
diff --git a/appimage/build-appimage b/appimage/build-appimage
index 0e86bff6..f970b7df 100755
--- a/appimage/build-appimage
+++ b/appimage/build-appimage
@@ -47,14 +47,14 @@ fi
_osversion=$(cat /etc/os-release | grep PRETTY_NAME | awk -F'=' '{print $2}' | sed 's#"##g')
# Warn users building the AppImage locally:
-if [[ ! $_osversion =~ Ubuntu\ 20.04.*\ LTS ]]; then
+if [[ ! $_osversion =~ Ubuntu\ 18.04.*\ LTS ]]; then
set +x
echo ""
# 0 1 2 3 4 5 6 7
# 01234567890123456789012345678901234567890123456789012345678901234567890123456789
echo "+===========================================================================+"
echo "|| WARNING: You are about to build a QPDF AppImage on a system which is ||"
- echo "|| NOT Ubuntu 20.04 LTS. ||"
+ echo "|| NOT Ubuntu 18.04 LTS. ||"
echo "|| ||"
echo "|| It is recommended that you use a distribution that is at least a ||"
echo "|| few years old to maximize the number of Linux distributions the ||"
diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt
index 9af85fe2..614047d5 100644
--- a/examples/CMakeLists.txt
+++ b/examples/CMakeLists.txt
@@ -34,6 +34,11 @@ foreach(PROG ${EXAMPLE_C_PROGRAMS})
endforeach()
target_include_directories(pdf-create PRIVATE ${JPEG_INCLUDE})
+# extend-c-api contains a mixture of C and C++ files.
+add_executable(extend-c-api extend-c-api-impl.cc extend-c-api.c)
+set_property(TARGET extend-c-api PROPERTY LINKER_LANGUAGE CXX)
+target_link_libraries(extend-c-api libqpdf)
+
add_test(
NAME examples
COMMAND ${RUN_QTEST}
@@ -47,7 +52,7 @@ add_test(
--tc "${qpdf_SOURCE_DIR}/examples/*.cc"
--tc "${qpdf_SOURCE_DIR}/examples/*.c")
-file(GLOB EXAMPLES_SRC "*.c" "*.cc")
+file(GLOB EXAMPLES_SRC "*.c" "*.cc" "*.h")
if(INSTALL_EXAMPLES)
install(FILES ${EXAMPLES_SRC}
DESTINATION ${CMAKE_INSTALL_DOCDIR}/examples
diff --git a/examples/extend-c-api-impl.cc b/examples/extend-c-api-impl.cc
new file mode 100644
index 00000000..680d957b
--- /dev/null
+++ b/examples/extend-c-api-impl.cc
@@ -0,0 +1,29 @@
+// This is an example of how to write C++ functions and make them usable with the qpdf C API. It
+// consists of three files:
+// - extend-c-api.h -- a plain C header file
+// - extend-c-api.c -- a C program that calls the function
+// - extend-c-api.cc -- a C++ file that implements the function
+
+#include "extend-c-api.h"
+
+// Here, we add a function to get the number of pages in a PDF file and make it callable through the
+// C API.
+
+// This is a normal C++ function that works with QPDF in a normal way. It doesn't do anything
+// special to be callable from C.
+int
+numPages(std::shared_ptr<QPDF> qpdf)
+{
+ return qpdf->getRoot().getKey("/Pages").getKey("/Count").getIntValueAsInt();
+}
+
+// Now we define the glue that makes our function callable using the C API.
+
+// This is the C++ implementation of the C function.
+QPDF_ERROR_CODE
+num_pages(qpdf_data qc, int* npages)
+{
+ // Call qpdf_c_wrap to convert any exception our function might through to a QPDF_ERROR_CODE
+ // and attach it to the qpdf_data object in the same way as other functions in the C API.
+ return qpdf_c_wrap(qc, [&qc, &npages]() { *npages = numPages(qpdf_c_get_qpdf(qc)); });
+}
diff --git a/examples/extend-c-api.c b/examples/extend-c-api.c
new file mode 100644
index 00000000..aa603845
--- /dev/null
+++ b/examples/extend-c-api.c
@@ -0,0 +1,67 @@
+/*
+ * This is an example of how to write C++ functions and make them usable with the qpdf C API. It
+ * consists of three files:
+ * - extend-c-api.h -- a plain C header file
+ * - extend-c-api.c -- a C program that calls the function
+ * - extend-c-api.cc -- a C++ file that implements the function
+ */
+
+#include "extend-c-api.h"
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+static char const* whoami = 0;
+
+static void
+usage()
+{
+ fprintf(stderr, "Usage: %s infile\n", whoami);
+ exit(2);
+}
+
+int
+main(int argc, char* argv[])
+{
+ char* infile = NULL;
+ qpdf_data qpdf = qpdf_init();
+ int warnings = 0;
+ int errors = 0;
+ char* p = NULL;
+
+ if ((p = strrchr(argv[0], '/')) != NULL) {
+ whoami = p + 1;
+ } else if ((p = strrchr(argv[0], '\\')) != NULL) {
+ whoami = p + 1;
+ } else {
+ whoami = argv[0];
+ }
+
+ if (argc != 2) {
+ usage();
+ }
+
+ infile = argv[1];
+
+ if ((qpdf_read(qpdf, infile, NULL) & QPDF_ERRORS) == 0) {
+ int npages;
+ if ((num_pages(qpdf, &npages) & QPDF_ERRORS) == 0) {
+ printf("num pages = %d\n", npages);
+ }
+ }
+ if (qpdf_more_warnings(qpdf)) {
+ warnings = 1;
+ }
+ if (qpdf_has_error(qpdf)) {
+ errors = 1;
+ printf("error: %s\n", qpdf_get_error_full_text(qpdf, qpdf_get_error(qpdf)));
+ }
+ qpdf_cleanup(&qpdf);
+ if (errors) {
+ return 2;
+ } else if (warnings) {
+ return 3;
+ }
+
+ return 0;
+}
diff --git a/examples/extend-c-api.h b/examples/extend-c-api.h
new file mode 100644
index 00000000..3b2d12d4
--- /dev/null
+++ b/examples/extend-c-api.h
@@ -0,0 +1,25 @@
+#ifndef EXAMPLE_C_EXTEND_H
+#define EXAMPLE_C_EXTEND_H
+
+/*
+ * This is an example of how to write C++ functions and make them usable with the qpdf C API. It
+ * consists of three files:
+ * - extend-c-api.h -- a plain C header file
+ * - extend-c-api.c -- a C program that calls the function
+ * - extend-c-api.cc -- a C++ file that implements the function
+ */
+#include <qpdf/qpdf-c.h>
+
+/* Declare your custom function to return QPDF_ERROR_CODE and take qpdf_data and anything else you
+ * need. Any errors are retrievable through the qpdf C APIs normal error-handling mechanism.
+ */
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+ QPDF_ERROR_CODE num_pages(qpdf_data qc, int* npages);
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* EXAMPLE_C_EXTEND_H */
diff --git a/examples/qtest/extend-c-api.test b/examples/qtest/extend-c-api.test
new file mode 100644
index 00000000..3dd82193
--- /dev/null
+++ b/examples/qtest/extend-c-api.test
@@ -0,0 +1,30 @@
+#!/usr/bin/env perl
+require 5.008;
+use warnings;
+use strict;
+
+chdir("extend-c-api") or die "chdir testdir failed: $!\n";
+
+require TestDriver;
+
+cleanup();
+
+my $td = new TestDriver('extend-c-api');
+
+$td->runtest("extend C API (good)",
+ {$td->COMMAND => "extend-c-api good.pdf"},
+ {$td->FILE => "good.out", $td->EXIT_STATUS => 0},
+ $td->NORMALIZE_NEWLINES);
+$td->runtest("extend C API (bad)",
+ {$td->COMMAND => "extend-c-api bad.pdf"},
+ {$td->FILE => "bad.out", $td->EXIT_STATUS => 2},
+ $td->NORMALIZE_NEWLINES);
+
+cleanup();
+
+$td->report(2);
+
+sub cleanup
+{
+ unlink "a.pdf";
+}
diff --git a/examples/qtest/extend-c-api/bad.out b/examples/qtest/extend-c-api/bad.out
new file mode 100644
index 00000000..51f1d56b
--- /dev/null
+++ b/examples/qtest/extend-c-api/bad.out
@@ -0,0 +1,5 @@
+WARNING: bad.pdf: can't find PDF header
+WARNING: bad.pdf: file is damaged
+WARNING: bad.pdf: can't find startxref
+WARNING: bad.pdf: Attempting to reconstruct cross-reference table
+error: bad.pdf: unable to find trailer dictionary while recovering damaged file
diff --git a/examples/qtest/extend-c-api/bad.pdf b/examples/qtest/extend-c-api/bad.pdf
new file mode 100644
index 00000000..a3d2d925
--- /dev/null
+++ b/examples/qtest/extend-c-api/bad.pdf
@@ -0,0 +1 @@
+not even a pdf file
diff --git a/examples/qtest/extend-c-api/good.out b/examples/qtest/extend-c-api/good.out
new file mode 100644
index 00000000..98205fae
--- /dev/null
+++ b/examples/qtest/extend-c-api/good.out
@@ -0,0 +1 @@
+num pages = 1
diff --git a/examples/qtest/extend-c-api/good.pdf b/examples/qtest/extend-c-api/good.pdf
new file mode 100644
index 00000000..42867b96
--- /dev/null
+++ b/examples/qtest/extend-c-api/good.pdf
@@ -0,0 +1,64 @@
+%PDF-2.0
+1 0 obj
+<<
+ /Pages 2 0 R
+ /Type /Catalog
+>>
+endobj
+2 0 obj
+<<
+ /Count 1
+ /Kids [
+ 3 0 R
+ ]
+ /Type /Pages
+>>
+endobj
+3 0 obj
+<<
+ /Contents 4 0 R
+ /MediaBox [ 0 0 612 792 ]
+ /Parent 2 0 R
+ /Resources <<
+ /Font << /F1 5 0 R >>
+ >>
+ /Type /Page
+>>
+endobj
+4 0 obj
+<<
+ /Length 44
+>>
+stream
+BT
+ /F1 24 Tf
+ 72 720 Td
+ (Potato) Tj
+ET
+endstream
+endobj
+5 0 obj
+<<
+ /BaseFont /Helvetica
+ /Encoding /WinAnsiEncoding
+ /Subtype /Type1
+ /Type /Font
+>>
+endobj
+
+xref
+0 6
+0000000000 65535 f
+0000000009 00000 n
+0000000062 00000 n
+0000000133 00000 n
+0000000277 00000 n
+0000000372 00000 n
+trailer <<
+ /Root 1 0 R
+ /Size 6
+ /ID [<42841c13bbf709d79a200fa1691836f8><b1d8b5838eeafe16125317aa78e666aa>]
+>>
+startxref
+478
+%%EOF
diff --git a/include/qpdf/DLL.h b/include/qpdf/DLL.h
index 74c3c62e..6dd5137e 100644
--- a/include/qpdf/DLL.h
+++ b/include/qpdf/DLL.h
@@ -25,9 +25,9 @@
/* The first version of qpdf to include the version constants is 10.6.0. */
#define QPDF_MAJOR_VERSION 11
-#define QPDF_MINOR_VERSION 6
-#define QPDF_PATCH_VERSION 3
-#define QPDF_VERSION "11.6.3"
+#define QPDF_MINOR_VERSION 7
+#define QPDF_PATCH_VERSION 0
+#define QPDF_VERSION "11.7.0"
/*
* This file defines symbols that control the which functions,
diff --git a/include/qpdf/qpdf-c.h b/include/qpdf/qpdf-c.h
index d4305602..f989ba15 100644
--- a/include/qpdf/qpdf-c.h
+++ b/include/qpdf/qpdf-c.h
@@ -21,21 +21,23 @@
#define QPDF_C_H
/*
- * This file defines a basic "C" API for qpdf. It provides access to a subset of the QPDF library's
+ * This file defines a basic "C" API for qpdf. It provides access to a subset of the QPDF library's
* capabilities to make them accessible to callers who can't handle calling C++ functions or working
- * with C++ classes. This may be especially useful to Windows users who are accessing the qpdf DLL
+ * with C++ classes. This may be especially useful to Windows users who are accessing the qpdf DLL
* directly or to other people programming in non-C/C++ languages that can call C code but not C++
- * code.
+ * code. Starting with qpdf 11.7, it is possible to write your own `extern "C"` functions that
+ * interoperate with the C API.
*
* There are several things to keep in mind when using the C API.
*
* Error handling is tricky because the underlying C++ API uses exception handling. See "ERROR
* HANDLING" below for a detailed explanation.
*
- * The C API is not as rich as the C++ API. For any operations that involve actually
- * manipulating PDF objects, you must use the C++ API. The C API is primarily useful for doing
- * basic transformations on PDF files similar to what you might do with the qpdf command-line
- * tool.
+ * The C API is not as rich as the C++ API. For many operations, you must use the C++ API. The C
+ * API is primarily useful for doing basic transformations on PDF files similar to what you
+ * might do with the qpdf command-line tool. You can write your own `extern "C"` functions in
+ * C++ that interoperate with the C API by using qpdf_c_get_qpdf and qpdf_c_wrap which were
+ * introduced in qpdf 11.7.0.
*
* These functions store their state in a qpdf_data object. Individual instances of qpdf_data
* are not thread-safe: although you may access different qpdf_data objects from different
@@ -990,6 +992,23 @@ extern "C" {
QPDF_ERROR_CODE qpdf_remove_page(qpdf_data qpdf, qpdf_oh page);
#ifdef __cplusplus
}
+
+// These C++ functions make it easier to write C++ code that interoperates with the C API.
+// See examples/extend-c-api.
+
+# include <functional>
+# include <memory>
+
+# include <qpdf/QPDF.hh>
+
+// Retrieve the real QPDF object attached to this qpdf_data.
+QPDF_DLL
+std::shared_ptr<QPDF> qpdf_c_get_qpdf(qpdf_data qpdf);
+
+// Wrap a C++ function that may throw an exception to translate the exception for retrieval using
+// the normal QPDF C API methods.
+QPDF_DLL
+QPDF_ERROR_CODE qpdf_c_wrap(qpdf_data qpdf, std::function<void()> fn);
#endif
#endif /* QPDF_C_H */
diff --git a/job.sums b/job.sums
index 1b718776..8ab0d576 100644
--- a/job.sums
+++ b/job.sums
@@ -14,4 +14,4 @@ libqpdf/qpdf/auto_job_json_decl.hh 06caa46eaf71db8a50c046f91866baa8087745a947431
libqpdf/qpdf/auto_job_json_init.hh 85ac7e5c66f14c767419823eac84bdea4bd72d690bfe12b533321e5708e644b7
libqpdf/qpdf/auto_job_schema.hh 5e0f5cb7d462716fe52548b2ae1a8eb6f3c900016e915140eea37f78cee45b2b
manual/_ext/qpdf.py 6add6321666031d55ed4aedf7c00e5662bba856dfcd66ccb526563bffefbb580
-manual/cli.rst 35d32800cee1871e74c85419c481cae1c544c8b0eb462df82cf373a32619ab73
+manual/cli.rst 4f2806f7cf77f167fd41b065a8916f02fdfaab35ad1a74587578bf2954228464
diff --git a/libqpdf/CMakeLists.txt b/libqpdf/CMakeLists.txt
index c6a122c6..eb30b622 100644
--- a/libqpdf/CMakeLists.txt
+++ b/libqpdf/CMakeLists.txt
@@ -590,10 +590,12 @@ if(INSTALL_CMAKE_PACKAGE)
install(EXPORT libqpdfTargets
NAMESPACE qpdf::
FILE libqpdfTargets.cmake
+ COMPONENT ${COMPONENT_DEV}
DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/qpdf)
install(FILES
${CMAKE_CURRENT_BINARY_DIR}/qpdfConfigVersion.cmake
${CMAKE_CURRENT_BINARY_DIR}/qpdfConfig.cmake
+ COMPONENT ${COMPONENT_DEV}
DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/qpdf)
endif()
diff --git a/libqpdf/qpdf-c.cc b/libqpdf/qpdf-c.cc
index 1f7b85cb..b45b564b 100644
--- a/libqpdf/qpdf-c.cc
+++ b/libqpdf/qpdf-c.cc
@@ -1949,3 +1949,15 @@ qpdf_write_json(
});
return status;
}
+
+std::shared_ptr<QPDF>
+qpdf_c_get_qpdf(qpdf_data qpdf)
+{
+ return qpdf->qpdf;
+}
+
+QPDF_ERROR_CODE
+qpdf_c_wrap(qpdf_data qpdf, std::function<void()> fn)
+{
+ return trap_errors(qpdf, [&fn](qpdf_data) { fn(); });
+}
diff --git a/manual/cli.rst b/manual/cli.rst
index 4e01b65f..482d65f9 100644
--- a/manual/cli.rst
+++ b/manual/cli.rst
@@ -749,7 +749,7 @@ Related Options
signature but leaves its visual appearance intact.
Remove security restrictions associated with digitally signed PDF
- files. This may be combined with :qpdf:option:--decrypt: to allow
+ files. This may be combined with :qpdf:ref:--decrypt: to allow
free editing of previously signed/encrypted files. This option
invalidates the signature but leaves its visual appearance intact.
@@ -2176,7 +2176,7 @@ Related Options
created in this way are insecure since they can be opened without a
password, and restrictions will not be enforced. Users would
ordinarily never want to create such files. If you are using qpdf
- to intentionally created strange files for testing (a valid use of
+ to intentionally create strange files for testing (a valid use of
qpdf!), this option allows you to create such insecure files. This
option is only available with 256-bit encryption.
diff --git a/manual/conf.py b/manual/conf.py
index f0fd45c5..b95eb3c6 100644
--- a/manual/conf.py
+++ b/manual/conf.py
@@ -16,7 +16,7 @@ project = 'QPDF'
copyright = '2005-2023, Jay Berkenbilt'
author = 'Jay Berkenbilt'
# make_dist and the CI build lexically find the release version from this file.
-release = '11.6.3'
+release = '11.7.0'
version = release
extensions = [
'sphinx_rtd_theme',
diff --git a/manual/release-notes.rst b/manual/release-notes.rst
index a03ce499..7388f17d 100644
--- a/manual/release-notes.rst
+++ b/manual/release-notes.rst
@@ -38,6 +38,23 @@ Planned changes for future 12.x (subject to change):
.. x.y.z: not yet released
+11.7.0: not yet released
+ - Library Enhancements:
+
+ - Add C++ functions ``qpdf_c_wrap`` and ``qpdf_c_get_qpdf`` to the
+ C API to enable custom C++ code to interoperate more easily with
+ the the C API. See ``examples/extend-c-api``.
+
+11.6.4: December 10, 2023
+ - Bug fixes:
+
+ - When running ``cmake --install --component dev``, install cmake
+ files, which were previously omitted from the ``dev`` component
+
+ - Fix the Linux binary build to use older libraries so it
+ continues to work in AWS Lambda and other older execution
+ environments.
+
11.6.3: October 15, 2023
- Bug fixes:
@@ -48,7 +65,7 @@ Planned changes for future 12.x (subject to change):
content streams with default settings.
- The linearization specification precludes linearized files that
- require offets past the 4 GB mark. A bug in qpdf was preventing
+ require offsets past the 4 GB mark. A bug in qpdf was preventing
it from working when offsets had to pass the 2 GB mark. This has
been corrected.
generated by cgit v1.2.3-54-g00ecf (git 2.45.2) at 2024-07-03 15:52:25 +0200