Add manual page for mandoc-db (mostly to document the file format of

[mandoc.git] / mdoc.c

diff --git a/mdoc.c b/mdoc.c
index 9f0e77d3dcacfb27dcc2ba32a25780a53acc5d22..ea3fda2691686ff647825f788e3df89d390364a6 100644 (file)
--- a/mdoc.c
+++ b/mdoc.c
@@ -1,6 +1,7 @@
-/*     $Id: mdoc.c,v 1.75 2009/04/12 19:45:26 kristaps Exp $ */
+/*     $Id: mdoc.c,v 1.188 2011/03/28 23:52:13 kristaps Exp $ */

 /*
 /*

- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org>
+ * Copyright (c) 2008, 2009, 2010, 2011 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


@@ -14,27 +15,26 @@
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
  * 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 <stdarg.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 #include <stdarg.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>

+#include <time.h>

 
 

+#include "mdoc.h"
+#include "mandoc.h"

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

-
-enum   merr {
-       ENOCALL,
-       EBODYPROL,
-       EPROLBODY,
-       ESPACE,
-       ETEXTPROL,
-       ENOBLANK,
-       EMALLOC
-};
+#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",


@@ -45,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",


@@ -63,12 +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",           "Ap",
-       "Lp",           "Lk",           "Mt",           "Brq",
+       "Fr",           "Ud",           "Lb",           "Lp",
+       "Lk",           "Mt",           "Brq",          "Bro",
+       /* LINTED */
+       "Brc",          "%C",           "Es",           "En",

        /* LINTED */
        /* LINTED */

-       "Bro",          "Brc",          "\%C",          "Es",
+       "Dx",           "%Q",           "br",           "sp",

        /* LINTED */
        /* LINTED */

-       "En",           "Dx",           "\%Q"
+       "%U",           "Ta"

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


@@ -80,33 +82,30 @@ 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",             "nested"
+       "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_free1(struct mdoc *);

-static int               mdoc_alloc1(struct mdoc *);
+static void              mdoc_alloc1(struct mdoc *);

 static struct mdoc_node *node_alloc(struct mdoc *, int, int, 
 static struct mdoc_node *node_alloc(struct mdoc *, int, int, 

-                               int, enum mdoc_type);
+                               enum mdoct, enum mdoc_type);

 static int               node_append(struct mdoc *, 
                                struct mdoc_node *);
 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               macrowarn(struct mdoc *, int, const char *);
-static int               perr(struct mdoc *, int, int, enum merr);
-
-#define verr(m, t) perr((m), (m)->last->line, (m)->last->pos, (t))
+static int               mdoc_ptext(struct mdoc *, int, char *, int);
+static int               mdoc_pmacro(struct mdoc *, int, char *, int);

 
 

-/*
- * Get the first (root) node of the parse tree.
- */

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

-       return(MDOC_HALT & m->flags ? NULL : m->first);
+       assert( ! (MDOC_HALT & m->flags));
+       return(m->first);

 }
 
 
 }
 
 


@@ -114,16 +113,20 @@ const struct mdoc_meta *
 mdoc_meta(const struct mdoc *m)
 {
 
 mdoc_meta(const struct mdoc *m)
 {
 

-       return(MDOC_HALT & m->flags ? NULL : &m->meta);
+       assert( ! (MDOC_HALT & m->flags));
+       return(&m->meta);

 }
 
 
 }
 
 

+/*
+ * Frees volatile resources (parse tree, meta-data, fields).
+ */

 static void
 mdoc_free1(struct mdoc *mdoc)
 {
 
        if (mdoc->first)
 static void
 mdoc_free1(struct mdoc *mdoc)
 {
 
        if (mdoc->first)

-               mdoc_node_freelist(mdoc->first);
+               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)


@@ -134,217 +137,204 @@ mdoc_free1(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);

 }
 
 
 }
 
 

-static int
+/*
+ * Allocate all volatile resources (parse tree, meta-data, fields).
+ */
+static void

 mdoc_alloc1(struct mdoc *mdoc)
 {
 
 mdoc_alloc1(struct mdoc *mdoc)
 {
 

-       bzero(&mdoc->meta, sizeof(struct mdoc_meta));
+       memset(&mdoc->meta, 0, sizeof(struct mdoc_meta));

        mdoc->flags = 0;
        mdoc->flags = 0;

-       mdoc->lastnamed = mdoc->lastsec = 0;
-       mdoc->last = calloc(1, sizeof(struct mdoc_node));
-       if (NULL == mdoc->last)
-               return(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->next = MDOC_NEXT_CHILD;
        mdoc->first = mdoc->last;
        mdoc->last->type = MDOC_ROOT;
        mdoc->next = MDOC_NEXT_CHILD;

-       return(1);

 }
 
 
 /*
 }
 
 
 /*

- * Free up all resources contributed by a parse:  the node tree,
- * meta-data and so on.  Then reallocate the root node for another
- * parse.
+ * 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.

  */
  */

-int
+void

 mdoc_reset(struct mdoc *mdoc)
 {
 
        mdoc_free1(mdoc);
 mdoc_reset(struct mdoc *mdoc)
 {
 
        mdoc_free1(mdoc);

-       return(mdoc_alloc1(mdoc));
+       mdoc_alloc1(mdoc);

 }
 
 
 /*
 }
 
 
 /*

- * Completely free up all resources.
+ * 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);
  */
 void
 mdoc_free(struct mdoc *mdoc)
 {
 
        mdoc_free1(mdoc);

-       if (mdoc->htab)
-               mdoc_hash_free(mdoc->htab);

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

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

 struct mdoc *
 struct mdoc *

-mdoc_alloc(void *data, int pflags, const struct mdoc_cb *cb)
+mdoc_alloc(struct regset *regs, struct mparse *parse)

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

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

 
 

-       if (NULL == (p->htab = mdoc_hash_alloc())) {
-               free(p);
-               return(NULL);
-       } else if (mdoc_alloc1(p))
-               return(p);
+       p->parse = parse;
+       p->regs = regs;

 
 

-       free(p);
-       return(NULL);
+       mdoc_hash_init();
+       mdoc_alloc1(p);
+       return(p);

 }
 
 
 /*
  * Climb back up the parse tree, validating open scopes.  Mostly calls
 }
 
 
 /*
  * Climb back up the parse tree, validating open scopes.  Mostly calls

- * through to macro_end in macro.c.
+ * through to macro_end() in macro.c.

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

-       if (MDOC_HALT & m->flags)
-               return(0);
-       else if (mdoc_macroend(m))
+       assert( ! (MDOC_HALT & m->flags));
+       if (mdoc_macroend(m))

                return(1);
        m->flags |= MDOC_HALT;
        return(0);
 }
 
                return(1);
        m->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 *m, const struct eqn *ep)

 {
 {

+       struct mdoc_node *n;

 
 

-       /* If in error-mode, then we parse no more. */
+       assert( ! (MDOC_HALT & m->flags));

 
 

-       if (MDOC_HALT & m->flags)
+       /* No text before an initial macro. */
+
+       if (SEC_NONE == m->lastnamed) {
+               mdoc_pmsg(m, ep->line, ep->pos, MANDOCERR_NOTEXT);
+               return(1);
+       }
+
+       n = node_alloc(m, ep->line, ep->pos, MDOC_MAX, MDOC_EQN);
+       n->eqn = ep;
+
+       if ( ! node_append(m, n))

                return(0);
 
                return(0);
 

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

 }
 
 }
 

-
-void
-mdoc_vmsg(struct mdoc *mdoc, int ln, int pos, const char *fmt, ...)
+int
+mdoc_addspan(struct mdoc *m, 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 & m->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 == m->lastnamed) {
+               mdoc_pmsg(m, 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(m, sp->line, 0, MDOC_MAX, MDOC_TBL);
+       n->span = sp;

 
 

-       if (NULL == mdoc->cb.mdoc_err)
+       if ( ! node_append(m, 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));
+       m->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 *m, int ln, char *buf, int offs)

 {
 {

-       char             buf[256];
-       va_list          ap;

 
 

-       if (NULL == mdoc->cb.mdoc_warn)
-               return(0);
+       assert( ! (MDOC_HALT & m->flags));
+
+       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;
+       }

 
 

-       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(mandoc_getcontrol(buf, &offs) ?
+                       mdoc_pmacro(m, ln, buf, offs) :
+                       mdoc_ptext(m, 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(perr(m, ln, pp, EPROLBODY));
-
-       if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) && 
-                       SEC_PROLOGUE == m->lastnamed)
-               return(perr(m, ln, pp, EBODYPROL));
-
-       if (1 != pp && ! (MDOC_CALLABLE & mdoc_macros[tok].flags))
-               return(perr(m, ln, pp, ENOCALL));
-
-       return((*mdoc_macros[tok].fp)(m, tok, ln, pp, pos, buf));
-}
-
+                       MDOC_PBODY & m->flags) {
+               mdoc_pmsg(m, line, ppos, MANDOCERR_BADBODY);
+               return(1);
+       }

 
 

-static int
-perr(struct mdoc *m, int line, int pos, enum merr type)
-{
-       char            *p;
+       /* If we're in the prologue, deny "body" macros.  */

 
 

-       p = NULL;
-       switch (type) {
-       case (ENOCALL):
-               p = "not callable";
-               break;
-       case (EPROLBODY):
-               p = "macro disallowed in document body";
-               break;
-       case (EBODYPROL):
-               p = "macro disallowed in document prologue";
-               break;
-       case (EMALLOC):
-               p = "memory exhausted";
-               break;
-       case (ETEXTPROL):
-               p = "text disallowed in document prologue";
-               break;
-       case (ENOBLANK):
-               p = "blank lines disallowed in non-literal contexts";
-               break;
-       case (ESPACE):
-               p = "whitespace disallowed after delimiter";
-               break;
+       if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) && 
+                       ! (MDOC_PBODY & m->flags)) {
+               mdoc_pmsg(m, line, ppos, MANDOCERR_BADPROLOG);
+               if (NULL == m->meta.msec)
+                       m->meta.msec = mandoc_strdup("1");
+               if (NULL == m->meta.title)
+                       m->meta.title = mandoc_strdup("UNKNOWN");
+               if (NULL == m->meta.vol)
+                       m->meta.vol = mandoc_strdup("LOCAL");
+               if (NULL == m->meta.os)
+                       m->meta.os = mandoc_strdup("LOCAL");
+               if (NULL == m->meta.date)
+                       m->meta.date = mandoc_normdate
+                               (m->parse, NULL, line, ppos);
+               m->flags |= MDOC_PBODY;

        }
        }

-       assert(p);
-       return(mdoc_perr(m, line, pos, p));
+
+       return((*mdoc_macros[tok].fp)(m, tok, line, ppos, pos, buf));

 }
 
 
 }
 
 


@@ -371,10 +361,27 @@ 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):
+               /* 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);

-       if ( ! mdoc_action_pre(mdoc, p))
-               return(0);

 
        switch (p->type) {
        case (MDOC_HEAD):
 
        switch (p->type) {
        case (MDOC_HEAD):


@@ -386,6 +393,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;


@@ -396,11 +405,11 @@ node_append(struct mdoc *mdoc, struct mdoc_node *p)
        mdoc->last = p;
 
        switch (p->type) {
        mdoc->last = p;
 
        switch (p->type) {

+       case (MDOC_TBL):
+               /* FALLTHROUGH */

        case (MDOC_TEXT):
                if ( ! mdoc_valid_post(mdoc))
                        return(0);
        case (MDOC_TEXT):
                if ( ! mdoc_valid_post(mdoc))
                        return(0);

-               if ( ! mdoc_action_post(mdoc))
-                       return(0);

                break;
        default:
                break;
                break;
        default:
                break;


@@ -411,117 +420,176 @@ node_append(struct mdoc *mdoc, struct mdoc_node *p)
 
 
 static struct mdoc_node *
 
 
 static struct mdoc_node *

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

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

-       if (NULL == (p = calloc(1, sizeof(struct mdoc_node)))) {
-               (void)verr(mdoc, EMALLOC);
-               return(NULL);
-       }
-
-       p->sec = mdoc->lastsec;
+       p = mandoc_calloc(1, sizeof(struct mdoc_node));
+       p->sec = m->lastsec;

        p->line = line;
        p->pos = pos;
        p->tok = tok;
        p->line = line;
        p->pos = pos;
        p->tok = tok;

-       if (MDOC_TEXT != (p->type = type))
-               assert(p->tok >= 0);
+       p->type = type;
+
+       /* 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;

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

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

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

-       p = node_alloc(mdoc, line, pos, tok, MDOC_TAIL);
-       if (NULL == p)
+       p = node_alloc(m, line, pos, tok, MDOC_TAIL);
+       if ( ! node_append(m, p))

                return(0);
                return(0);

-       return(node_append(mdoc, p));
+       m->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 *m, int line, int pos, enum mdoct tok)

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

-       assert(mdoc->first);
-       assert(mdoc->last);
+       assert(m->first);
+       assert(m->last);

 
 

-       p = node_alloc(mdoc, line, pos, tok, MDOC_HEAD);
-       if (NULL == p)
+       p = node_alloc(m, line, pos, tok, MDOC_HEAD);
+       if ( ! node_append(m, p))

                return(0);
                return(0);

-       return(node_append(mdoc, p));
+       m->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 *m, int line, int pos, enum mdoct tok)

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

-       p = node_alloc(mdoc, line, pos, tok, MDOC_BODY);
-       if (NULL == p)
+       p = node_alloc(m, line, pos, tok, MDOC_BODY);
+       if ( ! node_append(m, p))

                return(0);
                return(0);

-       return(node_append(mdoc, p));
+       m->next = MDOC_NEXT_CHILD;
+       return(1);

 }
 
 
 int
 }
 
 
 int

-mdoc_block_alloc(struct mdoc *mdoc, int line, int pos, 
-               int tok, struct mdoc_arg *args)
+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;
 
 {
        struct mdoc_node *p;
 

-       p = node_alloc(mdoc, line, pos, tok, MDOC_BLOCK);
-       if (NULL == p)
+       p = node_alloc(m, line, pos, tok, MDOC_BODY);
+       p->pending = body;
+       p->end = end;
+       if ( ! node_append(m, p))

                return(0);
                return(0);

-       if ((p->args = args))
-               (args->refcnt)++;
-       return(node_append(mdoc, p));
+       m->next = MDOC_NEXT_SIBLING;
+       return(1);

 }
 
 
 int
 }
 
 
 int

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

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

-       p = node_alloc(mdoc, line, pos, tok, MDOC_ELEM);
-       if (NULL == p)
-               return(0);
-       if ((p->args = args))
+       p = node_alloc(m, line, pos, tok, MDOC_BLOCK);
+       p->args = args;
+       if (p->args)

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

-       return(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(m, p))
+               return(0);
+       m->next = MDOC_NEXT_CHILD;
+       return(1);

 }
 
 
 int
 }
 
 
 int

-mdoc_word_alloc(struct mdoc *mdoc, 
-               int line, int pos, const char *word)
+mdoc_elem_alloc(struct mdoc *m, int line, int pos, 
+               enum mdoct tok, struct mdoc_arg *args)

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

-       p = node_alloc(mdoc, line, pos, -1, MDOC_TEXT);
-       if (NULL == p)
+       p = node_alloc(m, line, pos, tok, MDOC_ELEM);
+       p->args = args;
+       if (p->args)
+               (args->refcnt)++;
+
+       switch (tok) {
+       case (MDOC_An):
+               p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
+               break;
+       default:
+               break;
+       }
+
+       if ( ! node_append(m, p))

                return(0);
                return(0);

-       if (NULL == (p->string = strdup(word))) {
-               (void)verr(mdoc, EMALLOC);
+       m->next = MDOC_NEXT_CHILD;
+       return(1);
+}
+
+int
+mdoc_word_alloc(struct mdoc *m, int line, int pos, const char *p)
+{
+       struct mdoc_node *n;
+       size_t            sv, len;
+
+       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);
+
+       /* Prohibit truncation. */
+       assert(sv < len + 1);
+
+       if ( ! node_append(m, n))

                return(0);
                return(0);

-       }
-       return(node_append(mdoc, p));
+
+       m->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)


@@ -530,15 +598,55 @@ mdoc_node_free(struct mdoc_node *p)
 }
 
 
 }
 
 

+static void
+mdoc_node_unlink(struct mdoc *m, 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 (m && m->last == n) {
+               if (n->prev) {
+                       m->last = n->prev;
+                       m->next = MDOC_NEXT_SIBLING;
+               } else {
+                       m->last = n->parent;
+                       m->next = MDOC_NEXT_CHILD;
+               }
+       }
+
+       if (m && m->first == n)
+               m->first = NULL;
+}
+
+

 void
 void

-mdoc_node_freelist(struct mdoc_node *p)
+mdoc_node_delete(struct mdoc *m, 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(m, p->child);
+       }
+       assert(0 == p->nchild);

 
 

+       mdoc_node_unlink(m, p);

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


@@ -548,96 +656,235 @@ mdoc_node_freelist(struct mdoc_node *p)
  * control character.
  */
 static int
  * control character.
  */
 static int

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

 {
 {

+       char             *c, *ws, *end;
+       struct mdoc_node *n;
+
+       /* No text before an initial macro. */
+
+       if (SEC_NONE == m->lastnamed) {
+               mdoc_pmsg(m, line, offs, MANDOCERR_NOTEXT);
+               return(1);
+       }
+
+       assert(m->last);
+       n = m->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. */
+               m->flags |= MDOC_FREECOL;
+               return(mdoc_macro(m, MDOC_It, line, offs, &offs, 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. */
+               m->flags |= MDOC_FREECOL;
+               return(mdoc_macro(m, MDOC_It, line, offs, &offs, buf));
+       }

 
 

-       if (SEC_PROLOGUE == m->lastnamed)
-               return(perr(m, line, 0, ETEXTPROL));
+       /*
+        * 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 (mandoc_hyph(buf + offs, c))
+                               *c = ASCII_HYPH;
+                       ws = NULL;
+                       break;
+               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 & m->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 (0 == buf[0] && ! (MDOC_LITERAL & m->flags))
-               return(perr(m, line, 0, ENOBLANK));
+       if (ws)
+               mdoc_pmsg(m, line, (int)(ws-buf), MANDOCERR_EOLNSPACE);
+
+       if ('\0' == buf[offs] && ! (MDOC_LITERAL & m->flags)) {
+               mdoc_pmsg(m, 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(m, line, offs, MDOC_sp, NULL))
+                       return(0);
+
+               m->next = MDOC_NEXT_SIBLING;
+               return(1);
+       }

 
 

-       if ( ! mdoc_word_alloc(m, line, 0, buf))
+       if ( ! mdoc_word_alloc(m, line, offs, buf+offs))

                return(0);
 
                return(0);
 

-       m->next = MDOC_NEXT_SIBLING;
-       return(1);
-}
+       if (MDOC_LITERAL & m->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.
+        */

 
 

-static int
-macrowarn(struct mdoc *m, int ln, const char *buf)
-{
-       if ( ! (MDOC_IGN_MACRO & m->pflags))
-               return(mdoc_perr(m, ln, 1, 
-                               "unknown macro: %s%s", 
-                               buf, strlen(buf) > 3 ? "..." : ""));
-       return(mdoc_pwarn(m, ln, 1, WARN_SYNTAX,
-                               "unknown macro: %s%s",
-                               buf, strlen(buf) > 3 ? "..." : ""));
-}
+       assert(buf < end);
+
+       if (mandoc_eos(buf+offs, (size_t)(end-buf-offs), 0))
+               m->last->flags |= MDOC_EOS;

 
 

+       return(1);
+}

 
 
 /*
  * 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 *m, 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;

 
 

-       /* Comments and empties are quickly ignored. */
+       /* Empty post-control lines are ignored. */

 
 

-       if (0 == buf[1])
+       if ('"' == buf[offs]) {
+               mdoc_pmsg(m, ln, offs, MANDOCERR_BADCOMMENT);
+               return(1);
+       } else if ('\0' == buf[offs])

                return(1);
 
                return(1);
 

-       if (' ' == buf[1]) {
-               i = 2;
-               while (buf[i] && ' ' == buf[i])
-                       i++;
-               if (0 == buf[i])
-                       return(1);
-               return(perr(m, ln, 1, ESPACE));
-       }
+       sv = offs;

 
 

-       if (buf[1] && '\\' == buf[1])
-               if (buf[2] && '\"' == buf[2])
-                       return(1);
+       /* 
+        * Copy the first word into a nil-terminated buffer.
+        * Stop copying when a tab, space, or eoln is encountered.
+        */

 
 

-       /* Copy the first word into a nil-terminated buffer. */
+       i = 0;
+       while (i < 4 && '\0' != buf[offs] && 
+                       ' ' != buf[offs] && '\t' != buf[offs])
+               mac[i++] = buf[offs++];

 
 

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

        }
 
        }
 

-       mac[i - 1] = 0;
+       /* Disregard the first trailing tab, if applicable. */
+
+       if ('\t' == buf[offs])
+               offs++;
+
+       /* 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(m, ln, offs - 1, MANDOCERR_EOLNSPACE);
+
+       /*
+        * If an initial macro or a list invocation, divert directly
+        * into macro processing.
+        */

 
 

-       if (i == 5 || i <= 2) {
-               if ( ! macrowarn(m, ln, mac))
+       if (NULL == m->last || MDOC_It == tok || MDOC_El == tok) {
+               if ( ! mdoc_macro(m, tok, ln, sv, &offs, buf)) 

                        goto err;
                return(1);
                        goto err;
                return(1);

-       } 
-       
-       if (MDOC_MAX == (c = mdoc_hash_find(m->htab, mac))) {
-               if ( ! macrowarn(m, ln, mac))
+       }
+
+       n = m->last;
+       assert(m->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) {
+               m->flags |= MDOC_FREECOL;
+               if ( ! mdoc_macro(m, MDOC_It, ln, sv, &sv, buf))

                        goto err;
                return(1);
        }
 
                        goto err;
                return(1);
        }
 

-       /* The macro is sane.  Jump to the next word. */
-
-       while (buf[i] && ' ' == 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) {
+               m->flags |= MDOC_FREECOL;
+               if ( ! mdoc_macro(m, 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(m, tok, ln, sv, &offs, buf)) 

                goto err;
 
        return(1);
                goto err;
 
        return(1);


@@ -647,3 +894,49 @@ err:       /* Error out. */
        m->flags |= MDOC_HALT;
        return(0);
 }
        m->flags |= MDOC_HALT;
        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, "*(Ba"))
+               return(DELIM_MIDDLE);
+
+       return(DELIM_NONE);
+}