Clarify what eqn actually is.

[mandoc.git] / man.c

diff --git a/man.c b/man.c
index 1a6807efafb704293f8d114e477b2a450ddf239d..593777ace34c303f4ed03a179799a5781da97b07 100644 (file)
--- a/man.c
+++ b/man.c
@@ -1,6 +1,6 @@
-/*     $Id: man.c,v 1.99 2011/02/06 22:05:20 kristaps Exp $ */
+/*     $Id: man.c,v 1.109 2011/07/21 10:24:35 kristaps Exp $ */

 /*
 /*

- * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>

  *
  * 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


@@ -26,6 +26,7 @@
 #include <stdio.h>
 #include <string.h>
 
 #include <stdio.h>
 #include <string.h>
 

+#include "man.h"

 #include "mandoc.h"
 #include "libman.h"
 #include "libmandoc.h"
 #include "mandoc.h"
 #include "libman.h"
 #include "libmandoc.h"


@@ -48,8 +49,6 @@ static        struct man_node *man_node_alloc(struct man *, int, int,
                                enum man_type, enum mant);
 static int              man_node_append(struct man *, 
                                struct man_node *);
                                enum man_type, enum mant);
 static int              man_node_append(struct man *, 
                                struct man_node *);

-static int              man_span_alloc(struct man *, 
-                               const struct tbl_span *);

 static void             man_node_free(struct man_node *);
 static void             man_node_unlink(struct man *, 
                                struct man_node *);
 static void             man_node_free(struct man_node *);
 static void             man_node_unlink(struct man *, 
                                struct man_node *);


@@ -97,16 +96,15 @@ man_free(struct man *man)
 
 
 struct man *
 
 
 struct man *

-man_alloc(struct regset *regs, void *data, mandocmsg msg)
+man_alloc(struct roff *roff, struct mparse *parse)

 {
        struct man      *p;
 
        p = mandoc_calloc(1, sizeof(struct man));
 
        man_hash_init();
 {
        struct man      *p;
 
        p = mandoc_calloc(1, sizeof(struct man));
 
        man_hash_init();

-       p->data = data;
-       p->msg = msg;
-       p->regs = regs;
+       p->parse = parse;
+       p->roff = roff;

 
        man_alloc1(p);
        return(p);
 
        man_alloc1(p);
        return(p);


@@ -132,7 +130,8 @@ man_parseln(struct man *m, int ln, char *buf, int offs)
        m->flags |= MAN_NEWLINE;
 
        assert( ! (MAN_HALT & m->flags));
        m->flags |= MAN_NEWLINE;
 
        assert( ! (MAN_HALT & m->flags));

-       return(('.' == buf[offs] || '\'' == buf[offs]) ? 
+
+       return (mandoc_getcontrol(buf, &offs) ?

                        man_pmacro(m, ln, buf, offs) : 
                        man_ptext(m, ln, buf, offs));
 }
                        man_pmacro(m, ln, buf, offs) : 
                        man_ptext(m, ln, buf, offs));
 }


@@ -148,8 +147,8 @@ man_free1(struct man *man)
                free(man->meta.title);
        if (man->meta.source)
                free(man->meta.source);
                free(man->meta.title);
        if (man->meta.source)
                free(man->meta.source);

-       if (man->meta.rawdate)
-               free(man->meta.rawdate);
+       if (man->meta.date)
+               free(man->meta.date);

        if (man->meta.vol)
                free(man->meta.vol);
        if (man->meta.msec)
        if (man->meta.vol)
                free(man->meta.vol);
        if (man->meta.msec)


@@ -205,6 +204,10 @@ man_node_append(struct man *man, struct man_node *p)
                assert(MAN_BLOCK == p->parent->type);
                p->parent->head = p;
                break;
                assert(MAN_BLOCK == p->parent->type);
                p->parent->head = p;
                break;

+       case (MAN_TAIL):
+               assert(MAN_BLOCK == p->parent->type);
+               p->parent->tail = p;
+               break;

        case (MAN_BODY):
                assert(MAN_BLOCK == p->parent->type);
                p->parent->body = p;
        case (MAN_BODY):
                assert(MAN_BLOCK == p->parent->type);
                p->parent->body = p;


@@ -263,11 +266,11 @@ man_elem_alloc(struct man *m, int line, int pos, enum mant tok)
 
 
 int
 
 
 int

-man_head_alloc(struct man *m, int line, int pos, enum mant tok)
+man_tail_alloc(struct man *m, int line, int pos, enum mant tok)

 {
        struct man_node *p;
 
 {
        struct man_node *p;
 

-       p = man_node_alloc(m, line, pos, MAN_HEAD, tok);
+       p = man_node_alloc(m, line, pos, MAN_TAIL, tok);

        if ( ! man_node_append(m, p))
                return(0);
        m->next = MAN_NEXT_CHILD;
        if ( ! man_node_append(m, p))
                return(0);
        m->next = MAN_NEXT_CHILD;


@@ -276,11 +279,11 @@ man_head_alloc(struct man *m, int line, int pos, enum mant tok)
 
 
 int
 
 
 int

-man_body_alloc(struct man *m, int line, int pos, enum mant tok)
+man_head_alloc(struct man *m, int line, int pos, enum mant tok)

 {
        struct man_node *p;
 
 {
        struct man_node *p;
 

-       p = man_node_alloc(m, line, pos, MAN_BODY, tok);
+       p = man_node_alloc(m, line, pos, MAN_HEAD, tok);

        if ( ! man_node_append(m, p))
                return(0);
        m->next = MAN_NEXT_CHILD;
        if ( ! man_node_append(m, p))
                return(0);
        m->next = MAN_NEXT_CHILD;


@@ -289,29 +292,27 @@ man_body_alloc(struct man *m, int line, int pos, enum mant tok)
 
 
 int
 
 
 int

-man_block_alloc(struct man *m, int line, int pos, enum mant tok)
+man_body_alloc(struct man *m, int line, int pos, enum mant tok)

 {
        struct man_node *p;
 
 {
        struct man_node *p;
 

-       p = man_node_alloc(m, line, pos, MAN_BLOCK, tok);
+       p = man_node_alloc(m, line, pos, MAN_BODY, tok);

        if ( ! man_node_append(m, p))
                return(0);
        m->next = MAN_NEXT_CHILD;
        return(1);
 }
 
        if ( ! man_node_append(m, p))
                return(0);
        m->next = MAN_NEXT_CHILD;
        return(1);
 }
 

-static int
-man_span_alloc(struct man *m, const struct tbl_span *span)
-{
-       struct man_node *n;

 
 

-       n = man_node_alloc(m, span->line, 0, MAN_TBL, MAN_MAX);
-       n->span = span;
+int
+man_block_alloc(struct man *m, int line, int pos, enum mant tok)
+{
+       struct man_node *p;

 
 

-       if ( ! man_node_append(m, n))
+       p = man_node_alloc(m, line, pos, MAN_BLOCK, tok);
+       if ( ! man_node_append(m, p))

                return(0);
                return(0);

-
-       m->next = MAN_NEXT_SIBLING;
+       m->next = MAN_NEXT_CHILD;

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


@@ -363,14 +364,37 @@ man_node_delete(struct man *m, struct man_node *p)
        man_node_free(p);
 }
 
        man_node_free(p);
 }
 

+int
+man_addeqn(struct man *m, const struct eqn *ep)
+{
+       struct man_node *n;
+
+       assert( ! (MAN_HALT & m->flags));
+
+       n = man_node_alloc(m, ep->ln, ep->pos, MAN_EQN, MAN_MAX);
+       n->eqn = ep;
+
+       if ( ! man_node_append(m, n))
+               return(0);
+
+       m->next = MAN_NEXT_SIBLING;
+       return(man_descope(m, ep->ln, ep->pos));
+}

 
 int
 man_addspan(struct man *m, const struct tbl_span *sp)
 {
 
 int
 man_addspan(struct man *m, const struct tbl_span *sp)
 {

+       struct man_node *n;

 
        assert( ! (MAN_HALT & m->flags));
 
        assert( ! (MAN_HALT & m->flags));

-       if ( ! man_span_alloc(m, sp))
+
+       n = man_node_alloc(m, sp->line, 0, MAN_TBL, MAN_MAX);
+       n->span = sp;
+
+       if ( ! man_node_append(m, n))

                return(0);
                return(0);

+
+       m->next = MAN_NEXT_SIBLING;

        return(man_descope(m, sp->line, 0));
 }
 
        return(man_descope(m, sp->line, 0));
 }
 


@@ -398,21 +422,11 @@ man_descope(struct man *m, int line, int offs)
        return(man_body_alloc(m, line, offs, m->last->tok));
 }
 
        return(man_body_alloc(m, line, offs, m->last->tok));
 }
 

-

 static int
 man_ptext(struct man *m, int line, char *buf, int offs)
 {
        int              i;
 
 static int
 man_ptext(struct man *m, int line, char *buf, int offs)
 {
        int              i;
 

-       /* Ignore bogus comments. */
-
-       if ('\\' == buf[offs] && 
-                       '.' == buf[offs + 1] && 
-                       '"' == buf[offs + 2]) {
-               man_pmsg(m, line, offs, MANDOCERR_BADCOMMENT);
-               return(1);
-       }
-

        /* Literal free-form text whitespace is preserved. */
 
        if (MAN_LITERAL & m->flags) {
        /* Literal free-form text whitespace is preserved. */
 
        if (MAN_LITERAL & m->flags) {


@@ -470,67 +484,54 @@ man_ptext(struct man *m, int line, char *buf, int offs)
        return(man_descope(m, line, offs));
 }
 
        return(man_descope(m, line, offs));
 }
 

-

 static int
 man_pmacro(struct man *m, int ln, char *buf, int offs)
 {
 static int
 man_pmacro(struct man *m, int ln, char *buf, int offs)
 {

-       int              i, j, ppos;
+       int              i, ppos;

        enum mant        tok;
        char             mac[5];
        struct man_node *n;
 
        enum mant        tok;
        char             mac[5];
        struct man_node *n;
 

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

                return(1);
 
                return(1);
 

-       i = offs;
-
-       /*
-        * Skip whitespace between the control character and initial
-        * text.  "Whitespace" is both spaces and tabs.
-        */
-
-       if (' ' == buf[i] || '\t' == buf[i]) {
-               i++;
-               while (buf[i] && (' ' == buf[i] || '\t' == buf[i]))
-                       i++;
-               if ('\0' == buf[i])
-                       goto out;
-       }
-
-       ppos = i;
+       ppos = offs;

 
        /*
         * 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.
         * Stop copying when a tab, space, or eoln is encountered.
         */
 

-       j = 0;
-       while (j < 4 && '\0' != buf[i] && ' ' != buf[i] && '\t' != buf[i])
-               mac[j++] = buf[i++];
-       mac[j] = '\0';
+       i = 0;
+       while (i < 4 && '\0' != buf[offs] && 
+                       ' ' != buf[offs] && '\t' != buf[offs])
+               mac[i++] = buf[offs++];
+
+       mac[i] = '\0';
+
+       tok = (i > 0 && i < 4) ? man_hash_find(mac) : MAN_MAX;

 
 

-       tok = (j > 0 && j < 4) ? man_hash_find(mac) : MAN_MAX;

        if (MAN_MAX == tok) {
        if (MAN_MAX == tok) {

-               man_vmsg(m, MANDOCERR_MACRO, ln, ppos, "%s", buf + ppos - 1);
+               mandoc_vmsg(MANDOCERR_MACRO, m->parse, ln, 
+                               ppos, "%s", buf + ppos - 1);

                return(1);
        }
 
        /* The macro is sane.  Jump to the next word. */
 
                return(1);
        }
 
        /* The macro is sane.  Jump to the next word. */
 

-       while (buf[i] && ' ' == buf[i])
-               i++;
+       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.
         */
 
 
        /* 
         * 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[i] && ' ' == buf[i - 1])
-               man_pmsg(m, ln, i - 1, MANDOCERR_EOLNSPACE);
+       if ('\0' == buf[offs] && ' ' == buf[offs - 1])
+               man_pmsg(m, ln, offs - 1, MANDOCERR_EOLNSPACE);

 
        /* 
         * Remove prior ELINE macro, as it's being clobbered by a new
 
        /* 
         * Remove prior ELINE macro, as it's being clobbered by a new


@@ -548,8 +549,8 @@ man_pmacro(struct man *m, int ln, char *buf, int offs)
                if (MAN_NSCOPED & man_macros[n->tok].flags)
                        n = n->parent;
 
                if (MAN_NSCOPED & man_macros[n->tok].flags)
                        n = n->parent;
 

-               man_vmsg(m, MANDOCERR_LINESCOPE, n->line, n->pos,
-                               "%s", man_macronames[n->tok]);
+               mandoc_vmsg(MANDOCERR_LINESCOPE, m->parse, n->line, 
+                               n->pos, "%s", man_macronames[n->tok]);

 
                man_node_delete(m, n);
                m->flags &= ~MAN_ELINE;
 
                man_node_delete(m, n);
                m->flags &= ~MAN_ELINE;


@@ -567,10 +568,9 @@ man_pmacro(struct man *m, int ln, char *buf, int offs)
        /* Call to handler... */
 
        assert(man_macros[tok].fp);
        /* Call to handler... */
 
        assert(man_macros[tok].fp);

-       if ( ! (*man_macros[tok].fp)(m, tok, ln, ppos, &i, buf))
+       if ( ! (*man_macros[tok].fp)(m, tok, ln, ppos, &offs, buf))

                goto err;
 
                goto err;
 

-out:

        /* 
         * We weren't in a block-line scope when entering the
         * above-parsed macro, so return.
        /* 
         * We weren't in a block-line scope when entering the
         * above-parsed macro, so return.


@@ -607,7 +607,7 @@ out:
 
        if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX))
                return(0);
 
        if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX))
                return(0);

-       return(man_body_alloc(m, ln, offs, m->last->tok));
+       return(man_body_alloc(m, ln, ppos, m->last->tok));

 
 err:   /* Error out. */
 
 
 err:   /* Error out. */
 


@@ -615,21 +615,6 @@ err:       /* Error out. */
        return(0);
 }
 
        return(0);
 }
 

-
-int
-man_vmsg(struct man *man, enum mandocerr t, 
-               int ln, int pos, const char *fmt, ...)
-{
-       char             buf[256];
-       va_list          ap;
-
-       va_start(ap, fmt);
-       vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
-       va_end(ap);
-       return((*man->msg)(t, man->data, ln, pos, buf));
-}
-
-

 /*
  * Unlink a node from its context.  If "m" is provided, the last parse
  * point will also be adjusted accordingly.
 /*
  * Unlink a node from its context.  If "m" is provided, the last parse
  * point will also be adjusted accordingly.