本主题介绍了如何使用 QtIVI 生成器。

简介

生成器是一个 Python 脚本，可以手动运行或使用 qmake 集成。此脚本使用 QFace 作为自动生成框架，解析 IDL 文件，生成领域模型（类似于抽象语法树（AST）），然后将它馈送到生成器。根据要生成的项目类型，指定不同的 格式。

命令行参数

要运行生成，使用以下命令

$$[QT_HOST_BINS]/ivigenerator/generate.py --format=backend_simulator interface.qface out_dir

选项和参数如下所示

目前，基于 --format 值，生成器可以使用给定的 IDL 文件生成多种类型的多个项目

配置生成器

生成器的Python脚本解析输入文件并创建域模型。然后，将此域模型作为上下文传递给Jinja模板引擎。使用生成YAML文件指定要生成的文件。之后，您可以使用注释YAML文件向IDL文件添加更多信息，这是针对特定生成器的。

生成YAML

在创建域模型树之后，遍历此树，并将域模型对象树的每个叶子节点（模块、接口、结构等）传递给由配置文件定义的特定Jinja模板。

生成YAML文件定义了用于生成哪些文件的模板。假设您想为您的域模型中的每个模块生成一个头文件。但是，一个模块可以具有多个接口，因此，您希望为每个接口和结构使用不同的头文件。在这种情况下，生成YAML文件定义了一组规则来指定使用哪个模板文件以及如何命名它们。

此YAML文件必须有以下结构

frontend:
    module:
        documents:
            - "{{module.module_name|lower}}plugin.h": "plugin.h.tpl"
    interface:
        documents:
            - '{{interface|lower}}backend.h': 'backend.h.tpl'

对于每个实体，都有一个当在域模型树中遍历此实体时必须调用的一组模板。在此，YAML文件定义了一个文档列表，需要生成所有模块和接口的列表。每个列表条目由两部分组成；第一部分是需要创建的文件名，如Jinja模板语言中指定的格式。模板名称中使用的对象属性的值经过处理和替换后被替换到模板中，从而形成了创建最终文件名的名称。第二部分是使用模板的名称。对于IVI生成器，您必须指定三种实体的规则：模块、接口和结构。有关更多详细信息，请参阅QFace规则基础生成文档。

注释YAML

目前，不使用IDL本身来表达接口描述的所有方面。例如，没有语言构造可以定义属性默认值或属性可以接受的值的范围。但是，这可以通过一种称为注释的机制来实现。注释提供自由和灵活性来表达任何概念和构造。

下面的代码片段显示了在IDL中使用注释的一个示例。在这里，我们定义了一个带区域的接口，并指定了它的ID。

@config: {zoned: true, id: "org.qt-project.qtivi.ClimateControl/1.2"}

将所有注释放置在主要IDL文件中是没有意义的。例如，您可能需要定义自动测试代码生成的一些方面。这样的注释可以放在与主要IDL文件配对的，同名YAML文件中。在解析阶段QFace自动提取此文件并将YAML文件中指定的注释与IDL文件中定义的注释合并。

由于附加的 YAML 文件总是自动选取，因此它不适用于某些特定项目所需的注释，例如在生成后端插件时。对于这种情况，您可以向生成器传递多个额外的注释 YAML 文件。

在 QtIvi 中，以下注释用于定义 IDL

@config: {interfaceBuilder: "FunctionName"}

@config: {zoned: true}

@config: {id: "org.qt.project.qtivi.ClimateControl/1.0"}

@config: {getter_name: "isHeaterEnabled"}

@config: {setter_name: "setHeaterEnabled"}

@config: {qml_name: "ClimateControl"}

@config: {qml_type: "ClimateControl"}

不属于接口描述逻辑部分，而是用于指定额外信息的注释，置于附加的 YAML 文件中。以下是用于定义生成后端模拟各种方面的注释列表

config_simulator:
    simulationFile: ":/qrc/simulation.qml"

config_simulator:
    zones: [ FrontLeft,
             FrontRight,
             Rear ]

config_simulator:
default:
    AirflowDirection.Floor |
    AirflowDirection.Dashboard

config_simulator:
default: {
    FrontLeft: 21.0,
    FrontRight: 22.5, =: 0.0
}

config_simulator:
minimum: 10

config_simulator:
maximum: 10

config_simulator:
range: [10, 20]

config_simulator:
domain: {10, 20, 30}

生成项目的结构

在生成器输出目录中，首先创建一个新的子文件夹，将其命名为模块 ID。所有生成的文件都放置在这个文件夹中。下表描述了为前端和后端生成的文件。

前端

基于 动态后端系统 生成 QML 友好的 C++ API。

QML 插件

生成一个 C++ QML 插件，该插件在 QML 中注册前端中的所有类型。

后端模拟器

提供使用 QIviSimulationEngine 的模拟器后端，以实现在 QML 文件中的模拟行为。

QtRemoteObjects 后端

只有当 qmake 发现 QtRemoteObjects 模块时，后端_qtro 模板才可用。产生的代码只包含继承的源类和建立连接的代码。开发者必须实现实际的后端逻辑。

QtRemoteObjects 服务器

只有当 qmake 发现 QtRemoteObjects 模块时，服务器_qtro 模板才可用。产生的代码只包含源类代码，用于继承和代码，用于建立连接。开发者必须实现实际的后端逻辑。

QtRemoteObjects 模拟服务器

仅当qmake找到QtRemoteObjects模块时，server_qtro_simulator模板才可用。生成的代码包含一个完整实现的服务器，使用与backend_simulator模板相同的实现，该模板使用QIviSimulationEngine在QML中实现模拟行为。