[OpenSPARC-T2-DV] / tools / perl-5.8.0 / man / man3 / Unicode::Normalize.3

.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" 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<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    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
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" 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.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" 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
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    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 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Unicode::Normalize 3"
.TH Unicode::Normalize 3 "2002-06-01" "perl v5.8.0" "Perl Programmers Reference Guide"
.SH "NAME"
Unicode::Normalize \- Unicode Normalization Forms
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Unicode::Normalize;
.Ve
.PP
.Vb 4
\&  $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
.Ve
.PP
.Vb 1
\&   or
.Ve
.PP
.Vb 1
\&  use Unicode::Normalize 'normalize';
.Ve
.PP
.Vb 4
\&  $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
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.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 """$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.
.Sp
.Vb 4
\&  'C'  or 'NFC'  for Normalization Form C
\&  'D'  or 'NFD'  for Normalization Form D
\&  'KC' or 'NFKC' for Normalization Form KC
\&  'KD' or 'NFKD' for Normalization Form KD
.Ve
.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)"
.PD 0
.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)"
.PD
Decompose the specified string and returns the result.
.Sp
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.
.Sp
The string returned is not always in \s-1NFD/NFKD\s0.
Reordering may be required.
.Sp
.Vb 2
\&    $NFD_string  = reorder(decompose($string));       # eq. to NFD()
\&    $NFKD_string = reorder(decompose($string, TRUE)); # eq. to NFKD()
.Ve
.ie n .IP """$reordered_string  = reorder($string)""" 4
.el .IP "\f(CW$reordered_string  = reorder($string)\fR" 4
.IX Item "$reordered_string  = reorder($string)"
Reorder the combining characters and the like in the canonical ordering
and returns the result.
.Sp
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
.Sp
.Vb 2
\&    $concat_NFD  = reorder(join '', @NFD_strings);
\&    $concat_NFKD = reorder(join '', @NFKD_strings);
.Ve
.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.
.Sp
E.g., when you have a \s-1NFD/NFKD\s0 string,
you can get its \s-1NFC/NFKC\s0 string, saying
.Sp
.Vb 2
\&    $NFC_string  = compose($NFD_string);
\&    $NFKC_string = compose($NFKD_string);
.Ve
.Sh "Quick Check"
.IX Subsection "Quick Check"
(see Annex 8, \s-1UAX\s0 #15; \fIDerivedNormalizationProps.txt\fR)
.PP
The following functions check whether the string is in that normalization form.
.PP
The result returned will be:
.PP
.Vb 3
\&    YES     The string is in that normalization form.
\&    NO      The string is not in that normalization form.
\&    MAYBE   Dubious. Maybe yes, maybe no.
.Ve
.ie n .IP """$result = checkNFD($string)""" 4
.el .IP "\f(CW$result = checkNFD($string)\fR" 4
.IX Item "$result = checkNFD($string)"
returns \f(CW\*(C`YES\*(C'\fR (\f(CW1\fR) or \f(CW\*(C`NO\*(C'\fR (\f(CW\*(C`empty string\*(C'\fR).
.ie n .IP """$result = checkNFC($string)""" 4
.el .IP "\f(CW$result = checkNFC($string)\fR" 4
.IX Item "$result = checkNFC($string)"
returns \f(CW\*(C`YES\*(C'\fR (\f(CW1\fR), \f(CW\*(C`NO\*(C'\fR (\f(CW\*(C`empty string\*(C'\fR), or \f(CW\*(C`MAYBE\*(C'\fR (\f(CW\*(C`undef\*(C'\fR).
.ie n .IP """$result = checkNFKD($string)""" 4
.el .IP "\f(CW$result = checkNFKD($string)\fR" 4
.IX Item "$result = checkNFKD($string)"
returns \f(CW\*(C`YES\*(C'\fR (\f(CW1\fR) or \f(CW\*(C`NO\*(C'\fR (\f(CW\*(C`empty string\*(C'\fR).
.ie n .IP """$result = checkNFKC($string)""" 4
.el .IP "\f(CW$result = checkNFKC($string)\fR" 4
.IX Item "$result = checkNFKC($string)"
returns \f(CW\*(C`YES\*(C'\fR (\f(CW1\fR), \f(CW\*(C`NO\*(C'\fR (\f(CW\*(C`empty string\*(C'\fR), or \f(CW\*(C`MAYBE\*(C'\fR (\f(CW\*(C`undef\*(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 \f(CW\*(C`YES\*(C'\fR (\f(CW1\fR), \f(CW\*(C`NO\*(C'\fR (\f(CW\*(C`empty string\*(C'\fR), or \f(CW\*(C`MAYBE\*(C'\fR (\f(CW\*(C`undef\*(C'\fR).
.Sp
\&\f(CW$form_name\fR is alike to that for \f(CW\*(C`normalize()\*(C'\fR.
.PP
\&\fBNote\fR
.PP
In the cases of \s-1NFD\s0 and \s-1NFKD\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 and \s-1NFKC\s0.
.PP
A \s-1MAYBE\-NFC/NFKC\s0 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.
.PP
If you want to check exactly, compare the string with its \s-1NFC/NFKC\s0; i.e.,
.PP
.Vb 2
\&    $string eq NFC($string)    # more thorough than checkNFC($string)
\&    $string eq NFKC($string)   # more thorough than checkNFKC($string)
.Ve
.Sh "Character Data"
.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
call them yourself.
.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.
.Sp
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.
.Sp
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.
.Sp
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
a singleton.
.ie n .IP """$is_non_startar_decomposition = isNonStDecomp($codepoint)""" 4
.el .IP "\f(CW$is_non_startar_decomposition = isNonStDecomp($codepoint)\fR" 4
.IX Item "$is_non_startar_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).
.Sh "\s-1EXPORT\s0"
.IX Subsection "EXPORT"
\&\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.
.PP
\&\f(CW\*(C`normalize\*(C'\fR and other some functions: on request.
.SH "AUTHOR"
.IX Header "AUTHOR"
\&\s-1SADAHIRO\s0 Tomoyuki, <SADAHIRO@cpan.org>
.PP
.Vb 1
\&  http://homepage1.nifty.com/nomenclator/perl/
.Ve
.PP
.Vb 1
\&  Copyright(C) 2001-2002, SADAHIRO Tomoyuki. Japan. All rights reserved.
.Ve
.PP
.Vb 2
\&  This program is free software; you can redistribute it and/or 
\&  modify it under the same terms as Perl itself.
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "http://www.unicode.org/unicode/reports/tr15/" 4
.IX Item "http://www.unicode.org/unicode/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
Commit	Line	Data
86530b38 AT	1	.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
	2	.\"
	3	.\" Standard preamble:
	4	.\" ========================================================================
	5	.de Sh \" Subsection heading
	6	.br
	7	.if t .Sp
	8	.ne 5
	9	.PP
	10	\fB\\$1\fR
	11	.PP
	12	..
	13	.de Sp \" Vertical space (when we can't use .PP)
	14	.if t .sp .5v
	15	.if n .sp
	16	..
	17	.de Vb \" Begin verbatim text
	18	.ft CW
	19	.nf
	20	.ne \\$1
	21	..
	22	.de Ve \" End verbatim text
	23	.ft R
	24	.fi
	25	..
	26	.\" Set up some character translations and predefined strings. \*(-- will
	27	.\" give an unbreakable dash, \(PI will give pi, \(L" will give a left
	28	.\" double quote, and \*(R" will give a right double quote. \| will give a
	29	.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
	30	.\" do unbreakable dashes and therefore won't be available. \(C` and \(C'
	31	.\" expand to `' in nroff, nothing in troff, for use with C<>.
	32	.tr \(W-\|\(bv\(Tr
	33	.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
	34	.ie n \{\
	35	. ds -- \(*W-
	36	. ds PI pi
	37	. if (\n(.H=4u)&(1m=24u) .ds -- \(W\h'-12u'\(W\h'-12u'-\" diablo 10 pitch
	38	. if (\n(.H=4u)&(1m=20u) .ds -- \(W\h'-12u'\(W\h'-8u'-\" diablo 12 pitch
	39	. ds L" ""
	40	. ds R" ""
	41	. ds C` ""
	42	. ds C' ""
	43	'br\}
	44	.el\{\
	45	. ds -- \\|\(em\\|
	46	. ds PI \(*p
	47	. ds L" ``
	48	. ds R" ''
	49	'br\}
	50	.\"
	51	.\" If the F register is turned on, we'll generate index entries on stderr for
	52	.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
	53	.\" entries marked with X<> in POD. Of course, you'll have to process the
	54	.\" output yourself in some meaningful fashion.
	55	.if \nF \{\
	56	. de IX
	57	. tm Index:\\$1\t\\n%\t"\\$2"
	58	..
	59	. nr % 0
	60	. rr F
	61	.\}
	62	.\"
	63	.\" For nroff, turn off justification. Always turn off hyphenation; it makes
	64	.\" way too many mistakes in technical documents.
65	.hy 0
66	.if n .na
67	.\"
68	.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69	.\" Fear. Run. Save yourself. No user-serviceable parts.
70	. \" fudge factors for nroff and troff
71	.if n \{\
72	. ds #H 0
73	. ds #V .8m
74	. ds #F .3m
75	. ds #[ \f1
76	. ds #] \fP
77	.\}
78	.if t \{\
79	. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80	. ds #V .6m
81	. ds #F 0
82	. ds #[ \&
83	. ds #] \&
84	.\}
85	. \" simple accents for nroff and troff
86	.if n \{\
87	. ds ' \&
88	. ds ` \&
89	. ds ^ \&
90	. ds , \&
91	. ds ~ ~
92	. ds /
93	.\}
94	.if t \{\
95	. ds ' \\k:\h'-(\\n(.wu8/10-\(#H)'\'\h"\|\\n:u"
96	. ds ` \\k:\h'-(\\n(.wu8/10-\(#H)'\`\h'\|\\n:u'
97	. ds ^ \\k:\h'-(\\n(.wu10/11-\(#H)'^\h'\|\\n:u'
98	. ds , \\k:\h'-(\\n(.wu*8/10)',\h'\|\\n:u'
99	. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'\|\\n:u'
100	. ds / \\k:\h'-(\\n(.wu8/10-\(#H)'\z\(sl\h'\|\\n:u'
101	.\}
102	. \" troff and (daisy-wheel) nroff accents
103	.ds : \\k:\h'-(\\n(.wu8/10-\(#H+.1m+\(#F)'\v'-\(#V'\z.\h'.2m+\(#F'.\h'\|\\n:u'\v'\(#V'
104	.ds 8 \h'\(#H'\(b\h'-\*(#H'
105	.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\(#H)/2u'\v'-.3n'\(#[\z\(de\v'.3n'\h'\|\\n:u'\*(#]
106	.ds d- \h'\(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\(#H'
107	.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'\|\\n:u'
108	.ds th \(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u2/3)'\s-1o\s+1\*(#]
109	.ds Th \(#[\s+2I\s-2\h'-\w'I'u3/5'\v'-.3m'o\v'.3m'\*(#]
110	.ds ae a\h'-(\w'a'u*4/10)'e
111	.ds Ae A\h'-(\w'A'u*4/10)'E
112	. \" corrections for vroff
113	.if v .ds ~ \\k:\h'-(\\n(.wu9/10-\(#H)'\s-2\u~\d\s+2\h'\|\\n:u'
114	.if v .ds ^ \\k:\h'-(\\n(.wu10/11-\(#H)'\v'-.4m'^\v'.4m'\h'\|\\n:u'
115	. \" for low resolution devices (crt and lpr)
116	.if \n(.H>23 .if \n(.V>19 \
117	\{\
118	. ds : e
119	. ds 8 ss
120	. ds o a
121	. ds d- d\h'-1'\(ga
122	. ds D- D\h'-1'\(hy
123	. ds th \o'bp'
124	. ds Th \o'LP'
125	. ds ae ae
126	. ds Ae AE
127	.\}
128	.rm #[ #] #H #V #F C
129	.\" ========================================================================
130	.\"
131	.IX Title "Unicode::Normalize 3"
132	.TH Unicode::Normalize 3 "2002-06-01" "perl v5.8.0" "Perl Programmers Reference Guide"
133	.SH "NAME"
134	Unicode::Normalize \- Unicode Normalization Forms
135	.SH "SYNOPSIS"
136	.IX Header "SYNOPSIS"
137	.Vb 1
138	\& use Unicode::Normalize;
139	.Ve
140	.PP
141	.Vb 4
142	\& $NFD_string = NFD($string); # Normalization Form D
143	\& $NFC_string = NFC($string); # Normalization Form C
144	\& $NFKD_string = NFKD($string); # Normalization Form KD
145	\& $NFKC_string = NFKC($string); # Normalization Form KC
146	.Ve
147	.PP
148	.Vb 1
149	\& or
150	.Ve
151	.PP
152	.Vb 1
153	\& use Unicode::Normalize 'normalize';
154	.Ve
155	.PP
156	.Vb 4
157	\& $NFD_string = normalize('D', $string); # Normalization Form D
158	\& $NFC_string = normalize('C', $string); # Normalization Form C
159	\& $NFKD_string = normalize('KD', $string); # Normalization Form KD
160	\& $NFKC_string = normalize('KC', $string); # Normalization Form KC
161	.Ve
162	.SH "DESCRIPTION"
163	.IX Header "DESCRIPTION"
164	.Sh "Normalization Forms"
165	.IX Subsection "Normalization Forms"
166	.ie n .IP """$NFD_string = NFD($string)""" 4
167	.el .IP "\f(CW$NFD_string = NFD($string)\fR" 4
168	.IX Item "$NFD_string = NFD($string)"
169	returns the Normalization Form D (formed by canonical decomposition).
170	.ie n .IP """$NFC_string = NFC($string)""" 4
171	.el .IP "\f(CW$NFC_string = NFC($string)\fR" 4
172	.IX Item "$NFC_string = NFC($string)"
173	returns the Normalization Form C (formed by canonical decomposition
174	followed by canonical composition).
175	.ie n .IP """$NFKD_string = NFKD($string)""" 4
176	.el .IP "\f(CW$NFKD_string = NFKD($string)\fR" 4
177	.IX Item "$NFKD_string = NFKD($string)"
178	returns the Normalization Form \s-1KD\s0 (formed by compatibility decomposition).
179	.ie n .IP """$NFKC_string = NFKC($string)""" 4
180	.el .IP "\f(CW$NFKC_string = NFKC($string)\fR" 4
181	.IX Item "$NFKC_string = NFKC($string)"
182	returns the Normalization Form \s-1KC\s0 (formed by compatibility decomposition
183	followed by \fBcanonical\fR composition).
184	.ie n .IP """$normalized_string = normalize($form_name, $string)""" 4
185	.el .IP "\f(CW$normalized_string = normalize($form_name, $string)\fR" 4
186	.IX Item "$normalized_string = normalize($form_name, $string)"
187	As \f(CW$form_name\fR, one of the following names must be given.
188	.Sp
189	.Vb 4
190	\& 'C' or 'NFC' for Normalization Form C
191	\& 'D' or 'NFD' for Normalization Form D
192	\& 'KC' or 'NFKC' for Normalization Form KC
193	\& 'KD' or 'NFKD' for Normalization Form KD
194	.Ve
195	.Sh "Decomposition and Composition"
196	.IX Subsection "Decomposition and Composition"
197	.ie n .IP """$decomposed_string = decompose($string)""" 4
198	.el .IP "\f(CW$decomposed_string = decompose($string)\fR" 4
199	.IX Item "$decomposed_string = decompose($string)"
200	.PD 0
201	.ie n .IP """$decomposed_string = decompose($string, $useCompatMapping)""" 4
202	.el .IP "\f(CW$decomposed_string = decompose($string, $useCompatMapping)\fR" 4
203	.IX Item "$decomposed_string = decompose($string, $useCompatMapping)"
204	.PD
205	Decompose the specified string and returns the result.
206	.Sp
207	If the second parameter (a boolean) is omitted or false, decomposes it
208	using the Canonical Decomposition Mapping.
209	If true, decomposes it using the Compatibility Decomposition Mapping.
210	.Sp
211	The string returned is not always in \s-1NFD/NFKD\s0.
212	Reordering may be required.
213	.Sp
214	.Vb 2
215	\& $NFD_string = reorder(decompose($string)); # eq. to NFD()
216	\& $NFKD_string = reorder(decompose($string, TRUE)); # eq. to NFKD()
217	.Ve
218	.ie n .IP """$reordered_string = reorder($string)""" 4
219	.el .IP "\f(CW$reordered_string = reorder($string)\fR" 4
220	.IX Item "$reordered_string = reorder($string)"
221	Reorder the combining characters and the like in the canonical ordering
222	and returns the result.
223	.Sp
224	E.g., when you have a list of \s-1NFD/NFKD\s0 strings,
225	you can get the concatenated \s-1NFD/NFKD\s0 string from them, saying
226	.Sp
227	.Vb 2
228	\& $concat_NFD = reorder(join '', @NFD_strings);
229	\& $concat_NFKD = reorder(join '', @NFKD_strings);
230	.Ve
231	.ie n .IP """$composed_string = compose($string)""" 4
232	.el .IP "\f(CW$composed_string = compose($string)\fR" 4
233	.IX Item "$composed_string = compose($string)"
234	Returns the string where composable pairs are composed.
235	.Sp
236	E.g., when you have a \s-1NFD/NFKD\s0 string,
237	you can get its \s-1NFC/NFKC\s0 string, saying
238	.Sp
239	.Vb 2
240	\& $NFC_string = compose($NFD_string);
241	\& $NFKC_string = compose($NFKD_string);
242	.Ve
243	.Sh "Quick Check"
244	.IX Subsection "Quick Check"
245	(see Annex 8, \s-1UAX\s0 #15; \fIDerivedNormalizationProps.txt\fR)
246	.PP
247	The following functions check whether the string is in that normalization form.
248	.PP
249	The result returned will be:
250	.PP
251	.Vb 3
252	\& YES The string is in that normalization form.
253	\& NO The string is not in that normalization form.
254	\& MAYBE Dubious. Maybe yes, maybe no.
255	.Ve
256	.ie n .IP """$result = checkNFD($string)""" 4
257	.el .IP "\f(CW$result = checkNFD($string)\fR" 4
258	.IX Item "$result = checkNFD($string)"
259	returns \f(CW\(C`YES\(C'\fR (\f(CW1\fR) or \f(CW\(C`NO\(C'\fR (\f(CW\(C`empty string\(C'\fR).
260	.ie n .IP """$result = checkNFC($string)""" 4
261	.el .IP "\f(CW$result = checkNFC($string)\fR" 4
262	.IX Item "$result = checkNFC($string)"
263	returns \f(CW\(C`YES\(C'\fR (\f(CW1\fR), \f(CW\(C`NO\(C'\fR (\f(CW\(C`empty string\(C'\fR), or \f(CW\(C`MAYBE\(C'\fR (\f(CW\(C`undef\(C'\fR).
264	.ie n .IP """$result = checkNFKD($string)""" 4
265	.el .IP "\f(CW$result = checkNFKD($string)\fR" 4
266	.IX Item "$result = checkNFKD($string)"
267	returns \f(CW\(C`YES\(C'\fR (\f(CW1\fR) or \f(CW\(C`NO\(C'\fR (\f(CW\(C`empty string\(C'\fR).
268	.ie n .IP """$result = checkNFKC($string)""" 4
269	.el .IP "\f(CW$result = checkNFKC($string)\fR" 4
270	.IX Item "$result = checkNFKC($string)"
271	returns \f(CW\(C`YES\(C'\fR (\f(CW1\fR), \f(CW\(C`NO\(C'\fR (\f(CW\(C`empty string\(C'\fR), or \f(CW\(C`MAYBE\(C'\fR (\f(CW\(C`undef\(C'\fR).
272	.ie n .IP """$result = check($form_name, $string)""" 4
273	.el .IP "\f(CW$result = check($form_name, $string)\fR" 4
274	.IX Item "$result = check($form_name, $string)"
275	returns \f(CW\(C`YES\(C'\fR (\f(CW1\fR), \f(CW\(C`NO\(C'\fR (\f(CW\(C`empty string\(C'\fR), or \f(CW\(C`MAYBE\(C'\fR (\f(CW\(C`undef\(C'\fR).
276	.Sp
277	\&\f(CW$form_name\fR is alike to that for \f(CW\(C`normalize()\(C'\fR.
278	.PP
279	\&\fBNote\fR
280	.PP
281	In the cases of \s-1NFD\s0 and \s-1NFKD\s0, the answer must be either \f(CW\(C`YES\(C'\fR or \f(CW\(C`NO\(C'\fR.
282	The answer \f(CW\(C`MAYBE\(C'\fR may be returned in the cases of \s-1NFC\s0 and \s-1NFKC\s0.
283	.PP
284	A \s-1MAYBE\-NFC/NFKC\s0 string should contain at least
285	one combining character or the like.
286	For example, \f(CW\(C`COMBINING ACUTE ACCENT\(C'\fR has
287	the \s-1MAYBE_NFC/MAYBE_NFKC\s0 property.
288	Both \f(CW\(C`checkNFC("A\eN{COMBINING ACUTE ACCENT}")\(C'\fR
289	and \f(CW\(C`checkNFC("B\eN{COMBINING ACUTE ACCENT}")\(C'\fR will return \f(CW\(C`MAYBE\(C'\fR.
290	\&\f(CW"A\eN{COMBINING ACUTE ACCENT}"\fR is not in \s-1NFC\s0
291	(its \s-1NFC\s0 is \f(CW"\eN{LATIN CAPITAL LETTER A WITH ACUTE}"\fR),
292	while \f(CW"B\eN{COMBINING ACUTE ACCENT}"\fR is in \s-1NFC\s0.
293	.PP
294	If you want to check exactly, compare the string with its \s-1NFC/NFKC\s0; i.e.,
295	.PP
296	.Vb 2
297	\& $string eq NFC($string) # more thorough than checkNFC($string)
298	\& $string eq NFKC($string) # more thorough than checkNFKC($string)
299	.Ve
300	.Sh "Character Data"
301	.IX Subsection "Character Data"
302	These functions are interface of character data used internally.
303	If you want only to get Unicode normalization forms, you don't need
304	call them yourself.
305	.ie n .IP """$canonical_decomposed = getCanon($codepoint)""" 4
306	.el .IP "\f(CW$canonical_decomposed = getCanon($codepoint)\fR" 4
307	.IX Item "$canonical_decomposed = getCanon($codepoint)"
308	If the character of the specified codepoint is canonically
309	decomposable (including Hangul Syllables),
310	returns the \fBcompletely decomposed\fR string canonically equivalent to it.
311	.Sp
312	If it is not decomposable, returns \f(CW\(C`undef\(C'\fR.
313	.ie n .IP """$compatibility_decomposed = getCompat($codepoint)""" 4
314	.el .IP "\f(CW$compatibility_decomposed = getCompat($codepoint)\fR" 4
315	.IX Item "$compatibility_decomposed = getCompat($codepoint)"
316	If the character of the specified codepoint is compatibility
317	decomposable (including Hangul Syllables),
318	returns the \fBcompletely decomposed\fR string compatibility equivalent to it.
319	.Sp
320	If it is not decomposable, returns \f(CW\(C`undef\(C'\fR.
321	.ie n .IP """$codepoint_composite = getComposite($codepoint_here, $codepoint_next)""" 4
322	.el .IP "\f(CW$codepoint_composite = getComposite($codepoint_here, $codepoint_next)\fR" 4
323	.IX Item "$codepoint_composite = getComposite($codepoint_here, $codepoint_next)"
324	If two characters here and next (as codepoints) are composable
325	(including Hangul Jamo/Syllables and Composition Exclusions),
326	returns the codepoint of the composite.
327	.Sp
328	If they are not composable, returns \f(CW\(C`undef\(C'\fR.
329	.ie n .IP """$combining_class = getCombinClass($codepoint)""" 4
330	.el .IP "\f(CW$combining_class = getCombinClass($codepoint)\fR" 4
331	.IX Item "$combining_class = getCombinClass($codepoint)"
332	Returns the combining class of the character as an integer.
333	.ie n .IP """$is_exclusion = isExclusion($codepoint)""" 4
334	.el .IP "\f(CW$is_exclusion = isExclusion($codepoint)\fR" 4
335	.IX Item "$is_exclusion = isExclusion($codepoint)"
336	Returns a boolean whether the character of the specified codepoint
337	is a composition exclusion.
338	.ie n .IP """$is_singleton = isSingleton($codepoint)""" 4
339	.el .IP "\f(CW$is_singleton = isSingleton($codepoint)\fR" 4
340	.IX Item "$is_singleton = isSingleton($codepoint)"
341	Returns a boolean whether the character of the specified codepoint is
342	a singleton.
343	.ie n .IP """$is_non_startar_decomposition = isNonStDecomp($codepoint)""" 4
344	.el .IP "\f(CW$is_non_startar_decomposition = isNonStDecomp($codepoint)\fR" 4
345	.IX Item "$is_non_startar_decomposition = isNonStDecomp($codepoint)"
346	Returns a boolean whether the canonical decomposition
347	of the character of the specified codepoint
348	is a Non-Starter Decomposition.
349	.ie n .IP """$may_be_composed_with_prev_char = isComp2nd($codepoint)""" 4
350	.el .IP "\f(CW$may_be_composed_with_prev_char = isComp2nd($codepoint)\fR" 4
351	.IX Item "$may_be_composed_with_prev_char = isComp2nd($codepoint)"
352	Returns a boolean whether the character of the specified codepoint
353	may be composed with the previous one in a certain composition
354	(including Hangul Compositions, but excluding
355	Composition Exclusions and Non-Starter Decompositions).
356	.Sh "\s-1EXPORT\s0"
357	.IX Subsection "EXPORT"
358	\&\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.
359	.PP
360	\&\f(CW\(C`normalize\(C'\fR and other some functions: on request.
361	.SH "AUTHOR"
362	.IX Header "AUTHOR"
363	\&\s-1SADAHIRO\s0 Tomoyuki, <SADAHIRO@cpan.org>
364	.PP
365	.Vb 1
366	\& http://homepage1.nifty.com/nomenclator/perl/
367	.Ve
368	.PP
369	.Vb 1
370	\& Copyright(C) 2001-2002, SADAHIRO Tomoyuki. Japan. All rights reserved.
371	.Ve
372	.PP
373	.Vb 2
374	\& This program is free software; you can redistribute it and/or
375	\& modify it under the same terms as Perl itself.
376	.Ve
377	.SH "SEE ALSO"
378	.IX Header "SEE ALSO"
379	.IP "http://www.unicode.org/unicode/reports/tr15/" 4
380	.IX Item "http://www.unicode.org/unicode/reports/tr15/"
381	Unicode Normalization Forms \- \s-1UAX\s0 #15
382	.IP "http://www.unicode.org/Public/UNIDATA/DerivedNormalizationProps.txt" 4
383	.IX Item "http://www.unicode.org/Public/UNIDATA/DerivedNormalizationProps.txt"
384	Derived Normalization Properties