]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc.c
Lint fixes (type-safety for enums via -cefuh).
[mandoc.git] / mdoc.c
diff --git a/mdoc.c b/mdoc.c
index e0d63fed8b2a0ffe421e9b3862ca0d29f826d182..5974c19b9a80c63d08c3fd0b461138a06e76b519 100644 (file)
--- a/mdoc.c
+++ b/mdoc.c
@@ -1,4 +1,4 @@
-/*     $Id: mdoc.c,v 1.121 2010/04/06 11:33:00 kristaps Exp $ */
+/*     $Id: mdoc.c,v 1.125 2010/05/08 07:30:19 kristaps Exp $ */
 /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
  *
@@ -84,6 +84,7 @@ const char *const __mdoc_merrnames[MERRMAX] = {
        "no description found for library", /* ELIB */
        "bad child for parent context", /* EBADCHILD */
        "list arguments preceding type", /* ENOTYPE */
+       "deprecated comment style", /* EBADCOMMENT */
 };
 
 const  char *const __mdoc_macronames[MDOC_MAX] = {              
@@ -150,11 +151,10 @@ static    struct mdoc_node *node_alloc(struct mdoc *, int, int,
                                enum mdoct, enum mdoc_type);
 static int               node_append(struct mdoc *, 
                                struct mdoc_node *);
-static int               parsetext(struct mdoc *, int, char *);
-static int               parsemacro(struct mdoc *, int, char *);
+static int               mdoc_ptext(struct mdoc *, int, char *);
+static int               mdoc_pmacro(struct mdoc *, int, char *);
 static int               macrowarn(struct mdoc *, int, const char *);
-static int               pstring(struct mdoc *, int, int, 
-                               const char *, size_t);
+
 
 const struct mdoc_node *
 mdoc_node(const struct mdoc *m)
@@ -280,7 +280,7 @@ mdoc_endparse(struct mdoc *m)
 
 /*
  * Main parse routine.  Parses a single line -- really just hands off to
- * the macro (parsemacro()) or text parser (parsetext()).
+ * the macro (mdoc_pmacro()) or text parser (mdoc_ptext()).
  */
 int
 mdoc_parseln(struct mdoc *m, int ln, char *buf)
@@ -289,8 +289,8 @@ mdoc_parseln(struct mdoc *m, int ln, char *buf)
        if (MDOC_HALT & m->flags)
                return(0);
 
-       return('.' == *buf ? parsemacro(m, ln, buf) :
-                       parsetext(m, ln, buf));
+       return('.' == *buf ? mdoc_pmacro(m, ln, buf) :
+                       mdoc_ptext(m, ln, buf));
 }
 
 
@@ -348,19 +348,20 @@ int
 mdoc_macro(struct mdoc *m, enum mdoct tok, 
                int ln, int pp, int *pos, char *buf)
 {
-
        assert(tok < MDOC_MAX);
-       /*
-        * If we're in the prologue, deny "body" macros.  Similarly, if
-        * we're in the body, deny prologue calls.
-        */
+
+       /* If we're in the body, deny prologue calls. */
+
        if (MDOC_PROLOGUE & mdoc_macros[tok].flags && 
-                       MDOC_PBODY & m->flags) {
+                       MDOC_PBODY & m->flags)
+               return(mdoc_perr(m, ln, pp, EPROLBODY));
+
+       /* If we're in the prologue, deny "body" macros.  */
+
+       if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) && 
+                       ! (MDOC_PBODY & m->flags)) {
                if ( ! mdoc_pwarn(m, ln, pp, EBODYPROL))
                        return(0);
-               /*
-                * FIXME: do this in mdoc_action.c.
-                */
                if (NULL == m->meta.title)
                        m->meta.title = mandoc_strdup("unknown");
                if (NULL == m->meta.vol)
@@ -371,9 +372,6 @@ mdoc_macro(struct mdoc *m, enum mdoct tok,
                        m->meta.date = time(NULL);
                m->flags |= MDOC_PBODY;
        }
-       if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) && 
-                       ! (MDOC_PBODY & m->flags))
-               return(mdoc_perr(m, ln, pp, EBODYPROL));
 
        return((*mdoc_macros[tok].fp)(m, tok, ln, pp, pos, buf));
 }
@@ -536,13 +534,15 @@ mdoc_elem_alloc(struct mdoc *m, int line, int pos,
 }
 
 
-static int
-pstring(struct mdoc *m, int line, int pos, const char *p, size_t len)
+int
+mdoc_word_alloc(struct mdoc *m, int line, int pos, const char *p)
 {
        struct mdoc_node *n;
-       size_t            sv;
+       size_t            sv, len;
 
-       n = node_alloc(m, line, pos, -1, MDOC_TEXT);
+       len = strlen(p);
+
+       n = node_alloc(m, line, pos, MDOC_MAX, MDOC_TEXT);
        n->string = mandoc_malloc(len + 1);
        sv = strlcpy(n->string, p, len + 1);
 
@@ -551,19 +551,12 @@ pstring(struct mdoc *m, int line, int pos, const char *p, size_t len)
 
        if ( ! node_append(m, n))
                return(0);
+
        m->next = MDOC_NEXT_SIBLING;
        return(1);
 }
 
 
-int
-mdoc_word_alloc(struct mdoc *m, int line, int pos, const char *p)
-{
-
-       return(pstring(m, line, pos, p, strlen(p)));
-}
-
-
 void
 mdoc_node_free(struct mdoc_node *p)
 {
@@ -632,95 +625,67 @@ mdoc_node_delete(struct mdoc *m, struct mdoc_node *p)
  * control character.
  */
 static int
-parsetext(struct mdoc *m, int line, char *buf)
+mdoc_ptext(struct mdoc *m, int line, char *buf)
 {
-       int              i, j;
-       char             sv;
+       int              i;
+
+       /* Ignore bogus comments. */
+
+       if ('\\' == buf[0] && '.' == buf[1] && '\"' == buf[2])
+               return(mdoc_pwarn(m, line, 0, EBADCOMMENT));
+
+       /* No text before an initial macro. */
 
        if (SEC_NONE == m->lastnamed)
                return(mdoc_perr(m, line, 0, ETEXTPROL));
-       
-       /*
-        * If in literal mode, then pass the buffer directly to the
-        * back-end, as it should be preserved as a single term.
-        */
 
+       /* Literal just gets pulled in as-is. */
+       
        if (MDOC_LITERAL & m->flags)
                return(mdoc_word_alloc(m, line, 0, buf));
 
-       /* Disallow blank/white-space lines in non-literal mode. */
+       /* Check for a blank line, which may also consist of spaces. */
 
        for (i = 0; ' ' == buf[i]; i++)
-               /* Skip leading whitespace. */ ;
+               /* Skip to first non-space. */ ;
 
        if ('\0' == buf[i]) {
                if ( ! mdoc_pwarn(m, line, 0, ENOBLANK))
                        return(0);
+
                /*
-                * Assume that a `Pp' should be inserted in the case of
-                * a blank line.  Technically, blank lines aren't
-                * allowed, but enough manuals assume this behaviour
-                * that we want to work around it.
+                * Insert a `Pp' in the case of a blank line.  Technically,
+                * blank lines aren't allowed, but enough manuals assume this
+                * behaviour that we want to work around it.
                 */
                if ( ! mdoc_elem_alloc(m, line, 0, MDOC_Pp, NULL))
                        return(0);
-       }
-
-       /*
-        * Break apart a free-form line into tokens.  Spaces are
-        * stripped out of the input.
-        */
-
-       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);
-
-               /* Trailing whitespace?  Check at overwritten byte. */
-
-               if (' ' == sv && '\0' == buf[i])
-                       if ( ! mdoc_pwarn(m, line, i - 1, ETAILWS))
-                               return(0);
 
-               for ( ; ' ' == buf[i]; i++)
-                       /* Skip trailing whitespace. */ ;
+               m->next = MDOC_NEXT_SIBLING;
+               return(1);
+       }
 
-               j = i;
+       /* Warn if the last un-escaped character is whitespace. */
 
-               /* Trailing whitespace? */
+       i = (int)strlen(buf);
+       assert(i);
 
-               if (' ' == buf[i - 1] && '\0' == buf[i])
+       if (' ' == buf[i - 1] || '\t' == buf[i - 1])
+               if (1 == i || ('\\' != buf[i - 2]))
                        if ( ! mdoc_pwarn(m, line, i - 1, ETAILWS))
                                return(0);
 
-               if ('\0' == buf[i])
-                       break;
-       }
-
-       if (j != i && ! pstring(m, line, j, &buf[j], (size_t)(i - j)))
-               return(0);
+       /* Allocate the whole word. */
 
-       m->next = MDOC_NEXT_SIBLING;
-       return(1);
+       return(mdoc_word_alloc(m, line, 0, buf));
 }
 
 
-
 static int
 macrowarn(struct mdoc *m, int ln, const char *buf)
 {
        if ( ! (MDOC_IGN_MACRO & m->pflags))
-               return(mdoc_verr(m, ln, 0, 
-                               "unknown macro: %s%s", 
+               return(mdoc_verr(m, ln, 0, "unknown macro: %s%s", 
                                buf, strlen(buf) > 3 ? "..." : ""));
        return(mdoc_vwarn(m, ln, 0, "unknown macro: %s%s",
                                buf, strlen(buf) > 3 ? "..." : ""));
@@ -732,10 +697,11 @@ macrowarn(struct mdoc *m, int ln, const char *buf)
  * character.
  */
 int
-parsemacro(struct mdoc *m, int ln, char *buf)
+mdoc_pmacro(struct mdoc *m, int ln, char *buf)
 {
-       int               i, j, c;
-       char              mac[5];
+       enum mdoct      tok;
+       int             i, j;
+       char            mac[5];
 
        /* Empty lines are ignored. */
 
@@ -777,7 +743,7 @@ parsemacro(struct mdoc *m, int ln, char *buf)
                return(1);
        } 
        
-       if (MDOC_MAX == (c = mdoc_hash_find(mac))) {
+       if (MDOC_MAX == (tok = mdoc_hash_find(mac))) {
                if ( ! macrowarn(m, ln, mac))
                        goto err;
                return(1);
@@ -788,7 +754,10 @@ parsemacro(struct mdoc *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 ( ! mdoc_pwarn(m, ln, i - 1, ETAILWS))
@@ -798,7 +767,7 @@ parsemacro(struct mdoc *m, int ln, char *buf)
         * Begin recursive parse sequence.  Since we're at the start of
         * the line, we don't need to do callable/parseable checks.
         */
-       if ( ! mdoc_macro(m, c, ln, 1, &i, buf)) 
+       if ( ! mdoc_macro(m, tok, ln, 1, &i, buf)) 
                goto err;
 
        return(1);