CMakeの「CMAKE_EXPORT_NO_PACKAGE_REGISTRY」を使いこなして、開発をもっと効率化しよう！

CMakeの変数「CMAKE_EXPORT_NO_PACKAGE_REGISTRY」徹底解説

CMAKE_EXPORT_NO_PACKAGE_REGISTRY は、CMake の "Variables" における重要な変数の 1 つです。これは、export(PACKAGE) コマンドの動作を制御し、特定の状況下でパッケージレジストリへの書き込みを抑制するために使用されます。

詳細解説

機能

CMAKE_EXPORT_NO_PACKAGE_REGISTRY は、以下の 2 つの状況で特に役立ちます。

• パッケージング: パッケージングシステムが独自のレジストリを使用する場合、CMake のレジストリへの書き込みは不要です。
• システム全体のインストール: システム全体のインストールでは、通常、ユーザーレジストリへの書き込みは望ましくありません。

設定方法

CMAKE_EXPORT_NO_PACKAGE_REGISTRY は、CMakeLists.txt ファイル内で以下の方法で設定できます。

set(CMAKE_EXPORT_NO_PACKAGE_REGISTRY ON)

この設定を有効にすると、export(PACKAGE) コマンドは何も実行せず、パッケージレジストリへの書き込みは行われません。

注意点

• CMAKE_EXPORT_NO_PACKAGE_REGISTRY は、CMake 3.1 以降でのみ使用できます。
• この変数を設定すると、find_package() コマンドが正しく動作しなくなる可能性があります。
• システム全体のインストールでは、CMAKE_INSTALL_PREFIX と組み合わせて使用するのが一般的です。

例

以下は、CMAKE_EXPORT_NO_PACKAGE_REGISTRY を使用して、システム全体のインストールを行う例です。

set(CMAKE_EXPORT_NO_PACKAGE_REGISTRY ON)
set(CMAKE_INSTALL_PREFIX /usr/local)

install(TARGETS my_target
        RUNTIME DESTINATION bin
        LIBRARY DESTINATION lib
        ARCHIVE DESTINATION lib)

この例では、my_target は /usr/local/bin にインストールされ、ライブラリは /usr/local/lib にインストールされます。レジストリへの書き込みは行われません。

CMAKE_EXPORT_NO_PACKAGE_REGISTRY は、特定の状況下でパッケージレジストリへの書き込みを抑制するために使用できる便利な変数です。使用方法を理解することで、CMake の柔軟性をさらに活用することができます。

CMake の CMAKE_EXPORT_NO_PACKAGE_REGISTRY を使ったサンプルコード

基本的なサンプル

# CMakeLists.txt

set(CMAKE_EXPORT_NO_PACKAGE_REGISTRY ON)

add_library(my_library SHARED src/my_library.c)

target_link_libraries(my_library PUBLIC other_library)

install(TARGETS my_library
        RUNTIME DESTINATION bin
        LIBRARY DESTINATION lib
        ARCHIVE DESTINATION lib)

システム全体のインストール

# CMakeLists.txt

set(CMAKE_EXPORT_NO_PACKAGE_REGISTRY ON)
set(CMAKE_INSTALL_PREFIX /usr/local)

add_library(my_library SHARED src/my_library.c)

target_link_libraries(my_library PUBLIC other_library)

install(TARGETS my_library
        RUNTIME DESTINATION bin
        LIBRARY DESTINATION lib
        ARCHIVE DESTINATION lib)

この例では、my_library を /usr/local にインストールします。レジストリへの書き込みは行われません。

パッケージングシステムとの連携

# CMakeLists.txt

set(CMAKE_EXPORT_NO_PACKAGE_REGISTRY ON)
set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake)

find_package(PkgConfig REQUIRED)

pkg_check_modules(PKG_CONFIG_MODULE pkg-config)

add_library(my_library SHARED src/my_library.c)

target_link_libraries(my_library PUBLIC PKG_CONFIG_MODULE)

install(TARGETS my_library
        RUNTIME DESTINATION bin
        LIBRARY DESTINATION lib
        ARCHIVE DESTINATION lib)

export(PACKAGE my_library)

この例では、PkgConfig を使用して外部ライブラリ pkg-config を検索し、my_library にリンクします。CMAKE_EXPORT_NO_PACKAGE_REGISTRY が設定されているため、レジストリへの書き込みは行われません。

まとめ

CMAKE_EXPORT_NO_PACKAGE_REGISTRY は、特定の状況下でパッケージレジストリへの書き込みを抑制するために使用できる便利な変数です。上記のサンプルコードを参考に、さまざまな状況で活用してみてください。

CMake の CMAKE_EXPORT_NO_PACKAGE_REGISTRY 以外の方法

install(EXPORT) コマンドを使用して、ターゲットの情報をファイルに書き出すことができます。このファイルは、後から find_package() コマンドによって読み込まれます。

# CMakeLists.txt

add_library(my_library SHARED src/my_library.c)

install(TARGETS my_library
        RUNTIME DESTINATION bin
        LIBRARY DESTINATION lib
        ARCHIVE DESTINATION lib)

install(EXPORT my_library
        DESTINATION etc/my_library)

この例では、my_library の情報を /etc/my_library に書き出します。

カスタム CMake モジュールを作成して、レジストリへの書き込みを制御することもできます。

# my_module.cmake

set(CMAKE_EXPORT_NO_PACKAGE_REGISTRY ON)

function(my_install_target target)
    install(TARGETS ${target}
            RUNTIME DESTINATION bin
            LIBRARY DESTINATION lib
            ARCHIVE DESTINATION lib)
endfunction()

export(TARGETS my_library
        NAMESPACE my::library
        FILE my_module.cmake)

この例では、my_module.cmake という名前のカスタム CMake モジュールを作成し、my_install_target という関数を使用してターゲットをインストールします。

手動によるレジストリの編集

レジストリエディタを使用して、手動でレジストリを編集することもできます。ただし、これは推奨されない方法です。

CMAKE_EXPORT_NO_PACKAGE_REGISTRY は、レジストリへの書き込みを抑制する最も簡単な方法です。ただし、他の方法も存在し、状況に応じて使い分ける必要があります。