"Groff allows the initial macro on a line to be delimited by a space of

[mandoc.git] / main.c

diff --git a/main.c b/main.c
index 11b7a9002240717efcfae7e7696ab8d1f58aa459..4ad45ab2954ddc91774ad6407150ee8f34210cd5 100644 (file)
--- a/main.c
+++ b/main.c
@@ -1,6 +1,7 @@
-/*     $Id: main.c,v 1.91 2010/06/26 15:36:37 kristaps Exp $ */
+/*     $Id: main.c,v 1.101 2010/07/29 22:00:39 joerg Exp $ */

 /*
 /*

- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2010 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
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above


@@ -22,6 +23,7 @@
 #include <sys/stat.h>
 
 #include <assert.h>
 #include <sys/stat.h>
 
 #include <assert.h>

+#include <ctype.h>

 #include <fcntl.h>
 #include <stdio.h>
 #include <stdint.h>
 #include <fcntl.h>
 #include <stdio.h>
 #include <stdint.h>


@@ -30,12 +32,15 @@
 #include <unistd.h>
 
 #include "mandoc.h"
 #include <unistd.h>
 
 #include "mandoc.h"

-#include "regs.h"

 #include "main.h"
 #include "mdoc.h"
 #include "man.h"
 #include "roff.h"
 
 #include "main.h"
 #include "mdoc.h"
 #include "man.h"
 #include "roff.h"
 

+#ifndef MAP_FILE
+#define        MAP_FILE        0
+#endif
+

 #define        UNCONST(a)      ((void *)(uintptr_t)(const void *)(a))
 
 /* FIXME: Intel's compiler?  LLVM?  pcc?  */
 #define        UNCONST(a)      ((void *)(uintptr_t)(const void *)(a))
 
 /* FIXME: Intel's compiler?  LLVM?  pcc?  */


@@ -67,7 +72,8 @@ enum  outt {
        OUTT_HTML,
        OUTT_XHTML,
        OUTT_LINT,
        OUTT_HTML,
        OUTT_XHTML,
        OUTT_LINT,

-       OUTT_PS
+       OUTT_PS,
+       OUTT_PDF

 };
 
 struct curparse {
 };
 
 struct curparse {


@@ -88,6 +94,7 @@ struct        curparse {
        struct man       *man;          /* man parser */
        struct mdoc      *mdoc;         /* mdoc parser */
        struct roff      *roff;         /* roff parser (!NULL) */
        struct man       *man;          /* man parser */
        struct mdoc      *mdoc;         /* mdoc parser */
        struct roff      *roff;         /* roff parser (!NULL) */

+       struct regset     regs;         /* roff registers */

        enum outt         outtype;      /* which output to use */
        out_mdoc          outmdoc;      /* mdoc output ptr */
        out_man           outman;       /* man output ptr */
        enum outt         outtype;      /* which output to use */
        out_mdoc          outmdoc;      /* mdoc output ptr */
        out_man           outman;       /* man output ptr */


@@ -98,6 +105,9 @@ struct       curparse {
 
 static const char * const      mandocerrs[MANDOCERR_MAX] = {
        "ok",
 
 static const char * const      mandocerrs[MANDOCERR_MAX] = {
        "ok",

+
+       "generic warning",
+

        "text should be uppercase",
        "sections out of conventional order",
        "section name repeats",
        "text should be uppercase",
        "sections out of conventional order",
        "section name repeats",


@@ -106,6 +116,7 @@ static      const char * const      mandocerrs[MANDOCERR_MAX] = {
        "list type must come first",
        "bad standard",
        "bad library",
        "list type must come first",
        "bad standard",
        "bad library",

+       "tab in non-literal context",

        "bad escape sequence",
        "unterminated quoted string",
        "argument requires the width argument",
        "bad escape sequence",
        "unterminated quoted string",
        "argument requires the width argument",


@@ -116,7 +127,11 @@ static     const char * const      mandocerrs[MANDOCERR_MAX] = {
        "unknown manual section",
        "section not in conventional manual section",
        "end of line whitespace",
        "unknown manual section",
        "section not in conventional manual section",
        "end of line whitespace",

+       "blocks badly nested",

        "scope open on exit",
        "scope open on exit",

+
+       "generic error",
+

        "NAME section must come first",
        "bad Boolean value",
        "child violates parent syntax",
        "NAME section must come first",
        "bad Boolean value",
        "child violates parent syntax",


@@ -136,7 +151,6 @@ static      const char * const      mandocerrs[MANDOCERR_MAX] = {
        "bad comment style",
        "unknown macro will be lost",
        "line scope broken",
        "bad comment style",
        "unknown macro will be lost",
        "line scope broken",

-       "scope broken",

        "argument count wrong",
        "request scope close w/none open",
        "scope already open",
        "argument count wrong",
        "request scope close w/none open",
        "scope already open",


@@ -146,13 +160,17 @@ static    const char * const      mandocerrs[MANDOCERR_MAX] = {
        "no title in document",
        "missing list type",
        "missing display type",
        "no title in document",
        "missing list type",
        "missing display type",

+       "missing font type",

        "line argument(s) will be lost",
        "body argument(s) will be lost",
        "line argument(s) will be lost",
        "body argument(s) will be lost",

+
+       "generic fatal error",
+

        "column syntax is inconsistent",
        "column syntax is inconsistent",

-       "missing font type",

        "displays may not be nested",
        "unsupported display type",
        "displays may not be nested",
        "unsupported display type",

-       "no scope to rewind: syntax violated",
+       "blocks badly nested",
+       "no such block is open",

        "scope broken, syntax violated",
        "line scope broken, syntax violated",
        "argument count wrong, violates syntax",
        "scope broken, syntax violated",
        "line scope broken, syntax violated",
        "argument count wrong, violates syntax",


@@ -181,8 +199,8 @@ static      void              version(void) __attribute__((noreturn));
 static int               woptions(int *, char *);
 
 static const char       *progname;
 static int               woptions(int *, char *);
 
 static const char       *progname;

-static         int               with_error;
-static int               with_warning;
+static int               with_fatal;
+static int               with_error;

 
 int
 main(int argc, char *argv[])
 
 int
 main(int argc, char *argv[])


@@ -245,7 +263,7 @@ main(int argc, char *argv[])
        while (*argv) {
                ffile(*argv, &curp);
 
        while (*argv) {
                ffile(*argv, &curp);
 

-               if (with_error && !(curp.fflags & FL_IGN_ERRORS))
+               if (with_fatal && !(curp.fflags & FL_IGN_ERRORS))

                        break;
                ++argv;
        }
                        break;
                ++argv;
        }


@@ -259,7 +277,7 @@ main(int argc, char *argv[])
        if (curp.roff)
                roff_free(curp.roff);
 
        if (curp.roff)
                roff_free(curp.roff);
 

-       return((with_warning || with_error) ? 
+       return((with_fatal || with_error) ? 

                        EXIT_FAILURE :  EXIT_SUCCESS);
 }
 
                        EXIT_FAILURE :  EXIT_SUCCESS);
 }
 


@@ -298,7 +316,7 @@ man_init(struct curparse *curp)
        if (curp->fflags & FL_NIGN_ESCAPE)
                pflags &= ~MAN_IGN_ESCAPE;
 
        if (curp->fflags & FL_NIGN_ESCAPE)
                pflags &= ~MAN_IGN_ESCAPE;
 

-       return(man_alloc(curp, pflags, mmsg));
+       return(man_alloc(&curp->regs, curp, pflags, mmsg));

 }
 
 
 }
 
 


@@ -306,7 +324,7 @@ static struct roff *
 roff_init(struct curparse *curp)
 {
 
 roff_init(struct curparse *curp)
 {
 

-       return(roff_alloc(mmsg, curp));
+       return(roff_alloc(&curp->regs, mmsg, curp));

 }
 
 
 }
 
 


@@ -326,7 +344,7 @@ mdoc_init(struct curparse *curp)
        if (curp->fflags & FL_NIGN_MACRO)
                pflags &= ~MDOC_IGN_MACRO;
 
        if (curp->fflags & FL_NIGN_MACRO)
                pflags &= ~MDOC_IGN_MACRO;
 

-       return(mdoc_alloc(curp, pflags, mmsg));
+       return(mdoc_alloc(&curp->regs, curp, pflags, mmsg));

 }
 
 
 }
 
 


@@ -337,7 +355,7 @@ ffile(const char *file, struct curparse *curp)
        curp->file = file;
        if (-1 == (curp->fd = open(curp->file, O_RDONLY, 0))) {
                perror(curp->file);
        curp->file = file;
        if (-1 == (curp->fd = open(curp->file, O_RDONLY, 0))) {
                perror(curp->file);

-               with_error = 1;
+               with_fatal = 1;

                return;
        }
 
                return;
        }
 


@@ -378,7 +396,7 @@ read_whole_file(struct curparse *curp, struct buf *fb, int *with_mmap)
 
        if (-1 == fstat(curp->fd, &st)) {
                perror(curp->file);
 
        if (-1 == fstat(curp->fd, &st)) {
                perror(curp->file);

-               with_error = 1;
+               with_fatal = 1;

                return(0);
        }
 
                return(0);
        }
 


@@ -393,7 +411,7 @@ read_whole_file(struct curparse *curp, struct buf *fb, int *with_mmap)
                if (st.st_size >= (1U << 31)) {
                        fprintf(stderr, "%s: input too large\n", 
                                        curp->file);
                if (st.st_size >= (1U << 31)) {
                        fprintf(stderr, "%s: input too large\n", 
                                        curp->file);

-                       with_error = 1;
+                       with_fatal = 1;

                        return(0);
                }
                *with_mmap = 1;
                        return(0);
                }
                *with_mmap = 1;


@@ -437,7 +455,7 @@ read_whole_file(struct curparse *curp, struct buf *fb, int *with_mmap)
 
        free(fb->buf);
        fb->buf = NULL;
 
        free(fb->buf);
        fb->buf = NULL;

-       with_error = 1;
+       with_fatal = 1;

        return(0);
 }
 
        return(0);
 }
 


@@ -451,13 +469,12 @@ fdesc(struct curparse *curp)
        struct man      *man;
        struct mdoc     *mdoc;
        struct roff     *roff;
        struct man      *man;
        struct mdoc     *mdoc;
        struct roff     *roff;

-       struct regset    regs;

 
        man = NULL;
        mdoc = NULL;
        roff = NULL;
 
        man = NULL;
        mdoc = NULL;
        roff = NULL;

+

        memset(&ln, 0, sizeof(struct buf));
        memset(&ln, 0, sizeof(struct buf));

-       memset(&regs, 0, sizeof(struct regset));

 
        /*
         * Two buffers: ln and buf.  buf is the input file and may be
 
        /*
         * Two buffers: ln and buf.  buf is the input file and may be


@@ -481,6 +498,26 @@ fdesc(struct curparse *curp)
                                ++lnn;
                                break;
                        }
                                ++lnn;
                                break;
                        }

+
+                       /* 
+                        * Warn about bogus characters.  If you're using
+                        * non-ASCII encoding, you're screwing your
+                        * readers.  Since I'd rather this not happen,
+                        * I'll be helpful and drop these characters so
+                        * we don't display gibberish.  Note to manual
+                        * writers: use special characters.
+                        */
+
+                       if ( ! isgraph((u_char)blk.buf[i]) &&
+                                       ! isblank((u_char)blk.buf[i])) {
+                               if ( ! mmsg(MANDOCERR_BADCHAR, curp, 
+                                               lnn_start, pos, 
+                                               "ignoring byte"))
+                                       goto bailout;
+                               i++;
+                               continue;
+                       }
+

                        /* Trailing backslash is like a plain character. */
                        if ('\\' != blk.buf[i] || i + 1 == (int)blk.sz) {
                                if (pos >= (int)ln.sz)
                        /* Trailing backslash is like a plain character. */
                        if ('\\' != blk.buf[i] || i + 1 == (int)blk.sz) {
                                if (pos >= (int)ln.sz)


@@ -540,7 +577,7 @@ fdesc(struct curparse *curp)
 
                of = 0;
                do {
 
                of = 0;
                do {

-                       re = roff_parseln(roff, &regs, lnn_start, 
+                       re = roff_parseln(roff, lnn_start, 

                                        &ln.buf, &ln.sz, of, &of);
                } while (ROFF_RERUN == re);
 
                                        &ln.buf, &ln.sz, of, &of);
                } while (ROFF_RERUN == re);
 


@@ -562,9 +599,9 @@ fdesc(struct curparse *curp)
 
                /* Lastly, push down into the parsers themselves. */
 
 
                /* Lastly, push down into the parsers themselves. */
 

-               if (man && ! man_parseln(man, &regs, lnn_start, ln.buf, of))
+               if (man && ! man_parseln(man, lnn_start, ln.buf, of))

                        goto bailout;
                        goto bailout;

-               if (mdoc && ! mdoc_parseln(mdoc, &regs, lnn_start, ln.buf, of))
+               if (mdoc && ! mdoc_parseln(mdoc, lnn_start, ln.buf, of))

                        goto bailout;
        }
 
                        goto bailout;
        }
 


@@ -598,9 +635,13 @@ fdesc(struct curparse *curp)
                        curp->outdata = ascii_alloc(curp->outopts);
                        curp->outfree = ascii_free;
                        break;
                        curp->outdata = ascii_alloc(curp->outopts);
                        curp->outfree = ascii_free;
                        break;

+               case (OUTT_PDF):
+                       curp->outdata = pdf_alloc(curp->outopts);
+                       curp->outfree = pspdf_free;
+                       break;

                case (OUTT_PS):
                case (OUTT_PS):

-                       curp->outdata = ps_alloc();
-                       curp->outfree = ps_free;
+                       curp->outdata = ps_alloc(curp->outopts);
+                       curp->outfree = pspdf_free;

                        break;
                default:
                        break;
                        break;
                default:
                        break;


@@ -618,6 +659,8 @@ fdesc(struct curparse *curp)
                        curp->outman = tree_man;
                        curp->outmdoc = tree_mdoc;
                        break;
                        curp->outman = tree_man;
                        curp->outmdoc = tree_mdoc;
                        break;

+               case (OUTT_PDF):
+                       /* FALLTHROUGH */

                case (OUTT_ASCII):
                        /* FALLTHROUGH */
                case (OUTT_PS):
                case (OUTT_ASCII):
                        /* FALLTHROUGH */
                case (OUTT_PS):


@@ -637,6 +680,7 @@ fdesc(struct curparse *curp)
                (*curp->outmdoc)(curp->outdata, mdoc);
 
  cleanup:
                (*curp->outmdoc)(curp->outdata, mdoc);
 
  cleanup:

+       memset(&curp->regs, 0, sizeof(struct regset));

        if (mdoc)
                mdoc_reset(mdoc);
        if (man)
        if (mdoc)
                mdoc_reset(mdoc);
        if (man)


@@ -653,7 +697,7 @@ fdesc(struct curparse *curp)
        return;
 
  bailout:
        return;
 
  bailout:

-       with_error = 1;
+       with_fatal = 1;

        goto cleanup;
 }
 
        goto cleanup;
 }
 


@@ -751,6 +795,8 @@ toptions(struct curparse *curp, char *arg)
                curp->outtype = OUTT_XHTML;
        else if (0 == strcmp(arg, "ps"))
                curp->outtype = OUTT_PS;
                curp->outtype = OUTT_XHTML;
        else if (0 == strcmp(arg, "ps"))
                curp->outtype = OUTT_PS;

+       else if (0 == strcmp(arg, "pdf"))
+               curp->outtype = OUTT_PDF;

        else {
                fprintf(stderr, "%s: Bad argument\n", arg);
                return(0);
        else {
                fprintf(stderr, "%s: Bad argument\n", arg);
                return(0);


@@ -838,30 +884,37 @@ static int
 mmsg(enum mandocerr t, void *arg, int ln, int col, const char *msg)
 {
        struct curparse *cp;
 mmsg(enum mandocerr t, void *arg, int ln, int col, const char *msg)
 {
        struct curparse *cp;

+       const char *level;
+       int rc;

 
        cp = (struct curparse *)arg;
 
        cp = (struct curparse *)arg;

-
-       if (t <= MANDOCERR_ERROR) {
-               if ( ! (cp->wflags & WARN_WALL))
+       level = NULL;
+       rc = 1;
+
+       if (t >= MANDOCERR_FATAL) {
+               with_fatal = 1;
+               level = "FATAL";
+               rc = 0;
+       } else {
+               if ( ! (WARN_WALL & cp->wflags))

                        return(1);
                        return(1);

-               with_warning = 1;
-       } else
-               with_error = 1;
-
-       fprintf(stderr, "%s:%d:%d: %s", cp->file, 
-                       ln, col + 1, mandocerrs[t]);
+               if (t >= MANDOCERR_ERROR) {
+                       with_error = 1;
+                       level = "ERROR";
+               }
+               if (WARN_WERR & cp->wflags) {
+                       with_fatal = 1;
+                       rc = 0;
+               }
+       }

 
 

+       fprintf(stderr, "%s:%d:%d:", cp->file, ln, col + 1);
+       if (level)
+               fprintf(stderr, " %s:", level);
+       fprintf(stderr, " %s", mandocerrs[t]);

        if (msg)
                fprintf(stderr, ": %s", msg);
        if (msg)
                fprintf(stderr, ": %s", msg);

-

        fputc('\n', stderr);
 
        fputc('\n', stderr);
 

-       /* This is superfluous, but whatever. */
-       if (t > MANDOCERR_ERROR)
-               return(0);
-       if (cp->wflags & WARN_WERR) {
-               with_error = 1;
-               return(0);
-       }
-       return(1);
+       return(rc);

 }
 }