xref: /openbsd-src/usr.bin/mandoc/out.h (revision e5157e49389faebcb42b7237d55fbf096d9c2523)
1 /*	$OpenBSD: out.h,v 1.15 2014/10/14 02:16:02 schwarze Exp $ */
2 /*
3  * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4  *
5  * Permission to use, copy, modify, and distribute this software for any
6  * purpose with or without fee is hereby granted, provided that the above
7  * copyright notice and this permission notice appear in all copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16  */
17 #ifndef OUT_H
18 #define OUT_H
19 
20 enum	roffscale {
21 	SCALE_CM, /* centimeters (c) */
22 	SCALE_IN, /* inches (i) */
23 	SCALE_PC, /* pica (P) */
24 	SCALE_PT, /* points (p) */
25 	SCALE_EM, /* ems (m) */
26 	SCALE_MM, /* mini-ems (M) */
27 	SCALE_EN, /* ens (n) */
28 	SCALE_BU, /* default horizontal (u) */
29 	SCALE_VS, /* default vertical (v) */
30 	SCALE_FS, /* syn. for u (f) */
31 	SCALE_MAX
32 };
33 
34 struct	roffcol {
35 	size_t		 width; /* width of cell */
36 	size_t		 decimal; /* decimal position in cell */
37 	int		 flags; /* layout flags, see tbl_cell */
38 };
39 
40 struct	roffsu {
41 	enum roffscale	  unit;
42 	double		  scale;
43 };
44 
45 typedef	size_t	(*tbl_strlen)(const char *, void *);
46 typedef	size_t	(*tbl_len)(size_t, void *);
47 
48 struct	rofftbl {
49 	tbl_strlen	 slen; /* calculate string length */
50 	tbl_len		 len; /* produce width of empty space */
51 	struct roffcol	*cols; /* master column specifiers */
52 	void		*arg; /* passed to slen and len */
53 };
54 
55 __BEGIN_DECLS
56 
57 #define	SCALE_VS_INIT(p, v) \
58 	do { (p)->unit = SCALE_VS; \
59 	     (p)->scale = (v); } \
60 	while (/* CONSTCOND */ 0)
61 
62 #define	SCALE_HS_INIT(p, v) \
63 	do { (p)->unit = SCALE_EN; \
64 	     (p)->scale = (v); } \
65 	while (/* CONSTCOND */ 0)
66 
67 int		  a2roffsu(const char *, struct roffsu *, enum roffscale);
68 void		  tblcalc(struct rofftbl *tbl,
69 			const struct tbl_span *, size_t);
70 
71 __END_DECLS
72 
73 #endif /*!OUT_H*/
74