Clarified EXIT STATUS sections. Discussed among schwarze@, Thomas, and

[mandoc.git] / mdoc.c

diff --git a/mdoc.c b/mdoc.c
index 6d2334a61998c983201d7dd8265f664530e274c2..bee01503f341021bd6e8b3825ecb91ba237c1358 100644 (file)
--- a/mdoc.c
+++ b/mdoc.c
@@ -1,6 +1,7 @@
-/*     $Id: mdoc.c,v 1.150 2010/06/27 16:18:13 kristaps Exp $ */
+/*     $Id: mdoc.c,v 1.164 2010/08/29 11:29:51 kristaps Exp $ */

 /*
 /*

- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>

  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above


@@ -21,7 +22,6 @@
 #include <sys/types.h>
 
 #include <assert.h>
 #include <sys/types.h>
 
 #include <assert.h>

-#include <ctype.h>

 #include <stdarg.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <stdarg.h>
 #include <stdio.h>
 #include <stdlib.h>


@@ -29,7 +29,6 @@
 #include <time.h>
 
 #include "mandoc.h"
 #include <time.h>
 
 #include "mandoc.h"

-#include "regs.h"

 #include "libmdoc.h"
 #include "libmandoc.h"
 
 #include "libmdoc.h"
 #include "libmandoc.h"
 


@@ -99,8 +98,6 @@ static        int               node_append(struct mdoc *,
                                struct mdoc_node *);
 static int               mdoc_ptext(struct mdoc *, int, char *, int);
 static int               mdoc_pmacro(struct mdoc *, int, char *, int);
                                struct mdoc_node *);
 static int               mdoc_ptext(struct mdoc *, int, char *, int);
 static int               mdoc_pmacro(struct mdoc *, int, char *, int);

-static int               macrowarn(struct mdoc *, int, 
-                               const char *, int);

 
 
 const struct mdoc_node *
 
 
 const struct mdoc_node *


@@ -192,8 +189,7 @@ mdoc_free(struct mdoc *mdoc)
  * Allocate volatile and non-volatile parse resources.  
  */
 struct mdoc *
  * Allocate volatile and non-volatile parse resources.  
  */
 struct mdoc *

-mdoc_alloc(struct regset *regs, void *data, 
-               int pflags, mandocmsg msg)
+mdoc_alloc(struct regset *regs, void *data, mandocmsg msg)

 {
        struct mdoc     *p;
 
 {
        struct mdoc     *p;
 


@@ -201,7 +197,6 @@ mdoc_alloc(struct regset *regs, void *data,
 
        p->msg = msg;
        p->data = data;
 
        p->msg = msg;
        p->data = data;

-       p->pflags = pflags;

        p->regs = regs;
 
        mdoc_hash_init();
        p->regs = regs;
 
        mdoc_hash_init();


@@ -239,6 +234,20 @@ mdoc_parseln(struct mdoc *m, int ln, char *buf, int offs)
                return(0);
 
        m->flags |= MDOC_NEWLINE;
                return(0);
 
        m->flags |= MDOC_NEWLINE;

+
+       /*
+        * Let the roff nS register switch SYNOPSIS mode early,
+        * such that the parser knows at all times
+        * whether this mode is on or off.
+        * Note that this mode is also switched by the Sh macro.
+        */
+       if (m->regs->regs[(int)REG_nS].set) {
+               if (m->regs->regs[(int)REG_nS].v.u)
+                       m->flags |= MDOC_SYNOPSIS;
+               else
+                       m->flags &= ~MDOC_SYNOPSIS;
+       }
+

        return(('.' == buf[offs] || '\'' == buf[offs]) ? 
                        mdoc_pmacro(m, ln, buf, offs) :
                        mdoc_ptext(m, ln, buf, offs));
        return(('.' == buf[offs] || '\'' == buf[offs]) ? 
                        mdoc_pmacro(m, ln, buf, offs) :
                        mdoc_ptext(m, ln, buf, offs));


@@ -332,6 +341,8 @@ node_append(struct mdoc *mdoc, struct mdoc_node *p)
                p->parent->tail = p;
                break;
        case (MDOC_BODY):
                p->parent->tail = p;
                break;
        case (MDOC_BODY):

+               if (p->end)
+                       break;

                assert(MDOC_BLOCK == p->parent->type);
                p->parent->body = p;
                break;
                assert(MDOC_BLOCK == p->parent->type);
                p->parent->body = p;
                break;


@@ -371,15 +382,14 @@ node_alloc(struct mdoc *m, int line, int pos,
 
        /* Flag analysis. */
 
 
        /* Flag analysis. */
 

+       if (MDOC_SYNOPSIS & m->flags)
+               p->flags |= MDOC_SYNPRETTY;
+       else
+               p->flags &= ~MDOC_SYNPRETTY;

        if (MDOC_NEWLINE & m->flags)
                p->flags |= MDOC_LINE;
        m->flags &= ~MDOC_NEWLINE;
 
        if (MDOC_NEWLINE & m->flags)
                p->flags |= MDOC_LINE;
        m->flags &= ~MDOC_NEWLINE;
 

-       /* Section analysis. */
-
-       if (SEC_SYNOPSIS == p->sec)
-               p->flags |= MDOC_SYNPRETTY;
-

        return(p);
 }
 
        return(p);
 }
 


@@ -426,6 +436,22 @@ mdoc_body_alloc(struct mdoc *m, int line, int pos, enum mdoct tok)
 }
 
 
 }
 
 

+int
+mdoc_endbody_alloc(struct mdoc *m, int line, int pos, enum mdoct tok,
+               struct mdoc_node *body, enum mdoc_endbody end)
+{
+       struct mdoc_node *p;
+
+       p = node_alloc(m, line, pos, tok, MDOC_BODY);
+       p->pending = body;
+       p->end = end;
+       if ( ! node_append(m, p))
+               return(0);
+       m->next = MDOC_NEXT_SIBLING;
+       return(1);
+}
+
+

 int
 mdoc_block_alloc(struct mdoc *m, int line, int pos, 
                enum mdoct tok, struct mdoc_arg *args)
 int
 mdoc_block_alloc(struct mdoc *m, int line, int pos, 
                enum mdoct tok, struct mdoc_arg *args)


@@ -483,10 +509,26 @@ mdoc_word_alloc(struct mdoc *m, int line, int pos, const char *p)
 }
 
 
 }
 
 

-void
+static void

 mdoc_node_free(struct mdoc_node *p)
 {
 
 mdoc_node_free(struct mdoc_node *p)
 {
 

+       /*
+        * XXX: if these end up being problematic in terms of memory
+        * management and dereferencing freed blocks, then make them
+        * into reference-counted double-pointers.
+        */
+
+       if (MDOC_Bd == p->tok && MDOC_BLOCK == p->type)
+               if (p->data.Bd)
+                       free(p->data.Bd);
+       if (MDOC_Bl == p->tok && MDOC_BLOCK == p->type)
+               if (p->data.Bl)
+                       free(p->data.Bl);
+       if (MDOC_Bf == p->tok && MDOC_HEAD == p->type)
+               if (p->data.Bf)
+                       free(p->data.Bf);
+

        if (p->string)
                free(p->string);
        if (p->args)
        if (p->string)
                free(p->string);
        if (p->args)


@@ -579,7 +621,7 @@ mdoc_ptext(struct mdoc *m, int line, char *buf, int offs)
         */
 
        if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
         */
 
        if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&

-                       LIST_column == n->data.Bl.type) {
+                       LIST_column == n->data.Bl->type) {

                /* `Bl' is open without any children. */
                m->flags |= MDOC_FREECOL;
                return(mdoc_macro(m, MDOC_It, line, offs, &offs, buf));
                /* `Bl' is open without any children. */
                m->flags |= MDOC_FREECOL;
                return(mdoc_macro(m, MDOC_It, line, offs, &offs, buf));


@@ -588,7 +630,7 @@ mdoc_ptext(struct mdoc *m, int line, char *buf, int offs)
        if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
                        NULL != n->parent &&
                        MDOC_Bl == n->parent->tok &&
        if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
                        NULL != n->parent &&
                        MDOC_Bl == n->parent->tok &&

-                       LIST_column == n->parent->data.Bl.type) {
+                       LIST_column == n->parent->data.Bl->type) {

                /* `Bl' has block-level `It' children. */
                m->flags |= MDOC_FREECOL;
                return(mdoc_macro(m, MDOC_It, line, offs, &offs, buf));
                /* `Bl' has block-level `It' children. */
                m->flags |= MDOC_FREECOL;
                return(mdoc_macro(m, MDOC_It, line, offs, &offs, buf));


@@ -674,33 +716,18 @@ mdoc_ptext(struct mdoc *m, int line, char *buf, int offs)
 
        assert(buf < end);
 
 
        assert(buf < end);
 

-       if (mandoc_eos(buf+offs, (size_t)(end-buf-offs)))
+       if (mandoc_eos(buf+offs, (size_t)(end-buf-offs), 0))

                m->last->flags |= MDOC_EOS;
 
        return(1);
 }
 
 
                m->last->flags |= MDOC_EOS;
 
        return(1);
 }
 
 

-static int
-macrowarn(struct mdoc *m, int ln, const char *buf, int offs)
-{
-       int              rc;
-
-       rc = mdoc_vmsg(m, MANDOCERR_MACRO, ln, offs, 
-                       "unknown macro: %s%s", 
-                       buf, strlen(buf) > 3 ? "..." : "");
-
-       /* FIXME: logic should be in driver. */
-       /* FIXME: broken, will error out and not omit a message. */
-       return(MDOC_IGN_MACRO & m->pflags ? rc : 0);
-}
-
-

 /*
  * Parse a macro line, that is, a line beginning with the control
  * character.
  */
 /*
  * Parse a macro line, that is, a line beginning with the control
  * character.
  */

-int
+static int

 mdoc_pmacro(struct mdoc *m, int ln, char *buf, int offs)
 {
        enum mdoct        tok;
 mdoc_pmacro(struct mdoc *m, int ln, char *buf, int offs)
 {
        enum mdoct        tok;


@@ -717,11 +744,11 @@ mdoc_pmacro(struct mdoc *m, int ln, char *buf, int offs)
 
        i = offs;
 
 
        i = offs;
 

-       /* Accept whitespace after the initial control char. */
+       /* Accept tabs/whitespace after the initial control char. */

 
 

-       if (' ' == buf[i]) {
+       if (' ' == buf[i] || '\t' == buf[i]) {

                i++;
                i++;

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

                        i++;
                if ('\0' == buf[i])
                        return(1);
                        i++;
                if ('\0' == buf[i])
                        return(1);


@@ -729,38 +756,33 @@ mdoc_pmacro(struct mdoc *m, int ln, char *buf, int offs)
 
        sv = i;
 
 
        sv = i;
 

-       /* Copy the first word into a nil-terminated buffer. */
-
-       for (j = 0; j < 4; j++, i++) {
-               if ('\0' == (mac[j] = buf[i]))
-                       break;
-               else if (' ' == buf[i])
-                       break;
-
-               /* Check for invalid characters. */
-
-               if (isgraph((u_char)buf[i]))
-                       continue;
-               if ( ! mdoc_pmsg(m, ln, i, MANDOCERR_BADCHAR))
-                       return(0);
-               i--;
-       }
+       /* 
+        * Copy the first word into a nil-terminated buffer.
+        * Stop copying when a tab, space, backslash, or eoln is encountered.
+        */

 
 

+       j = 0;
+       while (j < 4 && '\0' != buf[i] && 
+                       ' ' != buf[i] && 
+                       '\t' != buf[i] && 
+                       '\\' != buf[i])
+               mac[j++] = buf[i++];

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

-       if (j == 4 || j < 2) {
-               if ( ! macrowarn(m, ln, mac, sv))
-                       goto err;
-               return(1);
-       } 
-       
-       if (MDOC_MAX == (tok = mdoc_hash_find(mac))) {
-               if ( ! macrowarn(m, ln, mac, sv))
-                       goto err;
+       tok = (j > 1 || j < 4) ? mdoc_hash_find(mac) : MDOC_MAX;
+       if (MDOC_MAX == tok) {
+               mdoc_vmsg(m, MANDOCERR_MACRO, ln, sv, 
+                   "unknown macro: %s%s", 
+                   buf, strlen(buf) > 3 ? "..." : "");

                return(1);
        }
 
                return(1);
        }
 

-       /* The macro is sane.  Jump to the next word. */
+       /* Disregard the first trailing tab, if applicable. */
+
+       if ('\t' == buf[i])
+               i++;
+
+       /* Jump to the next non-whitespace word. */

 
        while (buf[i] && ' ' == buf[i])
                i++;
 
        while (buf[i] && ' ' == buf[i])
                i++;


@@ -794,7 +816,7 @@ mdoc_pmacro(struct mdoc *m, int ln, char *buf, int offs)
         */
 
        if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
         */
 
        if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&

-                       LIST_column == n->data.Bl.type) {
+                       LIST_column == n->data.Bl->type) {

                m->flags |= MDOC_FREECOL;
                if ( ! mdoc_macro(m, MDOC_It, ln, sv, &sv, buf))
                        goto err;
                m->flags |= MDOC_FREECOL;
                if ( ! mdoc_macro(m, MDOC_It, ln, sv, &sv, buf))
                        goto err;


@@ -810,7 +832,7 @@ mdoc_pmacro(struct mdoc *m, int ln, char *buf, int offs)
        if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
                        NULL != n->parent &&
                        MDOC_Bl == n->parent->tok &&
        if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
                        NULL != n->parent &&
                        MDOC_Bl == n->parent->tok &&

-                       LIST_column == n->parent->data.Bl.type) {
+                       LIST_column == n->parent->data.Bl->type) {

                m->flags |= MDOC_FREECOL;
                if ( ! mdoc_macro(m, MDOC_It, ln, sv, &sv, buf)) 
                        goto err;
                m->flags |= MDOC_FREECOL;
                if ( ! mdoc_macro(m, MDOC_It, ln, sv, &sv, buf)) 
                        goto err;