=================================================================== RCS file: /cvs/mandoc/man.c,v retrieving revision 1.8 retrieving revision 1.122 diff -u -p -r1.8 -r1.122 --- mandoc/man.c 2009/03/25 21:46:24 1.8 +++ mandoc/man.c 2013/12/31 23:23:10 1.122 @@ -1,63 +1,80 @@ -/* $Id: man.c,v 1.8 2009/03/25 21:46:24 kristaps Exp $ */ +/* $Id: man.c,v 1.122 2013/12/31 23:23:10 schwarze Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * Copyright (c) 2008, 2009, 2010, 2011 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 "man.h" +#include "mandoc.h" #include "libman.h" +#include "libmandoc.h" 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", "sp", "nf", + "fi", "RE", "RS", "DT", + "UC", "PD", "AT", "in", + "ft", "OP", "EX", "EE", + "UR", "UE" }; 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(struct man *, int, 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 void man_alloc1(struct man *); +static int man_descope(struct man *, int, int); const struct man_node * -man_node(const struct man *m) +man_node(const struct man *man) { - return(MAN_HALT & m->flags ? NULL : m->first); + assert( ! (MAN_HALT & man->flags)); + return(man->first); } const struct man_meta * -man_meta(const struct man *m) +man_meta(const struct man *man) { - return(MAN_HALT & m->flags ? NULL : &m->meta); + assert( ! (MAN_HALT & man->flags)); + return(&man->meta); } @@ -75,55 +92,49 @@ man_free(struct man *man) { man_free1(man); - - if (man->htab) - man_hash_free(man->htab); free(man); } struct man * -man_alloc(void *data, int pflags, const struct man_cb *cb) +man_alloc(struct roff *roff, struct mparse *parse) { 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); + man_hash_init(); + p->parse = parse; + p->roff = roff; - if (cb) - (void)memcpy(&p->cb, cb, sizeof(struct man_cb)); - - p->htab = man_hash_alloc(); - p->data = data; - p->pflags = pflags; - + man_alloc1(p); return(p); } int -man_endparse(struct man *m) +man_endparse(struct man *man) { - if (MAN_HALT & m->flags) - return(0); - else if (man_macroend(m)) + assert( ! (MAN_HALT & man->flags)); + if (man_macroend(man)) return(1); - m->flags |= MAN_HALT; + man->flags |= MAN_HALT; return(0); } int -man_parseln(struct man *m, int ln, char *buf) +man_parseln(struct man *man, int ln, char *buf, int offs) { - return('.' == *buf ? - man_pmacro(m, ln, buf) : - man_ptext(m, ln, buf)); + man->flags |= MAN_NEWLINE; + + assert( ! (MAN_HALT & man->flags)); + + return (roff_getcontrol(man->roff, buf, &offs) ? + man_pmacro(man, ln, buf, offs) : + man_ptext(man, ln, buf, offs)); } @@ -132,28 +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.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) +man_alloc1(struct man *man) { - bzero(&m->meta, sizeof(struct man_meta)); - m->flags = 0; - m->last = calloc(1, sizeof(struct man_node)); - if (NULL == m->last) - err(1, "calloc"); - m->first = m->last; - m->last->type = MAN_ROOT; - m->next = MAN_NEXT_CHILD; + memset(&man->meta, 0, sizeof(struct man_meta)); + man->flags = 0; + man->last = mandoc_calloc(1, sizeof(struct man_node)); + man->first = man->last; + man->last->type = MAN_ROOT; + man->last->tok = MAN_MAX; + man->next = MAN_NEXT_CHILD; } @@ -179,15 +193,38 @@ man_node_append(struct man *man, struct man_node *p) 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_TAIL): + assert(MAN_BLOCK == p->parent->type); + p->parent->tail = 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); - if ( ! man_action_post(man)) - return(0); break; default: break; @@ -198,47 +235,109 @@ 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(struct man *man, 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; + if (MAN_NEWLINE & man->flags) + p->flags |= MAN_LINE; + man->flags &= ~MAN_NEWLINE; return(p); } int -man_elem_alloc(struct man *man, int line, int pos, int tok) +man_elem_alloc(struct man *man, 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(man, line, pos, MAN_ELEM, tok); + if ( ! man_node_append(man, p)) + return(0); + man->next = MAN_NEXT_CHILD; + return(1); +} - return(man_node_append(man, p)); + +int +man_tail_alloc(struct man *man, int line, int pos, enum mant tok) +{ + struct man_node *p; + + p = man_node_alloc(man, line, pos, MAN_TAIL, tok); + if ( ! man_node_append(man, p)) + return(0); + man->next = MAN_NEXT_CHILD; + return(1); } int -man_word_alloc(struct man *man, - int line, int pos, const char *word) +man_head_alloc(struct man *man, 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(man, line, pos, MAN_HEAD, tok); + if ( ! man_node_append(man, p)) + return(0); + man->next = MAN_NEXT_CHILD; + return(1); +} - return(man_node_append(man, p)); + +int +man_body_alloc(struct man *man, int line, int pos, enum mant tok) +{ + struct man_node *p; + + p = man_node_alloc(man, line, pos, MAN_BODY, tok); + if ( ! man_node_append(man, p)) + return(0); + man->next = MAN_NEXT_CHILD; + return(1); } -void +int +man_block_alloc(struct man *man, int line, int pos, enum mant tok) +{ + struct man_node *p; + + p = man_node_alloc(man, line, pos, MAN_BLOCK, tok); + if ( ! man_node_append(man, p)) + return(0); + man->next = MAN_NEXT_CHILD; + return(1); +} + +int +man_word_alloc(struct man *man, int line, int pos, const char *word) +{ + struct man_node *n; + + n = man_node_alloc(man, line, pos, MAN_TEXT, MAN_MAX); + n->string = roff_strdup(man->roff, word); + + if ( ! man_node_append(man, n)) + return(0); + + man->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(). + */ +static void man_node_free(struct man_node *p) { @@ -249,134 +348,351 @@ man_node_free(struct man_node *p) void -man_node_freelist(struct man_node *p) +man_node_delete(struct man *man, 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(man, p->child); + man_node_unlink(man, p); man_node_free(p); } +int +man_addeqn(struct man *man, const struct eqn *ep) +{ + struct man_node *n; + assert( ! (MAN_HALT & man->flags)); + + n = man_node_alloc(man, ep->ln, ep->pos, MAN_EQN, MAN_MAX); + n->eqn = ep; + + if ( ! man_node_append(man, n)) + return(0); + + man->next = MAN_NEXT_SIBLING; + return(man_descope(man, ep->ln, ep->pos)); +} + +int +man_addspan(struct man *man, const struct tbl_span *sp) +{ + struct man_node *n; + + assert( ! (MAN_HALT & man->flags)); + + n = man_node_alloc(man, sp->line, 0, MAN_TBL, MAN_MAX); + n->span = sp; + + if ( ! man_node_append(man, n)) + return(0); + + man->next = MAN_NEXT_SIBLING; + return(man_descope(man, sp->line, 0)); +} + static int -man_ptext(struct man *m, int line, char *buf) +man_descope(struct 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_word_alloc(m, line, 0, buf)) + if (MAN_ELINE & man->flags) { + man->flags &= ~MAN_ELINE; + if ( ! man_unscope(man, man->last->parent, MANDOCERR_MAX)) + return(0); + } + + if ( ! (MAN_BLINE & man->flags)) + return(1); + man->flags &= ~MAN_BLINE; + + if ( ! man_unscope(man, man->last->parent, MANDOCERR_MAX)) return(0); - m->next = MAN_NEXT_SIBLING; - return(1); + return(man_body_alloc(man, line, offs, man->last->tok)); } +static int +man_ptext(struct man *man, int line, char *buf, int offs) +{ + int i; -int -man_pmacro(struct man *m, int ln, char *buf) + /* Literal free-form text whitespace is preserved. */ + + if (MAN_LITERAL & man->flags) { + if ( ! man_word_alloc(man, line, offs, buf + offs)) + return(0); + return(man_descope(man, line, offs)); + } + + for (i = offs; ' ' == buf[i]; i++) + /* Skip leading whitespace. */ ; + + /* + * Blank lines are ignored right after headings + * but add a single vertical space elsewhere. + */ + + if ('\0' == buf[i]) { + /* Allocate a blank entry. */ + if (MAN_SH != man->last->tok && + MAN_SS != man->last->tok) { + if ( ! man_elem_alloc(man, line, offs, MAN_sp)) + return(0); + man->next = MAN_NEXT_SIBLING; + } + return(1); + } + + /* + * Warn if the last un-escaped character is whitespace. Then + * strip away the remaining spaces (tabs stay!). + */ + + i = (int)strlen(buf); + assert(i); + + if (' ' == buf[i - 1] || '\t' == buf[i - 1]) { + if (i > 1 && '\\' != buf[i - 2]) + man_pmsg(man, line, i - 1, MANDOCERR_EOLNSPACE); + + for (--i; i && ' ' == buf[i]; i--) + /* Spin back to non-space. */ ; + + /* Jump ahead of escaped whitespace. */ + i += '\\' == buf[i] ? 2 : 1; + + buf[i] = '\0'; + } + + if ( ! man_word_alloc(man, 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 + * sentence. The front-end will know how to interpret this. + */ + + assert(i); + if (mandoc_eos(buf, (size_t)i)) + man->last->flags |= MAN_EOS; + + return(man_descope(man, line, offs)); +} + +static int +man_pmacro(struct man *man, int ln, char *buf, int offs) { - int i, c; - char mac[5]; + int i, ppos; + enum mant tok; + char mac[5]; + struct man_node *n; - /* Comments and empties are quickly ignored. */ + if ('"' == buf[offs]) { + man_pmsg(man, ln, offs, MANDOCERR_BADCOMMENT); + return(1); + } else if ('\0' == buf[offs]) + return(1); - if (0 == buf[1]) + ppos = offs; + + /* + * Copy the first word into a nil-terminated buffer. + * Stop copying when a tab, space, or eoln is encountered. + */ + + i = 0; + while (i < 4 && '\0' != buf[offs] && + ' ' != buf[offs] && '\t' != buf[offs]) + mac[i++] = buf[offs++]; + + mac[i] = '\0'; + + tok = (i > 0 && i < 4) ? man_hash_find(mac) : MAN_MAX; + + if (MAN_MAX == tok) { + mandoc_vmsg(MANDOCERR_MACRO, man->parse, ln, + ppos, "%s", buf + ppos - 1); return(1); + } - if (' ' == buf[1]) { - i = 2; - while (buf[i] && ' ' == buf[i]) - i++; - if (0 == buf[i]) - return(1); - return(man_vwarn(m, ln, 0, "invalid syntax")); + /* The macro is sane. Jump to the next 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 ('\0' == buf[offs] && ' ' == buf[offs - 1]) + man_pmsg(man, ln, offs - 1, MANDOCERR_EOLNSPACE); + + /* + * 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. + */ + + if ( ! (MAN_NSCOPED & man_macros[tok].flags) && + man->flags & MAN_ELINE) { + n = man->last; + assert(MAN_TEXT != n->type); + + /* Remove repeated NSCOPED macros causing ELINE. */ + + if (MAN_NSCOPED & man_macros[n->tok].flags) + n = n->parent; + + mandoc_vmsg(MANDOCERR_LINESCOPE, man->parse, n->line, + n->pos, "%s breaks %s", man_macronames[tok], + man_macronames[n->tok]); + + man_node_delete(man, n); + man->flags &= ~MAN_ELINE; } - if (buf[1] && '\\' == buf[1]) - if (buf[2] && '\"' == buf[2]) - return(1); + /* + * Remove prior BLINE macro that is being clobbered. + */ + if ((man->flags & MAN_BLINE) && + (MAN_BSCOPE & man_macros[tok].flags)) { + n = man->last; - /* Copy the first word into a nil-terminated buffer. */ + /* Might be a text node like 8 in + * .TP 8 + * .SH foo + */ + if (MAN_TEXT == n->type) + n = n->parent; - for (i = 1; i < 5; i++) { - if (0 == (mac[i - 1] = buf[i])) - break; - else if (' ' == buf[i]) - break; + /* Remove element that didn't end BLINE, if any. */ + if ( ! (MAN_BSCOPE & man_macros[n->tok].flags)) + n = n->parent; + + assert(MAN_HEAD == n->type); + n = n->parent; + assert(MAN_BLOCK == n->type); + assert(MAN_SCOPED & man_macros[n->tok].flags); + + mandoc_vmsg(MANDOCERR_LINESCOPE, man->parse, n->line, + n->pos, "%s breaks %s", man_macronames[tok], + man_macronames[n->tok]); + + man_node_delete(man, n); + man->flags &= ~MAN_BLINE; } - mac[i - 1] = 0; + /* + * 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 (i == 5 || i <= 1) { - if ( ! (MAN_IGN_MACRO & m->pflags)) { - (void)man_verr(m, ln, 1, - "ill-formed macro: %s", mac); - goto err; - } - if ( ! man_vwarn(m, ln, 1, "ill-formed macro: %s", mac)) - goto err; + if (MAN_BLINE & man->flags) + man->flags |= MAN_BPLINE; + + /* Call to handler... */ + + assert(man_macros[tok].fp); + if ( ! (*man_macros[tok].fp)(man, tok, ln, ppos, &offs, buf)) + goto err; + + /* + * We weren't in a block-line scope when entering the + * above-parsed macro, so return. + */ + + if ( ! (MAN_BPLINE & man->flags)) { + man->flags &= ~MAN_ILINE; return(1); } - - if (MAN_MAX == (c = man_hash_find(m->htab, mac))) { - if ( ! (MAN_IGN_MACRO & m->pflags)) { - (void)man_verr(m, ln, 1, - "unknown macro: %s", mac); - goto err; - } - if ( ! man_vwarn(m, ln, 1, "unknown macro: %s", mac)) - goto err; + man->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 & man->flags) { + man->flags &= ~MAN_ILINE; return(1); } - /* The macro is sane. Jump to the next word. */ + /* + * If we've opened a new next-line element scope, then return + * now, as the next line will close out the block scope. + */ - while (buf[i] && ' ' == buf[i]) - i++; + if (MAN_ELINE & man->flags) + return(1); - /* Begin recursive parse sequence. */ + /* Close out the block scope opened in the prior line. */ - if ( ! man_macro(m, c, ln, 1, &i, buf)) - goto err; + assert(MAN_BLINE & man->flags); + man->flags &= ~MAN_BLINE; - return(1); + if ( ! man_unscope(man, man->last->parent, MANDOCERR_MAX)) + return(0); + return(man_body_alloc(man, ln, ppos, man->last->tok)); err: /* Error out. */ - m->flags |= MAN_HALT; + man->flags |= MAN_HALT; return(0); } - -int -man_verr(struct man *man, int ln, int pos, const char *fmt, ...) +/* + * 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 man *man, struct man_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 = MAN_NEXT_SIBLING; + } else { + man->last = n->parent; + man->next = MAN_NEXT_CHILD; + } + } + + if (man && man->first == n) + man->first = NULL; } +const struct mparse * +man_mparse(const struct man *man) +{ + assert(man && man->parse); + return(man->parse); +}