| version 1.34, 2011/12/12 02:00:49 |
version 1.249, 2017/05/05 15:17:32 |
|
|
| /* $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-2017 Ingo Schwarze <schwarze@openbsd.org> |
| |
* Copyright (c) 2016 Ed Maste <emaste@freebsd.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 |
| * copyright notice and this permission notice appear in all copies. |
* copyright notice and this permission notice appear in all copies. |
| * |
* |
| * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES |
| * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
| * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR |
| * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
| * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
| * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
| * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
| */ |
*/ |
| #ifdef HAVE_CONFIG_H |
|
| #include "config.h" |
#include "config.h" |
| #endif |
|
| |
|
| #include <sys/param.h> |
|
| #include <sys/types.h> |
#include <sys/types.h> |
| #include <sys/stat.h> |
#include <sys/stat.h> |
| |
#include <sys/wait.h> |
| |
|
| #include <assert.h> |
#include <assert.h> |
| #include <dirent.h> |
#include <ctype.h> |
| |
#if HAVE_ERR |
| |
#include <err.h> |
| |
#endif |
| |
#include <errno.h> |
| #include <fcntl.h> |
#include <fcntl.h> |
| #include <getopt.h> |
#if HAVE_FTS |
| |
#include <fts.h> |
| |
#else |
| |
#include "compat_fts.h" |
| |
#endif |
| |
#include <limits.h> |
| |
#if HAVE_SANDBOX_INIT |
| |
#include <sandbox.h> |
| |
#endif |
| |
#include <stdarg.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__) |
#include "mandoc_aux.h" |
| # include <endian.h> |
#include "mandoc_ohash.h" |
| # include <db_185.h> |
|
| #elif defined(__APPLE__) |
|
| # include <libkern/OSByteOrder.h> |
|
| # include <db.h> |
|
| #else |
|
| # include <db.h> |
|
| #endif |
|
| |
|
| #include "man.h" |
|
| #include "mdoc.h" |
|
| #include "mandoc.h" |
#include "mandoc.h" |
| #include "mandocdb.h" |
#include "roff.h" |
| #include "manpath.h" |
#include "mdoc.h" |
| |
#include "man.h" |
| |
#include "manconf.h" |
| |
#include "mansearch.h" |
| |
#include "dba_array.h" |
| |
#include "dba.h" |
| |
|
| #define MANDOC_BUFSZ BUFSIZ |
extern const char *const mansearch_keynames[]; |
| #define MANDOC_SLOP 1024 |
|
| |
|
| #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 */ |
| |
}; |
| |
|
| /* Tiny list for files. No need to bring in QUEUE. */ |
struct str { |
| |
const struct mpage *mpage; /* if set, the owning parse */ |
| |
uint64_t mask; /* bitmask in sequence */ |
| |
char key[]; /* rendered text */ |
| |
}; |
| |
|
| struct of { |
struct inodev { |
| char *fname; /* heap-allocated */ |
ino_t st_ino; |
| char *sec; |
dev_t st_dev; |
| char *arch; |
|
| char *title; |
|
| int src_form; |
|
| struct of *next; /* NULL for last one */ |
|
| struct of *first; /* first in list */ |
|
| }; |
}; |
| |
|
| /* Buffer for storing growable data. */ |
struct mpage { |
| |
struct inodev inodev; /* used for hashing routine */ |
| |
struct dba_array *dba; |
| |
char *sec; /* section from file content */ |
| |
char *arch; /* architecture from file content */ |
| |
char *title; /* title from file content */ |
| |
char *desc; /* description from file content */ |
| |
struct mpage *next; /* singly linked list */ |
| |
struct mlink *mlinks; /* singly linked list */ |
| |
int name_head_done; |
| |
enum form form; /* format from file content */ |
| |
}; |
| |
|
| struct buf { |
struct mlink { |
| char *cp; |
char file[PATH_MAX]; /* filename rel. to manpath */ |
| 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 */ |
| |
struct mpage *mpage; /* parent */ |
| |
int gzip; /* filename has a .gz suffix */ |
| |
enum form dform; /* format from directory */ |
| |
enum form fform; /* format from file name suffix */ |
| }; |
}; |
| |
|
| /* Operation we're going to perform. */ |
typedef int (*mdoc_fp)(struct mpage *, const struct roff_meta *, |
| |
const struct roff_node *); |
| |
|
| enum op { |
struct mdoc_handler { |
| OP_NEW = 0, /* new database */ |
mdoc_fp fp; /* optional handler */ |
| OP_UPDATE, /* delete/add entries in existing database */ |
uint64_t mask; /* set unless handler returns 0 */ |
| OP_DELETE /* delete entries from existing database */ |
int taboo; /* node flags that must not be set */ |
| }; |
}; |
| |
|
| #define MAN_ARGS DB *hash, \ |
|
| struct buf *buf, \ |
|
| struct buf *dbuf, \ |
|
| const struct man_node *n |
|
| #define MDOC_ARGS DB *hash, \ |
|
| struct buf *buf, \ |
|
| struct buf *dbuf, \ |
|
| const struct mdoc_node *n, \ |
|
| const struct mdoc_meta *m |
|
| |
|
| static void buf_appendmdoc(struct buf *, |
int mandocdb(int, char *[]); |
| const struct mdoc_node *, int); |
|
| static void buf_append(struct buf *, const char *); |
|
| static void buf_appendb(struct buf *, |
|
| const void *, size_t); |
|
| static void dbt_put(DB *, const char *, DBT *, DBT *); |
|
| static void hash_put(DB *, const struct buf *, uint64_t); |
|
| static void hash_reset(DB **); |
|
| static void index_merge(const struct of *, struct mparse *, |
|
| struct buf *, struct buf *, DB *, |
|
| DB *, const char *, DB *, const char *, |
|
| recno_t, const recno_t *, size_t); |
|
| static void index_prune(const struct of *, DB *, |
|
| const char *, DB *, const char *, |
|
| recno_t *, recno_t **, size_t *, |
|
| size_t *); |
|
| static void ofile_argbuild(int, char *[], struct of **); |
|
| static int ofile_dirbuild(const char *, const char *, |
|
| const char *, int, struct of **); |
|
| static void ofile_free(struct of *); |
|
| static void pformatted(DB *, struct buf *, struct buf *, |
|
| const struct of *); |
|
| static int pman_node(MAN_ARGS); |
|
| static void pmdoc_node(MDOC_ARGS); |
|
| static int pmdoc_head(MDOC_ARGS); |
|
| static int pmdoc_body(MDOC_ARGS); |
|
| static int pmdoc_Fd(MDOC_ARGS); |
|
| static int pmdoc_In(MDOC_ARGS); |
|
| static int pmdoc_Fn(MDOC_ARGS); |
|
| static int pmdoc_Nd(MDOC_ARGS); |
|
| static int pmdoc_Nm(MDOC_ARGS); |
|
| static int pmdoc_Sh(MDOC_ARGS); |
|
| static int pmdoc_St(MDOC_ARGS); |
|
| static int pmdoc_Xr(MDOC_ARGS); |
|
| static void usage(void); |
|
| |
|
| #define MDOCF_CHILD 0x01 /* Automatically index child nodes. */ |
static void dbadd(struct dba *, struct mpage *); |
| |
static void dbadd_mlink(const struct mlink *mlink); |
| |
static void dbprune(struct dba *); |
| |
static void dbwrite(struct dba *); |
| |
static void filescan(const char *); |
| |
#if HAVE_FTS_COMPARE_CONST |
| |
static int fts_compare(const FTSENT *const *, const FTSENT *const *); |
| |
#else |
| |
static int fts_compare(const FTSENT **, const FTSENT **); |
| |
#endif |
| |
static void mlink_add(struct mlink *, const struct stat *); |
| |
static void 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 dba *, struct mparse *); |
| |
static void parse_cat(struct mpage *, int); |
| |
static void parse_man(struct mpage *, const struct roff_meta *, |
| |
const struct roff_node *); |
| |
static void parse_mdoc(struct mpage *, const struct roff_meta *, |
| |
const struct roff_node *); |
| |
static int parse_mdoc_head(struct mpage *, const struct roff_meta *, |
| |
const struct roff_node *); |
| |
static int parse_mdoc_Fd(struct mpage *, const struct roff_meta *, |
| |
const struct roff_node *); |
| |
static void parse_mdoc_fname(struct mpage *, const struct roff_node *); |
| |
static int parse_mdoc_Fn(struct mpage *, const struct roff_meta *, |
| |
const struct roff_node *); |
| |
static int parse_mdoc_Fo(struct mpage *, const struct roff_meta *, |
| |
const struct roff_node *); |
| |
static int parse_mdoc_Nd(struct mpage *, const struct roff_meta *, |
| |
const struct roff_node *); |
| |
static int parse_mdoc_Nm(struct mpage *, const struct roff_meta *, |
| |
const struct roff_node *); |
| |
static int parse_mdoc_Sh(struct mpage *, const struct roff_meta *, |
| |
const struct roff_node *); |
| |
static int parse_mdoc_Va(struct mpage *, const struct roff_meta *, |
| |
const struct roff_node *); |
| |
static int parse_mdoc_Xr(struct mpage *, const struct roff_meta *, |
| |
const struct roff_node *); |
| |
static void putkey(const struct mpage *, char *, uint64_t); |
| |
static void putkeys(const struct mpage *, char *, size_t, uint64_t); |
| |
static void putmdockey(const struct mpage *, |
| |
const struct roff_node *, uint64_t, int); |
| |
static int render_string(char **, size_t *); |
| |
static void say(const char *, const char *, ...) |
| |
__attribute__((__format__ (__printf__, 2, 3))); |
| |
static int set_basedir(const char *, int); |
| |
static int treescan(void); |
| |
static size_t utf8(unsigned int, char [7]); |
| |
|
| struct mdoc_handler { |
static int nodb; /* no database changes */ |
| int (*fp)(MDOC_ARGS); /* Optional handler. */ |
static int mparse_options; /* abort the parse early */ |
| uint64_t mask; /* Set unless handler returns 0. */ |
static int use_all; /* use all found files */ |
| int flags; /* For use by pmdoc_node. */ |
static int debug; /* 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 mpage *mpage_head; /* list of distinct manual pages */ |
| |
static struct ohash mpages; /* table of distinct manual pages */ |
| |
static struct ohash mlinks; /* table of directory entries */ |
| |
static struct ohash names; /* table of all names */ |
| |
static struct ohash strings; /* table of all strings */ |
| |
static uint64_t name_mask; |
| |
|
| static const struct mdoc_handler mdocs[MDOC_MAX] = { |
static const struct mdoc_handler __mdocs[MDOC_MAX - MDOC_Dd] = { |
| { NULL, 0, 0 }, /* Ap */ |
{ NULL, 0, NODE_NOPRT }, /* Dd */ |
| { NULL, 0, 0 }, /* Dd */ |
{ NULL, 0, NODE_NOPRT }, /* Dt */ |
| { NULL, 0, 0 }, /* Dt */ |
{ NULL, 0, NODE_NOPRT }, /* Os */ |
| { NULL, 0, 0 }, /* Os */ |
{ parse_mdoc_Sh, TYPE_Sh, 0 }, /* Sh */ |
| { pmdoc_Sh, TYPE_Sh, MDOCF_CHILD }, /* Sh */ |
{ parse_mdoc_head, TYPE_Ss, 0 }, /* Ss */ |
| { pmdoc_head, TYPE_Ss, MDOCF_CHILD }, /* Ss */ |
|
| { NULL, 0, 0 }, /* Pp */ |
{ NULL, 0, 0 }, /* Pp */ |
| { NULL, 0, 0 }, /* D1 */ |
{ NULL, 0, 0 }, /* D1 */ |
| { NULL, 0, 0 }, /* Dl */ |
{ NULL, 0, 0 }, /* Dl */ |
| Line 153 static const struct mdoc_handler mdocs[MDOC_MAX] = { |
|
| Line 198 static const struct mdoc_handler mdocs[MDOC_MAX] = { |
|
| { NULL, 0, 0 }, /* El */ |
{ NULL, 0, 0 }, /* El */ |
| { NULL, 0, 0 }, /* It */ |
{ NULL, 0, 0 }, /* It */ |
| { NULL, 0, 0 }, /* Ad */ |
{ NULL, 0, 0 }, /* Ad */ |
| { NULL, TYPE_An, MDOCF_CHILD }, /* An */ |
{ NULL, TYPE_An, 0 }, /* An */ |
| { NULL, TYPE_Ar, MDOCF_CHILD }, /* Ar */ |
{ NULL, 0, 0 }, /* Ap */ |
| { NULL, TYPE_Cd, MDOCF_CHILD }, /* Cd */ |
{ NULL, TYPE_Ar, 0 }, /* Ar */ |
| { NULL, TYPE_Cm, MDOCF_CHILD }, /* Cm */ |
{ NULL, TYPE_Cd, 0 }, /* Cd */ |
| { NULL, TYPE_Dv, MDOCF_CHILD }, /* Dv */ |
{ NULL, TYPE_Cm, 0 }, /* Cm */ |
| { NULL, TYPE_Er, MDOCF_CHILD }, /* Er */ |
{ NULL, TYPE_Dv, 0 }, /* Dv */ |
| { NULL, TYPE_Ev, MDOCF_CHILD }, /* Ev */ |
{ NULL, TYPE_Er, 0 }, /* Er */ |
| |
{ NULL, TYPE_Ev, 0 }, /* Ev */ |
| { NULL, 0, 0 }, /* Ex */ |
{ NULL, 0, 0 }, /* Ex */ |
| { NULL, TYPE_Fa, MDOCF_CHILD }, /* Fa */ |
{ NULL, TYPE_Fa, 0 }, /* Fa */ |
| { pmdoc_Fd, TYPE_In, 0 }, /* Fd */ |
{ parse_mdoc_Fd, 0, 0 }, /* Fd */ |
| { NULL, TYPE_Fl, MDOCF_CHILD }, /* Fl */ |
{ NULL, TYPE_Fl, 0 }, /* Fl */ |
| { pmdoc_Fn, 0, 0 }, /* Fn */ |
{ parse_mdoc_Fn, 0, 0 }, /* Fn */ |
| { NULL, TYPE_Ft, MDOCF_CHILD }, /* Ft */ |
{ NULL, TYPE_Ft, 0 }, /* Ft */ |
| { NULL, TYPE_Ic, MDOCF_CHILD }, /* Ic */ |
{ NULL, TYPE_Ic, 0 }, /* Ic */ |
| { pmdoc_In, TYPE_In, 0 }, /* In */ |
{ NULL, TYPE_In, 0 }, /* In */ |
| { NULL, TYPE_Li, MDOCF_CHILD }, /* Li */ |
{ NULL, TYPE_Li, 0 }, /* Li */ |
| { pmdoc_Nd, TYPE_Nd, MDOCF_CHILD }, /* Nd */ |
{ parse_mdoc_Nd, 0, 0 }, /* Nd */ |
| { pmdoc_Nm, TYPE_Nm, MDOCF_CHILD }, /* Nm */ |
{ parse_mdoc_Nm, 0, 0 }, /* Nm */ |
| { NULL, 0, 0 }, /* Op */ |
{ NULL, 0, 0 }, /* Op */ |
| { NULL, 0, 0 }, /* Ot */ |
{ NULL, 0, 0 }, /* Ot */ |
| { NULL, TYPE_Pa, MDOCF_CHILD }, /* Pa */ |
{ NULL, TYPE_Pa, NODE_NOSRC }, /* Pa */ |
| { NULL, 0, 0 }, /* Rv */ |
{ NULL, 0, 0 }, /* Rv */ |
| { pmdoc_St, TYPE_St, 0 }, /* St */ |
{ NULL, TYPE_St, 0 }, /* St */ |
| { NULL, TYPE_Va, MDOCF_CHILD }, /* Va */ |
{ parse_mdoc_Va, TYPE_Va, 0 }, /* Va */ |
| { pmdoc_body, TYPE_Va, MDOCF_CHILD }, /* Vt */ |
{ parse_mdoc_Va, TYPE_Vt, 0 }, /* Vt */ |
| { pmdoc_Xr, TYPE_Xr, 0 }, /* Xr */ |
{ parse_mdoc_Xr, 0, 0 }, /* Xr */ |
| { NULL, 0, 0 }, /* %A */ |
{ NULL, 0, 0 }, /* %A */ |
| { NULL, 0, 0 }, /* %B */ |
{ NULL, 0, 0 }, /* %B */ |
| { NULL, 0, 0 }, /* %D */ |
{ NULL, 0, 0 }, /* %D */ |
| Line 193 static const struct mdoc_handler mdocs[MDOC_MAX] = { |
|
| Line 239 static const struct mdoc_handler mdocs[MDOC_MAX] = { |
|
| { NULL, 0, 0 }, /* Ac */ |
{ NULL, 0, 0 }, /* Ac */ |
| { NULL, 0, 0 }, /* Ao */ |
{ NULL, 0, 0 }, /* Ao */ |
| { NULL, 0, 0 }, /* Aq */ |
{ NULL, 0, 0 }, /* Aq */ |
| { NULL, TYPE_At, MDOCF_CHILD }, /* At */ |
{ NULL, TYPE_At, 0 }, /* At */ |
| { NULL, 0, 0 }, /* Bc */ |
{ NULL, 0, 0 }, /* Bc */ |
| { NULL, 0, 0 }, /* Bf */ |
{ NULL, 0, 0 }, /* Bf */ |
| { NULL, 0, 0 }, /* Bo */ |
{ NULL, 0, 0 }, /* Bo */ |
| { NULL, 0, 0 }, /* Bq */ |
{ NULL, 0, 0 }, /* Bq */ |
| { NULL, TYPE_Bsx, MDOCF_CHILD }, /* Bsx */ |
{ NULL, TYPE_Bsx, NODE_NOSRC }, /* Bsx */ |
| { NULL, TYPE_Bx, MDOCF_CHILD }, /* Bx */ |
{ NULL, TYPE_Bx, NODE_NOSRC }, /* Bx */ |
| { NULL, 0, 0 }, /* Db */ |
{ NULL, 0, 0 }, /* Db */ |
| { NULL, 0, 0 }, /* Dc */ |
{ NULL, 0, 0 }, /* Dc */ |
| { NULL, 0, 0 }, /* Do */ |
{ NULL, 0, 0 }, /* Do */ |
| { NULL, 0, 0 }, /* Dq */ |
{ NULL, 0, 0 }, /* Dq */ |
| { NULL, 0, 0 }, /* Ec */ |
{ NULL, 0, 0 }, /* Ec */ |
| { NULL, 0, 0 }, /* Ef */ |
{ NULL, 0, 0 }, /* Ef */ |
| { NULL, TYPE_Em, MDOCF_CHILD }, /* Em */ |
{ NULL, TYPE_Em, 0 }, /* Em */ |
| { NULL, 0, 0 }, /* Eo */ |
{ NULL, 0, 0 }, /* Eo */ |
| { NULL, TYPE_Fx, MDOCF_CHILD }, /* Fx */ |
{ NULL, TYPE_Fx, NODE_NOSRC }, /* Fx */ |
| { NULL, TYPE_Ms, MDOCF_CHILD }, /* Ms */ |
{ NULL, TYPE_Ms, 0 }, /* Ms */ |
| { NULL, 0, 0 }, /* No */ |
{ NULL, 0, 0 }, /* No */ |
| { NULL, 0, 0 }, /* Ns */ |
{ NULL, 0, 0 }, /* Ns */ |
| { NULL, TYPE_Nx, MDOCF_CHILD }, /* Nx */ |
{ NULL, TYPE_Nx, NODE_NOSRC }, /* Nx */ |
| { NULL, TYPE_Ox, MDOCF_CHILD }, /* Ox */ |
{ NULL, TYPE_Ox, NODE_NOSRC }, /* Ox */ |
| { NULL, 0, 0 }, /* Pc */ |
{ NULL, 0, 0 }, /* Pc */ |
| { NULL, 0, 0 }, /* Pf */ |
{ NULL, 0, 0 }, /* Pf */ |
| { NULL, 0, 0 }, /* Po */ |
{ NULL, 0, 0 }, /* Po */ |
| Line 229 static const struct mdoc_handler mdocs[MDOC_MAX] = { |
|
| Line 275 static const struct mdoc_handler mdocs[MDOC_MAX] = { |
|
| { NULL, 0, 0 }, /* Sq */ |
{ NULL, 0, 0 }, /* Sq */ |
| { NULL, 0, 0 }, /* Sm */ |
{ NULL, 0, 0 }, /* Sm */ |
| { NULL, 0, 0 }, /* Sx */ |
{ NULL, 0, 0 }, /* Sx */ |
| { NULL, TYPE_Sy, MDOCF_CHILD }, /* Sy */ |
{ NULL, TYPE_Sy, 0 }, /* Sy */ |
| { NULL, TYPE_Tn, MDOCF_CHILD }, /* Tn */ |
{ NULL, TYPE_Tn, 0 }, /* Tn */ |
| { NULL, 0, 0 }, /* Ux */ |
{ NULL, 0, NODE_NOSRC }, /* Ux */ |
| { NULL, 0, 0 }, /* Xc */ |
{ NULL, 0, 0 }, /* Xc */ |
| { NULL, 0, 0 }, /* Xo */ |
{ NULL, 0, 0 }, /* Xo */ |
| { pmdoc_head, TYPE_Fn, 0 }, /* Fo */ |
{ parse_mdoc_Fo, 0, 0 }, /* Fo */ |
| { NULL, 0, 0 }, /* Fc */ |
{ NULL, 0, 0 }, /* Fc */ |
| { NULL, 0, 0 }, /* Oo */ |
{ NULL, 0, 0 }, /* Oo */ |
| { NULL, 0, 0 }, /* Oc */ |
{ NULL, 0, 0 }, /* Oc */ |
| Line 244 static const struct mdoc_handler mdocs[MDOC_MAX] = { |
|
| Line 290 static const struct mdoc_handler mdocs[MDOC_MAX] = { |
|
| { NULL, 0, 0 }, /* Hf */ |
{ NULL, 0, 0 }, /* Hf */ |
| { NULL, 0, 0 }, /* Fr */ |
{ NULL, 0, 0 }, /* Fr */ |
| { NULL, 0, 0 }, /* Ud */ |
{ NULL, 0, 0 }, /* Ud */ |
| { NULL, TYPE_Lb, MDOCF_CHILD }, /* Lb */ |
{ NULL, TYPE_Lb, NODE_NOSRC }, /* Lb */ |
| { NULL, 0, 0 }, /* Lp */ |
{ NULL, 0, 0 }, /* Lp */ |
| { NULL, TYPE_Lk, MDOCF_CHILD }, /* Lk */ |
{ NULL, TYPE_Lk, 0 }, /* Lk */ |
| { NULL, TYPE_Mt, MDOCF_CHILD }, /* Mt */ |
{ NULL, TYPE_Mt, NODE_NOSRC }, /* Mt */ |
| { NULL, 0, 0 }, /* Brq */ |
{ NULL, 0, 0 }, /* Brq */ |
| { NULL, 0, 0 }, /* Bro */ |
{ NULL, 0, 0 }, /* Bro */ |
| { NULL, 0, 0 }, /* Brc */ |
{ NULL, 0, 0 }, /* Brc */ |
| { NULL, 0, 0 }, /* %C */ |
{ NULL, 0, 0 }, /* %C */ |
| { NULL, 0, 0 }, /* Es */ |
{ NULL, 0, 0 }, /* Es */ |
| { NULL, 0, 0 }, /* En */ |
{ NULL, 0, 0 }, /* En */ |
| { NULL, TYPE_Dx, MDOCF_CHILD }, /* Dx */ |
{ NULL, TYPE_Dx, NODE_NOSRC }, /* Dx */ |
| { NULL, 0, 0 }, /* %Q */ |
{ NULL, 0, 0 }, /* %Q */ |
| { NULL, 0, 0 }, /* br */ |
|
| { NULL, 0, 0 }, /* sp */ |
|
| { NULL, 0, 0 }, /* %U */ |
{ NULL, 0, 0 }, /* %U */ |
| { NULL, 0, 0 }, /* Ta */ |
{ NULL, 0, 0 }, /* Ta */ |
| }; |
}; |
| |
static const struct mdoc_handler *const mdocs = __mdocs - MDOC_Dd; |
| |
|
| static const char *progname; |
|
| static int use_all; /* Use all directories and files. */ |
|
| static int verb; /* Output verbosity level. */ |
|
| |
|
| int |
int |
| main(int argc, char *argv[]) |
mandocdb(int argc, char *argv[]) |
| { |
{ |
| struct mparse *mp; /* parse sequence */ |
struct manconf conf; |
| struct manpaths dirs; |
struct mparse *mp; |
| enum op op; /* current operation */ |
struct dba *dba; |
| const char *dir; |
const char *path_arg, *progname; |
| char *conf_file; |
size_t j, sz; |
| char *cp; |
int ch, i; |
| char pbuf[PATH_MAX], |
|
| ibuf[MAXPATHLEN], /* index fname */ |
|
| fbuf[MAXPATHLEN]; /* btree fname */ |
|
| int ch, i, flags; |
|
| DB *idx, /* index database */ |
|
| *db, /* keyword database */ |
|
| *hash; /* temporary keyword hashtable */ |
|
| BTREEINFO info; /* btree configuration */ |
|
| recno_t maxrec; /* last record number in the index */ |
|
| recno_t *recs; /* the numbers of all empty records */ |
|
| size_t sz1, sz2, |
|
| recsz, /* number of allocated slots in recs */ |
|
| reccur; /* current number of empty records */ |
|
| struct buf buf, /* keyword buffer */ |
|
| dbuf; /* description buffer */ |
|
| struct of *of; /* list of files for processing */ |
|
| extern int optind; |
|
| extern char *optarg; |
|
| |
|
| progname = strrchr(argv[0], '/'); |
#if HAVE_PLEDGE |
| if (progname == NULL) |
if (pledge("stdio rpath wpath cpath fattr flock proc exec", NULL) == -1) { |
| progname = argv[0]; |
warn("pledge"); |
| else |
return (int)MANDOCLEVEL_SYSERR; |
| ++progname; |
} |
| |
#endif |
| |
|
| memset(&dirs, 0, sizeof(struct manpaths)); |
#if HAVE_SANDBOX_INIT |
| |
if (sandbox_init(kSBXProfileNoInternet, SANDBOX_NAMED, NULL) == -1) { |
| |
warnx("sandbox_init"); |
| |
return (int)MANDOCLEVEL_SYSERR; |
| |
} |
| |
#endif |
| |
|
| verb = 0; |
memset(&conf, 0, sizeof(conf)); |
| use_all = 0; |
|
| of = NULL; |
|
| db = idx = NULL; |
|
| mp = NULL; |
|
| hash = NULL; |
|
| recs = NULL; |
|
| recsz = reccur = 0; |
|
| maxrec = 0; |
|
| op = OP_NEW; |
|
| dir = NULL; |
|
| conf_file = NULL; |
|
| |
|
| while (-1 != (ch = getopt(argc, argv, "aC:d:u:v"))) |
/* |
| |
* We accept a few different invocations. |
| |
* The CHECKOP macro makes sure that invocation styles don't |
| |
* clobber each other. |
| |
*/ |
| |
#define CHECKOP(_op, _ch) do \ |
| |
if (OP_DEFAULT != (_op)) { \ |
| |
warnx("-%c: Conflicting option", (_ch)); \ |
| |
goto usage; \ |
| |
} while (/*CONSTCOND*/0) |
| |
|
| |
path_arg = NULL; |
| |
op = OP_DEFAULT; |
| |
|
| |
while (-1 != (ch = getopt(argc, argv, "aC:Dd:npQT:tu:v"))) |
| switch (ch) { |
switch (ch) { |
| case ('a'): |
case 'a': |
| use_all = 1; |
use_all = 1; |
| break; |
break; |
| case ('C'): |
case 'C': |
| conf_file = optarg; |
CHECKOP(op, ch); |
| |
path_arg = optarg; |
| |
op = OP_CONFFILE; |
| break; |
break; |
| case ('d'): |
case 'D': |
| dir = optarg; |
debug++; |
| |
break; |
| |
case 'd': |
| |
CHECKOP(op, ch); |
| |
path_arg = optarg; |
| op = OP_UPDATE; |
op = OP_UPDATE; |
| break; |
break; |
| case ('u'): |
case 'n': |
| dir = optarg; |
nodb = 1; |
| |
break; |
| |
case 'p': |
| |
warnings = 1; |
| |
break; |
| |
case 'Q': |
| |
mparse_options |= MPARSE_QUICK; |
| |
break; |
| |
case 'T': |
| |
if (strcmp(optarg, "utf8")) { |
| |
warnx("-T%s: Unsupported output format", |
| |
optarg); |
| |
goto usage; |
| |
} |
| |
write_utf8 = 1; |
| |
break; |
| |
case 't': |
| |
CHECKOP(op, ch); |
| |
dup2(STDOUT_FILENO, STDERR_FILENO); |
| |
op = OP_TEST; |
| |
nodb = warnings = 1; |
| |
break; |
| |
case 'u': |
| |
CHECKOP(op, ch); |
| |
path_arg = optarg; |
| op = OP_DELETE; |
op = OP_DELETE; |
| break; |
break; |
| case ('v'): |
case 'v': |
| verb++; |
/* Compatibility with espie@'s makewhatis. */ |
| break; |
break; |
| default: |
default: |
| usage(); |
goto usage; |
| return((int)MANDOCLEVEL_BADARG); |
|
| } |
} |
| |
|
| argc -= optind; |
argc -= optind; |
| argv += optind; |
argv += optind; |
| |
|
| memset(&info, 0, sizeof(BTREEINFO)); |
#if HAVE_PLEDGE |
| info.flags = R_DUP; |
if (nodb) { |
| |
if (pledge("stdio rpath", NULL) == -1) { |
| |
warn("pledge"); |
| |
return (int)MANDOCLEVEL_SYSERR; |
| |
} |
| |
} |
| |
#endif |
| |
|
| mp = mparse_alloc(MPARSE_AUTO, MANDOCLEVEL_FATAL, NULL, NULL); |
if (OP_CONFFILE == op && argc > 0) { |
| |
warnx("-C: Too many arguments"); |
| |
goto usage; |
| |
} |
| |
|
| memset(&buf, 0, sizeof(struct buf)); |
exitcode = (int)MANDOCLEVEL_OK; |
| memset(&dbuf, 0, sizeof(struct buf)); |
mchars_alloc(); |
| |
mp = mparse_alloc(mparse_options, MANDOCLEVEL_BADARG, NULL, NULL); |
| |
mandoc_ohash_init(&mpages, 6, offsetof(struct mpage, inodev)); |
| |
mandoc_ohash_init(&mlinks, 6, offsetof(struct mlink, file)); |
| |
|
| buf.size = dbuf.size = MANDOC_BUFSZ; |
if (OP_UPDATE == op || OP_DELETE == op || OP_TEST == op) { |
| |
|
| buf.cp = mandoc_malloc(buf.size); |
/* |
| dbuf.cp = mandoc_malloc(dbuf.size); |
* Most of these deal with a specific directory. |
| |
* Jump into that directory first. |
| |
*/ |
| |
if (OP_TEST != op && 0 == set_basedir(path_arg, 1)) |
| |
goto out; |
| |
|
| flags = OP_NEW == op ? O_CREAT|O_TRUNC|O_RDWR : O_CREAT|O_RDWR; |
dba = nodb ? dba_new(128) : dba_read(MANDOC_DB); |
| |
if (dba != NULL) { |
| |
/* |
| |
* The existing database is usable. Process |
| |
* all files specified on the command-line. |
| |
*/ |
| |
#if HAVE_PLEDGE |
| |
if (!nodb) { |
| |
if (pledge("stdio rpath wpath cpath fattr flock", NULL) == -1) { |
| |
warn("pledge"); |
| |
exitcode = (int)MANDOCLEVEL_SYSERR; |
| |
goto out; |
| |
} |
| |
} |
| |
#endif |
| |
use_all = 1; |
| |
for (i = 0; i < argc; i++) |
| |
filescan(argv[i]); |
| |
if (nodb == 0) |
| |
dbprune(dba); |
| |
} else { |
| |
/* Database missing or corrupt. */ |
| |
if (op != OP_UPDATE || errno != ENOENT) |
| |
say(MANDOC_DB, "%s: Automatically recreating" |
| |
" from scratch", strerror(errno)); |
| |
exitcode = (int)MANDOCLEVEL_OK; |
| |
op = OP_DEFAULT; |
| |
if (0 == treescan()) |
| |
goto out; |
| |
dba = dba_new(128); |
| |
} |
| |
if (OP_DELETE != op) |
| |
mpages_merge(dba, mp); |
| |
if (nodb == 0) |
| |
dbwrite(dba); |
| |
dba_free(dba); |
| |
} else { |
| |
/* |
| |
* If we have arguments, use them as our manpaths. |
| |
* If we don't, use man.conf(5). |
| |
*/ |
| |
if (argc > 0) { |
| |
conf.manpath.paths = mandoc_reallocarray(NULL, |
| |
argc, sizeof(char *)); |
| |
conf.manpath.sz = (size_t)argc; |
| |
for (i = 0; i < argc; i++) |
| |
conf.manpath.paths[i] = mandoc_strdup(argv[i]); |
| |
} else |
| |
manconf_parse(&conf, path_arg, NULL, NULL); |
| |
|
| if (OP_UPDATE == op || OP_DELETE == op) { |
if (conf.manpath.sz == 0) { |
| ibuf[0] = fbuf[0] = '\0'; |
exitcode = (int)MANDOCLEVEL_BADARG; |
| |
say("", "Empty manpath"); |
| |
} |
| |
|
| strlcat(fbuf, dir, MAXPATHLEN); |
/* |
| strlcat(fbuf, "/", MAXPATHLEN); |
* First scan the tree rooted at a base directory, then |
| sz1 = strlcat(fbuf, MANDOC_DB, MAXPATHLEN); |
* build a new database and finally move it into place. |
| |
* Ignore zero-length directories and strip trailing |
| |
* slashes. |
| |
*/ |
| |
for (j = 0; j < conf.manpath.sz; j++) { |
| |
sz = strlen(conf.manpath.paths[j]); |
| |
if (sz && conf.manpath.paths[j][sz - 1] == '/') |
| |
conf.manpath.paths[j][--sz] = '\0'; |
| |
if (0 == sz) |
| |
continue; |
| |
|
| strlcat(ibuf, dir, MAXPATHLEN); |
if (j) { |
| strlcat(ibuf, "/", MAXPATHLEN); |
mandoc_ohash_init(&mpages, 6, |
| sz2 = strlcat(ibuf, MANDOC_IDX, MAXPATHLEN); |
offsetof(struct mpage, inodev)); |
| |
mandoc_ohash_init(&mlinks, 6, |
| |
offsetof(struct mlink, file)); |
| |
} |
| |
|
| if (sz1 >= MAXPATHLEN || sz2 >= MAXPATHLEN) { |
if ( ! set_basedir(conf.manpath.paths[j], argc > 0)) |
| fprintf(stderr, "%s: Path too long\n", dir); |
continue; |
| exit((int)MANDOCLEVEL_BADARG); |
if (0 == treescan()) |
| |
continue; |
| |
dba = dba_new(128); |
| |
mpages_merge(dba, mp); |
| |
if (nodb == 0) |
| |
dbwrite(dba); |
| |
dba_free(dba); |
| |
|
| |
if (j + 1 < conf.manpath.sz) { |
| |
mpages_free(); |
| |
ohash_delete(&mpages); |
| |
ohash_delete(&mlinks); |
| |
} |
| } |
} |
| |
} |
| |
out: |
| |
manconf_free(&conf); |
| |
mparse_free(mp); |
| |
mchars_free(); |
| |
mpages_free(); |
| |
ohash_delete(&mpages); |
| |
ohash_delete(&mlinks); |
| |
return exitcode; |
| |
usage: |
| |
progname = getprogname(); |
| |
fprintf(stderr, "usage: %s [-aDnpQ] [-C file] [-Tutf8]\n" |
| |
" %s [-aDnpQ] [-Tutf8] dir ...\n" |
| |
" %s [-DnpQ] [-Tutf8] -d dir [file ...]\n" |
| |
" %s [-Dnp] -u dir [file ...]\n" |
| |
" %s [-Q] -t file ...\n", |
| |
progname, progname, progname, progname, progname); |
| |
|
| db = dbopen(fbuf, flags, 0644, DB_BTREE, &info); |
return (int)MANDOCLEVEL_BADARG; |
| idx = dbopen(ibuf, flags, 0644, DB_RECNO, NULL); |
} |
| |
|
| if (NULL == db) { |
/* |
| perror(fbuf); |
* To get a singly linked list in alpha order while inserting entries |
| exit((int)MANDOCLEVEL_SYSERR); |
* at the beginning, process directory entries in reverse alpha order. |
| } else if (NULL == idx) { |
*/ |
| perror(ibuf); |
static int |
| exit((int)MANDOCLEVEL_SYSERR); |
#if HAVE_FTS_COMPARE_CONST |
| } |
fts_compare(const FTSENT *const *a, const FTSENT *const *b) |
| |
#else |
| |
fts_compare(const FTSENT **a, const FTSENT **b) |
| |
#endif |
| |
{ |
| |
return -strcmp((*a)->fts_name, (*b)->fts_name); |
| |
} |
| |
|
| if (verb > 2) { |
/* |
| printf("%s: Opened\n", fbuf); |
* Scan a directory tree rooted at "basedir" for manpages. |
| printf("%s: Opened\n", ibuf); |
* We use fts(), scanning directory parts along the way for clues to our |
| } |
* section and architecture. |
| |
* |
| |
* If use_all has been specified, grok all files. |
| |
* If not, sanitise paths to the following: |
| |
* |
| |
* [./]man*[/<arch>]/<name>.<section> |
| |
* or |
| |
* [./]cat<section>[/<arch>]/<name>.0 |
| |
* |
| |
* TODO: accommodate for multi-language directories. |
| |
*/ |
| |
static int |
| |
treescan(void) |
| |
{ |
| |
char buf[PATH_MAX]; |
| |
FTS *f; |
| |
FTSENT *ff; |
| |
struct mlink *mlink; |
| |
int gzip; |
| |
enum form dform; |
| |
char *dsec, *arch, *fsec, *cp; |
| |
const char *path; |
| |
const char *argv[2]; |
| |
|
| ofile_argbuild(argc, argv, &of); |
argv[0] = "."; |
| if (NULL == of) |
argv[1] = NULL; |
| goto out; |
|
| |
|
| of = of->first; |
f = fts_open((char * const *)argv, FTS_PHYSICAL | FTS_NOCHDIR, |
| |
fts_compare); |
| |
if (f == NULL) { |
| |
exitcode = (int)MANDOCLEVEL_SYSERR; |
| |
say("", "&fts_open"); |
| |
return 0; |
| |
} |
| |
|
| index_prune(of, db, fbuf, idx, ibuf, |
dsec = arch = NULL; |
| &maxrec, &recs, &recsz, &reccur); |
dform = FORM_NONE; |
| |
|
| |
while ((ff = fts_read(f)) != NULL) { |
| |
path = ff->fts_path + 2; |
| |
switch (ff->fts_info) { |
| |
|
| /* |
/* |
| * Go to the root of the respective manual tree |
* Symbolic links require various sanity checks, |
| * such that .so links work. In case of failure, |
* then get handled just like regular files. |
| * just prod on, even though .so links won't work. |
|
| */ |
*/ |
| |
case FTS_SL: |
| |
if (realpath(path, buf) == NULL) { |
| |
if (warnings) |
| |
say(path, "&realpath"); |
| |
continue; |
| |
} |
| |
if (strstr(buf, basedir) != buf |
| |
#ifdef HOMEBREWDIR |
| |
&& strstr(buf, HOMEBREWDIR) != buf |
| |
#endif |
| |
) { |
| |
if (warnings) say("", |
| |
"%s: outside base directory", buf); |
| |
continue; |
| |
} |
| |
/* Use logical inode to avoid mpages dupe. */ |
| |
if (stat(path, ff->fts_statp) == -1) { |
| |
if (warnings) |
| |
say(path, "&stat"); |
| |
continue; |
| |
} |
| |
/* FALLTHROUGH */ |
| |
|
| if (OP_UPDATE == op) { |
/* |
| chdir(dir); |
* If we're a regular file, add an mlink by using the |
| index_merge(of, mp, &dbuf, &buf, hash, |
* stored directory data and handling the filename. |
| db, fbuf, idx, ibuf, |
*/ |
| maxrec, recs, reccur); |
case FTS_F: |
| } |
if ( ! strcmp(path, MANDOC_DB)) |
| |
continue; |
| |
if ( ! use_all && ff->fts_level < 2) { |
| |
if (warnings) |
| |
say(path, "Extraneous file"); |
| |
continue; |
| |
} |
| |
gzip = 0; |
| |
fsec = NULL; |
| |
while (fsec == NULL) { |
| |
fsec = strrchr(ff->fts_name, '.'); |
| |
if (fsec == NULL || strcmp(fsec+1, "gz")) |
| |
break; |
| |
gzip = 1; |
| |
*fsec = '\0'; |
| |
fsec = NULL; |
| |
} |
| |
if (fsec == NULL) { |
| |
if ( ! use_all) { |
| |
if (warnings) |
| |
say(path, |
| |
"No filename suffix"); |
| |
continue; |
| |
} |
| |
} else if ( ! strcmp(++fsec, "html")) { |
| |
if (warnings) |
| |
say(path, "Skip html"); |
| |
continue; |
| |
} else if ( ! strcmp(fsec, "ps")) { |
| |
if (warnings) |
| |
say(path, "Skip ps"); |
| |
continue; |
| |
} else if ( ! strcmp(fsec, "pdf")) { |
| |
if (warnings) |
| |
say(path, "Skip pdf"); |
| |
continue; |
| |
} else if ( ! use_all && |
| |
((dform == FORM_SRC && |
| |
strncmp(fsec, dsec, strlen(dsec))) || |
| |
(dform == FORM_CAT && strcmp(fsec, "0")))) { |
| |
if (warnings) |
| |
say(path, "Wrong filename suffix"); |
| |
continue; |
| |
} else |
| |
fsec[-1] = '\0'; |
| |
|
| goto out; |
mlink = mandoc_calloc(1, sizeof(struct mlink)); |
| } |
if (strlcpy(mlink->file, path, |
| |
sizeof(mlink->file)) >= |
| |
sizeof(mlink->file)) { |
| |
say(path, "Filename too long"); |
| |
free(mlink); |
| |
continue; |
| |
} |
| |
mlink->dform = dform; |
| |
mlink->dsec = dsec; |
| |
mlink->arch = arch; |
| |
mlink->name = ff->fts_name; |
| |
mlink->fsec = fsec; |
| |
mlink->gzip = gzip; |
| |
mlink_add(mlink, ff->fts_statp); |
| |
continue; |
| |
|
| /* |
case FTS_D: |
| * Configure the directories we're going to scan. |
case FTS_DP: |
| * If we have command-line arguments, use them. |
break; |
| * If not, we use man(1)'s method (see mandocdb.8). |
|
| */ |
|
| |
|
| if (argc > 0) { |
default: |
| dirs.paths = mandoc_calloc(argc, sizeof(char *)); |
if (warnings) |
| dirs.sz = argc; |
say(path, "Not a regular file"); |
| for (i = 0; i < argc; i++) { |
continue; |
| if (NULL == (cp = realpath(argv[i], pbuf))) { |
} |
| perror(argv[i]); |
|
| goto out; |
switch (ff->fts_level) { |
| |
case 0: |
| |
/* Ignore the root directory. */ |
| |
break; |
| |
case 1: |
| |
/* |
| |
* This might contain manX/ or catX/. |
| |
* Try to infer this from the name. |
| |
* If we're not in use_all, enforce it. |
| |
*/ |
| |
cp = ff->fts_name; |
| |
if (ff->fts_info == FTS_DP) { |
| |
dform = FORM_NONE; |
| |
dsec = NULL; |
| |
break; |
| } |
} |
| dirs.paths[i] = mandoc_strdup(cp); |
|
| |
if ( ! strncmp(cp, "man", 3)) { |
| |
dform = FORM_SRC; |
| |
dsec = cp + 3; |
| |
} else if ( ! strncmp(cp, "cat", 3)) { |
| |
dform = FORM_CAT; |
| |
dsec = cp + 3; |
| |
} else { |
| |
dform = FORM_NONE; |
| |
dsec = NULL; |
| |
} |
| |
|
| |
if (dsec != NULL || use_all) |
| |
break; |
| |
|
| |
if (warnings) |
| |
say(path, "Unknown directory part"); |
| |
fts_set(f, ff, FTS_SKIP); |
| |
break; |
| |
case 2: |
| |
/* |
| |
* Possibly our architecture. |
| |
* If we're descending, keep tabs on it. |
| |
*/ |
| |
if (ff->fts_info != FTS_DP && dsec != NULL) |
| |
arch = ff->fts_name; |
| |
else |
| |
arch = NULL; |
| |
break; |
| |
default: |
| |
if (ff->fts_info == FTS_DP || use_all) |
| |
break; |
| |
if (warnings) |
| |
say(path, "Extraneous directory part"); |
| |
fts_set(f, ff, FTS_SKIP); |
| |
break; |
| } |
} |
| } else |
} |
| manpath_parse(&dirs, conf_file, NULL, NULL); |
|
| |
|
| for (i = 0; i < dirs.sz; i++) { |
fts_close(f); |
| ibuf[0] = fbuf[0] = '\0'; |
return 1; |
| |
} |
| |
|
| strlcat(fbuf, dirs.paths[i], MAXPATHLEN); |
/* |
| strlcat(fbuf, "/", MAXPATHLEN); |
* Add a file to the mlinks table. |
| sz1 = strlcat(fbuf, MANDOC_DB, MAXPATHLEN); |
* Do not verify that it's a "valid" looking manpage (we'll do that |
| |
* later). |
| |
* |
| |
* Try to infer the manual section, architecture, and page name from the |
| |
* path, assuming it looks like |
| |
* |
| |
* [./]man*[/<arch>]/<name>.<section> |
| |
* or |
| |
* [./]cat<section>[/<arch>]/<name>.0 |
| |
* |
| |
* See treescan() for the fts(3) version of this. |
| |
*/ |
| |
static void |
| |
filescan(const char *file) |
| |
{ |
| |
char buf[PATH_MAX]; |
| |
struct stat st; |
| |
struct mlink *mlink; |
| |
char *p, *start; |
| |
|
| strlcat(ibuf, dirs.paths[i], MAXPATHLEN); |
assert(use_all); |
| strlcat(ibuf, "/", MAXPATHLEN); |
|
| sz2 = strlcat(ibuf, MANDOC_IDX, MAXPATHLEN); |
|
| |
|
| if (sz1 >= MAXPATHLEN || sz2 >= MAXPATHLEN) { |
if (0 == strncmp(file, "./", 2)) |
| fprintf(stderr, "%s: Path too long\n", |
file += 2; |
| dirs.paths[i]); |
|
| exit((int)MANDOCLEVEL_BADARG); |
/* |
| |
* We have to do lstat(2) before realpath(3) loses |
| |
* the information whether this is a symbolic link. |
| |
* We need to know that because for symbolic links, |
| |
* we want to use the orginal file name, while for |
| |
* regular files, we want to use the real path. |
| |
*/ |
| |
if (-1 == lstat(file, &st)) { |
| |
exitcode = (int)MANDOCLEVEL_BADARG; |
| |
say(file, "&lstat"); |
| |
return; |
| |
} else if (0 == ((S_IFREG | S_IFLNK) & st.st_mode)) { |
| |
exitcode = (int)MANDOCLEVEL_BADARG; |
| |
say(file, "Not a regular file"); |
| |
return; |
| |
} |
| |
|
| |
/* |
| |
* We have to resolve the file name to the real path |
| |
* in any case for the base directory check. |
| |
*/ |
| |
if (NULL == realpath(file, buf)) { |
| |
exitcode = (int)MANDOCLEVEL_BADARG; |
| |
say(file, "&realpath"); |
| |
return; |
| |
} |
| |
|
| |
if (OP_TEST == op) |
| |
start = buf; |
| |
else if (strstr(buf, basedir) == buf) |
| |
start = buf + strlen(basedir); |
| |
#ifdef HOMEBREWDIR |
| |
else if (strstr(buf, HOMEBREWDIR) == buf) |
| |
start = buf; |
| |
#endif |
| |
else { |
| |
exitcode = (int)MANDOCLEVEL_BADARG; |
| |
say("", "%s: outside base directory", buf); |
| |
return; |
| |
} |
| |
|
| |
/* |
| |
* Now we are sure the file is inside our tree. |
| |
* If it is a symbolic link, ignore the real path |
| |
* and use the original name. |
| |
* This implies passing stuff like "cat1/../man1/foo.1" |
| |
* on the command line won't work. So don't do that. |
| |
* Note the stat(2) can still fail if the link target |
| |
* doesn't exist. |
| |
*/ |
| |
if (S_IFLNK & st.st_mode) { |
| |
if (-1 == stat(buf, &st)) { |
| |
exitcode = (int)MANDOCLEVEL_BADARG; |
| |
say(file, "&stat"); |
| |
return; |
| } |
} |
| |
if (strlcpy(buf, file, sizeof(buf)) >= sizeof(buf)) { |
| |
say(file, "Filename too long"); |
| |
return; |
| |
} |
| |
start = buf; |
| |
if (OP_TEST != op && strstr(buf, basedir) == buf) |
| |
start += strlen(basedir); |
| |
} |
| |
|
| if (db) |
mlink = mandoc_calloc(1, sizeof(struct mlink)); |
| (*db->close)(db); |
mlink->dform = FORM_NONE; |
| if (idx) |
if (strlcpy(mlink->file, start, sizeof(mlink->file)) >= |
| (*idx->close)(idx); |
sizeof(mlink->file)) { |
| |
say(start, "Filename too long"); |
| |
free(mlink); |
| |
return; |
| |
} |
| |
|
| db = dbopen(fbuf, flags, 0644, DB_BTREE, &info); |
/* |
| idx = dbopen(ibuf, flags, 0644, DB_RECNO, NULL); |
* In test mode or when the original name is absolute |
| |
* but outside our tree, guess the base directory. |
| |
*/ |
| |
|
| if (NULL == db) { |
if (op == OP_TEST || (start == buf && *start == '/')) { |
| perror(fbuf); |
if (strncmp(buf, "man/", 4) == 0) |
| exit((int)MANDOCLEVEL_SYSERR); |
start = buf + 4; |
| } else if (NULL == idx) { |
else if ((start = strstr(buf, "/man/")) != NULL) |
| perror(ibuf); |
start += 5; |
| exit((int)MANDOCLEVEL_SYSERR); |
else |
| |
start = buf; |
| |
} |
| |
|
| |
/* |
| |
* First try to guess our directory structure. |
| |
* If we find a separator, try to look for man* or cat*. |
| |
* If we find one of these and what's underneath is a directory, |
| |
* assume it's an architecture. |
| |
*/ |
| |
if (NULL != (p = strchr(start, '/'))) { |
| |
*p++ = '\0'; |
| |
if (0 == strncmp(start, "man", 3)) { |
| |
mlink->dform = FORM_SRC; |
| |
mlink->dsec = start + 3; |
| |
} else if (0 == strncmp(start, "cat", 3)) { |
| |
mlink->dform = FORM_CAT; |
| |
mlink->dsec = start + 3; |
| } |
} |
| |
|
| if (verb > 2) { |
start = p; |
| printf("%s: Truncated\n", fbuf); |
if (NULL != mlink->dsec && NULL != (p = strchr(start, '/'))) { |
| printf("%s: Truncated\n", ibuf); |
*p++ = '\0'; |
| |
mlink->arch = start; |
| |
start = p; |
| } |
} |
| |
} |
| |
|
| ofile_free(of); |
/* |
| of = NULL; |
* Now check the file suffix. |
| |
* Suffix of `.0' indicates a catpage, `.1-9' is a manpage. |
| |
*/ |
| |
p = strrchr(start, '\0'); |
| |
while (p-- > start && '/' != *p && '.' != *p) |
| |
/* Loop. */ ; |
| |
|
| if ( ! ofile_dirbuild(dirs.paths[i], NULL, NULL, |
if ('.' == *p) { |
| 0, &of)) |
*p++ = '\0'; |
| exit((int)MANDOCLEVEL_SYSERR); |
mlink->fsec = p; |
| |
} |
| |
|
| if (NULL == of) |
/* |
| continue; |
* Now try to parse the name. |
| |
* Use the filename portion of the path. |
| |
*/ |
| |
mlink->name = start; |
| |
if (NULL != (p = strrchr(start, '/'))) { |
| |
mlink->name = p + 1; |
| |
*p = '\0'; |
| |
} |
| |
mlink_add(mlink, &st); |
| |
} |
| |
|
| of = of->first; |
static void |
| |
mlink_add(struct mlink *mlink, const struct stat *st) |
| |
{ |
| |
struct inodev inodev; |
| |
struct mpage *mpage; |
| |
unsigned int slot; |
| |
|
| /* |
assert(NULL != mlink->file); |
| * Go to the root of the respective manual tree |
|
| * such that .so links work. In case of failure, |
|
| * just prod on, even though .so links won't work. |
|
| */ |
|
| |
|
| chdir(dirs.paths[i]); |
mlink->dsec = mandoc_strdup(mlink->dsec ? mlink->dsec : ""); |
| index_merge(of, mp, &dbuf, &buf, hash, db, fbuf, |
mlink->arch = mandoc_strdup(mlink->arch ? mlink->arch : ""); |
| idx, ibuf, maxrec, recs, reccur); |
mlink->name = mandoc_strdup(mlink->name ? mlink->name : ""); |
| } |
mlink->fsec = mandoc_strdup(mlink->fsec ? mlink->fsec : ""); |
| |
|
| out: |
if ('0' == *mlink->fsec) { |
| if (db) |
free(mlink->fsec); |
| (*db->close)(db); |
mlink->fsec = mandoc_strdup(mlink->dsec); |
| if (idx) |
mlink->fform = FORM_CAT; |
| (*idx->close)(idx); |
} else if ('1' <= *mlink->fsec && '9' >= *mlink->fsec) |
| if (hash) |
mlink->fform = FORM_SRC; |
| (*hash->close)(hash); |
else |
| if (mp) |
mlink->fform = FORM_NONE; |
| mparse_free(mp); |
|
| |
|
| manpath_free(&dirs); |
slot = ohash_qlookup(&mlinks, mlink->file); |
| ofile_free(of); |
assert(NULL == ohash_find(&mlinks, slot)); |
| free(buf.cp); |
ohash_insert(&mlinks, slot, mlink); |
| free(dbuf.cp); |
|
| free(recs); |
|
| |
|
| return(MANDOCLEVEL_OK); |
memset(&inodev, 0, sizeof(inodev)); /* Clear padding. */ |
| |
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; |
| |
mpage->form = FORM_NONE; |
| |
mpage->next = mpage_head; |
| |
mpage_head = mpage; |
| |
ohash_insert(&mpages, slot, mpage); |
| |
} else |
| |
mlink->next = mpage->mlinks; |
| |
mpage->mlinks = mlink; |
| |
mlink->mpage = mpage; |
| } |
} |
| |
|
| void |
static void |
| index_merge(const struct of *of, struct mparse *mp, |
mlink_free(struct mlink *mlink) |
| struct buf *dbuf, struct buf *buf, DB *hash, |
|
| DB *db, const char *dbf, DB *idx, const char *idxf, |
|
| recno_t maxrec, const recno_t *recs, size_t reccur) |
|
| { |
{ |
| recno_t rec; |
|
| int ch; |
|
| DBT key, val; |
|
| struct mdoc *mdoc; |
|
| struct man *man; |
|
| const char *fn, *msec, *mtitle, *arch; |
|
| size_t sv; |
|
| unsigned seq; |
|
| struct db_val vbuf; |
|
| |
|
| for (rec = 0; of; of = of->next) { |
free(mlink->dsec); |
| fn = of->fname; |
free(mlink->arch); |
| |
free(mlink->name); |
| |
free(mlink->fsec); |
| |
free(mlink); |
| |
} |
| |
|
| /* |
static void |
| * Try interpreting the file as mdoc(7) or man(7) |
mpages_free(void) |
| * source code, unless it is already known to be |
{ |
| * formatted. Fall back to formatted mode. |
struct mpage *mpage; |
| */ |
struct mlink *mlink; |
| |
|
| mparse_reset(mp); |
while ((mpage = mpage_head) != NULL) { |
| mdoc = NULL; |
while ((mlink = mpage->mlinks) != NULL) { |
| man = NULL; |
mpage->mlinks = mlink->next; |
| |
mlink_free(mlink); |
| |
} |
| |
mpage_head = mpage->next; |
| |
free(mpage->sec); |
| |
free(mpage->arch); |
| |
free(mpage->title); |
| |
free(mpage->desc); |
| |
free(mpage); |
| |
} |
| |
} |
| |
|
| if ((MANDOC_SRC & of->src_form || |
/* |
| ! (MANDOC_FORM & of->src_form)) && |
* For each mlink to the mpage, check whether the path looks like |
| MANDOCLEVEL_FATAL > mparse_readfd(mp, -1, fn)) |
* it is formatted, and if it does, check whether a source manual |
| mparse_result(mp, &mdoc, &man); |
* exists by the same name, ignoring the suffix. |
| |
* If both conditions hold, drop the mlink. |
| |
*/ |
| |
static void |
| |
mlinks_undupe(struct mpage *mpage) |
| |
{ |
| |
char buf[PATH_MAX]; |
| |
struct mlink **prev; |
| |
struct mlink *mlink; |
| |
char *bufp; |
| |
|
| if (NULL != mdoc) { |
mpage->form = FORM_CAT; |
| msec = mdoc_meta(mdoc)->msec; |
prev = &mpage->mlinks; |
| arch = mdoc_meta(mdoc)->arch; |
while (NULL != (mlink = *prev)) { |
| mtitle = mdoc_meta(mdoc)->title; |
if (FORM_CAT != mlink->dform) { |
| } else if (NULL != man) { |
mpage->form = FORM_NONE; |
| msec = man_meta(man)->msec; |
goto nextlink; |
| arch = NULL; |
|
| mtitle = man_meta(man)->title; |
|
| } else { |
|
| msec = of->sec; |
|
| arch = of->arch; |
|
| mtitle = of->title; |
|
| } |
} |
| |
(void)strlcpy(buf, mlink->file, sizeof(buf)); |
| |
bufp = strstr(buf, "cat"); |
| |
assert(NULL != bufp); |
| |
memcpy(bufp, "man", 3); |
| |
if (NULL != (bufp = strrchr(buf, '.'))) |
| |
*++bufp = '\0'; |
| |
(void)strlcat(buf, mlink->dsec, sizeof(buf)); |
| |
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; |
| |
} |
| |
} |
| |
|
| /* |
static void |
| * By default, skip a file if the manual section |
mlink_check(struct mpage *mpage, struct mlink *mlink) |
| * and architecture given in the file disagree |
{ |
| * with the directory where the file is located. |
struct str *str; |
| */ |
unsigned int slot; |
| |
|
| if (0 == use_all) { |
/* |
| assert(of->sec); |
* Check whether the manual section given in a file |
| assert(msec); |
* agrees with the directory where the file is located. |
| if (strcasecmp(msec, of->sec)) |
* Some manuals have suffixes like (3p) on their |
| continue; |
* 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 (NULL == arch) { |
if (FORM_SRC == mpage->form && |
| if (NULL != of->arch) |
strcasecmp(mpage->sec, mlink->dsec)) |
| continue; |
say(mlink->file, "Section \"%s\" manual in %s directory", |
| } else if (NULL == of->arch || |
mpage->sec, mlink->dsec); |
| strcasecmp(arch, of->arch)) |
|
| continue; |
|
| } |
|
| |
|
| if (NULL == arch) |
/* |
| arch = ""; |
* 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, and sparc64. |
| |
*/ |
| |
|
| /* |
if (strcasecmp(mpage->arch, mlink->arch)) |
| * By default, skip a file if the title given |
say(mlink->file, "Architecture \"%s\" manual in " |
| * in the file disagrees with the file name. |
"\"%s\" directory", mpage->arch, mlink->arch); |
| * If both agree, use the file name as the title, |
|
| * because the one in the file usually is all caps. |
|
| */ |
|
| |
|
| assert(of->title); |
/* |
| assert(mtitle); |
* XXX |
| |
* parse_cat() doesn't set NAME_TITLE yet. |
| |
*/ |
| |
|
| if (0 == strcasecmp(mtitle, of->title)) |
if (FORM_CAT == mpage->form) |
| mtitle = of->title; |
return; |
| else if (0 == use_all) |
|
| continue; |
|
| |
|
| /* |
/* |
| * The index record value consists of a nil-terminated |
* Check whether this mlink |
| * filename, a nil-terminated manual section, and a |
* appears as a name in the NAME section. |
| * nil-terminated description. Since the description |
*/ |
| * may not be set, we set a sentinel to see if we're |
|
| * going to write a nil byte in its place. |
|
| */ |
|
| |
|
| dbuf->len = 0; |
slot = ohash_qlookup(&names, mlink->name); |
| buf_append(dbuf, mdoc ? "mdoc" : (man ? "man" : "cat")); |
str = ohash_find(&names, slot); |
| buf_appendb(dbuf, fn, strlen(fn) + 1); |
assert(NULL != str); |
| buf_appendb(dbuf, msec, strlen(msec) + 1); |
if ( ! (NAME_TITLE & str->mask)) |
| buf_appendb(dbuf, mtitle, strlen(mtitle) + 1); |
say(mlink->file, "Name missing in NAME section"); |
| buf_appendb(dbuf, arch, strlen(arch) + 1); |
} |
| |
|
| sv = dbuf->len; |
/* |
| |
* Run through the files in the global vector "mpages" |
| |
* and add them to the database specified in "basedir". |
| |
* |
| |
* This handles the parsing scheme itself, using the cues of directory |
| |
* and filename to determine whether the file is parsable or not. |
| |
*/ |
| |
static void |
| |
mpages_merge(struct dba *dba, struct mparse *mp) |
| |
{ |
| |
struct mpage *mpage, *mpage_dest; |
| |
struct mlink *mlink, *mlink_dest; |
| |
struct roff_man *man; |
| |
char *sodest; |
| |
char *cp; |
| |
int fd; |
| |
|
| /* |
for (mpage = mpage_head; mpage != NULL; mpage = mpage->next) { |
| * Collect keyword/mask pairs. |
mlinks_undupe(mpage); |
| * Each pair will become a new btree node. |
if ((mlink = mpage->mlinks) == NULL) |
| */ |
continue; |
| |
|
| hash_reset(&hash); |
name_mask = NAME_MASK; |
| if (mdoc) |
mandoc_ohash_init(&names, 4, offsetof(struct str, key)); |
| pmdoc_node(hash, buf, dbuf, |
mandoc_ohash_init(&strings, 6, offsetof(struct str, key)); |
| mdoc_node(mdoc), mdoc_meta(mdoc)); |
mparse_reset(mp); |
| else if (man) |
man = NULL; |
| pman_node(hash, buf, dbuf, man_node(man)); |
sodest = NULL; |
| else |
|
| pformatted(hash, buf, dbuf, of); |
|
| |
|
| |
if ((fd = mparse_open(mp, mlink->file)) == -1) { |
| |
say(mlink->file, "&open"); |
| |
goto nextpage; |
| |
} |
| |
|
| /* |
/* |
| * Reclaim an empty index record, if available. |
* Interpret the file as mdoc(7) or man(7) source |
| * Use its record number for all new btree nodes. |
* code, unless it is known to be formatted. |
| */ |
*/ |
| |
if (mlink->dform != FORM_CAT || mlink->fform != FORM_CAT) { |
| |
mparse_readfd(mp, fd, mlink->file); |
| |
close(fd); |
| |
fd = -1; |
| |
mparse_result(mp, &man, &sodest); |
| |
} |
| |
|
| if (reccur > 0) { |
if (sodest != NULL) { |
| --reccur; |
mlink_dest = ohash_find(&mlinks, |
| rec = recs[(int)reccur]; |
ohash_qlookup(&mlinks, sodest)); |
| } else if (maxrec > 0) { |
if (mlink_dest == NULL) { |
| rec = maxrec; |
mandoc_asprintf(&cp, "%s.gz", sodest); |
| maxrec = 0; |
mlink_dest = ohash_find(&mlinks, |
| } else |
ohash_qlookup(&mlinks, cp)); |
| rec++; |
free(cp); |
| vbuf.rec = htobe32(rec); |
} |
| |
if (mlink_dest != NULL) { |
| |
|
| /* |
/* The .so target exists. */ |
| * Copy from the in-memory hashtable of pending |
|
| * keyword/mask pairs into the database. |
|
| */ |
|
| |
|
| seq = R_FIRST; |
mpage_dest = mlink_dest->mpage; |
| while (0 == (ch = (*hash->seq)(hash, &key, &val, seq))) { |
while (1) { |
| seq = R_NEXT; |
mlink->mpage = mpage_dest; |
| vbuf.mask = htobe64(*(uint64_t *)val.data); |
|
| val.size = sizeof(struct db_val); |
|
| val.data = &vbuf; |
|
| dbt_put(db, dbf, &key, &val); |
|
| } |
|
| if (ch < 0) { |
|
| perror("hash"); |
|
| exit((int)MANDOCLEVEL_SYSERR); |
|
| } |
|
| |
|
| /* |
|
| * Apply to the index. If we haven't had a description |
|
| * set, put an empty one in now. |
|
| */ |
|
| |
|
| if (dbuf->len == sv) |
/* |
| buf_appendb(dbuf, "", 1); |
* If the target was already |
| |
* processed, add the links |
| |
* to the database now. |
| |
* Otherwise, this will |
| |
* happen when we come |
| |
* to the target. |
| |
*/ |
| |
|
| key.data = &rec; |
if (mpage_dest->dba != NULL) |
| key.size = sizeof(recno_t); |
dbadd_mlink(mlink); |
| |
|
| val.data = dbuf->cp; |
if (mlink->next == NULL) |
| val.size = dbuf->len; |
break; |
| |
mlink = mlink->next; |
| |
} |
| |
|
| if (verb) |
/* Move all links to the target. */ |
| printf("%s: Added index\n", fn); |
|
| |
|
| dbt_put(idx, idxf, &key, &val); |
mlink->next = mlink_dest->next; |
| |
mlink_dest->next = mpage->mlinks; |
| |
mpage->mlinks = NULL; |
| |
} |
| |
goto nextpage; |
| |
} else if (man != NULL && man->macroset == MACROSET_MDOC) { |
| |
mdoc_validate(man); |
| |
mpage->form = FORM_SRC; |
| |
mpage->sec = man->meta.msec; |
| |
mpage->sec = mandoc_strdup( |
| |
mpage->sec == NULL ? "" : mpage->sec); |
| |
mpage->arch = man->meta.arch; |
| |
mpage->arch = mandoc_strdup( |
| |
mpage->arch == NULL ? "" : mpage->arch); |
| |
mpage->title = mandoc_strdup(man->meta.title); |
| |
} else if (man != NULL && man->macroset == MACROSET_MAN) { |
| |
man_validate(man); |
| |
if (*man->meta.msec != '\0' || |
| |
*man->meta.title != '\0') { |
| |
mpage->form = FORM_SRC; |
| |
mpage->sec = mandoc_strdup(man->meta.msec); |
| |
mpage->arch = mandoc_strdup(mlink->arch); |
| |
mpage->title = mandoc_strdup(man->meta.title); |
| |
} else |
| |
man = NULL; |
| |
} |
| |
|
| |
assert(mpage->desc == NULL); |
| |
if (man == NULL) { |
| |
mpage->form = FORM_CAT; |
| |
mpage->sec = mandoc_strdup(mlink->dsec); |
| |
mpage->arch = mandoc_strdup(mlink->arch); |
| |
mpage->title = mandoc_strdup(mlink->name); |
| |
parse_cat(mpage, fd); |
| |
} else if (man->macroset == MACROSET_MDOC) |
| |
parse_mdoc(mpage, &man->meta, man->first); |
| |
else |
| |
parse_man(mpage, &man->meta, man->first); |
| |
if (mpage->desc == NULL) { |
| |
mpage->desc = mandoc_strdup(mlink->name); |
| |
if (warnings) |
| |
say(mlink->file, "No one-line description, " |
| |
"using filename \"%s\"", mlink->name); |
| |
} |
| |
|
| |
for (mlink = mpage->mlinks; |
| |
mlink != NULL; |
| |
mlink = mlink->next) { |
| |
putkey(mpage, mlink->name, NAME_FILE); |
| |
if (warnings && !use_all) |
| |
mlink_check(mpage, mlink); |
| |
} |
| |
|
| |
dbadd(dba, mpage); |
| |
|
| |
nextpage: |
| |
ohash_delete(&strings); |
| |
ohash_delete(&names); |
| } |
} |
| } |
} |
| |
|
| /* |
|
| * Scan through all entries in the index file `idx' and prune those |
|
| * entries in `ofile'. |
|
| * Pruning consists of removing from `db', then invalidating the entry |
|
| * in `idx' (zeroing its value size). |
|
| */ |
|
| static void |
static void |
| index_prune(const struct of *ofile, DB *db, const char *dbf, |
parse_cat(struct mpage *mpage, int fd) |
| DB *idx, const char *idxf, recno_t *maxrec, |
|
| recno_t **recs, size_t *recsz, size_t *reccur) |
|
| { |
{ |
| const struct of *of; |
FILE *stream; |
| const char *fn, *cp; |
struct mlink *mlink; |
| struct db_val *vbuf; |
char *line, *p, *title, *sec; |
| unsigned seq, sseq; |
size_t linesz, plen, titlesz; |
| DBT key, val; |
ssize_t len; |
| int ch; |
int offs; |
| |
|
| *reccur = 0; |
mlink = mpage->mlinks; |
| seq = R_FIRST; |
stream = fd == -1 ? fopen(mlink->file, "r") : fdopen(fd, "r"); |
| while (0 == (ch = (*idx->seq)(idx, &key, &val, seq))) { |
if (stream == NULL) { |
| seq = R_NEXT; |
if (fd != -1) |
| *maxrec = *(recno_t *)key.data; |
close(fd); |
| cp = val.data; |
if (warnings) |
| |
say(mlink->file, "&fopen"); |
| |
return; |
| |
} |
| |
|
| /* Deleted records are zero-sized. Skip them. */ |
line = NULL; |
| |
linesz = 0; |
| |
|
| if (0 == val.size) |
/* Parse the section number from the header line. */ |
| goto cont; |
|
| |
|
| /* |
while (getline(&line, &linesz, stream) != -1) { |
| * Make sure we're sane. |
if (*line == '\n') |
| * Read past our mdoc/man/cat type to the next string, |
continue; |
| * then make sure it's bounded by a NUL. |
if ((sec = strchr(line, '(')) == NULL) |
| * Failing any of these, we go into our error handler. |
|
| */ |
|
| |
|
| if (NULL == (fn = memchr(cp, '\0', val.size))) |
|
| break; |
break; |
| if (++fn - cp >= (int)val.size) |
if ((p = strchr(++sec, ')')) == NULL) |
| break; |
break; |
| if (NULL == memchr(fn, '\0', val.size - (fn - cp))) |
free(mpage->sec); |
| |
mpage->sec = mandoc_strndup(sec, p - sec); |
| |
if (warnings && *mlink->dsec != '\0' && |
| |
strcasecmp(mpage->sec, mlink->dsec)) |
| |
say(mlink->file, |
| |
"Section \"%s\" manual in %s directory", |
| |
mpage->sec, mlink->dsec); |
| |
break; |
| |
} |
| |
|
| |
/* Skip to first blank line. */ |
| |
|
| |
while (line == NULL || *line != '\n') |
| |
if (getline(&line, &linesz, stream) == -1) |
| break; |
break; |
| |
|
| /* |
/* |
| * Search for the file in those we care about. |
* Assume the first line that is not indented |
| * XXX: build this into a tree. Too slow. |
* is the first section header. Skip to it. |
| */ |
*/ |
| |
|
| for (of = ofile; of; of = of->next) |
while (getline(&line, &linesz, stream) != -1) |
| if (0 == strcmp(fn, of->fname)) |
if (*line != '\n' && *line != ' ') |
| break; |
break; |
| |
|
| if (NULL == of) |
/* |
| |
* Read up until the next section into a buffer. |
| |
* Strip the leading and trailing newline from each read line, |
| |
* appending a trailing space. |
| |
* Ignore empty (whitespace-only) lines. |
| |
*/ |
| |
|
| |
titlesz = 0; |
| |
title = NULL; |
| |
|
| |
while ((len = getline(&line, &linesz, stream)) != -1) { |
| |
if (*line != ' ') |
| |
break; |
| |
offs = 0; |
| |
while (isspace((unsigned char)line[offs])) |
| |
offs++; |
| |
if (line[offs] == '\0') |
| continue; |
continue; |
| |
title = mandoc_realloc(title, titlesz + len - offs); |
| |
memcpy(title + titlesz, line + offs, len - offs); |
| |
titlesz += len - offs; |
| |
title[titlesz - 1] = ' '; |
| |
} |
| |
free(line); |
| |
|
| /* |
/* |
| * Search through the keyword database, throwing out all |
* If no page content can be found, or the input line |
| * references to our file. |
* is already the next section header, or there is no |
| */ |
* trailing newline, reuse the page title as the page |
| |
* description. |
| |
*/ |
| |
|
| sseq = R_FIRST; |
if (NULL == title || '\0' == *title) { |
| while (0 == (ch = (*db->seq)(db, &key, &val, sseq))) { |
if (warnings) |
| sseq = R_NEXT; |
say(mlink->file, "Cannot find NAME section"); |
| if (sizeof(struct db_val) != val.size) |
fclose(stream); |
| break; |
free(title); |
| |
return; |
| |
} |
| |
|
| vbuf = val.data; |
title[titlesz - 1] = '\0'; |
| if (*maxrec != betoh32(vbuf->rec)) |
|
| continue; |
|
| |
|
| if ((ch = (*db->del)(db, &key, R_CURSOR)) < 0) |
/* |
| break; |
* Skip to the first dash. |
| } |
* Use the remaining line as the description (no more than 70 |
| |
* bytes). |
| |
*/ |
| |
|
| if (ch < 0) { |
if (NULL != (p = strstr(title, "- "))) { |
| perror(dbf); |
for (p += 2; ' ' == *p || '\b' == *p; p++) |
| exit((int)MANDOCLEVEL_SYSERR); |
/* Skip to next word. */ ; |
| } else if (1 != ch) { |
} else { |
| fprintf(stderr, "%s: Corrupt database\n", dbf); |
if (warnings) |
| exit((int)MANDOCLEVEL_SYSERR); |
say(mlink->file, "No dash in title line, " |
| } |
"reusing \"%s\" as one-line description", title); |
| |
p = title; |
| |
} |
| |
|
| if (verb) |
plen = strlen(p); |
| printf("%s: Deleted index\n", fn); |
|
| |
|
| val.size = 0; |
/* Strip backspace-encoding from line. */ |
| ch = (*idx->put)(idx, &key, &val, R_CURSOR); |
|
| |
|
| if (ch < 0) |
while (NULL != (line = memchr(p, '\b', plen))) { |
| break; |
len = line - p; |
| cont: |
if (0 == len) { |
| if (*reccur >= *recsz) { |
memmove(line, line + 1, plen--); |
| *recsz += MANDOC_SLOP; |
continue; |
| *recs = mandoc_realloc |
|
| (*recs, *recsz * sizeof(recno_t)); |
|
| } |
} |
| |
memmove(line - 1, line + 1, plen - len); |
| (*recs)[(int)*reccur] = *maxrec; |
plen -= 2; |
| (*reccur)++; |
|
| } |
} |
| |
|
| if (ch < 0) { |
mpage->desc = mandoc_strdup(p); |
| perror(idxf); |
fclose(stream); |
| exit((int)MANDOCLEVEL_SYSERR); |
free(title); |
| } else if (1 != ch) { |
} |
| fprintf(stderr, "%s: Corrupt index\n", idxf); |
|
| exit((int)MANDOCLEVEL_SYSERR); |
|
| } |
|
| |
|
| (*maxrec)++; |
/* |
| |
* Put a type/word pair into the word database for this particular file. |
| |
*/ |
| |
static void |
| |
putkey(const struct mpage *mpage, char *value, uint64_t type) |
| |
{ |
| |
putkeys(mpage, value, strlen(value), type); |
| } |
} |
| |
|
| /* |
/* |
| * Grow the buffer (if necessary) and copy in a binary string. |
* Grok all nodes at or below a certain mdoc node into putkey(). |
| */ |
*/ |
| static void |
static void |
| buf_appendb(struct buf *buf, const void *cp, size_t sz) |
putmdockey(const struct mpage *mpage, |
| |
const struct roff_node *n, uint64_t m, int taboo) |
| { |
{ |
| |
|
| /* Overshoot by MANDOC_BUFSZ. */ |
for ( ; NULL != n; n = n->next) { |
| |
if (n->flags & taboo) |
| while (buf->len + sz >= buf->size) { |
continue; |
| buf->size = buf->len + sz + MANDOC_BUFSZ; |
if (NULL != n->child) |
| buf->cp = mandoc_realloc(buf->cp, buf->size); |
putmdockey(mpage, n->child, m, taboo); |
| |
if (n->type == ROFFT_TEXT) |
| |
putkey(mpage, n->string, m); |
| } |
} |
| |
|
| memcpy(buf->cp + (int)buf->len, cp, sz); |
|
| buf->len += sz; |
|
| } |
} |
| |
|
| /* |
|
| * Append a nil-terminated string to the buffer. |
|
| * This can be invoked multiple times. |
|
| * The buffer string will be nil-terminated. |
|
| * If invoked multiple times, a space is put between strings. |
|
| */ |
|
| static void |
static void |
| buf_append(struct buf *buf, const char *cp) |
parse_man(struct mpage *mpage, const struct roff_meta *meta, |
| |
const struct roff_node *n) |
| { |
{ |
| |
const struct roff_node *head, *body; |
| |
char *start, *title; |
| |
char byte; |
| size_t sz; |
size_t sz; |
| |
|
| if (0 == (sz = strlen(cp))) |
if (n == NULL) |
| return; |
return; |
| |
|
| if (buf->len) |
/* |
| buf->cp[(int)buf->len - 1] = ' '; |
* We're only searching for one thing: the first text child in |
| |
* the BODY of a NAME section. Since we don't keep track of |
| |
* sections in -man, run some hoops to find out whether we're in |
| |
* the correct section or not. |
| |
*/ |
| |
|
| buf_appendb(buf, cp, sz + 1); |
if (n->type == ROFFT_BODY && n->tok == MAN_SH) { |
| } |
body = n; |
| |
if ((head = body->parent->head) != NULL && |
| |
(head = head->child) != NULL && |
| |
head->next == NULL && |
| |
head->type == ROFFT_TEXT && |
| |
strcmp(head->string, "NAME") == 0 && |
| |
body->child != NULL) { |
| |
|
| /* |
/* |
| * Recursively add all text from a given node. |
* Suck the entire NAME section into memory. |
| * This is optimised for general mdoc nodes in this context, which do |
* Yes, we might run away. |
| * not consist of subexpressions and having a recursive call for n->next |
* But too many manuals have big, spread-out |
| * would be wasteful. |
* NAME sections over many lines. |
| * 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 |
|
| buf_appendmdoc(struct buf *buf, const struct mdoc_node *n, int f) |
|
| { |
|
| |
|
| for ( ; n; n = n->next) { |
title = NULL; |
| if (n->child) |
deroff(&title, body); |
| buf_appendmdoc(buf, n->child, f); |
if (NULL == title) |
| |
return; |
| |
|
| if (MDOC_TEXT == n->type && f) { |
/* |
| f = 0; |
* Go through a special heuristic dance here. |
| buf_appendb(buf, n->string, |
* Conventionally, one or more manual names are |
| strlen(n->string) + 1); |
* comma-specified prior to a whitespace, then a |
| } else if (MDOC_TEXT == n->type) |
* dash, then a description. Try to puzzle out |
| buf_append(buf, n->string); |
* the name parts here. |
| |
*/ |
| |
|
| } |
start = title; |
| } |
for ( ;; ) { |
| |
sz = strcspn(start, " ,"); |
| |
if ('\0' == start[sz]) |
| |
break; |
| |
|
| static void |
byte = start[sz]; |
| hash_reset(DB **db) |
start[sz] = '\0'; |
| { |
|
| DB *hash; |
|
| |
|
| if (NULL != (hash = *db)) |
/* |
| (*hash->close)(hash); |
* Assume a stray trailing comma in the |
| |
* name list if a name begins with a dash. |
| |
*/ |
| |
|
| *db = dbopen(NULL, O_CREAT|O_RDWR, 0644, DB_HASH, NULL); |
if ('-' == start[0] || |
| if (NULL == *db) { |
('\\' == start[0] && '-' == start[1])) |
| perror("hash"); |
break; |
| exit((int)MANDOCLEVEL_SYSERR); |
|
| } |
|
| } |
|
| |
|
| /* ARGSUSED */ |
putkey(mpage, start, NAME_TITLE); |
| static int |
if ( ! (mpage->name_head_done || |
| pmdoc_head(MDOC_ARGS) |
strcasecmp(start, meta->title))) { |
| { |
putkey(mpage, start, NAME_HEAD); |
| |
mpage->name_head_done = 1; |
| |
} |
| |
|
| return(MDOC_HEAD == n->type); |
if (' ' == byte) { |
| |
start += sz + 1; |
| |
break; |
| |
} |
| |
|
| |
assert(',' == byte); |
| |
start += sz + 1; |
| |
while (' ' == *start) |
| |
start++; |
| |
} |
| |
|
| |
if (start == title) { |
| |
putkey(mpage, start, NAME_TITLE); |
| |
if ( ! (mpage->name_head_done || |
| |
strcasecmp(start, meta->title))) { |
| |
putkey(mpage, start, NAME_HEAD); |
| |
mpage->name_head_done = 1; |
| |
} |
| |
free(title); |
| |
return; |
| |
} |
| |
|
| |
while (isspace((unsigned char)*start)) |
| |
start++; |
| |
|
| |
if (0 == strncmp(start, "-", 1)) |
| |
start += 1; |
| |
else if (0 == strncmp(start, "\\-\\-", 4)) |
| |
start += 4; |
| |
else if (0 == strncmp(start, "\\-", 2)) |
| |
start += 2; |
| |
else if (0 == strncmp(start, "\\(en", 4)) |
| |
start += 4; |
| |
else if (0 == strncmp(start, "\\(em", 4)) |
| |
start += 4; |
| |
|
| |
while (' ' == *start) |
| |
start++; |
| |
|
| |
mpage->desc = mandoc_strdup(start); |
| |
free(title); |
| |
return; |
| |
} |
| |
} |
| |
|
| |
for (n = n->child; n; n = n->next) { |
| |
if (NULL != mpage->desc) |
| |
break; |
| |
parse_man(mpage, meta, n); |
| |
} |
| } |
} |
| |
|
| /* ARGSUSED */ |
static void |
| static int |
parse_mdoc(struct mpage *mpage, const struct roff_meta *meta, |
| pmdoc_body(MDOC_ARGS) |
const struct roff_node *n) |
| { |
{ |
| |
|
| return(MDOC_BODY == n->type); |
for (n = n->child; n != NULL; n = n->next) { |
| |
if (n->tok == TOKEN_NONE || |
| |
n->tok < ROFF_MAX || |
| |
n->flags & mdocs[n->tok].taboo) |
| |
continue; |
| |
assert(n->tok >= MDOC_Dd && n->tok < MDOC_MAX); |
| |
switch (n->type) { |
| |
case ROFFT_ELEM: |
| |
case ROFFT_BLOCK: |
| |
case ROFFT_HEAD: |
| |
case ROFFT_BODY: |
| |
case ROFFT_TAIL: |
| |
if (mdocs[n->tok].fp != NULL && |
| |
(*mdocs[n->tok].fp)(mpage, meta, n) == 0) |
| |
break; |
| |
if (mdocs[n->tok].mask) |
| |
putmdockey(mpage, n->child, |
| |
mdocs[n->tok].mask, mdocs[n->tok].taboo); |
| |
break; |
| |
default: |
| |
continue; |
| |
} |
| |
if (NULL != n->child) |
| |
parse_mdoc(mpage, meta, n); |
| |
} |
| } |
} |
| |
|
| /* ARGSUSED */ |
|
| static int |
static int |
| pmdoc_Fd(MDOC_ARGS) |
parse_mdoc_Fd(struct mpage *mpage, const struct roff_meta *meta, |
| |
const struct roff_node *n) |
| { |
{ |
| const char *start, *end; |
char *start, *end; |
| size_t sz; |
size_t sz; |
| |
|
| if (SEC_SYNOPSIS != n->sec) |
if (SEC_SYNOPSIS != n->sec || |
| return(0); |
NULL == (n = n->child) || |
| if (NULL == (n = n->child) || MDOC_TEXT != n->type) |
n->type != ROFFT_TEXT) |
| return(0); |
return 0; |
| |
|
| /* |
/* |
| * Only consider those `Fd' macro fields that begin with an |
* Only consider those `Fd' macro fields that begin with an |
| * "inclusion" token (versus, e.g., #define). |
* "inclusion" token (versus, e.g., #define). |
| */ |
*/ |
| |
|
| if (strcmp("#include", n->string)) |
if (strcmp("#include", n->string)) |
| return(0); |
return 0; |
| |
|
| if (NULL == (n = n->next) || MDOC_TEXT != n->type) |
if ((n = n->next) == NULL || n->type != ROFFT_TEXT) |
| return(0); |
return 0; |
| |
|
| /* |
/* |
| * Strip away the enclosing angle brackets and make sure we're |
* Strip away the enclosing angle brackets and make sure we're |
| Line 925 pmdoc_Fd(MDOC_ARGS) |
|
| Line 1603 pmdoc_Fd(MDOC_ARGS) |
|
| start++; |
start++; |
| |
|
| if (0 == (sz = strlen(start))) |
if (0 == (sz = strlen(start))) |
| return(0); |
return 0; |
| |
|
| end = &start[(int)sz - 1]; |
end = &start[(int)sz - 1]; |
| if ('>' == *end || '"' == *end) |
if ('>' == *end || '"' == *end) |
| end--; |
end--; |
| |
|
| assert(end >= start); |
if (end > start) |
| |
putkeys(mpage, start, end - start + 1, TYPE_In); |
| buf_appendb(buf, start, (size_t)(end - start + 1)); |
return 0; |
| buf_appendb(buf, "", 1); |
|
| return(1); |
|
| } |
} |
| |
|
| /* ARGSUSED */ |
static void |
| static int |
parse_mdoc_fname(struct mpage *mpage, const struct roff_node *n) |
| pmdoc_In(MDOC_ARGS) |
|
| { |
{ |
| |
char *cp; |
| |
size_t sz; |
| |
|
| if (NULL == n->child || MDOC_TEXT != n->child->type) |
if (n->type != ROFFT_TEXT) |
| return(0); |
return; |
| |
|
| buf_append(buf, n->child->string); |
/* Skip function pointer punctuation. */ |
| return(1); |
|
| |
cp = n->string; |
| |
while (*cp == '(' || *cp == '*') |
| |
cp++; |
| |
sz = strcspn(cp, "()"); |
| |
|
| |
putkeys(mpage, cp, sz, TYPE_Fn); |
| |
if (n->sec == SEC_SYNOPSIS) |
| |
putkeys(mpage, cp, sz, NAME_SYN); |
| } |
} |
| |
|
| /* ARGSUSED */ |
|
| static int |
static int |
| pmdoc_Fn(MDOC_ARGS) |
parse_mdoc_Fn(struct mpage *mpage, const struct roff_meta *meta, |
| |
const struct roff_node *n) |
| { |
{ |
| struct mdoc_node *nn; |
|
| const char *cp; |
|
| |
|
| nn = n->child; |
if (n->child == NULL) |
| |
return 0; |
| |
|
| if (NULL == nn || MDOC_TEXT != nn->type) |
parse_mdoc_fname(mpage, n->child); |
| return(0); |
|
| |
|
| /* .Fn "struct type *name" "char *arg" */ |
for (n = n->child->next; n != NULL; n = n->next) |
| |
if (n->type == ROFFT_TEXT) |
| |
putkey(mpage, n->string, TYPE_Fa); |
| |
|
| cp = strrchr(nn->string, ' '); |
return 0; |
| if (NULL == cp) |
} |
| cp = nn->string; |
|
| |
|
| /* Strip away pointer symbol. */ |
static int |
| |
parse_mdoc_Fo(struct mpage *mpage, const struct roff_meta *meta, |
| |
const struct roff_node *n) |
| |
{ |
| |
|
| while ('*' == *cp) |
if (n->type != ROFFT_HEAD) |
| cp++; |
return 1; |
| |
|
| /* Store the function name. */ |
if (n->child != NULL) |
| |
parse_mdoc_fname(mpage, n->child); |
| |
|
| buf_append(buf, cp); |
return 0; |
| hash_put(hash, buf, TYPE_Fn); |
} |
| |
|
| /* Store the function type. */ |
static int |
| |
parse_mdoc_Va(struct mpage *mpage, const struct roff_meta *meta, |
| |
const struct roff_node *n) |
| |
{ |
| |
char *cp; |
| |
|
| if (nn->string < cp) { |
if (n->type != ROFFT_ELEM && n->type != ROFFT_BODY) |
| buf->len = 0; |
return 0; |
| buf_appendb(buf, nn->string, cp - nn->string); |
|
| buf_appendb(buf, "", 1); |
|
| hash_put(hash, buf, TYPE_Ft); |
|
| } |
|
| |
|
| /* Store the arguments. */ |
if (n->child != NULL && |
| |
n->child->next == NULL && |
| |
n->child->type == ROFFT_TEXT) |
| |
return 1; |
| |
|
| for (nn = nn->next; nn; nn = nn->next) { |
cp = NULL; |
| if (MDOC_TEXT != nn->type) |
deroff(&cp, n); |
| continue; |
if (cp != NULL) { |
| buf->len = 0; |
putkey(mpage, cp, TYPE_Vt | (n->tok == MDOC_Va || |
| buf_append(buf, nn->string); |
n->type == ROFFT_BODY ? TYPE_Va : 0)); |
| hash_put(hash, buf, TYPE_Fa); |
free(cp); |
| } |
} |
| |
|
| return(0); |
return 0; |
| } |
} |
| |
|
| /* ARGSUSED */ |
|
| static int |
static int |
| pmdoc_St(MDOC_ARGS) |
parse_mdoc_Xr(struct mpage *mpage, const struct roff_meta *meta, |
| |
const struct roff_node *n) |
| { |
{ |
| |
char *cp; |
| |
|
| if (NULL == n->child || MDOC_TEXT != n->child->type) |
if (NULL == (n = n->child)) |
| return(0); |
return 0; |
| |
|
| buf_append(buf, n->child->string); |
if (NULL == n->next) { |
| return(1); |
putkey(mpage, n->string, TYPE_Xr); |
| |
return 0; |
| |
} |
| |
|
| |
mandoc_asprintf(&cp, "%s(%s)", n->string, n->next->string); |
| |
putkey(mpage, cp, TYPE_Xr); |
| |
free(cp); |
| |
return 0; |
| } |
} |
| |
|
| /* ARGSUSED */ |
|
| static int |
static int |
| pmdoc_Xr(MDOC_ARGS) |
parse_mdoc_Nd(struct mpage *mpage, const struct roff_meta *meta, |
| |
const struct roff_node *n) |
| { |
{ |
| |
|
| if (NULL == (n = n->child)) |
if (n->type == ROFFT_BODY) |
| return(0); |
deroff(&mpage->desc, n); |
| |
return 0; |
| buf_appendb(buf, n->string, strlen(n->string)); |
|
| |
|
| if (NULL != (n = n->next)) { |
|
| buf_appendb(buf, ".", 1); |
|
| buf_appendb(buf, n->string, strlen(n->string) + 1); |
|
| } else |
|
| buf_appendb(buf, ".", 2); |
|
| |
|
| return(1); |
|
| } |
} |
| |
|
| /* ARGSUSED */ |
|
| static int |
static int |
| pmdoc_Nd(MDOC_ARGS) |
parse_mdoc_Nm(struct mpage *mpage, const struct roff_meta *meta, |
| |
const struct roff_node *n) |
| { |
{ |
| |
|
| if (MDOC_BODY != n->type) |
if (SEC_NAME == n->sec) |
| return(0); |
putmdockey(mpage, n->child, NAME_TITLE, 0); |
| |
else if (n->sec == SEC_SYNOPSIS && n->type == ROFFT_HEAD) { |
| buf_appendmdoc(dbuf, n->child, 1); |
if (n->child == NULL) |
| return(1); |
putkey(mpage, meta->name, NAME_SYN); |
| |
else |
| |
putmdockey(mpage, n->child, NAME_SYN, 0); |
| |
} |
| |
if ( ! (mpage->name_head_done || |
| |
n->child == NULL || n->child->string == NULL || |
| |
strcasecmp(n->child->string, meta->title))) { |
| |
putkey(mpage, n->child->string, NAME_HEAD); |
| |
mpage->name_head_done = 1; |
| |
} |
| |
return 0; |
| } |
} |
| |
|
| /* ARGSUSED */ |
|
| static int |
static int |
| pmdoc_Nm(MDOC_ARGS) |
parse_mdoc_Sh(struct mpage *mpage, const struct roff_meta *meta, |
| |
const struct roff_node *n) |
| { |
{ |
| |
|
| if (SEC_NAME == n->sec) |
return n->sec == SEC_CUSTOM && n->type == ROFFT_HEAD; |
| return(1); |
|
| else if (SEC_SYNOPSIS != n->sec || MDOC_HEAD != n->type) |
|
| return(0); |
|
| |
|
| if (NULL == n->child) |
|
| buf_append(buf, m->name); |
|
| |
|
| return(1); |
|
| } |
} |
| |
|
| /* ARGSUSED */ |
|
| static int |
static int |
| pmdoc_Sh(MDOC_ARGS) |
parse_mdoc_head(struct mpage *mpage, const struct roff_meta *meta, |
| |
const struct roff_node *n) |
| { |
{ |
| |
|
| return(SEC_CUSTOM == n->sec && MDOC_HEAD == n->type); |
return n->type == ROFFT_HEAD; |
| } |
} |
| |
|
| |
/* |
| |
* Add a string to the hash table for the current manual. |
| |
* Each string has a bitmask telling which macros it belongs to. |
| |
* When we finish the manual, we'll dump the table. |
| |
*/ |
| static void |
static void |
| hash_put(DB *db, const struct buf *buf, uint64_t mask) |
putkeys(const struct mpage *mpage, char *cp, size_t sz, uint64_t v) |
| { |
{ |
| DBT key, val; |
struct ohash *htab; |
| int rc; |
struct str *s; |
| |
const char *end; |
| |
unsigned int slot; |
| |
int i, mustfree; |
| |
|
| if (buf->len < 2) |
if (0 == sz) |
| return; |
return; |
| |
|
| key.data = buf->cp; |
mustfree = render_string(&cp, &sz); |
| key.size = buf->len; |
|
| |
|
| if ((rc = (*db->get)(db, &key, &val, 0)) < 0) { |
if (TYPE_Nm & v) { |
| perror("hash"); |
htab = &names; |
| exit((int)MANDOCLEVEL_SYSERR); |
v &= name_mask; |
| } else if (0 == rc) |
if (v & NAME_FIRST) |
| mask |= *(uint64_t *)val.data; |
name_mask &= ~NAME_FIRST; |
| |
if (debug > 1) |
| |
say(mpage->mlinks->file, |
| |
"Adding name %*s, bits=0x%llx", (int)sz, cp, |
| |
(unsigned long long)v); |
| |
} else { |
| |
htab = &strings; |
| |
if (debug > 1) |
| |
for (i = 0; i < KEY_MAX; i++) |
| |
if ((uint64_t)1 << i & v) |
| |
say(mpage->mlinks->file, |
| |
"Adding key %s=%*s", |
| |
mansearch_keynames[i], (int)sz, cp); |
| |
} |
| |
|
| val.data = &mask; |
end = cp + sz; |
| val.size = sizeof(uint64_t); |
slot = ohash_qlookupi(htab, cp, &end); |
| |
s = ohash_find(htab, slot); |
| |
|
| if ((rc = (*db->put)(db, &key, &val, 0)) < 0) { |
if (NULL != s && mpage == s->mpage) { |
| perror("hash"); |
s->mask |= v; |
| exit((int)MANDOCLEVEL_SYSERR); |
return; |
| } |
} else if (NULL == s) { |
| |
s = mandoc_calloc(1, sizeof(struct str) + sz + 1); |
| |
memcpy(s->key, cp, sz); |
| |
ohash_insert(htab, slot, s); |
| |
} |
| |
s->mpage = mpage; |
| |
s->mask = v; |
| |
|
| |
if (mustfree) |
| |
free(cp); |
| } |
} |
| |
|
| static void |
/* |
| dbt_put(DB *db, const char *dbn, DBT *key, DBT *val) |
* Take a Unicode codepoint and produce its UTF-8 encoding. |
| |
* This isn't the best way to do this, but it works. |
| |
* The magic numbers are from the UTF-8 packaging. |
| |
* They're not as scary as they seem: read the UTF-8 spec for details. |
| |
*/ |
| |
static size_t |
| |
utf8(unsigned int cp, char out[7]) |
| { |
{ |
| |
size_t rc; |
| |
|
| assert(key->size); |
rc = 0; |
| assert(val->size); |
if (cp <= 0x0000007F) { |
| |
rc = 1; |
| |
out[0] = (char)cp; |
| |
} else if (cp <= 0x000007FF) { |
| |
rc = 2; |
| |
out[0] = (cp >> 6 & 31) | 192; |
| |
out[1] = (cp & 63) | 128; |
| |
} else if (cp <= 0x0000FFFF) { |
| |
rc = 3; |
| |
out[0] = (cp >> 12 & 15) | 224; |
| |
out[1] = (cp >> 6 & 63) | 128; |
| |
out[2] = (cp & 63) | 128; |
| |
} else if (cp <= 0x001FFFFF) { |
| |
rc = 4; |
| |
out[0] = (cp >> 18 & 7) | 240; |
| |
out[1] = (cp >> 12 & 63) | 128; |
| |
out[2] = (cp >> 6 & 63) | 128; |
| |
out[3] = (cp & 63) | 128; |
| |
} else if (cp <= 0x03FFFFFF) { |
| |
rc = 5; |
| |
out[0] = (cp >> 24 & 3) | 248; |
| |
out[1] = (cp >> 18 & 63) | 128; |
| |
out[2] = (cp >> 12 & 63) | 128; |
| |
out[3] = (cp >> 6 & 63) | 128; |
| |
out[4] = (cp & 63) | 128; |
| |
} else if (cp <= 0x7FFFFFFF) { |
| |
rc = 6; |
| |
out[0] = (cp >> 30 & 1) | 252; |
| |
out[1] = (cp >> 24 & 63) | 128; |
| |
out[2] = (cp >> 18 & 63) | 128; |
| |
out[3] = (cp >> 12 & 63) | 128; |
| |
out[4] = (cp >> 6 & 63) | 128; |
| |
out[5] = (cp & 63) | 128; |
| |
} else |
| |
return 0; |
| |
|
| if (0 == (*db->put)(db, key, val, 0)) |
out[rc] = '\0'; |
| return; |
return rc; |
| |
|
| perror(dbn); |
|
| exit((int)MANDOCLEVEL_SYSERR); |
|
| /* NOTREACHED */ |
|
| } |
} |
| |
|
| /* |
/* |
| * Call out to per-macro handlers after clearing the persistent database |
* If the string contains escape sequences, |
| * key. If the macro sets the database key, flush it to the database. |
* replace it with an allocated rendering and return 1, |
| |
* such that the caller can free it after use. |
| |
* Otherwise, do nothing and return 0. |
| */ |
*/ |
| static void |
static int |
| pmdoc_node(MDOC_ARGS) |
render_string(char **public, size_t *psz) |
| { |
{ |
| |
const char *src, *scp, *addcp, *seq; |
| |
char *dst; |
| |
size_t ssz, dsz, addsz; |
| |
char utfbuf[7], res[6]; |
| |
int seqlen, unicode; |
| |
|
| if (NULL == n) |
res[0] = '\\'; |
| return; |
res[1] = '\t'; |
| |
res[2] = ASCII_NBRSP; |
| |
res[3] = ASCII_HYPH; |
| |
res[4] = ASCII_BREAK; |
| |
res[5] = '\0'; |
| |
|
| switch (n->type) { |
src = scp = *public; |
| case (MDOC_HEAD): |
ssz = *psz; |
| /* FALLTHROUGH */ |
dst = NULL; |
| case (MDOC_BODY): |
dsz = 0; |
| /* FALLTHROUGH */ |
|
| case (MDOC_TAIL): |
|
| /* FALLTHROUGH */ |
|
| case (MDOC_BLOCK): |
|
| /* FALLTHROUGH */ |
|
| case (MDOC_ELEM): |
|
| buf->len = 0; |
|
| |
|
| |
while (scp < src + *psz) { |
| |
|
| |
/* Leave normal characters unchanged. */ |
| |
|
| |
if (strchr(res, *scp) == NULL) { |
| |
if (dst != NULL) |
| |
dst[dsz++] = *scp; |
| |
scp++; |
| |
continue; |
| |
} |
| |
|
| /* |
/* |
| * Both NULL handlers and handlers returning true |
* Found something that requires replacing, |
| * request using the data. Only skip the element |
* make sure we have a destination buffer. |
| * when the handler returns false. |
|
| */ |
*/ |
| |
|
| if (NULL != mdocs[n->tok].fp && |
if (dst == NULL) { |
| 0 == (*mdocs[n->tok].fp)(hash, buf, dbuf, n, m)) |
dst = mandoc_malloc(ssz + 1); |
| |
dsz = scp - src; |
| |
memcpy(dst, src, dsz); |
| |
} |
| |
|
| |
/* Handle single-char special characters. */ |
| |
|
| |
switch (*scp) { |
| |
case '\\': |
| break; |
break; |
| |
case '\t': |
| |
case ASCII_NBRSP: |
| |
dst[dsz++] = ' '; |
| |
scp++; |
| |
continue; |
| |
case ASCII_HYPH: |
| |
dst[dsz++] = '-'; |
| |
/* FALLTHROUGH */ |
| |
case ASCII_BREAK: |
| |
scp++; |
| |
continue; |
| |
default: |
| |
abort(); |
| |
} |
| |
|
| /* |
/* |
| * For many macros, use the text from all children. |
* Found an escape sequence. |
| * Set zero flags for macros not needing this. |
* Read past the slash, then parse it. |
| * In that case, the handler must fill the buffer. |
* Ignore everything except characters. |
| */ |
*/ |
| |
|
| if (MDOCF_CHILD & mdocs[n->tok].flags) |
scp++; |
| buf_appendmdoc(buf, n->child, 0); |
if (mandoc_escape(&scp, &seq, &seqlen) != ESCAPE_SPECIAL) |
| |
continue; |
| |
|
| /* |
/* |
| * Cover the most common case: |
* Render the special character |
| * Automatically stage one string per element. |
* as either UTF-8 or ASCII. |
| * Set a zero mask for macros not needing this. |
|
| * Additional staging can be done in the handler. |
|
| */ |
*/ |
| |
|
| if (mdocs[n->tok].mask) |
if (write_utf8) { |
| hash_put(hash, buf, mdocs[n->tok].mask); |
unicode = mchars_spec2cp(seq, seqlen); |
| break; |
if (unicode <= 0) |
| default: |
continue; |
| break; |
addsz = utf8(unicode, utfbuf); |
| } |
if (addsz == 0) |
| |
continue; |
| pmdoc_node(hash, buf, dbuf, n->child, m); |
addcp = utfbuf; |
| pmdoc_node(hash, buf, dbuf, n->next, m); |
} else { |
| } |
addcp = mchars_spec2str(seq, seqlen, &addsz); |
| |
if (addcp == NULL) |
| static int |
continue; |
| pman_node(MAN_ARGS) |
if (*addcp == ASCII_NBRSP) { |
| { |
addcp = " "; |
| const struct man_node *head, *body; |
addsz = 1; |
| const char *start, *sv; |
|
| size_t sz; |
|
| |
|
| if (NULL == n) |
|
| return(0); |
|
| |
|
| /* |
|
| * We're only searching for one thing: the first text child in |
|
| * the BODY of a NAME section. Since we don't keep track of |
|
| * sections in -man, run some hoops to find out whether we're in |
|
| * the correct section or not. |
|
| */ |
|
| |
|
| if (MAN_BODY == n->type && MAN_SH == n->tok) { |
|
| body = n; |
|
| assert(body->parent); |
|
| if (NULL != (head = body->parent->head) && |
|
| 1 == head->nchild && |
|
| NULL != (head = (head->child)) && |
|
| MAN_TEXT == head->type && |
|
| 0 == strcmp(head->string, "NAME") && |
|
| NULL != (body = body->child) && |
|
| MAN_TEXT == body->type) { |
|
| |
|
| assert(body->string); |
|
| start = sv = body->string; |
|
| |
|
| /* |
|
| * Go through a special heuristic dance here. |
|
| * This is why -man manuals are great! |
|
| * (I'm being sarcastic: my eyes are bleeding.) |
|
| * Conventionally, one or more manual names are |
|
| * comma-specified prior to a whitespace, then a |
|
| * dash, then a description. Try to puzzle out |
|
| * the name parts here. |
|
| */ |
|
| |
|
| for ( ;; ) { |
|
| sz = strcspn(start, " ,"); |
|
| if ('\0' == start[(int)sz]) |
|
| break; |
|
| |
|
| buf->len = 0; |
|
| buf_appendb(buf, start, sz); |
|
| buf_appendb(buf, "", 1); |
|
| |
|
| hash_put(hash, buf, TYPE_Nm); |
|
| |
|
| if (' ' == start[(int)sz]) { |
|
| start += (int)sz + 1; |
|
| break; |
|
| } |
|
| |
|
| assert(',' == start[(int)sz]); |
|
| start += (int)sz + 1; |
|
| while (' ' == *start) |
|
| start++; |
|
| } |
} |
| |
} |
| |
|
| buf->len = 0; |
/* Copy the rendered glyph into the stream. */ |
| |
|
| if (sv == start) { |
ssz += addsz; |
| buf_append(buf, start); |
dst = mandoc_realloc(dst, ssz + 1); |
| return(1); |
memcpy(dst + dsz, addcp, addsz); |
| } |
dsz += addsz; |
| |
|
| while (' ' == *start) |
|
| start++; |
|
| |
|
| if (0 == strncmp(start, "-", 1)) |
|
| start += 1; |
|
| else if (0 == strncmp(start, "\\-", 2)) |
|
| start += 2; |
|
| else if (0 == strncmp(start, "\\(en", 4)) |
|
| start += 4; |
|
| else if (0 == strncmp(start, "\\(em", 4)) |
|
| start += 4; |
|
| |
|
| while (' ' == *start) |
|
| start++; |
|
| |
|
| sz = strlen(start) + 1; |
|
| buf_appendb(dbuf, start, sz); |
|
| buf_appendb(buf, start, sz); |
|
| |
|
| hash_put(hash, buf, TYPE_Nd); |
|
| } |
|
| } |
} |
| |
if (dst != NULL) { |
| |
*public = dst; |
| |
*psz = dsz; |
| |
} |
| |
|
| for (n = n->child; n; n = n->next) |
/* Trim trailing whitespace and NUL-terminate. */ |
| if (pman_node(hash, buf, dbuf, n)) |
|
| return(1); |
|
| |
|
| return(0); |
while (*psz > 0 && (*public)[*psz - 1] == ' ') |
| |
--*psz; |
| |
if (dst != NULL) { |
| |
(*public)[*psz] = '\0'; |
| |
return 1; |
| |
} else |
| |
return 0; |
| } |
} |
| |
|
| |
static void |
| |
dbadd_mlink(const struct mlink *mlink) |
| |
{ |
| |
dba_page_alias(mlink->mpage->dba, mlink->name, NAME_FILE); |
| |
dba_page_add(mlink->mpage->dba, DBP_SECT, mlink->dsec); |
| |
dba_page_add(mlink->mpage->dba, DBP_SECT, mlink->fsec); |
| |
dba_page_add(mlink->mpage->dba, DBP_ARCH, mlink->arch); |
| |
dba_page_add(mlink->mpage->dba, DBP_FILE, mlink->file); |
| |
} |
| |
|
| /* |
/* |
| * Parse a formatted manual page. |
* Flush the current page's terms (and their bits) into the database. |
| * By necessity, this involves rather crude guesswork. |
* Also, handle escape sequences at the last possible moment. |
| */ |
*/ |
| static void |
static void |
| pformatted(DB *hash, struct buf *buf, struct buf *dbuf, |
dbadd(struct dba *dba, struct mpage *mpage) |
| const struct of *of) |
|
| { |
{ |
| FILE *stream; |
struct mlink *mlink; |
| char *line, *p; |
struct str *key; |
| size_t len, plen; |
char *cp; |
| |
uint64_t mask; |
| |
size_t i; |
| |
unsigned int slot; |
| |
int mustfree; |
| |
|
| if (NULL == (stream = fopen(of->fname, "r"))) { |
mlink = mpage->mlinks; |
| perror(of->fname); |
|
| return; |
|
| } |
|
| |
|
| /* |
if (nodb) { |
| * Always use the title derived from the filename up front, |
for (key = ohash_first(&names, &slot); NULL != key; |
| * do not even try to find it in the file. This also makes |
key = ohash_next(&names, &slot)) |
| * sure we don't end up with an orphan index record, even if |
free(key); |
| * the file content turns out to be completely unintelligible. |
for (key = ohash_first(&strings, &slot); NULL != key; |
| */ |
key = ohash_next(&strings, &slot)) |
| |
free(key); |
| buf->len = 0; |
if (0 == debug) |
| buf_append(buf, of->title); |
return; |
| hash_put(hash, buf, TYPE_Nm); |
while (NULL != mlink) { |
| |
fputs(mlink->name, stdout); |
| /* Skip to first blank line. */ |
if (NULL == mlink->next || |
| |
strcmp(mlink->dsec, mlink->next->dsec) || |
| while (NULL != (line = fgetln(stream, &len))) |
strcmp(mlink->fsec, mlink->next->fsec) || |
| if ('\n' == *line) |
strcmp(mlink->arch, mlink->next->arch)) { |
| break; |
putchar('('); |
| |
if ('\0' == *mlink->dsec) |
| /* |
fputs(mlink->fsec, stdout); |
| * Assume the first line that is not indented |
else |
| * is the first section header. Skip to it. |
fputs(mlink->dsec, stdout); |
| */ |
if ('\0' != *mlink->arch) |
| |
printf("/%s", mlink->arch); |
| while (NULL != (line = fgetln(stream, &len))) |
putchar(')'); |
| if ('\n' != *line && ' ' != *line) |
} |
| break; |
mlink = mlink->next; |
| |
if (NULL != mlink) |
| /* |
fputs(", ", stdout); |
| * If no page content can be found, or the input line |
} |
| * is already the next section header, or there is no |
printf(" - %s\n", mpage->desc); |
| * trailing newline, reuse the page title as the page |
|
| * description. |
|
| */ |
|
| |
|
| line = fgetln(stream, &len); |
|
| if (NULL == line || ' ' != *line || '\n' != line[(int)len - 1]) { |
|
| buf_appendb(dbuf, buf->cp, buf->size); |
|
| hash_put(hash, buf, TYPE_Nd); |
|
| fclose(stream); |
|
| return; |
return; |
| } |
} |
| |
|
| line[(int)--len] = '\0'; |
if (debug) |
| |
say(mlink->file, "Adding to database"); |
| |
|
| /* |
cp = mpage->desc; |
| * Skip to the first dash. |
i = strlen(cp); |
| * Use the remaining line as the description (no more than 70 |
mustfree = render_string(&cp, &i); |
| * bytes). |
mpage->dba = dba_page_new(dba->pages, |
| */ |
*mpage->arch == '\0' ? mlink->arch : mpage->arch, |
| |
cp, mlink->file, mpage->form); |
| |
if (mustfree) |
| |
free(cp); |
| |
dba_page_add(mpage->dba, DBP_SECT, mpage->sec); |
| |
|
| if (NULL != (p = strstr(line, "- "))) { |
while (mlink != NULL) { |
| for (p += 2; ' ' == *p || '\b' == *p; p++) |
dbadd_mlink(mlink); |
| /* Skip to next word. */ ; |
mlink = mlink->next; |
| } else |
|
| p = line; |
|
| |
|
| if ((plen = strlen(p)) > 70) { |
|
| plen = 70; |
|
| p[plen] = '\0'; |
|
| } |
} |
| |
|
| /* Strip backspace-encoding from line. */ |
for (key = ohash_first(&names, &slot); NULL != key; |
| |
key = ohash_next(&names, &slot)) { |
| while (NULL != (line = memchr(p, '\b', plen))) { |
assert(key->mpage == mpage); |
| len = line - p; |
dba_page_alias(mpage->dba, key->key, key->mask); |
| if (0 == len) { |
free(key); |
| memmove(line, line + 1, plen--); |
|
| continue; |
|
| } |
|
| memmove(line - 1, line + 1, plen - len); |
|
| plen -= 2; |
|
| } |
} |
| |
for (key = ohash_first(&strings, &slot); NULL != key; |
| buf_appendb(dbuf, p, plen + 1); |
key = ohash_next(&strings, &slot)) { |
| buf->len = 0; |
assert(key->mpage == mpage); |
| buf_appendb(buf, p, plen + 1); |
i = 0; |
| hash_put(hash, buf, TYPE_Nd); |
for (mask = TYPE_Xr; mask <= TYPE_Lb; mask *= 2) { |
| fclose(stream); |
if (key->mask & mask) |
| |
dba_macro_add(dba->macros, i, |
| |
key->key, mpage->dba); |
| |
i++; |
| |
} |
| |
free(key); |
| |
} |
| } |
} |
| |
|
| static void |
static void |
| ofile_argbuild(int argc, char *argv[], struct of **of) |
dbprune(struct dba *dba) |
| { |
{ |
| char buf[MAXPATHLEN]; |
struct dba_array *page, *files; |
| char *sec, *arch, *title, *p; |
char *file; |
| int i, src_form; |
|
| struct of *nof; |
|
| |
|
| for (i = 0; i < argc; i++) { |
dba_array_FOREACH(dba->pages, page) { |
| |
files = dba_array_get(page, DBP_FILE); |
| /* |
dba_array_FOREACH(files, file) { |
| * Try to infer the manual section, architecture and |
if (*file < ' ') |
| * page title from the path, assuming it looks like |
file++; |
| * man*[/<arch>]/<title>.<section> or |
if (ohash_find(&mlinks, ohash_qlookup(&mlinks, |
| * cat<section>[/<arch>]/<title>.0 |
file)) != NULL) { |
| */ |
if (debug) |
| |
say(file, "Deleting from database"); |
| if (strlcpy(buf, argv[i], sizeof(buf)) >= sizeof(buf)) { |
dba_array_del(dba->pages); |
| fprintf(stderr, "%s: Path too long\n", argv[i]); |
break; |
| continue; |
|
| } |
|
| sec = arch = title = NULL; |
|
| src_form = 0; |
|
| p = strrchr(buf, '\0'); |
|
| while (p-- > buf) { |
|
| if (NULL == sec && '.' == *p) { |
|
| sec = p + 1; |
|
| *p = '\0'; |
|
| if ('0' == *sec) |
|
| src_form |= MANDOC_FORM; |
|
| else if ('1' <= *sec && '9' >= *sec) |
|
| src_form |= MANDOC_SRC; |
|
| continue; |
|
| } |
} |
| if ('/' != *p) |
|
| continue; |
|
| if (NULL == title) { |
|
| title = p + 1; |
|
| *p = '\0'; |
|
| continue; |
|
| } |
|
| if (0 == strncmp("man", p + 1, 3)) |
|
| src_form |= MANDOC_SRC; |
|
| else if (0 == strncmp("cat", p + 1, 3)) |
|
| src_form |= MANDOC_FORM; |
|
| else |
|
| arch = p + 1; |
|
| break; |
|
| } |
} |
| if (NULL == title) |
|
| title = buf; |
|
| |
|
| /* |
|
| * Build the file structure. |
|
| */ |
|
| |
|
| nof = mandoc_calloc(1, sizeof(struct of)); |
|
| nof->fname = mandoc_strdup(argv[i]); |
|
| if (NULL != sec) |
|
| nof->sec = mandoc_strdup(sec); |
|
| if (NULL != arch) |
|
| nof->arch = mandoc_strdup(arch); |
|
| nof->title = mandoc_strdup(title); |
|
| nof->src_form = src_form; |
|
| |
|
| /* |
|
| * Add the structure to the list. |
|
| */ |
|
| |
|
| if (verb > 2) |
|
| printf("%s: Scheduling\n", argv[i]); |
|
| if (NULL == *of) { |
|
| *of = nof; |
|
| (*of)->first = nof; |
|
| } else { |
|
| nof->first = (*of)->first; |
|
| (*of)->next = nof; |
|
| *of = nof; |
|
| } |
|
| } |
} |
| } |
} |
| |
|
| /* |
/* |
| * Recursively build up a list of files to parse. |
* Write the database from memory to disk. |
| * We use this instead of ftw() and so on because I don't want global |
|
| * variables hanging around. |
|
| * This ignores the mandoc.db and mandoc.index files, but assumes that |
|
| * everything else is a manual. |
|
| * Pass in a pointer to a NULL structure for the first invocation. |
|
| */ |
*/ |
| static int |
static void |
| ofile_dirbuild(const char *dir, const char* psec, const char *parch, |
dbwrite(struct dba *dba) |
| int p_src_form, struct of **of) |
|
| { |
{ |
| char buf[MAXPATHLEN]; |
char tfn[32]; |
| struct stat sb; |
int status; |
| size_t sz; |
pid_t child; |
| DIR *d; |
|
| const char *fn, *sec, *arch; |
|
| char *p, *q, *suffix; |
|
| struct of *nof; |
|
| struct dirent *dp; |
|
| int src_form; |
|
| |
|
| if (NULL == (d = opendir(dir))) { |
if (dba_write(MANDOC_DB "~", dba) != -1) { |
| perror(dir); |
if (rename(MANDOC_DB "~", MANDOC_DB) == -1) { |
| return(0); |
exitcode = (int)MANDOCLEVEL_SYSERR; |
| |
say(MANDOC_DB, "&rename"); |
| |
unlink(MANDOC_DB "~"); |
| |
} |
| |
return; |
| } |
} |
| |
|
| while (NULL != (dp = readdir(d))) { |
(void)strlcpy(tfn, "/tmp/mandocdb.XXXXXXXX", sizeof(tfn)); |
| fn = dp->d_name; |
if (mkdtemp(tfn) == NULL) { |
| |
exitcode = (int)MANDOCLEVEL_SYSERR; |
| |
say("", "&%s", tfn); |
| |
return; |
| |
} |
| |
|
| if ('.' == *fn) |
(void)strlcat(tfn, "/" MANDOC_DB, sizeof(tfn)); |
| continue; |
if (dba_write(tfn, dba) == -1) { |
| |
exitcode = (int)MANDOCLEVEL_SYSERR; |
| |
say(tfn, "&dba_write"); |
| |
goto out; |
| |
} |
| |
|
| src_form = p_src_form; |
switch (child = fork()) { |
| |
case -1: |
| |
exitcode = (int)MANDOCLEVEL_SYSERR; |
| |
say("", "&fork cmp"); |
| |
return; |
| |
case 0: |
| |
execlp("cmp", "cmp", "-s", tfn, MANDOC_DB, (char *)NULL); |
| |
say("", "&exec cmp"); |
| |
exit(0); |
| |
default: |
| |
break; |
| |
} |
| |
if (waitpid(child, &status, 0) == -1) { |
| |
exitcode = (int)MANDOCLEVEL_SYSERR; |
| |
say("", "&wait cmp"); |
| |
} else if (WIFSIGNALED(status)) { |
| |
exitcode = (int)MANDOCLEVEL_SYSERR; |
| |
say("", "cmp died from signal %d", WTERMSIG(status)); |
| |
} else if (WEXITSTATUS(status)) { |
| |
exitcode = (int)MANDOCLEVEL_SYSERR; |
| |
say(MANDOC_DB, |
| |
"Data changed, but cannot replace database"); |
| |
} |
| |
|
| if (DT_DIR == dp->d_type) { |
out: |
| sec = psec; |
*strrchr(tfn, '/') = '\0'; |
| arch = parch; |
switch (child = fork()) { |
| |
case -1: |
| |
exitcode = (int)MANDOCLEVEL_SYSERR; |
| |
say("", "&fork rm"); |
| |
return; |
| |
case 0: |
| |
execlp("rm", "rm", "-rf", tfn, (char *)NULL); |
| |
say("", "&exec rm"); |
| |
exit((int)MANDOCLEVEL_SYSERR); |
| |
default: |
| |
break; |
| |
} |
| |
if (waitpid(child, &status, 0) == -1) { |
| |
exitcode = (int)MANDOCLEVEL_SYSERR; |
| |
say("", "&wait rm"); |
| |
} else if (WIFSIGNALED(status) || WEXITSTATUS(status)) { |
| |
exitcode = (int)MANDOCLEVEL_SYSERR; |
| |
say("", "%s: Cannot remove temporary directory", tfn); |
| |
} |
| |
} |
| |
|
| /* |
static int |
| * By default, only use directories called: |
set_basedir(const char *targetdir, int report_baddir) |
| * man<section>/[<arch>/] or |
{ |
| * cat<section>/[<arch>/] |
static char startdir[PATH_MAX]; |
| */ |
static int getcwd_status; /* 1 = ok, 2 = failure */ |
| |
static int chdir_status; /* 1 = changed directory */ |
| |
char *cp; |
| |
|
| if (NULL == sec) { |
/* |
| if(0 == strncmp("man", fn, 3)) { |
* Remember the original working directory, if possible. |
| src_form |= MANDOC_SRC; |
* This will be needed if the second or a later directory |
| sec = fn + 3; |
* on the command line is given as a relative path. |
| } else if (0 == strncmp("cat", fn, 3)) { |
* Do not error out if the current directory is not |
| src_form |= MANDOC_FORM; |
* searchable: Maybe it won't be needed after all. |
| sec = fn + 3; |
*/ |
| } else if (use_all) |
if (0 == getcwd_status) { |
| sec = fn; |
if (NULL == getcwd(startdir, sizeof(startdir))) { |
| else |
getcwd_status = 2; |
| continue; |
(void)strlcpy(startdir, strerror(errno), |
| } else if (NULL == arch && (use_all || |
sizeof(startdir)); |
| NULL == strchr(fn, '.'))) |
} else |
| arch = fn; |
getcwd_status = 1; |
| else if (0 == use_all) |
} |
| continue; |
|
| |
|
| buf[0] = '\0'; |
/* |
| strlcat(buf, dir, MAXPATHLEN); |
* We are leaving the old base directory. |
| strlcat(buf, "/", MAXPATHLEN); |
* Do not use it any longer, not even for messages. |
| sz = strlcat(buf, fn, MAXPATHLEN); |
*/ |
| |
*basedir = '\0'; |
| |
|
| if (MAXPATHLEN <= sz) { |
/* |
| fprintf(stderr, "%s: Path too long\n", dir); |
* If and only if the directory was changed earlier and |
| return(0); |
* the next directory to process is given as a relative path, |
| } |
* first go back, or bail out if that is impossible. |
| |
*/ |
| if (verb > 2) |
if (chdir_status && '/' != *targetdir) { |
| printf("%s: Scanning\n", buf); |
if (2 == getcwd_status) { |
| |
exitcode = (int)MANDOCLEVEL_SYSERR; |
| if ( ! ofile_dirbuild(buf, sec, arch, |
say("", "getcwd: %s", startdir); |
| src_form, of)) |
return 0; |
| return(0); |
|
| } |
} |
| if (DT_REG != dp->d_type || |
if (-1 == chdir(startdir)) { |
| (NULL == psec && !use_all) || |
exitcode = (int)MANDOCLEVEL_SYSERR; |
| !strcmp(MANDOC_DB, fn) || |
say("", "&chdir %s", startdir); |
| !strcmp(MANDOC_IDX, fn)) |
return 0; |
| continue; |
|
| |
|
| /* |
|
| * By default, skip files where the file name suffix |
|
| * does not agree with the section directory |
|
| * they are located in. |
|
| */ |
|
| |
|
| suffix = strrchr(fn, '.'); |
|
| if (0 == use_all) { |
|
| if (NULL == suffix) |
|
| continue; |
|
| if ((MANDOC_SRC & src_form && |
|
| strcmp(suffix + 1, psec)) || |
|
| (MANDOC_FORM & src_form && |
|
| strcmp(suffix + 1, "0"))) |
|
| continue; |
|
| } |
} |
| if (NULL != suffix) { |
} |
| if ('0' == suffix[1]) |
|
| src_form |= MANDOC_FORM; |
|
| else if ('1' <= suffix[1] && '9' >= suffix[1]) |
|
| src_form |= MANDOC_SRC; |
|
| } |
|
| |
|
| |
/* |
| /* |
* Always resolve basedir to the canonicalized absolute |
| * Skip formatted manuals if a source version is |
* pathname and append a trailing slash, such that |
| * available. Ignore the age: it is very unlikely |
* we can reliably check whether files are inside. |
| * that people install newer formatted base manuals |
*/ |
| * when they used to have source manuals before, |
if (NULL == realpath(targetdir, basedir)) { |
| * and in ports, old manuals get removed on update. |
if (report_baddir || errno != ENOENT) { |
| */ |
exitcode = (int)MANDOCLEVEL_BADARG; |
| if (0 == use_all && MANDOC_FORM & src_form && |
say("", "&%s: realpath", targetdir); |
| NULL != psec) { |
|
| buf[0] = '\0'; |
|
| strlcat(buf, dir, MAXPATHLEN); |
|
| p = strrchr(buf, '/'); |
|
| if (NULL != parch && NULL != p) |
|
| for (p--; p > buf; p--) |
|
| if ('/' == *p) |
|
| break; |
|
| if (NULL == p) |
|
| p = buf; |
|
| else |
|
| p++; |
|
| if (0 == strncmp("cat", p, 3)) |
|
| memcpy(p, "man", 3); |
|
| strlcat(buf, "/", MAXPATHLEN); |
|
| sz = strlcat(buf, fn, MAXPATHLEN); |
|
| if (sz >= MAXPATHLEN) { |
|
| fprintf(stderr, "%s: Path too long\n", buf); |
|
| continue; |
|
| } |
|
| q = strrchr(buf, '.'); |
|
| if (NULL != q && p < q++) { |
|
| *q = '\0'; |
|
| sz = strlcat(buf, psec, MAXPATHLEN); |
|
| if (sz >= MAXPATHLEN) { |
|
| fprintf(stderr, |
|
| "%s: Path too long\n", buf); |
|
| continue; |
|
| } |
|
| if (0 == stat(buf, &sb)) |
|
| continue; |
|
| } |
|
| } |
} |
| |
return 0; |
| buf[0] = '\0'; |
} else if (-1 == chdir(basedir)) { |
| strlcat(buf, dir, MAXPATHLEN); |
if (report_baddir || errno != ENOENT) { |
| strlcat(buf, "/", MAXPATHLEN); |
exitcode = (int)MANDOCLEVEL_BADARG; |
| sz = strlcat(buf, fn, MAXPATHLEN); |
say("", "&chdir"); |
| if (sz >= MAXPATHLEN) { |
|
| fprintf(stderr, "%s: Path too long\n", dir); |
|
| continue; |
|
| } |
} |
| |
return 0; |
| nof = mandoc_calloc(1, sizeof(struct of)); |
} |
| nof->fname = mandoc_strdup(buf); |
chdir_status = 1; |
| if (NULL != psec) |
cp = strchr(basedir, '\0'); |
| nof->sec = mandoc_strdup(psec); |
if ('/' != cp[-1]) { |
| if (NULL != parch) |
if (cp - basedir >= PATH_MAX - 1) { |
| nof->arch = mandoc_strdup(parch); |
exitcode = (int)MANDOCLEVEL_SYSERR; |
| nof->src_form = src_form; |
say("", "Filename too long"); |
| |
return 0; |
| /* |
|
| * Remember the file name without the extension, |
|
| * to be used as the page title in the database. |
|
| */ |
|
| |
|
| if (NULL != suffix) |
|
| *suffix = '\0'; |
|
| nof->title = mandoc_strdup(fn); |
|
| |
|
| /* |
|
| * Add the structure to the list. |
|
| */ |
|
| |
|
| if (verb > 2) |
|
| printf("%s: Scheduling\n", buf); |
|
| if (NULL == *of) { |
|
| *of = nof; |
|
| (*of)->first = nof; |
|
| } else { |
|
| nof->first = (*of)->first; |
|
| (*of)->next = nof; |
|
| *of = nof; |
|
| } |
} |
| |
*cp++ = '/'; |
| |
*cp = '\0'; |
| } |
} |
| |
return 1; |
| closedir(d); |
|
| return(1); |
|
| } |
} |
| |
|
| static void |
static void |
| ofile_free(struct of *of) |
say(const char *file, const char *format, ...) |
| { |
{ |
| struct of *nof; |
va_list ap; |
| |
int use_errno; |
| |
|
| while (of) { |
if ('\0' != *basedir) |
| nof = of->next; |
fprintf(stderr, "%s", basedir); |
| free(of->fname); |
if ('\0' != *basedir && '\0' != *file) |
| free(of->sec); |
fputc('/', stderr); |
| free(of->arch); |
if ('\0' != *file) |
| free(of->title); |
fprintf(stderr, "%s", file); |
| free(of); |
|
| of = nof; |
|
| } |
|
| } |
|
| |
|
| static void |
use_errno = 1; |
| usage(void) |
if (NULL != format) { |
| { |
switch (*format) { |
| |
case '&': |
| fprintf(stderr, "usage: %s [-v] " |
format++; |
| "[-C file] |" |
break; |
| " dir ... |" |
case '\0': |
| " -d dir [file ...] |" |
format = NULL; |
| " -u dir [file ...]\n", progname); |
break; |
| |
default: |
| |
use_errno = 0; |
| |
break; |
| |
} |
| |
} |
| |
if (NULL != format) { |
| |
if ('\0' != *basedir || '\0' != *file) |
| |
fputs(": ", stderr); |
| |
va_start(ap, format); |
| |
vfprintf(stderr, format, ap); |
| |
va_end(ap); |
| |
} |
| |
if (use_errno) { |
| |
if ('\0' != *basedir || '\0' != *file || NULL != format) |
| |
fputs(": ", stderr); |
| |
perror(NULL); |
| |
} else |
| |
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