=================================================================== RCS file: /cvs/mandoc/man_term.c,v retrieving revision 1.26 retrieving revision 1.176 diff -u -p -r1.26 -r1.176 --- mandoc/man_term.c 2009/08/19 11:30:40 1.26 +++ mandoc/man_term.c 2015/04/04 18:52:51 1.176 @@ -1,490 +1,551 @@ -/* $Id: man_term.c,v 1.26 2009/08/19 11:30:40 kristaps Exp $ */ +/* $Id: man_term.c,v 1.176 2015/04/04 18:52:51 schwarze Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * Copyright (c) 2008-2012 Kristaps Dzonsons + * Copyright (c) 2010-2015 Ingo Schwarze * * 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. * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF - * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS 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 "config.h" + +#include + #include #include -#include +#include #include #include #include -#include "term.h" +#include "mandoc_aux.h" +#include "mandoc.h" +#include "roff.h" #include "man.h" +#include "out.h" +#include "term.h" +#include "main.h" -#define INDENT 7 -#define HALFINDENT 3 +#define MAXMARGINS 64 /* maximum number of indented scopes */ 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; + int lmargin[MAXMARGINS]; /* margins (incl. vis. page) */ + int lmargincur; /* index of current margin */ + int lmarginsz; /* actual number of nested margins */ + size_t offset; /* default offset to visible page */ + int pardist; /* vert. space before par., unit: [v] */ }; -#define DECL_ARGS struct termp *p, \ +#define DECL_ARGS struct termp *p, \ struct mtermp *mt, \ - const struct man_node *n, \ - const struct man_meta *m + struct roff_node *n, \ + const struct roff_meta *meta struct termact { int (*pre)(DECL_ARGS); void (*post)(DECL_ARGS); + int flags; +#define MAN_NOTEXT (1 << 0) /* Never has text children. */ }; +static void print_man_nodelist(DECL_ARGS); +static void print_man_node(DECL_ARGS); +static void print_man_head(struct termp *, + const struct roff_meta *); +static void print_man_foot(struct termp *, + const struct roff_meta *); +static void print_bvspace(struct termp *, + const struct roff_node *, int); + 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_OP(DECL_ARGS); +static int pre_PD(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_nf(DECL_ARGS); -static int pre_r(DECL_ARGS); +static int pre_UR(DECL_ARGS); +static int pre_alternate(DECL_ARGS); +static int pre_ft(DECL_ARGS); +static int pre_ign(DECL_ARGS); +static int pre_in(DECL_ARGS); +static int pre_literal(DECL_ARGS); +static int pre_ll(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 void post_UR(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 */ /* 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 */ - { NULL, NULL }, /* RE */ - { pre_RS, post_RS }, /* RS */ +static const struct termact termacts[MAN_MAX] = { + { pre_sp, 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_alternate, NULL, 0 }, /* BI */ + { pre_alternate, NULL, 0 }, /* IB */ + { pre_alternate, NULL, 0 }, /* BR */ + { pre_alternate, NULL, 0 }, /* RB */ + { NULL, NULL, 0 }, /* R */ + { pre_B, NULL, 0 }, /* B */ + { pre_I, NULL, 0 }, /* I */ + { pre_alternate, NULL, 0 }, /* IR */ + { pre_alternate, NULL, 0 }, /* RI */ + { pre_sp, NULL, MAN_NOTEXT }, /* sp */ + { pre_literal, NULL, 0 }, /* nf */ + { pre_literal, NULL, 0 }, /* fi */ + { NULL, NULL, 0 }, /* RE */ + { pre_RS, post_RS, 0 }, /* RS */ + { pre_ign, NULL, 0 }, /* DT */ + { pre_ign, NULL, MAN_NOTEXT }, /* UC */ + { pre_PD, NULL, MAN_NOTEXT }, /* PD */ + { pre_ign, NULL, 0 }, /* AT */ + { pre_in, NULL, MAN_NOTEXT }, /* in */ + { pre_ft, NULL, MAN_NOTEXT }, /* ft */ + { pre_OP, NULL, 0 }, /* OP */ + { pre_literal, NULL, 0 }, /* EX */ + { pre_literal, NULL, 0 }, /* EE */ + { pre_UR, post_UR, 0 }, /* UR */ + { NULL, NULL, 0 }, /* UE */ + { pre_ll, NULL, MAN_NOTEXT }, /* ll */ }; -#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 *); +void +terminal_man(void *arg, const struct man *man) +{ + struct termp *p; + const struct roff_meta *meta; + struct roff_node *n; + struct mtermp mt; + p = (struct termp *)arg; -int -man_run(struct termp *p, const struct man *m) -{ - struct mtermp mt; + p->overstep = 0; + p->rmargin = p->maxrmargin = p->defrmargin; + p->tabwidth = term_len(p, 5); - print_head(p, man_meta(m)); - p->flags |= TERMP_NOSPACE; - assert(man_node(m)); - assert(MAN_ROOT == man_node(m)->type); + n = man_node(man)->child; + meta = man_meta(man); - mt.fl = 0; - mt.lmargin = INDENT; - mt.offset = INDENT; + memset(&mt, 0, sizeof(struct mtermp)); - if (man_node(m)->child) - print_body(p, &mt, man_node(m)->child, man_meta(m)); - print_foot(p, man_meta(m)); + mt.lmargin[mt.lmargincur] = term_len(p, p->defindent); + mt.offset = term_len(p, p->defindent); + mt.pardist = 1; - return(1); + if (p->synopsisonly) { + while (n != NULL) { + if (n->tok == MAN_SH && + n->child->child->type == ROFFT_TEXT && + !strcmp(n->child->child->string, "SYNOPSIS")) { + if (n->child->next->child != NULL) + print_man_nodelist(p, &mt, + n->child->next->child, meta); + term_newln(p); + break; + } + n = n->next; + } + } else { + if (p->defindent == 0) + p->defindent = 7; + term_begin(p, print_man_head, print_man_foot, meta); + p->flags |= TERMP_NOSPACE; + if (n != NULL) + print_man_nodelist(p, &mt, n, meta); + term_end(p); + } } - +/* + * Printing leading vertical space before a block. + * This is used for the paragraph macros. + * The rules are pretty simple, since there's very little nesting going + * on here. Basically, if we're the first within another block (SS/SH), + * then don't emit vertical space. If we are (RS), then do. If not the + * first, print it. + */ static void -fmt_block_vspace(struct termp *p, const struct man_node *n) +print_bvspace(struct termp *p, const struct roff_node *n, int pardist) { + int i; + term_newln(p); - if (NULL == n->prev) - return; + if (n->body && n->body->child) + if (n->body->child->type == ROFFT_TBL) + return; - if (MAN_SS == n->prev->tok) - return; - if (MAN_SH == n->prev->tok) - return; + if (n->parent->type == ROFFT_ROOT || n->parent->tok != MAN_RS) + if (NULL == n->prev) + return; - term_vspace(p); + for (i = 0; i < pardist; i++) + term_vspace(p); } static int -arg_width(const struct man_node *n) +pre_ign(DECL_ARGS) { - 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); + return(0); } - -/* ARGSUSED */ static int -pre_I(DECL_ARGS) +pre_ll(DECL_ARGS) { - p->flags |= TERMP_UNDER; - return(1); + term_setwidth(p, n->nchild ? n->child->string : NULL); + return(0); } - -/* ARGSUSED */ static int -pre_r(DECL_ARGS) +pre_I(DECL_ARGS) { - p->flags &= ~TERMP_UNDER; - p->flags &= ~TERMP_BOLD; + term_fontrepl(p, TERMFONT_UNDER); return(1); } - -/* ARGSUSED */ -static void -post_i(DECL_ARGS) +static int +pre_literal(DECL_ARGS) { - if (n->nchild) - p->flags &= ~TERMP_UNDER; -} + term_newln(p); + if (MAN_nf == n->tok || MAN_EX == n->tok) + mt->fl |= MANT_LITERAL; + else + mt->fl &= ~MANT_LITERAL; -/* ARGSUSED */ -static void -post_I(DECL_ARGS) -{ + /* + * Unlike .IP and .TP, .HP does not have a HEAD. + * So in case a second call to term_flushln() is needed, + * indentation has to be set up explicitly. + */ + if (MAN_HP == n->parent->tok && p->rmargin < p->maxrmargin) { + p->offset = p->rmargin; + p->rmargin = p->maxrmargin; + p->trailspace = 0; + p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND); + p->flags |= TERMP_NOSPACE; + } - p->flags &= ~TERMP_UNDER; + return(0); } - -/* ARGSUSED */ static int -pre_fi(DECL_ARGS) +pre_PD(DECL_ARGS) { + struct roffsu su; - mt->fl &= ~MANT_LITERAL; - return(1); + n = n->child; + if (n == NULL) { + mt->pardist = 1; + return(0); + } + assert(n->type == ROFFT_TEXT); + if (a2roffsu(n->string, &su, SCALE_VS)) + mt->pardist = term_vspan(p, &su); + return(0); } - -/* ARGSUSED */ static int -pre_nf(DECL_ARGS) +pre_alternate(DECL_ARGS) { + enum termfont font[2]; + struct roff_node *nn; + int savelit, i; - term_newln(p); - mt->fl |= MANT_LITERAL; - return(1); -} + switch (n->tok) { + case MAN_RB: + font[0] = TERMFONT_NONE; + font[1] = TERMFONT_BOLD; + break; + case MAN_RI: + font[0] = TERMFONT_NONE; + font[1] = TERMFONT_UNDER; + break; + case MAN_BR: + font[0] = TERMFONT_BOLD; + font[1] = TERMFONT_NONE; + break; + case MAN_BI: + font[0] = TERMFONT_BOLD; + font[1] = TERMFONT_UNDER; + break; + case MAN_IR: + font[0] = TERMFONT_UNDER; + font[1] = TERMFONT_NONE; + break; + case MAN_IB: + font[0] = TERMFONT_UNDER; + font[1] = TERMFONT_BOLD; + break; + default: + abort(); + } + savelit = MANT_LITERAL & mt->fl; + mt->fl &= ~MANT_LITERAL; -/* 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) + for (i = 0, nn = n->child; nn; nn = nn->next, i = 1 - i) { + term_fontrepl(p, font[i]); + if (savelit && NULL == nn->next) + mt->fl |= MANT_LITERAL; + print_man_node(p, mt, nn, meta); + if (nn->next) p->flags |= TERMP_NOSPACE; - print_node(p, mt, nn, m); - if ( ! (i % 2)) - p->flags &= ~TERMP_UNDER; } + return(0); } - -/* ARGSUSED */ static int -pre_IB(DECL_ARGS) +pre_B(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); + term_fontrepl(p, TERMFONT_BOLD); + return(1); } - -/* ARGSUSED */ static int -pre_RB(DECL_ARGS) +pre_OP(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; + term_word(p, "["); + p->flags |= TERMP_NOSPACE; + + if (NULL != (n = n->child)) { + term_fontrepl(p, TERMFONT_BOLD); + term_word(p, n->string); } + if (NULL != n && NULL != n->next) { + term_fontrepl(p, TERMFONT_UNDER); + term_word(p, n->next->string); + } + + term_fontrepl(p, TERMFONT_NONE); + p->flags |= TERMP_NOSPACE; + term_word(p, "]"); return(0); } - -/* ARGSUSED */ static int -pre_RI(DECL_ARGS) +pre_ft(DECL_ARGS) { - const struct man_node *nn; - int i; + const char *cp; - 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; + if (NULL == n->child) { + term_fontlast(p); + return(0); } - 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, mt, nn, m); - if ( ! (i % 2)) - p->flags &= ~TERMP_BOLD; + cp = n->child->string; + switch (*cp) { + case '4': + /* FALLTHROUGH */ + case '3': + /* FALLTHROUGH */ + case 'B': + term_fontrepl(p, TERMFONT_BOLD); + break; + case '2': + /* FALLTHROUGH */ + case 'I': + term_fontrepl(p, TERMFONT_UNDER); + break; + case 'P': + term_fontlast(p); + break; + case '1': + /* FALLTHROUGH */ + case 'C': + /* FALLTHROUGH */ + case 'R': + term_fontrepl(p, TERMFONT_NONE); + break; + default: + break; } return(0); } - -/* ARGSUSED */ static int -pre_BI(DECL_ARGS) +pre_in(DECL_ARGS) { - const struct man_node *nn; - int i; + struct roffsu su; + const char *cp; + size_t v; + int less; - 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, mt, nn, m); - p->flags &= i % 2 ? ~TERMP_UNDER : ~TERMP_BOLD; + term_newln(p); + + if (NULL == n->child) { + p->offset = mt->offset; + return(0); } - return(0); -} + cp = n->child->string; + less = 0; -/* ARGSUSED */ -static int -pre_B(DECL_ARGS) -{ + if ('-' == *cp) + less = -1; + else if ('+' == *cp) + less = 1; + else + cp--; - p->flags |= TERMP_BOLD; - return(1); -} + if ( ! a2roffsu(++cp, &su, SCALE_EN)) + return(0); + v = (term_hspan(p, &su) + 11) / 24; -/* ARGSUSED */ -static void -post_B(DECL_ARGS) -{ + if (less < 0) + p->offset -= p->offset > v ? v : p->offset; + else if (less > 0) + p->offset += v; + else + p->offset = v; + if (p->offset > SHRT_MAX) + p->offset = term_len(p, p->defindent); - p->flags &= ~TERMP_BOLD; + return(0); } - -/* ARGSUSED */ static int pre_sp(DECL_ARGS) { + struct roffsu su; int i, len; - if (NULL == n->child) { - term_vspace(p); - return(0); + if ((NULL == n->prev && n->parent)) { + switch (n->parent->tok) { + case MAN_SH: + /* FALLTHROUGH */ + case MAN_SS: + /* FALLTHROUGH */ + case MAN_PP: + /* FALLTHROUGH */ + case MAN_LP: + /* FALLTHROUGH */ + case MAN_P: + /* FALLTHROUGH */ + return(0); + default: + break; + } } - len = atoi(n->child->string); - if (0 == len) + if (n->tok == MAN_br) + len = 0; + else if (n->child == NULL) + len = 1; + else { + if ( ! a2roffsu(n->child->string, &su, SCALE_VS)) + su.scale = 1.0; + len = term_vspan(p, &su); + } + + if (len == 0) term_newln(p); - for (i = 0; i < len; i++) - term_vspace(p); + else if (len < 0) + p->skipvsp -= len; + else + for (i = 0; i < len; i++) + term_vspace(p); return(0); } - -/* ARGSUSED */ static int -pre_br(DECL_ARGS) -{ - - term_newln(p); - return(0); -} - - -/* ARGSUSED */ -static int pre_HP(DECL_ARGS) { - size_t len; - int ival; - const struct man_node *nn; + struct roffsu su; + const struct roff_node *nn; + int len; switch (n->type) { - case (MAN_BLOCK): - fmt_block_vspace(p, n); + case ROFFT_BLOCK: + print_bvspace(p, n, mt->pardist); return(1); - case (MAN_BODY): - p->flags |= TERMP_NOBREAK; - p->flags |= TERMP_TWOSPACE; + case ROFFT_BODY: break; default: return(0); } - len = mt->lmargin; - ival = -1; + if ( ! (MANT_LITERAL & mt->fl)) { + p->flags |= TERMP_NOBREAK | TERMP_BRIND; + p->trailspace = 2; + } /* Calculate offset. */ - if (NULL != (nn = n->parent->head->child)) - if ((ival = arg_width(nn)) >= 0) - len = (size_t)ival; + if ((nn = n->parent->head->child) != NULL && + a2roffsu(nn->string, &su, SCALE_EN)) { + len = term_hspan(p, &su) / 24; + if (len < 0 && (size_t)(-len) > mt->offset) + len = -mt->offset; + else if (len > SHRT_MAX) + len = term_len(p, p->defindent); + mt->lmargin[mt->lmargincur] = len; + } else + len = mt->lmargin[mt->lmargincur]; - 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; + case ROFFT_BODY: + term_newln(p); + + /* + * Compatibility with a groff bug. + * The .HP macro uses the undocumented .tag request + * which causes a line break and cancels no-space + * mode even if there isn't any output. + */ + + if (n->child == NULL) + term_vspace(p); + + p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND); + p->trailspace = 0; p->offset = mt->offset; p->rmargin = p->maxrmargin; break; @@ -493,82 +554,74 @@ post_HP(DECL_ARGS) } } - -/* ARGSUSED */ static int pre_PP(DECL_ARGS) { switch (n->type) { - case (MAN_BLOCK): - mt->lmargin = INDENT; - fmt_block_vspace(p, n); + case ROFFT_BLOCK: + mt->lmargin[mt->lmargincur] = term_len(p, p->defindent); + print_bvspace(p, n, mt->pardist); break; default: p->offset = mt->offset; break; } - return(1); + return(n->type != ROFFT_HEAD); } - -/* ARGSUSED */ static int pre_IP(DECL_ARGS) { - const struct man_node *nn; - size_t len; - int ival; + struct roffsu su; + const struct roff_node *nn; + int len, savelit; switch (n->type) { - case (MAN_BODY): - p->flags |= TERMP_NOLPAD; + case ROFFT_BODY: p->flags |= TERMP_NOSPACE; break; - case (MAN_HEAD): + case ROFFT_HEAD: p->flags |= TERMP_NOBREAK; - p->flags |= TERMP_TWOSPACE; + p->trailspace = 1; break; - case (MAN_BLOCK): - fmt_block_vspace(p, n); + case ROFFT_BLOCK: + print_bvspace(p, n, mt->pardist); /* FALLTHROUGH */ default: return(1); } - len = mt->lmargin; - ival = -1; + /* Calculate the offset from the optional second argument. */ + if ((nn = n->parent->head->child) != NULL && + (nn = nn->next) != NULL && + a2roffsu(nn->string, &su, SCALE_EN)) { + len = term_hspan(p, &su) / 24; + if (len < 0 && (size_t)(-len) > mt->offset) + len = -mt->offset; + else if (len > SHRT_MAX) + len = term_len(p, p->defindent); + mt->lmargin[mt->lmargincur] = len; + } else + len = mt->lmargin[mt->lmargincur]; - /* Calculate offset. */ - - 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; - + case ROFFT_HEAD: p->offset = mt->offset; p->rmargin = mt->offset + len; - if (ival < 0) - break; - /* Set the saved left-margin. */ - mt->lmargin = (size_t)ival; + savelit = MANT_LITERAL & mt->fl; + mt->fl &= ~MANT_LITERAL; - /* Don't print the length value. */ - for (nn = n->child; nn->next; nn = nn->next) - print_node(p, mt, nn, m); + if (n->child) + print_man_node(p, mt, n->child, meta); + + if (savelit) + mt->fl |= MANT_LITERAL; + return(0); - case (MAN_BODY): + case ROFFT_BODY: p->offset = mt->offset + len; p->rmargin = p->maxrmargin; break; @@ -579,84 +632,88 @@ pre_IP(DECL_ARGS) return(1); } - -/* ARGSUSED */ static void post_IP(DECL_ARGS) { switch (n->type) { - case (MAN_HEAD): + case ROFFT_HEAD: term_flushln(p); p->flags &= ~TERMP_NOBREAK; - p->flags &= ~TERMP_TWOSPACE; + p->trailspace = 0; p->rmargin = p->maxrmargin; break; - case (MAN_BODY): - term_flushln(p); - p->flags &= ~TERMP_NOLPAD; + case ROFFT_BODY: + term_newln(p); + p->offset = mt->offset; break; default: break; } } - -/* ARGSUSED */ static int pre_TP(DECL_ARGS) { - const struct man_node *nn; - size_t len; - int ival; + struct roffsu su; + struct roff_node *nn; + int len, savelit; switch (n->type) { - case (MAN_HEAD): + case ROFFT_HEAD: p->flags |= TERMP_NOBREAK; - p->flags |= TERMP_TWOSPACE; + p->trailspace = 1; break; - case (MAN_BODY): - p->flags |= TERMP_NOLPAD; + case ROFFT_BODY: p->flags |= TERMP_NOSPACE; break; - case (MAN_BLOCK): - fmt_block_vspace(p, n); + case ROFFT_BLOCK: + print_bvspace(p, n, mt->pardist); /* FALLTHROUGH */ default: return(1); } - len = (size_t)mt->lmargin; - ival = -1; - /* Calculate offset. */ - if (NULL != (nn = n->parent->head->child)) - if (NULL != nn->next) - if ((ival = arg_width(nn)) >= 0) - len = (size_t)ival; + if ((nn = n->parent->head->child) != NULL && + nn->string != NULL && ! (MAN_LINE & nn->flags) && + a2roffsu(nn->string, &su, SCALE_EN)) { + len = term_hspan(p, &su) / 24; + if (len < 0 && (size_t)(-len) > mt->offset) + len = -mt->offset; + else if (len > SHRT_MAX) + len = term_len(p, p->defindent); + mt->lmargin[mt->lmargincur] = len; + } else + len = mt->lmargin[mt->lmargincur]; switch (n->type) { - case (MAN_HEAD): - /* Handle zero-length properly. */ - if (0 == len) - len = 1; - + case ROFFT_HEAD: p->offset = mt->offset; p->rmargin = mt->offset + len; + savelit = MANT_LITERAL & mt->fl; + mt->fl &= ~MANT_LITERAL; + /* 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); + nn = n->child; + while (NULL != nn && 0 == (MAN_LINE & nn->flags)) + nn = nn->next; - if (ival >= 0) - mt->lmargin = (size_t)ival; + while (NULL != nn) { + print_man_node(p, mt, nn, meta); + nn = nn->next; + } + if (savelit) + mt->fl |= MANT_LITERAL; return(0); - case (MAN_BODY): + case ROFFT_BODY: p->offset = mt->offset + len; p->rmargin = p->maxrmargin; + p->trailspace = 0; + p->flags &= ~TERMP_NOBREAK; break; default: break; @@ -665,52 +722,61 @@ pre_TP(DECL_ARGS) return(1); } - -/* ARGSUSED */ static void post_TP(DECL_ARGS) { switch (n->type) { - case (MAN_HEAD): + case ROFFT_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; + case ROFFT_BODY: + term_newln(p); + p->offset = mt->offset; break; default: break; } } - -/* ARGSUSED */ static int pre_SS(DECL_ARGS) { + int i; 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) + case ROFFT_BLOCK: + mt->fl &= ~MANT_LITERAL; + mt->lmargin[mt->lmargincur] = term_len(p, p->defindent); + mt->offset = term_len(p, p->defindent); + + /* + * No vertical space before the first subsection + * and after an empty subsection. + */ + + do { + n = n->prev; + } while (n != NULL && n->tok != MAN_MAX && + termacts[n->tok].flags & MAN_NOTEXT); + if (n == NULL || (n->tok == MAN_SS && n->body->child == NULL)) break; - term_vspace(p); + + for (i = 0; i < mt->pardist; i++) + term_vspace(p); break; - case (MAN_HEAD): - p->flags |= TERMP_BOLD; - p->offset = HALFINDENT; + case ROFFT_HEAD: + term_fontrepl(p, TERMFONT_BOLD); + p->offset = term_len(p, 3); + p->rmargin = mt->offset; + p->trailspace = mt->offset; + p->flags |= TERMP_NOBREAK | TERMP_BRIND; break; - case (MAN_BODY): + case ROFFT_BODY: p->offset = mt->offset; + p->rmargin = p->maxrmargin; + p->trailspace = 0; + p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND); break; default: break; @@ -719,18 +785,15 @@ pre_SS(DECL_ARGS) return(1); } - -/* ARGSUSED */ static void post_SS(DECL_ARGS) { - + switch (n->type) { - case (MAN_HEAD): + case ROFFT_HEAD: term_newln(p); - p->flags &= ~TERMP_BOLD; break; - case (MAN_BODY): + case ROFFT_BODY: term_newln(p); break; default: @@ -738,28 +801,43 @@ post_SS(DECL_ARGS) } } - -/* ARGSUSED */ static int pre_SH(DECL_ARGS) { + int i; 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); + case ROFFT_BLOCK: + mt->fl &= ~MANT_LITERAL; + mt->lmargin[mt->lmargincur] = term_len(p, p->defindent); + mt->offset = term_len(p, p->defindent); + + /* + * No vertical space before the first section + * and after an empty section. + */ + + do { + n = n->prev; + } while (n != NULL && termacts[n->tok].flags & MAN_NOTEXT); + if (n == NULL || (n->tok == MAN_SH && n->body->child == NULL)) + break; + + for (i = 0; i < mt->pardist; i++) + term_vspace(p); break; - case (MAN_HEAD): - p->flags |= TERMP_BOLD; + case ROFFT_HEAD: + term_fontrepl(p, TERMFONT_BOLD); p->offset = 0; + p->rmargin = mt->offset; + p->trailspace = mt->offset; + p->flags |= TERMP_NOBREAK | TERMP_BRIND; break; - case (MAN_BODY): + case ROFFT_BODY: p->offset = mt->offset; + p->rmargin = p->maxrmargin; + p->trailspace = 0; + p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND); break; default: break; @@ -768,18 +846,15 @@ pre_SH(DECL_ARGS) return(1); } - -/* ARGSUSED */ static void post_SH(DECL_ARGS) { - + switch (n->type) { - case (MAN_HEAD): + case ROFFT_HEAD: term_newln(p); - p->flags &= ~TERMP_BOLD; break; - case (MAN_BODY): + case ROFFT_BODY: term_newln(p); break; default: @@ -787,199 +862,314 @@ post_SH(DECL_ARGS) } } - -/* ARGSUSED */ static int pre_RS(DECL_ARGS) { - const struct man_node *nn; - int ival; + struct roffsu su; switch (n->type) { - case (MAN_BLOCK): + case ROFFT_BLOCK: term_newln(p); return(1); - case (MAN_HEAD): + case ROFFT_HEAD: return(0); default: break; } - if (NULL == (nn = n->parent->head->child)) { - mt->offset = mt->lmargin + INDENT; - p->offset = mt->offset; - return(1); - } + n = n->parent->head; + n->aux = SHRT_MAX + 1; + if (n->child != NULL && a2roffsu(n->child->string, &su, SCALE_EN)) + n->aux = term_hspan(p, &su) / 24; + if (n->aux < 0 && (size_t)(-n->aux) > mt->offset) + n->aux = -mt->offset; + else if (n->aux > SHRT_MAX) + n->aux = term_len(p, p->defindent); - if ((ival = arg_width(nn)) < 0) - return(1); - - mt->offset = INDENT + (size_t)ival; + mt->offset += n->aux; p->offset = mt->offset; + p->rmargin = p->maxrmargin; + if (++mt->lmarginsz < MAXMARGINS) + mt->lmargincur = mt->lmarginsz; + + mt->lmargin[mt->lmargincur] = mt->lmargin[mt->lmargincur - 1]; return(1); } - -/* ARGSUSED */ static void post_RS(DECL_ARGS) { switch (n->type) { - case (MAN_BLOCK): - mt->offset = mt->lmargin = INDENT; - break; + case ROFFT_BLOCK: + return; + case ROFFT_HEAD: + return; default: term_newln(p); - p->offset = INDENT; break; } + + mt->offset -= n->parent->head->aux; + p->offset = mt->offset; + + if (--mt->lmarginsz < MAXMARGINS) + mt->lmargincur = mt->lmarginsz; } +static int +pre_UR(DECL_ARGS) +{ + return (n->type != ROFFT_HEAD); +} + static void -print_node(DECL_ARGS) +post_UR(DECL_ARGS) { - int c, sz; - c = 1; + if (n->type != ROFFT_BLOCK) + return; + term_word(p, "<"); + p->flags |= TERMP_NOSPACE; + + if (NULL != n->child->child) + print_man_node(p, mt, n->child->child, meta); + + p->flags |= TERMP_NOSPACE; + term_word(p, ">"); +} + +static void +print_man_node(DECL_ARGS) +{ + size_t rm, rmax; + int c; + switch (n->type) { - case(MAN_TEXT): - if (0 == *n->string) { - term_vspace(p); - break; - } + case ROFFT_TEXT: /* - * 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. + * If we have a blank line, output a vertical space. + * If we have a space as the first character, break + * before printing the line's data. */ - sz = (int)strlen(n->string); + if ('\0' == *n->string) { + term_vspace(p); + return; + } else if (' ' == *n->string && MAN_LINE & n->flags) + term_newln(p); + term_word(p, n->string); - if (sz >= 2 && n->string[sz - 1] == 'c' && - n->string[sz - 2] == '\\') + goto out; + + case ROFFT_EQN: + if ( ! (n->flags & MAN_LINE)) p->flags |= TERMP_NOSPACE; - /* FIXME: this means that macro lines are munged! */ - if (MANT_LITERAL & mt->fl) { + term_eqn(p, n->eqn); + if (n->next != NULL && ! (n->next->flags & MAN_LINE)) p->flags |= TERMP_NOSPACE; - term_flushln(p); - } - break; + return; + case ROFFT_TBL: + if (p->tbl.cols == NULL) + term_vspace(p); + term_tbl(p, n->span); + return; default: - if (termacts[n->tok].pre) - c = (*termacts[n->tok].pre)(p, mt, n, m); break; } + if ( ! (MAN_NOTEXT & termacts[n->tok].flags)) + term_fontrepl(p, TERMFONT_NONE); + + c = 1; + if (termacts[n->tok].pre) + c = (*termacts[n->tok].pre)(p, mt, n, meta); + if (c && n->child) - print_body(p, mt, n->child, m); + print_man_nodelist(p, mt, n->child, meta); - if (MAN_TEXT != n->type) - if (termacts[n->tok].post) - (*termacts[n->tok].post)(p, mt, n, m); + if (termacts[n->tok].post) + (*termacts[n->tok].post)(p, mt, n, meta); + if ( ! (MAN_NOTEXT & termacts[n->tok].flags)) + term_fontrepl(p, TERMFONT_NONE); + +out: + /* + * If we're in a literal context, make sure that words + * together on the same line stay together. This is a + * POST-printing call, so we check the NEXT word. Since + * -man doesn't have nested macros, we don't need to be + * more specific than this. + */ + if (mt->fl & MANT_LITERAL && + ! (p->flags & (TERMP_NOBREAK | TERMP_NONEWLINE)) && + (n->next == NULL || n->next->flags & MAN_LINE)) { + rm = p->rmargin; + rmax = p->maxrmargin; + p->rmargin = p->maxrmargin = TERM_MAXMARGIN; + p->flags |= TERMP_NOSPACE; + if (n->string != NULL && *n->string != '\0') + term_flushln(p); + else + term_newln(p); + if (rm < rmax && n->parent->tok == MAN_HP) { + p->offset = rm; + p->rmargin = rmax; + } else + p->rmargin = rm; + p->maxrmargin = rmax; + } + if (MAN_EOS & n->flags) + p->flags |= TERMP_SENTENCE; } static void -print_body(DECL_ARGS) +print_man_nodelist(DECL_ARGS) { - print_node(p, mt, n, m); - if ( ! n->next) - return; - print_body(p, mt, n->next, m); + while (n != NULL) { + print_man_node(p, mt, n, meta); + n = n->next; + } } - static void -print_foot(struct termp *p, const struct man_meta *meta) +print_man_foot(struct termp *p, const struct roff_meta *meta) { - struct tm *tm; - char *buf; + char *title; + size_t datelen, titlen; - if (NULL == (buf = malloc(p->rmargin))) - err(1, "malloc"); + assert(meta->title); + assert(meta->msec); + assert(meta->date); - tm = localtime(&meta->date); + term_fontrepl(p, TERMFONT_NONE); - if (0 == strftime(buf, p->rmargin, "%B %d, %Y", tm)) - err(1, "strftime"); + if (meta->hasbody) + term_vspace(p); - term_vspace(p); + /* + * Temporary, undocumented option to imitate mdoc(7) output. + * In the bottom right corner, use the operating system + * instead of the title. + */ + if ( ! p->mdocstyle) { + if (meta->hasbody) { + term_vspace(p); + term_vspace(p); + } + mandoc_asprintf(&title, "%s(%s)", + meta->title, meta->msec); + } else if (meta->os) { + title = mandoc_strdup(meta->os); + } else { + title = mandoc_strdup(""); + } + datelen = term_strlen(p, meta->date); + + /* Bottom left corner: operating system. */ + p->flags |= TERMP_NOSPACE | TERMP_NOBREAK; - p->rmargin = p->maxrmargin - strlen(buf); + p->trailspace = 1; p->offset = 0; + p->rmargin = p->maxrmargin > datelen ? + (p->maxrmargin + term_len(p, 1) - datelen) / 2 : 0; - if (meta->source) - term_word(p, meta->source); - if (meta->source) - term_word(p, ""); + if (meta->os) + term_word(p, meta->os); term_flushln(p); - p->flags |= TERMP_NOLPAD | TERMP_NOSPACE; + /* At the bottom in the middle: manual date. */ + p->offset = p->rmargin; - p->rmargin = p->maxrmargin; - p->flags &= ~TERMP_NOBREAK; + titlen = term_strlen(p, title); + p->rmargin = p->maxrmargin > titlen ? p->maxrmargin - titlen : 0; + p->flags |= TERMP_NOSPACE; - term_word(p, buf); + term_word(p, meta->date); term_flushln(p); - free(buf); -} + /* Bottom right corner: manual title and section. */ + p->flags &= ~TERMP_NOBREAK; + p->flags |= TERMP_NOSPACE; + p->trailspace = 0; + p->offset = p->rmargin; + p->rmargin = p->maxrmargin; + term_word(p, title); + term_flushln(p); + free(title); +} + static void -print_head(struct termp *p, const struct man_meta *meta) +print_man_head(struct termp *p, const struct roff_meta *meta) { - char *buf, *title; + const char *volume; + char *title; + size_t vollen, titlen; - p->rmargin = p->maxrmargin; - p->offset = 0; + assert(meta->title); + assert(meta->msec); - if (NULL == (buf = malloc(p->rmargin))) - err(1, "malloc"); - if (NULL == (title = malloc(p->rmargin))) - err(1, "malloc"); + volume = NULL == meta->vol ? "" : meta->vol; + vollen = term_strlen(p, volume); - if (meta->vol) - (void)strlcpy(buf, meta->vol, p->rmargin); - else - *buf = 0; + /* Top left corner: manual title and section. */ - (void)snprintf(title, p->rmargin, "%s(%d)", - meta->title, meta->msec); + mandoc_asprintf(&title, "%s(%s)", meta->title, meta->msec); + titlen = term_strlen(p, title); - p->offset = 0; - p->rmargin = (p->maxrmargin - strlen(buf) + 1) / 2; p->flags |= TERMP_NOBREAK | TERMP_NOSPACE; + p->trailspace = 1; + p->offset = 0; + p->rmargin = 2 * (titlen+1) + vollen < p->maxrmargin ? + (p->maxrmargin - vollen + term_len(p, 1)) / 2 : + vollen < p->maxrmargin ? p->maxrmargin - vollen : 0; term_word(p, title); term_flushln(p); - p->flags |= TERMP_NOLPAD | TERMP_NOSPACE; + /* At the top in the middle: manual volume. */ + + p->flags |= TERMP_NOSPACE; p->offset = p->rmargin; - p->rmargin = p->maxrmargin - strlen(title); + p->rmargin = p->offset + vollen + titlen < p->maxrmargin ? + p->maxrmargin - titlen : p->maxrmargin; - term_word(p, buf); + term_word(p, volume); term_flushln(p); - p->offset = p->rmargin; - p->rmargin = p->maxrmargin; + /* Top right corner: title and section, again. */ + p->flags &= ~TERMP_NOBREAK; - p->flags |= TERMP_NOLPAD | TERMP_NOSPACE; + p->trailspace = 0; + if (p->rmargin + titlen <= p->maxrmargin) { + p->flags |= 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; + p->offset = 0; + p->rmargin = p->maxrmargin; + /* + * Groff prints three blank lines before the content. + * Do the same, except in the temporary, undocumented + * mode imitating mdoc(7) output. + */ + + term_vspace(p); + if ( ! p->mdocstyle) { + term_vspace(p); + term_vspace(p); + } free(title); - free(buf); } -