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

Diff for /mandoc/tag.c between version 1.2 and 1.19

version 1.2, 2015/07/18 03:41:37 version 1.19, 2018/02/23 16:47:10
Line 1 
Line 1 
 /*      $Id$    */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2015 Ingo Schwarze <schwarze@openbsd.org>   * Copyright (c) 2015, 2016 Ingo Schwarze <schwarze@openbsd.org>
  *   *
  * Permission to use, copy, modify, and distribute this software for any   * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above   * purpose with or without fee is hereby granted, provided that the above
Line 14 
Line 14 
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF   * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.   * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */   */
   #include "config.h"
   
 #include <sys/types.h>  #include <sys/types.h>
   
 #include <signal.h>  #include <signal.h>
 #include <stddef.h>  #include <stddef.h>
   #include <stdint.h>
 #include <stdio.h>  #include <stdio.h>
 #include <stdlib.h>  #include <stdlib.h>
 #include <string.h>  #include <string.h>
 #include <unistd.h>  #include <unistd.h>
   
 #if HAVE_OHASH  
 #include <ohash.h>  
 #else  
 #include "compat_ohash.h"  
 #endif  
   
 #include "mandoc_aux.h"  #include "mandoc_aux.h"
   #include "mandoc_ohash.h"
 #include "tag.h"  #include "tag.h"
   
 struct tag_entry {  struct tag_entry {
         size_t   line;          size_t  *lines;
           size_t   maxlines;
           size_t   nlines;
           int      prio;
         char     s[];          char     s[];
 };  };
   
 static  void     tag_signal(int);  static  void     tag_signal(int) __attribute__((__noreturn__));
 static  void    *tag_alloc(size_t, void *);  
 static  void     tag_free(void *, void *);  
 static  void    *tag_calloc(size_t, size_t, void *);  
   
 static struct ohash      tag_data;  static struct ohash      tag_data;
 static char             *tag_fn = NULL;  static struct tag_files  tag_files;
 static int               tag_fd = -1;  
   
   
 /*  /*
  * Set up the ohash table to collect output line numbers   * Prepare for using a pager.
  * where various marked-up terms are documented and create   * Not all pagers are capable of using a tag file,
  * the temporary tags file, saving the name for the pager.   * but for simplicity, create it anyway.
  */   */
 void  struct tag_files *
 tag_init(void)  tag_init(void)
 {  {
         struct ohash_info        tag_info;          struct sigaction         sa;
           int                      ofd;
   
         tag_fn = mandoc_strdup("/tmp/man.XXXXXXXXXX");          ofd = -1;
         signal(SIGHUP, tag_signal);          tag_files.tfd = -1;
         signal(SIGINT, tag_signal);          tag_files.tcpgid = -1;
         signal(SIGTERM, tag_signal);  
         if ((tag_fd = mkstemp(tag_fn)) == -1) {  
                 free(tag_fn);  
                 tag_fn = NULL;  
                 return;  
         }  
   
         tag_info.alloc = tag_alloc;          /* Clean up when dying from a signal. */
         tag_info.calloc = tag_calloc;  
         tag_info.free = tag_free;  
         tag_info.key_offset = offsetof(struct tag_entry, s);  
         tag_info.data = NULL;  
         ohash_init(&tag_data, 4, &tag_info);  
 }  
   
 char *          memset(&sa, 0, sizeof(sa));
 tag_filename(void)          sigfillset(&sa.sa_mask);
 {          sa.sa_handler = tag_signal;
           sigaction(SIGHUP, &sa, NULL);
           sigaction(SIGINT, &sa, NULL);
           sigaction(SIGTERM, &sa, NULL);
   
         return(tag_fn);          /*
 }           * POSIX requires that a process calling tcsetpgrp(3)
            * from the background gets a SIGTTOU signal.
            * In that case, do not stop.
            */
   
 /*          sa.sa_handler = SIG_IGN;
  * Return the line number where a term is defined,          sigaction(SIGTTOU, &sa, NULL);
  * or 0 if the term is unknown.  
  */  
 size_t  
 tag_get(const char *s, size_t len)  
 {  
         struct tag_entry        *entry;  
         const char              *end;  
         unsigned int             slot;  
   
         if (tag_fd == -1)          /* Save the original standard output for use by the pager. */
                 return(0);  
         if (len == 0)          if ((tag_files.ofd = dup(STDOUT_FILENO)) == -1)
                 len = strlen(s);                  goto fail;
         end = s + len;  
         slot = ohash_qlookupi(&tag_data, s, &end);          /* Create both temporary output files. */
         entry = ohash_find(&tag_data, slot);  
         return(entry == NULL ? 0 : entry->line);          (void)strlcpy(tag_files.ofn, "/tmp/man.XXXXXXXXXX",
               sizeof(tag_files.ofn));
           (void)strlcpy(tag_files.tfn, "/tmp/man.XXXXXXXXXX",
               sizeof(tag_files.tfn));
           if ((ofd = mkstemp(tag_files.ofn)) == -1)
                   goto fail;
           if ((tag_files.tfd = mkstemp(tag_files.tfn)) == -1)
                   goto fail;
           if (dup2(ofd, STDOUT_FILENO) == -1)
                   goto fail;
           close(ofd);
   
           /*
            * Set up the ohash table to collect output line numbers
            * where various marked-up terms are documented.
            */
   
           mandoc_ohash_init(&tag_data, 4, offsetof(struct tag_entry, s));
           return &tag_files;
   
   fail:
           tag_unlink();
           if (ofd != -1)
                   close(ofd);
           if (tag_files.ofd != -1)
                   close(tag_files.ofd);
           if (tag_files.tfd != -1)
                   close(tag_files.tfd);
           *tag_files.ofn = '\0';
           *tag_files.tfn = '\0';
           tag_files.ofd = -1;
           tag_files.tfd = -1;
           return NULL;
 }  }
   
 /*  /*
  * Set the line number where a term is defined.   * Set the line number where a term is defined,
    * unless it is already defined at a higher priority.
  */   */
 void  void
 tag_put(const char *s, size_t len, size_t line)  tag_put(const char *s, int prio, size_t line)
 {  {
         struct tag_entry        *entry;          struct tag_entry        *entry;
         const char              *end;          size_t                   len;
         unsigned int             slot;          unsigned int             slot;
   
         if (tag_fd == -1)          /* Sanity checks. */
   
           if (tag_files.tfd <= 0)
                 return;                  return;
         if (len == 0)          if (s[0] == '\\' && (s[1] == '&' || s[1] == 'e'))
                 len = strlen(s);                  s += 2;
         end = s + len;          if (*s == '\0' || strchr(s, ' ') != NULL)
         slot = ohash_qlookupi(&tag_data, s, &end);                  return;
   
           slot = ohash_qlookup(&tag_data, s);
         entry = ohash_find(&tag_data, slot);          entry = ohash_find(&tag_data, slot);
   
         if (entry == NULL) {          if (entry == NULL) {
                 entry = mandoc_malloc(sizeof(*entry) + len + 1);  
                   /* Build a new entry. */
   
                   len = strlen(s) + 1;
                   entry = mandoc_malloc(sizeof(*entry) + len);
                 memcpy(entry->s, s, len);                  memcpy(entry->s, s, len);
                 entry->s[len] = '\0';                  entry->lines = NULL;
                   entry->maxlines = entry->nlines = 0;
                 ohash_insert(&tag_data, slot, entry);                  ohash_insert(&tag_data, slot, entry);
   
           } else {
   
                   /* Handle priority 0 entries. */
   
                   if (prio == 0) {
                           if (entry->prio == 0)
                                   entry->prio = -1;
                           return;
                   }
   
                   /* A better entry is already present, ignore the new one. */
   
                   if (entry->prio > 0 && entry->prio < prio)
                           return;
   
                   /* The existing entry is worse, clear it. */
   
                   if (entry->prio < 1 || entry->prio > prio)
                           entry->nlines = 0;
         }          }
         entry->line = line;  
           /* Remember the new line. */
   
           if (entry->maxlines == entry->nlines) {
                   entry->maxlines += 4;
                   entry->lines = mandoc_reallocarray(entry->lines,
                       entry->maxlines, sizeof(*entry->lines));
           }
           entry->lines[entry->nlines++] = line;
           entry->prio = prio;
 }  }
   
 /*  /*
Line 138  tag_write(void)
Line 194  tag_write(void)
 {  {
         FILE                    *stream;          FILE                    *stream;
         struct tag_entry        *entry;          struct tag_entry        *entry;
           size_t                   i;
         unsigned int             slot;          unsigned int             slot;
   
         if (tag_fd == -1)          if (tag_files.tfd <= 0)
                 return;                  return;
         stream = fdopen(tag_fd, "w");          stream = fdopen(tag_files.tfd, "w");
         entry = ohash_first(&tag_data, &slot);          entry = ohash_first(&tag_data, &slot);
         while (entry != NULL) {          while (entry != NULL) {
                 if (stream != NULL)                  if (stream != NULL && entry->prio >= 0)
                         fprintf(stream, "%s - %zu\n", entry->s, entry->line);                          for (i = 0; i < entry->nlines; i++)
                                   fprintf(stream, "%s %s %zu\n",
                                       entry->s, tag_files.ofn, entry->lines[i]);
                   free(entry->lines);
                 free(entry);                  free(entry);
                 entry = ohash_next(&tag_data, &slot);                  entry = ohash_next(&tag_data, &slot);
         }          }
         ohash_delete(&tag_data);          ohash_delete(&tag_data);
         if (stream != NULL)          if (stream != NULL)
                 fclose(stream);                  fclose(stream);
           else
                   close(tag_files.tfd);
           tag_files.tfd = -1;
 }  }
   
 void  void
 tag_unlink(void)  tag_unlink(void)
 {  {
           pid_t    tc_pgid;
   
         if (tag_fn != NULL)          if (tag_files.tcpgid != -1) {
                 unlink(tag_fn);                  tc_pgid = tcgetpgrp(tag_files.ofd);
                   if (tc_pgid == tag_files.pager_pid ||
                       tc_pgid == getpgid(0) ||
                       getpgid(tc_pgid) == -1)
                           (void)tcsetpgrp(tag_files.ofd, tag_files.tcpgid);
           }
           if (*tag_files.ofn != '\0')
                   unlink(tag_files.ofn);
           if (*tag_files.tfn != '\0')
                   unlink(tag_files.tfn);
 }  }
   
 static void  static void
 tag_signal(int signum)  tag_signal(int signum)
 {  {
           struct sigaction         sa;
   
         tag_unlink();          tag_unlink();
         signal(signum, SIG_DFL);          memset(&sa, 0, sizeof(sa));
           sigemptyset(&sa.sa_mask);
           sa.sa_handler = SIG_DFL;
           sigaction(signum, &sa, NULL);
         kill(getpid(), signum);          kill(getpid(), signum);
         /* NOTREACHED */          /* NOTREACHED */
         _exit(1);          _exit(1);
 }  
   
 /*  
  * Memory management callback functions for ohash.  
  */  
 static void *  
 tag_alloc(size_t sz, void *arg)  
 {  
   
         return(mandoc_malloc(sz));  
 }  
   
 static void *  
 tag_calloc(size_t nmemb, size_t sz, void *arg)  
 {  
   
         return(mandoc_calloc(nmemb, sz));  
 }  
   
 static void  
 tag_free(void *p, void *arg)  
 {  
   
         free(p);  
 }  }
Legend:
Removed from v.1.2  
changed lines
  Added in v.1.19
CVSweb