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