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

Annotation of mandoc/mandocdb.c, Revision 1.247

1.247   ! schwarze    1: /*     $Id: mandocdb.c,v 1.246 2017/04/24 23:06:18 schwarze Exp $ */
1.1       kristaps    2: /*
1.48      schwarze    3:  * Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
1.235     schwarze    4:  * Copyright (c) 2011-2017 Ingo Schwarze <schwarze@openbsd.org>
1.231     schwarze    5:  * Copyright (c) 2016 Ed Maste <emaste@freebsd.org>
1.1       kristaps    6:  *
                      7:  * Permission to use, copy, modify, and distribute this software for any
                      8:  * purpose with or without fee is hereby granted, provided that the above
                      9:  * copyright notice and this permission notice appear in all copies.
                     10:  *
1.187     schwarze   11:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.1       kristaps   12:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.187     schwarze   13:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.1       kristaps   14:  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     15:  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     16:  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     17:  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
                     18:  */
                     19: #include "config.h"
                     20:
1.162     schwarze   21: #include <sys/types.h>
1.50      kristaps   22: #include <sys/stat.h>
1.115     schwarze   23: #include <sys/wait.h>
1.1       kristaps   24:
                     25: #include <assert.h>
1.43      kristaps   26: #include <ctype.h>
1.208     schwarze   27: #if HAVE_ERR
1.198     schwarze   28: #include <err.h>
1.208     schwarze   29: #endif
1.63      schwarze   30: #include <errno.h>
1.1       kristaps   31: #include <fcntl.h>
1.158     schwarze   32: #if HAVE_FTS
1.50      kristaps   33: #include <fts.h>
1.157     schwarze   34: #else
                     35: #include "compat_fts.h"
                     36: #endif
1.58      schwarze   37: #include <limits.h>
1.218     kristaps   38: #if HAVE_SANDBOX_INIT
                     39: #include <sandbox.h>
                     40: #endif
1.221     schwarze   41: #include <stdarg.h>
1.50      kristaps   42: #include <stddef.h>
1.59      schwarze   43: #include <stdio.h>
1.1       kristaps   44: #include <stdint.h>
                     45: #include <stdlib.h>
                     46: #include <string.h>
1.17      schwarze   47: #include <unistd.h>
1.1       kristaps   48:
1.188     schwarze   49: #include "mandoc_aux.h"
1.202     schwarze   50: #include "mandoc_ohash.h"
1.188     schwarze   51: #include "mandoc.h"
                     52: #include "roff.h"
1.50      kristaps   53: #include "mdoc.h"
1.1       kristaps   54: #include "man.h"
1.187     schwarze   55: #include "manconf.h"
1.55      kristaps   56: #include "mansearch.h"
1.221     schwarze   57: #include "dba_array.h"
                     58: #include "dba.h"
1.1       kristaps   59:
1.111     schwarze   60: extern const char *const mansearch_keynames[];
                     61:
1.50      kristaps   62: enum   op {
                     63:        OP_DEFAULT = 0, /* new dbs from dir list or default config */
                     64:        OP_CONFFILE, /* new databases from custom config file */
                     65:        OP_UPDATE, /* delete/add entries in existing database */
                     66:        OP_DELETE, /* delete entries from existing database */
                     67:        OP_TEST /* change no databases, report potential problems */
1.38      schwarze   68: };
                     69:
1.50      kristaps   70: struct str {
1.78      schwarze   71:        const struct mpage *mpage; /* if set, the owning parse */
1.50      kristaps   72:        uint64_t         mask; /* bitmask in sequence */
1.176     schwarze   73:        char             key[]; /* rendered text */
1.38      schwarze   74: };
                     75:
1.79      schwarze   76: struct inodev {
                     77:        ino_t            st_ino;
                     78:        dev_t            st_dev;
1.50      kristaps   79: };
1.5       kristaps   80:
1.78      schwarze   81: struct mpage {
1.79      schwarze   82:        struct inodev    inodev;  /* used for hashing routine */
1.221     schwarze   83:        struct dba_array *dba;
1.82      schwarze   84:        char            *sec;     /* section from file content */
                     85:        char            *arch;    /* architecture from file content */
                     86:        char            *title;   /* title from file content */
                     87:        char            *desc;    /* description from file content */
1.231     schwarze   88:        struct mpage    *next;    /* singly linked list */
1.82      schwarze   89:        struct mlink    *mlinks;  /* singly linked list */
1.174     schwarze   90:        int              name_head_done;
1.221     schwarze   91:        enum form        form;    /* format from file content */
1.82      schwarze   92: };
                     93:
                     94: struct mlink {
1.58      schwarze   95:        char             file[PATH_MAX]; /* filename rel. to manpath */
1.82      schwarze   96:        char            *dsec;    /* section from directory */
                     97:        char            *arch;    /* architecture from directory */
                     98:        char            *name;    /* name from file name (not empty) */
                     99:        char            *fsec;    /* section from file name suffix */
1.85      schwarze  100:        struct mlink    *next;    /* singly linked list */
1.118     schwarze  101:        struct mpage    *mpage;   /* parent */
1.124     schwarze  102:        int              gzip;    /* filename has a .gz suffix */
1.221     schwarze  103:        enum form        dform;   /* format from directory */
                    104:        enum form        fform;   /* format from file name suffix */
1.1       kristaps  105: };
                    106:
1.190     schwarze  107: typedef        int (*mdoc_fp)(struct mpage *, const struct roff_meta *,
1.189     schwarze  108:                        const struct roff_node *);
1.1       kristaps  109:
1.50      kristaps  110: struct mdoc_handler {
                    111:        mdoc_fp          fp; /* optional handler */
                    112:        uint64_t         mask;  /* set unless handler returns 0 */
1.235     schwarze  113:        int              taboo;  /* node flags that must not be set */
1.1       kristaps  114: };
1.219     schwarze  115:
                    116:
                    117: int             mandocdb(int, char *[]);
1.1       kristaps  118:
1.221     schwarze  119: static void     dbadd(struct dba *, struct mpage *);
1.118     schwarze  120: static void     dbadd_mlink(const struct mlink *mlink);
1.221     schwarze  121: static void     dbprune(struct dba *);
                    122: static void     dbwrite(struct dba *);
1.59      schwarze  123: static void     filescan(const char *);
1.232     schwarze  124: #if HAVE_FTS_COMPARE_CONST
                    125: static int      fts_compare(const FTSENT *const *, const FTSENT *const *);
                    126: #else
1.231     schwarze  127: static int      fts_compare(const FTSENT **, const FTSENT **);
1.232     schwarze  128: #endif
1.84      schwarze  129: static void     mlink_add(struct mlink *, const struct stat *);
1.131     schwarze  130: static void     mlink_check(struct mpage *, struct mlink *);
1.82      schwarze  131: static void     mlink_free(struct mlink *);
1.89      schwarze  132: static void     mlinks_undupe(struct mpage *);
1.78      schwarze  133: static void     mpages_free(void);
1.221     schwarze  134: static void     mpages_merge(struct dba *, struct mparse *);
1.124     schwarze  135: static void     parse_cat(struct mpage *, int);
1.190     schwarze  136: static void     parse_man(struct mpage *, const struct roff_meta *,
1.189     schwarze  137:                        const struct roff_node *);
1.190     schwarze  138: static void     parse_mdoc(struct mpage *, const struct roff_meta *,
1.189     schwarze  139:                        const struct roff_node *);
1.190     schwarze  140: static int      parse_mdoc_head(struct mpage *, const struct roff_meta *,
1.189     schwarze  141:                        const struct roff_node *);
1.190     schwarze  142: static int      parse_mdoc_Fd(struct mpage *, const struct roff_meta *,
1.189     schwarze  143:                        const struct roff_node *);
                    144: static void     parse_mdoc_fname(struct mpage *, const struct roff_node *);
1.190     schwarze  145: static int      parse_mdoc_Fn(struct mpage *, const struct roff_meta *,
1.189     schwarze  146:                        const struct roff_node *);
1.190     schwarze  147: static int      parse_mdoc_Fo(struct mpage *, const struct roff_meta *,
1.189     schwarze  148:                        const struct roff_node *);
1.190     schwarze  149: static int      parse_mdoc_Nd(struct mpage *, const struct roff_meta *,
1.189     schwarze  150:                        const struct roff_node *);
1.190     schwarze  151: static int      parse_mdoc_Nm(struct mpage *, const struct roff_meta *,
1.189     schwarze  152:                        const struct roff_node *);
1.190     schwarze  153: static int      parse_mdoc_Sh(struct mpage *, const struct roff_meta *,
1.189     schwarze  154:                        const struct roff_node *);
1.211     schwarze  155: static int      parse_mdoc_Va(struct mpage *, const struct roff_meta *,
                    156:                        const struct roff_node *);
1.190     schwarze  157: static int      parse_mdoc_Xr(struct mpage *, const struct roff_meta *,
1.189     schwarze  158:                        const struct roff_node *);
1.112     schwarze  159: static void     putkey(const struct mpage *, char *, uint64_t);
1.176     schwarze  160: static void     putkeys(const struct mpage *, char *, size_t, uint64_t);
1.78      schwarze  161: static void     putmdockey(const struct mpage *,
1.235     schwarze  162:                        const struct roff_node *, uint64_t, int);
1.176     schwarze  163: static int      render_string(char **, size_t *);
1.220     schwarze  164: static void     say(const char *, const char *, ...)
1.243     schwarze  165:                        __attribute__((__format__ (__printf__, 2, 3)));
1.165     schwarze  166: static int      set_basedir(const char *, int);
1.59      schwarze  167: static int      treescan(void);
1.50      kristaps  168: static size_t   utf8(unsigned int, char [7]);
                    169:
1.102     schwarze  170: static int              nodb; /* no database changes */
1.116     schwarze  171: static int              mparse_options; /* abort the parse early */
1.141     schwarze  172: static int              use_all; /* use all found files */
                    173: static int              debug; /* print what we're doing */
                    174: static int              warnings; /* warn about crap */
1.95      schwarze  175: static int              write_utf8; /* write UTF-8 output; else ASCII */
1.59      schwarze  176: static int              exitcode; /* to be returned by main */
1.141     schwarze  177: static enum op          op; /* operational mode */
1.59      schwarze  178: static char             basedir[PATH_MAX]; /* current base directory */
1.231     schwarze  179: static struct mpage    *mpage_head; /* list of distinct manual pages */
1.78      schwarze  180: static struct ohash     mpages; /* table of distinct manual pages */
1.83      schwarze  181: static struct ohash     mlinks; /* table of directory entries */
1.133     schwarze  182: static struct ohash     names; /* table of all names */
1.50      kristaps  183: static struct ohash     strings; /* table of all strings */
1.133     schwarze  184: static uint64_t         name_mask;
1.25      schwarze  185:
1.246     schwarze  186: static const struct mdoc_handler __mdocs[MDOC_MAX - MDOC_Dd] = {
1.235     schwarze  187:        { NULL, 0, NODE_NOPRT },  /* Dd */
                    188:        { NULL, 0, NODE_NOPRT },  /* Dt */
                    189:        { NULL, 0, NODE_NOPRT },  /* Os */
                    190:        { parse_mdoc_Sh, TYPE_Sh, 0 }, /* Sh */
                    191:        { parse_mdoc_head, TYPE_Ss, 0 }, /* Ss */
                    192:        { NULL, 0, 0 },  /* Pp */
                    193:        { NULL, 0, 0 },  /* D1 */
                    194:        { NULL, 0, 0 },  /* Dl */
                    195:        { NULL, 0, 0 },  /* Bd */
                    196:        { NULL, 0, 0 },  /* Ed */
                    197:        { NULL, 0, 0 },  /* Bl */
                    198:        { NULL, 0, 0 },  /* El */
                    199:        { NULL, 0, 0 },  /* It */
                    200:        { NULL, 0, 0 },  /* Ad */
                    201:        { NULL, TYPE_An, 0 },  /* An */
1.246     schwarze  202:        { NULL, 0, 0 },  /* Ap */
1.235     schwarze  203:        { NULL, TYPE_Ar, 0 },  /* Ar */
                    204:        { NULL, TYPE_Cd, 0 },  /* Cd */
                    205:        { NULL, TYPE_Cm, 0 },  /* Cm */
                    206:        { NULL, TYPE_Dv, 0 },  /* Dv */
                    207:        { NULL, TYPE_Er, 0 },  /* Er */
                    208:        { NULL, TYPE_Ev, 0 },  /* Ev */
                    209:        { NULL, 0, 0 },  /* Ex */
                    210:        { NULL, TYPE_Fa, 0 },  /* Fa */
                    211:        { parse_mdoc_Fd, 0, 0 },  /* Fd */
                    212:        { NULL, TYPE_Fl, 0 },  /* Fl */
                    213:        { parse_mdoc_Fn, 0, 0 },  /* Fn */
                    214:        { NULL, TYPE_Ft, 0 },  /* Ft */
                    215:        { NULL, TYPE_Ic, 0 },  /* Ic */
                    216:        { NULL, TYPE_In, 0 },  /* In */
                    217:        { NULL, TYPE_Li, 0 },  /* Li */
                    218:        { parse_mdoc_Nd, 0, 0 },  /* Nd */
                    219:        { parse_mdoc_Nm, 0, 0 },  /* Nm */
                    220:        { NULL, 0, 0 },  /* Op */
                    221:        { NULL, 0, 0 },  /* Ot */
                    222:        { NULL, TYPE_Pa, NODE_NOSRC },  /* Pa */
                    223:        { NULL, 0, 0 },  /* Rv */
                    224:        { NULL, TYPE_St, 0 },  /* St */
                    225:        { parse_mdoc_Va, TYPE_Va, 0 },  /* Va */
                    226:        { parse_mdoc_Va, TYPE_Vt, 0 },  /* Vt */
                    227:        { parse_mdoc_Xr, 0, 0 },  /* Xr */
                    228:        { NULL, 0, 0 },  /* %A */
                    229:        { NULL, 0, 0 },  /* %B */
                    230:        { NULL, 0, 0 },  /* %D */
                    231:        { NULL, 0, 0 },  /* %I */
                    232:        { NULL, 0, 0 },  /* %J */
                    233:        { NULL, 0, 0 },  /* %N */
                    234:        { NULL, 0, 0 },  /* %O */
                    235:        { NULL, 0, 0 },  /* %P */
                    236:        { NULL, 0, 0 },  /* %R */
                    237:        { NULL, 0, 0 },  /* %T */
                    238:        { NULL, 0, 0 },  /* %V */
                    239:        { NULL, 0, 0 },  /* Ac */
                    240:        { NULL, 0, 0 },  /* Ao */
                    241:        { NULL, 0, 0 },  /* Aq */
1.237     schwarze  242:        { NULL, TYPE_At, 0 },  /* At */
1.235     schwarze  243:        { NULL, 0, 0 },  /* Bc */
                    244:        { NULL, 0, 0 },  /* Bf */
                    245:        { NULL, 0, 0 },  /* Bo */
                    246:        { NULL, 0, 0 },  /* Bq */
                    247:        { NULL, TYPE_Bsx, NODE_NOSRC },  /* Bsx */
1.236     schwarze  248:        { NULL, TYPE_Bx, NODE_NOSRC },  /* Bx */
1.235     schwarze  249:        { NULL, 0, 0 },  /* Db */
                    250:        { NULL, 0, 0 },  /* Dc */
                    251:        { NULL, 0, 0 },  /* Do */
                    252:        { NULL, 0, 0 },  /* Dq */
                    253:        { NULL, 0, 0 },  /* Ec */
                    254:        { NULL, 0, 0 },  /* Ef */
                    255:        { NULL, TYPE_Em, 0 },  /* Em */
                    256:        { NULL, 0, 0 },  /* Eo */
                    257:        { NULL, TYPE_Fx, NODE_NOSRC },  /* Fx */
                    258:        { NULL, TYPE_Ms, 0 },  /* Ms */
                    259:        { NULL, 0, 0 },  /* No */
                    260:        { NULL, 0, 0 },  /* Ns */
                    261:        { NULL, TYPE_Nx, NODE_NOSRC },  /* Nx */
                    262:        { NULL, TYPE_Ox, NODE_NOSRC },  /* Ox */
                    263:        { NULL, 0, 0 },  /* Pc */
                    264:        { NULL, 0, 0 },  /* Pf */
                    265:        { NULL, 0, 0 },  /* Po */
                    266:        { NULL, 0, 0 },  /* Pq */
                    267:        { NULL, 0, 0 },  /* Qc */
                    268:        { NULL, 0, 0 },  /* Ql */
                    269:        { NULL, 0, 0 },  /* Qo */
                    270:        { NULL, 0, 0 },  /* Qq */
                    271:        { NULL, 0, 0 },  /* Re */
                    272:        { NULL, 0, 0 },  /* Rs */
                    273:        { NULL, 0, 0 },  /* Sc */
                    274:        { NULL, 0, 0 },  /* So */
                    275:        { NULL, 0, 0 },  /* Sq */
                    276:        { NULL, 0, 0 },  /* Sm */
                    277:        { NULL, 0, 0 },  /* Sx */
                    278:        { NULL, TYPE_Sy, 0 },  /* Sy */
                    279:        { NULL, TYPE_Tn, 0 },  /* Tn */
                    280:        { NULL, 0, NODE_NOSRC },  /* Ux */
                    281:        { NULL, 0, 0 },  /* Xc */
                    282:        { NULL, 0, 0 },  /* Xo */
                    283:        { parse_mdoc_Fo, 0, 0 },  /* Fo */
                    284:        { NULL, 0, 0 },  /* Fc */
                    285:        { NULL, 0, 0 },  /* Oo */
                    286:        { NULL, 0, 0 },  /* Oc */
                    287:        { NULL, 0, 0 },  /* Bk */
                    288:        { NULL, 0, 0 },  /* Ek */
                    289:        { NULL, 0, 0 },  /* Bt */
                    290:        { NULL, 0, 0 },  /* Hf */
                    291:        { NULL, 0, 0 },  /* Fr */
                    292:        { NULL, 0, 0 },  /* Ud */
1.237     schwarze  293:        { NULL, TYPE_Lb, NODE_NOSRC },  /* Lb */
1.235     schwarze  294:        { NULL, 0, 0 },  /* Lp */
                    295:        { NULL, TYPE_Lk, 0 },  /* Lk */
                    296:        { NULL, TYPE_Mt, NODE_NOSRC },  /* Mt */
                    297:        { NULL, 0, 0 },  /* Brq */
                    298:        { NULL, 0, 0 },  /* Bro */
                    299:        { NULL, 0, 0 },  /* Brc */
                    300:        { NULL, 0, 0 },  /* %C */
                    301:        { NULL, 0, 0 },  /* Es */
                    302:        { NULL, 0, 0 },  /* En */
                    303:        { NULL, TYPE_Dx, NODE_NOSRC },  /* Dx */
                    304:        { NULL, 0, 0 },  /* %Q */
                    305:        { NULL, 0, 0 },  /* sp */
                    306:        { NULL, 0, 0 },  /* %U */
                    307:        { NULL, 0, 0 },  /* Ta */
                    308:        { NULL, 0, 0 },  /* ll */
1.1       kristaps  309: };
1.246     schwarze  310: static const struct mdoc_handler *const mdocs = __mdocs - MDOC_Dd;
1.1       kristaps  311:
1.141     schwarze  312:
1.1       kristaps  313: int
1.179     schwarze  314: mandocdb(int argc, char *argv[])
1.1       kristaps  315: {
1.187     schwarze  316:        struct manconf    conf;
                    317:        struct mparse    *mp;
1.221     schwarze  318:        struct dba       *dba;
1.206     schwarze  319:        const char       *path_arg, *progname;
1.187     schwarze  320:        size_t            j, sz;
1.59      schwarze  321:        int               ch, i;
1.50      kristaps  322:
1.207     schwarze  323: #if HAVE_PLEDGE
                    324:        if (pledge("stdio rpath wpath cpath fattr flock proc exec", NULL) == -1) {
1.214     schwarze  325:                warn("pledge");
1.218     kristaps  326:                return (int)MANDOCLEVEL_SYSERR;
                    327:        }
                    328: #endif
                    329:
                    330: #if HAVE_SANDBOX_INIT
                    331:        if (sandbox_init(kSBXProfileNoInternet, SANDBOX_NAMED, NULL) == -1) {
                    332:                warnx("sandbox_init");
1.207     schwarze  333:                return (int)MANDOCLEVEL_SYSERR;
                    334:        }
                    335: #endif
                    336:
1.187     schwarze  337:        memset(&conf, 0, sizeof(conf));
1.50      kristaps  338:
                    339:        /*
1.141     schwarze  340:         * We accept a few different invocations.
1.50      kristaps  341:         * The CHECKOP macro makes sure that invocation styles don't
                    342:         * clobber each other.
                    343:         */
                    344: #define        CHECKOP(_op, _ch) do \
                    345:        if (OP_DEFAULT != (_op)) { \
1.198     schwarze  346:                warnx("-%c: Conflicting option", (_ch)); \
1.50      kristaps  347:                goto usage; \
                    348:        } while (/*CONSTCOND*/0)
1.10      kristaps  349:
1.59      schwarze  350:        path_arg = NULL;
1.38      schwarze  351:        op = OP_DEFAULT;
1.1       kristaps  352:
1.126     schwarze  353:        while (-1 != (ch = getopt(argc, argv, "aC:Dd:npQT:tu:v")))
1.1       kristaps  354:                switch (ch) {
1.141     schwarze  355:                case 'a':
1.12      schwarze  356:                        use_all = 1;
                    357:                        break;
1.141     schwarze  358:                case 'C':
1.50      kristaps  359:                        CHECKOP(op, ch);
1.59      schwarze  360:                        path_arg = optarg;
1.38      schwarze  361:                        op = OP_CONFFILE;
1.34      schwarze  362:                        break;
1.141     schwarze  363:                case 'D':
1.125     schwarze  364:                        debug++;
                    365:                        break;
1.141     schwarze  366:                case 'd':
1.50      kristaps  367:                        CHECKOP(op, ch);
1.59      schwarze  368:                        path_arg = optarg;
1.5       kristaps  369:                        op = OP_UPDATE;
                    370:                        break;
1.141     schwarze  371:                case 'n':
1.50      kristaps  372:                        nodb = 1;
                    373:                        break;
1.141     schwarze  374:                case 'p':
1.126     schwarze  375:                        warnings = 1;
                    376:                        break;
1.141     schwarze  377:                case 'Q':
1.116     schwarze  378:                        mparse_options |= MPARSE_QUICK;
1.102     schwarze  379:                        break;
1.141     schwarze  380:                case 'T':
1.95      schwarze  381:                        if (strcmp(optarg, "utf8")) {
1.198     schwarze  382:                                warnx("-T%s: Unsupported output format",
                    383:                                    optarg);
1.95      schwarze  384:                                goto usage;
                    385:                        }
                    386:                        write_utf8 = 1;
                    387:                        break;
1.141     schwarze  388:                case 't':
1.50      kristaps  389:                        CHECKOP(op, ch);
1.38      schwarze  390:                        dup2(STDOUT_FILENO, STDERR_FILENO);
                    391:                        op = OP_TEST;
1.50      kristaps  392:                        nodb = warnings = 1;
1.38      schwarze  393:                        break;
1.141     schwarze  394:                case 'u':
1.50      kristaps  395:                        CHECKOP(op, ch);
1.59      schwarze  396:                        path_arg = optarg;
1.5       kristaps  397:                        op = OP_DELETE;
                    398:                        break;
1.141     schwarze  399:                case 'v':
1.126     schwarze  400:                        /* Compatibility with espie@'s makewhatis. */
1.38      schwarze  401:                        break;
1.1       kristaps  402:                default:
1.38      schwarze  403:                        goto usage;
1.1       kristaps  404:                }
                    405:
                    406:        argc -= optind;
                    407:        argv += optind;
                    408:
1.207     schwarze  409: #if HAVE_PLEDGE
1.210     schwarze  410:        if (nodb) {
                    411:                if (pledge("stdio rpath", NULL) == -1) {
1.214     schwarze  412:                        warn("pledge");
1.210     schwarze  413:                        return (int)MANDOCLEVEL_SYSERR;
                    414:                }
1.207     schwarze  415:        }
                    416: #endif
                    417:
1.38      schwarze  418:        if (OP_CONFFILE == op && argc > 0) {
1.198     schwarze  419:                warnx("-C: Too many arguments");
1.38      schwarze  420:                goto usage;
                    421:        }
                    422:
1.59      schwarze  423:        exitcode = (int)MANDOCLEVEL_OK;
1.203     schwarze  424:        mchars_alloc();
                    425:        mp = mparse_alloc(mparse_options, MANDOCLEVEL_BADARG, NULL, NULL);
1.202     schwarze  426:        mandoc_ohash_init(&mpages, 6, offsetof(struct mpage, inodev));
                    427:        mandoc_ohash_init(&mlinks, 6, offsetof(struct mlink, file));
1.50      kristaps  428:
                    429:        if (OP_UPDATE == op || OP_DELETE == op || OP_TEST == op) {
1.59      schwarze  430:
1.50      kristaps  431:                /*
1.150     schwarze  432:                 * Most of these deal with a specific directory.
1.140     schwarze  433:                 * Jump into that directory first.
1.50      kristaps  434:                 */
1.165     schwarze  435:                if (OP_TEST != op && 0 == set_basedir(path_arg, 1))
1.50      kristaps  436:                        goto out;
1.140     schwarze  437:
1.225     schwarze  438:                dba = nodb ? dba_new(128) : dba_read(MANDOC_DB);
                    439:                if (dba != NULL) {
1.140     schwarze  440:                        /*
                    441:                         * The existing database is usable.  Process
                    442:                         * all files specified on the command-line.
                    443:                         */
1.207     schwarze  444: #if HAVE_PLEDGE
1.210     schwarze  445:                        if (!nodb) {
                    446:                                if (pledge("stdio rpath wpath cpath fattr flock", NULL) == -1) {
1.214     schwarze  447:                                        warn("pledge");
1.210     schwarze  448:                                        exitcode = (int)MANDOCLEVEL_SYSERR;
                    449:                                        goto out;
                    450:                                }
1.207     schwarze  451:                        }
                    452: #endif
1.140     schwarze  453:                        use_all = 1;
1.138     schwarze  454:                        for (i = 0; i < argc; i++)
                    455:                                filescan(argv[i]);
1.225     schwarze  456:                        if (nodb == 0)
1.221     schwarze  457:                                dbprune(dba);
1.138     schwarze  458:                } else {
1.228     schwarze  459:                        /* Database missing or corrupt. */
1.230     schwarze  460:                        if (op != OP_UPDATE || errno != ENOENT)
                    461:                                say(MANDOC_DB, "%s: Automatically recreating"
                    462:                                    " from scratch", strerror(errno));
1.140     schwarze  463:                        exitcode = (int)MANDOCLEVEL_OK;
1.138     schwarze  464:                        op = OP_DEFAULT;
                    465:                        if (0 == treescan())
                    466:                                goto out;
1.221     schwarze  467:                        dba = dba_new(128);
1.138     schwarze  468:                }
1.50      kristaps  469:                if (OP_DELETE != op)
1.221     schwarze  470:                        mpages_merge(dba, mp);
                    471:                if (nodb == 0)
                    472:                        dbwrite(dba);
                    473:                dba_free(dba);
1.50      kristaps  474:        } else {
                    475:                /*
                    476:                 * If we have arguments, use them as our manpaths.
1.222     schwarze  477:                 * If we don't, use man.conf(5).
1.50      kristaps  478:                 */
                    479:                if (argc > 0) {
1.187     schwarze  480:                        conf.manpath.paths = mandoc_reallocarray(NULL,
1.144     schwarze  481:                            argc, sizeof(char *));
1.187     schwarze  482:                        conf.manpath.sz = (size_t)argc;
1.50      kristaps  483:                        for (i = 0; i < argc; i++)
1.187     schwarze  484:                                conf.manpath.paths[i] = mandoc_strdup(argv[i]);
1.50      kristaps  485:                } else
1.187     schwarze  486:                        manconf_parse(&conf, path_arg, NULL, NULL);
1.127     schwarze  487:
1.187     schwarze  488:                if (conf.manpath.sz == 0) {
1.127     schwarze  489:                        exitcode = (int)MANDOCLEVEL_BADARG;
                    490:                        say("", "Empty manpath");
                    491:                }
1.50      kristaps  492:
                    493:                /*
1.69      schwarze  494:                 * First scan the tree rooted at a base directory, then
                    495:                 * build a new database and finally move it into place.
1.50      kristaps  496:                 * Ignore zero-length directories and strip trailing
                    497:                 * slashes.
                    498:                 */
1.187     schwarze  499:                for (j = 0; j < conf.manpath.sz; j++) {
                    500:                        sz = strlen(conf.manpath.paths[j]);
                    501:                        if (sz && conf.manpath.paths[j][sz - 1] == '/')
                    502:                                conf.manpath.paths[j][--sz] = '\0';
1.50      kristaps  503:                        if (0 == sz)
                    504:                                continue;
1.66      schwarze  505:
                    506:                        if (j) {
1.202     schwarze  507:                                mandoc_ohash_init(&mpages, 6,
                    508:                                    offsetof(struct mpage, inodev));
                    509:                                mandoc_ohash_init(&mlinks, 6,
                    510:                                    offsetof(struct mlink, file));
1.66      schwarze  511:                        }
                    512:
1.187     schwarze  513:                        if ( ! set_basedir(conf.manpath.paths[j], argc > 0))
1.165     schwarze  514:                                continue;
1.59      schwarze  515:                        if (0 == treescan())
1.165     schwarze  516:                                continue;
1.221     schwarze  517:                        dba = dba_new(128);
                    518:                        mpages_merge(dba, mp);
                    519:                        if (nodb == 0)
                    520:                                dbwrite(dba);
                    521:                        dba_free(dba);
1.66      schwarze  522:
1.187     schwarze  523:                        if (j + 1 < conf.manpath.sz) {
1.80      schwarze  524:                                mpages_free();
1.78      schwarze  525:                                ohash_delete(&mpages);
1.83      schwarze  526:                                ohash_delete(&mlinks);
1.66      schwarze  527:                        }
1.50      kristaps  528:                }
                    529:        }
                    530: out:
1.187     schwarze  531:        manconf_free(&conf);
1.168     schwarze  532:        mparse_free(mp);
1.203     schwarze  533:        mchars_free();
1.80      schwarze  534:        mpages_free();
1.78      schwarze  535:        ohash_delete(&mpages);
1.83      schwarze  536:        ohash_delete(&mlinks);
1.197     schwarze  537:        return exitcode;
1.50      kristaps  538: usage:
1.206     schwarze  539:        progname = getprogname();
1.126     schwarze  540:        fprintf(stderr, "usage: %s [-aDnpQ] [-C file] [-Tutf8]\n"
                    541:                        "       %s [-aDnpQ] [-Tutf8] dir ...\n"
                    542:                        "       %s [-DnpQ] [-Tutf8] -d dir [file ...]\n"
                    543:                        "       %s [-Dnp] -u dir [file ...]\n"
1.102     schwarze  544:                        "       %s [-Q] -t file ...\n",
1.206     schwarze  545:                        progname, progname, progname, progname, progname);
1.50      kristaps  546:
1.197     schwarze  547:        return (int)MANDOCLEVEL_BADARG;
1.50      kristaps  548: }
                    549:
                    550: /*
1.231     schwarze  551:  * To get a singly linked list in alpha order while inserting entries
                    552:  * at the beginning, process directory entries in reverse alpha order.
                    553:  */
                    554: static int
1.232     schwarze  555: #if HAVE_FTS_COMPARE_CONST
                    556: fts_compare(const FTSENT *const *a, const FTSENT *const *b)
                    557: #else
1.231     schwarze  558: fts_compare(const FTSENT **a, const FTSENT **b)
1.232     schwarze  559: #endif
1.231     schwarze  560: {
                    561:        return -strcmp((*a)->fts_name, (*b)->fts_name);
                    562: }
                    563:
                    564: /*
1.59      schwarze  565:  * Scan a directory tree rooted at "basedir" for manpages.
1.50      kristaps  566:  * We use fts(), scanning directory parts along the way for clues to our
                    567:  * section and architecture.
                    568:  *
                    569:  * If use_all has been specified, grok all files.
                    570:  * If not, sanitise paths to the following:
                    571:  *
1.141     schwarze  572:  *   [./]man*[/<arch>]/<name>.<section>
1.50      kristaps  573:  *   or
                    574:  *   [./]cat<section>[/<arch>]/<name>.0
                    575:  *
1.216     schwarze  576:  * TODO: accommodate for multi-language directories.
1.50      kristaps  577:  */
                    578: static int
1.59      schwarze  579: treescan(void)
1.50      kristaps  580: {
1.139     schwarze  581:        char             buf[PATH_MAX];
1.50      kristaps  582:        FTS             *f;
                    583:        FTSENT          *ff;
1.84      schwarze  584:        struct mlink    *mlink;
1.221     schwarze  585:        int              gzip;
                    586:        enum form        dform;
1.94      schwarze  587:        char            *dsec, *arch, *fsec, *cp;
                    588:        const char      *path;
1.50      kristaps  589:        const char      *argv[2];
                    590:
                    591:        argv[0] = ".";
1.244     schwarze  592:        argv[1] = NULL;
1.50      kristaps  593:
1.231     schwarze  594:        f = fts_open((char * const *)argv, FTS_PHYSICAL | FTS_NOCHDIR,
                    595:            fts_compare);
1.200     schwarze  596:        if (f == NULL) {
1.59      schwarze  597:                exitcode = (int)MANDOCLEVEL_SYSERR;
1.123     schwarze  598:                say("", "&fts_open");
1.197     schwarze  599:                return 0;
1.50      kristaps  600:        }
                    601:
                    602:        dsec = arch = NULL;
                    603:        dform = FORM_NONE;
                    604:
1.200     schwarze  605:        while ((ff = fts_read(f)) != NULL) {
1.50      kristaps  606:                path = ff->fts_path + 2;
1.139     schwarze  607:                switch (ff->fts_info) {
                    608:
                    609:                /*
                    610:                 * Symbolic links require various sanity checks,
                    611:                 * then get handled just like regular files.
                    612:                 */
1.141     schwarze  613:                case FTS_SL:
1.200     schwarze  614:                        if (realpath(path, buf) == NULL) {
1.139     schwarze  615:                                if (warnings)
                    616:                                        say(path, "&realpath");
                    617:                                continue;
                    618:                        }
1.184     schwarze  619:                        if (strstr(buf, basedir) != buf
                    620: #ifdef HOMEBREWDIR
                    621:                            && strstr(buf, HOMEBREWDIR) != buf
                    622: #endif
                    623:                        ) {
1.139     schwarze  624:                                if (warnings) say("",
                    625:                                    "%s: outside base directory", buf);
                    626:                                continue;
                    627:                        }
                    628:                        /* Use logical inode to avoid mpages dupe. */
1.200     schwarze  629:                        if (stat(path, ff->fts_statp) == -1) {
1.139     schwarze  630:                                if (warnings)
                    631:                                        say(path, "&stat");
                    632:                                continue;
                    633:                        }
                    634:                        /* FALLTHROUGH */
                    635:
1.50      kristaps  636:                /*
1.83      schwarze  637:                 * If we're a regular file, add an mlink by using the
1.50      kristaps  638:                 * stored directory data and handling the filename.
                    639:                 */
1.141     schwarze  640:                case FTS_F:
1.200     schwarze  641:                        if ( ! strcmp(path, MANDOC_DB))
1.60      schwarze  642:                                continue;
1.50      kristaps  643:                        if ( ! use_all && ff->fts_level < 2) {
1.56      schwarze  644:                                if (warnings)
1.59      schwarze  645:                                        say(path, "Extraneous file");
1.50      kristaps  646:                                continue;
1.124     schwarze  647:                        }
                    648:                        gzip = 0;
                    649:                        fsec = NULL;
1.200     schwarze  650:                        while (fsec == NULL) {
1.124     schwarze  651:                                fsec = strrchr(ff->fts_name, '.');
1.200     schwarze  652:                                if (fsec == NULL || strcmp(fsec+1, "gz"))
1.124     schwarze  653:                                        break;
                    654:                                gzip = 1;
                    655:                                *fsec = '\0';
                    656:                                fsec = NULL;
                    657:                        }
1.200     schwarze  658:                        if (fsec == NULL) {
1.60      schwarze  659:                                if ( ! use_all) {
1.56      schwarze  660:                                        if (warnings)
1.60      schwarze  661:                                                say(path,
                    662:                                                    "No filename suffix");
1.50      kristaps  663:                                        continue;
                    664:                                }
1.200     schwarze  665:                        } else if ( ! strcmp(++fsec, "html")) {
1.60      schwarze  666:                                if (warnings)
                    667:                                        say(path, "Skip html");
                    668:                                continue;
1.200     schwarze  669:                        } else if ( ! strcmp(fsec, "ps")) {
1.60      schwarze  670:                                if (warnings)
                    671:                                        say(path, "Skip ps");
                    672:                                continue;
1.200     schwarze  673:                        } else if ( ! strcmp(fsec, "pdf")) {
1.60      schwarze  674:                                if (warnings)
                    675:                                        say(path, "Skip pdf");
                    676:                                continue;
                    677:                        } else if ( ! use_all &&
1.200     schwarze  678:                            ((dform == FORM_SRC &&
1.185     schwarze  679:                              strncmp(fsec, dsec, strlen(dsec))) ||
1.200     schwarze  680:                             (dform == FORM_CAT && strcmp(fsec, "0")))) {
1.60      schwarze  681:                                if (warnings)
                    682:                                        say(path, "Wrong filename suffix");
                    683:                                continue;
1.66      schwarze  684:                        } else
1.84      schwarze  685:                                fsec[-1] = '\0';
1.94      schwarze  686:
1.84      schwarze  687:                        mlink = mandoc_calloc(1, sizeof(struct mlink));
1.143     schwarze  688:                        if (strlcpy(mlink->file, path,
                    689:                            sizeof(mlink->file)) >=
                    690:                            sizeof(mlink->file)) {
                    691:                                say(path, "Filename too long");
                    692:                                free(mlink);
                    693:                                continue;
                    694:                        }
1.84      schwarze  695:                        mlink->dform = dform;
1.94      schwarze  696:                        mlink->dsec = dsec;
                    697:                        mlink->arch = arch;
                    698:                        mlink->name = ff->fts_name;
                    699:                        mlink->fsec = fsec;
1.124     schwarze  700:                        mlink->gzip = gzip;
1.84      schwarze  701:                        mlink_add(mlink, ff->fts_statp);
1.50      kristaps  702:                        continue;
1.139     schwarze  703:
1.141     schwarze  704:                case FTS_D:
                    705:                case FTS_DP:
1.139     schwarze  706:                        break;
                    707:
                    708:                default:
1.60      schwarze  709:                        if (warnings)
                    710:                                say(path, "Not a regular file");
1.50      kristaps  711:                        continue;
1.60      schwarze  712:                }
1.1       kristaps  713:
1.50      kristaps  714:                switch (ff->fts_level) {
1.141     schwarze  715:                case 0:
1.50      kristaps  716:                        /* Ignore the root directory. */
                    717:                        break;
1.141     schwarze  718:                case 1:
1.50      kristaps  719:                        /*
                    720:                         * This might contain manX/ or catX/.
                    721:                         * Try to infer this from the name.
                    722:                         * If we're not in use_all, enforce it.
                    723:                         */
                    724:                        cp = ff->fts_name;
1.200     schwarze  725:                        if (ff->fts_info == FTS_DP) {
                    726:                                dform = FORM_NONE;
                    727:                                dsec = NULL;
1.50      kristaps  728:                                break;
1.200     schwarze  729:                        }
1.1       kristaps  730:
1.200     schwarze  731:                        if ( ! strncmp(cp, "man", 3)) {
1.50      kristaps  732:                                dform = FORM_SRC;
1.66      schwarze  733:                                dsec = cp + 3;
1.200     schwarze  734:                        } else if ( ! strncmp(cp, "cat", 3)) {
1.50      kristaps  735:                                dform = FORM_CAT;
1.66      schwarze  736:                                dsec = cp + 3;
1.94      schwarze  737:                        } else {
                    738:                                dform = FORM_NONE;
                    739:                                dsec = NULL;
1.50      kristaps  740:                        }
1.1       kristaps  741:
1.200     schwarze  742:                        if (dsec != NULL || use_all)
1.50      kristaps  743:                                break;
1.1       kristaps  744:
1.56      schwarze  745:                        if (warnings)
1.59      schwarze  746:                                say(path, "Unknown directory part");
1.50      kristaps  747:                        fts_set(f, ff, FTS_SKIP);
                    748:                        break;
1.141     schwarze  749:                case 2:
1.50      kristaps  750:                        /*
                    751:                         * Possibly our architecture.
                    752:                         * If we're descending, keep tabs on it.
                    753:                         */
1.200     schwarze  754:                        if (ff->fts_info != FTS_DP && dsec != NULL)
1.66      schwarze  755:                                arch = ff->fts_name;
1.94      schwarze  756:                        else
                    757:                                arch = NULL;
1.50      kristaps  758:                        break;
                    759:                default:
1.200     schwarze  760:                        if (ff->fts_info == FTS_DP || use_all)
1.50      kristaps  761:                                break;
1.56      schwarze  762:                        if (warnings)
1.59      schwarze  763:                                say(path, "Extraneous directory part");
1.50      kristaps  764:                        fts_set(f, ff, FTS_SKIP);
                    765:                        break;
1.5       kristaps  766:                }
1.50      kristaps  767:        }
                    768:
                    769:        fts_close(f);
1.197     schwarze  770:        return 1;
1.50      kristaps  771: }
1.5       kristaps  772:
1.50      kristaps  773: /*
1.89      schwarze  774:  * Add a file to the mlinks table.
1.50      kristaps  775:  * Do not verify that it's a "valid" looking manpage (we'll do that
                    776:  * later).
                    777:  *
                    778:  * Try to infer the manual section, architecture, and page name from the
                    779:  * path, assuming it looks like
                    780:  *
1.141     schwarze  781:  *   [./]man*[/<arch>]/<name>.<section>
1.50      kristaps  782:  *   or
                    783:  *   [./]cat<section>[/<arch>]/<name>.0
                    784:  *
                    785:  * See treescan() for the fts(3) version of this.
                    786:  */
                    787: static void
1.59      schwarze  788: filescan(const char *file)
1.50      kristaps  789: {
1.59      schwarze  790:        char             buf[PATH_MAX];
1.84      schwarze  791:        struct stat      st;
                    792:        struct mlink    *mlink;
1.59      schwarze  793:        char            *p, *start;
1.5       kristaps  794:
1.50      kristaps  795:        assert(use_all);
1.5       kristaps  796:
1.50      kristaps  797:        if (0 == strncmp(file, "./", 2))
                    798:                file += 2;
1.5       kristaps  799:
1.139     schwarze  800:        /*
                    801:         * We have to do lstat(2) before realpath(3) loses
                    802:         * the information whether this is a symbolic link.
                    803:         * We need to know that because for symbolic links,
                    804:         * we want to use the orginal file name, while for
                    805:         * regular files, we want to use the real path.
                    806:         */
                    807:        if (-1 == lstat(file, &st)) {
                    808:                exitcode = (int)MANDOCLEVEL_BADARG;
                    809:                say(file, "&lstat");
                    810:                return;
                    811:        } else if (0 == ((S_IFREG | S_IFLNK) & st.st_mode)) {
                    812:                exitcode = (int)MANDOCLEVEL_BADARG;
                    813:                say(file, "Not a regular file");
                    814:                return;
                    815:        }
                    816:
                    817:        /*
                    818:         * We have to resolve the file name to the real path
                    819:         * in any case for the base directory check.
                    820:         */
1.59      schwarze  821:        if (NULL == realpath(file, buf)) {
                    822:                exitcode = (int)MANDOCLEVEL_BADARG;
1.123     schwarze  823:                say(file, "&realpath");
1.59      schwarze  824:                return;
1.106     schwarze  825:        }
                    826:
1.150     schwarze  827:        if (OP_TEST == op)
1.106     schwarze  828:                start = buf;
1.150     schwarze  829:        else if (strstr(buf, basedir) == buf)
                    830:                start = buf + strlen(basedir);
1.184     schwarze  831: #ifdef HOMEBREWDIR
                    832:        else if (strstr(buf, HOMEBREWDIR) == buf)
                    833:                start = buf;
                    834: #endif
1.106     schwarze  835:        else {
1.59      schwarze  836:                exitcode = (int)MANDOCLEVEL_BADARG;
                    837:                say("", "%s: outside base directory", buf);
                    838:                return;
1.106     schwarze  839:        }
                    840:
1.139     schwarze  841:        /*
                    842:         * Now we are sure the file is inside our tree.
                    843:         * If it is a symbolic link, ignore the real path
                    844:         * and use the original name.
                    845:         * This implies passing stuff like "cat1/../man1/foo.1"
                    846:         * on the command line won't work.  So don't do that.
                    847:         * Note the stat(2) can still fail if the link target
                    848:         * doesn't exist.
                    849:         */
                    850:        if (S_IFLNK & st.st_mode) {
                    851:                if (-1 == stat(buf, &st)) {
                    852:                        exitcode = (int)MANDOCLEVEL_BADARG;
                    853:                        say(file, "&stat");
                    854:                        return;
                    855:                }
1.143     schwarze  856:                if (strlcpy(buf, file, sizeof(buf)) >= sizeof(buf)) {
                    857:                        say(file, "Filename too long");
                    858:                        return;
                    859:                }
1.150     schwarze  860:                start = buf;
                    861:                if (OP_TEST != op && strstr(buf, basedir) == buf)
                    862:                        start += strlen(basedir);
1.50      kristaps  863:        }
1.106     schwarze  864:
1.84      schwarze  865:        mlink = mandoc_calloc(1, sizeof(struct mlink));
1.161     schwarze  866:        mlink->dform = FORM_NONE;
1.143     schwarze  867:        if (strlcpy(mlink->file, start, sizeof(mlink->file)) >=
                    868:            sizeof(mlink->file)) {
                    869:                say(start, "Filename too long");
1.180     schwarze  870:                free(mlink);
1.143     schwarze  871:                return;
1.239     schwarze  872:        }
                    873:
                    874:        /*
                    875:         * In test mode or when the original name is absolute
                    876:         * but outside our tree, guess the base directory.
                    877:         */
                    878:
                    879:        if (op == OP_TEST || (start == buf && *start == '/')) {
                    880:                if (strncmp(buf, "man/", 4) == 0)
                    881:                        start = buf + 4;
                    882:                else if ((start = strstr(buf, "/man/")) != NULL)
                    883:                        start += 5;
                    884:                else
                    885:                        start = buf;
1.143     schwarze  886:        }
1.17      schwarze  887:
1.50      kristaps  888:        /*
                    889:         * First try to guess our directory structure.
                    890:         * If we find a separator, try to look for man* or cat*.
                    891:         * If we find one of these and what's underneath is a directory,
                    892:         * assume it's an architecture.
                    893:         */
                    894:        if (NULL != (p = strchr(start, '/'))) {
                    895:                *p++ = '\0';
                    896:                if (0 == strncmp(start, "man", 3)) {
1.84      schwarze  897:                        mlink->dform = FORM_SRC;
1.94      schwarze  898:                        mlink->dsec = start + 3;
1.50      kristaps  899:                } else if (0 == strncmp(start, "cat", 3)) {
1.84      schwarze  900:                        mlink->dform = FORM_CAT;
1.94      schwarze  901:                        mlink->dsec = start + 3;
1.17      schwarze  902:                }
1.5       kristaps  903:
1.50      kristaps  904:                start = p;
1.84      schwarze  905:                if (NULL != mlink->dsec && NULL != (p = strchr(start, '/'))) {
1.50      kristaps  906:                        *p++ = '\0';
1.94      schwarze  907:                        mlink->arch = start;
1.50      kristaps  908:                        start = p;
1.84      schwarze  909:                }
1.50      kristaps  910:        }
                    911:
                    912:        /*
                    913:         * Now check the file suffix.
                    914:         * Suffix of `.0' indicates a catpage, `.1-9' is a manpage.
                    915:         */
                    916:        p = strrchr(start, '\0');
                    917:        while (p-- > start && '/' != *p && '.' != *p)
                    918:                /* Loop. */ ;
                    919:
                    920:        if ('.' == *p) {
                    921:                *p++ = '\0';
1.94      schwarze  922:                mlink->fsec = p;
1.5       kristaps  923:        }
                    924:
1.10      kristaps  925:        /*
1.50      kristaps  926:         * Now try to parse the name.
                    927:         * Use the filename portion of the path.
1.10      kristaps  928:         */
1.84      schwarze  929:        mlink->name = start;
1.50      kristaps  930:        if (NULL != (p = strrchr(start, '/'))) {
1.84      schwarze  931:                mlink->name = p + 1;
1.50      kristaps  932:                *p = '\0';
1.84      schwarze  933:        }
                    934:        mlink_add(mlink, &st);
1.50      kristaps  935: }
1.5       kristaps  936:
1.50      kristaps  937: static void
1.84      schwarze  938: mlink_add(struct mlink *mlink, const struct stat *st)
1.50      kristaps  939: {
1.83      schwarze  940:        struct inodev    inodev;
1.78      schwarze  941:        struct mpage    *mpage;
1.83      schwarze  942:        unsigned int     slot;
1.50      kristaps  943:
1.84      schwarze  944:        assert(NULL != mlink->file);
1.50      kristaps  945:
1.94      schwarze  946:        mlink->dsec = mandoc_strdup(mlink->dsec ? mlink->dsec : "");
                    947:        mlink->arch = mandoc_strdup(mlink->arch ? mlink->arch : "");
                    948:        mlink->name = mandoc_strdup(mlink->name ? mlink->name : "");
                    949:        mlink->fsec = mandoc_strdup(mlink->fsec ? mlink->fsec : "");
1.84      schwarze  950:
                    951:        if ('0' == *mlink->fsec) {
                    952:                free(mlink->fsec);
                    953:                mlink->fsec = mandoc_strdup(mlink->dsec);
                    954:                mlink->fform = FORM_CAT;
                    955:        } else if ('1' <= *mlink->fsec && '9' >= *mlink->fsec)
                    956:                mlink->fform = FORM_SRC;
1.74      schwarze  957:        else
1.84      schwarze  958:                mlink->fform = FORM_NONE;
1.82      schwarze  959:
1.83      schwarze  960:        slot = ohash_qlookup(&mlinks, mlink->file);
                    961:        assert(NULL == ohash_find(&mlinks, slot));
                    962:        ohash_insert(&mlinks, slot, mlink);
                    963:
1.186     schwarze  964:        memset(&inodev, 0, sizeof(inodev));  /* Clear padding. */
1.83      schwarze  965:        inodev.st_ino = st->st_ino;
                    966:        inodev.st_dev = st->st_dev;
                    967:        slot = ohash_lookup_memory(&mpages, (char *)&inodev,
                    968:            sizeof(struct inodev), inodev.st_ino);
                    969:        mpage = ohash_find(&mpages, slot);
                    970:        if (NULL == mpage) {
                    971:                mpage = mandoc_calloc(1, sizeof(struct mpage));
                    972:                mpage->inodev.st_ino = inodev.st_ino;
                    973:                mpage->inodev.st_dev = inodev.st_dev;
1.221     schwarze  974:                mpage->form = FORM_NONE;
1.231     schwarze  975:                mpage->next = mpage_head;
                    976:                mpage_head = mpage;
1.83      schwarze  977:                ohash_insert(&mpages, slot, mpage);
                    978:        } else
1.85      schwarze  979:                mlink->next = mpage->mlinks;
1.82      schwarze  980:        mpage->mlinks = mlink;
1.118     schwarze  981:        mlink->mpage = mpage;
1.82      schwarze  982: }
                    983:
                    984: static void
                    985: mlink_free(struct mlink *mlink)
                    986: {
                    987:
                    988:        free(mlink->dsec);
                    989:        free(mlink->arch);
                    990:        free(mlink->name);
                    991:        free(mlink->fsec);
                    992:        free(mlink);
1.50      kristaps  993: }
1.3       kristaps  994:
1.50      kristaps  995: static void
1.78      schwarze  996: mpages_free(void)
1.50      kristaps  997: {
1.78      schwarze  998:        struct mpage    *mpage;
1.82      schwarze  999:        struct mlink    *mlink;
1.3       kristaps 1000:
1.231     schwarze 1001:        while ((mpage = mpage_head) != NULL) {
                   1002:                while ((mlink = mpage->mlinks) != NULL) {
1.85      schwarze 1003:                        mpage->mlinks = mlink->next;
1.82      schwarze 1004:                        mlink_free(mlink);
                   1005:                }
1.231     schwarze 1006:                mpage_head = mpage->next;
1.78      schwarze 1007:                free(mpage->sec);
                   1008:                free(mpage->arch);
1.82      schwarze 1009:                free(mpage->title);
                   1010:                free(mpage->desc);
1.78      schwarze 1011:                free(mpage);
1.50      kristaps 1012:        }
                   1013: }
1.38      schwarze 1014:
1.50      kristaps 1015: /*
1.89      schwarze 1016:  * For each mlink to the mpage, check whether the path looks like
                   1017:  * it is formatted, and if it does, check whether a source manual
                   1018:  * exists by the same name, ignoring the suffix.
                   1019:  * If both conditions hold, drop the mlink.
                   1020:  */
                   1021: static void
                   1022: mlinks_undupe(struct mpage *mpage)
                   1023: {
                   1024:        char              buf[PATH_MAX];
                   1025:        struct mlink    **prev;
                   1026:        struct mlink     *mlink;
                   1027:        char             *bufp;
                   1028:
                   1029:        mpage->form = FORM_CAT;
1.90      schwarze 1030:        prev = &mpage->mlinks;
                   1031:        while (NULL != (mlink = *prev)) {
1.89      schwarze 1032:                if (FORM_CAT != mlink->dform) {
                   1033:                        mpage->form = FORM_NONE;
1.90      schwarze 1034:                        goto nextlink;
1.89      schwarze 1035:                }
1.143     schwarze 1036:                (void)strlcpy(buf, mlink->file, sizeof(buf));
1.89      schwarze 1037:                bufp = strstr(buf, "cat");
                   1038:                assert(NULL != bufp);
                   1039:                memcpy(bufp, "man", 3);
                   1040:                if (NULL != (bufp = strrchr(buf, '.')))
                   1041:                        *++bufp = '\0';
1.143     schwarze 1042:                (void)strlcat(buf, mlink->dsec, sizeof(buf));
1.89      schwarze 1043:                if (NULL == ohash_find(&mlinks,
1.141     schwarze 1044:                    ohash_qlookup(&mlinks, buf)))
1.90      schwarze 1045:                        goto nextlink;
1.89      schwarze 1046:                if (warnings)
                   1047:                        say(mlink->file, "Man source exists: %s", buf);
                   1048:                if (use_all)
1.90      schwarze 1049:                        goto nextlink;
1.89      schwarze 1050:                *prev = mlink->next;
                   1051:                mlink_free(mlink);
1.90      schwarze 1052:                continue;
                   1053: nextlink:
                   1054:                prev = &(*prev)->next;
1.89      schwarze 1055:        }
                   1056: }
                   1057:
1.131     schwarze 1058: static void
1.93      schwarze 1059: mlink_check(struct mpage *mpage, struct mlink *mlink)
                   1060: {
1.131     schwarze 1061:        struct str      *str;
                   1062:        unsigned int     slot;
1.93      schwarze 1063:
                   1064:        /*
                   1065:         * Check whether the manual section given in a file
                   1066:         * agrees with the directory where the file is located.
                   1067:         * Some manuals have suffixes like (3p) on their
                   1068:         * section number either inside the file or in the
                   1069:         * directory name, some are linked into more than one
                   1070:         * section, like encrypt(1) = makekey(8).
                   1071:         */
                   1072:
                   1073:        if (FORM_SRC == mpage->form &&
1.131     schwarze 1074:            strcasecmp(mpage->sec, mlink->dsec))
1.93      schwarze 1075:                say(mlink->file, "Section \"%s\" manual in %s directory",
                   1076:                    mpage->sec, mlink->dsec);
                   1077:
                   1078:        /*
                   1079:         * Manual page directories exist for each kernel
                   1080:         * architecture as returned by machine(1).
                   1081:         * However, many manuals only depend on the
                   1082:         * application architecture as returned by arch(1).
                   1083:         * For example, some (2/ARM) manuals are shared
                   1084:         * across the "armish" and "zaurus" kernel
                   1085:         * architectures.
                   1086:         * A few manuals are even shared across completely
                   1087:         * different architectures, for example fdformat(1)
1.229     schwarze 1088:         * on amd64, i386, and sparc64.
1.93      schwarze 1089:         */
                   1090:
1.131     schwarze 1091:        if (strcasecmp(mpage->arch, mlink->arch))
1.93      schwarze 1092:                say(mlink->file, "Architecture \"%s\" manual in "
                   1093:                    "\"%s\" directory", mpage->arch, mlink->arch);
                   1094:
1.131     schwarze 1095:        /*
                   1096:         * XXX
1.133     schwarze 1097:         * parse_cat() doesn't set NAME_TITLE yet.
1.131     schwarze 1098:         */
                   1099:
                   1100:        if (FORM_CAT == mpage->form)
                   1101:                return;
                   1102:
                   1103:        /*
                   1104:         * Check whether this mlink
                   1105:         * appears as a name in the NAME section.
                   1106:         */
1.93      schwarze 1107:
1.133     schwarze 1108:        slot = ohash_qlookup(&names, mlink->name);
                   1109:        str = ohash_find(&names, slot);
1.131     schwarze 1110:        assert(NULL != str);
1.133     schwarze 1111:        if ( ! (NAME_TITLE & str->mask))
1.131     schwarze 1112:                say(mlink->file, "Name missing in NAME section");
1.93      schwarze 1113: }
                   1114:
1.89      schwarze 1115: /*
1.80      schwarze 1116:  * Run through the files in the global vector "mpages"
                   1117:  * and add them to the database specified in "basedir".
1.50      kristaps 1118:  *
                   1119:  * This handles the parsing scheme itself, using the cues of directory
                   1120:  * and filename to determine whether the file is parsable or not.
                   1121:  */
1.59      schwarze 1122: static void
1.221     schwarze 1123: mpages_merge(struct dba *dba, struct mparse *mp)
1.50      kristaps 1124: {
1.231     schwarze 1125:        struct mpage            *mpage, *mpage_dest;
1.118     schwarze 1126:        struct mlink            *mlink, *mlink_dest;
1.191     schwarze 1127:        struct roff_man         *man;
1.118     schwarze 1128:        char                    *sodest;
1.112     schwarze 1129:        char                    *cp;
1.162     schwarze 1130:        int                      fd;
1.69      schwarze 1131:
1.231     schwarze 1132:        for (mpage = mpage_head; mpage != NULL; mpage = mpage->next) {
1.89      schwarze 1133:                mlinks_undupe(mpage);
1.231     schwarze 1134:                if ((mlink = mpage->mlinks) == NULL)
                   1135:                        continue;
1.50      kristaps 1136:
1.133     schwarze 1137:                name_mask = NAME_MASK;
1.202     schwarze 1138:                mandoc_ohash_init(&names, 4, offsetof(struct str, key));
                   1139:                mandoc_ohash_init(&strings, 6, offsetof(struct str, key));
1.50      kristaps 1140:                mparse_reset(mp);
                   1141:                man = NULL;
1.124     schwarze 1142:                sodest = NULL;
                   1143:
1.213     schwarze 1144:                if ((fd = mparse_open(mp, mlink->file)) == -1) {
1.182     schwarze 1145:                        say(mlink->file, "&open");
1.162     schwarze 1146:                        goto nextpage;
1.124     schwarze 1147:                }
1.14      schwarze 1148:
                   1149:                /*
1.183     schwarze 1150:                 * Interpret the file as mdoc(7) or man(7) source
                   1151:                 * code, unless it is known to be formatted.
1.14      schwarze 1152:                 */
1.182     schwarze 1153:                if (mlink->dform != FORM_CAT || mlink->fform != FORM_CAT) {
1.183     schwarze 1154:                        mparse_readfd(mp, fd, mlink->file);
1.212     schwarze 1155:                        close(fd);
1.240     schwarze 1156:                        fd = -1;
1.192     schwarze 1157:                        mparse_result(mp, &man, &sodest);
1.76      schwarze 1158:                }
1.14      schwarze 1159:
1.171     schwarze 1160:                if (sodest != NULL) {
1.118     schwarze 1161:                        mlink_dest = ohash_find(&mlinks,
                   1162:                            ohash_qlookup(&mlinks, sodest));
1.171     schwarze 1163:                        if (mlink_dest == NULL) {
                   1164:                                mandoc_asprintf(&cp, "%s.gz", sodest);
                   1165:                                mlink_dest = ohash_find(&mlinks,
                   1166:                                    ohash_qlookup(&mlinks, cp));
                   1167:                                free(cp);
                   1168:                        }
                   1169:                        if (mlink_dest != NULL) {
1.118     schwarze 1170:
                   1171:                                /* The .so target exists. */
                   1172:
                   1173:                                mpage_dest = mlink_dest->mpage;
                   1174:                                while (1) {
                   1175:                                        mlink->mpage = mpage_dest;
                   1176:
                   1177:                                        /*
                   1178:                                         * If the target was already
                   1179:                                         * processed, add the links
                   1180:                                         * to the database now.
                   1181:                                         * Otherwise, this will
                   1182:                                         * happen when we come
                   1183:                                         * to the target.
                   1184:                                         */
                   1185:
1.221     schwarze 1186:                                        if (mpage_dest->dba != NULL)
                   1187:                                                dbadd_mlink(mlink);
1.118     schwarze 1188:
1.171     schwarze 1189:                                        if (mlink->next == NULL)
1.118     schwarze 1190:                                                break;
                   1191:                                        mlink = mlink->next;
                   1192:                                }
                   1193:
                   1194:                                /* Move all links to the target. */
                   1195:
                   1196:                                mlink->next = mlink_dest->next;
                   1197:                                mlink_dest->next = mpage->mlinks;
                   1198:                                mpage->mlinks = NULL;
                   1199:                        }
1.124     schwarze 1200:                        goto nextpage;
1.192     schwarze 1201:                } else if (man != NULL && man->macroset == MACROSET_MDOC) {
1.204     schwarze 1202:                        mdoc_validate(man);
1.82      schwarze 1203:                        mpage->form = FORM_SRC;
1.193     schwarze 1204:                        mpage->sec = man->meta.msec;
1.155     schwarze 1205:                        mpage->sec = mandoc_strdup(
1.171     schwarze 1206:                            mpage->sec == NULL ? "" : mpage->sec);
1.193     schwarze 1207:                        mpage->arch = man->meta.arch;
1.84      schwarze 1208:                        mpage->arch = mandoc_strdup(
1.171     schwarze 1209:                            mpage->arch == NULL ? "" : mpage->arch);
1.193     schwarze 1210:                        mpage->title = mandoc_strdup(man->meta.title);
1.192     schwarze 1211:                } else if (man != NULL && man->macroset == MACROSET_MAN) {
1.205     schwarze 1212:                        man_validate(man);
1.240     schwarze 1213:                        if (*man->meta.msec != '\0' ||
1.245     schwarze 1214:                            *man->meta.title != '\0') {
1.240     schwarze 1215:                                mpage->form = FORM_SRC;
                   1216:                                mpage->sec = mandoc_strdup(man->meta.msec);
                   1217:                                mpage->arch = mandoc_strdup(mlink->arch);
                   1218:                                mpage->title = mandoc_strdup(man->meta.title);
                   1219:                        } else
                   1220:                                man = NULL;
                   1221:                }
                   1222:
                   1223:                assert(mpage->desc == NULL);
                   1224:                if (man == NULL) {
1.82      schwarze 1225:                        mpage->form = FORM_CAT;
1.182     schwarze 1226:                        mpage->sec = mandoc_strdup(mlink->dsec);
                   1227:                        mpage->arch = mandoc_strdup(mlink->arch);
                   1228:                        mpage->title = mandoc_strdup(mlink->name);
1.240     schwarze 1229:                        parse_cat(mpage, fd);
                   1230:                } else if (man->macroset == MACROSET_MDOC)
1.193     schwarze 1231:                        parse_mdoc(mpage, &man->meta, man->first);
1.240     schwarze 1232:                else
1.193     schwarze 1233:                        parse_man(mpage, &man->meta, man->first);
1.242     schwarze 1234:                if (mpage->desc == NULL) {
                   1235:                        mpage->desc = mandoc_strdup(mlink->name);
                   1236:                        if (warnings)
                   1237:                                say(mlink->file, "No one-line description, "
                   1238:                                    "using filename \"%s\"", mlink->name);
                   1239:                }
1.131     schwarze 1240:
1.238     schwarze 1241:                for (mlink = mpage->mlinks;
                   1242:                     mlink != NULL;
                   1243:                     mlink = mlink->next) {
                   1244:                        putkey(mpage, mlink->name, NAME_FILE);
                   1245:                        if (warnings && !use_all)
1.131     schwarze 1246:                                mlink_check(mpage, mlink);
1.238     schwarze 1247:                }
1.44      kristaps 1248:
1.221     schwarze 1249:                dbadd(dba, mpage);
1.124     schwarze 1250:
                   1251: nextpage:
1.66      schwarze 1252:                ohash_delete(&strings);
1.133     schwarze 1253:                ohash_delete(&names);
1.50      kristaps 1254:        }
                   1255: }
1.12      schwarze 1256:
1.50      kristaps 1257: static void
1.124     schwarze 1258: parse_cat(struct mpage *mpage, int fd)
1.50      kristaps 1259: {
                   1260:        FILE            *stream;
1.241     schwarze 1261:        struct mlink    *mlink;
                   1262:        char            *line, *p, *title, *sec;
1.209     schwarze 1263:        size_t           linesz, plen, titlesz;
                   1264:        ssize_t          len;
                   1265:        int              offs;
1.12      schwarze 1266:
1.241     schwarze 1267:        mlink = mpage->mlinks;
                   1268:        stream = fd == -1 ? fopen(mlink->file, "r") : fdopen(fd, "r");
                   1269:        if (stream == NULL) {
                   1270:                if (fd != -1)
1.159     schwarze 1271:                        close(fd);
1.56      schwarze 1272:                if (warnings)
1.241     schwarze 1273:                        say(mlink->file, "&fopen");
1.50      kristaps 1274:                return;
                   1275:        }
1.1       kristaps 1276:
1.209     schwarze 1277:        line = NULL;
                   1278:        linesz = 0;
                   1279:
1.241     schwarze 1280:        /* Parse the section number from the header line. */
                   1281:
                   1282:        while (getline(&line, &linesz, stream) != -1) {
                   1283:                if (*line == '\n')
                   1284:                        continue;
                   1285:                if ((sec = strchr(line, '(')) == NULL)
                   1286:                        break;
                   1287:                if ((p = strchr(++sec, ')')) == NULL)
                   1288:                        break;
                   1289:                free(mpage->sec);
                   1290:                mpage->sec = mandoc_strndup(sec, p - sec);
                   1291:                if (warnings && *mlink->dsec != '\0' &&
                   1292:                    strcasecmp(mpage->sec, mlink->dsec))
                   1293:                        say(mlink->file,
                   1294:                            "Section \"%s\" manual in %s directory",
                   1295:                            mpage->sec, mlink->dsec);
                   1296:                break;
                   1297:        }
                   1298:
1.50      kristaps 1299:        /* Skip to first blank line. */
1.1       kristaps 1300:
1.241     schwarze 1301:        while (line == NULL || *line != '\n')
                   1302:                if (getline(&line, &linesz, stream) == -1)
1.50      kristaps 1303:                        break;
1.1       kristaps 1304:
1.50      kristaps 1305:        /*
                   1306:         * Assume the first line that is not indented
                   1307:         * is the first section header.  Skip to it.
                   1308:         */
1.1       kristaps 1309:
1.209     schwarze 1310:        while (getline(&line, &linesz, stream) != -1)
                   1311:                if (*line != '\n' && *line != ' ')
1.50      kristaps 1312:                        break;
1.141     schwarze 1313:
1.50      kristaps 1314:        /*
                   1315:         * Read up until the next section into a buffer.
                   1316:         * Strip the leading and trailing newline from each read line,
                   1317:         * appending a trailing space.
                   1318:         * Ignore empty (whitespace-only) lines.
                   1319:         */
1.1       kristaps 1320:
1.50      kristaps 1321:        titlesz = 0;
                   1322:        title = NULL;
1.38      schwarze 1323:
1.209     schwarze 1324:        while ((len = getline(&line, &linesz, stream)) != -1) {
                   1325:                if (*line != ' ')
1.50      kristaps 1326:                        break;
1.209     schwarze 1327:                offs = 0;
                   1328:                while (isspace((unsigned char)line[offs]))
                   1329:                        offs++;
                   1330:                if (line[offs] == '\0')
1.38      schwarze 1331:                        continue;
1.209     schwarze 1332:                title = mandoc_realloc(title, titlesz + len - offs);
                   1333:                memcpy(title + titlesz, line + offs, len - offs);
                   1334:                titlesz += len - offs;
1.50      kristaps 1335:                title[titlesz - 1] = ' ';
                   1336:        }
1.209     schwarze 1337:        free(line);
1.38      schwarze 1338:
1.50      kristaps 1339:        /*
                   1340:         * If no page content can be found, or the input line
                   1341:         * is already the next section header, or there is no
                   1342:         * trailing newline, reuse the page title as the page
                   1343:         * description.
                   1344:         */
1.44      kristaps 1345:
1.50      kristaps 1346:        if (NULL == title || '\0' == *title) {
1.56      schwarze 1347:                if (warnings)
1.241     schwarze 1348:                        say(mlink->file, "Cannot find NAME section");
1.50      kristaps 1349:                fclose(stream);
                   1350:                free(title);
                   1351:                return;
                   1352:        }
1.1       kristaps 1353:
1.209     schwarze 1354:        title[titlesz - 1] = '\0';
1.33      schwarze 1355:
1.50      kristaps 1356:        /*
                   1357:         * Skip to the first dash.
                   1358:         * Use the remaining line as the description (no more than 70
                   1359:         * bytes).
                   1360:         */
1.33      schwarze 1361:
1.50      kristaps 1362:        if (NULL != (p = strstr(title, "- "))) {
                   1363:                for (p += 2; ' ' == *p || '\b' == *p; p++)
                   1364:                        /* Skip to next word. */ ;
                   1365:        } else {
1.56      schwarze 1366:                if (warnings)
1.242     schwarze 1367:                        say(mlink->file, "No dash in title line, "
                   1368:                            "reusing \"%s\" as one-line description", title);
1.50      kristaps 1369:                p = title;
                   1370:        }
1.38      schwarze 1371:
1.50      kristaps 1372:        plen = strlen(p);
1.1       kristaps 1373:
1.50      kristaps 1374:        /* Strip backspace-encoding from line. */
1.1       kristaps 1375:
1.50      kristaps 1376:        while (NULL != (line = memchr(p, '\b', plen))) {
                   1377:                len = line - p;
                   1378:                if (0 == len) {
                   1379:                        memmove(line, line + 1, plen--);
                   1380:                        continue;
1.141     schwarze 1381:                }
1.50      kristaps 1382:                memmove(line - 1, line + 1, plen - len);
                   1383:                plen -= 2;
                   1384:        }
1.1       kristaps 1385:
1.78      schwarze 1386:        mpage->desc = mandoc_strdup(p);
1.50      kristaps 1387:        fclose(stream);
                   1388:        free(title);
                   1389: }
1.1       kristaps 1390:
1.50      kristaps 1391: /*
                   1392:  * Put a type/word pair into the word database for this particular file.
                   1393:  */
                   1394: static void
1.112     schwarze 1395: putkey(const struct mpage *mpage, char *value, uint64_t type)
1.50      kristaps 1396: {
1.78      schwarze 1397:        putkeys(mpage, value, strlen(value), type);
1.3       kristaps 1398: }
                   1399:
                   1400: /*
1.50      kristaps 1401:  * Grok all nodes at or below a certain mdoc node into putkey().
1.3       kristaps 1402:  */
                   1403: static void
1.78      schwarze 1404: putmdockey(const struct mpage *mpage,
1.235     schwarze 1405:        const struct roff_node *n, uint64_t m, int taboo)
1.3       kristaps 1406: {
1.18      kristaps 1407:
1.50      kristaps 1408:        for ( ; NULL != n; n = n->next) {
1.235     schwarze 1409:                if (n->flags & taboo)
                   1410:                        continue;
1.50      kristaps 1411:                if (NULL != n->child)
1.235     schwarze 1412:                        putmdockey(mpage, n->child, m, taboo);
1.188     schwarze 1413:                if (n->type == ROFFT_TEXT)
1.78      schwarze 1414:                        putkey(mpage, n->string, m);
1.50      kristaps 1415:        }
                   1416: }
1.18      kristaps 1417:
1.61      schwarze 1418: static void
1.190     schwarze 1419: parse_man(struct mpage *mpage, const struct roff_meta *meta,
1.189     schwarze 1420:        const struct roff_node *n)
1.50      kristaps 1421: {
1.189     schwarze 1422:        const struct roff_node *head, *body;
1.121     schwarze 1423:        char            *start, *title;
1.50      kristaps 1424:        char             byte;
1.121     schwarze 1425:        size_t           sz;
1.18      kristaps 1426:
1.215     schwarze 1427:        if (n == NULL)
1.61      schwarze 1428:                return;
1.18      kristaps 1429:
1.50      kristaps 1430:        /*
                   1431:         * We're only searching for one thing: the first text child in
                   1432:         * the BODY of a NAME section.  Since we don't keep track of
                   1433:         * sections in -man, run some hoops to find out whether we're in
                   1434:         * the correct section or not.
                   1435:         */
1.18      kristaps 1436:
1.188     schwarze 1437:        if (n->type == ROFFT_BODY && n->tok == MAN_SH) {
1.50      kristaps 1438:                body = n;
1.215     schwarze 1439:                if ((head = body->parent->head) != NULL &&
                   1440:                    (head = head->child) != NULL &&
                   1441:                    head->next == NULL &&
1.188     schwarze 1442:                    head->type == ROFFT_TEXT &&
1.215     schwarze 1443:                    strcmp(head->string, "NAME") == 0 &&
                   1444:                    body->child != NULL) {
1.3       kristaps 1445:
1.50      kristaps 1446:                        /*
                   1447:                         * Suck the entire NAME section into memory.
                   1448:                         * Yes, we might run away.
                   1449:                         * But too many manuals have big, spread-out
                   1450:                         * NAME sections over many lines.
                   1451:                         */
1.3       kristaps 1452:
1.121     schwarze 1453:                        title = NULL;
1.194     schwarze 1454:                        deroff(&title, body);
1.50      kristaps 1455:                        if (NULL == title)
1.61      schwarze 1456:                                return;
1.18      kristaps 1457:
1.141     schwarze 1458:                        /*
1.50      kristaps 1459:                         * Go through a special heuristic dance here.
                   1460:                         * Conventionally, one or more manual names are
                   1461:                         * comma-specified prior to a whitespace, then a
                   1462:                         * dash, then a description.  Try to puzzle out
                   1463:                         * the name parts here.
                   1464:                         */
1.18      kristaps 1465:
1.121     schwarze 1466:                        start = title;
1.50      kristaps 1467:                        for ( ;; ) {
                   1468:                                sz = strcspn(start, " ,");
                   1469:                                if ('\0' == start[sz])
                   1470:                                        break;
1.1       kristaps 1471:
1.50      kristaps 1472:                                byte = start[sz];
                   1473:                                start[sz] = '\0';
1.110     schwarze 1474:
                   1475:                                /*
                   1476:                                 * Assume a stray trailing comma in the
                   1477:                                 * name list if a name begins with a dash.
                   1478:                                 */
                   1479:
                   1480:                                if ('-' == start[0] ||
                   1481:                                    ('\\' == start[0] && '-' == start[1]))
                   1482:                                        break;
1.1       kristaps 1483:
1.133     schwarze 1484:                                putkey(mpage, start, NAME_TITLE);
1.174     schwarze 1485:                                if ( ! (mpage->name_head_done ||
                   1486:                                    strcasecmp(start, meta->title))) {
                   1487:                                        putkey(mpage, start, NAME_HEAD);
                   1488:                                        mpage->name_head_done = 1;
                   1489:                                }
1.1       kristaps 1490:
1.50      kristaps 1491:                                if (' ' == byte) {
                   1492:                                        start += sz + 1;
                   1493:                                        break;
                   1494:                                }
1.1       kristaps 1495:
1.50      kristaps 1496:                                assert(',' == byte);
                   1497:                                start += sz + 1;
                   1498:                                while (' ' == *start)
                   1499:                                        start++;
                   1500:                        }
1.1       kristaps 1501:
1.121     schwarze 1502:                        if (start == title) {
1.133     schwarze 1503:                                putkey(mpage, start, NAME_TITLE);
1.174     schwarze 1504:                                if ( ! (mpage->name_head_done ||
                   1505:                                    strcasecmp(start, meta->title))) {
                   1506:                                        putkey(mpage, start, NAME_HEAD);
                   1507:                                        mpage->name_head_done = 1;
                   1508:                                }
1.50      kristaps 1509:                                free(title);
1.61      schwarze 1510:                                return;
1.50      kristaps 1511:                        }
1.1       kristaps 1512:
1.50      kristaps 1513:                        while (isspace((unsigned char)*start))
                   1514:                                start++;
1.1       kristaps 1515:
1.50      kristaps 1516:                        if (0 == strncmp(start, "-", 1))
                   1517:                                start += 1;
                   1518:                        else if (0 == strncmp(start, "\\-\\-", 4))
                   1519:                                start += 4;
                   1520:                        else if (0 == strncmp(start, "\\-", 2))
                   1521:                                start += 2;
                   1522:                        else if (0 == strncmp(start, "\\(en", 4))
                   1523:                                start += 4;
                   1524:                        else if (0 == strncmp(start, "\\(em", 4))
                   1525:                                start += 4;
1.1       kristaps 1526:
1.50      kristaps 1527:                        while (' ' == *start)
                   1528:                                start++;
1.1       kristaps 1529:
1.78      schwarze 1530:                        mpage->desc = mandoc_strdup(start);
1.50      kristaps 1531:                        free(title);
1.61      schwarze 1532:                        return;
1.50      kristaps 1533:                }
                   1534:        }
1.1       kristaps 1535:
1.77      schwarze 1536:        for (n = n->child; n; n = n->next) {
1.78      schwarze 1537:                if (NULL != mpage->desc)
1.77      schwarze 1538:                        break;
1.174     schwarze 1539:                parse_man(mpage, meta, n);
1.77      schwarze 1540:        }
1.1       kristaps 1541: }
                   1542:
                   1543: static void
1.190     schwarze 1544: parse_mdoc(struct mpage *mpage, const struct roff_meta *meta,
1.189     schwarze 1545:        const struct roff_node *n)
1.1       kristaps 1546: {
                   1547:
1.246     schwarze 1548:        for (n = n->child; n != NULL; n = n->next) {
1.247   ! schwarze 1549:                if (n->tok == TOKEN_NONE ||
        !          1550:                    n->tok < ROFF_MAX ||
        !          1551:                    n->flags & mdocs[n->tok].taboo)
1.235     schwarze 1552:                        continue;
1.247   ! schwarze 1553:                assert(n->tok >= MDOC_Dd && n->tok < MDOC_MAX);
1.50      kristaps 1554:                switch (n->type) {
1.188     schwarze 1555:                case ROFFT_ELEM:
                   1556:                case ROFFT_BLOCK:
                   1557:                case ROFFT_HEAD:
                   1558:                case ROFFT_BODY:
                   1559:                case ROFFT_TAIL:
1.246     schwarze 1560:                        if (mdocs[n->tok].fp != NULL &&
                   1561:                            (*mdocs[n->tok].fp)(mpage, meta, n) == 0)
                   1562:                                break;
1.68      schwarze 1563:                        if (mdocs[n->tok].mask)
1.78      schwarze 1564:                                putmdockey(mpage, n->child,
1.235     schwarze 1565:                                    mdocs[n->tok].mask, mdocs[n->tok].taboo);
1.50      kristaps 1566:                        break;
                   1567:                default:
                   1568:                        continue;
                   1569:                }
                   1570:                if (NULL != n->child)
1.172     schwarze 1571:                        parse_mdoc(mpage, meta, n);
1.1       kristaps 1572:        }
                   1573: }
                   1574:
1.25      schwarze 1575: static int
1.190     schwarze 1576: parse_mdoc_Fd(struct mpage *mpage, const struct roff_meta *meta,
1.189     schwarze 1577:        const struct roff_node *n)
1.1       kristaps 1578: {
1.176     schwarze 1579:        char            *start, *end;
1.1       kristaps 1580:        size_t           sz;
1.25      schwarze 1581:
1.50      kristaps 1582:        if (SEC_SYNOPSIS != n->sec ||
1.141     schwarze 1583:            NULL == (n = n->child) ||
1.188     schwarze 1584:            n->type != ROFFT_TEXT)
1.197     schwarze 1585:                return 0;
1.1       kristaps 1586:
                   1587:        /*
                   1588:         * Only consider those `Fd' macro fields that begin with an
                   1589:         * "inclusion" token (versus, e.g., #define).
                   1590:         */
1.50      kristaps 1591:
1.1       kristaps 1592:        if (strcmp("#include", n->string))
1.197     schwarze 1593:                return 0;
1.1       kristaps 1594:
1.188     schwarze 1595:        if ((n = n->next) == NULL || n->type != ROFFT_TEXT)
1.197     schwarze 1596:                return 0;
1.1       kristaps 1597:
                   1598:        /*
                   1599:         * Strip away the enclosing angle brackets and make sure we're
                   1600:         * not zero-length.
                   1601:         */
                   1602:
                   1603:        start = n->string;
                   1604:        if ('<' == *start || '"' == *start)
                   1605:                start++;
                   1606:
                   1607:        if (0 == (sz = strlen(start)))
1.197     schwarze 1608:                return 0;
1.1       kristaps 1609:
                   1610:        end = &start[(int)sz - 1];
                   1611:        if ('>' == *end || '"' == *end)
                   1612:                end--;
                   1613:
1.50      kristaps 1614:        if (end > start)
1.78      schwarze 1615:                putkeys(mpage, start, end - start + 1, TYPE_In);
1.197     schwarze 1616:        return 0;
1.1       kristaps 1617: }
                   1618:
1.178     schwarze 1619: static void
1.189     schwarze 1620: parse_mdoc_fname(struct mpage *mpage, const struct roff_node *n)
1.1       kristaps 1621: {
1.112     schwarze 1622:        char    *cp;
1.178     schwarze 1623:        size_t   sz;
1.1       kristaps 1624:
1.188     schwarze 1625:        if (n->type != ROFFT_TEXT)
1.178     schwarze 1626:                return;
1.25      schwarze 1627:
1.178     schwarze 1628:        /* Skip function pointer punctuation. */
1.1       kristaps 1629:
1.178     schwarze 1630:        cp = n->string;
                   1631:        while (*cp == '(' || *cp == '*')
1.1       kristaps 1632:                cp++;
1.178     schwarze 1633:        sz = strcspn(cp, "()");
1.1       kristaps 1634:
1.178     schwarze 1635:        putkeys(mpage, cp, sz, TYPE_Fn);
1.173     schwarze 1636:        if (n->sec == SEC_SYNOPSIS)
1.178     schwarze 1637:                putkeys(mpage, cp, sz, NAME_SYN);
                   1638: }
1.25      schwarze 1639:
1.178     schwarze 1640: static int
1.190     schwarze 1641: parse_mdoc_Fn(struct mpage *mpage, const struct roff_meta *meta,
1.189     schwarze 1642:        const struct roff_node *n)
1.178     schwarze 1643: {
                   1644:
                   1645:        if (n->child == NULL)
1.197     schwarze 1646:                return 0;
1.178     schwarze 1647:
                   1648:        parse_mdoc_fname(mpage, n->child);
1.25      schwarze 1649:
1.178     schwarze 1650:        for (n = n->child->next; n != NULL; n = n->next)
1.188     schwarze 1651:                if (n->type == ROFFT_TEXT)
1.78      schwarze 1652:                        putkey(mpage, n->string, TYPE_Fa);
1.25      schwarze 1653:
1.197     schwarze 1654:        return 0;
1.173     schwarze 1655: }
                   1656:
                   1657: static int
1.190     schwarze 1658: parse_mdoc_Fo(struct mpage *mpage, const struct roff_meta *meta,
1.189     schwarze 1659:        const struct roff_node *n)
1.173     schwarze 1660: {
1.177     schwarze 1661:
1.188     schwarze 1662:        if (n->type != ROFFT_HEAD)
1.197     schwarze 1663:                return 1;
1.173     schwarze 1664:
1.178     schwarze 1665:        if (n->child != NULL)
                   1666:                parse_mdoc_fname(mpage, n->child);
                   1667:
1.197     schwarze 1668:        return 0;
1.1       kristaps 1669: }
                   1670:
1.25      schwarze 1671: static int
1.211     schwarze 1672: parse_mdoc_Va(struct mpage *mpage, const struct roff_meta *meta,
                   1673:        const struct roff_node *n)
                   1674: {
                   1675:        char *cp;
                   1676:
                   1677:        if (n->type != ROFFT_ELEM && n->type != ROFFT_BODY)
                   1678:                return 0;
                   1679:
1.215     schwarze 1680:        if (n->child != NULL &&
                   1681:            n->child->next == NULL &&
                   1682:            n->child->type == ROFFT_TEXT)
1.211     schwarze 1683:                return 1;
                   1684:
                   1685:        cp = NULL;
                   1686:        deroff(&cp, n);
                   1687:        if (cp != NULL) {
                   1688:                putkey(mpage, cp, TYPE_Vt | (n->tok == MDOC_Va ||
                   1689:                    n->type == ROFFT_BODY ? TYPE_Va : 0));
                   1690:                free(cp);
                   1691:        }
                   1692:
                   1693:        return 0;
                   1694: }
                   1695:
                   1696: static int
1.190     schwarze 1697: parse_mdoc_Xr(struct mpage *mpage, const struct roff_meta *meta,
1.189     schwarze 1698:        const struct roff_node *n)
1.1       kristaps 1699: {
1.67      schwarze 1700:        char    *cp;
1.1       kristaps 1701:
                   1702:        if (NULL == (n = n->child))
1.197     schwarze 1703:                return 0;
1.1       kristaps 1704:
1.67      schwarze 1705:        if (NULL == n->next) {
1.78      schwarze 1706:                putkey(mpage, n->string, TYPE_Xr);
1.197     schwarze 1707:                return 0;
1.67      schwarze 1708:        }
                   1709:
1.120     schwarze 1710:        mandoc_asprintf(&cp, "%s(%s)", n->string, n->next->string);
1.78      schwarze 1711:        putkey(mpage, cp, TYPE_Xr);
1.67      schwarze 1712:        free(cp);
1.197     schwarze 1713:        return 0;
1.1       kristaps 1714: }
                   1715:
1.25      schwarze 1716: static int
1.190     schwarze 1717: parse_mdoc_Nd(struct mpage *mpage, const struct roff_meta *meta,
1.189     schwarze 1718:        const struct roff_node *n)
1.1       kristaps 1719: {
                   1720:
1.188     schwarze 1721:        if (n->type == ROFFT_BODY)
1.194     schwarze 1722:                deroff(&mpage->desc, n);
1.197     schwarze 1723:        return 0;
1.1       kristaps 1724: }
                   1725:
1.25      schwarze 1726: static int
1.190     schwarze 1727: parse_mdoc_Nm(struct mpage *mpage, const struct roff_meta *meta,
1.189     schwarze 1728:        const struct roff_node *n)
1.1       kristaps 1729: {
                   1730:
1.129     schwarze 1731:        if (SEC_NAME == n->sec)
1.235     schwarze 1732:                putmdockey(mpage, n->child, NAME_TITLE, 0);
1.188     schwarze 1733:        else if (n->sec == SEC_SYNOPSIS && n->type == ROFFT_HEAD) {
1.172     schwarze 1734:                if (n->child == NULL)
                   1735:                        putkey(mpage, meta->name, NAME_SYN);
                   1736:                else
1.235     schwarze 1737:                        putmdockey(mpage, n->child, NAME_SYN, 0);
1.174     schwarze 1738:        }
                   1739:        if ( ! (mpage->name_head_done ||
                   1740:            n->child == NULL || n->child->string == NULL ||
                   1741:            strcasecmp(n->child->string, meta->title))) {
1.226     schwarze 1742:                putkey(mpage, n->child->string, NAME_HEAD);
1.174     schwarze 1743:                mpage->name_head_done = 1;
1.172     schwarze 1744:        }
1.197     schwarze 1745:        return 0;
1.1       kristaps 1746: }
                   1747:
1.25      schwarze 1748: static int
1.190     schwarze 1749: parse_mdoc_Sh(struct mpage *mpage, const struct roff_meta *meta,
1.189     schwarze 1750:        const struct roff_node *n)
1.1       kristaps 1751: {
                   1752:
1.197     schwarze 1753:        return n->sec == SEC_CUSTOM && n->type == ROFFT_HEAD;
1.1       kristaps 1754: }
                   1755:
1.50      kristaps 1756: static int
1.190     schwarze 1757: parse_mdoc_head(struct mpage *mpage, const struct roff_meta *meta,
1.189     schwarze 1758:        const struct roff_node *n)
1.1       kristaps 1759: {
                   1760:
1.197     schwarze 1761:        return n->type == ROFFT_HEAD;
1.1       kristaps 1762: }
                   1763:
1.50      kristaps 1764: /*
1.66      schwarze 1765:  * Add a string to the hash table for the current manual.
                   1766:  * Each string has a bitmask telling which macros it belongs to.
                   1767:  * When we finish the manual, we'll dump the table.
1.50      kristaps 1768:  */
                   1769: static void
1.176     schwarze 1770: putkeys(const struct mpage *mpage, char *cp, size_t sz, uint64_t v)
1.50      kristaps 1771: {
1.133     schwarze 1772:        struct ohash    *htab;
1.50      kristaps 1773:        struct str      *s;
1.111     schwarze 1774:        const char      *end;
1.65      schwarze 1775:        unsigned int     slot;
1.176     schwarze 1776:        int              i, mustfree;
1.25      schwarze 1777:
1.50      kristaps 1778:        if (0 == sz)
                   1779:                return;
1.111     schwarze 1780:
1.176     schwarze 1781:        mustfree = render_string(&cp, &sz);
                   1782:
1.133     schwarze 1783:        if (TYPE_Nm & v) {
                   1784:                htab = &names;
                   1785:                v &= name_mask;
1.169     schwarze 1786:                if (v & NAME_FIRST)
                   1787:                        name_mask &= ~NAME_FIRST;
1.133     schwarze 1788:                if (debug > 1)
                   1789:                        say(mpage->mlinks->file,
1.234     schwarze 1790:                            "Adding name %*s, bits=0x%llx", (int)sz, cp,
                   1791:                            (unsigned long long)v);
1.133     schwarze 1792:        } else {
                   1793:                htab = &strings;
                   1794:                if (debug > 1)
1.221     schwarze 1795:                    for (i = 0; i < KEY_MAX; i++)
1.163     schwarze 1796:                        if ((uint64_t)1 << i & v)
1.133     schwarze 1797:                            say(mpage->mlinks->file,
                   1798:                                "Adding key %s=%*s",
1.220     schwarze 1799:                                mansearch_keynames[i], (int)sz, cp);
1.111     schwarze 1800:        }
1.25      schwarze 1801:
1.65      schwarze 1802:        end = cp + sz;
1.133     schwarze 1803:        slot = ohash_qlookupi(htab, cp, &end);
                   1804:        s = ohash_find(htab, slot);
1.25      schwarze 1805:
1.78      schwarze 1806:        if (NULL != s && mpage == s->mpage) {
1.50      kristaps 1807:                s->mask |= v;
                   1808:                return;
                   1809:        } else if (NULL == s) {
1.144     schwarze 1810:                s = mandoc_calloc(1, sizeof(struct str) + sz + 1);
1.50      kristaps 1811:                memcpy(s->key, cp, sz);
1.133     schwarze 1812:                ohash_insert(htab, slot, s);
1.1       kristaps 1813:        }
1.78      schwarze 1814:        s->mpage = mpage;
1.50      kristaps 1815:        s->mask = v;
1.176     schwarze 1816:
                   1817:        if (mustfree)
                   1818:                free(cp);
1.1       kristaps 1819: }
                   1820:
1.50      kristaps 1821: /*
                   1822:  * Take a Unicode codepoint and produce its UTF-8 encoding.
                   1823:  * This isn't the best way to do this, but it works.
                   1824:  * The magic numbers are from the UTF-8 packaging.
                   1825:  * They're not as scary as they seem: read the UTF-8 spec for details.
                   1826:  */
                   1827: static size_t
                   1828: utf8(unsigned int cp, char out[7])
1.1       kristaps 1829: {
1.50      kristaps 1830:        size_t           rc;
1.1       kristaps 1831:
1.50      kristaps 1832:        rc = 0;
                   1833:        if (cp <= 0x0000007F) {
                   1834:                rc = 1;
                   1835:                out[0] = (char)cp;
                   1836:        } else if (cp <= 0x000007FF) {
                   1837:                rc = 2;
                   1838:                out[0] = (cp >> 6  & 31) | 192;
                   1839:                out[1] = (cp       & 63) | 128;
                   1840:        } else if (cp <= 0x0000FFFF) {
                   1841:                rc = 3;
                   1842:                out[0] = (cp >> 12 & 15) | 224;
                   1843:                out[1] = (cp >> 6  & 63) | 128;
                   1844:                out[2] = (cp       & 63) | 128;
                   1845:        } else if (cp <= 0x001FFFFF) {
                   1846:                rc = 4;
                   1847:                out[0] = (cp >> 18 &  7) | 240;
                   1848:                out[1] = (cp >> 12 & 63) | 128;
                   1849:                out[2] = (cp >> 6  & 63) | 128;
                   1850:                out[3] = (cp       & 63) | 128;
                   1851:        } else if (cp <= 0x03FFFFFF) {
                   1852:                rc = 5;
                   1853:                out[0] = (cp >> 24 &  3) | 248;
                   1854:                out[1] = (cp >> 18 & 63) | 128;
                   1855:                out[2] = (cp >> 12 & 63) | 128;
                   1856:                out[3] = (cp >> 6  & 63) | 128;
                   1857:                out[4] = (cp       & 63) | 128;
                   1858:        } else if (cp <= 0x7FFFFFFF) {
                   1859:                rc = 6;
                   1860:                out[0] = (cp >> 30 &  1) | 252;
                   1861:                out[1] = (cp >> 24 & 63) | 128;
                   1862:                out[2] = (cp >> 18 & 63) | 128;
                   1863:                out[3] = (cp >> 12 & 63) | 128;
                   1864:                out[4] = (cp >> 6  & 63) | 128;
                   1865:                out[5] = (cp       & 63) | 128;
                   1866:        } else
1.197     schwarze 1867:                return 0;
1.1       kristaps 1868:
1.50      kristaps 1869:        out[rc] = '\0';
1.197     schwarze 1870:        return rc;
1.50      kristaps 1871: }
1.1       kristaps 1872:
1.50      kristaps 1873: /*
1.176     schwarze 1874:  * If the string contains escape sequences,
                   1875:  * replace it with an allocated rendering and return 1,
                   1876:  * such that the caller can free it after use.
                   1877:  * Otherwise, do nothing and return 0.
1.50      kristaps 1878:  */
1.176     schwarze 1879: static int
                   1880: render_string(char **public, size_t *psz)
1.50      kristaps 1881: {
1.176     schwarze 1882:        const char      *src, *scp, *addcp, *seq;
                   1883:        char            *dst;
                   1884:        size_t           ssz, dsz, addsz;
1.114     schwarze 1885:        char             utfbuf[7], res[6];
1.176     schwarze 1886:        int              seqlen, unicode;
1.50      kristaps 1887:
                   1888:        res[0] = '\\';
                   1889:        res[1] = '\t';
                   1890:        res[2] = ASCII_NBRSP;
                   1891:        res[3] = ASCII_HYPH;
1.114     schwarze 1892:        res[4] = ASCII_BREAK;
                   1893:        res[5] = '\0';
1.1       kristaps 1894:
1.176     schwarze 1895:        src = scp = *public;
                   1896:        ssz = *psz;
                   1897:        dst = NULL;
                   1898:        dsz = 0;
                   1899:
                   1900:        while (scp < src + *psz) {
                   1901:
                   1902:                /* Leave normal characters unchanged. */
                   1903:
                   1904:                if (strchr(res, *scp) == NULL) {
                   1905:                        if (dst != NULL)
                   1906:                                dst[dsz++] = *scp;
                   1907:                        scp++;
                   1908:                        continue;
                   1909:                }
1.46      kristaps 1910:
1.50      kristaps 1911:                /*
1.176     schwarze 1912:                 * Found something that requires replacing,
                   1913:                 * make sure we have a destination buffer.
1.50      kristaps 1914:                 */
1.176     schwarze 1915:
                   1916:                if (dst == NULL) {
                   1917:                        dst = mandoc_malloc(ssz + 1);
                   1918:                        dsz = scp - src;
                   1919:                        memcpy(dst, src, dsz);
1.50      kristaps 1920:                }
1.46      kristaps 1921:
1.176     schwarze 1922:                /* Handle single-char special characters. */
                   1923:
                   1924:                switch (*scp) {
                   1925:                case '\\':
                   1926:                        break;
1.141     schwarze 1927:                case '\t':
                   1928:                case ASCII_NBRSP:
1.176     schwarze 1929:                        dst[dsz++] = ' ';
                   1930:                        scp++;
                   1931:                        continue;
                   1932:                case ASCII_HYPH:
                   1933:                        dst[dsz++] = '-';
1.114     schwarze 1934:                        /* FALLTHROUGH */
1.141     schwarze 1935:                case ASCII_BREAK:
1.176     schwarze 1936:                        scp++;
1.50      kristaps 1937:                        continue;
1.114     schwarze 1938:                default:
1.176     schwarze 1939:                        abort();
1.114     schwarze 1940:                }
1.46      kristaps 1941:
1.50      kristaps 1942:                /*
1.176     schwarze 1943:                 * Found an escape sequence.
                   1944:                 * Read past the slash, then parse it.
                   1945:                 * Ignore everything except characters.
1.50      kristaps 1946:                 */
1.95      schwarze 1947:
1.176     schwarze 1948:                scp++;
                   1949:                if (mandoc_escape(&scp, &seq, &seqlen) != ESCAPE_SPECIAL)
1.50      kristaps 1950:                        continue;
1.1       kristaps 1951:
1.50      kristaps 1952:                /*
1.95      schwarze 1953:                 * Render the special character
                   1954:                 * as either UTF-8 or ASCII.
1.50      kristaps 1955:                 */
1.95      schwarze 1956:
                   1957:                if (write_utf8) {
1.203     schwarze 1958:                        unicode = mchars_spec2cp(seq, seqlen);
1.176     schwarze 1959:                        if (unicode <= 0)
1.95      schwarze 1960:                                continue;
1.176     schwarze 1961:                        addsz = utf8(unicode, utfbuf);
                   1962:                        if (addsz == 0)
1.95      schwarze 1963:                                continue;
1.176     schwarze 1964:                        addcp = utfbuf;
1.95      schwarze 1965:                } else {
1.203     schwarze 1966:                        addcp = mchars_spec2str(seq, seqlen, &addsz);
1.176     schwarze 1967:                        if (addcp == NULL)
1.95      schwarze 1968:                                continue;
1.176     schwarze 1969:                        if (*addcp == ASCII_NBRSP) {
                   1970:                                addcp = " ";
                   1971:                                addsz = 1;
1.95      schwarze 1972:                        }
                   1973:                }
1.1       kristaps 1974:
1.50      kristaps 1975:                /* Copy the rendered glyph into the stream. */
1.1       kristaps 1976:
1.176     schwarze 1977:                ssz += addsz;
                   1978:                dst = mandoc_realloc(dst, ssz + 1);
                   1979:                memcpy(dst + dsz, addcp, addsz);
                   1980:                dsz += addsz;
                   1981:        }
                   1982:        if (dst != NULL) {
                   1983:                *public = dst;
                   1984:                *psz = dsz;
                   1985:        }
                   1986:
                   1987:        /* Trim trailing whitespace and NUL-terminate. */
                   1988:
                   1989:        while (*psz > 0 && (*public)[*psz - 1] == ' ')
                   1990:                --*psz;
                   1991:        if (dst != NULL) {
                   1992:                (*public)[*psz] = '\0';
1.197     schwarze 1993:                return 1;
1.176     schwarze 1994:        } else
1.197     schwarze 1995:                return 0;
1.1       kristaps 1996: }
                   1997:
1.118     schwarze 1998: static void
                   1999: dbadd_mlink(const struct mlink *mlink)
                   2000: {
1.221     schwarze 2001:        dba_page_alias(mlink->mpage->dba, mlink->name, NAME_FILE);
                   2002:        dba_page_add(mlink->mpage->dba, DBP_SECT, mlink->dsec);
1.223     schwarze 2003:        dba_page_add(mlink->mpage->dba, DBP_SECT, mlink->fsec);
1.221     schwarze 2004:        dba_page_add(mlink->mpage->dba, DBP_ARCH, mlink->arch);
                   2005:        dba_page_add(mlink->mpage->dba, DBP_FILE, mlink->file);
1.118     schwarze 2006: }
                   2007:
1.14      schwarze 2008: /*
1.50      kristaps 2009:  * Flush the current page's terms (and their bits) into the database.
1.96      schwarze 2010:  * Also, handle escape sequences at the last possible moment.
1.14      schwarze 2011:  */
                   2012: static void
1.221     schwarze 2013: dbadd(struct dba *dba, struct mpage *mpage)
1.14      schwarze 2014: {
1.87      schwarze 2015:        struct mlink    *mlink;
1.50      kristaps 2016:        struct str      *key;
1.176     schwarze 2017:        char            *cp;
1.221     schwarze 2018:        uint64_t         mask;
1.52      kristaps 2019:        size_t           i;
1.66      schwarze 2020:        unsigned int     slot;
1.176     schwarze 2021:        int              mustfree;
1.14      schwarze 2022:
1.128     schwarze 2023:        mlink = mpage->mlinks;
1.43      kristaps 2024:
1.128     schwarze 2025:        if (nodb) {
1.147     schwarze 2026:                for (key = ohash_first(&names, &slot); NULL != key;
1.176     schwarze 2027:                     key = ohash_next(&names, &slot))
1.147     schwarze 2028:                        free(key);
                   2029:                for (key = ohash_first(&strings, &slot); NULL != key;
1.176     schwarze 2030:                     key = ohash_next(&strings, &slot))
1.147     schwarze 2031:                        free(key);
1.145     schwarze 2032:                if (0 == debug)
                   2033:                        return;
1.128     schwarze 2034:                while (NULL != mlink) {
                   2035:                        fputs(mlink->name, stdout);
                   2036:                        if (NULL == mlink->next ||
                   2037:                            strcmp(mlink->dsec, mlink->next->dsec) ||
                   2038:                            strcmp(mlink->fsec, mlink->next->fsec) ||
                   2039:                            strcmp(mlink->arch, mlink->next->arch)) {
                   2040:                                putchar('(');
                   2041:                                if ('\0' == *mlink->dsec)
                   2042:                                        fputs(mlink->fsec, stdout);
                   2043:                                else
                   2044:                                        fputs(mlink->dsec, stdout);
                   2045:                                if ('\0' != *mlink->arch)
                   2046:                                        printf("/%s", mlink->arch);
                   2047:                                putchar(')');
                   2048:                        }
                   2049:                        mlink = mlink->next;
                   2050:                        if (NULL != mlink)
                   2051:                                fputs(", ", stdout);
                   2052:                }
1.132     schwarze 2053:                printf(" - %s\n", mpage->desc);
1.14      schwarze 2054:                return;
1.128     schwarze 2055:        }
                   2056:
                   2057:        if (debug)
                   2058:                say(mlink->file, "Adding to database");
1.28      kristaps 2059:
1.176     schwarze 2060:        cp = mpage->desc;
                   2061:        i = strlen(cp);
                   2062:        mustfree = render_string(&cp, &i);
1.227     schwarze 2063:        mpage->dba = dba_page_new(dba->pages,
1.223     schwarze 2064:            *mpage->arch == '\0' ? mlink->arch : mpage->arch,
                   2065:            cp, mlink->file, mpage->form);
1.176     schwarze 2066:        if (mustfree)
                   2067:                free(cp);
1.227     schwarze 2068:        dba_page_add(mpage->dba, DBP_SECT, mpage->sec);
1.81      schwarze 2069:
1.223     schwarze 2070:        while (mlink != NULL) {
1.118     schwarze 2071:                dbadd_mlink(mlink);
1.223     schwarze 2072:                mlink = mlink->next;
                   2073:        }
1.50      kristaps 2074:
1.133     schwarze 2075:        for (key = ohash_first(&names, &slot); NULL != key;
                   2076:             key = ohash_next(&names, &slot)) {
                   2077:                assert(key->mpage == mpage);
1.221     schwarze 2078:                dba_page_alias(mpage->dba, key->key, key->mask);
1.133     schwarze 2079:                free(key);
                   2080:        }
1.66      schwarze 2081:        for (key = ohash_first(&strings, &slot); NULL != key;
                   2082:             key = ohash_next(&strings, &slot)) {
1.78      schwarze 2083:                assert(key->mpage == mpage);
1.221     schwarze 2084:                i = 0;
                   2085:                for (mask = TYPE_Xr; mask <= TYPE_Lb; mask *= 2) {
                   2086:                        if (key->mask & mask)
                   2087:                                dba_macro_add(dba->macros, i,
                   2088:                                    key->key, mpage->dba);
                   2089:                        i++;
                   2090:                }
1.66      schwarze 2091:                free(key);
1.38      schwarze 2092:        }
1.14      schwarze 2093: }
                   2094:
1.5       kristaps 2095: static void
1.221     schwarze 2096: dbprune(struct dba *dba)
1.5       kristaps 2097: {
1.221     schwarze 2098:        struct dba_array        *page, *files;
                   2099:        char                    *file;
1.5       kristaps 2100:
1.221     schwarze 2101:        dba_array_FOREACH(dba->pages, page) {
                   2102:                files = dba_array_get(page, DBP_FILE);
                   2103:                dba_array_FOREACH(files, file) {
                   2104:                        if (*file < ' ')
                   2105:                                file++;
                   2106:                        if (ohash_find(&mlinks, ohash_qlookup(&mlinks,
                   2107:                            file)) != NULL) {
                   2108:                                if (debug)
                   2109:                                        say(file, "Deleting from database");
                   2110:                                dba_array_del(dba->pages);
                   2111:                                break;
                   2112:                        }
1.106     schwarze 2113:                }
1.5       kristaps 2114:        }
                   2115: }
                   2116:
1.4       kristaps 2117: /*
1.221     schwarze 2118:  * Write the database from memory to disk.
1.4       kristaps 2119:  */
1.35      kristaps 2120: static void
1.221     schwarze 2121: dbwrite(struct dba *dba)
1.4       kristaps 2122: {
1.221     schwarze 2123:        char             tfn[32];
1.115     schwarze 2124:        int              status;
                   2125:        pid_t            child;
1.4       kristaps 2126:
1.221     schwarze 2127:        if (dba_write(MANDOC_DB "~", dba) != -1) {
                   2128:                if (rename(MANDOC_DB "~", MANDOC_DB) == -1) {
                   2129:                        exitcode = (int)MANDOCLEVEL_SYSERR;
                   2130:                        say(MANDOC_DB, "&rename");
                   2131:                        unlink(MANDOC_DB "~");
                   2132:                }
1.38      schwarze 2133:                return;
1.4       kristaps 2134:        }
                   2135:
1.221     schwarze 2136:        (void)strlcpy(tfn, "/tmp/mandocdb.XXXXXXXX", sizeof(tfn));
                   2137:        if (mkdtemp(tfn) == NULL) {
                   2138:                exitcode = (int)MANDOCLEVEL_SYSERR;
                   2139:                say("", "&%s", tfn);
1.50      kristaps 2140:                return;
1.221     schwarze 2141:        }
1.12      schwarze 2142:
1.221     schwarze 2143:        (void)strlcat(tfn, "/" MANDOC_DB, sizeof(tfn));
                   2144:        if (dba_write(tfn, dba) == -1) {
                   2145:                exitcode = (int)MANDOCLEVEL_SYSERR;
                   2146:                say(tfn, "&dba_write");
                   2147:                goto out;
1.115     schwarze 2148:        }
                   2149:
                   2150:        switch (child = fork()) {
1.141     schwarze 2151:        case -1:
1.115     schwarze 2152:                exitcode = (int)MANDOCLEVEL_SYSERR;
1.123     schwarze 2153:                say("", "&fork cmp");
1.115     schwarze 2154:                return;
1.141     schwarze 2155:        case 0:
1.221     schwarze 2156:                execlp("cmp", "cmp", "-s", tfn, MANDOC_DB, (char *)NULL);
1.123     schwarze 2157:                say("", "&exec cmp");
1.115     schwarze 2158:                exit(0);
                   2159:        default:
                   2160:                break;
                   2161:        }
1.221     schwarze 2162:        if (waitpid(child, &status, 0) == -1) {
1.115     schwarze 2163:                exitcode = (int)MANDOCLEVEL_SYSERR;
1.123     schwarze 2164:                say("", "&wait cmp");
1.115     schwarze 2165:        } else if (WIFSIGNALED(status)) {
                   2166:                exitcode = (int)MANDOCLEVEL_SYSERR;
1.123     schwarze 2167:                say("", "cmp died from signal %d", WTERMSIG(status));
1.115     schwarze 2168:        } else if (WEXITSTATUS(status)) {
1.59      schwarze 2169:                exitcode = (int)MANDOCLEVEL_SYSERR;
1.115     schwarze 2170:                say(MANDOC_DB,
                   2171:                    "Data changed, but cannot replace database");
                   2172:        }
                   2173:
1.221     schwarze 2174: out:
                   2175:        *strrchr(tfn, '/') = '\0';
1.115     schwarze 2176:        switch (child = fork()) {
1.141     schwarze 2177:        case -1:
1.115     schwarze 2178:                exitcode = (int)MANDOCLEVEL_SYSERR;
1.123     schwarze 2179:                say("", "&fork rm");
1.115     schwarze 2180:                return;
1.141     schwarze 2181:        case 0:
1.221     schwarze 2182:                execlp("rm", "rm", "-rf", tfn, (char *)NULL);
1.123     schwarze 2183:                say("", "&exec rm");
1.115     schwarze 2184:                exit((int)MANDOCLEVEL_SYSERR);
                   2185:        default:
                   2186:                break;
                   2187:        }
1.221     schwarze 2188:        if (waitpid(child, &status, 0) == -1) {
1.115     schwarze 2189:                exitcode = (int)MANDOCLEVEL_SYSERR;
1.123     schwarze 2190:                say("", "&wait rm");
1.115     schwarze 2191:        } else if (WIFSIGNALED(status) || WEXITSTATUS(status)) {
                   2192:                exitcode = (int)MANDOCLEVEL_SYSERR;
1.221     schwarze 2193:                say("", "%s: Cannot remove temporary directory", tfn);
1.146     schwarze 2194:        }
1.4       kristaps 2195: }
                   2196:
1.50      kristaps 2197: static int
1.165     schwarze 2198: set_basedir(const char *targetdir, int report_baddir)
1.4       kristaps 2199: {
1.59      schwarze 2200:        static char      startdir[PATH_MAX];
1.151     schwarze 2201:        static int       getcwd_status;  /* 1 = ok, 2 = failure */
                   2202:        static int       chdir_status;  /* 1 = changed directory */
1.150     schwarze 2203:        char            *cp;
1.4       kristaps 2204:
1.59      schwarze 2205:        /*
1.151     schwarze 2206:         * Remember the original working directory, if possible.
                   2207:         * This will be needed if the second or a later directory
                   2208:         * on the command line is given as a relative path.
                   2209:         * Do not error out if the current directory is not
                   2210:         * searchable: Maybe it won't be needed after all.
                   2211:         */
                   2212:        if (0 == getcwd_status) {
                   2213:                if (NULL == getcwd(startdir, sizeof(startdir))) {
                   2214:                        getcwd_status = 2;
                   2215:                        (void)strlcpy(startdir, strerror(errno),
                   2216:                            sizeof(startdir));
                   2217:                } else
                   2218:                        getcwd_status = 1;
                   2219:        }
                   2220:
                   2221:        /*
                   2222:         * We are leaving the old base directory.
                   2223:         * Do not use it any longer, not even for messages.
                   2224:         */
                   2225:        *basedir = '\0';
                   2226:
                   2227:        /*
                   2228:         * If and only if the directory was changed earlier and
                   2229:         * the next directory to process is given as a relative path,
                   2230:         * first go back, or bail out if that is impossible.
1.59      schwarze 2231:         */
1.151     schwarze 2232:        if (chdir_status && '/' != *targetdir) {
                   2233:                if (2 == getcwd_status) {
1.59      schwarze 2234:                        exitcode = (int)MANDOCLEVEL_SYSERR;
1.151     schwarze 2235:                        say("", "getcwd: %s", startdir);
1.197     schwarze 2236:                        return 0;
1.59      schwarze 2237:                }
1.151     schwarze 2238:                if (-1 == chdir(startdir)) {
1.59      schwarze 2239:                        exitcode = (int)MANDOCLEVEL_SYSERR;
1.123     schwarze 2240:                        say("", "&chdir %s", startdir);
1.197     schwarze 2241:                        return 0;
1.59      schwarze 2242:                }
                   2243:        }
1.151     schwarze 2244:
                   2245:        /*
                   2246:         * Always resolve basedir to the canonicalized absolute
                   2247:         * pathname and append a trailing slash, such that
                   2248:         * we can reliably check whether files are inside.
                   2249:         */
1.59      schwarze 2250:        if (NULL == realpath(targetdir, basedir)) {
1.165     schwarze 2251:                if (report_baddir || errno != ENOENT) {
                   2252:                        exitcode = (int)MANDOCLEVEL_BADARG;
                   2253:                        say("", "&%s: realpath", targetdir);
                   2254:                }
1.197     schwarze 2255:                return 0;
1.59      schwarze 2256:        } else if (-1 == chdir(basedir)) {
1.165     schwarze 2257:                if (report_baddir || errno != ENOENT) {
                   2258:                        exitcode = (int)MANDOCLEVEL_BADARG;
                   2259:                        say("", "&chdir");
                   2260:                }
1.197     schwarze 2261:                return 0;
1.150     schwarze 2262:        }
1.151     schwarze 2263:        chdir_status = 1;
1.150     schwarze 2264:        cp = strchr(basedir, '\0');
                   2265:        if ('/' != cp[-1]) {
                   2266:                if (cp - basedir >= PATH_MAX - 1) {
                   2267:                        exitcode = (int)MANDOCLEVEL_SYSERR;
                   2268:                        say("", "Filename too long");
1.197     schwarze 2269:                        return 0;
1.150     schwarze 2270:                }
                   2271:                *cp++ = '/';
                   2272:                *cp = '\0';
1.4       kristaps 2273:        }
1.197     schwarze 2274:        return 1;
1.56      schwarze 2275: }
                   2276:
                   2277: static void
1.59      schwarze 2278: say(const char *file, const char *format, ...)
1.56      schwarze 2279: {
                   2280:        va_list          ap;
1.123     schwarze 2281:        int              use_errno;
1.56      schwarze 2282:
1.59      schwarze 2283:        if ('\0' != *basedir)
                   2284:                fprintf(stderr, "%s", basedir);
                   2285:        if ('\0' != *basedir && '\0' != *file)
1.151     schwarze 2286:                fputc('/', stderr);
1.56      schwarze 2287:        if ('\0' != *file)
1.59      schwarze 2288:                fprintf(stderr, "%s", file);
                   2289:
1.123     schwarze 2290:        use_errno = 1;
                   2291:        if (NULL != format) {
                   2292:                switch (*format) {
1.141     schwarze 2293:                case '&':
1.123     schwarze 2294:                        format++;
                   2295:                        break;
1.141     schwarze 2296:                case '\0':
1.123     schwarze 2297:                        format = NULL;
                   2298:                        break;
                   2299:                default:
                   2300:                        use_errno = 0;
                   2301:                        break;
                   2302:                }
                   2303:        }
                   2304:        if (NULL != format) {
                   2305:                if ('\0' != *basedir || '\0' != *file)
                   2306:                        fputs(": ", stderr);
                   2307:                va_start(ap, format);
                   2308:                vfprintf(stderr, format, ap);
                   2309:                va_end(ap);
                   2310:        }
                   2311:        if (use_errno) {
                   2312:                if ('\0' != *basedir || '\0' != *file || NULL != format)
                   2313:                        fputs(": ", stderr);
1.59      schwarze 2314:                perror(NULL);
1.123     schwarze 2315:        } else
                   2316:                fputc('\n', stderr);
1.1       kristaps 2317: }

CVSweb