=================================================================== RCS file: /cvs/mandoc/man_term.c,v retrieving revision 1.19 retrieving revision 1.37 diff -u -p -r1.19 -r1.37 --- mandoc/man_term.c 2009/08/13 11:45:29 1.19 +++ mandoc/man_term.c 2009/10/18 11:14:04 1.37 @@ -1,4 +1,4 @@ -/* $Id: man_term.c,v 1.19 2009/08/13 11:45:29 kristaps Exp $ */ +/* $Id: man_term.c,v 1.37 2009/10/18 11:14:04 kristaps Exp $ */ /* * Copyright (c) 2008, 2009 Kristaps Dzonsons * @@ -14,6 +14,8 @@ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ +#include + #include #include #include @@ -21,21 +23,37 @@ #include #include -#include "term.h" #include "man.h" +#include "term.h" +#include "chars.h" +#include "main.h" +#include "out.h" #define INDENT 7 #define HALFINDENT 3 -#ifdef __linux__ -extern size_t strlcpy(char *, const char *, size_t); -extern size_t strlcat(char *, const char *, size_t); -#endif - +struct mtermp { + int fl; #define MANT_LITERAL (1 << 0) + /* + * Default amount to indent the left margin after leading text + * has been printed (e.g., `HP' left-indent, `TP' and `IP' body + * indent). This needs to be saved because `HP' and so on, if + * not having a specified value, must default. + * + * Note that this is the indentation AFTER the left offset, so + * the total offset is usually offset + lmargin. + */ + size_t lmargin; + /* + * The default offset, i.e., the amount between any text and the + * page boundary. + */ + size_t offset; +}; #define DECL_ARGS struct termp *p, \ - int *fl, \ + struct mtermp *mt, \ const struct man_node *n, \ const struct man_meta *m @@ -46,60 +64,73 @@ struct termact { 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); +static int pre_RS(DECL_ARGS); static int pre_SH(DECL_ARGS); 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] = { +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, NULL }, /* TP */ + { pre_TP, post_TP }, /* TP */ { pre_PP, NULL }, /* LP */ { pre_PP, NULL }, /* PP */ { pre_PP, NULL }, /* P */ - { pre_IP, NULL }, /* IP */ - { pre_HP, NULL }, /* HP */ + { 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_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_IR, NULL }, /* IR */ { pre_RI, NULL }, /* RI */ - { NULL, NULL }, /* na */ /* TODO: document that has no effect */ + { 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 */ }; +#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); @@ -108,25 +139,42 @@ 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 *); +static int a2width(const char *); -int -man_run(struct termp *p, const struct man *m) +void +terminal_man(void *arg, const struct man *man) { - int fl; + 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; + + 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_head(p, m); p->flags |= TERMP_NOSPACE; - assert(man_node(m)); - assert(MAN_ROOT == man_node(m)->type); - fl = 0; - if (man_node(m)->child) - print_body(p, &fl, man_node(m)->child, man_meta(m)); - print_foot(p, man_meta(m)); + mt.fl = 0; + mt.lmargin = INDENT; + mt.offset = INDENT; - return(1); + if (n->child) + print_body(p, &mt, n->child, m); + print_foot(p, m); } @@ -148,30 +196,51 @@ fmt_block_vspace(struct termp *p, const struct man_nod static int -arg_width(const struct man_node *n) +a2width(const char *p) { - int i, len; - const char *p; + struct roffsu su; + double r; - assert(MAN_TEXT == n->type); - assert(n->string); + if ( ! a2roffsu(p, &su)) + return(-1); - p = n->string; + switch (su.unit) { + case (SCALE_CM): + r = 4 * su.scale; + break; + case (SCALE_IN): + r = 10 * su.scale; + break; + case (SCALE_PC): + r = 2 * su.scale; + break; + case (SCALE_PT): + r = (su.scale / 10) + 1; + break; + case (SCALE_MM): + r = su.scale / 1000; + break; + case (SCALE_VS): + r = su.scale * 2 - 1; + break; + default: + r = su.scale + 1; + break; + } - if (0 == (len = (int)strlen(p))) - return(-1); + if (r < 0.0) + r = 0.0; + return((int)/* LINTED */ + r); +} - 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)); +/* ARGSUSED */ +static int +pre_ign(DECL_ARGS) +{ - return(-1); + return(0); } @@ -180,7 +249,7 @@ static int pre_I(DECL_ARGS) { - p->flags |= TERMP_UNDER; + p->under++; return(1); } @@ -190,8 +259,7 @@ static int pre_r(DECL_ARGS) { - p->flags &= ~TERMP_UNDER; - p->flags &= ~TERMP_BOLD; + p->bold = p->under = 0; return(1); } @@ -202,7 +270,7 @@ post_i(DECL_ARGS) { if (n->nchild) - p->flags &= ~TERMP_UNDER; + p->under--; } @@ -211,7 +279,7 @@ static void post_I(DECL_ARGS) { - p->flags &= ~TERMP_UNDER; + p->under--; } @@ -220,7 +288,7 @@ static int pre_fi(DECL_ARGS) { - *fl &= ~MANT_LITERAL; + mt->fl &= ~MANT_LITERAL; return(1); } @@ -231,7 +299,7 @@ pre_nf(DECL_ARGS) { term_newln(p); - *fl |= MANT_LITERAL; + mt->fl |= MANT_LITERAL; return(1); } @@ -245,12 +313,12 @@ pre_IR(DECL_ARGS) for (i = 0, nn = n->child; nn; nn = nn->next, i++) { if ( ! (i % 2)) - p->flags |= TERMP_UNDER; + p->under++; if (i > 0) p->flags |= TERMP_NOSPACE; - print_node(p, fl, nn, m); + print_node(p, mt, nn, m); if ( ! (i % 2)) - p->flags &= ~TERMP_UNDER; + p->under--; } return(0); } @@ -258,37 +326,26 @@ pre_IR(DECL_ARGS) /* ARGSUSED */ static int -pre_IB(DECL_ARGS) +pre_RB(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 % 2 && MAN_RB == n->tok) + p->bold++; + else if ( ! (i % 2) && MAN_RB != n->tok) + p->bold++; + if (i > 0) p->flags |= TERMP_NOSPACE; - print_node(p, fl, nn, m); - p->flags &= i % 2 ? ~TERMP_BOLD : ~TERMP_UNDER; - } - return(0); -} + print_node(p, mt, nn, m); -/* 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 > 0) - p->flags |= TERMP_NOSPACE; - print_node(p, fl, nn, m); - if (i % 2) - p->flags &= ~TERMP_BOLD; + if (i % 2 && MAN_RB == n->tok) + p->bold--; + else if ( ! (i % 2) && MAN_RB != n->tok) + p->bold--; } return(0); } @@ -303,12 +360,12 @@ pre_RI(DECL_ARGS) for (i = 0, nn = n->child; nn; nn = nn->next, i++) { if ( ! (i % 2)) - p->flags |= TERMP_UNDER; + p->under++; if (i > 0) p->flags |= TERMP_NOSPACE; - print_node(p, fl, nn, m); + print_node(p, mt, nn, m); if ( ! (i % 2)) - p->flags &= ~TERMP_UNDER; + p->under--; } return(0); } @@ -316,37 +373,33 @@ pre_RI(DECL_ARGS) /* 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, fl, nn, m); - if ( ! (i % 2)) - p->flags &= ~TERMP_BOLD; - } - return(0); -} - - -/* ARGSUSED */ -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) + p->under++; + else if (i % 2) + p->bold++; + else if (MAN_BI == n->tok) + p->bold++; + else + p->under++; + + if (i) p->flags |= TERMP_NOSPACE; - print_node(p, fl, nn, m); - p->flags &= i % 2 ? ~TERMP_UNDER : ~TERMP_BOLD; + print_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--; } return(0); } @@ -357,7 +410,7 @@ static int pre_B(DECL_ARGS) { - p->flags |= TERMP_BOLD; + p->bold++; return(1); } @@ -367,7 +420,7 @@ static void post_B(DECL_ARGS) { - p->flags &= ~TERMP_BOLD; + p->bold--; } @@ -406,23 +459,80 @@ pre_br(DECL_ARGS) static int pre_HP(DECL_ARGS) { + size_t len; + int ival; + const struct man_node *nn; - /* TODO */ + switch (n->type) { + case (MAN_BLOCK): + fmt_block_vspace(p, n); + return(1); + case (MAN_BODY): + p->flags |= TERMP_NOBREAK; + p->flags |= TERMP_TWOSPACE; + break; + default: + return(0); + } + + len = mt->lmargin; + ival = -1; + + /* Calculate offset. */ + + if (NULL != (nn = n->parent->head->child)) { + assert(MAN_TEXT == nn->type); + if ((ival = a2width(nn->string)) >= 0) + len = (size_t)ival; + } + + if (0 == len) + len = 1; + + p->offset = mt->offset; + p->rmargin = mt->offset + len; + + if (ival >= 0) + mt->lmargin = (size_t)ival; + return(1); } /* ARGSUSED */ +static void +post_HP(DECL_ARGS) +{ + + switch (n->type) { + case (MAN_BLOCK): + term_flushln(p); + break; + case (MAN_BODY): + term_flushln(p); + p->flags &= ~TERMP_NOBREAK; + p->flags &= ~TERMP_TWOSPACE; + p->offset = mt->offset; + p->rmargin = p->maxrmargin; + break; + default: + break; + } +} + + +/* ARGSUSED */ static int pre_PP(DECL_ARGS) { switch (n->type) { case (MAN_BLOCK): + mt->lmargin = INDENT; fmt_block_vspace(p, n); break; default: - p->offset = INDENT; + p->offset = mt->offset; break; } @@ -434,110 +544,205 @@ pre_PP(DECL_ARGS) static int pre_IP(DECL_ARGS) { - /* TODO */ -#if 0 - const struct man_node *nn; - size_t offs, sv; - int ival; + const struct man_node *nn; + size_t len; + int ival; - fmt_block_vspace(p, n); - - p->flags |= TERMP_NOSPACE; - - sv = p->offset; - p->offset = INDENT; - - if (NULL == n->child) + switch (n->type) { + case (MAN_BODY): + p->flags |= TERMP_NOLPAD; + p->flags |= TERMP_NOSPACE; + break; + case (MAN_HEAD): + p->flags |= TERMP_NOBREAK; + p->flags |= TERMP_TWOSPACE; + break; + case (MAN_BLOCK): + fmt_block_vspace(p, n); + /* FALLTHROUGH */ + default: return(1); + } - p->flags |= TERMP_NOBREAK; + len = mt->lmargin; + ival = -1; - offs = sv; + /* Calculate offset. */ - /* - * If the last token is number-looking (3m, 3n, 3) then - * interpret it as the width specifier, else we stick with the - * prior saved offset. XXX - obviously not documented. - */ - for (nn = n->child; nn; nn = nn->next) { - if (NULL == nn->next) { - ival = arg_width(nn); - if (ival >= 0) { - offs = (size_t)ival; - break; - } + if (NULL != (nn = n->parent->head->child)) + if (NULL != (nn = nn->next)) { + for ( ; nn->next; nn = nn->next) + /* Do nothing. */ ; + assert(MAN_TEXT == nn->type); + if ((ival = a2width(nn->string)) >= 0) + len = (size_t)ival; } - print_node(p, fl, nn, m); - } - p->rmargin = p->offset + offs; + switch (n->type) { + case (MAN_HEAD): + /* Handle zero-width lengths. */ + if (0 == len) + len = 1; - term_flushln(p); + p->offset = mt->offset; + p->rmargin = mt->offset + len; + if (ival < 0) + break; - p->offset = offs; - p->rmargin = p->maxrmargin; + /* Set the saved left-margin. */ + mt->lmargin = (size_t)ival; - p->flags |= TERMP_NOLPAD | TERMP_NOSPACE; + /* Don't print the length value. */ + for (nn = n->child; nn->next; nn = nn->next) + print_node(p, mt, nn, m); + return(0); + case (MAN_BODY): + p->offset = mt->offset + len; + p->rmargin = p->maxrmargin; + break; + default: + break; + } - return(0); -#endif return(1); } /* ARGSUSED */ +static void +post_IP(DECL_ARGS) +{ + + switch (n->type) { + case (MAN_HEAD): + term_flushln(p); + p->flags &= ~TERMP_NOBREAK; + p->flags &= ~TERMP_TWOSPACE; + p->rmargin = p->maxrmargin; + break; + case (MAN_BODY): + term_flushln(p); + p->flags &= ~TERMP_NOLPAD; + break; + default: + break; + } +} + + +/* ARGSUSED */ static int pre_TP(DECL_ARGS) { - /* TODO */ -#if 0 - const struct man_node *nn; - size_t offs; + const struct man_node *nn; + size_t len; + int ival; - term_vspace(p); + switch (n->type) { + case (MAN_HEAD): + p->flags |= TERMP_NOBREAK; + p->flags |= TERMP_TWOSPACE; + break; + case (MAN_BODY): + p->flags |= TERMP_NOLPAD; + p->flags |= TERMP_NOSPACE; + break; + case (MAN_BLOCK): + fmt_block_vspace(p, n); + /* FALLTHROUGH */ + default: + return(1); + } - p->offset = INDENT; + len = (size_t)mt->lmargin; + ival = -1; - if (NULL == (nn = n->child)) - return(1); + /* Calculate offset. */ - if (nn->line == n->line) { - if (MAN_TEXT != nn->type) - errx(1, "expected text line argument"); - offs = (size_t)atoi(nn->string); - nn = nn->next; - } else - offs = INDENT; + if (NULL != (nn = n->parent->head->child)) + if (NULL != nn->next) { + assert(MAN_TEXT == nn->type); + if ((ival = a2width(nn->string)) >= 0) + len = (size_t)ival; + } - for ( ; nn; nn = nn->next) - print_node(p, fl, nn, m); + switch (n->type) { + case (MAN_HEAD): + /* Handle zero-length properly. */ + if (0 == len) + len = 1; - term_flushln(p); - p->flags |= TERMP_NOSPACE; - p->offset += offs; - return(0); -#endif + p->offset = mt->offset; + p->rmargin = mt->offset + len; + + /* 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); + + if (ival >= 0) + mt->lmargin = (size_t)ival; + + return(0); + case (MAN_BODY): + p->offset = mt->offset + len; + p->rmargin = p->maxrmargin; + break; + default: + break; + } + return(1); } /* ARGSUSED */ +static void +post_TP(DECL_ARGS) +{ + + switch (n->type) { + case (MAN_HEAD): + term_flushln(p); + p->flags &= ~TERMP_NOBREAK; + p->flags &= ~TERMP_TWOSPACE; + p->rmargin = p->maxrmargin; + break; + case (MAN_BODY): + term_flushln(p); + p->flags &= ~TERMP_NOLPAD; + break; + default: + break; + } +} + + +/* ARGSUSED */ static int pre_SS(DECL_ARGS) { switch (n->type) { case (MAN_BLOCK): - term_newln(p); - if (n->prev) - term_vspace(p); + mt->lmargin = INDENT; + mt->offset = INDENT; + /* If following a prior empty `SS', no vspace. */ + if (n->prev && MAN_SS == n->prev->tok) + if (NULL == n->prev->body->child) + break; + if (NULL == n->prev) + break; + term_vspace(p); break; case (MAN_HEAD): - p->flags |= TERMP_BOLD; + p->bold++; p->offset = HALFINDENT; break; + case (MAN_BODY): + p->offset = mt->offset; + break; default: - p->offset = INDENT; break; } @@ -553,8 +758,11 @@ post_SS(DECL_ARGS) switch (n->type) { case (MAN_HEAD): term_newln(p); - p->flags &= ~TERMP_BOLD; + p->bold--; break; + case (MAN_BODY): + term_newln(p); + break; default: break; } @@ -565,23 +773,23 @@ post_SS(DECL_ARGS) static int pre_SH(DECL_ARGS) { - /* - * XXX: undocumented: using two `SH' macros in sequence has no - * vspace between calls, only a newline. - */ + switch (n->type) { case (MAN_BLOCK): + mt->lmargin = INDENT; + mt->offset = INDENT; + /* If following a prior empty `SH', no vspace. */ if (n->prev && MAN_SH == n->prev->tok) if (NULL == n->prev->body->child) break; term_vspace(p); break; case (MAN_HEAD): - p->flags |= TERMP_BOLD; + p->bold++; p->offset = 0; break; case (MAN_BODY): - p->offset = INDENT; + p->offset = mt->offset; break; default: break; @@ -599,7 +807,7 @@ post_SH(DECL_ARGS) switch (n->type) { case (MAN_HEAD): term_newln(p); - p->flags &= ~TERMP_BOLD; + p->bold--; break; case (MAN_BODY): term_newln(p); @@ -610,7 +818,58 @@ post_SH(DECL_ARGS) } +/* ARGSUSED */ +static int +pre_RS(DECL_ARGS) +{ + const struct man_node *nn; + int ival; + + switch (n->type) { + case (MAN_BLOCK): + term_newln(p); + return(1); + case (MAN_HEAD): + return(0); + default: + break; + } + + if (NULL == (nn = n->parent->head->child)) { + mt->offset = mt->lmargin + INDENT; + p->offset = mt->offset; + return(1); + } + + assert(MAN_TEXT == nn->type); + if ((ival = a2width(nn->string)) < 0) + return(1); + + mt->offset = INDENT + (size_t)ival; + p->offset = mt->offset; + + return(1); +} + + +/* ARGSUSED */ static void +post_RS(DECL_ARGS) +{ + + switch (n->type) { + case (MAN_BLOCK): + mt->offset = mt->lmargin = INDENT; + break; + default: + term_newln(p); + p->offset = INDENT; + break; + } +} + + +static void print_node(DECL_ARGS) { int c, sz; @@ -635,23 +894,23 @@ print_node(DECL_ARGS) n->string[sz - 2] == '\\') p->flags |= TERMP_NOSPACE; /* FIXME: this means that macro lines are munged! */ - if (MANT_LITERAL & *fl) { + if (MANT_LITERAL & mt->fl) { p->flags |= TERMP_NOSPACE; term_flushln(p); } break; default: if (termacts[n->tok].pre) - c = (*termacts[n->tok].pre)(p, fl, n, m); + c = (*termacts[n->tok].pre)(p, mt, n, m); break; } if (c && n->child) - print_body(p, fl, n->child, m); + print_body(p, mt, n->child, m); if (MAN_TEXT != n->type) if (termacts[n->tok].post) - (*termacts[n->tok].post)(p, fl, n, m); + (*termacts[n->tok].post)(p, mt, n, m); } @@ -659,10 +918,10 @@ static void print_body(DECL_ARGS) { - print_node(p, fl, n, m); + print_node(p, mt, n, m); if ( ! n->next) return; - print_body(p, fl, n->next, m); + print_body(p, mt, n->next, m); } @@ -670,15 +929,12 @@ static void print_foot(struct termp *p, const struct man_meta *meta) { struct tm *tm; - char *buf; + char buf[BUFSIZ]; - if (NULL == (buf = malloc(p->rmargin))) - err(1, "malloc"); - tm = localtime(&meta->date); if (0 == strftime(buf, p->rmargin, "%B %d, %Y", tm)) - err(1, "strftime"); + (void)strlcpy(buf, "(invalid date)", BUFSIZ); term_vspace(p); @@ -699,8 +955,6 @@ print_foot(struct termp *p, const struct man_meta *met term_word(p, buf); term_flushln(p); - - free(buf); } @@ -713,9 +967,9 @@ print_head(struct termp *p, const struct man_meta *met p->offset = 0; if (NULL == (buf = malloc(p->rmargin))) - err(1, "malloc"); + err(EXIT_FAILURE, "malloc"); if (NULL == (title = malloc(p->rmargin))) - err(1, "malloc"); + err(EXIT_FAILURE, "malloc"); if (meta->vol) (void)strlcpy(buf, meta->vol, p->rmargin);