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