Pledge man.cgi(8).

[mandoc.git] / mdoc.c

diff --git a/mdoc.c b/mdoc.c
index c9c1e8f19664ab5ff43b0b69c44c575fa39b7e55..5be1e7810d55c2098bc5be7b059cfb3dbe5a193c 100644 (file)
--- a/mdoc.c
+++ b/mdoc.c
@@ -1,40 +1,43 @@
-/*     $Id: mdoc.c,v 1.79 2009/06/15 10:02:53 kristaps Exp $ */
+/*     $Id: mdoc.c,v 1.260 2017/02/16 03:00:23 schwarze Exp $ */

 /*
 /*

- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2010, 2012-2017 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
  * copyright notice and this permission notice appear in all copies.
  *
  *
  * 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.
  *

- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES

  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF

- * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS 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.
  */
  * 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.
  */

+#include "config.h"
+
+#include <sys/types.h>
+

 #include <assert.h>
 #include <ctype.h>
 #include <stdarg.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 #include <assert.h>
 #include <ctype.h>
 #include <stdarg.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>

-
+#include <time.h>
+
+#include "mandoc_aux.h"
+#include "mandoc.h"
+#include "roff.h"
+#include "mdoc.h"
+#include "libmandoc.h"
+#include "roff_int.h"

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

-enum   merr {
-       ENOCALL,
-       EBODYPROL,
-       EPROLBODY,
-       ESPACE,
-       ETEXTPROL,
-       ENOBLANK,
-       EMALLOC
-};
-
-const  char *const __mdoc_macronames[MDOC_MAX] = {              
-       "\\\"",         "Dd",           "Dt",           "Os",
+const  char *const __mdoc_macronames[MDOC_MAX + 1] = {
+       "text",
+       "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",


@@ -44,12 +47,9 @@ const        char *const __mdoc_macronames[MDOC_MAX] = {
        "Ic",           "In",           "Li",           "Nd",
        "Nm",           "Op",           "Ot",           "Pa",
        "Rv",           "St",           "Va",           "Vt",
        "Ic",           "In",           "Li",           "Nd",
        "Nm",           "Op",           "Ot",           "Pa",
        "Rv",           "St",           "Va",           "Vt",

-       /* LINTED */
-       "Xr",           "\%A",          "\%B",          "\%D",
-       /* LINTED */
-       "\%I",          "\%J",          "\%N",          "\%O",
-       /* LINTED */
-       "\%P",          "\%R",          "\%T",          "\%V",
+       "Xr",           "%A",           "%B",           "%D",
+       "%I",           "%J",           "%N",           "%O",
+       "%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,704 +63,420 @@ 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",
-       /* LINTED */
-       "Bro",          "Brc",          "\%C",          "Es",
-       /* LINTED */
-       "En",           "Dx",           "\%Q"
-       };
+       "Fr",           "Ud",           "Lb",           "Lp",
+       "Lk",           "Mt",           "Brq",          "Bro",
+       "Brc",          "%C",           "Es",           "En",
+       "Dx",           "%Q",           "br",           "sp",
+       "%U",           "Ta",           "ll",
+};

 
 

-const  char *const __mdoc_argnames[MDOC_ARG_MAX] = {            
+const  char *const __mdoc_argnames[MDOC_ARG_MAX] = {

        "split",                "nosplit",              "ragged",
        "split",                "nosplit",              "ragged",

-       "unfilled",             "literal",              "file",          
-       "offset",               "bullet",               "dash",          
-       "hyphen",               "item",                 "enum",          
-       "tag",                  "diag",                 "hang",          
-       "ohang",                "inset",                "column",        
-       "width",                "compact",              "std",   
+       "unfilled",             "literal",              "file",
+       "offset",               "bullet",               "dash",
+       "hyphen",               "item",                 "enum",
+       "tag",                  "diag",                 "hang",
+       "ohang",                "inset",                "column",
+       "width",                "compact",              "std",

        "filled",               "words",                "emphasis",
        "filled",               "words",                "emphasis",

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

        };
 
        };
 

-const  char * const *mdoc_macronames = __mdoc_macronames;
+const  char * const *mdoc_macronames = __mdoc_macronames + 1;

 const  char * const *mdoc_argnames = __mdoc_argnames;
 
 const  char * const *mdoc_argnames = __mdoc_argnames;
 

-static void              mdoc_free1(struct mdoc *);
-static int               mdoc_alloc1(struct mdoc *);
-static struct mdoc_node *node_alloc(struct mdoc *, int, int, 
-                               int, enum mdoc_type);
-static int               node_append(struct mdoc *, 
-                               struct mdoc_node *);
-static int               parsetext(struct mdoc *, int, char *);
-static int               parsemacro(struct mdoc *, int, char *);
-static int               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))
-
-/*
- * Get the first (root) node of the parse tree.
- */
-const struct mdoc_node *
-mdoc_node(const struct mdoc *m)
-{
-
-       return(MDOC_HALT & m->flags ? NULL : m->first);
-}
-
-
-const struct mdoc_meta *
-mdoc_meta(const struct mdoc *m)
-{
-
-       return(MDOC_HALT & m->flags ? NULL : &m->meta);
-}
-
-
-static void
-mdoc_free1(struct mdoc *mdoc)
-{
-
-       if (mdoc->first)
-               mdoc_node_freelist(mdoc->first);
-       if (mdoc->meta.title)
-               free(mdoc->meta.title);
-       if (mdoc->meta.os)
-               free(mdoc->meta.os);
-       if (mdoc->meta.name)
-               free(mdoc->meta.name);
-       if (mdoc->meta.arch)
-               free(mdoc->meta.arch);
-       if (mdoc->meta.vol)
-               free(mdoc->meta.vol);
-}
-
-
-static int
-mdoc_alloc1(struct mdoc *mdoc)
-{
-
-       bzero(&mdoc->meta, sizeof(struct mdoc_meta));
-       mdoc->flags = 0;
-       mdoc->lastnamed = mdoc->lastsec = 0;
-       mdoc->last = calloc(1, sizeof(struct mdoc_node));
-       if (NULL == mdoc->last)
-               return(0);
-
-       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.
- */
-int
-mdoc_reset(struct mdoc *mdoc)
-{
-
-       mdoc_free1(mdoc);
-       return(mdoc_alloc1(mdoc));
-}
-
-
-/*
- * Completely free up all resources.
- */
-void
-mdoc_free(struct mdoc *mdoc)
-{
-
-       mdoc_free1(mdoc);
-       if (mdoc->htab)
-               mdoc_hash_free(mdoc->htab);
-       free(mdoc);
-}
-
-
-struct mdoc *
-mdoc_alloc(void *data, int pflags, const struct mdoc_cb *cb)
-{
-       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;
-
-       if (NULL == (p->htab = mdoc_hash_alloc())) {
-               free(p);
-               return(NULL);
-       } else if (mdoc_alloc1(p))
-               return(p);
-
-       free(p);
-       return(NULL);
-}
-
-
-/*
- * Climb back up the parse tree, validating open scopes.  Mostly calls
- * through to macro_end in macro.c.
- */
-int
-mdoc_endparse(struct mdoc *m)
-{
-
-       if (MDOC_HALT & m->flags)
-               return(0);
-       else if (mdoc_macroend(m))
-               return(1);
-       m->flags |= MDOC_HALT;
-       return(0);
-}
+static int               mdoc_ptext(struct roff_man *, int, char *, int);
+static int               mdoc_pmacro(struct roff_man *, int, char *, int);

 
 
 /*
  * Main parse routine.  Parses a single line -- really just hands off to
 
 
 /*
  * Main parse routine.  Parses a single line -- really just hands off to

- * the macro or text parser.
+ * the macro (mdoc_pmacro()) or text parser (mdoc_ptext()).

  */
 int
  */
 int

-mdoc_parseln(struct mdoc *m, int ln, char *buf)
+mdoc_parseln(struct roff_man *mdoc, int ln, char *buf, int offs)

 {
 
 {
 

-       /* If in error-mode, then we parse no more. */
+       if (mdoc->last->type != ROFFT_EQN || ln > mdoc->last->line)
+               mdoc->flags |= MDOC_NEWLINE;

 
 

-       if (MDOC_HALT & m->flags)
-               return(0);
+       /*
+        * 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_getreg(mdoc->roff, "nS"))
+               mdoc->flags |= MDOC_SYNOPSIS;
+       else
+               mdoc->flags &= ~MDOC_SYNOPSIS;

 
 

-       return('.' == *buf ? parsemacro(m, ln, buf) :
-                       parsetext(m, ln, buf));
+       return roff_getcontrol(mdoc->roff, buf, &offs) ?
+           mdoc_pmacro(mdoc, ln, buf, offs) :
+           mdoc_ptext(mdoc, ln, buf, offs);

 }
 
 }
 

-

 void
 void

-mdoc_vmsg(struct mdoc *mdoc, int ln, int pos, const char *fmt, ...)
-{
-       char              buf[256];
-       va_list           ap;
-
-       if (NULL == mdoc->cb.mdoc_msg)
-               return;
-
-       va_start(ap, fmt);
-       (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
-       va_end(ap);
-       (*mdoc->cb.mdoc_msg)(mdoc->data, ln, pos, buf);
-}
-
-
-int
-mdoc_verr(struct mdoc *mdoc, int ln, int pos, 
-               const char *fmt, ...)
+mdoc_macro(MACRO_PROT_ARGS)

 {
 {

-       char             buf[256];
-       va_list          ap;
-
-       if (NULL == mdoc->cb.mdoc_err)
-               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));
-}
-
-
-int
-mdoc_vwarn(struct mdoc *mdoc, int ln, int pos, 
-               enum mdoc_warn type, const char *fmt, ...)
-{
-       char             buf[256];
-       va_list          ap;
-
-       if (NULL == mdoc->cb.mdoc_warn)
-               return(0);
+       assert(tok > TOKEN_NONE && tok < MDOC_MAX);

 
 

-       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));
+       (*mdoc_macros[tok].fp)(mdoc, tok, line, ppos, pos, buf);

 }
 
 }
 

-
-int
-mdoc_nerr(struct mdoc *mdoc, const struct mdoc_node *node, const char *fmt, ...)
+void
+mdoc_tail_alloc(struct roff_man *mdoc, int line, int pos, int tok)

 {
 {

-       char             buf[256];
-       va_list          ap;
-
-       if (NULL == mdoc->cb.mdoc_err)
-               return(0);
+       struct roff_node *p;

 
 

-       va_start(ap, fmt);
-       (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
-       va_end(ap);
-       return((*mdoc->cb.mdoc_err)(mdoc->data, node->line, node->pos, buf));
+       p = roff_node_alloc(mdoc, line, pos, ROFFT_TAIL, tok);
+       roff_node_append(mdoc, p);
+       mdoc->next = ROFF_NEXT_CHILD;

 }
 
 }
 

-
-int
-mdoc_warn(struct mdoc *mdoc, enum mdoc_warn type, const char *fmt, ...)
+struct roff_node *
+mdoc_endbody_alloc(struct roff_man *mdoc, int line, int pos, int tok,
+               struct roff_node *body)

 {
 {

-       char             buf[256];
-       va_list          ap;
+       struct roff_node *p;

 
 

-       if (NULL == mdoc->cb.mdoc_warn)
-               return(0);
-
-       va_start(ap, fmt);
-       (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
-       va_end(ap);
-       return((*mdoc->cb.mdoc_warn)(mdoc->data, mdoc->last->line,
-           mdoc->last->pos, type, buf));
+       body->flags |= NODE_ENDED;
+       body->parent->flags |= NODE_ENDED;
+       p = roff_node_alloc(mdoc, line, pos, ROFFT_BODY, tok);
+       p->body = body;
+       p->norm = body->norm;
+       p->end = ENDBODY_SPACE;
+       roff_node_append(mdoc, p);
+       mdoc->next = ROFF_NEXT_SIBLING;
+       return p;

 }
 
 }
 

-
-int
-mdoc_err(struct mdoc *mdoc, const char *fmt, ...)
+struct roff_node *
+mdoc_block_alloc(struct roff_man *mdoc, int line, int pos,
+       int tok, struct mdoc_arg *args)

 {
 {

-       char             buf[256];
-       va_list          ap;
+       struct roff_node *p;

 
 

-       if (NULL == mdoc->cb.mdoc_err)
-               return(0);
+       p = roff_node_alloc(mdoc, line, pos, ROFFT_BLOCK, tok);
+       p->args = args;
+       if (p->args)
+               (args->refcnt)++;

 
 

-       va_start(ap, fmt);
-       (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
-       va_end(ap);
-       return((*mdoc->cb.mdoc_err)(mdoc->data, mdoc->last->line,
-           mdoc->last->pos, buf));
+       switch (tok) {
+       case MDOC_Bd:
+       case MDOC_Bf:
+       case MDOC_Bl:
+       case MDOC_En:
+       case MDOC_Rs:
+               p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
+               break;
+       default:
+               break;
+       }
+       roff_node_append(mdoc, p);
+       mdoc->next = ROFF_NEXT_CHILD;
+       return p;

 }
 
 }
 

-

 void
 void

-mdoc_msg(struct mdoc *mdoc, const char *fmt, ...)
+mdoc_elem_alloc(struct roff_man *mdoc, int line, int pos,
+       int tok, struct mdoc_arg *args)

 {
 {

-       char              buf[256];
-       va_list           ap;
+       struct roff_node *p;

 
 

-       if (NULL == mdoc->cb.mdoc_msg)
-               return;
+       p = roff_node_alloc(mdoc, line, pos, ROFFT_ELEM, tok);
+       p->args = args;
+       if (p->args)
+               (args->refcnt)++;

 
 

-       va_start(ap, fmt);
-       (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
-       va_end(ap);
-       (*mdoc->cb.mdoc_msg)(mdoc->data, mdoc->last->line, mdoc->last->pos,
-           buf);
+       switch (tok) {
+       case MDOC_An:
+               p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
+               break;
+       default:
+               break;
+       }
+       roff_node_append(mdoc, p);
+       mdoc->next = ROFF_NEXT_CHILD;

 }
 
 }
 

-

 void
 void

-mdoc_pmsg(struct mdoc *mdoc, int line, int pos, const char *fmt, ...)
-{
-       char              buf[256];
-       va_list           ap;
-
-       if (NULL == mdoc->cb.mdoc_msg)
-               return;
-
-       va_start(ap, fmt);
-       (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
-       va_end(ap);
-       (*mdoc->cb.mdoc_msg)(mdoc->data, line, pos, buf);
-}
-
-
-int
-mdoc_pwarn(struct mdoc *mdoc, int line, int pos, enum mdoc_warn type,
-               const char *fmt, ...)
+mdoc_node_relink(struct roff_man *mdoc, struct roff_node *p)

 {
 {

-       char             buf[256];
-       va_list          ap;

 
 

-       if (NULL == mdoc->cb.mdoc_warn)
-               return(0);
-
-       va_start(ap, fmt);
-       (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
-       va_end(ap);
-       return((*mdoc->cb.mdoc_warn)(mdoc->data, line, pos, type, buf));
+       roff_node_unlink(mdoc, p);
+       p->prev = p->next = NULL;
+       roff_node_append(mdoc, p);

 }
 
 }
 

-int
-mdoc_perr(struct mdoc *mdoc, int line, int pos, const char *fmt, ...)
-{
-       char             buf[256];
-       va_list          ap;
-
-       if (NULL == mdoc->cb.mdoc_err)
-               return(0);
+/*
+ * Parse free-form text, that is, a line that does not begin with the
+ * control character.
+ */
+static int
+mdoc_ptext(struct roff_man *mdoc, int line, char *buf, int offs)
+{
+       struct roff_node *n;
+       char             *c, *ws, *end;
+
+       n = mdoc->last;
+
+       /*
+        * If a column list contains plain text, assume an implicit item
+        * macro.  This can happen one or more times at the beginning
+        * of such a list, intermixed with non-It mdoc macros and with
+        * nodes generated on the roff level, for example by tbl.
+        */
+
+       if ((n->tok == MDOC_Bl && n->type == ROFFT_BODY &&
+            n->end == ENDBODY_NOT && n->norm->Bl.type == LIST_column) ||
+           (n->parent != NULL && n->parent->tok == MDOC_Bl &&
+            n->parent->norm->Bl.type == LIST_column)) {
+               mdoc->flags |= MDOC_FREECOL;
+               mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf);
+               return 1;
+       }

 
 

-       va_start(ap, fmt);
-       (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
-       va_end(ap);
-       return((*mdoc->cb.mdoc_err)(mdoc->data, line, pos, 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)
+               mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse,
+                   line, (int)(ws-buf), NULL);
+
+       if (buf[offs] == '\0' && ! (mdoc->flags & MDOC_LITERAL)) {
+               mandoc_msg(MANDOCERR_FI_BLANK, mdoc->parse,
+                   line, (int)(c - buf), NULL);
+
+               /*
+                * 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.
+                */
+               roff_elem_alloc(mdoc, line, offs, MDOC_sp);
+               mdoc->last->flags |= NODE_VALID | NODE_ENDED;
+               mdoc->next = ROFF_NEXT_SIBLING;
+               return 1;
+       }

 
 

+       roff_word_alloc(mdoc, line, offs, buf+offs);

 
 

-int
-mdoc_macro(struct mdoc *m, int tok, 
-               int ln, int pp, int *pos, char *buf)
-{
+       if (mdoc->flags & MDOC_LITERAL)
+               return 1;

 
 

-       /* FIXME - these should happen during validation. */
+       /*
+        * 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.
+        */

 
 

-       if (MDOC_PROLOGUE & mdoc_macros[tok].flags && 
-                       SEC_PROLOGUE != m->lastnamed)
-               return(perr(m, ln, pp, EPROLBODY));
+       assert(buf < end);

 
 

-       if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) && 
-                       SEC_PROLOGUE == m->lastnamed)
-               return(perr(m, ln, pp, EBODYPROL));
+       if (mandoc_eos(buf+offs, (size_t)(end-buf-offs)))
+               mdoc->last->flags |= NODE_EOS;

 
 

-       if (1 != pp && ! (MDOC_CALLABLE & mdoc_macros[tok].flags))
-               return(perr(m, ln, pp, ENOCALL));
+       for (c = buf + offs; c != NULL; c = strchr(c + 1, '.')) {
+               if (c - buf < offs + 2)
+                       continue;
+               if (end - c < 4)
+                       break;
+               if (isalpha((unsigned char)c[-2]) &&
+                   isalpha((unsigned char)c[-1]) &&
+                   c[1] == ' ' &&
+                   isupper((unsigned char)(c[2] == ' ' ? c[3] : c[2])) &&
+                   (c[-2] != 'n' || c[-1] != 'c') &&
+                   (c[-2] != 'v' || c[-1] != 's'))
+                       mandoc_msg(MANDOCERR_EOS, mdoc->parse,
+                           line, (int)(c - buf), NULL);
+       }

 
 

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

 }
 
 }
 

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

 static int
 static int

-perr(struct mdoc *m, int line, int pos, enum merr type)
+mdoc_pmacro(struct roff_man *mdoc, int ln, char *buf, int offs)

 {
 {

-       char            *p;
+       struct roff_node *n;
+       const char       *cp;
+       int               tok;
+       int               i, sv;
+       char              mac[5];

 
 

-       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;
-       }
-       assert(p);
-       return(mdoc_perr(m, line, pos, p));
-}
+       sv = offs;

 
 

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

 
 

-static int
-node_append(struct mdoc *mdoc, struct mdoc_node *p)
-{
+       i = 0;
+       while (i < 4 && strchr(" \t\\", buf[offs]) == NULL)
+               mac[i++] = buf[offs++];

 
 

-       assert(mdoc->last);
-       assert(mdoc->first);
-       assert(MDOC_ROOT != p->type);
+       mac[i] = '\0';

 
 

-       switch (mdoc->next) {
-       case (MDOC_NEXT_SIBLING):
-               mdoc->last->next = p;
-               p->prev = mdoc->last;
-               p->parent = mdoc->last->parent;
-               break;
-       case (MDOC_NEXT_CHILD):
-               mdoc->last->child = p;
-               p->parent = mdoc->last;
-               break;
-       default:
-               abort();
-               /* NOTREACHED */
+       tok = (i > 1 && i < 4) ? mdoc_hash_find(mac) : TOKEN_NONE;
+
+       if (tok == TOKEN_NONE) {
+               mandoc_msg(MANDOCERR_MACRO, mdoc->parse,
+                   ln, sv, buf + sv - 1);
+               return 1;

        }
 
        }
 

-       if ( ! mdoc_valid_pre(mdoc, p))
-               return(0);
-       if ( ! mdoc_action_pre(mdoc, p))
-               return(0);
+       /* Skip a leading escape sequence or tab. */

 
 

-       switch (p->type) {
-       case (MDOC_HEAD):
-               assert(MDOC_BLOCK == p->parent->type);
-               p->parent->head = p;
-               break;
-       case (MDOC_TAIL):
-               assert(MDOC_BLOCK == p->parent->type);
-               p->parent->tail = p;
+       switch (buf[offs]) {
+       case '\\':
+               cp = buf + offs + 1;
+               mandoc_escape(&cp, NULL, NULL);
+               offs = cp - buf;

                break;
                break;

-       case (MDOC_BODY):
-               assert(MDOC_BLOCK == p->parent->type);
-               p->parent->body = p;
+       case '\t':
+               offs++;

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

-       mdoc->last = p;
+       /* Jump to the next non-whitespace word. */

 
 

-       switch (p->type) {
-       case (MDOC_TEXT):
-               if ( ! mdoc_valid_post(mdoc))
-                       return(0);
-               if ( ! mdoc_action_post(mdoc))
-                       return(0);
-               break;
-       default:
-               break;
-       }
+       while (buf[offs] && ' ' == buf[offs])
+               offs++;

 
 

-       return(1);
-}
+       /*
+        * 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])
+               mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse,
+                   ln, offs - 1, NULL);

 
 

-static struct mdoc_node *
-node_alloc(struct mdoc *mdoc, int line, 
-               int pos, int tok, enum mdoc_type type)
-{
-       struct mdoc_node *p;
+       /*
+        * If an initial macro or a list invocation, divert directly
+        * into macro processing.
+        */

 
 

-       if (NULL == (p = calloc(1, sizeof(struct mdoc_node)))) {
-               (void)verr(mdoc, EMALLOC);
-               return(NULL);
+       n = mdoc->last;
+       if (n == NULL || tok == MDOC_It || tok == MDOC_El) {
+               mdoc_macro(mdoc, tok, ln, sv, &offs, buf);
+               return 1;

        }
 
        }
 

-       p->sec = mdoc->lastsec;
-       p->line = line;
-       p->pos = pos;
-       p->tok = tok;
-       if (MDOC_TEXT != (p->type = type))
-               assert(p->tok >= 0);
-
-       return(p);
-}
-
-
-int
-mdoc_tail_alloc(struct mdoc *mdoc, int line, int pos, int tok)
-{
-       struct mdoc_node *p;
-
-       p = node_alloc(mdoc, line, pos, tok, MDOC_TAIL);
-       if (NULL == p)
-               return(0);
-       return(node_append(mdoc, p));
-}
-
-
-int
-mdoc_head_alloc(struct mdoc *mdoc, int line, int pos, int tok)
-{
-       struct mdoc_node *p;
-
-       assert(mdoc->first);
-       assert(mdoc->last);
-
-       p = node_alloc(mdoc, line, pos, tok, MDOC_HEAD);
-       if (NULL == p)
-               return(0);
-       return(node_append(mdoc, p));
-}
-
-
-int
-mdoc_body_alloc(struct mdoc *mdoc, int line, int pos, int tok)
-{
-       struct mdoc_node *p;
-
-       p = node_alloc(mdoc, line, pos, tok, MDOC_BODY);
-       if (NULL == p)
-               return(0);
-       return(node_append(mdoc, p));
-}
-
-
-int
-mdoc_block_alloc(struct mdoc *mdoc, int line, int pos, 
-               int tok, struct mdoc_arg *args)
-{
-       struct mdoc_node *p;
-
-       p = node_alloc(mdoc, line, pos, tok, MDOC_BLOCK);
-       if (NULL == p)
-               return(0);
-       p->args = args;
-       if (p->args)
-               (args->refcnt)++;
-       return(node_append(mdoc, p));
-}
-
-
-int
-mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos, 
-               int tok, struct mdoc_arg *args)
-{
-       struct mdoc_node *p;
-
-       p = node_alloc(mdoc, line, pos, tok, MDOC_ELEM);
-       if (NULL == p)
-               return(0);
-       p->args = args;
-       if (p->args)
-               (args->refcnt)++;
-       return(node_append(mdoc, p));
-}
-
-
-int
-mdoc_word_alloc(struct mdoc *mdoc, 
-               int line, int pos, const char *word)
-{
-       struct mdoc_node *p;
-
-       p = node_alloc(mdoc, line, pos, -1, MDOC_TEXT);
-       if (NULL == p)
-               return(0);
-       if (NULL == (p->string = strdup(word))) {
-               (void)verr(mdoc, EMALLOC);
-               return(0);
+       /*
+        * If a column list contains a non-It macro, assume an implicit
+        * item macro.  This can happen one or more times at the
+        * beginning of such a list, intermixed with text lines and
+        * with nodes generated on the roff level, for example by tbl.
+        */
+
+       if ((n->tok == MDOC_Bl && n->type == ROFFT_BODY &&
+            n->end == ENDBODY_NOT && n->norm->Bl.type == LIST_column) ||
+           (n->parent != NULL && n->parent->tok == MDOC_Bl &&
+            n->parent->norm->Bl.type == LIST_column)) {
+               mdoc->flags |= MDOC_FREECOL;
+               mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf);
+               return 1;

        }
        }

-       return(node_append(mdoc, p));
-}

 
 

+       /* Normal processing of a macro. */

 
 

-void
-mdoc_node_free(struct mdoc_node *p)
-{
-
-       if (p->string)
-               free(p->string);
-       if (p->args)
-               mdoc_argv_free(p->args);
-       free(p);
-}
-
+       mdoc_macro(mdoc, tok, ln, sv, &offs, buf);

 
 

-void
-mdoc_node_freelist(struct mdoc_node *p)
-{
+       /* In quick mode (for mandocdb), abort after the NAME section. */

 
 

-       if (p->child)
-               mdoc_node_freelist(p->child);
-       if (p->next)
-               mdoc_node_freelist(p->next);
+       if (mdoc->quick && MDOC_Sh == tok &&
+           SEC_NAME != mdoc->last->sec)
+               return 2;

 
 

-       mdoc_node_free(p);
+       return 1;

 }
 
 }
 

-
-/*
- * Parse free-form text, that is, a line that does not begin with the
- * control character.
- */
-static int
-parsetext(struct mdoc *m, int line, char *buf)
+enum mdelim
+mdoc_isdelim(const char *p)

 {
 
 {
 

-       if (SEC_PROLOGUE == m->lastnamed)
-               return(perr(m, line, 0, ETEXTPROL));
+       if ('\0' == p[0])
+               return DELIM_NONE;

 
 

-       if (0 == buf[0] && ! (MDOC_LITERAL & m->flags))
-               return(perr(m, line, 0, ENOBLANK));
+       if ('\0' == p[1])
+               switch (p[0]) {
+               case '(':
+               case '[':
+                       return DELIM_OPEN;
+               case '|':
+                       return DELIM_MIDDLE;
+               case '.':
+               case ',':
+               case ';':
+               case ':':
+               case '?':
+               case '!':
+               case ')':
+               case ']':
+                       return DELIM_CLOSE;
+               default:
+                       return DELIM_NONE;
+               }

 
 

-       if ( ! mdoc_word_alloc(m, line, 0, buf))
-               return(0);
+       if ('\\' != p[0])
+               return DELIM_NONE;

 
 

-       m->next = MDOC_NEXT_SIBLING;
-       return(1);
-}
+       if (0 == strcmp(p + 1, "."))
+               return DELIM_CLOSE;
+       if (0 == strcmp(p + 1, "fR|\\fP"))
+               return DELIM_MIDDLE;

 
 

-
-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 ? "..." : ""));
+       return DELIM_NONE;

 }
 
 }
 

-
-
-/*
- * Parse a macro line, that is, a line beginning with the control
- * character.
- */
-int
-parsemacro(struct mdoc *m, int ln, char *buf)
+void
+mdoc_validate(struct roff_man *mdoc)

 {
 {

-       int               i, c;
-       char              mac[5];
-
-       /* Comments and empties are quickly ignored. */
-
-       if (0 == buf[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));
-       }
-
-       if (buf[1] && '\\' == buf[1])
-               if (buf[2] && '\"' == buf[2])
-                       return(1);
-
-       /* Copy the first word into a nil-terminated buffer. */
-
-       for (i = 1; i < 5; i++) {
-               if (0 == (mac[i - 1] = buf[i]))
-                       break;
-               else if (' ' == buf[i])
-                       break;
-       }
-
-       mac[i - 1] = 0;
-
-       if (i == 5 || i <= 2) {
-               if ( ! macrowarn(m, ln, mac))
-                       goto err;
-               return(1);
-       } 
-       
-       if (MDOC_MAX == (c = mdoc_hash_find(m->htab, mac))) {
-               if ( ! macrowarn(m, ln, mac))
-                       goto err;
-               return(1);
-       }
-
-       /* The macro is sane.  Jump to the next word. */
-
-       while (buf[i] && ' ' == buf[i])
-               i++;
-
-       /* Begin recursive parse sequence. */
-
-       if ( ! mdoc_macro(m, c, ln, 1, &i, buf)) 
-               goto err;
-
-       return(1);
-
-err:   /* Error out. */

 
 

-       m->flags |= MDOC_HALT;
-       return(0);
+       mdoc->last = mdoc->first;
+       mdoc_node_validate(mdoc);
+       mdoc_state_reset(mdoc);

 }
 }