version 1.84, 2009/06/17 07:59:47 |
version 1.250, 2015/04/19 14:57:38 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se> |
* Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
|
* Copyright (c) 2010, 2012-2015 Ingo Schwarze <schwarze@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 above |
* purpose with or without fee is hereby granted, provided that the above |
* copyright notice and this permission notice appear in all copies. |
* copyright notice and this permission notice appear in all copies. |
* |
* |
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES |
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR |
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
*/ |
*/ |
|
#include "config.h" |
|
|
|
#include <sys/types.h> |
|
|
#include <assert.h> |
#include <assert.h> |
#include <ctype.h> |
#include <ctype.h> |
#include <stdarg.h> |
#include <stdarg.h> |
#include <stdio.h> |
#include <stdio.h> |
#include <stdlib.h> |
#include <stdlib.h> |
#include <string.h> |
#include <string.h> |
|
#include <time.h> |
|
|
|
#include "mandoc_aux.h" |
|
#include "mandoc.h" |
|
#include "roff.h" |
|
#include "mdoc.h" |
|
#include "libmandoc.h" |
|
#include "roff_int.h" |
#include "libmdoc.h" |
#include "libmdoc.h" |
|
|
enum merr { |
const char *const __mdoc_macronames[MDOC_MAX + 1] = { |
ENOCALL, |
"text", |
EBODYPROL, |
|
EPROLBODY, |
|
ESPACE, |
|
ETEXTPROL, |
|
ENOBLANK, |
|
EMALLOC |
|
}; |
|
|
|
const char *const __mdoc_macronames[MDOC_MAX] = { |
|
"Ap", "Dd", "Dt", "Os", |
"Ap", "Dd", "Dt", "Os", |
"Sh", "Ss", "Pp", "D1", |
"Sh", "Ss", "Pp", "D1", |
"Dl", "Bd", "Ed", "Bl", |
"Dl", "Bd", "Ed", "Bl", |
Line 44 const char *const __mdoc_macronames[MDOC_MAX] = { |
|
Line 47 const char *const __mdoc_macronames[MDOC_MAX] = { |
|
"Ic", "In", "Li", "Nd", |
"Ic", "In", "Li", "Nd", |
"Nm", "Op", "Ot", "Pa", |
"Nm", "Op", "Ot", "Pa", |
"Rv", "St", "Va", "Vt", |
"Rv", "St", "Va", "Vt", |
/* LINTED */ |
"Xr", "%A", "%B", "%D", |
"Xr", "\%A", "\%B", "\%D", |
"%I", "%J", "%N", "%O", |
/* LINTED */ |
"%P", "%R", "%T", "%V", |
"\%I", "\%J", "\%N", "\%O", |
|
/* LINTED */ |
|
"\%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 65 const char *const __mdoc_macronames[MDOC_MAX] = { |
|
Line 65 const char *const __mdoc_macronames[MDOC_MAX] = { |
|
"Bk", "Ek", "Bt", "Hf", |
"Bk", "Ek", "Bt", "Hf", |
"Fr", "Ud", "Lb", "Lp", |
"Fr", "Ud", "Lb", "Lp", |
"Lk", "Mt", "Brq", "Bro", |
"Lk", "Mt", "Brq", "Bro", |
/* LINTED */ |
"Brc", "%C", "Es", "En", |
"Brc", "\%C", "Es", "En", |
"Dx", "%Q", "br", "sp", |
/* LINTED */ |
"%U", "Ta", "ll", |
"Dx", "\%Q" |
}; |
}; |
|
|
|
const char *const __mdoc_argnames[MDOC_ARG_MAX] = { |
const char *const __mdoc_argnames[MDOC_ARG_MAX] = { |
"split", "nosplit", "ragged", |
"split", "nosplit", "ragged", |
"unfilled", "literal", "file", |
"unfilled", "literal", "file", |
"offset", "bullet", "dash", |
"offset", "bullet", "dash", |
"hyphen", "item", "enum", |
"hyphen", "item", "enum", |
"tag", "diag", "hang", |
"tag", "diag", "hang", |
"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 + 1; |
const char * const *mdoc_argnames = __mdoc_argnames; |
const char * const *mdoc_argnames = __mdoc_argnames; |
|
|
static void mdoc_free1(struct mdoc *); |
static int mdoc_ptext(struct roff_man *, int, char *, int); |
static int mdoc_alloc1(struct mdoc *); |
static int mdoc_pmacro(struct roff_man *, int, char *, int); |
static struct mdoc_node *node_alloc(struct mdoc *, int, int, |
|
int, enum mdoc_type); |
|
static int 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 *); |
|
static int perr(struct mdoc *, int, int, enum merr); |
|
|
|
const struct mdoc_node * |
|
mdoc_node(const struct mdoc *m) |
|
{ |
|
|
|
return(MDOC_HALT & m->flags ? NULL : m->first); |
void |
} |
mdoc_endparse(struct roff_man *mdoc) |
|
|
|
|
const struct mdoc_meta * |
|
mdoc_meta(const struct mdoc *m) |
|
{ |
{ |
|
|
return(MDOC_HALT & m->flags ? NULL : &m->meta); |
mdoc_macroend(mdoc); |
} |
} |
|
|
|
|
static void |
|
mdoc_free1(struct mdoc *mdoc) |
|
{ |
|
|
|
if (mdoc->first) |
|
mdoc_node_freelist(mdoc->first); |
|
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); |
|
} |
|
|
|
|
|
static int |
|
mdoc_alloc1(struct mdoc *mdoc) |
|
{ |
|
|
|
bzero(&mdoc->meta, sizeof(struct mdoc_meta)); |
|
mdoc->flags = 0; |
|
mdoc->lastnamed = mdoc->lastsec = 0; |
|
mdoc->last = calloc(1, sizeof(struct mdoc_node)); |
|
if (NULL == mdoc->last) |
|
return(0); |
|
|
|
mdoc->first = mdoc->last; |
|
mdoc->last->type = MDOC_ROOT; |
|
mdoc->next = MDOC_NEXT_CHILD; |
|
return(1); |
|
} |
|
|
|
|
|
/* |
/* |
* Free up all resources contributed by a parse: the node tree, |
* Main parse routine. Parses a single line -- really just hands off to |
* meta-data and so on. Then reallocate the root node for another |
* the macro (mdoc_pmacro()) or text parser (mdoc_ptext()). |
* parse. |
|
*/ |
*/ |
int |
int |
mdoc_reset(struct mdoc *mdoc) |
mdoc_parseln(struct roff_man *mdoc, int ln, char *buf, int offs) |
{ |
{ |
|
|
mdoc_free1(mdoc); |
if (mdoc->last->type != ROFFT_EQN || ln > mdoc->last->line) |
return(mdoc_alloc1(mdoc)); |
mdoc->flags |= MDOC_NEWLINE; |
} |
|
|
|
|
/* |
|
* Let the roff nS register switch SYNOPSIS mode early, |
|
* such that the parser knows at all times |
|
* whether this mode is on or off. |
|
* Note that this mode is also switched by the Sh macro. |
|
*/ |
|
if (roff_getreg(mdoc->roff, "nS")) |
|
mdoc->flags |= MDOC_SYNOPSIS; |
|
else |
|
mdoc->flags &= ~MDOC_SYNOPSIS; |
|
|
/* |
return(roff_getcontrol(mdoc->roff, buf, &offs) ? |
* Completely free up all resources. |
mdoc_pmacro(mdoc, ln, buf, offs) : |
*/ |
mdoc_ptext(mdoc, ln, buf, offs)); |
void |
|
mdoc_free(struct mdoc *mdoc) |
|
{ |
|
|
|
mdoc_free1(mdoc); |
|
if (mdoc->htab) |
|
mdoc_hash_free(mdoc->htab); |
|
free(mdoc); |
|
} |
} |
|
|
|
void |
struct mdoc * |
mdoc_macro(MACRO_PROT_ARGS) |
mdoc_alloc(void *data, int pflags, const struct mdoc_cb *cb) |
|
{ |
{ |
struct mdoc *p; |
assert(tok > TOKEN_NONE && tok < MDOC_MAX); |
|
|
if (NULL == (p = calloc(1, sizeof(struct mdoc)))) |
if (mdoc->flags & MDOC_PBODY) { |
return(NULL); |
if (tok == MDOC_Dt) { |
if (cb) |
mandoc_vmsg(MANDOCERR_DT_LATE, |
(void)memcpy(&p->cb, cb, sizeof(struct mdoc_cb)); |
mdoc->parse, line, ppos, |
|
"Dt %s", buf + *pos); |
p->data = data; |
return; |
p->pflags = pflags; |
} |
|
} else if ( ! (mdoc_macros[tok].flags & MDOC_PROLOGUE)) { |
if (NULL == (p->htab = mdoc_hash_alloc())) { |
if (mdoc->meta.title == NULL) { |
free(p); |
mandoc_vmsg(MANDOCERR_DT_NOTITLE, |
return(NULL); |
mdoc->parse, line, ppos, "%s %s", |
} else if (mdoc_alloc1(p)) |
mdoc_macronames[tok], buf + *pos); |
return(p); |
mdoc->meta.title = mandoc_strdup("UNTITLED"); |
|
} |
free(p); |
if (NULL == mdoc->meta.vol) |
return(NULL); |
mdoc->meta.vol = mandoc_strdup("LOCAL"); |
|
mdoc->flags |= MDOC_PBODY; |
|
} |
|
(*mdoc_macros[tok].fp)(mdoc, tok, line, ppos, pos, buf); |
} |
} |
|
|
|
void |
/* |
mdoc_tail_alloc(struct roff_man *mdoc, int line, int pos, int tok) |
* Climb back up the parse tree, validating open scopes. Mostly calls |
|
* through to macro_end in macro.c. |
|
*/ |
|
int |
|
mdoc_endparse(struct mdoc *m) |
|
{ |
{ |
|
struct roff_node *p; |
|
|
if (MDOC_HALT & m->flags) |
p = roff_node_alloc(mdoc, line, pos, ROFFT_TAIL, tok); |
return(0); |
roff_node_append(mdoc, p); |
else if (mdoc_macroend(m)) |
mdoc->next = ROFF_NEXT_CHILD; |
return(1); |
|
m->flags |= MDOC_HALT; |
|
return(0); |
|
} |
} |
|
|
|
struct roff_node * |
/* |
mdoc_endbody_alloc(struct roff_man *mdoc, int line, int pos, int tok, |
* Main parse routine. Parses a single line -- really just hands off to |
struct roff_node *body, enum mdoc_endbody end) |
* the macro or text parser. |
|
*/ |
|
int |
|
mdoc_parseln(struct mdoc *m, int ln, char *buf) |
|
{ |
{ |
|
struct roff_node *p; |
|
|
if (MDOC_HALT & m->flags) |
body->flags |= MDOC_ENDED; |
return(0); |
body->parent->flags |= MDOC_ENDED; |
|
p = roff_node_alloc(mdoc, line, pos, ROFFT_BODY, tok); |
return('.' == *buf ? parsemacro(m, ln, buf) : |
p->body = body; |
parsetext(m, ln, buf)); |
p->norm = body->norm; |
|
p->end = end; |
|
roff_node_append(mdoc, p); |
|
mdoc->next = ROFF_NEXT_SIBLING; |
|
return(p); |
} |
} |
|
|
|
struct roff_node * |
int |
mdoc_block_alloc(struct roff_man *mdoc, int line, int pos, |
mdoc_verr(struct mdoc *mdoc, int ln, int pos, |
int tok, struct mdoc_arg *args) |
const char *fmt, ...) |
|
{ |
{ |
char buf[256]; |
struct roff_node *p; |
va_list ap; |
|
|
|
if (NULL == mdoc->cb.mdoc_err) |
p = roff_node_alloc(mdoc, line, pos, ROFFT_BLOCK, tok); |
return(0); |
p->args = args; |
|
if (p->args) |
|
(args->refcnt)++; |
|
|
va_start(ap, fmt); |
switch (tok) { |
(void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap); |
case MDOC_Bd: |
va_end(ap); |
/* FALLTHROUGH */ |
return((*mdoc->cb.mdoc_err)(mdoc->data, ln, pos, buf)); |
case MDOC_Bf: |
|
/* FALLTHROUGH */ |
|
case MDOC_Bl: |
|
/* FALLTHROUGH */ |
|
case MDOC_En: |
|
/* FALLTHROUGH */ |
|
case MDOC_Rs: |
|
p->norm = mandoc_calloc(1, sizeof(union mdoc_data)); |
|
break; |
|
default: |
|
break; |
|
} |
|
roff_node_append(mdoc, p); |
|
mdoc->next = ROFF_NEXT_CHILD; |
|
return(p); |
} |
} |
|
|
|
void |
int |
mdoc_elem_alloc(struct roff_man *mdoc, int line, int pos, |
mdoc_vwarn(struct mdoc *mdoc, int ln, int pos, |
int tok, struct mdoc_arg *args) |
enum mdoc_warn type, const char *fmt, ...) |
|
{ |
{ |
char buf[256]; |
struct roff_node *p; |
va_list ap; |
|
|
|
if (NULL == mdoc->cb.mdoc_warn) |
p = roff_node_alloc(mdoc, line, pos, ROFFT_ELEM, tok); |
return(0); |
p->args = args; |
|
if (p->args) |
|
(args->refcnt)++; |
|
|
va_start(ap, fmt); |
switch (tok) { |
(void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap); |
case MDOC_An: |
va_end(ap); |
p->norm = mandoc_calloc(1, sizeof(union mdoc_data)); |
return((*mdoc->cb.mdoc_warn)(mdoc->data, ln, pos, type, buf)); |
break; |
|
default: |
|
break; |
|
} |
|
roff_node_append(mdoc, p); |
|
mdoc->next = ROFF_NEXT_CHILD; |
} |
} |
|
|
|
void |
int |
mdoc_node_relink(struct roff_man *mdoc, struct roff_node *p) |
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) |
roff_node_unlink(mdoc, p); |
return(0); |
roff_node_append(mdoc, p); |
|
|
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 |
* Parse free-form text, that is, a line that does not begin with the |
mdoc_warn(struct mdoc *mdoc, enum mdoc_warn type, |
* control character. |
const char *fmt, ...) |
*/ |
|
static int |
|
mdoc_ptext(struct roff_man *mdoc, int line, char *buf, int offs) |
{ |
{ |
char buf[256]; |
struct roff_node *n; |
va_list ap; |
char *c, *ws, *end; |
|
|
if (NULL == mdoc->cb.mdoc_warn) |
assert(mdoc->last); |
return(0); |
n = mdoc->last; |
|
|
va_start(ap, fmt); |
/* |
(void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap); |
* Divert directly to list processing if we're encountering a |
va_end(ap); |
* columnar ROFFT_BLOCK with or without a prior ROFFT_BLOCK entry |
return((*mdoc->cb.mdoc_warn)(mdoc->data, mdoc->last->line, |
* (a ROFFT_BODY means it's already open, in which case we should |
mdoc->last->pos, type, buf)); |
* process within its context in the normal way). |
} |
*/ |
|
|
|
if (n->tok == MDOC_Bl && n->type == ROFFT_BODY && |
|
n->end == ENDBODY_NOT && n->norm->Bl.type == LIST_column) { |
|
/* `Bl' is open without any children. */ |
|
mdoc->flags |= MDOC_FREECOL; |
|
mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf); |
|
return(1); |
|
} |
|
|
int |
if (n->tok == MDOC_It && n->type == ROFFT_BLOCK && |
mdoc_err(struct mdoc *mdoc, const char *fmt, ...) |
NULL != n->parent && |
{ |
MDOC_Bl == n->parent->tok && |
char buf[256]; |
LIST_column == n->parent->norm->Bl.type) { |
va_list ap; |
/* `Bl' has block-level `It' children. */ |
|
mdoc->flags |= MDOC_FREECOL; |
|
mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf); |
|
return(1); |
|
} |
|
|
if (NULL == mdoc->cb.mdoc_err) |
/* |
return(0); |
* Search for the beginning of unescaped trailing whitespace (ws) |
|
* and for the first character not to be output (end). |
|
*/ |
|
|
va_start(ap, fmt); |
/* FIXME: replace with strcspn(). */ |
(void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap); |
ws = NULL; |
va_end(ap); |
for (c = end = buf + offs; *c; c++) { |
return((*mdoc->cb.mdoc_err)(mdoc->data, mdoc->last->line, |
switch (*c) { |
mdoc->last->pos, buf)); |
case ' ': |
} |
if (NULL == ws) |
|
ws = c; |
|
continue; |
|
case '\t': |
|
/* |
|
* Always warn about trailing tabs, |
|
* even outside literal context, |
|
* where they should be put on the next line. |
|
*/ |
|
if (NULL == ws) |
|
ws = c; |
|
/* |
|
* Strip trailing tabs in literal context only; |
|
* outside, they affect the next line. |
|
*/ |
|
if (MDOC_LITERAL & mdoc->flags) |
|
continue; |
|
break; |
|
case '\\': |
|
/* Skip the escaped character, too, if any. */ |
|
if (c[1]) |
|
c++; |
|
/* FALLTHROUGH */ |
|
default: |
|
ws = NULL; |
|
break; |
|
} |
|
end = c + 1; |
|
} |
|
*end = '\0'; |
|
|
|
if (ws) |
|
mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse, |
|
line, (int)(ws-buf), NULL); |
|
|
int |
if (buf[offs] == '\0' && ! (mdoc->flags & MDOC_LITERAL)) { |
mdoc_pwarn(struct mdoc *mdoc, int line, int pos, enum mdoc_warn type, |
mandoc_msg(MANDOCERR_FI_BLANK, mdoc->parse, |
const char *fmt, ...) |
line, (int)(c - buf), NULL); |
{ |
|
char buf[256]; |
|
va_list ap; |
|
|
|
if (NULL == mdoc->cb.mdoc_warn) |
/* |
return(0); |
* Insert a `sp' 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. |
|
*/ |
|
roff_elem_alloc(mdoc, line, offs, MDOC_sp); |
|
mdoc->next = ROFF_NEXT_SIBLING; |
|
mdoc_valid_post(mdoc); |
|
return(1); |
|
} |
|
|
va_start(ap, fmt); |
roff_word_alloc(mdoc, line, offs, buf+offs); |
(void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap); |
|
va_end(ap); |
|
return((*mdoc->cb.mdoc_warn)(mdoc->data, |
|
line, pos, type, buf)); |
|
} |
|
|
|
int |
if (mdoc->flags & MDOC_LITERAL) |
mdoc_perr(struct mdoc *mdoc, int line, int pos, const char *fmt, ...) |
return(1); |
{ |
|
char buf[256]; |
|
va_list ap; |
|
|
|
if (NULL == mdoc->cb.mdoc_err) |
/* |
return(0); |
* 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. |
|
*/ |
|
|
va_start(ap, fmt); |
assert(buf < end); |
(void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap); |
|
va_end(ap); |
|
return((*mdoc->cb.mdoc_err)(mdoc->data, line, pos, buf)); |
|
} |
|
|
|
|
if (mandoc_eos(buf+offs, (size_t)(end-buf-offs))) |
int |
mdoc->last->flags |= MDOC_EOS; |
mdoc_macro(struct mdoc *m, int tok, |
return(1); |
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)); |
|
} |
} |
|
|
|
/* |
|
* Parse a macro line, that is, a line beginning with the control |
|
* character. |
|
*/ |
static int |
static int |
perr(struct mdoc *m, int line, int pos, enum merr type) |
mdoc_pmacro(struct roff_man *mdoc, int ln, char *buf, int offs) |
{ |
{ |
char *p; |
struct roff_node *n; |
|
const char *cp; |
|
int tok; |
|
int i, sv; |
|
char mac[5]; |
|
|
p = NULL; |
sv = offs; |
switch (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; |
|
} |
|
assert(p); |
|
return(mdoc_perr(m, line, pos, p)); |
|
} |
|
|
|
|
/* |
|
* Copy the first word into a nil-terminated buffer. |
|
* Stop when a space, tab, escape, or eoln is encountered. |
|
*/ |
|
|
static int |
i = 0; |
node_append(struct mdoc *mdoc, struct mdoc_node *p) |
while (i < 4 && strchr(" \t\\", buf[offs]) == NULL) |
{ |
mac[i++] = buf[offs++]; |
|
|
assert(mdoc->last); |
mac[i] = '\0'; |
assert(mdoc->first); |
|
assert(MDOC_ROOT != p->type); |
|
|
|
switch (mdoc->next) { |
tok = (i > 1 && i < 4) ? mdoc_hash_find(mac) : TOKEN_NONE; |
case (MDOC_NEXT_SIBLING): |
|
mdoc->last->next = p; |
if (tok == TOKEN_NONE) { |
p->prev = mdoc->last; |
mandoc_msg(MANDOCERR_MACRO, mdoc->parse, |
p->parent = mdoc->last->parent; |
ln, sv, buf + sv - 1); |
break; |
return(1); |
case (MDOC_NEXT_CHILD): |
|
mdoc->last->child = p; |
|
p->parent = mdoc->last; |
|
break; |
|
default: |
|
abort(); |
|
/* NOTREACHED */ |
|
} |
} |
|
|
if ( ! mdoc_valid_pre(mdoc, p)) |
/* Skip a leading escape sequence or tab. */ |
return(0); |
|
if ( ! mdoc_action_pre(mdoc, p)) |
|
return(0); |
|
|
|
switch (p->type) { |
switch (buf[offs]) { |
case (MDOC_HEAD): |
case '\\': |
assert(MDOC_BLOCK == p->parent->type); |
cp = buf + offs + 1; |
p->parent->head = p; |
mandoc_escape(&cp, NULL, NULL); |
|
offs = cp - buf; |
break; |
break; |
case (MDOC_TAIL): |
case '\t': |
assert(MDOC_BLOCK == p->parent->type); |
offs++; |
p->parent->tail = p; |
|
break; |
break; |
case (MDOC_BODY): |
|
assert(MDOC_BLOCK == p->parent->type); |
|
p->parent->body = p; |
|
break; |
|
default: |
default: |
break; |
break; |
} |
} |
|
|
mdoc->last = p; |
/* Jump to the next non-whitespace word. */ |
|
|
switch (p->type) { |
while (buf[offs] && ' ' == buf[offs]) |
case (MDOC_TEXT): |
offs++; |
if ( ! mdoc_valid_post(mdoc)) |
|
return(0); |
|
if ( ! mdoc_action_post(mdoc)) |
|
return(0); |
|
break; |
|
default: |
|
break; |
|
} |
|
|
|
return(1); |
/* |
} |
* 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]) |
|
mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse, |
|
ln, offs - 1, NULL); |
|
|
static struct mdoc_node * |
/* |
node_alloc(struct mdoc *mdoc, int line, |
* If an initial macro or a list invocation, divert directly |
int pos, int tok, enum mdoc_type type) |
* into macro processing. |
{ |
*/ |
struct mdoc_node *p; |
|
|
|
if (NULL == (p = calloc(1, sizeof(struct mdoc_node)))) { |
if (NULL == mdoc->last || MDOC_It == tok || MDOC_El == tok) { |
(void)perr(mdoc, (mdoc)->last->line, |
mdoc_macro(mdoc, tok, ln, sv, &offs, buf); |
(mdoc)->last->pos, EMALLOC); |
return(1); |
return(NULL); |
|
} |
} |
|
|
p->sec = mdoc->lastsec; |
n = mdoc->last; |
p->line = line; |
|
p->pos = pos; |
|
p->tok = tok; |
|
if (MDOC_TEXT != (p->type = type)) |
|
assert(p->tok >= 0); |
|
|
|
return(p); |
|
} |
|
|
|
|
|
int |
|
mdoc_tail_alloc(struct mdoc *mdoc, int line, int pos, int tok) |
|
{ |
|
struct mdoc_node *p; |
|
|
|
p = node_alloc(mdoc, line, pos, tok, MDOC_TAIL); |
|
if (NULL == p) |
|
return(0); |
|
return(node_append(mdoc, p)); |
|
} |
|
|
|
|
|
int |
|
mdoc_head_alloc(struct mdoc *mdoc, int line, int pos, int tok) |
|
{ |
|
struct mdoc_node *p; |
|
|
|
assert(mdoc->first); |
|
assert(mdoc->last); |
assert(mdoc->last); |
|
|
p = node_alloc(mdoc, line, pos, tok, MDOC_HEAD); |
/* |
if (NULL == p) |
* If the first macro of a `Bl -column', open an `It' block |
return(0); |
* context around the parsed macro. |
return(node_append(mdoc, p)); |
*/ |
} |
|
|
|
|
if (n->tok == MDOC_Bl && n->type == ROFFT_BODY && |
|
n->end == ENDBODY_NOT && n->norm->Bl.type == LIST_column) { |
|
mdoc->flags |= MDOC_FREECOL; |
|
mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf); |
|
return(1); |
|
} |
|
|
int |
/* |
mdoc_body_alloc(struct mdoc *mdoc, int line, int pos, int tok) |
* If we're following a block-level `It' within a `Bl -column' |
{ |
* context (perhaps opened in the above block or in ptext()), |
struct mdoc_node *p; |
* then open an `It' block context around the parsed macro. |
|
*/ |
|
|
p = node_alloc(mdoc, line, pos, tok, MDOC_BODY); |
if (n->tok == MDOC_It && n->type == ROFFT_BLOCK && |
if (NULL == p) |
NULL != n->parent && |
return(0); |
MDOC_Bl == n->parent->tok && |
return(node_append(mdoc, p)); |
LIST_column == n->parent->norm->Bl.type) { |
} |
mdoc->flags |= MDOC_FREECOL; |
|
mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf); |
|
return(1); |
int |
|
mdoc_block_alloc(struct mdoc *mdoc, int line, int pos, |
|
int tok, struct mdoc_arg *args) |
|
{ |
|
struct mdoc_node *p; |
|
|
|
p = node_alloc(mdoc, line, pos, tok, MDOC_BLOCK); |
|
if (NULL == p) |
|
return(0); |
|
p->args = args; |
|
if (p->args) |
|
(args->refcnt)++; |
|
return(node_append(mdoc, p)); |
|
} |
|
|
|
|
|
int |
|
mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos, |
|
int tok, struct mdoc_arg *args) |
|
{ |
|
struct mdoc_node *p; |
|
|
|
p = node_alloc(mdoc, line, pos, tok, MDOC_ELEM); |
|
if (NULL == p) |
|
return(0); |
|
p->args = args; |
|
if (p->args) |
|
(args->refcnt)++; |
|
return(node_append(mdoc, p)); |
|
} |
|
|
|
|
|
int |
|
mdoc_word_alloc(struct mdoc *mdoc, |
|
int line, int pos, const char *word) |
|
{ |
|
struct mdoc_node *p; |
|
|
|
p = node_alloc(mdoc, line, pos, -1, MDOC_TEXT); |
|
if (NULL == p) |
|
return(0); |
|
if (NULL == (p->string = strdup(word))) { |
|
(void)perr(mdoc, (mdoc)->last->line, |
|
(mdoc)->last->pos, EMALLOC); |
|
return(0); |
|
} |
} |
return(node_append(mdoc, p)); |
|
} |
|
|
|
|
/* Normal processing of a macro. */ |
|
|
void |
mdoc_macro(mdoc, tok, ln, sv, &offs, buf); |
mdoc_node_free(struct mdoc_node *p) |
|
{ |
|
|
|
if (p->string) |
/* In quick mode (for mandocdb), abort after the NAME section. */ |
free(p->string); |
|
if (p->args) |
|
mdoc_argv_free(p->args); |
|
free(p); |
|
} |
|
|
|
|
if (mdoc->quick && MDOC_Sh == tok && |
|
SEC_NAME != mdoc->last->sec) |
|
return(2); |
|
|
void |
return(1); |
mdoc_node_freelist(struct mdoc_node *p) |
|
{ |
|
|
|
if (p->child) |
|
mdoc_node_freelist(p->child); |
|
if (p->next) |
|
mdoc_node_freelist(p->next); |
|
|
|
mdoc_node_free(p); |
|
} |
} |
|
|
|
enum mdelim |
/* |
mdoc_isdelim(const char *p) |
* Parse free-form text, that is, a line that does not begin with the |
|
* control character. |
|
*/ |
|
static int |
|
parsetext(struct mdoc *m, int line, char *buf) |
|
{ |
{ |
|
|
if (SEC_PROLOGUE == m->lastnamed) |
if ('\0' == p[0]) |
return(perr(m, line, 0, ETEXTPROL)); |
return(DELIM_NONE); |
|
|
if (0 == buf[0] && ! (MDOC_LITERAL & m->flags)) |
if ('\0' == p[1]) |
return(perr(m, line, 0, ENOBLANK)); |
switch (p[0]) { |
|
case '(': |
|
/* FALLTHROUGH */ |
|
case '[': |
|
return(DELIM_OPEN); |
|
case '|': |
|
return(DELIM_MIDDLE); |
|
case '.': |
|
/* FALLTHROUGH */ |
|
case ',': |
|
/* FALLTHROUGH */ |
|
case ';': |
|
/* FALLTHROUGH */ |
|
case ':': |
|
/* FALLTHROUGH */ |
|
case '?': |
|
/* FALLTHROUGH */ |
|
case '!': |
|
/* FALLTHROUGH */ |
|
case ')': |
|
/* FALLTHROUGH */ |
|
case ']': |
|
return(DELIM_CLOSE); |
|
default: |
|
return(DELIM_NONE); |
|
} |
|
|
if ( ! mdoc_word_alloc(m, line, 0, buf)) |
if ('\\' != p[0]) |
return(0); |
return(DELIM_NONE); |
|
|
m->next = MDOC_NEXT_SIBLING; |
if (0 == strcmp(p + 1, ".")) |
return(1); |
return(DELIM_CLOSE); |
} |
if (0 == strcmp(p + 1, "fR|\\fP")) |
|
return(DELIM_MIDDLE); |
|
|
|
return(DELIM_NONE); |
static int |
|
macrowarn(struct mdoc *m, int ln, const char *buf) |
|
{ |
|
if ( ! (MDOC_IGN_MACRO & m->pflags)) |
|
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 ? "..." : "")); |
|
} |
} |
|
|
|
void |
/* |
mdoc_deroff(char **dest, const struct roff_node *n) |
* Parse a macro line, that is, a line beginning with the control |
|
* character. |
|
*/ |
|
int |
|
parsemacro(struct mdoc *m, int ln, char *buf) |
|
{ |
{ |
int i, c; |
char *cp; |
char mac[5]; |
size_t sz; |
|
|
/* Empty lines are ignored. */ |
if (n->type != ROFFT_TEXT) { |
|
for (n = n->child; n; n = n->next) |
if (0 == buf[1]) |
mdoc_deroff(dest, n); |
return(1); |
return; |
|
|
if (' ' == buf[1]) { |
|
i = 2; |
|
while (buf[i] && ' ' == buf[i]) |
|
i++; |
|
if (0 == buf[i]) |
|
return(1); |
|
return(perr(m, ln, 1, ESPACE)); |
|
} |
} |
|
|
/* Copy the first word into a nil-terminated buffer. */ |
/* Skip leading whitespace. */ |
|
|
for (i = 1; i < 5; i++) { |
for (cp = n->string; '\0' != *cp; cp++) |
if (0 == (mac[i - 1] = buf[i])) |
if (0 == isspace((unsigned char)*cp)) |
break; |
break; |
else if (' ' == buf[i]) |
|
break; |
|
} |
|
|
|
mac[i - 1] = 0; |
/* Skip trailing whitespace. */ |
|
|
if (i == 5 || i <= 2) { |
for (sz = strlen(cp); sz; sz--) |
if ( ! macrowarn(m, ln, mac)) |
if (0 == isspace((unsigned char)cp[sz-1])) |
goto err; |
break; |
return(1); |
|
} |
|
|
|
if (MDOC_MAX == (c = mdoc_hash_find(m->htab, mac))) { |
|
if ( ! macrowarn(m, ln, mac)) |
|
goto err; |
|
return(1); |
|
} |
|
|
|
/* The macro is sane. Jump to the next word. */ |
/* Skip empty strings. */ |
|
|
while (buf[i] && ' ' == buf[i]) |
if (0 == sz) |
i++; |
return; |
|
|
/* Begin recursive parse sequence. */ |
if (NULL == *dest) { |
|
*dest = mandoc_strndup(cp, sz); |
|
return; |
|
} |
|
|
if ( ! mdoc_macro(m, c, ln, 1, &i, buf)) |
mandoc_asprintf(&cp, "%s %*s", *dest, (int)sz, cp); |
goto err; |
free(*dest); |
|
*dest = cp; |
return(1); |
|
|
|
err: /* Error out. */ |
|
|
|
m->flags |= MDOC_HALT; |
|
return(0); |
|
} |
} |