はじめに

qmlprojectexporterは、プロジェクトに含まれるすべてのリソースと.qmlファイルのC++コードを自動生成するツールです。リソースには、Qmlファイル、画像、フォントファイル、翻訳ファイル、C++インターフェースがあります。qmlprojectexporter 。このファイルはプロジェクトの構造を定義し、他の.qmlprojectモジュールファイルに依存するかもしれません。

qmlprojectファイル

.qmlprojectファイルの構文はQmlドキュメントと同じです。.qmlprojectファイルの目的は、プロジェクトの構造を記述することです。QMLドキュメントと同様に、.qmlprojectファイルはインポートセクションに続いて、ルートノード（この場合はProject）から始まるノードまたはオブジェクトの階層で構成され、各ノードは事前に定義されたプロパティのセットを持ちます。インポートセクションは主に "import QmlProject 1.3 "で構成され、.qmlprojectファイルであることを示し、使用するAPIのバージョンを指定します。

移行ガイド

非推奨の CMake API に依存している既存のプロジェクトを.qmlproject に移行することができます。詳しくはQmlProjectへの移行ガイドを参照してください。

プラットフォームソースを含むプロジェクトのエクスポート

qmlprojectexporter コマンドラインユーティリティを使って、QmlProject をプラットフォームソースと一緒にエクスポートすることができます。これにより、Qt for MCUs をサードパーティの IDE やカスタムビルドシステムに統合するプロセスが簡単になります。この機能の使用方法の詳細については、 Qt for MCUs プロジェクトをプラットフォーム・ソースとともにエクスポートするを参照してください。

ノード

各ノードは、プロジェクトの特定の部分（Qmlファイル、イメージ、モジュールなど）を設定します。ImageFilesのように、プロジェクトのルートノードで何度も定義できるノードもあります。また、MCU.Module.ImageFilesなど、一度しか定義できないノードもあります。

プロパティ

.qmlprojectファイルのPropertiesは設定パラメータと考えることができます。各ノードには定義済みの設定可能なセットがあります。

MCU.Configノードにコンフィギュレーションを配置すると、プロジェクトファイル内でコンフィギュレーションをサポートするすべてのノードにコンフィギュレーションを割り当てることができ、それぞれのプロパティがデフォルトのノード（ImageFilesなど）で見つからない場合、MCU.Config で定義された値が有効になります。これらのコンフィギュレーション・プロパティには、"MCU. "というプレフィックスが付いています。詳細については、MCU.Configを参照してください。

ノード

プロジェクト

各qmlproject ファイルには、ルート・ノードとしてProject ノードがあります。このルート・ノードには、プロジェクトの詳細情報を提供する他のすべてのノードが含まれます。

qmlproject ファイル構造は、Project とその子ノードという2つのレベルに制限されています。qmprojectexporter は、第3レベルに配置されたノードを無視します。

使用方法

Project {
    projectRootPath: "..."
    ...
    MCU.Config {...}
    ...
    ImageFiles {...}
    ...
}

以下はProjectノードで使用可能なプロパティのリストです：

QmlFiles

このノードを使うと、プロジェクトの QML ファイルを一覧表示できます。QML ファイルには、相対パスと絶対パスの両方を使用できます。

使用方法

QmlFiles {
    files: ["src/other.qml"]
}

QmlFilesノードで利用可能なプロパティの一覧は以下の通りです：

画像ファイル

ImageFiles ノードは、指定された画像アセットをプロジェクトに追加します。

さらに、与えられたノードで指定されたプロパティは、qulrcc-toolがこれらのアセットをどのようにエンコードするかに影響します。

同じプロジェクトに複数のImageFilesを持つことができ、画像のグループごとに異なるプロパティを設定するときに必要になります。

ImageFilesノードで指定されたプロパティを定義しない場合、qmlprojectexporter 、MCU.Configノードで提供されたデフォルト値が使用されます。そこで定義されていない場合は、グローバルなデフォルト値に依存します。

使用方法

Project {
    ...
    ImageFiles {
        files: [...]
        MCU.resourceOptimizeForRotation: true
    }
    ...
}

以下は、ImageFiles ノードで使用可能なプロパティの一覧です：

フォントファイル

このノードを使用すると、プロジェクトで必要なフォントファイルを一覧表示できます。サポートされているフォントファイル形式については、フォント形式を参照してください。

使用方法

Project {
    ...
    FontFiles {
        files: [...]
    }
    ...
}

以下は、FontFiles ノードで使用できるプロパティの一覧です：

TranslationFiles

このノードを使用して、プロジェクトに翻訳ファイルを追加できます (.ts)。

qmlprojectexporterは対応するツールを呼び出して、これらの翻訳ファイルを.qm に変換します。 は Qt が翻訳を管理するために使用するバイナリフォーマットです。

QMLソースでは、翻訳可能な文字列をマークするために、qsTr() またはqsTrId() を使用することができます。実行時に、翻訳システムは現在のシステムロケールの翻訳ファイルから一致する文字列を探します。

使用方法

Project {
    ...
    TranslationFiles {
        files: [...]
    }
    ...
}

TranslationFilesノードでサポートされているプロパティは次のとおりです：

インターフェースファイル

このノードは C++ インタフェース固有の設定を提供します。C++ インタフェースを定義し、QML ファイルにインポートすることなく、Qml から見えるようにすることができます。qmlprojectexporterはこれらのC++インターフェースのヘッダーファイルに基づいてQMLコードを生成するので、同じプロジェクト内の別のQMLファイルから参照することができます。

使用方法

Project {
    ...
    InterfaceFiles {
        files: [...]
    }
    ...
}

InterfaceFiles ノードで利用可能なプロパティの一覧を以下に示します：

バイナリファイル

BinaryFiles ノードは、指定されたバイナリ資産をプロジェクトに追加します。

さらに、指定されたノードで指定されたプロパティは、qulrcc-toolがこれらのアセットを処理する方法に影響します。

同じプロジェクトに複数のBinaryFilesを持つことができ、バイナリ資産のグループごとに異なるプロパティを設定するときに必要になります。

BinaryFilesノードで所定のプロパティを定義しない場合、qmlprojectexporter 、MCU.Configノードで提供されるデフォルト値が使用されます。そこで定義されていない場合は、グローバルなデフォルト値に依存します。

使用方法

Project {
    ...
    BinaryFiles {
        files: [...]
    }
    ...
}

以下は、BinaryFiles ノードで使用可能なプロパティのリストです：

MCU.コンフィグ

このノードを使用して、QmlProject ファイルのデフォルト値を定義できます。このノードのコンテキスト内で定義されたプロパティには、"MCU." 接頭辞は必要ありません。同じプロパティが ImageFiles や FontFiles などの特定のノードの一部である場合は、この接頭辞を使用する必要があります。

使用方法

//node1
MCU.Config {
  // Project-wide default value for resourceOptimizeForRotation.
  resourceOptimizeForRotation: true
}

ImageFiles {
  // Here resourceOptimizeForRotation was explicitly defined for a specific ImageFiles node.
  MCU.resourceOptimizeForRotation: false // requires the "MCU."prefix
}

//node2
ImageFiles {
  // MCU.resourceOptimizeForRotation was not defined but the value \c true will be
  // picked from MCU.Config.
}

以下は、MCU.Configで使用可能なプロパティのリストです：

リソースストレージセクション

このノードを使用して、リソース格納セクションのプロパティを指定できます。アプリケーションで使用する各リソース格納セクションに対して、複数のノードを指定することができます。

ノードはMCU.Configノードの子でなければなりません。

使用方法

MCU.Config {
        ResourceStorageSection
        {
            name: "ResourceDataInInternalFlash"
            majorVersion: 2
            minorVersion: 1
        }

        ResourceStorageSection
        {
            name: "ResourceDataInExternalFlash"
            majorVersion: 1
            minorVersion: 0
        }
}

以下は、ResourceStorageSectionで使用可能なプロパティのリストです：

MCU.モジュール

このノードの役割は、qmlprojectファイルをモジュールとして宣言することです。モジュールには、アセット、インターフェース、QML コンポーネント、および翻訳を含めることができます。qmlprojectベースのプロジェクトは、QmlProjectのModuleFilesノードを使うことで、qmlprojectベースのモジュールを利用することができます。

使用方法

// mymodule.qmlproject
import QmlProject 1.3
Project {
  MCU.Module {
    uri: "custom.module"
  }
  QmlFiles {
    files: ["CustomBox.qml"]
  }
}

// CustomBox.qml
// ... some qml code

// main.qmlproject
import QmlProject 1.3
Project {
  QmlFiles {
    files: ["main.qml"]
  }
  ModuleFiles {
    files: ["mymodule.qmlproject"]
  }

// main.qml
import QtQuick 2.15
import custom.module
Rectangle {
  CustomBox {}
}

Qulモジュール

Qt Quick Ultraliteには、ModuleFiles.MCU.qulModulesでプロジェクトが使用できる以下の定義済みモジュールが付属しています：

• コントロール
• コントロールテンプレート
• レイアウト
• ロケーション
• プロファイリング
• ポジショニング
• セーフレンダラー
• シェイプ
• スタジオコンポーネント
• タイムライン
• バーチャルキーボード

以下は、MCU.Moduleノードで使用可能なプロパティのリストです：

モジュール・ファイル

このノードを使用して、QML モジュールをプロジェクトにインポートすることができます。

使用方法

Project {
    ...
    ModuleFiles {
        MCU.qulModules: [...]
        ...
    }
    ...
}

ModuleFiles ノードで使用できるプロパティの一覧は次のとおりです：

コマンドラインリファレンス

qmlprojectexporter

qmlprojectexporterはQMLソース、画像アセット、フォントをコンパイル可能なc++コードにエクスポートするために使用します。.qmlproject QMLソースとイメージアセット、フォントをコンパイル可能なc++コードにエクスポートするには、qmlprojectexporterを使ってください。さらに、qmlprojectexporterは、CMakeのようなサードパーティのビルドシステムで自動的に使用するのに便利な、インポートおよびエクスポートされたファイルのプレーンテキストリストもエクスポートします。

CMake プロジェクトでのqmlprojectexporter の使用法

qmlprojectexporter を CMake のビルドシステムで使うのは簡単で、qul_add_target というCMake のカスタムマクロが、qmlprojectexporter を適切なパラメータで呼び出してくれます。

// Adding the \l GENERATE_ENTRYPOINT option will generate an application entrypoint automatically,
// but it requires setting the \l Project.mainFile property
qul_add_target(my_project QML_PROJECT my_project.qmlproject GENERATE_ENTRYPOINT)

// Note for a working Qul application with CMake it is still required to call \l app_target_setup_os macro
// after adding the qmlproject target.
app_target_setup_os(myproject)

qmlprojectexporter を使う場合、qmlprojectexporter を呼び出すと同じ機能を実行することになるので、以下の CMake マクロは必要ありません。

• qul_target_qml_sources
• qul_target_generate_interfaces
• qul_target_embed_translations
• qul_add_qml_module

QmlProject に置き換わる全ての CMake フラグは、CMake マニュアルで非推奨とされています。

スタンドアロンqmlprojectexporter

CMake 以外のビルドシステムを使う場合でも、qmlprojectexporter を直接使うことができます。生成されたアセットファイルを任意のビルドシステムで使用することができます。

qmlprojectexporter --outdir output_directory myproject.qmlproject

以下はqmlprojectexporter のコマンドライン引数の拡張リストです：

qmlprojectexporterの生成ファイル

出力ディレクトリに生成されるファイルは、使用するコマンドライン引数によって異なります。プロジェクトのビルドプロセスでqmlprojectexporter がどのような役割を果たすかをよりよく理解するには、Qt Quick Ultralite tools を参照してください。 次の例によって生成される可能性のあるファイルのリストは次のとおりです：

次のスタートアッププロジェクトファイルを考えてみましょう：

エクスポートなし

qmlprojectexporter --no-export-cpp --no-export-modules --no-export-configuration --outdir output my_project.qmlproject

このコマンドを実行すると、output ディレクトリが作成されますが、すべてのエクスポートが無効になるため、その中にファイルは作成されません。

エクスポート設定

qmlprojectexporter --no-export-cpp --no-export-modules --outdir output my_project.qmlproject

no-export-configuration引数を削除すると、以下のファイルが作成されます：

先ほどのコマンドを使うと、ファイルを生成するオーバーヘッドなしに、プロジェクトが期待するリソースや設定に関する情報を取得することができます。

CPPファイルのエクスポート

qmlprojectexporter --no-export-modules --outdir output my_project.qmlproject

--no-export-configuration を削除するとコンフィギュレーションが一覧表示されますが、--no-export-cpp を削除すると、プロジェクトの実際のCPP ファイルがすべて生成されます。 Qt Quick Ultralite toolsでは、どのツールがどのファイルを担当するかを紹介しています。

モジュールのエクスポート

qmlprojectexporter --outdir output my_project.qmlproject

先ほどの例でqmlprojectexporter を--no-export-modulesなしで実行しても、この例ではモジュールファイルを使用していないため、出力フォルダに大きな影響はありません。しかし、プロジェクトがモジュールとともに完全にエクスポートされると、サードパーティツールが使用する出力ディレクトリに2つのファイルが表示されます。これらのファイルは

--no-export-modules の主な効果を見るために、新しいプロジェクト・ファイルを考えてみましょう：

新しいファイルを使って先のqmlprojectexporter コマンドを実行すると、次のようになります：

qmlprojectexporter no-export-modulesを省略し、--no-export-cppを使用すると、設定txtファイルが生成されます。

デフォルトのアプリケーション・エントリポイントを持つモジュールのエクスポート

次のステップで生成されるファイルは、既存のエントリーポイントがある場合には必要ありません。以下のコマンドを考慮してください：

//[1]
qmlprojectexporter --generate-entrypoint --target-type executable --outdir output my_project.qmlproject
//[2]
qmlprojectexporter --generate-entrypoint --target-type static_library --outdir output my_project.qmlproject

qmlprojectexporter --target-type フラグによって、生成されたファイルのリストに新しいファイルを追加します。

実行可能ファイルを使う場合

static_library を使用する場合：

qulpreview (テクニカルプレビュー)

qulpreview は、QMLプロジェクトをターゲットプラットフォームに素早く簡単にデプロイするために使用できます。最も基本的なシナリオでは、次のように使用します：

qulpreview <QMLPROJECT>

<QMLPROJECT> はプロジェクトの.qmlproject ファイルへのパスです。--profile <PROFILE_ID> と--workflow <WORKFLOW_ID> のコマンドライン引数を使用すると、動作をさらにカスタマイズできます。<PROFILE_ID> と<WORKFLOW_ID> はそれぞれ、ターゲットプロファイルの ID と、デプロイ手順を記述するワークフローの ID です。

win-mingw linux-gcc 現在の技術プレビューでは、Qt for MCUs の 2 つのプロファイルのみがバンドルされており、どちらもデスクトップ Qt を対象としています。

利用可能なプロファイルのリストは、qulpreview --list-profiles を実行することで得られます。

プロファイルは変数を利用して、パターンの繰り返しを最小限に抑えることができる。構文は${VAR_NAME} 。

環境変数も利用可能で、${env:PATH} のようにenv: という接頭辞を使って参照できます。

プロファイル作成者の便宜のために、このツールはいくつかの定義済みの、主にプロジェクト関連の変数を提供しています：

• OUT_DIR -qulpreview はそれ自体では成果物を生成しませんが、ツールの出力をカスタマイズするためのレシピでこの変数を使用できます。--out-dir コマンドラインパラメーターで指定できる。
• PROJECT_FILE_PATH -.qmlproject ファイルへのフルパス（プロジェクトファイル自体を含む）
• PROJECT_FILE_NAME - プロジェクトファイル名（拡張子あり）
• PROJECT_BASE_NAME - プロジェクトファイル名（拡張子なし）
• PROJECT_DIR - プロジェクト・ファイルの親ディレクトリ

レシピのステップは順次実行され、あるステップが失敗した場合（開始できない、クラッシュした、0 以外のコードで終了したなど）、それに続くステップは実行されない。

qulpreview でエラーが発生した場合、EXIT_FAILURE のエラーコードで終了し、stderr にエラーが出力される。

以下は、qulpreview コマンドライン引数の拡張リストである：