]> git.cameronkatri.com Git - mandoc.git/blobdiff - man.c
Allow roff_parseln() to be re-run.
[mandoc.git] / man.c
diff --git a/man.c b/man.c
index 1d258836eaee191b1f9d81afe1fcdd9bfa582132..975a82f8554952ffd3d1a3f01752698751ca7217 100644 (file)
--- a/man.c
+++ b/man.c
@@ -1,4 +1,4 @@
-/*     $Id: man.c,v 1.58 2010/03/29 04:52:14 kristaps Exp $ */
+/*     $Id: man.c,v 1.72 2010/05/16 10:59:36 kristaps Exp $ */
 /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
  *
@@ -32,7 +32,6 @@
 
 const  char *const __man_merrnames[WERRMAX] = {                 
        "invalid character", /* WNPRINT */
-       "invalid manual section", /* WMSEC */
        "invalid date format", /* WDATE */
        "scope of prior line violated", /* WLNSCOPE */
        "over-zealous prior line scope violation", /* WLNSCOPE2 */
@@ -50,9 +49,8 @@ const char *const __man_merrnames[WERRMAX] = {
        "no scope context", /* WNOSCOPE */
        "literal context already open", /* WOLITERAL */
        "no literal context open", /* WNLITERAL */
-       "invalid nesting of roff declarations", /* WROFFNEST */
-       "scope in roff instructions broken", /* WROFFSCOPE */
        "document title should be uppercase", /* WTITLECASE */
+       "deprecated comment style", /* WBADCOMMENT */
 };
 
 const  char *const __man_macronames[MAN_MAX] = {                
@@ -64,9 +62,7 @@ const char *const __man_macronames[MAN_MAX] = {
        "RI",           "na",           "i",            "sp",
        "nf",           "fi",           "r",            "RE",
        "RS",           "DT",           "UC",           "PD",
-       "Sp",           "Vb",           "Ve",           "de",
-       "dei",          "am",           "ami",          "ig",
-       ".",
+       "Sp",           "Vb",           "Ve",
        };
 
 const  char * const *man_macronames = __man_macronames;
@@ -78,13 +74,11 @@ static      int              man_node_append(struct man *,
 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 int              man_ptext(struct man *, int, char *, int);
+static int              man_pmacro(struct man *, int, char *, int);
 static void             man_free1(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 *);
+static int              macrowarn(struct man *, int, const char *, int);
 
 
 const struct man_node *
@@ -154,12 +148,15 @@ man_endparse(struct man *m)
 
 
 int
-man_parseln(struct man *m, int ln, char *buf)
+man_parseln(struct man *m, int ln, char *buf, int offs)
 {
 
-       return('.' == *buf || '\'' == *buf ? 
-                       man_pmacro(m, ln, buf) : 
-                       man_ptext(m, ln, buf));
+       if (MAN_HALT & m->flags)
+               return(0);
+
+       return(('.' == buf[offs] || '\'' == buf[offs]) ? 
+                       man_pmacro(m, ln, buf, offs) : 
+                       man_ptext(m, ln, buf, offs));
 }
 
 
@@ -175,6 +172,8 @@ man_free1(struct man *man)
                free(man->meta.source);
        if (man->meta.vol)
                free(man->meta.vol);
+       if (man->meta.msec)
+               free(man->meta.msec);
 }
 
 
@@ -317,35 +316,29 @@ man_block_alloc(struct man *m, int line, int pos, enum mant tok)
 }
 
 
-static int
-pstring(struct man *m, int line, int pos, 
-               const char *p, size_t len)
+int
+man_word_alloc(struct man *m, int line, int pos, const char *word)
 {
        struct man_node *n;
-       size_t           sv;
+       size_t           sv, len;
+
+       len = strlen(word);
 
        n = man_node_alloc(line, pos, MAN_TEXT, MAN_MAX);
        n->string = mandoc_malloc(len + 1);
-       sv = strlcpy(n->string, p, len + 1);
+       sv = strlcpy(n->string, word, len + 1);
 
        /* Prohibit truncation. */
        assert(sv < len + 1);
 
        if ( ! man_node_append(m, n))
                return(0);
+
        m->next = MAN_NEXT_SIBLING;
        return(1);
 }
 
 
-int
-man_word_alloc(struct man *m, int line, int pos, const char *word)
-{
-
-       return(pstring(m, line, pos, word, strlen(word)));
-}
-
-
 /*
  * Free all of the resources held by a node.  This does NOT unlink a
  * node from its context; for that, see man_node_unlink().
@@ -373,74 +366,73 @@ man_node_delete(struct man *m, struct man_node *p)
 
 
 static int
-man_ptext(struct man *m, int line, char *buf)
+man_ptext(struct man *m, int line, char *buf, int offs)
 {
-       int              i, j;
-       char             sv;
+       int              i;
+
+       /* Ignore bogus comments. */
+
+       if ('\\' == buf[offs] && 
+                       '.' == buf[offs + 1] && 
+                       '"' == buf[offs + 2])
+               return(man_pwarn(m, line, offs, WBADCOMMENT));
 
        /* Literal free-form text whitespace is preserved. */
 
        if (MAN_LITERAL & m->flags) {
-               if ( ! man_word_alloc(m, line, 0, buf))
+               if ( ! man_word_alloc(m, line, offs, buf + offs))
                        return(0);
                goto descope;
        }
 
-       /* First de-chunk and allocate words. */
+       /* Pump blank lines directly into the backend. */
 
-       for (i = 0; ' ' == buf[i]; i++)
+       for (i = offs; ' ' == buf[i]; i++)
                /* Skip leading whitespace. */ ;
 
        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))
+               /* Allocate a blank entry. */
+               if ( ! man_word_alloc(m, line, offs, ""))
                        return(0);
                goto descope;
        }
 
-       for (j = i; buf[i]; i++) {
-               if (' ' != buf[i])
-                       continue;
-
-               /* Escaped whitespace. */
-               if (i && ' ' == buf[i] && '\\' == buf[i - 1])
-                       continue;
-
-               sv = buf[i];
-               buf[i++] = '\0';
-
-               if ( ! pstring(m, line, j, &buf[j], (size_t)(i - j)))
-                       return(0);
+       /* 
+        * Warn if the last un-escaped character is whitespace. Then
+        * strip away the remaining spaces (tabs stay!).   
+        */
 
-               /* Trailing whitespace?  Check at overwritten byte. */
+       i = (int)strlen(buf);
+       assert(i);
 
-               if (' ' == sv && '\0' == buf[i])
+       if (' ' == buf[i - 1] || '\t' == buf[i - 1]) {
+               if (i > 1 && '\\' != buf[i - 2])
                        if ( ! man_pwarn(m, line, i - 1, WTSPACE))
                                return(0);
 
-               for ( ; ' ' == buf[i]; i++)
-                       /* Skip trailing whitespace. */ ;
+               for (--i; i && ' ' == buf[i]; i--)
+                       /* Spin back to non-space. */ ;
 
-               j = i;
+               /* Jump ahead of escaped whitespace. */
+               i += '\\' == buf[i] ? 2 : 1;
 
-               /* Trailing whitespace? */
-
-               if (' ' == buf[i - 1] && '\0' == buf[i])
-                       if ( ! man_pwarn(m, line, i - 1, WTSPACE))
-                               return(0);
-
-               if ('\0' == buf[i])
-                       break;
+               buf[i] = '\0';
        }
 
-       if (j != i && ! pstring(m, line, j, &buf[j], (size_t)(i - j)))
+       if ( ! man_word_alloc(m, line, offs, buf + offs))
                return(0);
 
-descope:
+       /*
+        * End-of-sentence check.  If the last character is an unescaped
+        * EOS character, then flag the node as being the end of a
+        * sentence.  The front-end will know how to interpret this.
+        */
+
+       assert(i);
+       if (mandoc_eos(buf, (size_t)i))
+               m->last->flags |= MAN_EOS;
 
+descope:
        /*
         * Co-ordinate what happens with having a next-line scope open:
         * first close out the element scope (if applicable), then close
@@ -459,24 +451,23 @@ descope:
 
        if ( ! man_unscope(m, m->last->parent, WERRMAX))
                return(0);
-       return(man_body_alloc(m, line, 0, m->last->tok));
+       return(man_body_alloc(m, line, offs, m->last->tok));
 }
 
 
 static int
-macrowarn(struct man *m, int ln, const char *buf)
+macrowarn(struct man *m, int ln, const char *buf, int offs)
 {
        if ( ! (MAN_IGN_MACRO & m->pflags))
-               return(man_verr(m, ln, 0, 
-                               "unknown macro: %s%s", 
+               return(man_verr(m, ln, offs, "unknown macro: %s%s", 
                                buf, strlen(buf) > 3 ? "..." : ""));
-       return(man_vwarn(m, ln, 0, "unknown macro: %s%s",
+       return(man_vwarn(m, ln, offs, "unknown macro: %s%s",
                                buf, strlen(buf) > 3 ? "..." : ""));
 }
 
 
 int
-man_pmacro(struct man *m, int ln, char *buf)
+man_pmacro(struct man *m, int ln, char *buf, int offs)
 {
        int              i, j, ppos;
        enum mant        tok;
@@ -485,18 +476,18 @@ man_pmacro(struct man *m, int ln, char *buf)
 
        /* Comments and empties are quickly ignored. */
 
-       if (MAN_BLINE & m->flags)
-               m->flags |= MAN_BPLINE;
+       offs++;
 
-       if ('\0' == buf[1])
+       if ('\0' == buf[offs])
                return(1);
 
-       i = 1;
+       i = offs;
 
        /*
         * Skip whitespace between the control character and initial
         * text.  "Whitespace" is both spaces and tabs.
         */
+
        if (' ' == buf[i] || '\t' == buf[i]) {
                i++;
                while (buf[i] && (' ' == buf[i] || '\t' == buf[i]))
@@ -535,7 +526,7 @@ man_pmacro(struct man *m, int ln, char *buf)
        }
        
        if (MAN_MAX == (tok = man_hash_find(mac))) {
-               if ( ! macrowarn(m, ln, mac))
+               if ( ! macrowarn(m, ln, mac, ppos))
                        goto err;
                return(1);
        }
@@ -545,7 +536,10 @@ man_pmacro(struct man *m, int ln, char *buf)
        while (buf[i] && ' ' == buf[i])
                i++;
 
-       /* Trailing whitespace? */
+       /* 
+        * Trailing whitespace.  Note that tabs are allowed to be passed
+        * into the parser as "text", so we only warn about spaces here.
+        */
 
        if ('\0' == buf[i] && ' ' == buf[i - 1])
                if ( ! man_pwarn(m, ln, i - 1, WTSPACE))
@@ -586,10 +580,18 @@ man_pmacro(struct man *m, int ln, char *buf)
                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.
+        */
+
+       if (MAN_BLINE & m->flags)
+               m->flags |= MAN_BPLINE;
+
+       /* Call to handler... */
 
        assert(man_macros[tok].fp);
-
        if ( ! (*man_macros[tok].fp)(m, tok, ln, ppos, &i, buf))
                goto err;
 
@@ -597,9 +599,6 @@ out:
        /* 
         * We weren't in a block-line scope when entering the
         * above-parsed macro, so return.
-        *
-        * FIXME: this prohibits the nesting of blocks (e.g., `de' and
-        * family) within BLINE or ELINE systems.  This is annoying.
         */
 
        if ( ! (MAN_BPLINE & m->flags)) {
@@ -633,7 +632,7 @@ out:
 
        if ( ! man_unscope(m, m->last->parent, WERRMAX))
                return(0);
-       return(man_body_alloc(m, ln, 0, m->last->tok));
+       return(man_body_alloc(m, ln, offs, m->last->tok));
 
 err:   /* Error out. */