version 1.5, 2011/07/15 17:59:29 |
version 1.84, 2013/12/27 15:39:03 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv> |
|
* Copyright (c) 2011, 2012, 2013 Ingo Schwarze <schwarze@openbsd.org> |
* |
* |
* Permission to use, copy, modify, and distribute this software for any |
* Permission to use, copy, modify, and distribute this software for any |
* purpose with or without fee is hereby granted, provided that the above |
* purpose with or without fee is hereby granted, provided that the above |
|
|
#include "config.h" |
#include "config.h" |
#endif |
#endif |
|
|
#include <sys/param.h> |
#include <sys/stat.h> |
|
|
#include <assert.h> |
#include <assert.h> |
#include <dirent.h> |
#include <ctype.h> |
|
#include <errno.h> |
#include <fcntl.h> |
#include <fcntl.h> |
|
#include <fts.h> |
#include <getopt.h> |
#include <getopt.h> |
|
#include <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_SLOP 1024 |
#define SQL_BIND_TEXT(_s, _i, _v) \ |
|
if (SQLITE_OK != sqlite3_bind_text \ |
|
((_s), (_i)++, (_v), -1, SQLITE_STATIC)) \ |
|
fprintf(stderr, "%s\n", sqlite3_errmsg(db)) |
|
#define SQL_BIND_INT(_s, _i, _v) \ |
|
if (SQLITE_OK != sqlite3_bind_int \ |
|
((_s), (_i)++, (_v))) \ |
|
fprintf(stderr, "%s\n", sqlite3_errmsg(db)) |
|
#define SQL_BIND_INT64(_s, _i, _v) \ |
|
if (SQLITE_OK != sqlite3_bind_int64 \ |
|
((_s), (_i)++, (_v))) \ |
|
fprintf(stderr, "%s\n", sqlite3_errmsg(db)) |
|
#define SQL_STEP(_s) \ |
|
if (SQLITE_DONE != sqlite3_step((_s))) \ |
|
fprintf(stderr, "%s\n", sqlite3_errmsg(db)) |
|
|
/* 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 |
|
|
|
/* Tiny list for files. No need to bring in QUEUE. */ |
struct str { |
|
char *utf8; /* key in UTF-8 form */ |
|
const struct mpage *mpage; /* if set, the owning parse */ |
|
uint64_t mask; /* bitmask in sequence */ |
|
char key[]; /* the string itself */ |
|
}; |
|
|
struct of { |
struct inodev { |
char *fname; /* heap-allocated */ |
ino_t st_ino; |
struct of *next; /* NULL for last one */ |
dev_t st_dev; |
struct of *first; /* first in list */ |
|
}; |
}; |
|
|
/* Buffer for storing growable data. */ |
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 */ |
|
}; |
|
|
struct buf { |
struct mlink { |
char *cp; |
char file[PATH_MAX]; /* filename rel. to manpath */ |
size_t len; /* current length */ |
enum form dform; /* format from directory */ |
size_t size; /* total buffer size */ |
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 */ |
}; |
}; |
|
|
/* Operation we're going to perform. */ |
struct title { |
|
char *title; /* name(sec/arch) given inside the file */ |
|
char *file; /* file name in case of mismatch */ |
|
}; |
|
|
enum op { |
enum stmt { |
OP_NEW = 0, /* new database */ |
STMT_DELETE_PAGE = 0, /* delete mpage */ |
OP_UPDATE, /* delete/add entries in existing database */ |
STMT_INSERT_PAGE, /* insert mpage */ |
OP_DELETE /* delete entries from existing database */ |
STMT_INSERT_LINK, /* insert mlink */ |
|
STMT_INSERT_KEY, /* insert parsed key */ |
|
STMT__MAX |
}; |
}; |
|
|
#define MAN_ARGS DB *hash, \ |
typedef int (*mdoc_fp)(struct mpage *, const struct mdoc_node *); |
struct buf *buf, \ |
|
struct buf *dbuf, \ |
|
const struct man_node *n |
|
#define MDOC_ARGS DB *hash, \ |
|
struct buf *buf, \ |
|
struct buf *dbuf, \ |
|
const struct mdoc_node *n, \ |
|
const struct mdoc_meta *m |
|
|
|
static void buf_appendmdoc(struct buf *, |
struct mdoc_handler { |
const struct mdoc_node *, int); |
mdoc_fp fp; /* optional handler */ |
static void buf_append(struct buf *, const char *); |
uint64_t mask; /* set unless handler returns 0 */ |
static void buf_appendb(struct buf *, |
}; |
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 void index_merge(const struct of *, struct mparse *, |
|
struct buf *, struct buf *, |
|
DB *, DB *, const char *, |
|
DB *, const char *, int, |
|
recno_t, const recno_t *, size_t); |
|
static void index_prune(const struct of *, DB *, |
|
const char *, DB *, const char *, |
|
int, recno_t *, recno_t **, size_t *); |
|
static void ofile_argbuild(char *[], int, int, struct of **); |
|
static int ofile_dirbuild(const char *, int, struct of **); |
|
static void ofile_free(struct of *); |
|
static int pman_node(MAN_ARGS); |
|
static void pmdoc_node(MDOC_ARGS); |
|
static void pmdoc_An(MDOC_ARGS); |
|
static void pmdoc_Cd(MDOC_ARGS); |
|
static void pmdoc_Er(MDOC_ARGS); |
|
static void pmdoc_Ev(MDOC_ARGS); |
|
static void pmdoc_Fd(MDOC_ARGS); |
|
static void pmdoc_In(MDOC_ARGS); |
|
static void pmdoc_Fn(MDOC_ARGS); |
|
static void pmdoc_Fo(MDOC_ARGS); |
|
static void pmdoc_Nd(MDOC_ARGS); |
|
static void pmdoc_Nm(MDOC_ARGS); |
|
static void pmdoc_Pa(MDOC_ARGS); |
|
static void pmdoc_St(MDOC_ARGS); |
|
static void pmdoc_Vt(MDOC_ARGS); |
|
static void pmdoc_Xr(MDOC_ARGS); |
|
static void usage(void); |
|
|
|
typedef void (*pmdoc_nf)(MDOC_ARGS); |
static void dbclose(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 int inocheck(const struct stat *); |
|
static void mlink_add(struct mlink *, const struct stat *); |
|
static void mlink_free(struct mlink *); |
|
static void mpages_free(void); |
|
static void mpages_merge(struct mchars *, struct mparse *, int); |
|
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_In(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_St(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 say(const char *, const char *, ...); |
|
static int set_basedir(const char *); |
|
static int treescan(void); |
|
static size_t utf8(unsigned int, char [7]); |
|
static void utf8key(struct mchars *, struct str *); |
|
|
static const pmdoc_nf mdocs[MDOC_MAX] = { |
static char *progname; |
NULL, /* Ap */ |
static int use_all; /* use all found files */ |
NULL, /* Dd */ |
static int nodb; /* no database changes */ |
NULL, /* Dt */ |
static int verb; /* print what we're doing */ |
NULL, /* Os */ |
static int warnings; /* warn about crap */ |
NULL, /* Sh */ |
static int exitcode; /* to be returned by main */ |
NULL, /* Ss */ |
static enum op op; /* operational mode */ |
NULL, /* Pp */ |
static char basedir[PATH_MAX]; /* current base directory */ |
NULL, /* D1 */ |
static struct ohash mpages; /* table of distinct manual pages */ |
NULL, /* Dl */ |
static struct ohash mlinks; /* table of directory entries */ |
NULL, /* Bd */ |
static struct ohash strings; /* table of all strings */ |
NULL, /* Ed */ |
static sqlite3 *db = NULL; /* current database */ |
NULL, /* Bl */ |
static sqlite3_stmt *stmts[STMT__MAX]; /* current statements */ |
NULL, /* El */ |
|
NULL, /* It */ |
static const struct mdoc_handler mdocs[MDOC_MAX] = { |
NULL, /* Ad */ |
{ NULL, 0 }, /* Ap */ |
pmdoc_An, /* An */ |
{ NULL, 0 }, /* Dd */ |
NULL, /* Ar */ |
{ NULL, 0 }, /* Dt */ |
pmdoc_Cd, /* Cd */ |
{ NULL, 0 }, /* Os */ |
NULL, /* Cm */ |
{ parse_mdoc_Sh, TYPE_Sh }, /* Sh */ |
NULL, /* Dv */ |
{ parse_mdoc_head, TYPE_Ss }, /* Ss */ |
pmdoc_Er, /* Er */ |
{ NULL, 0 }, /* Pp */ |
pmdoc_Ev, /* Ev */ |
{ NULL, 0 }, /* D1 */ |
NULL, /* Ex */ |
{ NULL, 0 }, /* Dl */ |
NULL, /* Fa */ |
{ NULL, 0 }, /* Bd */ |
pmdoc_Fd, /* Fd */ |
{ NULL, 0 }, /* Ed */ |
NULL, /* Fl */ |
{ NULL, 0 }, /* Bl */ |
pmdoc_Fn, /* Fn */ |
{ NULL, 0 }, /* El */ |
NULL, /* Ft */ |
{ NULL, 0 }, /* It */ |
NULL, /* Ic */ |
{ NULL, 0 }, /* Ad */ |
pmdoc_In, /* In */ |
{ NULL, TYPE_An }, /* An */ |
NULL, /* Li */ |
{ NULL, TYPE_Ar }, /* Ar */ |
pmdoc_Nd, /* Nd */ |
{ NULL, TYPE_Cd }, /* Cd */ |
pmdoc_Nm, /* Nm */ |
{ NULL, TYPE_Cm }, /* Cm */ |
NULL, /* Op */ |
{ NULL, TYPE_Dv }, /* Dv */ |
NULL, /* Ot */ |
{ NULL, TYPE_Er }, /* Er */ |
pmdoc_Pa, /* Pa */ |
{ NULL, TYPE_Ev }, /* Ev */ |
NULL, /* Rv */ |
{ NULL, 0 }, /* Ex */ |
pmdoc_St, /* St */ |
{ NULL, TYPE_Fa }, /* Fa */ |
pmdoc_Vt, /* Va */ |
{ parse_mdoc_Fd, 0 }, /* Fd */ |
pmdoc_Vt, /* Vt */ |
{ NULL, TYPE_Fl }, /* Fl */ |
pmdoc_Xr, /* Xr */ |
{ parse_mdoc_Fn, 0 }, /* Fn */ |
NULL, /* %A */ |
{ NULL, TYPE_Ft }, /* Ft */ |
NULL, /* %B */ |
{ NULL, TYPE_Ic }, /* Ic */ |
NULL, /* %D */ |
{ parse_mdoc_In, TYPE_In }, /* In */ |
NULL, /* %I */ |
{ NULL, TYPE_Li }, /* Li */ |
NULL, /* %J */ |
{ parse_mdoc_Nd, TYPE_Nd }, /* Nd */ |
NULL, /* %N */ |
{ parse_mdoc_Nm, TYPE_Nm }, /* Nm */ |
NULL, /* %O */ |
{ NULL, 0 }, /* Op */ |
NULL, /* %P */ |
{ NULL, 0 }, /* Ot */ |
NULL, /* %R */ |
{ NULL, TYPE_Pa }, /* Pa */ |
NULL, /* %T */ |
{ NULL, 0 }, /* Rv */ |
NULL, /* %V */ |
{ parse_mdoc_St, 0 }, /* St */ |
NULL, /* Ac */ |
{ NULL, TYPE_Va }, /* Va */ |
NULL, /* Ao */ |
{ parse_mdoc_body, TYPE_Va }, /* Vt */ |
NULL, /* Aq */ |
{ parse_mdoc_Xr, 0 }, /* Xr */ |
NULL, /* At */ |
{ NULL, 0 }, /* %A */ |
NULL, /* Bc */ |
{ NULL, 0 }, /* %B */ |
NULL, /* Bf */ |
{ NULL, 0 }, /* %D */ |
NULL, /* Bo */ |
{ NULL, 0 }, /* %I */ |
NULL, /* Bq */ |
{ NULL, 0 }, /* %J */ |
NULL, /* Bsx */ |
{ NULL, 0 }, /* %N */ |
NULL, /* Bx */ |
{ NULL, 0 }, /* %O */ |
NULL, /* Db */ |
{ NULL, 0 }, /* %P */ |
NULL, /* Dc */ |
{ NULL, 0 }, /* %R */ |
NULL, /* Do */ |
{ NULL, 0 }, /* %T */ |
NULL, /* Dq */ |
{ NULL, 0 }, /* %V */ |
NULL, /* Ec */ |
{ NULL, 0 }, /* Ac */ |
NULL, /* Ef */ |
{ NULL, 0 }, /* Ao */ |
NULL, /* Em */ |
{ NULL, 0 }, /* Aq */ |
NULL, /* Eo */ |
{ NULL, TYPE_At }, /* At */ |
NULL, /* Fx */ |
{ NULL, 0 }, /* Bc */ |
NULL, /* Ms */ |
{ NULL, 0 }, /* Bf */ |
NULL, /* No */ |
{ NULL, 0 }, /* Bo */ |
NULL, /* Ns */ |
{ NULL, 0 }, /* Bq */ |
NULL, /* Nx */ |
{ NULL, TYPE_Bsx }, /* Bsx */ |
NULL, /* Ox */ |
{ NULL, TYPE_Bx }, /* Bx */ |
NULL, /* Pc */ |
{ NULL, 0 }, /* Db */ |
NULL, /* Pf */ |
{ NULL, 0 }, /* Dc */ |
NULL, /* Po */ |
{ NULL, 0 }, /* Do */ |
NULL, /* Pq */ |
{ NULL, 0 }, /* Dq */ |
NULL, /* Qc */ |
{ NULL, 0 }, /* Ec */ |
NULL, /* Ql */ |
{ NULL, 0 }, /* Ef */ |
NULL, /* Qo */ |
{ NULL, TYPE_Em }, /* Em */ |
NULL, /* Qq */ |
{ NULL, 0 }, /* Eo */ |
NULL, /* Re */ |
{ NULL, TYPE_Fx }, /* Fx */ |
NULL, /* Rs */ |
{ NULL, TYPE_Ms }, /* Ms */ |
NULL, /* Sc */ |
{ NULL, 0 }, /* No */ |
NULL, /* So */ |
{ NULL, 0 }, /* Ns */ |
NULL, /* Sq */ |
{ NULL, TYPE_Nx }, /* Nx */ |
NULL, /* Sm */ |
{ NULL, TYPE_Ox }, /* Ox */ |
NULL, /* Sx */ |
{ NULL, 0 }, /* Pc */ |
NULL, /* Sy */ |
{ NULL, 0 }, /* Pf */ |
NULL, /* Tn */ |
{ NULL, 0 }, /* Po */ |
NULL, /* Ux */ |
{ NULL, 0 }, /* Pq */ |
NULL, /* Xc */ |
{ NULL, 0 }, /* Qc */ |
NULL, /* Xo */ |
{ NULL, 0 }, /* Ql */ |
pmdoc_Fo, /* Fo */ |
{ NULL, 0 }, /* Qo */ |
NULL, /* Fc */ |
{ NULL, 0 }, /* Qq */ |
NULL, /* Oo */ |
{ NULL, 0 }, /* Re */ |
NULL, /* Oc */ |
{ NULL, 0 }, /* Rs */ |
NULL, /* Bk */ |
{ NULL, 0 }, /* Sc */ |
NULL, /* Ek */ |
{ NULL, 0 }, /* So */ |
NULL, /* Bt */ |
{ NULL, 0 }, /* Sq */ |
NULL, /* Hf */ |
{ NULL, 0 }, /* Sm */ |
NULL, /* Fr */ |
{ NULL, 0 }, /* Sx */ |
NULL, /* Ud */ |
{ NULL, TYPE_Sy }, /* Sy */ |
NULL, /* Lb */ |
{ NULL, TYPE_Tn }, /* Tn */ |
NULL, /* Lp */ |
{ NULL, 0 }, /* Ux */ |
NULL, /* Lk */ |
{ NULL, 0 }, /* Xc */ |
NULL, /* Mt */ |
{ NULL, 0 }, /* Xo */ |
NULL, /* Brq */ |
{ parse_mdoc_head, 0 }, /* Fo */ |
NULL, /* Bro */ |
{ NULL, 0 }, /* Fc */ |
NULL, /* Brc */ |
{ NULL, 0 }, /* Oo */ |
NULL, /* %C */ |
{ NULL, 0 }, /* Oc */ |
NULL, /* Es */ |
{ NULL, 0 }, /* Bk */ |
NULL, /* En */ |
{ NULL, 0 }, /* Ek */ |
NULL, /* Dx */ |
{ NULL, 0 }, /* Bt */ |
NULL, /* %Q */ |
{ NULL, 0 }, /* Hf */ |
NULL, /* br */ |
{ NULL, 0 }, /* Fr */ |
NULL, /* sp */ |
{ NULL, 0 }, /* Ud */ |
NULL, /* %U */ |
{ NULL, TYPE_Lb }, /* Lb */ |
NULL, /* Ta */ |
{ 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 */ |
}; |
}; |
|
|
static const char *progname; |
|
|
|
int |
int |
main(int argc, char *argv[]) |
main(int argc, char *argv[]) |
{ |
{ |
struct mparse *mp; /* parse sequence */ |
int ch, i; |
enum op op; /* current operation */ |
size_t j, sz; |
const char *dir; |
const char *path_arg; |
char ibuf[MAXPATHLEN], /* index fname */ |
struct mchars *mc; |
fbuf[MAXPATHLEN]; /* btree fname */ |
struct manpaths dirs; |
int verb, /* output verbosity */ |
struct mparse *mp; |
ch, i, flags; |
struct ohash_info mpages_info, mlinks_info; |
DB *idx, /* index database */ |
|
*db, /* keyword database */ |
|
*hash; /* temporary keyword hashtable */ |
|
BTREEINFO info; /* btree configuration */ |
|
recno_t maxrec; /* supremum of all records */ |
|
recno_t *recs; /* buffer of empty records */ |
|
size_t sz1, sz2, |
|
recsz, /* buffer size of recs */ |
|
reccur; /* valid number of recs */ |
|
struct buf buf, /* keyword buffer */ |
|
dbuf; /* description buffer */ |
|
struct of *of; /* list of files for processing */ |
|
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; |
|
|
verb = 0; |
/* |
of = NULL; |
* 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; \ |
dir = NULL; |
} while (/*CONSTCOND*/0) |
|
|
while (-1 != (ch = getopt(argc, argv, "d:u:v"))) |
path_arg = NULL; |
|
op = OP_DEFAULT; |
|
|
|
while (-1 != (ch = getopt(argc, argv, "aC:d:ntu:vW"))) |
switch (ch) { |
switch (ch) { |
|
case ('a'): |
|
use_all = 1; |
|
break; |
|
case ('C'): |
|
CHECKOP(op, ch); |
|
path_arg = optarg; |
|
op = OP_CONFFILE; |
|
break; |
case ('d'): |
case ('d'): |
dir = optarg; |
CHECKOP(op, ch); |
|
path_arg = optarg; |
op = OP_UPDATE; |
op = OP_UPDATE; |
break; |
break; |
|
case ('n'): |
|
nodb = 1; |
|
break; |
|
case ('t'): |
|
CHECKOP(op, ch); |
|
dup2(STDOUT_FILENO, STDERR_FILENO); |
|
op = OP_TEST; |
|
nodb = warnings = 1; |
|
break; |
case ('u'): |
case ('u'): |
dir = optarg; |
CHECKOP(op, ch); |
|
path_arg = optarg; |
op = OP_DELETE; |
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; |
|
|
memset(&info, 0, sizeof(BTREEINFO)); |
if (OP_CONFFILE == op && argc > 0) { |
info.flags = R_DUP; |
fprintf(stderr, "-C: Too many arguments\n"); |
|
goto usage; |
|
} |
|
|
mp = mparse_alloc(MPARSE_AUTO, MANDOCLEVEL_FATAL, NULL, NULL); |
exitcode = (int)MANDOCLEVEL_OK; |
|
mp = mparse_alloc(MPARSE_AUTO, |
|
MANDOCLEVEL_FATAL, NULL, NULL, NULL); |
|
mc = mchars_alloc(); |
|
|
memset(&buf, 0, sizeof(struct buf)); |
ohash_init(&mpages, 6, &mpages_info); |
memset(&dbuf, 0, sizeof(struct buf)); |
ohash_init(&mlinks, 6, &mlinks_info); |
|
|
buf.size = dbuf.size = MANDOC_BUFSZ; |
if (OP_UPDATE == op || OP_DELETE == op || OP_TEST == op) { |
|
/* |
|
* Force processing all files. |
|
*/ |
|
use_all = 1; |
|
|
buf.cp = mandoc_malloc(buf.size); |
/* |
dbuf.cp = mandoc_malloc(dbuf.size); |
* All of these deal with a specific directory. |
|
* Jump into that directory then collect files specified |
|
* on the command-line. |
|
*/ |
|
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, 0); |
|
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); |
|
|
flags = OP_NEW == op ? O_CREAT|O_TRUNC|O_RDWR : O_CREAT|O_RDWR; |
/* |
|
* 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_UPDATE == op || OP_DELETE == op) { |
if (j) { |
ibuf[0] = fbuf[0] = '\0'; |
ohash_init(&mpages, 6, &mpages_info); |
|
ohash_init(&mlinks, 6, &mlinks_info); |
|
} |
|
|
strlcat(fbuf, dir, MAXPATHLEN); |
if (0 == set_basedir(dirs.paths[j])) |
strlcat(fbuf, "/", MAXPATHLEN); |
goto out; |
sz1 = strlcat(fbuf, MANDOC_DB, MAXPATHLEN); |
if (0 == treescan()) |
|
goto out; |
|
if (0 == set_basedir(dirs.paths[j])) |
|
goto out; |
|
if (0 == dbopen(0)) |
|
goto out; |
|
|
strlcat(ibuf, dir, MAXPATHLEN); |
mpages_merge(mc, mp, warnings && !use_all); |
strlcat(ibuf, "/", MAXPATHLEN); |
dbclose(0); |
sz2 = strlcat(ibuf, MANDOC_IDX, MAXPATHLEN); |
|
|
|
if (sz1 >= MAXPATHLEN || sz2 >= MAXPATHLEN) { |
if (j + 1 < dirs.sz) { |
fprintf(stderr, "%s: Path too long\n", dir); |
mpages_free(); |
exit((int)MANDOCLEVEL_BADARG); |
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 [-anvW] [-C file]\n" |
|
" %s [-anvW] dir ...\n" |
|
" %s [-nvW] -d dir [file ...]\n" |
|
" %s [-nvW] -u dir [file ...]\n" |
|
" %s -t file ...\n", |
|
progname, progname, progname, |
|
progname, progname); |
|
|
db = dbopen(fbuf, flags, 0644, DB_BTREE, &info); |
return((int)MANDOCLEVEL_BADARG); |
idx = dbopen(ibuf, flags, 0644, DB_RECNO, NULL); |
} |
|
|
if (NULL == db) { |
/* |
perror(fbuf); |
* Scan a directory tree rooted at "basedir" for manpages. |
exit((int)MANDOCLEVEL_SYSERR); |
* We use fts(), scanning directory parts along the way for clues to our |
} else if (NULL == db) { |
* section and architecture. |
perror(ibuf); |
* |
exit((int)MANDOCLEVEL_SYSERR); |
* 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 *fsec; |
|
const char *dsec, *arch, *cp, *path; |
|
const char *argv[2]; |
|
|
if (verb > 2) { |
argv[0] = "."; |
printf("%s: Opened\n", fbuf); |
argv[1] = (char *)NULL; |
printf("%s: Opened\n", ibuf); |
|
} |
|
|
|
ofile_argbuild(argv, argc, verb, &of); |
/* |
if (NULL == of) |
* Walk through all components under the directory, using the |
goto out; |
* logical descent of files. |
|
*/ |
|
f = fts_open((char * const *)argv, FTS_LOGICAL, NULL); |
|
if (NULL == f) { |
|
exitcode = (int)MANDOCLEVEL_SYSERR; |
|
say("", NULL); |
|
return(0); |
|
} |
|
|
of = of->first; |
dsec = arch = NULL; |
|
dform = FORM_NONE; |
|
|
index_prune(of, db, fbuf, idx, ibuf, verb, |
while (NULL != (ff = fts_read(f))) { |
&maxrec, &recs, &recsz); |
path = ff->fts_path + 2; |
|
/* |
|
* If we're a regular file, add an mlink by using the |
|
* stored directory data and handling the filename. |
|
* Disallow duplicate (hard-linked) files. |
|
*/ |
|
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 (inocheck(ff->fts_statp)) { |
|
if (warnings) |
|
say(path, "Duplicate file"); |
|
continue; |
|
} else if (NULL == (fsec = |
|
strrchr(ff->fts_name, '.'))) { |
|
if ( ! use_all) { |
|
if (warnings) |
|
say(path, |
|
"No filename suffix"); |
|
continue; |
|
} |
|
} else if (0 == strcmp(++fsec, "html")) { |
|
if (warnings) |
|
say(path, "Skip html"); |
|
continue; |
|
} else if (0 == strcmp(fsec, "gz")) { |
|
if (warnings) |
|
say(path, "Skip gz"); |
|
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'; |
|
mlink = mandoc_calloc(1, sizeof(struct mlink)); |
|
strlcpy(mlink->file, path, sizeof(mlink->file)); |
|
mlink->dform = dform; |
|
if (NULL != dsec) |
|
mlink->dsec = mandoc_strdup(dsec); |
|
if (NULL != arch) |
|
mlink->arch = mandoc_strdup(arch); |
|
mlink->name = mandoc_strdup(ff->fts_name); |
|
if (NULL != fsec) |
|
mlink->fsec = mandoc_strdup(fsec); |
|
mlink_add(mlink, ff->fts_statp); |
|
continue; |
|
} else if (FTS_D != ff->fts_info && |
|
FTS_DP != ff->fts_info) { |
|
if (warnings) |
|
say(path, "Not a regular file"); |
|
continue; |
|
} |
|
|
if (OP_UPDATE == op) |
switch (ff->fts_level) { |
index_merge(of, mp, &dbuf, &buf, hash, |
case (0): |
db, fbuf, idx, ibuf, verb, |
/* Ignore the root directory. */ |
maxrec, recs, reccur); |
break; |
|
case (1): |
|
/* |
|
* This might contain manX/ or catX/. |
|
* Try to infer this from the name. |
|
* If we're not in use_all, enforce it. |
|
*/ |
|
dsec = NULL; |
|
dform = FORM_NONE; |
|
cp = ff->fts_name; |
|
if (FTS_DP == ff->fts_info) |
|
break; |
|
|
goto out; |
if (0 == strncmp(cp, "man", 3)) { |
|
dform = FORM_SRC; |
|
dsec = cp + 3; |
|
} else if (0 == strncmp(cp, "cat", 3)) { |
|
dform = FORM_CAT; |
|
dsec = cp + 3; |
|
} |
|
|
|
if (NULL != dsec || use_all) |
|
break; |
|
|
|
if (warnings) |
|
say(path, "Unknown directory part"); |
|
fts_set(f, ff, FTS_SKIP); |
|
break; |
|
case (2): |
|
/* |
|
* Possibly our architecture. |
|
* If we're descending, keep tabs on it. |
|
*/ |
|
arch = NULL; |
|
if (FTS_DP != ff->fts_info && NULL != dsec) |
|
arch = ff->fts_name; |
|
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; |
|
} |
} |
} |
|
|
for (i = 0; i < argc; i++) { |
fts_close(f); |
ibuf[0] = fbuf[0] = '\0'; |
return(1); |
|
} |
|
|
strlcat(fbuf, argv[i], MAXPATHLEN); |
/* |
strlcat(fbuf, "/", MAXPATHLEN); |
* Add a file to the file vector. |
sz1 = strlcat(fbuf, MANDOC_DB, MAXPATHLEN); |
* Do not verify that it's a "valid" looking manpage (we'll do that |
|
* later). |
|
* |
|
* Try to infer the manual section, architecture, and page name from the |
|
* path, assuming it looks like |
|
* |
|
* [./]man*[/<arch>]/<name>.<section> |
|
* or |
|
* [./]cat<section>[/<arch>]/<name>.0 |
|
* |
|
* Stuff this information directly into the mlink vector. |
|
* 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; |
|
|
strlcat(ibuf, argv[i], MAXPATHLEN); |
assert(use_all); |
strlcat(ibuf, "/", MAXPATHLEN); |
|
sz2 = strlcat(ibuf, MANDOC_IDX, MAXPATHLEN); |
|
|
|
if (sz1 >= MAXPATHLEN || sz2 >= MAXPATHLEN) { |
if (0 == strncmp(file, "./", 2)) |
fprintf(stderr, "%s: Path too long\n", argv[i]); |
file += 2; |
exit((int)MANDOCLEVEL_BADARG); |
|
} |
|
|
|
db = dbopen(fbuf, flags, 0644, DB_BTREE, &info); |
if (NULL == realpath(file, buf)) { |
idx = dbopen(ibuf, flags, 0644, DB_RECNO, NULL); |
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; |
|
} else if (inocheck(&st)) { |
|
if (warnings) |
|
say(file, "Duplicate file"); |
|
return; |
|
} |
|
start = buf + strlen(basedir); |
|
mlink = mandoc_calloc(1, sizeof(struct mlink)); |
|
strlcpy(mlink->file, start, sizeof(mlink->file)); |
|
|
if (NULL == db) { |
/* |
perror(fbuf); |
* First try to guess our directory structure. |
exit((int)MANDOCLEVEL_SYSERR); |
* If we find a separator, try to look for man* or cat*. |
} else if (NULL == db) { |
* If we find one of these and what's underneath is a directory, |
perror(ibuf); |
* assume it's an architecture. |
exit((int)MANDOCLEVEL_SYSERR); |
*/ |
|
if (NULL != (p = strchr(start, '/'))) { |
|
*p++ = '\0'; |
|
if (0 == strncmp(start, "man", 3)) { |
|
mlink->dform = FORM_SRC; |
|
mlink->dsec = mandoc_strdup(start + 3); |
|
} else if (0 == strncmp(start, "cat", 3)) { |
|
mlink->dform = FORM_CAT; |
|
mlink->dsec = mandoc_strdup(start + 3); |
} |
} |
|
|
if (verb > 2) { |
start = p; |
printf("%s: Truncated\n", fbuf); |
if (NULL != mlink->dsec && NULL != (p = strchr(start, '/'))) { |
printf("%s: Truncated\n", ibuf); |
*p++ = '\0'; |
|
mlink->arch = mandoc_strdup(start); |
|
start = p; |
} |
} |
|
} |
|
|
ofile_free(of); |
/* |
of = NULL; |
* Now check the file suffix. |
|
* Suffix of `.0' indicates a catpage, `.1-9' is a manpage. |
|
*/ |
|
p = strrchr(start, '\0'); |
|
while (p-- > start && '/' != *p && '.' != *p) |
|
/* Loop. */ ; |
|
|
if ( ! ofile_dirbuild(argv[i], verb, &of)) |
if ('.' == *p) { |
exit((int)MANDOCLEVEL_SYSERR); |
*p++ = '\0'; |
|
mlink->fsec = mandoc_strdup(p); |
|
} |
|
|
if (NULL == of) |
/* |
continue; |
* Now try to parse the name. |
|
* Use the filename portion of the path. |
of = of->first; |
*/ |
|
mlink->name = start; |
index_merge(of, mp, &dbuf, &buf, hash, db, fbuf, |
if (NULL != (p = strrchr(start, '/'))) { |
idx, ibuf, verb, maxrec, recs, reccur); |
mlink->name = p + 1; |
|
*p = '\0'; |
} |
} |
|
mlink->name = mandoc_strdup(mlink->name); |
|
|
out: |
mlink_add(mlink, &st); |
if (db) |
} |
(*db->close)(db); |
|
if (idx) |
|
(*idx->close)(idx); |
|
if (hash) |
|
(*hash->close)(hash); |
|
if (mp) |
|
mparse_free(mp); |
|
|
|
ofile_free(of); |
static int |
free(buf.cp); |
inocheck(const struct stat *st) |
free(dbuf.cp); |
{ |
free(recs); |
struct inodev inodev; |
|
uint32_t hash; |
|
|
return(MANDOCLEVEL_OK); |
memset(&inodev, 0, sizeof(inodev)); |
|
inodev.st_ino = hash = st->st_ino; |
|
inodev.st_dev = st->st_dev; |
|
|
|
return(NULL != ohash_find(&mpages, ohash_lookup_memory( |
|
&mpages, (char *)&inodev, sizeof(inodev), hash))); |
} |
} |
|
|
void |
static void |
index_merge(const struct of *of, struct mparse *mp, |
mlink_add(struct mlink *mlink, const struct stat *st) |
struct buf *dbuf, struct buf *buf, |
|
DB *hash, DB *db, const char *dbf, |
|
DB *idx, const char *idxf, int verb, |
|
recno_t maxrec, const recno_t *recs, size_t reccur) |
|
{ |
{ |
recno_t rec; |
struct inodev inodev; |
int ch; |
struct mpage *mpage; |
DBT key, val; |
unsigned int slot; |
struct mdoc *mdoc; |
|
struct man *man; |
|
const char *fn, *msec, *mtitle, *arch; |
|
size_t sv; |
|
unsigned seq; |
|
char vbuf[8]; |
|
|
|
for (rec = 0; of; of = of->next) { |
assert(NULL != mlink->file); |
fn = of->fname; |
|
if (reccur > 0) { |
|
--reccur; |
|
rec = recs[(int)reccur]; |
|
} else if (maxrec > 0) { |
|
rec = maxrec; |
|
maxrec = 0; |
|
} else |
|
rec++; |
|
|
|
mparse_reset(mp); |
if (NULL == mlink->dsec) |
hash_reset(&hash); |
mlink->dsec = mandoc_strdup(""); |
|
if (NULL == mlink->arch) |
|
mlink->arch = mandoc_strdup(""); |
|
if (NULL == mlink->name) |
|
mlink->name = mandoc_strdup(""); |
|
if (NULL == mlink->fsec) |
|
mlink->fsec = mandoc_strdup(""); |
|
|
if (mparse_readfd(mp, -1, fn) >= MANDOCLEVEL_FATAL) { |
if ('0' == *mlink->fsec) { |
fprintf(stderr, "%s: Parse failure\n", fn); |
free(mlink->fsec); |
continue; |
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; |
|
|
mparse_result(mp, &mdoc, &man); |
slot = ohash_qlookup(&mlinks, mlink->file); |
if (NULL == mdoc && NULL == man) |
assert(NULL == ohash_find(&mlinks, slot)); |
continue; |
ohash_insert(&mlinks, slot, mlink); |
|
|
msec = NULL != mdoc ? |
inodev.st_ino = st->st_ino; |
mdoc_meta(mdoc)->msec : man_meta(man)->msec; |
inodev.st_dev = st->st_dev; |
mtitle = NULL != mdoc ? |
slot = ohash_lookup_memory(&mpages, (char *)&inodev, |
mdoc_meta(mdoc)->title : man_meta(man)->title; |
sizeof(struct inodev), inodev.st_ino); |
arch = NULL != mdoc ? |
mpage = ohash_find(&mpages, slot); |
mdoc_meta(mdoc)->arch : NULL; |
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 |
|
abort(); |
|
mpage->mlinks = mlink; |
|
} |
|
|
if (NULL == arch) |
static void |
arch = ""; |
mlink_free(struct mlink *mlink) |
|
{ |
|
|
/* |
free(mlink->dsec); |
* The index record value consists of a nil-terminated |
free(mlink->arch); |
* filename, a nil-terminated manual section, and a |
free(mlink->name); |
* nil-terminated description. Since the description |
free(mlink->fsec); |
* may not be set, we set a sentinel to see if we're |
free(mlink); |
* going to write a nil byte in its place. |
} |
*/ |
|
|
|
dbuf->len = 0; |
static void |
buf_appendb(dbuf, fn, strlen(fn) + 1); |
mpages_free(void) |
buf_appendb(dbuf, msec, strlen(msec) + 1); |
{ |
buf_appendb(dbuf, mtitle, strlen(mtitle) + 1); |
struct mpage *mpage; |
buf_appendb(dbuf, arch, strlen(arch) + 1); |
struct mlink *mlink; |
|
unsigned int slot; |
|
|
sv = dbuf->len; |
mpage = ohash_first(&mpages, &slot); |
|
while (NULL != mpage) { |
|
while (NULL != (mlink = mpage->mlinks)) { |
|
mpage->mlinks = NULL; |
|
mlink_free(mlink); |
|
} |
|
free(mpage->sec); |
|
free(mpage->arch); |
|
free(mpage->title); |
|
free(mpage->desc); |
|
free(mpage); |
|
mpage = ohash_next(&mpages, &slot); |
|
} |
|
} |
|
|
/* Fix the record number in the btree value. */ |
/* |
|
* 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 |
|
mpages_merge(struct mchars *mc, struct mparse *mp, int check_reachable) |
|
{ |
|
struct ohash title_table; |
|
struct ohash_info title_info, str_info; |
|
char buf[PATH_MAX]; |
|
struct mpage *mpage; |
|
struct mdoc *mdoc; |
|
struct man *man; |
|
struct title *title_entry; |
|
char *bufp, *title_str; |
|
const char *cp; |
|
size_t sz; |
|
int match; |
|
unsigned int pslot, tslot; |
|
enum mandoclevel lvl; |
|
|
if (mdoc) |
str_info.alloc = hash_alloc; |
pmdoc_node(hash, buf, dbuf, |
str_info.halloc = hash_halloc; |
mdoc_node(mdoc), mdoc_meta(mdoc)); |
str_info.hfree = hash_free; |
else |
str_info.key_offset = offsetof(struct str, key); |
pman_node(hash, buf, dbuf, man_node(man)); |
|
|
|
|
if (check_reachable) { |
|
title_info.alloc = hash_alloc; |
|
title_info.halloc = hash_halloc; |
|
title_info.hfree = hash_free; |
|
title_info.key_offset = offsetof(struct title, title); |
|
ohash_init(&title_table, 6, &title_info); |
|
} |
|
|
|
mpage = ohash_first(&mpages, &pslot); |
|
while (NULL != mpage) { |
/* |
/* |
* Copy from the in-memory hashtable of pending keywords |
* If we're a catpage (as defined by our path), then see |
* into the database. |
* if a manpage exists by the same name (ignoring the |
|
* suffix). |
|
* If it does, then we want to use it instead of our |
|
* own. |
*/ |
*/ |
|
if ( ! use_all && FORM_CAT == mpage->mlinks->dform) { |
memset(vbuf, 0, sizeof(uint32_t)); |
sz = strlcpy(buf, mpage->mlinks->file, PATH_MAX); |
memcpy(vbuf + 4, &rec, sizeof(uint32_t)); |
if (sz >= PATH_MAX) { |
|
if (warnings) |
|
say(mpage->mlinks->file, |
|
"Filename too long"); |
|
mpage = ohash_next(&mpages, &pslot); |
|
continue; |
|
} |
|
bufp = strstr(buf, "cat"); |
|
assert(NULL != bufp); |
|
memcpy(bufp, "man", 3); |
|
if (NULL != (bufp = strrchr(buf, '.'))) |
|
*++bufp = '\0'; |
|
strlcat(buf, mpage->mlinks->dsec, PATH_MAX); |
|
if (NULL != ohash_find(&mlinks, |
|
ohash_qlookup(&mlinks, buf))) { |
|
if (warnings) |
|
say(mpage->mlinks->file, "Man " |
|
"source exists: %s", buf); |
|
mpage = ohash_next(&mpages, &pslot); |
|
continue; |
|
} |
|
} |
|
|
seq = R_FIRST; |
ohash_init(&strings, 6, &str_info); |
while (0 == (ch = (*hash->seq)(hash, &key, &val, seq))) { |
mparse_reset(mp); |
seq = R_NEXT; |
mdoc = NULL; |
|
man = NULL; |
|
match = 1; |
|
|
memcpy(vbuf, val.data, sizeof(uint32_t)); |
/* |
val.size = sizeof(vbuf); |
* Try interpreting the file as mdoc(7) or man(7) |
val.data = vbuf; |
* source code, unless it is already known to be |
|
* formatted. Fall back to formatted mode. |
|
*/ |
|
if (FORM_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 (verb > 1) |
if (NULL != mdoc) { |
printf("%s: Added keyword: %s\n", |
mpage->form = FORM_SRC; |
fn, (char *)key.data); |
mpage->sec = |
dbt_put(db, dbf, &key, &val); |
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); |
} |
} |
if (ch < 0) { |
|
perror("hash"); |
/* |
exit((int)MANDOCLEVEL_SYSERR); |
* Check whether the manual section given in a file |
|
* agrees with the directory where the file is located. |
|
* Some manuals have suffixes like (3p) on their |
|
* section number either inside the file or in the |
|
* directory name, some are linked into more than one |
|
* section, like encrypt(1) = makekey(8). Do not skip |
|
* manuals for such reasons. |
|
*/ |
|
if (warnings && !use_all && FORM_SRC == mpage->form && |
|
strcasecmp(mpage->sec, mpage->mlinks->dsec)) { |
|
match = 0; |
|
say(mpage->mlinks->file, "Section \"%s\" " |
|
"manual in %s directory", |
|
mpage->sec, mpage->mlinks->dsec); |
} |
} |
|
|
/* |
/* |
* Apply to the index. If we haven't had a description |
* Manual page directories exist for each kernel |
* set, put an empty one in now. |
* architecture as returned by machine(1). |
|
* However, many manuals only depend on the |
|
* application architecture as returned by arch(1). |
|
* For example, some (2/ARM) manuals are shared |
|
* across the "armish" and "zaurus" kernel |
|
* architectures. |
|
* A few manuals are even shared across completely |
|
* different architectures, for example fdformat(1) |
|
* on amd64, i386, sparc, and sparc64. |
|
* Thus, warn about architecture mismatches, |
|
* but don't skip manuals for this reason. |
*/ |
*/ |
|
if (warnings && !use_all && |
|
strcasecmp(mpage->arch, mpage->mlinks->arch)) { |
|
match = 0; |
|
say(mpage->mlinks->file, "Architecture \"%s\" " |
|
"manual in \"%s\" directory", |
|
mpage->arch, mpage->mlinks->arch); |
|
} |
|
if (warnings && !use_all && |
|
strcasecmp(mpage->title, mpage->mlinks->name)) |
|
match = 0; |
|
|
if (dbuf->len == sv) |
putkey(mpage, mpage->mlinks->name, TYPE_Nm); |
buf_appendb(dbuf, "", 1); |
|
|
|
key.data = &rec; |
if (NULL != mdoc) { |
key.size = sizeof(recno_t); |
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); |
|
|
val.data = dbuf->cp; |
/* |
val.size = dbuf->len; |
* Build a title string for the file. If it matches |
|
* the location of the file, remember the title as |
|
* found; else, remember it as missing. |
|
*/ |
|
|
if (verb) |
if (check_reachable) { |
printf("%s: Added index\n", fn); |
if (-1 == asprintf(&title_str, "%s(%s%s%s)", |
dbt_put(idx, idxf, &key, &val); |
mpage->title, mpage->sec, |
|
'\0' == *mpage->arch ? "" : "/", |
|
mpage->arch)) { |
|
perror(NULL); |
|
exit((int)MANDOCLEVEL_SYSERR); |
|
} |
|
tslot = ohash_qlookup(&title_table, title_str); |
|
title_entry = ohash_find(&title_table, tslot); |
|
if (NULL == title_entry) { |
|
title_entry = mandoc_malloc( |
|
sizeof(struct title)); |
|
title_entry->title = title_str; |
|
title_entry->file = mandoc_strdup( |
|
match ? "" : mpage->mlinks->file); |
|
ohash_insert(&title_table, tslot, |
|
title_entry); |
|
} else { |
|
if (match) |
|
*title_entry->file = '\0'; |
|
free(title_str); |
|
} |
|
} |
|
|
|
dbindex(mpage, mc); |
|
ohash_delete(&strings); |
|
mpage = ohash_next(&mpages, &pslot); |
} |
} |
|
|
|
if (check_reachable) { |
|
title_entry = ohash_first(&title_table, &tslot); |
|
while (NULL != title_entry) { |
|
if ('\0' != *title_entry->file) |
|
say(title_entry->file, |
|
"Probably unreachable, title is %s", |
|
title_entry->title); |
|
free(title_entry->title); |
|
free(title_entry->file); |
|
free(title_entry); |
|
title_entry = ohash_next(&title_table, &tslot); |
|
} |
|
ohash_delete(&title_table); |
|
} |
} |
} |
|
|
/* |
|
* Scan through all entries in the index file `idx' and prune those |
|
* entries in `ofile'. |
|
* Pruning consists of removing from `db', then invalidating the entry |
|
* in `idx' (zeroing its value size). |
|
*/ |
|
static void |
static void |
index_prune(const struct of *ofile, DB *db, const char *dbf, |
parse_cat(struct mpage *mpage) |
DB *idx, const char *idxf, int verb, |
|
recno_t *maxrec, recno_t **recs, size_t *recsz) |
|
{ |
{ |
const struct of *of; |
FILE *stream; |
const char *fn; |
char *line, *p, *title; |
unsigned seq, sseq; |
size_t len, plen, titlesz; |
DBT key, val; |
|
size_t reccur; |
|
int ch; |
|
|
|
reccur = 0; |
if (NULL == (stream = fopen(mpage->mlinks->file, "r"))) { |
seq = R_FIRST; |
if (warnings) |
while (0 == (ch = (*idx->seq)(idx, &key, &val, seq))) { |
say(mpage->mlinks->file, NULL); |
seq = R_NEXT; |
return; |
*maxrec = *(recno_t *)key.data; |
} |
if (0 == val.size) { |
|
if (reccur >= *recsz) { |
|
*recsz += MANDOC_SLOP; |
|
*recs = mandoc_realloc(*recs, |
|
*recsz * sizeof(recno_t)); |
|
} |
|
(*recs)[(int)reccur] = *maxrec; |
|
reccur++; |
|
continue; |
|
} |
|
|
|
fn = (char *)val.data; |
/* Skip to first blank line. */ |
for (of = ofile; of; of = of->next) |
|
if (0 == strcmp(fn, of->fname)) |
|
break; |
|
|
|
if (NULL == of) |
while (NULL != (line = fgetln(stream, &len))) |
continue; |
if ('\n' == *line) |
|
break; |
|
|
sseq = R_FIRST; |
/* |
while (0 == (ch = (*db->seq)(db, &key, &val, sseq))) { |
* Assume the first line that is not indented |
sseq = R_NEXT; |
* is the first section header. Skip to it. |
assert(8 == val.size); |
*/ |
if (*maxrec != *(recno_t *)(val.data + 4)) |
|
continue; |
|
if (verb) |
|
printf("%s: Deleted keyword: %s\n", |
|
fn, (char *)key.data); |
|
ch = (*db->del)(db, &key, R_CURSOR); |
|
if (ch < 0) |
|
break; |
|
} |
|
if (ch < 0) { |
|
perror(dbf); |
|
exit((int)MANDOCLEVEL_SYSERR); |
|
} |
|
|
|
if (verb) |
while (NULL != (line = fgetln(stream, &len))) |
printf("%s: Deleted index\n", fn); |
if ('\n' != *line && ' ' != *line) |
|
break; |
|
|
|
/* |
|
* Read up until the next section into a buffer. |
|
* Strip the leading and trailing newline from each read line, |
|
* appending a trailing space. |
|
* Ignore empty (whitespace-only) lines. |
|
*/ |
|
|
val.size = 0; |
titlesz = 0; |
ch = (*idx->put)(idx, &key, &val, R_CURSOR); |
title = NULL; |
if (ch < 0) { |
|
perror(idxf); |
|
exit((int)MANDOCLEVEL_SYSERR); |
|
} |
|
|
|
if (reccur >= *recsz) { |
while (NULL != (line = fgetln(stream, &len))) { |
*recsz += MANDOC_SLOP; |
if (' ' != *line || '\n' != line[len - 1]) |
*recs = mandoc_realloc |
break; |
(*recs, *recsz * sizeof(recno_t)); |
while (len > 0 && isspace((unsigned char)*line)) { |
|
line++; |
|
len--; |
} |
} |
|
if (1 == len) |
|
continue; |
|
title = mandoc_realloc(title, titlesz + len); |
|
memcpy(title + titlesz, line, len); |
|
titlesz += len; |
|
title[titlesz - 1] = ' '; |
|
} |
|
|
(*recs)[(int)reccur] = *maxrec; |
/* |
reccur++; |
* If no page content can be found, or the input line |
|
* is already the next section header, or there is no |
|
* trailing newline, reuse the page title as the page |
|
* description. |
|
*/ |
|
|
|
if (NULL == title || '\0' == *title) { |
|
if (warnings) |
|
say(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; |
} |
} |
(*maxrec)++; |
|
} |
|
|
|
/* |
title = mandoc_realloc(title, titlesz + 1); |
* Grow the buffer (if necessary) and copy in a binary string. |
title[titlesz] = '\0'; |
*/ |
|
static void |
|
buf_appendb(struct buf *buf, const void *cp, size_t sz) |
|
{ |
|
|
|
/* Overshoot by MANDOC_BUFSZ. */ |
/* |
|
* Skip to the first dash. |
|
* Use the remaining line as the description (no more than 70 |
|
* bytes). |
|
*/ |
|
|
while (buf->len + sz >= buf->size) { |
if (NULL != (p = strstr(title, "- "))) { |
buf->size = buf->len + sz + MANDOC_BUFSZ; |
for (p += 2; ' ' == *p || '\b' == *p; p++) |
buf->cp = mandoc_realloc(buf->cp, buf->size); |
/* Skip to next word. */ ; |
|
} else { |
|
if (warnings) |
|
say(mpage->mlinks->file, |
|
"No dash in title line"); |
|
p = title; |
} |
} |
|
|
memcpy(buf->cp + (int)buf->len, cp, sz); |
plen = strlen(p); |
buf->len += sz; |
|
|
/* 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); |
} |
} |
|
|
/* |
/* |
* Append a nil-terminated string to the buffer. |
* Put a type/word pair into the word database for this particular file. |
* 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) |
putkey(const struct mpage *mpage, const char *value, uint64_t type) |
{ |
{ |
size_t sz; |
|
|
|
if (0 == (sz = strlen(cp))) |
assert(NULL != value); |
return; |
putkeys(mpage, value, strlen(value), type); |
|
|
if (buf->len) |
|
buf->cp[(int)buf->len - 1] = ' '; |
|
|
|
buf_appendb(buf, cp, sz + 1); |
|
} |
} |
|
|
/* |
/* |
* Recursively add all text from a given node. |
* Grok all nodes at or below a certain mdoc node into putkey(). |
* This is optimised for general mdoc nodes in this context, which do |
|
* not consist of subexpressions and having a recursive call for n->next |
|
* would be wasteful. |
|
* The "f" variable should be 0 unless called from pmdoc_Nd for the |
|
* description buffer, which does not start at the beginning of the |
|
* buffer. |
|
*/ |
*/ |
static void |
static void |
buf_appendmdoc(struct buf *buf, const struct mdoc_node *n, int f) |
putmdockey(const struct mpage *mpage, |
|
const struct mdoc_node *n, uint64_t m) |
{ |
{ |
|
|
for ( ; n; n = n->next) { |
for ( ; NULL != n; n = n->next) { |
if (n->child) |
if (NULL != n->child) |
buf_appendmdoc(buf, n->child, f); |
putmdockey(mpage, n->child, m); |
|
if (MDOC_TEXT == n->type) |
if (MDOC_TEXT == n->type && f) { |
putkey(mpage, n->string, m); |
f = 0; |
|
buf_appendb(buf, n->string, |
|
strlen(n->string) + 1); |
|
} else if (MDOC_TEXT == n->type) |
|
buf_append(buf, n->string); |
|
|
|
} |
} |
} |
} |
|
|
/* ARGSUSED */ |
|
static 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, O_CREAT|O_RDWR, 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 778 pmdoc_Fd(MDOC_ARGS) |
|
Line 1437 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(1); |
buf_appendb(buf, "", 1); |
|
|
|
hash_put(hash, buf, TYPE_INCLUDES); |
|
} |
} |
|
|
/* ARGSUSED */ |
static int |
static void |
parse_mdoc_In(struct mpage *mpage, const struct mdoc_node *n) |
pmdoc_Cd(MDOC_ARGS) |
|
{ |
{ |
|
|
if (SEC_SYNOPSIS != n->sec) |
|
return; |
|
|
|
buf_appendmdoc(buf, n->child, 0); |
if (NULL != n->child && MDOC_TEXT == n->child->type) |
hash_put(hash, buf, TYPE_CONFIG); |
return(0); |
} |
|
|
|
/* ARGSUSED */ |
putkey(mpage, n->child->string, TYPE_In); |
static void |
return(1); |
pmdoc_In(MDOC_ARGS) |
|
{ |
|
|
|
if (SEC_SYNOPSIS != n->sec) |
|
return; |
|
if (NULL == n->child || MDOC_TEXT != n->child->type) |
|
return; |
|
|
|
buf_append(buf, n->child->string); |
|
hash_put(hash, buf, TYPE_INCLUDES); |
|
} |
} |
|
|
/* ARGSUSED */ |
static int |
static void |
parse_mdoc_Fn(struct mpage *mpage, const struct mdoc_node *n) |
pmdoc_Fn(MDOC_ARGS) |
|
{ |
{ |
const char *cp; |
const char *cp; |
|
|
if (SEC_SYNOPSIS != n->sec) |
|
return; |
|
if (NULL == n->child || MDOC_TEXT != n->child->type) |
|
return; |
|
|
|
/* .Fn "struct type *arg" "foo" */ |
if (NULL == (n = n->child) || MDOC_TEXT != n->type) |
|
return(0); |
|
|
cp = strrchr(n->child->string, ' '); |
/* |
if (NULL == cp) |
* Parse: .Fn "struct type *name" "char *arg". |
cp = n->child->string; |
* First strip away pointer symbol. |
|
* Then store the function name, then type. |
|
* Finally, store the arguments. |
|
*/ |
|
|
/* Strip away pointer symbol. */ |
if (NULL == (cp = strrchr(n->string, ' '))) |
|
cp = n->string; |
|
|
while ('*' == *cp) |
while ('*' == *cp) |
cp++; |
cp++; |
|
|
buf_append(buf, cp); |
putkey(mpage, cp, TYPE_Fn); |
hash_put(hash, buf, TYPE_FUNCTION); |
|
|
if (n->string < cp) |
|
putkeys(mpage, n->string, cp - n->string, TYPE_Ft); |
|
|
|
for (n = n->next; NULL != n; n = n->next) |
|
if (MDOC_TEXT == n->type) |
|
putkey(mpage, n->string, TYPE_Fa); |
|
|
|
return(0); |
} |
} |
|
|
/* ARGSUSED */ |
static int |
static void |
parse_mdoc_St(struct mpage *mpage, const struct mdoc_node *n) |
pmdoc_St(MDOC_ARGS) |
|
{ |
{ |
|
|
if (SEC_STANDARDS != n->sec) |
|
return; |
|
if (NULL == n->child || MDOC_TEXT != n->child->type) |
if (NULL == n->child || MDOC_TEXT != n->child->type) |
return; |
return(0); |
|
|
buf_append(buf, n->child->string); |
putkey(mpage, n->child->string, TYPE_St); |
hash_put(hash, buf, TYPE_STANDARD); |
return(1); |
} |
} |
|
|
/* 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))) |
if (SEC_NAME == n->sec) |
return; |
return(1); |
|
else if (SEC_SYNOPSIS != n->sec || MDOC_HEAD != n->type) |
|
return(0); |
|
|
if (';' == start[(int)sz - 1]) |
return(1); |
sz--; |
} |
|
|
if (0 == sz) |
static int |
return; |
parse_mdoc_Sh(struct mpage *mpage, const struct mdoc_node *n) |
|
{ |
|
|
buf_appendb(buf, start, sz); |
return(SEC_CUSTOM == n->sec && MDOC_HEAD == n->type); |
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 UTF-8 version of a key, or alias the pointer if the key has |
|
* no UTF-8 transcription marks in it. |
|
*/ |
static void |
static void |
pmdoc_Nm(MDOC_ARGS) |
utf8key(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->utf8); |
|
|
|
res[0] = '\\'; |
|
res[1] = '\t'; |
|
res[2] = ASCII_NBRSP; |
|
res[3] = ASCII_HYPH; |
|
res[4] = '\0'; |
|
|
|
val = key->key; |
|
bsz = strlen(val); |
|
|
|
/* |
|
* Pre-check: if we have no stop-characters, then set the |
|
* pointer as ourselvse and get out of here. |
|
*/ |
|
if (strcspn(val, res) == bsz) { |
|
key->utf8 = key->key; |
return; |
return; |
} 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++; |
|
u = 0; |
|
|
|
/* |
|
* 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; |
|
if (0 == (u = mchars_spec2cp(mc, seq, len))) |
|
continue; |
|
|
|
/* |
|
* If we have a Unicode codepoint, try to convert that |
|
* to a UTF-8 byte string. |
|
*/ |
|
cpp = utfbuf; |
|
if (0 == (sz = utf8(u, utfbuf))) |
|
continue; |
|
|
|
/* Copy the rendered glyph into the stream. */ |
|
|
|
sz = strlen(cpp); |
|
bsz += sz; |
|
|
|
buf = mandoc_realloc(buf, bsz); |
|
|
|
memcpy(&buf[pos], cpp, sz); |
|
pos += sz; |
|
} |
|
|
|
buf[pos] = '\0'; |
|
key->utf8 = buf; |
} |
} |
|
|
|
/* |
|
* Flush the current page's terms (and their bits) into the database. |
|
* Wrap the entire set of additions in a transaction to make sqlite be a |
|
* little faster. |
|
* Also, UTF-8-encode the description at the last possible moment. |
|
*/ |
static void |
static void |
hash_put(DB *db, const struct buf *buf, int mask) |
dbindex(const struct mpage *mpage, struct mchars *mc) |
{ |
{ |
DBT key, val; |
struct str *key; |
int rc; |
const char *desc; |
|
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; |
desc = ""; |
key.size = buf->len; |
if (NULL != mpage->desc && '\0' != *mpage->desc) { |
|
key = ohash_find(&strings, |
|
ohash_qlookup(&strings, mpage->desc)); |
|
assert(NULL != key); |
|
if (NULL == key->utf8) |
|
utf8key(mc, key); |
|
desc = key->utf8; |
|
} |
|
|
if ((rc = (*db->get)(db, &key, &val, 0)) < 0) { |
SQL_EXEC("BEGIN TRANSACTION"); |
perror("hash"); |
|
exit((int)MANDOCLEVEL_SYSERR); |
|
} else if (0 == rc) |
|
mask |= *(int *)val.data; |
|
|
|
val.data = &mask; |
i = 1; |
val.size = sizeof(int); |
/* |
|
* XXX The following three lines are obsolete |
|
* and only kept for backward compatibility |
|
* until apropos(1) and friends have caught up. |
|
*/ |
|
SQL_BIND_TEXT(stmts[STMT_INSERT_PAGE], i, mpage->mlinks->file); |
|
SQL_BIND_TEXT(stmts[STMT_INSERT_PAGE], i, mpage->mlinks->dsec); |
|
SQL_BIND_TEXT(stmts[STMT_INSERT_PAGE], i, mpage->mlinks->arch); |
|
SQL_BIND_TEXT(stmts[STMT_INSERT_PAGE], i, desc); |
|
SQL_BIND_INT(stmts[STMT_INSERT_PAGE], i, FORM_SRC == mpage->form); |
|
SQL_STEP(stmts[STMT_INSERT_PAGE]); |
|
recno = sqlite3_last_insert_rowid(db); |
|
sqlite3_reset(stmts[STMT_INSERT_PAGE]); |
|
|
if ((rc = (*db->put)(db, &key, &val, 0)) < 0) { |
i = 1; |
perror("hash"); |
SQL_BIND_TEXT(stmts[STMT_INSERT_LINK], i, mpage->mlinks->dsec); |
exit((int)MANDOCLEVEL_SYSERR); |
SQL_BIND_TEXT(stmts[STMT_INSERT_LINK], i, mpage->mlinks->arch); |
} |
SQL_BIND_TEXT(stmts[STMT_INSERT_LINK], i, mpage->mlinks->file); |
|
SQL_BIND_INT64(stmts[STMT_INSERT_LINK], i, recno); |
|
SQL_STEP(stmts[STMT_INSERT_LINK]); |
|
sqlite3_reset(stmts[STMT_INSERT_LINK]); |
|
|
|
for (key = ohash_first(&strings, &slot); NULL != key; |
|
key = ohash_next(&strings, &slot)) { |
|
assert(key->mpage == mpage); |
|
if (NULL == key->utf8) |
|
utf8key(mc, key); |
|
i = 1; |
|
SQL_BIND_INT64(stmts[STMT_INSERT_KEY], i, key->mask); |
|
SQL_BIND_TEXT(stmts[STMT_INSERT_KEY], i, key->utf8); |
|
SQL_BIND_INT64(stmts[STMT_INSERT_KEY], i, recno); |
|
SQL_STEP(stmts[STMT_INSERT_KEY]); |
|
sqlite3_reset(stmts[STMT_INSERT_KEY]); |
|
if (key->utf8 != key->key) |
|
free(key->utf8); |
|
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(0); |
return(1); |
|
|
/* |
ofl = SQLITE_OPEN_READWRITE; |
* We're only searching for one thing: the first text child in |
if (0 == real) { |
* the BODY of a NAME section. Since we don't keep track of |
file = MANDOC_DB "~"; |
* sections in -man, run some hoops to find out whether we're in |
if (-1 == remove(file) && ENOENT != errno) { |
* the correct section or not. |
exitcode = (int)MANDOCLEVEL_SYSERR; |
*/ |
say(file, NULL); |
|
return(0); |
|
} |
|
ofl |= SQLITE_OPEN_EXCLUSIVE; |
|
} else |
|
file = MANDOC_DB; |
|
|
if (MAN_BODY == n->type && MAN_SH == n->tok) { |
rc = sqlite3_open_v2(file, &db, ofl, NULL); |
body = n; |
if (SQLITE_OK == rc) |
assert(body->parent); |
goto prepare_statements; |
if (NULL != (head = body->parent->head) && |
if (SQLITE_CANTOPEN != rc) { |
1 == head->nchild && |
exitcode = (int)MANDOCLEVEL_SYSERR; |
NULL != (head = (head->child)) && |
say(file, NULL); |
MAN_TEXT == head->type && |
return(0); |
0 == strcmp(head->string, "NAME") && |
} |
NULL != (body = body->child) && |
|
MAN_TEXT == body->type) { |
|
|
|
assert(body->string); |
sqlite3_close(db); |
start = sv = body->string; |
db = NULL; |
|
|
/* |
if (SQLITE_OK != (rc = sqlite3_open(file, &db))) { |
* Go through a special heuristic dance here. |
exitcode = (int)MANDOCLEVEL_SYSERR; |
* This is why -man manuals are great! |
say(file, NULL); |
* (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 ( ;; ) { |
/* |
sz = strcspn(start, " ,"); |
* XXX The first three columns in table mpages are obsolete |
if ('\0' == start[(int)sz]) |
* and only kept for backward compatibility |
break; |
* until apropos(1) and friends have caught up. |
|
*/ |
|
sql = "CREATE TABLE \"mpages\" (\n" |
|
" \"file\" TEXT NOT NULL,\n" |
|
" \"sec\" TEXT NOT NULL,\n" |
|
" \"arch\" TEXT NOT NULL,\n" |
|
" \"desc\" TEXT NOT NULL,\n" |
|
" \"form\" INTEGER NOT NULL,\n" |
|
" \"id\" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL\n" |
|
");\n" |
|
"\n" |
|
"CREATE TABLE \"mlinks\" (\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"; |
|
|
buf->len = 0; |
if (SQLITE_OK != sqlite3_exec(db, sql, NULL, NULL, NULL)) { |
buf_appendb(buf, start, sz); |
exitcode = (int)MANDOCLEVEL_SYSERR; |
buf_appendb(buf, "", 1); |
say(file, "%s", sqlite3_errmsg(db)); |
|
return(0); |
|
} |
|
|
hash_put(hash, buf, TYPE_NAME); |
prepare_statements: |
|
SQL_EXEC("PRAGMA foreign_keys = ON"); |
|
sql = "DELETE FROM mpages where file=?"; |
|
sqlite3_prepare_v2(db, sql, -1, &stmts[STMT_DELETE_PAGE], NULL); |
|
sql = "INSERT INTO mpages " |
|
"(file,sec,arch,desc,form) VALUES (?,?,?,?,?)"; |
|
sqlite3_prepare_v2(db, sql, -1, &stmts[STMT_INSERT_PAGE], NULL); |
|
sql = "INSERT INTO mlinks " |
|
"(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); |
|
|
if (' ' == start[(int)sz]) { |
#ifndef __APPLE__ |
start += (int)sz + 1; |
/* |
break; |
* When opening a new database, we can turn off |
} |
* synchronous mode for much better performance. |
|
*/ |
|
|
assert(',' == start[(int)sz]); |
if (real) |
start += (int)sz + 1; |
SQL_EXEC("PRAGMA synchronous = OFF"); |
while (' ' == *start) |
#endif |
start++; |
|
} |
|
|
|
buf->len = 0; |
return(1); |
|
} |
|
|
if (sv == start) { |
static void * |
buf_append(buf, start); |
hash_halloc(size_t sz, void *arg) |
return(1); |
{ |
} |
|
|
|
while (' ' == *start) |
return(mandoc_calloc(sz, 1)); |
start++; |
} |
|
|
if (0 == strncmp(start, "-", 1)) |
static void * |
start += 1; |
hash_alloc(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) |
return(mandoc_malloc(sz)); |
start++; |
|
|
|
sz = strlen(start) + 1; |
|
buf_appendb(dbuf, start, sz); |
|
buf_appendb(buf, start, sz); |
|
|
|
hash_put(hash, buf, TYPE_DESC); |
|
} |
|
} |
|
|
|
if (pman_node(hash, buf, dbuf, n->child)) |
|
return(1); |
|
if (pman_node(hash, buf, dbuf, n->next)) |
|
return(1); |
|
|
|
return(0); |
|
} |
} |
|
|
static void |
static void |
ofile_argbuild(char *argv[], int argc, int verb, struct of **of) |
hash_free(void *p, size_t sz, void *arg) |
{ |
{ |
int i; |
|
struct of *nof; |
|
|
|
for (i = 0; i < argc; i++) { |
free(p); |
nof = mandoc_calloc(1, sizeof(struct of)); |
|
nof->fname = strdup(argv[i]); |
|
if (verb > 2) |
|
printf("%s: Scheduling\n", argv[i]); |
|
if (NULL == *of) { |
|
*of = nof; |
|
(*of)->first = nof; |
|
} else { |
|
nof->first = (*of)->first; |
|
(*of)->next = nof; |
|
*of = nof; |
|
} |
|
} |
|
} |
} |
|
|
/* |
|
* Recursively build up a list of files to parse. |
|
* We use this instead of ftw() and so on because I don't want global |
|
* variables hanging around. |
|
* This ignores the mandoc.db and mandoc.index files, but assumes that |
|
* everything else is a manual. |
|
* Pass in a pointer to a NULL structure for the first invocation. |
|
*/ |
|
static int |
static int |
ofile_dirbuild(const char *dir, int verb, struct of **of) |
set_basedir(const char *targetdir) |
{ |
{ |
char buf[MAXPATHLEN]; |
static char startdir[PATH_MAX]; |
size_t sz; |
static int fd; |
DIR *d; |
|
const char *fn; |
|
struct of *nof; |
|
struct dirent *dp; |
|
|
|
if (NULL == (d = opendir(dir))) { |
/* |
perror(dir); |
* Remember where we started by keeping a fd open to the origin |
return(0); |
* path component: throughout this utility, we chdir() a lot to |
} |
* handle relative paths, and by doing this, we can return to |
|
* the starting point. |
while (NULL != (dp = readdir(d))) { |
*/ |
fn = dp->d_name; |
if ('\0' == *startdir) { |
if (DT_DIR == dp->d_type) { |
if (NULL == getcwd(startdir, PATH_MAX)) { |
if (0 == strcmp(".", fn)) |
exitcode = (int)MANDOCLEVEL_SYSERR; |
continue; |
if (NULL != targetdir) |
if (0 == strcmp("..", fn)) |
say(".", NULL); |
continue; |
|
|
|
buf[0] = '\0'; |
|
strlcat(buf, dir, MAXPATHLEN); |
|
strlcat(buf, "/", MAXPATHLEN); |
|
sz = strlcat(buf, fn, MAXPATHLEN); |
|
|
|
if (sz < MAXPATHLEN) { |
|
if ( ! ofile_dirbuild(buf, verb, of)) |
|
return(0); |
|
continue; |
|
} else if (sz < MAXPATHLEN) |
|
continue; |
|
|
|
fprintf(stderr, "%s: Path too long\n", dir); |
|
return(0); |
return(0); |
} |
} |
if (DT_REG != dp->d_type) |
if (-1 == (fd = open(startdir, O_RDONLY, 0))) { |
continue; |
exitcode = (int)MANDOCLEVEL_SYSERR; |
|
say(startdir, NULL); |
if (0 == strcmp(MANDOC_DB, fn) || |
|
0 == strcmp(MANDOC_IDX, fn)) |
|
continue; |
|
|
|
buf[0] = '\0'; |
|
strlcat(buf, dir, MAXPATHLEN); |
|
strlcat(buf, "/", MAXPATHLEN); |
|
strlcat(buf, fn, MAXPATHLEN); |
|
if (sz >= MAXPATHLEN) { |
|
fprintf(stderr, "%s: Path too long\n", dir); |
|
return(0); |
return(0); |
} |
} |
|
if (NULL == targetdir) |
nof = mandoc_calloc(1, sizeof(struct of)); |
targetdir = startdir; |
nof->fname = mandoc_strdup(buf); |
} else { |
|
if (-1 == fd) |
if (verb > 2) |
return(0); |
printf("%s: Scheduling\n", buf); |
if (-1 == fchdir(fd)) { |
|
close(fd); |
if (NULL == *of) { |
basedir[0] = '\0'; |
*of = nof; |
exitcode = (int)MANDOCLEVEL_SYSERR; |
(*of)->first = nof; |
say(startdir, NULL); |
} else { |
return(0); |
nof->first = (*of)->first; |
|
(*of)->next = nof; |
|
*of = nof; |
|
} |
} |
|
if (NULL == targetdir) { |
|
close(fd); |
|
return(1); |
|
} |
} |
} |
|
if (NULL == realpath(targetdir, basedir)) { |
|
basedir[0] = '\0'; |
|
exitcode = (int)MANDOCLEVEL_BADARG; |
|
say(targetdir, NULL); |
|
return(0); |
|
} else if (-1 == chdir(basedir)) { |
|
exitcode = (int)MANDOCLEVEL_BADARG; |
|
say("", NULL); |
|
return(0); |
|
} |
return(1); |
return(1); |
} |
} |
|
|
static void |
static void |
ofile_free(struct of *of) |
say(const char *file, const char *format, ...) |
{ |
{ |
struct of *nof; |
va_list ap; |
|
|
while (of) { |
if ('\0' != *basedir) |
nof = of->next; |
fprintf(stderr, "%s", basedir); |
free(of->fname); |
if ('\0' != *basedir && '\0' != *file) |
free(of); |
fputs("//", stderr); |
of = nof; |
if ('\0' != *file) |
|
fprintf(stderr, "%s", file); |
|
fputs(": ", stderr); |
|
|
|
if (NULL == format) { |
|
perror(NULL); |
|
return; |
} |
} |
} |
|
|
|
static void |
va_start(ap, format); |
usage(void) |
vfprintf(stderr, format, ap); |
{ |
va_end(ap); |
|
|
fprintf(stderr, "usage: %s [-v] " |
fputc('\n', stderr); |
"[-d dir [files...] |" |
|
" -u dir [files...] |" |
|
" dir...]\n", progname); |
|
} |
} |