/* Copyright (C) 2018-2020, Dirk Krause SPDX-License-Identifier: BSD-3-Clause */ /* WARNING: This file was generated by the dkct program (see http://dktools.sourceforge.net/ for details). Changes you make here will be lost if dkct is run again! You should modify the original source and run dkct on it. Original source: dk4pppta.ctr */ #ifndef DK4PPPTA_H_INCLUDED /** Avoid multiple inclusions. */ #define DK4PPPTA_H_INCLUDED 1 #line 8 "dk4pppta.ctr" /** @file dk4pppta.h PGF/PDF/PS+TeX output with dk4_app_t support. */ #ifndef DK4CONF_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4conf.h" #else #include #endif #endif #ifndef DK4TYPES_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4types.h" #else #include #endif #endif #ifndef DK4ERROR_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4error.h" #else #include #endif #endif #ifndef DK4PPPT_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4pppt.h" #else #include #endif #endif #ifndef DK4APP_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4app.h" #else #include #endif #endif #ifdef __cplusplus extern "C" { #endif /** Open an output structure. @param texname Name of TeX output file. The name ends on ".tex". The name of the included *.eps or *.pdf file is derived from this name. @param dr Output driver. @param isdoc Flag: Produce LaTeX document, not just image. @param flags Additional flags for graphics. @param width Image width in bp (PS point). @param height Image height in bp. @param app Application structure for diagnostics, may be NULL. @return Valid pointer to new output structure on success, NULL on error. */ dk4_pppt_t * dk4pppt_app_open( const dkChar *texname, dk4_pppt_driver_t dr, int isdoc, int flags, size_t width, size_t height, dk4_app_t *app ); /** Write output file(s) and close output structure. @param pppt Output structure to write and close. @param app Application structure for diagnostics, may be NULL. @return 1 on success, 0 on error. */ int dk4pppt_app_write_and_close( dk4_pppt_t *pppt, dk4_app_t *app ); /** Close output structure without writing. This function can be used after errors to close the structure without any attempt to overwrite existing files. @param pppt Output structure to close. */ void dk4pppt_app_close( dk4_pppt_t *pppt ); /** Set flag for simplified gsave/grestore handling. Set this flag, if you use gsave and grestore only to save and restore the clip path for pattern filling. @param pppt Output structure. @param val Flag: Simplified gsave and grestore handling. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_set_gs_for_pattern_only( dk4_pppt_t *pppt, int val, dk4_app_t *app ); /** Save current graphics state (especially clip path). @param pppt Output structure. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_gsave( dk4_pppt_t *pppt, int *backptr, dk4_app_t *app ); /** Restore graphics state (especially clip path). @param pppt Output structure. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_grestore( dk4_pppt_t *pppt, int *backptr, dk4_app_t *app ); /** Set line width. @param pppt Output structure. @param lw Line width in bp. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_set_line_width( dk4_pppt_t *pppt, double lw, int *backptr, dk4_app_t *app ); /** Set line style. @param pppt Output structure. @param ls Line style. @param sv Style value (dash length in bp). @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_set_line_style( dk4_pppt_t *pppt, dk4_gra_ls_t ls, double sv, int *backptr, dk4_app_t *app ); /** Set line cap. @param pppt Output structure. @param lc Line cap type. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_set_line_cap( dk4_pppt_t *pppt, dk4_gra_lc_t lc, int *backptr, dk4_app_t *app ); /** Set line join. @param pppt Output structure. @param lj Line join type. @param ml Miter limit, only used if lj is DK4_GRA_LJ_MITERED. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_set_line_join( dk4_pppt_t *pppt, dk4_gra_lj_t lj, double ml, int *backptr, dk4_app_t *app ); /** Set fill color to gray. @param pppt Output structure. @param g Gray value in interval 0 to 1. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_set_fill_gray( dk4_pppt_t *pppt, double g, int *backptr, dk4_app_t *app ); /** Set fill color to RGB. @param pppt Output structure. @param r Red value in interval 0 to 1. @param g Green value in interval 0 to 1. @param b Blue value in interval 0 to 1. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_set_fill_rgb( dk4_pppt_t *pppt, double r, double g, double b, int *backptr, dk4_app_t *app ); /** Set fill color to CMYK. @param pppt Output structure. @param c Cyan value in interval 0 to 1. @param m Magenta value in interval 0 to 1. @param y Yellow value in interval 0 to 1. @param k Black value in interval 0 to 1. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_set_fill_cmyk( dk4_pppt_t *pppt, double c, double m, double y, double k, int *backptr, dk4_app_t *app ); /** Set stroke color to gray. @param pppt Output structure. @param g Gray value in interval 0 to 1. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_set_stroke_gray( dk4_pppt_t *pppt, double g, int *backptr, dk4_app_t *app ); /** Set stroke color to RGB. @param pppt Output structure. @param r Red value in interval 0 to 1. @param g Green value in interval 0 to 1. @param b Blue value in interval 0 to 1. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_set_stroke_rgb( dk4_pppt_t *pppt, double r, double g, double b, int *backptr, dk4_app_t *app ); /** Set stroke color to CMYK. @param pppt Output structure. @param c Cyan value in interval 0 to 1. @param m Magenta value in interval 0 to 1. @param y Yellow value in interval 0 to 1. @param k Black value in interval 0 to 1. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_set_stroke_cmyk( dk4_pppt_t *pppt, double c, double m, double y, double k, int *backptr, dk4_app_t *app ); /** Prepare output structure for a fill operation. Use this function before you start to construct a path you plan to fill. @param pppt Output structure. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_prepare_fill( dk4_pppt_t *pppt, int *backptr, dk4_app_t *app ); /** Prepare output structure for a stroke operation. Use this function before you start to construct a path you plan to stroke. @param pppt Output structure. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_prepare_stroke( dk4_pppt_t *pppt, int *backptr, dk4_app_t *app ); /** Prepare output structure for a combined fill and stroke operation. Use this function before you start to construct a path you plan to fill and stroke. @param pppt Output structure. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_prepare_fill_and_stroke( dk4_pppt_t *pppt, int *backptr, dk4_app_t *app ); /** Check whether a combined fill and close operation is available for an output structure. @param pppt Output structure to test. @return 1 if a fill-and-close operation is available, 0 otherwise. */ int dk4pppt_app_can_fill_and_stroke( dk4_pppt_t *pppt ); /** Fill current path. Note: Use dk4gra_prepare_fill() before you start to construct a path you plan to fill. @param pppt Output structure. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_fill( dk4_pppt_t *pppt, int *backptr, dk4_app_t *app ); /** Stroke current path. Note: Use dk4gra_prepare_stroke() before you start to construct a path you plan to stroke. @param pppt Output structure. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_stroke( dk4_pppt_t *pppt, int *backptr, dk4_app_t *app ); /** Fill and stroke current path. Note: Use dk4gra_prepare_fill_and_stroke() before you start to construct a path you plan to fill and stroke. @param pppt Output structure. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_fill_and_stroke( dk4_pppt_t *pppt, int *backptr, dk4_app_t *app ); /** Use current path for clipping. @param pppt Output structure. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_clip( dk4_pppt_t *pppt, int *backptr, dk4_app_t *app ); /** Pattern a region (clipping should be set to the path). @param pppt Output structure. @param xl Left y coordinate. @param xr Right x coordinate. @param yb Bottom y coordinate. @param yt Top y coordinate. @param pn Pattern number. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_pattern( dk4_pppt_t *pppt, double xl, double xr, double yb, double yt, dk4_gra_pattern_t pn, int *backptr, dk4_app_t *app ); /** Start a new path and move to first point. @param pppt Output structure. @param x X coordinate of start point. @param y Y coordinate of start point. @param bbptr Bounding box, may be NULL. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_newpath_moveto( dk4_pppt_t *pppt, double x, double y, dk4_bb_t *bbptr, int *backptr, dk4_app_t *app ); /** Add line from current point to new point to path. @param pppt Output structure. @param x X coordinate of new point. @param y Y coordinate of new point. @param bbptr Bounding box, may be NULL. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_lineto( dk4_pppt_t *pppt, double x, double y, dk4_bb_t *bbptr, int *backptr, dk4_app_t *app ); /** Add Bezier curve segment from current point to new point in path. @param pppt Output structure. @param xc1 X coordinate of first control point. @param yc1 Y coordinate of first control point. @param xc2 X coordinate of second control point. @param yc2 Y coordinate of second control point. @param x X coordinate of new point. @param y Y coordinate of new point. @param bbptr Bounding box, may be NULL. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_curveto( dk4_pppt_t *pppt, double xc1, double yc1, double xc2, double yc2, double x, double y, dk4_bb_t *bbptr, int *backptr, dk4_app_t *app ); /** Close current path. @param pppt Output structure. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_closepath( dk4_pppt_t *pppt, int *backptr, dk4_app_t *app ); /** Add bitmap image XFig style. @param pppt Output structure. @param xl Left x coordinate. @param xr Right x coordinate. @param yb Bottom y coordinate. @param yt Top y coordinate. @param bif Bitmap image file. @param fn Image file name. @param fno Frame number (0 for first frame). @param pos Image positioning: - 0 not rotated, not flipped, - 1 rotated 90 degree counterclockwise, not flipped, - 2 rotated 180 degree counterclockwise, not flipped, - 3 rotated 270 degree counterclockwise, not flipped, - 4 not rotated, flipped, - 5 rotated 90 degree counterclockwise, flipped, - 6 rotated 180 degree counterclockwise, flipped, - 7 rotated 270 degree counterclockwise, flipped. @param ifl Image flags. @param bbptr Bounding box, may be NULL. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_bif_fig_image( dk4_pppt_t *pppt, double xl, double xr, double yb, double yt, dk4_bif_t *bif, const dkChar *fn, size_t fno, int pos, int ifl, dk4_bb_t *bbptr, int *backptr, dk4_app_t *app ); /** Add bitmap image. @param pppt Output structure. @param xl Left x coordinate. @param xr Right x coordinate. @param yb Bottom y coordinate. @param yt Top y coordinate. @param bif Bitmap image file data. @param fn Image file name. @param fno Frame number (0 for first frame). @param ifl Image flags. @param bbptr Bounding box, may be NULL. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_bif_image( dk4_pppt_t *pppt, double xl, double xr, double yb, double yt, dk4_bif_t *bif, const dkChar *fn, size_t fno, int ifl, dk4_bb_t *bbptr, int *backptr, dk4_app_t *app ); /** Add bitmap image. @param pppt Output structure. @param xl Left x coordinate. @param xr Right x coordinate. @param yb Bottom y coordinate. @param yt Top y coordinate. @param fn Image file name. @param fno Frame number (0 for first frame). @param ctx Bitmap image conversion context, may be NULL. @param ifl Image flags. @param bbptr Bounding box, may be NULL. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_image( dk4_pppt_t *pppt, double xl, double xr, double yb, double yt, const dkChar *fn, size_t fno, dk4_cs_conv_ctx_t *ctx, int ifl, dk4_bb_t *bbptr, int *backptr, dk4_app_t *app ); /** Add bitmap image XFig style. @param pppt Output structure. @param xl Left x coordinate. @param xr Right x coordinate. @param yb Bottom y coordinate. @param yt Top y coordinate. @param fn Image file name. @param fno Frame number (0 for first frame). @param ctx Bitmap image conversion context, may be NULL. @param pos Image positioning: - 0 not rotated, not flipped, - 1 rotated 90 degree counterclockwise, not flipped, - 2 rotated 180 degree counterclockwise, not flipped, - 3 rotated 270 degree counterclockwise, not flipped, - 4 not rotated, flipped, - 5 rotated 90 degree counterclockwise, flipped, - 6 rotated 180 degree counterclockwise, flipped, - 7 rotated 270 degree counterclockwise, flipped. @param ifl Image flags. @param bbptr Bounding box, may be NULL. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_fig_image( dk4_pppt_t *pppt, double xl, double xr, double yb, double yt, const dkChar *fn, size_t fno, dk4_cs_conv_ctx_t *ctx, int pos, int ifl, dk4_bb_t *bbptr, int *backptr, dk4_app_t *app ); /** Create path for a circle. @param pppt Output structure. @param xc Center point x coordinate. @param yc Center point y coordinate. @param r Radius. @param bbptr Bounding box, may be NULL. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_circle( dk4_pppt_t *pppt, double xc, double yc, double r, dk4_bb_t *bbptr, int *backptr, dk4_app_t *app ); /** Create path for rectangle parallel to axes, optionally with rounded corners. @param pppt Output structure. @param xl Left x coordinate. @param xr Right x coordinate. @param yb Bottom y coordinate. @param yt Top y coordinate. @param r Corner radius, maximum is a half of the smaller side length. Use negative values to avoid rounded corners. @param bbptr Bounding box, may be NULL. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_rectangle( dk4_pppt_t *pppt, double xl, double xr, double yb, double yt, double r, dk4_bb_t *bbptr, int *backptr, dk4_app_t *app ); /** Add path for an arc. @param pppt Output structure. @param xc Center point x coordinate. @param yc Center point y coordinate. @param ra Radius. @param start Start angle in degree. @param end End angle in degree. @param cl Flag: Draw closed arc (piece of cake) instead of simple arc. @param bbptr Bounding box, may be NULL. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_arc( dk4_pppt_t *pppt, double xc, double yc, double ra, double start, double end, int cl, dk4_bb_t *bbptr, int *backptr, dk4_app_t *app ); /** Create path for an ellipse. @param pppt Output structure. @param xc Center point x coordinate. @param yc Center point y coordinate. @param rx Radius in x direction. @param ry Radius in y direction. @param rot Rotation counterclockwise in degree. @param bbptr Bounding box, may be NULL. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_ellipse( dk4_pppt_t *pppt, double xc, double yc, double rx, double ry, double rot, dk4_bb_t *bbptr, int *backptr, dk4_app_t *app ); /** Add simple (non-special) text to PGF graphics. The text is shown in the current fill color (non-stroking color) unless colspec is used to specify a color. @param pppt Output structure, must be initialized for PGF. @param x X coordinate. @param y Y coordinate. @param txt Text to show. @param colspec Color specification, may be NULL to use fill color. @param ie Text encoding, only used for char text. @param ha Horizontal alignment. @param va Vertical alignment. @param fno Font number. @param fsz Font size in pt. @param fex Flag: Use exact font (1) or similar font (0). @param uc2l UC to LaTeX conversion structure. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_simple_text( dk4_pppt_t *pppt, double x, double y, const dkChar *txt, const char *colspec, int ie, dk4_text_align_h_t ha, dk4_text_align_v_t va, int fno, double fsz, dk4_gra_tf_t fex, dk4_uc2l_t *uc2l, int *backptr, dk4_app_t *app ); /** Add special text to PGF graphics. The text is shown in the current fill color (non-stroking color) unless colspec is used to specify a color. @param pppt Output structure, must be initialized for PGF. @param x X coordinate. @param y Y coordinate. @param txt Text to show. @param colspec Color specification, may be NULL to use the fill colorö. @param ha Horizontal alignment. @param va Vertical alignment. @param fno Font number. @param fsz Font size in pt. @param fex Flag: Use exact font. @param backptr Address of success variable to reset on errors. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_special_text( dk4_pppt_t *pppt, double x, double y, const char *txt, const char *colspec, dk4_text_align_h_t ha, dk4_text_align_v_t va, int fno, double fsz, dk4_gra_tf_t fex, int *backptr, dk4_app_t *app ); /** Set flag for even-odd-rule. If this flag is on, the even-odd-rule is used for filling and clipping. Otherwise the nonzero-winding rule is used. By default this flag is turned on when creating a dk4_gra_t structure. @param pppt Output structure. @param val New flag value. */ void dk4pppt_app_set_eorule( dk4_pppt_t *pppt, int val ); /** Set document font size. @param pppt Output structure. @param fs New font size. @param backptr Address of success variable to reset on error. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_doc_font_size( dk4_pppt_t *pppt, double fs, int *backptr, dk4_app_t *app ); /** Add one preamble line. @param pppt Output structure. @param line Line to add without trailing newline. @param tp Preamble line type. @param backptr Address of success variable to reset on error. @param app Application structure for diagnostics, may be NULL. */ void dk4pppt_app_doc_preamble_line( dk4_pppt_t *pppt, const char *line, int tp, int *backptr, dk4_app_t *app ); #ifdef __cplusplus } #endif #endif