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

Diff for /mandoc/html.c between version 1.263 and 1.269

version 1.263, 2020/02/27 22:28:13 version 1.269, 2020/04/19 15:16:56
Line 1 
Line 1 
 /*      $Id$ */  /* $Id$ */
 /*  /*
  * Copyright (c) 2008-2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>  
  * Copyright (c) 2011-2015, 2017-2020 Ingo Schwarze <schwarze@openbsd.org>   * Copyright (c) 2011-2015, 2017-2020 Ingo Schwarze <schwarze@openbsd.org>
    * Copyright (c) 2008-2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
  *   *
  * 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 
  * 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.
    *
    * Common functions for mandoc(1) HTML formatters.
    * For use by individual formatters and by the main program.
  */   */
 #include "config.h"  #include "config.h"
   
Line 109  static const struct htmldata htmltags[TAG_MAX] = {
Line 112  static const struct htmldata htmltags[TAG_MAX] = {
 };  };
   
 /* Avoid duplicate HTML id= attributes. */  /* Avoid duplicate HTML id= attributes. */
   
   struct  id_entry {
           int      ord;   /* Ordinal number of the latest occurrence. */
           char     id[];  /* The id= attribute without any ordinal suffix. */
   };
 static  struct ohash     id_unique;  static  struct ohash     id_unique;
   
 static  void     html_reset_internal(struct html *);  static  void     html_reset_internal(struct html *);
Line 143  html_alloc(const struct manoutput *outopts)
Line 151  html_alloc(const struct manoutput *outopts)
         if (outopts->toc)          if (outopts->toc)
                 h->oflags |= HTML_TOC;                  h->oflags |= HTML_TOC;
   
         mandoc_ohash_init(&id_unique, 4, 0);          mandoc_ohash_init(&id_unique, 4, offsetof(struct id_entry, id));
   
         return h;          return h;
 }  }
Line 152  static void
Line 160  static void
 html_reset_internal(struct html *h)  html_reset_internal(struct html *h)
 {  {
         struct tag      *tag;          struct tag      *tag;
         char            *cp;          struct id_entry *entry;
         unsigned int     slot;          unsigned int     slot;
   
         while ((tag = h->tag) != NULL) {          while ((tag = h->tag) != NULL) {
                 h->tag = tag->next;                  h->tag = tag->next;
                 free(tag);                  free(tag);
         }          }
         cp = ohash_first(&id_unique, &slot);          entry = ohash_first(&id_unique, &slot);
         while (cp != NULL) {          while (entry != NULL) {
                 free(cp);                  free(entry);
                 cp = ohash_next(&id_unique, &slot);                  entry = ohash_next(&id_unique, &slot);
         }          }
         ohash_delete(&id_unique);          ohash_delete(&id_unique);
 }  }
Line 171  void
Line 179  void
 html_reset(void *p)  html_reset(void *p)
 {  {
         html_reset_internal(p);          html_reset_internal(p);
         mandoc_ohash_init(&id_unique, 4, 0);          mandoc_ohash_init(&id_unique, 4, offsetof(struct id_entry, id));
 }  }
   
 void  void
Line 321  html_fillmode(struct html *h, enum roff_tok want)
Line 329  html_fillmode(struct html *h, enum roff_tok want)
         return had;          return had;
 }  }
   
   /*
    * Allocate a string to be used for the "id=" attribute of an HTML
    * element and/or as a segment identifier for a URI in an <a> element.
    * The function may fail and return NULL if the node lacks text data
    * to create the attribute from.
    * The caller is responsible for free(3)ing the returned string.
    *
    * If the "unique" argument is non-zero, the "id_unique" ohash table
    * is used for de-duplication.  If the "unique" argument is 1,
    * it is the first time the function is called for this tag and
    * location, so if an ordinal suffix is needed, it is incremented.
    * If the "unique" argument is 2, it is the second time the function
    * is called for this tag and location, so the ordinal suffix
    * remains unchanged.
    */
 char *  char *
 html_make_id(const struct roff_node *n, int unique)  html_make_id(const struct roff_node *n, int unique)
 {  {
         const struct roff_node  *nch;          const struct roff_node  *nch;
         char                    *buf, *bufs, *cp;          struct id_entry         *entry;
           char                    *buf, *cp;
           size_t                   len;
         unsigned int             slot;          unsigned int             slot;
         int                      suffix;  
   
         for (nch = n->child; nch != NULL; nch = nch->next)          if (n->tag != NULL)
                 if (nch->type != ROFFT_TEXT)                  buf = mandoc_strdup(n->tag);
                         return NULL;          else {
                   switch (n->tok) {
                   case MDOC_Sh:
                   case MDOC_Ss:
                   case MDOC_Sx:
                   case MAN_SH:
                   case MAN_SS:
                           for (nch = n->child; nch != NULL; nch = nch->next)
                                   if (nch->type != ROFFT_TEXT)
                                           return NULL;
                           buf = NULL;
                           deroff(&buf, n);
                           if (buf == NULL)
                                   return NULL;
                           break;
                   default:
                           if (n->child == NULL || n->child->type != ROFFT_TEXT)
                                   return NULL;
                           buf = mandoc_strdup(n->child->string);
                           break;
                   }
           }
   
         buf = NULL;  
         deroff(&buf, n);  
         if (buf == NULL)  
                 return NULL;  
   
         /*          /*
          * In ID attributes, only use ASCII characters that are           * In ID attributes, only use ASCII characters that are
          * permitted in URL-fragment strings according to the           * permitted in URL-fragment strings according to the
Line 355  html_make_id(const struct roff_node *n, int unique)
Line 395  html_make_id(const struct roff_node *n, int unique)
   
         /* Avoid duplicate HTML id= attributes. */          /* Avoid duplicate HTML id= attributes. */
   
         bufs = NULL;  
         suffix = 1;  
         slot = ohash_qlookup(&id_unique, buf);          slot = ohash_qlookup(&id_unique, buf);
         cp = ohash_find(&id_unique, slot);          if ((entry = ohash_find(&id_unique, slot)) == NULL) {
         if (cp != NULL) {                  len = strlen(buf) + 1;
                 while (cp != NULL) {                  entry = mandoc_malloc(sizeof(*entry) + len);
                         free(bufs);                  entry->ord = 1;
                         if (++suffix > 127) {                  memcpy(entry->id, buf, len);
                                 free(buf);                  ohash_insert(&id_unique, slot, entry);
                                 return NULL;          } else if (unique == 1)
                         }                  entry->ord++;
                         mandoc_asprintf(&bufs, "%s_%d", buf, suffix);  
                         slot = ohash_qlookup(&id_unique, bufs);          if (entry->ord > 1) {
                         cp = ohash_find(&id_unique, slot);                  cp = buf;
                 }                  mandoc_asprintf(&buf, "%s_%d", cp, entry->ord);
                 free(buf);                  free(cp);
                 buf = bufs;  
         }          }
         ohash_insert(&id_unique, slot, buf);  
         return buf;          return buf;
 }  }
   
Line 736  print_otag(struct html *h, enum htmltag tag, const cha
Line 772  print_otag(struct html *h, enum htmltag tag, const cha
         return t;          return t;
 }  }
   
   /*
    * Print an element with an optional "id=" attribute.
    * If the element has phrasing content and an "id=" attribute,
    * also add a permalink: outside if it can be in phrasing context,
    * inside otherwise.
    */
   struct tag *
   print_otag_id(struct html *h, enum htmltag elemtype, const char *cattr,
       struct roff_node *n)
   {
           struct roff_node *nch;
           struct tag      *ret, *t;
           char            *id, *href;
   
           ret = NULL;
           id = href = NULL;
           if (n->flags & NODE_ID)
                   id = html_make_id(n, 1);
           if (n->flags & NODE_HREF)
                   href = id == NULL ? html_make_id(n, 2) : id;
           if (href != NULL && htmltags[elemtype].flags & HTML_INPHRASE)
                   ret = print_otag(h, TAG_A, "chR", "permalink", href);
           t = print_otag(h, elemtype, "ci", cattr, id);
           if (ret == NULL) {
                   ret = t;
                   if (href != NULL && (nch = n->child) != NULL) {
                           /* man(7) is safe, it tags phrasing content only. */
                           if (n->tok > MDOC_MAX ||
                               htmltags[elemtype].flags & HTML_TOPHRASE)
                                   nch = NULL;
                           else  /* For mdoc(7), beware of nested blocks. */
                                   while (nch != NULL && nch->type == ROFFT_TEXT)
                                           nch = nch->next;
                           if (nch == NULL)
                                   print_otag(h, TAG_A, "chR", "permalink", href);
                   }
           }
           free(id);
           if (id == NULL)
                   free(href);
           return ret;
   }
   
 static void  static void
 print_ctag(struct html *h, struct tag *tag)  print_ctag(struct html *h, struct tag *tag)
 {  {
Line 805  print_gen_comment(struct html *h, struct roff_node *n)
Line 884  print_gen_comment(struct html *h, struct roff_node *n)
 void  void
 print_text(struct html *h, const char *word)  print_text(struct html *h, const char *word)
 {  {
           print_tagged_text(h, word, NULL);
   }
   
   void
   print_tagged_text(struct html *h, const char *word, struct roff_node *n)
   {
           struct tag      *t;
           char            *href;
   
         /*          /*
          * Always wrap text in a paragraph unless already contained in           * Always wrap text in a paragraph unless already contained in
          * some flow container; never put it directly into a section.           * some flow container; never put it directly into a section.
Line 825  print_text(struct html *h, const char *word)
Line 913  print_text(struct html *h, const char *word)
         }          }
   
         /*          /*
          * Print the text, optionally surrounded by HTML whitespace,           * Optionally switch fonts, optionally write a permalink, then
          * optionally manually switching fonts before and after.           * print the text, optionally surrounded by HTML whitespace.
          */           */
   
         assert(h->metaf == NULL);          assert(h->metaf == NULL);
         print_metaf(h);          print_metaf(h);
         print_indent(h);          print_indent(h);
   
           if (n != NULL && (href = html_make_id(n, 2)) != NULL) {
                   t = print_otag(h, TAG_A, "chR", "permalink", href);
                   free(href);
           } else
                   t = NULL;
   
         if ( ! print_encode(h, word, NULL, 0)) {          if ( ! print_encode(h, word, NULL, 0)) {
                 if ( ! (h->flags & HTML_NONOSPACE))                  if ( ! (h->flags & HTML_NONOSPACE))
                         h->flags &= ~HTML_NOSPACE;                          h->flags &= ~HTML_NOSPACE;
Line 842  print_text(struct html *h, const char *word)
Line 937  print_text(struct html *h, const char *word)
         if (h->metaf != NULL) {          if (h->metaf != NULL) {
                 print_tagq(h, h->metaf);                  print_tagq(h, h->metaf);
                 h->metaf = NULL;                  h->metaf = NULL;
         }          } else if (t != NULL)
                   print_tagq(h, t);
   
         h->flags &= ~HTML_IGNDELIM;          h->flags &= ~HTML_IGNDELIM;
 }  }
Legend:
Removed from v.1.263  
changed lines
  Added in v.1.269
CVSweb