source-git / libxml2

Clone
Source Code
GIT

Blame doc/html/libxml-xpointer.html

c8 c8s master
  1.   423ecb126a67dbb9a6e77dd83f1159c349d39f33
  2.   doc
  3.   html
  4.   libxml-xpointer.html
Blob History Raw
Packit 423ecb
Packit 423ecb
Packit 423ecb 
<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 423ecb 
TD {font-family: Verdana,Arial,Helvetica}
Packit 423ecb 
BODY {font-family: Verdana,Arial,Helvetica; margin-top: 2em; margin-left: 0em; margin-right: 0em}
Packit 423ecb 
H1 {font-family: Verdana,Arial,Helvetica}
Packit 423ecb 
H2 {font-family: Verdana,Arial,Helvetica}
Packit 423ecb 
H3 {font-family: Verdana,Arial,Helvetica}
Packit 423ecb 
A:link, A:visited, A:active { text-decoration: underline }
Packit 423ecb 
</style><style type="text/css">
Packit 423ecb 
      div.deprecated pre.programlisting {border-style: double;border-color:red}
Packit 423ecb 
      pre.programlisting {border-style: double;background: #EECFA1}
Packit 423ecb 
    </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>
PrevxpathInternalsUpAPI documentationHomeThe XML C parser and toolkit of Gnome
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 423ecb 
Typedef xmlLocationSet * xmlLocationSetPtr
Packit 423ecb 
xmlNodePtr	xmlXPtrBuildNodeList	(xmlXPathObjectPtr obj)
Packit 423ecb 
xmlXPathObjectPtr	xmlXPtrEval	(const xmlChar * str, 
					 xmlXPathContextPtr ctx)
Packit 423ecb 
void	xmlXPtrEvalRangePredicate	(xmlXPathParserContextPtr ctxt)
Packit 423ecb 
void	xmlXPtrFreeLocationSet		(xmlLocationSetPtr obj)
Packit 423ecb 
void	xmlXPtrLocationSetAdd		(xmlLocationSetPtr cur, 
					 xmlXPathObjectPtr val)
Packit 423ecb 
xmlLocationSetPtr	xmlXPtrLocationSetCreate	(xmlXPathObjectPtr val)
Packit 423ecb 
void	xmlXPtrLocationSetDel		(xmlLocationSetPtr cur, 
					 xmlXPathObjectPtr val)
Packit 423ecb 
xmlLocationSetPtr	xmlXPtrLocationSetMerge	(xmlLocationSetPtr val1, 
						 xmlLocationSetPtr val2)
Packit 423ecb 
void	xmlXPtrLocationSetRemove	(xmlLocationSetPtr cur, 
					 int val)
Packit 423ecb 
xmlXPathObjectPtr	xmlXPtrNewCollapsedRange	(xmlNodePtr start)
Packit 423ecb 
xmlXPathContextPtr	xmlXPtrNewContext	(xmlDocPtr doc, 
						 xmlNodePtr here, 
						 xmlNodePtr origin)
Packit 423ecb 
xmlXPathObjectPtr	xmlXPtrNewLocationSetNodeSet	(xmlNodeSetPtr set)
Packit 423ecb 
xmlXPathObjectPtr	xmlXPtrNewLocationSetNodes	(xmlNodePtr start, 
							 xmlNodePtr end)
Packit 423ecb 
xmlXPathObjectPtr	xmlXPtrNewRange	(xmlNodePtr start, 
					 int startindex, 
					 xmlNodePtr end, 
					 int endindex)
Packit 423ecb 
xmlXPathObjectPtr	xmlXPtrNewRangeNodeObject	(xmlNodePtr start, 
							 xmlXPathObjectPtr end)
Packit 423ecb 
xmlXPathObjectPtr	xmlXPtrNewRangeNodePoint	(xmlNodePtr start, 
							 xmlXPathObjectPtr end)
Packit 423ecb 
xmlXPathObjectPtr	xmlXPtrNewRangeNodes	(xmlNodePtr start, 
						 xmlNodePtr end)
Packit 423ecb 
xmlXPathObjectPtr	xmlXPtrNewRangePointNode	(xmlXPathObjectPtr start, 
							 xmlNodePtr end)
Packit 423ecb 
xmlXPathObjectPtr	xmlXPtrNewRangePoints	(xmlXPathObjectPtr start, 
						 xmlXPathObjectPtr end)
Packit 423ecb 
void	xmlXPtrRangeToFunction		(xmlXPathParserContextPtr ctxt, 
					 int nargs)
Packit 423ecb 
xmlXPathObjectPtr	xmlXPtrWrapLocationSet	(xmlLocationSetPtr val)
Packit 423ecb 
Description
Packit 423ecb 
Structure xmlLocationSet
Structure xmlLocationSet
struct _xmlLocationSet {
Packit 423ecb 
    int	locNr	: number of locations in the set
Packit 423ecb 
    int	locMax	: size of the array as allocated
Packit 423ecb 
    xmlXPathObjectPtr *	locTab	: array of locations
Packit 423ecb 
}
Function: xmlXPtrBuildNodeList
xmlNodePtr	xmlXPtrBuildNodeList	(xmlXPathObjectPtr obj)
Packit 423ecb 
Build a node list tree copy of the XPointer result. This will drop Attributes and Namespace declarations.
Packit 423ecb 
<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 423ecb 
Evaluate the XPath Location Path in the given context.
Packit 423ecb 
<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 423ecb 
[8] Predicate ::= '[' PredicateExpr ']' [9] PredicateExpr ::= Expr Evaluate a predicate as in xmlXPathEvalPredicate() but for a Location Set instead of a node set
Packit 423ecb 
<tt>ctxt</tt>:the XPointer Parser context
Function: xmlXPtrFreeLocationSet
void	xmlXPtrFreeLocationSet		(xmlLocationSetPtr obj)
Packit 423ecb 
Free the LocationSet compound (not the actual ranges !).
Packit 423ecb 
<tt>obj</tt>:the xmlLocationSetPtr to free
Function: xmlXPtrLocationSetAdd
void	xmlXPtrLocationSetAdd		(xmlLocationSetPtr cur, 
					 xmlXPathObjectPtr val)
Packit 423ecb 
add a new xmlXPathObjectPtr to an existing LocationSet If the location already exist in the set @val is freed.
Packit 423ecb 
<tt>cur</tt>:the initial range set
<tt>val</tt>:a new xmlXPathObjectPtr
Function: xmlXPtrLocationSetCreate
xmlLocationSetPtr	xmlXPtrLocationSetCreate	(xmlXPathObjectPtr val)
Packit 423ecb 
Create a new xmlLocationSetPtr of type double and of value @val
Packit 423ecb 
<tt>val</tt>:an initial xmlXPathObjectPtr, or NULL
<tt>Returns</tt>:the newly created object.
Function: xmlXPtrLocationSetDel
void	xmlXPtrLocationSetDel		(xmlLocationSetPtr cur, 
					 xmlXPathObjectPtr val)
Packit 423ecb 
Removes an xmlXPathObjectPtr from an existing LocationSet
Packit 423ecb 
<tt>cur</tt>:the initial range set
<tt>val</tt>:an xmlXPathObjectPtr
Function: xmlXPtrLocationSetMerge
xmlLocationSetPtr	xmlXPtrLocationSetMerge	(xmlLocationSetPtr val1, 
						 xmlLocationSetPtr val2)
Packit 423ecb 
Merges two rangesets, all ranges from @val2 are added to @val1
Packit 423ecb 
<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 423ecb 
Removes an entry from an existing LocationSet list.
Packit 423ecb 
<tt>cur</tt>:the initial range set
<tt>val</tt>:the index to remove
Function: xmlXPtrNewCollapsedRange
xmlXPathObjectPtr	xmlXPtrNewCollapsedRange	(xmlNodePtr start)
Packit 423ecb 
Create a new xmlXPathObjectPtr of type range using a single nodes
Packit 423ecb 
<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 423ecb 
Create a new XPointer context
Packit 423ecb 
<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 423ecb 
Create a new xmlXPathObjectPtr of type LocationSet and initialize it with all the nodes from @set
Packit 423ecb 
<tt>set</tt>:a node set
<tt>Returns</tt>:the newly created object.
Function: xmlXPtrNewLocationSetNodes
xmlXPathObjectPtr	xmlXPtrNewLocationSetNodes	(xmlNodePtr start, 
							 xmlNodePtr end)
Packit 423ecb 
Create a new xmlXPathObjectPtr of type LocationSet and initialize it with the single range made of the two nodes @start and @end
Packit 423ecb 
<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 423ecb 
Create a new xmlXPathObjectPtr of type range
Packit 423ecb 
<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 423ecb 
Create a new xmlXPathObjectPtr of type range from a not to an object
Packit 423ecb 
<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 423ecb 
Create a new xmlXPathObjectPtr of type range from a node to a point
Packit 423ecb 
<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 423ecb 
Create a new xmlXPathObjectPtr of type range using 2 nodes
Packit 423ecb 
<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 423ecb 
Create a new xmlXPathObjectPtr of type range from a point to a node
Packit 423ecb 
<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 423ecb 
Create a new xmlXPathObjectPtr of type range using 2 Points
Packit 423ecb 
<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 423ecb 
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 423ecb 
<tt>ctxt</tt>:the XPointer Parser context
<tt>nargs</tt>:the number of args
Function: xmlXPtrWrapLocationSet
xmlXPathObjectPtr	xmlXPtrWrapLocationSet	(xmlLocationSetPtr val)
Packit 423ecb 
Wrap the LocationSet @val in a new xmlXPathObjectPtr
Packit 423ecb 
<tt>val</tt>:the LocationSet value
<tt>Returns</tt>:the newly created object.
Daniel Veillard
</body></html>

Powered by Pagure 5.14.1

SSH Hostkey/Fingerprint | Documentation