D7net
Home
Console
Upload
information
Create File
Create Folder
About
Tools
:
/
usr
/
local
/
lp
/
sonarperl
/
man
/
man3
/
Filename :
Unicode::Collate::Locale.3
back
Copy
.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .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 .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Unicode::Collate::Locale 3" .TH Unicode::Collate::Locale 3 2022-05-28 "perl v5.38.0" "Perl Programmers Reference Guide" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME Unicode::Collate::Locale \- Linguistic tailoring for DUCET via Unicode::Collate .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& use Unicode::Collate::Locale; \& \& #construct \& $Collator = Unicode::Collate::Locale\-> \& new(locale => $locale_name, %tailoring); \& \& #sort \& @sorted = $Collator\->sort(@not_sorted); \& \& #compare \& $result = $Collator\->cmp($a, $b); # returns 1, 0, or \-1. .Ve .PP \&\fBNote:\fR Strings in \f(CW@not_sorted\fR, \f(CW$a\fR and \f(CW$b\fR are interpreted according to Perl's Unicode support. See perlunicode, perluniintro, perlunitut, perlunifaq, utf8. Otherwise you can use \f(CW\*(C`preprocess\*(C'\fR (cf. \f(CW\*(C`Unicode::Collate\*(C'\fR) or should decode them before. .SH DESCRIPTION .IX Header "DESCRIPTION" This module provides linguistic tailoring for it taking advantage of \f(CW\*(C`Unicode::Collate\*(C'\fR. .SS Constructor .IX Subsection "Constructor" The \f(CW\*(C`new\*(C'\fR method returns a collator object. .PP A parameter list for the constructor is a hash, which can include a special key \f(CW\*(C`locale\*(C'\fR and its value (case-insensitive) standing for a Unicode base language code (two or three-letter). For example, \f(CW\*(C`Unicode::Collate::Locale\->new(locale => \*(AqES\*(Aq)\*(C'\fR returns a collator tailored for Spanish. .PP \&\f(CW$locale_name\fR may be suffixed with a Unicode script code (four-letter), a Unicode region (territory) code, a Unicode language variant code. These codes are case-insensitive, and separated with \f(CW\*(Aq_\*(Aq\fR or \f(CW\*(Aq\-\*(Aq\fR. E.g. \f(CW\*(C`en_US\*(C'\fR for English in USA, \&\f(CW\*(C`az_Cyrl\*(C'\fR for Azerbaijani in the Cyrillic script, \&\f(CW\*(C`es_ES_traditional\*(C'\fR for Spanish in Spain (Traditional). .PP If \f(CW$locale_name\fR is not available, fallback is selected in the following order: .PP .Vb 5 \& 1. language with a variant code \& 2. language with a script code \& 3. language with a region code \& 4. language \& 5. default .Ve .PP Tailoring tags provided by \f(CW\*(C`Unicode::Collate\*(C'\fR are allowed as long as they are not used for \f(CW\*(C`locale\*(C'\fR support. Esp. the \f(CW\*(C`table\*(C'\fR tag is always untailorable, since it is reserved for DUCET. .PP However \f(CW\*(C`entry\*(C'\fR is allowed, even if it is used for \f(CW\*(C`locale\*(C'\fR support, to add or override mappings. .PP E.g. a collator for Spanish, which ignores diacritics and case difference (i.e. level 1), with reversed case ordering and no normalization. .PP .Vb 6 \& Unicode::Collate::Locale\->new( \& level => 1, \& locale => \*(Aqes\*(Aq, \& upper_before_lower => 1, \& normalization => undef \& ) .Ve .PP Overriding a behavior already tailored by \f(CW\*(C`locale\*(C'\fR is disallowed if such a tailoring is passed to \f(CWnew()\fR. .PP .Vb 4 \& Unicode::Collate::Locale\->new( \& locale => \*(Aqda\*(Aq, \& upper_before_lower => 0, # causes error as reserved by \*(Aqda\*(Aq \& ) .Ve .PP However \f(CWchange()\fR inherited from \f(CW\*(C`Unicode::Collate\*(C'\fR allows such a tailoring that is reserved by \f(CW\*(C`locale\*(C'\fR. Examples: .PP .Vb 3 \& new(locale => \*(Aqfr_ca\*(Aq)\->change(backwards => undef) \& new(locale => \*(Aqda\*(Aq)\->change(upper_before_lower => 0) \& new(locale => \*(Aqja\*(Aq)\->change(overrideCJK => undef) .Ve .SS Methods .IX Subsection "Methods" \&\f(CW\*(C`Unicode::Collate::Locale\*(C'\fR is a subclass of \f(CW\*(C`Unicode::Collate\*(C'\fR and methods other than \f(CW\*(C`new\*(C'\fR are inherited from \f(CW\*(C`Unicode::Collate\*(C'\fR. .PP Here is a list of additional methods: .ie n .IP """$Collator\->getlocale""" 4 .el .IP \f(CW$Collator\->getlocale\fR 4 .IX Item "$Collator->getlocale" Returns a language code accepted and used actually on collation. If linguistic tailoring is not provided for a language code you passed (intensionally for some languages, or due to the incomplete implementation), this method returns a string \f(CW\*(Aqdefault\*(Aq\fR meaning no special tailoring. .ie n .IP """$Collator\->locale_version""" 4 .el .IP \f(CW$Collator\->locale_version\fR 4 .IX Item "$Collator->locale_version" (Since Unicode::Collate::Locale 0.87) Returns the version number (perhaps \f(CW\*(C`/\ed\e.\ed\ed/\*(C'\fR) of the locale, as that of \fILocale/*.pl\fR. .Sp \&\fBNote:\fR \fILocale/*.pl\fR that a collator uses should be identified by a combination of return values from \f(CW\*(C`getlocale\*(C'\fR and \f(CW\*(C`locale_version\*(C'\fR. .SS "A list of tailorable locales" .IX Subsection "A list of tailorable locales" .Vb 10 \& locale name description \& \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- \& af Afrikaans \& ar Arabic \& as Assamese \& az Azerbaijani (Azeri) \& be Belarusian \& bn Bengali \& bs Bosnian (tailored as Croatian) \& bs_Cyrl Bosnian in Cyrillic (tailored as Serbian) \& ca Catalan \& cs Czech \& cu Church Slavic \& cy Welsh \& da Danish \& de_\|_phonebook German (umlaut as \*(Aqae\*(Aq, \*(Aqoe\*(Aq, \*(Aque\*(Aq) \& de_AT_phonebook Austrian German (umlaut primary greater) \& dsb Lower Sorbian \& ee Ewe \& eo Esperanto \& es Spanish \& es_\|_traditional Spanish (\*(Aqch\*(Aq and \*(Aqll\*(Aq as a grapheme) \& et Estonian \& fa Persian \& fi Finnish (v and w are primary equal) \& fi_\|_phonebook Finnish (v and w as separate characters) \& fil Filipino \& fo Faroese \& fr_CA Canadian French \& gu Gujarati \& ha Hausa \& haw Hawaiian \& he Hebrew \& hi Hindi \& hr Croatian \& hu Hungarian \& hy Armenian \& ig Igbo \& is Icelandic \& ja Japanese [1] \& kk Kazakh \& kl Kalaallisut \& kn Kannada \& ko Korean [2] \& kok Konkani \& lkt Lakota \& ln Lingala \& lt Lithuanian \& lv Latvian \& mk Macedonian \& ml Malayalam \& mr Marathi \& mt Maltese \& nb Norwegian Bokmal \& nn Norwegian Nynorsk \& nso Northern Sotho \& om Oromo \& or Oriya \& pa Punjabi \& pl Polish \& ro Romanian \& sa Sanskrit \& se Northern Sami \& si Sinhala \& si_\|_dictionary Sinhala (U+0DA5 = U+0DA2,0DCA,0DA4) \& sk Slovak \& sl Slovenian \& sq Albanian \& sr Serbian \& sr_Latn Serbian in Latin (tailored as Croatian) \& sv Swedish (v and w are primary equal) \& sv_\|_reformed Swedish (v and w as separate characters) \& ta Tamil \& te Telugu \& th Thai \& tn Tswana \& to Tonga \& tr Turkish \& ug_Cyrl Uyghur in Cyrillic \& uk Ukrainian \& ur Urdu \& vi Vietnamese \& vo Volapu"k \& wae Walser \& wo Wolof \& yo Yoruba \& zh Chinese \& zh_\|_big5han Chinese (ideographs: big5 order) \& zh_\|_gb2312han Chinese (ideographs: GB\-2312 order) \& zh_\|_pinyin Chinese (ideographs: pinyin order) [3] \& zh_\|_stroke Chinese (ideographs: stroke order) [3] \& zh_\|_zhuyin Chinese (ideographs: zhuyin order) [3] \& \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- .Ve .PP Locales according to the default UCA rules include am (Amharic) without \f(CW\*(C`[reorder Ethi]\*(C'\fR, bg (Bulgarian) without \f(CW\*(C`[reorder Cyrl]\*(C'\fR, chr (Cherokee) without \f(CW\*(C`[reorder Cher]\*(C'\fR, de (German), en (English), fr (French), ga (Irish), id (Indonesian), it (Italian), ka (Georgian) without \f(CW\*(C`[reorder Geor]\*(C'\fR, mn (Mongolian) without \f(CW\*(C`[reorder Cyrl Mong]\*(C'\fR, ms (Malay), nl (Dutch), pt (Portuguese), ru (Russian) without \f(CW\*(C`[reorder Cyrl]\*(C'\fR, sw (Swahili), zu (Zulu). .PP \&\fBNote\fR .PP [1] ja: Ideographs are sorted in JIS X 0208 order. Fullwidth and halfwidth forms are identical to their regular form. The difference between hiragana and katakana is at the 4th level, the comparison also requires \f(CW\*(C`(variable => \*(AqNon\-ignorable\*(Aq)\*(C'\fR, and then \f(CW\*(C`katakana_before_hiragana\*(C'\fR has no effect. .PP [2] ko: Plenty of ideographs are sorted by their reading. Such an ideograph is primary (level 1) equal to, and secondary (level 2) greater than, the corresponding hangul syllable. .PP [3] zh_\|_pinyin, zh_\|_stroke and zh_\|_zhuyin: implemented alt='short', where a smaller number of ideographs are tailored. .SS "A list of variant codes and their aliases" .IX Subsection "A list of variant codes and their aliases" .Vb 10 \& variant code alias \& \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- \& dictionary dict \& phonebook phone phonebk \& reformed reform \& traditional trad \& \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- \& big5han big5 \& gb2312han gb2312 \& pinyin \& stroke \& zhuyin \& \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- .Ve .PP Note: 'pinyin' is Han in Latin, 'zhuyin' is Han in Bopomofo. .SH INSTALL .IX Header "INSTALL" Installation of \f(CW\*(C`Unicode::Collate::Locale\*(C'\fR requires \fICollate/Locale.pm\fR, \&\fICollate/Locale/*.pm\fR, \fICollate/CJK/*.pm\fR and \fICollate/allkeys.txt\fR. On building, \f(CW\*(C`Unicode::Collate::Locale\*(C'\fR doesn't require any of \fIdata/*.txt\fR, \fIgendata/*\fR, and \fImklocale\fR. Tests for \f(CW\*(C`Unicode::Collate::Locale\*(C'\fR are named \fIt/loc_*.t\fR. .SH CAVEAT .IX Header "CAVEAT" .IP "Tailoring is not maximum" 4 .IX Item "Tailoring is not maximum" Even if a certain letter is tailored, its equivalent would not always tailored as well as it. For example, even though W is tailored, fullwidth W (\f(CW\*(C`U+FF37\*(C'\fR), W with acute (\f(CW\*(C`U+1E82\*(C'\fR), etc. are not tailored. The result may depend on whether source strings are normalized or not, and whether decomposed or composed. Thus \f(CW\*(C`(normalization => undef)\*(C'\fR is less preferred. .IP "Collation reordering is not supported" 4 .IX Item "Collation reordering is not supported" The order of any groups including scripts is not changed. .SS Reference .IX Subsection "Reference" .Vb 10 \& locale based CLDR or other reference \& \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- \& af 30 = 1.8.1 \& ar 30 = 28 ("compat" wo [reorder Arab]) = 1.9.0 \& as 30 = 28 (without [reorder Beng..]) = 23 \& az 30 = 24 ("standard" wo [reorder Latn Cyrl]) \& be 30 = 28 (without [reorder Cyrl]) \& bn 30 = 28 ("standard" wo [reorder Beng..]) = 2.0.1 \& bs 30 = 28 (type="standard": [import hr]) \& bs_Cyrl 30 = 28 (type="standard": [import sr]) \& ca 30 = 23 (alt="proposed" type="standard") \& cs 30 = 1.8.1 (type="standard") \& cu 34 = 30 (without [reorder Cyrl]) \& cy 30 = 1.8.1 \& da 22.1 = 1.8.1 (type="standard") \& de_\|_phonebook 30 = 2.0 (type="phonebook") \& de_AT_phonebook 30 = 27 (type="phonebook") \& dsb 30 = 26 \& ee 30 = 21 \& eo 30 = 1.8.1 \& es 30 = 1.9.0 (type="standard") \& es_\|_traditional 30 = 1.8.1 (type="traditional") \& et 30 = 26 \& fa 22.1 = 1.8.1 \& fi 22.1 = 1.8.1 (type="standard" alt="proposed") \& fi_\|_phonebook 22.1 = 1.8.1 (type="phonebook") \& fil 30 = 1.9.0 (type="standard") = 1.8.1 \& fo 22.1 = 1.8.1 (alt="proposed" type="standard") \& fr_CA 30 = 1.9.0 \& gu 30 = 28 ("standard" wo [reorder Gujr..]) = 1.9.0 \& ha 30 = 1.9.0 \& haw 30 = 24 \& he 30 = 28 (without [reorder Hebr]) = 23 \& hi 30 = 28 (without [reorder Deva..]) = 1.9.0 \& hr 30 = 28 ("standard" wo [reorder Latn Cyrl]) = 1.9.0 \& hu 22.1 = 1.8.1 (alt="proposed" type="standard") \& hy 30 = 28 (without [reorder Armn]) = 1.8.1 \& ig 30 = 1.8.1 \& is 22.1 = 1.8.1 (type="standard") \& ja 22.1 = 1.8.1 (type="standard") \& kk 30 = 28 (without [reorder Cyrl]) \& kl 22.1 = 1.8.1 (type="standard") \& kn 30 = 28 ("standard" wo [reorder Knda..]) = 1.9.0 \& ko 22.1 = 1.8.1 (type="standard") \& kok 30 = 28 (without [reorder Deva..]) = 1.8.1 \& lkt 30 = 25 \& ln 30 = 2.0 (type="standard") = 1.8.1 \& lt 22.1 = 1.9.0 \& lv 22.1 = 1.9.0 (type="standard") = 1.8.1 \& mk 30 = 28 (without [reorder Cyrl]) \& ml 22.1 = 1.9.0 \& mr 30 = 28 (without [reorder Deva..]) = 1.8.1 \& mt 22.1 = 1.9.0 \& nb 22.1 = 2.0 (type="standard") \& nn 22.1 = 2.0 (type="standard") \& nso [*] 26 = 1.8.1 \& om 22.1 = 1.8.1 \& or 30 = 28 (without [reorder Orya..]) = 1.9.0 \& pa 22.1 = 1.8.1 \& pl 30 = 1.8.1 \& ro 30 = 1.9.0 (type="standard") \& sa [*] 1.9.1 = 1.8.1 (type="standard" alt="proposed") \& se 22.1 = 1.8.1 (type="standard") \& si 30 = 28 ("standard" wo [reorder Sinh..]) = 1.9.0 \& si_\|_dictionary 30 = 28 ("dictionary" wo [reorder Sinh..]) = 1.9.0 \& sk 22.1 = 1.9.0 (type="standard") \& sl 22.1 = 1.8.1 (type="standard" alt="proposed") \& sq 22.1 = 1.8.1 (alt="proposed" type="standard") \& sr 30 = 28 (without [reorder Cyrl]) \& sr_Latn 30 = 28 (type="standard": [import hr]) \& sv 22.1 = 1.9.0 (type="standard") \& sv_\|_reformed 22.1 = 1.8.1 (type="reformed") \& ta 22.1 = 1.9.0 \& te 30 = 28 (without [reorder Telu..]) = 1.9.0 \& th 22.1 = 22 \& tn [*] 26 = 1.8.1 \& to 22.1 = 22 \& tr 22.1 = 1.8.1 (type="standard") \& uk 30 = 28 (without [reorder Cyrl]) \& ug_Cyrl https://en.wikipedia.org/wiki/Uyghur_Cyrillic_alphabet \& ur 22.1 = 1.9.0 \& vi 22.1 = 1.8.1 \& vo 30 = 25 \& wae 30 = 2.0 \& wo [*] 1.9.1 = 1.8.1 \& yo 30 = 1.8.1 \& zh 22.1 = 1.8.1 (type="standard") \& zh_\|_big5han 22.1 = 1.8.1 (type="big5han") \& zh_\|_gb2312han 22.1 = 1.8.1 (type="gb2312han") \& zh_\|_pinyin 22.1 = 2.0 (type=\*(Aqpinyin\*(Aq alt=\*(Aqshort\*(Aq) \& zh_\|_stroke 22.1 = 1.9.1 (type=\*(Aqstroke\*(Aq alt=\*(Aqshort\*(Aq) \& zh_\|_zhuyin 22.1 = 22 (type=\*(Aqzhuyin\*(Aq alt=\*(Aqshort\*(Aq) \& \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- .Ve .PP [*] http://www.unicode.org/repos/cldr/tags/latest/seed/collation/ .SH AUTHOR .IX Header "AUTHOR" The Unicode::Collate::Locale module for perl was written by SADAHIRO Tomoyuki, <SADAHIRO@cpan.org>. This module is Copyright(C) 2004\-2020, SADAHIRO Tomoyuki. Japan. All rights reserved. .PP This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. .SH "SEE ALSO" .IX Header "SEE ALSO" .IP "Unicode Collation Algorithm \- UTS #10" 4 .IX Item "Unicode Collation Algorithm - UTS #10" <http://www.unicode.org/reports/tr10/> .IP "The Default Unicode Collation Element Table (DUCET)" 4 .IX Item "The Default Unicode Collation Element Table (DUCET)" <http://www.unicode.org/Public/UCA/latest/allkeys.txt> .IP "Unicode Locale Data Markup Language (LDML) \- UTS #35" 4 .IX Item "Unicode Locale Data Markup Language (LDML) - UTS #35" <http://www.unicode.org/reports/tr35/> .IP "CLDR \- Unicode Common Locale Data Repository" 4 .IX Item "CLDR - Unicode Common Locale Data Repository" <http://cldr.unicode.org/> .IP Unicode::Collate 4 .IX Item "Unicode::Collate" .PD 0 .IP Unicode::Normalize 4 .IX Item "Unicode::Normalize"