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

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

version 1.29, 2020/03/13 16:16:58 version 1.38, 2023/11/24 05:02:18
Line 1 
Line 1 
 /* $Id$ */  /* $Id$ */
 /*  /*
  * Copyright (c) 2015,2016,2018,2019,2020 Ingo Schwarze <schwarze@openbsd.org>   * Copyright (c) 2015, 2016, 2018, 2019, 2020, 2022, 2023
    *               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 24 
Line 25 
 #include <assert.h>  #include <assert.h>
 #include <limits.h>  #include <limits.h>
 #include <stddef.h>  #include <stddef.h>
   #include <stdint.h>
   #include <stdio.h>
 #include <stdlib.h>  #include <stdlib.h>
 #include <string.h>  #include <string.h>
   
 #include "mandoc_aux.h"  #include "mandoc_aux.h"
 #include "mandoc_ohash.h"  #include "mandoc_ohash.h"
   #include "mandoc.h"
 #include "roff.h"  #include "roff.h"
   #include "mdoc.h"
   #include "roff_int.h"
 #include "tag.h"  #include "tag.h"
   
 struct tag_entry {  struct tag_entry {
Line 40  struct tag_entry {
Line 46  struct tag_entry {
         char     s[];          char     s[];
 };  };
   
   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;
   
   
Line 73  tag_free(void)
Line 83  tag_free(void)
   
 /*  /*
  * Set a node where a term is defined,   * Set a node where a term is defined,
  * unless it is already defined at a lower priority.   * unless the term is already defined at a lower priority.
  */   */
 void  void
 tag_put(const char *s, int prio, struct roff_node *n)  tag_put(const char *s, int prio, struct roff_node *n)
 {  {
         struct tag_entry        *entry;          struct tag_entry        *entry;
         const char              *se;          struct roff_node        *nold;
           const char              *se, *src;
           char                    *cpy;
         size_t                   len;          size_t                   len;
         unsigned int             slot;          unsigned int             slot;
           int                      changed;
   
         assert(prio <= TAG_FALLBACK);          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;
   
           /* Determine the implicit tag. */
   
           changed = 1;
         if (s == NULL) {          if (s == NULL) {
                 if (n->child == NULL || n->child->type != ROFFT_TEXT)                  if (n->child == NULL || n->child->type != ROFFT_TEXT)
                         return;                          return;
                 s = n->child->string;                  s = n->child->string;
                 if (s[0] == '\\' && (s[1] == '&' || s[1] == 'e'))                  switch (s[0]) {
                         s += 2;                  case '-':
                           s++;
                           break;
                   case '\\':
                           switch (s[1]) {
                           case '&':
                           case '-':
                           case 'e':
                                   s += 2;
                                   break;
                           default:
                                   return;
                           }
                           break;
                   default:
                           changed = 0;
                           break;
                   }
         }          }
   
         /*          /*
            * Translate \- and ASCII_HYPH to plain '-'.
          * Skip whitespace and escapes and whatever follows,           * Skip whitespace and escapes and whatever follows,
          * and if there is any, downgrade the priority.           * and if there is any, downgrade the priority.
          */           */
   
         len = strcspn(s, " \t\\");          cpy = mandoc_malloc(strlen(s) + 1);
           for (src = s, len = 0; *src != '\0'; src++, len++) {
                   switch (*src) {
                   case '\t':
                   case ' ':
                           changed = 1;
                           break;
                   case ASCII_HYPH:
                           cpy[len] = '-';
                           changed = 1;
                           continue;
                   case '\\':
                           if (src[1] != '-')
                                   break;
                           src++;
                           changed = 1;
                           /* FALLTHROUGH */
                   default:
                           cpy[len] = *src;
                           continue;
                   }
                   break;
           }
         if (len == 0)          if (len == 0)
                 return;                  goto out;
           cpy[len] = '\0';
   
         se = s + len;          if (*src != '\0' && prio < TAG_WEAK)
         if (*se != '\0' && prio < TAG_WEAK)  
                 prio = TAG_WEAK;                  prio = TAG_WEAK;
   
           s = cpy;
           se = cpy + len;
         slot = ohash_qlookupi(&tag_data, s, &se);          slot = ohash_qlookupi(&tag_data, s, &se);
         entry = ohash_find(&tag_data, slot);          entry = ohash_find(&tag_data, slot);
   
Line 113  tag_put(const char *s, int prio, struct roff_node *n)
Line 181  tag_put(const char *s, int prio, struct roff_node *n)
   
         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 + 1);
                 entry->s[len] = '\0';  
                 entry->nodes = NULL;                  entry->nodes = NULL;
                 entry->maxnodes = entry->nnodes = 0;                  entry->maxnodes = entry->nnodes = 0;
                 ohash_insert(&tag_data, slot, entry);                  ohash_insert(&tag_data, slot, entry);
Line 126  tag_put(const char *s, int prio, struct roff_node *n)
Line 193  tag_put(const char *s, int prio, struct roff_node *n)
          */           */
   
         else if (entry->prio < prio)          else if (entry->prio < prio)
                         return;                  goto out;
   
         /*          /*
          * If the existing entry is worse, clear it.           * If the existing entry is worse, clear it.
Line 135  tag_put(const char *s, int prio, struct roff_node *n)
Line 202  tag_put(const char *s, int prio, struct roff_node *n)
          */           */
   
         else if (entry->prio > prio || prio == TAG_FALLBACK) {          else if (entry->prio > prio || prio == TAG_FALLBACK) {
                 while (entry->nnodes > 0)                  while (entry->nnodes > 0) {
                         entry->nodes[--entry->nnodes]->flags &= ~NODE_ID;                          nold = entry->nodes[--entry->nnodes];
                           nold->flags &= ~NODE_ID;
                           free(nold->tag);
                           nold->tag = NULL;
                   }
                 if (prio == TAG_FALLBACK) {                  if (prio == TAG_FALLBACK) {
                         entry->prio = TAG_DELETE;                          entry->prio = TAG_DELETE;
                         return;                          goto out;
                 }                  }
         }          }
   
Line 154  tag_put(const char *s, int prio, struct roff_node *n)
Line 224  tag_put(const char *s, int prio, struct roff_node *n)
         entry->nodes[entry->nnodes++] = n;          entry->nodes[entry->nnodes++] = n;
         entry->prio = prio;          entry->prio = prio;
         n->flags |= NODE_ID;          n->flags |= NODE_ID;
         if (n->child == NULL || n->child->string != s || *se != '\0') {          if (changed) {
                 assert(n->string == NULL);                  assert(n->tag == NULL);
                 n->string = mandoc_strndup(s, len);                  n->tag = mandoc_strndup(s, len);
         }          }
   
    out:
           free(cpy);
 }  }
   
 enum tag_result  int
 tag_check(const char *test_tag)  tag_exists(const char *tag)
 {  {
         unsigned int slot;          return ohash_find(&tag_data, ohash_qlookup(&tag_data, tag)) != NULL;
   }
   
         if (ohash_first(&tag_data, &slot) == NULL)  /*
                 return TAG_EMPTY;   * For in-line elements, move the link target
         else if (test_tag != NULL && ohash_find(&tag_data,   * to the enclosing paragraph when appropriate.
             ohash_qlookup(&tag_data, test_tag)) == NULL)   */
                 return TAG_MISS;  static void
         else  tag_move_id(struct roff_node *n)
                 return TAG_OK;  {
           struct roff_node *np;
   
           np = n;
           for (;;) {
                   if (np->prev != NULL)
                           np = np->prev;
                   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;
                   }
           }
   }
   
   /*
    * 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)
   {
           char    *cp;
   
           if (n == NULL || n->type != ROFFT_TEXT ||
               *n->string == '\0' || *n->string == ' ')
                   return;
   
           cp = n->string;
           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';
           }
   
           assert(n->tag == NULL);
           n->tag = mandoc_strdup(tag);
           n->flags |= NODE_HREF;
   }
   
   /*
    * 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) {
                   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.29  
changed lines
  Added in v.1.38
CVSweb