-/* $Id: mdoc_macro.c,v 1.48 2010/03/31 07:42:04 kristaps Exp $ */
+/* $Id: mdoc_macro.c,v 1.58 2010/05/08 07:30:19 kristaps Exp $ */
/*
* Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
*
#include "libmdoc.h"
-#define REWIND_REWIND (1 << 0)
-#define REWIND_NOHALT (1 << 1)
-#define REWIND_HALT (1 << 2)
-
-static int ctx_synopsis(MACRO_PROT_ARGS);
-static int obsolete(MACRO_PROT_ARGS);
-static int blk_part_exp(MACRO_PROT_ARGS);
-static int in_line_eoln(MACRO_PROT_ARGS);
-static int in_line_argn(MACRO_PROT_ARGS);
-static int in_line(MACRO_PROT_ARGS);
-static int blk_full(MACRO_PROT_ARGS);
-static int blk_exp_close(MACRO_PROT_ARGS);
-static int blk_part_imp(MACRO_PROT_ARGS);
-
-static int phrase(struct mdoc *, int, int, char *);
-static int rew_dohalt(enum mdoct, enum mdoc_type,
- const struct mdoc_node *);
-static enum mdoct rew_alt(enum mdoct);
-static int rew_dobreak(enum mdoct, const struct mdoc_node *);
-static int rew_elem(struct mdoc *, enum mdoct);
-static int rew_sub(enum mdoc_type, struct mdoc *,
- enum mdoct, int, int);
-static int rew_last(struct mdoc *,
- const struct mdoc_node *);
-static int append_delims(struct mdoc *, int, int *, char *);
-static int lookup(int, const char *);
-static int lookup_raw(const char *);
-static int swarn(struct mdoc *, enum mdoc_type, int, int,
- const struct mdoc_node *);
-
-/* Central table of library: who gets parsed how. */
+enum rew {
+ REWIND_REWIND,
+ REWIND_NOHALT,
+ REWIND_HALT
+};
+
+static int blk_full(MACRO_PROT_ARGS);
+static int blk_exp_close(MACRO_PROT_ARGS);
+static int blk_part_exp(MACRO_PROT_ARGS);
+static int blk_part_imp(MACRO_PROT_ARGS);
+static int ctx_synopsis(MACRO_PROT_ARGS);
+static int in_line_eoln(MACRO_PROT_ARGS);
+static int in_line_argn(MACRO_PROT_ARGS);
+static int in_line(MACRO_PROT_ARGS);
+static int obsolete(MACRO_PROT_ARGS);
+
+static int append_delims(struct mdoc *,
+ int, int *, char *);
+static enum mdoct lookup(enum mdoct, const char *);
+static enum mdoct lookup_raw(const char *);
+static int phrase(struct mdoc *, int, int, char *);
+static enum mdoct rew_alt(enum mdoct);
+static int rew_dobreak(enum mdoct,
+ const struct mdoc_node *);
+static enum rew rew_dohalt(enum mdoct, enum mdoc_type,
+ const struct mdoc_node *);
+static int rew_elem(struct mdoc *, enum mdoct);
+static int rew_last(struct mdoc *,
+ const struct mdoc_node *);
+static int rew_sub(enum mdoc_type, struct mdoc *,
+ enum mdoct, int, int);
+static int swarn(struct mdoc *, enum mdoc_type, int,
+ int, const struct mdoc_node *);
const struct mdoc_macro __mdoc_macros[MDOC_MAX] = {
{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ap */
{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Nx */
{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ox */
{ blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Pc */
- { in_line_argn, MDOC_PARSED | MDOC_IGNDELIM }, /* Pf */
+ { in_line_argn, MDOC_CALLABLE | MDOC_PARSED | MDOC_IGNDELIM }, /* Pf */
{ blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Po */
{ blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Pq */
{ blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Qc */
/*
* Look up a macro from within a subsequent context.
*/
-static int
-lookup(int from, const char *p)
+static enum mdoct
+lookup(enum mdoct from, const char *p)
{
/* FIXME: make -diag lists be un-PARSED. */
/*
* Lookup a macro following the initial line macro.
*/
-static int
+static enum mdoct
lookup_raw(const char *p)
{
- int res;
+ enum mdoct res;
if (MDOC_MAX == (res = mdoc_hash_find(p)))
return(MDOC_MAX);
* close our current scope (REWIND_REWIND), or continue (REWIND_NOHALT).
* The scope-closing and so on occurs in the various rew_* routines.
*/
-static int
+static enum rew
rew_dohalt(enum mdoct tok, enum mdoc_type type,
const struct mdoc_node *p)
{
enum mdoct tok, int line, int ppos)
{
struct mdoc_node *n;
- int c;
+ enum rew c;
/* LINTED */
for (n = m->last; n; n = n->parent) {
static int
append_delims(struct mdoc *mdoc, int line, int *pos, char *buf)
{
- int c, lastarg;
+ int lastarg;
+ enum margserr ac;
char *p;
if (0 == buf[*pos])
for (;;) {
lastarg = *pos;
- c = mdoc_zargs(mdoc, line, pos, buf, ARGS_NOWARN, &p);
- assert(ARGS_PHRASE != c);
+ ac = mdoc_zargs(mdoc, line, pos, buf, ARGS_NOWARN, &p);
- if (ARGS_ERROR == c)
+ if (ARGS_ERROR == ac)
return(0);
- else if (ARGS_EOLN == c)
+ else if (ARGS_EOLN == ac)
break;
assert(mdoc_isdelim(p));
if ( ! mdoc_word_alloc(mdoc, line, lastarg, p))
static int
blk_exp_close(MACRO_PROT_ARGS)
{
- int j, c, lastarg, maxargs, flushed;
+ int j, lastarg, maxargs, flushed;
+ enum margserr ac;
+ enum mdoct ntok;
char *p;
switch (tok) {
flushed = 1;
}
- c = mdoc_args(m, line, pos, buf, tok, &p);
+ ac = mdoc_args(m, line, pos, buf, tok, &p);
- if (ARGS_ERROR == c)
+ if (ARGS_ERROR == ac)
return(0);
- if (ARGS_PUNCT == c)
+ if (ARGS_PUNCT == ac)
break;
- if (ARGS_EOLN == c)
+ if (ARGS_EOLN == ac)
break;
- if (MDOC_MAX != (c = lookup(tok, p))) {
- if ( ! flushed) {
- if ( ! rew_sub(MDOC_BLOCK, m, tok, line, ppos))
- return(0);
- flushed = 1;
- }
- if ( ! mdoc_macro(m, c, line, lastarg, pos, buf))
+ ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
+
+ if (MDOC_MAX == ntok) {
+ if ( ! mdoc_word_alloc(m, line, lastarg, p))
return(0);
- break;
- }
+ continue;
+ }
- if ( ! mdoc_word_alloc(m, line, lastarg, p))
+ if ( ! flushed) {
+ if ( ! rew_sub(MDOC_BLOCK, m, tok, line, ppos))
+ return(0);
+ flushed = 1;
+ }
+ if ( ! mdoc_macro(m, ntok, line, lastarg, pos, buf))
return(0);
+ break;
}
if ( ! flushed && ! rew_sub(MDOC_BLOCK, m, tok, line, ppos))
static int
in_line(MACRO_PROT_ARGS)
{
- int la, lastpunct, c, w, cnt, d, nc;
- struct mdoc_arg *arg;
- char *p;
+ int la, lastpunct, cnt, d, nc;
+ enum margverr av;
+ enum mdoct ntok;
+ enum margserr ac;
+ struct mdoc_arg *arg;
+ char *p;
/*
* Whether we allow ignored elements (those without content,
for (arg = NULL;; ) {
la = *pos;
- c = mdoc_argv(m, line, tok, &arg, pos, buf);
+ av = mdoc_argv(m, line, tok, &arg, pos, buf);
- if (ARGV_WORD == c) {
+ if (ARGV_WORD == av) {
*pos = la;
break;
}
- if (ARGV_EOLN == c)
+ if (ARGV_EOLN == av)
break;
- if (ARGV_ARG == c)
+ if (ARGV_ARG == av)
continue;
mdoc_argv_free(arg);
for (cnt = 0, lastpunct = 1;; ) {
la = *pos;
- w = mdoc_args(m, line, pos, buf, tok, &p);
+ ac = mdoc_args(m, line, pos, buf, tok, &p);
- if (ARGS_ERROR == w)
+ if (ARGS_ERROR == ac)
return(0);
- if (ARGS_EOLN == w)
+ if (ARGS_EOLN == ac)
break;
- if (ARGS_PUNCT == w)
+ if (ARGS_PUNCT == ac)
break;
- /* Quoted words shouldn't be looked-up. */
-
- c = ARGS_QWORD == w ? MDOC_MAX : lookup(tok, p);
+ ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
/*
* In this case, we've located a submacro and must
* or raise a warning.
*/
- if (MDOC_MAX != c) {
+ if (MDOC_MAX != ntok) {
if (0 == lastpunct && ! rew_elem(m, tok))
return(0);
if (nc && 0 == cnt) {
if ( ! mdoc_pwarn(m, line, ppos, EIGNE))
return(0);
}
- c = mdoc_macro(m, c, line, la, pos, buf);
- if (0 == c)
+ if ( ! mdoc_macro(m, ntok, line, la, pos, buf))
return(0);
if (ppos > 1)
return(1);
* the word.
*/
- d = mdoc_isdelim(p);
+ d = ARGS_QWORD == ac ? 0 : mdoc_isdelim(p);
- if (ARGS_QWORD != w && d) {
+ if (ARGS_QWORD != ac && d) {
if (0 == lastpunct && ! rew_elem(m, tok))
return(0);
lastpunct = 1;
static int
blk_full(MACRO_PROT_ARGS)
{
- int c, la;
+ int la;
struct mdoc_arg *arg;
struct mdoc_node *head; /* save of head macro */
+ struct mdoc_node *body; /* save of body macro */
#ifdef UGLY
struct mdoc_node *n;
#endif
+ enum mdoct ntok;
+ enum margserr ac;
+ enum margverr av;
char *p;
/* Close out prior implicit scope. */
for (arg = NULL;; ) {
la = *pos;
- c = mdoc_argv(m, line, tok, &arg, pos, buf);
+ av = mdoc_argv(m, line, tok, &arg, pos, buf);
- if (ARGV_WORD == c) {
+ if (ARGV_WORD == av) {
*pos = la;
break;
}
- if (ARGV_EOLN == c)
+ if (ARGV_EOLN == av)
break;
- if (ARGV_ARG == c)
+ if (ARGV_ARG == av)
continue;
mdoc_argv_free(arg);
if ( ! mdoc_block_alloc(m, line, ppos, tok, arg))
return(0);
- head = NULL;
+ head = body = NULL;
/*
* The `Nd' macro has all arguments in its body: it's a hybrid
return(0);
if ( ! mdoc_body_alloc(m, line, ppos, tok))
return(0);
+ body = m->last;
}
for (;;) {
la = *pos;
- c = mdoc_args(m, line, pos, buf, tok, &p);
+ ac = mdoc_args(m, line, pos, buf, tok, &p);
- if (ARGS_ERROR == c)
+ if (ARGS_ERROR == ac)
return(0);
- if (ARGS_EOLN == c)
+ if (ARGS_EOLN == ac)
break;
/* Don't emit leading punct. for phrases. */
- if (NULL == head && ARGS_PHRASE != c &&
+ if (NULL == head && ARGS_PHRASE != ac &&
+ ARGS_PPHRASE != ac &&
+ ARGS_QWORD != ac &&
1 == mdoc_isdelim(p)) {
if ( ! mdoc_word_alloc(m, line, la, p))
return(0);
/* Always re-open head for phrases. */
- if (NULL == head || ARGS_PHRASE == c) {
+ if (NULL == head || ARGS_PHRASE == ac ||
+ ARGS_PPHRASE == ac) {
if ( ! mdoc_head_alloc(m, line, ppos, tok))
return(0);
head = m->last;
}
- if (ARGS_PHRASE == c) {
+ if (ARGS_PHRASE == ac || ARGS_PPHRASE == ac) {
if ( ! phrase(m, line, la, buf))
return(0);
if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos))
continue;
}
- c = lookup(tok, p);
- if (MDOC_MAX != c) {
- if ( ! mdoc_macro(m, c, line, la, pos, buf))
+ ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
+
+ if (MDOC_MAX == ntok) {
+ if ( ! mdoc_word_alloc(m, line, la, p))
return(0);
- break;
+ continue;
}
- if ( ! mdoc_word_alloc(m, line, la, p))
- return(0);
+ if ( ! mdoc_macro(m, ntok, line, la, pos, buf))
+ return(0);
+ break;
}
if (NULL == head) {
if (1 == ppos && ! append_delims(m, line, pos, buf))
return(0);
- /* See notes on `Nd' hybrid, above. */
+ /* If we've already opened our body, exit now. */
- if (MDOC_Nd == tok)
+ if (NULL != body)
return(1);
#ifdef UGLY
/*
- * If there is an open sub-block requiring explicit close-out,
- * postpone switching the current block from head to body until
- * the rew_sub() call closing out that sub-block.
+ * If there is an open (i.e., unvalidated) sub-block requiring
+ * explicit close-out, postpone switching the current block from
+ * head to body until the rew_sub() call closing out that
+ * sub-block.
*/
for (n = m->last; n && n != head; n = n->parent) {
- if (MDOC_EXPLICIT & mdoc_macros[n->tok].flags &&
- MDOC_BLOCK == n->type) {
+ if (MDOC_BLOCK == n->type &&
+ MDOC_EXPLICIT & mdoc_macros[n->tok].flags &&
+ ! (MDOC_VALID & n->flags)) {
+ assert( ! (MDOC_ACTED & n->flags));
n->pending = head;
return(1);
}
static int
blk_part_imp(MACRO_PROT_ARGS)
{
- int la, c;
+ int la;
+ enum mdoct ntok;
+ enum margserr ac;
char *p;
struct mdoc_node *blk; /* saved block context */
struct mdoc_node *body; /* saved body context */
for (body = NULL; ; ) {
la = *pos;
- c = mdoc_args(m, line, pos, buf, tok, &p);
+ ac = mdoc_args(m, line, pos, buf, tok, &p);
- assert(ARGS_PHRASE != c);
-
- if (ARGS_ERROR == c)
+ if (ARGS_ERROR == ac)
return(0);
- if (ARGS_EOLN == c)
+ if (ARGS_EOLN == ac)
break;
- if (ARGS_PUNCT == c)
+ if (ARGS_PUNCT == ac)
break;
- if (NULL == body && 1 == mdoc_isdelim(p)) {
+ if (NULL == body && ARGS_QWORD != ac &&
+ 1 == mdoc_isdelim(p)) {
if ( ! mdoc_word_alloc(m, line, la, p))
return(0);
continue;
body = m->last;
}
- if (MDOC_MAX != (c = lookup(tok, p))) {
- if ( ! mdoc_macro(m, c, line, la, pos, buf))
+ ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
+
+ if (MDOC_MAX == ntok) {
+ if ( ! mdoc_word_alloc(m, line, la, p))
return(0);
- break;
- }
+ continue;
+ }
- if ( ! mdoc_word_alloc(m, line, la, p))
+ if ( ! mdoc_macro(m, ntok, line, la, pos, buf))
return(0);
+ break;
}
/* Clean-ups to leave in a consistent state. */
static int
blk_part_exp(MACRO_PROT_ARGS)
{
- int la, c;
+ int la;
+ enum margserr ac;
struct mdoc_node *head; /* keep track of head */
struct mdoc_node *body; /* keep track of body */
char *p;
+ enum mdoct ntok;
/*
* The opening of an explicit macro having zero or more leading
for (head = body = NULL; ; ) {
la = *pos;
- c = mdoc_args(m, line, pos, buf, tok, &p);
+ ac = mdoc_args(m, line, pos, buf, tok, &p);
- if (ARGS_ERROR == c)
+ if (ARGS_ERROR == ac)
return(0);
- if (ARGS_PUNCT == c)
+ if (ARGS_PUNCT == ac)
break;
- if (ARGS_EOLN == c)
+ if (ARGS_EOLN == ac)
break;
- assert(ARGS_PHRASE != c);
-
/* Flush out leading punctuation. */
- if (NULL == head && 1 == mdoc_isdelim(p)) {
+ if (NULL == head && ARGS_QWORD != ac &&
+ 1 == mdoc_isdelim(p)) {
assert(NULL == body);
if ( ! mdoc_word_alloc(m, line, la, p))
return(0);
assert(NULL != head && NULL != body);
- if (MDOC_MAX != (c = lookup(tok, p))) {
- if ( ! mdoc_macro(m, c, line, la, pos, buf))
+ ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
+
+ if (MDOC_MAX == ntok) {
+ if ( ! mdoc_word_alloc(m, line, la, p))
return(0);
- break;
+ continue;
}
- if ( ! mdoc_word_alloc(m, line, la, p))
+ if ( ! mdoc_macro(m, ntok, line, la, pos, buf))
return(0);
+ break;
}
/* Clean-up to leave in a consistent state. */
static int
in_line_argn(MACRO_PROT_ARGS)
{
- int la, flushed, j, c, maxargs;
- struct mdoc_arg *arg;
- char *p;
+ int la, flushed, j, maxargs;
+ enum margserr ac;
+ enum margverr av;
+ struct mdoc_arg *arg;
+ char *p;
+ enum mdoct ntok;
/*
* A line macro that has a fixed number of arguments (maxargs).
for (arg = NULL; ; ) {
la = *pos;
- c = mdoc_argv(m, line, tok, &arg, pos, buf);
+ av = mdoc_argv(m, line, tok, &arg, pos, buf);
- if (ARGV_WORD == c) {
+ if (ARGV_WORD == av) {
*pos = la;
break;
}
- if (ARGV_EOLN == c)
+ if (ARGV_EOLN == av)
break;
- if (ARGV_ARG == c)
+ if (ARGV_ARG == av)
continue;
mdoc_argv_free(arg);
for (flushed = j = 0; ; ) {
la = *pos;
- c = mdoc_args(m, line, pos, buf, tok, &p);
+ ac = mdoc_args(m, line, pos, buf, tok, &p);
- if (ARGS_ERROR == c)
+ if (ARGS_ERROR == ac)
return(0);
- if (ARGS_PUNCT == c)
+ if (ARGS_PUNCT == ac)
break;
- if (ARGS_EOLN == c)
+ if (ARGS_EOLN == ac)
break;
if ( ! (MDOC_IGNDELIM & mdoc_macros[tok].flags) &&
+ ARGS_QWORD != ac &&
0 == j && 1 == mdoc_isdelim(p)) {
if ( ! mdoc_word_alloc(m, line, la, p))
return(0);
flushed = 1;
}
- if (MDOC_MAX != (c = lookup(tok, p))) {
+ ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
+
+ if (MDOC_MAX != ntok) {
if ( ! flushed && ! rew_elem(m, tok))
return(0);
flushed = 1;
- if ( ! mdoc_macro(m, c, line, la, pos, buf))
+ if ( ! mdoc_macro(m, ntok, line, la, pos, buf))
return(0);
j++;
break;
}
if ( ! (MDOC_IGNDELIM & mdoc_macros[tok].flags) &&
+ ARGS_QWORD != ac &&
! flushed && mdoc_isdelim(p)) {
if ( ! rew_elem(m, tok))
return(0);
static int
in_line_eoln(MACRO_PROT_ARGS)
{
- int c, w, la;
- struct mdoc_arg *arg;
- char *p;
+ int la;
+ enum margserr ac;
+ enum margverr av;
+ struct mdoc_arg *arg;
+ char *p;
+ enum mdoct ntok;
assert( ! (MDOC_PARSED & mdoc_macros[tok].flags));
for (arg = NULL; ; ) {
la = *pos;
- c = mdoc_argv(m, line, tok, &arg, pos, buf);
+ av = mdoc_argv(m, line, tok, &arg, pos, buf);
- if (ARGV_WORD == c) {
+ if (ARGV_WORD == av) {
*pos = la;
break;
}
- if (ARGV_EOLN == c)
+ if (ARGV_EOLN == av)
break;
- if (ARGV_ARG == c)
+ if (ARGV_ARG == av)
continue;
mdoc_argv_free(arg);
for (;;) {
la = *pos;
- w = mdoc_args(m, line, pos, buf, tok, &p);
+ ac = mdoc_args(m, line, pos, buf, tok, &p);
- if (ARGS_ERROR == w)
+ if (ARGS_ERROR == ac)
return(0);
- if (ARGS_EOLN == w)
+ if (ARGS_EOLN == ac)
break;
- c = ARGS_QWORD == w ? MDOC_MAX : lookup(tok, p);
+ ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
- if (MDOC_MAX != c) {
- if ( ! rew_elem(m, tok))
+ if (MDOC_MAX == ntok) {
+ if ( ! mdoc_word_alloc(m, line, la, p))
return(0);
- return(mdoc_macro(m, c, line, la, pos, buf));
- }
+ continue;
+ }
- if ( ! mdoc_word_alloc(m, line, la, p))
+ if ( ! rew_elem(m, tok))
return(0);
+ return(mdoc_macro(m, ntok, line, la, pos, buf));
}
/* Close out (no delimiters). */
static int
phrase(struct mdoc *m, int line, int ppos, char *buf)
{
- int c, w, la, pos;
- char *p;
+ int la, pos;
+ enum margserr ac;
+ enum mdoct ntok;
+ char *p;
for (pos = ppos; ; ) {
la = pos;
/* Note: no calling context! */
- w = mdoc_zargs(m, line, &pos, buf, 0, &p);
+ ac = mdoc_zargs(m, line, &pos, buf, 0, &p);
- if (ARGS_ERROR == w)
+ if (ARGS_ERROR == ac)
return(0);
- if (ARGS_EOLN == w)
+ if (ARGS_EOLN == ac)
break;
- c = ARGS_QWORD == w ? MDOC_MAX : lookup_raw(p);
+ ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup_raw(p);
- if (MDOC_MAX != c) {
- if ( ! mdoc_macro(m, c, line, la, &pos, buf))
+ if (MDOC_MAX == ntok) {
+ if ( ! mdoc_word_alloc(m, line, la, p))
return(0);
- return(append_delims(m, line, &pos, buf));
- }
+ continue;
+ }
- if ( ! mdoc_word_alloc(m, line, la, p))
+ if ( ! mdoc_macro(m, ntok, line, la, &pos, buf))
return(0);
+ return(append_delims(m, line, &pos, buf));
}
return(1);