]> git.cameronkatri.com Git - mandoc.git/blobdiff - mansearch.c
Clean up eqn(7) error handling:
[mandoc.git] / mansearch.c
index eec5ff132be318febfdfbdaecf00a22bbb777c59..a4d40544c7bf8e123c4e2a364d9ee6e1548f9585 100644 (file)
@@ -1,7 +1,7 @@
-/*     $Id: mansearch.c,v 1.35 2014/04/23 16:34:50 schwarze Exp $ */
+/*     $Id: mansearch.c,v 1.53 2015/01/20 18:21:18 schwarze Exp $ */
 /*
  * Copyright (c) 2012 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2013, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
-#ifdef HAVE_CONFIG_H
 #include "config.h"
-#endif
 
 #include <sys/mman.h>
+#include <sys/types.h>
+
 #include <assert.h>
+#include <errno.h>
 #include <fcntl.h>
 #include <getopt.h>
 #include <limits.h>
 #include <string.h>
 #include <unistd.h>
 
-#ifdef HAVE_OHASH
+#if HAVE_OHASH
 #include <ohash.h>
 #else
 #include "compat_ohash.h"
 #endif
 #include <sqlite3.h>
+#ifndef SQLITE_DETERMINISTIC
+#define SQLITE_DETERMINISTIC 0
+#endif
 
 #include "mandoc.h"
 #include "mandoc_aux.h"
@@ -64,35 +68,37 @@ extern const char *const mansearch_keynames[];
        } while (0)
 
 struct expr {
-       uint64_t         bits;    /* type-mask */
-       const char      *substr;  /* to search for, if applicable */
        regex_t          regexp;  /* compiled regexp, if applicable */
+       const char      *substr;  /* to search for, if applicable */
+       struct expr     *next;    /* next in sequence */
+       uint64_t         bits;    /* type-mask */
+       int              equal;   /* equality, not subsring match */
        int              open;    /* opening parentheses before */
        int              and;     /* logical AND before */
        int              close;   /* closing parentheses after */
-       struct expr     *next;    /* next in sequence */
 };
 
 struct match {
        uint64_t         pageid; /* identifier in database */
+       uint64_t         bits; /* name type mask */
        char            *desc; /* manual page description */
-       int              form; /* 0 == catpage */
+       int              form; /* bit field: formatted, zipped? */
 };
 
-static void             buildnames(struct manpage *, sqlite3 *,
+static void             buildnames(const struct mansearch *,
+                               struct manpage *, sqlite3 *,
                                sqlite3_stmt *, uint64_t,
                                const char *, int form);
 static char            *buildoutput(sqlite3 *, sqlite3_stmt *,
                                 uint64_t, uint64_t);
 static void            *hash_alloc(size_t, void *);
-static void             hash_free(void *, size_t, void *);
-static void            *hash_halloc(size_t, void *);
+static void             hash_free(void *, void *);
+static void            *hash_calloc(size_t, size_t, void *);
 static struct expr     *exprcomp(const struct mansearch *,
                                int, char *[]);
 static void             exprfree(struct expr *);
-static struct expr     *exprspec(struct expr *, uint64_t,
-                                const char *, const char *);
 static struct expr     *exprterm(const struct mansearch *, char *, int);
+static int              manpage_compare(const void *, const void *);
 static void             sql_append(char **sql, size_t *sz,
                                const char *newstr, int count);
 static void             sql_match(sqlite3_context *context,
@@ -118,7 +124,8 @@ mansearch_setup(int start)
                }
 
                pagecache = mmap(NULL, PC_PAGESIZE * PC_NUMPAGES,
-                   PROT_READ | PROT_WRITE, MAP_ANON, -1, 0);
+                   PROT_READ | PROT_WRITE,
+                   MAP_SHARED | MAP_ANON, -1, 0);
 
                if (MAP_FAILED == pagecache) {
                        perror("mmap");
@@ -153,7 +160,6 @@ int
 mansearch(const struct mansearch *search,
                const struct manpaths *paths,
                int argc, char *argv[],
-               const char *outkey,
                struct manpage **res, size_t *sz)
 {
        int              fd, rc, c, indexbit;
@@ -171,11 +177,9 @@ mansearch(const struct mansearch *search,
        unsigned int     idx;
        size_t           i, j, cur, maxres;
 
-       memset(&info, 0, sizeof(struct ohash_info));
-
-       info.halloc = hash_halloc;
+       info.calloc = hash_calloc;
        info.alloc = hash_alloc;
-       info.hfree = hash_free;
+       info.free = hash_free;
        info.key_offset = offsetof(struct match, pageid);
 
        *sz = cur = maxres = 0;
@@ -191,11 +195,11 @@ mansearch(const struct mansearch *search,
                goto out;
 
        outbit = 0;
-       if (NULL != outkey) {
+       if (NULL != search->outkey) {
                for (indexbit = 0, iterbit = 1;
                     indexbit < mansearch_keymax;
                     indexbit++, iterbit <<= 1) {
-                       if (0 == strcasecmp(outkey,
+                       if (0 == strcasecmp(search->outkey,
                            mansearch_keynames[indexbit])) {
                                outbit = iterbit;
                                break;
@@ -242,7 +246,8 @@ mansearch(const struct mansearch *search,
                    SQLITE_OPEN_READONLY, NULL);
 
                if (SQLITE_OK != c) {
-                       perror(MANDOC_DB);
+                       fprintf(stderr, "%s/%s: %s\n",
+                           paths->paths[i], MANDOC_DB, strerror(errno));
                        sqlite3_close(db);
                        continue;
                }
@@ -298,8 +303,9 @@ mansearch(const struct mansearch *search,
                        mp = mandoc_calloc(1, sizeof(struct match));
                        mp->pageid = pageid;
                        mp->form = sqlite3_column_int(s, 1);
+                       mp->bits = sqlite3_column_int64(s, 3);
                        if (TYPE_Nd == outbit)
-                               mp->desc = mandoc_strdup(
+                               mp->desc = mandoc_strdup((const char *)
                                    sqlite3_column_text(s, 0));
                        ohash_insert(&htab, idx, mp);
                }
@@ -328,26 +334,40 @@ mansearch(const struct mansearch *search,
                                mp = ohash_next(&htab, &idx)) {
                        if (cur + 1 > maxres) {
                                maxres += 1024;
-                               *res = mandoc_realloc(*res,
-                                   maxres * sizeof(struct manpage));
+                               *res = mandoc_reallocarray(*res,
+                                   maxres, sizeof(struct manpage));
                        }
                        mpage = *res + cur;
+                       mpage->ipath = i;
+                       mpage->bits = mp->bits;
+                       mpage->sec = 10;
                        mpage->form = mp->form;
-                       buildnames(mpage, db, s, mp->pageid,
+                       buildnames(search, mpage, db, s, mp->pageid,
                            paths->paths[i], mp->form);
-                       mpage->output = TYPE_Nd & outbit ?
-                           mp->desc : outbit ?
-                           buildoutput(db, s2, mp->pageid, outbit) : NULL;
-
+                       if (mpage->names != NULL) {
+                               mpage->output = TYPE_Nd & outbit ?
+                                   mp->desc : outbit ?
+                                   buildoutput(db, s2, mp->pageid, outbit) :
+                                   NULL;
+                               cur++;
+                       }
                        free(mp);
-                       cur++;
                }
 
                sqlite3_finalize(s);
                sqlite3_finalize(s2);
                sqlite3_close(db);
                ohash_delete(&htab);
+
+               /*
+                * In man(1) mode, prefer matches in earlier trees
+                * over matches in later trees.
+                */
+
+               if (cur && search->firstmatch)
+                       break;
        }
+       qsort(*res, cur, sizeof(struct manpage), manpage_compare);
        rc = 1;
 out:
        if (-1 != fd) {
@@ -361,8 +381,35 @@ out:
        return(rc);
 }
 
+void
+mansearch_free(struct manpage *res, size_t sz)
+{
+       size_t   i;
+
+       for (i = 0; i < sz; i++) {
+               free(res[i].file);
+               free(res[i].names);
+               free(res[i].output);
+       }
+       free(res);
+}
+
+static int
+manpage_compare(const void *vp1, const void *vp2)
+{
+       const struct manpage    *mp1, *mp2;
+       int                      diff;
+
+       mp1 = vp1;
+       mp2 = vp2;
+       return( (diff = mp2->bits - mp1->bits) ? diff :
+               (diff = mp1->sec - mp2->sec) ? diff :
+               strcasecmp(mp1->names, mp2->names));
+}
+
 static void
-buildnames(struct manpage *mpage, sqlite3 *db, sqlite3_stmt *s,
+buildnames(const struct mansearch *search, struct manpage *mpage,
+               sqlite3 *db, sqlite3_stmt *s,
                uint64_t pageid, const char *path, int form)
 {
        char            *newnames, *prevsec, *prevarch;
@@ -387,11 +434,21 @@ buildnames(struct manpage *mpage, sqlite3 *db, sqlite3_stmt *s,
                        sep1 = ", ";
                }
 
-               /* Fetch the next name. */
+               /* Fetch the next name, rejecting sec/arch mismatches. */
+
+               sec = (const char *)sqlite3_column_text(s, 0);
+               if (search->sec != NULL && strcasecmp(sec, search->sec))
+                       continue;
+               arch = (const char *)sqlite3_column_text(s, 1);
+               if (search->arch != NULL && *arch != '\0' &&
+                   strcasecmp(arch, search->arch))
+                       continue;
+               name = (const char *)sqlite3_column_text(s, 2);
+
+               /* Remember the first section found. */
 
-               sec = sqlite3_column_text(s, 0);
-               arch = sqlite3_column_text(s, 1);
-               name = sqlite3_column_text(s, 2);
+               if (9 < mpage->sec && '1' <= *sec && '9' >= *sec)
+                       mpage->sec = (*sec - '1') + 1;
 
                /* If the section changed, append the old one. */
 
@@ -424,28 +481,28 @@ buildnames(struct manpage *mpage, sqlite3 *db, sqlite3_stmt *s,
 
                /* Also save the first file name encountered. */
 
-               if (NULL != mpage->file)
+               if (mpage->file != NULL)
                        continue;
 
-               if (form) {
+               if (form & FORM_SRC) {
                        sep1 = "man";
                        fsec = sec;
                } else {
                        sep1 = "cat";
                        fsec = "0";
                }
-               sep2 = '\0' == *arch ? "" : "/";
+               sep2 = *arch == '\0' ? "" : "/";
                mandoc_asprintf(&mpage->file, "%s/%s%s%s%s/%s.%s",
                    path, sep1, sec, sep2, arch, name, fsec);
        }
-       if (SQLITE_DONE != c)
+       if (c != SQLITE_DONE)
                fprintf(stderr, "%s\n", sqlite3_errmsg(db));
        sqlite3_reset(s);
 
        /* Append one final section to the names. */
 
-       if (NULL != prevsec) {
-               sep2 = '\0' == *prevarch ? "" : "/";
+       if (prevsec != NULL) {
+               sep2 = *prevarch == '\0' ? "" : "/";
                mandoc_asprintf(&newnames, "%s(%s%s%s)",
                    mpage->names, prevsec, sep2, prevarch);
                free(mpage->names);
@@ -475,7 +532,7 @@ buildoutput(sqlite3 *db, sqlite3_stmt *s, uint64_t pageid, uint64_t outbit)
                        oldoutput = output;
                        sep1 = " # ";
                }
-               data = sqlite3_column_text(s, 1);
+               data = (const char *)sqlite3_column_text(s, 1);
                mandoc_asprintf(&newoutput, "%s%s%s",
                    oldoutput, sep1, data);
                free(output);
@@ -543,8 +600,10 @@ sql_statement(const struct expr *e)
        size_t           sz;
        int              needop;
 
-       sql = mandoc_strdup(
-           "SELECT desc, form, pageid FROM mpages WHERE ");
+       sql = mandoc_strdup(e->equal ?
+           "SELECT desc, form, pageid, bits "
+               "FROM mpages NATURAL JOIN names WHERE " :
+           "SELECT desc, form, pageid, 0 FROM mpages WHERE ");
        sz = strlen(sql);
 
        for (needop = 0; NULL != e; e = e->next) {
@@ -563,6 +622,8 @@ sql_statement(const struct expr *e)
                    ? (NULL == e->substr
                        ? "pageid IN (SELECT pageid FROM names "
                          "WHERE name REGEXP ?)"
+                       : e->equal
+                       ? "name = ? "
                        : "pageid IN (SELECT pageid FROM names "
                          "WHERE name MATCH ?)")
                    : (NULL == e->substr
@@ -591,8 +652,7 @@ exprcomp(const struct mansearch *search, int argc, char *argv[])
        struct expr     *first, *prev, *cur, *next;
 
        first = cur = NULL;
-       logic = igncase = toclose = 0;
-       toopen = NULL != search->sec || NULL != search->arch;
+       logic = igncase = toopen = toclose = 0;
 
        for (i = 0; i < argc; i++) {
                if (0 == strcmp("(", argv[i])) {
@@ -658,17 +718,8 @@ exprcomp(const struct mansearch *search, int argc, char *argv[])
 
                toopen = logic = igncase = 0;
        }
-       if (toopen || logic || igncase || toclose)
-               goto fail;
-
-       if (NULL != search->sec || NULL != search->arch)
-               cur->close++;
-       if (NULL != search->arch)
-               cur = exprspec(cur, TYPE_arch, search->arch, "^(%s|any)$");
-       if (NULL != search->sec)
-               exprspec(cur, TYPE_sec, search->sec, "^%s$");
-
-       return(first);
+       if ( ! (toopen || logic || igncase || toclose))
+               return(first);
 
 fail:
        if (NULL != first)
@@ -676,35 +727,12 @@ fail:
        return(NULL);
 }
 
-static struct expr *
-exprspec(struct expr *cur, uint64_t key, const char *value,
-               const char *format)
-{
-       char     errbuf[BUFSIZ];
-       char    *cp;
-       int      irc;
-
-       mandoc_asprintf(&cp, format, value);
-       cur->next = mandoc_calloc(1, sizeof(struct expr));
-       cur = cur->next;
-       cur->and = 1;
-       cur->bits = key;
-       if (0 != (irc = regcomp(&cur->regexp, cp,
-           REG_EXTENDED | REG_NOSUB | REG_ICASE))) {
-               regerror(irc, &cur->regexp, errbuf, sizeof(errbuf));
-               fprintf(stderr, "regcomp: %s\n", errbuf);
-               cur->substr = value;
-       }
-       free(cp);
-       return(cur);
-}
-
 static struct expr *
 exprterm(const struct mansearch *search, char *buf, int cs)
 {
        char             errbuf[BUFSIZ];
        struct expr     *e;
-       char            *key, *v;
+       char            *key, *val;
        uint64_t         iterbit;
        int              i, irc;
 
@@ -713,40 +741,54 @@ exprterm(const struct mansearch *search, char *buf, int cs)
 
        e = mandoc_calloc(1, sizeof(struct expr));
 
-       /*"whatis" mode uses an opaque string and default fields. */
-
-       if (MANSEARCH_WHATIS & search->flags) {
+       if (search->argmode == ARG_NAME) {
+               e->bits = TYPE_Nm;
                e->substr = buf;
-               e->bits = search->deftype;
+               e->equal = 1;
                return(e);
        }
 
        /*
-        * If no =~ is specified, search with equality over names and
-        * descriptions.
-        * If =~ begins the phrase, use name and description fields.
+        * Separate macro keys from search string.
+        * If needed, request regular expression handling
+        * by setting e->substr to NULL.
         */
 
-       if (NULL == (v = strpbrk(buf, "=~"))) {
+       if (search->argmode == ARG_WORD) {
+               e->bits = TYPE_Nm;
+               e->substr = NULL;
+               mandoc_asprintf(&val, "[[:<:]]%s[[:>:]]", buf);
+               cs = 0;
+       } else if ((val = strpbrk(buf, "=~")) == NULL) {
+               e->bits = TYPE_Nm | TYPE_Nd;
                e->substr = buf;
-               e->bits = search->deftype;
-               return(e);
-       } else if (v == buf)
-               e->bits = search->deftype;
-
-       if ('~' == *v++) {
+       } else {
+               if (val == buf)
+                       e->bits = TYPE_Nm | TYPE_Nd;
+               if ('=' == *val)
+                       e->substr = val + 1;
+               *val++ = '\0';
                if (NULL != strstr(buf, "arch"))
                        cs = 0;
-               if (0 != (irc = regcomp(&e->regexp, v,
-                   REG_EXTENDED | REG_NOSUB | (cs ? 0 : REG_ICASE)))) {
+       }
+
+       /* Compile regular expressions. */
+
+       if (NULL == e->substr) {
+               irc = regcomp(&e->regexp, val,
+                   REG_EXTENDED | REG_NOSUB | (cs ? 0 : REG_ICASE));
+               if (search->argmode == ARG_WORD)
+                       free(val);
+               if (irc) {
                        regerror(irc, &e->regexp, errbuf, sizeof(errbuf));
                        fprintf(stderr, "regcomp: %s\n", errbuf);
                        free(e);
                        return(NULL);
                }
-       } else
-               e->substr = v;
-       v[-1] = '\0';
+       }
+
+       if (e->bits)
+               return(e);
 
        /*
         * Parse out all possible fields.
@@ -790,10 +832,10 @@ exprfree(struct expr *p)
 }
 
 static void *
-hash_halloc(size_t sz, void *arg)
+hash_calloc(size_t nmemb, size_t sz, void *arg)
 {
 
-       return(mandoc_calloc(sz, 1));
+       return(mandoc_calloc(nmemb, sz));
 }
 
 static void *
@@ -804,7 +846,7 @@ hash_alloc(size_t sz, void *arg)
 }
 
 static void
-hash_free(void *p, size_t sz, void *arg)
+hash_free(void *p, void *arg)
 {
 
        free(p);