=================================================================== RCS file: /cvs/mandoc/tag.c,v retrieving revision 1.12 retrieving revision 1.31 diff -u -p -r1.12 -r1.31 --- mandoc/tag.c 2016/07/08 20:42:15 1.12 +++ mandoc/tag.c 2020/04/02 22:12:55 1.31 @@ -1,6 +1,6 @@ -/* $Id: tag.c,v 1.12 2016/07/08 20:42:15 schwarze Exp $ */ +/* $Id: tag.c,v 1.31 2020/04/02 22:12:55 schwarze Exp $ */ /* - * Copyright (c) 2015 Ingo Schwarze + * Copyright (c) 2015,2016,2018,2019,2020 Ingo Schwarze * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -13,192 +13,171 @@ * 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 -#include +#include +#include #include -#include -#include #include #include -#include #include "mandoc_aux.h" #include "mandoc_ohash.h" +#include "roff.h" #include "tag.h" struct tag_entry { - size_t line; + struct roff_node **nodes; + size_t maxnodes; + size_t nnodes; int prio; char s[]; }; -static void tag_signal(int); - 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 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)); - 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, - * unless it is already defined at a higher priority. - */ void -tag_put(const char *s, int prio, size_t line) +tag_free(void) { struct tag_entry *entry; - size_t len; unsigned int slot; - if (tag_files.tfd <= 0 || strchr(s, ' ') != NULL) + if (tag_data.info.free == NULL) return; - slot = ohash_qlookup(&tag_data, s); - entry = ohash_find(&tag_data, slot); - if (entry == NULL) { - len = strlen(s) + 1; - entry = mandoc_malloc(sizeof(*entry) + len); - memcpy(entry->s, s, len); - ohash_insert(&tag_data, slot, entry); - } else if (entry->prio <= prio) - return; - entry->line = line; - entry->prio = prio; + 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; } /* - * Write out the tags file using the previously collected - * information and clear the ohash table while going along. + * Set a node where a term is defined, + * unless it is already defined at a lower priority. */ void -tag_write(void) +tag_put(const char *s, int prio, struct roff_node *n) { - FILE *stream; struct tag_entry *entry; + const char *se; + 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; - 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); + + 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); + + /* Build a new entry. */ + + if (entry == NULL) { + entry = mandoc_malloc(sizeof(*entry) + len + 1); + memcpy(entry->s, s, len); + entry->s[len] = '\0'; + entry->nodes = NULL; + entry->maxnodes = entry->nnodes = 0; + ohash_insert(&tag_data, slot, entry); } - ohash_delete(&tag_data); - if (stream != NULL) - fclose(stream); -} -void -tag_unlink(void) -{ - pid_t tc_pgid; + /* + * Lower priority numbers take precedence. + * If a better entry is already present, ignore the new one. + */ - if (tag_files.tcpgid != -1) { - tc_pgid = tcgetpgrp(STDIN_FILENO); - if (tc_pgid == tag_files.pager_pid || - tc_pgid == getpgid(0) || - getpgid(tc_pgid) == -1) - (void)tcsetpgrp(STDIN_FILENO, tag_files.tcpgid); + 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) + entry->nodes[--entry->nnodes]->flags &= ~NODE_ID; + + if (prio == TAG_FALLBACK) { + entry->prio = TAG_DELETE; + return; + } } - if (*tag_files.ofn != '\0') - unlink(tag_files.ofn); - if (*tag_files.tfn != '\0') - unlink(tag_files.tfn); + + /* Remember the new node. */ + + 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->string == NULL); + n->string = mandoc_strndup(s, len); + } } -static void -tag_signal(int signum) +int +tag_exists(const char *tag) { - struct sigaction sa; - - tag_unlink(); - memset(&sa, 0, sizeof(sa)); - sigemptyset(&sa.sa_mask); - sa.sa_handler = SIG_DFL; - sigaction(signum, &sa, NULL); - kill(getpid(), signum); - /* NOTREACHED */ - _exit(1); + return ohash_find(&tag_data, ohash_qlookup(&tag_data, tag)) != NULL; }