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