=================================================================== RCS file: /cvs/mandoc/man_term.c,v retrieving revision 1.93 retrieving revision 1.242 diff -u -p -r1.93 -r1.242 --- mandoc/man_term.c 2011/01/03 15:30:25 1.93 +++ mandoc/man_term.c 2023/04/28 20:23:19 1.242 @@ -1,119 +1,112 @@ -/* $Id: man_term.c,v 1.93 2011/01/03 15:30:25 kristaps Exp $ */ +/* $Id: man_term.c,v 1.242 2023/04/28 20:23:19 schwarze Exp $ */ /* - * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons + * Copyright (c) 2010-2015,2017-2020,2022 Ingo Schwarze + * Copyright (c) 2008-2012 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. * - * 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. + * + * Plain text formatter for man(7), used by mandoc(1) + * for ASCII, UTF-8, PostScript, and PDF output. */ -#ifdef HAVE_CONFIG_H #include "config.h" -#endif #include #include #include +#include #include #include #include +#include "mandoc_aux.h" #include "mandoc.h" -#include "out.h" +#include "roff.h" #include "man.h" +#include "out.h" #include "term.h" -#include "chars.h" +#include "term_tag.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; + 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 { +struct man_term_act { int (*pre)(DECL_ARGS); void (*post)(DECL_ARGS); int flags; #define MAN_NOTEXT (1 << 0) /* Never has text children. */ }; -static int a2width(const struct termp *, const char *); -static size_t a2height(const struct termp *, const char *); - static void print_man_nodelist(DECL_ARGS); static void print_man_node(DECL_ARGS); -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 *); +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 *, + struct roff_node *, int); -static int pre_alternate(DECL_ARGS); static int pre_B(DECL_ARGS); +static int pre_DT(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_RS(DECL_ARGS); static int pre_SH(DECL_ARGS); static int pre_SS(DECL_ARGS); +static int pre_SY(DECL_ARGS); static int pre_TP(DECL_ARGS); +static int pre_UR(DECL_ARGS); +static int pre_alternate(DECL_ARGS); static int pre_ign(DECL_ARGS); static int pre_in(DECL_ARGS); static int pre_literal(DECL_ARGS); -static int pre_sp(DECL_ARGS); -static int pre_ft(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_SY(DECL_ARGS); static void post_TP(DECL_ARGS); +static void post_UR(DECL_ARGS); -static const struct termact termacts[MAN_MAX] = { - { pre_sp, NULL, MAN_NOTEXT }, /* br */ +static const struct man_term_act man_term_acts[MAN_MAX - MAN_TH] = { { NULL, NULL, 0 }, /* TH */ { pre_SH, post_SH, 0 }, /* SH */ - { pre_SS, post_SS, 0 }, /* SS */ + { pre_SS, post_SH, 0 }, /* SS */ { pre_TP, post_TP, 0 }, /* TP */ + { pre_TP, post_TP, 0 }, /* TQ */ { 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 */ + { pre_HP, post_HP, 0 }, /* HP */ { NULL, NULL, 0 }, /* SM */ { pre_B, NULL, 0 }, /* SB */ { pre_alternate, NULL, 0 }, /* BI */ @@ -125,898 +118,1018 @@ static const struct termact termacts[MAN_MAX] = { { pre_I, NULL, 0 }, /* I */ { pre_alternate, NULL, 0 }, /* IR */ { pre_alternate, NULL, 0 }, /* RI */ - { NULL, 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, 0 }, /* UC */ - { pre_ign, NULL, 0 }, /* PD */ - { pre_ign, NULL, 0 }, /* AT */ + { pre_DT, NULL, MAN_NOTEXT }, /* DT */ + { pre_ign, NULL, MAN_NOTEXT }, /* UC */ + { pre_PD, NULL, MAN_NOTEXT }, /* PD */ + { pre_ign, NULL, MAN_NOTEXT }, /* AT */ { pre_in, NULL, MAN_NOTEXT }, /* in */ - { pre_ft, NULL, MAN_NOTEXT }, /* ft */ + { pre_SY, post_SY, 0 }, /* SY */ + { NULL, NULL, 0 }, /* YS */ + { 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_UR, post_UR, 0 }, /* MT */ + { NULL, NULL, 0 }, /* ME */ }; +static const struct man_term_act *man_term_act(enum roff_tok); +static const struct man_term_act * +man_term_act(enum roff_tok tok) +{ + assert(tok >= MAN_TH && tok <= MAN_MAX); + return man_term_acts + (tok - MAN_TH); +} void -terminal_man(void *arg, const struct man *man) +terminal_man(void *arg, const struct roff_meta *man) { - struct termp *p; - const struct man_node *n; - const struct man_meta *m; struct mtermp mt; + struct termp *p; + struct roff_node *n, *nc, *nn; + size_t save_defindent; p = (struct termp *)arg; + save_defindent = p->defindent; + if (p->synopsisonly == 0 && p->defindent == 0) + p->defindent = 7; + p->tcol->rmargin = p->maxrmargin = p->defrmargin; + term_tab_set(p, NULL); + term_tab_set(p, "T"); + term_tab_set(p, ".5i"); - p->overstep = 0; - p->maxrmargin = p->defrmargin; - p->tabwidth = term_len(p, 5); + memset(&mt, 0, sizeof(mt)); + mt.lmargin[mt.lmargincur] = term_len(p, p->defindent); + mt.offset = term_len(p, p->defindent); + mt.pardist = 1; - if (NULL == p->symtab) - switch (p->enc) { - case (TERMENC_ASCII): - p->symtab = chars_init(CHARS_ASCII); - break; - default: - abort(); - /* NOTREACHED */ + n = man->first->child; + if (p->synopsisonly) { + for (nn = NULL; n != NULL; n = n->next) { + if (n->tok != MAN_SH) + continue; + nc = n->child->child; + if (nc->type != ROFFT_TEXT) + continue; + if (strcmp(nc->string, "SYNOPSIS") == 0) + break; + if (nn == NULL && strcmp(nc->string, "NAME") == 0) + nn = n; } - - n = man_node(man); - m = man_meta(man); - - term_begin(p, print_man_head, print_man_foot, m); - p->flags |= TERMP_NOSPACE; - - mt.fl = 0; - mt.lmargin = term_len(p, INDENT); - mt.offset = term_len(p, INDENT); - - if (n->child) - print_man_nodelist(p, &mt, n->child, m); - - term_end(p); + if (n == NULL) + n = nn; + p->flags |= TERMP_NOSPACE; + if (n != NULL && (n = n->child->next->child) != NULL) + print_man_nodelist(p, &mt, n, man); + term_newln(p); + } else { + term_begin(p, print_man_head, print_man_foot, man); + p->flags |= TERMP_NOSPACE; + if (n != NULL) + print_man_nodelist(p, &mt, n, man); + term_end(p); + } + p->defindent = save_defindent; } - -static size_t -a2height(const struct termp *p, const char *cp) -{ - struct roffsu su; - - if ( ! a2roffsu(cp, &su, SCALE_VS)) - SCALE_VS_INIT(&su, term_strlen(p, cp)); - - return(term_vspan(p, &su)); -} - - -static int -a2width(const struct termp *p, const char *cp) -{ - struct roffsu su; - - if ( ! a2roffsu(cp, &su, SCALE_BU)) - return(-1); - - 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, struct roff_node *n, int pardist) { + struct roff_node *nch; + int i; + term_newln(p); - if (NULL == n->prev) + if (n->body != NULL && + (nch = roff_node_child(n->body)) != NULL && + nch->type == ROFFT_TBL) return; - if (MAN_SS == n->prev->tok) + if (n->parent->tok != MAN_RS && roff_node_prev(n) == NULL) return; - if (MAN_SH == n->prev->tok) - return; - term_vspace(p); + for (i = 0; i < pardist; i++) + term_vspace(p); } - -/* ARGSUSED */ static int pre_ign(DECL_ARGS) { - - return(0); + return 0; } - -/* ARGSUSED */ static int pre_I(DECL_ARGS) { - term_fontrepl(p, TERMFONT_UNDER); - return(1); + return 1; } - -/* ARGSUSED */ static int pre_literal(DECL_ARGS) { - term_newln(p); - if (MAN_nf == n->tok) - mt->fl |= MANT_LITERAL; - else - mt->fl &= ~MANT_LITERAL; + /* + * 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 (n->parent->tok == MAN_HP && p->tcol->rmargin < p->maxrmargin) { + p->tcol->offset = p->tcol->rmargin; + p->tcol->rmargin = p->maxrmargin; + p->trailspace = 0; + p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND); + p->flags |= TERMP_NOSPACE; + } + return 0; +} - return(1); +static int +pre_PD(DECL_ARGS) +{ + struct roffsu su; + + n = n->child; + if (n == NULL) { + mt->pardist = 1; + return 0; + } + assert(n->type == ROFFT_TEXT); + if (a2roffsu(n->string, &su, SCALE_VS) != NULL) + mt->pardist = term_vspan(p, &su); + return 0; } -/* ARGSUSED */ static int pre_alternate(DECL_ARGS) { enum termfont font[2]; - const struct man_node *nn; - int savelit, i; + struct roff_node *nn; + int i; switch (n->tok) { - case (MAN_RB): + case MAN_RB: font[0] = TERMFONT_NONE; font[1] = TERMFONT_BOLD; break; - case (MAN_RI): + case MAN_RI: font[0] = TERMFONT_NONE; font[1] = TERMFONT_UNDER; break; - case (MAN_BR): + case MAN_BR: font[0] = TERMFONT_BOLD; font[1] = TERMFONT_NONE; break; - case (MAN_BI): + case MAN_BI: font[0] = TERMFONT_BOLD; font[1] = TERMFONT_UNDER; break; - case (MAN_IR): + case MAN_IR: font[0] = TERMFONT_UNDER; font[1] = TERMFONT_NONE; break; - case (MAN_IB): + case MAN_IB: font[0] = TERMFONT_UNDER; font[1] = TERMFONT_BOLD; break; default: abort(); } - - savelit = MANT_LITERAL & mt->fl; - mt->fl &= ~MANT_LITERAL; - - for (i = 0, nn = n->child; nn; nn = nn->next, i = 1 - i) { + for (i = 0, nn = n->child; nn != NULL; 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, m); - if (nn->next) + assert(nn->type == ROFFT_TEXT); + term_word(p, nn->string); + if (nn->flags & NODE_EOS) + p->flags |= TERMP_SENTENCE; + if (nn->next != NULL) p->flags |= TERMP_NOSPACE; } - - return(0); + return 0; } -/* ARGSUSED */ static int pre_B(DECL_ARGS) { - term_fontrepl(p, TERMFONT_BOLD); - return(1); + return 1; } -/* ARGSUSED */ static int -pre_ft(DECL_ARGS) +pre_OP(DECL_ARGS) { - const char *cp; + term_word(p, "["); + p->flags |= TERMP_KEEP | TERMP_NOSPACE; - if (NULL == n->child) { - term_fontlast(p); - return(0); - } - - cp = n->child->string; - switch (*cp) { - case ('4'): - /* FALLTHROUGH */ - case ('3'): - /* FALLTHROUGH */ - case ('B'): + if ((n = n->child) != NULL) { term_fontrepl(p, TERMFONT_BOLD); - break; - case ('2'): - /* FALLTHROUGH */ - case ('I'): + term_word(p, n->string); + } + if (n != NULL && n->next != NULL) { 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; + term_word(p, n->next->string); } - return(0); + term_fontrepl(p, TERMFONT_NONE); + p->flags &= ~TERMP_KEEP; + p->flags |= TERMP_NOSPACE; + term_word(p, "]"); + return 0; } -/* ARGSUSED */ static int pre_in(DECL_ARGS) { - int len, less; - size_t v; + struct roffsu su; const char *cp; + size_t v; + int less; term_newln(p); - if (NULL == n->child) { - p->offset = mt->offset; - return(0); + if (n->child == NULL) { + p->tcol->offset = mt->offset; + return 0; } cp = n->child->string; less = 0; - if ('-' == *cp) + if (*cp == '-') less = -1; - else if ('+' == *cp) + else if (*cp == '+') less = 1; else cp--; - if ((len = a2width(p, ++cp)) < 0) - return(0); + if (a2roffsu(++cp, &su, SCALE_EN) == NULL) + return 0; - v = (size_t)len; + v = term_hen(p, &su); if (less < 0) - p->offset -= p->offset > v ? v : p->offset; + p->tcol->offset -= p->tcol->offset > v ? v : p->tcol->offset; else if (less > 0) - p->offset += v; - else - p->offset = v; + p->tcol->offset += v; + else + p->tcol->offset = v; + if (p->tcol->offset > SHRT_MAX) + p->tcol->offset = term_len(p, p->defindent); - return(0); + return 0; } - -/* ARGSUSED */ static int -pre_sp(DECL_ARGS) +pre_DT(DECL_ARGS) { - size_t i, len; - - switch (n->tok) { - case (MAN_br): - len = 0; - break; - default: - len = n->child ? a2height(p, n->child->string) : 1; - break; - } - - if (0 == len) - term_newln(p); - for (i = 0; i < len; i++) - term_vspace(p); - - return(0); + term_tab_set(p, NULL); + term_tab_set(p, "T"); + term_tab_set(p, ".5i"); + 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): - print_bvspace(p, n); - return(1); - case (MAN_BODY): - p->flags |= TERMP_NOBREAK; - p->flags |= TERMP_TWOSPACE; + case ROFFT_BLOCK: + print_bvspace(p, n, mt->pardist); + return 1; + case ROFFT_HEAD: + return 0; + case ROFFT_BODY: break; default: - return(0); + abort(); } - len = mt->lmargin; - ival = -1; + if (n->child == NULL) + return 0; + if ((n->child->flags & NODE_NOFILL) == 0) { + p->flags |= TERMP_NOBREAK | TERMP_BRIND; + p->trailspace = 2; + } + /* Calculate offset. */ - if (NULL != (nn = n->parent->head->child)) - if ((ival = a2width(p, nn->string)) >= 0) - len = (size_t)ival; + if ((nn = n->parent->head->child) != NULL && + a2roffsu(nn->string, &su, SCALE_EN) != NULL) { + len = term_hen(p, &su); + 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 = term_len(p, 1); - - p->offset = mt->offset; - p->rmargin = mt->offset + len; - - if (ival >= 0) - mt->lmargin = (size_t)ival; - - return(1); + p->tcol->offset = mt->offset; + p->tcol->rmargin = mt->offset + len; + return 1; } - -/* ARGSUSED */ static void post_HP(DECL_ARGS) { - switch (n->type) { - case (MAN_BLOCK): - term_flushln(p); + case ROFFT_BLOCK: + case ROFFT_HEAD: break; - case (MAN_BODY): - term_flushln(p); - p->flags &= ~TERMP_NOBREAK; - p->flags &= ~TERMP_TWOSPACE; - p->offset = mt->offset; - p->rmargin = p->maxrmargin; + 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->tcol->offset = mt->offset; + p->tcol->rmargin = p->maxrmargin; break; default: - break; + abort(); } } - -/* ARGSUSED */ static int pre_PP(DECL_ARGS) { - switch (n->type) { - case (MAN_BLOCK): - mt->lmargin = term_len(p, INDENT); - print_bvspace(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; + case ROFFT_HEAD: + return 0; + case ROFFT_BODY: + p->tcol->offset = mt->offset; break; + default: + abort(); } - - return(MAN_HEAD != n->type); + return 1; } - -/* 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; switch (n->type) { - case (MAN_BODY): - p->flags |= TERMP_NOLPAD; - p->flags |= TERMP_NOSPACE; - break; - case (MAN_HEAD): + case ROFFT_BLOCK: + print_bvspace(p, n, mt->pardist); + return 1; + case ROFFT_HEAD: p->flags |= TERMP_NOBREAK; + p->trailspace = 1; break; - case (MAN_BLOCK): - print_bvspace(p, n); - /* FALLTHROUGH */ + case ROFFT_BODY: + p->flags |= TERMP_NOSPACE | TERMP_NONEWLINE; + break; default: - return(1); + abort(); } - 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) != NULL) { + len = term_hen(p, &su); + 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 = a2width(p, nn->string)) >= 0) - len = (size_t)ival; - } - switch (n->type) { - case (MAN_HEAD): - /* Handle zero-width lengths. */ - if (0 == len) - 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; - - /* Don't print the length value. */ - for (nn = n->child; nn->next; nn = nn->next) - print_man_node(p, mt, nn, m); - return(0); - case (MAN_BODY): - p->offset = mt->offset + len; - p->rmargin = p->maxrmargin; + case ROFFT_HEAD: + p->tcol->offset = mt->offset; + p->tcol->rmargin = mt->offset + len; + if (n->child != NULL) + print_man_node(p, mt, n->child, meta); + return 0; + case ROFFT_BODY: + p->tcol->offset = mt->offset + len; + p->tcol->rmargin = p->maxrmargin; break; default: - break; + abort(); } - - return(1); + return 1; } - -/* ARGSUSED */ static void post_IP(DECL_ARGS) { - switch (n->type) { - case (MAN_HEAD): + case ROFFT_BLOCK: + break; + case ROFFT_HEAD: term_flushln(p); p->flags &= ~TERMP_NOBREAK; - p->rmargin = p->maxrmargin; + p->trailspace = 0; + p->tcol->rmargin = p->maxrmargin; break; - case (MAN_BODY): - term_flushln(p); - p->flags &= ~TERMP_NOLPAD; + case ROFFT_BODY: + term_newln(p); + p->tcol->offset = mt->offset; break; default: - break; + abort(); } } - -/* 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; switch (n->type) { - case (MAN_HEAD): - p->flags |= TERMP_NOBREAK; - p->flags |= TERMP_TWOSPACE; + case ROFFT_BLOCK: + if (n->tok == MAN_TP) + print_bvspace(p, n, mt->pardist); + return 1; + case ROFFT_HEAD: + p->flags |= TERMP_NOBREAK | TERMP_BRTRSP; + p->trailspace = 1; break; - case (MAN_BODY): - p->flags |= TERMP_NOLPAD; - p->flags |= TERMP_NOSPACE; + case ROFFT_BODY: + p->flags |= TERMP_NOSPACE | TERMP_NONEWLINE; break; - case (MAN_BLOCK): - print_bvspace(p, n); - /* FALLTHROUGH */ default: - return(1); + abort(); } - len = (size_t)mt->lmargin; - ival = -1; - /* Calculate offset. */ - if (NULL != (nn = n->parent->head->child)) { - while (nn && MAN_TEXT != nn->type) - nn = nn->next; - if (nn && nn->next) - if ((ival = a2width(p, nn->string)) >= 0) - len = (size_t)ival; - } + if ((nn = n->parent->head->child) != NULL && + nn->string != NULL && ! (NODE_LINE & nn->flags) && + a2roffsu(nn->string, &su, SCALE_EN) != NULL) { + len = term_hen(p, &su); + 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 = term_len(p, 1); + case ROFFT_HEAD: + p->tcol->offset = mt->offset; + p->tcol->rmargin = mt->offset + len; - p->offset = mt->offset; - p->rmargin = mt->offset + len; - /* Don't print same-line elements. */ - for (nn = n->child; nn; nn = nn->next) - if (nn->line > n->line) - print_man_node(p, mt, nn, m); + nn = n->child; + while (nn != NULL && (nn->flags & NODE_LINE) == 0) + nn = nn->next; - if (ival >= 0) - mt->lmargin = (size_t)ival; - - return(0); - case (MAN_BODY): - p->offset = mt->offset + len; - p->rmargin = p->maxrmargin; + while (nn != NULL) { + print_man_node(p, mt, nn, meta); + nn = nn->next; + } + return 0; + case ROFFT_BODY: + p->tcol->offset = mt->offset + len; + p->tcol->rmargin = p->maxrmargin; + p->trailspace = 0; + p->flags &= ~(TERMP_NOBREAK | TERMP_BRTRSP); break; default: - break; + abort(); } - - return(1); + 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; + case ROFFT_BLOCK: break; - case (MAN_BODY): + case ROFFT_HEAD: term_flushln(p); - p->flags &= ~TERMP_NOLPAD; break; - default: + case ROFFT_BODY: + term_newln(p); + p->tcol->offset = mt->offset; break; + default: + abort(); } } - -/* ARGSUSED */ static int pre_SS(DECL_ARGS) { + int i; switch (n->type) { - case (MAN_BLOCK): - mt->lmargin = term_len(p, INDENT); - mt->offset = term_len(p, 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->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. + */ + + if ((n = roff_node_prev(n)) == NULL || + (n->tok == MAN_SS && roff_node_child(n->body) == NULL)) break; - term_vspace(p); + + for (i = 0; i < mt->pardist; i++) + term_vspace(p); break; - case (MAN_HEAD): + case ROFFT_HEAD: term_fontrepl(p, TERMFONT_BOLD); - p->offset = term_len(p, HALFINDENT); + p->tcol->offset = term_len(p, 3); + p->tcol->rmargin = mt->offset; + p->trailspace = mt->offset; + p->flags |= TERMP_NOBREAK | TERMP_BRIND; break; - case (MAN_BODY): - p->offset = mt->offset; + case ROFFT_BODY: + p->tcol->offset = mt->offset; + p->tcol->rmargin = p->maxrmargin; + p->trailspace = 0; + p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND); break; default: break; } - - return(1); + return 1; } - -/* ARGSUSED */ -static void -post_SS(DECL_ARGS) -{ - - switch (n->type) { - case (MAN_HEAD): - term_newln(p); - break; - case (MAN_BODY): - term_newln(p); - break; - default: - break; - } -} - - -/* ARGSUSED */ static int pre_SH(DECL_ARGS) { + int i; switch (n->type) { - case (MAN_BLOCK): - mt->lmargin = term_len(p, INDENT); - mt->offset = term_len(p, INDENT); - /* If following a prior empty `SH', no vspace. */ - if (n->prev && MAN_SH == n->prev->tok) - if (NULL == n->prev->body->child) - break; - /* If the first macro, no vspae. */ - if (NULL == n->prev) + case ROFFT_BLOCK: + 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. + */ + + if ((n = roff_node_prev(n)) == NULL || + (n->tok == MAN_SH && roff_node_child(n->body) == NULL)) break; - term_vspace(p); + + for (i = 0; i < mt->pardist; i++) + term_vspace(p); break; - case (MAN_HEAD): + case ROFFT_HEAD: term_fontrepl(p, TERMFONT_BOLD); - p->offset = 0; + p->tcol->offset = 0; + p->tcol->rmargin = mt->offset; + p->trailspace = mt->offset; + p->flags |= TERMP_NOBREAK | TERMP_BRIND; break; - case (MAN_BODY): - p->offset = mt->offset; + case ROFFT_BODY: + p->tcol->offset = mt->offset; + p->tcol->rmargin = p->maxrmargin; + p->trailspace = 0; + p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND); break; default: - break; + abort(); } - - return(1); + return 1; } - -/* ARGSUSED */ static void post_SH(DECL_ARGS) { - switch (n->type) { - case (MAN_HEAD): - term_newln(p); + case ROFFT_BLOCK: break; - case (MAN_BODY): + case ROFFT_HEAD: + case ROFFT_BODY: term_newln(p); break; default: - break; + abort(); } } - -/* 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): - return(0); - default: + return 1; + case ROFFT_HEAD: + return 0; + case ROFFT_BODY: break; + default: + abort(); } - if (NULL == (nn = n->parent->head->child)) { - mt->offset = mt->lmargin + term_len(p, INDENT); - p->offset = mt->offset; - return(1); - } + n = n->parent->head; + n->aux = SHRT_MAX + 1; + if (n->child == NULL) + n->aux = mt->lmargin[mt->lmargincur]; + else if (a2roffsu(n->child->string, &su, SCALE_EN) != NULL) + n->aux = term_hen(p, &su); + 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 = a2width(p, nn->string)) < 0) - return(1); + mt->offset += n->aux; + p->tcol->offset = mt->offset; + p->tcol->rmargin = p->maxrmargin; - mt->offset = term_len(p, INDENT) + (size_t)ival; - p->offset = mt->offset; + if (++mt->lmarginsz < MAXMARGINS) + mt->lmargincur = mt->lmarginsz; - return(1); + mt->lmargin[mt->lmargincur] = term_len(p, p->defindent); + return 1; } - -/* ARGSUSED */ static void post_RS(DECL_ARGS) { + switch (n->type) { + case ROFFT_BLOCK: + case ROFFT_HEAD: + return; + case ROFFT_BODY: + break; + default: + abort(); + } + term_newln(p); + mt->offset -= n->parent->head->aux; + p->tcol->offset = mt->offset; + if (--mt->lmarginsz < MAXMARGINS) + mt->lmargincur = mt->lmarginsz; +} +static int +pre_SY(DECL_ARGS) +{ + const struct roff_node *nn; + int len; + switch (n->type) { - case (MAN_BLOCK): - mt->offset = mt->lmargin = term_len(p, INDENT); + case ROFFT_BLOCK: + if ((nn = roff_node_prev(n)) == NULL || nn->tok != MAN_SY) + print_bvspace(p, n, mt->pardist); + return 1; + case ROFFT_HEAD: + case ROFFT_BODY: break; - case (MAN_HEAD): + default: + abort(); + } + + nn = n->parent->head->child; + len = nn == NULL ? 1 : term_strlen(p, nn->string) + 1; + + switch (n->type) { + case ROFFT_HEAD: + p->tcol->offset = mt->offset; + p->tcol->rmargin = mt->offset + len; + if (n->next->child == NULL || + (n->next->child->flags & NODE_NOFILL) == 0) + p->flags |= TERMP_NOBREAK; + term_fontrepl(p, TERMFONT_BOLD); break; + case ROFFT_BODY: + mt->lmargin[mt->lmargincur] = len; + p->tcol->offset = mt->offset + len; + p->tcol->rmargin = p->maxrmargin; + p->flags |= TERMP_NOSPACE; + break; default: + abort(); + } + return 1; +} + +static void +post_SY(DECL_ARGS) +{ + switch (n->type) { + case ROFFT_BLOCK: + break; + case ROFFT_HEAD: + term_flushln(p); + p->flags &= ~TERMP_NOBREAK; + break; + case ROFFT_BODY: term_newln(p); - p->offset = term_len(p, INDENT); + p->tcol->offset = mt->offset; break; + default: + abort(); } } +static int +pre_UR(DECL_ARGS) +{ + return n->type != ROFFT_HEAD; +} static void +post_UR(DECL_ARGS) +{ + if (n->type != ROFFT_BLOCK) + return; + + term_word(p, "<"); + p->flags |= TERMP_NOSPACE; + + if (n->child->child != NULL) + 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; + const struct man_term_act *act; + int c; - c = 1; + /* + * In no-fill mode, break the output line at the beginning + * of new input lines except after \c, and nowhere else. + */ - switch (n->type) { - case(MAN_TEXT): - if (0 == *n->string) { - term_vspace(p); - break; - } + if (n->flags & NODE_NOFILL) { + if (n->flags & NODE_LINE && + (p->flags & TERMP_NONEWLINE) == 0) + term_newln(p); + p->flags |= TERMP_BRNEVER; + } else { + if (n->flags & NODE_LINE) + term_tab_ref(p); + p->flags &= ~TERMP_BRNEVER; + } - term_word(p, n->string); + if (n->flags & NODE_ID) + term_tag_write(n, p->line); - /* FIXME: this means that macro lines are munged! */ + switch (n->type) { + case ROFFT_TEXT: + /* + * 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. + */ + if (*n->string == '\0') { + if (p->flags & TERMP_NONEWLINE) + term_newln(p); + else + term_vspace(p); + return; + } else if (*n->string == ' ' && n->flags & NODE_LINE && + (p->flags & TERMP_NONEWLINE) == 0) + term_newln(p); + else if (n->flags & NODE_DELIMC) + p->flags |= TERMP_NOSPACE; - if (MANT_LITERAL & mt->fl) { - rm = p->rmargin; - rmax = p->maxrmargin; - p->rmargin = p->maxrmargin = TERM_MAXMARGIN; + term_word(p, n->string); + goto out; + case ROFFT_COMMENT: + return; + case ROFFT_EQN: + if ( ! (n->flags & NODE_LINE)) p->flags |= TERMP_NOSPACE; - term_flushln(p); - p->rmargin = rm; - p->maxrmargin = rmax; - } - break; - case (MAN_TBL): - if (TBL_SPAN_FIRST & n->span->flags) + term_eqn(p, n->eqn); + if (n->next != NULL && ! (n->next->flags & NODE_LINE)) + p->flags |= TERMP_NOSPACE; + return; + case ROFFT_TBL: + if (p->tbl.cols == NULL) term_newln(p); term_tbl(p, n->span); - break; + return; default: - if ( ! (MAN_NOTEXT & termacts[n->tok].flags)) - term_fontrepl(p, TERMFONT_NONE); - if (termacts[n->tok].pre) - c = (*termacts[n->tok].pre)(p, mt, n, m); break; } - if (c && n->child) - print_man_nodelist(p, mt, n->child, m); - - switch (n->type) { - case (MAN_TEXT): - /* FALLTHROUGH */ - case (MAN_TBL): - break; - default: - if (termacts[n->tok].post) - (*termacts[n->tok].post)(p, mt, n, m); - if ( ! (MAN_NOTEXT & termacts[n->tok].flags)) - term_fontrepl(p, TERMFONT_NONE); - break; + if (n->tok < ROFF_MAX) { + roff_term_pre(p, n); + return; } - if (MAN_EOS & n->flags) + act = man_term_act(n->tok); + if ((act->flags & MAN_NOTEXT) == 0 && n->tok != MAN_SM) + term_fontrepl(p, TERMFONT_NONE); + + c = 1; + if (act->pre != NULL) + c = (*act->pre)(p, mt, n, meta); + + if (c && n->child != NULL) + print_man_nodelist(p, mt, n->child, meta); + + if (act->post != NULL) + (*act->post)(p, mt, n, meta); + if ((act->flags & MAN_NOTEXT) == 0 && n->tok != MAN_SM) + term_fontrepl(p, TERMFONT_NONE); + +out: + if (n->parent->tok == MAN_HP && n->parent->type == ROFFT_BODY && + n->prev == NULL && n->flags & NODE_NOFILL) { + term_newln(p); + p->tcol->offset = p->tcol->rmargin; + p->tcol->rmargin = p->maxrmargin; + } + if (n->flags & NODE_EOS) p->flags |= TERMP_SENTENCE; } - static void print_man_nodelist(DECL_ARGS) { - - print_man_node(p, mt, n, m); - if ( ! n->next) - return; - print_man_nodelist(p, mt, n->next, m); + while (n != NULL) { + print_man_node(p, mt, n, meta); + n = n->next; + } } - static void -print_man_foot(struct termp *p, const void *arg) +print_man_foot(struct termp *p, const struct roff_meta *meta) { - char buf[DATESIZ]; - const struct man_meta *meta; + char *title; + size_t datelen, titlen; - meta = (const struct man_meta *)arg; + assert(meta->title); + assert(meta->msec); + assert(meta->date); term_fontrepl(p, TERMFONT_NONE); - if (meta->rawdate) - strlcpy(buf, meta->rawdate, DATESIZ); - else - time2a(meta->date, buf, DATESIZ); + if (meta->hasbody) + term_vspace(p); - term_vspace(p); - 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. + */ - p->flags |= TERMP_NOSPACE | TERMP_NOBREAK; - p->rmargin = p->maxrmargin - term_strlen(p, buf); - p->offset = 0; + if ( ! p->mdocstyle) { + mandoc_asprintf(&title, "%s(%s)", + meta->title, meta->msec); + } else if (meta->os != NULL) { + title = mandoc_strdup(meta->os); + } else { + title = mandoc_strdup(""); + } + datelen = term_strlen(p, meta->date); - /* term_strlen() can return zero. */ - if (p->rmargin == p->maxrmargin) - p->rmargin--; + /* Bottom left corner: operating system. */ - if (meta->source) - term_word(p, meta->source); - if (meta->source) - term_word(p, ""); + p->flags |= TERMP_NOSPACE | TERMP_NOBREAK; + p->trailspace = 1; + p->tcol->offset = 0; + p->tcol->rmargin = p->maxrmargin > datelen ? + (p->maxrmargin + term_len(p, 1) - datelen) / 2 : 0; + + if (meta->os) + term_word(p, meta->os); term_flushln(p); - p->flags |= TERMP_NOLPAD | TERMP_NOSPACE; - p->offset = p->rmargin; - p->rmargin = p->maxrmargin; - p->flags &= ~TERMP_NOBREAK; + /* At the bottom in the middle: manual date. */ - term_word(p, buf); + p->tcol->offset = p->tcol->rmargin; + titlen = term_strlen(p, title); + p->tcol->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. */ -static void -print_man_head(struct termp *p, const void *arg) -{ - char buf[BUFSIZ], title[BUFSIZ]; - size_t buflen, titlen; - const struct man_meta *m; + p->flags &= ~TERMP_NOBREAK; + p->flags |= TERMP_NOSPACE; + p->trailspace = 0; + p->tcol->offset = p->tcol->rmargin; + p->tcol->rmargin = p->maxrmargin; - m = (const struct man_meta *)arg; + term_word(p, title); + term_flushln(p); /* - * Note that old groff would spit out some spaces before the - * header. We discontinue this strange behaviour, but at one - * point we did so here. + * Reset the terminal state for more output after the footer: + * Some output modes, in particular PostScript and PDF, print + * the header and the footer into a buffer such that it can be + * reused for multiple output pages, then go on to format the + * main text. */ - p->rmargin = p->maxrmargin; + p->tcol->offset = 0; + p->flags = 0; - p->offset = 0; - buf[0] = title[0] = '\0'; + free(title); +} - if (m->vol) - strlcpy(buf, m->vol, BUFSIZ); - buflen = term_strlen(p, buf); +static void +print_man_head(struct termp *p, const struct roff_meta *meta) +{ + const char *volume; + char *title; + size_t vollen, titlen; - snprintf(title, BUFSIZ, "%s(%s)", m->title, m->msec); + assert(meta->title); + assert(meta->msec); + + volume = NULL == meta->vol ? "" : meta->vol; + vollen = term_strlen(p, volume); + + /* Top left corner: manual title and section. */ + + mandoc_asprintf(&title, "%s(%s)", meta->title, meta->msec); titlen = term_strlen(p, title); - p->offset = 0; - p->rmargin = 2 * (titlen+1) + buflen < p->maxrmargin ? - (p->maxrmargin - - term_strlen(p, buf) + term_len(p, 1)) / 2 : - p->maxrmargin - buflen; p->flags |= TERMP_NOBREAK | TERMP_NOSPACE; + p->trailspace = 1; + p->tcol->offset = 0; + p->tcol->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; - p->offset = p->rmargin; - p->rmargin = p->offset + buflen + titlen < p->maxrmargin ? - p->maxrmargin - titlen : p->maxrmargin; + /* At the top in the middle: manual volume. */ - term_word(p, buf); + p->flags |= TERMP_NOSPACE; + p->tcol->offset = p->tcol->rmargin; + p->tcol->rmargin = p->tcol->offset + vollen + titlen < + p->maxrmargin ? p->maxrmargin - titlen : p->maxrmargin; + + term_word(p, volume); term_flushln(p); + /* Top right corner: title and section, again. */ + p->flags &= ~TERMP_NOBREAK; - if (p->rmargin + titlen <= p->maxrmargin) { - p->flags |= TERMP_NOLPAD | TERMP_NOSPACE; - p->offset = p->rmargin; - p->rmargin = p->maxrmargin; + p->trailspace = 0; + if (p->tcol->rmargin + titlen <= p->maxrmargin) { + p->flags |= TERMP_NOSPACE; + p->tcol->offset = p->tcol->rmargin; + p->tcol->rmargin = p->maxrmargin; term_word(p, title); term_flushln(p); } - p->rmargin = p->maxrmargin; - p->offset = 0; p->flags &= ~TERMP_NOSPACE; + p->tcol->offset = 0; + p->tcol->rmargin = p->maxrmargin; - /* - * Groff likes to have some leading spaces before content. Well - * that's fine by me. + /* + * Groff prints three blank lines before the content. + * Do the same, except in the temporary, undocumented + * mode imitating mdoc(7) output. */ term_vspace(p); - term_vspace(p); - term_vspace(p); + free(title); }