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

Diff for /mandoc/mandocdb.c between version 1.2 and 1.103

version 1.2, 2011/07/14 14:36:37 version 1.103, 2014/01/06 03:02:46
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, 2014 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 18 
Line 19 
 #include "config.h"  #include "config.h"
 #endif  #endif
   
 #include <sys/param.h>  #include <sys/stat.h>
   
 #include <assert.h>  #include <assert.h>
   #include <ctype.h>
   #include <errno.h>
 #include <fcntl.h>  #include <fcntl.h>
   #include <fts.h>
 #include <getopt.h>  #include <getopt.h>
   #include <limits.h>
   #include <stddef.h>
 #include <stdio.h>  #include <stdio.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_NONE,  /* format is unknown */
 #define TYPE_UTILITY      0x04          FORM_SRC,   /* format is -man or -mdoc */
 #define TYPE_INCLUDES     0x08          FORM_CAT    /* format is cat */
 #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  
   
 /* Buffer for storing growable data. */  struct  str {
           char            *rendered; /* key in UTF-8 or ASCII form */
           const struct mpage *mpage; /* if set, the owning parse */
           uint64_t         mask; /* bitmask in sequence */
           char             key[]; /* may contain escape sequences */
   };
   
 struct  buf {  struct  inodev {
         char             *cp;          ino_t            st_ino;
         size_t            len;          dev_t            st_dev;
         size_t            size;  
 };  };
   
 /* Operation we're going to perform. */  struct  mpage {
           struct inodev    inodev;  /* used for hashing routine */
           enum form        form;    /* format from file content */
           char            *sec;     /* section from file content */
           char            *arch;    /* architecture from file content */
           char            *title;   /* title from file content */
           char            *desc;    /* description from file content */
           struct mlink    *mlinks;  /* singly linked list */
   };
   
 enum    op {  struct  mlink {
         OP_NEW = 0, /* new database */          char             file[PATH_MAX]; /* filename rel. to manpath */
         OP_UPDATE, /* update entries in existing database */          enum form        dform;   /* format from directory */
         OP_DELETE /* delete entries from existing database */          enum form        fform;   /* format from file name suffix */
           char            *dsec;    /* section from directory */
           char            *arch;    /* architecture from directory */
           char            *name;    /* name from file name (not empty) */
           char            *fsec;    /* section from file name suffix */
           struct mlink    *next;    /* singly linked list */
 };  };
   
 #define MAN_ARGS          DB *hash, \  enum    stmt {
                           struct buf *buf, \          STMT_DELETE_PAGE = 0,   /* delete mpage */
                           struct buf *dbuf, \          STMT_INSERT_PAGE,       /* insert mpage */
                           const struct man_node *n          STMT_INSERT_LINK,       /* insert mlink */
 #define MDOC_ARGS         DB *hash, \          STMT_INSERT_KEY,        /* insert parsed key */
                           struct buf *buf, \          STMT__MAX
                           struct buf *dbuf, \  };
                           const struct mdoc_node *n, \  
                           const struct mdoc_meta *m  
   
 static  void              buf_appendmdoc(struct buf *,  typedef int (*mdoc_fp)(struct mpage *, const struct mdoc_node *);
                                 const struct mdoc_node *, int);  
 static  void              buf_append(struct buf *, const char *);  
 static  void              buf_appendb(struct buf *,  
                                 const void *, size_t);  
 static  void              dbt_put(DB *, const char *, DBT *, DBT *);  
 static  void              hash_put(DB *, const struct buf *, int);  
 static  void              hash_reset(DB **);  
 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);  struct  mdoc_handler {
           mdoc_fp          fp; /* optional handler */
 static  const pmdoc_nf    mdocs[MDOC_MAX] = {          uint64_t         mask;  /* set unless handler returns 0 */
         NULL, /* Ap */  
         NULL, /* Dd */  
         NULL, /* Dt */  
         NULL, /* Os */  
         NULL, /* Sh */  
         NULL, /* Ss */  
         NULL, /* Pp */  
         NULL, /* D1 */  
         NULL, /* Dl */  
         NULL, /* Bd */  
         NULL, /* Ed */  
         NULL, /* Bl */  
         NULL, /* El */  
         NULL, /* It */  
         NULL, /* Ad */  
         pmdoc_An, /* An */  
         NULL, /* Ar */  
         pmdoc_Cd, /* Cd */  
         NULL, /* Cm */  
         NULL, /* Dv */  
         pmdoc_Er, /* Er */  
         pmdoc_Ev, /* Ev */  
         NULL, /* Ex */  
         NULL, /* Fa */  
         pmdoc_Fd, /* Fd */  
         NULL, /* Fl */  
         pmdoc_Fn, /* Fn */  
         NULL, /* Ft */  
         NULL, /* Ic */  
         pmdoc_In, /* In */  
         NULL, /* Li */  
         pmdoc_Nd, /* Nd */  
         pmdoc_Nm, /* Nm */  
         NULL, /* Op */  
         NULL, /* Ot */  
         pmdoc_Pa, /* Pa */  
         NULL, /* Rv */  
         pmdoc_St, /* St */  
         pmdoc_Vt, /* Va */  
         pmdoc_Vt, /* Vt */  
         pmdoc_Xr, /* Xr */  
         NULL, /* %A */  
         NULL, /* %B */  
         NULL, /* %D */  
         NULL, /* %I */  
         NULL, /* %J */  
         NULL, /* %N */  
         NULL, /* %O */  
         NULL, /* %P */  
         NULL, /* %R */  
         NULL, /* %T */  
         NULL, /* %V */  
         NULL, /* Ac */  
         NULL, /* Ao */  
         NULL, /* Aq */  
         NULL, /* At */  
         NULL, /* Bc */  
         NULL, /* Bf */  
         NULL, /* Bo */  
         NULL, /* Bq */  
         NULL, /* Bsx */  
         NULL, /* Bx */  
         NULL, /* Db */  
         NULL, /* Dc */  
         NULL, /* Do */  
         NULL, /* Dq */  
         NULL, /* Ec */  
         NULL, /* Ef */  
         NULL, /* Em */  
         NULL, /* Eo */  
         NULL, /* Fx */  
         NULL, /* Ms */  
         NULL, /* No */  
         NULL, /* Ns */  
         NULL, /* Nx */  
         NULL, /* Ox */  
         NULL, /* Pc */  
         NULL, /* Pf */  
         NULL, /* Po */  
         NULL, /* Pq */  
         NULL, /* Qc */  
         NULL, /* Ql */  
         NULL, /* Qo */  
         NULL, /* Qq */  
         NULL, /* Re */  
         NULL, /* Rs */  
         NULL, /* Sc */  
         NULL, /* So */  
         NULL, /* Sq */  
         NULL, /* Sm */  
         NULL, /* Sx */  
         NULL, /* Sy */  
         NULL, /* Tn */  
         NULL, /* Ux */  
         NULL, /* Xc */  
         NULL, /* Xo */  
         pmdoc_Fo, /* Fo */  
         NULL, /* Fc */  
         NULL, /* Oo */  
         NULL, /* Oc */  
         NULL, /* Bk */  
         NULL, /* Ek */  
         NULL, /* Bt */  
         NULL, /* Hf */  
         NULL, /* Fr */  
         NULL, /* Ud */  
         NULL, /* Lb */  
         NULL, /* Lp */  
         NULL, /* Lk */  
         NULL, /* Mt */  
         NULL, /* Brq */  
         NULL, /* Bro */  
         NULL, /* Brc */  
         NULL, /* %C */  
         NULL, /* Es */  
         NULL, /* En */  
         NULL, /* Dx */  
         NULL, /* %Q */  
         NULL, /* br */  
         NULL, /* sp */  
         NULL, /* %U */  
         NULL, /* Ta */  
 };  };
   
 static  const char       *progname;  static  void     dbclose(int);
   static  void     dbindex(const struct mpage *, struct mchars *);
   static  int      dbopen(int);
   static  void     dbprune(void);
   static  void     filescan(const char *);
   static  void    *hash_alloc(size_t, void *);
   static  void     hash_free(void *, size_t, void *);
   static  void    *hash_halloc(size_t, void *);
   static  void     mlink_add(struct mlink *, const struct stat *);
   static  int      mlink_check(struct mpage *, struct mlink *);
   static  void     mlink_free(struct mlink *);
   static  void     mlinks_undupe(struct mpage *);
   static  void     mpages_free(void);
   static  void     mpages_merge(struct mchars *, struct mparse *);
   static  void     parse_cat(struct mpage *);
   static  void     parse_man(struct mpage *, const struct man_node *);
   static  void     parse_mdoc(struct mpage *, const struct mdoc_node *);
   static  int      parse_mdoc_body(struct mpage *, const struct mdoc_node *);
   static  int      parse_mdoc_head(struct mpage *, const struct mdoc_node *);
   static  int      parse_mdoc_Fd(struct mpage *, const struct mdoc_node *);
   static  int      parse_mdoc_Fn(struct mpage *, const struct mdoc_node *);
   static  int      parse_mdoc_Nd(struct mpage *, const struct mdoc_node *);
   static  int      parse_mdoc_Nm(struct mpage *, const struct mdoc_node *);
   static  int      parse_mdoc_Sh(struct mpage *, const struct mdoc_node *);
   static  int      parse_mdoc_Xr(struct mpage *, const struct mdoc_node *);
   static  void     putkey(const struct mpage *,
                           const char *, uint64_t);
   static  void     putkeys(const struct mpage *,
                           const char *, size_t, uint64_t);
   static  void     putmdockey(const struct mpage *,
                           const struct mdoc_node *, uint64_t);
   static  void     render_key(struct mchars *, struct str *);
   static  void     say(const char *, const char *, ...);
   static  int      set_basedir(const char *);
   static  int      treescan(void);
   static  size_t   utf8(unsigned int, char [7]);
   
   static  char            *progname;
   static  int              nodb; /* no database changes */
   static  int              quick; /* abort the parse early */
   static  int              use_all; /* use all found files */
   static  int              verb; /* print what we're doing */
   static  int              warnings; /* warn about crap */
   static  int              write_utf8; /* write UTF-8 output; else ASCII */
   static  int              exitcode; /* to be returned by main */
   static  enum op          op; /* operational mode */
   static  char             basedir[PATH_MAX]; /* current base directory */
   static  struct ohash     mpages; /* table of distinct manual pages */
   static  struct ohash     mlinks; /* table of directory entries */
   static  struct ohash     strings; /* table of all strings */
   static  sqlite3         *db = NULL; /* current database */
   static  sqlite3_stmt    *stmts[STMT__MAX]; /* current statements */
   
   static  const struct mdoc_handler mdocs[MDOC_MAX] = {
           { NULL, 0 },  /* Ap */
           { NULL, 0 },  /* Dd */
           { NULL, 0 },  /* Dt */
           { NULL, 0 },  /* Os */
           { parse_mdoc_Sh, TYPE_Sh }, /* Sh */
           { parse_mdoc_head, TYPE_Ss }, /* Ss */
           { NULL, 0 },  /* Pp */
           { NULL, 0 },  /* D1 */
           { NULL, 0 },  /* Dl */
           { NULL, 0 },  /* Bd */
           { NULL, 0 },  /* Ed */
           { NULL, 0 },  /* Bl */
           { NULL, 0 },  /* El */
           { NULL, 0 },  /* It */
           { NULL, 0 },  /* Ad */
           { NULL, TYPE_An },  /* An */
           { NULL, TYPE_Ar },  /* Ar */
           { NULL, TYPE_Cd },  /* Cd */
           { NULL, TYPE_Cm },  /* Cm */
           { NULL, TYPE_Dv },  /* Dv */
           { NULL, TYPE_Er },  /* Er */
           { NULL, TYPE_Ev },  /* Ev */
           { NULL, 0 },  /* Ex */
           { NULL, TYPE_Fa },  /* Fa */
           { parse_mdoc_Fd, 0 },  /* Fd */
           { NULL, TYPE_Fl },  /* Fl */
           { parse_mdoc_Fn, 0 },  /* Fn */
           { NULL, TYPE_Ft },  /* Ft */
           { NULL, TYPE_Ic },  /* Ic */
           { NULL, TYPE_In },  /* In */
           { NULL, TYPE_Li },  /* Li */
           { parse_mdoc_Nd, TYPE_Nd },  /* Nd */
           { parse_mdoc_Nm, TYPE_Nm },  /* Nm */
           { NULL, 0 },  /* Op */
           { NULL, 0 },  /* Ot */
           { NULL, TYPE_Pa },  /* Pa */
           { NULL, 0 },  /* Rv */
           { NULL, TYPE_St },  /* St */
           { NULL, TYPE_Va },  /* Va */
           { parse_mdoc_body, TYPE_Va },  /* Vt */
           { parse_mdoc_Xr, 0 },  /* Xr */
           { NULL, 0 },  /* %A */
           { NULL, 0 },  /* %B */
           { NULL, 0 },  /* %D */
           { NULL, 0 },  /* %I */
           { NULL, 0 },  /* %J */
           { NULL, 0 },  /* %N */
           { NULL, 0 },  /* %O */
           { NULL, 0 },  /* %P */
           { NULL, 0 },  /* %R */
           { NULL, 0 },  /* %T */
           { NULL, 0 },  /* %V */
           { NULL, 0 },  /* Ac */
           { NULL, 0 },  /* Ao */
           { NULL, 0 },  /* Aq */
           { NULL, TYPE_At },  /* At */
           { NULL, 0 },  /* Bc */
           { NULL, 0 },  /* Bf */
           { NULL, 0 },  /* Bo */
           { NULL, 0 },  /* Bq */
           { NULL, TYPE_Bsx },  /* Bsx */
           { NULL, TYPE_Bx },  /* Bx */
           { NULL, 0 },  /* Db */
           { NULL, 0 },  /* Dc */
           { NULL, 0 },  /* Do */
           { NULL, 0 },  /* Dq */
           { NULL, 0 },  /* Ec */
           { NULL, 0 },  /* Ef */
           { NULL, TYPE_Em },  /* Em */
           { NULL, 0 },  /* Eo */
           { NULL, TYPE_Fx },  /* Fx */
           { NULL, TYPE_Ms },  /* Ms */
           { NULL, 0 },  /* No */
           { NULL, 0 },  /* Ns */
           { NULL, TYPE_Nx },  /* Nx */
           { NULL, TYPE_Ox },  /* Ox */
           { NULL, 0 },  /* Pc */
           { NULL, 0 },  /* Pf */
           { NULL, 0 },  /* Po */
           { NULL, 0 },  /* Pq */
           { NULL, 0 },  /* Qc */
           { NULL, 0 },  /* Ql */
           { NULL, 0 },  /* Qo */
           { NULL, 0 },  /* Qq */
           { NULL, 0 },  /* Re */
           { NULL, 0 },  /* Rs */
           { NULL, 0 },  /* Sc */
           { NULL, 0 },  /* So */
           { NULL, 0 },  /* Sq */
           { NULL, 0 },  /* Sm */
           { NULL, 0 },  /* Sx */
           { NULL, TYPE_Sy },  /* Sy */
           { NULL, TYPE_Tn },  /* Tn */
           { NULL, 0 },  /* Ux */
           { NULL, 0 },  /* Xc */
           { NULL, 0 },  /* Xo */
           { parse_mdoc_head, 0 },  /* Fo */
           { NULL, 0 },  /* Fc */
           { NULL, 0 },  /* Oo */
           { NULL, 0 },  /* Oc */
           { NULL, 0 },  /* Bk */
           { NULL, 0 },  /* Ek */
           { NULL, 0 },  /* Bt */
           { NULL, 0 },  /* Hf */
           { NULL, 0 },  /* Fr */
           { NULL, 0 },  /* Ud */
           { NULL, TYPE_Lb },  /* Lb */
           { NULL, 0 },  /* Lp */
           { NULL, TYPE_Lk },  /* Lk */
           { NULL, TYPE_Mt },  /* Mt */
           { NULL, 0 },  /* Brq */
           { NULL, 0 },  /* Bro */
           { NULL, 0 },  /* Brc */
           { NULL, 0 },  /* %C */
           { NULL, 0 },  /* Es */
           { NULL, 0 },  /* En */
           { NULL, TYPE_Dx },  /* Dx */
           { NULL, 0 },  /* %Q */
           { NULL, 0 },  /* br */
           { NULL, 0 },  /* sp */
           { NULL, 0 },  /* %U */
           { NULL, 0 },  /* Ta */
   };
   
 int  int
 main(int argc, char *argv[])  main(int argc, char *argv[])
 {  {
         struct mparse   *mp; /* parse sequence */          int               ch, i;
         struct mdoc     *mdoc; /* resulting mdoc */          size_t            j, sz;
         struct man      *man; /* resulting man */          const char       *path_arg;
         enum op          op; /* current operation */          struct mchars    *mc;
         char            *fn; /* current file being parsed */          struct manpaths   dirs;
         const char      *msec, /* manual section */          struct mparse    *mp;
                         *mtitle, /* manual title */          struct ohash_info mpages_info, mlinks_info;
                         *arch, /* manual architecture */  
                         *dir; /* result dir (default: cwd) */  
         char             ibuf[MAXPATHLEN], /* index fname */  
                          fbuf[MAXPATHLEN],  /* btree fname */  
                          vbuf[8]; /* stringified record number */  
         int              ch, seq, sseq, verb, i;  
         DB              *idx, /* index database */  
                         *db, /* keyword database */  
                         *hash; /* temporary keyword hashtable */  
         DBT              key, val;  
         enum mandoclevel ec; /* exit status */  
         size_t           sv;  
         BTREEINFO        info; /* btree configuration */  
         recno_t          rec,  
                          maxrec; /* supremum of all records */  
         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 */  
         extern int       optind;  
         extern char     *optarg;  
   
           memset(stmts, 0, STMT__MAX * sizeof(sqlite3_stmt *));
           memset(&dirs, 0, sizeof(struct manpaths));
   
           mpages_info.alloc  = mlinks_info.alloc  = hash_alloc;
           mpages_info.halloc = mlinks_info.halloc = hash_halloc;
           mpages_info.hfree  = mlinks_info.hfree  = hash_free;
   
           mpages_info.key_offset = offsetof(struct mpage, inodev);
           mlinks_info.key_offset = offsetof(struct mlink, file);
   
         progname = strrchr(argv[0], '/');          progname = strrchr(argv[0], '/');
         if (progname == NULL)          if (progname == NULL)
                 progname = argv[0];                  progname = argv[0];
         else          else
                 ++progname;                  ++progname;
   
         dir = "";          /*
         verb = 0;           * We accept a few different invocations.
         db = idx = NULL;           * The CHECKOP macro makes sure that invocation styles don't
         mp = NULL;           * clobber each other.
         hash = NULL;           */
         recs = NULL;  #define CHECKOP(_op, _ch) do \
         recsz = reccur = 0;          if (OP_DEFAULT != (_op)) { \
         maxrec = 0;                  fprintf(stderr, "-%c: Conflicting option\n", (_ch)); \
         op = OP_NEW;                  goto usage; \
         ec = MANDOCLEVEL_SYSERR;          } while (/*CONSTCOND*/0)
   
         memset(&buf, 0, sizeof(struct buf));          path_arg = NULL;
         memset(&dbuf, 0, sizeof(struct buf));          op = OP_DEFAULT;
   
         while (-1 != (ch = getopt(argc, argv, "d:ruv")))          while (-1 != (ch = getopt(argc, argv, "aC:d:nQT:tu:vW")))
                 switch (ch) {                  switch (ch) {
                   case ('a'):
                           use_all = 1;
                           break;
                   case ('C'):
                           CHECKOP(op, ch);
                           path_arg = optarg;
                           op = OP_CONFFILE;
                           break;
                 case ('d'):                  case ('d'):
                         dir = optarg;                          CHECKOP(op, ch);
                           path_arg = optarg;
                           op = OP_UPDATE;
                         break;                          break;
                 case ('r'):                  case ('n'):
                         op = OP_DELETE;                          nodb = 1;
                         break;                          break;
                   case ('Q'):
                           quick = 1;
                           break;
                   case ('T'):
                           if (strcmp(optarg, "utf8")) {
                                   fprintf(stderr, "-T%s: Unsupported "
                                       "output format\n", optarg);
                                   goto usage;
                           }
                           write_utf8 = 1;
                           break;
                   case ('t'):
                           CHECKOP(op, ch);
                           dup2(STDOUT_FILENO, STDERR_FILENO);
                           op = OP_TEST;
                           nodb = warnings = 1;
                           break;
                 case ('u'):                  case ('u'):
                         op = OP_UPDATE;                          CHECKOP(op, ch);
                           path_arg = optarg;
                           op = OP_DELETE;
                         break;                          break;
                 case ('v'):                  case ('v'):
                         verb++;                          verb++;
                         break;                          break;
                   case ('W'):
                           warnings = 1;
                           break;
                 default:                  default:
                         usage();                          goto usage;
                         return((int)MANDOCLEVEL_BADARG);  
                 }                  }
   
         argc -= optind;          argc -= optind;
         argv += optind;          argv += optind;
   
         ibuf[0] = ibuf[MAXPATHLEN - 2] =          if (OP_CONFFILE == op && argc > 0) {
                 fbuf[0] = fbuf[MAXPATHLEN - 2] = '\0';                  fprintf(stderr, "-C: Too many arguments\n");
                   goto usage;
           }
   
         strlcat(fbuf, dir, MAXPATHLEN);          exitcode = (int)MANDOCLEVEL_OK;
         strlcat(fbuf, MANDOC_DB, MAXPATHLEN);          mp = mparse_alloc(MPARSE_AUTO,
                   MANDOCLEVEL_FATAL, NULL, NULL, quick);
           mc = mchars_alloc();
   
         strlcat(ibuf, dir, MAXPATHLEN);          ohash_init(&mpages, 6, &mpages_info);
         strlcat(ibuf, MANDOC_IDX, MAXPATHLEN);          ohash_init(&mlinks, 6, &mlinks_info);
   
         if ('\0' != fbuf[MAXPATHLEN - 2] ||          if (OP_UPDATE == op || OP_DELETE == op || OP_TEST == op) {
                         '\0' != ibuf[MAXPATHLEN - 2]) {                  /*
                 fprintf(stderr, "%s: Path too long\n", dir);                   * Force processing all files.
                 goto out;                   */
         }                  use_all = 1;
   
         /*                  /*
          * For the keyword database, open a BTREE database that allows                   * All of these deal with a specific directory.
          * duplicates.                   * Jump into that directory then collect files specified
          * For the index database, use a standard RECNO database type.                   * on the command-line.
          * Truncate the database if we're creating a new one.                   */
          */                  if (0 == set_basedir(path_arg))
                           goto out;
                   for (i = 0; i < argc; i++)
                           filescan(argv[i]);
                   if (0 == dbopen(1))
                           goto out;
                   if (OP_TEST != op)
                           dbprune();
                   if (OP_DELETE != op)
                           mpages_merge(mc, mp);
                   dbclose(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, path_arg, NULL, NULL);
   
         memset(&info, 0, sizeof(BTREEINFO));                  /*
         info.flags = R_DUP;                   * First scan the tree rooted at a base directory, then
                    * build a new database and finally move it into place.
                    * 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 (OP_NEW == op) {                          if (j) {
                 db = dbopen(fbuf, MANDOC_FLAGS, 0644, DB_BTREE, &info);                                  ohash_init(&mpages, 6, &mpages_info);
                 idx = dbopen(ibuf, MANDOC_FLAGS, 0644, DB_RECNO, NULL);                                  ohash_init(&mlinks, 6, &mlinks_info);
         } else {                          }
                 db = dbopen(fbuf, O_CREAT|O_RDWR, 0644, DB_BTREE, &info);  
                 idx = dbopen(ibuf, O_CREAT|O_RDWR, 0644, DB_RECNO, NULL);  
         }  
   
         if (NULL == db) {                          if (0 == set_basedir(dirs.paths[j]))
                 perror(fbuf);                                  goto out;
                 goto out;                          if (0 == treescan())
         } else if (NULL == db) {                                  goto out;
                 perror(ibuf);                          if (0 == set_basedir(dirs.paths[j]))
                 goto out;                                  goto out;
                           if (0 == dbopen(0))
                                   goto out;
   
                           mpages_merge(mc, mp);
                           dbclose(0);
   
                           if (j + 1 < dirs.sz) {
                                   mpages_free();
                                   ohash_delete(&mpages);
                                   ohash_delete(&mlinks);
                           }
                   }
         }          }
   out:
           set_basedir(NULL);
           manpath_free(&dirs);
           mchars_free(mc);
           mparse_free(mp);
           mpages_free();
           ohash_delete(&mpages);
           ohash_delete(&mlinks);
           return(exitcode);
   usage:
           fprintf(stderr, "usage: %s [-anQvW] [-C file] [-Tutf8]\n"
                           "       %s [-anQvW] [-Tutf8] dir ...\n"
                           "       %s [-nQvW] [-Tutf8] -d dir [file ...]\n"
                           "       %s [-nvW] -u dir [file ...]\n"
                           "       %s [-Q] -t file ...\n",
                          progname, progname, progname,
                          progname, progname);
   
           return((int)MANDOCLEVEL_BADARG);
   }
   
   /*
    * Scan a directory tree rooted at "basedir" for manpages.
    * We use fts(), scanning directory parts along the way for clues to our
    * section and architecture.
    *
    * If use_all has been specified, grok all files.
    * If not, sanitise paths to the following:
    *
    *   [./]man*[/<arch>]/<name>.<section>
    *   or
    *   [./]cat<section>[/<arch>]/<name>.0
    *
    * TODO: accomodate for multi-language directories.
    */
   static int
   treescan(void)
   {
           FTS             *f;
           FTSENT          *ff;
           struct mlink    *mlink;
           int              dform;
           char            *dsec, *arch, *fsec, *cp;
           const char      *path;
           const char      *argv[2];
   
           argv[0] = ".";
           argv[1] = (char *)NULL;
   
         /*          /*
          * If we're going to delete or update a database, remove the           * Walk through all components under the directory, using the
          * entries now (both the index and all keywords pointing to it).           * logical descent of files.
          * This doesn't actually remove them: it only sets their record  
          * value lengths to zero.  
          * While doing so, add the empty records to a list we'll access  
          * later in re-adding entries to the database.  
          */           */
           f = fts_open((char * const *)argv, FTS_LOGICAL, NULL);
           if (NULL == f) {
                   exitcode = (int)MANDOCLEVEL_SYSERR;
                   say("", NULL);
                   return(0);
           }
   
         if (OP_DELETE == op || OP_UPDATE == op) {          dsec = arch = NULL;
                 seq = R_FIRST;          dform = FORM_NONE;
                 while (0 == (ch = (*idx->seq)(idx, &key, &val, seq))) {  
                         seq = R_NEXT;          while (NULL != (ff = fts_read(f))) {
                         maxrec = *(recno_t *)key.data;                  path = ff->fts_path + 2;
                         if (0 == val.size && OP_UPDATE == op) {                  /*
                                 if (reccur >= recsz) {                   * If we're a regular file, add an mlink by using the
                                         recsz += MANDOC_SLOP;                   * stored directory data and handling the filename.
                                         recs = mandoc_realloc                   */
                                                 (recs, recsz * sizeof(recno_t));                  if (FTS_F == ff->fts_info) {
                           if (0 == strcmp(path, MANDOC_DB))
                                   continue;
                           if ( ! use_all && ff->fts_level < 2) {
                                   if (warnings)
                                           say(path, "Extraneous file");
                                   continue;
                           } else if (NULL == (fsec =
                                           strrchr(ff->fts_name, '.'))) {
                                   if ( ! use_all) {
                                           if (warnings)
                                                   say(path,
                                                       "No filename suffix");
                                           continue;
                                 }                                  }
                                 recs[(int)reccur] = maxrec;                          } else if (0 == strcmp(++fsec, "html")) {
                                 reccur++;                                  if (warnings)
                                           say(path, "Skip html");
                                 continue;                                  continue;
                         }                          } else if (0 == strcmp(fsec, "gz")) {
                                   if (warnings)
                         fn = (char *)val.data;                                          say(path, "Skip gz");
                         for (i = 0; i < argc; i++)  
                                 if (0 == strcmp(fn, argv[i]))  
                                         break;  
   
                         if (i == argc)  
                                 continue;                                  continue;
                           } else if (0 == strcmp(fsec, "ps")) {
                                   if (warnings)
                                           say(path, "Skip ps");
                                   continue;
                           } else if (0 == strcmp(fsec, "pdf")) {
                                   if (warnings)
                                           say(path, "Skip pdf");
                                   continue;
                           } else if ( ! use_all &&
                               ((FORM_SRC == dform && strcmp(fsec, dsec)) ||
                                (FORM_CAT == dform && strcmp(fsec, "0")))) {
                                   if (warnings)
                                           say(path, "Wrong filename suffix");
                                   continue;
                           } else
                                   fsec[-1] = '\0';
   
                         sseq = R_FIRST;                          mlink = mandoc_calloc(1, sizeof(struct mlink));
                         while (0 == (ch = (*db->seq)(db, &key, &val, sseq))) {                          strlcpy(mlink->file, path, sizeof(mlink->file));
                                 sseq = R_NEXT;                          mlink->dform = dform;
                                 assert(8 == val.size);                          mlink->dsec = dsec;
                                 if (maxrec != *(recno_t *)(val.data + 4))                          mlink->arch = arch;
                                         continue;                          mlink->name = ff->fts_name;
                                 if (verb > 1)                          mlink->fsec = fsec;
                                         printf("%s: Deleted keyword: %s\n",                          mlink_add(mlink, ff->fts_statp);
                                                 fn, (char *)key.data);                          continue;
                                 ch = (*db->del)(db, &key, R_CURSOR);                  } else if (FTS_D != ff->fts_info &&
                                 if (ch < 0)                                  FTS_DP != ff->fts_info) {
                                         break;                          if (warnings)
                         }                                  say(path, "Not a regular file");
                         if (ch < 0) {                          continue;
                                 perror(fbuf);                  }
                                 exit((int)MANDOCLEVEL_SYSERR);  
                         }  
   
                         if (verb)                  switch (ff->fts_level) {
                                 printf("%s: Deleted index\n", fn);                  case (0):
                           /* Ignore the root directory. */
                           break;
                   case (1):
                           /*
                            * This might contain manX/ or catX/.
                            * Try to infer this from the name.
                            * If we're not in use_all, enforce it.
                            */
                           cp = ff->fts_name;
                           if (FTS_DP == ff->fts_info)
                                   break;
   
                         val.size = 0;                          if (0 == strncmp(cp, "man", 3)) {
                         ch = (*idx->put)(idx, &key, &val, R_CURSOR);                                  dform = FORM_SRC;
                         if (ch < 0) {                                  dsec = cp + 3;
                                 perror(ibuf);                          } else if (0 == strncmp(cp, "cat", 3)) {
                                 exit((int)MANDOCLEVEL_SYSERR);                                  dform = FORM_CAT;
                                   dsec = cp + 3;
                           } else {
                                   dform = FORM_NONE;
                                   dsec = NULL;
                         }                          }
   
                         if (OP_UPDATE == op) {                          if (NULL != dsec || use_all)
                                 if (reccur >= recsz) {                                  break;
                                         recsz += MANDOC_SLOP;  
                                         recs = mandoc_realloc                          if (warnings)
                                                 (recs, recsz * sizeof(recno_t));                                  say(path, "Unknown directory part");
                                 }                          fts_set(f, ff, FTS_SKIP);
                                 recs[(int)reccur] = maxrec;                          break;
                                 reccur++;                  case (2):
                         }                          /*
                            * Possibly our architecture.
                            * If we're descending, keep tabs on it.
                            */
                           if (FTS_DP != ff->fts_info && NULL != dsec)
                                   arch = ff->fts_name;
                           else
                                   arch = NULL;
                           break;
                   default:
                           if (FTS_DP == ff->fts_info || use_all)
                                   break;
                           if (warnings)
                                   say(path, "Extraneous directory part");
                           fts_set(f, ff, FTS_SKIP);
                           break;
                 }                  }
                 maxrec++;  
         }          }
   
         if (OP_DELETE == op) {          fts_close(f);
                 ec = MANDOCLEVEL_OK;          return(1);
                 goto out;  }
   
   /*
    * Add a file to the mlinks table.
    * 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
    *
    * See treescan() for the fts(3) version of this.
    */
   static void
   filescan(const char *file)
   {
           char             buf[PATH_MAX];
           struct stat      st;
           struct mlink    *mlink;
           char            *p, *start;
   
           assert(use_all);
   
           if (0 == strncmp(file, "./", 2))
                   file += 2;
   
           if (NULL == realpath(file, buf)) {
                   exitcode = (int)MANDOCLEVEL_BADARG;
                   say(file, NULL);
                   return;
           } else if (OP_TEST != op && strstr(buf, basedir) != buf) {
                   exitcode = (int)MANDOCLEVEL_BADARG;
                   say("", "%s: outside base directory", buf);
                   return;
           } else if (-1 == stat(buf, &st)) {
                   exitcode = (int)MANDOCLEVEL_BADARG;
                   say(file, NULL);
                   return;
           } else if ( ! (S_IFREG & st.st_mode)) {
                   exitcode = (int)MANDOCLEVEL_BADARG;
                   say(file, "Not a regular file");
                   return;
         }          }
           start = buf + strlen(basedir);
           mlink = mandoc_calloc(1, sizeof(struct mlink));
           strlcpy(mlink->file, start, sizeof(mlink->file));
   
         /*          /*
          * Add records to the database.           * First try to guess our directory structure.
          * Try parsing each manual given on the command line.           * If we find a separator, try to look for man* or cat*.
          * If we fail, then emit an error and keep on going.           * If we find one of these and what's underneath is a directory,
          * Take resulting trees and push them down into the database code.           * assume it's an architecture.
          * Use the auto-parser and don't report any errors.  
          */           */
           if (NULL != (p = strchr(start, '/'))) {
                   *p++ = '\0';
                   if (0 == strncmp(start, "man", 3)) {
                           mlink->dform = FORM_SRC;
                           mlink->dsec = start + 3;
                   } else if (0 == strncmp(start, "cat", 3)) {
                           mlink->dform = FORM_CAT;
                           mlink->dsec = start + 3;
                   }
   
         mp = mparse_alloc(MPARSE_AUTO, MANDOCLEVEL_FATAL, NULL, NULL);                  start = p;
                   if (NULL != mlink->dsec && NULL != (p = strchr(start, '/'))) {
                           *p++ = '\0';
                           mlink->arch = start;
                           start = p;
                   }
           }
   
         buf.size = dbuf.size = MANDOC_BUFSZ;          /*
         buf.cp = mandoc_malloc(buf.size);           * Now check the file suffix.
         dbuf.cp = mandoc_malloc(dbuf.size);           * Suffix of `.0' indicates a catpage, `.1-9' is a manpage.
            */
           p = strrchr(start, '\0');
           while (p-- > start && '/' != *p && '.' != *p)
                   /* Loop. */ ;
   
         for (rec = 0, i = 0; i < argc; i++) {          if ('.' == *p) {
                 fn = argv[i];                  *p++ = '\0';
                 if (OP_UPDATE == op) {                  mlink->fsec = p;
                         if (reccur > 0) {          }
                                 --reccur;  
                                 rec = recs[(int)reccur];  
                         } else if (maxrec > 0) {  
                                 rec = maxrec;  
                                 maxrec = 0;  
                         } else  
                                 rec++;  
                 } else  
                         rec++;  
   
                 mparse_reset(mp);          /*
                 hash_reset(&hash);           * Now try to parse the name.
            * Use the filename portion of the path.
            */
           mlink->name = start;
           if (NULL != (p = strrchr(start, '/'))) {
                   mlink->name = p + 1;
                   *p = '\0';
           }
           mlink_add(mlink, &st);
   }
   
                 if (mparse_readfd(mp, -1, fn) >= MANDOCLEVEL_FATAL) {  static void
                         fprintf(stderr, "%s: Parse failure\n", fn);  mlink_add(struct mlink *mlink, const struct stat *st)
                         continue;  {
                 }          struct inodev    inodev;
           struct mpage    *mpage;
           unsigned int     slot;
   
                 mparse_result(mp, &mdoc, &man);          assert(NULL != mlink->file);
                 if (NULL == mdoc && NULL == man)  
                         continue;  
   
                 msec = NULL != mdoc ?          mlink->dsec = mandoc_strdup(mlink->dsec ? mlink->dsec : "");
                         mdoc_meta(mdoc)->msec : man_meta(man)->msec;          mlink->arch = mandoc_strdup(mlink->arch ? mlink->arch : "");
                 mtitle = NULL != mdoc ?          mlink->name = mandoc_strdup(mlink->name ? mlink->name : "");
                         mdoc_meta(mdoc)->title : man_meta(man)->title;          mlink->fsec = mandoc_strdup(mlink->fsec ? mlink->fsec : "");
                 arch = NULL != mdoc ? mdoc_meta(mdoc)->arch : NULL;  
   
                 if (NULL == arch)          if ('0' == *mlink->fsec) {
                         arch = "";                  free(mlink->fsec);
                   mlink->fsec = mandoc_strdup(mlink->dsec);
                   mlink->fform = FORM_CAT;
           } else if ('1' <= *mlink->fsec && '9' >= *mlink->fsec)
                   mlink->fform = FORM_SRC;
           else
                   mlink->fform = FORM_NONE;
   
                 /*          slot = ohash_qlookup(&mlinks, mlink->file);
                  * The index record value consists of a nil-terminated          assert(NULL == ohash_find(&mlinks, slot));
                  * filename, a nil-terminated manual section, and a          ohash_insert(&mlinks, slot, mlink);
                  * nil-terminated description.  Since the description  
                  * may not be set, we set a sentinel to see if we're  
                  * going to write a nil byte in its place.  
                  */  
   
                 dbuf.len = 0;          inodev.st_ino = st->st_ino;
                 buf_appendb(&dbuf, fn, strlen(fn) + 1);          inodev.st_dev = st->st_dev;
                 buf_appendb(&dbuf, msec, strlen(msec) + 1);          slot = ohash_lookup_memory(&mpages, (char *)&inodev,
                 buf_appendb(&dbuf, mtitle, strlen(mtitle) + 1);              sizeof(struct inodev), inodev.st_ino);
                 buf_appendb(&dbuf, arch, strlen(arch) + 1);          mpage = ohash_find(&mpages, slot);
           if (NULL == mpage) {
                   mpage = mandoc_calloc(1, sizeof(struct mpage));
                   mpage->inodev.st_ino = inodev.st_ino;
                   mpage->inodev.st_dev = inodev.st_dev;
                   ohash_insert(&mpages, slot, mpage);
           } else
                   mlink->next = mpage->mlinks;
           mpage->mlinks = mlink;
   }
   
                 sv = dbuf.len;  static void
   mlink_free(struct mlink *mlink)
   {
   
                 /* Fix the record number in the btree value. */          free(mlink->dsec);
           free(mlink->arch);
           free(mlink->name);
           free(mlink->fsec);
           free(mlink);
   }
   
                 if (mdoc)  static void
                         pmdoc_node(hash, &buf, &dbuf,  mpages_free(void)
                                 mdoc_node(mdoc), mdoc_meta(mdoc));  {
                 else          struct mpage    *mpage;
                         pman_node(hash, &buf, &dbuf, man_node(man));          struct mlink    *mlink;
           unsigned int     slot;
   
                 /*          mpage = ohash_first(&mpages, &slot);
                  * Copy from the in-memory hashtable of pending keywords          while (NULL != mpage) {
                  * into the database.                  while (NULL != (mlink = mpage->mlinks)) {
                  */                          mpage->mlinks = mlink->next;
                           mlink_free(mlink);
                 memset(vbuf, 0, sizeof(uint32_t));                  }
                 memcpy(vbuf + 4, &rec, sizeof(uint32_t));                  free(mpage->sec);
                   free(mpage->arch);
                   free(mpage->title);
                   free(mpage->desc);
                   free(mpage);
                   mpage = ohash_next(&mpages, &slot);
           }
   }
   
                 seq = R_FIRST;  /*
                 while (0 == (ch = (*hash->seq)(hash, &key, &val, seq))) {   * For each mlink to the mpage, check whether the path looks like
                         seq = R_NEXT;   * it is formatted, and if it does, check whether a source manual
    * exists by the same name, ignoring the suffix.
    * If both conditions hold, drop the mlink.
    */
   static void
   mlinks_undupe(struct mpage *mpage)
   {
           char              buf[PATH_MAX];
           struct mlink    **prev;
           struct mlink     *mlink;
           char             *bufp;
   
                         memcpy(vbuf, val.data, sizeof(uint32_t));          mpage->form = FORM_CAT;
                         val.size = sizeof(vbuf);          prev = &mpage->mlinks;
                         val.data = vbuf;          while (NULL != (mlink = *prev)) {
                   if (FORM_CAT != mlink->dform) {
                         if (verb > 1)                          mpage->form = FORM_NONE;
                                 printf("%s: Added keyword: %s, 0x%x\n",                          goto nextlink;
                                         fn, (char *)key.data,  
                                         *(int *)val.data);  
                         dbt_put(db, fbuf, &key, &val);  
                 }                  }
                 if (ch < 0) {                  if (strlcpy(buf, mlink->file, PATH_MAX) >= PATH_MAX) {
                         perror("hash");                          if (warnings)
                         exit((int)MANDOCLEVEL_SYSERR);                                  say(mlink->file, "Filename too long");
                           goto nextlink;
                 }                  }
                   bufp = strstr(buf, "cat");
                 /*                  assert(NULL != bufp);
                  * Apply to the index.  If we haven't had a description                  memcpy(bufp, "man", 3);
                  * set, put an empty one in now.                  if (NULL != (bufp = strrchr(buf, '.')))
                  */                          *++bufp = '\0';
                   strlcat(buf, mlink->dsec, PATH_MAX);
                   if (NULL == ohash_find(&mlinks,
                                   ohash_qlookup(&mlinks, buf)))
                           goto nextlink;
                   if (warnings)
                           say(mlink->file, "Man source exists: %s", buf);
                   if (use_all)
                           goto nextlink;
                   *prev = mlink->next;
                   mlink_free(mlink);
                   continue;
   nextlink:
                   prev = &(*prev)->next;
           }
   }
   
                 if (dbuf.len == sv)  static int
                         buf_appendb(&dbuf, "", 1);  mlink_check(struct mpage *mpage, struct mlink *mlink)
   {
           int      match;
   
                 key.data = &rec;          match = 1;
                 key.size = sizeof(recno_t);  
   
                 val.data = dbuf.cp;          /*
                 val.size = dbuf.len;           * Check whether the manual section given in a file
            * agrees with the directory where the file is located.
            * Some manuals have suffixes like (3p) on their
            * section number either inside the file or in the
            * directory name, some are linked into more than one
            * section, like encrypt(1) = makekey(8).
            */
   
                 if (verb > 0)          if (FORM_SRC == mpage->form &&
                         printf("%s: Added index\n", fn);              strcasecmp(mpage->sec, mlink->dsec)) {
                   match = 0;
                 dbt_put(idx, ibuf, &key, &val);                  say(mlink->file, "Section \"%s\" manual in %s directory",
                       mpage->sec, mlink->dsec);
         }          }
   
         ec = MANDOCLEVEL_OK;          /*
 out:           * Manual page directories exist for each kernel
         if (db)           * architecture as returned by machine(1).
                 (*db->close)(db);           * However, many manuals only depend on the
         if (idx)           * application architecture as returned by arch(1).
                 (*idx->close)(idx);           * For example, some (2/ARM) manuals are shared
         if (hash)           * across the "armish" and "zaurus" kernel
                 (*hash->close)(hash);           * architectures.
         if (mp)           * A few manuals are even shared across completely
                 mparse_free(mp);           * different architectures, for example fdformat(1)
            * on amd64, i386, sparc, and sparc64.
            */
   
         free(buf.cp);          if (strcasecmp(mpage->arch, mlink->arch)) {
         free(dbuf.cp);                  match = 0;
         free(recs);                  say(mlink->file, "Architecture \"%s\" manual in "
                       "\"%s\" directory", mpage->arch, mlink->arch);
           }
   
         return((int)ec);          if (strcasecmp(mpage->title, mlink->name))
                   match = 0;
   
           return(match);
 }  }
   
 /*  /*
  * Grow the buffer (if necessary) and copy in a binary string.   * Run through the files in the global vector "mpages"
    * and add them to the database specified in "basedir".
    *
    * This handles the parsing scheme itself, using the cues of directory
    * and filename to determine whether the file is parsable or not.
  */   */
 static void  static void
 buf_appendb(struct buf *buf, const void *cp, size_t sz)  mpages_merge(struct mchars *mc, struct mparse *mp)
 {  {
           struct ohash_info        str_info;
           struct mpage            *mpage;
           struct mlink            *mlink;
           struct mdoc             *mdoc;
           struct man              *man;
           const char              *cp;
           int                      match;
           unsigned int             pslot;
           enum mandoclevel         lvl;
   
         /* Overshoot by MANDOC_BUFSZ. */          str_info.alloc = hash_alloc;
           str_info.halloc = hash_halloc;
           str_info.hfree = hash_free;
           str_info.key_offset = offsetof(struct str, key);
   
         while (buf->len + sz >= buf->size) {          mpage = ohash_first(&mpages, &pslot);
                 buf->size = buf->len + sz + MANDOC_BUFSZ;          while (NULL != mpage) {
                 buf->cp = mandoc_realloc(buf->cp, buf->size);                  mlinks_undupe(mpage);
         }                  if (NULL == mpage->mlinks) {
                           mpage = ohash_next(&mpages, &pslot);
                           continue;
                   }
   
         memcpy(buf->cp + (int)buf->len, cp, sz);                  ohash_init(&strings, 6, &str_info);
         buf->len += sz;                  mparse_reset(mp);
                   mdoc = NULL;
                   man = NULL;
   
                   /*
                    * Try interpreting the file as mdoc(7) or man(7)
                    * source code, unless it is already known to be
                    * formatted.  Fall back to formatted mode.
                    */
                   if (FORM_CAT != mpage->mlinks->dform ||
                       FORM_CAT != mpage->mlinks->fform) {
                           lvl = mparse_readfd(mp, -1, mpage->mlinks->file);
                           if (lvl < MANDOCLEVEL_FATAL)
                                   mparse_result(mp, &mdoc, &man);
                   }
   
                   if (NULL != mdoc) {
                           mpage->form = FORM_SRC;
                           mpage->sec =
                               mandoc_strdup(mdoc_meta(mdoc)->msec);
                           mpage->arch = mdoc_meta(mdoc)->arch;
                           mpage->arch = mandoc_strdup(
                               NULL == mpage->arch ? "" : mpage->arch);
                           mpage->title =
                               mandoc_strdup(mdoc_meta(mdoc)->title);
                   } else if (NULL != man) {
                           mpage->form = FORM_SRC;
                           mpage->sec =
                               mandoc_strdup(man_meta(man)->msec);
                           mpage->arch =
                               mandoc_strdup(mpage->mlinks->arch);
                           mpage->title =
                               mandoc_strdup(man_meta(man)->title);
                   } else {
                           mpage->form = FORM_CAT;
                           mpage->sec =
                               mandoc_strdup(mpage->mlinks->dsec);
                           mpage->arch =
                               mandoc_strdup(mpage->mlinks->arch);
                           mpage->title =
                               mandoc_strdup(mpage->mlinks->name);
                   }
                   putkey(mpage, mpage->sec, TYPE_sec);
                   putkey(mpage, '\0' == *mpage->arch ?
                       "any" : mpage->arch, TYPE_arch);
   
                   for (mlink = mpage->mlinks; mlink; mlink = mlink->next) {
                           if ('\0' != *mlink->dsec)
                                   putkey(mpage, mlink->dsec, TYPE_sec);
                           if ('\0' != *mlink->fsec)
                                   putkey(mpage, mlink->fsec, TYPE_sec);
                           putkey(mpage, '\0' == *mlink->arch ?
                               "any" : mlink->arch, TYPE_arch);
                           putkey(mpage, mlink->name, TYPE_Nm);
                   }
   
                   if (warnings && !use_all) {
                           match = 0;
                           for (mlink = mpage->mlinks; mlink;
                                mlink = mlink->next)
                                   if (mlink_check(mpage, mlink))
                                           match = 1;
                   } else
                           match = 1;
   
                   if (NULL != mdoc) {
                           if (NULL != (cp = mdoc_meta(mdoc)->name))
                                   putkey(mpage, cp, TYPE_Nm);
                           assert(NULL == mpage->desc);
                           parse_mdoc(mpage, mdoc_node(mdoc));
                           putkey(mpage, NULL != mpage->desc ?
                               mpage->desc : mpage->mlinks->name, TYPE_Nd);
                   } else if (NULL != man)
                           parse_man(mpage, man_node(man));
                   else
                           parse_cat(mpage);
   
                   dbindex(mpage, mc);
                   ohash_delete(&strings);
                   mpage = ohash_next(&mpages, &pslot);
           }
 }  }
   
 /*  
  * Append a nil-terminated string to the buffer.  
  * This can be invoked multiple times.  
  * The buffer string will be nil-terminated.  
  * If invoked multiple times, a space is put between strings.  
  */  
 static void  static void
 buf_append(struct buf *buf, const char *cp)  parse_cat(struct mpage *mpage)
 {  {
         size_t           sz;          FILE            *stream;
           char            *line, *p, *title;
           size_t           len, plen, titlesz;
   
         if (0 == (sz = strlen(cp)))          if (NULL == (stream = fopen(mpage->mlinks->file, "r"))) {
                   if (warnings)
                           say(mpage->mlinks->file, NULL);
                 return;                  return;
           }
   
         if (buf->len)          /* Skip to first blank line. */
                 buf->cp[(int)buf->len - 1] = ' ';  
   
         buf_appendb(buf, cp, sz + 1);          while (NULL != (line = fgetln(stream, &len)))
                   if ('\n' == *line)
                           break;
   
           /*
            * Assume the first line that is not indented
            * is the first section header.  Skip to it.
            */
   
           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.
            */
   
           titlesz = 0;
           title = NULL;
   
           while (NULL != (line = fgetln(stream, &len))) {
                   if (' ' != *line || '\n' != line[len - 1])
                           break;
                   while (len > 0 && isspace((unsigned char)*line)) {
                           line++;
                           len--;
                   }
                   if (1 == len)
                           continue;
                   title = mandoc_realloc(title, titlesz + len);
                   memcpy(title + titlesz, line, len);
                   titlesz += len;
                   title[titlesz - 1] = ' ';
           }
   
           /*
            * 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(mpage->mlinks->file,
                               "Cannot find NAME section");
                   assert(NULL == mpage->desc);
                   mpage->desc = mandoc_strdup(mpage->mlinks->name);
                   putkey(mpage, mpage->mlinks->name, TYPE_Nd);
                   fclose(stream);
                   free(title);
                   return;
           }
   
           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(mpage->mlinks->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;
           }
   
           assert(NULL == mpage->desc);
           mpage->desc = mandoc_strdup(p);
           putkey(mpage, mpage->desc, TYPE_Nd);
           fclose(stream);
           free(title);
 }  }
   
 /*  /*
  * Recursively add all text from a given node.   * Put a type/word pair into the word database for this particular file.
  * 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)  putkey(const struct mpage *mpage, const char *value, uint64_t type)
 {  {
   
         for ( ; n; n = n->next) {          assert(NULL != value);
                 if (n->child)          putkeys(mpage, value, strlen(value), type);
                         buf_appendmdoc(buf, n->child, f);  }
   
                 if (MDOC_TEXT == n->type && f) {  /*
                         f = 0;   * Grok all nodes at or below a certain mdoc node into putkey().
                         buf_appendb(buf, n->string,   */
                                         strlen(n->string) + 1);  static void
                 } else if (MDOC_TEXT == n->type)  putmdockey(const struct mpage *mpage,
                         buf_append(buf, n->string);          const struct mdoc_node *n, uint64_t m)
   {
   
           for ( ; NULL != n; n = n->next) {
                   if (NULL != n->child)
                           putmdockey(mpage, n->child, m);
                   if (MDOC_TEXT == n->type)
                           putkey(mpage, n->string, m);
         }          }
 }  }
   
 /* ARGSUSED */  
 static void  static void
 pmdoc_An(MDOC_ARGS)  parse_man(struct mpage *mpage, const struct man_node *n)
 {  {
           const struct man_node *head, *body;
         if (SEC_AUTHORS != n->sec)          char            *start, *sv, *title;
           char             byte;
           size_t           sz, titlesz;
   
           if (NULL == n)
                 return;                  return;
   
         buf_appendmdoc(buf, n->child, 0);          /*
         hash_put(hash, buf, TYPE_AUTHOR);           * 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;
   
                           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;
                           }
   
                           /* Erase trailing space. */
   
                           start = &sv[sz - 1];
                           while (start > sv && isspace((unsigned char)*start))
                                   *start-- = '\0';
   
                           if (start == sv) {
                                   free(title);
                                   return;
                           }
   
                           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(mpage, start, TYPE_Nm);
   
                                   if (' ' == byte) {
                                           start += sz + 1;
                                           break;
                                   }
   
                                   assert(',' == byte);
                                   start += sz + 1;
                                   while (' ' == *start)
                                           start++;
                           }
   
                           if (sv == start) {
                                   putkey(mpage, start, TYPE_Nm);
                                   free(title);
                                   return;
                           }
   
                           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 == mpage->desc);
                           mpage->desc = mandoc_strdup(start);
                           putkey(mpage, mpage->desc, TYPE_Nd);
                           free(title);
                           return;
                   }
           }
   
           for (n = n->child; n; n = n->next) {
                   if (NULL != mpage->desc)
                           break;
                   parse_man(mpage, n);
           }
 }  }
   
 static void  static void
 hash_reset(DB **db)  parse_mdoc(struct mpage *mpage, 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) {
         *db = dbopen(NULL, MANDOC_FLAGS, 0644, DB_HASH, NULL);                  case (MDOC_ELEM):
         if (NULL == *db) {                          /* FALLTHROUGH */
                 perror("hash");                  case (MDOC_BLOCK):
                 exit((int)MANDOCLEVEL_SYSERR);                          /* FALLTHROUGH */
                   case (MDOC_HEAD):
                           /* FALLTHROUGH */
                   case (MDOC_BODY):
                           /* FALLTHROUGH */
                   case (MDOC_TAIL):
                           if (NULL != mdocs[n->tok].fp)
                                  if (0 == (*mdocs[n->tok].fp)(mpage, n))
                                          break;
                           if (mdocs[n->tok].mask)
                                   putmdockey(mpage, n->child,
                                       mdocs[n->tok].mask);
                           break;
                   default:
                           assert(MDOC_ROOT != n->type);
                           continue;
                   }
                   if (NULL != n->child)
                           parse_mdoc(mpage, n);
         }          }
 }  }
   
 /* ARGSUSED */  static int
 static void  parse_mdoc_Fd(struct mpage *mpage, 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 698  pmdoc_Fd(MDOC_ARGS)
Line 1403  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(mpage, start, end - start + 1, TYPE_In);
         buf_appendb(buf, start, (size_t)(end - start + 1));          return(0);
         buf_appendb(buf, "", 1);  
   
         hash_put(hash, buf, TYPE_INCLUDES);  
 }  }
   
 /* ARGSUSED */  static int
 static void  parse_mdoc_Fn(struct mpage *mpage, const struct mdoc_node *n)
 pmdoc_Cd(MDOC_ARGS)  
 {  {
   
         if (SEC_SYNOPSIS != n->sec)  
                 return;  
   
         buf_appendmdoc(buf, n->child, 0);  
         hash_put(hash, buf, TYPE_CONFIG);  
 }  
   
 /* ARGSUSED */  
 static void  
 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 void  
 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(mpage, cp, TYPE_Fn);
         hash_put(hash, buf, TYPE_FUNCTION);  
 }  
   
 /* ARGSUSED */          if (n->string < cp)
 static void                  putkeys(mpage, n->string, cp - n->string, TYPE_Ft);
 pmdoc_St(MDOC_ARGS)  
 {  
   
         if (SEC_STANDARDS != n->sec)  
                 return;  
         if (NULL == n->child || MDOC_TEXT != n->child->type)  
                 return;  
   
         buf_append(buf, n->child->string);          for (n = n->next; NULL != n; n = n->next)
         hash_put(hash, buf, TYPE_STANDARD);                  if (MDOC_TEXT == n->type)
                           putkey(mpage, n->string, TYPE_Fa);
   
           return(0);
 }  }
   
 /* ARGSUSED */  static int
 static void  parse_mdoc_Xr(struct mpage *mpage, const struct mdoc_node *n)
 pmdoc_Xr(MDOC_ARGS)  
 {  {
           char    *cp;
   
         if (NULL == (n = n->child))          if (NULL == (n = n->child))
                 return;                  return(0);
   
         buf_appendb(buf, n->string, strlen(n->string));          if (NULL == n->next) {
                   putkey(mpage, n->string, TYPE_Xr);
                   return(0);
           }
   
         if (NULL != (n = n->next)) {          if (-1 == asprintf(&cp, "%s(%s)", n->string, n->next->string)) {
                 buf_appendb(buf, ".", 1);                  perror(NULL);
                 buf_appendb(buf, n->string, strlen(n->string) + 1);                  exit((int)MANDOCLEVEL_SYSERR);
         } else          }
                 buf_appendb(buf, ".", 2);          putkey(mpage, cp, TYPE_Xr);
           free(cp);
         hash_put(hash, buf, TYPE_XREF);          return(0);
 }  }
   
 /* ARGSUSED */  static int
 static void  parse_mdoc_Nd(struct mpage *mpage, const struct mdoc_node *n)
 pmdoc_Vt(MDOC_ARGS)  
 {  {
         const char      *start;  
         size_t           sz;          size_t           sz;
   
         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;          for (n = n->child; NULL != n; n = n->next) {
                   if (MDOC_TEXT == n->type) {
                           if (NULL != mpage->desc) {
                                   sz = strlen(mpage->desc) +
                                        strlen(n->string) + 2;
                                   mpage->desc = mandoc_realloc(
                                       mpage->desc, sz);
                                   strlcat(mpage->desc, " ", sz);
                                   strlcat(mpage->desc, n->string, sz);
                           } else
                                   mpage->desc = mandoc_strdup(n->string);
                   }
                   if (NULL != n->child)
                           parse_mdoc_Nd(mpage, n);
           }
           return(1);
   }
   
         while ('*' == *start)  static int
                 start++;  parse_mdoc_Nm(struct mpage *mpage, const struct mdoc_node *n)
   {
   
         if (0 == (sz = strlen(start)))          return(SEC_NAME == n->sec ||
                 return;              (SEC_SYNOPSIS == n->sec && MDOC_HEAD == n->type));
   }
   
         if (';' == start[(int)sz - 1])  static int
                 sz--;  parse_mdoc_Sh(struct mpage *mpage, const struct mdoc_node *n)
   {
   
         if (0 == sz)          return(SEC_CUSTOM == n->sec && MDOC_HEAD == n->type);
                 return;  
   
         buf_appendb(buf, start, sz);  
         buf_appendb(buf, "", 1);  
         hash_put(hash, buf, TYPE_VARIABLE);  
 }  }
   
 /* ARGSUSED */  static int
 static void  parse_mdoc_head(struct mpage *mpage, 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(MDOC_HEAD == n->type);
         hash_put(hash, buf, TYPE_FUNCTION);  
 }  }
   
   static int
 /* ARGSUSED */  parse_mdoc_body(struct mpage *mpage, const struct mdoc_node *n)
 static void  
 pmdoc_Nd(MDOC_ARGS)  
 {  {
   
         if (MDOC_BODY != n->type)          return(MDOC_BODY == n->type);
                 return;  
   
         buf_appendmdoc(dbuf, n->child, 1);  
         buf_appendmdoc(buf, n->child, 0);  
   
         hash_put(hash, buf, TYPE_DESC);  
 }  }
   
 /* ARGSUSED */  /*
    * Add a string to the hash table for the current manual.
    * Each string has a bitmask telling which macros it belongs to.
    * When we finish the manual, we'll dump the table.
    */
 static void  static void
 pmdoc_Er(MDOC_ARGS)  putkeys(const struct mpage *mpage,
           const char *cp, size_t sz, uint64_t v)
 {  {
           struct str      *s;
           unsigned int     slot;
           const char      *end;
   
         if (SEC_ERRORS != n->sec)          if (0 == sz)
                 return;                  return;
   
         buf_appendmdoc(buf, n->child, 0);  
         hash_put(hash, buf, TYPE_ERR);  
 }  
   
 /* ARGSUSED */          end = cp + sz;
 static void          slot = ohash_qlookupi(&strings, cp, &end);
 pmdoc_Ev(MDOC_ARGS)          s = ohash_find(&strings, slot);
 {  
   
         if (SEC_ENVIRONMENT != n->sec)          if (NULL != s && mpage == s->mpage) {
                   s->mask |= v;
                 return;                  return;
           } else if (NULL == s) {
         buf_appendmdoc(buf, n->child, 0);                  s = mandoc_calloc(sizeof(struct str) + sz + 1, 1);
         hash_put(hash, buf, TYPE_ENV);                  memcpy(s->key, cp, sz);
                   ohash_insert(&strings, slot, s);
           }
           s->mpage = mpage;
           s->mask = v;
 }  }
   
 /* ARGSUSED */  /*
 static void   * Take a Unicode codepoint and produce its UTF-8 encoding.
 pmdoc_Pa(MDOC_ARGS)   * 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;
   
         if (SEC_FILES != n->sec)          rc = 0;
                 return;          if (cp <= 0x0000007F) {
                   rc = 1;
         buf_appendmdoc(buf, n->child, 0);                  out[0] = (char)cp;
         hash_put(hash, buf, TYPE_PATH);          } else if (cp <= 0x000007FF) {
                   rc = 2;
                   out[0] = (cp >> 6  & 31) | 192;
                   out[1] = (cp       & 63) | 128;
           } else if (cp <= 0x0000FFFF) {
                   rc = 3;
                   out[0] = (cp >> 12 & 15) | 224;
                   out[1] = (cp >> 6  & 63) | 128;
                   out[2] = (cp       & 63) | 128;
           } else if (cp <= 0x001FFFFF) {
                   rc = 4;
                   out[0] = (cp >> 18 &  7) | 240;
                   out[1] = (cp >> 12 & 63) | 128;
                   out[2] = (cp >> 6  & 63) | 128;
                   out[3] = (cp       & 63) | 128;
           } else if (cp <= 0x03FFFFFF) {
                   rc = 5;
                   out[0] = (cp >> 24 &  3) | 248;
                   out[1] = (cp >> 18 & 63) | 128;
                   out[2] = (cp >> 12 & 63) | 128;
                   out[3] = (cp >> 6  & 63) | 128;
                   out[4] = (cp       & 63) | 128;
           } else if (cp <= 0x7FFFFFFF) {
                   rc = 6;
                   out[0] = (cp >> 30 &  1) | 252;
                   out[1] = (cp >> 24 & 63) | 128;
                   out[2] = (cp >> 18 & 63) | 128;
                   out[3] = (cp >> 12 & 63) | 128;
                   out[4] = (cp >> 6  & 63) | 128;
                   out[5] = (cp       & 63) | 128;
           } else
                   return(0);
   
           out[rc] = '\0';
           return(rc);
 }  }
   
 /* ARGSUSED */  /*
    * Store the rendered version of a key, or alias the pointer
    * if the key contains no escape sequences.
    */
 static void  static void
 pmdoc_Nm(MDOC_ARGS)  render_key(struct mchars *mc, struct str *key)
 {  {
           size_t           sz, bsz, pos;
         if (SEC_NAME == n->sec) {          char             utfbuf[7], res[5];
                 buf_appendmdoc(buf, n->child, 0);          char            *buf;
                 hash_put(hash, buf, TYPE_NAME);          const char      *seq, *cpp, *val;
           int              len, u;
           enum mandoc_esc  esc;
   
           assert(NULL == key->rendered);
   
           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->rendered = key->key;
                 return;                  return;
         } else if (SEC_SYNOPSIS != n->sec || MDOC_HEAD != n->type)          }
                 return;  
   
         if (NULL == n->child)          /* Pre-allocate by the length of the input */
                 buf_append(buf, m->name);  
   
         buf_appendmdoc(buf, n->child, 0);          buf = mandoc_malloc(++bsz);
         hash_put(hash, buf, TYPE_UTILITY);          pos = 0;
   
           while ('\0' != *val) {
                   /*
                    * Halt on the first escape sequence.
                    * This also halts on the end of string, in which case
                    * we just copy, fallthrough, and exit the loop.
                    */
                   if ((sz = strcspn(val, res)) > 0) {
                           memcpy(&buf[pos], val, sz);
                           pos += sz;
                           val += sz;
                   }
   
                   if (ASCII_HYPH == *val) {
                           buf[pos++] = '-';
                           val++;
                           continue;
                   } else if ('\t' == *val || ASCII_NBRSP == *val) {
                           buf[pos++] = ' ';
                           val++;
                           continue;
                   } else if ('\\' != *val)
                           break;
   
                   /* Read past the slash. */
   
                   val++;
   
                   /*
                    * Parse the escape sequence and see if it's a
                    * predefined character or special character.
                    */
   
                   esc = mandoc_escape
                           ((const char **)&val, &seq, &len);
                   if (ESCAPE_ERROR == esc)
                           break;
                   if (ESCAPE_SPECIAL != esc)
                           continue;
   
                   /*
                    * Render the special character
                    * as either UTF-8 or ASCII.
                    */
   
                   if (write_utf8) {
                           if (0 == (u = mchars_spec2cp(mc, seq, len)))
                                   continue;
                           cpp = utfbuf;
                           if (0 == (sz = utf8(u, utfbuf)))
                                   continue;
                           sz = strlen(cpp);
                   } else {
                           cpp = mchars_spec2str(mc, seq, len, &sz);
                           if (NULL == cpp)
                                   continue;
                           if (ASCII_NBRSP == *cpp) {
                                   cpp = " ";
                                   sz = 1;
                           }
                   }
   
                   /* Copy the rendered glyph into the stream. */
   
                   bsz += sz;
                   buf = mandoc_realloc(buf, bsz);
                   memcpy(&buf[pos], cpp, sz);
                   pos += sz;
           }
   
           buf[pos] = '\0';
           key->rendered = buf;
 }  }
   
   /*
    * 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, handle escape sequences at the last possible moment.
    */
 static void  static void
 hash_put(DB *db, const struct buf *buf, int mask)  dbindex(const struct mpage *mpage, struct mchars *mc)
 {  {
         DBT              key, val;          struct mlink    *mlink;
         int              rc;          struct str      *key;
           int64_t          recno;
           size_t           i;
           unsigned int     slot;
   
         if (buf->len < 2)          if (verb)
                   say(mpage->mlinks->file, "Adding to index");
   
           if (nodb)
                 return;                  return;
   
         key.data = buf->cp;          SQL_EXEC("BEGIN TRANSACTION");
         key.size = buf->len;  
   
         if ((rc = (*db->get)(db, &key, &val, 0)) < 0) {          i = 1;
                 perror("hash");          SQL_BIND_INT(stmts[STMT_INSERT_PAGE], i, FORM_SRC == mpage->form);
                 exit((int)MANDOCLEVEL_SYSERR);          SQL_STEP(stmts[STMT_INSERT_PAGE]);
         } else if (0 == rc)          recno = sqlite3_last_insert_rowid(db);
                 mask |= *(int *)val.data;          sqlite3_reset(stmts[STMT_INSERT_PAGE]);
   
         val.data = &mask;          for (mlink = mpage->mlinks; mlink; mlink = mlink->next) {
         val.size = sizeof(int);                  i = 1;
                   SQL_BIND_TEXT(stmts[STMT_INSERT_LINK], i, mlink->file);
                   SQL_BIND_TEXT(stmts[STMT_INSERT_LINK], i, mlink->dsec);
                   SQL_BIND_TEXT(stmts[STMT_INSERT_LINK], i, mlink->arch);
                   SQL_BIND_TEXT(stmts[STMT_INSERT_LINK], i, mlink->name);
                   SQL_BIND_INT64(stmts[STMT_INSERT_LINK], i, recno);
                   SQL_STEP(stmts[STMT_INSERT_LINK]);
                   sqlite3_reset(stmts[STMT_INSERT_LINK]);
           }
   
         if ((rc = (*db->put)(db, &key, &val, 0)) < 0) {          for (key = ohash_first(&strings, &slot); NULL != key;
                 perror("hash");               key = ohash_next(&strings, &slot)) {
                 exit((int)MANDOCLEVEL_SYSERR);                  assert(key->mpage == mpage);
         }                  if (NULL == key->rendered)
                           render_key(mc, key);
                   i = 1;
                   SQL_BIND_INT64(stmts[STMT_INSERT_KEY], i, key->mask);
                   SQL_BIND_TEXT(stmts[STMT_INSERT_KEY], i, key->rendered);
                   SQL_BIND_INT64(stmts[STMT_INSERT_KEY], i, recno);
                   SQL_STEP(stmts[STMT_INSERT_KEY]);
                   sqlite3_reset(stmts[STMT_INSERT_KEY]);
                   if (key->rendered != key->key)
                           free(key->rendered);
                   free(key);
           }
   
           SQL_EXEC("END TRANSACTION");
 }  }
   
 static void  static void
 dbt_put(DB *db, const char *dbn, DBT *key, DBT *val)  dbprune(void)
 {  {
           struct mpage    *mpage;
           struct mlink    *mlink;
           size_t           i;
           unsigned int     slot;
   
         assert(key->size);          if (nodb)
         assert(val->size);  
   
         if (0 == (*db->put)(db, key, val, 0))  
                 return;                  return;
   
         perror(dbn);          mpage = ohash_first(&mpages, &slot);
         exit((int)MANDOCLEVEL_SYSERR);          while (NULL != mpage) {
         /* NOTREACHED */                  mlink = mpage->mlinks;
                   i = 1;
                   SQL_BIND_TEXT(stmts[STMT_DELETE_PAGE], i, mlink->file);
                   SQL_STEP(stmts[STMT_DELETE_PAGE]);
                   sqlite3_reset(stmts[STMT_DELETE_PAGE]);
                   if (verb)
                           say(mlink->file, "Deleted from index");
                   mpage = ohash_next(&mpages, &slot);
           }
 }  }
   
 /*  /*
  * Call out to per-macro handlers after clearing the persistent database   * Close an existing database and its prepared statements.
  * key.  If the macro sets the database key, flush it to the database.   * If "real" is not set, rename the temporary file into the real one.
  */   */
 static void  static void
 pmdoc_node(MDOC_ARGS)  dbclose(int real)
 {  {
           size_t           i;
   
         if (NULL == n)          if (nodb)
                 return;                  return;
   
         switch (n->type) {          for (i = 0; i < STMT__MAX; i++) {
         case (MDOC_HEAD):                  sqlite3_finalize(stmts[i]);
                 /* FALLTHROUGH */                  stmts[i] = NULL;
         case (MDOC_BODY):  
                 /* FALLTHROUGH */  
         case (MDOC_TAIL):  
                 /* FALLTHROUGH */  
         case (MDOC_BLOCK):  
                 /* FALLTHROUGH */  
         case (MDOC_ELEM):  
                 if (NULL == mdocs[n->tok])  
                         break;  
   
                 buf->len = 0;  
                 (*mdocs[n->tok])(hash, buf, dbuf, n, m);  
                 break;  
         default:  
                 break;  
         }          }
   
         pmdoc_node(hash, buf, dbuf, n->child, m);          sqlite3_close(db);
         pmdoc_node(hash, buf, dbuf, n->next, m);          db = NULL;
   
           if (real)
                   return;
   
           if (-1 == rename(MANDOC_DB "~", MANDOC_DB)) {
                   exitcode = (int)MANDOCLEVEL_SYSERR;
                   say(MANDOC_DB, NULL);
           }
 }  }
   
   /*
    * This is straightforward stuff.
    * Open a database connection to a "temporary" database, then open a set
    * of prepared statements we'll use over and over again.
    * If "real" is set, we use the existing database; if not, we truncate a
    * temporary one.
    * Must be matched by dbclose().
    */
 static int  static int
 pman_node(MAN_ARGS)  dbopen(int real)
 {  {
         const struct man_node *head, *body;          const char      *file, *sql;
         const char      *start, *sv;          int              rc, ofl;
         size_t           sz;  
   
         if (NULL == n)          if (nodb)
                   return(1);
   
           ofl = SQLITE_OPEN_READWRITE;
           if (0 == real) {
                   file = MANDOC_DB "~";
                   if (-1 == remove(file) && ENOENT != errno) {
                           exitcode = (int)MANDOCLEVEL_SYSERR;
                           say(file, NULL);
                           return(0);
                   }
                   ofl |= SQLITE_OPEN_EXCLUSIVE;
           } else
                   file = MANDOC_DB;
   
           rc = sqlite3_open_v2(file, &db, ofl, NULL);
           if (SQLITE_OK == rc)
                   goto prepare_statements;
           if (SQLITE_CANTOPEN != rc) {
                   exitcode = (int)MANDOCLEVEL_SYSERR;
                   say(file, NULL);
                 return(0);                  return(0);
           }
   
         /*          sqlite3_close(db);
          * We're only searching for one thing: the first text child in          db = NULL;
          * 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) {          if (SQLITE_OK != (rc = sqlite3_open(file, &db))) {
                 body = n;                  exitcode = (int)MANDOCLEVEL_SYSERR;
                 assert(body->parent);                  say(file, NULL);
                 if (NULL != (head = body->parent->head) &&                  return(0);
                                 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);          sql = "CREATE TABLE \"mpages\" (\n"
                         start = sv = body->string;                " \"form\" INTEGER NOT NULL,\n"
                 " \"id\" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL\n"
                 ");\n"
                 "\n"
                 "CREATE TABLE \"mlinks\" (\n"
                 " \"file\" TEXT NOT NULL,\n"
                 " \"sec\" TEXT NOT NULL,\n"
                 " \"arch\" TEXT NOT NULL,\n"
                 " \"name\" TEXT NOT NULL,\n"
                 " \"pageid\" INTEGER NOT NULL REFERENCES mpages(id) "
                   "ON DELETE CASCADE,\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"
                 " \"pageid\" INTEGER NOT NULL REFERENCES mpages(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)) {
                          * Go through a special heuristic dance here.                  exitcode = (int)MANDOCLEVEL_SYSERR;
                          * This is why -man manuals are great!                  say(file, "%s", sqlite3_errmsg(db));
                          * (I'm being sarcastic: my eyes are bleeding.)                  return(0);
                          * 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 ( ;; ) {  prepare_statements:
                                 sz = strcspn(start, " ,");          SQL_EXEC("PRAGMA foreign_keys = ON");
                                 if ('\0' == start[(int)sz])          sql = "DELETE FROM mpages where file=?";
                                         break;          sqlite3_prepare_v2(db, sql, -1, &stmts[STMT_DELETE_PAGE], NULL);
           sql = "INSERT INTO mpages "
                   "(form) VALUES (?)";
           sqlite3_prepare_v2(db, sql, -1, &stmts[STMT_INSERT_PAGE], NULL);
           sql = "INSERT INTO mlinks "
                   "(file,sec,arch,name,pageid) VALUES (?,?,?,?,?)";
           sqlite3_prepare_v2(db, sql, -1, &stmts[STMT_INSERT_LINK], NULL);
           sql = "INSERT INTO keys "
                   "(bits,key,pageid) VALUES (?,?,?)";
           sqlite3_prepare_v2(db, sql, -1, &stmts[STMT_INSERT_KEY], NULL);
   
                                 buf->len = 0;  #ifndef __APPLE__
                                 buf_appendb(buf, start, sz);          /*
                                 buf_appendb(buf, "", 1);           * When opening a new database, we can turn off
            * synchronous mode for much better performance.
            */
   
                                 hash_put(hash, buf, TYPE_NAME);          if (real)
                   SQL_EXEC("PRAGMA synchronous = OFF");
   #endif
   
                                 if (' ' == start[(int)sz]) {          return(1);
                                         start += (int)sz + 1;  }
                                         break;  
                                 }  
   
                                 assert(',' == start[(int)sz]);  static void *
                                 start += (int)sz + 1;  hash_halloc(size_t sz, void *arg)
                                 while (' ' == *start)  {
                                         start++;  
                         }  
   
                         buf->len = 0;          return(mandoc_calloc(sz, 1));
   }
   
                         if (sv == start) {  static void *
                                 buf_append(buf, start);  hash_alloc(size_t sz, void *arg)
                                 return(1);  {
                         }  
   
                         while (' ' == *start)          return(mandoc_malloc(sz));
                                 start++;  }
   
                         if (0 == strncmp(start, "-", 1))  static void
                                 start += 1;  hash_free(void *p, size_t sz, void *arg)
                         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)          free(p);
                                 start++;  }
   
                         sz = strlen(start) + 1;  static int
                         buf_appendb(dbuf, start, sz);  set_basedir(const char *targetdir)
                         buf_appendb(buf, start, sz);  {
           static char      startdir[PATH_MAX];
           static int       fd;
   
                         hash_put(hash, buf, TYPE_DESC);          /*
            * Remember where we started by keeping a fd open to the origin
            * path component: throughout this utility, we chdir() a lot to
            * handle relative paths, and by doing this, we can return to
            * the starting point.
            */
           if ('\0' == *startdir) {
                   if (NULL == getcwd(startdir, PATH_MAX)) {
                           exitcode = (int)MANDOCLEVEL_SYSERR;
                           if (NULL != targetdir)
                                   say(".", NULL);
                           return(0);
                 }                  }
                   if (-1 == (fd = open(startdir, O_RDONLY, 0))) {
                           exitcode = (int)MANDOCLEVEL_SYSERR;
                           say(startdir, NULL);
                           return(0);
                   }
                   if (NULL == targetdir)
                           targetdir = startdir;
           } else {
                   if (-1 == fd)
                           return(0);
                   if (-1 == fchdir(fd)) {
                           close(fd);
                           basedir[0] = '\0';
                           exitcode = (int)MANDOCLEVEL_SYSERR;
                           say(startdir, NULL);
                           return(0);
                   }
                   if (NULL == targetdir) {
                           close(fd);
                           return(1);
                   }
         }          }
           if (NULL == realpath(targetdir, basedir)) {
         if (pman_node(hash, buf, dbuf, n->child))                  basedir[0] = '\0';
                 return(1);                  exitcode = (int)MANDOCLEVEL_BADARG;
         if (pman_node(hash, buf, dbuf, n->next))                  say(targetdir, NULL);
                 return(1);                  return(0);
           } else if (-1 == chdir(basedir)) {
         return(0);                  exitcode = (int)MANDOCLEVEL_BADARG;
                   say("", NULL);
                   return(0);
           }
           return(1);
 }  }
   
 static void  static void
 usage(void)  say(const char *file, const char *format, ...)
 {  {
           va_list          ap;
   
         fprintf(stderr, "usage: %s [-ruv] [-d path] [file...]\n",          if ('\0' != *basedir)
                         progname);                  fprintf(stderr, "%s", basedir);
           if ('\0' != *basedir && '\0' != *file)
                   fputs("//", stderr);
           if ('\0' != *file)
                   fprintf(stderr, "%s", file);
           fputs(": ", stderr);
   
           if (NULL == format) {
                   perror(NULL);
                   return;
           }
   
           va_start(ap, format);
           vfprintf(stderr, format, ap);
           va_end(ap);
   
           fputc('\n', stderr);
 }  }
Legend:
Removed from v.1.2  
changed lines
  Added in v.1.103
CVSweb