In the SYNOPSIS, .Nm at the beginning of an input line starts

[mandoc.git] / man_macro.c

diff --git a/man_macro.c b/man_macro.c
index 5281a90592de4e3797b43df0e773e57ce9712034..bf36e79989fd86c232db767398e5b4bda3a5769a 100644 (file)
--- a/man_macro.c
+++ b/man_macro.c
@@ -1,6 +1,6 @@
-/*     $Id: man_macro.c,v 1.35 2010/03/24 20:10:53 kristaps Exp $ */
+/*     $Id: man_macro.c,v 1.48 2010/06/26 16:07:08 kristaps Exp $ */

 /*
 /*

- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 2009 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
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above


@@ -23,16 +23,16 @@
 #include <stdlib.h>
 #include <string.h>
 
 #include <stdlib.h>
 #include <string.h>
 

+#include "mandoc.h"

 #include "libman.h"
 
 enum   rew {
        REW_REWIND,
        REW_NOHALT,
 #include "libman.h"
 
 enum   rew {
        REW_REWIND,
        REW_NOHALT,

-       REW_HALT,
+       REW_HALT

 };
 
 static int              blk_close(MACRO_PROT_ARGS);
 };
 
 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              blk_exp(MACRO_PROT_ARGS);
 static int              blk_imp(MACRO_PROT_ARGS);
 static int              in_line_eoln(MACRO_PROT_ARGS);


@@ -43,6 +43,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 *);
                                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 mandocerr);

 
 const  struct man_macro __man_macros[MAN_MAX] = {
        { in_line_eoln, MAN_NSCOPED }, /* br */
 
 const  struct man_macro __man_macros[MAN_MAX] = {
        { in_line_eoln, MAN_NSCOPED }, /* br */


@@ -80,25 +82,44 @@ const       struct man_macro __man_macros[MAN_MAX] = {
        { in_line_eoln, MAN_NSCOPED }, /* Sp */
        { in_line_eoln, 0 }, /* Vb */
        { in_line_eoln, 0 }, /* Ve */
        { 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_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* ig */
-       { blk_dotted, 0 }, /* . */
+       { in_line_eoln, 0 }, /* AT */

 };
 
 const  struct man_macro * const man_macros = __man_macros;
 
 
 };
 
 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 mandocerr er)
+{
+
+       if (er == MANDOCERR_MAX || MAN_BLOCK != n->type)
+               return(1);
+       if (MAN_VALID & n->flags)
+               return(1);
+       if ( ! (MAN_EXPLICIT & man_macros[n->tok].flags))
+               return(1);
+       return(man_nmsg(m, n, er));
+}
+
+
+/*
+ * 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
 int

-man_unscope(struct man *m, const struct man_node *n)
+man_unscope(struct man *m, const struct man_node *n, 
+               enum mandocerr er)

 {
 
        assert(n);
 
        /* LINTED */
        while (m->last != n) {
 {
 
        assert(n);
 
        /* LINTED */
        while (m->last != n) {

+               if ( ! rew_warn(m, m->last, er))
+                       return(0);

                if ( ! man_valid_post(m))
                        return(0);
                if ( ! man_action_post(m))
                if ( ! man_valid_post(m))
                        return(0);
                if ( ! man_action_post(m))


@@ -107,6 +128,8 @@ man_unscope(struct man *m, const struct man_node *n)
                assert(m->last);
        }
 
                assert(m->last);
        }
 

+       if ( ! rew_warn(m, m->last, er))
+               return(0);

        if ( ! man_valid_post(m))
                return(0);
        if ( ! man_action_post(m))
        if ( ! man_valid_post(m))
                return(0);
        if ( ! man_action_post(m))


@@ -140,18 +163,29 @@ rew_dohalt(enum mant tok, enum man_type type, const struct man_node *n)
 {
        enum rew         c;
 
 {
        enum rew         c;
 

+       /* We cannot progress beyond the root ever. */

        if (MAN_ROOT == n->type)
                return(REW_HALT);
        if (MAN_ROOT == n->type)
                return(REW_HALT);

+

        assert(n->parent);
        assert(n->parent);

+
+       /* Normal nodes shouldn't go to the level of the root. */

        if (MAN_ROOT == n->parent->type)
                return(REW_REWIND);
        if (MAN_ROOT == n->parent->type)
                return(REW_REWIND);

+
+       /* Already-validated nodes should be closed out. */

        if (MAN_VALID & n->flags)
                return(REW_NOHALT);
 
        if (MAN_VALID & n->flags)
                return(REW_NOHALT);
 

-       /* Rewind to ourselves, first. */
+       /* First: rewind to ourselves. */

        if (type == n->type && tok == n->tok)
                return(REW_REWIND);
 
        if (type == n->type && tok == n->tok)
                return(REW_REWIND);
 

+       /* 
+        * Next follow the implicit scope-smashings as defined by man.7:
+        * section, sub-section, etc.
+        */
+

        switch (tok) {
        case (MAN_SH):
                break;
        switch (tok) {
        case (MAN_SH):
                break;


@@ -210,44 +244,19 @@ rew_scope(enum man_type type, struct man *m, enum mant tok)
                        break;
        }
 
                        break;
        }
 

-       /* Rewind until the current point. */
-
+       /* 
+        * Rewind until the current point.  Warn if we're a roff
+        * instruction that's mowing over explicit scopes.
+        */

        assert(n);
        assert(n);

-       return(man_unscope(m, n));
-}
-
-
-/* ARGSUSED */
-int
-blk_dotted(MACRO_PROT_ARGS)
-{
-       enum mant        ntok;
-       struct man_node *nn;

 
 

-       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 ||
-                               nn->tok == MAN_ig) {
-                       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);
-
-       return(1);
+       return(man_unscope(m, n, MANDOCERR_MAX));

 }
 
 
 }
 
 

+/*
+ * Close out a generic explicit macro.
+ */

 /* ARGSUSED */
 int
 blk_close(MACRO_PROT_ARGS)
 /* ARGSUSED */
 int
 blk_close(MACRO_PROT_ARGS)


@@ -269,7 +278,7 @@ blk_close(MACRO_PROT_ARGS)
                        break;
 
        if (NULL == nn)
                        break;
 
        if (NULL == nn)

-               if ( ! man_pwarn(m, line, ppos, WNOSCOPE))
+               if ( ! man_pmsg(m, line, ppos, MANDOCERR_NOSCOPE))

                        return(0);
 
        if ( ! rew_scope(MAN_BODY, m, ntok))
                        return(0);
 
        if ( ! rew_scope(MAN_BODY, m, ntok))


@@ -281,12 +290,12 @@ blk_close(MACRO_PROT_ARGS)
 }
 
 
 }
 
 

+/* ARGSUSED */

 int
 blk_exp(MACRO_PROT_ARGS)
 {
        int              w, la;
        char            *p;
 int
 blk_exp(MACRO_PROT_ARGS)
 {
        int              w, la;
        char            *p;

-       struct man_node *n;

 
        /* 
         * Close out prior scopes.  "Regular" explicit macros cannot be
 
        /* 
         * Close out prior scopes.  "Regular" explicit macros cannot be


@@ -294,20 +303,16 @@ blk_exp(MACRO_PROT_ARGS)
         * anywhere.
         */
 
         * 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);
-       }
+       if ( ! rew_scope(MAN_BODY, m, tok))
+               return(0);
+       if ( ! rew_scope(MAN_BLOCK, m, tok))
+               return(0);

 
        if ( ! man_block_alloc(m, line, ppos, tok))
                return(0);
        if ( ! man_head_alloc(m, line, ppos, tok))
                return(0);
 
 
        if ( ! man_block_alloc(m, line, ppos, tok))
                return(0);
        if ( ! man_head_alloc(m, line, ppos, tok))
                return(0);
 

-       n = m->last;
-

        for (;;) {
                la = *pos;
                w = man_args(m, line, pos, buf, &p);
        for (;;) {
                la = *pos;
                w = man_args(m, line, pos, buf, &p);


@@ -337,6 +342,7 @@ blk_exp(MACRO_PROT_ARGS)
  * scopes, such as `SH' closing out an `SS', are defined in the rew
  * routines.
  */
  * scopes, such as `SH' closing out an `SS', are defined in the rew
  * routines.
  */

+/* ARGSUSED */

 int
 blk_imp(MACRO_PROT_ARGS)
 {
 int
 blk_imp(MACRO_PROT_ARGS)
 {


@@ -394,6 +400,7 @@ blk_imp(MACRO_PROT_ARGS)
 }
 
 
 }
 
 

+/* ARGSUSED */

 int
 in_line_eoln(MACRO_PROT_ARGS)
 {
 int
 in_line_eoln(MACRO_PROT_ARGS)
 {


@@ -475,20 +482,7 @@ in_line_eoln(MACRO_PROT_ARGS)
 int
 man_macroend(struct man *m)
 {
 int
 man_macroend(struct man *m)
 {

-       struct man_node *n;
-
-       n = MAN_VALID & m->last->flags ?
-               m->last->parent : m->last;
-
-       for ( ; n; n = n->parent) {
-               if (MAN_BLOCK != n->type)
-                       continue;
-               if ( ! (MAN_EXPLICIT & man_macros[n->tok].flags))
-                       continue;
-               if ( ! man_nwarn(m, n, WEXITSCOPE))
-                       return(0);
-       }

 
 

-       return(man_unscope(m, m->first));
+       return(man_unscope(m, m->first, MANDOCERR_SCOPEEXIT));

 }
 
 }