[BACK]Return to node.h CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / docbook2mdoc

Annotation of docbook2mdoc/node.h, Revision 1.24

1.24    ! schwarze    1: /* $Id: node.h,v 1.23 2019/04/13 15:54:45 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 {
                     42:        NODE_AFFILIATION,
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,
                     78:        NODE_HOLDER,
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,
                    105:        NODE_OPTION,
                    106:        NODE_ORDEREDLIST,
                    107:        NODE_ORGNAME,
                    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_RELEASEINFO,
                    130:        NODE_REPLACEABLE,
                    131:        NODE_ROW,
                    132:        NODE_SBR,
                    133:        NODE_SCREEN,
                    134:        NODE_SECTION,
                    135:        NODE_SIMPLELIST,
                    136:        NODE_SPANSPEC,
                    137:        NODE_SUBTITLE,
                    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,
                    154:        NODE_YEAR,
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.14      schwarze  175:        ATTRKEY_HREF,
1.1       schwarze  176:        ATTRKEY_ID,
                    177:        ATTRKEY_LINKEND,
1.13      schwarze  178:        ATTRKEY_NAME,
1.1       schwarze  179:        ATTRKEY_OPEN,
1.13      schwarze  180:        ATTRKEY_PUBLIC,
1.1       schwarze  181:        ATTRKEY_REP,
1.13      schwarze  182:        ATTRKEY_SYSTEM,
1.11      schwarze  183:        ATTRKEY_URL,
                    184:        ATTRKEY_XLINK_HREF,
1.1       schwarze  185:        ATTRKEY__MAX
                    186: };
                    187:
                    188: /*
                    189:  * All explicitly recognised attribute values.
                    190:  * If an attribute has ATTRVAL__MAX, it is treated as free-form.
                    191:  */
                    192: enum   attrval {
                    193:        /* Alpha-order... */
1.23      schwarze  194:        ATTRVAL_EVENT,
                    195:        ATTRVAL_IPADDRESS,
1.1       schwarze  196:        ATTRVAL_MONOSPACED,
                    197:        ATTRVAL_NOREPEAT,
                    198:        ATTRVAL_OPT,
                    199:        ATTRVAL_PLAIN,
                    200:        ATTRVAL_REPEAT,
                    201:        ATTRVAL_REQ,
1.23      schwarze  202:        ATTRVAL_SYSTEMNAME,
1.1       schwarze  203:        ATTRVAL__MAX
                    204: };
                    205:
                    206: TAILQ_HEAD(pnodeq, pnode);
                    207: TAILQ_HEAD(pattrq, pattr);
                    208:
                    209: /*
                    210:  * One DocBook XML element attribute.
                    211:  */
                    212: struct pattr {
                    213:        enum attrkey     key;
                    214:        enum attrval     val;
                    215:        char            *rawval;
                    216:        TAILQ_ENTRY(pattr) child;
                    217: };
                    218:
                    219: /*
                    220:  * One DocBook XML element.
                    221:  */
                    222: struct pnode {
                    223:        enum nodeid      node;     /* Node type. */
                    224:        char            *b;        /* String value. */
1.10      schwarze  225:        int              spc;      /* Whitespace before this node. */
1.1       schwarze  226:        struct pnode    *parent;   /* Parent node or NULL. */
                    227:        struct pnodeq    childq;   /* Queue of children. */
                    228:        struct pattrq    attrq;    /* Attributes of the node. */
                    229:        TAILQ_ENTRY(pnode) child;
                    230: };
                    231:
                    232: /*
                    233:  * The parse result for one complete DocBook XML document.
                    234:  */
                    235: struct ptree {
                    236:        struct pnode    *root;     /* The document element. */
                    237:        int              flags;
1.15      schwarze  238: #define        TREE_ERROR       (1 << 0)  /* A parse error occurred. */
                    239: #define        TREE_WARN        (1 << 1)  /* A parser warning occurred. */
                    240: #define        TREE_CLOSED      (1 << 3)  /* The document element was closed. */
1.1       schwarze  241: };
                    242:
                    243:
                    244: enum attrkey    attrkey_parse(const char *);
1.21      schwarze  245: const char     *attrkey_name(enum attrkey);
1.1       schwarze  246: enum attrval    attrval_parse(const char *);
1.21      schwarze  247: const char     *attr_getval(const struct pattr *a);
1.20      schwarze  248: enum nodeid     pnode_parse(const char *name);
                    249: const char     *pnode_name(enum nodeid);
                    250: enum nodeclass  pnode_class(enum nodeid);
                    251:
1.17      schwarze  252: struct pnode   *pnode_alloc(struct pnode *);
1.1       schwarze  253: void            pnode_unlink(struct pnode *);
                    254: void            pnode_unlinksub(struct pnode *);
                    255: enum attrval    pnode_getattr(struct pnode *, enum attrkey);
                    256: const char     *pnode_getattr_raw(struct pnode *, enum attrkey, const char *);
                    257: struct pnode   *pnode_findfirst(struct pnode *, enum nodeid);
1.22      schwarze  258: struct pnode   *pnode_takefirst(struct pnode *, enum nodeid);

CVSweb