=================================================================== RCS file: /cvs/mandoc/man.c,v retrieving revision 1.43 retrieving revision 1.86 diff -u -p -r1.43 -r1.86 --- mandoc/man.c 2009/10/26 07:11:06 1.43 +++ mandoc/man.c 2010/08/08 14:51:32 1.86 @@ -1,6 +1,6 @@ -/* $Id: man.c,v 1.43 2009/10/26 07:11:06 kristaps Exp $ */ +/* $Id: man.c,v 1.86 2010/08/08 14:51:32 schwarze Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * Copyright (c) 2008, 2009, 2010 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 @@ -14,39 +14,22 @@ * 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.h" #include "libman.h" +#include "libmandoc.h" -const char *const __man_merrnames[WERRMAX] = { - "invalid character", /* WNPRINT */ - "system: malloc error", /* WNMEM */ - "invalid manual section", /* WMSEC */ - "invalid date format", /* WDATE */ - "scope of prior line violated", /* WLNSCOPE */ - "trailing whitespace", /* WTSPACE */ - "unterminated quoted parameter", /* WTQUOTE */ - "document has no body", /* WNODATA */ - "document has no title/section", /* WNOTITLE */ - "invalid escape sequence", /* WESCAPE */ - "invalid number format", /* WNUMFMT */ - "expected block head arguments", /* WHEADARGS */ - "expected block body arguments", /* WBODYARGS */ - "expected empty block head", /* WNHEADARGS */ - "ill-formed macro", /* WMACROFORM */ - "scope open on exit", /* WEXITSCOPE */ - "no scope context", /* WNOSCOPE */ - "literal context already open", /* WOLITERAL */ - "no literal context open" /* WNLITERAL */ -}; - const char *const __man_macronames[MAN_MAX] = { "br", "TH", "SH", "SS", "TP", "LP", "PP", "P", @@ -55,28 +38,27 @@ const char *const __man_macronames[MAN_MAX] = { "R", "B", "I", "IR", "RI", "na", "i", "sp", "nf", "fi", "r", "RE", - "RS", "DT", "UC", "PD" + "RS", "DT", "UC", "PD", + "Sp", "Vb", "Ve", "AT", + "in" }; const char * const *man_macronames = __man_macronames; static struct man_node *man_node_alloc(int, int, - enum man_type, int); + enum man_type, enum mant); 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_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 int man_alloc1(struct man *); -static int pstring(struct man *, int, int, - const char *, size_t); -static int macrowarn(struct man *, int, const char *); +static void man_alloc1(struct man *); +static int macrowarn(struct man *, int, const char *, int); -#ifdef __linux__ -extern size_t strlcpy(char *, const char *, size_t); -#endif - const struct man_node * man_node(const struct man *m) { @@ -93,12 +75,12 @@ man_meta(const struct man *m) } -int +void man_reset(struct man *man) { man_free1(man); - return(man_alloc1(man)); + man_alloc1(man); } @@ -112,23 +94,20 @@ man_free(struct man *man) struct man * -man_alloc(void *data, int pflags, const struct man_cb *cb) +man_alloc(struct regset *regs, void *data, + int pflags, mandocmsg msg) { struct man *p; - if (NULL == (p = calloc(1, sizeof(struct man)))) - return(NULL); + p = mandoc_calloc(1, sizeof(struct man)); - if ( ! man_alloc1(p)) { - free(p); - return(NULL); - } - man_hash_init(); - p->data = data; p->pflags = pflags; - (void)memcpy(&p->cb, cb, sizeof(struct man_cb)); + p->msg = msg; + p->regs = regs; + + man_alloc1(p); return(p); } @@ -147,12 +126,15 @@ man_endparse(struct man *m) int -man_parseln(struct man *m, int ln, char *buf) +man_parseln(struct man *m, int ln, char *buf, int offs) { - return('.' == *buf ? - man_pmacro(m, ln, buf) : - man_ptext(m, ln, buf)); + if (MAN_HALT & m->flags) + return(0); + + return(('.' == buf[offs] || '\'' == buf[offs]) ? + man_pmacro(m, ln, buf, offs) : + man_ptext(m, ln, buf, offs)); } @@ -161,29 +143,31 @@ man_free1(struct man *man) { if (man->first) - man_node_freelist(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.rawdate) + free(man->meta.rawdate); if (man->meta.vol) free(man->meta.vol); + if (man->meta.msec) + free(man->meta.msec); } -static int +static void man_alloc1(struct man *m) { - bzero(&m->meta, sizeof(struct man_meta)); + memset(&m->meta, 0, sizeof(struct man_meta)); m->flags = 0; - m->last = calloc(1, sizeof(struct man_node)); - if (NULL == m->last) - return(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; - return(1); } @@ -210,6 +194,7 @@ man_node_append(struct man *man, struct man_node *p) /* NOTREACHED */ } + assert(p->parent); p->parent->nchild++; if ( ! man_valid_pre(man, p)) @@ -246,14 +231,11 @@ man_node_append(struct man *man, struct man_node *p) static struct man_node * -man_node_alloc(int line, int pos, enum man_type type, int tok) +man_node_alloc(int line, int pos, enum man_type type, enum mant tok) { struct man_node *p; - p = calloc(1, sizeof(struct man_node)); - if (NULL == p) - return(NULL); - + p = mandoc_calloc(1, sizeof(struct man_node)); p->line = line; p->pos = pos; p->type = type; @@ -263,13 +245,11 @@ man_node_alloc(int line, int pos, enum man_type type, int -man_elem_alloc(struct man *m, int line, int pos, int tok) +man_elem_alloc(struct man *m, int line, int pos, enum mant tok) { struct man_node *p; p = man_node_alloc(line, pos, MAN_ELEM, tok); - if (NULL == p) - return(0); if ( ! man_node_append(m, p)) return(0); m->next = MAN_NEXT_CHILD; @@ -278,13 +258,11 @@ man_elem_alloc(struct man *m, int line, int pos, int t int -man_head_alloc(struct man *m, int line, int pos, int tok) +man_head_alloc(struct man *m, int line, int pos, enum mant tok) { struct man_node *p; p = man_node_alloc(line, pos, MAN_HEAD, tok); - if (NULL == p) - return(0); if ( ! man_node_append(m, p)) return(0); m->next = MAN_NEXT_CHILD; @@ -293,13 +271,11 @@ man_head_alloc(struct man *m, int line, int pos, int t int -man_body_alloc(struct man *m, int line, int pos, int tok) +man_body_alloc(struct man *m, int line, int pos, enum mant tok) { struct man_node *p; p = man_node_alloc(line, pos, MAN_BODY, tok); - if (NULL == p) - return(0); if ( ! man_node_append(m, p)) return(0); m->next = MAN_NEXT_CHILD; @@ -308,13 +284,11 @@ man_body_alloc(struct man *m, int line, int pos, int t int -man_block_alloc(struct man *m, int line, int pos, int tok) +man_block_alloc(struct man *m, int line, int pos, enum mant tok) { struct man_node *p; p = man_node_alloc(line, pos, MAN_BLOCK, tok); - if (NULL == p) - return(0); if ( ! man_node_append(m, p)) return(0); m->next = MAN_NEXT_CHILD; @@ -322,118 +296,123 @@ man_block_alloc(struct man *m, int line, int pos, int } -static int -pstring(struct man *m, int line, int pos, - const char *p, size_t len) +int +man_word_alloc(struct man *m, int line, int pos, const char *word) { struct man_node *n; - size_t sv; + size_t sv, len; - n = man_node_alloc(line, pos, MAN_TEXT, -1); - if (NULL == n) - return(0); + len = strlen(word); - n->string = malloc(len + 1); - if (NULL == n->string) { - free(n); - return(0); - } + n = man_node_alloc(line, pos, MAN_TEXT, MAN_MAX); + n->string = mandoc_malloc(len + 1); + sv = strlcpy(n->string, word, len + 1); - sv = strlcpy(n->string, p, len + 1); - /* Prohibit truncation. */ assert(sv < len + 1); if ( ! man_node_append(m, n)) return(0); + m->next = MAN_NEXT_SIBLING; return(1); } -int -man_word_alloc(struct man *m, int line, int pos, const char *word) -{ - - return(pstring(m, line, pos, word, strlen(word))); -} - - -void +/* + * 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 man_node *p) { if (p->string) free(p->string); - if (p->parent) - p->parent->nchild--; free(p); } void -man_node_freelist(struct man_node *p) +man_node_delete(struct man *m, struct man_node *p) { - struct man_node *n; - if (p->child) - man_node_freelist(p->child); - assert(0 == p->nchild); - n = p->next; + while (p->child) + man_node_delete(m, p->child); + + man_node_unlink(m, p); man_node_free(p); - if (n) - man_node_freelist(n); } static int -man_ptext(struct man *m, int line, char *buf) +man_ptext(struct man *m, int line, char *buf, int offs) { - int i, j; + int i; + /* Ignore bogus comments. */ + + if ('\\' == buf[offs] && + '.' == buf[offs + 1] && + '"' == buf[offs + 2]) + return(man_pmsg(m, line, offs, MANDOCERR_BADCOMMENT)); + /* Literal free-form text whitespace is preserved. */ if (MAN_LITERAL & m->flags) { - if ( ! man_word_alloc(m, line, 0, buf)) + if ( ! man_word_alloc(m, line, offs, buf + offs)) return(0); goto descope; } - /* First de-chunk and allocate words. */ + /* Pump blank lines directly into the backend. */ - for (i = 0; ' ' == buf[i]; i++) + for (i = offs; ' ' == buf[i]; i++) /* Skip leading whitespace. */ ; - if (0 == buf[i]) { - if ( ! pstring(m, line, 0, &buf[i], 0)) + + if ('\0' == buf[i]) { + /* Allocate a blank entry. */ + if ( ! man_word_alloc(m, line, offs, "")) return(0); goto descope; } - for (j = i; buf[i]; i++) { - if (' ' != buf[i]) - continue; + /* + * Warn if the last un-escaped character is whitespace. Then + * strip away the remaining spaces (tabs stay!). + */ - /* Escaped whitespace. */ - if (i && ' ' == buf[i] && '\\' == buf[i - 1]) - continue; + i = (int)strlen(buf); + assert(i); - buf[i++] = 0; - if ( ! pstring(m, line, j, &buf[j], (size_t)(i - j))) - return(0); + if (' ' == buf[i - 1] || '\t' == buf[i - 1]) { + if (i > 1 && '\\' != buf[i - 2]) + if ( ! man_pmsg(m, line, i - 1, MANDOCERR_EOLNSPACE)) + return(0); - for ( ; ' ' == buf[i]; i++) - /* Skip trailing whitespace. */ ; + for (--i; i && ' ' == buf[i]; i--) + /* Spin back to non-space. */ ; - j = i; - if (0 == buf[i]) - break; + /* Jump ahead of escaped whitespace. */ + i += '\\' == buf[i] ? 2 : 1; + + buf[i] = '\0'; } - if (j != i && ! pstring(m, line, j, &buf[j], (size_t)(i - j))) + if ( ! man_word_alloc(m, line, offs, buf + offs)) return(0); -descope: + /* + * 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, 0)) + m->last->flags |= MAN_EOS; + +descope: /* * Co-ordinate what happens with having a next-line scope open: * first close out the element scope (if applicable), then close @@ -442,7 +421,7 @@ descope: if (MAN_ELINE & m->flags) { m->flags &= ~MAN_ELINE; - if ( ! man_unscope(m, m->last->parent)) + if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX)) return(0); } @@ -450,79 +429,75 @@ descope: return(1); m->flags &= ~MAN_BLINE; - if ( ! man_unscope(m, m->last->parent)) + if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX)) return(0); - return(man_body_alloc(m, line, 0, m->last->tok)); + return(man_body_alloc(m, line, offs, m->last->tok)); } static int -macrowarn(struct man *m, int ln, const char *buf) +macrowarn(struct man *m, int ln, const char *buf, int offs) { - if ( ! (MAN_IGN_MACRO & m->pflags)) - return(man_verr(m, ln, 0, - "unknown macro: %s%s", - buf, strlen(buf) > 3 ? "..." : "")); - return(man_vwarn(m, ln, 0, "unknown macro: %s%s", - buf, strlen(buf) > 3 ? "..." : "")); + int rc; + + rc = man_vmsg(m, MANDOCERR_MACRO, ln, offs, + "unknown macro: %s%s", + buf, strlen(buf) > 3 ? "..." : ""); + + return(MAN_IGN_MACRO & m->pflags ? rc : 0); } int -man_pmacro(struct man *m, int ln, char *buf) +man_pmacro(struct man *m, int ln, char *buf, int offs) { - int i, j, c, ppos, fl; + int i, j, ppos; + enum mant tok; char mac[5]; struct man_node *n; /* Comments and empties are quickly ignored. */ - fl = m->flags; + offs++; - if (0 == buf[1]) - goto out; + if ('\0' == buf[offs]) + return(1); - i = 1; + i = offs; - if (' ' == buf[i]) { + /* + * 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]) + while (buf[i] && (' ' == buf[i] || '\t' == buf[i])) i++; - if (0 == buf[i]) + if ('\0' == buf[i]) goto out; } ppos = i; - /* Copy the first word into a nil-terminated buffer. */ + /* + * Copy the first word into a nil-terminated buffer. + * Stop copying when a tab, space, or eoln is encountered. + */ - for (j = 0; j < 4; j++, i++) { - if (0 == (mac[j] = buf[i])) - break; - else if (' ' == buf[i]) - break; + j = 0; + while (j < 4 && '\0' != buf[i] && ' ' != buf[i] && '\t' != buf[i]) + mac[j++] = buf[i++]; + mac[j] = '\0'; - /* Check for invalid characters. */ - - if (isgraph((u_char)buf[i])) - continue; - return(man_perr(m, ln, i, WNPRINT)); - } - - mac[j] = 0; - if (j == 4 || j < 1) { - if ( ! (MAN_IGN_MACRO & m->pflags)) { - (void)man_perr(m, ln, ppos, WMACROFORM); + if ( ! macrowarn(m, ln, mac, ppos)) goto err; - } - if ( ! man_pwarn(m, ln, ppos, WMACROFORM)) - goto err; return(1); } - if (MAN_MAX == (c = man_hash_find(mac))) { - if ( ! macrowarn(m, ln, mac)) + if (MAN_MAX == (tok = man_hash_find(mac))) { + if ( ! macrowarn(m, ln, mac, ppos)) goto err; return(1); } @@ -532,43 +507,89 @@ man_pmacro(struct man *m, int ln, char *buf) while (buf[i] && ' ' == buf[i]) i++; - /* Remove prior ELINE macro, if applicable. */ + /* + * Trailing whitespace. Note that tabs are allowed to be passed + * into the parser as "text", so we only warn about spaces here. + */ - if (m->flags & MAN_ELINE) { + if ('\0' == buf[i] && ' ' == buf[i - 1]) + if ( ! man_pmsg(m, ln, i - 1, MANDOCERR_EOLNSPACE)) + goto err; + + /* + * Remove prior ELINE macro, as it's being clobbering 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. + */ + + if ( ! (MAN_NSCOPED & man_macros[tok].flags) && + m->flags & MAN_ELINE) { + assert(MAN_TEXT != m->last->type); + + /* + * This occurs in the following construction: + * .B + * .br + * .B + * .br + * I hate man macros. + * Flat-out disallow this madness. + */ + if (MAN_NSCOPED & man_macros[m->last->tok].flags) { + man_pmsg(m, ln, ppos, MANDOCERR_SYNTLINESCOPE); + return(0); + } + n = m->last; + + assert(n); assert(NULL == n->child); assert(0 == n->nchild); - if ( ! man_nwarn(m, n, WLNSCOPE)) + + if ( ! man_nmsg(m, n, MANDOCERR_LINESCOPE)) return(0); - if (n->prev) { - assert(n != n->parent->child); - assert(n == n->prev->next); - n->prev->next = NULL; - m->last = n->prev; - m->next = MAN_NEXT_SIBLING; - } else { - assert(n == n->parent->child); - n->parent->child = NULL; - m->last = n->parent; - m->next = MAN_NEXT_CHILD; - } - - man_node_free(n); + man_node_delete(m, n); m->flags &= ~MAN_ELINE; } - /* Begin recursive parse sequence. */ + /* + * 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. + */ - assert(man_macros[c].fp); + if (MAN_BLINE & m->flags) + m->flags |= MAN_BPLINE; - if ( ! (*man_macros[c].fp)(m, c, ln, ppos, &i, buf)) + /* Call to handler... */ + + assert(man_macros[tok].fp); + if ( ! (*man_macros[tok].fp)(m, tok, ln, ppos, &i, buf)) goto err; out: - if ( ! (MAN_BLINE & fl)) + /* + * We weren't in a block-line scope when entering the + * above-parsed macro, so return. + */ + + if ( ! (MAN_BPLINE & m->flags)) { + m->flags &= ~MAN_ILINE; return(1); + } + m->flags &= ~MAN_BPLINE; + /* + * If we're in a block scope, then allow this macro to slip by + * without closing scope around it. + */ + + if (MAN_ILINE & m->flags) { + m->flags &= ~MAN_ILINE; + 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. @@ -582,9 +603,9 @@ out: assert(MAN_BLINE & m->flags); m->flags &= ~MAN_BLINE; - if ( ! man_unscope(m, m->last->parent)) + if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX)) return(0); - return(man_body_alloc(m, ln, 0, m->last->tok)); + return(man_body_alloc(m, ln, offs, m->last->tok)); err: /* Error out. */ @@ -594,47 +615,56 @@ err: /* Error out. */ int -man_verr(struct man *man, int ln, int pos, const char *fmt, ...) +man_vmsg(struct man *man, enum mandocerr t, + int ln, int pos, const char *fmt, ...) { 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); + vsnprintf(buf, sizeof(buf) - 1, fmt, ap); va_end(ap); - return((*man->cb.man_err)(man->data, ln, pos, buf)); + return((*man->msg)(t, man->data, ln, pos, buf)); } -int -man_vwarn(struct man *man, int ln, int pos, const char *fmt, ...) +/* + * 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) { - char buf[256]; - va_list ap; - if (NULL == man->cb.man_warn) - return(0); + /* Adjust siblings. */ - 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 (n->prev) + n->prev->next = n->next; + if (n->next) + n->next->prev = n->prev; + /* Adjust parent. */ -int -man_err(struct man *m, int line, int pos, int iserr, enum merr type) -{ - const char *p; - - p = __man_merrnames[(int)type]; - assert(p); + if (n->parent) { + n->parent->nchild--; + if (n->parent->child == n) + n->parent->child = n->prev ? n->prev : n->next; + } - if (iserr) - return(man_verr(m, line, pos, p)); + /* Adjust parse point, if applicable. */ - return(man_vwarn(m, line, pos, p)); + 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 (m && m->first == n) + m->first = NULL; }