Annotation of mandoc/tag.c, Revision 1.22
1.22 ! schwarze 1: /* $Id: tag.c,v 1.21 2018/11/22 11:30:23 schwarze Exp $ */
1.1 schwarze 2: /*
1.22 ! schwarze 3: * Copyright (c) 2015, 2016, 2018, 2019 Ingo Schwarze <schwarze@openbsd.org>
1.1 schwarze 4: *
5: * Permission to use, copy, modify, and distribute this software for any
6: * purpose with or without fee is hereby granted, provided that the above
7: * copyright notice and this permission notice appear in all copies.
8: *
9: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16: */
1.7 schwarze 17: #include "config.h"
18:
1.1 schwarze 19: #include <sys/types.h>
20:
1.22 ! schwarze 21: #include <errno.h>
1.20 schwarze 22: #include <limits.h>
1.2 schwarze 23: #include <signal.h>
1.1 schwarze 24: #include <stddef.h>
1.7 schwarze 25: #include <stdint.h>
1.1 schwarze 26: #include <stdio.h>
27: #include <stdlib.h>
28: #include <string.h>
29: #include <unistd.h>
30:
31: #include "mandoc_aux.h"
1.10 schwarze 32: #include "mandoc_ohash.h"
1.22 ! schwarze 33: #include "mandoc.h"
1.1 schwarze 34: #include "tag.h"
35:
36: struct tag_entry {
1.14 schwarze 37: size_t *lines;
38: size_t maxlines;
39: size_t nlines;
1.4 schwarze 40: int prio;
1.1 schwarze 41: char s[];
42: };
43:
1.18 schwarze 44: static void tag_signal(int) __attribute__((__noreturn__));
1.1 schwarze 45:
46: static struct ohash tag_data;
1.6 schwarze 47: static struct tag_files tag_files;
1.1 schwarze 48:
49:
50: /*
1.6 schwarze 51: * Prepare for using a pager.
52: * Not all pagers are capable of using a tag file,
53: * but for simplicity, create it anyway.
1.1 schwarze 54: */
1.6 schwarze 55: struct tag_files *
1.1 schwarze 56: tag_init(void)
57: {
1.11 schwarze 58: struct sigaction sa;
1.6 schwarze 59: int ofd;
1.1 schwarze 60:
1.6 schwarze 61: ofd = -1;
62: tag_files.tfd = -1;
1.11 schwarze 63: tag_files.tcpgid = -1;
1.6 schwarze 64:
1.12 schwarze 65: /* Clean up when dying from a signal. */
66:
67: memset(&sa, 0, sizeof(sa));
68: sigfillset(&sa.sa_mask);
69: sa.sa_handler = tag_signal;
70: sigaction(SIGHUP, &sa, NULL);
71: sigaction(SIGINT, &sa, NULL);
72: sigaction(SIGTERM, &sa, NULL);
73:
74: /*
75: * POSIX requires that a process calling tcsetpgrp(3)
76: * from the background gets a SIGTTOU signal.
77: * In that case, do not stop.
78: */
79:
80: sa.sa_handler = SIG_IGN;
81: sigaction(SIGTTOU, &sa, NULL);
82:
1.6 schwarze 83: /* Save the original standard output for use by the pager. */
84:
1.22 ! schwarze 85: if ((tag_files.ofd = dup(STDOUT_FILENO)) == -1) {
! 86: mandoc_msg(MANDOCERR_DUP, 0, 0, "%s", strerror(errno));
1.6 schwarze 87: goto fail;
1.22 ! schwarze 88: }
1.6 schwarze 89:
90: /* Create both temporary output files. */
91:
92: (void)strlcpy(tag_files.ofn, "/tmp/man.XXXXXXXXXX",
93: sizeof(tag_files.ofn));
94: (void)strlcpy(tag_files.tfn, "/tmp/man.XXXXXXXXXX",
95: sizeof(tag_files.tfn));
1.22 ! schwarze 96: if ((ofd = mkstemp(tag_files.ofn)) == -1) {
! 97: mandoc_msg(MANDOCERR_MKSTEMP, 0, 0,
! 98: "%s: %s", tag_files.ofn, strerror(errno));
1.6 schwarze 99: goto fail;
1.22 ! schwarze 100: }
! 101: if ((tag_files.tfd = mkstemp(tag_files.tfn)) == -1) {
! 102: mandoc_msg(MANDOCERR_MKSTEMP, 0, 0,
! 103: "%s: %s", tag_files.tfn, strerror(errno));
1.6 schwarze 104: goto fail;
1.22 ! schwarze 105: }
! 106: if (dup2(ofd, STDOUT_FILENO) == -1) {
! 107: mandoc_msg(MANDOCERR_DUP, 0, 0, "%s", strerror(errno));
1.6 schwarze 108: goto fail;
1.22 ! schwarze 109: }
1.6 schwarze 110: close(ofd);
111:
112: /*
113: * Set up the ohash table to collect output line numbers
114: * where various marked-up terms are documented.
115: */
1.1 schwarze 116:
1.10 schwarze 117: mandoc_ohash_init(&tag_data, 4, offsetof(struct tag_entry, s));
1.8 schwarze 118: return &tag_files;
1.6 schwarze 119:
120: fail:
121: tag_unlink();
122: if (ofd != -1)
123: close(ofd);
124: if (tag_files.ofd != -1)
125: close(tag_files.ofd);
126: if (tag_files.tfd != -1)
127: close(tag_files.tfd);
128: *tag_files.ofn = '\0';
129: *tag_files.tfn = '\0';
130: tag_files.ofd = -1;
131: tag_files.tfd = -1;
1.8 schwarze 132: return NULL;
1.1 schwarze 133: }
134:
135: /*
1.5 schwarze 136: * Set the line number where a term is defined,
1.20 schwarze 137: * unless it is already defined at a lower priority.
1.1 schwarze 138: */
139: void
1.5 schwarze 140: tag_put(const char *s, int prio, size_t line)
1.1 schwarze 141: {
142: struct tag_entry *entry;
1.20 schwarze 143: const char *se;
1.5 schwarze 144: size_t len;
1.1 schwarze 145: unsigned int slot;
146:
1.15 schwarze 147: if (tag_files.tfd <= 0)
148: return;
1.20 schwarze 149:
1.15 schwarze 150: if (s[0] == '\\' && (s[1] == '&' || s[1] == 'e'))
151: s += 2;
1.20 schwarze 152:
153: /*
154: * Skip whitespace and whatever follows it,
155: * and if there is any, downgrade the priority.
156: */
157:
158: len = strcspn(s, " \t");
159: if (len == 0)
1.1 schwarze 160: return;
1.14 schwarze 161:
1.20 schwarze 162: se = s + len;
163: if (*se != '\0')
164: prio = INT_MAX;
165:
166: slot = ohash_qlookupi(&tag_data, s, &se);
1.1 schwarze 167: entry = ohash_find(&tag_data, slot);
1.14 schwarze 168:
1.1 schwarze 169: if (entry == NULL) {
1.14 schwarze 170:
171: /* Build a new entry. */
172:
1.20 schwarze 173: entry = mandoc_malloc(sizeof(*entry) + len + 1);
1.1 schwarze 174: memcpy(entry->s, s, len);
1.20 schwarze 175: entry->s[len] = '\0';
1.14 schwarze 176: entry->lines = NULL;
177: entry->maxlines = entry->nlines = 0;
1.1 schwarze 178: ohash_insert(&tag_data, slot, entry);
1.14 schwarze 179:
180: } else {
181:
1.20 schwarze 182: /*
183: * Lower priority numbers take precedence,
184: * but 0 is special.
185: * A tag with priority 0 is only used
186: * if the tag occurs exactly once.
187: */
1.16 schwarze 188:
189: if (prio == 0) {
190: if (entry->prio == 0)
191: entry->prio = -1;
192: return;
193: }
194:
1.14 schwarze 195: /* A better entry is already present, ignore the new one. */
196:
1.16 schwarze 197: if (entry->prio > 0 && entry->prio < prio)
1.14 schwarze 198: return;
199:
200: /* The existing entry is worse, clear it. */
201:
1.16 schwarze 202: if (entry->prio < 1 || entry->prio > prio)
1.14 schwarze 203: entry->nlines = 0;
204: }
205:
206: /* Remember the new line. */
207:
208: if (entry->maxlines == entry->nlines) {
209: entry->maxlines += 4;
210: entry->lines = mandoc_reallocarray(entry->lines,
211: entry->maxlines, sizeof(*entry->lines));
212: }
213: entry->lines[entry->nlines++] = line;
1.4 schwarze 214: entry->prio = prio;
1.1 schwarze 215: }
216:
217: /*
218: * Write out the tags file using the previously collected
219: * information and clear the ohash table while going along.
220: */
221: void
222: tag_write(void)
223: {
224: FILE *stream;
225: struct tag_entry *entry;
1.14 schwarze 226: size_t i;
1.1 schwarze 227: unsigned int slot;
228:
1.6 schwarze 229: if (tag_files.tfd <= 0)
1.1 schwarze 230: return;
1.21 schwarze 231: if (tag_files.tagname != NULL && ohash_find(&tag_data,
232: ohash_qlookup(&tag_data, tag_files.tagname)) == NULL) {
1.22 ! schwarze 233: mandoc_msg(MANDOCERR_TAG, 0, 0, "%s", tag_files.tagname);
1.21 schwarze 234: tag_files.tagname = NULL;
235: }
1.22 ! schwarze 236: if ((stream = fdopen(tag_files.tfd, "w")) == NULL)
! 237: mandoc_msg(MANDOCERR_FDOPEN, 0, 0, "%s", strerror(errno));
1.1 schwarze 238: entry = ohash_first(&tag_data, &slot);
239: while (entry != NULL) {
1.16 schwarze 240: if (stream != NULL && entry->prio >= 0)
1.14 schwarze 241: for (i = 0; i < entry->nlines; i++)
242: fprintf(stream, "%s %s %zu\n",
243: entry->s, tag_files.ofn, entry->lines[i]);
244: free(entry->lines);
1.1 schwarze 245: free(entry);
246: entry = ohash_next(&tag_data, &slot);
247: }
248: ohash_delete(&tag_data);
249: if (stream != NULL)
250: fclose(stream);
1.19 schwarze 251: else
252: close(tag_files.tfd);
253: tag_files.tfd = -1;
1.1 schwarze 254: }
255:
256: void
257: tag_unlink(void)
258: {
1.11 schwarze 259: pid_t tc_pgid;
1.1 schwarze 260:
1.11 schwarze 261: if (tag_files.tcpgid != -1) {
1.17 schwarze 262: tc_pgid = tcgetpgrp(tag_files.ofd);
1.11 schwarze 263: if (tc_pgid == tag_files.pager_pid ||
264: tc_pgid == getpgid(0) ||
265: getpgid(tc_pgid) == -1)
1.17 schwarze 266: (void)tcsetpgrp(tag_files.ofd, tag_files.tcpgid);
1.11 schwarze 267: }
1.6 schwarze 268: if (*tag_files.ofn != '\0')
269: unlink(tag_files.ofn);
270: if (*tag_files.tfn != '\0')
271: unlink(tag_files.tfn);
1.2 schwarze 272: }
273:
274: static void
275: tag_signal(int signum)
276: {
1.11 schwarze 277: struct sigaction sa;
1.2 schwarze 278:
279: tag_unlink();
1.11 schwarze 280: memset(&sa, 0, sizeof(sa));
281: sigemptyset(&sa.sa_mask);
282: sa.sa_handler = SIG_DFL;
283: sigaction(signum, &sa, NULL);
1.2 schwarze 284: kill(getpid(), signum);
285: /* NOTREACHED */
286: _exit(1);
1.1 schwarze 287: }
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to tag.c CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc