dany/pdfio
1
0
Fork 0
mirror of https://github.com/michaelrsweet/pdfio.git synced 2024-11-19 11:58:24 +01:00
Code Issues Packages Projects Releases Wiki Activity
9610892dd7
pdfio/pdfio.h

175 lines
7.9 KiB
C
Raw Normal View History

Initial checkin.
2021-04-10 14:00:52 +02:00
//
// Public header file for pdfio.
//
// 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...
//
Add string array, have the pdfio_file_t object manage allocated data.
2021-04-25 17:28:56 +02:00
# include <stdio.h>
# include <stdlib.h>
Save work on fleshing out public API.
2021-04-12 14:09:25 +02:00
# include <stdbool.h>
Add string array, have the pdfio_file_t object manage allocated data.
2021-04-25 17:28:56 +02:00
# include <sys/types.h>
Save work on fleshing out public API.
2021-04-12 14:09:25 +02:00
# include <time.h>
Initial checkin.
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...
//
Save work on fleshing out public API.
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
pdfio_dict_t implementation
2021-04-26 02:12:52 +02:00
typedef bool (*pdfio_error_cb_t)(pdfio_file_t *pdf, const char *message, void *data);
Add string array, have the pdfio_file_t object manage allocated data.
2021-04-25 17:28:56 +02:00
// Error callback
Save work on low-level file I/O.
2021-04-26 16:42:01 +02:00
typedef enum pdfio_filter_e // Compression/decompression filters for streams
{
PDFIO_FILTER_NONE, // No filter
PDFIO_FILTER_FLATE // Flate filter
} pdfio_filter_t;
Save work on fleshing out public API.
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
{
float x1; // Lower-left X coordinate
float y1; // Lower-left Y coordinate
float x2; // Upper-right X coordinate
float y2; // Upper-right Y coordinate
} 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
Save work.
2021-04-28 03:22:34 +02:00
PDFIO_VALTYPE_BINARY, // Binary data
Save work on fleshing out public API.
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;
typedef struct _pdfio_value_s pdf_value_t;
// PDF value of any type
Initial checkin.
2021-04-10 14:00:52 +02:00
//
// Functions...
//
Fill out basic API functions.
2021-04-17 02:41:46 +02:00
extern bool pdfioArrayAppendArray(pdfio_array_t *a, pdfio_array_t *value) PDFIO_PUBLIC;
Add string array, have the pdfio_file_t object manage allocated data.
2021-04-25 17:28:56 +02:00
extern bool pdfioArrayAppendBoolean(pdfio_array_t *a, bool value) PDFIO_PUBLIC;
Fill out basic API functions.
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;
extern bool pdfioArrayAppendNumber(pdfio_array_t *a, float value) PDFIO_PUBLIC;
extern bool pdfioArrayAppendObject(pdfio_array_t *a, pdfio_obj_t *value) PDFIO_PUBLIC;
extern bool pdfioArrayAppendString(pdfio_array_t *a, const char *value) PDFIO_PUBLIC;
Save work.
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;
Add string array, have the pdfio_file_t object manage allocated data.
2021-04-25 17:28:56 +02:00
extern pdfio_array_t *pdfioArrayGetArray(pdfio_array_t *a, size_t n) PDFIO_PUBLIC;
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;
extern float pdfioArrayGetNumber(pdfio_array_t *a, size_t n) PDFIO_PUBLIC;
extern pdfio_obj_t *pdfioArrayGetObject(pdfio_array_t *a, size_t n) PDFIO_PUBLIC;
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;
Fill out basic API functions.
2021-04-17 02:41:46 +02:00
Save work.
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;
Save work.
2021-04-12 22:15:08 +02:00
extern pdfio_array_t *pdfioDictGetArray(pdfio_dict_t *dict, const char *name) PDFIO_PUBLIC;
extern bool pdfioDictGetBoolean(pdfio_dict_t *dict, const char *name) PDFIO_PUBLIC;
extern pdfio_dict_t *pdfioDictGetDict(pdfio_dict_t *dict, const char *name) PDFIO_PUBLIC;
extern const char *pdfioDictGetName(pdfio_dict_t *dict, const char *name) PDFIO_PUBLIC;
Save work on fleshing out public API.
2021-04-12 14:09:25 +02:00
extern float pdfioDictGetNumber(pdfio_dict_t *dict, const char *name) PDFIO_PUBLIC;
Save work.
2021-04-12 22:15:08 +02:00
extern pdfio_obj_t *pdfioDictGetObject(pdfio_dict_t *dict, const char *name) PDFIO_PUBLIC;
Save work on fleshing out public API.
2021-04-12 14:09:25 +02:00
extern pdfio_rect_t *pdfioDictGetRect(pdfio_dict_t *dict, const char *name, pdfio_rect_t *rect) PDFIO_PUBLIC;
extern const char *pdfioDictGetString(pdfio_dict_t *dict, const char *name) PDFIO_PUBLIC;
Save work.
2021-04-12 22:15:08 +02:00
extern pdfio_valtype_t pdfioDictGetType(pdfio_dict_t *dict, const char *name) PDFIO_PUBLIC;
extern bool pdfioDictSetArray(pdfio_dict_t *dict, const char *name, pdfio_array_t *value) PDFIO_PUBLIC;
extern bool pdfioDictSetBoolean(pdfio_dict_t *dict, const char *name, bool value) PDFIO_PUBLIC;
extern bool pdfioDictSetDict(pdfio_dict_t *dict, const char *name, pdfio_dict_t *value) PDFIO_PUBLIC;
extern bool pdfioDictSetName(pdfio_dict_t *dict, const char *name, const char *value) PDFIO_PUBLIC;
extern bool pdfioDictSetNull(pdfio_dict_t *dict, const char *name) PDFIO_PUBLIC;
extern bool pdfioDictSetNumber(pdfio_dict_t *dict, const char *name, float value) PDFIO_PUBLIC;
extern bool pdfioDictSetObject(pdfio_dict_t *dict, const char *name, pdfio_obj_t *value) PDFIO_PUBLIC;
extern bool pdfioDictSetRect(pdfio_dict_t *dict, const char *name, pdfio_rect_t *value) PDFIO_PUBLIC;
extern bool pdfioDictSetString(pdfio_dict_t *dict, const char *name, const char *value) PDFIO_PUBLIC;
extern bool pdfioDictSetStringf(pdfio_dict_t *dict, const char *name, const char *format, ...) PDFIO_PUBLIC PDFIO_FORMAT(3,4);
Save work on fleshing out public API.
2021-04-12 14:09:25 +02:00
extern bool pdfioFileClose(pdfio_file_t *pdf) PDFIO_PUBLIC;
Save work.
2021-04-28 03:22:34 +02:00
extern pdfio_file_t *pdfioFileCreate(const char *filename, const char *version, pdfio_error_cb_t error_cb, void *error_data) PDFIO_PUBLIC;
extern pdfio_obj_t *pdfioFileCreateObject(pdfio_file_t *pdf, pdfio_dict_t *dict) PDFIO_PUBLIC;
Add string array, have the pdfio_file_t object manage allocated data.
2021-04-25 17:28:56 +02:00
extern pdfio_obj_t *pdfioFileCreatePage(pdfio_file_t *pdf, pdfio_dict_t *dict) PDFIO_PUBLIC;
Save work on fleshing out public API.
2021-04-12 14:09:25 +02:00
extern const char *pdfioFileGetName(pdfio_file_t *pdf) PDFIO_PUBLIC;
Save work.
2021-04-28 03:22:34 +02:00
extern size_t pdfioFileGetNumObjects(pdfio_file_t *pdf) PDFIO_PUBLIC;
extern size_t pdfioFileGetNumPages(pdfio_file_t *pdf) PDFIO_PUBLIC;
extern pdfio_obj_t *pdfioFileGetObject(pdfio_file_t *pdf, size_t number) PDFIO_PUBLIC;
extern pdfio_obj_t *pdfioFileGetPage(pdfio_file_t *pdf, size_t number) PDFIO_PUBLIC;
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;
Save work on fleshing out public API.
2021-04-12 14:09:25 +02:00
Add string array, have the pdfio_file_t object manage allocated data.
2021-04-25 17:28:56 +02:00
extern bool pdfioObjClose(pdfio_obj_t *obj) PDFIO_PUBLIC;
Save work on low-level file I/O.
2021-04-26 16:42:01 +02:00
extern pdfio_stream_t *pdfioObjCreateStream(pdfio_obj_t *obj, pdfio_filter_t compression) PDFIO_PUBLIC;
Start filling out internal APIs.
2021-04-17 03:09:43 +02:00
extern pdfio_dict_t *pdfioObjGetDict(pdfio_obj_t *obj) PDFIO_PUBLIC;
Save work.
2021-04-28 03:22:34 +02:00
extern size_t pdfioObjGetGeneration(pdfio_obj_t *obj) PDFIO_PUBLIC;
extern size_t pdfioObjGetNumber(pdfio_obj_t *obj) PDFIO_PUBLIC;
Start filling out internal APIs.
2021-04-17 03:09:43 +02:00
extern const char *pdfioObjGetType(pdfio_obj_t *obj) PDFIO_PUBLIC;
Save work on low-level file I/O.
2021-04-26 16:42:01 +02:00
extern pdfio_stream_t *pdfioObjOpenStream(pdfio_obj_t *obj) PDFIO_PUBLIC;
Save work on fleshing out public API.
2021-04-12 14:09:25 +02:00
extern bool pdfioStreamClose(pdfio_stream_t *st) PDFIO_PUBLIC;
Save work on low-level file I/O.
2021-04-26 16:42:01 +02:00
extern bool pdfioStreamGetToken(pdfio_stream_t *st, char *buffer, size_t bufsize) PDFIO_PUBLIC;
Save work on fleshing out public API.
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;
Add string array, have the pdfio_file_t object manage allocated data.
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;
Initial checkin.
2021-04-10 14:00:52 +02:00
//
// C++ magic...
//
# ifdef __cplusplus
}
# endif // __cplusplus
#endif // !PDFIO_H
Reference in New Issue Copy Permalink