Linux Manual Pages

Free Software * Books

Source Code

Free Media

Linux

SAX

NAME
SYNOPSIS
DESCRIPTION
USING A SAX2 PARSER
WRITING A SAX2 PARSER
EXPORTS
AUTHOR
LICENSE
SEE ALSO

NAME

XML::SAX − Simple API for XML

SYNOPSIS

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

DESCRIPTION

XML::SAX is a SAX parser access API for Perl. It includes classes and APIs required for implementing SAX drivers, along with a factory class for returning any SAX parser installed on the user’s system.

USING A SAX2 PARSER

The factory class is XML::SAX::ParserFactory. Please see the documentation of that module for how to instantiate a SAX parser: XML::SAX::ParserFactory. However if you don’t want to load up another manual page, here’s a short synopsis:

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

This will automatically load a SAX2 parser (defaulting to XML::SAX::PurePerl if no others are found) and return it to you.

In order to learn how to use SAX to parse XML , you will need to read XML::SAX::Intro and for reference, XML::SAX::Specification.

WRITING A SAX2 PARSER

The first thing to remember in writing a SAX2 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.

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

The best way to do this is to follow these rules:

•

Add XML::SAX as a prerequisite in Makefile.PL:

  WriteMakefile(
      ...
      PREREQ_PM => { 'XML::SAX' => 0 },
      ...
  );

Alternatively you may wish to check for it in other ways that will cause more than just a warning.

•

Add the following code snippet to your Makefile.PL:

  sub MY::install {
    package MY;
    my $script = shift−>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) −MXML::SAX −e "XML::SAX−>add_parser(q(\$(NAME)))−>save_parsers()"
  INSTALL
    }
    return $script;
  }

Note that you should check the output of this − \$( NAME ) 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 ) in the above.

•

Add an XML::SAX test:

A test file should be added to your t/ directory containing something like the following:

  use Test;
  BEGIN { plan tests => 3 }
  use XML::SAX;
  use XML::SAX::PurePerl::DebugHandler;
  XML::SAX−>add_parser(q(XML::SAX::MyDriver));
  local $XML::SAX::ParserPackage = 'XML::SAX::MyDriver';
  eval {
    my $handler = XML::SAX::PurePerl::DebugHandler−>new();
    ok($handler);
    my $parser = XML::SAX::ParserFactory−>parser(Handler => $handler);
    ok($parser);
    ok($parser−>isa('XML::SAX::MyDriver');
    $parser−>parse_string("<tag/>");
    ok($handler−>{seen}{start_element});
  };

EXPORTS

By default, XML::SAX exports nothing into the caller’s 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:

  use XML::SAX qw(Namespaces Validation);
  my $factory = XML::SAX::ParserFactory−>new();
  $factory−>require_feature(Namespaces);
  $factory−>require_feature(Validation);
  my $parser = $factory−>parser();

AUTHOR

Current maintainer: Grant McLean, grantm@cpan.org

Originally written by:

Matt Sergeant, matt@sergeant.org

Kip Hampton, khampton@totalcinema.com

Robin Berjon, robin@knowscape.com

LICENSE

This is free software, you may use it and distribute it under the same terms as Perl itself.

Opportunity

Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.

Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.

Free Software

Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.

Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.

Free Books

The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.

Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.

Education

Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.

Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.