Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

xml::sax::expatxs(3pm) [debian man page]

XML::SAX::ExpatXS(3pm)					User Contributed Perl Documentation				    XML::SAX::ExpatXS(3pm)

NAME
XML::SAX::ExpatXS - Perl SAX 2 XS extension to Expat parser SYNOPSIS
use XML::SAX::ExpatXS; $handler = MyHandler->new(); $parser = XML::SAX::ExpatXS->new( Handler => $handler ); $parser->parse_uri($uri); #or $parser->parse_string($xml); DESCRIPTION
XML::SAX::ExpatXS is a direct XS extension to Expat XML parser. It implements Perl SAX 2.1 interface. See http://perl-xml.sourceforge.net/perl-sax/ for Perl SAX API description. Any deviations from the Perl SAX 2.1 specification are considered as bugs. Features The parser behavior can be changed by setting features. $parser->set_feature(FEATURE, VALUE); XML::SAX::ExpatXS provides these adjustable features: "http://xmlns.perl.org/sax/join-character-data" Consequent character data are joined (1, default) or not(0). "http://xmlns.perl.org/sax/ns-attributes" Namespace attributes are reported as common attributes (1, default) or not(0). "http://xmlns.perl.org/sax/xmlns-uris" When set on, xmlns and xmlns:* attributes are put into namespaces in a Perl SAX traditional way; xmlns attributes are in no namespace while xmlns:* attributes are in the "http://www.w3.org/2000/xmlns/" namespace. This feature is set to 1 by default. "http://xml.org/sax/features/xmlns-uris" This feature applies if and only if the "http://xmlns.perl.org/sax/xmlns-uris" feature is off. Then, xmlns and xmlns:* attributes are both put into no namespace (0, default) or into "http://www.w3.org/2000/xmlns/" namespace(1). "http://xmlns.perl.org/sax/locator" The document locator is updated (1, default) for ContentHadler events or not(0). "http://xmlns.perl.org/sax/recstring" A recognized string (the text string currently processed by this XML parser) is either maintained as $parser->{ParseOptions}{RecognizedString} (1) or not (0, default). "http://xml.org/sax/features/external-general-entities" Controls whether this parser processes external general entities (1, default) or not(0). "http://xml.org/sax/features/external-parameter-entities" Controls whether this parser processes external parameter entities including an external DTD subset(1) or not (0, default). Constructor Options Apart from features, the behavior of this parser can also be changed with options to the constructor. ParseParamEnt ParseParamEnt => 1 This option meaning is exactly the same as the "http://xml.org/sax/features/external-parameter-entities" feature. The option is supported only because of the compatibility with older versions of this module. Turned off by default. NoExpand NoExpand => 1 No internal entities are expanded if this option is turned on. Turned off by default. Read-only Properties ExpatVersion This property returns a version of linked Expat library, for example expat_1.95.7. AUTHORS
Petr Cimprich <petr AT gingerall DOT org> (maintainer) Matt Sergeant <matt AT sergeant DOT org> perl v5.14.2 2011-04-12 XML::SAX::ExpatXS(3pm)

Check Out this Related Man Page

SAX::ParserFactory(3pm) 				User Contributed Perl Documentation				   SAX::ParserFactory(3pm)

NAME
XML::SAX::ParserFactory - Obtain a SAX parser 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); DESCRIPTION
XML::SAX::ParserFactory is a factory class for providing an application with a Perl SAX2 XML parser. It is akin to DBI - a front end for other parser classes. Each new SAX2 parser installed will register itself with XML::SAX, and then it will become available to all applications that use XML::SAX::ParserFactory to obtain a SAX parser. Unlike DBI however, XML/SAX parsers almost all work alike (especially if they subclass XML::SAX::Base, as they should), so rather than specifying the parser you want in the call to "parser()", XML::SAX has several ways to automatically choose which parser to use: o $XML::SAX::ParserPackage If this package variable is set, then this package is "require()"d and an instance of this package is returned by calling the "new()" class method in that package. If it cannot be loaded or there is an error, an exception will be thrown. The variable can also contain a version number: $XML::SAX::ParserPackage = "XML::SAX::Expat (0.72)"; And the number will be treated as a minimum version number. o Required features It is possible to require features from the parsers. For example, you may wish for a parser that supports validation via a DTD. To do that, use the following code: use XML::SAX::ParserFactory; my $factory = XML::SAX::ParserFactory->new(); $factory->require_feature('http://xml.org/sax/features/validation'); my $parser = $factory->parser(...); Alternatively, specify the required features in the call to the ParserFactory constructor: my $factory = XML::SAX::ParserFactory->new( RequiredFeatures => { 'http://xml.org/sax/features/validation' => 1, } ); If the features you have asked for are unavailable (for example the user might not have a validating parser installed), then an exception will be thrown. The list of known parsers is searched in reverse order, so it will always return the last installed parser that supports all of your requested features (Note: this is subject to change if someone comes up with a better way of making this work). o SAX.ini ParserFactory will search @INC for a file called SAX.ini, which is in a simple format: # a comment looks like this, ; or like this, and are stripped anywhere in the file key = value # SAX.in contains key/value pairs. All whitespace is non-significant. This file can contain either a line: ParserPackage = MyParserModule (1.02) Where MyParserModule is the module to load and use for the parser, and the number in brackets is a minimum version to load. Or you can list required features: http://xml.org/sax/features/validation = 1 And each feature with a true value will be required. o Fallback If none of the above works, the last parser installed on the user's system will be used. The XML::SAX package ships with a pure perl XML parser, XML::SAX::PurePerl, so that there will always be a fallback parser. AUTHOR
Matt Sergeant, matt@sergeant.org LICENSE
This is free software, you may use it and distribute it under the same terms as Perl itself. perl v5.14.2 2009-10-10 SAX::ParserFactory(3pm)
Man Page