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