]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc_macro.c
Unify some node handling functions that use TOKEN_NONE.
[mandoc.git] / mdoc_macro.c
index bd3bf3e270b416b8a21f0797c066b1077438cdee..2f4bc6e1038111a3135c05213a8bd9852f10c45c 100644 (file)
@@ -1,4 +1,4 @@
-/*     $Id: mdoc_macro.c,v 1.185 2015/04/02 22:48:17 schwarze Exp $ */
+/*     $Id: mdoc_macro.c,v 1.192 2015/04/19 14:25:41 schwarze Exp $ */
 /*
  * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2010, 2012-2015 Ingo Schwarze <schwarze@openbsd.org>
@@ -30,6 +30,7 @@
 #include "roff.h"
 #include "mdoc.h"
 #include "libmandoc.h"
+#include "roff_int.h"
 #include "libmdoc.h"
 
 static void            blk_full(MACRO_PROT_ARGS);
@@ -42,16 +43,19 @@ static      void            in_line_argn(MACRO_PROT_ARGS);
 static void            in_line(MACRO_PROT_ARGS);
 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 int             lookup(struct mdoc *, int, int, int, const char *);
+static void            append_delims(struct roff_man *, int, int *, char *);
+static void            dword(struct roff_man *, int, int, const char *,
+                               enum mdelim, int);
+static int             find_pending(struct roff_man *, int, int, int,
+                               struct roff_node *);
+static int             lookup(struct roff_man *, int, int, int, const char *);
 static int             macro_or_word(MACRO_PROT_ARGS, int);
-static int             parse_rest(struct mdoc *, int, int, int *, char *);
+static int             parse_rest(struct roff_man *, int, int, int *, char *);
 static int             rew_alt(int);
-static void            rew_elem(struct mdoc *, int);
-static void            rew_last(struct mdoc *, const struct roff_node *);
-static void            rew_pending(struct mdoc *, const struct roff_node *);
+static void            rew_elem(struct roff_man *, int);
+static void            rew_last(struct roff_man *, const struct roff_node *);
+static void            rew_pending(struct roff_man *,
+                               const struct roff_node *);
 
 const  struct mdoc_macro __mdoc_macros[MDOC_MAX] = {
        { in_line_argn, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Ap */
@@ -206,7 +210,7 @@ const       struct mdoc_macro * const mdoc_macros = __mdoc_macros;
  * are errors.
  */
 void
-mdoc_macroend(struct mdoc *mdoc)
+mdoc_macroend(struct roff_man *mdoc)
 {
        struct roff_node *n;
 
@@ -228,16 +232,16 @@ mdoc_macroend(struct mdoc *mdoc)
 
 /*
  * Look up the macro at *p called by "from",
- * or as a line macro if from == MDOC_MAX.
+ * or as a line macro if from == TOKEN_NONE.
  */
 static int
-lookup(struct mdoc *mdoc, int from, int line, int ppos, const char *p)
+lookup(struct roff_man *mdoc, int from, int line, int ppos, const char *p)
 {
        int      res;
 
-       if (from == MDOC_MAX || mdoc_macros[from].flags & MDOC_PARSED) {
+       if (from == TOKEN_NONE || mdoc_macros[from].flags & MDOC_PARSED) {
                res = mdoc_hash_find(p);
-               if (res != MDOC_MAX) {
+               if (res != TOKEN_NONE) {
                        if (mdoc_macros[res].flags & MDOC_CALLABLE)
                                return(res);
                        if (res != MDOC_br && res != MDOC_sp && res != MDOC_ll)
@@ -245,19 +249,21 @@ lookup(struct mdoc *mdoc, int from, int line, int ppos, const char *p)
                                    mdoc->parse, line, ppos, p);
                }
        }
-       return(MDOC_MAX);
+       return(TOKEN_NONE);
 }
 
 /*
  * Rewind up to and including a specific node.
  */
 static void
-rew_last(struct mdoc *mdoc, const struct roff_node *to)
+rew_last(struct roff_man *mdoc, const struct roff_node *to)
 {
        struct roff_node *n, *np;
 
-       assert(to);
-       mdoc->next = MDOC_NEXT_SIBLING;
+       if (to->flags & MDOC_VALID)
+               return;
+
+       mdoc->next = ROFF_NEXT_SIBLING;
        while (mdoc->last != to) {
                /*
                 * Save the parent here, because we may delete the
@@ -279,7 +285,7 @@ rew_last(struct mdoc *mdoc, const struct roff_node *to)
  * Rewind up to a specific block, including all blocks that broke it.
  */
 static void
-rew_pending(struct mdoc *mdoc, const struct roff_node *n)
+rew_pending(struct roff_man *mdoc, const struct roff_node *n)
 {
 
        for (;;) {
@@ -287,7 +293,7 @@ rew_pending(struct mdoc *mdoc, const struct roff_node *n)
 
                switch (n->type) {
                case ROFFT_HEAD:
-                       mdoc_body_alloc(mdoc, n->line, n->pos, n->tok);
+                       roff_body_alloc(mdoc, n->line, n->pos, n->tok);
                        return;
                case ROFFT_BLOCK:
                        break;
@@ -360,7 +366,7 @@ rew_alt(int tok)
 }
 
 static void
-rew_elem(struct mdoc *mdoc, int tok)
+rew_elem(struct roff_man *mdoc, int tok)
 {
        struct roff_node *n;
 
@@ -372,12 +378,50 @@ rew_elem(struct mdoc *mdoc, int tok)
        rew_last(mdoc, n);
 }
 
+/*
+ * If there is an open sub-block of the target requiring
+ * explicit close-out, postpone closing out the target until
+ * the rew_pending() call closing out the sub-block.
+ */
+static int
+find_pending(struct roff_man *mdoc, int tok, int line, int ppos,
+       struct roff_node *target)
+{
+       struct roff_node        *n;
+       int                      irc;
+
+       irc = 0;
+       for (n = mdoc->last; n != NULL && n != target; n = n->parent) {
+               if (n->flags & MDOC_ENDED) {
+                       if ( ! (n->flags & MDOC_VALID))
+                               n->flags |= MDOC_BROKEN;
+                       continue;
+               }
+               if (n->type == ROFFT_BLOCK &&
+                   mdoc_macros[n->tok].flags & MDOC_EXPLICIT) {
+                       irc = 1;
+                       n->flags = MDOC_BROKEN;
+                       if (target->type == ROFFT_HEAD)
+                               target->flags = MDOC_ENDED;
+                       else if ( ! (target->flags & MDOC_ENDED)) {
+                               mandoc_vmsg(MANDOCERR_BLK_NEST,
+                                   mdoc->parse, line, ppos,
+                                   "%s breaks %s", mdoc_macronames[tok],
+                                   mdoc_macronames[n->tok]);
+                               mdoc_endbody_alloc(mdoc, line, ppos,
+                                   tok, target, ENDBODY_NOSPACE);
+                       }
+               }
+       }
+       return(irc);
+}
+
 /*
  * Allocate a word and check whether it's punctuation or not.
  * Punctuation consists of those tokens found in mdoc_isdelim().
  */
 static void
-dword(struct mdoc *mdoc, int line, int col, const char *p,
+dword(struct roff_man *mdoc, int line, int col, const char *p,
                enum mdelim d, int may_append)
 {
 
@@ -388,11 +432,11 @@ dword(struct mdoc *mdoc, int line, int col, const char *p,
            ! (mdoc->flags & (MDOC_SYNOPSIS | MDOC_KEEP | MDOC_SMOFF)) &&
            d == DELIM_NONE && mdoc->last->type == ROFFT_TEXT &&
            mdoc_isdelim(mdoc->last->string) == DELIM_NONE) {
-               mdoc_word_append(mdoc, p);
+               roff_word_append(mdoc, p);
                return;
        }
 
-       mdoc_word_alloc(mdoc, line, col, p);
+       roff_word_alloc(mdoc, line, col, p);
 
        /*
         * If the word consists of a bare delimiter,
@@ -411,7 +455,7 @@ dword(struct mdoc *mdoc, int line, int col, const char *p,
 }
 
 static void
-append_delims(struct mdoc *mdoc, int line, int *pos, char *buf)
+append_delims(struct roff_man *mdoc, int line, int *pos, char *buf)
 {
        char            *p;
        int              la;
@@ -421,7 +465,8 @@ append_delims(struct mdoc *mdoc, int line, int *pos, char *buf)
 
        for (;;) {
                la = *pos;
-               if (mdoc_args(mdoc, line, pos, buf, MDOC_MAX, &p) == ARGS_EOLN)
+               if (mdoc_args(mdoc, line, pos, buf, TOKEN_NONE, &p) ==
+                   ARGS_EOLN)
                        break;
                dword(mdoc, line, la, p, DELIM_MAX, 1);
 
@@ -454,21 +499,21 @@ macro_or_word(MACRO_PROT_ARGS, int parsed)
        int              ntok;
 
        p = buf + ppos;
-       ntok = MDOC_MAX;
+       ntok = TOKEN_NONE;
        if (*p == '"')
                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 ||
+       if (ntok == TOKEN_NONE) {
+               dword(mdoc, line, ppos, p, DELIM_MAX, tok == TOKEN_NONE ||
                    mdoc_macros[tok].flags & MDOC_JOIN);
                return(0);
        } else {
                if (mdoc_macros[tok].fp == in_line_eoln)
                        rew_elem(mdoc, tok);
                mdoc_macro(mdoc, ntok, line, ppos, pos, buf);
-               if (tok == MDOC_MAX)
+               if (tok == TOKEN_NONE)
                        append_delims(mdoc, line, pos, buf);
                return(1);
        }
@@ -485,8 +530,9 @@ blk_exp_close(MACRO_PROT_ARGS)
        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;
+       int              j, lastarg, maxargs, nl, pending;
        enum margserr    ac;
        int              atok, ntok;
        char            *p;
@@ -574,7 +620,7 @@ blk_exp_close(MACRO_PROT_ARGS)
                         */
 
                        if (maxargs)
-                               mdoc->next = MDOC_NEXT_CHILD;
+                               mdoc->next = ROFF_NEXT_CHILD;
                        break;
                }
 
@@ -625,35 +671,42 @@ blk_exp_close(MACRO_PROT_ARGS)
        for (j = 0; ; j++) {
                lastarg = *pos;
 
-               if (j == maxargs && n != NULL) {
-                       rew_pending(mdoc, n);
-                       n = NULL;
-               }
+               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 ? MDOC_MAX :
+               ntok = ac == ARGS_QWORD ? TOKEN_NONE :
                    lookup(mdoc, tok, line, lastarg, p);
 
-               if (ntok == MDOC_MAX) {
+               if (ntok == TOKEN_NONE) {
                        dword(mdoc, line, lastarg, p, DELIM_MAX,
                            MDOC_JOIN & mdoc_macros[tok].flags);
                        continue;
                }
 
-               if (n != NULL) {
-                       rew_pending(mdoc, n);
-                       n = NULL;
-               }
+               if (n != NULL)
+                       rew_last(mdoc, n);
                mdoc->flags &= ~MDOC_NEWLINE;
                mdoc_macro(mdoc, ntok, line, lastarg, pos, buf);
                break;
        }
 
-       if (n != NULL)
-               rew_pending(mdoc, n);
+       if (n != NULL) {
+               if (n != mdoc->last && 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);
 }
@@ -729,7 +782,7 @@ in_line(MACRO_PROT_ARGS)
                }
 
                ntok = (ac == ARGS_QWORD || (tok == MDOC_Fn && !cnt)) ?
-                   MDOC_MAX : lookup(mdoc, tok, line, la, p);
+                   TOKEN_NONE : lookup(mdoc, tok, line, la, p);
 
                /*
                 * In this case, we've located a submacro and must
@@ -738,7 +791,7 @@ in_line(MACRO_PROT_ARGS)
                 * or raise a warning.
                 */
 
-               if (ntok != MDOC_MAX) {
+               if (ntok != TOKEN_NONE) {
                        if (scope)
                                rew_elem(mdoc, tok);
                        if (nc && ! cnt) {
@@ -971,9 +1024,9 @@ blk_full(MACRO_PROT_ARGS)
         */
 
        if (tok == MDOC_Nd) {
-               head = mdoc_head_alloc(mdoc, line, ppos, tok);
+               head = roff_head_alloc(mdoc, line, ppos, tok);
                rew_last(mdoc, head);
-               body = mdoc_body_alloc(mdoc, line, ppos, tok);
+               body = roff_body_alloc(mdoc, line, ppos, tok);
        }
 
        if (tok == MDOC_Bk)
@@ -996,7 +1049,7 @@ blk_full(MACRO_PROT_ARGS)
                         */
                        if (body != NULL)
                                rew_last(mdoc, body);
-                       body = mdoc_body_alloc(mdoc, line, ppos, tok);
+                       body = roff_body_alloc(mdoc, line, ppos, tok);
                        break;
                }
                if (tok == MDOC_Bd || tok == MDOC_Bk) {
@@ -1031,7 +1084,7 @@ blk_full(MACRO_PROT_ARGS)
                /* Open a head if one hasn't been opened. */
 
                if (head == NULL)
-                       head = mdoc_head_alloc(mdoc, line, ppos, tok);
+                       head = roff_head_alloc(mdoc, line, ppos, tok);
 
                if (ac == ARGS_PHRASE ||
                    ac == ARGS_PEND ||
@@ -1043,7 +1096,7 @@ blk_full(MACRO_PROT_ARGS)
                         */
 
                        rew_last(mdoc, body == NULL ? head : body);
-                       body = mdoc_body_alloc(mdoc, line, ppos, tok);
+                       body = roff_body_alloc(mdoc, line, ppos, tok);
 
                        /*
                         * Process phrases: set whether we're in a
@@ -1055,7 +1108,7 @@ blk_full(MACRO_PROT_ARGS)
                                mdoc->flags |= MDOC_PPHRASE;
                        if (ac == ARGS_PEND && lac == ARGS_PPHRASE)
                                mdoc->flags |= MDOC_PPHRASE;
-                       parse_rest(mdoc, MDOC_MAX, line, &la, buf);
+                       parse_rest(mdoc, TOKEN_NONE, line, &la, buf);
                        mdoc->flags &= ~MDOC_PPHRASE;
                        continue;
                }
@@ -1067,37 +1120,18 @@ blk_full(MACRO_PROT_ARGS)
        if (blk->flags & MDOC_VALID)
                return;
        if (head == NULL)
-               head = mdoc_head_alloc(mdoc, line, ppos, tok);
+               head = roff_head_alloc(mdoc, line, ppos, tok);
        if (nl && tok != MDOC_Bd && tok != MDOC_Bl && tok != MDOC_Rs)
                append_delims(mdoc, line, pos, buf);
        if (body != NULL)
                goto out;
-
-       /*
-        * If there is an open (i.e., unvalidated) sub-block requiring
-        * explicit close-out, postpone switching the current block from
-        * head to body until the rew_pending() call closing out that
-        * sub-block.
-        */
-       for (n = mdoc->last; n && n != head; n = n->parent) {
-               if (n->flags & MDOC_ENDED) {
-                       if ( ! (n->flags & MDOC_VALID))
-                               n->flags |= MDOC_BROKEN;
-                       continue;
-               }
-               if (n->type == ROFFT_BLOCK &&
-                   mdoc_macros[n->tok].flags & MDOC_EXPLICIT) {
-                       n->flags = MDOC_BROKEN;
-                       head->flags = MDOC_ENDED;
-               }
-       }
-       if (head->flags & MDOC_ENDED)
+       if (find_pending(mdoc, tok, line, ppos, head))
                return;
 
        /* Close out scopes to remain in a consistent state. */
 
        rew_last(mdoc, head);
-       body = mdoc_body_alloc(mdoc, line, ppos, tok);
+       body = roff_body_alloc(mdoc, line, ppos, tok);
 out:
        if (mdoc->flags & MDOC_FREECOL) {
                rew_last(mdoc, body);
@@ -1128,7 +1162,7 @@ blk_part_imp(MACRO_PROT_ARGS)
         */
 
        blk = mdoc_block_alloc(mdoc, line, ppos, tok, NULL);
-       rew_last(mdoc, mdoc_head_alloc(mdoc, line, ppos, tok));
+       rew_last(mdoc, roff_head_alloc(mdoc, line, ppos, tok));
 
        /*
         * Open the body scope "on-demand", that is, after we've
@@ -1149,42 +1183,15 @@ blk_part_imp(MACRO_PROT_ARGS)
                }
 
                if (body == NULL)
-                       body = mdoc_body_alloc(mdoc, line, ppos, tok);
+                       body = roff_body_alloc(mdoc, line, ppos, tok);
 
                if (macro_or_word(mdoc, tok, line, la, pos, buf, 1))
                        break;
        }
        if (body == NULL)
-               body = mdoc_body_alloc(mdoc, line, ppos, tok);
-
-       /*
-        * If there is an open sub-block requiring explicit close-out,
-        * postpone closing out the current block until the
-        * rew_pending() call closing out the sub-block.
-        */
+               body = roff_body_alloc(mdoc, line, ppos, tok);
 
-       for (n = mdoc->last; n && n != body && n != blk->parent;
-            n = n->parent) {
-               if (n->flags & MDOC_ENDED) {
-                       if ( ! (n->flags & MDOC_VALID))
-                               n->flags |= MDOC_BROKEN;
-                       continue;
-               }
-               if (n->type == ROFFT_BLOCK &&
-                   mdoc_macros[n->tok].flags & MDOC_EXPLICIT) {
-                       n->flags |= MDOC_BROKEN;
-                       if ( ! (body->flags & MDOC_ENDED)) {
-                               mandoc_vmsg(MANDOCERR_BLK_NEST,
-                                   mdoc->parse, line, ppos,
-                                   "%s breaks %s", mdoc_macronames[tok],
-                                   mdoc_macronames[n->tok]);
-                               mdoc_endbody_alloc(mdoc, line, ppos,
-                                   tok, body, ENDBODY_NOSPACE);
-                       }
-               }
-       }
-       assert(n == body);
-       if (body->flags & MDOC_ENDED)
+       if (find_pending(mdoc, tok, line, ppos, body))
                return;
 
        rew_last(mdoc, body);
@@ -1233,11 +1240,11 @@ blk_part_exp(MACRO_PROT_ARGS)
                }
 
                if (head == NULL) {
-                       head = mdoc_head_alloc(mdoc, line, ppos, tok);
+                       head = roff_head_alloc(mdoc, line, ppos, tok);
                        if (tok == MDOC_Eo)  /* Not parsed. */
                                dword(mdoc, line, la, p, DELIM_MAX, 0);
                        rew_last(mdoc, head);
-                       mdoc_body_alloc(mdoc, line, ppos, tok);
+                       roff_body_alloc(mdoc, line, ppos, tok);
                        if (tok == MDOC_Eo)
                                continue;
                }
@@ -1249,8 +1256,8 @@ blk_part_exp(MACRO_PROT_ARGS)
        /* Clean-up to leave in a consistent state. */
 
        if (head == NULL) {
-               rew_last(mdoc, mdoc_head_alloc(mdoc, line, ppos, tok));
-               mdoc_body_alloc(mdoc, line, ppos, tok);
+               rew_last(mdoc, roff_head_alloc(mdoc, line, ppos, tok));
+               roff_body_alloc(mdoc, line, ppos, tok);
        }
        if (nl)
                append_delims(mdoc, line, pos, buf);
@@ -1331,9 +1338,9 @@ in_line_argn(MACRO_PROT_ARGS)
                }
 
                ntok = (ac == ARGS_QWORD || (tok == MDOC_Pf && state == 0)) ?
-                   MDOC_MAX : lookup(mdoc, tok, line, la, p);
+                   TOKEN_NONE : lookup(mdoc, tok, line, la, p);
 
-               if (ntok != MDOC_MAX) {
+               if (ntok != TOKEN_NONE) {
                        if (state >= 0) {
                                rew_elem(mdoc, tok);
                                state = -2;
@@ -1382,7 +1389,7 @@ in_line_eoln(MACRO_PROT_ARGS)
        if ((tok == MDOC_Pp || tok == MDOC_Lp) &&
            ! (mdoc->flags & MDOC_SYNOPSIS)) {
                n = mdoc->last;
-               if (mdoc->next == MDOC_NEXT_SIBLING)
+               if (mdoc->next == ROFF_NEXT_SIBLING)
                        n = n->parent;
                if (n->tok == MDOC_Nm)
                        rew_last(mdoc, mdoc->last->parent);
@@ -1408,7 +1415,7 @@ in_line_eoln(MACRO_PROT_ARGS)
  * or until the next macro, call that macro, and return 1.
  */
 static int
-parse_rest(struct mdoc *mdoc, int tok, int line, int *pos, char *buf)
+parse_rest(struct roff_man *mdoc, int tok, int line, int *pos, char *buf)
 {
        int              la;
 
@@ -1466,6 +1473,6 @@ phrase_ta(MACRO_PROT_ARGS)
        /* Advance to the next column. */
 
        rew_last(mdoc, body);
-       mdoc_body_alloc(mdoc, line, ppos, MDOC_It);
-       parse_rest(mdoc, MDOC_MAX, line, pos, buf);
+       roff_body_alloc(mdoc, line, ppos, MDOC_It);
+       parse_rest(mdoc, TOKEN_NONE, line, pos, buf);
 }