xref: /openbsd-src/usr.bin/mandoc/term_ascii.c (revision cb39b41371628601fbe4c618205356d538b9d08a)
1 /*	$OpenBSD: term_ascii.c,v 1.32 2015/04/04 17:46:58 schwarze Exp $ */
2 /*
3  * Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4  * Copyright (c) 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
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 AUTHORS DISCLAIM ALL WARRANTIES
11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS 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  */
18 #include <sys/types.h>
19 
20 #include <assert.h>
21 #include <locale.h>
22 #include <stdint.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <unistd.h>
26 #include <wchar.h>
27 
28 #include "mandoc.h"
29 #include "mandoc_aux.h"
30 #include "out.h"
31 #include "term.h"
32 #include "manconf.h"
33 #include "main.h"
34 
35 static	struct termp	 *ascii_init(enum termenc, const struct mchars *,
36 				const struct manoutput *);
37 static	int		  ascii_hspan(const struct termp *,
38 				const struct roffsu *);
39 static	size_t		  ascii_width(const struct termp *, int);
40 static	void		  ascii_advance(struct termp *, size_t);
41 static	void		  ascii_begin(struct termp *);
42 static	void		  ascii_end(struct termp *);
43 static	void		  ascii_endline(struct termp *);
44 static	void		  ascii_letter(struct termp *, int);
45 static	void		  ascii_setwidth(struct termp *, int, int);
46 
47 static	void		  locale_advance(struct termp *, size_t);
48 static	void		  locale_endline(struct termp *);
49 static	void		  locale_letter(struct termp *, int);
50 static	size_t		  locale_width(const struct termp *, int);
51 
52 
53 static struct termp *
54 ascii_init(enum termenc enc, const struct mchars *mchars,
55 	const struct manoutput *outopts)
56 {
57 	char		*v;
58 	struct termp	*p;
59 
60 	p = mandoc_calloc(1, sizeof(struct termp));
61 
62 	p->symtab = mchars;
63 	p->tabwidth = 5;
64 	p->defrmargin = p->lastrmargin = 78;
65 	p->fontq = mandoc_reallocarray(NULL,
66 	     (p->fontsz = 8), sizeof(enum termfont));
67 	p->fontq[0] = p->fontl = TERMFONT_NONE;
68 
69 	p->begin = ascii_begin;
70 	p->end = ascii_end;
71 	p->hspan = ascii_hspan;
72 	p->type = TERMTYPE_CHAR;
73 
74 	p->enc = TERMENC_ASCII;
75 	p->advance = ascii_advance;
76 	p->endline = ascii_endline;
77 	p->letter = ascii_letter;
78 	p->setwidth = ascii_setwidth;
79 	p->width = ascii_width;
80 
81 	if (TERMENC_ASCII != enc) {
82 		v = TERMENC_LOCALE == enc ?
83 		    setlocale(LC_ALL, "") :
84 		    setlocale(LC_CTYPE, "en_US.UTF-8");
85 		if (NULL != v && MB_CUR_MAX > 1) {
86 			p->enc = enc;
87 			p->advance = locale_advance;
88 			p->endline = locale_endline;
89 			p->letter = locale_letter;
90 			p->width = locale_width;
91 		}
92 	}
93 
94 	if (outopts->mdoc) {
95 		p->mdocstyle = 1;
96 		p->defindent = 5;
97 	}
98 	if (outopts->indent)
99 		p->defindent = outopts->indent;
100 	if (outopts->width)
101 		p->defrmargin = outopts->width;
102 	if (outopts->synopsisonly)
103 		p->synopsisonly = 1;
104 
105 	return(p);
106 }
107 
108 void *
109 ascii_alloc(const struct mchars *mchars, const struct manoutput *outopts)
110 {
111 
112 	return(ascii_init(TERMENC_ASCII, mchars, outopts));
113 }
114 
115 void *
116 utf8_alloc(const struct mchars *mchars, const struct manoutput *outopts)
117 {
118 
119 	return(ascii_init(TERMENC_UTF8, mchars, outopts));
120 }
121 
122 void *
123 locale_alloc(const struct mchars *mchars, const struct manoutput *outopts)
124 {
125 
126 	return(ascii_init(TERMENC_LOCALE, mchars, outopts));
127 }
128 
129 static void
130 ascii_setwidth(struct termp *p, int iop, int width)
131 {
132 
133 	width /= 24;
134 	p->rmargin = p->defrmargin;
135 	if (iop > 0)
136 		p->defrmargin += width;
137 	else if (iop == 0)
138 		p->defrmargin = width ? (size_t)width : p->lastrmargin;
139 	else if (p->defrmargin > (size_t)width)
140 		p->defrmargin -= width;
141 	else
142 		p->defrmargin = 0;
143 	p->lastrmargin = p->rmargin;
144 	p->rmargin = p->maxrmargin = p->defrmargin;
145 }
146 
147 void
148 ascii_sepline(void *arg)
149 {
150 	struct termp	*p;
151 	size_t		 i;
152 
153 	p = (struct termp *)arg;
154 	putchar('\n');
155 	for (i = 0; i < p->defrmargin; i++)
156 		putchar('-');
157 	putchar('\n');
158 	putchar('\n');
159 }
160 
161 static size_t
162 ascii_width(const struct termp *p, int c)
163 {
164 
165 	return(1);
166 }
167 
168 void
169 ascii_free(void *arg)
170 {
171 
172 	term_free((struct termp *)arg);
173 }
174 
175 static void
176 ascii_letter(struct termp *p, int c)
177 {
178 
179 	putchar(c);
180 }
181 
182 static void
183 ascii_begin(struct termp *p)
184 {
185 
186 	(*p->headf)(p, p->argf);
187 }
188 
189 static void
190 ascii_end(struct termp *p)
191 {
192 
193 	(*p->footf)(p, p->argf);
194 }
195 
196 static void
197 ascii_endline(struct termp *p)
198 {
199 
200 	putchar('\n');
201 }
202 
203 static void
204 ascii_advance(struct termp *p, size_t len)
205 {
206 	size_t		i;
207 
208 	for (i = 0; i < len; i++)
209 		putchar(' ');
210 }
211 
212 static int
213 ascii_hspan(const struct termp *p, const struct roffsu *su)
214 {
215 	double		 r;
216 
217 	switch (su->unit) {
218 	case SCALE_BU:
219 		r = su->scale;
220 		break;
221 	case SCALE_CM:
222 		r = su->scale * 240.0 / 2.54;
223 		break;
224 	case SCALE_FS:
225 		r = su->scale * 65536.0;
226 		break;
227 	case SCALE_IN:
228 		r = su->scale * 240.0;
229 		break;
230 	case SCALE_MM:
231 		r = su->scale * 0.24;
232 		break;
233 	case SCALE_VS:
234 		/* FALLTHROUGH */
235 	case SCALE_PC:
236 		r = su->scale * 40.0;
237 		break;
238 	case SCALE_PT:
239 		r = su->scale * 10.0 / 3.0;
240 		break;
241 	case SCALE_EN:
242 		/* FALLTHROUGH */
243 	case SCALE_EM:
244 		r = su->scale * 24.0;
245 		break;
246 	default:
247 		abort();
248 		/* NOTREACHED */
249 	}
250 	return(r > 0.0 ? r + 0.01 : r - 0.01);
251 }
252 
253 const char *
254 ascii_uc2str(int uc)
255 {
256 	static const char nbrsp[2] = { ASCII_NBRSP, '\0' };
257 	static const char *tab[] = {
258 	"<NUL>","<SOH>","<STX>","<ETX>","<EOT>","<ENQ>","<ACK>","<BEL>",
259 	"<BS>",	"\t",	"<LF>",	"<VT>",	"<FF>",	"<CR>",	"<SO>",	"<SI>",
260 	"<DLE>","<DC1>","<DC2>","<DC3>","<DC4>","<NAK>","<SYN>","<ETB>",
261 	"<CAN>","<EM>",	"<SUB>","<ESC>","<FS>",	"<GS>",	"<RS>",	"<US>",
262 	" ",	"!",	"\"",	"#",	"$",	"%",	"&",	"'",
263 	"(",	")",	"*",	"+",	",",	"-",	".",	"/",
264 	"0",	"1",	"2",	"3",	"4",	"5",	"6",	"7",
265 	"8",	"9",	":",	";",	"<",	"=",	">",	"?",
266 	"@",	"A",	"B",	"C",	"D",	"E",	"F",	"G",
267 	"H",	"I",	"J",	"K",	"L",	"M",	"N",	"O",
268 	"P",	"Q",	"R",	"S",	"T",	"U",	"V",	"W",
269 	"X",	"Y",	"Z",	"[",	"\\",	"]",	"^",	"_",
270 	"`",	"a",	"b",	"c",	"d",	"e",	"f",	"g",
271 	"h",	"i",	"j",	"k",	"l",	"m",	"n",	"o",
272 	"p",	"q",	"r",	"s",	"t",	"u",	"v",	"w",
273 	"x",	"y",	"z",	"{",	"|",	"}",	"~",	"<DEL>",
274 	"<80>",	"<81>",	"<82>",	"<83>",	"<84>",	"<85>",	"<86>",	"<87>",
275 	"<88>",	"<89>",	"<8A>",	"<8B>",	"<8C>",	"<8D>",	"<8E>",	"<8F>",
276 	"<90>",	"<91>",	"<92>",	"<93>",	"<94>",	"<95>",	"<96>",	"<97>",
277 	"<99>",	"<99>",	"<9A>",	"<9B>",	"<9C>",	"<9D>",	"<9E>",	"<9F>",
278 	nbrsp,	"!",	"/\bc",	"GBP",	"o\bx",	"=\bY",	"|",	"<sec>",
279 	"\"",	"(C)",	"_\ba",	"<<",	"~",	"",	"(R)",	"-",
280 	"<deg>","+-",	"2",	"3",	"'",	",\bu",	"<par>",".",
281 	",",	"1",	"_\bo",	">>",	"1/4",	"1/2",	"3/4",	"?",
282 	"`\bA",	"'\bA",	"^\bA",	"~\bA",	"\"\bA","o\bA",	"AE",	",\bC",
283 	"`\bE",	"'\bE",	"^\bE",	"\"\bE","`\bI",	"'\bI",	"^\bI",	"\"\bI",
284 	"-\bD",	"~\bN",	"`\bO",	"'\bO",	"^\bO",	"~\bO",	"\"\bO","x",
285 	"/\bO",	"`\bU",	"'\bU",	"^\bU",	"\"\bU","'\bY",	"Th",	"ss",
286 	"`\ba",	"'\ba",	"^\ba",	"~\ba",	"\"\ba","o\ba",	"ae",	",\bc",
287 	"`\be",	"'\be",	"^\be",	"\"\be","`\bi",	"'\bi",	"^\bi",	"\"\bi",
288 	"d",	"~\bn",	"`\bo",	"'\bo",	"^\bo",	"~\bo",	"\"\bo","-:-",
289 	"/\bo",	"`\bu",	"'\bu",	"^\bu",	"\"\bu","'\by",	"th",	"\"\by",
290 	"A",	"a",	"A",	"a",	"A",	"a",	"'\bC",	"'\bc",
291 	"^\bC",	"^\bc",	"C",	"c",	"C",	"c",	"D",	"d",
292 	"/\bD",	"/\bd",	"E",	"e",	"E",	"e",	"E",	"e",
293 	"E",	"e",	"E",	"e",	"^\bG",	"^\bg",	"G",	"g",
294 	"G",	"g",	",\bG",	",\bg",	"^\bH",	"^\bh",	"/\bH",	"/\bh",
295 	"~\bI",	"~\bi",	"I",	"i",	"I",	"i",	"I",	"i",
296 	"I",	"i",	"IJ",	"ij",	"^\bJ",	"^\bj",	",\bK",	",\bk",
297 	"q",	"'\bL",	"'\bl",	",\bL",	",\bl",	"L",	"l",	"L",
298 	"l",	"/\bL",	"/\bl",	"'\bN",	"'\bn",	",\bN",	",\bn",	"N",
299 	"n",	"'n",	"Ng",	"ng",	"O",	"o",	"O",	"o",
300 	"O",	"o",	"OE",	"oe",	"'\bR",	"'\br",	",\bR",	",\br",
301 	"R",	"r",	"'\bS",	"'\bs",	"^\bS",	"^\bs",	",\bS",	",\bs",
302 	"S",	"s",	",\bT",	",\bt",	"T",	"t",	"/\bT",	"/\bt",
303 	"~\bU",	"~\bu",	"U",	"u",	"U",	"u",	"U",	"u",
304 	"U",	"u",	"U",	"u",	"^\bW",	"^\bw",	"^\bY",	"^\by",
305 	"\"\bY","'\bZ",	"'\bz",	"Z",	"z",	"Z",	"z",	"s",
306 	"b",	"B",	"B",	"b",	"6",	"6",	"O",	"C",
307 	"c",	"D",	"D",	"D",	"d",	"d",	"3",	"@",
308 	"E",	"F",	",\bf",	"G",	"G",	"hv",	"I",	"/\bI",
309 	"K",	"k",	"/\bl",	"l",	"W",	"N",	"n",	"~\bO",
310 	"O",	"o",	"OI",	"oi",	"P",	"p",	"YR",	"2",
311 	"2",	"SH",	"sh",	"t",	"T",	"t",	"T",	"U",
312 	"u",	"Y",	"V",	"Y",	"y",	"/\bZ",	"/\bz",	"ZH",
313 	"ZH",	"zh",	"zh",	"/\b2",	"5",	"5",	"ts",	"w",
314 	"|",	"||",	"|=",	"!",	"DZ",	"Dz",	"dz",	"LJ",
315 	"Lj",	"lj",	"NJ",	"Nj",	"nj",	"A",	"a",	"I",
316 	"i",	"O",	"o",	"U",	"u",	"U",	"u",	"U",
317 	"u",	"U",	"u",	"U",	"u",	"@",	"A",	"a",
318 	"A",	"a",	"AE",	"ae",	"/\bG",	"/\bg",	"G",	"g",
319 	"K",	"k",	"O",	"o",	"O",	"o",	"ZH",	"zh",
320 	"j",	"DZ",	"Dz",	"dz",	"'\bG",	"'\bg",	"HV",	"W",
321 	"`\bN",	"`\bn",	"A",	"a",	"'\bAE","'\bae","O",	"o"};
322 
323 	assert(uc >= 0);
324 	if ((size_t)uc < sizeof(tab)/sizeof(tab[0]))
325 		return(tab[uc]);
326 	return(mchars_uc2str(uc));
327 }
328 
329 static size_t
330 locale_width(const struct termp *p, int c)
331 {
332 	int		rc;
333 
334 	if (c == ASCII_NBRSP)
335 		c = ' ';
336 	rc = wcwidth(c);
337 	if (rc < 0)
338 		rc = 0;
339 	return(rc);
340 }
341 
342 static void
343 locale_advance(struct termp *p, size_t len)
344 {
345 	size_t		i;
346 
347 	for (i = 0; i < len; i++)
348 		putwchar(L' ');
349 }
350 
351 static void
352 locale_endline(struct termp *p)
353 {
354 
355 	putwchar(L'\n');
356 }
357 
358 static void
359 locale_letter(struct termp *p, int c)
360 {
361 
362 	putwchar(c);
363 }
364