version 1.88, 2009/07/06 13:04:52 |
version 1.99, 2009/08/13 11:43:24 |
|
|
|
|
#include "libmdoc.h" |
#include "libmdoc.h" |
|
|
|
const char *const __mdoc_merrnames[MERRMAX] = { |
|
"trailing whitespace", /* ETAILWS */ |
|
"unexpected quoted parameter", /* EQUOTPARM */ |
|
"unterminated quoted parameter", /* EQUOTTERM */ |
|
"system: malloc error", /* EMALLOC */ |
|
"argument parameter suggested", /* EARGVAL */ |
|
"macro disallowed in prologue", /* EBODYPROL */ |
|
"macro disallowed in body", /* EPROLBODY */ |
|
"text disallowed in prologue", /* ETEXTPROL */ |
|
"blank line disallowed", /* ENOBLANK */ |
|
"text parameter too long", /* ETOOLONG */ |
|
"invalid escape sequence", /* EESCAPE */ |
|
"invalid character", /* EPRINT */ |
|
"document has no body", /* ENODAT */ |
|
"document has no prologue", /* ENOPROLOGUE */ |
|
"expected line arguments", /* ELINE */ |
|
"invalid AT&T argument", /* EATT */ |
|
"default name not yet set", /* ENAME */ |
|
"missing list type", /* ELISTTYPE */ |
|
"missing display type", /* EDISPTYPE */ |
|
"too many display types", /* EMULTIDISP */ |
|
"too many list types", /* EMULTILIST */ |
|
"NAME section must be first", /* ESECNAME */ |
|
"badly-formed NAME section", /* ENAMESECINC */ |
|
"argument repeated", /* EARGREP */ |
|
"expected boolean parameter", /* EBOOL */ |
|
"inconsistent column syntax", /* ECOLMIS */ |
|
"nested display invalid", /* ENESTDISP */ |
|
"width argument missing", /* EMISSWIDTH */ |
|
"invalid section for this manual section", /* EWRONGMSEC */ |
|
"section out of conventional order", /* ESECOOO */ |
|
"section repeated", /* ESECREP */ |
|
"invalid standard argument", /* EBADSTAND */ |
|
"multi-line arguments discouraged", /* ENOMULTILINE */ |
|
"multi-line arguments suggested", /* EMULTILINE */ |
|
"line arguments discouraged", /* ENOLINE */ |
|
"prologue macro out of conventional order", /* EPROLOOO */ |
|
"prologue macro repeated", /* EPROLREP */ |
|
"invalid manual section", /* EBADMSEC */ |
|
"invalid section", /* EBADSEC */ |
|
"invalid font mode", /* EFONT */ |
|
"invalid date syntax", /* EBADDATE */ |
|
"invalid number format", /* ENUMFMT */ |
|
"superfluous width argument", /* ENOWIDTH */ |
|
"system: utsname error", /* EUTSNAME */ |
|
"obsolete macro", /* EOBS */ |
|
"end-of-line scope violation", /* EIMPBRK */ |
|
"empty macro ignored", /* EIGNE */ |
|
"unclosed explicit scope", /* EOPEN */ |
|
"unterminated quoted phrase", /* EQUOTPHR */ |
|
"closure macro without prior context", /* ENOCTX */ |
|
"invalid whitespace after control character", /* ESPACE */ |
|
"no description found for library" /* ELIB */ |
|
}; |
|
|
const char *const __mdoc_macronames[MDOC_MAX] = { |
const char *const __mdoc_macronames[MDOC_MAX] = { |
"Ap", "Dd", "Dt", "Os", |
"Ap", "Dd", "Dt", "Os", |
"Sh", "Ss", "Pp", "D1", |
"Sh", "Ss", "Pp", "D1", |
Line 58 const char *const __mdoc_macronames[MDOC_MAX] = { |
|
Line 113 const char *const __mdoc_macronames[MDOC_MAX] = { |
|
/* LINTED */ |
/* LINTED */ |
"Brc", "\%C", "Es", "En", |
"Brc", "\%C", "Es", "En", |
/* LINTED */ |
/* LINTED */ |
"Dx", "\%Q" |
"Dx", "\%Q", "br", "sp" |
}; |
}; |
|
|
const char *const __mdoc_argnames[MDOC_ARG_MAX] = { |
const char *const __mdoc_argnames[MDOC_ARG_MAX] = { |
Line 85 static int node_append(struct mdoc *, |
|
Line 140 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 pstring(struct mdoc *, int, int, |
|
const char *, size_t); |
|
|
|
#ifdef __linux__ |
|
extern size_t strlcpy(char *, const char *, size_t); |
|
#endif |
|
|
|
|
const struct mdoc_node * |
const struct mdoc_node * |
mdoc_node(const struct mdoc *m) |
mdoc_node(const struct mdoc *m) |
{ |
{ |
Line 274 mdoc_vwarn(struct mdoc *mdoc, int ln, int pos, const c |
|
Line 335 mdoc_vwarn(struct mdoc *mdoc, int ln, int pos, const c |
|
int |
int |
mdoc_err(struct mdoc *m, int line, int pos, int iserr, enum merr type) |
mdoc_err(struct mdoc *m, int line, int pos, int iserr, enum merr type) |
{ |
{ |
char *p; |
const char *p; |
|
|
p = NULL; |
|
|
|
switch (type) { |
p = __mdoc_merrnames[(int)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; |
|
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); |
|
|
if (iserr) |
if (iserr) |
|
|
mdoc_macro(struct mdoc *m, int tok, |
mdoc_macro(struct mdoc *m, int tok, |
int ln, int pp, int *pos, char *buf) |
int ln, int pp, int *pos, char *buf) |
{ |
{ |
|
/* |
|
* If we're in the prologue, deny "body" macros. Similarly, if |
|
* we're in the body, deny prologue calls. |
|
*/ |
if (MDOC_PROLOGUE & mdoc_macros[tok].flags && |
if (MDOC_PROLOGUE & mdoc_macros[tok].flags && |
MDOC_PBODY & m->flags) |
MDOC_PBODY & m->flags) |
return(mdoc_perr(m, ln, pp, EPROLBODY)); |
return(mdoc_perr(m, ln, pp, EPROLBODY)); |
Line 470 mdoc_macro(struct mdoc *m, int tok, |
|
Line 362 mdoc_macro(struct mdoc *m, int tok, |
|
! (MDOC_PBODY & m->flags)) |
! (MDOC_PBODY & m->flags)) |
return(mdoc_perr(m, ln, pp, EBODYPROL)); |
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)); |
return((*mdoc_macros[tok].fp)(m, tok, ln, pp, pos, buf)); |
} |
} |
|
|
Line 542 node_append(struct mdoc *mdoc, struct mdoc_node *p) |
|
Line 431 node_append(struct mdoc *mdoc, struct mdoc_node *p) |
|
|
|
|
|
static struct mdoc_node * |
static struct mdoc_node * |
node_alloc(struct mdoc *mdoc, int line, |
node_alloc(struct mdoc *m, int line, |
int pos, int tok, enum mdoc_type type) |
int pos, int tok, enum mdoc_type type) |
{ |
{ |
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)mdoc_nerr(mdoc, mdoc->last, EMALLOC); |
(void)mdoc_nerr(m, m->last, EMALLOC); |
return(NULL); |
return(NULL); |
} |
} |
|
|
p->sec = mdoc->lastsec; |
p->sec = m->lastsec; |
p->line = line; |
p->line = line; |
p->pos = pos; |
p->pos = pos; |
p->tok = tok; |
p->tok = tok; |
Line 564 node_alloc(struct mdoc *mdoc, int line, |
|
Line 453 node_alloc(struct mdoc *mdoc, int line, |
|
|
|
|
|
int |
int |
mdoc_tail_alloc(struct mdoc *mdoc, int line, int pos, int tok) |
mdoc_tail_alloc(struct mdoc *m, int line, int pos, int tok) |
{ |
{ |
struct mdoc_node *p; |
struct mdoc_node *p; |
|
|
p = node_alloc(mdoc, line, pos, tok, MDOC_TAIL); |
p = node_alloc(m, line, pos, tok, MDOC_TAIL); |
if (NULL == p) |
if (NULL == p) |
return(0); |
return(0); |
return(node_append(mdoc, p)); |
return(node_append(m, p)); |
} |
} |
|
|
|
|
int |
int |
mdoc_head_alloc(struct mdoc *mdoc, int line, int pos, int tok) |
mdoc_head_alloc(struct mdoc *m, int line, int pos, int tok) |
{ |
{ |
struct mdoc_node *p; |
struct mdoc_node *p; |
|
|
assert(mdoc->first); |
assert(m->first); |
assert(mdoc->last); |
assert(m->last); |
|
|
p = node_alloc(mdoc, line, pos, tok, MDOC_HEAD); |
p = node_alloc(m, line, pos, tok, MDOC_HEAD); |
if (NULL == p) |
if (NULL == p) |
return(0); |
return(0); |
return(node_append(mdoc, p)); |
return(node_append(m, p)); |
} |
} |
|
|
|
|
int |
int |
mdoc_body_alloc(struct mdoc *mdoc, int line, int pos, int tok) |
mdoc_body_alloc(struct mdoc *m, int line, int pos, int tok) |
{ |
{ |
struct mdoc_node *p; |
struct mdoc_node *p; |
|
|
p = node_alloc(mdoc, line, pos, tok, MDOC_BODY); |
p = node_alloc(m, line, pos, tok, MDOC_BODY); |
if (NULL == p) |
if (NULL == p) |
return(0); |
return(0); |
return(node_append(mdoc, p)); |
return(node_append(m, p)); |
} |
} |
|
|
|
|
int |
int |
mdoc_block_alloc(struct mdoc *mdoc, int line, int pos, |
mdoc_block_alloc(struct mdoc *m, int line, int pos, |
int tok, struct mdoc_arg *args) |
int tok, struct mdoc_arg *args) |
{ |
{ |
struct mdoc_node *p; |
struct mdoc_node *p; |
|
|
p = node_alloc(mdoc, line, pos, tok, MDOC_BLOCK); |
p = node_alloc(m, line, pos, tok, MDOC_BLOCK); |
if (NULL == p) |
if (NULL == p) |
return(0); |
return(0); |
p->args = args; |
p->args = args; |
if (p->args) |
if (p->args) |
(args->refcnt)++; |
(args->refcnt)++; |
return(node_append(mdoc, p)); |
return(node_append(m, p)); |
} |
} |
|
|
|
|
int |
int |
mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos, |
mdoc_elem_alloc(struct mdoc *m, int line, int pos, |
int tok, struct mdoc_arg *args) |
int tok, struct mdoc_arg *args) |
{ |
{ |
struct mdoc_node *p; |
struct mdoc_node *p; |
|
|
p = node_alloc(mdoc, line, pos, tok, MDOC_ELEM); |
p = node_alloc(m, line, pos, tok, MDOC_ELEM); |
if (NULL == p) |
if (NULL == p) |
return(0); |
return(0); |
p->args = args; |
p->args = args; |
if (p->args) |
if (p->args) |
(args->refcnt)++; |
(args->refcnt)++; |
return(node_append(mdoc, p)); |
return(node_append(m, p)); |
} |
} |
|
|
|
|
int |
static int |
mdoc_word_alloc(struct mdoc *mdoc, |
pstring(struct mdoc *m, int line, int pos, const char *p, size_t len) |
int line, int pos, const char *word) |
|
{ |
{ |
struct mdoc_node *p; |
struct mdoc_node *n; |
|
size_t sv; |
|
|
p = node_alloc(mdoc, line, pos, -1, MDOC_TEXT); |
n = node_alloc(m, line, pos, -1, MDOC_TEXT); |
if (NULL == p) |
if (NULL == n) |
return(0); |
return(mdoc_nerr(m, m->last, EMALLOC)); |
if (NULL == (p->string = strdup(word))) { |
|
(void)mdoc_nerr(mdoc, mdoc->last, EMALLOC); |
n->string = malloc(len + 1); |
return(0); |
if (NULL == n->string) { |
|
free(n); |
|
return(mdoc_nerr(m, m->last, EMALLOC)); |
} |
} |
|
|
return(node_append(mdoc, p)); |
sv = strlcpy(n->string, p, len + 1); |
|
|
|
/* Prohibit truncation. */ |
|
assert(sv < len + 1); |
|
|
|
return(node_append(m, n)); |
} |
} |
|
|
|
|
|
int |
|
mdoc_word_alloc(struct mdoc *m, int line, int pos, const char *p) |
|
{ |
|
|
|
return(pstring(m, line, pos, p, strlen(p))); |
|
} |
|
|
|
|
void |
void |
mdoc_node_free(struct mdoc_node *p) |
mdoc_node_free(struct mdoc_node *p) |
{ |
{ |
Line 687 mdoc_node_freelist(struct mdoc_node *p) |
|
Line 591 mdoc_node_freelist(struct mdoc_node *p) |
|
static int |
static int |
parsetext(struct mdoc *m, int line, char *buf) |
parsetext(struct mdoc *m, int line, char *buf) |
{ |
{ |
|
int i, j; |
|
|
if (SEC_NONE == m->lastnamed) |
if (SEC_NONE == m->lastnamed) |
return(mdoc_perr(m, line, 0, ETEXTPROL)); |
return(mdoc_perr(m, line, 0, ETEXTPROL)); |
|
|
|
/* |
|
* If in literal mode, then pass the buffer directly to the |
|
* back-end, as it should be preserved as a single term. |
|
*/ |
|
|
if (0 == buf[0] && ! (MDOC_LITERAL & m->flags)) |
if (MDOC_LITERAL & m->flags) { |
|
if ( ! mdoc_word_alloc(m, line, 0, buf)) |
|
return(0); |
|
m->next = MDOC_NEXT_SIBLING; |
|
return(1); |
|
} |
|
|
|
/* Disallow blank/white-space lines in non-literal mode. */ |
|
|
|
for (i = 0; ' ' == buf[i]; i++) |
|
/* Skip leading whitespace. */ ; |
|
if (0 == buf[i]) |
return(mdoc_perr(m, line, 0, ENOBLANK)); |
return(mdoc_perr(m, line, 0, ENOBLANK)); |
|
|
if ( ! mdoc_word_alloc(m, line, 0, buf)) |
/* |
|
* Break apart a free-form line into tokens. Spaces are |
|
* stripped out of the input. |
|
*/ |
|
|
|
for (j = i; buf[i]; i++) { |
|
if (' ' != buf[i]) |
|
continue; |
|
|
|
/* Escaped whitespace. */ |
|
if (i && ' ' == buf[i] && '\\' == buf[i - 1]) |
|
continue; |
|
|
|
buf[i++] = 0; |
|
if ( ! pstring(m, line, j, &buf[j], (size_t)(i - j))) |
|
return(0); |
|
m->next = MDOC_NEXT_SIBLING; |
|
|
|
for ( ; ' ' == buf[i]; i++) |
|
/* Skip trailing whitespace. */ ; |
|
|
|
j = i; |
|
if (0 == buf[i]) |
|
break; |
|
} |
|
|
|
if (j != i && ! pstring(m, line, j, &buf[j], (size_t)(i - j))) |
return(0); |
return(0); |
|
|
m->next = MDOC_NEXT_SIBLING; |
m->next = MDOC_NEXT_SIBLING; |
Line 702 parsetext(struct mdoc *m, int line, char *buf) |
|
Line 649 parsetext(struct mdoc *m, int line, char *buf) |
|
} |
} |
|
|
|
|
|
|
|
|
static int |
static int |
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_verr(m, ln, 1, |
return(mdoc_verr(m, ln, 0, |
"unknown macro: %s%s", |
"unknown macro: %s%s", |
buf, strlen(buf) > 3 ? "..." : "")); |
buf, strlen(buf) > 3 ? "..." : "")); |
return(mdoc_vwarn(m, ln, 1, "unknown macro: %s%s", |
return(mdoc_vwarn(m, ln, 0, "unknown macro: %s%s", |
buf, strlen(buf) > 3 ? "..." : "")); |
buf, strlen(buf) > 3 ? "..." : "")); |
} |
} |
|
|
Line 726 parsemacro(struct mdoc *m, int ln, char *buf) |
|
Line 675 parsemacro(struct mdoc *m, int ln, char *buf) |
|
|
|
/* Empty lines are ignored. */ |
/* Empty lines are ignored. */ |
|
|
|
/* FIXME: this can accept `. xx' like libman! */ |
|
|
if (0 == buf[1]) |
if (0 == buf[1]) |
return(1); |
return(1); |
|
|
Line 766 parsemacro(struct mdoc *m, int ln, char *buf) |
|
Line 717 parsemacro(struct mdoc *m, int ln, char *buf) |
|
while (buf[i] && ' ' == buf[i]) |
while (buf[i] && ' ' == buf[i]) |
i++; |
i++; |
|
|
/* Begin recursive parse sequence. */ |
/* |
|
* Begin recursive parse sequence. Since we're at the start of |
|
* the line, we don't need to do callable/parseable checks. |
|
*/ |
if ( ! mdoc_macro(m, c, ln, 1, &i, buf)) |
if ( ! mdoc_macro(m, c, ln, 1, &i, buf)) |
goto err; |
goto err; |
|
|