=================================================================== RCS file: /cvs/mandoc/mandocdb.c,v retrieving revision 1.81 retrieving revision 1.97 diff -u -p -r1.81 -r1.97 --- mandoc/mandocdb.c 2013/12/27 01:16:54 1.81 +++ mandoc/mandocdb.c 2014/01/05 00:29:54 1.97 @@ -1,7 +1,7 @@ -/* $Id: mandocdb.c,v 1.81 2013/12/27 01:16:54 schwarze Exp $ */ +/* $Id: mandocdb.c,v 1.97 2014/01/05 00:29:54 schwarze Exp $ */ /* * Copyright (c) 2011, 2012 Kristaps Dzonsons - * Copyright (c) 2011, 2012, 2013 Ingo Schwarze + * Copyright (c) 2011, 2012, 2013, 2014 Ingo Schwarze * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -76,16 +76,16 @@ enum op { }; enum form { - FORM_SRC, /* format is -man or -mdoc */ - FORM_CAT, /* format is cat */ - FORM_NONE /* format is unknown */ + FORM_NONE, /* format is unknown */ + FORM_SRC, /* format is -man or -mdoc */ + FORM_CAT /* format is cat */ }; struct str { - char *utf8; /* key in UTF-8 form */ + char *rendered; /* key in UTF-8 or ASCII form */ const struct mpage *mpage; /* if set, the owning parse */ uint64_t mask; /* bitmask in sequence */ - char key[]; /* the string itself */ + char key[]; /* may contain escape sequences */ }; struct inodev { @@ -95,14 +95,23 @@ struct inodev { struct mpage { struct inodev inodev; /* used for hashing routine */ - enum form dform; /* path-cued form */ - enum form sform; /* suffix-cued form */ + enum form form; /* format from file content */ + char *sec; /* section from file content */ + char *arch; /* architecture from file content */ + char *title; /* title from file content */ + char *desc; /* description from file content */ + struct mlink *mlinks; /* singly linked list */ +}; + +struct mlink { char file[PATH_MAX]; /* filename rel. to manpath */ - char *desc; /* parsed description */ - char *name; /* name (from filename) (not empty) */ - char *sec; /* suffix-cued section (or empty) */ - char *dsec; /* path-cued section (or empty) */ - char *arch; /* path-cued arch. (or empty) */ + enum form dform; /* format from directory */ + enum form fform; /* format from file name suffix */ + char *dsec; /* section from directory */ + char *arch; /* architecture from directory */ + char *name; /* name from file name (not empty) */ + char *fsec; /* section from file name suffix */ + struct mlink *next; /* singly linked list */ }; struct title { @@ -126,19 +135,17 @@ struct mdoc_handler { }; static void dbclose(int); -static void dbindex(struct mchars *, int, const struct mpage *); +static void dbindex(const struct mpage *, struct mchars *); static int dbopen(int); static void dbprune(void); -static void fileadd(struct mpage *); -static int filecheck(const char *); static void filescan(const char *); static void *hash_alloc(size_t, void *); static void hash_free(void *, size_t, void *); static void *hash_halloc(size_t, void *); -static void inoadd(const struct stat *, struct mpage *); -static int inocheck(const struct stat *); -static void ofadd(int, const char *, const char *, const char *, - const char *, const char *, const struct stat *); +static void mlink_add(struct mlink *, const struct stat *); +static int mlink_check(struct mpage *, struct mlink *); +static void mlink_free(struct mlink *); +static void mlinks_undupe(struct mpage *); static void mpages_free(void); static void mpages_merge(struct mchars *, struct mparse *, int); static void parse_cat(struct mpage *); @@ -148,11 +155,9 @@ static int parse_mdoc_body(struct mpage *, const stru static int parse_mdoc_head(struct mpage *, const struct mdoc_node *); static int parse_mdoc_Fd(struct mpage *, const struct mdoc_node *); static int parse_mdoc_Fn(struct mpage *, const struct mdoc_node *); -static int parse_mdoc_In(struct mpage *, const struct mdoc_node *); static int parse_mdoc_Nd(struct mpage *, const struct mdoc_node *); static int parse_mdoc_Nm(struct mpage *, const struct mdoc_node *); static int parse_mdoc_Sh(struct mpage *, const struct mdoc_node *); -static int parse_mdoc_St(struct mpage *, const struct mdoc_node *); static int parse_mdoc_Xr(struct mpage *, const struct mdoc_node *); static void putkey(const struct mpage *, const char *, uint64_t); @@ -160,22 +165,23 @@ static void putkeys(const struct mpage *, const char *, size_t, uint64_t); static void putmdockey(const struct mpage *, const struct mdoc_node *, uint64_t); +static void render_key(struct mchars *, struct str *); static void say(const char *, const char *, ...); static int set_basedir(const char *); static int treescan(void); static size_t utf8(unsigned int, char [7]); -static void utf8key(struct mchars *, struct str *); static char *progname; static int use_all; /* use all found files */ static int nodb; /* no database changes */ static int verb; /* print what we're doing */ static int warnings; /* warn about crap */ +static int write_utf8; /* write UTF-8 output; else ASCII */ static int exitcode; /* to be returned by main */ static enum op op; /* operational mode */ static char basedir[PATH_MAX]; /* current base directory */ static struct ohash mpages; /* table of distinct manual pages */ -static struct ohash filenames; /* table of filenames */ +static struct ohash mlinks; /* table of directory entries */ static struct ohash strings; /* table of all strings */ static sqlite3 *db = NULL; /* current database */ static sqlite3_stmt *stmts[STMT__MAX]; /* current statements */ @@ -210,7 +216,7 @@ static const struct mdoc_handler mdocs[MDOC_MAX] = { { parse_mdoc_Fn, 0 }, /* Fn */ { NULL, TYPE_Ft }, /* Ft */ { NULL, TYPE_Ic }, /* Ic */ - { parse_mdoc_In, TYPE_In }, /* In */ + { NULL, TYPE_In }, /* In */ { NULL, TYPE_Li }, /* Li */ { parse_mdoc_Nd, TYPE_Nd }, /* Nd */ { parse_mdoc_Nm, TYPE_Nm }, /* Nm */ @@ -218,7 +224,7 @@ static const struct mdoc_handler mdocs[MDOC_MAX] = { { NULL, 0 }, /* Ot */ { NULL, TYPE_Pa }, /* Pa */ { NULL, 0 }, /* Rv */ - { parse_mdoc_St, 0 }, /* St */ + { NULL, TYPE_St }, /* St */ { NULL, TYPE_Va }, /* Va */ { parse_mdoc_body, TYPE_Va }, /* Vt */ { parse_mdoc_Xr, 0 }, /* Xr */ @@ -314,17 +320,17 @@ main(int argc, char *argv[]) struct mchars *mc; struct manpaths dirs; struct mparse *mp; - struct ohash_info mpages_info, filename_info; + struct ohash_info mpages_info, mlinks_info; memset(stmts, 0, STMT__MAX * sizeof(sqlite3_stmt *)); memset(&dirs, 0, sizeof(struct manpaths)); - mpages_info.alloc = filename_info.alloc = hash_alloc; - mpages_info.halloc = filename_info.halloc = hash_halloc; - mpages_info.hfree = filename_info.hfree = hash_free; + mpages_info.alloc = mlinks_info.alloc = hash_alloc; + mpages_info.halloc = mlinks_info.halloc = hash_halloc; + mpages_info.hfree = mlinks_info.hfree = hash_free; mpages_info.key_offset = offsetof(struct mpage, inodev); - filename_info.key_offset = offsetof(struct mpage, file); + mlinks_info.key_offset = offsetof(struct mlink, file); progname = strrchr(argv[0], '/'); if (progname == NULL) @@ -346,7 +352,7 @@ main(int argc, char *argv[]) path_arg = NULL; op = OP_DEFAULT; - while (-1 != (ch = getopt(argc, argv, "aC:d:ntu:vW"))) + while (-1 != (ch = getopt(argc, argv, "aC:d:nT:tu:vW"))) switch (ch) { case ('a'): use_all = 1; @@ -364,6 +370,14 @@ main(int argc, char *argv[]) case ('n'): nodb = 1; break; + case ('T'): + if (strcmp(optarg, "utf8")) { + fprintf(stderr, "-T%s: Unsupported " + "output format\n", optarg); + goto usage; + } + write_utf8 = 1; + break; case ('t'): CHECKOP(op, ch); dup2(STDOUT_FILENO, STDERR_FILENO); @@ -399,7 +413,7 @@ main(int argc, char *argv[]) mc = mchars_alloc(); ohash_init(&mpages, 6, &mpages_info); - ohash_init(&filenames, 6, &filename_info); + ohash_init(&mlinks, 6, &mlinks_info); if (OP_UPDATE == op || OP_DELETE == op || OP_TEST == op) { /* @@ -453,7 +467,7 @@ main(int argc, char *argv[]) if (j) { ohash_init(&mpages, 6, &mpages_info); - ohash_init(&filenames, 6, &filename_info); + ohash_init(&mlinks, 6, &mlinks_info); } if (0 == set_basedir(dirs.paths[j])) @@ -471,7 +485,7 @@ main(int argc, char *argv[]) if (j + 1 < dirs.sz) { mpages_free(); ohash_delete(&mpages); - ohash_delete(&filenames); + ohash_delete(&mlinks); } } } @@ -482,12 +496,12 @@ out: mparse_free(mp); mpages_free(); ohash_delete(&mpages); - ohash_delete(&filenames); + ohash_delete(&mlinks); return(exitcode); usage: - fprintf(stderr, "usage: %s [-anvW] [-C file]\n" - " %s [-anvW] dir ...\n" - " %s [-nvW] -d dir [file ...]\n" + fprintf(stderr, "usage: %s [-anvW] [-C file] [-Tutf8]\n" + " %s [-anvW] [-Tutf8] dir ...\n" + " %s [-nvW] [-Tutf8] -d dir [file ...]\n" " %s [-nvW] -u dir [file ...]\n" " %s -t file ...\n", progname, progname, progname, @@ -515,9 +529,10 @@ treescan(void) { FTS *f; FTSENT *ff; + struct mlink *mlink; int dform; - char *sec; - const char *dsec, *arch, *cp, *path; + char *dsec, *arch, *fsec, *cp; + const char *path; const char *argv[2]; argv[0] = "."; @@ -540,9 +555,8 @@ treescan(void) while (NULL != (ff = fts_read(f))) { path = ff->fts_path + 2; /* - * If we're a regular file, add an mpage by using the + * If we're a regular file, add an mlink by using the * stored directory data and handling the filename. - * Disallow duplicate (hard-linked) files. */ if (FTS_F == ff->fts_info) { if (0 == strcmp(path, MANDOC_DB)) @@ -551,11 +565,7 @@ treescan(void) if (warnings) say(path, "Extraneous file"); continue; - } else if (inocheck(ff->fts_statp)) { - if (warnings) - say(path, "Duplicate file"); - continue; - } else if (NULL == (sec = + } else if (NULL == (fsec = strrchr(ff->fts_name, '.'))) { if ( ! use_all) { if (warnings) @@ -563,34 +573,41 @@ treescan(void) "No filename suffix"); continue; } - } else if (0 == strcmp(++sec, "html")) { + } else if (0 == strcmp(++fsec, "html")) { if (warnings) say(path, "Skip html"); continue; - } else if (0 == strcmp(sec, "gz")) { + } else if (0 == strcmp(fsec, "gz")) { if (warnings) say(path, "Skip gz"); continue; - } else if (0 == strcmp(sec, "ps")) { + } else if (0 == strcmp(fsec, "ps")) { if (warnings) say(path, "Skip ps"); continue; - } else if (0 == strcmp(sec, "pdf")) { + } else if (0 == strcmp(fsec, "pdf")) { if (warnings) say(path, "Skip pdf"); continue; } else if ( ! use_all && - ((FORM_SRC == dform && strcmp(sec, dsec)) || - (FORM_CAT == dform && strcmp(sec, "0")))) { + ((FORM_SRC == dform && strcmp(fsec, dsec)) || + (FORM_CAT == dform && strcmp(fsec, "0")))) { if (warnings) say(path, "Wrong filename suffix"); continue; } else - sec[-1] = '\0'; - ofadd(dform, path, ff->fts_name, dsec, sec, - arch, ff->fts_statp); + fsec[-1] = '\0'; + + mlink = mandoc_calloc(1, sizeof(struct mlink)); + strlcpy(mlink->file, path, sizeof(mlink->file)); + mlink->dform = dform; + mlink->dsec = dsec; + mlink->arch = arch; + mlink->name = ff->fts_name; + mlink->fsec = fsec; + mlink_add(mlink, ff->fts_statp); continue; - } else if (FTS_D != ff->fts_info && + } else if (FTS_D != ff->fts_info && FTS_DP != ff->fts_info) { if (warnings) say(path, "Not a regular file"); @@ -607,8 +624,6 @@ treescan(void) * Try to infer this from the name. * If we're not in use_all, enforce it. */ - dsec = NULL; - dform = FORM_NONE; cp = ff->fts_name; if (FTS_DP == ff->fts_info) break; @@ -619,6 +634,9 @@ treescan(void) } else if (0 == strncmp(cp, "cat", 3)) { dform = FORM_CAT; dsec = cp + 3; + } else { + dform = FORM_NONE; + dsec = NULL; } if (NULL != dsec || use_all) @@ -633,9 +651,10 @@ treescan(void) * Possibly our architecture. * If we're descending, keep tabs on it. */ - arch = NULL; if (FTS_DP != ff->fts_info && NULL != dsec) arch = ff->fts_name; + else + arch = NULL; break; default: if (FTS_DP == ff->fts_info || use_all) @@ -652,7 +671,7 @@ treescan(void) } /* - * Add a file to the file vector. + * Add a file to the mlinks table. * Do not verify that it's a "valid" looking manpage (we'll do that * later). * @@ -663,17 +682,15 @@ treescan(void) * or * [./]cat
[/]/.0 * - * Stuff this information directly into the mpage vector. * See treescan() for the fts(3) version of this. */ static void filescan(const char *file) { char buf[PATH_MAX]; - const char *sec, *arch, *name, *dsec; - char *p, *start; - int dform; struct stat st; + struct mlink *mlink; + char *p, *start; assert(use_all); @@ -696,14 +713,10 @@ filescan(const char *file) exitcode = (int)MANDOCLEVEL_BADARG; say(file, "Not a regular file"); return; - } else if (inocheck(&st)) { - if (warnings) - say(file, "Duplicate file"); - return; } start = buf + strlen(basedir); - sec = arch = name = dsec = NULL; - dform = FORM_NONE; + mlink = mandoc_calloc(1, sizeof(struct mlink)); + strlcpy(mlink->file, start, sizeof(mlink->file)); /* * First try to guess our directory structure. @@ -714,19 +727,19 @@ filescan(const char *file) if (NULL != (p = strchr(start, '/'))) { *p++ = '\0'; if (0 == strncmp(start, "man", 3)) { - dform = FORM_SRC; - dsec = start + 3; + mlink->dform = FORM_SRC; + mlink->dsec = start + 3; } else if (0 == strncmp(start, "cat", 3)) { - dform = FORM_CAT; - dsec = start + 3; + mlink->dform = FORM_CAT; + mlink->dsec = start + 3; } start = p; - if (NULL != dsec && NULL != (p = strchr(start, '/'))) { + if (NULL != mlink->dsec && NULL != (p = strchr(start, '/'))) { *p++ = '\0'; - arch = start; + mlink->arch = start; start = p; - } + } } /* @@ -739,142 +752,189 @@ filescan(const char *file) if ('.' == *p) { *p++ = '\0'; - sec = p; + mlink->fsec = p; } /* * Now try to parse the name. * Use the filename portion of the path. */ - name = start; + mlink->name = start; if (NULL != (p = strrchr(start, '/'))) { - name = p + 1; + mlink->name = p + 1; *p = '\0'; - } - - ofadd(dform, file, name, dsec, sec, arch, &st); + } + mlink_add(mlink, &st); } -/* - * See fileadd(). - */ -static int -filecheck(const char *name) +static void +mlink_add(struct mlink *mlink, const struct stat *st) { + struct inodev inodev; + struct mpage *mpage; + unsigned int slot; - return(NULL != ohash_find(&filenames, - ohash_qlookup(&filenames, name))); + assert(NULL != mlink->file); + + mlink->dsec = mandoc_strdup(mlink->dsec ? mlink->dsec : ""); + mlink->arch = mandoc_strdup(mlink->arch ? mlink->arch : ""); + mlink->name = mandoc_strdup(mlink->name ? mlink->name : ""); + mlink->fsec = mandoc_strdup(mlink->fsec ? mlink->fsec : ""); + + if ('0' == *mlink->fsec) { + free(mlink->fsec); + mlink->fsec = mandoc_strdup(mlink->dsec); + mlink->fform = FORM_CAT; + } else if ('1' <= *mlink->fsec && '9' >= *mlink->fsec) + mlink->fform = FORM_SRC; + else + mlink->fform = FORM_NONE; + + slot = ohash_qlookup(&mlinks, mlink->file); + assert(NULL == ohash_find(&mlinks, slot)); + ohash_insert(&mlinks, slot, mlink); + + inodev.st_ino = st->st_ino; + inodev.st_dev = st->st_dev; + slot = ohash_lookup_memory(&mpages, (char *)&inodev, + sizeof(struct inodev), inodev.st_ino); + mpage = ohash_find(&mpages, slot); + if (NULL == mpage) { + mpage = mandoc_calloc(1, sizeof(struct mpage)); + mpage->inodev.st_ino = inodev.st_ino; + mpage->inodev.st_dev = inodev.st_dev; + ohash_insert(&mpages, slot, mpage); + } else + mlink->next = mpage->mlinks; + mpage->mlinks = mlink; } -/* - * Use the standard hashing mechanism (K&R) to see if the given filename - * already exists. - */ static void -fileadd(struct mpage *mpage) +mlink_free(struct mlink *mlink) { - unsigned int slot; - slot = ohash_qlookup(&filenames, mpage->file); - assert(NULL == ohash_find(&filenames, slot)); - ohash_insert(&filenames, slot, mpage); + free(mlink->dsec); + free(mlink->arch); + free(mlink->name); + free(mlink->fsec); + free(mlink); } -/* - * See inoadd(). - */ -static int -inocheck(const struct stat *st) +static void +mpages_free(void) { - struct inodev inodev; - uint32_t hash; + struct mpage *mpage; + struct mlink *mlink; + unsigned int slot; - memset(&inodev, 0, sizeof(inodev)); - inodev.st_ino = hash = st->st_ino; - inodev.st_dev = st->st_dev; - - return(NULL != ohash_find(&mpages, ohash_lookup_memory( - &mpages, (char *)&inodev, sizeof(inodev), hash))); + mpage = ohash_first(&mpages, &slot); + while (NULL != mpage) { + while (NULL != (mlink = mpage->mlinks)) { + mpage->mlinks = mlink->next; + mlink_free(mlink); + } + free(mpage->sec); + free(mpage->arch); + free(mpage->title); + free(mpage->desc); + free(mpage); + mpage = ohash_next(&mpages, &slot); + } } /* - * The hashing function used here is quite simple: simply take the inode - * and use uint32_t of its bits. - * Then when we do the lookup, use both the inode and device identifier. + * For each mlink to the mpage, check whether the path looks like + * it is formatted, and if it does, check whether a source manual + * exists by the same name, ignoring the suffix. + * If both conditions hold, drop the mlink. */ static void -inoadd(const struct stat *st, struct mpage *mpage) +mlinks_undupe(struct mpage *mpage) { - unsigned int slot; + char buf[PATH_MAX]; + struct mlink **prev; + struct mlink *mlink; + char *bufp; - mpage->inodev.st_ino = st->st_ino; - mpage->inodev.st_dev = st->st_dev; - slot = ohash_lookup_memory(&mpages, (char *)&mpage->inodev, - sizeof(struct inodev), st->st_ino); - - assert(NULL == ohash_find(&mpages, slot)); - ohash_insert(&mpages, slot, mpage); + mpage->form = FORM_CAT; + prev = &mpage->mlinks; + while (NULL != (mlink = *prev)) { + if (FORM_CAT != mlink->dform) { + mpage->form = FORM_NONE; + goto nextlink; + } + if (strlcpy(buf, mlink->file, PATH_MAX) >= PATH_MAX) { + if (warnings) + say(mlink->file, "Filename too long"); + goto nextlink; + } + bufp = strstr(buf, "cat"); + assert(NULL != bufp); + memcpy(bufp, "man", 3); + if (NULL != (bufp = strrchr(buf, '.'))) + *++bufp = '\0'; + strlcat(buf, mlink->dsec, PATH_MAX); + if (NULL == ohash_find(&mlinks, + ohash_qlookup(&mlinks, buf))) + goto nextlink; + if (warnings) + say(mlink->file, "Man source exists: %s", buf); + if (use_all) + goto nextlink; + *prev = mlink->next; + mlink_free(mlink); + continue; +nextlink: + prev = &(*prev)->next; + } } -static void -ofadd(int dform, const char *file, const char *name, const char *dsec, - const char *sec, const char *arch, const struct stat *st) +static int +mlink_check(struct mpage *mpage, struct mlink *mlink) { - struct mpage *mpage; - int sform; + int match; - assert(NULL != file); + match = 1; - if (NULL == name) - name = ""; - if (NULL == sec) - sec = ""; - if (NULL == dsec) - dsec = ""; - if (NULL == arch) - arch = ""; + /* + * Check whether the manual section given in a file + * agrees with the directory where the file is located. + * Some manuals have suffixes like (3p) on their + * section number either inside the file or in the + * directory name, some are linked into more than one + * section, like encrypt(1) = makekey(8). + */ - if ('0' == *sec) { - sec = dsec; - sform = FORM_CAT; - } else if ('1' <= *sec && '9' >= *sec) - sform = FORM_SRC; - else - sform = FORM_NONE; + if (FORM_SRC == mpage->form && + strcasecmp(mpage->sec, mlink->dsec)) { + match = 0; + say(mlink->file, "Section \"%s\" manual in %s directory", + mpage->sec, mlink->dsec); + } - mpage = mandoc_calloc(1, sizeof(struct mpage)); - strlcpy(mpage->file, file, PATH_MAX); - mpage->name = mandoc_strdup(name); - mpage->sec = mandoc_strdup(sec); - mpage->dsec = mandoc_strdup(dsec); - mpage->arch = mandoc_strdup(arch); - mpage->sform = sform; - mpage->dform = dform; - /* - * Add to unique identifier hash. - * Then if it's a source manual and we're going to use source in - * favour of catpages, add it to that hash. + * Manual page directories exist for each kernel + * architecture as returned by machine(1). + * However, many manuals only depend on the + * application architecture as returned by arch(1). + * For example, some (2/ARM) manuals are shared + * across the "armish" and "zaurus" kernel + * architectures. + * A few manuals are even shared across completely + * different architectures, for example fdformat(1) + * on amd64, i386, sparc, and sparc64. */ - inoadd(st, mpage); - fileadd(mpage); -} -static void -mpages_free(void) -{ - struct mpage *mpage; - unsigned int slot; - - mpage = ohash_first(&mpages, &slot); - while (NULL != mpage) { - free(mpage->name); - free(mpage->sec); - free(mpage->dsec); - free(mpage->arch); - free(mpage); - mpage = ohash_next(&mpages, &slot); + if (strcasecmp(mpage->arch, mlink->arch)) { + match = 0; + say(mlink->file, "Architecture \"%s\" manual in " + "\"%s\" directory", mpage->arch, mlink->arch); } + + if (strcasecmp(mpage->title, mlink->name)) + match = 0; + + return(match); } /* @@ -889,15 +949,13 @@ mpages_merge(struct mchars *mc, struct mparse *mp, int { struct ohash title_table; struct ohash_info title_info, str_info; - char buf[PATH_MAX]; struct mpage *mpage; + struct mlink *mlink; struct mdoc *mdoc; struct man *man; struct title *title_entry; - char *bufp, *title_str; - const char *msec, *march, *mtitle, *cp; - size_t sz; - int form; + char *title_str; + const char *cp; int match; unsigned int pslot, tslot; enum mandoclevel lvl; @@ -917,127 +975,83 @@ mpages_merge(struct mchars *mc, struct mparse *mp, int mpage = ohash_first(&mpages, &pslot); while (NULL != mpage) { - /* - * If we're a catpage (as defined by our path), then see - * if a manpage exists by the same name (ignoring the - * suffix). - * If it does, then we want to use it instead of our - * own. - */ - if ( ! use_all && FORM_CAT == mpage->dform) { - sz = strlcpy(buf, mpage->file, PATH_MAX); - if (sz >= PATH_MAX) { - if (warnings) - say(mpage->file, - "Filename too long"); - mpage = ohash_next(&mpages, &pslot); - continue; - } - bufp = strstr(buf, "cat"); - assert(NULL != bufp); - memcpy(bufp, "man", 3); - if (NULL != (bufp = strrchr(buf, '.'))) - *++bufp = '\0'; - strlcat(buf, mpage->dsec, PATH_MAX); - if (filecheck(buf)) { - if (warnings) - say(mpage->file, "Man " - "source exists: %s", buf); - mpage = ohash_next(&mpages, &pslot); - continue; - } + mlinks_undupe(mpage); + if (NULL == mpage->mlinks) { + mpage = ohash_next(&mpages, &pslot); + continue; } ohash_init(&strings, 6, &str_info); mparse_reset(mp); mdoc = NULL; man = NULL; - match = 1; /* * Try interpreting the file as mdoc(7) or man(7) * source code, unless it is already known to be * formatted. Fall back to formatted mode. */ - if (FORM_CAT != mpage->dform || FORM_CAT != mpage->sform) { - lvl = mparse_readfd(mp, -1, mpage->file); + if (FORM_CAT != mpage->mlinks->dform || + FORM_CAT != mpage->mlinks->fform) { + lvl = mparse_readfd(mp, -1, mpage->mlinks->file); if (lvl < MANDOCLEVEL_FATAL) mparse_result(mp, &mdoc, &man); } if (NULL != mdoc) { - form = 1; - msec = mdoc_meta(mdoc)->msec; - march = mdoc_meta(mdoc)->arch; - mtitle = mdoc_meta(mdoc)->title; + mpage->form = FORM_SRC; + mpage->sec = + mandoc_strdup(mdoc_meta(mdoc)->msec); + mpage->arch = mdoc_meta(mdoc)->arch; + mpage->arch = mandoc_strdup( + NULL == mpage->arch ? "" : mpage->arch); + mpage->title = + mandoc_strdup(mdoc_meta(mdoc)->title); } else if (NULL != man) { - form = 1; - msec = man_meta(man)->msec; - march = mpage->arch; - mtitle = man_meta(man)->title; + mpage->form = FORM_SRC; + mpage->sec = + mandoc_strdup(man_meta(man)->msec); + mpage->arch = + mandoc_strdup(mpage->mlinks->arch); + mpage->title = + mandoc_strdup(man_meta(man)->title); } else { - form = 0; - msec = mpage->dsec; - march = mpage->arch; - mtitle = mpage->name; + mpage->form = FORM_CAT; + mpage->sec = + mandoc_strdup(mpage->mlinks->dsec); + mpage->arch = + mandoc_strdup(mpage->mlinks->arch); + mpage->title = + mandoc_strdup(mpage->mlinks->name); } + putkey(mpage, mpage->sec, TYPE_sec); + putkey(mpage, mpage->arch, TYPE_arch); - if (NULL == msec) - msec = ""; - if (NULL == march) - march = ""; - if (NULL == mtitle) - mtitle = ""; - - /* - * Check whether the manual section given in a file - * agrees with the directory where the file is located. - * Some manuals have suffixes like (3p) on their - * section number either inside the file or in the - * directory name, some are linked into more than one - * section, like encrypt(1) = makekey(8). Do not skip - * manuals for such reasons. - */ - if (warnings && !use_all && form && - strcasecmp(msec, mpage->dsec)) { - match = 0; - say(mpage->file, "Section \"%s\" " - "manual in %s directory", - msec, mpage->dsec); + for (mlink = mpage->mlinks; mlink; mlink = mlink->next) { + if ('\0' != *mlink->dsec) + putkey(mpage, mlink->dsec, TYPE_sec); + if ('\0' != *mlink->fsec) + putkey(mpage, mlink->fsec, TYPE_sec); + putkey(mpage, mlink->arch, TYPE_arch); + putkey(mpage, mlink->name, TYPE_Nm); } - /* - * Manual page directories exist for each kernel - * architecture as returned by machine(1). - * However, many manuals only depend on the - * application architecture as returned by arch(1). - * For example, some (2/ARM) manuals are shared - * across the "armish" and "zaurus" kernel - * architectures. - * A few manuals are even shared across completely - * different architectures, for example fdformat(1) - * on amd64, i386, sparc, and sparc64. - * Thus, warn about architecture mismatches, - * but don't skip manuals for this reason. - */ - if (warnings && !use_all && strcasecmp(march, mpage->arch)) { + if (warnings && !use_all) { match = 0; - say(mpage->file, "Architecture \"%s\" " - "manual in \"%s\" directory", - march, mpage->arch); - } - if (warnings && !use_all && strcasecmp(mtitle, mpage->name)) - match = 0; + for (mlink = mpage->mlinks; mlink; + mlink = mlink->next) + if (mlink_check(mpage, mlink)) + match = 1; + } else + match = 1; - putkey(mpage, mpage->name, TYPE_Nm); - if (NULL != mdoc) { if (NULL != (cp = mdoc_meta(mdoc)->name)) putkey(mpage, cp, TYPE_Nm); assert(NULL == mpage->desc); parse_mdoc(mpage, mdoc_node(mdoc)); putkey(mpage, NULL != mpage->desc ? - mpage->desc : mpage->name, TYPE_Nd); + mpage->desc : mpage->mlinks->name, TYPE_Nd); } else if (NULL != man) parse_man(mpage, man_node(man)); else @@ -1050,8 +1064,10 @@ mpages_merge(struct mchars *mc, struct mparse *mp, int */ if (check_reachable) { - if (-1 == asprintf(&title_str, "%s(%s%s%s)", mtitle, - msec, '\0' == *march ? "" : "/", march)) { + if (-1 == asprintf(&title_str, "%s(%s%s%s)", + mpage->title, mpage->sec, + '\0' == *mpage->arch ? "" : "/", + mpage->arch)) { perror(NULL); exit((int)MANDOCLEVEL_SYSERR); } @@ -1062,7 +1078,7 @@ mpages_merge(struct mchars *mc, struct mparse *mp, int sizeof(struct title)); title_entry->title = title_str; title_entry->file = mandoc_strdup( - match ? "" : mpage->file); + match ? "" : mpage->mlinks->file); ohash_insert(&title_table, tslot, title_entry); } else { @@ -1072,7 +1088,7 @@ mpages_merge(struct mchars *mc, struct mparse *mp, int } } - dbindex(mc, form, mpage); + dbindex(mpage, mc); ohash_delete(&strings); mpage = ohash_next(&mpages, &pslot); } @@ -1100,9 +1116,9 @@ parse_cat(struct mpage *mpage) char *line, *p, *title; size_t len, plen, titlesz; - if (NULL == (stream = fopen(mpage->file, "r"))) { + if (NULL == (stream = fopen(mpage->mlinks->file, "r"))) { if (warnings) - say(mpage->file, NULL); + say(mpage->mlinks->file, NULL); return; } @@ -1155,10 +1171,11 @@ parse_cat(struct mpage *mpage) if (NULL == title || '\0' == *title) { if (warnings) - say(mpage->file, "Cannot find NAME section"); + say(mpage->mlinks->file, + "Cannot find NAME section"); assert(NULL == mpage->desc); - mpage->desc = mandoc_strdup(mpage->name); - putkey(mpage, mpage->name, TYPE_Nd); + mpage->desc = mandoc_strdup(mpage->mlinks->name); + putkey(mpage, mpage->mlinks->name, TYPE_Nd); fclose(stream); free(title); return; @@ -1178,7 +1195,8 @@ parse_cat(struct mpage *mpage) /* Skip to next word. */ ; } else { if (warnings) - say(mpage->file, "No dash in title line"); + say(mpage->mlinks->file, + "No dash in title line"); p = title; } @@ -1449,21 +1467,10 @@ parse_mdoc_Fd(struct mpage *mpage, const struct mdoc_n if (end > start) putkeys(mpage, start, end - start + 1, TYPE_In); - return(1); + return(0); } static int -parse_mdoc_In(struct mpage *mpage, const struct mdoc_node *n) -{ - - if (NULL != n->child && MDOC_TEXT == n->child->type) - return(0); - - putkey(mpage, n->child->string, TYPE_In); - return(1); -} - -static int parse_mdoc_Fn(struct mpage *mpage, const struct mdoc_node *n) { const char *cp; @@ -1497,17 +1504,6 @@ parse_mdoc_Fn(struct mpage *mpage, const struct mdoc_n } static int -parse_mdoc_St(struct mpage *mpage, const struct mdoc_node *n) -{ - - if (NULL == n->child || MDOC_TEXT != n->child->type) - return(0); - - putkey(mpage, n->child->string, TYPE_St); - return(1); -} - -static int parse_mdoc_Xr(struct mpage *mpage, const struct mdoc_node *n) { char *cp; @@ -1564,12 +1560,8 @@ static int parse_mdoc_Nm(struct mpage *mpage, const struct mdoc_node *n) { - if (SEC_NAME == n->sec) - return(1); - else if (SEC_SYNOPSIS != n->sec || MDOC_HEAD != n->type) - return(0); - - return(1); + return(SEC_NAME == n->sec || + (SEC_SYNOPSIS == n->sec && MDOC_HEAD == n->type)); } static int @@ -1678,11 +1670,11 @@ utf8(unsigned int cp, char out[7]) } /* - * Store the UTF-8 version of a key, or alias the pointer if the key has - * no UTF-8 transcription marks in it. + * Store the rendered version of a key, or alias the pointer + * if the key contains no escape sequences. */ static void -utf8key(struct mchars *mc, struct str *key) +render_key(struct mchars *mc, struct str *key) { size_t sz, bsz, pos; char utfbuf[7], res[5]; @@ -1691,7 +1683,7 @@ utf8key(struct mchars *mc, struct str *key) int len, u; enum mandoc_esc esc; - assert(NULL == key->utf8); + assert(NULL == key->rendered); res[0] = '\\'; res[1] = '\t'; @@ -1707,7 +1699,7 @@ utf8key(struct mchars *mc, struct str *key) * pointer as ourselvse and get out of here. */ if (strcspn(val, res) == bsz) { - key->utf8 = key->key; + key->rendered = key->key; return; } @@ -1742,54 +1734,63 @@ utf8key(struct mchars *mc, struct str *key) /* Read past the slash. */ val++; - u = 0; /* * Parse the escape sequence and see if it's a * predefined character or special character. */ + esc = mandoc_escape ((const char **)&val, &seq, &len); if (ESCAPE_ERROR == esc) break; - if (ESCAPE_SPECIAL != esc) continue; - if (0 == (u = mchars_spec2cp(mc, seq, len))) - continue; /* - * If we have a Unicode codepoint, try to convert that - * to a UTF-8 byte string. + * Render the special character + * as either UTF-8 or ASCII. */ - cpp = utfbuf; - if (0 == (sz = utf8(u, utfbuf))) - continue; + if (write_utf8) { + if (0 == (u = mchars_spec2cp(mc, seq, len))) + continue; + cpp = utfbuf; + if (0 == (sz = utf8(u, utfbuf))) + continue; + sz = strlen(cpp); + } else { + cpp = mchars_spec2str(mc, seq, len, &sz); + if (NULL == cpp) + continue; + if (ASCII_NBRSP == *cpp) { + cpp = " "; + sz = 1; + } + } + /* Copy the rendered glyph into the stream. */ - sz = strlen(cpp); bsz += sz; - buf = mandoc_realloc(buf, bsz); - memcpy(&buf[pos], cpp, sz); pos += sz; } buf[pos] = '\0'; - key->utf8 = buf; + key->rendered = buf; } /* * Flush the current page's terms (and their bits) into the database. * Wrap the entire set of additions in a transaction to make sqlite be a * little faster. - * Also, UTF-8-encode the description at the last possible moment. + * Also, handle escape sequences at the last possible moment. */ static void -dbindex(struct mchars *mc, int form, const struct mpage *mpage) +dbindex(const struct mpage *mpage, struct mchars *mc) { + struct mlink *mlink; struct str *key; const char *desc; int64_t recno; @@ -1797,7 +1798,7 @@ dbindex(struct mchars *mc, int form, const struct mpag unsigned int slot; if (verb) - say(mpage->file, "Adding to index"); + say(mpage->mlinks->file, "Adding to index"); if (nodb) return; @@ -1807,9 +1808,9 @@ dbindex(struct mchars *mc, int form, const struct mpag key = ohash_find(&strings, ohash_qlookup(&strings, mpage->desc)); assert(NULL != key); - if (NULL == key->utf8) - utf8key(mc, key); - desc = key->utf8; + if (NULL == key->rendered) + render_key(mc, key); + desc = key->rendered; } SQL_EXEC("BEGIN TRANSACTION"); @@ -1820,36 +1821,39 @@ dbindex(struct mchars *mc, int form, const struct mpag * and only kept for backward compatibility * until apropos(1) and friends have caught up. */ - SQL_BIND_TEXT(stmts[STMT_INSERT_PAGE], i, mpage->file); - SQL_BIND_TEXT(stmts[STMT_INSERT_PAGE], i, mpage->sec); - SQL_BIND_TEXT(stmts[STMT_INSERT_PAGE], i, mpage->arch); + SQL_BIND_TEXT(stmts[STMT_INSERT_PAGE], i, mpage->mlinks->file); + SQL_BIND_TEXT(stmts[STMT_INSERT_PAGE], i, mpage->mlinks->dsec); + SQL_BIND_TEXT(stmts[STMT_INSERT_PAGE], i, mpage->mlinks->arch); SQL_BIND_TEXT(stmts[STMT_INSERT_PAGE], i, desc); - SQL_BIND_INT(stmts[STMT_INSERT_PAGE], i, form); + SQL_BIND_INT(stmts[STMT_INSERT_PAGE], i, FORM_SRC == mpage->form); SQL_STEP(stmts[STMT_INSERT_PAGE]); recno = sqlite3_last_insert_rowid(db); sqlite3_reset(stmts[STMT_INSERT_PAGE]); - i = 1; - SQL_BIND_TEXT(stmts[STMT_INSERT_LINK], i, mpage->sec); - SQL_BIND_TEXT(stmts[STMT_INSERT_LINK], i, mpage->arch); - SQL_BIND_TEXT(stmts[STMT_INSERT_LINK], i, mpage->file); - SQL_BIND_INT64(stmts[STMT_INSERT_LINK], i, recno); - SQL_STEP(stmts[STMT_INSERT_LINK]); - sqlite3_reset(stmts[STMT_INSERT_LINK]); + for (mlink = mpage->mlinks; mlink; mlink = mlink->next) { + i = 1; + SQL_BIND_TEXT(stmts[STMT_INSERT_LINK], i, mlink->file); + SQL_BIND_TEXT(stmts[STMT_INSERT_LINK], i, mlink->dsec); + SQL_BIND_TEXT(stmts[STMT_INSERT_LINK], i, mlink->arch); + SQL_BIND_TEXT(stmts[STMT_INSERT_LINK], i, mlink->name); + SQL_BIND_INT64(stmts[STMT_INSERT_LINK], i, recno); + SQL_STEP(stmts[STMT_INSERT_LINK]); + sqlite3_reset(stmts[STMT_INSERT_LINK]); + } for (key = ohash_first(&strings, &slot); NULL != key; key = ohash_next(&strings, &slot)) { assert(key->mpage == mpage); - if (NULL == key->utf8) - utf8key(mc, key); + if (NULL == key->rendered) + render_key(mc, key); i = 1; SQL_BIND_INT64(stmts[STMT_INSERT_KEY], i, key->mask); - SQL_BIND_TEXT(stmts[STMT_INSERT_KEY], i, key->utf8); + SQL_BIND_TEXT(stmts[STMT_INSERT_KEY], i, key->rendered); SQL_BIND_INT64(stmts[STMT_INSERT_KEY], i, recno); SQL_STEP(stmts[STMT_INSERT_KEY]); sqlite3_reset(stmts[STMT_INSERT_KEY]); - if (key->utf8 != key->key) - free(key->utf8); + if (key->rendered != key->key) + free(key->rendered); free(key); } @@ -1860,6 +1864,7 @@ static void dbprune(void) { struct mpage *mpage; + struct mlink *mlink; size_t i; unsigned int slot; @@ -1868,12 +1873,13 @@ dbprune(void) mpage = ohash_first(&mpages, &slot); while (NULL != mpage) { + mlink = mpage->mlinks; i = 1; - SQL_BIND_TEXT(stmts[STMT_DELETE_PAGE], i, mpage->file); + SQL_BIND_TEXT(stmts[STMT_DELETE_PAGE], i, mlink->file); SQL_STEP(stmts[STMT_DELETE_PAGE]); sqlite3_reset(stmts[STMT_DELETE_PAGE]); if (verb) - say(mpage->file, "Deleted from index"); + say(mlink->file, "Deleted from index"); mpage = ohash_next(&mpages, &slot); } } @@ -1969,6 +1975,7 @@ dbopen(int real) ");\n" "\n" "CREATE TABLE \"mlinks\" (\n" + " \"file\" TEXT NOT NULL,\n" " \"sec\" TEXT NOT NULL,\n" " \"arch\" TEXT NOT NULL,\n" " \"name\" TEXT NOT NULL,\n" @@ -2001,7 +2008,7 @@ prepare_statements: "(file,sec,arch,desc,form) VALUES (?,?,?,?,?)"; sqlite3_prepare_v2(db, sql, -1, &stmts[STMT_INSERT_PAGE], NULL); sql = "INSERT INTO mlinks " - "(sec,arch,name,pageid) VALUES (?,?,?,?)"; + "(file,sec,arch,name,pageid) VALUES (?,?,?,?,?)"; sqlite3_prepare_v2(db, sql, -1, &stmts[STMT_INSERT_LINK], NULL); sql = "INSERT INTO keys " "(bits,key,pageid) VALUES (?,?,?)";