Blame doc/html/libxml-xpointer.html

Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="SHORTCUT ICON" href="/favicon.ico" /><style type="text/css">
Packit Service a31ea6
TD {font-family: Verdana,Arial,Helvetica}
Packit Service a31ea6
BODY {font-family: Verdana,Arial,Helvetica; margin-top: 2em; margin-left: 0em; margin-right: 0em}
Packit Service a31ea6
H1 {font-family: Verdana,Arial,Helvetica}
Packit Service a31ea6
H2 {font-family: Verdana,Arial,Helvetica}
Packit Service a31ea6
H3 {font-family: Verdana,Arial,Helvetica}
Packit Service a31ea6
A:link, A:visited, A:active { text-decoration: underline }
Packit Service a31ea6
</style><style type="text/css">
Packit Service a31ea6
      div.deprecated pre.programlisting {border-style: double;border-color:red}
Packit Service a31ea6
      pre.programlisting {border-style: double;background: #EECFA1}
Packit Service a31ea6
    </style><title>Module xpointer from libxml2</title></head><body bgcolor="#8b7765" text="#000000" link="#a06060" vlink="#000000">
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo

Module xpointer from libxml2

<center>API Menu</center>
<form action="../search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="20" value="" /><input name="submit" type="submit" value="Search ..." /></form>
<center>API Indexes</center>
<center>Related links</center>

API to handle XML Pointers Base implementation was made accordingly to W3C Candidate Recommendation 7 June 2000

Table of Contents

Structure xmlLocationSet
struct _xmlLocationSet
Packit Service a31ea6
Typedef xmlLocationSet * xmlLocationSetPtr
Packit Service a31ea6
xmlNodePtr	xmlXPtrBuildNodeList	(xmlXPathObjectPtr obj)
Packit Service a31ea6
xmlXPathObjectPtr	xmlXPtrEval	(const xmlChar * str, 
xmlXPathContextPtr ctx)
Packit Service a31ea6
void	xmlXPtrEvalRangePredicate	(xmlXPathParserContextPtr ctxt)
Packit Service a31ea6
void	xmlXPtrFreeLocationSet		(xmlLocationSetPtr obj)
Packit Service a31ea6
void	xmlXPtrLocationSetAdd		(xmlLocationSetPtr cur, 
xmlXPathObjectPtr val)
Packit Service a31ea6
xmlLocationSetPtr	xmlXPtrLocationSetCreate	(xmlXPathObjectPtr val)
Packit Service a31ea6
void	xmlXPtrLocationSetDel		(xmlLocationSetPtr cur, 
xmlXPathObjectPtr val)
Packit Service a31ea6
xmlLocationSetPtr	xmlXPtrLocationSetMerge	(xmlLocationSetPtr val1, 
xmlLocationSetPtr val2)
Packit Service a31ea6
void	xmlXPtrLocationSetRemove	(xmlLocationSetPtr cur, 
int val)
Packit Service a31ea6
xmlXPathObjectPtr	xmlXPtrNewCollapsedRange	(xmlNodePtr start)
Packit Service a31ea6
xmlXPathContextPtr	xmlXPtrNewContext	(xmlDocPtr doc, 
xmlNodePtr here,
xmlNodePtr origin)
Packit Service a31ea6
xmlXPathObjectPtr	xmlXPtrNewLocationSetNodeSet	(xmlNodeSetPtr set)
Packit Service a31ea6
xmlXPathObjectPtr	xmlXPtrNewLocationSetNodes	(xmlNodePtr start, 
xmlNodePtr end)
Packit Service a31ea6
xmlXPathObjectPtr	xmlXPtrNewRange	(xmlNodePtr start, 
int startindex,
xmlNodePtr end,
int endindex)
Packit Service a31ea6
xmlXPathObjectPtr	xmlXPtrNewRangeNodeObject	(xmlNodePtr start, 
xmlXPathObjectPtr end)
Packit Service a31ea6
xmlXPathObjectPtr	xmlXPtrNewRangeNodePoint	(xmlNodePtr start, 
xmlXPathObjectPtr end)
Packit Service a31ea6
xmlXPathObjectPtr	xmlXPtrNewRangeNodes	(xmlNodePtr start, 
xmlNodePtr end)
Packit Service a31ea6
xmlXPathObjectPtr	xmlXPtrNewRangePointNode	(xmlXPathObjectPtr start, 
xmlNodePtr end)
Packit Service a31ea6
xmlXPathObjectPtr	xmlXPtrNewRangePoints	(xmlXPathObjectPtr start, 
xmlXPathObjectPtr end)
Packit Service a31ea6
void	xmlXPtrRangeToFunction		(xmlXPathParserContextPtr ctxt, 
int nargs)
Packit Service a31ea6
xmlXPathObjectPtr	xmlXPtrWrapLocationSet	(xmlLocationSetPtr val)
Packit Service a31ea6

Description

Packit Service a31ea6

Structure xmlLocationSet

Structure xmlLocationSet
struct _xmlLocationSet {
Packit Service a31ea6
    int	locNr	: number of locations in the set
Packit Service a31ea6
    int	locMax	: size of the array as allocated
Packit Service a31ea6
    xmlXPathObjectPtr *	locTab	: array of locations
Packit Service a31ea6
}

Function: xmlXPtrBuildNodeList

xmlNodePtr	xmlXPtrBuildNodeList	(xmlXPathObjectPtr obj)
Packit Service a31ea6

Build a node list tree copy of the XPointer result. This will drop Attributes and Namespace declarations.

Packit Service a31ea6
<tt>obj</tt>:the XPointer result from the evaluation.
<tt>Returns</tt>:an xmlNodePtr list or NULL. the caller has to free the node tree.

Function: xmlXPtrEval

xmlXPathObjectPtr	xmlXPtrEval	(const xmlChar * str, 
xmlXPathContextPtr ctx)
Packit Service a31ea6

Evaluate the XPath Location Path in the given context.

Packit Service a31ea6
<tt>str</tt>:the XPointer expression
<tt>ctx</tt>:the XPointer context
<tt>Returns</tt>:the xmlXPathObjectPtr resulting from the evaluation or NULL. the caller has to free the object.

Function: xmlXPtrEvalRangePredicate

void	xmlXPtrEvalRangePredicate	(xmlXPathParserContextPtr ctxt)
Packit Service a31ea6

[8] Predicate ::= '[' PredicateExpr ']' [9] PredicateExpr ::= Expr Evaluate a predicate as in xmlXPathEvalPredicate() but for a Location Set instead of a node set

Packit Service a31ea6
<tt>ctxt</tt>:the XPointer Parser context

Function: xmlXPtrFreeLocationSet

void	xmlXPtrFreeLocationSet		(xmlLocationSetPtr obj)
Packit Service a31ea6

Free the LocationSet compound (not the actual ranges !).

Packit Service a31ea6
<tt>obj</tt>:the xmlLocationSetPtr to free

Function: xmlXPtrLocationSetAdd

void	xmlXPtrLocationSetAdd		(xmlLocationSetPtr cur, 
xmlXPathObjectPtr val)
Packit Service a31ea6

add a new xmlXPathObjectPtr to an existing LocationSet If the location already exist in the set @val is freed.

Packit Service a31ea6
<tt>cur</tt>:the initial range set
<tt>val</tt>:a new xmlXPathObjectPtr

Function: xmlXPtrLocationSetCreate

xmlLocationSetPtr	xmlXPtrLocationSetCreate	(xmlXPathObjectPtr val)
Packit Service a31ea6

Create a new xmlLocationSetPtr of type double and of value @val

Packit Service a31ea6
<tt>val</tt>:an initial xmlXPathObjectPtr, or NULL
<tt>Returns</tt>:the newly created object.

Function: xmlXPtrLocationSetDel

void	xmlXPtrLocationSetDel		(xmlLocationSetPtr cur, 
xmlXPathObjectPtr val)
Packit Service a31ea6

Removes an xmlXPathObjectPtr from an existing LocationSet

Packit Service a31ea6
<tt>cur</tt>:the initial range set
<tt>val</tt>:an xmlXPathObjectPtr

Function: xmlXPtrLocationSetMerge

xmlLocationSetPtr	xmlXPtrLocationSetMerge	(xmlLocationSetPtr val1, 
xmlLocationSetPtr val2)
Packit Service a31ea6

Merges two rangesets, all ranges from @val2 are added to @val1

Packit Service a31ea6
<tt>val1</tt>:the first LocationSet
<tt>val2</tt>:the second LocationSet
<tt>Returns</tt>:val1 once extended or NULL in case of error.

Function: xmlXPtrLocationSetRemove

void	xmlXPtrLocationSetRemove	(xmlLocationSetPtr cur, 
int val)
Packit Service a31ea6

Removes an entry from an existing LocationSet list.

Packit Service a31ea6
<tt>cur</tt>:the initial range set
<tt>val</tt>:the index to remove

Function: xmlXPtrNewCollapsedRange

xmlXPathObjectPtr	xmlXPtrNewCollapsedRange	(xmlNodePtr start)
Packit Service a31ea6

Create a new xmlXPathObjectPtr of type range using a single nodes

Packit Service a31ea6
<tt>start</tt>:the starting and ending node
<tt>Returns</tt>:the newly created object.

Function: xmlXPtrNewContext

xmlXPathContextPtr	xmlXPtrNewContext	(xmlDocPtr doc, 
xmlNodePtr here,
xmlNodePtr origin)
Packit Service a31ea6

Create a new XPointer context

Packit Service a31ea6
<tt>doc</tt>:the XML document
<tt>here</tt>:the node that directly contains the XPointer being evaluated or NULL
<tt>origin</tt>:the element from which a user or program initiated traversal of the link, or NULL.
<tt>Returns</tt>:the xmlXPathContext just allocated.

Function: xmlXPtrNewLocationSetNodeSet

xmlXPathObjectPtr	xmlXPtrNewLocationSetNodeSet	(xmlNodeSetPtr set)
Packit Service a31ea6

Create a new xmlXPathObjectPtr of type LocationSet and initialize it with all the nodes from @set

Packit Service a31ea6
<tt>set</tt>:a node set
<tt>Returns</tt>:the newly created object.

Function: xmlXPtrNewLocationSetNodes

xmlXPathObjectPtr	xmlXPtrNewLocationSetNodes	(xmlNodePtr start, 
xmlNodePtr end)
Packit Service a31ea6

Create a new xmlXPathObjectPtr of type LocationSet and initialize it with the single range made of the two nodes @start and @end

Packit Service a31ea6
<tt>start</tt>:the start NodePtr value
<tt>end</tt>:the end NodePtr value or NULL
<tt>Returns</tt>:the newly created object.

Function: xmlXPtrNewRange

xmlXPathObjectPtr	xmlXPtrNewRange	(xmlNodePtr start, 
int startindex,
xmlNodePtr end,
int endindex)
Packit Service a31ea6

Create a new xmlXPathObjectPtr of type range

Packit Service a31ea6
<tt>start</tt>:the starting node
<tt>startindex</tt>:the start index
<tt>end</tt>:the ending point
<tt>endindex</tt>:the ending index
<tt>Returns</tt>:the newly created object.

Function: xmlXPtrNewRangeNodeObject

xmlXPathObjectPtr	xmlXPtrNewRangeNodeObject	(xmlNodePtr start, 
xmlXPathObjectPtr end)
Packit Service a31ea6

Create a new xmlXPathObjectPtr of type range from a not to an object

Packit Service a31ea6
<tt>start</tt>:the starting node
<tt>end</tt>:the ending object
<tt>Returns</tt>:the newly created object.

Function: xmlXPtrNewRangeNodePoint

xmlXPathObjectPtr	xmlXPtrNewRangeNodePoint	(xmlNodePtr start, 
xmlXPathObjectPtr end)
Packit Service a31ea6

Create a new xmlXPathObjectPtr of type range from a node to a point

Packit Service a31ea6
<tt>start</tt>:the starting node
<tt>end</tt>:the ending point
<tt>Returns</tt>:the newly created object.

Function: xmlXPtrNewRangeNodes

xmlXPathObjectPtr	xmlXPtrNewRangeNodes	(xmlNodePtr start, 
xmlNodePtr end)
Packit Service a31ea6

Create a new xmlXPathObjectPtr of type range using 2 nodes

Packit Service a31ea6
<tt>start</tt>:the starting node
<tt>end</tt>:the ending node
<tt>Returns</tt>:the newly created object.

Function: xmlXPtrNewRangePointNode

xmlXPathObjectPtr	xmlXPtrNewRangePointNode	(xmlXPathObjectPtr start, 
xmlNodePtr end)
Packit Service a31ea6

Create a new xmlXPathObjectPtr of type range from a point to a node

Packit Service a31ea6
<tt>start</tt>:the starting point
<tt>end</tt>:the ending node
<tt>Returns</tt>:the newly created object.

Function: xmlXPtrNewRangePoints

xmlXPathObjectPtr	xmlXPtrNewRangePoints	(xmlXPathObjectPtr start, 
xmlXPathObjectPtr end)
Packit Service a31ea6

Create a new xmlXPathObjectPtr of type range using 2 Points

Packit Service a31ea6
<tt>start</tt>:the starting point
<tt>end</tt>:the ending point
<tt>Returns</tt>:the newly created object.

Function: xmlXPtrRangeToFunction

void	xmlXPtrRangeToFunction		(xmlXPathParserContextPtr ctxt, 
int nargs)
Packit Service a31ea6

Implement the range-to() XPointer function Obsolete. range-to is not a real function but a special type of location step which is handled in xpath.c.

Packit Service a31ea6
<tt>ctxt</tt>:the XPointer Parser context
<tt>nargs</tt>:the number of args

Function: xmlXPtrWrapLocationSet

xmlXPathObjectPtr	xmlXPtrWrapLocationSet	(xmlLocationSetPtr val)
Packit Service a31ea6

Wrap the LocationSet @val in a new xmlXPathObjectPtr

Packit Service a31ea6
<tt>val</tt>:the LocationSet value
<tt>Returns</tt>:the newly created object.

Daniel Veillard

</body></html>