1 /* $Id: man_term.c,v 1.94 2011/01/04 01:23:18 schwarze Exp $ */
3 * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2010, 2011 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 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.
22 #include <sys/types.h>
40 /* FIXME: have PD set the default vspace width. */
44 #define MANT_LITERAL (1 << 0)
46 * Default amount to indent the left margin after leading text
47 * has been printed (e.g., `HP' left-indent, `TP' and `IP' body
48 * indent). This needs to be saved because `HP' and so on, if
49 * not having a specified value, must default.
51 * Note that this is the indentation AFTER the left offset, so
52 * the total offset is usually offset + lmargin.
56 * The default offset, i.e., the amount between any text and the
62 #define DECL_ARGS struct termp *p, \
64 const struct man_node *n, \
65 const struct man_meta *m
68 int (*pre)(DECL_ARGS);
69 void (*post)(DECL_ARGS);
71 #define MAN_NOTEXT (1 << 0) /* Never has text children. */
74 static int a2width(const struct termp *, const char *);
75 static size_t a2height(const struct termp *, const char *);
77 static void print_man_nodelist(DECL_ARGS);
78 static void print_man_node(DECL_ARGS);
79 static void print_man_head(struct termp *, const void *);
80 static void print_man_foot(struct termp *, const void *);
81 static void print_bvspace(struct termp *,
82 const struct man_node *);
84 static int pre_alternate(DECL_ARGS);
85 static int pre_B(DECL_ARGS);
86 static int pre_HP(DECL_ARGS);
87 static int pre_I(DECL_ARGS);
88 static int pre_IP(DECL_ARGS);
89 static int pre_PP(DECL_ARGS);
90 static int pre_RS(DECL_ARGS);
91 static int pre_SH(DECL_ARGS);
92 static int pre_SS(DECL_ARGS);
93 static int pre_TP(DECL_ARGS);
94 static int pre_ign(DECL_ARGS);
95 static int pre_in(DECL_ARGS);
96 static int pre_literal(DECL_ARGS);
97 static int pre_sp(DECL_ARGS);
98 static int pre_ft(DECL_ARGS);
100 static void post_IP(DECL_ARGS);
101 static void post_HP(DECL_ARGS);
102 static void post_RS(DECL_ARGS);
103 static void post_SH(DECL_ARGS);
104 static void post_SS(DECL_ARGS);
105 static void post_TP(DECL_ARGS);
107 static const struct termact termacts[MAN_MAX] = {
108 { pre_sp, NULL, MAN_NOTEXT }, /* br */
109 { NULL, NULL, 0 }, /* TH */
110 { pre_SH, post_SH, 0 }, /* SH */
111 { pre_SS, post_SS, 0 }, /* SS */
112 { pre_TP, post_TP, 0 }, /* TP */
113 { pre_PP, NULL, 0 }, /* LP */
114 { pre_PP, NULL, 0 }, /* PP */
115 { pre_PP, NULL, 0 }, /* P */
116 { pre_IP, post_IP, 0 }, /* IP */
117 { pre_HP, post_HP, 0 }, /* HP */
118 { NULL, NULL, 0 }, /* SM */
119 { pre_B, NULL, 0 }, /* SB */
120 { pre_alternate, NULL, 0 }, /* BI */
121 { pre_alternate, NULL, 0 }, /* IB */
122 { pre_alternate, NULL, 0 }, /* BR */
123 { pre_alternate, NULL, 0 }, /* RB */
124 { NULL, NULL, 0 }, /* R */
125 { pre_B, NULL, 0 }, /* B */
126 { pre_I, NULL, 0 }, /* I */
127 { pre_alternate, NULL, 0 }, /* IR */
128 { pre_alternate, NULL, 0 }, /* RI */
129 { NULL, NULL, MAN_NOTEXT }, /* na */
130 { pre_sp, NULL, MAN_NOTEXT }, /* sp */
131 { pre_literal, NULL, 0 }, /* nf */
132 { pre_literal, NULL, 0 }, /* fi */
133 { NULL, NULL, 0 }, /* RE */
134 { pre_RS, post_RS, 0 }, /* RS */
135 { pre_ign, NULL, 0 }, /* DT */
136 { pre_ign, NULL, 0 }, /* UC */
137 { pre_ign, NULL, 0 }, /* PD */
138 { pre_ign, NULL, 0 }, /* AT */
139 { pre_in, NULL, MAN_NOTEXT }, /* in */
140 { pre_ft, NULL, MAN_NOTEXT }, /* ft */
146 terminal_man(void *arg, const struct man *man)
149 const struct man_node *n;
150 const struct man_meta *m;
153 p = (struct termp *)arg;
156 p->maxrmargin = p->defrmargin;
157 p->tabwidth = term_len(p, 5);
159 if (NULL == p->symtab)
161 case (TERMENC_ASCII):
162 p->symtab = chars_init(CHARS_ASCII);
172 term_begin(p, print_man_head, print_man_foot, m);
173 p->flags |= TERMP_NOSPACE;
176 mt.lmargin = term_len(p, INDENT);
177 mt.offset = term_len(p, INDENT);
180 print_man_nodelist(p, &mt, n->child, m);
187 a2height(const struct termp *p, const char *cp)
191 if ( ! a2roffsu(cp, &su, SCALE_VS))
192 SCALE_VS_INIT(&su, term_strlen(p, cp));
194 return(term_vspan(p, &su));
199 a2width(const struct termp *p, const char *cp)
203 if ( ! a2roffsu(cp, &su, SCALE_BU))
206 return((int)term_hspan(p, &su));
211 print_bvspace(struct termp *p, const struct man_node *n)
218 if (MAN_SS == n->prev->tok)
220 if (MAN_SH == n->prev->tok)
241 term_fontrepl(p, TERMFONT_UNDER);
248 pre_literal(DECL_ARGS)
253 if (MAN_nf == n->tok)
254 mt->fl |= MANT_LITERAL;
256 mt->fl &= ~MANT_LITERAL;
263 pre_alternate(DECL_ARGS)
265 enum termfont font[2];
266 const struct man_node *nn;
271 font[0] = TERMFONT_NONE;
272 font[1] = TERMFONT_BOLD;
275 font[0] = TERMFONT_NONE;
276 font[1] = TERMFONT_UNDER;
279 font[0] = TERMFONT_BOLD;
280 font[1] = TERMFONT_NONE;
283 font[0] = TERMFONT_BOLD;
284 font[1] = TERMFONT_UNDER;
287 font[0] = TERMFONT_UNDER;
288 font[1] = TERMFONT_NONE;
291 font[0] = TERMFONT_UNDER;
292 font[1] = TERMFONT_BOLD;
298 savelit = MANT_LITERAL & mt->fl;
299 mt->fl &= ~MANT_LITERAL;
301 for (i = 0, nn = n->child; nn; nn = nn->next, i = 1 - i) {
302 term_fontrepl(p, font[i]);
303 if (savelit && NULL == nn->next)
304 mt->fl |= MANT_LITERAL;
305 print_man_node(p, mt, nn, m);
307 p->flags |= TERMP_NOSPACE;
318 term_fontrepl(p, TERMFONT_BOLD);
328 if (NULL == n->child) {
333 cp = n->child->string;
340 term_fontrepl(p, TERMFONT_BOLD);
345 term_fontrepl(p, TERMFONT_UNDER);
355 term_fontrepl(p, TERMFONT_NONE);
373 if (NULL == n->child) {
374 p->offset = mt->offset;
378 cp = n->child->string;
388 if ((len = a2width(p, ++cp)) < 0)
394 p->offset -= p->offset > v ? v : p->offset;
415 len = n->child ? a2height(p, n->child->string) : 1;
421 for (i = 0; i < len; i++)
434 const struct man_node *nn;
441 p->flags |= TERMP_NOBREAK;
442 p->flags |= TERMP_TWOSPACE;
451 /* Calculate offset. */
453 if (NULL != (nn = n->parent->head->child))
454 if ((ival = a2width(p, nn->string)) >= 0)
458 len = term_len(p, 1);
460 p->offset = mt->offset;
461 p->rmargin = mt->offset + len;
464 mt->lmargin = (size_t)ival;
481 p->flags &= ~TERMP_NOBREAK;
482 p->flags &= ~TERMP_TWOSPACE;
483 p->offset = mt->offset;
484 p->rmargin = p->maxrmargin;
499 mt->lmargin = term_len(p, INDENT);
503 p->offset = mt->offset;
507 return(MAN_HEAD != n->type);
515 const struct man_node *nn;
521 p->flags |= TERMP_NOLPAD;
522 p->flags |= TERMP_NOSPACE;
525 p->flags |= TERMP_NOBREAK;
537 /* Calculate the offset from the optional second argument. */
538 if (NULL != (nn = n->parent->head->child))
539 if (NULL != (nn = nn->next))
540 if ((ival = a2width(p, nn->string)) >= 0)
545 /* Handle zero-width lengths. */
547 len = term_len(p, 1);
549 p->offset = mt->offset;
550 p->rmargin = mt->offset + len;
554 /* Set the saved left-margin. */
555 mt->lmargin = (size_t)ival;
557 savelit = MANT_LITERAL & mt->fl;
558 mt->fl &= ~MANT_LITERAL;
561 print_man_node(p, mt, n->child, m);
564 mt->fl |= MANT_LITERAL;
568 p->offset = mt->offset + len;
569 p->rmargin = p->maxrmargin;
587 p->flags &= ~TERMP_NOBREAK;
588 p->rmargin = p->maxrmargin;
592 p->flags &= ~TERMP_NOLPAD;
604 const struct man_node *nn;
610 p->flags |= TERMP_NOBREAK;
613 p->flags |= TERMP_NOLPAD;
614 p->flags |= TERMP_NOSPACE;
623 len = (size_t)mt->lmargin;
626 /* Calculate offset. */
628 if (NULL != (nn = n->parent->head->child)) {
629 while (nn && MAN_TEXT != nn->type)
632 if ((ival = a2width(p, nn->string)) >= 0)
638 /* Handle zero-length properly. */
640 len = term_len(p, 1);
642 p->offset = mt->offset;
643 p->rmargin = mt->offset + len;
645 savelit = MANT_LITERAL & mt->fl;
646 mt->fl &= ~MANT_LITERAL;
648 /* Don't print same-line elements. */
649 for (nn = n->child; nn; nn = nn->next)
650 if (nn->line > n->line)
651 print_man_node(p, mt, nn, m);
654 mt->fl |= MANT_LITERAL;
657 mt->lmargin = (size_t)ival;
661 p->offset = mt->offset + len;
662 p->rmargin = p->maxrmargin;
680 p->flags &= ~TERMP_NOBREAK;
681 p->flags &= ~TERMP_TWOSPACE;
682 p->rmargin = p->maxrmargin;
686 p->flags &= ~TERMP_NOLPAD;
701 mt->lmargin = term_len(p, INDENT);
702 mt->offset = term_len(p, INDENT);
703 /* If following a prior empty `SS', no vspace. */
704 if (n->prev && MAN_SS == n->prev->tok)
705 if (NULL == n->prev->body->child)
712 term_fontrepl(p, TERMFONT_BOLD);
713 p->offset = term_len(p, HALFINDENT);
716 p->offset = mt->offset;
751 mt->lmargin = term_len(p, INDENT);
752 mt->offset = term_len(p, INDENT);
753 /* If following a prior empty `SH', no vspace. */
754 if (n->prev && MAN_SH == n->prev->tok)
755 if (NULL == n->prev->body->child)
757 /* If the first macro, no vspae. */
763 term_fontrepl(p, TERMFONT_BOLD);
767 p->offset = mt->offset;
799 const struct man_node *nn;
812 if (NULL == (nn = n->parent->head->child)) {
813 mt->offset = mt->lmargin + term_len(p, INDENT);
814 p->offset = mt->offset;
818 if ((ival = a2width(p, nn->string)) < 0)
821 mt->offset = term_len(p, INDENT) + (size_t)ival;
822 p->offset = mt->offset;
835 mt->offset = mt->lmargin = term_len(p, INDENT);
841 p->offset = term_len(p, INDENT);
848 print_man_node(DECL_ARGS)
857 if (0 == *n->string) {
862 term_word(p, n->string);
864 /* FIXME: this means that macro lines are munged! */
866 if (MANT_LITERAL & mt->fl) {
868 rmax = p->maxrmargin;
869 p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
870 p->flags |= TERMP_NOSPACE;
872 p->flags &= ~TERMP_NOLPAD;
874 p->maxrmargin = rmax;
878 if (TBL_SPAN_FIRST & n->span->flags)
880 term_tbl(p, n->span);
883 if ( ! (MAN_NOTEXT & termacts[n->tok].flags))
884 term_fontrepl(p, TERMFONT_NONE);
885 if (termacts[n->tok].pre)
886 c = (*termacts[n->tok].pre)(p, mt, n, m);
891 print_man_nodelist(p, mt, n->child, m);
899 if (termacts[n->tok].post)
900 (*termacts[n->tok].post)(p, mt, n, m);
901 if ( ! (MAN_NOTEXT & termacts[n->tok].flags))
902 term_fontrepl(p, TERMFONT_NONE);
906 if (MAN_EOS & n->flags)
907 p->flags |= TERMP_SENTENCE;
912 print_man_nodelist(DECL_ARGS)
915 print_man_node(p, mt, n, m);
918 print_man_nodelist(p, mt, n->next, m);
923 print_man_foot(struct termp *p, const void *arg)
926 const struct man_meta *meta;
928 meta = (const struct man_meta *)arg;
930 term_fontrepl(p, TERMFONT_NONE);
933 strlcpy(buf, meta->rawdate, DATESIZ);
935 time2a(meta->date, buf, DATESIZ);
941 p->flags |= TERMP_NOSPACE | TERMP_NOBREAK;
942 p->rmargin = p->maxrmargin - term_strlen(p, buf);
945 /* term_strlen() can return zero. */
946 if (p->rmargin == p->maxrmargin)
950 term_word(p, meta->source);
955 p->flags |= TERMP_NOLPAD | TERMP_NOSPACE;
956 p->offset = p->rmargin;
957 p->rmargin = p->maxrmargin;
958 p->flags &= ~TERMP_NOBREAK;
966 print_man_head(struct termp *p, const void *arg)
968 char buf[BUFSIZ], title[BUFSIZ];
969 size_t buflen, titlen;
970 const struct man_meta *m;
972 m = (const struct man_meta *)arg;
975 * Note that old groff would spit out some spaces before the
976 * header. We discontinue this strange behaviour, but at one
977 * point we did so here.
980 p->rmargin = p->maxrmargin;
983 buf[0] = title[0] = '\0';
986 strlcpy(buf, m->vol, BUFSIZ);
987 buflen = term_strlen(p, buf);
989 snprintf(title, BUFSIZ, "%s(%s)", m->title, m->msec);
990 titlen = term_strlen(p, title);
993 p->rmargin = 2 * (titlen+1) + buflen < p->maxrmargin ?
995 term_strlen(p, buf) + term_len(p, 1)) / 2 :
996 p->maxrmargin - buflen;
997 p->flags |= TERMP_NOBREAK | TERMP_NOSPACE;
1002 p->flags |= TERMP_NOLPAD | TERMP_NOSPACE;
1003 p->offset = p->rmargin;
1004 p->rmargin = p->offset + buflen + titlen < p->maxrmargin ?
1005 p->maxrmargin - titlen : p->maxrmargin;
1010 p->flags &= ~TERMP_NOBREAK;
1011 if (p->rmargin + titlen <= p->maxrmargin) {
1012 p->flags |= TERMP_NOLPAD | TERMP_NOSPACE;
1013 p->offset = p->rmargin;
1014 p->rmargin = p->maxrmargin;
1015 term_word(p, title);
1019 p->rmargin = p->maxrmargin;
1021 p->flags &= ~TERMP_NOSPACE;
1024 * Groff likes to have some leading spaces before content. Well
1025 * that's fine by me.