QMakeからCMakeへのScreenPlay転送のサクセスストーリー

ScreenPlayは、壁紙やウィジェットで動作するように設計されたWindows用のオープンソースアプリケーションです（まもなくLinuxとmacOS用にもなります）。最新のツール（C ++ / Qt / QML）を使用して作成され、2017年前半から積極的に取り組んでいます。プロジェクトコードはGitLabプラットフォームに保存されます。 本日公開する記事の著者は、ScreenPlayを開発しています。彼は多くの問題に直面しましたが、それはQMakeからCMakeへの移行によって助けられました。

QMakeと大規模プロジェクトの開発

▍QMakeでのコード共有は非常に不便です

かなり複雑なアプリケーションを開発する場合、通常、それらを小さくて管理しやすいチャンクに分割するのが最善です。たとえば、ライブラリが接続されているメインの実行可能ファイルとしてアプリケーションを提示する必要がある場合、QMakeを使用すると、これはテンプレートに基づくプロジェクトを使用してのみ実行できますsubdirs。これは、MyApp.pro使用されるテンプレートのエントリとプロジェクトフォルダのリストを含む、たとえば名前の付いたファイルで表されるプロジェクトです。

  TEMPLATE = subdirs
 
  SUBDIRS = \
            src/app \   #  
            src/lib \
            src/lib2

このアプローチでは、コードの共有を整理する必要があるいくつかのサブプロジェクトを自由に使用できます。他のプロジェクトのどこでヘッダーファイルやソースコードを含むファイルを検索する必要があるかをコンパイラに通知するには、含める必要のあるライブラリとコンパイル済みファイルを検索する場所に関する情報をリンカーに通知する必要があります。QMakeは、プロジェクトに含めるものを記述するためだけに使用される巨大な.priファイルを作成することによってこれを行います。これは、通常のC ++ビュー構造を使用するのと似ています#include <xyz.h>。その結果、たとえば、ファイルがMyProjectName.priコンポジションに含まれていることがわかりMyProjectName.proます。また、相対パスの問題を修正するには、現在の絶対パスを各行に追加します。

▍外部依存関係

さまざまなオペレーティングシステムを対象とした外部依存関係の操作は、主に、対応する依存関係へのパスをコピーして.proファイルに貼り付けることになります。各OSにはこの点で独自の特性があるため、これは退屈で退屈な作業です。たとえば、Linuxには個別のサブフォルダdebugとがありませんrelease。

▍CONFIG+ = orderedはコンパイルパフォーマンスキラーです

QMakeのもう1つの欠点は、コンパイルの問題が断続的に発生することです。したがって、プロジェクトに他のサブプロジェクトで使用されるライブラリである多くのサブプロジェクトがある場合、コンパイルは定期的に失敗します。エラーの理由は次のようになります。libAライブラリはライブラリlibBとに依存しますlibC。しかし、組み立ての時点では、libAライブラリlibCはまだ準備ができていません。通常、プロジェクトを再コンパイルすると問題は解決します。しかし、これがまったく起こっているという事実は、QMakeに深刻な問題があることを示しています。そして、これらの問題は、次のようなものを使用して解決することはできませんlibA.depends = libB..。おそらく（そしておそらくそうですが）、私は何か間違ったことをしていますが、私も同僚も問題に対処できませんでした。ライブラリのビルド順序に関する問題を解決する唯一の方法は、カスタマイズを使用するCONFIG += orderedことですが、このため、並列ビルドがないため、パフォーマンスが大幅に低下します。

QBSとCMake

▍QBSがCMakeに負けるのはなぜですか？

QBS（Qtビルドシステム、Qtビルドシステム）のサポート終了についてのメッセージは、私にとって本当にショックでした。私はこれを変える試みの創始者の一人でさえありました。 QBSは、QMLコードを書いたことのある人なら誰でも知っている素晴らしい構文を使用しています。 CMakeについては同じことは言えませんが、このプロジェクトビルドシステムを数か月使用した後、QBSからの切り替えが正しい判断であり、CMakeを引き続き使用することを確信できます。 ..。



CMakeには構文上の欠陥がいくつかありますが、確実に機能します。そして、QBSの問題は技術的というよりも政治的です。



これは、Qtのサイズ（コードの行数とライブラリのサイズの両方の点で）に不満を持っているプログラマーに代替案を探すことを強いる主な要因の1つです。さらに、多くの人がMOCを強く嫌っています。これは、Qtを使用して記述されたC ++コードを通常のC ++に変換するメタオブジェクトコンパイラです。このコンパイラのおかげで、たとえば、信号を操作できるような便利な構造を使用できます。

▍QBSの代替

QBSに加えて、build2、CMake、Meson、SConsなどのプロジェクトビルドシステムを自由に使用できます。これらは、Qtエコシステムの外部で、多くのプロジェクトで使用されています。

▍IDEでのQBSサポートが不十分

私の知る限り、QBSをサポートするIDEはQtCreatorだけです。

▍vcpkgとCMakeの見事な結合

上記の外部依存関係の問題にどのように憤慨したか覚えていますか？したがって、vcpkgパッケージマネージャーが私にどれほど前向きな感情を与えたかは驚くことではありません。依存関係をインストールするには、1つのコマンドで十分です。vcpkgはどのC ++プログラマーにも役立つと思います。

一見魅力的でないCMake構文

Googleが見つけた上位10のリンクからCMakeを判断すると、システムが非常に魅力のない構文を使用しているように見える場合があります。しかし、ここでの問題は、Googleが2008年のStackOverflowから古いCMakeのものを最初に表示したことです。CMake2.8バージョンの古いドキュメントへのリンクもあります。CMakeを使用するときに使用される構文は、かなりきれいです。実際のところ、CMakeの使用には、主に以下に示す構成の使用が含まれます（これは、ScreenPlayプロジェクトのCMakeList.txtファイルの短縮バージョンです）。

#   
cmake_minimum_required(VERSION 3.16.0)

#   .       
#       ${PROJECT_NAME}
project(ScreenPlay)

#   Qt,    MOC
set(CMAKE_AUTORCC ON)
set(CMAKE_AUTOMOC ON)

#  -   .    src,
#   .       add_executable
set(src main.cpp
        app.cpp
        #  - 
        src/util.cpp
        src/create.cpp)

set(headers app.h
        src/globalvariables.h
        #   - 
        src/util.h
        src/create.h)

#  Qt     
qt5_add_big_resources(resources  resources.qrc)

#  CMake  qml  C++   release
#   !
if(CMAKE_BUILD_TYPE STREQUAL "Debug")
    set(qml qml.qrc)
else()
    qtquick_compiler_add_resources(qml qml.qrc )
endif()

#  CMake   .  ,   ,  CMAKE_TOOLCHAIN_FILE
#         !
find_package(
  Qt5
  COMPONENTS Quick
             QuickCompiler
             Widgets
             Gui
             WebEngine
  REQUIRED)

#   vcpkg
find_package(ZLIB REQUIRED)
find_package(OpenSSL REQUIRED)
find_package(libzippp CONFIG REQUIRED)
find_package(nlohmann_json CONFIG REQUIRED)

#  CMake    : 
# add_executable    
# add_library   
add_executable(${PROJECT_NAME} ${src} ${headers} ${resources} ${qml})

#        Windows
# https://stackoverflow.com/questions/8249028/how-do-i-keep-my-qt-c-program-from-opening-a-console-in-windows
set_property(TARGET ${PROJECT_NAME} PROPERTY WIN32_EXECUTABLE true)

#     .    
#     vcpkg.      
# dll/lib/so/dynlib  vcpkg/installed
#      , 
#   project(MyLib)  target_link_libraries.
#        .
target_link_libraries(${PROJECT_NAME}
    PRIVATE
    Qt5::Quick
    Qt5::Gui
    Qt5::Widgets
    Qt5::Core
    Qt5::WebEngine
    nlohmann_json::nlohmann_json
    libzippp::libzippp
    ScreenPlaySDK
    QTBreakpadplugin)

#  CMake      build   ,   .
# ${CMAKE_BINARY_DIR} -   build!
file(MAKE_DIRECTORY ${CMAKE_BINARY_DIR}/bin/assets/fonts)
configure_file(assets/fonts/NotoSansCJKkr-Regular.otf ${CMAKE_BINARY_DIR}/bin/assets/fonts COPYONLY)

忍者はCMakeをスピードアップ

CMakeの役割は、開発者が選択したプロジェクトビルドシステムの命令を生成することだけです。これは、QtCreatorではなくVisualStudioを使用する人々と協力する場合に大きなプラスになる可能性があります。CMakeを使用する場合、デフォルトのビルドシステムとしてNinjaを選択できます（選択する必要があります）。CMake + Ninjaバンドルを使用してプロジェクトをコンパイルするのはとても便利です。どちらもQtMaintenanceツールボックスにあります。特に、これらのツールは、反復的な開発アプローチで変更を非常に迅速に処理できます。実際、すべてが非常に高速に動作するため、SConsでGodotを使用する場合は、ここでもCMakeを使用したいと思います。

VcpkgはCMakeを輝かせます

C ++プロジェクトの依存関係の管理は簡単な作業ではありません。これを解決するために、多くのプロジェクトでは、必要なDLLをGitリポジトリに配置しています。これはリポジトリのサイズを不必要に大きくするため、これは悪いことです（ここでは、Git LFSについては触れません）。 vcpkgの唯一の欠点は、このパッケージマネージャーがパッケージのグローバルバージョンを1つしかサポートしないことです（つまり、異なるバージョンのvcpkgを自分でインストールする必要がありますが、これはちょっとしたハックであり、これが必要になることはめったにありません）。確かに、プロジェクトの開発計画では、それが正しい方向に進んでいることがわかります。



次のコマンドを使用してパッケージをインストールします。

vcpkg install crashpad

脚本に取り組んでいる間、私たちは、単に作成install_dependencies_windows.batとinstall_dependencies_linux_mac.shスクリプト、vcpkgリポジトリのクローンを作成するには、それを構築するために、すべての私達の依存関係をインストールします。Qt Creatorを使用する場合は、CMAKE_TOOLCHAIN_FILEvcpkgへの相対パスに書き込む必要があります。さらに、vcpkgには、使用しているOSとアーキテクチャを通知する必要があります。

    #  QtCreator. Extras -> Tools -> Kits ->  -> CMake Configuration.    :
    CMAKE_TOOLCHAIN_FILE:STRING=%{CurrentProject:Path}/Common/vcpkg/scripts/buildsystems/vcpkg.CMake
    VCPKG_TARGET_TRIPLET:STRING=x64-windows

他のライブラリをインストールする必要がありますか？これを行うには、フォームのコマンドを使用するだけvcpkg install myLibToInstallです。

結果

最新で最も人気のあるものを使用するアプローチには、その利点があります。しかし、たとえば、QBSのような大きな可能性を秘めたシステムを構築するときに、突然傍観者になった場合はどうすればよいでしょうか。最終的には、開発者自身がプロジェクトで何を使用するかを決定します。そのため、プロジェクトをCMakeに移すことにしました。そして、私は言わなければなりません、それは正しい決断でした。今日、2020年にCMakeはかなり良く見えます。



CMakeとvcpkgを使用していますか？