NAME

       XML::Grove::PerlSAX - an PerlSAX event interface for XML objects

SYNOPSIS

        use XML::Grove::PerlSAX;

        $parser = XML::Grove::PerlSAX->new( [OPTIONS] );
        $result = $parser->parse( [OPTIONS] );

        # or
        $result = $xml_object->parse( [OPTIONS] );

DESCRIPTION

       "XML::Grove::PerlSAX" is a PerlSAX parser that generates PerlSAX events from XML::Grove objects.  This
       man page summarizes the specific options, handlers, and properties supported by "XML::Grove::PerlSAX";
       please refer to the PerlSAX standard in `"PerlSAX.pod"' for general usage information.

METHODS

       new Creates  a  new parser object.  Default options for parsing, described below, are passed as key-value
           pairs or as a single hash.  Options may be changed  directly  in  the  parser  object  unless  stated
           otherwise.   Options  passed to `"parse()"' override the default options in the parser object for the
           duration of the parse.

       parse
           Parses a document.  Options, described below, are passed as key-value pairs  or  as  a  single  hash.
           Options passed to `"parse()"' override default options in the parser object.

OPTIONS

       The following options are supported by "XML::Grove::PerlSAX":

        Handler          default handler to receive events
        DocumentHandler  handler to receive document events
        Source           hash containing the input source for parsing

       If no handlers are provided then all events will be silently ignored.

       If  a  single grove argument is passed to the `"parse()"' method, it is treated as if a `"Source"' option
       was given with a `"Grove"' parameter.

       The `"Source"' hash may contain the following parameters:

        Grove            The grove object used to generate parse events..

HANDLERS

       The  following  events  are  generated  by   "XML::Grove::PerlSAX".    XML::Grove::PerlSAX   passes   the
       corresponding  grove object as it's parameter so the properties passed to the handler are those that were
       used to create or were assigned to the grove.  Please see the docs for the  parser  used  to  create  the
       grove for a list of properties that were provided.

   DocumentHandler methods
       start_document
           Receive  notification  of  the beginning of a document.  This is called from the XML::Grove::Document
           object before processing any document content.

       end_document
           Receive notification of the end of a document.  This is called from the  XML::Grove::Document  object
           after processing all document content.

       start_element
           Receive  notification  of  the  beginning of an element.  This is called from the XML::Grove::Element
           object before processing any element content.

       end_element
           Receive notification of the end of an element.  This is called from  the  XML::Grove::Element  object
           after processing all element content.

       characters
           Receive notification of character data.  This is called from the XML::Grove::Characters object.

       processing_instruction
           Receive notification of a processing instruction.  This is called from the XML::Grove::PI object.

       comment
           Receive notification of a comment.  This is called from the XML::Grove::Comment object.

AUTHOR

       Ken MacLeod, ken@bitsko.slc.ut.us

SEE ALSO

       perl(1), XML::Grove(3)

       Extensible Markup Language (XML) <http://www.w3c.org/XML>

perl v5.36.0                                       2022-11-29                           XML::Grove::PerlSAX(3pm)