Annotation of docbook2mdoc/node.h, Revision 1.3
1.3 ! schwarze 1: /* $Id: node.h,v 1.2 2019/03/26 20:54:43 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: */
18: #include <sys/queue.h>
19:
20: /*
21: * The interface of the DocBook syntax tree.
22: */
23:
24: /*
25: * All node types used for formatting purposes.
26: * More DocBook XML elements are recognized, but remapped or discarded.
27: */
28: enum nodeid {
1.2 schwarze 29: NODE_IGNORE = 0, /* Must come first. */
30: NODE_WARN,
1.1 schwarze 31: /* Alpha-ordered hereafter. */
32: NODE_AFFILIATION,
33: NODE_APPLICATION,
34: NODE_ARG,
35: NODE_AUTHOR,
36: NODE_AUTHORGROUP,
37: NODE_BLOCKQUOTE,
38: NODE_BOOK,
39: NODE_BOOKINFO,
40: NODE_CAUTION,
41: NODE_CITEREFENTRY,
42: NODE_CITETITLE,
43: NODE_CMDSYNOPSIS,
44: NODE_CODE,
45: NODE_COLSPEC,
46: NODE_COMMAND,
47: NODE_CONSTANT,
48: NODE_COPYRIGHT,
49: NODE_DATE,
50: NODE_EDITOR,
51: NODE_EMAIL,
52: NODE_EMPHASIS,
53: NODE_ENTRY,
54: NODE_ENVAR,
55: NODE_FIELDSYNOPSIS,
56: NODE_FILENAME,
57: NODE_FIRSTTERM,
58: NODE_FOOTNOTE,
59: NODE_FUNCDEF,
60: NODE_FUNCPROTOTYPE,
61: NODE_FUNCSYNOPSIS,
62: NODE_FUNCSYNOPSISINFO,
63: NODE_FUNCTION,
64: NODE_GLOSSTERM,
65: NODE_GROUP,
66: NODE_HOLDER,
67: NODE_INDEX,
68: NODE_INDEXTERM,
69: NODE_INFO,
70: NODE_INFORMALEQUATION,
71: NODE_INFORMALTABLE,
72: NODE_INLINEEQUATION,
73: NODE_ITEMIZEDLIST,
74: NODE_KEYSYM,
75: NODE_LEGALNOTICE,
76: NODE_LINK,
77: NODE_LISTITEM,
78: NODE_LITERAL,
79: NODE_LITERALLAYOUT,
80: NODE_MANVOLNUM,
81: NODE_MEMBER,
82: NODE_MML_MATH,
83: NODE_MML_MFENCED,
84: NODE_MML_MFRAC,
85: NODE_MML_MI,
86: NODE_MML_MN,
87: NODE_MML_MO,
88: NODE_MML_MROW,
89: NODE_MML_MSUB,
90: NODE_MML_MSUP,
91: NODE_MODIFIER,
92: NODE_NOTE,
93: NODE_OPTION,
94: NODE_ORDEREDLIST,
95: NODE_ORGNAME,
96: NODE_PARA,
97: NODE_PARAMDEF,
98: NODE_PARAMETER,
99: NODE_PERSONNAME,
100: NODE_PREFACE,
101: NODE_PRIMARY,
102: NODE_PROGRAMLISTING,
103: NODE_PROMPT,
104: NODE_QUOTE,
105: NODE_REFCLASS,
106: NODE_REFDESCRIPTOR,
107: NODE_REFENTRY,
108: NODE_REFENTRYINFO,
109: NODE_REFENTRYTITLE,
110: NODE_REFMETA,
111: NODE_REFMETAINFO,
112: NODE_REFMISCINFO,
113: NODE_REFNAME,
114: NODE_REFNAMEDIV,
115: NODE_REFPURPOSE,
116: NODE_REFSYNOPSISDIV,
117: NODE_RELEASEINFO,
118: NODE_REPLACEABLE,
119: NODE_ROW,
120: NODE_SBR,
121: NODE_SCREEN,
122: NODE_SECONDARY,
123: NODE_SECTION,
124: NODE_SGMLTAG,
125: NODE_SIMPLELIST,
126: NODE_SPANSPEC,
127: NODE_STRUCTNAME,
128: NODE_SUBTITLE,
129: NODE_SYNOPSIS,
130: NODE_TABLE,
131: NODE_TBODY,
132: NODE_TERM,
133: NODE_TEXT,
134: NODE_TFOOT,
135: NODE_TGROUP,
136: NODE_THEAD,
137: NODE_TIP,
138: NODE_TITLE,
139: NODE_TYPE,
140: NODE_ULINK,
141: NODE_USERINPUT,
142: NODE_VARIABLELIST,
143: NODE_VARLISTENTRY,
144: NODE_VARNAME,
145: NODE_WARNING,
146: NODE_WORDASWORD,
147: NODE_YEAR,
148: NODE__MAX
149: };
150:
151: /*
152: * All recognised attribute keys.
153: * Other attributes are discarded.
154: */
155: enum attrkey {
156: /* Alpha-order... */
157: ATTRKEY_CHOICE = 0,
158: ATTRKEY_CLASS,
159: ATTRKEY_CLOSE,
160: ATTRKEY_ID,
161: ATTRKEY_LINKEND,
162: ATTRKEY_OPEN,
163: ATTRKEY_REP,
164: ATTRKEY__MAX
165: };
166:
167: /*
168: * All explicitly recognised attribute values.
169: * If an attribute has ATTRVAL__MAX, it is treated as free-form.
170: */
171: enum attrval {
172: /* Alpha-order... */
173: ATTRVAL_MONOSPACED,
174: ATTRVAL_NOREPEAT,
175: ATTRVAL_OPT,
176: ATTRVAL_PLAIN,
177: ATTRVAL_REPEAT,
178: ATTRVAL_REQ,
179: ATTRVAL__MAX
180: };
181:
182: TAILQ_HEAD(pnodeq, pnode);
183: TAILQ_HEAD(pattrq, pattr);
184:
185: /*
186: * One DocBook XML element attribute.
187: */
188: struct pattr {
189: enum attrkey key;
190: enum attrval val;
191: char *rawval;
192: TAILQ_ENTRY(pattr) child;
193: };
194:
195: /*
196: * One DocBook XML element.
197: */
198: struct pnode {
199: enum nodeid node; /* Node type. */
200: char *b; /* String value. */
201: char *real; /* Storage for "b". */
202: size_t bsz; /* strlen(b) */
203: struct pnode *parent; /* Parent node or NULL. */
204: struct pnodeq childq; /* Queue of children. */
205: struct pattrq attrq; /* Attributes of the node. */
206: TAILQ_ENTRY(pnode) child;
207: };
208:
209: /*
210: * The parse result for one complete DocBook XML document.
211: */
212: struct ptree {
213: struct pnode *root; /* The document element. */
214: int flags;
215: #define TREE_FAIL (1 << 0) /* A fatal parse error occurred. */
216: #define TREE_EQN (1 << 1) /* The document needs inline eqn(7). */
217: };
218:
219:
220: enum attrkey attrkey_parse(const char *);
221: enum attrval attrval_parse(const char *);
222: void pnode_unlink(struct pnode *);
223: void pnode_unlinksub(struct pnode *);
224: enum attrval pnode_getattr(struct pnode *, enum attrkey);
225: const char *pnode_getattr_raw(struct pnode *, enum attrkey, const char *);
226: struct pnode *pnode_findfirst(struct pnode *, enum nodeid);
CVSweb