version 1.51, 2009/03/05 13:12:12 |
version 1.66, 2009/03/16 23:37:28 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se> |
* Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org> |
* |
* |
* Permission to use, copy, modify, and distribute this software for any |
* Permission to use, copy, modify, and distribute this software for any |
* purpose with or without fee is hereby granted, provided that the |
* purpose with or without fee is hereby granted, provided that the |
|
|
* in macro.c and validate.c. |
* in macro.c and validate.c. |
*/ |
*/ |
|
|
static struct mdoc_arg *argdup(size_t, const struct mdoc_arg *); |
|
static void argfree(size_t, struct mdoc_arg *); |
|
static void argcpy(struct mdoc_arg *, |
|
const struct mdoc_arg *); |
|
|
|
static struct mdoc_node *mdoc_node_alloc(const struct mdoc *); |
static struct mdoc_node *mdoc_node_alloc(const struct mdoc *); |
static int mdoc_node_append(struct mdoc *, |
static int mdoc_node_append(struct mdoc *, |
struct mdoc_node *); |
struct mdoc_node *); |
static void mdoc_elem_free(struct mdoc_elem *); |
|
static void mdoc_text_free(struct mdoc_text *); |
|
|
|
|
static int parsetext(struct mdoc *, int, char *); |
|
static int parsemacro(struct mdoc *, int, char *); |
|
static int macrowarn(struct mdoc *, int, const char *); |
|
|
|
|
const char *const __mdoc_macronames[MDOC_MAX] = { |
const char *const __mdoc_macronames[MDOC_MAX] = { |
"\\\"", "Dd", "Dt", "Os", |
"\\\"", "Dd", "Dt", "Os", |
"Sh", "Ss", "Pp", "D1", |
"Sh", "Ss", "Pp", "D1", |
Line 74 const char *const __mdoc_macronames[MDOC_MAX] = { |
|
Line 71 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", |
"Fr", "Ud", "Lb", "Ap", |
|
"Lp", "Lk", "Mt", "Brq", |
|
/* LINTED */ |
|
"Bro", "Brc", "\%C", "Es", |
|
"En", "Dx" |
}; |
}; |
|
|
const char *const __mdoc_argnames[MDOC_ARG_MAX] = { |
const char *const __mdoc_argnames[MDOC_ARG_MAX] = { |
Line 85 const char *const __mdoc_argnames[MDOC_ARG_MAX] = { |
|
Line 86 const char *const __mdoc_argnames[MDOC_ARG_MAX] = { |
|
"tag", "diag", "hang", |
"tag", "diag", "hang", |
"ohang", "inset", "column", |
"ohang", "inset", "column", |
"width", "compact", "std", |
"width", "compact", "std", |
"p1003.1-88", "p1003.1-90", "p1003.1-96", |
"filled", "words", "emphasis", |
"p1003.1-2001", "p1003.1-2004", "p1003.1", |
"symbolic", "nested" |
"p1003.1b", "p1003.1b-93", "p1003.1c-95", |
|
"p1003.1g-2000", "p1003.2-92", "p1387.2-95", |
|
"p1003.2", "p1387.2", "isoC-90", |
|
"isoC-amd1", "isoC-tcor1", "isoC-tcor2", |
|
"isoC-99", "ansiC", "ansiC-89", |
|
"ansiC-99", "ieee754", "iso8802-3", |
|
"xpg3", "xpg4", "xpg4.2", |
|
"xpg4.3", "xbd5", "xcu5", |
|
"xsh5", "xns5", "xns5.2d2.0", |
|
"xcurses4.2", "susv2", "susv3", |
|
"svid4", "filled", "words", |
|
"emphasis", "symbolic", |
|
}; |
}; |
|
|
const char * const *mdoc_macronames = __mdoc_macronames; |
const char * const *mdoc_macronames = __mdoc_macronames; |
Line 135 mdoc_free(struct mdoc *mdoc) |
|
Line 124 mdoc_free(struct mdoc *mdoc) |
|
free(mdoc->meta.os); |
free(mdoc->meta.os); |
if (mdoc->meta.name) |
if (mdoc->meta.name) |
free(mdoc->meta.name); |
free(mdoc->meta.name); |
|
if (mdoc->meta.arch) |
|
free(mdoc->meta.arch); |
|
if (mdoc->meta.vol) |
|
free(mdoc->meta.vol); |
|
|
free(mdoc); |
free(mdoc); |
} |
} |
|
|
|
|
struct mdoc * |
struct mdoc * |
mdoc_alloc(void *data, const struct mdoc_cb *cb) |
mdoc_alloc(void *data, int pflags, const struct mdoc_cb *cb) |
{ |
{ |
struct mdoc *p; |
struct mdoc *p; |
|
|
Line 154 mdoc_alloc(void *data, const struct mdoc_cb *cb) |
|
Line 147 mdoc_alloc(void *data, const struct mdoc_cb *cb) |
|
p->last = xcalloc(1, sizeof(struct mdoc_node)); |
p->last = xcalloc(1, sizeof(struct mdoc_node)); |
p->last->type = MDOC_ROOT; |
p->last->type = MDOC_ROOT; |
p->first = p->last; |
p->first = p->last; |
|
p->pflags = pflags; |
p->next = MDOC_NEXT_CHILD; |
p->next = MDOC_NEXT_CHILD; |
p->htab = mdoc_tokhash_alloc(); |
p->htab = mdoc_tokhash_alloc(); |
|
|
Line 181 mdoc_endparse(struct mdoc *mdoc) |
|
Line 174 mdoc_endparse(struct mdoc *mdoc) |
|
|
|
|
|
/* |
/* |
* Main line-parsing routine. If the line is a macro-line (started with |
* Main parse routine. Parses a single line -- really just hands off to |
* a '.' control character), then pass along to the parser, which parses |
* the macro or text parser. |
* subsequent macros until the end of line. If normal text, simply |
|
* append the entire line to the chain. |
|
*/ |
*/ |
int |
int |
mdoc_parseln(struct mdoc *mdoc, int line, char *buf) |
mdoc_parseln(struct mdoc *m, int ln, char *buf) |
{ |
{ |
int c, i; |
|
char tmp[5]; |
|
|
|
if (MDOC_HALT & mdoc->flags) |
/* If in error-mode, then we parse no more. */ |
return(0); |
|
|
|
mdoc->linetok = 0; |
if (MDOC_HALT & m->flags) |
|
|
if ('.' != *buf) { |
|
/* |
|
* Free-form text. Not allowed in the prologue. |
|
*/ |
|
if (SEC_PROLOGUE == mdoc->lastnamed) |
|
return(mdoc_perr(mdoc, line, 0, |
|
"no text in prologue")); |
|
|
|
if ( ! mdoc_word_alloc(mdoc, line, 0, buf)) |
|
return(0); |
|
mdoc->next = MDOC_NEXT_SIBLING; |
|
return(1); |
|
} |
|
|
|
/* |
|
* Control-character detected. Begin the parsing sequence. |
|
*/ |
|
|
|
if (buf[1] && '\\' == buf[1]) |
|
if (buf[2] && '\"' == buf[2]) |
|
return(1); |
|
|
|
i = 1; |
|
while (buf[i] && ! isspace((u_char)buf[i]) && |
|
i < (int)sizeof(tmp)) |
|
i++; |
|
|
|
if (i == (int)sizeof(tmp)) { |
|
mdoc->flags |= MDOC_HALT; |
|
return(mdoc_perr(mdoc, line, 1, "unknown macro")); |
|
} else if (i <= 2) { |
|
mdoc->flags |= MDOC_HALT; |
|
return(mdoc_perr(mdoc, line, 1, "unknown macro")); |
|
} |
|
|
|
i--; |
|
|
|
(void)memcpy(tmp, buf + 1, (size_t)i); |
|
tmp[i++] = 0; |
|
|
|
if (MDOC_MAX == (c = mdoc_find(mdoc, tmp))) { |
|
mdoc->flags |= MDOC_HALT; |
|
return(mdoc_perr(mdoc, line, 1, "unknown macro")); |
|
} |
|
|
|
while (buf[i] && isspace((u_char)buf[i])) |
|
i++; |
|
|
|
if ( ! mdoc_macro(mdoc, c, line, 1, &i, buf)) { |
|
mdoc->flags |= MDOC_HALT; |
|
return(0); |
return(0); |
} |
|
|
|
return(1); |
return('.' == *buf ? parsemacro(m, ln, buf) : |
|
parsetext(m, ln, buf)); |
} |
} |
|
|
|
|
Line 305 mdoc_vwarn(struct mdoc *mdoc, int ln, int pos, |
|
Line 242 mdoc_vwarn(struct mdoc *mdoc, int ln, int pos, |
|
|
|
|
|
int |
int |
mdoc_macro(struct mdoc *mdoc, int tok, |
mdoc_macro(struct mdoc *m, int tok, |
int ln, int ppos, int *pos, char *buf) |
int ln, int pp, int *pos, char *buf) |
{ |
{ |
|
|
assert(mdoc_macros[tok].fp); |
/* FIXME - these should happen during validation. */ |
|
|
if (MDOC_PROLOGUE & mdoc_macros[tok].flags && |
if (MDOC_PROLOGUE & mdoc_macros[tok].flags && |
SEC_PROLOGUE != mdoc->lastnamed) |
SEC_PROLOGUE != m->lastnamed) |
return(mdoc_perr(mdoc, ln, ppos, "macro disallowed in document body")); |
return(mdoc_perr(m, ln, pp, |
|
"disallowed in document body")); |
|
|
if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) && |
if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) && |
SEC_PROLOGUE == mdoc->lastnamed) |
SEC_PROLOGUE == m->lastnamed) |
return(mdoc_perr(mdoc, ln, ppos, "macro disallowed in document prologue")); |
return(mdoc_perr(m, ln, pp, |
if (1 != ppos && ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) |
"disallowed in prologue")); |
return(mdoc_perr(mdoc, ln, ppos, "macro not callable")); |
|
return((*mdoc_macros[tok].fp)(mdoc, tok, ln, ppos, pos, buf)); |
if (1 != pp && ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) |
|
return(mdoc_perr(m, ln, pp, "%s not callable", |
|
mdoc_macronames[tok])); |
|
|
|
return((*mdoc_macros[tok].fp)(m, tok, ln, pp, pos, buf)); |
} |
} |
|
|
|
|
static int |
static int |
mdoc_node_append(struct mdoc *mdoc, struct mdoc_node *p) |
mdoc_node_append(struct mdoc *mdoc, struct mdoc_node *p) |
{ |
{ |
const char *nn, *nt, *on, *ot, *act; |
|
|
|
assert(mdoc->last); |
assert(mdoc->last); |
assert(mdoc->first); |
assert(mdoc->first); |
assert(MDOC_ROOT != p->type); |
assert(MDOC_ROOT != p->type); |
|
|
/* See if we exceed the suggest line-max. */ |
|
|
|
switch (p->type) { |
|
case (MDOC_TEXT): |
|
/* FALLTHROUGH */ |
|
case (MDOC_ELEM): |
|
/* FALLTHROUGH */ |
|
case (MDOC_BLOCK): |
|
mdoc->linetok++; |
|
break; |
|
default: |
|
break; |
|
} |
|
|
|
/* This sort-of works (re-opening of text macros...). */ |
|
if (mdoc->linetok > MDOC_LINEARG_SOFTMAX) |
|
if ( ! mdoc_nwarn(mdoc, p, WARN_COMPAT, |
|
"suggested %d tokens per line exceeded (has %d)", |
|
MDOC_LINEARG_SOFTMAX, mdoc->linetok)) |
|
return(0); |
|
|
|
if (MDOC_TEXT == mdoc->last->type) |
|
on = "<text>"; |
|
else if (MDOC_ROOT == mdoc->last->type) |
|
on = "<root>"; |
|
else |
|
on = mdoc_macronames[mdoc->last->tok]; |
|
|
|
if (MDOC_TEXT == p->type) |
|
nn = "<text>"; |
|
else if (MDOC_ROOT == p->type) |
|
nn = "<root>"; |
|
else |
|
nn = mdoc_macronames[p->tok]; |
|
|
|
ot = mdoc_type2a(mdoc->last->type); |
|
nt = mdoc_type2a(p->type); |
|
|
|
switch (mdoc->next) { |
switch (mdoc->next) { |
case (MDOC_NEXT_SIBLING): |
case (MDOC_NEXT_SIBLING): |
mdoc->last->next = p; |
mdoc->last->next = p; |
p->prev = mdoc->last; |
p->prev = mdoc->last; |
p->parent = mdoc->last->parent; |
p->parent = mdoc->last->parent; |
act = "sibling"; |
|
break; |
break; |
case (MDOC_NEXT_CHILD): |
case (MDOC_NEXT_CHILD): |
mdoc->last->child = p; |
mdoc->last->child = p; |
p->parent = mdoc->last; |
p->parent = mdoc->last; |
act = "child"; |
|
break; |
break; |
default: |
default: |
abort(); |
abort(); |
Line 393 mdoc_node_append(struct mdoc *mdoc, struct mdoc_node * |
|
Line 295 mdoc_node_append(struct mdoc *mdoc, struct mdoc_node * |
|
switch (p->type) { |
switch (p->type) { |
case (MDOC_HEAD): |
case (MDOC_HEAD): |
assert(MDOC_BLOCK == p->parent->type); |
assert(MDOC_BLOCK == p->parent->type); |
p->parent->data.block.head = p; |
p->parent->head = p; |
break; |
break; |
case (MDOC_TAIL): |
case (MDOC_TAIL): |
assert(MDOC_BLOCK == p->parent->type); |
assert(MDOC_BLOCK == p->parent->type); |
p->parent->data.block.tail = p; |
p->parent->tail = p; |
break; |
break; |
case (MDOC_BODY): |
case (MDOC_BODY): |
assert(MDOC_BLOCK == p->parent->type); |
assert(MDOC_BLOCK == p->parent->type); |
p->parent->data.block.body = p; |
p->parent->body = p; |
break; |
break; |
default: |
default: |
break; |
break; |
} |
} |
|
|
mdoc->last = p; |
mdoc->last = p; |
mdoc_msg(mdoc, "parse: %s `%s' %s of %s `%s'", |
|
nt, nn, act, ot, on); |
|
return(1); |
return(1); |
} |
} |
|
|
Line 498 mdoc_root_alloc(struct mdoc *mdoc) |
|
Line 398 mdoc_root_alloc(struct mdoc *mdoc) |
|
|
|
int |
int |
mdoc_block_alloc(struct mdoc *mdoc, int line, int pos, |
mdoc_block_alloc(struct mdoc *mdoc, int line, int pos, |
int tok, size_t argsz, const struct mdoc_arg *args) |
int tok, struct mdoc_arg *args) |
{ |
{ |
struct mdoc_node *p; |
struct mdoc_node *p; |
|
|
Line 508 mdoc_block_alloc(struct mdoc *mdoc, int line, int pos, |
|
Line 408 mdoc_block_alloc(struct mdoc *mdoc, int line, int pos, |
|
p->line = line; |
p->line = line; |
p->type = MDOC_BLOCK; |
p->type = MDOC_BLOCK; |
p->tok = tok; |
p->tok = tok; |
p->data.block.argc = argsz; |
p->args = args; |
p->data.block.argv = argdup(argsz, args); |
|
|
|
|
if (args) |
|
(args->refcnt)++; |
|
|
return(mdoc_node_append(mdoc, p)); |
return(mdoc_node_append(mdoc, p)); |
} |
} |
|
|
|
|
int |
int |
mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos, |
mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos, |
int tok, size_t argsz, const struct mdoc_arg *args) |
int tok, struct mdoc_arg *args) |
{ |
{ |
struct mdoc_node *p; |
struct mdoc_node *p; |
|
|
Line 527 mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos, |
|
Line 429 mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos, |
|
p->pos = pos; |
p->pos = pos; |
p->type = MDOC_ELEM; |
p->type = MDOC_ELEM; |
p->tok = tok; |
p->tok = tok; |
p->data.elem.argc = argsz; |
p->args = args; |
p->data.elem.argv = argdup(argsz, args); |
|
|
|
|
if (args) |
|
(args->refcnt)++; |
|
|
return(mdoc_node_append(mdoc, p)); |
return(mdoc_node_append(mdoc, p)); |
} |
} |
|
|
Line 545 mdoc_word_alloc(struct mdoc *mdoc, |
|
Line 449 mdoc_word_alloc(struct mdoc *mdoc, |
|
p->line = line; |
p->line = line; |
p->pos = pos; |
p->pos = pos; |
p->type = MDOC_TEXT; |
p->type = MDOC_TEXT; |
p->data.text.string = xstrdup(word); |
p->string = xstrdup(word); |
|
|
return(mdoc_node_append(mdoc, p)); |
return(mdoc_node_append(mdoc, p)); |
} |
} |
|
|
|
|
static void |
|
argfree(size_t sz, struct mdoc_arg *p) |
|
{ |
|
int i, j; |
|
|
|
if (0 == sz) |
|
return; |
|
|
|
assert(p); |
|
/* LINTED */ |
|
for (i = 0; i < (int)sz; i++) |
|
if (p[i].sz > 0) { |
|
assert(p[i].value); |
|
/* LINTED */ |
|
for (j = 0; j < (int)p[i].sz; j++) |
|
free(p[i].value[j]); |
|
free(p[i].value); |
|
} |
|
free(p); |
|
} |
|
|
|
|
|
static void |
|
mdoc_elem_free(struct mdoc_elem *p) |
|
{ |
|
|
|
argfree(p->argc, p->argv); |
|
} |
|
|
|
|
|
static void |
|
mdoc_block_free(struct mdoc_block *p) |
|
{ |
|
|
|
argfree(p->argc, p->argv); |
|
} |
|
|
|
|
|
static void |
|
mdoc_text_free(struct mdoc_text *p) |
|
{ |
|
|
|
if (p->string) |
|
free(p->string); |
|
} |
|
|
|
|
|
void |
void |
mdoc_node_free(struct mdoc_node *p) |
mdoc_node_free(struct mdoc_node *p) |
{ |
{ |
|
|
switch (p->type) { |
if (p->string) |
case (MDOC_TEXT): |
free(p->string); |
mdoc_text_free(&p->data.text); |
if (p->args) |
break; |
mdoc_argv_free(p->args); |
case (MDOC_ELEM): |
|
mdoc_elem_free(&p->data.elem); |
|
break; |
|
case (MDOC_BLOCK): |
|
mdoc_block_free(&p->data.block); |
|
break; |
|
default: |
|
break; |
|
} |
|
|
|
free(p); |
free(p); |
} |
} |
|
|
Line 633 mdoc_node_freelist(struct mdoc_node *p) |
|
Line 480 mdoc_node_freelist(struct mdoc_node *p) |
|
} |
} |
|
|
|
|
int |
/* |
mdoc_find(const struct mdoc *mdoc, const char *key) |
* Parse free-form text, that is, a line that does not begin with the |
|
* control character. |
|
*/ |
|
static int |
|
parsetext(struct mdoc *mdoc, int line, char *buf) |
{ |
{ |
|
|
return(mdoc_tokhash_find(mdoc->htab, key)); |
if (SEC_PROLOGUE == mdoc->lastnamed) |
|
return(mdoc_perr(mdoc, line, 0, |
|
"text disallowed in prologue")); |
|
|
|
if ( ! mdoc_word_alloc(mdoc, line, 0, buf)) |
|
return(0); |
|
|
|
mdoc->next = MDOC_NEXT_SIBLING; |
|
return(1); |
} |
} |
|
|
|
|
static void |
static int |
argcpy(struct mdoc_arg *dst, const struct mdoc_arg *src) |
macrowarn(struct mdoc *m, int ln, const char *buf) |
{ |
{ |
int i; |
if ( ! (MDOC_IGN_MACRO & m->pflags)) |
|
return(mdoc_perr(m, ln, 1, "unknown macro: %s%s", |
dst->line = src->line; |
buf, strlen(buf) > 3 ? "..." : "")); |
dst->pos = src->pos; |
return(mdoc_pwarn(m, ln, 1, WARN_SYNTAX, |
dst->arg = src->arg; |
"unknown macro: %s%s", |
if (0 == (dst->sz = src->sz)) |
buf, strlen(buf) > 3 ? "..." : "")); |
return; |
|
dst->value = xcalloc(dst->sz, sizeof(char *)); |
|
for (i = 0; i < (int)dst->sz; i++) |
|
dst->value[i] = xstrdup(src->value[i]); |
|
} |
} |
|
|
|
|
static struct mdoc_arg * |
|
argdup(size_t argsz, const struct mdoc_arg *args) |
/* |
|
* Parse a macro line, that is, a line beginning with the control |
|
* character. |
|
*/ |
|
int |
|
parsemacro(struct mdoc *m, int ln, char *buf) |
{ |
{ |
struct mdoc_arg *pp; |
int i, c; |
int i; |
char mac[5]; |
|
|
if (0 == argsz) |
/* Comments and empties are quickly ignored. */ |
return(NULL); |
|
|
|
pp = xcalloc((size_t)argsz, sizeof(struct mdoc_arg)); |
if (0 == buf[1]) |
for (i = 0; i < (int)argsz; i++) |
return(1); |
argcpy(&pp[i], &args[i]); |
|
|
|
return(pp); |
if (' ' == buf[1]) { |
} |
i = 2; |
|
while (buf[i] && ' ' == buf[i]) |
|
i++; |
|
if (0 == buf[i]) |
|
return(1); |
|
return(mdoc_perr(m, ln, 1, "invalid syntax")); |
|
} |
|
|
|
if (buf[1] && '\\' == buf[1]) |
|
if (buf[2] && '\"' == buf[2]) |
|
return(1); |
|
|
/* FIXME: deprecate. */ |
/* Copy the first word into a nil-terminated buffer. */ |
char * |
|
mdoc_node2a(struct mdoc_node *node) |
|
{ |
|
static char buf[64]; |
|
|
|
assert(node); |
for (i = 1; i < 5; i++) { |
|
if (0 == (mac[i - 1] = buf[i])) |
|
break; |
|
else if (' ' == buf[i]) |
|
break; |
|
} |
|
|
buf[0] = 0; |
mac[i - 1] = 0; |
(void)xstrlcat(buf, mdoc_type2a(node->type), 64); |
|
if (MDOC_ROOT == node->type) |
|
return(buf); |
|
(void)xstrlcat(buf, " `", 64); |
|
if (MDOC_TEXT == node->type) |
|
(void)xstrlcat(buf, node->data.text.string, 64); |
|
else |
|
(void)xstrlcat(buf, mdoc_macronames[node->tok], 64); |
|
(void)xstrlcat(buf, "'", 64); |
|
|
|
return(buf); |
if (i == 5 || i <= 2) { |
} |
if ( ! macrowarn(m, ln, mac)) |
|
goto err; |
|
return(1); |
|
} |
|
|
|
if (MDOC_MAX == (c = mdoc_tokhash_find(m->htab, mac))) { |
|
if ( ! macrowarn(m, ln, mac)) |
|
goto err; |
|
return(1); |
|
} |
|
|
|
/* The macro is sane. Jump to the next word. */ |
|
|
|
while (buf[i] && ' ' == buf[i]) |
|
i++; |
|
|
|
/* Begin recursive parse sequence. */ |
|
|
|
if ( ! mdoc_macro(m, c, ln, 1, &i, buf)) |
|
goto err; |
|
|
|
return(1); |
|
|
|
err: /* Error out. */ |
|
|
|
m->flags |= MDOC_HALT; |
|
return(0); |
|
} |