]> git.cameronkatri.com Git - mandoc.git/blobdiff - main.c
Deprecated mdoc_msg (not being used anywhere).
[mandoc.git] / main.c
diff --git a/main.c b/main.c
index 6f36aa9c51fb76d000c88cf2f54dc77c4192e3a1..ce6d4a91a2014d4aee05ae69b30cf9c0ac002d80 100644 (file)
--- a/main.c
+++ b/main.c
@@ -1,20 +1,18 @@
-/* $Id: main.c,v 1.21 2009/04/02 16:42:35 kristaps Exp $ */
+/*     $Id: main.c,v 1.28 2009/06/15 10:36:01 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 <sys/stat.h>
 
@@ -42,6 +40,10 @@ extern       int               getsubopt(char **, char * const *, char **);
 # endif
 #endif
 
+typedef        int             (*out_mdoc)(void *, const struct mdoc *);
+typedef        int             (*out_man)(void *, const struct man *);
+typedef        void            (*out_free)(void *);
+
 struct buf {
        char             *buf;
        size_t            sz;
@@ -60,35 +62,35 @@ enum        outt {
 };
 
 struct curparse {
-       const char       *file;
-       int               fd;
+       const char       *file;         /* Current parse. */
+       int               fd;           /* Current parse. */
        int               wflags;
 #define        WARN_WALL         0x03          /* All-warnings mask. */
 #define        WARN_WCOMPAT     (1 << 0)       /* Compatibility warnings. */
 #define        WARN_WSYNTAX     (1 << 1)       /* Syntax warnings. */
 #define        WARN_WERR        (1 << 2)       /* Warnings->errors. */
        int               fflags;
-       enum intt         inttype;
+#define        IGN_SCOPE        (1 << 0)       /* Ignore scope errors. */
+#define        NO_IGN_ESCAPE    (1 << 1)       /* Don't ignore bad escapes. */
+#define        NO_IGN_MACRO     (1 << 2)       /* Don't ignore bad macros. */
+#define        NO_IGN_CHARS     (1 << 3)       /* Don't ignore bad chars. */
+       enum intt         inttype;      /* Input parsers. */
        struct man       *man;
+       struct man       *lastman;
        struct mdoc      *mdoc;
+       struct mdoc      *lastmdoc;
+       enum outt         outtype;      /* Output devices. */
+       out_mdoc          outmdoc;
+       out_man           outman;
+       out_free          outfree;
+       void             *outdata;
 };
 
-#define        IGN_SCOPE        (1 << 0)       /* Ignore scope errors. */
-#define        IGN_ESCAPE       (1 << 1)       /* Ignore bad escapes. */
-#define        IGN_MACRO        (1 << 2)       /* Ignore unknown macros. */
-#define        NO_IGN_MACRO     (1 << 3) 
-
-typedef        int             (*out_run)(void *, const struct man *,
-                               const struct mdoc *);
-typedef        void            (*out_free)(void *);
-
-extern char             *__progname;
-
 extern void             *ascii_alloc(void);
-extern int               terminal_run(void *, const struct man *, 
-                               const struct mdoc *);
-extern int               tree_run(void *, const struct man *,
-                               const struct mdoc *);
+extern int               tree_mdoc(void *, const struct mdoc *);
+extern int               tree_man(void *, const struct man *);
+extern int               terminal_mdoc(void *, const struct mdoc *);
+extern int               terminal_man(void *, const struct man *);
 extern void              terminal_free(void *);
 
 static int               foptions(int *, char *);
@@ -105,30 +107,27 @@ static    int               ffile(struct buf *, struct buf *,
                                const char *, struct curparse *);
 static int               fdesc(struct buf *, struct buf *,
                                struct curparse *);
-static int               pset(const char *, size_t, struct curparse *,
+static int               pset(const char *, int, struct curparse *,
                                struct man **, struct mdoc **);
 static struct man       *man_init(struct curparse *);
 static struct mdoc      *mdoc_init(struct curparse *);
 __dead static void       version(void);
 __dead static void       usage(void);
 
+extern char             *__progname;
+
 
 int
 main(int argc, char *argv[])
 {
        int              c, rc;
-       void            *outdata;
-       enum outt        outtype;
        struct buf       ln, blk;
-       out_run          outrun;
-       out_free         outfree;
        struct curparse  curp;
 
-       outtype = OUTT_ASCII;
-
        bzero(&curp, sizeof(struct curparse));
 
        curp.inttype = INTT_AUTO;
+       curp.outtype = OUTT_ASCII;
 
        /* LINTED */
        while (-1 != (c = getopt(argc, argv, "f:m:VW:T:")))
@@ -142,7 +141,7 @@ main(int argc, char *argv[])
                                return(0);
                        break;
                case ('T'):
-                       if ( ! toptions(&outtype, optarg))
+                       if ( ! toptions(&curp.outtype, optarg))
                                return(0);
                        break;
                case ('W'):
@@ -160,72 +159,41 @@ main(int argc, char *argv[])
        argc -= optind;
        argv += optind;
 
-       /*
-        * Allocate the appropriate front-end.  Note that utf8, latin1
-        * (both not yet implemented) and ascii all resolve to the
-        * terminal front-end with different encodings (see terminal.c).
-        * Not all frontends have cleanup or alloc routines.
-        */
-
-       switch (outtype) {
-       case (OUTT_TREE):
-               outdata = NULL;
-               outrun = tree_run;
-               outfree = NULL;
-               break;
-       case (OUTT_LINT):
-               outdata = NULL;
-               outrun = NULL;
-               outfree = NULL;
-               break;
-       default:
-               outdata = ascii_alloc();
-               outrun = terminal_run;
-               outfree = terminal_free;
-               break;
-       }
-
        /* Configure buffers. */
 
        bzero(&ln, sizeof(struct buf));
        bzero(&blk, sizeof(struct buf));
 
-       /*
-        * Main loop around available files.
-        */
-
-       if (NULL == *argv) {
-               rc = 0;
-               c = fstdin(&blk, &ln, &curp);
-
-               if (c && NULL == outrun)
-                       rc = 1;
-               /*else if (c && outrun && (*outrun)(outdata, curp.man, curp.mdoc))
-                       rc = 1;*/
-       } else {
-               while (*argv) {
-                       c = ffile(&blk, &ln, *argv, &curp);
-                       if ( ! c)
-                               break;
-                       /*if (outrun && ! (*outrun)(outdata, curp.man, curp.mdoc))
-                               break;*/
-                       if (curp.man)
-                               man_reset(curp.man);
-                       if (curp.mdoc && ! mdoc_reset(curp.mdoc)) {
-                               warnx("memory exhausted");
-                               break;
-                       }
-                       argv++;
+       rc = 1;
+
+       if (NULL == *argv)
+               if ( ! fstdin(&blk, &ln, &curp))
+                       rc = 0;
+
+       while (rc && *argv) {
+               if ( ! ffile(&blk, &ln, *argv, &curp))
+                       rc = 0;
+               argv++;
+               if (*argv && rc) {
+                       if (curp.lastman)
+                               if ( ! man_reset(curp.lastman))
+                                       rc = 0;
+                       if (curp.lastmdoc)
+                               if ( ! mdoc_reset(curp.lastmdoc))
+                                       rc = 0;
+                       curp.lastman = NULL;
+                       curp.lastmdoc = NULL;
                }
-               rc = NULL == *argv;
        }
 
        if (blk.buf)
                free(blk.buf);
        if (ln.buf)
                free(ln.buf);
-       if (outfree)
-               (*outfree)(outdata);
+
+       /* TODO: have a curp_free routine. */
+       if (curp.outfree)
+               (*curp.outfree)(curp.outdata);
        if (curp.mdoc)
                mdoc_free(curp.mdoc);
        if (curp.man)
@@ -265,9 +233,15 @@ man_init(struct curparse *curp)
        mancb.man_err = merr;
        mancb.man_warn = manwarn;
 
-       /* Set command defaults. */
+       /*
+        * Default behaviour is to ignore unknown macros.  This is
+        * specified in mandoc.1.
+        */
+
        pflags = MAN_IGN_MACRO;
 
+       /* Override default behaviour... */
+
        if (curp->fflags & NO_IGN_MACRO)
                pflags &= ~MAN_IGN_MACRO;
 
@@ -285,21 +259,30 @@ mdoc_init(struct curparse *curp)
        struct mdoc     *mdoc;
        struct mdoc_cb   mdoccb;
 
-       mdoccb.mdoc_msg = NULL;
        mdoccb.mdoc_err = merr;
        mdoccb.mdoc_warn = mdocwarn;
 
-       pflags = 0;
+       /* 
+        * Default behaviour is to ignore unknown macros, escape
+        * sequences and characters (very liberal).  This is specified
+        * in mandoc.1.
+        */
+
+       pflags = MDOC_IGN_MACRO | MDOC_IGN_ESCAPE | MDOC_IGN_CHARS;
+
+       /* Override default behaviour... */
 
        if (curp->fflags & IGN_SCOPE)
                pflags |= MDOC_IGN_SCOPE;
-       if (curp->fflags & IGN_ESCAPE)
-               pflags |= MDOC_IGN_ESCAPE;
-       if (curp->fflags & IGN_MACRO)
-               pflags |= MDOC_IGN_MACRO;
+       if (curp->fflags & NO_IGN_ESCAPE)
+               pflags &= ~MDOC_IGN_ESCAPE;
+       if (curp->fflags & NO_IGN_MACRO)
+               pflags &= ~MDOC_IGN_MACRO;
+       if (curp->fflags & NO_IGN_CHARS)
+               pflags &= ~MDOC_IGN_CHARS;
 
        if (NULL == (mdoc = mdoc_alloc(curp, pflags, &mdoccb)))
-               warnx("memory allocated");
+               warnx("memory exhausted");
 
        return(mdoc);
 }
@@ -396,7 +379,7 @@ fdesc(struct buf *blk, struct buf *ln, struct curparse *curp)
                                continue;
                        }
 
-                       /* Check for CPP-escaped newline.  */
+                       /* Check for CPP-escaped newline. */
 
                        if (pos > 0 && '\\' == ln->buf[pos - 1]) {
                                for (j = pos - 1; j >= 0; j--)
@@ -435,18 +418,55 @@ fdesc(struct buf *blk, struct buf *ln, struct curparse *curp)
 
        /* Note that a parser may not have been assigned, yet. */
 
-       if (mdoc)
-              return(mdoc_endparse(mdoc));
-       if (man)
-               return(man_endparse(man));
+       if ( ! (man || mdoc)) {
+               warnx("%s: not a manual", curp->file);
+               return(0);
+       }
+
+       if (mdoc && ! mdoc_endparse(mdoc))
+               return(0);
+       if (man && ! man_endparse(man))
+               return(0);
 
-       warnx("%s: not a manual", curp->file);
-       return(0);
+       /*
+        * If an output device hasn't been allocated, see if we should
+        * do so now.  Note that not all outtypes have functions, so
+        * this switch statement may be superfluous, but it's
+        * low-overhead enough not to matter very much.
+        */
+
+       if ( ! (curp->outman && curp->outmdoc)) {
+               switch (curp->outtype) {
+               case (OUTT_TREE):
+                       curp->outman = tree_man;
+                       curp->outmdoc = tree_mdoc;
+                       break;
+               case (OUTT_LINT):
+                       break;
+               default:
+                       curp->outdata = ascii_alloc();
+                       curp->outman = terminal_man;
+                       curp->outmdoc = terminal_mdoc;
+                       curp->outfree = terminal_free;
+                       break;
+               }
+       }
+
+       /* Execute the out device, if it exists. */
+
+       if (man && curp->outman)
+               if ( ! (*curp->outman)(curp->outdata, man))
+                       return(0);
+       if (mdoc && curp->outmdoc)
+               if ( ! (*curp->outmdoc)(curp->outdata, mdoc))
+                       return(0);
+
+       return(1);
 }
 
 
 static int
-pset(const char *buf, size_t pos, struct curparse *curp,
+pset(const char *buf, int pos, struct curparse *curp,
                struct man **man, struct mdoc **mdoc)
 {
 
@@ -467,14 +487,14 @@ pset(const char *buf, size_t pos, struct curparse *curp,
                        curp->mdoc = mdoc_init(curp);
                if (NULL == (*mdoc = curp->mdoc))
                        return(0);
-               warnx("inheriting -mdoc parser");
+               curp->lastmdoc = *mdoc;
                return(1);
        case (INTT_MAN):
                if (NULL == curp->man) 
                        curp->man = man_init(curp);
                if (NULL == (*man = curp->man))
                        return(0);
-               warnx("inheriting -man parser");
+               curp->lastman = *man;
                return(1);
        default:
                break;
@@ -485,6 +505,7 @@ pset(const char *buf, size_t pos, struct curparse *curp,
                        curp->mdoc = mdoc_init(curp);
                if (NULL == (*mdoc = curp->mdoc))
                        return(0);
+               curp->lastmdoc = *mdoc;
                return(1);
        } 
 
@@ -492,6 +513,7 @@ pset(const char *buf, size_t pos, struct curparse *curp,
                curp->man = man_init(curp);
        if (NULL == (*man = curp->man))
                return(0);
+       curp->lastman = *man;
        return(1);
 }
 
@@ -542,12 +564,13 @@ static int
 foptions(int *fflags, char *arg)
 {
        char            *v;
-       char            *toks[5];
+       char            *toks[6];
 
        toks[0] = "ign-scope";
-       toks[1] = "ign-escape";
-       toks[2] = "ign-macro";
-       toks[4] = "no-ign-macro";
+       toks[1] = "no-ign-escape";
+       toks[2] = "no-ign-macro";
+       toks[3] = "no-ign-chars";
+       toks[4] = "strict";
        toks[5] = NULL;
 
        while (*arg) 
@@ -556,13 +579,17 @@ foptions(int *fflags, char *arg)
                        *fflags |= IGN_SCOPE;
                        break;
                case (1):
-                       *fflags |= IGN_ESCAPE;
+                       *fflags |= NO_IGN_ESCAPE;
                        break;
                case (2):
-                       *fflags |= IGN_MACRO;
+                       *fflags |= NO_IGN_MACRO;
                        break;
                case (3):
-                       *fflags |= NO_IGN_MACRO;
+                       *fflags |= NO_IGN_CHARS;
+                       break;
+               case (4):
+                       *fflags |= NO_IGN_ESCAPE | 
+                                  NO_IGN_MACRO | NO_IGN_CHARS;
                        break;
                default:
                        warnx("bad argument: -f%s", arg);
@@ -619,9 +646,10 @@ merr(void *arg, int line, int col, const char *msg)
        struct curparse *curp;
 
        curp = (struct curparse *)arg;
-
        warnx("%s:%d: error: %s (column %d)", 
                        curp->file, line, msg, col);
+
+       /* Always exit on errors... */
        return(0);
 }
 
@@ -655,6 +683,11 @@ mdocwarn(void *arg, int line, int col,
 
        if ( ! (curp->wflags & WARN_WERR))
                return(1);
+       
+       /*
+        * If the -Werror flag is passed in, as in gcc, then all
+        * warnings are considered as errors.
+        */
 
        warnx("%s: considering warnings as errors", 
                        __progname);
@@ -678,6 +711,11 @@ manwarn(void *arg, int line, int col, const char *msg)
        if ( ! (curp->wflags & WARN_WERR))
                return(1);
 
+       /* 
+        * If the -Werror flag is passed in, as in gcc, then all
+        * warnings are considered as errors.
+        */
+
        warnx("%s: considering warnings as errors", 
                        __progname);
        return(0);