/ 
Encode-UTF8Mac-0.04
River stage one • 1 direct dependent • 1 total dependent
++
 / Encode::UTF8Mac
Naoki Tomita
and 1 contributors

NAME

Encode::UTF8Mac - "utf-8-mac" a variant utf-8 used by OSX filesystem

SYNOPSIS

  use Encode;
  use Encode::UTF8Mac;
  
  # some filename from osx...
  my ($filename) = <*.txt>;
  
  # it is possible to decode by "utf-8" but...
  $filename = Encode::decode('utf-8', $filename);
  # => "poke\x{0301}mon.txt" (NFD é)
  #        ^^^^^^^^^ 2 unicode strings: "LATIN SMALL LETTER E" and "COMBINING ACUTE ACCENT"
  
  # probably you want these unicode strings.
  $filename = Encode::decode('utf-8-mac', $filename);
  # => "pok\x{00E9}mon.txt" (NFC é)
  #        ^^^^^^^^ single unicode: "LATIN SMALL LETTER E WITH ACUTE"

DESCRIPTION

Encode::UTF8Mac provides a encoding named "utf-8-mac".

On OSX, utf-8 encoding is used and it is NFD (Normalization Form canonical Decomposition) form. If you want to get NFC (Normalization Form canonical Composition) character you need to use Unicode::Normalize's NFC().

However, OSX filesystem does not follow the exact specification. Specifically, the following ranges are not decomposed.

  U+2000-U+2FFF
  U+F900-U+FAFF
  U+2F800-U+2FAFF

http://developer.apple.com/library/mac/#qa/qa2001/qa1173.html

iconv (bundled Mac) can use this encoding as "utf-8-mac".

This module adds same name "utf-8-mac" encoding for Encode, it encode/decode text with that rule in mind. This will help when you decode file name on Mac.

See more information and Japanese example:

Encode::UTF8Mac makes you happy while handling file names on MacOSX

ENCODING

utf-8-mac

  • Encode::decode('utf-8-mac', $octets)

    Decode as utf-8, and normalize form C except special range using Unicode::Normalize.

  • Encode::encode('utf-8-mac', $string)

    Normalize form D except special range using Unicode::Normalize, and encode as utf-8.

    OSX file system change NFD automatically. So actually, this is not necessary.

COOKBOOK

  use Encode;
  use Encode::Locale;
  
  # change locale_fs "utf-8" to "utf-8-mac"
  if ($^O eq 'darwin') {
      require Encode::UTF8Mac;
      $Encode::Locale::ENCODING_LOCALE_FS = 'utf-8-mac';
  }
  
  $filename = Encode::decode('locale_fs', $filename);

If you are using Encode::Locale, you may want to do this.

SEE ALSO

Encode::Locale - provides useful "magic" encoding.

Unicode::Normalize::Mac - this module uses it internally.

AUTHOR

Naoki Tomita <tomita@cpan.org>

LICENSE

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.