Daniel Veillard | 260a68f | 1998-08-13 03:39:55 +0000 | [diff] [blame] | 1 | /* |
| 2 | * entities.h : interface for the XML entities handking |
| 3 | * |
| 4 | * See Copyright for the status of this software. |
| 5 | * |
Daniel Veillard | 39a1f9a | 1999-01-17 19:11:59 +0000 | [diff] [blame] | 6 | * Daniel.Veillard@w3.org |
Daniel Veillard | 260a68f | 1998-08-13 03:39:55 +0000 | [diff] [blame] | 7 | */ |
| 8 | |
| 9 | #ifndef __XML_ENTITIES_H__ |
| 10 | #define __XML_ENTITIES_H__ |
Daniel Veillard | 260a68f | 1998-08-13 03:39:55 +0000 | [diff] [blame] | 11 | |
Daniel Veillard | 517752b | 1999-04-05 12:20:10 +0000 | [diff] [blame] | 12 | #include "tree.h" |
Daniel Veillard | 260a68f | 1998-08-13 03:39:55 +0000 | [diff] [blame] | 13 | |
| 14 | #ifdef __cplusplus |
| 15 | extern "C" { |
| 16 | #endif |
| 17 | |
| 18 | #define XML_INTERNAL_GENERAL_ENTITY 1 |
| 19 | #define XML_EXTERNAL_GENERAL_PARSED_ENTITY 2 |
| 20 | #define XML_EXTERNAL_GENERAL_UNPARSED_ENTITY 3 |
| 21 | #define XML_INTERNAL_PARAMETER_ENTITY 4 |
| 22 | #define XML_EXTERNAL_PARAMETER_ENTITY 5 |
Daniel Veillard | 25940b7 | 1998-10-29 05:51:30 +0000 | [diff] [blame] | 23 | #define XML_INTERNAL_PREDEFINED_ENTITY 6 |
Daniel Veillard | 260a68f | 1998-08-13 03:39:55 +0000 | [diff] [blame] | 24 | |
| 25 | /* |
| 26 | * An unit of storage for an entity, contains the string, the value |
| 27 | * and the linkind data needed for the linking in the hash table. |
| 28 | */ |
| 29 | |
| 30 | typedef struct xmlEntity { |
| 31 | int type; /* The entity type */ |
| 32 | int len; /* The lenght of the name */ |
Daniel Veillard | 00fdf37 | 1999-10-08 09:40:39 +0000 | [diff] [blame] | 33 | const xmlChar *name; /* Name of the entity */ |
| 34 | const xmlChar *ExternalID; /* External identifier for PUBLIC Entity */ |
| 35 | const xmlChar *SystemID; /* URI for a SYSTEM or PUBLIC Entity */ |
Daniel Veillard | dd6b367 | 1999-09-23 22:19:22 +0000 | [diff] [blame] | 36 | xmlChar *content; /* The entity content or ndata if unparsed */ |
Daniel Veillard | 00fdf37 | 1999-10-08 09:40:39 +0000 | [diff] [blame] | 37 | xmlChar *orig; /* The entity cont without ref substitution */ |
Daniel Veillard | 1e346af | 1999-02-22 10:33:01 +0000 | [diff] [blame] | 38 | } xmlEntity; |
| 39 | typedef xmlEntity *xmlEntityPtr; |
Daniel Veillard | 260a68f | 1998-08-13 03:39:55 +0000 | [diff] [blame] | 40 | |
| 41 | /* |
| 42 | * ALl entities are stored in a table there is one table per DTD |
| 43 | * and one extra per document. |
| 44 | */ |
| 45 | |
| 46 | #define XML_MIN_ENTITIES_TABLE 32 |
| 47 | |
| 48 | typedef struct xmlEntitiesTable { |
| 49 | int nb_entities; /* number of elements stored */ |
| 50 | int max_entities; /* maximum number of elements */ |
Daniel Veillard | be36afe | 1998-11-27 06:39:50 +0000 | [diff] [blame] | 51 | xmlEntityPtr table; /* the table of entities */ |
Daniel Veillard | 1e346af | 1999-02-22 10:33:01 +0000 | [diff] [blame] | 52 | } xmlEntitiesTable; |
| 53 | typedef xmlEntitiesTable *xmlEntitiesTablePtr; |
Daniel Veillard | 260a68f | 1998-08-13 03:39:55 +0000 | [diff] [blame] | 54 | |
Daniel Veillard | ccb0963 | 1998-10-27 06:21:04 +0000 | [diff] [blame] | 55 | |
Daniel Veillard | 260a68f | 1998-08-13 03:39:55 +0000 | [diff] [blame] | 56 | /* |
| 57 | * External functions : |
| 58 | */ |
| 59 | |
Daniel Veillard | 517752b | 1999-04-05 12:20:10 +0000 | [diff] [blame] | 60 | #include "parser.h" |
| 61 | |
Daniel Veillard | b96e643 | 1999-08-29 21:02:19 +0000 | [diff] [blame] | 62 | void xmlAddDocEntity (xmlDocPtr doc, |
Daniel Veillard | dd6b367 | 1999-09-23 22:19:22 +0000 | [diff] [blame] | 63 | const xmlChar *name, |
Daniel Veillard | b96e643 | 1999-08-29 21:02:19 +0000 | [diff] [blame] | 64 | int type, |
Daniel Veillard | dd6b367 | 1999-09-23 22:19:22 +0000 | [diff] [blame] | 65 | const xmlChar *ExternalID, |
| 66 | const xmlChar *SystemID, |
| 67 | const xmlChar *content); |
Daniel Veillard | b96e643 | 1999-08-29 21:02:19 +0000 | [diff] [blame] | 68 | void xmlAddDtdEntity (xmlDocPtr doc, |
Daniel Veillard | dd6b367 | 1999-09-23 22:19:22 +0000 | [diff] [blame] | 69 | const xmlChar *name, |
Daniel Veillard | b96e643 | 1999-08-29 21:02:19 +0000 | [diff] [blame] | 70 | int type, |
Daniel Veillard | dd6b367 | 1999-09-23 22:19:22 +0000 | [diff] [blame] | 71 | const xmlChar *ExternalID, |
| 72 | const xmlChar *SystemID, |
| 73 | const xmlChar *content); |
| 74 | xmlEntityPtr xmlGetPredefinedEntity (const xmlChar *name); |
Daniel Veillard | b96e643 | 1999-08-29 21:02:19 +0000 | [diff] [blame] | 75 | xmlEntityPtr xmlGetDocEntity (xmlDocPtr doc, |
Daniel Veillard | dd6b367 | 1999-09-23 22:19:22 +0000 | [diff] [blame] | 76 | const xmlChar *name); |
Daniel Veillard | b96e643 | 1999-08-29 21:02:19 +0000 | [diff] [blame] | 77 | xmlEntityPtr xmlGetDtdEntity (xmlDocPtr doc, |
Daniel Veillard | dd6b367 | 1999-09-23 22:19:22 +0000 | [diff] [blame] | 78 | const xmlChar *name); |
Daniel Veillard | b96e643 | 1999-08-29 21:02:19 +0000 | [diff] [blame] | 79 | xmlEntityPtr xmlGetParameterEntity (xmlDocPtr doc, |
Daniel Veillard | dd6b367 | 1999-09-23 22:19:22 +0000 | [diff] [blame] | 80 | const xmlChar *name); |
| 81 | const xmlChar * xmlEncodeEntities (xmlDocPtr doc, |
| 82 | const xmlChar *input); |
Daniel Veillard | 00fdf37 | 1999-10-08 09:40:39 +0000 | [diff] [blame] | 83 | xmlChar * xmlEncodeEntitiesReentrant(xmlDocPtr doc, |
Daniel Veillard | dd6b367 | 1999-09-23 22:19:22 +0000 | [diff] [blame] | 84 | const xmlChar *input); |
Daniel Veillard | b96e643 | 1999-08-29 21:02:19 +0000 | [diff] [blame] | 85 | xmlEntitiesTablePtr xmlCreateEntitiesTable (void); |
| 86 | xmlEntitiesTablePtr xmlCopyEntitiesTable (xmlEntitiesTablePtr table); |
| 87 | void xmlFreeEntitiesTable (xmlEntitiesTablePtr table); |
| 88 | void xmlDumpEntitiesTable (xmlBufferPtr buf, |
| 89 | xmlEntitiesTablePtr table); |
| 90 | xmlEntitiesTablePtr xmlCopyEntitiesTable (xmlEntitiesTablePtr table); |
Daniel Veillard | 260a68f | 1998-08-13 03:39:55 +0000 | [diff] [blame] | 91 | |
| 92 | #ifdef __cplusplus |
| 93 | } |
| 94 | #endif |
| 95 | |
| 96 | # endif /* __XML_ENTITIES_H__ */ |