]> git.cameronkatri.com Git - mandoc.git/blobdiff - man.c
Clarify -man -T[x]html handling of `br' within `B'.
[mandoc.git] / man.c
diff --git a/man.c b/man.c
index 6336f938ac5621671276c070c7d4e247f3a5f0ff..2aee2cb5e94b5f0a86be47c940137708358a770f 100644 (file)
--- a/man.c
+++ b/man.c
@@ -1,4 +1,4 @@
-/*     $Id: man.c,v 1.43 2009/10/26 07:11:06 kristaps Exp $ */
+/*     $Id: man.c,v 1.51 2010/03/22 14:03:03 kristaps Exp $ */
 /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
  *
  * 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 <string.h>
 
 #include "libman.h"
+#include "libmandoc.h"
 
 const  char *const __man_merrnames[WERRMAX] = {                 
        "invalid character", /* WNPRINT */
-       "system: malloc error", /* WNMEM */
        "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 */
@@ -67,15 +72,11 @@ static      int              man_node_append(struct man *,
 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_alloc1(struct man *);
+static void             man_alloc1(struct man *);
 static int              pstring(struct man *, int, int, 
                                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)
@@ -93,12 +94,12 @@ man_meta(const struct man *m)
 }
 
 
-int
+void
 man_reset(struct man *man)
 {
 
        man_free1(man);
-       return(man_alloc1(man));
+       man_alloc1(man);
 }
 
 
@@ -116,19 +117,16 @@ man_alloc(void *data, int pflags, const struct man_cb *cb)
 {
        struct man      *p;
 
-       if (NULL == (p = calloc(1, sizeof(struct man))))
-               return(NULL);
+       p = mandoc_calloc(1, sizeof(struct man));
 
-       if ( ! man_alloc1(p)) {
-               free(p);
-               return(NULL);
-       }
+       if (cb)
+               memcpy(&p->cb, cb, sizeof(struct man_cb));
 
        man_hash_init();
-
        p->data = data;
        p->pflags = pflags;
-       (void)memcpy(&p->cb, cb, sizeof(struct man_cb));
+
+       man_alloc1(p);
        return(p);
 }
 
@@ -171,19 +169,16 @@ man_free1(struct man *man)
 }
 
 
-static int
+static void
 man_alloc1(struct man *m)
 {
 
-       bzero(&m->meta, sizeof(struct man_meta));
+       memset(&m->meta, 0, sizeof(struct man_meta));
        m->flags = 0;
-       m->last = calloc(1, sizeof(struct man_node));
-       if (NULL == m->last)
-               return(0);
+       m->last = mandoc_calloc(1, sizeof(struct man_node));
        m->first = m->last;
        m->last->type = MAN_ROOT;
        m->next = MAN_NEXT_CHILD;
-       return(1);
 }
 
 
@@ -250,10 +245,7 @@ man_node_alloc(int line, int pos, enum man_type type, int tok)
 {
        struct man_node *p;
 
-       p = calloc(1, sizeof(struct man_node));
-       if (NULL == p)
-               return(NULL);
-
+       p = mandoc_calloc(1, sizeof(struct man_node));
        p->line = line;
        p->pos = pos;
        p->type = type;
@@ -268,8 +260,6 @@ man_elem_alloc(struct man *m, int line, int pos, int tok)
        struct man_node *p;
 
        p = man_node_alloc(line, pos, MAN_ELEM, tok);
-       if (NULL == p)
-               return(0);
        if ( ! man_node_append(m, p))
                return(0);
        m->next = MAN_NEXT_CHILD;
@@ -283,8 +273,6 @@ man_head_alloc(struct man *m, int line, int pos, int tok)
        struct man_node *p;
 
        p = man_node_alloc(line, pos, MAN_HEAD, tok);
-       if (NULL == p)
-               return(0);
        if ( ! man_node_append(m, p))
                return(0);
        m->next = MAN_NEXT_CHILD;
@@ -298,8 +286,6 @@ man_body_alloc(struct man *m, int line, int pos, int tok)
        struct man_node *p;
 
        p = man_node_alloc(line, pos, MAN_BODY, tok);
-       if (NULL == p)
-               return(0);
        if ( ! man_node_append(m, p))
                return(0);
        m->next = MAN_NEXT_CHILD;
@@ -313,8 +299,6 @@ man_block_alloc(struct man *m, int line, int pos, int tok)
        struct man_node *p;
 
        p = man_node_alloc(line, pos, MAN_BLOCK, tok);
-       if (NULL == p)
-               return(0);
        if ( ! man_node_append(m, p))
                return(0);
        m->next = MAN_NEXT_CHILD;
@@ -330,15 +314,7 @@ pstring(struct man *m, int line, int pos,
        size_t           sv;
 
        n = man_node_alloc(line, pos, MAN_TEXT, -1);
-       if (NULL == n)
-               return(0);
-
-       n->string = malloc(len + 1);
-       if (NULL == n->string) {
-               free(n);
-               return(0);
-       }
-
+       n->string = mandoc_malloc(len + 1);
        sv = strlcpy(n->string, p, len + 1);
 
        /* Prohibit truncation. */
@@ -390,6 +366,7 @@ static int
 man_ptext(struct man *m, int line, char *buf)
 {
        int              i, j;
+       char             sv;
 
        /* Literal free-form text whitespace is preserved. */
 
@@ -403,7 +380,12 @@ man_ptext(struct man *m, int line, char *buf)
 
        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;
@@ -417,15 +399,30 @@ man_ptext(struct man *m, int line, char *buf)
                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);
 
+               /* 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;
-               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;
        }
 
@@ -479,8 +476,8 @@ man_pmacro(struct man *m, int ln, char *buf)
 
        fl = m->flags;
 
-       if (0 == buf[1])
-               goto out;
+       if ('\0' == buf[1])
+               return(1);
 
        i = 1;
 
@@ -488,7 +485,7 @@ man_pmacro(struct man *m, int ln, char *buf)
                i++;
                while (buf[i] && ' ' == buf[i])
                        i++;
-               if (0 == buf[i])
+               if ('\0' == buf[i])
                        goto out;
        }
 
@@ -497,7 +494,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++) {
-               if (0 == (mac[j] = buf[i]))
+               if ('\0' == (mac[j] = buf[i]))
                        break;
                else if (' ' == buf[i])
                        break;
@@ -509,7 +506,7 @@ man_pmacro(struct man *m, int ln, char *buf)
                return(man_perr(m, ln, i, WNPRINT));
        }
 
-       mac[j] = 0;
+       mac[j] = '\0';
 
        if (j == 4 || j < 1) {
                if ( ! (MAN_IGN_MACRO & m->pflags)) {
@@ -532,28 +529,44 @@ man_pmacro(struct man *m, int ln, char *buf)
        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.
+        */
+
+       if ( ! (MAN_NSCOPED & man_macros[c].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;
+
+               assert(n);
                assert(NULL == n->child);
                assert(0 == n->nchild);
+
                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_unlink(m, n);
                man_node_free(n);
                m->flags &= ~MAN_ELINE;
        }
@@ -566,8 +579,25 @@ man_pmacro(struct man *m, int ln, char *buf)
                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_BLINE & fl)) {
+               m->flags &= ~MAN_ILINE; 
+               return(1);
+       }
+
+       /*
+        * 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
@@ -638,3 +668,28 @@ man_err(struct man *m, int line, int pos, int iserr, enum merr type)
 
        return(man_vwarn(m, line, pos, p));
 }
+
+
+void
+man_node_unlink(struct man *m, struct man_node *n)
+{
+
+       if (n->prev) {
+               n->prev->next = n->next;
+               if (m->last == n) {
+                       assert(NULL == n->next);
+                       m->last = n->prev;
+                       m->next = MAN_NEXT_SIBLING;
+               }
+       } else {
+               n->parent->child = n->next;
+               if (m->last == n) {
+                       assert(NULL == n->next);
+                       m->last = n->parent;
+                       m->next = MAN_NEXT_CHILD;
+               }
+       }
+
+       if (n->next)
+               n->next->prev = n->prev;
+}