Annotation of src/usr.bin/mandoc/man_term.c, Revision 1.127
1.127 ! schwarze 1: /* $OpenBSD: man_term.c,v 1.126 2015/04/02 23:47:43 schwarze Exp $ */
1.1 kristaps 2: /*
1.84 schwarze 3: * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
1.121 schwarze 4: * Copyright (c) 2010-2015 Ingo Schwarze <schwarze@openbsd.org>
1.1 kristaps 5: *
6: * Permission to use, copy, modify, and distribute this software for any
1.2 schwarze 7: * purpose with or without fee is hereby granted, provided that the above
8: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 9: *
1.124 schwarze 10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.2 schwarze 11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.124 schwarze 12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.2 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.
1.1 kristaps 17: */
1.13 schwarze 18: #include <sys/types.h>
19:
1.1 kristaps 20: #include <assert.h>
1.11 schwarze 21: #include <ctype.h>
1.117 schwarze 22: #include <limits.h>
1.1 kristaps 23: #include <stdio.h>
24: #include <stdlib.h>
25: #include <string.h>
26:
1.124 schwarze 27: #include "mandoc_aux.h"
1.37 schwarze 28: #include "mandoc.h"
1.124 schwarze 29: #include "roff.h"
30: #include "man.h"
1.18 schwarze 31: #include "out.h"
1.1 kristaps 32: #include "term.h"
1.18 schwarze 33: #include "main.h"
1.10 schwarze 34:
1.70 schwarze 35: #define MAXMARGINS 64 /* maximum number of indented scopes */
1.1 kristaps 36:
1.11 schwarze 37: struct mtermp {
38: int fl;
39: #define MANT_LITERAL (1 << 0)
1.116 schwarze 40: int lmargin[MAXMARGINS]; /* margins (incl. vis. page) */
1.70 schwarze 41: int lmargincur; /* index of current margin */
42: int lmarginsz; /* actual number of nested margins */
43: size_t offset; /* default offset to visible page */
1.88 schwarze 44: int pardist; /* vert. space before par., unit: [v] */
1.11 schwarze 45: };
46:
1.100 schwarze 47: #define DECL_ARGS struct termp *p, \
1.11 schwarze 48: struct mtermp *mt, \
1.125 schwarze 49: struct roff_node *n, \
1.126 schwarze 50: const struct roff_meta *meta
1.1 kristaps 51:
52: struct termact {
53: int (*pre)(DECL_ARGS);
54: void (*post)(DECL_ARGS);
1.26 schwarze 55: int flags;
56: #define MAN_NOTEXT (1 << 0) /* Never has text children. */
1.1 kristaps 57: };
58:
1.21 schwarze 59: static void print_man_nodelist(DECL_ARGS);
1.19 schwarze 60: static void print_man_node(DECL_ARGS);
1.126 schwarze 61: static void print_man_head(struct termp *,
62: const struct roff_meta *);
63: static void print_man_foot(struct termp *,
64: const struct roff_meta *);
1.100 schwarze 65: static void print_bvspace(struct termp *,
1.125 schwarze 66: const struct roff_node *, int);
1.18 schwarze 67:
1.1 kristaps 68: static int pre_B(DECL_ARGS);
1.11 schwarze 69: static int pre_HP(DECL_ARGS);
1.1 kristaps 70: static int pre_I(DECL_ARGS);
71: static int pre_IP(DECL_ARGS);
1.82 schwarze 72: static int pre_OP(DECL_ARGS);
1.88 schwarze 73: static int pre_PD(DECL_ARGS);
1.1 kristaps 74: static int pre_PP(DECL_ARGS);
1.13 schwarze 75: static int pre_RS(DECL_ARGS);
1.1 kristaps 76: static int pre_SH(DECL_ARGS);
77: static int pre_SS(DECL_ARGS);
78: static int pre_TP(DECL_ARGS);
1.91 schwarze 79: static int pre_UR(DECL_ARGS);
1.82 schwarze 80: static int pre_alternate(DECL_ARGS);
81: static int pre_ft(DECL_ARGS);
1.14 schwarze 82: static int pre_ign(DECL_ARGS);
1.45 schwarze 83: static int pre_in(DECL_ARGS);
84: static int pre_literal(DECL_ARGS);
1.97 schwarze 85: static int pre_ll(DECL_ARGS);
1.11 schwarze 86: static int pre_sp(DECL_ARGS);
1.1 kristaps 87:
1.11 schwarze 88: static void post_IP(DECL_ARGS);
89: static void post_HP(DECL_ARGS);
1.13 schwarze 90: static void post_RS(DECL_ARGS);
1.1 kristaps 91: static void post_SH(DECL_ARGS);
92: static void post_SS(DECL_ARGS);
1.11 schwarze 93: static void post_TP(DECL_ARGS);
1.91 schwarze 94: static void post_UR(DECL_ARGS);
1.1 kristaps 95:
1.17 schwarze 96: static const struct termact termacts[MAN_MAX] = {
1.45 schwarze 97: { pre_sp, NULL, MAN_NOTEXT }, /* br */
1.26 schwarze 98: { NULL, NULL, 0 }, /* TH */
99: { pre_SH, post_SH, 0 }, /* SH */
100: { pre_SS, post_SS, 0 }, /* SS */
101: { pre_TP, post_TP, 0 }, /* TP */
102: { pre_PP, NULL, 0 }, /* LP */
103: { pre_PP, NULL, 0 }, /* PP */
104: { pre_PP, NULL, 0 }, /* P */
105: { pre_IP, post_IP, 0 }, /* IP */
1.100 schwarze 106: { pre_HP, post_HP, 0 }, /* HP */
1.26 schwarze 107: { NULL, NULL, 0 }, /* SM */
108: { pre_B, NULL, 0 }, /* SB */
1.51 schwarze 109: { pre_alternate, NULL, 0 }, /* BI */
110: { pre_alternate, NULL, 0 }, /* IB */
111: { pre_alternate, NULL, 0 }, /* BR */
112: { pre_alternate, NULL, 0 }, /* RB */
1.26 schwarze 113: { NULL, NULL, 0 }, /* R */
114: { pre_B, NULL, 0 }, /* B */
115: { pre_I, NULL, 0 }, /* I */
1.51 schwarze 116: { pre_alternate, NULL, 0 }, /* IR */
117: { pre_alternate, NULL, 0 }, /* RI */
1.26 schwarze 118: { pre_sp, NULL, MAN_NOTEXT }, /* sp */
1.45 schwarze 119: { pre_literal, NULL, 0 }, /* nf */
120: { pre_literal, NULL, 0 }, /* fi */
1.26 schwarze 121: { NULL, NULL, 0 }, /* RE */
122: { pre_RS, post_RS, 0 }, /* RS */
123: { pre_ign, NULL, 0 }, /* DT */
1.111 schwarze 124: { pre_ign, NULL, MAN_NOTEXT }, /* UC */
1.88 schwarze 125: { pre_PD, NULL, MAN_NOTEXT }, /* PD */
1.36 schwarze 126: { pre_ign, NULL, 0 }, /* AT */
1.45 schwarze 127: { pre_in, NULL, MAN_NOTEXT }, /* in */
1.52 schwarze 128: { pre_ft, NULL, MAN_NOTEXT }, /* ft */
1.82 schwarze 129: { pre_OP, NULL, 0 }, /* OP */
1.83 schwarze 130: { pre_literal, NULL, 0 }, /* EX */
131: { pre_literal, NULL, 0 }, /* EE */
1.91 schwarze 132: { pre_UR, post_UR, 0 }, /* UR */
133: { NULL, NULL, 0 }, /* UE */
1.97 schwarze 134: { pre_ll, NULL, MAN_NOTEXT }, /* ll */
1.1 kristaps 135: };
1.11 schwarze 136:
1.1 kristaps 137:
1.16 schwarze 138: void
1.18 schwarze 139: terminal_man(void *arg, const struct man *man)
1.1 kristaps 140: {
1.18 schwarze 141: struct termp *p;
1.126 schwarze 142: const struct roff_meta *meta;
1.125 schwarze 143: struct roff_node *n;
1.18 schwarze 144: struct mtermp mt;
145:
146: p = (struct termp *)arg;
147:
1.39 schwarze 148: p->overstep = 0;
1.104 schwarze 149: p->rmargin = p->maxrmargin = p->defrmargin;
1.42 schwarze 150: p->tabwidth = term_len(p, 5);
1.18 schwarze 151:
1.104 schwarze 152: n = man_node(man)->child;
1.89 schwarze 153: meta = man_meta(man);
1.1 kristaps 154:
1.70 schwarze 155: memset(&mt, 0, sizeof(struct mtermp));
156:
1.77 schwarze 157: mt.lmargin[mt.lmargincur] = term_len(p, p->defindent);
158: mt.offset = term_len(p, p->defindent);
1.88 schwarze 159: mt.pardist = 1;
1.11 schwarze 160:
1.104 schwarze 161: if (p->synopsisonly) {
162: while (n != NULL) {
163: if (n->tok == MAN_SH &&
1.124 schwarze 164: n->child->child->type == ROFFT_TEXT &&
1.104 schwarze 165: !strcmp(n->child->child->string, "SYNOPSIS")) {
166: if (n->child->next->child != NULL)
167: print_man_nodelist(p, &mt,
168: n->child->next->child, meta);
169: term_newln(p);
170: break;
171: }
172: n = n->next;
173: }
174: } else {
175: if (p->defindent == 0)
176: p->defindent = 7;
177: term_begin(p, print_man_head, print_man_foot, meta);
178: p->flags |= TERMP_NOSPACE;
179: if (n != NULL)
180: print_man_nodelist(p, &mt, n, meta);
181: term_end(p);
182: }
1.1 kristaps 183: }
184:
1.69 schwarze 185: /*
186: * Printing leading vertical space before a block.
187: * This is used for the paragraph macros.
188: * The rules are pretty simple, since there's very little nesting going
189: * on here. Basically, if we're the first within another block (SS/SH),
190: * then don't emit vertical space. If we are (RS), then do. If not the
191: * first, print it.
192: */
1.18 schwarze 193: static void
1.125 schwarze 194: print_bvspace(struct termp *p, const struct roff_node *n, int pardist)
1.18 schwarze 195: {
1.88 schwarze 196: int i;
1.69 schwarze 197:
1.18 schwarze 198: term_newln(p);
1.64 schwarze 199:
1.69 schwarze 200: if (n->body && n->body->child)
1.124 schwarze 201: if (n->body->child->type == ROFFT_TBL)
1.69 schwarze 202: return;
1.11 schwarze 203:
1.124 schwarze 204: if (n->parent->type == ROFFT_ROOT || n->parent->tok != MAN_RS)
1.69 schwarze 205: if (NULL == n->prev)
206: return;
1.11 schwarze 207:
1.88 schwarze 208: for (i = 0; i < pardist; i++)
209: term_vspace(p);
1.14 schwarze 210: }
211:
1.100 schwarze 212:
1.14 schwarze 213: static int
214: pre_ign(DECL_ARGS)
215: {
216:
1.97 schwarze 217: return(0);
218: }
219:
220: static int
221: pre_ll(DECL_ARGS)
222: {
223:
1.98 schwarze 224: term_setwidth(p, n->nchild ? n->child->string : NULL);
1.14 schwarze 225: return(0);
1.11 schwarze 226: }
227:
1.1 kristaps 228: static int
229: pre_I(DECL_ARGS)
230: {
231:
1.21 schwarze 232: term_fontrepl(p, TERMFONT_UNDER);
1.1 kristaps 233: return(1);
234: }
235:
1.11 schwarze 236: static int
1.45 schwarze 237: pre_literal(DECL_ARGS)
1.11 schwarze 238: {
239:
1.45 schwarze 240: term_newln(p);
1.53 schwarze 241:
1.83 schwarze 242: if (MAN_nf == n->tok || MAN_EX == n->tok)
1.45 schwarze 243: mt->fl |= MANT_LITERAL;
1.53 schwarze 244: else
1.45 schwarze 245: mt->fl &= ~MANT_LITERAL;
246:
1.72 schwarze 247: /*
248: * Unlike .IP and .TP, .HP does not have a HEAD.
249: * So in case a second call to term_flushln() is needed,
250: * indentation has to be set up explicitly.
251: */
252: if (MAN_HP == n->parent->tok && p->rmargin < p->maxrmargin) {
1.76 schwarze 253: p->offset = p->rmargin;
1.72 schwarze 254: p->rmargin = p->maxrmargin;
1.93 schwarze 255: p->trailspace = 0;
1.99 schwarze 256: p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND);
1.72 schwarze 257: p->flags |= TERMP_NOSPACE;
258: }
259:
1.62 schwarze 260: return(0);
1.11 schwarze 261: }
262:
263: static int
1.88 schwarze 264: pre_PD(DECL_ARGS)
265: {
1.113 schwarze 266: struct roffsu su;
1.88 schwarze 267:
268: n = n->child;
1.113 schwarze 269: if (n == NULL) {
1.88 schwarze 270: mt->pardist = 1;
271: return(0);
272: }
1.124 schwarze 273: assert(n->type == ROFFT_TEXT);
1.113 schwarze 274: if (a2roffsu(n->string, &su, SCALE_VS))
275: mt->pardist = term_vspan(p, &su);
1.88 schwarze 276: return(0);
277: }
278:
279: static int
1.51 schwarze 280: pre_alternate(DECL_ARGS)
1.1 kristaps 281: {
1.51 schwarze 282: enum termfont font[2];
1.125 schwarze 283: struct roff_node *nn;
1.51 schwarze 284: int savelit, i;
1.1 kristaps 285:
1.51 schwarze 286: switch (n->tok) {
1.100 schwarze 287: case MAN_RB:
1.51 schwarze 288: font[0] = TERMFONT_NONE;
289: font[1] = TERMFONT_BOLD;
290: break;
1.100 schwarze 291: case MAN_RI:
1.51 schwarze 292: font[0] = TERMFONT_NONE;
293: font[1] = TERMFONT_UNDER;
294: break;
1.100 schwarze 295: case MAN_BR:
1.51 schwarze 296: font[0] = TERMFONT_BOLD;
297: font[1] = TERMFONT_NONE;
298: break;
1.100 schwarze 299: case MAN_BI:
1.51 schwarze 300: font[0] = TERMFONT_BOLD;
301: font[1] = TERMFONT_UNDER;
302: break;
1.100 schwarze 303: case MAN_IR:
1.51 schwarze 304: font[0] = TERMFONT_UNDER;
305: font[1] = TERMFONT_NONE;
306: break;
1.100 schwarze 307: case MAN_IB:
1.51 schwarze 308: font[0] = TERMFONT_UNDER;
309: font[1] = TERMFONT_BOLD;
310: break;
311: default:
312: abort();
313: }
1.17 schwarze 314:
1.51 schwarze 315: savelit = MANT_LITERAL & mt->fl;
316: mt->fl &= ~MANT_LITERAL;
1.17 schwarze 317:
1.51 schwarze 318: for (i = 0, nn = n->child; nn; nn = nn->next, i = 1 - i) {
319: term_fontrepl(p, font[i]);
320: if (savelit && NULL == nn->next)
321: mt->fl |= MANT_LITERAL;
1.89 schwarze 322: print_man_node(p, mt, nn, meta);
1.51 schwarze 323: if (nn->next)
1.1 kristaps 324: p->flags |= TERMP_NOSPACE;
325: }
1.17 schwarze 326:
1.1 kristaps 327: return(0);
328: }
329:
330: static int
331: pre_B(DECL_ARGS)
332: {
333:
1.21 schwarze 334: term_fontrepl(p, TERMFONT_BOLD);
1.1 kristaps 335: return(1);
1.82 schwarze 336: }
337:
338: static int
339: pre_OP(DECL_ARGS)
340: {
341:
342: term_word(p, "[");
343: p->flags |= TERMP_NOSPACE;
344:
345: if (NULL != (n = n->child)) {
346: term_fontrepl(p, TERMFONT_BOLD);
347: term_word(p, n->string);
348: }
349: if (NULL != n && NULL != n->next) {
350: term_fontrepl(p, TERMFONT_UNDER);
351: term_word(p, n->next->string);
352: }
353:
354: term_fontrepl(p, TERMFONT_NONE);
355: p->flags |= TERMP_NOSPACE;
356: term_word(p, "]");
357: return(0);
1.52 schwarze 358: }
359:
360: static int
361: pre_ft(DECL_ARGS)
362: {
363: const char *cp;
364:
365: if (NULL == n->child) {
366: term_fontlast(p);
367: return(0);
368: }
369:
370: cp = n->child->string;
371: switch (*cp) {
1.100 schwarze 372: case '4':
1.52 schwarze 373: /* FALLTHROUGH */
1.100 schwarze 374: case '3':
1.52 schwarze 375: /* FALLTHROUGH */
1.100 schwarze 376: case 'B':
1.52 schwarze 377: term_fontrepl(p, TERMFONT_BOLD);
378: break;
1.100 schwarze 379: case '2':
1.52 schwarze 380: /* FALLTHROUGH */
1.100 schwarze 381: case 'I':
1.52 schwarze 382: term_fontrepl(p, TERMFONT_UNDER);
383: break;
1.100 schwarze 384: case 'P':
1.52 schwarze 385: term_fontlast(p);
386: break;
1.100 schwarze 387: case '1':
1.52 schwarze 388: /* FALLTHROUGH */
1.100 schwarze 389: case 'C':
1.52 schwarze 390: /* FALLTHROUGH */
1.100 schwarze 391: case 'R':
1.52 schwarze 392: term_fontrepl(p, TERMFONT_NONE);
393: break;
394: default:
395: break;
396: }
397: return(0);
1.1 kristaps 398: }
399:
400: static int
1.45 schwarze 401: pre_in(DECL_ARGS)
1.11 schwarze 402: {
1.116 schwarze 403: struct roffsu su;
404: const char *cp;
1.45 schwarze 405: size_t v;
1.116 schwarze 406: int less;
1.45 schwarze 407:
408: term_newln(p);
409:
410: if (NULL == n->child) {
411: p->offset = mt->offset;
412: return(0);
413: }
1.11 schwarze 414:
1.45 schwarze 415: cp = n->child->string;
416: less = 0;
1.11 schwarze 417:
1.45 schwarze 418: if ('-' == *cp)
419: less = -1;
420: else if ('+' == *cp)
421: less = 1;
422: else
423: cp--;
424:
1.116 schwarze 425: if ( ! a2roffsu(++cp, &su, SCALE_EN))
1.45 schwarze 426: return(0);
427:
1.116 schwarze 428: v = term_hspan(p, &su);
1.45 schwarze 429:
430: if (less < 0)
431: p->offset -= p->offset > v ? v : p->offset;
432: else if (less > 0)
433: p->offset += v;
1.100 schwarze 434: else
1.45 schwarze 435: p->offset = v;
1.117 schwarze 436: if (p->offset > SHRT_MAX)
437: p->offset = term_len(p, p->defindent);
1.59 schwarze 438:
1.11 schwarze 439: return(0);
440: }
441:
442: static int
1.45 schwarze 443: pre_sp(DECL_ARGS)
1.8 schwarze 444: {
1.115 schwarze 445: struct roffsu su;
1.116 schwarze 446: int i, len;
1.45 schwarze 447:
1.69 schwarze 448: if ((NULL == n->prev && n->parent)) {
1.86 schwarze 449: switch (n->parent->tok) {
1.100 schwarze 450: case MAN_SH:
1.86 schwarze 451: /* FALLTHROUGH */
1.100 schwarze 452: case MAN_SS:
1.86 schwarze 453: /* FALLTHROUGH */
1.100 schwarze 454: case MAN_PP:
1.86 schwarze 455: /* FALLTHROUGH */
1.100 schwarze 456: case MAN_LP:
1.86 schwarze 457: /* FALLTHROUGH */
1.100 schwarze 458: case MAN_P:
1.86 schwarze 459: /* FALLTHROUGH */
1.69 schwarze 460: return(0);
1.86 schwarze 461: default:
462: break;
463: }
1.69 schwarze 464: }
465:
1.116 schwarze 466: if (n->tok == MAN_br)
1.45 schwarze 467: len = 0;
1.116 schwarze 468: else if (n->child == NULL)
469: len = 1;
470: else {
471: if ( ! a2roffsu(n->child->string, &su, SCALE_VS))
1.115 schwarze 472: su.scale = 1.0;
473: len = term_vspan(p, &su);
1.45 schwarze 474: }
475:
1.116 schwarze 476: if (len == 0)
1.45 schwarze 477: term_newln(p);
1.116 schwarze 478: else if (len < 0)
479: p->skipvsp -= len;
1.85 schwarze 480: else
481: for (i = 0; i < len; i++)
482: term_vspace(p);
1.8 schwarze 483:
484: return(0);
485: }
486:
487: static int
1.11 schwarze 488: pre_HP(DECL_ARGS)
489: {
1.116 schwarze 490: struct roffsu su;
1.125 schwarze 491: const struct roff_node *nn;
1.116 schwarze 492: int len;
1.11 schwarze 493:
494: switch (n->type) {
1.124 schwarze 495: case ROFFT_BLOCK:
1.88 schwarze 496: print_bvspace(p, n, mt->pardist);
1.11 schwarze 497: return(1);
1.124 schwarze 498: case ROFFT_BODY:
1.11 schwarze 499: break;
500: default:
501: return(0);
502: }
503:
1.84 schwarze 504: if ( ! (MANT_LITERAL & mt->fl)) {
1.99 schwarze 505: p->flags |= TERMP_NOBREAK | TERMP_BRIND;
1.93 schwarze 506: p->trailspace = 2;
1.84 schwarze 507: }
508:
1.11 schwarze 509: /* Calculate offset. */
510:
1.116 schwarze 511: if ((nn = n->parent->head->child) != NULL &&
512: a2roffsu(nn->string, &su, SCALE_EN)) {
513: len = term_hspan(p, &su);
1.117 schwarze 514: if (len < 0 && (size_t)(-len) > mt->offset)
515: len = -mt->offset;
516: else if (len > SHRT_MAX)
517: len = term_len(p, p->defindent);
1.116 schwarze 518: mt->lmargin[mt->lmargincur] = len;
519: } else
520: len = mt->lmargin[mt->lmargincur];
1.11 schwarze 521:
1.13 schwarze 522: p->offset = mt->offset;
1.117 schwarze 523: p->rmargin = mt->offset + len;
1.11 schwarze 524: return(1);
525: }
526:
527: static void
528: post_HP(DECL_ARGS)
529: {
530:
531: switch (n->type) {
1.124 schwarze 532: case ROFFT_BODY:
1.90 schwarze 533: term_newln(p);
1.127 ! schwarze 534:
! 535: /*
! 536: * Compatibility with a groff bug.
! 537: * The .HP macro uses the undocumented .tag request
! 538: * which causes a line break and cancels no-space
! 539: * mode even if there isn't any output.
! 540: */
! 541:
! 542: if (n->child == NULL)
! 543: term_vspace(p);
! 544:
1.99 schwarze 545: p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND);
1.93 schwarze 546: p->trailspace = 0;
1.13 schwarze 547: p->offset = mt->offset;
1.11 schwarze 548: p->rmargin = p->maxrmargin;
549: break;
550: default:
551: break;
552: }
553: }
554:
555: static int
1.1 kristaps 556: pre_PP(DECL_ARGS)
557: {
558:
1.11 schwarze 559: switch (n->type) {
1.124 schwarze 560: case ROFFT_BLOCK:
1.77 schwarze 561: mt->lmargin[mt->lmargincur] = term_len(p, p->defindent);
1.88 schwarze 562: print_bvspace(p, n, mt->pardist);
1.11 schwarze 563: break;
564: default:
1.13 schwarze 565: p->offset = mt->offset;
1.11 schwarze 566: break;
567: }
568:
1.124 schwarze 569: return(n->type != ROFFT_HEAD);
1.1 kristaps 570: }
571:
572: static int
573: pre_IP(DECL_ARGS)
574: {
1.116 schwarze 575: struct roffsu su;
1.125 schwarze 576: const struct roff_node *nn;
1.116 schwarze 577: int len, savelit;
1.11 schwarze 578:
579: switch (n->type) {
1.124 schwarze 580: case ROFFT_BODY:
1.11 schwarze 581: p->flags |= TERMP_NOSPACE;
582: break;
1.124 schwarze 583: case ROFFT_HEAD:
1.11 schwarze 584: p->flags |= TERMP_NOBREAK;
1.93 schwarze 585: p->trailspace = 1;
1.11 schwarze 586: break;
1.124 schwarze 587: case ROFFT_BLOCK:
1.88 schwarze 588: print_bvspace(p, n, mt->pardist);
1.11 schwarze 589: /* FALLTHROUGH */
590: default:
591: return(1);
592: }
593:
1.57 schwarze 594: /* Calculate the offset from the optional second argument. */
1.116 schwarze 595: if ((nn = n->parent->head->child) != NULL &&
596: (nn = nn->next) != NULL &&
597: a2roffsu(nn->string, &su, SCALE_EN)) {
598: len = term_hspan(p, &su);
599: if (len < 0 && (size_t)(-len) > mt->offset)
600: len = -mt->offset;
1.117 schwarze 601: else if (len > SHRT_MAX)
602: len = term_len(p, p->defindent);
603: mt->lmargin[mt->lmargincur] = len;
1.116 schwarze 604: } else
605: len = mt->lmargin[mt->lmargincur];
1.11 schwarze 606:
607: switch (n->type) {
1.124 schwarze 608: case ROFFT_HEAD:
1.13 schwarze 609: p->offset = mt->offset;
610: p->rmargin = mt->offset + len;
1.11 schwarze 611:
1.57 schwarze 612: savelit = MANT_LITERAL & mt->fl;
613: mt->fl &= ~MANT_LITERAL;
614:
615: if (n->child)
1.89 schwarze 616: print_man_node(p, mt, n->child, meta);
1.57 schwarze 617:
618: if (savelit)
619: mt->fl |= MANT_LITERAL;
620:
1.11 schwarze 621: return(0);
1.124 schwarze 622: case ROFFT_BODY:
1.13 schwarze 623: p->offset = mt->offset + len;
1.109 schwarze 624: p->rmargin = p->maxrmargin;
1.11 schwarze 625: break;
626: default:
627: break;
628: }
1.1 kristaps 629:
1.11 schwarze 630: return(1);
631: }
1.1 kristaps 632:
1.11 schwarze 633: static void
634: post_IP(DECL_ARGS)
635: {
1.4 schwarze 636:
1.11 schwarze 637: switch (n->type) {
1.124 schwarze 638: case ROFFT_HEAD:
1.11 schwarze 639: term_flushln(p);
640: p->flags &= ~TERMP_NOBREAK;
1.93 schwarze 641: p->trailspace = 0;
1.11 schwarze 642: p->rmargin = p->maxrmargin;
643: break;
1.124 schwarze 644: case ROFFT_BODY:
1.57 schwarze 645: term_newln(p);
1.92 schwarze 646: p->offset = mt->offset;
1.11 schwarze 647: break;
648: default:
649: break;
650: }
1.1 kristaps 651: }
652:
653: static int
654: pre_TP(DECL_ARGS)
655: {
1.116 schwarze 656: struct roffsu su;
1.125 schwarze 657: struct roff_node *nn;
1.116 schwarze 658: int len, savelit;
1.11 schwarze 659:
660: switch (n->type) {
1.124 schwarze 661: case ROFFT_HEAD:
1.11 schwarze 662: p->flags |= TERMP_NOBREAK;
1.93 schwarze 663: p->trailspace = 1;
1.11 schwarze 664: break;
1.124 schwarze 665: case ROFFT_BODY:
1.11 schwarze 666: p->flags |= TERMP_NOSPACE;
667: break;
1.124 schwarze 668: case ROFFT_BLOCK:
1.88 schwarze 669: print_bvspace(p, n, mt->pardist);
1.11 schwarze 670: /* FALLTHROUGH */
671: default:
672: return(1);
673: }
674:
675: /* Calculate offset. */
1.1 kristaps 676:
1.116 schwarze 677: if ((nn = n->parent->head->child) != NULL &&
678: nn->string != NULL && ! (MAN_LINE & nn->flags) &&
679: a2roffsu(nn->string, &su, SCALE_EN)) {
680: len = term_hspan(p, &su);
681: if (len < 0 && (size_t)(-len) > mt->offset)
682: len = -mt->offset;
1.117 schwarze 683: else if (len > SHRT_MAX)
684: len = term_len(p, p->defindent);
685: mt->lmargin[mt->lmargincur] = len;
1.116 schwarze 686: } else
687: len = mt->lmargin[mt->lmargincur];
1.8 schwarze 688:
1.11 schwarze 689: switch (n->type) {
1.124 schwarze 690: case ROFFT_HEAD:
1.13 schwarze 691: p->offset = mt->offset;
692: p->rmargin = mt->offset + len;
1.11 schwarze 693:
1.57 schwarze 694: savelit = MANT_LITERAL & mt->fl;
695: mt->fl &= ~MANT_LITERAL;
696:
1.11 schwarze 697: /* Don't print same-line elements. */
1.95 schwarze 698: nn = n->child;
699: while (NULL != nn && 0 == (MAN_LINE & nn->flags))
700: nn = nn->next;
701:
702: while (NULL != nn) {
703: print_man_node(p, mt, nn, meta);
704: nn = nn->next;
705: }
1.11 schwarze 706:
1.57 schwarze 707: if (savelit)
708: mt->fl |= MANT_LITERAL;
1.11 schwarze 709: return(0);
1.124 schwarze 710: case ROFFT_BODY:
1.13 schwarze 711: p->offset = mt->offset + len;
1.109 schwarze 712: p->rmargin = p->maxrmargin;
1.93 schwarze 713: p->trailspace = 0;
1.84 schwarze 714: p->flags &= ~TERMP_NOBREAK;
1.11 schwarze 715: break;
716: default:
717: break;
718: }
1.1 kristaps 719:
1.11 schwarze 720: return(1);
721: }
1.1 kristaps 722:
1.11 schwarze 723: static void
724: post_TP(DECL_ARGS)
725: {
1.1 kristaps 726:
1.11 schwarze 727: switch (n->type) {
1.124 schwarze 728: case ROFFT_HEAD:
1.11 schwarze 729: term_flushln(p);
730: break;
1.124 schwarze 731: case ROFFT_BODY:
1.57 schwarze 732: term_newln(p);
1.92 schwarze 733: p->offset = mt->offset;
1.11 schwarze 734: break;
735: default:
736: break;
737: }
1.1 kristaps 738: }
739:
740: static int
741: pre_SS(DECL_ARGS)
742: {
1.88 schwarze 743: int i;
1.1 kristaps 744:
1.11 schwarze 745: switch (n->type) {
1.124 schwarze 746: case ROFFT_BLOCK:
1.69 schwarze 747: mt->fl &= ~MANT_LITERAL;
1.77 schwarze 748: mt->lmargin[mt->lmargincur] = term_len(p, p->defindent);
749: mt->offset = term_len(p, p->defindent);
1.111 schwarze 750:
751: /*
752: * No vertical space before the first subsection
753: * and after an empty subsection.
754: */
755:
756: do {
757: n = n->prev;
1.123 schwarze 758: } while (n != NULL && n->tok != MAN_MAX &&
759: termacts[n->tok].flags & MAN_NOTEXT);
1.111 schwarze 760: if (n == NULL || (n->tok == MAN_SS && n->body->child == NULL))
1.11 schwarze 761: break;
1.111 schwarze 762:
1.88 schwarze 763: for (i = 0; i < mt->pardist; i++)
764: term_vspace(p);
1.11 schwarze 765: break;
1.124 schwarze 766: case ROFFT_HEAD:
1.21 schwarze 767: term_fontrepl(p, TERMFONT_BOLD);
1.87 schwarze 768: p->offset = term_len(p, 3);
1.11 schwarze 769: break;
1.124 schwarze 770: case ROFFT_BODY:
1.13 schwarze 771: p->offset = mt->offset;
1.11 schwarze 772: break;
773: default:
774: break;
775: }
776:
1.1 kristaps 777: return(1);
778: }
779:
780: static void
781: post_SS(DECL_ARGS)
782: {
1.100 schwarze 783:
1.11 schwarze 784: switch (n->type) {
1.124 schwarze 785: case ROFFT_HEAD:
1.11 schwarze 786: term_newln(p);
787: break;
1.124 schwarze 788: case ROFFT_BODY:
1.11 schwarze 789: term_newln(p);
790: break;
791: default:
792: break;
793: }
1.1 kristaps 794: }
795:
796: static int
797: pre_SH(DECL_ARGS)
798: {
1.88 schwarze 799: int i;
1.1 kristaps 800:
1.11 schwarze 801: switch (n->type) {
1.124 schwarze 802: case ROFFT_BLOCK:
1.69 schwarze 803: mt->fl &= ~MANT_LITERAL;
1.77 schwarze 804: mt->lmargin[mt->lmargincur] = term_len(p, p->defindent);
805: mt->offset = term_len(p, p->defindent);
1.111 schwarze 806:
807: /*
808: * No vertical space before the first section
809: * and after an empty section.
810: */
811:
812: do {
813: n = n->prev;
814: } while (n != NULL && termacts[n->tok].flags & MAN_NOTEXT);
815: if (n == NULL || (n->tok == MAN_SH && n->body->child == NULL))
1.29 schwarze 816: break;
1.111 schwarze 817:
1.88 schwarze 818: for (i = 0; i < mt->pardist; i++)
819: term_vspace(p);
1.11 schwarze 820: break;
1.124 schwarze 821: case ROFFT_HEAD:
1.21 schwarze 822: term_fontrepl(p, TERMFONT_BOLD);
1.11 schwarze 823: p->offset = 0;
824: break;
1.124 schwarze 825: case ROFFT_BODY:
1.13 schwarze 826: p->offset = mt->offset;
1.11 schwarze 827: break;
828: default:
829: break;
830: }
831:
1.1 kristaps 832: return(1);
833: }
834:
835: static void
836: post_SH(DECL_ARGS)
837: {
1.100 schwarze 838:
1.11 schwarze 839: switch (n->type) {
1.124 schwarze 840: case ROFFT_HEAD:
1.11 schwarze 841: term_newln(p);
842: break;
1.124 schwarze 843: case ROFFT_BODY:
1.11 schwarze 844: term_newln(p);
845: break;
846: default:
1.13 schwarze 847: break;
848: }
849: }
850:
851: static int
852: pre_RS(DECL_ARGS)
853: {
1.116 schwarze 854: struct roffsu su;
1.13 schwarze 855:
856: switch (n->type) {
1.124 schwarze 857: case ROFFT_BLOCK:
1.13 schwarze 858: term_newln(p);
859: return(1);
1.124 schwarze 860: case ROFFT_HEAD:
1.13 schwarze 861: return(0);
862: default:
863: break;
864: }
865:
1.118 schwarze 866: n = n->parent->head;
867: n->aux = SHRT_MAX + 1;
868: if (n->child != NULL && a2roffsu(n->child->string, &su, SCALE_EN))
869: n->aux = term_hspan(p, &su);
870: if (n->aux < 0 && (size_t)(-n->aux) > mt->offset)
871: n->aux = -mt->offset;
872: else if (n->aux > SHRT_MAX)
873: n->aux = term_len(p, p->defindent);
1.13 schwarze 874:
1.118 schwarze 875: mt->offset += n->aux;
1.94 schwarze 876: p->offset = mt->offset;
1.109 schwarze 877: p->rmargin = p->maxrmargin;
1.13 schwarze 878:
1.70 schwarze 879: if (++mt->lmarginsz < MAXMARGINS)
880: mt->lmargincur = mt->lmarginsz;
881:
882: mt->lmargin[mt->lmargincur] = mt->lmargin[mt->lmargincur - 1];
1.13 schwarze 883: return(1);
884: }
885:
886: static void
887: post_RS(DECL_ARGS)
888: {
889:
890: switch (n->type) {
1.124 schwarze 891: case ROFFT_BLOCK:
1.69 schwarze 892: return;
1.124 schwarze 893: case ROFFT_HEAD:
1.69 schwarze 894: return;
1.13 schwarze 895: default:
896: term_newln(p);
1.11 schwarze 897: break;
898: }
1.69 schwarze 899:
1.118 schwarze 900: mt->offset -= n->parent->head->aux;
1.69 schwarze 901: p->offset = mt->offset;
1.70 schwarze 902:
903: if (--mt->lmarginsz < MAXMARGINS)
904: mt->lmargincur = mt->lmarginsz;
1.91 schwarze 905: }
906:
907: static int
908: pre_UR(DECL_ARGS)
909: {
910:
1.124 schwarze 911: return (n->type != ROFFT_HEAD);
1.91 schwarze 912: }
913:
914: static void
915: post_UR(DECL_ARGS)
916: {
917:
1.124 schwarze 918: if (n->type != ROFFT_BLOCK)
1.91 schwarze 919: return;
920:
921: term_word(p, "<");
922: p->flags |= TERMP_NOSPACE;
923:
924: if (NULL != n->child->child)
925: print_man_node(p, mt, n->child->child, meta);
926:
927: p->flags |= TERMP_NOSPACE;
928: term_word(p, ">");
1.47 schwarze 929: }
930:
1.1 kristaps 931: static void
1.19 schwarze 932: print_man_node(DECL_ARGS)
1.1 kristaps 933: {
1.32 schwarze 934: size_t rm, rmax;
1.21 schwarze 935: int c;
1.1 kristaps 936:
937: switch (n->type) {
1.124 schwarze 938: case ROFFT_TEXT:
1.61 schwarze 939: /*
940: * If we have a blank line, output a vertical space.
941: * If we have a space as the first character, break
942: * before printing the line's data.
943: */
1.60 schwarze 944: if ('\0' == *n->string) {
1.1 kristaps 945: term_vspace(p);
1.61 schwarze 946: return;
947: } else if (' ' == *n->string && MAN_LINE & n->flags)
1.60 schwarze 948: term_newln(p);
1.21 schwarze 949:
1.1 kristaps 950: term_word(p, n->string);
1.84 schwarze 951: goto out;
1.21 schwarze 952:
1.124 schwarze 953: case ROFFT_EQN:
1.105 schwarze 954: if ( ! (n->flags & MAN_LINE))
955: p->flags |= TERMP_NOSPACE;
1.71 schwarze 956: term_eqn(p, n->eqn);
1.107 schwarze 957: if (n->next != NULL && ! (n->next->flags & MAN_LINE))
1.106 schwarze 958: p->flags |= TERMP_NOSPACE;
1.61 schwarze 959: return;
1.124 schwarze 960: case ROFFT_TBL:
1.122 schwarze 961: if (p->tbl.cols == NULL)
962: term_vspace(p);
1.58 schwarze 963: term_tbl(p, n->span);
1.61 schwarze 964: return;
1.1 kristaps 965: default:
966: break;
967: }
968:
1.61 schwarze 969: if ( ! (MAN_NOTEXT & termacts[n->tok].flags))
970: term_fontrepl(p, TERMFONT_NONE);
971:
972: c = 1;
973: if (termacts[n->tok].pre)
1.89 schwarze 974: c = (*termacts[n->tok].pre)(p, mt, n, meta);
1.61 schwarze 975:
1.1 kristaps 976: if (c && n->child)
1.89 schwarze 977: print_man_nodelist(p, mt, n->child, meta);
1.1 kristaps 978:
1.61 schwarze 979: if (termacts[n->tok].post)
1.89 schwarze 980: (*termacts[n->tok].post)(p, mt, n, meta);
1.61 schwarze 981: if ( ! (MAN_NOTEXT & termacts[n->tok].flags))
982: term_fontrepl(p, TERMFONT_NONE);
1.30 schwarze 983:
1.84 schwarze 984: out:
985: /*
986: * If we're in a literal context, make sure that words
987: * together on the same line stay together. This is a
988: * POST-printing call, so we check the NEXT word. Since
989: * -man doesn't have nested macros, we don't need to be
990: * more specific than this.
991: */
1.110 schwarze 992: if (mt->fl & MANT_LITERAL &&
993: ! (p->flags & (TERMP_NOBREAK | TERMP_NONEWLINE)) &&
994: (n->next == NULL || n->next->flags & MAN_LINE)) {
1.84 schwarze 995: rm = p->rmargin;
996: rmax = p->maxrmargin;
997: p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
998: p->flags |= TERMP_NOSPACE;
1.110 schwarze 999: if (n->string != NULL && *n->string != '\0')
1.84 schwarze 1000: term_flushln(p);
1001: else
1002: term_newln(p);
1003: if (rm < rmax && n->parent->tok == MAN_HP) {
1004: p->offset = rm;
1005: p->rmargin = rmax;
1006: } else
1007: p->rmargin = rm;
1008: p->maxrmargin = rmax;
1009: }
1.30 schwarze 1010: if (MAN_EOS & n->flags)
1011: p->flags |= TERMP_SENTENCE;
1.1 kristaps 1012: }
1013:
1014:
1015: static void
1.21 schwarze 1016: print_man_nodelist(DECL_ARGS)
1.1 kristaps 1017: {
1.11 schwarze 1018:
1.121 schwarze 1019: while (n != NULL) {
1020: print_man_node(p, mt, n, meta);
1021: n = n->next;
1022: }
1.1 kristaps 1023: }
1024:
1025: static void
1.126 schwarze 1026: print_man_foot(struct termp *p, const struct roff_meta *meta)
1.1 kristaps 1027: {
1.101 schwarze 1028: char *title;
1.109 schwarze 1029: size_t datelen, titlen;
1.41 schwarze 1030:
1.80 schwarze 1031: assert(meta->title);
1032: assert(meta->msec);
1033: assert(meta->date);
1.21 schwarze 1034:
1035: term_fontrepl(p, TERMFONT_NONE);
1.1 kristaps 1036:
1.103 schwarze 1037: if (meta->hasbody)
1038: term_vspace(p);
1.81 schwarze 1039:
1040: /*
1041: * Temporary, undocumented option to imitate mdoc(7) output.
1.126 schwarze 1042: * In the bottom right corner, use the operating system
1043: * instead of the title.
1.81 schwarze 1044: */
1045:
1.79 schwarze 1046: if ( ! p->mdocstyle) {
1.103 schwarze 1047: if (meta->hasbody) {
1048: term_vspace(p);
1049: term_vspace(p);
1050: }
1.101 schwarze 1051: mandoc_asprintf(&title, "%s(%s)",
1052: meta->title, meta->msec);
1.126 schwarze 1053: } else if (meta->os) {
1054: title = mandoc_strdup(meta->os);
1.79 schwarze 1055: } else {
1.101 schwarze 1056: title = mandoc_strdup("");
1.79 schwarze 1057: }
1.78 schwarze 1058: datelen = term_strlen(p, meta->date);
1.1 kristaps 1059:
1.126 schwarze 1060: /* Bottom left corner: operating system. */
1.81 schwarze 1061:
1.1 kristaps 1062: p->flags |= TERMP_NOSPACE | TERMP_NOBREAK;
1.93 schwarze 1063: p->trailspace = 1;
1.1 kristaps 1064: p->offset = 0;
1.109 schwarze 1065: p->rmargin = p->maxrmargin > datelen ?
1066: (p->maxrmargin + term_len(p, 1) - datelen) / 2 : 0;
1.1 kristaps 1067:
1.126 schwarze 1068: if (meta->os)
1069: term_word(p, meta->os);
1.1 kristaps 1070: term_flushln(p);
1071:
1.81 schwarze 1072: /* At the bottom in the middle: manual date. */
1073:
1.109 schwarze 1074: p->offset = p->rmargin;
1075: titlen = term_strlen(p, title);
1076: p->rmargin = p->maxrmargin > titlen ? p->maxrmargin - titlen : 0;
1.72 schwarze 1077: p->flags |= TERMP_NOSPACE;
1.78 schwarze 1078:
1079: term_word(p, meta->date);
1080: term_flushln(p);
1081:
1.81 schwarze 1082: /* Bottom right corner: manual title and section. */
1083:
1.78 schwarze 1084: p->flags &= ~TERMP_NOBREAK;
1085: p->flags |= TERMP_NOSPACE;
1.93 schwarze 1086: p->trailspace = 0;
1.78 schwarze 1087: p->offset = p->rmargin;
1.1 kristaps 1088: p->rmargin = p->maxrmargin;
1089:
1.78 schwarze 1090: term_word(p, title);
1.1 kristaps 1091: term_flushln(p);
1.101 schwarze 1092: free(title);
1.1 kristaps 1093: }
1094:
1095: static void
1.126 schwarze 1096: print_man_head(struct termp *p, const struct roff_meta *meta)
1.1 kristaps 1097: {
1.102 schwarze 1098: const char *volume;
1.101 schwarze 1099: char *title;
1.102 schwarze 1100: size_t vollen, titlen;
1.41 schwarze 1101:
1.89 schwarze 1102: assert(meta->title);
1103: assert(meta->msec);
1.1 kristaps 1104:
1.102 schwarze 1105: volume = NULL == meta->vol ? "" : meta->vol;
1106: vollen = term_strlen(p, volume);
1.1 kristaps 1107:
1.81 schwarze 1108: /* Top left corner: manual title and section. */
1109:
1.101 schwarze 1110: mandoc_asprintf(&title, "%s(%s)", meta->title, meta->msec);
1.42 schwarze 1111: titlen = term_strlen(p, title);
1.1 kristaps 1112:
1.73 schwarze 1113: p->flags |= TERMP_NOBREAK | TERMP_NOSPACE;
1.93 schwarze 1114: p->trailspace = 1;
1.1 kristaps 1115: p->offset = 0;
1.102 schwarze 1116: p->rmargin = 2 * (titlen+1) + vollen < p->maxrmargin ?
1117: (p->maxrmargin - vollen + term_len(p, 1)) / 2 :
1.109 schwarze 1118: vollen < p->maxrmargin ? p->maxrmargin - vollen : 0;
1.1 kristaps 1119:
1120: term_word(p, title);
1121: term_flushln(p);
1122:
1.81 schwarze 1123: /* At the top in the middle: manual volume. */
1124:
1.72 schwarze 1125: p->flags |= TERMP_NOSPACE;
1.1 kristaps 1126: p->offset = p->rmargin;
1.102 schwarze 1127: p->rmargin = p->offset + vollen + titlen < p->maxrmargin ?
1.25 schwarze 1128: p->maxrmargin - titlen : p->maxrmargin;
1.1 kristaps 1129:
1.102 schwarze 1130: term_word(p, volume);
1.1 kristaps 1131: term_flushln(p);
1132:
1.81 schwarze 1133: /* Top right corner: title and section, again. */
1134:
1.1 kristaps 1135: p->flags &= ~TERMP_NOBREAK;
1.93 schwarze 1136: p->trailspace = 0;
1.25 schwarze 1137: if (p->rmargin + titlen <= p->maxrmargin) {
1.72 schwarze 1138: p->flags |= TERMP_NOSPACE;
1.25 schwarze 1139: p->offset = p->rmargin;
1140: p->rmargin = p->maxrmargin;
1141: term_word(p, title);
1142: term_flushln(p);
1143: }
1.1 kristaps 1144:
1.73 schwarze 1145: p->flags &= ~TERMP_NOSPACE;
1146: p->offset = 0;
1.1 kristaps 1147: p->rmargin = p->maxrmargin;
1.29 schwarze 1148:
1.100 schwarze 1149: /*
1.81 schwarze 1150: * Groff prints three blank lines before the content.
1151: * Do the same, except in the temporary, undocumented
1152: * mode imitating mdoc(7) output.
1.29 schwarze 1153: */
1154:
1155: term_vspace(p);
1.79 schwarze 1156: if ( ! p->mdocstyle) {
1157: term_vspace(p);
1158: term_vspace(p);
1159: }
1.101 schwarze 1160: free(title);
1.1 kristaps 1161: }
![[BACK]](/icons/back.gif){kind=icon}
Return to man_term.c CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / mandoc