Allow `Bd' to accept (warn about then ignore) in-line arguments.

[mandoc.git] / man.c

diff --git a/man.c b/man.c
index 1cc0811a6134d4e30b7a70d84a0665f581364745..b1853d1a08d6acb7ae85e4d28620bacc82cb8584 100644 (file)
--- a/man.c
+++ b/man.c
@@ -1,4 +1,4 @@
-/*     $Id: man.c,v 1.45 2009/10/30 05:58:37 kristaps Exp $ */
+/*     $Id: man.c,v 1.59 2010/03/29 10:10:35 kristaps Exp $ */

 /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
  *
 /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
  *


@@ -14,6 +14,10 @@
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
  * 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 <sys/types.h>
 
 #include <assert.h>


@@ -31,6 +35,7 @@ const char *const __man_merrnames[WERRMAX] = {
        "invalid manual section", /* WMSEC */
        "invalid date format", /* WDATE */
        "scope of prior line violated", /* WLNSCOPE */
        "invalid manual section", /* WMSEC */
        "invalid date format", /* WDATE */
        "scope of prior line violated", /* WLNSCOPE */

+       "over-zealous prior line scope violation", /* WLNSCOPE2 */

        "trailing whitespace", /* WTSPACE */
        "unterminated quoted parameter", /* WTQUOTE */
        "document has no body", /* WNODATA */
        "trailing whitespace", /* WTSPACE */
        "unterminated quoted parameter", /* WTQUOTE */
        "document has no body", /* WNODATA */


@@ -44,7 +49,10 @@ const        char *const __man_merrnames[WERRMAX] = {
        "scope open on exit", /* WEXITSCOPE */
        "no scope context", /* WNOSCOPE */
        "literal context already open", /* WOLITERAL */
        "scope open on exit", /* WEXITSCOPE */
        "no scope context", /* WNOSCOPE */
        "literal context already open", /* WOLITERAL */

-       "no literal context open" /* WNLITERAL */
+       "no literal context open", /* WNLITERAL */
+       "invalid nesting of roff declarations", /* WROFFNEST */
+       "scope in roff instructions broken", /* WROFFSCOPE */
+       "document title should be uppercase", /* WTITLECASE */

 };
 
 const  char *const __man_macronames[MAN_MAX] = {                
 };
 
 const  char *const __man_macronames[MAN_MAX] = {                


@@ -55,15 +63,21 @@ const       char *const __man_macronames[MAN_MAX] = {
        "R",            "B",            "I",            "IR",
        "RI",           "na",           "i",            "sp",
        "nf",           "fi",           "r",            "RE",
        "R",            "B",            "I",            "IR",
        "RI",           "na",           "i",            "sp",
        "nf",           "fi",           "r",            "RE",

-       "RS",           "DT",           "UC",           "PD"
+       "RS",           "DT",           "UC",           "PD",
+       "Sp",           "Vb",           "Ve",           "de",
+       "dei",          "am",           "ami",          "ig",
+       ".",

        };
 
 const  char * const *man_macronames = __man_macronames;
 
 static struct man_node *man_node_alloc(int, int, 
        };
 
 const  char * const *man_macronames = __man_macronames;
 
 static struct man_node *man_node_alloc(int, int, 

-                               enum man_type, int);
+                               enum man_type, enum mant);

 static int              man_node_append(struct man *, 
                                struct man_node *);
 static int              man_node_append(struct man *, 
                                struct man_node *);

+static void             man_node_free(struct man_node *);
+static void             man_node_unlink(struct man *, 
+                               struct man_node *);

 static int              man_ptext(struct man *, int, char *);
 static int              man_pmacro(struct man *, int, char *);
 static void             man_free1(struct man *);
 static int              man_ptext(struct man *, int, char *);
 static int              man_pmacro(struct man *, int, char *);
 static void             man_free1(struct man *);


@@ -72,10 +86,6 @@ static       int              pstring(struct man *, int, int,
                                const char *, size_t);
 static int              macrowarn(struct man *, int, const char *);
 
                                const char *, size_t);
 static int              macrowarn(struct man *, int, const char *);
 

-#ifdef __linux__
-extern size_t            strlcpy(char *, const char *, size_t);
-#endif
-

 
 const struct man_node *
 man_node(const struct man *m)
 
 const struct man_node *
 man_node(const struct man *m)


@@ -147,7 +157,7 @@ int
 man_parseln(struct man *m, int ln, char *buf)
 {
 
 man_parseln(struct man *m, int ln, char *buf)
 {
 

-       return('.' == *buf ? 
+       return('.' == *buf || '\'' == *buf ? 

                        man_pmacro(m, ln, buf) : 
                        man_ptext(m, ln, buf));
 }
                        man_pmacro(m, ln, buf) : 
                        man_ptext(m, ln, buf));
 }


@@ -158,7 +168,7 @@ man_free1(struct man *man)
 {
 
        if (man->first)
 {
 
        if (man->first)

-               man_node_freelist(man->first);
+               man_node_delete(man, man->first);

        if (man->meta.title)
                free(man->meta.title);
        if (man->meta.source)
        if (man->meta.title)
                free(man->meta.title);
        if (man->meta.source)


@@ -177,6 +187,7 @@ man_alloc1(struct man *m)
        m->last = mandoc_calloc(1, sizeof(struct man_node));
        m->first = m->last;
        m->last->type = MAN_ROOT;
        m->last = mandoc_calloc(1, sizeof(struct man_node));
        m->first = m->last;
        m->last->type = MAN_ROOT;

+       m->last->tok = MAN_MAX;

        m->next = MAN_NEXT_CHILD;
 }
 
        m->next = MAN_NEXT_CHILD;
 }
 


@@ -204,6 +215,7 @@ man_node_append(struct man *man, struct man_node *p)
                /* NOTREACHED */
        }
        
                /* NOTREACHED */
        }
        

+       assert(p->parent);

        p->parent->nchild++;
 
        if ( ! man_valid_pre(man, p))
        p->parent->nchild++;
 
        if ( ! man_valid_pre(man, p))


@@ -240,7 +252,7 @@ man_node_append(struct man *man, struct man_node *p)
 
 
 static struct man_node *
 
 
 static struct man_node *

-man_node_alloc(int line, int pos, enum man_type type, int tok)
+man_node_alloc(int line, int pos, enum man_type type, enum mant tok)

 {
        struct man_node *p;
 
 {
        struct man_node *p;
 


@@ -254,7 +266,7 @@ man_node_alloc(int line, int pos, enum man_type type, int tok)
 
 
 int
 
 
 int

-man_elem_alloc(struct man *m, int line, int pos, int tok)
+man_elem_alloc(struct man *m, int line, int pos, enum mant tok)

 {
        struct man_node *p;
 
 {
        struct man_node *p;
 


@@ -267,7 +279,7 @@ man_elem_alloc(struct man *m, int line, int pos, int tok)
 
 
 int
 
 
 int

-man_head_alloc(struct man *m, int line, int pos, int tok)
+man_head_alloc(struct man *m, int line, int pos, enum mant tok)

 {
        struct man_node *p;
 
 {
        struct man_node *p;
 


@@ -280,7 +292,7 @@ man_head_alloc(struct man *m, int line, int pos, int tok)
 
 
 int
 
 
 int

-man_body_alloc(struct man *m, int line, int pos, int tok)
+man_body_alloc(struct man *m, int line, int pos, enum mant tok)

 {
        struct man_node *p;
 
 {
        struct man_node *p;
 


@@ -293,7 +305,7 @@ man_body_alloc(struct man *m, int line, int pos, int tok)
 
 
 int
 
 
 int

-man_block_alloc(struct man *m, int line, int pos, int tok)
+man_block_alloc(struct man *m, int line, int pos, enum mant tok)

 {
        struct man_node *p;
 
 {
        struct man_node *p;
 


@@ -312,7 +324,7 @@ pstring(struct man *m, int line, int pos,
        struct man_node *n;
        size_t           sv;
 
        struct man_node *n;
        size_t           sv;
 

-       n = man_node_alloc(line, pos, MAN_TEXT, -1);
+       n = man_node_alloc(line, pos, MAN_TEXT, MAN_MAX);

        n->string = mandoc_malloc(len + 1);
        sv = strlcpy(n->string, p, len + 1);
 
        n->string = mandoc_malloc(len + 1);
        sv = strlcpy(n->string, p, len + 1);
 


@@ -334,30 +346,29 @@ man_word_alloc(struct man *m, int line, int pos, const char *word)
 }
 
 
 }
 
 

-void
+/*
+ * Free all of the resources held by a node.  This does NOT unlink a
+ * node from its context; for that, see man_node_unlink().
+ */
+static void

 man_node_free(struct man_node *p)
 {
 
        if (p->string)
                free(p->string);
 man_node_free(struct man_node *p)
 {
 
        if (p->string)
                free(p->string);

-       if (p->parent)
-               p->parent->nchild--;

        free(p);
 }
 
 
 void
        free(p);
 }
 
 
 void

-man_node_freelist(struct man_node *p)
+man_node_delete(struct man *m, struct man_node *p)

 {
 {

-       struct man_node *n;

 
 

-       if (p->child)
-               man_node_freelist(p->child);
-       assert(0 == p->nchild);
-       n = p->next;
+       while (p->child)
+               man_node_delete(m, p->child);
+
+       man_node_unlink(m, p);

        man_node_free(p);
        man_node_free(p);

-       if (n)
-               man_node_freelist(n);

 }
 
 
 }
 
 


@@ -365,6 +376,7 @@ static int
 man_ptext(struct man *m, int line, char *buf)
 {
        int              i, j;
 man_ptext(struct man *m, int line, char *buf)
 {
        int              i, j;

+       char             sv;

 
        /* Literal free-form text whitespace is preserved. */
 
 
        /* Literal free-form text whitespace is preserved. */
 


@@ -378,7 +390,12 @@ man_ptext(struct man *m, int line, char *buf)
 
        for (i = 0; ' ' == buf[i]; i++)
                /* Skip leading whitespace. */ ;
 
        for (i = 0; ' ' == buf[i]; i++)
                /* Skip leading whitespace. */ ;

-       if (0 == buf[i]) {
+
+       if ('\0' == buf[i]) {
+               /* Trailing whitespace? */
+               if (i && ' ' == buf[i - 1])
+                       if ( ! man_pwarn(m, line, i - 1, WTSPACE))
+                               return(0);

                if ( ! pstring(m, line, 0, &buf[i], 0))
                        return(0);
                goto descope;
                if ( ! pstring(m, line, 0, &buf[i], 0))
                        return(0);
                goto descope;


@@ -392,15 +409,30 @@ man_ptext(struct man *m, int line, char *buf)
                if (i && ' ' == buf[i] && '\\' == buf[i - 1])
                        continue;
 
                if (i && ' ' == buf[i] && '\\' == buf[i - 1])
                        continue;
 

-               buf[i++] = 0;
+               sv = buf[i];
+               buf[i++] = '\0';
+

                if ( ! pstring(m, line, j, &buf[j], (size_t)(i - j)))
                        return(0);
 
                if ( ! pstring(m, line, j, &buf[j], (size_t)(i - j)))
                        return(0);
 

+               /* Trailing whitespace?  Check at overwritten byte. */
+
+               if (' ' == sv && '\0' == buf[i])
+                       if ( ! man_pwarn(m, line, i - 1, WTSPACE))
+                               return(0);
+

                for ( ; ' ' == buf[i]; i++)
                        /* Skip trailing whitespace. */ ;
 
                j = i;
                for ( ; ' ' == buf[i]; i++)
                        /* Skip trailing whitespace. */ ;
 
                j = i;

-               if (0 == buf[i])
+
+               /* Trailing whitespace? */
+
+               if (' ' == buf[i - 1] && '\0' == buf[i])
+                       if ( ! man_pwarn(m, line, i - 1, WTSPACE))
+                               return(0);
+
+               if ('\0' == buf[i])

                        break;
        }
 
                        break;
        }
 


@@ -417,7 +449,7 @@ descope:
 
        if (MAN_ELINE & m->flags) {
                m->flags &= ~MAN_ELINE;
 
        if (MAN_ELINE & m->flags) {
                m->flags &= ~MAN_ELINE;

-               if ( ! man_unscope(m, m->last->parent))
+               if ( ! man_unscope(m, m->last->parent, WERRMAX))

                        return(0);
        }
 
                        return(0);
        }
 


@@ -425,7 +457,7 @@ descope:
                return(1);
        m->flags &= ~MAN_BLINE;
 
                return(1);
        m->flags &= ~MAN_BLINE;
 

-       if ( ! man_unscope(m, m->last->parent))
+       if ( ! man_unscope(m, m->last->parent, WERRMAX))

                return(0);
        return(man_body_alloc(m, line, 0, m->last->tok));
 }
                return(0);
        return(man_body_alloc(m, line, 0, m->last->tok));
 }


@@ -446,24 +478,27 @@ macrowarn(struct man *m, int ln, const char *buf)
 int
 man_pmacro(struct man *m, int ln, char *buf)
 {
 int
 man_pmacro(struct man *m, int ln, char *buf)
 {

-       int              i, j, c, ppos, fl;
+       int              i, j, ppos;
+       enum mant        tok;

        char             mac[5];
        struct man_node *n;
 
        /* Comments and empties are quickly ignored. */
 
        char             mac[5];
        struct man_node *n;
 
        /* Comments and empties are quickly ignored. */
 

-       fl = m->flags;
-
-       if (0 == buf[1])
-               goto out;
+       if ('\0' == buf[1])
+               return(1);

 
        i = 1;
 
 
        i = 1;
 

-       if (' ' == buf[i]) {
+       /*
+        * Skip whitespace between the control character and initial
+        * text.  "Whitespace" is both spaces and tabs.
+        */
+       if (' ' == buf[i] || '\t' == buf[i]) {

                i++;
                i++;

-               while (buf[i] && ' ' == buf[i])
+               while (buf[i] && (' ' == buf[i] || '\t' == buf[i]))

                        i++;
                        i++;

-               if (0 == buf[i])
+               if ('\0' == buf[i])

                        goto out;
        }
 
                        goto out;
        }
 


@@ -472,7 +507,7 @@ man_pmacro(struct man *m, int ln, char *buf)
        /* Copy the first word into a nil-terminated buffer. */
 
        for (j = 0; j < 4; j++, i++) {
        /* Copy the first word into a nil-terminated buffer. */
 
        for (j = 0; j < 4; j++, i++) {

-               if (0 == (mac[j] = buf[i]))
+               if ('\0' == (mac[j] = buf[i]))

                        break;
                else if (' ' == buf[i])
                        break;
                        break;
                else if (' ' == buf[i])
                        break;


@@ -484,7 +519,7 @@ man_pmacro(struct man *m, int ln, char *buf)
                return(man_perr(m, ln, i, WNPRINT));
        }
 
                return(man_perr(m, ln, i, WNPRINT));
        }
 

-       mac[j] = 0;
+       mac[j] = '\0';

 
        if (j == 4 || j < 1) {
                if ( ! (MAN_IGN_MACRO & m->pflags)) {
 
        if (j == 4 || j < 1) {
                if ( ! (MAN_IGN_MACRO & m->pflags)) {


@@ -496,7 +531,7 @@ man_pmacro(struct man *m, int ln, char *buf)
                return(1);
        }
        
                return(1);
        }
        

-       if (MAN_MAX == (c = man_hash_find(mac))) {
+       if (MAN_MAX == (tok = man_hash_find(mac))) {

                if ( ! macrowarn(m, ln, mac))
                        goto err;
                return(1);
                if ( ! macrowarn(m, ln, mac))
                        goto err;
                return(1);


@@ -507,42 +542,86 @@ man_pmacro(struct man *m, int ln, char *buf)
        while (buf[i] && ' ' == buf[i])
                i++;
 
        while (buf[i] && ' ' == buf[i])
                i++;
 

-       /* Remove prior ELINE macro, if applicable. */
+       /* Trailing whitespace? */
+
+       if ('\0' == buf[i] && ' ' == buf[i - 1])
+               if ( ! man_pwarn(m, ln, i - 1, WTSPACE))
+                       goto err;
+
+       /* 
+        * Remove prior ELINE macro, as it's being clobbering by a new
+        * macro.  Note that NSCOPED macros do not close out ELINE
+        * macros---they don't print text---so we let those slip by.
+        * NOTE: we don't allow roff blocks (NOCLOSE) to be embedded
+        * here because that would stipulate blocks as children of
+        * elements!
+        */
+
+       if ( ! (MAN_NSCOPED & man_macros[tok].flags) &&
+                       m->flags & MAN_ELINE) {
+               assert(MAN_TEXT != m->last->type);
+
+               /*
+                * This occurs in the following construction:
+                *   .B
+                *   .br
+                *   .B
+                *   .br
+                *   I hate man macros.
+                * Flat-out disallow this madness.
+                */
+               if (MAN_NSCOPED & man_macros[m->last->tok].flags)
+                       return(man_perr(m, ln, ppos, WLNSCOPE));

 
 

-       if (m->flags & MAN_ELINE) {

                n = m->last;
                n = m->last;

+
+               assert(n);

                assert(NULL == n->child);
                assert(0 == n->nchild);
                assert(NULL == n->child);
                assert(0 == n->nchild);

+

                if ( ! man_nwarn(m, n, WLNSCOPE))
                        return(0);
 
                if ( ! man_nwarn(m, n, WLNSCOPE))
                        return(0);
 

-               if (n->prev) {
-                       assert(n != n->parent->child);
-                       assert(n == n->prev->next);
-                       n->prev->next = NULL;
-                       m->last = n->prev;
-                       m->next = MAN_NEXT_SIBLING;
-               } else {
-                       assert(n == n->parent->child);
-                       n->parent->child = NULL;
-                       m->last = n->parent;
-                       m->next = MAN_NEXT_CHILD;
-               }
-
-               man_node_free(n);
+               man_node_delete(m, n);

                m->flags &= ~MAN_ELINE;
        }
 
                m->flags &= ~MAN_ELINE;
        }
 

-       /* Begin recursive parse sequence. */
+       /*
+        * Save the fact that we're in the next-line for a block.  In
+        * this way, embedded roff instructions can "remember" state
+        * when they exit.
+        */

 
 

-       assert(man_macros[c].fp);
+       if (MAN_BLINE & m->flags)
+               m->flags |= MAN_BPLINE;

 
 

-       if ( ! (*man_macros[c].fp)(m, c, ln, ppos, &i, buf))
+       /* Call to handler... */
+
+       assert(man_macros[tok].fp);
+       if ( ! (*man_macros[tok].fp)(m, tok, ln, ppos, &i, buf))

                goto err;
 
 out:
                goto err;
 
 out:

-       if ( ! (MAN_BLINE & fl))
+       /* 
+        * We weren't in a block-line scope when entering the
+        * above-parsed macro, so return.
+        */
+
+       if ( ! (MAN_BPLINE & m->flags)) {
+               m->flags &= ~MAN_ILINE; 

                return(1);
                return(1);

+       }
+       m->flags &= ~MAN_BPLINE;
+
+       /*
+        * If we're in a block scope, then allow this macro to slip by
+        * without closing scope around it.
+        */
+
+       if (MAN_ILINE & m->flags) {
+               m->flags &= ~MAN_ILINE;
+               return(1);
+       }

 
        /* 
         * If we've opened a new next-line element scope, then return
 
        /* 
         * If we've opened a new next-line element scope, then return


@@ -557,7 +636,7 @@ out:
        assert(MAN_BLINE & m->flags);
        m->flags &= ~MAN_BLINE;
 
        assert(MAN_BLINE & m->flags);
        m->flags &= ~MAN_BLINE;
 

-       if ( ! man_unscope(m, m->last->parent))
+       if ( ! man_unscope(m, m->last->parent, WERRMAX))

                return(0);
        return(man_body_alloc(m, ln, 0, m->last->tok));
 
                return(0);
        return(man_body_alloc(m, ln, 0, m->last->tok));
 


@@ -613,3 +692,45 @@ man_err(struct man *m, int line, int pos, int iserr, enum merr type)
 
        return(man_vwarn(m, line, pos, p));
 }
 
        return(man_vwarn(m, line, pos, p));
 }

+
+
+/*
+ * Unlink a node from its context.  If "m" is provided, the last parse
+ * point will also be adjusted accordingly.
+ */
+static void
+man_node_unlink(struct man *m, struct man_node *n)
+{
+
+       /* Adjust siblings. */
+
+       if (n->prev)
+               n->prev->next = n->next;
+       if (n->next)
+               n->next->prev = n->prev;
+
+       /* Adjust parent. */
+
+       if (n->parent) {
+               n->parent->nchild--;
+               if (n->parent->child == n)
+                       n->parent->child = n->prev ? n->prev : n->next;
+       }
+
+       /* Adjust parse point, if applicable. */
+
+       if (m && m->last == n) {
+               /*XXX: this can occur when bailing from validation. */
+               /*assert(NULL == n->next);*/
+               if (n->prev) {
+                       m->last = n->prev;
+                       m->next = MAN_NEXT_SIBLING;
+               } else {
+                       m->last = n->parent;
+                       m->next = MAN_NEXT_CHILD;
+               }
+       }
+
+       if (m && m->first == n)
+               m->first = NULL;
+}