]> git.cameronkatri.com Git - mandoc.git/blobdiff - man_macro.c
Add support for markers. These decorate the last box: see eqn.7.
[mandoc.git] / man_macro.c
index 012d4163b536feeb14bbda882736fad4d1282250..1d0a431baa09b7ea4aa51545a93382f3674e20f6 100644 (file)
@@ -1,6 +1,6 @@
-/*     $Id: man_macro.c,v 1.43 2010/05/15 20:51:40 kristaps Exp $ */
+/*     $Id: man_macro.c,v 1.64 2011/07/07 05:42:32 kristaps Exp $ */
 /*
- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -23,6 +23,9 @@
 #include <stdlib.h>
 #include <string.h>
 
+#include "man.h"
+#include "mandoc.h"
+#include "libmandoc.h"
 #include "libman.h"
 
 enum   rew {
@@ -32,10 +35,11 @@ enum        rew {
 };
 
 static int              blk_close(MACRO_PROT_ARGS);
-static int              blk_dotted(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 int              man_args(struct man *, int, 
+                               int *, char *, char **);
 
 static int              rew_scope(enum man_type, 
                                struct man *, enum mant);
@@ -43,8 +47,8 @@ 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 int              rew_warn(struct man *, 
-                               struct man_node *, enum merr);
+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 */
@@ -69,24 +73,17 @@ const       struct man_macro __man_macros[MAN_MAX] = {
        { in_line_eoln, 0 }, /* IR */
        { in_line_eoln, 0 }, /* RI */
        { in_line_eoln, MAN_NSCOPED }, /* na */
-       { in_line_eoln, 0 }, /* i */
        { in_line_eoln, MAN_NSCOPED }, /* sp */
        { in_line_eoln, 0 }, /* nf */
        { in_line_eoln, 0 }, /* fi */
-       { in_line_eoln, 0 }, /* r */
        { blk_close, 0 }, /* RE */
        { blk_exp, MAN_EXPLICIT }, /* RS */
        { in_line_eoln, 0 }, /* DT */
        { in_line_eoln, 0 }, /* UC */
        { in_line_eoln, 0 }, /* PD */
-       { in_line_eoln, MAN_NSCOPED }, /* Sp */
-       { in_line_eoln, 0 }, /* Vb */
-       { in_line_eoln, 0 }, /* Ve */
-       { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* de */
-       { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* dei */
-       { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* am */
-       { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* ami */
-       { blk_dotted, 0 }, /* . */
+       { in_line_eoln, 0 }, /* AT */
+       { in_line_eoln, 0 }, /* in */
+       { in_line_eoln, 0 }, /* ft */
 };
 
 const  struct man_macro * const man_macros = __man_macros;
@@ -95,53 +92,56 @@ const       struct man_macro * const man_macros = __man_macros;
 /*
  * Warn when "n" is an explicit non-roff macro.
  */
-static int
-rew_warn(struct man *m, struct man_node *n, enum merr er)
+static void
+rew_warn(struct man *m, struct man_node *n, enum mandocerr er)
 {
 
-       if (er == WERRMAX || MAN_BLOCK != n->type)
-               return(1);
+       if (er == MANDOCERR_MAX || MAN_BLOCK != n->type)
+               return;
        if (MAN_VALID & n->flags)
-               return(1);
+               return;
        if ( ! (MAN_EXPLICIT & man_macros[n->tok].flags))
-               return(1);
-       if (MAN_NOCLOSE & man_macros[n->tok].flags)
-               return(1);
-       return(man_nwarn(m, n, er));
+               return;
+
+       assert(er < MANDOCERR_FATAL);
+       man_nmsg(m, n, er);
 }
 
 
 /*
- * Rewind scope.  If a code "er" != WERRMAX has been provided, it will
- * be used if an explicit block scope is being closed out.
+ * Rewind scope.  If a code "er" != MANDOCERR_MAX has been provided, it
+ * will be used if an explicit block scope is being closed out.
  */
 int
-man_unscope(struct man *m, const struct man_node *n, enum merr er)
+man_unscope(struct man *m, const struct man_node *to, 
+               enum mandocerr er)
 {
+       struct man_node *n;
 
-       assert(n);
+       assert(to);
+
+       assert(MAN_ROOT != m->last->type);
+       m->next = MAN_NEXT_SIBLING;
 
        /* LINTED */
-       while (m->last != n) {
-               if ( ! rew_warn(m, m->last, er))
-                       return(0);
+       while (m->last != to) {
+               /*
+                * Save the parent here, because we may delete the
+                * m->last node in the post-validation phase and reset
+                * it to m->last->parent, causing a step in the closing
+                * out to be lost.
+                */
+               n = m->last->parent;
+               rew_warn(m, m->last, er);
                if ( ! man_valid_post(m))
                        return(0);
-               if ( ! man_action_post(m))
-                       return(0);
-               m->last = m->last->parent;
+               m->last = n;
                assert(m->last);
        }
 
-       if ( ! rew_warn(m, m->last, er))
-               return(0);
+       rew_warn(m, m->last, er);
        if ( ! man_valid_post(m))
                return(0);
-       if ( ! man_action_post(m))
-               return(0);
-
-       m->next = MAN_ROOT == m->last->type ? 
-               MAN_NEXT_CHILD : MAN_NEXT_SIBLING;
 
        return(1);
 }
@@ -186,24 +186,6 @@ rew_dohalt(enum mant tok, enum man_type type, const struct man_node *n)
        if (type == n->type && tok == n->tok)
                return(REW_REWIND);
 
-       /*
-        * If we're a roff macro, then we can close out anything that
-        * stands between us and our parent context.
-        */
-       if (MAN_NOCLOSE & man_macros[tok].flags)
-               return(REW_NOHALT);
-
-       /* 
-        * Don't clobber roff macros: this is a bit complicated.  If the
-        * current macro is a roff macro, halt immediately and don't
-        * rewind.  If it's not, and the parent is, then close out the
-        * current scope and halt at the parent.
-        */
-       if (MAN_NOCLOSE & man_macros[n->tok].flags)
-               return(REW_HALT);
-       if (MAN_NOCLOSE & man_macros[n->parent->tok].flags)
-               return(REW_REWIND);
-
        /* 
         * Next follow the implicit scope-smashings as defined by man.7:
         * section, sub-section, etc.
@@ -272,55 +254,8 @@ rew_scope(enum man_type type, struct man *m, enum mant tok)
         * instruction that's mowing over explicit scopes.
         */
        assert(n);
-       if (MAN_NOCLOSE & man_macros[tok].flags)
-               return(man_unscope(m, n, WROFFSCOPE));
-
-       return(man_unscope(m, n, WERRMAX));
-}
-
-
-/*
- * Closure for dotted macros (de, dei, am, ami, ign).  This must handle
- * any of these as the parent node, so it needs special handling.
- * Beyond this, it's the same as blk_close().
- */
-/* ARGSUSED */
-int
-blk_dotted(MACRO_PROT_ARGS)
-{
-       enum mant        ntok;
-       struct man_node *nn;
-
-       /* Check for any of the following parents... */
-
-       for (nn = m->last->parent; nn; nn = nn->parent)
-               if (nn->tok == MAN_de || nn->tok == MAN_dei ||
-                               nn->tok == MAN_am ||
-                               nn->tok == MAN_ami) {
-                       ntok = nn->tok;
-                       break;
-               }
-
-       if (NULL == nn) {
-               if ( ! man_pwarn(m, line, ppos, WNOSCOPE))
-                       return(0);
-               return(1);
-       }
 
-       if ( ! rew_scope(MAN_BODY, m, ntok))
-               return(0);
-       if ( ! rew_scope(MAN_BLOCK, m, ntok))
-               return(0);
-
-       /*
-        * Restore flags set when we got here and also stipulate that we
-        * don't post-process the line when exiting the macro op
-        * function in man_pmacro().  See blk_exp().
-        */
-
-       m->flags = m->svflags | MAN_ILINE;
-       m->next = m->svnext;
-       return(1);
+       return(man_unscope(m, n, MANDOCERR_MAX));
 }
 
 
@@ -348,8 +283,7 @@ blk_close(MACRO_PROT_ARGS)
                        break;
 
        if (NULL == nn)
-               if ( ! man_pwarn(m, line, ppos, WNOSCOPE))
-                       return(0);
+               man_pmsg(m, line, ppos, MANDOCERR_NOSCOPE);
 
        if ( ! rew_scope(MAN_BODY, m, ntok))
                return(0);
@@ -360,10 +294,11 @@ blk_close(MACRO_PROT_ARGS)
 }
 
 
+/* ARGSUSED */
 int
 blk_exp(MACRO_PROT_ARGS)
 {
-       int              w, la;
+       int              la;
        char            *p;
 
        /* 
@@ -372,24 +307,6 @@ blk_exp(MACRO_PROT_ARGS)
         * anywhere.
         */
 
-       if ( ! (MAN_NOCLOSE & man_macros[tok].flags)) {
-               if ( ! rew_scope(MAN_BODY, m, tok))
-                       return(0);
-               if ( ! rew_scope(MAN_BLOCK, m, tok))
-                       return(0);
-       } else {
-               /*
-                * Save our state and next-scope indicator; we restore
-                * it when exiting from the roff instruction block.  See
-                * blk_dotted().
-                */
-               m->svflags = m->flags;
-               m->svnext = m->next;
-               
-               /* Make sure we drop any line modes. */
-               m->flags = 0;
-       }
-
        if ( ! man_block_alloc(m, line, ppos, tok))
                return(0);
        if ( ! man_head_alloc(m, line, ppos, tok))
@@ -397,13 +314,8 @@ blk_exp(MACRO_PROT_ARGS)
 
        for (;;) {
                la = *pos;
-               w = man_args(m, line, pos, buf, &p);
-
-               if (-1 == w)
-                       return(0);
-               if (0 == w)
+               if ( ! man_args(m, line, pos, buf, &p))
                        break;
-
                if ( ! man_word_alloc(m, line, la, p))
                        return(0);
        }
@@ -424,10 +336,11 @@ blk_exp(MACRO_PROT_ARGS)
  * scopes, such as `SH' closing out an `SS', are defined in the rew
  * routines.
  */
+/* ARGSUSED */
 int
 blk_imp(MACRO_PROT_ARGS)
 {
-       int              w, la;
+       int              la;
        char            *p;
        struct man_node *n;
 
@@ -451,13 +364,8 @@ blk_imp(MACRO_PROT_ARGS)
 
        for (;;) {
                la = *pos;
-               w = man_args(m, line, pos, buf, &p);
-
-               if (-1 == w)
-                       return(0);
-               if (0 == w)
+               if ( ! man_args(m, line, pos, buf, &p))
                        break;
-
                if ( ! man_word_alloc(m, line, la, p))
                        return(0);
        }
@@ -481,10 +389,11 @@ blk_imp(MACRO_PROT_ARGS)
 }
 
 
+/* ARGSUSED */
 int
 in_line_eoln(MACRO_PROT_ARGS)
 {
-       int              w, la;
+       int              la;
        char            *p;
        struct man_node *n;
 
@@ -495,11 +404,7 @@ in_line_eoln(MACRO_PROT_ARGS)
 
        for (;;) {
                la = *pos;
-               w = man_args(m, line, pos, buf, &p);
-
-               if (-1 == w)
-                       return(0);
-               if (0 == w)
+               if ( ! man_args(m, line, pos, buf, &p))
                        break;
                if ( ! man_word_alloc(m, line, la, p))
                        return(0);
@@ -523,6 +428,9 @@ in_line_eoln(MACRO_PROT_ARGS)
                assert( ! (MAN_SCOPED & man_macros[tok].flags));
                m->flags |= MAN_ILINE;
        }
+
+       assert(MAN_ROOT != m->last->type);
+       m->next = MAN_NEXT_SIBLING;
        
        /*
         * Rewind our element scope.  Note that when TH is pruned, we'll
@@ -537,8 +445,6 @@ in_line_eoln(MACRO_PROT_ARGS)
                        break;
                if ( ! man_valid_post(m))
                        return(0);
-               if ( ! man_action_post(m))
-                       return(0);
        }
 
        assert(m->last);
@@ -549,11 +455,6 @@ in_line_eoln(MACRO_PROT_ARGS)
 
        if (m->last->type != MAN_ROOT && ! man_valid_post(m))
                return(0);
-       if (m->last->type != MAN_ROOT && ! man_action_post(m))
-               return(0);
-
-       m->next = MAN_ROOT == m->last->type ?
-               MAN_NEXT_CHILD : MAN_NEXT_SIBLING;
 
        return(1);
 }
@@ -563,6 +464,21 @@ int
 man_macroend(struct man *m)
 {
 
-       return(man_unscope(m, m->first, WEXITSCOPE));
+       return(man_unscope(m, m->first, MANDOCERR_SCOPEEXIT));
 }
 
+static int
+man_args(struct man *m, int line, int *pos, char *buf, char **v)
+{
+       char     *start;
+
+       assert(*pos);
+       *v = start = buf + *pos;
+       assert(' ' != *start);
+
+       if ('\0' == *start)
+               return(0);
+
+       *v = mandoc_getarg(m->parse, v, line, pos);
+       return(1);
+}