Annotation of docbook2mdoc/node.h, Revision 1.28
1.28 ! schwarze 1: /* $Id: node.h,v 1.27 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: */
18: #include <sys/queue.h>
19:
20: /*
21: * The interface of the DocBook syntax tree.
22: */
23:
24: /*
1.20 schwarze 25: * How the output from each node behaves
26: * with respect to mdoc(7) structure.
27: */
28: enum nodeclass {
29: CLASS_VOID = 0, /* No output at all, children are skipped. */
30: CLASS_TEXT, /* Node prints only text, no macros. */
31: CLASS_TRANS, /* Transparent: only the children are shown. */
32: CLASS_LINE, /* Generates only simple in-line macros. */
33: CLASS_ENCL, /* Explicit or implicit partial blocks. */
34: CLASS_BLOCK /* Output linebreak before and after. */
35: };
36:
37: /*
1.1 schwarze 38: * All node types used for formatting purposes.
39: * More DocBook XML elements are recognized, but remapped or discarded.
40: */
41: enum nodeid {
1.12 schwarze 42: NODE_APPENDIX,
1.1 schwarze 43: NODE_ARG,
44: NODE_AUTHOR,
45: NODE_AUTHORGROUP,
46: NODE_BLOCKQUOTE,
47: NODE_BOOKINFO,
48: NODE_CAUTION,
49: NODE_CITEREFENTRY,
50: NODE_CITETITLE,
51: NODE_CMDSYNOPSIS,
52: NODE_COLSPEC,
53: NODE_COMMAND,
54: NODE_CONSTANT,
1.6 schwarze 55: NODE_CONTRIB,
1.1 schwarze 56: NODE_COPYRIGHT,
57: NODE_DATE,
1.13 schwarze 58: NODE_DOCTYPE,
1.1 schwarze 59: NODE_EDITOR,
60: NODE_EMAIL,
61: NODE_EMPHASIS,
1.13 schwarze 62: NODE_ENTITY,
1.1 schwarze 63: NODE_ENTRY,
64: NODE_ENVAR,
1.9 schwarze 65: NODE_ERRORNAME,
1.1 schwarze 66: NODE_FIELDSYNOPSIS,
67: NODE_FILENAME,
68: NODE_FIRSTTERM,
69: NODE_FOOTNOTE,
70: NODE_FUNCDEF,
71: NODE_FUNCPROTOTYPE,
72: NODE_FUNCSYNOPSIS,
73: NODE_FUNCSYNOPSISINFO,
74: NODE_FUNCTION,
75: NODE_GLOSSTERM,
76: NODE_GROUP,
1.27 schwarze 77: NODE_IMAGEDATA,
1.14 schwarze 78: NODE_INCLUDE,
1.1 schwarze 79: NODE_INDEX,
80: NODE_INFO,
81: NODE_INFORMALEQUATION,
82: NODE_INLINEEQUATION,
83: NODE_ITEMIZEDLIST,
84: NODE_KEYSYM,
85: NODE_LEGALNOTICE,
86: NODE_LINK,
87: NODE_LISTITEM,
88: NODE_LITERAL,
89: NODE_LITERALLAYOUT,
90: NODE_MANVOLNUM,
1.18 schwarze 91: NODE_MARKUP,
1.1 schwarze 92: NODE_MEMBER,
93: NODE_MML_MATH,
94: NODE_MML_MFENCED,
95: NODE_MML_MFRAC,
96: NODE_MML_MI,
97: NODE_MML_MN,
98: NODE_MML_MO,
99: NODE_MML_MROW,
100: NODE_MML_MSUB,
101: NODE_MML_MSUP,
102: NODE_MODIFIER,
103: NODE_NOTE,
1.28 ! schwarze 104: NODE_OLINK,
1.1 schwarze 105: NODE_OPTION,
106: NODE_ORDEREDLIST,
107: NODE_PARA,
108: NODE_PARAMDEF,
109: NODE_PARAMETER,
110: NODE_PERSONNAME,
111: NODE_PREFACE,
112: NODE_PROGRAMLISTING,
113: NODE_PROMPT,
1.22 schwarze 114: NODE_PUBDATE,
1.1 schwarze 115: NODE_QUOTE,
116: NODE_REFCLASS,
117: NODE_REFDESCRIPTOR,
118: NODE_REFENTRY,
119: NODE_REFENTRYINFO,
120: NODE_REFENTRYTITLE,
121: NODE_REFMETA,
122: NODE_REFMETAINFO,
123: NODE_REFMISCINFO,
124: NODE_REFNAME,
125: NODE_REFNAMEDIV,
126: NODE_REFPURPOSE,
127: NODE_REFSYNOPSISDIV,
128: NODE_REPLACEABLE,
129: NODE_ROW,
130: NODE_SBR,
131: NODE_SCREEN,
132: NODE_SECTION,
133: NODE_SIMPLELIST,
1.25 schwarze 134: NODE_SIMPLESECT,
1.1 schwarze 135: NODE_SPANSPEC,
1.26 schwarze 136: NODE_SUBSCRIPT,
1.1 schwarze 137: NODE_SUBTITLE,
1.26 schwarze 138: NODE_SUPERSCRIPT,
1.1 schwarze 139: NODE_SYNOPSIS,
1.23 schwarze 140: NODE_SYSTEMITEM,
1.1 schwarze 141: NODE_TABLE,
142: NODE_TBODY,
143: NODE_TERM,
144: NODE_TFOOT,
145: NODE_TGROUP,
146: NODE_THEAD,
147: NODE_TIP,
148: NODE_TITLE,
149: NODE_TYPE,
150: NODE_VARIABLELIST,
151: NODE_VARLISTENTRY,
152: NODE_VARNAME,
153: NODE_WARNING,
154: NODE_WORDASWORD,
1.20 schwarze 155: NODE_UNKNOWN,
156: NODE_TEXT,
157: NODE_ESCAPE,
158: NODE_IGNORE,
159: NODE_DELETE,
160: NODE_DELETE_WARN
1.1 schwarze 161: };
162:
163: /*
164: * All recognised attribute keys.
165: * Other attributes are discarded.
166: */
167: enum attrkey {
168: /* Alpha-order... */
169: ATTRKEY_CHOICE = 0,
170: ATTRKEY_CLASS,
171: ATTRKEY_CLOSE,
1.8 schwarze 172: ATTRKEY_COLS,
1.13 schwarze 173: ATTRKEY_DEFINITION,
1.11 schwarze 174: ATTRKEY_ENDTERM,
1.27 schwarze 175: ATTRKEY_ENTITYREF,
176: ATTRKEY_FILEREF,
1.14 schwarze 177: ATTRKEY_HREF,
1.1 schwarze 178: ATTRKEY_ID,
179: ATTRKEY_LINKEND,
1.28 ! schwarze 180: ATTRKEY_LOCALINFO,
1.13 schwarze 181: ATTRKEY_NAME,
1.1 schwarze 182: ATTRKEY_OPEN,
1.13 schwarze 183: ATTRKEY_PUBLIC,
1.1 schwarze 184: ATTRKEY_REP,
1.13 schwarze 185: ATTRKEY_SYSTEM,
1.28 ! schwarze 186: ATTRKEY_TARGETDOC,
! 187: ATTRKEY_TARGETPTR,
1.11 schwarze 188: ATTRKEY_URL,
189: ATTRKEY_XLINK_HREF,
1.1 schwarze 190: ATTRKEY__MAX
191: };
192:
193: /*
194: * All explicitly recognised attribute values.
195: * If an attribute has ATTRVAL__MAX, it is treated as free-form.
196: */
197: enum attrval {
198: /* Alpha-order... */
1.23 schwarze 199: ATTRVAL_EVENT,
200: ATTRVAL_IPADDRESS,
1.1 schwarze 201: ATTRVAL_MONOSPACED,
202: ATTRVAL_NOREPEAT,
203: ATTRVAL_OPT,
204: ATTRVAL_PLAIN,
205: ATTRVAL_REPEAT,
206: ATTRVAL_REQ,
1.23 schwarze 207: ATTRVAL_SYSTEMNAME,
1.1 schwarze 208: ATTRVAL__MAX
209: };
210:
211: TAILQ_HEAD(pnodeq, pnode);
212: TAILQ_HEAD(pattrq, pattr);
213:
214: /*
215: * One DocBook XML element attribute.
216: */
217: struct pattr {
218: enum attrkey key;
219: enum attrval val;
220: char *rawval;
221: TAILQ_ENTRY(pattr) child;
222: };
223:
224: /*
225: * One DocBook XML element.
226: */
227: struct pnode {
228: enum nodeid node; /* Node type. */
229: char *b; /* String value. */
1.10 schwarze 230: int spc; /* Whitespace before this node. */
1.1 schwarze 231: struct pnode *parent; /* Parent node or NULL. */
232: struct pnodeq childq; /* Queue of children. */
233: struct pattrq attrq; /* Attributes of the node. */
234: TAILQ_ENTRY(pnode) child;
235: };
236:
237: /*
238: * The parse result for one complete DocBook XML document.
239: */
240: struct ptree {
241: struct pnode *root; /* The document element. */
242: int flags;
1.15 schwarze 243: #define TREE_ERROR (1 << 0) /* A parse error occurred. */
244: #define TREE_WARN (1 << 1) /* A parser warning occurred. */
245: #define TREE_CLOSED (1 << 3) /* The document element was closed. */
1.1 schwarze 246: };
247:
248:
249: enum attrkey attrkey_parse(const char *);
1.21 schwarze 250: const char *attrkey_name(enum attrkey);
1.1 schwarze 251: enum attrval attrval_parse(const char *);
1.21 schwarze 252: const char *attr_getval(const struct pattr *a);
1.20 schwarze 253: enum nodeid pnode_parse(const char *name);
254: const char *pnode_name(enum nodeid);
255: enum nodeclass pnode_class(enum nodeid);
256:
1.17 schwarze 257: struct pnode *pnode_alloc(struct pnode *);
1.1 schwarze 258: void pnode_unlink(struct pnode *);
259: void pnode_unlinksub(struct pnode *);
260: enum attrval pnode_getattr(struct pnode *, enum attrkey);
261: const char *pnode_getattr_raw(struct pnode *, enum attrkey, const char *);
262: struct pnode *pnode_findfirst(struct pnode *, enum nodeid);
1.22 schwarze 263: struct pnode *pnode_takefirst(struct pnode *, enum nodeid);
CVSweb