.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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::Handler::Subs 3"
.TH XML::Handler::Subs 3 2024-07-12 "perl v5.38.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
XML::Handler::Subs \- a PerlSAX handler base class for calling user\-defined subs
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& use XML::Handler::Subs;
\&
\& package MyHandlers;
\& use vars qw{ @ISA };
\&
\& sub s_NAME { my ($self, $element) = @_ };
\& sub e_NAME { my ($self, $element) = @_ };
\&
\& $self\->{Names};    # an array of names
\& $self\->{Nodes};    # an array of $element nodes
\&
\& $handler = MyHandlers\->new();
\& $self\->in_element($name);
\& $self\->within_element($name);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\f(CW\*(C`XML::Handler::Subs\*(C'\fR is a base class for PerlSAX handlers.
\&\f(CW\*(C`XML::Handler::Subs\*(C'\fR is subclassed to implement complete behavior and
to add element-specific handling.
.PP
Each time an element starts, a method by that name prefixed with `s_'
is called with the element to be processed.  Each time an element
ends, a method with that name prefixed with `e_' is called.  Any
special characters in the element name are replaced by underscores.
.PP
Subclassing XML::Handler::Subs in this way is similar to
XML::Parser's Subs style.
.PP
XML::Handler::Subs maintains a stack of element names,
`\f(CW\*(C`$self\-\*(C'\fR{Names}', and a stack of element nodes, `\f(CW\*(C`$self\-\*(C'\fR{Nodes}>'
that can be used by subclasses.  The current element is pushed on the
stacks before calling an element-name start method and popped off the
stacks after calling the element-name end method.  The
`\f(CWin_element()\fR' and `\f(CWwithin_element()\fR' calls use these stacks.
.PP
If the subclass implements `\f(CWstart_document()\fR', `\f(CWend_document()\fR',
`\f(CWstart_element()\fR', and `\f(CWend_element()\fR', be sure to use
`\f(CW\*(C`SUPER::\*(C'\fR' to call the the superclass methods also.  See \fBperlobj\fR\|(1)
for details on SUPER::.  `\f(CWSUPER::start_element()\fR' and
`\f(CWSUPER::end_element()\fR' return 1 if an element-name method is
called, they return 0 if no method was called.
.PP
XML::Handler::Subs does not implement any other PerlSAX handlers.
.PP
XML::Handler::Subs supports the following methods:
.IP "new( \fIOPTIONS\fR )" 4
.IX Item "new( OPTIONS )"
A basic `\f(CWnew()\fR' method.  `\f(CWnew()\fR' takes a list of key, value
pairs or a hash and creates and returns a hash with those options; the
hash is blessed into the subclass.
.IP in_element($name) 4
.IX Item "in_element($name)"
Returns true if `\f(CW$name\fR' is equal to the name of the innermost
currently opened element.
.IP within_element($name) 4
.IX Item "within_element($name)"
Returns the number of times the `\f(CW$name\fR' appears in Names.
.SH AUTHOR
.IX Header "AUTHOR"
Ken MacLeod, ken@bitsko.slc.ut.us
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBperl\fR\|(1), \fBPerlSAX.pod\fR\|(3)