tree.h

Introduction

Typedefs

typedef struct _xmlAttr xmlAttr;  

Discussion

xmlAttr:

An attribute on an XML node.

typedef struct _xmlAttribute xmlAttribute;  

Discussion

xmlAttribute:

An Attribute declaration in a DTD.

typedef enum { 
    XML_ATTRIBUTE_NONE = 1, 
    XML_ATTRIBUTE_REQUIRED, 
    XML_ATTRIBUTE_IMPLIED, 
    XML_ATTRIBUTE_FIXED 
} xmlAttributeDefault;  

Discussion

xmlAttributeDefault:

A DTD Attribute default definition.

typedef enum { 
    XML_ATTRIBUTE_CDATA = 1, 
    XML_ATTRIBUTE_ID, 
    XML_ATTRIBUTE_IDREF, 
    XML_ATTRIBUTE_IDREFS, 
    XML_ATTRIBUTE_ENTITY, 
    XML_ATTRIBUTE_ENTITIES, 
    XML_ATTRIBUTE_NMTOKEN, 
    XML_ATTRIBUTE_NMTOKENS, 
    XML_ATTRIBUTE_ENUMERATION, 
    XML_ATTRIBUTE_NOTATION 
} xmlAttributeType;  

Discussion

xmlAttributeType:

A DTD Attribute type definition.

typedef struct _xmlBuffer xmlBuffer;  

Discussion

xmlBuffer:

A buffer structure.

typedef enum { 
    XML_BUFFER_ALLOC_DOUBLEIT, 
    XML_BUFFER_ALLOC_EXACT, 
    XML_BUFFER_ALLOC_IMMUTABLE 
} xmlBufferAllocationScheme;  

Discussion

xmlBufferAllocationScheme:

A buffer allocation scheme can be defined to either match exactly the need or double it's allocated size each time it is found too small.

typedef struct _xmlDoc xmlDoc;  

Discussion

xmlDoc:

An XML document.

typedef struct _xmlDtd xmlDtd;  

Discussion

xmlDtd:

An XML DTD, as defined by

typedef struct _xmlElement xmlElement;  

Discussion

xmlElement:

An XML Element declaration from a DTD.

typedef struct _xmlElementContent xmlElementContent;  

Discussion

xmlElementContent:

An XML Element content as stored after parsing an element definition in a DTD.

typedef enum { 
    XML_ELEMENT_CONTENT_ONCE = 1, 
    XML_ELEMENT_CONTENT_OPT, 
    XML_ELEMENT_CONTENT_MULT, 
    XML_ELEMENT_CONTENT_PLUS 
} xmlElementContentOccur;  

Discussion

xmlElementContentOccur:

Possible definitions of element content occurrences.

typedef enum { 
    XML_ELEMENT_CONTENT_PCDATA = 1, 
    XML_ELEMENT_CONTENT_ELEMENT, 
    XML_ELEMENT_CONTENT_SEQ, 
    XML_ELEMENT_CONTENT_OR 
} xmlElementContentType;  

Discussion

xmlElementContentType:

Possible definitions of element content types.

typedef enum { 
    XML_ELEMENT_TYPE_UNDEFINED = 0, 
    XML_ELEMENT_TYPE_EMPTY = 1, 
    XML_ELEMENT_TYPE_ANY, 
    XML_ELEMENT_TYPE_MIXED, 
    XML_ELEMENT_TYPE_ELEMENT 
} xmlElementTypeVal;  

Discussion

xmlElementTypeVal:

The different possibilities for an element content type.

typedef struct _xmlEnumeration xmlEnumeration;  

Discussion

xmlEnumeration:

List structure used when there is an enumeration in DTDs.

typedef struct _xmlID xmlID;  

Discussion

xmlID:

An XML ID instance.

typedef struct _xmlNode xmlNode;  

Discussion

xmlNode:

A node in an XML tree.

typedef struct _xmlNotation xmlNotation;  

Discussion

xmlNotation:

A DTD Notation definition.

typedef struct _xmlNs xmlNs;  

Discussion

xmlNs:

An XML namespace. Note that prefix == NULL is valid, it defines the default namespace within the subtree (until overridden).

xmlNsType is unified with xmlElementType.

typedef struct _xmlRef xmlRef;  

Discussion

xmlRef:

An XML IDREF instance.

#defines

#define BASE_BUFFER_SIZE 4096 

Discussion

BASE_BUFFER_SIZE:

default buffer size 4000.

#define XML_GET_CONTENT(
    n) \ ((
    n)->type == XML_ELEMENT_NODE ? NULL : (
    n)->content) 

Discussion

XML_GET_CONTENT:

Macro to extract the content pointer of a node.

#define XML_GET_LINE(
    n) \ (
    xmlGetLineNo(
    n)) 

Discussion

XML_GET_LINE:

Macro to extract the line number of an element node.

#define XML_LOCAL_NAMESPACE XML_NAMESPACE_DECL 

Discussion

XML_LOCAL_NAMESPACE:

A namespace declaration node.

#define XML_XML_ID  

Discussion

XML_XML_ID:

This is the name for the special xml:id attribute

#define XML_XML_NAMESPACE \ (
    const xmlChar *) "http://www.w3.org/XML/1998/namespace"  

Discussion

XML_XML_NAMESPACE:

This is the namespace for the special xml: prefix predefined in the XML Namespace specification.

Did this document help you? Yes: Tell us what works for you. It’s good, but: Report typos, inaccuracies, and so forth. It wasn’t helpful: Tell us what would have helped.

Last Updated: 2006-06-20