]> git.cameronkatri.com Git - mandoc.git/commitdiff
It's annoying that we don't have preconv, so throw together a quick
authorKristaps Dzonsons <kristaps@bsd.lv>
Thu, 26 May 2011 00:30:11 +0000 (00:30 +0000)
committerKristaps Dzonsons <kristaps@bsd.lv>
Thu, 26 May 2011 00:30:11 +0000 (00:30 +0000)
version and let it grow in-tree.  Right now, this only supports the
Latin-1 and US-ASCII encoding.  I'll do UTF-8 next.  It's
call-compatible with GNU's preconv although I don't do fancy stuff like
BOM or header check.  This will come.  I used read.c's file-grokking
code.

Makefile
preconv.c [new file with mode: 0644]

index 2f49ffd2fa2844beff2339dd9323ef89d1cc7d7b..aa3b29b740525c2cda90afcf123452869464b2dd 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -228,6 +228,11 @@ MAKEWHATIS_LNS      = makewhatis.ln
 
 $(MAKEWHATIS_OBJS) $(MAKEWHATIS_LNS): mandoc.h mdoc.h man.h config.h
 
 
 $(MAKEWHATIS_OBJS) $(MAKEWHATIS_LNS): mandoc.h mdoc.h man.h config.h
 
+PRECONV_OBJS    = preconv.o
+PRECONV_LNS     = preconv.ln
+
+$(PRECONV_OBJS) $(PRECONV_LNS): config.h
+
 INDEX_MANS      = makewhatis.1.html \
                   makewhatis.1.xhtml \
                   makewhatis.1.ps \
 INDEX_MANS      = makewhatis.1.html \
                   makewhatis.1.xhtml \
                   makewhatis.1.ps \
@@ -292,6 +297,8 @@ clean:
        rm -f llib-llibmandoc.ln $(LIBMANDOC_LNS)
        rm -f makewhatis $(MAKEWHATIS_OBJS)
        rm -f llib-lmakewhatis.ln $(MAKEWHATIS_LNS)
        rm -f llib-llibmandoc.ln $(LIBMANDOC_LNS)
        rm -f makewhatis $(MAKEWHATIS_OBJS)
        rm -f llib-lmakewhatis.ln $(MAKEWHATIS_LNS)
+       rm -f preconv $(PRECONV_OBJS)
+       rm -f llib-lpreconv.ln $(PRECONV_LNS)
        rm -f mandoc $(MANDOC_OBJS)
        rm -f llib-lmandoc.ln $(MANDOC_LNS)
        rm -f config.h config.log compat.o compat.ln
        rm -f mandoc $(MANDOC_OBJS)
        rm -f llib-lmandoc.ln $(MANDOC_LNS)
        rm -f config.h config.log compat.o compat.ln
@@ -333,16 +340,22 @@ llib-llibmandoc.ln: compat.ln $(LIBMANDOC_LNS)
 mandoc: $(MANDOC_OBJS) libmandoc.a
        $(CC) -o $@ $(MANDOC_OBJS) libmandoc.a
 
 mandoc: $(MANDOC_OBJS) libmandoc.a
        $(CC) -o $@ $(MANDOC_OBJS) libmandoc.a
 
+llib-lmandoc.ln: $(MANDOC_LNS)
+       $(LINT) $(LINTFLAGS) -Cmandoc $(MANDOC_LNS)
+
 # You'll need -ldb for Linux.
 makewhatis: $(MAKEWHATIS_OBJS) libmandoc.a
        $(CC) -o $@ $(MAKEWHATIS_OBJS) libmandoc.a
 
 # You'll need -ldb for Linux.
 makewhatis: $(MAKEWHATIS_OBJS) libmandoc.a
        $(CC) -o $@ $(MAKEWHATIS_OBJS) libmandoc.a
 
-llib-lmandoc.ln: $(MANDOC_LNS)
-       $(LINT) $(LINTFLAGS) -Cmandoc $(MANDOC_LNS)
-
 llib-lmakewhatis.ln: $(MAKEWHATIS_LNS)
        $(LINT) $(LINTFLAGS) -Cmakewhatis $(MAKEWHATIS_LNS)
 
 llib-lmakewhatis.ln: $(MAKEWHATIS_LNS)
        $(LINT) $(LINTFLAGS) -Cmakewhatis $(MAKEWHATIS_LNS)
 
+preconv: $(PRECONV_OBJS)
+       $(CC) -o $@ $(PRECONV_OBJS)
+
+llib-lpreconv.ln: $(PRECONV_LNS)
+       $(LINT) $(LINTFLAGS) -Cpreconv $(PRECONV_LNS)
+
 mdocml.md5: mdocml.tar.gz
        md5 mdocml.tar.gz >$@
 
 mdocml.md5: mdocml.tar.gz
        md5 mdocml.tar.gz >$@
 
diff --git a/preconv.c b/preconv.c
new file mode 100644 (file)
index 0000000..ce091ec
--- /dev/null
+++ b/preconv.c
@@ -0,0 +1,316 @@
+/*     $Id: preconv.c,v 1.1 2011/05/26 00:30:11 kristaps Exp $ */
+/*
+ * Copyright (c) 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
+ * 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.
+ */
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include <sys/stat.h>
+#include <sys/mman.h>
+
+#include <assert.h>
+#include <fcntl.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <unistd.h>
+
+/* 
+ * The read_whole_file() and resize_buf() functions are copied from
+ * read.c, including all dependency code (MAP_FILE, etc.).
+ */
+
+#ifndef MAP_FILE
+#define        MAP_FILE        0
+#endif
+
+enum   enc {
+       ENC_UTF_8, /* UTF-8 */
+       ENC_US_ASCII, /* US-ASCII */
+       ENC_LATIN_1, /* Latin-1 */
+       ENC__MAX
+};
+
+struct buf {
+       char             *buf; /* binary input buffer */
+       size_t            sz; /* size of binary buffer */
+       size_t            offs; /* starting buffer offset */
+};
+
+struct encode {
+       const char       *name;
+       int             (*conv)(const struct buf *);
+};
+
+static int      conv_latin_1(const struct buf *);
+static int      conv_us_ascii(const struct buf *);
+static int      conv_utf_8(const struct buf *);
+static int      read_whole_file(const char *, int, 
+                       struct buf *, int *);
+static void     resize_buf(struct buf *, size_t);
+static void     usage(void);
+
+static const struct encode encs[ENC__MAX] = {
+       { "utf-8", conv_utf_8 }, /* ENC_UTF_8 */
+       { "us-ascii", conv_us_ascii }, /* ENC_US_ASCII */
+       { "latin-1", conv_latin_1 }, /* ENC_LATIN_1 */
+};
+
+static const char       *progname;
+
+static void
+usage(void)
+{
+
+       fprintf(stderr, "usage: %s "
+                       "[-D enc] "
+                       "[-e ENC] "
+                       "[file]\n", progname);
+}
+
+static int
+conv_latin_1(const struct buf *b)
+{
+       size_t           i;
+       unsigned char    c;
+       const char      *cp;
+
+       cp = b->buf + (int)b->offs;
+
+       /*
+        * Latin-1 falls into the first 256 code-points of Unicode, so
+        * there's no need for any sort of translation.  Just make the
+        * 8-bit characters use the Unicode escape.
+        */
+
+       for (i = b->offs; i < b->sz; i++) {
+               c = (unsigned char)*cp++;
+               c < 128 ? putchar(c) : printf("\\[u%.4X]", c);
+       }
+
+       return(1);
+}
+
+static int
+conv_us_ascii(const struct buf *b)
+{
+
+       /*
+        * US-ASCII has no conversion since it falls into the first 128
+        * bytes of Unicode.
+        */
+
+       fwrite(b->buf, 1, b->sz, stdout);
+       return(1);
+}
+
+static int
+conv_utf_8(const struct buf *b)
+{
+
+       return(1);
+}
+
+static void
+resize_buf(struct buf *buf, size_t initial)
+{
+
+       buf->sz = buf->sz > initial / 2 ? 
+               2 * buf->sz : initial;
+
+       buf->buf = realloc(buf->buf, buf->sz);
+       if (NULL == buf->buf) {
+               perror(NULL);
+               exit(EXIT_FAILURE);
+       }
+}
+
+static int
+read_whole_file(const char *f, int fd, 
+               struct buf *fb, int *with_mmap)
+{
+       struct stat      st;
+       size_t           off;
+       ssize_t          ssz;
+
+       if (-1 == fstat(fd, &st)) {
+               perror(f);
+               return(0);
+       }
+
+       /*
+        * If we're a regular file, try just reading in the whole entry
+        * via mmap().  This is faster than reading it into blocks, and
+        * since each file is only a few bytes to begin with, I'm not
+        * concerned that this is going to tank any machines.
+        */
+
+       if (S_ISREG(st.st_mode) && st.st_size >= (1U << 31)) {
+               fprintf(stderr, "%s: input too large\n", f);
+               return(0);
+       } 
+       
+       if (S_ISREG(st.st_mode)) {
+               *with_mmap = 1;
+               fb->sz = (size_t)st.st_size;
+               fb->buf = mmap(NULL, fb->sz, PROT_READ, 
+                               MAP_FILE|MAP_SHARED, fd, 0);
+               if (fb->buf != MAP_FAILED)
+                       return(1);
+       }
+
+       /*
+        * If this isn't a regular file (like, say, stdin), then we must
+        * go the old way and just read things in bit by bit.
+        */
+
+       *with_mmap = 0;
+       off = 0;
+       fb->sz = 0;
+       fb->buf = NULL;
+       for (;;) {
+               if (off == fb->sz && fb->sz == (1U << 31)) {
+                       fprintf(stderr, "%s: input too large\n", f);
+                       break;
+               } 
+               
+               if (off == fb->sz)
+                       resize_buf(fb, 65536);
+
+               ssz = read(fd, fb->buf + (int)off, fb->sz - off);
+               if (ssz == 0) {
+                       fb->sz = off;
+                       return(1);
+               }
+               if (ssz == -1) {
+                       perror(f);
+                       break;
+               }
+               off += (size_t)ssz;
+       }
+
+       free(fb->buf);
+       fb->buf = NULL;
+       return(0);
+}
+
+int
+main(int argc, char *argv[])
+{
+       int              i, ch, map, fd, rc;
+       struct buf       buf;
+       const char      *fn;
+       enum enc         enc, def;
+       extern int       optind;
+       extern char     *optarg;
+
+       progname = strrchr(argv[0], '/');
+       if (progname == NULL)
+               progname = argv[0];
+       else
+               ++progname;
+
+       fn = "<stdin>";
+       fd = STDIN_FILENO;
+       rc = EXIT_FAILURE;
+       enc = def = ENC__MAX;
+       map = 0;
+
+       memset(&buf, 0, sizeof(struct buf));
+
+       while (-1 != (ch = getopt(argc, argv, "D:e:rdvh")))
+               switch (ch) {
+               case ('D'):
+                       /* FALLTHROUGH */
+               case ('e'):
+                       for (i = 0; i < ENC__MAX; i++) {
+                               if (strcasecmp(optarg, encs[i].name))
+                                       continue;
+                               break;
+                       }
+                       if (i < ENC__MAX) {
+                               if ('D' == ch)
+                                       def = (enum enc)i;
+                               else
+                                       enc = (enum enc)i;
+                               break;
+                       }
+
+                       fprintf(stderr, "%s: Bad encoding\n", optarg);
+                       return(EXIT_FAILURE);
+               case ('r'):
+                       /* FALLTHROUGH */
+               case ('d'):
+                       /* FALLTHROUGH */
+               case ('v'):
+                       /* Compatibility with GNU preconv. */
+                       break;
+               case ('h'):
+                       /* Compatibility with GNU preconv. */
+                       /* FALLTHROUGH */
+               default:
+                       usage();
+                       return(EXIT_FAILURE);
+               }
+
+       argc -= optind;
+       argv += optind;
+       
+       /* 
+        * Open and read the first argument on the command-line.
+        * If we don't have one, we default to stdin.
+        */
+
+       if (argc > 0) {
+               fn = *argv;
+               fd = open(fn, O_RDONLY, 0);
+               if (-1 == fd) {
+                       perror(fn);
+                       return(EXIT_FAILURE);
+               }
+       }
+
+       if ( ! read_whole_file(fn, fd, &buf, &map))
+               goto out;
+
+       if (ENC__MAX == enc) {
+               /* TODO: search for BOM. */
+       }
+
+       /*
+        * No encoding has been detected.
+        * Thus, we either fall into our default encoder, if specified,
+        * or use Latin-1 if all else fails.
+        */
+
+       if (ENC__MAX == enc) 
+               enc = ENC__MAX == def ? ENC_LATIN_1 : def;
+
+       if ( ! (*encs[(int)enc].conv)(&buf))
+               goto out;
+
+       rc = EXIT_SUCCESS;
+out:
+       if (map)
+               munmap(buf.buf, buf.sz);
+       else 
+               free(buf.buf);
+
+       if (fd > STDIN_FILENO)
+               close(fd);
+
+       return(rc);
+}