When a .Tg is attached to a paragraph, attach the permalink

[mandoc.git] / tag.c

diff --git a/tag.c b/tag.c
index 6f264c8032a9cded76c0f869158255f859af3c00..105f19e1270cd10f08b91c208d7c9ea9d22186a1 100644 (file)
--- a/tag.c
+++ b/tag.c
@@ -1,6 +1,6 @@
-/*      $Id: tag.c,v 1.8 2015/10/06 18:32:20 schwarze Exp $    */
+/* $Id: tag.c,v 1.35 2020/04/18 20:40:10 schwarze Exp $ */

 /*
 /*

- * 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
  * purpose with or without fee is hereby granted, provided that the above
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above


@@ -13,201 +13,298 @@
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * 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 "config.h"
 
 #include <sys/types.h>
 

-#include <signal.h>
+#include <assert.h>
+#include <limits.h>

 #include <stddef.h>
 #include <stdint.h>
 #include <stddef.h>
 #include <stdint.h>

-#include <stdio.h>

 #include <stdlib.h>
 #include <string.h>
 #include <stdlib.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"
 
 struct tag_entry {
 #include "tag.h"
 
 struct tag_entry {

-       size_t   line;
+       struct roff_node **nodes;
+       size_t   maxnodes;
+       size_t   nnodes;

        int      prio;
        char     s[];
 };
 
        int      prio;
        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 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.
- * Not all pagers are capable of using a tag file,
- * but for simplicity, create it anyway.
+ * Set up the ohash table to collect nodes
+ * where various marked-up terms are documented.

  */
  */

-struct tag_files *
-tag_init(void)
+void
+tag_alloc(void)

 {
 {

-       struct ohash_info        tag_info;
-       int                      ofd;
-
-       ofd = -1;
-       tag_files.tfd = -1;
-
-       /* 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));
-       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);
+       mandoc_ohash_init(&tag_data, 4, offsetof(struct tag_entry, s));
+}

 
 

-       /*
-        * Set up the ohash table to collect output line numbers
-        * where various marked-up terms are documented.
-        */
+void
+tag_free(void)
+{
+       struct tag_entry        *entry;
+       unsigned int             slot;

 
 

-       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;
+       if (tag_data.info.free == NULL)
+               return;
+       entry = ohash_first(&tag_data, &slot);
+       while (entry != NULL) {
+               free(entry->nodes);
+               free(entry);
+               entry = ohash_next(&tag_data, &slot);
+       }
+       ohash_delete(&tag_data);
+       tag_data.info.free = NULL;

 }
 
 /*
 }
 
 /*

- * Set the line number where a term is defined,
- * unless it is already defined at a higher priority.
+ * Set a node where a term is defined,
+ * 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;
        unsigned int             slot;
 
        size_t                   len;
        unsigned int             slot;
 

-       if (tag_files.tfd <= 0)
+       assert(prio <= TAG_FALLBACK);
+
+       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;

-       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);

+
+       /* Build a new entry. */
+

        if (entry == NULL) {
        if (entry == NULL) {

-               len = strlen(s) + 1;
-               entry = mandoc_malloc(sizeof(*entry) + len);
+               entry = mandoc_malloc(sizeof(*entry) + len + 1);

                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
- * information and clear the ohash table while going along.
- */
-void
-tag_write(void)
-{
-       FILE                    *stream;
-       struct tag_entry        *entry;
-       unsigned int             slot;
+       /*
+        * Lower priority numbers take precedence.
+        * If a better entry is already present, ignore the new one.
+        */

 
 

-       if (tag_files.tfd <= 0)
-               return;
-       stream = fdopen(tag_files.tfd, "w");
-       entry = ohash_first(&tag_data, &slot);
-       while (entry != NULL) {
-               if (stream != NULL)
-                       fprintf(stream, "%s %s %zu\n",
-                           entry->s, tag_files.ofn, entry->line);
-               free(entry);
-               entry = ohash_next(&tag_data, &slot);
+       else if (entry->prio < prio)
+                       return;
+
+       /*
+        * 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.
+        */
+
+       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)
-               fclose(stream);
-}

 
 

-void
-tag_unlink(void)
-{
+       /* Remember the new node. */

 
 

-       if (*tag_files.ofn != '\0')
-               unlink(tag_files.ofn);
-       if (*tag_files.tfn != '\0')
-               unlink(tag_files.tfn);
+       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);
+       }

 }
 
 }
 

-static void
-tag_signal(int signum)
+int
+tag_exists(const char *tag)

 {
 {

-
-       tag_unlink();
-       signal(signum, SIG_DFL);
-       kill(getpid(), signum);
-       /* NOTREACHED */
-       _exit(1);
+       return ohash_find(&tag_data, ohash_qlookup(&tag_data, tag)) != NULL;

 }
 
 /*
 }
 
 /*

- * Memory management callback functions for ohash.
+ * For in-line elements, move the link target
+ * to the enclosing paragraph when appropriate.

  */
  */

-static void *
-tag_alloc(size_t sz, void *arg)
-{
-
-       return mandoc_malloc(sz);
-}
-
-static void *
-tag_calloc(size_t nmemb, size_t sz, void *arg)
+static void
+tag_move_id(struct roff_node *n)

 {
 {

+       struct roff_node *np;

 
 

-       return mandoc_calloc(nmemb, sz);
+       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;
+               }
+       }

 }
 
 }
 

-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)

 {
 {

+       struct roff_node        *nn;
+       char                    *cp;

 
 

-       free(p);
+       if (n->flags & NODE_ID) {
+               switch (n->tok) {
+               case MDOC_Pp:
+                       nn = n->next;
+                       if (nn == NULL || nn->type != ROFFT_TEXT ||
+                           *nn->string == '\0' || *nn->string == ' ')
+                               break;
+                       /* Use the first few letters for the permalink. */
+                       cp = nn->string;
+                       while (cp != NULL && cp - nn->string < 5)
+                               cp = strchr(cp + 1, ' ');
+                       if (cp != NULL && cp[1] != '\0') {
+                               /* Split a longer text node. */
+                               man->last = nn;
+                               man->next = ROFF_NEXT_SIBLING;
+                               roff_word_alloc(man, nn->line,
+                                   nn->pos + (cp - nn->string), cp + 1);
+                               man->last->flags = nn->flags;
+                               *cp = '\0';
+                       }
+                       assert(nn->tag == NULL);
+                       nn->tag = mandoc_strdup(n->tag);
+                       nn->flags |= NODE_HREF;
+                       break;
+               case MDOC_Bd:
+               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);

 }
 }