=================================================================== RCS file: /cvs/mandoc/mdoc.c,v retrieving revision 1.84 retrieving revision 1.242 diff -u -p -r1.84 -r1.242 --- mandoc/mdoc.c 2009/06/17 07:59:47 1.84 +++ mandoc/mdoc.c 2015/04/18 16:06:40 1.242 @@ -1,39 +1,40 @@ -/* $Id: mdoc.c,v 1.84 2009/06/17 07:59:47 kristaps Exp $ */ +/* $Id: mdoc.c,v 1.242 2015/04/18 16:06:40 schwarze Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons + * Copyright (c) 2010, 2012-2015 Ingo Schwarze * * 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 + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF - * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS 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 "config.h" + +#include + #include #include #include #include #include #include +#include +#include "mandoc_aux.h" +#include "mandoc.h" +#include "roff.h" +#include "mdoc.h" +#include "libmandoc.h" #include "libmdoc.h" -enum merr { - ENOCALL, - EBODYPROL, - EPROLBODY, - ESPACE, - ETEXTPROL, - ENOBLANK, - EMALLOC -}; - -const char *const __mdoc_macronames[MDOC_MAX] = { +const char *const __mdoc_macronames[MDOC_MAX + 1] = { "Ap", "Dd", "Dt", "Os", "Sh", "Ss", "Pp", "D1", "Dl", "Bd", "Ed", "Bl", @@ -44,12 +45,9 @@ const char *const __mdoc_macronames[MDOC_MAX] = { "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", + "Xr", "%A", "%B", "%D", + "%I", "%J", "%N", "%O", + "%P", "%R", "%T", "%V", "Ac", "Ao", "Aq", "At", "Bc", "Bf", "Bo", "Bq", "Bsx", "Bx", "Db", "Dc", @@ -65,367 +63,234 @@ const char *const __mdoc_macronames[MDOC_MAX] = { "Bk", "Ek", "Bt", "Hf", "Fr", "Ud", "Lb", "Lp", "Lk", "Mt", "Brq", "Bro", - /* LINTED */ - "Brc", "\%C", "Es", "En", - /* LINTED */ - "Dx", "\%Q" + "Brc", "%C", "Es", "En", + "Dx", "%Q", "br", "sp", + "%U", "Ta", "ll", "text", }; -const char *const __mdoc_argnames[MDOC_ARG_MAX] = { +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", + "unfilled", "literal", "file", + "offset", "bullet", "dash", + "hyphen", "item", "enum", + "tag", "diag", "hang", + "ohang", "inset", "column", + "width", "compact", "std", "filled", "words", "emphasis", - "symbolic", "nested" + "symbolic", "nested", "centered" }; const char * const *mdoc_macronames = __mdoc_macronames; const char * const *mdoc_argnames = __mdoc_argnames; -static void mdoc_free1(struct mdoc *); -static int mdoc_alloc1(struct mdoc *); -static struct mdoc_node *node_alloc(struct mdoc *, int, int, - int, 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 perr(struct mdoc *, int, int, enum merr); +static void mdoc_node_free(struct roff_node *); +static void mdoc_node_unlink(struct roff_man *, + struct roff_node *); +static void mdoc_free1(struct roff_man *); +static void mdoc_alloc1(struct roff_man *); +static struct roff_node *node_alloc(struct roff_man *, int, int, + int, enum roff_type); +static void node_append(struct roff_man *, struct roff_node *); +static int mdoc_ptext(struct roff_man *, int, char *, int); +static int mdoc_pmacro(struct roff_man *, int, char *, int); -const struct mdoc_node * -mdoc_node(const struct mdoc *m) + +const struct roff_node * +mdoc_node(const struct roff_man *mdoc) { - return(MDOC_HALT & m->flags ? NULL : m->first); + return(mdoc->first); } - -const struct mdoc_meta * -mdoc_meta(const struct mdoc *m) +const struct roff_meta * +mdoc_meta(const struct roff_man *mdoc) { - return(MDOC_HALT & m->flags ? NULL : &m->meta); + return(&mdoc->meta); } - +/* + * Frees volatile resources (parse tree, meta-data, fields). + */ static void -mdoc_free1(struct mdoc *mdoc) +mdoc_free1(struct roff_man *mdoc) { if (mdoc->first) - mdoc_node_freelist(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); + mdoc_node_delete(mdoc, mdoc->first); + free(mdoc->meta.msec); + free(mdoc->meta.vol); + free(mdoc->meta.arch); + free(mdoc->meta.date); + free(mdoc->meta.title); + free(mdoc->meta.os); + free(mdoc->meta.name); } - -static int -mdoc_alloc1(struct mdoc *mdoc) +/* + * Allocate all volatile resources (parse tree, meta-data, fields). + */ +static void +mdoc_alloc1(struct roff_man *mdoc) { - bzero(&mdoc->meta, sizeof(struct mdoc_meta)); + memset(&mdoc->meta, 0, sizeof(mdoc->meta)); mdoc->flags = 0; - mdoc->lastnamed = mdoc->lastsec = 0; - mdoc->last = calloc(1, sizeof(struct mdoc_node)); - if (NULL == mdoc->last) - return(0); - + mdoc->lastnamed = mdoc->lastsec = SEC_NONE; + mdoc->last = mandoc_calloc(1, sizeof(*mdoc->last)); mdoc->first = mdoc->last; - mdoc->last->type = MDOC_ROOT; - mdoc->next = MDOC_NEXT_CHILD; - return(1); + mdoc->last->type = ROFFT_ROOT; + mdoc->last->tok = MDOC_MAX; + mdoc->next = ROFF_NEXT_CHILD; } - /* - * Free up all resources contributed by a parse: the node tree, - * meta-data and so on. Then reallocate the root node for another - * parse. + * 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. */ -int -mdoc_reset(struct mdoc *mdoc) +void +mdoc_reset(struct roff_man *mdoc) { mdoc_free1(mdoc); - return(mdoc_alloc1(mdoc)); + mdoc_alloc1(mdoc); } - /* - * Completely free up all resources. + * 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_free(struct roff_man *mdoc) { mdoc_free1(mdoc); - if (mdoc->htab) - mdoc_hash_free(mdoc->htab); free(mdoc); } - -struct mdoc * -mdoc_alloc(void *data, int pflags, const struct mdoc_cb *cb) -{ - struct mdoc *p; - - if (NULL == (p = calloc(1, sizeof(struct mdoc)))) - return(NULL); - if (cb) - (void)memcpy(&p->cb, cb, sizeof(struct mdoc_cb)); - - p->data = data; - p->pflags = pflags; - - if (NULL == (p->htab = mdoc_hash_alloc())) { - free(p); - return(NULL); - } else if (mdoc_alloc1(p)) - return(p); - - free(p); - return(NULL); -} - - /* - * Climb back up the parse tree, validating open scopes. Mostly calls - * through to macro_end in macro.c. + * Allocate volatile and non-volatile parse resources. */ -int -mdoc_endparse(struct mdoc *m) +struct roff_man * +mdoc_alloc(struct roff *roff, struct mparse *parse, + const char *defos, int quick) { + struct roff_man *p; - if (MDOC_HALT & m->flags) - return(0); - else if (mdoc_macroend(m)) - return(1); - m->flags |= MDOC_HALT; - return(0); -} + p = mandoc_calloc(1, sizeof(*p)); + p->parse = parse; + p->defos = defos; + p->quick = quick; + p->roff = roff; -/* - * Main parse routine. Parses a single line -- really just hands off to - * the macro or text parser. - */ -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)); + mdoc_hash_init(); + mdoc_alloc1(p); + return(p); } - -int -mdoc_verr(struct mdoc *mdoc, int ln, int pos, - const char *fmt, ...) +void +mdoc_endparse(struct roff_man *mdoc) { - 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)); + mdoc_macroend(mdoc); } - -int -mdoc_vwarn(struct mdoc *mdoc, int ln, int pos, - enum mdoc_warn type, const char *fmt, ...) +void +mdoc_addeqn(struct roff_man *mdoc, const struct eqn *ep) { - char buf[256]; - va_list ap; + struct roff_node *n; - 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, type, buf)); + n = node_alloc(mdoc, ep->ln, ep->pos, MDOC_MAX, ROFFT_EQN); + n->eqn = ep; + if (ep->ln > mdoc->last->line) + n->flags |= MDOC_LINE; + node_append(mdoc, n); + mdoc->next = ROFF_NEXT_SIBLING; } - -int -mdoc_nerr(struct mdoc *mdoc, const struct mdoc_node *node, - const char *fmt, ...) +void +mdoc_addspan(struct roff_man *mdoc, const struct tbl_span *sp) { - char buf[256]; - va_list ap; + struct roff_node *n; - 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, - node->line, node->pos, buf)); + n = node_alloc(mdoc, sp->line, 0, MDOC_MAX, ROFFT_TBL); + n->span = sp; + node_append(mdoc, n); + mdoc->next = ROFF_NEXT_SIBLING; } - +/* + * Main parse routine. Parses a single line -- really just hands off to + * the macro (mdoc_pmacro()) or text parser (mdoc_ptext()). + */ int -mdoc_warn(struct mdoc *mdoc, enum mdoc_warn type, - const char *fmt, ...) +mdoc_parseln(struct roff_man *mdoc, int ln, char *buf, int offs) { - char buf[256]; - va_list ap; - if (NULL == mdoc->cb.mdoc_warn) - return(0); + if (mdoc->last->type != ROFFT_EQN || ln > mdoc->last->line) + mdoc->flags |= MDOC_NEWLINE; - va_start(ap, fmt); - (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap); - va_end(ap); - return((*mdoc->cb.mdoc_warn)(mdoc->data, mdoc->last->line, - mdoc->last->pos, type, buf)); -} + /* + * Let the roff nS register switch SYNOPSIS mode early, + * such that the parser knows at all times + * whether this mode is on or off. + * Note that this mode is also switched by the Sh macro. + */ + if (roff_getreg(mdoc->roff, "nS")) + mdoc->flags |= MDOC_SYNOPSIS; + else + mdoc->flags &= ~MDOC_SYNOPSIS; - -int -mdoc_err(struct mdoc *mdoc, 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, mdoc->last->line, - mdoc->last->pos, buf)); + return(roff_getcontrol(mdoc->roff, buf, &offs) ? + mdoc_pmacro(mdoc, ln, buf, offs) : + mdoc_ptext(mdoc, ln, buf, offs)); } - -int -mdoc_pwarn(struct mdoc *mdoc, int line, int pos, enum mdoc_warn type, - const char *fmt, ...) +void +mdoc_macro(MACRO_PROT_ARGS) { - char buf[256]; - va_list ap; + assert(tok < MDOC_MAX); - 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, - line, pos, type, buf)); -} - -int -mdoc_perr(struct mdoc *mdoc, int line, 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, line, pos, buf)); -} - - -int -mdoc_macro(struct mdoc *m, int tok, - int ln, int pp, int *pos, char *buf) -{ - - /* FIXME - these should happen during validation. */ - - if (MDOC_PROLOGUE & mdoc_macros[tok].flags && - SEC_PROLOGUE != m->lastnamed) - return(perr(m, ln, pp, EPROLBODY)); - - if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) && - SEC_PROLOGUE == m->lastnamed) - return(perr(m, ln, pp, EBODYPROL)); - - if (1 != pp && ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) - return(perr(m, ln, pp, ENOCALL)); - - return((*mdoc_macros[tok].fp)(m, tok, ln, pp, pos, buf)); -} - - -static int -perr(struct mdoc *m, int line, int pos, enum merr type) -{ - char *p; - - p = NULL; - switch (type) { - case (ENOCALL): - p = "not callable"; - break; - case (EPROLBODY): - p = "macro disallowed in document body"; - break; - case (EBODYPROL): - p = "macro disallowed in document prologue"; - break; - case (EMALLOC): - p = "memory exhausted"; - break; - case (ETEXTPROL): - p = "text disallowed in document prologue"; - break; - case (ENOBLANK): - p = "blank lines disallowed in non-literal contexts"; - break; - case (ESPACE): - p = "whitespace disallowed after delimiter"; - break; + if (mdoc->flags & MDOC_PBODY) { + if (tok == MDOC_Dt) { + mandoc_vmsg(MANDOCERR_DT_LATE, + mdoc->parse, line, ppos, + "Dt %s", buf + *pos); + return; + } + } else if ( ! (mdoc_macros[tok].flags & MDOC_PROLOGUE)) { + if (mdoc->meta.title == NULL) { + mandoc_vmsg(MANDOCERR_DT_NOTITLE, + mdoc->parse, line, ppos, "%s %s", + mdoc_macronames[tok], buf + *pos); + mdoc->meta.title = mandoc_strdup("UNTITLED"); + } + if (NULL == mdoc->meta.vol) + mdoc->meta.vol = mandoc_strdup("LOCAL"); + mdoc->flags |= MDOC_PBODY; } - assert(p); - return(mdoc_perr(m, line, pos, p)); + (*mdoc_macros[tok].fp)(mdoc, tok, line, ppos, pos, buf); } -static int -node_append(struct mdoc *mdoc, struct mdoc_node *p) +static void +node_append(struct roff_man *mdoc, struct roff_node *p) { assert(mdoc->last); assert(mdoc->first); - assert(MDOC_ROOT != p->type); + assert(p->type != ROFFT_ROOT); switch (mdoc->next) { - case (MDOC_NEXT_SIBLING): + case ROFF_NEXT_SIBLING: mdoc->last->next = p; p->prev = mdoc->last; p->parent = mdoc->last->parent; break; - case (MDOC_NEXT_CHILD): + case ROFF_NEXT_CHILD: mdoc->last->child = p; p->parent = mdoc->last; break; @@ -434,22 +299,42 @@ node_append(struct mdoc *mdoc, struct mdoc_node *p) /* NOTREACHED */ } - if ( ! mdoc_valid_pre(mdoc, p)) - return(0); - if ( ! mdoc_action_pre(mdoc, p)) - return(0); + p->parent->nchild++; + /* + * Copy over the normalised-data pointer of our parent. Not + * everybody has one, but copying a null pointer is fine. + */ + switch (p->type) { - case (MDOC_HEAD): - assert(MDOC_BLOCK == p->parent->type); + case ROFFT_BODY: + if (ENDBODY_NOT != p->end) + break; + /* FALLTHROUGH */ + case ROFFT_TAIL: + /* FALLTHROUGH */ + case ROFFT_HEAD: + p->norm = p->parent->norm; + break; + default: + break; + } + + mdoc_valid_pre(mdoc, p); + + switch (p->type) { + case ROFFT_HEAD: + assert(p->parent->type == ROFFT_BLOCK); p->parent->head = p; break; - case (MDOC_TAIL): - assert(MDOC_BLOCK == p->parent->type); + case ROFFT_TAIL: + assert(p->parent->type == ROFFT_BLOCK); p->parent->tail = p; break; - case (MDOC_BODY): - assert(MDOC_BLOCK == p->parent->type); + case ROFFT_BODY: + if (p->end) + break; + assert(p->parent->type == ROFFT_BLOCK); p->parent->body = p; break; default: @@ -459,136 +344,178 @@ node_append(struct mdoc *mdoc, struct mdoc_node *p) mdoc->last = p; switch (p->type) { - case (MDOC_TEXT): - if ( ! mdoc_valid_post(mdoc)) - return(0); - if ( ! mdoc_action_post(mdoc)) - return(0); + case ROFFT_TBL: + /* FALLTHROUGH */ + case ROFFT_TEXT: + mdoc_valid_post(mdoc); break; default: break; } - - return(1); } - -static struct mdoc_node * -node_alloc(struct mdoc *mdoc, int line, - int pos, int tok, enum mdoc_type type) +static struct roff_node * +node_alloc(struct roff_man *mdoc, int line, int pos, + int tok, enum roff_type type) { - struct mdoc_node *p; + struct roff_node *p; - if (NULL == (p = calloc(1, sizeof(struct mdoc_node)))) { - (void)perr(mdoc, (mdoc)->last->line, - (mdoc)->last->pos, EMALLOC); - return(NULL); - } - + p = mandoc_calloc(1, sizeof(*p)); p->sec = mdoc->lastsec; p->line = line; p->pos = pos; p->tok = tok; - if (MDOC_TEXT != (p->type = type)) - assert(p->tok >= 0); + p->type = type; + /* Flag analysis. */ + + if (MDOC_SYNOPSIS & mdoc->flags) + p->flags |= MDOC_SYNPRETTY; + else + p->flags &= ~MDOC_SYNPRETTY; + if (MDOC_NEWLINE & mdoc->flags) + p->flags |= MDOC_LINE; + mdoc->flags &= ~MDOC_NEWLINE; + return(p); } - -int -mdoc_tail_alloc(struct mdoc *mdoc, int line, int pos, int tok) +void +mdoc_tail_alloc(struct roff_man *mdoc, int line, int pos, int tok) { - struct mdoc_node *p; + struct roff_node *p; - p = node_alloc(mdoc, line, pos, tok, MDOC_TAIL); - if (NULL == p) - return(0); - return(node_append(mdoc, p)); + p = node_alloc(mdoc, line, pos, tok, ROFFT_TAIL); + node_append(mdoc, p); + mdoc->next = ROFF_NEXT_CHILD; } - -int -mdoc_head_alloc(struct mdoc *mdoc, int line, int pos, int tok) +struct roff_node * +mdoc_head_alloc(struct roff_man *mdoc, int line, int pos, int tok) { - struct mdoc_node *p; + struct roff_node *p; assert(mdoc->first); assert(mdoc->last); - - p = node_alloc(mdoc, line, pos, tok, MDOC_HEAD); - if (NULL == p) - return(0); - return(node_append(mdoc, p)); + p = node_alloc(mdoc, line, pos, tok, ROFFT_HEAD); + node_append(mdoc, p); + mdoc->next = ROFF_NEXT_CHILD; + return(p); } - -int -mdoc_body_alloc(struct mdoc *mdoc, int line, int pos, int tok) +struct roff_node * +mdoc_body_alloc(struct roff_man *mdoc, int line, int pos, int tok) { - struct mdoc_node *p; + struct roff_node *p; - p = node_alloc(mdoc, line, pos, tok, MDOC_BODY); - if (NULL == p) - return(0); - return(node_append(mdoc, p)); + p = node_alloc(mdoc, line, pos, tok, ROFFT_BODY); + node_append(mdoc, p); + mdoc->next = ROFF_NEXT_CHILD; + return(p); } +struct roff_node * +mdoc_endbody_alloc(struct roff_man *mdoc, int line, int pos, int tok, + struct roff_node *body, enum mdoc_endbody end) +{ + struct roff_node *p; -int -mdoc_block_alloc(struct mdoc *mdoc, int line, int pos, - int tok, struct mdoc_arg *args) + body->flags |= MDOC_ENDED; + body->parent->flags |= MDOC_ENDED; + p = node_alloc(mdoc, line, pos, tok, ROFFT_BODY); + p->body = body; + p->norm = body->norm; + p->end = end; + node_append(mdoc, p); + mdoc->next = ROFF_NEXT_SIBLING; + return(p); +} + +struct roff_node * +mdoc_block_alloc(struct roff_man *mdoc, int line, int pos, + int tok, struct mdoc_arg *args) { - struct mdoc_node *p; + struct roff_node *p; - p = node_alloc(mdoc, line, pos, tok, MDOC_BLOCK); - if (NULL == p) - return(0); + p = node_alloc(mdoc, line, pos, tok, ROFFT_BLOCK); p->args = args; if (p->args) (args->refcnt)++; - return(node_append(mdoc, p)); + + switch (tok) { + case MDOC_Bd: + /* FALLTHROUGH */ + case MDOC_Bf: + /* FALLTHROUGH */ + case MDOC_Bl: + /* FALLTHROUGH */ + case MDOC_En: + /* FALLTHROUGH */ + case MDOC_Rs: + p->norm = mandoc_calloc(1, sizeof(union mdoc_data)); + break; + default: + break; + } + node_append(mdoc, p); + mdoc->next = ROFF_NEXT_CHILD; + return(p); } - -int -mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos, - int tok, struct mdoc_arg *args) +void +mdoc_elem_alloc(struct roff_man *mdoc, int line, int pos, + int tok, struct mdoc_arg *args) { - struct mdoc_node *p; + struct roff_node *p; - p = node_alloc(mdoc, line, pos, tok, MDOC_ELEM); - if (NULL == p) - return(0); + p = node_alloc(mdoc, line, pos, tok, ROFFT_ELEM); p->args = args; if (p->args) (args->refcnt)++; - return(node_append(mdoc, p)); + + switch (tok) { + case MDOC_An: + p->norm = mandoc_calloc(1, sizeof(union mdoc_data)); + break; + default: + break; + } + node_append(mdoc, p); + mdoc->next = ROFF_NEXT_CHILD; } - -int -mdoc_word_alloc(struct mdoc *mdoc, - int line, int pos, const char *word) +void +mdoc_word_alloc(struct roff_man *mdoc, int line, int pos, const char *p) { - struct mdoc_node *p; + struct roff_node *n; - p = node_alloc(mdoc, line, pos, -1, MDOC_TEXT); - if (NULL == p) - return(0); - if (NULL == (p->string = strdup(word))) { - (void)perr(mdoc, (mdoc)->last->line, - (mdoc)->last->pos, EMALLOC); - return(0); - } - return(node_append(mdoc, p)); + n = node_alloc(mdoc, line, pos, MDOC_MAX, ROFFT_TEXT); + n->string = roff_strdup(mdoc->roff, p); + node_append(mdoc, n); + mdoc->next = ROFF_NEXT_SIBLING; } - void -mdoc_node_free(struct mdoc_node *p) +mdoc_word_append(struct roff_man *mdoc, const char *p) { + struct roff_node *n; + char *addstr, *newstr; + n = mdoc->last; + addstr = roff_strdup(mdoc->roff, p); + mandoc_asprintf(&newstr, "%s %s", n->string, addstr); + free(addstr); + free(n->string); + n->string = newstr; + mdoc->next = ROFF_NEXT_SIBLING; +} + +static void +mdoc_node_free(struct roff_node *p) +{ + + if (p->type == ROFFT_BLOCK || p->type == ROFFT_ELEM) + free(p->norm); if (p->string) free(p->string); if (p->args) @@ -596,116 +523,378 @@ mdoc_node_free(struct mdoc_node *p) free(p); } +static void +mdoc_node_unlink(struct roff_man *mdoc, struct roff_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; + if (n->parent->last == n) + n->parent->last = n->prev ? n->prev : NULL; + } + + /* Adjust parse point, if applicable. */ + + if (mdoc && mdoc->last == n) { + if (n->prev) { + mdoc->last = n->prev; + mdoc->next = ROFF_NEXT_SIBLING; + } else { + mdoc->last = n->parent; + mdoc->next = ROFF_NEXT_CHILD; + } + } + + if (mdoc && mdoc->first == n) + mdoc->first = NULL; +} + void -mdoc_node_freelist(struct mdoc_node *p) +mdoc_node_delete(struct roff_man *mdoc, struct roff_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(mdoc, p->child); + } + assert(0 == p->nchild); + mdoc_node_unlink(mdoc, p); mdoc_node_free(p); } +void +mdoc_node_relink(struct roff_man *mdoc, struct roff_node *p) +{ + mdoc_node_unlink(mdoc, p); + node_append(mdoc, 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) +mdoc_ptext(struct roff_man *mdoc, int line, char *buf, int offs) { + struct roff_node *n; + char *c, *ws, *end; - if (SEC_PROLOGUE == m->lastnamed) - return(perr(m, line, 0, ETEXTPROL)); + assert(mdoc->last); + n = mdoc->last; - if (0 == buf[0] && ! (MDOC_LITERAL & m->flags)) - return(perr(m, line, 0, ENOBLANK)); + /* + * Divert directly to list processing if we're encountering a + * columnar ROFFT_BLOCK with or without a prior ROFFT_BLOCK entry + * (a ROFFT_BODY means it's already open, in which case we should + * process within its context in the normal way). + */ - if ( ! mdoc_word_alloc(m, line, 0, buf)) - return(0); + if (n->tok == MDOC_Bl && n->type == ROFFT_BODY && + n->end == ENDBODY_NOT && n->norm->Bl.type == LIST_column) { + /* `Bl' is open without any children. */ + mdoc->flags |= MDOC_FREECOL; + mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf); + return(1); + } - m->next = MDOC_NEXT_SIBLING; - return(1); -} + if (n->tok == MDOC_It && n->type == ROFFT_BLOCK && + NULL != n->parent && + MDOC_Bl == n->parent->tok && + LIST_column == n->parent->norm->Bl.type) { + /* `Bl' has block-level `It' children. */ + mdoc->flags |= MDOC_FREECOL; + mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf); + return(1); + } + /* + * Search for the beginning of unescaped trailing whitespace (ws) + * and for the first character not to be output (end). + */ -static int -macrowarn(struct mdoc *m, int ln, const char *buf) -{ - if ( ! (MDOC_IGN_MACRO & m->pflags)) - return(mdoc_perr(m, ln, 1, - "unknown macro: %s%s", - buf, strlen(buf) > 3 ? "..." : "")); - return(mdoc_pwarn(m, ln, 1, WARN_SYNTAX, - "unknown macro: %s%s", - buf, strlen(buf) > 3 ? "..." : "")); -} + /* FIXME: replace with strcspn(). */ + ws = NULL; + for (c = end = buf + offs; *c; c++) { + switch (*c) { + case ' ': + if (NULL == ws) + ws = c; + continue; + case '\t': + /* + * Always warn about trailing tabs, + * even outside literal context, + * where they should be put on the next line. + */ + if (NULL == ws) + ws = c; + /* + * Strip trailing tabs in literal context only; + * outside, they affect the next line. + */ + if (MDOC_LITERAL & mdoc->flags) + continue; + break; + case '\\': + /* Skip the escaped character, too, if any. */ + if (c[1]) + c++; + /* FALLTHROUGH */ + default: + ws = NULL; + break; + } + end = c + 1; + } + *end = '\0'; + if (ws) + mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse, + line, (int)(ws-buf), NULL); + if (buf[offs] == '\0' && ! (mdoc->flags & MDOC_LITERAL)) { + mandoc_msg(MANDOCERR_FI_BLANK, mdoc->parse, + line, (int)(c - buf), NULL); + + /* + * Insert a `sp' 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. + */ + mdoc_elem_alloc(mdoc, line, offs, MDOC_sp, NULL); + mdoc->next = ROFF_NEXT_SIBLING; + mdoc_valid_post(mdoc); + return(1); + } + + mdoc_word_alloc(mdoc, line, offs, buf+offs); + + if (mdoc->flags & MDOC_LITERAL) + return(1); + + /* + * 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(buf < end); + + if (mandoc_eos(buf+offs, (size_t)(end-buf-offs))) + mdoc->last->flags |= MDOC_EOS; + return(1); +} + /* * Parse a macro line, that is, a line beginning with the control * character. */ -int -parsemacro(struct mdoc *m, int ln, char *buf) +static int +mdoc_pmacro(struct roff_man *mdoc, int ln, char *buf, int offs) { - int i, c; + struct roff_node *n; + const char *cp; + int tok; + int i, sv; char mac[5]; - /* Empty lines are ignored. */ + sv = offs; - if (0 == buf[1]) + /* + * Copy the first word into a nil-terminated buffer. + * Stop when a space, tab, escape, or eoln is encountered. + */ + + i = 0; + while (i < 4 && strchr(" \t\\", buf[offs]) == NULL) + mac[i++] = buf[offs++]; + + mac[i] = '\0'; + + tok = (i > 1 && i < 4) ? mdoc_hash_find(mac) : MDOC_MAX; + + if (tok == MDOC_MAX) { + mandoc_msg(MANDOCERR_MACRO, mdoc->parse, + ln, sv, buf + sv - 1); return(1); + } - if (' ' == buf[1]) { - i = 2; - while (buf[i] && ' ' == buf[i]) - i++; - if (0 == buf[i]) - return(1); - return(perr(m, ln, 1, ESPACE)); + /* Skip a leading escape sequence or tab. */ + + switch (buf[offs]) { + case '\\': + cp = buf + offs + 1; + mandoc_escape(&cp, NULL, NULL); + offs = cp - buf; + break; + case '\t': + offs++; + break; + default: + break; } - /* Copy the first word into a nil-terminated buffer. */ + /* Jump to the next non-whitespace word. */ - for (i = 1; i < 5; i++) { - if (0 == (mac[i - 1] = buf[i])) - break; - else if (' ' == buf[i]) - break; + 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]) + mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse, + ln, offs - 1, NULL); + + /* + * If an initial macro or a list invocation, divert directly + * into macro processing. + */ + + if (NULL == mdoc->last || MDOC_It == tok || MDOC_El == tok) { + mdoc_macro(mdoc, tok, ln, sv, &offs, buf); + return(1); } - mac[i - 1] = 0; + n = mdoc->last; + assert(mdoc->last); - if (i == 5 || i <= 2) { - if ( ! macrowarn(m, ln, mac)) - goto err; + /* + * If the first macro of a `Bl -column', open an `It' block + * context around the parsed macro. + */ + + if (n->tok == MDOC_Bl && n->type == ROFFT_BODY && + n->end == ENDBODY_NOT && n->norm->Bl.type == LIST_column) { + mdoc->flags |= MDOC_FREECOL; + mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf); return(1); - } - - if (MDOC_MAX == (c = mdoc_hash_find(m->htab, mac))) { - if ( ! macrowarn(m, ln, mac)) - goto err; + } + + /* + * If we're following a block-level `It' within a `Bl -column' + * context (perhaps opened in the above block or in ptext()), + * then open an `It' block context around the parsed macro. + */ + + if (n->tok == MDOC_It && n->type == ROFFT_BLOCK && + NULL != n->parent && + MDOC_Bl == n->parent->tok && + LIST_column == n->parent->norm->Bl.type) { + mdoc->flags |= MDOC_FREECOL; + mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf); return(1); } - /* The macro is sane. Jump to the next word. */ + /* Normal processing of a macro. */ - while (buf[i] && ' ' == buf[i]) - i++; + mdoc_macro(mdoc, tok, ln, sv, &offs, buf); - /* Begin recursive parse sequence. */ + /* In quick mode (for mandocdb), abort after the NAME section. */ - if ( ! mdoc_macro(m, c, ln, 1, &i, buf)) - goto err; + if (mdoc->quick && MDOC_Sh == tok && + SEC_NAME != mdoc->last->sec) + return(2); return(1); +} -err: /* Error out. */ +enum mdelim +mdoc_isdelim(const char *p) +{ - m->flags |= MDOC_HALT; - return(0); + if ('\0' == p[0]) + return(DELIM_NONE); + + if ('\0' == p[1]) + switch (p[0]) { + case '(': + /* FALLTHROUGH */ + case '[': + return(DELIM_OPEN); + case '|': + return(DELIM_MIDDLE); + case '.': + /* FALLTHROUGH */ + case ',': + /* FALLTHROUGH */ + case ';': + /* FALLTHROUGH */ + case ':': + /* FALLTHROUGH */ + case '?': + /* FALLTHROUGH */ + case '!': + /* FALLTHROUGH */ + case ')': + /* FALLTHROUGH */ + case ']': + return(DELIM_CLOSE); + default: + return(DELIM_NONE); + } + + if ('\\' != p[0]) + return(DELIM_NONE); + + if (0 == strcmp(p + 1, ".")) + return(DELIM_CLOSE); + if (0 == strcmp(p + 1, "fR|\\fP")) + return(DELIM_MIDDLE); + + return(DELIM_NONE); +} + +void +mdoc_deroff(char **dest, const struct roff_node *n) +{ + char *cp; + size_t sz; + + if (n->type != ROFFT_TEXT) { + for (n = n->child; n; n = n->next) + mdoc_deroff(dest, n); + return; + } + + /* Skip leading whitespace. */ + + for (cp = n->string; '\0' != *cp; cp++) + if (0 == isspace((unsigned char)*cp)) + break; + + /* Skip trailing whitespace. */ + + for (sz = strlen(cp); sz; sz--) + if (0 == isspace((unsigned char)cp[sz-1])) + break; + + /* Skip empty strings. */ + + if (0 == sz) + return; + + if (NULL == *dest) { + *dest = mandoc_strndup(cp, sz); + return; + } + + mandoc_asprintf(&cp, "%s %*s", *dest, (int)sz, cp); + free(*dest); + *dest = cp; }