Perl 5 version 26.3 documentation

Unicode::Collate::Locale

NAME

Unicode::Collate::Locale - Linguistic tailoring for DUCET via Unicode::Collate

SYNOPSIS

  1. use Unicode::Collate::Locale;
  2. #construct
  3. $Collator = Unicode::Collate::Locale->
  4. new(locale => $locale_name, %tailoring);
  5. #sort
  6. @sorted = $Collator->sort(@not_sorted);
  7. #compare
  8. $result = $Collator->cmp($a, $b); # returns 1, 0, or -1.

Note: Strings in @not_sorted , $a and $b are interpreted according to Perl's Unicode support. See perlunicode, perluniintro, perlunitut, perlunifaq, utf8. Otherwise you can use preprocess (cf. Unicode::Collate ) or should decode them before.

DESCRIPTION

This module provides linguistic tailoring for it taking advantage of Unicode::Collate .

Constructor

The new method returns a collator object.

A parameter list for the constructor is a hash, which can include a special key locale and its value (case-insensitive) standing for a Unicode base language code (two or three-letter). For example, Unicode::Collate::Locale->new(locale => 'ES') returns a collator tailored for Spanish.

$locale_name 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 '_' or '-' . E.g. en_US for English in USA, az_Cyrl for Azerbaijani in the Cyrillic script, es_ES_traditional for Spanish in Spain (Traditional).

If $locale_name is not available, fallback is selected in the following order:

  1. 1. language with a variant code
  2. 2. language with a script code
  3. 3. language with a region code
  4. 4. language
  5. 5. default

Tailoring tags provided by Unicode::Collate are allowed as long as they are not used for locale support. Esp. the table tag is always untailorable, since it is reserved for DUCET.

However entry is allowed, even if it is used for locale support, to add or override mappings.

E.g. a collator for Spanish, which ignores diacritics and case difference (i.e. level 1), with reversed case ordering and no normalization.

  1. Unicode::Collate::Locale->new(
  2. level => 1,
  3. locale => 'es',
  4. upper_before_lower => 1,
  5. normalization => undef
  6. )

Overriding a behavior already tailored by locale is disallowed if such a tailoring is passed to new() .

  1. Unicode::Collate::Locale->new(
  2. locale => 'da',
  3. upper_before_lower => 0, # causes error as reserved by 'da'
  4. )

However change() inherited from Unicode::Collate allows such a tailoring that is reserved by locale . Examples:

  1. new(locale => 'fr_ca')->change(backwards => undef)
  2. new(locale => 'da')->change(upper_before_lower => 0)
  3. new(locale => 'ja')->change(overrideCJK => undef)

Methods

Unicode::Collate::Locale is a subclass of Unicode::Collate and methods other than new are inherited from Unicode::Collate .

Here is a list of additional methods:

  • $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 'default' meaning no special tailoring.

  • $Collator->locale_version

    (Since Unicode::Collate::Locale 0.87) Returns the version number (perhaps /\d\.\d\d/ ) of the locale, as that of Locale/*.pl.

    Note: Locale/*.pl that a collator uses should be identified by a combination of return values from getlocale and locale_version .

A list of tailorable locales

  1. locale name description
  2. --------------------------------------------------------------
  3. af Afrikaans
  4. ar Arabic
  5. as Assamese
  6. az Azerbaijani (Azeri)
  7. be Belarusian
  8. bn Bengali
  9. bs Bosnian (tailored as Croatian)
  10. bs_Cyrl Bosnian in Cyrillic (tailored as Serbian)
  11. ca Catalan
  12. cs Czech
  13. cy Welsh
  14. da Danish
  15. de__phonebook German (umlaut as 'ae', 'oe', 'ue')
  16. de_AT_phonebook Austrian German (umlaut primary greater)
  17. ee Ewe
  18. eo Esperanto
  19. es Spanish
  20. es__traditional Spanish ('ch' and 'll' as a grapheme)
  21. et Estonian
  22. fa Persian
  23. fi Finnish (v and w are primary equal)
  24. fi__phonebook Finnish (v and w as separate characters)
  25. fil Filipino
  26. fo Faroese
  27. fr_CA Canadian French
  28. gu Gujarati
  29. ha Hausa
  30. haw Hawaiian
  31. he Hebrew
  32. hi Hindi
  33. hr Croatian
  34. hu Hungarian
  35. hy Armenian
  36. ig Igbo
  37. is Icelandic
  38. ja Japanese [1]
  39. kk Kazakh
  40. kl Kalaallisut
  41. kn Kannada
  42. ko Korean [2]
  43. kok Konkani
  44. ln Lingala
  45. lt Lithuanian
  46. lv Latvian
  47. mk Macedonian
  48. ml Malayalam
  49. mr Marathi
  50. mt Maltese
  51. nb Norwegian Bokmal
  52. nn Norwegian Nynorsk
  53. nso Northern Sotho
  54. om Oromo
  55. or Oriya
  56. pa Punjabi
  57. pl Polish
  58. ro Romanian
  59. sa Sanskrit
  60. se Northern Sami
  61. si Sinhala
  62. si__dictionary Sinhala (U+0DA5 = U+0DA2,0DCA,0DA4)
  63. sk Slovak
  64. sl Slovenian
  65. sq Albanian
  66. sr Serbian
  67. sr_Latn Serbian in Latin (tailored as Croatian)
  68. sv Swedish (v and w are primary equal)
  69. sv__reformed Swedish (v and w as separate characters)
  70. ta Tamil
  71. te Telugu
  72. th Thai
  73. tn Tswana
  74. to Tonga
  75. tr Turkish
  76. ug_Cyrl Uyghur in Cyrillic
  77. uk Ukrainian
  78. ur Urdu
  79. vi Vietnamese
  80. vo Volapuk
  81. wae Walser
  82. wo Wolof
  83. yo Yoruba
  84. zh Chinese
  85. zh__big5han Chinese (ideographs: big5 order)
  86. zh__gb2312han Chinese (ideographs: GB-2312 order)
  87. zh__pinyin Chinese (ideographs: pinyin order) [3]
  88. zh__stroke Chinese (ideographs: stroke order) [3]
  89. zh__zhuyin Chinese (ideographs: zhuyin order) [3]
  90. --------------------------------------------------------------

Locales according to the default UCA rules include am (Amharic) without [reorder Ethi] , bg (Bulgarian) without [reorder Cyrl] , chr (Cherokee) without [reorder Cher] , de (German), en (English), fr (French), ga (Irish), id (Indonesian), it (Italian), ka (Georgian) without [reorder Geor] , mn (Mongolian) without [reorder Cyrl Mong] , ms (Malay), nl (Dutch), pt (Portuguese), ru (Russian) without [reorder Cyrl] , sw (Swahili), zu (Zulu).

Note

[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 (variable => 'Non-ignorable') , and then katakana_before_hiragana has no effect.

[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.

[3] zh__pinyin, zh__stroke and zh__zhuyin: implemented alt='short', where a smaller number of ideographs are tailored.

Note: 'pinyin' is in latin, 'zhuyin' is in bopomofo.

INSTALL

Installation of Unicode::Collate::Locale requires Collate/Locale.pm, Collate/Locale/*.pm, Collate/CJK/*.pm and Collate/allkeys.txt. On building, Unicode::Collate::Locale doesn't require any of data/*.txt, gendata/*, and mklocale. Tests for Unicode::Collate::Locale are named t/loc_*.t.

CAVEAT

  • 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 (U+FF37 ), W with acute (U+1E82 ), etc. are not tailored. The result may depend on whether source strings are normalized or not, and whether decomposed or composed. Thus (normalization => undef) is less preferred.

  • Collation reordering is not supported

    The order of any groups including scripts is not changed.

Reference

  1. locale based CLDR or other reference
  2. --------------------------------------------------------------------
  3. af 30 = 1.8.1
  4. ar 22.1 = 1.9.0
  5. as 30 = 28 (without [reorder Beng..]) = 23
  6. az 30 = 24 (type="standard" without [reorder Latn Cyrl])
  7. be 30 = 28 (without [reorder Cyrl])
  8. bn 30 = 28 (type="standard" wo [reorder Beng..]) = 2.0.1
  9. bs 30 = 28 (type="standard": [import hr])
  10. bs_Cyrl 30 = 28 (type="standard": [import sr])
  11. ca 30 = 23 (alt="proposed" type="standard")
  12. cs 30 = 1.8.1 (type="standard")
  13. cy 30 = 1.8.1
  14. da 22.1 = 1.8.1 (type="standard")
  15. de__phonebook 30 = 2.0 (type="phonebook")
  16. de_AT_phonebook 30 = 27 (type="phonebook")
  17. ee 22.1 = 22
  18. eo 30 = 1.8.1
  19. es 30 = 1.9.0 (type="standard")
  20. es__traditional 30 = 1.8.1 (type="traditional")
  21. et 30 = 26
  22. fa 22.1 = 1.8.1
  23. fi 22.1 = 1.8.1 (type="standard" alt="proposed")
  24. fi__phonebook 22.1 = 1.8.1 (type="phonebook")
  25. fil 30 = 1.9.0 (type="standard") = 1.8.1
  26. fo 22.1 = 1.8.1 (alt="proposed" type="standard")
  27. fr_CA 30 = 1.9.0
  28. gu 30 = 28 (type="standard" wo [reorder Gujr..]) = 1.9.0
  29. ha 30 = 1.9.0
  30. haw 30 = 24
  31. he 30 = 28 (without [reorder Hebr]) = 23
  32. hi 30 = 28 (without [reorder Deva..]) = 1.9.0
  33. hr 22.1 = 1.9.0 (type="standard")
  34. hu 22.1 = 1.8.1 (alt="proposed" type="standard")
  35. hy 30 = 28 (without [reorder Armn]) = 1.8.1
  36. ig 30 = 1.8.1
  37. is 22.1 = 1.8.1 (type="standard")
  38. ja 22.1 = 1.8.1 (type="standard")
  39. kk 30 = 28 (without [reorder Cyrl])
  40. kl 22.1 = 1.8.1 (type="standard")
  41. kn 30 = 28 (type="standard" wo [reorder Knda..]) = 1.9.0
  42. ko 22.1 = 1.8.1 (type="standard")
  43. kok 30 = 28 (without [reorder Deva..]) = 1.8.1
  44. ln 30 = 2.0 (type="standard") = 1.8.1
  45. lt 22.1 = 1.9.0
  46. lv 22.1 = 1.9.0 (type="standard") = 1.8.1
  47. mk 30 = 28 (without [reorder Cyrl])
  48. ml 22.1 = 1.9.0
  49. mr 30 = 28 (without [reorder Deva..]) = 1.8.1
  50. mt 22.1 = 1.9.0
  51. nb 22.1 = 2.0 (type="standard")
  52. nn 22.1 = 2.0 (type="standard")
  53. nso [*] 26 = 1.8.1
  54. om 22.1 = 1.8.1
  55. or 30 = 28 (without [reorder Orya..]) = 1.9.0
  56. pa 22.1 = 1.8.1
  57. pl 30 = 1.8.1
  58. ro 30 = 1.9.0 (type="standard")
  59. sa [*] 1.9.1 = 1.8.1 (type="standard" alt="proposed")
  60. se 22.1 = 1.8.1 (type="standard")
  61. si 30 = 28 (type="standard" wo [reorder Sinh..]) = 1.9.0
  62. si__dictionary 30 = 28 (type="dictionary" wo [reorder Sinh..]) = 1.9.0
  63. sk 22.1 = 1.9.0 (type="standard")
  64. sl 22.1 = 1.8.1 (type="standard" alt="proposed")
  65. sq 22.1 = 1.8.1 (alt="proposed" type="standard")
  66. sr 30 = 28 (without [reorder Cyrl])
  67. sr_Latn 30 = 28 (type="standard": [import hr])
  68. sv 22.1 = 1.9.0 (type="standard")
  69. sv__reformed 22.1 = 1.8.1 (type="reformed")
  70. ta 22.1 = 1.9.0
  71. te 30 = 28 (without [reorder Telu..]) = 1.9.0
  72. th 22.1 = 22
  73. tn [*] 26 = 1.8.1
  74. to 22.1 = 22
  75. tr 22.1 = 1.8.1 (type="standard")
  76. uk 30 = 28 (without [reorder Cyrl])
  77. ug_Cyrl https://en.wikipedia.org/wiki/Uyghur_Cyrillic_alphabet
  78. ur 22.1 = 1.9.0
  79. vi 22.1 = 1.8.1
  80. vo 30 = 25
  81. wae 30 = 2.0
  82. wo [*] 1.9.1 = 1.8.1
  83. yo 30 = 1.8.1
  84. zh 22.1 = 1.8.1 (type="standard")
  85. zh__big5han 22.1 = 1.8.1 (type="big5han")
  86. zh__gb2312han 22.1 = 1.8.1 (type="gb2312han")
  87. zh__pinyin 22.1 = 2.0 (type='pinyin' alt='short')
  88. zh__stroke 22.1 = 1.9.1 (type='stroke' alt='short')
  89. zh__zhuyin 22.1 = 22 (type='zhuyin' alt='short')
  90. --------------------------------------------------------------------

[*] http://www.unicode.org/repos/cldr/tags/latest/seed/collation/

AUTHOR

The Unicode::Collate::Locale module for perl was written by SADAHIRO Tomoyuki, <SADAHIRO@cpan.org>. This module is Copyright(C) 2004-2016, SADAHIRO 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.

SEE ALSO