Edit
kc3-lang/libxml2/doc/html/libxml-entities.html
Branch :
-
Show log
Commit
-
Author :
Daniel Veillard
Date : 2003-08-18 12:15:38
Hash : 2fdbd32d
Message : new dictionary module to keep a single instance of the names used by the * dict.c include/libxml/dict.h Makefile.am include/libxml/Makefile.am: new dictionary module to keep a single instance of the names used by the parser * DOCBparser.c HTMLparser.c parser.c parserInternals.c valid.c: switched all parsers to use the dictionary internally * include/libxml/HTMLparser.h include/libxml/parser.h include/libxml/parserInternals.h include/libxml/valid.h: Some of the interfaces changed as a result to receive or return "const xmlChar *" instead of "xmlChar *", this is either insignificant from an user point of view or when the returning value changed, those function are really parser internal methods that no user code should really change * doc/libxml2-api.xml doc/html/*: the API interface changed and the docs were regenerated Daniel
- doc/html/libxml-entities.html
-
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>entities</title><meta name="generator" content="DocBook XSL Stylesheets V1.58.1"><style xmlns="http://www.w3.org/TR/xhtml1/transitional" type="text/css"> .synopsis, .classsynopsis { background: #eeeeee; border: solid 1px #aaaaaa; padding: 0.5em; } .programlisting { background: #eeeeff; border: solid 1px #aaaaff; padding: 0.5em; } .variablelist { padding: 4px; margin-left: 3em; } .navigation { background: #ffeeee; border: solid 1px #ffaaaa; margin-top: 0.5em; margin-bottom: 0.5em; } .navigation a { color: #770000; } .navigation a:visited { color: #550000; } .navigation .title { font-size: 200%; } </style><link rel="home" href="index.html" title="Gnome XML Library Reference Manual"><link rel="up" href="libxml-lib.html" title="Libxml Library Reference"><link rel="previous" href="libxml-tree.html" title="tree"><link rel="next" href="libxml-valid.html" title="valid"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="libxml-tree.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></img></a></td><td><a accesskey="u" href="libxml-lib.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></img></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></img></a></td><th width="100%" align="center">Gnome XML Library Reference Manual</th><td><a accesskey="n" href="libxml-valid.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></img></a></td></tr></table><div class="refentry" lang="en"><a name="libxml-entities"></a><div class="titlepage"></div><div class="refnamediv"><h2>entities</h2><p>entities — </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis"> enum <a href="libxml-entities.html#xmlEntityType">xmlEntityType</a>; struct <a href="libxml-tree.html#xmlEntity">xmlEntity</a>; typedef <a href="libxml-entities.html#xmlEntitiesTablePtr">xmlEntitiesTablePtr</a>; void <a href="libxml-entities.html#xmlInitializePredefinedEntities">xmlInitializePredefinedEntities</a> (void); <a href="libxml-tree.html#xmlEntityPtr">xmlEntityPtr</a> <a href="libxml-entities.html#xmlAddDocEntity">xmlAddDocEntity</a> (<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name, int type, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ExternalID, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *SystemID, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *content); <a href="libxml-tree.html#xmlEntityPtr">xmlEntityPtr</a> <a href="libxml-entities.html#xmlAddDtdEntity">xmlAddDtdEntity</a> (<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name, int type, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ExternalID, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *SystemID, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *content); <a href="libxml-tree.html#xmlEntityPtr">xmlEntityPtr</a> <a href="libxml-entities.html#xmlGetPredefinedEntity">xmlGetPredefinedEntity</a> (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name); <a href="libxml-tree.html#xmlEntityPtr">xmlEntityPtr</a> <a href="libxml-entities.html#xmlGetDocEntity">xmlGetDocEntity</a> (<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name); <a href="libxml-tree.html#xmlEntityPtr">xmlEntityPtr</a> <a href="libxml-entities.html#xmlGetDtdEntity">xmlGetDtdEntity</a> (<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name); <a href="libxml-tree.html#xmlEntityPtr">xmlEntityPtr</a> <a href="libxml-entities.html#xmlGetParameterEntity">xmlGetParameterEntity</a> (<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name); const <a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-entities.html#xmlEncodeEntities">xmlEncodeEntities</a> (<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *input); <a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-entities.html#xmlEncodeEntitiesReentrant">xmlEncodeEntitiesReentrant</a> (<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *input); <a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-entities.html#xmlEncodeSpecialChars">xmlEncodeSpecialChars</a> (<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *input); <a href="libxml-entities.html#xmlEntitiesTablePtr">xmlEntitiesTablePtr</a> <a href="libxml-entities.html#xmlCreateEntitiesTable">xmlCreateEntitiesTable</a> (void); <a href="libxml-entities.html#xmlEntitiesTablePtr">xmlEntitiesTablePtr</a> <a href="libxml-entities.html#xmlCopyEntitiesTable">xmlCopyEntitiesTable</a> (<a href="libxml-entities.html#xmlEntitiesTablePtr">xmlEntitiesTablePtr</a> table); void <a href="libxml-entities.html#xmlFreeEntitiesTable">xmlFreeEntitiesTable</a> (<a href="libxml-entities.html#xmlEntitiesTablePtr">xmlEntitiesTablePtr</a> table); void <a href="libxml-entities.html#xmlDumpEntitiesTable">xmlDumpEntitiesTable</a> (<a href="libxml-tree.html#xmlBufferPtr">xmlBufferPtr</a> buf, <a href="libxml-entities.html#xmlEntitiesTablePtr">xmlEntitiesTablePtr</a> table); void <a href="libxml-entities.html#xmlDumpEntityDecl">xmlDumpEntityDecl</a> (<a href="libxml-tree.html#xmlBufferPtr">xmlBufferPtr</a> buf, <a href="libxml-tree.html#xmlEntityPtr">xmlEntityPtr</a> ent); void <a href="libxml-entities.html#xmlCleanupPredefinedEntities">xmlCleanupPredefinedEntities</a> (void); </pre></div><div class="refsect1" lang="en"><h2>Description</h2><p> </p></div><div class="refsect1" lang="en"><h2>Details</h2><div class="refsect2" lang="en"><h3><a name="xmlEntityType"></a>enum xmlEntityType</h3><pre class="programlisting">typedef enum { XML_INTERNAL_GENERAL_ENTITY = 1, XML_EXTERNAL_GENERAL_PARSED_ENTITY = 2, XML_EXTERNAL_GENERAL_UNPARSED_ENTITY = 3, XML_INTERNAL_PARAMETER_ENTITY = 4, XML_EXTERNAL_PARAMETER_ENTITY = 5, XML_INTERNAL_PREDEFINED_ENTITY = 6 } xmlEntityType; </pre><p> </p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlEntity"></a>struct xmlEntity</h3><pre class="programlisting">struct xmlEntity { void *_private; /* application data */ xmlElementType type; /* XML_ENTITY_DECL, must be second ! */ const xmlChar *name; /* Entity name */ struct _xmlNode *children; /* First child link */ struct _xmlNode *last; /* Last child link */ struct _xmlDtd *parent; /* -> DTD */ struct _xmlNode *next; /* next sibling link */ struct _xmlNode *prev; /* previous sibling link */ struct _xmlDoc *doc; /* the containing document */ xmlChar *orig; /* content without ref substitution */ xmlChar *content; /* content or ndata if unparsed */ int length; /* the content length */ xmlEntityType etype; /* The entity type */ const xmlChar *ExternalID; /* External identifier for PUBLIC */ const xmlChar *SystemID; /* URI for a SYSTEM or PUBLIC Entity */ struct _xmlEntity *nexte; /* unused */ const xmlChar *URI; /* the full URI as computed */ int owner; /* does the entity own the childrens */ }; </pre><p> </p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlEntitiesTablePtr"></a>xmlEntitiesTablePtr</h3><pre class="programlisting">typedef xmlEntitiesTable *xmlEntitiesTablePtr; </pre><p> </p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlInitializePredefinedEntities"></a>xmlInitializePredefinedEntities ()</h3><pre class="programlisting">void xmlInitializePredefinedEntities (void);</pre><p> Set up the predefined entities.</p><p> </p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlAddDocEntity"></a>xmlAddDocEntity ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlEntityPtr">xmlEntityPtr</a> xmlAddDocEntity (<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name, int type, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ExternalID, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *SystemID, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *content);</pre><p> Register a new entity for this document.</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>doc</tt></i>