{"id":6731,"date":"2022-12-20T19:33:32","date_gmt":"2022-12-20T22:33:32","guid":{"rendered":"http:\/\/lode.uno\/linux-man\/index.php\/2022\/12\/20\/xmlsax-man3\/"},"modified":"2022-12-20T19:33:32","modified_gmt":"2022-12-20T22:33:32","slug":"xmlsax-man3","status":"publish","type":"post","link":"https:\/\/lode.uno\/linux-man\/2022\/12\/20\/xmlsax-man3\/","title":{"rendered":"XML::SAX (man3)"},"content":{"rendered":"

XML::SAX<\/h1>\n

NAME<\/a>
SYNOPSIS<\/a>
DESCRIPTION<\/a>
USING A SAX2 PARSER<\/a>
WRITING A SAX2 PARSER<\/a>
EXPORTS<\/a>
AUTHOR<\/a>
LICENSE<\/a>
SEE ALSO<\/a> <\/p>\n

\n

NAME <\/a> <\/h2>\n

XML::SAX \u2212 Simple API for XML<\/p>\n

SYNOPSIS <\/a> <\/h2>\n

use XML::SAX;
# get a list of known parsers
my $parsers = XML::SAX\u2212>parsers();
# add\/update a parser
XML::SAX\u2212>add_parser(q(XML::SAX::PurePerl));
# remove parser
XML::SAX\u2212>remove_parser(q(XML::SAX::Foodelberry));
# save parsers
XML::SAX\u2212>save_parsers();<\/p>\n

DESCRIPTION <\/a> <\/h2>\n

XML::SAX<\/small> is a SAX<\/small> parser access API<\/small> for Perl. It includes classes and APIs required for implementing SAX<\/small> drivers, along with a factory class for returning any SAX<\/small> parser installed on the user\u2019s system.<\/p>\n

USING A SAX2 PARSER <\/a> <\/h2>\n

The factory class is XML::SAX::ParserFactory. Please see the documentation of that module for how to instantiate a SAX<\/small> parser: XML::SAX::ParserFactory. However if you don\u2019t want to load up another manual page, here\u2019s a short synopsis:<\/p>\n

use XML::SAX::ParserFactory;
use XML::SAX::XYZHandler;
my $handler = XML::SAX::XYZHandler\u2212>new();
my $p = XML::SAX::ParserFactory\u2212>parser(Handler => $handler);
$p\u2212>parse_uri(“foo.xml”);
# or $p\u2212>parse_string(““) or $p\u2212>parse_file($fh);<\/p>\n

This will automatically load a SAX2<\/small> parser (defaulting to XML::SAX::PurePerl if no others are found) and return it to you.<\/p>\n

In order to learn how to use SAX<\/small> to parse XML,<\/small> you will need to read XML::SAX::Intro and for reference, XML::SAX::Specification.<\/p>\n

WRITING A SAX2 PARSER <\/a> <\/h2>\n

The first thing to remember in writing a SAX2<\/small> parser is to subclass XML::SAX::Base. This will make your life infinitely easier, by providing a number of methods automagically for you. See XML::SAX::Base for more details.<\/p>\n

When writing a SAX2<\/small> parser that is compatible with XML::SAX,<\/small> you need to inform XML::SAX<\/small> of the presence of that driver when you install it. In order to do that, XML::SAX<\/small> contains methods for saving the fact that the parser exists on your system to a ” INI”<\/small> file, which is then loaded to determine which parsers are installed.<\/p>\n

The best way to do this is to follow these rules:<\/p>\n\n\n
<\/td>\n\n

\u2022<\/p>\n<\/td>\n

<\/td>\n\n

Add XML::SAX<\/small> as a prerequisite in Makefile.PL:<\/p>\n<\/td>\n

 <\/td>\n<\/tr>\n<\/table>\n

WriteMakefile(
…
PREREQ_PM => { ‘XML::SAX’ => 0 },
…
);<\/p>\n

Alternatively you may wish to check for it in other ways that will cause more than just a warning.<\/p>\n\n\n
<\/td>\n\n

\u2022<\/p>\n<\/td>\n

<\/td>\n\n

Add the following code snippet to your Makefile.PL:<\/p>\n<\/td>\n

 <\/td>\n<\/tr>\n<\/table>\n

sub MY::install {
package MY;
my $script = shift\u2212>SUPER::install(@_);
if (ExtUtils::MakeMaker::prompt(
“Do you want to modify ParserDetails.ini?”, ‘Y’)
=~ \/^y\/i) {
$script =~ s\/install :: (.*)$\/install :: $1 install_sax_driver\/m;
$script .= <<\"INSTALL\";
install_sax_driver :
t@$(PERL) \u2212MXML::SAX \u2212e “XML::SAX\u2212>add_parser(q($(NAME)))\u2212>save_parsers()”
INSTALL
}
return $script;
}<\/p>\n

Note that you should check the output of this \u2212 $( NAME<\/small> ) will use the name of your distribution, which may not be exactly what you want. For example XML::LibXML has a driver called XML::LibXML::SAX::Generator, which is used in place of $( NAME<\/small> ) in the above.<\/p>\n\n\n
<\/td>\n\n

\u2022<\/p>\n<\/td>\n

<\/td>\n\n

Add an XML::SAX<\/small> test:<\/p>\n<\/td>\n

 <\/td>\n<\/tr>\n<\/table>\n

A test file should be added to your t\/ directory containing something like the following:<\/p>\n

use Test;
BEGIN { plan tests => 3 }
use XML::SAX;
use XML::SAX::PurePerl::DebugHandler;
XML::SAX\u2212>add_parser(q(XML::SAX::MyDriver));
local $XML::SAX::ParserPackage = ‘XML::SAX::MyDriver’;
eval {
my $handler = XML::SAX::PurePerl::DebugHandler\u2212>new();
ok($handler);
my $parser = XML::SAX::ParserFactory\u2212>parser(Handler => $handler);
ok($parser);
ok($parser\u2212>isa(‘XML::SAX::MyDriver’);
$parser\u2212>parse_string(““);
ok($handler\u2212>{seen}{start_element});
};<\/p>\n

EXPORTS <\/a> <\/h2>\n

By default, XML::SAX<\/small> exports nothing into the caller\u2019s namespace. However you can request the symbols “Namespaces” and “Validation” which are the URIs for those features, allowing an easier way to request those features via ParserFactory:<\/p>\n

use XML::SAX qw(Namespaces Validation);
my $factory = XML::SAX::ParserFactory\u2212>new();
$factory\u2212>require_feature(Namespaces);
$factory\u2212>require_feature(Validation);
my $parser = $factory\u2212>parser();<\/p>\n

AUTHOR <\/a> <\/h2>\n

Current maintainer: Grant McLean, grantm@cpan.org<\/p>\n

Originally written by:<\/p>\n

Matt Sergeant, matt@sergeant.org<\/p>\n

Kip Hampton, khampton@totalcinema.com<\/p>\n

Robin Berjon, robin@knowscape.com<\/p>\n

LICENSE <\/a> <\/h2>\n

This is free software, you may use it and distribute it under the same terms as Perl itself.<\/p>\n

SEE ALSO <\/a> <\/h2>\n

XML::SAX::Base for writing SAX<\/small> Filters and Parsers<\/p>\n

XML::SAX::PurePerl for an XML<\/small> parser written in 100% pure perl.<\/p>\n

XML::SAX::Exception for details on exception handling<\/p>\n

\n","protected":false},"excerpt":{"rendered":"

XML::SAX \u2212 Simple API for XML <\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[3007,3105],"class_list":["post-6731","post","type-post","status-publish","format-standard","hentry","category-sin-categoria","tag-man3","tag-xmlsax"],"gutentor_comment":0,"_links":{"self":[{"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/posts\/6731","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/comments?post=6731"}],"version-history":[{"count":0,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/posts\/6731\/revisions"}],"wp:attachment":[{"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/media?parent=6731"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/categories?post=6731"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/tags?post=6731"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}