From 6bd26dc2d0d57212c9aa3925a9985deca51e58af Mon Sep 17 00:00:00 2001 From: Daniel Veillard Date: Fri, 3 Sep 1999 14:28:40 +0000 Subject: [PATCH] Regenerated the documentation, Daniel. --- doc/gnome-xml.sgml | 22 +- doc/html/book1.html | 15 +- doc/html/gnome-xml-entities.html | 163 ++- doc/html/gnome-xml-htmlparser.html | 224 +++- doc/html/gnome-xml-htmltree.html | 42 +- doc/html/gnome-xml-parser.html | 995 ++++++++++---- doc/html/gnome-xml-parserinternals.html | 542 ++++---- doc/html/gnome-xml-tree.html | 1534 ++++++++++++++++++---- doc/html/gnome-xml-valid.html | 1582 +++++++++++++++++++++-- doc/html/gnome-xml-xml-error.html | 380 +++++- doc/html/gnome-xml-xpath.html | 101 +- doc/html/index.sgml | 126 +- doc/html/libxml.html | 12 +- doc/xml.html | 6 +- 14 files changed, 4589 insertions(+), 1155 deletions(-) diff --git a/doc/gnome-xml.sgml b/doc/gnome-xml.sgml index 96eb97aa..d1c21de9 100644 --- a/doc/gnome-xml.sgml +++ b/doc/gnome-xml.sgml @@ -9,6 +9,7 @@ + ]> @@ -18,16 +19,17 @@ Gnome XML Library - &parser; The parser general interfaces - &SAX; The parser SAX interfaces - &tree; Manipulation the tree generated by the parser - &entities; Routines for handling entities - &valid; All the stuff defined in DTDs - &error; Callbacks in case of parsing error - &parserInternals; Access to the parser internal routines - &HTMLparser; parsing HTML and generating a tree - &HTMLtree; printing HTML trees - &xpath; A on-going XPath implementation + &parser; + &SAX; + &tree; + &entities; + &valid; + &error; + &HTMLparser; + &HTMLtree; + &xpath; + &parserInternals; + &xmlmemory; diff --git a/doc/html/book1.html b/doc/html/book1.html index 09efeb7e..3ebd0f2c 100644 --- a/doc/html/book1.html +++ b/doc/html/book1.html @@ -80,11 +80,6 @@ HREF="gnome-xml-xml-error.html" > —
parserInternals —
HTMLparser —
xpath —
parserInternals —
xmlmemory —

Name

Synopsis

Description

Details

#define     XML_INTERNAL_GENERAL_ENTITY
#define XML_INTERNAL_GENERAL_ENTITY 1

#define     XML_EXTERNAL_GENERAL_PARSED_ENTITY
#define XML_EXTERNAL_GENERAL_PARSED_ENTITY 2

#define     XML_EXTERNAL_GENERAL_UNPARSED_ENTITY
#define XML_EXTERNAL_GENERAL_UNPARSED_ENTITY 3

#define     XML_INTERNAL_PARAMETER_ENTITY
#define XML_INTERNAL_PARAMETER_ENTITY 4

#define     XML_EXTERNAL_PARAMETER_ENTITY
#define XML_EXTERNAL_PARAMETER_ENTITY 5

#define     XML_INTERNAL_PREDEFINED_ENTITY
#define XML_INTERNAL_PREDEFINED_ENTITY 6

xmlEntityPtr

typedef xmlEntity *xmlEntityPtr;

#define     XML_MIN_ENTITIES_TABLE
#define XML_MIN_ENTITIES_TABLE 32

xmlEntitiesTablePtr

typedef xmlEntitiesTable *xmlEntitiesTablePtr;

  the document  the entity name  the entity type XML_xxx_yyy_ENTITY  the entity external ID if available  the entity system ID if available  the entity content

  the document  the entity name  the entity type XML_xxx_yyy_ENTITY  the entity external ID if available  the entity system ID if available  the entity content

  the entity name NULL if not, othervise the entity

  the document referencing the entity  the entity name A pointer to the entity structure or NULL if not found.

  the document referencing the entity  the entity name A pointer to the entity structure or NULL if not found.

  the document referencing the entity  the entity name A pointer to the entity structure or NULL if not found.

Do a global encoding of a string, replacing the predefined entities and non ASCII values with their entities and CharRef counterparts.

TODO: remove this, once we are not afraid of breaking binary compatibility

TODO: remove xmlEncodeEntities, once we are not afraid of breaking binary +compatibility

People must migrate their code to xmlEncodeEntitiesReentrant ! This routine will issue a warning when encountered.

  the document containing the string  A string to convert to XML. A newly allocated string with the substitution done.

  the document containing the string  A string to convert to XML. A newly allocated string with the substitution done.

 the xmlEntitiesTablePtr just created or NULL in case of error.

  An entity table the new xmlEntitiesTablePtr or NULL in case of error.

  An entity table

  An XML buffer.  An entity table

Name

Synopsis

Description

Details

htmlParserCtxt

typedef xmlParserCtxt htmlParserCtxt;

htmlParserCtxtPtr

typedef xmlParserCtxtPtr htmlParserCtxtPtr;

htmlParserNodeInfo

typedef xmlParserNodeInfo htmlParserNodeInfo;

htmlSAXHandler

typedef xmlSAXHandler htmlSAXHandler;

htmlSAXHandlerPtr

typedef xmlSAXHandlerPtr htmlSAXHandlerPtr;

htmlParserInput

typedef xmlParserInput htmlParserInput;

htmlParserInputPtr

typedef xmlParserInputPtr htmlParserInputPtr;

htmlDocPtr

typedef xmlDocPtr htmlDocPtr;

htmlNodePtr

typedef xmlNodePtr htmlNodePtr;

  The tag name the related htmlElemDescPtr or NULL if not found.

  the entity name the associated htmlEntityDescPtr if found, NULL otherwise.

  an HTML parser context  location to store the entity name the associated htmlEntityDescPtr if found, or NULL otherwise, +if non-NULL *str will have to be freed by the caller.

  an HTML parser context the value parsed (as an int)

  an HTML parser context

  a pointer to an array of CHAR  a free form C string describing the HTML document encoding, or NULL  the SAX handler block  if using SAX, this pointer will be provided on callbacks.  the resulting document tree

  a pointer to an array of CHAR  a free form C string describing the HTML document encoding, or NULL the resulting document tree

  the filename  a free form C string describing the HTML document encoding, or NULL  the SAX handler block  if using SAX, this pointer will be provided on callbacks.  the resulting document tree

  the filename  a free form C string describing the HTML document encoding, or NULL the resulting document tree

parserInternalsxml-error

Name

Synopsis

Description

Details

#define     HTML_TEXT_NODE
#define HTML_TEXT_NODE XML_TEXT_NODE

#define     HTML_ENTITY_REF_NODE
#define HTML_ENTITY_REF_NODE XML_ENTITY_REF_NODE

#define     HTML_COMMENT_NODE
#define HTML_COMMENT_NODE XML_COMMENT_NODE

  the document  OUT: the memory pointer  OUT: the memory lenght

  the FILE*  the document

  the filename  the document  the number of byte written or -1 in case of failure.

xmlParserInputPtr; +xmlParserInputPtr (*xmlExternalEntityLoader) + (const char *URL, + const char *ID, + xmlParserInputPtr context); typedef xmlParserNodeInfohtmlDefaultSAXHandler; +extern int xmlSubstituteEntitiesDefaultValue; int xmlParserInputReadCHAR *buffer, const char *filename); +void xmlDefaultSAXHandlerInit (void); +void htmlDefaultSAXHandlerInit (void); const xmlParserNodeInfoxmlParserNodeInfo *info); void xmlDefaultSAXHandlerInit (void); -void htmlDefaultSAXHandlerInit (void);xmlSetExternalEntityLoader (xmlExternalEntityLoader f); +xmlExternalEntityLoader xmlGetExternalEntityLoader + (void); +xmlParserInputPtr xmlLoadExternalEntity (const char *URL, + const char *ID, + xmlParserInputPtr context);

Description

Details

#define     XML_DEFAULT_VERSION
#define XML_DEFAULT_VERSION "1.0"

xmlParserInputPtr

xmlParserNodeInfo

xmlParserNodeInfoSeq

xmlParserNodeInfoSeqPtr

typedef xmlParserInput *xmlParserInputPtr;

xmlExternalEntityLoader ()

xmlParserInputPtr (*xmlExternalEntityLoader)
+                                            (const char *URL,
+                                             const char *ID,
+                                             xmlParserInputPtr context);

URL : 
ID : 
context : 
Returns : 

xmlParserNodeInfo

typedef _xmlParserNodeInfo xmlParserNodeInfo;

xmlParserNodeInfoSeq

typedef _xmlParserNodeInfoSeq xmlParserNodeInfoSeq;

xmlParserNodeInfoSeqPtr

typedef xmlParserNodeInfoSeq *xmlParserNodeInfoSeqPtr;

enum xmlParserInputState

xmlParserCtxt

typedef _xmlParserCtxt xmlParserCtxt;

xmlParserCtxtPtr

typedef xmlParserCtxt *xmlParserCtxtPtr;

xmlSAXLocator

typedef _xmlSAXLocator xmlSAXLocator;

xmlSAXLocatorPtr

typedef xmlSAXLocator *xmlSAXLocatorPtr;

xmlSAXHandlerPtr

typedef xmlSAXHandler *xmlSAXHandlerPtr;

xmlSubstituteEntitiesDefaultValue

extern int xmlSubstituteEntitiesDefaultValue;

  an XML parser input  an indicative size for the lookahead the number of CHARs read, or -1 in case of error, 0 indicate the +end of this entity

  an XML parser input  an indicative size for the lookahead the number of CHARs read, or -1 in case of error, 0 indicate the +end of this entity

  the input CHAR * a new CHAR * or NULL

  the input CHAR *  the len of cur a new CHAR * or NULL

  the CHAR * array (haystack)  the index of the first char (zero based)  the length of the substring the CHAR * for the first occurence or NULL.

  the CHAR * array  the CHAR to search the CHAR * for the first occurence or NULL.

  the CHAR * array (haystack)  the CHAR to search (needle) the CHAR * for the first occurence or NULL.

  the first CHAR *  the second CHAR * the integer result of the comparison

  the first CHAR *  the second CHAR *  the max comparison length the integer result of the comparison

  the CHAR * array the number of CHAR contained in the ARRAY.

  the original CHAR * array  the CHAR * array added a new CHAR * containing the concatenated string.

  the original CHAR * array  the CHAR * array added  the length of add a new CHAR * containing the concatenated string.

  a pointer to an array of CHAR the resulting document tree

  an pointer to a char array  the size of the array the resulting document tree

  the filename the resulting document tree

  int 0 or 1  the last value for 0 for no substitution, 1 for substitution.

  a pointer to an array of CHAR the resulting document tree

  an pointer to a char array  the size of the array the resulting document tree

  the filename the resulting document tree

  an XML parser context 0, -1 in case of error. the parser context is augmented +as a result of the parsing.

  the SAX handler block  a pointer to an array of CHAR  work in recovery mode, i.e. tries to read no Well Formed +documents the resulting document tree

  the SAX handler block  an pointer to a char array  the siwe of the array  work in recovery mode, i.e. tries to read no Well Formed +documents the resulting document tree

  the SAX handler block  the filename  work in recovery mode, i.e. tries to read no Well Formed +documents the resulting document tree

  a NAME* containing the External ID of the DTD  a NAME* containing the URL to the DTD the resulting xmlDtdPtr or NULL in case of error.

  the SAX handler block  a NAME* containing the External ID of the DTD  a NAME* containing the URL to the DTD the resulting xmlDtdPtr or NULL in case of error.

  an HTML parser context

  an XML parser context

  an XML parser context  a CHAR * buffer  a file name

xmlDefaultSAXHandlerInit ()

void        xmlDefaultSAXHandlerInit        (void);

Initialize the default SAX handler

htmlDefaultSAXHandlerInit ()

void        htmlDefaultSAXHandlerInit       (void);

Initialize the default SAX handler

  an XML parser context  an XML node within the tree an xmlParserNodeInfo block pointer or NULL

  a node info sequence pointer

  a node info sequence pointer

  a node info sequence pointer  an XML node pointer a long indicating the position of the record

  an XML parser context a node info sequence pointer

xmlSetExternalEntityLoader ()

void        xmlSetExternalEntityLoader      (xmlExternalEntityLoader f);

f : 

xmlDefaultSAXHandlerInit ()

xmlGetExternalEntityLoader ()

void        xmlDefaultSAXHandlerInit        (void);
xmlExternalEntityLoader xmlGetExternalEntityLoader + (void);

Initialize the default SAX handler

Returns : 

htmlDefaultSAXHandlerInit ()

xmlLoadExternalEntity ()

void        htmlDefaultSAXHandlerInit       (void);
xmlParserInputPtr xmlLoadExternalEntity (const char *URL, + const char *ID, + xmlParserInputPtr context);

Initialize the default SAX handler

URL : 
ID : 
context : 
Returns : 

Name

Synopsis

+#define XML_MAX_NAMELEN typedef CHARVAL

Description

Details

XML_MAX_NAMELEN

#define XML_MAX_NAMELEN 1000

#define     SKIPCHARVAL(p)
#define SKIPCHARVAL(p) (p)++;

  a pointer to an array of CHAR the new parser context or NULL

  the filename the new parser context or NULL

  an pointer to a char array  the siwe of the array the new parser context or NULL

  an XML parser context

 the xmlParserCtxtPtr or NULL

  the parser context

  an XML parser context  an XML entity pointer.

  an XML parser context  an Entity pointer the new input stream or NULL

  an XML parser context  an XML parser input fragment (entity, XML fragment ...).

  an XML parser context the current CHAR in the parser context

  an xmlP arserInputPtr

  an XML parser context  the filename to use as entity the new input stream or NULL in case of error

  an XML parser context  a CHAR **  the function returns the local part, and prefix is updated +to get the Prefix if any.

  an XML parser context the namespace name or NULL

  an XML parser context  a CHAR **  the function returns the local part, and prefix is updated +to get the Prefix if any.

  an XML parser context the namespace name

  an XML parser context the string parser or NULL.

  an XML parser context

  an XML parser context the Name parsed or NULL

  an XML parser context the Name parsed or NULL

  an XML parser context the Nmtoken parsed or NULL

  an XML parser context  if non-NULL store a copy of the original entity value the EntityValue parsed with reference substitued or NULL

parse a value for an attribute Note: the parser won't do substitution of entities here, this -will be handled later in xmlStringGetNodeList, unless it was -asked for ctxt->replaceEntities != 0

[10] AttValue ::= '"' ([^<&"] | Reference)* '"' | "'" ([^<&'] | Reference)* "'"

  an XML parser context the AttValue parsed or NULL.

  an XML parser context the SystemLiteral parsed or NULL

  an XML parser context the PubidLiteral parsed or NULL.

  an XML parser context  int indicating whether we are within a CDATA section

  an XML parser context  a CHAR** receiving PubidLiteral  indicate whether we should restrict parsing to only +production [75], see NOTE below the function returns SystemLiteral and in the second +case publicID receives PubidLiteral, is strict is off +it is possible to return NULL and have publicID set.

Skip an XML (SGML) comment <!-- .... --> -This may or may not create a node (depending on the context) The spec says that "For compatibility, the string "--" (double-hyphen) must not occur within comments. "

  an XML parser context

  an XML parser context the PITarget name or NULL

  an XML parser context

  an XML parser context

[76] NDataDecl ::= S 'NDATA' S Name

[ VC: Notation Declared ] -TODO The Name must match the declared name of a notation.

  an XML parser context

' S)? AttValue)

[ VC: Required Attribute ] -TODO if the default declaration is the keyword REQUIRED, then the @@ -4507,7 +4540,7 @@ HREF="gnome-xml-valid.html#XMLVALIDATEATTRIBUTEDECL" >()

[ VC: Fixed Attribute Default ] -TODO if an attribute has a default value declared with the FIXED @@ -4546,7 +4579,7 @@ CLASS="PARAMETER" WIDTH="80%" ALIGN="LEFT" VALIGN="TOP" ->  an XML parser context  Receive a possible fixed default value for the attribute  XML_ATTRIBUTE_NONE, XML_ATTRIBUTE_REQUIRED, XML_ATTRIBUTE_IMPLIED +or XML_ATTRIBUTE_FIXED.

[58] NotationType ::= 'NOTATION' S '(' S? Name (S? '|' S? Name)* S? ')'

[ VC: Notation Attributes ] -TODO Values of this type must match one of the notation names included +Values of this type must match one of the notation names included in the declaration; all notation names in the declaration must be declared.

  an XML parser context  the notation attribute tree built while parsing

[59] Enumeration ::= '(' S? Nmtoken (S? '|' S? Nmtoken)* S? ')'

[ VC: Enumeration ] -TODO Values of this type must match one of the Nmtoken tokens in +Values of this type must match one of the Nmtoken tokens in the declaration

  an XML parser context  the enumeration attribute tree built while parsing

  an XML parser context  the enumeration tree built while parsing  XML_ATTRIBUTE_ENUMERATION or XML_ATTRIBUTE_NOTATION

Validity constraints for attribute values syntax are checked in -xmlValidateAttributeValuexmlValidateAttributeValue()

[ VC: ID ] -Values of type ID must match the Name production. TODO A name must not +Values of type ID must match the Name production. A name must not appear more than once in an XML document as a value of this type; i.e., ID values must uniquely identify the elements which bear them.

[ VC: One ID per Element Type ] -TODO No element type may have more than one ID attribute specified.

[ VC: ID Attribute Default ] -TODO An ID attribute must have a declared default of IMPLIED or

[ VC: IDREF ] Values of type IDREF must match the Name production, and values -of type IDREFS must match Names; TODO each Name must match the value of -an ID attribute on some element in the XML document; i.e. IDREF +of type IDREFS must match Names; TODO each IDREF Name must match the value +of an ID attribute on some element in the XML document; i.e. IDREF values must match the value of some ID attribute.

[ VC: Entity Name ] Values of type ENTITY must match the Name production, values -of type ENTITIES must match Names; TODO each Name must match the name of -an unparsed entity declared in the DTD.

[ VC: Name Token ] Values of type NMTOKEN must match the Nmtoken production; values @@ -4969,7 +5003,7 @@ CLASS="PARAMETER" WIDTH="80%" ALIGN="LEFT" VALIGN="TOP" ->  an XML parser context  the enumeration tree built while parsing the attribute type

  an XML parser context

[ VC: Proper Group/PE Nesting ] applies to [51] too (see [49])

[ VC: No Duplicate Types ] -TODO The same name must not appear more than once in a single +The same name must not appear more than once in a single mixed-content declaration.

  an XML parser context  the list of the xmlElementContentPtr describing the element choices

  an XML parser context  the tree of xmlElementContentPtr describing the element +hierarchy.

  an XML parser context  the name of the element being defined.  the Element Content pointer will be stored here if any  the type of element content XML_ELEMENT_TYPE_xxx

[45] elementdecl ::= '<!ELEMENT' S Name S contentspec S? '>'

[ VC: Unique Element Type Declaration ] -TODO No element type may be declared more than once

  an XML parser context the type of the element, or -1 in case of error

  an XML parser context

  an XML parser context the value parsed (as an int)

  an XML parser context the xmlEntityPtr if found, or NULL otherwise.

  an XML parser context

  an XML parser context

  an XML parser context

[ VC: Attribute Value Type ] -TODO The attribute must have been declared; the value must be of the type +The attribute must have been declared; the value must be of the type declared for it.

[25] Eq ::= S? '=' S?

  an XML parser context  a CHAR ** used to store the value of the attribute the attribute name, and the value in *value.

  an XML parser context the element name parsed

  an XML parser context  the tag name as parsed in the opening tag.

  an XML parser context

  an XML parser context

[ VC: Element Valid ] -TODO An element is valid if there is a declaration matching elementdecl +An element is valid if there is a declaration matching elementdecl where the Name matches the element type and one of the following holds: - The declaration matches EMPTY and the element has no content. - The declaration matches children and the sequence of child elements @@ -6505,7 +6540,7 @@ CLASS="PARAMETER" WIDTH="80%" ALIGN="LEFT" VALIGN="TOP" ->  an XML parser context

  an XML parser context the string giving the XML version number, or NULL

  an XML parser context the version string, e.g. "1.0"

  an XML parser context the encoding name value or NULL

  an XML parser context the encoding value or NULL

  an XML parser context 1 if standalone, 0 otherwise

  an XML parser context

  an XML parser context

[31] extSubsetDecl ::= (markupdecl | conditionalSect | PEReference | S) *

TODO There is a check [ VC: Proper Declaration/PE Nesting ]

  an XML parser context

#define     XML_SUBSTITUTE_NONE
#define XML_SUBSTITUTE_NONE 0

#define     XML_SUBSTITUTE_REF
#define XML_SUBSTITUTE_REF 1

#define     XML_SUBSTITUTE_PEREF
#define XML_SUBSTITUTE_PEREF 2

#define     XML_SUBSTITUTE_BOTH
#define XML_SUBSTITUTE_BOTH 3

  the parser context  the len to decode (in bytes !), -1 for no size limit  combination of XML_SUBSTITUTE_REF and XML_SUBSTITUTE_PEREF  an end marker CHAR, 0 if none  an end marker CHAR, 0 if none  an end marker CHAR, 0 if none A newly allocated string with the substitution done. The caller +must deallocate it !

xml-errorxpathHTMLparserxmlmemory

Name

Synopsis

CHAR; +#define BAD_CAST typedef xmlNotationPtrxmlAttrPtr; typedef xmlIDPtr; +typedef xmlNode; @@ -456,6 +464,28 @@ HREF="gnome-xml-tree.html#CHAR" HREF="gnome-xml-tree.html#CHAR" >CHAR *value); +xmlAttrPtr xmlNewNsProp (xmlNodePtr node, + xmlNsPtr ns, + const CHAR *name, + const CHAR *value); void xmlFreePropListxmlNodePtr xmlNewPI (const CHAR *name, + const CHAR *content); +xmlNodePtr xmlNewDocTextLen (xmlNodePtr cur); +xmlNodePtr xmlAddSibling (xmlNodePtr cur, + xmlNodePtr elem); void xmlUnlinkNodeCHAR *href); +xmlNsPtr* xmlGetNsList (xmlDocPtr doc, + xmlNodePtr node); void xmlSetNsxmlNodePtr cur); +const CHAR* xmlNodeGetLang (xmlNodePtr cur); +void xmlNodeSetLang (xmlNodePtr cur, + const CHAR *lang); void xmlBufferWriteCHAR

Description

Details

xmlNotationPtr

BAD_CAST

#define BAD_CAST (CHAR *)

xmlNotationPtr

typedef xmlNotation *xmlNotationPtr;

xmlEnumerationPtr

typedef xmlEnumeration *xmlEnumerationPtr;

xmlAttributePtr

typedef xmlAttribute *xmlAttributePtr;

xmlElementContentPtr

typedef xmlElementContent *xmlElementContentPtr;

xmlElementPtr

typedef xmlElement *xmlElementPtr;

xmlNsPtr

typedef xmlNs *xmlNsPtr;

xmlDtdPtr

typedef xmlDtd *xmlDtdPtr;

xmlAttrPtr

typedef xmlAttr *xmlAttrPtr;

xmlIDPtr

typedef xmlID *xmlIDPtr;

xmlNode

typedef _xmlNode xmlNode;

xmlNodePtr

typedef _xmlNode *xmlNodePtr;

xmlDoc

typedef _xmlDoc xmlDoc;

xmlDocPtr

typedef xmlDoc *xmlDocPtr;

xmlBuffer

typedef _xmlBuffer xmlBuffer;

xmlBufferPtr

typedef xmlBuffer *xmlBufferPtr;

 the new structure.

  the buffer to free

  the file output  the buffer to dump the number of CHAR written

  the buffer to dump  the CHAR string  the number of CHAR to add

  the buffer to dump  the CHAR string

  the buffer to dump  the C char string

  the buffer to dump  the number of CHAR to remove the number of CHAR removed, or -1 in case of failure.

  the buffer

  the document pointer  the DTD name  the external ID  the system ID a pointer to the new DTD structure

  the document pointer  the DTD name  the external ID  the system ID a pointer to the new DTD structure

  the DTD structure to free up

  the document carrying the namespace  the URI associated  the prefix for the namespace returns a new namespace pointer

  the element carrying the namespace  the URI associated  the prefix for the namespace returns a new namespace pointer

  the namespace pointer

  CHAR string giving the version of XML "1.0" a new document

  pointer to the document +@:

  the document  the name of the attribute  the value of the attribute a pointer to the attribute

  the holding node  the name of the attribute  the value of the attribute a pointer to the attribute

xmlNewNsProp ()

xmlAttrPtr  xmlNewNsProp                    (xmlNodePtr node,
+                                             xmlNsPtr ns,
+                                             const CHAR *name,
+                                             const CHAR *value);

Create a new property tagged with a namespace and carried by a node.

node : the holding node
ns : the namespace
name : the name of the attribute
value : the value of the attribute
Returns :a pointer to the attribute

  the first property in the list

  the first property in the list

  the element where the attribute will be grafted  the attribute  a new xmlAttrPtr, or NULL in case of error.

  the element where the attributes will be grafted  the first attribute  a new xmlAttrPtr, or NULL in case of error.

  the dtd  a new xmlDtdPtr, or NULL in case of error.

  the document  if 1 do a recursive copy.  a new xmlDocPtr, or NULL in case of error.

  the document  namespace if any  the node name  the text content if any a pointer to the new node object.

  namespace if any  the node name a pointer to the new node object.

  the parent node  a namespace if any  the name of the child  the content of the child if any. a pointer to the new node object.

  the document  the text content a pointer to the new node object.

  the text content a pointer to the new node object.

xmlNewPI ()

xmlNodePtr  xmlNewPI                        (const CHAR *name,
+                                             const CHAR *content);

Creation of a processing instruction element.

name : the processing instruction name
content : the PI content
Returns :a pointer to the new node object.

  the document  the text content  the text len. a pointer to the new node object.

  the text content  the text len. a pointer to the new node object.

  the document  the comment content a pointer to the new node object.

  the comment content a pointer to the new node object.

  the document  the CData block content content  the length of the block a pointer to the new node object.

  the document  the reference name, or the reference string with & and ; a pointer to the new node object.

  the node  if 1 do a recursive copy.  a new xmlNodePtr, or NULL in case of error.

  the first node in the list.  a new xmlNodePtr, or NULL in case of error.

  the parent node the last child or NULL if none.

  the node 1 yes, 0 no

  the parent node  the child node the child or NULL in case of error.

xmlAddSibling ()

xmlNodePtr  xmlAddSibling                   (xmlNodePtr cur,
+                                             xmlNodePtr elem);

Add a new element to the list of siblings of cur

cur : the child node
elem : the new node
Returns :the element or NULL in case of error.

  the node

  the first text node  the second text node being merged the first text node augmented

  the node  the content  content lenght

  the first node in the list

  the node

  the document  the current node  the namespace string the namespace pointer or NULL.

  the document  the current node  the namespace value the namespace pointer or NULL.

xmlGetNsList ()

xmlNsPtr*   xmlGetNsList                    (xmlDocPtr doc,
+                                             xmlNodePtr node);

Search all the namespace applying to a given element.

doc : the document
node : the current node
Returns :an NULL terminated array of all the xmlNsPtr found +that need to be freed by the caller or NULL if no +namespace if defined

  a node in the document  a namespace pointer

  the namespace  a new xmlNsPtr, or NULL in case of error.

  the first namespace  a new xmlNsPtr, or NULL in case of error.

  the node  the attribute name  the attribute value the attribute pointer.

  the node  the attribute name the attribute value or NULL if not found.

  the document  the value of the attribute a pointer to the first child

  the document  the value of the text  the length of the string value a pointer to the first child

  the document  a Node list  should we replace entity contents or show their external form a pointer to the string copy, the calller must free it.

  the node being modified  the new value of the content

  the node being modified  the new value of the content  the size of content

  the node being modified  extra content

  the node being modified  extra content  the size of content

  the node being read a new CHAR * or NULL if no content is available. +It's up to the caller to free the memory.

xmlNodeGetLang ()

const CHAR* xmlNodeGetLang                  (xmlNodePtr cur);

Searches the language of a node, i.e. the values of the xml:lang +attribute or the one carried by the nearest ancestor.

cur : the node being checked
Returns :a pointer to the lang value, or NULL if not found

xmlNodeSetLang ()

void        xmlNodeSetLang                  (xmlNodePtr cur,
+                                             const CHAR *lang);

Searches the language of a node, i.e. the values of the xml:lang +attribute or the one carried by the nearest ancestor.

cur : the node being changed
lang : the langage description

  the XML buffer  the string to add

  the XML buffer output  the string to add

  the XML buffer output  the string to add

  the document  OUT: the memory pointer  OUT: the memory lenght

  the FILE*  the document

  the filename  the document  the number of file written or -1 in case of failure.

  the document 0 (uncompressed) to 9 (max compression)

  the document  the compression ratio

 0 (uncompressed) to 9 (max compression)

  the compression ratio

Name

Synopsis

xmlAttributeTablePtr; +#define XML_MIN_ID_TABLE +typedef xmlIDTablePtr; xmlNotationPtrxmlAttributeTablePtr table); +xmlIDPtr xmlAddID (xmlValidCtxtPtr ctxt, + xmlDocPtr doc, + const CHAR *value, + xmlAttrPtr attr); +xmlIDTablePtr xmlCopyIDTable (xmlIDTablePtr table); +void xmlFreeIDTable (xmlIDTablePtr table); +xmlAttrPtr xmlGetID (xmlDocPtr doc, + const CHAR *ID); +int xmlIsID (xmlDocPtr doc, + xmlNodePtr elem, + xmlAttrPtr attr); int xmlValidateRootxmlAttributePtr attr); int xmlValidateAttributeValue (xmlAttributeType type, + const CHAR *value); +int xmlValidateNotationDecl (CHAR *value); int xmlValidateNotationUse (xmlValidCtxtPtr ctxt, + xmlDocPtr doc, + const CHAR *notationName); +int xmlIsMixedElement (CHAR *name); +xmlAttributePtr xmlGetDtdAttrDesc (xmlDtdPtr dtd, + const CHAR *elem, + const CHAR *name); +xmlNotationPtr xmlGetDtdNotationDesc (xmlDtdPtr dtd, + const CHAR *name); +xmlElementPtr xmlGetDtdElementDesc (xmlDtdPtr dtd, + const CHAR *name);

Description

Details

  an XML parser context  the message to display/transmit  extra parameters for the message display

  an XML parser context  the message to display/transmit  extra parameters for the message display

#define     XML_MIN_NOTATION_TABLE
#define XML_MIN_NOTATION_TABLE 32

xmlNotationTablePtr

typedef xmlNotationTable *xmlNotationTablePtr;

#define     XML_MIN_ELEMENT_TABLE
#define XML_MIN_ELEMENT_TABLE 32

xmlElementTablePtr

typedef xmlElementTable *xmlElementTablePtr;

#define     XML_MIN_ATTRIBUTE_TABLE
#define XML_MIN_ATTRIBUTE_TABLE 32

xmlAttributeTablePtr

typedef xmlAttributeTable *xmlAttributeTablePtr;

XML_MIN_ID_TABLE

#define XML_MIN_ID_TABLE	32

xmlIDTablePtr

typedef xmlIDTable *xmlIDTablePtr;

  the validation context  pointer to the DTD  the entity name  the public identifier or NULL  the system identifier or NULL NULL if not, othervise the entity

  A notation table the new xmlNotationTablePtr or NULL in case of error.

  An notation table

  the XML buffer output  A notation table

  the subelement name or NULL  the type of element content decl NULL if not, othervise the new element content structure

  An element content pointer. the new xmlElementContentPtr or NULL in case of error.

  the element content tree to free

  pointer to the DTD  the entity name  the element type  the element content tree or NULL NULL if not, othervise the entity

  An element table the new xmlElementTablePtr or NULL in case of error.

  An element table

  the XML buffer output  An element table

  the enumeration name or NULL the xmlEnumerationPtr just created or NULL in case +of error.

  the tree to free.

  the tree to copy. the xmlEnumerationPtr just created or NULL in case +of error.

  the validation context  pointer to the DTD  the element name  the attribute name  the attribute type  the attribute default type  the attribute default value  if it's an enumeration, the associated list NULL if not, othervise the entity

  An attribute table the new xmlAttributeTablePtr or NULL in case of error.

  An attribute table

  the XML buffer output An attribute table

xmlAddID ()

xmlIDPtr    xmlAddID                        (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             const CHAR *value,
+                                             xmlAttrPtr attr);

Register a new id declaration

ctxt : the validation context
doc : pointer to the document
value : the value name
attr : the attribute holding the ID
Returns :NULL if not, othervise the new xmlIDPtr

xmlCopyIDTable ()

xmlIDTablePtr xmlCopyIDTable                (xmlIDTablePtr table);

table : 
Returns : 

xmlFreeIDTable ()

void        xmlFreeIDTable                  (xmlIDTablePtr table);

Deallocate the memory used by an ID hash table.

table : An id table

xmlGetID ()

xmlAttrPtr  xmlGetID                        (xmlDocPtr doc,
+                                             const CHAR *ID);

Search the attribute declaring the given ID

doc : pointer to the document
ID : the ID value
Returns :NULL if not found, otherwise the xmlAttrPtr defining the ID

xmlIsID ()

int         xmlIsID                         (xmlDocPtr doc,
+                                             xmlNodePtr elem,
+                                             xmlAttrPtr attr);

Determine whether an attribute is of type ID. In case we have Dtd(s) +then this is simple, otherwise we use an heuristic: name ID (upper +or lowercase).

doc : the document
elem : the element carrying the attribute
attr : the attribute
Returns :0 or 1 depending on the lookup result

  the validation context  a document instance 1 if valid or 0 otherwise

  the validation context  a document instance  an element definition 1 if valid or 0 otherwise

  the validation context  a document instance  an attribute definition 1 if valid or 0 otherwise

xmlValidateAttributeValue ()

int         xmlValidateAttributeValue       (xmlAttributeType type,
+                                             const CHAR *value);

Validate that the given attribute value match the proper production

[ VC: ID ] +Values of type ID must match the Name production....

[ VC: IDREF ] +Values of type IDREF must match the Name production, and values +of type IDREFS must match Names ...

[ VC: Entity Name ] +Values of type ENTITY must match the Name production, values +of type ENTITIES must match Names ...

[ VC: Name Token ] +Values of type NMTOKEN must match the Nmtoken production; values +of type NMTOKENS must match Nmtokens.

type : an attribute type
value : an attribute value
Returns :1 if valid or 0 otherwise

  the validation context  a document instance  a notation definition 1 if valid or 0 otherwise

  the validation context  a document instance  a dtd instance 1 if valid or 0 otherwise

  the validation context  a document instance 1 if valid or 0 otherwise

  the validation context  a document instance  an element instance 1 if valid or 0 otherwise

  the validation context  a document instance  an element instance 1 if valid or 0 otherwise

  the validation context  a document instance  an element instance  an attribute instance 1 if valid or 0 otherwise

xmlValidateNotationUse ()

int         xmlValidateNotationUse          (xmlValidCtxtPtr ctxt,
+                                             xmlDocPtr doc,
+                                             const CHAR *notationName);

Validate that the given mame match a notation declaration. +- [ VC: Notation Declared ]

ctxt : the validation context
doc : the document
notationName : the notation name to check
Returns :1 if valid or 0 otherwise

xmlGetDtdAttrDesc ()

xmlAttributePtr xmlGetDtdAttrDesc           (xmlDtdPtr dtd,
+                                             const CHAR *elem,
+                                             const CHAR *name);

Search the Dtd for the description of this attribute on +this element.

dtd : a pointer to the DtD to search
elem : the element name
name : the attribute name
Returns :the xmlAttributePtr if found or NULL

xmlGetDtdNotationDesc ()

xmlNotationPtr xmlGetDtdNotationDesc        (xmlDtdPtr dtd,
+                                             const CHAR *name);

Search the Dtd for the description of this notation

dtd : a pointer to the DtD to search
name : the notation name
Returns :the xmlNotationPtr if found or NULL

xmlGetDtdElementDesc ()

xmlElementPtr xmlGetDtdElementDesc          (xmlDtdPtr dtd,
+                                             const CHAR *name);

Search the Dtd for the description of this element

dtd : a pointer to the DtD to search
name : the element name
Returns :the xmlElementPtr if found or NULL

Name

Synopsis

xmlParserWarning (void *ctx, const char *msg, - ...);xmlParserValidityError (void *ctx, + const char *msg, + ...); +void xmlParserValidityWarning (void *ctx, + const char *msg, + ...); +void xmlParserPrintFileInfo (xmlParserInputPtr input); +void xmlParserPrintFileContext (xmlParserInputPtr input);

Description

Details

an XML parser contextmsg : the message to display/transmit... : extra parameters for the message display

xmlParserWarning ()

void        xmlParserWarning                (void *ctx,
+                                             const char *msg,
+                                             ...);

Display and format a warning messages, gives file, line, position and +extra parameters.

ctx : an XML parser context
msg : the message to display/transmit
... : extra parameters for the message display

xmlParserValidityError ()

void        xmlParserValidityError          (void *ctx,
+                                             const char *msg,
+                                             ...);

Display and format an validity error messages, gives file, +line, position and extra parameters.

xmlParserWarning ()

xmlParserValidityWarning ()
ctx : 
void        xmlParserWarning                (void *ctx,
+>void        xmlParserValidityWarning        (void *ctx,
                                              const char *msg,
                                              ...);

Display and format a warning messages, gives file, line, position and -extra parameters.

Display and format a validity warning messages, gives file, line, +position and extra parameters.

xmlParserPrintFileInfo ()

void        xmlParserPrintFileInfo          (xmlParserInputPtr input);

Displays the associated file and line informations for the current input

input : an xmlParserInputPtr input

xmlParserPrintFileContext ()

void        xmlParserPrintFileContext       (xmlParserInputPtr input);

Displays current context within the input content for error tracking

input : an xmlParserInputPtr input

parserInternalsHTMLparser Next Page >>>

Name

Synopsis

Description

Details

#define     XPATH_UNDEFINED
#define XPATH_UNDEFINED 0

#define     XPATH_NODESET
#define XPATH_NODESET 1

#define     XPATH_BOOLEAN
#define XPATH_BOOLEAN 2

#define     XPATH_NUMBER
#define XPATH_NUMBER 3

#define     XPATH_STRING
#define XPATH_STRING 4

  the XML document  the variable list  the function list the xmlXPathContext just allocated.

  the context to free

  the XPath expression  the XPath context the xmlXPathObjectPtr resulting from the eveluation or NULL. +the caller has to free the object.

  the object to free

  the XPath expression  the XPath context the xmlXPathObjectPtr resulting from the evaluation or NULL. +the caller has to free the object.

 Next Page >>> parserInternals

+ @@ -42,6 +43,7 @@ + @@ -70,16 +72,20 @@ + + - - + + + + @@ -94,6 +100,7 @@ + @@ -121,6 +128,7 @@ + @@ -132,6 +140,7 @@ + @@ -143,6 +152,7 @@ + @@ -150,6 +160,7 @@ + @@ -163,6 +174,8 @@ + + @@ -206,6 +219,8 @@ + + @@ -224,20 +239,73 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -324,41 +392,19 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + diff --git a/doc/html/libxml.html b/doc/html/libxml.html index c12cb2fe..d314a304 100644 --- a/doc/html/libxml.html +++ b/doc/html/libxml.html @@ -105,17 +105,7 @@ CLASS="CHAPTER" NAME="LIBXML" >Gnome XML Library

The parser general interfaces - The parser SAX interfaces - Manipulation the tree generated by the parser - Routines for handling entities - All the stuff defined in DTDs - Callbacks in case of parsing error - Access to the parser internal routines - parsing HTML and generating a tree - printing HTML trees - A on-going XPath implementation -



extensive documentation to be automatically extracted.

There is also a mailing-list xml@rufus.w3.org for libxml, with an xml@rufus.w3.org for libxml, with an on-line archive. To subscribe to this majordomo based list, send a mail to majordomo@rufus.w3.org with "subscribe xml" -in the content of the message.

+href="mailto:majordomo@rufus.w3.org">majordomo@rufus.w3.org with +"subscribe xml" in the content of the message.

This library is released both under the W3C Copyright and the GNU LGP, basically everybody should be happy, if not, drop me a mail.