]> git.cameronkatri.com Git - mandoc.git/blobdiff - man_macro.c
Simplify by making many functions in the man(7) parser void,
[mandoc.git] / man_macro.c
index 51e916086d7c5d23e5ee49e24b0e7d3356486a37..1b8965899edcb6e88ae5712127914523384d47e6 100644 (file)
@@ -1,7 +1,7 @@
-/*     $Id: man_macro.c,v 1.83 2014/07/07 19:18:15 schwarze Exp $ */
+/*     $Id: man_macro.c,v 1.91 2014/11/28 05:51:32 schwarze Exp $ */
 /*
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2012, 2013 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2012, 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
  * Copyright (c) 2013 Franco Fichtner <franco@lastsummer.de>
  *
  * Permission to use, copy, modify, and distribute this software for any
@@ -16,9 +16,9 @@
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
-#ifdef HAVE_CONFIG_H
 #include "config.h"
-#endif
+
+#include <sys/types.h>
 
 #include <assert.h>
 #include <ctype.h>
@@ -36,21 +36,19 @@ enum        rew {
        REW_HALT
 };
 
-static int              blk_close(MACRO_PROT_ARGS);
-static int              blk_exp(MACRO_PROT_ARGS);
-static int              blk_imp(MACRO_PROT_ARGS);
-static int              in_line_eoln(MACRO_PROT_ARGS);
+static void             blk_close(MACRO_PROT_ARGS);
+static void             blk_exp(MACRO_PROT_ARGS);
+static void             blk_imp(MACRO_PROT_ARGS);
+static void             in_line_eoln(MACRO_PROT_ARGS);
 static int              man_args(struct man *, int,
                                int *, char *, char **);
 
-static int              rew_scope(enum man_type,
+static void             rew_scope(enum man_type,
                                struct man *, enum mant);
 static enum rew         rew_dohalt(enum mant, enum man_type,
                                const struct man_node *);
 static enum rew         rew_block(enum mant, enum man_type,
                                const struct man_node *);
-static void             rew_warn(struct man *,
-                               struct man_node *, enum mandocerr);
 
 const  struct man_macro __man_macros[MAN_MAX] = {
        { in_line_eoln, MAN_NSCOPED }, /* br */
@@ -63,15 +61,15 @@ const       struct man_macro __man_macros[MAN_MAX] = {
        { blk_imp, MAN_BSCOPE }, /* P */
        { blk_imp, MAN_BSCOPE }, /* IP */
        { blk_imp, MAN_BSCOPE }, /* HP */
-       { in_line_eoln, MAN_SCOPED }, /* SM */
-       { in_line_eoln, MAN_SCOPED }, /* SB */
+       { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* SM */
+       { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* SB */
        { in_line_eoln, 0 }, /* BI */
        { in_line_eoln, 0 }, /* IB */
        { in_line_eoln, 0 }, /* BR */
        { in_line_eoln, 0 }, /* RB */
-       { in_line_eoln, MAN_SCOPED }, /* R */
-       { in_line_eoln, MAN_SCOPED }, /* B */
-       { in_line_eoln, MAN_SCOPED }, /* I */
+       { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* R */
+       { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* B */
+       { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* I */
        { in_line_eoln, 0 }, /* IR */
        { in_line_eoln, 0 }, /* RI */
        { in_line_eoln, MAN_NSCOPED }, /* na */
@@ -97,42 +95,72 @@ const       struct man_macro __man_macros[MAN_MAX] = {
 const  struct man_macro * const man_macros = __man_macros;
 
 
-int
+void
 man_unscope(struct man *man, const struct man_node *to)
 {
        struct man_node *n;
 
-       man->next = MAN_NEXT_SIBLING;
        to = to->parent;
        n = man->last;
        while (n != to) {
-               if (NULL == to &&
-                   MAN_BLOCK == n->type &&
-                   0 == (MAN_VALID & n->flags) &&
-                   MAN_EXPLICIT & man_macros[n->tok].flags)
-                       mandoc_msg(MANDOCERR_SCOPEEXIT,
-                           man->parse, n->line, n->pos,
-                           man_macronames[n->tok]);
+
+               /* Reached the end of the document? */
+
+               if (to == NULL && ! (n->flags & MAN_VALID)) {
+                       if (man->flags & (MAN_BLINE | MAN_ELINE) &&
+                           man_macros[n->tok].flags & MAN_SCOPED) {
+                               mandoc_vmsg(MANDOCERR_BLK_LINE,
+                                   man->parse, n->line, n->pos,
+                                   "EOF breaks %s",
+                                   man_macronames[n->tok]);
+                               if (man->flags & MAN_ELINE)
+                                       man->flags &= ~MAN_ELINE;
+                               else {
+                                       assert(n->type == MAN_HEAD);
+                                       n = n->parent;
+                                       man->flags &= ~MAN_BLINE;
+                               }
+                               man->last = n;
+                               n = n->parent;
+                               man_node_delete(man, man->last);
+                               continue;
+                       }
+                       if (n->type == MAN_BLOCK &&
+                           man_macros[n->tok].flags & MAN_EXPLICIT)
+                               mandoc_msg(MANDOCERR_BLK_NOEND,
+                                   man->parse, n->line, n->pos,
+                                   man_macronames[n->tok]);
+               }
+
                /*
                 * We might delete the man->last node
                 * in the post-validation phase.
                 * Save a pointer to the parent such that
                 * we know where to continue the iteration.
                 */
+
                man->last = n;
                n = n->parent;
-               if ( ! man_valid_post(man))
-                       return(0);
+               man_valid_post(man);
        }
-       return(1);
+
+       /*
+        * If we ended up at the parent of the node we were
+        * supposed to rewind to, that means the target node
+        * got deleted, so add the next node we parse as a child
+        * of the parent instead of as a sibling of the target.
+        */
+
+       man->next = (man->last == to) ?
+           MAN_NEXT_CHILD : MAN_NEXT_SIBLING;
 }
 
 static enum rew
 rew_block(enum mant ntok, enum man_type type, const struct man_node *n)
 {
 
-       if (MAN_BLOCK == type && ntok == n->parent->tok &&
-           MAN_BODY == n->parent->type)
+       if (type == MAN_BLOCK && ntok == n->parent->tok &&
+           n->parent->type == MAN_BODY)
                return(REW_REWIND);
        return(ntok == n->tok ? REW_HALT : REW_NOHALT);
 }
@@ -215,7 +243,7 @@ rew_dohalt(enum mant tok, enum man_type type, const struct man_node *n)
  * for example, the `SH' macro will close out any intervening `SS'
  * scopes.  When a scope is closed, it must be validated and actioned.
  */
-static int
+static void
 rew_scope(enum man_type type, struct man *man, enum mant tok)
 {
        struct man_node *n;
@@ -229,7 +257,7 @@ rew_scope(enum man_type type, struct man *man, enum mant tok)
                 */
                c = rew_dohalt(tok, type, n);
                if (REW_HALT == c)
-                       return(1);
+                       return;
                if (REW_REWIND == c)
                        break;
        }
@@ -238,16 +266,15 @@ rew_scope(enum man_type type, struct man *man, enum mant tok)
         * Rewind until the current point.  Warn if we're a roff
         * instruction that's mowing over explicit scopes.
         */
-       assert(n);
 
-       return(man_unscope(man, n));
+       man_unscope(man, n);
 }
 
 
 /*
  * Close out a generic explicit macro.
  */
-int
+void
 blk_close(MACRO_PROT_ARGS)
 {
        enum mant                ntok;
@@ -266,56 +293,46 @@ blk_close(MACRO_PROT_ARGS)
        }
 
        for (nn = man->last->parent; nn; nn = nn->parent)
-               if (ntok == nn->tok && MAN_BLOCK == nn->type)
+               if (nn->tok == ntok && nn->type == MAN_BLOCK)
                        break;
 
-       if (NULL == nn) {
-               man_pmsg(man, line, ppos, MANDOCERR_NOSCOPE);
-               if ( ! rew_scope(MAN_BLOCK, man, MAN_PP))
-                       return(0);
+       if (nn == NULL) {
+               mandoc_msg(MANDOCERR_BLK_NOTOPEN, man->parse,
+                   line, ppos, man_macronames[tok]);
+               rew_scope(MAN_BLOCK, man, MAN_PP);
        } else
                man_unscope(man, nn);
-
-       return(1);
 }
 
-int
+void
 blk_exp(MACRO_PROT_ARGS)
 {
        struct man_node *n;
        int              la;
        char            *p;
 
-       /* Close out prior implicit scopes. */
-
-       if ( ! rew_scope(MAN_BLOCK, man, tok))
-               return(0);
-
-       if ( ! man_block_alloc(man, line, ppos, tok))
-               return(0);
-       if ( ! man_head_alloc(man, line, ppos, tok))
-               return(0);
+       rew_scope(MAN_BLOCK, man, tok);
+       man_block_alloc(man, line, ppos, tok);
+       man_head_alloc(man, line, ppos, tok);
 
        for (;;) {
                la = *pos;
                if ( ! man_args(man, line, pos, buf, &p))
                        break;
-               if ( ! man_word_alloc(man, line, la, p))
-                       return(0);
+               man_word_alloc(man, line, la, p);
        }
 
        assert(man);
        assert(tok != MAN_MAX);
 
-       for (n = man->last; n; n = n->parent) {
-               if (n->tok != tok)
-                       continue;
-               assert(MAN_HEAD == n->type);
-               man_unscope(man, n);
-               break;
-       }
+       for (n = man->last; n; n = n->parent)
+               if (n->tok == tok) {
+                       assert(n->type == MAN_HEAD);
+                       man_unscope(man, n);
+                       break;
+               }
 
-       return(man_body_alloc(man, line, ppos, tok));
+       man_body_alloc(man, line, ppos, tok);
 }
 
 /*
@@ -324,27 +341,17 @@ blk_exp(MACRO_PROT_ARGS)
  * scopes, such as `SH' closing out an `SS', are defined in the rew
  * routines.
  */
-int
+void
 blk_imp(MACRO_PROT_ARGS)
 {
        int              la;
        char            *p;
        struct man_node *n;
 
-       /* Close out prior scopes. */
-
-       if ( ! rew_scope(MAN_BODY, man, tok))
-               return(0);
-       if ( ! rew_scope(MAN_BLOCK, man, tok))
-               return(0);
-
-       /* Allocate new block & head scope. */
-
-       if ( ! man_block_alloc(man, line, ppos, tok))
-               return(0);
-       if ( ! man_head_alloc(man, line, ppos, tok))
-               return(0);
-
+       rew_scope(MAN_BODY, man, tok);
+       rew_scope(MAN_BLOCK, man, tok);
+       man_block_alloc(man, line, ppos, tok);
+       man_head_alloc(man, line, ppos, tok);
        n = man->last;
 
        /* Add line arguments. */
@@ -353,46 +360,44 @@ blk_imp(MACRO_PROT_ARGS)
                la = *pos;
                if ( ! man_args(man, line, pos, buf, &p))
                        break;
-               if ( ! man_word_alloc(man, line, la, p))
-                       return(0);
+               man_word_alloc(man, line, la, p);
        }
 
        /* Close out head and open body (unless MAN_SCOPE). */
 
-       if (MAN_SCOPED & man_macros[tok].flags) {
+       if (man_macros[tok].flags & MAN_SCOPED) {
                /* If we're forcing scope (`TP'), keep it open. */
-               if (MAN_FSCOPED & man_macros[tok].flags) {
+               if (man_macros[tok].flags & MAN_FSCOPED) {
                        man->flags |= MAN_BLINE;
-                       return(1);
+                       return;
                } else if (n == man->last) {
                        man->flags |= MAN_BLINE;
-                       return(1);
+                       return;
                }
        }
-
-       if ( ! rew_scope(MAN_HEAD, man, tok))
-               return(0);
-       return(man_body_alloc(man, line, ppos, tok));
+       rew_scope(MAN_HEAD, man, tok);
+       man_body_alloc(man, line, ppos, tok);
 }
 
-int
+void
 in_line_eoln(MACRO_PROT_ARGS)
 {
        int              la;
        char            *p;
        struct man_node *n;
 
-       if ( ! man_elem_alloc(man, line, ppos, tok))
-               return(0);
-
+       man_elem_alloc(man, line, ppos, tok);
        n = man->last;
 
        for (;;) {
                la = *pos;
                if ( ! man_args(man, line, pos, buf, &p))
                        break;
-               if ( ! man_word_alloc(man, line, la, p))
-                       return(0);
+               if (man_macros[tok].flags & MAN_JOIN &&
+                   man->last->type == MAN_TEXT)
+                       man_word_append(man, p);
+               else
+                       man_word_alloc(man, line, la, p);
        }
 
        /*
@@ -410,20 +415,13 @@ in_line_eoln(MACRO_PROT_ARGS)
         * waiting for terms to load into our context.
         */
 
-       if (n == man->last && MAN_SCOPED & man_macros[tok].flags) {
-               assert( ! (MAN_NSCOPED & man_macros[tok].flags));
+       if (n == man->last && man_macros[tok].flags & MAN_SCOPED) {
+               assert( ! (man_macros[tok].flags & MAN_NSCOPED));
                man->flags |= MAN_ELINE;
-               return(1);
-       }
-
-       /* Set ignorable context, if applicable. */
-
-       if (MAN_NSCOPED & man_macros[tok].flags) {
-               assert( ! (MAN_SCOPED & man_macros[tok].flags));
-               man->flags |= MAN_ILINE;
+               return;
        }
 
-       assert(MAN_ROOT != man->last->type);
+       assert(man->last->type != MAN_ROOT);
        man->next = MAN_NEXT_SIBLING;
 
        /*
@@ -437,8 +435,7 @@ in_line_eoln(MACRO_PROT_ARGS)
                        break;
                if (man->last->type == MAN_ROOT)
                        break;
-               if ( ! man_valid_post(man))
-                       return(0);
+               man_valid_post(man);
        }
 
        assert(man->last);
@@ -447,18 +444,16 @@ in_line_eoln(MACRO_PROT_ARGS)
         * Same here regarding whether we're back at the root.
         */
 
-       if (man->last->type != MAN_ROOT && ! man_valid_post(man))
-               return(0);
-
-       return(1);
+       if (man->last->type != MAN_ROOT)
+               man_valid_post(man);
 }
 
 
-int
+void
 man_macroend(struct man *man)
 {
 
-       return(man_unscope(man, man->first));
+       man_unscope(man, man->first);
 }
 
 static int