=================================================================== RCS file: /cvs/mandoc/man_term.c,v retrieving revision 1.226 retrieving revision 1.244 diff -u -p -r1.226 -r1.244 --- mandoc/man_term.c 2019/01/05 00:36:50 1.226 +++ mandoc/man_term.c 2023/11/13 19:13:01 1.244 @@ -1,7 +1,7 @@ -/* $Id: man_term.c,v 1.226 2019/01/05 00:36:50 schwarze Exp $ */ +/* $Id: man_term.c,v 1.244 2023/11/13 19:13:01 schwarze Exp $ */ /* + * Copyright (c) 2010-15,2017-20,2022-23 Ingo Schwarze * Copyright (c) 2008-2012 Kristaps Dzonsons - * Copyright (c) 2010-2015, 2017-2019 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 +14,9 @@ * 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. */ #include "config.h" @@ -27,10 +30,12 @@ #include #include "mandoc_aux.h" +#include "mandoc.h" #include "roff.h" #include "man.h" #include "out.h" #include "term.h" +#include "term_tag.h" #include "main.h" #define MAXMARGINS 64 /* maximum number of indented scopes */ @@ -62,13 +67,14 @@ static void print_man_head(struct termp *, static void print_man_foot(struct termp *, const struct roff_meta *); static void print_bvspace(struct termp *, - const struct roff_node *, int); + struct roff_node *, int); 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_MR(DECL_ARGS); static int pre_OP(DECL_ARGS); static int pre_PD(DECL_ARGS); static int pre_PP(DECL_ARGS); @@ -78,7 +84,6 @@ 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_abort(DECL_ARGS); static int pre_alternate(DECL_ARGS); static int pre_ign(DECL_ARGS); static int pre_in(DECL_ARGS); @@ -88,7 +93,6 @@ 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); @@ -96,12 +100,12 @@ static void post_UR(DECL_ARGS); 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_abort, NULL, 0 }, /* LP */ + { pre_PP, NULL, 0 }, /* LP */ { pre_PP, NULL, 0 }, /* PP */ - { pre_abort, NULL, 0 }, /* P */ + { pre_PP, NULL, 0 }, /* P */ { pre_IP, post_IP, 0 }, /* IP */ { pre_HP, post_HP, 0 }, /* HP */ { NULL, NULL, 0 }, /* SM */ @@ -117,10 +121,10 @@ static const struct man_term_act man_term_acts[MAN_MAX { pre_alternate, NULL, 0 }, /* RI */ { NULL, NULL, 0 }, /* RE */ { pre_RS, post_RS, 0 }, /* RS */ - { pre_DT, NULL, 0 }, /* DT */ + { pre_DT, NULL, MAN_NOTEXT }, /* DT */ { pre_ign, NULL, MAN_NOTEXT }, /* UC */ { pre_PD, NULL, MAN_NOTEXT }, /* PD */ - { pre_ign, NULL, 0 }, /* AT */ + { pre_ign, NULL, MAN_NOTEXT }, /* AT */ { pre_in, NULL, MAN_NOTEXT }, /* in */ { pre_SY, post_SY, 0 }, /* SY */ { NULL, NULL, 0 }, /* YS */ @@ -131,6 +135,7 @@ static const struct man_term_act man_term_acts[MAN_MAX { NULL, NULL, 0 }, /* UE */ { pre_UR, post_UR, 0 }, /* MT */ { NULL, NULL, 0 }, /* ME */ + { pre_MR, NULL, 0 }, /* MR */ }; static const struct man_term_act *man_term_act(enum roff_tok); @@ -145,39 +150,40 @@ man_term_act(enum roff_tok tok) void terminal_man(void *arg, const struct roff_meta *man) { - struct termp *p; - struct roff_node *n; struct mtermp mt; - size_t save_defindent; + struct termp *p; + struct roff_node *n, *nc, *nn; 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"); - memset(&mt, 0, sizeof(struct mtermp)); - mt.lmargin[mt.lmargincur] = term_len(p, p->defindent); + memset(&mt, 0, sizeof(mt)); + mt.lmargin[mt.lmargincur] = term_len(p, 7); mt.offset = term_len(p, p->defindent); mt.pardist = 1; n = man->first->child; 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, man); - term_newln(p); + 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; - } - n = n->next; + if (nn == NULL && strcmp(nc->string, "NAME") == 0) + nn = n; } + 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; @@ -185,7 +191,6 @@ terminal_man(void *arg, const struct roff_meta *man) print_man_nodelist(p, &mt, n, man); term_end(p); } - p->defindent = save_defindent; } /* @@ -197,42 +202,34 @@ terminal_man(void *arg, const struct roff_meta *man) * first, print it. */ static void -print_bvspace(struct termp *p, const struct roff_node *n, int pardist) +print_bvspace(struct termp *p, struct roff_node *n, int pardist) { - int i; + struct roff_node *nch; + int i; term_newln(p); - if (n->body && n->body->child) - if (n->body->child->type == ROFFT_TBL) - return; + if (n->body != NULL && + (nch = roff_node_child(n->body)) != NULL && + nch->type == ROFFT_TBL) + return; - if (n->parent->type == ROFFT_ROOT || n->parent->tok != MAN_RS) - if (NULL == n->prev) - return; + if (n->parent->tok != MAN_RS && roff_node_prev(n) == NULL) + return; for (i = 0; i < pardist; i++) term_vspace(p); } - static int -pre_abort(DECL_ARGS) -{ - abort(); -} - -static int pre_ign(DECL_ARGS) { - return 0; } static int pre_I(DECL_ARGS) { - term_fontrepl(p, TERMFONT_UNDER); return 1; } @@ -313,8 +310,8 @@ pre_alternate(DECL_ARGS) assert(nn->type == ROFFT_TEXT); term_word(p, nn->string); if (nn->flags & NODE_EOS) - p->flags |= TERMP_SENTENCE; - if (nn->next) + p->flags |= TERMP_SENTENCE; + if (nn->next != NULL) p->flags |= TERMP_NOSPACE; } return 0; @@ -323,27 +320,47 @@ pre_alternate(DECL_ARGS) static int pre_B(DECL_ARGS) { - term_fontrepl(p, TERMFONT_BOLD); return 1; } static int -pre_OP(DECL_ARGS) +pre_MR(DECL_ARGS) { + term_fontrepl(p, TERMFONT_NONE); + n = n->child; + if (n != NULL) { + term_word(p, n->string); /* name */ + p->flags |= TERMP_NOSPACE; + } + term_word(p, "("); + p->flags |= TERMP_NOSPACE; + if (n != NULL && (n = n->next) != NULL) { + term_word(p, n->string); /* section */ + p->flags |= TERMP_NOSPACE; + } + term_word(p, ")"); + if (n != NULL && (n = n->next) != NULL) { + p->flags |= TERMP_NOSPACE; + term_word(p, n->string); /* suffix */ + } + return 0; +} +static int +pre_OP(DECL_ARGS) +{ term_word(p, "["); p->flags |= TERMP_KEEP | TERMP_NOSPACE; - if (NULL != (n = n->child)) { + if ((n = n->child) != NULL) { term_fontrepl(p, TERMFONT_BOLD); term_word(p, n->string); } - if (NULL != n && NULL != n->next) { + if (n != NULL && n->next != NULL) { term_fontrepl(p, TERMFONT_UNDER); term_word(p, n->next->string); } - term_fontrepl(p, TERMFONT_NONE); p->flags &= ~TERMP_KEEP; p->flags |= TERMP_NOSPACE; @@ -369,9 +386,9 @@ pre_in(DECL_ARGS) cp = n->child->string; less = 0; - if ('-' == *cp) + if (*cp == '-') less = -1; - else if ('+' == *cp) + else if (*cp == '+') less = 1; else cp--; @@ -413,10 +430,12 @@ pre_HP(DECL_ARGS) case ROFFT_BLOCK: print_bvspace(p, n, mt->pardist); return 1; + case ROFFT_HEAD: + return 0; case ROFFT_BODY: break; default: - return 0; + abort(); } if (n->child == NULL) @@ -448,8 +467,10 @@ pre_HP(DECL_ARGS) static void post_HP(DECL_ARGS) { - switch (n->type) { + case ROFFT_BLOCK: + case ROFFT_HEAD: + break; case ROFFT_BODY: term_newln(p); @@ -469,25 +490,27 @@ post_HP(DECL_ARGS) p->tcol->rmargin = p->maxrmargin; break; default: - break; + abort(); } } static int pre_PP(DECL_ARGS) { - switch (n->type) { case ROFFT_BLOCK: - mt->lmargin[mt->lmargincur] = term_len(p, p->defindent); + mt->lmargin[mt->lmargincur] = term_len(p, 7); print_bvspace(p, n, mt->pardist); break; - default: + case ROFFT_HEAD: + return 0; + case ROFFT_BODY: p->tcol->offset = mt->offset; break; + default: + abort(); } - - return n->type != ROFFT_HEAD; + return 1; } static int @@ -498,18 +521,18 @@ pre_IP(DECL_ARGS) int len; switch (n->type) { - case ROFFT_BODY: - p->flags |= TERMP_NOSPACE; - break; + case ROFFT_BLOCK: + print_bvspace(p, n, mt->pardist); + return 1; case ROFFT_HEAD: p->flags |= TERMP_NOBREAK; p->trailspace = 1; break; - case ROFFT_BLOCK: - print_bvspace(p, n, mt->pardist); - /* FALLTHROUGH */ + case ROFFT_BODY: + p->flags |= TERMP_NOSPACE | TERMP_NONEWLINE; + break; default: - return 1; + abort(); } /* Calculate the offset from the optional second argument. */ @@ -529,7 +552,7 @@ pre_IP(DECL_ARGS) case ROFFT_HEAD: p->tcol->offset = mt->offset; p->tcol->rmargin = mt->offset + len; - if (n->child) + if (n->child != NULL) print_man_node(p, mt, n->child, meta); return 0; case ROFFT_BODY: @@ -537,7 +560,7 @@ pre_IP(DECL_ARGS) p->tcol->rmargin = p->maxrmargin; break; default: - break; + abort(); } return 1; } @@ -546,6 +569,8 @@ static void post_IP(DECL_ARGS) { switch (n->type) { + case ROFFT_BLOCK: + break; case ROFFT_HEAD: term_flushln(p); p->flags &= ~TERMP_NOBREAK; @@ -557,7 +582,7 @@ post_IP(DECL_ARGS) p->tcol->offset = mt->offset; break; default: - break; + abort(); } } @@ -569,19 +594,19 @@ pre_TP(DECL_ARGS) int len; switch (n->type) { + 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 ROFFT_BODY: - p->flags |= TERMP_NOSPACE; + p->flags |= TERMP_NOSPACE | TERMP_NONEWLINE; break; - case ROFFT_BLOCK: - if (n->tok == MAN_TP) - print_bvspace(p, n, mt->pardist); - /* FALLTHROUGH */ default: - return 1; + abort(); } /* Calculate offset. */ @@ -605,10 +630,10 @@ pre_TP(DECL_ARGS) /* Don't print same-line elements. */ nn = n->child; - while (NULL != nn && 0 == (NODE_LINE & nn->flags)) + while (nn != NULL && (nn->flags & NODE_LINE) == 0) nn = nn->next; - while (NULL != nn) { + while (nn != NULL) { print_man_node(p, mt, nn, meta); nn = nn->next; } @@ -620,7 +645,7 @@ pre_TP(DECL_ARGS) p->flags &= ~(TERMP_NOBREAK | TERMP_BRTRSP); break; default: - break; + abort(); } return 1; } @@ -629,6 +654,8 @@ static void post_TP(DECL_ARGS) { switch (n->type) { + case ROFFT_BLOCK: + break; case ROFFT_HEAD: term_flushln(p); break; @@ -637,7 +664,7 @@ post_TP(DECL_ARGS) p->tcol->offset = mt->offset; break; default: - break; + abort(); } } @@ -648,7 +675,7 @@ pre_SS(DECL_ARGS) switch (n->type) { case ROFFT_BLOCK: - mt->lmargin[mt->lmargincur] = term_len(p, p->defindent); + mt->lmargin[mt->lmargincur] = term_len(p, 7); mt->offset = term_len(p, p->defindent); /* @@ -656,12 +683,8 @@ pre_SS(DECL_ARGS) * and after an empty subsection. */ - do { - n = n->prev; - } while (n != NULL && n->tok >= MAN_TH && - man_term_act(n->tok)->flags & MAN_NOTEXT); - if (n == NULL || n->type == ROFFT_COMMENT || - (n->tok == MAN_SS && n->body->child == NULL)) + if ((n = roff_node_prev(n)) == NULL || + (n->tok == MAN_SS && roff_node_child(n->body) == NULL)) break; for (i = 0; i < mt->pardist; i++) @@ -683,26 +706,9 @@ pre_SS(DECL_ARGS) default: break; } - return 1; } -static void -post_SS(DECL_ARGS) -{ - - switch (n->type) { - case ROFFT_HEAD: - term_newln(p); - break; - case ROFFT_BODY: - term_newln(p); - break; - default: - break; - } -} - static int pre_SH(DECL_ARGS) { @@ -710,7 +716,7 @@ pre_SH(DECL_ARGS) switch (n->type) { case ROFFT_BLOCK: - mt->lmargin[mt->lmargincur] = term_len(p, p->defindent); + mt->lmargin[mt->lmargincur] = term_len(p, 7); mt->offset = term_len(p, p->defindent); /* @@ -718,12 +724,8 @@ pre_SH(DECL_ARGS) * and after an empty section. */ - do { - n = n->prev; - } while (n != NULL && n->tok >= MAN_TH && - man_term_act(n->tok)->flags & MAN_NOTEXT); - if (n == NULL || n->type == ROFFT_COMMENT || - (n->tok == MAN_SH && n->body->child == NULL)) + if ((n = roff_node_prev(n)) == NULL || + (n->tok == MAN_SH && roff_node_child(n->body) == NULL)) break; for (i = 0; i < mt->pardist; i++) @@ -743,25 +745,23 @@ pre_SH(DECL_ARGS) p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND); break; default: - break; + abort(); } - return 1; } static void post_SH(DECL_ARGS) { - switch (n->type) { - case ROFFT_HEAD: - term_newln(p); + case ROFFT_BLOCK: break; + case ROFFT_HEAD: case ROFFT_BODY: term_newln(p); break; default: - break; + abort(); } } @@ -776,8 +776,10 @@ pre_RS(DECL_ARGS) return 1; case ROFFT_HEAD: return 0; - default: + case ROFFT_BODY: break; + default: + abort(); } n = n->parent->head; @@ -798,27 +800,25 @@ pre_RS(DECL_ARGS) if (++mt->lmarginsz < MAXMARGINS) mt->lmargincur = mt->lmarginsz; - mt->lmargin[mt->lmargincur] = term_len(p, p->defindent); + mt->lmargin[mt->lmargincur] = term_len(p, 7); return 1; } static void post_RS(DECL_ARGS) { - switch (n->type) { case ROFFT_BLOCK: - return; case ROFFT_HEAD: return; - default: - term_newln(p); + 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; } @@ -831,7 +831,7 @@ pre_SY(DECL_ARGS) switch (n->type) { case ROFFT_BLOCK: - if (n->prev == NULL || n->prev->tok != MAN_SY) + if ((nn = roff_node_prev(n)) == NULL || nn->tok != MAN_SY) print_bvspace(p, n, mt->pardist); return 1; case ROFFT_HEAD: @@ -848,7 +848,9 @@ pre_SY(DECL_ARGS) case ROFFT_HEAD: p->tcol->offset = mt->offset; p->tcol->rmargin = mt->offset + len; - p->flags |= TERMP_NOBREAK; + 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: @@ -867,6 +869,8 @@ static void post_SY(DECL_ARGS) { switch (n->type) { + case ROFFT_BLOCK: + break; case ROFFT_HEAD: term_flushln(p); p->flags &= ~TERMP_NOBREAK; @@ -876,28 +880,26 @@ post_SY(DECL_ARGS) p->tcol->offset = mt->offset; break; default: - break; + 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 (NULL != n->child->child) + if (n->child->child != NULL) print_man_node(p, mt, n->child->child, meta); p->flags |= TERMP_NOSPACE; @@ -910,6 +912,25 @@ print_man_node(DECL_ARGS) const struct man_term_act *act; int c; + /* + * In no-fill mode, break the output line at the beginning + * of new input lines except after \c, and nowhere else. + */ + + 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; + } + + if (n->flags & NODE_ID) + term_tag_write(n, p->line); + switch (n->type) { case ROFFT_TEXT: /* @@ -942,7 +963,7 @@ print_man_node(DECL_ARGS) return; case ROFFT_TBL: if (p->tbl.cols == NULL) - term_vspace(p); + term_newln(p); term_tbl(p, n->span); return; default: @@ -962,7 +983,7 @@ print_man_node(DECL_ARGS) if (act->pre != NULL) c = (*act->pre)(p, mt, n, meta); - if (c && n->child) + if (c && n->child != NULL) print_man_nodelist(p, mt, n->child, meta); if (act->post != NULL) @@ -971,37 +992,19 @@ print_man_node(DECL_ARGS) 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 (n->flags & NODE_NOFILL && - ! (p->flags & (TERMP_NOBREAK | TERMP_NONEWLINE)) && - (n->next == NULL || n->next->flags & NODE_LINE)) { - p->flags |= TERMP_BRNEVER | TERMP_NOSPACE; - if (n->string != NULL && *n->string != '\0') - term_flushln(p); - else - term_newln(p); - p->flags &= ~TERMP_BRNEVER; - if (p->tcol->rmargin < p->maxrmargin && - n->parent->tok == MAN_HP) { - p->tcol->offset = p->tcol->rmargin; - p->tcol->rmargin = p->maxrmargin; - } + 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 (NODE_EOS & n->flags) + if (n->flags & NODE_EOS) p->flags |= TERMP_SENTENCE; } - static void print_man_nodelist(DECL_ARGS) { - while (n != NULL) { print_man_node(p, mt, n, meta); n = n->next; @@ -1030,13 +1033,9 @@ print_man_foot(struct termp *p, const struct roff_meta */ 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) { + } else if (meta->os != NULL) { title = mandoc_strdup(meta->os); } else { title = mandoc_strdup(""); @@ -1152,9 +1151,5 @@ print_man_head(struct termp *p, const struct roff_meta */ term_vspace(p); - if ( ! p->mdocstyle) { - term_vspace(p); - term_vspace(p); - } free(title); }