=================================================================== RCS file: /cvs/mandoc/man_term.c,v retrieving revision 1.51 retrieving revision 1.79 diff -u -p -r1.51 -r1.79 --- mandoc/man_term.c 2009/11/10 12:03:30 1.51 +++ mandoc/man_term.c 2010/07/07 15:04:54 1.79 @@ -1,6 +1,6 @@ -/* $Id: man_term.c,v 1.51 2009/11/10 12:03:30 kristaps Exp $ */ +/* $Id: man_term.c,v 1.79 2010/07/07 15:04:54 kristaps Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * Copyright (c) 2008, 2009 Kristaps Dzonsons * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -14,6 +14,10 @@ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ +#ifdef HAVE_CONFIG_H +#include "config.h" +#endif + #include #include @@ -22,6 +26,7 @@ #include #include +#include "mandoc.h" #include "out.h" #include "man.h" #include "term.h" @@ -61,22 +66,17 @@ struct mtermp { struct termact { int (*pre)(DECL_ARGS); void (*post)(DECL_ARGS); + int flags; +#define MAN_NOTEXT (1 << 0) /* Never has text children. */ }; -#ifdef __linux__ -extern size_t strlcpy(char *, const char *, size_t); -extern size_t strlcat(char *, const char *, size_t); -#endif +static int a2width(const struct termp *, const char *); +static size_t a2height(const struct termp *, const char *); -static int a2width(const struct man_node *); -static int a2height(const struct man_node *); - -static void print_man_head(struct termp *, - const struct man_meta *); -static void print_man_body(DECL_ARGS); +static void print_man_nodelist(DECL_ARGS); static void print_man_node(DECL_ARGS); -static void print_man_foot(struct termp *, - const struct man_meta *); +static void print_man_head(struct termp *, const void *); +static void print_man_foot(struct termp *, const void *); static void print_bvspace(struct termp *, const struct man_node *); @@ -96,52 +96,52 @@ static int pre_br(DECL_ARGS); static int pre_fi(DECL_ARGS); static int pre_ign(DECL_ARGS); static int pre_nf(DECL_ARGS); -static int pre_r(DECL_ARGS); static int pre_sp(DECL_ARGS); -static void post_B(DECL_ARGS); -static void post_I(DECL_ARGS); static void post_IP(DECL_ARGS); static void post_HP(DECL_ARGS); static void post_RS(DECL_ARGS); static void post_SH(DECL_ARGS); static void post_SS(DECL_ARGS); static void post_TP(DECL_ARGS); -static void post_i(DECL_ARGS); static const struct termact termacts[MAN_MAX] = { - { pre_br, NULL }, /* br */ - { NULL, NULL }, /* TH */ - { pre_SH, post_SH }, /* SH */ - { pre_SS, post_SS }, /* SS */ - { pre_TP, post_TP }, /* TP */ - { pre_PP, NULL }, /* LP */ - { pre_PP, NULL }, /* PP */ - { pre_PP, NULL }, /* P */ - { pre_IP, post_IP }, /* IP */ - { pre_HP, post_HP }, /* HP */ - { NULL, NULL }, /* SM */ - { pre_B, post_B }, /* SB */ - { pre_BI, NULL }, /* BI */ - { pre_BI, NULL }, /* IB */ - { pre_RB, NULL }, /* BR */ - { pre_RB, NULL }, /* RB */ - { NULL, NULL }, /* R */ - { pre_B, post_B }, /* B */ - { pre_I, post_I }, /* I */ - { pre_RI, NULL }, /* IR */ - { pre_RI, NULL }, /* RI */ - { NULL, NULL }, /* na */ - { pre_I, post_i }, /* i */ - { pre_sp, NULL }, /* sp */ - { pre_nf, NULL }, /* nf */ - { pre_fi, NULL }, /* fi */ - { pre_r, NULL }, /* r */ - { NULL, NULL }, /* RE */ - { pre_RS, post_RS }, /* RS */ - { pre_ign, NULL }, /* DT */ - { pre_ign, NULL }, /* UC */ - { pre_ign, NULL }, /* PD */ + { pre_br, NULL, MAN_NOTEXT }, /* br */ + { NULL, NULL, 0 }, /* TH */ + { pre_SH, post_SH, 0 }, /* SH */ + { pre_SS, post_SS, 0 }, /* SS */ + { pre_TP, post_TP, 0 }, /* TP */ + { pre_PP, NULL, 0 }, /* LP */ + { pre_PP, NULL, 0 }, /* PP */ + { pre_PP, NULL, 0 }, /* P */ + { pre_IP, post_IP, 0 }, /* IP */ + { pre_HP, post_HP, 0 }, /* HP */ + { NULL, NULL, 0 }, /* SM */ + { pre_B, NULL, 0 }, /* SB */ + { pre_BI, NULL, 0 }, /* BI */ + { pre_BI, NULL, 0 }, /* IB */ + { pre_RB, NULL, 0 }, /* BR */ + { pre_RB, NULL, 0 }, /* RB */ + { NULL, NULL, 0 }, /* R */ + { pre_B, NULL, 0 }, /* B */ + { pre_I, NULL, 0 }, /* I */ + { pre_RI, NULL, 0 }, /* IR */ + { pre_RI, NULL, 0 }, /* RI */ + { NULL, NULL, MAN_NOTEXT }, /* na */ + { pre_I, NULL, 0 }, /* i */ + { pre_sp, NULL, MAN_NOTEXT }, /* sp */ + { pre_nf, NULL, 0 }, /* nf */ + { pre_fi, NULL, 0 }, /* fi */ + { NULL, NULL, 0 }, /* r */ + { NULL, NULL, 0 }, /* RE */ + { pre_RS, post_RS, 0 }, /* RS */ + { pre_ign, NULL, 0 }, /* DT */ + { pre_ign, NULL, 0 }, /* UC */ + { pre_ign, NULL, 0 }, /* PD */ + { pre_sp, NULL, MAN_NOTEXT }, /* Sp */ + { pre_nf, NULL, 0 }, /* Vb */ + { pre_fi, NULL, 0 }, /* Ve */ + { pre_ign, NULL, 0 }, /* AT */ }; @@ -156,6 +156,10 @@ terminal_man(void *arg, const struct man *man) p = (struct termp *)arg; + p->overstep = 0; + p->maxrmargin = p->defrmargin; + p->tabwidth = term_len(p, 5); + if (NULL == p->symtab) switch (p->enc) { case (TERMENC_ASCII): @@ -169,44 +173,41 @@ terminal_man(void *arg, const struct man *man) n = man_node(man); m = man_meta(man); - print_man_head(p, m); + term_begin(p, print_man_head, print_man_foot, m); p->flags |= TERMP_NOSPACE; mt.fl = 0; - mt.lmargin = INDENT; - mt.offset = INDENT; + mt.lmargin = term_len(p, INDENT); + mt.offset = term_len(p, INDENT); if (n->child) - print_man_body(p, &mt, n->child, m); - print_man_foot(p, m); + print_man_nodelist(p, &mt, n->child, m); + + term_end(p); } -static int -a2height(const struct man_node *n) +static size_t +a2height(const struct termp *p, const char *cp) { struct roffsu su; - assert(MAN_TEXT == n->type); - assert(n->string); - if ( ! a2roffsu(n->string, &su, SCALE_VS)) - SCALE_VS_INIT(&su, strlen(n->string)); + if ( ! a2roffsu(cp, &su, SCALE_VS)) + SCALE_VS_INIT(&su, term_strlen(p, cp)); - return((int)term_vspan(&su)); + return(term_vspan(p, &su)); } static int -a2width(const struct man_node *n) +a2width(const struct termp *p, const char *cp) { struct roffsu su; - assert(MAN_TEXT == n->type); - assert(n->string); - if ( ! a2roffsu(n->string, &su, SCALE_BU)) + if ( ! a2roffsu(cp, &su, SCALE_BU)) return(-1); - return((int)term_hspan(&su)); + return((int)term_hspan(p, &su)); } @@ -241,42 +242,13 @@ static int pre_I(DECL_ARGS) { - p->under++; + term_fontrepl(p, TERMFONT_UNDER); return(1); } /* ARGSUSED */ static int -pre_r(DECL_ARGS) -{ - - p->bold = p->under = 0; - return(1); -} - - -/* ARGSUSED */ -static void -post_i(DECL_ARGS) -{ - - if (n->nchild) - p->under--; -} - - -/* ARGSUSED */ -static void -post_I(DECL_ARGS) -{ - - p->under--; -} - - -/* ARGSUSED */ -static int pre_fi(DECL_ARGS) { @@ -290,9 +262,8 @@ static int pre_nf(DECL_ARGS) { - term_newln(p); mt->fl |= MANT_LITERAL; - return(1); + return(MAN_Vb != n->tok); } @@ -305,19 +276,16 @@ pre_RB(DECL_ARGS) for (i = 0, nn = n->child; nn; nn = nn->next, i++) { if (i % 2 && MAN_RB == n->tok) - p->bold++; + term_fontrepl(p, TERMFONT_BOLD); else if ( ! (i % 2) && MAN_RB != n->tok) - p->bold++; + term_fontrepl(p, TERMFONT_BOLD); + else + term_fontrepl(p, TERMFONT_NONE); if (i > 0) p->flags |= TERMP_NOSPACE; print_man_node(p, mt, nn, m); - - if (i % 2 && MAN_RB == n->tok) - p->bold--; - else if ( ! (i % 2) && MAN_RB != n->tok) - p->bold--; } return(0); } @@ -332,18 +300,16 @@ pre_RI(DECL_ARGS) for (i = 0, nn = n->child; nn; nn = nn->next, i++) { if (i % 2 && MAN_RI == n->tok) - p->under++; + term_fontrepl(p, TERMFONT_UNDER); else if ( ! (i % 2) && MAN_RI != n->tok) - p->under++; + term_fontrepl(p, TERMFONT_UNDER); + else + term_fontrepl(p, TERMFONT_NONE); if (i > 0) p->flags |= TERMP_NOSPACE; - print_man_node(p, mt, nn, m); - if (i % 2 && MAN_RI == n->tok) - p->under--; - else if ( ! (i % 2) && MAN_RI != n->tok) - p->under--; + print_man_node(p, mt, nn, m); } return(0); } @@ -358,26 +324,18 @@ pre_BI(DECL_ARGS) for (i = 0, nn = n->child; nn; nn = nn->next, i++) { if (i % 2 && MAN_BI == n->tok) - p->under++; + term_fontrepl(p, TERMFONT_UNDER); else if (i % 2) - p->bold++; + term_fontrepl(p, TERMFONT_BOLD); else if (MAN_BI == n->tok) - p->bold++; + term_fontrepl(p, TERMFONT_BOLD); else - p->under++; + term_fontrepl(p, TERMFONT_UNDER); if (i) p->flags |= TERMP_NOSPACE; - print_man_node(p, mt, nn, m); - if (i % 2 && MAN_BI == n->tok) - p->under--; - else if (i % 2) - p->bold--; - else if (MAN_BI == n->tok) - p->bold--; - else - p->under--; + print_man_node(p, mt, nn, m); } return(0); } @@ -388,31 +346,23 @@ static int pre_B(DECL_ARGS) { - p->bold++; + term_fontrepl(p, TERMFONT_BOLD); return(1); } /* ARGSUSED */ -static void -post_B(DECL_ARGS) -{ - - p->bold--; -} - - -/* ARGSUSED */ static int pre_sp(DECL_ARGS) { - int i, len; + size_t i, len; - len = n->child ? a2height(n->child) : 1; + len = n->child ? + a2height(p, n->child->string) : term_len(p, 1); if (0 == len) term_newln(p); - for (i = 0; i < len; i++) + for (i = 0; i <= len; i++) term_vspace(p); return(0); @@ -455,11 +405,11 @@ pre_HP(DECL_ARGS) /* Calculate offset. */ if (NULL != (nn = n->parent->head->child)) - if ((ival = a2width(nn)) >= 0) + if ((ival = a2width(p, nn->string)) >= 0) len = (size_t)ival; if (0 == len) - len = 1; + len = term_len(p, 1); p->offset = mt->offset; p->rmargin = mt->offset + len; @@ -500,7 +450,7 @@ pre_PP(DECL_ARGS) switch (n->type) { case (MAN_BLOCK): - mt->lmargin = INDENT; + mt->lmargin = term_len(p, INDENT); print_bvspace(p, n); break; default: @@ -527,7 +477,6 @@ pre_IP(DECL_ARGS) break; case (MAN_HEAD): p->flags |= TERMP_NOBREAK; - p->flags |= TERMP_TWOSPACE; break; case (MAN_BLOCK): print_bvspace(p, n); @@ -545,7 +494,7 @@ pre_IP(DECL_ARGS) if (NULL != (nn = nn->next)) { for ( ; nn->next; nn = nn->next) /* Do nothing. */ ; - if ((ival = a2width(nn)) >= 0) + if ((ival = a2width(p, nn->string)) >= 0) len = (size_t)ival; } @@ -553,7 +502,7 @@ pre_IP(DECL_ARGS) case (MAN_HEAD): /* Handle zero-width lengths. */ if (0 == len) - len = 1; + len = term_len(p, 1); p->offset = mt->offset; p->rmargin = mt->offset + len; @@ -588,7 +537,6 @@ post_IP(DECL_ARGS) case (MAN_HEAD): term_flushln(p); p->flags &= ~TERMP_NOBREAK; - p->flags &= ~TERMP_TWOSPACE; p->rmargin = p->maxrmargin; break; case (MAN_BODY): @@ -630,16 +578,19 @@ pre_TP(DECL_ARGS) /* Calculate offset. */ - if (NULL != (nn = n->parent->head->child)) - if (NULL != nn->next) - if ((ival = a2width(nn)) >= 0) + if (NULL != (nn = n->parent->head->child)) { + while (nn && MAN_TEXT != nn->type) + nn = nn->next; + if (nn && nn->next) + if ((ival = a2width(p, nn->string)) >= 0) len = (size_t)ival; + } switch (n->type) { case (MAN_HEAD): /* Handle zero-length properly. */ if (0 == len) - len = 1; + len = term_len(p, 1); p->offset = mt->offset; p->rmargin = mt->offset + len; @@ -694,8 +645,8 @@ pre_SS(DECL_ARGS) switch (n->type) { case (MAN_BLOCK): - mt->lmargin = INDENT; - mt->offset = INDENT; + mt->lmargin = term_len(p, INDENT); + mt->offset = term_len(p, INDENT); /* If following a prior empty `SS', no vspace. */ if (n->prev && MAN_SS == n->prev->tok) if (NULL == n->prev->body->child) @@ -705,8 +656,8 @@ pre_SS(DECL_ARGS) term_vspace(p); break; case (MAN_HEAD): - p->bold++; - p->offset = HALFINDENT; + term_fontrepl(p, TERMFONT_BOLD); + p->offset = term_len(p, HALFINDENT); break; case (MAN_BODY): p->offset = mt->offset; @@ -727,7 +678,6 @@ post_SS(DECL_ARGS) switch (n->type) { case (MAN_HEAD): term_newln(p); - p->bold--; break; case (MAN_BODY): term_newln(p); @@ -745,16 +695,19 @@ pre_SH(DECL_ARGS) switch (n->type) { case (MAN_BLOCK): - mt->lmargin = INDENT; - mt->offset = INDENT; + mt->lmargin = term_len(p, INDENT); + mt->offset = term_len(p, INDENT); /* If following a prior empty `SH', no vspace. */ if (n->prev && MAN_SH == n->prev->tok) if (NULL == n->prev->body->child) break; + /* If the first macro, no vspae. */ + if (NULL == n->prev) + break; term_vspace(p); break; case (MAN_HEAD): - p->bold++; + term_fontrepl(p, TERMFONT_BOLD); p->offset = 0; break; case (MAN_BODY): @@ -776,7 +729,6 @@ post_SH(DECL_ARGS) switch (n->type) { case (MAN_HEAD): term_newln(p); - p->bold--; break; case (MAN_BODY): term_newln(p); @@ -805,15 +757,15 @@ pre_RS(DECL_ARGS) } if (NULL == (nn = n->parent->head->child)) { - mt->offset = mt->lmargin + INDENT; + mt->offset = mt->lmargin + term_len(p, INDENT); p->offset = mt->offset; return(1); } - if ((ival = a2width(nn)) < 0) + if ((ival = a2width(p, nn->string)) < 0) return(1); - mt->offset = INDENT + (size_t)ival; + mt->offset = term_len(p, INDENT) + (size_t)ival; p->offset = mt->offset; return(1); @@ -827,11 +779,13 @@ post_RS(DECL_ARGS) switch (n->type) { case (MAN_BLOCK): - mt->offset = mt->lmargin = INDENT; + mt->offset = mt->lmargin = term_len(p, INDENT); break; + case (MAN_HEAD): + break; default: term_newln(p); - p->offset = INDENT; + p->offset = term_len(p, INDENT); break; } } @@ -840,7 +794,8 @@ post_RS(DECL_ARGS) static void print_man_node(DECL_ARGS) { - int c, sz; + size_t rm, rmax; + int c; c = 1; @@ -850,66 +805,76 @@ print_man_node(DECL_ARGS) term_vspace(p); break; } - /* - * Note! This is hacky. Here, we recognise the `\c' - * escape embedded in so many -man pages. It's supposed - * to remove the subsequent space, so we mark NOSPACE if - * it's encountered in the string. - */ - sz = (int)strlen(n->string); + term_word(p, n->string); - if (sz >= 2 && n->string[sz - 1] == 'c' && - n->string[sz - 2] == '\\') - p->flags |= TERMP_NOSPACE; + /* FIXME: this means that macro lines are munged! */ + if (MANT_LITERAL & mt->fl) { + rm = p->rmargin; + rmax = p->maxrmargin; + p->rmargin = p->maxrmargin = TERM_MAXMARGIN; p->flags |= TERMP_NOSPACE; term_flushln(p); + p->rmargin = rm; + p->maxrmargin = rmax; } break; default: + if ( ! (MAN_NOTEXT & termacts[n->tok].flags)) + term_fontrepl(p, TERMFONT_NONE); if (termacts[n->tok].pre) c = (*termacts[n->tok].pre)(p, mt, n, m); break; } if (c && n->child) - print_man_body(p, mt, n->child, m); + print_man_nodelist(p, mt, n->child, m); if (MAN_TEXT != n->type) { if (termacts[n->tok].post) (*termacts[n->tok].post)(p, mt, n, m); - - /* Reset metafont upon exit from macro. */ - p->metafont = 0; + if ( ! (MAN_NOTEXT & termacts[n->tok].flags)) + term_fontrepl(p, TERMFONT_NONE); } + + if (MAN_EOS & n->flags) + p->flags |= TERMP_SENTENCE; } static void -print_man_body(DECL_ARGS) +print_man_nodelist(DECL_ARGS) { print_man_node(p, mt, n, m); if ( ! n->next) return; - print_man_body(p, mt, n->next, m); + print_man_nodelist(p, mt, n->next, m); } static void -print_man_foot(struct termp *p, const struct man_meta *meta) +print_man_foot(struct termp *p, const void *arg) { char buf[DATESIZ]; + const struct man_meta *meta; - p->metafont = 0; + meta = (const struct man_meta *)arg; - time2a(meta->date, buf, DATESIZ); + term_fontrepl(p, TERMFONT_NONE); + if (meta->rawdate) + strlcpy(buf, meta->rawdate, DATESIZ); + else + time2a(meta->date, buf, DATESIZ); + term_vspace(p); + term_vspace(p); + term_vspace(p); p->flags |= TERMP_NOSPACE | TERMP_NOBREAK; - p->rmargin = p->maxrmargin - strlen(buf); + p->rmargin = p->maxrmargin - term_strlen(p, buf); p->offset = 0; if (meta->source) @@ -929,21 +894,37 @@ print_man_foot(struct termp *p, const struct man_meta static void -print_man_head(struct termp *p, const struct man_meta *m) +print_man_head(struct termp *p, const void *arg) { char buf[BUFSIZ], title[BUFSIZ]; + size_t buflen, titlen; + const struct man_meta *m; + m = (const struct man_meta *)arg; + + /* + * Note that old groff would spit out some spaces before the + * header. We discontinue this strange behaviour, but at one + * point we did so here. + */ + p->rmargin = p->maxrmargin; + p->offset = 0; buf[0] = title[0] = '\0'; if (m->vol) strlcpy(buf, m->vol, BUFSIZ); + buflen = term_strlen(p, buf); - snprintf(title, BUFSIZ, "%s(%d)", m->title, m->msec); + snprintf(title, BUFSIZ, "%s(%s)", m->title, m->msec); + titlen = term_strlen(p, title); p->offset = 0; - p->rmargin = (p->maxrmargin - strlen(buf) + 1) / 2; + p->rmargin = 2 * (titlen+1) + buflen < p->maxrmargin ? + (p->maxrmargin - + term_strlen(p, buf) + term_len(p, 1)) / 2 : + p->maxrmargin - buflen; p->flags |= TERMP_NOBREAK | TERMP_NOSPACE; term_word(p, title); @@ -951,20 +932,31 @@ print_man_head(struct termp *p, const struct man_meta p->flags |= TERMP_NOLPAD | TERMP_NOSPACE; p->offset = p->rmargin; - p->rmargin = p->maxrmargin - strlen(title); + p->rmargin = p->offset + buflen + titlen < p->maxrmargin ? + p->maxrmargin - titlen : p->maxrmargin; term_word(p, buf); term_flushln(p); - p->offset = p->rmargin; - p->rmargin = p->maxrmargin; p->flags &= ~TERMP_NOBREAK; - p->flags |= TERMP_NOLPAD | TERMP_NOSPACE; + if (p->rmargin + titlen <= p->maxrmargin) { + p->flags |= TERMP_NOLPAD | TERMP_NOSPACE; + p->offset = p->rmargin; + p->rmargin = p->maxrmargin; + term_word(p, title); + term_flushln(p); + } - term_word(p, title); - term_flushln(p); - p->rmargin = p->maxrmargin; p->offset = 0; p->flags &= ~TERMP_NOSPACE; + + /* + * Groff likes to have some leading spaces before content. Well + * that's fine by me. + */ + + term_vspace(p); + term_vspace(p); + term_vspace(p); }