1 /* $Id: man_term.c,v 1.109 2011/05/17 14:38:34 kristaps Exp $ */
3 * Copyright (c) 2008, 2009, 2010, 2011 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>
39 /* FIXME: have PD set the default vspace width. */
43 #define MANT_LITERAL (1 << 0)
45 * Default amount to indent the left margin after leading text
46 * has been printed (e.g., `HP' left-indent, `TP' and `IP' body
47 * indent). This needs to be saved because `HP' and so on, if
48 * not having a specified value, must default.
50 * Note that this is the indentation AFTER the left offset, so
51 * the total offset is usually offset + lmargin.
55 * The default offset, i.e., the amount between any text and the
61 #define DECL_ARGS struct termp *p, \
63 const struct man_node *n, \
64 const struct man_meta *m
67 int (*pre)(DECL_ARGS);
68 void (*post)(DECL_ARGS);
70 #define MAN_NOTEXT (1 << 0) /* Never has text children. */
73 static int a2width(const struct termp *, const char *);
74 static size_t a2height(const struct termp *, const char *);
76 static void print_man_nodelist(DECL_ARGS);
77 static void print_man_node(DECL_ARGS);
78 static void print_man_head(struct termp *, const void *);
79 static void print_man_foot(struct termp *, const void *);
80 static void print_bvspace(struct termp *,
81 const struct man_node *);
83 static int pre_alternate(DECL_ARGS);
84 static int pre_B(DECL_ARGS);
85 static int pre_HP(DECL_ARGS);
86 static int pre_I(DECL_ARGS);
87 static int pre_IP(DECL_ARGS);
88 static int pre_PP(DECL_ARGS);
89 static int pre_RS(DECL_ARGS);
90 static int pre_SH(DECL_ARGS);
91 static int pre_SS(DECL_ARGS);
92 static int pre_TP(DECL_ARGS);
93 static int pre_ign(DECL_ARGS);
94 static int pre_in(DECL_ARGS);
95 static int pre_literal(DECL_ARGS);
96 static int pre_sp(DECL_ARGS);
97 static int pre_ft(DECL_ARGS);
99 static void post_IP(DECL_ARGS);
100 static void post_HP(DECL_ARGS);
101 static void post_RS(DECL_ARGS);
102 static void post_SH(DECL_ARGS);
103 static void post_SS(DECL_ARGS);
104 static void post_TP(DECL_ARGS);
106 static const struct termact termacts[MAN_MAX] = {
107 { pre_sp, NULL, MAN_NOTEXT }, /* br */
108 { NULL, NULL, 0 }, /* TH */
109 { pre_SH, post_SH, 0 }, /* SH */
110 { pre_SS, post_SS, 0 }, /* SS */
111 { pre_TP, post_TP, 0 }, /* TP */
112 { pre_PP, NULL, 0 }, /* LP */
113 { pre_PP, NULL, 0 }, /* PP */
114 { pre_PP, NULL, 0 }, /* P */
115 { pre_IP, post_IP, 0 }, /* IP */
116 { pre_HP, post_HP, 0 }, /* HP */
117 { NULL, NULL, 0 }, /* SM */
118 { pre_B, NULL, 0 }, /* SB */
119 { pre_alternate, NULL, 0 }, /* BI */
120 { pre_alternate, NULL, 0 }, /* IB */
121 { pre_alternate, NULL, 0 }, /* BR */
122 { pre_alternate, NULL, 0 }, /* RB */
123 { NULL, NULL, 0 }, /* R */
124 { pre_B, NULL, 0 }, /* B */
125 { pre_I, NULL, 0 }, /* I */
126 { pre_alternate, NULL, 0 }, /* IR */
127 { pre_alternate, NULL, 0 }, /* RI */
128 { pre_ign, NULL, MAN_NOTEXT }, /* na */
129 { pre_sp, NULL, MAN_NOTEXT }, /* sp */
130 { pre_literal, NULL, 0 }, /* nf */
131 { pre_literal, NULL, 0 }, /* fi */
132 { NULL, NULL, 0 }, /* RE */
133 { pre_RS, post_RS, 0 }, /* RS */
134 { pre_ign, NULL, 0 }, /* DT */
135 { pre_ign, NULL, 0 }, /* UC */
136 { pre_ign, NULL, 0 }, /* PD */
137 { pre_ign, NULL, 0 }, /* AT */
138 { pre_in, NULL, MAN_NOTEXT }, /* in */
139 { pre_ft, NULL, MAN_NOTEXT }, /* ft */
145 terminal_man(void *arg, const struct man *man)
148 const struct man_node *n;
149 const struct man_meta *m;
152 p = (struct termp *)arg;
155 p->maxrmargin = p->defrmargin;
156 p->tabwidth = term_len(p, 5);
158 if (NULL == p->symtab)
159 p->symtab = mchars_alloc();
164 term_begin(p, print_man_head, print_man_foot, m);
165 p->flags |= TERMP_NOSPACE;
168 mt.lmargin = term_len(p, INDENT);
169 mt.offset = term_len(p, INDENT);
172 print_man_nodelist(p, &mt, n->child, m);
179 a2height(const struct termp *p, const char *cp)
183 if ( ! a2roffsu(cp, &su, SCALE_VS))
184 SCALE_VS_INIT(&su, term_strlen(p, cp));
186 return(term_vspan(p, &su));
191 a2width(const struct termp *p, const char *cp)
195 if ( ! a2roffsu(cp, &su, SCALE_BU))
198 return((int)term_hspan(p, &su));
203 print_bvspace(struct termp *p, const struct man_node *n)
207 if (n->body && n->body->child && MAN_TBL == n->body->child->type)
213 if (MAN_SS == n->prev->tok)
215 if (MAN_SH == n->prev->tok)
236 term_fontrepl(p, TERMFONT_UNDER);
243 pre_literal(DECL_ARGS)
248 if (MAN_nf == n->tok)
249 mt->fl |= MANT_LITERAL;
251 mt->fl &= ~MANT_LITERAL;
258 pre_alternate(DECL_ARGS)
260 enum termfont font[2];
261 const struct man_node *nn;
266 font[0] = TERMFONT_NONE;
267 font[1] = TERMFONT_BOLD;
270 font[0] = TERMFONT_NONE;
271 font[1] = TERMFONT_UNDER;
274 font[0] = TERMFONT_BOLD;
275 font[1] = TERMFONT_NONE;
278 font[0] = TERMFONT_BOLD;
279 font[1] = TERMFONT_UNDER;
282 font[0] = TERMFONT_UNDER;
283 font[1] = TERMFONT_NONE;
286 font[0] = TERMFONT_UNDER;
287 font[1] = TERMFONT_BOLD;
293 savelit = MANT_LITERAL & mt->fl;
294 mt->fl &= ~MANT_LITERAL;
296 for (i = 0, nn = n->child; nn; nn = nn->next, i = 1 - i) {
297 term_fontrepl(p, font[i]);
298 if (savelit && NULL == nn->next)
299 mt->fl |= MANT_LITERAL;
300 print_man_node(p, mt, nn, m);
302 p->flags |= TERMP_NOSPACE;
313 term_fontrepl(p, TERMFONT_BOLD);
323 if (NULL == n->child) {
328 cp = n->child->string;
335 term_fontrepl(p, TERMFONT_BOLD);
340 term_fontrepl(p, TERMFONT_UNDER);
350 term_fontrepl(p, TERMFONT_NONE);
368 if (NULL == n->child) {
369 p->offset = mt->offset;
373 cp = n->child->string;
383 if ((len = a2width(p, ++cp)) < 0)
389 p->offset -= p->offset > v ? v : p->offset;
395 /* Don't let this creep beyond the right margin. */
397 if (p->offset > p->rmargin)
398 p->offset = p->rmargin;
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)
856 * If we have a blank line, output a vertical space.
857 * If we have a space as the first character, break
858 * before printing the line's data.
860 if ('\0' == *n->string) {
863 } else if (' ' == *n->string && MAN_LINE & n->flags)
866 term_word(p, n->string);
869 * If we're in a literal context, make sure that words
870 * togehter on the same line stay together. This is a
871 * POST-printing call, so we check the NEXT word. Since
872 * -man doesn't have nested macros, we don't need to be
873 * more specific than this.
875 if (MANT_LITERAL & mt->fl &&
877 n->next->line > n->line)) {
879 rmax = p->maxrmargin;
880 p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
881 p->flags |= TERMP_NOSPACE;
883 p->flags &= ~TERMP_NOLPAD;
885 p->maxrmargin = rmax;
888 if (MAN_EOS & n->flags)
889 p->flags |= TERMP_SENTENCE;
892 term_word(p, n->eqn->data);
896 * Tables are preceded by a newline. Then process a
897 * table line, which will cause line termination,
899 if (TBL_SPAN_FIRST & n->span->flags)
901 term_tbl(p, n->span);
907 if ( ! (MAN_NOTEXT & termacts[n->tok].flags))
908 term_fontrepl(p, TERMFONT_NONE);
911 if (termacts[n->tok].pre)
912 c = (*termacts[n->tok].pre)(p, mt, n, m);
915 print_man_nodelist(p, mt, n->child, m);
917 if (termacts[n->tok].post)
918 (*termacts[n->tok].post)(p, mt, n, m);
919 if ( ! (MAN_NOTEXT & termacts[n->tok].flags))
920 term_fontrepl(p, TERMFONT_NONE);
922 if (MAN_EOS & n->flags)
923 p->flags |= TERMP_SENTENCE;
928 print_man_nodelist(DECL_ARGS)
931 print_man_node(p, mt, n, m);
934 print_man_nodelist(p, mt, n->next, m);
939 print_man_foot(struct termp *p, const void *arg)
941 const struct man_meta *meta;
943 meta = (const struct man_meta *)arg;
945 term_fontrepl(p, TERMFONT_NONE);
951 p->flags |= TERMP_NOSPACE | TERMP_NOBREAK;
952 p->rmargin = p->maxrmargin - term_strlen(p, meta->date);
955 /* term_strlen() can return zero. */
956 if (p->rmargin == p->maxrmargin)
960 term_word(p, meta->source);
965 p->flags |= TERMP_NOLPAD | TERMP_NOSPACE;
966 p->offset = p->rmargin;
967 p->rmargin = p->maxrmargin;
968 p->flags &= ~TERMP_NOBREAK;
970 term_word(p, meta->date);
976 print_man_head(struct termp *p, const void *arg)
978 char buf[BUFSIZ], title[BUFSIZ];
979 size_t buflen, titlen;
980 const struct man_meta *m;
982 m = (const struct man_meta *)arg;
985 * Note that old groff would spit out some spaces before the
986 * header. We discontinue this strange behaviour, but at one
987 * point we did so here.
990 p->rmargin = p->maxrmargin;
993 buf[0] = title[0] = '\0';
996 strlcpy(buf, m->vol, BUFSIZ);
997 buflen = term_strlen(p, buf);
999 snprintf(title, BUFSIZ, "%s(%s)", m->title, m->msec);
1000 titlen = term_strlen(p, title);
1003 p->rmargin = 2 * (titlen+1) + buflen < p->maxrmargin ?
1005 term_strlen(p, buf) + term_len(p, 1)) / 2 :
1006 p->maxrmargin - buflen;
1007 p->flags |= TERMP_NOBREAK | TERMP_NOSPACE;
1009 term_word(p, title);
1012 p->flags |= TERMP_NOLPAD | TERMP_NOSPACE;
1013 p->offset = p->rmargin;
1014 p->rmargin = p->offset + buflen + titlen < p->maxrmargin ?
1015 p->maxrmargin - titlen : p->maxrmargin;
1020 p->flags &= ~TERMP_NOBREAK;
1021 if (p->rmargin + titlen <= p->maxrmargin) {
1022 p->flags |= TERMP_NOLPAD | TERMP_NOSPACE;
1023 p->offset = p->rmargin;
1024 p->rmargin = p->maxrmargin;
1025 term_word(p, title);
1029 p->rmargin = p->maxrmargin;
1031 p->flags &= ~TERMP_NOSPACE;
1034 * Groff likes to have some leading spaces before content. Well
1035 * that's fine by me.