PDFio is a simple C library for reading and writing PDF files.
Go to file
2021-06-04 11:07:27 -04:00
.github Only use cppcheck on Linux. 2021-05-30 12:58:36 -04:00
doc Update logo. 2021-05-30 09:07:50 -04:00
pdfio.xcodeproj Add content convenience functions. 2021-05-24 19:33:40 -04:00
testfiles Implement calibrated color support, including constants for a few standard 2021-05-31 09:31:00 -04:00
.cppcheck Update Cppcheck exclusions. 2021-06-04 11:03:15 -04:00
.gitignore Add clang and cppcheck. 2021-05-30 12:51:26 -04:00
FAQ.md Add start of FAQ. 2021-05-02 09:59:33 -04:00
LICENSE Initial checkin. 2021-04-10 08:00:52 -04:00
Makefile Add clang and cppcheck. 2021-05-30 12:51:26 -04:00
NOTICE Rename as PDFio for consistency. 2021-05-30 07:10:44 -04:00
pdfio-array.c Rename as PDFio for consistency. 2021-05-30 07:10:44 -04:00
pdfio-common.c Fix Coverity-discovered issues. 2021-06-04 10:56:23 -04:00
pdfio-content.c Fix Coverity-discovered issues. 2021-06-04 10:56:23 -04:00
pdfio-content.h Add pdfioImageGetBytesPerLine API, document its use for image streams. 2021-06-04 10:33:39 -04:00
pdfio-dict.c Rename as PDFio for consistency. 2021-05-30 07:10:44 -04:00
pdfio-file.c Fix Coverity-discovered issues. 2021-06-04 10:56:23 -04:00
pdfio-object.c Add read-back tests. 2021-06-02 15:46:39 -04:00
pdfio-page.c Rename as PDFio for consistency. 2021-05-30 07:10:44 -04:00
pdfio-private.h Fix PNG predictor 12, 14, and 15. 2021-06-01 17:48:36 -04:00
pdfio-stream.c Fix Coverity-discovered issues. 2021-06-04 10:56:23 -04:00
pdfio-string.c Rename as PDFio for consistency. 2021-05-30 07:10:44 -04:00
pdfio-token.c Resolve clang warning. 2021-06-04 11:03:24 -04:00
pdfio-value.c Rename as PDFio for consistency. 2021-05-30 07:10:44 -04:00
pdfio.h Add read-back tests. 2021-06-02 15:46:39 -04:00
pdfio.pc.in Rename as PDFio for consistency. 2021-05-30 07:10:44 -04:00
README.md Add badges. 2021-06-01 18:36:22 -04:00
testpdfio.c Fix one more resource leak found by Coverity. 2021-06-04 11:07:27 -04:00

pdfio - PDF Read/Write Library

Version Apache 2.0 Build Coverity Scan Status LGTM Grade LGTM Alerts

PDFio is a simple C library for reading and writing PDF files. The primary goals of PDFio are:

  • Read and write any version of PDF file
  • Provide access to pages, objects, and streams within a PDF file
  • Support reading encrypted PDF files
  • Support writing PDF files with digital signatures
  • Extract or embed useful metadata (author, creator, page information, etc.)
  • "Filter" PDF files, for example to extract a range of pages or to embed fonts that are missing from a PDF
  • Provide access to objects used for each page

PDFio is not concerned with rendering or viewing a PDF file, although a PDF RIP or viewer could be written using it.

Requirements

PDFio requires the following to build the software:

  • A C99 compiler such as Clang, GCC, or MS Visual C
  • A POSIX-compliant make program
  • ZLIB (https://www.zlib.net) 1.0 or higher

IDE files for Xcode (macOS/iOS) and Visual Studio (Windows) are also provided.

Documentation

Note: Documentation is under active development...

See the man page (pdfio.3), frequently ask questions (FAQ.md), and full HTML documentation (pdfio.html) for information on using PDFio.

Installing pdfio

PDFio comes with a portable makefile that will work on any POSIX-compliant system with ZLIB installed. To make it, run:

make all

To test it, run:

make test

To install it, run:

make install

If you want a shared library, run:

make all-shared
make install-shared

The default installation location is "/usr/local". Pass the prefix variable to make to install it to another location:

make install prefix=/some/other/directory

The makefile installs the pdfio header to "${prefix}/include", the library to "${prefix}/lib", the pkg-config file to "${prefix}/lib/pkgconfig", the man page to "${prefix}/share/man/man3", and the documentation to "${prefix}/share/doc/pdfio".

The makefile supports the following variables that can be specified in the make command or as environment variables:

  • AR: the library archiver (default "ar")
  • ARFLAGS: options for the library archiver (default "cr")
  • CC: the C compiler (default "cc")
  • CFLAGS: options for the C compiler (default "")
  • CODESIGN_IDENTITY: the identity to use when code signing the shared library on macOS (default "Developer ID")
  • COMMONFLAGS: options for the C compiler and linker (typically architecture and optimization options, default is "-Os -g")
  • CPPFLAGS: options for the C preprocessor (default "")
  • DESTDIR" and "DSTROOT: specifies a root directory when installing (default is "", specify only one)
  • DSOFLAGS: options for the C compiler when linking the shared library (default "")
  • LDFLAGS: options for the C compiler when linking the test programs (default "")
  • LIBS: library options when linking the test programs (default "-lz")
  • RANLIB: program that generates a table-of-contents in a library (default "ranlib")
  • prefix: specifies the installation directory (default "/usr/local")

Visual Studio Project

Note: I haven't yet added this...

The Visual Studio solution ("pdfio.sln") is provided for Windows developers generates both a static library and DLL.

Xcode Project

There is also an Xcode project ("pdfio.xcodeproj") you can use on macOS which generates a static library that will be installed under "/usr/local" with:

sudo xcodebuild install

You can reproduce this with the makefile using:

sudo make 'COMMONFLAGS="-Os -mmacosx-version-min=10.14 -arch x86_64 -arch arm64"' install

PDFio is Copyright © 2021 by Michael R Sweet.

This software is licensed under the Apache License Version 2.0 with an (optional) exception to allow linking against GPL2/LGPL2 software. See the files "LICENSE" and "NOTICE" for more information.