Annotation of mandoc/term.c, Revision 1.81
1.81 ! kristaps 1: /* $Id: term.c,v 1.80 2009/06/22 10:40:04 kristaps Exp $ */
1.1 kristaps 2: /*
1.75 kristaps 3: * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
1.1 kristaps 4: *
5: * Permission to use, copy, modify, and distribute this software for any
1.74 kristaps 6: * purpose with or without fee is hereby granted, provided that the above
7: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 8: *
1.74 kristaps 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.
1.1 kristaps 16: */
17: #include <assert.h>
1.23 kristaps 18: #include <err.h>
1.22 kristaps 19: #include <stdio.h>
1.1 kristaps 20: #include <stdlib.h>
21: #include <string.h>
22:
1.71 kristaps 23: #include "term.h"
24: #include "man.h"
25: #include "mdoc.h"
1.1 kristaps 26:
1.71 kristaps 27: extern int man_run(struct termp *,
28: const struct man *);
29: extern int mdoc_run(struct termp *,
30: const struct mdoc *);
1.1 kristaps 31:
1.71 kristaps 32: static struct termp *term_alloc(enum termenc);
33: static void term_free(struct termp *);
34: static void term_pword(struct termp *, const char *, int);
35: static void term_pescape(struct termp *,
36: const char *, int *, int);
37: static void term_nescape(struct termp *,
38: const char *, size_t);
39: static void term_chara(struct termp *, char);
1.79 kristaps 40: static void term_encodea(struct termp *, char);
1.71 kristaps 41: static int term_isopendelim(const char *, int);
42: static int term_isclosedelim(const char *, int);
1.1 kristaps 43:
44:
1.71 kristaps 45: void *
46: ascii_alloc(void)
1.10 kristaps 47: {
1.1 kristaps 48:
1.71 kristaps 49: return(term_alloc(TERMENC_ASCII));
1.1 kristaps 50: }
51:
52:
1.71 kristaps 53: int
1.72 kristaps 54: terminal_man(void *arg, const struct man *man)
1.1 kristaps 55: {
1.71 kristaps 56: struct termp *p;
1.1 kristaps 57:
1.71 kristaps 58: p = (struct termp *)arg;
59: if (NULL == p->symtab)
60: p->symtab = term_ascii2htab();
1.2 kristaps 61:
1.72 kristaps 62: return(man_run(p, man));
63: }
64:
65:
66: int
67: terminal_mdoc(void *arg, const struct mdoc *mdoc)
68: {
69: struct termp *p;
70:
71: p = (struct termp *)arg;
72: if (NULL == p->symtab)
73: p->symtab = term_ascii2htab();
1.2 kristaps 74:
1.72 kristaps 75: return(mdoc_run(p, mdoc));
1.1 kristaps 76: }
77:
78:
1.71 kristaps 79: void
80: terminal_free(void *arg)
1.11 kristaps 81: {
82:
1.71 kristaps 83: term_free((struct termp *)arg);
1.11 kristaps 84: }
85:
86:
1.71 kristaps 87: static void
88: term_free(struct termp *p)
1.14 kristaps 89: {
90:
1.71 kristaps 91: if (p->buf)
92: free(p->buf);
93: if (TERMENC_ASCII == p->enc && p->symtab)
94: term_asciifree(p->symtab);
1.14 kristaps 95:
1.71 kristaps 96: free(p);
1.14 kristaps 97: }
98:
99:
1.71 kristaps 100: static struct termp *
101: term_alloc(enum termenc enc)
1.14 kristaps 102: {
1.71 kristaps 103: struct termp *p;
1.14 kristaps 104:
1.71 kristaps 105: if (NULL == (p = malloc(sizeof(struct termp))))
106: err(1, "malloc");
107: bzero(p, sizeof(struct termp));
1.80 kristaps 108: p->maxrmargin = 78;
1.71 kristaps 109: p->enc = enc;
110: return(p);
1.14 kristaps 111: }
112:
113:
114: static int
1.71 kristaps 115: term_isclosedelim(const char *p, int len)
1.14 kristaps 116: {
117:
1.71 kristaps 118: if (1 != len)
119: return(0);
1.14 kristaps 120:
1.71 kristaps 121: switch (*p) {
122: case('.'):
123: /* FALLTHROUGH */
124: case(','):
125: /* FALLTHROUGH */
126: case(';'):
127: /* FALLTHROUGH */
128: case(':'):
129: /* FALLTHROUGH */
130: case('?'):
131: /* FALLTHROUGH */
132: case('!'):
133: /* FALLTHROUGH */
134: case(')'):
135: /* FALLTHROUGH */
136: case(']'):
137: /* FALLTHROUGH */
138: case('}'):
139: return(1);
140: default:
141: break;
142: }
1.14 kristaps 143:
1.71 kristaps 144: return(0);
1.30 kristaps 145: }
146:
147:
1.14 kristaps 148: static int
1.71 kristaps 149: term_isopendelim(const char *p, int len)
1.14 kristaps 150: {
1.43 kristaps 151:
1.71 kristaps 152: if (1 != len)
153: return(0);
1.14 kristaps 154:
1.71 kristaps 155: switch (*p) {
156: case('('):
157: /* FALLTHROUGH */
158: case('['):
159: /* FALLTHROUGH */
160: case('{'):
161: return(1);
162: default:
163: break;
164: }
1.43 kristaps 165:
1.14 kristaps 166: return(0);
167: }
1.15 kristaps 168:
169:
1.71 kristaps 170: /*
171: * Flush a line of text. A "line" is loosely defined as being something
172: * that should be followed by a newline, regardless of whether it's
173: * broken apart by newlines getting there. A line can also be a
174: * fragment of a columnar list.
175: *
176: * Specifically, a line is whatever's in p->buf of length p->col, which
177: * is zeroed after this function returns.
178: *
179: * The variables TERMP_NOLPAD, TERMP_LITERAL and TERMP_NOBREAK are of
180: * critical importance here. Their behaviour follows:
181: *
182: * - TERMP_NOLPAD: when beginning to write the line, don't left-pad the
183: * offset value. This is useful when doing columnar lists where the
184: * prior column has right-padded.
185: *
186: * - TERMP_NOBREAK: this is the most important and is used when making
187: * columns. In short: don't print a newline and instead pad to the
188: * right margin. Used in conjunction with TERMP_NOLPAD.
189: *
190: * - TERMP_NONOBREAK: don't newline when TERMP_NOBREAK is specified.
191: *
192: * In-line line breaking:
193: *
194: * If TERMP_NOBREAK is specified and the line overruns the right
195: * margin, it will break and pad-right to the right margin after
196: * writing. If maxrmargin is violated, it will break and continue
197: * writing from the right-margin, which will lead to the above
198: * scenario upon exit.
199: *
200: * Otherwise, the line will break at the right margin. Extremely long
201: * lines will cause the system to emit a warning (TODO: hyphenate, if
202: * possible).
203: */
204: void
205: term_flushln(struct termp *p)
1.53 kristaps 206: {
1.71 kristaps 207: int i, j;
1.81 ! kristaps 208: size_t vbl, vsz, vis, maxvis, mmax, bp;
1.53 kristaps 209:
1.71 kristaps 210: /*
211: * First, establish the maximum columns of "visible" content.
212: * This is usually the difference between the right-margin and
213: * an indentation, but can be, for tagged lists or columns, a
214: * small set of values.
215: */
1.53 kristaps 216:
1.71 kristaps 217: assert(p->offset < p->rmargin);
218: maxvis = p->rmargin - p->offset;
219: mmax = p->maxrmargin - p->offset;
220: bp = TERMP_NOBREAK & p->flags ? mmax : maxvis;
221: vis = 0;
1.53 kristaps 222:
1.71 kristaps 223: /*
224: * If in the standard case (left-justified), then begin with our
225: * indentation, otherwise (columns, etc.) just start spitting
226: * out text.
227: */
1.53 kristaps 228:
1.71 kristaps 229: if ( ! (p->flags & TERMP_NOLPAD))
230: /* LINTED */
231: for (j = 0; j < (int)p->offset; j++)
232: putchar(' ');
233:
234: for (i = 0; i < (int)p->col; i++) {
235: /*
236: * Count up visible word characters. Control sequences
237: * (starting with the CSI) aren't counted. A space
238: * generates a non-printing word, which is valid (the
239: * space is printed according to regular spacing rules).
240: */
241:
242: /* LINTED */
243: for (j = i, vsz = 0; j < (int)p->col; j++) {
244: if (' ' == p->buf[j])
245: break;
246: else if (8 == p->buf[j])
247: j += 1;
248: else
249: vsz++;
250: }
1.53 kristaps 251:
1.71 kristaps 252: /*
1.81 ! kristaps 253: * Choose the number of blanks to prepend: no blank at the
! 254: * beginning of a line, one between words -- but do not
! 255: * actually write them yet.
1.71 kristaps 256: */
1.81 ! kristaps 257: vbl = (size_t)(0 == vis ? 0 : 1);
1.71 kristaps 258:
1.81 ! kristaps 259: /*
! 260: * Find out whether we would exceed the right margin.
! 261: * If so, break to the next line. (TODO: hyphenate)
! 262: * Otherwise, write the chosen number of blanks now.
! 263: */
! 264: if (vis && vis + vbl + vsz > bp) {
! 265: putchar('\n');
! 266: if (TERMP_NOBREAK & p->flags) {
! 267: for (j = 0; j < (int)p->rmargin; j++)
! 268: putchar(' ');
! 269: vis = p->rmargin - p->offset;
! 270: } else {
1.71 kristaps 271: for (j = 0; j < (int)p->offset; j++)
272: putchar(' ');
273: vis = 0;
1.81 ! kristaps 274: }
! 275: } else {
! 276: for (j = 0; j < (int)vbl; j++)
1.71 kristaps 277: putchar(' ');
1.81 ! kristaps 278: vis += vbl;
1.71 kristaps 279: }
1.53 kristaps 280:
1.78 kristaps 281: /*
1.81 ! kristaps 282: * Finally, write out the word.
1.71 kristaps 283: */
284: for ( ; i < (int)p->col; i++) {
285: if (' ' == p->buf[i])
286: break;
287: putchar(p->buf[i]);
288: }
289: vis += vsz;
290: }
1.15 kristaps 291:
1.71 kristaps 292: /*
293: * If we've overstepped our maximum visible no-break space, then
294: * cause a newline and offset at the right margin.
295: */
1.15 kristaps 296:
1.81 ! kristaps 297: if ((TERMP_NOBREAK & p->flags) && vis >= maxvis) {
1.71 kristaps 298: if ( ! (TERMP_NONOBREAK & p->flags)) {
299: putchar('\n');
300: for (i = 0; i < (int)p->rmargin; i++)
301: putchar(' ');
302: }
303: p->col = 0;
1.15 kristaps 304: return;
1.71 kristaps 305: }
1.15 kristaps 306:
1.71 kristaps 307: /*
308: * If we're not to right-marginalise it (newline), then instead
309: * pad to the right margin and stay off.
310: */
1.15 kristaps 311:
1.71 kristaps 312: if (p->flags & TERMP_NOBREAK) {
313: if ( ! (TERMP_NONOBREAK & p->flags))
1.81 ! kristaps 314: for ( ; vis < maxvis; vis++)
1.71 kristaps 315: putchar(' ');
316: } else
317: putchar('\n');
1.15 kristaps 318:
1.71 kristaps 319: p->col = 0;
1.15 kristaps 320: }
321:
322:
1.71 kristaps 323: /*
324: * A newline only breaks an existing line; it won't assert vertical
325: * space. All data in the output buffer is flushed prior to the newline
326: * assertion.
327: */
328: void
329: term_newln(struct termp *p)
1.15 kristaps 330: {
331:
1.71 kristaps 332: p->flags |= TERMP_NOSPACE;
333: if (0 == p->col) {
334: p->flags &= ~TERMP_NOLPAD;
1.15 kristaps 335: return;
1.16 kristaps 336: }
1.71 kristaps 337: term_flushln(p);
338: p->flags &= ~TERMP_NOLPAD;
1.16 kristaps 339: }
340:
341:
1.71 kristaps 342: /*
343: * Asserts a vertical space (a full, empty line-break between lines).
344: * Note that if used twice, this will cause two blank spaces and so on.
345: * All data in the output buffer is flushed prior to the newline
346: * assertion.
347: */
348: void
349: term_vspace(struct termp *p)
1.16 kristaps 350: {
351:
1.62 kristaps 352: term_newln(p);
1.71 kristaps 353: putchar('\n');
1.16 kristaps 354: }
355:
356:
1.71 kristaps 357: /*
358: * Break apart a word into "pwords" (partial-words, usually from
359: * breaking up a phrase into individual words) and, eventually, put them
360: * into the output buffer. If we're a literal word, then don't break up
361: * the word and put it verbatim into the output buffer.
362: */
363: void
364: term_word(struct termp *p, const char *word)
1.17 kristaps 365: {
1.71 kristaps 366: int i, j, len;
1.17 kristaps 367:
1.71 kristaps 368: len = (int)strlen(word);
1.17 kristaps 369:
1.71 kristaps 370: if (p->flags & TERMP_LITERAL) {
371: term_pword(p, word, len);
372: return;
373: }
1.17 kristaps 374:
1.71 kristaps 375: /* LINTED */
376: for (j = i = 0; i < len; i++) {
377: if (' ' != word[i]) {
378: j++;
379: continue;
380: }
381:
382: /* Escaped spaces don't delimit... */
383: if (i && ' ' == word[i] && '\\' == word[i - 1]) {
384: j++;
385: continue;
386: }
1.17 kristaps 387:
1.71 kristaps 388: if (0 == j)
389: continue;
390: assert(i >= j);
391: term_pword(p, &word[i - j], j);
392: j = 0;
393: }
394: if (j > 0) {
395: assert(i >= j);
396: term_pword(p, &word[i - j], j);
397: }
1.17 kristaps 398: }
399:
400:
1.71 kristaps 401: /*
402: * Determine the symbol indicated by an escape sequences, that is, one
403: * starting with a backslash. Once done, we pass this value into the
404: * output buffer by way of the symbol table.
405: */
406: static void
407: term_nescape(struct termp *p, const char *word, size_t len)
1.17 kristaps 408: {
1.71 kristaps 409: const char *rhs;
410: size_t sz;
1.79 kristaps 411: int i;
1.17 kristaps 412:
1.79 kristaps 413: if ((rhs = term_a2ascii(p->symtab, word, len, &sz)))
414: for (i = 0; i < (int)sz; i++)
415: term_encodea(p, rhs[i]);
1.17 kristaps 416: }
417:
418:
1.71 kristaps 419: /*
420: * Handle an escape sequence: determine its length and pass it to the
421: * escape-symbol look table. Note that we assume mdoc(3) has validated
422: * the escape sequence (we assert upon badly-formed escape sequences).
423: */
424: static void
425: term_pescape(struct termp *p, const char *word, int *i, int len)
1.17 kristaps 426: {
1.71 kristaps 427: int j;
1.17 kristaps 428:
1.71 kristaps 429: if (++(*i) >= len)
430: return;
1.17 kristaps 431:
1.71 kristaps 432: if ('(' == word[*i]) {
433: (*i)++;
434: if (*i + 1 >= len)
435: return;
1.22 kristaps 436:
1.71 kristaps 437: term_nescape(p, &word[*i], 2);
438: (*i)++;
439: return;
1.22 kristaps 440:
1.71 kristaps 441: } else if ('*' == word[*i]) {
442: (*i)++;
443: if (*i >= len)
444: return;
1.22 kristaps 445:
1.71 kristaps 446: switch (word[*i]) {
447: case ('('):
448: (*i)++;
449: if (*i + 1 >= len)
450: return;
1.65 kristaps 451:
1.71 kristaps 452: term_nescape(p, &word[*i], 2);
453: (*i)++;
454: return;
455: case ('['):
456: break;
457: default:
458: term_nescape(p, &word[*i], 1);
459: return;
460: }
461:
462: } else if ('f' == word[*i]) {
463: (*i)++;
464: if (*i >= len)
465: return;
466: switch (word[*i]) {
467: case ('B'):
468: p->flags |= TERMP_BOLD;
469: break;
470: case ('I'):
471: p->flags |= TERMP_UNDER;
472: break;
473: case ('P'):
474: /* FALLTHROUGH */
475: case ('R'):
476: p->flags &= ~TERMP_STYLE;
477: break;
478: default:
479: break;
480: }
481: return;
1.22 kristaps 482:
1.71 kristaps 483: } else if ('[' != word[*i]) {
484: term_nescape(p, &word[*i], 1);
485: return;
486: }
1.28 kristaps 487:
1.71 kristaps 488: (*i)++;
489: for (j = 0; word[*i] && ']' != word[*i]; (*i)++, j++)
490: /* Loop... */ ;
1.28 kristaps 491:
1.71 kristaps 492: if (0 == word[*i])
493: return;
1.48 kristaps 494:
1.71 kristaps 495: term_nescape(p, &word[*i - j], (size_t)j);
1.48 kristaps 496: }
497:
498:
1.71 kristaps 499: /*
500: * Handle pwords, partial words, which may be either a single word or a
501: * phrase that cannot be broken down (such as a literal string). This
502: * handles word styling.
503: */
504: static void
505: term_pword(struct termp *p, const char *word, int len)
1.65 kristaps 506: {
1.71 kristaps 507: int i;
508:
509: if (term_isclosedelim(word, len))
510: if ( ! (TERMP_IGNDELIM & p->flags))
511: p->flags |= TERMP_NOSPACE;
1.65 kristaps 512:
1.71 kristaps 513: if ( ! (TERMP_NOSPACE & p->flags))
514: term_chara(p, ' ');
1.65 kristaps 515:
1.71 kristaps 516: if ( ! (p->flags & TERMP_NONOSPACE))
517: p->flags &= ~TERMP_NOSPACE;
1.65 kristaps 518:
1.71 kristaps 519: /*
520: * If ANSI (word-length styling), then apply our style now,
521: * before the word.
522: */
1.28 kristaps 523:
1.79 kristaps 524: for (i = 0; i < len; i++)
525: if ('\\' == word[i])
1.71 kristaps 526: term_pescape(p, word, &i, len);
1.79 kristaps 527: else
528: term_encodea(p, word[i]);
1.65 kristaps 529:
1.71 kristaps 530: if (term_isopendelim(word, len))
531: p->flags |= TERMP_NOSPACE;
1.65 kristaps 532: }
533:
534:
1.71 kristaps 535: /*
536: * Insert a single character into the line-buffer. If the buffer's
537: * space is exceeded, then allocate more space by doubling the buffer
538: * size.
539: */
540: static void
541: term_chara(struct termp *p, char c)
1.51 kristaps 542: {
1.71 kristaps 543: size_t s;
1.51 kristaps 544:
1.71 kristaps 545: if (p->col + 1 >= p->maxcols) {
546: if (0 == p->maxcols)
547: p->maxcols = 256;
548: s = p->maxcols * 2;
549: p->buf = realloc(p->buf, s);
550: if (NULL == p->buf)
551: err(1, "realloc");
552: p->maxcols = s;
553: }
554: p->buf[(int)(p->col)++] = c;
1.51 kristaps 555: }
556:
1.79 kristaps 557:
558: static void
559: term_encodea(struct termp *p, char c)
560: {
561:
562: if (TERMP_STYLE & p->flags) {
563: if (TERMP_BOLD & p->flags) {
564: term_chara(p, c);
565: term_chara(p, 8);
566: }
567: if (TERMP_UNDER & p->flags) {
568: term_chara(p, '_');
569: term_chara(p, 8);
570: }
571: }
572: term_chara(p, c);
573: }
CVSweb