=================================================================== RCS file: /cvs/mandoc/man_term.c,v retrieving revision 1.50 retrieving revision 1.162 diff -u -p -r1.50 -r1.162 --- mandoc/man_term.c 2009/11/10 11:45:57 1.50 +++ mandoc/man_term.c 2014/12/23 09:31:46 1.162 @@ -1,6 +1,7 @@ -/* $Id: man_term.c,v 1.50 2009/11/10 11:45:57 kristaps Exp $ */ +/* $Id: man_term.c,v 1.162 2014/12/23 09:31:46 schwarze Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * Copyright (c) 2008-2012 Kristaps Dzonsons + * Copyright (c) 2010-2014 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 @@ -14,6 +15,8 @@ * 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 @@ -22,212 +25,203 @@ #include #include +#include "mandoc.h" +#include "mandoc_aux.h" #include "out.h" #include "man.h" #include "term.h" -#include "chars.h" #include "main.h" -#define INDENT 7 -#define HALFINDENT 3 +#define MAXMARGINS 64 /* maximum number of indented scopes */ -/* FIXME: have PD set the default vspace width. */ - 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; + size_t lmargin[MAXMARGINS]; /* margins (incl. visible 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 + const struct man_meta *meta struct termact { int (*pre)(DECL_ARGS); void (*post)(DECL_ARGS); + int flags; +#define MAN_NOTEXT (1 << 0) /* Never has text children. */ }; -#ifdef __linux__ -extern size_t strlcpy(char *, const char *, size_t); -extern size_t strlcat(char *, const char *, size_t); -#endif +static int a2width(const struct termp *, const char *); -static int a2width(const struct man_node *); -static int a2height(const struct man_node *); - -static void print_man_head(struct termp *, - const struct man_meta *); -static void print_man_body(DECL_ARGS); +static void print_man_nodelist(DECL_ARGS); static void print_man_node(DECL_ARGS); -static void print_man_foot(struct termp *, - const struct man_meta *); -static void print_bvspace(struct termp *, - const struct man_node *); +static void print_man_head(struct termp *, const void *); +static void print_man_foot(struct termp *, const void *); +static void print_bvspace(struct termp *, + const struct man_node *, int); static int pre_B(DECL_ARGS); -static int pre_BI(DECL_ARGS); static int pre_HP(DECL_ARGS); static int pre_I(DECL_ARGS); static int pre_IP(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_UR(DECL_ARGS); +static int pre_alternate(DECL_ARGS); +static int pre_ft(DECL_ARGS); static int pre_ign(DECL_ARGS); -static int pre_nf(DECL_ARGS); -static int pre_r(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_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_RI, NULL }, /* IR */ - { pre_RI, NULL }, /* RI */ - { 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 */ - { pre_ign, NULL }, /* PD */ + { 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_ign, NULL, MAN_NOTEXT }, /* na */ + { 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 */ }; - void terminal_man(void *arg, const struct man *man) { struct termp *p; - const struct man_node *n; - const struct man_meta *m; + const struct man_meta *meta; + struct man_node *n; struct mtermp mt; p = (struct termp *)arg; - if (NULL == p->symtab) - switch (p->enc) { - case (TERMENC_ASCII): - p->symtab = chars_init(CHARS_ASCII); - break; - default: - abort(); - /* NOTREACHED */ - } + p->overstep = 0; + p->rmargin = p->maxrmargin = p->defrmargin; + p->tabwidth = term_len(p, 5); - n = man_node(man); - m = man_meta(man); + n = man_node(man)->child; + meta = man_meta(man); - print_man_head(p, m); - p->flags |= TERMP_NOSPACE; + memset(&mt, 0, sizeof(struct mtermp)); - mt.fl = 0; - mt.lmargin = INDENT; - mt.offset = INDENT; + mt.lmargin[mt.lmargincur] = term_len(p, p->defindent); + mt.offset = term_len(p, p->defindent); + mt.pardist = 1; - if (n->child) - print_man_body(p, &mt, n->child, m); - print_man_foot(p, m); + if (p->synopsisonly) { + while (n != NULL) { + if (n->tok == MAN_SH && + n->child->child->type == MAN_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); + } } - static int -a2height(const struct man_node *n) +a2width(const struct termp *p, const char *cp) { struct roffsu su; - assert(MAN_TEXT == n->type); - assert(n->string); - if ( ! a2roffsu(n->string, &su, SCALE_VS)) - SCALE_VS_INIT(&su, strlen(n->string)); - - return((int)term_vspan(&su)); -} - - -static int -a2width(const struct man_node *n) -{ - struct roffsu su; - - assert(MAN_TEXT == n->type); - assert(n->string); - if ( ! a2roffsu(n->string, &su, SCALE_BU)) + if ( ! a2roffsu(cp, &su, SCALE_EN)) return(-1); - return((int)term_hspan(&su)); + return((int)term_hspan(p, &su)); } - +/* + * 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 -print_bvspace(struct termp *p, const struct man_node *n) +print_bvspace(struct termp *p, const struct man_node *n, int pardist) { + int i; + term_newln(p); - if (NULL == n->prev) - return; + if (n->body && n->body->child) + if (MAN_TBL == n->body->child->type) + return; - if (MAN_SS == n->prev->tok) - return; - if (MAN_SH == n->prev->tok) - return; + if (MAN_ROOT == n->parent->type || MAN_RS != n->parent->tok) + if (NULL == n->prev) + return; - term_vspace(p); + for (i = 0; i < pardist; i++) + term_vspace(p); } -/* ARGSUSED */ static int pre_ign(DECL_ARGS) { @@ -235,255 +229,336 @@ pre_ign(DECL_ARGS) return(0); } +static int +pre_ll(DECL_ARGS) +{ -/* ARGSUSED */ + term_setwidth(p, n->nchild ? n->child->string : NULL); + return(0); +} + static int pre_I(DECL_ARGS) { - p->under++; + term_fontrepl(p, TERMFONT_UNDER); return(1); } - -/* ARGSUSED */ static int -pre_r(DECL_ARGS) +pre_literal(DECL_ARGS) { - p->bold = p->under = 0; - return(1); -} + 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; + } - if (n->nchild) - p->under--; + return(0); } - -/* ARGSUSED */ -static void -post_I(DECL_ARGS) +static int +pre_PD(DECL_ARGS) { + struct roffsu su; - p->under--; + n = n->child; + if (n == NULL) { + mt->pardist = 1; + return(0); + } + assert(MAN_TEXT == n->type); + if (a2roffsu(n->string, &su, SCALE_VS)) + mt->pardist = term_vspan(p, &su); + return(0); } - -/* ARGSUSED */ static int -pre_fi(DECL_ARGS) +pre_alternate(DECL_ARGS) { + enum termfont font[2]; + const struct man_node *nn; + int savelit, i; + 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; - return(1); -} + 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; + } -/* ARGSUSED */ + return(0); +} + static int -pre_nf(DECL_ARGS) +pre_B(DECL_ARGS) { - term_newln(p); - mt->fl |= MANT_LITERAL; + 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 && MAN_RB == n->tok) - p->bold++; - else if ( ! (i % 2) && MAN_RB != n->tok) - p->bold++; + term_word(p, "["); + p->flags |= TERMP_NOSPACE; - if (i > 0) - p->flags |= TERMP_NOSPACE; - - print_man_node(p, mt, nn, m); - - if (i % 2 && MAN_RB == n->tok) - p->bold--; - else if ( ! (i % 2) && MAN_RB != n->tok) - p->bold--; + 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 && MAN_RI == n->tok) - p->under++; - else if ( ! (i % 2) && MAN_RI != n->tok) - p->under++; + if (NULL == n->child) { + term_fontlast(p); + return(0); + } - if (i > 0) - p->flags |= TERMP_NOSPACE; - print_man_node(p, mt, nn, m); - - if (i % 2 && MAN_RI == n->tok) - p->under--; - else if ( ! (i % 2) && MAN_RI != n->tok) - p->under--; + 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; + int len, less; + size_t v; + const char *cp; - for (i = 0, nn = n->child; nn; nn = nn->next, i++) { - 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++; + term_newln(p); - if (i) - p->flags |= TERMP_NOSPACE; - print_man_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--; + 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->bold++; - return(1); -} + if ((len = a2width(p, ++cp)) < 0) + return(0); + v = (size_t)len; -/* 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; - p->bold--; + return(0); } - -/* ARGSUSED */ static int pre_sp(DECL_ARGS) { - int i, len; + struct roffsu su; + char *s; + size_t i, len; + int neg; - len = n->child ? a2height(n->child) : 1; + 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; + } + } + neg = 0; + switch (n->tok) { + case MAN_br: + len = 0; + break; + default: + if (NULL == n->child) { + len = 1; + break; + } + s = n->child->string; + if ('-' == *s) { + neg = 1; + s++; + } + if ( ! a2roffsu(s, &su, SCALE_VS)) + su.scale = 1.0; + len = term_vspan(p, &su); + break; + } + if (0 == len) term_newln(p); - for (i = 0; i < len; i++) - term_vspace(p); + else if (neg) + 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; + size_t len, one; int ival; const struct man_node *nn; switch (n->type) { - case (MAN_BLOCK): - print_bvspace(p, n); + case MAN_BLOCK: + print_bvspace(p, n, mt->pardist); return(1); - case (MAN_BODY): - p->flags |= TERMP_NOBREAK; - p->flags |= TERMP_TWOSPACE; + case MAN_BODY: break; default: return(0); } - len = mt->lmargin; + if ( ! (MANT_LITERAL & mt->fl)) { + p->flags |= TERMP_NOBREAK | TERMP_BRIND; + p->trailspace = 2; + } + + len = mt->lmargin[mt->lmargincur]; ival = -1; /* Calculate offset. */ if (NULL != (nn = n->parent->head->child)) - if ((ival = a2width(nn)) >= 0) + if ((ival = a2width(p, nn->string)) >= 0) len = (size_t)ival; - if (0 == len) - len = 1; + one = term_len(p, 1); + if (len < one) + len = one; p->offset = mt->offset; p->rmargin = mt->offset + len; if (ival >= 0) - mt->lmargin = (size_t)ival; + mt->lmargin[mt->lmargincur] = (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 MAN_BODY: + term_newln(p); + p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND); + p->trailspace = 0; p->offset = mt->offset; p->rmargin = p->maxrmargin; break; @@ -492,82 +567,78 @@ post_HP(DECL_ARGS) } } - -/* ARGSUSED */ static int pre_PP(DECL_ARGS) { switch (n->type) { - case (MAN_BLOCK): - mt->lmargin = INDENT; - print_bvspace(p, n); + case MAN_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(MAN_HEAD != n->type); } - -/* ARGSUSED */ static int pre_IP(DECL_ARGS) { const struct man_node *nn; size_t len; - int ival; + int savelit, ival; switch (n->type) { - case (MAN_BODY): - p->flags |= TERMP_NOLPAD; + case MAN_BODY: p->flags |= TERMP_NOSPACE; break; - case (MAN_HEAD): + case MAN_HEAD: p->flags |= TERMP_NOBREAK; - p->flags |= TERMP_TWOSPACE; + p->trailspace = 1; break; - case (MAN_BLOCK): - print_bvspace(p, n); + case MAN_BLOCK: + print_bvspace(p, n, mt->pardist); /* FALLTHROUGH */ default: return(1); } - len = mt->lmargin; + len = mt->lmargin[mt->lmargincur]; ival = -1; - /* Calculate offset. */ - + /* Calculate the offset from the optional second argument. */ if (NULL != (nn = n->parent->head->child)) - if (NULL != (nn = nn->next)) { - for ( ; nn->next; nn = nn->next) - /* Do nothing. */ ; - if ((ival = a2width(nn)) >= 0) + if (NULL != (nn = nn->next)) + if ((ival = a2width(p, nn->string)) >= 0) len = (size_t)ival; - } switch (n->type) { - case (MAN_HEAD): + case MAN_HEAD: /* Handle zero-width lengths. */ if (0 == len) - len = 1; + len = term_len(p, 1); p->offset = mt->offset; p->rmargin = mt->offset + len; - if (ival < 0) - break; /* Set the saved left-margin. */ - mt->lmargin = (size_t)ival; + if (ival >= 0) + mt->lmargin[mt->lmargincur] = (size_t)ival; - /* Don't print the length value. */ - for (nn = n->child; nn->next; nn = nn->next) - print_man_node(p, mt, nn, m); + savelit = MANT_LITERAL & mt->fl; + mt->fl &= ~MANT_LITERAL; + + if (n->child) + print_man_node(p, mt, n->child, meta); + + if (savelit) + mt->fl |= MANT_LITERAL; + return(0); - case (MAN_BODY): + case MAN_BODY: p->offset = mt->offset + len; p->rmargin = p->maxrmargin; break; @@ -578,84 +649,91 @@ pre_IP(DECL_ARGS) return(1); } - -/* ARGSUSED */ static void post_IP(DECL_ARGS) { switch (n->type) { - case (MAN_HEAD): + case MAN_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 MAN_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; + int savelit, ival; switch (n->type) { - case (MAN_HEAD): + case MAN_HEAD: p->flags |= TERMP_NOBREAK; - p->flags |= TERMP_TWOSPACE; + p->trailspace = 1; break; - case (MAN_BODY): - p->flags |= TERMP_NOLPAD; + case MAN_BODY: p->flags |= TERMP_NOSPACE; break; - case (MAN_BLOCK): - print_bvspace(p, n); + case MAN_BLOCK: + print_bvspace(p, n, mt->pardist); /* FALLTHROUGH */ default: return(1); } - len = (size_t)mt->lmargin; + len = (size_t)mt->lmargin[mt->lmargincur]; ival = -1; /* Calculate offset. */ if (NULL != (nn = n->parent->head->child)) - if (NULL != nn->next) - if ((ival = a2width(nn)) >= 0) + if (nn->string && 0 == (MAN_LINE & nn->flags)) + if ((ival = a2width(p, nn->string)) >= 0) len = (size_t)ival; switch (n->type) { - case (MAN_HEAD): + case MAN_HEAD: /* Handle zero-length properly. */ if (0 == len) - len = 1; + len = term_len(p, 1); 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_man_node(p, mt, nn, m); + nn = n->child; + while (NULL != nn && 0 == (MAN_LINE & nn->flags)) + nn = nn->next; + while (NULL != nn) { + print_man_node(p, mt, nn, meta); + nn = nn->next; + } + + if (savelit) + mt->fl |= MANT_LITERAL; if (ival >= 0) - mt->lmargin = (size_t)ival; + mt->lmargin[mt->lmargincur] = (size_t)ival; return(0); - case (MAN_BODY): + case MAN_BODY: p->offset = mt->offset + len; p->rmargin = p->maxrmargin; + p->trailspace = 0; + p->flags &= ~TERMP_NOBREAK; break; default: break; @@ -664,51 +742,53 @@ pre_TP(DECL_ARGS) return(1); } - -/* ARGSUSED */ static void post_TP(DECL_ARGS) { switch (n->type) { - case (MAN_HEAD): + 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; + case MAN_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 MAN_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 && 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->bold++; - p->offset = HALFINDENT; + case MAN_HEAD: + term_fontrepl(p, TERMFONT_BOLD); + p->offset = term_len(p, 3); break; - case (MAN_BODY): + case MAN_BODY: p->offset = mt->offset; break; default: @@ -718,18 +798,15 @@ pre_SS(DECL_ARGS) return(1); } - -/* ARGSUSED */ static void post_SS(DECL_ARGS) { - + switch (n->type) { - case (MAN_HEAD): + case MAN_HEAD: term_newln(p); - p->bold--; break; - case (MAN_BODY): + case MAN_BODY: term_newln(p); break; default: @@ -737,27 +814,36 @@ 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 MAN_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->bold++; + case MAN_HEAD: + term_fontrepl(p, TERMFONT_BOLD); p->offset = 0; break; - case (MAN_BODY): + case MAN_BODY: p->offset = mt->offset; break; default: @@ -767,18 +853,15 @@ pre_SH(DECL_ARGS) return(1); } - -/* ARGSUSED */ static void post_SH(DECL_ARGS) { - + switch (n->type) { - case (MAN_HEAD): + case MAN_HEAD: term_newln(p); - p->bold--; break; - case (MAN_BODY): + case MAN_BODY: term_newln(p); break; default: @@ -786,181 +869,328 @@ post_SH(DECL_ARGS) } } - -/* ARGSUSED */ static int pre_RS(DECL_ARGS) { - const struct man_node *nn; - int ival; + int ival; + size_t sz; switch (n->type) { - case (MAN_BLOCK): + case MAN_BLOCK: term_newln(p); return(1); - case (MAN_HEAD): + 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); - } + sz = term_len(p, p->defindent); - if ((ival = a2width(nn)) < 0) - return(1); + if (NULL != (n = n->parent->head->child)) + if ((ival = a2width(p, n->string)) >= 0) + sz = (size_t)ival; - mt->offset = INDENT + (size_t)ival; + mt->offset += sz; 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) { + int ival; + size_t sz; switch (n->type) { - case (MAN_BLOCK): - mt->offset = mt->lmargin = INDENT; - break; + case MAN_BLOCK: + return; + case MAN_HEAD: + return; default: term_newln(p); - p->offset = INDENT; break; } + + sz = term_len(p, p->defindent); + + if (NULL != (n = n->parent->head->child)) + if ((ival = a2width(p, n->string)) >= 0) + sz = (size_t)ival; + + mt->offset = mt->offset < sz ? 0 : mt->offset - sz; + p->offset = mt->offset; + + if (--mt->lmarginsz < MAXMARGINS) + mt->lmargincur = mt->lmarginsz; } +static int +pre_UR(DECL_ARGS) +{ + return (MAN_HEAD != n->type); +} + static void -print_man_node(DECL_ARGS) +post_UR(DECL_ARGS) { - int c, sz; - c = 1; + if (MAN_BLOCK != n->type) + 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 MAN_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 MAN_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 MAN_TBL: + /* + * Tables are preceded by a newline. Then process a + * table line, which will cause line termination, + */ + if (TBL_SPAN_FIRST & n->span->flags) + term_newln(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_man_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_man_body(DECL_ARGS) +print_man_nodelist(DECL_ARGS) { - print_man_node(p, mt, n, m); + print_man_node(p, mt, n, meta); if ( ! n->next) return; - print_man_body(p, mt, n->next, m); + print_man_nodelist(p, mt, n->next, meta); } - static void -print_man_foot(struct termp *p, const struct man_meta *meta) +print_man_foot(struct termp *p, const void *arg) { - char buf[DATESIZ]; + const struct man_meta *meta; + char *title; + size_t datelen, titlen; - p->metafont = 0; + meta = (const struct man_meta *)arg; + assert(meta->title); + assert(meta->msec); + assert(meta->date); - time2a(meta->date, buf, DATESIZ); + term_fontrepl(p, TERMFONT_NONE); - term_vspace(p); + if (meta->hasbody) + term_vspace(p); + /* + * Temporary, undocumented option to imitate mdoc(7) output. + * In the bottom right corner, use the source 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->source) { + title = mandoc_strdup(meta->source); + } else { + title = mandoc_strdup(""); + } + datelen = term_strlen(p, meta->date); + + /* Bottom left corner: manual source. */ + 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, ""); 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; + titlen = term_strlen(p, title); + p->rmargin = p->maxrmargin > titlen ? p->maxrmargin - titlen : 0; + p->flags |= TERMP_NOSPACE; + + term_word(p, meta->date); + term_flushln(p); + + /* 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, buf); + term_word(p, title); term_flushln(p); + free(title); } - static void -print_man_head(struct termp *p, const struct man_meta *m) +print_man_head(struct termp *p, const void *arg) { - char buf[BUFSIZ], title[BUFSIZ]; + const struct man_meta *meta; + const char *volume; + char *title; + size_t vollen, titlen; - p->rmargin = p->maxrmargin; - p->offset = 0; - buf[0] = title[0] = '\0'; + meta = (const struct man_meta *)arg; + assert(meta->title); + assert(meta->msec); - if (m->vol) - strlcpy(buf, m->vol, BUFSIZ); + volume = NULL == meta->vol ? "" : meta->vol; + vollen = term_strlen(p, volume); - snprintf(title, BUFSIZ, "%s(%d)", m->title, m->msec); + /* Top left corner: manual title and section. */ - p->offset = 0; - p->rmargin = (p->maxrmargin - strlen(buf) + 1) / 2; + mandoc_asprintf(&title, "%s(%s)", meta->title, meta->msec); + titlen = term_strlen(p, title); + 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); }