]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc_macro.c
Support .RE with an argument; needed for audio/pms(1).
[mandoc.git] / mdoc_macro.c
index b501d4d62946c6d8e144adbc3c82d9e87a6d0bb0..56ae7983032791ad1d89df34bc3d54258e378617 100644 (file)
@@ -1,4 +1,4 @@
-/*     $Id: mdoc_macro.c,v 1.154 2014/11/29 04:31:35 schwarze Exp $ */
+/*     $Id: mdoc_macro.c,v 1.161 2014/12/22 23:27:32 schwarze Exp $ */
 /*
  * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2010, 2012, 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
@@ -53,7 +53,8 @@ static        void            phrase_ta(MACRO_PROT_ARGS);
 static void            dword(struct mdoc *, int, int, const char *,
                                 enum mdelim, int);
 static void            append_delims(struct mdoc *, int, int *, char *);
-static enum mdoct      lookup(enum mdoct, const char *);
+static enum mdoct      lookup(struct mdoc *, enum mdoct,
+                               int, int, const char *);
 static int             macro_or_word(MACRO_PROT_ARGS, int);
 static int             make_pending(struct mdoc_node *, enum mdoct,
                                struct mdoc *, int, int);
@@ -245,14 +246,19 @@ mdoc_macroend(struct mdoc *mdoc)
  * or as a line macro if from == MDOC_MAX.
  */
 static enum mdoct
-lookup(enum mdoct from, const char *p)
+lookup(struct mdoc *mdoc, enum mdoct from, int line, int ppos, const char *p)
 {
        enum mdoct       res;
 
        if (from == MDOC_MAX || mdoc_macros[from].flags & MDOC_PARSED) {
                res = mdoc_hash_find(p);
-               if (res != MDOC_MAX && mdoc_macros[res].flags & MDOC_CALLABLE)
-                       return(res);
+               if (res != MDOC_MAX) {
+                       if (mdoc_macros[res].flags & MDOC_CALLABLE)
+                               return(res);
+                       if (res != MDOC_br && res != MDOC_sp && res != MDOC_ll)
+                               mandoc_msg(MANDOCERR_MACRO_CALL,
+                                   mdoc->parse, line, ppos, p);
+               }
        }
        return(MDOC_MAX);
 }
@@ -357,7 +363,7 @@ rew_dohalt(enum mdoct tok, enum mdoc_type type,
         * When starting to rewind, skip plain text
         * and nodes that have already been rewound.
         */
-       if (MDOC_TEXT == p->type || MDOC_VALID & p->flags)
+       if (p->type == MDOC_TEXT || p->flags & (MDOC_VALID | MDOC_BREAK))
                return(REWIND_MORE);
 
        /*
@@ -472,12 +478,16 @@ make_pending(struct mdoc_node *broken, enum mdoct tok,
        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 the *broken block (Z) is already broken and we
+                * encounter its breaker (B), make the tok block (A)
+                * pending on that inner breaker (B).
+                * Graphically, [A breaker=[B! broken=[Z->B B] tok=A] Z]
+                * becomes breaker=[A broken=[B! [Z->B B] tok=A] Z]
+                * and finally [A! [B!->A [Z->B B] A] Z].
+                * In these graphics, "->" indicates the "pending"
+                * pointer and "!" indicates the MDOC_BREAK flag.
+                * Each of the cases gets one additional pointer (B->A)
+                * and one additional flag (A!).
                 */
                if (breaker == broken->pending) {
                        broken = breaker;
@@ -491,31 +501,38 @@ make_pending(struct mdoc_node *broken, enum mdoct tok,
 
                /*
                 * Found the breaker.
-                * If another, outer breaker is already pending on
-                * the *broken block, we must not clobber the link
+                * If another, outer breaker (X) is already pending on
+                * the *broken block (B), 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]".
+                * new, now inner breaker (A).
+                * Graphically, [X! breaker=[A broken=[B->X X] tok=A] B]
+                * becomes [X! breaker=[A->X broken=[B X] tok=A] B]
+                * and finally [X! [A!->X [B->A X] A] B].
                 */
                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]"
+                        * If the inner breaker (A) is already broken,
+                        * too, it cannot take on the outer breaker (X)
+                        * but must hand it on to its own breakers (Y):
+                        * [X! [Y! breaker=[A->Y Y] broken=[B->X X] tok=A] B]
+                        * [X! take=[Y!->X brea=[A->Y Y] brok=[B X] tok=A] B]
+                        * and finally [X! [Y!->X [A!->Y Y] [B->A X] A] B].
                         */
                        taker = breaker;
                        while (taker->pending)
                                taker = taker->pending;
                        taker->pending = broken->pending;
                }
+
+               /*
+                * Now we have reduced the situation to the simplest
+                * case, which is just breaker=[A broken=[B tok=A] B]
+                * and becomes [A! [B->A A] B].
+                */
                broken->pending = breaker;
+               breaker->flags |= MDOC_BREAK;
                mandoc_vmsg(MANDOCERR_BLK_NEST, mdoc->parse, line, ppos,
                    "%s breaks %s", mdoc_macronames[tok],
                    mdoc_macronames[broken->tok]);
@@ -533,13 +550,17 @@ static void
 rew_sub(enum mdoc_type t, struct mdoc *mdoc,
                enum mdoct tok, int line, int ppos)
 {
-       struct mdoc_node *n;
+       struct mdoc_node *n, *to;
 
+       to = NULL;
        n = mdoc->last;
        while (n) {
                switch (rew_dohalt(tok, t, n)) {
                case REWIND_NONE:
-                       return;
+                       if (to == NULL)
+                               return;
+                       n = to;
+                       break;
                case REWIND_THIS:
                        n->lastline = line -
                            (mdoc->flags & MDOC_NEWLINE &&
@@ -554,6 +575,7 @@ rew_sub(enum mdoc_type t, struct mdoc *mdoc,
                case REWIND_MORE:
                        n->lastline = line -
                            (mdoc->flags & MDOC_NEWLINE ? 1 : 0);
+                       to = n;
                        n = n->parent;
                        continue;
                case REWIND_LATER:
@@ -666,12 +688,10 @@ macro_or_word(MACRO_PROT_ARGS, int parsed)
 
        p = buf + ppos;
        ntok = MDOC_MAX;
-       if (mdoc->flags & MDOC_PHRASELIT)
-               /* nothing */;
-       else if (*p == '"')
+       if (*p == '"')
                p++;
-       else if (parsed)
-               ntok = lookup(tok, p);
+       else if (parsed && ! (mdoc->flags & MDOC_PHRASELIT))
+               ntok = lookup(mdoc, tok, line, ppos, p);
 
        if (ntok == MDOC_MAX) {
                dword(mdoc, line, ppos, p, DELIM_MAX, tok == MDOC_MAX ||
@@ -698,7 +718,7 @@ blk_exp_close(MACRO_PROT_ARGS)
        struct mdoc_node *later;        /* A sub-block starting later. */
        struct mdoc_node *n;            /* For searching backwards. */
 
-       int              j, lastarg, maxargs, flushed, nl;
+       int              flushed, have_it, j, lastarg, maxargs, nl;
        enum margserr    ac;
        enum mdoct       atok, ntok;
        char            *p;
@@ -722,10 +742,11 @@ blk_exp_close(MACRO_PROT_ARGS)
         * both of our own and of pending sub-blocks.
         */
 
+       have_it = 0;
        atok = rew_alt(tok);
        body = endbody = later = NULL;
        for (n = mdoc->last; n; n = n->parent) {
-               if (n->flags & MDOC_VALID)
+               if (n->flags & (MDOC_VALID | MDOC_BREAK))
                        continue;
 
                /* Remember the start of our own body. */
@@ -738,6 +759,12 @@ blk_exp_close(MACRO_PROT_ARGS)
 
                if (n->type != MDOC_BLOCK || n->tok == MDOC_Nm)
                        continue;
+
+               if (n->tok == MDOC_It) {
+                       have_it = 1;
+                       continue;
+               }
+
                if (atok == n->tok) {
                        assert(body);
 
@@ -747,7 +774,8 @@ blk_exp_close(MACRO_PROT_ARGS)
                         * just proceed to closing out.
                         */
 
-                       if (later == NULL)
+                       if (later == NULL ||
+                           (tok == MDOC_El && !have_it))
                                break;
 
                        /*
@@ -786,10 +814,8 @@ blk_exp_close(MACRO_PROT_ARGS)
                 * implicit ones, the first open implicit block.
                 */
 
-               if (later &&
-                   mdoc_macros[later->tok].flags & MDOC_EXPLICIT)
-                       continue;
-               if (n->tok != MDOC_It)
+               if (later == NULL ||
+                   ! (mdoc_macros[later->tok].flags & MDOC_EXPLICIT))
                        later = n;
        }
        rew_sub(MDOC_BODY, mdoc, tok, line, ppos);
@@ -832,7 +858,8 @@ blk_exp_close(MACRO_PROT_ARGS)
                if (ac == ARGS_PUNCT || ac == ARGS_EOLN)
                        break;
 
-               ntok = ac == ARGS_QWORD ? MDOC_MAX : lookup(tok, p);
+               ntok = ac == ARGS_QWORD ? MDOC_MAX :
+                   lookup(mdoc, tok, line, lastarg, p);
 
                if (ntok == MDOC_MAX) {
                        dword(mdoc, line, lastarg, p, DELIM_MAX,
@@ -933,7 +960,7 @@ in_line(MACRO_PROT_ARGS)
                }
 
                ntok = (ac == ARGS_QWORD || (tok == MDOC_Fn && !cnt)) ?
-                   MDOC_MAX : lookup(tok, p);
+                   MDOC_MAX : lookup(mdoc, tok, line, la, p);
 
                /*
                 * In this case, we've located a submacro and must
@@ -1062,8 +1089,8 @@ blk_full(MACRO_PROT_ARGS)
 
        if (tok == MDOC_It) {
                for (n = mdoc->last; n; n = n->parent)
-                       if (n->tok == MDOC_Bl &&
-                           ! (n->flags & MDOC_VALID))
+                       if (n->tok == MDOC_Bl && n->type == MDOC_BLOCK &&
+                           ! (n->flags & (MDOC_VALID | MDOC_BREAK)))
                                break;
                if (n == NULL) {
                        mandoc_vmsg(MANDOCERR_IT_STRAY, mdoc->parse,
@@ -1389,7 +1416,7 @@ in_line_argn(MACRO_PROT_ARGS)
        char            *p;
        enum mdoct       ntok;
 
-       nl = MDOC_NEWLINE & mdoc->flags;
+       nl = mdoc->flags & MDOC_NEWLINE;
 
        /*
         * A line macro that has a fixed number of arguments (maxargs).
@@ -1421,11 +1448,18 @@ in_line_argn(MACRO_PROT_ARGS)
 
        mdoc_argv(mdoc, line, tok, &arg, pos, buf);
 
-       for (flushed = j = 0; ; ) {
+       p = NULL;
+       flushed = j = 0;
+       for (;;) {
                la = *pos;
                ac = mdoc_args(mdoc, line, pos, buf, tok, &p);
-               if (ac == ARGS_PUNCT || ac == ARGS_EOLN)
+               if (ac == ARGS_PUNCT || ac == ARGS_EOLN) {
+                       if (j < 2 && tok == MDOC_Pf)
+                               mandoc_vmsg(MANDOCERR_PF_SKIP,
+                                   mdoc->parse, line, ppos, "Pf %s",
+                                   p == NULL ? "at eol" : p);
                        break;
+               }
 
                if ( ! (mdoc_macros[tok].flags & MDOC_IGNDELIM) &&
                    ac != ARGS_QWORD && j == 0 &&
@@ -1440,7 +1474,8 @@ in_line_argn(MACRO_PROT_ARGS)
                        flushed = 1;
                }
 
-               ntok = ac == ARGS_QWORD ? MDOC_MAX : lookup(tok, p);
+               ntok = (ac == ARGS_QWORD || (tok == MDOC_Pf && j == 0)) ?
+                   MDOC_MAX : lookup(mdoc, tok, line, la, p);
 
                if (ntok != MDOC_MAX) {
                        if ( ! flushed)
@@ -1463,8 +1498,11 @@ in_line_argn(MACRO_PROT_ARGS)
                j++;
        }
 
-       if (j == 0)
+       if (j == 0) {
                mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
+               if (ac == ARGS_PUNCT && tok == MDOC_Pf)
+                       append_delims(mdoc, line, pos, buf);
+       }
        if ( ! flushed)
                rew_elem(mdoc, tok);
        if (nl)
@@ -1532,7 +1570,8 @@ phrase_ta(MACRO_PROT_ARGS)
        /* Make sure we are in a column list or ignore this macro. */
 
        n = mdoc->last;
-       while (n != NULL && n->tok != MDOC_Bl)
+       while (n != NULL &&
+           (n->tok != MDOC_Bl || n->flags & (MDOC_VALID | MDOC_BREAK)))
                n = n->parent;
        if (n == NULL || n->norm->Bl.type != LIST_column) {
                mandoc_msg(MANDOCERR_TA_STRAY, mdoc->parse,