=================================================================== RCS file: /cvs/mandoc/mdoc.c,v retrieving revision 1.61 retrieving revision 1.135 diff -u -p -r1.61 -r1.135 --- mandoc/mdoc.c 2009/03/11 00:39:58 1.61 +++ mandoc/mdoc.c 2010/05/16 10:59:36 1.135 @@ -1,48 +1,93 @@ -/* $Id: mdoc.c,v 1.61 2009/03/11 00:39:58 kristaps Exp $ */ +/* $Id: mdoc.c,v 1.135 2010/05/16 10:59:36 kristaps Exp $ */ /* - * Copyright (c) 2008 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 +#include -#include "private.h" +#include "libmdoc.h" +#include "libmandoc.h" -/* - * Main caller in the libmdoc library. This begins the parsing routine, - * handles allocation of data, and so forth. Most of the "work" is done - * in macro.c and validate.c. - */ +const char *const __mdoc_merrnames[MERRMAX] = { + "trailing whitespace", /* ETAILWS */ + "unexpected quoted parameter", /* EQUOTPARM */ + "unterminated quoted parameter", /* EQUOTTERM */ + "argument parameter suggested", /* EARGVAL */ + "macro disallowed in prologue", /* EBODYPROL */ + "macro disallowed in body", /* EPROLBODY */ + "text disallowed in prologue", /* ETEXTPROL */ + "blank line disallowed", /* ENOBLANK */ + "text parameter too long", /* ETOOLONG */ + "invalid escape sequence", /* EESCAPE */ + "invalid character", /* EPRINT */ + "document has no body", /* ENODAT */ + "document has no prologue", /* ENOPROLOGUE */ + "expected line arguments", /* ELINE */ + "invalid AT&T argument", /* EATT */ + "default name not yet set", /* ENAME */ + "missing list type", /* ELISTTYPE */ + "missing display type", /* EDISPTYPE */ + "too many display types", /* EMULTIDISP */ + "too many list types", /* EMULTILIST */ + "NAME section must be first", /* ESECNAME */ + "badly-formed NAME section", /* ENAMESECINC */ + "argument repeated", /* EARGREP */ + "expected boolean parameter", /* EBOOL */ + "inconsistent column syntax", /* ECOLMIS */ + "nested display invalid", /* ENESTDISP */ + "width argument missing", /* EMISSWIDTH */ + "invalid section for this manual section", /* EWRONGMSEC */ + "section out of conventional order", /* ESECOOO */ + "section repeated", /* ESECREP */ + "invalid standard argument", /* EBADSTAND */ + "multi-line arguments discouraged", /* ENOMULTILINE */ + "multi-line arguments suggested", /* EMULTILINE */ + "line arguments discouraged", /* ENOLINE */ + "prologue macro out of conventional order", /* EPROLOOO */ + "prologue macro repeated", /* EPROLREP */ + "invalid manual section", /* EBADMSEC */ + "invalid font mode", /* EFONT */ + "invalid date syntax", /* EBADDATE */ + "invalid number format", /* ENUMFMT */ + "superfluous width argument", /* ENOWIDTH */ + "system: utsname error", /* EUTSNAME */ + "obsolete macro", /* EOBS */ + "end-of-line scope violation", /* EIMPBRK */ + "empty macro ignored", /* EIGNE */ + "unclosed explicit scope", /* EOPEN */ + "unterminated quoted phrase", /* EQUOTPHR */ + "closure macro without prior context", /* ENOCTX */ + "no description found for library", /* ELIB */ + "bad child for parent context", /* EBADCHILD */ + "list arguments preceding type", /* ENOTYPE */ + "deprecated comment style", /* EBADCOMMENT */ +}; -static struct mdoc_node *mdoc_node_alloc(const struct mdoc *); -static int mdoc_node_append(struct mdoc *, - struct mdoc_node *); - -static int parsetext(struct mdoc *, int, char *); -static int parsemacro(struct mdoc *, int, char *); -static int macrowarn(struct mdoc *, int, const char *); - - const char *const __mdoc_macronames[MDOC_MAX] = { - "\\\"", "Dd", "Dt", "Os", + "Ap", "Dd", "Dt", "Os", "Sh", "Ss", "Pp", "D1", "Dl", "Bd", "Ed", "Bl", "El", "It", "Ad", "An", @@ -53,11 +98,11 @@ const char *const __mdoc_macronames[MDOC_MAX] = { "Nm", "Op", "Ot", "Pa", "Rv", "St", "Va", "Vt", /* LINTED */ - "Xr", "\%A", "\%B", "\%D", + "Xr", "%A", "%B", "%D", /* LINTED */ - "\%I", "\%J", "\%N", "\%O", + "%I", "%J", "%N", "%O", /* LINTED */ - "\%P", "\%R", "\%T", "\%V", + "%P", "%R", "%T", "%V", "Ac", "Ao", "Aq", "At", "Bc", "Bf", "Bo", "Bq", "Bsx", "Bx", "Db", "Dc", @@ -71,9 +116,14 @@ const char *const __mdoc_macronames[MDOC_MAX] = { "Tn", "Ux", "Xc", "Xo", "Fo", "Fc", "Oo", "Oc", "Bk", "Ek", "Bt", "Hf", - "Fr", "Ud", "Lb", "Ap", - "Lp", "Lk", "Mt", "Brq", - "Bro", "Brc" + "Fr", "Ud", "Lb", "Lp", + "Lk", "Mt", "Brq", "Bro", + /* LINTED */ + "Brc", "%C", "Es", "En", + /* LINTED */ + "Dx", "%Q", "br", "sp", + /* LINTED */ + "%U" }; const char *const __mdoc_argnames[MDOC_ARG_MAX] = { @@ -85,37 +135,52 @@ const char *const __mdoc_argnames[MDOC_ARG_MAX] = { "ohang", "inset", "column", "width", "compact", "std", "filled", "words", "emphasis", - "symbolic" + "symbolic", "nested", "centered" }; const char * const *mdoc_macronames = __mdoc_macronames; const char * const *mdoc_argnames = __mdoc_argnames; +static void mdoc_node_free(struct mdoc_node *); +static void mdoc_node_unlink(struct mdoc *, + struct mdoc_node *); +static void mdoc_free1(struct mdoc *); +static void mdoc_alloc1(struct mdoc *); +static struct mdoc_node *node_alloc(struct mdoc *, int, int, + enum mdoct, enum mdoc_type); +static int node_append(struct mdoc *, + struct mdoc_node *); +static int mdoc_ptext(struct mdoc *, int, char *, int); +static int mdoc_pmacro(struct mdoc *, int, char *, int); +static int macrowarn(struct mdoc *, int, + const char *, int); + const struct mdoc_node * -mdoc_node(const struct mdoc *mdoc) +mdoc_node(const struct mdoc *m) { - return(mdoc->first); + return(MDOC_HALT & m->flags ? NULL : m->first); } const struct mdoc_meta * -mdoc_meta(const struct mdoc *mdoc) +mdoc_meta(const struct mdoc *m) { - return(&mdoc->meta); + return(MDOC_HALT & m->flags ? NULL : &m->meta); } -void -mdoc_free(struct mdoc *mdoc) +/* + * Frees volatile resources (parse tree, meta-data, fields). + */ +static void +mdoc_free1(struct mdoc *mdoc) { if (mdoc->first) - mdoc_node_freelist(mdoc->first); - if (mdoc->htab) - mdoc_tokhash_free(mdoc->htab); + mdoc_node_delete(mdoc, mdoc->first); if (mdoc->meta.title) free(mdoc->meta.title); if (mdoc->meta.os) @@ -126,85 +191,113 @@ mdoc_free(struct mdoc *mdoc) free(mdoc->meta.arch); if (mdoc->meta.vol) free(mdoc->meta.vol); + if (mdoc->meta.msec) + free(mdoc->meta.msec); +} + +/* + * Allocate all volatile resources (parse tree, meta-data, fields). + */ +static void +mdoc_alloc1(struct mdoc *mdoc) +{ + + memset(&mdoc->meta, 0, sizeof(struct mdoc_meta)); + mdoc->flags = 0; + mdoc->lastnamed = mdoc->lastsec = SEC_NONE; + mdoc->last = mandoc_calloc(1, sizeof(struct mdoc_node)); + mdoc->first = mdoc->last; + mdoc->last->type = MDOC_ROOT; + mdoc->next = MDOC_NEXT_CHILD; +} + + +/* + * Free up volatile resources (see mdoc_free1()) then re-initialises the + * data with mdoc_alloc1(). After invocation, parse data has been reset + * and the parser is ready for re-invocation on a new tree; however, + * cross-parse non-volatile data is kept intact. + */ +void +mdoc_reset(struct mdoc *mdoc) +{ + + mdoc_free1(mdoc); + mdoc_alloc1(mdoc); +} + + +/* + * Completely free up all volatile and non-volatile parse resources. + * After invocation, the pointer is no longer usable. + */ +void +mdoc_free(struct mdoc *mdoc) +{ + + mdoc_free1(mdoc); free(mdoc); } +/* + * Allocate volatile and non-volatile parse resources. + */ struct mdoc * mdoc_alloc(void *data, int pflags, const struct mdoc_cb *cb) { struct mdoc *p; - p = xcalloc(1, sizeof(struct mdoc)); + p = mandoc_calloc(1, sizeof(struct mdoc)); - p->data = data; if (cb) - (void)memcpy(&p->cb, cb, sizeof(struct mdoc_cb)); + memcpy(&p->cb, cb, sizeof(struct mdoc_cb)); - p->last = xcalloc(1, sizeof(struct mdoc_node)); - p->last->type = MDOC_ROOT; - p->first = p->last; + p->data = data; p->pflags = pflags; - p->next = MDOC_NEXT_CHILD; - p->htab = mdoc_tokhash_alloc(); + mdoc_hash_init(); + mdoc_alloc1(p); return(p); } +/* + * Climb back up the parse tree, validating open scopes. Mostly calls + * through to macro_end() in macro.c. + */ int -mdoc_endparse(struct mdoc *mdoc) +mdoc_endparse(struct mdoc *m) { - if (MDOC_HALT & mdoc->flags) + if (MDOC_HALT & m->flags) return(0); - if (NULL == mdoc->first) + else if (mdoc_macroend(m)) return(1); - - assert(mdoc->last); - if ( ! macro_end(mdoc)) { - mdoc->flags |= MDOC_HALT; - return(0); - } - return(1); + m->flags |= MDOC_HALT; + return(0); } /* * Main parse routine. Parses a single line -- really just hands off to - * the macro or text parser. + * the macro (mdoc_pmacro()) or text parser (mdoc_ptext()). */ int -mdoc_parseln(struct mdoc *m, int ln, char *buf) +mdoc_parseln(struct mdoc *m, int ln, char *buf, int offs) { - /* If in error-mode, then we parse no more. */ - if (MDOC_HALT & m->flags) return(0); - return('.' == *buf ? parsemacro(m, ln, buf) : - parsetext(m, ln, buf)); + m->flags |= MDOC_NEWLINE; + return(('.' == buf[offs] || '\'' == buf[offs]) ? + mdoc_pmacro(m, ln, buf, offs) : + mdoc_ptext(m, ln, buf, offs)); } -void -mdoc_vmsg(struct mdoc *mdoc, int ln, int pos, const char *fmt, ...) -{ - char buf[256]; - va_list ap; - - if (NULL == mdoc->cb.mdoc_msg) - return; - - va_start(ap, fmt); - (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap); - va_end(ap); - (*mdoc->cb.mdoc_msg)(mdoc->data, ln, pos, buf); -} - - int mdoc_verr(struct mdoc *mdoc, int ln, int pos, const char *fmt, ...) @@ -218,13 +311,13 @@ mdoc_verr(struct mdoc *mdoc, int ln, int pos, va_start(ap, fmt); (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap); va_end(ap); + return((*mdoc->cb.mdoc_err)(mdoc->data, ln, pos, buf)); } int -mdoc_vwarn(struct mdoc *mdoc, int ln, int pos, - enum mdoc_warn type, const char *fmt, ...) +mdoc_vwarn(struct mdoc *mdoc, int ln, int pos, const char *fmt, ...) { char buf[256]; va_list ap; @@ -235,36 +328,61 @@ mdoc_vwarn(struct mdoc *mdoc, int ln, int pos, va_start(ap, fmt); (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap); va_end(ap); - return((*mdoc->cb.mdoc_warn)(mdoc->data, ln, pos, type, buf)); + + return((*mdoc->cb.mdoc_warn)(mdoc->data, ln, pos, buf)); } int -mdoc_macro(struct mdoc *m, int tok, +mdoc_err(struct mdoc *m, int line, int pos, int iserr, enum merr type) +{ + const char *p; + + p = __mdoc_merrnames[(int)type]; + assert(p); + + if (iserr) + return(mdoc_verr(m, line, pos, p)); + + return(mdoc_vwarn(m, line, pos, p)); +} + + +int +mdoc_macro(struct mdoc *m, enum mdoct tok, int ln, int pp, int *pos, char *buf) { + assert(tok < MDOC_MAX); - /* FIXME - these should happen during validation. */ + /* If we're in the body, deny prologue calls. */ if (MDOC_PROLOGUE & mdoc_macros[tok].flags && - SEC_PROLOGUE != m->lastnamed) - return(mdoc_perr(m, ln, pp, - "disallowed in document body")); + MDOC_PBODY & m->flags) + return(mdoc_perr(m, ln, pp, EPROLBODY)); + /* If we're in the prologue, deny "body" macros. */ + if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) && - SEC_PROLOGUE == m->lastnamed) - return(mdoc_perr(m, ln, pp, - "disallowed in prologue")); + ! (MDOC_PBODY & m->flags)) { + if ( ! mdoc_pwarn(m, ln, pp, EBODYPROL)) + return(0); + if (NULL == m->meta.title) + m->meta.title = mandoc_strdup("unknown"); + if (NULL == m->meta.vol) + m->meta.vol = mandoc_strdup("local"); + if (NULL == m->meta.os) + m->meta.os = mandoc_strdup("local"); + if (0 == m->meta.date) + m->meta.date = time(NULL); + m->flags |= MDOC_PBODY; + } - if (1 != pp && ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) - return(mdoc_perr(m, ln, pp, "not callable")); - return((*mdoc_macros[tok].fp)(m, tok, ln, pp, pos, buf)); } static int -mdoc_node_append(struct mdoc *mdoc, struct mdoc_node *p) +node_append(struct mdoc *mdoc, struct mdoc_node *p) { assert(mdoc->last); @@ -286,8 +404,12 @@ mdoc_node_append(struct mdoc *mdoc, struct mdoc_node * /* NOTREACHED */ } + p->parent->nchild++; + if ( ! mdoc_valid_pre(mdoc, p)) return(0); + if ( ! mdoc_action_pre(mdoc, p)) + return(0); switch (p->type) { case (MDOC_HEAD): @@ -307,148 +429,137 @@ mdoc_node_append(struct mdoc *mdoc, struct mdoc_node * } mdoc->last = p; + + switch (p->type) { + case (MDOC_TEXT): + if ( ! mdoc_valid_post(mdoc)) + return(0); + if ( ! mdoc_action_post(mdoc)) + return(0); + break; + default: + break; + } + return(1); } static struct mdoc_node * -mdoc_node_alloc(const struct mdoc *mdoc) +node_alloc(struct mdoc *m, int line, int pos, + enum mdoct tok, enum mdoc_type type) { struct mdoc_node *p; - p = xcalloc(1, sizeof(struct mdoc_node)); - p->sec = mdoc->lastsec; - - return(p); -} - - -int -mdoc_tail_alloc(struct mdoc *mdoc, int line, int pos, int tok) -{ - struct mdoc_node *p; - - assert(mdoc->first); - assert(mdoc->last); - - p = mdoc_node_alloc(mdoc); - + p = mandoc_calloc(1, sizeof(struct mdoc_node)); + p->sec = m->lastsec; p->line = line; p->pos = pos; - p->type = MDOC_TAIL; p->tok = tok; - - return(mdoc_node_append(mdoc, p)); + p->type = type; + if (MDOC_NEWLINE & m->flags) + p->flags |= MDOC_LINE; + m->flags &= ~MDOC_NEWLINE; + return(p); } int -mdoc_head_alloc(struct mdoc *mdoc, int line, int pos, int tok) +mdoc_tail_alloc(struct mdoc *m, int line, int pos, enum mdoct tok) { struct mdoc_node *p; - assert(mdoc->first); - assert(mdoc->last); - - p = mdoc_node_alloc(mdoc); - - p->line = line; - p->pos = pos; - p->type = MDOC_HEAD; - p->tok = tok; - - return(mdoc_node_append(mdoc, p)); + p = node_alloc(m, line, pos, tok, MDOC_TAIL); + if ( ! node_append(m, p)) + return(0); + m->next = MDOC_NEXT_CHILD; + return(1); } int -mdoc_body_alloc(struct mdoc *mdoc, int line, int pos, int tok) +mdoc_head_alloc(struct mdoc *m, int line, int pos, enum mdoct tok) { struct mdoc_node *p; - assert(mdoc->first); - assert(mdoc->last); + assert(m->first); + assert(m->last); - p = mdoc_node_alloc(mdoc); - - p->line = line; - p->pos = pos; - p->type = MDOC_BODY; - p->tok = tok; - - return(mdoc_node_append(mdoc, p)); + p = node_alloc(m, line, pos, tok, MDOC_HEAD); + if ( ! node_append(m, p)) + return(0); + m->next = MDOC_NEXT_CHILD; + return(1); } int -mdoc_root_alloc(struct mdoc *mdoc) +mdoc_body_alloc(struct mdoc *m, int line, int pos, enum mdoct tok) { struct mdoc_node *p; - p = mdoc_node_alloc(mdoc); - - p->type = MDOC_ROOT; - - return(mdoc_node_append(mdoc, p)); + p = node_alloc(m, line, pos, tok, MDOC_BODY); + if ( ! node_append(m, p)) + return(0); + m->next = MDOC_NEXT_CHILD; + return(1); } int -mdoc_block_alloc(struct mdoc *mdoc, int line, int pos, - int tok, struct mdoc_arg *args) +mdoc_block_alloc(struct mdoc *m, int line, int pos, + enum mdoct tok, struct mdoc_arg *args) { struct mdoc_node *p; - p = mdoc_node_alloc(mdoc); - - p->pos = pos; - p->line = line; - p->type = MDOC_BLOCK; - p->tok = tok; + p = node_alloc(m, line, pos, tok, MDOC_BLOCK); p->args = args; - - if (args) + if (p->args) (args->refcnt)++; - - return(mdoc_node_append(mdoc, p)); + if ( ! node_append(m, p)) + return(0); + m->next = MDOC_NEXT_CHILD; + return(1); } int -mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos, - int tok, struct mdoc_arg *args) +mdoc_elem_alloc(struct mdoc *m, int line, int pos, + enum mdoct tok, struct mdoc_arg *args) { struct mdoc_node *p; - p = mdoc_node_alloc(mdoc); - - p->line = line; - p->pos = pos; - p->type = MDOC_ELEM; - p->tok = tok; + p = node_alloc(m, line, pos, tok, MDOC_ELEM); p->args = args; - - if (args) + if (p->args) (args->refcnt)++; - - return(mdoc_node_append(mdoc, p)); + if ( ! node_append(m, p)) + return(0); + m->next = MDOC_NEXT_CHILD; + return(1); } int -mdoc_word_alloc(struct mdoc *mdoc, - int line, int pos, const char *word) +mdoc_word_alloc(struct mdoc *m, int line, int pos, const char *p) { - struct mdoc_node *p; + struct mdoc_node *n; + size_t sv, len; - p = mdoc_node_alloc(mdoc); + len = strlen(p); - p->line = line; - p->pos = pos; - p->type = MDOC_TEXT; - p->string = xstrdup(word); + n = node_alloc(m, line, pos, MDOC_MAX, MDOC_TEXT); + n->string = mandoc_malloc(len + 1); + sv = strlcpy(n->string, p, len + 1); - return(mdoc_node_append(mdoc, p)); + /* Prohibit truncation. */ + assert(sv < len + 1); + + if ( ! node_append(m, n)) + return(0); + + m->next = MDOC_NEXT_SIBLING; + return(1); } @@ -464,15 +575,53 @@ mdoc_node_free(struct mdoc_node *p) } +static void +mdoc_node_unlink(struct mdoc *m, struct mdoc_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) { + if (n->prev) { + m->last = n->prev; + m->next = MDOC_NEXT_SIBLING; + } else { + m->last = n->parent; + m->next = MDOC_NEXT_CHILD; + } + } + + if (m && m->first == n) + m->first = NULL; +} + + void -mdoc_node_freelist(struct mdoc_node *p) +mdoc_node_delete(struct mdoc *m, struct mdoc_node *p) { - if (p->child) - mdoc_node_freelist(p->child); - if (p->next) - mdoc_node_freelist(p->next); + while (p->child) { + assert(p->nchild); + mdoc_node_delete(m, p->child); + } + assert(0 == p->nchild); + mdoc_node_unlink(m, p); mdoc_node_free(p); } @@ -482,83 +631,180 @@ mdoc_node_freelist(struct mdoc_node *p) * control character. */ static int -parsetext(struct mdoc *mdoc, int line, char *buf) +mdoc_ptext(struct mdoc *m, int line, char *buf, int offs) { + int i; - if (SEC_PROLOGUE == mdoc->lastnamed) - return(mdoc_perr(mdoc, line, 0, - "text disallowed in prologue")); + /* Ignore bogus comments. */ - if ( ! mdoc_word_alloc(mdoc, line, 0, buf)) + if ('\\' == buf[offs] && + '.' == buf[offs + 1] && + '"' == buf[offs + 2]) + return(mdoc_pwarn(m, line, offs, EBADCOMMENT)); + + /* No text before an initial macro. */ + + if (SEC_NONE == m->lastnamed) + return(mdoc_perr(m, line, offs, ETEXTPROL)); + + /* Literal just gets pulled in as-is. */ + + if (MDOC_LITERAL & m->flags) + return(mdoc_word_alloc(m, line, offs, buf + offs)); + + /* Check for a blank line, which may also consist of spaces. */ + + for (i = offs; ' ' == buf[i]; i++) + /* Skip to first non-space. */ ; + + if ('\0' == buf[i]) { + if ( ! mdoc_pwarn(m, line, offs, ENOBLANK)) + return(0); + + /* + * Insert a `Pp' in the case of a blank line. Technically, + * blank lines aren't allowed, but enough manuals assume this + * behaviour that we want to work around it. + */ + if ( ! mdoc_elem_alloc(m, line, offs, MDOC_Pp, NULL)) + return(0); + + m->next = MDOC_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]) + if ( ! mdoc_pwarn(m, line, i - 1, ETAILWS)) + return(0); + + for (--i; i && ' ' == buf[i]; i--) + /* Spin back to non-space. */ ; + + /* Jump ahead of escaped whitespace. */ + i += '\\' == buf[i] ? 2 : 1; + + buf[i] = '\0'; + } + + /* Allocate the whole word. */ + + if ( ! mdoc_word_alloc(m, line, offs, buf + offs)) return(0); - mdoc->next = MDOC_NEXT_SIBLING; + /* + * 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)) + m->last->flags |= MDOC_EOS; + return(1); } static int -macrowarn(struct mdoc *m, int ln, const char *buf) +macrowarn(struct mdoc *m, int ln, const char *buf, int offs) { if ( ! (MDOC_IGN_MACRO & m->pflags)) - return(mdoc_perr(m, ln, 1, "unknown macro: %s%s", + return(mdoc_verr(m, ln, offs, "unknown macro: %s%s", buf, strlen(buf) > 3 ? "..." : "")); - return(mdoc_pwarn(m, ln, 1, WARN_SYNTAX, - "unknown macro: %s%s", + return(mdoc_vwarn(m, ln, offs, "unknown macro: %s%s", buf, strlen(buf) > 3 ? "..." : "")); } - /* * Parse a macro line, that is, a line beginning with the control * character. */ int -parsemacro(struct mdoc *m, int ln, char *buf) +mdoc_pmacro(struct mdoc *m, int ln, char *buf, int offs) { - int i, c; - char mac[5]; + enum mdoct tok; + int i, j, sv; + char mac[5]; - /* Comments are quickly ignored. */ + /* Empty lines are ignored. */ - if (buf[1] && '\\' == buf[1]) - if (buf[2] && '\"' == buf[2]) + offs++; + + if ('\0' == buf[offs]) + return(1); + + i = offs; + + /* Accept whitespace after the initial control char. */ + + if (' ' == buf[i]) { + i++; + while (buf[i] && ' ' == buf[i]) + i++; + if ('\0' == buf[i]) return(1); + } + sv = 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 (isspace((unsigned char)buf[i])) + else if (' ' == buf[i]) break; - } - /* FIXME: be able to skip unknown macro lines! */ + /* Check for invalid characters. */ - mac[i - 1] = 0; + if (isgraph((u_char)buf[i])) + continue; + return(mdoc_perr(m, ln, i, EPRINT)); + } - if (i == 5 || i <= 2) { - if ( ! macrowarn(m, ln, mac)) + mac[j] = '\0'; + + if (j == 4 || j < 2) { + if ( ! macrowarn(m, ln, mac, sv)) goto err; return(1); } - if (MDOC_MAX == (c = mdoc_tokhash_find(m->htab, mac))) { - if ( ! macrowarn(m, ln, mac)) + if (MDOC_MAX == (tok = mdoc_hash_find(mac))) { + if ( ! macrowarn(m, ln, mac, sv)) goto err; return(1); } /* The macro is sane. Jump to the next word. */ - while (buf[i] && isspace((unsigned char)buf[i])) + while (buf[i] && ' ' == buf[i]) i++; - /* Begin recursive parse sequence. */ + /* + * Trailing whitespace. Note that tabs are allowed to be passed + * into the parser as "text", so we only warn about spaces here. + */ - if ( ! mdoc_macro(m, c, ln, 1, &i, buf)) + if ('\0' == buf[i] && ' ' == buf[i - 1]) + if ( ! mdoc_pwarn(m, ln, i - 1, ETAILWS)) + goto err; + + /* + * Begin recursive parse sequence. Since we're at the start of + * the line, we don't need to do callable/parseable checks. + */ + if ( ! mdoc_macro(m, tok, ln, sv, &i, buf)) goto err; return(1); @@ -568,3 +814,5 @@ err: /* Error out. */ m->flags |= MDOC_HALT; return(0); } + +