[BACK]Return to mandocdb.c CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandocdb.c between version 1.4 and 1.56

version 1.4, 2011/07/15 10:15:24 version 1.56, 2013/06/03 19:01:31
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>   * Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
    * Copyright (c) 2011, 2012, 2013 Ingo Schwarze <schwarze@openbsd.org>
  *   *
  * Permission to use, copy, modify, and distribute this software for any   * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above   * purpose with or without fee is hereby granted, provided that the above
Line 19 
Line 20 
 #endif  #endif
   
 #include <sys/param.h>  #include <sys/param.h>
   #include <sys/stat.h>
   
 #include <assert.h>  #include <assert.h>
 #include <dirent.h>  #include <ctype.h>
   #include <errno.h>
 #include <fcntl.h>  #include <fcntl.h>
   #include <fts.h>
 #include <getopt.h>  #include <getopt.h>
 #include <stdio.h>  #include <stddef.h>
 #include <stdint.h>  #include <stdint.h>
 #include <stdlib.h>  #include <stdlib.h>
 #include <string.h>  #include <string.h>
   #include <unistd.h>
   
 #ifdef __linux__  #ifdef HAVE_OHASH
 # include <db_185.h>  #include <ohash.h>
 #else  #else
 # include <db.h>  #include "compat_ohash.h"
 #endif  #endif
   #include <sqlite3.h>
   
 #include "man.h"  
 #include "mdoc.h"  #include "mdoc.h"
   #include "man.h"
 #include "mandoc.h"  #include "mandoc.h"
   #include "manpath.h"
   #include "mansearch.h"
   
 #define MANDOC_DB        "mandoc.db"  #define SQL_EXEC(_v) \
 #define MANDOC_IDX       "mandoc.index"          if (SQLITE_OK != sqlite3_exec(db, (_v), NULL, NULL, NULL)) \
 #define MANDOC_BUFSZ      BUFSIZ                  fprintf(stderr, "%s\n", sqlite3_errmsg(db))
 #define MANDOC_FLAGS      O_CREAT|O_TRUNC|O_RDWR  #define SQL_BIND_TEXT(_s, _i, _v) \
 #define MANDOC_SLOP       1024          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))
   
 /* Bit-fields.  See mandocdb.8. */  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 */
   };
   
 #define TYPE_NAME         0x01  enum    form {
 #define TYPE_FUNCTION     0x02          FORM_SRC, /* format is -man or -mdoc */
 #define TYPE_UTILITY      0x04          FORM_CAT, /* format is cat */
 #define TYPE_INCLUDES     0x08          FORM_NONE /* format is unknown */
 #define TYPE_VARIABLE     0x10  };
 #define TYPE_STANDARD     0x20  
 #define TYPE_AUTHOR       0x40  
 #define TYPE_CONFIG       0x80  
 #define TYPE_DESC         0x100  
 #define TYPE_XREF         0x200  
 #define TYPE_PATH         0x400  
 #define TYPE_ENV          0x800  
 #define TYPE_ERR          0x1000  
   
 struct  of {  struct  str {
         char             *fname;          char            *utf8; /* key in UTF-8 form */
         struct of        *next;          const struct of *of; /* if set, the owning parse */
         struct of        *first;          struct str      *next; /* next in owning parse sequence */
           uint64_t         mask; /* bitmask in sequence */
           char             key[]; /* the string itself */
 };  };
   
 /* Buffer for storing growable data. */  struct  id {
           ino_t            ino;
           dev_t            dev;
   };
   
 struct  buf {  struct  of {
         char             *cp;          struct id        id; /* used for hashing routine */
         size_t            len;          struct of       *next; /* next in ofs */
         size_t            size;          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) */
 };  };
   
 /* Operation we're going to perform. */  enum    stmt {
           STMT_DELETE = 0, /* delete manpage */
 enum    op {          STMT_INSERT_DOC, /* insert manpage */
         OP_NEW = 0, /* new database */          STMT_INSERT_KEY, /* insert parsed key */
         OP_UPDATE, /* update entries in existing database */          STMT__MAX
         OP_DELETE /* delete entries from existing database */  
 };  };
   
 #define MAN_ARGS          DB *hash, \  typedef int (*mdoc_fp)(struct of *, const struct mdoc_node *);
                           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 *,  struct  mdoc_handler {
                                 const struct mdoc_node *, int);          mdoc_fp          fp; /* optional handler */
 static  void              buf_append(struct buf *, const char *);          uint64_t         mask;  /* set unless handler returns 0 */
 static  void              buf_appendb(struct buf *,          int              flags;  /* for use by pmdoc_node */
                                 const void *, size_t);  #define MDOCF_CHILD      0x01  /* automatically index child nodes */
 static  void              dbt_put(DB *, const char *, DBT *, DBT *);  };
 static  void              hash_put(DB *, const struct buf *, int);  
 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 *);  
 static  int               ofile_build(const char *, struct of **);  
 static  void              ofile_free(struct of *);  
 static  int               pman_node(MAN_ARGS);  
 static  void              pmdoc_node(MDOC_ARGS);  
 static  void              pmdoc_An(MDOC_ARGS);  
 static  void              pmdoc_Cd(MDOC_ARGS);  
 static  void              pmdoc_Er(MDOC_ARGS);  
 static  void              pmdoc_Ev(MDOC_ARGS);  
 static  void              pmdoc_Fd(MDOC_ARGS);  
 static  void              pmdoc_In(MDOC_ARGS);  
 static  void              pmdoc_Fn(MDOC_ARGS);  
 static  void              pmdoc_Fo(MDOC_ARGS);  
 static  void              pmdoc_Nd(MDOC_ARGS);  
 static  void              pmdoc_Nm(MDOC_ARGS);  
 static  void              pmdoc_Pa(MDOC_ARGS);  
 static  void              pmdoc_St(MDOC_ARGS);  
 static  void              pmdoc_Vt(MDOC_ARGS);  
 static  void              pmdoc_Xr(MDOC_ARGS);  
 static  void              usage(void);  
   
 typedef void            (*pmdoc_nf)(MDOC_ARGS);  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  void     say(const char *, const char *, const char *, ...);
   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  const pmdoc_nf    mdocs[MDOC_MAX] = {  static  char            *progname;
         NULL, /* Ap */  static  int              use_all; /* use all found files */
         NULL, /* Dd */  static  int              nodb; /* no database changes */
         NULL, /* Dt */  static  int              verb; /* print what we're doing */
         NULL, /* Os */  static  int              warnings; /* warn about crap */
         NULL, /* Sh */  static  enum op          op; /* operational mode */
         NULL, /* Ss */  static  struct ohash     inos; /* table of inodes/devices */
         NULL, /* Pp */  static  struct ohash     filenames; /* table of filenames */
         NULL, /* D1 */  static  struct ohash     strings; /* table of all strings */
         NULL, /* Dl */  static  struct of       *ofs = NULL; /* vector of files to parse */
         NULL, /* Bd */  static  struct str      *words = NULL; /* word list in current parse */
         NULL, /* Ed */  static  sqlite3         *db = NULL; /* current database */
         NULL, /* Bl */  static  sqlite3_stmt    *stmts[STMT__MAX]; /* current statements */
         NULL, /* El */  
         NULL, /* It */  static  const struct mdoc_handler mdocs[MDOC_MAX] = {
         NULL, /* Ad */          { NULL, 0, 0 },  /* Ap */
         pmdoc_An, /* An */          { NULL, 0, 0 },  /* Dd */
         NULL, /* Ar */          { NULL, 0, 0 },  /* Dt */
         pmdoc_Cd, /* Cd */          { NULL, 0, 0 },  /* Os */
         NULL, /* Cm */          { parse_mdoc_Sh, TYPE_Sh, MDOCF_CHILD }, /* Sh */
         NULL, /* Dv */          { parse_mdoc_head, TYPE_Ss, MDOCF_CHILD }, /* Ss */
         pmdoc_Er, /* Er */          { NULL, 0, 0 },  /* Pp */
         pmdoc_Ev, /* Ev */          { NULL, 0, 0 },  /* D1 */
         NULL, /* Ex */          { NULL, 0, 0 },  /* Dl */
         NULL, /* Fa */          { NULL, 0, 0 },  /* Bd */
         pmdoc_Fd, /* Fd */          { NULL, 0, 0 },  /* Ed */
         NULL, /* Fl */          { NULL, 0, 0 },  /* Bl */
         pmdoc_Fn, /* Fn */          { NULL, 0, 0 },  /* El */
         NULL, /* Ft */          { NULL, 0, 0 },  /* It */
         NULL, /* Ic */          { NULL, 0, 0 },  /* Ad */
         pmdoc_In, /* In */          { NULL, TYPE_An, MDOCF_CHILD },  /* An */
         NULL, /* Li */          { NULL, TYPE_Ar, MDOCF_CHILD },  /* Ar */
         pmdoc_Nd, /* Nd */          { NULL, TYPE_Cd, MDOCF_CHILD },  /* Cd */
         pmdoc_Nm, /* Nm */          { NULL, TYPE_Cm, MDOCF_CHILD },  /* Cm */
         NULL, /* Op */          { NULL, TYPE_Dv, MDOCF_CHILD },  /* Dv */
         NULL, /* Ot */          { NULL, TYPE_Er, MDOCF_CHILD },  /* Er */
         pmdoc_Pa, /* Pa */          { NULL, TYPE_Ev, MDOCF_CHILD },  /* Ev */
         NULL, /* Rv */          { NULL, 0, 0 },  /* Ex */
         pmdoc_St, /* St */          { NULL, TYPE_Fa, MDOCF_CHILD },  /* Fa */
         pmdoc_Vt, /* Va */          { parse_mdoc_Fd, TYPE_In, 0 },  /* Fd */
         pmdoc_Vt, /* Vt */          { NULL, TYPE_Fl, MDOCF_CHILD },  /* Fl */
         pmdoc_Xr, /* Xr */          { parse_mdoc_Fn, 0, 0 },  /* Fn */
         NULL, /* %A */          { NULL, TYPE_Ft, MDOCF_CHILD },  /* Ft */
         NULL, /* %B */          { NULL, TYPE_Ic, MDOCF_CHILD },  /* Ic */
         NULL, /* %D */          { parse_mdoc_In, TYPE_In, MDOCF_CHILD },  /* In */
         NULL, /* %I */          { NULL, TYPE_Li, MDOCF_CHILD },  /* Li */
         NULL, /* %J */          { parse_mdoc_Nd, TYPE_Nd, MDOCF_CHILD },  /* Nd */
         NULL, /* %N */          { parse_mdoc_Nm, TYPE_Nm, MDOCF_CHILD },  /* Nm */
         NULL, /* %O */          { NULL, 0, 0 },  /* Op */
         NULL, /* %P */          { NULL, 0, 0 },  /* Ot */
         NULL, /* %R */          { NULL, TYPE_Pa, MDOCF_CHILD },  /* Pa */
         NULL, /* %T */          { NULL, 0, 0 },  /* Rv */
         NULL, /* %V */          { parse_mdoc_St, TYPE_St, 0 },  /* St */
         NULL, /* Ac */          { NULL, TYPE_Va, MDOCF_CHILD },  /* Va */
         NULL, /* Ao */          { parse_mdoc_body, TYPE_Va, MDOCF_CHILD },  /* Vt */
         NULL, /* Aq */          { parse_mdoc_Xr, TYPE_Xr, 0 },  /* Xr */
         NULL, /* At */          { NULL, 0, 0 },  /* %A */
         NULL, /* Bc */          { NULL, 0, 0 },  /* %B */
         NULL, /* Bf */          { NULL, 0, 0 },  /* %D */
         NULL, /* Bo */          { NULL, 0, 0 },  /* %I */
         NULL, /* Bq */          { NULL, 0, 0 },  /* %J */
         NULL, /* Bsx */          { NULL, 0, 0 },  /* %N */
         NULL, /* Bx */          { NULL, 0, 0 },  /* %O */
         NULL, /* Db */          { NULL, 0, 0 },  /* %P */
         NULL, /* Dc */          { NULL, 0, 0 },  /* %R */
         NULL, /* Do */          { NULL, 0, 0 },  /* %T */
         NULL, /* Dq */          { NULL, 0, 0 },  /* %V */
         NULL, /* Ec */          { NULL, 0, 0 },  /* Ac */
         NULL, /* Ef */          { NULL, 0, 0 },  /* Ao */
         NULL, /* Em */          { NULL, 0, 0 },  /* Aq */
         NULL, /* Eo */          { NULL, TYPE_At, MDOCF_CHILD },  /* At */
         NULL, /* Fx */          { NULL, 0, 0 },  /* Bc */
         NULL, /* Ms */          { NULL, 0, 0 },  /* Bf */
         NULL, /* No */          { NULL, 0, 0 },  /* Bo */
         NULL, /* Ns */          { NULL, 0, 0 },  /* Bq */
         NULL, /* Nx */          { NULL, TYPE_Bsx, MDOCF_CHILD },  /* Bsx */
         NULL, /* Ox */          { NULL, TYPE_Bx, MDOCF_CHILD },  /* Bx */
         NULL, /* Pc */          { NULL, 0, 0 },  /* Db */
         NULL, /* Pf */          { NULL, 0, 0 },  /* Dc */
         NULL, /* Po */          { NULL, 0, 0 },  /* Do */
         NULL, /* Pq */          { NULL, 0, 0 },  /* Dq */
         NULL, /* Qc */          { NULL, 0, 0 },  /* Ec */
         NULL, /* Ql */          { NULL, 0, 0 },  /* Ef */
         NULL, /* Qo */          { NULL, TYPE_Em, MDOCF_CHILD },  /* Em */
         NULL, /* Qq */          { NULL, 0, 0 },  /* Eo */
         NULL, /* Re */          { NULL, TYPE_Fx, MDOCF_CHILD },  /* Fx */
         NULL, /* Rs */          { NULL, TYPE_Ms, MDOCF_CHILD },  /* Ms */
         NULL, /* Sc */          { NULL, 0, 0 },  /* No */
         NULL, /* So */          { NULL, 0, 0 },  /* Ns */
         NULL, /* Sq */          { NULL, TYPE_Nx, MDOCF_CHILD },  /* Nx */
         NULL, /* Sm */          { NULL, TYPE_Ox, MDOCF_CHILD },  /* Ox */
         NULL, /* Sx */          { NULL, 0, 0 },  /* Pc */
         NULL, /* Sy */          { NULL, 0, 0 },  /* Pf */
         NULL, /* Tn */          { NULL, 0, 0 },  /* Po */
         NULL, /* Ux */          { NULL, 0, 0 },  /* Pq */
         NULL, /* Xc */          { NULL, 0, 0 },  /* Qc */
         NULL, /* Xo */          { NULL, 0, 0 },  /* Ql */
         pmdoc_Fo, /* Fo */          { NULL, 0, 0 },  /* Qo */
         NULL, /* Fc */          { NULL, 0, 0 },  /* Qq */
         NULL, /* Oo */          { NULL, 0, 0 },  /* Re */
         NULL, /* Oc */          { NULL, 0, 0 },  /* Rs */
         NULL, /* Bk */          { NULL, 0, 0 },  /* Sc */
         NULL, /* Ek */          { NULL, 0, 0 },  /* So */
         NULL, /* Bt */          { NULL, 0, 0 },  /* Sq */
         NULL, /* Hf */          { NULL, 0, 0 },  /* Sm */
         NULL, /* Fr */          { NULL, 0, 0 },  /* Sx */
         NULL, /* Ud */          { NULL, TYPE_Sy, MDOCF_CHILD },  /* Sy */
         NULL, /* Lb */          { NULL, TYPE_Tn, MDOCF_CHILD },  /* Tn */
         NULL, /* Lp */          { NULL, 0, 0 },  /* Ux */
         NULL, /* Lk */          { NULL, 0, 0 },  /* Xc */
         NULL, /* Mt */          { NULL, 0, 0 },  /* Xo */
         NULL, /* Brq */          { parse_mdoc_head, TYPE_Fn, 0 },  /* Fo */
         NULL, /* Bro */          { NULL, 0, 0 },  /* Fc */
         NULL, /* Brc */          { NULL, 0, 0 },  /* Oo */
         NULL, /* %C */          { NULL, 0, 0 },  /* Oc */
         NULL, /* Es */          { NULL, 0, 0 },  /* Bk */
         NULL, /* En */          { NULL, 0, 0 },  /* Ek */
         NULL, /* Dx */          { NULL, 0, 0 },  /* Bt */
         NULL, /* %Q */          { NULL, 0, 0 },  /* Hf */
         NULL, /* br */          { NULL, 0, 0 },  /* Fr */
         NULL, /* sp */          { NULL, 0, 0 },  /* Ud */
         NULL, /* %U */          { NULL, TYPE_Lb, MDOCF_CHILD },  /* Lb */
         NULL, /* Ta */          { NULL, 0, 0 },  /* Lp */
           { NULL, TYPE_Lk, MDOCF_CHILD },  /* Lk */
           { NULL, TYPE_Mt, MDOCF_CHILD },  /* Mt */
           { NULL, 0, 0 },  /* Brq */
           { NULL, 0, 0 },  /* Bro */
           { NULL, 0, 0 },  /* Brc */
           { NULL, 0, 0 },  /* %C */
           { NULL, 0, 0 },  /* Es */
           { NULL, 0, 0 },  /* En */
           { NULL, TYPE_Dx, MDOCF_CHILD },  /* Dx */
           { NULL, 0, 0 },  /* %Q */
           { NULL, 0, 0 },  /* br */
           { NULL, 0, 0 },  /* sp */
           { NULL, 0, 0 },  /* %U */
           { NULL, 0, 0 },  /* Ta */
 };  };
   
 static  const char       *progname;  
   
 int  int
 main(int argc, char *argv[])  main(int argc, char *argv[])
 {  {
         struct mparse   *mp; /* parse sequence */          char              cwd[MAXPATHLEN];
         enum op          op; /* current operation */          int               ch, rc, fd, i;
         char             ibuf[MAXPATHLEN], /* index fname */          unsigned int      index;
                          fbuf[MAXPATHLEN];  /* btree fname */          size_t            j, sz;
         int              ch, i, flags;          const char       *dir;
         DB              *idx, /* index database */          struct str       *s;
                         *db, /* keyword database */          struct mchars    *mc;
                         *hash; /* temporary keyword hashtable */          struct manpaths   dirs;
         BTREEINFO        info; /* btree configuration */          struct mparse    *mp;
         recno_t          maxrec; /* supremum of all records */          struct ohash_info ino_info, filename_info, str_info;
         recno_t         *recs; /* buffer of empty records */  
         size_t           recsz, /* buffer size of recs */  
                          reccur; /* valid number of recs */  
         struct buf       buf, /* keyword buffer */  
                          dbuf; /* description buffer */  
         struct of       *of;  
         extern int       optind;  
         extern char     *optarg;  
   
           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], '/');          progname = strrchr(argv[0], '/');
         if (progname == NULL)          if (progname == NULL)
                 progname = argv[0];                  progname = argv[0];
         else          else
                 ++progname;                  ++progname;
   
         of = NULL;          /*
         db = idx = NULL;           * Remember where we started by keeping a fd open to the origin
         mp = NULL;           * path component: throughout this utility, we chdir() a lot to
         hash = NULL;           * handle relative paths, and by doing this, we can return to
         recs = NULL;           * the starting point.
         recsz = reccur = 0;           */
         maxrec = 0;          if (NULL == getcwd(cwd, MAXPATHLEN)) {
         op = OP_NEW;                  perror(NULL);
                   return(EXIT_FAILURE);
           } else if (-1 == (fd = open(cwd, O_RDONLY, 0))) {
                   perror(cwd);
                   return(EXIT_FAILURE);
           }
   
         memset(&buf, 0, sizeof(struct buf));          /*
         memset(&dbuf, 0, sizeof(struct buf));           * 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)
   
         while (-1 != (ch = getopt(argc, argv, "")))          dir = NULL;
           op = OP_DEFAULT;
   
           while (-1 != (ch = getopt(argc, argv, "aC:d:ntu:vW")))
                 switch (ch) {                  switch (ch) {
                   case ('a'):
                           use_all = 1;
                           break;
                   case ('C'):
                           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:                  default:
                         usage();                          goto usage;
                         return((int)MANDOCLEVEL_BADARG);  
                 }                  }
   
         argc -= optind;          argc -= optind;
         argv += optind;          argv += optind;
   
         memset(&info, 0, sizeof(BTREEINFO));          if (OP_CONFFILE == op && argc > 0) {
         info.flags = R_DUP;                  fprintf(stderr, "-C: Too many arguments\n");
                   goto usage;
           }
   
         mp = mparse_alloc(MPARSE_AUTO, MANDOCLEVEL_FATAL, NULL, NULL);          rc = 1;
           mp = mparse_alloc(MPARSE_AUTO,
                   MANDOCLEVEL_FATAL, NULL, NULL, NULL);
           mc = mchars_alloc();
   
         flags = OP_NEW == op ? O_CREAT|O_TRUNC|O_RDWR : O_CREAT|O_RDWR;          ohash_init(&strings, 6, &str_info);
           ohash_init(&inos, 6, &ino_info);
           ohash_init(&filenames, 6, &filename_info);
   
         buf.size = dbuf.size = MANDOC_BUFSZ;          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;
                   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 {
                   /*
                    * 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 (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);
   
         buf.cp = mandoc_malloc(buf.size);                  /*
         dbuf.cp = mandoc_malloc(dbuf.size);                   * 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;
   
         for (i = 0; i < argc; i++) {                          /*
                 ibuf[0] = ibuf[MAXPATHLEN - 2] =                           * Since we're opening up a new database, we can
                         fbuf[0] = fbuf[MAXPATHLEN - 2] = '\0';                           * turn off synchronous mode for much better
                            * performance.
                            */
   #ifndef __APPLE__
                           SQL_EXEC("PRAGMA synchronous = OFF");
   #endif
   
                 strlcat(fbuf, argv[i], MAXPATHLEN);                          if (0 == ofmerge(mc, mp, dirs.paths[j]))
                 strlcat(fbuf, MANDOC_DB, MAXPATHLEN);                                  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:
           close(fd);
           manpath_free(&dirs);
           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);
   
                 strlcat(ibuf, argv[i], MAXPATHLEN);          return(EXIT_FAILURE);
                 strlcat(ibuf, MANDOC_IDX, MAXPATHLEN);  }
   
                 if ('\0' != fbuf[MAXPATHLEN - 2] ||  /*
                                 '\0' != ibuf[MAXPATHLEN - 2]) {   * Scan a directory tree rooted at "base" for manpages.
                         fprintf(stderr, "%s: Path too long\n", argv[i]);   * 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)
   {
           FTS             *f;
           FTSENT          *ff;
           int              dform;
           char            *sec;
           const char      *dsec, *arch, *cp, *name, *path;
           const char      *argv[2];
   
           argv[0] = ".";
           argv[1] = (char *)NULL;
   
           /*
            * 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);
           }
   
           dsec = arch = NULL;
           dform = FORM_NONE;
   
           while (NULL != (ff = fts_read(f))) {
                   path = ff->fts_path + 2;
                   /*
                    * 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 (FTS_F == ff->fts_info) {
                           if ( ! use_all && ff->fts_level < 2) {
                                   if (warnings)
                                           say(base, path, "Extraneous file");
                                   continue;
                           } else if (inocheck(ff->fts_statp)) {
                                   if (warnings)
                                           say(base, path, "Duplicate file");
                                   continue;
                           }
   
                           cp = ff->fts_name;
   
                           if (0 == strcmp(cp, "mandocdb.db")) {
                                   if (warnings)
                                           say(base, path, "Skip database");
                                   continue;
                           } else if (NULL != (cp = strrchr(cp, '.'))) {
                                   if (0 == strcmp(cp + 1, "html")) {
                                           if (warnings)
                                                   say(base, path, "Skip html");
                                           continue;
                                   } else if (0 == strcmp(cp + 1, "gz")) {
                                           if (warnings)
                                                   say(base, path, "Skip gz");
                                           continue;
                                   } else if (0 == strcmp(cp + 1, "ps")) {
                                           if (warnings)
                                                   say(base, path, "Skip ps");
                                           continue;
                                   } else if (0 == strcmp(cp + 1, "pdf")) {
                                           if (warnings)
                                                   say(base, path, "Skip pdf");
                                           continue;
                                   }
                           }
   
                           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;
   
                   switch (ff->fts_level) {
                   case (0):
                           /* Ignore the root directory. */
                         break;                          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;
   
                 db = dbopen(fbuf, flags, 0644, DB_BTREE, &info);                          if (0 == strncmp(cp, "man", 3)) {
                 idx = dbopen(ibuf, flags, 0644, DB_RECNO, NULL);                                  dform = FORM_SRC;
                                   dsec = stradd(cp + 3);
                           } else if (0 == strncmp(cp, "cat", 3)) {
                                   dform = FORM_CAT;
                                   dsec = stradd(cp + 3);
                           }
   
                 if (NULL == db) {                          if (NULL != dsec || use_all)
                         perror(fbuf);                                  break;
   
                           if (warnings)
                                   say(base, path, "Unknown directory part");
                           fts_set(f, ff, FTS_SKIP);
                         break;                          break;
                 } else if (NULL == db) {                  case (2):
                         perror(ibuf);                          /*
                            * 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;                          break;
                   default:
                           if (FTS_DP == ff->fts_info || use_all)
                                   break;
                           if (warnings)
                                   say(base, path, "Extraneous directory part");
                           fts_set(f, ff, FTS_SKIP);
                           break;
                 }                  }
           }
   
                 ofile_free(of);          fts_close(f);
                 of = NULL;          return(1);
   }
   
                 if ( ! ofile_build(argv[i], &of))  /*
                         break;   * Add a file to the file vector.
                 of = of->first;   * 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
   filescan(const char *file, const char *base)
   {
           const char      *sec, *arch, *name, *dsec;
           char            *p, *start, *buf;
           int              dform;
           struct stat      st;
   
                 if (OP_DELETE == op || OP_UPDATE == op)          assert(use_all);
                         index_prune(of, db, fbuf, idx, ibuf,  
                                         &maxrec, &recs, &recsz);  
   
                 if (OP_DELETE == op)          if (0 == strncmp(file, "./", 2))
                         continue;                  file += 2;
   
                 index_merge(of, mp, &dbuf, &buf, hash, db,          if (-1 == stat(file, &st)) {
                                 fbuf, idx, ibuf, maxrec, recs, reccur);                  if (warnings)
                           say(base, file, "%s", strerror(errno));
                   return;
           } else if ( ! (S_IFREG & st.st_mode)) {
                   if (warnings)
                           say(base, file, "Not a regular file");
                   return;
           } else if (inocheck(&st)) {
                   if (warnings)
                           say(base, file, "Duplicate file");
                   return;
         }          }
   
         if (db)          buf = mandoc_strdup(file);
                 (*db->close)(db);          start = buf;
         if (idx)          sec = arch = name = dsec = NULL;
                 (*idx->close)(idx);          dform = FORM_NONE;
         if (hash)  
                 (*hash->close)(hash);  
         if (mp)  
                 mparse_free(mp);  
   
         ofile_free(of);          /*
         free(buf.cp);           * First try to guess our directory structure.
         free(dbuf.cp);           * If we find a separator, try to look for man* or cat*.
         free(recs);           * 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;
                   }
   
         return(i < argc ? MANDOCLEVEL_SYSERR : MANDOCLEVEL_OK);                  start = p;
                   if (NULL != dsec && NULL != (p = strchr(start, '/'))) {
                           *p++ = '\0';
                           arch = start;
                           start = p;
                   }
           }
   
           /*
            * 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. */ ;
   
           if ('.' == *p) {
                   *p++ = '\0';
                   sec = p;
           }
   
           /*
            * 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';
           }
   
           ofadd(base, dform, file, name, dsec, sec, arch, &st);
           free(buf);
 }  }
   
 void  /*
 index_merge(const struct of *of, struct mparse *mp,   * See fileadd().
                 struct buf *dbuf, struct buf *buf,   */
                 DB *hash, DB *db, const char *dbf,  static int
                 DB *idx, const char *idxf,  filecheck(const char *name)
                 recno_t maxrec, const recno_t *recs, size_t reccur)  
 {  {
         recno_t          rec;          unsigned int     index;
         int              ch;  
         DBT              key, val;  
         struct mdoc     *mdoc;  
         struct man      *man;  
         const char      *fn, *msec, *mtitle, *arch;  
         size_t           sv;  
         unsigned         seq;  
         char             vbuf[8];  
   
         for (rec = 0; of; of = of->next) {          index = ohash_qlookup(&filenames, name);
                 fn = of->fname;          return(NULL != ohash_find(&filenames, index));
                 if (reccur > 0) {  }
                         --reccur;  
                         rec = recs[(int)reccur];  
                 } else if (maxrec > 0) {  
                         rec = maxrec;  
                         maxrec = 0;  
                 } else  
                         rec++;  
   
                 mparse_reset(mp);  /*
                 hash_reset(&hash);   * Use the standard hashing mechanism (K&R) to see if the given filename
    * already exists.
    */
   static void
   fileadd(struct of *of)
   {
           unsigned int     index;
   
                 if (mparse_readfd(mp, -1, fn) >= MANDOCLEVEL_FATAL) {          index = ohash_qlookup(&filenames, of->file);
                         fprintf(stderr, "%s: Parse failure\n", fn);          assert(NULL == ohash_find(&filenames, index));
                         continue;          ohash_insert(&filenames, index, of);
                 }  }
   
                 mparse_result(mp, &mdoc, &man);  /*
                 if (NULL == mdoc && NULL == man)   * See inoadd().
                         continue;   */
   static int
   inocheck(const struct stat *st)
   {
           struct id        id;
           uint32_t         hash;
           unsigned int     index;
   
                 msec = NULL != mdoc ?          memset(&id, 0, sizeof(id));
                         mdoc_meta(mdoc)->msec : man_meta(man)->msec;          id.ino = hash = st->st_ino;
                 mtitle = NULL != mdoc ?          id.dev = st->st_dev;
                         mdoc_meta(mdoc)->title : man_meta(man)->title;          index = ohash_lookup_memory
                 arch = NULL != mdoc ?                  (&inos, (char *)&id, sizeof(id), hash);
                         mdoc_meta(mdoc)->arch : NULL;  
   
                 if (NULL == arch)          return(NULL != ohash_find(&inos, index));
                         arch = "";  }
   
                 /*  /*
                  * The index record value consists of a nil-terminated   * The hashing function used here is quite simple: simply take the inode
                  * filename, a nil-terminated manual section, and a   * and use uint32_t of its bits.
                  * nil-terminated description.  Since the description   * Then when we do the lookup, use both the inode and device identifier.
                  * may not be set, we set a sentinel to see if we're   */
                  * going to write a nil byte in its place.  static void
                  */  inoadd(const struct stat *st, struct of *of)
   {
           uint32_t         hash;
           unsigned int     index;
   
                 dbuf->len = 0;          of->id.ino = hash = st->st_ino;
                 buf_appendb(dbuf, fn, strlen(fn) + 1);          of->id.dev = st->st_dev;
                 buf_appendb(dbuf, msec, strlen(msec) + 1);          index = ohash_lookup_memory
                 buf_appendb(dbuf, mtitle, strlen(mtitle) + 1);                  (&inos, (char *)&of->id, sizeof(of->id), hash);
                 buf_appendb(dbuf, arch, strlen(arch) + 1);  
   
                 sv = dbuf->len;          assert(NULL == ohash_find(&inos, index));
           ohash_insert(&inos, index, of);
   }
   
                 /* Fix the record number in the btree value. */  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;
   
                 if (mdoc)          assert(NULL != file);
                         pmdoc_node(hash, buf, dbuf,  
                                 mdoc_node(mdoc), mdoc_meta(mdoc));  
                 else  
                         pman_node(hash, buf, dbuf, man_node(man));  
   
           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;
           }
   
           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);
   }
   
   static void
   offree(void)
   {
           struct of       *of;
   
           while (NULL != (of = ofs)) {
                   ofs = of->next;
                   free(of);
           }
   }
   
   /*
    * 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
   ofmerge(struct mchars *mc, struct mparse *mp, const char *base)
   {
           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;
   
           for (of = ofs; NULL != of; of = of->next) {
                 /*                  /*
                  * Copy from the in-memory hashtable of pending keywords                   * If we're a catpage (as defined by our path), then see
                  * into the database.                   * 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) {
                 memset(vbuf, 0, sizeof(uint32_t));                          sz = strlcpy(buf, of->file, MAXPATHLEN);
                 memcpy(vbuf + 4, &rec, sizeof(uint32_t));                          if (sz >= MAXPATHLEN) {
                                   if (warnings)
                                           say(base, of->file,
                                               "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)) {
                                   if (warnings)
                                           say(base, of->file, "Man "
                                               "source exists: %s", buf);
                                   continue;
                           }
                   }
   
                 seq = R_FIRST;                  words = NULL;
                 while (0 == (ch = (*hash->seq)(hash, &key, &val, seq))) {                  mparse_reset(mp);
                         seq = R_NEXT;                  mdoc = NULL;
                   man = NULL;
                   form = 0;
                   msec = of->dsec;
                   march = of->arch;
                   mtitle = of->name;
   
                         memcpy(vbuf, val.data, sizeof(uint32_t));                  /*
                         val.size = sizeof(vbuf);                   * Try interpreting the file as mdoc(7) or man(7)
                         val.data = vbuf;                   * 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);
                   }
   
                         printf("%s: Added keyword: %s\n",                  if (NULL != mdoc) {
                                         fn, (char *)key.data);                          form = 1;
                         dbt_put(db, dbf, &key, &val);                          msec = mdoc_meta(mdoc)->msec;
                 }                          march = mdoc_meta(mdoc)->arch;
                 if (ch < 0) {                          mtitle = mdoc_meta(mdoc)->title;
                         perror("hash");                  } else if (NULL != man) {
                         exit((int)MANDOCLEVEL_SYSERR);                          form = 1;
                 }                          msec = man_meta(man)->msec;
                           march = "";
                           mtitle = man_meta(man)->title;
                   }
   
                   if (NULL == msec)
                           msec = "";
                   if (NULL == march)
                           march = "";
                   if (NULL == mtitle)
                           mtitle = "";
   
                 /*                  /*
                  * Apply to the index.  If we haven't had a description                   * Check whether the manual section given in a file
                  * set, put an empty one in now.                   * 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 (warnings && !use_all && form &&
                                   strcasecmp(msec, of->dsec))
                           say(base, of->file, "Section \"%s\" "
                                   "manual in %s directory",
                                   msec, of->dsec);
   
                 if (dbuf->len == sv)                  /*
                         buf_appendb(dbuf, "", 1);                   * 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 (warnings && !use_all && strcasecmp(march, of->arch))
                           say(base, of->file, "Architecture \"%s\" "
                                   "manual in \"%s\" directory",
                                   march, of->arch);
   
                 key.data = &rec;                  putkey(of, of->name, TYPE_Nm);
                 key.size = sizeof(recno_t);  
   
                 val.data = dbuf->cp;                  if (NULL != mdoc) {
                 val.size = dbuf->len;                          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);
   
                 printf("%s: Added index\n", fn);                  dbindex(mc, form, of, base);
                 dbt_put(idx, idxf, &key, &val);  
         }          }
   
           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).  
  */  
 static void  static void
 index_prune(const struct of *ofile, DB *db, const char *dbf,  parse_catpage(struct of *of, const char *base)
                 DB *idx, const char *idxf,  
                 recno_t *maxrec, recno_t **recs, size_t *recsz)  
 {  {
         const struct of *of;          FILE            *stream;
         const char      *fn;          char            *line, *p, *title;
         unsigned         seq, sseq;          size_t           len, plen, titlesz;
         DBT              key, val;  
         size_t           reccur;  
         int              ch;  
   
         reccur = 0;          if (NULL == (stream = fopen(of->file, "r"))) {
         seq = R_FIRST;                  if (warnings)
         while (0 == (ch = (*idx->seq)(idx, &key, &val, seq))) {                          say(base, of->file, "%s", strerror(errno));
                 seq = R_NEXT;                  return;
                 *maxrec = *(recno_t *)key.data;          }
                 if (0 == val.size) {  
                         if (reccur >= *recsz) {  
                                 *recsz += MANDOC_SLOP;  
                                 *recs = mandoc_realloc(*recs,  
                                         *recsz * sizeof(recno_t));  
                         }  
                         (*recs)[(int)reccur] = *maxrec;  
                         reccur++;  
                         continue;  
                 }  
   
                 fn = (char *)val.data;          /* Skip to first blank line. */
                 for (of = ofile; of; of = of->next)  
                         if (0 == strcmp(fn, of->fname))  
                                 break;  
   
                 if (NULL == of)          while (NULL != (line = fgetln(stream, &len)))
                         continue;                  if ('\n' == *line)
                           break;
   
                 sseq = R_FIRST;          /*
                 while (0 == (ch = (*db->seq)(db, &key, &val, sseq))) {           * Assume the first line that is not indented
                         sseq = R_NEXT;           * is the first section header.  Skip to it.
                         assert(8 == val.size);           */
                         if (*maxrec != *(recno_t *)(val.data + 4))  
                                 continue;  
                         printf("%s: Deleted keyword: %s\n",  
                                 fn, (char *)key.data);  
                         ch = (*db->del)(db, &key, R_CURSOR);  
                         if (ch < 0)  
                                 break;  
                 }  
                 if (ch < 0) {  
                         perror(dbf);  
                         exit((int)MANDOCLEVEL_SYSERR);  
                 }  
   
                 printf("%s: Deleted index\n", fn);          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.
            */
   
                 val.size = 0;          titlesz = 0;
                 ch = (*idx->put)(idx, &key, &val, R_CURSOR);          title = NULL;
                 if (ch < 0) {  
                         perror(idxf);  
                         exit((int)MANDOCLEVEL_SYSERR);  
                 }  
   
                 if (reccur >= *recsz) {          while (NULL != (line = fgetln(stream, &len))) {
                         *recsz += MANDOC_SLOP;                  if (' ' != *line || '\n' != line[len - 1])
                         *recs = mandoc_realloc                          break;
                                 (*recs, *recsz * sizeof(recno_t));                  while (len > 0 && isspace((unsigned char)*line)) {
                           line++;
                           len--;
                 }                  }
                   if (1 == len)
                           continue;
                   title = mandoc_realloc(title, titlesz + len);
                   memcpy(title + titlesz, line, len);
                   titlesz += len;
                   title[titlesz - 1] = ' ';
           }
   
                 (*recs)[(int)reccur] = *maxrec;          /*
                 reccur++;           * 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 (NULL == title || '\0' == *title) {
                   if (warnings)
                           say(base, of->file, "Cannot find NAME section");
                   fclose(stream);
                   free(title);
                   return;
         }          }
         (*maxrec)++;  
           title = mandoc_realloc(title, titlesz + 1);
           title[titlesz] = '\0';
   
           /*
            * Skip to the first dash.
            * Use the remaining line as the description (no more than 70
            * bytes).
            */
   
           if (NULL != (p = strstr(title, "- "))) {
                   for (p += 2; ' ' == *p || '\b' == *p; p++)
                           /* Skip to next word. */ ;
           } else {
                   if (warnings)
                           say(base, of->file, "No dash in title line");
                   p = title;
           }
   
           plen = strlen(p);
   
           /* Strip backspace-encoding from line. */
   
           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;
           }
   
           of->desc = stradd(p);
           putkey(of, p, TYPE_Nd);
           fclose(stream);
           free(title);
 }  }
   
 /*  /*
  * Grow the buffer (if necessary) and copy in a binary string.   * Put a type/word pair into the word database for this particular file.
  */   */
 static void  static void
 buf_appendb(struct buf *buf, const void *cp, size_t sz)  putkey(const struct of *of, const char *value, uint64_t type)
 {  {
   
         /* Overshoot by MANDOC_BUFSZ. */          assert(NULL != value);
           wordaddbuf(of, value, strlen(value), type);
         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;  
 }  }
   
 /*  /*
  * Append a nil-terminated string to the buffer.   * Like putkey() but for unterminated strings.
  * This can be invoked multiple times.  
  * The buffer string will be nil-terminated.  
  * If invoked multiple times, a space is put between strings.  
  */   */
 static void  static void
 buf_append(struct buf *buf, const char *cp)  putkeys(const struct of *of, const char *value, int sz, uint64_t type)
 {  {
         size_t           sz;  
   
         if (0 == (sz = strlen(cp)))          wordaddbuf(of, value, sz, type);
                 return;  
   
         if (buf->len)  
                 buf->cp[(int)buf->len - 1] = ' ';  
   
         buf_appendb(buf, cp, sz + 1);  
 }  }
   
 /*  /*
  * Recursively add all text from a given node.   * Grok all nodes at or below a certain mdoc node into putkey().
  * 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.  
  */   */
 static void  static void
 buf_appendmdoc(struct buf *buf, const struct mdoc_node *n, int f)  putmdockey(const struct of *of, const struct mdoc_node *n, uint64_t m)
 {  {
   
         for ( ; n; n = n->next) {          for ( ; NULL != n; n = n->next) {
                 if (n->child)                  if (NULL != n->child)
                         buf_appendmdoc(buf, n->child, f);                          putmdockey(of, n->child, m);
                   if (MDOC_TEXT == n->type)
                 if (MDOC_TEXT == n->type && f) {                          putkey(of, n->string, m);
                         f = 0;  
                         buf_appendb(buf, n->string,  
                                         strlen(n->string) + 1);  
                 } else if (MDOC_TEXT == n->type)  
                         buf_append(buf, n->string);  
   
         }          }
 }  }
   
 /* ARGSUSED */  static int
 static void  parse_man(struct of *of, const struct man_node *n)
 pmdoc_An(MDOC_ARGS)  
 {  {
           const struct man_node *head, *body;
         if (SEC_AUTHORS != n->sec)          char            *start, *sv, *title;
                 return;          char             byte;
           size_t           sz, titlesz;
   
         buf_appendmdoc(buf, n->child, 0);          if (NULL == n)
         hash_put(hash, buf, TYPE_AUTHOR);                  return(0);
   
           /*
            * We're only searching for one thing: the first text child in
            * the BODY of a NAME section.  Since we don't keep track of
            * sections in -man, run some hoops to find out whether we're in
            * the correct section or not.
            */
   
           if (MAN_BODY == n->type && MAN_SH == n->tok) {
                   body = n;
                   assert(body->parent);
                   if (NULL != (head = body->parent->head) &&
                                   1 == head->nchild &&
                                   NULL != (head = (head->child)) &&
                                   MAN_TEXT == head->type &&
                                   0 == strcmp(head->string, "NAME") &&
                                   NULL != (body = body->child) &&
                                   MAN_TEXT == body->type) {
   
                           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.
                            * Conventionally, one or more manual names are
                            * comma-specified prior to a whitespace, then a
                            * dash, then a description.  Try to puzzle out
                            * the name parts here.
                            */
   
                           for ( ;; ) {
                                   sz = strcspn(start, " ,");
                                   if ('\0' == start[sz])
                                           break;
   
                                   byte = start[sz];
                                   start[sz] = '\0';
   
                                   putkey(of, start, TYPE_Nm);
   
                                   if (' ' == byte) {
                                           start += sz + 1;
                                           break;
                                   }
   
                                   assert(',' == byte);
                                   start += sz + 1;
                                   while (' ' == *start)
                                           start++;
                           }
   
                           if (sv == start) {
                                   putkey(of, start, TYPE_Nm);
                                   free(title);
                                   return(1);
                           }
   
                           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))
                                   start += 4;
                           else if (0 == strncmp(start, "\\(em", 4))
                                   start += 4;
   
                           while (' ' == *start)
                                   start++;
   
                           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 (parse_man(of, n))
                           return(1);
   
           return(0);
 }  }
   
 static void  static void
 hash_reset(DB **db)  parse_mdoc(struct of *of, const struct mdoc_node *n)
 {  {
         DB              *hash;  
   
         if (NULL != (hash = *db))          assert(NULL != n);
                 (*hash->close)(hash);          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;
   
         *db = dbopen(NULL, MANDOC_FLAGS, 0644, DB_HASH, NULL);                          if (MDOCF_CHILD & mdocs[n->tok].flags)
         if (NULL == *db) {                                  putmdockey(of, n->child, mdocs[n->tok].mask);
                 perror("hash");                          break;
                 exit((int)MANDOCLEVEL_SYSERR);                  default:
                           assert(MDOC_ROOT != n->type);
                           continue;
                   }
                   if (NULL != n->child)
                           parse_mdoc(of, n);
         }          }
 }  }
   
 /* ARGSUSED */  static int
 static void  parse_mdoc_Fd(struct of *of, const struct mdoc_node *n)
 pmdoc_Fd(MDOC_ARGS)  
 {  {
         const char      *start, *end;          const char      *start, *end;
         size_t           sz;          size_t           sz;
   
         if (SEC_SYNOPSIS != n->sec)  
                 return;  
         if (NULL == (n = n->child) || MDOC_TEXT != n->type)  
                 return;  
   
           if (SEC_SYNOPSIS != n->sec ||
                           NULL == (n = n->child) ||
                           MDOC_TEXT != n->type)
                   return(0);
   
         /*          /*
          * Only consider those `Fd' macro fields that begin with an           * Only consider those `Fd' macro fields that begin with an
          * "inclusion" token (versus, e.g., #define).           * "inclusion" token (versus, e.g., #define).
          */           */
   
         if (strcmp("#include", n->string))          if (strcmp("#include", n->string))
                 return;                  return(0);
   
         if (NULL == (n = n->next) || MDOC_TEXT != n->type)          if (NULL == (n = n->next) || MDOC_TEXT != n->type)
                 return;                  return(0);
   
         /*          /*
          * Strip away the enclosing angle brackets and make sure we're           * Strip away the enclosing angle brackets and make sure we're
Line 704  pmdoc_Fd(MDOC_ARGS)
Line 1399  pmdoc_Fd(MDOC_ARGS)
                 start++;                  start++;
   
         if (0 == (sz = strlen(start)))          if (0 == (sz = strlen(start)))
                 return;                  return(0);
   
         end = &start[(int)sz - 1];          end = &start[(int)sz - 1];
         if ('>' == *end || '"' == *end)          if ('>' == *end || '"' == *end)
                 end--;                  end--;
   
         assert(end >= start);          if (end > start)
                   putkeys(of, start, end - start + 1, TYPE_In);
         buf_appendb(buf, start, (size_t)(end - start + 1));          return(1);
         buf_appendb(buf, "", 1);  
   
         hash_put(hash, buf, TYPE_INCLUDES);  
 }  }
   
 /* ARGSUSED */  static int
 static void  parse_mdoc_In(struct of *of, const struct mdoc_node *n)
 pmdoc_Cd(MDOC_ARGS)  
 {  {
   
         if (SEC_SYNOPSIS != n->sec)  
                 return;  
   
         buf_appendmdoc(buf, n->child, 0);          if (NULL != n->child && MDOC_TEXT == n->child->type)
         hash_put(hash, buf, TYPE_CONFIG);                  return(0);
 }  
   
 /* ARGSUSED */          putkey(of, n->child->string, TYPE_In);
 static void          return(1);
 pmdoc_In(MDOC_ARGS)  
 {  
   
         if (SEC_SYNOPSIS != n->sec)  
                 return;  
         if (NULL == n->child || MDOC_TEXT != n->child->type)  
                 return;  
   
         buf_append(buf, n->child->string);  
         hash_put(hash, buf, TYPE_INCLUDES);  
 }  }
   
 /* ARGSUSED */  static int
 static void  parse_mdoc_Fn(struct of *of, const struct mdoc_node *n)
 pmdoc_Fn(MDOC_ARGS)  
 {  {
         const char      *cp;          const char      *cp;
   
         if (SEC_SYNOPSIS != n->sec)  
                 return;  
         if (NULL == n->child || MDOC_TEXT != n->child->type)  
                 return;  
   
         /* .Fn "struct type *arg" "foo" */          if (NULL == (n = n->child) || MDOC_TEXT != n->type)
                   return(0);
   
         cp = strrchr(n->child->string, ' ');          /*
         if (NULL == cp)           * Parse: .Fn "struct type *name" "char *arg".
                 cp = n->child->string;           * First strip away pointer symbol.
            * Then store the function name, then type.
            * Finally, store the arguments.
            */
   
         /* Strip away pointer symbol. */          if (NULL == (cp = strrchr(n->string, ' ')))
                   cp = n->string;
   
         while ('*' == *cp)          while ('*' == *cp)
                 cp++;                  cp++;
   
         buf_append(buf, cp);          putkey(of, cp, TYPE_Fn);
         hash_put(hash, buf, TYPE_FUNCTION);  
           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);
 }  }
   
 /* ARGSUSED */  static int
 static void  parse_mdoc_St(struct of *of, const struct mdoc_node *n)
 pmdoc_St(MDOC_ARGS)  
 {  {
   
         if (SEC_STANDARDS != n->sec)  
                 return;  
         if (NULL == n->child || MDOC_TEXT != n->child->type)          if (NULL == n->child || MDOC_TEXT != n->child->type)
                 return;                  return(0);
   
         buf_append(buf, n->child->string);          putkey(of, n->child->string, TYPE_St);
         hash_put(hash, buf, TYPE_STANDARD);          return(1);
 }  }
   
 /* ARGSUSED */  static int
 static void  parse_mdoc_Xr(struct of *of, const struct mdoc_node *n)
 pmdoc_Xr(MDOC_ARGS)  
 {  {
   
         if (NULL == (n = n->child))          if (NULL == (n = n->child))
                 return;                  return(0);
   
         buf_appendb(buf, n->string, strlen(n->string));          putkey(of, n->string, TYPE_Xr);
           return(1);
         if (NULL != (n = n->next)) {  
                 buf_appendb(buf, ".", 1);  
                 buf_appendb(buf, n->string, strlen(n->string) + 1);  
         } else  
                 buf_appendb(buf, ".", 2);  
   
         hash_put(hash, buf, TYPE_XREF);  
 }  }
   
 /* ARGSUSED */  static int
 static void  parse_mdoc_Nd(struct of *of, const struct mdoc_node *n)
 pmdoc_Vt(MDOC_ARGS)  
 {  {
         const char      *start;  
         size_t           sz;          size_t           sz;
           char            *sv, *desc;
         if (SEC_SYNOPSIS != n->sec)  
                 return;  
         if (MDOC_Vt == n->tok && MDOC_BODY != n->type)  
                 return;  
         if (NULL == n->last || MDOC_TEXT != n->last->type)  
                 return;  
   
           if (MDOC_BODY != n->type)
                   return(0);
   
         /*          /*
          * Strip away leading pointer symbol '*' and trailing ';'.           * Special-case the `Nd' because we need to put the description
            * into the document table.
          */           */
   
         start = n->last->string;          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);
           }
   
         while ('*' == *start)          of->desc = NULL != desc ? stradd(desc) : NULL;
                 start++;          free(desc);
           return(1);
   }
   
         if (0 == (sz = strlen(start)))  static int
                 return;  parse_mdoc_Nm(struct of *of, const struct mdoc_node *n)
   {
   
         if (';' == start[(int)sz - 1])          if (SEC_NAME == n->sec)
                 sz--;                  return(1);
           else if (SEC_SYNOPSIS != n->sec || MDOC_HEAD != n->type)
                   return(0);
   
         if (0 == sz)          return(1);
                 return;  
   
         buf_appendb(buf, start, sz);  
         buf_appendb(buf, "", 1);  
         hash_put(hash, buf, TYPE_VARIABLE);  
 }  }
   
 /* ARGSUSED */  static int
 static void  parse_mdoc_Sh(struct of *of, const struct mdoc_node *n)
 pmdoc_Fo(MDOC_ARGS)  
 {  {
   
         if (SEC_SYNOPSIS != n->sec || MDOC_HEAD != n->type)  
                 return;  
         if (NULL == n->child || MDOC_TEXT != n->child->type)  
                 return;  
   
         buf_append(buf, n->child->string);          return(SEC_CUSTOM == n->sec && MDOC_HEAD == n->type);
         hash_put(hash, buf, TYPE_FUNCTION);  
 }  }
   
   static int
 /* ARGSUSED */  parse_mdoc_head(struct of *of, const struct mdoc_node *n)
 static void  
 pmdoc_Nd(MDOC_ARGS)  
 {  {
   
         if (MDOC_BODY != n->type)          return(MDOC_HEAD == n->type);
                 return;  
   
         buf_appendmdoc(dbuf, n->child, 1);  
         buf_appendmdoc(buf, n->child, 0);  
   
         hash_put(hash, buf, TYPE_DESC);  
 }  }
   
 /* ARGSUSED */  static int
 static void  parse_mdoc_body(struct of *of, const struct mdoc_node *n)
 pmdoc_Er(MDOC_ARGS)  
 {  {
   
         if (SEC_ERRORS != n->sec)          return(MDOC_BODY == n->type);
                 return;  
   
         buf_appendmdoc(buf, n->child, 0);  
         hash_put(hash, buf, TYPE_ERR);  
 }  }
   
 /* ARGSUSED */  /*
 static void   * See straddbuf().
 pmdoc_Ev(MDOC_ARGS)   */
   static char *
   stradd(const char *cp)
 {  {
   
         if (SEC_ENVIRONMENT != n->sec)          return(straddbuf(cp, strlen(cp)));
                 return;  
   
         buf_appendmdoc(buf, n->child, 0);  
         hash_put(hash, buf, TYPE_ENV);  
 }  }
   
 /* ARGSUSED */  /*
 static void   * This looks up or adds a string to the string table.
 pmdoc_Pa(MDOC_ARGS)   * 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 (SEC_FILES != n->sec)          if (NULL != (s = hashget(cp, sz)))
                 return;                  return(s->key);
   
         buf_appendmdoc(buf, n->child, 0);          s = mandoc_calloc(sizeof(struct str) + sz + 1, 1);
         hash_put(hash, buf, TYPE_PATH);          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);
 }  }
   
 /* ARGSUSED */  static struct str *
 static void  hashget(const char *cp, size_t sz)
 pmdoc_Nm(MDOC_ARGS)  
 {  {
           unsigned int     index;
         if (SEC_NAME == n->sec) {          const char      *end;
                 buf_appendmdoc(buf, n->child, 0);  
                 hash_put(hash, buf, TYPE_NAME);  
                 return;  
         } else if (SEC_SYNOPSIS != n->sec || MDOC_HEAD != n->type)  
                 return;  
   
         if (NULL == n->child)          end = cp + sz;
                 buf_append(buf, m->name);          index = ohash_qlookupi(&strings, cp, &end);
           return(ohash_find(&strings, index));
         buf_appendmdoc(buf, n->child, 0);  
         hash_put(hash, buf, TYPE_UTILITY);  
 }  }
   
   /*
    * 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  static void
 hash_put(DB *db, const struct buf *buf, int mask)  wordaddbuf(const struct of *of,
                   const char *cp, size_t sz, uint64_t v)
 {  {
         DBT              key, val;          struct str      *s;
         int              rc;          unsigned int     index;
           const char      *end;
   
         if (buf->len < 2)          if (0 == sz)
                 return;                  return;
   
         key.data = buf->cp;          s = hashget(cp, sz);
         key.size = buf->len;  
   
         if ((rc = (*db->get)(db, &key, &val, 0)) < 0) {          if (NULL != s && of == s->of) {
                 perror("hash");                  s->mask |= v;
                 exit((int)MANDOCLEVEL_SYSERR);                  return;
         } else if (0 == rc)          } else if (NULL == s) {
                 mask |= *(int *)val.data;                  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);
           }
   
         val.data = &mask;          s->next = words;
         val.size = sizeof(int);          s->of = of;
           s->mask = v;
         if ((rc = (*db->put)(db, &key, &val, 0)) < 0) {          words = s;
                 perror("hash");  
                 exit((int)MANDOCLEVEL_SYSERR);  
         }  
 }  }
   
 static void  /*
 dbt_put(DB *db, const char *dbn, DBT *key, DBT *val)   * 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;
   
         assert(key->size);          rc = 0;
         assert(val->size);          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);
   
         if (0 == (*db->put)(db, key, val, 0))          out[rc] = '\0';
                 return;          return(rc);
   
         perror(dbn);  
         exit((int)MANDOCLEVEL_SYSERR);  
         /* NOTREACHED */  
 }  }
   
 /*  /*
  * Call out to per-macro handlers after clearing the persistent database   * Store the UTF-8 version of a key, or alias the pointer if the key has
  * key.  If the macro sets the database key, flush it to the database.   * no UTF-8 transcription marks in it.
  */   */
 static void  static void
 pmdoc_node(MDOC_ARGS)  utf8key(struct mchars *mc, struct str *key)
 {  {
           size_t           sz, bsz, pos;
           char             utfbuf[7], res[5];
           char            *buf;
           const char      *seq, *cpp, *val;
           int              len, u;
           enum mandoc_esc  esc;
   
         if (NULL == n)          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;                  return;
           }
   
         switch (n->type) {          /* Pre-allocate by the length of the input */
         case (MDOC_HEAD):  
                 /* FALLTHROUGH */          buf = mandoc_malloc(++bsz);
         case (MDOC_BODY):          pos = 0;
                 /* FALLTHROUGH */  
         case (MDOC_TAIL):          while ('\0' != *val) {
                 /* FALLTHROUGH */                  /*
         case (MDOC_BLOCK):                   * Halt on the first escape sequence.
                 /* FALLTHROUGH */                   * This also halts on the end of string, in which case
         case (MDOC_ELEM):                   * we just copy, fallthrough, and exit the loop.
                 if (NULL == mdocs[n->tok])                   */
                   if ((sz = strcspn(val, res)) > 0) {
                           memcpy(&buf[pos], val, sz);
                           pos += sz;
                           val += sz;
                   }
   
                   if (ASCII_HYPH == *val) {
                           buf[pos++] = '-';
                           val++;
                           continue;
                   } else if ('\t' == *val || ASCII_NBRSP == *val) {
                           buf[pos++] = ' ';
                           val++;
                           continue;
                   } else if ('\\' != *val)
                         break;                          break;
   
                 buf->len = 0;                  /* Read past the slash. */
                 (*mdocs[n->tok])(hash, buf, dbuf, n, m);  
                 break;  
         default:  
                 break;  
         }  
   
         pmdoc_node(hash, buf, dbuf, n->child, m);                  val++;
         pmdoc_node(hash, buf, dbuf, n->next, m);                  u = 0;
 }  
   
 static int                  /*
 pman_node(MAN_ARGS)                   * Parse the escape sequence and see if it's a
 {                   * predefined character or special character.
         const struct man_node *head, *body;                   */
         const char      *start, *sv;                  esc = mandoc_escape
         size_t           sz;                          ((const char **)&val, &seq, &len);
                   if (ESCAPE_ERROR == esc)
                           break;
   
         if (NULL == n)                  if (ESCAPE_SPECIAL != esc)
                 return(0);                          continue;
                   if (0 == (u = mchars_spec2cp(mc, seq, len)))
                           continue;
   
         /*                  /*
          * We're only searching for one thing: the first text child in                   * If we have a Unicode codepoint, try to convert that
          * the BODY of a NAME section.  Since we don't keep track of                   * to a UTF-8 byte string.
          * sections in -man, run some hoops to find out whether we're in                   */
          * the correct section or not.                  cpp = utfbuf;
          */                  if (0 == (sz = utf8(u, utfbuf)))
                           continue;
   
         if (MAN_BODY == n->type && MAN_SH == n->tok) {                  /* Copy the rendered glyph into the stream. */
                 body = n;  
                 assert(body->parent);  
                 if (NULL != (head = body->parent->head) &&  
                                 1 == head->nchild &&  
                                 NULL != (head = (head->child)) &&  
                                 MAN_TEXT == head->type &&  
                                 0 == strcmp(head->string, "NAME") &&  
                                 NULL != (body = body->child) &&  
                                 MAN_TEXT == body->type) {  
   
                         assert(body->string);                  sz = strlen(cpp);
                         start = sv = body->string;                  bsz += sz;
   
                         /*                  buf = mandoc_realloc(buf, bsz);
                          * 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  
                          * the name parts here.  
                          */  
   
                         for ( ;; ) {                  memcpy(&buf[pos], cpp, sz);
                                 sz = strcspn(start, " ,");                  pos += sz;
                                 if ('\0' == start[(int)sz])          }
                                         break;  
   
                                 buf->len = 0;          buf[pos] = '\0';
                                 buf_appendb(buf, start, sz);          key->utf8 = buf;
                                 buf_appendb(buf, "", 1);  }
   
                                 hash_put(hash, buf, TYPE_NAME);  /*
    * 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
   dbindex(struct mchars *mc, int form,
                   const struct of *of, const char *base)
   {
           struct str      *key;
           const char      *desc;
           int64_t          recno;
           size_t           i;
   
                                 if (' ' == start[(int)sz]) {          if (verb)
                                         start += (int)sz + 1;                  say(base, of->file, "Adding to index");
                                         break;  
                                 }  
   
                                 assert(',' == start[(int)sz]);          if (nodb)
                                 start += (int)sz + 1;                  return;
                                 while (' ' == *start)  
                                         start++;  
                         }  
   
                         buf->len = 0;          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;
           }
   
                         if (sv == start) {          SQL_EXEC("BEGIN TRANSACTION");
                                 buf_append(buf, start);  
                                 return(1);  
                         }  
   
                         while (' ' == *start)          i = 1;
                                 start++;          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]);
   
                         if (0 == strncmp(start, "-", 1))          for (key = words; NULL != key; key = key->next) {
                                 start += 1;                  assert(key->of == of);
                         else if (0 == strncmp(start, "\\-", 2))                  if (NULL == key->utf8)
                                 start += 2;                          utf8key(mc, key);
                         else if (0 == strncmp(start, "\\(en", 4))                  i = 1;
                                 start += 4;                  SQL_BIND_INT64(stmts[STMT_INSERT_KEY], i, key->mask);
                         else if (0 == strncmp(start, "\\(em", 4))                  SQL_BIND_TEXT(stmts[STMT_INSERT_KEY], i, key->utf8);
                                 start += 4;                  SQL_BIND_INT64(stmts[STMT_INSERT_KEY], i, recno);
                   SQL_STEP(stmts[STMT_INSERT_KEY]);
                   sqlite3_reset(stmts[STMT_INSERT_KEY]);
           }
   
                         while (' ' == *start)          SQL_EXEC("END TRANSACTION");
                                 start++;  }
   
                         sz = strlen(start) + 1;  static void
                         buf_appendb(dbuf, start, sz);  dbprune(const char *base)
                         buf_appendb(buf, start, sz);  {
           struct of       *of;
           size_t           i;
   
                         hash_put(hash, buf, TYPE_DESC);          if (nodb)
                 }                  return;
   
           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]);
                   if (verb)
                           say(base, of->file, "Deleted from index");
         }          }
   }
   
         if (pman_node(hash, buf, dbuf, n->child))  /*
                 return(1);   * Close an existing database and its prepared statements.
         if (pman_node(hash, buf, dbuf, n->next))   * If "real" is not set, rename the temporary file into the real one.
                 return(1);   */
   static void
   dbclose(const char *base, int real)
   {
           size_t           i;
           char             file[MAXPATHLEN];
   
         return(0);          if (nodb)
                   return;
   
           for (i = 0; i < STMT__MAX; i++) {
                   sqlite3_finalize(stmts[i]);
                   stmts[i] = NULL;
           }
   
           sqlite3_close(db);
           db = NULL;
   
           if (real)
                   return;
   
           strlcpy(file, MANDOC_DB, MAXPATHLEN);
           strlcat(file, "~", MAXPATHLEN);
           if (-1 == rename(file, MANDOC_DB))
                   perror(MANDOC_DB);
 }  }
   
 /*  /*
  * Recursively build up a list of files to parse.   * This is straightforward stuff.
  * We use this instead of ftw() and so on because I don't want global   * Open a database connection to a "temporary" database, then open a set
  * variables hanging around.   * of prepared statements we'll use over and over again.
  * This ignores the mandoc.db and mandoc.index files, but assumes that   * If "real" is set, we use the existing database; if not, we truncate a
  * everything else is a manual.   * temporary one.
  * Pass in a pointer to a NULL structure for the first invocation.   * Must be matched by dbclose().
  */   */
 static int  static int
 ofile_build(const char *dir, struct of **of)  dbopen(const char *base, int real)
 {  {
         DIR             *d;          char             file[MAXPATHLEN];
         const char      *fn;          const char      *sql;
         struct of       *nof;          int              rc, ofl;
         struct dirent   *dp;          size_t           sz;
   
         if (NULL == (d = opendir(dir))) {          if (nodb)
                 perror(dir);                  return(1);
   
           sz = strlcpy(file, MANDOC_DB, MAXPATHLEN);
           if ( ! real)
                   sz = strlcat(file, "~", MAXPATHLEN);
   
           if (sz >= MAXPATHLEN) {
                   fprintf(stderr, "%s: Path too long\n", file);
                 return(0);                  return(0);
         }          }
   
         while (NULL != (dp = readdir(d))) {          if ( ! real)
                 fn = dp->d_name;                  remove(file);
                 if (DT_DIR == dp->d_type) {  
                         if (strcmp(".", fn) && strcmp("..", fn))  
                                 if ( ! ofile_build(dp->d_name, of))  
                                         return(0);  
                         continue;  
                 } else if (DT_REG != dp->d_type)  
                         continue;  
   
                 if (0 == strcmp(MANDOC_DB, fn) ||          ofl = SQLITE_OPEN_READWRITE |
                                 0 == strcmp(MANDOC_IDX, fn))                  (0 == real ? SQLITE_OPEN_EXCLUSIVE : 0);
                         continue;  
   
                 nof = mandoc_calloc(1, sizeof(struct of));          rc = sqlite3_open_v2(file, &db, ofl, NULL);
                 nof->fname = mandoc_strdup(fn);          if (SQLITE_OK == rc)
                   return(1);
           if (SQLITE_CANTOPEN != rc) {
                   perror(file);
                   return(0);
           }
   
                 if (NULL == *of) {          sqlite3_close(db);
                         *of = nof;          db = NULL;
                         (*of)->first = nof;  
                 } else {          if (SQLITE_OK != (rc = sqlite3_open(file, &db))) {
                         (*of)->next = nof;                  perror(file);
                         *of = nof;                  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);
           }
   
           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);          return(1);
 }  }
   
   static void *
   hash_halloc(size_t sz, void *arg)
   {
   
           return(mandoc_calloc(sz, 1));
   }
   
   static void *
   hash_alloc(size_t sz, void *arg)
   {
   
           return(mandoc_malloc(sz));
   }
   
 static void  static void
 ofile_free(struct of *of)  hash_free(void *p, size_t sz, void *arg)
 {  {
         struct of       *nof;  
   
         while (of) {          free(p);
                 nof = of->next;  }
                 free(of->fname);  
                 free(of);  static int
                 of = nof;  path_reset(const char *cwd, int fd, const char *base)
   {
   
           if (-1 == fchdir(fd)) {
                   perror(cwd);
                   return(0);
           } else if (-1 == chdir(base)) {
                   perror(base);
                   return(0);
         }          }
           return(1);
 }  }
   
 static void  static void
 usage(void)  say(const char *dir, const char *file, const char *format, ...)
 {  {
           va_list          ap;
   
         fprintf(stderr, "usage: %s [dir...]\n", progname);          fprintf(stderr, "%s", dir);
           if ('\0' != *file)
                   fprintf(stderr, "//%s", file);
           fputs(": ", stderr);
   
           va_start(ap, format);
           vfprintf(stderr, format, ap);
           va_end(ap);
   
           fputc('\n', stderr);
 }  }
Legend:
Removed from v.1.4  
changed lines
  Added in v.1.56
CVSweb