xml::quote(3pm) [debian man page]
Quote(3pm) User Contributed Perl Documentation Quote(3pm) NAME
XML::Quote - XML quote/dequote functions SYNOPSIS
use strict; use XML::Quote qw(:all); my $str=q{666 > 444 & "apple" < 'earth'}; print xml_quote($str)," "; # 666 > 444 & "apple" < 'earth' my $str2=q{666 > 444 & "apple" < 'earth'}; print xml_dequote($str2)," "; # 666 > 444 & "apple" < 'earth' my $str3=q{666 > 444 & "apple" < 'earth'}; print xml_quote_min($str3)," "; # 666 > 444 & "apple" < 'earth' DESCRIPTION
This module provides functions to quote/dequote strings in "xml"-way. All functions are written in XS and are very fast; they correctly process utf8, tied, overloaded variables and all the rest of perl "magic". FUNCTIONS
$quoted = xml_quote($str); This function replaces all occurences of symbols '&', '"', ''', '>', '<' to '&', '"', ''', '>', '<' respectively. Returns quoted string or undef if $str is undef. $dequoted = xml_dequote($str); This function replaces all occurences of '&', '"', ''', '>', '<' to '&', '"', ''', '>', '<' respectively. All other entities (for example ) will not be touched. Returns dequoted string or undef if $str is undef. $quoted = xml_quote_min($str); This function replaces all occurences of symbols '&', '"', '<' to '&', '"', '<' respectively. Symbols ''' and '>' are not replaced. Returns quoted string or undef if $str is undef. EXPORT
xml_quote(), xml_dequote() are exported as default. PERFORMANCE
You can use t/benchmark.pl to test the perfomance. Here is the result on my P4 box. Benchmark: timing 1000000 iterations of perl quote, xs quote... perl quote: 108 wallclock secs (88.08 usr + 0.01 sys = 88.09 CPU) @ 11351.64/s (n=1000000) xs quote: 20 wallclock secs (16.78 usr + 0.00 sys = 16.78 CPU) @ 59591.20/s (n=1000000) Benchmark: timing 1000000 iterations of perl dequote, xs dequote... perl dequote: 106 wallclock secs (85.22 usr + 0.09 sys = 85.31 CPU) @ 11721.54/s (n=1000000) xs dequote: 19 wallclock secs (15.92 usr + 0.02 sys = 15.94 CPU) @ 62743.13/s (n=1000000) AUTHOR
Sergey Skvortsov <skv@protey.ru> SEE ALSO
http://www.w3.org/TR/REC-xml <http://www.w3.org/TR/REC-xml>, perlre COPYRIGHT
Copyright 2003 Sergey Skvortsov <skv@protey.ru>. All rights reserved. This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. perl v5.14.2 2008-06-26 Quote(3pm)
Check Out this Related Man Page
HTML::Entities::Numbered(3pm) User Contributed Perl Documentation HTML::Entities::Numbered(3pm) NAME
HTML::Entities::Numbered - Conversion of numbered HTML entities SYNOPSIS
use HTML::Entities::Numbered; $html = 'Hi Honey<b>♥</b>'; # convert named HTML entities to numbered (decimal) $decimal = name2decimal($html); # Hi Honey<b>♥</b> # to numbered (hexadecimal) $hex = name2hex($html); # Hi Honey<b>♥</b> $content = 'Copyright © Larry Wall'; # convert numbered HTML entities (decimal) to named $name1 = decimal2name($content); # Copyright © Larry Wall $content = 'Copyright © Larry Wall'; # convert numbered HTML entitites (hexadecimal) to named $name2 = hex2name($content); # Copyright © Larry Wall $xml = '"Give me ¥10,000" > cherie♠'; # convert named HTML entities to numbered # except valid XML entities (decimal) $decimal = name2decimal_xml($xml); # "Give me ¥10,000" # > cherie♠ # to numbered except valid XML entities (hexdecimal) $hex = name2hex_xml($xml); # "Give me ¥10,000" # > cherie♠ DESCRIPTION
HTML::Entities::Numbered is a content conversion filter for named HTML entities (symbols, mathmetical symbols, Greek letters, Latin let- ters, etc.). When an argument of "name2decimal()" or "name2hex()" contains some nameable HTML entities, they will be replaced to numbered HTML entities. And when an argument of "name2decimal_xml()" or "name2hex_xml()" contains some nameable numbered HTML entities, they will be replaced to numbered HTML entities except valid XML entities (the excepted "valid XML entities" are the following five entities: "<", ">", "&", """, "'"). By the same token, when an argument of "decimal2name()" or "hex2name()" contains some nameable num- bered HTML entities, they will be replaced to named HTML entities. (the exception "valid XML entities" means the following five entities: "<", ">", "&", """, "'") On version 0.03, the entities hash table is imported from HTML::Entities (with obsolete class "HTML::Entities::Numbered::Extra" for older releases of Perl). At the moment, 0.04 (or later) is included HTML::Entities::Numbered::Table to import HTML entities table, and thereby we do not need to have HTML::Entities (included in HTML::Parser distribution). This may be also useful for making valid XML (corrects the undefined entity references, and enhanced by addition of functions conform to the XML). FUNCTIONS
Following all functions are exported by default. * name2decimal Some included named HTML entities in argument of "name2decimal()" will be replaced to decimal numbered HTML entities. * name2hex Some included named HTML entities in argument of "name2hex()" will be replaced to hexadecimal numbered HTML entities. * decimal2name Some include decimal numbered HTML entities in argument of "decimal2name()" will be replaced to named HTML entities (If they're name- able). * hex2name Some include hexadecimal numbered HTML entities in argument of "hex2name()" will be replaced to named HTML entities (If they're name- able). * name2decimal_xml Some included named HTML entities in argument of "name2decimal_xml()" will be replaced to decimal numbered HTML entities except valid XML entities. * name2hex_xml Some included named HTML entities in argument of "name2hex_xml()" will be replaced to hexadecimal numbered HTML entities except valid XML entities. If you'd prefer not to import them functions into the caller's namespace, you can call them as below: use HTML::Entities::Numbered (); $decimal = HTML::Entities::Numbered::name2decimal($str); $hex = HTML::Entities::Numbered::name2hex($str); $named1 = HTML::Entities::Numbered::decimal2name($str); $named2 = HTML::Entities::Numbered::hex2name($str); $decimal = HTML::Entities::Numbered::name2decimal_xml($str); $hex = HTML::Entities::Numbered::name2hex_xml($str); AUTHOR
Koichi Taniguchi <taniguchi@livedoor.jp> Develop triggered by IKEBE Tomohiro <ikebe@cpan.org> Many thanks to Tatsuhiko Miyagawa <miyagawa@cpan.org> COPYRIGHT
Copyright (c) 2004 Koichi Taniguchi. Japan. All rights reserved. This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. SEE ALSO
HTML::Entities, <http://www.w3.org/TR/REC-html40/sgml/entities.html> perl v5.8.8 2008-03-06 HTML::Entities::Numbered(3pm)