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