This one needs config.h too, if only for __BEGIN_DECLS.

[mandoc.git] / manpath.c

diff --git a/manpath.c b/manpath.c
index 1ed7f9c5d2436c581bdc35207a5063371353ba02..9446ea6971a42cc81e477b6161e107ae02215848 100644 (file)
--- a/manpath.c
+++ b/manpath.c
@@ -1,61 +1,145 @@
-/*     $Id: manpath.c,v 1.5 2011/12/12 02:00:49 schwarze Exp $ */
+/*     $Id: manpath.c,v 1.25 2015/05/07 12:08:13 schwarze Exp $        */

 /*
 /*

- * Copyright (c) 2011 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2011, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>

  * Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
  * copyright notice and this permission notice appear in all copies.
  *
  * Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
  * copyright notice and this permission notice appear in all copies.
  *

- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES

  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF

- * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR

  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * 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"
 #include "config.h"

-#endif

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

-#include <assert.h>
+#include <sys/stat.h>
+

 #include <ctype.h>
 #include <limits.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 
 #include <ctype.h>
 #include <limits.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 

-#include "mandoc.h"
-#include "manpath.h"
+#include "mandoc_aux.h"
+#include "manconf.h"

 
 

-#define MAN_CONF_FILE  "/etc/man.conf"
-#define MAN_CONF_KEY   "_whatdb"
+static void     manconf_file(struct manconf *, const char *);
+static void     manpath_add(struct manpaths *, const char *, int);
+static void     manpath_parseline(struct manpaths *, char *, int);

 
 

-static void     manpath_add(struct manpaths *, const char *);

 
 void
 
 void

-manpath_parse(struct manpaths *dirs, const char *file,
+manconf_parse(struct manconf *conf, const char *file,

                char *defp, char *auxp)
 {
                char *defp, char *auxp)
 {

+#if HAVE_MANPATH
+       char             cmd[(PATH_MAX * 3) + 20];
+       FILE            *stream;
+       char            *buf;
+       size_t           sz, bsz;
+
+       strlcpy(cmd, "manpath", sizeof(cmd));
+       if (file) {
+               strlcat(cmd, " -C ", sizeof(cmd));
+               strlcat(cmd, file, sizeof(cmd));
+       }
+       if (auxp) {
+               strlcat(cmd, " -m ", sizeof(cmd));
+               strlcat(cmd, auxp, sizeof(cmd));
+       }
+       if (defp) {
+               strlcat(cmd, " -M ", sizeof(cmd));
+               strlcat(cmd, defp, sizeof(cmd));
+       }
+
+       /* Open manpath(1).  Ignore errors. */
+
+       stream = popen(cmd, "r");
+       if (NULL == stream)
+               return;

 
 

-       manpath_parseline(dirs, auxp);
+       buf = NULL;
+       bsz = 0;

 
 

-       if (NULL == defp)
-               defp = getenv("MANPATH");
+       /* Read in as much output as we can. */

 
 

-       if (NULL == defp)
-               manpath_parseconf(dirs, file);
-       else
-               manpath_parseline(dirs, defp);
+       do {
+               buf = mandoc_realloc(buf, bsz + 1024);
+               sz = fread(buf + bsz, 1, 1024, stream);
+               bsz += sz;
+       } while (sz > 0);
+
+       if ( ! ferror(stream) && feof(stream) &&
+                       bsz && '\n' == buf[bsz - 1]) {
+               buf[bsz - 1] = '\0';
+               manpath_parseline(&conf->manpath, buf, 1);
+       }
+
+       free(buf);
+       pclose(stream);
+#else
+       char            *insert;
+
+       /* Always prepend -m. */
+       manpath_parseline(&conf->manpath, auxp, 1);
+
+       /* If -M is given, it overrides everything else. */
+       if (NULL != defp) {
+               manpath_parseline(&conf->manpath, defp, 1);
+               return;
+       }
+
+       /* MANPATH and man.conf(5) cooperate. */
+       defp = getenv("MANPATH");
+       if (NULL == file)
+               file = MAN_CONF_FILE;
+
+       /* No MANPATH; use man.conf(5) only. */
+       if (NULL == defp || '\0' == defp[0]) {
+               manconf_file(conf, file);
+               return;
+       }
+
+       /* Prepend man.conf(5) to MANPATH. */
+       if (':' == defp[0]) {
+               manconf_file(conf, file);
+               manpath_parseline(&conf->manpath, defp, 0);
+               return;
+       }
+
+       /* Append man.conf(5) to MANPATH. */
+       if (':' == defp[strlen(defp) - 1]) {
+               manpath_parseline(&conf->manpath, defp, 0);
+               manconf_file(conf, file);
+               return;
+       }
+
+       /* Insert man.conf(5) into MANPATH. */
+       insert = strstr(defp, "::");
+       if (NULL != insert) {
+               *insert++ = '\0';
+               manpath_parseline(&conf->manpath, defp, 0);
+               manconf_file(conf, file);
+               manpath_parseline(&conf->manpath, insert + 1, 0);
+               return;
+       }
+
+       /* MANPATH overrides man.conf(5) completely. */
+       manpath_parseline(&conf->manpath, defp, 0);
+#endif

 }
 
 /*
  * Parse a FULL pathname from a colon-separated list of arrays.
  */
 }
 
 /*
  * Parse a FULL pathname from a colon-separated list of arrays.
  */

-void
-manpath_parseline(struct manpaths *dirs, char *path)
+static void
+manpath_parseline(struct manpaths *dirs, char *path, int complain)

 {
        char    *dir;
 
 {
        char    *dir;
 


@@ -63,7 +147,7 @@ manpath_parseline(struct manpaths *dirs, char *path)
                return;
 
        for (dir = strtok(path, ":"); dir; dir = strtok(NULL, ":"))
                return;
 
        for (dir = strtok(path, ":"); dir; dir = strtok(NULL, ":"))

-               manpath_add(dirs, dir);
+               manpath_add(dirs, dir, complain);

 }
 
 /*
 }
 
 /*


@@ -71,106 +155,173 @@ manpath_parseline(struct manpaths *dirs, char *path)
  * Grow the array one-by-one for simplicity's sake.
  */
 static void
  * Grow the array one-by-one for simplicity's sake.
  */
 static void

-manpath_add(struct manpaths *dirs, const char *dir)
+manpath_add(struct manpaths *dirs, const char *dir, int complain)

 {
        char             buf[PATH_MAX];
 {
        char             buf[PATH_MAX];

+       struct stat      sb;

        char            *cp;
        char            *cp;

-       int              i;
+       size_t           i;

 
 

-       if (NULL == (cp = realpath(dir, buf)))
+       if (NULL == (cp = realpath(dir, buf))) {
+               if (complain) {
+                       fputs("manpath: ", stderr);
+                       perror(dir);
+               }

                return;
                return;

+       }

 
        for (i = 0; i < dirs->sz; i++)
                if (0 == strcmp(dirs->paths[i], dir))
                        return;
 
 
        for (i = 0; i < dirs->sz; i++)
                if (0 == strcmp(dirs->paths[i], dir))
                        return;
 

-       dirs->paths = mandoc_realloc
-               (dirs->paths,
-                ((size_t)dirs->sz + 1) * sizeof(char *));
+       if (stat(cp, &sb) == -1) {
+               if (complain) {
+                       fputs("manpath: ", stderr);
+                       perror(dir);
+               }
+               return;
+       }
+
+       dirs->paths = mandoc_reallocarray(dirs->paths,
+           dirs->sz + 1, sizeof(char *));

 
        dirs->paths[dirs->sz++] = mandoc_strdup(cp);
 }
 
 void
 
        dirs->paths[dirs->sz++] = mandoc_strdup(cp);
 }
 
 void

-manpath_parseconf(struct manpaths *dirs, const char *file)
+manconf_free(struct manconf *conf)

 {
 {

-#ifdef USE_MANPATH
-       FILE            *stream;
-       char            *buf;
-       size_t           sz, bsz;
+       size_t           i;

 
 

-       /* Open manpath(1).  Ignore errors. */
-
-       stream = popen("manpath", "r");
-       if (NULL == stream)
-               return;
-
-       buf = NULL;
-       bsz = 0;
+       for (i = 0; i < conf->manpath.sz; i++)
+               free(conf->manpath.paths[i]);

 
 

-       /* Read in as much output as we can. */
+       free(conf->manpath.paths);
+       free(conf->output.includes);
+       free(conf->output.man);
+       free(conf->output.paper);
+       free(conf->output.style);
+}

 
 

-       do {
-               buf = mandoc_realloc(buf, bsz + 1024);
-               sz = fread(buf + (int)bsz, 1, 1024, stream);
-               bsz += sz;
-       } while (sz > 0);
+static void
+manconf_file(struct manconf *conf, const char *file)
+{
+       const char *const toks[] = { "manpath", "output", "_whatdb" };
+       char manpath_default[] = MANPATH_DEFAULT;

 
 

-       if ( ! ferror(stream) && feof(stream) &&
-                       bsz && '\n' == buf[bsz - 1]) {
-               buf[bsz - 1] = '\0';
-               manpath_parseline(dirs, buf);
-       }
+       FILE            *stream;
+       char            *cp, *ep;
+       size_t           len, tok;

 
 

-       free(buf);
-       pclose(stream);
-#else
-       manpath_manconf(dirs, file ? file : MAN_CONF_FILE);
-#endif
-}
+       if ((stream = fopen(file, "r")) == NULL)
+               goto out;

 
 

-void
-manpath_free(struct manpaths *p)
-{
-       int              i;
+       while ((cp = fgetln(stream, &len)) != NULL) {
+               ep = cp + len;
+               if (ep[-1] != '\n')
+                       break;
+               *--ep = '\0';
+               while (isspace((unsigned char)*cp))
+                       cp++;
+               if (*cp == '#')
+                       continue;

 
 

-       for (i = 0; i < p->sz; i++)
-               free(p->paths[i]);
+               for (tok = 0; tok < sizeof(toks)/sizeof(toks[0]); tok++) {
+                       len = strlen(toks[tok]);
+                       if (cp + len < ep &&
+                           isspace((unsigned char)cp[len]) &&
+                           !strncmp(cp, toks[tok], len)) {
+                               cp += len;
+                               while (isspace((unsigned char)*cp))
+                                       cp++;
+                               break;
+                       }
+               }
+
+               switch (tok) {
+               case 2:  /* _whatdb */
+                       while (ep > cp && ep[-1] != '/')
+                               ep--;
+                       if (ep == cp)
+                               continue;
+                       *ep = '\0';
+                       /* FALLTHROUGH */
+               case 0:  /* manpath */
+                       manpath_add(&conf->manpath, cp, 0);
+                       *manpath_default = '\0';
+                       break;
+               case 1:  /* output */
+                       manconf_output(&conf->output, cp);
+                       break;
+               default:
+                       break;
+               }
+       }
+       fclose(stream);

 
 

-       free(p->paths);
+out:
+       if (*manpath_default != '\0')
+               manpath_parseline(&conf->manpath, manpath_default, 0);

 }
 
 void
 }
 
 void

-manpath_manconf(struct manpaths *dirs, const char *file)
+manconf_output(struct manoutput *conf, const char *cp)

 {
 {

-       FILE            *stream;
-       char            *p, *q;
-       size_t           len, keysz;
-
-       keysz = strlen(MAN_CONF_KEY);
-       assert(keysz > 0);
+       const char *const toks[] = {
+           "includes", "man", "paper", "style",
+           "indent", "width", "fragment", "mdoc"
+       };
+
+       size_t   len, tok;
+
+       for (tok = 0; tok < sizeof(toks)/sizeof(toks[0]); tok++) {
+               len = strlen(toks[tok]);
+               if ( ! strncmp(cp, toks[tok], len) &&
+                   strchr(" =  ", cp[len]) != NULL) {
+                       cp += len;
+                       if (*cp == '=')
+                               cp++;
+                       while (isspace((unsigned char)*cp))
+                               cp++;
+                       break;
+               }
+       }

 
 

-       if (NULL == (stream = fopen(file, "r")))
+       if (tok < 6 && *cp == '\0')

                return;
 
                return;
 

-       while (NULL != (p = fgetln(stream, &len))) {
-               if (0 == len || '\n' != p[--len])
-                       break;
-               p[len] = '\0';
-               while (isspace((unsigned char)*p))
-                       p++;
-               if (strncmp(MAN_CONF_KEY, p, keysz))
-                       continue;
-               p += keysz;
-               while (isspace(*p))
-                       p++;
-               if ('\0' == *p)
-                       continue;
-               if (NULL == (q = strrchr(p, '/')))
-                       continue;
-               *q = '\0';
-               manpath_add(dirs, p);
+       switch (tok) {
+       case 0:
+               if (conf->includes == NULL)
+                       conf->includes = mandoc_strdup(cp);
+               break;
+       case 1:
+               if (conf->man == NULL)
+                       conf->man = mandoc_strdup(cp);
+               break;
+       case 2:
+               if (conf->paper == NULL)
+                       conf->paper = mandoc_strdup(cp);
+               break;
+       case 3:
+               if (conf->style == NULL)
+                       conf->style = mandoc_strdup(cp);
+               break;
+       case 4:
+               if (conf->indent == 0)
+                       conf->indent = strtonum(cp, 0, 1000, NULL);
+               break;
+       case 5:
+               if (conf->width == 0)
+                       conf->width = strtonum(cp, 58, 1000, NULL);
+               break;
+       case 6:
+               conf->fragment = 1;
+               break;
+       case 7:
+               conf->mdoc = 1;
+               break;
+       default:
+               break;

        }
        }

-
-       fclose(stream);

 }
 }