=================================================================== RCS file: /cvs/mandoc/mdoc.c,v retrieving revision 1.205 retrieving revision 1.221 diff -u -p -r1.205 -r1.221 --- mandoc/mdoc.c 2013/10/21 23:47:58 1.205 +++ mandoc/mdoc.c 2014/07/30 21:18:24 1.221 @@ -1,7 +1,7 @@ -/* $Id: mdoc.c,v 1.205 2013/10/21 23:47:58 schwarze Exp $ */ +/* $Id: mdoc.c,v 1.221 2014/07/30 21:18:24 schwarze Exp $ */ /* * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons - * Copyright (c) 2010, 2012, 2013 Ingo Schwarze + * 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 @@ -22,6 +22,7 @@ #include #include +#include #include #include #include @@ -30,10 +31,11 @@ #include "mdoc.h" #include "mandoc.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,13 +85,13 @@ 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 *); #if 0 static int mdoc_preptext(struct mdoc *, int, char *, int); @@ -103,24 +99,21 @@ static int mdoc_preptext(struct mdoc *, int, char * 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 *mdoc) { - assert( ! (MDOC_HALT & mdoc->flags)); return(mdoc->first); } - const struct mdoc_meta * mdoc_meta(const struct mdoc *mdoc) { - assert( ! (MDOC_HALT & mdoc->flags)); return(&mdoc->meta); } - /* * Frees volatile resources (parse tree, meta-data, fields). */ @@ -146,7 +139,6 @@ mdoc_free1(struct mdoc *mdoc) free(mdoc->meta.date); } - /* * Allocate all volatile resources (parse tree, meta-data, fields). */ @@ -164,7 +156,6 @@ mdoc_alloc1(struct mdoc *mdoc) 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 @@ -179,7 +170,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. @@ -192,12 +182,12 @@ 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(struct roff *roff, struct mparse *parse, char *defos) +mdoc_alloc(struct roff *roff, struct mparse *parse, + const char *defos, int quick) { struct mdoc *p; @@ -205,6 +195,7 @@ mdoc_alloc(struct roff *roff, struct mparse *parse, ch p->parse = parse; p->defos = defos; + p->quick = quick; p->roff = roff; mdoc_hash_init(); @@ -212,20 +203,11 @@ mdoc_alloc(struct roff *roff, struct mparse *parse, ch 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) { - assert( ! (MDOC_HALT & mdoc->flags)); - if (mdoc_macroend(mdoc)) - return(1); - mdoc->flags |= MDOC_HALT; - return(0); + return(mdoc_macroend(mdoc)); } int @@ -233,15 +215,6 @@ mdoc_addeqn(struct mdoc *mdoc, const struct eqn *ep) { struct mdoc_node *n; - assert( ! (MDOC_HALT & mdoc->flags)); - - /* No text before an initial macro. */ - - if (SEC_NONE == mdoc->lastnamed) { - mdoc_pmsg(mdoc, ep->ln, ep->pos, MANDOCERR_NOTEXT); - return(1); - } - n = node_alloc(mdoc, ep->ln, ep->pos, MDOC_MAX, MDOC_EQN); n->eqn = ep; @@ -257,15 +230,6 @@ mdoc_addspan(struct mdoc *mdoc, const struct tbl_span { struct mdoc_node *n; - assert( ! (MDOC_HALT & mdoc->flags)); - - /* No text before an initial macro. */ - - if (SEC_NONE == mdoc->lastnamed) { - mdoc_pmsg(mdoc, sp->line, 0, MANDOCERR_NOTEXT); - return(1); - } - n = node_alloc(mdoc, sp->line, 0, MDOC_MAX, MDOC_TBL); n->span = sp; @@ -276,7 +240,6 @@ mdoc_addspan(struct mdoc *mdoc, const struct tbl_span return(1); } - /* * Main parse routine. Parses a single line -- really just hands off to * the macro (mdoc_pmacro()) or text parser (mdoc_ptext()). @@ -285,8 +248,6 @@ int mdoc_parseln(struct mdoc *mdoc, int ln, char *buf, int offs) { - assert( ! (MDOC_HALT & mdoc->flags)); - mdoc->flags |= MDOC_NEWLINE; /* @@ -301,8 +262,8 @@ mdoc_parseln(struct mdoc *mdoc, int ln, char *buf, int mdoc->flags &= ~MDOC_SYNOPSIS; return(roff_getcontrol(mdoc->roff, buf, &offs) ? - mdoc_pmacro(mdoc, ln, buf, offs) : - mdoc_ptext(mdoc, ln, buf, offs)); + mdoc_pmacro(mdoc, ln, buf, offs) : + mdoc_ptext(mdoc, ln, buf, offs)); } int @@ -312,17 +273,19 @@ mdoc_macro(MACRO_PROT_ARGS) /* If we're in the body, deny prologue calls. */ - if (MDOC_PROLOGUE & mdoc_macros[tok].flags && - MDOC_PBODY & mdoc->flags) { - mdoc_pmsg(mdoc, 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 & mdoc->flags)) { - mdoc_pmsg(mdoc, line, ppos, MANDOCERR_BADPROLOG); + 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) @@ -350,12 +313,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; @@ -372,13 +335,13 @@ node_append(struct mdoc *mdoc, struct mdoc_node *p) */ switch (p->type) { - case (MDOC_BODY): + case MDOC_BODY: if (ENDBODY_NOT != p->end) break; /* FALLTHROUGH */ - case (MDOC_TAIL): + case MDOC_TAIL: /* FALLTHROUGH */ - case (MDOC_HEAD): + case MDOC_HEAD: p->norm = p->parent->norm; break; default: @@ -389,15 +352,15 @@ node_append(struct mdoc *mdoc, struct mdoc_node *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); @@ -410,9 +373,9 @@ node_append(struct mdoc *mdoc, struct mdoc_node *p) mdoc->last = p; switch (p->type) { - case (MDOC_TBL): + case MDOC_TBL: /* FALLTHROUGH */ - case (MDOC_TEXT): + case MDOC_TEXT: if ( ! mdoc_valid_post(mdoc)) return(0); break; @@ -423,9 +386,8 @@ node_append(struct mdoc *mdoc, struct mdoc_node *p) return(1); } - static struct mdoc_node * -node_alloc(struct mdoc *mdoc, int line, int pos, +node_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok, enum mdoc_type type) { struct mdoc_node *p; @@ -434,6 +396,7 @@ node_alloc(struct mdoc *mdoc, int line, int pos, p->sec = mdoc->lastsec; p->line = line; p->pos = pos; + p->lastline = line; p->tok = tok; p->type = type; @@ -450,7 +413,6 @@ node_alloc(struct mdoc *mdoc, int line, int pos, return(p); } - int mdoc_tail_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok) { @@ -463,7 +425,6 @@ mdoc_tail_alloc(struct mdoc *mdoc, int line, int pos, return(1); } - int mdoc_head_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok) { @@ -479,7 +440,6 @@ mdoc_head_alloc(struct mdoc *mdoc, int line, int pos, return(1); } - int mdoc_body_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok) { @@ -492,7 +452,6 @@ mdoc_body_alloc(struct mdoc *mdoc, int line, int pos, return(1); } - int mdoc_endbody_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok, struct mdoc_node *body, enum mdoc_endbody end) @@ -509,9 +468,8 @@ mdoc_endbody_alloc(struct mdoc *mdoc, int line, int po return(1); } - int -mdoc_block_alloc(struct mdoc *mdoc, 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; @@ -522,13 +480,15 @@ mdoc_block_alloc(struct mdoc *mdoc, int line, int pos, (args->refcnt)++; switch (tok) { - case (MDOC_Bd): + case MDOC_Bd: /* FALLTHROUGH */ - case (MDOC_Bf): + case MDOC_Bf: /* FALLTHROUGH */ - case (MDOC_Bl): + case MDOC_Bl: /* FALLTHROUGH */ - case (MDOC_Rs): + case MDOC_En: + /* FALLTHROUGH */ + case MDOC_Rs: p->norm = mandoc_calloc(1, sizeof(union mdoc_data)); break; default: @@ -541,9 +501,8 @@ mdoc_block_alloc(struct mdoc *mdoc, int line, int pos, return(1); } - int -mdoc_elem_alloc(struct mdoc *mdoc, 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; @@ -554,7 +513,7 @@ mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos, (args->refcnt)++; switch (tok) { - case (MDOC_An): + case MDOC_An: p->norm = mandoc_calloc(1, sizeof(union mdoc_data)); break; default: @@ -590,10 +549,7 @@ mdoc_word_append(struct mdoc *mdoc, const char *p) n = mdoc->last; addstr = roff_strdup(mdoc->roff, p); - if (-1 == asprintf(&newstr, "%s %s", n->string, addstr)) { - perror(NULL); - exit((int)MANDOCLEVEL_SYSERR); - } + mandoc_asprintf(&newstr, "%s %s", n->string, addstr); free(addstr); free(n->string); n->string = newstr; @@ -613,7 +569,6 @@ mdoc_node_free(struct mdoc_node *p) free(p); } - static void mdoc_node_unlink(struct mdoc *mdoc, struct mdoc_node *n) { @@ -651,7 +606,6 @@ mdoc_node_unlink(struct mdoc *mdoc, struct mdoc_node * mdoc->first = NULL; } - void mdoc_node_delete(struct mdoc *mdoc, struct mdoc_node *p) { @@ -722,7 +676,7 @@ mdoc_preptext(struct mdoc *mdoc, int line, char *buf, if ( ! mdoc_addeqn(mdoc, roff_eqn(mdoc->roff))) return(0); offs += (end - (buf + offs)); - } + } return(1); } @@ -738,13 +692,6 @@ mdoc_ptext(struct mdoc *mdoc, int line, char *buf, int char *c, *ws, *end; struct mdoc_node *n; - /* No text before an initial macro. */ - - if (SEC_NONE == mdoc->lastnamed) { - mdoc_pmsg(mdoc, line, offs, MANDOCERR_NOTEXT); - return(1); - } - assert(mdoc->last); n = mdoc->last; @@ -756,16 +703,16 @@ mdoc_ptext(struct mdoc *mdoc, int line, char *buf, int */ if (MDOC_Bl == n->tok && MDOC_BODY == n->type && - LIST_column == n->norm->Bl.type) { + LIST_column == n->norm->Bl.type) { /* `Bl' is open without any children. */ 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->norm->Bl.type) { + 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; return(mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf)); @@ -813,10 +760,12 @@ mdoc_ptext(struct mdoc *mdoc, int line, char *buf, int *end = '\0'; if (ws) - mdoc_pmsg(mdoc, line, (int)(ws-buf), MANDOCERR_EOLNSPACE); + mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse, + line, (int)(ws-buf), NULL); if ('\0' == buf[offs] && ! (MDOC_LITERAL & mdoc->flags)) { - mdoc_pmsg(mdoc, line, (int)(c-buf), MANDOCERR_NOBLANKLN); + mandoc_msg(MANDOCERR_FI_BLANK, mdoc->parse, + line, (int)(c - buf), NULL); /* * Insert a `sp' in the case of a blank line. Technically, @@ -845,13 +794,12 @@ mdoc_ptext(struct mdoc *mdoc, int line, char *buf, int assert(buf < end); - if (mandoc_eos(buf+offs, (size_t)(end-buf-offs), 0)) + 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. @@ -867,30 +815,31 @@ mdoc_pmacro(struct mdoc *mdoc, int ln, char *buf, int /* Empty post-control lines are ignored. */ if ('"' == buf[offs]) { - mdoc_pmsg(mdoc, ln, offs, MANDOCERR_BADCOMMENT); + mandoc_msg(MANDOCERR_COMMENT_BAD, mdoc->parse, + ln, offs, NULL); return(1); } else if ('\0' == buf[offs]) return(1); sv = offs; - /* + /* * Copy the first word into a nil-terminated buffer. * Stop copying when a tab, space, or eoln is encountered. */ i = 0; - while (i < 4 && '\0' != buf[offs] && - ' ' != buf[offs] && '\t' != buf[offs]) + while (i < 4 && '\0' != buf[offs] && ' ' != buf[offs] && + '\t' != buf[offs]) mac[i++] = buf[offs++]; mac[i] = '\0'; - tok = (i > 1 || i < 4) ? mdoc_hash_find(mac) : MDOC_MAX; + tok = (i > 1 && i < 4) ? mdoc_hash_find(mac) : MDOC_MAX; if (MDOC_MAX == tok) { - mandoc_vmsg(MANDOCERR_MACRO, mdoc->parse, - ln, sv, "%s", buf + sv - 1); + mandoc_vmsg(MANDOCERR_MACRO, mdoc->parse, + ln, sv, "%s", buf + sv - 1); return(1); } @@ -904,24 +853,22 @@ mdoc_pmacro(struct mdoc *mdoc, int ln, char *buf, int 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]) - mdoc_pmsg(mdoc, ln, offs - 1, MANDOCERR_EOLNSPACE); + 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) { - if ( ! mdoc_macro(mdoc, tok, ln, sv, &offs, buf)) - goto err; - return(1); - } + if (NULL == mdoc->last || MDOC_It == tok || MDOC_El == tok) + return(mdoc_macro(mdoc, tok, ln, sv, &offs, buf)); n = mdoc->last; assert(mdoc->last); @@ -932,11 +879,9 @@ mdoc_pmacro(struct mdoc *mdoc, int ln, char *buf, int */ if (MDOC_Bl == n->tok && MDOC_BODY == n->type && - LIST_column == n->norm->Bl.type) { + LIST_column == n->norm->Bl.type) { mdoc->flags |= MDOC_FREECOL; - if ( ! mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf)) - goto err; - return(1); + return(mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf)); } /* @@ -946,26 +891,25 @@ mdoc_pmacro(struct mdoc *mdoc, int ln, char *buf, int */ if (MDOC_It == n->tok && MDOC_BLOCK == n->type && - NULL != n->parent && - MDOC_Bl == n->parent->tok && - LIST_column == n->parent->norm->Bl.type) { + 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); + return(mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf)); } /* Normal processing of a macro. */ - if ( ! mdoc_macro(mdoc, tok, ln, sv, &offs, buf)) - goto err; + if ( ! mdoc_macro(mdoc, tok, ln, sv, &offs, buf)) + return(0); - return(1); + /* In quick mode (for mandocdb), abort after the NAME section. */ -err: /* Error out. */ + if (mdoc->quick && MDOC_Sh == tok && + SEC_NAME != mdoc->last->sec) + return(2); - mdoc->flags |= MDOC_HALT; - return(0); + return(1); } enum mdelim @@ -977,27 +921,27 @@ mdoc_isdelim(const char *p) if ('\0' == p[1]) switch (p[0]) { - case('('): + case '(': /* FALLTHROUGH */ - case('['): + case '[': return(DELIM_OPEN); - case('|'): + case '|': return(DELIM_MIDDLE); - case('.'): + case '.': /* FALLTHROUGH */ - case(','): + case ',': /* FALLTHROUGH */ - case(';'): + case ';': /* FALLTHROUGH */ - case(':'): + case ':': /* FALLTHROUGH */ - case('?'): + case '?': /* FALLTHROUGH */ - case('!'): + case '!': /* FALLTHROUGH */ - case(')'): + case ')': /* FALLTHROUGH */ - case(']'): + case ']': return(DELIM_CLOSE); default: return(DELIM_NONE); @@ -1012,4 +956,43 @@ mdoc_isdelim(const char *p) 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; }