=================================================================== RCS file: /cvs/mandoc/man_term.c,v retrieving revision 1.27 retrieving revision 1.58 diff -u -p -r1.27 -r1.58 --- mandoc/man_term.c 2009/08/20 11:51:07 1.27 +++ mandoc/man_term.c 2010/03/23 12:42:22 1.58 @@ -1,4 +1,4 @@ -/* $Id: man_term.c,v 1.27 2009/08/20 11:51:07 kristaps Exp $ */ +/* $Id: man_term.c,v 1.58 2010/03/23 12:42:22 kristaps Exp $ */ /* * Copyright (c) 2008, 2009 Kristaps Dzonsons * @@ -14,19 +14,29 @@ * 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 #include -#include #include #include #include -#include "term.h" +#include "out.h" #include "man.h" +#include "term.h" +#include "chars.h" +#include "main.h" #define INDENT 7 #define HALFINDENT 3 +/* FIXME: have PD set the default vspace width. */ + struct mtermp { int fl; #define MANT_LITERAL (1 << 0) @@ -55,16 +65,27 @@ struct mtermp { struct termact { int (*pre)(DECL_ARGS); void (*post)(DECL_ARGS); + int flags; +#define MAN_NOTEXT (1 << 0) /* Never has text children. */ }; +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_nodelist(DECL_ARGS); +static void print_man_node(DECL_ARGS); +static void print_man_foot(struct termp *, + const struct man_meta *); +static void print_bvspace(struct termp *, + const struct man_node *); + static int pre_B(DECL_ARGS); static int pre_BI(DECL_ARGS); -static int pre_BR(DECL_ARGS); static int pre_HP(DECL_ARGS); static int pre_I(DECL_ARGS); -static int pre_IB(DECL_ARGS); static int pre_IP(DECL_ARGS); -static int pre_IR(DECL_ARGS); static int pre_PP(DECL_ARGS); static int pre_RB(DECL_ARGS); static int pre_RI(DECL_ARGS); @@ -74,173 +95,157 @@ static int pre_SS(DECL_ARGS); static int pre_TP(DECL_ARGS); 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_IB, NULL }, /* IB */ - { pre_BR, NULL }, /* BR */ - { pre_RB, NULL }, /* RB */ - { NULL, NULL }, /* R */ - { pre_B, post_B }, /* B */ - { pre_I, post_I }, /* I */ - { pre_IR, 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 */ - { NULL, NULL }, /* DT */ +static const struct termact termacts[MAN_MAX] = { + { 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 */ }; -#ifdef __linux__ -extern size_t strlcpy(char *, const char *, size_t); -extern size_t strlcat(char *, const char *, size_t); -#endif -static void print_head(struct termp *, - const struct man_meta *); -static void print_body(DECL_ARGS); -static void print_node(DECL_ARGS); -static void print_foot(struct termp *, - const struct man_meta *); -static void fmt_block_vspace(struct termp *, - const struct man_node *); -static int arg_width(const struct man_node *); - -int -man_run(struct termp *p, const struct man *m) +void +terminal_man(void *arg, const struct man *man) { - struct mtermp mt; + struct termp *p; + const struct man_node *n; + const struct man_meta *m; + struct mtermp mt; - print_head(p, man_meta(m)); + p = (struct termp *)arg; + + p->overstep = 0; + p->maxrmargin = 65; + + if (NULL == p->symtab) + switch (p->enc) { + case (TERMENC_ASCII): + p->symtab = chars_init(CHARS_ASCII); + break; + default: + abort(); + /* NOTREACHED */ + } + + n = man_node(man); + m = man_meta(man); + + print_man_head(p, m); p->flags |= TERMP_NOSPACE; - assert(man_node(m)); - assert(MAN_ROOT == man_node(m)->type); mt.fl = 0; mt.lmargin = INDENT; mt.offset = INDENT; - if (man_node(m)->child) - print_body(p, &mt, man_node(m)->child, man_meta(m)); - print_foot(p, man_meta(m)); - - return(1); + if (n->child) + print_man_nodelist(p, &mt, n->child, m); + print_man_foot(p, m); } -static void -fmt_block_vspace(struct termp *p, const struct man_node *n) +static int +a2height(const struct man_node *n) { - term_newln(p); + struct roffsu su; - if (NULL == n->prev) - return; + assert(MAN_TEXT == n->type); + assert(n->string); + if ( ! a2roffsu(n->string, &su, SCALE_VS)) + SCALE_VS_INIT(&su, strlen(n->string)); - if (MAN_SS == n->prev->tok) - return; - if (MAN_SH == n->prev->tok) - return; - - term_vspace(p); + return((int)term_vspan(&su)); } static int -arg_width(const struct man_node *n) +a2width(const struct man_node *n) { - int i, len; - const char *p; + struct roffsu su; assert(MAN_TEXT == n->type); assert(n->string); - - p = n->string; - - if (0 == (len = (int)strlen(p))) + if ( ! a2roffsu(n->string, &su, SCALE_BU)) return(-1); - for (i = 0; i < len; i++) - if ( ! isdigit((u_char)p[i])) - break; - - if (i == len - 1) { - if ('n' == p[len - 1] || 'm' == p[len - 1]) - return(atoi(p)); - } else if (i == len) - return(atoi(p)); - - return(-1); + return((int)term_hspan(&su)); } -/* ARGSUSED */ -static int -pre_I(DECL_ARGS) +static void +print_bvspace(struct termp *p, const struct man_node *n) { + term_newln(p); - p->flags |= TERMP_UNDER; - return(1); -} + if (NULL == n->prev) + return; + if (MAN_SS == n->prev->tok) + return; + if (MAN_SH == n->prev->tok) + return; -/* ARGSUSED */ -static int -pre_r(DECL_ARGS) -{ - - p->flags &= ~TERMP_UNDER; - p->flags &= ~TERMP_BOLD; - return(1); + term_vspace(p); } /* ARGSUSED */ -static void -post_i(DECL_ARGS) +static int +pre_ign(DECL_ARGS) { - if (n->nchild) - p->flags &= ~TERMP_UNDER; + return(0); } /* ARGSUSED */ -static void -post_I(DECL_ARGS) +static int +pre_I(DECL_ARGS) { - p->flags &= ~TERMP_UNDER; + term_fontrepl(p, TERMFONT_UNDER); + return(1); } @@ -249,6 +254,7 @@ static int pre_fi(DECL_ARGS) { + p->rmargin = p->maxrmargin = 65; mt->fl &= ~MANT_LITERAL; return(1); } @@ -259,65 +265,33 @@ static int pre_nf(DECL_ARGS) { + p->rmargin = p->maxrmargin = 78; term_newln(p); mt->fl |= MANT_LITERAL; - return(1); -} - -/* ARGSUSED */ -static int -pre_IR(DECL_ARGS) -{ - const struct man_node *nn; - int i; - - for (i = 0, nn = n->child; nn; nn = nn->next, i++) { - if ( ! (i % 2)) - p->flags |= TERMP_UNDER; - if (i > 0) - p->flags |= TERMP_NOSPACE; - print_node(p, mt, nn, m); - if ( ! (i % 2)) - p->flags &= ~TERMP_UNDER; - } - return(0); + return(MAN_Vb != n->tok); } /* ARGSUSED */ static int -pre_IB(DECL_ARGS) -{ - const struct man_node *nn; - int i; - - for (i = 0, nn = n->child; nn; nn = nn->next, i++) { - p->flags |= i % 2 ? TERMP_BOLD : TERMP_UNDER; - if (i > 0) - p->flags |= TERMP_NOSPACE; - print_node(p, mt, nn, m); - p->flags &= i % 2 ? ~TERMP_BOLD : ~TERMP_UNDER; - } - return(0); -} - - -/* ARGSUSED */ -static int pre_RB(DECL_ARGS) { const struct man_node *nn; int i; for (i = 0, nn = n->child; nn; nn = nn->next, i++) { - if (i % 2) - p->flags |= TERMP_BOLD; + if (i % 2 && MAN_RB == n->tok) + term_fontrepl(p, TERMFONT_BOLD); + else if ( ! (i % 2) && MAN_RB != n->tok) + term_fontrepl(p, TERMFONT_BOLD); + else + term_fontrepl(p, TERMFONT_NONE); + if (i > 0) p->flags |= TERMP_NOSPACE; - print_node(p, mt, nn, m); - if (i % 2) - p->flags &= ~TERMP_BOLD; + + print_man_node(p, mt, nn, m); } return(0); } @@ -331,33 +305,17 @@ pre_RI(DECL_ARGS) int i; for (i = 0, nn = n->child; nn; nn = nn->next, i++) { - if ( ! (i % 2)) - p->flags |= TERMP_UNDER; - if (i > 0) - p->flags |= TERMP_NOSPACE; - print_node(p, mt, nn, m); - if ( ! (i % 2)) - p->flags &= ~TERMP_UNDER; - } - return(0); -} + if (i % 2 && MAN_RI == n->tok) + term_fontrepl(p, TERMFONT_UNDER); + else if ( ! (i % 2) && MAN_RI != n->tok) + term_fontrepl(p, TERMFONT_UNDER); + else + term_fontrepl(p, TERMFONT_NONE); - -/* ARGSUSED */ -static int -pre_BR(DECL_ARGS) -{ - const struct man_node *nn; - int i; - - for (i = 0, nn = n->child; nn; nn = nn->next, i++) { - if ( ! (i % 2)) - p->flags |= TERMP_BOLD; if (i > 0) p->flags |= TERMP_NOSPACE; - print_node(p, mt, nn, m); - if ( ! (i % 2)) - p->flags &= ~TERMP_BOLD; + + print_man_node(p, mt, nn, m); } return(0); } @@ -367,15 +325,23 @@ pre_BR(DECL_ARGS) static int pre_BI(DECL_ARGS) { - const struct man_node *nn; - int i; + const struct man_node *nn; + int i; for (i = 0, nn = n->child; nn; nn = nn->next, i++) { - p->flags |= i % 2 ? TERMP_UNDER : TERMP_BOLD; - if (i > 0) + if (i % 2 && MAN_BI == n->tok) + term_fontrepl(p, TERMFONT_UNDER); + else if (i % 2) + term_fontrepl(p, TERMFONT_BOLD); + else if (MAN_BI == n->tok) + term_fontrepl(p, TERMFONT_BOLD); + else + term_fontrepl(p, TERMFONT_UNDER); + + if (i) p->flags |= TERMP_NOSPACE; - print_node(p, mt, nn, m); - p->flags &= i % 2 ? ~TERMP_UNDER : ~TERMP_BOLD; + + print_man_node(p, mt, nn, m); } return(0); } @@ -386,32 +352,19 @@ static int pre_B(DECL_ARGS) { - p->flags |= TERMP_BOLD; + term_fontrepl(p, TERMFONT_BOLD); return(1); } /* ARGSUSED */ -static void -post_B(DECL_ARGS) -{ - - p->flags &= ~TERMP_BOLD; -} - - -/* ARGSUSED */ static int pre_sp(DECL_ARGS) { int i, len; - if (NULL == n->child) { - term_vspace(p); - return(0); - } + len = n->child ? a2height(n->child) : 1; - len = atoi(n->child->string); if (0 == len) term_newln(p); for (i = 0; i < len; i++) @@ -441,7 +394,7 @@ pre_HP(DECL_ARGS) switch (n->type) { case (MAN_BLOCK): - fmt_block_vspace(p, n); + print_bvspace(p, n); return(1); case (MAN_BODY): p->flags |= TERMP_NOBREAK; @@ -457,7 +410,7 @@ pre_HP(DECL_ARGS) /* Calculate offset. */ if (NULL != (nn = n->parent->head->child)) - if ((ival = arg_width(nn)) >= 0) + if ((ival = a2width(nn)) >= 0) len = (size_t)ival; if (0 == len) @@ -503,7 +456,7 @@ pre_PP(DECL_ARGS) switch (n->type) { case (MAN_BLOCK): mt->lmargin = INDENT; - fmt_block_vspace(p, n); + print_bvspace(p, n); break; default: p->offset = mt->offset; @@ -532,7 +485,7 @@ pre_IP(DECL_ARGS) p->flags |= TERMP_TWOSPACE; break; case (MAN_BLOCK): - fmt_block_vspace(p, n); + print_bvspace(p, n); /* FALLTHROUGH */ default: return(1); @@ -547,7 +500,7 @@ pre_IP(DECL_ARGS) if (NULL != (nn = nn->next)) { for ( ; nn->next; nn = nn->next) /* Do nothing. */ ; - if ((ival = arg_width(nn)) >= 0) + if ((ival = a2width(nn)) >= 0) len = (size_t)ival; } @@ -567,7 +520,7 @@ pre_IP(DECL_ARGS) /* Don't print the length value. */ for (nn = n->child; nn->next; nn = nn->next) - print_node(p, mt, nn, m); + print_man_node(p, mt, nn, m); return(0); case (MAN_BODY): p->offset = mt->offset + len; @@ -621,7 +574,7 @@ pre_TP(DECL_ARGS) p->flags |= TERMP_NOSPACE; break; case (MAN_BLOCK): - fmt_block_vspace(p, n); + print_bvspace(p, n); /* FALLTHROUGH */ default: return(1); @@ -632,10 +585,13 @@ pre_TP(DECL_ARGS) /* Calculate offset. */ - if (NULL != (nn = n->parent->head->child)) - if (NULL != nn->next) - if ((ival = arg_width(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(nn)) >= 0) len = (size_t)ival; + } switch (n->type) { case (MAN_HEAD): @@ -649,7 +605,7 @@ pre_TP(DECL_ARGS) /* Don't print same-line elements. */ for (nn = n->child; nn; nn = nn->next) if (nn->line > n->line) - print_node(p, mt, nn, m); + print_man_node(p, mt, nn, m); if (ival >= 0) mt->lmargin = (size_t)ival; @@ -707,7 +663,7 @@ pre_SS(DECL_ARGS) term_vspace(p); break; case (MAN_HEAD): - p->flags |= TERMP_BOLD; + term_fontrepl(p, TERMFONT_BOLD); p->offset = HALFINDENT; break; case (MAN_BODY): @@ -729,7 +685,6 @@ post_SS(DECL_ARGS) switch (n->type) { case (MAN_HEAD): term_newln(p); - p->flags &= ~TERMP_BOLD; break; case (MAN_BODY): term_newln(p); @@ -756,7 +711,7 @@ pre_SH(DECL_ARGS) term_vspace(p); break; case (MAN_HEAD): - p->flags |= TERMP_BOLD; + term_fontrepl(p, TERMFONT_BOLD); p->offset = 0; break; case (MAN_BODY): @@ -778,7 +733,6 @@ post_SH(DECL_ARGS) switch (n->type) { case (MAN_HEAD): term_newln(p); - p->flags &= ~TERMP_BOLD; break; case (MAN_BODY): term_newln(p); @@ -812,7 +766,7 @@ pre_RS(DECL_ARGS) return(1); } - if ((ival = arg_width(nn)) < 0) + if ((ival = a2width(nn)) < 0) return(1); mt->offset = INDENT + (size_t)ival; @@ -840,9 +794,9 @@ post_RS(DECL_ARGS) static void -print_node(DECL_ARGS) +print_man_node(DECL_ARGS) { - int c, sz; + int c; c = 1; @@ -852,63 +806,56 @@ print_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) { p->flags |= TERMP_NOSPACE; term_flushln(p); } 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_body(p, mt, n->child, m); + print_man_nodelist(p, mt, n->child, m); - if (MAN_TEXT != n->type) + if (MAN_TEXT != n->type) { if (termacts[n->tok].post) (*termacts[n->tok].post)(p, mt, n, m); + if ( ! (MAN_NOTEXT & termacts[n->tok].flags)) + term_fontrepl(p, TERMFONT_NONE); + } } static void -print_body(DECL_ARGS) +print_man_nodelist(DECL_ARGS) { - print_node(p, mt, n, m); + print_man_node(p, mt, n, m); if ( ! n->next) return; - print_body(p, mt, n->next, m); + print_man_nodelist(p, mt, n->next, m); } static void -print_foot(struct termp *p, const struct man_meta *meta) +print_man_foot(struct termp *p, const struct man_meta *meta) { - struct tm *tm; - char *buf; + char buf[DATESIZ]; - if (NULL == (buf = malloc(p->rmargin))) - err(1, "malloc"); + term_fontrepl(p, TERMFONT_NONE); - tm = localtime(&meta->date); + time2a(meta->date, buf, DATESIZ); - if (0 == strftime(buf, p->rmargin, "%B %d, %Y", tm)) - err(1, "strftime"); - term_vspace(p); p->flags |= TERMP_NOSPACE | TERMP_NOBREAK; @@ -928,34 +875,31 @@ print_foot(struct termp *p, const struct man_meta *met term_word(p, buf); term_flushln(p); - - free(buf); } static void -print_head(struct termp *p, const struct man_meta *meta) +print_man_head(struct termp *p, const struct man_meta *m) { - char *buf, *title; + char buf[BUFSIZ], title[BUFSIZ]; + size_t buflen, titlen; p->rmargin = p->maxrmargin; + p->offset = 0; + buf[0] = title[0] = '\0'; - if (NULL == (buf = malloc(p->rmargin))) - err(1, "malloc"); - if (NULL == (title = malloc(p->rmargin))) - err(1, "malloc"); + if (m->vol) + strlcpy(buf, m->vol, BUFSIZ); + buflen = strlen(buf); - if (meta->vol) - (void)strlcpy(buf, meta->vol, p->rmargin); - else - *buf = 0; + snprintf(title, BUFSIZ, "%s(%d)", m->title, m->msec); + titlen = strlen(title); - (void)snprintf(title, p->rmargin, "%s(%d)", - meta->title, meta->msec); - p->offset = 0; - p->rmargin = (p->maxrmargin - strlen(buf) + 1) / 2; + p->rmargin = 2 * (titlen+1) + buflen < p->maxrmargin ? + (p->maxrmargin - strlen(buf) + 1) / 2 : + p->maxrmargin - buflen; p->flags |= TERMP_NOBREAK | TERMP_NOSPACE; term_word(p, title); @@ -963,24 +907,22 @@ print_head(struct termp *p, const struct man_meta *met 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; - - free(title); - free(buf); } -