2021-05-19 01:08:50 +02:00
|
|
|
|
//
|
2021-05-30 13:10:44 +02:00
|
|
|
|
// Public content header file for PDFio.
|
2021-05-19 01:08:50 +02:00
|
|
|
|
//
|
2023-10-06 20:40:08 +02:00
|
|
|
|
// Copyright © 2021-2023 by Michael R Sweet.
|
2021-05-19 01:08:50 +02:00
|
|
|
|
//
|
|
|
|
|
|
// Licensed under Apache License v2.0. See the file "LICENSE" for more
|
|
|
|
|
|
// information.
|
|
|
|
|
|
//
|
|
|
|
|
|
|
|
|
|
|
|
#ifndef PDFIO_CONTENT_H
|
|
|
|
|
|
# define PDFIO_CONTENT_H
|
|
|
|
|
|
# include "pdfio.h"
|
|
|
|
|
|
# ifdef __cplusplus
|
|
|
|
|
|
extern "C" {
|
|
|
|
|
|
# endif // __cplusplus
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
//
|
|
|
|
|
|
// Types and constants...
|
|
|
|
|
|
//
|
|
|
|
|
|
|
2021-08-18 16:17:47 +02:00
|
|
|
|
typedef enum pdfio_cs_e // Standard color spaces
|
|
|
|
|
|
{
|
|
|
|
|
|
PDFIO_CS_ADOBE, // AdobeRGB 1998
|
|
|
|
|
|
PDFIO_CS_P3_D65, // Display P3
|
|
|
|
|
|
PDFIO_CS_SRGB // sRGB
|
|
|
|
|
|
} pdfio_cs_t;
|
|
|
|
|
|
|
2021-05-19 01:08:50 +02:00
|
|
|
|
typedef enum pdfio_linecap_e // Line capping modes
|
|
|
|
|
|
{
|
2021-05-25 01:33:40 +02:00
|
|
|
|
PDFIO_LINECAP_BUTT, // Butt ends
|
|
|
|
|
|
PDFIO_LINECAP_ROUND, // Round ends
|
|
|
|
|
|
PDFIO_LINECAP_SQUARE // Square ends
|
2021-05-19 01:08:50 +02:00
|
|
|
|
} pdfio_linecap_t;
|
|
|
|
|
|
|
|
|
|
|
|
typedef enum pdfio_linejoin_e // Line joining modes
|
|
|
|
|
|
{
|
2021-05-25 01:33:40 +02:00
|
|
|
|
PDFIO_LINEJOIN_MITER, // Miter joint
|
|
|
|
|
|
PDFIO_LINEJOIN_ROUND, // Round joint
|
|
|
|
|
|
PDFIO_LINEJOIN_BEVEL // Bevel joint
|
2021-05-19 01:08:50 +02:00
|
|
|
|
} pdfio_linejoin_t;
|
|
|
|
|
|
|
2021-05-30 03:16:21 +02:00
|
|
|
|
typedef double pdfio_matrix_t[3][2]; // Transform matrix
|
2021-05-19 01:08:50 +02:00
|
|
|
|
|
|
|
|
|
|
typedef enum pdfio_textrendering_e // Text rendering modes
|
|
|
|
|
|
{
|
|
|
|
|
|
PDFIO_TEXTRENDERING_FILL, // Fill text
|
|
|
|
|
|
PDFIO_TEXTRENDERING_STROKE, // Stroke text
|
|
|
|
|
|
PDFIO_TEXTRENDERING_FILL_AND_STROKE, // Fill then stroke text
|
|
|
|
|
|
PDFIO_TEXTRENDERING_INVISIBLE, // Don't fill or stroke (invisible)
|
|
|
|
|
|
PDFIO_TEXTRENDERING_FILL_PATH, // Fill text and add to path
|
|
|
|
|
|
PDFIO_TEXTRENDERING_STROKE_PATH, // Stroke text and add to path
|
|
|
|
|
|
PDFIO_TEXTRENDERING_FILL_AND_STROKE_PATH,
|
|
|
|
|
|
// Fill then stroke text and add to path
|
|
|
|
|
|
PDFIO_TEXTRENDERING_TEXT_PATH // Add text to path (invisible)
|
|
|
|
|
|
} pdfio_textrendering_t;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
//
|
|
|
|
|
|
// Functions...
|
|
|
|
|
|
//
|
|
|
|
|
|
|
2021-06-05 17:28:32 +02:00
|
|
|
|
// Color array functions...
|
2021-07-24 19:08:46 +02:00
|
|
|
|
extern pdfio_array_t *pdfioArrayCreateColorFromICCObj(pdfio_file_t *pdf, pdfio_obj_t *icc_object) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern pdfio_array_t *pdfioArrayCreateColorFromMatrix(pdfio_file_t *pdf, size_t num_colors, double gamma, const double matrix[3][3], const double white_point[3]) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern pdfio_array_t *pdfioArrayCreateColorFromPalette(pdfio_file_t *pdf, size_t num_colors, const unsigned char *colors) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern pdfio_array_t *pdfioArrayCreateColorFromPrimaries(pdfio_file_t *pdf, size_t num_colors, double gamma, double wx, double wy, double rx, double ry, double gx, double gy, double bx, double by) _PDFIO_PUBLIC;
|
2021-08-18 16:17:47 +02:00
|
|
|
|
extern pdfio_array_t *pdfioArrayCreateColorFromStandard(pdfio_file_t *pdf, size_t num_colors, pdfio_cs_t cs);
|
2021-06-05 17:28:32 +02:00
|
|
|
|
|
2021-05-19 01:08:50 +02:00
|
|
|
|
// PDF content drawing functions...
|
2021-07-24 19:08:46 +02:00
|
|
|
|
extern bool pdfioContentClip(pdfio_stream_t *st, bool even_odd) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentDrawImage(pdfio_stream_t *st, const char *name, double x, double y, double w, double h) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentFill(pdfio_stream_t *st, bool even_odd) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentFillAndStroke(pdfio_stream_t *st, bool even_odd) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentMatrixConcat(pdfio_stream_t *st, pdfio_matrix_t m) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentMatrixRotate(pdfio_stream_t *st, double degrees) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentMatrixScale(pdfio_stream_t *st, double sx, double sy) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentMatrixTranslate(pdfio_stream_t *st, double tx, double ty) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentPathClose(pdfio_stream_t *st) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentPathCurve(pdfio_stream_t *st, double x1, double y1, double x2, double y2, double x3, double y3) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentPathCurve13(pdfio_stream_t *st, double x1, double y1, double x3, double y3) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentPathCurve23(pdfio_stream_t *st, double x2, double y2, double x3, double y3) _PDFIO_PUBLIC;
|
2022-07-03 16:01:10 +02:00
|
|
|
|
extern bool pdfioContentPathEnd(pdfio_stream_t *st) _PDFIO_PUBLIC;
|
2021-07-24 19:08:46 +02:00
|
|
|
|
extern bool pdfioContentPathLineTo(pdfio_stream_t *st, double x, double y) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentPathMoveTo(pdfio_stream_t *st, double x, double y) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentPathRect(pdfio_stream_t *st, double x, double y, double width, double height) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentRestore(pdfio_stream_t *st) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentSave(pdfio_stream_t *st) _PDFIO_PUBLIC;
|
2021-10-16 15:41:19 +02:00
|
|
|
|
extern bool pdfioContentSetDashPattern(pdfio_stream_t *st, double phase, double on, double off) _PDFIO_PUBLIC;
|
2021-07-24 19:08:46 +02:00
|
|
|
|
extern bool pdfioContentSetFillColorDeviceCMYK(pdfio_stream_t *st, double c, double m, double y, double k) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentSetFillColorDeviceGray(pdfio_stream_t *st, double g) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentSetFillColorDeviceRGB(pdfio_stream_t *st, double r, double g, double b) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentSetFillColorGray(pdfio_stream_t *st, double g) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentSetFillColorRGB(pdfio_stream_t *st, double r, double g, double b) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentSetFillColorSpace(pdfio_stream_t *st, const char *name) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentSetFlatness(pdfio_stream_t *st, double f) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentSetLineCap(pdfio_stream_t *st, pdfio_linecap_t lc) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentSetLineJoin(pdfio_stream_t *st, pdfio_linejoin_t lj) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentSetLineWidth(pdfio_stream_t *st, double width) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentSetMiterLimit(pdfio_stream_t *st, double limit) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentSetStrokeColorDeviceCMYK(pdfio_stream_t *st, double c, double m, double y, double k) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentSetStrokeColorDeviceGray(pdfio_stream_t *st, double g) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentSetStrokeColorDeviceRGB(pdfio_stream_t *st, double r, double g, double b) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentSetStrokeColorGray(pdfio_stream_t *st, double g) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentSetStrokeColorRGB(pdfio_stream_t *st, double r, double g, double b) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentSetStrokeColorSpace(pdfio_stream_t *st, const char *name) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentSetTextCharacterSpacing(pdfio_stream_t *st, double spacing) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentSetTextFont(pdfio_stream_t *st, const char *name, double size) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentSetTextLeading(pdfio_stream_t *st, double leading) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentSetTextMatrix(pdfio_stream_t *st, pdfio_matrix_t m) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentSetTextRenderingMode(pdfio_stream_t *st, pdfio_textrendering_t mode) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentSetTextRise(pdfio_stream_t *st, double rise) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentSetTextWordSpacing(pdfio_stream_t *st, double spacing) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentSetTextXScaling(pdfio_stream_t *st, double percent) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentStroke(pdfio_stream_t *st) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentTextBegin(pdfio_stream_t *st) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentTextEnd(pdfio_stream_t *st) _PDFIO_PUBLIC;
|
2023-12-05 03:20:51 +01:00
|
|
|
|
extern double pdfioContentTextMeasure(pdfio_obj_t *font, const char *s, double size) _PDFIO_PUBLIC;
|
2021-07-24 19:08:46 +02:00
|
|
|
|
extern bool pdfioContentTextMoveLine(pdfio_stream_t *st, double tx, double ty) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentTextMoveTo(pdfio_stream_t *st, double tx, double ty) _PDFIO_PUBLIC;
|
2023-12-05 13:49:49 +01:00
|
|
|
|
extern bool pdfioContentTextNewLine(pdfio_stream_t *st) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentTextNewLineShow(pdfio_stream_t *st, double ws, double cs, bool unicode, const char *s) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentTextNewLineShowf(pdfio_stream_t *st, double ws, double cs, bool unicode, const char *format, ...) _PDFIO_PUBLIC _PDFIO_FORMAT(5,6);
|
2023-12-05 19:33:07 +01:00
|
|
|
|
extern bool pdfioContentTextNextLine(pdfio_stream_t *st) _PDFIO_PUBLIC;
|
2021-07-24 19:08:46 +02:00
|
|
|
|
extern bool pdfioContentTextShow(pdfio_stream_t *st, bool unicode, const char *s) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioContentTextShowf(pdfio_stream_t *st, bool unicode, const char *format, ...) _PDFIO_PUBLIC _PDFIO_FORMAT(3,4);
|
|
|
|
|
|
extern bool pdfioContentTextShowJustified(pdfio_stream_t *st, bool unicode, size_t num_fragments, const double *offsets, const char * const *fragments) _PDFIO_PUBLIC;
|
2021-05-19 01:08:50 +02:00
|
|
|
|
|
2021-05-29 04:05:44 +02:00
|
|
|
|
// Resource helpers...
|
2021-07-24 19:08:46 +02:00
|
|
|
|
extern pdfio_obj_t *pdfioFileCreateFontObjFromBase(pdfio_file_t *pdf, const char *name) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern pdfio_obj_t *pdfioFileCreateFontObjFromFile(pdfio_file_t *pdf, const char *filename, bool unicode) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern pdfio_obj_t *pdfioFileCreateICCObjFromFile(pdfio_file_t *pdf, const char *filename, size_t num_colors) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern pdfio_obj_t *pdfioFileCreateImageObjFromData(pdfio_file_t *pdf, const unsigned char *data, size_t width, size_t height, size_t num_colors, pdfio_array_t *color_data, bool alpha, bool interpolate) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern pdfio_obj_t *pdfioFileCreateImageObjFromFile(pdfio_file_t *pdf, const char *filename, bool interpolate) _PDFIO_PUBLIC;
|
2021-05-29 04:05:44 +02:00
|
|
|
|
|
|
|
|
|
|
// Image object helpers...
|
2021-07-24 19:08:46 +02:00
|
|
|
|
extern size_t pdfioImageGetBytesPerLine(pdfio_obj_t *obj) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern double pdfioImageGetHeight(pdfio_obj_t *obj) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern double pdfioImageGetWidth(pdfio_obj_t *obj) _PDFIO_PUBLIC;
|
2021-05-29 04:05:44 +02:00
|
|
|
|
|
2021-05-19 01:08:50 +02:00
|
|
|
|
// Page dictionary helpers...
|
2021-07-24 19:08:46 +02:00
|
|
|
|
extern bool pdfioPageDictAddColorSpace(pdfio_dict_t *dict, const char *name, pdfio_array_t *data) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioPageDictAddFont(pdfio_dict_t *dict, const char *name, pdfio_obj_t *obj) _PDFIO_PUBLIC;
|
|
|
|
|
|
extern bool pdfioPageDictAddImage(pdfio_dict_t *dict, const char *name, pdfio_obj_t *obj) _PDFIO_PUBLIC;
|
2021-05-19 01:08:50 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# ifdef __cplusplus
|
|
|
|
|
|
}
|
|
|
|
|
|
# endif // __cplusplus
|
|
|
|
|
|
#endif // !PDFIO_CONTENT_H
|
