]> git.cameronkatri.com Git - mandoc.git/blobdiff - man.c
Setting maxmargin, too (for completion).
[mandoc.git] / man.c
diff --git a/man.c b/man.c
index edcd44bad3bd5e8b790574fc3f58191220ed5ec7..7a41b1fbedd49c309649a41d4310416b8b925c6e 100644 (file)
--- a/man.c
+++ b/man.c
@@ -1,4 +1,4 @@
-/*     $Id: man.c,v 1.56 2010/03/27 10:21:38 kristaps Exp $ */
+/*     $Id: man.c,v 1.64 2010/05/08 10:25:27 kristaps Exp $ */
 /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
  *
@@ -53,6 +53,7 @@ const char *const __man_merrnames[WERRMAX] = {
        "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] = {                
@@ -82,8 +83,6 @@ static        int              man_ptext(struct man *, int, char *);
 static int              man_pmacro(struct man *, int, char *);
 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 *);
 
 
@@ -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().
@@ -375,8 +368,12 @@ man_node_delete(struct man *m, struct man_node *p)
 static int
 man_ptext(struct man *m, int line, char *buf)
 {
-       int              i, j;
-       char             sv;
+       int              i;
+
+       /* Ignore bogus comments. */
+
+       if ('\\' == buf[0] && '.' == buf[1] && '\"' == buf[2])
+               return(man_pwarn(m, line, 0, WBADCOMMENT));
 
        /* Literal free-form text whitespace is preserved. */
 
@@ -386,61 +383,44 @@ man_ptext(struct man *m, int line, char *buf)
                goto descope;
        }
 
-       /* First de-chunk and allocate words. */
+       /* Pump blank lines directly into the backend. */
 
        for (i = 0; ' ' == 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, 0, ""))
                        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. */ ;
-
-               j = i;
+               for (--i; i && ' ' == buf[i]; i--)
+                       /* Spin back to non-space. */ ;
 
-               /* Trailing whitespace? */
+               /* Jump ahead of escaped whitespace. */
+               i += '\\' == buf[i] ? 2 : 1;
 
-               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, 0, buf))
                return(0);
 
 descope:
-
        /*
         * Co-ordinate what happens with having a next-line scope open:
         * first close out the element scope (if applicable), then close
@@ -467,8 +447,7 @@ static int
 macrowarn(struct man *m, int ln, const char *buf)
 {
        if ( ! (MAN_IGN_MACRO & m->pflags))
-               return(man_verr(m, ln, 0, 
-                               "unknown macro: %s%s", 
+               return(man_verr(m, ln, 0, "unknown macro: %s%s", 
                                buf, strlen(buf) > 3 ? "..." : ""));
        return(man_vwarn(m, ln, 0, "unknown macro: %s%s",
                                buf, strlen(buf) > 3 ? "..." : ""));
@@ -478,15 +457,13 @@ macrowarn(struct man *m, int ln, const char *buf)
 int
 man_pmacro(struct man *m, int ln, char *buf)
 {
-       int              i, j, ppos, fl;
+       int              i, j, ppos;
        enum mant        tok;
        char             mac[5];
        struct man_node *n;
 
        /* Comments and empties are quickly ignored. */
 
-       fl = m->flags;
-
        if ('\0' == buf[1])
                return(1);
 
@@ -496,7 +473,8 @@ man_pmacro(struct man *m, int ln, char *buf)
         * Skip whitespace between the control character and initial
         * text.  "Whitespace" is both spaces and tabs.
         */
-       if (' ' == buf[i]) {
+
+       if (' ' == buf[i] || '\t' == buf[i]) {
                i++;
                while (buf[i] && (' ' == buf[i] || '\t' == buf[i]))
                        i++;
@@ -544,7 +522,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))
@@ -554,6 +535,9 @@ man_pmacro(struct man *m, int ln, char *buf)
         * 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) &&
@@ -585,10 +569,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.
+        */
 
-       assert(man_macros[tok].fp);
+       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;
 
@@ -596,15 +588,13 @@ 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_BLINE & fl)) {
+       if ( ! (MAN_BPLINE & m->flags)) {
                m->flags &= ~MAN_ILINE; 
                return(1);
        }
+       m->flags &= ~MAN_BPLINE;
 
        /*
         * If we're in a block scope, then allow this macro to slip by