Annotation of docbook2mdoc/node.h, Revision 1.27
1.27 ! schwarze 1: /* $Id: node.h,v 1.26 2019/04/14 20:13:25 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,
104: NODE_OPTION,
105: NODE_ORDEREDLIST,
106: NODE_PARA,
107: NODE_PARAMDEF,
108: NODE_PARAMETER,
109: NODE_PERSONNAME,
110: NODE_PREFACE,
111: NODE_PROGRAMLISTING,
112: NODE_PROMPT,
1.22 schwarze 113: NODE_PUBDATE,
1.1 schwarze 114: NODE_QUOTE,
115: NODE_REFCLASS,
116: NODE_REFDESCRIPTOR,
117: NODE_REFENTRY,
118: NODE_REFENTRYINFO,
119: NODE_REFENTRYTITLE,
120: NODE_REFMETA,
121: NODE_REFMETAINFO,
122: NODE_REFMISCINFO,
123: NODE_REFNAME,
124: NODE_REFNAMEDIV,
125: NODE_REFPURPOSE,
126: NODE_REFSYNOPSISDIV,
127: NODE_REPLACEABLE,
128: NODE_ROW,
129: NODE_SBR,
130: NODE_SCREEN,
131: NODE_SECTION,
132: NODE_SIMPLELIST,
1.25 schwarze 133: NODE_SIMPLESECT,
1.1 schwarze 134: NODE_SPANSPEC,
1.26 schwarze 135: NODE_SUBSCRIPT,
1.1 schwarze 136: NODE_SUBTITLE,
1.26 schwarze 137: NODE_SUPERSCRIPT,
1.1 schwarze 138: NODE_SYNOPSIS,
1.23 schwarze 139: NODE_SYSTEMITEM,
1.1 schwarze 140: NODE_TABLE,
141: NODE_TBODY,
142: NODE_TERM,
143: NODE_TFOOT,
144: NODE_TGROUP,
145: NODE_THEAD,
146: NODE_TIP,
147: NODE_TITLE,
148: NODE_TYPE,
149: NODE_VARIABLELIST,
150: NODE_VARLISTENTRY,
151: NODE_VARNAME,
152: NODE_WARNING,
153: NODE_WORDASWORD,
1.20 schwarze 154: NODE_UNKNOWN,
155: NODE_TEXT,
156: NODE_ESCAPE,
157: NODE_IGNORE,
158: NODE_DELETE,
159: NODE_DELETE_WARN
1.1 schwarze 160: };
161:
162: /*
163: * All recognised attribute keys.
164: * Other attributes are discarded.
165: */
166: enum attrkey {
167: /* Alpha-order... */
168: ATTRKEY_CHOICE = 0,
169: ATTRKEY_CLASS,
170: ATTRKEY_CLOSE,
1.8 schwarze 171: ATTRKEY_COLS,
1.13 schwarze 172: ATTRKEY_DEFINITION,
1.11 schwarze 173: ATTRKEY_ENDTERM,
1.27 ! schwarze 174: ATTRKEY_ENTITYREF,
! 175: ATTRKEY_FILEREF,
1.14 schwarze 176: ATTRKEY_HREF,
1.1 schwarze 177: ATTRKEY_ID,
178: ATTRKEY_LINKEND,
1.13 schwarze 179: ATTRKEY_NAME,
1.1 schwarze 180: ATTRKEY_OPEN,
1.13 schwarze 181: ATTRKEY_PUBLIC,
1.1 schwarze 182: ATTRKEY_REP,
1.13 schwarze 183: ATTRKEY_SYSTEM,
1.11 schwarze 184: ATTRKEY_URL,
185: ATTRKEY_XLINK_HREF,
1.1 schwarze 186: ATTRKEY__MAX
187: };
188:
189: /*
190: * All explicitly recognised attribute values.
191: * If an attribute has ATTRVAL__MAX, it is treated as free-form.
192: */
193: enum attrval {
194: /* Alpha-order... */
1.23 schwarze 195: ATTRVAL_EVENT,
196: ATTRVAL_IPADDRESS,
1.1 schwarze 197: ATTRVAL_MONOSPACED,
198: ATTRVAL_NOREPEAT,
199: ATTRVAL_OPT,
200: ATTRVAL_PLAIN,
201: ATTRVAL_REPEAT,
202: ATTRVAL_REQ,
1.23 schwarze 203: ATTRVAL_SYSTEMNAME,
1.1 schwarze 204: ATTRVAL__MAX
205: };
206:
207: TAILQ_HEAD(pnodeq, pnode);
208: TAILQ_HEAD(pattrq, pattr);
209:
210: /*
211: * One DocBook XML element attribute.
212: */
213: struct pattr {
214: enum attrkey key;
215: enum attrval val;
216: char *rawval;
217: TAILQ_ENTRY(pattr) child;
218: };
219:
220: /*
221: * One DocBook XML element.
222: */
223: struct pnode {
224: enum nodeid node; /* Node type. */
225: char *b; /* String value. */
1.10 schwarze 226: int spc; /* Whitespace before this node. */
1.1 schwarze 227: struct pnode *parent; /* Parent node or NULL. */
228: struct pnodeq childq; /* Queue of children. */
229: struct pattrq attrq; /* Attributes of the node. */
230: TAILQ_ENTRY(pnode) child;
231: };
232:
233: /*
234: * The parse result for one complete DocBook XML document.
235: */
236: struct ptree {
237: struct pnode *root; /* The document element. */
238: int flags;
1.15 schwarze 239: #define TREE_ERROR (1 << 0) /* A parse error occurred. */
240: #define TREE_WARN (1 << 1) /* A parser warning occurred. */
241: #define TREE_CLOSED (1 << 3) /* The document element was closed. */
1.1 schwarze 242: };
243:
244:
245: enum attrkey attrkey_parse(const char *);
1.21 schwarze 246: const char *attrkey_name(enum attrkey);
1.1 schwarze 247: enum attrval attrval_parse(const char *);
1.21 schwarze 248: const char *attr_getval(const struct pattr *a);
1.20 schwarze 249: enum nodeid pnode_parse(const char *name);
250: const char *pnode_name(enum nodeid);
251: enum nodeclass pnode_class(enum nodeid);
252:
1.17 schwarze 253: struct pnode *pnode_alloc(struct pnode *);
1.1 schwarze 254: void pnode_unlink(struct pnode *);
255: void pnode_unlinksub(struct pnode *);
256: enum attrval pnode_getattr(struct pnode *, enum attrkey);
257: const char *pnode_getattr_raw(struct pnode *, enum attrkey, const char *);
258: struct pnode *pnode_findfirst(struct pnode *, enum nodeid);
1.22 schwarze 259: struct pnode *pnode_takefirst(struct pnode *, enum nodeid);
CVSweb