.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\" ========================================================================
.de Sh \" Subsection heading
.de Sp \" Vertical space (when we can't use .PP)
.de Vb \" Begin verbatim text
.de Ve \" End verbatim text
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. | will give a
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
. tm Index:\\$1\t\\n%\t"\\$2"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. \" simple accents for nroff and troff
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
.\" ========================================================================
.IX Title "Unicode::Normalize 3"
.TH Unicode::Normalize 3 "2001-09-21" "perl v5.8.8" "Perl Programmers Reference Guide"
Unicode::Normalize \- Unicode Normalization Forms
(1) using function names exported by default:
\& use Unicode::Normalize;
\& $NFD_string = NFD($string); # Normalization Form D
\& $NFC_string = NFC($string); # Normalization Form C
\& $NFKD_string = NFKD($string); # Normalization Form KD
\& $NFKC_string = NFKC($string); # Normalization Form KC
(2) using function names exported on request:
\& use Unicode::Normalize 'normalize';
\& $NFD_string = normalize('D', $string); # Normalization Form D
\& $NFC_string = normalize('C', $string); # Normalization Form C
\& $NFKD_string = normalize('KD', $string); # Normalization Form KD
\& $NFKC_string = normalize('KC', $string); # Normalization Form KC
\&\f(CW$string\fR is used as a string under character semantics
\&\f(CW$codepoint\fR should be an unsigned integer
representing a Unicode code point.
Note: Between \s-1XSUB\s0 and pure Perl, there is an incompatibility
about the interpretation of \f(CW$codepoint\fR as a decimal number.
\&\s-1XSUB\s0 converts \f(CW$codepoint\fR to an unsigned integer, but pure Perl does not.
Do not use a floating point nor a negative sign in \f(CW$codepoint\fR.
.Sh "Normalization Forms"
.IX Subsection "Normalization Forms"
.ie n .IP """$NFD_string = NFD($string)""" 4
.el .IP "\f(CW$NFD_string = NFD($string)\fR" 4
.IX Item "$NFD_string = NFD($string)"
returns the Normalization Form D (formed by canonical decomposition).
.ie n .IP """$NFC_string = NFC($string)""" 4
.el .IP "\f(CW$NFC_string = NFC($string)\fR" 4
.IX Item "$NFC_string = NFC($string)"
returns the Normalization Form C (formed by canonical decomposition
followed by canonical composition).
.ie n .IP """$NFKD_string = NFKD($string)""" 4
.el .IP "\f(CW$NFKD_string = NFKD($string)\fR" 4
.IX Item "$NFKD_string = NFKD($string)"
returns the Normalization Form \s-1KD\s0 (formed by compatibility decomposition).
.ie n .IP """$NFKC_string = NFKC($string)""" 4
.el .IP "\f(CW$NFKC_string = NFKC($string)\fR" 4
.IX Item "$NFKC_string = NFKC($string)"
returns the Normalization Form \s-1KC\s0 (formed by compatibility decomposition
followed by \fBcanonical\fR composition).
.ie n .IP """$FCD_string = FCD($string)""" 4
.el .IP "\f(CW$FCD_string = FCD($string)\fR" 4
.IX Item "$FCD_string = FCD($string)"
If the given string is in \s-1FCD\s0 (\*(L"Fast C or D\*(R" form; cf. \s-1UTN\s0 #5),
returns it without modification; otherwise returns an \s-1FCD\s0 string.
Note: \s-1FCD\s0 is not always unique, then plural forms may be equivalent
each other. \f(CW\*(C`FCD()\*(C'\fR will return one of these equivalent forms.
.ie n .IP """$FCC_string = FCC($string)""" 4
.el .IP "\f(CW$FCC_string = FCC($string)\fR" 4
.IX Item "$FCC_string = FCC($string)"
returns the \s-1FCC\s0 form (\*(L"Fast C Contiguous\*(R"; cf. \s-1UTN\s0 #5).
Note: \s-1FCC\s0 is unique, as well as four normalization forms (NF*).
.ie n .IP """$normalized_string = normalize($form_name, $string)""" 4
.el .IP "\f(CW$normalized_string = normalize($form_name, $string)\fR" 4
.IX Item "$normalized_string = normalize($form_name, $string)"
As \f(CW$form_name\fR, one of the following names must be given.
\& 'C' or 'NFC' for Normalization Form C (UAX #15)
\& 'D' or 'NFD' for Normalization Form D (UAX #15)
\& 'KC' or 'NFKC' for Normalization Form KC (UAX #15)
\& 'KD' or 'NFKD' for Normalization Form KD (UAX #15)
\& 'FCD' for "Fast C or D" Form (UTN #5)
\& 'FCC' for "Fast C Contiguous" (UTN #5)
.Sh "Decomposition and Composition"
.IX Subsection "Decomposition and Composition"
.ie n .IP """$decomposed_string = decompose($string)""" 4
.el .IP "\f(CW$decomposed_string = decompose($string)\fR" 4
.IX Item "$decomposed_string = decompose($string)"
.ie n .IP """$decomposed_string = decompose($string, $useCompatMapping)""" 4
.el .IP "\f(CW$decomposed_string = decompose($string, $useCompatMapping)\fR" 4
.IX Item "$decomposed_string = decompose($string, $useCompatMapping)"
Decomposes the specified string and returns the result.
If the second parameter (a boolean) is omitted or false, decomposes it
using the Canonical Decomposition Mapping.
If true, decomposes it using the Compatibility Decomposition Mapping.
The string returned is not always in \s-1NFD/NFKD\s0.
Reordering may be required.
\& $NFD_string = reorder(decompose($string)); # eq. to NFD()
\& $NFKD_string = reorder(decompose($string, TRUE)); # eq. to NFKD()
.ie n .IP """$reordered_string = reorder($string)""" 4
.el .IP "\f(CW$reordered_string = reorder($string)\fR" 4
.IX Item "$reordered_string = reorder($string)"
Reorders the combining characters and the like in the canonical ordering
E.g., when you have a list of \s-1NFD/NFKD\s0 strings,
you can get the concatenated \s-1NFD/NFKD\s0 string from them, saying
\& $concat_NFD = reorder(join '', @NFD_strings);
\& $concat_NFKD = reorder(join '', @NFKD_strings);
.ie n .IP """$composed_string = compose($string)""" 4
.el .IP "\f(CW$composed_string = compose($string)\fR" 4
.IX Item "$composed_string = compose($string)"
Returns the string where composable pairs are composed.
E.g., when you have a \s-1NFD/NFKD\s0 string,
you can get its \s-1NFC/NFKC\s0 string, saying
\& $NFC_string = compose($NFD_string);
\& $NFKC_string = compose($NFKD_string);
.IX Subsection "Quick Check"
(see Annex 8, \s-1UAX\s0 #15; and \fIDerivedNormalizationProps.txt\fR)
The following functions check whether the string is in that normalization form.
The result returned will be:
\& YES The string is in that normalization form.
\& NO The string is not in that normalization form.
\& MAYBE Dubious. Maybe yes, maybe no.
.ie n .IP """$result = checkNFD($string)""" 4
.el .IP "\f(CW$result = checkNFD($string)\fR" 4
.IX Item "$result = checkNFD($string)"
returns true (\f(CW1\fR) if \f(CW\*(C`YES\*(C'\fR; false (\f(CW\*(C`empty string\*(C'\fR) if \f(CW\*(C`NO\*(C'\fR.
.ie n .IP """$result = checkNFC($string)""" 4
.el .IP "\f(CW$result = checkNFC($string)\fR" 4
.IX Item "$result = checkNFC($string)"
returns true (\f(CW1\fR) if \f(CW\*(C`YES\*(C'\fR; false (\f(CW\*(C`empty string\*(C'\fR) if \f(CW\*(C`NO\*(C'\fR;
\&\f(CW\*(C`undef\*(C'\fR if \f(CW\*(C`MAYBE\*(C'\fR.
.ie n .IP """$result = checkNFKD($string)""" 4
.el .IP "\f(CW$result = checkNFKD($string)\fR" 4
.IX Item "$result = checkNFKD($string)"
returns true (\f(CW1\fR) if \f(CW\*(C`YES\*(C'\fR; false (\f(CW\*(C`empty string\*(C'\fR) if \f(CW\*(C`NO\*(C'\fR.
.ie n .IP """$result = checkNFKC($string)""" 4
.el .IP "\f(CW$result = checkNFKC($string)\fR" 4
.IX Item "$result = checkNFKC($string)"
returns true (\f(CW1\fR) if \f(CW\*(C`YES\*(C'\fR; false (\f(CW\*(C`empty string\*(C'\fR) if \f(CW\*(C`NO\*(C'\fR;
\&\f(CW\*(C`undef\*(C'\fR if \f(CW\*(C`MAYBE\*(C'\fR.
.ie n .IP """$result = checkFCD($string)""" 4
.el .IP "\f(CW$result = checkFCD($string)\fR" 4
.IX Item "$result = checkFCD($string)"
returns true (\f(CW1\fR) if \f(CW\*(C`YES\*(C'\fR; false (\f(CW\*(C`empty string\*(C'\fR) if \f(CW\*(C`NO\*(C'\fR.
.ie n .IP """$result = checkFCC($string)""" 4
.el .IP "\f(CW$result = checkFCC($string)\fR" 4
.IX Item "$result = checkFCC($string)"
returns true (\f(CW1\fR) if \f(CW\*(C`YES\*(C'\fR; false (\f(CW\*(C`empty string\*(C'\fR) if \f(CW\*(C`NO\*(C'\fR;
\&\f(CW\*(C`undef\*(C'\fR if \f(CW\*(C`MAYBE\*(C'\fR.
If a string is not in \s-1FCD\s0, it must not be in \s-1FCC\s0.
So \f(CW\*(C`checkFCC($not_FCD_string)\*(C'\fR should return \f(CW\*(C`NO\*(C'\fR.
.ie n .IP """$result = check($form_name, $string)""" 4
.el .IP "\f(CW$result = check($form_name, $string)\fR" 4
.IX Item "$result = check($form_name, $string)"
returns true (\f(CW1\fR) if \f(CW\*(C`YES\*(C'\fR; false (\f(CW\*(C`empty string\*(C'\fR) if \f(CW\*(C`NO\*(C'\fR;
\&\f(CW\*(C`undef\*(C'\fR if \f(CW\*(C`MAYBE\*(C'\fR.
As \f(CW$form_name\fR, one of the following names must be given.
\& 'C' or 'NFC' for Normalization Form C (UAX #15)
\& 'D' or 'NFD' for Normalization Form D (UAX #15)
\& 'KC' or 'NFKC' for Normalization Form KC (UAX #15)
\& 'KD' or 'NFKD' for Normalization Form KD (UAX #15)
\& 'FCD' for "Fast C or D" Form (UTN #5)
\& 'FCC' for "Fast C Contiguous" (UTN #5)
In the cases of \s-1NFD\s0, \s-1NFKD\s0, and \s-1FCD\s0, the answer must be
either \f(CW\*(C`YES\*(C'\fR or \f(CW\*(C`NO\*(C'\fR. The answer \f(CW\*(C`MAYBE\*(C'\fR may be returned
in the cases of \s-1NFC\s0, \s-1NFKC\s0, and \s-1FCC\s0.
A \f(CW\*(C`MAYBE\*(C'\fR string should contain at least one combining character
or the like. For example, \f(CW\*(C`COMBINING ACUTE ACCENT\*(C'\fR has
the \s-1MAYBE_NFC/MAYBE_NFKC\s0 property.
Both \f(CW\*(C`checkNFC("A\eN{COMBINING ACUTE ACCENT}")\*(C'\fR
and \f(CW\*(C`checkNFC("B\eN{COMBINING ACUTE ACCENT}")\*(C'\fR will return \f(CW\*(C`MAYBE\*(C'\fR.
\&\f(CW"A\eN{COMBINING ACUTE ACCENT}"\fR is not in \s-1NFC\s0
(its \s-1NFC\s0 is \f(CW"\eN{LATIN CAPITAL LETTER A WITH ACUTE}"\fR),
while \f(CW"B\eN{COMBINING ACUTE ACCENT}"\fR is in \s-1NFC\s0.
If you want to check exactly, compare the string with its \s-1NFC/NFKC/FCC\s0.
\& if ($string eq NFC($string)) {
\& # $string is exactly normalized in NFC;
\& # $string is not normalized in NFC;
\& if ($string eq NFKC($string)) {
\& # $string is exactly normalized in NFKC;
\& # $string is not normalized in NFKC;
.IX Subsection "Character Data"
These functions are interface of character data used internally.
If you want only to get Unicode normalization forms, you don't need
.ie n .IP """$canonical_decomposed = getCanon($codepoint)""" 4
.el .IP "\f(CW$canonical_decomposed = getCanon($codepoint)\fR" 4
.IX Item "$canonical_decomposed = getCanon($codepoint)"
If the character of the specified codepoint is canonically
decomposable (including Hangul Syllables),
returns the \fBcompletely decomposed\fR string canonically equivalent to it.
If it is not decomposable, returns \f(CW\*(C`undef\*(C'\fR.
.ie n .IP """$compatibility_decomposed = getCompat($codepoint)""" 4
.el .IP "\f(CW$compatibility_decomposed = getCompat($codepoint)\fR" 4
.IX Item "$compatibility_decomposed = getCompat($codepoint)"
If the character of the specified codepoint is compatibility
decomposable (including Hangul Syllables),
returns the \fBcompletely decomposed\fR string compatibility equivalent to it.
If it is not decomposable, returns \f(CW\*(C`undef\*(C'\fR.
.ie n .IP """$codepoint_composite = getComposite($codepoint_here, $codepoint_next)""" 4
.el .IP "\f(CW$codepoint_composite = getComposite($codepoint_here, $codepoint_next)\fR" 4
.IX Item "$codepoint_composite = getComposite($codepoint_here, $codepoint_next)"
If two characters here and next (as codepoints) are composable
(including Hangul Jamo/Syllables and Composition Exclusions),
returns the codepoint of the composite.
If they are not composable, returns \f(CW\*(C`undef\*(C'\fR.
.ie n .IP """$combining_class = getCombinClass($codepoint)""" 4
.el .IP "\f(CW$combining_class = getCombinClass($codepoint)\fR" 4
.IX Item "$combining_class = getCombinClass($codepoint)"
Returns the combining class of the character as an integer.
.ie n .IP """$is_exclusion = isExclusion($codepoint)""" 4
.el .IP "\f(CW$is_exclusion = isExclusion($codepoint)\fR" 4
.IX Item "$is_exclusion = isExclusion($codepoint)"
Returns a boolean whether the character of the specified codepoint
is a composition exclusion.
.ie n .IP """$is_singleton = isSingleton($codepoint)""" 4
.el .IP "\f(CW$is_singleton = isSingleton($codepoint)\fR" 4
.IX Item "$is_singleton = isSingleton($codepoint)"
Returns a boolean whether the character of the specified codepoint is
.ie n .IP """$is_non_starter_decomposition = isNonStDecomp($codepoint)""" 4
.el .IP "\f(CW$is_non_starter_decomposition = isNonStDecomp($codepoint)\fR" 4
.IX Item "$is_non_starter_decomposition = isNonStDecomp($codepoint)"
Returns a boolean whether the canonical decomposition
of the character of the specified codepoint
is a Non-Starter Decomposition.
.ie n .IP """$may_be_composed_with_prev_char = isComp2nd($codepoint)""" 4
.el .IP "\f(CW$may_be_composed_with_prev_char = isComp2nd($codepoint)\fR" 4
.IX Item "$may_be_composed_with_prev_char = isComp2nd($codepoint)"
Returns a boolean whether the character of the specified codepoint
may be composed with the previous one in a certain composition
(including Hangul Compositions, but excluding
Composition Exclusions and Non-Starter Decompositions).
\&\f(CW\*(C`NFC\*(C'\fR, \f(CW\*(C`NFD\*(C'\fR, \f(CW\*(C`NFKC\*(C'\fR, \f(CW\*(C`NFKD\*(C'\fR: by default.
\&\f(CW\*(C`normalize\*(C'\fR and other some functions: on request.
.IP "Perl's version vs. Unicode version" 4
.IX Item "Perl's version vs. Unicode version"
Since this module refers to perl core's Unicode database in the directory
\&\fI/lib/unicore\fR (or formerly \fI/lib/unicode\fR), the Unicode version of
normalization implemented by this module depends on your perl's version.
\& perl's version implemented Unicode version
\& 5.7.3 3.1.1 (same normalized form as that of 3.1.0)
\& 5.8.4-5.8.6 (latest) 4.0.1 (same normalized form as that of 4.0.0)
.IP "Correction of decomposition mapping" 4
.IX Item "Correction of decomposition mapping"
In older Unicode versions, a small number of characters (all of which are
\&\s-1CJK\s0 compatibility ideographs as far as they have been found) may have
an erroneous decomposition mapping (see \fINormalizationCorrections.txt\fR).
Anyhow, this module will neither refer to \fINormalizationCorrections.txt\fR
nor provide any specific version of normalization. Therefore this module
running on an older perl with an older Unicode database may use
the erroneous decomposition mapping blindly conforming to the Unicode database.
.IP "Revised definition of canonical composition" 4
.IX Item "Revised definition of canonical composition"
In Unicode 4.1.0, the definition D2 of canonical composition (which
affects \s-1NFC\s0 and \s-1NFKC\s0) has been changed (see Public Review Issue #29
and recent \s-1UAX\s0 #15). This module has used the newer definition
since the version 0.07 (Oct 31, 2001).
This module does not support normalization according to the older
definition, even if the Unicode version implemented by perl is
\&\s-1SADAHIRO\s0 Tomoyuki <SADAHIRO@cpan.org>
Copyright(C) 2001\-2005, \s-1SADAHIRO\s0 Tomoyuki. Japan. All rights reserved.
This module is free software; you can redistribute it
and/or modify it under the same terms as Perl itself.
.IP "http://www.unicode.org/reports/tr15/" 4
.IX Item "http://www.unicode.org/reports/tr15/"
Unicode Normalization Forms \- \s-1UAX\s0 #15
.IP "http://www.unicode.org/Public/UNIDATA/DerivedNormalizationProps.txt" 4
.IX Item "http://www.unicode.org/Public/UNIDATA/DerivedNormalizationProps.txt"
Derived Normalization Properties
.IP "http://www.unicode.org/Public/UNIDATA/NormalizationCorrections.txt" 4
.IX Item "http://www.unicode.org/Public/UNIDATA/NormalizationCorrections.txt"
Normalization Corrections
.IP "http://www.unicode.org/review/pr\-29.html" 4
.IX Item "http://www.unicode.org/review/pr-29.html"
Public Review Issue #29: Normalization Issue
.IP "http://www.unicode.org/notes/tn5/" 4
.IX Item "http://www.unicode.org/notes/tn5/"
Canonical Equivalence in Applications \- \s-1UTN\s0 #5
projects / OpenSPARC-T2-SAM / blob