qtcreator相关-qtconfig嵌入自定义开发模块以及项目向导的编写

prf文件

• qmake可以通过专门的prf文件设置另外的配置特性.这些特性通常提供给编译时候的自定义的工具使用。为了在处理过程添加一个特性,往CONFIG变量里面添加一个特性名字,该名字跟特性的文件名相同(mkspecs/features目录里面)

• 例如 qmake可以在编译过程利用pkg-config 提供支持的额外的库,例如D-Bus库 和 ogg库,用下面的方法

   `CONFIG += link_pkgconfig`
    `PKGCONFIG += ogg dbus-1`
  

qt wizard 创建项目向导

向导文件配置位置 /share/qtcreator/templates/wizards

• 详见Adding New Custom Wizards | Qt Creator Manual

1. 项目模板引导页面依赖于wizard.json中的定义。
2. 使用启动参数-customwizard-verbose启动Qt Creator，可以打印加载情况。

options键（定义变量）

• EX:

  "options":
  [
      { "key": "TargetPath", "value": "%{Path}" },
      { "key": "HdrPath", "value": "%{Path}/%{HdrFileName}" },
      { "key": "SrcPath", "value": "%{Path}/%{SrcFileName}" },
      { "key": "CN", "value": "%{JS: Cpp.className(value('Class'))}" },
      { "key": "Base", "value": "%{JS: value('BaseCB') === '' ? value('BaseEdit') : value('BaseCB')}" },
      { "key": "isQObject", "value": "%{JS: (value('Base') === 'QObject' || value('Base') === 'QWidget' || value('Base') === 'QMainWindow' || value('Base') === 'QDeclarativeItem' || value('Base') === 'QQuickItem' ) ? 'true' : 'false'}" },
      { "key": "GUARD", "value": "%{JS: Cpp.classToHeaderGuard(value('Class'), Util.suffix(value('HdrFileName'))}" },
      { "key": "SharedDataInit", "value": "%{JS: value('IncludeQSharedData') ? 'data(new %{CN}Data)' : '' }" },
    ...
  ],
  

您可以在JSON配置文件和模板源文件中的字符串中使用变量％{<variableName>}。向导及其页面预定义了一组变量。您可以通过在wizard.json文件的选项部分中定义变量键名和值，将新变量作为快捷方式引入，以便以后使用。

有一个特殊的变量％ {JS：<JavaScript expression> }，该变量评估给定的JavaScript表达式并将生成的JavaScript值转换为字符串。在JavaScript表达式中，您可以使用value('<variableName>')引用向导定义的变量。返回的JavaScript对象具有变量值具有的类型，可以是字符串，列表，字典或布尔值。

在期望布尔值并给出字符串的地方，空字符串以及**字符串“ false”**都将被视为false，其他任何情况都将被视为true。

翻译

如果设置名称以tr前缀开头，则该值对用户可见，应该进行翻译。如果新向导包含在Qt Creator的源代码中，则可翻译的字符串会出现在Qt Creator的翻译文件中，并且可以作为Qt Creator的一部分进行翻译。或者，您可以使用以下语法将翻译内容放入.json文件中：

• EX:

  "trDisplayName": { "C": "Project Location", "en_US": "Project Location", "de_DE": "Projekt Verzeichnis" }

page键（页面定义）

• EX:

  "pages":
  [
      {
          "trDisplayName": "Define Class",
          "trShortTitle": "Details",
          "typeId": "Fields",
          "data" :
          [
              {
                  "name": "Class",
                  "trDisplayName": "Class name:",
                  "mandatory": true,
                  "type": "LineEdit",
                  "data": { "validator": "(?:(?:[a-zA-Z_][a-zA-Z_0-9]*::)+[a-zA-Z_][a-zA-Z_0-9]*|)" }
              },
              ...
  ]
  

• typeId 定义页的要使用的页面类型：Fields, File, Form, Kits, Project, VcsConfiguration, VcsCommand or Summary代码中使用的完整页面ID由前缀为“ PE.Wizard.Page”的typeId组成。有关页面的更多信息，请参阅可用页面Available Pages。

• trDisplayName 指定页面标题。

• trSubTitle 指定子标题。

• trShortTitle 指定向导边栏中使用的标题。

• index 是一个整数值，用于指定页面ID。

• enabled 设置为true可以显示页面，设置为false可以隐藏页面。

• data 指定向导页面。在C ++向导中，它指定“字段”页面和“摘要”页面。 “字段”页面包含CheckBox，ComboBox，LineEdit，PathChooser和Spacer小部件。有关这些小部件的更多信息，请参见可用的小部件 Available Widgets。

  ​

  ​

generators键（生成）

• EX:

  "generators":
  [
      {
          "typeId": "File",
          "data":
          [
              {
                  "source": "file.h",
                  "target": "%{HdrPath}",
                  "openInEditor": true
              },
              {
                  "source": "file.cpp",
                  "target": "%{SrcPath}",
                  "openInEditor": true
              }
           [
    	 }
  ]
  

• typeId指定生成器的类型。当前，仅支持File 或Scanner详见Available Generators 。

• data 允许进一步配置生成器。

JSON向导可用的变量

• WizardDir Wizard.json文件的绝对路径。

• Features 列出了通过Qt Creator中配置的任何工具包可用的所有功能。

• Plugins 包含在Qt Creator的当前实例中运行的所有插件的列表。

• Platform 包含在“文件”>“新建文件”或“项目”对话框中选择的平台。该值可能为空

• InitialPath 与所选节点的路径。

• ProjectExplorer.Profile.Ids包含为所选节点的项目配置的工具包的列表。

  ​

用例 Qt Widgets Application

• 从Wizard.json文档中可以轻松看出对应关系

  1. 模板的从属关系
     

  2. 项目创建位置

  3. 构建系统

  4. 细节
     

  5. ​翻译
     

  6. 工具

  7. 总结

• 生成文件
  

  • 以Project.pro为例​