[BACK]Return to mandocdb.c CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandocdb.c between version 1.13 and 1.14

version 1.13, 2011/11/26 22:38:11 version 1.14, 2011/11/27 22:57:53
Line 20 
Line 20 
 #endif  #endif
   
 #include <sys/param.h>  #include <sys/param.h>
   #include <sys/types.h>
   #include <sys/stat.h>
   
 #include <assert.h>  #include <assert.h>
 #include <dirent.h>  #include <dirent.h>
Line 45 
Line 47 
 #define MANDOC_BUFSZ      BUFSIZ  #define MANDOC_BUFSZ      BUFSIZ
 #define MANDOC_SLOP       1024  #define MANDOC_SLOP       1024
   
   #define MANDOC_SRC        0x1
   #define MANDOC_FORM       0x2
   
 /* Tiny list for files.  No need to bring in QUEUE. */  /* Tiny list for files.  No need to bring in QUEUE. */
   
 struct  of {  struct  of {
Line 52  struct of {
Line 57  struct of {
         char             *sec;          char             *sec;
         char             *arch;          char             *arch;
         char             *title;          char             *title;
           int               src_form;
         struct of        *next; /* NULL for last one */          struct of        *next; /* NULL for last one */
         struct of        *first; /* first in list */          struct of        *first; /* first in list */
 };  };
Line 101  static void    index_prune(const struct of *, DB *, 
Line 107  static void    index_prune(const struct of *, DB *, 
 static  void              ofile_argbuild(char *[], int, int, int,  static  void              ofile_argbuild(char *[], int, int, int,
                                 struct of **);                                  struct of **);
 static  int               ofile_dirbuild(const char *, const char *,  static  int               ofile_dirbuild(const char *, const char *,
                                 const char *, int, int, struct of **);                                  const char *, int, int, int,
                                   struct of **);
 static  void              ofile_free(struct of *);  static  void              ofile_free(struct of *);
   static  void              pformatted(DB *, struct buf *, struct buf *,
                                   const struct of *);
 static  int               pman_node(MAN_ARGS);  static  int               pman_node(MAN_ARGS);
 static  void              pmdoc_node(MDOC_ARGS);  static  void              pmdoc_node(MDOC_ARGS);
 static  void              pmdoc_An(MDOC_ARGS);  static  void              pmdoc_An(MDOC_ARGS);
Line 441  main(int argc, char *argv[])
Line 450  main(int argc, char *argv[])
                 of = NULL;                  of = NULL;
   
                 if ( ! ofile_dirbuild(dirs.paths[i], NULL, NULL,                  if ( ! ofile_dirbuild(dirs.paths[i], NULL, NULL,
                                 use_all, verb, &of))                                  0, use_all, verb, &of))
                         exit((int)MANDOCLEVEL_SYSERR);                          exit((int)MANDOCLEVEL_SYSERR);
   
                 if (NULL == of)                  if (NULL == of)
Line 492  index_merge(const struct of *of, struct mparse *mp,
Line 501  index_merge(const struct of *of, struct mparse *mp,
   
         for (rec = 0; of; of = of->next) {          for (rec = 0; of; of = of->next) {
                 fn = of->fname;                  fn = of->fname;
   
                   /*
                    * Reclaim an empty index record, if available.
                    */
   
                 if (reccur > 0) {                  if (reccur > 0) {
                         --reccur;                          --reccur;
                         rec = recs[(int)reccur];                          rec = recs[(int)reccur];
Line 503  index_merge(const struct of *of, struct mparse *mp,
Line 517  index_merge(const struct of *of, struct mparse *mp,
   
                 mparse_reset(mp);                  mparse_reset(mp);
                 hash_reset(&hash);                  hash_reset(&hash);
                   mdoc = NULL;
                   man = NULL;
   
                 if (mparse_readfd(mp, -1, fn) >= MANDOCLEVEL_FATAL) {                  /*
                         fprintf(stderr, "%s: Parse failure\n", fn);                   * Try interpreting the file as mdoc(7) or man(7)
                         continue;                   * source code, unless it is already known to be
                 }                   * formatted.  Fall back to formatted mode.
                    */
   
                 mparse_result(mp, &mdoc, &man);                  if ((MANDOC_SRC & of->src_form ||
                 if (NULL == mdoc && NULL == man)                      ! (MANDOC_FORM & of->src_form)) &&
                         continue;                      MANDOCLEVEL_FATAL > mparse_readfd(mp, -1, fn))
                           mparse_result(mp, &mdoc, &man);
   
                   if (NULL != mdoc) {
                           msec = mdoc_meta(mdoc)->msec;
                           arch = mdoc_meta(mdoc)->arch;
                           mtitle = mdoc_meta(mdoc)->title;
                   } else if (NULL != man) {
                           msec = man_meta(man)->msec;
                           arch = NULL;
                           mtitle = man_meta(man)->title;
                   } else {
                           msec = of->sec;
                           arch = of->arch;
                           mtitle = of->title;
                   }
   
                 /*                  /*
                  * By default, skip a file if the manual section                   * By default, skip a file if the manual section
                  * and architecture given in the file disagree                   * and architecture given in the file disagree
                  * with the directory where the file is located.                   * with the directory where the file is located.
                  */                   */
   
                 msec = NULL != mdoc ?  
                         mdoc_meta(mdoc)->msec : man_meta(man)->msec;  
                 arch = NULL != mdoc ?  
                         mdoc_meta(mdoc)->arch : NULL;  
   
                 if (0 == use_all) {                  if (0 == use_all) {
                         assert(of->sec);                          assert(of->sec);
                         assert(msec);                          assert(msec);
Line 548  index_merge(const struct of *of, struct mparse *mp,
Line 575  index_merge(const struct of *of, struct mparse *mp,
                  * because the one in the file usually is all caps.                   * because the one in the file usually is all caps.
                  */                   */
   
                 mtitle = NULL != mdoc ?  
                         mdoc_meta(mdoc)->title : man_meta(man)->title;  
   
                 assert(of->title);                  assert(of->title);
                 assert(mtitle);                  assert(mtitle);
   
Line 580  index_merge(const struct of *of, struct mparse *mp,
Line 604  index_merge(const struct of *of, struct mparse *mp,
                 if (mdoc)                  if (mdoc)
                         pmdoc_node(hash, buf, dbuf,                          pmdoc_node(hash, buf, dbuf,
                                 mdoc_node(mdoc), mdoc_meta(mdoc));                                  mdoc_node(mdoc), mdoc_meta(mdoc));
                 else                  else if (man)
                         pman_node(hash, buf, dbuf, man_node(man));                          pman_node(hash, buf, dbuf, man_node(man));
                   else
                           pformatted(hash, buf, dbuf, of);
   
                 /*                  /*
                  * Copy from the in-memory hashtable of pending keywords                   * Copy from the in-memory hashtable of pending keywords
Line 1232  pman_node(MAN_ARGS)
Line 1258  pman_node(MAN_ARGS)
         return(0);          return(0);
 }  }
   
   /*
    * Parse a formatted manual page.
    * By necessity, this involves rather crude guesswork.
    */
 static void  static void
   pformatted(DB *hash, struct buf *buf, struct buf *dbuf,
                    const struct of *of)
   {
           FILE            *stream;
           char            *line, *p;
           size_t           len, plen;
   
           if (NULL == (stream = fopen(of->fname, "r"))) {
                   perror(of->fname);
                   return;
           }
   
           /*
            * Always use the title derived from the filename up front,
            * do not even try to find it in the file.  This also makes
            * sure we don't end up with an orphan index record, even if
            * the file content turns out to be completely unintelligible.
            */
   
           buf->len = 0;
           buf_append(buf, of->title);
           hash_put(hash, buf, TYPE_Nm);
   
           while (NULL != (line = fgetln(stream, &len)) && '\n' != *line)
                   /* Skip to first blank line. */ ;
   
           while (NULL != (line = fgetln(stream, &len)) &&
                           ('\n' == *line || ' ' == *line))
                   /* Skip to first section header. */ ;
   
           /*
            * If no page content can be found,
            * reuse the page title as the page description.
            */
   
           if (NULL == (line = fgetln(stream, &len))) {
                   buf_appendb(dbuf, buf->cp, buf->size);
                   hash_put(hash, buf, TYPE_Nd);
                   fclose(stream);
                   return;
           }
           fclose(stream);
   
           /*
            * If there is a dash, skip to the text following it.
            */
   
           for (p = line, plen = len; plen; p++, plen--)
                   if ('-' == *p)
                           break;
           for ( ; plen; p++, plen--)
                   if ('-' != *p && ' ' != *p && 8 != *p)
                           break;
           if (0 == plen) {
                   p = line;
                   plen = len;
           }
   
           /*
            * Copy the rest of the line, but no more than 70 bytes.
            */
   
           if (70 < plen)
                   plen = 70;
           p[plen-1] = '\0';
           buf_appendb(dbuf, p, plen);
           buf->len = 0;
           buf_appendb(buf, p, plen);
           hash_put(hash, buf, TYPE_Nd);
   }
   
   static void
 ofile_argbuild(char *argv[], int argc, int use_all, int verb,  ofile_argbuild(char *argv[], int argc, int use_all, int verb,
                 struct of **of)                  struct of **of)
 {  {
         char             buf[MAXPATHLEN];          char             buf[MAXPATHLEN];
         char            *sec, *arch, *title, *p;          char            *sec, *arch, *title, *p;
         int              i;          int              i, src_form;
         struct of       *nof;          struct of       *nof;
   
         for (i = 0; i < argc; i++) {          for (i = 0; i < argc; i++) {
Line 1246  ofile_argbuild(char *argv[], int argc, int use_all, in
Line 1348  ofile_argbuild(char *argv[], int argc, int use_all, in
                 /*                  /*
                  * Try to infer the manual section, architecture and                   * Try to infer the manual section, architecture and
                  * page title from the path, assuming it looks like                   * page title from the path, assuming it looks like
                  *   man*[/<arch>]/<title>.<section>                   *   man*[/<arch>]/<title>.<section>   or
                    *   cat<section>[/<arch>]/<title>.0
                  */                   */
   
                 if (strlcpy(buf, argv[i], sizeof(buf)) >= sizeof(buf)) {                  if (strlcpy(buf, argv[i], sizeof(buf)) >= sizeof(buf)) {
Line 1254  ofile_argbuild(char *argv[], int argc, int use_all, in
Line 1357  ofile_argbuild(char *argv[], int argc, int use_all, in
                         continue;                          continue;
                 }                  }
                 sec = arch = title = NULL;                  sec = arch = title = NULL;
                   src_form = 0;
                 p = strrchr(buf, '\0');                  p = strrchr(buf, '\0');
                 while (p-- > buf) {                  while (p-- > buf) {
                         if (NULL == sec && '.' == *p) {                          if (NULL == sec && '.' == *p) {
                                 sec = p + 1;                                  sec = p + 1;
                                 *p = '\0';                                  *p = '\0';
                                   if ('0' == *sec)
                                           src_form |= MANDOC_FORM;
                                   else if ('1' <= *sec && '9' >= *sec)
                                           src_form |= MANDOC_SRC;
                                 continue;                                  continue;
                         }                          }
                         if ('/' != *p)                          if ('/' != *p)
Line 1268  ofile_argbuild(char *argv[], int argc, int use_all, in
Line 1376  ofile_argbuild(char *argv[], int argc, int use_all, in
                                 *p = '\0';                                  *p = '\0';
                                 continue;                                  continue;
                         }                          }
                         if (strncmp("man", p + 1, 3))                          if (strncmp("man", p + 1, 3)) {
                                   src_form |= MANDOC_SRC;
                                 arch = p + 1;                                  arch = p + 1;
                           } else if (strncmp("cat", p + 1, 3)) {
                                   src_form |= MANDOC_FORM;
                                   arch = p + 1;
                           }
                         break;                          break;
                 }                  }
                 if (NULL == title)                  if (NULL == title)
Line 1286  ofile_argbuild(char *argv[], int argc, int use_all, in
Line 1399  ofile_argbuild(char *argv[], int argc, int use_all, in
                 if (NULL != arch)                  if (NULL != arch)
                         nof->arch = mandoc_strdup(arch);                          nof->arch = mandoc_strdup(arch);
                 nof->title = mandoc_strdup(title);                  nof->title = mandoc_strdup(title);
                   nof->src_form = src_form;
   
                 /*                  /*
                  * Add the structure to the list.                   * Add the structure to the list.
Line 1314  ofile_argbuild(char *argv[], int argc, int use_all, in
Line 1428  ofile_argbuild(char *argv[], int argc, int use_all, in
  */   */
 static int  static int
 ofile_dirbuild(const char *dir, const char* psec, const char *parch,  ofile_dirbuild(const char *dir, const char* psec, const char *parch,
                 int use_all, int verb, struct of **of)                  int p_src_form, int use_all, int verb, struct of **of)
 {  {
         char             buf[MAXPATHLEN];          char             buf[MAXPATHLEN];
           struct stat      sb;
         size_t           sz;          size_t           sz;
         DIR             *d;          DIR             *d;
         const char      *fn, *sec, *arch;          const char      *fn, *sec, *arch;
         char            *suffix;          char            *p, *q, *suffix;
         struct of       *nof;          struct of       *nof;
         struct dirent   *dp;          struct dirent   *dp;
           int              src_form;
   
         if (NULL == (d = opendir(dir))) {          if (NULL == (d = opendir(dir))) {
                 perror(dir);                  perror(dir);
Line 1335  ofile_dirbuild(const char *dir, const char* psec, cons
Line 1451  ofile_dirbuild(const char *dir, const char* psec, cons
                 if ('.' == *fn)                  if ('.' == *fn)
                         continue;                          continue;
   
                   src_form = p_src_form;
   
                 if (DT_DIR == dp->d_type) {                  if (DT_DIR == dp->d_type) {
                         sec = psec;                          sec = psec;
                         arch = parch;                          arch = parch;
   
                         /*                          /*
                          * By default, only use directories called:                           * By default, only use directories called:
                          *   man<section>/[<arch>/]                           *   man<section>/[<arch>/]   or
                            *   cat<section>/[<arch>/]
                          */                           */
   
                         if (NULL == sec) {                          if (NULL == sec) {
                                 if(0 == strncmp("man", fn, 3))                                  if(0 == strncmp("man", fn, 3)) {
                                           src_form |= MANDOC_SRC;
                                         sec = fn + 3;                                          sec = fn + 3;
                                 else if (use_all)                                  } else if (0 == strncmp("cat", fn, 3)) {
                                           src_form |= MANDOC_FORM;
                                           sec = fn + 3;
                                   } else if (use_all)
                                         sec = fn;                                          sec = fn;
                                 else                                  else
                                         continue;                                          continue;
Line 1371  ofile_dirbuild(const char *dir, const char* psec, cons
Line 1494  ofile_dirbuild(const char *dir, const char* psec, cons
                                 printf("%s: Scanning\n", buf);                                  printf("%s: Scanning\n", buf);
   
                         if ( ! ofile_dirbuild(buf, sec, arch,                          if ( ! ofile_dirbuild(buf, sec, arch,
                                         use_all, verb, of))                                          src_form, use_all, verb, of))
                                 return(0);                                  return(0);
                 }                  }
                 if (DT_REG != dp->d_type ||                  if (DT_REG != dp->d_type ||
Line 1390  ofile_dirbuild(const char *dir, const char* psec, cons
Line 1513  ofile_dirbuild(const char *dir, const char* psec, cons
                 if (0 == use_all) {                  if (0 == use_all) {
                         if (NULL == suffix)                          if (NULL == suffix)
                                 continue;                                  continue;
                         if (strcmp(suffix + 1, psec))                          if ((MANDOC_SRC & src_form &&
                                            strcmp(suffix + 1, psec)) ||
                               (MANDOC_FORM & src_form &&
                                            strcmp(suffix + 1, "0")))
                                           continue;
                   }
                   if (NULL != suffix) {
                           if ('0' == suffix[1])
                                   src_form |= MANDOC_FORM;
                           else if ('1' <= suffix[1] && '9' >= suffix[1])
                                   src_form |= MANDOC_SRC;
                   }
   
   
                   /*
                    * Skip formatted manuals if a source version is
                    * available.  Ignore the age: it is very unlikely
                    * that people install newer formatted base manuals
                    * when they used to have source manuals before,
                    * and in ports, old manuals get removed on update.
                    */
                   if (0 == use_all && MANDOC_FORM & src_form &&
                                   NULL != psec) {
                           buf[0] = '\0';
                           strlcat(buf, dir, MAXPATHLEN);
                           p = strrchr(buf, '/');
                           if (NULL == p)
                                   p = buf;
                           else
                                   p++;
                           if (0 == strncmp("cat", p, 3))
                                   memcpy(p, "man", 3);
                           strlcat(buf, "/", MAXPATHLEN);
                           sz = strlcat(buf, fn, MAXPATHLEN);
                           if (sz >= MAXPATHLEN) {
                                   fprintf(stderr, "%s: Path too long\n", buf);
                                 continue;                                  continue;
                           }
                           q = strrchr(buf, '.');
                           if (NULL != q && p < q++) {
                                   *q = '\0';
                                   sz = strlcat(buf, psec, MAXPATHLEN);
                                   if (sz >= MAXPATHLEN) {
                                           fprintf(stderr,
                                               "%s: Path too long\n", buf);
                                           continue;
                                   }
                                   if (0 == stat(buf, &sb))
                                           continue;
                           }
                 }                  }
   
                 buf[0] = '\0';                  buf[0] = '\0';
Line 1400  ofile_dirbuild(const char *dir, const char* psec, cons
Line 1571  ofile_dirbuild(const char *dir, const char* psec, cons
                 sz = strlcat(buf, fn, MAXPATHLEN);                  sz = strlcat(buf, fn, MAXPATHLEN);
                 if (sz >= MAXPATHLEN) {                  if (sz >= MAXPATHLEN) {
                         fprintf(stderr, "%s: Path too long\n", dir);                          fprintf(stderr, "%s: Path too long\n", dir);
                         return(0);                          continue;
                 }                  }
   
                 nof = mandoc_calloc(1, sizeof(struct of));                  nof = mandoc_calloc(1, sizeof(struct of));
Line 1409  ofile_dirbuild(const char *dir, const char* psec, cons
Line 1580  ofile_dirbuild(const char *dir, const char* psec, cons
                         nof->sec = mandoc_strdup(psec);                          nof->sec = mandoc_strdup(psec);
                 if (NULL != parch)                  if (NULL != parch)
                         nof->arch = mandoc_strdup(parch);                          nof->arch = mandoc_strdup(parch);
                   nof->src_form = src_form;
   
                 /*                  /*
                  * Remember the file name without the extension,                   * Remember the file name without the extension,
Line 1419  ofile_dirbuild(const char *dir, const char* psec, cons
Line 1591  ofile_dirbuild(const char *dir, const char* psec, cons
                         *suffix = '\0';                          *suffix = '\0';
                 nof->title = mandoc_strdup(fn);                  nof->title = mandoc_strdup(fn);
   
                   /*
                    * Add the structure to the list.
                    */
   
                 if (verb > 2)                  if (verb > 2)
                         printf("%s: Scheduling\n", buf);                          printf("%s: Scheduling\n", buf);
   
                 if (NULL == *of) {                  if (NULL == *of) {
                         *of = nof;                          *of = nof;
                         (*of)->first = nof;                          (*of)->first = nof;
Legend:
Removed from v.1.13  
changed lines
  Added in v.1.14
CVSweb