1 /* $Id: man_term.c,v 1.191 2017/02/15 14:10:08 schwarze Exp $ */
3 * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2010-2015, 2017 Ingo Schwarze <schwarze@openbsd.org>
6 * Permission to use, copy, modify, and distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS 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.
20 #include <sys/types.h>
29 #include "mandoc_aux.h"
37 #define MAXMARGINS 64 /* maximum number of indented scopes */
41 #define MANT_LITERAL (1 << 0)
42 int lmargin[MAXMARGINS]; /* margins (incl. vis. page) */
43 int lmargincur; /* index of current margin */
44 int lmarginsz; /* actual number of nested margins */
45 size_t offset; /* default offset to visible page */
46 int pardist; /* vert. space before par., unit: [v] */
49 #define DECL_ARGS struct termp *p, \
51 struct roff_node *n, \
52 const struct roff_meta *meta
55 int (*pre)(DECL_ARGS);
56 void (*post)(DECL_ARGS);
58 #define MAN_NOTEXT (1 << 0) /* Never has text children. */
61 static void print_man_nodelist(DECL_ARGS);
62 static void print_man_node(DECL_ARGS);
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 *);
67 static void print_bvspace(struct termp *,
68 const struct roff_node *, int);
70 static int pre_B(DECL_ARGS);
71 static int pre_HP(DECL_ARGS);
72 static int pre_I(DECL_ARGS);
73 static int pre_IP(DECL_ARGS);
74 static int pre_OP(DECL_ARGS);
75 static int pre_PD(DECL_ARGS);
76 static int pre_PP(DECL_ARGS);
77 static int pre_RS(DECL_ARGS);
78 static int pre_SH(DECL_ARGS);
79 static int pre_SS(DECL_ARGS);
80 static int pre_TP(DECL_ARGS);
81 static int pre_UR(DECL_ARGS);
82 static int pre_alternate(DECL_ARGS);
83 static int pre_ft(DECL_ARGS);
84 static int pre_ign(DECL_ARGS);
85 static int pre_in(DECL_ARGS);
86 static int pre_literal(DECL_ARGS);
87 static int pre_ll(DECL_ARGS);
88 static int pre_sp(DECL_ARGS);
90 static void post_IP(DECL_ARGS);
91 static void post_HP(DECL_ARGS);
92 static void post_RS(DECL_ARGS);
93 static void post_SH(DECL_ARGS);
94 static void post_SS(DECL_ARGS);
95 static void post_TP(DECL_ARGS);
96 static void post_UR(DECL_ARGS);
98 static const struct termact termacts[MAN_MAX] = {
99 { pre_sp, NULL, MAN_NOTEXT }, /* br */
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 */
108 { pre_HP, post_HP, 0 }, /* HP */
109 { NULL, NULL, 0 }, /* SM */
110 { pre_B, NULL, 0 }, /* SB */
111 { pre_alternate, NULL, 0 }, /* BI */
112 { pre_alternate, NULL, 0 }, /* IB */
113 { pre_alternate, NULL, 0 }, /* BR */
114 { pre_alternate, NULL, 0 }, /* RB */
115 { NULL, NULL, 0 }, /* R */
116 { pre_B, NULL, 0 }, /* B */
117 { pre_I, NULL, 0 }, /* I */
118 { pre_alternate, NULL, 0 }, /* IR */
119 { pre_alternate, NULL, 0 }, /* RI */
120 { pre_sp, NULL, MAN_NOTEXT }, /* sp */
121 { pre_literal, NULL, 0 }, /* nf */
122 { pre_literal, NULL, 0 }, /* fi */
123 { NULL, NULL, 0 }, /* RE */
124 { pre_RS, post_RS, 0 }, /* RS */
125 { pre_ign, NULL, 0 }, /* DT */
126 { pre_ign, NULL, MAN_NOTEXT }, /* UC */
127 { pre_PD, NULL, MAN_NOTEXT }, /* PD */
128 { pre_ign, NULL, 0 }, /* AT */
129 { pre_in, NULL, MAN_NOTEXT }, /* in */
130 { pre_ft, NULL, MAN_NOTEXT }, /* ft */
131 { pre_OP, NULL, 0 }, /* OP */
132 { pre_literal, NULL, 0 }, /* EX */
133 { pre_literal, NULL, 0 }, /* EE */
134 { pre_UR, post_UR, 0 }, /* UR */
135 { NULL, NULL, 0 }, /* UE */
136 { pre_ll, NULL, MAN_NOTEXT }, /* ll */
141 terminal_man(void *arg, const struct roff_man *man)
146 size_t save_defindent;
148 p = (struct termp *)arg;
150 p->rmargin = p->maxrmargin = p->defrmargin;
151 p->tabwidth = term_len(p, 5);
153 memset(&mt, 0, sizeof(struct mtermp));
154 mt.lmargin[mt.lmargincur] = term_len(p, p->defindent);
155 mt.offset = term_len(p, p->defindent);
158 n = man->first->child;
159 if (p->synopsisonly) {
161 if (n->tok == MAN_SH &&
162 n->child->child->type == ROFFT_TEXT &&
163 !strcmp(n->child->child->string, "SYNOPSIS")) {
164 if (n->child->next->child != NULL)
165 print_man_nodelist(p, &mt,
166 n->child->next->child,
174 save_defindent = p->defindent;
175 if (p->defindent == 0)
177 term_begin(p, print_man_head, print_man_foot, &man->meta);
178 p->flags |= TERMP_NOSPACE;
180 print_man_nodelist(p, &mt, n, &man->meta);
182 p->defindent = save_defindent;
187 * Printing leading vertical space before a block.
188 * This is used for the paragraph macros.
189 * The rules are pretty simple, since there's very little nesting going
190 * on here. Basically, if we're the first within another block (SS/SH),
191 * then don't emit vertical space. If we are (RS), then do. If not the
195 print_bvspace(struct termp *p, const struct roff_node *n, int pardist)
201 if (n->body && n->body->child)
202 if (n->body->child->type == ROFFT_TBL)
205 if (n->parent->type == ROFFT_ROOT || n->parent->tok != MAN_RS)
209 for (i = 0; i < pardist; i++)
225 term_setwidth(p, n->child != NULL ? n->child->string : NULL);
233 term_fontrepl(p, TERMFONT_UNDER);
238 pre_literal(DECL_ARGS)
243 if (MAN_nf == n->tok || MAN_EX == n->tok)
244 mt->fl |= MANT_LITERAL;
246 mt->fl &= ~MANT_LITERAL;
249 * Unlike .IP and .TP, .HP does not have a HEAD.
250 * So in case a second call to term_flushln() is needed,
251 * indentation has to be set up explicitly.
253 if (MAN_HP == n->parent->tok && p->rmargin < p->maxrmargin) {
254 p->offset = p->rmargin;
255 p->rmargin = p->maxrmargin;
257 p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND);
258 p->flags |= TERMP_NOSPACE;
274 assert(n->type == ROFFT_TEXT);
275 if (a2roffsu(n->string, &su, SCALE_VS))
276 mt->pardist = term_vspan(p, &su);
281 pre_alternate(DECL_ARGS)
283 enum termfont font[2];
284 struct roff_node *nn;
289 font[0] = TERMFONT_NONE;
290 font[1] = TERMFONT_BOLD;
293 font[0] = TERMFONT_NONE;
294 font[1] = TERMFONT_UNDER;
297 font[0] = TERMFONT_BOLD;
298 font[1] = TERMFONT_NONE;
301 font[0] = TERMFONT_BOLD;
302 font[1] = TERMFONT_UNDER;
305 font[0] = TERMFONT_UNDER;
306 font[1] = TERMFONT_NONE;
309 font[0] = TERMFONT_UNDER;
310 font[1] = TERMFONT_BOLD;
316 savelit = MANT_LITERAL & mt->fl;
317 mt->fl &= ~MANT_LITERAL;
319 for (i = 0, nn = n->child; nn; nn = nn->next, i = 1 - i) {
320 term_fontrepl(p, font[i]);
321 if (savelit && NULL == nn->next)
322 mt->fl |= MANT_LITERAL;
323 assert(nn->type == ROFFT_TEXT);
324 term_word(p, nn->string);
325 if (nn->flags & NODE_EOS)
326 p->flags |= TERMP_SENTENCE;
328 p->flags |= TERMP_NOSPACE;
338 term_fontrepl(p, TERMFONT_BOLD);
347 p->flags |= TERMP_NOSPACE;
349 if (NULL != (n = n->child)) {
350 term_fontrepl(p, TERMFONT_BOLD);
351 term_word(p, n->string);
353 if (NULL != n && NULL != n->next) {
354 term_fontrepl(p, TERMFONT_UNDER);
355 term_word(p, n->next->string);
358 term_fontrepl(p, TERMFONT_NONE);
359 p->flags |= TERMP_NOSPACE;
369 if (NULL == n->child) {
374 cp = n->child->string;
379 term_fontrepl(p, TERMFONT_BOLD);
383 term_fontrepl(p, TERMFONT_UNDER);
391 term_fontrepl(p, TERMFONT_NONE);
409 if (NULL == n->child) {
410 p->offset = mt->offset;
414 cp = n->child->string;
424 if ( ! a2roffsu(++cp, &su, SCALE_EN))
427 v = (term_hspan(p, &su) + 11) / 24;
430 p->offset -= p->offset > v ? v : p->offset;
435 if (p->offset > SHRT_MAX)
436 p->offset = term_len(p, p->defindent);
447 if ((NULL == n->prev && n->parent)) {
448 switch (n->parent->tok) {
460 if (n->tok == MAN_br)
462 else if (n->child == NULL)
465 if ( ! a2roffsu(n->child->string, &su, SCALE_VS))
467 len = term_vspan(p, &su);
475 for (i = 0; i < len; i++)
479 * Handle an explicit break request in the same way
480 * as an overflowing line.
483 if (p->flags & TERMP_BRIND) {
484 p->offset = p->rmargin;
485 p->rmargin = p->maxrmargin;
486 p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND);
496 const struct roff_node *nn;
501 print_bvspace(p, n, mt->pardist);
509 if ( ! (MANT_LITERAL & mt->fl)) {
510 p->flags |= TERMP_NOBREAK | TERMP_BRIND;
514 /* Calculate offset. */
516 if ((nn = n->parent->head->child) != NULL &&
517 a2roffsu(nn->string, &su, SCALE_EN)) {
518 len = term_hspan(p, &su) / 24;
519 if (len < 0 && (size_t)(-len) > mt->offset)
521 else if (len > SHRT_MAX)
522 len = term_len(p, p->defindent);
523 mt->lmargin[mt->lmargincur] = len;
525 len = mt->lmargin[mt->lmargincur];
527 p->offset = mt->offset;
528 p->rmargin = mt->offset + len;
541 * Compatibility with a groff bug.
542 * The .HP macro uses the undocumented .tag request
543 * which causes a line break and cancels no-space
544 * mode even if there isn't any output.
547 if (n->child == NULL)
550 p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND);
552 p->offset = mt->offset;
553 p->rmargin = p->maxrmargin;
566 mt->lmargin[mt->lmargincur] = term_len(p, p->defindent);
567 print_bvspace(p, n, mt->pardist);
570 p->offset = mt->offset;
574 return n->type != ROFFT_HEAD;
581 const struct roff_node *nn;
586 p->flags |= TERMP_NOSPACE;
589 p->flags |= TERMP_NOBREAK;
593 print_bvspace(p, n, mt->pardist);
599 /* Calculate the offset from the optional second argument. */
600 if ((nn = n->parent->head->child) != NULL &&
601 (nn = nn->next) != NULL &&
602 a2roffsu(nn->string, &su, SCALE_EN)) {
603 len = term_hspan(p, &su) / 24;
604 if (len < 0 && (size_t)(-len) > mt->offset)
606 else if (len > SHRT_MAX)
607 len = term_len(p, p->defindent);
608 mt->lmargin[mt->lmargincur] = len;
610 len = mt->lmargin[mt->lmargincur];
614 p->offset = mt->offset;
615 p->rmargin = mt->offset + len;
617 savelit = MANT_LITERAL & mt->fl;
618 mt->fl &= ~MANT_LITERAL;
621 print_man_node(p, mt, n->child, meta);
624 mt->fl |= MANT_LITERAL;
628 p->offset = mt->offset + len;
629 p->rmargin = p->maxrmargin;
645 p->flags &= ~TERMP_NOBREAK;
647 p->rmargin = p->maxrmargin;
651 p->offset = mt->offset;
662 struct roff_node *nn;
667 p->flags |= TERMP_NOBREAK | TERMP_BRTRSP;
671 p->flags |= TERMP_NOSPACE;
674 print_bvspace(p, n, mt->pardist);
680 /* Calculate offset. */
682 if ((nn = n->parent->head->child) != NULL &&
683 nn->string != NULL && ! (NODE_LINE & nn->flags) &&
684 a2roffsu(nn->string, &su, SCALE_EN)) {
685 len = term_hspan(p, &su) / 24;
686 if (len < 0 && (size_t)(-len) > mt->offset)
688 else if (len > SHRT_MAX)
689 len = term_len(p, p->defindent);
690 mt->lmargin[mt->lmargincur] = len;
692 len = mt->lmargin[mt->lmargincur];
696 p->offset = mt->offset;
697 p->rmargin = mt->offset + len;
699 savelit = MANT_LITERAL & mt->fl;
700 mt->fl &= ~MANT_LITERAL;
702 /* Don't print same-line elements. */
704 while (NULL != nn && 0 == (NODE_LINE & nn->flags))
708 print_man_node(p, mt, nn, meta);
713 mt->fl |= MANT_LITERAL;
716 p->offset = mt->offset + len;
717 p->rmargin = p->maxrmargin;
719 p->flags &= ~(TERMP_NOBREAK | TERMP_BRTRSP);
738 p->offset = mt->offset;
752 mt->fl &= ~MANT_LITERAL;
753 mt->lmargin[mt->lmargincur] = term_len(p, p->defindent);
754 mt->offset = term_len(p, p->defindent);
757 * No vertical space before the first subsection
758 * and after an empty subsection.
763 } while (n != NULL && n->tok != TOKEN_NONE &&
764 termacts[n->tok].flags & MAN_NOTEXT);
765 if (n == NULL || (n->tok == MAN_SS && n->body->child == NULL))
768 for (i = 0; i < mt->pardist; i++)
772 term_fontrepl(p, TERMFONT_BOLD);
773 p->offset = term_len(p, 3);
774 p->rmargin = mt->offset;
775 p->trailspace = mt->offset;
776 p->flags |= TERMP_NOBREAK | TERMP_BRIND;
779 p->offset = mt->offset;
780 p->rmargin = p->maxrmargin;
782 p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND);
814 mt->fl &= ~MANT_LITERAL;
815 mt->lmargin[mt->lmargincur] = term_len(p, p->defindent);
816 mt->offset = term_len(p, p->defindent);
819 * No vertical space before the first section
820 * and after an empty section.
825 } while (n != NULL && n->tok != TOKEN_NONE &&
826 termacts[n->tok].flags & MAN_NOTEXT);
827 if (n == NULL || (n->tok == MAN_SH && n->body->child == NULL))
830 for (i = 0; i < mt->pardist; i++)
834 term_fontrepl(p, TERMFONT_BOLD);
836 p->rmargin = mt->offset;
837 p->trailspace = mt->offset;
838 p->flags |= TERMP_NOBREAK | TERMP_BRIND;
841 p->offset = mt->offset;
842 p->rmargin = p->maxrmargin;
844 p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND);
885 n->aux = SHRT_MAX + 1;
886 if (n->child == NULL)
887 n->aux = mt->lmargin[mt->lmargincur];
888 else if (a2roffsu(n->child->string, &su, SCALE_EN))
889 n->aux = term_hspan(p, &su) / 24;
890 if (n->aux < 0 && (size_t)(-n->aux) > mt->offset)
891 n->aux = -mt->offset;
892 else if (n->aux > SHRT_MAX)
893 n->aux = term_len(p, p->defindent);
895 mt->offset += n->aux;
896 p->offset = mt->offset;
897 p->rmargin = p->maxrmargin;
899 if (++mt->lmarginsz < MAXMARGINS)
900 mt->lmargincur = mt->lmarginsz;
902 mt->lmargin[mt->lmargincur] = term_len(p, p->defindent);
920 mt->offset -= n->parent->head->aux;
921 p->offset = mt->offset;
923 if (--mt->lmarginsz < MAXMARGINS)
924 mt->lmargincur = mt->lmarginsz;
931 return n->type != ROFFT_HEAD;
938 if (n->type != ROFFT_BLOCK)
942 p->flags |= TERMP_NOSPACE;
944 if (NULL != n->child->child)
945 print_man_node(p, mt, n->child->child, meta);
947 p->flags |= TERMP_NOSPACE;
952 print_man_node(DECL_ARGS)
960 * If we have a blank line, output a vertical space.
961 * If we have a space as the first character, break
962 * before printing the line's data.
964 if ('\0' == *n->string) {
967 } else if (' ' == *n->string && NODE_LINE & n->flags)
970 term_word(p, n->string);
974 if ( ! (n->flags & NODE_LINE))
975 p->flags |= TERMP_NOSPACE;
977 if (n->next != NULL && ! (n->next->flags & NODE_LINE))
978 p->flags |= TERMP_NOSPACE;
981 if (p->tbl.cols == NULL)
983 term_tbl(p, n->span);
989 if ( ! (MAN_NOTEXT & termacts[n->tok].flags))
990 term_fontrepl(p, TERMFONT_NONE);
993 if (termacts[n->tok].pre)
994 c = (*termacts[n->tok].pre)(p, mt, n, meta);
997 print_man_nodelist(p, mt, n->child, meta);
999 if (termacts[n->tok].post)
1000 (*termacts[n->tok].post)(p, mt, n, meta);
1001 if ( ! (MAN_NOTEXT & termacts[n->tok].flags))
1002 term_fontrepl(p, TERMFONT_NONE);
1006 * If we're in a literal context, make sure that words
1007 * together on the same line stay together. This is a
1008 * POST-printing call, so we check the NEXT word. Since
1009 * -man doesn't have nested macros, we don't need to be
1010 * more specific than this.
1012 if (mt->fl & MANT_LITERAL &&
1013 ! (p->flags & (TERMP_NOBREAK | TERMP_NONEWLINE)) &&
1014 (n->next == NULL || n->next->flags & NODE_LINE)) {
1016 rmax = p->maxrmargin;
1017 p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
1018 p->flags |= TERMP_NOSPACE;
1019 if (n->string != NULL && *n->string != '\0')
1023 if (rm < rmax && n->parent->tok == MAN_HP) {
1028 p->maxrmargin = rmax;
1030 if (NODE_EOS & n->flags)
1031 p->flags |= TERMP_SENTENCE;
1036 print_man_nodelist(DECL_ARGS)
1040 print_man_node(p, mt, n, meta);
1046 print_man_foot(struct termp *p, const struct roff_meta *meta)
1049 size_t datelen, titlen;
1051 assert(meta->title);
1055 term_fontrepl(p, TERMFONT_NONE);
1061 * Temporary, undocumented option to imitate mdoc(7) output.
1062 * In the bottom right corner, use the operating system
1063 * instead of the title.
1066 if ( ! p->mdocstyle) {
1067 if (meta->hasbody) {
1071 mandoc_asprintf(&title, "%s(%s)",
1072 meta->title, meta->msec);
1073 } else if (meta->os) {
1074 title = mandoc_strdup(meta->os);
1076 title = mandoc_strdup("");
1078 datelen = term_strlen(p, meta->date);
1080 /* Bottom left corner: operating system. */
1082 p->flags |= TERMP_NOSPACE | TERMP_NOBREAK;
1085 p->rmargin = p->maxrmargin > datelen ?
1086 (p->maxrmargin + term_len(p, 1) - datelen) / 2 : 0;
1089 term_word(p, meta->os);
1092 /* At the bottom in the middle: manual date. */
1094 p->offset = p->rmargin;
1095 titlen = term_strlen(p, title);
1096 p->rmargin = p->maxrmargin > titlen ? p->maxrmargin - titlen : 0;
1097 p->flags |= TERMP_NOSPACE;
1099 term_word(p, meta->date);
1102 /* Bottom right corner: manual title and section. */
1104 p->flags &= ~TERMP_NOBREAK;
1105 p->flags |= TERMP_NOSPACE;
1107 p->offset = p->rmargin;
1108 p->rmargin = p->maxrmargin;
1110 term_word(p, title);
1116 print_man_head(struct termp *p, const struct roff_meta *meta)
1120 size_t vollen, titlen;
1122 assert(meta->title);
1125 volume = NULL == meta->vol ? "" : meta->vol;
1126 vollen = term_strlen(p, volume);
1128 /* Top left corner: manual title and section. */
1130 mandoc_asprintf(&title, "%s(%s)", meta->title, meta->msec);
1131 titlen = term_strlen(p, title);
1133 p->flags |= TERMP_NOBREAK | TERMP_NOSPACE;
1136 p->rmargin = 2 * (titlen+1) + vollen < p->maxrmargin ?
1137 (p->maxrmargin - vollen + term_len(p, 1)) / 2 :
1138 vollen < p->maxrmargin ? p->maxrmargin - vollen : 0;
1140 term_word(p, title);
1143 /* At the top in the middle: manual volume. */
1145 p->flags |= TERMP_NOSPACE;
1146 p->offset = p->rmargin;
1147 p->rmargin = p->offset + vollen + titlen < p->maxrmargin ?
1148 p->maxrmargin - titlen : p->maxrmargin;
1150 term_word(p, volume);
1153 /* Top right corner: title and section, again. */
1155 p->flags &= ~TERMP_NOBREAK;
1157 if (p->rmargin + titlen <= p->maxrmargin) {
1158 p->flags |= TERMP_NOSPACE;
1159 p->offset = p->rmargin;
1160 p->rmargin = p->maxrmargin;
1161 term_word(p, title);
1165 p->flags &= ~TERMP_NOSPACE;
1167 p->rmargin = p->maxrmargin;
1170 * Groff prints three blank lines before the content.
1171 * Do the same, except in the temporary, undocumented
1172 * mode imitating mdoc(7) output.
1176 if ( ! p->mdocstyle) {