Moved prologue-pruning into action.c.

[mandoc.git] / mdoc.c

diff --git a/mdoc.c b/mdoc.c
index e22ef3ccb851fbd7a558b93b23f87f21bf0c6922..247f759347d252ea3409955b4a88f692800f52c3 100644 (file)
--- a/mdoc.c
+++ b/mdoc.c
@@ -1,4 +1,4 @@
-/* $Id: mdoc.c,v 1.30 2009/01/15 15:46:45 kristaps Exp $ */
+/* $Id: mdoc.c,v 1.39 2009/01/20 12:51:28 kristaps Exp $ */

 /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
  *
 /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
  *


@@ -99,7 +99,7 @@ const struct mdoc_macro __mdoc_macros[MDOC_MAX] = {
        { macro_scoped_close, MDOC_EXPLICIT }, /* El */
        { macro_scoped, MDOC_PARSED | MDOC_TABSEP}, /* It */
        { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ad */ 
        { macro_scoped_close, MDOC_EXPLICIT }, /* El */
        { macro_scoped, MDOC_PARSED | MDOC_TABSEP}, /* It */
        { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ad */ 

-       { macro_constant, MDOC_PARSED }, /* An */
+       { macro_text, MDOC_PARSED }, /* An */

        { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ar */
        { macro_constant, MDOC_QUOTABLE }, /* Cd */
        { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Cm */
        { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ar */
        { macro_constant, MDOC_QUOTABLE }, /* Cd */
        { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Cm */


@@ -111,7 +111,7 @@ const       struct mdoc_macro __mdoc_macros[MDOC_MAX] = {
        { macro_constant, 0 }, /* Fd */ 
        { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Fl */
        { macro_text, MDOC_CALLABLE | MDOC_QUOTABLE | MDOC_PARSED }, /* Fn */ 
        { macro_constant, 0 }, /* Fd */ 
        { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Fl */
        { macro_text, MDOC_CALLABLE | MDOC_QUOTABLE | MDOC_PARSED }, /* Fn */ 

-       { macro_text, MDOC_PARSED }, /* Ft */ 
+       { macro_text, MDOC_PARSED | MDOC_QUOTABLE }, /* Ft */ 

        { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ic */ 
        { macro_constant, 0 }, /* In */ 
        { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Li */
        { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ic */ 
        { macro_constant, 0 }, /* In */ 
        { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Li */


@@ -140,7 +140,7 @@ const       struct mdoc_macro __mdoc_macros[MDOC_MAX] = {
        { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Ac */
        { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Ao */
        { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Aq */
        { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Ac */
        { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Ao */
        { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Aq */

-       { macro_constant, 0 }, /* At */
+       { macro_constant_delimited, 0 }, /* At */

        { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Bc */
        { macro_scoped, MDOC_EXPLICIT }, /* Bf */ 
        { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Bo */
        { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Bc */
        { macro_scoped, MDOC_EXPLICIT }, /* Bf */ 
        { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Bo */


@@ -162,7 +162,7 @@ const       struct mdoc_macro __mdoc_macros[MDOC_MAX] = {
        { macro_constant_delimited, MDOC_PARSED }, /* Nx */
        { macro_constant_delimited, MDOC_PARSED }, /* Ox */
        { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Pc */
        { macro_constant_delimited, MDOC_PARSED }, /* Nx */
        { macro_constant_delimited, MDOC_PARSED }, /* Ox */
        { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Pc */

-       { macro_constant, MDOC_PARSED }, /* Pf */
+       { macro_constant_delimited, MDOC_PARSED }, /* Pf */

        { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Po */
        { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Pq */
        { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Qc */
        { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Po */
        { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Pq */
        { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Qc */


@@ -205,7 +205,6 @@ static      void              argfree(size_t, struct mdoc_arg *);
 static void              argcpy(struct mdoc_arg *, 
                                const struct mdoc_arg *);
 
 static void              argcpy(struct mdoc_arg *, 
                                const struct mdoc_arg *);
 

-static void              mdoc_node_freelist(struct mdoc_node *);

 static int               mdoc_node_append(struct mdoc *, 
                                struct mdoc_node *);
 static void              mdoc_elem_free(struct mdoc_elem *);
 static int               mdoc_node_append(struct mdoc *, 
                                struct mdoc_node *);
 static void              mdoc_elem_free(struct mdoc_elem *);


@@ -213,13 +212,21 @@ static    void              mdoc_text_free(struct mdoc_text *);
 
 
 const struct mdoc_node *
 
 
 const struct mdoc_node *

-mdoc_result(struct mdoc *mdoc)
+mdoc_node(struct mdoc *mdoc)

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

+const struct mdoc_meta *
+mdoc_meta(struct mdoc *mdoc)
+{
+
+       return(&mdoc->meta);
+}
+
+

 void
 mdoc_free(struct mdoc *mdoc)
 {
 void
 mdoc_free(struct mdoc *mdoc)
 {


@@ -228,7 +235,13 @@ mdoc_free(struct mdoc *mdoc)
                mdoc_node_freelist(mdoc->first);
        if (mdoc->htab)
                mdoc_tokhash_free(mdoc->htab);
                mdoc_node_freelist(mdoc->first);
        if (mdoc->htab)
                mdoc_tokhash_free(mdoc->htab);

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

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


@@ -241,7 +254,8 @@ mdoc_alloc(void *data, const struct mdoc_cb *cb)
        p = xcalloc(1, sizeof(struct mdoc));
 
        p->data = data;
        p = xcalloc(1, sizeof(struct mdoc));
 
        p->data = data;

-       (void)memcpy(&p->cb, cb, sizeof(struct mdoc_cb));
+       if (cb)
+               (void)memcpy(&p->cb, cb, sizeof(struct mdoc_cb));

 
        p->last = xcalloc(1, sizeof(struct mdoc_node));
        p->last->type = MDOC_ROOT;
 
        p->last = xcalloc(1, sizeof(struct mdoc_node));
        p->last->type = MDOC_ROOT;


@@ -281,14 +295,15 @@ mdoc_parseln(struct mdoc *mdoc, int line, char *buf)
        if (MDOC_HALT & mdoc->flags)
                return(0);
 
        if (MDOC_HALT & mdoc->flags)
                return(0);
 

+       mdoc->linetok = 0;
+

        if ('.' != *buf) {
        if ('.' != *buf) {

-               if (SEC_PROLOGUE != mdoc->sec_lastn) {
-                       if ( ! mdoc_word_alloc(mdoc, line, 0, buf))
-                               return(0);
-                       mdoc->next = MDOC_NEXT_SIBLING;
-                       return(1);
-               }
-               return(mdoc_perr(mdoc, line, 0, ERR_SYNTAX_NOTEXT));
+               if ( ! (MDOC_BODYPARSE & mdoc->flags))
+                       return(mdoc_perr(mdoc, line, 0, "text disallowed"));
+               if ( ! mdoc_word_alloc(mdoc, line, 0, buf))
+                       return(0);
+               mdoc->next = MDOC_NEXT_SIBLING;
+               return(1);

        }
 
        if (buf[1] && '\\' == buf[1])
        }
 
        if (buf[1] && '\\' == buf[1])


@@ -301,10 +316,10 @@ mdoc_parseln(struct mdoc *mdoc, int line, char *buf)
 
        if (i == (int)sizeof(tmp)) {
                mdoc->flags |= MDOC_HALT;
 
        if (i == (int)sizeof(tmp)) {
                mdoc->flags |= MDOC_HALT;

-               return(mdoc_perr(mdoc, line, 1, ERR_MACRO_NOTSUP));
+               return(mdoc_perr(mdoc, line, 1, "unknown macro"));

        } else if (i <= 2) {
                mdoc->flags |= MDOC_HALT;
        } else if (i <= 2) {
                mdoc->flags |= MDOC_HALT;

-               return(mdoc_perr(mdoc, line, 1, ERR_MACRO_NOTSUP));
+               return(mdoc_perr(mdoc, line, 1, "unknown macro"));

        }
 
        i--;
        }
 
        i--;


@@ -314,7 +329,7 @@ mdoc_parseln(struct mdoc *mdoc, int line, char *buf)
 
        if (MDOC_MAX == (c = mdoc_find(mdoc, tmp))) {
                mdoc->flags |= MDOC_HALT;
 
        if (MDOC_MAX == (c = mdoc_find(mdoc, tmp))) {
                mdoc->flags |= MDOC_HALT;

-               return(mdoc_perr(mdoc, line, 1, ERR_MACRO_NOTSUP));
+               return(mdoc_perr(mdoc, line, 1, "unknown macro"));

        }
 
        while (buf[i] && isspace(buf[i]))
        }
 
        while (buf[i] && isspace(buf[i]))


@@ -329,45 +344,52 @@ mdoc_parseln(struct mdoc *mdoc, int line, char *buf)
 
 
 void
 
 
 void

-mdoc_msg(struct mdoc *mdoc, const char *fmt, ...)
+mdoc_vmsg(struct mdoc *mdoc, int ln, int pos, const char *fmt, ...)

 {
 {

-       struct mdoc_node *n;
-       va_list           ap;

        char              buf[256];
        char              buf[256];

+       va_list           ap;

 
        if (NULL == mdoc->cb.mdoc_msg)
                return;
 
 
        if (NULL == mdoc->cb.mdoc_msg)
                return;
 

-       n = mdoc->last;
-       assert(n);
-

        va_start(ap, fmt);
        va_start(ap, fmt);

-       (void)vsnprintf(buf, sizeof(buf), fmt, ap);
+       (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);

        va_end(ap);
        va_end(ap);

-
-       (*mdoc->cb.mdoc_msg)(mdoc->data, n->line, n->pos, buf);
+       (*mdoc->cb.mdoc_msg)(mdoc->data, ln, pos, buf);

 }
 
 
 int
 }
 
 
 int

-mdoc_perr(struct mdoc *mdoc, 
-               int line, int pos, enum mdoc_err type)
+mdoc_verr(struct mdoc *mdoc, int ln, int pos, 
+               const char *fmt, ...)

 {
 {

+       char             buf[256];
+       va_list          ap;

 
        if (NULL == mdoc->cb.mdoc_err)
                return(0);
 
        if (NULL == mdoc->cb.mdoc_err)
                return(0);

-       return((*mdoc->cb.mdoc_err)(mdoc->data, line, pos, type));
+
+       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
 }
 
 
 int

-mdoc_pwarn(struct mdoc *mdoc, 
-               int line, int pos, enum mdoc_warn type)
+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);
 
        if (NULL == mdoc->cb.mdoc_warn)
                return(0);

-       return((*mdoc->cb.mdoc_warn)(mdoc->data, line, pos, type));
+
+       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));

 }
 
 
 }
 
 


@@ -376,16 +398,13 @@ mdoc_macro(struct mdoc *mdoc, int tok,
                int ln, int ppos, int *pos, char *buf)
 {
 
                int ln, int ppos, int *pos, char *buf)
 {
 

-       if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) &&
-                       SEC_PROLOGUE == mdoc->sec_lastn)
-               return(mdoc_perr(mdoc, ln, ppos, ERR_SEC_PROLOGUE));
-
-       if (NULL == (mdoc_macros[tok].fp))
-               return(mdoc_perr(mdoc, ln, ppos, ERR_MACRO_NOTSUP));
+       assert(mdoc_macros[tok].fp);

 
 

+       if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) &&
+                       ! (MDOC_BODYPARSE & mdoc->flags))
+               return(mdoc_perr(mdoc, ln, ppos, "macro disallowed: not in document body"));

        if (1 != ppos && ! (MDOC_CALLABLE & mdoc_macros[tok].flags))
        if (1 != ppos && ! (MDOC_CALLABLE & mdoc_macros[tok].flags))

-               return(mdoc_perr(mdoc, ln, ppos, ERR_MACRO_NOTCALL));
-
+               return(mdoc_perr(mdoc, ln, ppos, "macro not callable"));

        return((*mdoc_macros[tok].fp)(mdoc, tok, ln, ppos, pos, buf));
 }
 
        return((*mdoc_macros[tok].fp)(mdoc, tok, ln, ppos, pos, buf));
 }
 


@@ -399,6 +418,26 @@ mdoc_node_append(struct mdoc *mdoc, struct mdoc_node *p)
        assert(mdoc->first);
        assert(MDOC_ROOT != p->type);
 
        assert(mdoc->first);
        assert(MDOC_ROOT != p->type);
 

+       /* See if we exceed the suggest line-max. */
+
+       switch (p->type) {
+       case (MDOC_TEXT):
+               /* FALLTHROUGH */
+       case (MDOC_ELEM):
+               /* FALLTHROUGH */
+       case (MDOC_BLOCK):
+               mdoc->linetok++;
+               break;
+       default:
+               break;
+       }
+
+       if (mdoc->linetok > MDOC_LINEARG_SOFTMAX) 
+               if ( ! mdoc_nwarn(mdoc, p, WARN_COMPAT, 
+                                       "suggested %d tokens per line exceeded (has %d)",
+                                       MDOC_LINEARG_SOFTMAX, mdoc->linetok))
+                       return(0);
+

        if (MDOC_TEXT == mdoc->last->type)
                on = "<text>";
        else if (MDOC_ROOT == mdoc->last->type)
        if (MDOC_TEXT == mdoc->last->type)
                on = "<text>";
        else if (MDOC_ROOT == mdoc->last->type)


@@ -435,8 +474,6 @@ mdoc_node_append(struct mdoc *mdoc, struct mdoc_node *p)
 
        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):


@@ -655,7 +692,7 @@ mdoc_node_free(struct mdoc_node *p)
 }
 
 
 }
 
 

-static void
+void

 mdoc_node_freelist(struct mdoc_node *p)
 {
 
 mdoc_node_freelist(struct mdoc_node *p)
 {
 


@@ -708,3 +745,27 @@ argdup(size_t argsz, const struct mdoc_arg *args)
        return(pp);
 }
 
        return(pp);
 }
 

+
+/* FIXME: deprecate. */
+char *
+mdoc_node2a(struct mdoc_node *node)
+{
+       static char      buf[64];
+
+       assert(node);
+
+       buf[0] = 0;
+       (void)xstrlcat(buf, mdoc_type2a(node->type), 64);
+       if (MDOC_ROOT == node->type)
+               return(buf);
+       (void)xstrlcat(buf, " `", 64);
+       if (MDOC_TEXT == node->type)
+               (void)xstrlcat(buf, node->data.text.string, 64);
+       else
+               (void)xstrlcat(buf, mdoc_macronames[node->tok], 64);
+       (void)xstrlcat(buf, "'", 64);
+
+       return(buf);
+}
+
+