Annotation of docbook2mdoc/node.c, Revision 1.19
1.19 ! schwarze 1: /* $Id: node.c,v 1.18 2019/04/14 22:37:56 schwarze Exp $ */
1.1 schwarze 2: /*
3: * Copyright (c) 2014 Kristaps Dzonsons <kristaps@bsd.lv>
4: * Copyright (c) 2019 Ingo Schwarze <schwarze@openbsd.org>
5: *
6: * Permission to use, copy, modify, and distribute this software for any
7: * purpose with or without fee is hereby granted, provided that the above
8: * copyright notice and this permission notice appear in all copies.
9: *
10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
13: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17: */
1.10 schwarze 18: #include <assert.h>
1.1 schwarze 19: #include <stdlib.h>
20: #include <string.h>
21:
22: #include "node.h"
23:
24: /*
25: * The implementation of the DocBook syntax tree.
26: */
27:
1.10 schwarze 28: struct nodeprop {
29: const char *name;
30: enum nodeclass class;
31: };
32:
33: static const struct nodeprop properties[] = {
34: { "appendix", CLASS_BLOCK },
35: { "arg", CLASS_ENCL },
36: { "author", CLASS_LINE },
37: { "authorgroup", CLASS_BLOCK },
38: { "blockquote", CLASS_BLOCK },
39: { "bookinfo", CLASS_BLOCK },
40: { "caution", CLASS_BLOCK },
41: { "citerefentry", CLASS_LINE },
42: { "citetitle", CLASS_LINE },
43: { "cmdsynopsis", CLASS_TRANS },
44: { "colspec", CLASS_VOID },
45: { "command", CLASS_LINE },
46: { "constant", CLASS_LINE },
47: { "contrib", CLASS_TRANS },
1.15 schwarze 48: { "copyright", CLASS_LINE },
1.10 schwarze 49: { "date", CLASS_TRANS },
50: { "!DOCTYPE", CLASS_VOID },
51: { "editor", CLASS_LINE },
52: { "email", CLASS_ENCL },
53: { "emphasis", CLASS_LINE },
54: { "!ENTITY", CLASS_VOID },
55: { "entry", CLASS_ENCL },
56: { "envar", CLASS_LINE },
57: { "errorname", CLASS_LINE },
58: { "fieldsynopsis", CLASS_TRANS },
59: { "filename", CLASS_LINE },
60: { "firstterm", CLASS_LINE },
1.17 schwarze 61: { "footnote", CLASS_BLOCK },
1.10 schwarze 62: { "funcdef", CLASS_BLOCK },
63: { "funcprototype", CLASS_BLOCK },
64: { "funcsynopsis", CLASS_TRANS },
65: { "funcsynopsisinfo", CLASS_LINE },
66: { "function", CLASS_LINE },
67: { "glossterm", CLASS_LINE },
68: { "group", CLASS_ENCL },
1.18 schwarze 69: { "imagedata", CLASS_TEXT },
1.10 schwarze 70: { "xi:include", CLASS_VOID },
71: { "index", CLASS_TRANS },
72: { "info", CLASS_TRANS },
73: { "informalequation", CLASS_BLOCK },
74: { "inlineequation", CLASS_BLOCK },
75: { "itemizedlist", CLASS_BLOCK },
76: { "keysym", CLASS_LINE },
77: { "legalnotice", CLASS_BLOCK },
78: { "link", CLASS_ENCL },
79: { "listitem", CLASS_TRANS },
80: { "literal", CLASS_ENCL },
81: { "literallayout", CLASS_BLOCK },
82: { "manvolnum", CLASS_TRANS },
83: { "markup", CLASS_LINE },
84: { "member", CLASS_LINE },
85: { "mml:math", CLASS_LINE },
86: { "mml:mfenced", CLASS_LINE },
87: { "mml:mfrac", CLASS_LINE },
88: { "mml:mi", CLASS_LINE },
89: { "mml:mn", CLASS_LINE },
90: { "mml:mo", CLASS_LINE },
91: { "mml:mrow", CLASS_LINE },
92: { "mml:msub", CLASS_LINE },
93: { "mml:msup", CLASS_LINE },
94: { "modifier", CLASS_LINE },
95: { "note", CLASS_BLOCK },
1.19 ! schwarze 96: { "olink", CLASS_ENCL },
1.10 schwarze 97: { "option", CLASS_LINE },
98: { "orderedlist", CLASS_BLOCK },
99: { "para", CLASS_BLOCK },
100: { "paramdef", CLASS_LINE },
101: { "parameter", CLASS_LINE },
102: { "personname", CLASS_TRANS },
103: { "preface", CLASS_BLOCK },
104: { "programlisting", CLASS_BLOCK },
105: { "prompt", CLASS_TRANS },
1.12 schwarze 106: { "pubdate", CLASS_TRANS },
1.10 schwarze 107: { "quote", CLASS_ENCL },
108: { "refclass", CLASS_TRANS },
109: { "refdescriptor", CLASS_TRANS },
110: { "refentry", CLASS_TRANS },
111: { "refentryinfo", CLASS_VOID },
112: { "refentrytitle", CLASS_TRANS },
113: { "refmeta", CLASS_TRANS },
114: { "refmetainfo", CLASS_TRANS },
115: { "refmiscinfo", CLASS_TRANS },
116: { "refname", CLASS_LINE },
117: { "refnamediv", CLASS_BLOCK },
118: { "refpurpose", CLASS_LINE },
119: { "refsynopsisdiv", CLASS_BLOCK },
120: { "replaceable", CLASS_LINE },
121: { "row", CLASS_BLOCK },
122: { "sbr", CLASS_BLOCK },
123: { "screen", CLASS_BLOCK },
124: { "section", CLASS_BLOCK },
125: { "simplelist", CLASS_TRANS },
1.15 schwarze 126: { "simplesect", CLASS_BLOCK },
1.10 schwarze 127: { "spanspec", CLASS_TRANS },
1.16 schwarze 128: { "subscript", CLASS_TEXT },
1.15 schwarze 129: { "subtitle", CLASS_BLOCK },
1.16 schwarze 130: { "superscript", CLASS_TEXT },
1.10 schwarze 131: { "synopsis", CLASS_BLOCK },
1.13 schwarze 132: { "systemitem", CLASS_LINE },
1.10 schwarze 133: { "table", CLASS_TRANS },
134: { "tbody", CLASS_TRANS },
135: { "term", CLASS_LINE },
136: { "tfoot", CLASS_TRANS },
137: { "tgroup", CLASS_BLOCK },
138: { "thead", CLASS_TRANS },
139: { "tip", CLASS_BLOCK },
140: { "title", CLASS_BLOCK },
141: { "type", CLASS_LINE },
142: { "variablelist", CLASS_BLOCK },
143: { "varlistentry", CLASS_BLOCK },
144: { "varname", CLASS_LINE },
145: { "warning", CLASS_BLOCK },
146: { "wordasword", CLASS_TRANS },
147: { "[UNKNOWN]", CLASS_VOID },
1.11 schwarze 148: { "(t)", CLASS_TEXT },
149: { "(e)", CLASS_TEXT }
1.10 schwarze 150: };
151:
1.1 schwarze 152: static const char *const attrkeys[ATTRKEY__MAX] = {
153: "choice",
154: "class",
155: "close",
1.3 schwarze 156: "cols",
1.5 schwarze 157: "DEFINITION",
1.4 schwarze 158: "endterm",
1.18 schwarze 159: "entityref",
160: "fileref",
1.6 schwarze 161: "href",
1.1 schwarze 162: "id",
163: "linkend",
1.19 ! schwarze 164: "localinfo",
1.5 schwarze 165: "NAME",
1.1 schwarze 166: "open",
1.5 schwarze 167: "PUBLIC",
1.4 schwarze 168: "rep",
1.5 schwarze 169: "SYSTEM",
1.19 ! schwarze 170: "targetdoc",
! 171: "targetptr",
1.4 schwarze 172: "url",
173: "xlink:href"
1.1 schwarze 174: };
175:
176: static const char *const attrvals[ATTRVAL__MAX] = {
1.13 schwarze 177: "event",
178: "ipaddress",
1.1 schwarze 179: "monospaced",
180: "norepeat",
181: "opt",
182: "plain",
183: "repeat",
1.13 schwarze 184: "req",
185: "systemname"
1.1 schwarze 186: };
187:
188: enum attrkey
189: attrkey_parse(const char *name)
190: {
191: enum attrkey key;
192:
193: for (key = 0; key < ATTRKEY__MAX; key++)
194: if (strcmp(name, attrkeys[key]) == 0)
195: break;
196: return key;
197: }
198:
1.11 schwarze 199: const char *
200: attrkey_name(enum attrkey key)
201: {
202: return attrkeys[key];
203: }
204:
1.1 schwarze 205: enum attrval
206: attrval_parse(const char *name)
207: {
208: enum attrval val;
209:
210: for (val = 0; val < ATTRVAL__MAX; val++)
211: if (strcmp(name, attrvals[val]) == 0)
212: break;
213: return val;
1.11 schwarze 214: }
215:
216: const char *
217: attr_getval(const struct pattr *a)
218: {
219: return a->val == ATTRVAL__MAX ? a->rawval : attrvals[a->val];
1.10 schwarze 220: }
221:
222: enum nodeid
223: pnode_parse(const char *name)
224: {
225: enum nodeid node;
226:
227: for (node = 0; node < NODE_UNKNOWN; node++)
228: if (strcmp(name, properties[node].name) == 0)
229: break;
230: return node;
231: }
232:
233: const char *
234: pnode_name(enum nodeid node)
235: {
236: assert(node < NODE_IGNORE);
237: return properties[node].name;
238: }
239:
240: enum nodeclass
241: pnode_class(enum nodeid node)
242: {
243: assert(node < NODE_IGNORE);
244: return properties[node].class;
1.9 schwarze 245: }
246:
247: struct pnode *
248: pnode_alloc(struct pnode *np)
249: {
250: struct pnode *n;
251:
252: if ((n = calloc(1, sizeof(*n))) != NULL) {
253: TAILQ_INIT(&n->childq);
254: TAILQ_INIT(&n->attrq);
255: if ((n->parent = np) != NULL)
256: TAILQ_INSERT_TAIL(&np->childq, n, child);
257: }
258: return n;
1.1 schwarze 259: }
260:
261: /*
262: * Recursively free a node (NULL is ok).
263: */
264: static void
1.7 schwarze 265: pnode_free(struct pnode *n)
1.1 schwarze 266: {
1.7 schwarze 267: struct pnode *nc;
268: struct pattr *a;
1.1 schwarze 269:
1.7 schwarze 270: if (n == NULL)
1.1 schwarze 271: return;
272:
1.7 schwarze 273: while ((nc = TAILQ_FIRST(&n->childq)) != NULL) {
274: TAILQ_REMOVE(&n->childq, nc, child);
275: pnode_free(nc);
1.1 schwarze 276: }
1.7 schwarze 277: while ((a = TAILQ_FIRST(&n->attrq)) != NULL) {
278: TAILQ_REMOVE(&n->attrq, a, child);
279: free(a->rawval);
280: free(a);
1.1 schwarze 281: }
1.8 schwarze 282: free(n->b);
1.7 schwarze 283: free(n);
1.1 schwarze 284: }
285:
286: /*
287: * Unlink a node from its parent and pnode_free() it.
288: */
289: void
1.7 schwarze 290: pnode_unlink(struct pnode *n)
1.1 schwarze 291: {
1.7 schwarze 292: if (n == NULL)
1.1 schwarze 293: return;
1.7 schwarze 294: if (n->parent != NULL)
295: TAILQ_REMOVE(&n->parent->childq, n, child);
296: pnode_free(n);
1.1 schwarze 297: }
298:
299: /*
300: * Unlink all children of a node and pnode_free() them.
301: */
302: void
1.7 schwarze 303: pnode_unlinksub(struct pnode *n)
1.1 schwarze 304: {
1.7 schwarze 305: while (TAILQ_EMPTY(&n->childq) == 0)
306: pnode_unlink(TAILQ_FIRST(&n->childq));
1.1 schwarze 307: }
308:
309: /*
310: * Retrieve an enumeration attribute from a node.
311: * Return ATTRVAL__MAX if the node has no such attribute.
312: */
313: enum attrval
1.7 schwarze 314: pnode_getattr(struct pnode *n, enum attrkey key)
1.1 schwarze 315: {
1.7 schwarze 316: struct pattr *a;
1.1 schwarze 317:
1.7 schwarze 318: if (n == NULL)
1.1 schwarze 319: return ATTRVAL__MAX;
1.7 schwarze 320: TAILQ_FOREACH(a, &n->attrq, child)
321: if (a->key == key)
322: return a->val;
1.1 schwarze 323: return ATTRVAL__MAX;
324: }
325:
326: /*
327: * Retrieve an attribute string from a node.
328: * Return defval if the node has no such attribute.
329: */
330: const char *
1.7 schwarze 331: pnode_getattr_raw(struct pnode *n, enum attrkey key, const char *defval)
1.1 schwarze 332: {
1.7 schwarze 333: struct pattr *a;
1.1 schwarze 334:
1.7 schwarze 335: if (n == NULL)
1.1 schwarze 336: return defval;
1.7 schwarze 337: TAILQ_FOREACH(a, &n->attrq, child)
338: if (a->key == key)
339: return a->val != ATTRVAL__MAX ? attrvals[a->val] :
340: a->rawval != NULL ? a->rawval : defval;
1.1 schwarze 341: return defval;
342: }
343:
344: /*
345: * Recursively search and return the first instance of "node".
346: */
347: struct pnode *
1.7 schwarze 348: pnode_findfirst(struct pnode *n, enum nodeid node)
1.1 schwarze 349: {
1.7 schwarze 350: struct pnode *nc, *res;
1.1 schwarze 351:
1.12 schwarze 352: if (n == NULL)
353: return NULL;
1.7 schwarze 354: if (n->node == node)
355: return n;
356: TAILQ_FOREACH(nc, &n->childq, child)
357: if ((res = pnode_findfirst(nc, node)) != NULL)
1.1 schwarze 358: return res;
359: return NULL;
1.12 schwarze 360: }
361:
362: /*
363: * Like pnode_findfirst(), but also take the node out of the tree.
364: */
365: struct pnode *
366: pnode_takefirst(struct pnode *n, enum nodeid node)
367: {
368: struct pnode *nc;
369:
370: if ((nc = pnode_findfirst(n, node)) != NULL && nc->parent != NULL)
371: TAILQ_REMOVE(&nc->parent->childq, nc, child);
372: return nc;
1.1 schwarze 373: }
CVSweb