Rudimentary implementation of the .it request (input line trap).

[mandoc.git] / mdoc.c

diff --git a/mdoc.c b/mdoc.c
index c6aa83714af7fcd8a10d850723631ed9a4215f57..df68229cfd64e2b5825c84652a6e5f987986cfad 100644 (file)
--- a/mdoc.c
+++ b/mdoc.c
@@ -1,47 +1,40 @@
-/* $Id: mdoc.c,v 1.54 2009/03/08 12:40:27 kristaps Exp $ */
+/*     $Id: mdoc.c,v 1.203 2012/11/17 00:26:33 schwarze Exp $ */

 /*
 /*

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

  *
  * Permission to use, copy, modify, and distribute this software for any
  *
  * Permission to use, copy, modify, and distribute this software for any

- * purpose with or without fee is hereby granted, provided that the
- * above copyright notice and this permission notice appear in all
- * copies.
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.

  *
  *

- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
- * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
- * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
- * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
- * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
- * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- * PERFORMANCE OF THIS SOFTWARE.
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * 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 <assert.h>

-#include <ctype.h>
-#include <err.h>

 #include <stdarg.h>
 #include <stdarg.h>

-#include <stdlib.h>

 #include <stdio.h>
 #include <stdio.h>

+#include <stdlib.h>

 #include <string.h>
 #include <string.h>

+#include <time.h>

 
 

-#include "private.h"
-
-/*
- * Main caller in the libmdoc library.  This begins the parsing routine,
- * handles allocation of data, and so forth.  Most of the "work" is done
- * in macro.c and validate.c.
- */
-
-static struct mdoc_node *mdoc_node_alloc(const struct mdoc *);
-static int               mdoc_node_append(struct mdoc *, 
-                               struct mdoc_node *);
-
-static int               parsetext(struct mdoc *, int, char *);
-static int               parsemacro(struct mdoc *, int, char *);
-
+#include "mdoc.h"
+#include "mandoc.h"
+#include "libmdoc.h"
+#include "libmandoc.h"

 
 const  char *const __mdoc_macronames[MDOC_MAX] = {              
 
 const  char *const __mdoc_macronames[MDOC_MAX] = {              

-       "\\\"",         "Dd",           "Dt",           "Os",
+       "Ap",           "Dd",           "Dt",           "Os",

        "Sh",           "Ss",           "Pp",           "D1",
        "Dl",           "Bd",           "Ed",           "Bl",
        "El",           "It",           "Ad",           "An",
        "Sh",           "Ss",           "Pp",           "D1",
        "Dl",           "Bd",           "Ed",           "Bl",
        "El",           "It",           "Ad",           "An",


@@ -52,11 +45,11 @@ const       char *const __mdoc_macronames[MDOC_MAX] = {
        "Nm",           "Op",           "Ot",           "Pa",
        "Rv",           "St",           "Va",           "Vt",
        /* LINTED */
        "Nm",           "Op",           "Ot",           "Pa",
        "Rv",           "St",           "Va",           "Vt",
        /* LINTED */

-       "Xr",           "\%A",          "\%B",          "\%D",
+       "Xr",           "%A",           "%B",           "%D",

        /* LINTED */
        /* LINTED */

-       "\%I",          "\%J",          "\%N",          "\%O",
+       "%I",           "%J",           "%N",           "%O",

        /* LINTED */
        /* LINTED */

-       "\%P",          "\%R",          "\%T",          "\%V",
+       "%P",           "%R",           "%T",           "%V",

        "Ac",           "Ao",           "Aq",           "At",
        "Bc",           "Bf",           "Bo",           "Bq",
        "Bsx",          "Bx",           "Db",           "Dc",
        "Ac",           "Ao",           "Aq",           "At",
        "Bc",           "Bf",           "Bo",           "Bq",
        "Bsx",          "Bx",           "Db",           "Dc",


@@ -70,7 +63,14 @@ const        char *const __mdoc_macronames[MDOC_MAX] = {
        "Tn",           "Ux",           "Xc",           "Xo",
        "Fo",           "Fc",           "Oo",           "Oc",
        "Bk",           "Ek",           "Bt",           "Hf",
        "Tn",           "Ux",           "Xc",           "Xo",
        "Fo",           "Fc",           "Oo",           "Oc",
        "Bk",           "Ek",           "Bt",           "Hf",

-       "Fr",           "Ud",           "Lb",
+       "Fr",           "Ud",           "Lb",           "Lp",
+       "Lk",           "Mt",           "Brq",          "Bro",
+       /* LINTED */
+       "Brc",          "%C",           "Es",           "En",
+       /* LINTED */
+       "Dx",           "%Q",           "br",           "sp",
+       /* LINTED */
+       "%U",           "Ta"

        };
 
 const  char *const __mdoc_argnames[MDOC_ARG_MAX] = {            
        };
 
 const  char *const __mdoc_argnames[MDOC_ARG_MAX] = {            


@@ -82,17 +82,32 @@ const       char *const __mdoc_argnames[MDOC_ARG_MAX] = {
        "ohang",                "inset",                "column",        
        "width",                "compact",              "std",   
        "filled",               "words",                "emphasis",
        "ohang",                "inset",                "column",        
        "width",                "compact",              "std",   
        "filled",               "words",                "emphasis",

-       "symbolic"
+       "symbolic",             "nested",               "centered"

        };
 
 const  char * const *mdoc_macronames = __mdoc_macronames;
 const  char * const *mdoc_argnames = __mdoc_argnames;
 
        };
 
 const  char * const *mdoc_macronames = __mdoc_macronames;
 const  char * const *mdoc_argnames = __mdoc_argnames;
 

+static void              mdoc_node_free(struct mdoc_node *);
+static void              mdoc_node_unlink(struct mdoc *, 
+                               struct mdoc_node *);
+static void              mdoc_free1(struct mdoc *);
+static void              mdoc_alloc1(struct mdoc *);
+static struct mdoc_node *node_alloc(struct mdoc *, int, int, 
+                               enum mdoct, enum mdoc_type);
+static int               node_append(struct mdoc *, 
+                               struct mdoc_node *);
+#if 0
+static int               mdoc_preptext(struct mdoc *, int, char *, int);
+#endif
+static int               mdoc_ptext(struct mdoc *, int, char *, int);
+static int               mdoc_pmacro(struct mdoc *, int, char *, int);

 
 const struct mdoc_node *
 mdoc_node(const struct mdoc *mdoc)
 {
 
 
 const struct mdoc_node *
 mdoc_node(const struct mdoc *mdoc)
 {
 

+       assert( ! (MDOC_HALT & mdoc->flags));

        return(mdoc->first);
 }
 
        return(mdoc->first);
 }
 


@@ -101,18 +116,20 @@ const struct mdoc_meta *
 mdoc_meta(const struct mdoc *mdoc)
 {
 
 mdoc_meta(const struct mdoc *mdoc)
 {
 

+       assert( ! (MDOC_HALT & mdoc->flags));

        return(&mdoc->meta);
 }
 
 
        return(&mdoc->meta);
 }
 
 

-void
-mdoc_free(struct mdoc *mdoc)
+/*
+ * Frees volatile resources (parse tree, meta-data, fields).
+ */
+static void
+mdoc_free1(struct mdoc *mdoc)

 {
 
        if (mdoc->first)
 {
 
        if (mdoc->first)

-               mdoc_node_freelist(mdoc->first);
-       if (mdoc->htab)
-               mdoc_tokhash_free(mdoc->htab);
+               mdoc_node_delete(mdoc, mdoc->first);

        if (mdoc->meta.title)
                free(mdoc->meta.title);
        if (mdoc->meta.os)
        if (mdoc->meta.title)
                free(mdoc->meta.title);
        if (mdoc->meta.os)


@@ -123,145 +140,211 @@ mdoc_free(struct mdoc *mdoc)
                free(mdoc->meta.arch);
        if (mdoc->meta.vol)
                free(mdoc->meta.vol);
                free(mdoc->meta.arch);
        if (mdoc->meta.vol)
                free(mdoc->meta.vol);

+       if (mdoc->meta.msec)
+               free(mdoc->meta.msec);
+       if (mdoc->meta.date)
+               free(mdoc->meta.date);
+}
+
+
+/*
+ * Allocate all volatile resources (parse tree, meta-data, fields).
+ */
+static void
+mdoc_alloc1(struct mdoc *mdoc)
+{
+
+       memset(&mdoc->meta, 0, sizeof(struct mdoc_meta));
+       mdoc->flags = 0;
+       mdoc->lastnamed = mdoc->lastsec = SEC_NONE;
+       mdoc->last = mandoc_calloc(1, sizeof(struct mdoc_node));
+       mdoc->first = mdoc->last;
+       mdoc->last->type = MDOC_ROOT;
+       mdoc->last->tok = MDOC_MAX;
+       mdoc->next = MDOC_NEXT_CHILD;
+}
+
+
+/*
+ * Free up volatile resources (see mdoc_free1()) then re-initialises the
+ * data with mdoc_alloc1().  After invocation, parse data has been reset
+ * and the parser is ready for re-invocation on a new tree; however,
+ * cross-parse non-volatile data is kept intact.
+ */
+void
+mdoc_reset(struct mdoc *mdoc)
+{
+
+       mdoc_free1(mdoc);
+       mdoc_alloc1(mdoc);
+}

 
 

+
+/*
+ * Completely free up all volatile and non-volatile parse resources.
+ * After invocation, the pointer is no longer usable.
+ */
+void
+mdoc_free(struct mdoc *mdoc)
+{
+
+       mdoc_free1(mdoc);

        free(mdoc);
 }
 
 
        free(mdoc);
 }
 
 

+/*
+ * Allocate volatile and non-volatile parse resources.  
+ */

 struct mdoc *
 struct mdoc *

-mdoc_alloc(void *data, const struct mdoc_cb *cb)
+mdoc_alloc(struct roff *roff, struct mparse *parse, char *defos)

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

-       p = xcalloc(1, sizeof(struct mdoc));
-
-       p->data = data;
-       if (cb)
-               (void)memcpy(&p->cb, cb, sizeof(struct mdoc_cb));
+       p = mandoc_calloc(1, sizeof(struct mdoc));

 
 

-       p->last = xcalloc(1, sizeof(struct mdoc_node));
-       p->last->type = MDOC_ROOT;
-       p->first = p->last;
-
-       p->next = MDOC_NEXT_CHILD;
-       p->htab = mdoc_tokhash_alloc();
+       p->parse = parse;
+       p->defos = defos;
+       p->roff = roff;

 
 

+       mdoc_hash_init();
+       mdoc_alloc1(p);

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

+/*
+ * Climb back up the parse tree, validating open scopes.  Mostly calls
+ * through to macro_end() in macro.c.
+ */

 int
 mdoc_endparse(struct mdoc *mdoc)
 {
 
 int
 mdoc_endparse(struct mdoc *mdoc)
 {
 

-       if (MDOC_HALT & mdoc->flags)
-               return(0);
-       if (NULL == mdoc->first)
+       assert( ! (MDOC_HALT & mdoc->flags));
+       if (mdoc_macroend(mdoc))

                return(1);
                return(1);

-
-       assert(mdoc->last);
-       if ( ! macro_end(mdoc)) {
-               mdoc->flags |= MDOC_HALT;
-               return(0);
-       }
-       return(1);
+       mdoc->flags |= MDOC_HALT;
+       return(0);

 }
 
 }
 

-
-/*
- * Main parse routine.  Parses a single line -- really just hands off to
- * the macro or text parser.
- */

 int
 int

-mdoc_parseln(struct mdoc *m, int ln, char *buf)
+mdoc_addeqn(struct mdoc *mdoc, const struct eqn *ep)

 {
 {

+       struct mdoc_node *n;
+
+       assert( ! (MDOC_HALT & mdoc->flags));
+
+       /* No text before an initial macro. */

 
 

-       /* If in error-mode, then we parse no more. */
+       if (SEC_NONE == mdoc->lastnamed) {
+               mdoc_pmsg(mdoc, ep->ln, ep->pos, MANDOCERR_NOTEXT);
+               return(1);
+       }

 
 

-       if (MDOC_HALT & m->flags)
+       n = node_alloc(mdoc, ep->ln, ep->pos, MDOC_MAX, MDOC_EQN);
+       n->eqn = ep;
+
+       if ( ! node_append(mdoc, n))

                return(0);
 
                return(0);
 

-       return('.' == *buf ? parsemacro(m, ln, buf) :
-                       parsetext(m, ln, buf));
+       mdoc->next = MDOC_NEXT_SIBLING;
+       return(1);

 }
 
 }
 

-
-void
-mdoc_vmsg(struct mdoc *mdoc, int ln, int pos, const char *fmt, ...)
+int
+mdoc_addspan(struct mdoc *mdoc, const struct tbl_span *sp)

 {
 {

-       char              buf[256];
-       va_list           ap;
+       struct mdoc_node *n;

 
 

-       if (NULL == mdoc->cb.mdoc_msg)
-               return;
+       assert( ! (MDOC_HALT & mdoc->flags));

 
 

-       va_start(ap, fmt);
-       (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
-       va_end(ap);
-       (*mdoc->cb.mdoc_msg)(mdoc->data, ln, pos, buf);
-}
+       /* No text before an initial macro. */

 
 

+       if (SEC_NONE == mdoc->lastnamed) {
+               mdoc_pmsg(mdoc, sp->line, 0, MANDOCERR_NOTEXT);
+               return(1);
+       }

 
 

-int
-mdoc_verr(struct mdoc *mdoc, int ln, int pos, 
-               const char *fmt, ...)
-{
-       char             buf[256];
-       va_list          ap;
+       n = node_alloc(mdoc, sp->line, 0, MDOC_MAX, MDOC_TBL);
+       n->span = sp;

 
 

-       if (NULL == mdoc->cb.mdoc_err)
+       if ( ! node_append(mdoc, n))

                return(0);
 
                return(0);
 

-       va_start(ap, fmt);
-       (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
-       va_end(ap);
-       return((*mdoc->cb.mdoc_err)(mdoc->data, ln, pos, buf));
+       mdoc->next = MDOC_NEXT_SIBLING;
+       return(1);

 }
 
 
 }
 
 

+/*
+ * Main parse routine.  Parses a single line -- really just hands off to
+ * the macro (mdoc_pmacro()) or text parser (mdoc_ptext()).
+ */

 int
 int

-mdoc_vwarn(struct mdoc *mdoc, int ln, int pos, 
-               enum mdoc_warn type, const char *fmt, ...)
+mdoc_parseln(struct mdoc *mdoc, int ln, char *buf, int offs)

 {
 {

-       char             buf[256];
-       va_list          ap;

 
 

-       if (NULL == mdoc->cb.mdoc_warn)
-               return(0);
+       assert( ! (MDOC_HALT & mdoc->flags));
+
+       mdoc->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 (roff_regisset(mdoc->roff, REG_nS)) {
+               if (roff_regget(mdoc->roff, REG_nS))
+                       mdoc->flags |= MDOC_SYNOPSIS;
+               else
+                       mdoc->flags &= ~MDOC_SYNOPSIS;
+       }

 
 

-       va_start(ap, fmt);
-       (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
-       va_end(ap);
-       return((*mdoc->cb.mdoc_warn)(mdoc->data, ln, pos, type, buf));
+       return(roff_getcontrol(mdoc->roff, buf, &offs) ?
+                       mdoc_pmacro(mdoc, ln, buf, offs) :
+                       mdoc_ptext(mdoc, ln, buf, offs));

 }
 
 }
 

-

 int
 int

-mdoc_macro(struct mdoc *m, int tok, 
-               int ln, int pp, int *pos, char *buf)
+mdoc_macro(MACRO_PROT_ARGS)

 {
 {

+       assert(tok < MDOC_MAX);

 
 

-       /* FIXME - these should happen during validation. */
+       /* If we're in the body, deny prologue calls. */

 
        if (MDOC_PROLOGUE & mdoc_macros[tok].flags && 
 
        if (MDOC_PROLOGUE & mdoc_macros[tok].flags && 

-                       SEC_PROLOGUE != m->lastnamed)
-               return(mdoc_perr(m, ln, pp, 
-                               "disallowed in document body"));
+                       MDOC_PBODY & mdoc->flags) {
+               mdoc_pmsg(mdoc, line, ppos, MANDOCERR_BADBODY);
+               return(1);
+       }

 
 

-       if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) && 
-                       SEC_PROLOGUE == m->lastnamed)
-               return(mdoc_perr(m, ln, pp, 
-                               "disallowed in prologue"));
+       /* If we're in the prologue, deny "body" macros.  */

 
 

-       if (1 != pp && ! (MDOC_CALLABLE & mdoc_macros[tok].flags))
-               return(mdoc_perr(m, ln, pp, "not callable"));
+       if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) && 
+                       ! (MDOC_PBODY & mdoc->flags)) {
+               mdoc_pmsg(mdoc, line, ppos, MANDOCERR_BADPROLOG);
+               if (NULL == mdoc->meta.msec)
+                       mdoc->meta.msec = mandoc_strdup("1");
+               if (NULL == mdoc->meta.title)
+                       mdoc->meta.title = mandoc_strdup("UNKNOWN");
+               if (NULL == mdoc->meta.vol)
+                       mdoc->meta.vol = mandoc_strdup("LOCAL");
+               if (NULL == mdoc->meta.os)
+                       mdoc->meta.os = mandoc_strdup("LOCAL");
+               if (NULL == mdoc->meta.date)
+                       mdoc->meta.date = mandoc_normdate
+                               (mdoc->parse, NULL, line, ppos);
+               mdoc->flags |= MDOC_PBODY;
+       }

 
 

-       return((*mdoc_macros[tok].fp)(m, tok, ln, pp, pos, buf));
+       return((*mdoc_macros[tok].fp)(mdoc, tok, line, ppos, pos, buf));

 }
 
 
 static int
 }
 
 
 static int

-mdoc_node_append(struct mdoc *mdoc, struct mdoc_node *p)
+node_append(struct mdoc *mdoc, struct mdoc_node *p)

 {
 
        assert(mdoc->last);
 {
 
        assert(mdoc->last);


@@ -283,6 +366,27 @@ mdoc_node_append(struct mdoc *mdoc, struct mdoc_node *p)
                /* NOTREACHED */
        }
 
                /* NOTREACHED */
        }
 

+       p->parent->nchild++;
+
+       /*
+        * Copy over the normalised-data pointer of our parent.  Not
+        * everybody has one, but copying a null pointer is fine.
+        */
+
+       switch (p->type) {
+       case (MDOC_BODY):
+               if (ENDBODY_NOT != p->end)
+                       break;
+               /* FALLTHROUGH */
+       case (MDOC_TAIL):
+               /* FALLTHROUGH */
+       case (MDOC_HEAD):
+               p->norm = p->parent->norm;
+               break;
+       default:
+               break;
+       }
+

        if ( ! mdoc_valid_pre(mdoc, p))
                return(0);
 
        if ( ! mdoc_valid_pre(mdoc, p))
                return(0);
 


@@ -296,6 +400,8 @@ mdoc_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;


@@ -304,155 +410,187 @@ mdoc_node_append(struct mdoc *mdoc, struct mdoc_node *p)
        }
 
        mdoc->last = p;
        }
 
        mdoc->last = p;

+
+       switch (p->type) {
+       case (MDOC_TBL):
+               /* FALLTHROUGH */
+       case (MDOC_TEXT):
+               if ( ! mdoc_valid_post(mdoc))
+                       return(0);
+               break;
+       default:
+               break;
+       }
+

        return(1);
 }
 
 
 static struct mdoc_node *
        return(1);
 }
 
 
 static struct mdoc_node *

-mdoc_node_alloc(const struct mdoc *mdoc)
+node_alloc(struct mdoc *mdoc, int line, int pos, 
+               enum mdoct tok, enum mdoc_type type)

 {
        struct mdoc_node *p;
 
 {
        struct mdoc_node *p;
 

-       p = xcalloc(1, sizeof(struct mdoc_node));
+       p = mandoc_calloc(1, sizeof(struct mdoc_node));

        p->sec = mdoc->lastsec;
        p->sec = mdoc->lastsec;

+       p->line = line;
+       p->pos = pos;
+       p->tok = tok;
+       p->type = type;
+
+       /* Flag analysis. */
+
+       if (MDOC_SYNOPSIS & mdoc->flags)
+               p->flags |= MDOC_SYNPRETTY;
+       else
+               p->flags &= ~MDOC_SYNPRETTY;
+       if (MDOC_NEWLINE & mdoc->flags)
+               p->flags |= MDOC_LINE;
+       mdoc->flags &= ~MDOC_NEWLINE;

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

-mdoc_tail_alloc(struct mdoc *mdoc, int line, int pos, int tok)
+mdoc_tail_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok)

 {
        struct mdoc_node *p;
 
 {
        struct mdoc_node *p;
 

-       assert(mdoc->first);
-       assert(mdoc->last);
-
-       p = mdoc_node_alloc(mdoc);
-
-       p->line = line;
-       p->pos = pos;
-       p->type = MDOC_TAIL;
-       p->tok = tok;
-
-       return(mdoc_node_append(mdoc, p));
+       p = node_alloc(mdoc, line, pos, tok, MDOC_TAIL);
+       if ( ! node_append(mdoc, p))
+               return(0);
+       mdoc->next = MDOC_NEXT_CHILD;
+       return(1);

 }
 
 
 int
 }
 
 
 int

-mdoc_head_alloc(struct mdoc *mdoc, int line, int pos, int tok)
+mdoc_head_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok)

 {
        struct mdoc_node *p;
 
        assert(mdoc->first);
        assert(mdoc->last);
 
 {
        struct mdoc_node *p;
 
        assert(mdoc->first);
        assert(mdoc->last);
 

-       p = mdoc_node_alloc(mdoc);
-
-       p->line = line;
-       p->pos = pos;
-       p->type = MDOC_HEAD;
-       p->tok = tok;
-
-       return(mdoc_node_append(mdoc, p));
+       p = node_alloc(mdoc, line, pos, tok, MDOC_HEAD);
+       if ( ! node_append(mdoc, p))
+               return(0);
+       mdoc->next = MDOC_NEXT_CHILD;
+       return(1);

 }
 
 
 int
 }
 
 
 int

-mdoc_body_alloc(struct mdoc *mdoc, int line, int pos, int tok)
+mdoc_body_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok)

 {
        struct mdoc_node *p;
 
 {
        struct mdoc_node *p;
 

-       assert(mdoc->first);
-       assert(mdoc->last);
-
-       p = mdoc_node_alloc(mdoc);
-
-       p->line = line;
-       p->pos = pos;
-       p->type = MDOC_BODY;
-       p->tok = tok;
-
-       return(mdoc_node_append(mdoc, p));
+       p = node_alloc(mdoc, line, pos, tok, MDOC_BODY);
+       if ( ! node_append(mdoc, p))
+               return(0);
+       mdoc->next = MDOC_NEXT_CHILD;
+       return(1);

 }
 
 
 int
 }
 
 
 int

-mdoc_root_alloc(struct mdoc *mdoc)
+mdoc_endbody_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok,
+               struct mdoc_node *body, enum mdoc_endbody end)

 {
        struct mdoc_node *p;
 
 {
        struct mdoc_node *p;
 

-       p = mdoc_node_alloc(mdoc);
-
-       p->type = MDOC_ROOT;
-
-       return(mdoc_node_append(mdoc, p));
+       p = node_alloc(mdoc, line, pos, tok, MDOC_BODY);
+       p->pending = body;
+       p->norm = body->norm;
+       p->end = end;
+       if ( ! node_append(mdoc, p))
+               return(0);
+       mdoc->next = MDOC_NEXT_SIBLING;
+       return(1);

 }
 
 
 int
 mdoc_block_alloc(struct mdoc *mdoc, int line, int pos, 
 }
 
 
 int
 mdoc_block_alloc(struct mdoc *mdoc, int line, int pos, 

-               int tok, struct mdoc_arg *args)
+               enum mdoct tok, struct mdoc_arg *args)

 {
        struct mdoc_node *p;
 
 {
        struct mdoc_node *p;
 

-       p = mdoc_node_alloc(mdoc);
-
-       p->pos = pos;
-       p->line = line;
-       p->type = MDOC_BLOCK;
-       p->tok = tok;
+       p = node_alloc(mdoc, line, pos, tok, MDOC_BLOCK);

        p->args = args;
        p->args = args;

-
-       if (args)
+       if (p->args)

                (args->refcnt)++;
 
                (args->refcnt)++;
 

-       return(mdoc_node_append(mdoc, p));
+       switch (tok) {
+       case (MDOC_Bd):
+               /* FALLTHROUGH */
+       case (MDOC_Bf):
+               /* FALLTHROUGH */
+       case (MDOC_Bl):
+               /* FALLTHROUGH */
+       case (MDOC_Rs):
+               p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
+               break;
+       default:
+               break;
+       }
+
+       if ( ! node_append(mdoc, p))
+               return(0);
+       mdoc->next = MDOC_NEXT_CHILD;
+       return(1);

 }
 
 
 int
 mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos, 
 }
 
 
 int
 mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos, 

-               int tok, struct mdoc_arg *args)
+               enum mdoct tok, struct mdoc_arg *args)

 {
        struct mdoc_node *p;
 
 {
        struct mdoc_node *p;
 

-       p = mdoc_node_alloc(mdoc);
-
-       p->line = line;
-       p->pos = pos;
-       p->type = MDOC_ELEM;
-       p->tok = tok;
+       p = node_alloc(mdoc, line, pos, tok, MDOC_ELEM);

        p->args = args;
        p->args = args;

-
-       if (args)
+       if (p->args)

                (args->refcnt)++;
 
                (args->refcnt)++;
 

-       return(mdoc_node_append(mdoc, p));
-}
+       switch (tok) {
+       case (MDOC_An):
+               p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
+               break;
+       default:
+               break;
+       }

 
 

+       if ( ! node_append(mdoc, p))
+               return(0);
+       mdoc->next = MDOC_NEXT_CHILD;
+       return(1);
+}

 
 int
 
 int

-mdoc_word_alloc(struct mdoc *mdoc, 
-               int line, int pos, const char *word)
+mdoc_word_alloc(struct mdoc *mdoc, int line, int pos, const char *p)

 {
 {

-       struct mdoc_node *p;
+       struct mdoc_node *n;

 
 

-       p = mdoc_node_alloc(mdoc);
+       n = node_alloc(mdoc, line, pos, MDOC_MAX, MDOC_TEXT);
+       n->string = roff_strdup(mdoc->roff, p);

 
 

-       p->line = line;
-       p->pos = pos;
-       p->type = MDOC_TEXT;
-       p->string = xstrdup(word);
+       if ( ! node_append(mdoc, n))
+               return(0);

 
 

-       return(mdoc_node_append(mdoc, p));
+       mdoc->next = MDOC_NEXT_SIBLING;
+       return(1);

 }
 
 
 }
 
 

-void
+static void

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

+       if (MDOC_BLOCK == p->type || MDOC_ELEM == p->type)
+               free(p->norm);

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


@@ -461,35 +599,240 @@ mdoc_node_free(struct mdoc_node *p)
 }
 
 
 }
 
 

+static void
+mdoc_node_unlink(struct mdoc *mdoc, struct mdoc_node *n)
+{
+
+       /* Adjust siblings. */
+
+       if (n->prev)
+               n->prev->next = n->next;
+       if (n->next)
+               n->next->prev = n->prev;
+
+       /* Adjust parent. */
+
+       if (n->parent) {
+               n->parent->nchild--;
+               if (n->parent->child == n)
+                       n->parent->child = n->prev ? n->prev : n->next;
+               if (n->parent->last == n)
+                       n->parent->last = n->prev ? n->prev : NULL;
+       }
+
+       /* Adjust parse point, if applicable. */
+
+       if (mdoc && mdoc->last == n) {
+               if (n->prev) {
+                       mdoc->last = n->prev;
+                       mdoc->next = MDOC_NEXT_SIBLING;
+               } else {
+                       mdoc->last = n->parent;
+                       mdoc->next = MDOC_NEXT_CHILD;
+               }
+       }
+
+       if (mdoc && mdoc->first == n)
+               mdoc->first = NULL;
+}
+
+

 void
 void

-mdoc_node_freelist(struct mdoc_node *p)
+mdoc_node_delete(struct mdoc *mdoc, struct mdoc_node *p)

 {
 
 {
 

-       if (p->child)
-               mdoc_node_freelist(p->child);
-       if (p->next)
-               mdoc_node_freelist(p->next);
+       while (p->child) {
+               assert(p->nchild);
+               mdoc_node_delete(mdoc, p->child);
+       }
+       assert(0 == p->nchild);

 
 

+       mdoc_node_unlink(mdoc, p);

        mdoc_node_free(p);
 }
 
        mdoc_node_free(p);
 }
 

+int
+mdoc_node_relink(struct mdoc *mdoc, struct mdoc_node *p)
+{
+
+       mdoc_node_unlink(mdoc, p);
+       return(node_append(mdoc, p));
+}
+
+#if 0
+/*
+ * Pre-treat a text line.
+ * Text lines can consist of equations, which must be handled apart from
+ * the regular text.
+ * Thus, use this function to step through a line checking if it has any
+ * equations embedded in it.
+ * This must handle multiple equations AND equations that do not end at
+ * the end-of-line, i.e., will re-enter in the next roff parse.
+ */
+static int
+mdoc_preptext(struct mdoc *mdoc, int line, char *buf, int offs)
+{
+       char            *start, *end;
+       char             delim;
+
+       while ('\0' != buf[offs]) {
+               /* Mark starting position if eqn is set. */
+               start = NULL;
+               if ('\0' != (delim = roff_eqndelim(mdoc->roff)))
+                       if (NULL != (start = strchr(buf + offs, delim)))
+                               *start++ = '\0';
+
+               /* Parse text as normal. */
+               if ( ! mdoc_ptext(mdoc, line, buf, offs))
+                       return(0);
+
+               /* Continue only if an equation exists. */
+               if (NULL == start)
+                       break;
+
+               /* Read past the end of the equation. */
+               offs += start - (buf + offs);
+               assert(start == &buf[offs]);
+               if (NULL != (end = strchr(buf + offs, delim))) {
+                       *end++ = '\0';
+                       while (' ' == *end)
+                               end++;
+               }
+
+               /* Parse the equation itself. */
+               roff_openeqn(mdoc->roff, NULL, line, offs, buf);
+
+               /* Process a finished equation? */
+               if (roff_closeeqn(mdoc->roff))
+                       if ( ! mdoc_addeqn(mdoc, roff_eqn(mdoc->roff)))
+                               return(0);
+               offs += (end - (buf + offs));
+       } 
+
+       return(1);
+}
+#endif

 
 /*
  * Parse free-form text, that is, a line that does not begin with the
  * control character.
  */
 static int
 
 /*
  * Parse free-form text, that is, a line that does not begin with the
  * control character.
  */
 static int

-parsetext(struct mdoc *mdoc, int line, char *buf)
+mdoc_ptext(struct mdoc *mdoc, int line, char *buf, int offs)

 {
 {

+       char             *c, *ws, *end;
+       struct mdoc_node *n;
+
+       /* No text before an initial macro. */
+
+       if (SEC_NONE == mdoc->lastnamed) {
+               mdoc_pmsg(mdoc, line, offs, MANDOCERR_NOTEXT);
+               return(1);
+       }

 
 

-       if (SEC_PROLOGUE == mdoc->lastnamed)
-               return(mdoc_perr(mdoc, line, 0,
-                       "text disallowed in prologue"));
+       assert(mdoc->last);
+       n = mdoc->last;
+
+       /*
+        * Divert directly to list processing if we're encountering a
+        * columnar MDOC_BLOCK with or without a prior MDOC_BLOCK entry
+        * (a MDOC_BODY means it's already open, in which case we should
+        * process within its context in the normal way).
+        */
+
+       if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
+                       LIST_column == n->norm->Bl.type) {
+               /* `Bl' is open without any children. */
+               mdoc->flags |= MDOC_FREECOL;
+               return(mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf));
+       }

 
 

-       if ( ! mdoc_word_alloc(mdoc, line, 0, buf))
+       if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
+                       NULL != n->parent &&
+                       MDOC_Bl == n->parent->tok &&
+                       LIST_column == n->parent->norm->Bl.type) {
+               /* `Bl' has block-level `It' children. */
+               mdoc->flags |= MDOC_FREECOL;
+               return(mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf));
+       }
+
+       /*
+        * Search for the beginning of unescaped trailing whitespace (ws)
+        * and for the first character not to be output (end).
+        */
+
+       /* FIXME: replace with strcspn(). */
+       ws = NULL;
+       for (c = end = buf + offs; *c; c++) {
+               switch (*c) {
+               case ' ':
+                       if (NULL == ws)
+                               ws = c;
+                       continue;
+               case '\t':
+                       /*
+                        * Always warn about trailing tabs,
+                        * even outside literal context,
+                        * where they should be put on the next line.
+                        */
+                       if (NULL == ws)
+                               ws = c;
+                       /*
+                        * Strip trailing tabs in literal context only;
+                        * outside, they affect the next line.
+                        */
+                       if (MDOC_LITERAL & mdoc->flags)
+                               continue;
+                       break;
+               case '\\':
+                       /* Skip the escaped character, too, if any. */
+                       if (c[1])
+                               c++;
+                       /* FALLTHROUGH */
+               default:
+                       ws = NULL;
+                       break;
+               }
+               end = c + 1;
+       }
+       *end = '\0';
+
+       if (ws)
+               mdoc_pmsg(mdoc, line, (int)(ws-buf), MANDOCERR_EOLNSPACE);
+
+       if ('\0' == buf[offs] && ! (MDOC_LITERAL & mdoc->flags)) {
+               mdoc_pmsg(mdoc, line, (int)(c-buf), MANDOCERR_NOBLANKLN);
+
+               /*
+                * Insert a `sp' 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(mdoc, line, offs, MDOC_sp, NULL))
+                       return(0);
+
+               mdoc->next = MDOC_NEXT_SIBLING;
+
+               return(mdoc_valid_post(mdoc));
+       }
+
+       if ( ! mdoc_word_alloc(mdoc, line, offs, buf+offs))

                return(0);
 
                return(0);
 

-       mdoc->next = MDOC_NEXT_SIBLING;
+       if (MDOC_LITERAL & mdoc->flags)
+               return(1);
+
+       /*
+        * 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(buf < end);
+
+       if (mandoc_eos(buf+offs, (size_t)(end-buf-offs), 0))
+               mdoc->last->flags |= MDOC_EOS;
+

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


@@ -498,56 +841,160 @@ parsetext(struct mdoc *mdoc, int line, char *buf)
  * 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
-parsemacro(struct mdoc *m, int ln, char *buf)
+static int
+mdoc_pmacro(struct mdoc *mdoc, int ln, char *buf, int offs)

 {
 {

-       int               i, c;
+       enum mdoct        tok;
+       int               i, sv;

        char              mac[5];
        char              mac[5];

+       struct mdoc_node *n;
+
+       /* Empty post-control lines are ignored. */

 
 

-       /* Comments are quickly ignored. */
+       if ('"' == buf[offs]) {
+               mdoc_pmsg(mdoc, ln, offs, MANDOCERR_BADCOMMENT);
+               return(1);
+       } else if ('\0' == buf[offs])
+               return(1);

 
 

-       if (buf[1] && '\\' == buf[1])
-               if (buf[2] && '\"' == buf[2])
-                       return(1);
+       sv = offs;

 
 

-       /* Copy the first word into a nil-terminated buffer. */
+       /* 
+        * Copy the first word into a nil-terminated buffer.
+        * Stop copying when a tab, space, or eoln is encountered.
+        */

 
 

-       for (i = 1; i < 5; i++) {
-               if (0 == (mac[i - 1] = buf[i]))
-                       break;
-               else if (isspace((unsigned char)buf[i]))
-                       break;
+       i = 0;
+       while (i < 4 && '\0' != buf[offs] && 
+                       ' ' != buf[offs] && '\t' != buf[offs])
+               mac[i++] = buf[offs++];
+
+       mac[i] = '\0';
+
+       tok = (i > 1 || i < 4) ? mdoc_hash_find(mac) : MDOC_MAX;
+
+       if (MDOC_MAX == tok) {
+               mandoc_vmsg(MANDOCERR_MACRO, mdoc->parse, 
+                               ln, sv, "%s", buf + sv - 1);
+               return(1);

        }
 
        }
 

-       /* FIXME: be able to skip unknown macro lines! */
+       /* Disregard the first trailing tab, if applicable. */

 
 

-       mac[i - 1] = 0;
+       if ('\t' == buf[offs])
+               offs++;

 
 

-       if (i == 5 || i <= 2) {
-               (void)mdoc_perr(m, ln, 1, "unknown macro: %s%s", 
-                               mac, i == 5 ? "..." : "");
-               goto err;
-       } 
-       
-       if (MDOC_MAX == (c = mdoc_tokhash_find(m->htab, mac))) {
-               (void)mdoc_perr(m, ln, 1, "unknown macro: %s", mac);
-               goto err;
+       /* Jump to the next non-whitespace word. */
+
+       while (buf[offs] && ' ' == buf[offs])
+               offs++;
+
+       /* 
+        * 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[offs] && ' ' == buf[offs - 1])
+               mdoc_pmsg(mdoc, ln, offs - 1, MANDOCERR_EOLNSPACE);
+
+       /*
+        * If an initial macro or a list invocation, divert directly
+        * into macro processing.
+        */
+
+       if (NULL == mdoc->last || MDOC_It == tok || MDOC_El == tok) {
+               if ( ! mdoc_macro(mdoc, tok, ln, sv, &offs, buf)) 
+                       goto err;
+               return(1);

        }
 
        }
 

-       /* The macro is sane.  Jump to the next word. */
+       n = mdoc->last;
+       assert(mdoc->last);
+
+       /*
+        * If the first macro of a `Bl -column', open an `It' block
+        * context around the parsed macro.
+        */
+
+       if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
+                       LIST_column == n->norm->Bl.type) {
+               mdoc->flags |= MDOC_FREECOL;
+               if ( ! mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf))
+                       goto err;
+               return(1);
+       }

 
 

-       while (buf[i] && isspace((unsigned char)buf[i]))
-               i++;
+       /*
+        * If we're following a block-level `It' within a `Bl -column'
+        * context (perhaps opened in the above block or in ptext()),
+        * then open an `It' block context around the parsed macro.
+        */
+
+       if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
+                       NULL != n->parent &&
+                       MDOC_Bl == n->parent->tok &&
+                       LIST_column == n->parent->norm->Bl.type) {
+               mdoc->flags |= MDOC_FREECOL;
+               if ( ! mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf)) 
+                       goto err;
+               return(1);
+       }

 
 

-       /* Begin recursive parse sequence. */
+       /* Normal processing of a macro. */

 
 

-       if ( ! mdoc_macro(m, c, ln, 1, &i, buf)) 
+       if ( ! mdoc_macro(mdoc, tok, ln, sv, &offs, buf)) 

                goto err;
 
        return(1);
 
 err:   /* Error out. */
 
                goto err;
 
        return(1);
 
 err:   /* Error out. */
 

-       m->flags |= MDOC_HALT;
+       mdoc->flags |= MDOC_HALT;

        return(0);
 }
        return(0);
 }

+
+enum mdelim
+mdoc_isdelim(const char *p)
+{
+
+       if ('\0' == p[0])
+               return(DELIM_NONE);
+
+       if ('\0' == p[1])
+               switch (p[0]) {
+               case('('):
+                       /* FALLTHROUGH */
+               case('['):
+                       return(DELIM_OPEN);
+               case('|'):
+                       return(DELIM_MIDDLE);
+               case('.'):
+                       /* FALLTHROUGH */
+               case(','):
+                       /* FALLTHROUGH */
+               case(';'):
+                       /* FALLTHROUGH */
+               case(':'):
+                       /* FALLTHROUGH */
+               case('?'):
+                       /* FALLTHROUGH */
+               case('!'):
+                       /* FALLTHROUGH */
+               case(')'):
+                       /* FALLTHROUGH */
+               case(']'):
+                       return(DELIM_CLOSE);
+               default:
+                       return(DELIM_NONE);
+               }
+
+       if ('\\' != p[0])
+               return(DELIM_NONE);
+
+       if (0 == strcmp(p + 1, "."))
+               return(DELIM_CLOSE);
+       if (0 == strcmp(p + 1, "fR|\\fP"))
+               return(DELIM_MIDDLE);
+
+       return(DELIM_NONE);
+}