=================================================================== RCS file: /cvs/mandoc/mdoc.c,v retrieving revision 1.148 retrieving revision 1.219 diff -u -p -r1.148 -r1.219 --- mandoc/mdoc.c 2010/06/26 16:07:08 1.148 +++ mandoc/mdoc.c 2014/07/07 15:03:43 1.219 @@ -1,6 +1,7 @@ -/* $Id: mdoc.c,v 1.148 2010/06/26 16:07:08 kristaps Exp $ */ +/* $Id: mdoc.c,v 1.219 2014/07/07 15:03:43 schwarze Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons + * Copyright (c) 2010, 2012, 2013, 2014 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 @@ -28,12 +29,13 @@ #include #include +#include "mdoc.h" #include "mandoc.h" -#include "regs.h" +#include "mandoc_aux.h" #include "libmdoc.h" #include "libmandoc.h" -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,11 +46,8 @@ 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", "Ac", "Ao", "Aq", "At", "Bc", "Bf", "Bo", "Bq", @@ -65,22 +64,19 @@ 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", "br", "sp", - /* LINTED */ - "%U", "Ta" + "%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", "centered" }; @@ -89,40 +85,37 @@ const char * const *mdoc_macronames = __mdoc_macroname const char * const *mdoc_argnames = __mdoc_argnames; static void mdoc_node_free(struct mdoc_node *); -static void mdoc_node_unlink(struct mdoc *, +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, +static struct mdoc_node *node_alloc(struct mdoc *, int, int, enum mdoct, enum mdoc_type); -static int node_append(struct mdoc *, +static int node_append(struct mdoc *, struct mdoc_node *); -static int mdoc_ptext(struct mdoc *, - const struct regset *, - int, char *, int); -static int mdoc_pmacro(struct mdoc *, - const struct regset *, - int, char *, int); -static int macrowarn(struct mdoc *, int, - const char *, int); +#if 0 +static int mdoc_preptext(struct mdoc *, int, char *, int); +#endif +static int mdoc_ptext(struct mdoc *, int, char *, int); +static int mdoc_pmacro(struct mdoc *, int, char *, int); const struct mdoc_node * -mdoc_node(const struct mdoc *m) +mdoc_node(const struct mdoc *mdoc) { - return(MDOC_HALT & m->flags ? NULL : m->first); + assert( ! (MDOC_HALT & mdoc->flags)); + return(mdoc->first); } - const struct mdoc_meta * -mdoc_meta(const struct mdoc *m) +mdoc_meta(const struct mdoc *mdoc) { - return(MDOC_HALT & m->flags ? NULL : &m->meta); + assert( ! (MDOC_HALT & mdoc->flags)); + return(&mdoc->meta); } - /* * Frees volatile resources (parse tree, meta-data, fields). */ @@ -144,9 +137,10 @@ mdoc_free1(struct mdoc *mdoc) free(mdoc->meta.vol); if (mdoc->meta.msec) free(mdoc->meta.msec); + if (mdoc->meta.date) + free(mdoc->meta.date); } - /* * Allocate all volatile resources (parse tree, meta-data, fields). */ @@ -160,10 +154,10 @@ mdoc_alloc1(struct mdoc *mdoc) mdoc->last = mandoc_calloc(1, sizeof(struct mdoc_node)); mdoc->first = mdoc->last; mdoc->last->type = MDOC_ROOT; + mdoc->last->tok = MDOC_MAX; 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 @@ -178,7 +172,6 @@ mdoc_reset(struct mdoc *mdoc) mdoc_alloc1(mdoc); } - /* * Completely free up all volatile and non-volatile parse resources. * After invocation, the pointer is no longer usable. @@ -191,78 +184,104 @@ mdoc_free(struct mdoc *mdoc) free(mdoc); } - /* - * Allocate volatile and non-volatile parse resources. + * Allocate volatile and non-volatile parse resources. */ struct mdoc * -mdoc_alloc(void *data, int pflags, mandocmsg msg) +mdoc_alloc(struct roff *roff, struct mparse *parse, + char *defos, int quick) { struct mdoc *p; p = mandoc_calloc(1, sizeof(struct mdoc)); - p->msg = msg; - p->data = data; - p->pflags = pflags; + p->parse = parse; + p->defos = defos; + p->quick = quick; + p->roff = roff; 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) +mdoc_endparse(struct mdoc *mdoc) { - if (MDOC_HALT & m->flags) - return(0); - else if (mdoc_macroend(m)) + assert( ! (MDOC_HALT & mdoc->flags)); + if (mdoc_macroend(mdoc)) return(1); - m->flags |= MDOC_HALT; + mdoc->flags |= MDOC_HALT; return(0); } - -/* - * Main parse routine. Parses a single line -- really just hands off to - * the macro (mdoc_pmacro()) or text parser (mdoc_ptext()). - */ int -mdoc_parseln(struct mdoc *m, const struct regset *regs, - int ln, char *buf, int offs) +mdoc_addeqn(struct mdoc *mdoc, const struct eqn *ep) { + struct mdoc_node *n; - if (MDOC_HALT & m->flags) + assert( ! (MDOC_HALT & mdoc->flags)); + + n = node_alloc(mdoc, ep->ln, ep->pos, MDOC_MAX, MDOC_EQN); + n->eqn = ep; + + if ( ! node_append(mdoc, n)) return(0); - m->flags |= MDOC_NEWLINE; - return(('.' == buf[offs] || '\'' == buf[offs]) ? - mdoc_pmacro(m, regs, ln, buf, offs) : - mdoc_ptext(m, regs, ln, buf, offs)); + mdoc->next = MDOC_NEXT_SIBLING; + return(1); } - int -mdoc_vmsg(struct mdoc *mdoc, enum mandocerr t, - int ln, int pos, const char *fmt, ...) +mdoc_addspan(struct mdoc *mdoc, const struct tbl_span *sp) { - char buf[256]; - va_list ap; + struct mdoc_node *n; - va_start(ap, fmt); - vsnprintf(buf, sizeof(buf) - 1, fmt, ap); - va_end(ap); + assert( ! (MDOC_HALT & mdoc->flags)); - return((*mdoc->msg)(t, mdoc->data, ln, pos, buf)); + n = node_alloc(mdoc, sp->line, 0, MDOC_MAX, MDOC_TBL); + n->span = sp; + + if ( ! node_append(mdoc, n)) + return(0); + + mdoc->next = MDOC_NEXT_SIBLING; + return(1); } +/* + * Main parse routine. Parses a single line -- really just hands off to + * the macro (mdoc_pmacro()) or text parser (mdoc_ptext()). + */ +int +mdoc_parseln(struct mdoc *mdoc, int ln, char *buf, int offs) +{ + assert( ! (MDOC_HALT & mdoc->flags)); + + mdoc->flags |= MDOC_NEWLINE; + + /* + * 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; + + return(roff_getcontrol(mdoc->roff, buf, &offs) ? + mdoc_pmacro(mdoc, ln, buf, offs) : + mdoc_ptext(mdoc, ln, buf, offs)); +} + int mdoc_macro(MACRO_PROT_ARGS) { @@ -270,29 +289,34 @@ mdoc_macro(MACRO_PROT_ARGS) /* If we're in the body, deny prologue calls. */ - if (MDOC_PROLOGUE & mdoc_macros[tok].flags && - MDOC_PBODY & m->flags) - return(mdoc_pmsg(m, line, ppos, MANDOCERR_BADBODY)); + if (MDOC_PROLOGUE & mdoc_macros[tok].flags && + MDOC_PBODY & mdoc->flags) { + mandoc_vmsg(MANDOCERR_PROLOG_ONLY, mdoc->parse, + line, ppos, "%s", mdoc_macronames[tok]); + return(1); + } /* If we're in the prologue, deny "body" macros. */ - if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) && - ! (MDOC_PBODY & m->flags)) { - if ( ! mdoc_pmsg(m, line, ppos, MANDOCERR_BADPROLOG)) - 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 ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) && + ! (MDOC_PBODY & mdoc->flags)) { + mandoc_vmsg(MANDOCERR_PROLOG_BAD, mdoc->parse, + line, ppos, "%s", mdoc_macronames[tok]); + if (NULL == mdoc->meta.msec) + mdoc->meta.msec = mandoc_strdup("1"); + if (NULL == mdoc->meta.title) + mdoc->meta.title = mandoc_strdup("UNKNOWN"); + if (NULL == mdoc->meta.vol) + mdoc->meta.vol = mandoc_strdup("LOCAL"); + if (NULL == mdoc->meta.os) + mdoc->meta.os = mandoc_strdup("LOCAL"); + if (NULL == mdoc->meta.date) + mdoc->meta.date = mandoc_normdate + (mdoc->parse, NULL, line, ppos); + mdoc->flags |= MDOC_PBODY; } - return((*mdoc_macros[tok].fp) - (m, regs, tok, line, ppos, pos, buf)); + return((*mdoc_macros[tok].fp)(mdoc, tok, line, ppos, pos, buf)); } @@ -305,12 +329,12 @@ node_append(struct mdoc *mdoc, struct mdoc_node *p) assert(MDOC_ROOT != p->type); switch (mdoc->next) { - case (MDOC_NEXT_SIBLING): + case MDOC_NEXT_SIBLING: mdoc->last->next = p; p->prev = mdoc->last; p->parent = mdoc->last->parent; break; - case (MDOC_NEXT_CHILD): + case MDOC_NEXT_CHILD: mdoc->last->child = p; p->parent = mdoc->last; break; @@ -321,21 +345,40 @@ node_append(struct mdoc *mdoc, struct mdoc_node *p) 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_BODY: + if (ENDBODY_NOT != p->end) + break; + /* FALLTHROUGH */ + case MDOC_TAIL: + /* FALLTHROUGH */ + case MDOC_HEAD: + p->norm = p->parent->norm; + break; + default: + break; + } + if ( ! mdoc_valid_pre(mdoc, p)) return(0); - if ( ! mdoc_action_pre(mdoc, p)) - return(0); switch (p->type) { - case (MDOC_HEAD): + case MDOC_HEAD: assert(MDOC_BLOCK == p->parent->type); p->parent->head = p; break; - case (MDOC_TAIL): + case MDOC_TAIL: assert(MDOC_BLOCK == p->parent->type); p->parent->tail = p; break; - case (MDOC_BODY): + case MDOC_BODY: + if (p->end) + break; assert(MDOC_BLOCK == p->parent->type); p->parent->body = p; break; @@ -346,11 +389,11 @@ node_append(struct mdoc *mdoc, struct mdoc_node *p) mdoc->last = p; switch (p->type) { - case (MDOC_TEXT): + case MDOC_TBL: + /* FALLTHROUGH */ + case MDOC_TEXT: if ( ! mdoc_valid_post(mdoc)) return(0); - if ( ! mdoc_action_post(mdoc)) - return(0); break; default: break; @@ -359,129 +402,182 @@ node_append(struct mdoc *mdoc, struct mdoc_node *p) return(1); } - static struct mdoc_node * -node_alloc(struct mdoc *m, int line, int pos, +node_alloc(struct mdoc *mdoc, 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->sec = mdoc->lastsec; p->line = line; p->pos = pos; + p->lastline = line; p->tok = tok; p->type = type; - if (MDOC_NEWLINE & m->flags) + + /* 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; - m->flags &= ~MDOC_NEWLINE; + mdoc->flags &= ~MDOC_NEWLINE; + return(p); } - int -mdoc_tail_alloc(struct mdoc *m, int line, int pos, enum mdoct tok) +mdoc_tail_alloc(struct mdoc *mdoc, 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)) + p = node_alloc(mdoc, line, pos, tok, MDOC_TAIL); + if ( ! node_append(mdoc, p)) return(0); - m->next = MDOC_NEXT_CHILD; + mdoc->next = MDOC_NEXT_CHILD; return(1); } - int -mdoc_head_alloc(struct mdoc *m, int line, int pos, enum mdoct tok) +mdoc_head_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok) { struct mdoc_node *p; - assert(m->first); - assert(m->last); + assert(mdoc->first); + assert(mdoc->last); - p = node_alloc(m, line, pos, tok, MDOC_HEAD); - if ( ! node_append(m, p)) + p = node_alloc(mdoc, line, pos, tok, MDOC_HEAD); + if ( ! node_append(mdoc, p)) return(0); - m->next = MDOC_NEXT_CHILD; + mdoc->next = MDOC_NEXT_CHILD; return(1); } - int -mdoc_body_alloc(struct mdoc *m, int line, int pos, enum mdoct tok) +mdoc_body_alloc(struct mdoc *mdoc, 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)) + p = node_alloc(mdoc, line, pos, tok, MDOC_BODY); + if ( ! node_append(mdoc, p)) return(0); - m->next = MDOC_NEXT_CHILD; + mdoc->next = MDOC_NEXT_CHILD; return(1); } +int +mdoc_endbody_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok, + struct mdoc_node *body, enum mdoc_endbody end) +{ + struct mdoc_node *p; + p = node_alloc(mdoc, line, pos, tok, MDOC_BODY); + p->pending = body; + p->norm = body->norm; + p->end = end; + if ( ! node_append(mdoc, p)) + return(0); + mdoc->next = MDOC_NEXT_SIBLING; + return(1); +} + int -mdoc_block_alloc(struct mdoc *m, int line, int pos, +mdoc_block_alloc(struct mdoc *mdoc, 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 = node_alloc(mdoc, line, pos, tok, MDOC_BLOCK); p->args = args; if (p->args) (args->refcnt)++; - if ( ! node_append(m, 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; + } + + if ( ! node_append(mdoc, p)) return(0); - m->next = MDOC_NEXT_CHILD; + mdoc->next = MDOC_NEXT_CHILD; return(1); } - int -mdoc_elem_alloc(struct mdoc *m, int line, int pos, +mdoc_elem_alloc(struct mdoc *mdoc, 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 = node_alloc(mdoc, line, pos, tok, MDOC_ELEM); p->args = args; if (p->args) (args->refcnt)++; - if ( ! node_append(m, p)) + + switch (tok) { + case MDOC_An: + p->norm = mandoc_calloc(1, sizeof(union mdoc_data)); + break; + default: + break; + } + + if ( ! node_append(mdoc, p)) return(0); - m->next = MDOC_NEXT_CHILD; + mdoc->next = MDOC_NEXT_CHILD; return(1); } - int -mdoc_word_alloc(struct mdoc *m, int line, int pos, const char *p) +mdoc_word_alloc(struct mdoc *mdoc, int line, int pos, const char *p) { struct mdoc_node *n; - size_t sv, len; - len = strlen(p); + n = node_alloc(mdoc, line, pos, MDOC_MAX, MDOC_TEXT); + n->string = roff_strdup(mdoc->roff, p); - n = node_alloc(m, line, pos, MDOC_MAX, 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)) + if ( ! node_append(mdoc, n)) return(0); - m->next = MDOC_NEXT_SIBLING; + mdoc->next = MDOC_NEXT_SIBLING; return(1); } - void +mdoc_word_append(struct mdoc *mdoc, const char *p) +{ + struct mdoc_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 = MDOC_NEXT_SIBLING; +} + +static void mdoc_node_free(struct mdoc_node *p) { + if (MDOC_BLOCK == p->type || MDOC_ELEM == p->type) + free(p->norm); if (p->string) free(p->string); if (p->args) @@ -489,9 +585,8 @@ mdoc_node_free(struct mdoc_node *p) free(p); } - static void -mdoc_node_unlink(struct mdoc *m, struct mdoc_node *n) +mdoc_node_unlink(struct mdoc *mdoc, struct mdoc_node *n) { /* Adjust siblings. */ @@ -507,66 +602,115 @@ mdoc_node_unlink(struct mdoc *m, struct mdoc_node *n) 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 (m && m->last == n) { + if (mdoc && mdoc->last == n) { if (n->prev) { - m->last = n->prev; - m->next = MDOC_NEXT_SIBLING; + mdoc->last = n->prev; + mdoc->next = MDOC_NEXT_SIBLING; } else { - m->last = n->parent; - m->next = MDOC_NEXT_CHILD; + mdoc->last = n->parent; + mdoc->next = MDOC_NEXT_CHILD; } } - if (m && m->first == n) - m->first = NULL; + if (mdoc && mdoc->first == n) + mdoc->first = NULL; } - void -mdoc_node_delete(struct mdoc *m, struct mdoc_node *p) +mdoc_node_delete(struct mdoc *mdoc, struct mdoc_node *p) { while (p->child) { assert(p->nchild); - mdoc_node_delete(m, p->child); + mdoc_node_delete(mdoc, p->child); } assert(0 == p->nchild); - mdoc_node_unlink(m, p); + mdoc_node_unlink(mdoc, p); mdoc_node_free(p); } +int +mdoc_node_relink(struct mdoc *mdoc, struct mdoc_node *p) +{ + mdoc_node_unlink(mdoc, p); + return(node_append(mdoc, p)); +} + +#if 0 /* - * Parse free-form text, that is, a line that does not begin with the - * control character. + * Pre-treat a text line. + * Text lines can consist of equations, which must be handled apart from + * the regular text. + * Thus, use this function to step through a line checking if it has any + * equations embedded in it. + * This must handle multiple equations AND equations that do not end at + * the end-of-line, i.e., will re-enter in the next roff parse. */ static int -mdoc_ptext(struct mdoc *m, const struct regset *regs, - int line, char *buf, int offs) +mdoc_preptext(struct mdoc *mdoc, int line, char *buf, int offs) { - char *c, *ws, *end; - struct mdoc_node *n; + char *start, *end; + char delim; - /* Ignore bogus comments. */ + while ('\0' != buf[offs]) { + /* Mark starting position if eqn is set. */ + start = NULL; + if ('\0' != (delim = roff_eqndelim(mdoc->roff))) + if (NULL != (start = strchr(buf + offs, delim))) + *start++ = '\0'; - if ('\\' == buf[offs] && - '.' == buf[offs + 1] && - '"' == buf[offs + 2]) - return(mdoc_pmsg(m, line, offs, MANDOCERR_BADCOMMENT)); + /* Parse text as normal. */ + if ( ! mdoc_ptext(mdoc, line, buf, offs)) + return(0); - /* No text before an initial macro. */ + /* Continue only if an equation exists. */ + if (NULL == start) + break; - if (SEC_NONE == m->lastnamed) - return(mdoc_pmsg(m, line, offs, MANDOCERR_NOTEXT)); + /* Read past the end of the equation. */ + offs += start - (buf + offs); + assert(start == &buf[offs]); + if (NULL != (end = strchr(buf + offs, delim))) { + *end++ = '\0'; + while (' ' == *end) + end++; + } - assert(m->last); - n = m->last; + /* Parse the equation itself. */ + roff_openeqn(mdoc->roff, NULL, line, offs, buf); + /* Process a finished equation? */ + if (roff_closeeqn(mdoc->roff)) + if ( ! mdoc_addeqn(mdoc, roff_eqn(mdoc->roff))) + return(0); + offs += (end - (buf + offs)); + } + + return(1); +} +#endif + +/* + * Parse free-form text, that is, a line that does not begin with the + * control character. + */ +static int +mdoc_ptext(struct mdoc *mdoc, int line, char *buf, int offs) +{ + char *c, *ws, *end; + struct mdoc_node *n; + + assert(mdoc->last); + n = mdoc->last; + /* * Divert directly to list processing if we're encountering a * columnar MDOC_BLOCK with or without a prior MDOC_BLOCK entry @@ -575,21 +719,19 @@ mdoc_ptext(struct mdoc *m, const struct regset *regs, */ if (MDOC_Bl == n->tok && MDOC_BODY == n->type && - LIST_column == n->data.Bl.type) { + LIST_column == n->norm->Bl.type) { /* `Bl' is open without any children. */ - m->flags |= MDOC_FREECOL; - return(mdoc_macro(m, regs, MDOC_It, - line, offs, &offs, buf)); + mdoc->flags |= MDOC_FREECOL; + return(mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf)); } if (MDOC_It == n->tok && MDOC_BLOCK == n->type && - NULL != n->parent && - MDOC_Bl == n->parent->tok && - LIST_column == n->parent->data.Bl.type) { + NULL != n->parent && + MDOC_Bl == n->parent->tok && + LIST_column == n->parent->norm->Bl.type) { /* `Bl' has block-level `It' children. */ - m->flags |= MDOC_FREECOL; - return(mdoc_macro(m, regs, MDOC_It, - line, offs, &offs, buf)); + mdoc->flags |= MDOC_FREECOL; + return(mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf)); } /* @@ -601,11 +743,6 @@ mdoc_ptext(struct mdoc *m, const struct regset *regs, ws = NULL; for (c = end = buf + offs; *c; c++) { switch (*c) { - case '-': - if (mandoc_hyph(buf + offs, c)) - *c = ASCII_HYPH; - ws = NULL; - break; case ' ': if (NULL == ws) ws = c; @@ -622,7 +759,7 @@ mdoc_ptext(struct mdoc *m, const struct regset *regs, * Strip trailing tabs in literal context only; * outside, they affect the next line. */ - if (MDOC_LITERAL & m->flags) + if (MDOC_LITERAL & mdoc->flags) continue; break; case '\\': @@ -639,29 +776,30 @@ mdoc_ptext(struct mdoc *m, const struct regset *regs, *end = '\0'; if (ws) - if ( ! mdoc_pmsg(m, line, (int)(ws-buf), MANDOCERR_EOLNSPACE)) - return(0); + mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse, + line, (int)(ws-buf), NULL); - if ('\0' == buf[offs] && ! (MDOC_LITERAL & m->flags)) { - if ( ! mdoc_pmsg(m, line, (int)(c-buf), MANDOCERR_NOBLANKLN)) - return(0); + if ('\0' == buf[offs] && ! (MDOC_LITERAL & mdoc->flags)) { + mandoc_msg(MANDOCERR_FI_BLANK, mdoc->parse, + line, (int)(c - buf), NULL); /* - * Insert a `Pp' in the case of a blank line. Technically, + * 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. */ - if ( ! mdoc_elem_alloc(m, line, offs, MDOC_Pp, NULL)) + if ( ! mdoc_elem_alloc(mdoc, line, offs, MDOC_sp, NULL)) return(0); - m->next = MDOC_NEXT_SIBLING; - return(1); + mdoc->next = MDOC_NEXT_SIBLING; + + return(mdoc_valid_post(mdoc)); } - if ( ! mdoc_word_alloc(m, line, offs, buf+offs)) + if ( ! mdoc_word_alloc(mdoc, line, offs, buf+offs)) return(0); - if (MDOC_LITERAL & m->flags) + if (MDOC_LITERAL & mdoc->flags) return(1); /* @@ -673,119 +811,86 @@ mdoc_ptext(struct mdoc *m, const struct regset *regs, assert(buf < end); if (mandoc_eos(buf+offs, (size_t)(end-buf-offs))) - m->last->flags |= MDOC_EOS; + mdoc->last->flags |= MDOC_EOS; return(1); } - -static int -macrowarn(struct mdoc *m, int ln, const char *buf, int offs) -{ - int rc; - - rc = mdoc_vmsg(m, MANDOCERR_MACRO, ln, offs, - "unknown macro: %s%s", - buf, strlen(buf) > 3 ? "..." : ""); - - /* FIXME: logic should be in driver. */ - /* FIXME: broken, will error out and not omit a message. */ - return(MDOC_IGN_MACRO & m->pflags ? rc : 0); -} - - /* * Parse a macro line, that is, a line beginning with the control * character. */ -int -mdoc_pmacro(struct mdoc *m, const struct regset *regs, - int ln, char *buf, int offs) +static int +mdoc_pmacro(struct mdoc *mdoc, int ln, char *buf, int offs) { enum mdoct tok; - int i, j, sv; + int i, sv; char mac[5]; struct mdoc_node *n; - /* Empty lines are ignored. */ + /* Empty post-control lines are ignored. */ - offs++; - - if ('\0' == buf[offs]) + if ('"' == buf[offs]) { + mandoc_msg(MANDOCERR_COMMENT_BAD, mdoc->parse, + ln, offs, NULL); return(1); + } else if ('\0' == buf[offs]) + return(1); - i = offs; + sv = offs; - /* Accept whitespace after the initial control char. */ + /* + * Copy the first word into a nil-terminated buffer. + * Stop copying when a tab, space, or eoln is encountered. + */ - if (' ' == buf[i]) { - i++; - while (buf[i] && ' ' == buf[i]) - i++; - if ('\0' == buf[i]) - return(1); - } + i = 0; + while (i < 4 && '\0' != buf[offs] && ' ' != buf[offs] && + '\t' != buf[offs]) + mac[i++] = buf[offs++]; - sv = i; + mac[i] = '\0'; - /* Copy the first word into a nil-terminated buffer. */ + tok = (i > 1 && i < 4) ? mdoc_hash_find(mac) : MDOC_MAX; - 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; - if ( ! mdoc_pmsg(m, ln, i, MANDOCERR_BADCHAR)) - return(0); - i--; + if (MDOC_MAX == tok) { + mandoc_vmsg(MANDOCERR_MACRO, mdoc->parse, + ln, sv, "%s", buf + sv - 1); + return(1); } - mac[j] = '\0'; + /* Disregard the first trailing tab, if applicable. */ - if (j == 4 || j < 2) { - if ( ! macrowarn(m, ln, mac, sv)) - goto err; - return(1); - } - - if (MDOC_MAX == (tok = mdoc_hash_find(mac))) { - if ( ! macrowarn(m, ln, mac, sv)) - goto err; - return(1); - } + if ('\t' == buf[offs]) + offs++; - /* The macro is sane. Jump to the next word. */ + /* Jump to the next non-whitespace word. */ - while (buf[i] && ' ' == buf[i]) - i++; + 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[i] && ' ' == buf[i - 1]) - if ( ! mdoc_pmsg(m, ln, i - 1, MANDOCERR_EOLNSPACE)) - goto err; + 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 == m->last || MDOC_It == tok || MDOC_El == tok) { - if ( ! mdoc_macro(m, regs, tok, ln, sv, &i, buf)) + if (NULL == mdoc->last || MDOC_It == tok || MDOC_El == tok) { + if ( ! mdoc_macro(mdoc, tok, ln, sv, &offs, buf)) goto err; return(1); } - n = m->last; - assert(m->last); + n = mdoc->last; + assert(mdoc->last); /* * If the first macro of a `Bl -column', open an `It' block @@ -793,9 +898,9 @@ mdoc_pmacro(struct mdoc *m, const struct regset *regs, */ if (MDOC_Bl == n->tok && MDOC_BODY == n->type && - LIST_column == n->data.Bl.type) { - m->flags |= MDOC_FREECOL; - if ( ! mdoc_macro(m, regs, MDOC_It, ln, sv, &sv, buf)) + LIST_column == n->norm->Bl.type) { + mdoc->flags |= MDOC_FREECOL; + if ( ! mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf)) goto err; return(1); } @@ -807,26 +912,115 @@ mdoc_pmacro(struct mdoc *m, const struct regset *regs, */ if (MDOC_It == n->tok && MDOC_BLOCK == n->type && - NULL != n->parent && - MDOC_Bl == n->parent->tok && - LIST_column == n->parent->data.Bl.type) { - m->flags |= MDOC_FREECOL; - if ( ! mdoc_macro(m, regs, MDOC_It, ln, sv, &sv, buf)) + NULL != n->parent && + MDOC_Bl == n->parent->tok && + LIST_column == n->parent->norm->Bl.type) { + mdoc->flags |= MDOC_FREECOL; + if ( ! mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf)) goto err; return(1); } /* Normal processing of a macro. */ - if ( ! mdoc_macro(m, regs, tok, ln, sv, &i, buf)) + if ( ! mdoc_macro(mdoc, tok, ln, sv, &offs, buf)) goto err; + /* In quick mode (for mandocdb), abort after the NAME section. */ + + if (mdoc->quick && MDOC_Sh == tok && + SEC_NAME != mdoc->last->sec) + return(2); + return(1); err: /* Error out. */ - m->flags |= MDOC_HALT; + mdoc->flags |= MDOC_HALT; return(0); } +enum mdelim +mdoc_isdelim(const char *p) +{ + 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 mdoc_node *n) +{ + char *cp; + size_t sz; + + if (MDOC_TEXT != n->type) { + 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; +}