version 1.81, 2009/06/16 19:13:28 |
version 1.88, 2009/07/06 13:04:52 |
|
|
|
|
#include "libmdoc.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] = { |
"\\\"", "Dd", "Dt", "Os", |
"Ap", "Dd", "Dt", "Os", |
"Sh", "Ss", "Pp", "D1", |
"Sh", "Ss", "Pp", "D1", |
"Dl", "Bd", "Ed", "Bl", |
"Dl", "Bd", "Ed", "Bl", |
"El", "It", "Ad", "An", |
"El", "It", "Ad", "An", |
Line 63 const char *const __mdoc_macronames[MDOC_MAX] = { |
|
Line 53 const char *const __mdoc_macronames[MDOC_MAX] = { |
|
"Tn", "Ux", "Xc", "Xo", |
"Tn", "Ux", "Xc", "Xo", |
"Fo", "Fc", "Oo", "Oc", |
"Fo", "Fc", "Oo", "Oc", |
"Bk", "Ek", "Bt", "Hf", |
"Bk", "Ek", "Bt", "Hf", |
"Fr", "Ud", "Lb", "Ap", |
"Fr", "Ud", "Lb", "Lp", |
"Lp", "Lk", "Mt", "Brq", |
"Lk", "Mt", "Brq", "Bro", |
/* LINTED */ |
/* LINTED */ |
"Bro", "Brc", "\%C", "Es", |
"Brc", "\%C", "Es", "En", |
/* LINTED */ |
/* LINTED */ |
"En", "Dx", "\%Q" |
"Dx", "\%Q" |
}; |
}; |
|
|
const char *const __mdoc_argnames[MDOC_ARG_MAX] = { |
const char *const __mdoc_argnames[MDOC_ARG_MAX] = { |
Line 95 static int node_append(struct mdoc *, |
|
Line 85 static int node_append(struct mdoc *, |
|
static int parsetext(struct mdoc *, int, char *); |
static int parsetext(struct mdoc *, int, char *); |
static int parsemacro(struct mdoc *, int, char *); |
static int parsemacro(struct mdoc *, int, char *); |
static int macrowarn(struct mdoc *, int, const char *); |
static int macrowarn(struct mdoc *, int, const char *); |
static int perr(struct mdoc *, int, int, enum merr); |
|
|
|
#define verr(m, t) perr((m), (m)->last->line, (m)->last->pos, (t)) |
|
|
|
/* |
|
* Get the first (root) node of the parse tree. |
|
*/ |
|
const struct mdoc_node * |
const struct mdoc_node * |
mdoc_node(const struct mdoc *m) |
mdoc_node(const struct mdoc *m) |
{ |
{ |
Line 118 mdoc_meta(const struct mdoc *m) |
|
Line 103 mdoc_meta(const struct mdoc *m) |
|
} |
} |
|
|
|
|
|
/* |
|
* Frees volatile resources (parse tree, meta-data, fields). |
|
*/ |
static void |
static void |
mdoc_free1(struct mdoc *mdoc) |
mdoc_free1(struct mdoc *mdoc) |
{ |
{ |
Line 137 mdoc_free1(struct mdoc *mdoc) |
|
Line 125 mdoc_free1(struct mdoc *mdoc) |
|
} |
} |
|
|
|
|
|
/* |
|
* Allocate all volatile resources (parse tree, meta-data, fields). |
|
*/ |
static int |
static int |
mdoc_alloc1(struct mdoc *mdoc) |
mdoc_alloc1(struct mdoc *mdoc) |
{ |
{ |
|
|
bzero(&mdoc->meta, sizeof(struct mdoc_meta)); |
bzero(&mdoc->meta, sizeof(struct mdoc_meta)); |
mdoc->flags = 0; |
mdoc->flags = 0; |
mdoc->lastnamed = mdoc->lastsec = 0; |
mdoc->lastnamed = mdoc->lastsec = SEC_NONE; |
mdoc->last = calloc(1, sizeof(struct mdoc_node)); |
mdoc->last = calloc(1, sizeof(struct mdoc_node)); |
if (NULL == mdoc->last) |
if (NULL == mdoc->last) |
return(0); |
return(0); |
Line 156 mdoc_alloc1(struct mdoc *mdoc) |
|
Line 147 mdoc_alloc1(struct mdoc *mdoc) |
|
|
|
|
|
/* |
/* |
* Free up all resources contributed by a parse: the node tree, |
* Free up volatile resources (see mdoc_free1()) then re-initialises the |
* meta-data and so on. Then reallocate the root node for another |
* data with mdoc_alloc1(). After invocation, parse data has been reset |
* parse. |
* and the parser is ready for re-invocation on a new tree; however, |
|
* cross-parse non-volatile data is kept intact. |
*/ |
*/ |
int |
int |
mdoc_reset(struct mdoc *mdoc) |
mdoc_reset(struct mdoc *mdoc) |
Line 170 mdoc_reset(struct mdoc *mdoc) |
|
Line 162 mdoc_reset(struct mdoc *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 |
void |
mdoc_free(struct mdoc *mdoc) |
mdoc_free(struct mdoc *mdoc) |
Line 183 mdoc_free(struct mdoc *mdoc) |
|
Line 176 mdoc_free(struct mdoc *mdoc) |
|
} |
} |
|
|
|
|
|
/* |
|
* Allocate volatile and non-volatile parse resources. |
|
*/ |
struct mdoc * |
struct mdoc * |
mdoc_alloc(void *data, int pflags, const struct mdoc_cb *cb) |
mdoc_alloc(void *data, int pflags, const struct mdoc_cb *cb) |
{ |
{ |
Line 209 mdoc_alloc(void *data, int pflags, const struct mdoc_c |
|
Line 205 mdoc_alloc(void *data, int pflags, const struct mdoc_c |
|
|
|
/* |
/* |
* Climb back up the parse tree, validating open scopes. Mostly calls |
* Climb back up the parse tree, validating open scopes. Mostly calls |
* through to macro_end in macro.c. |
* through to macro_end() in macro.c. |
*/ |
*/ |
int |
int |
mdoc_endparse(struct mdoc *m) |
mdoc_endparse(struct mdoc *m) |
Line 226 mdoc_endparse(struct mdoc *m) |
|
Line 222 mdoc_endparse(struct mdoc *m) |
|
|
|
/* |
/* |
* Main parse routine. Parses a single line -- really just hands off to |
* Main parse routine. Parses a single line -- really just hands off to |
* the macro or text parser. |
* the macro (parsemacro()) or text parser (parsetext()). |
*/ |
*/ |
int |
int |
mdoc_parseln(struct mdoc *m, int ln, char *buf) |
mdoc_parseln(struct mdoc *m, int ln, char *buf) |
{ |
{ |
|
|
/* If in error-mode, then we parse no more. */ |
|
|
|
if (MDOC_HALT & m->flags) |
if (MDOC_HALT & m->flags) |
return(0); |
return(0); |
|
|
Line 255 mdoc_verr(struct mdoc *mdoc, int ln, int pos, |
|
Line 249 mdoc_verr(struct mdoc *mdoc, int ln, int pos, |
|
va_start(ap, fmt); |
va_start(ap, fmt); |
(void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap); |
(void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap); |
va_end(ap); |
va_end(ap); |
|
|
return((*mdoc->cb.mdoc_err)(mdoc->data, ln, pos, buf)); |
return((*mdoc->cb.mdoc_err)(mdoc->data, ln, pos, buf)); |
} |
} |
|
|
|
|
int |
int |
mdoc_vwarn(struct mdoc *mdoc, int ln, int pos, |
mdoc_vwarn(struct mdoc *mdoc, int ln, int pos, const char *fmt, ...) |
enum mdoc_warn type, const char *fmt, ...) |
|
{ |
{ |
char buf[256]; |
char buf[256]; |
va_list ap; |
va_list ap; |
Line 272 mdoc_vwarn(struct mdoc *mdoc, int ln, int pos, |
|
Line 266 mdoc_vwarn(struct mdoc *mdoc, int ln, int pos, |
|
va_start(ap, fmt); |
va_start(ap, fmt); |
(void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap); |
(void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap); |
va_end(ap); |
va_end(ap); |
return((*mdoc->cb.mdoc_warn)(mdoc->data, ln, pos, type, buf)); |
|
} |
|
|
|
|
return((*mdoc->cb.mdoc_warn)(mdoc->data, ln, pos, buf)); |
int |
|
mdoc_nerr(struct mdoc *mdoc, const struct mdoc_node *node, 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, node->line, node->pos, buf)); |
|
} |
} |
|
|
|
|
int |
int |
mdoc_warn(struct mdoc *mdoc, enum mdoc_warn type, const char *fmt, ...) |
mdoc_err(struct mdoc *m, int line, int pos, int iserr, enum merr type) |
{ |
{ |
char buf[256]; |
char *p; |
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, mdoc->last->line, |
|
mdoc->last->pos, type, buf)); |
|
} |
|
|
|
|
|
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)); |
|
} |
|
|
|
|
|
int |
|
mdoc_pwarn(struct mdoc *mdoc, int line, int pos, enum mdoc_warn type, |
|
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, 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; |
p = NULL; |
|
|
switch (type) { |
switch (type) { |
case (ENOCALL): |
case (ENOCALL): |
p = "not callable"; |
p = "not callable"; |
Line 408 perr(struct mdoc *m, int line, int pos, enum merr type |
|
Line 300 perr(struct mdoc *m, int line, int pos, enum merr type |
|
case (ESPACE): |
case (ESPACE): |
p = "whitespace disallowed after delimiter"; |
p = "whitespace disallowed after delimiter"; |
break; |
break; |
|
case (ETOOLONG): |
|
p = "text argument too long"; |
|
break; |
|
case (EESCAPE): |
|
p = "invalid escape sequence"; |
|
break; |
|
case (EPRINT): |
|
p = "invalid character"; |
|
break; |
|
case (ENESTDISP): |
|
p = "displays may not be nested"; |
|
break; |
|
case (EBOOL): |
|
p = "expected boolean value"; |
|
break; |
|
case (EARGREP): |
|
p = "argument repeated"; |
|
break; |
|
case (EMULTIDISP): |
|
p = "multiple display types specified"; |
|
break; |
|
case (EMULTILIST): |
|
p = "multiple list types specified"; |
|
break; |
|
case (ELISTTYPE): |
|
p = "missing list type"; |
|
break; |
|
case (EDISPTYPE): |
|
p = "missing display type"; |
|
break; |
|
case (ESECNAME): |
|
p = "the NAME section must come first"; |
|
break; |
|
case (ELINE): |
|
p = "expected line arguments"; |
|
break; |
|
case (ENOPROLOGUE): |
|
p = "document has no prologue"; |
|
break; |
|
case (ENODAT): |
|
p = "document has no data"; |
|
break; |
|
case (ECOLMIS): |
|
p = "column syntax style mismatch"; |
|
break; |
|
case (EATT): |
|
p = "expected valid AT&T symbol"; |
|
break; |
|
case (ENAME): |
|
p = "default name not yet set"; |
|
break; |
|
case (ENOWIDTH): |
|
p = "superfluous width argument"; |
|
break; |
|
case (EMISSWIDTH): |
|
p = "missing width argument"; |
|
break; |
|
case (EWRONGMSEC): |
|
p = "document section in wrong manual section"; |
|
break; |
|
case (ESECOOO): |
|
p = "document section out of conventional order"; |
|
break; |
|
case (ESECREP): |
|
p = "document section repeated"; |
|
break; |
|
case (EBADSTAND): |
|
p = "unknown standard"; |
|
break; |
|
case (ENAMESECINC): |
|
p = "NAME section contents incomplete/badly-ordered"; |
|
break; |
|
case (ENOMULTILINE): |
|
p = "suggested no multi-line arguments"; |
|
break; |
|
case (EMULTILINE): |
|
p = "suggested multi-line arguments"; |
|
break; |
|
case (ENOLINE): |
|
p = "suggested no line arguments"; |
|
break; |
|
case (EPROLOOO): |
|
p = "prologue macros out-of-order"; |
|
break; |
|
case (EPROLREP): |
|
p = "prologue macros repeated"; |
|
break; |
|
case (EARGVAL): |
|
p = "argument value suggested"; |
|
break; |
|
case (EFONT): |
|
p = "invalid font mode"; |
|
break; |
|
case (EBADMSEC): |
|
p = "inappropriate manual section"; |
|
break; |
|
case (EBADSEC): |
|
p = "inappropriate document section"; |
|
break; |
|
case (EQUOTTERM): |
|
p = "unterminated quoted parameter"; |
|
break; |
|
case (EQUOTPARM): |
|
p = "unexpected quoted parameter"; |
|
break; |
|
case (EARGVPARM): |
|
p = "argument-like parameter"; |
|
break; |
|
case (ECOLEMPTY): |
|
p = "last list column is empty"; |
|
break; |
|
case (ETAILWS): |
|
p = "trailing whitespace"; |
|
break; |
|
case (ENUMFMT): |
|
p = "bad number format"; |
|
break; |
|
case (EUTSNAME): |
|
p = "utsname"; |
|
break; |
|
case (EBADDATE): |
|
p = "malformed date syntax"; |
|
break; |
|
case (EOPEN): |
|
p = "explicit scope still open on exit"; |
|
break; |
|
case (EQUOT): |
|
p = "unterminated quotation"; |
|
break; |
|
case (ENOCTX): |
|
p = "closure has no prior context"; |
|
break; |
|
case (ENOPARMS): |
|
p = "unexpect line arguments"; |
|
break; |
|
case (EIGNE): |
|
p = "ignoring empty element"; |
|
break; |
|
case (EIMPBRK): |
|
p = "crufty end-of-line scope violation"; |
|
break; |
|
case (EMACPARM): |
|
p = "macro-like parameter"; |
|
break; |
|
case (EOBS): |
|
p = "macro marked obsolete"; |
|
break; |
} |
} |
|
|
assert(p); |
assert(p); |
return(mdoc_perr(m, line, pos, p)); |
|
|
if (iserr) |
|
return(mdoc_verr(m, line, pos, p)); |
|
|
|
return(mdoc_vwarn(m, line, pos, p)); |
} |
} |
|
|
|
|
|
int |
|
mdoc_macro(struct mdoc *m, int tok, |
|
int ln, int pp, int *pos, char *buf) |
|
{ |
|
|
|
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)) |
|
return(mdoc_perr(m, ln, pp, EBODYPROL)); |
|
|
|
if (1 != pp && ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) |
|
return(mdoc_perr(m, ln, pp, ENOCALL)); |
|
|
|
return((*mdoc_macros[tok].fp)(m, tok, ln, pp, pos, buf)); |
|
} |
|
|
|
|
static int |
static int |
node_append(struct mdoc *mdoc, struct mdoc_node *p) |
node_append(struct mdoc *mdoc, struct mdoc_node *p) |
{ |
{ |
Line 437 node_append(struct mdoc *mdoc, struct mdoc_node *p) |
|
Line 500 node_append(struct mdoc *mdoc, struct mdoc_node *p) |
|
/* NOTREACHED */ |
/* NOTREACHED */ |
} |
} |
|
|
|
p->parent->nchild++; |
|
|
if ( ! mdoc_valid_pre(mdoc, p)) |
if ( ! mdoc_valid_pre(mdoc, p)) |
return(0); |
return(0); |
if ( ! mdoc_action_pre(mdoc, p)) |
if ( ! mdoc_action_pre(mdoc, p)) |
Line 483 node_alloc(struct mdoc *mdoc, int line, |
|
Line 548 node_alloc(struct mdoc *mdoc, int line, |
|
struct mdoc_node *p; |
struct mdoc_node *p; |
|
|
if (NULL == (p = calloc(1, sizeof(struct mdoc_node)))) { |
if (NULL == (p = calloc(1, sizeof(struct mdoc_node)))) { |
(void)verr(mdoc, EMALLOC); |
(void)mdoc_nerr(mdoc, mdoc->last, EMALLOC); |
return(NULL); |
return(NULL); |
} |
} |
|
|
Line 579 mdoc_word_alloc(struct mdoc *mdoc, |
|
Line 644 mdoc_word_alloc(struct mdoc *mdoc, |
|
if (NULL == p) |
if (NULL == p) |
return(0); |
return(0); |
if (NULL == (p->string = strdup(word))) { |
if (NULL == (p->string = strdup(word))) { |
(void)verr(mdoc, EMALLOC); |
(void)mdoc_nerr(mdoc, mdoc->last, EMALLOC); |
return(0); |
return(0); |
} |
} |
|
|
return(node_append(mdoc, p)); |
return(node_append(mdoc, p)); |
} |
} |
|
|
|
|
mdoc_node_free(struct mdoc_node *p) |
mdoc_node_free(struct mdoc_node *p) |
{ |
{ |
|
|
|
if (p->parent) |
|
p->parent->nchild--; |
if (p->string) |
if (p->string) |
free(p->string); |
free(p->string); |
if (p->args) |
if (p->args) |
Line 607 mdoc_node_freelist(struct mdoc_node *p) |
|
Line 675 mdoc_node_freelist(struct mdoc_node *p) |
|
if (p->next) |
if (p->next) |
mdoc_node_freelist(p->next); |
mdoc_node_freelist(p->next); |
|
|
|
assert(0 == p->nchild); |
mdoc_node_free(p); |
mdoc_node_free(p); |
} |
} |
|
|
|
|
parsetext(struct mdoc *m, int line, char *buf) |
parsetext(struct mdoc *m, int line, char *buf) |
{ |
{ |
|
|
if (SEC_PROLOGUE == m->lastnamed) |
if (SEC_NONE == m->lastnamed) |
return(perr(m, line, 0, ETEXTPROL)); |
return(mdoc_perr(m, line, 0, ETEXTPROL)); |
|
|
if (0 == buf[0] && ! (MDOC_LITERAL & m->flags)) |
if (0 == buf[0] && ! (MDOC_LITERAL & m->flags)) |
return(perr(m, line, 0, ENOBLANK)); |
return(mdoc_perr(m, line, 0, ENOBLANK)); |
|
|
if ( ! mdoc_word_alloc(m, line, 0, buf)) |
if ( ! mdoc_word_alloc(m, line, 0, buf)) |
return(0); |
return(0); |
|
|
macrowarn(struct mdoc *m, int ln, const char *buf) |
macrowarn(struct mdoc *m, int ln, const char *buf) |
{ |
{ |
if ( ! (MDOC_IGN_MACRO & m->pflags)) |
if ( ! (MDOC_IGN_MACRO & m->pflags)) |
return(mdoc_perr(m, ln, 1, |
return(mdoc_verr(m, ln, 1, |
"unknown macro: %s%s", |
"unknown macro: %s%s", |
buf, strlen(buf) > 3 ? "..." : "")); |
buf, strlen(buf) > 3 ? "..." : "")); |
return(mdoc_pwarn(m, ln, 1, WARN_SYNTAX, |
return(mdoc_vwarn(m, ln, 1, "unknown macro: %s%s", |
"unknown macro: %s%s", |
|
buf, strlen(buf) > 3 ? "..." : "")); |
buf, strlen(buf) > 3 ? "..." : "")); |
} |
} |
|
|
|
|
|
|
/* |
/* |
* Parse a macro line, that is, a line beginning with the control |
* Parse a macro line, that is, a line beginning with the control |
* character. |
* character. |
Line 668 parsemacro(struct mdoc *m, int ln, char *buf) |
|
Line 735 parsemacro(struct mdoc *m, int ln, char *buf) |
|
i++; |
i++; |
if (0 == buf[i]) |
if (0 == buf[i]) |
return(1); |
return(1); |
return(perr(m, ln, 1, ESPACE)); |
return(mdoc_perr(m, ln, 1, ESPACE)); |
} |
} |
|
|
/* Copy the first word into a nil-terminated buffer. */ |
/* Copy the first word into a nil-terminated buffer. */ |