version 1.69, 2009/03/21 09:42:07 |
version 1.136, 2010/05/17 22:11:42 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org> |
* Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se> |
* |
* |
* 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 above |
* above copyright notice and this permission notice appear in all |
* copyright notice and this permission notice appear in all copies. |
* copies. |
|
* |
* |
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL |
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
* WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED |
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
* WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE |
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
* AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL |
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
* DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR |
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
* PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER |
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR |
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
* PERFORMANCE OF THIS SOFTWARE. |
|
*/ |
*/ |
|
#ifdef HAVE_CONFIG_H |
|
#include "config.h" |
|
#endif |
|
|
|
#include <sys/types.h> |
|
|
#include <assert.h> |
#include <assert.h> |
#include <ctype.h> |
#include <ctype.h> |
#include <err.h> |
|
#include <stdarg.h> |
#include <stdarg.h> |
#include <stdlib.h> |
|
#include <stdio.h> |
#include <stdio.h> |
|
#include <stdlib.h> |
#include <string.h> |
#include <string.h> |
|
#include <time.h> |
|
|
#include "private.h" |
#include "mandoc.h" |
|
#include "libmdoc.h" |
|
#include "libmandoc.h" |
|
|
/* |
|
* Main caller in the libmdoc library. This begins the parsing routine, |
|
* handles allocation of data, and so forth. Most of the "work" is done |
|
* in macro.c, validate.c and action.c. |
|
*/ |
|
|
|
static struct mdoc_node *mdoc_node_alloc(const struct mdoc *); |
|
static int mdoc_node_append(struct mdoc *, |
|
struct mdoc_node *); |
|
|
|
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", |
"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 53 const char *const __mdoc_macronames[MDOC_MAX] = { |
|
Line 44 const char *const __mdoc_macronames[MDOC_MAX] = { |
|
"Nm", "Op", "Ot", "Pa", |
"Nm", "Op", "Ot", "Pa", |
"Rv", "St", "Va", "Vt", |
"Rv", "St", "Va", "Vt", |
/* LINTED */ |
/* LINTED */ |
"Xr", "\%A", "\%B", "\%D", |
"Xr", "%A", "%B", "%D", |
/* LINTED */ |
/* LINTED */ |
"\%I", "\%J", "\%N", "\%O", |
"%I", "%J", "%N", "%O", |
/* LINTED */ |
/* LINTED */ |
"\%P", "\%R", "\%T", "\%V", |
"%P", "%R", "%T", "%V", |
"Ac", "Ao", "Aq", "At", |
"Ac", "Ao", "Aq", "At", |
"Bc", "Bf", "Bo", "Bq", |
"Bc", "Bf", "Bo", "Bq", |
"Bsx", "Bx", "Db", "Dc", |
"Bsx", "Bx", "Db", "Dc", |
Line 71 const char *const __mdoc_macronames[MDOC_MAX] = { |
|
Line 62 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", "br", "sp", |
|
/* LINTED */ |
|
"%U" |
}; |
}; |
|
|
const char *const __mdoc_argnames[MDOC_ARG_MAX] = { |
const char *const __mdoc_argnames[MDOC_ARG_MAX] = { |
Line 88 const char *const __mdoc_argnames[MDOC_ARG_MAX] = { |
|
Line 81 const char *const __mdoc_argnames[MDOC_ARG_MAX] = { |
|
"ohang", "inset", "column", |
"ohang", "inset", "column", |
"width", "compact", "std", |
"width", "compact", "std", |
"filled", "words", "emphasis", |
"filled", "words", "emphasis", |
"symbolic", "nested" |
"symbolic", "nested", "centered" |
}; |
}; |
|
|
const char * const *mdoc_macronames = __mdoc_macronames; |
const char * const *mdoc_macronames = __mdoc_macronames; |
const char * const *mdoc_argnames = __mdoc_argnames; |
const char * const *mdoc_argnames = __mdoc_argnames; |
|
|
|
static void mdoc_node_free(struct mdoc_node *); |
|
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, |
|
enum mdoct, enum mdoc_type); |
|
static int node_append(struct mdoc *, |
|
struct mdoc_node *); |
|
static int mdoc_ptext(struct mdoc *, int, char *, int); |
|
static int mdoc_pmacro(struct mdoc *, int, char *, int); |
|
static int macrowarn(struct mdoc *, int, |
|
const char *, int); |
|
|
/* |
|
* Get the first (root) node of the parse tree. |
|
*/ |
|
const struct mdoc_node * |
const struct mdoc_node * |
mdoc_node(const struct mdoc *mdoc) |
mdoc_node(const struct mdoc *m) |
{ |
{ |
|
|
if (MDOC_HALT & mdoc->flags) |
return(MDOC_HALT & m->flags ? NULL : m->first); |
return(NULL); |
|
if (mdoc->first) |
|
assert(MDOC_ROOT == mdoc->first->type); |
|
return(mdoc->first); |
|
} |
} |
|
|
|
|
const struct mdoc_meta * |
const struct mdoc_meta * |
mdoc_meta(const struct mdoc *mdoc) |
mdoc_meta(const struct mdoc *m) |
{ |
{ |
|
|
if (MDOC_HALT & mdoc->flags) |
return(MDOC_HALT & m->flags ? NULL : &m->meta); |
return(NULL); |
|
return(&mdoc->meta); |
|
} |
} |
|
|
|
|
/* |
/* |
* Free up all resources contributed by a parse: the node tree, meta-data and |
* Frees volatile resources (parse tree, meta-data, fields). |
* so on. Then reallocate the root node for another parse. |
|
*/ |
*/ |
void |
static void |
mdoc_reset(struct mdoc *mdoc) |
mdoc_free1(struct mdoc *mdoc) |
{ |
{ |
|
|
if (mdoc->first) |
if (mdoc->first) |
mdoc_node_freelist(mdoc->first); |
mdoc_node_delete(mdoc, mdoc->first); |
if (mdoc->meta.title) |
if (mdoc->meta.title) |
free(mdoc->meta.title); |
free(mdoc->meta.title); |
if (mdoc->meta.os) |
if (mdoc->meta.os) |
Line 140 mdoc_reset(struct mdoc *mdoc) |
|
Line 137 mdoc_reset(struct mdoc *mdoc) |
|
free(mdoc->meta.arch); |
free(mdoc->meta.arch); |
if (mdoc->meta.vol) |
if (mdoc->meta.vol) |
free(mdoc->meta.vol); |
free(mdoc->meta.vol); |
|
if (mdoc->meta.msec) |
|
free(mdoc->meta.msec); |
|
} |
|
|
bzero(&mdoc->meta, sizeof(struct mdoc_meta)); |
|
mdoc->flags = 0; |
|
mdoc->lastnamed = mdoc->lastsec = 0; |
|
|
|
mdoc->first = mdoc->last = |
/* |
xcalloc(1, sizeof(struct mdoc_node)); |
* Allocate all volatile resources (parse tree, meta-data, fields). |
|
*/ |
|
static void |
|
mdoc_alloc1(struct mdoc *mdoc) |
|
{ |
|
|
|
memset(&mdoc->meta, 0, sizeof(struct mdoc_meta)); |
|
mdoc->flags = 0; |
|
mdoc->lastnamed = mdoc->lastsec = SEC_NONE; |
|
mdoc->last = mandoc_calloc(1, sizeof(struct mdoc_node)); |
|
mdoc->first = mdoc->last; |
mdoc->last->type = MDOC_ROOT; |
mdoc->last->type = MDOC_ROOT; |
mdoc->next = MDOC_NEXT_CHILD; |
mdoc->next = MDOC_NEXT_CHILD; |
} |
} |
|
|
|
|
/* |
/* |
* Completely free up all resources. |
* Free up volatile resources (see mdoc_free1()) then re-initialises the |
|
* data with mdoc_alloc1(). After invocation, parse data has been reset |
|
* and the parser is ready for re-invocation on a new tree; however, |
|
* cross-parse non-volatile data is kept intact. |
*/ |
*/ |
void |
void |
mdoc_free(struct mdoc *mdoc) |
mdoc_reset(struct mdoc *mdoc) |
{ |
{ |
|
|
if (mdoc->first) |
mdoc_free1(mdoc); |
mdoc_node_freelist(mdoc->first); |
mdoc_alloc1(mdoc); |
if (mdoc->meta.title) |
} |
free(mdoc->meta.title); |
|
if (mdoc->meta.os) |
|
free(mdoc->meta.os); |
|
if (mdoc->meta.name) |
|
free(mdoc->meta.name); |
|
if (mdoc->meta.arch) |
|
free(mdoc->meta.arch); |
|
if (mdoc->meta.vol) |
|
free(mdoc->meta.vol); |
|
|
|
if (mdoc->htab) |
|
mdoc_tokhash_free(mdoc->htab); |
|
|
|
|
/* |
|
* Completely free up all volatile and non-volatile parse resources. |
|
* After invocation, the pointer is no longer usable. |
|
*/ |
|
void |
|
mdoc_free(struct mdoc *mdoc) |
|
{ |
|
|
|
mdoc_free1(mdoc); |
free(mdoc); |
free(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, mandocmsg msg) |
{ |
{ |
struct mdoc *p; |
struct mdoc *p; |
|
|
p = xcalloc(1, sizeof(struct mdoc)); |
p = mandoc_calloc(1, sizeof(struct mdoc)); |
|
|
|
p->msg = msg; |
p->data = data; |
p->data = data; |
if (cb) |
|
(void)memcpy(&p->cb, cb, sizeof(struct mdoc_cb)); |
|
|
|
p->last = p->first = |
|
xcalloc(1, sizeof(struct mdoc_node)); |
|
p->last->type = MDOC_ROOT; |
|
p->pflags = pflags; |
p->pflags = pflags; |
p->next = MDOC_NEXT_CHILD; |
|
p->htab = mdoc_tokhash_alloc(); |
mdoc_hash_init(); |
|
mdoc_alloc1(p); |
return(p); |
return(p); |
} |
} |
|
|
|
|
/* |
/* |
* 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 *mdoc) |
mdoc_endparse(struct mdoc *m) |
{ |
{ |
|
|
if (MDOC_HALT & mdoc->flags) |
if (MDOC_HALT & m->flags) |
return(0); |
return(0); |
if (NULL == mdoc->first) |
else if (mdoc_macroend(m)) |
return(1); |
return(1); |
|
m->flags |= MDOC_HALT; |
assert(mdoc->last); |
return(0); |
if ( ! macro_end(mdoc)) { |
|
mdoc->flags |= MDOC_HALT; |
|
return(0); |
|
} |
|
return(1); |
|
} |
} |
|
|
|
|
/* |
/* |
* 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 (mdoc_pmacro()) or text parser (mdoc_ptext()). |
*/ |
*/ |
int |
int |
mdoc_parseln(struct mdoc *m, int ln, char *buf) |
mdoc_parseln(struct mdoc *m, int ln, char *buf, int offs) |
{ |
{ |
|
|
/* If in error-mode, then we parse no more. */ |
|
|
|
if (MDOC_HALT & m->flags) |
if (MDOC_HALT & m->flags) |
return(0); |
return(0); |
|
|
return('.' == *buf ? parsemacro(m, ln, buf) : |
m->flags |= MDOC_NEWLINE; |
parsetext(m, ln, buf)); |
return(('.' == buf[offs] || '\'' == buf[offs]) ? |
|
mdoc_pmacro(m, ln, buf, offs) : |
|
mdoc_ptext(m, ln, buf, offs)); |
} |
} |
|
|
|
|
void |
|
mdoc_vmsg(struct mdoc *mdoc, int ln, int pos, const char *fmt, ...) |
|
{ |
|
char buf[256]; |
|
va_list ap; |
|
|
|
if (NULL == mdoc->cb.mdoc_msg) |
|
return; |
|
|
|
va_start(ap, fmt); |
|
(void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap); |
|
va_end(ap); |
|
(*mdoc->cb.mdoc_msg)(mdoc->data, ln, pos, buf); |
|
} |
|
|
|
|
|
int |
int |
mdoc_verr(struct mdoc *mdoc, int ln, int pos, |
mdoc_vmsg(struct mdoc *mdoc, enum mandocerr t, |
const char *fmt, ...) |
int ln, int pos, const char *fmt, ...) |
{ |
{ |
char buf[256]; |
char buf[256]; |
va_list ap; |
va_list ap; |
|
|
if (NULL == mdoc->cb.mdoc_err) |
|
return(0); |
|
|
|
va_start(ap, fmt); |
va_start(ap, fmt); |
(void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap); |
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->msg)(t, mdoc->data, ln, pos, buf)); |
int |
|
mdoc_vwarn(struct mdoc *mdoc, int ln, 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, ln, pos, type, buf)); |
|
} |
} |
|
|
|
|
int |
int |
mdoc_macro(struct mdoc *m, int tok, |
mdoc_macro(struct mdoc *m, enum mdoct tok, |
int ln, int pp, int *pos, char *buf) |
int ln, int pp, int *pos, char *buf) |
{ |
{ |
|
assert(tok < MDOC_MAX); |
|
|
/* FIXME - these should happen during validation. */ |
/* If we're in the body, deny prologue calls. */ |
|
|
if (MDOC_PROLOGUE & mdoc_macros[tok].flags && |
if (MDOC_PROLOGUE & mdoc_macros[tok].flags && |
SEC_PROLOGUE != m->lastnamed) |
MDOC_PBODY & m->flags) |
return(mdoc_perr(m, ln, pp, |
return(mdoc_pmsg(m, ln, pp, MANDOCERR_BADBODY)); |
"disallowed in document body")); |
|
|
|
|
/* If we're in the prologue, deny "body" macros. */ |
|
|
if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) && |
if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) && |
SEC_PROLOGUE == m->lastnamed) |
! (MDOC_PBODY & m->flags)) { |
return(mdoc_perr(m, ln, pp, |
if ( ! mdoc_pmsg(m, ln, pp, MANDOCERR_BADPROLOG)) |
"disallowed in prologue")); |
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 (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)); |
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) |
node_append(struct mdoc *mdoc, struct mdoc_node *p) |
{ |
{ |
|
|
assert(mdoc->last); |
assert(mdoc->last); |
Line 338 mdoc_node_append(struct mdoc *mdoc, struct mdoc_node * |
|
Line 313 mdoc_node_append(struct mdoc *mdoc, struct mdoc_node * |
|
/* 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 361 mdoc_node_append(struct mdoc *mdoc, struct mdoc_node * |
|
Line 338 mdoc_node_append(struct mdoc *mdoc, struct mdoc_node * |
|
} |
} |
|
|
mdoc->last = p; |
mdoc->last = p; |
|
|
|
switch (p->type) { |
|
case (MDOC_TEXT): |
|
if ( ! mdoc_valid_post(mdoc)) |
|
return(0); |
|
if ( ! mdoc_action_post(mdoc)) |
|
return(0); |
|
break; |
|
default: |
|
break; |
|
} |
|
|
return(1); |
return(1); |
} |
} |
|
|
|
|
static struct mdoc_node * |
static struct mdoc_node * |
mdoc_node_alloc(const struct mdoc *mdoc) |
node_alloc(struct mdoc *m, int line, int pos, |
|
enum mdoct tok, enum mdoc_type type) |
{ |
{ |
struct mdoc_node *p; |
struct mdoc_node *p; |
|
|
p = xcalloc(1, sizeof(struct mdoc_node)); |
p = mandoc_calloc(1, sizeof(struct mdoc_node)); |
p->sec = mdoc->lastsec; |
p->sec = m->lastsec; |
|
|
return(p); |
|
} |
|
|
|
|
|
int |
|
mdoc_tail_alloc(struct mdoc *mdoc, int line, int pos, int tok) |
|
{ |
|
struct mdoc_node *p; |
|
|
|
assert(mdoc->first); |
|
assert(mdoc->last); |
|
|
|
p = mdoc_node_alloc(mdoc); |
|
|
|
p->line = line; |
p->line = line; |
p->pos = pos; |
p->pos = pos; |
p->type = MDOC_TAIL; |
|
p->tok = tok; |
p->tok = tok; |
|
p->type = type; |
return(mdoc_node_append(mdoc, p)); |
if (MDOC_NEWLINE & m->flags) |
|
p->flags |= MDOC_LINE; |
|
m->flags &= ~MDOC_NEWLINE; |
|
return(p); |
} |
} |
|
|
|
|
int |
int |
mdoc_head_alloc(struct mdoc *mdoc, int line, int pos, int tok) |
mdoc_tail_alloc(struct mdoc *m, int line, int pos, enum mdoct tok) |
{ |
{ |
struct mdoc_node *p; |
struct mdoc_node *p; |
|
|
assert(mdoc->first); |
p = node_alloc(m, line, pos, tok, MDOC_TAIL); |
assert(mdoc->last); |
if ( ! node_append(m, p)) |
|
return(0); |
p = mdoc_node_alloc(mdoc); |
m->next = MDOC_NEXT_CHILD; |
|
return(1); |
p->line = line; |
|
p->pos = pos; |
|
p->type = MDOC_HEAD; |
|
p->tok = tok; |
|
|
|
return(mdoc_node_append(mdoc, p)); |
|
} |
} |
|
|
|
|
int |
int |
mdoc_body_alloc(struct mdoc *mdoc, int line, int pos, int tok) |
mdoc_head_alloc(struct mdoc *m, int line, int pos, enum mdoct tok) |
{ |
{ |
struct mdoc_node *p; |
struct mdoc_node *p; |
|
|
assert(mdoc->first); |
assert(m->first); |
assert(mdoc->last); |
assert(m->last); |
|
|
p = mdoc_node_alloc(mdoc); |
p = node_alloc(m, line, pos, tok, MDOC_HEAD); |
|
if ( ! node_append(m, p)) |
p->line = line; |
return(0); |
p->pos = pos; |
m->next = MDOC_NEXT_CHILD; |
p->type = MDOC_BODY; |
return(1); |
p->tok = tok; |
|
|
|
return(mdoc_node_append(mdoc, p)); |
|
} |
} |
|
|
|
|
int |
int |
mdoc_root_alloc(struct mdoc *mdoc) |
mdoc_body_alloc(struct mdoc *m, int line, int pos, enum mdoct tok) |
{ |
{ |
struct mdoc_node *p; |
struct mdoc_node *p; |
|
|
p = mdoc_node_alloc(mdoc); |
p = node_alloc(m, line, pos, tok, MDOC_BODY); |
|
if ( ! node_append(m, p)) |
p->type = MDOC_ROOT; |
return(0); |
|
m->next = MDOC_NEXT_CHILD; |
return(mdoc_node_append(mdoc, p)); |
return(1); |
} |
} |
|
|
|
|
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) |
enum mdoct tok, struct mdoc_arg *args) |
{ |
{ |
struct mdoc_node *p; |
struct mdoc_node *p; |
|
|
p = mdoc_node_alloc(mdoc); |
p = node_alloc(m, line, pos, tok, MDOC_BLOCK); |
|
|
p->pos = pos; |
|
p->line = line; |
|
p->type = MDOC_BLOCK; |
|
p->tok = tok; |
|
p->args = args; |
p->args = args; |
|
if (p->args) |
if (args) |
|
(args->refcnt)++; |
(args->refcnt)++; |
|
if ( ! node_append(m, p)) |
return(mdoc_node_append(mdoc, p)); |
return(0); |
|
m->next = MDOC_NEXT_CHILD; |
|
return(1); |
} |
} |
|
|
|
|
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) |
enum mdoct tok, struct mdoc_arg *args) |
{ |
{ |
struct mdoc_node *p; |
struct mdoc_node *p; |
|
|
p = mdoc_node_alloc(mdoc); |
p = node_alloc(m, line, pos, tok, MDOC_ELEM); |
|
|
p->line = line; |
|
p->pos = pos; |
|
p->type = MDOC_ELEM; |
|
p->tok = tok; |
|
p->args = args; |
p->args = args; |
|
if (p->args) |
if (args) |
|
(args->refcnt)++; |
(args->refcnt)++; |
|
if ( ! node_append(m, p)) |
return(mdoc_node_append(mdoc, p)); |
return(0); |
|
m->next = MDOC_NEXT_CHILD; |
|
return(1); |
} |
} |
|
|
|
|
int |
int |
mdoc_word_alloc(struct mdoc *mdoc, |
mdoc_word_alloc(struct mdoc *m, int line, int pos, const char *p) |
int line, int pos, const char *word) |
|
{ |
{ |
struct mdoc_node *p; |
struct mdoc_node *n; |
|
size_t sv, len; |
|
|
p = mdoc_node_alloc(mdoc); |
len = strlen(p); |
|
|
p->line = line; |
n = node_alloc(m, line, pos, MDOC_MAX, MDOC_TEXT); |
p->pos = pos; |
n->string = mandoc_malloc(len + 1); |
p->type = MDOC_TEXT; |
sv = strlcpy(n->string, p, len + 1); |
p->string = xstrdup(word); |
|
|
|
return(mdoc_node_append(mdoc, p)); |
/* Prohibit truncation. */ |
|
assert(sv < len + 1); |
|
|
|
if ( ! node_append(m, n)) |
|
return(0); |
|
|
|
m->next = MDOC_NEXT_SIBLING; |
|
return(1); |
} |
} |
|
|
|
|
Line 518 mdoc_node_free(struct mdoc_node *p) |
|
Line 484 mdoc_node_free(struct mdoc_node *p) |
|
} |
} |
|
|
|
|
|
static void |
|
mdoc_node_unlink(struct mdoc *m, struct mdoc_node *n) |
|
{ |
|
|
|
/* Adjust siblings. */ |
|
|
|
if (n->prev) |
|
n->prev->next = n->next; |
|
if (n->next) |
|
n->next->prev = n->prev; |
|
|
|
/* Adjust parent. */ |
|
|
|
if (n->parent) { |
|
n->parent->nchild--; |
|
if (n->parent->child == n) |
|
n->parent->child = n->prev ? n->prev : n->next; |
|
} |
|
|
|
/* Adjust parse point, if applicable. */ |
|
|
|
if (m && m->last == n) { |
|
if (n->prev) { |
|
m->last = n->prev; |
|
m->next = MDOC_NEXT_SIBLING; |
|
} else { |
|
m->last = n->parent; |
|
m->next = MDOC_NEXT_CHILD; |
|
} |
|
} |
|
|
|
if (m && m->first == n) |
|
m->first = NULL; |
|
} |
|
|
|
|
void |
void |
mdoc_node_freelist(struct mdoc_node *p) |
mdoc_node_delete(struct mdoc *m, struct mdoc_node *p) |
{ |
{ |
|
|
if (p->child) |
while (p->child) { |
mdoc_node_freelist(p->child); |
assert(p->nchild); |
if (p->next) |
mdoc_node_delete(m, p->child); |
mdoc_node_freelist(p->next); |
} |
|
assert(0 == p->nchild); |
|
|
|
mdoc_node_unlink(m, p); |
mdoc_node_free(p); |
mdoc_node_free(p); |
} |
} |
|
|
Line 536 mdoc_node_freelist(struct mdoc_node *p) |
|
Line 540 mdoc_node_freelist(struct mdoc_node *p) |
|
* control character. |
* control character. |
*/ |
*/ |
static int |
static int |
parsetext(struct mdoc *m, int line, char *buf) |
mdoc_ptext(struct mdoc *m, int line, char *buf, int offs) |
{ |
{ |
|
int i; |
|
|
if (SEC_PROLOGUE == m->lastnamed) |
/* Ignore bogus comments. */ |
return(mdoc_perr(m, line, 0, |
|
"text disallowed in prologue")); |
|
|
|
if (0 == buf[0] && ! (MDOC_LITERAL & m->flags)) |
if ('\\' == buf[offs] && |
return(mdoc_perr(m, line, 0, |
'.' == buf[offs + 1] && |
"blank lines only in literal context")); |
'"' == buf[offs + 2]) |
|
return(mdoc_pmsg(m, line, offs, MANDOCERR_BADCOMMENT)); |
|
|
if ( ! mdoc_word_alloc(m, line, 0, buf)) |
/* No text before an initial macro. */ |
|
|
|
if (SEC_NONE == m->lastnamed) |
|
return(mdoc_pmsg(m, line, offs, MANDOCERR_NOTEXT)); |
|
|
|
/* Literal just gets pulled in as-is. */ |
|
|
|
if (MDOC_LITERAL & m->flags) |
|
return(mdoc_word_alloc(m, line, offs, buf + offs)); |
|
|
|
/* Check for a blank line, which may also consist of spaces. */ |
|
|
|
for (i = offs; ' ' == buf[i]; i++) |
|
/* Skip to first non-space. */ ; |
|
|
|
if ('\0' == buf[i]) { |
|
if ( ! mdoc_pmsg(m, line, offs, MANDOCERR_NOBLANKLN)) |
|
return(0); |
|
|
|
/* |
|
* Insert a `Pp' 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)) |
|
return(0); |
|
|
|
m->next = MDOC_NEXT_SIBLING; |
|
return(1); |
|
} |
|
|
|
/* |
|
* Warn if the last un-escaped character is whitespace. Then |
|
* strip away the remaining spaces (tabs stay!). |
|
*/ |
|
|
|
i = (int)strlen(buf); |
|
assert(i); |
|
|
|
if (' ' == buf[i - 1] || '\t' == buf[i - 1]) { |
|
if (i > 1 && '\\' != buf[i - 2]) |
|
if ( ! mdoc_pmsg(m, line, i - 1, MANDOCERR_EOLNSPACE)) |
|
return(0); |
|
|
|
for (--i; i && ' ' == buf[i]; i--) |
|
/* Spin back to non-space. */ ; |
|
|
|
/* Jump ahead of escaped whitespace. */ |
|
i += '\\' == buf[i] ? 2 : 1; |
|
|
|
buf[i] = '\0'; |
|
} |
|
|
|
/* Allocate the whole word. */ |
|
|
|
if ( ! mdoc_word_alloc(m, line, offs, buf + offs)) |
return(0); |
return(0); |
|
|
m->next = MDOC_NEXT_SIBLING; |
/* |
|
* End-of-sentence check. If the last character is an unescaped |
|
* EOS character, then flag the node as being the end of a |
|
* sentence. The front-end will know how to interpret this. |
|
*/ |
|
|
|
assert(i); |
|
if (mandoc_eos(buf, (size_t)i)) |
|
m->last->flags |= MDOC_EOS; |
|
|
return(1); |
return(1); |
} |
} |
|
|
|
|
static int |
static int |
macrowarn(struct mdoc *m, int ln, const char *buf) |
macrowarn(struct mdoc *m, int ln, const char *buf, int offs) |
{ |
{ |
if ( ! (MDOC_IGN_MACRO & m->pflags)) |
int rc; |
return(mdoc_perr(m, ln, 1, "unknown macro: %s%s", |
|
buf, strlen(buf) > 3 ? "..." : "")); |
|
return(mdoc_pwarn(m, ln, 1, WARN_SYNTAX, |
|
"unknown macro: %s%s", |
|
buf, strlen(buf) > 3 ? "..." : "")); |
|
} |
|
|
|
|
rc = mdoc_vmsg(m, MANDOCERR_MACRO, ln, offs, |
|
"unknown macro: %s%s", |
|
buf, strlen(buf) > 3 ? "..." : ""); |
|
|
|
/* FIXME: logic should be in driver. */ |
|
return(MDOC_IGN_MACRO & m->pflags ? rc : 0); |
|
} |
|
|
|
|
/* |
/* |
* 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. |
*/ |
*/ |
int |
int |
parsemacro(struct mdoc *m, int ln, char *buf) |
mdoc_pmacro(struct mdoc *m, int ln, char *buf, int offs) |
{ |
{ |
int i, c; |
enum mdoct tok; |
char mac[5]; |
int i, j, sv; |
|
char mac[5]; |
|
|
/* Comments and empties are quickly ignored. */ |
/* Empty lines are ignored. */ |
|
|
if (0 == buf[1]) |
offs++; |
|
|
|
if ('\0' == buf[offs]) |
return(1); |
return(1); |
|
|
if (' ' == buf[1]) { |
i = offs; |
i = 2; |
|
|
/* Accept whitespace after the initial control char. */ |
|
|
|
if (' ' == buf[i]) { |
|
i++; |
while (buf[i] && ' ' == buf[i]) |
while (buf[i] && ' ' == buf[i]) |
i++; |
i++; |
if (0 == buf[i]) |
if ('\0' == buf[i]) |
return(1); |
return(1); |
return(mdoc_perr(m, ln, 1, "invalid syntax")); |
|
} |
} |
|
|
if (buf[1] && '\\' == buf[1]) |
sv = i; |
if (buf[2] && '\"' == buf[2]) |
|
return(1); |
|
|
|
/* Copy the first word into a nil-terminated buffer. */ |
/* Copy the first word into a nil-terminated buffer. */ |
|
|
for (i = 1; i < 5; i++) { |
for (j = 0; j < 4; j++, i++) { |
if (0 == (mac[i - 1] = buf[i])) |
if ('\0' == (mac[j] = buf[i])) |
break; |
break; |
else if (' ' == buf[i]) |
else if (' ' == buf[i]) |
break; |
break; |
|
|
|
/* Check for invalid characters. */ |
|
|
|
if (isgraph((u_char)buf[i])) |
|
continue; |
|
if ( ! mdoc_pmsg(m, ln, i, MANDOCERR_BADCHAR)) |
|
return(0); |
|
i--; |
} |
} |
|
|
mac[i - 1] = 0; |
mac[j] = '\0'; |
|
|
if (i == 5 || i <= 2) { |
if (j == 4 || j < 2) { |
if ( ! macrowarn(m, ln, mac)) |
if ( ! macrowarn(m, ln, mac, sv)) |
goto err; |
goto err; |
return(1); |
return(1); |
} |
} |
|
|
if (MDOC_MAX == (c = mdoc_tokhash_find(m->htab, mac))) { |
if (MDOC_MAX == (tok = mdoc_hash_find(mac))) { |
if ( ! macrowarn(m, ln, mac)) |
if ( ! macrowarn(m, ln, mac, sv)) |
goto err; |
goto err; |
return(1); |
return(1); |
} |
} |
Line 624 parsemacro(struct mdoc *m, int ln, char *buf) |
|
Line 705 parsemacro(struct mdoc *m, int ln, char *buf) |
|
while (buf[i] && ' ' == buf[i]) |
while (buf[i] && ' ' == buf[i]) |
i++; |
i++; |
|
|
/* Begin recursive parse sequence. */ |
/* |
|
* Trailing whitespace. Note that tabs are allowed to be passed |
|
* into the parser as "text", so we only warn about spaces here. |
|
*/ |
|
|
if ( ! mdoc_macro(m, c, ln, 1, &i, buf)) |
if ('\0' == buf[i] && ' ' == buf[i - 1]) |
goto err; |
if ( ! mdoc_pmsg(m, ln, i - 1, MANDOCERR_EOLNSPACE)) |
|
goto err; |
|
|
/* |
/* |
* If we're in literal mode, then add a newline to the end of |
* Begin recursive parse sequence. Since we're at the start of |
* macro lines. Our frontends will interpret this correctly |
* the line, we don't need to do callable/parseable checks. |
* (it's documented in mdoc.3). |
|
*/ |
*/ |
|
if ( ! mdoc_macro(m, tok, ln, sv, &i, buf)) |
|
goto err; |
|
|
return(1); |
return(1); |
|
|
Line 642 err: /* Error out. */ |
|
Line 728 err: /* Error out. */ |
|
m->flags |= MDOC_HALT; |
m->flags |= MDOC_HALT; |
return(0); |
return(0); |
} |
} |
|
|
|
|