.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "XML::Grove::Path 3pm"
.TH XML::Grove::Path 3pm "2022-11-29" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
XML::Grove::Path \- return the object at a path
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use XML::Grove::Path;
\&
\& # Using at_path method on XML::Grove::Document or XML::Grove::Element:
\& $xml_obj = $grove_object\->at_path("/some/path");
\&
\& # Using an XML::Grove::Path instance:
\& $pather = XML::Grove::Path\->new();
\& $xml_obj = $pather\->at_path($grove_object);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`XML::Grove::Path\*(C'\fR returns \s-1XML\s0 objects located at paths.  Paths are
strings of element names or \s-1XML\s0 object types separated by slash (\*(L"/\*(R")
characters.  Paths must always start at the grove object passed to
`\f(CW\*(C`at_path()\*(C'\fR'.  \f(CW\*(C`XML::Grove::Path\*(C'\fR is \fBnot\fR XPath, but it should
become obsolete when an XPath implementation is available.
.PP
Paths are like URLs
.PP
.Vb 2
\&    /html/body/ul/li[4]
\&    /html/body/#pi[2]
.Ve
.PP
The path segments can be element names or object types, the objects
types are named using:
.PP
.Vb 6
\&    #element
\&    #pi
\&    #comment
\&    #text
\&    #cdata
\&    #any
.Ve
.PP
The `\f(CW\*(C`#any\*(C'\fR' object type matches any type of object, it is
essentially an index into the contents of the parent object.
.PP
The `\f(CW\*(C`#text\*(C'\fR' object type treats text objects as if they are not
normalized.  Two consecutive text objects are separate text objects.
.SH "AUTHOR"
.IX Header "AUTHOR"
Ken MacLeod, ken@bitsko.slc.ut.us
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBperl\fR\|(1), \fBXML::Grove\fR\|(3)
.PP
Extensible Markup Language (\s-1XML\s0) <http://www.w3c.org/XML>