Mostly complete implementation of the 'c' (character available)

[mandoc.git] / mandocdb.c

diff --git a/mandocdb.c b/mandocdb.c
index 2f34f487753f0f12647904df890b33557e792475..a2d9e494b562b58f87e4b1f7100c4f1866e3d457 100644 (file)
--- a/mandocdb.c
+++ b/mandocdb.c
@@ -1,7 +1,7 @@
-/*     $Id: mandocdb.c,v 1.254 2017/08/26 12:59:17 schwarze Exp $ */
+/*     $Id: mandocdb.c,v 1.259 2018/08/17 20:33:37 schwarze Exp $ */

 /*
  * Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
 /*
  * Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>

- * Copyright (c) 2011-2017 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2011-2018 Ingo Schwarze <schwarze@openbsd.org>

  * Copyright (c) 2016 Ed Maste <emaste@freebsd.org>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * Copyright (c) 2016 Ed Maste <emaste@freebsd.org>
  *
  * Permission to use, copy, modify, and distribute this software for any


@@ -19,8 +19,8 @@
 #include "config.h"
 
 #include <sys/types.h>
 #include "config.h"
 
 #include <sys/types.h>

+#include <sys/mman.h>

 #include <sys/stat.h>
 #include <sys/stat.h>

-#include <sys/wait.h>

 
 #include <assert.h>
 #include <ctype.h>
 
 #include <assert.h>
 #include <ctype.h>


@@ -139,6 +139,8 @@ static      void     parse_mdoc(struct mpage *, const struct roff_meta *,
                        const struct roff_node *);
 static int      parse_mdoc_head(struct mpage *, const struct roff_meta *,
                        const struct roff_node *);
                        const struct roff_node *);
 static int      parse_mdoc_head(struct mpage *, const struct roff_meta *,
                        const struct roff_node *);

+static int      parse_mdoc_Fa(struct mpage *, const struct roff_meta *,
+                       const struct roff_node *);

 static int      parse_mdoc_Fd(struct mpage *, const struct roff_meta *,
                        const struct roff_node *);
 static void     parse_mdoc_fname(struct mpage *, const struct roff_node *);
 static int      parse_mdoc_Fd(struct mpage *, const struct roff_meta *,
                        const struct roff_node *);
 static void     parse_mdoc_fname(struct mpage *, const struct roff_node *);


@@ -183,7 +185,7 @@ static      struct ohash     names; /* table of all names */
 static struct ohash     strings; /* table of all strings */
 static uint64_t         name_mask;
 
 static struct ohash     strings; /* table of all strings */
 static uint64_t         name_mask;
 

-static const struct mdoc_handler __mdocs[MDOC_MAX - MDOC_Dd] = {
+static const struct mdoc_handler mdoc_handlers[MDOC_MAX - MDOC_Dd] = {

        { NULL, 0, NODE_NOPRT },  /* Dd */
        { NULL, 0, NODE_NOPRT },  /* Dt */
        { NULL, 0, NODE_NOPRT },  /* Os */
        { NULL, 0, NODE_NOPRT },  /* Dd */
        { NULL, 0, NODE_NOPRT },  /* Dt */
        { NULL, 0, NODE_NOPRT },  /* Os */


@@ -207,11 +209,11 @@ static    const struct mdoc_handler __mdocs[MDOC_MAX - MDOC_Dd] = {
        { NULL, TYPE_Er, 0 },  /* Er */
        { NULL, TYPE_Ev, 0 },  /* Ev */
        { NULL, 0, 0 },  /* Ex */
        { NULL, TYPE_Er, 0 },  /* Er */
        { NULL, TYPE_Ev, 0 },  /* Ev */
        { NULL, 0, 0 },  /* Ex */

-       { NULL, TYPE_Fa, 0 },  /* Fa */
+       { parse_mdoc_Fa, 0, 0 },  /* Fa */

        { parse_mdoc_Fd, 0, 0 },  /* Fd */
        { NULL, TYPE_Fl, 0 },  /* Fl */
        { parse_mdoc_Fn, 0, 0 },  /* Fn */
        { parse_mdoc_Fd, 0, 0 },  /* Fd */
        { NULL, TYPE_Fl, 0 },  /* Fl */
        { parse_mdoc_Fn, 0, 0 },  /* Fn */

-       { NULL, TYPE_Ft, 0 },  /* Ft */
+       { NULL, TYPE_Ft | TYPE_Vt, 0 },  /* Ft */

        { NULL, TYPE_Ic, 0 },  /* Ic */
        { NULL, TYPE_In, 0 },  /* In */
        { NULL, TYPE_Li, 0 },  /* Li */
        { NULL, TYPE_Ic, 0 },  /* Ic */
        { NULL, TYPE_In, 0 },  /* In */
        { NULL, TYPE_Li, 0 },  /* Li */


@@ -305,7 +307,6 @@ static      const struct mdoc_handler __mdocs[MDOC_MAX - MDOC_Dd] = {
        { NULL, 0, 0 },  /* %U */
        { NULL, 0, 0 },  /* Ta */
 };
        { NULL, 0, 0 },  /* %U */
        { NULL, 0, 0 },  /* Ta */
 };

-static const struct mdoc_handler *const mdocs = __mdocs - MDOC_Dd;

 
 
 int
 
 
 int


@@ -319,7 +320,7 @@ mandocdb(int argc, char *argv[])
        int               ch, i;
 
 #if HAVE_PLEDGE
        int               ch, i;
 
 #if HAVE_PLEDGE

-       if (pledge("stdio rpath wpath cpath fattr flock proc exec", NULL) == -1) {
+       if (pledge("stdio rpath wpath cpath", NULL) == -1) {

                warn("pledge");
                return (int)MANDOCLEVEL_SYSERR;
        }
                warn("pledge");
                return (int)MANDOCLEVEL_SYSERR;
        }


@@ -440,15 +441,6 @@ mandocdb(int argc, char *argv[])
                         * The existing database is usable.  Process
                         * all files specified on the command-line.
                         */
                         * The existing database is usable.  Process
                         * all files specified on the command-line.
                         */

-#if HAVE_PLEDGE
-                       if (!nodb) {
-                               if (pledge("stdio rpath wpath cpath fattr flock", NULL) == -1) {
-                                       warn("pledge");
-                                       exitcode = (int)MANDOCLEVEL_SYSERR;
-                                       goto out;
-                               }
-                       }
-#endif

                        use_all = 1;
                        for (i = 0; i < argc; i++)
                                filescan(argv[i]);
                        use_all = 1;
                        for (i = 0; i < argc; i++)
                                filescan(argv[i]);


@@ -1382,7 +1374,12 @@ parse_cat(struct mpage *mpage, int fd)
                plen -= 2;
        }
 
                plen -= 2;
        }
 

-       mpage->desc = mandoc_strdup(p);
+       /*
+        * Cut off excessive one-line descriptions.
+        * Bad pages are not worth better heuristics.
+        */
+
+       mpage->desc = mandoc_strndup(p, 150);

        fclose(stream);
        free(title);
 }
        fclose(stream);
        free(title);
 }


@@ -1526,7 +1523,12 @@ parse_man(struct mpage *mpage, const struct roff_meta *meta,
                        while (' ' == *start)
                                start++;
 
                        while (' ' == *start)
                                start++;
 

-                       mpage->desc = mandoc_strdup(start);
+                       /*
+                        * Cut off excessive one-line descriptions.
+                        * Bad pages are not worth better heuristics.
+                        */
+
+                       mpage->desc = mandoc_strndup(start, 150);

                        free(title);
                        return;
                }
                        free(title);
                        return;
                }


@@ -1543,25 +1545,28 @@ static void
 parse_mdoc(struct mpage *mpage, const struct roff_meta *meta,
        const struct roff_node *n)
 {
 parse_mdoc(struct mpage *mpage, const struct roff_meta *meta,
        const struct roff_node *n)
 {

+       const struct mdoc_handler *handler;

 
        for (n = n->child; n != NULL; n = n->next) {
 
        for (n = n->child; n != NULL; n = n->next) {

-               if (n->tok == TOKEN_NONE ||
-                   n->tok < ROFF_MAX ||
-                   n->flags & mdocs[n->tok].taboo)
+               if (n->tok == TOKEN_NONE || n->tok < ROFF_MAX)

                        continue;
                assert(n->tok >= MDOC_Dd && n->tok < MDOC_MAX);
                        continue;
                assert(n->tok >= MDOC_Dd && n->tok < MDOC_MAX);

+               handler = mdoc_handlers + (n->tok - MDOC_Dd);
+               if (n->flags & handler->taboo)
+                       continue;
+

                switch (n->type) {
                case ROFFT_ELEM:
                case ROFFT_BLOCK:
                case ROFFT_HEAD:
                case ROFFT_BODY:
                case ROFFT_TAIL:
                switch (n->type) {
                case ROFFT_ELEM:
                case ROFFT_BLOCK:
                case ROFFT_HEAD:
                case ROFFT_BODY:
                case ROFFT_TAIL:

-                       if (mdocs[n->tok].fp != NULL &&
-                           (*mdocs[n->tok].fp)(mpage, meta, n) == 0)
+                       if (handler->fp != NULL &&
+                           (*handler->fp)(mpage, meta, n) == 0)

                                break;
                                break;

-                       if (mdocs[n->tok].mask)
+                       if (handler->mask)

                                putmdockey(mpage, n->child,
                                putmdockey(mpage, n->child,

-                                   mdocs[n->tok].mask, mdocs[n->tok].taboo);
+                                   handler->mask, handler->taboo);

                        break;
                default:
                        continue;
                        break;
                default:
                        continue;


@@ -1571,6 +1576,20 @@ parse_mdoc(struct mpage *mpage, const struct roff_meta *meta,
        }
 }
 
        }
 }
 

+static int
+parse_mdoc_Fa(struct mpage *mpage, const struct roff_meta *meta,
+       const struct roff_node *n)
+{
+       uint64_t mask;
+
+       mask = TYPE_Fa;
+       if (n->sec == SEC_SYNOPSIS)
+               mask |= TYPE_Vt;
+
+       putmdockey(mpage, n->child, mask, 0);
+       return 0;
+}
+

 static int
 parse_mdoc_Fd(struct mpage *mpage, const struct roff_meta *meta,
        const struct roff_node *n)
 static int
 parse_mdoc_Fd(struct mpage *mpage, const struct roff_meta *meta,
        const struct roff_node *n)


@@ -1640,15 +1659,20 @@ static int
 parse_mdoc_Fn(struct mpage *mpage, const struct roff_meta *meta,
        const struct roff_node *n)
 {
 parse_mdoc_Fn(struct mpage *mpage, const struct roff_meta *meta,
        const struct roff_node *n)
 {

+       uint64_t mask;

 
        if (n->child == NULL)
                return 0;
 
        parse_mdoc_fname(mpage, n->child);
 
 
        if (n->child == NULL)
                return 0;
 
        parse_mdoc_fname(mpage, n->child);
 

-       for (n = n->child->next; n != NULL; n = n->next)
-               if (n->type == ROFFT_TEXT)
-                       putkey(mpage, n->string, TYPE_Fa);
+       n = n->child->next;
+       if (n != NULL && n->type == ROFFT_TEXT) {
+               mask = TYPE_Fa;
+               if (n->sec == SEC_SYNOPSIS)
+                       mask |= TYPE_Vt;
+               putmdockey(mpage, n, mask, 0);
+       }

 
        return 0;
 }
 
        return 0;
 }


@@ -2119,9 +2143,10 @@ dbprune(struct dba *dba)
 static void
 dbwrite(struct dba *dba)
 {
 static void
 dbwrite(struct dba *dba)
 {

-       char             tfn[33];
-       int              status;
-       pid_t            child;
+       struct stat      sb1, sb2;
+       char             tfn[33], *cp1, *cp2;
+       off_t            i;
+       int              fd1, fd2;

 
        /*
         * Do not write empty databases, and delete existing ones
 
        /*
         * Do not write empty databases, and delete existing ones


@@ -2160,39 +2185,59 @@ dbwrite(struct dba *dba)
                say("", "&%s", tfn);
                return;
        }
                say("", "&%s", tfn);
                return;
        }

-
+       cp1 = cp2 = MAP_FAILED;
+       fd1 = fd2 = -1;

        (void)strlcat(tfn, "/" MANDOC_DB, sizeof(tfn));
        if (dba_write(tfn, dba) == -1) {
        (void)strlcat(tfn, "/" MANDOC_DB, sizeof(tfn));
        if (dba_write(tfn, dba) == -1) {

-               exitcode = (int)MANDOCLEVEL_SYSERR;

                say(tfn, "&dba_write");
                say(tfn, "&dba_write");

-               goto out;
+               goto err;

        }
        }

-
-       switch (child = fork()) {
-       case -1:
-               exitcode = (int)MANDOCLEVEL_SYSERR;
-               say("", "&fork cmp");
-               return;
-       case 0:
-               execlp("cmp", "cmp", "-s", tfn, MANDOC_DB, (char *)NULL);
-               say("", "&exec cmp");
-               exit(0);
-       default:
-               break;
+       if ((fd1 = open(MANDOC_DB, O_RDONLY, 0)) == -1) {
+               say(MANDOC_DB, "&open");
+               goto err;

        }
        }

-       if (waitpid(child, &status, 0) == -1) {
-               exitcode = (int)MANDOCLEVEL_SYSERR;
-               say("", "&wait cmp");
-       } else if (WIFSIGNALED(status)) {
-               exitcode = (int)MANDOCLEVEL_SYSERR;
-               say("", "cmp died from signal %d", WTERMSIG(status));
-       } else if (WEXITSTATUS(status)) {
-               exitcode = (int)MANDOCLEVEL_SYSERR;
-               say(MANDOC_DB,
-                   "Data changed, but cannot replace database");
+       if ((fd2 = open(tfn, O_RDONLY, 0)) == -1) {
+               say(tfn, "&open");
+               goto err;
+       }
+       if (fstat(fd1, &sb1) == -1) {
+               say(MANDOC_DB, "&fstat");
+               goto err;

        }
        }

+       if (fstat(fd2, &sb2) == -1) {
+               say(tfn, "&fstat");
+               goto err;
+       }
+       if (sb1.st_size != sb2.st_size)
+               goto err;
+       if ((cp1 = mmap(NULL, sb1.st_size, PROT_READ, MAP_PRIVATE,
+           fd1, 0)) == MAP_FAILED) {
+               say(MANDOC_DB, "&mmap");
+               goto err;
+       }
+       if ((cp2 = mmap(NULL, sb2.st_size, PROT_READ, MAP_PRIVATE,
+           fd2, 0)) == MAP_FAILED) {
+               say(tfn, "&mmap");
+               goto err;
+       }
+       for (i = 0; i < sb1.st_size; i++)
+               if (cp1[i] != cp2[i])
+                       goto err;
+       goto out;
+
+err:
+       exitcode = (int)MANDOCLEVEL_SYSERR;
+       say(MANDOC_DB, "Data changed, but cannot replace database");

 
 out:
 
 out:

+       if (cp1 != MAP_FAILED)
+               munmap(cp1, sb1.st_size);
+       if (cp2 != MAP_FAILED)
+               munmap(cp2, sb2.st_size);
+       if (fd1 != -1)
+               close(fd1);
+       if (fd2 != -1)
+               close(fd2);

        unlink(tfn);
        *strrchr(tfn, '/') = '\0';
        rmdir(tfn);
        unlink(tfn);
        *strrchr(tfn, '/') = '\0';
        rmdir(tfn);