version 1.136, 2010/05/17 22:11:42 |
version 1.265, 2017/06/07 20:30:40 |
|
|
/* $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-2017 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. |
*/ |
*/ |
#ifdef HAVE_CONFIG_H |
|
#include "config.h" |
#include "config.h" |
#endif |
|
|
|
#include <sys/types.h> |
#include <sys/types.h> |
|
|
|
|
#include <string.h> |
#include <string.h> |
#include <time.h> |
#include <time.h> |
|
|
|
#include "mandoc_aux.h" |
#include "mandoc.h" |
#include "mandoc.h" |
#include "libmdoc.h" |
#include "roff.h" |
|
#include "mdoc.h" |
#include "libmandoc.h" |
#include "libmandoc.h" |
|
#include "roff_int.h" |
|
#include "libmdoc.h" |
|
|
const char *const __mdoc_macronames[MDOC_MAX] = { |
const char *const __mdoc_argnames[MDOC_ARG_MAX] = { |
"Ap", "Dd", "Dt", "Os", |
|
"Sh", "Ss", "Pp", "D1", |
|
"Dl", "Bd", "Ed", "Bl", |
|
"El", "It", "Ad", "An", |
|
"Ar", "Cd", "Cm", "Dv", |
|
"Er", "Ev", "Ex", "Fa", |
|
"Fd", "Fl", "Fn", "Ft", |
|
"Ic", "In", "Li", "Nd", |
|
"Nm", "Op", "Ot", "Pa", |
|
"Rv", "St", "Va", "Vt", |
|
/* LINTED */ |
|
"Xr", "%A", "%B", "%D", |
|
/* LINTED */ |
|
"%I", "%J", "%N", "%O", |
|
/* LINTED */ |
|
"%P", "%R", "%T", "%V", |
|
"Ac", "Ao", "Aq", "At", |
|
"Bc", "Bf", "Bo", "Bq", |
|
"Bsx", "Bx", "Db", "Dc", |
|
"Do", "Dq", "Ec", "Ef", |
|
"Em", "Eo", "Fx", "Ms", |
|
"No", "Ns", "Nx", "Ox", |
|
"Pc", "Pf", "Po", "Pq", |
|
"Qc", "Ql", "Qo", "Qq", |
|
"Re", "Rs", "Sc", "So", |
|
"Sq", "Sm", "Sx", "Sy", |
|
"Tn", "Ux", "Xc", "Xo", |
|
"Fo", "Fc", "Oo", "Oc", |
|
"Bk", "Ek", "Bt", "Hf", |
|
"Fr", "Ud", "Lb", "Lp", |
|
"Lk", "Mt", "Brq", "Bro", |
|
/* LINTED */ |
|
"Brc", "%C", "Es", "En", |
|
/* LINTED */ |
|
"Dx", "%Q", "br", "sp", |
|
/* LINTED */ |
|
"%U" |
|
}; |
|
|
|
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", "centered" |
"symbolic", "nested", "centered" |
}; |
}; |
|
|
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 int mdoc_ptext(struct roff_man *, int, char *, int); |
static void mdoc_node_unlink(struct mdoc *, |
static int mdoc_pmacro(struct roff_man *, int, char *, int); |
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); |
|
|
|
|
|
const struct mdoc_node * |
|
mdoc_node(const struct mdoc *m) |
|
{ |
|
|
|
return(MDOC_HALT & m->flags ? NULL : m->first); |
|
} |
|
|
|
|
|
const struct mdoc_meta * |
|
mdoc_meta(const struct mdoc *m) |
|
{ |
|
|
|
return(MDOC_HALT & m->flags ? NULL : &m->meta); |
|
} |
|
|
|
|
|
/* |
/* |
* Frees volatile resources (parse tree, meta-data, fields). |
* Main parse routine. Parses a single line -- really just hands off to |
|
* the macro (mdoc_pmacro()) or text parser (mdoc_ptext()). |
*/ |
*/ |
static void |
int |
mdoc_free1(struct mdoc *mdoc) |
mdoc_parseln(struct roff_man *mdoc, int ln, char *buf, int offs) |
{ |
{ |
|
|
if (mdoc->first) |
if (mdoc->last->type != ROFFT_EQN || ln > mdoc->last->line) |
mdoc_node_delete(mdoc, mdoc->first); |
mdoc->flags |= MDOC_NEWLINE; |
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->meta.msec) |
|
free(mdoc->meta.msec); |
|
} |
|
|
|
|
/* |
|
* 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) ? |
* Allocate all volatile resources (parse tree, meta-data, fields). |
mdoc_pmacro(mdoc, ln, buf, offs) : |
*/ |
mdoc_ptext(mdoc, ln, buf, offs); |
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->next = MDOC_NEXT_CHILD; |
|
} |
} |
|
|
|
|
/* |
|
* 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_reset(struct mdoc *mdoc) |
mdoc_macro(MACRO_PROT_ARGS) |
{ |
{ |
|
assert(tok >= MDOC_Dd && tok < MDOC_MAX); |
mdoc_free1(mdoc); |
(*mdoc_macros[tok].fp)(mdoc, tok, line, ppos, pos, buf); |
mdoc_alloc1(mdoc); |
|
} |
} |
|
|
|
|
/* |
|
* 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_tail_alloc(struct roff_man *mdoc, int line, int pos, enum roff_tok tok) |
{ |
{ |
|
struct roff_node *p; |
|
|
mdoc_free1(mdoc); |
p = roff_node_alloc(mdoc, line, pos, ROFFT_TAIL, tok); |
free(mdoc); |
roff_node_append(mdoc, p); |
|
mdoc->next = ROFF_NEXT_CHILD; |
} |
} |
|
|
|
struct roff_node * |
/* |
mdoc_endbody_alloc(struct roff_man *mdoc, int line, int pos, |
* Allocate volatile and non-volatile parse resources. |
enum roff_tok tok, struct roff_node *body) |
*/ |
|
struct mdoc * |
|
mdoc_alloc(void *data, int pflags, mandocmsg msg) |
|
{ |
{ |
struct mdoc *p; |
struct roff_node *p; |
|
|
p = mandoc_calloc(1, sizeof(struct mdoc)); |
body->flags |= NODE_ENDED; |
|
body->parent->flags |= NODE_ENDED; |
p->msg = msg; |
p = roff_node_alloc(mdoc, line, pos, ROFFT_BODY, tok); |
p->data = data; |
p->body = body; |
p->pflags = pflags; |
p->norm = body->norm; |
|
p->end = ENDBODY_SPACE; |
mdoc_hash_init(); |
roff_node_append(mdoc, p); |
mdoc_alloc1(p); |
mdoc->next = ROFF_NEXT_SIBLING; |
return(p); |
return p; |
} |
} |
|
|
|
struct roff_node * |
/* |
mdoc_block_alloc(struct roff_man *mdoc, int line, int pos, |
* Climb back up the parse tree, validating open scopes. Mostly calls |
enum roff_tok tok, struct mdoc_arg *args) |
* 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_BLOCK, tok); |
return(0); |
p->args = args; |
else if (mdoc_macroend(m)) |
if (p->args) |
return(1); |
(args->refcnt)++; |
m->flags |= MDOC_HALT; |
|
return(0); |
|
} |
|
|
|
|
switch (tok) { |
/* |
case MDOC_Bd: |
* Main parse routine. Parses a single line -- really just hands off to |
case MDOC_Bf: |
* the macro (mdoc_pmacro()) or text parser (mdoc_ptext()). |
case MDOC_Bl: |
*/ |
case MDOC_En: |
int |
case MDOC_Rs: |
mdoc_parseln(struct mdoc *m, int ln, char *buf, int offs) |
p->norm = mandoc_calloc(1, sizeof(union mdoc_data)); |
{ |
|
|
|
if (MDOC_HALT & m->flags) |
|
return(0); |
|
|
|
m->flags |= MDOC_NEWLINE; |
|
return(('.' == buf[offs] || '\'' == buf[offs]) ? |
|
mdoc_pmacro(m, ln, buf, offs) : |
|
mdoc_ptext(m, ln, buf, offs)); |
|
} |
|
|
|
|
|
int |
|
mdoc_vmsg(struct mdoc *mdoc, enum mandocerr t, |
|
int ln, int pos, const char *fmt, ...) |
|
{ |
|
char buf[256]; |
|
va_list ap; |
|
|
|
va_start(ap, fmt); |
|
vsnprintf(buf, sizeof(buf) - 1, fmt, ap); |
|
va_end(ap); |
|
|
|
return((*mdoc->msg)(t, mdoc->data, ln, pos, buf)); |
|
} |
|
|
|
|
|
int |
|
mdoc_macro(struct mdoc *m, enum mdoct tok, |
|
int ln, int pp, int *pos, char *buf) |
|
{ |
|
assert(tok < MDOC_MAX); |
|
|
|
/* If we're in the body, deny prologue calls. */ |
|
|
|
if (MDOC_PROLOGUE & mdoc_macros[tok].flags && |
|
MDOC_PBODY & m->flags) |
|
return(mdoc_pmsg(m, ln, pp, MANDOCERR_BADBODY)); |
|
|
|
/* If we're in the prologue, deny "body" macros. */ |
|
|
|
if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) && |
|
! (MDOC_PBODY & m->flags)) { |
|
if ( ! mdoc_pmsg(m, ln, pp, MANDOCERR_BADPROLOG)) |
|
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; |
|
} |
|
|
|
return((*mdoc_macros[tok].fp)(m, tok, ln, pp, pos, buf)); |
|
} |
|
|
|
|
|
static int |
|
node_append(struct mdoc *mdoc, struct mdoc_node *p) |
|
{ |
|
|
|
assert(mdoc->last); |
|
assert(mdoc->first); |
|
assert(MDOC_ROOT != p->type); |
|
|
|
switch (mdoc->next) { |
|
case (MDOC_NEXT_SIBLING): |
|
mdoc->last->next = p; |
|
p->prev = mdoc->last; |
|
p->parent = mdoc->last->parent; |
|
break; |
break; |
case (MDOC_NEXT_CHILD): |
|
mdoc->last->child = p; |
|
p->parent = mdoc->last; |
|
break; |
|
default: |
default: |
abort(); |
|
/* NOTREACHED */ |
|
} |
|
|
|
p->parent->nchild++; |
|
|
|
if ( ! mdoc_valid_pre(mdoc, p)) |
|
return(0); |
|
if ( ! mdoc_action_pre(mdoc, p)) |
|
return(0); |
|
|
|
switch (p->type) { |
|
case (MDOC_HEAD): |
|
assert(MDOC_BLOCK == p->parent->type); |
|
p->parent->head = p; |
|
break; |
break; |
case (MDOC_TAIL): |
|
assert(MDOC_BLOCK == p->parent->type); |
|
p->parent->tail = p; |
|
break; |
|
case (MDOC_BODY): |
|
assert(MDOC_BLOCK == p->parent->type); |
|
p->parent->body = p; |
|
break; |
|
default: |
|
break; |
|
} |
} |
|
roff_node_append(mdoc, p); |
mdoc->last = p; |
mdoc->next = ROFF_NEXT_CHILD; |
|
return 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); |
|
} |
} |
|
|
|
void |
static struct mdoc_node * |
mdoc_elem_alloc(struct roff_man *mdoc, int line, int pos, |
node_alloc(struct mdoc *m, int line, int pos, |
enum roff_tok tok, struct mdoc_arg *args) |
enum mdoct tok, enum mdoc_type type) |
|
{ |
{ |
struct mdoc_node *p; |
struct roff_node *p; |
|
|
p = mandoc_calloc(1, sizeof(struct mdoc_node)); |
p = roff_node_alloc(mdoc, line, pos, ROFFT_ELEM, tok); |
p->sec = m->lastsec; |
|
p->line = line; |
|
p->pos = pos; |
|
p->tok = tok; |
|
p->type = type; |
|
if (MDOC_NEWLINE & m->flags) |
|
p->flags |= MDOC_LINE; |
|
m->flags &= ~MDOC_NEWLINE; |
|
return(p); |
|
} |
|
|
|
|
|
int |
|
mdoc_tail_alloc(struct mdoc *m, int line, int pos, enum mdoct tok) |
|
{ |
|
struct mdoc_node *p; |
|
|
|
p = node_alloc(m, line, pos, tok, MDOC_TAIL); |
|
if ( ! node_append(m, p)) |
|
return(0); |
|
m->next = MDOC_NEXT_CHILD; |
|
return(1); |
|
} |
|
|
|
|
|
int |
|
mdoc_head_alloc(struct mdoc *m, int line, int pos, enum mdoct tok) |
|
{ |
|
struct mdoc_node *p; |
|
|
|
assert(m->first); |
|
assert(m->last); |
|
|
|
p = node_alloc(m, line, pos, tok, MDOC_HEAD); |
|
if ( ! node_append(m, p)) |
|
return(0); |
|
m->next = MDOC_NEXT_CHILD; |
|
return(1); |
|
} |
|
|
|
|
|
int |
|
mdoc_body_alloc(struct mdoc *m, int line, int pos, enum mdoct tok) |
|
{ |
|
struct mdoc_node *p; |
|
|
|
p = node_alloc(m, line, pos, tok, MDOC_BODY); |
|
if ( ! node_append(m, p)) |
|
return(0); |
|
m->next = MDOC_NEXT_CHILD; |
|
return(1); |
|
} |
|
|
|
|
|
int |
|
mdoc_block_alloc(struct mdoc *m, int line, int pos, |
|
enum mdoct tok, struct mdoc_arg *args) |
|
{ |
|
struct mdoc_node *p; |
|
|
|
p = node_alloc(m, line, pos, tok, MDOC_BLOCK); |
|
p->args = args; |
p->args = args; |
if (p->args) |
if (p->args) |
(args->refcnt)++; |
(args->refcnt)++; |
if ( ! node_append(m, p)) |
|
return(0); |
|
m->next = MDOC_NEXT_CHILD; |
|
return(1); |
|
} |
|
|
|
|
switch (tok) { |
int |
case MDOC_An: |
mdoc_elem_alloc(struct mdoc *m, int line, int pos, |
p->norm = mandoc_calloc(1, sizeof(union mdoc_data)); |
enum mdoct tok, struct mdoc_arg *args) |
break; |
{ |
default: |
struct mdoc_node *p; |
break; |
|
|
p = node_alloc(m, line, pos, tok, MDOC_ELEM); |
|
p->args = args; |
|
if (p->args) |
|
(args->refcnt)++; |
|
if ( ! node_append(m, p)) |
|
return(0); |
|
m->next = MDOC_NEXT_CHILD; |
|
return(1); |
|
} |
|
|
|
|
|
int |
|
mdoc_word_alloc(struct mdoc *m, int line, int pos, const char *p) |
|
{ |
|
struct mdoc_node *n; |
|
size_t sv, len; |
|
|
|
len = strlen(p); |
|
|
|
n = node_alloc(m, line, pos, MDOC_MAX, MDOC_TEXT); |
|
n->string = mandoc_malloc(len + 1); |
|
sv = strlcpy(n->string, p, len + 1); |
|
|
|
/* Prohibit truncation. */ |
|
assert(sv < len + 1); |
|
|
|
if ( ! node_append(m, n)) |
|
return(0); |
|
|
|
m->next = MDOC_NEXT_SIBLING; |
|
return(1); |
|
} |
|
|
|
|
|
void |
|
mdoc_node_free(struct mdoc_node *p) |
|
{ |
|
|
|
if (p->string) |
|
free(p->string); |
|
if (p->args) |
|
mdoc_argv_free(p->args); |
|
free(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; |
|
} |
} |
|
roff_node_append(mdoc, p); |
/* Adjust parse point, if applicable. */ |
mdoc->next = ROFF_NEXT_CHILD; |
|
|
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_delete(struct mdoc *m, struct mdoc_node *p) |
mdoc_node_relink(struct roff_man *mdoc, struct roff_node *p) |
{ |
{ |
|
|
while (p->child) { |
roff_node_unlink(mdoc, p); |
assert(p->nchild); |
p->prev = p->next = NULL; |
mdoc_node_delete(m, p->child); |
roff_node_append(mdoc, p); |
} |
|
assert(0 == p->nchild); |
|
|
|
mdoc_node_unlink(m, p); |
|
mdoc_node_free(p); |
|
} |
} |
|
|
|
|
/* |
/* |
* Parse free-form text, that is, a line that does not begin with the |
* Parse free-form text, that is, a line that does not begin with the |
* control character. |
* control character. |
*/ |
*/ |
static int |
static int |
mdoc_ptext(struct mdoc *m, int line, char *buf, int offs) |
mdoc_ptext(struct roff_man *mdoc, int line, char *buf, int offs) |
{ |
{ |
int i; |
struct roff_node *n; |
|
char *c, *ws, *end; |
|
|
/* Ignore bogus comments. */ |
n = mdoc->last; |
|
|
if ('\\' == buf[offs] && |
/* |
'.' == buf[offs + 1] && |
* If a column list contains plain text, assume an implicit item |
'"' == buf[offs + 2]) |
* macro. This can happen one or more times at the beginning |
return(mdoc_pmsg(m, line, offs, MANDOCERR_BADCOMMENT)); |
* of such a list, intermixed with non-It mdoc macros and with |
|
* nodes generated on the roff level, for example by tbl. |
|
*/ |
|
|
/* No text before an initial macro. */ |
if ((n->tok == MDOC_Bl && n->type == ROFFT_BODY && |
|
n->end == ENDBODY_NOT && n->norm->Bl.type == LIST_column) || |
|
(n->parent != NULL && n->parent->tok == MDOC_Bl && |
|
n->parent->norm->Bl.type == LIST_column)) { |
|
mdoc->flags |= MDOC_FREECOL; |
|
mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf); |
|
return 1; |
|
} |
|
|
if (SEC_NONE == m->lastnamed) |
/* |
return(mdoc_pmsg(m, line, offs, MANDOCERR_NOTEXT)); |
* Search for the beginning of unescaped trailing whitespace (ws) |
|
* and for the first character not to be output (end). |
|
*/ |
|
|
/* Literal just gets pulled in as-is. */ |
/* FIXME: replace with strcspn(). */ |
|
ws = NULL; |
if (MDOC_LITERAL & m->flags) |
for (c = end = buf + offs; *c; c++) { |
return(mdoc_word_alloc(m, line, offs, buf + offs)); |
switch (*c) { |
|
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'; |
|
|
/* Check for a blank line, which may also consist of spaces. */ |
if (ws) |
|
mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse, |
|
line, (int)(ws-buf), NULL); |
|
|
for (i = offs; ' ' == buf[i]; i++) |
if (buf[offs] == '\0' && ! (mdoc->flags & MDOC_LITERAL)) { |
/* Skip to first non-space. */ ; |
mandoc_msg(MANDOCERR_FI_BLANK, mdoc->parse, |
|
line, (int)(c - buf), NULL); |
|
|
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, |
* Insert a `sp' in the case of a blank line. Technically, |
* blank lines aren't allowed, but enough manuals assume this |
* blank lines aren't allowed, but enough manuals assume this |
* behaviour that we want to work around it. |
* behaviour that we want to work around it. |
*/ |
*/ |
if ( ! mdoc_elem_alloc(m, line, offs, MDOC_Pp, NULL)) |
roff_elem_alloc(mdoc, line, offs, ROFF_sp); |
return(0); |
mdoc->last->flags |= NODE_VALID | NODE_ENDED; |
|
mdoc->next = ROFF_NEXT_SIBLING; |
m->next = MDOC_NEXT_SIBLING; |
return 1; |
return(1); |
|
} |
} |
|
|
/* |
roff_word_alloc(mdoc, line, offs, buf+offs); |
* Warn if the last un-escaped character is whitespace. Then |
|
* strip away the remaining spaces (tabs stay!). |
|
*/ |
|
|
|
i = (int)strlen(buf); |
if (mdoc->flags & MDOC_LITERAL) |
assert(i); |
return 1; |
|
|
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); |
|
|
|
/* |
/* |
* End-of-sentence check. If the last character is an unescaped |
* End-of-sentence check. If the last character is an unescaped |
* EOS character, then flag the node as being the end of a |
* EOS character, then flag the node as being the end of a |
* sentence. The front-end will know how to interpret this. |
* sentence. The front-end will know how to interpret this. |
*/ |
*/ |
|
|
assert(i); |
assert(buf < end); |
if (mandoc_eos(buf, (size_t)i)) |
|
m->last->flags |= MDOC_EOS; |
|
|
|
return(1); |
if (mandoc_eos(buf+offs, (size_t)(end-buf-offs))) |
} |
mdoc->last->flags |= NODE_EOS; |
|
|
|
for (c = buf + offs; c != NULL; c = strchr(c + 1, '.')) { |
|
if (c - buf < offs + 2) |
|
continue; |
|
if (end - c < 3) |
|
break; |
|
if (isalpha((unsigned char)c[-2]) && |
|
isalpha((unsigned char)c[-1]) && |
|
c[1] == ' ' && |
|
isupper((unsigned char)(c[2] == ' ' ? c[3] : c[2])) && |
|
(c[-2] != 'n' || c[-1] != 'c') && |
|
(c[-2] != 'v' || c[-1] != 's')) |
|
mandoc_msg(MANDOCERR_EOS, mdoc->parse, |
|
line, (int)(c - buf), NULL); |
|
} |
|
|
static int |
return 1; |
macrowarn(struct mdoc *m, int ln, const char *buf, int offs) |
|
{ |
|
int rc; |
|
|
|
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 |
static int |
mdoc_pmacro(struct mdoc *m, int ln, char *buf, int offs) |
mdoc_pmacro(struct roff_man *mdoc, int ln, char *buf, int offs) |
{ |
{ |
enum mdoct tok; |
struct roff_node *n; |
int i, j, sv; |
const char *cp; |
char mac[5]; |
size_t sz; |
|
enum roff_tok tok; |
|
int sv; |
|
|
/* Empty lines are ignored. */ |
/* Determine the line macro. */ |
|
|
offs++; |
sv = offs; |
|
tok = TOKEN_NONE; |
|
for (sz = 0; sz < 4 && strchr(" \t\\", buf[offs]) == NULL; sz++) |
|
offs++; |
|
if (sz == 2 || sz == 3) |
|
tok = roffhash_find(mdoc->mdocmac, buf + sv, sz); |
|
if (tok == TOKEN_NONE) { |
|
mandoc_msg(MANDOCERR_MACRO, mdoc->parse, |
|
ln, sv, buf + sv - 1); |
|
return 1; |
|
} |
|
|
if ('\0' == buf[offs]) |
/* Skip a leading escape sequence or tab. */ |
return(1); |
|
|
|
i = offs; |
switch (buf[offs]) { |
|
case '\\': |
/* Accept whitespace after the initial control char. */ |
cp = buf + offs + 1; |
|
mandoc_escape(&cp, NULL, NULL); |
if (' ' == buf[i]) { |
offs = cp - buf; |
i++; |
break; |
while (buf[i] && ' ' == buf[i]) |
case '\t': |
i++; |
offs++; |
if ('\0' == buf[i]) |
break; |
return(1); |
default: |
|
break; |
} |
} |
|
|
sv = i; |
/* Jump to the next non-whitespace word. */ |
|
|
/* Copy the first word into a nil-terminated buffer. */ |
while (buf[offs] == ' ') |
|
offs++; |
|
|
for (j = 0; j < 4; j++, i++) { |
/* |
if ('\0' == (mac[j] = buf[i])) |
* Trailing whitespace. Note that tabs are allowed to be passed |
break; |
* into the parser as "text", so we only warn about spaces here. |
else if (' ' == buf[i]) |
*/ |
break; |
|
|
|
/* Check for invalid characters. */ |
if ('\0' == buf[offs] && ' ' == buf[offs - 1]) |
|
mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse, |
|
ln, offs - 1, NULL); |
|
|
if (isgraph((u_char)buf[i])) |
/* |
continue; |
* If an initial macro or a list invocation, divert directly |
if ( ! mdoc_pmsg(m, ln, i, MANDOCERR_BADCHAR)) |
* into macro processing. |
return(0); |
*/ |
i--; |
|
|
n = mdoc->last; |
|
if (n == NULL || tok == MDOC_It || tok == MDOC_El) { |
|
mdoc_macro(mdoc, tok, ln, sv, &offs, buf); |
|
return 1; |
} |
} |
|
|
mac[j] = '\0'; |
/* |
|
* If a column list contains a non-It macro, assume an implicit |
|
* item macro. This can happen one or more times at the |
|
* beginning of such a list, intermixed with text lines and |
|
* with nodes generated on the roff level, for example by tbl. |
|
*/ |
|
|
if (j == 4 || j < 2) { |
if ((n->tok == MDOC_Bl && n->type == ROFFT_BODY && |
if ( ! macrowarn(m, ln, mac, sv)) |
n->end == ENDBODY_NOT && n->norm->Bl.type == LIST_column) || |
goto err; |
(n->parent != NULL && n->parent->tok == MDOC_Bl && |
return(1); |
n->parent->norm->Bl.type == LIST_column)) { |
} |
mdoc->flags |= MDOC_FREECOL; |
|
mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf); |
if (MDOC_MAX == (tok = mdoc_hash_find(mac))) { |
return 1; |
if ( ! macrowarn(m, ln, mac, sv)) |
|
goto err; |
|
return(1); |
|
} |
} |
|
|
/* The macro is sane. Jump to the next word. */ |
/* Normal processing of a macro. */ |
|
|
while (buf[i] && ' ' == buf[i]) |
mdoc_macro(mdoc, tok, ln, sv, &offs, buf); |
i++; |
|
|
|
/* |
/* In quick mode (for mandocdb), abort after the NAME section. */ |
* 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[i] && ' ' == buf[i - 1]) |
if (mdoc->quick && MDOC_Sh == tok && |
if ( ! mdoc_pmsg(m, ln, i - 1, MANDOCERR_EOLNSPACE)) |
SEC_NAME != mdoc->last->sec) |
goto err; |
return 2; |
|
|
/* |
return 1; |
* 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, tok, ln, sv, &i, buf)) |
|
goto err; |
|
|
|
return(1); |
enum mdelim |
|
mdoc_isdelim(const char *p) |
|
{ |
|
|
err: /* Error out. */ |
if ('\0' == p[0]) |
|
return DELIM_NONE; |
|
|
m->flags |= MDOC_HALT; |
if ('\0' == p[1]) |
return(0); |
switch (p[0]) { |
|
case '(': |
|
case '[': |
|
return DELIM_OPEN; |
|
case '|': |
|
return DELIM_MIDDLE; |
|
case '.': |
|
case ',': |
|
case ';': |
|
case ':': |
|
case '?': |
|
case '!': |
|
case ')': |
|
case ']': |
|
return DELIM_CLOSE; |
|
default: |
|
return DELIM_NONE; |
|
} |
|
|
|
if ('\\' != p[0]) |
|
return DELIM_NONE; |
|
|
|
if (0 == strcmp(p + 1, ".")) |
|
return DELIM_CLOSE; |
|
if (0 == strcmp(p + 1, "fR|\\fP")) |
|
return DELIM_MIDDLE; |
|
|
|
return DELIM_NONE; |
} |
} |
|
|
|
void |
|
mdoc_validate(struct roff_man *mdoc) |
|
{ |
|
|
|
mdoc->last = mdoc->first; |
|
mdoc_node_validate(mdoc); |
|
mdoc_state_reset(mdoc); |
|
} |