PDFio is a simple C library for reading and writing PDF files.
Go to file
Michael R Sweet 7cb4d0a557
Update TODOs.
2021-05-10 21:33:26 -04:00
pdfio.xcodeproj Rework object and xref processing to allow for sparse object lists and generation numbers. 2021-05-04 16:06:14 -04:00
.gitignore Initial checkin. 2021-04-10 08:00:52 -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 Save work on loading object dictionaries - have a memory issue someplace. 2021-05-04 21:31:58 -04:00
NOTICE Initial checkin. 2021-04-10 08:00:52 -04:00
pdfio-array.c Increase token buffer to 256 bytes, to avoid overflow scenarios. 2021-05-10 17:37:57 -04:00
pdfio-common.c Increase token buffer to 256 bytes, to avoid overflow scenarios. 2021-05-10 17:37:57 -04:00
pdfio-dict.c Increase token buffer to 256 bytes, to avoid overflow scenarios. 2021-05-10 17:37:57 -04:00
pdfio-file.c Update TODOs. 2021-05-10 21:33:26 -04:00
pdfio-object.c Update TODOs. 2021-05-10 21:33:26 -04:00
pdfio-page.c Update TODOs. 2021-05-10 21:33:26 -04:00
pdfio-private.h Increase token buffer to 256 bytes, to avoid overflow scenarios. 2021-05-10 17:37:57 -04:00
pdfio-stream.c Update TODOs. 2021-05-10 21:33:26 -04:00
pdfio-string.c Restructure unit test program to include unit tests and alternate error handling. 2021-05-10 08:00:27 -04:00
pdfio-token.c Increase token buffer to 256 bytes, to avoid overflow scenarios. 2021-05-10 17:37:57 -04:00
pdfio-value.c Rework error/debug output. 2021-05-10 08:40:52 -04:00
pdfio.3 Initial checkin. 2021-04-10 08:00:52 -04:00
pdfio.h Add pdfioObjGetArray. 2021-05-10 21:01:02 -04:00
pdfio.html Initial checkin. 2021-04-10 08:00:52 -04:00
pdfio.md Initial checkin. 2021-04-10 08:00:52 -04:00
pdfio.pc.in Initial checkin. 2021-04-10 08:00:52 -04:00
README.md Update readme docos/requirements. 2021-05-02 09:59:51 -04:00
testpdfio.c Rework error/debug output. 2021-05-10 08:40:52 -04:00
testpdfio.pdf Add a simple PDF test document. 2021-05-01 09:29:10 -04:00
TODO.md Update TODOs. 2021-05-10 21:33:26 -04:00

pdfio - PDF Read/Write Library

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 arm64e"' 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.