xref: /aosp_15_r20/external/libxml2/os400/libxmlrpg/entities.rpgle (revision 7c5688314b92172186c154356a6374bf7684c3ca)
1*7c568831SAndroid Build Coastguard Worker      * Summary: interface for the XML entities handling
2*7c568831SAndroid Build Coastguard Worker      * Description: this module provides some of the entity API needed
3*7c568831SAndroid Build Coastguard Worker      *              for the parser and applications.
4*7c568831SAndroid Build Coastguard Worker      *
5*7c568831SAndroid Build Coastguard Worker      * Copy: See Copyright for the status of this software.
6*7c568831SAndroid Build Coastguard Worker      *
7*7c568831SAndroid Build Coastguard Worker      * Author: Patrick Monnerat <[email protected]>, DATASPHERE S.A.
8*7c568831SAndroid Build Coastguard Worker
9*7c568831SAndroid Build Coastguard Worker      /if not defined(XML_ENTITIES_H__)
10*7c568831SAndroid Build Coastguard Worker      /define XML_ENTITIES_H__
11*7c568831SAndroid Build Coastguard Worker
12*7c568831SAndroid Build Coastguard Worker      /include "libxmlrpg/xmlversion"
13*7c568831SAndroid Build Coastguard Worker      /include "libxmlrpg/xmlTypesC"
14*7c568831SAndroid Build Coastguard Worker      /include "libxmlrpg/tree"
15*7c568831SAndroid Build Coastguard Worker
16*7c568831SAndroid Build Coastguard Worker      * The different valid entity types.
17*7c568831SAndroid Build Coastguard Worker
18*7c568831SAndroid Build Coastguard Worker     d xmlEntityType   s                   based(######typedef######)
19*7c568831SAndroid Build Coastguard Worker     d                                     like(xmlCenum)
20*7c568831SAndroid Build Coastguard Worker     d  XML_INTERNAL_GENERAL_ENTITY...
21*7c568831SAndroid Build Coastguard Worker     d                 c                   1
22*7c568831SAndroid Build Coastguard Worker     d  XML_EXTERNAL_GENERAL_PARSED_ENTITY...
23*7c568831SAndroid Build Coastguard Worker     d                 c                   2
24*7c568831SAndroid Build Coastguard Worker     d  XML_EXTERNAL_GENERAL_UNPARSED_ENTITY...
25*7c568831SAndroid Build Coastguard Worker     d                 c                   3
26*7c568831SAndroid Build Coastguard Worker     d  XML_INTERNAL_PARAMETER_ENTITY...
27*7c568831SAndroid Build Coastguard Worker     d                 c                   4
28*7c568831SAndroid Build Coastguard Worker     d  XML_EXTERNAL_PARAMETER_ENTITY...
29*7c568831SAndroid Build Coastguard Worker     d                 c                   5
30*7c568831SAndroid Build Coastguard Worker     d  XML_INTERNAL_PREDEFINED_ENTITY...
31*7c568831SAndroid Build Coastguard Worker     d                 c                   6
32*7c568831SAndroid Build Coastguard Worker
33*7c568831SAndroid Build Coastguard Worker      * An unit of storage for an entity, contains the string, the value
34*7c568831SAndroid Build Coastguard Worker      * and the linkind data needed for the linking in the hash table.
35*7c568831SAndroid Build Coastguard Worker
36*7c568831SAndroid Build Coastguard Worker     d xmlEntity       ds                  based(xmlEntityPtr)
37*7c568831SAndroid Build Coastguard Worker     d                                     align qualified
38*7c568831SAndroid Build Coastguard Worker     d  #private                       *                                        void *
39*7c568831SAndroid Build Coastguard Worker     d  type                               like(xmlElementType)                 XML_ENTITY_DECL
40*7c568831SAndroid Build Coastguard Worker     d  name                           *                                        const xmlChar *
41*7c568831SAndroid Build Coastguard Worker     d  children                           like(xmlNodePtr)                     First child link
42*7c568831SAndroid Build Coastguard Worker     d  last                               like(xmlNodePtr)                     Last child link
43*7c568831SAndroid Build Coastguard Worker     d  parent                             like(xmlDtdPtr)                      -> DTD
44*7c568831SAndroid Build Coastguard Worker     d  next                               like(xmlNodePtr)                     next sibling link
45*7c568831SAndroid Build Coastguard Worker     d  prev                               like(xmlNodePtr)                     prev sibling link
46*7c568831SAndroid Build Coastguard Worker     d  doc                                like(xmlDocPtr)                      containing document
47*7c568831SAndroid Build Coastguard Worker     d  orig                           *                                        xmlChar *
48*7c568831SAndroid Build Coastguard Worker     d  content                        *                                        xmlChar *
49*7c568831SAndroid Build Coastguard Worker     d  length                             like(xmlCint)                        content length
50*7c568831SAndroid Build Coastguard Worker     d  etype                              like(xmlEntityType)                  The entity type
51*7c568831SAndroid Build Coastguard Worker     d  ExternalID                     *                                        const xmlChar *
52*7c568831SAndroid Build Coastguard Worker     d  SystemlID                      *                                        const xmlChar *
53*7c568831SAndroid Build Coastguard Worker     d  nexte                              like(xmlEntityPtr)                   unused
54*7c568831SAndroid Build Coastguard Worker     d  URI                            *                                        const xmlChar *
55*7c568831SAndroid Build Coastguard Worker     d  owner                              like(xmlCint)                        Owns children ?
56*7c568831SAndroid Build Coastguard Worker     d  checked                            like(xmlCint)                        Content checked ?
57*7c568831SAndroid Build Coastguard Worker
58*7c568831SAndroid Build Coastguard Worker      * All entities are stored in an hash table.
59*7c568831SAndroid Build Coastguard Worker      * There is 2 separate hash tables for global and parameter entities.
60*7c568831SAndroid Build Coastguard Worker
61*7c568831SAndroid Build Coastguard Worker     d xmlEntitiesTablePtr...
62*7c568831SAndroid Build Coastguard Worker     d                 s               *   based(######typedef######)
63*7c568831SAndroid Build Coastguard Worker
64*7c568831SAndroid Build Coastguard Worker      * External functions:
65*7c568831SAndroid Build Coastguard Worker
66*7c568831SAndroid Build Coastguard Worker      /if defined(LIBXML_LEGACY_ENABLED)
67*7c568831SAndroid Build Coastguard Worker     d xmlInitializePredefinedEntities...
68*7c568831SAndroid Build Coastguard Worker     d                 pr                  extproc(
69*7c568831SAndroid Build Coastguard Worker     d                                      'xmlInitializePredefinedEntities')
70*7c568831SAndroid Build Coastguard Worker      /endif                                                                    LIBXML_LEGACY_ENABLD
71*7c568831SAndroid Build Coastguard Worker
72*7c568831SAndroid Build Coastguard Worker     d xmlNewEntity    pr                  extproc('xmlNewEntity')
73*7c568831SAndroid Build Coastguard Worker     d                                     like(xmlEntityPtr)
74*7c568831SAndroid Build Coastguard Worker     d  doc                                value like(xmlDocPtr)
75*7c568831SAndroid Build Coastguard Worker     d  name                           *   value options(*string)               const xmlChar *
76*7c568831SAndroid Build Coastguard Worker     d  type                               value like(xmlCint)
77*7c568831SAndroid Build Coastguard Worker     d  ExternalID                     *   value options(*string)               const xmlChar *
78*7c568831SAndroid Build Coastguard Worker     d  SystemID                       *   value options(*string)               const xmlChar *
79*7c568831SAndroid Build Coastguard Worker     d  content                        *   value options(*string)               const xmlChar *
80*7c568831SAndroid Build Coastguard Worker
81*7c568831SAndroid Build Coastguard Worker     d xmlAddDocEntity...
82*7c568831SAndroid Build Coastguard Worker     d                 pr                  extproc('xmlAddDocEntity')
83*7c568831SAndroid Build Coastguard Worker     d                                     like(xmlEntityPtr)
84*7c568831SAndroid Build Coastguard Worker     d  doc                                value like(xmlDocPtr)
85*7c568831SAndroid Build Coastguard Worker     d  name                           *   value options(*string)               const xmlChar *
86*7c568831SAndroid Build Coastguard Worker     d  type                               value like(xmlCint)
87*7c568831SAndroid Build Coastguard Worker     d  ExternalID                     *   value options(*string)               const xmlChar *
88*7c568831SAndroid Build Coastguard Worker     d  SystemID                       *   value options(*string)               const xmlChar *
89*7c568831SAndroid Build Coastguard Worker     d  content                        *   value options(*string)               const xmlChar *
90*7c568831SAndroid Build Coastguard Worker
91*7c568831SAndroid Build Coastguard Worker     d xmlAddDtdEntity...
92*7c568831SAndroid Build Coastguard Worker     d                 pr                  extproc('xmlAddDtdEntity')
93*7c568831SAndroid Build Coastguard Worker     d                                     like(xmlEntityPtr)
94*7c568831SAndroid Build Coastguard Worker     d  doc                                value like(xmlDocPtr)
95*7c568831SAndroid Build Coastguard Worker     d  name                           *   value options(*string)               const xmlChar *
96*7c568831SAndroid Build Coastguard Worker     d  type                               value like(xmlCint)
97*7c568831SAndroid Build Coastguard Worker     d  ExternalID                     *   value options(*string)               const xmlChar *
98*7c568831SAndroid Build Coastguard Worker     d  SystemID                       *   value options(*string)               const xmlChar *
99*7c568831SAndroid Build Coastguard Worker     d  content                        *   value options(*string)               const xmlChar *
100*7c568831SAndroid Build Coastguard Worker
101*7c568831SAndroid Build Coastguard Worker     d xmlGetPredefinedEntity...
102*7c568831SAndroid Build Coastguard Worker     d                 pr                  extproc('xmlGetPredefinedEntity')
103*7c568831SAndroid Build Coastguard Worker     d                                     like(xmlEntityPtr)
104*7c568831SAndroid Build Coastguard Worker     d  name                           *   value options(*string)               const xmlChar *
105*7c568831SAndroid Build Coastguard Worker
106*7c568831SAndroid Build Coastguard Worker     d xmlGetDocEntity...
107*7c568831SAndroid Build Coastguard Worker     d                 pr                  extproc('xmlGetDocEntity')
108*7c568831SAndroid Build Coastguard Worker     d                                     like(xmlEntityPtr)
109*7c568831SAndroid Build Coastguard Worker     d  doc                                value like(xmlDocPtr)
110*7c568831SAndroid Build Coastguard Worker     d  name                           *   value options(*string)               const xmlChar *
111*7c568831SAndroid Build Coastguard Worker
112*7c568831SAndroid Build Coastguard Worker     d xmlGetDtdEntity...
113*7c568831SAndroid Build Coastguard Worker     d                 pr                  extproc('xmlGetDtdEntity')
114*7c568831SAndroid Build Coastguard Worker     d                                     like(xmlEntityPtr)
115*7c568831SAndroid Build Coastguard Worker     d  doc                                value like(xmlDocPtr)
116*7c568831SAndroid Build Coastguard Worker     d  name                           *   value options(*string)               const xmlChar *
117*7c568831SAndroid Build Coastguard Worker
118*7c568831SAndroid Build Coastguard Worker     d xmlGetParameterEntity...
119*7c568831SAndroid Build Coastguard Worker     d                 pr                  extproc('xmlGetParameterEntity')
120*7c568831SAndroid Build Coastguard Worker     d                                     like(xmlEntityPtr)
121*7c568831SAndroid Build Coastguard Worker     d  doc                                value like(xmlDocPtr)
122*7c568831SAndroid Build Coastguard Worker     d  name                           *   value options(*string)               const xmlChar *
123*7c568831SAndroid Build Coastguard Worker
124*7c568831SAndroid Build Coastguard Worker
125*7c568831SAndroid Build Coastguard Worker      /if defined(LIBXML_LEGACY_ENABLED)
126*7c568831SAndroid Build Coastguard Worker     d xmlEncodeEntities...
127*7c568831SAndroid Build Coastguard Worker     d                 pr              *   extproc('xmlEncodeEntities')         xmlChar *
128*7c568831SAndroid Build Coastguard Worker     d  doc                                value like(xmlDocPtr)
129*7c568831SAndroid Build Coastguard Worker     d  input                          *   value options(*string)               const xmlChar *
130*7c568831SAndroid Build Coastguard Worker      /endif                                                                    LIBXML_LEGACY_ENABLD
131*7c568831SAndroid Build Coastguard Worker
132*7c568831SAndroid Build Coastguard Worker     d xmlEncodeEntitiesReentrant...
133*7c568831SAndroid Build Coastguard Worker     d                 pr              *   extproc(                             xmlChar *
134*7c568831SAndroid Build Coastguard Worker     d                                      'xmlEncodeEntitiesReentrant')
135*7c568831SAndroid Build Coastguard Worker     d  doc                                value like(xmlDocPtr)
136*7c568831SAndroid Build Coastguard Worker     d  input                          *   value options(*string)               const xmlChar *
137*7c568831SAndroid Build Coastguard WorkerXMLPU
138*7c568831SAndroid Build Coastguard Worker     d xmlEncodeSpecialChars...
139*7c568831SAndroid Build Coastguard Worker     d                 pr              *   extproc('xmlSpecialChars')           xmlChar *
140*7c568831SAndroid Build Coastguard Worker     d  doc                                value like(xmlDocPtr)
141*7c568831SAndroid Build Coastguard Worker     d  input                          *   value options(*string)               const xmlChar *
142*7c568831SAndroid Build Coastguard WorkerXMLPU
143*7c568831SAndroid Build Coastguard Worker     d xmlCreateEntitiesTable...
144*7c568831SAndroid Build Coastguard Worker     d                 pr                  extproc('xmlCreateEntitiesTable')
145*7c568831SAndroid Build Coastguard Worker     d                                     like(xmlEntitiesTablePtr)
146*7c568831SAndroid Build Coastguard Worker
147*7c568831SAndroid Build Coastguard Worker      /if defined(LIBXML_TREE_ENABLED)
148*7c568831SAndroid Build Coastguard Worker     d xmlCopyEntitiesTable...
149*7c568831SAndroid Build Coastguard Worker     d                 pr                  extproc('xmlCopyEntitiesTable')
150*7c568831SAndroid Build Coastguard Worker     d                                     like(xmlEntitiesTablePtr)
151*7c568831SAndroid Build Coastguard Worker     d  table                              value like(xmlEntitiesTablePtr)
152*7c568831SAndroid Build Coastguard Worker      /endif                                                                    LIBXML_TREE_ENABLED
153*7c568831SAndroid Build Coastguard Worker
154*7c568831SAndroid Build Coastguard Worker     d xmlFreeEntitiesTable...
155*7c568831SAndroid Build Coastguard Worker     d                 pr                  extproc('xmlFreeEntitiesTable')
156*7c568831SAndroid Build Coastguard Worker     d  table                              value like(xmlEntitiesTablePtr)
157*7c568831SAndroid Build Coastguard WorkerXMLPU
158*7c568831SAndroid Build Coastguard Worker      /if defined(LIBXML_OUTPUT_ENABLED)
159*7c568831SAndroid Build Coastguard Worker     d xmlDumpEntitiesTable...
160*7c568831SAndroid Build Coastguard Worker     d                 pr                  extproc('xmlDumpEntitiesTable')
161*7c568831SAndroid Build Coastguard Worker     d  buf                                value like(xmlBufferPtr)
162*7c568831SAndroid Build Coastguard Worker     d  table                              value like(xmlEntitiesTablePtr)
163*7c568831SAndroid Build Coastguard WorkerXMLPU
164*7c568831SAndroid Build Coastguard Worker     d xmlDumpEntityDecl...
165*7c568831SAndroid Build Coastguard Worker     d                 pr                  extproc('xmlDumpEntityDecl')
166*7c568831SAndroid Build Coastguard Worker     d  buf                                value like(xmlBufferPtr)
167*7c568831SAndroid Build Coastguard Worker     d  ent                                value like(xmlEntityPtr)
168*7c568831SAndroid Build Coastguard Worker      /endif                                                                    LIBXML_OUTPUT_ENABLD
169*7c568831SAndroid Build Coastguard Worker
170*7c568831SAndroid Build Coastguard Worker      /if defined(LIBXML_LEGACY_ENABLED)
171*7c568831SAndroid Build Coastguard Worker     d xmlCleanupPredefinedEntities...
172*7c568831SAndroid Build Coastguard Worker     d                 pr                  extproc(
173*7c568831SAndroid Build Coastguard WorkerXMLPUd                                      'xmlCleanupPredefinedEntities')
174*7c568831SAndroid Build Coastguard Worker      /endif                                                                    LIBXML_LEGACY_ENABLD
175*7c568831SAndroid Build Coastguard Worker
176*7c568831SAndroid Build Coastguard Worker      /endif                                                                    XML_ENTITIES_H__
177