Commit | Line | Data |
---|---|---|
54ba9607 | 1 | /* $Id: term.h,v 1.131 2019/01/04 03:21:02 schwarze Exp $ */ |
80387638 | 2 | /* |
36342e81 | 3 | * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
54ba9607 | 4 | * Copyright (c) 2011-2015, 2017, 2019 Ingo Schwarze <schwarze@openbsd.org> |
80387638 SW |
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 | * | |
54ba9607 | 10 | * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES |
80387638 | 11 | * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
54ba9607 | 12 | * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR |
80387638 SW |
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 | */ | |
80387638 SW |
18 | |
19 | enum termenc { | |
a4c7eb57 SW |
20 | TERMENC_ASCII, |
21 | TERMENC_LOCALE, | |
22 | TERMENC_UTF8 | |
80387638 SW |
23 | }; |
24 | ||
25 | enum termtype { | |
26 | TERMTYPE_CHAR, | |
27 | TERMTYPE_PS, | |
28 | TERMTYPE_PDF | |
29 | }; | |
30 | ||
31 | enum termfont { | |
32 | TERMFONT_NONE = 0, | |
33 | TERMFONT_BOLD, | |
34 | TERMFONT_UNDER, | |
f88b6c16 | 35 | TERMFONT_BI, |
80387638 SW |
36 | TERMFONT__MAX |
37 | }; | |
38 | ||
54ba9607 SW |
39 | struct eqn_box; |
40 | struct roff_meta; | |
41 | struct roff_node; | |
42 | struct tbl_span; | |
43 | struct termp; | |
80387638 | 44 | |
54ba9607 | 45 | typedef void (*term_margin)(struct termp *, const struct roff_meta *); |
80387638 | 46 | |
80387638 SW |
47 | struct termp_tbl { |
48 | int width; /* width in fixed chars */ | |
49 | int decimal; /* decimal point position */ | |
50 | }; | |
51 | ||
54ba9607 SW |
52 | struct termp_col { |
53 | int *buf; /* Output buffer. */ | |
54 | size_t maxcols; /* Allocated bytes in buf. */ | |
55 | size_t lastcol; /* Last byte in buf. */ | |
56 | size_t col; /* Byte in buf to be written. */ | |
57 | size_t rmargin; /* Current right margin. */ | |
58 | size_t offset; /* Current left margin. */ | |
59 | }; | |
60 | ||
80387638 | 61 | struct termp { |
54ba9607 SW |
62 | struct rofftbl tbl; /* Table configuration. */ |
63 | struct termp_col *tcols; /* Array of table columns. */ | |
64 | struct termp_col *tcol; /* Current table column. */ | |
65 | size_t maxtcol; /* Allocated table columns. */ | |
66 | size_t lasttcol; /* Last column currently used. */ | |
67 | size_t line; /* Current output line number. */ | |
36342e81 | 68 | size_t defindent; /* Default indent for text. */ |
80387638 | 69 | size_t defrmargin; /* Right margin of the device. */ |
070c62a6 | 70 | size_t lastrmargin; /* Right margin before the last ll. */ |
80387638 | 71 | size_t maxrmargin; /* Max right margin. */ |
54ba9607 | 72 | size_t col; /* Byte position in buf. */ |
80387638 | 73 | size_t viscol; /* Chars on current line. */ |
54ba9607 SW |
74 | size_t trailspace; /* See term_flushln(). */ |
75 | size_t minbl; /* Minimum blanks before next field. */ | |
76 | int synopsisonly; /* Print the synopsis only. */ | |
77 | int mdocstyle; /* Imitate mdoc(7) output. */ | |
78 | int ti; /* Temporary indent for one line. */ | |
f88b6c16 | 79 | int skipvsp; /* Vertical space to skip. */ |
80387638 | 80 | int flags; |
54ba9607 SW |
81 | #define TERMP_SENTENCE (1 << 0) /* Space before a sentence. */ |
82 | #define TERMP_NOSPACE (1 << 1) /* No space before words. */ | |
83 | #define TERMP_NONOSPACE (1 << 2) /* No space (no autounset). */ | |
84 | #define TERMP_NBRWORD (1 << 3) /* Make next word nonbreaking. */ | |
85 | #define TERMP_KEEP (1 << 4) /* Keep words together. */ | |
86 | #define TERMP_PREKEEP (1 << 5) /* ...starting with the next one. */ | |
87 | #define TERMP_BACKAFTER (1 << 6) /* Back up after next character. */ | |
88 | #define TERMP_BACKBEFORE (1 << 7) /* Back up before next character. */ | |
7888c61d | 89 | #define TERMP_NOBREAK (1 << 8) /* See term_flushln(). */ |
54ba9607 SW |
90 | #define TERMP_BRTRSP (1 << 9) /* See term_flushln(). */ |
91 | #define TERMP_BRIND (1 << 10) /* See term_flushln(). */ | |
070c62a6 | 92 | #define TERMP_HANG (1 << 11) /* See term_flushln(). */ |
54ba9607 SW |
93 | #define TERMP_NOPAD (1 << 12) /* See term_flushln(). */ |
94 | #define TERMP_NOSPLIT (1 << 13) /* Do not break line before .An. */ | |
95 | #define TERMP_SPLIT (1 << 14) /* Break line before .An. */ | |
96 | #define TERMP_NONEWLINE (1 << 15) /* No line break in nofill mode. */ | |
97 | #define TERMP_BRNEVER (1 << 16) /* Don't even break at maxrmargin. */ | |
98 | #define TERMP_NOBUF (1 << 17) /* Bypass output buffer. */ | |
99 | #define TERMP_NEWMC (1 << 18) /* No .mc printed yet. */ | |
100 | #define TERMP_ENDMC (1 << 19) /* Next break ends .mc mode. */ | |
101 | #define TERMP_MULTICOL (1 << 20) /* Multiple column mode. */ | |
102 | #define TERMP_CENTER (1 << 21) /* Center output lines. */ | |
103 | #define TERMP_RIGHT (1 << 22) /* Adjust to the right margin. */ | |
104 | enum termtype type; /* Terminal, PS, or PDF. */ | |
80387638 | 105 | enum termenc enc; /* Type of encoding. */ |
80387638 | 106 | enum termfont fontl; /* Last font set. */ |
54ba9607 SW |
107 | enum termfont *fontq; /* Symmetric fonts. */ |
108 | int fontsz; /* Allocated size of font stack */ | |
80387638 SW |
109 | int fonti; /* Index of font stack. */ |
110 | term_margin headf; /* invoked to print head */ | |
111 | term_margin footf; /* invoked to print foot */ | |
a4c7eb57 | 112 | void (*letter)(struct termp *, int); |
80387638 SW |
113 | void (*begin)(struct termp *); |
114 | void (*end)(struct termp *); | |
115 | void (*endline)(struct termp *); | |
116 | void (*advance)(struct termp *, size_t); | |
54ba9607 | 117 | void (*setwidth)(struct termp *, int, int); |
a4c7eb57 | 118 | size_t (*width)(const struct termp *, int); |
54ba9607 | 119 | int (*hspan)(const struct termp *, |
80387638 SW |
120 | const struct roffsu *); |
121 | const void *argf; /* arg for headf/footf */ | |
54ba9607 | 122 | const char *mc; /* Margin character. */ |
a4c7eb57 | 123 | struct termp_ps *ps; |
80387638 SW |
124 | }; |
125 | ||
54ba9607 SW |
126 | |
127 | const char *ascii_uc2str(int); | |
128 | ||
129 | void roff_term_pre(struct termp *, const struct roff_node *); | |
130 | ||
131 | void term_eqn(struct termp *, const struct eqn_box *); | |
80387638 SW |
132 | void term_tbl(struct termp *, const struct tbl_span *); |
133 | void term_free(struct termp *); | |
54ba9607 | 134 | void term_setcol(struct termp *, size_t); |
80387638 SW |
135 | void term_newln(struct termp *); |
136 | void term_vspace(struct termp *); | |
137 | void term_word(struct termp *, const char *); | |
138 | void term_flushln(struct termp *); | |
070c62a6 | 139 | void term_begin(struct termp *, term_margin, |
54ba9607 | 140 | term_margin, const struct roff_meta *); |
80387638 SW |
141 | void term_end(struct termp *); |
142 | ||
070c62a6 | 143 | void term_setwidth(struct termp *, const char *); |
54ba9607 SW |
144 | int term_hspan(const struct termp *, const struct roffsu *); |
145 | int term_hen(const struct termp *, const struct roffsu *); | |
146 | int term_vspan(const struct termp *, const struct roffsu *); | |
80387638 SW |
147 | size_t term_strlen(const struct termp *, const char *); |
148 | size_t term_len(const struct termp *, size_t); | |
149 | ||
54ba9607 SW |
150 | void term_tab_set(const struct termp *, const char *); |
151 | void term_tab_iset(size_t); | |
152 | size_t term_tab_next(size_t); | |
153 | ||
80387638 SW |
154 | void term_fontpush(struct termp *, enum termfont); |
155 | void term_fontpop(struct termp *); | |
54ba9607 | 156 | void term_fontpopq(struct termp *, int); |
80387638 SW |
157 | void term_fontrepl(struct termp *, enum termfont); |
158 | void term_fontlast(struct termp *); |