Annotation of mandoc/tag.c, Revision 1.27
1.27 ! schwarze 1: /* $Id: tag.c,v 1.26 2020/01/19 18:02:00 schwarze Exp $ */
1.1 schwarze 2: /*
1.26 schwarze 3: * Copyright (c) 2015,2016,2018,2019,2020 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.27 ! schwarze 21: #include <assert.h>
1.22 schwarze 22: #include <errno.h>
1.20 schwarze 23: #include <limits.h>
1.2 schwarze 24: #include <signal.h>
1.1 schwarze 25: #include <stddef.h>
1.7 schwarze 26: #include <stdint.h>
1.1 schwarze 27: #include <stdio.h>
28: #include <stdlib.h>
29: #include <string.h>
30: #include <unistd.h>
31:
32: #include "mandoc_aux.h"
1.10 schwarze 33: #include "mandoc_ohash.h"
1.22 schwarze 34: #include "mandoc.h"
1.1 schwarze 35: #include "tag.h"
36:
37: struct tag_entry {
1.14 schwarze 38: size_t *lines;
39: size_t maxlines;
40: size_t nlines;
1.4 schwarze 41: int prio;
1.1 schwarze 42: char s[];
43: };
44:
1.18 schwarze 45: static void tag_signal(int) __attribute__((__noreturn__));
1.1 schwarze 46:
47: static struct ohash tag_data;
1.6 schwarze 48: static struct tag_files tag_files;
1.1 schwarze 49:
50:
51: /*
1.6 schwarze 52: * Prepare for using a pager.
53: * Not all pagers are capable of using a tag file,
54: * but for simplicity, create it anyway.
1.1 schwarze 55: */
1.6 schwarze 56: struct tag_files *
1.25 schwarze 57: tag_init(char *tagname)
1.1 schwarze 58: {
1.11 schwarze 59: struct sigaction sa;
1.6 schwarze 60: int ofd;
1.1 schwarze 61:
1.6 schwarze 62: ofd = -1;
63: tag_files.tfd = -1;
1.11 schwarze 64: tag_files.tcpgid = -1;
1.25 schwarze 65: tag_files.tagname = tagname;
1.6 schwarze 66:
1.12 schwarze 67: /* Clean up when dying from a signal. */
68:
69: memset(&sa, 0, sizeof(sa));
70: sigfillset(&sa.sa_mask);
71: sa.sa_handler = tag_signal;
72: sigaction(SIGHUP, &sa, NULL);
73: sigaction(SIGINT, &sa, NULL);
74: sigaction(SIGTERM, &sa, NULL);
75:
76: /*
77: * POSIX requires that a process calling tcsetpgrp(3)
78: * from the background gets a SIGTTOU signal.
79: * In that case, do not stop.
80: */
81:
82: sa.sa_handler = SIG_IGN;
83: sigaction(SIGTTOU, &sa, NULL);
84:
1.6 schwarze 85: /* Save the original standard output for use by the pager. */
86:
1.22 schwarze 87: if ((tag_files.ofd = dup(STDOUT_FILENO)) == -1) {
88: mandoc_msg(MANDOCERR_DUP, 0, 0, "%s", strerror(errno));
1.6 schwarze 89: goto fail;
1.22 schwarze 90: }
1.6 schwarze 91:
92: /* Create both temporary output files. */
93:
94: (void)strlcpy(tag_files.ofn, "/tmp/man.XXXXXXXXXX",
95: sizeof(tag_files.ofn));
96: (void)strlcpy(tag_files.tfn, "/tmp/man.XXXXXXXXXX",
97: sizeof(tag_files.tfn));
1.22 schwarze 98: if ((ofd = mkstemp(tag_files.ofn)) == -1) {
99: mandoc_msg(MANDOCERR_MKSTEMP, 0, 0,
100: "%s: %s", tag_files.ofn, strerror(errno));
1.6 schwarze 101: goto fail;
1.22 schwarze 102: }
103: if ((tag_files.tfd = mkstemp(tag_files.tfn)) == -1) {
104: mandoc_msg(MANDOCERR_MKSTEMP, 0, 0,
105: "%s: %s", tag_files.tfn, strerror(errno));
1.6 schwarze 106: goto fail;
1.22 schwarze 107: }
108: if (dup2(ofd, STDOUT_FILENO) == -1) {
109: mandoc_msg(MANDOCERR_DUP, 0, 0, "%s", strerror(errno));
1.6 schwarze 110: goto fail;
1.22 schwarze 111: }
1.6 schwarze 112: close(ofd);
113:
114: /*
115: * Set up the ohash table to collect output line numbers
116: * where various marked-up terms are documented.
117: */
1.1 schwarze 118:
1.10 schwarze 119: mandoc_ohash_init(&tag_data, 4, offsetof(struct tag_entry, s));
1.8 schwarze 120: return &tag_files;
1.6 schwarze 121:
122: fail:
123: tag_unlink();
124: if (ofd != -1)
125: close(ofd);
126: if (tag_files.ofd != -1)
127: close(tag_files.ofd);
128: if (tag_files.tfd != -1)
129: close(tag_files.tfd);
130: *tag_files.ofn = '\0';
131: *tag_files.tfn = '\0';
132: tag_files.ofd = -1;
133: tag_files.tfd = -1;
1.25 schwarze 134: tag_files.tagname = NULL;
1.8 schwarze 135: return NULL;
1.1 schwarze 136: }
137:
138: /*
1.5 schwarze 139: * Set the line number where a term is defined,
1.20 schwarze 140: * unless it is already defined at a lower priority.
1.1 schwarze 141: */
142: void
1.5 schwarze 143: tag_put(const char *s, int prio, size_t line)
1.1 schwarze 144: {
145: struct tag_entry *entry;
1.20 schwarze 146: const char *se;
1.5 schwarze 147: size_t len;
1.1 schwarze 148: unsigned int slot;
149:
1.27 ! schwarze 150: assert(prio <= TAG_FALLBACK);
1.15 schwarze 151: if (tag_files.tfd <= 0)
152: return;
1.20 schwarze 153:
1.15 schwarze 154: if (s[0] == '\\' && (s[1] == '&' || s[1] == 'e'))
155: s += 2;
1.20 schwarze 156:
157: /*
1.24 schwarze 158: * Skip whitespace and escapes and whatever follows,
1.20 schwarze 159: * and if there is any, downgrade the priority.
160: */
161:
1.24 schwarze 162: len = strcspn(s, " \t\\");
1.20 schwarze 163: if (len == 0)
1.1 schwarze 164: return;
1.14 schwarze 165:
1.20 schwarze 166: se = s + len;
1.27 ! schwarze 167: if (*se != '\0' && prio < TAG_WEAK)
! 168: prio = TAG_WEAK;
1.20 schwarze 169:
170: slot = ohash_qlookupi(&tag_data, s, &se);
1.1 schwarze 171: entry = ohash_find(&tag_data, slot);
1.14 schwarze 172:
1.1 schwarze 173: if (entry == NULL) {
1.14 schwarze 174:
175: /* Build a new entry. */
176:
1.20 schwarze 177: entry = mandoc_malloc(sizeof(*entry) + len + 1);
1.1 schwarze 178: memcpy(entry->s, s, len);
1.20 schwarze 179: entry->s[len] = '\0';
1.14 schwarze 180: entry->lines = NULL;
181: entry->maxlines = entry->nlines = 0;
1.1 schwarze 182: ohash_insert(&tag_data, slot, entry);
1.14 schwarze 183:
184: } else {
185:
1.20 schwarze 186: /*
187: * Lower priority numbers take precedence,
1.27 ! schwarze 188: * but TAG_FALLBACK is special.
! 189: * A tag with priority TAG_FALLBACK is only used
1.20 schwarze 190: * if the tag occurs exactly once.
191: */
1.16 schwarze 192:
1.27 ! schwarze 193: if (prio == TAG_FALLBACK) {
! 194: if (entry->prio == TAG_FALLBACK)
! 195: entry->prio = TAG_DELETE;
1.16 schwarze 196: return;
197: }
198:
1.14 schwarze 199: /* A better entry is already present, ignore the new one. */
200:
1.27 ! schwarze 201: if (entry->prio < prio)
1.14 schwarze 202: return;
203:
204: /* The existing entry is worse, clear it. */
205:
1.27 ! schwarze 206: if (entry->prio > prio)
1.14 schwarze 207: entry->nlines = 0;
208: }
209:
210: /* Remember the new line. */
211:
212: if (entry->maxlines == entry->nlines) {
213: entry->maxlines += 4;
214: entry->lines = mandoc_reallocarray(entry->lines,
215: entry->maxlines, sizeof(*entry->lines));
216: }
217: entry->lines[entry->nlines++] = line;
1.4 schwarze 218: entry->prio = prio;
1.1 schwarze 219: }
220:
221: /*
222: * Write out the tags file using the previously collected
223: * information and clear the ohash table while going along.
224: */
225: void
226: tag_write(void)
227: {
228: FILE *stream;
229: struct tag_entry *entry;
1.14 schwarze 230: size_t i;
1.1 schwarze 231: unsigned int slot;
1.23 schwarze 232: int empty;
1.1 schwarze 233:
1.6 schwarze 234: if (tag_files.tfd <= 0)
1.1 schwarze 235: return;
1.21 schwarze 236: if (tag_files.tagname != NULL && ohash_find(&tag_data,
237: ohash_qlookup(&tag_data, tag_files.tagname)) == NULL) {
1.22 schwarze 238: mandoc_msg(MANDOCERR_TAG, 0, 0, "%s", tag_files.tagname);
1.21 schwarze 239: tag_files.tagname = NULL;
240: }
1.22 schwarze 241: if ((stream = fdopen(tag_files.tfd, "w")) == NULL)
242: mandoc_msg(MANDOCERR_FDOPEN, 0, 0, "%s", strerror(errno));
1.23 schwarze 243: empty = 1;
1.1 schwarze 244: entry = ohash_first(&tag_data, &slot);
245: while (entry != NULL) {
1.27 ! schwarze 246: if (stream != NULL && entry->prio < TAG_DELETE) {
1.23 schwarze 247: for (i = 0; i < entry->nlines; i++) {
1.14 schwarze 248: fprintf(stream, "%s %s %zu\n",
249: entry->s, tag_files.ofn, entry->lines[i]);
1.23 schwarze 250: empty = 0;
251: }
252: }
1.14 schwarze 253: free(entry->lines);
1.1 schwarze 254: free(entry);
255: entry = ohash_next(&tag_data, &slot);
256: }
257: ohash_delete(&tag_data);
258: if (stream != NULL)
259: fclose(stream);
1.19 schwarze 260: else
261: close(tag_files.tfd);
262: tag_files.tfd = -1;
1.23 schwarze 263: if (empty) {
264: unlink(tag_files.tfn);
265: *tag_files.tfn = '\0';
266: }
1.1 schwarze 267: }
268:
269: void
270: tag_unlink(void)
271: {
1.11 schwarze 272: pid_t tc_pgid;
1.1 schwarze 273:
1.11 schwarze 274: if (tag_files.tcpgid != -1) {
1.17 schwarze 275: tc_pgid = tcgetpgrp(tag_files.ofd);
1.11 schwarze 276: if (tc_pgid == tag_files.pager_pid ||
277: tc_pgid == getpgid(0) ||
278: getpgid(tc_pgid) == -1)
1.17 schwarze 279: (void)tcsetpgrp(tag_files.ofd, tag_files.tcpgid);
1.11 schwarze 280: }
1.6 schwarze 281: if (*tag_files.ofn != '\0')
282: unlink(tag_files.ofn);
283: if (*tag_files.tfn != '\0')
284: unlink(tag_files.tfn);
1.2 schwarze 285: }
286:
287: static void
288: tag_signal(int signum)
289: {
1.11 schwarze 290: struct sigaction sa;
1.2 schwarze 291:
292: tag_unlink();
1.11 schwarze 293: memset(&sa, 0, sizeof(sa));
294: sigemptyset(&sa.sa_mask);
295: sa.sa_handler = SIG_DFL;
296: sigaction(signum, &sa, NULL);
1.2 schwarze 297: kill(getpid(), signum);
298: /* NOTREACHED */
299: _exit(1);
1.1 schwarze 300: }
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