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

Diff for /mandoc/tag.c between version 1.8 and 1.37

version 1.8, 2015/10/06 18:32:20 version 1.37, 2022/04/26 11:38:38
Line 1 
Line 1 
 /*      $Id$    */  /* $Id$ */
 /*  /*
  * Copyright (c) 2015 Ingo Schwarze <schwarze@openbsd.org>   * Copyright (c) 2015, 2016, 2018, 2019, 2020, 2022
    *               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 14 
  * 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 "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 <stdint.h>  #include <stdint.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 "mdoc.h"
   #include "roff_int.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;          int      prio;
         char     s[];          char     s[];
 };  };
   
 static  void     tag_signal(int);  static void              tag_move_href(struct roff_man *,
 static  void    *tag_alloc(size_t, void *);                                  struct roff_node *, const char *);
 static  void     tag_free(void *, void *);  static void              tag_move_id(struct roff_node *);
 static  void    *tag_calloc(size_t, size_t, void *);  
   
 static struct ohash      tag_data;  static struct ohash      tag_data;
 static struct tag_files  tag_files;  
   
   
 /*  /*
  * Prepare for using a pager.   * Set up the ohash table to collect nodes
  * Not all pagers are capable of using a tag file,   * where various marked-up terms are documented.
  * but for simplicity, create it anyway.  
  */   */
 struct tag_files *  void
 tag_init(void)  tag_alloc(void)
 {  {
         struct ohash_info        tag_info;          mandoc_ohash_init(&tag_data, 4, offsetof(struct tag_entry, s));
         int                      ofd;  }
   
         ofd = -1;  void
         tag_files.tfd = -1;  tag_free(void)
   {
           struct tag_entry        *entry;
           unsigned int             slot;
   
         /* Save the original standard output for use by the pager. */          if (tag_data.info.free == NULL)
                   return;
         if ((tag_files.ofd = dup(STDOUT_FILENO)) == -1)          entry = ohash_first(&tag_data, &slot);
                 goto fail;          while (entry != NULL) {
                   free(entry->nodes);
         /* Create both temporary output files. */                  free(entry);
                   entry = ohash_next(&tag_data, &slot);
         (void)strlcpy(tag_files.ofn, "/tmp/man.XXXXXXXXXX",          }
             sizeof(tag_files.ofn));          ohash_delete(&tag_data);
         (void)strlcpy(tag_files.tfn, "/tmp/man.XXXXXXXXXX",          tag_data.info.free = NULL;
             sizeof(tag_files.tfn));  
         signal(SIGHUP, tag_signal);  
         signal(SIGINT, tag_signal);  
         signal(SIGTERM, tag_signal);  
         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.  
          */  
   
         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_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 a node where a term is defined,
  * unless it is already defined at a higher priority.   * unless the term is already defined at a lower priority.
  */   */
 void  void
 tag_put(const char *s, int prio, size_t line)  tag_put(const char *s, int prio, struct roff_node *n)
 {  {
         struct tag_entry        *entry;          struct tag_entry        *entry;
           struct roff_node        *nold;
           const char              *se;
         size_t                   len;          size_t                   len;
         unsigned int             slot;          unsigned int             slot;
   
         if (tag_files.tfd <= 0)          assert(prio <= TAG_FALLBACK);
   
           /*
            * If the node is already tagged, the existing tag is
            * explicit and we are now about to add an implicit tag.
            * Don't do that; just skip implicit tagging if the author
            * specified an explicit tag.
            */
   
           if (n->flags & NODE_ID)
                 return;                  return;
         slot = ohash_qlookup(&tag_data, s);  
           /* Determine the implicit tag. */
   
           if (s == NULL) {
                   if (n->child == NULL || n->child->type != ROFFT_TEXT)
                           return;
                   s = n->child->string;
                   switch (s[0]) {
                   case '-':
                           s++;
                           break;
                   case '\\':
                           switch (s[1]) {
                           case '&':
                           case '-':
                           case 'e':
                                   s += 2;
                                   break;
                           default:
                                   break;
                           }
                           break;
                   default:
                           break;
                   }
           }
   
           /*
            * Skip whitespace and escapes and whatever follows,
            * and if there is any, downgrade the priority.
            */
   
           len = strcspn(s, " \t\\");
           if (len == 0)
                   return;
   
           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) {
                 len = strlen(s) + 1;                  entry = mandoc_malloc(sizeof(*entry) + len + 1);
                 entry = mandoc_malloc(sizeof(*entry) + len);  
                 memcpy(entry->s, s, len);                  memcpy(entry->s, s, len);
                   entry->s[len] = '\0';
                   entry->nodes = NULL;
                   entry->maxnodes = entry->nnodes = 0;
                 ohash_insert(&tag_data, slot, entry);                  ohash_insert(&tag_data, slot, entry);
         } else if (entry->prio <= prio)          }
                 return;  
         entry->line = line;  
         entry->prio = prio;  
 }  
   
 /*          /*
  * 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_files.tfd <= 0)          else if (entry->prio < prio)
                 return;                  return;
         stream = fdopen(tag_files.tfd, "w");  
         entry = ohash_first(&tag_data, &slot);          /*
         while (entry != NULL) {           * If the existing entry is worse, clear it.
                 if (stream != NULL)           * In addition, a tag with priority TAG_FALLBACK
                         fprintf(stream, "%s %s %zu\n",           * is only used if the tag occurs exactly once.
                             entry->s, tag_files.ofn, entry->line);           */
                 free(entry);  
                 entry = ohash_next(&tag_data, &slot);          else if (entry->prio > prio || prio == TAG_FALLBACK) {
                   while (entry->nnodes > 0) {
                           nold = entry->nodes[--entry->nnodes];
                           nold->flags &= ~NODE_ID;
                           free(nold->tag);
                           nold->tag = NULL;
                   }
                   if (prio == TAG_FALLBACK) {
                           entry->prio = TAG_DELETE;
                           return;
                   }
         }          }
         ohash_delete(&tag_data);  
         if (stream != NULL)          /* Remember the new node. */
                 fclose(stream);  
           if (entry->maxnodes == entry->nnodes) {
                   entry->maxnodes += 4;
                   entry->nodes = mandoc_reallocarray(entry->nodes,
                       entry->maxnodes, sizeof(*entry->nodes));
           }
           entry->nodes[entry->nnodes++] = n;
           entry->prio = prio;
           n->flags |= NODE_ID;
           if (n->child == NULL || n->child->string != s || *se != '\0') {
                   assert(n->tag == NULL);
                   n->tag = mandoc_strndup(s, len);
           }
 }  }
   
 void  int
 tag_unlink(void)  tag_exists(const char *tag)
 {  {
           return ohash_find(&tag_data, ohash_qlookup(&tag_data, tag)) != NULL;
         if (*tag_files.ofn != '\0')  
                 unlink(tag_files.ofn);  
         if (*tag_files.tfn != '\0')  
                 unlink(tag_files.tfn);  
 }  }
   
   /*
    * For in-line elements, move the link target
    * to the enclosing paragraph when appropriate.
    */
 static void  static void
 tag_signal(int signum)  tag_move_id(struct roff_node *n)
 {  {
           struct roff_node *np;
   
         tag_unlink();          np = n;
         signal(signum, SIG_DFL);          for (;;) {
         kill(getpid(), signum);                  if (np->prev != NULL)
         /* NOTREACHED */                          np = np->prev;
         _exit(1);                  else if ((np = np->parent) == NULL)
                           return;
                   switch (np->tok) {
                   case MDOC_It:
                           switch (np->parent->parent->norm->Bl.type) {
                           case LIST_column:
                                   /* Target the ROFFT_BLOCK = <tr>. */
                                   np = np->parent;
                                   break;
                           case LIST_diag:
                           case LIST_hang:
                           case LIST_inset:
                           case LIST_ohang:
                           case LIST_tag:
                                   /* Target the ROFFT_HEAD = <dt>. */
                                   np = np->parent->head;
                                   break;
                           default:
                                   /* Target the ROFF_BODY = <li>. */
                                   break;
                           }
                           /* FALLTHROUGH */
                   case MDOC_Pp:   /* Target the ROFFT_ELEM = <p>. */
                           if (np->tag == NULL) {
                                   np->tag = mandoc_strdup(n->tag == NULL ?
                                       n->child->string : n->tag);
                                   np->flags |= NODE_ID;
                                   n->flags &= ~NODE_ID;
                           }
                           return;
                   case MDOC_Sh:
                   case MDOC_Ss:
                   case MDOC_Bd:
                   case MDOC_Bl:
                   case MDOC_D1:
                   case MDOC_Dl:
                   case MDOC_Rs:
                           /* Do not move past major blocks. */
                           return;
                   default:
                           /*
                            * Move past in-line content and partial
                            * blocks, for example .It Xo or .It Bq Er.
                            */
                           break;
                   }
           }
 }  }
   
 /*  /*
  * Memory management callback functions for ohash.   * When a paragraph is tagged and starts with text,
    * move the permalink to the first few words.
  */   */
 static void *  static void
 tag_alloc(size_t sz, void *arg)  tag_move_href(struct roff_man *man, struct roff_node *n, const char *tag)
 {  {
           char    *cp;
   
         return mandoc_malloc(sz);          if (n == NULL || n->type != ROFFT_TEXT ||
 }              *n->string == '\0' || *n->string == ' ')
                   return;
   
 static void *          cp = n->string;
 tag_calloc(size_t nmemb, size_t sz, void *arg)          while (cp != NULL && cp - n->string < 5)
 {                  cp = strchr(cp + 1, ' ');
   
         return mandoc_calloc(nmemb, sz);          /* If the first text node is longer, split it. */
   
           if (cp != NULL && cp[1] != '\0') {
                   man->last = n;
                   man->next = ROFF_NEXT_SIBLING;
                   roff_word_alloc(man, n->line,
                       n->pos + (cp - n->string), cp + 1);
                   man->last->flags = n->flags & ~NODE_LINE;
                   *cp = '\0';
           }
   
           assert(n->tag == NULL);
           n->tag = mandoc_strdup(tag);
           n->flags |= NODE_HREF;
 }  }
   
 static void  /*
 tag_free(void *p, void *arg)   * When all tags have been set, decide where to put
    * the associated permalinks, and maybe move some tags
    * to the beginning of the respective paragraphs.
    */
   void
   tag_postprocess(struct roff_man *man, struct roff_node *n)
 {  {
           if (n->flags & NODE_ID) {
         free(p);                  switch (n->tok) {
                   case MDOC_Pp:
                           tag_move_href(man, n->next, n->tag);
                           break;
                   case MDOC_Bd:
                   case MDOC_D1:
                   case MDOC_Dl:
                           tag_move_href(man, n->child, n->tag);
                           break;
                   case MDOC_Bl:
                           /* XXX No permalink for now. */
                           break;
                   default:
                           if (n->type == ROFFT_ELEM || n->tok == MDOC_Fo)
                                   tag_move_id(n);
                           if (n->tok != MDOC_Tg)
                                   n->flags |= NODE_HREF;
                           else if ((n->flags & NODE_ID) == 0) {
                                   n->flags |= NODE_NOPRT;
                                   free(n->tag);
                                   n->tag = NULL;
                           }
                           break;
                   }
           }
           for (n = n->child; n != NULL; n = n->next)
                   tag_postprocess(man, n);
 }  }
Legend:
Removed from v.1.8  
changed lines
  Added in v.1.37
CVSweb