=================================================================== RCS file: /cvs/mandoc/man.c,v retrieving revision 1.61 retrieving revision 1.113 diff -u -p -r1.61 -r1.113 --- mandoc/man.c 2010/05/07 15:49:36 1.61 +++ mandoc/man.c 2011/11/07 01:24:40 1.113 @@ -1,6 +1,6 @@ -/* $Id: man.c,v 1.61 2010/05/07 15:49:36 kristaps Exp $ */ +/* $Id: man.c,v 1.113 2011/11/07 01:24:40 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 @@ -21,76 +21,50 @@ #include #include -#include #include #include #include #include +#include "man.h" +#include "mandoc.h" #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 */ - "deprecated comment style", /* WBADCOMMENT */ -}; - 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", "na", "i", "sp", - "nf", "fi", "r", "RE", - "RS", "DT", "UC", "PD", - "Sp", "Vb", "Ve", "de", - "dei", "am", "ami", "ig", - ".", + "RI", "na", "sp", "nf", + "fi", "RE", "RS", "DT", + "UC", "PD", "AT", "in", + "ft" }; const char * const *man_macronames = __man_macronames; -static struct man_node *man_node_alloc(int, int, +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 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 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 macrowarn(struct man *, int, const char *); +static int man_descope(struct man *, int, int); const struct man_node * man_node(const struct man *m) { - return(MAN_HALT & m->flags ? NULL : m->first); + assert( ! (MAN_HALT & m->flags)); + return(m->first); } @@ -98,7 +72,8 @@ const struct man_meta * man_meta(const struct man *m) { - return(MAN_HALT & m->flags ? NULL : &m->meta); + assert( ! (MAN_HALT & m->flags)); + return(&m->meta); } @@ -121,18 +96,15 @@ man_free(struct man *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 = mandoc_calloc(1, sizeof(struct man)); - if (cb) - memcpy(&p->cb, cb, sizeof(struct man_cb)); - man_hash_init(); - p->data = data; - p->pflags = pflags; + p->parse = parse; + p->roff = roff; man_alloc1(p); return(p); @@ -143,9 +115,8 @@ int man_endparse(struct man *m) { - if (MAN_HALT & m->flags) - return(0); - else if (man_macroend(m)) + assert( ! (MAN_HALT & m->flags)); + if (man_macroend(m)) return(1); m->flags |= MAN_HALT; return(0); @@ -153,12 +124,16 @@ 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 || '\'' == *buf ? - man_pmacro(m, ln, buf) : - man_ptext(m, ln, buf)); + m->flags |= MAN_NEWLINE; + + assert( ! (MAN_HALT & m->flags)); + + return (mandoc_getcontrol(buf, &offs) ? + man_pmacro(m, ln, buf, offs) : + man_ptext(m, ln, buf, offs)); } @@ -172,8 +147,12 @@ man_free1(struct man *man) 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); } @@ -225,6 +204,10 @@ man_node_append(struct man *man, struct man_node *p) 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; @@ -236,11 +219,11 @@ man_node_append(struct man *man, struct man_node *p) 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; @@ -251,7 +234,8 @@ 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, enum mant tok) +man_node_alloc(struct man *m, int line, int pos, + enum man_type type, enum mant tok) { struct man_node *p; @@ -260,6 +244,10 @@ man_node_alloc(int line, int pos, enum man_type type, p->pos = pos; p->type = type; p->tok = tok; + + if (MAN_NEWLINE & m->flags) + p->flags |= MAN_LINE; + m->flags &= ~MAN_NEWLINE; return(p); } @@ -269,7 +257,7 @@ man_elem_alloc(struct man *m, int line, int pos, enum { struct man_node *p; - p = man_node_alloc(line, pos, MAN_ELEM, tok); + p = man_node_alloc(m, line, pos, MAN_ELEM, tok); if ( ! man_node_append(m, p)) return(0); m->next = MAN_NEXT_CHILD; @@ -278,11 +266,24 @@ man_elem_alloc(struct man *m, int line, int pos, enum int +man_tail_alloc(struct man *m, int line, int pos, enum mant tok) +{ + struct man_node *p; + + p = man_node_alloc(m, line, pos, MAN_TAIL, tok); + if ( ! man_node_append(m, p)) + return(0); + m->next = MAN_NEXT_CHILD; + return(1); +} + + +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); + p = man_node_alloc(m, line, pos, MAN_HEAD, tok); if ( ! man_node_append(m, p)) return(0); m->next = MAN_NEXT_CHILD; @@ -295,7 +296,7 @@ man_body_alloc(struct man *m, int line, int pos, enum { struct man_node *p; - p = man_node_alloc(line, pos, MAN_BODY, tok); + p = man_node_alloc(m, line, pos, MAN_BODY, tok); if ( ! man_node_append(m, p)) return(0); m->next = MAN_NEXT_CHILD; @@ -308,29 +309,21 @@ man_block_alloc(struct man *m, int line, int pos, enum { struct man_node *p; - p = man_node_alloc(line, pos, MAN_BLOCK, tok); + p = man_node_alloc(m, line, pos, MAN_BLOCK, tok); if ( ! man_node_append(m, p)) return(0); m->next = MAN_NEXT_CHILD; return(1); } - int man_word_alloc(struct man *m, int line, int pos, const char *word) { struct man_node *n; - size_t sv, len; - len = strlen(word); + n = man_node_alloc(m, line, pos, MAN_TEXT, MAN_MAX); + n->string = roff_strdup(m->roff, word); - n = man_node_alloc(line, pos, MAN_TEXT, MAN_MAX); - n->string = mandoc_malloc(len + 1); - sv = strlcpy(n->string, word, len + 1); - - /* Prohibit truncation. */ - assert(sv < len + 1); - if ( ! man_node_append(m, n)) return(0); @@ -364,194 +357,223 @@ man_node_delete(struct man *m, struct man_node *p) man_node_free(p); } +int +man_addeqn(struct man *m, const struct eqn *ep) +{ + struct man_node *n; + assert( ! (MAN_HALT & m->flags)); + + n = man_node_alloc(m, ep->ln, ep->pos, MAN_EQN, MAN_MAX); + n->eqn = ep; + + if ( ! man_node_append(m, n)) + return(0); + + m->next = MAN_NEXT_SIBLING; + return(man_descope(m, ep->ln, ep->pos)); +} + +int +man_addspan(struct man *m, const struct tbl_span *sp) +{ + struct man_node *n; + + assert( ! (MAN_HALT & m->flags)); + + n = man_node_alloc(m, sp->line, 0, MAN_TBL, MAN_MAX); + n->span = sp; + + if ( ! man_node_append(m, n)) + return(0); + + m->next = MAN_NEXT_SIBLING; + return(man_descope(m, sp->line, 0)); +} + static int -man_ptext(struct man *m, int line, char *buf) +man_descope(struct man *m, int line, int offs) { - int i; + /* + * 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). + */ - /* Ignore bogus comments. */ + if (MAN_ELINE & m->flags) { + m->flags &= ~MAN_ELINE; + if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX)) + return(0); + } - if ('\\' == buf[0] && '.' == buf[1] && '\"' == buf[2]) - return(man_pwarn(m, line, 0, WBADCOMMENT)); + if ( ! (MAN_BLINE & m->flags)) + return(1); + m->flags &= ~MAN_BLINE; + if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX)) + return(0); + return(man_body_alloc(m, line, offs, m->last->tok)); +} + +static int +man_ptext(struct man *m, int line, char *buf, int offs) +{ + int i; + /* 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; + return(man_descope(m, line, offs)); } /* 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]) { /* Allocate a blank entry. */ - if ( ! man_word_alloc(m, line, 0, "")) + if ( ! man_word_alloc(m, line, offs, "")) return(0); - goto descope; + return(man_descope(m, line, offs)); } - /* Warn if the last un-escaped character is whitespace. */ + /* + * 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 (1 == i || ('\\' != buf[i - 2])) - if ( ! man_pwarn(m, line, i - 1, WTSPACE)) - return(0); + if (' ' == buf[i - 1] || '\t' == buf[i - 1]) { + if (i > 1 && '\\' != buf[i - 2]) + man_pmsg(m, line, i - 1, MANDOCERR_EOLNSPACE); - if ( ! man_word_alloc(m, line, 0, buf)) + 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(m, line, offs, buf + offs)) return(0); -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). + * 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. */ - if (MAN_ELINE & m->flags) { - m->flags &= ~MAN_ELINE; - if ( ! man_unscope(m, m->last->parent, WERRMAX)) - return(0); - } + assert(i); + if (mandoc_eos(buf, (size_t)i, 0)) + m->last->flags |= MAN_EOS; - 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)); + return(man_descope(m, line, offs)); } - static int -macrowarn(struct man *m, int ln, const char *buf) +man_pmacro(struct man *m, int ln, 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 -man_pmacro(struct man *m, int ln, char *buf) -{ - int i, j, ppos; + int i, ppos; enum mant tok; char mac[5]; struct man_node *n; - /* Comments and empties are quickly ignored. */ - - if ('\0' == buf[1]) + if ('"' == buf[offs]) { + man_pmsg(m, ln, offs, MANDOCERR_BADCOMMENT); return(1); + } else if ('\0' == buf[offs]) + return(1); - i = 1; + ppos = offs; /* - * Skip whitespace between the control character and initial - * text. "Whitespace" is both spaces and tabs. + * Copy the first word into a nil-terminated buffer. + * Stop copying when a tab, space, or eoln is encountered. */ - if (' ' == buf[i] || '\t' == buf[i]) { - i++; - while (buf[i] && (' ' == buf[i] || '\t' == buf[i])) - i++; - if ('\0' == buf[i]) - goto out; - } - ppos = i; + i = 0; + while (i < 4 && '\0' != buf[offs] && + ' ' != buf[offs] && '\t' != buf[offs]) + mac[i++] = buf[offs++]; - /* Copy the first word into a nil-terminated buffer. */ + mac[i] = '\0'; - for (j = 0; j < 4; j++, i++) { - if ('\0' == (mac[j] = buf[i])) - break; - else if (' ' == buf[i]) - break; + tok = (i > 0 && i < 4) ? man_hash_find(mac) : MAN_MAX; - /* 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); - goto err; - } - if ( ! man_pwarn(m, ln, ppos, WMACROFORM)) - goto err; + if (MAN_MAX == tok) { + mandoc_vmsg(MANDOCERR_MACRO, m->parse, ln, + ppos, "%s", buf + ppos - 1); return(1); } - - 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. */ - while (buf[i] && ' ' == buf[i]) - i++; + while (buf[offs] && ' ' == buf[offs]) + offs++; - /* Trailing whitespace? */ + /* + * 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[i] && ' ' == buf[i - 1]) - if ( ! man_pwarn(m, ln, i - 1, WTSPACE)) - goto err; + if ('\0' == buf[offs] && ' ' == buf[offs - 1]) + man_pmsg(m, ln, offs - 1, MANDOCERR_EOLNSPACE); /* - * Remove prior ELINE macro, as it's being clobbering by a new + * 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. - * NOTE: we don't allow roff blocks (NOCLOSE) to be embedded - * here because that would stipulate blocks as children of - * elements! */ if ( ! (MAN_NSCOPED & man_macros[tok].flags) && m->flags & MAN_ELINE) { - assert(MAN_TEXT != m->last->type); + n = m->last; + assert(MAN_TEXT != n->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)); + /* Remove repeated NSCOPED macros causing ELINE. */ + if (MAN_NSCOPED & man_macros[n->tok].flags) + n = n->parent; + + mandoc_vmsg(MANDOCERR_LINESCOPE, m->parse, n->line, + n->pos, "%s breaks %s", man_macronames[tok], + man_macronames[n->tok]); + + man_node_delete(m, n); + m->flags &= ~MAN_ELINE; + } + + /* + * Remove prior BLINE macro that is being clobbered. + */ + if ((m->flags & MAN_BLINE) && + (MAN_BSCOPE & man_macros[tok].flags)) { n = m->last; + assert(MAN_TEXT != n->type); - assert(n); - assert(NULL == n->child); - assert(0 == n->nchild); + /* Remove element that didn't end BLINE, if any. */ - if ( ! man_nwarn(m, n, WLNSCOPE)) - return(0); + 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, m->parse, n->line, + n->pos, "%s breaks %s", man_macronames[tok], + man_macronames[n->tok]); + man_node_delete(m, n); - m->flags &= ~MAN_ELINE; + m->flags &= ~MAN_BLINE; } /* @@ -566,10 +588,9 @@ man_pmacro(struct man *m, int ln, char *buf) /* Call to handler... */ assert(man_macros[tok].fp); - if ( ! (*man_macros[tok].fp)(m, tok, ln, ppos, &i, buf)) + if ( ! (*man_macros[tok].fp)(m, tok, ln, ppos, &offs, buf)) goto err; -out: /* * We weren't in a block-line scope when entering the * above-parsed macro, so return. @@ -604,9 +625,9 @@ out: assert(MAN_BLINE & m->flags); m->flags &= ~MAN_BLINE; - if ( ! man_unscope(m, m->last->parent, WERRMAX)) + 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, ppos, m->last->tok)); err: /* Error out. */ @@ -614,54 +635,6 @@ err: /* Error out. */ 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. @@ -701,4 +674,12 @@ man_node_unlink(struct man *m, struct man_node *n) if (m && m->first == n) m->first = NULL; +} + +const struct mparse * +man_mparse(const struct man *m) +{ + + assert(m && m->parse); + return(m->parse); }