summaryrefslogtreecommitdiff
path: root/support/dktools/dk3pdf.h
blob: 5a9e03e5755e275c95dd68bbb906866b55c51c8a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
/*
	WARNING: This file was generated by dkct.
	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: dk3pdf.ctr
*/

/*
Copyright (C) 2011-2017, Dirk Krause

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above opyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
* Neither the name of the author nor the names of contributors may be used
  to endorse or promote products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

/**	@file dk3pdf.h Header file for the dk3pdf module.
*/

#ifndef DK3PDF_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK3PDF_H_INCLUDED 1


#line 10 "dk3pdf.ctr"

#ifdef __cplusplus
extern "C" {
#endif

/**	Create PDF writer structure.
	@param	app	Application structure, required here.
	@return	Pointer to new structure on success, NULL on error.
*/
dk3_pdf_t *
dk3pdf_open_app(dk3_app_t *app);

/**	Write PDF to output file.
	@param	pdf	PDF writer structure.
	@param	ofile	Output file.
	@return	1 on success, 0 on error.
*/
int
dk3pdf_write_file(dk3_pdf_t *pdf, FILE *ofile);

/**	Write PDF to output file.
	@param	pdf	PDF writer structure.
	@param	ofile	Output file.
	@param	pcomm	Communicator object.
	@param	minpb	Minimum progress bar value.
	@param	maxpb	Maximum progress bar value.
	@return	1 on success, 0 on error.
*/
int
dk3pdf_write_file_progress(
  dk3_pdf_t	*pdf,
  FILE		*ofile,
  void		*pcomm,
  int		 minpb,
  int		 maxpb
);

/**	Destroy PDF writer structure, release memory.
	@param	pdf	Structure to destroy.
*/
void
dk3pdf_close(dk3_pdf_t *pdf);

/**	Prepare media box for next page to open.
	@param	pdf	PDF writer structure.
	@param	x0	Left x.
	@param	x1	Right x.
	@param	y0	Bottom y.
	@param	y1	Top y.
*/
void
dk3pdf_set_next_mediabox(
  dk3_pdf_t	*pdf,
  long		 x0,
  long		 x1,
  long		 y0,
  long		 y1
);

/**	Open a new page.
	@param	pdf	PDF writer structure.
	@return	1 on success, 0 on error.
*/
int
dk3pdf_open_page(dk3_pdf_t *pdf);

/**	Open a new page, set clip path to media box.
	@param	pdf	PDF writer structure.
	@param	wc	Flag: With clip path setting.
	@return	1 on success, 0 on error.
*/
int
dk3pdf_open_page_with_clip(dk3_pdf_t *pdf, int wc);

/**	Close the current page.
	@param	pdf	PDF writer structure.
	@return	1 on success, 0 on error.
*/
int
dk3pdf_close_page(dk3_pdf_t *pdf);

/**	Write save graphics state instruction to current page.
	@param	pdf	PDF writer structure.
	@return	1 on success, 0 on error.
*/
int
dk3pdf_gsave(dk3_pdf_t *pdf);

/**	Write restore graphics state instruction to current page.
	@param	pdf	PDF writer structure.
	@return	1 on success, 0 on error.
*/
int
dk3pdf_grestore(dk3_pdf_t *pdf);

/**	Translate coordinates, use long values.
	@param	pdf	PDF writer structure.
	@param	x	X translation.
	@param	y	Y translation.
	@return	1 on success, 0 on error.
*/
int
dk3pdf_translate_long(dk3_pdf_t *pdf, long x, long y);

/**	Translate coordinates, use double values.
	@param	pdf	PDF writer structure.
	@param	x	X translation.
	@param	y	Y translation.
	@return	1 on success, 0 on error.
*/
int
dk3pdf_translate_double(dk3_pdf_t *pdf, double x, double y);

/**	Rotate coordinates, use integer value.
	@param	pdf	PDF writer structure.
	@param	angle	Rotation angle in degree.
	@return	1 on success, 0 on error.
*/
int
dk3pdf_rotate_int(dk3_pdf_t *pdf, int angle);

/**	Rotate coordinates, use double value.
	@param	pdf	PDF writer structure.
	@param	angle	Rotation angle in degree.
	@return	1 on success, 0 on error.
*/
int
dk3pdf_rotate_double(dk3_pdf_t *pdf, double angle);

/**	Scale coordinates, use long values.
	@param	pdf	PDF writer structure.
	@param	x	X scale factor.
	@param	y	Y scale factor.
	@return	1 on success, 0 on error.
*/
int
dk3pdf_scale_long(dk3_pdf_t *pdf, long x, long y);

/**	Scale coordinates, use double values.
	@param	pdf	PDF writer structure.
	@param	x	X scale factor.
	@param	y	Y scale factor.
	@return	1 on success, 0 on error.
*/
int
dk3pdf_scale_double(dk3_pdf_t *pdf, double x, double y);

/**	Add XObject to current page.
	@param	pdf	PDF writer structure.
	@param	xo	XObject to add.
	@return	1 on success, 0 on error.
*/
int
dk3pdf_add_xobject_to_page(dk3_pdf_t *pdf, dk3_pdf_xobject_t *xo);

/**	Add image.
	@param	pdf		PDF writer structure.
	@param	bif		Image, the current frame will be added.
	@param	opt		Conversion options.
	@param	pc		Communicator object.
	@param	min		Minimum progress bar value (0-1000).
	@param	max		Maximum progress bar value (0-1000).
	@return	Pointer to object on success, NULL on error.
*/
dk3_pdf_xobject_t *
dk3pdf_add_image_progress(
  dk3_pdf_t		*pdf,
  dk3_bif_t		*bif,
  dk3_bm_eps_options_t	*opt,
  void			*pc,
  int			 min,
  int			 max
);

/**	Add image.
	@param	pdf		PDF writer structure.
	@param	bif		Image, the current frame will be added.
	@param	opt		Conversion options.
	@return	Pointer to object on success, NULL on error.
*/
dk3_pdf_xobject_t *
dk3pdf_add_image(
  dk3_pdf_t		*pdf,
  dk3_bif_t		*bif,
  dk3_bm_eps_options_t	*opt
);

/**	PDF newpath and lineto. Start new path and move to specified position.
	@param	pdf	PDF writer structure.
	@param	x	New x position.
	@param	y	New y position.
	@return	1 on success, 0 on error.
*/
int
dk3pdf_newpath_moveto(dk3_pdf_t *pdf, double x, double y);

/**	PDF lineto.
	@param	pdf	PDF writer structure.
	@param	x	New x
	@param	y	New y.
	@return	1 on success, 0 on error.
*/
int
dk3pdf_lineto(dk3_pdf_t *pdf, double x, double y);

/**	PDF curveto.
	@param	pdf	PDF writer structure.
	@param	xcs	Control point X near start.
	@param	ycs	Control point Y near start.
	@param	xce	Control point X near end.
	@param	yce	Control point Y near end.
	@param	xe	End point X.
	@param	ye	End point Y.
	@return	1 on success, 0 on error.
*/
int
dk3pdf_curveto(
  dk3_pdf_t *pdf,
  double xcs, double ycs,
  double xce, double yce,
  double xe,  double ye
);

/**	Set nonstroking gray.
	@param	pdf	PDF writer structure.
	@param	g	New gray value.
	@return 1 on success, 0 on error.
*/
int
dk3pdf_set_nonstroking_gray(dk3_pdf_t *pdf, double g);

/**	Set stroking gray.
	@param	pdf	PDF writer structure.
	@param	g	New gray value.
	@return 1 on success, 0 on error.
*/
int
dk3pdf_set_stroking_gray(dk3_pdf_t *pdf, double g);

/**	Close path, fill (non-zero winding rule), and stroke path.
	@param	pdf	PDF writer structure.
	@return	1 on success, 0 on error.
*/
int
dk3pdf_closepath_fill_stroke_nz(dk3_pdf_t *pdf);

/**	Close path, fill (even/odd rule), and stroke path.
	@param	pdf	PDF writer structure.
	@return	1 on success, 0 on error.
*/
int
dk3pdf_closepath_fill_stroke_eo(dk3_pdf_t *pdf);

/**	Close path.
	@param	pdf	PDF writer structure.
	@return	1 on success, 0 on error.
*/
int
dk3pdf_closepath(dk3_pdf_t *pdf);

/**	Fill current path (non-zero winding rule).
	@param	pdf	PDF writer structure.
	@return	1 on success, 0 on error.
*/
int
dk3pdf_fill_nz(dk3_pdf_t *pdf);

/**	Fill current path (even/odd rule).
	@param	pdf	PDF writer structure.
	@return	1 on success, 0 on error.
*/
int
dk3pdf_fill_eo(dk3_pdf_t *pdf);

/**	Clip to current path (even/odd rule).
	@param	pdf	PDF writer structure.
	@return	1 on success, 0 on error.
*/
int
dk3pdf_clip_eo(dk3_pdf_t *pdf);

/**	Clip to current path (non-zero rule).
	@param	pdf	PDF writer structure.
	@return	1 on success, 0 on error.
*/
int
dk3pdf_clip_nz(dk3_pdf_t *pdf);

/**	Set RGB color for nonstroking operations.
	@param	pdf	PDF writer structure.
	@param	r	Red.
	@param	g	Green.
	@param	b	Blue.
	@return	1 on success, 0 on error.
*/
int
dk3pdf_nonstroking_rgb(dk3_pdf_t *pdf, double r, double g, double b);

/**	Set RGB color for stroking operations.
	@param	pdf	PDF writer structure.
	@param	r	Red.
	@param	g	Green.
	@param	b	Blue.
	@return	1 on success, 0 on error.
*/
int
dk3pdf_stroking_rgb(dk3_pdf_t *pdf, double r, double g, double b);

/**	Set line cap mode.
	@param	pdf	PDF writer structure.
	@param	lc	Line cap DK3_LINECAP_xxx, see @ref linecap.
	@return	1 on success, 0 on error.
*/
int
dk3pdf_set_linecap(dk3_pdf_t *pdf, int lc);

/**	Set line join mode.
	@param	pdf	PDF writer structure.
	@param	lj	Line cap DK3_LINECAP_xxx, see @ref linecap.
	@return	1 on success, 0 on error.
*/
int
dk3pdf_set_linejoin(dk3_pdf_t *pdf, int lj);

/**	Set line dash pattern.
	@param	pdf	PDF writer structure.
	@param	sv	Style values array.
	@param	nsv	Number of elements in sv.
	@param	ph	Phase (initial shift).
	@return	1 on success, 0 on error.
*/
int
dk3pdf_set_line_dash(dk3_pdf_t *pdf, double *sv, size_t nsv, double ph);

/**	Stroke current path.
	@param	pdf	PDF writer structure.
	@return	1 on success, 0 on error.
*/
int
dk3pdf_stroke(dk3_pdf_t *pdf);

/**	Set line width for stroke operations.
	@param	pdf	PDF writer structure.
	@param	lw	New line width.
	@return	1 on success, 0 on error.
*/
int
dk3pdf_set_linewidth(dk3_pdf_t *pdf, double lw);

/**	Create image XObject.
	@param	pdf	PDF writer structure.
	@param	bif	Image, the current frame will be added.
	@param	opt	Conversion options.
	@param	pc	Communication object.
	@param	min	Minimum progress bar value (0-1000).
	@param	max	Maximum progress bar value (0-1000).
	@return	Pointer to new object on success, NULL on error.
*/
dk3_pdf_xobject_t *
dk3pdf_create_ixobject_progress(
  dk3_pdf_t		*pdf,
  dk3_bif_t		*bif,
  dk3_bm_eps_options_t	*opt,
  void			*pc,
  int			 min,
  int			 max
);

/**	Write debug line to graphics contents stream.
	@param	pdf	PDF output structure.
	@param	txt	Text to write.
	@return	1 on success, 0 on error.
*/
int
dk3pdf_write_debug_line(dk3_pdf_t *pdf, char const *txt);

#ifdef __cplusplus
}
#endif




#endif