=================================================================== RCS file: /cvs/mandoc/man.c,v retrieving revision 1.2 retrieving revision 1.57 diff -u -p -r1.2 -r1.57 --- mandoc/man.c 2009/03/23 15:20:51 1.2 +++ mandoc/man.c 2010/03/27 10:26:39 1.57 @@ -1,48 +1,90 @@ -/* $Id: man.c,v 1.2 2009/03/23 15:20:51 kristaps Exp $ */ +/* $Id: man.c,v 1.57 2010/03/27 10:26:39 kristaps Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * Copyright (c) 2008, 2009 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 copyright notice and this permission notice appear in all - * copies. + * 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 WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED - * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE - * AUTHOR 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. + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR 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 #include "libman.h" +#include "libmandoc.h" +const char *const __man_merrnames[WERRMAX] = { + "invalid character", /* WNPRINT */ + "invalid manual section", /* WMSEC */ + "invalid date format", /* WDATE */ + "scope of prior line violated", /* WLNSCOPE */ + "over-zealous prior line scope violation", /* WLNSCOPE2 */ + "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 */ + "invalid nesting of roff declarations", /* WROFFNEST */ + "scope in roff instructions broken", /* WROFFSCOPE */ + "document title should be uppercase", /* WTITLECASE */ +}; + const char *const __man_macronames[MAN_MAX] = { - "\\\"", "TH", "SH", "SS", + "br", "TH", "SH", "SS", "TP", "LP", "PP", "P", "IP", "HP", "SM", "SB", "BI", "IB", "BR", "RB", - "R", "B", "I", "IR" + "R", "B", "I", "IR", + "RI", "na", "i", "sp", + "nf", "fi", "r", "RE", + "RS", "DT", "UC", "PD", + "Sp", "Vb", "Ve", "de", + "dei", "am", "ami", "ig", + ".", }; const char * const *man_macronames = __man_macronames; -static struct man_node *man_node_alloc(int, int, enum man_type); +static struct man_node *man_node_alloc(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 *); static int man_pmacro(struct man *, int, char *); static void man_free1(struct man *); static void man_alloc1(struct man *); +static int pstring(struct man *, int, int, + const char *, size_t); +static int macrowarn(struct man *, int, const char *); const struct man_node * @@ -75,25 +117,25 @@ man_free(struct man *man) { man_free1(man); - - if (man->htab) - man_hash_free(man->htab); free(man); } struct man * -man_alloc(void) +man_alloc(void *data, int pflags, const struct man_cb *cb) { struct man *p; - p = calloc(1, sizeof(struct man)); - if (NULL == p) - err(1, "calloc"); + p = mandoc_calloc(1, sizeof(struct man)); - man_alloc1(p); + if (cb) + memcpy(&p->cb, cb, sizeof(struct man_cb)); - p->htab = man_hash_alloc(); + man_hash_init(); + p->data = data; + p->pflags = pflags; + + man_alloc1(p); return(p); } @@ -102,8 +144,12 @@ int man_endparse(struct man *m) { - /* FIXME. */ - return(1); + if (MAN_HALT & m->flags) + return(0); + else if (man_macroend(m)) + return(1); + m->flags |= MAN_HALT; + return(0); } @@ -111,7 +157,7 @@ int man_parseln(struct man *m, int ln, char *buf) { - return('.' == *buf ? + return('.' == *buf || '\'' == *buf ? man_pmacro(m, ln, buf) : man_ptext(m, ln, buf)); } @@ -122,11 +168,11 @@ 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.os) - free(man->meta.os); + if (man->meta.source) + free(man->meta.source); if (man->meta.vol) free(man->meta.vol); } @@ -136,13 +182,12 @@ 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) - err(1, "calloc"); + 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; } @@ -169,24 +214,34 @@ man_node_append(struct man *man, struct man_node *p) abort(); /* NOTREACHED */ } + + assert(p->parent); + p->parent->nchild++; -#if 0 if ( ! man_valid_pre(man, p)) return(0); - if ( ! man_action_pre(man, p)) - return(0); -#endif + 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_TEXT): -#if 0 if ( ! man_valid_post(man)) return(0); if ( ! man_action_post(man)) return(0); -#endif break; default: break; @@ -197,47 +252,105 @@ 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) +man_node_alloc(int line, int pos, enum man_type type, enum mant tok) { struct man_node *p; - if (NULL == (p = calloc(1, sizeof(struct man_node)))) - err(1, "malloc"); + p = mandoc_calloc(1, sizeof(struct man_node)); p->line = line; p->pos = pos; p->type = type; - + p->tok = tok; return(p); } int -man_elem_alloc(struct man *man, 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); - p->tok = tok; + p = man_node_alloc(line, pos, MAN_ELEM, tok); + if ( ! man_node_append(m, p)) + return(0); + m->next = MAN_NEXT_CHILD; + return(1); +} - return(man_node_append(man, p)); + +int +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 ( ! man_node_append(m, p)) + return(0); + m->next = MAN_NEXT_CHILD; + return(1); } int -man_word_alloc(struct man *man, - int line, int pos, const char *word) +man_body_alloc(struct man *m, int line, int pos, enum mant tok) { - struct man_node *p; + struct man_node *p; - p = man_node_alloc(line, pos, MAN_TEXT); - if (NULL == (p->string = strdup(word))) - err(1, "strdup"); + p = man_node_alloc(line, pos, MAN_BODY, tok); + if ( ! man_node_append(m, p)) + return(0); + m->next = MAN_NEXT_CHILD; + return(1); +} - return(man_node_append(man, p)); + +int +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 ( ! man_node_append(m, p)) + return(0); + m->next = MAN_NEXT_CHILD; + return(1); } -void +static int +pstring(struct man *m, int line, int pos, + const char *p, size_t len) +{ + struct man_node *n; + size_t sv; + + n = man_node_alloc(line, pos, MAN_TEXT, MAN_MAX); + n->string = mandoc_malloc(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))); +} + + +/* + * 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) { @@ -248,14 +361,13 @@ man_node_free(struct man_node *p) void -man_node_freelist(struct man_node *p) +man_node_delete(struct man *m, struct man_node *p) { - if (p->child) - man_node_freelist(p->child); - if (p->next) - man_node_freelist(p->next); + while (p->child) + man_node_delete(m, p->child); + man_node_unlink(m, p); man_node_free(p); } @@ -263,58 +375,168 @@ man_node_freelist(struct man_node *p) static int man_ptext(struct man *m, int line, char *buf) { + int i, j; + char sv; - if ( ! man_word_alloc(m, line, 0, buf)) + /* Literal free-form text whitespace is preserved. */ + + if (MAN_LITERAL & m->flags) { + if ( ! man_word_alloc(m, line, 0, buf)) + return(0); + goto descope; + } + + /* First de-chunk and allocate words. */ + + for (i = 0; ' ' == buf[i]; i++) + /* Skip leading whitespace. */ ; + + if ('\0' == buf[i]) { + /* Trailing whitespace? */ + if (i && ' ' == buf[i - 1]) + if ( ! man_pwarn(m, line, i - 1, WTSPACE)) + return(0); + if ( ! pstring(m, line, 0, &buf[i], 0)) + return(0); + goto descope; + } + + for (j = i; buf[i]; i++) { + if (' ' != buf[i]) + continue; + + /* Escaped whitespace. */ + if (i && ' ' == buf[i] && '\\' == buf[i - 1]) + continue; + + sv = buf[i]; + buf[i++] = '\0'; + + if ( ! pstring(m, line, j, &buf[j], (size_t)(i - j))) + return(0); + + /* Trailing whitespace? Check at overwritten byte. */ + + if (' ' == sv && '\0' == buf[i]) + if ( ! man_pwarn(m, line, i - 1, WTSPACE)) + return(0); + + for ( ; ' ' == buf[i]; i++) + /* Skip trailing whitespace. */ ; + + j = i; + + /* Trailing whitespace? */ + + if (' ' == buf[i - 1] && '\0' == buf[i]) + if ( ! man_pwarn(m, line, i - 1, WTSPACE)) + return(0); + + if ('\0' == buf[i]) + break; + } + + if (j != i && ! pstring(m, line, j, &buf[j], (size_t)(i - j))) return(0); - m->next = MAN_NEXT_SIBLING; - return(1); + +descope: + + /* + * 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_ELINE & m->flags) { + m->flags &= ~MAN_ELINE; + if ( ! man_unscope(m, m->last->parent, WERRMAX)) + return(0); + } + + if ( ! (MAN_BLINE & m->flags)) + return(1); + m->flags &= ~MAN_BLINE; + + if ( ! man_unscope(m, m->last->parent, WERRMAX)) + return(0); + return(man_body_alloc(m, line, 0, m->last->tok)); } +static int +macrowarn(struct man *m, int ln, const char *buf) +{ + 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 man_pmacro(struct man *m, int ln, char *buf) { - int i, c; - char mac[5]; + int i, j, ppos, fl; + enum mant tok; + char mac[5]; + struct man_node *n; /* Comments and empties are quickly ignored. */ - if (0 == buf[1]) + fl = m->flags; + + if ('\0' == buf[1]) return(1); - if (' ' == buf[1]) { - i = 2; - while (buf[i] && ' ' == buf[i]) + i = 1; + + /* + * 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]) - return(1); - warnx("invalid syntax"); - return(0); + if ('\0' == buf[i]) + goto out; } - if (buf[1] && '\\' == buf[1]) - if (buf[2] && '\"' == buf[2]) - return(1); + ppos = i; /* Copy the first word into a nil-terminated buffer. */ - for (i = 1; i < 5; i++) { - if (0 == (mac[i - 1] = buf[i])) + for (j = 0; j < 4; j++, i++) { + if ('\0' == (mac[j] = buf[i])) break; else if (' ' == buf[i]) break; + + /* Check for invalid characters. */ + + if (isgraph((u_char)buf[i])) + continue; + return(man_perr(m, ln, i, WNPRINT)); } - mac[i - 1] = 0; + mac[j] = '\0'; - if (i == 5 || i <= 1) { - warnx("unknown macro: %s", mac); - goto err; - } + if (j == 4 || j < 1) { + if ( ! (MAN_IGN_MACRO & m->pflags)) { + (void)man_perr(m, ln, ppos, WMACROFORM); + goto err; + } + if ( ! man_pwarn(m, ln, ppos, WMACROFORM)) + goto err; + return(1); + } - if (MAN_MAX == (c = man_hash_find(m->htab, mac))) { - warnx("unknown macro: %s", mac); - goto err; + if (MAN_MAX == (tok = man_hash_find(mac))) { + if ( ! macrowarn(m, ln, mac)) + goto err; + return(1); } /* The macro is sane. Jump to the next word. */ @@ -322,15 +544,186 @@ man_pmacro(struct man *m, int ln, char *buf) while (buf[i] && ' ' == buf[i]) i++; + /* Trailing whitespace? */ + + if ('\0' == buf[i] && ' ' == buf[i - 1]) + if ( ! man_pwarn(m, ln, i - 1, WTSPACE)) + 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) + return(man_perr(m, ln, ppos, WLNSCOPE)); + + n = m->last; + + assert(n); + assert(NULL == n->child); + assert(0 == n->nchild); + + if ( ! man_nwarn(m, n, WLNSCOPE)) + return(0); + + man_node_delete(m, n); + m->flags &= ~MAN_ELINE; + } + /* Begin recursive parse sequence. */ - if ( ! man_macro(m, c, ln, 1, &i, buf)) + assert(man_macros[tok].fp); + + if ( ! (*man_macros[tok].fp)(m, tok, ln, ppos, &i, buf)) goto err; - return(1); +out: + /* + * We weren't in a block-line scope when entering the + * above-parsed macro, so return. + * + * FIXME: this prohibits the nesting of blocks (e.g., `de' and + * family) within BLINE or ELINE systems. This is annoying. + */ + if ( ! (MAN_BLINE & fl)) { + m->flags &= ~MAN_ILINE; + return(1); + } + + /* + * 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. + */ + + 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, WERRMAX)) + return(0); + return(man_body_alloc(m, ln, 0, m->last->tok)); + err: /* Error out. */ m->flags |= MAN_HALT; return(0); +} + + +int +man_verr(struct man *man, 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); + va_end(ap); + return((*man->cb.man_err)(man->data, ln, pos, buf)); +} + + +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)); +} + + +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 (iserr) + return(man_verr(m, line, pos, p)); + + return(man_vwarn(m, line, pos, p)); +} + + +/* + * 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) +{ + + /* Adjust siblings. */ + + if (n->prev) + n->prev->next = n->next; + if (n->next) + n->next->prev = n->prev; + + /* Adjust parent. */ + + if (n->parent) { + n->parent->nchild--; + if (n->parent->child == n) + n->parent->child = n->prev ? n->prev : n->next; + } + + /* Adjust parse point, if applicable. */ + + 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; }