]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc.c
Unify some node handling functions that use TOKEN_NONE.
[mandoc.git] / mdoc.c
diff --git a/mdoc.c b/mdoc.c
index 278e301e7ebef45ab89541a5eb799b70a84cf8c1..a397fafcfd64723534ab2fb2fc2d6083f285d4a4 100644 (file)
--- a/mdoc.c
+++ b/mdoc.c
@@ -1,15 +1,15 @@
-/*     $Id: mdoc.c,v 1.235 2015/02/02 04:26:44 schwarze Exp $ */
+/*     $Id: mdoc.c,v 1.249 2015/04/19 14:25:41 schwarze Exp $ */
 /*
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2010, 2012, 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2010, 2012-2015 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.
  *
- * 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
- * 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
 #include <string.h>
 #include <time.h>
 
-#include "mdoc.h"
-#include "mandoc.h"
 #include "mandoc_aux.h"
-#include "libmdoc.h"
+#include "mandoc.h"
+#include "roff.h"
+#include "mdoc.h"
 #include "libmandoc.h"
+#include "roff_int.h"
+#include "libmdoc.h"
 
 const  char *const __mdoc_macronames[MDOC_MAX + 1] = {
+       "text",
        "Ap",           "Dd",           "Dt",           "Os",
        "Sh",           "Ss",           "Pp",           "D1",
        "Dl",           "Bd",           "Ed",           "Bl",
@@ -64,8 +67,8 @@ const char *const __mdoc_macronames[MDOC_MAX + 1] = {
        "Lk",           "Mt",           "Brq",          "Bro",
        "Brc",          "%C",           "Es",           "En",
        "Dx",           "%Q",           "br",           "sp",
-       "%U",           "Ta",           "ll",           "text",
-       };
+       "%U",           "Ta",           "ll",
+};
 
 const  char *const __mdoc_argnames[MDOC_ARG_MAX] = {
        "split",                "nosplit",              "ragged",
@@ -79,157 +82,29 @@ const      char *const __mdoc_argnames[MDOC_ARG_MAX] = {
        "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;
 
-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 void              node_append(struct mdoc *, struct mdoc_node *);
-static int               mdoc_ptext(struct mdoc *, int, char *, int);
-static int               mdoc_pmacro(struct mdoc *, int, char *, int);
-
-
-const struct mdoc_node *
-mdoc_node(const struct mdoc *mdoc)
-{
-
-       return(mdoc->first);
-}
-
-const struct mdoc_meta *
-mdoc_meta(const struct mdoc *mdoc)
-{
-
-       return(&mdoc->meta);
-}
+static int               mdoc_ptext(struct roff_man *, int, char *, int);
+static int               mdoc_pmacro(struct roff_man *, int, char *, int);
 
-/*
- * Frees volatile resources (parse tree, meta-data, fields).
- */
-static void
-mdoc_free1(struct mdoc *mdoc)
-{
 
-       if (mdoc->first)
-               mdoc_node_delete(mdoc, mdoc->first);
-       free(mdoc->meta.msec);
-       free(mdoc->meta.vol);
-       free(mdoc->meta.arch);
-       free(mdoc->meta.date);
-       free(mdoc->meta.title);
-       free(mdoc->meta.os);
-       free(mdoc->meta.name);
-}
-
-/*
- * 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);
-}
-
-/*
- * Allocate volatile and non-volatile parse resources.
- */
-struct mdoc *
-mdoc_alloc(struct roff *roff, struct mparse *parse,
-       const char *defos, int quick)
-{
-       struct mdoc     *p;
-
-       p = mandoc_calloc(1, sizeof(struct mdoc));
-
-       p->parse = parse;
-       p->defos = defos;
-       p->quick = quick;
-       p->roff = roff;
-
-       mdoc_hash_init();
-       mdoc_alloc1(p);
-       return(p);
-}
-
-void
-mdoc_endparse(struct mdoc *mdoc)
+mdoc_endparse(struct roff_man *mdoc)
 {
 
        mdoc_macroend(mdoc);
 }
 
-void
-mdoc_addeqn(struct mdoc *mdoc, const struct eqn *ep)
-{
-       struct mdoc_node *n;
-
-       n = node_alloc(mdoc, ep->ln, ep->pos, MDOC_MAX, MDOC_EQN);
-       n->eqn = ep;
-       if (ep->ln > mdoc->last->line)
-               n->flags |= MDOC_LINE;
-       node_append(mdoc, n);
-       mdoc->next = MDOC_NEXT_SIBLING;
-}
-
-void
-mdoc_addspan(struct mdoc *mdoc, const struct tbl_span *sp)
-{
-       struct mdoc_node *n;
-
-       n = node_alloc(mdoc, sp->line, 0, MDOC_MAX, MDOC_TBL);
-       n->span = sp;
-       node_append(mdoc, n);
-       mdoc->next = MDOC_NEXT_SIBLING;
-}
-
 /*
  * Main parse routine.  Parses a single line -- really just hands off to
  * the macro (mdoc_pmacro()) or text parser (mdoc_ptext()).
  */
 int
-mdoc_parseln(struct mdoc *mdoc, int ln, char *buf, int offs)
+mdoc_parseln(struct roff_man *mdoc, int ln, char *buf, int offs)
 {
 
-       if (mdoc->last->type != MDOC_EQN || ln > mdoc->last->line)
+       if (mdoc->last->type != ROFFT_EQN || ln > mdoc->last->line)
                mdoc->flags |= MDOC_NEWLINE;
 
        /*
@@ -251,7 +126,7 @@ mdoc_parseln(struct mdoc *mdoc, int ln, char *buf, int offs)
 void
 mdoc_macro(MACRO_PROT_ARGS)
 {
-       assert(tok < MDOC_MAX);
+       assert(tok > TOKEN_NONE && tok < MDOC_MAX);
 
        if (mdoc->flags & MDOC_PBODY) {
                if (tok == MDOC_Dt) {
@@ -274,168 +149,40 @@ mdoc_macro(MACRO_PROT_ARGS)
        (*mdoc_macros[tok].fp)(mdoc, tok, line, ppos, pos, buf);
 }
 
-
-static void
-node_append(struct mdoc *mdoc, struct mdoc_node *p)
-{
-
-       assert(mdoc->last);
-       assert(mdoc->first);
-       assert(MDOC_ROOT != p->type);
-
-       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 */
-       }
-
-       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;
-       }
-
-       mdoc_valid_pre(mdoc, p);
-
-       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;
-               break;
-       case MDOC_BODY:
-               if (p->end)
-                       break;
-               assert(MDOC_BLOCK == p->parent->type);
-               p->parent->body = p;
-               break;
-       default:
-               break;
-       }
-
-       mdoc->last = p;
-
-       switch (p->type) {
-       case MDOC_TBL:
-               /* FALLTHROUGH */
-       case MDOC_TEXT:
-               mdoc_valid_post(mdoc);
-               break;
-       default:
-               break;
-       }
-}
-
-static struct mdoc_node *
-node_alloc(struct mdoc *mdoc, int line, int pos,
-               enum mdoct tok, enum mdoc_type type)
-{
-       struct mdoc_node *p;
-
-       p = mandoc_calloc(1, sizeof(struct mdoc_node));
-       p->sec = mdoc->lastsec;
-       p->line = line;
-       p->pos = pos;
-       p->lastline = line;
-       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);
-}
-
 void
-mdoc_tail_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok)
+mdoc_tail_alloc(struct roff_man *mdoc, int line, int pos, int tok)
 {
-       struct mdoc_node *p;
+       struct roff_node *p;
 
-       p = node_alloc(mdoc, line, pos, tok, MDOC_TAIL);
-       node_append(mdoc, p);
-       mdoc->next = MDOC_NEXT_CHILD;
+       p = roff_node_alloc(mdoc, line, pos, ROFFT_TAIL, tok);
+       roff_node_append(mdoc, p);
+       mdoc->next = ROFF_NEXT_CHILD;
 }
 
-struct mdoc_node *
-mdoc_head_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok)
+struct roff_node *
+mdoc_endbody_alloc(struct roff_man *mdoc, int line, int pos, int tok,
+               struct roff_node *body, enum mdoc_endbody end)
 {
-       struct mdoc_node *p;
-
-       assert(mdoc->first);
-       assert(mdoc->last);
-       p = node_alloc(mdoc, line, pos, tok, MDOC_HEAD);
-       node_append(mdoc, p);
-       mdoc->next = MDOC_NEXT_CHILD;
-       return(p);
-}
-
-struct mdoc_node *
-mdoc_body_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok)
-{
-       struct mdoc_node *p;
-
-       p = node_alloc(mdoc, line, pos, tok, MDOC_BODY);
-       node_append(mdoc, p);
-       mdoc->next = MDOC_NEXT_CHILD;
-       return(p);
-}
+       struct roff_node *p;
 
-struct mdoc_node *
-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;
-
-       p = node_alloc(mdoc, line, pos, tok, MDOC_BODY);
-       p->pending = body;
+       body->flags |= MDOC_ENDED;
+       body->parent->flags |= MDOC_ENDED;
+       p = roff_node_alloc(mdoc, line, pos, ROFFT_BODY, tok);
+       p->body = body;
        p->norm = body->norm;
        p->end = end;
-       node_append(mdoc, p);
-       mdoc->next = MDOC_NEXT_SIBLING;
+       roff_node_append(mdoc, p);
+       mdoc->next = ROFF_NEXT_SIBLING;
        return(p);
 }
 
-struct mdoc_node *
-mdoc_block_alloc(struct mdoc *mdoc, int line, int pos,
-               enum mdoct tok, struct mdoc_arg *args)
+struct roff_node *
+mdoc_block_alloc(struct roff_man *mdoc, int line, int pos,
+       int tok, struct mdoc_arg *args)
 {
-       struct mdoc_node *p;
+       struct roff_node *p;
 
-       p = node_alloc(mdoc, line, pos, tok, MDOC_BLOCK);
+       p = roff_node_alloc(mdoc, line, pos, ROFFT_BLOCK, tok);
        p->args = args;
        if (p->args)
                (args->refcnt)++;
@@ -455,18 +202,18 @@ mdoc_block_alloc(struct mdoc *mdoc, int line, int pos,
        default:
                break;
        }
-       node_append(mdoc, p);
-       mdoc->next = MDOC_NEXT_CHILD;
+       roff_node_append(mdoc, p);
+       mdoc->next = ROFF_NEXT_CHILD;
        return(p);
 }
 
 void
-mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos,
-               enum mdoct tok, struct mdoc_arg *args)
+mdoc_elem_alloc(struct roff_man *mdoc, int line, int pos,
+       int tok, struct mdoc_arg *args)
 {
-       struct mdoc_node *p;
+       struct roff_node *p;
 
-       p = node_alloc(mdoc, line, pos, tok, MDOC_ELEM);
+       p = roff_node_alloc(mdoc, line, pos, ROFFT_ELEM, tok);
        p->args = args;
        if (p->args)
                (args->refcnt)++;
@@ -478,106 +225,16 @@ mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos,
        default:
                break;
        }
-       node_append(mdoc, p);
-       mdoc->next = MDOC_NEXT_CHILD;
-}
-
-void
-mdoc_word_alloc(struct mdoc *mdoc, int line, int pos, const char *p)
-{
-       struct mdoc_node *n;
-
-       n = node_alloc(mdoc, line, pos, MDOC_MAX, MDOC_TEXT);
-       n->string = roff_strdup(mdoc->roff, p);
-       node_append(mdoc, n);
-       mdoc->next = MDOC_NEXT_SIBLING;
-}
-
-void
-mdoc_word_append(struct mdoc *mdoc, const char *p)
-{
-       struct mdoc_node        *n;
-       char                    *addstr, *newstr;
-
-       n = mdoc->last;
-       addstr = roff_strdup(mdoc->roff, p);
-       mandoc_asprintf(&newstr, "%s %s", n->string, addstr);
-       free(addstr);
-       free(n->string);
-       n->string = newstr;
-       mdoc->next = MDOC_NEXT_SIBLING;
-}
-
-static void
-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)
-               mdoc_argv_free(p->args);
-       free(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
-mdoc_node_delete(struct mdoc *mdoc, struct mdoc_node *p)
-{
-
-       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);
+       roff_node_append(mdoc, p);
+       mdoc->next = ROFF_NEXT_CHILD;
 }
 
 void
-mdoc_node_relink(struct mdoc *mdoc, struct mdoc_node *p)
+mdoc_node_relink(struct roff_man *mdoc, struct roff_node *p)
 {
 
-       mdoc_node_unlink(mdoc, p);
-       node_append(mdoc, p);
+       roff_node_unlink(mdoc, p);
+       roff_node_append(mdoc, p);
 }
 
 /*
@@ -585,30 +242,30 @@ mdoc_node_relink(struct mdoc *mdoc, struct mdoc_node *p)
  * control character.
  */
 static int
-mdoc_ptext(struct mdoc *mdoc, int line, char *buf, int offs)
+mdoc_ptext(struct roff_man *mdoc, int line, char *buf, int offs)
 {
+       struct roff_node *n;
        char             *c, *ws, *end;
-       struct mdoc_node *n;
 
        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
+        * columnar ROFFT_BLOCK with or without a prior ROFFT_BLOCK entry
+        * (a ROFFT_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) {
+       if (n->tok == MDOC_Bl && n->type == ROFFT_BODY &&
+           n->end == ENDBODY_NOT && n->norm->Bl.type == LIST_column) {
                /* `Bl' is open without any children. */
                mdoc->flags |= MDOC_FREECOL;
                mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf);
                return(1);
        }
 
-       if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
+       if (n->tok == MDOC_It && n->type == ROFFT_BLOCK &&
            NULL != n->parent &&
            MDOC_Bl == n->parent->tok &&
            LIST_column == n->parent->norm->Bl.type) {
@@ -673,12 +330,12 @@ mdoc_ptext(struct mdoc *mdoc, int line, char *buf, int offs)
                 * behaviour that we want to work around it.
                 */
                mdoc_elem_alloc(mdoc, line, offs, MDOC_sp, NULL);
-               mdoc->next = MDOC_NEXT_SIBLING;
+               mdoc->next = ROFF_NEXT_SIBLING;
                mdoc_valid_post(mdoc);
                return(1);
        }
 
-       mdoc_word_alloc(mdoc, line, offs, buf+offs);
+       roff_word_alloc(mdoc, line, offs, buf+offs);
 
        if (mdoc->flags & MDOC_LITERAL)
                return(1);
@@ -701,11 +358,11 @@ mdoc_ptext(struct mdoc *mdoc, int line, char *buf, int offs)
  * character.
  */
 static int
-mdoc_pmacro(struct mdoc *mdoc, int ln, char *buf, int offs)
+mdoc_pmacro(struct roff_man *mdoc, int ln, char *buf, int offs)
 {
-       struct mdoc_node *n;
+       struct roff_node *n;
        const char       *cp;
-       enum mdoct        tok;
+       int               tok;
        int               i, sv;
        char              mac[5];
 
@@ -722,9 +379,9 @@ mdoc_pmacro(struct mdoc *mdoc, int ln, char *buf, int offs)
 
        mac[i] = '\0';
 
-       tok = (i > 1 && i < 4) ? mdoc_hash_find(mac) : MDOC_MAX;
+       tok = (i > 1 && i < 4) ? mdoc_hash_find(mac) : TOKEN_NONE;
 
-       if (tok == MDOC_MAX) {
+       if (tok == TOKEN_NONE) {
                mandoc_msg(MANDOCERR_MACRO, mdoc->parse,
                    ln, sv, buf + sv - 1);
                return(1);
@@ -777,8 +434,8 @@ mdoc_pmacro(struct mdoc *mdoc, int ln, char *buf, int offs)
         * context around the parsed macro.
         */
 
-       if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
-           LIST_column == n->norm->Bl.type) {
+       if (n->tok == MDOC_Bl && n->type == ROFFT_BODY &&
+           n->end == ENDBODY_NOT && n->norm->Bl.type == LIST_column) {
                mdoc->flags |= MDOC_FREECOL;
                mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf);
                return(1);
@@ -790,7 +447,7 @@ mdoc_pmacro(struct mdoc *mdoc, int ln, char *buf, int offs)
         * then open an `It' block context around the parsed macro.
         */
 
-       if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
+       if (n->tok == MDOC_It && n->type == ROFFT_BLOCK &&
            NULL != n->parent &&
            MDOC_Bl == n->parent->tok &&
            LIST_column == n->parent->norm->Bl.type) {
@@ -859,12 +516,12 @@ mdoc_isdelim(const char *p)
 }
 
 void
-mdoc_deroff(char **dest, const struct mdoc_node *n)
+mdoc_deroff(char **dest, const struct roff_node *n)
 {
        char    *cp;
        size_t   sz;
 
-       if (MDOC_TEXT != n->type) {
+       if (n->type != ROFFT_TEXT) {
                for (n = n->child; n; n = n->next)
                        mdoc_deroff(dest, n);
                return;