Clarified EXIT STATUS sections. Discussed among schwarze@, Thomas, and

[mandoc.git] / mdoc_macro.c

diff --git a/mdoc_macro.c b/mdoc_macro.c
index 59739af82b5e96b10e990e54924fa2fab4e7f0e0..91972f3418d5ee19fa6142396de339c918b8fcbf 100644 (file)
--- a/mdoc_macro.c
+++ b/mdoc_macro.c
@@ -1,6 +1,7 @@
-/*     $Id: mdoc_macro.c,v 1.85 2010/06/29 19:45:06 schwarze Exp $ */
+/*     $Id: mdoc_macro.c,v 1.93 2010/07/18 17:00:26 schwarze Exp $ */

 /*
 /*

- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>

  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above


@@ -34,7 +35,7 @@ enum  rew {   /* see rew_dohalt() */
        REWIND_THIS,
        REWIND_MORE,
        REWIND_LATER,
        REWIND_THIS,
        REWIND_MORE,
        REWIND_LATER,

-       REWIND_ERROR,
+       REWIND_ERROR

 };
 
 static int             blk_full(MACRO_PROT_ARGS);
 };
 
 static int             blk_full(MACRO_PROT_ARGS);


@@ -97,7 +98,7 @@ 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_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 */
        { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Op */
        { obsolete, 0 }, /* Ot */
        { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Pa */


@@ -335,21 +336,44 @@ rew_dohalt(enum mdoct tok, enum mdoc_type type,
                const struct mdoc_node *p)
 {
 
                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);
        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);
 
        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);
 
        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);
 
        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)
        switch (tok) {
        case (MDOC_Bl):
                if (MDOC_It == p->tok)


@@ -369,6 +393,8 @@ rew_dohalt(enum mdoct tok, enum mdoc_type type,
                if (MDOC_Op == p->tok)
                        return(REWIND_MORE);
                break;
                if (MDOC_Op == p->tok)
                        return(REWIND_MORE);
                break;

+       case (MDOC_Nm):
+               return(REWIND_NONE);

        case (MDOC_Nd):
                /* FALLTHROUGH */
        case (MDOC_Ss):
        case (MDOC_Nd):
                /* FALLTHROUGH */
        case (MDOC_Ss):


@@ -384,9 +410,27 @@ rew_dohalt(enum mdoct tok, enum mdoc_type type,
                break;
        }
 
                break;
        }
 

-       return(p->end || (MDOC_BLOCK == p->type &&
-           ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)) ?
-           REWIND_MORE : REWIND_LATER);
+       /*
+        * 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);
+
+       /*
+        * Partial blocks allow delayed rewinding by default.
+        */
+       if (&blk_full != mdoc_macros[tok].fp)
+               return (REWIND_LATER);
+
+       /*
+        * Full blocks can only be rewound when matching
+        * or when there is an explicit rule.
+        */
+       return(REWIND_ERROR);

 }
 
 
 }
 
 


@@ -468,8 +512,9 @@ make_pending(struct mdoc_node *broken, enum mdoct tok,
                        taker->pending = broken->pending;
                }
                broken->pending = breaker;
                        taker->pending = broken->pending;
                }
                broken->pending = breaker;

-               mdoc_vmsg(m, MANDOCERR_SCOPE, line, ppos, "%s breaks %s",
-                   mdoc_macronames[tok], mdoc_macronames[broken->tok]);
+               mdoc_vmsg(m, MANDOCERR_SCOPENEST, line, ppos,
+                   "%s breaks %s", mdoc_macronames[tok],
+                   mdoc_macronames[broken->tok]);

                return(1);
        }
 
                return(1);
        }
 


@@ -503,7 +548,9 @@ rew_sub(enum mdoc_type t, struct mdoc *m,
                        return(make_pending(n, tok, m, line, ppos));
                case (REWIND_ERROR):
                        /* XXX Make this non-fatal. */
                        return(make_pending(n, tok, m, line, ppos));
                case (REWIND_ERROR):
                        /* XXX Make this non-fatal. */

-                       mdoc_pmsg(m, line, ppos, MANDOCERR_SYNTNOSCOPE);
+                       mdoc_vmsg(m, MANDOCERR_SCOPEFATAL, line, ppos,
+                           "%s cannot break %s", mdoc_macronames[tok],
+                           mdoc_macronames[n->tok]);

                        return 0;
                }
                break;
                        return 0;
                }
                break;


@@ -563,7 +610,7 @@ append_delims(struct mdoc *m, int line, int *pos, char *buf)
                 * knowing which symbols break this behaviour, for
                 * example, `.  ;' shouldn't propogate the double-space.
                 */
                 * knowing which symbols break this behaviour, for
                 * example, `.  ;' shouldn't propogate the double-space.
                 */

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

                        m->last->flags |= MDOC_EOS;
        }
 
                        m->last->flags |= MDOC_EOS;
        }
 


@@ -609,12 +656,12 @@ blk_exp_close(MACRO_PROT_ARGS)
 
                /* Remember the start of our own body. */
                if (MDOC_BODY == n->type && atok == n->tok) {
 
                /* Remember the start of our own body. */
                if (MDOC_BODY == n->type && atok == n->tok) {

-                       if ( ! n->end)
+                       if (ENDBODY_NOT == n->end)

                                body = n;
                        continue;
                }
 
                                body = n;
                        continue;
                }
 

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

                        continue;
                if (atok == n->tok) {
                        assert(body);
                        continue;
                if (atok == n->tok) {
                        assert(body);


@@ -979,6 +1026,9 @@ blk_full(MACRO_PROT_ARGS)
                lac = ARGS_ERROR == ac ? ARGS_PEND : ac;
                ac = mdoc_args(m, line, pos, buf, tok, &p);
 
                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_ERROR == ac)
                        return(0);
 


@@ -1216,7 +1266,7 @@ blk_part_imp(MACRO_PROT_ARGS)
         */
 
        if (n && MDOC_TEXT == n->type && n->string)
         */
 
        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. */
                        n->flags |= MDOC_EOS;
 
        /* Up-propogate the end-of-space flag. */


@@ -1251,8 +1301,8 @@ blk_part_imp(MACRO_PROT_ARGS)
         * is ugly behaviour nodding its head to OpenBSD's overwhelming
         * crufty use of `Op' breakage.
         */
         * is ugly behaviour nodding its head to OpenBSD's overwhelming
         * crufty use of `Op' breakage.
         */

-       if (n != body && ! mdoc_vmsg(m, MANDOCERR_SCOPE, line, ppos,
-           "%s broken", mdoc_macronames[tok]))
+       if (n != body && ! mdoc_vmsg(m, MANDOCERR_SCOPENEST,
+           line, ppos, "%s broken", mdoc_macronames[tok]))

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


@@ -1533,6 +1583,9 @@ in_line_eoln(MACRO_PROT_ARGS)
 
        assert( ! (MDOC_PARSED & mdoc_macros[tok].flags));
 
 
        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; ; ) {
        /* Parse macro arguments. */
 
        for (arg = NULL; ; ) {


@@ -1596,7 +1649,7 @@ ctx_synopsis(MACRO_PROT_ARGS)
        nl = MDOC_NEWLINE & m->flags;
 
        /* If we're not in the SYNOPSIS, go straight to in-line. */
        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. */
                return(in_line(m, tok, line, ppos, pos, buf));
 
        /* If we're a nested call, same place. */


@@ -1608,7 +1661,9 @@ ctx_synopsis(MACRO_PROT_ARGS)
         * up formatting the block scope, then child nodes will inherit
         * the formatting.  Be careful.
         */
         * 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));
 }
 
        return(blk_part_imp(m, tok, line, ppos, pos, buf));
 }