Note discarding of \m, \M, and \s in COMPATIBILITY sections.

[mandoc.git] / mdoc_macro.c

diff --git a/mdoc_macro.c b/mdoc_macro.c
index 6e9b07e8eededfbc0e36458b3eeeeb80eb2b1f13..91972f3418d5ee19fa6142396de339c918b8fcbf 100644 (file)
--- a/mdoc_macro.c
+++ b/mdoc_macro.c
@@ -1,6 +1,7 @@
-/*     $Id: mdoc_macro.c,v 1.83 2010/06/29 19:20:38 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


@@ -29,10 +30,12 @@
 #include "libmdoc.h"
 #include "libmandoc.h"
 
 #include "libmdoc.h"
 #include "libmandoc.h"
 

-enum   rew {
-       REWIND_REWIND,
-       REWIND_NOHALT,
-       REWIND_HALT
+enum   rew {   /* see rew_dohalt() */
+       REWIND_NONE,
+       REWIND_THIS,
+       REWIND_MORE,
+       REWIND_LATER,
+       REWIND_ERROR

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


@@ -50,12 +53,10 @@ static      int             append_delims(struct mdoc *,
                                int, int *, char *);
 static enum mdoct      lookup(enum mdoct, const char *);
 static enum mdoct      lookup_raw(const char *);
                                int, int *, char *);
 static enum mdoct      lookup(enum mdoct, const char *);
 static enum mdoct      lookup_raw(const char *);

-static int             make_pending(struct mdoc_node *, enum mdoc_type,
+static int             make_pending(struct mdoc_node *, enum mdoct,

                                struct mdoc *, int, int);
 static int             phrase(struct mdoc *, int, int, char *);
 static enum mdoct      rew_alt(enum mdoct);
                                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);
 static enum rew        rew_dohalt(enum mdoct, enum mdoc_type, 
                                const struct mdoc_node *);
 static int             rew_elem(struct mdoc *, enum mdoct);


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


@@ -275,8 +276,8 @@ rew_last(struct mdoc *mdoc, const struct mdoc_node *to)
 
 
 /*
 
 
 /*

- * Return the opening macro of a closing one, e.g., `Ec' has `Eo' as its
- * matching pair.
+ * For a block closing macro, return the corresponding opening one.
+ * Otherwise, return the macro itself.

  */
 static enum mdoct
 rew_alt(enum mdoct tok)
  */
 static enum mdoct
 rew_alt(enum mdoct tok)


@@ -315,216 +316,121 @@ rew_alt(enum mdoct tok)
        case (MDOC_Xc):
                return(MDOC_Xo);
        default:
        case (MDOC_Xc):
                return(MDOC_Xo);
        default:

-               break;
+               return(tok);

        }
        }

-       abort();

        /* NOTREACHED */
 }
 
 
        /* NOTREACHED */
 }
 
 

-/* 
- * 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.
+/*
+ * 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_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)
 {
 
  */
 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)
        if (MDOC_ROOT == p->type)

-               return(REWIND_HALT);
-       if (MDOC_VALID & p->flags)
-               return(REWIND_NOHALT);
+               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) {
        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 (tok != p->tok)
-                       break;
-               if (p->end)
-                       return(REWIND_HALT);
-               if (type == p->type)
-                       return(REWIND_REWIND);
+       case (MDOC_Bl):
+               if (MDOC_It == p->tok)
+                       return(REWIND_MORE);

                break;
        case (MDOC_It):
                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)
                if (MDOC_BODY == p->type && MDOC_Bl == p->tok)

-                       return(REWIND_HALT);
+                       return(REWIND_NONE);

                break;
                break;

-       case (MDOC_Sh):
-               if (type == p->type && tok == p->tok)
-                       return(REWIND_REWIND);
+       /*
+        * 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;
                break;

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

        case (MDOC_Nd):
                /* FALLTHROUGH */
        case (MDOC_Ss):
        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)
                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 (tok != p->tok)
-                       break;
-               if (p->end)
-                       return(REWIND_HALT);
-               if (type == p->type)
-                       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):
+                       return(REWIND_NONE);

                /* FALLTHROUGH */
                /* 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 (rew_alt(tok) != p->tok)
-                       break;
-               if (p->end)
-                       return(REWIND_HALT);
-               if (type == p->type)
-                       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);
-       if (MDOC_BODY == p->type && p->end)
-               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):
        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);
+               if (MDOC_Nd == p->tok || MDOC_Ss == p->tok ||
+                   MDOC_Sh == p->tok)
+                       return(REWIND_MORE);

                break;
        default:
                break;
        }
 
                break;
        default:
                break;
        }
 

-       if (MDOC_EXPLICIT & mdoc_macros[tok].flags) 
-               return(p->tok == rew_alt(tok));
-       else if (MDOC_BLOCK == p->type)
-               return(1);
+       /*
+        * 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);

 
 

-       return(tok == p->tok);
+       /*
+        * 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);

 }
 
 
 }
 
 


@@ -574,7 +480,7 @@ make_pending(struct mdoc_node *broken, enum mdoct tok,
                        continue;
                }
 
                        continue;
                }
 

-               if (REWIND_REWIND != rew_dohalt(tok, MDOC_BLOCK, breaker))
+               if (REWIND_THIS != rew_dohalt(tok, MDOC_BLOCK, breaker))

                        continue;
                if (MDOC_BODY == broken->type)
                        broken = broken->parent;
                        continue;
                if (MDOC_BODY == broken->type)
                        broken = broken->parent;


@@ -606,44 +512,48 @@ 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);
        }
 
        /*
         * Found no matching block for tok.
         * Are you trying to close a block that is not open?
                return(1);
        }
 
        /*
         * Found no matching block for tok.
         * Are you trying to close a block that is not open?

-        * Report failure and abort the parser.
+        * XXX Make this non-fatal.

         */
        mdoc_pmsg(m, line, ppos, MANDOCERR_SYNTNOSCOPE);
        return(0);
 }
 
         */
        mdoc_pmsg(m, line, ppos, MANDOCERR_SYNTNOSCOPE);
        return(0);
 }
 

+

 static int
 rew_sub(enum mdoc_type t, struct mdoc *m, 
                enum mdoct tok, int line, int ppos)
 {
        struct mdoc_node *n;
 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 */
-       for (n = m->last; n; n = n->parent) {
-               c = rew_dohalt(tok, t, n);
-               if (REWIND_HALT == c) {
-                       if (n->end || MDOC_BLOCK != t)
-                               return(1);
-                       if ( ! (MDOC_EXPLICIT & mdoc_macros[tok].flags))
-                               return(1);
-                       /* FIXME: shouldn't raise an error */
-                       mdoc_pmsg(m, line, ppos, MANDOCERR_SYNTNOSCOPE);
-                       return(0);
-               }
-               if (REWIND_REWIND == c)
+       n = m->last;
+       while (n) {
+               switch (rew_dohalt(tok, t, n)) {
+               case (REWIND_NONE):
+                       return(1);
+               case (REWIND_THIS):

                        break;
                        break;

-               else if (rew_dobreak(tok, n))
+               case (REWIND_MORE):
+                       n = n->parent;

                        continue;
                        continue;

-               return(make_pending(n, tok, m, line, ppos));
+               case (REWIND_LATER):
+                       return(make_pending(n, tok, m, line, ppos));
+               case (REWIND_ERROR):
+                       /* XXX Make this non-fatal. */
+                       mdoc_vmsg(m, MANDOCERR_SCOPEFATAL, line, ppos,
+                           "%s cannot break %s", mdoc_macronames[tok],
+                           mdoc_macronames[n->tok]);
+                       return 0;
+               }
+               break;

        }
 
        assert(n);
        }
 
        assert(n);


@@ -700,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;
        }
 


@@ -746,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);


@@ -1116,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);
 


@@ -1353,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. */


@@ -1388,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))


@@ -1670,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; ; ) {


@@ -1733,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. */


@@ -1745,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));
 }