=================================================================== RCS file: /cvs/mandoc/man.c,v retrieving revision 1.26 retrieving revision 1.157 diff -u -p -r1.26 -r1.157 --- mandoc/man.c 2009/07/04 09:01:55 1.26 +++ mandoc/man.c 2015/04/18 17:53:21 1.157 @@ -1,19 +1,25 @@ -/* $Id: man.c,v 1.26 2009/07/04 09:01:55 kristaps Exp $ */ +/* $Id: man.c,v 1.157 2015/04/18 17:53:21 schwarze Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons + * Copyright (c) 2013, 2014, 2015 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. */ +#include "config.h" + +#include + #include #include #include @@ -21,160 +27,75 @@ #include #include +#include "mandoc_aux.h" +#include "mandoc.h" +#include "roff.h" +#include "man.h" +#include "libmandoc.h" #include "libman.h" -const char *const __man_macronames[MAN_MAX] = { +const char *const __man_macronames[MAN_MAX] = { "br", "TH", "SH", "SS", - "TP", "LP", "PP", "P", + "TP", "LP", "PP", "P", "IP", "HP", "SM", "SB", "BI", "IB", "BR", "RB", "R", "B", "I", "IR", - "RI", "na", "i" + "RI", "sp", "nf", + "fi", "RE", "RS", "DT", + "UC", "PD", "AT", "in", + "ft", "OP", "EX", "EE", + "UR", "UE", "ll" }; const char * const *man_macronames = __man_macronames; -static struct man_node *man_node_alloc(int, int, - enum man_type, int); -static int man_node_append(struct man *, - struct man_node *); -static int man_ptext(struct man *, int, char *); -static int man_pmacro(struct man *, int, char *); -static void man_free1(struct man *); -static int man_alloc1(struct man *); +static void man_breakscope(struct roff_man *, int); +static void man_descope(struct roff_man *, int, int); +static struct roff_node *man_node_alloc(struct roff_man *, int, int, + enum roff_type, int); +static void man_node_append(struct roff_man *, + struct roff_node *); +static void man_node_free(struct roff_node *); +static void man_node_unlink(struct roff_man *, + struct roff_node *); +static int man_ptext(struct roff_man *, int, char *, int); +static int man_pmacro(struct roff_man *, int, char *, int); -const struct man_node * -man_node(const struct man *m) -{ - - return(MAN_HALT & m->flags ? NULL : m->first); -} - - -const struct man_meta * -man_meta(const struct man *m) -{ - - return(MAN_HALT & m->flags ? NULL : &m->meta); -} - - -int -man_reset(struct man *man) -{ - - man_free1(man); - return(man_alloc1(man)); -} - - void -man_free(struct man *man) +man_endparse(struct roff_man *man) { - man_free1(man); - - if (man->htab) - man_hash_free(man->htab); - free(man); + man_macroend(man); } - -struct man * -man_alloc(void *data, int pflags, const struct man_cb *cb) -{ - struct man *p; - - if (NULL == (p = calloc(1, sizeof(struct man)))) - return(NULL); - - if ( ! man_alloc1(p)) { - free(p); - return(NULL); - } - - p->data = data; - p->pflags = pflags; - (void)memcpy(&p->cb, cb, sizeof(struct man_cb)); - - if (NULL == (p->htab = man_hash_alloc())) { - free(p); - return(NULL); - } - return(p); -} - - int -man_endparse(struct man *m) +man_parseln(struct roff_man *man, int ln, char *buf, int offs) { - if (MAN_HALT & m->flags) - return(0); - else 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) -{ - - return('.' == *buf ? - man_pmacro(m, ln, buf) : - man_ptext(m, ln, buf)); + 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) +man_node_append(struct roff_man *man, struct roff_node *p) { - if (man->first) - man_node_freelist(man->first); - if (man->meta.title) - free(man->meta.title); - if (man->meta.source) - free(man->meta.source); - if (man->meta.vol) - free(man->meta.vol); -} - - -static int -man_alloc1(struct man *m) -{ - - bzero(&m->meta, sizeof(struct man_meta)); - m->flags = 0; - m->last = calloc(1, sizeof(struct man_node)); - if (NULL == m->last) - return(0); - m->first = m->last; - m->last->type = MAN_ROOT; - m->next = MAN_NEXT_CHILD; - return(1); -} - - -static int -man_node_append(struct man *man, struct man_node *p) -{ - assert(man->last); assert(man->first); - assert(MAN_ROOT != p->type); + assert(p->type != ROFFT_ROOT); switch (man->next) { - case (MAN_NEXT_SIBLING): + case ROFF_NEXT_SIBLING: man->last->next = p; p->prev = man->last; p->parent = man->last->parent; break; - case (MAN_NEXT_CHILD): + case ROFF_NEXT_CHILD: man->last->child = p; p->parent = man->last; break; @@ -182,304 +103,509 @@ man_node_append(struct man *man, struct man_node *p) abort(); /* NOTREACHED */ } - + + assert(p->parent); p->parent->nchild++; + switch (p->type) { + case ROFFT_BLOCK: + if (p->tok == MAN_SH || p->tok == MAN_SS) + man->flags &= ~MAN_LITERAL; + break; + case ROFFT_HEAD: + assert(p->parent->type == ROFFT_BLOCK); + p->parent->head = p; + break; + case ROFFT_BODY: + assert(p->parent->type == ROFFT_BLOCK); + p->parent->body = p; + break; + default: + break; + } + man->last = p; switch (p->type) { - case (MAN_TEXT): - if ( ! man_valid_post(man)) - return(0); - if ( ! man_action_post(man)) - return(0); + case ROFFT_TBL: + /* FALLTHROUGH */ + case ROFFT_TEXT: + man_valid_post(man); break; default: break; } - - return(1); } - -static struct man_node * -man_node_alloc(int line, int pos, enum man_type type, int tok) +static struct roff_node * +man_node_alloc(struct roff_man *man, int line, int pos, + enum roff_type type, int tok) { - struct man_node *p; + struct roff_node *p; - p = calloc(1, sizeof(struct man_node)); - if (NULL == p) - return(NULL); - + p = mandoc_calloc(1, sizeof(*p)); p->line = line; p->pos = pos; p->type = type; p->tok = tok; + + if (man->flags & MAN_NEWLINE) + p->flags |= MAN_LINE; + man->flags &= ~MAN_NEWLINE; return(p); } +void +man_elem_alloc(struct roff_man *man, int line, int pos, int tok) +{ + struct roff_node *p; -int -man_elem_alloc(struct man *man, int line, int pos, int tok) + p = man_node_alloc(man, line, pos, ROFFT_ELEM, tok); + man_node_append(man, p); + man->next = ROFF_NEXT_CHILD; +} + +void +man_head_alloc(struct roff_man *man, int line, int pos, int tok) { - struct man_node *p; + struct roff_node *p; - p = man_node_alloc(line, pos, MAN_ELEM, tok); - if (NULL == p) - return(0); - return(man_node_append(man, p)); + p = man_node_alloc(man, line, pos, ROFFT_HEAD, tok); + man_node_append(man, p); + man->next = ROFF_NEXT_CHILD; } +void +man_body_alloc(struct roff_man *man, int line, int pos, int tok) +{ + struct roff_node *p; -int -man_word_alloc(struct man *man, - int line, int pos, const char *word) + p = man_node_alloc(man, line, pos, ROFFT_BODY, tok); + man_node_append(man, p); + man->next = ROFF_NEXT_CHILD; +} + +void +man_block_alloc(struct roff_man *man, int line, int pos, int tok) { - struct man_node *p; + struct roff_node *p; - p = man_node_alloc(line, pos, MAN_TEXT, -1); - if (NULL == p) - return(0); - if (NULL == (p->string = strdup(word))) - return(0); - return(man_node_append(man, p)); + p = man_node_alloc(man, line, pos, ROFFT_BLOCK, tok); + man_node_append(man, p); + man->next = ROFF_NEXT_CHILD; } +void +man_word_alloc(struct roff_man *man, int line, int pos, const char *word) +{ + struct roff_node *n; + n = man_node_alloc(man, line, pos, ROFFT_TEXT, MAN_MAX); + n->string = roff_strdup(man->roff, word); + man_node_append(man, n); + man->next = ROFF_NEXT_SIBLING; +} + void -man_node_free(struct man_node *p) +man_word_append(struct roff_man *man, const char *word) { + struct roff_node *n; + char *addstr, *newstr; - if (p->string) - free(p->string); - if (p->parent) - p->parent->nchild--; - free(p); + n = man->last; + addstr = roff_strdup(man->roff, word); + mandoc_asprintf(&newstr, "%s %s", n->string, addstr); + free(addstr); + free(n->string); + n->string = newstr; + man->next = ROFF_NEXT_SIBLING; } +/* + * Free all of the resources held by a node. This does NOT unlink a + * node from its context; for that, see man_node_unlink(). + */ +static void +man_node_free(struct roff_node *p) +{ + free(p->string); + free(p); +} + void -man_node_freelist(struct man_node *p) +man_node_delete(struct roff_man *man, struct roff_node *p) { - if (p->child) - man_node_freelist(p->child); - if (p->next) - man_node_freelist(p->next); + while (p->child) + man_node_delete(man, p->child); - assert(0 == p->nchild); + man_node_unlink(man, p); man_node_free(p); } +void +man_addeqn(struct roff_man *man, const struct eqn *ep) +{ + struct roff_node *n; + n = man_node_alloc(man, ep->ln, ep->pos, ROFFT_EQN, MAN_MAX); + n->eqn = ep; + if (ep->ln > man->last->line) + n->flags |= MAN_LINE; + man_node_append(man, n); + man->next = ROFF_NEXT_SIBLING; + man_descope(man, ep->ln, ep->pos); +} + +void +man_addspan(struct roff_man *man, const struct tbl_span *sp) +{ + struct roff_node *n; + + man_breakscope(man, MAN_MAX); + n = man_node_alloc(man, sp->line, 0, ROFFT_TBL, MAN_MAX); + n->span = sp; + man_node_append(man, n); + man->next = ROFF_NEXT_SIBLING; + man_descope(man, sp->line, 0); +} + +static void +man_descope(struct roff_man *man, 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). + */ + + if (man->flags & MAN_ELINE) { + man->flags &= ~MAN_ELINE; + man_unscope(man, man->last->parent); + } + if ( ! (man->flags & MAN_BLINE)) + return; + man->flags &= ~MAN_BLINE; + man_unscope(man, man->last->parent); + man_body_alloc(man, line, offs, man->last->tok); +} + static int -man_ptext(struct man *m, int line, char *buf) +man_ptext(struct roff_man *man, int line, char *buf, int offs) { + int i; - if ( ! man_word_alloc(m, line, 0, buf)) - return(0); - m->next = MAN_NEXT_SIBLING; + /* Literal free-form text whitespace is preserved. */ + if (man->flags & MAN_LITERAL) { + man_word_alloc(man, line, offs, buf + offs); + man_descope(man, line, offs); + return(1); + } + + for (i = offs; buf[i] == ' '; i++) + /* Skip leading whitespace. */ ; + /* - * If this is one of the zany NLINE macros that consumes the - * next line of input as being influenced, then close out the - * existing macro "scope" and continue processing. + * Blank lines are ignored right after headings + * but add a single vertical space elsewhere. */ - if ( ! (MAN_NLINE & m->flags)) + if (buf[i] == '\0') { + /* Allocate a blank entry. */ + if (man->last->tok != MAN_SH && + man->last->tok != MAN_SS) { + man_elem_alloc(man, line, offs, MAN_sp); + man->next = ROFF_NEXT_SIBLING; + } return(1); + } - m->flags &= ~MAN_NLINE; - m->last = m->last->parent; + /* + * Warn if the last un-escaped character is whitespace. Then + * strip away the remaining spaces (tabs stay!). + */ - assert(MAN_ROOT != m->last->type); - if ( ! man_valid_post(m)) - return(0); - if ( ! man_action_post(m)) - return(0); + i = (int)strlen(buf); + assert(i); + if (' ' == buf[i - 1] || '\t' == buf[i - 1]) { + if (i > 1 && '\\' != buf[i - 2]) + mandoc_msg(MANDOCERR_SPACE_EOL, man->parse, + line, i - 1, NULL); + + for (--i; i && ' ' == buf[i]; i--) + /* Spin back to non-space. */ ; + + /* Jump ahead of escaped whitespace. */ + i += '\\' == buf[i] ? 2 : 1; + + buf[i] = '\0'; + } + man_word_alloc(man, line, offs, buf + offs); + + /* + * End-of-sentence check. If the last character is an unescaped + * EOS character, then flag the node as being the end of a + * sentence. The front-end will know how to interpret this. + */ + + assert(i); + if (mandoc_eos(buf, (size_t)i)) + man->last->flags |= MAN_EOS; + + man_descope(man, line, offs); return(1); } - -int -man_pmacro(struct man *m, int ln, char *buf) +static int +man_pmacro(struct roff_man *man, int ln, char *buf, int offs) { - int i, j, c, ppos, fl; - char mac[5]; - struct man_node *n; + struct roff_node *n; + const char *cp; + int tok; + int i, ppos; + int bline; + char mac[5]; - /* Comments and empties are quickly ignored. */ + ppos = offs; - n = m->last; - fl = MAN_NLINE & m->flags; + /* + * Copy the first word into a nil-terminated buffer. + * Stop when a space, tab, escape, or eoln is encountered. + */ - if (0 == buf[1]) - goto out; + i = 0; + while (i < 4 && strchr(" \t\\", buf[offs]) == NULL) + mac[i++] = buf[offs++]; - i = 1; + mac[i] = '\0'; - if (' ' == buf[i]) { - i++; - while (buf[i] && ' ' == buf[i]) - i++; - if (0 == buf[i]) - goto out; + tok = (i > 0 && i < 4) ? man_hash_find(mac) : MAN_MAX; + + if (tok == MAN_MAX) { + mandoc_msg(MANDOCERR_MACRO, man->parse, + ln, ppos, buf + ppos - 1); + return(1); } - ppos = i; + /* Skip a leading escape sequence or tab. */ - /* Copy the first word into a nil-terminated buffer. */ + switch (buf[offs]) { + case '\\': + cp = buf + offs + 1; + mandoc_escape(&cp, NULL, NULL); + offs = cp - buf; + break; + case '\t': + offs++; + break; + default: + break; + } - for (j = 0; j < 4; j++, i++) { - if (0 == (mac[j] = buf[i])) - break; - else if (' ' == buf[i]) - break; + /* Jump to the next non-whitespace word. */ + + while (buf[offs] && 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 (buf[offs] == '\0' && buf[offs - 1] == ' ') + mandoc_msg(MANDOCERR_SPACE_EOL, man->parse, + ln, offs - 1, NULL); + + /* + * Some macros break next-line scopes; otherwise, remember + * whether we are in next-line scope for a block head. + */ + + man_breakscope(man, tok); + bline = man->flags & MAN_BLINE; + + /* Call to handler... */ + + assert(man_macros[tok].fp); + (*man_macros[tok].fp)(man, tok, ln, ppos, &offs, buf); + + /* In quick mode (for mandocdb), abort after the NAME section. */ + + if (man->quick && tok == MAN_SH) { + n = man->last; + if (n->type == ROFFT_BODY && + strcmp(n->prev->child->string, "NAME")) + return(2); } - mac[j] = 0; + /* + * 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 (j == 4 || j < 1) { - if ( ! (MAN_IGN_MACRO & m->pflags)) { - (void)man_verr(m, ln, ppos, - "ill-formed macro: %s", mac); - goto err; - } - if ( ! man_vwarn(m, ln, ppos, - "ill-formed macro: %s", mac)) - goto err; + if ( ! bline || man->flags & MAN_ELINE || + man_macros[tok].flags & MAN_NSCOPED) return(1); - } - - if (MAN_MAX == (c = man_hash_find(m->htab, mac))) { - if ( ! (MAN_IGN_MACRO & m->pflags)) { - (void)man_verr(m, ln, ppos, - "unknown macro: %s", mac); - goto err; - } - if ( ! man_vwarn(m, ln, ppos, - "unknown macro: %s", mac)) - goto err; - return(1); - } - /* The macro is sane. Jump to the next word. */ + assert(man->flags & MAN_BLINE); + man->flags &= ~MAN_BLINE; - while (buf[i] && ' ' == buf[i]) - i++; + man_unscope(man, man->last->parent); + man_body_alloc(man, ln, ppos, man->last->tok); + return(1); +} - /* Begin recursive parse sequence. */ +void +man_breakscope(struct roff_man *man, int tok) +{ + struct roff_node *n; - if ( ! man_macro(m, c, ln, ppos, &i, buf)) - goto err; + /* + * An element next line scope is open, + * and the new macro is not allowed inside elements. + * Delete the element that is being broken. + */ -out: - if (fl) { - /* - * A NLINE macro has been immediately followed with - * another. Close out the preceding macro's scope, and - * continue. - */ - assert(MAN_ROOT != m->last->type); - assert(m->last->parent); - assert(MAN_ROOT != m->last->parent->type); + if (man->flags & MAN_ELINE && (tok == MAN_MAX || + ! (man_macros[tok].flags & MAN_NSCOPED))) { + n = man->last; + assert(n->type != ROFFT_TEXT); + if (man_macros[n->tok].flags & MAN_NSCOPED) + n = n->parent; - if (n != m->last) - m->last = m->last->parent; + mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse, + n->line, n->pos, "%s breaks %s", + tok == MAN_MAX ? "TS" : man_macronames[tok], + man_macronames[n->tok]); - if ( ! man_valid_post(m)) - return(0); - if ( ! man_action_post(m)) - return(0); - m->next = MAN_NEXT_SIBLING; - m->flags &= ~MAN_NLINE; - } + man_node_delete(man, n); + man->flags &= ~MAN_ELINE; + } - return(1); + /* + * 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. + */ -err: /* Error out. */ + if (man->flags & MAN_BLINE && (tok == MAN_MAX || + man_macros[tok].flags & MAN_BSCOPE)) { + n = man->last; + if (n->type == ROFFT_TEXT) + n = n->parent; + if ( ! (man_macros[n->tok].flags & MAN_BSCOPE)) + n = n->parent; - m->flags |= MAN_HALT; - return(0); -} + assert(n->type == ROFFT_HEAD); + n = n->parent; + assert(n->type == ROFFT_BLOCK); + assert(man_macros[n->tok].flags & MAN_SCOPED); + mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse, + n->line, n->pos, "%s breaks %s", + tok == MAN_MAX ? "TS" : man_macronames[tok], + man_macronames[n->tok]); -int -man_verr(struct man *man, int ln, int pos, const char *fmt, ...) + man_node_delete(man, n); + man->flags &= ~MAN_BLINE; + } +} + +/* + * Unlink a node from its context. If "man" is provided, the last parse + * point will also be adjusted accordingly. + */ +static void +man_node_unlink(struct roff_man *man, struct roff_node *n) { - char buf[256]; - va_list ap; - if (NULL == man->cb.man_err) - return(0); + /* Adjust siblings. */ - va_start(ap, fmt); - (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap); - va_end(ap); - return((*man->cb.man_err)(man->data, ln, pos, buf)); -} + if (n->prev) + n->prev->next = n->next; + if (n->next) + n->next->prev = n->prev; + /* Adjust parent. */ -int -man_vwarn(struct man *man, int ln, int pos, const char *fmt, ...) -{ - char buf[256]; - va_list ap; + if (n->parent) { + n->parent->nchild--; + if (n->parent->child == n) + n->parent->child = n->prev ? n->prev : n->next; + } - if (NULL == man->cb.man_warn) - return(0); + /* Adjust parse point, if applicable. */ - va_start(ap, fmt); - (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap); - va_end(ap); - return((*man->cb.man_warn)(man->data, ln, pos, buf)); + if (man && man->last == n) { + /*XXX: this can occur when bailing from validation. */ + /*assert(NULL == n->next);*/ + if (n->prev) { + man->last = n->prev; + man->next = ROFF_NEXT_SIBLING; + } else { + man->last = n->parent; + man->next = ROFF_NEXT_CHILD; + } + } + + if (man && man->first == n) + man->first = NULL; } +const struct mparse * +man_mparse(const struct roff_man *man) +{ -int -man_err(struct man *m, int line, int pos, - int iserr, enum merr type) + assert(man && man->parse); + return(man->parse); +} + +void +man_deroff(char **dest, const struct roff_node *n) { - const char *p; - - p = NULL; - switch (type) { - case (WNPRINT): - p = "invalid character"; - break; - case (WNMEM): - p = "memory exhausted"; - break; - case (WMSEC): - p = "invalid manual section"; - break; - case (WDATE): - p = "invalid date format"; - break; - case (WLNSCOPE): - p = "scope of prior line violated"; - break; - case (WTSPACE): - p = "trailing whitespace at end of line"; - break; - case (WTQUOTE): - p = "unterminated quotation"; - break; - case (WNODATA): - p = "document has no data"; - break; - case (WNOTITLE): - p = "document has no title/section"; - break; - case (WESCAPE): - p = "invalid escape sequence"; - break; + char *cp; + size_t sz; + + if (n->type != ROFFT_TEXT) { + for (n = n->child; n; n = n->next) + man_deroff(dest, n); + return; } - assert(p); - if (iserr) - return(man_verr(m, line, pos, p)); + /* Skip leading whitespace and escape sequences. */ - return(man_vwarn(m, line, pos, p)); + cp = n->string; + while ('\0' != *cp) { + if ('\\' == *cp) { + cp++; + mandoc_escape((const char **)&cp, NULL, NULL); + } else if (isspace((unsigned char)*cp)) + cp++; + else + break; + } + + /* Skip trailing whitespace. */ + + for (sz = strlen(cp); sz; sz--) + if (0 == isspace((unsigned char)cp[sz-1])) + break; + + /* Skip empty strings. */ + + if (0 == sz) + return; + + if (NULL == *dest) { + *dest = mandoc_strndup(cp, sz); + return; + } + + mandoc_asprintf(&cp, "%s %*s", *dest, (int)sz, cp); + free(*dest); + *dest = cp; }