mandoc 0.0.1

data/mandoc-1.14.6/dbm_map.c

@@ -0,0 +1,194 @@
+/*	$Id: dbm_map.c,v 1.8 2017/02/17 14:43:54 schwarze Exp $ */
+/*
+ * Copyright (c) 2016 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
+ * 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.
+ *
+ * Low-level routines for the map-based version
+ * of the mandoc database, for read-only access.
+ * The interface is defined in "dbm_map.h".
+ */
+#include "config.h"
+
+#include <sys/mman.h>
+#include <sys/stat.h>
+#include <sys/types.h>
+
+#if HAVE_ENDIAN
+#include <endian.h>
+#elif HAVE_SYS_ENDIAN
+#include <sys/endian.h>
+#elif HAVE_NTOHL
+#include <arpa/inet.h>
+#endif
+#if HAVE_ERR
+#include <err.h>
+#endif
+#include <errno.h>
+#include <fcntl.h>
+#include <regex.h>
+#include <stdint.h>
+#include <stdlib.h>
+#include <string.h>
+#include <unistd.h>
+
+#include "mansearch.h"
+#include "dbm_map.h"
+#include "dbm.h"
+
+static struct stat	 st;
+static char		*dbm_base;
+static int		 ifd;
+static int32_t		 max_offset;
+
+/*
+ * Open a disk-based database for read-only access.
+ * Validate the file format as far as it is not mandoc-specific.
+ * Return 0 on success.  Return -1 and set errno on failure.
+ */
+int
+dbm_map(const char *fname)
+{
+	int		 save_errno;
+	const int32_t	*magic;
+
+	if ((ifd = open(fname, O_RDONLY)) == -1)
+		return -1;
+	if (fstat(ifd, &st) == -1)
+		goto fail;
+	if (st.st_size < 5) {
+		warnx("dbm_map(%s): File too short", fname);
+		errno = EFTYPE;
+		goto fail;
+	}
+	if (st.st_size > INT32_MAX) {
+		errno = EFBIG;
+		goto fail;
+	}
+	if ((dbm_base = mmap(NULL, st.st_size, PROT_READ, MAP_SHARED,
+	    ifd, 0)) == MAP_FAILED)
+		goto fail;
+	magic = dbm_getint(0);
+	if (be32toh(*magic) != MANDOCDB_MAGIC) {
+		if (strncmp(dbm_base, "SQLite format 3", 15))
+			warnx("dbm_map(%s): "
+			    "Bad initial magic %x (expected %x)",
+			    fname, be32toh(*magic), MANDOCDB_MAGIC);
+		else
+			warnx("dbm_map(%s): "
+			    "Obsolete format based on SQLite 3",
+			    fname);
+		errno = EFTYPE;
+		goto fail;
+	}
+	magic = dbm_getint(1);
+	if (be32toh(*magic) != MANDOCDB_VERSION) {
+		warnx("dbm_map(%s): Bad version number %d (expected %d)",
+		    fname, be32toh(*magic), MANDOCDB_VERSION);
+		errno = EFTYPE;
+		goto fail;
+	}
+	max_offset = be32toh(*dbm_getint(3)) + sizeof(int32_t);
+	if (st.st_size != max_offset) {
+		warnx("dbm_map(%s): Inconsistent file size %lld (expected %d)",
+		    fname, (long long)st.st_size, max_offset);
+		errno = EFTYPE;
+		goto fail;
+	}
+	if ((magic = dbm_get(*dbm_getint(3))) == NULL) {
+		errno = EFTYPE;
+		goto fail;
+	}
+	if (be32toh(*magic) != MANDOCDB_MAGIC) {
+		warnx("dbm_map(%s): Bad final magic %x (expected %x)",
+		    fname, be32toh(*magic), MANDOCDB_MAGIC);
+		errno = EFTYPE;
+		goto fail;
+	}
+	return 0;
+
+fail:
+	save_errno = errno;
+	close(ifd);
+	errno = save_errno;
+	return -1;
+}
+
+void
+dbm_unmap(void)
+{
+	if (munmap(dbm_base, st.st_size) == -1)
+		warn("dbm_unmap: munmap");
+	if (close(ifd) == -1)
+		warn("dbm_unmap: close");
+	dbm_base = (char *)-1;
+}
+
+/*
+ * Take a raw integer as it was read from the database.
+ * Interpret it as an offset into the database file
+ * and return a pointer to that place in the file.
+ */
+void *
+dbm_get(int32_t offset)
+{
+	offset = be32toh(offset);
+	if (offset < 0) {
+		warnx("dbm_get: Database corrupt: offset %d", offset);
+		return NULL;
+	}
+	if (offset >= max_offset) {
+		warnx("dbm_get: Database corrupt: offset %d > %d",
+		    offset, max_offset);
+		return NULL;
+	}
+	return dbm_base + offset;
+}
+
+/*
+ * Assume the database starts with some integers.
+ * Assume they are numbered starting from 0, increasing.
+ * Get a pointer to one with the number "offset".
+ */
+int32_t *
+dbm_getint(int32_t offset)
+{
+	return (int32_t *)dbm_base + offset;
+}
+
+/*
+ * The reverse of dbm_get().
+ * Take pointer into the database file
+ * and convert it to the raw integer
+ * that would be used to refer to that place in the file.
+ */
+int32_t
+dbm_addr(const void *p)
+{
+	return htobe32((const char *)p - dbm_base);
+}
+
+int
+dbm_match(const struct dbm_match *match, const char *str)
+{
+	switch (match->type) {
+	case DBM_EXACT:
+		return strcmp(str, match->str) == 0;
+	case DBM_SUB:
+		return strcasestr(str, match->str) != NULL;
+	case DBM_REGEX:
+		return regexec(match->re, str, 0, NULL, 0) == 0;
+	default:
+		abort();
+	}
+}

data/mandoc-1.14.6/dbm_map.h

@@ -0,0 +1,29 @@
+/*	$Id: dbm_map.h,v 1.2 2019/07/01 22:56:24 schwarze Exp $ */
+/*
+ * Copyright (c) 2016 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
+ * 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.
+ *
+ * Private interface for low-level routines for the map-based version
+ * of the mandoc database, for read-only access.
+ * To be used by dbm*.c only.
+ */
+
+struct dbm_match;
+
+int		 dbm_map(const char *);
+void		 dbm_unmap(void);
+void		*dbm_get(int32_t);
+int32_t		*dbm_getint(int32_t);
+int32_t		 dbm_addr(const void *);
+int		 dbm_match(const struct dbm_match *, const char *);

data/mandoc-1.14.6/demandoc.c

@@ -0,0 +1,260 @@
+/*	$Id: demandoc.c,v 1.33 2019/03/03 11:01:15 schwarze 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.
+ */
+#include "config.h"
+
+#include <sys/types.h>
+
+#include <assert.h>
+#include <ctype.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <unistd.h>
+
+#include "mandoc.h"
+#include "roff.h"
+#include "man.h"
+#include "mdoc.h"
+#include "mandoc_parse.h"
+
+static	void	 pline(int, int *, int *, int);
+static	void	 pman(const struct roff_node *, int *, int *, int);
+static	void	 pmandoc(struct mparse *, int, const char *, int);
+static	void	 pmdoc(const struct roff_node *, int *, int *, int);
+static	void	 pstring(const char *, int, int *, int);
+static	void	 usage(void);
+
+static	const char	 *progname;
+
+int
+main(int argc, char *argv[])
+{
+	struct mparse	*mp;
+	int		 ch, fd, i, list;
+	extern int	 optind;
+
+	if (argc < 1)
+		progname = "demandoc";
+	else if ((progname = strrchr(argv[0], '/')) == NULL)
+		progname = argv[0];
+	else
+		++progname;
+
+	mp = NULL;
+	list = 0;
+
+	while (-1 != (ch = getopt(argc, argv, "ikm:pw")))
+		switch (ch) {
+		case ('i'):
+			/* FALLTHROUGH */
+		case ('k'):
+			/* FALLTHROUGH */
+		case ('m'):
+			/* FALLTHROUGH */
+		case ('p'):
+			break;
+		case ('w'):
+			list = 1;
+			break;
+		default:
+			usage();
+			return (int)MANDOCLEVEL_BADARG;
+		}
+
+	argc -= optind;
+	argv += optind;
+
+	mchars_alloc();
+	mp = mparse_alloc(MPARSE_SO | MPARSE_UTF8 | MPARSE_LATIN1 |
+	    MPARSE_VALIDATE, MANDOC_OS_OTHER, NULL);
+	assert(mp);
+
+	if (argc < 1)
+		pmandoc(mp, STDIN_FILENO, "<stdin>", list);
+
+	for (i = 0; i < argc; i++) {
+		mparse_reset(mp);
+		if ((fd = mparse_open(mp, argv[i])) == -1) {
+			perror(argv[i]);
+			continue;
+		}
+		pmandoc(mp, fd, argv[i], list);
+	}
+
+	mparse_free(mp);
+	mchars_free();
+	return (int)MANDOCLEVEL_OK;
+}
+
+static void
+usage(void)
+{
+
+	fprintf(stderr, "usage: %s [-w] [files...]\n", progname);
+}
+
+static void
+pmandoc(struct mparse *mp, int fd, const char *fn, int list)
+{
+	struct roff_meta	*meta;
+	int		 line, col;
+
+	mparse_readfd(mp, fd, fn);
+	close(fd);
+	meta = mparse_result(mp);
+	line = 1;
+	col = 0;
+
+	if (meta->macroset == MACROSET_MDOC)
+		pmdoc(meta->first->child, &line, &col, list);
+	else
+		pman(meta->first->child, &line, &col, list);
+
+	if ( ! list)
+		putchar('\n');
+}
+
+/*
+ * Strip the escapes out of a string, emitting the results.
+ */
+static void
+pstring(const char *p, int col, int *colp, int list)
+{
+	enum mandoc_esc	 esc;
+	const char	*start, *end;
+	int		 emit;
+
+	/*
+	 * Print as many column spaces til we achieve parity with the
+	 * input document.
+	 */
+
+again:
+	if (list && '\0' != *p) {
+		while (isspace((unsigned char)*p))
+			p++;
+
+		while ('\'' == *p || '(' == *p || '"' == *p)
+			p++;
+
+		emit = isalpha((unsigned char)p[0]) &&
+			isalpha((unsigned char)p[1]);
+
+		for (start = p; '\0' != *p; p++)
+			if ('\\' == *p) {
+				p++;
+				esc = mandoc_escape(&p, NULL, NULL);
+				if (ESCAPE_ERROR == esc)
+					return;
+				emit = 0;
+			} else if (isspace((unsigned char)*p))
+				break;
+
+		end = p - 1;
+
+		while (end > start)
+			if ('.' == *end || ',' == *end ||
+					'\'' == *end || '"' == *end ||
+					')' == *end || '!' == *end ||
+					'?' == *end || ':' == *end ||
+					';' == *end)
+				end--;
+			else
+				break;
+
+		if (emit && end - start >= 1) {
+			for ( ; start <= end; start++)
+				if (ASCII_HYPH == *start)
+					putchar('-');
+				else
+					putchar((unsigned char)*start);
+			putchar('\n');
+		}
+
+		if (isspace((unsigned char)*p))
+			goto again;
+
+		return;
+	}
+
+	while (*colp < col) {
+		putchar(' ');
+		(*colp)++;
+	}
+
+	/*
+	 * Print the input word, skipping any special characters.
+	 */
+	while ('\0' != *p)
+		if ('\\' == *p) {
+			p++;
+			esc = mandoc_escape(&p, NULL, NULL);
+			if (ESCAPE_ERROR == esc)
+				break;
+		} else {
+			putchar((unsigned char )*p++);
+			(*colp)++;
+		}
+}
+
+static void
+pline(int line, int *linep, int *col, int list)
+{
+
+	if (list)
+		return;
+
+	/*
+	 * Print out as many lines as needed to reach parity with the
+	 * original input.
+	 */
+
+	while (*linep < line) {
+		putchar('\n');
+		(*linep)++;
+	}
+
+	*col = 0;
+}
+
+static void
+pmdoc(const struct roff_node *p, int *line, int *col, int list)
+{
+
+	for ( ; p; p = p->next) {
+		if (NODE_LINE & p->flags)
+			pline(p->line, line, col, list);
+		if (ROFFT_TEXT == p->type)
+			pstring(p->string, p->pos, col, list);
+		if (p->child)
+			pmdoc(p->child, line, col, list);
+	}
+}
+
+static void
+pman(const struct roff_node *p, int *line, int *col, int list)
+{
+
+	for ( ; p; p = p->next) {
+		if (NODE_LINE & p->flags)
+			pline(p->line, line, col, list);
+		if (ROFFT_TEXT == p->type)
+			pstring(p->string, p->pos, col, list);
+		if (p->child)
+			pman(p->child, line, col, list);
+	}
+}