=================================================================== RCS file: /cvs/mandoc/tag.c,v retrieving revision 1.4 retrieving revision 1.26 diff -u -p -r1.4 -r1.26 --- mandoc/tag.c 2015/07/25 14:02:06 1.4 +++ mandoc/tag.c 2020/01/19 18:02:00 1.26 @@ -1,6 +1,6 @@ -/* $Id: tag.c,v 1.4 2015/07/25 14:02:06 schwarze Exp $ */ +/* $Id: tag.c,v 1.26 2020/01/19 18:02:00 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 @@ -14,114 +14,206 @@ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ +#include "config.h" + #include +#include +#include #include #include +#include #include #include #include #include -#if HAVE_OHASH -#include -#else -#include "compat_ohash.h" -#endif - #include "mandoc_aux.h" +#include "mandoc_ohash.h" +#include "mandoc.h" #include "tag.h" struct tag_entry { - size_t line; + size_t *lines; + size_t maxlines; + size_t nlines; 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_signal(int) __attribute__((__noreturn__)); static struct ohash tag_data; -static char *tag_fn = NULL; -static int tag_fd = -1; +static struct tag_files tag_files; /* - * Set up the ohash table to collect output line numbers - * where various marked-up terms are documented and create - * the temporary tags file, saving the name for the pager. + * Prepare for using a pager. + * Not all pagers are capable of using a tag file, + * but for simplicity, create it anyway. */ -char * -tag_init(void) +struct tag_files * +tag_init(char *tagname) { - struct ohash_info tag_info; + struct sigaction sa; + int ofd; - tag_fn = mandoc_strdup("/tmp/man.XXXXXXXXXX"); - signal(SIGHUP, tag_signal); - signal(SIGINT, tag_signal); - signal(SIGTERM, tag_signal); - if ((tag_fd = mkstemp(tag_fn)) == -1) { - free(tag_fn); - tag_fn = NULL; - return(NULL); + ofd = -1; + tag_files.tfd = -1; + tag_files.tcpgid = -1; + tag_files.tagname = tagname; + + /* 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) { + mandoc_msg(MANDOCERR_DUP, 0, 0, "%s", strerror(errno)); + goto fail; } - 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_fn); -} + /* Create both temporary output files. */ -/* - * Return the line number where a term is defined, - * or 0 if the term is unknown. - */ -size_t -tag_get(const char *s, size_t len, int prio) -{ - struct tag_entry *entry; - const char *end; - unsigned int slot; + (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) { + mandoc_msg(MANDOCERR_MKSTEMP, 0, 0, + "%s: %s", tag_files.ofn, strerror(errno)); + goto fail; + } + if ((tag_files.tfd = mkstemp(tag_files.tfn)) == -1) { + mandoc_msg(MANDOCERR_MKSTEMP, 0, 0, + "%s: %s", tag_files.tfn, strerror(errno)); + goto fail; + } + if (dup2(ofd, STDOUT_FILENO) == -1) { + mandoc_msg(MANDOCERR_DUP, 0, 0, "%s", strerror(errno)); + goto fail; + } + close(ofd); - if (tag_fd == -1) - return(0); - if (len == 0) - len = strlen(s); - end = s + len; - slot = ohash_qlookupi(&tag_data, s, &end); - entry = ohash_find(&tag_data, slot); - return((entry == NULL || prio < entry->prio) ? 0 : entry->line); + /* + * 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; + tag_files.tagname = NULL; + return NULL; } /* - * Set the line number where a term is defined. + * Set the line number where a term is defined, + * unless it is already defined at a lower priority. */ void -tag_put(const char *s, size_t len, int prio, size_t line) +tag_put(const char *s, int prio, size_t line) { struct tag_entry *entry; - const char *end; + const char *se; + size_t len; unsigned int slot; - if (tag_fd == -1) + if (tag_files.tfd <= 0) return; + + if (s[0] == '\\' && (s[1] == '&' || s[1] == 'e')) + s += 2; + + /* + * Skip whitespace and escapes and whatever follows, + * and if there is any, downgrade the priority. + */ + + len = strcspn(s, " \t\\"); if (len == 0) - len = strlen(s); - end = s + len; - slot = ohash_qlookupi(&tag_data, s, &end); + return; + + se = s + len; + if (*se != '\0') + prio = INT_MAX; + + slot = ohash_qlookupi(&tag_data, s, &se); entry = ohash_find(&tag_data, slot); + if (entry == NULL) { + + /* Build a new entry. */ + entry = mandoc_malloc(sizeof(*entry) + len + 1); memcpy(entry->s, s, len); entry->s[len] = '\0'; + entry->lines = NULL; + entry->maxlines = entry->nlines = 0; ohash_insert(&tag_data, slot, entry); + + } else { + + /* + * Lower priority numbers take precedence, + * but 0 is special. + * A tag with priority 0 is only used + * if the tag occurs exactly once. + */ + + if (prio == 0) { + if (entry->prio == 0) + entry->prio = -1; + return; + } + + /* A better entry is already present, ignore the new one. */ + + if (entry->prio != -1 && entry->prio < prio) + return; + + /* The existing entry is worse, clear it. */ + + if (entry->prio == -1 || entry->prio == 0 || + entry->prio > prio) + entry->nlines = 0; } - entry->line = line; + + /* Remember the new line. */ + + if (entry->maxlines == entry->nlines) { + entry->maxlines += 4; + entry->lines = mandoc_reallocarray(entry->lines, + entry->maxlines, sizeof(*entry->lines)); + } + entry->lines[entry->nlines++] = line; entry->prio = prio; } @@ -134,62 +226,74 @@ tag_write(void) { FILE *stream; struct tag_entry *entry; + size_t i; unsigned int slot; + int empty; - if (tag_fd == -1) + if (tag_files.tfd <= 0) return; - stream = fdopen(tag_fd, "w"); + if (tag_files.tagname != NULL && ohash_find(&tag_data, + ohash_qlookup(&tag_data, tag_files.tagname)) == NULL) { + mandoc_msg(MANDOCERR_TAG, 0, 0, "%s", tag_files.tagname); + tag_files.tagname = NULL; + } + if ((stream = fdopen(tag_files.tfd, "w")) == NULL) + mandoc_msg(MANDOCERR_FDOPEN, 0, 0, "%s", strerror(errno)); + empty = 1; entry = ohash_first(&tag_data, &slot); while (entry != NULL) { - if (stream != NULL) - fprintf(stream, "%s - %zu\n", entry->s, entry->line); + if (stream != NULL && entry->prio != -1) { + for (i = 0; i < entry->nlines; i++) { + fprintf(stream, "%s %s %zu\n", + entry->s, tag_files.ofn, entry->lines[i]); + empty = 0; + } + } + free(entry->lines); free(entry); entry = ohash_next(&tag_data, &slot); } ohash_delete(&tag_data); if (stream != NULL) fclose(stream); + else + close(tag_files.tfd); + tag_files.tfd = -1; + if (empty) { + unlink(tag_files.tfn); + *tag_files.tfn = '\0'; + } } void tag_unlink(void) { + pid_t tc_pgid; - if (tag_fn != NULL) - unlink(tag_fn); + if (tag_files.tcpgid != -1) { + tc_pgid = tcgetpgrp(tag_files.ofd); + if (tc_pgid == tag_files.pager_pid || + tc_pgid == getpgid(0) || + getpgid(tc_pgid) == -1) + (void)tcsetpgrp(tag_files.ofd, tag_files.tcpgid); + } + if (*tag_files.ofn != '\0') + unlink(tag_files.ofn); + if (*tag_files.tfn != '\0') + unlink(tag_files.tfn); } static void tag_signal(int signum) { + struct sigaction sa; tag_unlink(); - signal(signum, SIG_DFL); + memset(&sa, 0, sizeof(sa)); + sigemptyset(&sa.sa_mask); + sa.sa_handler = SIG_DFL; + sigaction(signum, &sa, NULL); kill(getpid(), signum); /* NOTREACHED */ _exit(1); -} - -/* - * Memory management callback functions for ohash. - */ -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) -{ - - return(mandoc_calloc(nmemb, sz)); -} - -static void -tag_free(void *p, void *arg) -{ - - free(p); }