.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Test::XML::XPath 3pm"
.TH Test::XML::XPath 3pm "2009-07-02" "perl v5.14.2" "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"
Test::XML::XPath \- Test XPath assertions
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 4
\&  use Test::XML::XPath tests => 3;
\&  like_xpath( \*(Aq<foo />\*(Aq, \*(Aq/foo\*(Aq );   # PASS
\&  like_xpath( \*(Aq<foo />\*(Aq, \*(Aq/bar\*(Aq );   # FAIL
\&  unlike_xpath( \*(Aq<foo />\*(Aq, \*(Aq/bar\*(Aq ); # PASS
\&
\&  is_xpath( \*(Aq<foo>bar</foo>\*(Aq, \*(Aq/foo\*(Aq, \*(Aqbar\*(Aq ); # PASS
\&  is_xpath( \*(Aq<foo>bar</foo>\*(Aq, \*(Aq/bar\*(Aq, \*(Aqfoo\*(Aq ); # FAIL
\&
\&  # More interesting examples of xpath assertions.
\&  my $xml = \*(Aq<foo attrib="1"><bish><bosh args="42">pub</bosh></bish></foo>\*(Aq;
\&
\&  # Do testing for attributes.
\&  like_xpath( $xml, \*(Aq/foo[@attrib="1"]\*(Aq ); # PASS
\&  # Find an element anywhere in the document.
\&  like_xpath( $xml, \*(Aq//bosh\*(Aq ); # PASS
\&  # Both.
\&  like_xpath( $xml, \*(Aq//bosh[@args="42"]\*(Aq ); # PASS
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module allows you to assert statements about your \s-1XML\s0 in the form
of XPath statements.  You can say that a piece of \s-1XML\s0 must contain
certain tags, with so-and-so attributes, etc.  It will try to use any
installed XPath module that it knows about.  Currently, this means
XML::LibXML and XML::XPath, in that order.
.PP
\&\fB\s-1NB\s0\fR: Normally in XPath processing, the statement occurs from a
\&\fIcontext\fR node.  In the case of \fIlike_xpath()\fR, the context node will
always be the root node.  In practice, this means that these two
statements are identical:
.PP
.Vb 4
\&   # Absolute path.
\&   like_xpath( \*(Aq<foo/>\*(Aq, \*(Aq/foo\*(Aq );
\&   # Path relative to root.
\&   like_xpath( \*(Aq<foo/>\*(Aq, \*(Aqfoo\*(Aq );
.Ve
.PP
It's probably best to use absolute paths everywhere in order to keep
things simple.
.PP
\&\fB\s-1NB\s0\fR: Beware of specifying attributes.  Because they use an @\-sign,
perl will complain about trying to interpolate arrays if you don't
escape them or use single quotes.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.IP "like_xpath ( \s-1XML\s0, \s-1XPATH\s0 [, \s-1NAME\s0 ] )" 4
.IX Item "like_xpath ( XML, XPATH [, NAME ] )"
Assert that \s-1XML\s0 (a string containing \s-1XML\s0) matches the statement
\&\s-1XPATH\s0.  \s-1NAME\s0 is the name of the test.
.Sp
Returns true or false depending upon test success.
.IP "unlike_xpath ( \s-1XML\s0, \s-1XPATH\s0 [, \s-1NAME\s0 ] )" 4
.IX Item "unlike_xpath ( XML, XPATH [, NAME ] )"
This is the reverse of \fIlike_xpath()\fR.  The test will only pass if \s-1XPATH\s0
\&\fIdoes not\fR generates any matches in \s-1XML\s0.
.Sp
Returns true or false depending upon test success.
.IP "is_xpath ( \s-1XML\s0, \s-1XPATH\s0, \s-1EXPECTED\s0 [, \s-1NAME\s0 ] )" 4
.IX Item "is_xpath ( XML, XPATH, EXPECTED [, NAME ] )"
Evaluates \s-1XPATH\s0 against \s-1XML\s0, and pass the test if the is \s-1EXPECTED\s0.  Uses
\&\fIfindvalue()\fR internally.
.Sp
Returns true or false depending upon test success.
.IP "set_xpath_processor ( \s-1CLASS\s0 )" 4
.IX Item "set_xpath_processor ( CLASS )"
Set the class name of the XPath processor used.  It is up to you to
ensure that this class is loaded.
.PP
In all cases, \s-1XML\s0 must be well formed, or the test will fail.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Test::XML.
.PP
XML::XPath, which is the basis for this module.
.PP
If you are not conversant with XPath, there are many tutorials
available on the web.  Google will point you at them.  The first one
that I saw was: <http://www.zvon.org/xxl/XPathTutorial/>, which
appears to offer interactive XPath as well as the tutorials.
.SH "AUTHOR"
.IX Header "AUTHOR"
Dominic Mitchell <cpan2 (at) semantico.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2002 by semantico
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.