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