=================================================================== RCS file: /cvs/mandoc/mandocdb.c,v retrieving revision 1.66 retrieving revision 1.74 diff -u -p -r1.66 -r1.74 --- mandoc/mandocdb.c 2013/06/07 01:01:34 1.66 +++ mandoc/mandocdb.c 2013/10/27 16:09:44 1.74 @@ -1,4 +1,4 @@ -/* $Id: mandocdb.c,v 1.66 2013/06/07 01:01:34 schwarze Exp $ */ +/* $Id: mandocdb.c,v 1.74 2013/10/27 16:09:44 schwarze Exp $ */ /* * Copyright (c) 2011, 2012 Kristaps Dzonsons * Copyright (c) 2011, 2012, 2013 Ingo Schwarze @@ -106,6 +106,11 @@ struct of { char *arch; /* path-cued arch. (or empty) */ }; +struct title { + char *title; /* name(sec/arch) given inside the file */ + char *file; /* file name in case of mismatch */ +}; + enum stmt { STMT_DELETE = 0, /* delete manpage */ STMT_INSERT_DOC, /* insert manpage */ @@ -118,8 +123,6 @@ typedef int (*mdoc_fp)(struct of *, const struct mdoc_ struct mdoc_handler { mdoc_fp fp; /* optional handler */ uint64_t mask; /* set unless handler returns 0 */ - int flags; /* for use by pmdoc_node */ -#define MDOCF_CHILD 0x01 /* automatically index child nodes */ }; static void dbclose(int); @@ -137,8 +140,7 @@ 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 offree(void); -static void ofmerge(struct mchars *, struct mparse *, - struct ohash_info*); +static void ofmerge(struct mchars *, struct mparse *, int); static void parse_catpage(struct of *); static void parse_man(struct of *, const struct man_node *); static void parse_mdoc(struct of *, const struct mdoc_node *); @@ -180,128 +182,128 @@ static sqlite3 *db = NULL; /* current database */ static sqlite3_stmt *stmts[STMT__MAX]; /* current statements */ static const struct mdoc_handler mdocs[MDOC_MAX] = { - { NULL, 0, 0 }, /* Ap */ - { NULL, 0, 0 }, /* Dd */ - { NULL, 0, 0 }, /* Dt */ - { NULL, 0, 0 }, /* Os */ - { parse_mdoc_Sh, TYPE_Sh, MDOCF_CHILD }, /* Sh */ - { parse_mdoc_head, TYPE_Ss, MDOCF_CHILD }, /* Ss */ - { NULL, 0, 0 }, /* Pp */ - { NULL, 0, 0 }, /* D1 */ - { NULL, 0, 0 }, /* Dl */ - { NULL, 0, 0 }, /* Bd */ - { NULL, 0, 0 }, /* Ed */ - { NULL, 0, 0 }, /* Bl */ - { NULL, 0, 0 }, /* El */ - { NULL, 0, 0 }, /* It */ - { NULL, 0, 0 }, /* Ad */ - { NULL, TYPE_An, MDOCF_CHILD }, /* An */ - { NULL, TYPE_Ar, MDOCF_CHILD }, /* Ar */ - { NULL, TYPE_Cd, MDOCF_CHILD }, /* Cd */ - { NULL, TYPE_Cm, MDOCF_CHILD }, /* Cm */ - { NULL, TYPE_Dv, MDOCF_CHILD }, /* Dv */ - { NULL, TYPE_Er, MDOCF_CHILD }, /* Er */ - { NULL, TYPE_Ev, MDOCF_CHILD }, /* Ev */ - { NULL, 0, 0 }, /* Ex */ - { NULL, TYPE_Fa, MDOCF_CHILD }, /* Fa */ - { parse_mdoc_Fd, TYPE_In, 0 }, /* Fd */ - { NULL, TYPE_Fl, MDOCF_CHILD }, /* Fl */ - { parse_mdoc_Fn, 0, 0 }, /* Fn */ - { NULL, TYPE_Ft, MDOCF_CHILD }, /* Ft */ - { NULL, TYPE_Ic, MDOCF_CHILD }, /* Ic */ - { parse_mdoc_In, TYPE_In, MDOCF_CHILD }, /* In */ - { NULL, TYPE_Li, MDOCF_CHILD }, /* Li */ - { parse_mdoc_Nd, TYPE_Nd, MDOCF_CHILD }, /* Nd */ - { parse_mdoc_Nm, TYPE_Nm, MDOCF_CHILD }, /* Nm */ - { NULL, 0, 0 }, /* Op */ - { NULL, 0, 0 }, /* Ot */ - { NULL, TYPE_Pa, MDOCF_CHILD }, /* Pa */ - { NULL, 0, 0 }, /* Rv */ - { parse_mdoc_St, TYPE_St, 0 }, /* St */ - { NULL, TYPE_Va, MDOCF_CHILD }, /* Va */ - { parse_mdoc_body, TYPE_Va, MDOCF_CHILD }, /* Vt */ - { parse_mdoc_Xr, TYPE_Xr, 0 }, /* Xr */ - { NULL, 0, 0 }, /* %A */ - { NULL, 0, 0 }, /* %B */ - { NULL, 0, 0 }, /* %D */ - { NULL, 0, 0 }, /* %I */ - { NULL, 0, 0 }, /* %J */ - { NULL, 0, 0 }, /* %N */ - { NULL, 0, 0 }, /* %O */ - { NULL, 0, 0 }, /* %P */ - { NULL, 0, 0 }, /* %R */ - { NULL, 0, 0 }, /* %T */ - { NULL, 0, 0 }, /* %V */ - { NULL, 0, 0 }, /* Ac */ - { NULL, 0, 0 }, /* Ao */ - { NULL, 0, 0 }, /* Aq */ - { NULL, TYPE_At, MDOCF_CHILD }, /* At */ - { NULL, 0, 0 }, /* Bc */ - { NULL, 0, 0 }, /* Bf */ - { NULL, 0, 0 }, /* Bo */ - { NULL, 0, 0 }, /* Bq */ - { NULL, TYPE_Bsx, MDOCF_CHILD }, /* Bsx */ - { NULL, TYPE_Bx, MDOCF_CHILD }, /* Bx */ - { NULL, 0, 0 }, /* Db */ - { NULL, 0, 0 }, /* Dc */ - { NULL, 0, 0 }, /* Do */ - { NULL, 0, 0 }, /* Dq */ - { NULL, 0, 0 }, /* Ec */ - { NULL, 0, 0 }, /* Ef */ - { NULL, TYPE_Em, MDOCF_CHILD }, /* Em */ - { NULL, 0, 0 }, /* Eo */ - { NULL, TYPE_Fx, MDOCF_CHILD }, /* Fx */ - { NULL, TYPE_Ms, MDOCF_CHILD }, /* Ms */ - { NULL, 0, 0 }, /* No */ - { NULL, 0, 0 }, /* Ns */ - { NULL, TYPE_Nx, MDOCF_CHILD }, /* Nx */ - { NULL, TYPE_Ox, MDOCF_CHILD }, /* Ox */ - { NULL, 0, 0 }, /* Pc */ - { NULL, 0, 0 }, /* Pf */ - { NULL, 0, 0 }, /* Po */ - { NULL, 0, 0 }, /* Pq */ - { NULL, 0, 0 }, /* Qc */ - { NULL, 0, 0 }, /* Ql */ - { NULL, 0, 0 }, /* Qo */ - { NULL, 0, 0 }, /* Qq */ - { NULL, 0, 0 }, /* Re */ - { NULL, 0, 0 }, /* Rs */ - { NULL, 0, 0 }, /* Sc */ - { NULL, 0, 0 }, /* So */ - { NULL, 0, 0 }, /* Sq */ - { NULL, 0, 0 }, /* Sm */ - { NULL, 0, 0 }, /* Sx */ - { NULL, TYPE_Sy, MDOCF_CHILD }, /* Sy */ - { NULL, TYPE_Tn, MDOCF_CHILD }, /* Tn */ - { NULL, 0, 0 }, /* Ux */ - { NULL, 0, 0 }, /* Xc */ - { NULL, 0, 0 }, /* Xo */ - { parse_mdoc_head, TYPE_Fn, 0 }, /* Fo */ - { NULL, 0, 0 }, /* Fc */ - { NULL, 0, 0 }, /* Oo */ - { NULL, 0, 0 }, /* Oc */ - { NULL, 0, 0 }, /* Bk */ - { NULL, 0, 0 }, /* Ek */ - { NULL, 0, 0 }, /* Bt */ - { NULL, 0, 0 }, /* Hf */ - { NULL, 0, 0 }, /* Fr */ - { NULL, 0, 0 }, /* Ud */ - { NULL, TYPE_Lb, MDOCF_CHILD }, /* Lb */ - { NULL, 0, 0 }, /* Lp */ - { NULL, TYPE_Lk, MDOCF_CHILD }, /* Lk */ - { NULL, TYPE_Mt, MDOCF_CHILD }, /* Mt */ - { NULL, 0, 0 }, /* Brq */ - { NULL, 0, 0 }, /* Bro */ - { NULL, 0, 0 }, /* Brc */ - { NULL, 0, 0 }, /* %C */ - { NULL, 0, 0 }, /* Es */ - { NULL, 0, 0 }, /* En */ - { NULL, TYPE_Dx, MDOCF_CHILD }, /* Dx */ - { NULL, 0, 0 }, /* %Q */ - { NULL, 0, 0 }, /* br */ - { NULL, 0, 0 }, /* sp */ - { NULL, 0, 0 }, /* %U */ - { NULL, 0, 0 }, /* Ta */ + { NULL, 0 }, /* Ap */ + { NULL, 0 }, /* Dd */ + { NULL, 0 }, /* Dt */ + { NULL, 0 }, /* Os */ + { parse_mdoc_Sh, TYPE_Sh }, /* Sh */ + { parse_mdoc_head, TYPE_Ss }, /* Ss */ + { NULL, 0 }, /* Pp */ + { NULL, 0 }, /* D1 */ + { NULL, 0 }, /* Dl */ + { NULL, 0 }, /* Bd */ + { NULL, 0 }, /* Ed */ + { NULL, 0 }, /* Bl */ + { NULL, 0 }, /* El */ + { NULL, 0 }, /* It */ + { NULL, 0 }, /* Ad */ + { NULL, TYPE_An }, /* An */ + { NULL, TYPE_Ar }, /* Ar */ + { NULL, TYPE_Cd }, /* Cd */ + { NULL, TYPE_Cm }, /* Cm */ + { NULL, TYPE_Dv }, /* Dv */ + { NULL, TYPE_Er }, /* Er */ + { NULL, TYPE_Ev }, /* Ev */ + { NULL, 0 }, /* Ex */ + { NULL, TYPE_Fa }, /* Fa */ + { parse_mdoc_Fd, 0 }, /* Fd */ + { NULL, TYPE_Fl }, /* Fl */ + { parse_mdoc_Fn, 0 }, /* Fn */ + { NULL, TYPE_Ft }, /* Ft */ + { NULL, TYPE_Ic }, /* Ic */ + { parse_mdoc_In, TYPE_In }, /* In */ + { NULL, TYPE_Li }, /* Li */ + { parse_mdoc_Nd, TYPE_Nd }, /* Nd */ + { parse_mdoc_Nm, TYPE_Nm }, /* Nm */ + { NULL, 0 }, /* Op */ + { NULL, 0 }, /* Ot */ + { NULL, TYPE_Pa }, /* Pa */ + { NULL, 0 }, /* Rv */ + { parse_mdoc_St, 0 }, /* St */ + { NULL, TYPE_Va }, /* Va */ + { parse_mdoc_body, TYPE_Va }, /* Vt */ + { parse_mdoc_Xr, 0 }, /* Xr */ + { NULL, 0 }, /* %A */ + { NULL, 0 }, /* %B */ + { NULL, 0 }, /* %D */ + { NULL, 0 }, /* %I */ + { NULL, 0 }, /* %J */ + { NULL, 0 }, /* %N */ + { NULL, 0 }, /* %O */ + { NULL, 0 }, /* %P */ + { NULL, 0 }, /* %R */ + { NULL, 0 }, /* %T */ + { NULL, 0 }, /* %V */ + { NULL, 0 }, /* Ac */ + { NULL, 0 }, /* Ao */ + { NULL, 0 }, /* Aq */ + { NULL, TYPE_At }, /* At */ + { NULL, 0 }, /* Bc */ + { NULL, 0 }, /* Bf */ + { NULL, 0 }, /* Bo */ + { NULL, 0 }, /* Bq */ + { NULL, TYPE_Bsx }, /* Bsx */ + { NULL, TYPE_Bx }, /* Bx */ + { NULL, 0 }, /* Db */ + { NULL, 0 }, /* Dc */ + { NULL, 0 }, /* Do */ + { NULL, 0 }, /* Dq */ + { NULL, 0 }, /* Ec */ + { NULL, 0 }, /* Ef */ + { NULL, TYPE_Em }, /* Em */ + { NULL, 0 }, /* Eo */ + { NULL, TYPE_Fx }, /* Fx */ + { NULL, TYPE_Ms }, /* Ms */ + { NULL, 0 }, /* No */ + { NULL, 0 }, /* Ns */ + { NULL, TYPE_Nx }, /* Nx */ + { NULL, TYPE_Ox }, /* Ox */ + { NULL, 0 }, /* Pc */ + { NULL, 0 }, /* Pf */ + { NULL, 0 }, /* Po */ + { NULL, 0 }, /* Pq */ + { NULL, 0 }, /* Qc */ + { NULL, 0 }, /* Ql */ + { NULL, 0 }, /* Qo */ + { NULL, 0 }, /* Qq */ + { NULL, 0 }, /* Re */ + { NULL, 0 }, /* Rs */ + { NULL, 0 }, /* Sc */ + { NULL, 0 }, /* So */ + { NULL, 0 }, /* Sq */ + { NULL, 0 }, /* Sm */ + { NULL, 0 }, /* Sx */ + { NULL, TYPE_Sy }, /* Sy */ + { NULL, TYPE_Tn }, /* Tn */ + { NULL, 0 }, /* Ux */ + { NULL, 0 }, /* Xc */ + { NULL, 0 }, /* Xo */ + { parse_mdoc_head, 0 }, /* Fo */ + { NULL, 0 }, /* Fc */ + { NULL, 0 }, /* Oo */ + { NULL, 0 }, /* Oc */ + { NULL, 0 }, /* Bk */ + { NULL, 0 }, /* Ek */ + { NULL, 0 }, /* Bt */ + { NULL, 0 }, /* Hf */ + { NULL, 0 }, /* Fr */ + { NULL, 0 }, /* Ud */ + { NULL, TYPE_Lb }, /* Lb */ + { NULL, 0 }, /* Lp */ + { NULL, TYPE_Lk }, /* Lk */ + { NULL, TYPE_Mt }, /* Mt */ + { NULL, 0 }, /* Brq */ + { NULL, 0 }, /* Bro */ + { NULL, 0 }, /* Brc */ + { NULL, 0 }, /* %C */ + { NULL, 0 }, /* Es */ + { NULL, 0 }, /* En */ + { NULL, TYPE_Dx }, /* Dx */ + { NULL, 0 }, /* %Q */ + { NULL, 0 }, /* br */ + { NULL, 0 }, /* sp */ + { NULL, 0 }, /* %U */ + { NULL, 0 }, /* Ta */ }; int @@ -313,21 +315,17 @@ main(int argc, char *argv[]) struct mchars *mc; struct manpaths dirs; struct mparse *mp; - struct ohash_info ino_info, filename_info, str_info; + struct ohash_info ino_info, filename_info; memset(stmts, 0, STMT__MAX * sizeof(sqlite3_stmt *)); memset(&dirs, 0, sizeof(struct manpaths)); - ino_info.halloc = filename_info.halloc = - str_info.halloc = hash_halloc; - ino_info.hfree = filename_info.hfree = - str_info.hfree = hash_free; - ino_info.alloc = filename_info.alloc = - str_info.alloc = hash_alloc; + ino_info.alloc = filename_info.alloc = hash_alloc; + ino_info.halloc = filename_info.halloc = hash_halloc; + ino_info.hfree = filename_info.hfree = hash_free; ino_info.key_offset = offsetof(struct of, id); filename_info.key_offset = offsetof(struct of, file); - str_info.key_offset = offsetof(struct str, key); progname = strrchr(argv[0], '/'); if (progname == NULL) @@ -424,7 +422,7 @@ main(int argc, char *argv[]) if (OP_TEST != op) dbprune(); if (OP_DELETE != op) - ofmerge(mc, mp, &str_info); + ofmerge(mc, mp, 0); dbclose(1); } else { /* @@ -442,9 +440,8 @@ main(int argc, char *argv[]) manpath_parse(&dirs, path_arg, NULL, NULL); /* - * First scan the tree rooted at a base directory. - * Then whak its database (if one exists), parse, and - * build up the database. + * First scan the tree rooted at a base directory, then + * build a new database and finally move it into place. * Ignore zero-length directories and strip trailing * slashes. */ @@ -469,16 +466,7 @@ main(int argc, char *argv[]) if (0 == dbopen(0)) goto out; - /* - * Since we're opening up a new database, we can - * turn off synchronous mode for much better - * performance. - */ -#ifndef __APPLE__ - SQL_EXEC("PRAGMA synchronous = OFF"); -#endif - - ofmerge(mc, mp, &str_info); + ofmerge(mc, mp, warnings && !use_all); dbclose(0); if (j + 1 < dirs.sz) { @@ -697,7 +685,7 @@ filescan(const char *file) exitcode = (int)MANDOCLEVEL_BADARG; say(file, NULL); return; - } else if (strstr(buf, basedir) != buf) { + } else if (OP_TEST != op && strstr(buf, basedir) != buf) { exitcode = (int)MANDOCLEVEL_BADARG; say("", "%s: outside base directory", buf); return; @@ -848,13 +836,13 @@ ofadd(int dform, const char *file, const char *name, c if (NULL == arch) arch = ""; - sform = FORM_NONE; - if (NULL != sec && *sec <= '9' && *sec >= '1') - sform = FORM_SRC; - else if (NULL != sec && *sec == '0') { + if ('0' == *sec) { sec = dsec; sform = FORM_CAT; - } + } else if ('1' <= *sec && '9' >= *sec) + sform = FORM_SRC; + else + sform = FORM_NONE; of = mandoc_calloc(1, sizeof(struct of)); strlcpy(of->file, file, PATH_MAX); @@ -899,19 +887,36 @@ offree(void) * and filename to determine whether the file is parsable or not. */ static void -ofmerge(struct mchars *mc, struct mparse *mp, - struct ohash_info *infop) +ofmerge(struct mchars *mc, struct mparse *mp, int check_reachable) { - int form; - size_t sz; - struct mdoc *mdoc; - struct man *man; - char buf[PATH_MAX]; - char *bufp; - const char *msec, *march, *mtitle, *cp; - struct of *of; - enum mandoclevel lvl; + struct ohash title_table; + struct ohash_info title_info, str_info; + char buf[PATH_MAX]; + struct of *of; + 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; + int match; + unsigned int slot; + enum mandoclevel lvl; + str_info.alloc = hash_alloc; + str_info.halloc = hash_halloc; + str_info.hfree = hash_free; + str_info.key_offset = offsetof(struct str, key); + + if (check_reachable) { + title_info.alloc = hash_alloc; + title_info.halloc = hash_halloc; + title_info.hfree = hash_free; + title_info.key_offset = offsetof(struct title, title); + ohash_init(&title_table, 6, &title_info); + } + for (of = ofs; NULL != of; of = of->next) { /* * If we're a catpage (as defined by our path), then see @@ -941,7 +946,7 @@ ofmerge(struct mchars *mc, struct mparse *mp, } } - ohash_init(&strings, 6, infop); + ohash_init(&strings, 6, &str_info); mparse_reset(mp); mdoc = NULL; man = NULL; @@ -949,6 +954,7 @@ ofmerge(struct mchars *mc, struct mparse *mp, msec = of->dsec; march = of->arch; mtitle = of->name; + match = 1; /* * Try interpreting the file as mdoc(7) or man(7) @@ -990,10 +996,12 @@ ofmerge(struct mchars *mc, struct mparse *mp, * manuals for such reasons. */ if (warnings && !use_all && form && - strcasecmp(msec, of->dsec)) + strcasecmp(msec, of->dsec)) { + match = 0; say(of->file, "Section \"%s\" " "manual in %s directory", msec, of->dsec); + } /* * Manual page directories exist for each kernel @@ -1009,10 +1017,14 @@ ofmerge(struct mchars *mc, struct mparse *mp, * Thus, warn about architecture mismatches, * but don't skip manuals for this reason. */ - if (warnings && !use_all && strcasecmp(march, of->arch)) + if (warnings && !use_all && strcasecmp(march, of->arch)) { + match = 0; say(of->file, "Architecture \"%s\" " "manual in \"%s\" directory", march, of->arch); + } + if (warnings && !use_all && strcasecmp(mtitle, of->name)) + match = 0; putkey(of, of->name, TYPE_Nm); @@ -1028,9 +1040,53 @@ ofmerge(struct mchars *mc, struct mparse *mp, else parse_catpage(of); + /* + * Build a title string for the file. If it matches + * the location of the file, remember the title as + * found; else, remember it as missing. + */ + + if (check_reachable) { + if (-1 == asprintf(&title_str, "%s(%s%s%s)", mtitle, + msec, '\0' == *march ? "" : "/", march)) { + perror(NULL); + exit((int)MANDOCLEVEL_SYSERR); + } + slot = ohash_qlookup(&title_table, title_str); + title_entry = ohash_find(&title_table, slot); + if (NULL == title_entry) { + title_entry = mandoc_malloc( + sizeof(struct title)); + title_entry->title = title_str; + title_entry->file = mandoc_strdup( + match ? "" : of->file); + ohash_insert(&title_table, slot, + title_entry); + } else { + if (match) + *title_entry->file = '\0'; + free(title_str); + } + } + dbindex(mc, form, of); ohash_delete(&strings); } + + if (check_reachable) { + title_entry = ohash_first(&title_table, &slot); + while (NULL != title_entry) { + if ('\0' != *title_entry->file) + say(title_entry->file, + "Probably unreachable, title is %s", + title_entry->title); + free(title_entry->title); + free(title_entry->file); + free(title_entry); + title_entry = ohash_next(&title_table, &slot); + } + ohash_delete(&title_table); + } } static void @@ -1332,8 +1388,7 @@ parse_mdoc(struct of *of, const struct mdoc_node *n) if (NULL != mdocs[n->tok].fp) if (0 == (*mdocs[n->tok].fp)(of, n)) break; - - if (MDOCF_CHILD & mdocs[n->tok].flags) + if (mdocs[n->tok].mask) putmdockey(of, n->child, mdocs[n->tok].mask); break; default: @@ -1446,12 +1501,23 @@ parse_mdoc_St(struct of *of, const struct mdoc_node *n static int parse_mdoc_Xr(struct of *of, const struct mdoc_node *n) { + char *cp; if (NULL == (n = n->child)) return(0); - putkey(of, n->string, TYPE_Xr); - return(1); + if (NULL == n->next) { + putkey(of, n->string, TYPE_Xr); + return(0); + } + + if (-1 == asprintf(&cp, "%s(%s)", n->string, n->next->string)) { + perror(NULL); + exit((int)MANDOCLEVEL_SYSERR); + } + putkey(of, cp, TYPE_Xr); + free(cp); + return(0); } static int @@ -1726,7 +1792,7 @@ dbindex(struct mchars *mc, int form, const struct of * return; desc = ""; - if (NULL != of->desc) { + if (NULL != of->desc && '\0' != *of->desc) { key = ohash_find(&strings, ohash_qlookup(&strings, of->desc)); assert(NULL != key); @@ -1896,6 +1962,17 @@ prepare_statements: sql = "INSERT INTO keys " "(bits,key,docid) VALUES (?,?,?)"; sqlite3_prepare_v2(db, sql, -1, &stmts[STMT_INSERT_KEY], NULL); + +#ifndef __APPLE__ + /* + * When opening a new database, we can turn off + * synchronous mode for much better performance. + */ + + if (real) + SQL_EXEC("PRAGMA synchronous = OFF"); +#endif + return(1); }