Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / libxml2 / 41e065130b6ed61362f61bd451a20039bfae9669 / . / doc / html / gnome-xml-xpointer.html
blob: b4d10d7bf5b05c03990b5d48fe2de81ec517b1e7 [file] [log] [blame]
Daniel Veillardb732a0e2000-10-15 11:27:01 +0000[diff] [blame]1<HTML
2><HEAD
3><TITLE
4>xpointer</TITLE
5><META
6NAME="GENERATOR"
7CONTENT="Modular DocBook HTML Stylesheet Version 1.33"><LINK
8REL="HOME"
9TITLE="Gnome XML Library Reference Manual"
10HREF="book1.html"><LINK
11REL="UP"
12TITLE="Libxml Library Reference"
13HREF="libxml-lib.html"><LINK
14REL="PREVIOUS"
Daniel Veillard29a11cc2000-10-25 13:32:39 +0000[diff] [blame]15TITLE="xpathInternals"
16HREF="gnome-xml-xpathinternals.html"><LINK
Daniel Veillardb732a0e2000-10-15 11:27:01 +0000[diff] [blame]17REL="NEXT"
18TITLE="nanohttp"
19HREF="gnome-xml-nanohttp.html"></HEAD
20><BODY
21BGCOLOR="#FFFFFF"
22TEXT="#000000"
23><DIV
24CLASS="NAVHEADER"
25><TABLE
26WIDTH="100%"
27BORDER="0"
28BGCOLOR="#000000"
29CELLPADDING="1"
30CELLSPACING="0"
31><TR
32><TH
33COLSPAN="4"
34ALIGN="center"
35><FONT
36COLOR="#FFFFFF"
37SIZE="5"
38>Gnome XML Library Reference Manual</FONT
39></TH
40></TR
41><TR
42><TD
43WIDTH="25%"
44BGCOLOR="#C00000"
45ALIGN="left"
46><A
Daniel Veillard29a11cc2000-10-25 13:32:39 +0000[diff] [blame]47HREF="gnome-xml-xpathinternals.html"
Daniel Veillardb732a0e2000-10-15 11:27:01 +0000[diff] [blame]48><FONT
49COLOR="#FFFFFF"
50SIZE="3"
51><B
52>&#60;&#60;&#60; Previous Page</B
53></FONT
54></A
55></TD
56><TD
57WIDTH="25%"
58BGCOLOR="#0000C0"
59ALIGN="center"
60><FONT
61COLOR="#FFFFFF"
62SIZE="3"
63><B
64><A
65HREF="book1.html"
66><FONT
67COLOR="#FFFFFF"
68SIZE="3"
69><B
70>Home</B
71></FONT
72></A
73></B
74></FONT
75></TD
76><TD
77WIDTH="25%"
78BGCOLOR="#00C000"
79ALIGN="center"
80><FONT
81COLOR="#FFFFFF"
82SIZE="3"
83><B
84><A
85HREF="libxml-lib.html"
86><FONT
87COLOR="#FFFFFF"
88SIZE="3"
89><B
90>Up</B
91></FONT
92></A
93></B
94></FONT
95></TD
96><TD
97WIDTH="25%"
98BGCOLOR="#C00000"
99ALIGN="right"
100><A
101HREF="gnome-xml-nanohttp.html"
102><FONT
103COLOR="#FFFFFF"
104SIZE="3"
105><B
106>Next Page &#62;&#62;&#62;</B
107></FONT
108></A
109></TD
110></TR
111></TABLE
112></DIV
113><H1
114>xpointer</H1
115><DIV
116CLASS="REFNAMEDIV"
117><A
Daniel Veillarda4964b72000-10-31 18:23:44 +0000[diff] [blame]118NAME="AEN12835"
Daniel Veillardb732a0e2000-10-15 11:27:01 +0000[diff] [blame]119></A
120><H2
121>Name</H2
122>xpointer &#8212; </DIV
123><DIV
124CLASS="REFSYNOPSISDIV"
125><A
Daniel Veillarda4964b72000-10-31 18:23:44 +0000[diff] [blame]126NAME="AEN12838"
Daniel Veillardb732a0e2000-10-15 11:27:01 +0000[diff] [blame]127></A
128><H2
129>Synopsis</H2
130><TABLE
131BORDER="0"
132BGCOLOR="#D6E8FF"
133WIDTH="100%"
134CELLPADDING="6"
135><TR
136><TD
137><PRE
138CLASS="SYNOPSIS"
139>&#13;
140
141struct <A
142HREF="gnome-xml-xpointer.html#XMLLOCATIONSET"
143>xmlLocationSet</A
144>;
145typedef <A
146HREF="gnome-xml-xpointer.html#XMLLOCATIONSETPTR"
147>xmlLocationSetPtr</A
148>;
149void <A
150HREF="gnome-xml-xpointer.html#XMLXPTRFREELOCATIONSET"
151>xmlXPtrFreeLocationSet</A
152> (<A
153HREF="gnome-xml-xpointer.html#XMLLOCATIONSETPTR"
154>xmlLocationSetPtr</A
155> obj);
156<A
157HREF="gnome-xml-xpointer.html#XMLLOCATIONSETPTR"
158>xmlLocationSetPtr</A
159> <A
160HREF="gnome-xml-xpointer.html#XMLXPTRLOCATIONSETMERGE"
161>xmlXPtrLocationSetMerge</A
162> (<A
163HREF="gnome-xml-xpointer.html#XMLLOCATIONSETPTR"
164>xmlLocationSetPtr</A
165> val1,
166 <A
167HREF="gnome-xml-xpointer.html#XMLLOCATIONSETPTR"
168>xmlLocationSetPtr</A
169> val2);
170<A
171HREF="gnome-xml-xpath.html#XMLXPATHCONTEXTPTR"
172>xmlXPathContextPtr</A
173> <A
174HREF="gnome-xml-xpointer.html#XMLXPTRNEWCONTEXT"
175>xmlXPtrNewContext</A
176> (<A
177HREF="gnome-xml-tree.html#XMLDOCPTR"
178>xmlDocPtr</A
179> doc,
180 <A
181HREF="gnome-xml-tree.html#XMLNODEPTR"
182>xmlNodePtr</A
183> here,
184 <A
185HREF="gnome-xml-tree.html#XMLNODEPTR"
186>xmlNodePtr</A
187> origin);
188<A
189HREF="gnome-xml-xpath.html#XMLXPATHOBJECTPTR"
190>xmlXPathObjectPtr</A
191> <A
192HREF="gnome-xml-xpointer.html#XMLXPTREVAL"
193>xmlXPtrEval</A
194> (const <A
195HREF="gnome-xml-tree.html#XMLCHAR"
196>xmlChar</A
197> *str,
198 <A
199HREF="gnome-xml-xpath.html#XMLXPATHCONTEXTPTR"
200>xmlXPathContextPtr</A
201> ctx);
202void <A
203HREF="gnome-xml-xpointer.html#XMLXPTRRANGETOFUNCTION"
204>xmlXPtrRangeToFunction</A
205> (<A
206HREF="gnome-xml-xpath.html#XMLXPATHPARSERCONTEXTPTR"
207>xmlXPathParserContextPtr</A
208> ctxt,
209 int nargs);</PRE
210></TD
211></TR
212></TABLE
213></DIV
214><DIV
215CLASS="REFSECT1"
216><A
Daniel Veillarda4964b72000-10-31 18:23:44 +0000[diff] [blame]217NAME="AEN12860"
Daniel Veillardb732a0e2000-10-15 11:27:01 +0000[diff] [blame]218></A
219><H2
220>Description</H2
221><P
222></P
223></DIV
224><DIV
225CLASS="REFSECT1"
226><A
Daniel Veillarda4964b72000-10-31 18:23:44 +0000[diff] [blame]227NAME="AEN12863"
Daniel Veillardb732a0e2000-10-15 11:27:01 +0000[diff] [blame]228></A
229><H2
230>Details</H2
231><DIV
232CLASS="REFSECT2"
233><A
Daniel Veillarda4964b72000-10-31 18:23:44 +0000[diff] [blame]234NAME="AEN12865"
Daniel Veillardb732a0e2000-10-15 11:27:01 +0000[diff] [blame]235></A
236><H3
237><A
238NAME="XMLLOCATIONSET"
239></A
240>struct xmlLocationSet</H3
241><TABLE
242BORDER="0"
243BGCOLOR="#D6E8FF"
244WIDTH="100%"
245CELLPADDING="6"
246><TR
247><TD
248><PRE
249CLASS="PROGRAMLISTING"
250>struct xmlLocationSet {
251 int locNr; /* number of locations in the set */
252 int locMax; /* size of the array as allocated */
253 xmlXPathObjectPtr *locTab;/* array of locations */
254};</PRE
255></TD
256></TR
257></TABLE
258><P
259></P
260></DIV
261><HR><DIV
262CLASS="REFSECT2"
263><A
Daniel Veillarda4964b72000-10-31 18:23:44 +0000[diff] [blame]264NAME="AEN12870"
Daniel Veillardb732a0e2000-10-15 11:27:01 +0000[diff] [blame]265></A
266><H3
267><A
268NAME="XMLLOCATIONSETPTR"
269></A
270>xmlLocationSetPtr</H3
271><TABLE
272BORDER="0"
273BGCOLOR="#D6E8FF"
274WIDTH="100%"
275CELLPADDING="6"
276><TR
277><TD
278><PRE
279CLASS="PROGRAMLISTING"
280>typedef xmlLocationSet *xmlLocationSetPtr;</PRE
281></TD
282></TR
283></TABLE
284><P
285></P
286></DIV
287><HR><DIV
288CLASS="REFSECT2"
289><A
Daniel Veillarda4964b72000-10-31 18:23:44 +0000[diff] [blame]290NAME="AEN12875"
Daniel Veillardb732a0e2000-10-15 11:27:01 +0000[diff] [blame]291></A
292><H3
293><A
294NAME="XMLXPTRFREELOCATIONSET"
295></A
296>xmlXPtrFreeLocationSet ()</H3
297><TABLE
298BORDER="0"
299BGCOLOR="#D6E8FF"
300WIDTH="100%"
301CELLPADDING="6"
302><TR
303><TD
304><PRE
305CLASS="PROGRAMLISTING"
306>void xmlXPtrFreeLocationSet (<A
307HREF="gnome-xml-xpointer.html#XMLLOCATIONSETPTR"
308>xmlLocationSetPtr</A
309> obj);</PRE
310></TD
311></TR
312></TABLE
313><P
314>Free the LocationSet compound (not the actual ranges !).</P
315><P
316></P
317><DIV
318CLASS="INFORMALTABLE"
319><P
320></P
321><TABLE
322BORDER="0"
323WIDTH="100%"
324BGCOLOR="#FFD0D0"
325CELLSPACING="0"
326CELLPADDING="4"
327CLASS="CALSTABLE"
328><TR
329><TD
330WIDTH="20%"
331ALIGN="RIGHT"
332VALIGN="TOP"
333><TT
334CLASS="PARAMETER"
335><I
336>obj</I
337></TT
338>&nbsp;:</TD
339><TD
340WIDTH="80%"
341ALIGN="LEFT"
342VALIGN="TOP"
343> the xmlLocationSetPtr to free</TD
344></TR
345></TABLE
346><P
347></P
348></DIV
349></DIV
350><HR><DIV
351CLASS="REFSECT2"
352><A
Daniel Veillarda4964b72000-10-31 18:23:44 +0000[diff] [blame]353NAME="AEN12891"
Daniel Veillardb732a0e2000-10-15 11:27:01 +0000[diff] [blame]354></A
355><H3
356><A
357NAME="XMLXPTRLOCATIONSETMERGE"
358></A
359>xmlXPtrLocationSetMerge ()</H3
360><TABLE
361BORDER="0"
362BGCOLOR="#D6E8FF"
363WIDTH="100%"
364CELLPADDING="6"
365><TR
366><TD
367><PRE
368CLASS="PROGRAMLISTING"
369><A
370HREF="gnome-xml-xpointer.html#XMLLOCATIONSETPTR"
371>xmlLocationSetPtr</A
372> xmlXPtrLocationSetMerge (<A
373HREF="gnome-xml-xpointer.html#XMLLOCATIONSETPTR"
374>xmlLocationSetPtr</A
375> val1,
376 <A
377HREF="gnome-xml-xpointer.html#XMLLOCATIONSETPTR"
378>xmlLocationSetPtr</A
379> val2);</PRE
380></TD
381></TR
382></TABLE
383><P
384>Merges two rangesets, all ranges from <TT
385CLASS="PARAMETER"
386><I
387>val2</I
388></TT
389> are added to <TT
390CLASS="PARAMETER"
391><I
392>val1</I
393></TT
394></P
395><P
396></P
397><DIV
398CLASS="INFORMALTABLE"
399><P
400></P
401><TABLE
402BORDER="0"
403WIDTH="100%"
404BGCOLOR="#FFD0D0"
405CELLSPACING="0"
406CELLPADDING="4"
407CLASS="CALSTABLE"
408><TR
409><TD
410WIDTH="20%"
411ALIGN="RIGHT"
412VALIGN="TOP"
413><TT
414CLASS="PARAMETER"
415><I
416>val1</I
417></TT
418>&nbsp;:</TD
419><TD
420WIDTH="80%"
421ALIGN="LEFT"
422VALIGN="TOP"
423> the first LocationSet</TD
424></TR
425><TR
426><TD
427WIDTH="20%"
428ALIGN="RIGHT"
429VALIGN="TOP"
430><TT
431CLASS="PARAMETER"
432><I
433>val2</I
434></TT
435>&nbsp;:</TD
436><TD
437WIDTH="80%"
438ALIGN="LEFT"
439VALIGN="TOP"
440> the second LocationSet</TD
441></TR
442><TR
443><TD
444WIDTH="20%"
445ALIGN="RIGHT"
446VALIGN="TOP"
447><I
448CLASS="EMPHASIS"
449>Returns</I
450> :</TD
451><TD
452WIDTH="80%"
453ALIGN="LEFT"
454VALIGN="TOP"
455>val1 once extended or NULL in case of error.</TD
456></TR
457></TABLE
458><P
459></P
460></DIV
461></DIV
462><HR><DIV
463CLASS="REFSECT2"
464><A
Daniel Veillarda4964b72000-10-31 18:23:44 +0000[diff] [blame]465NAME="AEN12919"
Daniel Veillardb732a0e2000-10-15 11:27:01 +0000[diff] [blame]466></A
467><H3
468><A
469NAME="XMLXPTRNEWCONTEXT"
470></A
471>xmlXPtrNewContext ()</H3
472><TABLE
473BORDER="0"
474BGCOLOR="#D6E8FF"
475WIDTH="100%"
476CELLPADDING="6"
477><TR
478><TD
479><PRE
480CLASS="PROGRAMLISTING"
481><A
482HREF="gnome-xml-xpath.html#XMLXPATHCONTEXTPTR"
483>xmlXPathContextPtr</A
484> xmlXPtrNewContext (<A
485HREF="gnome-xml-tree.html#XMLDOCPTR"
486>xmlDocPtr</A
487> doc,
488 <A
489HREF="gnome-xml-tree.html#XMLNODEPTR"
490>xmlNodePtr</A
491> here,
492 <A
493HREF="gnome-xml-tree.html#XMLNODEPTR"
494>xmlNodePtr</A
495> origin);</PRE
496></TD
497></TR
498></TABLE
499><P
500>Create a new XPointer context</P
501><P
502></P
503><DIV
504CLASS="INFORMALTABLE"
505><P
506></P
507><TABLE
508BORDER="0"
509WIDTH="100%"
510BGCOLOR="#FFD0D0"
511CELLSPACING="0"
512CELLPADDING="4"
513CLASS="CALSTABLE"
514><TR
515><TD
516WIDTH="20%"
517ALIGN="RIGHT"
518VALIGN="TOP"
519><TT
520CLASS="PARAMETER"
521><I
522>doc</I
523></TT
524>&nbsp;:</TD
525><TD
526WIDTH="80%"
527ALIGN="LEFT"
528VALIGN="TOP"
529> the XML document</TD
530></TR
531><TR
532><TD
533WIDTH="20%"
534ALIGN="RIGHT"
535VALIGN="TOP"
536><TT
537CLASS="PARAMETER"
538><I
539>here</I
540></TT
541>&nbsp;:</TD
542><TD
543WIDTH="80%"
544ALIGN="LEFT"
545VALIGN="TOP"
546> the node that directly contains the XPointer being evaluated or NULL</TD
547></TR
548><TR
549><TD
550WIDTH="20%"
551ALIGN="RIGHT"
552VALIGN="TOP"
553><TT
554CLASS="PARAMETER"
555><I
556>origin</I
557></TT
558>&nbsp;:</TD
559><TD
560WIDTH="80%"
561ALIGN="LEFT"
562VALIGN="TOP"
563> the element from which a user or program initiated traversal of
564the link, or NULL.</TD
565></TR
566><TR
567><TD
568WIDTH="20%"
569ALIGN="RIGHT"
570VALIGN="TOP"
571><I
572CLASS="EMPHASIS"
573>Returns</I
574> :</TD
575><TD
576WIDTH="80%"
577ALIGN="LEFT"
578VALIGN="TOP"
579>the xmlXPathContext just allocated.</TD
580></TR
581></TABLE
582><P
583></P
584></DIV
585></DIV
586><HR><DIV
587CLASS="REFSECT2"
588><A
Daniel Veillarda4964b72000-10-31 18:23:44 +0000[diff] [blame]589NAME="AEN12950"
Daniel Veillardb732a0e2000-10-15 11:27:01 +0000[diff] [blame]590></A
591><H3
592><A
593NAME="XMLXPTREVAL"
594></A
595>xmlXPtrEval ()</H3
596><TABLE
597BORDER="0"
598BGCOLOR="#D6E8FF"
599WIDTH="100%"
600CELLPADDING="6"
601><TR
602><TD
603><PRE
604CLASS="PROGRAMLISTING"
605><A
606HREF="gnome-xml-xpath.html#XMLXPATHOBJECTPTR"
607>xmlXPathObjectPtr</A
608> xmlXPtrEval (const <A
609HREF="gnome-xml-tree.html#XMLCHAR"
610>xmlChar</A
611> *str,
612 <A
613HREF="gnome-xml-xpath.html#XMLXPATHCONTEXTPTR"
614>xmlXPathContextPtr</A
615> ctx);</PRE
616></TD
617></TR
618></TABLE
619><P
620>Evaluate the XPath Location Path in the given context.</P
621><P
622></P
623><DIV
624CLASS="INFORMALTABLE"
625><P
626></P
627><TABLE
628BORDER="0"
629WIDTH="100%"
630BGCOLOR="#FFD0D0"
631CELLSPACING="0"
632CELLPADDING="4"
633CLASS="CALSTABLE"
634><TR
635><TD
636WIDTH="20%"
637ALIGN="RIGHT"
638VALIGN="TOP"
639><TT
640CLASS="PARAMETER"
641><I
642>str</I
643></TT
644>&nbsp;:</TD
645><TD
646WIDTH="80%"
647ALIGN="LEFT"
648VALIGN="TOP"
649> the XPointer expression</TD
650></TR
651><TR
652><TD
653WIDTH="20%"
654ALIGN="RIGHT"
655VALIGN="TOP"
656><TT
657CLASS="PARAMETER"
658><I
659>ctx</I
660></TT
661>&nbsp;:</TD
662><TD
663WIDTH="80%"
664ALIGN="LEFT"
665VALIGN="TOP"
666> the XPointer context</TD
667></TR
668><TR
669><TD
670WIDTH="20%"
671ALIGN="RIGHT"
672VALIGN="TOP"
673><I
674CLASS="EMPHASIS"
675>Returns</I
676> :</TD
677><TD
678WIDTH="80%"
679ALIGN="LEFT"
680VALIGN="TOP"
681>the xmlXPathObjectPtr resulting from the eveluation or NULL.
682the caller has to free the object.</TD
683></TR
684></TABLE
685><P
686></P
687></DIV
688></DIV
689><HR><DIV
690CLASS="REFSECT2"
691><A
Daniel Veillarda4964b72000-10-31 18:23:44 +0000[diff] [blame]692NAME="AEN12976"
Daniel Veillardb732a0e2000-10-15 11:27:01 +0000[diff] [blame]693></A
694><H3
695><A
696NAME="XMLXPTRRANGETOFUNCTION"
697></A
698>xmlXPtrRangeToFunction ()</H3
699><TABLE
700BORDER="0"
701BGCOLOR="#D6E8FF"
702WIDTH="100%"
703CELLPADDING="6"
704><TR
705><TD
706><PRE
707CLASS="PROGRAMLISTING"
708>void xmlXPtrRangeToFunction (<A
709HREF="gnome-xml-xpath.html#XMLXPATHPARSERCONTEXTPTR"
710>xmlXPathParserContextPtr</A
711> ctxt,
712 int nargs);</PRE
713></TD
714></TR
715></TABLE
716><P
717>Implement the range-<GTKDOCLINK
718HREF="TO"
719>to</GTKDOCLINK
720>() XPointer function</P
721><P
722></P
723><DIV
724CLASS="INFORMALTABLE"
725><P
726></P
727><TABLE
728BORDER="0"
729WIDTH="100%"
730BGCOLOR="#FFD0D0"
731CELLSPACING="0"
732CELLPADDING="4"
733CLASS="CALSTABLE"
734><TR
735><TD
736WIDTH="20%"
737ALIGN="RIGHT"
738VALIGN="TOP"
739><TT
740CLASS="PARAMETER"
741><I
742>ctxt</I
743></TT
744>&nbsp;:</TD
745><TD
746WIDTH="80%"
747ALIGN="LEFT"
748VALIGN="TOP"
749> the XPointer Parser context</TD
750></TR
751><TR
752><TD
753WIDTH="20%"
754ALIGN="RIGHT"
755VALIGN="TOP"
756><TT
757CLASS="PARAMETER"
758><I
759>nargs</I
760></TT
761>&nbsp;:</TD
762><TD
763WIDTH="80%"
764ALIGN="LEFT"
765VALIGN="TOP"
766>&nbsp;</TD
767></TR
768></TABLE
769><P
770></P
771></DIV
772></DIV
773></DIV
774><DIV
775CLASS="NAVFOOTER"
776><BR
777CLEAR="all"><BR><TABLE
778WIDTH="100%"
779BORDER="0"
780BGCOLOR="#000000"
781CELLPADDING="1"
782CELLSPACING="0"
783><TR
784><TD
785WIDTH="25%"
786BGCOLOR="#C00000"
787ALIGN="left"
788><A
Daniel Veillard29a11cc2000-10-25 13:32:39 +0000[diff] [blame]789HREF="gnome-xml-xpathinternals.html"
Daniel Veillardb732a0e2000-10-15 11:27:01 +0000[diff] [blame]790><FONT
791COLOR="#FFFFFF"
792SIZE="3"
793><B
794>&#60;&#60;&#60; Previous Page</B
795></FONT
796></A
797></TD
798><TD
799WIDTH="25%"
800BGCOLOR="#0000C0"
801ALIGN="center"
802><FONT
803COLOR="#FFFFFF"
804SIZE="3"
805><B
806><A
807HREF="book1.html"
808><FONT
809COLOR="#FFFFFF"
810SIZE="3"
811><B
812>Home</B
813></FONT
814></A
815></B
816></FONT
817></TD
818><TD
819WIDTH="25%"
820BGCOLOR="#00C000"
821ALIGN="center"
822><FONT
823COLOR="#FFFFFF"
824SIZE="3"
825><B
826><A
827HREF="libxml-lib.html"
828><FONT
829COLOR="#FFFFFF"
830SIZE="3"
831><B
832>Up</B
833></FONT
834></A
835></B
836></FONT
837></TD
838><TD
839WIDTH="25%"
840BGCOLOR="#C00000"
841ALIGN="right"
842><A
843HREF="gnome-xml-nanohttp.html"
844><FONT
845COLOR="#FFFFFF"
846SIZE="3"
847><B
848>Next Page &#62;&#62;&#62;</B
849></FONT
850></A
851></TD
852></TR
853><TR
854><TD
855COLSPAN="2"
856ALIGN="left"
857><FONT
858COLOR="#FFFFFF"
859SIZE="3"
860><B
Daniel Veillard29a11cc2000-10-25 13:32:39 +0000[diff] [blame]861>xpathInternals</B
Daniel Veillardb732a0e2000-10-15 11:27:01 +0000[diff] [blame]862></FONT
863></TD
864><TD
865COLSPAN="2"
866ALIGN="right"
867><FONT
868COLOR="#FFFFFF"
869SIZE="3"
870><B
871>nanohttp</B
872></FONT
873></TD
874></TR
875></TABLE
876></DIV
877></BODY
878></HTML
879>