-/* $Id: mandocdb.c,v 1.37 2011/12/20 21:41:11 schwarze Exp $ */
+/* $Id: mandocdb.c,v 1.55 2012/06/09 14:11:16 kristaps Exp $ */
/*
- * Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2011 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2011, 2012 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
#endif
#include <sys/param.h>
-#include <sys/types.h>
+#include <sys/stat.h>
#include <assert.h>
-#include <dirent.h>
+#include <ctype.h>
+#include <errno.h>
#include <fcntl.h>
+#include <fts.h>
#include <getopt.h>
-#include <stdio.h>
+#include <stddef.h>
#include <stdint.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
-#if defined(__linux__)
-# include <endian.h>
-# include <db_185.h>
-#elif defined(__APPLE__)
-# include <libkern/OSByteOrder.h>
-# include <db.h>
+#ifdef HAVE_OHASH
+#include <ohash.h>
#else
-# include <db.h>
+#include "compat_ohash.h"
#endif
+#include <sqlite3.h>
-#include "man.h"
#include "mdoc.h"
+#include "man.h"
#include "mandoc.h"
-#include "mandocdb.h"
#include "manpath.h"
+#include "mansearch.h"
+
+/* Post a warning to stderr. */
+#define WARNING(_f, _b, _fmt, _args...) \
+ do if (warnings) { \
+ fprintf(stderr, "%s: ", (_b)); \
+ fprintf(stderr, (_fmt), ##_args); \
+ if ('\0' != *(_f)) \
+ fprintf(stderr, ": %s", (_f)); \
+ fprintf(stderr, "\n"); \
+ } while (/* CONSTCOND */ 0)
+/* Post a "verbose" message to stderr. */
+#define DEBUG(_f, _b, _fmt, _args...) \
+ do if (verb) { \
+ fprintf(stderr, "%s: ", (_b)); \
+ fprintf(stderr, (_fmt), ##_args); \
+ fprintf(stderr, ": %s\n", (_f)); \
+ } while (/* CONSTCOND */ 0)
+
+#define SQL_EXEC(_v) \
+ if (SQLITE_OK != sqlite3_exec(db, (_v), NULL, NULL, NULL)) \
+ fprintf(stderr, "%s\n", sqlite3_errmsg(db))
+#define SQL_BIND_TEXT(_s, _i, _v) \
+ if (SQLITE_OK != sqlite3_bind_text \
+ ((_s), (_i)++, (_v), -1, SQLITE_STATIC)) \
+ fprintf(stderr, "%s\n", sqlite3_errmsg(db))
+#define SQL_BIND_INT(_s, _i, _v) \
+ if (SQLITE_OK != sqlite3_bind_int \
+ ((_s), (_i)++, (_v))) \
+ fprintf(stderr, "%s\n", sqlite3_errmsg(db))
+#define SQL_BIND_INT64(_s, _i, _v) \
+ if (SQLITE_OK != sqlite3_bind_int64 \
+ ((_s), (_i)++, (_v))) \
+ fprintf(stderr, "%s\n", sqlite3_errmsg(db))
+#define SQL_STEP(_s) \
+ if (SQLITE_DONE != sqlite3_step((_s))) \
+ fprintf(stderr, "%s\n", sqlite3_errmsg(db))
-#define MANDOC_BUFSZ BUFSIZ
-#define MANDOC_SLOP 1024
-
-#define MANDOC_SRC 0x1
-#define MANDOC_FORM 0x2
-
-/* Tiny list for files. No need to bring in QUEUE. */
+enum op {
+ OP_DEFAULT = 0, /* new dbs from dir list or default config */
+ OP_CONFFILE, /* new databases from custom config file */
+ OP_UPDATE, /* delete/add entries in existing database */
+ OP_DELETE, /* delete entries from existing database */
+ OP_TEST /* change no databases, report potential problems */
+};
-struct of {
- char *fname; /* heap-allocated */
- char *sec;
- char *arch;
- char *title;
- int src_form;
- struct of *next; /* NULL for last one */
- struct of *first; /* first in list */
+enum form {
+ FORM_SRC, /* format is -man or -mdoc */
+ FORM_CAT, /* format is cat */
+ FORM_NONE /* format is unknown */
};
-/* Buffer for storing growable data. */
+struct str {
+ char *utf8; /* key in UTF-8 form */
+ const struct of *of; /* if set, the owning parse */
+ struct str *next; /* next in owning parse sequence */
+ uint64_t mask; /* bitmask in sequence */
+ char key[]; /* the string itself */
+};
-struct buf {
- char *cp;
- size_t len; /* current length */
- size_t size; /* total buffer size */
+struct id {
+ ino_t ino;
+ dev_t dev;
};
-/* Operation we're going to perform. */
+struct of {
+ struct id id; /* used for hashing routine */
+ struct of *next; /* next in ofs */
+ enum form dform; /* path-cued form */
+ enum form sform; /* suffix-cued form */
+ char file[MAXPATHLEN]; /* filename rel. to manpath */
+ const char *desc; /* parsed description */
+ const char *sec; /* suffix-cued section (or empty) */
+ const char *dsec; /* path-cued section (or empty) */
+ const char *arch; /* path-cued arch. (or empty) */
+ const char *name; /* name (from filename) (not empty) */
+};
-enum op {
- OP_NEW = 0, /* new database */
- OP_UPDATE, /* delete/add entries in existing database */
- OP_DELETE /* delete entries from existing database */
+enum stmt {
+ STMT_DELETE = 0, /* delete manpage */
+ STMT_INSERT_DOC, /* insert manpage */
+ STMT_INSERT_KEY, /* insert parsed key */
+ STMT__MAX
};
-#define MAN_ARGS DB *hash, \
- struct buf *buf, \
- struct buf *dbuf, \
- const struct man_node *n
-#define MDOC_ARGS DB *hash, \
- struct buf *buf, \
- struct buf *dbuf, \
- const struct mdoc_node *n, \
- const struct mdoc_meta *m
-
-static void buf_appendmdoc(struct buf *,
- const struct mdoc_node *, int);
-static void buf_append(struct buf *, const char *);
-static void buf_appendb(struct buf *,
- const void *, size_t);
-static void dbt_put(DB *, const char *, DBT *, DBT *);
-static void hash_put(DB *, const struct buf *, uint64_t);
-static void hash_reset(DB **);
-static void index_merge(const struct of *, struct mparse *,
- struct buf *, struct buf *, DB *,
- DB *, const char *, DB *, const char *,
- recno_t, const recno_t *, size_t);
-static void index_prune(const struct of *, DB *,
- const char *, DB *, const char *,
- recno_t *, recno_t **, size_t *,
- size_t *);
-static void ofile_argbuild(int, char *[], struct of **);
-static void ofile_dirbuild(const char *, const char *,
- const char *, int, struct of **);
-static void ofile_free(struct of *);
-static void pformatted(DB *, struct buf *, struct buf *,
- const struct of *);
-static int pman_node(MAN_ARGS);
-static void pmdoc_node(MDOC_ARGS);
-static int pmdoc_head(MDOC_ARGS);
-static int pmdoc_body(MDOC_ARGS);
-static int pmdoc_Fd(MDOC_ARGS);
-static int pmdoc_In(MDOC_ARGS);
-static int pmdoc_Fn(MDOC_ARGS);
-static int pmdoc_Nd(MDOC_ARGS);
-static int pmdoc_Nm(MDOC_ARGS);
-static int pmdoc_Sh(MDOC_ARGS);
-static int pmdoc_St(MDOC_ARGS);
-static int pmdoc_Xr(MDOC_ARGS);
-static void usage(void);
-
-#define MDOCF_CHILD 0x01 /* Automatically index child nodes. */
+typedef int (*mdoc_fp)(struct of *, const struct mdoc_node *);
struct mdoc_handler {
- int (*fp)(MDOC_ARGS); /* Optional handler. */
- uint64_t mask; /* Set unless handler returns 0. */
- int flags; /* For use by pmdoc_node. */
+ mdoc_fp fp; /* optional handler */
+ uint64_t mask; /* set unless handler returns 0 */
+ int flags; /* for use by pmdoc_node */
+#define MDOCF_CHILD 0x01 /* automatically index child nodes */
};
+static void dbclose(const char *, int);
+static void dbindex(struct mchars *, int,
+ const struct of *, const char *);
+static int dbopen(const char *, int);
+static void dbprune(const char *);
+static void fileadd(struct of *);
+static int filecheck(const char *);
+static void filescan(const char *, const char *);
+static struct str *hashget(const char *, size_t);
+static void *hash_alloc(size_t, void *);
+static void hash_free(void *, size_t, void *);
+static void *hash_halloc(size_t, void *);
+static void inoadd(const struct stat *, struct of *);
+static int inocheck(const struct stat *);
+static void ofadd(const char *, int, const char *,
+ const char *, const char *, const char *,
+ const char *, const struct stat *);
+static void offree(void);
+static int ofmerge(struct mchars *, struct mparse *, const char *);
+static void parse_catpage(struct of *, const char *);
+static int parse_man(struct of *,
+ const struct man_node *);
+static void parse_mdoc(struct of *, const struct mdoc_node *);
+static int parse_mdoc_body(struct of *, const struct mdoc_node *);
+static int parse_mdoc_head(struct of *, const struct mdoc_node *);
+static int parse_mdoc_Fd(struct of *, const struct mdoc_node *);
+static int parse_mdoc_Fn(struct of *, const struct mdoc_node *);
+static int parse_mdoc_In(struct of *, const struct mdoc_node *);
+static int parse_mdoc_Nd(struct of *, const struct mdoc_node *);
+static int parse_mdoc_Nm(struct of *, const struct mdoc_node *);
+static int parse_mdoc_Sh(struct of *, const struct mdoc_node *);
+static int parse_mdoc_St(struct of *, const struct mdoc_node *);
+static int parse_mdoc_Xr(struct of *, const struct mdoc_node *);
+static int path_reset(const char *, int, const char *);
+static void putkey(const struct of *,
+ const char *, uint64_t);
+static void putkeys(const struct of *,
+ const char *, int, uint64_t);
+static void putmdockey(const struct of *,
+ const struct mdoc_node *, uint64_t);
+static char *stradd(const char *);
+static char *straddbuf(const char *, size_t);
+static int treescan(const char *);
+static size_t utf8(unsigned int, char [7]);
+static void utf8key(struct mchars *, struct str *);
+static void wordaddbuf(const struct of *,
+ const char *, size_t, uint64_t);
+
+static char *progname;
+static int use_all; /* use all found files */
+static int nodb; /* no database changes */
+static int verb; /* print what we're doing */
+static int warnings; /* warn about crap */
+static enum op op; /* operational mode */
+static struct ohash inos; /* table of inodes/devices */
+static struct ohash filenames; /* table of filenames */
+static struct ohash strings; /* table of all strings */
+static struct of *ofs = NULL; /* vector of files to parse */
+static struct str *words = NULL; /* word list in current parse */
+static sqlite3 *db = NULL; /* current database */
+static sqlite3_stmt *stmts[STMT__MAX]; /* current statements */
+
static const struct mdoc_handler mdocs[MDOC_MAX] = {
{ NULL, 0, 0 }, /* Ap */
{ NULL, 0, 0 }, /* Dd */
{ NULL, 0, 0 }, /* Dt */
{ NULL, 0, 0 }, /* Os */
- { pmdoc_Sh, TYPE_Sh, MDOCF_CHILD }, /* Sh */
- { pmdoc_head, TYPE_Ss, MDOCF_CHILD }, /* Ss */
+ { parse_mdoc_Sh, TYPE_Sh, MDOCF_CHILD }, /* Sh */
+ { parse_mdoc_head, TYPE_Ss, MDOCF_CHILD }, /* Ss */
{ NULL, 0, 0 }, /* Pp */
{ NULL, 0, 0 }, /* D1 */
{ NULL, 0, 0 }, /* Dl */
{ NULL, TYPE_Ev, MDOCF_CHILD }, /* Ev */
{ NULL, 0, 0 }, /* Ex */
{ NULL, TYPE_Fa, MDOCF_CHILD }, /* Fa */
- { pmdoc_Fd, TYPE_In, 0 }, /* Fd */
+ { parse_mdoc_Fd, TYPE_In, 0 }, /* Fd */
{ NULL, TYPE_Fl, MDOCF_CHILD }, /* Fl */
- { pmdoc_Fn, 0, 0 }, /* Fn */
+ { parse_mdoc_Fn, 0, 0 }, /* Fn */
{ NULL, TYPE_Ft, MDOCF_CHILD }, /* Ft */
{ NULL, TYPE_Ic, MDOCF_CHILD }, /* Ic */
- { pmdoc_In, TYPE_In, 0 }, /* In */
+ { parse_mdoc_In, TYPE_In, MDOCF_CHILD }, /* In */
{ NULL, TYPE_Li, MDOCF_CHILD }, /* Li */
- { pmdoc_Nd, TYPE_Nd, MDOCF_CHILD }, /* Nd */
- { pmdoc_Nm, TYPE_Nm, MDOCF_CHILD }, /* Nm */
+ { parse_mdoc_Nd, TYPE_Nd, MDOCF_CHILD }, /* Nd */
+ { parse_mdoc_Nm, TYPE_Nm, MDOCF_CHILD }, /* Nm */
{ NULL, 0, 0 }, /* Op */
{ NULL, 0, 0 }, /* Ot */
{ NULL, TYPE_Pa, MDOCF_CHILD }, /* Pa */
{ NULL, 0, 0 }, /* Rv */
- { pmdoc_St, TYPE_St, 0 }, /* St */
+ { parse_mdoc_St, TYPE_St, 0 }, /* St */
{ NULL, TYPE_Va, MDOCF_CHILD }, /* Va */
- { pmdoc_body, TYPE_Va, MDOCF_CHILD }, /* Vt */
- { pmdoc_Xr, TYPE_Xr, 0 }, /* Xr */
+ { parse_mdoc_body, TYPE_Va, MDOCF_CHILD }, /* Vt */
+ { parse_mdoc_Xr, TYPE_Xr, 0 }, /* Xr */
{ NULL, 0, 0 }, /* %A */
{ NULL, 0, 0 }, /* %B */
{ NULL, 0, 0 }, /* %D */
{ NULL, 0, 0 }, /* Ux */
{ NULL, 0, 0 }, /* Xc */
{ NULL, 0, 0 }, /* Xo */
- { pmdoc_head, TYPE_Fn, 0 }, /* Fo */
+ { parse_mdoc_head, TYPE_Fn, 0 }, /* Fo */
{ NULL, 0, 0 }, /* Fc */
{ NULL, 0, 0 }, /* Oo */
{ NULL, 0, 0 }, /* Oc */
{ NULL, 0, 0 }, /* Ta */
};
-static const char *progname;
-static int use_all; /* Use all directories and files. */
-static int verb; /* Output verbosity level. */
-
int
main(int argc, char *argv[])
{
- struct mparse *mp; /* parse sequence */
- struct manpaths dirs;
- enum op op; /* current operation */
- const char *dir;
- char *conf_file;
- char *cp;
- char pbuf[PATH_MAX],
- ibuf[MAXPATHLEN], /* index fname */
- fbuf[MAXPATHLEN]; /* btree fname */
- int ch, i, flags;
- DB *idx, /* index database */
- *db, /* keyword database */
- *hash; /* temporary keyword hashtable */
- BTREEINFO info; /* btree configuration */
- recno_t maxrec; /* last record number in the index */
- recno_t *recs; /* the numbers of all empty records */
- size_t sz1, sz2,
- recsz, /* number of allocated slots in recs */
- reccur; /* current number of empty records */
- struct buf buf, /* keyword buffer */
- dbuf; /* description buffer */
- struct of *of; /* list of files for processing */
- extern int optind;
- extern char *optarg;
+ char cwd[MAXPATHLEN];
+ int ch, rc, fd, i;
+ unsigned int index;
+ size_t j, sz;
+ const char *dir;
+ struct str *s;
+ struct mchars *mc;
+ struct manpaths dirs;
+ struct mparse *mp;
+ struct ohash_info ino_info, filename_info, str_info;
+
+ memset(stmts, 0, STMT__MAX * sizeof(sqlite3_stmt *));
+ memset(&dirs, 0, sizeof(struct manpaths));
+
+ ino_info.halloc = filename_info.halloc =
+ str_info.halloc = hash_halloc;
+ ino_info.hfree = filename_info.hfree =
+ str_info.hfree = hash_free;
+ ino_info.alloc = filename_info.alloc =
+ str_info.alloc = hash_alloc;
+
+ ino_info.key_offset = offsetof(struct of, id);
+ filename_info.key_offset = offsetof(struct of, file);
+ str_info.key_offset = offsetof(struct str, key);
progname = strrchr(argv[0], '/');
if (progname == NULL)
else
++progname;
- memset(&dirs, 0, sizeof(struct manpaths));
+ /*
+ * Remember where we started by keeping a fd open to the origin
+ * path component: throughout this utility, we chdir() a lot to
+ * handle relative paths, and by doing this, we can return to
+ * the starting point.
+ */
+ if (NULL == getcwd(cwd, MAXPATHLEN)) {
+ perror(NULL);
+ return(EXIT_FAILURE);
+ } else if (-1 == (fd = open(cwd, O_RDONLY, 0))) {
+ perror(cwd);
+ return(EXIT_FAILURE);
+ }
+
+ /*
+ * We accept a few different invocations.
+ * The CHECKOP macro makes sure that invocation styles don't
+ * clobber each other.
+ */
+#define CHECKOP(_op, _ch) do \
+ if (OP_DEFAULT != (_op)) { \
+ fprintf(stderr, "-%c: Conflicting option\n", (_ch)); \
+ goto usage; \
+ } while (/*CONSTCOND*/0)
- verb = 0;
- use_all = 0;
- of = NULL;
- db = idx = NULL;
- mp = NULL;
- hash = NULL;
- recs = NULL;
- recsz = reccur = 0;
- maxrec = 0;
- op = OP_NEW;
dir = NULL;
- conf_file = NULL;
+ op = OP_DEFAULT;
- while (-1 != (ch = getopt(argc, argv, "aC:d:u:v")))
+ while (-1 != (ch = getopt(argc, argv, "aC:d:ntu:vW")))
switch (ch) {
case ('a'):
use_all = 1;
break;
case ('C'):
- conf_file = optarg;
+ CHECKOP(op, ch);
+ dir = optarg;
+ op = OP_CONFFILE;
break;
case ('d'):
+ CHECKOP(op, ch);
dir = optarg;
op = OP_UPDATE;
break;
+ case ('n'):
+ nodb = 1;
+ break;
+ case ('t'):
+ CHECKOP(op, ch);
+ dup2(STDOUT_FILENO, STDERR_FILENO);
+ op = OP_TEST;
+ nodb = warnings = 1;
+ break;
case ('u'):
+ CHECKOP(op, ch);
dir = optarg;
op = OP_DELETE;
break;
case ('v'):
verb++;
break;
+ case ('W'):
+ warnings = 1;
+ break;
default:
- usage();
- return((int)MANDOCLEVEL_BADARG);
+ goto usage;
}
argc -= optind;
argv += optind;
- memset(&info, 0, sizeof(BTREEINFO));
- info.flags = R_DUP;
-
- mp = mparse_alloc(MPARSE_AUTO, MANDOCLEVEL_FATAL, NULL, NULL);
-
- memset(&buf, 0, sizeof(struct buf));
- memset(&dbuf, 0, sizeof(struct buf));
-
- buf.size = dbuf.size = MANDOC_BUFSZ;
-
- buf.cp = mandoc_malloc(buf.size);
- dbuf.cp = mandoc_malloc(dbuf.size);
-
- flags = OP_NEW == op ? O_CREAT|O_TRUNC|O_RDWR : O_CREAT|O_RDWR;
-
- if (OP_UPDATE == op || OP_DELETE == op) {
- ibuf[0] = fbuf[0] = '\0';
-
- strlcat(fbuf, dir, MAXPATHLEN);
- strlcat(fbuf, "/", MAXPATHLEN);
- sz1 = strlcat(fbuf, MANDOC_DB, MAXPATHLEN);
-
- strlcat(ibuf, dir, MAXPATHLEN);
- strlcat(ibuf, "/", MAXPATHLEN);
- sz2 = strlcat(ibuf, MANDOC_IDX, MAXPATHLEN);
-
- if (sz1 >= MAXPATHLEN || sz2 >= MAXPATHLEN) {
- fprintf(stderr, "%s: Path too long\n", dir);
- exit((int)MANDOCLEVEL_BADARG);
- }
-
- db = dbopen(fbuf, flags, 0644, DB_BTREE, &info);
- idx = dbopen(ibuf, flags, 0644, DB_RECNO, NULL);
+ if (OP_CONFFILE == op && argc > 0) {
+ fprintf(stderr, "-C: Too many arguments\n");
+ goto usage;
+ }
- if (NULL == db) {
- perror(fbuf);
- exit((int)MANDOCLEVEL_SYSERR);
- } else if (NULL == idx) {
- perror(ibuf);
- exit((int)MANDOCLEVEL_SYSERR);
- }
+ rc = 1;
+ mp = mparse_alloc(MPARSE_AUTO,
+ MANDOCLEVEL_FATAL, NULL, NULL, NULL);
+ mc = mchars_alloc();
- ofile_argbuild(argc, argv, &of);
+ ohash_init(&strings, 6, &str_info);
+ ohash_init(&inos, 6, &ino_info);
+ ohash_init(&filenames, 6, &filename_info);
- if (NULL == of)
+ if (OP_UPDATE == op || OP_DELETE == op || OP_TEST == op) {
+ /*
+ * Force processing all files.
+ */
+ use_all = 1;
+ if (NULL == dir)
+ dir = cwd;
+ /*
+ * All of these deal with a specific directory.
+ * Jump into that directory then collect files specified
+ * on the command-line.
+ */
+ if (0 == path_reset(cwd, fd, dir))
goto out;
-
- of = of->first;
-
- index_prune(of, db, fbuf, idx, ibuf,
- &maxrec, &recs, &recsz, &reccur);
-
+ for (i = 0; i < argc; i++)
+ filescan(argv[i], dir);
+ if (0 == dbopen(dir, 1))
+ goto out;
+ if (OP_TEST != op)
+ dbprune(dir);
+ if (OP_DELETE != op)
+ rc = ofmerge(mc, mp, dir);
+ dbclose(dir, 1);
+ } else {
/*
- * Go to the root of the respective manual tree.
- * This must work or no manuals may be found (they're
- * indexed relative to the root).
+ * If we have arguments, use them as our manpaths.
+ * If we don't, grok from manpath(1) or however else
+ * manpath_parse() wants to do it.
*/
-
- if (OP_UPDATE == op) {
- if (-1 == chdir(dir)) {
- perror(dir);
- exit((int)MANDOCLEVEL_SYSERR);
- }
- index_merge(of, mp, &dbuf, &buf, hash,
- db, fbuf, idx, ibuf,
- maxrec, recs, reccur);
- }
-
- goto out;
- }
-
- /*
- * Configure the directories we're going to scan.
- * If we have command-line arguments, use them.
- * If not, we use man(1)'s method (see mandocdb.8).
- */
-
- if (argc > 0) {
- dirs.paths = mandoc_calloc(argc, sizeof(char *));
- dirs.sz = argc;
- for (i = 0; i < argc; i++) {
- if (NULL == (cp = realpath(argv[i], pbuf))) {
- perror(argv[i]);
- goto out;
- }
- dirs.paths[i] = mandoc_strdup(cp);
- }
- } else
- manpath_parse(&dirs, conf_file, NULL, NULL);
-
- for (i = 0; i < dirs.sz; i++) {
- ibuf[0] = fbuf[0] = '\0';
-
- strlcat(fbuf, dirs.paths[i], MAXPATHLEN);
- strlcat(fbuf, "/", MAXPATHLEN);
- sz1 = strlcat(fbuf, MANDOC_DB, MAXPATHLEN);
-
- strlcat(ibuf, dirs.paths[i], MAXPATHLEN);
- strlcat(ibuf, "/", MAXPATHLEN);
- sz2 = strlcat(ibuf, MANDOC_IDX, MAXPATHLEN);
-
- if (sz1 >= MAXPATHLEN || sz2 >= MAXPATHLEN) {
- fprintf(stderr, "%s: Path too long\n",
- dirs.paths[i]);
- exit((int)MANDOCLEVEL_BADARG);
- }
-
- if (db)
- (*db->close)(db);
- if (idx)
- (*idx->close)(idx);
-
- db = dbopen(fbuf, flags, 0644, DB_BTREE, &info);
- idx = dbopen(ibuf, flags, 0644, DB_RECNO, NULL);
-
- if (NULL == db) {
- perror(fbuf);
- exit((int)MANDOCLEVEL_SYSERR);
- } else if (NULL == idx) {
- perror(ibuf);
- exit((int)MANDOCLEVEL_SYSERR);
- }
-
- ofile_free(of);
- of = NULL;
-
- if (-1 == chdir(dirs.paths[i])) {
- perror(dirs.paths[i]);
- exit((int)MANDOCLEVEL_SYSERR);
- }
-
- ofile_dirbuild(".", NULL, NULL, 0, &of);
-
- if (NULL == of)
- continue;
-
- of = of->first;
+ if (argc > 0) {
+ dirs.paths = mandoc_calloc
+ (argc, sizeof(char *));
+ dirs.sz = (size_t)argc;
+ for (i = 0; i < argc; i++)
+ dirs.paths[i] = mandoc_strdup(argv[i]);
+ } else
+ manpath_parse(&dirs, dir, NULL, NULL);
/*
- * Go to the root of the respective manual tree.
- * This must work or no manuals may be found (they're
- * indexed relative to the root).
+ * First scan the tree rooted at a base directory.
+ * Then whak its database (if one exists), parse, and
+ * build up the database.
+ * Ignore zero-length directories and strip trailing
+ * slashes.
*/
+ for (j = 0; j < dirs.sz; j++) {
+ sz = strlen(dirs.paths[j]);
+ if (sz && '/' == dirs.paths[j][sz - 1])
+ dirs.paths[j][--sz] = '\0';
+ if (0 == sz)
+ continue;
+ if (0 == path_reset(cwd, fd, dirs.paths[j]))
+ goto out;
+ if (0 == treescan(dirs.paths[j]))
+ goto out;
+ if (0 == path_reset(cwd, fd, dirs.paths[j]))
+ goto out;
+ if (0 == dbopen(dirs.paths[j], 0))
+ goto out;
- if (-1 == chdir(dirs.paths[i])) {
- perror(dirs.paths[i]);
- exit((int)MANDOCLEVEL_SYSERR);
- }
+ /*
+ * Since we're opening up a new database, we can
+ * turn off synchronous mode for much better
+ * performance.
+ */
+#ifndef __APPLE__
+ SQL_EXEC("PRAGMA synchronous = OFF");
+#endif
- index_merge(of, mp, &dbuf, &buf, hash, db, fbuf,
- idx, ibuf, maxrec, recs, reccur);
+ if (0 == ofmerge(mc, mp, dirs.paths[j]))
+ goto out;
+ dbclose(dirs.paths[j], 0);
+ offree();
+ ohash_delete(&inos);
+ ohash_init(&inos, 6, &ino_info);
+ ohash_delete(&filenames);
+ ohash_init(&filenames, 6, &filename_info);
+ }
}
-
out:
- if (db)
- (*db->close)(db);
- if (idx)
- (*idx->close)(idx);
- if (hash)
- (*hash->close)(hash);
- if (mp)
- mparse_free(mp);
-
+ close(fd);
manpath_free(&dirs);
- ofile_free(of);
- free(buf.cp);
- free(dbuf.cp);
- free(recs);
-
- return(MANDOCLEVEL_OK);
+ mchars_free(mc);
+ mparse_free(mp);
+ for (s = ohash_first(&strings, &index);
+ NULL != s; s = ohash_next(&strings, &index)) {
+ if (s->utf8 != s->key)
+ free(s->utf8);
+ free(s);
+ }
+ ohash_delete(&strings);
+ ohash_delete(&inos);
+ ohash_delete(&filenames);
+ offree();
+ return(rc ? EXIT_SUCCESS : EXIT_FAILURE);
+usage:
+ fprintf(stderr, "usage: %s [-anvW] [-C file]\n"
+ " %s [-anvW] dir ...\n"
+ " %s [-nvW] -d dir [file ...]\n"
+ " %s [-nvW] -u dir [file ...]\n"
+ " %s -t file ...\n",
+ progname, progname, progname,
+ progname, progname);
+
+ return(EXIT_FAILURE);
}
-void
-index_merge(const struct of *of, struct mparse *mp,
- struct buf *dbuf, struct buf *buf, DB *hash,
- DB *db, const char *dbf, DB *idx, const char *idxf,
- recno_t maxrec, const recno_t *recs, size_t reccur)
+/*
+ * Scan a directory tree rooted at "base" for manpages.
+ * We use fts(), scanning directory parts along the way for clues to our
+ * section and architecture.
+ *
+ * If use_all has been specified, grok all files.
+ * If not, sanitise paths to the following:
+ *
+ * [./]man*[/<arch>]/<name>.<section>
+ * or
+ * [./]cat<section>[/<arch>]/<name>.0
+ *
+ * TODO: accomodate for multi-language directories.
+ */
+static int
+treescan(const char *base)
{
- recno_t rec;
- int ch;
- DBT key, val;
- struct mdoc *mdoc;
- struct man *man;
- const char *fn, *msec, *mtitle, *arch;
- uint64_t mask;
- size_t sv;
- unsigned seq;
- struct db_val vbuf;
- char type;
-
- for (rec = 0; of; of = of->next) {
- fn = of->fname;
+ FTS *f;
+ FTSENT *ff;
+ int dform;
+ char *sec;
+ const char *dsec, *arch, *cp, *name, *path;
+ const char *argv[2];
- /*
- * Try interpreting the file as mdoc(7) or man(7)
- * source code, unless it is already known to be
- * formatted. Fall back to formatted mode.
- */
-
- mparse_reset(mp);
- mdoc = NULL;
- man = NULL;
+ argv[0] = ".";
+ argv[1] = (char *)NULL;
- if ((MANDOC_SRC & of->src_form ||
- ! (MANDOC_FORM & of->src_form)) &&
- MANDOCLEVEL_FATAL > mparse_readfd(mp, -1, fn))
- mparse_result(mp, &mdoc, &man);
+ /*
+ * Walk through all components under the directory, using the
+ * logical descent of files.
+ */
+ f = fts_open((char * const *)argv, FTS_LOGICAL, NULL);
+ if (NULL == f) {
+ perror(base);
+ return(0);
+ }
- if (NULL != mdoc) {
- msec = mdoc_meta(mdoc)->msec;
- arch = mdoc_meta(mdoc)->arch;
- mtitle = mdoc_meta(mdoc)->title;
- } else if (NULL != man) {
- msec = man_meta(man)->msec;
- arch = NULL;
- mtitle = man_meta(man)->title;
- } else {
- msec = of->sec;
- arch = of->arch;
- mtitle = of->title;
- }
+ dsec = arch = NULL;
+ dform = FORM_NONE;
+ while (NULL != (ff = fts_read(f))) {
+ path = ff->fts_path + 2;
/*
- * By default, skip a file if the manual section
- * and architecture given in the file disagree
- * with the directory where the file is located.
+ * If we're a regular file, add an "of" by using the
+ * stored directory data and handling the filename.
+ * Disallow duplicate (hard-linked) files.
*/
-
- if (0 == use_all) {
- assert(of->sec);
- assert(msec);
- if (strcasecmp(msec, of->sec))
+ if (FTS_F == ff->fts_info) {
+ if ( ! use_all && ff->fts_level < 2) {
+ WARNING(path, base, "Extraneous file");
continue;
-
- if (NULL == arch) {
- if (NULL != of->arch)
- continue;
- } else if (NULL == of->arch ||
- strcasecmp(arch, of->arch))
+ } else if (inocheck(ff->fts_statp)) {
+ WARNING(path, base, "Duplicate file");
continue;
- }
-
- if (NULL == arch)
- arch = "";
+ }
- /*
- * By default, skip a file if the title given
- * in the file disagrees with the file name.
- * If both agree, use the file name as the title,
- * because the one in the file usually is all caps.
- */
+ cp = ff->fts_name;
- assert(of->title);
- assert(mtitle);
+ if (0 == strcmp(cp, "mandocdb.db")) {
+ WARNING(path, base, "Skip database");
+ continue;
+ } else if (NULL != (cp = strrchr(cp, '.'))) {
+ if (0 == strcmp(cp + 1, "html")) {
+ WARNING(path, base, "Skip html");
+ continue;
+ } else if (0 == strcmp(cp + 1, "gz")) {
+ WARNING(path, base, "Skip gz");
+ continue;
+ } else if (0 == strcmp(cp + 1, "ps")) {
+ WARNING(path, base, "Skip ps");
+ continue;
+ } else if (0 == strcmp(cp + 1, "pdf")) {
+ WARNING(path, base, "Skip pdf");
+ continue;
+ }
+ }
- if (0 == strcasecmp(mtitle, of->title))
- mtitle = of->title;
- else if (0 == use_all)
+ if (NULL != (sec = strrchr(ff->fts_name, '.'))) {
+ *sec = '\0';
+ sec = stradd(sec + 1);
+ }
+ name = stradd(ff->fts_name);
+ ofadd(base, dform, path,
+ name, dsec, sec, arch, ff->fts_statp);
+ continue;
+ } else if (FTS_D != ff->fts_info &&
+ FTS_DP != ff->fts_info)
continue;
- /*
- * The index record value consists of a nil-terminated
- * filename, a nil-terminated manual section, and a
- * nil-terminated description. Since the description
- * may not be set, we set a sentinel to see if we're
- * going to write a nil byte in its place.
- */
-
- dbuf->len = 0;
- type = mdoc ? 'd' : (man ? 'a' : 'c');
- buf_appendb(dbuf, &type, 1);
- buf_appendb(dbuf, fn, strlen(fn) + 1);
- buf_appendb(dbuf, msec, strlen(msec) + 1);
- buf_appendb(dbuf, mtitle, strlen(mtitle) + 1);
- buf_appendb(dbuf, arch, strlen(arch) + 1);
-
- sv = dbuf->len;
-
- /*
- * Collect keyword/mask pairs.
- * Each pair will become a new btree node.
- */
-
- hash_reset(&hash);
- if (mdoc)
- pmdoc_node(hash, buf, dbuf,
- mdoc_node(mdoc), mdoc_meta(mdoc));
- else if (man)
- pman_node(hash, buf, dbuf, man_node(man));
- else
- pformatted(hash, buf, dbuf, of);
-
- /*
- * Reclaim an empty index record, if available.
- * Use its record number for all new btree nodes.
- */
+ switch (ff->fts_level) {
+ case (0):
+ /* Ignore the root directory. */
+ break;
+ case (1):
+ /*
+ * This might contain manX/ or catX/.
+ * Try to infer this from the name.
+ * If we're not in use_all, enforce it.
+ */
+ dsec = NULL;
+ dform = FORM_NONE;
+ cp = ff->fts_name;
+ if (FTS_DP == ff->fts_info)
+ break;
- if (reccur > 0) {
- --reccur;
- rec = recs[(int)reccur];
- } else if (maxrec > 0) {
- rec = maxrec;
- maxrec = 0;
- } else
- rec++;
- vbuf.rec = htobe32(rec);
+ if (0 == strncmp(cp, "man", 3)) {
+ dform = FORM_SRC;
+ dsec = stradd(cp + 3);
+ } else if (0 == strncmp(cp, "cat", 3)) {
+ dform = FORM_CAT;
+ dsec = stradd(cp + 3);
+ }
- /*
- * Copy from the in-memory hashtable of pending
- * keyword/mask pairs into the database.
- */
+ if (NULL != dsec || use_all)
+ break;
- seq = R_FIRST;
- while (0 == (ch = (*hash->seq)(hash, &key, &val, seq))) {
- seq = R_NEXT;
- assert(sizeof(uint64_t) == val.size);
- memcpy(&mask, val.data, val.size);
- vbuf.mask = htobe64(mask);
- val.size = sizeof(struct db_val);
- val.data = &vbuf;
- dbt_put(db, dbf, &key, &val);
- }
- if (ch < 0) {
- perror("hash");
- exit((int)MANDOCLEVEL_SYSERR);
+ WARNING(path, base, "Unknown directory part");
+ fts_set(f, ff, FTS_SKIP);
+ break;
+ case (2):
+ /*
+ * Possibly our architecture.
+ * If we're descending, keep tabs on it.
+ */
+ arch = NULL;
+ if (FTS_DP != ff->fts_info && NULL != dsec)
+ arch = stradd(ff->fts_name);
+ break;
+ default:
+ if (FTS_DP == ff->fts_info || use_all)
+ break;
+ WARNING(path, base, "Extraneous directory part");
+ fts_set(f, ff, FTS_SKIP);
+ break;
}
-
- /*
- * Apply to the index. If we haven't had a description
- * set, put an empty one in now.
- */
-
- if (dbuf->len == sv)
- buf_appendb(dbuf, "", 1);
-
- key.data = &rec;
- key.size = sizeof(recno_t);
-
- val.data = dbuf->cp;
- val.size = dbuf->len;
-
- if (verb)
- printf("%s: Added index\n", fn);
-
- dbt_put(idx, idxf, &key, &val);
}
+
+ fts_close(f);
+ return(1);
}
/*
- * Scan through all entries in the index file `idx' and prune those
- * entries in `ofile'.
- * Pruning consists of removing from `db', then invalidating the entry
- * in `idx' (zeroing its value size).
+ * Add a file to the file vector.
+ * Do not verify that it's a "valid" looking manpage (we'll do that
+ * later).
+ *
+ * Try to infer the manual section, architecture, and page name from the
+ * path, assuming it looks like
+ *
+ * [./]man*[/<arch>]/<name>.<section>
+ * or
+ * [./]cat<section>[/<arch>]/<name>.0
+ *
+ * Stuff this information directly into the "of" vector.
+ * See treescan() for the fts(3) version of this.
*/
static void
-index_prune(const struct of *ofile, DB *db, const char *dbf,
- DB *idx, const char *idxf, recno_t *maxrec,
- recno_t **recs, size_t *recsz, size_t *reccur)
+filescan(const char *file, const char *base)
{
- const struct of *of;
- const char *fn;
- struct db_val *vbuf;
- unsigned seq, sseq;
- DBT key, val;
- int ch;
-
- *reccur = 0;
- seq = R_FIRST;
- while (0 == (ch = (*idx->seq)(idx, &key, &val, seq))) {
- seq = R_NEXT;
- assert(sizeof(recno_t) == key.size);
- memcpy(maxrec, key.data, key.size);
-
- /* Deleted records are zero-sized. Skip them. */
-
- if (0 == val.size)
- goto cont;
-
- /*
- * Make sure we're sane.
- * Read past our mdoc/man/cat type to the next string,
- * then make sure it's bounded by a NUL.
- * Failing any of these, we go into our error handler.
- */
-
- fn = (char *)val.data + 1;
- if (NULL == memchr(fn, '\0', val.size - 1))
- break;
-
- /*
- * Search for the file in those we care about.
- * XXX: build this into a tree. Too slow.
- */
-
- for (of = ofile; of; of = of->next)
- if (0 == strcmp(fn, of->fname))
- break;
+ const char *sec, *arch, *name, *dsec;
+ char *p, *start, *buf;
+ int dform;
+ struct stat st;
- if (NULL == of)
- continue;
-
- /*
- * Search through the keyword database, throwing out all
- * references to our file.
- */
+ assert(use_all);
- sseq = R_FIRST;
- while (0 == (ch = (*db->seq)(db, &key, &val, sseq))) {
- sseq = R_NEXT;
- if (sizeof(struct db_val) != val.size)
- break;
+ if (0 == strncmp(file, "./", 2))
+ file += 2;
- vbuf = val.data;
- if (*maxrec != betoh32(vbuf->rec))
- continue;
+ if (-1 == stat(file, &st)) {
+ WARNING(file, base, "%s", strerror(errno));
+ return;
+ } else if ( ! (S_IFREG & st.st_mode)) {
+ WARNING(file, base, "Not a regular file");
+ return;
+ } else if (inocheck(&st)) {
+ WARNING(file, base, "Duplicate file");
+ return;
+ }
- if ((ch = (*db->del)(db, &key, R_CURSOR)) < 0)
- break;
- }
+ buf = mandoc_strdup(file);
+ start = buf;
+ sec = arch = name = dsec = NULL;
+ dform = FORM_NONE;
- if (ch < 0) {
- perror(dbf);
- exit((int)MANDOCLEVEL_SYSERR);
- } else if (1 != ch) {
- fprintf(stderr, "%s: Corrupt database\n", dbf);
- exit((int)MANDOCLEVEL_SYSERR);
+ /*
+ * First try to guess our directory structure.
+ * If we find a separator, try to look for man* or cat*.
+ * If we find one of these and what's underneath is a directory,
+ * assume it's an architecture.
+ */
+ if (NULL != (p = strchr(start, '/'))) {
+ *p++ = '\0';
+ if (0 == strncmp(start, "man", 3)) {
+ dform = FORM_SRC;
+ dsec = start + 3;
+ } else if (0 == strncmp(start, "cat", 3)) {
+ dform = FORM_CAT;
+ dsec = start + 3;
}
- if (verb)
- printf("%s: Deleted index\n", fn);
-
- val.size = 0;
- ch = (*idx->put)(idx, &key, &val, R_CURSOR);
+ start = p;
+ if (NULL != dsec && NULL != (p = strchr(start, '/'))) {
+ *p++ = '\0';
+ arch = start;
+ start = p;
+ }
+ }
- if (ch < 0)
- break;
-cont:
- if (*reccur >= *recsz) {
- *recsz += MANDOC_SLOP;
- *recs = mandoc_realloc
- (*recs, *recsz * sizeof(recno_t));
- }
+ /*
+ * Now check the file suffix.
+ * Suffix of `.0' indicates a catpage, `.1-9' is a manpage.
+ */
+ p = strrchr(start, '\0');
+ while (p-- > start && '/' != *p && '.' != *p)
+ /* Loop. */ ;
- (*recs)[(int)*reccur] = *maxrec;
- (*reccur)++;
+ if ('.' == *p) {
+ *p++ = '\0';
+ sec = p;
}
- if (ch < 0) {
- perror(idxf);
- exit((int)MANDOCLEVEL_SYSERR);
- } else if (1 != ch) {
- fprintf(stderr, "%s: Corrupt index\n", idxf);
- exit((int)MANDOCLEVEL_SYSERR);
- }
+ /*
+ * Now try to parse the name.
+ * Use the filename portion of the path.
+ */
+ name = start;
+ if (NULL != (p = strrchr(start, '/'))) {
+ name = p + 1;
+ *p = '\0';
+ }
- (*maxrec)++;
+ ofadd(base, dform, file, name, dsec, sec, arch, &st);
+ free(buf);
}
/*
- * Grow the buffer (if necessary) and copy in a binary string.
+ * See fileadd().
*/
-static void
-buf_appendb(struct buf *buf, const void *cp, size_t sz)
+static int
+filecheck(const char *name)
{
+ unsigned int index;
- /* Overshoot by MANDOC_BUFSZ. */
-
- while (buf->len + sz >= buf->size) {
- buf->size = buf->len + sz + MANDOC_BUFSZ;
- buf->cp = mandoc_realloc(buf->cp, buf->size);
- }
-
- memcpy(buf->cp + (int)buf->len, cp, sz);
- buf->len += sz;
+ index = ohash_qlookup(&filenames, name);
+ return(NULL != ohash_find(&filenames, index));
}
/*
- * Append a nil-terminated string to the buffer.
- * This can be invoked multiple times.
- * The buffer string will be nil-terminated.
- * If invoked multiple times, a space is put between strings.
+ * Use the standard hashing mechanism (K&R) to see if the given filename
+ * already exists.
*/
static void
-buf_append(struct buf *buf, const char *cp)
+fileadd(struct of *of)
{
- size_t sz;
-
- if (0 == (sz = strlen(cp)))
- return;
-
- if (buf->len)
- buf->cp[(int)buf->len - 1] = ' ';
+ unsigned int index;
- buf_appendb(buf, cp, sz + 1);
+ index = ohash_qlookup(&filenames, of->file);
+ assert(NULL == ohash_find(&filenames, index));
+ ohash_insert(&filenames, index, of);
}
/*
- * Recursively add all text from a given node.
- * This is optimised for general mdoc nodes in this context, which do
- * not consist of subexpressions and having a recursive call for n->next
- * would be wasteful.
- * The "f" variable should be 0 unless called from pmdoc_Nd for the
- * description buffer, which does not start at the beginning of the
- * buffer.
+ * See inoadd().
*/
-static void
-buf_appendmdoc(struct buf *buf, const struct mdoc_node *n, int f)
+static int
+inocheck(const struct stat *st)
{
+ struct id id;
+ uint32_t hash;
+ unsigned int index;
- for ( ; n; n = n->next) {
- if (n->child)
- buf_appendmdoc(buf, n->child, f);
+ memset(&id, 0, sizeof(id));
+ id.ino = hash = st->st_ino;
+ id.dev = st->st_dev;
+ index = ohash_lookup_memory
+ (&inos, (char *)&id, sizeof(id), hash);
- if (MDOC_TEXT == n->type && f) {
- f = 0;
- buf_appendb(buf, n->string,
- strlen(n->string) + 1);
- } else if (MDOC_TEXT == n->type)
- buf_append(buf, n->string);
-
- }
+ return(NULL != ohash_find(&inos, index));
}
+/*
+ * The hashing function used here is quite simple: simply take the inode
+ * and use uint32_t of its bits.
+ * Then when we do the lookup, use both the inode and device identifier.
+ */
static void
-hash_reset(DB **db)
+inoadd(const struct stat *st, struct of *of)
{
- DB *hash;
+ uint32_t hash;
+ unsigned int index;
- if (NULL != (hash = *db))
- (*hash->close)(hash);
+ of->id.ino = hash = st->st_ino;
+ of->id.dev = st->st_dev;
+ index = ohash_lookup_memory
+ (&inos, (char *)&of->id, sizeof(of->id), hash);
- *db = dbopen(NULL, O_CREAT|O_RDWR, 0644, DB_HASH, NULL);
- if (NULL == *db) {
- perror("hash");
- exit((int)MANDOCLEVEL_SYSERR);
- }
+ assert(NULL == ohash_find(&inos, index));
+ ohash_insert(&inos, index, of);
}
-/* ARGSUSED */
-static int
-pmdoc_head(MDOC_ARGS)
+static void
+ofadd(const char *base, int dform, const char *file,
+ const char *name, const char *dsec, const char *sec,
+ const char *arch, const struct stat *st)
{
+ struct of *of;
+ int sform;
+
+ assert(NULL != file);
+
+ if (NULL == name)
+ name = "";
+ if (NULL == sec)
+ sec = "";
+ if (NULL == dsec)
+ dsec = "";
+ if (NULL == arch)
+ arch = "";
+
+ sform = FORM_NONE;
+ if (NULL != sec && *sec <= '9' && *sec >= '1')
+ sform = FORM_SRC;
+ else if (NULL != sec && *sec == '0') {
+ sec = dsec;
+ sform = FORM_CAT;
+ }
- return(MDOC_HEAD == n->type);
+ of = mandoc_calloc(1, sizeof(struct of));
+ strlcpy(of->file, file, MAXPATHLEN);
+ of->name = name;
+ of->sec = sec;
+ of->dsec = dsec;
+ of->arch = arch;
+ of->sform = sform;
+ of->dform = dform;
+ of->next = ofs;
+ ofs = of;
+
+ /*
+ * Add to unique identifier hash.
+ * Then if it's a source manual and we're going to use source in
+ * favour of catpages, add it to that hash.
+ */
+ inoadd(st, of);
+ fileadd(of);
}
-/* ARGSUSED */
-static int
-pmdoc_body(MDOC_ARGS)
+static void
+offree(void)
{
+ struct of *of;
- return(MDOC_BODY == n->type);
+ while (NULL != (of = ofs)) {
+ ofs = of->next;
+ free(of);
+ }
}
-/* ARGSUSED */
+/*
+ * Run through the files in the global vector "ofs" and add them to the
+ * database specified in "base".
+ *
+ * This handles the parsing scheme itself, using the cues of directory
+ * and filename to determine whether the file is parsable or not.
+ */
static int
-pmdoc_Fd(MDOC_ARGS)
+ofmerge(struct mchars *mc, struct mparse *mp, const char *base)
{
- const char *start, *end;
+ int form;
size_t sz;
+ struct mdoc *mdoc;
+ struct man *man;
+ char buf[MAXPATHLEN];
+ char *bufp;
+ const char *msec, *march, *mtitle, *cp;
+ struct of *of;
+ enum mandoclevel lvl;
- if (SEC_SYNOPSIS != n->sec)
- return(0);
- if (NULL == (n = n->child) || MDOC_TEXT != n->type)
- return(0);
-
- /*
- * Only consider those `Fd' macro fields that begin with an
- * "inclusion" token (versus, e.g., #define).
- */
- if (strcmp("#include", n->string))
- return(0);
+ for (of = ofs; NULL != of; of = of->next) {
+ /*
+ * If we're a catpage (as defined by our path), then see
+ * if a manpage exists by the same name (ignoring the
+ * suffix).
+ * If it does, then we want to use it instead of our
+ * own.
+ */
+ if ( ! use_all && FORM_CAT == of->dform) {
+ sz = strlcpy(buf, of->file, MAXPATHLEN);
+ if (sz >= MAXPATHLEN) {
+ WARNING(of->file, base,
+ "Filename too long");
+ continue;
+ }
+ bufp = strstr(buf, "cat");
+ assert(NULL != bufp);
+ memcpy(bufp, "man", 3);
+ if (NULL != (bufp = strrchr(buf, '.')))
+ *++bufp = '\0';
+ strlcat(buf, of->dsec, MAXPATHLEN);
+ if (filecheck(buf)) {
+ WARNING(of->file, base, "Man "
+ "source exists: %s", buf);
+ continue;
+ }
+ }
- if (NULL == (n = n->next) || MDOC_TEXT != n->type)
- return(0);
+ words = NULL;
+ mparse_reset(mp);
+ mdoc = NULL;
+ man = NULL;
+ form = 0;
+ msec = of->dsec;
+ march = of->arch;
+ mtitle = of->name;
- /*
- * Strip away the enclosing angle brackets and make sure we're
- * not zero-length.
- */
+ /*
+ * Try interpreting the file as mdoc(7) or man(7)
+ * source code, unless it is already known to be
+ * formatted. Fall back to formatted mode.
+ */
+ if (FORM_SRC == of->dform || FORM_SRC == of->sform) {
+ lvl = mparse_readfd(mp, -1, of->file);
+ if (lvl < MANDOCLEVEL_FATAL)
+ mparse_result(mp, &mdoc, &man);
+ }
- start = n->string;
- if ('<' == *start || '"' == *start)
- start++;
+ if (NULL != mdoc) {
+ form = 1;
+ msec = mdoc_meta(mdoc)->msec;
+ march = mdoc_meta(mdoc)->arch;
+ mtitle = mdoc_meta(mdoc)->title;
+ } else if (NULL != man) {
+ form = 1;
+ msec = man_meta(man)->msec;
+ march = "";
+ mtitle = man_meta(man)->title;
+ }
- if (0 == (sz = strlen(start)))
- return(0);
+ if (NULL == msec)
+ msec = "";
+ if (NULL == march)
+ march = "";
+ if (NULL == mtitle)
+ mtitle = "";
- end = &start[(int)sz - 1];
- if ('>' == *end || '"' == *end)
- end--;
+ /*
+ * Check whether the manual section given in a file
+ * agrees with the directory where the file is located.
+ * Some manuals have suffixes like (3p) on their
+ * section number either inside the file or in the
+ * directory name, some are linked into more than one
+ * section, like encrypt(1) = makekey(8). Do not skip
+ * manuals for such reasons.
+ */
+ if ( ! use_all && form && strcasecmp(msec, of->dsec))
+ WARNING(of->file, base, "Section \"%s\" "
+ "manual in %s directory",
+ msec, of->dsec);
- assert(end >= start);
+ /*
+ * Manual page directories exist for each kernel
+ * architecture as returned by machine(1).
+ * However, many manuals only depend on the
+ * application architecture as returned by arch(1).
+ * For example, some (2/ARM) manuals are shared
+ * across the "armish" and "zaurus" kernel
+ * architectures.
+ * A few manuals are even shared across completely
+ * different architectures, for example fdformat(1)
+ * on amd64, i386, sparc, and sparc64.
+ * Thus, warn about architecture mismatches,
+ * but don't skip manuals for this reason.
+ */
+ if ( ! use_all && strcasecmp(march, of->arch))
+ WARNING(of->file, base, "Architecture \"%s\" "
+ "manual in \"%s\" directory",
+ march, of->arch);
- buf_appendb(buf, start, (size_t)(end - start + 1));
- buf_appendb(buf, "", 1);
- return(1);
-}
+ putkey(of, of->name, TYPE_Nm);
-/* ARGSUSED */
-static int
-pmdoc_In(MDOC_ARGS)
-{
+ if (NULL != mdoc) {
+ if (NULL != (cp = mdoc_meta(mdoc)->name))
+ putkey(of, cp, TYPE_Nm);
+ parse_mdoc(of, mdoc_node(mdoc));
+ } else if (NULL != man)
+ parse_man(of, man_node(man));
+ else
+ parse_catpage(of, base);
- if (NULL == n->child || MDOC_TEXT != n->child->type)
- return(0);
+ dbindex(mc, form, of, base);
+ }
- buf_append(buf, n->child->string);
return(1);
}
-/* ARGSUSED */
-static int
-pmdoc_Fn(MDOC_ARGS)
+static void
+parse_catpage(struct of *of, const char *base)
{
- struct mdoc_node *nn;
- const char *cp;
-
- nn = n->child;
-
- if (NULL == nn || MDOC_TEXT != nn->type)
- return(0);
-
- /* .Fn "struct type *name" "char *arg" */
-
- cp = strrchr(nn->string, ' ');
- if (NULL == cp)
- cp = nn->string;
-
- /* Strip away pointer symbol. */
+ FILE *stream;
+ char *line, *p, *title;
+ size_t len, plen, titlesz;
- while ('*' == *cp)
- cp++;
+ if (NULL == (stream = fopen(of->file, "r"))) {
+ WARNING(of->file, base, "%s", strerror(errno));
+ return;
+ }
- /* Store the function name. */
+ /* Skip to first blank line. */
- buf_append(buf, cp);
- hash_put(hash, buf, TYPE_Fn);
+ while (NULL != (line = fgetln(stream, &len)))
+ if ('\n' == *line)
+ break;
- /* Store the function type. */
+ /*
+ * Assume the first line that is not indented
+ * is the first section header. Skip to it.
+ */
- if (nn->string < cp) {
- buf->len = 0;
- buf_appendb(buf, nn->string, cp - nn->string);
- buf_appendb(buf, "", 1);
- hash_put(hash, buf, TYPE_Ft);
- }
+ while (NULL != (line = fgetln(stream, &len)))
+ if ('\n' != *line && ' ' != *line)
+ break;
+
+ /*
+ * Read up until the next section into a buffer.
+ * Strip the leading and trailing newline from each read line,
+ * appending a trailing space.
+ * Ignore empty (whitespace-only) lines.
+ */
- /* Store the arguments. */
+ titlesz = 0;
+ title = NULL;
- for (nn = nn->next; nn; nn = nn->next) {
- if (MDOC_TEXT != nn->type)
+ while (NULL != (line = fgetln(stream, &len))) {
+ if (' ' != *line || '\n' != line[len - 1])
+ break;
+ while (len > 0 && isspace((unsigned char)*line)) {
+ line++;
+ len--;
+ }
+ if (1 == len)
continue;
- buf->len = 0;
- buf_append(buf, nn->string);
- hash_put(hash, buf, TYPE_Fa);
+ title = mandoc_realloc(title, titlesz + len);
+ memcpy(title + titlesz, line, len);
+ titlesz += len;
+ title[titlesz - 1] = ' ';
}
- return(0);
-}
-
-/* ARGSUSED */
-static int
-pmdoc_St(MDOC_ARGS)
-{
-
- if (NULL == n->child || MDOC_TEXT != n->child->type)
- return(0);
-
- buf_append(buf, n->child->string);
- return(1);
-}
-
-/* ARGSUSED */
-static int
-pmdoc_Xr(MDOC_ARGS)
-{
-
- if (NULL == (n = n->child))
- return(0);
-
- buf_appendb(buf, n->string, strlen(n->string));
-
- if (NULL != (n = n->next)) {
- buf_appendb(buf, ".", 1);
- buf_appendb(buf, n->string, strlen(n->string) + 1);
- } else
- buf_appendb(buf, ".", 2);
-
- return(1);
-}
-
-/* ARGSUSED */
-static int
-pmdoc_Nd(MDOC_ARGS)
-{
+ /*
+ * If no page content can be found, or the input line
+ * is already the next section header, or there is no
+ * trailing newline, reuse the page title as the page
+ * description.
+ */
- if (MDOC_BODY != n->type)
- return(0);
+ if (NULL == title || '\0' == *title) {
+ WARNING(of->file, base, "Cannot find NAME section");
+ fclose(stream);
+ free(title);
+ return;
+ }
- buf_appendmdoc(dbuf, n->child, 1);
- return(1);
-}
+ title = mandoc_realloc(title, titlesz + 1);
+ title[titlesz] = '\0';
-/* ARGSUSED */
-static int
-pmdoc_Nm(MDOC_ARGS)
-{
+ /*
+ * Skip to the first dash.
+ * Use the remaining line as the description (no more than 70
+ * bytes).
+ */
- if (SEC_NAME == n->sec)
- return(1);
- else if (SEC_SYNOPSIS != n->sec || MDOC_HEAD != n->type)
- return(0);
+ if (NULL != (p = strstr(title, "- "))) {
+ for (p += 2; ' ' == *p || '\b' == *p; p++)
+ /* Skip to next word. */ ;
+ } else {
+ WARNING(of->file, base, "No dash in title line");
+ p = title;
+ }
- if (NULL == n->child)
- buf_append(buf, m->name);
+ plen = strlen(p);
- return(1);
-}
+ /* Strip backspace-encoding from line. */
-/* ARGSUSED */
-static int
-pmdoc_Sh(MDOC_ARGS)
-{
+ while (NULL != (line = memchr(p, '\b', plen))) {
+ len = line - p;
+ if (0 == len) {
+ memmove(line, line + 1, plen--);
+ continue;
+ }
+ memmove(line - 1, line + 1, plen - len);
+ plen -= 2;
+ }
- return(SEC_CUSTOM == n->sec && MDOC_HEAD == n->type);
+ of->desc = stradd(p);
+ putkey(of, p, TYPE_Nd);
+ fclose(stream);
+ free(title);
}
+/*
+ * Put a type/word pair into the word database for this particular file.
+ */
static void
-hash_put(DB *db, const struct buf *buf, uint64_t mask)
+putkey(const struct of *of, const char *value, uint64_t type)
{
- uint64_t oldmask;
- DBT key, val;
- int rc;
-
- if (buf->len < 2)
- return;
-
- key.data = buf->cp;
- key.size = buf->len;
-
- if ((rc = (*db->get)(db, &key, &val, 0)) < 0) {
- perror("hash");
- exit((int)MANDOCLEVEL_SYSERR);
- } else if (0 == rc) {
- assert(sizeof(uint64_t) == val.size);
- memcpy(&oldmask, val.data, val.size);
- mask |= oldmask;
- }
- val.data = &mask;
- val.size = sizeof(uint64_t);
-
- if ((rc = (*db->put)(db, &key, &val, 0)) < 0) {
- perror("hash");
- exit((int)MANDOCLEVEL_SYSERR);
- }
+ assert(NULL != value);
+ wordaddbuf(of, value, strlen(value), type);
}
+/*
+ * Like putkey() but for unterminated strings.
+ */
static void
-dbt_put(DB *db, const char *dbn, DBT *key, DBT *val)
+putkeys(const struct of *of, const char *value, int sz, uint64_t type)
{
- assert(key->size);
- assert(val->size);
-
- if (0 == (*db->put)(db, key, val, 0))
- return;
-
- perror(dbn);
- exit((int)MANDOCLEVEL_SYSERR);
- /* NOTREACHED */
+ wordaddbuf(of, value, sz, type);
}
/*
- * Call out to per-macro handlers after clearing the persistent database
- * key. If the macro sets the database key, flush it to the database.
+ * Grok all nodes at or below a certain mdoc node into putkey().
*/
static void
-pmdoc_node(MDOC_ARGS)
+putmdockey(const struct of *of, const struct mdoc_node *n, uint64_t m)
{
- if (NULL == n)
- return;
-
- switch (n->type) {
- case (MDOC_HEAD):
- /* FALLTHROUGH */
- case (MDOC_BODY):
- /* FALLTHROUGH */
- case (MDOC_TAIL):
- /* FALLTHROUGH */
- case (MDOC_BLOCK):
- /* FALLTHROUGH */
- case (MDOC_ELEM):
- buf->len = 0;
-
- /*
- * Both NULL handlers and handlers returning true
- * request using the data. Only skip the element
- * when the handler returns false.
- */
-
- if (NULL != mdocs[n->tok].fp &&
- 0 == (*mdocs[n->tok].fp)(hash, buf, dbuf, n, m))
- break;
-
- /*
- * For many macros, use the text from all children.
- * Set zero flags for macros not needing this.
- * In that case, the handler must fill the buffer.
- */
-
- if (MDOCF_CHILD & mdocs[n->tok].flags)
- buf_appendmdoc(buf, n->child, 0);
-
- /*
- * Cover the most common case:
- * Automatically stage one string per element.
- * Set a zero mask for macros not needing this.
- * Additional staging can be done in the handler.
- */
-
- if (mdocs[n->tok].mask)
- hash_put(hash, buf, mdocs[n->tok].mask);
- break;
- default:
- break;
+ for ( ; NULL != n; n = n->next) {
+ if (NULL != n->child)
+ putmdockey(of, n->child, m);
+ if (MDOC_TEXT == n->type)
+ putkey(of, n->string, m);
}
-
- pmdoc_node(hash, buf, dbuf, n->child, m);
- pmdoc_node(hash, buf, dbuf, n->next, m);
}
static int
-pman_node(MAN_ARGS)
+parse_man(struct of *of, const struct man_node *n)
{
const struct man_node *head, *body;
- const char *start, *sv;
- size_t sz;
+ char *start, *sv, *title;
+ char byte;
+ size_t sz, titlesz;
if (NULL == n)
return(0);
NULL != (body = body->child) &&
MAN_TEXT == body->type) {
- assert(body->string);
- start = sv = body->string;
+ title = NULL;
+ titlesz = 0;
+
+ /*
+ * Suck the entire NAME section into memory.
+ * Yes, we might run away.
+ * But too many manuals have big, spread-out
+ * NAME sections over many lines.
+ */
+
+ for ( ; NULL != body; body = body->next) {
+ if (MAN_TEXT != body->type)
+ break;
+ if (0 == (sz = strlen(body->string)))
+ continue;
+ title = mandoc_realloc
+ (title, titlesz + sz + 1);
+ memcpy(title + titlesz, body->string, sz);
+ titlesz += sz + 1;
+ title[titlesz - 1] = ' ';
+ }
+ if (NULL == title)
+ return(1);
+
+ title = mandoc_realloc(title, titlesz + 1);
+ title[titlesz] = '\0';
+
+ /* Skip leading space. */
+
+ sv = title;
+ while (isspace((unsigned char)*sv))
+ sv++;
+
+ if (0 == (sz = strlen(sv))) {
+ free(title);
+ return(1);
+ }
+
+ /* Erase trailing space. */
+
+ start = &sv[sz - 1];
+ while (start > sv && isspace((unsigned char)*start))
+ *start-- = '\0';
+
+ if (start == sv) {
+ free(title);
+ return(1);
+ }
+
+ start = sv;
/*
* Go through a special heuristic dance here.
- * This is why -man manuals are great!
- * (I'm being sarcastic: my eyes are bleeding.)
* Conventionally, one or more manual names are
* comma-specified prior to a whitespace, then a
* dash, then a description. Try to puzzle out
for ( ;; ) {
sz = strcspn(start, " ,");
- if ('\0' == start[(int)sz])
+ if ('\0' == start[sz])
break;
- buf->len = 0;
- buf_appendb(buf, start, sz);
- buf_appendb(buf, "", 1);
+ byte = start[sz];
+ start[sz] = '\0';
- hash_put(hash, buf, TYPE_Nm);
+ putkey(of, start, TYPE_Nm);
- if (' ' == start[(int)sz]) {
- start += (int)sz + 1;
+ if (' ' == byte) {
+ start += sz + 1;
break;
}
- assert(',' == start[(int)sz]);
- start += (int)sz + 1;
+ assert(',' == byte);
+ start += sz + 1;
while (' ' == *start)
start++;
}
- buf->len = 0;
-
if (sv == start) {
- buf_append(buf, start);
+ putkey(of, start, TYPE_Nm);
+ free(title);
return(1);
}
- while (' ' == *start)
+ while (isspace((unsigned char)*start))
start++;
if (0 == strncmp(start, "-", 1))
start += 1;
+ else if (0 == strncmp(start, "\\-\\-", 4))
+ start += 4;
else if (0 == strncmp(start, "\\-", 2))
start += 2;
else if (0 == strncmp(start, "\\(en", 4))
while (' ' == *start)
start++;
- sz = strlen(start) + 1;
- buf_appendb(dbuf, start, sz);
- buf_appendb(buf, start, sz);
-
- hash_put(hash, buf, TYPE_Nd);
+ assert(NULL == of->desc);
+ of->desc = stradd(start);
+ putkey(of, start, TYPE_Nd);
+ free(title);
+ return(1);
}
}
for (n = n->child; n; n = n->next)
- if (pman_node(hash, buf, dbuf, n))
+ if (parse_man(of, n))
return(1);
return(0);
}
-/*
- * Parse a formatted manual page.
- * By necessity, this involves rather crude guesswork.
- */
static void
-pformatted(DB *hash, struct buf *buf, struct buf *dbuf,
- const struct of *of)
+parse_mdoc(struct of *of, const struct mdoc_node *n)
{
- FILE *stream;
- char *line, *p;
- size_t len, plen;
- if (NULL == (stream = fopen(of->fname, "r"))) {
- perror(of->fname);
- return;
+ assert(NULL != n);
+ for (n = n->child; NULL != n; n = n->next) {
+ switch (n->type) {
+ case (MDOC_ELEM):
+ /* FALLTHROUGH */
+ case (MDOC_BLOCK):
+ /* FALLTHROUGH */
+ case (MDOC_HEAD):
+ /* FALLTHROUGH */
+ case (MDOC_BODY):
+ /* FALLTHROUGH */
+ case (MDOC_TAIL):
+ if (NULL != mdocs[n->tok].fp)
+ if (0 == (*mdocs[n->tok].fp)(of, n))
+ break;
+
+ if (MDOCF_CHILD & mdocs[n->tok].flags)
+ putmdockey(of, n->child, mdocs[n->tok].mask);
+ break;
+ default:
+ assert(MDOC_ROOT != n->type);
+ continue;
+ }
+ if (NULL != n->child)
+ parse_mdoc(of, n);
}
+}
+
+static int
+parse_mdoc_Fd(struct of *of, const struct mdoc_node *n)
+{
+ const char *start, *end;
+ size_t sz;
+
+ if (SEC_SYNOPSIS != n->sec ||
+ NULL == (n = n->child) ||
+ MDOC_TEXT != n->type)
+ return(0);
/*
- * Always use the title derived from the filename up front,
- * do not even try to find it in the file. This also makes
- * sure we don't end up with an orphan index record, even if
- * the file content turns out to be completely unintelligible.
+ * Only consider those `Fd' macro fields that begin with an
+ * "inclusion" token (versus, e.g., #define).
*/
- buf->len = 0;
- buf_append(buf, of->title);
- hash_put(hash, buf, TYPE_Nm);
-
- /* Skip to first blank line. */
+ if (strcmp("#include", n->string))
+ return(0);
- while (NULL != (line = fgetln(stream, &len)))
- if ('\n' == *line)
- break;
+ if (NULL == (n = n->next) || MDOC_TEXT != n->type)
+ return(0);
/*
- * Assume the first line that is not indented
- * is the first section header. Skip to it.
+ * Strip away the enclosing angle brackets and make sure we're
+ * not zero-length.
*/
- while (NULL != (line = fgetln(stream, &len)))
- if ('\n' != *line && ' ' != *line)
- break;
+ start = n->string;
+ if ('<' == *start || '"' == *start)
+ start++;
- /*
- * If no page content can be found, or the input line
- * is already the next section header, or there is no
- * trailing newline, reuse the page title as the page
- * description.
+ if (0 == (sz = strlen(start)))
+ return(0);
+
+ end = &start[(int)sz - 1];
+ if ('>' == *end || '"' == *end)
+ end--;
+
+ if (end > start)
+ putkeys(of, start, end - start + 1, TYPE_In);
+ return(1);
+}
+
+static int
+parse_mdoc_In(struct of *of, const struct mdoc_node *n)
+{
+
+ if (NULL != n->child && MDOC_TEXT == n->child->type)
+ return(0);
+
+ putkey(of, n->child->string, TYPE_In);
+ return(1);
+}
+
+static int
+parse_mdoc_Fn(struct of *of, const struct mdoc_node *n)
+{
+ const char *cp;
+
+ if (NULL == (n = n->child) || MDOC_TEXT != n->type)
+ return(0);
+
+ /*
+ * Parse: .Fn "struct type *name" "char *arg".
+ * First strip away pointer symbol.
+ * Then store the function name, then type.
+ * Finally, store the arguments.
*/
- line = fgetln(stream, &len);
- if (NULL == line || ' ' != *line || '\n' != line[(int)len - 1]) {
- buf_appendb(dbuf, buf->cp, buf->size);
- hash_put(hash, buf, TYPE_Nd);
- fclose(stream);
- return;
- }
+ if (NULL == (cp = strrchr(n->string, ' ')))
+ cp = n->string;
+
+ while ('*' == *cp)
+ cp++;
+
+ putkey(of, cp, TYPE_Fn);
+
+ if (n->string < cp)
+ putkeys(of, n->string, cp - n->string, TYPE_Ft);
+
+ for (n = n->next; NULL != n; n = n->next)
+ if (MDOC_TEXT == n->type)
+ putkey(of, n->string, TYPE_Fa);
+
+ return(0);
+}
+
+static int
+parse_mdoc_St(struct of *of, const struct mdoc_node *n)
+{
+
+ if (NULL == n->child || MDOC_TEXT != n->child->type)
+ return(0);
+
+ putkey(of, n->child->string, TYPE_St);
+ return(1);
+}
+
+static int
+parse_mdoc_Xr(struct of *of, const struct mdoc_node *n)
+{
- line[(int)--len] = '\0';
+ if (NULL == (n = n->child))
+ return(0);
+
+ putkey(of, n->string, TYPE_Xr);
+ return(1);
+}
+
+static int
+parse_mdoc_Nd(struct of *of, const struct mdoc_node *n)
+{
+ size_t sz;
+ char *sv, *desc;
+
+ if (MDOC_BODY != n->type)
+ return(0);
/*
- * Skip to the first dash.
- * Use the remaining line as the description (no more than 70
- * bytes).
+ * Special-case the `Nd' because we need to put the description
+ * into the document table.
*/
- if (NULL != (p = strstr(line, "- "))) {
- for (p += 2; ' ' == *p || '\b' == *p; p++)
- /* Skip to next word. */ ;
- } else
- p = line;
-
- if ((plen = strlen(p)) > 70) {
- plen = 70;
- p[plen] = '\0';
+ desc = NULL;
+ for (n = n->child; NULL != n; n = n->next) {
+ if (MDOC_TEXT == n->type) {
+ sz = strlen(n->string) + 1;
+ if (NULL != (sv = desc))
+ sz += strlen(desc) + 1;
+ desc = mandoc_realloc(desc, sz);
+ if (NULL != sv)
+ strlcat(desc, " ", sz);
+ else
+ *desc = '\0';
+ strlcat(desc, n->string, sz);
+ }
+ if (NULL != n->child)
+ parse_mdoc_Nd(of, n);
}
- /* Strip backspace-encoding from line. */
+ of->desc = NULL != desc ? stradd(desc) : NULL;
+ free(desc);
+ return(1);
+}
- while (NULL != (line = memchr(p, '\b', plen))) {
- len = line - p;
- if (0 == len) {
- memmove(line, line + 1, plen--);
- continue;
- }
- memmove(line - 1, line + 1, plen - len);
- plen -= 2;
+static int
+parse_mdoc_Nm(struct of *of, const struct mdoc_node *n)
+{
+
+ if (SEC_NAME == n->sec)
+ return(1);
+ else if (SEC_SYNOPSIS != n->sec || MDOC_HEAD != n->type)
+ return(0);
+
+ return(1);
+}
+
+static int
+parse_mdoc_Sh(struct of *of, const struct mdoc_node *n)
+{
+
+ return(SEC_CUSTOM == n->sec && MDOC_HEAD == n->type);
+}
+
+static int
+parse_mdoc_head(struct of *of, const struct mdoc_node *n)
+{
+
+ return(MDOC_HEAD == n->type);
+}
+
+static int
+parse_mdoc_body(struct of *of, const struct mdoc_node *n)
+{
+
+ return(MDOC_BODY == n->type);
+}
+
+/*
+ * See straddbuf().
+ */
+static char *
+stradd(const char *cp)
+{
+
+ return(straddbuf(cp, strlen(cp)));
+}
+
+/*
+ * This looks up or adds a string to the string table.
+ * The string table is a table of all strings encountered during parse
+ * or file scan.
+ * In using it, we avoid having thousands of (e.g.) "cat1" string
+ * allocations for the "of" table.
+ * We also have a layer atop the string table for keeping track of words
+ * in a parse sequence (see wordaddbuf()).
+ */
+static char *
+straddbuf(const char *cp, size_t sz)
+{
+ struct str *s;
+ unsigned int index;
+ const char *end;
+
+ if (NULL != (s = hashget(cp, sz)))
+ return(s->key);
+
+ s = mandoc_calloc(sizeof(struct str) + sz + 1, 1);
+ memcpy(s->key, cp, sz);
+
+ end = cp + sz;
+ index = ohash_qlookupi(&strings, cp, &end);
+ assert(NULL == ohash_find(&strings, index));
+ ohash_insert(&strings, index, s);
+ return(s->key);
+}
+
+static struct str *
+hashget(const char *cp, size_t sz)
+{
+ unsigned int index;
+ const char *end;
+
+ end = cp + sz;
+ index = ohash_qlookupi(&strings, cp, &end);
+ return(ohash_find(&strings, index));
+}
+
+/*
+ * Add a word to the current parse sequence.
+ * Within the hashtable of strings, we maintain a list of strings that
+ * are currently indexed.
+ * Each of these ("words") has a bitmask modified within the parse.
+ * When we finish a parse, we'll dump the list, then remove the head
+ * entry -- since the next parse will have a new "of", it can keep track
+ * of its entries without conflict.
+ */
+static void
+wordaddbuf(const struct of *of,
+ const char *cp, size_t sz, uint64_t v)
+{
+ struct str *s;
+ unsigned int index;
+ const char *end;
+
+ if (0 == sz)
+ return;
+
+ s = hashget(cp, sz);
+
+ if (NULL != s && of == s->of) {
+ s->mask |= v;
+ return;
+ } else if (NULL == s) {
+ s = mandoc_calloc(sizeof(struct str) + sz + 1, 1);
+ memcpy(s->key, cp, sz);
+ end = cp + sz;
+ index = ohash_qlookupi(&strings, cp, &end);
+ assert(NULL == ohash_find(&strings, index));
+ ohash_insert(&strings, index, s);
}
- buf_appendb(dbuf, p, plen + 1);
- buf->len = 0;
- buf_appendb(buf, p, plen + 1);
- hash_put(hash, buf, TYPE_Nd);
- fclose(stream);
+ s->next = words;
+ s->of = of;
+ s->mask = v;
+ words = s;
}
+/*
+ * Take a Unicode codepoint and produce its UTF-8 encoding.
+ * This isn't the best way to do this, but it works.
+ * The magic numbers are from the UTF-8 packaging.
+ * They're not as scary as they seem: read the UTF-8 spec for details.
+ */
+static size_t
+utf8(unsigned int cp, char out[7])
+{
+ size_t rc;
+
+ rc = 0;
+ if (cp <= 0x0000007F) {
+ rc = 1;
+ out[0] = (char)cp;
+ } else if (cp <= 0x000007FF) {
+ rc = 2;
+ out[0] = (cp >> 6 & 31) | 192;
+ out[1] = (cp & 63) | 128;
+ } else if (cp <= 0x0000FFFF) {
+ rc = 3;
+ out[0] = (cp >> 12 & 15) | 224;
+ out[1] = (cp >> 6 & 63) | 128;
+ out[2] = (cp & 63) | 128;
+ } else if (cp <= 0x001FFFFF) {
+ rc = 4;
+ out[0] = (cp >> 18 & 7) | 240;
+ out[1] = (cp >> 12 & 63) | 128;
+ out[2] = (cp >> 6 & 63) | 128;
+ out[3] = (cp & 63) | 128;
+ } else if (cp <= 0x03FFFFFF) {
+ rc = 5;
+ out[0] = (cp >> 24 & 3) | 248;
+ out[1] = (cp >> 18 & 63) | 128;
+ out[2] = (cp >> 12 & 63) | 128;
+ out[3] = (cp >> 6 & 63) | 128;
+ out[4] = (cp & 63) | 128;
+ } else if (cp <= 0x7FFFFFFF) {
+ rc = 6;
+ out[0] = (cp >> 30 & 1) | 252;
+ out[1] = (cp >> 24 & 63) | 128;
+ out[2] = (cp >> 18 & 63) | 128;
+ out[3] = (cp >> 12 & 63) | 128;
+ out[4] = (cp >> 6 & 63) | 128;
+ out[5] = (cp & 63) | 128;
+ } else
+ return(0);
+
+ out[rc] = '\0';
+ return(rc);
+}
+
+/*
+ * Store the UTF-8 version of a key, or alias the pointer if the key has
+ * no UTF-8 transcription marks in it.
+ */
static void
-ofile_argbuild(int argc, char *argv[], struct of **of)
+utf8key(struct mchars *mc, struct str *key)
{
- char buf[MAXPATHLEN];
- char *sec, *arch, *title, *p;
- int i, src_form;
- struct of *nof;
+ size_t sz, bsz, pos;
+ char utfbuf[7], res[5];
+ char *buf;
+ const char *seq, *cpp, *val;
+ int len, u;
+ enum mandoc_esc esc;
+
+ assert(NULL == key->utf8);
+
+ res[0] = '\\';
+ res[1] = '\t';
+ res[2] = ASCII_NBRSP;
+ res[3] = ASCII_HYPH;
+ res[4] = '\0';
+
+ val = key->key;
+ bsz = strlen(val);
+
+ /*
+ * Pre-check: if we have no stop-characters, then set the
+ * pointer as ourselvse and get out of here.
+ */
+ if (strcspn(val, res) == bsz) {
+ key->utf8 = key->key;
+ return;
+ }
- for (i = 0; i < argc; i++) {
+ /* Pre-allocate by the length of the input */
+ buf = mandoc_malloc(++bsz);
+ pos = 0;
+
+ while ('\0' != *val) {
/*
- * Try to infer the manual section, architecture and
- * page title from the path, assuming it looks like
- * man*[/<arch>]/<title>.<section> or
- * cat<section>[/<arch>]/<title>.0
+ * Halt on the first escape sequence.
+ * This also halts on the end of string, in which case
+ * we just copy, fallthrough, and exit the loop.
*/
+ if ((sz = strcspn(val, res)) > 0) {
+ memcpy(&buf[pos], val, sz);
+ pos += sz;
+ val += sz;
+ }
- if (strlcpy(buf, argv[i], sizeof(buf)) >= sizeof(buf)) {
- fprintf(stderr, "%s: Path too long\n", argv[i]);
+ if (ASCII_HYPH == *val) {
+ buf[pos++] = '-';
+ val++;
continue;
- }
- sec = arch = title = NULL;
- src_form = 0;
- p = strrchr(buf, '\0');
- while (p-- > buf) {
- if (NULL == sec && '.' == *p) {
- sec = p + 1;
- *p = '\0';
- if ('0' == *sec)
- src_form |= MANDOC_FORM;
- else if ('1' <= *sec && '9' >= *sec)
- src_form |= MANDOC_SRC;
- continue;
- }
- if ('/' != *p)
- continue;
- if (NULL == title) {
- title = p + 1;
- *p = '\0';
- continue;
- }
- if (0 == strncmp("man", p + 1, 3))
- src_form |= MANDOC_SRC;
- else if (0 == strncmp("cat", p + 1, 3))
- src_form |= MANDOC_FORM;
- else
- arch = p + 1;
+ } else if ('\t' == *val || ASCII_NBRSP == *val) {
+ buf[pos++] = ' ';
+ val++;
+ continue;
+ } else if ('\\' != *val)
break;
- }
- if (NULL == title)
- title = buf;
+
+ /* Read past the slash. */
+
+ val++;
+ u = 0;
/*
- * Build the file structure.
+ * Parse the escape sequence and see if it's a
+ * predefined character or special character.
*/
+ esc = mandoc_escape
+ ((const char **)&val, &seq, &len);
+ if (ESCAPE_ERROR == esc)
+ break;
- nof = mandoc_calloc(1, sizeof(struct of));
- nof->fname = mandoc_strdup(argv[i]);
- if (NULL != sec)
- nof->sec = mandoc_strdup(sec);
- if (NULL != arch)
- nof->arch = mandoc_strdup(arch);
- nof->title = mandoc_strdup(title);
- nof->src_form = src_form;
+ if (ESCAPE_SPECIAL != esc)
+ continue;
+ if (0 == (u = mchars_spec2cp(mc, seq, len)))
+ continue;
/*
- * Add the structure to the list.
+ * If we have a Unicode codepoint, try to convert that
+ * to a UTF-8 byte string.
*/
+ cpp = utfbuf;
+ if (0 == (sz = utf8(u, utfbuf)))
+ continue;
- if (NULL == *of) {
- *of = nof;
- (*of)->first = nof;
- } else {
- nof->first = (*of)->first;
- (*of)->next = nof;
- *of = nof;
- }
+ /* Copy the rendered glyph into the stream. */
+
+ sz = strlen(cpp);
+ bsz += sz;
+
+ buf = mandoc_realloc(buf, bsz);
+
+ memcpy(&buf[pos], cpp, sz);
+ pos += sz;
}
+
+ buf[pos] = '\0';
+ key->utf8 = buf;
}
/*
- * Recursively build up a list of files to parse.
- * We use this instead of ftw() and so on because I don't want global
- * variables hanging around.
- * This ignores the mandoc.db and mandoc.index files, but assumes that
- * everything else is a manual.
- * Pass in a pointer to a NULL structure for the first invocation.
+ * Flush the current page's terms (and their bits) into the database.
+ * Wrap the entire set of additions in a transaction to make sqlite be a
+ * little faster.
+ * Also, UTF-8-encode the description at the last possible moment.
*/
static void
-ofile_dirbuild(const char *dir, const char* psec, const char *parch,
- int p_src_form, struct of **of)
+dbindex(struct mchars *mc, int form,
+ const struct of *of, const char *base)
{
- char buf[MAXPATHLEN];
- size_t sz;
- DIR *d;
- const char *fn, *sec, *arch;
- char *p, *q, *suffix;
- struct of *nof;
- struct dirent *dp;
- int src_form;
-
- if (NULL == (d = opendir(dir))) {
- perror(dir);
- exit((int)MANDOCLEVEL_SYSERR);
+ struct str *key;
+ const char *desc;
+ int64_t recno;
+ size_t i;
+
+ DEBUG(of->file, base, "Adding to index");
+
+ if (nodb)
+ return;
+
+ desc = "";
+ if (NULL != of->desc) {
+ key = hashget(of->desc, strlen(of->desc));
+ assert(NULL != key);
+ if (NULL == key->utf8)
+ utf8key(mc, key);
+ desc = key->utf8;
}
- while (NULL != (dp = readdir(d))) {
- fn = dp->d_name;
+ SQL_EXEC("BEGIN TRANSACTION");
+
+ i = 1;
+ SQL_BIND_TEXT(stmts[STMT_INSERT_DOC], i, of->file);
+ SQL_BIND_TEXT(stmts[STMT_INSERT_DOC], i, of->sec);
+ SQL_BIND_TEXT(stmts[STMT_INSERT_DOC], i, of->arch);
+ SQL_BIND_TEXT(stmts[STMT_INSERT_DOC], i, desc);
+ SQL_BIND_INT(stmts[STMT_INSERT_DOC], i, form);
+ SQL_STEP(stmts[STMT_INSERT_DOC]);
+ recno = sqlite3_last_insert_rowid(db);
+ sqlite3_reset(stmts[STMT_INSERT_DOC]);
+
+ for (key = words; NULL != key; key = key->next) {
+ assert(key->of == of);
+ if (NULL == key->utf8)
+ utf8key(mc, key);
+ i = 1;
+ SQL_BIND_INT64(stmts[STMT_INSERT_KEY], i, key->mask);
+ SQL_BIND_TEXT(stmts[STMT_INSERT_KEY], i, key->utf8);
+ SQL_BIND_INT64(stmts[STMT_INSERT_KEY], i, recno);
+ SQL_STEP(stmts[STMT_INSERT_KEY]);
+ sqlite3_reset(stmts[STMT_INSERT_KEY]);
+ }
- if ('.' == *fn)
- continue;
+ SQL_EXEC("END TRANSACTION");
+}
- src_form = p_src_form;
+static void
+dbprune(const char *base)
+{
+ struct of *of;
+ size_t i;
- if (DT_DIR == dp->d_type) {
- sec = psec;
- arch = parch;
+ if (nodb)
+ return;
- /*
- * By default, only use directories called:
- * man<section>/[<arch>/] or
- * cat<section>/[<arch>/]
- */
+ for (of = ofs; NULL != of; of = of->next) {
+ i = 1;
+ SQL_BIND_TEXT(stmts[STMT_DELETE], i, of->file);
+ SQL_STEP(stmts[STMT_DELETE]);
+ sqlite3_reset(stmts[STMT_DELETE]);
+ DEBUG(of->file, base, "Deleted from index");
+ }
+}
- if (NULL == sec) {
- if(0 == strncmp("man", fn, 3)) {
- src_form |= MANDOC_SRC;
- sec = fn + 3;
- } else if (0 == strncmp("cat", fn, 3)) {
- src_form |= MANDOC_FORM;
- sec = fn + 3;
- } else if (use_all)
- sec = fn;
- else
- continue;
- } else if (NULL == arch && (use_all ||
- NULL == strchr(fn, '.')))
- arch = fn;
- else if (0 == use_all)
- continue;
+/*
+ * Close an existing database and its prepared statements.
+ * If "real" is not set, rename the temporary file into the real one.
+ */
+static void
+dbclose(const char *base, int real)
+{
+ size_t i;
+ char file[MAXPATHLEN];
- buf[0] = '\0';
- strlcat(buf, dir, MAXPATHLEN);
- strlcat(buf, "/", MAXPATHLEN);
- sz = strlcat(buf, fn, MAXPATHLEN);
+ if (nodb)
+ return;
- if (MAXPATHLEN <= sz) {
- fprintf(stderr, "%s: Path too long\n", dir);
- exit((int)MANDOCLEVEL_SYSERR);
- }
-
- ofile_dirbuild(buf, sec, arch, src_form, of);
- }
+ for (i = 0; i < STMT__MAX; i++) {
+ sqlite3_finalize(stmts[i]);
+ stmts[i] = NULL;
+ }
- if (DT_REG != dp->d_type ||
- (NULL == psec && !use_all) ||
- ! strcmp(MANDOC_DB, fn) ||
- ! strcmp(MANDOC_IDX, fn))
- continue;
+ sqlite3_close(db);
+ db = NULL;
- /*
- * By default, skip files where the file name suffix
- * does not agree with the section directory
- * they are located in.
- */
+ if (real)
+ return;
- suffix = strrchr(fn, '.');
- if (0 == use_all) {
- if (NULL == suffix)
- continue;
- if ((MANDOC_SRC & src_form &&
- strcmp(suffix + 1, psec)) ||
- (MANDOC_FORM & src_form &&
- strcmp(suffix + 1, "0")))
- continue;
- }
- if (NULL != suffix) {
- if ('0' == suffix[1])
- src_form |= MANDOC_FORM;
- else if ('1' <= suffix[1] && '9' >= suffix[1])
- src_form |= MANDOC_SRC;
- }
+ strlcpy(file, MANDOC_DB, MAXPATHLEN);
+ strlcat(file, "~", MAXPATHLEN);
+ if (-1 == rename(file, MANDOC_DB))
+ perror(MANDOC_DB);
+}
+/*
+ * This is straightforward stuff.
+ * Open a database connection to a "temporary" database, then open a set
+ * of prepared statements we'll use over and over again.
+ * If "real" is set, we use the existing database; if not, we truncate a
+ * temporary one.
+ * Must be matched by dbclose().
+ */
+static int
+dbopen(const char *base, int real)
+{
+ char file[MAXPATHLEN];
+ const char *sql;
+ int rc, ofl;
+ size_t sz;
- /*
- * Skip formatted manuals if a source version is
- * available. Ignore the age: it is very unlikely
- * that people install newer formatted base manuals
- * when they used to have source manuals before,
- * and in ports, old manuals get removed on update.
- */
- if (0 == use_all && MANDOC_FORM & src_form &&
- NULL != psec) {
- buf[0] = '\0';
- strlcat(buf, dir, MAXPATHLEN);
- p = strrchr(buf, '/');
- if (NULL != parch && NULL != p)
- for (p--; p > buf; p--)
- if ('/' == *p)
- break;
- if (NULL == p)
- p = buf;
- else
- p++;
- if (0 == strncmp("cat", p, 3))
- memcpy(p, "man", 3);
- strlcat(buf, "/", MAXPATHLEN);
- sz = strlcat(buf, fn, MAXPATHLEN);
- if (sz >= MAXPATHLEN) {
- fprintf(stderr, "%s: Path too long\n", buf);
- continue;
- }
- q = strrchr(buf, '.');
- if (NULL != q && p < q++) {
- *q = '\0';
- sz = strlcat(buf, psec, MAXPATHLEN);
- if (sz >= MAXPATHLEN) {
- fprintf(stderr,
- "%s: Path too long\n", buf);
- continue;
- }
- if (0 == access(buf, R_OK))
- continue;
- }
- }
+ if (nodb)
+ return(1);
- assert('.' == dir[0]);
- assert('/' == dir[1]);
- buf[0] = '\0';
- strlcat(buf, dir + 2, MAXPATHLEN);
- strlcat(buf, "/", MAXPATHLEN);
- sz = strlcat(buf, fn, MAXPATHLEN);
- if (sz >= MAXPATHLEN) {
- fprintf(stderr, "%s: Path too long\n", dir);
- continue;
- }
+ sz = strlcpy(file, MANDOC_DB, MAXPATHLEN);
+ if ( ! real)
+ sz = strlcat(file, "~", MAXPATHLEN);
- nof = mandoc_calloc(1, sizeof(struct of));
- nof->fname = mandoc_strdup(buf);
- if (NULL != psec)
- nof->sec = mandoc_strdup(psec);
- if (NULL != parch)
- nof->arch = mandoc_strdup(parch);
- nof->src_form = src_form;
+ if (sz >= MAXPATHLEN) {
+ fprintf(stderr, "%s: Path too long\n", file);
+ return(0);
+ }
- /*
- * Remember the file name without the extension,
- * to be used as the page title in the database.
- */
+ if ( ! real)
+ remove(file);
- if (NULL != suffix)
- *suffix = '\0';
- nof->title = mandoc_strdup(fn);
+ ofl = SQLITE_OPEN_READWRITE |
+ (0 == real ? SQLITE_OPEN_EXCLUSIVE : 0);
- /*
- * Add the structure to the list.
- */
+ rc = sqlite3_open_v2(file, &db, ofl, NULL);
+ if (SQLITE_OK == rc)
+ return(1);
+ if (SQLITE_CANTOPEN != rc) {
+ perror(file);
+ return(0);
+ }
- if (NULL == *of) {
- *of = nof;
- (*of)->first = nof;
- } else {
- nof->first = (*of)->first;
- (*of)->next = nof;
- *of = nof;
- }
+ sqlite3_close(db);
+ db = NULL;
+
+ if (SQLITE_OK != (rc = sqlite3_open(file, &db))) {
+ perror(file);
+ return(0);
+ }
+
+ sql = "CREATE TABLE \"docs\" (\n"
+ " \"file\" TEXT NOT NULL,\n"
+ " \"sec\" TEXT NOT NULL,\n"
+ " \"arch\" TEXT NOT NULL,\n"
+ " \"desc\" TEXT NOT NULL,\n"
+ " \"form\" INTEGER NOT NULL,\n"
+ " \"id\" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL\n"
+ ");\n"
+ "\n"
+ "CREATE TABLE \"keys\" (\n"
+ " \"bits\" INTEGER NOT NULL,\n"
+ " \"key\" TEXT NOT NULL,\n"
+ " \"docid\" INTEGER NOT NULL REFERENCES docs(id) "
+ "ON DELETE CASCADE,\n"
+ " \"id\" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL\n"
+ ");\n"
+ "\n"
+ "CREATE INDEX \"key_index\" ON keys (key);\n";
+
+ if (SQLITE_OK != sqlite3_exec(db, sql, NULL, NULL, NULL)) {
+ perror(sqlite3_errmsg(db));
+ return(0);
}
- closedir(d);
+ sql = "DELETE FROM docs where file=?";
+ sqlite3_prepare_v2(db, sql, -1, &stmts[STMT_DELETE], NULL);
+ sql = "INSERT INTO docs "
+ "(file,sec,arch,desc,form) VALUES (?,?,?,?,?)";
+ sqlite3_prepare_v2(db, sql, -1, &stmts[STMT_INSERT_DOC], NULL);
+ sql = "INSERT INTO keys "
+ "(bits,key,docid) VALUES (?,?,?)";
+ sqlite3_prepare_v2(db, sql, -1, &stmts[STMT_INSERT_KEY], NULL);
+ return(1);
}
-static void
-ofile_free(struct of *of)
+static void *
+hash_halloc(size_t sz, void *arg)
{
- struct of *nof;
-
- while (of) {
- nof = of->next;
- free(of->fname);
- free(of->sec);
- free(of->arch);
- free(of->title);
- free(of);
- of = nof;
- }
+
+ return(mandoc_calloc(sz, 1));
+}
+
+static void *
+hash_alloc(size_t sz, void *arg)
+{
+
+ return(mandoc_malloc(sz));
}
static void
-usage(void)
+hash_free(void *p, size_t sz, void *arg)
+{
+
+ free(p);
+}
+
+static int
+path_reset(const char *cwd, int fd, const char *base)
{
- fprintf(stderr, "usage: %s [-v] "
- "[-C file] |"
- " dir ... |"
- " -d dir [file ...] |"
- " -u dir [file ...]\n", progname);
+ if (-1 == fchdir(fd)) {
+ perror(cwd);
+ return(0);
+ } else if (-1 == chdir(base)) {
+ perror(base);
+ return(0);
+ }
+ return(1);
}
git.ckatri.com / mandoc.git / blobdiff