]> git.cameronkatri.com Git - mandoc.git/blob - roff_term.c
add a style message about overlong text lines,
[mandoc.git] / roff_term.c
1 /* $OpenBSD: roff_term.c,v 1.20 2020/09/03 17:37:06 schwarze Exp $ */
2 /*
3 * Copyright (c) 2010,2014,2015,2017-2020 Ingo Schwarze <schwarze@openbsd.org>
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 #include "config.h"
18
19 #include <sys/types.h>
20
21 #include <assert.h>
22 #include <stdio.h>
23 #include <string.h>
24
25 #include "mandoc.h"
26 #include "roff.h"
27 #include "out.h"
28 #include "term.h"
29
30 #define ROFF_TERM_ARGS struct termp *p, const struct roff_node *n
31
32 typedef void (*roff_term_pre_fp)(ROFF_TERM_ARGS);
33
34 static void roff_term_pre_br(ROFF_TERM_ARGS);
35 static void roff_term_pre_ce(ROFF_TERM_ARGS);
36 static void roff_term_pre_ft(ROFF_TERM_ARGS);
37 static void roff_term_pre_ll(ROFF_TERM_ARGS);
38 static void roff_term_pre_mc(ROFF_TERM_ARGS);
39 static void roff_term_pre_po(ROFF_TERM_ARGS);
40 static void roff_term_pre_sp(ROFF_TERM_ARGS);
41 static void roff_term_pre_ta(ROFF_TERM_ARGS);
42 static void roff_term_pre_ti(ROFF_TERM_ARGS);
43
44 static const roff_term_pre_fp roff_term_pre_acts[ROFF_MAX] = {
45 roff_term_pre_br, /* br */
46 roff_term_pre_ce, /* ce */
47 roff_term_pre_br, /* fi */
48 roff_term_pre_ft, /* ft */
49 roff_term_pre_ll, /* ll */
50 roff_term_pre_mc, /* mc */
51 roff_term_pre_br, /* nf */
52 roff_term_pre_po, /* po */
53 roff_term_pre_ce, /* rj */
54 roff_term_pre_sp, /* sp */
55 roff_term_pre_ta, /* ta */
56 roff_term_pre_ti, /* ti */
57 };
58
59
60 void
61 roff_term_pre(struct termp *p, const struct roff_node *n)
62 {
63 assert(n->tok < ROFF_MAX);
64 (*roff_term_pre_acts[n->tok])(p, n);
65 }
66
67 static void
68 roff_term_pre_br(ROFF_TERM_ARGS)
69 {
70 term_newln(p);
71 if (p->flags & TERMP_BRIND) {
72 p->tcol->offset = p->tcol->rmargin;
73 p->tcol->rmargin = p->maxrmargin;
74 p->trailspace = 0;
75 p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND);
76 p->flags |= TERMP_NOSPACE;
77 }
78 }
79
80 static void
81 roff_term_pre_ce(ROFF_TERM_ARGS)
82 {
83 const struct roff_node *nc1, *nc2;
84
85 roff_term_pre_br(p, n);
86 p->flags |= n->tok == ROFF_ce ? TERMP_CENTER : TERMP_RIGHT;
87 nc1 = n->child->next;
88 while (nc1 != NULL) {
89 nc2 = nc1;
90 do {
91 nc2 = nc2->next;
92 } while (nc2 != NULL && (nc2->type != ROFFT_TEXT ||
93 (nc2->flags & NODE_LINE) == 0));
94 while (nc1 != nc2) {
95 if (nc1->type == ROFFT_TEXT)
96 term_word(p, nc1->string);
97 else
98 roff_term_pre(p, nc1);
99 nc1 = nc1->next;
100 }
101 p->flags |= TERMP_NOSPACE;
102 term_flushln(p);
103 }
104 p->flags &= ~(TERMP_CENTER | TERMP_RIGHT);
105 }
106
107 static void
108 roff_term_pre_ft(ROFF_TERM_ARGS)
109 {
110 const char *cp;
111
112 cp = n->child->string;
113 switch (mandoc_font(cp, (int)strlen(cp))) {
114 case ESCAPE_FONTBOLD:
115 term_fontrepl(p, TERMFONT_BOLD);
116 break;
117 case ESCAPE_FONTITALIC:
118 term_fontrepl(p, TERMFONT_UNDER);
119 break;
120 case ESCAPE_FONTBI:
121 term_fontrepl(p, TERMFONT_BI);
122 break;
123 case ESCAPE_FONTPREV:
124 term_fontlast(p);
125 break;
126 case ESCAPE_FONTROMAN:
127 case ESCAPE_FONTCW:
128 term_fontrepl(p, TERMFONT_NONE);
129 break;
130 default:
131 break;
132 }
133 }
134
135 static void
136 roff_term_pre_ll(ROFF_TERM_ARGS)
137 {
138 term_setwidth(p, n->child != NULL ? n->child->string : NULL);
139 }
140
141 static void
142 roff_term_pre_mc(ROFF_TERM_ARGS)
143 {
144 if (p->col) {
145 p->flags |= TERMP_NOBREAK;
146 term_flushln(p);
147 p->flags &= ~(TERMP_NOBREAK | TERMP_NOSPACE);
148 }
149 if (n->child != NULL) {
150 p->mc = n->child->string;
151 p->flags |= TERMP_NEWMC;
152 } else
153 p->flags |= TERMP_ENDMC;
154 }
155
156 static void
157 roff_term_pre_po(ROFF_TERM_ARGS)
158 {
159 struct roffsu su;
160 static int po, pouse, polast;
161 int ponew;
162
163 /* Revert the currently active page offset. */
164 p->tcol->offset -= pouse;
165
166 /* Determine the requested page offset. */
167 if (n->child != NULL &&
168 a2roffsu(n->child->string, &su, SCALE_EM) != NULL) {
169 ponew = term_hen(p, &su);
170 if (*n->child->string == '+' ||
171 *n->child->string == '-')
172 ponew += po;
173 } else
174 ponew = polast;
175
176 /* Remeber both the previous and the newly requested offset. */
177 polast = po;
178 po = ponew;
179
180 /* Truncate to the range [-offset, 60], remember, and apply it. */
181 pouse = po >= 60 ? 60 :
182 po < -(int)p->tcol->offset ? -p->tcol->offset : po;
183 p->tcol->offset += pouse;
184 }
185
186 static void
187 roff_term_pre_sp(ROFF_TERM_ARGS)
188 {
189 struct roffsu su;
190 int len;
191
192 if (n->child != NULL) {
193 if (a2roffsu(n->child->string, &su, SCALE_VS) == NULL)
194 su.scale = 1.0;
195 len = term_vspan(p, &su);
196 } else
197 len = 1;
198
199 if (len < 0)
200 p->skipvsp -= len;
201 else
202 while (len--)
203 term_vspace(p);
204
205 roff_term_pre_br(p, n);
206 }
207
208 static void
209 roff_term_pre_ta(ROFF_TERM_ARGS)
210 {
211 term_tab_set(p, NULL);
212 for (n = n->child; n != NULL; n = n->next)
213 term_tab_set(p, n->string);
214 }
215
216 static void
217 roff_term_pre_ti(ROFF_TERM_ARGS)
218 {
219 struct roffsu su;
220 const char *cp;
221 const size_t maxoff = 72;
222 int len, sign;
223
224 roff_term_pre_br(p, n);
225
226 if (n->child == NULL)
227 return;
228 cp = n->child->string;
229 if (*cp == '+') {
230 sign = 1;
231 cp++;
232 } else if (*cp == '-') {
233 sign = -1;
234 cp++;
235 } else
236 sign = 0;
237
238 if (a2roffsu(cp, &su, SCALE_EM) == NULL)
239 return;
240 len = term_hen(p, &su);
241
242 switch (sign) {
243 case 1:
244 if (p->tcol->offset + len <= maxoff)
245 p->ti = len;
246 else if (p->tcol->offset < maxoff)
247 p->ti = maxoff - p->tcol->offset;
248 else
249 p->ti = 0;
250 break;
251 case -1:
252 if ((size_t)len < p->tcol->offset)
253 p->ti = -len;
254 else
255 p->ti = -p->tcol->offset;
256 break;
257 default:
258 if ((size_t)len > maxoff)
259 len = maxoff;
260 p->ti = len - p->tcol->offset;
261 break;
262 }
263 p->tcol->offset += p->ti;
264 }