Annotation of mandoc/tag.c, Revision 1.31
1.31 ! schwarze 1: /* $Id: tag.c,v 1.30 2020/03/21 00:17:31 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.
1.28 schwarze 16: *
17: * Functions to tag syntax tree nodes.
18: * For internal use by mandoc(1) validation modules only.
1.1 schwarze 19: */
1.7 schwarze 20: #include "config.h"
21:
1.1 schwarze 22: #include <sys/types.h>
23:
1.27 schwarze 24: #include <assert.h>
1.20 schwarze 25: #include <limits.h>
1.1 schwarze 26: #include <stddef.h>
27: #include <stdlib.h>
28: #include <string.h>
29:
30: #include "mandoc_aux.h"
1.10 schwarze 31: #include "mandoc_ohash.h"
1.28 schwarze 32: #include "roff.h"
1.1 schwarze 33: #include "tag.h"
34:
35: struct tag_entry {
1.28 schwarze 36: struct roff_node **nodes;
37: size_t maxnodes;
38: size_t nnodes;
1.4 schwarze 39: int prio;
1.1 schwarze 40: char s[];
41: };
42:
43: static struct ohash tag_data;
44:
45:
46: /*
1.28 schwarze 47: * Set up the ohash table to collect nodes
48: * where various marked-up terms are documented.
1.1 schwarze 49: */
1.28 schwarze 50: void
51: tag_alloc(void)
1.1 schwarze 52: {
1.28 schwarze 53: mandoc_ohash_init(&tag_data, 4, offsetof(struct tag_entry, s));
54: }
1.1 schwarze 55:
1.28 schwarze 56: void
57: tag_free(void)
58: {
59: struct tag_entry *entry;
60: unsigned int slot;
1.12 schwarze 61:
1.29 schwarze 62: if (tag_data.info.free == NULL)
63: return;
1.28 schwarze 64: entry = ohash_first(&tag_data, &slot);
65: while (entry != NULL) {
66: free(entry->nodes);
67: free(entry);
68: entry = ohash_next(&tag_data, &slot);
1.22 schwarze 69: }
1.28 schwarze 70: ohash_delete(&tag_data);
1.29 schwarze 71: tag_data.info.free = NULL;
1.1 schwarze 72: }
73:
74: /*
1.28 schwarze 75: * Set a node where a term is defined,
1.20 schwarze 76: * unless it is already defined at a lower priority.
1.1 schwarze 77: */
78: void
1.28 schwarze 79: tag_put(const char *s, int prio, struct roff_node *n)
1.1 schwarze 80: {
81: struct tag_entry *entry;
1.20 schwarze 82: const char *se;
1.5 schwarze 83: size_t len;
1.1 schwarze 84: unsigned int slot;
85:
1.27 schwarze 86: assert(prio <= TAG_FALLBACK);
1.20 schwarze 87:
1.28 schwarze 88: if (s == NULL) {
89: if (n->child == NULL || n->child->type != ROFFT_TEXT)
90: return;
91: s = n->child->string;
1.30 schwarze 92: switch (s[0]) {
93: case '-':
94: s++;
95: break;
96: case '\\':
97: switch (s[1]) {
98: case '&':
99: case '-':
100: case 'e':
101: s += 2;
102: break;
103: default:
104: break;
105: }
106: break;
107: default:
108: break;
109: }
1.28 schwarze 110: }
1.20 schwarze 111:
112: /*
1.24 schwarze 113: * Skip whitespace and escapes and whatever follows,
1.20 schwarze 114: * and if there is any, downgrade the priority.
115: */
116:
1.24 schwarze 117: len = strcspn(s, " \t\\");
1.20 schwarze 118: if (len == 0)
1.1 schwarze 119: return;
1.14 schwarze 120:
1.20 schwarze 121: se = s + len;
1.27 schwarze 122: if (*se != '\0' && prio < TAG_WEAK)
123: prio = TAG_WEAK;
1.20 schwarze 124:
125: slot = ohash_qlookupi(&tag_data, s, &se);
1.1 schwarze 126: entry = ohash_find(&tag_data, slot);
1.14 schwarze 127:
1.28 schwarze 128: /* Build a new entry. */
129:
1.1 schwarze 130: if (entry == NULL) {
1.20 schwarze 131: entry = mandoc_malloc(sizeof(*entry) + len + 1);
1.1 schwarze 132: memcpy(entry->s, s, len);
1.20 schwarze 133: entry->s[len] = '\0';
1.28 schwarze 134: entry->nodes = NULL;
135: entry->maxnodes = entry->nnodes = 0;
1.1 schwarze 136: ohash_insert(&tag_data, slot, entry);
1.28 schwarze 137: }
1.14 schwarze 138:
1.28 schwarze 139: /*
140: * Lower priority numbers take precedence.
141: * If a better entry is already present, ignore the new one.
142: */
143:
144: else if (entry->prio < prio)
145: return;
146:
147: /*
148: * If the existing entry is worse, clear it.
149: * In addition, a tag with priority TAG_FALLBACK
150: * is only used if the tag occurs exactly once.
151: */
1.14 schwarze 152:
1.28 schwarze 153: else if (entry->prio > prio || prio == TAG_FALLBACK) {
154: while (entry->nnodes > 0)
155: entry->nodes[--entry->nnodes]->flags &= ~NODE_ID;
1.16 schwarze 156:
1.27 schwarze 157: if (prio == TAG_FALLBACK) {
1.28 schwarze 158: entry->prio = TAG_DELETE;
1.16 schwarze 159: return;
160: }
1.14 schwarze 161: }
162:
1.28 schwarze 163: /* Remember the new node. */
1.14 schwarze 164:
1.28 schwarze 165: if (entry->maxnodes == entry->nnodes) {
166: entry->maxnodes += 4;
167: entry->nodes = mandoc_reallocarray(entry->nodes,
168: entry->maxnodes, sizeof(*entry->nodes));
1.14 schwarze 169: }
1.28 schwarze 170: entry->nodes[entry->nnodes++] = n;
1.4 schwarze 171: entry->prio = prio;
1.28 schwarze 172: n->flags |= NODE_ID;
173: if (n->child == NULL || n->child->string != s || *se != '\0') {
174: assert(n->string == NULL);
175: n->string = mandoc_strndup(s, len);
176: }
1.1 schwarze 177: }
178:
1.31 ! schwarze 179: int
! 180: tag_exists(const char *tag)
1.1 schwarze 181: {
1.31 ! schwarze 182: return ohash_find(&tag_data, ohash_qlookup(&tag_data, tag)) != NULL;
1.1 schwarze 183: }
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