「入門Mercurial Linux/Windows対応」発売中（詳細は「執筆情報」参照）

文字コード

Mercurial での日本語利用における文字コードの扱いに関してまとめてみました。

• 文字コード設定の確認
• 明示的な文字コードの設定
• 日本語 Windows 環境でのファイル名問題
• Emacs の hg モード利用における留意点
• 分散リポジトリ間での日本語ファイル名問題

文字コード設定の確認

Mercurial 固有の明示的な設定（後述）を行わない場合、 Python 標準の locale モジュールが提供する getpreferredencoding() メソッドの戻り値で文字コードが決定されます （文字コード確定手順の詳細は、 Mercurial ソースの mercurial/encoding.py 冒頭の try 節を参照ください）。

例えば私が主に使用している環境(cygwin)では

% python
> import locale
> locale.getpreferredencoding()
'US-ASCII'

となるため、日本語は使えません。

この段階で希望する文字コードが選択されているなら、 Mercurial は問題なく日本語を通してくれます。

文字列変換で不正なバイト列が検出された場合の Mercurial の基底動作が「中断」となっているため、 例えば日本語を含むファイル commit.ja.log の内容をメッセージとして commit しようとすると、 以下のようなエラーとなります （ページ表示の都合上、 Python が不正とみなす文字を "xxxx" で置換しています）。

% hg commit -l commit.ja.log
abort: decoding near 'xxxx': 'ascii' codec can't decode byte 
       0xe6 in position 0: ordinal not in range(128)!
transaction abort!
rollback completed

明示的な文字コードの設定

Mercurial は、 "HGENCODING" 環境変数により、 ロケール系環境変数 （e.g.: LC_CTYPE や LC_ALL、LANG） とは独立して文字コード指定を行うことができます。

特に Cygwin 環境では、ロケール系環境変数（と Python の locale モジュール） は機能しないと考えたほうが良いですので、 HGENCODING を使用しましょう。

% echo ${HGENCODING}
cp932
% hg commit -l commit.ja.log
% hg log
changeset:   0:65b7f27315f7
tag:         tip
user:        FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
date:        Sun Sep 23 18:29:46 2007 +0900
summary:     日本語のログメッセージ

設定する文字コード名の可否に関しては:

% python
>>> unicode('abcdefg', '文字コード名')"

といったスクリプトを Python に実行させてみて、 正常に終了するか否かで判定することができます。

また、 不正な文字コードが検出された場合の Mercurial の挙動を制御するための HGENCODINGMODE という環境変数も存在しますが、 危険を承知でデフォルトの「中断」（"strict" を指定） 以外に設定する必要性は低いと思われます。

各環境変数の仕様に関する詳細は、 "hg help environment" が出力するヘルプを参照してください。

日本語 Windows 環境でのファイル名問題

日本語 Windows 環境では、 ファイル名自身の文字コードには cp932（厳密には違いますが、 「Shift_JIS」と言ったほうが通りが良いかもしれません） が使用されています。

cp932 符号化方式では、 幾つかの２バイト文字が２バイト目に 0x5c、 すなわち「バックスラッシュ」と同じコード値を持つ （例えばカタカナの「ソ」を表すバイト列は 0x83 0x5c）ため、 OS のパス区切りとの区別が付かないことから、 これらの文字を含むファイル・ディレクトリ名を適切に扱うことができません。

この問題は HGENCODING 環境変数を設定しても解決しません （解決しても良さそうなものなのですが…）ので:

余計な手間をかけたくない場合:

日本語ファイル名の使用を諦めるか、 0x5c を含まない文字を使用するしかありません。

もっとも「0x5c を含まない文字」 か否かをいちいち判定していたのでは面倒なことこの上ありませんから、 実質「日本語ファイル名の使用を諦める」一択しかないでしょう。

多少は手間をかけても良い場合:

Mercurial の 1.0 版、 ないし TortoiseHG の 0.3 版以降であれば、 win32mbcs エクステンションを利用することで、 この問題を解決可能です。

但し、 このエクステンションはデフォルトでは無効化されていますので、 適切な場所の Mercurial.ini ないし hgrc で 有効化する必要があります。

といった対応が必要です。

Emacs の hg モード利用における留意点

Emacs の hg モード経由で Mercurial を利用する場合、 ファイル名やログメッセージに日本語を使用するに当たって、 確認が必要な点が２つあります。

まず第１は、 hg モード経由での Mercurial 利用はシェルを経由しないため、 当該 Emacs プロセスそのものに対して HGENCODING 環境変数が設定されていることを確認してください。 Meadow のような非 Cygwin プロセスの場合は、 「システムプロパティ」の「環境変数設定」による設定が必要です。

第２に、 以下の lisp 変数にも HGENCODING （および稼働環境の OS） と辻褄の合う適切な値が設定されていることが必要です。

• process-coding-system （ないし default-process-coding-system）
• file-name-coding-system （ないし default-file-name-coding-system）

以上の２点が適切であることが確認できれば:

hg モードにおける日本語利用（画像）

日本語ファイル名のファイルを add することも、 日本語のログメッセージを入力することも （勿論、日本語のログメッセージの閲覧も）可能です。

分散リポジトリ間での日本語ファイル名問題

HGENCODING 環境変数を使用することで、 Mercurial は日本語ファイル名を使用することができるようになるのですが:

1. Windows 環境下で HGENCODING=cp932 を設定
2. Windows 環境下で日本語ファイル名のファイルを構成管理対象に追加
3. Linux 環境下で HGENCODING=euc-jp を設定
4. Windows 環境下のリポジトリから Linux 環境下のリポジトリへ push
5. Linux 環境下で "hg update" を実施