xref: /freebsd/contrib/expat/lib/xmlrole.h (revision 207d96dabfec14d7b3699747abb539ab3c1118ab)
1 /*
2                             __  __            _
3                          ___\ \/ /_ __   __ _| |_
4                         / _ \\  /| '_ \ / _` | __|
5                        |  __//  \| |_) | (_| | |_
6                         \___/_/\_\ .__/ \__,_|\__|
7                                  |_| XML parser
8 
9    Copyright (c) 1997-2000 Thai Open Source Software Center Ltd
10    Copyright (c) 2000      Clark Cooper <coopercc@users.sourceforge.net>
11    Copyright (c) 2002      Karl Waclawek <karl@waclawek.net>
12    Copyright (c) 2002      Fred L. Drake, Jr. <fdrake@users.sourceforge.net>
13    Copyright (c) 2017-2025 Sebastian Pipping <sebastian@pipping.org>
14    Licensed under the MIT license:
15 
16    Permission is  hereby granted,  free of charge,  to any  person obtaining
17    a  copy  of  this  software   and  associated  documentation  files  (the
18    "Software"),  to  deal in  the  Software  without restriction,  including
19    without  limitation the  rights  to use,  copy,  modify, merge,  publish,
20    distribute, sublicense, and/or sell copies of the Software, and to permit
21    persons  to whom  the Software  is  furnished to  do so,  subject to  the
22    following conditions:
23 
24    The above copyright  notice and this permission notice  shall be included
25    in all copies or substantial portions of the Software.
26 
27    THE  SOFTWARE  IS  PROVIDED  "AS  IS",  WITHOUT  WARRANTY  OF  ANY  KIND,
28    EXPRESS  OR IMPLIED,  INCLUDING  BUT  NOT LIMITED  TO  THE WARRANTIES  OF
29    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
30    NO EVENT SHALL THE AUTHORS OR  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
31    DAMAGES OR  OTHER LIABILITY, WHETHER  IN AN  ACTION OF CONTRACT,  TORT OR
32    OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
33    USE OR OTHER DEALINGS IN THE SOFTWARE.
34 
35    SPDX-License-Identifier: MIT
36 */
37 
38 #ifndef XmlRole_INCLUDED
39 #  define XmlRole_INCLUDED 1
40 
41 #  include "xmltok.h"
42 
43 #  ifdef __cplusplus
44 extern "C" {
45 #  endif
46 
47 enum {
48   XML_ROLE_ERROR = -1,
49   XML_ROLE_NONE = 0,
50   XML_ROLE_XML_DECL,
51   XML_ROLE_INSTANCE_START,
52   XML_ROLE_DOCTYPE_NONE,
53   XML_ROLE_DOCTYPE_NAME,
54   XML_ROLE_DOCTYPE_SYSTEM_ID,
55   XML_ROLE_DOCTYPE_PUBLIC_ID,
56   XML_ROLE_DOCTYPE_INTERNAL_SUBSET,
57   XML_ROLE_DOCTYPE_CLOSE,
58   XML_ROLE_GENERAL_ENTITY_NAME,
59   XML_ROLE_PARAM_ENTITY_NAME,
60   XML_ROLE_ENTITY_NONE,
61   XML_ROLE_ENTITY_VALUE,
62   XML_ROLE_ENTITY_SYSTEM_ID,
63   XML_ROLE_ENTITY_PUBLIC_ID,
64   XML_ROLE_ENTITY_COMPLETE,
65   XML_ROLE_ENTITY_NOTATION_NAME,
66   XML_ROLE_NOTATION_NONE,
67   XML_ROLE_NOTATION_NAME,
68   XML_ROLE_NOTATION_SYSTEM_ID,
69   XML_ROLE_NOTATION_NO_SYSTEM_ID,
70   XML_ROLE_NOTATION_PUBLIC_ID,
71   XML_ROLE_ATTRIBUTE_NAME,
72   XML_ROLE_ATTRIBUTE_TYPE_CDATA,
73   XML_ROLE_ATTRIBUTE_TYPE_ID,
74   XML_ROLE_ATTRIBUTE_TYPE_IDREF,
75   XML_ROLE_ATTRIBUTE_TYPE_IDREFS,
76   XML_ROLE_ATTRIBUTE_TYPE_ENTITY,
77   XML_ROLE_ATTRIBUTE_TYPE_ENTITIES,
78   XML_ROLE_ATTRIBUTE_TYPE_NMTOKEN,
79   XML_ROLE_ATTRIBUTE_TYPE_NMTOKENS,
80   XML_ROLE_ATTRIBUTE_ENUM_VALUE,
81   XML_ROLE_ATTRIBUTE_NOTATION_VALUE,
82   XML_ROLE_ATTLIST_NONE,
83   XML_ROLE_ATTLIST_ELEMENT_NAME,
84   XML_ROLE_IMPLIED_ATTRIBUTE_VALUE,
85   XML_ROLE_REQUIRED_ATTRIBUTE_VALUE,
86   XML_ROLE_DEFAULT_ATTRIBUTE_VALUE,
87   XML_ROLE_FIXED_ATTRIBUTE_VALUE,
88   XML_ROLE_ELEMENT_NONE,
89   XML_ROLE_ELEMENT_NAME,
90   XML_ROLE_CONTENT_ANY,
91   XML_ROLE_CONTENT_EMPTY,
92   XML_ROLE_CONTENT_PCDATA,
93   XML_ROLE_GROUP_OPEN,
94   XML_ROLE_GROUP_CLOSE,
95   XML_ROLE_GROUP_CLOSE_REP,
96   XML_ROLE_GROUP_CLOSE_OPT,
97   XML_ROLE_GROUP_CLOSE_PLUS,
98   XML_ROLE_GROUP_CHOICE,
99   XML_ROLE_GROUP_SEQUENCE,
100   XML_ROLE_CONTENT_ELEMENT,
101   XML_ROLE_CONTENT_ELEMENT_REP,
102   XML_ROLE_CONTENT_ELEMENT_OPT,
103   XML_ROLE_CONTENT_ELEMENT_PLUS,
104   XML_ROLE_PI,
105   XML_ROLE_COMMENT,
106 #  ifdef XML_DTD
107   XML_ROLE_TEXT_DECL,
108   XML_ROLE_IGNORE_SECT,
109   XML_ROLE_INNER_PARAM_ENTITY_REF,
110 #  endif /* XML_DTD */
111   XML_ROLE_PARAM_ENTITY_REF
112 };
113 
114 typedef struct prolog_state {
115   int(PTRCALL *handler)(struct prolog_state *state, int tok, const char *ptr,
116                         const char *end, const ENCODING *enc);
117   unsigned level;
118   int role_none;
119 #  ifdef XML_DTD
120   unsigned includeLevel;
121   int documentEntity;
122   int inEntityValue;
123 #  endif /* XML_DTD */
124 } PROLOG_STATE;
125 
126 void XmlPrologStateInit(PROLOG_STATE *state);
127 #  ifdef XML_DTD
128 void XmlPrologStateInitExternalEntity(PROLOG_STATE *state);
129 #  endif /* XML_DTD */
130 
131 #  define XmlTokenRole(state, tok, ptr, end, enc)                              \
132     (((state)->handler)(state, tok, ptr, end, enc))
133 
134 #  ifdef __cplusplus
135 }
136 #  endif
137 
138 #endif /* not XmlRole_INCLUDED */
139