/* $Id: mdoc.c,v 1.40 2010/04/07 23:15:05 schwarze Exp $ */ /* * 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. * * 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. */ #include #include #include #include #include #include #include #include #include "libmdoc.h" #include "libmandoc.h" 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 section", /* EBADSEC */ "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 */ }; const char *const __mdoc_macronames[MDOC_MAX] = { "Ap", "Dd", "Dt", "Os", "Sh", "Ss", "Pp", "D1", "Dl", "Bd", "Ed", "Bl", "El", "It", "Ad", "An", "Ar", "Cd", "Cm", "Dv", "Er", "Ev", "Ex", "Fa", "Fd", "Fl", "Fn", "Ft", "Ic", "In", "Li", "Nd", "Nm", "Op", "Ot", "Pa", "Rv", "St", "Va", "Vt", /* LINTED */ "Xr", "%A", "%B", "%D", /* LINTED */ "%I", "%J", "%N", "%O", /* LINTED */ "%P", "%R", "%T", "%V", "Ac", "Ao", "Aq", "At", "Bc", "Bf", "Bo", "Bq", "Bsx", "Bx", "Db", "Dc", "Do", "Dq", "Ec", "Ef", "Em", "Eo", "Fx", "Ms", "No", "Ns", "Nx", "Ox", "Pc", "Pf", "Po", "Pq", "Qc", "Ql", "Qo", "Qq", "Re", "Rs", "Sc", "So", "Sq", "Sm", "Sx", "Sy", "Tn", "Ux", "Xc", "Xo", "Fo", "Fc", "Oo", "Oc", "Bk", "Ek", "Bt", "Hf", "Fr", "Ud", "Lb", "Lp", "Lk", "Mt", "Brq", "Bro", /* LINTED */ "Brc", "%C", "Es", "En", /* LINTED */ "Dx", "%Q", "br", "sp", /* LINTED */ "%U", "eos" }; const char *const __mdoc_argnames[MDOC_ARG_MAX] = { "split", "nosplit", "ragged", "unfilled", "literal", "file", "offset", "bullet", "dash", "hyphen", "item", "enum", "tag", "diag", "hang", "ohang", "inset", "column", "width", "compact", "std", "filled", "words", "emphasis", "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 parsetext(struct mdoc *, int, char *); static int parsemacro(struct mdoc *, int, char *); static int macrowarn(struct mdoc *, int, const char *); static int pstring(struct mdoc *, int, int, const char *, size_t); const struct mdoc_node * mdoc_node(const struct mdoc *m) { return(MDOC_HALT & m->flags ? NULL : m->first); } const struct mdoc_meta * mdoc_meta(const struct mdoc *m) { return(MDOC_HALT & m->flags ? NULL : &m->meta); } /* * Frees volatile resources (parse tree, meta-data, fields). */ static void mdoc_free1(struct mdoc *mdoc) { if (mdoc->first) mdoc_node_delete(mdoc, mdoc->first); if (mdoc->meta.title) free(mdoc->meta.title); if (mdoc->meta.os) free(mdoc->meta.os); if (mdoc->meta.name) free(mdoc->meta.name); if (mdoc->meta.arch) free(mdoc->meta.arch); if (mdoc->meta.vol) free(mdoc->meta.vol); } /* * 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 = mandoc_calloc(1, sizeof(struct mdoc)); if (cb) memcpy(&p->cb, cb, sizeof(struct mdoc_cb)); p->data = data; p->pflags = pflags; 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 *m) { if (MDOC_HALT & m->flags) return(0); else if (mdoc_macroend(m)) return(1); m->flags |= MDOC_HALT; return(0); } /* * Main parse routine. Parses a single line -- really just hands off to * the macro (parsemacro()) or text parser (parsetext()). */ int mdoc_parseln(struct mdoc *m, int ln, char *buf) { if (MDOC_HALT & m->flags) return(0); return('.' == *buf ? parsemacro(m, ln, buf) : parsetext(m, ln, buf)); } int mdoc_verr(struct mdoc *mdoc, int ln, int pos, const char *fmt, ...) { char buf[256]; va_list ap; if (NULL == mdoc->cb.mdoc_err) return(0); 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, const char *fmt, ...) { char buf[256]; va_list ap; if (NULL == mdoc->cb.mdoc_warn) return(0); va_start(ap, fmt); (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap); va_end(ap); return((*mdoc->cb.mdoc_warn)(mdoc->data, ln, pos, buf)); } int 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); /* * If we're in the prologue, deny "body" macros. Similarly, if * we're in the body, deny prologue calls. */ if (MDOC_PROLOGUE & mdoc_macros[tok].flags && MDOC_PBODY & m->flags) return(mdoc_perr(m, ln, pp, EPROLBODY)); if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) && ! (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; } return((*mdoc_macros[tok].fp)(m, tok, ln, pp, pos, buf)); } static int node_append(struct mdoc *mdoc, struct mdoc_node *p) { assert(mdoc->last); assert(mdoc->first); assert(MDOC_ROOT != p->type); switch (mdoc->next) { case (MDOC_NEXT_SIBLING): mdoc->last->next = p; p->prev = mdoc->last; p->parent = mdoc->last->parent; break; case (MDOC_NEXT_CHILD): mdoc->last->child = p; p->parent = mdoc->last; break; default: abort(); /* 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): assert(MDOC_BLOCK == p->parent->type); p->parent->head = p; break; case (MDOC_TAIL): assert(MDOC_BLOCK == p->parent->type); p->parent->tail = p; break; case (MDOC_BODY): assert(MDOC_BLOCK == p->parent->type); p->parent->body = p; break; default: break; } 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 * node_alloc(struct mdoc *m, int line, int pos, enum mdoct tok, enum mdoc_type type) { struct mdoc_node *p; p = mandoc_calloc(1, sizeof(struct mdoc_node)); p->sec = m->lastsec; p->line = line; p->pos = pos; p->tok = tok; p->type = type; return(p); } int mdoc_tail_alloc(struct mdoc *m, int line, int pos, enum mdoct tok) { struct mdoc_node *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_head_alloc(struct mdoc *m, int line, int pos, enum mdoct tok) { struct mdoc_node *p; assert(m->first); assert(m->last); 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_body_alloc(struct mdoc *m, int line, int pos, enum mdoct tok) { struct mdoc_node *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 *m, int line, int pos, enum mdoct tok, struct mdoc_arg *args) { struct mdoc_node *p; p = node_alloc(m, line, pos, tok, MDOC_BLOCK); p->args = args; if (p->args) (args->refcnt)++; if ( ! node_append(m, p)) return(0); m->next = MDOC_NEXT_CHILD; return(1); } int mdoc_elem_alloc(struct mdoc *m, int line, int pos, enum mdoct tok, struct mdoc_arg *args) { struct mdoc_node *p; p = node_alloc(m, line, pos, tok, MDOC_ELEM); p->args = args; if (p->args) (args->refcnt)++; if ( ! node_append(m, p)) return(0); m->next = MDOC_NEXT_CHILD; return(1); } static int pstring(struct mdoc *m, int line, int pos, const char *p, size_t len) { struct mdoc_node *n; size_t sv; n = node_alloc(m, line, pos, -1, MDOC_TEXT); n->string = mandoc_malloc(len + 1); sv = strlcpy(n->string, p, len + 1); /* Prohibit truncation. */ assert(sv < len + 1); if ( ! node_append(m, n)) return(0); m->next = MDOC_NEXT_SIBLING; return(1); } int mdoc_word_alloc(struct mdoc *m, int line, int pos, const char *p) { return(pstring(m, line, pos, p, strlen(p))); } void mdoc_node_free(struct mdoc_node *p) { if (p->string) free(p->string); if (p->args) mdoc_argv_free(p->args); free(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_delete(struct mdoc *m, struct mdoc_node *p) { 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); } /* * Parse free-form text, that is, a line that does not begin with the * control character. */ static int parsetext(struct mdoc *m, int line, char *buf) { int i, j; char sv; if (SEC_NONE == m->lastnamed) return(mdoc_perr(m, line, 0, ETEXTPROL)); /* * If in literal mode, then pass the buffer directly to the * back-end, as it should be preserved as a single term. */ if (MDOC_LITERAL & m->flags) return(mdoc_word_alloc(m, line, 0, buf)); /* Disallow blank/white-space lines in non-literal mode. */ for (i = 0; ' ' == buf[i]; i++) /* Skip leading whitespace. */ ; if ('\0' == buf[i]) { if ( ! mdoc_pwarn(m, line, 0, ENOBLANK)) return(0); /* * Assume that a `Pp' should be inserted 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, 0, MDOC_Pp, NULL)) return(0); } /* * Break apart a free-form line into tokens. Spaces are * stripped out of the input. */ 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 ( ! mdoc_pwarn(m, line, i - 1, ETAILWS)) return(0); for ( ; ' ' == buf[i]; i++) /* Skip trailing whitespace. */ ; j = i; /* Trailing whitespace? */ if (' ' == buf[i - 1] && '\0' == buf[i]) if ( ! mdoc_pwarn(m, line, i - 1, ETAILWS)) return(0); if ('\0' == buf[i]) break; } if (j != i && ! pstring(m, line, j, &buf[j], (size_t)(i - j))) return(0); /* * Mark the end of a sentence. Only works when you respect * Jason's rule: "new sentence, new line". */ if ('.' == buf[i-1] || '!' == buf[i-1] || '?' == buf[i-1]) { m->next = MDOC_NEXT_SIBLING; if ( ! mdoc_elem_alloc(m, line, i, MDOC_eos, NULL)) return(0); } m->next = MDOC_NEXT_SIBLING; return(1); } static int macrowarn(struct mdoc *m, int ln, const char *buf) { if ( ! (MDOC_IGN_MACRO & m->pflags)) return(mdoc_verr(m, ln, 0, "unknown macro: %s%s", buf, strlen(buf) > 3 ? "..." : "")); return(mdoc_vwarn(m, ln, 0, "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) { int i, j, c; char mac[5]; struct mdoc_node *n; char *t; /* Empty lines are ignored. */ if ('\0' == buf[1]) return(1); i = 1; /* Accept whitespace after the initial control char. */ if (' ' == buf[i]) { i++; while (buf[i] && ' ' == buf[i]) i++; if ('\0' == buf[i]) return(1); } /* Copy the first word into a nil-terminated buffer. */ 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(mdoc_perr(m, ln, i, EPRINT)); } mac[j] = 0; if (j == 4 || j < 2) { if ( ! macrowarn(m, ln, mac)) goto err; return(1); } if (MDOC_MAX == (c = mdoc_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++; /* Trailing whitespace? */ 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, c, ln, 1, &i, buf)) goto err; /* * Mark the end of a sentence, but be careful not to insert * markers into reference blocks. */ n = m->last; if (n->child) n = n->child; while (n->next) n = n->next; if (MDOC_TEXT == n->type && m->last->parent->tok != MDOC_Rs) { t = n->string; while (t[0] && t[1]) t++; if ('.' == *t || '!' == *t || '?' == *t) { if ( ! mdoc_elem_alloc(m, ln, i, MDOC_eos, NULL)) return(0); m->next = MDOC_NEXT_SIBLING; } } return(1); err: /* Error out. */ m->flags |= MDOC_HALT; return(0); }