]> git.cameronkatri.com Git - mandoc.git/blobdiff - man.c
Fixed email address in manual AUTHOR reference.
[mandoc.git] / man.c
diff --git a/man.c b/man.c
index c00fd6eb6466a17eb0f0fba9742094828335d7e1..56b0721c270420eba3d5e9b8d3cfa9376f4dcb2c 100644 (file)
--- a/man.c
+++ b/man.c
@@ -1,24 +1,21 @@
-/* $Id: man.c,v 1.4 2009/03/25 15:17:49 kristaps Exp $ */
+/*     $Id: man.c,v 1.19 2009/06/10 20:18:43 kristaps Exp $ */
 /*
- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org>
+ * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
  *
  * 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.
+ * 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 WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
- * AUTHOR 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.
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR 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.
  */
 #include <assert.h>
 #include <ctype.h>
-#include <err.h>
 #include <stdarg.h>
 #include <stdlib.h>
 #include <stdio.h>
@@ -31,18 +28,20 @@ const       char *const __man_macronames[MAN_MAX] = {
        "TP",           "LP",           "PP",           "P",
        "IP",           "HP",           "SM",           "SB",
        "BI",           "IB",           "BR",           "RB",
-       "R",            "B",            "I",            "IR"
+       "R",            "B",            "I",            "IR",
+       "RI",           "br",           "na",           "i"
        };
 
 const  char * const *man_macronames = __man_macronames;
 
-static struct man_node *man_node_alloc(int, int, enum man_type);
+static struct man_node *man_node_alloc(int, int, 
+                               enum man_type, int);
 static int              man_node_append(struct man *, 
                                struct man_node *);
 static int              man_ptext(struct man *, int, char *);
 static int              man_pmacro(struct man *, int, char *);
 static void             man_free1(struct man *);
-static void             man_alloc1(struct man *);
+static int              man_alloc1(struct man *);
 
 
 const struct man_node *
@@ -61,12 +60,12 @@ man_meta(const struct man *m)
 }
 
 
-void
+int
 man_reset(struct man *man)
 {
 
        man_free1(man);
-       man_alloc1(man);
+       return(man_alloc1(man));
 }
 
 
@@ -83,21 +82,26 @@ man_free(struct man *man)
 
 
 struct man *
-man_alloc(void *data, const struct man_cb *cb)
+man_alloc(void *data, int pflags, const struct man_cb *cb)
 {
        struct man      *p;
 
-       p = calloc(1, sizeof(struct man));
-       if (NULL == p)
-               err(1, "calloc");
-
-       man_alloc1(p);
+       if (NULL == (p = calloc(1, sizeof(struct man))))
+               return(NULL);
 
-       if (cb)
-               (void)memcpy(&p->cb, cb, sizeof(struct man_cb));
+       if ( ! man_alloc1(p)) {
+               free(p);
+               return(NULL);
+       }
 
-       p->htab = man_hash_alloc();
        p->data = data;
+       p->pflags = pflags;
+       (void)memcpy(&p->cb, cb, sizeof(struct man_cb));
+
+       if (NULL == (p->htab = man_hash_alloc())) {
+               free(p);
+               return(NULL);
+       }
        return(p);
 }
 
@@ -133,14 +137,14 @@ man_free1(struct man *man)
                man_node_freelist(man->first);
        if (man->meta.title)
                free(man->meta.title);
-       if (man->meta.os)
-               free(man->meta.os);
+       if (man->meta.source)
+               free(man->meta.source);
        if (man->meta.vol)
                free(man->meta.vol);
 }
 
 
-static void
+static int
 man_alloc1(struct man *m)
 {
 
@@ -148,10 +152,11 @@ man_alloc1(struct man *m)
        m->flags = 0;
        m->last = calloc(1, sizeof(struct man_node));
        if (NULL == m->last)
-               err(1, "calloc");
+               return(0);
        m->first = m->last;
        m->last->type = MAN_ROOT;
        m->next = MAN_NEXT_CHILD;
+       return(1);
 }
 
 
@@ -178,21 +183,14 @@ man_node_append(struct man *man, struct man_node *p)
                /* NOTREACHED */
        }
 
-#if 0
-       if ( ! man_action_pre(man, p))
-               return(0);
-#endif
-
        man->last = p;
 
        switch (p->type) {
        case (MAN_TEXT):
                if ( ! man_valid_post(man))
                        return(0);
-#if 0
                if ( ! man_action_post(man))
                        return(0);
-#endif
                break;
        default:
                break;
@@ -203,16 +201,18 @@ man_node_append(struct man *man, struct man_node *p)
 
 
 static struct man_node *
-man_node_alloc(int line, int pos, enum man_type type)
+man_node_alloc(int line, int pos, enum man_type type, int tok)
 {
        struct man_node *p;
 
-       if (NULL == (p = calloc(1, sizeof(struct man_node))))
-               err(1, "malloc");
+       p = calloc(1, sizeof(struct man_node));
+       if (NULL == p)
+               return(NULL);
+
        p->line = line;
        p->pos = pos;
        p->type = type;
-
+       p->tok = tok;
        return(p);
 }
 
@@ -222,9 +222,9 @@ man_elem_alloc(struct man *man, int line, int pos, int tok)
 {
        struct man_node *p;
 
-       p = man_node_alloc(line, pos, MAN_ELEM);
-       p->tok = tok;
-
+       p = man_node_alloc(line, pos, MAN_ELEM, tok);
+       if (NULL == p)
+               return(0);
        return(man_node_append(man, p));
 }
 
@@ -235,10 +235,11 @@ man_word_alloc(struct man *man,
 {
        struct man_node *p;
 
-       p = man_node_alloc(line, pos, MAN_TEXT);
+       p = man_node_alloc(line, pos, MAN_TEXT, -1);
+       if (NULL == p)
+               return(0);
        if (NULL == (p->string = strdup(word)))
-               err(1, "strdup");
-
+               return(0);
        return(man_node_append(man, p));
 }
 
@@ -273,6 +274,25 @@ man_ptext(struct man *m, int line, char *buf)
        if ( ! man_word_alloc(m, line, 0, buf))
                return(0);
        m->next = MAN_NEXT_SIBLING;
+
+       /*
+        * If this is one of the zany NLINE macros that consumes the
+        * next line of input as being influenced, then close out the
+        * existing macro "scope" and continue processing.
+        */
+
+       if ( ! (MAN_NLINE & m->flags))
+               return(1);
+
+       m->flags &= ~MAN_NLINE;
+       m->last = m->last->parent;
+
+       assert(MAN_ROOT != m->last->type);
+       if ( ! man_valid_post(m))
+               return(0);
+       if ( ! man_action_post(m))
+               return(0);
+
        return(1);
 }
 
@@ -280,47 +300,67 @@ man_ptext(struct man *m, int line, char *buf)
 int
 man_pmacro(struct man *m, int ln, char *buf)
 {
-       int               i, c;
+       int               i, j, c, ppos, fl;
        char              mac[5];
+       struct man_node  *n;
 
        /* Comments and empties are quickly ignored. */
 
+       n = m->last;
+       fl = MAN_NLINE & m->flags;
+
        if (0 == buf[1])
-               return(1);
+               goto out;
 
-       if (' ' == buf[1]) {
-               i = 2;
+       i = 1;
+
+       if (' ' == buf[i]) {
+               i++;
                while (buf[i] && ' ' == buf[i])
                        i++;
                if (0 == buf[i])
-                       return(1);
-               warnx("invalid syntax");
-               return(0);
+                       goto out;
        }
 
-       if (buf[1] && '\\' == buf[1])
-               if (buf[2] && '\"' == buf[2])
-                       return(1);
+       ppos = i;
+
+       if (buf[i] && '\\' == buf[i])
+               if (buf[i + 1] && '\"' == buf[i + 1])
+                       goto out;
 
        /* Copy the first word into a nil-terminated buffer. */
 
-       for (i = 1; i < 5; i++) {
-               if (0 == (mac[i - 1] = buf[i]))
+       for (j = 0; j < 4; j++, i++) {
+               if (0 == (mac[j] = buf[i]))
                        break;
                else if (' ' == buf[i])
                        break;
        }
 
-       mac[i - 1] = 0;
-
-       if (i == 5 || i <= 1) {
-               warnx("unknown macro: %s", mac);
-               goto err;
-       } 
+       mac[j] = 0;
+
+       if (j == 4 || j < 1) {
+               if ( ! (MAN_IGN_MACRO & m->pflags)) {
+                       (void)man_verr(m, ln, ppos, 
+                               "ill-formed macro: %s", mac);
+                       goto err;
+               } 
+               if ( ! man_vwarn(m, ln, ppos, 
+                               "ill-formed macro: %s", mac))
+                       goto err;
+               return(1);
+       }
        
        if (MAN_MAX == (c = man_hash_find(m->htab, mac))) {
-               warnx("unknown macro: %s", mac);
-               goto err;
+               if ( ! (MAN_IGN_MACRO & m->pflags)) {
+                       (void)man_verr(m, ln, ppos, 
+                               "unknown macro: %s", mac);
+                       goto err;
+               } 
+               if ( ! man_vwarn(m, ln, ppos, 
+                               "unknown macro: %s", mac))
+                       goto err;
+               return(1);
        }
 
        /* The macro is sane.  Jump to the next word. */
@@ -330,9 +370,31 @@ man_pmacro(struct man *m, int ln, char *buf)
 
        /* Begin recursive parse sequence. */
 
-       if ( ! man_macro(m, c, ln, 1, &i, buf))
+       if ( ! man_macro(m, c, ln, ppos, &i, buf))
                goto err;
 
+out:
+       if (fl) {
+               /*
+                * A NLINE macro has been immediately followed with
+                * another.  Close out the preceding macro's scope, and
+                * continue.
+                */
+               assert(MAN_ROOT != m->last->type);
+               assert(m->last->parent);
+               assert(MAN_ROOT != m->last->parent->type);
+
+               if (n != m->last)
+                       m->last = m->last->parent;
+
+               if ( ! man_valid_post(m))
+                       return(0);
+               if ( ! man_action_post(m))
+                       return(0);
+               m->next = MAN_NEXT_SIBLING;
+               m->flags &= ~MAN_NLINE;
+       } 
+
        return(1);
 
 err:   /* Error out. */