=================================================================== RCS file: /cvs/mandoc/man_term.c,v retrieving revision 1.2 retrieving revision 1.18 diff -u -p -r1.2 -r1.18 --- mandoc/man_term.c 2009/03/26 14:44:41 1.2 +++ mandoc/man_term.c 2009/08/10 10:09:51 1.18 @@ -1,22 +1,21 @@ -/* $Id: man_term.c,v 1.2 2009/03/26 14:44:41 kristaps Exp $ */ +/* $Id: man_term.c,v 1.18 2009/08/10 10:09:51 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 copyright notice and this permission notice appear in all - * copies. + * purpose with or without fee is hereby granted, provided that the above + * copyright notice and this permission notice appear in all copies. * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL - * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED - * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE - * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL - * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR - * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER - * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - * PERFORMANCE OF THIS SOFTWARE. + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + * 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 #include @@ -25,6 +24,9 @@ #include "term.h" #include "man.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); @@ -40,8 +42,16 @@ 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_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_SH(DECL_ARGS); static int pre_SS(DECL_ARGS); static int pre_TP(DECL_ARGS); @@ -52,7 +62,7 @@ static void post_SH(DECL_ARGS); static void post_SS(DECL_ARGS); static const struct termact termacts[MAN_MAX] = { - { NULL, NULL }, /* __ */ + { pre_br, NULL }, /* br */ { NULL, NULL }, /* TH */ { pre_SH, post_SH }, /* SH */ { pre_SS, post_SS }, /* SS */ @@ -60,19 +70,22 @@ static const struct termact termacts[MAN_MAX] = { { pre_PP, NULL }, /* LP */ { pre_PP, NULL }, /* PP */ { pre_PP, NULL }, /* P */ - { NULL, NULL }, /* IP */ - { pre_PP, NULL }, /* HP */ /* XXX */ + { pre_IP, NULL }, /* IP */ + { pre_PP, NULL }, /* HP */ /* FIXME */ { NULL, NULL }, /* SM */ { pre_B, post_B }, /* SB */ - { NULL, NULL }, /* BI */ - { NULL, NULL }, /* IB */ - { NULL, NULL }, /* BR */ - { NULL, NULL }, /* RB */ + { 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 */ - { NULL, NULL }, /* IR */ - { NULL, NULL }, /* RI */ + { pre_IR, NULL }, /* IR */ + { pre_RI, NULL }, /* RI */ + { NULL, NULL }, /* na */ + { pre_I, post_I }, /* i */ + { NULL, NULL }, /* sp */ }; static void print_head(struct termp *, @@ -81,6 +94,9 @@ 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 @@ -89,14 +105,63 @@ man_run(struct termp *p, const struct man *m) print_head(p, man_meta(m)); p->flags |= TERMP_NOSPACE; - print_body(p, man_node(m), man_meta(m)); + assert(man_node(m)); + assert(MAN_ROOT == man_node(m)->type); + if (man_node(m)->child) + print_body(p, 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) { @@ -105,6 +170,7 @@ pre_I(DECL_ARGS) } +/* ARGSUSED */ static void post_I(DECL_ARGS) { @@ -113,7 +179,124 @@ post_I(DECL_ARGS) } +/* 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, nn, m); + if ( ! (i % 2)) + p->flags &= ~TERMP_UNDER; + } + return(0); +} + + +/* 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, 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 > 0) + p->flags |= TERMP_NOSPACE; + print_node(p, nn, m); + if (i % 2) + p->flags &= ~TERMP_BOLD; + } + return(0); +} + + +/* ARGSUSED */ +static int +pre_RI(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, nn, m); + if ( ! (i % 2)) + p->flags &= ~TERMP_UNDER; + } + return(0); +} + + +/* 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, 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; + + for (i = 0, nn = n->child; nn; nn = nn->next, i++) { + p->flags |= i % 2 ? TERMP_UNDER : TERMP_BOLD; + if (i > 0) + p->flags |= TERMP_NOSPACE; + print_node(p, nn, m); + p->flags &= i % 2 ? ~TERMP_UNDER : ~TERMP_BOLD; + } + return(0); +} + + +/* ARGSUSED */ +static int pre_B(DECL_ARGS) { @@ -122,6 +305,7 @@ pre_B(DECL_ARGS) } +/* ARGSUSED */ static void post_B(DECL_ARGS) { @@ -130,23 +314,89 @@ post_B(DECL_ARGS) } +/* ARGSUSED */ static int +pre_br(DECL_ARGS) +{ + + term_newln(p); + return(0); +} + + +/* ARGSUSED */ +static int pre_PP(DECL_ARGS) { term_vspace(p); + term_vspace(p); p->offset = INDENT; + p->flags |= TERMP_NOSPACE; return(0); } +/* ARGSUSED */ static int +pre_IP(DECL_ARGS) +{ + const struct man_node *nn; + size_t offs, sv; + int ival; + + fmt_block_vspace(p, n); + + p->flags |= TERMP_NOSPACE; + + sv = p->offset; + p->offset = INDENT; + + if (NULL == n->child) + return(1); + + p->flags |= TERMP_NOBREAK; + + offs = sv; + + /* + * 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; + } + } + print_node(p, nn, m); + } + + p->rmargin = p->offset + offs; + + term_flushln(p); + + p->offset = offs; + p->rmargin = p->maxrmargin; + + p->flags |= TERMP_NOLPAD | TERMP_NOSPACE; + + return(0); +} + + +/* ARGSUSED */ +static int pre_TP(DECL_ARGS) { const struct man_node *nn; size_t offs; term_vspace(p); + p->offset = INDENT; if (NULL == (nn = n->child)) @@ -155,7 +405,7 @@ pre_TP(DECL_ARGS) if (nn->line == n->line) { if (MAN_TEXT != nn->type) errx(1, "expected text line argument"); - offs = atoi(nn->string); + offs = (size_t)atoi(nn->string); nn = nn->next; } else offs = INDENT; @@ -170,6 +420,7 @@ pre_TP(DECL_ARGS) } +/* ARGSUSED */ static int pre_SS(DECL_ARGS) { @@ -180,6 +431,7 @@ pre_SS(DECL_ARGS) } +/* ARGSUSED */ static void post_SS(DECL_ARGS) { @@ -190,6 +442,7 @@ post_SS(DECL_ARGS) } +/* ARGSUSED */ static int pre_SH(DECL_ARGS) { @@ -201,6 +454,7 @@ pre_SH(DECL_ARGS) } +/* ARGSUSED */ static void post_SH(DECL_ARGS) { @@ -215,7 +469,7 @@ post_SH(DECL_ARGS) static void print_node(DECL_ARGS) { - int c; + int c, sz; c = 1; @@ -225,11 +479,21 @@ print_node(DECL_ARGS) c = (*termacts[n->tok].pre)(p, n, m); break; case(MAN_TEXT): - if (*n->string) { - term_word(p, n->string); + if (0 == *n->string) { + term_vspace(p); break; } - term_vspace(p); + /* + * 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; break; default: break; @@ -270,20 +534,9 @@ print_foot(struct termp *p, const struct man_meta *met tm = localtime(&meta->date); -#ifdef __OpenBSD__ - if (NULL == strftime(buf, p->rmargin, "%B %d, %Y", tm)) -#else if (0 == strftime(buf, p->rmargin, "%B %d, %Y", tm)) -#endif err(1, "strftime"); - /* - * This is /slightly/ different from regular groff output - * because we don't have page numbers. Print the following: - * - * OS MDOCDATE - */ - term_vspace(p); p->flags |= TERMP_NOSPACE | TERMP_NOBREAK; @@ -321,19 +574,6 @@ print_head(struct termp *p, const struct man_meta *met if (NULL == (title = malloc(p->rmargin))) err(1, "malloc"); - /* - * The header is strange. It has three components, which are - * really two with the first duplicated. It goes like this: - * - * IDENTIFIER TITLE IDENTIFIER - * - * The IDENTIFIER is NAME(SECTION), which is the command-name - * (if given, or "unknown" if not) followed by the manual page - * section. These are given in `Dt'. The TITLE is a free-form - * string depending on the manual volume. If not specified, it - * switches on the manual section. - */ - if (meta->vol) (void)strlcpy(buf, meta->vol, p->rmargin); else @@ -343,7 +583,7 @@ print_head(struct termp *p, const struct man_meta *met meta->title, meta->msec); p->offset = 0; - p->rmargin = (p->maxrmargin - strlen(buf)) / 2; + p->rmargin = (p->maxrmargin - strlen(buf) + 1) / 2; p->flags |= TERMP_NOBREAK | TERMP_NOSPACE; term_word(p, title);