2021-04-10 14:00:52 +02:00
|
|
|
|
//
|
2021-05-30 13:10:44 +02:00
|
|
|
|
// Public header file for PDFio.
|
2021-04-10 14:00:52 +02:00
|
|
|
|
//
|
|
|
|
|
|
// Copyright © 2021 by Michael R Sweet.
|
|
|
|
|
|
//
|
|
|
|
|
|
// Licensed under Apache License v2.0. See the file "LICENSE" for more
|
|
|
|
|
|
// information.
|
|
|
|
|
|
//
|
|
|
|
|
|
|
|
|
|
|
|
#ifndef PDFIO_H
|
|
|
|
|
|
# define PDFIO_H
|
|
|
|
|
|
|
|
|
|
|
|
//
|
|
|
|
|
|
// Include necessary headers...
|
|
|
|
|
|
//
|
|
|
|
|
|
|
2021-04-25 17:28:56 +02:00
|
|
|
|
# include <stdio.h>
|
|
|
|
|
|
# include <stdlib.h>
|
2021-04-12 14:09:25 +02:00
|
|
|
|
# include <stdbool.h>
|
2021-04-25 17:28:56 +02:00
|
|
|
|
# include <sys/types.h>
|
2021-04-12 14:09:25 +02:00
|
|
|
|
# include <time.h>
|
|
|
|
|
|
|
2021-04-10 14:00:52 +02:00
|
|
|
|
|
|
|
|
|
|
//
|
|
|
|
|
|
// C++ magic...
|
|
|
|
|
|
//
|
|
|
|
|
|
|
|
|
|
|
|
# ifdef __cplusplus
|
|
|
|
|
|
extern "C" {
|
|
|
|
|
|
# endif // __cplusplus
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
//
|
|
|
|
|
|
// Visibility and other annotations...
|
|
|
|
|
|
//
|
|
|
|
|
|
|
|
|
|
|
|
# if defined(__has_extension) || defined(__GNUC__)
|
|
|
|
|
|
# define PDFIO_PUBLIC __attribute__ ((visibility("default")))
|
|
|
|
|
|
# define PDFIO_FORMAT(a,b) __attribute__ ((__format__(__printf__, a,b)))
|
|
|
|
|
|
# else
|
|
|
|
|
|
# define PDFIO_PUBLIC
|
|
|
|
|
|
# define PDFIO_FORMAT(a,b)
|
|
|
|
|
|
# endif // __has_extension || __GNUC__
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
//
|
|
|
|
|
|
// Types and constants...
|
|
|
|
|
|
//
|
|
|
|
|
|
|
2021-04-12 14:09:25 +02:00
|
|
|
|
typedef struct _pdfio_array_s pdfio_array_t;
|
|
|
|
|
|
// Array of PDF values
|
|
|
|
|
|
typedef struct _pdfio_dict_s pdfio_dict_t;
|
|
|
|
|
|
// Key/value dictionary
|
|
|
|
|
|
typedef struct _pdfio_file_s pdfio_file_t;
|
|
|
|
|
|
// PDF file
|
2021-04-26 02:12:52 +02:00
|
|
|
|
typedef bool (*pdfio_error_cb_t)(pdfio_file_t *pdf, const char *message, void *data);
|
2021-04-25 17:28:56 +02:00
|
|
|
|
// Error callback
|
2021-04-26 16:42:01 +02:00
|
|
|
|
typedef enum pdfio_filter_e // Compression/decompression filters for streams
|
|
|
|
|
|
{
|
|
|
|
|
|
PDFIO_FILTER_NONE, // No filter
|
2021-05-06 22:07:58 +02:00
|
|
|
|
PDFIO_FILTER_ASCIIHEX, // ASCIIHexDecode filter (reading only)
|
|
|
|
|
|
PDFIO_FILTER_ASCII85, // ASCII85Decode filter (reading only)
|
|
|
|
|
|
PDFIO_FILTER_CCITTFAX, // CCITTFaxDecode filter
|
|
|
|
|
|
PDFIO_FILTER_CRYPT, // Encryption filter
|
|
|
|
|
|
PDFIO_FILTER_DCT, // DCTDecode (JPEG) filter
|
|
|
|
|
|
PDFIO_FILTER_FLATE, // FlateDecode filter
|
|
|
|
|
|
PDFIO_FILTER_JBIG2, // JBIG2Decode filter
|
|
|
|
|
|
PDFIO_FILTER_JPX, // JPXDecode filter (reading only)
|
|
|
|
|
|
PDFIO_FILTER_LZW, // LZWDecode filter (reading only)
|
|
|
|
|
|
PDFIO_FILTER_RUNLENGTH, // RunLengthDecode filter (reading only)
|
2021-04-26 16:42:01 +02:00
|
|
|
|
} pdfio_filter_t;
|
2021-04-12 14:09:25 +02:00
|
|
|
|
typedef struct _pdfio_obj_s pdfio_obj_t;// Numbered object in PDF file
|
|
|
|
|
|
typedef struct pdfio_rect_s // PDF rectangle
|
|
|
|
|
|
{
|
2021-05-30 03:16:21 +02:00
|
|
|
|
double x1; // Lower-left X coordinate
|
|
|
|
|
|
double y1; // Lower-left Y coordinate
|
|
|
|
|
|
double x2; // Upper-right X coordinate
|
|
|
|
|
|
double y2; // Upper-right Y coordinate
|
2021-04-12 14:09:25 +02:00
|
|
|
|
} pdfio_rect_t;
|
|
|
|
|
|
typedef struct _pdfio_stream_s pdfio_stream_t;
|
|
|
|
|
|
// Object data stream in PDF file
|
|
|
|
|
|
typedef enum pdfio_valtype_e // PDF value types
|
|
|
|
|
|
{
|
|
|
|
|
|
PDFIO_VALTYPE_NONE, // No value, not set
|
|
|
|
|
|
PDFIO_VALTYPE_ARRAY, // Array
|
2021-04-28 03:22:34 +02:00
|
|
|
|
PDFIO_VALTYPE_BINARY, // Binary data
|
2021-04-12 14:09:25 +02:00
|
|
|
|
PDFIO_VALTYPE_BOOLEAN, // Boolean
|
|
|
|
|
|
PDFIO_VALTYPE_DATE, // Date/time
|
|
|
|
|
|
PDFIO_VALTYPE_DICT, // Dictionary
|
|
|
|
|
|
PDFIO_VALTYPE_INDIRECT, // Indirect object (N G obj)
|
|
|
|
|
|
PDFIO_VALTYPE_NAME, // Name
|
|
|
|
|
|
PDFIO_VALTYPE_NULL, // Null object
|
|
|
|
|
|
PDFIO_VALTYPE_NUMBER, // Number (integer or real)
|
|
|
|
|
|
PDFIO_VALTYPE_STRING // String
|
|
|
|
|
|
} pdfio_valtype_t;
|
|
|
|
|
|
|
2021-04-10 14:00:52 +02:00
|
|
|
|
|
|
|
|
|
|
//
|
|
|
|
|
|
// Functions...
|
|
|
|
|
|
//
|
|
|
|
|
|
|
2021-04-17 02:41:46 +02:00
|
|
|
|
extern bool pdfioArrayAppendArray(pdfio_array_t *a, pdfio_array_t *value) PDFIO_PUBLIC;
|
2021-06-05 17:28:32 +02:00
|
|
|
|
extern bool pdfioArrayAppendBinary(pdfio_array_t *a, const unsigned char *value, size_t valuelen) PDFIO_PUBLIC;
|
2021-04-25 17:28:56 +02:00
|
|
|
|
extern bool pdfioArrayAppendBoolean(pdfio_array_t *a, bool value) PDFIO_PUBLIC;
|
2021-04-17 02:41:46 +02:00
|
|
|
|
extern bool pdfioArrayAppendDict(pdfio_array_t *a, pdfio_dict_t *value) PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioArrayAppendName(pdfio_array_t *a, const char *value) PDFIO_PUBLIC;
|
2021-05-30 03:16:21 +02:00
|
|
|
|
extern bool pdfioArrayAppendNumber(pdfio_array_t *a, double value) PDFIO_PUBLIC;
|
2021-06-07 14:34:30 +02:00
|
|
|
|
extern bool pdfioArrayAppendObj(pdfio_array_t *a, pdfio_obj_t *value) PDFIO_PUBLIC;
|
2021-04-17 02:41:46 +02:00
|
|
|
|
extern bool pdfioArrayAppendString(pdfio_array_t *a, const char *value) PDFIO_PUBLIC;
|
2021-04-28 03:22:34 +02:00
|
|
|
|
extern pdfio_array_t *pdfioArrayCopy(pdfio_file_t *pdf, pdfio_array_t *a) PDFIO_PUBLIC;
|
|
|
|
|
|
extern pdfio_array_t *pdfioArrayCreate(pdfio_file_t *pdf) PDFIO_PUBLIC;
|
2021-04-25 17:28:56 +02:00
|
|
|
|
extern pdfio_array_t *pdfioArrayGetArray(pdfio_array_t *a, size_t n) PDFIO_PUBLIC;
|
2021-05-01 13:36:19 +02:00
|
|
|
|
extern unsigned char *pdfioArrayGetBinary(pdfio_array_t *a, size_t n, size_t *length) PDFIO_PUBLIC;
|
2021-04-25 17:28:56 +02:00
|
|
|
|
extern bool pdfioArrayGetBoolean(pdfio_array_t *a, size_t n) PDFIO_PUBLIC;
|
|
|
|
|
|
extern pdfio_dict_t *pdfioArrayGetDict(pdfio_array_t *a, size_t n) PDFIO_PUBLIC;
|
|
|
|
|
|
extern const char *pdfioArrayGetName(pdfio_array_t *a, size_t n) PDFIO_PUBLIC;
|
2021-05-30 03:16:21 +02:00
|
|
|
|
extern double pdfioArrayGetNumber(pdfio_array_t *a, size_t n) PDFIO_PUBLIC;
|
2021-06-07 14:34:30 +02:00
|
|
|
|
extern pdfio_obj_t *pdfioArrayGetObj(pdfio_array_t *a, size_t n) PDFIO_PUBLIC;
|
2021-04-25 17:28:56 +02:00
|
|
|
|
extern size_t pdfioArrayGetSize(pdfio_array_t *a) PDFIO_PUBLIC;
|
|
|
|
|
|
extern const char *pdfioArrayGetString(pdfio_array_t *a, size_t n) PDFIO_PUBLIC;
|
|
|
|
|
|
extern pdfio_valtype_t pdfioArrayGetType(pdfio_array_t *a, size_t n) PDFIO_PUBLIC;
|
2021-04-17 02:41:46 +02:00
|
|
|
|
|
2021-04-28 03:22:34 +02:00
|
|
|
|
extern pdfio_dict_t *pdfioDictCopy(pdfio_file_t *pdf, pdfio_dict_t *dict) PDFIO_PUBLIC;
|
|
|
|
|
|
extern pdfio_dict_t *pdfioDictCreate(pdfio_file_t *pdf) PDFIO_PUBLIC;
|
2021-05-01 13:36:19 +02:00
|
|
|
|
extern pdfio_array_t *pdfioDictGetArray(pdfio_dict_t *dict, const char *key) PDFIO_PUBLIC;
|
|
|
|
|
|
extern unsigned char *pdfioDictGetBinary(pdfio_dict_t *dict, const char *key, size_t *length) PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioDictGetBoolean(pdfio_dict_t *dict, const char *key) PDFIO_PUBLIC;
|
|
|
|
|
|
extern pdfio_dict_t *pdfioDictGetDict(pdfio_dict_t *dict, const char *key) PDFIO_PUBLIC;
|
|
|
|
|
|
extern const char *pdfioDictGetName(pdfio_dict_t *dict, const char *key) PDFIO_PUBLIC;
|
2021-05-30 03:16:21 +02:00
|
|
|
|
extern double pdfioDictGetNumber(pdfio_dict_t *dict, const char *key) PDFIO_PUBLIC;
|
2021-06-07 14:34:30 +02:00
|
|
|
|
extern pdfio_obj_t *pdfioDictGetObj(pdfio_dict_t *dict, const char *key) PDFIO_PUBLIC;
|
2021-05-01 13:36:19 +02:00
|
|
|
|
extern pdfio_rect_t *pdfioDictGetRect(pdfio_dict_t *dict, const char *key, pdfio_rect_t *rect) PDFIO_PUBLIC;
|
|
|
|
|
|
extern const char *pdfioDictGetString(pdfio_dict_t *dict, const char *key) PDFIO_PUBLIC;
|
|
|
|
|
|
extern pdfio_valtype_t pdfioDictGetType(pdfio_dict_t *dict, const char *key) PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioDictSetArray(pdfio_dict_t *dict, const char *key, pdfio_array_t *value) PDFIO_PUBLIC;
|
2021-06-05 17:28:32 +02:00
|
|
|
|
extern bool pdfioDictSetBinary(pdfio_dict_t *dict, const char *key, const unsigned char *value, size_t valuelen) PDFIO_PUBLIC;
|
2021-05-01 13:36:19 +02:00
|
|
|
|
extern bool pdfioDictSetBoolean(pdfio_dict_t *dict, const char *key, bool value) PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioDictSetDict(pdfio_dict_t *dict, const char *key, pdfio_dict_t *value) PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioDictSetName(pdfio_dict_t *dict, const char *key, const char *value) PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioDictSetNull(pdfio_dict_t *dict, const char *key) PDFIO_PUBLIC;
|
2021-05-30 03:16:21 +02:00
|
|
|
|
extern bool pdfioDictSetNumber(pdfio_dict_t *dict, const char *key, double value) PDFIO_PUBLIC;
|
2021-06-07 14:34:30 +02:00
|
|
|
|
extern bool pdfioDictSetObj(pdfio_dict_t *dict, const char *key, pdfio_obj_t *value) PDFIO_PUBLIC;
|
2021-05-01 13:36:19 +02:00
|
|
|
|
extern bool pdfioDictSetRect(pdfio_dict_t *dict, const char *key, pdfio_rect_t *value) PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioDictSetString(pdfio_dict_t *dict, const char *key, const char *value) PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioDictSetStringf(pdfio_dict_t *dict, const char *key, const char *format, ...) PDFIO_PUBLIC PDFIO_FORMAT(3,4);
|
2021-04-12 14:09:25 +02:00
|
|
|
|
|
|
|
|
|
|
extern bool pdfioFileClose(pdfio_file_t *pdf) PDFIO_PUBLIC;
|
2021-05-16 17:39:05 +02:00
|
|
|
|
extern pdfio_file_t *pdfioFileCreate(const char *filename, const char *version, pdfio_rect_t *media_box, pdfio_rect_t *crop_box, pdfio_error_cb_t error_cb, void *error_data) PDFIO_PUBLIC;
|
2021-06-07 14:34:30 +02:00
|
|
|
|
extern pdfio_obj_t *pdfioFileCreateObj(pdfio_file_t *pdf, pdfio_dict_t *dict) PDFIO_PUBLIC;
|
2021-05-16 17:39:05 +02:00
|
|
|
|
// TODO: Add number, array, string, etc. versions of pdfioFileCreateObject?
|
|
|
|
|
|
extern pdfio_stream_t *pdfioFileCreatePage(pdfio_file_t *pdf, pdfio_dict_t *dict) PDFIO_PUBLIC;
|
2021-06-07 14:34:30 +02:00
|
|
|
|
extern pdfio_obj_t *pdfioFileFindObj(pdfio_file_t *pdf, size_t number) PDFIO_PUBLIC;
|
2021-05-01 23:50:52 +02:00
|
|
|
|
extern pdfio_array_t *pdfioFileGetID(pdfio_file_t *pdf) PDFIO_PUBLIC;
|
2021-04-12 14:09:25 +02:00
|
|
|
|
extern const char *pdfioFileGetName(pdfio_file_t *pdf) PDFIO_PUBLIC;
|
2021-06-07 14:34:30 +02:00
|
|
|
|
extern size_t pdfioFileGetNumObjs(pdfio_file_t *pdf) PDFIO_PUBLIC;
|
2021-04-28 03:22:34 +02:00
|
|
|
|
extern size_t pdfioFileGetNumPages(pdfio_file_t *pdf) PDFIO_PUBLIC;
|
2021-06-07 14:34:30 +02:00
|
|
|
|
extern pdfio_obj_t *pdfioFileGetObj(pdfio_file_t *pdf, size_t n) PDFIO_PUBLIC;
|
2021-05-04 22:06:14 +02:00
|
|
|
|
extern pdfio_obj_t *pdfioFileGetPage(pdfio_file_t *pdf, size_t n) PDFIO_PUBLIC;
|
2021-04-28 03:22:34 +02:00
|
|
|
|
extern const char *pdfioFileGetVersion(pdfio_file_t *pdf) PDFIO_PUBLIC;
|
|
|
|
|
|
extern pdfio_file_t *pdfioFileOpen(const char *filename, pdfio_error_cb_t error_cb, void *error_data) PDFIO_PUBLIC;
|
2021-04-12 14:09:25 +02:00
|
|
|
|
|
2021-04-25 17:28:56 +02:00
|
|
|
|
extern bool pdfioObjClose(pdfio_obj_t *obj) PDFIO_PUBLIC;
|
2021-05-15 15:29:37 +02:00
|
|
|
|
extern pdfio_obj_t *pdfioObjCopy(pdfio_file_t *pdf, pdfio_obj_t *srcobj) PDFIO_PUBLIC;
|
2021-04-26 16:42:01 +02:00
|
|
|
|
extern pdfio_stream_t *pdfioObjCreateStream(pdfio_obj_t *obj, pdfio_filter_t compression) PDFIO_PUBLIC;
|
2021-05-11 03:01:02 +02:00
|
|
|
|
extern pdfio_array_t *pdfioObjGetArray(pdfio_obj_t *obj) PDFIO_PUBLIC;
|
2021-04-17 03:09:43 +02:00
|
|
|
|
extern pdfio_dict_t *pdfioObjGetDict(pdfio_obj_t *obj) PDFIO_PUBLIC;
|
2021-05-01 17:41:43 +02:00
|
|
|
|
extern unsigned short pdfioObjGetGeneration(pdfio_obj_t *obj) PDFIO_PUBLIC;
|
2021-05-09 01:16:27 +02:00
|
|
|
|
extern size_t pdfioObjGetLength(pdfio_obj_t *obj) PDFIO_PUBLIC;
|
2021-04-28 03:22:34 +02:00
|
|
|
|
extern size_t pdfioObjGetNumber(pdfio_obj_t *obj) PDFIO_PUBLIC;
|
2021-06-02 21:46:39 +02:00
|
|
|
|
extern const char *pdfioObjGetSubtype(pdfio_obj_t *obj) PDFIO_PUBLIC;
|
2021-04-17 03:09:43 +02:00
|
|
|
|
extern const char *pdfioObjGetType(pdfio_obj_t *obj) PDFIO_PUBLIC;
|
2021-05-06 22:07:58 +02:00
|
|
|
|
extern pdfio_stream_t *pdfioObjOpenStream(pdfio_obj_t *obj, bool decode) PDFIO_PUBLIC;
|
2021-04-12 14:09:25 +02:00
|
|
|
|
|
2021-05-30 02:00:48 +02:00
|
|
|
|
extern bool pdfioPageCopy(pdfio_file_t *pdf, pdfio_obj_t *srcpage) PDFIO_PUBLIC;
|
2021-05-09 04:50:18 +02:00
|
|
|
|
extern size_t pdfioPageGetNumStreams(pdfio_obj_t *page) PDFIO_PUBLIC;
|
|
|
|
|
|
extern pdfio_stream_t *pdfioPageOpenStream(pdfio_obj_t *page, size_t n, bool decode) PDFIO_PUBLIC;
|
2021-05-01 13:36:19 +02:00
|
|
|
|
|
2021-04-12 14:09:25 +02:00
|
|
|
|
extern bool pdfioStreamClose(pdfio_stream_t *st) PDFIO_PUBLIC;
|
2021-05-02 04:38:11 +02:00
|
|
|
|
extern bool pdfioStreamConsume(pdfio_stream_t *st, size_t bytes) PDFIO_PUBLIC;
|
2021-04-26 16:42:01 +02:00
|
|
|
|
extern bool pdfioStreamGetToken(pdfio_stream_t *st, char *buffer, size_t bufsize) PDFIO_PUBLIC;
|
2021-05-01 23:50:52 +02:00
|
|
|
|
extern ssize_t pdfioStreamPeek(pdfio_stream_t *st, void *buffer, size_t bytes) PDFIO_PUBLIC;
|
2021-04-12 14:09:25 +02:00
|
|
|
|
extern bool pdfioStreamPrintf(pdfio_stream_t *st, const char *format, ...) PDFIO_PUBLIC PDFIO_FORMAT(2,3);
|
|
|
|
|
|
extern bool pdfioStreamPuts(pdfio_stream_t *st, const char *s) PDFIO_PUBLIC;
|
|
|
|
|
|
extern ssize_t pdfioStreamRead(pdfio_stream_t *st, void *buffer, size_t bytes) PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioStreamWrite(pdfio_stream_t *st, const void *buffer, size_t bytes) PDFIO_PUBLIC;
|
|
|
|
|
|
|
2021-04-25 17:28:56 +02:00
|
|
|
|
extern char *pdfioStringCreate(pdfio_file_t *pdf, const char *s) PDFIO_PUBLIC;
|
|
|
|
|
|
extern char *pdfioStringCreatef(pdfio_file_t *pdf, const char *format, ...) PDFIO_FORMAT(2,3) PDFIO_PUBLIC;
|
|
|
|
|
|
|
2021-04-10 14:00:52 +02:00
|
|
|
|
|
|
|
|
|
|
//
|
|
|
|
|
|
// C++ magic...
|
|
|
|
|
|
//
|
|
|
|
|
|
|
|
|
|
|
|
# ifdef __cplusplus
|
|
|
|
|
|
}
|
|
|
|
|
|
# endif // __cplusplus
|
|
|
|
|
|
#endif // !PDFIO_H
|
