summaryrefslogtreecommitdiff
path: root/support/dktools/dk4paper.h
blob: 6afcd696ecf90366e5d33a0f75f0880e5df84370 (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
/*
	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: dk4paper.ctr
*/

/*
Copyright (C) 2016-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.
*/

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


#line 9 "dk4paper.ctr"

/**	@file	dk4paper.h	Read paper sizes.
*/

#ifndef	DK4CONF_H_INCLUDED
#include "dk4conf.h"
#endif

#ifndef	DK4TYPES_H_INCLUDED
#include "dk4types.h"
#endif

#ifndef	DK4ERROR_H_INCLUDED
#include "dk4error.h"
#endif

#ifndef	DK4STO_H_INCLUDED
#include "dk4sto.h"
#endif


/**	One paper size.
*/
typedef struct {
	dkChar	*name;	/**< Paper format name. */
	double	 w;		/**< Paper width in PS points. */
	double	 h;		/**< Paper height. */
	double	 i;		/**< Left or inner border. */
	double	 o;		/**< Right or outer border. */
	double	 t;		/**< Top border. */
	double	 b;		/**< Bottom border. */
} dk4_paper_size_t;


/**	Collection of paper sizes read from files.
*/
typedef struct {
	dk4_sto_t		*s_ps;	/**< Storage for paper sizes. */
	dk4_sto_it_t	*i_ps;	/**< Iterator through storage. */
} dk4_paper_size_collection_t;

#ifdef	__cplusplus
extern "C" {
#endif


/**	Open a new paper size collection with minimum entries only.
	@param	erp	Error report, may be NULL.
*/

dk4_paper_size_collection_t *
dk4papersize_coll_open(dk4_er_t *erp);


/**	Open a new paper size collection, search for configuration files
	and apply them.
	Note: Programs using the dk4_app_t type should use the
	dk4app_get_paper_sizes() from the dk4papea module instead.
	@param	progname	Program name.
	@param	grpname		Program group name.
	@param	erp			Error report, may be NULL.
	@return	Valid pointer on success, NULL on error.
*/

dk4_paper_size_collection_t *
dk4papersize_coll_for_application(
	const dkChar	*progname,
	const dkChar	*grpname,
	dk4_er_t		*erp
);


/**	Close paper size collection, release memory.
	@param	ptr	Paper size collection to close.
*/

void
dk4papersize_coll_close(dk4_paper_size_collection_t *ptr);


/**	Find a specific paper size in the collection.
	Note: Do not mix search and traversal mechanism, use exactly
	one method from the following three:
	- Find paper size entry by name using dk4papersize_coll_find(),
	- Get number of paper sizes using dk4papersize_coll_size() and use
	  dk4papersize_coll_get() to get an entry for a given index,
	- Reset the collection using dk4papersize_coll_reset() and retrieve
	  the next entry using dk4papersize_coll_next(), repeat
	  dk4papersize_coll_next() until it returns NULL.
	All three methods use and modify the same internal container iterator,
	so mixing the methods is not a good idea.
	@param	ptr		Paper size collection to search for a paper size.
	@param	name	Name of paper size to find.
	@param	erp		Error report, may be NULL.
	@return	Pointer to paper size on success, NULL on error or not found.
*/

const dk4_paper_size_t *
dk4papersize_coll_find(
	dk4_paper_size_collection_t	*ptr,
	const dkChar				*name,
	dk4_er_t					*erp
);


/**	Get number of paper sizes stored in the collection.
	Note: Do not mix search and traversal mechanism, use exactly
	one method from the following three:
	- Find paper size entry by name using dk4papersize_coll_find(),
	- Get number of paper sizes using dk4papersize_coll_size() and use
	  dk4papersize_coll_get() to get an entry for a given index,
	- Reset the collection using dk4papersize_coll_reset() and retrieve
	  the next entry using dk4papersize_coll_next(), repeat
	  dk4papersize_coll_next() until it returns NULL.
	All three methods use and modify the same internal container iterator,
	so mixing the methods is not a good idea.
	@param	ptr	Paper size collection to query.
	@return	Positive number of paper sizes on success, 0 on error.
*/

size_t
dk4papersize_coll_size(dk4_paper_size_collection_t *ptr);


/**	Get paper size entry from collection by number.
	Note: Do not mix search and traversal mechanism, use exactly
	one method from the following three:
	- Find paper size entry by name using dk4papersize_coll_find(),
	- Get number of paper sizes using dk4papersize_coll_size() and use
	  dk4papersize_coll_get() to get an entry for a given index,
	- Reset the collection using dk4papersize_coll_reset() and retrieve
	  the next entry using dk4papersize_coll_next(), repeat
	  dk4papersize_coll_next() until it returns NULL.
	All three methods use and modify the same internal container iterator,
	so mixing the methods is not a good idea.
	@param	ptr	Paper size collection to query.
	@param	n	Index of paper size entry, 0 for the first.
	@return	Valid pointer on success, NULL on error.
*/

const dk4_paper_size_t *
dk4papersize_coll_get(dk4_paper_size_collection_t *ptr, size_t n);


/**	Reset collection (start traversing at beginning).
	Note: Do not mix search and traversal mechanism, use exactly
	one method from the following three:
	- Find paper size entry by name using dk4papersize_coll_find(),
	- Get number of paper sizes using dk4papersize_coll_size() and use
	  dk4papersize_coll_get() to get an entry for a given index,
	- Reset the collection using dk4papersize_coll_reset() and retrieve
	  the next entry using dk4papersize_coll_next(), repeat
	  dk4papersize_coll_next() until it returns NULL.
	All three methods use and modify the same internal container iterator,
	so mixing the methods is not a good idea.
	@param	ptr	Paper size collection to reset.
*/

void
dk4papersize_coll_reset(dk4_paper_size_collection_t *ptr);


/**	Get next paper size from collection.
	Note: Do not mix search and traversal mechanism, use exactly
	one method from the following three:
	- Find paper size entry by name using dk4papersize_coll_find(),
	- Get number of paper sizes using dk4papersize_coll_size() and use
	  dk4papersize_coll_get() to get an entry for a given index,
	- Reset the collection using dk4papersize_coll_reset() and retrieve
	  the next entry using dk4papersize_coll_next(), repeat
	  dk4papersize_coll_next() until it returns NULL.
	All three methods use and modify the same internal container iterator,
	so mixing the methods is not a good idea.
	@param	ptr	Paper size collection to query.
	@return	Valid pointer on success, NULL on error or end of collection.
*/

const dk4_paper_size_t *
dk4papersize_coll_next(dk4_paper_size_collection_t *ptr);


/**	Create a new paper size structure, allocate memory.
	@param	name	Name of paper size.
	@param	erp		Error report, may be NULL.
	@return	Pointer to new paper size structure on success, NULL on error.
*/

dk4_paper_size_t *
dk4papersize_new(const dkChar *name, dk4_er_t *erp);


/**	Destroy a paper size structure, release memory.
	@param	pps	Paper size structure to destroy.
*/

void
dk4papersize_delete(dk4_paper_size_t *pps);


/**	Compare two paper sizes.
	@param	l	Left object pointer.
	@param	r	Right object or name pointer.
	@param	cr	Comparison criteria: 0=papersize/papersize, 1=papersize/name.
	@return	Comparison result.
*/

int
dk4papersize_cmp(const void *l, const void *r, int cr);


/**	Get paper width from paper size record.
	@param	psptr	Paper size record to query.
	@return	Positive result on success, negative value on error.
*/

double
dk4papersize_get_width(const dk4_paper_size_t *psptr);


/**	Get paper height from paper size record.
	@param	psptr	Paper size record to query.
	@return	Positive result on success, negative value on error.
*/

double
dk4papersize_get_height(const dk4_paper_size_t *psptr);


/**	Get left (inner) border from paper size record.
	@param	psptr	Paper size record to query.
	@return	Non-negative result on success, negative value on error.
*/

double
dk4papersize_get_left_border(const dk4_paper_size_t *psptr);


/**	Get right (outer) border from paper size record.
	@param	psptr	Paper size record to query.
	@return	Non-negative result on success, negative value on error.
*/

double
dk4papersize_get_right_border(const dk4_paper_size_t *psptr);


/**	Get top border from paper size record.
	@param	psptr	Paper size record to query.
	@return	Non-negative result on success, negative value on error.
*/

double
dk4papersize_get_top_border(const dk4_paper_size_t *psptr);


/**	Get bottom border from paper size record.
	@param	psptr	Paper size record to query.
	@return	Non-negative result on success, negative value on error.
*/

double
dk4papersize_get_bottom_border(const dk4_paper_size_t *psptr);


/**	Get name for paper size.
	@param	psptr	Paper size record to query.
	@return	Valid pointer on success, NULL on error or empty name.
*/

const dkChar *
dk4papersize_get_name(const dk4_paper_size_t *psptr);

#ifdef	__cplusplus
}
#endif


/* vim: set ai sw=4 ts=4 : */

#endif