=================================================================== RCS file: /cvs/mandoc/mdoc_macro.c,v retrieving revision 1.42 retrieving revision 1.45 diff -u -p -r1.42 -r1.45 --- mandoc/mdoc_macro.c 2010/02/17 19:28:11 1.42 +++ mandoc/mdoc_macro.c 2010/03/30 06:52:08 1.45 @@ -1,4 +1,4 @@ -/* $Id: mdoc_macro.c,v 1.42 2010/02/17 19:28:11 kristaps Exp $ */ +/* $Id: mdoc_macro.c,v 1.45 2010/03/30 06:52:08 kristaps Exp $ */ /* * Copyright (c) 2008, 2009 Kristaps Dzonsons * @@ -714,6 +714,7 @@ in_line(MACRO_PROT_ARGS) * Whether we allow ignored elements (those without content, * usually because of reserved words) to squeak by. */ + switch (tok) { case (MDOC_An): /* FALLTHROUGH */ @@ -835,8 +836,8 @@ in_line(MACRO_PROT_ARGS) * If no elements have been collected and we're allowed to have * empties (nc), open a scope and close it out. Otherwise, * raise a warning. - * */ + if (nc && 0 == cnt) { if ( ! mdoc_elem_alloc(m, line, ppos, tok, arg)) return(0); @@ -857,26 +858,13 @@ in_line(MACRO_PROT_ARGS) static int blk_full(MACRO_PROT_ARGS) { - int c, lastarg, reopen, dohead; + int c, la; struct mdoc_arg *arg; + struct mdoc_node *head; /* save of head macro */ char *p; - /* - * Whether to process a block-head section. If this is - * non-zero, then a head will be opened for all line arguments. - * If not, then the head will always be empty and only a body - * will be opened, which will stay open at the eoln. - */ + /* Close out prior implicit scope. */ - switch (tok) { - case (MDOC_Nd): - dohead = 0; - break; - default: - dohead = 1; - break; - } - if ( ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)) { if ( ! rew_sub(MDOC_BODY, m, tok, line, ppos)) return(0); @@ -884,12 +872,21 @@ blk_full(MACRO_PROT_ARGS) return(0); } + /* + * This routine accomodates 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 + * for `It -column', which has phrase-part syntax instead of + * regular child nodes. + */ + for (arg = NULL;; ) { - lastarg = *pos; + la = *pos; c = mdoc_argv(m, line, tok, &arg, pos, buf); if (ARGV_WORD == c) { - *pos = lastarg; + *pos = la; break; } @@ -905,72 +902,84 @@ blk_full(MACRO_PROT_ARGS) if ( ! mdoc_block_alloc(m, line, ppos, tok, arg)) return(0); - if (0 == buf[*pos]) { + head = NULL; + + /* + * The `Nd' macro has all arguments in its body: it's a hybrid + * of block partial-explicit and full-implicit. Stupid. + */ + + if (MDOC_Nd == tok) { if ( ! mdoc_head_alloc(m, line, ppos, tok)) return(0); + head = m->last; if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos)) return(0); if ( ! mdoc_body_alloc(m, line, ppos, tok)) return(0); - return(1); - } - - if ( ! mdoc_head_alloc(m, line, ppos, tok)) - return(0); - - /* Immediately close out head and enter body, if applicable. */ - - if (0 == dohead) { - if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos)) - return(0); - if ( ! mdoc_body_alloc(m, line, ppos, tok)) - return(0); } - for (reopen = 0;; ) { - lastarg = *pos; + for (;;) { + la = *pos; c = mdoc_args(m, line, pos, buf, tok, &p); if (ARGS_ERROR == c) return(0); if (ARGS_EOLN == c) break; - if (ARGS_PHRASE == c) { - assert(dohead); - if (reopen && ! mdoc_head_alloc(m, line, ppos, tok)) + + /* Don't emit leading punct. for phrases. */ + + if (NULL == head && ARGS_PHRASE != c && + 1 == mdoc_isdelim(p)) { + if ( ! mdoc_word_alloc(m, line, la, p)) return(0); - /* - * Phrases are self-contained macro phrases used - * in the columnar output of a macro. They need - * special handling. - */ - if ( ! phrase(m, line, lastarg, buf)) + continue; + } + + /* Always re-open head for phrases. */ + + if (NULL == head || ARGS_PHRASE == c) { + if ( ! mdoc_head_alloc(m, line, ppos, tok)) return(0); + head = m->last; + } + + if (ARGS_PHRASE == c) { + if ( ! phrase(m, line, la, buf)) + return(0); if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos)) return(0); - - reopen = 1; continue; } - if (MDOC_MAX == (c = lookup(tok, p))) { - if ( ! mdoc_word_alloc(m, line, lastarg, p)) + c = lookup(tok, p); + if (MDOC_MAX != c) { + if ( ! mdoc_macro(m, c, line, la, pos, buf)) return(0); - continue; - } + break; + } + if ( ! mdoc_word_alloc(m, line, la, p)) + return(0); - if ( ! mdoc_macro(m, c, line, lastarg, pos, buf)) + } + + if (NULL == head) { + if ( ! mdoc_head_alloc(m, line, ppos, tok)) return(0); - break; + head = m->last; } if (1 == ppos && ! append_delims(m, line, pos, buf)) return(0); - /* If the body's already open, then just return. */ - if (0 == dohead) + /* See notes on `Nd' hybrid, above. */ + + if (MDOC_Nd == tok) return(1); + /* Close out scopes to remain in a consistent state. */ + if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos)) return(0); if ( ! mdoc_body_alloc(m, line, ppos, tok)) @@ -985,59 +994,92 @@ blk_part_imp(MACRO_PROT_ARGS) { int la, c; char *p; - struct mdoc_node *blk, *body, *n; + struct mdoc_node *blk; /* saved block context */ + struct mdoc_node *body; /* saved body context */ + struct mdoc_node *n; - /* If applicable, close out prior scopes. */ + /* + * A macro that spans to the end of the line. This is generally + * (but not necessarily) called as the first macro. The block + * has a head as the immediate child, which is always empty, + * followed by zero or more opening punctuation nodes, then the + * body (which may be empty, depending on the macro), then zero + * or more closing punctuation nodes. + */ if ( ! mdoc_block_alloc(m, line, ppos, tok, NULL)) return(0); - /* Saved for later close-out. */ + blk = m->last; + if ( ! mdoc_head_alloc(m, line, ppos, tok)) return(0); if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos)) return(0); - if ( ! mdoc_body_alloc(m, line, ppos, tok)) - return(0); - /* Saved for later close-out. */ - body = m->last; - /* Body argument processing. */ + /* + * Open the body scope "on-demand", that is, after we've + * processed all our the leading delimiters (open parenthesis, + * etc.). + */ - for (;;) { + for (body = NULL; ; ) { la = *pos; c = mdoc_args(m, line, pos, buf, tok, &p); + assert(ARGS_PHRASE != c); if (ARGS_ERROR == c) return(0); - if (ARGS_PUNCT == c) - break; if (ARGS_EOLN == c) break; + if (ARGS_PUNCT == c) + break; - if (MDOC_MAX == (c = lookup(tok, p))) { + if (NULL == body && 1 == mdoc_isdelim(p)) { if ( ! mdoc_word_alloc(m, line, la, p)) return(0); continue; } - if ( ! mdoc_macro(m, c, line, la, pos, buf)) + if (NULL == body) { + if ( ! mdoc_body_alloc(m, line, ppos, tok)) + return(0); + body = m->last; + } + + if (MDOC_MAX != (c = lookup(tok, p))) { + if ( ! mdoc_macro(m, c, line, la, pos, buf)) + return(0); + break; + } + + if ( ! mdoc_word_alloc(m, line, la, p)) return(0); - break; } + /* Clean-ups to leave in a consistent state. */ + + if (NULL == body) { + if ( ! mdoc_body_alloc(m, line, ppos, tok)) + return(0); + body = m->last; + } + /* * 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--XXX, deprecate in time. + * crufty use of `Op' breakage. XXX: DEPRECATE. */ + for (n = m->last; n; n = n->parent) if (body == n) break; + if (NULL == n && ! mdoc_nwarn(m, body, EIMPBRK)) return(0); + if (n && ! rew_last(m, body)) return(0); @@ -1058,59 +1100,23 @@ blk_part_imp(MACRO_PROT_ARGS) static int blk_part_exp(MACRO_PROT_ARGS) { - int la, flushed, j, c, maxargs; + int la, c; + struct mdoc_node *head; /* keep track of head */ + struct mdoc_node *body; /* keep track of body */ char *p; - /* Number of head arguments. Only `Eo' has these, */ + /* + * The opening of an explicit macro having zero or more leading + * punctuation nodes; a head with optional single element (the + * case of `Eo'); and a body that may be empty. + */ - switch (tok) { - case (MDOC_Eo): - maxargs = 1; - break; - default: - maxargs = 0; - break; - } - - /* Begin the block scope. */ - if ( ! mdoc_block_alloc(m, line, ppos, tok, NULL)) return(0); - /* - * If no head arguments, open and then close out a head, noting - * that we've flushed our terms. `flushed' means that we've - * flushed out the head and the body is open. - */ - - if (0 == maxargs) { - if ( ! mdoc_head_alloc(m, line, ppos, tok)) - return(0); - if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos)) - return(0); - if ( ! mdoc_body_alloc(m, line, ppos, tok)) - return(0); - flushed = 1; - } else { - if ( ! mdoc_head_alloc(m, line, ppos, tok)) - return(0); - flushed = 0; - } - - /* Process the head/head+body line arguments. */ - - for (j = 0; ; j++) { + for (head = body = NULL; ; ) { la = *pos; - if (j == maxargs && ! flushed) { - if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos)) - return(0); - flushed = 1; - if ( ! mdoc_body_alloc(m, line, ppos, tok)) - return(0); - } - c = mdoc_args(m, line, pos, buf, tok, &p); - assert(ARGS_PHRASE != c); if (ARGS_ERROR == c) return(0); @@ -1119,44 +1125,79 @@ blk_part_exp(MACRO_PROT_ARGS) if (ARGS_EOLN == c) break; - if (MDOC_MAX != (c = lookup(tok, p))) { - if ( ! flushed) { - if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos)) - return(0); - flushed = 1; - if ( ! mdoc_body_alloc(m, line, ppos, tok)) - return(0); - } - if ( ! mdoc_macro(m, c, line, la, pos, buf)) + assert(ARGS_PHRASE != c); + + /* Flush out leading punctuation. */ + + if (NULL == head && 1 == mdoc_isdelim(p)) { + assert(NULL == body); + if ( ! mdoc_word_alloc(m, line, la, p)) return(0); - break; + continue; + } + + if (NULL == head) { + assert(NULL == body); + if ( ! mdoc_head_alloc(m, line, ppos, tok)) + return(0); + head = m->last; } - if ( ! flushed && mdoc_isdelim(p)) { + /* + * `Eo' gobbles any data into the head, but most other + * macros just immediately close out and begin the body. + */ + + if (NULL == body) { + assert(head); + /* No check whether it's a macro! */ + if (MDOC_Eo == tok) + if ( ! mdoc_word_alloc(m, line, la, p)) + return(0); + if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos)) return(0); - flushed = 1; if ( ! mdoc_body_alloc(m, line, ppos, tok)) return(0); + body = m->last; + + if (MDOC_Eo == tok) + continue; } - + + assert(NULL != head && NULL != body); + + if (MDOC_MAX != (c = lookup(tok, p))) { + if ( ! mdoc_macro(m, c, line, la, pos, buf)) + return(0); + break; + } + if ( ! mdoc_word_alloc(m, line, la, p)) return(0); } - /* Close the head and open the body, if applicable. */ + /* Clean-up to leave in a consistent state. */ - if ( ! flushed) { + 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. */ if (ppos > 1) return(1); + return(append_delims(m, line, pos, buf)); } @@ -1255,6 +1296,7 @@ in_line_argn(MACRO_PROT_ARGS) * ideally be deprecated behaviour, but because this is * code is no here, it's unlikely to be removed. */ + if (MDOC_Xr == tok && j == maxargs) { if ( ! mdoc_elem_alloc(m, line, ppos, MDOC_Ns, NULL)) return(0);