CMake と gettext の連携: 国際化とローカライズ (i18n & l10n) を容易に

CMake Modules の FindGettext プログラミング解説

FindGettext は、CMake モジュールの一つで、GNU gettext ライブラリとツールを見つけ、ビルドプロジェクトで使用できるようにするためのものです。gettext は、国際化とローカライズ (i18n & l10n) をサポートするためのライブラリとツール群を提供します。

FindGettext は以下の機能を提供します。

• gettext ランタイムライブラリ (LGPL) とヘッダーファイルの検索
• gettext ツール (xgettext、msginit、msgmerge、msgcat、msgconv、msgfmt) の検索
• gettext 関連の変数の設定
  • GETTEXT_INCLUDE_DIR: gettext ヘッダーファイルのパス
  • GETTEXT_LIBRARIES: gettext ライブラリのパス
  • GETTEXT_INTL_LIBRARY: gettext インターナショナルライブラリのパス
  • GETTEXT_RUNTIME_FOUND: gettext ランタイムライブラリが見つかったかどうか
  • GETTEXT_INFO_MSG: gettext に関する情報メッセージ
  • GETTEXT_XGETTEXT_EXECUTABLE: xgettext ツールのパス
  • GETTEXT_MSGINIT_EXECUTABLE: msginit ツールのパス
  • GETTEXT_MSGMERGE_EXECUTABLE: msgmerge ツールのパス
  • GETTEXT_TOOLS_FOUND: gettext ツールが見つかったかどうか
  • GETTEXT_FOUND: gettext ランタイムライブラリとツールが見つかったかどうか

FindGettext は、CMake の find_package() コマンドを使って使用できます。

find_package(Gettext REQUIRED)

# gettext ヘッダーファイルのインクルード
include_directories(${GETTEXT_INCLUDE_DIR})

# gettext ライブラリとのリンク
target_link_libraries(your_target ${GETTEXT_LIBRARIES})

FindGettext は、デフォルトでいくつかのパスを検索しますが、GETTEXT_SEARCH_PATH 変数を設定することで、検索パスをカスタマイズできます。

set(GETTEXT_SEARCH_PATH /usr/local /opt)

find_package(Gettext REQUIRED)

FindGettext の詳細については、以下のリソースを参照してください。

補足

• FindGettext は、CMake バージョン 3.2 以降で使用できます。
• gettext は、多くの Linux ディストリビューションと macOS にデフォルトでインストールされています。
• Windows で gettext を使用するには、Cygwin や MinGW などの環境が必要となります。

FindGettext のサンプルコード

シンプルなサンプル

find_package(Gettext REQUIRED)

# gettext ヘッダーファイルのインクルード
include_directories(${GETTEXT_INCLUDE_DIR})

# gettext ライブラリとのリンク
target_link_libraries(your_target ${GETTEXT_LIBRARIES})

検索パスのカスタマイズ

set(GETTEXT_SEARCH_PATH /usr/local /opt)

find_package(Gettext REQUIRED)

gettext ツールの使用

find_package(Gettext REQUIRED)

# xgettext ツールを使って PO ファイルを生成
add_custom_command(
  OUTPUT ${CMAKE_CURRENT_SOURCE_DIR}/my.po
  COMMAND ${GETTEXT_XGETTEXT_EXECUTABLE}
    --from-code=utf-8
    --output=${CMAKE_CURRENT_SOURCE_DIR}/my.po
    ${CMAKE_CURRENT_SOURCE_DIR}/my.c
)

# msginit ツールを使って POT ファイルを初期化
add_custom_command(
  OUTPUT ${CMAKE_CURRENT_SOURCE_DIR}/my.pot
  COMMAND ${GETTEXT_MSGINIT_EXECUTABLE}
    --locale=ja
    --output=${CMAKE_CURRENT_SOURCE_DIR}/my.pot
)

# msgmerge ツールを使って PO ファイルを更新
add_custom_command(
  OUTPUT ${CMAKE_CURRENT_SOURCE_DIR}/my.po
  COMMAND ${GETTEXT_MSGMERGE_EXECUTABLE}
    --update
    --output=${CMAKE_CURRENT_SOURCE_DIR}/my.po
    ${CMAKE_CURRENT_SOURCE_DIR}/my.po
    ${CMAKE_CURRENT_SOURCE_DIR}/my.pot
)

# msgfmt ツールを使って MO ファイルを生成
add_custom_command(
  OUTPUT ${CMAKE_CURRENT_SOURCE_DIR}/my.mo
  COMMAND ${GETTEXT_MSGFMT_EXECUTABLE}
    --output=${CMAKE_CURRENT_SOURCE_DIR}/my.mo
    ${CMAKE_CURRENT_SOURCE_DIR}/my.po
)

上記のサンプルコードは、あくまでも参考です。実際の使用例は、プロジェクトの環境や要件に合わせて変更する必要があります。

FindGettext 以外の方法

手動でパスを設定する

set(GETTEXT_INCLUDE_DIR /usr/local/include/gettext)
set(GETTEXT_LIBRARIES /usr/local/lib/libgettext.so)

# gettext ヘッダーファイルのインクルード
include_directories(${GETTEXT_INCLUDE_DIR})

# gettext ライブラリとのリンク
target_link_libraries(your_target ${GETTEXT_LIBRARIES})

注意

この方法は、gettext のインストールパスが分かっている場合にのみ使用できます。

外部プロジェクトを使う

ExternalProject モジュールなどの外部プロジェクトを使って、gettext をビルドしてインストールすることができます。

set(GETTEXT_VERSION 0.21)

ExternalProject_Add(gettext
  URL https://ftp.gnu.org/gnu/gettext/gettext-${GETTEXT_VERSION}.tar.gz
  BUILD_IN_SOURCE 1
  CONFIGURE_COMMAND ./configure --prefix=${CMAKE_BINARY_DIR}/gettext-install
  BUILD_COMMAND make
  INSTALL_COMMAND make install
)

# gettext ヘッダーファイルのインクルード
include_directories(${GETTEXT_INSTALL_DIR}/include)

# gettext ライブラリとのリンク
target_link_libraries(your_target ${GETTEXT_INSTALL_DIR}/lib/libgettext.so)

注意

この方法は、複雑な手順が必要となります。

CMakeLists.txt を直接編集する

gettext ツールを使う場合は、CMakeLists.txt を直接編集して、ツールを実行するコマンドを記述することができます。

add_custom_command(
  OUTPUT ${CMAKE_CURRENT_SOURCE_DIR}/my.mo
  COMMAND ${GETTEXT_MSGFMT_EXECUTABLE}
    --output=${CMAKE_CURRENT_SOURCE_DIR}/my.mo
    ${CMAKE_CURRENT_SOURCE_DIR}/my.po
)

注意

この方法は、可読性が低く、保守性が悪くなります。

FindGettext は、gettext を CMake プロジェクトで使用するための最も簡単な方法です。ただし、プロジェクトの環境や要件によっては、他の方法の方が適している場合があります。