diff options
Diffstat (limited to 'usr.bin/mandoc/man_term.c')
| -rw-r--r-- | usr.bin/mandoc/man_term.c | 544 |
1 files changed, 458 insertions, 86 deletions
diff --git a/usr.bin/mandoc/man_term.c b/usr.bin/mandoc/man_term.c index 83bd34269e8..f5a62be77f1 100644 --- a/usr.bin/mandoc/man_term.c +++ b/usr.bin/mandoc/man_term.c @@ -1,4 +1,4 @@ -/* $Id: man_term.c,v 1.10 2009/08/22 18:10:02 schwarze Exp $ */ +/* $Id: man_term.c,v 1.11 2009/08/22 20:14:37 schwarze Exp $ */ /* * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se> * @@ -15,6 +15,7 @@ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ #include <assert.h> +#include <ctype.h> #include <err.h> #include <stdio.h> #include <stdlib.h> @@ -26,7 +27,14 @@ #define INDENT 7 #define HALFINDENT 3 +struct mtermp { + int fl; +#define MANT_LITERAL (1 << 0) + int lmargin; +}; + #define DECL_ARGS struct termp *p, \ + struct mtermp *mt, \ const struct man_node *n, \ const struct man_meta *m @@ -38,7 +46,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); @@ -49,23 +57,32 @@ static int pre_RI(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_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_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 */ @@ -77,35 +94,96 @@ static const struct termact termacts[MAN_MAX] = { { pre_I, post_I }, /* I */ { pre_IR, NULL }, /* IR */ { pre_RI, NULL }, /* RI */ - { NULL, NULL }, /* na */ - { pre_I, post_I }, /* i */ - { NULL, NULL }, /* sp */ + { NULL, NULL }, /* na */ /* TODO: document that has no effect */ + { pre_I, post_i }, /* i */ + { pre_sp, NULL }, /* sp */ + { pre_nf, NULL }, /* nf */ + { pre_fi, NULL }, /* fi */ + { pre_r, NULL }, /* r */ }; +#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) { + 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; + 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); } +static void +fmt_block_vspace(struct termp *p, const struct man_node *n) +{ + term_newln(p); + + if (NULL == n->prev) + return; + + if (MAN_SS == n->prev->tok) + return; + if (MAN_SH == n->prev->tok) + return; + + term_vspace(p); +} + + +static int +arg_width(const struct man_node *n) +{ + int i, len; + const char *p; + + assert(MAN_TEXT == n->type); + assert(n->string); + + p = n->string; + + if (0 == (len = (int)strlen(p))) + 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); +} + + /* ARGSUSED */ static int pre_I(DECL_ARGS) @@ -117,6 +195,27 @@ pre_I(DECL_ARGS) /* ARGSUSED */ +static int +pre_r(DECL_ARGS) +{ + + p->flags &= ~TERMP_UNDER; + p->flags &= ~TERMP_BOLD; + return(1); +} + + +/* ARGSUSED */ +static void +post_i(DECL_ARGS) +{ + + if (n->nchild) + p->flags &= ~TERMP_UNDER; +} + + +/* ARGSUSED */ static void post_I(DECL_ARGS) { @@ -127,6 +226,27 @@ post_I(DECL_ARGS) /* 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; @@ -137,7 +257,7 @@ pre_IR(DECL_ARGS) p->flags |= TERMP_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; } @@ -156,7 +276,7 @@ pre_IB(DECL_ARGS) p->flags |= i % 2 ? TERMP_BOLD : TERMP_UNDER; if (i > 0) p->flags |= TERMP_NOSPACE; - print_node(p, nn, m); + print_node(p, mt, nn, m); p->flags &= i % 2 ? ~TERMP_BOLD : ~TERMP_UNDER; } return(0); @@ -175,7 +295,7 @@ pre_RB(DECL_ARGS) p->flags |= TERMP_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; } @@ -195,7 +315,7 @@ pre_RI(DECL_ARGS) p->flags |= TERMP_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; } @@ -215,7 +335,7 @@ pre_BR(DECL_ARGS) p->flags |= TERMP_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; } @@ -234,7 +354,7 @@ pre_BI(DECL_ARGS) p->flags |= i % 2 ? TERMP_UNDER : TERMP_BOLD; if (i > 0) p->flags |= TERMP_NOSPACE; - print_node(p, nn, m); + print_node(p, mt, nn, m); p->flags &= i % 2 ? ~TERMP_UNDER : ~TERMP_BOLD; } return(0); @@ -262,6 +382,27 @@ post_B(DECL_ARGS) /* 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) { @@ -272,47 +413,173 @@ 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; + + 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 = (size_t)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; - term_vspace(p); p->offset = INDENT; - return(0); + p->rmargin = INDENT + len; + + if (ival >= 0) + mt->lmargin = 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 = INDENT; + p->rmargin = p->maxrmargin; + break; + default: + break; + } } /* ARGSUSED */ static int -pre_IP(DECL_ARGS) +pre_PP(DECL_ARGS) { -#if 0 - const struct man_node *nn; - size_t offs; -#endif - term_vspace(p); - p->offset = INDENT; + switch (n->type) { + case (MAN_BLOCK): + mt->lmargin = INDENT; + fmt_block_vspace(p, n); + break; + default: + p->offset = INDENT; + break; + } + + return(1); +} + -#if 0 - if (NULL == (nn = 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); - if (MAN_TEXT != nn->type) - errx(1, "expected text line argument"); + } - if (nn->next) { - if (MAN_TEXT != nn->next->type) - errx(1, "expected text line argument"); - offs = (size_t)atoi(nn->next->string); - } else - offs = strlen(nn->string); + len = (size_t)mt->lmargin; + ival = -1; - p->flags |= TERMP_NOSPACE; - /* FIXME */ - if ((p->offset += offs) > p->rmargin) - errx(1, "line too long"); -#endif + /* Calculate offset. */ - return(0); + 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; + } + + switch (n->type) { + case (MAN_HEAD): + /* Handle zero-width lengths. */ + if (0 == len) + len = 1; + + p->offset = INDENT; + p->rmargin = INDENT + len; + if (ival < 0) + break; + + /* Set the saved left-margin. */ + mt->lmargin = ival; + + /* 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 = INDENT + len; + p->rmargin = p->maxrmargin; + break; + default: + break; + } + + 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; + } } @@ -320,31 +587,85 @@ pre_IP(DECL_ARGS) 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; + + p->offset = INDENT; + p->rmargin = INDENT + 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 = ival; + + return(0); + case (MAN_BODY): + p->offset = INDENT + len; + p->rmargin = p->maxrmargin; + break; + default: + break; + } - term_flushln(p); - p->flags |= TERMP_NOSPACE; - p->offset += offs; - return(0); + 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; + } } @@ -353,8 +674,28 @@ static int pre_SS(DECL_ARGS) { - term_vspace(p); - p->flags |= TERMP_BOLD; + switch (n->type) { + case (MAN_BLOCK): + mt->lmargin = 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->offset = HALFINDENT; + break; + case (MAN_BODY): + p->offset = INDENT; + break; + default: + break; + } + return(1); } @@ -364,9 +705,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->flags &= ~TERMP_BOLD; + break; + case (MAN_BODY): + term_newln(p); + break; + default: + break; + } } @@ -375,9 +724,26 @@ 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; + /* 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->offset = 0; + break; + case (MAN_BODY): + p->offset = INDENT; + break; + default: + break; + } + return(1); } @@ -387,10 +753,17 @@ 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->flags &= ~TERMP_BOLD; + break; + case (MAN_BODY): + term_newln(p); + break; + default: + break; + } } @@ -402,10 +775,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); @@ -422,32 +791,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); } |