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