mandoc/mdoc_macro.c - diff

Return to mdoc_macro.c CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc_macro.c between version 1.65 and 1.113

version 1.65, 2010/05/15 04:47:38

version 1.113, 2011/12/03 23:59:14

Line 1

/* $Id$ */

* Permission to use, copy, modify, and distribute this software for any

* purpose with or without fee is hereby granted, provided that the above

Line 25

Line 26

#include <string.h>

#include <time.h>

#include "mdoc.h"

#include "mandoc.h"

#include "libmdoc.h"

#include "libmandoc.h"

enum rew {

enum rew { /* see rew_dohalt() */

REWIND_REWIND,

REWIND_NONE,

REWIND_NOHALT,

REWIND_THIS,

REWIND_HALT

REWIND_MORE,

REWIND_FORCE,

REWIND_LATER,

REWIND_ERROR

};

static int blk_full(MACRO_PROT_ARGS);

Line 43 static int in_line_eoln(MACRO_PROT_ARGS);

Line 49 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 phrase_ta(MACRO_PROT_ARGS);

static int dword(struct mdoc *, int, int,

const char *, enum mdelim);

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,

static int make_pending(struct mdoc_node *, enum mdoct,

char *, enum margserr);

struct mdoc *, int, int);

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);

Line 60 static int rew_last(struct mdoc *,

Line 68 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_eoln, MDOC_PROLOGUE }, /* Dd */

{ in_line_eoln, MDOC_PROLOGUE }, /* Dt */

{ in_line_eoln, MDOC_PROLOGUE }, /* Os */

{ blk_full, 0 }, /* Sh */

{ blk_full, MDOC_PARSED }, /* Sh */

{ blk_full, 0 }, /* Ss */

{ blk_full, MDOC_PARSED }, /* Ss */

{ in_line_eoln, 0 }, /* Pp */

{ blk_part_imp, MDOC_PARSED }, /* D1 */

{ blk_part_imp, MDOC_PARSED }, /* Dl */

Line 96 const struct mdoc_macro __mdoc_macros[MDOC_MAX] = {

Line 102 const struct mdoc_macro __mdoc_macros[MDOC_MAX] = {

{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* In */

{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Li */

{ blk_full, 0 }, /* Nd */

{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Nm */

{ ctx_synopsis, MDOC_CALLABLE | MDOC_PARSED }, /* Nm */

{ blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Op */

{ obsolete, 0 }, /* Ot */

{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Pa */

Line 136 const struct mdoc_macro __mdoc_macros[MDOC_MAX] = {

Line 142 const struct mdoc_macro __mdoc_macros[MDOC_MAX] = {

{ blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Eo */

{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Fx */

{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ms */

{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* No */

{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED | MDOC_IGNDELIM }, /* No */

{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ns */

{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED | MDOC_IGNDELIM }, /* Ns */

{ 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 */

Line 170 const struct mdoc_macro __mdoc_macros[MDOC_MAX] = {

Line 176 const struct mdoc_macro __mdoc_macros[MDOC_MAX] = {

{ in_line_eoln, 0 }, /* Hf */

{ obsolete, 0 }, /* Fr */

{ in_line_eoln, 0 }, /* Ud */

{ in_line_eoln, 0 }, /* Lb */

{ in_line, 0 }, /* Lb */

{ in_line_eoln, 0 }, /* Lp */

{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Lk */

{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Mt */

Line 185 const struct mdoc_macro __mdoc_macros[MDOC_MAX] = {

Line 191 const struct mdoc_macro __mdoc_macros[MDOC_MAX] = {

{ in_line_eoln, 0 }, /* br */

{ in_line_eoln, 0 }, /* sp */

{ in_line_eoln, 0 }, /* %U */

{ phrase_ta, MDOC_CALLABLE | MDOC_PARSED }, /* Ta */

};

const struct mdoc_macro * const mdoc_macros = __mdoc_macros;

static int

swarn(struct mdoc *mdoc, enum mdoc_type type,

int line, int pos, const struct mdoc_node *p)

{

const char *n, *t, *tt;

n = t = "<root>";

tt = "block";

switch (type) {

case (MDOC_BODY):

tt = "multi-line";

break;

case (MDOC_HEAD):

tt = "line";

break;

default:

break;

}

switch (p->type) {

case (MDOC_BLOCK):

n = mdoc_macronames[p->tok];

t = "block";

break;

case (MDOC_BODY):

n = mdoc_macronames[p->tok];

t = "multi-line";

break;

case (MDOC_HEAD):

n = mdoc_macronames[p->tok];

t = "line";

break;

default:

break;

}

if ( ! (MDOC_IGN_SCOPE & mdoc->pflags))

return(mdoc_verr(mdoc, line, pos,

"%s scope breaks %s scope of %s",

tt, t, n));

return(mdoc_vwarn(mdoc, line, pos,

"%s scope breaks %s scope of %s",

tt, t, n));

}

* This is called at the end of parsing. It must traverse up the tree,

* closing out open [implicit] scopes. Obviously, open explicit scopes

Line 251 mdoc_macroend(struct mdoc *m)

Line 211 mdoc_macroend(struct mdoc *m)

n = MDOC_VALID & m->last->flags ? m->last->parent : m->last;

for ( ; n; n = n->parent) {

for ( ; n; n = n->parent)

if (MDOC_BLOCK != n->type)

if (MDOC_BLOCK == n->type &&

continue;

MDOC_EXPLICIT & mdoc_macros[n->tok].flags)

if ( ! (MDOC_EXPLICIT & mdoc_macros[n->tok].flags))

mdoc_nmsg(m, n, MANDOCERR_SCOPEEXIT);

continue;

return(mdoc_nerr(m, n, EOPEN));

}

/* Rewind to the first. */

Line 298 lookup_raw(const char *p)

Line 255 lookup_raw(const char *p)

static int

rew_last(struct mdoc *mdoc, const struct mdoc_node *to)

{

struct mdoc_node *n, *np;

assert(to);

mdoc->next = MDOC_NEXT_SIBLING;

/* LINTED */

while (mdoc->last != to) {

* Save the parent here, because we may delete the

* m->last node in the post-validation phase and reset

* it to m->last->parent, causing a step in the closing

* out to be lost.

np = mdoc->last->parent;

if ( ! mdoc_valid_post(mdoc))

return(0);

if ( ! mdoc_action_post(mdoc))

n = mdoc->last;

return(0);

mdoc->last = np;

mdoc->last = mdoc->last->parent;

assert(mdoc->last);

mdoc->last->last = n;

}

if ( ! mdoc_valid_post(mdoc))

return(mdoc_valid_post(mdoc));

return(0);

return(mdoc_action_post(mdoc));

}

* Return the opening macro of a closing one, e.g., `Ec' has `Eo' as its

* For a block closing macro, return the corresponding opening one.

* matching pair.

* Otherwise, return the macro itself.

static enum mdoct

rew_alt(enum mdoct tok)

Line 359 rew_alt(enum mdoct tok)

Line 322 rew_alt(enum mdoct tok)

case (MDOC_Xc):

return(MDOC_Xo);

default:

break;

return(tok);

}

abort();

/* NOTREACHED */

}

* Rewind rules. This indicates whether to stop rewinding

* Rewinding to tok, how do we have to handle *p?

* (REWIND_HALT) without touching our current scope, stop rewinding and

* REWIND_NONE: *p would delimit tok, but no tok scope is open

* close our current scope (REWIND_REWIND), or continue (REWIND_NOHALT).

* inside *p, so there is no need to rewind anything at all.

* The scope-closing and so on occurs in the various rew_* routines.

* REWIND_THIS: *p matches tok, so rewind *p and nothing else.

* REWIND_MORE: *p is implicit, rewind it and keep searching for tok.

* REWIND_FORCE: *p is explicit, but tok is full, force rewinding *p.

* REWIND_LATER: *p is explicit and still open, postpone rewinding.

* REWIND_ERROR: No tok block is open at all.

static enum rew

rew_dohalt(enum mdoct tok, enum mdoc_type type,

const struct mdoc_node *p)

{

* No matching token, no delimiting block, no broken block.

* This can happen when full implicit macros are called for

* the first time but try to rewind their previous

* instance anyway.

if (MDOC_ROOT == p->type)

return(REWIND_HALT);

return(MDOC_BLOCK == type &&

if (MDOC_VALID & p->flags)

MDOC_EXPLICIT & mdoc_macros[tok].flags ?

return(REWIND_NOHALT);

REWIND_ERROR : REWIND_NONE);

* When starting to rewind, skip plain text

* and nodes that have already been rewound.

if (MDOC_TEXT == p->type || MDOC_VALID & p->flags)

return(REWIND_MORE);

* The easiest case: Found a matching token.

* This applies to both blocks and elements.

tok = rew_alt(tok);

if (tok == p->tok)

return(p->end ? REWIND_NONE :

type == p->type ? REWIND_THIS : REWIND_MORE);

* While elements do require rewinding for themselves,

* they never affect rewinding of other nodes.

if (MDOC_ELEM == p->type)

return(REWIND_MORE);

* Blocks delimited by our target token get REWIND_MORE.

* Blocks delimiting our target token get REWIND_NONE.

switch (tok) {

case (MDOC_Aq):

case (MDOC_Bl):

/* FALLTHROUGH */

if (MDOC_It == p->tok)

case (MDOC_Bq):

return(REWIND_MORE);

/* FALLTHROUGH */

case (MDOC_Brq):

/* FALLTHROUGH */

case (MDOC_D1):

/* FALLTHROUGH */

case (MDOC_Dl):

/* FALLTHROUGH */

case (MDOC_Dq):

/* FALLTHROUGH */

case (MDOC_Op):

/* FALLTHROUGH */

case (MDOC_Pq):

/* FALLTHROUGH */

case (MDOC_Ql):

/* FALLTHROUGH */

case (MDOC_Qq):

/* FALLTHROUGH */

case (MDOC_Sq):

/* FALLTHROUGH */

case (MDOC_Vt):

assert(MDOC_TAIL != type);

if (type == p->type && tok == p->tok)

return(REWIND_REWIND);

break;

case (MDOC_It):

assert(MDOC_TAIL != type);

if (type == p->type && tok == p->tok)

return(REWIND_REWIND);

if (MDOC_BODY == p->type && MDOC_Bl == p->tok)

return(REWIND_HALT);

return(REWIND_NONE);

break;

case (MDOC_Sh):

if (type == p->type && tok == p->tok)

* XXX Badly nested block handling still fails badly

return(REWIND_REWIND);

* when one block is breaking two blocks of the same type.

* This is an incomplete and extremely ugly workaround,

* required to let the OpenBSD tree build.

case (MDOC_Oo):

if (MDOC_Op == p->tok)

return(REWIND_MORE);

break;

case (MDOC_Nm):

return(REWIND_NONE);

case (MDOC_Nd):

/* FALLTHROUGH */

case (MDOC_Ss):

assert(MDOC_TAIL != type);

if (type == p->type && tok == p->tok)

return(REWIND_REWIND);

if (MDOC_BODY == p->type && MDOC_Sh == p->tok)

return(REWIND_HALT);

return(REWIND_NONE);

break;

case (MDOC_Ao):

/* FALLTHROUGH */

case (MDOC_Bd):

/* FALLTHROUGH */

case (MDOC_Bf):

/* FALLTHROUGH */

case (MDOC_Bk):

/* FALLTHROUGH */

case (MDOC_Bl):

/* FALLTHROUGH */

case (MDOC_Bo):

/* FALLTHROUGH */

case (MDOC_Bro):

/* FALLTHROUGH */

case (MDOC_Do):

/* FALLTHROUGH */

case (MDOC_Eo):

/* FALLTHROUGH */

case (MDOC_Fo):

/* FALLTHROUGH */

case (MDOC_Oo):

/* FALLTHROUGH */

case (MDOC_Po):

/* FALLTHROUGH */

case (MDOC_Qo):

/* FALLTHROUGH */

case (MDOC_Rs):

/* FALLTHROUGH */

case (MDOC_So):

/* FALLTHROUGH */

case (MDOC_Xo):

if (type == p->type && tok == p->tok)

return(REWIND_REWIND);

break;

/* Multi-line explicit scope close. */

case (MDOC_Ac):

/* FALLTHROUGH */

case (MDOC_Bc):

/* FALLTHROUGH */

case (MDOC_Brc):

/* FALLTHROUGH */

case (MDOC_Dc):

/* FALLTHROUGH */

case (MDOC_Ec):

/* FALLTHROUGH */

case (MDOC_Ed):

/* FALLTHROUGH */

case (MDOC_Ek):

/* FALLTHROUGH */

case (MDOC_El):

/* FALLTHROUGH */

case (MDOC_Fc):

/* FALLTHROUGH */

case (MDOC_Ef):

/* FALLTHROUGH */

case (MDOC_Oc):

/* FALLTHROUGH */

case (MDOC_Pc):

/* FALLTHROUGH */

case (MDOC_Qc):

/* FALLTHROUGH */

case (MDOC_Re):

/* FALLTHROUGH */

case (MDOC_Sc):

/* FALLTHROUGH */

case (MDOC_Xc):

if (type == p->type && rew_alt(tok) == p->tok)

return(REWIND_REWIND);

break;

default:

abort();

/* NOTREACHED */

}

return(REWIND_NOHALT);

}

* See if we can break an encountered scope (the rew_dohalt has returned

* REWIND_NOHALT).

static int

rew_dobreak(enum mdoct tok, const struct mdoc_node *p)

{

assert(MDOC_ROOT != p->type);

if (MDOC_ELEM == p->type)

return(1);

if (MDOC_TEXT == p->type)

return(1);

if (MDOC_VALID & p->flags)

return(1);

switch (tok) {

case (MDOC_It):

return(MDOC_It == p->tok);

case (MDOC_Nd):

return(MDOC_Nd == p->tok);

case (MDOC_Ss):

return(MDOC_Ss == p->tok);

case (MDOC_Sh):

if (MDOC_Nd == p->tok)

if (MDOC_Nd == p->tok || MDOC_Ss == p->tok ||

return(1);

MDOC_Sh == p->tok)

if (MDOC_Ss == p->tok)

return(REWIND_MORE);

return(1);

return(MDOC_Sh == p->tok);

case (MDOC_El):

if (MDOC_It == p->tok)

return(1);

break;

case (MDOC_Oc):

if (MDOC_Op == p->tok)

return(1);

break;

default:

break;

}

if (MDOC_EXPLICIT & mdoc_macros[tok].flags)

return(p->tok == rew_alt(tok));

* Default block rewinding rules.

else if (MDOC_BLOCK == p->type)

* In particular, always skip block end markers,

return(1);

* and let all blocks rewind Nm children.

if (ENDBODY_NOT != p->end || MDOC_Nm == p->tok ||

(MDOC_BLOCK == p->type &&

! (MDOC_EXPLICIT & mdoc_macros[tok].flags)))

return(REWIND_MORE);

return(tok == p->tok);

* By default, closing out full blocks

* forces closing of broken explicit blocks,

* while closing out partial blocks

* allows delayed rewinding by default.

return (&blk_full == mdoc_macros[tok].fp ?

REWIND_FORCE : REWIND_LATER);

}

Line 573 rew_elem(struct mdoc *mdoc, enum mdoct tok)

Line 453 rew_elem(struct mdoc *mdoc, enum mdoct tok)

}

* We are trying to close a block identified by tok,

* but the child block *broken is still open.

* Thus, postpone closing the tok block

* until the rew_sub call closing *broken.

static int

make_pending(struct mdoc_node *broken, enum mdoct tok,

struct mdoc *m, int line, int ppos)

{

struct mdoc_node *breaker;

* Iterate backwards, searching for the block matching tok,

* that is, the block breaking the *broken block.

for (breaker = broken->parent; breaker; breaker = breaker->parent) {

* If the *broken block had already been broken before

* and we encounter its breaker, make the tok block

* pending on the inner breaker.

* Graphically, "[A breaker=[B broken=[C->B B] tok=A] C]"

* becomes "[A broken=[B [C->B B] tok=A] C]"

* and finally "[A [B->A [C->B B] A] C]".

if (breaker == broken->pending) {

broken = breaker;

continue;

}

if (REWIND_THIS != rew_dohalt(tok, MDOC_BLOCK, breaker))

continue;

if (MDOC_BODY == broken->type)

broken = broken->parent;

* Found the breaker.

* If another, outer breaker is already pending on

* the *broken block, we must not clobber the link

* to the outer breaker, but make it pending on the

* new, now inner breaker.

* Graphically, "[A breaker=[B broken=[C->A A] tok=B] C]"

* becomes "[A breaker=[B->A broken=[C A] tok=B] C]"

* and finally "[A [B->A [C->B A] B] C]".

if (broken->pending) {

struct mdoc_node *taker;

* If the breaker had also been broken before,

* it cannot take on the outer breaker itself,

* but must hand it on to its own breakers.

* Graphically, this is the following situation:

* "[A [B breaker=[C->B B] broken=[D->A A] tok=C] D]"

* "[A taker=[B->A breaker=[C->B B] [D->C A] C] D]"

taker = breaker;

while (taker->pending)

taker = taker->pending;

taker->pending = broken->pending;

}

broken->pending = breaker;

mandoc_vmsg(MANDOCERR_SCOPENEST, m->parse, line, ppos,

"%s breaks %s", mdoc_macronames[tok],

mdoc_macronames[broken->tok]);

return(1);

}

* Found no matching block for tok.

* Are you trying to close a block that is not open?

return(0);

}

static int

rew_sub(enum mdoc_type t, struct mdoc *m,

enum mdoct tok, int line, int ppos)

{

struct mdoc_node *n;

enum rew c;

/* LINTED */

n = m->last;

for (n = m->last; n; n = n->parent) {

while (n) {

c = rew_dohalt(tok, t, n);

switch (rew_dohalt(tok, t, n)) {

if (REWIND_HALT == c) {

case (REWIND_NONE):

if (MDOC_BLOCK != t)

return(1);

case (REWIND_THIS):

if ( ! (MDOC_EXPLICIT & mdoc_macros[tok].flags))

return(1);

return(mdoc_perr(m, line, ppos, ENOCTX));

}

if (REWIND_REWIND == c)

break;

else if (rew_dobreak(tok, n))

case (REWIND_FORCE):

mandoc_vmsg(MANDOCERR_SCOPEBROKEN, m->parse,

line, ppos, "%s breaks %s",

mdoc_macronames[tok],

mdoc_macronames[n->tok]);

/* FALLTHROUGH */

case (REWIND_MORE):

n = n->parent;

continue;

if ( ! swarn(m, t, line, ppos, n))

case (REWIND_LATER):

return(0);

if (make_pending(n, tok, m, line, ppos) ||

MDOC_BLOCK != t)

return(1);

/* FALLTHROUGH */

case (REWIND_ERROR):

mdoc_pmsg(m, line, ppos, MANDOCERR_NOSCOPE);

return(1);

}

break;

}

assert(n);

if ( ! rew_last(m, n))

return(0);

#ifdef UGLY

* The current block extends an enclosing block beyond a line

* The current block extends an enclosing block.

* break. Now that the current block ends, close the enclosing

* Now that the current block ends, close the enclosing block, too.

* block, too.

if (NULL != (n = n->pending)) {

while (NULL != (n = n->pending)) {

assert(MDOC_HEAD == n->type);

if ( ! rew_last(m, n))

return(0);

if ( ! mdoc_body_alloc(m, n->line, n->pos, n->tok))

if (MDOC_HEAD == n->type &&

! mdoc_body_alloc(m, n->line, n->pos, n->tok))

return(0);

}

#endif

return(1);

}

* Allocate a word and check whether it's punctuation or not.

* Punctuation consists of those tokens found in mdoc_isdelim().

static int

dword(struct mdoc *m, int line,

int col, const char *p, enum mdelim d)

{

if (DELIM_MAX == d)

d = mdoc_isdelim(p);

if ( ! mdoc_word_alloc(m, line, col, p))

return(0);

if (DELIM_OPEN == d)

m->last->flags |= MDOC_DELIMO;

* Closing delimiters only suppress the preceding space

* when they follow something, not when they start a new

* block or element, and not when they follow `No'.

* XXX Explicitly special-casing MDOC_No here feels

* like a layering violation. Find a better way

* and solve this in the code related to `No'!

else if (DELIM_CLOSE == d && m->last->prev &&

m->last->prev->tok != MDOC_No)

m->last->flags |= MDOC_DELIMC;

return(1);

}

static int

append_delims(struct mdoc *mdoc, int line, int *pos, char *buf)

append_delims(struct mdoc *m, int line, int *pos, char *buf)

{

int lastarg;

int la;

enum margserr ac;

char *p;

if (0 == buf[*pos])

if ('\0' == buf[*pos])

return(1);

for (;;) {

lastarg = *pos;

la = *pos;

ac = mdoc_zargs(mdoc, line, pos, buf, ARGS_NOWARN, &p);

ac = mdoc_zargs(m, line, pos, buf, &p);

if (ARGS_ERROR == ac)

return(0);

else if (ARGS_EOLN == ac)

break;

assert(mdoc_isdelim(p));

if ( ! mdoc_word_alloc(mdoc, line, lastarg, p))

dword(m, line, la, p, DELIM_MAX);

return(0);

* If we encounter end-of-sentence symbols, then trigger

* the double-space.

* XXX: it's easy to allow this to propagate outward to

* the last symbol, such that `. )' will cause the

* correct double-spacing. However, (1) groff isn't

* smart enough to do this and (2) it would require

* knowing which symbols break this behaviour, for

* example, `. ;' shouldn't propagate the double-space.

if (mandoc_eos(p, strlen(p), 0))

m->last->flags |= MDOC_EOS;

}

return(1);

Line 654 append_delims(struct mdoc *mdoc, int line, int *pos, c

Line 664 append_delims(struct mdoc *mdoc, int line, int *pos, c

static int

blk_exp_close(MACRO_PROT_ARGS)

{

struct mdoc_node *body; /* Our own body. */

struct mdoc_node *later; /* A sub-block starting later. */

struct mdoc_node *n; /* For searching backwards. */

int j, lastarg, maxargs, flushed, nl;

enum margserr ac;

enum mdoct ntok;

enum mdoct atok, ntok;

char *p;

nl = MDOC_NEWLINE & m->flags;

Line 670 blk_exp_close(MACRO_PROT_ARGS)

Line 684 blk_exp_close(MACRO_PROT_ARGS)

break;

}

* Search backwards for beginnings of blocks,

* both of our own and of pending sub-blocks.

atok = rew_alt(tok);

body = later = NULL;

for (n = m->last; n; n = n->parent) {

if (MDOC_VALID & n->flags)

continue;

/* Remember the start of our own body. */

if (MDOC_BODY == n->type && atok == n->tok) {

if (ENDBODY_NOT == n->end)

body = n;

continue;

}

if (MDOC_BLOCK != n->type || MDOC_Nm == n->tok)

continue;

if (atok == n->tok) {

assert(body);

* Found the start of our own block.

* When there is no pending sub block,

* just proceed to closing out.

if (NULL == later)

break;

* When there is a pending sub block,

* postpone closing out the current block

* until the rew_sub() closing out the sub-block.

make_pending(later, tok, m, line, ppos);

* Mark the place where the formatting - but not

* the scope - of the current block ends.

if ( ! mdoc_endbody_alloc(m, line, ppos,

atok, body, ENDBODY_SPACE))

return(0);

break;

}

* When finding an open sub block, remember the last

* open explicit block, or, in case there are only

* implicit ones, the first open implicit block.

if (later &&

MDOC_EXPLICIT & mdoc_macros[later->tok].flags)

continue;

if (MDOC_CALLABLE & mdoc_macros[n->tok].flags)

later = n;

}

if ( ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) {

/* FIXME: do this in validate */

if (buf[*pos])

if ( ! mdoc_pwarn(m, line, ppos, ENOLINE))

mdoc_pmsg(m, line, ppos, MANDOCERR_ARGSLOST);

return(0);

if ( ! rew_sub(MDOC_BODY, m, tok, line, ppos))

return(0);

Line 683 blk_exp_close(MACRO_PROT_ARGS)

Line 756 blk_exp_close(MACRO_PROT_ARGS)

if ( ! rew_sub(MDOC_BODY, m, tok, line, ppos))

return(0);

if (maxargs > 0)

if (NULL == later && maxargs > 0)

if ( ! mdoc_tail_alloc(m, line, ppos, rew_alt(tok)))

return(0);

Line 708 blk_exp_close(MACRO_PROT_ARGS)

Line 781 blk_exp_close(MACRO_PROT_ARGS)

ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);

if (MDOC_MAX == ntok) {

if ( ! mdoc_word_alloc(m, line, lastarg, p))

if ( ! dword(m, line, lastarg, p, DELIM_MAX))

return(0);

continue;

}

Line 735 blk_exp_close(MACRO_PROT_ARGS)

Line 808 blk_exp_close(MACRO_PROT_ARGS)

static int

in_line(MACRO_PROT_ARGS)

{

int la, lastpunct, cnt, d, nc, nl;

int la, scope, cnt, nc, nl;

enum margverr av;

enum mdoct ntok;

enum margserr ac;

enum mdelim d;

struct mdoc_arg *arg;

char *p;

Line 756 in_line(MACRO_PROT_ARGS)

Line 830 in_line(MACRO_PROT_ARGS)

/* FALLTHROUGH */

case (MDOC_Fl):

/* FALLTHROUGH */

case (MDOC_Lk):

case (MDOC_Mt):

/* FALLTHROUGH */

case (MDOC_Nm):

/* FALLTHROUGH */

Line 785 in_line(MACRO_PROT_ARGS)

Line 859 in_line(MACRO_PROT_ARGS)

return(0);

}

for (cnt = 0, lastpunct = 1;; ) {

for (cnt = scope = 0;; ) {

la = *pos;

ac = mdoc_args(m, line, pos, buf, tok, &p);

Line 806 in_line(MACRO_PROT_ARGS)

Line 880 in_line(MACRO_PROT_ARGS)

if (MDOC_MAX != ntok) {

if (0 == lastpunct && ! rew_elem(m, tok))

if (scope && ! rew_elem(m, tok))

return(0);

if (nc && 0 == cnt) {

if ( ! mdoc_elem_alloc(m, line, ppos, tok, arg))

Line 815 in_line(MACRO_PROT_ARGS)

Line 889 in_line(MACRO_PROT_ARGS)

return(0);

} else if ( ! nc && 0 == cnt) {

mdoc_argv_free(arg);

if ( ! mdoc_pwarn(m, line, ppos, EIGNE))

mdoc_pmsg(m, line, ppos, MANDOCERR_MACROEMPTY);

return(0);

}

if ( ! mdoc_macro(m, ntok, line, la, pos, buf))

return(0);

if ( ! nl)

Line 831 in_line(MACRO_PROT_ARGS)

Line 905 in_line(MACRO_PROT_ARGS)

* the word.

d = ARGS_QWORD == ac ? 0 : mdoc_isdelim(p);

d = ARGS_QWORD == ac ? DELIM_NONE : mdoc_isdelim(p);

if (ARGS_QWORD != ac && d) {

if (DELIM_NONE != d) {

if (0 == lastpunct && ! rew_elem(m, tok))

* If we encounter closing punctuation, no word

* has been omitted, no scope is open, and we're

* allowed to have an empty element, then start

* a new scope. `Ar', `Fl', and `Li', only do

* this once per invocation. There may be more

* of these (all of them?).

if (0 == cnt && (nc || MDOC_Li == tok) &&

DELIM_CLOSE == d && ! scope) {

if ( ! mdoc_elem_alloc(m, line, ppos, tok, arg))

return(0);

if (MDOC_Ar == tok || MDOC_Li == tok ||

MDOC_Fl == tok)

cnt++;

scope = 1;

}

* Close out our scope, if one is open, before

* any punctuation.

if (scope && ! rew_elem(m, tok))

return(0);

lastpunct = 1;

scope = 0;

} else if (lastpunct) {

} else if ( ! scope) {

if ( ! mdoc_elem_alloc(m, line, ppos, tok, arg))

return(0);

lastpunct = 0;

scope = 1;

}

if ( ! d)

if (DELIM_NONE == d)

cnt++;

if ( ! mdoc_word_alloc(m, line, la, p))

if ( ! dword(m, line, la, p, d))

return(0);

Line 853 in_line(MACRO_PROT_ARGS)

Line 949 in_line(MACRO_PROT_ARGS)

* word so that the `-' can be added to each one without

* having to parse out spaces.

if (0 == lastpunct && MDOC_Fl == tok) {

if (scope && MDOC_Fl == tok) {

if ( ! rew_elem(m, tok))

return(0);

lastpunct = 1;

scope = 0;

}

if (0 == lastpunct && ! rew_elem(m, tok))

if (scope && ! rew_elem(m, tok))

return(0);

Line 876 in_line(MACRO_PROT_ARGS)

Line 972 in_line(MACRO_PROT_ARGS)

return(0);

} else if ( ! nc && 0 == cnt) {

mdoc_argv_free(arg);

if ( ! mdoc_pwarn(m, line, ppos, EIGNE))

mdoc_pmsg(m, line, ppos, MANDOCERR_MACROEMPTY);

return(0);

}

if ( ! nl)

Line 893 blk_full(MACRO_PROT_ARGS)

Line 988 blk_full(MACRO_PROT_ARGS)

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 mdoc_type mtt;

enum mdoct ntok;

enum margserr ac, lac;

enum margverr av;

Line 913 blk_full(MACRO_PROT_ARGS)

Line 1007 blk_full(MACRO_PROT_ARGS)

}

* This routine accomodates implicitly- and explicitly-scoped

* This routine accommodates implicitly- and explicitly-scoped

* macro openings. Implicit ones first close out prior scope

* (seen above). Delay opening the head until necessary to

* allow leading punctuation to print. Special consideration

Line 964 blk_full(MACRO_PROT_ARGS)

Line 1058 blk_full(MACRO_PROT_ARGS)

for ( ; ; ) {

la = *pos;

lac = ac;

/* Initialise last-phrase-type with ARGS_PEND. */

lac = ARGS_ERROR == ac ? ARGS_PEND : ac;

ac = mdoc_args(m, line, pos, buf, tok, &p);

if (ARGS_PUNCT == ac)

break;

if (ARGS_ERROR == ac)

return(0);

if (ARGS_EOLN == ac)

break;

if (ARGS_PEND == ac) {

if (ARGS_EOLN == ac) {

if (ARGS_PPHRASE == lac)

if (ARGS_PPHRASE != lac && ARGS_PHRASE != lac)

ac = ARGS_PPHRASE;

break;

else

ac = ARGS_PHRASE;

* This is necessary: if the last token on a

* line is a `Ta' or tab, then we'll get

* ARGS_EOLN, so we must be smart enough to

* reopen our scope if the last parse was a

* phrase or partial phrase.

if ( ! rew_sub(MDOC_BODY, m, tok, line, ppos))

return(0);

if ( ! mdoc_body_alloc(m, line, ppos, tok))

return(0);

body = m->last;

break;

}

/* Don't emit leading punct. for phrases. */

* Emit leading punctuation (i.e., punctuation before

* the MDOC_HEAD) for non-phrase types.

if (NULL == head &&

ARGS_PEND != ac &&

ARGS_PHRASE != ac &&

ARGS_PPHRASE != ac &&

ARGS_QWORD != ac &&

1 == mdoc_isdelim(p)) {

DELIM_OPEN == mdoc_isdelim(p)) {

if ( ! mdoc_word_alloc(m, line, la, p))

if ( ! dword(m, line, la, p, DELIM_OPEN))

return(0);

continue;

}

/* Always re-open head for phrases. */

/* Open a head if one hasn't been opened. */

if (NULL == head ||

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 == ac || ARGS_PPHRASE == ac) {

if (ARGS_PHRASE == ac ||

ARGS_PEND == ac ||

ARGS_PPHRASE == ac) {

* If we haven't opened a body yet, rewind the

* head; if we have, rewind that instead.

mtt = body ? MDOC_BODY : MDOC_HEAD;

if ( ! rew_sub(mtt, m, tok, line, ppos))

return(0);

/* Then allocate our body context. */

if ( ! mdoc_body_alloc(m, line, ppos, tok))

return(0);

body = m->last;

* Process phrases: set whether we're in a

* partial-phrase (this effects line handling)

* then call down into the phrase parser.

if (ARGS_PPHRASE == ac)

m->flags |= MDOC_PPHRASE;

if ( ! phrase(m, line, la, buf, ac))

if (ARGS_PEND == ac && ARGS_PPHRASE == lac)

m->flags |= MDOC_PPHRASE;

if ( ! phrase(m, line, la, buf))

return(0);

m->flags &= ~MDOC_PPHRASE;

if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos))

return(0);

continue;

}

ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);

if (MDOC_MAX == ntok) {

if ( ! mdoc_word_alloc(m, line, la, p))

if ( ! dword(m, line, la, p, DELIM_MAX))

return(0);

continue;

}

Line 1037 blk_full(MACRO_PROT_ARGS)

Line 1171 blk_full(MACRO_PROT_ARGS)

/* If we've already opened our body, exit now. */

if (NULL != body)

return(1);

goto out;

#ifdef UGLY

* If there is an open (i.e., unvalidated) sub-block requiring

* explicit close-out, postpone switching the current block from

Line 1050 blk_full(MACRO_PROT_ARGS)

Line 1183 blk_full(MACRO_PROT_ARGS)

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);

}

#endif

/* Close out scopes to remain in a consistent state. */

Line 1064 blk_full(MACRO_PROT_ARGS)

Line 1195 blk_full(MACRO_PROT_ARGS)

if ( ! mdoc_body_alloc(m, line, ppos, tok))

return(0);

out:

if ( ! (MDOC_FREECOL & m->flags))

return(1);

if ( ! rew_sub(MDOC_BODY, m, tok, line, ppos))

return(0);

if ( ! rew_sub(MDOC_BLOCK, m, tok, line, ppos))

return(0);

m->flags &= ~MDOC_FREECOL;

return(1);

}

Line 1118 blk_part_imp(MACRO_PROT_ARGS)

Line 1259 blk_part_imp(MACRO_PROT_ARGS)

break;

if (NULL == body && ARGS_QWORD != ac &&

1 == mdoc_isdelim(p)) {

DELIM_OPEN == mdoc_isdelim(p)) {

if ( ! mdoc_word_alloc(m, line, la, p))

if ( ! dword(m, line, la, p, DELIM_OPEN))

return(0);

continue;

}

Line 1133 blk_part_imp(MACRO_PROT_ARGS)

Line 1274 blk_part_imp(MACRO_PROT_ARGS)

ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);

if (MDOC_MAX == ntok) {

if ( ! mdoc_word_alloc(m, line, la, p))

if ( ! dword(m, line, la, p, DELIM_MAX))

return(0);

continue;

}

Line 1160 blk_part_imp(MACRO_PROT_ARGS)

Line 1301 blk_part_imp(MACRO_PROT_ARGS)

if (n && MDOC_TEXT == n->type && n->string)

if (mandoc_eos(n->string, strlen(n->string)))

if (mandoc_eos(n->string, strlen(n->string), 1))

n->flags |= MDOC_EOS;

/* Up-propogate the end-of-space flag. */

/* Up-propagate the end-of-space flag. */

if (n && (MDOC_EOS & n->flags)) {

body->flags |= MDOC_EOS;

body->parent->flags |= MDOC_EOS;

}

* If there is an open sub-block requiring explicit close-out,

* postpone closing out the current block

* until the rew_sub() call closing out the sub-block.

for (n = m->last; n && n != body && n != blk->parent; n = n->parent) {

if (MDOC_BLOCK == n->type &&

MDOC_EXPLICIT & mdoc_macros[n->tok].flags &&

! (MDOC_VALID & n->flags)) {

make_pending(n, tok, m, line, ppos);

if ( ! mdoc_endbody_alloc(m, line, ppos,

tok, body, ENDBODY_NOSPACE))

return(0);

return(1);

}

* If we can't rewind to our body, then our scope has already

* been closed by another macro (like `Oc' closing `Op'). This

* is ugly behaviour nodding its head to OpenBSD's overwhelming

* crufty use of `Op' breakage.

* FIXME - this should be ifdef'd OpenBSD?

for (n = m->last; n; n = n->parent)

if (n != body)

if (body == n)

mandoc_vmsg(MANDOCERR_SCOPENEST, m->parse, line, ppos,

break;

"%s broken", mdoc_macronames[tok]);

if (NULL == n && ! mdoc_nwarn(m, body, EIMPBRK))

if (n && ! rew_sub(MDOC_BODY, m, tok, line, ppos))

return(0);

if (n && ! rew_last(m, body))

return(0);

/* Standard appending of delimiters. */

if (nl && ! append_delims(m, line, pos, buf))

Line 1195 blk_part_imp(MACRO_PROT_ARGS)

Line 1348 blk_part_imp(MACRO_PROT_ARGS)

/* Rewind scope, if applicable. */

if (n && ! rew_last(m, blk))

if (n && ! rew_sub(MDOC_BLOCK, m, tok, line, ppos))

return(0);

return(1);

Line 1237 blk_part_exp(MACRO_PROT_ARGS)

Line 1390 blk_part_exp(MACRO_PROT_ARGS)

/* Flush out leading punctuation. */

if (NULL == head && ARGS_QWORD != ac &&

1 == mdoc_isdelim(p)) {

DELIM_OPEN == mdoc_isdelim(p)) {

assert(NULL == body);

if ( ! mdoc_word_alloc(m, line, la, p))

if ( ! dword(m, line, la, p, DELIM_OPEN))

return(0);

continue;

}

Line 1260 blk_part_exp(MACRO_PROT_ARGS)

Line 1413 blk_part_exp(MACRO_PROT_ARGS)

assert(head);

/* No check whether it's a macro! */

if (MDOC_Eo == tok)

if ( ! mdoc_word_alloc(m, line, la, p))

if ( ! dword(m, line, la, p, DELIM_MAX))

return(0);

if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos))

Line 1278 blk_part_exp(MACRO_PROT_ARGS)

Line 1431 blk_part_exp(MACRO_PROT_ARGS)

ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);

if (MDOC_MAX == ntok) {

if ( ! mdoc_word_alloc(m, line, la, p))

if ( ! dword(m, line, la, p, DELIM_MAX))

return(0);

continue;

}

Line 1290 blk_part_exp(MACRO_PROT_ARGS)

Line 1443 blk_part_exp(MACRO_PROT_ARGS)

/* Clean-up to leave in a consistent state. */

if (NULL == head) {

if (NULL == head)

if ( ! mdoc_head_alloc(m, line, ppos, tok))

return(0);

head = m->last;

}

if (NULL == body) {

if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos))

return(0);

if ( ! mdoc_body_alloc(m, line, ppos, tok))

return(0);

body = m->last;

}

/* Standard appending of delimiters. */

Line 1343 in_line_argn(MACRO_PROT_ARGS)

Line 1493 in_line_argn(MACRO_PROT_ARGS)

case (MDOC_Ux):

maxargs = 0;

break;

case (MDOC_Bx):

/* FALLTHROUGH */

case (MDOC_Xr):

maxargs = 2;

break;

Line 1381 in_line_argn(MACRO_PROT_ARGS)

Line 1533 in_line_argn(MACRO_PROT_ARGS)

break;

if ( ! (MDOC_IGNDELIM & mdoc_macros[tok].flags) &&

ARGS_QWORD != ac &&

ARGS_QWORD != ac && 0 == j &&

0 == j && 1 == mdoc_isdelim(p)) {

DELIM_OPEN == mdoc_isdelim(p)) {

if ( ! mdoc_word_alloc(m, line, la, p))

if ( ! dword(m, line, la, p, DELIM_OPEN))

return(0);

continue;

} else if (0 == j)

Line 1410 in_line_argn(MACRO_PROT_ARGS)

Line 1562 in_line_argn(MACRO_PROT_ARGS)

if ( ! (MDOC_IGNDELIM & mdoc_macros[tok].flags) &&

ARGS_QWORD != ac &&

! flushed && mdoc_isdelim(p)) {

! flushed &&

DELIM_NONE != mdoc_isdelim(p)) {

if ( ! rew_elem(m, tok))

return(0);

flushed = 1;

}

if ( ! dword(m, line, la, p, DELIM_MAX))

* XXX: this is a hack to work around groff's ugliness

* as regards `Xr' and extraneous arguments. It should

* ideally be deprecated behaviour, but because this is

* code is no here, it's unlikely to be removed.

#ifdef __OpenBSD__

if (MDOC_Xr == tok && j == maxargs) {

if ( ! mdoc_elem_alloc(m, line, la, MDOC_Ns, NULL))

return(0);

if ( ! rew_elem(m, MDOC_Ns))

return(0);

}

#endif

if ( ! mdoc_word_alloc(m, line, la, p))

return(0);

j++;

}

Line 1462 in_line_eoln(MACRO_PROT_ARGS)

Line 1599 in_line_eoln(MACRO_PROT_ARGS)

assert( ! (MDOC_PARSED & mdoc_macros[tok].flags));

if (tok == MDOC_Pp)

rew_sub(MDOC_BLOCK, m, MDOC_Nm, line, ppos);

/* Parse macro arguments. */

for (arg = NULL; ; ) {

Line 1500 in_line_eoln(MACRO_PROT_ARGS)

Line 1640 in_line_eoln(MACRO_PROT_ARGS)

ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);

if (MDOC_MAX == ntok) {

if ( ! mdoc_word_alloc(m, line, la, p))

if ( ! dword(m, line, la, p, DELIM_MAX))

return(0);

continue;

}

Line 1525 ctx_synopsis(MACRO_PROT_ARGS)

Line 1665 ctx_synopsis(MACRO_PROT_ARGS)

nl = MDOC_NEWLINE & m->flags;

/* If we're not in the SYNOPSIS, go straight to in-line. */

if (SEC_SYNOPSIS != m->lastsec)

if ( ! (MDOC_SYNOPSIS & m->flags))

return(in_line(m, tok, line, ppos, pos, buf));

/* If we're a nested call, same place. */

Line 1537 ctx_synopsis(MACRO_PROT_ARGS)

Line 1677 ctx_synopsis(MACRO_PROT_ARGS)

* up formatting the block scope, then child nodes will inherit

* the formatting. Be careful.

if (MDOC_Nm == tok)

return(blk_full(m, tok, line, ppos, pos, buf));

assert(MDOC_Vt == tok);

return(blk_part_imp(m, tok, line, ppos, pos, buf));

}

Line 1547 static int

Line 1689 static int

obsolete(MACRO_PROT_ARGS)

{

return(mdoc_pwarn(m, line, ppos, EOBS));

mdoc_pmsg(m, line, ppos, MANDOCERR_MACROOBS);

return(1);

}

Line 1557 obsolete(MACRO_PROT_ARGS)

Line 1700 obsolete(MACRO_PROT_ARGS)

* macro is encountered.

static int

phrase(struct mdoc *m, int line, int ppos, char *buf, enum margserr ac)

phrase(struct mdoc *m, int line, int ppos, char *buf)

{

int la, pos;

enum margserr aac;

enum margserr ac;

enum mdoct ntok;

char *p;

assert(ARGS_PHRASE == ac || ARGS_PPHRASE == ac);

for (pos = ppos; ; ) {

la = pos;

aac = mdoc_zargs(m, line, &pos, buf, 0, &p);

ac = mdoc_zargs(m, line, &pos, buf, &p);

if (ARGS_ERROR == aac)

if (ARGS_ERROR == ac)

return(0);

if (ARGS_EOLN == aac)

if (ARGS_EOLN == ac)

break;

ntok = ARGS_QWORD == aac ? MDOC_MAX : lookup_raw(p);

ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup_raw(p);

if (MDOC_MAX == ntok) {

if ( ! mdoc_word_alloc(m, line, la, p))

if ( ! dword(m, line, la, p, DELIM_MAX))

return(0);

continue;

}

Line 1593 phrase(struct mdoc *m, int line, int ppos, char *buf,

Line 1734 phrase(struct mdoc *m, int line, int ppos, char *buf,

}

/* ARGSUSED */

static int

phrase_ta(MACRO_PROT_ARGS)

{

int la;

enum mdoct ntok;

enum margserr ac;

char *p;

* FIXME: this is overly restrictive: if the `Ta' is unexpected,

* it should simply error out with ARGSLOST.

if ( ! rew_sub(MDOC_BODY, m, MDOC_It, line, ppos))

return(0);

if ( ! mdoc_body_alloc(m, line, ppos, MDOC_It))

return(0);

for (;;) {

la = *pos;

ac = mdoc_zargs(m, line, pos, buf, &p);

if (ARGS_ERROR == ac)

return(0);

if (ARGS_EOLN == ac)

break;

ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup_raw(p);

if (MDOC_MAX == ntok) {

if ( ! dword(m, line, la, p, DELIM_MAX))

return(0);

continue;

}

if ( ! mdoc_macro(m, ntok, line, la, pos, buf))

return(0);

return(append_delims(m, line, pos, buf));

}

return(1);

}

CVSweb