Perl Diver 2.31
Main Environment Variables Perl Default Values Perl Config - Summary Perl Config - Full Installed Modules List Directory uptime Docs

Module Documentation
Details and documentation about a specific module, including version and documentation (if available). Note that while links to perldoc.com and search.cpan.org are provided, the module may be part of a larger distribution. If you reach a File Not Found page on either site, please try the parent module.

XML::Parser::Lite

Name XML::Parser::Lite
Version 0.722
Located at /usr/local/share/perl5
File /usr/local/share/perl5/XML/Parser/Lite.pm
Is Core No
Search CPAN for this module XML::Parser::Lite
Documentation XML::Parser::Lite
Module Details XML::Parser::Lite

NAME

XML::Parser::Lite - Lightweight pure-perl XML Parser (based on regexps)


SYNOPSIS

  use XML::Parser::Lite;
  $p1 = new XML::Parser::Lite;
  $p1->setHandlers(
    Start => sub { shift; print "start: @_\n" },
    Char => sub { shift; print "char: @_\n" },
    End => sub { shift; print "end: @_\n" },
  );
  $p1->parse('<foo id="me">Hello World!</foo>');
  $p2 = new XML::Parser::Lite
    Handlers => {
      Start => sub { shift; print "start: @_\n" },
      Char => sub { shift; print "char: @_\n" },
      End => sub { shift; print "end: @_\n" },
    }
  ;
  $p2->parse('<foo id="me">Hello <bar>cruel</bar> World!</foo>');


DESCRIPTION

This module implements an XML parser with a interface similar to the XML::Parser manpage. Though not all callbacks are supported, you should be able to use it in the same way you use XML::Parser. Due to using experimental regexp features it'll work only on Perl 5.6 and above and may behave differently on different platforms.

Note that you cannot use regular expressions or split in callbacks. This is due to a limitation of perl's regular expression implementation (which is not re-entrant).


SUBROUTINES/METHODS

new

Constructor.

The new() method returns the object called on when called as object method. This behaviour was inherited from the SOAP::Lite manpage, which XML::Parser::Lite was split out from. This means that the following effectively is a no-op if $obj is a object:

 $obj = $obj->new();

New accepts a single named parameter, Handlers with a hash ref as value:

 my $parser = XML::Parser::Lite->new(
    Handlers => {
        Start => sub { shift; print "start: @_\n" },
        Char => sub { shift; print "char: @_\n" },
        End => sub { shift; print "end: @_\n" },
    }
 );

The handlers given will be passed to setHandlers.

setHandlers

Sets (or resets) the parsing handlers. Accepts a hash with the handler names and handler code references as parameters. Passing undef instead of a code reference replaces the handler by a no-op.

The following handlers can be set:

 Init
 Start
 Char
 End
 Final

All other handlers are ignored.

Calling setHandlers without parameters resets all handlers to no-ops.

parse

Parses the XML given. In contrast to XML::Parser's parse method, parse() only parses strings.


Handler methods

Init

Called before parsing starts. You should perform any necessary initializations in Init.

Start

Called at the start of each XML node. See the XML::Parser manpage for details.

Char

Called for each character sequence. May be called multiple times for the characters contained in an XML node (even for every single character). Your implementation has to make sure that it captures all characters.

End

Called at the end of each XML node. See the XML::Parser manpage for details

Comment

See the XML::Parser manpage for details

XMLDecl

See the XML::Parser manpage for details

Doctype

See the XML::Parser manpage for details

Final

Called at the end of the parsing process. You should perform any necessary cleanup here.


SEE ALSO

the XML::Parser manpage - a full-blown XML Parser, on which XML::Parser::Lite is based. Requires a C compiler and the expat XML parser.

the XML::Parser::LiteCopy manpage - a fork in the XML::Parser::Lite::Tree manpage.

YAX - another pure-perl module for XML parsing.

the XML::Parser::REX manpage - another module that parses XML with regular expressions.


COPYRIGHT

Copyright (C) 2000-2007 Paul Kulchenko. All rights reserved.

Copyright (C) 2008 Martin Kutter. All rights reserved.

Copyright (C) 2013-2015 Fred Moyer. All rights reserved.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

This parser is based on ``shallow parser'' http://www.cs.sfu.ca/~cameron/REX.html Copyright (c) 1998, Robert D. Cameron.


AUTHORS

Paul Kulchenko (paulclinger@yahoo.com)

Martin Kutter (martin.kutter@fen-net.de)

Fred Moyer (fred@redhotpenguin.com)

Additional handlers supplied by Adam Leggett.


CONTRIBUTORS

David Steinbrunner (dsteinbrunner@pobox.com)

Neil Bowers (neil@bowers.com)

Paul Cochrane (paul@liekut.de)

Perl Diver brought to you by ScriptSolutions.com © 1997- 2024