| version 1.47, 2012/04/15 13:30:38 |
version 1.107, 2014/01/06 20:53:40 |
|
|
| /* $Id$ */ |
/* $Id$ */ |
| /* |
/* |
| * Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv> |
| * Copyright (c) 2011 Ingo Schwarze <schwarze@openbsd.org> |
* 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 |
|
|
| #include "config.h" |
#include "config.h" |
| #endif |
#endif |
| |
|
| #include <sys/param.h> |
#include <sys/stat.h> |
| #include <sys/types.h> |
|
| |
|
| #include <assert.h> |
#include <assert.h> |
| #include <ctype.h> |
#include <ctype.h> |
| #include <dirent.h> |
|
| #include <errno.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> |
#include <unistd.h> |
| |
|
| #if defined(__linux__) |
#ifdef HAVE_OHASH |
| # include <endian.h> |
#include <ohash.h> |
| # include <db_185.h> |
|
| #elif defined(__APPLE__) |
|
| # include <libkern/OSByteOrder.h> |
|
| # include <db.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 "mandocdb.h" |
|
| #include "manpath.h" |
#include "manpath.h" |
| |
#include "mansearch.h" |
| |
|
| #define MANDOC_BUFSZ BUFSIZ |
#define SQL_EXEC(_v) \ |
| #define MANDOC_SLOP 1024 |
if (SQLITE_OK != sqlite3_exec(db, (_v), NULL, NULL, NULL)) \ |
| |
fprintf(stderr, "%s\n", sqlite3_errmsg(db)) |
| |
#define SQL_BIND_TEXT(_s, _i, _v) \ |
| |
if (SQLITE_OK != sqlite3_bind_text \ |
| |
((_s), (_i)++, (_v), -1, SQLITE_STATIC)) \ |
| |
fprintf(stderr, "%s\n", sqlite3_errmsg(db)) |
| |
#define SQL_BIND_INT(_s, _i, _v) \ |
| |
if (SQLITE_OK != sqlite3_bind_int \ |
| |
((_s), (_i)++, (_v))) \ |
| |
fprintf(stderr, "%s\n", sqlite3_errmsg(db)) |
| |
#define SQL_BIND_INT64(_s, _i, _v) \ |
| |
if (SQLITE_OK != sqlite3_bind_int64 \ |
| |
((_s), (_i)++, (_v))) \ |
| |
fprintf(stderr, "%s\n", sqlite3_errmsg(db)) |
| |
#define SQL_STEP(_s) \ |
| |
if (SQLITE_DONE != sqlite3_step((_s))) \ |
| |
fprintf(stderr, "%s\n", sqlite3_errmsg(db)) |
| |
|
| #define MANDOC_SRC 0x1 |
enum op { |
| #define MANDOC_FORM 0x2 |
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 WARNING(_f, _b, _fmt, _args...) \ |
enum form { |
| do if (warnings) { \ |
FORM_NONE, /* format is unknown */ |
| fprintf(stderr, "%s: ", (_b)); \ |
FORM_SRC, /* format is -man or -mdoc */ |
| fprintf(stderr, (_fmt), ##_args); \ |
FORM_CAT /* format is cat */ |
| if ('\0' != *(_f)) \ |
}; |
| fprintf(stderr, ": %s", (_f)); \ |
|
| fprintf(stderr, "\n"); \ |
|
| } while (/* CONSTCOND */ 0) |
|
| |
|
| /* Access to the mandoc database on disk. */ |
|
| |
|
| struct mdb { |
struct str { |
| char idxn[MAXPATHLEN]; /* index db filename */ |
char *rendered; /* key in UTF-8 or ASCII form */ |
| char dbn[MAXPATHLEN]; /* keyword db filename */ |
const struct mpage *mpage; /* if set, the owning parse */ |
| DB *idx; /* index recno database */ |
uint64_t mask; /* bitmask in sequence */ |
| DB *db; /* keyword btree database */ |
char key[]; /* may contain escape sequences */ |
| }; |
}; |
| |
|
| /* Stack of temporarily unused index records. */ |
struct inodev { |
| |
ino_t st_ino; |
| struct recs { |
dev_t st_dev; |
| recno_t *stack; /* pointer to a malloc'ed array */ |
|
| size_t size; /* number of allocated slots */ |
|
| size_t cur; /* current number of empty records */ |
|
| recno_t last; /* last record number in the index */ |
|
| }; |
}; |
| |
|
| /* Tiny list for files. No need to bring in QUEUE. */ |
struct mpage { |
| |
struct inodev inodev; /* used for hashing routine */ |
| struct of { |
enum form form; /* format from file content */ |
| char *fname; /* heap-allocated */ |
char *sec; /* section from file content */ |
| char *sec; |
char *arch; /* architecture from file content */ |
| char *arch; |
char *title; /* title from file content */ |
| char *title; |
char *desc; /* description from file content */ |
| int src_form; |
struct mlink *mlinks; /* singly linked list */ |
| struct of *next; /* NULL for last one */ |
|
| struct of *first; /* first in list */ |
|
| }; |
}; |
| |
|
| /* Buffer for storing growable data. */ |
struct mlink { |
| |
char file[PATH_MAX]; /* filename rel. to manpath */ |
| struct buf { |
enum form dform; /* format from directory */ |
| char *cp; |
enum form fform; /* format from file name suffix */ |
| size_t len; /* current length */ |
char *dsec; /* section from directory */ |
| size_t size; /* total buffer size */ |
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 */ |
| }; |
}; |
| |
|
| /* Operation we're going to perform. */ |
enum stmt { |
| |
STMT_DELETE_PAGE = 0, /* delete mpage */ |
| enum op { |
STMT_INSERT_PAGE, /* insert mpage */ |
| OP_DEFAULT = 0, /* new dbs from dir list or default config */ |
STMT_INSERT_LINK, /* insert mlink */ |
| OP_CONFFILE, /* new databases from custom config file */ |
STMT_INSERT_KEY, /* insert parsed key */ |
| OP_UPDATE, /* delete/add entries in existing database */ |
STMT__MAX |
| OP_DELETE, /* delete entries from existing database */ |
|
| OP_TEST /* change no databases, report potential problems */ |
|
| }; |
}; |
| |
|
| #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 *, |
|
| const struct mdoc_node *, int); |
|
| static void buf_append(struct buf *, const char *); |
|
| static void buf_appendb(struct buf *, |
|
| const void *, size_t); |
|
| static void dbt_put(DB *, const char *, DBT *, DBT *); |
|
| static void hash_put(DB *, const struct buf *, uint64_t); |
|
| static void hash_reset(DB **); |
|
| static void index_merge(const struct of *, struct mparse *, |
|
| struct buf *, struct buf *, DB *, |
|
| struct mdb *, struct recs *, |
|
| const char *); |
|
| static void index_prune(const struct of *, struct mdb *, |
|
| struct recs *, const char *); |
|
| static void ofile_argbuild(int, char *[], |
|
| struct of **, const char *); |
|
| static void ofile_dirbuild(const char *, const char *, |
|
| const char *, int, struct of **, char *); |
|
| static void ofile_free(struct of *); |
|
| static void pformatted(DB *, struct buf *, struct buf *, |
|
| const struct of *, const char *); |
|
| static int pman_node(MAN_ARGS); |
|
| static void pmdoc_node(MDOC_ARGS); |
|
| static int pmdoc_head(MDOC_ARGS); |
|
| static int pmdoc_body(MDOC_ARGS); |
|
| static int pmdoc_Fd(MDOC_ARGS); |
|
| static int pmdoc_In(MDOC_ARGS); |
|
| static int pmdoc_Fn(MDOC_ARGS); |
|
| static int pmdoc_Nd(MDOC_ARGS); |
|
| static int pmdoc_Nm(MDOC_ARGS); |
|
| static int pmdoc_Sh(MDOC_ARGS); |
|
| static int pmdoc_St(MDOC_ARGS); |
|
| static int pmdoc_Xr(MDOC_ARGS); |
|
| |
|
| #define MDOCF_CHILD 0x01 /* Automatically index child nodes. */ |
|
| |
|
| struct mdoc_handler { |
struct mdoc_handler { |
| int (*fp)(MDOC_ARGS); /* Optional handler. */ |
mdoc_fp fp; /* optional handler */ |
| uint64_t mask; /* Set unless handler returns 0. */ |
uint64_t mask; /* set unless handler returns 0 */ |
| int flags; /* For use by pmdoc_node. */ |
|
| }; |
}; |
| |
|
| |
static void dbclose(int); |
| |
static void dbadd(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] = { |
static const struct mdoc_handler mdocs[MDOC_MAX] = { |
| { NULL, 0, 0 }, /* Ap */ |
{ NULL, 0 }, /* Ap */ |
| { NULL, 0, 0 }, /* Dd */ |
{ NULL, 0 }, /* Dd */ |
| { NULL, 0, 0 }, /* Dt */ |
{ NULL, 0 }, /* Dt */ |
| { NULL, 0, 0 }, /* Os */ |
{ NULL, 0 }, /* Os */ |
| { pmdoc_Sh, TYPE_Sh, MDOCF_CHILD }, /* Sh */ |
{ parse_mdoc_Sh, TYPE_Sh }, /* Sh */ |
| { pmdoc_head, TYPE_Ss, MDOCF_CHILD }, /* Ss */ |
{ parse_mdoc_head, TYPE_Ss }, /* Ss */ |
| { NULL, 0, 0 }, /* Pp */ |
{ NULL, 0 }, /* Pp */ |
| { NULL, 0, 0 }, /* D1 */ |
{ NULL, 0 }, /* D1 */ |
| { NULL, 0, 0 }, /* Dl */ |
{ NULL, 0 }, /* Dl */ |
| { NULL, 0, 0 }, /* Bd */ |
{ NULL, 0 }, /* Bd */ |
| { NULL, 0, 0 }, /* Ed */ |
{ NULL, 0 }, /* Ed */ |
| { NULL, 0, 0 }, /* Bl */ |
{ NULL, 0 }, /* Bl */ |
| { NULL, 0, 0 }, /* El */ |
{ NULL, 0 }, /* El */ |
| { NULL, 0, 0 }, /* It */ |
{ NULL, 0 }, /* It */ |
| { NULL, 0, 0 }, /* Ad */ |
{ NULL, 0 }, /* Ad */ |
| { NULL, TYPE_An, MDOCF_CHILD }, /* An */ |
{ NULL, TYPE_An }, /* An */ |
| { NULL, TYPE_Ar, MDOCF_CHILD }, /* Ar */ |
{ NULL, TYPE_Ar }, /* Ar */ |
| { NULL, TYPE_Cd, MDOCF_CHILD }, /* Cd */ |
{ NULL, TYPE_Cd }, /* Cd */ |
| { NULL, TYPE_Cm, MDOCF_CHILD }, /* Cm */ |
{ NULL, TYPE_Cm }, /* Cm */ |
| { NULL, TYPE_Dv, MDOCF_CHILD }, /* Dv */ |
{ NULL, TYPE_Dv }, /* Dv */ |
| { NULL, TYPE_Er, MDOCF_CHILD }, /* Er */ |
{ NULL, TYPE_Er }, /* Er */ |
| { NULL, TYPE_Ev, MDOCF_CHILD }, /* Ev */ |
{ NULL, TYPE_Ev }, /* Ev */ |
| { NULL, 0, 0 }, /* Ex */ |
{ NULL, 0 }, /* Ex */ |
| { NULL, TYPE_Fa, MDOCF_CHILD }, /* Fa */ |
{ NULL, TYPE_Fa }, /* Fa */ |
| { pmdoc_Fd, TYPE_In, 0 }, /* Fd */ |
{ parse_mdoc_Fd, 0 }, /* Fd */ |
| { NULL, TYPE_Fl, MDOCF_CHILD }, /* Fl */ |
{ NULL, TYPE_Fl }, /* Fl */ |
| { pmdoc_Fn, 0, 0 }, /* Fn */ |
{ parse_mdoc_Fn, 0 }, /* Fn */ |
| { NULL, TYPE_Ft, MDOCF_CHILD }, /* Ft */ |
{ NULL, TYPE_Ft }, /* Ft */ |
| { NULL, TYPE_Ic, MDOCF_CHILD }, /* Ic */ |
{ NULL, TYPE_Ic }, /* Ic */ |
| { pmdoc_In, TYPE_In, 0 }, /* In */ |
{ NULL, TYPE_In }, /* In */ |
| { NULL, TYPE_Li, MDOCF_CHILD }, /* Li */ |
{ NULL, TYPE_Li }, /* Li */ |
| { pmdoc_Nd, TYPE_Nd, MDOCF_CHILD }, /* Nd */ |
{ parse_mdoc_Nd, TYPE_Nd }, /* Nd */ |
| { pmdoc_Nm, TYPE_Nm, MDOCF_CHILD }, /* Nm */ |
{ parse_mdoc_Nm, TYPE_Nm }, /* Nm */ |
| { NULL, 0, 0 }, /* Op */ |
{ NULL, 0 }, /* Op */ |
| { NULL, 0, 0 }, /* Ot */ |
{ NULL, 0 }, /* Ot */ |
| { NULL, TYPE_Pa, MDOCF_CHILD }, /* Pa */ |
{ NULL, TYPE_Pa }, /* Pa */ |
| { NULL, 0, 0 }, /* Rv */ |
{ NULL, 0 }, /* Rv */ |
| { pmdoc_St, TYPE_St, 0 }, /* St */ |
{ NULL, TYPE_St }, /* St */ |
| { NULL, TYPE_Va, MDOCF_CHILD }, /* Va */ |
{ NULL, TYPE_Va }, /* Va */ |
| { pmdoc_body, TYPE_Va, MDOCF_CHILD }, /* Vt */ |
{ parse_mdoc_body, TYPE_Va }, /* Vt */ |
| { pmdoc_Xr, TYPE_Xr, 0 }, /* Xr */ |
{ parse_mdoc_Xr, 0 }, /* Xr */ |
| { NULL, 0, 0 }, /* %A */ |
{ NULL, 0 }, /* %A */ |
| { NULL, 0, 0 }, /* %B */ |
{ NULL, 0 }, /* %B */ |
| { NULL, 0, 0 }, /* %D */ |
{ NULL, 0 }, /* %D */ |
| { NULL, 0, 0 }, /* %I */ |
{ NULL, 0 }, /* %I */ |
| { NULL, 0, 0 }, /* %J */ |
{ NULL, 0 }, /* %J */ |
| { NULL, 0, 0 }, /* %N */ |
{ NULL, 0 }, /* %N */ |
| { NULL, 0, 0 }, /* %O */ |
{ NULL, 0 }, /* %O */ |
| { NULL, 0, 0 }, /* %P */ |
{ NULL, 0 }, /* %P */ |
| { NULL, 0, 0 }, /* %R */ |
{ NULL, 0 }, /* %R */ |
| { NULL, 0, 0 }, /* %T */ |
{ NULL, 0 }, /* %T */ |
| { NULL, 0, 0 }, /* %V */ |
{ NULL, 0 }, /* %V */ |
| { NULL, 0, 0 }, /* Ac */ |
{ NULL, 0 }, /* Ac */ |
| { NULL, 0, 0 }, /* Ao */ |
{ NULL, 0 }, /* Ao */ |
| { NULL, 0, 0 }, /* Aq */ |
{ NULL, 0 }, /* Aq */ |
| { NULL, TYPE_At, MDOCF_CHILD }, /* At */ |
{ NULL, TYPE_At }, /* At */ |
| { NULL, 0, 0 }, /* Bc */ |
{ NULL, 0 }, /* Bc */ |
| { NULL, 0, 0 }, /* Bf */ |
{ NULL, 0 }, /* Bf */ |
| { NULL, 0, 0 }, /* Bo */ |
{ NULL, 0 }, /* Bo */ |
| { NULL, 0, 0 }, /* Bq */ |
{ NULL, 0 }, /* Bq */ |
| { NULL, TYPE_Bsx, MDOCF_CHILD }, /* Bsx */ |
{ NULL, TYPE_Bsx }, /* Bsx */ |
| { NULL, TYPE_Bx, MDOCF_CHILD }, /* Bx */ |
{ NULL, TYPE_Bx }, /* Bx */ |
| { NULL, 0, 0 }, /* Db */ |
{ NULL, 0 }, /* Db */ |
| { NULL, 0, 0 }, /* Dc */ |
{ NULL, 0 }, /* Dc */ |
| { NULL, 0, 0 }, /* Do */ |
{ NULL, 0 }, /* Do */ |
| { NULL, 0, 0 }, /* Dq */ |
{ NULL, 0 }, /* Dq */ |
| { NULL, 0, 0 }, /* Ec */ |
{ NULL, 0 }, /* Ec */ |
| { NULL, 0, 0 }, /* Ef */ |
{ NULL, 0 }, /* Ef */ |
| { NULL, TYPE_Em, MDOCF_CHILD }, /* Em */ |
{ NULL, TYPE_Em }, /* Em */ |
| { NULL, 0, 0 }, /* Eo */ |
{ NULL, 0 }, /* Eo */ |
| { NULL, TYPE_Fx, MDOCF_CHILD }, /* Fx */ |
{ NULL, TYPE_Fx }, /* Fx */ |
| { NULL, TYPE_Ms, MDOCF_CHILD }, /* Ms */ |
{ NULL, TYPE_Ms }, /* Ms */ |
| { NULL, 0, 0 }, /* No */ |
{ NULL, 0 }, /* No */ |
| { NULL, 0, 0 }, /* Ns */ |
{ NULL, 0 }, /* Ns */ |
| { NULL, TYPE_Nx, MDOCF_CHILD }, /* Nx */ |
{ NULL, TYPE_Nx }, /* Nx */ |
| { NULL, TYPE_Ox, MDOCF_CHILD }, /* Ox */ |
{ NULL, TYPE_Ox }, /* Ox */ |
| { NULL, 0, 0 }, /* Pc */ |
{ NULL, 0 }, /* Pc */ |
| { NULL, 0, 0 }, /* Pf */ |
{ NULL, 0 }, /* Pf */ |
| { NULL, 0, 0 }, /* Po */ |
{ NULL, 0 }, /* Po */ |
| { NULL, 0, 0 }, /* Pq */ |
{ NULL, 0 }, /* Pq */ |
| { NULL, 0, 0 }, /* Qc */ |
{ NULL, 0 }, /* Qc */ |
| { NULL, 0, 0 }, /* Ql */ |
{ NULL, 0 }, /* Ql */ |
| { NULL, 0, 0 }, /* Qo */ |
{ NULL, 0 }, /* Qo */ |
| { NULL, 0, 0 }, /* Qq */ |
{ NULL, 0 }, /* Qq */ |
| { NULL, 0, 0 }, /* Re */ |
{ NULL, 0 }, /* Re */ |
| { NULL, 0, 0 }, /* Rs */ |
{ NULL, 0 }, /* Rs */ |
| { NULL, 0, 0 }, /* Sc */ |
{ NULL, 0 }, /* Sc */ |
| { NULL, 0, 0 }, /* So */ |
{ NULL, 0 }, /* So */ |
| { NULL, 0, 0 }, /* Sq */ |
{ NULL, 0 }, /* Sq */ |
| { NULL, 0, 0 }, /* Sm */ |
{ NULL, 0 }, /* Sm */ |
| { NULL, 0, 0 }, /* Sx */ |
{ NULL, 0 }, /* Sx */ |
| { NULL, TYPE_Sy, MDOCF_CHILD }, /* Sy */ |
{ NULL, TYPE_Sy }, /* Sy */ |
| { NULL, TYPE_Tn, MDOCF_CHILD }, /* Tn */ |
{ NULL, TYPE_Tn }, /* Tn */ |
| { NULL, 0, 0 }, /* Ux */ |
{ NULL, 0 }, /* Ux */ |
| { NULL, 0, 0 }, /* Xc */ |
{ NULL, 0 }, /* Xc */ |
| { NULL, 0, 0 }, /* Xo */ |
{ NULL, 0 }, /* Xo */ |
| { pmdoc_head, TYPE_Fn, 0 }, /* Fo */ |
{ parse_mdoc_head, 0 }, /* Fo */ |
| { NULL, 0, 0 }, /* Fc */ |
{ NULL, 0 }, /* Fc */ |
| { NULL, 0, 0 }, /* Oo */ |
{ NULL, 0 }, /* Oo */ |
| { NULL, 0, 0 }, /* Oc */ |
{ NULL, 0 }, /* Oc */ |
| { NULL, 0, 0 }, /* Bk */ |
{ NULL, 0 }, /* Bk */ |
| { NULL, 0, 0 }, /* Ek */ |
{ NULL, 0 }, /* Ek */ |
| { NULL, 0, 0 }, /* Bt */ |
{ NULL, 0 }, /* Bt */ |
| { NULL, 0, 0 }, /* Hf */ |
{ NULL, 0 }, /* Hf */ |
| { NULL, 0, 0 }, /* Fr */ |
{ NULL, 0 }, /* Fr */ |
| { NULL, 0, 0 }, /* Ud */ |
{ NULL, 0 }, /* Ud */ |
| { NULL, TYPE_Lb, MDOCF_CHILD }, /* Lb */ |
{ NULL, TYPE_Lb }, /* Lb */ |
| { NULL, 0, 0 }, /* Lp */ |
{ NULL, 0 }, /* Lp */ |
| { NULL, TYPE_Lk, MDOCF_CHILD }, /* Lk */ |
{ NULL, TYPE_Lk }, /* Lk */ |
| { NULL, TYPE_Mt, MDOCF_CHILD }, /* Mt */ |
{ NULL, TYPE_Mt }, /* Mt */ |
| { NULL, 0, 0 }, /* Brq */ |
{ NULL, 0 }, /* Brq */ |
| { NULL, 0, 0 }, /* Bro */ |
{ NULL, 0 }, /* Bro */ |
| { NULL, 0, 0 }, /* Brc */ |
{ NULL, 0 }, /* Brc */ |
| { NULL, 0, 0 }, /* %C */ |
{ NULL, 0 }, /* %C */ |
| { NULL, 0, 0 }, /* Es */ |
{ NULL, 0 }, /* Es */ |
| { NULL, 0, 0 }, /* En */ |
{ NULL, 0 }, /* En */ |
| { NULL, TYPE_Dx, MDOCF_CHILD }, /* Dx */ |
{ NULL, TYPE_Dx }, /* Dx */ |
| { NULL, 0, 0 }, /* %Q */ |
{ NULL, 0 }, /* %Q */ |
| { NULL, 0, 0 }, /* br */ |
{ NULL, 0 }, /* br */ |
| { NULL, 0, 0 }, /* sp */ |
{ NULL, 0 }, /* sp */ |
| { NULL, 0, 0 }, /* %U */ |
{ NULL, 0 }, /* %U */ |
| { NULL, 0, 0 }, /* Ta */ |
{ NULL, 0 }, /* Ta */ |
| }; |
}; |
| |
|
| static const char *progname; |
|
| static int use_all; /* Use all directories and files. */ |
|
| static int verb; /* Output verbosity level. */ |
|
| static int warnings; /* Potential problems in manuals. */ |
|
| |
|
| int |
int |
| main(int argc, char *argv[]) |
main(int argc, char *argv[]) |
| { |
{ |
| struct mparse *mp; /* parse sequence */ |
int ch, i; |
| struct manpaths dirs; |
size_t j, sz; |
| struct mdb mdb; |
const char *path_arg; |
| struct recs recs; |
struct mchars *mc; |
| enum op op; /* current operation */ |
struct manpaths dirs; |
| const char *dir; |
struct mparse *mp; |
| int ch, i, flags; |
struct ohash_info mpages_info, mlinks_info; |
| char dirbuf[MAXPATHLEN]; |
|
| DB *hash; /* temporary keyword hashtable */ |
|
| BTREEINFO info; /* btree configuration */ |
|
| size_t sz1, sz2; |
|
| 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; |
| |
|
| memset(&dirs, 0, sizeof(struct manpaths)); |
/* |
| memset(&mdb, 0, sizeof(struct mdb)); |
* We accept a few different invocations. |
| memset(&recs, 0, sizeof(struct recs)); |
* The CHECKOP macro makes sure that invocation styles don't |
| |
* clobber each other. |
| |
*/ |
| |
#define CHECKOP(_op, _ch) do \ |
| |
if (OP_DEFAULT != (_op)) { \ |
| |
fprintf(stderr, "-%c: Conflicting option\n", (_ch)); \ |
| |
goto usage; \ |
| |
} while (/*CONSTCOND*/0) |
| |
|
| of = NULL; |
path_arg = NULL; |
| mp = NULL; |
|
| hash = NULL; |
|
| op = OP_DEFAULT; |
op = OP_DEFAULT; |
| dir = NULL; |
|
| |
|
| while (-1 != (ch = getopt(argc, argv, "aC:d:tu:vW"))) |
while (-1 != (ch = getopt(argc, argv, "aC:d:nQT:tu:vW"))) |
| switch (ch) { |
switch (ch) { |
| case ('a'): |
case ('a'): |
| use_all = 1; |
use_all = 1; |
| break; |
break; |
| case ('C'): |
case ('C'): |
| if (op) { |
CHECKOP(op, ch); |
| fprintf(stderr, |
path_arg = optarg; |
| "-C: conflicting options\n"); |
|
| goto usage; |
|
| } |
|
| dir = optarg; |
|
| op = OP_CONFFILE; |
op = OP_CONFFILE; |
| break; |
break; |
| case ('d'): |
case ('d'): |
| if (op) { |
CHECKOP(op, ch); |
| fprintf(stderr, |
path_arg = optarg; |
| "-d: conflicting options\n"); |
op = OP_UPDATE; |
| |
break; |
| |
case ('n'): |
| |
nodb = 1; |
| |
break; |
| |
case ('Q'): |
| |
quick = 1; |
| |
break; |
| |
case ('T'): |
| |
if (strcmp(optarg, "utf8")) { |
| |
fprintf(stderr, "-T%s: Unsupported " |
| |
"output format\n", optarg); |
| goto usage; |
goto usage; |
| } |
} |
| dir = optarg; |
write_utf8 = 1; |
| op = OP_UPDATE; |
|
| break; |
break; |
| case ('t'): |
case ('t'): |
| |
CHECKOP(op, ch); |
| dup2(STDOUT_FILENO, STDERR_FILENO); |
dup2(STDOUT_FILENO, STDERR_FILENO); |
| if (op) { |
|
| fprintf(stderr, |
|
| "-t: conflicting options\n"); |
|
| goto usage; |
|
| } |
|
| op = OP_TEST; |
op = OP_TEST; |
| use_all = 1; |
nodb = warnings = 1; |
| warnings = 1; |
|
| break; |
break; |
| case ('u'): |
case ('u'): |
| if (op) { |
CHECKOP(op, ch); |
| fprintf(stderr, |
path_arg = optarg; |
| "-u: conflicting options\n"); |
|
| goto usage; |
|
| } |
|
| dir = optarg; |
|
| op = OP_DELETE; |
op = OP_DELETE; |
| break; |
break; |
| case ('v'): |
case ('v'): |
| Line 388 main(int argc, char *argv[]) |
|
| Line 402 main(int argc, char *argv[]) |
|
| argv += optind; |
argv += optind; |
| |
|
| if (OP_CONFFILE == op && argc > 0) { |
if (OP_CONFFILE == op && argc > 0) { |
| fprintf(stderr, "-C: too many arguments\n"); |
fprintf(stderr, "-C: Too many arguments\n"); |
| goto usage; |
goto usage; |
| } |
} |
| |
|
| memset(&info, 0, sizeof(BTREEINFO)); |
exitcode = (int)MANDOCLEVEL_OK; |
| info.lorder = 4321; |
mp = mparse_alloc(MPARSE_AUTO, |
| info.flags = R_DUP; |
MANDOCLEVEL_FATAL, NULL, NULL, quick); |
| |
mc = mchars_alloc(); |
| |
|
| mp = mparse_alloc(MPARSE_AUTO, MANDOCLEVEL_FATAL, NULL, NULL); |
ohash_init(&mpages, 6, &mpages_info); |
| |
ohash_init(&mlinks, 6, &mlinks_info); |
| |
|
| memset(&buf, 0, sizeof(struct buf)); |
if (OP_UPDATE == op || OP_DELETE == op || OP_TEST == op) { |
| memset(&dbuf, 0, sizeof(struct buf)); |
/* |
| |
* Force processing all files. |
| |
*/ |
| |
use_all = 1; |
| |
|
| buf.size = dbuf.size = MANDOC_BUFSZ; |
/* |
| |
* All of these deal with a specific directory. |
| buf.cp = mandoc_malloc(buf.size); |
* Jump into that directory then collect files specified |
| dbuf.cp = mandoc_malloc(dbuf.size); |
* on the command-line. |
| |
*/ |
| if (OP_TEST == op) { |
if (0 == set_basedir(path_arg)) |
| ofile_argbuild(argc, argv, &of, "."); |
|
| if (NULL == of) |
|
| goto out; |
goto out; |
| index_merge(of, mp, &dbuf, &buf, |
for (i = 0; i < argc; i++) |
| hash, &mdb, &recs, "."); |
filescan(argv[i]); |
| goto out; |
if (0 == dbopen(1)) |
| } |
|
| |
|
| if (OP_UPDATE == op || OP_DELETE == op) { |
|
| strlcat(mdb.dbn, dir, MAXPATHLEN); |
|
| strlcat(mdb.dbn, "/", MAXPATHLEN); |
|
| sz1 = strlcat(mdb.dbn, MANDOC_DB, MAXPATHLEN); |
|
| |
|
| strlcat(mdb.idxn, dir, MAXPATHLEN); |
|
| strlcat(mdb.idxn, "/", MAXPATHLEN); |
|
| sz2 = strlcat(mdb.idxn, MANDOC_IDX, MAXPATHLEN); |
|
| |
|
| if (sz1 >= MAXPATHLEN || sz2 >= MAXPATHLEN) { |
|
| fprintf(stderr, "%s: path too long\n", dir); |
|
| exit((int)MANDOCLEVEL_BADARG); |
|
| } |
|
| |
|
| flags = O_CREAT | O_RDWR; |
|
| mdb.db = dbopen(mdb.dbn, flags, 0644, DB_BTREE, &info); |
|
| mdb.idx = dbopen(mdb.idxn, flags, 0644, DB_RECNO, NULL); |
|
| |
|
| if (NULL == mdb.db) { |
|
| perror(mdb.dbn); |
|
| exit((int)MANDOCLEVEL_SYSERR); |
|
| } else if (NULL == mdb.idx) { |
|
| perror(mdb.idxn); |
|
| exit((int)MANDOCLEVEL_SYSERR); |
|
| } |
|
| |
|
| ofile_argbuild(argc, argv, &of, dir); |
|
| |
|
| if (NULL == of) |
|
| goto out; |
goto out; |
| |
if (OP_TEST != op) |
| index_prune(of, &mdb, &recs, dir); |
dbprune(); |
| |
if (OP_DELETE != op) |
| |
mpages_merge(mc, mp); |
| |
dbclose(1); |
| |
} else { |
| /* |
/* |
| * Go to the root of the respective manual tree. |
* If we have arguments, use them as our manpaths. |
| * This must work or no manuals may be found (they're |
* If we don't, grok from manpath(1) or however else |
| * indexed relative to the root). |
* 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); |
| |
|
| if (OP_UPDATE == op) { |
|
| if (-1 == chdir(dir)) { |
|
| perror(dir); |
|
| exit((int)MANDOCLEVEL_SYSERR); |
|
| } |
|
| index_merge(of, mp, &dbuf, &buf, hash, |
|
| &mdb, &recs, dir); |
|
| } |
|
| |
|
| goto out; |
|
| } |
|
| |
|
| /* |
|
| * Configure the directories we're going to scan. |
|
| * If we have command-line arguments, use them. |
|
| * If not, we use man(1)'s method (see mandocdb.8). |
|
| */ |
|
| |
|
| if (argc > 0) { |
|
| dirs.paths = mandoc_calloc(argc, sizeof(char *)); |
|
| dirs.sz = argc; |
|
| for (i = 0; i < argc; i++) |
|
| dirs.paths[i] = mandoc_strdup(argv[i]); |
|
| } else |
|
| manpath_parse(&dirs, dir, NULL, NULL); |
|
| |
|
| for (i = 0; i < dirs.sz; i++) { |
|
| /* |
/* |
| * Go to the root of the respective manual tree. |
* First scan the tree rooted at a base directory, then |
| * This must work or no manuals may be found: |
* build a new database and finally move it into place. |
| * They are indexed relative to the root. |
* 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 (-1 == chdir(dirs.paths[i])) { |
if (j) { |
| perror(dirs.paths[i]); |
ohash_init(&mpages, 6, &mpages_info); |
| exit((int)MANDOCLEVEL_SYSERR); |
ohash_init(&mlinks, 6, &mlinks_info); |
| } |
} |
| |
|
| strlcpy(mdb.dbn, MANDOC_DB, MAXPATHLEN); |
if (0 == set_basedir(dirs.paths[j])) |
| strlcpy(mdb.idxn, MANDOC_IDX, MAXPATHLEN); |
goto out; |
| |
if (0 == treescan()) |
| |
goto out; |
| |
if (0 == set_basedir(dirs.paths[j])) |
| |
goto out; |
| |
if (0 == dbopen(0)) |
| |
goto out; |
| |
|
| flags = O_CREAT | O_TRUNC | O_RDWR; |
mpages_merge(mc, mp); |
| mdb.db = dbopen(mdb.dbn, flags, 0644, DB_BTREE, &info); |
dbclose(0); |
| mdb.idx = dbopen(mdb.idxn, flags, 0644, DB_RECNO, NULL); |
|
| |
|
| if (NULL == mdb.db) { |
if (j + 1 < dirs.sz) { |
| perror(mdb.dbn); |
mpages_free(); |
| exit((int)MANDOCLEVEL_SYSERR); |
ohash_delete(&mpages); |
| } else if (NULL == mdb.idx) { |
ohash_delete(&mlinks); |
| perror(mdb.idxn); |
} |
| exit((int)MANDOCLEVEL_SYSERR); |
|
| } |
} |
| |
|
| /* |
|
| * Search for manuals and fill the new database. |
|
| */ |
|
| |
|
| strlcpy(dirbuf, dirs.paths[i], MAXPATHLEN); |
|
| ofile_dirbuild(".", "", "", 0, &of, dirbuf); |
|
| |
|
| if (NULL != of) { |
|
| index_merge(of, mp, &dbuf, &buf, hash, |
|
| &mdb, &recs, dirs.paths[i]); |
|
| ofile_free(of); |
|
| of = NULL; |
|
| } |
|
| |
|
| (*mdb.db->close)(mdb.db); |
|
| (*mdb.idx->close)(mdb.idx); |
|
| mdb.db = NULL; |
|
| mdb.idx = NULL; |
|
| } |
} |
| |
|
| out: |
out: |
| if (mdb.db) |
set_basedir(NULL); |
| (*mdb.db->close)(mdb.db); |
|
| if (mdb.idx) |
|
| (*mdb.idx->close)(mdb.idx); |
|
| if (hash) |
|
| (*hash->close)(hash); |
|
| if (mp) |
|
| mparse_free(mp); |
|
| |
|
| manpath_free(&dirs); |
manpath_free(&dirs); |
| ofile_free(of); |
mchars_free(mc); |
| free(buf.cp); |
mparse_free(mp); |
| free(dbuf.cp); |
mpages_free(); |
| free(recs.stack); |
ohash_delete(&mpages); |
| |
ohash_delete(&mlinks); |
| return(MANDOCLEVEL_OK); |
return(exitcode); |
| |
|
| usage: |
usage: |
| fprintf(stderr, |
fprintf(stderr, "usage: %s [-anQvW] [-C file] [-Tutf8]\n" |
| "usage: %s [-av] [-C file] | dir ... | -t file ...\n" |
" %s [-anQvW] [-Tutf8] dir ...\n" |
| " -d dir [file ...] | " |
" %s [-nQvW] [-Tutf8] -d dir [file ...]\n" |
| "-u dir [file ...]\n", |
" %s [-nvW] -u dir [file ...]\n" |
| progname); |
" %s [-Q] -t file ...\n", |
| |
progname, progname, progname, |
| |
progname, progname); |
| |
|
| return((int)MANDOCLEVEL_BADARG); |
return((int)MANDOCLEVEL_BADARG); |
| } |
} |
| |
|
| void |
/* |
| index_merge(const struct of *of, struct mparse *mp, |
* Scan a directory tree rooted at "basedir" for manpages. |
| struct buf *dbuf, struct buf *buf, DB *hash, |
* We use fts(), scanning directory parts along the way for clues to our |
| struct mdb *mdb, struct recs *recs, |
* section and architecture. |
| const char *basedir) |
* |
| |
* 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) |
| { |
{ |
| recno_t rec; |
FTS *f; |
| int ch, skip; |
FTSENT *ff; |
| DBT key, val; |
struct mlink *mlink; |
| DB *files; /* temporary file name table */ |
int dform; |
| char emptystring[1] = {'\0'}; |
char *dsec, *arch, *fsec, *cp; |
| struct mdoc *mdoc; |
const char *path; |
| struct man *man; |
const char *argv[2]; |
| char *p; |
|
| const char *fn, *msec, *march, *mtitle; |
|
| uint64_t mask; |
|
| size_t sv; |
|
| unsigned seq; |
|
| uint64_t vbuf[2]; |
|
| char type; |
|
| |
|
| if (warnings) { |
argv[0] = "."; |
| files = NULL; |
argv[1] = (char *)NULL; |
| hash_reset(&files); |
|
| |
/* |
| |
* Walk through all components under the directory, using the |
| |
* logical descent of files. |
| |
*/ |
| |
f = fts_open((char * const *)argv, FTS_LOGICAL, NULL); |
| |
if (NULL == f) { |
| |
exitcode = (int)MANDOCLEVEL_SYSERR; |
| |
say("", NULL); |
| |
return(0); |
| } |
} |
| |
|
| rec = 0; |
dsec = arch = NULL; |
| for (of = of->first; of; of = of->next) { |
dform = FORM_NONE; |
| fn = of->fname; |
|
| |
|
| |
while (NULL != (ff = fts_read(f))) { |
| |
path = ff->fts_path + 2; |
| /* |
/* |
| * Try interpreting the file as mdoc(7) or man(7) |
* If we're a regular file, add an mlink by using the |
| * source code, unless it is already known to be |
* stored directory data and handling the filename. |
| * formatted. Fall back to formatted mode. |
|
| */ |
*/ |
| |
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; |
| |
} |
| |
} 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'; |
| |
|
| mparse_reset(mp); |
mlink = mandoc_calloc(1, sizeof(struct mlink)); |
| mdoc = NULL; |
strlcpy(mlink->file, path, sizeof(mlink->file)); |
| man = NULL; |
mlink->dform = dform; |
| |
mlink->dsec = dsec; |
| if ((MANDOC_SRC & of->src_form || |
mlink->arch = arch; |
| ! (MANDOC_FORM & of->src_form)) && |
mlink->name = ff->fts_name; |
| MANDOCLEVEL_FATAL > mparse_readfd(mp, -1, fn)) |
mlink->fsec = fsec; |
| mparse_result(mp, &mdoc, &man); |
mlink_add(mlink, ff->fts_statp); |
| |
|
| if (NULL != mdoc) { |
|
| msec = mdoc_meta(mdoc)->msec; |
|
| march = mdoc_meta(mdoc)->arch; |
|
| if (NULL == march) |
|
| march = ""; |
|
| mtitle = mdoc_meta(mdoc)->title; |
|
| } else if (NULL != man) { |
|
| msec = man_meta(man)->msec; |
|
| march = ""; |
|
| mtitle = man_meta(man)->title; |
|
| } else { |
|
| msec = of->sec; |
|
| march = of->arch; |
|
| mtitle = of->title; |
|
| } |
|
| |
|
| /* |
|
| * 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. |
|
| */ |
|
| |
|
| skip = 0; |
|
| assert(of->sec); |
|
| assert(msec); |
|
| if (strcasecmp(msec, of->sec)) |
|
| WARNING(fn, basedir, "Section \"%s\" manual " |
|
| "in \"%s\" directory", msec, of->sec); |
|
| /* |
|
| * Manual page directories exist for each kernel |
|
| * architecture as returned by machine(1). |
|
| * However, many manuals only depend on the |
|
| * application architecture as returned by arch(1). |
|
| * For example, some (2/ARM) manuals are shared |
|
| * across the "armish" and "zaurus" kernel |
|
| * architectures. |
|
| * A few manuals are even shared across completely |
|
| * different architectures, for example fdformat(1) |
|
| * on amd64, i386, sparc, and sparc64. |
|
| * Thus, warn about architecture mismatches, |
|
| * but don't skip manuals for this reason. |
|
| */ |
|
| |
|
| assert(of->arch); |
|
| assert(march); |
|
| if (strcasecmp(march, of->arch)) |
|
| WARNING(fn, basedir, "Architecture \"%s\" " |
|
| "manual in \"%s\" directory", |
|
| march, of->arch); |
|
| |
|
| /* |
|
| * By default, skip a file if the title given |
|
| * in the file disagrees with the file name. |
|
| * Do not warn, this happens for all MLINKs. |
|
| */ |
|
| |
|
| assert(of->title); |
|
| assert(mtitle); |
|
| if (strcasecmp(mtitle, of->title)) |
|
| skip = 1; |
|
| |
|
| /* |
|
| * 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 (warnings) { |
|
| buf->len = 0; |
|
| buf_appendb(buf, mtitle, strlen(mtitle)); |
|
| buf_appendb(buf, "(", 1); |
|
| buf_appendb(buf, msec, strlen(msec)); |
|
| if ('\0' != *march) { |
|
| buf_appendb(buf, "/", 1); |
|
| buf_appendb(buf, march, strlen(march)); |
|
| } |
|
| buf_appendb(buf, ")", 2); |
|
| for (p = buf->cp; '\0' != *p; p++) |
|
| *p = tolower(*p); |
|
| key.data = buf->cp; |
|
| key.size = buf->len; |
|
| val.data = NULL; |
|
| val.size = 0; |
|
| if (0 == skip) |
|
| val.data = emptystring; |
|
| else { |
|
| ch = (*files->get)(files, &key, &val, 0); |
|
| if (ch < 0) { |
|
| perror("hash"); |
|
| exit((int)MANDOCLEVEL_SYSERR); |
|
| } else if (ch > 0) { |
|
| val.data = (void *)fn; |
|
| val.size = strlen(fn) + 1; |
|
| } else |
|
| val.data = NULL; |
|
| } |
|
| if (NULL != val.data && |
|
| (*files->put)(files, &key, &val, 0) < 0) { |
|
| perror("hash"); |
|
| exit((int)MANDOCLEVEL_SYSERR); |
|
| } |
|
| } |
|
| |
|
| if (skip && !use_all) |
|
| continue; |
continue; |
| |
} else if (FTS_D != ff->fts_info && |
| /* |
FTS_DP != ff->fts_info) { |
| * The index record value consists of a nil-terminated |
if (warnings) |
| * filename, a nil-terminated manual section, and a |
say(path, "Not a regular file"); |
| * nil-terminated description. Use the actual |
|
| * location of the file, such that the user can find |
|
| * it with man(1). Since the description may not be |
|
| * set, we set a sentinel to see if we're going to |
|
| * write a nil byte in its place. |
|
| */ |
|
| |
|
| dbuf->len = 0; |
|
| type = mdoc ? 'd' : (man ? 'a' : 'c'); |
|
| buf_appendb(dbuf, &type, 1); |
|
| buf_appendb(dbuf, fn, strlen(fn) + 1); |
|
| buf_appendb(dbuf, of->sec, strlen(of->sec) + 1); |
|
| buf_appendb(dbuf, of->title, strlen(of->title) + 1); |
|
| buf_appendb(dbuf, of->arch, strlen(of->arch) + 1); |
|
| |
|
| sv = dbuf->len; |
|
| |
|
| /* |
|
| * Collect keyword/mask pairs. |
|
| * Each pair will become a new btree node. |
|
| */ |
|
| |
|
| hash_reset(&hash); |
|
| if (mdoc) |
|
| pmdoc_node(hash, buf, dbuf, |
|
| mdoc_node(mdoc), mdoc_meta(mdoc)); |
|
| else if (man) |
|
| pman_node(hash, buf, dbuf, man_node(man)); |
|
| else |
|
| pformatted(hash, buf, dbuf, of, basedir); |
|
| |
|
| /* Test mode, do not access any database. */ |
|
| |
|
| if (NULL == mdb->db || NULL == mdb->idx) |
|
| continue; |
continue; |
| |
|
| /* |
|
| * Make sure the file name is always registered |
|
| * as an .Nm search key. |
|
| */ |
|
| buf->len = 0; |
|
| buf_append(buf, of->title); |
|
| hash_put(hash, buf, TYPE_Nm); |
|
| |
|
| /* |
|
| * Reclaim an empty index record, if available. |
|
| * Use its record number for all new btree nodes. |
|
| */ |
|
| |
|
| if (recs->cur > 0) { |
|
| recs->cur--; |
|
| rec = recs->stack[(int)recs->cur]; |
|
| } else if (recs->last > 0) { |
|
| rec = recs->last; |
|
| recs->last = 0; |
|
| } else |
|
| rec++; |
|
| vbuf[1] = htobe64(rec); |
|
| |
|
| /* |
|
| * Copy from the in-memory hashtable of pending |
|
| * keyword/mask pairs into the database. |
|
| */ |
|
| |
|
| seq = R_FIRST; |
|
| while (0 == (ch = (*hash->seq)(hash, &key, &val, seq))) { |
|
| seq = R_NEXT; |
|
| assert(sizeof(uint64_t) == val.size); |
|
| memcpy(&mask, val.data, val.size); |
|
| vbuf[0] = htobe64(mask); |
|
| val.size = sizeof(vbuf); |
|
| val.data = &vbuf; |
|
| dbt_put(mdb->db, mdb->dbn, &key, &val); |
|
| } |
} |
| if (ch < 0) { |
|
| perror("hash"); |
|
| exit((int)MANDOCLEVEL_SYSERR); |
|
| } |
|
| |
|
| /* |
switch (ff->fts_level) { |
| * Apply to the index. If we haven't had a description |
case (0): |
| * set, put an empty one in now. |
/* 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; |
| |
|
| if (dbuf->len == sv) |
if (0 == strncmp(cp, "man", 3)) { |
| buf_appendb(dbuf, "", 1); |
dform = FORM_SRC; |
| |
dsec = cp + 3; |
| |
} else if (0 == strncmp(cp, "cat", 3)) { |
| |
dform = FORM_CAT; |
| |
dsec = cp + 3; |
| |
} else { |
| |
dform = FORM_NONE; |
| |
dsec = NULL; |
| |
} |
| |
|
| key.data = &rec; |
if (NULL != dsec || use_all) |
| key.size = sizeof(recno_t); |
break; |
| |
|
| val.data = dbuf->cp; |
if (warnings) |
| val.size = dbuf->len; |
say(path, "Unknown directory part"); |
| |
fts_set(f, ff, FTS_SKIP); |
| if (verb) |
break; |
| printf("%s: Adding to index: %s\n", basedir, fn); |
case (2): |
| |
/* |
| dbt_put(mdb->idx, mdb->idxn, &key, &val); |
* Possibly our architecture. |
| } |
* If we're descending, keep tabs on it. |
| |
*/ |
| /* |
if (FTS_DP != ff->fts_info && NULL != dsec) |
| * Iterate the remembered file titles and check that |
arch = ff->fts_name; |
| * all files can be found by their main title. |
else |
| */ |
arch = NULL; |
| |
break; |
| if (warnings) { |
default: |
| seq = R_FIRST; |
if (FTS_DP == ff->fts_info || use_all) |
| while (0 == (*files->seq)(files, &key, &val, seq)) { |
break; |
| seq = R_NEXT; |
if (warnings) |
| if (val.size) |
say(path, "Extraneous directory part"); |
| WARNING((char *)val.data, basedir, |
fts_set(f, ff, FTS_SKIP); |
| "Probably unreachable, title " |
break; |
| "is %s", (char *)key.data); |
|
| } |
} |
| (*files->close)(files); |
|
| } |
} |
| |
|
| |
fts_close(f); |
| |
return(1); |
| } |
} |
| |
|
| /* |
/* |
| * Scan through all entries in the index file `idx' and prune those |
* Add a file to the mlinks table. |
| * entries in `ofile'. |
* Do not verify that it's a "valid" looking manpage (we'll do that |
| * Pruning consists of removing from `db', then invalidating the entry |
* later). |
| * in `idx' (zeroing its value size). |
* |
| |
* 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 |
static void |
| index_prune(const struct of *ofile, struct mdb *mdb, |
filescan(const char *file) |
| struct recs *recs, const char *basedir) |
|
| { |
{ |
| const struct of *of; |
char buf[PATH_MAX]; |
| const char *fn; |
struct stat st; |
| uint64_t vbuf[2]; |
struct mlink *mlink; |
| unsigned seq, sseq; |
char *p, *start; |
| DBT key, val; |
|
| int ch; |
|
| |
|
| recs->cur = 0; |
assert(use_all); |
| seq = R_FIRST; |
|
| while (0 == (ch = (*mdb->idx->seq)(mdb->idx, &key, &val, seq))) { |
|
| seq = R_NEXT; |
|
| assert(sizeof(recno_t) == key.size); |
|
| memcpy(&recs->last, key.data, key.size); |
|
| |
|
| /* Deleted records are zero-sized. Skip them. */ |
if (0 == strncmp(file, "./", 2)) |
| |
file += 2; |
| |
|
| if (0 == val.size) |
if (NULL == realpath(file, buf)) { |
| goto cont; |
exitcode = (int)MANDOCLEVEL_BADARG; |
| |
say(file, NULL); |
| |
return; |
| |
} |
| |
|
| /* |
if (strstr(buf, basedir) == buf) |
| * Make sure we're sane. |
start = buf + strlen(basedir) + 1; |
| * Read past our mdoc/man/cat type to the next string, |
else if (OP_TEST == op) |
| * then make sure it's bounded by a NUL. |
start = buf; |
| * Failing any of these, we go into our error handler. |
else { |
| */ |
exitcode = (int)MANDOCLEVEL_BADARG; |
| |
say("", "%s: outside base directory", buf); |
| |
return; |
| |
} |
| |
|
| fn = (char *)val.data + 1; |
if (-1 == stat(buf, &st)) { |
| if (NULL == memchr(fn, '\0', val.size - 1)) |
exitcode = (int)MANDOCLEVEL_BADARG; |
| break; |
say(file, NULL); |
| |
return; |
| |
} else if ( ! (S_IFREG & st.st_mode)) { |
| |
exitcode = (int)MANDOCLEVEL_BADARG; |
| |
say(file, "Not a regular file"); |
| |
return; |
| |
} |
| |
|
| /* |
mlink = mandoc_calloc(1, sizeof(struct mlink)); |
| * Search for the file in those we care about. |
strlcpy(mlink->file, start, sizeof(mlink->file)); |
| * XXX: build this into a tree. Too slow. |
|
| */ |
|
| |
|
| for (of = ofile->first; of; of = of->next) |
/* |
| if (0 == strcmp(fn, of->fname)) |
* First try to guess our directory structure. |
| break; |
* If we find a separator, try to look for man* or cat*. |
| |
* If we find one of these and what's underneath is a directory, |
| if (NULL == of) |
* assume it's an architecture. |
| continue; |
*/ |
| |
if (NULL != (p = strchr(start, '/'))) { |
| /* |
*p++ = '\0'; |
| * Search through the keyword database, throwing out all |
if (0 == strncmp(start, "man", 3)) { |
| * references to our file. |
mlink->dform = FORM_SRC; |
| */ |
mlink->dsec = start + 3; |
| |
} else if (0 == strncmp(start, "cat", 3)) { |
| sseq = R_FIRST; |
mlink->dform = FORM_CAT; |
| while (0 == (ch = (*mdb->db->seq)(mdb->db, |
mlink->dsec = start + 3; |
| &key, &val, sseq))) { |
|
| sseq = R_NEXT; |
|
| if (sizeof(vbuf) != val.size) |
|
| break; |
|
| |
|
| memcpy(vbuf, val.data, val.size); |
|
| if (recs->last != betoh64(vbuf[1])) |
|
| continue; |
|
| |
|
| if ((ch = (*mdb->db->del)(mdb->db, |
|
| &key, R_CURSOR)) < 0) |
|
| break; |
|
| } |
} |
| |
|
| if (ch < 0) { |
start = p; |
| perror(mdb->dbn); |
if (NULL != mlink->dsec && NULL != (p = strchr(start, '/'))) { |
| exit((int)MANDOCLEVEL_SYSERR); |
*p++ = '\0'; |
| } else if (1 != ch) { |
mlink->arch = start; |
| fprintf(stderr, "%s: corrupt database\n", |
start = p; |
| mdb->dbn); |
|
| exit((int)MANDOCLEVEL_SYSERR); |
|
| } |
} |
| |
} |
| |
|
| if (verb) |
/* |
| printf("%s: Deleting from index: %s\n", |
* Now check the file suffix. |
| basedir, fn); |
* Suffix of `.0' indicates a catpage, `.1-9' is a manpage. |
| |
*/ |
| |
p = strrchr(start, '\0'); |
| |
while (p-- > start && '/' != *p && '.' != *p) |
| |
/* Loop. */ ; |
| |
|
| val.size = 0; |
if ('.' == *p) { |
| ch = (*mdb->idx->put)(mdb->idx, &key, &val, R_CURSOR); |
*p++ = '\0'; |
| |
mlink->fsec = p; |
| if (ch < 0) |
|
| break; |
|
| cont: |
|
| if (recs->cur >= recs->size) { |
|
| recs->size += MANDOC_SLOP; |
|
| recs->stack = mandoc_realloc(recs->stack, |
|
| recs->size * sizeof(recno_t)); |
|
| } |
|
| |
|
| recs->stack[(int)recs->cur] = recs->last; |
|
| recs->cur++; |
|
| } |
} |
| |
|
| if (ch < 0) { |
/* |
| perror(mdb->idxn); |
* Now try to parse the name. |
| exit((int)MANDOCLEVEL_SYSERR); |
* Use the filename portion of the path. |
| } else if (1 != ch) { |
*/ |
| fprintf(stderr, "%s: corrupt index\n", mdb->idxn); |
mlink->name = start; |
| exit((int)MANDOCLEVEL_SYSERR); |
if (NULL != (p = strrchr(start, '/'))) { |
| |
mlink->name = p + 1; |
| |
*p = '\0'; |
| } |
} |
| |
mlink_add(mlink, &st); |
| recs->last++; |
|
| } |
} |
| |
|
| /* |
|
| * Grow the buffer (if necessary) and copy in a binary string. |
|
| */ |
|
| static void |
static void |
| buf_appendb(struct buf *buf, const void *cp, size_t sz) |
mlink_add(struct mlink *mlink, const struct stat *st) |
| { |
{ |
| |
struct inodev inodev; |
| |
struct mpage *mpage; |
| |
unsigned int slot; |
| |
|
| /* Overshoot by MANDOC_BUFSZ. */ |
assert(NULL != mlink->file); |
| |
|
| while (buf->len + sz >= buf->size) { |
mlink->dsec = mandoc_strdup(mlink->dsec ? mlink->dsec : ""); |
| buf->size = buf->len + sz + MANDOC_BUFSZ; |
mlink->arch = mandoc_strdup(mlink->arch ? mlink->arch : ""); |
| buf->cp = mandoc_realloc(buf->cp, buf->size); |
mlink->name = mandoc_strdup(mlink->name ? mlink->name : ""); |
| } |
mlink->fsec = mandoc_strdup(mlink->fsec ? mlink->fsec : ""); |
| |
|
| memcpy(buf->cp + (int)buf->len, cp, sz); |
if ('0' == *mlink->fsec) { |
| buf->len += sz; |
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); |
| |
assert(NULL == ohash_find(&mlinks, slot)); |
| |
ohash_insert(&mlinks, slot, mlink); |
| |
|
| |
inodev.st_ino = st->st_ino; |
| |
inodev.st_dev = st->st_dev; |
| |
slot = ohash_lookup_memory(&mpages, (char *)&inodev, |
| |
sizeof(struct inodev), inodev.st_ino); |
| |
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; |
| } |
} |
| |
|
| /* |
|
| * 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) |
mlink_free(struct mlink *mlink) |
| { |
{ |
| size_t sz; |
|
| |
|
| if (0 == (sz = strlen(cp))) |
free(mlink->dsec); |
| return; |
free(mlink->arch); |
| |
free(mlink->name); |
| if (buf->len) |
free(mlink->fsec); |
| buf->cp[(int)buf->len - 1] = ' '; |
free(mlink); |
| |
|
| buf_appendb(buf, cp, sz + 1); |
|
| } |
} |
| |
|
| /* |
|
| * Recursively add all text from a given node. |
|
| * This is optimised for general mdoc nodes in this context, which do |
|
| * not consist of subexpressions and having a recursive call for n->next |
|
| * would be wasteful. |
|
| * The "f" variable should be 0 unless called from pmdoc_Nd for the |
|
| * description buffer, which does not start at the beginning of the |
|
| * buffer. |
|
| */ |
|
| static void |
static void |
| buf_appendmdoc(struct buf *buf, const struct mdoc_node *n, int f) |
mpages_free(void) |
| { |
{ |
| |
struct mpage *mpage; |
| |
struct mlink *mlink; |
| |
unsigned int slot; |
| |
|
| for ( ; n; n = n->next) { |
mpage = ohash_first(&mpages, &slot); |
| if (n->child) |
while (NULL != mpage) { |
| buf_appendmdoc(buf, n->child, f); |
while (NULL != (mlink = mpage->mlinks)) { |
| |
mpage->mlinks = mlink->next; |
| if (MDOC_TEXT == n->type && f) { |
mlink_free(mlink); |
| f = 0; |
} |
| buf_appendb(buf, n->string, |
free(mpage->sec); |
| strlen(n->string) + 1); |
free(mpage->arch); |
| } else if (MDOC_TEXT == n->type) |
free(mpage->title); |
| buf_append(buf, n->string); |
free(mpage->desc); |
| |
free(mpage); |
| |
mpage = ohash_next(&mpages, &slot); |
| } |
} |
| } |
} |
| |
|
| |
/* |
| |
* For each mlink to the mpage, check whether the path looks like |
| |
* 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 |
static void |
| hash_reset(DB **db) |
mlinks_undupe(struct mpage *mpage) |
| { |
{ |
| DB *hash; |
char buf[PATH_MAX]; |
| |
struct mlink **prev; |
| |
struct mlink *mlink; |
| |
char *bufp; |
| |
|
| if (NULL != (hash = *db)) |
mpage->form = FORM_CAT; |
| (*hash->close)(hash); |
prev = &mpage->mlinks; |
| |
while (NULL != (mlink = *prev)) { |
| *db = dbopen(NULL, O_CREAT|O_RDWR, 0644, DB_HASH, NULL); |
if (FORM_CAT != mlink->dform) { |
| if (NULL == *db) { |
mpage->form = FORM_NONE; |
| perror("hash"); |
goto nextlink; |
| exit((int)MANDOCLEVEL_SYSERR); |
} |
| |
if (strlcpy(buf, mlink->file, PATH_MAX) >= PATH_MAX) { |
| |
if (warnings) |
| |
say(mlink->file, "Filename too long"); |
| |
goto nextlink; |
| |
} |
| |
bufp = strstr(buf, "cat"); |
| |
assert(NULL != bufp); |
| |
memcpy(bufp, "man", 3); |
| |
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; |
| } |
} |
| } |
} |
| |
|
| /* ARGSUSED */ |
|
| static int |
static int |
| pmdoc_head(MDOC_ARGS) |
mlink_check(struct mpage *mpage, struct mlink *mlink) |
| { |
{ |
| |
int match; |
| |
|
| return(MDOC_HEAD == n->type); |
match = 1; |
| } |
|
| |
|
| /* ARGSUSED */ |
|
| static int |
|
| pmdoc_body(MDOC_ARGS) |
|
| { |
|
| |
|
| return(MDOC_BODY == n->type); |
|
| } |
|
| |
|
| /* ARGSUSED */ |
|
| static int |
|
| pmdoc_Fd(MDOC_ARGS) |
|
| { |
|
| const char *start, *end; |
|
| size_t sz; |
|
| |
|
| if (SEC_SYNOPSIS != n->sec) |
|
| return(0); |
|
| if (NULL == (n = n->child) || MDOC_TEXT != n->type) |
|
| return(0); |
|
| |
|
| /* |
/* |
| * Only consider those `Fd' macro fields that begin with an |
* Check whether the manual section given in a file |
| * "inclusion" token (versus, e.g., #define). |
* 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 (strcmp("#include", n->string)) |
|
| return(0); |
|
| |
|
| if (NULL == (n = n->next) || MDOC_TEXT != n->type) |
if (FORM_SRC == mpage->form && |
| return(0); |
strcasecmp(mpage->sec, mlink->dsec)) { |
| |
match = 0; |
| |
say(mlink->file, "Section \"%s\" manual in %s directory", |
| |
mpage->sec, mlink->dsec); |
| |
} |
| |
|
| /* |
/* |
| * Strip away the enclosing angle brackets and make sure we're |
* Manual page directories exist for each kernel |
| * not zero-length. |
* 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. |
| */ |
*/ |
| |
|
| start = n->string; |
if (strcasecmp(mpage->arch, mlink->arch)) { |
| if ('<' == *start || '"' == *start) |
match = 0; |
| start++; |
say(mlink->file, "Architecture \"%s\" manual in " |
| |
"\"%s\" directory", mpage->arch, mlink->arch); |
| |
} |
| |
|
| if (0 == (sz = strlen(start))) |
if (strcasecmp(mpage->title, mlink->name)) |
| return(0); |
match = 0; |
| |
|
| end = &start[(int)sz - 1]; |
return(match); |
| if ('>' == *end || '"' == *end) |
|
| end--; |
|
| |
|
| assert(end >= start); |
|
| |
|
| buf_appendb(buf, start, (size_t)(end - start + 1)); |
|
| buf_appendb(buf, "", 1); |
|
| return(1); |
|
| } |
} |
| |
|
| /* ARGSUSED */ |
/* |
| static int |
* Run through the files in the global vector "mpages" |
| pmdoc_In(MDOC_ARGS) |
* 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) |
| { |
{ |
| |
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; |
| |
|
| if (NULL == n->child || MDOC_TEXT != n->child->type) |
str_info.alloc = hash_alloc; |
| return(0); |
str_info.halloc = hash_halloc; |
| |
str_info.hfree = hash_free; |
| |
str_info.key_offset = offsetof(struct str, key); |
| |
|
| buf_append(buf, n->child->string); |
if (0 == nodb) |
| return(1); |
SQL_EXEC("BEGIN TRANSACTION"); |
| } |
|
| |
|
| /* ARGSUSED */ |
mpage = ohash_first(&mpages, &pslot); |
| static int |
while (NULL != mpage) { |
| pmdoc_Fn(MDOC_ARGS) |
mlinks_undupe(mpage); |
| { |
if (NULL == mpage->mlinks) { |
| struct mdoc_node *nn; |
mpage = ohash_next(&mpages, &pslot); |
| const char *cp; |
continue; |
| |
} |
| |
|
| nn = n->child; |
ohash_init(&strings, 6, &str_info); |
| |
mparse_reset(mp); |
| |
mdoc = NULL; |
| |
man = NULL; |
| |
|
| if (NULL == nn || MDOC_TEXT != nn->type) |
/* |
| return(0); |
* 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); |
| |
} |
| |
|
| /* .Fn "struct type *name" "char *arg" */ |
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); |
| |
|
| cp = strrchr(nn->string, ' '); |
for (mlink = mpage->mlinks; mlink; mlink = mlink->next) { |
| if (NULL == cp) |
if ('\0' != *mlink->dsec) |
| cp = nn->string; |
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); |
| |
} |
| |
|
| /* Strip away pointer symbol. */ |
if (warnings && !use_all) { |
| |
match = 0; |
| |
for (mlink = mpage->mlinks; mlink; |
| |
mlink = mlink->next) |
| |
if (mlink_check(mpage, mlink)) |
| |
match = 1; |
| |
} else |
| |
match = 1; |
| |
|
| while ('*' == *cp) |
if (NULL != mdoc) { |
| cp++; |
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); |
| |
|
| /* Store the function name. */ |
dbadd(mpage, mc); |
| |
ohash_delete(&strings); |
| buf_append(buf, cp); |
mpage = ohash_next(&mpages, &pslot); |
| hash_put(hash, buf, TYPE_Fn); |
|
| |
|
| /* Store the function type. */ |
|
| |
|
| if (nn->string < cp) { |
|
| buf->len = 0; |
|
| buf_appendb(buf, nn->string, cp - nn->string); |
|
| buf_appendb(buf, "", 1); |
|
| hash_put(hash, buf, TYPE_Ft); |
|
| } |
} |
| |
|
| /* Store the arguments. */ |
if (0 == nodb) |
| |
SQL_EXEC("END TRANSACTION"); |
| for (nn = nn->next; nn; nn = nn->next) { |
|
| if (MDOC_TEXT != nn->type) |
|
| continue; |
|
| buf->len = 0; |
|
| buf_append(buf, nn->string); |
|
| hash_put(hash, buf, TYPE_Fa); |
|
| } |
|
| |
|
| return(0); |
|
| } |
} |
| |
|
| /* ARGSUSED */ |
static void |
| static int |
parse_cat(struct mpage *mpage) |
| pmdoc_St(MDOC_ARGS) |
|
| { |
{ |
| |
FILE *stream; |
| |
char *line, *p, *title; |
| |
size_t len, plen, titlesz; |
| |
|
| if (NULL == n->child || MDOC_TEXT != n->child->type) |
if (NULL == (stream = fopen(mpage->mlinks->file, "r"))) { |
| return(0); |
if (warnings) |
| |
say(mpage->mlinks->file, NULL); |
| |
return; |
| |
} |
| |
|
| buf_append(buf, n->child->string); |
/* Skip to first blank line. */ |
| return(1); |
|
| } |
|
| |
|
| /* ARGSUSED */ |
while (NULL != (line = fgetln(stream, &len))) |
| static int |
if ('\n' == *line) |
| pmdoc_Xr(MDOC_ARGS) |
break; |
| { |
|
| |
|
| if (NULL == (n = n->child)) |
/* |
| return(0); |
* Assume the first line that is not indented |
| |
* is the first section header. Skip to it. |
| |
*/ |
| |
|
| buf_appendb(buf, n->string, strlen(n->string)); |
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. |
| |
*/ |
| |
|
| if (NULL != (n = n->next)) { |
titlesz = 0; |
| buf_appendb(buf, ".", 1); |
title = NULL; |
| buf_appendb(buf, n->string, strlen(n->string) + 1); |
|
| } else |
|
| buf_appendb(buf, ".", 2); |
|
| |
|
| return(1); |
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] = ' '; |
| |
} |
| |
|
| /* ARGSUSED */ |
/* |
| static int |
* If no page content can be found, or the input line |
| pmdoc_Nd(MDOC_ARGS) |
* is already the next section header, or there is no |
| { |
* trailing newline, reuse the page title as the page |
| |
* description. |
| |
*/ |
| |
|
| if (MDOC_BODY != n->type) |
if (NULL == title || '\0' == *title) { |
| return(0); |
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; |
| |
} |
| |
|
| buf_appendmdoc(dbuf, n->child, 1); |
title = mandoc_realloc(title, titlesz + 1); |
| return(1); |
title[titlesz] = '\0'; |
| } |
|
| |
|
| /* ARGSUSED */ |
/* |
| static int |
* Skip to the first dash. |
| pmdoc_Nm(MDOC_ARGS) |
* Use the remaining line as the description (no more than 70 |
| { |
* bytes). |
| |
*/ |
| |
|
| if (SEC_NAME == n->sec) |
if (NULL != (p = strstr(title, "- "))) { |
| return(1); |
for (p += 2; ' ' == *p || '\b' == *p; p++) |
| else if (SEC_SYNOPSIS != n->sec || MDOC_HEAD != n->type) |
/* Skip to next word. */ ; |
| return(0); |
} else { |
| |
if (warnings) |
| |
say(mpage->mlinks->file, |
| |
"No dash in title line"); |
| |
p = title; |
| |
} |
| |
|
| if (NULL == n->child) |
plen = strlen(p); |
| buf_append(buf, m->name); |
|
| |
|
| return(1); |
/* Strip backspace-encoding from line. */ |
| } |
|
| |
|
| /* ARGSUSED */ |
while (NULL != (line = memchr(p, '\b', plen))) { |
| static int |
len = line - p; |
| pmdoc_Sh(MDOC_ARGS) |
if (0 == len) { |
| { |
memmove(line, line + 1, plen--); |
| |
continue; |
| return(SEC_CUSTOM == n->sec && MDOC_HEAD == n->type); |
} |
| } |
memmove(line - 1, line + 1, plen - len); |
| |
plen -= 2; |
| static void |
|
| hash_put(DB *db, const struct buf *buf, uint64_t mask) |
|
| { |
|
| uint64_t oldmask; |
|
| DBT key, val; |
|
| int rc; |
|
| |
|
| if (buf->len < 2) |
|
| return; |
|
| |
|
| key.data = buf->cp; |
|
| key.size = buf->len; |
|
| |
|
| if ((rc = (*db->get)(db, &key, &val, 0)) < 0) { |
|
| perror("hash"); |
|
| exit((int)MANDOCLEVEL_SYSERR); |
|
| } else if (0 == rc) { |
|
| assert(sizeof(uint64_t) == val.size); |
|
| memcpy(&oldmask, val.data, val.size); |
|
| mask |= oldmask; |
|
| } |
} |
| |
|
| val.data = &mask; |
assert(NULL == mpage->desc); |
| val.size = sizeof(uint64_t); |
mpage->desc = mandoc_strdup(p); |
| |
putkey(mpage, mpage->desc, TYPE_Nd); |
| if ((rc = (*db->put)(db, &key, &val, 0)) < 0) { |
fclose(stream); |
| perror("hash"); |
free(title); |
| exit((int)MANDOCLEVEL_SYSERR); |
|
| } |
|
| } |
} |
| |
|
| |
/* |
| |
* Put a type/word pair into the word database for this particular file. |
| |
*/ |
| static void |
static void |
| dbt_put(DB *db, const char *dbn, DBT *key, DBT *val) |
putkey(const struct mpage *mpage, const char *value, uint64_t type) |
| { |
{ |
| |
|
| assert(key->size); |
assert(NULL != value); |
| assert(val->size); |
putkeys(mpage, value, strlen(value), type); |
| |
|
| if (0 == (*db->put)(db, key, val, 0)) |
|
| return; |
|
| |
|
| perror(dbn); |
|
| exit((int)MANDOCLEVEL_SYSERR); |
|
| /* NOTREACHED */ |
|
| } |
} |
| |
|
| /* |
/* |
| * Call out to per-macro handlers after clearing the persistent database |
* Grok all nodes at or below a certain mdoc node into putkey(). |
| * key. If the macro sets the database key, flush it to the database. |
|
| */ |
*/ |
| static void |
static void |
| pmdoc_node(MDOC_ARGS) |
putmdockey(const struct mpage *mpage, |
| |
const struct mdoc_node *n, uint64_t m) |
| { |
{ |
| |
|
| if (NULL == n) |
for ( ; NULL != n; n = n->next) { |
| return; |
if (NULL != n->child) |
| |
putmdockey(mpage, n->child, m); |
| switch (n->type) { |
if (MDOC_TEXT == n->type) |
| case (MDOC_HEAD): |
putkey(mpage, n->string, m); |
| /* FALLTHROUGH */ |
|
| case (MDOC_BODY): |
|
| /* FALLTHROUGH */ |
|
| case (MDOC_TAIL): |
|
| /* FALLTHROUGH */ |
|
| case (MDOC_BLOCK): |
|
| /* FALLTHROUGH */ |
|
| case (MDOC_ELEM): |
|
| buf->len = 0; |
|
| |
|
| /* |
|
| * Both NULL handlers and handlers returning true |
|
| * request using the data. Only skip the element |
|
| * when the handler returns false. |
|
| */ |
|
| |
|
| if (NULL != mdocs[n->tok].fp && |
|
| 0 == (*mdocs[n->tok].fp)(hash, buf, dbuf, n, m)) |
|
| break; |
|
| |
|
| /* |
|
| * For many macros, use the text from all children. |
|
| * Set zero flags for macros not needing this. |
|
| * In that case, the handler must fill the buffer. |
|
| */ |
|
| |
|
| if (MDOCF_CHILD & mdocs[n->tok].flags) |
|
| buf_appendmdoc(buf, n->child, 0); |
|
| |
|
| /* |
|
| * Cover the most common case: |
|
| * Automatically stage one string per element. |
|
| * Set a zero mask for macros not needing this. |
|
| * Additional staging can be done in the handler. |
|
| */ |
|
| |
|
| if (mdocs[n->tok].mask) |
|
| hash_put(hash, buf, mdocs[n->tok].mask); |
|
| break; |
|
| default: |
|
| break; |
|
| } |
} |
| |
|
| pmdoc_node(hash, buf, dbuf, n->child, m); |
|
| pmdoc_node(hash, buf, dbuf, n->next, m); |
|
| } |
} |
| |
|
| static int |
static void |
| pman_node(MAN_ARGS) |
parse_man(struct mpage *mpage, const struct man_node *n) |
| { |
{ |
| const struct man_node *head, *body; |
const struct man_node *head, *body; |
| char *start, *sv, *title; |
char *start, *sv, *title; |
| |
char byte; |
| size_t sz, titlesz; |
size_t sz, titlesz; |
| |
|
| if (NULL == n) |
if (NULL == n) |
| return(0); |
return; |
| |
|
| /* |
/* |
| * We're only searching for one thing: the first text child in |
* We're only searching for one thing: the first text child in |
| Line 1349 pman_node(MAN_ARGS) |
|
| Line 1237 pman_node(MAN_ARGS) |
|
| |
|
| title = NULL; |
title = NULL; |
| titlesz = 0; |
titlesz = 0; |
| |
|
| /* |
/* |
| * Suck the entire NAME section into memory. |
* Suck the entire NAME section into memory. |
| * Yes, we might run away. |
* Yes, we might run away. |
| * But too many manuals have big, spread-out |
* But too many manuals have big, spread-out |
| * NAME sections over many lines. |
* NAME sections over many lines. |
| */ |
*/ |
| |
|
| for ( ; NULL != body; body = body->next) { |
for ( ; NULL != body; body = body->next) { |
| if (MAN_TEXT != body->type) |
if (MAN_TEXT != body->type) |
| break; |
break; |
| Line 1364 pman_node(MAN_ARGS) |
|
| Line 1254 pman_node(MAN_ARGS) |
|
| (title, titlesz + sz + 1); |
(title, titlesz + sz + 1); |
| memcpy(title + titlesz, body->string, sz); |
memcpy(title + titlesz, body->string, sz); |
| titlesz += sz + 1; |
titlesz += sz + 1; |
| title[(int)titlesz - 1] = ' '; |
title[titlesz - 1] = ' '; |
| } |
} |
| if (NULL == title) |
if (NULL == title) |
| return(0); |
return; |
| |
|
| title = mandoc_realloc(title, titlesz + 1); |
title = mandoc_realloc(title, titlesz + 1); |
| title[(int)titlesz] = '\0'; |
title[titlesz] = '\0'; |
| |
|
| /* Skip leading space. */ |
/* Skip leading space. */ |
| |
|
| Line 1380 pman_node(MAN_ARGS) |
|
| Line 1270 pman_node(MAN_ARGS) |
|
| |
|
| if (0 == (sz = strlen(sv))) { |
if (0 == (sz = strlen(sv))) { |
| free(title); |
free(title); |
| return(0); |
return; |
| } |
} |
| |
|
| /* Erase trailing space. */ |
/* Erase trailing space. */ |
| Line 1391 pman_node(MAN_ARGS) |
|
| Line 1281 pman_node(MAN_ARGS) |
|
| |
|
| if (start == sv) { |
if (start == sv) { |
| free(title); |
free(title); |
| return(0); |
return; |
| } |
} |
| |
|
| start = sv; |
start = sv; |
| |
|
| /* |
/* |
| * Go through a special heuristic dance here. |
* Go through a special heuristic dance here. |
| * This is why -man manuals are great! |
|
| * (I'm being sarcastic: my eyes are bleeding.) |
|
| * Conventionally, one or more manual names are |
* Conventionally, one or more manual names are |
| * comma-specified prior to a whitespace, then a |
* comma-specified prior to a whitespace, then a |
| * dash, then a description. Try to puzzle out |
* dash, then a description. Try to puzzle out |
| Line 1408 pman_node(MAN_ARGS) |
|
| Line 1296 pman_node(MAN_ARGS) |
|
| |
|
| for ( ;; ) { |
for ( ;; ) { |
| sz = strcspn(start, " ,"); |
sz = strcspn(start, " ,"); |
| if ('\0' == start[(int)sz]) |
if ('\0' == start[sz]) |
| break; |
break; |
| |
|
| buf->len = 0; |
byte = start[sz]; |
| buf_appendb(buf, start, sz); |
start[sz] = '\0'; |
| buf_appendb(buf, "", 1); |
|
| |
|
| hash_put(hash, buf, TYPE_Nm); |
putkey(mpage, start, TYPE_Nm); |
| |
|
| if (' ' == start[(int)sz]) { |
if (' ' == byte) { |
| start += (int)sz + 1; |
start += sz + 1; |
| break; |
break; |
| } |
} |
| |
|
| assert(',' == start[(int)sz]); |
assert(',' == byte); |
| start += (int)sz + 1; |
start += sz + 1; |
| while (' ' == *start) |
while (' ' == *start) |
| start++; |
start++; |
| } |
} |
| |
|
| buf->len = 0; |
|
| |
|
| if (sv == start) { |
if (sv == start) { |
| buf_append(buf, start); |
putkey(mpage, start, TYPE_Nm); |
| free(title); |
free(title); |
| return(1); |
return; |
| } |
} |
| |
|
| while (isspace((unsigned char)*start)) |
while (isspace((unsigned char)*start)) |
| Line 1453 pman_node(MAN_ARGS) |
|
| Line 1338 pman_node(MAN_ARGS) |
|
| while (' ' == *start) |
while (' ' == *start) |
| start++; |
start++; |
| |
|
| sz = strlen(start) + 1; |
assert(NULL == mpage->desc); |
| buf_appendb(dbuf, start, sz); |
mpage->desc = mandoc_strdup(start); |
| buf_appendb(buf, start, sz); |
putkey(mpage, mpage->desc, TYPE_Nd); |
| |
|
| hash_put(hash, buf, TYPE_Nd); |
|
| free(title); |
free(title); |
| |
return; |
| } |
} |
| } |
} |
| |
|
| for (n = n->child; n; n = n->next) |
for (n = n->child; n; n = n->next) { |
| if (pman_node(hash, buf, dbuf, n)) |
if (NULL != mpage->desc) |
| return(1); |
break; |
| |
parse_man(mpage, n); |
| return(0); |
} |
| } |
} |
| |
|
| /* |
|
| * Parse a formatted manual page. |
|
| * By necessity, this involves rather crude guesswork. |
|
| */ |
|
| static void |
static void |
| pformatted(DB *hash, struct buf *buf, struct buf *dbuf, |
parse_mdoc(struct mpage *mpage, const struct mdoc_node *n) |
| const struct of *of, const char *basedir) |
|
| { |
{ |
| FILE *stream; |
|
| char *line, *p, *title; |
|
| size_t len, plen, titlesz; |
|
| |
|
| if (NULL == (stream = fopen(of->fname, "r"))) { |
assert(NULL != n); |
| WARNING(of->fname, basedir, "%s", strerror(errno)); |
for (n = n->child; NULL != n; n = n->next) { |
| return; |
switch (n->type) { |
| |
case (MDOC_ELEM): |
| |
/* FALLTHROUGH */ |
| |
case (MDOC_BLOCK): |
| |
/* FALLTHROUGH */ |
| |
case (MDOC_HEAD): |
| |
/* FALLTHROUGH */ |
| |
case (MDOC_BODY): |
| |
/* FALLTHROUGH */ |
| |
case (MDOC_TAIL): |
| |
if (NULL != mdocs[n->tok].fp) |
| |
if (0 == (*mdocs[n->tok].fp)(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); |
| } |
} |
| |
} |
| |
|
| |
static int |
| |
parse_mdoc_Fd(struct mpage *mpage, const struct mdoc_node *n) |
| |
{ |
| |
const char *start, *end; |
| |
size_t sz; |
| |
|
| |
if (SEC_SYNOPSIS != n->sec || |
| |
NULL == (n = n->child) || |
| |
MDOC_TEXT != n->type) |
| |
return(0); |
| |
|
| /* |
/* |
| * Always use the title derived from the filename up front, |
* Only consider those `Fd' macro fields that begin with an |
| * do not even try to find it in the file. This also makes |
* "inclusion" token (versus, e.g., #define). |
| * sure we don't end up with an orphan index record, even if |
|
| * the file content turns out to be completely unintelligible. |
|
| */ |
*/ |
| |
|
| buf->len = 0; |
if (strcmp("#include", n->string)) |
| buf_append(buf, of->title); |
return(0); |
| hash_put(hash, buf, TYPE_Nm); |
|
| |
|
| /* Skip to first blank line. */ |
if (NULL == (n = n->next) || MDOC_TEXT != n->type) |
| |
return(0); |
| |
|
| while (NULL != (line = fgetln(stream, &len))) |
|
| if ('\n' == *line) |
|
| break; |
|
| |
|
| /* |
/* |
| * Assume the first line that is not indented |
* Strip away the enclosing angle brackets and make sure we're |
| * is the first section header. Skip to it. |
* not zero-length. |
| */ |
*/ |
| |
|
| while (NULL != (line = fgetln(stream, &len))) |
start = n->string; |
| if ('\n' != *line && ' ' != *line) |
if ('<' == *start || '"' == *start) |
| break; |
start++; |
| |
|
| /* |
|
| * 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; |
if (0 == (sz = strlen(start))) |
| title = NULL; |
return(0); |
| |
|
| while (NULL != (line = fgetln(stream, &len))) { |
end = &start[(int)sz - 1]; |
| if (' ' != *line || '\n' != line[(int)len - 1]) |
if ('>' == *end || '"' == *end) |
| break; |
end--; |
| 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[(int)titlesz - 1] = ' '; |
|
| } |
|
| |
|
| /* |
if (end > start) |
| * If no page content can be found, or the input line |
putkeys(mpage, start, end - start + 1, TYPE_In); |
| * is already the next section header, or there is no |
return(0); |
| * trailing newline, reuse the page title as the page |
} |
| * description. |
|
| |
static int |
| |
parse_mdoc_Fn(struct mpage *mpage, const struct mdoc_node *n) |
| |
{ |
| |
const char *cp; |
| |
|
| |
if (NULL == (n = n->child) || MDOC_TEXT != n->type) |
| |
return(0); |
| |
|
| |
/* |
| |
* Parse: .Fn "struct type *name" "char *arg". |
| |
* First strip away pointer symbol. |
| |
* Then store the function name, then type. |
| |
* Finally, store the arguments. |
| */ |
*/ |
| |
|
| if (NULL == title || '\0' == *title) { |
if (NULL == (cp = strrchr(n->string, ' '))) |
| WARNING(of->fname, basedir, |
cp = n->string; |
| "Cannot find NAME section"); |
|
| buf_appendb(dbuf, buf->cp, buf->size); |
while ('*' == *cp) |
| hash_put(hash, buf, TYPE_Nd); |
cp++; |
| fclose(stream); |
|
| free(title); |
putkey(mpage, cp, TYPE_Fn); |
| return; |
|
| |
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); |
| |
} |
| |
|
| |
static int |
| |
parse_mdoc_Xr(struct mpage *mpage, const struct mdoc_node *n) |
| |
{ |
| |
char *cp; |
| |
|
| |
if (NULL == (n = n->child)) |
| |
return(0); |
| |
|
| |
if (NULL == n->next) { |
| |
putkey(mpage, n->string, TYPE_Xr); |
| |
return(0); |
| } |
} |
| |
|
| title = mandoc_realloc(title, titlesz + 1); |
if (-1 == asprintf(&cp, "%s(%s)", n->string, n->next->string)) { |
| title[(int)titlesz] = '\0'; |
perror(NULL); |
| |
exit((int)MANDOCLEVEL_SYSERR); |
| |
} |
| |
putkey(mpage, cp, TYPE_Xr); |
| |
free(cp); |
| |
return(0); |
| |
} |
| |
|
| |
static int |
| |
parse_mdoc_Nd(struct mpage *mpage, const struct mdoc_node *n) |
| |
{ |
| |
size_t sz; |
| |
|
| |
if (MDOC_BODY != n->type) |
| |
return(0); |
| |
|
| /* |
/* |
| * Skip to the first dash. |
* Special-case the `Nd' because we need to put the description |
| * Use the remaining line as the description (no more than 70 |
* into the document table. |
| * bytes). |
|
| */ |
*/ |
| |
|
| if (NULL != (p = strstr(title, "- "))) { |
for (n = n->child; NULL != n; n = n->next) { |
| for (p += 2; ' ' == *p || '\b' == *p; p++) |
if (MDOC_TEXT == n->type) { |
| /* Skip to next word. */ ; |
if (NULL != mpage->desc) { |
| } else { |
sz = strlen(mpage->desc) + |
| WARNING(of->fname, basedir, |
strlen(n->string) + 2; |
| "No dash in title line"); |
mpage->desc = mandoc_realloc( |
| p = title; |
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); |
| |
} |
| |
|
| plen = strlen(p); |
static int |
| |
parse_mdoc_Nm(struct mpage *mpage, const struct mdoc_node *n) |
| |
{ |
| |
|
| /* Strip backspace-encoding from line. */ |
return(SEC_NAME == n->sec || |
| |
(SEC_SYNOPSIS == n->sec && MDOC_HEAD == n->type)); |
| |
} |
| |
|
| while (NULL != (line = memchr(p, '\b', plen))) { |
static int |
| len = line - p; |
parse_mdoc_Sh(struct mpage *mpage, const struct mdoc_node *n) |
| if (0 == len) { |
{ |
| memmove(line, line + 1, plen--); |
|
| continue; |
return(SEC_CUSTOM == n->sec && MDOC_HEAD == n->type); |
| } |
} |
| memmove(line - 1, line + 1, plen - len); |
|
| plen -= 2; |
static int |
| |
parse_mdoc_head(struct mpage *mpage, const struct mdoc_node *n) |
| |
{ |
| |
|
| |
return(MDOC_HEAD == n->type); |
| |
} |
| |
|
| |
static int |
| |
parse_mdoc_body(struct mpage *mpage, const struct mdoc_node *n) |
| |
{ |
| |
|
| |
return(MDOC_BODY == n->type); |
| |
} |
| |
|
| |
/* |
| |
* 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 |
| |
putkeys(const struct mpage *mpage, |
| |
const char *cp, size_t sz, uint64_t v) |
| |
{ |
| |
struct str *s; |
| |
unsigned int slot; |
| |
const char *end; |
| |
|
| |
if (0 == sz) |
| |
return; |
| |
|
| |
end = cp + sz; |
| |
slot = ohash_qlookupi(&strings, cp, &end); |
| |
s = ohash_find(&strings, slot); |
| |
|
| |
if (NULL != s && mpage == s->mpage) { |
| |
s->mask |= v; |
| |
return; |
| |
} else if (NULL == s) { |
| |
s = mandoc_calloc(sizeof(struct str) + sz + 1, 1); |
| |
memcpy(s->key, cp, sz); |
| |
ohash_insert(&strings, slot, s); |
| } |
} |
| |
s->mpage = mpage; |
| |
s->mask = v; |
| |
} |
| |
|
| buf_appendb(dbuf, p, plen + 1); |
/* |
| buf->len = 0; |
* Take a Unicode codepoint and produce its UTF-8 encoding. |
| buf_appendb(buf, p, plen + 1); |
* This isn't the best way to do this, but it works. |
| hash_put(hash, buf, TYPE_Nd); |
* The magic numbers are from the UTF-8 packaging. |
| fclose(stream); |
* They're not as scary as they seem: read the UTF-8 spec for details. |
| free(title); |
*/ |
| |
static size_t |
| |
utf8(unsigned int cp, char out[7]) |
| |
{ |
| |
size_t rc; |
| |
|
| |
rc = 0; |
| |
if (cp <= 0x0000007F) { |
| |
rc = 1; |
| |
out[0] = (char)cp; |
| |
} else if (cp <= 0x000007FF) { |
| |
rc = 2; |
| |
out[0] = (cp >> 6 & 31) | 192; |
| |
out[1] = (cp & 63) | 128; |
| |
} else if (cp <= 0x0000FFFF) { |
| |
rc = 3; |
| |
out[0] = (cp >> 12 & 15) | 224; |
| |
out[1] = (cp >> 6 & 63) | 128; |
| |
out[2] = (cp & 63) | 128; |
| |
} else if (cp <= 0x001FFFFF) { |
| |
rc = 4; |
| |
out[0] = (cp >> 18 & 7) | 240; |
| |
out[1] = (cp >> 12 & 63) | 128; |
| |
out[2] = (cp >> 6 & 63) | 128; |
| |
out[3] = (cp & 63) | 128; |
| |
} else if (cp <= 0x03FFFFFF) { |
| |
rc = 5; |
| |
out[0] = (cp >> 24 & 3) | 248; |
| |
out[1] = (cp >> 18 & 63) | 128; |
| |
out[2] = (cp >> 12 & 63) | 128; |
| |
out[3] = (cp >> 6 & 63) | 128; |
| |
out[4] = (cp & 63) | 128; |
| |
} else if (cp <= 0x7FFFFFFF) { |
| |
rc = 6; |
| |
out[0] = (cp >> 30 & 1) | 252; |
| |
out[1] = (cp >> 24 & 63) | 128; |
| |
out[2] = (cp >> 18 & 63) | 128; |
| |
out[3] = (cp >> 12 & 63) | 128; |
| |
out[4] = (cp >> 6 & 63) | 128; |
| |
out[5] = (cp & 63) | 128; |
| |
} else |
| |
return(0); |
| |
|
| |
out[rc] = '\0'; |
| |
return(rc); |
| } |
} |
| |
|
| |
/* |
| |
* Store the rendered version of a key, or alias the pointer |
| |
* if the key contains no escape sequences. |
| |
*/ |
| static void |
static void |
| ofile_argbuild(int argc, char *argv[], |
render_key(struct mchars *mc, struct str *key) |
| struct of **of, const char *basedir) |
|
| { |
{ |
| char buf[MAXPATHLEN]; |
size_t sz, bsz, pos; |
| const char *sec, *arch, *title; |
char utfbuf[7], res[5]; |
| char *p; |
char *buf; |
| int i, src_form; |
const char *seq, *cpp, *val; |
| struct of *nof; |
int len, u; |
| |
enum mandoc_esc esc; |
| |
|
| for (i = 0; i < argc; i++) { |
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; |
| |
} |
| |
|
| |
/* Pre-allocate by the length of the input */ |
| |
|
| |
buf = mandoc_malloc(++bsz); |
| |
pos = 0; |
| |
|
| |
while ('\0' != *val) { |
| /* |
/* |
| * Try to infer the manual section, architecture and |
* Halt on the first escape sequence. |
| * page title from the path, assuming it looks like |
* This also halts on the end of string, in which case |
| * man*[/<arch>]/<title>.<section> or |
* we just copy, fallthrough, and exit the loop. |
| * cat<section>[/<arch>]/<title>.0 |
|
| */ |
*/ |
| |
if ((sz = strcspn(val, res)) > 0) { |
| |
memcpy(&buf[pos], val, sz); |
| |
pos += sz; |
| |
val += sz; |
| |
} |
| |
|
| if (strlcpy(buf, argv[i], sizeof(buf)) >= sizeof(buf)) { |
if (ASCII_HYPH == *val) { |
| fprintf(stderr, "%s: Path too long\n", argv[i]); |
buf[pos++] = '-'; |
| |
val++; |
| continue; |
continue; |
| } |
} else if ('\t' == *val || ASCII_NBRSP == *val) { |
| sec = arch = title = ""; |
buf[pos++] = ' '; |
| src_form = 0; |
val++; |
| p = strrchr(buf, '\0'); |
continue; |
| while (p-- > buf) { |
} else if ('\\' != *val) |
| if ('\0' == *sec && '.' == *p) { |
|
| sec = p + 1; |
|
| *p = '\0'; |
|
| if ('0' == *sec) |
|
| src_form |= MANDOC_FORM; |
|
| else if ('1' <= *sec && '9' >= *sec) |
|
| src_form |= MANDOC_SRC; |
|
| continue; |
|
| } |
|
| if ('/' != *p) |
|
| continue; |
|
| if ('\0' == *title) { |
|
| title = p + 1; |
|
| *p = '\0'; |
|
| continue; |
|
| } |
|
| if (0 == strncmp("man", p + 1, 3)) |
|
| src_form |= MANDOC_SRC; |
|
| else if (0 == strncmp("cat", p + 1, 3)) |
|
| src_form |= MANDOC_FORM; |
|
| else |
|
| arch = p + 1; |
|
| break; |
break; |
| } |
|
| if ('\0' == *title) { |
|
| WARNING(argv[i], basedir, |
|
| "Cannot deduce title from filename"); |
|
| title = buf; |
|
| } |
|
| |
|
| |
/* Read past the slash. */ |
| |
|
| |
val++; |
| |
|
| /* |
/* |
| * Build the file structure. |
* Parse the escape sequence and see if it's a |
| |
* predefined character or special character. |
| */ |
*/ |
| |
|
| nof = mandoc_calloc(1, sizeof(struct of)); |
esc = mandoc_escape |
| nof->fname = mandoc_strdup(argv[i]); |
((const char **)&val, &seq, &len); |
| nof->sec = mandoc_strdup(sec); |
if (ESCAPE_ERROR == esc) |
| nof->arch = mandoc_strdup(arch); |
break; |
| nof->title = mandoc_strdup(title); |
if (ESCAPE_SPECIAL != esc) |
| nof->src_form = src_form; |
continue; |
| |
|
| /* |
/* |
| * Add the structure to the list. |
* Render the special character |
| |
* as either UTF-8 or ASCII. |
| */ |
*/ |
| |
|
| if (NULL == *of) { |
if (write_utf8) { |
| *of = nof; |
if (0 == (u = mchars_spec2cp(mc, seq, len))) |
| (*of)->first = nof; |
continue; |
| |
cpp = utfbuf; |
| |
if (0 == (sz = utf8(u, utfbuf))) |
| |
continue; |
| |
sz = strlen(cpp); |
| } else { |
} else { |
| nof->first = (*of)->first; |
cpp = mchars_spec2str(mc, seq, len, &sz); |
| (*of)->next = nof; |
if (NULL == cpp) |
| *of = nof; |
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; |
| } |
} |
| |
|
| /* |
/* |
| * Recursively build up a list of files to parse. |
* Flush the current page's terms (and their bits) into the database. |
| * We use this instead of ftw() and so on because I don't want global |
* Wrap the entire set of additions in a transaction to make sqlite be a |
| * variables hanging around. |
* little faster. |
| * This ignores the mandocdb.db and mandocdb.index files, but assumes that |
* Also, handle escape sequences at the last possible moment. |
| * everything else is a manual. |
|
| * Pass in a pointer to a NULL structure for the first invocation. |
|
| */ |
*/ |
| static void |
static void |
| ofile_dirbuild(const char *dir, const char* psec, const char *parch, |
dbadd(const struct mpage *mpage, struct mchars *mc) |
| int p_src_form, struct of **of, char *basedir) |
|
| { |
{ |
| char buf[MAXPATHLEN]; |
struct mlink *mlink; |
| size_t sz; |
struct str *key; |
| DIR *d; |
int64_t recno; |
| const char *fn, *sec, *arch; |
size_t i; |
| char *p, *q, *suffix; |
unsigned int slot; |
| struct of *nof; |
|
| struct dirent *dp; |
|
| int src_form; |
|
| |
|
| if (NULL == (d = opendir(dir))) { |
if (verb) |
| WARNING("", dir, "%s", strerror(errno)); |
say(mpage->mlinks->file, "Adding to database"); |
| |
|
| |
if (nodb) |
| return; |
return; |
| |
|
| |
i = 1; |
| |
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]); |
| |
|
| |
for (mlink = mpage->mlinks; mlink; mlink = mlink->next) { |
| |
i = 1; |
| |
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]); |
| } |
} |
| |
|
| while (NULL != (dp = readdir(d))) { |
for (key = ohash_first(&strings, &slot); NULL != key; |
| fn = dp->d_name; |
key = ohash_next(&strings, &slot)) { |
| |
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); |
| |
} |
| |
} |
| |
|
| if ('.' == *fn) |
static void |
| |
dbprune(void) |
| |
{ |
| |
struct mpage *mpage; |
| |
struct mlink *mlink; |
| |
size_t i; |
| |
unsigned int slot; |
| |
|
| |
if (0 == nodb) |
| |
SQL_EXEC("BEGIN TRANSACTION"); |
| |
|
| |
for (mpage = ohash_first(&mpages, &slot); NULL != mpage; |
| |
mpage = ohash_next(&mpages, &slot)) { |
| |
mlink = mpage->mlinks; |
| |
if (verb) |
| |
say(mlink->file, "Deleting from database"); |
| |
if (nodb) |
| continue; |
continue; |
| |
for ( ; NULL != mlink; mlink = mlink->next) { |
| |
i = 1; |
| |
SQL_BIND_TEXT(stmts[STMT_DELETE_PAGE], |
| |
i, mlink->dsec); |
| |
SQL_BIND_TEXT(stmts[STMT_DELETE_PAGE], |
| |
i, mlink->arch); |
| |
SQL_BIND_TEXT(stmts[STMT_DELETE_PAGE], |
| |
i, mlink->name); |
| |
SQL_STEP(stmts[STMT_DELETE_PAGE]); |
| |
sqlite3_reset(stmts[STMT_DELETE_PAGE]); |
| |
} |
| |
} |
| |
|
| src_form = p_src_form; |
if (0 == nodb) |
| |
SQL_EXEC("END TRANSACTION"); |
| |
} |
| |
|
| if (DT_DIR == dp->d_type) { |
/* |
| sec = psec; |
* Close an existing database and its prepared statements. |
| arch = parch; |
* If "real" is not set, rename the temporary file into the real one. |
| |
*/ |
| |
static void |
| |
dbclose(int real) |
| |
{ |
| |
size_t i; |
| |
|
| /* |
if (nodb) |
| * By default, only use directories called: |
return; |
| * man<section>/[<arch>/] or |
|
| * cat<section>/[<arch>/] |
|
| */ |
|
| |
|
| if ('\0' == *sec) { |
for (i = 0; i < STMT__MAX; i++) { |
| if(0 == strncmp("man", fn, 3)) { |
sqlite3_finalize(stmts[i]); |
| src_form |= MANDOC_SRC; |
stmts[i] = NULL; |
| sec = fn + 3; |
} |
| } else if (0 == strncmp("cat", fn, 3)) { |
|
| src_form |= MANDOC_FORM; |
|
| sec = fn + 3; |
|
| } else { |
|
| WARNING(fn, basedir, "Bad section"); |
|
| if (use_all) |
|
| sec = fn; |
|
| else |
|
| continue; |
|
| } |
|
| } else if ('\0' == *arch) { |
|
| if (NULL != strchr(fn, '.')) { |
|
| WARNING(fn, basedir, "Bad architecture"); |
|
| if (0 == use_all) |
|
| continue; |
|
| } |
|
| arch = fn; |
|
| } else { |
|
| WARNING(fn, basedir, "Excessive subdirectory"); |
|
| if (0 == use_all) |
|
| continue; |
|
| } |
|
| |
|
| buf[0] = '\0'; |
sqlite3_close(db); |
| strlcat(buf, dir, MAXPATHLEN); |
db = NULL; |
| strlcat(buf, "/", MAXPATHLEN); |
|
| strlcat(basedir, "/", MAXPATHLEN); |
|
| strlcat(basedir, fn, MAXPATHLEN); |
|
| sz = strlcat(buf, fn, MAXPATHLEN); |
|
| |
|
| if (MAXPATHLEN <= sz) { |
if (real) |
| WARNING(fn, basedir, "Path too long"); |
return; |
| continue; |
|
| } |
|
| |
|
| ofile_dirbuild(buf, sec, arch, |
if (-1 == rename(MANDOC_DB "~", MANDOC_DB)) { |
| src_form, of, basedir); |
exitcode = (int)MANDOCLEVEL_SYSERR; |
| |
say(MANDOC_DB, NULL); |
| |
} |
| |
} |
| |
|
| p = strrchr(basedir, '/'); |
/* |
| *p = '\0'; |
* This is straightforward stuff. |
| continue; |
* Open a database connection to a "temporary" database, then open a set |
| } |
* of prepared statements we'll use over and over again. |
| |
* If "real" is set, we use the existing database; if not, we truncate a |
| |
* temporary one. |
| |
* Must be matched by dbclose(). |
| |
*/ |
| |
static int |
| |
dbopen(int real) |
| |
{ |
| |
const char *file, *sql; |
| |
int rc, ofl; |
| |
|
| if (DT_REG != dp->d_type) { |
if (nodb) |
| WARNING(fn, basedir, "Not a regular file"); |
return(1); |
| continue; |
|
| |
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); |
| } |
} |
| if (!strcmp(MANDOC_DB, fn) || !strcmp(MANDOC_IDX, fn)) |
ofl |= SQLITE_OPEN_EXCLUSIVE; |
| continue; |
} else |
| if ('\0' == *psec) { |
file = MANDOC_DB; |
| WARNING(fn, basedir, "File outside section"); |
|
| if (0 == use_all) |
|
| continue; |
|
| } |
|
| |
|
| /* |
rc = sqlite3_open_v2(file, &db, ofl, NULL); |
| * By default, skip files where the file name suffix |
if (SQLITE_OK == rc) |
| * does not agree with the section directory |
goto prepare_statements; |
| * they are located in. |
if (SQLITE_CANTOPEN != rc) { |
| */ |
exitcode = (int)MANDOCLEVEL_SYSERR; |
| |
say(file, NULL); |
| |
return(0); |
| |
} |
| |
|
| suffix = strrchr(fn, '.'); |
sqlite3_close(db); |
| if (NULL == suffix) { |
db = NULL; |
| WARNING(fn, basedir, "No filename suffix"); |
|
| if (0 == use_all) |
|
| continue; |
|
| } else if ((MANDOC_SRC & src_form && |
|
| strcmp(suffix + 1, psec)) || |
|
| (MANDOC_FORM & src_form && |
|
| strcmp(suffix + 1, "0"))) { |
|
| WARNING(fn, basedir, "Wrong filename suffix"); |
|
| if (0 == use_all) |
|
| continue; |
|
| if ('0' == suffix[1]) |
|
| src_form |= MANDOC_FORM; |
|
| else if ('1' <= suffix[1] && '9' >= suffix[1]) |
|
| src_form |= MANDOC_SRC; |
|
| } |
|
| |
|
| /* |
if (SQLITE_OK != (rc = sqlite3_open(file, &db))) { |
| * Skip formatted manuals if a source version is |
exitcode = (int)MANDOCLEVEL_SYSERR; |
| * available. Ignore the age: it is very unlikely |
say(file, NULL); |
| * that people install newer formatted base manuals |
return(0); |
| * when they used to have source manuals before, |
} |
| * and in ports, old manuals get removed on update. |
|
| */ |
|
| if (0 == use_all && MANDOC_FORM & src_form && |
|
| '\0' != *psec) { |
|
| buf[0] = '\0'; |
|
| strlcat(buf, dir, MAXPATHLEN); |
|
| p = strrchr(buf, '/'); |
|
| if ('\0' != *parch && NULL != p) |
|
| for (p--; p > buf; p--) |
|
| if ('/' == *p) |
|
| break; |
|
| if (NULL == p) |
|
| p = buf; |
|
| else |
|
| p++; |
|
| if (0 == strncmp("cat", p, 3)) |
|
| memcpy(p, "man", 3); |
|
| strlcat(buf, "/", MAXPATHLEN); |
|
| sz = strlcat(buf, fn, MAXPATHLEN); |
|
| if (sz >= MAXPATHLEN) { |
|
| WARNING(fn, basedir, "Path too long"); |
|
| continue; |
|
| } |
|
| q = strrchr(buf, '.'); |
|
| if (NULL != q && p < q++) { |
|
| *q = '\0'; |
|
| sz = strlcat(buf, psec, MAXPATHLEN); |
|
| if (sz >= MAXPATHLEN) { |
|
| WARNING(fn, basedir, "Path too long"); |
|
| continue; |
|
| } |
|
| if (0 == access(buf, R_OK)) |
|
| continue; |
|
| } |
|
| } |
|
| |
|
| buf[0] = '\0'; |
sql = "CREATE TABLE \"mpages\" (\n" |
| assert('.' == dir[0]); |
" \"form\" INTEGER NOT NULL,\n" |
| if ('/' == dir[1]) { |
" \"id\" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL\n" |
| strlcat(buf, dir + 2, MAXPATHLEN); |
");\n" |
| strlcat(buf, "/", MAXPATHLEN); |
"\n" |
| } |
"CREATE TABLE \"mlinks\" (\n" |
| sz = strlcat(buf, fn, MAXPATHLEN); |
" \"sec\" TEXT NOT NULL,\n" |
| if (sz >= MAXPATHLEN) { |
" \"arch\" TEXT NOT NULL,\n" |
| WARNING(fn, basedir, "Path too long"); |
" \"name\" TEXT NOT NULL,\n" |
| continue; |
" \"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"; |
| |
|
| nof = mandoc_calloc(1, sizeof(struct of)); |
if (SQLITE_OK != sqlite3_exec(db, sql, NULL, NULL, NULL)) { |
| nof->fname = mandoc_strdup(buf); |
exitcode = (int)MANDOCLEVEL_SYSERR; |
| nof->sec = mandoc_strdup(psec); |
say(file, "%s", sqlite3_errmsg(db)); |
| nof->arch = mandoc_strdup(parch); |
return(0); |
| nof->src_form = src_form; |
} |
| |
|
| /* |
prepare_statements: |
| * Remember the file name without the extension, |
SQL_EXEC("PRAGMA foreign_keys = ON"); |
| * to be used as the page title in the database. |
sql = "DELETE FROM mpages WHERE id IN " |
| */ |
"(SELECT pageid FROM mlinks WHERE " |
| |
"sec=? AND arch=? AND name=?)"; |
| |
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 " |
| |
"(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 (NULL != suffix) |
#ifndef __APPLE__ |
| *suffix = '\0'; |
/* |
| nof->title = mandoc_strdup(fn); |
* When opening a new database, we can turn off |
| |
* synchronous mode for much better performance. |
| |
*/ |
| |
|
| /* |
if (real) |
| * Add the structure to the list. |
SQL_EXEC("PRAGMA synchronous = OFF"); |
| */ |
#endif |
| |
|
| if (NULL == *of) { |
return(1); |
| *of = nof; |
} |
| (*of)->first = nof; |
|
| } else { |
static void * |
| nof->first = (*of)->first; |
hash_halloc(size_t sz, void *arg) |
| (*of)->next = nof; |
{ |
| *of = nof; |
|
| |
return(mandoc_calloc(sz, 1)); |
| |
} |
| |
|
| |
static void * |
| |
hash_alloc(size_t sz, void *arg) |
| |
{ |
| |
|
| |
return(mandoc_malloc(sz)); |
| |
} |
| |
|
| |
static void |
| |
hash_free(void *p, size_t sz, void *arg) |
| |
{ |
| |
|
| |
free(p); |
| |
} |
| |
|
| |
static int |
| |
set_basedir(const char *targetdir) |
| |
{ |
| |
static char startdir[PATH_MAX]; |
| |
static int fd; |
| |
|
| |
/* |
| |
* 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)) { |
| closedir(d); |
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); |
| } |
} |
| |
|
| static void |
static void |
| ofile_free(struct of *of) |
say(const char *file, const char *format, ...) |
| { |
{ |
| struct of *nof; |
va_list ap; |
| |
|
| if (NULL != of) |
if ('\0' != *basedir) |
| of = of->first; |
fprintf(stderr, "%s", basedir); |
| |
if ('\0' != *basedir && '\0' != *file) |
| |
fputs("//", stderr); |
| |
if ('\0' != *file) |
| |
fprintf(stderr, "%s", file); |
| |
fputs(": ", stderr); |
| |
|
| while (NULL != of) { |
if (NULL == format) { |
| nof = of->next; |
perror(NULL); |
| free(of->fname); |
return; |
| free(of->sec); |
|
| free(of->arch); |
|
| free(of->title); |
|
| free(of); |
|
| of = nof; |
|
| } |
} |
| |
|
| |
va_start(ap, format); |
| |
vfprintf(stderr, format, ap); |
| |
va_end(ap); |
| |
|
| |
fputc('\n', stderr); |
| } |
} |
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to mandocdb.c CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc