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

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

version 1.19, 2018/02/23 16:47:10 version 1.36, 2020/04/19 16:36:16
Line 1 
Line 1 
 /*      $Id$ */  /* $Id$ */
 /*  /*
  * Copyright (c) 2015, 2016 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 "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>  
   
 #include "mandoc_aux.h"  #include "mandoc_aux.h"
 #include "mandoc_ohash.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  *lines;          struct roff_node **nodes;
         size_t   maxlines;          size_t   maxnodes;
         size_t   nlines;          size_t   nnodes;
         int      prio;          int      prio;
         char     s[];          char     s[];
 };  };
   
 static  void     tag_signal(int) __attribute__((__noreturn__));  static void              tag_move_href(struct roff_man *,
                                   struct roff_node *, const char *);
   static void              tag_move_id(struct roff_node *);
   
 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 sigaction         sa;  
         int                      ofd;  
   
         ofd = -1;  
         tag_files.tfd = -1;  
         tag_files.tcpgid = -1;  
   
         /* Clean up when dying from a signal. */  
   
         memset(&sa, 0, sizeof(sa));  
         sigfillset(&sa.sa_mask);  
         sa.sa_handler = tag_signal;  
         sigaction(SIGHUP, &sa, NULL);  
         sigaction(SIGINT, &sa, NULL);  
         sigaction(SIGTERM, &sa, NULL);  
   
         /*  
          * 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;  
         sigaction(SIGTTOU, &sa, NULL);  
   
         /* Save the original standard output for use by the pager. */  
   
         if ((tag_files.ofd = dup(STDOUT_FILENO)) == -1)  
                 goto fail;  
   
         /* Create both temporary output files. */  
   
         (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));          mandoc_ohash_init(&tag_data, 4, offsetof(struct tag_entry, s));
         return &tag_files;  }
   
 fail:  void
         tag_unlink();  tag_free(void)
         if (ofd != -1)  {
                 close(ofd);          struct tag_entry        *entry;
         if (tag_files.ofd != -1)          unsigned int             slot;
                 close(tag_files.ofd);  
         if (tag_files.tfd != -1)          if (tag_data.info.free == NULL)
                 close(tag_files.tfd);                  return;
         *tag_files.ofn = '\0';          entry = ohash_first(&tag_data, &slot);
         *tag_files.tfn = '\0';          while (entry != NULL) {
         tag_files.ofd = -1;                  free(entry->nodes);
         tag_files.tfd = -1;                  free(entry);
         return NULL;                  entry = ohash_next(&tag_data, &slot);
           }
           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 higher priority.   * unless it 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;
   
         /* Sanity checks. */          assert(prio <= TAG_FALLBACK);
   
         if (tag_files.tfd <= 0)          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;                  return;
         if (s[0] == '\\' && (s[1] == '&' || s[1] == 'e'))  
                 s += 2;  
         if (*s == '\0' || strchr(s, ' ') != NULL)  
                 return;  
   
         slot = ohash_qlookup(&tag_data, s);          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);
   
         if (entry == NULL) {          /* Build a new entry. */
   
                 /* Build a new entry. */          if (entry == NULL) {
                   entry = mandoc_malloc(sizeof(*entry) + len + 1);
                 len = strlen(s) + 1;  
                 entry = mandoc_malloc(sizeof(*entry) + len);  
                 memcpy(entry->s, s, len);                  memcpy(entry->s, s, len);
                 entry->lines = NULL;                  entry->s[len] = '\0';
                 entry->maxlines = entry->nlines = 0;                  entry->nodes = NULL;
                   entry->maxnodes = entry->nnodes = 0;
                 ohash_insert(&tag_data, slot, entry);                  ohash_insert(&tag_data, slot, entry);
           }
   
         } else {          /*
            * Lower priority numbers take precedence.
            * If a better entry is already present, ignore the new one.
            */
   
                 /* Handle priority 0 entries. */          else if (entry->prio < prio)
   
                 if (prio == 0) {  
                         if (entry->prio == 0)  
                                 entry->prio = -1;  
                         return;                          return;
                 }  
   
                 /* A better entry is already present, ignore the new one. */          /*
            * 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 (entry->prio > 0 && entry->prio < prio)          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;                          return;
                   }
                 /* The existing entry is worse, clear it. */  
   
                 if (entry->prio < 1 || entry->prio > prio)  
                         entry->nlines = 0;  
         }          }
   
         /* Remember the new line. */          /* Remember the new node. */
   
         if (entry->maxlines == entry->nlines) {          if (entry->maxnodes == entry->nnodes) {
                 entry->maxlines += 4;                  entry->maxnodes += 4;
                 entry->lines = mandoc_reallocarray(entry->lines,                  entry->nodes = mandoc_reallocarray(entry->nodes,
                     entry->maxlines, sizeof(*entry->lines));                      entry->maxnodes, sizeof(*entry->nodes));
         }          }
         entry->lines[entry->nlines++] = line;          entry->nodes[entry->nnodes++] = n;
         entry->prio = prio;          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);
           }
 }  }
   
   int
   tag_exists(const char *tag)
   {
           return ohash_find(&tag_data, ohash_qlookup(&tag_data, tag)) != NULL;
   }
   
 /*  /*
  * Write out the tags file using the previously collected   * For in-line elements, move the link target
  * information and clear the ohash table while going along.   * to the enclosing paragraph when appropriate.
  */   */
 void  static void
 tag_write(void)  tag_move_id(struct roff_node *n)
 {  {
         FILE                    *stream;          struct roff_node *np;
         struct tag_entry        *entry;  
         size_t                   i;  
         unsigned int             slot;  
   
         if (tag_files.tfd <= 0)          np = n;
                 return;          for (;;) {
         stream = fdopen(tag_files.tfd, "w");                  if (np->prev != NULL)
         entry = ohash_first(&tag_data, &slot);                          np = np->prev;
         while (entry != NULL) {                  else if ((np = np->parent) == NULL)
                 if (stream != NULL && entry->prio >= 0)                          return;
                         for (i = 0; i < entry->nlines; i++)                  switch (np->tok) {
                                 fprintf(stream, "%s %s %zu\n",                  case MDOC_It:
                                     entry->s, tag_files.ofn, entry->lines[i]);                          switch (np->parent->parent->norm->Bl.type) {
                 free(entry->lines);                          case LIST_column:
                 free(entry);                                  /* Target the ROFFT_BLOCK = <tr>. */
                 entry = ohash_next(&tag_data, &slot);                                  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;
                   }
         }          }
         ohash_delete(&tag_data);  
         if (stream != NULL)  
                 fclose(stream);  
         else  
                 close(tag_files.tfd);  
         tag_files.tfd = -1;  
 }  }
   
 void  /*
 tag_unlink(void)   * When a paragraph is tagged and starts with text,
    * move the permalink to the first few words.
    */
   static void
   tag_move_href(struct roff_man *man, struct roff_node *n, const char *tag)
 {  {
         pid_t    tc_pgid;          char    *cp;
   
         if (tag_files.tcpgid != -1) {          if (n == NULL || n->type != ROFFT_TEXT ||
                 tc_pgid = tcgetpgrp(tag_files.ofd);              *n->string == '\0' || *n->string == ' ')
                 if (tc_pgid == tag_files.pager_pid ||                  return;
                     tc_pgid == getpgid(0) ||  
                     getpgid(tc_pgid) == -1)          cp = n->string;
                         (void)tcsetpgrp(tag_files.ofd, tag_files.tcpgid);          while (cp != NULL && cp - n->string < 5)
                   cp = strchr(cp + 1, ' ');
   
           /* 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';
         }          }
         if (*tag_files.ofn != '\0')  
                 unlink(tag_files.ofn);          assert(n->tag == NULL);
         if (*tag_files.tfn != '\0')          n->tag = mandoc_strdup(tag);
                 unlink(tag_files.tfn);          n->flags |= NODE_HREF;
 }  }
   
 static void  /*
 tag_signal(int signum)   * 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)
 {  {
         struct sigaction         sa;          if (n->flags & NODE_ID) {
                   switch (n->tok) {
         tag_unlink();                  case MDOC_Pp:
         memset(&sa, 0, sizeof(sa));                          tag_move_href(man, n->next, n->tag);
         sigemptyset(&sa.sa_mask);                          break;
         sa.sa_handler = SIG_DFL;                  case MDOC_Bd:
         sigaction(signum, &sa, NULL);                  case MDOC_D1:
         kill(getpid(), signum);                  case MDOC_Dl:
         /* NOTREACHED */                          tag_move_href(man, n->child, n->tag);
         _exit(1);                          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.19  
changed lines
  Added in v.1.36
CVSweb