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

Diff for /mandoc/tag.c between version 1.3 and 1.29

version 1.3, 2015/07/21 03:26:22 version 1.29, 2020/03/13 16:16:58
Line 1 
Line 1 
 /*      $Id$    */  /* $Id$ */
 /*  /*
  * Copyright (c) 2015 Ingo Schwarze <schwarze@openbsd.org>   * Copyright (c) 2015,2016,2018,2019,2020 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 13 
Line 13 
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN   * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * 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.
    *
    * Functions to tag syntax tree nodes.
    * For internal use by mandoc(1) validation modules only.
  */   */
   #include "config.h"
   
 #include <sys/types.h>  #include <sys/types.h>
   
 #include <signal.h>  #include <assert.h>
   #include <limits.h>
 #include <stddef.h>  #include <stddef.h>
 #include <stdio.h>  
 #include <stdlib.h>  #include <stdlib.h>
 #include <string.h>  #include <string.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 "roff.h"
 #include "tag.h"  #include "tag.h"
   
 struct tag_entry {  struct tag_entry {
         size_t   line;          struct roff_node **nodes;
           size_t   maxnodes;
           size_t   nnodes;
           int      prio;
         char     s[];          char     s[];
 };  };
   
 static  void     tag_signal(int);  
 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 int               tag_fd = -1;  
   
   
 /*  /*
  * Set up the ohash table to collect output line numbers   * Set up the ohash table to collect nodes
  * where various marked-up terms are documented and create   * where various marked-up terms are documented.
  * the temporary tags file, saving the name for the pager.  
  */   */
 char *  void
 tag_init(void)  tag_alloc(void)
 {  {
         struct ohash_info        tag_info;          mandoc_ohash_init(&tag_data, 4, offsetof(struct tag_entry, s));
   
         tag_fn = mandoc_strdup("/tmp/man.XXXXXXXXXX");  
         signal(SIGHUP, tag_signal);  
         signal(SIGINT, tag_signal);  
         signal(SIGTERM, tag_signal);  
         if ((tag_fd = mkstemp(tag_fn)) == -1) {  
                 free(tag_fn);  
                 tag_fn = NULL;  
                 return(NULL);  
         }  
   
         tag_info.alloc = tag_alloc;  
         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);  
         return(tag_fn);  
 }  }
   
 /*  void
  * Return the line number where a term is defined,  tag_free(void)
  * or 0 if the term is unknown.  
  */  
 size_t  
 tag_get(const char *s, size_t len)  
 {  {
         struct tag_entry        *entry;          struct tag_entry        *entry;
         const char              *end;  
         unsigned int             slot;          unsigned int             slot;
   
         if (tag_fd == -1)          if (tag_data.info.free == NULL)
                 return(0);                  return;
         if (len == 0)          entry = ohash_first(&tag_data, &slot);
                 len = strlen(s);          while (entry != NULL) {
         end = s + len;                  free(entry->nodes);
         slot = ohash_qlookupi(&tag_data, s, &end);                  free(entry);
         entry = ohash_find(&tag_data, slot);                  entry = ohash_next(&tag_data, &slot);
         return(entry == NULL ? 0 : entry->line);          }
           ohash_delete(&tag_data);
           tag_data.info.free = NULL;
 }  }
   
 /*  /*
  * Set the line number where a term is defined.   * Set a node where a term is defined,
    * unless it is already defined at a lower priority.
  */   */
 void  void
 tag_put(const char *s, size_t len, size_t line)  tag_put(const char *s, int prio, struct roff_node *n)
 {  {
         struct tag_entry        *entry;          struct tag_entry        *entry;
         const char              *end;          const char              *se;
           size_t                   len;
         unsigned int             slot;          unsigned int             slot;
   
         if (tag_fd == -1)          assert(prio <= TAG_FALLBACK);
                 return;  
           if (s == NULL) {
                   if (n->child == NULL || n->child->type != ROFFT_TEXT)
                           return;
                   s = n->child->string;
                   if (s[0] == '\\' && (s[1] == '&' || s[1] == 'e'))
                           s += 2;
           }
   
           /*
            * Skip whitespace and escapes and whatever follows,
            * and if there is any, downgrade the priority.
            */
   
           len = strcspn(s, " \t\\");
         if (len == 0)          if (len == 0)
                 len = strlen(s);                  return;
         end = s + len;  
         slot = ohash_qlookupi(&tag_data, s, &end);          se = s + len;
           if (*se != '\0' && prio < TAG_WEAK)
                   prio = TAG_WEAK;
   
           slot = ohash_qlookupi(&tag_data, s, &se);
         entry = ohash_find(&tag_data, slot);          entry = ohash_find(&tag_data, slot);
   
           /* Build a new entry. */
   
         if (entry == NULL) {          if (entry == NULL) {
                 entry = mandoc_malloc(sizeof(*entry) + len + 1);                  entry = mandoc_malloc(sizeof(*entry) + len + 1);
                 memcpy(entry->s, s, len);                  memcpy(entry->s, s, len);
                 entry->s[len] = '\0';                  entry->s[len] = '\0';
                   entry->nodes = NULL;
                   entry->maxnodes = entry->nnodes = 0;
                 ohash_insert(&tag_data, slot, entry);                  ohash_insert(&tag_data, slot, entry);
         }          }
         entry->line = line;  
 }  
   
 /*          /*
  * Write out the tags file using the previously collected           * Lower priority numbers take precedence.
  * information and clear the ohash table while going along.           * If a better entry is already present, ignore the new one.
  */           */
 void  
 tag_write(void)  
 {  
         FILE                    *stream;  
         struct tag_entry        *entry;  
         unsigned int             slot;  
   
         if (tag_fd == -1)          else if (entry->prio < prio)
                 return;                          return;
         stream = fdopen(tag_fd, "w");  
         entry = ohash_first(&tag_data, &slot);  
         while (entry != NULL) {  
                 if (stream != NULL)  
                         fprintf(stream, "%s - %zu\n", entry->s, entry->line);  
                 free(entry);  
                 entry = ohash_next(&tag_data, &slot);  
         }  
         ohash_delete(&tag_data);  
         if (stream != NULL)  
                 fclose(stream);  
 }  
   
 void          /*
 tag_unlink(void)           * If the existing entry is worse, clear it.
 {           * In addition, a tag with priority TAG_FALLBACK
            * is only used if the tag occurs exactly once.
            */
   
         if (tag_fn != NULL)          else if (entry->prio > prio || prio == TAG_FALLBACK) {
                 unlink(tag_fn);                  while (entry->nnodes > 0)
 }                          entry->nodes[--entry->nnodes]->flags &= ~NODE_ID;
   
 static void                  if (prio == TAG_FALLBACK) {
 tag_signal(int signum)                          entry->prio = TAG_DELETE;
 {                          return;
                   }
           }
   
         tag_unlink();          /* Remember the new node. */
         signal(signum, SIG_DFL);  
         kill(getpid(), signum);  
         /* NOTREACHED */  
         _exit(1);  
 }  
   
 /*          if (entry->maxnodes == entry->nnodes) {
  * Memory management callback functions for ohash.                  entry->maxnodes += 4;
  */                  entry->nodes = mandoc_reallocarray(entry->nodes,
 static void *                      entry->maxnodes, sizeof(*entry->nodes));
 tag_alloc(size_t sz, void *arg)          }
 {          entry->nodes[entry->nnodes++] = n;
           entry->prio = prio;
         return(mandoc_malloc(sz));          n->flags |= NODE_ID;
           if (n->child == NULL || n->child->string != s || *se != '\0') {
                   assert(n->string == NULL);
                   n->string = mandoc_strndup(s, len);
           }
 }  }
   
 static void *  enum tag_result
 tag_calloc(size_t nmemb, size_t sz, void *arg)  tag_check(const char *test_tag)
 {  {
           unsigned int slot;
   
         return(mandoc_calloc(nmemb, sz));          if (ohash_first(&tag_data, &slot) == NULL)
 }                  return TAG_EMPTY;
           else if (test_tag != NULL && ohash_find(&tag_data,
 static void              ohash_qlookup(&tag_data, test_tag)) == NULL)
 tag_free(void *p, void *arg)                  return TAG_MISS;
 {          else
                   return TAG_OK;
         free(p);  
 }  }
Legend:
Removed from v.1.3  
changed lines
  Added in v.1.29
CVSweb