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