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