Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

xml::encoding(3pm) [debian man page]

XML::Encoding(3pm)					User Contributed Perl Documentation					XML::Encoding(3pm)

NAME

       XML::Encoding - A perl module for parsing XML encoding maps.

SYNOPSIS

	 use XML::Encoding;
	 my $em_parser = new XML::Encoding(ErrorContext  => 2,
					   ExpatRequired => 1,
					   PushPrefixFcn => &push_prefix,
					   PopPrefixFcn  => &pop_prefix,
					   RangeSetFcn	 => &range_set);

	 my $encmap_name = $em_parser->parsefile($ARGV[0]);

DESCRIPTION

       This module, which is built as a subclass of XML::Parser, provides a parser for encoding map files, which are XML files. The file
       maps/encmap.dtd in the distribution describes the structure of these files. Calling a parse method returns the name of the encoding map
       (obtained from the name attribute of the root element). The contents of the map are processed through the callback functions push_prefix,
       pop_prefix, and range_set.

METHODS

       This module provides no additional methods to those provided by XML::Parser, but it does take the following additional options.

       o   ExpatRequired

	   When this has a true value, then an error occurs unless the encmap "expat" attribute is set to "yes". Whether or not the ExpatRequired
	   option is given, the parser enters expat mode if this attribute is set. In expat mode, the parser checks if the encoding violates expat
	   restrictions.

       o   PushPrefixFcn

	   The corresponding value should be a code reference to be called when a prefix element starts. The single argument to the callback is an
	   integer which is the byte value of the prefix. An undef value should be returned if successful. If in expat mode, a defined value
	   causes an error and is used as the message string.

       o   PopPrefixFcn

	   The corresponding value should be a code reference to be called when a prefix element ends. No arguments are passed to this function.
	   An undef value should be returned if successful. If in expat mode, a defined value causes an error and is used as the message string.

       o   RangeSetFcn

	   The corresponding value should be a code reference to be called when a "range" or "ch" element is seen. The 3 arguments passed to this
	   function are: (byte, unicode_scalar, length) The byte is the starting byte of a range or the byte being mapped by a "ch" element. The
	   unicode_scalar is the Unicode value that this byte (with the current prefix) maps to. The length of the range is the last argument.
	   This will be 1 for the "ch" element. An undef value should be returned if successful. If in expat mode, a defined value causes an error
	   and is used as the message string.

AUTHOR

       Clark Cooper <coopercc@netheaven.com>

       Steve Hay <shay@cpan.org> is now maintaining XML::Encoding as of version 2.00

SEE ALSO

       XML::Parser

perl v5.12.3							    2010-09-20							XML::Encoding(3pm)

Check Out this Related Man Page

XML::DOM::ValParser(3)					User Contributed Perl Documentation				    XML::DOM::ValParser(3)

NAME

       XML::DOM::ValParser - an XML::DOM::Parser that validates at parse time

SYNOPSIS

	use XML::DOM::ValParser;

	my %expat_options = (KeepCDATA => 1,
			     Handlers => [ Unparsed => &my_Unparsed_handler ]);
	my $parser = new XML::DOM::ValParser (%expat_options);

	eval {
	    local $XML::Checker::FAIL = &my_fail;
	    my $doc = $parser->parsefile ("fail.xml");
	    ... XML::DOM::Document was created sucessfully ...
	};
	if ($@) {
	    # Either XML::Parser (expat) threw an exception or my_fail() died.
	    ... your error handling code here ...
	    # Note that the XML::DOM::Document is automatically disposed off and
	    # will be garbage collected
	}

	# Throws an exception (with die) when an error is encountered, this
	# will stop the parsing process.
	# Don't die if a warning or info message is encountered, just print a message.
	sub my_fail {
	    my $code = shift;
	    die XML::Checker::error_string ($code, @_) if $code < 200;
	    XML::Checker::print_error ($code, @_);
	}

DESCRIPTION

       Use XML::DOM::ValParser wherever you would use XML::DOM::Parser and your XML will be checked using XML::Checker at parse time.

       See XML::DOM for details on XML::DOM::Parser options.  See XML::Checker for details on setting the fail handler (my_fail.)

       The following handlers are currently supported, just like XML::DOM::Parser: Init, Final, Char, Start, End, Default, Doctype, CdataStart,
       CdataEnd, XMLDecl, Entity, Notation, Proc, Default, Comment, Attlist, Element, Unparsed.

XML
::DOM::ValParser
       XML::DOM::ValParser extends from XML::Checker::Parser. It creates an XML::Checker object and routes all event handlers through the checker,
       before processing the events to create the XML::DOM::Document.

       Just like XML::Checker::Parser, the checker object can be retrieved with the getChecker() method and can be reused later on (provided that
       the DOCTYPE section of the XML::DOM::Document did not change in the mean time.)

       You can control which errors are fatal (and therefore should stop creation of the XML::DOM::Document) by filtering the appropriate error
       codes in the global $XML::Checker::FAIL handler (see "ERROR_HANDLING" in XML::Checker) and calling die or croak appropriately.

       Just like XML::Checker::Parser, XML::DOM::ValParser supports the SkipExternalDTD and SkipInsignifWS options. See XML::Checker::Parser for
       details.

AUTHOR

       Send bug reports, hints, tips, suggestions to Enno Derksen at <enno@att.com>.

SEE ALSO

       XML::DOM, XML::Checker ("SEE_ALSO" in XML::Checker)

perl v5.8.0							    2000-01-31						    XML::DOM::ValParser(3)
Man Page