=================================================================== RCS file: /cvs/mandoc/man.c,v retrieving revision 1.102 retrieving revision 1.187 diff -u -p -r1.102 -r1.187 --- mandoc/man.c 2011/03/07 01:35:51 1.102 +++ mandoc/man.c 2019/01/05 00:36:50 1.187 @@ -1,447 +1,145 @@ -/* $Id: man.c,v 1.102 2011/03/07 01:35:51 schwarze Exp $ */ +/* $Id: man.c,v 1.187 2019/01/05 00:36:50 schwarze Exp $ */ /* * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons + * Copyright (c) 2013-2015, 2017-2019 Ingo Schwarze + * Copyright (c) 2011 Joerg Sonnenberger * * 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. */ -#ifdef HAVE_CONFIG_H #include "config.h" -#endif #include #include +#include #include #include #include #include +#include "mandoc_aux.h" #include "mandoc.h" -#include "libman.h" +#include "roff.h" +#include "man.h" #include "libmandoc.h" +#include "roff_int.h" +#include "libman.h" -const char *const __man_macronames[MAN_MAX] = { - "br", "TH", "SH", "SS", - "TP", "LP", "PP", "P", - "IP", "HP", "SM", "SB", - "BI", "IB", "BR", "RB", - "R", "B", "I", "IR", - "RI", "na", "sp", "nf", - "fi", "RE", "RS", "DT", - "UC", "PD", "AT", "in", - "ft" - }; +static char *man_hasc(char *); +static int man_ptext(struct roff_man *, int, char *, int); +static int man_pmacro(struct roff_man *, int, char *, int); -const char * const *man_macronames = __man_macronames; -static struct man_node *man_node_alloc(struct man *, int, int, - enum man_type, enum mant); -static int man_node_append(struct man *, - struct man_node *); -static void man_node_free(struct man_node *); -static void man_node_unlink(struct man *, - struct man_node *); -static int man_ptext(struct man *, int, char *, int); -static int man_pmacro(struct man *, int, char *, int); -static void man_free1(struct man *); -static void man_alloc1(struct man *); -static int man_descope(struct man *, int, int); - - -const struct man_node * -man_node(const struct man *m) -{ - - assert( ! (MAN_HALT & m->flags)); - return(m->first); -} - - -const struct man_meta * -man_meta(const struct man *m) -{ - - assert( ! (MAN_HALT & m->flags)); - return(&m->meta); -} - - -void -man_reset(struct man *man) -{ - - man_free1(man); - man_alloc1(man); -} - - -void -man_free(struct man *man) -{ - - man_free1(man); - free(man); -} - - -struct man * -man_alloc(struct regset *regs, void *data, mandocmsg msg) -{ - struct man *p; - - p = mandoc_calloc(1, sizeof(struct man)); - - man_hash_init(); - p->data = data; - p->msg = msg; - p->regs = regs; - - man_alloc1(p); - return(p); -} - - int -man_endparse(struct man *m) +man_parseln(struct roff_man *man, int ln, char *buf, int offs) { - assert( ! (MAN_HALT & m->flags)); - if (man_macroend(m)) - return(1); - m->flags |= MAN_HALT; - return(0); -} + if (man->last->type != ROFFT_EQN || ln > man->last->line) + man->flags |= MAN_NEWLINE; - -int -man_parseln(struct man *m, int ln, char *buf, int offs) -{ - - m->flags |= MAN_NEWLINE; - - assert( ! (MAN_HALT & m->flags)); - return(('.' == buf[offs] || '\'' == buf[offs]) ? - man_pmacro(m, ln, buf, offs) : - man_ptext(m, ln, buf, offs)); + return roff_getcontrol(man->roff, buf, &offs) ? + man_pmacro(man, ln, buf, offs) : + man_ptext(man, ln, buf, offs); } - -static void -man_free1(struct man *man) -{ - - if (man->first) - man_node_delete(man, man->first); - if (man->meta.title) - free(man->meta.title); - if (man->meta.source) - free(man->meta.source); - if (man->meta.date) - free(man->meta.date); - if (man->meta.vol) - free(man->meta.vol); - if (man->meta.msec) - free(man->meta.msec); -} - - -static void -man_alloc1(struct man *m) -{ - - memset(&m->meta, 0, sizeof(struct man_meta)); - m->flags = 0; - m->last = mandoc_calloc(1, sizeof(struct man_node)); - m->first = m->last; - m->last->type = MAN_ROOT; - m->last->tok = MAN_MAX; - m->next = MAN_NEXT_CHILD; -} - - -static int -man_node_append(struct man *man, struct man_node *p) -{ - - assert(man->last); - assert(man->first); - assert(MAN_ROOT != p->type); - - switch (man->next) { - case (MAN_NEXT_SIBLING): - man->last->next = p; - p->prev = man->last; - p->parent = man->last->parent; - break; - case (MAN_NEXT_CHILD): - man->last->child = p; - p->parent = man->last; - break; - default: - abort(); - /* NOTREACHED */ - } - - assert(p->parent); - p->parent->nchild++; - - if ( ! man_valid_pre(man, p)) - return(0); - - switch (p->type) { - case (MAN_HEAD): - assert(MAN_BLOCK == p->parent->type); - p->parent->head = p; - break; - case (MAN_BODY): - assert(MAN_BLOCK == p->parent->type); - p->parent->body = p; - break; - default: - break; - } - - man->last = p; - - switch (p->type) { - case (MAN_TBL): - /* FALLTHROUGH */ - case (MAN_TEXT): - if ( ! man_valid_post(man)) - return(0); - break; - default: - break; - } - - return(1); -} - - -static struct man_node * -man_node_alloc(struct man *m, int line, int pos, - enum man_type type, enum mant tok) -{ - struct man_node *p; - - p = mandoc_calloc(1, sizeof(struct man_node)); - p->line = line; - p->pos = pos; - p->type = type; - p->tok = tok; - - if (MAN_NEWLINE & m->flags) - p->flags |= MAN_LINE; - m->flags &= ~MAN_NEWLINE; - return(p); -} - - -int -man_elem_alloc(struct man *m, int line, int pos, enum mant tok) -{ - struct man_node *p; - - p = man_node_alloc(m, line, pos, MAN_ELEM, tok); - if ( ! man_node_append(m, p)) - return(0); - m->next = MAN_NEXT_CHILD; - return(1); -} - - -int -man_head_alloc(struct man *m, int line, int pos, enum mant tok) -{ - struct man_node *p; - - p = man_node_alloc(m, line, pos, MAN_HEAD, tok); - if ( ! man_node_append(m, p)) - return(0); - m->next = MAN_NEXT_CHILD; - return(1); -} - - -int -man_body_alloc(struct man *m, int line, int pos, enum mant tok) -{ - struct man_node *p; - - p = man_node_alloc(m, line, pos, MAN_BODY, tok); - if ( ! man_node_append(m, p)) - return(0); - m->next = MAN_NEXT_CHILD; - return(1); -} - - -int -man_block_alloc(struct man *m, int line, int pos, enum mant tok) -{ - struct man_node *p; - - p = man_node_alloc(m, line, pos, MAN_BLOCK, tok); - if ( ! man_node_append(m, p)) - return(0); - m->next = MAN_NEXT_CHILD; - return(1); -} - -int -man_word_alloc(struct man *m, int line, int pos, const char *word) -{ - struct man_node *n; - size_t sv, len; - - len = strlen(word); - - n = man_node_alloc(m, line, pos, MAN_TEXT, MAN_MAX); - n->string = mandoc_malloc(len + 1); - sv = strlcpy(n->string, word, len + 1); - - /* Prohibit truncation. */ - assert(sv < len + 1); - - if ( ! man_node_append(m, n)) - return(0); - - m->next = MAN_NEXT_SIBLING; - return(1); -} - - /* - * Free all of the resources held by a node. This does NOT unlink a - * node from its context; for that, see man_node_unlink(). + * If the string ends with \c, return a pointer to the backslash. + * Otherwise, return NULL. */ -static void -man_node_free(struct man_node *p) +static char * +man_hasc(char *start) { + char *cp, *ep; - if (p->string) - free(p->string); - free(p); + ep = strchr(start, '\0') - 2; + if (ep < start || ep[0] != '\\' || ep[1] != 'c') + return NULL; + for (cp = ep; cp > start; cp--) + if (cp[-1] != '\\') + break; + return (ep - cp) % 2 ? NULL : ep; } - void -man_node_delete(struct man *m, struct man_node *p) +man_descope(struct roff_man *man, int line, int offs, char *start) { + /* Trailing \c keeps next-line scope open. */ - while (p->child) - man_node_delete(m, p->child); + if (start != NULL && man_hasc(start) != NULL) + return; - man_node_unlink(m, p); - man_node_free(p); -} - -int -man_addeqn(struct man *m, const struct eqn *ep) -{ - struct man_node *n; - - assert( ! (MAN_HALT & m->flags)); - - n = man_node_alloc(m, ep->line, ep->pos, MAN_EQN, MAN_MAX); - n->eqn = ep; - - if ( ! man_node_append(m, n)) - return(0); - - m->next = MAN_NEXT_SIBLING; - return(man_descope(m, ep->line, ep->pos)); -} - -int -man_addspan(struct man *m, const struct tbl_span *sp) -{ - struct man_node *n; - - assert( ! (MAN_HALT & m->flags)); - - n = man_node_alloc(m, sp->line, 0, MAN_TBL, MAN_MAX); - n->span = sp; - - if ( ! man_node_append(m, n)) - return(0); - - m->next = MAN_NEXT_SIBLING; - return(man_descope(m, sp->line, 0)); -} - -static int -man_descope(struct man *m, int line, int offs) -{ /* * Co-ordinate what happens with having a next-line scope open: - * first close out the element scope (if applicable), then close - * out the block scope (also if applicable). + * first close out the element scopes (if applicable), + * then close out the block scope (also if applicable). */ - if (MAN_ELINE & m->flags) { - m->flags &= ~MAN_ELINE; - if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX)) - return(0); + if (man->flags & MAN_ELINE) { + while (man->last->parent->type != ROFFT_ROOT && + man_macro(man->last->parent->tok)->flags & MAN_ESCOPED) + man_unscope(man, man->last->parent); + man->flags &= ~MAN_ELINE; } - - if ( ! (MAN_BLINE & m->flags)) - return(1); - m->flags &= ~MAN_BLINE; - - if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX)) - return(0); - return(man_body_alloc(m, line, offs, m->last->tok)); + if ( ! (man->flags & MAN_BLINE)) + return; + man_unscope(man, man->last->parent); + roff_body_alloc(man, line, offs, man->last->tok); + man->flags &= ~(MAN_BLINE | ROFF_NONOFILL); } - static int -man_ptext(struct man *m, int line, char *buf, int offs) +man_ptext(struct roff_man *man, int line, char *buf, int offs) { int i; + char *ep; - /* Ignore bogus comments. */ + /* In no-fill mode, whitespace is preserved on text lines. */ - if ('\\' == buf[offs] && - '.' == buf[offs + 1] && - '"' == buf[offs + 2]) { - man_pmsg(m, line, offs, MANDOCERR_BADCOMMENT); - return(1); + if (man->flags & ROFF_NOFILL) { + roff_word_alloc(man, line, offs, buf + offs); + man_descope(man, line, offs, buf + offs); + return 1; } - /* Literal free-form text whitespace is preserved. */ - - if (MAN_LITERAL & m->flags) { - if ( ! man_word_alloc(m, line, offs, buf + offs)) - return(0); - return(man_descope(m, line, offs)); - } - - /* Pump blank lines directly into the backend. */ - - for (i = offs; ' ' == buf[i]; i++) + for (i = offs; buf[i] == ' '; i++) /* Skip leading whitespace. */ ; - if ('\0' == buf[i]) { - /* Allocate a blank entry. */ - if ( ! man_word_alloc(m, line, offs, "")) - return(0); - return(man_descope(m, line, offs)); + /* + * Blank lines are ignored in next line scope + * and right after headings and cancel preceding \c, + * but add a single vertical space elsewhere. + */ + + if (buf[i] == '\0') { + if (man->flags & (MAN_ELINE | MAN_BLINE)) { + mandoc_msg(MANDOCERR_BLK_BLANK, line, 0, NULL); + return 1; + } + if (man->last->tok == MAN_SH || man->last->tok == MAN_SS) + return 1; + if (man->last->type == ROFFT_TEXT && + ((ep = man_hasc(man->last->string)) != NULL)) { + *ep = '\0'; + return 1; + } + roff_elem_alloc(man, line, offs, ROFF_sp); + man->next = ROFF_NEXT_SIBLING; + return 1; } - /* + /* * Warn if the last un-escaped character is whitespace. Then - * strip away the remaining spaces (tabs stay!). + * strip away the remaining spaces (tabs stay!). */ i = (int)strlen(buf); @@ -449,7 +147,7 @@ man_ptext(struct man *m, int line, char *buf, int offs if (' ' == buf[i - 1] || '\t' == buf[i - 1]) { if (i > 1 && '\\' != buf[i - 2]) - man_pmsg(m, line, i - 1, MANDOCERR_EOLNSPACE); + mandoc_msg(MANDOCERR_SPACE_EOL, line, i - 1, NULL); for (--i; i && ' ' == buf[i]; i--) /* Spin back to non-space. */ ; @@ -459,10 +157,8 @@ man_ptext(struct man *m, int line, char *buf, int offs buf[i] = '\0'; } + roff_word_alloc(man, line, offs, buf + offs); - if ( ! man_word_alloc(m, line, offs, buf + offs)) - return(0); - /* * End-of-sentence check. If the last character is an unescaped * EOS character, then flag the node as being the end of a @@ -470,209 +166,180 @@ man_ptext(struct man *m, int line, char *buf, int offs */ assert(i); - if (mandoc_eos(buf, (size_t)i, 0)) - m->last->flags |= MAN_EOS; + if (mandoc_eos(buf, (size_t)i)) + man->last->flags |= NODE_EOS; - return(man_descope(m, line, offs)); + man_descope(man, line, offs, buf + offs); + return 1; } - static int -man_pmacro(struct man *m, int ln, char *buf, int offs) +man_pmacro(struct roff_man *man, int ln, char *buf, int offs) { - int i, j, ppos; - enum mant tok; - char mac[5]; - struct man_node *n; + struct roff_node *n; + const char *cp; + size_t sz; + enum roff_tok tok; + int ppos; + int bline; - /* Comments and empties are quickly ignored. */ + /* Determine the line macro. */ - offs++; - - if ('\0' == buf[offs]) - return(1); - - i = offs; - - /* - * Skip whitespace between the control character and initial - * text. "Whitespace" is both spaces and tabs. - */ - - if (' ' == buf[i] || '\t' == buf[i]) { - i++; - while (buf[i] && (' ' == buf[i] || '\t' == buf[i])) - i++; - if ('\0' == buf[i]) - goto out; + ppos = offs; + tok = TOKEN_NONE; + for (sz = 0; sz < 4 && strchr(" \t\\", buf[offs]) == NULL; sz++) + offs++; + if (sz > 0 && sz < 4) + tok = roffhash_find(man->manmac, buf + ppos, sz); + if (tok == TOKEN_NONE) { + mandoc_msg(MANDOCERR_MACRO, ln, ppos, "%s", buf + ppos - 1); + return 1; } - ppos = i; + /* Skip a leading escape sequence or tab. */ - /* - * Copy the first word into a nil-terminated buffer. - * Stop copying when a tab, space, or eoln is encountered. - */ - - j = 0; - while (j < 4 && '\0' != buf[i] && ' ' != buf[i] && '\t' != buf[i]) - mac[j++] = buf[i++]; - mac[j] = '\0'; - - tok = (j > 0 && j < 4) ? man_hash_find(mac) : MAN_MAX; - if (MAN_MAX == tok) { - man_vmsg(m, MANDOCERR_MACRO, ln, ppos, "%s", buf + ppos - 1); - return(1); + switch (buf[offs]) { + case '\\': + cp = buf + offs + 1; + mandoc_escape(&cp, NULL, NULL); + offs = cp - buf; + break; + case '\t': + offs++; + break; + default: + break; } - /* The macro is sane. Jump to the next word. */ + /* Jump to the next non-whitespace word. */ - while (buf[i] && ' ' == buf[i]) - i++; + while (buf[offs] == ' ') + offs++; - /* + /* * Trailing whitespace. Note that tabs are allowed to be passed * into the parser as "text", so we only warn about spaces here. */ - if ('\0' == buf[i] && ' ' == buf[i - 1]) - man_pmsg(m, ln, i - 1, MANDOCERR_EOLNSPACE); + if (buf[offs] == '\0' && buf[offs - 1] == ' ') + mandoc_msg(MANDOCERR_SPACE_EOL, ln, offs - 1, NULL); - /* - * Remove prior ELINE macro, as it's being clobbered by a new - * macro. Note that NSCOPED macros do not close out ELINE - * macros---they don't print text---so we let those slip by. + /* + * Some macros break next-line scopes; otherwise, remember + * whether we are in next-line scope for a block head. */ - if ( ! (MAN_NSCOPED & man_macros[tok].flags) && - m->flags & MAN_ELINE) { - n = m->last; - assert(MAN_TEXT != n->type); + man_breakscope(man, tok); + bline = man->flags & MAN_BLINE; - /* Remove repeated NSCOPED macros causing ELINE. */ - - if (MAN_NSCOPED & man_macros[n->tok].flags) - n = n->parent; - - man_vmsg(m, MANDOCERR_LINESCOPE, n->line, n->pos, - "%s", man_macronames[n->tok]); - - man_node_delete(m, n); - m->flags &= ~MAN_ELINE; - } - /* - * Save the fact that we're in the next-line for a block. In - * this way, embedded roff instructions can "remember" state - * when they exit. + * If the line in next-line scope ends with \c, keep the + * next-line scope open for the subsequent input line. + * That is not at all portable, only groff >= 1.22.4 + * does it, but *if* this weird idiom occurs in a manual + * page, that's very likely what the author intended. */ - if (MAN_BLINE & m->flags) - m->flags |= MAN_BPLINE; + if (bline && man_hasc(buf + offs)) + bline = 0; /* Call to handler... */ - assert(man_macros[tok].fp); - if ( ! (*man_macros[tok].fp)(m, tok, ln, ppos, &i, buf)) - goto err; + (*man_macro(tok)->fp)(man, tok, ln, ppos, &offs, buf); -out: - /* - * We weren't in a block-line scope when entering the - * above-parsed macro, so return. - */ + /* In quick mode (for mandocdb), abort after the NAME section. */ - if ( ! (MAN_BPLINE & m->flags)) { - m->flags &= ~MAN_ILINE; - return(1); + if (man->quick && tok == MAN_SH) { + n = man->last; + if (n->type == ROFFT_BODY && + strcmp(n->prev->child->string, "NAME")) + return 2; } - m->flags &= ~MAN_BPLINE; /* - * If we're in a block scope, then allow this macro to slip by - * without closing scope around it. + * If we are in a next-line scope for a block head, + * close it out now and switch to the body, + * unless the next-line scope is allowed to continue. */ - if (MAN_ILINE & m->flags) { - m->flags &= ~MAN_ILINE; - return(1); - } + if (bline == 0 || + (man->flags & MAN_BLINE) == 0 || + man->flags & MAN_ELINE || + man_macro(tok)->flags & MAN_NSCOPED) + return 1; - /* - * If we've opened a new next-line element scope, then return - * now, as the next line will close out the block scope. - */ - - if (MAN_ELINE & m->flags) - return(1); - - /* Close out the block scope opened in the prior line. */ - - assert(MAN_BLINE & m->flags); - m->flags &= ~MAN_BLINE; - - if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX)) - return(0); - return(man_body_alloc(m, ln, offs, m->last->tok)); - -err: /* Error out. */ - - m->flags |= MAN_HALT; - return(0); + man_unscope(man, man->last->parent); + roff_body_alloc(man, ln, ppos, man->last->tok); + man->flags &= ~(MAN_BLINE | ROFF_NONOFILL); + return 1; } - -int -man_vmsg(struct man *man, enum mandocerr t, - int ln, int pos, const char *fmt, ...) +void +man_breakscope(struct roff_man *man, int tok) { - char buf[256]; - va_list ap; + struct roff_node *n; - va_start(ap, fmt); - vsnprintf(buf, sizeof(buf) - 1, fmt, ap); - va_end(ap); - return((*man->msg)(t, man->data, ln, pos, buf)); -} + /* + * An element next line scope is open, + * and the new macro is not allowed inside elements. + * Delete the element that is being broken. + */ + if (man->flags & MAN_ELINE && (tok < MAN_TH || + (man_macro(tok)->flags & MAN_NSCOPED) == 0)) { + n = man->last; + if (n->type == ROFFT_TEXT) + n = n->parent; + if (n->tok < MAN_TH || + (man_macro(n->tok)->flags & (MAN_NSCOPED | MAN_ESCOPED)) + == MAN_NSCOPED) + n = n->parent; -/* - * Unlink a node from its context. If "m" is provided, the last parse - * point will also be adjusted accordingly. - */ -static void -man_node_unlink(struct man *m, struct man_node *n) -{ + mandoc_msg(MANDOCERR_BLK_LINE, n->line, n->pos, + "%s breaks %s", roff_name[tok], roff_name[n->tok]); - /* Adjust siblings. */ + roff_node_delete(man, n); + man->flags &= ~MAN_ELINE; + } - if (n->prev) - n->prev->next = n->next; - if (n->next) - n->next->prev = n->prev; + /* + * Weird special case: + * Switching fill mode closes section headers. + */ - /* Adjust parent. */ - - if (n->parent) { - n->parent->nchild--; - if (n->parent->child == n) - n->parent->child = n->prev ? n->prev : n->next; + if (man->flags & MAN_BLINE && + (tok == ROFF_nf || tok == ROFF_fi) && + (man->last->tok == MAN_SH || man->last->tok == MAN_SS)) { + n = man->last; + man_unscope(man, n); + roff_body_alloc(man, n->line, n->pos, n->tok); + man->flags &= ~(MAN_BLINE | ROFF_NONOFILL); } - /* Adjust parse point, if applicable. */ + /* + * A block header next line scope is open, + * and the new macro is not allowed inside block headers. + * Delete the block that is being broken. + */ - if (m && m->last == n) { - /*XXX: this can occur when bailing from validation. */ - /*assert(NULL == n->next);*/ - if (n->prev) { - m->last = n->prev; - m->next = MAN_NEXT_SIBLING; - } else { - m->last = n->parent; - m->next = MAN_NEXT_CHILD; - } - } + if (man->flags & MAN_BLINE && tok != ROFF_nf && tok != ROFF_fi && + (tok < MAN_TH || man_macro(tok)->flags & MAN_XSCOPE)) { + n = man->last; + if (n->type == ROFFT_TEXT) + n = n->parent; + if (n->tok < MAN_TH || + (man_macro(n->tok)->flags & MAN_XSCOPE) == 0) + n = n->parent; - if (m && m->first == n) - m->first = NULL; + assert(n->type == ROFFT_HEAD); + n = n->parent; + assert(n->type == ROFFT_BLOCK); + assert(man_macro(n->tok)->flags & MAN_BSCOPED); + + mandoc_msg(MANDOCERR_BLK_LINE, n->line, n->pos, + "%s breaks %s", roff_name[tok], roff_name[n->tok]); + + roff_node_delete(man, n); + man->flags &= ~(MAN_BLINE | ROFF_NONOFILL); + } }