Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 1 | /* |
Daniel Veillard | be58697 | 2003-11-18 20:56:51 +0000 | [diff] [blame] | 2 | * Summary: interface for the XML entities handling |
| 3 | * Description: this module provides some of the entity API needed |
| 4 | * for the parser and applications. |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 5 | * |
Daniel Veillard | be58697 | 2003-11-18 20:56:51 +0000 | [diff] [blame] | 6 | * Copy: See Copyright for the status of this software. |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 7 | * |
Daniel Veillard | be58697 | 2003-11-18 20:56:51 +0000 | [diff] [blame] | 8 | * Author: Daniel Veillard |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 9 | */ |
| 10 | |
| 11 | #ifndef __XML_ENTITIES_H__ |
| 12 | #define __XML_ENTITIES_H__ |
| 13 | |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 14 | #include <libxml/xmlversion.h> |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 15 | #include <libxml/tree.h> |
| 16 | |
| 17 | #ifdef __cplusplus |
| 18 | extern "C" { |
| 19 | #endif |
| 20 | |
| 21 | /* |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 22 | * The different valid entity types. |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 23 | */ |
| 24 | typedef enum { |
| 25 | XML_INTERNAL_GENERAL_ENTITY = 1, |
| 26 | XML_EXTERNAL_GENERAL_PARSED_ENTITY = 2, |
| 27 | XML_EXTERNAL_GENERAL_UNPARSED_ENTITY = 3, |
| 28 | XML_INTERNAL_PARAMETER_ENTITY = 4, |
| 29 | XML_EXTERNAL_PARAMETER_ENTITY = 5, |
| 30 | XML_INTERNAL_PREDEFINED_ENTITY = 6 |
| 31 | } xmlEntityType; |
| 32 | |
| 33 | /* |
| 34 | * An unit of storage for an entity, contains the string, the value |
| 35 | * and the linkind data needed for the linking in the hash table. |
| 36 | */ |
| 37 | |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 38 | struct _xmlEntity { |
Daniel Veillard | cbaf399 | 2001-12-31 16:16:02 +0000 | [diff] [blame] | 39 | void *_private; /* application data */ |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 40 | xmlElementType type; /* XML_ENTITY_DECL, must be second ! */ |
Daniel Veillard | e4301c8 | 2002-02-13 13:32:35 +0000 | [diff] [blame] | 41 | const xmlChar *name; /* Entity name */ |
Daniel Veillard | 8ee9c8f | 2002-01-26 21:42:58 +0000 | [diff] [blame] | 42 | struct _xmlNode *children; /* First child link */ |
| 43 | struct _xmlNode *last; /* Last child link */ |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 44 | struct _xmlDtd *parent; /* -> DTD */ |
| 45 | struct _xmlNode *next; /* next sibling link */ |
| 46 | struct _xmlNode *prev; /* previous sibling link */ |
| 47 | struct _xmlDoc *doc; /* the containing document */ |
| 48 | |
| 49 | xmlChar *orig; /* content without ref substitution */ |
| 50 | xmlChar *content; /* content or ndata if unparsed */ |
| 51 | int length; /* the content length */ |
| 52 | xmlEntityType etype; /* The entity type */ |
| 53 | const xmlChar *ExternalID; /* External identifier for PUBLIC */ |
| 54 | const xmlChar *SystemID; /* URI for a SYSTEM or PUBLIC Entity */ |
| 55 | |
| 56 | struct _xmlEntity *nexte; /* unused */ |
| 57 | const xmlChar *URI; /* the full URI as computed */ |
Daniel Veillard | 2d84a89 | 2002-12-30 00:01:08 +0000 | [diff] [blame] | 58 | int owner; /* does the entity own the childrens */ |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 59 | }; |
| 60 | |
| 61 | /* |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 62 | * All entities are stored in an hash table. |
| 63 | * There is 2 separate hash tables for global and parameter entities. |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 64 | */ |
| 65 | |
| 66 | typedef struct _xmlHashTable xmlEntitiesTable; |
| 67 | typedef xmlEntitiesTable *xmlEntitiesTablePtr; |
| 68 | |
| 69 | /* |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 70 | * External functions: |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 71 | */ |
| 72 | |
William M. Brack | 21e4ef2 | 2005-01-02 09:53:13 +0000 | [diff] [blame] | 73 | #ifdef LIBXML_LEGACY_ENABLED |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 74 | XMLPUBFUN void XMLCALL |
| 75 | xmlInitializePredefinedEntities (void); |
William M. Brack | 21e4ef2 | 2005-01-02 09:53:13 +0000 | [diff] [blame] | 76 | #endif /* LIBXML_LEGACY_ENABLED */ |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 77 | XMLPUBFUN xmlEntityPtr XMLCALL |
| 78 | xmlAddDocEntity (xmlDocPtr doc, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 79 | const xmlChar *name, |
| 80 | int type, |
| 81 | const xmlChar *ExternalID, |
| 82 | const xmlChar *SystemID, |
| 83 | const xmlChar *content); |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 84 | XMLPUBFUN xmlEntityPtr XMLCALL |
| 85 | xmlAddDtdEntity (xmlDocPtr doc, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 86 | const xmlChar *name, |
| 87 | int type, |
| 88 | const xmlChar *ExternalID, |
| 89 | const xmlChar *SystemID, |
| 90 | const xmlChar *content); |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 91 | XMLPUBFUN xmlEntityPtr XMLCALL |
| 92 | xmlGetPredefinedEntity (const xmlChar *name); |
| 93 | XMLPUBFUN xmlEntityPtr XMLCALL |
| 94 | xmlGetDocEntity (xmlDocPtr doc, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 95 | const xmlChar *name); |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 96 | XMLPUBFUN xmlEntityPtr XMLCALL |
| 97 | xmlGetDtdEntity (xmlDocPtr doc, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 98 | const xmlChar *name); |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 99 | XMLPUBFUN xmlEntityPtr XMLCALL |
| 100 | xmlGetParameterEntity (xmlDocPtr doc, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 101 | const xmlChar *name); |
William M. Brack | 21e4ef2 | 2005-01-02 09:53:13 +0000 | [diff] [blame] | 102 | #ifdef LIBXML_LEGACY_ENABLED |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 103 | XMLPUBFUN const xmlChar * XMLCALL |
| 104 | xmlEncodeEntities (xmlDocPtr doc, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 105 | const xmlChar *input); |
William M. Brack | 21e4ef2 | 2005-01-02 09:53:13 +0000 | [diff] [blame] | 106 | #endif /* LIBXML_LEGACY_ENABLED */ |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 107 | XMLPUBFUN xmlChar * XMLCALL |
| 108 | xmlEncodeEntitiesReentrant(xmlDocPtr doc, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 109 | const xmlChar *input); |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 110 | XMLPUBFUN xmlChar * XMLCALL |
| 111 | xmlEncodeSpecialChars (xmlDocPtr doc, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 112 | const xmlChar *input); |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 113 | XMLPUBFUN xmlEntitiesTablePtr XMLCALL |
| 114 | xmlCreateEntitiesTable (void); |
William M. Brack | 21e4ef2 | 2005-01-02 09:53:13 +0000 | [diff] [blame] | 115 | #ifdef LIBXML_TREE_ENABLED |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 116 | XMLPUBFUN xmlEntitiesTablePtr XMLCALL |
| 117 | xmlCopyEntitiesTable (xmlEntitiesTablePtr table); |
William M. Brack | 21e4ef2 | 2005-01-02 09:53:13 +0000 | [diff] [blame] | 118 | #endif /* LIBXML_TREE_ENABLED */ |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 119 | XMLPUBFUN void XMLCALL |
| 120 | xmlFreeEntitiesTable (xmlEntitiesTablePtr table); |
Daniel Veillard | a9cce9c | 2003-09-29 13:20:24 +0000 | [diff] [blame] | 121 | #ifdef LIBXML_OUTPUT_ENABLED |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 122 | XMLPUBFUN void XMLCALL |
| 123 | xmlDumpEntitiesTable (xmlBufferPtr buf, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 124 | xmlEntitiesTablePtr table); |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 125 | XMLPUBFUN void XMLCALL |
| 126 | xmlDumpEntityDecl (xmlBufferPtr buf, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 127 | xmlEntityPtr ent); |
Daniel Veillard | a9cce9c | 2003-09-29 13:20:24 +0000 | [diff] [blame] | 128 | #endif /* LIBXML_OUTPUT_ENABLED */ |
William M. Brack | 21e4ef2 | 2005-01-02 09:53:13 +0000 | [diff] [blame] | 129 | #ifdef LIBXML_LEGACY_ENABLED |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 130 | XMLPUBFUN void XMLCALL |
| 131 | xmlCleanupPredefinedEntities(void); |
William M. Brack | 21e4ef2 | 2005-01-02 09:53:13 +0000 | [diff] [blame] | 132 | #endif /* LIBXML_LEGACY_ENABLED */ |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 133 | |
| 134 | |
| 135 | #ifdef __cplusplus |
| 136 | } |
| 137 | #endif |
| 138 | |
| 139 | # endif /* __XML_ENTITIES_H__ */ |