/* * 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) return(1); if (MDOC_Ss == p->tok) 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)); else if (MDOC_BLOCK == p->type) return(1); return(tok == p->tok); }
/* * Close out block partial/full explicit. */ static void blk_exp_close(MACRO_PROT_ARGS) { struct roff_node *body; /* Our own body. */ struct roff_node *endbody; /* Our own end marker. */ struct roff_node *itblk; /* An It block starting later. */ struct roff_node *later; /* A sub-block starting later. */ struct roff_node *n; /* Search back to our block. */ struct roff_node *target; /* For find_pending(). */ int j, lastarg, maxargs, nl, pending; enum margserr ac; int atok, ntok; char *p; nl = MDOC_NEWLINE & mdoc->flags; switch (tok) { case MDOC_Ec: maxargs = 1; break; case MDOC_Ek: mdoc->flags &= ~MDOC_KEEP; /* FALLTHROUGH */ default: maxargs = 0; break; } /* * Search backwards for beginnings of blocks, * both of our own and of pending sub-blocks. */ atok = rew_alt(tok); body = endbody = itblk = later = NULL; for (n = mdoc->last; n; n = n->parent) { if (n->flags & MDOC_ENDED) { if ( ! (n->flags & MDOC_VALID)) n->flags |= MDOC_BROKEN; continue; } /* Remember the start of our own body. */ if (n->type == ROFFT_BODY && atok == n->tok) { if (n->end == ENDBODY_NOT) body = n; continue; } if (n->type != ROFFT_BLOCK || n->tok == MDOC_Nm) continue; if (n->tok == MDOC_It) { itblk = n; 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 (later == NULL || (tok == MDOC_El && itblk == NULL)) break; /* * When there is a pending sub block, postpone * closing out the current block until the * rew_pending() closing out the sub-block. * Mark the place where the formatting - but not * the scope - of the current block ends. */ mandoc_vmsg(MANDOCERR_BLK_NEST, mdoc->parse, line, ppos, "%s breaks %s", mdoc_macronames[atok], mdoc_macronames[later->tok]); endbody = mdoc_endbody_alloc(mdoc, line, ppos, atok, body, ENDBODY_SPACE); if (tok == MDOC_El) itblk->flags |= MDOC_ENDED | MDOC_BROKEN; /* * If a block closing macro taking arguments * breaks another block, put the arguments * into the end marker. */ if (maxargs) mdoc->next = ROFF_NEXT_CHILD; break; } /* Explicit blocks close out description lines. */ if (n->tok == MDOC_Nd) { rew_last(mdoc, n); continue; } /* Breaking an open sub block. */ n->flags |= MDOC_BROKEN; if (later == NULL) later = n; } if (body == NULL) { mandoc_msg(MANDOCERR_BLK_NOTOPEN, mdoc->parse, line, ppos, mdoc_macronames[tok]); if (later != NULL) later->flags &= ~MDOC_BROKEN; if (maxargs && endbody == NULL) { /* * Stray .Ec without previous .Eo: * Break the output line, keep the arguments. */ roff_elem_alloc(mdoc, line, ppos, MDOC_br); rew_elem(mdoc, MDOC_br); } } else if (endbody == NULL) { rew_last(mdoc, body); if (maxargs) mdoc_tail_alloc(mdoc, line, ppos, atok); } if ( ! (mdoc_macros[tok].flags & MDOC_PARSED)) { if (buf[*pos] != '\0') mandoc_vmsg(MANDOCERR_ARG_SKIP, mdoc->parse, line, ppos, "%s %s", mdoc_macronames[tok], buf + *pos); if (endbody == NULL && n != NULL) rew_pending(mdoc, n); return; } if (endbody != NULL) n = endbody; ntok = TOKEN_NONE; for (j = 0; ; j++) { lastarg = *pos; if (j == maxargs && n != NULL) rew_last(mdoc, n); ac = mdoc_args(mdoc, line, pos, buf, tok, &p); if (ac == ARGS_PUNCT || ac == ARGS_EOLN) break; ntok = ac == ARGS_QWORD ? TOKEN_NONE : lookup(mdoc, tok, line, lastarg, p); if (ntok == TOKEN_NONE) { dword(mdoc, line, lastarg, p, DELIM_MAX, MDOC_JOIN & mdoc_macros[tok].flags); continue; } if (n != NULL) rew_last(mdoc, n); mdoc->flags &= ~MDOC_NEWLINE; mdoc_macro(mdoc, ntok, line, lastarg, pos, buf); break; } if (n != NULL) { if (ntok != TOKEN_NONE && n->flags & MDOC_BROKEN) { target = n; do target = target->parent; while ( ! (target->flags & MDOC_ENDED)); pending = find_pending(mdoc, ntok, line, ppos, target); } else pending = 0; if ( ! pending) rew_pending(mdoc, n); } if (nl) append_delims(mdoc, line, pos, buf); }
/* * Close out block partial/full explicit. */ 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 atok, ntok; char *p; nl = MDOC_NEWLINE & m->flags; switch (tok) { case (MDOC_Ec): maxargs = 1; break; default: maxargs = 0; 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]) mdoc_pmsg(m, line, ppos, MANDOCERR_ARGSLOST); if ( ! rew_sub(MDOC_BODY, m, tok, line, ppos)) return(0); return(rew_sub(MDOC_BLOCK, m, tok, line, ppos)); } if ( ! rew_sub(MDOC_BODY, m, tok, line, ppos)) return(0); if (NULL == later && maxargs > 0) if ( ! mdoc_tail_alloc(m, line, ppos, rew_alt(tok))) return(0); for (flushed = j = 0; ; j++) { lastarg = *pos; if (j == maxargs && ! flushed) { if ( ! rew_sub(MDOC_BLOCK, m, tok, line, ppos)) return(0); flushed = 1; } ac = mdoc_args(m, line, pos, buf, tok, &p); if (ARGS_ERROR == ac) return(0); if (ARGS_PUNCT == ac) break; if (ARGS_EOLN == ac) break; ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p); if (MDOC_MAX == ntok) { if ( ! dword(m, line, lastarg, p, DELIM_MAX)) return(0); continue; } 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)) return(0); if ( ! nl) return(1); return(append_delims(m, line, pos, buf)); }
/* * Rewinding to tok, how do we have to handle *p? * REWIND_NONE: *p would delimit tok, but no tok scope is open * inside *p, so there is no need to rewind anything at all. * 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(MDOC_BLOCK == type && MDOC_EXPLICIT & mdoc_macros[tok].flags ? 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_Bl): if (MDOC_It == p->tok) return(REWIND_MORE); break; case (MDOC_It): if (MDOC_BODY == p->type && MDOC_Bl == p->tok) return(REWIND_NONE); break; /* * XXX Badly nested block handling still fails badly * 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): if (MDOC_BODY == p->type && MDOC_Sh == p->tok) return(REWIND_NONE); /* FALLTHROUGH */ case (MDOC_Sh): if (MDOC_Nd == p->tok || MDOC_Ss == p->tok || MDOC_Sh == p->tok) return(REWIND_MORE); break; default: break; } /* * Default block rewinding rules. * In particular, always skip block end markers, * 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); /* * 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); }
/* * Close out block partial/full explicit. */ static int blk_exp_close(MACRO_PROT_ARGS) { int j, lastarg, maxargs, flushed, nl; enum margserr ac; enum mdoct ntok; char *p; nl = MDOC_NEWLINE & m->flags; switch (tok) { case (MDOC_Ec): maxargs = 1; break; default: maxargs = 0; break; } if ( ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) { /* FIXME: do this in validate */ if (buf[*pos]) if ( ! mdoc_pmsg(m, line, ppos, MANDOCERR_ARGSLOST)) return(0); if ( ! rew_sub(MDOC_BODY, m, tok, line, ppos)) return(0); return(rew_sub(MDOC_BLOCK, m, tok, line, ppos)); } if ( ! rew_sub(MDOC_BODY, m, tok, line, ppos)) return(0); if (maxargs > 0) if ( ! mdoc_tail_alloc(m, line, ppos, rew_alt(tok))) return(0); for (flushed = j = 0; ; j++) { lastarg = *pos; if (j == maxargs && ! flushed) { if ( ! rew_sub(MDOC_BLOCK, m, tok, line, ppos)) return(0); flushed = 1; } ac = mdoc_args(m, line, pos, buf, tok, &p); if (ARGS_ERROR == ac) return(0); if (ARGS_PUNCT == ac) break; if (ARGS_EOLN == ac) break; ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p); if (MDOC_MAX == ntok) { if ( ! mdoc_word_alloc(m, line, lastarg, p)) return(0); continue; } 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)) return(0); if ( ! nl) return(1); return(append_delims(m, line, pos, buf)); }
/* * Rewind rules. This indicates whether to stop rewinding * (REWIND_HALT) without touching our current scope, stop rewinding and * close our current scope (REWIND_REWIND), or continue (REWIND_NOHALT). * The scope-closing and so on occurs in the various rew_* routines. */ static enum rew rew_dohalt(enum mdoct tok, enum mdoc_type type, const struct mdoc_node *p) { if (MDOC_ROOT == p->type) return(REWIND_HALT); if (MDOC_VALID & p->flags) return(REWIND_NOHALT); switch (tok) { case (MDOC_Aq): /* FALLTHROUGH */ case (MDOC_Bq): /* 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); break; case (MDOC_Sh): if (type == p->type && tok == p->tok) return(REWIND_REWIND); break; 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); 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); }