=================================================================== RCS file: /cvs/mandoc/man_term.c,v retrieving revision 1.18 retrieving revision 1.31 diff -u -p -r1.18 -r1.31 --- mandoc/man_term.c 2009/08/10 10:09:51 1.18 +++ mandoc/man_term.c 2009/09/16 09:41:24 1.31 @@ -1,4 +1,4 @@ -/* $Id: man_term.c,v 1.18 2009/08/10 10:09:51 kristaps Exp $ */ +/* $Id: man_term.c,v 1.31 2009/09/16 09:41:24 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 @@ -27,12 +29,28 @@ #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, \ + struct mtermp *mt, \ const struct man_node *n, \ const struct man_meta *m @@ -44,7 +62,7 @@ struct termact { static int pre_B(DECL_ARGS); static int pre_BI(DECL_ARGS); static int pre_BR(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); @@ -52,26 +70,38 @@ 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] = { { 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_PP, NULL }, /* HP */ /* FIXME */ + { pre_IP, post_IP }, /* IP */ + { pre_HP, post_HP }, /* HP */ { NULL, NULL }, /* SM */ { pre_B, post_B }, /* SB */ { pre_BI, NULL }, /* BI */ @@ -84,10 +114,22 @@ static const struct termact termacts[MAN_MAX] = { { pre_IR, NULL }, /* IR */ { pre_RI, NULL }, /* RI */ { NULL, NULL }, /* na */ - { pre_I, post_I }, /* i */ - { NULL, NULL }, /* sp */ + { 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); @@ -99,19 +141,21 @@ static void fmt_block_vspace(struct termp *, static int arg_width(const struct man_node *); -int +void man_run(struct termp *p, const struct man *m) { + struct mtermp mt; print_head(p, man_meta(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, man_node(m)->child, man_meta(m)); + print_body(p, &mt, man_node(m)->child, man_meta(m)); print_foot(p, man_meta(m)); - - return(1); } @@ -162,25 +206,75 @@ arg_width(const struct man_node *n) /* ARGSUSED */ static int +pre_ign(DECL_ARGS) +{ + + return(0); +} + + +/* ARGSUSED */ +static int pre_I(DECL_ARGS) { - p->flags |= TERMP_UNDER; + p->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->flags &= ~TERMP_UNDER; + p->under--; } /* ARGSUSED */ static int +pre_fi(DECL_ARGS) +{ + + mt->fl &= ~MANT_LITERAL; + return(1); +} + + +/* ARGSUSED */ +static int +pre_nf(DECL_ARGS) +{ + + term_newln(p); + mt->fl |= MANT_LITERAL; + return(1); +} + + +/* ARGSUSED */ +static int pre_IR(DECL_ARGS) { const struct man_node *nn; @@ -188,12 +282,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, nn, m); + print_node(p, mt, nn, m); if ( ! (i % 2)) - p->flags &= ~TERMP_UNDER; + p->under--; } return(0); } @@ -207,11 +301,17 @@ pre_IB(DECL_ARGS) int i; for (i = 0, nn = n->child; nn; nn = nn->next, i++) { - p->flags |= i % 2 ? TERMP_BOLD : TERMP_UNDER; + if (i % 2) + p->bold++; + else + p->under++; if (i > 0) p->flags |= TERMP_NOSPACE; - print_node(p, nn, m); - p->flags &= i % 2 ? ~TERMP_BOLD : ~TERMP_UNDER; + print_node(p, mt, nn, m); + if (i % 2) + p->bold--; + else + p->under--; } return(0); } @@ -226,12 +326,12 @@ pre_RB(DECL_ARGS) for (i = 0, nn = n->child; nn; nn = nn->next, i++) { if (i % 2) - p->flags |= TERMP_BOLD; + p->bold++; if (i > 0) p->flags |= TERMP_NOSPACE; - print_node(p, nn, m); + print_node(p, mt, nn, m); if (i % 2) - p->flags &= ~TERMP_BOLD; + p->bold--; } return(0); } @@ -246,12 +346,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, nn, m); + print_node(p, mt, nn, m); if ( ! (i % 2)) - p->flags &= ~TERMP_UNDER; + p->under--; } return(0); } @@ -266,12 +366,12 @@ pre_BR(DECL_ARGS) for (i = 0, nn = n->child; nn; nn = nn->next, i++) { if ( ! (i % 2)) - p->flags |= TERMP_BOLD; + p->bold++; if (i > 0) p->flags |= TERMP_NOSPACE; - print_node(p, nn, m); + print_node(p, mt, nn, m); if ( ! (i % 2)) - p->flags &= ~TERMP_BOLD; + p->bold--; } return(0); } @@ -285,11 +385,17 @@ pre_BI(DECL_ARGS) int i; for (i = 0, nn = n->child; nn; nn = nn->next, i++) { - p->flags |= i % 2 ? TERMP_UNDER : TERMP_BOLD; + if (i % 2) + p->under++; + else + p->bold++; if (i > 0) p->flags |= TERMP_NOSPACE; - print_node(p, nn, m); - p->flags &= i % 2 ? ~TERMP_UNDER : ~TERMP_BOLD; + print_node(p, mt, nn, m); + if (i % 2) + p->under--; + else + p->bold--; } return(0); } @@ -300,7 +406,7 @@ static int pre_B(DECL_ARGS) { - p->flags |= TERMP_BOLD; + p->bold++; return(1); } @@ -310,12 +416,33 @@ static void post_B(DECL_ARGS) { - p->flags &= ~TERMP_BOLD; + p->bold--; } /* ARGSUSED */ static int +pre_sp(DECL_ARGS) +{ + int i, len; + + if (NULL == n->child) { + term_vspace(p); + return(0); + } + + len = atoi(n->child->string); + if (0 == len) + term_newln(p); + for (i = 0; i < len; i++) + term_vspace(p); + + return(0); +} + + +/* ARGSUSED */ +static int pre_br(DECL_ARGS) { @@ -326,107 +453,290 @@ pre_br(DECL_ARGS) /* ARGSUSED */ static int -pre_PP(DECL_ARGS) +pre_HP(DECL_ARGS) { + size_t len; + int ival; + const struct man_node *nn; - term_vspace(p); - term_vspace(p); - p->offset = INDENT; - p->flags |= TERMP_NOSPACE; - return(0); + 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)) + if ((ival = arg_width(nn)) >= 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_IP(DECL_ARGS) +pre_PP(DECL_ARGS) { - const struct man_node *nn; - size_t offs, sv; - int ival; - fmt_block_vspace(p, n); + switch (n->type) { + case (MAN_BLOCK): + mt->lmargin = INDENT; + fmt_block_vspace(p, n); + break; + default: + p->offset = mt->offset; + break; + } - p->flags |= TERMP_NOSPACE; + return(1); +} - sv = p->offset; - p->offset = INDENT; - if (NULL == n->child) +/* ARGSUSED */ +static int +pre_IP(DECL_ARGS) +{ + const struct man_node *nn; + size_t len; + int ival; + + 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. */ ; + if ((ival = arg_width(nn)) >= 0) + len = (size_t)ival; } - print_node(p, 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); + 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) { - 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) + if ((ival = arg_width(nn)) >= 0) + len = (size_t)ival; - for ( ; nn; nn = nn->next) - print_node(p, 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); + 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) { - term_vspace(p); - p->flags |= TERMP_BOLD; + switch (n->type) { + case (MAN_BLOCK): + 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->bold++; + p->offset = HALFINDENT; + break; + case (MAN_BODY): + p->offset = mt->offset; + break; + default: + break; + } + return(1); } @@ -436,9 +746,17 @@ static void post_SS(DECL_ARGS) { - term_flushln(p); - p->flags &= ~TERMP_BOLD; - p->flags |= TERMP_NOSPACE; + switch (n->type) { + case (MAN_HEAD): + term_newln(p); + p->bold--; + break; + case (MAN_BODY): + term_newln(p); + break; + default: + break; + } } @@ -447,9 +765,27 @@ static int pre_SH(DECL_ARGS) { - term_vspace(p); - p->offset = 0; - p->flags |= TERMP_BOLD; + 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->bold++; + p->offset = 0; + break; + case (MAN_BODY): + p->offset = mt->offset; + break; + default: + break; + } + return(1); } @@ -459,14 +795,71 @@ static void post_SH(DECL_ARGS) { - term_flushln(p); - p->offset = INDENT; - p->flags &= ~TERMP_BOLD; - p->flags |= TERMP_NOSPACE; + switch (n->type) { + case (MAN_HEAD): + term_newln(p); + p->bold--; + break; + case (MAN_BODY): + term_newln(p); + break; + default: + break; + } } +/* 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); + } + + if ((ival = arg_width(nn)) < 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; @@ -474,10 +867,6 @@ print_node(DECL_ARGS) c = 1; switch (n->type) { - case(MAN_ELEM): - if (termacts[n->tok].pre) - c = (*termacts[n->tok].pre)(p, n, m); - break; case(MAN_TEXT): if (0 == *n->string) { term_vspace(p); @@ -494,32 +883,35 @@ print_node(DECL_ARGS) 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 (termacts[n->tok].pre) + c = (*termacts[n->tok].pre)(p, mt, n, m); break; } if (c && n->child) - print_body(p, n->child, m); + print_body(p, mt, n->child, m); - switch (n->type) { - case (MAN_ELEM): + if (MAN_TEXT != n->type) if (termacts[n->tok].post) - (*termacts[n->tok].post)(p, n, m); - break; - default: - break; - } + (*termacts[n->tok].post)(p, mt, n, m); } static void print_body(DECL_ARGS) { - print_node(p, n, m); + + print_node(p, mt, n, m); if ( ! n->next) return; - print_body(p, n->next, m); + print_body(p, mt, n->next, m); } @@ -530,12 +922,12 @@ print_foot(struct termp *p, const struct man_meta *met char *buf; if (NULL == (buf = malloc(p->rmargin))) - err(1, "malloc"); + err(EXIT_FAILURE, "malloc"); tm = localtime(&meta->date); if (0 == strftime(buf, p->rmargin, "%B %d, %Y", tm)) - err(1, "strftime"); + err(EXIT_FAILURE, "strftime"); term_vspace(p); @@ -570,9 +962,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);