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