=================================================================== RCS file: /cvs/mandoc/man.c,v retrieving revision 1.19 retrieving revision 1.164 diff -u -p -r1.19 -r1.164 --- mandoc/man.c 2009/06/10 20:18:43 1.19 +++ mandoc/man.c 2015/09/04 21:25:00 1.164 @@ -1,19 +1,25 @@ -/* $Id: man.c,v 1.19 2009/06/10 20:18:43 kristaps Exp $ */ +/* $Id: man.c,v 1.164 2015/09/04 21:25:00 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,418 +27,308 @@ #include #include +#include "mandoc_aux.h" +#include "mandoc.h" +#include "roff.h" +#include "man.h" +#include "libmandoc.h" +#include "roff_int.h" #include "libman.h" -const char *const __man_macronames[MAN_MAX] = { - "\\\"", "TH", "SH", "SS", - "TP", "LP", "PP", "P", +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", "br", "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_descope(struct roff_man *, int, int); +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) +int +man_parseln(struct roff_man *man, int ln, char *buf, int offs) { - return(MAN_HALT & m->flags ? NULL : m->first); -} + if (man->last->type != ROFFT_EQN || ln > man->last->line) + man->flags |= MAN_NEWLINE; - -const struct man_meta * -man_meta(const struct man *m) -{ - - return(MAN_HALT & m->flags ? NULL : &m->meta); + return (roff_getcontrol(man->roff, buf, &offs) ? + man_pmacro(man, ln, buf, offs) : + man_ptext(man, ln, buf, offs)); } - -int -man_reset(struct man *man) +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). + */ - man_free1(man); - return(man_alloc1(man)); + 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); + roff_body_alloc(man, line, offs, man->last->tok); } - -void -man_free(struct man *man) +static int +man_ptext(struct roff_man *man, int line, char *buf, int offs) { + int i; - man_free1(man); + /* Literal free-form text whitespace is preserved. */ - if (man->htab) - man_hash_free(man->htab); - free(man); -} + if (man->flags & MAN_LITERAL) { + roff_word_alloc(man, line, offs, buf + offs); + man_descope(man, line, offs); + return(1); + } + for (i = offs; buf[i] == ' '; i++) + /* Skip leading whitespace. */ ; -struct man * -man_alloc(void *data, int pflags, const struct man_cb *cb) -{ - struct man *p; + /* + * Blank lines are ignored right after headings + * but add a single vertical space elsewhere. + */ - if (NULL == (p = calloc(1, sizeof(struct man)))) - return(NULL); - - if ( ! man_alloc1(p)) { - free(p); - return(NULL); + if (buf[i] == '\0') { + /* Allocate a blank entry. */ + if (man->last->tok != MAN_SH && + man->last->tok != MAN_SS) { + roff_elem_alloc(man, line, offs, MAN_sp); + man->next = ROFF_NEXT_SIBLING; + } + return(1); } - p->data = data; - p->pflags = pflags; - (void)memcpy(&p->cb, cb, sizeof(struct man_cb)); + /* + * Warn if the last un-escaped character is whitespace. Then + * strip away the remaining spaces (tabs stay!). + */ - if (NULL == (p->htab = man_hash_alloc())) { - free(p); - return(NULL); - } - return(p); -} + 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); -int -man_endparse(struct man *m) -{ + for (--i; i && ' ' == buf[i]; i--) + /* Spin back to non-space. */ ; - if (MAN_HALT & m->flags) - return(0); - else if (man_macroend(m)) - return(1); - m->flags |= MAN_HALT; - return(0); -} + /* Jump ahead of escaped whitespace. */ + i += '\\' == buf[i] ? 2 : 1; + buf[i] = '\0'; + } + roff_word_alloc(man, line, offs, buf + offs); -int -man_parseln(struct man *m, int ln, char *buf) -{ + /* + * 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. + */ - return('.' == *buf ? - man_pmacro(m, ln, buf) : - man_ptext(m, ln, buf)); -} + assert(i); + if (mandoc_eos(buf, (size_t)i)) + man->last->flags |= MAN_EOS; - -static void -man_free1(struct man *man) -{ - - 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); + man_descope(man, line, offs); + return(1); } - static int -man_alloc1(struct man *m) +man_pmacro(struct roff_man *man, int ln, char *buf, int offs) { + struct roff_node *n; + const char *cp; + int tok; + int i, ppos; + int bline; + char mac[5]; - 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); -} + ppos = offs; + /* + * Copy the first word into a nil-terminated buffer. + * Stop when a space, tab, escape, or eoln is encountered. + */ -static int -man_node_append(struct man *man, struct man_node *p) -{ + i = 0; + while (i < 4 && strchr(" \t\\", buf[offs]) == NULL) + mac[i++] = buf[offs++]; - assert(man->last); - assert(man->first); - assert(MAN_ROOT != p->type); + mac[i] = '\0'; - 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 */ + tok = (i > 0 && i < 4) ? man_hash_find(mac) : TOKEN_NONE; + + if (tok == TOKEN_NONE) { + mandoc_msg(MANDOCERR_MACRO, man->parse, + ln, ppos, buf + ppos - 1); + return(1); } - man->last = p; + /* Skip a leading escape sequence or tab. */ - switch (p->type) { - case (MAN_TEXT): - if ( ! man_valid_post(man)) - return(0); - if ( ! man_action_post(man)) - return(0); + switch (buf[offs]) { + case '\\': + cp = buf + offs + 1; + mandoc_escape(&cp, NULL, NULL); + offs = cp - buf; break; + case '\t': + offs++; + break; default: break; } - return(1); -} + /* Jump to the next non-whitespace word. */ + while (buf[offs] && buf[offs] == ' ') + offs++; -static struct man_node * -man_node_alloc(int line, int pos, enum man_type type, int tok) -{ - struct man_node *p; + /* + * Trailing whitespace. Note that tabs are allowed to be passed + * into the parser as "text", so we only warn about spaces here. + */ - p = calloc(1, sizeof(struct man_node)); - if (NULL == p) - return(NULL); + if (buf[offs] == '\0' && buf[offs - 1] == ' ') + mandoc_msg(MANDOCERR_SPACE_EOL, man->parse, + ln, offs - 1, NULL); - p->line = line; - p->pos = pos; - p->type = type; - p->tok = tok; - return(p); -} + /* + * 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; -int -man_elem_alloc(struct man *man, int line, int pos, int tok) -{ - struct man_node *p; + /* Call to handler... */ - p = man_node_alloc(line, pos, MAN_ELEM, tok); - if (NULL == p) - return(0); - return(man_node_append(man, p)); -} + 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. */ -int -man_word_alloc(struct man *man, - int line, int pos, const char *word) -{ - struct man_node *p; + if (man->quick && tok == MAN_SH) { + n = man->last; + if (n->type == ROFFT_BODY && + strcmp(n->prev->child->string, "NAME")) + return(2); + } - 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)); -} - - -void -man_node_free(struct man_node *p) -{ - - if (p->string) - free(p->string); - free(p); -} - - -void -man_node_freelist(struct man_node *p) -{ - - if (p->child) - man_node_freelist(p->child); - if (p->next) - man_node_freelist(p->next); - - man_node_free(p); -} - - -static int -man_ptext(struct man *m, int line, char *buf) -{ - - if ( ! man_word_alloc(m, line, 0, buf)) - return(0); - m->next = MAN_NEXT_SIBLING; - /* - * 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. + * 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_NLINE & m->flags)) + if ( ! bline || man->flags & MAN_ELINE || + man_macros[tok].flags & MAN_NSCOPED) return(1); - m->flags &= ~MAN_NLINE; - m->last = m->last->parent; + assert(man->flags & MAN_BLINE); + man->flags &= ~MAN_BLINE; - assert(MAN_ROOT != m->last->type); - if ( ! man_valid_post(m)) - return(0); - if ( ! man_action_post(m)) - return(0); - + man_unscope(man, man->last->parent); + roff_body_alloc(man, ln, ppos, man->last->tok); return(1); } - -int -man_pmacro(struct man *m, int ln, char *buf) +void +man_breakscope(struct roff_man *man, int tok) { - int i, j, c, ppos, fl; - char mac[5]; - struct man_node *n; + struct roff_node *n; - /* Comments and empties are quickly ignored. */ + /* + * An element next line scope is open, + * and the new macro is not allowed inside elements. + * Delete the element that is being broken. + */ - n = m->last; - fl = MAN_NLINE & m->flags; + if (man->flags & MAN_ELINE && (tok == TOKEN_NONE || + ! (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 (0 == buf[1]) - goto out; + mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse, + n->line, n->pos, "%s breaks %s", + tok == TOKEN_NONE ? "TS" : man_macronames[tok], + man_macronames[n->tok]); - i = 1; - - if (' ' == buf[i]) { - i++; - while (buf[i] && ' ' == buf[i]) - i++; - if (0 == buf[i]) - goto out; + roff_node_delete(man, n); + man->flags &= ~MAN_ELINE; } - ppos = i; + /* + * Weird special case: + * Switching fill mode closes section headers. + */ - if (buf[i] && '\\' == buf[i]) - if (buf[i + 1] && '\"' == buf[i + 1]) - goto out; - - /* Copy the first word into a nil-terminated buffer. */ - - for (j = 0; j < 4; j++, i++) { - if (0 == (mac[j] = buf[i])) - break; - else if (' ' == buf[i]) - break; + if (man->flags & MAN_BLINE && + (tok == MAN_nf || tok == MAN_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; } - mac[j] = 0; + /* + * 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 (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; - 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); - } + if (man->flags & MAN_BLINE && (tok == TOKEN_NONE || + 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; - /* The macro is sane. Jump to the next word. */ + assert(n->type == ROFFT_HEAD); + n = n->parent; + assert(n->type == ROFFT_BLOCK); + assert(man_macros[n->tok].flags & MAN_SCOPED); - while (buf[i] && ' ' == buf[i]) - i++; + mandoc_vmsg(MANDOCERR_BLK_LINE, man->parse, + n->line, n->pos, "%s breaks %s", + tok == TOKEN_NONE ? "TS" : man_macronames[tok], + man_macronames[n->tok]); - /* Begin recursive parse sequence. */ - - if ( ! man_macro(m, c, ln, ppos, &i, buf)) - goto err; - -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 (n != m->last) - m->last = m->last->parent; - - if ( ! man_valid_post(m)) - return(0); - if ( ! man_action_post(m)) - return(0); - m->next = MAN_NEXT_SIBLING; - m->flags &= ~MAN_NLINE; - } - - return(1); - -err: /* Error out. */ - - m->flags |= MAN_HALT; - return(0); + roff_node_delete(man, n); + man->flags &= ~MAN_BLINE; + } } - -int -man_verr(struct man *man, int ln, int pos, const char *fmt, ...) +const struct mparse * +man_mparse(const struct roff_man *man) { - char buf[256]; - va_list ap; - if (NULL == man->cb.man_err) - return(0); - - 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)); + assert(man && man->parse); + return(man->parse); } - - -int -man_vwarn(struct man *man, int ln, int pos, const char *fmt, ...) -{ - char buf[256]; - va_list ap; - - if (NULL == man->cb.man_warn) - return(0); - - 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)); -} - -