From 74c3a036d2f33a3cf1fef26f42bd7dcba90da8be Mon Sep 17 00:00:00 2001 From: Christophe Date: Wed, 19 Oct 2022 16:49:17 +0200 Subject: [PATCH 001/154] vkconfig: fix application controlled mode Change-Id: I66b15282db99045a7c5105e2d9f7a977bf0bdb41 --- vkconfig/mainwindow.cpp | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/vkconfig/mainwindow.cpp b/vkconfig/mainwindow.cpp index 677de704d8..144cc39899 100644 --- a/vkconfig/mainwindow.cpp +++ b/vkconfig/mainwindow.cpp @@ -132,7 +132,9 @@ MainWindow::MainWindow(QWidget *parent) ui->log_browser->document()->setMaximumBlockCount(2048); ui->configuration_tree->scrollToItem(ui->configuration_tree->topLevelItem(0), QAbstractItemView::PositionAtTop); - _settings_tree_manager.CreateGUI(ui->settings_tree); + if (configurator.configurations.HasSelectConfiguration()) { + _settings_tree_manager.CreateGUI(ui->settings_tree); + } UpdateUI(); } From 3d729dd55268e94dcb916b7d9a938bdfae712fa0 Mon Sep 17 00:00:00 2001 From: Andrew Cox Date: Wed, 2 Nov 2022 19:19:04 +0000 Subject: [PATCH 002/154] Removed DevSim references. --- README.md | 2 +- layersvt/README.md | 3 --- 2 files changed, 1 insertion(+), 4 deletions(-) diff --git a/README.md b/README.md index d95e9285bc..eab26b5857 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ The repository contains the following Vulkan Tools: - [Vulkan Configurator](vkconfig/README.md) -- [`VK_LAYER_LUNARG_api_dump`, `VK_LAYER_LUNARG_device_simulation`, `VK_LAYER_LUNARG_screenshot` and `VK_LAYER_LUNARG_monitor` layers](layersvt/README.md) +- [`VK_LAYER_LUNARG_api_dump`, `VK_LAYER_LUNARG_screenshot` and `VK_LAYER_LUNARG_monitor` layers](layersvt/README.md) - [Vulkan Installation Analyzer](via/README.md) These tools have binaries included within the [Vulkan SDK](https://www.lunarg.com/vulkan-sdk/). diff --git a/layersvt/README.md b/layersvt/README.md index 81c32e0fea..c171692d68 100644 --- a/layersvt/README.md +++ b/layersvt/README.md @@ -33,9 +33,6 @@ To specify frames to be captured, the environment variable 'VK_SCREENSHOT_FRAMES ### View Frames Per Second layersvt/monitor.cpp - utility layer that will display an applications FPS in the title bar of a windowed application. -### Device Simulation -layersvt/device_simulation.cpp (name='VK_LAYER_LUNARG_device_simulation') - A utility layer to simulate a device with different capabilities than the actual hardware in the system. See device_simulation.md for details. - ## Using Layers 1. Build VK loader using normal steps (cmake and make) From 101d136041420c019bb729534dff04e3e3f28a45 Mon Sep 17 00:00:00 2001 From: Tony-LunarG Date: Thu, 10 Nov 2022 11:51:27 -0700 Subject: [PATCH 003/154] build: Update to 1.3.234 headers --- build-android/vulkan-headers_revision_android | 2 +- build-android/vulkan-tools_revision_android | 2 +- build-android/vulkan-validationlayers_revision_android | 2 +- scripts/known_good.json | 8 ++++---- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/build-android/vulkan-headers_revision_android b/build-android/vulkan-headers_revision_android index 624644b996..570452e57e 100644 --- a/build-android/vulkan-headers_revision_android +++ b/build-android/vulkan-headers_revision_android @@ -1 +1 @@ -v1.3.231 +v1.3.234 diff --git a/build-android/vulkan-tools_revision_android b/build-android/vulkan-tools_revision_android index 624644b996..570452e57e 100644 --- a/build-android/vulkan-tools_revision_android +++ b/build-android/vulkan-tools_revision_android @@ -1 +1 @@ -v1.3.231 +v1.3.234 diff --git a/build-android/vulkan-validationlayers_revision_android b/build-android/vulkan-validationlayers_revision_android index b0cf2c6787..570452e57e 100644 --- a/build-android/vulkan-validationlayers_revision_android +++ b/build-android/vulkan-validationlayers_revision_android @@ -1 +1 @@ -9935d4030899b30b7a72c8f4dfa2e7fe366461f0 +v1.3.234 diff --git a/scripts/known_good.json b/scripts/known_good.json index 4dd0c42982..edc428f178 100644 --- a/scripts/known_good.json +++ b/scripts/known_good.json @@ -6,7 +6,7 @@ "sub_dir" : "Vulkan-Headers", "build_dir" : "Vulkan-Headers/build", "install_dir" : "Vulkan-Headers/build/install", - "commit" : "v1.3.231" + "commit" : "v1.3.234" }, { "name" : "Vulkan-Loader", @@ -14,7 +14,7 @@ "sub_dir" : "Vulkan-Loader", "build_dir" : "Vulkan-Loader/build", "install_dir" : "Vulkan-Loader/build/install", - "commit" : "v1.3.231", + "commit" : "v1.3.234", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", @@ -35,7 +35,7 @@ "sub_dir" : "Vulkan-Tools", "build_dir" : "Vulkan-Tools/build", "install_dir" : "Vulkan-Tools/build/install", - "commit" : "v1.3.231", + "commit" : "v1.3.234", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", @@ -60,7 +60,7 @@ "sub_dir" : "Vulkan-ValidationLayers", "build_dir" : "Vulkan-ValidationLayers/build", "install_dir" : "Vulkan-ValidationLayers/build/install", - "commit" : "9935d4030899b30b7a72c8f4dfa2e7fe366461f0", + "commit" : "v1.3.234", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", From 60bc643091afbae58b3fa8e5a6abf8823cea15e9 Mon Sep 17 00:00:00 2001 From: Bob Ellison Date: Tue, 15 Nov 2022 16:00:31 -0700 Subject: [PATCH 004/154] scripts: use python3 if python is not available Some modern Linux distributions come with the "python3" executable but not the "python" executable. This change allows whichever is present on the invoking machine to be used. --- update_external_sources.sh | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/update_external_sources.sh b/update_external_sources.sh index 87c6865559..a4cb83d3d0 100755 --- a/update_external_sources.sh +++ b/update_external_sources.sh @@ -1,12 +1,14 @@ #!/bin/bash +PYTHON=$(which python python3 | head -1) + set -e if [[ $(uname) == "Linux" || $(uname) == "FreeBSD" || $(uname) =~ "CYGWIN" || $(uname) =~ "MINGW" ]]; then CURRENT_DIR="$(dirname "$(readlink -f ${BASH_SOURCE[0]})")" CORE_COUNT=$(nproc || echo 4) elif [[ $(uname) == "Darwin" ]]; then - CURRENT_DIR="$(dirname "$(python -c 'import os,sys;print(os.path.realpath(sys.argv[1]))' ${BASH_SOURCE[0]})")" + CURRENT_DIR="$(dirname "$($PYTHON -c 'import os,sys;print(os.path.realpath(sys.argv[1]))' ${BASH_SOURCE[0]})")" CORE_COUNT=$(sysctl -n hw.ncpu || echo 4) fi echo CURRENT_DIR=$CURRENT_DIR @@ -19,5 +21,5 @@ git submodule update --init --recursive echo "Building ${BASEDIR}/jsoncpp" cd ${BASEDIR}/jsoncpp -python amalgamate.py +$PYTHON amalgamate.py From 813f09f095d617bb0ce8725b2da8a49364c3d718 Mon Sep 17 00:00:00 2001 From: Bob Ellison Date: Tue, 15 Nov 2022 17:57:41 -0700 Subject: [PATCH 005/154] vkconfig: include vkconfig_core/ uses std::numeric_limits, but doesn't explicitly include , which defines this. This seemed to work fine on older Linux distributions (e.g. Ubuntu 16.04), probably because the header file was implicitly included somewhere; but it fails on newer distributions (e.g. Ubuntu 22.04). Always explicitly including is painless and lets the project build on all Linux versions. --- vkconfig_core/setting.h | 1 + 1 file changed, 1 insertion(+) diff --git a/vkconfig_core/setting.h b/vkconfig_core/setting.h index 598f902788..dfe9933f31 100644 --- a/vkconfig_core/setting.h +++ b/vkconfig_core/setting.h @@ -25,6 +25,7 @@ #include #include #include +#include #include From 24c2fa3f1361f8053a73772f13e46e76c6c3fd13 Mon Sep 17 00:00:00 2001 From: Christophe Date: Mon, 21 Nov 2022 11:57:54 +0100 Subject: [PATCH 006/154] vkconfig: add warn_on_robust_oob val setting Change-Id: I9f4ff61c161867879d8c2676bd36634f4f0461eb --- vkconfig/CHANGELOG.md | 7 +++++- vkconfig/settings_validation_areas.cpp | 30 ++++++++++++++++++++++++++ vkconfig/settings_validation_areas.h | 4 ++++ vkconfig_core/version.cpp | 2 +- 4 files changed, 41 insertions(+), 2 deletions(-) diff --git a/vkconfig/CHANGELOG.md b/vkconfig/CHANGELOG.md index b75d874e26..befa30bd97 100644 --- a/vkconfig/CHANGELOG.md +++ b/vkconfig/CHANGELOG.md @@ -11,7 +11,12 @@ # Release notes -## [Vulkan Configurator 2.5.1](https://github.com/LunarG/VulkanTools/tree/master) - October 2022 +## [Vulkan Configurator 2.5.2](https://github.com/LunarG/VulkanTools/tree/master) - December 2022 + +### Improvements: +- Add `warn_on_robust_oob` validation layer setting handling + +## [Vulkan Configurator 2.5.1](https://github.com/LunarG/VulkanTools/tree/sdk-1.3.231.0) - October 2022 ### Features: - Add ENUM setting type children settings #1746 diff --git a/vkconfig/settings_validation_areas.cpp b/vkconfig/settings_validation_areas.cpp index aac9aed095..2dea9a2cb7 100644 --- a/vkconfig/settings_validation_areas.cpp +++ b/vkconfig/settings_validation_areas.cpp @@ -116,6 +116,8 @@ WidgetSettingValidation::WidgetSettingValidation(QTreeWidget *tree, QTreeWidgetI widget_shader_gpu_reserve(nullptr), item_shader_gpu_oob(nullptr), widget_shader_gpu_oob(nullptr), + item_shader_gpu_robust_oob(nullptr), + widget_shader_gpu_robust_oob(nullptr), item_shader_gpu_desc_indexing(nullptr), widget_shader_gpu_desc_indexing(nullptr), item_shader_gpu_indirect(nullptr), @@ -290,6 +292,23 @@ WidgetSettingValidation::WidgetSettingValidation(QTreeWidget *tree, QTreeWidgetI } } + { + const SettingMetaBool *value = FindSetting(meta_set, "warn_on_robust_oob"); + if (IsSupported(value)) { + this->item_shader_gpu_robust_oob = new QTreeWidgetItem(); + this->item_shader_gpu_robust_oob->setSizeHint(0, QSize(0, ITEM_HEIGHT)); + this->item_shader_gpu->addChild(this->item_shader_gpu_robust_oob); + this->item_shader_gpu->setExpanded(true); + + this->widget_shader_gpu_robust_oob = new QCheckBox(this); + this->widget_shader_gpu_robust_oob->setText(value->label.c_str()); + this->widget_shader_gpu_robust_oob->setToolTip(value->description.c_str()); + this->tree->setItemWidget(this->item_shader_gpu_robust_oob, 0, this->widget_shader_gpu_robust_oob); + this->connect(this->widget_shader_gpu_robust_oob, SIGNAL(clicked(bool)), this, + SLOT(OnShaderGPURobustOOBChecked(bool))); + } + } + { const SettingMetaBool *value = FindSetting(meta_set, "validate_draw_indirect"); if (IsSupported(value)) { @@ -593,6 +612,11 @@ void WidgetSettingValidation::OnShaderGPUOOBChecked(bool checked) { this->OnSettingChanged(); } +void WidgetSettingValidation::OnShaderGPURobustOOBChecked(bool checked) { + static_cast(FindSetting(this->data_set, "warn_on_robust_oob"))->value = checked; + this->OnSettingChanged(); +} + void WidgetSettingValidation::OnShaderGPUIndirectChecked(bool checked) { static_cast(FindSetting(this->data_set, "validate_draw_indirect"))->value = checked; this->OnSettingChanged(); @@ -839,6 +863,12 @@ void WidgetSettingValidation::Refresh(RefreshAreas refresh_areas) { this->widget_shader_gpu_oob->setChecked(this->HasDataBool("gpuav_buffer_oob")); } + if (this->widget_shader_gpu_robust_oob != nullptr) { + this->widget_shader_gpu_robust_oob->setEnabled(shader_gpu); + if (refresh_areas == REFRESH_ENABLE_AND_STATE) + this->widget_shader_gpu_robust_oob->setChecked(this->HasDataBool("warn_on_robust_oob")); + } + if (this->widget_shader_gpu_indirect != nullptr) { this->widget_shader_gpu_indirect->setEnabled(shader_gpu); if (refresh_areas == REFRESH_ENABLE_AND_STATE) diff --git a/vkconfig/settings_validation_areas.h b/vkconfig/settings_validation_areas.h index 3af505d1be..2a19647e24 100644 --- a/vkconfig/settings_validation_areas.h +++ b/vkconfig/settings_validation_areas.h @@ -93,6 +93,9 @@ class WidgetSettingValidation : public WidgetSettingBase { QTreeWidgetItem *item_shader_gpu_oob; QCheckBox *widget_shader_gpu_oob; + QTreeWidgetItem *item_shader_gpu_robust_oob; + QCheckBox *widget_shader_gpu_robust_oob; + QTreeWidgetItem *item_shader_gpu_desc_indexing; QCheckBox *widget_shader_gpu_desc_indexing; @@ -160,6 +163,7 @@ class WidgetSettingValidation : public WidgetSettingBase { void OnShaderGPUReserveChecked(bool checked); void OnShaderGPUDescIndexingChecked(bool checked); void OnShaderGPUOOBChecked(bool checked); + void OnShaderGPURobustOOBChecked(bool checked); void OnShaderGPUIndirectChecked(bool checked); void OnShaderDispatchIndirectChecked(bool checked); void OnShaderGPUVMALinearOutput(bool checked); diff --git a/vkconfig_core/version.cpp b/vkconfig_core/version.cpp index 040fffd7c2..997b89fe56 100644 --- a/vkconfig_core/version.cpp +++ b/vkconfig_core/version.cpp @@ -28,7 +28,7 @@ #include #include -const Version Version::VKCONFIG(2, 5, 0); +const Version Version::VKCONFIG(2, 5, 2); const Version Version::LAYER_CONFIG(2, 2, 3); #ifdef VK_HEADER_VERSION_COMPLETE const Version Version::VKHEADER(VK_HEADER_VERSION_COMPLETE); From f6ba6912533c2c24806022e49d6931dc8be49986 Mon Sep 17 00:00:00 2001 From: Christophe Date: Mon, 21 Nov 2022 12:07:12 +0100 Subject: [PATCH 007/154] C.I.: fix Github actions build Change-Id: I1c3b7d7843f1f7e8531890828c1e10778e85315d --- .github/workflows/ci_build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci_build.yml b/.github/workflows/ci_build.yml index 04585c33f0..9ee7473a50 100644 --- a/.github/workflows/ci_build.yml +++ b/.github/workflows/ci_build.yml @@ -77,7 +77,7 @@ jobs: - name: Install build dependencies run: | sudo apt-get -qq update - sudo apt-get install -y libxkbcommon-dev libwayland-dev libxrandr-dev qt5-default\ + sudo apt-get install -y libxkbcommon-dev libwayland-dev libxrandr-dev qtbase5-dev\ libx11-xcb-dev libxcb-randr0-dev cmake jq wget - name: Build and Test VulkanTools run: python3 scripts/github_ci_linux.py --config ${{ matrix.config.type }} From 202b61c47d6e99220cbf9ca56046ef5f9b387e15 Mon Sep 17 00:00:00 2001 From: Christophe Date: Mon, 21 Nov 2022 17:53:36 +0100 Subject: [PATCH 008/154] vkconfig: improve handling of robust oob warn Change-Id: Ifd74cd529d9ab289b878381bcdf55aca6fb05637 --- vkconfig/settings_tree.cpp | 1 + vkconfig/settings_validation_areas.cpp | 42 +++++++++++++------------- 2 files changed, 22 insertions(+), 21 deletions(-) diff --git a/vkconfig/settings_tree.cpp b/vkconfig/settings_tree.cpp index 5c623b41d0..86bdc42537 100644 --- a/vkconfig/settings_tree.cpp +++ b/vkconfig/settings_tree.cpp @@ -297,6 +297,7 @@ static bool IsBuiltinValidationSetting(const Parameter ¶meter, const std::st keys.push_back("printf_verbose"); keys.push_back("printf_buffer_size"); keys.push_back("gpuav_buffer_oob"); + keys.push_back("warn_on_robust_oob"); keys.push_back("validate_draw_indirect"); keys.push_back("vma_linear_output"); keys.push_back("fine_grained_locking"); diff --git a/vkconfig/settings_validation_areas.cpp b/vkconfig/settings_validation_areas.cpp index 2dea9a2cb7..8485138ca0 100644 --- a/vkconfig/settings_validation_areas.cpp +++ b/vkconfig/settings_validation_areas.cpp @@ -289,23 +289,23 @@ WidgetSettingValidation::WidgetSettingValidation(QTreeWidget *tree, QTreeWidgetI this->widget_shader_gpu_oob->setToolTip(value->description.c_str()); this->tree->setItemWidget(this->item_shader_gpu_oob, 0, this->widget_shader_gpu_oob); this->connect(this->widget_shader_gpu_oob, SIGNAL(clicked(bool)), this, SLOT(OnShaderGPUOOBChecked(bool))); - } - } - { - const SettingMetaBool *value = FindSetting(meta_set, "warn_on_robust_oob"); - if (IsSupported(value)) { - this->item_shader_gpu_robust_oob = new QTreeWidgetItem(); - this->item_shader_gpu_robust_oob->setSizeHint(0, QSize(0, ITEM_HEIGHT)); - this->item_shader_gpu->addChild(this->item_shader_gpu_robust_oob); - this->item_shader_gpu->setExpanded(true); - - this->widget_shader_gpu_robust_oob = new QCheckBox(this); - this->widget_shader_gpu_robust_oob->setText(value->label.c_str()); - this->widget_shader_gpu_robust_oob->setToolTip(value->description.c_str()); - this->tree->setItemWidget(this->item_shader_gpu_robust_oob, 0, this->widget_shader_gpu_robust_oob); - this->connect(this->widget_shader_gpu_robust_oob, SIGNAL(clicked(bool)), this, - SLOT(OnShaderGPURobustOOBChecked(bool))); + { + const SettingMetaBool *value = FindSetting(meta_set, "warn_on_robust_oob"); + if (IsSupported(value)) { + this->item_shader_gpu_robust_oob = new QTreeWidgetItem(); + this->item_shader_gpu_robust_oob->setSizeHint(0, QSize(0, ITEM_HEIGHT)); + this->item_shader_gpu_oob->addChild(this->item_shader_gpu_robust_oob); + this->item_shader_gpu_oob->setExpanded(true); + + this->widget_shader_gpu_robust_oob = new QCheckBox(this); + this->widget_shader_gpu_robust_oob->setText(value->label.c_str()); + this->widget_shader_gpu_robust_oob->setToolTip(value->description.c_str()); + this->tree->setItemWidget(this->item_shader_gpu_robust_oob, 0, this->widget_shader_gpu_robust_oob); + this->connect(this->widget_shader_gpu_robust_oob, SIGNAL(clicked(bool)), this, + SLOT(OnShaderGPURobustOOBChecked(bool))); + } + } } } @@ -861,12 +861,12 @@ void WidgetSettingValidation::Refresh(RefreshAreas refresh_areas) { this->widget_shader_gpu_oob->setEnabled(shader_gpu); if (refresh_areas == REFRESH_ENABLE_AND_STATE) this->widget_shader_gpu_oob->setChecked(this->HasDataBool("gpuav_buffer_oob")); - } - if (this->widget_shader_gpu_robust_oob != nullptr) { - this->widget_shader_gpu_robust_oob->setEnabled(shader_gpu); - if (refresh_areas == REFRESH_ENABLE_AND_STATE) - this->widget_shader_gpu_robust_oob->setChecked(this->HasDataBool("warn_on_robust_oob")); + if (this->widget_shader_gpu_robust_oob != nullptr) { + this->widget_shader_gpu_robust_oob->setEnabled(shader_gpu && this->HasDataBool("gpuav_buffer_oob")); + if (refresh_areas == REFRESH_ENABLE_AND_STATE) + this->widget_shader_gpu_robust_oob->setChecked(this->HasDataBool("warn_on_robust_oob")); + } } if (this->widget_shader_gpu_indirect != nullptr) { From d942c7afc9506877aaa3e80661113e9a05f49f4e Mon Sep 17 00:00:00 2001 From: Christophe Date: Tue, 22 Nov 2022 16:56:18 +0100 Subject: [PATCH 009/154] vkconfig: fix setting dependences with enums Change-Id: If2fe7d3e71afc7873859e118624aabf83615778a --- vkconfig_core/layer.cpp | 4 ++-- vkconfig_core/setting_flags.cpp | 15 +++++++++++---- 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/vkconfig_core/layer.cpp b/vkconfig_core/layer.cpp index 393face845..a110a2a6ed 100644 --- a/vkconfig_core/layer.cpp +++ b/vkconfig_core/layer.cpp @@ -389,7 +389,7 @@ void Layer::AddSettingsSet(SettingMetaSet& settings, const SettingMeta* parent, } } -void Layer::AddSettingData(SettingDataSet& settings, const QJsonValue& json_setting_value) { +void Layer::AddSettingData(SettingDataSet& settings_data, const QJsonValue& json_setting_value) { const QJsonObject& json_setting_object = json_setting_value.toObject(); const std::string& key = ReadStringValue(json_setting_object, "key"); @@ -401,5 +401,5 @@ void Layer::AddSettingData(SettingDataSet& settings, const QJsonValue& json_sett const bool result = setting_data->Load(json_setting_object); assert(result); - settings.push_back(setting_data); + settings_data.push_back(setting_data); } diff --git a/vkconfig_core/setting_flags.cpp b/vkconfig_core/setting_flags.cpp index 5ed453af83..0e8fa4362f 100644 --- a/vkconfig_core/setting_flags.cpp +++ b/vkconfig_core/setting_flags.cpp @@ -21,6 +21,7 @@ #include "setting_flags.h" #include "json.h" #include "layer.h" +#include "setting.h" #include @@ -41,11 +42,17 @@ bool SettingMetaEnumeration::Load(const QJsonObject& json_setting) { setting_enum_value.view = this->view; LoadMetaHeader(setting_enum_value, json_object); - if (json_object.value("settings") != QJsonValue::Undefined) { - this->layer.AddSettingsSet(setting_enum_value.settings, this, json_object.value("settings")); - } - this->enum_values.push_back(setting_enum_value); + + for (std::size_t i = 0, n = this->enum_values.size(); i < n; ++i) { + if (this->enum_values[i].key != setting_enum_value.key) { + continue; + } + + if (json_object.value("settings") != QJsonValue::Undefined) { + this->layer.AddSettingsSet(this->enum_values[i].settings, this, json_object.value("settings")); + } + } } return true; } From 3037aef0ddb8c7415e6589c15064c59dfe103e44 Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Mon, 14 Jun 2021 18:57:13 -0600 Subject: [PATCH 010/154] apidump: Use setfill/setw to prevent indentation overflow When the indentation gets too high apidump would start reading other memory in the executable, which leads to humerous but highly inccorect output. Change-Id: I94e31fc994bb373a29804c9c55a257cb6193266b --- layersvt/api_dump.h | 34 +++++++++++----------------------- 1 file changed, 11 insertions(+), 23 deletions(-) diff --git a/layersvt/api_dump.h b/layersvt/api_dump.h index e8f05e1451..4922f9b515 100644 --- a/layersvt/api_dump.h +++ b/layersvt/api_dump.h @@ -521,23 +521,26 @@ class ApiDumpSettings { stream << indentation(indents) << name << ": "; if (use_spaces) - stream << spaces(name_size - (int)strlen(name) - 2); + stream << std::setfill(' ') << std::setw(name_size - (int)strlen(name) - 2); else - stream << tabs((name_size - (int)strlen(name) - 3 + indent_size) / indent_size); + stream << std::setfill('\t') << std::setw((name_size - (int)strlen(name) - 3 + indent_size) / indent_size); if (show_type && use_spaces) - stream << type << spaces(type_size - (int)strlen(type)); + stream << type << std::setfill(' ') << std::setw(type_size - (int)strlen(type)); else if (show_type && !use_spaces) - stream << type << tabs((type_size - (int)strlen(type) - 1 + indent_size) / indent_size); + stream << type << std::setfill('\t') << std::setw((type_size - (int)strlen(type) - 1 + indent_size) / indent_size); return stream << " = "; } inline const char *indentation(int indents) const { - if (use_spaces) - return spaces(indents * indent_size); - else - return tabs(indents); + if (use_spaces) { + stream() << std::setfill(' ') << std::setw(indents * indent_size); + return ""; + } else { + stream() << std::setfill('\t') << std::setw(indents); + return ""; + } } inline bool shouldFlush() const { return should_flush; } @@ -650,10 +653,6 @@ class ApiDumpSettings { return default_value; } - inline static const char *spaces(int count) { return SPACES + (MAX_SPACES - std::max(count, 0)); } - - inline static const char *tabs(int count) { return TABS + (MAX_TABS - std::max(count, 0)); } - bool use_cout; std::string output_dir = ""; std::ofstream output_stream; @@ -673,19 +672,8 @@ class ApiDumpSettings { bool use_conditional_output = false; ConditionalFrameOutput condFrameOutput; - - static const char *const SPACES; - static const int MAX_SPACES = 144; - static const char *const TABS; - static const int MAX_TABS = 36; }; -const char *const ApiDumpSettings::SPACES = - " " - " " - " "; -const char *const ApiDumpSettings::TABS = "\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t"; - class ApiDumpInstance { public: inline ApiDumpInstance() : dump_settings(NULL), frame_count(0), thread_count(0) { From 311adc366ad905d0b15c6c888620f59ecbb2ab3c Mon Sep 17 00:00:00 2001 From: Bob Ellison Date: Mon, 28 Nov 2022 19:42:40 -0700 Subject: [PATCH 011/154] android: limit parallel builds The Android build is quite aggressive, attempting to consume all available cores; large builds (particularly the api_dump layer) cause all the processes involved to consume 3+G of memory, causing physical and swap memory to be exhausted, which causes sporadic build failures as the OOM killer kills the compiler processes. These changes allow the use of an environment variable $VT_BUILD_CORES to limit how many cores are in use; it also prevents the build from using additional parallel jobs if the load average is too high (on one 8-core system, the load average climbed to over 26 before the OOM killer started killing processes). --- build-android/build_all.sh | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/build-android/build_all.sh b/build-android/build_all.sh index fef3b1f92b..6dcbc1d3cf 100755 --- a/build-android/build_all.sh +++ b/build-android/build_all.sh @@ -29,6 +29,7 @@ if [[ $(uname) == "Linux" ]]; then elif [[ $(uname) == "Darwin" ]]; then cores=$(sysctl -n hw.ncpu) || echo 4 fi +use_cores=${VT_BUILD_CORES:-$cores} function findtool() { if [[ ! $(type -t $1) ]]; then @@ -66,7 +67,7 @@ function create_APK() { # ./update_external_sources_android.sh --no-build ./android-generate.sh -ndk-build -j $cores +ndk-build -j $use_cores -l $use_cores # # build VulkanLayerValidationTests APK From af4a6269a03bdd0721b324757367e602f24f4782 Mon Sep 17 00:00:00 2001 From: Tony-LunarG Date: Mon, 28 Nov 2022 12:53:12 -0700 Subject: [PATCH 012/154] build: Build layers using C++ 17 Dependencies from Vulkan-ValidationLayers now contain C++ 17 --- build-android/cmake/layerlib/CMakeLists.txt | 2 +- build-android/jni/Android.mk | 6 +++--- layer_factory/CMakeLists.txt | 7 ++++++- layersvt/CMakeLists.txt | 7 ++++++- scripts/vlf_makefile_generator.py | 2 +- 5 files changed, 17 insertions(+), 7 deletions(-) diff --git a/build-android/cmake/layerlib/CMakeLists.txt b/build-android/cmake/layerlib/CMakeLists.txt index 18844a761f..9120706da6 100644 --- a/build-android/cmake/layerlib/CMakeLists.txt +++ b/build-android/cmake/layerlib/CMakeLists.txt @@ -8,7 +8,7 @@ if (CMAKE_CURRENT_SOURCE_DIR MATCHES "sources/third_party/vulkan/src") set(BUILD_IN_NDK ON) endif() -set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -Wall -Werror \ +set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++17 -Wall -Werror \ -Wno-unused-function -Wno-unused-const-variable \ -Wno-c++98-compat-pedantic -DVK_PROTOTYPES \ -DVK_USE_PLATFORM_ANDROID_KHR") diff --git a/build-android/jni/Android.mk b/build-android/jni/Android.mk index 014a61ee0f..203200d238 100644 --- a/build-android/jni/Android.mk +++ b/build-android/jni/Android.mk @@ -33,7 +33,7 @@ LOCAL_C_INCLUDES += $(LOCAL_PATH)/$(THIRD_PARTY)/Vulkan-Headers/include \ $(LOCAL_PATH)/$(LAYER_DIR)/include \ $(LOCAL_PATH)/$(LVL_DIR)/layers \ $(LOCAL_PATH)/$(LVL_DIR)/layers/generated -LOCAL_CPPFLAGS += -std=c++11 -Wall -Werror -Wno-unused-function -Wno-unused-const-variable +LOCAL_CPPFLAGS += -std=c++17 -Wall -Werror -Wno-unused-function -Wno-unused-const-variable LOCAL_CPPFLAGS += -DVK_ENABLE_BETA_EXTENSIONS -DVK_USE_PLATFORM_ANDROID_KHR -DVK_PROTOTYPES -fvisibility=hidden include $(BUILD_STATIC_LIBRARY) @@ -50,7 +50,7 @@ LOCAL_C_INCLUDES += $(LOCAL_PATH)/$(THIRD_PARTY)/Vulkan-Headers/include \ $(LOCAL_PATH)/$(SRC_DIR)/layersvt \ $(LOCAL_PATH)/$(LAYER_DIR)/include LOCAL_STATIC_LIBRARIES += layer_utils -LOCAL_CPPFLAGS += -std=c++11 -Wall -Werror -Wno-unused-function -Wno-unused-const-variable -mxgot +LOCAL_CPPFLAGS += -std=c++17 -Wall -Werror -Wno-unused-function -Wno-unused-const-variable -mxgot LOCAL_CPPFLAGS += -DVK_ENABLE_BETA_EXTENSIONS -DVK_USE_PLATFORM_ANDROID_KHR -DVK_PROTOTYPES -fvisibility=hidden LOCAL_LDLIBS := -llog include $(BUILD_SHARED_LIBRARY) @@ -66,7 +66,7 @@ LOCAL_C_INCLUDES += $(LOCAL_PATH)/$(THIRD_PARTY)/Vulkan-Headers/include \ $(LOCAL_PATH)/$(SRC_DIR)/layersvt \ $(LOCAL_PATH)/$(LAYER_DIR)/include LOCAL_STATIC_LIBRARIES += layer_utils -LOCAL_CPPFLAGS += -std=c++11 -Wall -Werror -Wno-unused-function -Wno-unused-const-variable -mxgot +LOCAL_CPPFLAGS += -std=c++17 -Wall -Werror -Wno-unused-function -Wno-unused-const-variable -mxgot LOCAL_CPPFLAGS += -DVK_ENABLE_BETA_EXTENSIONS -DVK_USE_PLATFORM_ANDROID_KHR -DVK_PROTOTYPES -fvisibility=hidden LOCAL_LDLIBS := -llog include $(BUILD_SHARED_LIBRARY) diff --git a/layer_factory/CMakeLists.txt b/layer_factory/CMakeLists.txt index 266e7ab559..e4b35cb911 100644 --- a/layer_factory/CMakeLists.txt +++ b/layer_factory/CMakeLists.txt @@ -42,7 +42,7 @@ if (WIN32) # The changed behavior is that constructor initializers are now fixed to clear the struct members. add_compile_options("$<$,$,19>>:/wd4351>") else() - set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -Wpointer-arith -Wno-unused-function -Wno-sign-compare") + set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++17 -Wpointer-arith -Wno-unused-function -Wno-sign-compare") set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wpointer-arith -Wno-unused-function -Wno-sign-compare") endif() @@ -170,6 +170,11 @@ FOREACH(subdir ${ST_SUBDIRS}) add_factory_layer(${subdir} ${CMAKE_LAYER_FACTORY_SOURCE_DIR}/${subdir} layer_factory.cpp layer_factory.h ${Vulkan-ValidationLayers_INCLUDE_DIR}/xxhash.c ${INTERCEPTOR_SOURCES}) add_dependencies(VkLayer_${subdir} ${dep_chain}) set(dep_chain VkLayer_${subdir}) + set_target_properties(VkLayer_${subdir} PROPERTIES + CXX_STANDARD 17 + CXX_STANDARD_REQUIRED ON + CXX_EXTENSIONS OFF + ) ENDFOREACH() # Add targets for JSON file install. Try to follow the same convention as the Khronos Vulkan-ValidationLayers repository to maintain diff --git a/layersvt/CMakeLists.txt b/layersvt/CMakeLists.txt index 414958ec4d..e49f632272 100644 --- a/layersvt/CMakeLists.txt +++ b/layersvt/CMakeLists.txt @@ -79,6 +79,11 @@ if (WIN32) ) add_library(VkLayer_${target} SHARED ${ARGN} VkLayer_${target}.def) target_link_Libraries(VkLayer_${target} ${VkLayer_utils_LIBRARY}) + set_target_properties(VkLayer_${target} PROPERTIES + CXX_STANDARD 17 + CXX_STANDARD_REQUIRED ON + CXX_EXTENSIONS OFF + ) if(BUILD_APIDUMP) add_dependencies(VkLayer_${target} generate_api_cpp generate_api_h generate_api_html_h) add_dependencies(VkLayer_${target} generate_api_cpp generate_api_h generate_api_json_h) @@ -120,7 +125,7 @@ if (WIN32) set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -D_CRT_SECURE_NO_WARNINGS /bigobj") set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -D_CRT_SECURE_NO_WARNINGS /bigobj") else() - set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11") + set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++17") set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wpointer-arith") set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wpointer-arith") endif() diff --git a/scripts/vlf_makefile_generator.py b/scripts/vlf_makefile_generator.py index 6d6685cd71..0c6f20e9d1 100644 --- a/scripts/vlf_makefile_generator.py +++ b/scripts/vlf_makefile_generator.py @@ -89,7 +89,7 @@ contents += 'LOCAL_C_INCLUDES += $(LOCAL_PATH)/$(SRC_DIR)/layer_factory/%s\n' % factory_layer contents += 'LOCAL_C_INCLUDES += $(LOCAL_PATH)/$(LVL_DIR)/loader\n' contents += 'LOCAL_STATIC_LIBRARIES += layer_utils\n' - contents += 'LOCAL_CPPFLAGS += -std=c++11 -DVK_PROTOTYPES -Wall -Werror -Wno-unused-function -Wno-unused-const-variable\n' + contents += 'LOCAL_CPPFLAGS += -std=c++17 -DVK_PROTOTYPES -Wall -Werror -Wno-unused-function -Wno-unused-const-variable\n' contents += 'LOCAL_CPPFLAGS += -DVK_USE_PLATFORM_ANDROID_KHR -DVK_ENABLE_BETA_EXTENSIONS -fvisibility=hidden\n' contents += 'LOCAL_LDLIBS := -llog\n' contents += 'LOCAL_LDFLAGS += -Wl,-Bsymbolic\n' From 8a7b5bf4370de6be667378685d5b6858741e23ed Mon Sep 17 00:00:00 2001 From: Tony-LunarG Date: Thu, 17 Nov 2022 16:04:21 -0700 Subject: [PATCH 013/154] build: Update to 1.3.235 headers Also disable VK_EXT_descriptor_buffer because VVL did and we use that dispatch table --- CMakeLists.txt | 2 +- build-android/android-generate.bat | 12 ++++++------ build-android/android-generate.sh | 12 ++++++------ build-android/vulkan-headers_revision_android | 2 +- build-android/vulkan-tools_revision_android | 2 +- .../vulkan-validationlayers_revision_android | 2 +- scripts/known_good.json | 6 +++--- 7 files changed, 19 insertions(+), 19 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index add805449a..cb5f833d0e 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -227,7 +227,7 @@ macro(run_vulkantools_vk_xml_generate dependency output) add_custom_command(OUTPUT ${output} COMMAND ${PYTHON_CMD} -B ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py -registry ${VulkanRegistry_DIR}/vk.xml -scripts ${VulkanRegistry_DIR} ${output} -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_EXT_video_decode_h264 - -removeExtensions VK_EXT_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 + -removeExtensions VK_EXT_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 -removeExtensions VK_EXT_descriptor_buffer DEPENDS ${VulkanRegistry_DIR}/vk.xml ${VulkanRegistry_DIR}/generator.py ${VULKANTOOLS_SCRIPTS_DIR}/${dependency} ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py ${VulkanRegistry_DIR}/reg.py ) endmacro() diff --git a/build-android/android-generate.bat b/build-android/android-generate.bat index 515932b399..84fcc6652f 100644 --- a/build-android/android-generate.bat +++ b/build-android/android-generate.bat @@ -42,17 +42,17 @@ pushd generated\include REM layer factory echo Generating VT layer factory header/source files echo ******** -py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% layer_factory.h -py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% layer_factory.cpp +py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% layer_factory.h -removeExtensions VK_EXT_descriptor_buffer +py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% layer_factory.cpp -removeExtensions VK_EXT_descriptor_buffer py -3 %VT_SCRIPTS%\vlf_makefile_generator.py ..\..\..\layer_factory %REGISTRY_PATH%\..\include REM apidump echo Generating VT apidump header/source files echo ******** -py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% api_dump.cpp -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_EXT_video_decode_h264 -removeExtensions VK_EXT_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 -py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% api_dump_text.h -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_EXT_video_decode_h264 -removeExtensions VK_EXT_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 -py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% api_dump_html.h -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_EXT_video_decode_h264 -removeExtensions VK_EXT_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 -py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% api_dump_json.h -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_EXT_video_decode_h264 -removeExtensions VK_EXT_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 +py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% api_dump.cpp -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_EXT_video_decode_h264 -removeExtensions VK_EXT_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 -removeExtensions VK_EXT_descriptor_buffer +py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% api_dump_text.h -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_EXT_video_decode_h264 -removeExtensions VK_EXT_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 -removeExtensions VK_EXT_descriptor_buffer +py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% api_dump_html.h -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_EXT_video_decode_h264 -removeExtensions VK_EXT_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 -removeExtensions VK_EXT_descriptor_buffer +py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% api_dump_json.h -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_EXT_video_decode_h264 -removeExtensions VK_EXT_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 -removeExtensions VK_EXT_descriptor_buffer REM Copy over the built source files to LVL. Otherwise, REM cube won't build. diff --git a/build-android/android-generate.sh b/build-android/android-generate.sh index 0f5129a8af..137588e072 100755 --- a/build-android/android-generate.sh +++ b/build-android/android-generate.sh @@ -44,15 +44,15 @@ fi echo "Using python: $(which $PYTHON_EXECUTABLE)" # layer factory -( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} layer_factory.h) -( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} layer_factory.cpp) +( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} layer_factory.h -removeExtensions VK_EXT_descriptor_buffer) +( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} layer_factory.cpp -removeExtensions VK_EXT_descriptor_buffer) ( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vlf_makefile_generator.py ../../../layer_factory ${REGISTRY_PATH}/../include) # apidump -( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump.cpp -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_EXT_video_decode_h264 -removeExtensions VK_EXT_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265) -( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_text.h -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_EXT_video_decode_h264 -removeExtensions VK_EXT_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265) -( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_html.h -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_EXT_video_decode_h264 -removeExtensions VK_EXT_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265) -( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_json.h -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_EXT_video_decode_h264 -removeExtensions VK_EXT_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265) +( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump.cpp -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_EXT_video_decode_h264 -removeExtensions VK_EXT_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 -removeExtensions VK_EXT_descriptor_buffer) +( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_text.h -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_EXT_video_decode_h264 -removeExtensions VK_EXT_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 -removeExtensions VK_EXT_descriptor_buffer) +( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_html.h -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_EXT_video_decode_h264 -removeExtensions VK_EXT_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 -removeExtensions VK_EXT_descriptor_buffer) +( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_json.h -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_EXT_video_decode_h264 -removeExtensions VK_EXT_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 -removeExtensions VK_EXT_descriptor_buffer) ( pushd ${LVL_BASE}/build-android; rm -rf generated; mkdir -p generated/include generated/common; popd ) ( cd generated/include; cp -rf * ${LVL_BASE}/build-android/generated/include ) diff --git a/build-android/vulkan-headers_revision_android b/build-android/vulkan-headers_revision_android index 570452e57e..56fb87f6e7 100644 --- a/build-android/vulkan-headers_revision_android +++ b/build-android/vulkan-headers_revision_android @@ -1 +1 @@ -v1.3.234 +v1.3.235 diff --git a/build-android/vulkan-tools_revision_android b/build-android/vulkan-tools_revision_android index 570452e57e..56fb87f6e7 100644 --- a/build-android/vulkan-tools_revision_android +++ b/build-android/vulkan-tools_revision_android @@ -1 +1 @@ -v1.3.234 +v1.3.235 diff --git a/build-android/vulkan-validationlayers_revision_android b/build-android/vulkan-validationlayers_revision_android index 570452e57e..56fb87f6e7 100644 --- a/build-android/vulkan-validationlayers_revision_android +++ b/build-android/vulkan-validationlayers_revision_android @@ -1 +1 @@ -v1.3.234 +v1.3.235 diff --git a/scripts/known_good.json b/scripts/known_good.json index edc428f178..9efdca1a78 100644 --- a/scripts/known_good.json +++ b/scripts/known_good.json @@ -6,7 +6,7 @@ "sub_dir" : "Vulkan-Headers", "build_dir" : "Vulkan-Headers/build", "install_dir" : "Vulkan-Headers/build/install", - "commit" : "v1.3.234" + "commit" : "v1.3.235" }, { "name" : "Vulkan-Loader", @@ -14,7 +14,7 @@ "sub_dir" : "Vulkan-Loader", "build_dir" : "Vulkan-Loader/build", "install_dir" : "Vulkan-Loader/build/install", - "commit" : "v1.3.234", + "commit" : "v1.3.235", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", @@ -60,7 +60,7 @@ "sub_dir" : "Vulkan-ValidationLayers", "build_dir" : "Vulkan-ValidationLayers/build", "install_dir" : "Vulkan-ValidationLayers/build/install", - "commit" : "v1.3.234", + "commit" : "v1.3.235", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", From 84b5016615c611aa877d739d433e697b74316270 Mon Sep 17 00:00:00 2001 From: Tony-LunarG Date: Mon, 28 Nov 2022 14:04:36 -0700 Subject: [PATCH 014/154] docs: Remove VS 2015 references --- BUILD.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/BUILD.md b/BUILD.md index 8881a451d7..99e6dc21f0 100644 --- a/BUILD.md +++ b/BUILD.md @@ -10,7 +10,7 @@ supplementing the loader and validation layer core components found at https://g Windows 7+ with additional required software packages: -- Microsoft Visual Studio 2017 or 2019: it is possible that lesser/older versions may work, but not guaranteed. +- Microsoft Visual Studio 2017, 2019 or 2022: it is possible that lesser/older versions may work, but not guaranteed. - [CMake 3.10.2](https://cmake.org/files/v3.10/cmake-3.10.2-win64-x64.zip) is recommended. - Tell the installer to "Add CMake to the system `PATH`" environment variable. - Python 3 (from https://www.python.org/downloads). Notes: @@ -182,7 +182,7 @@ ctest --parallel 8 --output-on-failure Use the following to ensure the Android build works. #### Android Build from Windows -From Developer Command Prompt for VS2015: +From Developer Command Prompt for VS2017: ``` cd build-android update_external_sources_android.bat @@ -355,10 +355,10 @@ quick-start tool for common use cases and default configurations. Cygwin is used in order to obtain a local copy of the Git repository, and to run the CMake command that creates Visual Studio files. Visual Studio is used to build the software, and will re-run CMake as appropriate. -To build all Windows targets (e.g. in a "Developer Command Prompt for VS2015" window): +To build all Windows targets (e.g. in a "Developer Command Prompt for VS2017" window): ``` cd VulkanTools # cd to the root of the VulkanTools git repository -cmake -H. -Bdbuild -DCMAKE_BUILD_TYPE=Debug -G "Visual Studio 14 2015 Win64" -DCMAKE_INSTALL_PREFIX=build/install -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_directory -DVULKAN_LOADER_INSTALL_DIR=absolute_path_to_install_directory -DVULKAN_VALIDATIONLAYERS_INSTALL_DIR=absolute_path_to_install_directory +cmake -H. -Bdbuild -DCMAKE_BUILD_TYPE=Debug -G "Visual Studio 15 2017 Win64" -DCMAKE_INSTALL_PREFIX=build/install -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_directory -DVULKAN_LOADER_INSTALL_DIR=absolute_path_to_install_directory -DVULKAN_VALIDATIONLAYERS_INSTALL_DIR=absolute_path_to_install_directory cmake --build dbuild --config Debug --target install ``` From c0130b2085ec70dec8a3ccb3c0499c84763fd35d Mon Sep 17 00:00:00 2001 From: Tony-LunarG Date: Wed, 7 Dec 2022 08:33:06 -0700 Subject: [PATCH 015/154] build: Update to 1.3.236 headers --- build-android/vulkan-headers_revision_android | 2 +- build-android/vulkan-tools_revision_android | 2 +- build-android/vulkan-validationlayers_revision_android | 2 +- scripts/known_good.json | 8 ++++---- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/build-android/vulkan-headers_revision_android b/build-android/vulkan-headers_revision_android index 56fb87f6e7..ac7edadc87 100644 --- a/build-android/vulkan-headers_revision_android +++ b/build-android/vulkan-headers_revision_android @@ -1 +1 @@ -v1.3.235 +v1.3.236 diff --git a/build-android/vulkan-tools_revision_android b/build-android/vulkan-tools_revision_android index 56fb87f6e7..ac7edadc87 100644 --- a/build-android/vulkan-tools_revision_android +++ b/build-android/vulkan-tools_revision_android @@ -1 +1 @@ -v1.3.235 +v1.3.236 diff --git a/build-android/vulkan-validationlayers_revision_android b/build-android/vulkan-validationlayers_revision_android index 56fb87f6e7..ac7edadc87 100644 --- a/build-android/vulkan-validationlayers_revision_android +++ b/build-android/vulkan-validationlayers_revision_android @@ -1 +1 @@ -v1.3.235 +v1.3.236 diff --git a/scripts/known_good.json b/scripts/known_good.json index 9efdca1a78..f7331e4c47 100644 --- a/scripts/known_good.json +++ b/scripts/known_good.json @@ -6,7 +6,7 @@ "sub_dir" : "Vulkan-Headers", "build_dir" : "Vulkan-Headers/build", "install_dir" : "Vulkan-Headers/build/install", - "commit" : "v1.3.235" + "commit" : "v1.3.236" }, { "name" : "Vulkan-Loader", @@ -14,7 +14,7 @@ "sub_dir" : "Vulkan-Loader", "build_dir" : "Vulkan-Loader/build", "install_dir" : "Vulkan-Loader/build/install", - "commit" : "v1.3.235", + "commit" : "v1.3.236", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", @@ -35,7 +35,7 @@ "sub_dir" : "Vulkan-Tools", "build_dir" : "Vulkan-Tools/build", "install_dir" : "Vulkan-Tools/build/install", - "commit" : "v1.3.234", + "commit" : "v1.3.236", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", @@ -60,7 +60,7 @@ "sub_dir" : "Vulkan-ValidationLayers", "build_dir" : "Vulkan-ValidationLayers/build", "install_dir" : "Vulkan-ValidationLayers/build/install", - "commit" : "v1.3.235", + "commit" : "5f77f7c00a0ebfcb3be0fcc11af76d28b4ccd247", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", From 26304501c945b8b5f9b1b69daebf1085d652f449 Mon Sep 17 00:00:00 2001 From: Christophe Date: Fri, 9 Dec 2022 14:54:53 +0100 Subject: [PATCH 016/154] vkconfig: fix macOS hang (maybe) Change-Id: I5d863842c43ccb54708561818c93c39918aafcbd --- vkconfig_core/environment.cpp | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/vkconfig_core/environment.cpp b/vkconfig_core/environment.cpp index f2ce982728..498923c5f8 100644 --- a/vkconfig_core/environment.cpp +++ b/vkconfig_core/environment.cpp @@ -535,7 +535,8 @@ bool ExactExecutableFromAppBundle(std::string& app_path) { line_buffer = stream.readLine(); // Qt Creator char* cExeName = new char[line_buffer.length()]; // Prevent buffer overrun - const char* pStart = strstr(line_buffer.toUtf8().constData(), ""); + QByteArray line_array = line_buffer.toUtf8(); + const char* pStart = strstr(line_array.constData(), ""); if (pStart == nullptr) return false; // We found it, now extract it out From c3ba6ad84b718e40f60939f3d434c6d6b8e28acc Mon Sep 17 00:00:00 2001 From: Christophe Date: Wed, 14 Dec 2022 11:39:26 +0100 Subject: [PATCH 017/154] vkconfig: Add Imagination Technologies best practices Change-Id: Ia2a9b73012706cfec2dc1310e0f257d6337e18b8 --- vkconfig/settings_validation_areas.cpp | 19 +++++++++++++++++++ vkconfig/settings_validation_areas.h | 4 ++++ 2 files changed, 23 insertions(+) diff --git a/vkconfig/settings_validation_areas.cpp b/vkconfig/settings_validation_areas.cpp index 8485138ca0..75ea7637ed 100644 --- a/vkconfig/settings_validation_areas.cpp +++ b/vkconfig/settings_validation_areas.cpp @@ -56,6 +56,7 @@ static const char *TOKEN_SYNC_QUEUE_SUBMIT = "VALIDATION_CHECK_ENABLE_SYNCHRONIZ static const char *TOKEN_BEST = "VK_VALIDATION_FEATURE_ENABLE_BEST_PRACTICES_EXT"; static const char *TOKEN_BEST_ARM = "VALIDATION_CHECK_ENABLE_VENDOR_SPECIFIC_ARM"; static const char *TOKEN_BEST_AMD = "VALIDATION_CHECK_ENABLE_VENDOR_SPECIFIC_AMD"; +static const char *TOKEN_BEST_IMG = "VALIDATION_CHECK_ENABLE_VENDOR_SPECIFIC_IMG"; static const char *TOKEN_BEST_NVIDIA = "VALIDATION_CHECK_ENABLE_VENDOR_SPECIFIC_NVIDIA"; QCheckBox *WidgetSettingValidation::CreateWidget(QTreeWidgetItem *parent, QTreeWidgetItem **item, const char *key, @@ -146,6 +147,8 @@ WidgetSettingValidation::WidgetSettingValidation(QTreeWidget *tree, QTreeWidgetI widget_best_arm(nullptr), item_best_amd(nullptr), widget_best_amd(nullptr), + item_best_img(nullptr), + widget_best_img(nullptr), item_best_nvidia(nullptr), widget_best_nvidia(nullptr), @@ -453,6 +456,10 @@ WidgetSettingValidation::WidgetSettingValidation(QTreeWidget *tree, QTreeWidgetI if (this->widget_best_arm != nullptr) this->connect(this->widget_best_arm, SIGNAL(clicked(bool)), this, SLOT(OnBestArmChecked(bool))); + this->widget_best_img = this->CreateWidget(this->item_best, &this->item_best_img, "enables", TOKEN_BEST_IMG); + if (this->widget_best_img != nullptr) + this->connect(this->widget_best_img, SIGNAL(clicked(bool)), this, SLOT(OnBestImgChecked(bool))); + this->widget_best_nvidia = this->CreateWidget(this->item_best, &this->item_best_nvidia, "enables", TOKEN_BEST_NVIDIA); if (this->widget_best_nvidia != nullptr) this->connect(this->widget_best_nvidia, SIGNAL(clicked(bool)), this, SLOT(OnBestNvidiaChecked(bool))); @@ -683,6 +690,11 @@ void WidgetSettingValidation::OnBestAmdChecked(bool checked) { this->OnSettingChanged(); } +void WidgetSettingValidation::OnBestImgChecked(bool checked) { + this->UpdateFlag("enables", TOKEN_BEST_IMG, checked); + this->OnSettingChanged(); +} + void WidgetSettingValidation::OnBestNvidiaChecked(bool checked) { this->UpdateFlag("enables", TOKEN_BEST_NVIDIA, checked); this->OnSettingChanged(); @@ -949,6 +961,13 @@ void WidgetSettingValidation::Refresh(RefreshAreas refresh_areas) { } } + if (this->widget_best_img != nullptr) { + this->widget_best_img->setEnabled(HasDataFlag("enables", TOKEN_BEST)); + if (refresh_areas == REFRESH_ENABLE_AND_STATE) { + this->widget_best_img->setChecked(HasDataFlag("enables", TOKEN_BEST_IMG)); + } + } + if (this->widget_best_nvidia != nullptr) { this->widget_best_nvidia->setEnabled(HasDataFlag("enables", TOKEN_BEST)); if (refresh_areas == REFRESH_ENABLE_AND_STATE) { diff --git a/vkconfig/settings_validation_areas.h b/vkconfig/settings_validation_areas.h index 2a19647e24..c621e562ce 100644 --- a/vkconfig/settings_validation_areas.h +++ b/vkconfig/settings_validation_areas.h @@ -135,6 +135,9 @@ class WidgetSettingValidation : public WidgetSettingBase { QTreeWidgetItem *item_best_amd; QCheckBox *widget_best_amd; + QTreeWidgetItem *item_best_img; + QCheckBox *widget_best_img; + QTreeWidgetItem *item_best_nvidia; QCheckBox *widget_best_nvidia; @@ -178,6 +181,7 @@ class WidgetSettingValidation : public WidgetSettingBase { void OnBestChecked(bool checked); void OnBestArmChecked(bool checked); void OnBestAmdChecked(bool checked); + void OnBestImgChecked(bool checked); void OnBestNvidiaChecked(bool checked); void OnSettingChanged(); From 7247204a6ff42e6e04cd47c1a1b95c05c89c4c1f Mon Sep 17 00:00:00 2001 From: Juan Ramos Date: Wed, 14 Dec 2022 12:22:06 -0700 Subject: [PATCH 018/154] vkvia: Fix not finding Ubuntu package on Ubuntu based distros --- via/via_system_linux.cpp | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/via/via_system_linux.cpp b/via/via_system_linux.cpp index 3ba7fb9a6e..693617e288 100644 --- a/via/via_system_linux.cpp +++ b/via/via_system_linux.cpp @@ -1157,10 +1157,9 @@ ViaSystem::ViaResults ViaSystemLinux::PrintSystemSdkInfo() { } // Next, try system install items - std::string upper_os_name = _os_name; - std::transform(upper_os_name.begin(), upper_os_name.end(), upper_os_name.begin(), ::toupper); - if (upper_os_name.find("UBUNTU") != std::string::npos || upper_os_name.find("DEBIAN") != std::string::npos) { + if (!sdk_exists) { FILE *dpkg_output = popen("dpkg-query --show --showformat='${Package} ${Version}' vulkan-sdk", "r"); + if (dpkg_output != nullptr) { char cur_line[1035]; std::string install_name; From d0c55962165c21bfbe75026c2a5cc5431165fff2 Mon Sep 17 00:00:00 2001 From: Juan Ramos Date: Wed, 21 Dec 2022 10:51:36 -0700 Subject: [PATCH 019/154] cmake: Fix Wayland CMake warnings Use pkg-config to find linux system libraries --- CMakeLists.txt | 10 +++---- cmake/FindWayland.cmake | 66 ----------------------------------------- cmake/FindX11_XCB.cmake | 32 -------------------- cmake/FindXCB.cmake | 52 -------------------------------- via/CMakeLists.txt | 35 +++++++++------------- 5 files changed, 19 insertions(+), 176 deletions(-) delete mode 100644 cmake/FindWayland.cmake delete mode 100644 cmake/FindX11_XCB.cmake delete mode 100644 cmake/FindXCB.cmake diff --git a/CMakeLists.txt b/CMakeLists.txt index cb5f833d0e..766d1f7ce6 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -122,22 +122,22 @@ if(CMAKE_SYSTEM_NAME STREQUAL "Linux" OR CMAKE_SYSTEM_NAME MATCHES "BSD") endif() endif() - include(FindPkgConfig) option(BUILD_WSI_XCB_SUPPORT "Build XCB WSI support" ON) option(BUILD_WSI_XLIB_SUPPORT "Build Xlib WSI support" ON) option(BUILD_WSI_WAYLAND_SUPPORT "Build Wayland WSI support" ON) + find_package(PkgConfig REQUIRED QUIET) # Use PkgConfig to find Linux system libraries + if (BUILD_WSI_XCB_SUPPORT) - find_package(XCB REQUIRED) + pkg_check_modules(XCB REQUIRED QUIET IMPORTED_TARGET xcb) endif() if (BUILD_WSI_XLIB_SUPPORT) - find_package(X11 REQUIRED) + pkg_check_modules(X11 REQUIRED QUIET IMPORTED_TARGET x11) endif() if (BUILD_WSI_WAYLAND_SUPPORT) - find_package(Wayland REQUIRED) - include_directories(${WAYLAND_CLIENT_INCLUDE_DIR}) + pkg_check_modules(WAYLAND_CLIENT REQUIRED QUIET IMPORTED_TARGET wayland-client) endif() elseif(CMAKE_SYSTEM_NAME STREQUAL "Darwin") option(BUILD_MOLTENVK_SUPPORT "Build MoltenVK WSI support" ON) diff --git a/cmake/FindWayland.cmake b/cmake/FindWayland.cmake deleted file mode 100644 index f93218b873..0000000000 --- a/cmake/FindWayland.cmake +++ /dev/null @@ -1,66 +0,0 @@ -# Try to find Wayland on a Unix system -# -# This will define: -# -# WAYLAND_FOUND - True if Wayland is found -# WAYLAND_LIBRARIES - Link these to use Wayland -# WAYLAND_INCLUDE_DIR - Include directory for Wayland -# WAYLAND_DEFINITIONS - Compiler flags for using Wayland -# -# In addition the following more fine grained variables will be defined: -# -# WAYLAND_CLIENT_FOUND WAYLAND_CLIENT_INCLUDE_DIR WAYLAND_CLIENT_LIBRARIES -# WAYLAND_SERVER_FOUND WAYLAND_SERVER_INCLUDE_DIR WAYLAND_SERVER_LIBRARIES -# WAYLAND_EGL_FOUND WAYLAND_EGL_INCLUDE_DIR WAYLAND_EGL_LIBRARIES -# -# Copyright (c) 2013 Martin Gräßlin -# -# Redistribution and use is allowed according to the terms of the BSD license. -# For details see the accompanying COPYING-CMAKE-SCRIPTS file. - -IF (NOT WIN32) - IF (WAYLAND_INCLUDE_DIR AND WAYLAND_LIBRARIES) - # In the cache already - SET(WAYLAND_FIND_QUIETLY TRUE) - ENDIF () - - # Use pkg-config to get the directories and then use these values - # in the FIND_PATH() and FIND_LIBRARY() calls - FIND_PACKAGE(PkgConfig) - PKG_CHECK_MODULES(PKG_WAYLAND QUIET wayland-client wayland-server wayland-egl wayland-cursor) - - SET(WAYLAND_DEFINITIONS ${PKG_WAYLAND_CFLAGS}) - - FIND_PATH(WAYLAND_CLIENT_INCLUDE_DIR NAMES wayland-client.h HINTS ${PKG_WAYLAND_INCLUDE_DIRS}) - FIND_PATH(WAYLAND_SERVER_INCLUDE_DIR NAMES wayland-server.h HINTS ${PKG_WAYLAND_INCLUDE_DIRS}) - FIND_PATH(WAYLAND_EGL_INCLUDE_DIR NAMES wayland-egl.h HINTS ${PKG_WAYLAND_INCLUDE_DIRS}) - FIND_PATH(WAYLAND_CURSOR_INCLUDE_DIR NAMES wayland-cursor.h HINTS ${PKG_WAYLAND_INCLUDE_DIRS}) - - FIND_LIBRARY(WAYLAND_CLIENT_LIBRARIES NAMES wayland-client HINTS ${PKG_WAYLAND_LIBRARY_DIRS}) - FIND_LIBRARY(WAYLAND_SERVER_LIBRARIES NAMES wayland-server HINTS ${PKG_WAYLAND_LIBRARY_DIRS}) - FIND_LIBRARY(WAYLAND_EGL_LIBRARIES NAMES wayland-egl HINTS ${PKG_WAYLAND_LIBRARY_DIRS}) - FIND_LIBRARY(WAYLAND_CURSOR_LIBRARIES NAMES wayland-cursor HINTS ${PKG_WAYLAND_LIBRARY_DIRS}) - - set(WAYLAND_INCLUDE_DIR ${WAYLAND_CLIENT_INCLUDE_DIR} ${WAYLAND_SERVER_INCLUDE_DIR} ${WAYLAND_EGL_INCLUDE_DIR} ${WAYLAND_CURSOR_INCLUDE_DIR}) - - set(WAYLAND_LIBRARIES ${WAYLAND_CLIENT_LIBRARIES} ${WAYLAND_SERVER_LIBRARIES} ${WAYLAND_EGL_LIBRARIES} ${WAYLAND_CURSOR_LIBRARIES}) - - list(REMOVE_DUPLICATES WAYLAND_INCLUDE_DIR) - - include(FindPackageHandleStandardArgs) - - FIND_PACKAGE_HANDLE_STANDARD_ARGS(WAYLAND_CLIENT DEFAULT_MSG WAYLAND_CLIENT_LIBRARIES WAYLAND_CLIENT_INCLUDE_DIR) - FIND_PACKAGE_HANDLE_STANDARD_ARGS(WAYLAND_SERVER DEFAULT_MSG WAYLAND_SERVER_LIBRARIES WAYLAND_SERVER_INCLUDE_DIR) - FIND_PACKAGE_HANDLE_STANDARD_ARGS(WAYLAND_EGL DEFAULT_MSG WAYLAND_EGL_LIBRARIES WAYLAND_EGL_INCLUDE_DIR) - FIND_PACKAGE_HANDLE_STANDARD_ARGS(WAYLAND_CURSOR DEFAULT_MSG WAYLAND_CURSOR_LIBRARIES WAYLAND_CURSOR_INCLUDE_DIR) - FIND_PACKAGE_HANDLE_STANDARD_ARGS(WAYLAND DEFAULT_MSG WAYLAND_LIBRARIES WAYLAND_INCLUDE_DIR) - - MARK_AS_ADVANCED( - WAYLAND_INCLUDE_DIR WAYLAND_LIBRARIES - WAYLAND_CLIENT_INCLUDE_DIR WAYLAND_CLIENT_LIBRARIES - WAYLAND_SERVER_INCLUDE_DIR WAYLAND_SERVER_LIBRARIES - WAYLAND_EGL_INCLUDE_DIR WAYLAND_EGL_LIBRARIES - WAYLAND_CURSOR_INCLUDE_DIR WAYLAND_CURSOR_LIBRARIES - ) - -ENDIF () diff --git a/cmake/FindX11_XCB.cmake b/cmake/FindX11_XCB.cmake deleted file mode 100644 index 956bf89d77..0000000000 --- a/cmake/FindX11_XCB.cmake +++ /dev/null @@ -1,32 +0,0 @@ -# - Try to find libX11-xcb -# Once done this will define -# -# X11_XCB_FOUND - system has libX11-xcb -# X11_XCB_LIBRARIES - Link these to use libX11-xcb -# X11_XCB_INCLUDE_DIR - the libX11-xcb include dir -# X11_XCB_DEFINITIONS - compiler switches required for using libX11-xcb - -# Copyright (c) 2011 Fredrik Höglund -# Copyright (c) 2008 Helio Chissini de Castro, -# Copyright (c) 2007 Matthias Kretz, -# -# Redistribution and use is allowed according to the terms of the BSD license. -# For details see the accompanying COPYING-CMAKE-SCRIPTS file. - -IF (NOT WIN32) - # use pkg-config to get the directories and then use these values - # in the FIND_PATH() and FIND_LIBRARY() calls - FIND_PACKAGE(PkgConfig) - PKG_CHECK_MODULES(PKG_X11_XCB QUIET x11-xcb) - - SET(X11_XCB_DEFINITIONS ${PKG_X11_XCB_CFLAGS}) - - FIND_PATH(X11_XCB_INCLUDE_DIR NAMES X11/Xlib-xcb.h HINTS ${PKG_X11_XCB_INCLUDE_DIRS}) - FIND_LIBRARY(X11_XCB_LIBRARIES NAMES X11-xcb HINTS ${PKG_X11_XCB_LIBRARY_DIRS}) - - include(FindPackageHandleStandardArgs) - FIND_PACKAGE_HANDLE_STANDARD_ARGS(X11_XCB DEFAULT_MSG X11_XCB_LIBRARIES X11_XCB_INCLUDE_DIR) - - MARK_AS_ADVANCED(X11_XCB_INCLUDE_DIR X11_XCB_LIBRARIES) -ENDIF (NOT WIN32) - diff --git a/cmake/FindXCB.cmake b/cmake/FindXCB.cmake deleted file mode 100644 index 6b9a068788..0000000000 --- a/cmake/FindXCB.cmake +++ /dev/null @@ -1,52 +0,0 @@ -# - FindXCB -# -# Copyright (C) 2015-2016 Valve Corporation -# Copyright (C) 2015-2016 LunarG, Inc. - -find_package(PkgConfig) - -if(NOT XCB_FIND_COMPONENTS) - set(XCB_FIND_COMPONENTS xcb) -endif() - -include(FindPackageHandleStandardArgs) -set(XCB_FOUND true) -set(XCB_INCLUDE_DIRS "") -set(XCB_LIBRARIES "") -foreach(comp ${XCB_FIND_COMPONENTS}) - # component name - string(TOUPPER ${comp} compname) - string(REPLACE "-" "_" compname ${compname}) - # header name - string(REPLACE "xcb-" "" headername xcb/${comp}.h) - # library name - set(libname ${comp}) - - pkg_check_modules(PC_${comp} QUIET ${comp}) - - find_path(${compname}_INCLUDE_DIR NAMES ${headername} - HINTS - ${PC_${comp}_INCLUDEDIR} - ${PC_${comp}_INCLUDE_DIRS} - ) - - find_library(${compname}_LIBRARY NAMES ${libname} - HINTS - ${PC_${comp}_LIBDIR} - ${PC_${comp}_LIBRARY_DIRS} - ) - - find_package_handle_standard_args(${compname} - FOUND_VAR ${compname}_FOUND - REQUIRED_VARS ${compname}_INCLUDE_DIR ${compname}_LIBRARY) - mark_as_advanced(${compname}_INCLUDE_DIR ${compname}_LIBRARY) - - list(APPEND XCB_INCLUDE_DIRS ${${compname}_INCLUDE_DIR}) - list(APPEND XCB_LIBRARIES ${${compname}_LIBRARY}) - - if(NOT ${compname}_FOUND) - set(XCB_FOUND false) - endif() -endforeach() - -list(REMOVE_DUPLICATES XCB_INCLUDE_DIRS) diff --git a/via/CMakeLists.txt b/via/CMakeLists.txt index 83612b82e3..7cde12c17b 100644 --- a/via/CMakeLists.txt +++ b/via/CMakeLists.txt @@ -32,24 +32,6 @@ else() if(APPLE) add_definitions(-DVIA_MACOS_TARGET) elseif(CMAKE_SYSTEM_NAME MATCHES "Linux") - if (BUILD_WSI_XCB_SUPPORT) - find_package(XCB REQUIRED) - - include_directories(${XCB_INCLUDE_DIRS}) - link_libraries(${XCB_LIBRARIES}) - endif() - if (BUILD_WSI_XLIB_SUPPORT) - find_package(X11 REQUIRED) - - include_directories(${X11_INCLUDE_DIRS}) - link_libraries(${X11_LIBRARIES}) - endif() - if (BUILD_WSI_WAYLAND_SUPPORT) - find_package(Wayland REQUIRED) - - include_directories(${WAYLAND_CLIENT_INCLUDE_DIR}) - link_libraries(${WAYLAND_CLIENT_LIBRARIES}) - endif() add_definitions(-DVIA_LINUX_TARGET) elseif(CMAKE_SYSTEM_NAME MATCHES "BSD") add_definitions(-DVIA_BSD_TARGET) @@ -89,12 +71,23 @@ add_executable(vkvia endif() target_include_directories(vkvia PUBLIC ${JSONCPP_INCLUDE_DIR}) -target_link_libraries(vkvia Vulkan::Vulkan) +target_link_libraries(vkvia Vulkan::Vulkan ${CMAKE_DL_LIBS}) if(WIN32) target_link_libraries(vkvia version shlwapi Cfgmgr32) -else() - target_link_libraries(vkvia dl) endif() + +if(BUILD_WSI_XCB_SUPPORT) + target_link_libraries(vkvia PkgConfig::XCB) +endif() + +if (BUILD_WSI_XLIB_SUPPORT) + target_link_libraries(vkvia PkgConfig::X11) +endif() + +if(BUILD_WSI_WAYLAND_SUPPORT) + target_link_libraries(vkvia PkgConfig::WAYLAND_CLIENT) +endif() + if(UNIX) install(TARGETS vkvia DESTINATION ${CMAKE_INSTALL_BINDIR}) endif() From 8fe04b644301e3e7a14dd42a37c4b06fb5398c42 Mon Sep 17 00:00:00 2001 From: Tony-LunarG Date: Tue, 3 Jan 2023 10:56:52 -0700 Subject: [PATCH 020/154] build: Update to 1.3.238 headers --- CMakeLists.txt | 4 ++-- build-android/android-generate.bat | 12 ++++++------ build-android/android-generate.sh | 12 ++++++------ build-android/vulkan-headers_revision_android | 2 +- build-android/vulkan-tools_revision_android | 2 +- .../vulkan-validationlayers_revision_android | 2 +- scripts/known_good.json | 8 ++++---- 7 files changed, 21 insertions(+), 21 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 766d1f7ce6..b14f06a08c 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -226,8 +226,8 @@ endif() macro(run_vulkantools_vk_xml_generate dependency output) add_custom_command(OUTPUT ${output} COMMAND ${PYTHON_CMD} -B ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py -registry ${VulkanRegistry_DIR}/vk.xml -scripts ${VulkanRegistry_DIR} ${output} - -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_EXT_video_decode_h264 - -removeExtensions VK_EXT_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 -removeExtensions VK_EXT_descriptor_buffer + -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_KHR_video_decode_h264 + -removeExtensions VK_KHR_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 DEPENDS ${VulkanRegistry_DIR}/vk.xml ${VulkanRegistry_DIR}/generator.py ${VULKANTOOLS_SCRIPTS_DIR}/${dependency} ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py ${VulkanRegistry_DIR}/reg.py ) endmacro() diff --git a/build-android/android-generate.bat b/build-android/android-generate.bat index 84fcc6652f..c4929aac56 100644 --- a/build-android/android-generate.bat +++ b/build-android/android-generate.bat @@ -42,17 +42,17 @@ pushd generated\include REM layer factory echo Generating VT layer factory header/source files echo ******** -py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% layer_factory.h -removeExtensions VK_EXT_descriptor_buffer -py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% layer_factory.cpp -removeExtensions VK_EXT_descriptor_buffer +py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% layer_factory.h +py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% layer_factory.cpp py -3 %VT_SCRIPTS%\vlf_makefile_generator.py ..\..\..\layer_factory %REGISTRY_PATH%\..\include REM apidump echo Generating VT apidump header/source files echo ******** -py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% api_dump.cpp -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_EXT_video_decode_h264 -removeExtensions VK_EXT_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 -removeExtensions VK_EXT_descriptor_buffer -py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% api_dump_text.h -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_EXT_video_decode_h264 -removeExtensions VK_EXT_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 -removeExtensions VK_EXT_descriptor_buffer -py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% api_dump_html.h -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_EXT_video_decode_h264 -removeExtensions VK_EXT_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 -removeExtensions VK_EXT_descriptor_buffer -py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% api_dump_json.h -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_EXT_video_decode_h264 -removeExtensions VK_EXT_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 -removeExtensions VK_EXT_descriptor_buffer +py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% api_dump.cpp -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_KHR_video_decode_h264 -removeExtensions VK_KHR_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 +py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% api_dump_text.h -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_KHR_video_decode_h264 -removeExtensions VK_KHR_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 +py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% api_dump_html.h -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_KHR_video_decode_h264 -removeExtensions VK_KHR_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 +py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% api_dump_json.h -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_KHR_video_decode_h264 -removeExtensions VK_KHR_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 REM Copy over the built source files to LVL. Otherwise, REM cube won't build. diff --git a/build-android/android-generate.sh b/build-android/android-generate.sh index 137588e072..e73dd5fc7a 100755 --- a/build-android/android-generate.sh +++ b/build-android/android-generate.sh @@ -44,15 +44,15 @@ fi echo "Using python: $(which $PYTHON_EXECUTABLE)" # layer factory -( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} layer_factory.h -removeExtensions VK_EXT_descriptor_buffer) -( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} layer_factory.cpp -removeExtensions VK_EXT_descriptor_buffer) +( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} layer_factory.h) +( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} layer_factory.cpp) ( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vlf_makefile_generator.py ../../../layer_factory ${REGISTRY_PATH}/../include) # apidump -( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump.cpp -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_EXT_video_decode_h264 -removeExtensions VK_EXT_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 -removeExtensions VK_EXT_descriptor_buffer) -( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_text.h -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_EXT_video_decode_h264 -removeExtensions VK_EXT_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 -removeExtensions VK_EXT_descriptor_buffer) -( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_html.h -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_EXT_video_decode_h264 -removeExtensions VK_EXT_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 -removeExtensions VK_EXT_descriptor_buffer) -( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_json.h -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_EXT_video_decode_h264 -removeExtensions VK_EXT_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 -removeExtensions VK_EXT_descriptor_buffer) +( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump.cpp -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_KHR_video_decode_h264 -removeExtensions VK_KHR_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265) +( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_text.h -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_KHR_video_decode_h264 -removeExtensions VK_KHR_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265) +( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_html.h -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_KHR_video_decode_h264 -removeExtensions VK_KHR_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265) +( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_json.h -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_KHR_video_decode_h264 -removeExtensions VK_KHR_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265) ( pushd ${LVL_BASE}/build-android; rm -rf generated; mkdir -p generated/include generated/common; popd ) ( cd generated/include; cp -rf * ${LVL_BASE}/build-android/generated/include ) diff --git a/build-android/vulkan-headers_revision_android b/build-android/vulkan-headers_revision_android index ac7edadc87..2997364be3 100644 --- a/build-android/vulkan-headers_revision_android +++ b/build-android/vulkan-headers_revision_android @@ -1 +1 @@ -v1.3.236 +v1.3.238 diff --git a/build-android/vulkan-tools_revision_android b/build-android/vulkan-tools_revision_android index ac7edadc87..d295ad7d3d 100644 --- a/build-android/vulkan-tools_revision_android +++ b/build-android/vulkan-tools_revision_android @@ -1 +1 @@ -v1.3.236 +7b798e3e47824c94ffc6c8e75b0440bb78d2b7e2 diff --git a/build-android/vulkan-validationlayers_revision_android b/build-android/vulkan-validationlayers_revision_android index ac7edadc87..2997364be3 100644 --- a/build-android/vulkan-validationlayers_revision_android +++ b/build-android/vulkan-validationlayers_revision_android @@ -1 +1 @@ -v1.3.236 +v1.3.238 diff --git a/scripts/known_good.json b/scripts/known_good.json index f7331e4c47..438beb358d 100644 --- a/scripts/known_good.json +++ b/scripts/known_good.json @@ -6,7 +6,7 @@ "sub_dir" : "Vulkan-Headers", "build_dir" : "Vulkan-Headers/build", "install_dir" : "Vulkan-Headers/build/install", - "commit" : "v1.3.236" + "commit" : "v1.3.238" }, { "name" : "Vulkan-Loader", @@ -14,7 +14,7 @@ "sub_dir" : "Vulkan-Loader", "build_dir" : "Vulkan-Loader/build", "install_dir" : "Vulkan-Loader/build/install", - "commit" : "v1.3.236", + "commit" : "v1.3.238", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", @@ -35,7 +35,7 @@ "sub_dir" : "Vulkan-Tools", "build_dir" : "Vulkan-Tools/build", "install_dir" : "Vulkan-Tools/build/install", - "commit" : "v1.3.236", + "commit" : "7b798e3e47824c94ffc6c8e75b0440bb78d2b7e2", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", @@ -60,7 +60,7 @@ "sub_dir" : "Vulkan-ValidationLayers", "build_dir" : "Vulkan-ValidationLayers/build", "install_dir" : "Vulkan-ValidationLayers/build/install", - "commit" : "5f77f7c00a0ebfcb3be0fcc11af76d28b4ccd247", + "commit" : "v1.3.238", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", From 7b6bd401db67f19e756a1ba11951961e145d3c01 Mon Sep 17 00:00:00 2001 From: Jeremy Gebben Date: Tue, 3 Jan 2023 13:36:48 -0700 Subject: [PATCH 021/154] layers: Update to use latest vk_layer_logging.h The api provided by this file has changed. --- build-android/jni/Android.mk | 1 + .../vulkan-validationlayers_revision_android | 2 +- layersvt/screenshot.cpp | 1 + scripts/known_good.json | 2 +- scripts/layer_factory_generator.py | 35 +++++++------------ 5 files changed, 16 insertions(+), 25 deletions(-) diff --git a/build-android/jni/Android.mk b/build-android/jni/Android.mk index 203200d238..49625a4e13 100644 --- a/build-android/jni/Android.mk +++ b/build-android/jni/Android.mk @@ -25,6 +25,7 @@ include $(CLEAR_VARS) LOCAL_MODULE := layer_utils LOCAL_SRC_FILES += $(LVL_DIR)/layers/vk_layer_config.cpp LOCAL_SRC_FILES += $(LVL_DIR)/layers/vk_layer_extension_utils.cpp +LOCAL_SRC_FILES += $(LVL_DIR)/layers/vk_layer_logging.cpp LOCAL_SRC_FILES += $(LVL_DIR)/layers/vk_layer_utils.cpp LOCAL_SRC_FILES += $(LVL_DIR)/layers/generated/vk_format_utils.cpp LOCAL_SRC_FILES += $(SRC_DIR)/vku/vk_layer_settings.cpp diff --git a/build-android/vulkan-validationlayers_revision_android b/build-android/vulkan-validationlayers_revision_android index 2997364be3..03eec28d5a 100644 --- a/build-android/vulkan-validationlayers_revision_android +++ b/build-android/vulkan-validationlayers_revision_android @@ -1 +1 @@ -v1.3.238 +92bd5a9ce36b327c9cba42e0b332b3f9cbde0f6f diff --git a/layersvt/screenshot.cpp b/layersvt/screenshot.cpp index 2e98338ae1..4b20dc6d30 100755 --- a/layersvt/screenshot.cpp +++ b/layersvt/screenshot.cpp @@ -36,6 +36,7 @@ using namespace std; #include "vk_dispatch_table_helper.h" +#include "vk_enum_string_helper.h" #include "vk_layer_config.h" #include "vk_layer_table.h" #include "vk_layer_extension_utils.h" diff --git a/scripts/known_good.json b/scripts/known_good.json index 438beb358d..332c826060 100644 --- a/scripts/known_good.json +++ b/scripts/known_good.json @@ -60,7 +60,7 @@ "sub_dir" : "Vulkan-ValidationLayers", "build_dir" : "Vulkan-ValidationLayers/build", "install_dir" : "Vulkan-ValidationLayers/build/install", - "commit" : "v1.3.238", + "commit" : "92bd5a9ce36b327c9cba42e0b332b3f9cbde0f6f", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", diff --git a/scripts/layer_factory_generator.py b/scripts/layer_factory_generator.py index 4b29622e2b..b3cdd41d82 100644 --- a/scripts/layer_factory_generator.py +++ b/scripts/layer_factory_generator.py @@ -347,15 +347,15 @@ class layer_factory; // Clean up logging callback, if any while (instance_data->logging_messenger.size() > 0) { VkDebugUtilsMessengerEXT messenger = instance_data->logging_messenger.back(); - layer_destroy_callback(instance_data->report_data, messenger, pAllocator); + LayerDestroyCallback(instance_data->report_data, messenger, pAllocator); instance_data->logging_messenger.pop_back(); } while (instance_data->logging_callback.size() > 0) { VkDebugReportCallbackEXT callback = instance_data->logging_callback.back(); - layer_destroy_callback(instance_data->report_data, callback, pAllocator); + LayerDestroyCallback(instance_data->report_data, callback, pAllocator); instance_data->logging_callback.pop_back(); } - layer_debug_utils_destroy_instance(instance_data->report_data); + LayerDebugUtilsDestroyInstance(instance_data->report_data); FreeLayerDataPtr(key, instance_layer_data_map); } @@ -424,7 +424,7 @@ class layer_factory; intercept->PreCallCreateDebugReportCallbackEXT(instance, pCreateInfo, pAllocator, pCallback); } VkResult result = instance_data->dispatch_table.CreateDebugReportCallbackEXT(instance, pCreateInfo, pAllocator, pCallback); - result = layer_create_report_callback(instance_data->report_data, false, pCreateInfo, pAllocator, pCallback); + result = LayerCreateReportCallback(instance_data->report_data, false, pCreateInfo, pAllocator, pCallback); for (auto intercept : global_interceptor_list) { intercept->PostCallCreateDebugReportCallbackEXT(instance, pCreateInfo, pAllocator, pCallback, result); } @@ -438,7 +438,7 @@ class layer_factory; intercept->PreCallDestroyDebugReportCallbackEXT(instance, callback, pAllocator); } instance_data->dispatch_table.DestroyDebugReportCallbackEXT(instance, callback, pAllocator); - layer_destroy_callback(instance_data->report_data, callback, pAllocator); + LayerDestroyCallback(instance_data->report_data, callback, pAllocator); for (auto intercept : global_interceptor_list) { intercept->PostCallDestroyDebugReportCallbackEXT(instance, callback, pAllocator); } @@ -556,6 +556,7 @@ def beginFile(self, genOpts): for s in genOpts.prefixText: write(s, file=self.outFile) write('#include "vulkan/vk_layer.h"', file=self.outFile) + write('#include \n', file=self.outFile) write('#include \n', file=self.outFile) write('class layer_factory;', file=self.outFile) write('extern std::vector global_interceptor_list;', file=self.outFile) @@ -577,27 +578,15 @@ def beginFile(self, genOpts): self.layer_factory += ' bool log_msg(const debug_report_data *debug_data, VkFlags msg_flags, VkObjectType object_type,\n' self.layer_factory += ' uint64_t src_object, const std::string &vuid_text, const char *format, ...) {\n' self.layer_factory += ' if (!debug_data) return false;\n' - self.layer_factory += ' VkFlags local_severity = 0;\n' - self.layer_factory += ' VkFlags local_type = 0;\n' - self.layer_factory += ' DebugReportFlagsToAnnotFlags(msg_flags, true, &local_severity, &local_type);\n' - self.layer_factory += ' if (!debug_data || !(debug_data->active_severities & local_severity) || !(debug_data->active_types & local_type)) {\n' - self.layer_factory += ' // Message is not wanted\n' - self.layer_factory += ' return false;\n' - self.layer_factory += ' }\n' - self.layer_factory += ' \n' - self.layer_factory += ' va_list argptr;\n' - self.layer_factory += ' va_start(argptr, format);\n' - self.layer_factory += ' char *str;\n' - self.layer_factory += ' if (-1 == vasprintf(&str, format, argptr)) {\n' - self.layer_factory += ' // On failure, glibc vasprintf leaves str undefined\n' - self.layer_factory += ' str = nullptr;\n' - self.layer_factory += ' }\n' - self.layer_factory += ' va_end(argptr);\n' - self.layer_factory += ' \n' + self.layer_factory += '\n' self.layer_factory += ' VulkanTypedHandle null_handle{};\n' self.layer_factory += ' LogObjectList objlist(null_handle);\n' + self.layer_factory += ' va_list argptr;\n' + self.layer_factory += ' va_start(argptr, format);\n' + self.layer_factory += ' const bool result = LogMsg(debug_data, msg_flags, objlist, vuid_text, format, argptr);\n' self.layer_factory += ' va_end(argptr);\n' - self.layer_factory += ' return LogMsgLocked(debug_data, msg_flags, objlist, vuid_text, str);\n' + self.layer_factory += '\n' + self.layer_factory += ' return result;\n' self.layer_factory += ' }\n' self.layer_factory += '\n' self.layer_factory += ' // Pre/post hook point declarations\n' From 0190c3b718b0758a873c23c73cb92b8c74a0d498 Mon Sep 17 00:00:00 2001 From: Juan Ramos Date: Tue, 10 Jan 2023 12:40:45 -0700 Subject: [PATCH 022/154] cmake: Raise minimum to 3.17.2 The vulkan validation layers update their CMake min to 3.17.2 Raise min accordingly --- CMakeLists.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index b14f06a08c..e208caf98e 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,4 +1,4 @@ -cmake_minimum_required(VERSION 3.10.2) +cmake_minimum_required(VERSION 3.17.2) enable_testing() From 3465109ac2f2c361045e1daf53d2db12e5934810 Mon Sep 17 00:00:00 2001 From: Juan Ramos Date: Tue, 10 Jan 2023 15:43:38 -0700 Subject: [PATCH 023/154] cmake: Cleanup CMake build - Update known_good.json to working dependencies - Delete cmake/FindVulkanHeaders.cmake - Use Vulkan::Headers - Use CMake functionality provided by VulkanHeaders - Remove usage of deprecated vk_sdk_platform.h --- CMakeLists.txt | 9 +-- cmake/FindVulkanHeaders.cmake | 128 ---------------------------------- layer_factory/CMakeLists.txt | 8 +-- layersvt/CMakeLists.txt | 6 +- scripts/known_good.json | 8 +-- via/CMakeLists-SDK.txt | 2 +- via/CMakeLists.txt | 2 +- vkconfig/CMakeLists.txt | 3 +- vkconfig_core/CMakeLists.txt | 3 +- vku/CMakeLists.txt | 5 +- vku/vk_layer_settings.cpp | 3 - 11 files changed, 21 insertions(+), 156 deletions(-) delete mode 100644 cmake/FindVulkanHeaders.cmake diff --git a/CMakeLists.txt b/CMakeLists.txt index e208caf98e..4d4af4cb3f 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -42,7 +42,6 @@ set(CMAKE_PREFIX_PATH ${CMAKE_PREFIX_PATH};${VULKAN_HEADERS_INSTALL_DIR};${VULKA message(STATUS "Using find_package to locate Vulkan") find_package(Vulkan) message(STATUS "Vulkan FOUND = ${Vulkan_FOUND}") -message(STATUS "Vulkan Include = ${Vulkan_INCLUDE_DIR}") message(STATUS "Vulkan Lib = ${Vulkan_LIBRARY}") if(NOT VULKAN_HEADERS_INSTALL_DIR AND NOT DEFINED ENV{VULKAN_HEADERS_INSTALL_DIR}) @@ -151,9 +150,7 @@ set (SUBPROJECTS_DIR ${CMAKE_CURRENT_SOURCE_DIR}/submodules) set(VULKANTOOLS_SCRIPTS_DIR ${CMAKE_CURRENT_SOURCE_DIR}/scripts) -# Header file for CMake settings -find_package(VulkanHeaders) -include_directories(${VulkanHeaders_INCLUDE_DIR} ${PROJECT_BINARY_DIR}/${VALIDATION_LAYERS_RELATIVE_LOCATION}) +find_package(VulkanHeaders REQUIRED CONFIG) # The vulkan loader search is: # User-supplied setting of CMAKE_PREFIX_PATH @@ -225,10 +222,10 @@ endif() # Define macro used for building vkxml generated files macro(run_vulkantools_vk_xml_generate dependency output) add_custom_command(OUTPUT ${output} - COMMAND ${PYTHON_CMD} -B ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py -registry ${VulkanRegistry_DIR}/vk.xml -scripts ${VulkanRegistry_DIR} ${output} + COMMAND ${PYTHON_CMD} -B ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py -registry ${VULKAN_HEADERS_REGISTRY_DIRECTORY}/vk.xml -scripts ${VULKAN_HEADERS_REGISTRY_DIRECTORY} ${output} -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_KHR_video_decode_h264 -removeExtensions VK_KHR_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 - DEPENDS ${VulkanRegistry_DIR}/vk.xml ${VulkanRegistry_DIR}/generator.py ${VULKANTOOLS_SCRIPTS_DIR}/${dependency} ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py ${VulkanRegistry_DIR}/reg.py + DEPENDS ${VULKAN_HEADERS_REGISTRY_DIRECTORY}/vk.xml ${VULKAN_HEADERS_REGISTRY_DIRECTORY}/generator.py ${VULKANTOOLS_SCRIPTS_DIR}/${dependency} ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py ${VULKAN_HEADERS_REGISTRY_DIRECTORY}/reg.py ) endmacro() diff --git a/cmake/FindVulkanHeaders.cmake b/cmake/FindVulkanHeaders.cmake deleted file mode 100644 index 65450c0b8b..0000000000 --- a/cmake/FindVulkanHeaders.cmake +++ /dev/null @@ -1,128 +0,0 @@ -#.rst: -# FindVulkanHeaders -# ----------------- -# -# Try to find Vulkan Headers and Registry. -# -# This module is intended to be used by projects that build Vulkan -# "system" components such as the loader and layers. -# Vulkan applications should instead use the FindVulkan (or similar) -# find module that locates the headers and the loader library. -# -# When using this find module to locate the headers and registry -# in a Vulkan-Headers repository, the Vulkan-Headers repository -# should be built with 'install' target and the following environment -# or CMake variable set to the location of the install directory. -# -# VULKAN_HEADERS_INSTALL_DIR -# -# IMPORTED Targets -# ^^^^^^^^^^^^^^^^ -# -# This module defines no IMPORTED targets -# -# Result Variables -# ^^^^^^^^^^^^^^^^ -# -# This module defines the following variables:: -# -# VulkanHeaders_FOUND - True if VulkanHeaders was found -# VulkanHeaders_INCLUDE_DIRS - include directories for VulkanHeaders -# -# VulkanRegistry_FOUND - True if VulkanRegistry was found -# VulkanRegistry_DIRS - directories for VulkanRegistry -# VulkanHeaders_VERSION_MAJOR - The Major API version of the latest version -# contained in the Vulkan header -# VulkanHeaders_VERSION_MINOR - The Minor API version of the latest version -# contained in the Vulkan header -# VulkanHeaders_VERSION_PATCH - The Patch API version of the latest version -# contained in the Vulkan header -# -# The module will also define two cache variables:: -# -# VulkanHeaders_INCLUDE_DIR - the VulkanHeaders include directory -# VulkanRegistry_DIR - the VulkanRegistry directory -# - -# Use HINTS instead of PATH to search these locations before -# searching system environment variables like $PATH that may -# contain SDK directories. -find_path(VulkanHeaders_INCLUDE_DIR - NAMES vulkan/vulkan.h - HINTS - ${VULKAN_HEADERS_INSTALL_DIR}/include - "$ENV{VULKAN_HEADERS_INSTALL_DIR}/include" - "$ENV{VULKAN_SDK}/include") - -if(VulkanHeaders_INCLUDE_DIR) - get_filename_component(VULKAN_REGISTRY_PATH_HINT ${VulkanHeaders_INCLUDE_DIR} DIRECTORY) - find_path(VulkanRegistry_DIR - NAMES vk.xml - HINTS "${VULKAN_REGISTRY_PATH_HINT}/share/vulkan/registry") -endif() - -set(VulkanHeaders_INCLUDE_DIRS ${VulkanHeaders_INCLUDE_DIR}) -set(VulkanRegistry_DIRS ${VulkanRegistry_DIR}) - -include(FindPackageHandleStandardArgs) -find_package_handle_standard_args(VulkanHeaders - DEFAULT_MSG - VulkanHeaders_INCLUDE_DIR) -set(FPHSA_NAME_MISMATCHED TRUE) -find_package_handle_standard_args(VulkanRegistry - DEFAULT_MSG - VulkanRegistry_DIR) -unset(FPHSA_NAME_MISMATCHED) - -mark_as_advanced(VulkanHeaders_INCLUDE_DIR VulkanRegistry_DIR) - -# Determine the major/minor/patch version from the vulkan header - -set(VulkanHeaders_VERSION_MAJOR "0") -set(VulkanHeaders_VERSION_MINOR "0") -set(VulkanHeaders_VERSION_PATCH "0") -set(VulkanHeaders_main_header ${VulkanHeaders_INCLUDE_DIR}/vulkan/vulkan_core.h) - -# Find all lines in the header file that contain any version we may be interested in -# NOTE: They start with #define and then have other keywords -file(STRINGS - ${VulkanHeaders_main_header} - VulkanHeader_lines - REGEX "^#define VK_HEADER_VERSION(_COMPLETE)? ") - -foreach(VulkanHeader_line ${VulkanHeader_lines}) - - # First, handle the case where we have a major/minor version - # Format is: - # #define VK_HEADER_VERSION_COMPLETE VK_MAKE_API_VERSION(0, X, Y, VK_HEADER_VERSION) - # We grab the major version (X) and minor version (Y) out of the parentheses - string(REGEX MATCH "VK_HEADER_VERSION_COMPLETE VK_MAKE_API_VERSION\\(.*\\)" VulkanHeaders_out ${VulkanHeader_line}) - string(REGEX MATCHALL "[0-9]+" VulkanHeaders_MAJOR_MINOR "${VulkanHeaders_out}") - if (VulkanHeaders_MAJOR_MINOR) - list (GET VulkanHeaders_MAJOR_MINOR 1 VulkanHeaders_cur_major) - list (GET VulkanHeaders_MAJOR_MINOR 2 VulkanHeaders_cur_minor) - if (${VulkanHeaders_cur_major} GREATER ${VulkanHeaders_VERSION_MAJOR}) - set(VulkanHeaders_VERSION_MAJOR ${VulkanHeaders_cur_major}) - set(VulkanHeaders_VERSION_MINOR ${VulkanHeaders_cur_minor}) - endif() - if (${VulkanHeaders_cur_major} EQUAL ${VulkanHeaders_VERSION_MAJOR} AND - ${VulkanHeaders_cur_minor} GREATER ${VulkanHeaders_VERSION_MINOR}) - set(VulkanHeaders_VERSION_MINOR ${VulkanHeaders_cur_minor}) - endif() - endif() - - # Second, handle the case where we have the patch version - # Format is: - # #define VK_HEADER_VERSION Z - # Where Z is the patch version which we just grab off the end - string(REGEX MATCH "define.*VK_HEADER_VERSION[^_].*[0-9]+" VulkanHeaders_out ${VulkanHeader_line}) - list(LENGTH VulkanHeaders_out VulkanHeaders_len) - if (VulkanHeaders_len) - string(REGEX MATCH "[0-9]+" VulkanHeaders_VERSION_PATCH "${VulkanHeaders_out}") - endif() - -endforeach() -MESSAGE(STATUS - "Detected Vulkan Version ${VulkanHeaders_VERSION_MAJOR}." - "${VulkanHeaders_VERSION_MINOR}." - "${VulkanHeaders_VERSION_PATCH}") diff --git a/layer_factory/CMakeLists.txt b/layer_factory/CMakeLists.txt index e4b35cb911..7f49fa0394 100644 --- a/layer_factory/CMakeLists.txt +++ b/layer_factory/CMakeLists.txt @@ -91,7 +91,7 @@ foreach(SUBDIR ${ST_SUBDIRS}) set(TARGET_NAME VkLayer_${SUBDIR}) set(CONFIG_DEFINES -DINPUT_FILE=${JSON_TEMPLATE_PATH} - -DVK_VERSION="${VulkanHeaders_VERSION_MAJOR}.${VulkanHeaders_VERSION_MINOR}.${VulkanHeaders_VERSION_PATCH}" + -DVK_VERSION="${VulkanHeaders_VERSION}" ) set(CONFIG_DEFINES ${CONFIG_DEFINES} -DOUTPUT_FILE="$/${TARGET_NAME}.json" @@ -126,7 +126,7 @@ foreach(SUBDIR ${ST_SUBDIRS}) file(WRITE ${dst_json} ${target_json_file}) add_library(VkLayer_${target} SHARED ${ARGN} VkLayer_${target}.def) - target_link_Libraries(VkLayer_${target} ${VkLayer_utils_LIBRARY}) + target_link_Libraries(VkLayer_${target} Vulkan::Headers ${VkLayer_utils_LIBRARY}) target_include_directories(VkLayer_${target} PRIVATE ${subdir}) endmacro() else() @@ -137,7 +137,7 @@ foreach(SUBDIR ${ST_SUBDIRS}) file(TO_NATIVE_PATH ${JSON_DEST_PATH}/VkLayer_${target}.json dst_json) file(WRITE ${dst_json} ${target_json_file}) add_library(VkLayer_${target} SHARED ${ARGN}) - target_link_Libraries(VkLayer_${target} ${VkLayer_utils_LIBRARY}) + target_link_Libraries(VkLayer_${target} Vulkan::Headers ${VkLayer_utils_LIBRARY}) target_include_directories(VkLayer_${target} PRIVATE ${subdir}) set_target_properties(VkLayer_${target} PROPERTIES LINK_FLAGS "-Wl,-Bsymbolic,--exclude-libs,ALL") endmacro() @@ -151,7 +151,7 @@ if(UNIX) -DINPUT_FILE=${CMAKE_CURRENT_SOURCE_DIR}/layer_factory.json.in -DLAYER_NAME="VK_LAYER_LUNARG_layer_factory" -DRELATIVE_LAYER_BINARY="./libVkLayer_layer_factory.so" - -DVK_VERSION="${VulkanHeaders_VERSION_MAJOR}.${VulkanHeaders_VERSION_MINOR}.${VulkanHeaders_VERSION_PATCH}" + -DVK_VERSION="${VulkanHeaders_VERSION}" -DOUTPUT_FILE="layer_factory_linux.json" ) add_custom_target(layer_factory_linux-json ALL diff --git a/layersvt/CMakeLists.txt b/layersvt/CMakeLists.txt index e49f632272..61a48f9f7b 100644 --- a/layersvt/CMakeLists.txt +++ b/layersvt/CMakeLists.txt @@ -78,7 +78,7 @@ if (WIN32) VERBATIM ) add_library(VkLayer_${target} SHARED ${ARGN} VkLayer_${target}.def) - target_link_Libraries(VkLayer_${target} ${VkLayer_utils_LIBRARY}) + target_link_Libraries(VkLayer_${target} Vulkan::Headers ${VkLayer_utils_LIBRARY}) set_target_properties(VkLayer_${target} PROPERTIES CXX_STANDARD 17 CXX_STANDARD_REQUIRED ON @@ -93,7 +93,7 @@ if (WIN32) else() macro(add_vk_layer target) add_library(VkLayer_${target} SHARED ${ARGN}) - target_link_Libraries(VkLayer_${target} ${VkLayer_utils_LIBRARY}) + target_link_Libraries(VkLayer_${target} Vulkan::Headers ${VkLayer_utils_LIBRARY}) add_dependencies(VkLayer_${target} generate_api_cpp generate_api_h generate_api_html_h) add_dependencies(VkLayer_${target} generate_api_cpp generate_api_h generate_api_json_h) if (NOT APPLE) @@ -165,7 +165,7 @@ file(WRITE "${CMAKE_CURRENT_BINARY_DIR}/generator.cmake" "configure_file(\"\${IN foreach(TARGET_NAME ${TARGET_NAMES}) set(CONFIG_DEFINES -DINPUT_FILE="${CMAKE_CURRENT_SOURCE_DIR}/${TARGET_NAME}.json.in" - -DVK_VERSION="${VulkanHeaders_VERSION_MAJOR}.${VulkanHeaders_VERSION_MINOR}.${VulkanHeaders_VERSION_PATCH}" + -DVK_VERSION="${VulkanHeaders_VERSION}" ) # Get the needed properties from that target set(CONFIG_DEFINES ${CONFIG_DEFINES} diff --git a/scripts/known_good.json b/scripts/known_good.json index 332c826060..5c53e03f6c 100644 --- a/scripts/known_good.json +++ b/scripts/known_good.json @@ -6,7 +6,7 @@ "sub_dir" : "Vulkan-Headers", "build_dir" : "Vulkan-Headers/build", "install_dir" : "Vulkan-Headers/build/install", - "commit" : "v1.3.238" + "commit": "5eeb2c4c570ce92f5f48bf667e39e9d4da2ef13a" }, { "name" : "Vulkan-Loader", @@ -14,7 +14,7 @@ "sub_dir" : "Vulkan-Loader", "build_dir" : "Vulkan-Loader/build", "install_dir" : "Vulkan-Loader/build/install", - "commit" : "v1.3.238", + "commit": "4e1777a8ffbb9b2e784c09a82ecdbc10875825f0", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", @@ -35,7 +35,7 @@ "sub_dir" : "Vulkan-Tools", "build_dir" : "Vulkan-Tools/build", "install_dir" : "Vulkan-Tools/build/install", - "commit" : "7b798e3e47824c94ffc6c8e75b0440bb78d2b7e2", + "commit": "6ef427d3b9877395e07f0618ada16d81c95ce974", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", @@ -60,7 +60,7 @@ "sub_dir" : "Vulkan-ValidationLayers", "build_dir" : "Vulkan-ValidationLayers/build", "install_dir" : "Vulkan-ValidationLayers/build/install", - "commit" : "92bd5a9ce36b327c9cba42e0b332b3f9cbde0f6f", + "commit": "0ee326ed922913aeaba0cbf873db96e0245e91b4", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", diff --git a/via/CMakeLists-SDK.txt b/via/CMakeLists-SDK.txt index 5decf2fb47..c039588851 100644 --- a/via/CMakeLists-SDK.txt +++ b/via/CMakeLists-SDK.txt @@ -106,7 +106,7 @@ add_executable(vkvia ${JSONCPP_SOURCE_DIR}/jsoncpp.cpp) endif() target_include_directories(vkvia PUBLIC ${JSONCPP_INCLUDE_DIR}) -target_link_libraries(vkvia ${LIBRARIES}) +target_link_libraries(vkvia Vulkan::Headers ${LIBRARIES}) if(WIN32) target_link_libraries(vkvia version) endif() diff --git a/via/CMakeLists.txt b/via/CMakeLists.txt index 7cde12c17b..7b35257b54 100644 --- a/via/CMakeLists.txt +++ b/via/CMakeLists.txt @@ -71,7 +71,7 @@ add_executable(vkvia endif() target_include_directories(vkvia PUBLIC ${JSONCPP_INCLUDE_DIR}) -target_link_libraries(vkvia Vulkan::Vulkan ${CMAKE_DL_LIBS}) +target_link_libraries(vkvia Vulkan::Headers Vulkan::Vulkan ${CMAKE_DL_LIBS}) if(WIN32) target_link_libraries(vkvia version shlwapi Cfgmgr32) endif() diff --git a/vkconfig/CMakeLists.txt b/vkconfig/CMakeLists.txt index 9a0a56a52c..e7f367e66a 100644 --- a/vkconfig/CMakeLists.txt +++ b/vkconfig/CMakeLists.txt @@ -41,8 +41,7 @@ else() add_executable(vkconfig ${FILES_ALL} ${FILES_UI}) endif() - target_include_directories(vkconfig PRIVATE "${Vulkan_INCLUDE_DIR}") - target_link_libraries(vkconfig vkconfig_core Qt5::Core Qt5::Gui Qt5::Widgets Qt5::Network) + target_link_libraries(vkconfig Vulkan::Headers vkconfig_core Qt5::Core Qt5::Gui Qt5::Widgets Qt5::Network) target_compile_definitions(vkconfig PRIVATE ${VKCONFIG_DEFINITIONS}) install(TARGETS vkconfig DESTINATION ${CMAKE_INSTALL_BINDIR}) diff --git a/vkconfig_core/CMakeLists.txt b/vkconfig_core/CMakeLists.txt index 2d117d2ca6..b091fe3f72 100644 --- a/vkconfig_core/CMakeLists.txt +++ b/vkconfig_core/CMakeLists.txt @@ -62,8 +62,7 @@ if(Qt5_FOUND) add_compile_options("-Wno-maybe-uninitialized") endif() - target_include_directories(vkconfig_core PRIVATE "${Vulkan_INCLUDE_DIR}") - target_link_libraries(vkconfig_core vku Qt5::Core Qt5::Gui Qt5::Widgets Qt5::Network) + target_link_libraries(vkconfig_core Vulkan::Headers vku Qt5::Core Qt5::Gui Qt5::Widgets Qt5::Network) target_compile_definitions(vkconfig_core PRIVATE ${VKCONFIG_DEFINITIONS}) add_subdirectory(test) diff --git a/vku/CMakeLists.txt b/vku/CMakeLists.txt index 1c427d3108..1c2f10a058 100644 --- a/vku/CMakeLists.txt +++ b/vku/CMakeLists.txt @@ -22,6 +22,8 @@ set(CMAKE_POSITION_INDEPENDENT_CODE ON) add_library(vku STATIC ${FILES_SOURCE} ${FILES_HEADER}) +target_link_libraries(vku PRIVATE Vulkan::Headers) + if(WIN32) target_compile_definitions(vku PUBLIC _CRT_SECURE_NO_WARNINGS) else() @@ -30,6 +32,5 @@ endif() install(TARGETS vku DESTINATION ${CMAKE_INSTALL_LIBDIR}) set_target_properties(vku PROPERTIES LINKER_LANGUAGE CXX) include_directories(${CMAKE_CURRENT_SOURCE_DIR} - ${CMAKE_CURRENT_SOURCE_DIR}/generated - ${VulkanHeaders_INCLUDE_DIRS}) + ${CMAKE_CURRENT_SOURCE_DIR}/generated) diff --git a/vku/vk_layer_settings.cpp b/vku/vk_layer_settings.cpp index aec304827c..7e1d72575b 100644 --- a/vku/vk_layer_settings.cpp +++ b/vku/vk_layer_settings.cpp @@ -38,9 +38,6 @@ #include #include -// sdk_platform header redefines NOMINMAX -#undef NOMINMAX -#include #if defined(_WIN32) #include From 2acda7b8950d1f17d9f300f25a9273dcfc3a8001 Mon Sep 17 00:00:00 2001 From: Juan Ramos Date: Tue, 17 Jan 2023 10:26:54 -0700 Subject: [PATCH 024/154] github: Rename master to main --- .github/workflows/ci_build.yml | 3 +-- BUILD.md | 10 +++------- CONTRIBUTING.md | 2 +- README.md | 19 +++++++++++++++---- scripts/check_code_format.sh | 4 ++-- scripts/update_deps.py | 2 +- via/README.md | 2 +- vkconfig/CHANGELOG.md | 6 +++--- vkconfig/CONTRIBUTING.md | 4 ++-- vkconfig/README.md | 28 ++++++++++++++-------------- vkconfig_core/doc.cpp | 2 +- vkconfig_core/help.cpp | 4 ++-- 12 files changed, 46 insertions(+), 40 deletions(-) diff --git a/.github/workflows/ci_build.yml b/.github/workflows/ci_build.yml index 9ee7473a50..1a493f5a1d 100644 --- a/.github/workflows/ci_build.yml +++ b/.github/workflows/ci_build.yml @@ -19,12 +19,11 @@ name: CI Build -# Perform CI builds for pull requests targeting the master branch or any pushes to the repo. on: push: pull_request: branches: - - master + - main jobs: code-format: diff --git a/BUILD.md b/BUILD.md index 99e6dc21f0..af13b731d4 100644 --- a/BUILD.md +++ b/BUILD.md @@ -88,10 +88,6 @@ macOS 10.11.4 have been tested with this repo. - [CMake 3.10.2](https://cmake.org/files/v3.10/cmake-3.10.2-Darwin-x86_64.tar.gz) is recommended. Setup Homebrew and components -- Follow instructions on [brew.sh](http://brew.sh) to get homebrew installed. -``` -/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" -``` - Ensure Homebrew is at the beginning of your PATH: ``` @@ -241,9 +237,9 @@ The VulkanTools repository contains a submodule named jsoncpp. You may occasiona You will know this needs to be performed when you perform a pull, and you check the status of your tree with `git status` and something similar to the following shows: ``` -(master *)] $ git status -On branch master -Your branch is up-to-date with 'origin/master'. +(main *)] $ git status +On branch main +Your branch is up-to-date with 'origin/main'. Changes not staged for commit: (use "git add ..." to update what will be committed) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7467072a24..7f9e92a0bd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -37,7 +37,7 @@ to work on an issue that is assigned, simply coordinate with the current assigne This will involve [forking the repository](https://help.github.com/articles/fork-a-repo/), creating a branch with your commits, and then [submitting a pull request](https://help.github.com/articles/using-pull-requests/). * Please read and adhere to the style and process [guidelines ](#coding-conventions-and-formatting) enumerated below. -* Please base your fixes on the master branch. SDK branches are generally not updated except for critical fixes needed to repair an SDK release. +* Please base your fixes on the main branch. SDK branches are generally not updated except for critical fixes needed to repair an SDK release. * The resulting Pull Request will be assigned to a repository maintainer. It is the maintainer's responsibility to ensure the Pull Request passes the Google/LunarG internal CI processes. Once the Pull Request has been approved and is passing internal CI, a repository maintainer will merge the PR. diff --git a/README.md b/README.md index eab26b5857..6c88bae67a 100644 --- a/README.md +++ b/README.md @@ -11,13 +11,24 @@ VkTrace and VkReplay have been deprecated and replaced by [gfxreconstruct](https Both VkTrace and VkReplay have been removed from VulkanTools and can now be found in the [vktrace](https://github.com/LunarG/vktrace) archive. Both these tools are also no longer part of the [Vulkan SDK](https://www.lunarg.com/vulkan-sdk/). +## Default branch changed to 'main' 2023-01-17 + +The default branch of this repository is now 'main'. This change should be largely transparent to repository users, since github rewrites many references to the old 'master' branch to 'main'. However, if you have a checked-out local clone, you may wish to take the following steps as recommended by github: + +```sh +git branch -m master main +git fetch origin +git branch -u origin/main main +git remote set-head origin -a +``` + ## CI Build Status | Build Status | |:------------| -| [![Build Status](https://github.com/LunarG/VulkanTools/actions/workflows/build_windows.yml/badge.svg?branch=master)](https://github.com/LunarG/VulkanTools/actions) | -| [![Build Status](https://github.com/LunarG/VulkanTools/actions/workflows/build_linux.yml/badge.svg?branch=master)](https://github.com/LunarG/VulkanTools/actions) | -| [![Build Status](https://github.com/LunarG/VulkanTools/actions/workflows/build_linux_gn.yml/badge.svg?branch=master)](https://github.com/LunarG/VulkanTools/actions) | -| [![Build Status](https://github.com/LunarG/VulkanTools/actions/workflows/build_android.yml/badge.svg?branch=master)](https://github.com/LunarG/VulkanTools/actions) | +| [![Build Status](https://github.com/LunarG/VulkanTools/actions/workflows/build_windows.yml/badge.svg?branch=main)](https://github.com/LunarG/VulkanTools/actions) | +| [![Build Status](https://github.com/LunarG/VulkanTools/actions/workflows/build_linux.yml/badge.svg?branch=main)](https://github.com/LunarG/VulkanTools/actions) | +| [![Build Status](https://github.com/LunarG/VulkanTools/actions/workflows/build_linux_gn.yml/badge.svg?branch=main)](https://github.com/LunarG/VulkanTools/actions) | +| [![Build Status](https://github.com/LunarG/VulkanTools/actions/workflows/build_android.yml/badge.svg?branch=main)](https://github.com/LunarG/VulkanTools/actions) | ## Contributing diff --git a/scripts/check_code_format.sh b/scripts/check_code_format.sh index dde4379482..1b07cf2168 100755 --- a/scripts/check_code_format.sh +++ b/scripts/check_code_format.sh @@ -22,14 +22,14 @@ RED='\033[0;31m' GREEN='\033[0;32m' NC='\033[0m' # No Color -FILES_TO_CHECK=$(git diff --name-only master | grep -v -E "^include/vulkan" | grep -E ".*\.(cpp|cc|c\+\+|cxx|c|h|hpp)$") +FILES_TO_CHECK=$(git diff --name-only main | grep -v -E "^include/vulkan" | grep -E ".*\.(cpp|cc|c\+\+|cxx|c|h|hpp)$") if [ -z "${FILES_TO_CHECK}" ]; then echo -e "${GREEN}No source code to check for formatting.${NC}" exit 0 fi -FORMAT_DIFF=$(git diff -U0 master -- ${FILES_TO_CHECK} | python ./scripts/clang-format-diff.py -p1 -style=file) +FORMAT_DIFF=$(git diff -U0 main -- ${FILES_TO_CHECK} | python ./scripts/clang-format-diff.py -p1 -style=file) if [ -z "${FORMAT_DIFF}" ]; then echo -e "${GREEN}All source code in PR properly formatted.${NC}" diff --git a/scripts/update_deps.py b/scripts/update_deps.py index 105ef22f21..c2f7050b4a 100755 --- a/scripts/update_deps.py +++ b/scripts/update_deps.py @@ -619,7 +619,7 @@ def main(): '--ref', dest='ref', default='', - help="Override 'commit' with git reference. E.g., 'origin/master'") + help="Override 'commit' with git reference. E.g., 'origin/main'") parser.add_argument( '--no-build', dest='do_build', diff --git a/via/README.md b/via/README.md index d4659f2e6a..d19ad5a405 100644 --- a/via/README.md +++ b/via/README.md @@ -30,7 +30,7 @@ skip down to the "Running" section below. #### Building VIA in VulkanTools Because it is part of a group of tools, you build it from the top folder by -following the instructions in the [VulkanTools/BUILD.md](https://github.com/LunarG/VulkanTools/blob/master/BUILD.md) +following the instructions in the [VulkanTools/BUILD.md](https://github.com/LunarG/VulkanTools/blob/main/BUILD.md) file at the top of the source tree. #### Building VIA in the Linux Vulkan SDK diff --git a/vkconfig/CHANGELOG.md b/vkconfig/CHANGELOG.md index befa30bd97..7a0dbc6677 100644 --- a/vkconfig/CHANGELOG.md +++ b/vkconfig/CHANGELOG.md @@ -1,6 +1,6 @@

LunarG

-

Copyright 2015-2022 LunarG, Inc.

+

Copyright � 2015-2022 LunarG, Inc.

[![Creative Commons][3]][4] @@ -11,7 +11,7 @@ # Release notes -## [Vulkan Configurator 2.5.2](https://github.com/LunarG/VulkanTools/tree/master) - December 2022 +## [Vulkan Configurator 2.5.2](https://github.com/LunarG/VulkanTools/tree/main) - December 2022 ### Improvements: - Add `warn_on_robust_oob` validation layer setting handling @@ -107,7 +107,7 @@ - Add build date in the title bar ### Improvements: -- Add link to [Vulkan Guide layers](https://github.com/KhronosGroup/Vulkan-Guide/blob/master/chapters/development_tools.md#vulkan-layers) list within the help menu +- Add link to [Vulkan Guide layers](https://github.com/KhronosGroup/Vulkan-Guide/blob/main/chapters/development_tools.md#vulkan-layers) list within the help menu - Update built-in VUIDs to the list included in SDK 1.2.176 #1511 - Refactor the layer window to expose more layer documentation #1519 - Add shader caching setting to validation built-in UI #1552 diff --git a/vkconfig/CONTRIBUTING.md b/vkconfig/CONTRIBUTING.md index ac819ee85f..4fbc92b651 100644 --- a/vkconfig/CONTRIBUTING.md +++ b/vkconfig/CONTRIBUTING.md @@ -12,7 +12,7 @@ Furthermore: -------------- ## Building Vulkan Configurator -It requires *[Qt 5](https://www.qt.io/download)* to be install and *Qt* `bin` directory to be added to the `PATH` environment variable. *Vulkan Configurator* is built as part of the [VulkanTools](https://github.com/LunarG/VulkanTools/blob/master/BUILD.md) using *CMake* build system or alternatively with `vkconfig.pro` using Qt Creator. +It requires *[Qt 5](https://www.qt.io/download)* to be install and *Qt* `bin` directory to be added to the `PATH` environment variable. *Vulkan Configurator* is built as part of the [VulkanTools](https://github.com/LunarG/VulkanTools/blob/main/BUILD.md) using *CMake* build system or alternatively with `vkconfig.pro` using Qt Creator. -------------- ## How to run Vulkan Configurator Unit Tests @@ -44,7 +44,7 @@ ctest --output-on-failure --parallel 16 This will involve [forking the repository](https://help.github.com/articles/fork-a-repo/), creating a branch with your commits, and then [submitting a pull request](https://help.github.com/articles/using-pull-requests/). * Please read and adhere to the style and process [guidelines ](#coding-conventions-and-formatting) enumerated below. -* Please base your fixes on the `master` branch. SDK branches are generally not updated except for critical fixes needed to repair an SDK release. +* Please base your fixes on the `main` branch. SDK branches are generally not updated except for critical fixes needed to repair an SDK release. * The resulting Pull Request will be assigned to a repository maintainer. Once the Pull Request has been approved and is passing internal CI, a repository maintainer will merge the PR. diff --git a/vkconfig/README.md b/vkconfig/README.md index c42a58473d..7b198da715 100644 --- a/vkconfig/README.md +++ b/vkconfig/README.md @@ -9,16 +9,16 @@

-*Vulkan Configurator* allows overriding the [layers configuration](https://github.com/KhronosGroup/Vulkan-Loader/blob/master/loader/LoaderAndLayerInterface.md#layers) used by Vulkan applications at runtime. +*Vulkan Configurator* allows overriding the [layers configuration](https://github.com/KhronosGroup/Vulkan-Loader/blob/main/loader/LoaderAndLayerInterface.md#layers) used by Vulkan applications at runtime. A Vulkan application may configure layers when creating a Vulkan Instance. This layers configuration may be overridden using *Vulkan Configurator* globally or for a selected list of Vulkan applications. Finally *Vulkan Configurator* allows using layers from user-defined directories. -* **[Change Log](https://github.com/LunarG/VulkanTools/blob/master/vkconfig/CHANGELOG.md)**: The history of *Vulkan Configurator* releases. +* **[Change Log](https://github.com/LunarG/VulkanTools/blob/main/vkconfig/CHANGELOG.md)**: The history of *Vulkan Configurator* releases. * **[Bug reports](https://github.com/LunarG/VulkanTools/issues)**: Open a GitHub issue when you encounter a bug. * **[Roadmap](https://github.com/LunarG/VulkanTools/projects/2)**: Follow *Vulkan Configurator* future developments. -* **[Contributing](https://github.com/LunarG/VulkanTools/blob/master/vkconfig/CONTRIBUTING.md)**: Submit a fix or a feature to *Vulkan Configurator*. +* **[Contributing](https://github.com/LunarG/VulkanTools/blob/main/vkconfig/CONTRIBUTING.md)**: Submit a fix or a feature to *Vulkan Configurator*. -------------- ## Platforms Support @@ -46,7 +46,7 @@ The tool is distributed differently, depending on the platform: Vulkan Configurator may be used with command line arguments to averride layers. Use `vkconfig --help` in the console for more information. -![Vulkan Configurator Animated Presentation](https://github.com/LunarG/VulkanTools/blob/master/vkconfig/images/presentation.gif) +![Vulkan Configurator Animated Presentation](https://github.com/LunarG/VulkanTools/blob/main/vkconfig/images/presentation.gif) ### Selecting an Application @@ -56,7 +56,7 @@ that any changes made are not carried over when the tool exits. Because of this, VkConfig has an application launcher built in which allows you to select which application to run. -![Application Selection](https://github.com/LunarG/VulkanTools/blob/master/vkconfig/images/vkconfig_applications_collapsed.png) +![Application Selection](https://github.com/LunarG/VulkanTools/blob/main/vkconfig/images/vkconfig_applications_collapsed.png) Select between any previously-defined applications by clicking the down-facing error on the right of the application line. @@ -65,13 +65,13 @@ arguments, and even the log file can be edited. To edit these fields in-place, expand the application area by simply expanding the arrow to the left of the word "Application". -![Application Selection Expanded](https://github.com/LunarG/VulkanTools/blob/master/vkconfig/images/vkconfig_applications_expanded.png) +![Application Selection Expanded](https://github.com/LunarG/VulkanTools/blob/main/vkconfig/images/vkconfig_applications_expanded.png) To add or further edit an application in the launcher, click the 3 periods (`...`) to the far right of the application field. This will expand to an application dialog where applications can be added, edited, or removed. -![Application Dialog](https://github.com/LunarG/VulkanTools/blob/master/vkconfig/images/vkconfig_applications_dialog.png) +![Application Dialog](https://github.com/LunarG/VulkanTools/blob/main/vkconfig/images/vkconfig_applications_dialog.png) ### Applications Listed by Name @@ -94,32 +94,32 @@ arguments. -------------- ## Terminology -***[Vulkan Layer](https://github.com/KhronosGroup/Vulkan-Loader/blob/master/loader/LoaderAndLayerInterface.md#layers)***: A layer is an optional library that can intercept Vulkan functions on their way from the Vulkan application down to the Vulkan drivers. Multiple layers can be chained together to use multiple layer functionalities simultaneously. +***[Vulkan Layer](https://github.com/KhronosGroup/Vulkan-Loader/blob/main/loader/LoaderAndLayerInterface.md#layers)***: A layer is an optional library that can intercept Vulkan functions on their way from the Vulkan application down to the Vulkan drivers. Multiple layers can be chained together to use multiple layer functionalities simultaneously. ***Vulkan Layers Configuration***: A collection of Vulkan Layers executed in [a specific order](#vulkan-layers-execution-order-overview) with specific settings for each layer. -***[Vulkan Explicit Layers vs Implicit Layer](https://github.com/KhronosGroup/Vulkan-Loader/blob/master/loader/LoaderAndLayerInterface.md#implicit-vs-explicit-layers)***: An explicit layer has to be explicitly activated by the user from source in `vkCreateInstance`, using Vulkan Configurator or `VK_INSTANCE_LAYERS` environment variable. Implicit layers are enabled by their existence on the system by default. +***[Vulkan Explicit Layers vs Implicit Layer](https://github.com/KhronosGroup/Vulkan-Loader/blob/main/loader/LoaderAndLayerInterface.md#implicit-vs-explicit-layers)***: An explicit layer has to be explicitly activated by the user from source in `vkCreateInstance`, using Vulkan Configurator or `VK_INSTANCE_LAYERS` environment variable. Implicit layers are enabled by their existence on the system by default. -***[Vulkan Meta-Layer](https://github.com/KhronosGroup/Vulkan-Loader/blob/master/loader/LoaderAndLayerInterface.md#meta-layers)***: Meta-layers are a special kind of layer which is only available through the desktop [Vulkan Loader](https://github.com/KhronosGroup/Vulkan-Loader). While usual layers are associated with one particular library, a meta-layer is actually a collection layer which contains an ordered list of other layers called *component layers*. +***[Vulkan Meta-Layer](https://github.com/KhronosGroup/Vulkan-Loader/blob/main/loader/LoaderAndLayerInterface.md#meta-layers)***: Meta-layers are a special kind of layer which is only available through the desktop [Vulkan Loader](https://github.com/KhronosGroup/Vulkan-Loader). While usual layers are associated with one particular library, a meta-layer is actually a collection layer which contains an ordered list of other layers called *component layers*. ***Vulkan Override Layer***: The Vulkan Override Layer is an implicit meta-layer found on the system with the name `VK_LAYER_LUNARG_override`. It is the mechanism used by *Vulkan Configurator* to override Vulkan applications layers. This layer contains: - The ordered list of layers to activate - The list of layers to exclude from execution - The list of paths to executables that the layers override applies to. If this list is empty, the override is applied to every application upon startup. -***Vulkan Layer settings***: Per-layer settings loaded by each layer library and stored in the `vk_layer_settings.txt` file. This file is located either next to the Vulkan application executable or set globally and applied to all Vulkan applications thanks to *Vulkan Configurator*. These settings are described [here for VK_LAYER_KHRONOS_validation](https://github.com/KhronosGroup/Vulkan-ValidationLayers/blob/master/layers/vk_layer_settings.txt) and [here for other layers created by LunarG](https://github.com/LunarG/VulkanTools/blob/master/layersvt/vk_layer_settings.txt). +***Vulkan Layer settings***: Per-layer settings loaded by each layer library and stored in the `vk_layer_settings.txt` file. This file is located either next to the Vulkan application executable or set globally and applied to all Vulkan applications thanks to *Vulkan Configurator*. These settings are described [here for VK_LAYER_KHRONOS_validation](https://github.com/KhronosGroup/Vulkan-ValidationLayers/blob/main/layers/vk_layer_settings.txt) and [here for other layers created by LunarG](https://github.com/LunarG/VulkanTools/blob/main/layersvt/vk_layer_settings.txt). -------------- ## Vulkan Layers execution order overview -[ ![Vulkan Loader](https://github.com/LunarG/VulkanTools/blob/master/vkconfig/images/vulkan_layers_order_small.png) ](https://github.com/LunarG/VulkanTools/blob/master/vkconfig/images/vulkan_layers_order.png) +[ ![Vulkan Loader](https://github.com/LunarG/VulkanTools/blob/main/vkconfig/images/vulkan_layers_order_small.png) ](https://github.com/LunarG/VulkanTools/blob/main/vkconfig/images/vulkan_layers_order.png) -------------- ## Vulkan Loader and Layers implementation overview -[ ![Vulkan Loader](https://github.com/LunarG/VulkanTools/blob/master/vkconfig/images/vulkan_loader_640px.png) ](https://github.com/LunarG/VulkanTools/blob/master/vkconfig/images/vulkan_loader.png) +[ ![Vulkan Loader](https://github.com/LunarG/VulkanTools/blob/main/vkconfig/images/vulkan_loader_640px.png) ](https://github.com/LunarG/VulkanTools/blob/main/vkconfig/images/vulkan_loader.png) -For detailed information, read the [Architecture of the Vulkan Loader Interfaces](https://github.com/KhronosGroup/Vulkan-Loader/blob/master/loader/LoaderAndLayerInterface.md) document. +For detailed information, read the [Architecture of the Vulkan Loader Interfaces](https://github.com/KhronosGroup/Vulkan-Loader/blob/main/loader/LoaderAndLayerInterface.md) document. ## Vulkan Layers Settings diff --git a/vkconfig_core/doc.cpp b/vkconfig_core/doc.cpp index f8a69471dd..0dc4b049fd 100644 --- a/vkconfig_core/doc.cpp +++ b/vkconfig_core/doc.cpp @@ -121,7 +121,7 @@ static const std::string GetLayerSettingsDocURL(const Layer& layer) { return format("https://github.com/LunarG/VulkanTools/tree/sdk-%s.0/vkconfig#vulkan-layers-settings", layer.api_version.str().c_str()); } else { - return "https://github.com/LunarG/VulkanTools/tree/master/vkconfig#vulkan-layers-settings"; + return "https://github.com/LunarG/VulkanTools/tree/main/vkconfig#vulkan-layers-settings"; } } diff --git a/vkconfig_core/help.cpp b/vkconfig_core/help.cpp index fab59ed746..cbeddea984 100644 --- a/vkconfig_core/help.cpp +++ b/vkconfig_core/help.cpp @@ -45,7 +45,7 @@ void ShowDoc(DocType doc_type) { } case DOC_FIND_LAYERS: { const std::string url = - "https://github.com/KhronosGroup/Vulkan-Guide/blob/master/chapters/development_tools.adoc#vulkan-layers"; + "https://github.com/KhronosGroup/Vulkan-Guide/blob/main/chapters/development_tools.adoc#vulkan-layers"; QDesktopServices::openUrl(QUrl(url.c_str())); break; } @@ -55,7 +55,7 @@ void ShowDoc(DocType doc_type) { break; } case DOC_VKCONFIG_CHANGELOG: { - QDesktopServices::openUrl(QUrl("https://github.com/LunarG/VulkanTools/blob/master/vkconfig/CHANGELOG.md")); + QDesktopServices::openUrl(QUrl("https://github.com/LunarG/VulkanTools/blob/main/vkconfig/CHANGELOG.md")); break; } case DOC_GPU_INFO: { From c02ab0a0a8c1604fab7ba03b88ac0593bffbacaf Mon Sep 17 00:00:00 2001 From: Tony-LunarG Date: Fri, 20 Jan 2023 10:02:54 -0700 Subject: [PATCH 025/154] build: Update to 1.3.239 headers --- build-android/vulkan-headers_revision_android | 2 +- build-android/vulkan-tools_revision_android | 2 +- build-android/vulkan-validationlayers_revision_android | 2 +- scripts/known_good.json | 8 ++++---- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/build-android/vulkan-headers_revision_android b/build-android/vulkan-headers_revision_android index 2997364be3..67d338f60d 100644 --- a/build-android/vulkan-headers_revision_android +++ b/build-android/vulkan-headers_revision_android @@ -1 +1 @@ -v1.3.238 +v1.3.239 diff --git a/build-android/vulkan-tools_revision_android b/build-android/vulkan-tools_revision_android index d295ad7d3d..67d338f60d 100644 --- a/build-android/vulkan-tools_revision_android +++ b/build-android/vulkan-tools_revision_android @@ -1 +1 @@ -7b798e3e47824c94ffc6c8e75b0440bb78d2b7e2 +v1.3.239 diff --git a/build-android/vulkan-validationlayers_revision_android b/build-android/vulkan-validationlayers_revision_android index 03eec28d5a..67d338f60d 100644 --- a/build-android/vulkan-validationlayers_revision_android +++ b/build-android/vulkan-validationlayers_revision_android @@ -1 +1 @@ -92bd5a9ce36b327c9cba42e0b332b3f9cbde0f6f +v1.3.239 diff --git a/scripts/known_good.json b/scripts/known_good.json index 5c53e03f6c..a8657f4f35 100644 --- a/scripts/known_good.json +++ b/scripts/known_good.json @@ -6,7 +6,7 @@ "sub_dir" : "Vulkan-Headers", "build_dir" : "Vulkan-Headers/build", "install_dir" : "Vulkan-Headers/build/install", - "commit": "5eeb2c4c570ce92f5f48bf667e39e9d4da2ef13a" + "commit": "v1.3.239" }, { "name" : "Vulkan-Loader", @@ -14,7 +14,7 @@ "sub_dir" : "Vulkan-Loader", "build_dir" : "Vulkan-Loader/build", "install_dir" : "Vulkan-Loader/build/install", - "commit": "4e1777a8ffbb9b2e784c09a82ecdbc10875825f0", + "commit": "v1.3.239", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", @@ -35,7 +35,7 @@ "sub_dir" : "Vulkan-Tools", "build_dir" : "Vulkan-Tools/build", "install_dir" : "Vulkan-Tools/build/install", - "commit": "6ef427d3b9877395e07f0618ada16d81c95ce974", + "commit": "v1.3.239", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", @@ -60,7 +60,7 @@ "sub_dir" : "Vulkan-ValidationLayers", "build_dir" : "Vulkan-ValidationLayers/build", "install_dir" : "Vulkan-ValidationLayers/build/install", - "commit": "0ee326ed922913aeaba0cbf873db96e0245e91b4", + "commit": "v1.3.239", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", From 78108c7cefb88f7fa59ce5b3106d16305568e4ea Mon Sep 17 00:00:00 2001 From: Juan Ramos Date: Wed, 1 Feb 2023 11:18:02 -0700 Subject: [PATCH 026/154] cmake: Remove custom install code --- BUILD.md | 4 ++-- CMakeLists.txt | 14 -------------- cmake/cmake_uninstall.cmake.in | 21 --------------------- 3 files changed, 2 insertions(+), 37 deletions(-) delete mode 100644 cmake/cmake_uninstall.cmake.in diff --git a/BUILD.md b/BUILD.md index af13b731d4..6318f88a76 100644 --- a/BUILD.md +++ b/BUILD.md @@ -354,7 +354,7 @@ Visual Studio is used to build the software, and will re-run CMake as appropriat To build all Windows targets (e.g. in a "Developer Command Prompt for VS2017" window): ``` cd VulkanTools # cd to the root of the VulkanTools git repository -cmake -H. -Bdbuild -DCMAKE_BUILD_TYPE=Debug -G "Visual Studio 15 2017 Win64" -DCMAKE_INSTALL_PREFIX=build/install -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_directory -DVULKAN_LOADER_INSTALL_DIR=absolute_path_to_install_directory -DVULKAN_VALIDATIONLAYERS_INSTALL_DIR=absolute_path_to_install_directory +cmake -S . -B dbuild -DCMAKE_BUILD_TYPE=Debug -G "Visual Studio 15 2017 Win64" -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_directory -DVULKAN_LOADER_INSTALL_DIR=absolute_path_to_install_directory -DVULKAN_VALIDATIONLAYERS_INSTALL_DIR=absolute_path_to_install_directory cmake --build dbuild --config Debug --target install ``` @@ -393,7 +393,7 @@ This build process builds all items in the VulkanTools repository Example debug build: ``` cd VulkanTools # cd to the root of the VulkanTools git repository -cmake -H. -Bdbuild -DCMAKE_BUILD_TYPE=Debug -DCMAKE_INSTALL_PREFIX=build/install -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_directory -DVULKAN_LOADER_INSTALL_DIR=absolute_path_to_install_directory -DVULKAN_VALIDATIONLAYERS_INSTALL_DIR=absolute_path_to_install_directory +cmake -H. -Bdbuild -DCMAKE_BUILD_TYPE=Debug -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_directory -DVULKAN_LOADER_INSTALL_DIR=absolute_path_to_install_directory -DVULKAN_VALIDATIONLAYERS_INSTALL_DIR=absolute_path_to_install_directory cd dbuild make -j8 ``` diff --git a/CMakeLists.txt b/CMakeLists.txt index 4d4af4cb3f..2ab5e1094e 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -13,14 +13,8 @@ add_definitions(-DVK_ENABLE_BETA_EXTENSIONS) set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_CURRENT_SOURCE_DIR}/cmake") -# Define GNU standard installation directories. include(GNUInstallDirs) -# Set a better default install location for Windows only if the user did not provide one. -if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT AND WIN32) - set(CMAKE_INSTALL_PREFIX "${CMAKE_BINARY_DIR}/install" CACHE PATH "default install path" FORCE) -endif() - # Find Vulkan Headers, Loader, and ValidationLayers # Search order: # User-supplied CMAKE_PREFIX_PATH containing paths to the header and/or loader install dirs @@ -255,11 +249,3 @@ if(BUILD_LAYERMGR) add_subdirectory(vkconfig_core) add_subdirectory(vkconfig) endif() - -# uninstall target -configure_file( - "${CMAKE_CURRENT_SOURCE_DIR}/cmake/cmake_uninstall.cmake.in" - "${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake" - IMMEDIATE @ONLY) -add_custom_target(uninstall - COMMAND ${CMAKE_COMMAND} -P ${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake) diff --git a/cmake/cmake_uninstall.cmake.in b/cmake/cmake_uninstall.cmake.in deleted file mode 100644 index 2037e36539..0000000000 --- a/cmake/cmake_uninstall.cmake.in +++ /dev/null @@ -1,21 +0,0 @@ -if(NOT EXISTS "@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt") - message(FATAL_ERROR "Cannot find install manifest: @CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt") -endif(NOT EXISTS "@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt") - -file(READ "@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt" files) -string(REGEX REPLACE "\n" ";" files "${files}") -foreach(file ${files}) - message(STATUS "Uninstalling $ENV{DESTDIR}${file}") - if(IS_SYMLINK "$ENV{DESTDIR}${file}" OR EXISTS "$ENV{DESTDIR}${file}") - exec_program( - "@CMAKE_COMMAND@" ARGS "-E remove \"$ENV{DESTDIR}${file}\"" - OUTPUT_VARIABLE rm_out - RETURN_VALUE rm_retval - ) - if(NOT "${rm_retval}" STREQUAL 0) - message(FATAL_ERROR "Problem when removing $ENV{DESTDIR}${file}") - endif(NOT "${rm_retval}" STREQUAL 0) - else(IS_SYMLINK "$ENV{DESTDIR}${file}" OR EXISTS "$ENV{DESTDIR}${file}") - message(STATUS "File $ENV{DESTDIR}${file} does not exist.") - endif(IS_SYMLINK "$ENV{DESTDIR}${file}" OR EXISTS "$ENV{DESTDIR}${file}") -endforeach(file) From e6d1b532fecffdc0439abedb269a32fe90eace72 Mon Sep 17 00:00:00 2001 From: Oskar Roesler Date: Thu, 26 Jan 2023 03:59:02 +0000 Subject: [PATCH 027/154] docs: Fix type in vkconfig/README.md --- vkconfig/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vkconfig/README.md b/vkconfig/README.md index 7b198da715..eb151f7a67 100644 --- a/vkconfig/README.md +++ b/vkconfig/README.md @@ -44,7 +44,7 @@ The tool is distributed differently, depending on the platform: - Windows: The tool will be present on the start menu, in the Vulkan SDK menu. User can also invoke from a command line. - macOS: The tool is provided as an application bundle. Run it by double-clicking the bundle from a Finder window. -Vulkan Configurator may be used with command line arguments to averride layers. Use `vkconfig --help` in the console for more information. +Vulkan Configurator may be used with command line arguments to override layers. Use `vkconfig --help` in the console for more information. ![Vulkan Configurator Animated Presentation](https://github.com/LunarG/VulkanTools/blob/main/vkconfig/images/presentation.gif) From ee27e57cd2f6225dbce92f6afcf14fb139caa4e4 Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Mon, 28 Nov 2022 17:07:25 -0600 Subject: [PATCH 028/154] apidump: Fix whitespace between names & types setw() will reset back to 0 in many cases, one of which includes << This meant that call to `stream << setw();` does not apply the proper whitespace required, leading to not adding any space between the name and type. `setw() << "";` forces the correct width to be printed. --- layersvt/api_dump.h | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/layersvt/api_dump.h b/layersvt/api_dump.h index 4922f9b515..bfbebf4f39 100644 --- a/layersvt/api_dump.h +++ b/layersvt/api_dump.h @@ -441,6 +441,11 @@ class ApiDumpSettings { stream() << "[\n"; } + if (use_spaces) + stream() << std::setfill(' '); + else + stream() << std::setfill('\t'); + if (isFrameInRange(0)) { setupInterFrameOutputFormatting(0); } @@ -519,18 +524,20 @@ class ApiDumpSettings { std::ostream &formatNameType(std::ostream &stream, int indents, const char *name, const char *type) const { stream << indentation(indents) << name << ": "; - if (use_spaces) - stream << std::setfill(' ') << std::setw(name_size - (int)strlen(name) - 2); + stream << std::setw(name_size - (int)strlen(name) - 2) << ""; else - stream << std::setfill('\t') << std::setw((name_size - (int)strlen(name) - 3 + indent_size) / indent_size); + stream << std::setw((name_size - (int)strlen(name) - 3 + indent_size) / indent_size) << ""; - if (show_type && use_spaces) - stream << type << std::setfill(' ') << std::setw(type_size - (int)strlen(type)); - else if (show_type && !use_spaces) - stream << type << std::setfill('\t') << std::setw((type_size - (int)strlen(type) - 1 + indent_size) / indent_size); - - return stream << " = "; + if (show_type) { + if (use_spaces) + stream << type << std::setw(type_size - (int)strlen(type)) << " = "; + else + stream << type << std::setw((type_size - (int)strlen(type) - 1 + indent_size) / indent_size) << " = "; + } else { + stream << " = "; + } + return stream; } inline const char *indentation(int indents) const { From 86a7e2fb331b58312c93ec7e14a35b8d6751b2fb Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Fri, 18 Nov 2022 17:00:55 -0700 Subject: [PATCH 029/154] apidump: Remove variadic templates and inline Many functions had inline which did nothing. Best to remove it. Variadic templates were used to pass information into printers that didn't have the requisite information available to correctly print (or skip) fields. The solution of variadic templates is unwieldly because every function needed the template arguments even if they didn't use it. Thus it is easier to create bespoke variables in the ApiDumpInstance to store the data before calling the printing functions, then retrieve the data from the instance. This solution allows simplifying the pNext printing code to no longer need workarounds for functions which used the variadic arguments. --- layersvt/api_dump.h | 384 ++++++++++++++-------------------- scripts/api_dump_generator.py | 255 ++++++++++------------ 2 files changed, 274 insertions(+), 365 deletions(-) diff --git a/layersvt/api_dump.h b/layersvt/api_dump.h index bfbebf4f39..d300d39b1b 100644 --- a/layersvt/api_dump.h +++ b/layersvt/api_dump.h @@ -101,7 +101,7 @@ class ConditionalFrameOutput { uint32_t length; }; - inline NumberToken parseNumber(std::string str, uint32_t current_char) { + NumberToken parseNumber(std::string str, uint32_t current_char) { uint32_t length = 0; while (current_char + length < str.size() && str[current_char + length] >= '0' && str[current_char + length] <= '9') { length++; @@ -114,7 +114,7 @@ class ConditionalFrameOutput { } } - inline void printErrorMsg(const char *msg) { + void printErrorMsg(const char *msg) { #ifdef ANDROID __android_log_print(ANDROID_LOG_DEBUG, "api_dump", "%s", msg); #else @@ -520,7 +520,7 @@ class ApiDumpSettings { } } - inline ApiDumpFormat format() const { return output_format; } + ApiDumpFormat format() const { return output_format; } std::ostream &formatNameType(std::ostream &stream, int indents, const char *name, const char *type) const { stream << indentation(indents) << name << ": "; @@ -550,36 +550,36 @@ class ApiDumpSettings { } } - inline bool shouldFlush() const { return should_flush; } + bool shouldFlush() const { return should_flush; } - inline bool showAddress() const { return show_address; } + bool showAddress() const { return show_address; } - inline bool showParams() const { return show_params; } + bool showParams() const { return show_params; } - inline bool showShader() const { return show_shader; } + bool showShader() const { return show_shader; } - inline bool showType() const { return show_type; } + bool showType() const { return show_type; } - inline bool showTimestamp() const { return show_timestamp; } + bool showTimestamp() const { return show_timestamp; } - inline bool showThreadAndFrame() const { return show_thread_and_frame; } + bool showThreadAndFrame() const { return show_thread_and_frame; } - inline std::ostream &stream() const { return use_cout ? std::cout : *(std::ofstream *)&output_stream; } + std::ostream &stream() const { return use_cout ? std::cout : *(std::ofstream *)&output_stream; } - inline std::string directory() const { return output_dir; } + std::string directory() const { return output_dir; } - inline bool isFrameInRange(uint64_t frame) const { return condFrameOutput.isFrameInRange(frame); } + bool isFrameInRange(uint64_t frame) const { return condFrameOutput.isFrameInRange(frame); } private: // Utility member to enable easier comparison by forcing a string to all lower-case - inline static std::string ToLowerString(const std::string &value) { + static std::string ToLowerString(const std::string &value) { std::string lower_value = value; std::transform(lower_value.begin(), lower_value.end(), lower_value.begin(), ::tolower); return lower_value; } // Utility member for getting a platform environment variable on various platforms. - inline std::string GetPlatformEnvVar(const std::string &var) { + std::string GetPlatformEnvVar(const std::string &var) { std::string ret_string = ""; #ifdef _WIN32 char temp[MAX_STRING_LENGTH]; @@ -618,14 +618,14 @@ class ApiDumpSettings { } // Utility member to convert from string to a boolean - inline bool GetStringBooleanValue(const std::string &value) { + bool GetStringBooleanValue(const std::string &value) { if (ToLowerString(value) == "true") { return true; } return false; } - inline static bool readBoolOption(const char *option, bool default_value) { + static bool readBoolOption(const char *option, bool default_value) { const char *string_option = getLayerOption(option); if (string_option == NULL) return default_value; std::string lowered_option = ToLowerString(std::string(string_option)); @@ -637,7 +637,7 @@ class ApiDumpSettings { return default_value; } - inline static int readIntOption(const char *option, int default_value) { + static int readIntOption(const char *option, int default_value) { const char *string_option = getLayerOption(option); int value; if (sscanf(string_option, "%d", &value) != 1) { @@ -647,7 +647,7 @@ class ApiDumpSettings { } } - inline static ApiDumpFormat readFormatOption(const char *option, ApiDumpFormat default_value) { + static ApiDumpFormat readFormatOption(const char *option, ApiDumpFormat default_value) { const char *string_option = getLayerOption(option); std::string lowered_option = ToLowerString(std::string(string_option)); if (lowered_option == "text") @@ -683,11 +683,16 @@ class ApiDumpSettings { class ApiDumpInstance { public: - inline ApiDumpInstance() : dump_settings(NULL), frame_count(0), thread_count(0) { + ApiDumpInstance() noexcept : dump_settings(NULL), frame_count(0), thread_count(0) { program_start = std::chrono::system_clock::now(); } + // Can't copy or move this type + ApiDumpInstance(const ApiDumpInstance &) = delete; + ApiDumpInstance &operator=(const ApiDumpInstance &) = delete; + ApiDumpInstance(ApiDumpInstance &&) = delete; + ApiDumpInstance &operator=(ApiDumpInstance &&) = delete; - inline ~ApiDumpInstance() { + ~ApiDumpInstance() { if (!dump_settings) return; if (!first_func_call_on_frame) settings().closeFrameOutput(); @@ -695,13 +700,13 @@ class ApiDumpInstance { delete dump_settings; } - inline uint64_t frameCount() { + uint64_t frameCount() { std::lock_guard lg(frame_mutex); uint64_t count = frame_count; return count; } - inline void nextFrame() { + void nextFrame() { std::lock_guard lg(frame_mutex); ++frame_count; @@ -710,7 +715,7 @@ class ApiDumpInstance { first_func_call_on_frame = true; } - inline bool shouldDumpOutput() { + bool shouldDumpOutput() { if (!conditional_initialized) { should_dump_output = settings().isFrameInRange(frame_count); conditional_initialized = true; @@ -718,7 +723,7 @@ class ApiDumpInstance { return should_dump_output; } - inline bool firstFunctionCallOnFrame() { + bool firstFunctionCallOnFrame() { if (first_func_call_on_frame) { first_func_call_on_frame = false; return true; @@ -726,9 +731,9 @@ class ApiDumpInstance { return false; } - inline std::recursive_mutex *outputMutex() { return &output_mutex; } + std::recursive_mutex *outputMutex() { return &output_mutex; } - inline const ApiDumpSettings &settings() { + const ApiDumpSettings &settings() { if (dump_settings == NULL) dump_settings = new ApiDumpSettings(); return *dump_settings; @@ -753,7 +758,9 @@ class ApiDumpInstance { return new_index; } - inline VkCommandBufferLevel getCmdBufferLevel(VkCommandBuffer cmd_buffer) { + void setCmdBuffer(VkCommandBuffer cmd_buffer) { this->cmd_buffer = cmd_buffer; } + + VkCommandBufferLevel getCmdBufferLevel() { std::lock_guard lg(cmd_buffer_state_mutex); const auto level_iter = cmd_buffer_level.find(cmd_buffer); assert(level_iter != cmd_buffer_level.end()); @@ -761,7 +768,7 @@ class ApiDumpInstance { return level; } - inline void eraseCmdBuffers(VkDevice device, VkCommandPool cmd_pool, std::vector cmd_buffers) { + void eraseCmdBuffers(VkDevice device, VkCommandPool cmd_pool, std::vector cmd_buffers) { cmd_buffers.erase(std::remove(cmd_buffers.begin(), cmd_buffers.end(), nullptr), cmd_buffers.end()); if (!cmd_buffers.empty()) { std::lock_guard lg(cmd_buffer_state_mutex); @@ -778,8 +785,8 @@ class ApiDumpInstance { } } - inline void addCmdBuffers(VkDevice device, VkCommandPool cmd_pool, std::vector cmd_buffers, - VkCommandBufferLevel level) { + void addCmdBuffers(VkDevice device, VkCommandPool cmd_pool, std::vector cmd_buffers, + VkCommandBufferLevel level) { std::lock_guard lg(cmd_buffer_state_mutex); auto &pool_cmd_buffers = cmd_buffer_pools[std::make_pair(device, cmd_pool)]; pool_cmd_buffers.insert(cmd_buffers.begin(), cmd_buffers.end()); @@ -790,7 +797,7 @@ class ApiDumpInstance { } } - inline void eraseCmdBufferPool(VkDevice device, VkCommandPool cmd_pool) { + void eraseCmdBufferPool(VkDevice device, VkCommandPool cmd_pool) { if (cmd_pool != VK_NULL_HANDLE) { std::lock_guard lg(cmd_buffer_state_mutex); @@ -805,12 +812,17 @@ class ApiDumpInstance { } } - inline std::chrono::microseconds current_time_since_start() { + void setIsDynamicScissor(bool is_dynamic_scissor) { this->is_dynamic_scissor = is_dynamic_scissor; } + void setIsDynamicViewport(bool is_dynamic_viewport) { this->is_dynamic_viewport = is_dynamic_viewport; } + bool getIsDynamicScissor() const { return is_dynamic_scissor; } + bool getIsDynamicViewport() const { return is_dynamic_viewport; } + + std::chrono::microseconds current_time_since_start() { std::chrono::system_clock::time_point now = std::chrono::system_clock::now(); return std::chrono::duration_cast(now - program_start); } - static inline ApiDumpInstance ¤t() { return current_instance; } + static ApiDumpInstance ¤t() { return current_instance; } std::unordered_map object_name_map; @@ -847,6 +859,15 @@ class ApiDumpInstance { // Store the VkInstance handle so we don't use null in the call to // vkGetInstanceProcAddr(instance_handle, "vkCreateDevice"); std::unordered_map vk_instance_map; + + // Storage for getCmdBufferLevel() which is called in a place where it needs access to the cmd_buffer but it isn't present in + // the current structure. + VkCommandBuffer cmd_buffer; + + // Storage for VkPipelineViewportStateCreateInfo which needs to ignore the scissor and viewport pipeline state if their + // respective dynamic state is set. + bool is_dynamic_scissor; + bool is_dynamic_viewport; }; // Utility to output an address. @@ -868,10 +889,9 @@ ApiDumpInstance ApiDumpInstance::current_instance; //==================================== Text Backend Helpers ======================================// -template -inline void dump_text_array(const T *array, size_t len, const ApiDumpSettings &settings, const char *type_string, - const char *child_type, const char *name, int indents, - std::ostream &(*dump)(const T, const ApiDumpSettings &, int, Args... args), Args... args) { +template +void dump_text_array(const T *array, size_t len, const ApiDumpSettings &settings, const char *type_string, const char *child_type, + const char *name, int indents, std::ostream &(*dump)(const T, const ApiDumpSettings &, int)) { settings.formatNameType(settings.stream(), indents, name, type_string); if (array == NULL) { settings.stream() << "NULL\n"; @@ -883,14 +903,13 @@ inline void dump_text_array(const T *array, size_t len, const ApiDumpSettings &s std::stringstream stream; stream << name << '[' << i << ']'; std::string indexName = stream.str(); - dump_text_value(array[i], settings, child_type, indexName.c_str(), indents + 1, dump, args...); + dump_text_value(array[i], settings, child_type, indexName.c_str(), indents + 1, dump); } } -template -inline void dump_text_array(const T *array, size_t len, const ApiDumpSettings &settings, const char *type_string, - const char *child_type, const char *name, int indents, - std::ostream &(*dump)(const T &, const ApiDumpSettings &, int, Args... args), Args... args) { +template +void dump_text_array(const T *array, size_t len, const ApiDumpSettings &settings, const char *type_string, const char *child_type, + const char *name, int indents, std::ostream &(*dump)(const T &, const ApiDumpSettings &, int)) { settings.formatNameType(settings.stream(), indents, name, type_string); if (array == NULL) { settings.stream() << "NULL\n"; @@ -902,124 +921,52 @@ inline void dump_text_array(const T *array, size_t len, const ApiDumpSettings &s std::stringstream stream; stream << name << '[' << i << ']'; std::string indexName = stream.str(); - dump_text_value(array[i], settings, child_type, indexName.c_str(), indents + 1, dump, args...); - } -} - -template -inline void dump_text_array_hex(const uint32_t *array, size_t len, const ApiDumpSettings &settings, const char *type_string, - const char *child_type, const char *name, int indents, - std::ostream &(*dump)(const T, const ApiDumpSettings &, int, Args... args), Args... args) { - settings.formatNameType(settings.stream(), indents, name, type_string); - if (array == NULL) { - settings.stream() << "NULL\n"; - return; - } - OutputAddress(settings, array, false); - std::stringstream stream; - const uint8_t *arraybyte = reinterpret_cast(array); - for (size_t i = 0; i < (len * 4) && array != NULL; ++i) { - stream << std::hex << std::setw(2) << std::setfill('0') << (int)arraybyte[i] << " "; - if (i % 32 == 31) { - stream << "\n"; - } - } - - if (settings.stream().rdbuf() == std::cout.rdbuf()) { - settings.stream() << "\n" << stream.str() << "\n"; - } else { - static uint64_t shaderDumpIndex = 0; - std::stringstream shaderDumpFileName; - shaderDumpFileName << settings.directory() << "shader_" << shaderDumpIndex << ".hex"; - settings.stream() << " (" << shaderDumpFileName.str() << ")\n"; - ++shaderDumpIndex; - std::ofstream shaderDumpFile; - shaderDumpFile.open(shaderDumpFileName.str(), std::ofstream::out | std::ostream::trunc); - shaderDumpFile << stream.str() << "\n"; - shaderDumpFile.close(); - } -} - -template -inline void dump_text_array_hex(const uint32_t *array, size_t len, const ApiDumpSettings &settings, const char *type_string, - const char *child_type, const char *name, int indents, - std::ostream &(*dump)(const T &, const ApiDumpSettings &, int, Args... args), Args... args) { - settings.formatNameType(settings.stream(), indents, name, type_string); - if (array == NULL) { - settings.stream() << "NULL\n"; - return; - } - OutputAddress(settings, array, false); - std::stringstream stream; - const uint8_t *arraybyte = reinterpret_cast(array); - for (size_t i = 0; i < (len * 4) && array != NULL; ++i) { - stream << std::hex << std::setw(2) << std::setfill('0') << (int)arraybyte[i] << " "; - if (i % 32 == 31) { - stream << "\n"; - } - } - - if (settings.stream().rdbuf() == std::cout.rdbuf()) { - settings.stream() << "\n" << stream.str() << "\n"; - } else { - static uint64_t shaderDumpIndex = 0; - std::stringstream shaderDumpFileName; - shaderDumpFileName << settings.directory() << "shader_" << shaderDumpIndex << ".hex"; - settings.stream() << " (" << shaderDumpFileName.str() << ")\n"; - ++shaderDumpIndex; - std::ofstream shaderDumpFile; - shaderDumpFile.open(shaderDumpFileName.str(), std::ofstream::out | std::ostream::trunc); - shaderDumpFile << stream.str() << "\n"; - shaderDumpFile.close(); + dump_text_value(array[i], settings, child_type, indexName.c_str(), indents + 1, dump); } } -template -inline void dump_text_pointer(const T *pointer, const ApiDumpSettings &settings, const char *type_string, const char *name, - int indents, std::ostream &(*dump)(const T, const ApiDumpSettings &, int, Args... args), - Args... args) { +template +void dump_text_pointer(const T *pointer, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents, + std::ostream &(*dump)(const T, const ApiDumpSettings &, int)) { if (pointer == NULL) { settings.formatNameType(settings.stream(), indents, name, type_string); settings.stream() << "NULL\n"; } else { - dump_text_value(*pointer, settings, type_string, name, indents, dump, args...); + dump_text_value(*pointer, settings, type_string, name, indents, dump); } } -template -inline void dump_text_pointer(const T *pointer, const ApiDumpSettings &settings, const char *type_string, const char *name, - int indents, std::ostream &(*dump)(const T &, const ApiDumpSettings &, int, Args... args), - Args... args) { +template +void dump_text_pointer(const T *pointer, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents, + std::ostream &(*dump)(const T &, const ApiDumpSettings &, int)) { if (pointer == NULL) { settings.formatNameType(settings.stream(), indents, name, type_string); settings.stream() << "NULL\n"; } else { - dump_text_value(*pointer, settings, type_string, name, indents, dump, args...); + dump_text_value(*pointer, settings, type_string, name, indents, dump); } } -template -inline void dump_text_value(const T object, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents, - std::ostream &(*dump)(const T, const ApiDumpSettings &, int, Args... args), Args... args) { +template +void dump_text_value(const T object, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents, + std::ostream &(*dump)(const T, const ApiDumpSettings &, int)) { settings.formatNameType(settings.stream(), indents, name, type_string); - dump(object, settings, indents, args...) << "\n"; + dump(object, settings, indents) << "\n"; } -template -inline void dump_text_value(const T &object, const ApiDumpSettings &settings, const char *type_string, const char *name, - int indents, std::ostream &(*dump)(const T &, const ApiDumpSettings &, int, Args... args), - Args... args) { +template +void dump_text_value(const T &object, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents, + std::ostream &(*dump)(const T &, const ApiDumpSettings &, int)) { settings.formatNameType(settings.stream(), indents, name, type_string); - dump(object, settings, indents, args...); + dump(object, settings, indents); } -inline void dump_text_special(const char *text, const ApiDumpSettings &settings, const char *type_string, const char *name, - int indents) { +void dump_text_special(const char *text, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents) { settings.formatNameType(settings.stream(), indents, name, type_string); settings.stream() << text << "\n"; } -inline bool dump_text_bitmaskOption(const std::string &option, std::ostream &stream, bool isFirst) { +bool dump_text_bitmaskOption(const std::string &option, std::ostream &stream, bool isFirst) { if (isFirst) stream << " ("; else @@ -1028,36 +975,36 @@ inline bool dump_text_bitmaskOption(const std::string &option, std::ostream &str return false; } -inline std::ostream &dump_text_cstring(const char *object, const ApiDumpSettings &settings, int indents) { +std::ostream &dump_text_cstring(const char *object, const ApiDumpSettings &settings, int indents) { if (object == NULL) return settings.stream() << "NULL"; else return settings.stream() << "\"" << object << "\""; } -inline std::ostream &dump_text_void(const void *object, const ApiDumpSettings &settings, int indents) { +std::ostream &dump_text_void(const void *object, const ApiDumpSettings &settings, int indents) { if (object == NULL) return settings.stream() << "NULL"; OutputAddress(settings, object, false); return settings.stream(); } -inline std::ostream &dump_text_int(int object, const ApiDumpSettings &settings, int indents) { return settings.stream() << object; } +std::ostream &dump_text_int(int object, const ApiDumpSettings &settings, int indents) { return settings.stream() << object; } -template -inline void dump_text_pNext(const T *object, const ApiDumpSettings &settings, const char *type_string, int indents, - std::ostream &(*dump)(const T &, const ApiDumpSettings &, int, Args... args), Args... args) { +template +void dump_text_pNext(const T *object, const ApiDumpSettings &settings, const char *type_string, int indents, + std::ostream &(*dump)(const T &, const ApiDumpSettings &, int)) { if (object == NULL) settings.stream() << "NULL"; else if (settings.showAddress()) { settings.formatNameType(settings.stream(), indents, "pNext", type_string); - dump(*object, settings, indents, args...); + dump(*object, settings, indents); } else settings.stream() << "address"; } //==================================== Html Backend Helpers ======================================// -inline std::ostream &dump_html_nametype(std::ostream &stream, bool showType, const char *name, const char *type) { +std::ostream &dump_html_nametype(std::ostream &stream, bool showType, const char *name, const char *type) { stream << "
" << name << "
"; if (showType) { stream << "
" << type << "
"; @@ -1065,10 +1012,9 @@ inline std::ostream &dump_html_nametype(std::ostream &stream, bool showType, con return stream; } -template -inline void dump_html_array(const T *array, size_t len, const ApiDumpSettings &settings, const char *type_string, - const char *child_type, const char *name, int indents, - std::ostream &(*dump)(const T, const ApiDumpSettings &, int, Args... args), Args... args) { +template +void dump_html_array(const T *array, size_t len, const ApiDumpSettings &settings, const char *type_string, const char *child_type, + const char *name, int indents, std::ostream &(*dump)(const T, const ApiDumpSettings &, int)) { if (array == NULL) { settings.stream() << "
"; dump_html_nametype(settings.stream(), settings.showType(), name, type_string); @@ -1086,15 +1032,14 @@ inline void dump_html_array(const T *array, size_t len, const ApiDumpSettings &s std::stringstream stream; stream << name << '[' << i << ']'; std::string indexName = stream.str(); - dump_html_value(array[i], settings, child_type, indexName.c_str(), indents + 1, dump, args...); + dump_html_value(array[i], settings, child_type, indexName.c_str(), indents + 1, dump); } settings.stream() << "
"; } -template -inline void dump_html_array(const T *array, size_t len, const ApiDumpSettings &settings, const char *type_string, - const char *child_type, const char *name, int indents, - std::ostream &(*dump)(const T &, const ApiDumpSettings &, int, Args... args), Args... args) { +template +void dump_html_array(const T *array, size_t len, const ApiDumpSettings &settings, const char *type_string, const char *child_type, + const char *name, int indents, std::ostream &(*dump)(const T &, const ApiDumpSettings &, int)) { if (array == NULL) { settings.stream() << "
"; dump_html_nametype(settings.stream(), settings.showType(), name, type_string); @@ -1112,64 +1057,60 @@ inline void dump_html_array(const T *array, size_t len, const ApiDumpSettings &s std::stringstream stream; stream << name << '[' << i << ']'; std::string indexName = stream.str(); - dump_html_value(array[i], settings, child_type, indexName.c_str(), indents + 1, dump, args...); + dump_html_value(array[i], settings, child_type, indexName.c_str(), indents + 1, dump); } settings.stream() << "
"; } -template -inline void dump_html_pointer(const T *pointer, const ApiDumpSettings &settings, const char *type_string, const char *name, - int indents, std::ostream &(*dump)(const T, const ApiDumpSettings &, int, Args... args), - Args... args) { +template +void dump_html_pointer(const T *pointer, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents, + std::ostream &(*dump)(const T, const ApiDumpSettings &, int)) { if (pointer == NULL) { settings.stream() << "
"; dump_html_nametype(settings.stream(), settings.showType(), name, type_string); settings.stream() << "
NULL
"; } else { - dump_html_value(*pointer, settings, type_string, name, indents, dump, args...); + dump_html_value(*pointer, settings, type_string, name, indents, dump); } } -template -inline void dump_html_pointer(const T *pointer, const ApiDumpSettings &settings, const char *type_string, const char *name, - int indents, std::ostream &(*dump)(const T &, const ApiDumpSettings &, int, Args... args), - Args... args) { +template +void dump_html_pointer(const T *pointer, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents, + std::ostream &(*dump)(const T &, const ApiDumpSettings &, int)) { if (pointer == NULL) { settings.stream() << "
"; dump_html_nametype(settings.stream(), settings.showType(), name, type_string); settings.stream() << "
NULL
"; } else { - dump_html_value(*pointer, settings, type_string, name, indents, dump, args...); + dump_html_value(*pointer, settings, type_string, name, indents, dump); } } -template -inline void dump_html_value(const T object, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents, - std::ostream &(*dump)(const T, const ApiDumpSettings &, int, Args... args), Args... args) { +template +void dump_html_value(const T object, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents, + std::ostream &(*dump)(const T, const ApiDumpSettings &, int)) { settings.stream() << "
"; dump_html_nametype(settings.stream(), settings.showType(), name, type_string); - dump(object, settings, indents, args...); + dump(object, settings, indents); settings.stream() << "
"; } -template -inline void dump_html_value(const T &object, const ApiDumpSettings &settings, const char *type_string, const char *name, - int indents, std::ostream &(*dump)(const T &, const ApiDumpSettings &, int, Args... args), - Args... args) { +template +void dump_html_value(const T &object, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents, + std::ostream &(*dump)(const T &, const ApiDumpSettings &, int)) { settings.stream() << "
"; dump_html_nametype(settings.stream(), settings.showType(), name, type_string); - dump(object, settings, indents, args...); + dump(object, settings, indents); settings.stream() << "
"; } -inline void dump_html_special(const char *text, const ApiDumpSettings &settings, const char *type_string, const char *name, - int indents) { +void dump_html_special(const char *text, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents) { settings.stream() << "
"; dump_html_nametype(settings.stream(), settings.showType(), name, type_string); settings.stream() << "
" << text << "
"; } -inline bool dump_html_bitmaskOption(const std::string &option, std::ostream &stream, bool isFirst) { +bool dump_html_bitmaskOption(const std::string &option, std::ostream &stream, bool isFirst) { if (isFirst) stream << " ("; else @@ -1178,7 +1119,7 @@ inline bool dump_html_bitmaskOption(const std::string &option, std::ostream &str return false; } -inline std::ostream &dump_html_cstring(const char *object, const ApiDumpSettings &settings, int indents) { +std::ostream &dump_html_cstring(const char *object, const ApiDumpSettings &settings, int indents) { settings.stream() << "
"; if (object == NULL) settings.stream() << "NULL"; @@ -1187,36 +1128,35 @@ inline std::ostream &dump_html_cstring(const char *object, const ApiDumpSettings return settings.stream() << "
"; } -inline std::ostream &dump_html_void(const void *object, const ApiDumpSettings &settings, int indents) { +std::ostream &dump_html_void(const void *object, const ApiDumpSettings &settings, int indents) { settings.stream() << "
"; OutputAddress(settings, object, false); return settings.stream() << "
"; } -inline std::ostream &dump_html_int(int object, const ApiDumpSettings &settings, int indents) { +std::ostream &dump_html_int(int object, const ApiDumpSettings &settings, int indents) { settings.stream() << "
"; settings.stream() << object; return settings.stream() << "
"; } -template -inline void dump_html_pNext(const T *object, const ApiDumpSettings &settings, const char *type_string, int indents, - std::ostream &(*dump)(const T &, const ApiDumpSettings &, int, Args... args), Args... args) { +template +void dump_html_pNext(const T *object, const ApiDumpSettings &settings, const char *type_string, int indents, + std::ostream &(*dump)(const T &, const ApiDumpSettings &, int)) { if (object == NULL) { settings.stream() << "
"; dump_html_nametype(settings.stream(), settings.showType(), "pNext", type_string); settings.stream() << "
NULL
"; } else { - dump_html_value(*object, settings, type_string, "pNext", indents, dump, args...); + dump_html_value(*object, settings, type_string, "pNext", indents, dump); } } //==================================== Json Backend Helpers ======================================// -template -inline void dump_json_array(const T *array, size_t len, const ApiDumpSettings &settings, const char *type_string, - const char *child_type, const char *name, int indents, - std::ostream &(*dump)(const T, const ApiDumpSettings &, int, Args... args), Args... args) { +template +void dump_json_array(const T *array, size_t len, const ApiDumpSettings &settings, const char *type_string, const char *child_type, + const char *name, int indents, std::ostream &(*dump)(const T, const ApiDumpSettings &, int)) { if (len == 0 || array == NULL) { settings.stream() << settings.indentation(indents) << "{\n"; settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << "\",\n"; @@ -1241,7 +1181,7 @@ inline void dump_json_array(const T *array, size_t len, const ApiDumpSettings &s std::stringstream stream; stream << "[" << i << "]"; std::string indexName = stream.str(); - dump_json_value(array[i], &array[i], settings, child_type, indexName.c_str(), indents + 2, dump, args...); + dump_json_value(array[i], &array[i], settings, child_type, indexName.c_str(), indents + 2, dump); if (i < len - 1) settings.stream() << ','; settings.stream() << "\n"; } @@ -1250,10 +1190,9 @@ inline void dump_json_array(const T *array, size_t len, const ApiDumpSettings &s settings.stream() << "\n" << settings.indentation(indents) << "}"; } -template -inline void dump_json_array(const T *array, size_t len, const ApiDumpSettings &settings, const char *type_string, - const char *child_type, const char *name, int indents, - std::ostream &(*dump)(const T &, const ApiDumpSettings &, int, Args... args), Args... args) { +template +void dump_json_array(const T *array, size_t len, const ApiDumpSettings &settings, const char *type_string, const char *child_type, + const char *name, int indents, std::ostream &(*dump)(const T &, const ApiDumpSettings &, int)) { if (len == 0 || array == NULL) { settings.stream() << settings.indentation(indents) << "{\n"; settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << "\",\n"; @@ -1277,7 +1216,7 @@ inline void dump_json_array(const T *array, size_t len, const ApiDumpSettings &s std::stringstream stream; stream << "[" << i << "]"; std::string indexName = stream.str(); - dump_json_value(array[i], &array[i], settings, child_type, indexName.c_str(), indents + 2, dump, args...); + dump_json_value(array[i], &array[i], settings, child_type, indexName.c_str(), indents + 2, dump); if (i < len - 1) settings.stream() << ','; settings.stream() << "\n"; } @@ -1286,10 +1225,9 @@ inline void dump_json_array(const T *array, size_t len, const ApiDumpSettings &s settings.stream() << "\n" << settings.indentation(indents) << "}"; } -template -inline void dump_json_pointer(const T *pointer, const ApiDumpSettings &settings, const char *type_string, const char *name, - int indents, std::ostream &(*dump)(const T, const ApiDumpSettings &, int, Args... args), - Args... args) { +template +void dump_json_pointer(const T *pointer, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents, + std::ostream &(*dump)(const T, const ApiDumpSettings &, int)) { if (pointer == NULL) { settings.stream() << settings.indentation(indents) << "{\n"; settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << "\",\n"; @@ -1299,14 +1237,13 @@ inline void dump_json_pointer(const T *pointer, const ApiDumpSettings &settings, settings.stream() << "\n"; settings.stream() << settings.indentation(indents) << "}"; } else { - dump_json_value(*pointer, pointer, settings, type_string, name, indents, dump, args...); + dump_json_value(*pointer, pointer, settings, type_string, name, indents, dump); } } -template -inline void dump_json_pointer(const T *pointer, const ApiDumpSettings &settings, const char *type_string, const char *name, - int indents, std::ostream &(*dump)(const T &, const ApiDumpSettings &, int, Args... args), - Args... args) { +template +void dump_json_pointer(const T *pointer, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents, + std::ostream &(*dump)(const T &, const ApiDumpSettings &, int)) { if (pointer == NULL) { settings.stream() << settings.indentation(indents) << "{\n"; settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << "\",\n"; @@ -1316,17 +1253,16 @@ inline void dump_json_pointer(const T *pointer, const ApiDumpSettings &settings, settings.stream() << "\n"; settings.stream() << settings.indentation(indents) << "}"; } else { - dump_json_value(*pointer, pointer, settings, type_string, name, indents, dump, args...); + dump_json_value(*pointer, pointer, settings, type_string, name, indents, dump); } } extern bool is_union(const char *t); extern bool is_struct(const char *t); -template -inline void dump_json_value(const T object, const void *pObject, const ApiDumpSettings &settings, const char *type_string, - const char *name, int indents, - std::ostream &(*dump)(const T, const ApiDumpSettings &, int, Args... args), Args... args) { +template +void dump_json_value(const T object, const void *pObject, const ApiDumpSettings &settings, const char *type_string, + const char *name, int indents, std::ostream &(*dump)(const T, const ApiDumpSettings &, int)) { bool isPnext = !strcmp(name, "pNext") | !strcmp(name, "pUserData"); const char *star = (isPnext && !strstr(type_string, "void")) ? "*" : ""; settings.stream() << settings.indentation(indents) << "{\n"; @@ -1346,16 +1282,15 @@ inline void dump_json_value(const T object, const void *pObject, const ApiDumpSe settings.stream() << settings.indentation(indents + 1) << "\"members\" :\n"; else settings.stream() << settings.indentation(indents + 1) << "\"value\" : "; - dump(object, settings, indents + 1, args...); + dump(object, settings, indents + 1); } settings.stream() << "\n"; settings.stream() << settings.indentation(indents) << "}"; } -template -inline void dump_json_value(const T &object, const void *pObject, const ApiDumpSettings &settings, const char *type_string, - const char *name, int indents, - std::ostream &(*dump)(const T &, const ApiDumpSettings &, int, Args... args), Args... args) { +template +void dump_json_value(const T &object, const void *pObject, const ApiDumpSettings &settings, const char *type_string, + const char *name, int indents, std::ostream &(*dump)(const T &, const ApiDumpSettings &, int)) { bool isPnext = !strcmp(name, "pNext") | !strcmp(name, "pUserData"); const char *star = (isPnext && !strstr(type_string, "void")) ? "*" : ""; settings.stream() << settings.indentation(indents) << "{\n"; @@ -1375,14 +1310,13 @@ inline void dump_json_value(const T &object, const void *pObject, const ApiDumpS settings.stream() << settings.indentation(indents + 1) << "\"members\" :\n"; else settings.stream() << settings.indentation(indents + 1) << "\"value\" : "; - dump(object, settings, indents + 1, args...); + dump(object, settings, indents + 1); } settings.stream() << "\n"; settings.stream() << settings.indentation(indents) << "}"; } -inline void dump_json_special(const char *text, const ApiDumpSettings &settings, const char *type_string, const char *name, - int indents) { +void dump_json_special(const char *text, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents) { settings.stream() << settings.indentation(indents) << "{\n"; settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << "\",\n"; settings.stream() << settings.indentation(indents + 1) << "\"name\" : \"" << name << "\",\n"; @@ -1394,7 +1328,7 @@ inline void dump_json_special(const char *text, const ApiDumpSettings &settings, settings.stream() << settings.indentation(indents) << "}"; } -inline bool dump_json_bitmaskOption(const std::string &option, std::ostream &stream, bool isFirst) { +bool dump_json_bitmaskOption(const std::string &option, std::ostream &stream, bool isFirst) { if (isFirst) stream << "("; else @@ -1403,7 +1337,7 @@ inline bool dump_json_bitmaskOption(const std::string &option, std::ostream &str return false; } -inline std::ostream &dump_json_cstring(const char *object, const ApiDumpSettings &settings, int indents) { +std::ostream &dump_json_cstring(const char *object, const ApiDumpSettings &settings, int indents) { if (object == NULL) settings.stream() << "\"\""; else @@ -1411,21 +1345,21 @@ inline std::ostream &dump_json_cstring(const char *object, const ApiDumpSettings return settings.stream(); } -inline std::ostream &dump_json_void(const void *object, const ApiDumpSettings &settings, int indents) { +std::ostream &dump_json_void(const void *object, const ApiDumpSettings &settings, int indents) { OutputAddress(settings, object, true); settings.stream() << "\n"; return settings.stream(); } -inline std::ostream &dump_json_int(int object, const ApiDumpSettings &settings, int indents) { +std::ostream &dump_json_int(int object, const ApiDumpSettings &settings, int indents) { settings.stream() << settings.indentation(indents) << "\"value\" : "; settings.stream() << '"' << object << "\""; return settings.stream(); } -template -inline void dump_json_pNext(const T *object, const ApiDumpSettings &settings, const char *type_string, int indents, - std::ostream &(*dump)(const T, const ApiDumpSettings &, int, Args... args), Args... args) { +template +void dump_json_pNext(const T *object, const ApiDumpSettings &settings, const char *type_string, int indents, + std::ostream &(*dump)(const T, const ApiDumpSettings &, int)) { if (object == NULL) { settings.stream() << settings.indentation(indents) << "{\n"; settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << "*\",\n"; @@ -1437,13 +1371,13 @@ inline void dump_json_pNext(const T *object, const ApiDumpSettings &settings, co settings.stream() << ",\n"; settings.stream() << settings.indentation(indents) << "}"; } else { - dump_json_value(*object, object, settings, type_string, "pNext", indents, dump, args...); + dump_json_value(*object, object, settings, type_string, "pNext", indents, dump); } } -template -inline void dump_json_pNext(const T *object, const ApiDumpSettings &settings, const char *type_string, int indents, - std::ostream &(*dump)(const T &, const ApiDumpSettings &, int, Args... args), Args... args) { +template +void dump_json_pNext(const T *object, const ApiDumpSettings &settings, const char *type_string, int indents, + std::ostream &(*dump)(const T &, const ApiDumpSettings &, int)) { if (object == NULL) { settings.stream() << settings.indentation(indents) << "{\n"; settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << "*\",\n"; @@ -1455,6 +1389,6 @@ inline void dump_json_pNext(const T *object, const ApiDumpSettings &settings, co settings.stream() << ",\n"; settings.stream() << settings.indentation(indents) << "}"; } else { - dump_json_value(*object, object, settings, type_string, "pNext", indents, dump, args...); + dump_json_value(*object, object, settings, type_string, "pNext", indents, dump); } } diff --git a/scripts/api_dump_generator.py b/scripts/api_dump_generator.py index 6088710478..6c0573a00b 100644 --- a/scripts/api_dump_generator.py +++ b/scripts/api_dump_generator.py @@ -79,7 +79,7 @@ //============================= Dump Functions ==============================// @foreach function where(not '{funcName}' in ['vkGetDeviceProcAddr', 'vkGetInstanceProcAddr', 'vkDebugMarkerSetObjectNameEXT','vkSetDebugUtilsObjectNameEXT']) -inline void dump_head_{funcName}(ApiDumpInstance& dump_inst, {funcTypedParams}) +void dump_head_{funcName}(ApiDumpInstance& dump_inst, {funcTypedParams}) {{ if (!dump_inst.shouldDumpOutput()) return ; dump_inst.outputMutex()->lock(); @@ -100,7 +100,7 @@ @end function @foreach function where('{funcReturn}' != 'void' and not '{funcName}' in ['vkGetDeviceProcAddr', 'vkGetInstanceProcAddr', 'vkDebugMarkerSetObjectNameEXT','vkSetDebugUtilsObjectNameEXT']) -inline void dump_body_{funcName}(ApiDumpInstance& dump_inst, {funcReturn} result, {funcTypedParams}) +void dump_body_{funcName}(ApiDumpInstance& dump_inst, {funcReturn} result, {funcTypedParams}) {{ if (!dump_inst.shouldDumpOutput()) return; @@ -122,7 +122,7 @@ @end function @foreach function where('{funcReturn}' == 'void') -inline void dump_body_{funcName}(ApiDumpInstance& dump_inst, {funcTypedParams}) +void dump_body_{funcName}(ApiDumpInstance& dump_inst, {funcTypedParams}) {{ if (!dump_inst.shouldDumpOutput()) return ; //Lock is already held @@ -144,7 +144,7 @@ @foreach function where('{funcName}' == 'vkDebugMarkerSetObjectNameEXT') -inline void dump_head_{funcName}(ApiDumpInstance& dump_inst, {funcTypedParams}) +void dump_head_{funcName}(ApiDumpInstance& dump_inst, {funcTypedParams}) {{ dump_inst.outputMutex()->lock(); @@ -177,7 +177,7 @@ @end function @foreach function where('{funcName}' == 'vkDebugMarkerSetObjectNameEXT') -inline void dump_body_{funcName}(ApiDumpInstance& dump_inst, {funcReturn} result, {funcTypedParams}) +void dump_body_{funcName}(ApiDumpInstance& dump_inst, {funcReturn} result, {funcTypedParams}) {{ //Lock is already held if (dump_inst.shouldDumpOutput()) {{ @@ -200,7 +200,7 @@ @end function @foreach function where('{funcName}' == 'vkSetDebugUtilsObjectNameEXT') -inline void dump_head_{funcName}(ApiDumpInstance& dump_inst, {funcTypedParams}) +void dump_head_{funcName}(ApiDumpInstance& dump_inst, {funcTypedParams}) {{ dump_inst.outputMutex()->lock(); if (pNameInfo->pObjectName) @@ -230,7 +230,7 @@ @end function @foreach function where('{funcName}' == 'vkSetDebugUtilsObjectNameEXT') -inline void dump_body_{funcName}(ApiDumpInstance& dump_inst, {funcReturn} result, {funcTypedParams}) +void dump_body_{funcName}(ApiDumpInstance& dump_inst, {funcReturn} result, {funcTypedParams}) {{ //Lock is already held if (dump_inst.shouldDumpOutput()) {{ @@ -536,7 +536,7 @@ #include "api_dump.h" @foreach struct -std::ostream& dump_text_{sctName}(const {sctName}& object, const ApiDumpSettings& settings, int indents{sctConditionVars}); +std::ostream& dump_text_{sctName}(const {sctName}& object, const ApiDumpSettings& settings, int indents); @end struct @foreach union std::ostream& dump_text_{unName}(const {unName}& object, const ApiDumpSettings& settings, int indents); @@ -552,7 +552,7 @@ return dump_text_VkAccelerationStructureTypeKHR(object, settings, indents); }} std::ostream& dump_text_VkBuildAccelerationStructureFlagsKHR(VkBuildAccelerationStructureFlagsKHR object, const ApiDumpSettings& settings, int indents); -inline std::ostream& dump_text_VkBuildAccelerationStructureFlagsNV(VkBuildAccelerationStructureFlagsNV object, const ApiDumpSettings& settings, int indents) +std::ostream& dump_text_VkBuildAccelerationStructureFlagsNV(VkBuildAccelerationStructureFlagsNV object, const ApiDumpSettings& settings, int indents) {{ return dump_text_VkBuildAccelerationStructureFlagsKHR(object, settings, indents); }} @@ -564,7 +564,7 @@ std::ostream& dump_text_pNext_trampoline(const void* object, const ApiDumpSettings& settings, int indents) {{ switch((int64_t) (static_cast(object)->sType)) {{ - @foreach struct where('{sctName}' not in ['VkPipelineViewportStateCreateInfo', 'VkCommandBufferBeginInfo']) + @foreach struct @if({sctStructureTypeIndex} != -1) case {sctStructureTypeIndex}: dump_text_pNext(static_cast(object), settings, "{sctName}", indents, dump_text_{sctName}); @@ -588,22 +588,10 @@ return settings.stream(); }} -inline std::ostream& dump_text_pNext_trampoline(const void* object, const ApiDumpSettings& settings, int indents, bool is_dynamic_viewport, bool is_dynamic_scissor) -{{ - dump_text_pNext(static_cast(object), settings, "VkPipelineViewportStateCreateInfo", indents, dump_text_VkPipelineViewportStateCreateInfo, is_dynamic_viewport, is_dynamic_scissor); - return settings.stream(); -}} - -inline std::ostream& dump_text_pNext_trampoline(const void* object, const ApiDumpSettings& settings, int indents, VkCommandBuffer cmd_buffer) -{{ - dump_text_pNext(static_cast(object), settings, "VkCommandBufferBeginInfo", indents, dump_text_VkCommandBufferBeginInfo, cmd_buffer); - return settings.stream(); -}} - std::ostream& dump_text_pNext_struct_name(const void* object, const ApiDumpSettings& settings, int indents) {{ switch((int64_t) (static_cast(object)->sType)) {{ - @foreach struct where('{sctName}' not in ['VkPipelineViewportStateCreateInfo', 'VkCommandBufferBeginInfo']) + @foreach struct @if({sctStructureTypeIndex} != -1) case {sctStructureTypeIndex}: settings.formatNameType(settings.stream(), indents, "pNext", "const void*"); @@ -627,7 +615,7 @@ //=========================== Type Implementations ==========================// @foreach type where('{etyName}' != 'void') -inline std::ostream& dump_text_{etyName}({etyName} object, const ApiDumpSettings& settings, int indents) +std::ostream& dump_text_{etyName}({etyName} object, const ApiDumpSettings& settings, int indents) {{ @if('{etyName}' != 'uint8_t') return settings.stream() << object; @@ -641,14 +629,14 @@ //========================= Basetype Implementations ========================// @foreach basetype where(not '{baseName}' in ['ANativeWindow', 'AHardwareBuffer', 'CAMetalLayer']) -inline std::ostream& dump_text_{baseName}({baseName} object, const ApiDumpSettings& settings, int indents) +std::ostream& dump_text_{baseName}({baseName} object, const ApiDumpSettings& settings, int indents) {{ return settings.stream() << object; }} @end basetype @foreach basetype where('{baseName}' in ['ANativeWindow', 'AHardwareBuffer']) #if defined(VK_USE_PLATFORM_ANDROID_KHR) -inline std::ostream& dump_text_{baseName}(const {baseName}* object, const ApiDumpSettings& settings, int indents) +std::ostream& dump_text_{baseName}(const {baseName}* object, const ApiDumpSettings& settings, int indents) {{ return settings.stream() << object; }} @@ -656,7 +644,7 @@ @end basetype @foreach basetype where('{baseName}' in ['CAMetalLayer']) #if defined(VK_USE_PLATFORM_METAL_EXT) -inline std::ostream& dump_text_{baseName}({baseName} object, const ApiDumpSettings& settings, int indents) +std::ostream& dump_text_{baseName}({baseName} object, const ApiDumpSettings& settings, int indents) {{ return settings.stream() << object; }} @@ -666,7 +654,7 @@ //======================= System Type Implementations =======================// @foreach systype -inline std::ostream& dump_text_{sysName}(const {sysType} object, const ApiDumpSettings& settings, int indents) +std::ostream& dump_text_{sysName}(const {sysType} object, const ApiDumpSettings& settings, int indents) {{ return settings.stream() << object; }} @@ -675,7 +663,7 @@ //========================== Handle Implementations =========================// @foreach handle -inline std::ostream& dump_text_{hdlName}(const {hdlName} object, const ApiDumpSettings& settings, int indents) +std::ostream& dump_text_{hdlName}(const {hdlName} object, const ApiDumpSettings& settings, int indents) {{ if(settings.showAddress()) {{ settings.stream() << object; @@ -745,13 +733,13 @@ //=========================== Flag Implementations ==========================// @foreach flag where('{flagEnum}' != 'None') -inline std::ostream& dump_text_{flagName}({flagName} object, const ApiDumpSettings& settings, int indents) +std::ostream& dump_text_{flagName}({flagName} object, const ApiDumpSettings& settings, int indents) {{ return dump_text_{flagEnum}(({flagEnum}) object, settings, indents); }} @end flag @foreach flag where('{flagEnum}' == 'None') -inline std::ostream& dump_text_{flagName}({flagName} object, const ApiDumpSettings& settings, int indents) +std::ostream& dump_text_{flagName}({flagName} object, const ApiDumpSettings& settings, int indents) {{ return settings.stream() << object; }} @@ -760,7 +748,7 @@ //======================= Func Pointer Implementations ======================// @foreach funcpointer -inline std::ostream& dump_text_{pfnName}({pfnName} object, const ApiDumpSettings& settings, int indents) +std::ostream& dump_text_{pfnName}({pfnName} object, const ApiDumpSettings& settings, int indents) {{ if(settings.showAddress()) return settings.stream() << object; @@ -772,7 +760,7 @@ //========================== Struct Implementations =========================// @foreach struct where('{sctName}' not in ['VkPhysicalDeviceMemoryProperties','VkPhysicalDeviceGroupProperties']) -std::ostream& dump_text_{sctName}(const {sctName}& object, const ApiDumpSettings& settings, int indents{sctConditionVars}) +std::ostream& dump_text_{sctName}(const {sctName}& object, const ApiDumpSettings& settings, int indents) {{ if(settings.showAddress()) settings.stream() << &object << ":\\n"; @@ -783,35 +771,37 @@ @if('{memCondition}' != 'None') if({memCondition}) @end if - + @if('{memParameterStorage}' != '') + {memParameterStorage} + @end if @if({memPtrLevel} == 0) @if('{memName}' != 'pNext') - dump_text_value(object.{memName}, settings, "{memType}", "{memName}", indents + 1, dump_text_{memTypeID}{memInheritedConditions}); // AET + dump_text_value(object.{memName}, settings, "{memType}", "{memName}", indents + 1, dump_text_{memTypeID}); // AET @end if @if('{memName}' == 'pNext') if(object.pNext != nullptr){{ dump_text_pNext_struct_name(object.{memName}, settings, indents + 1); }} else {{ - dump_text_value(object.{memName}, settings, "{memType}", "{memName}", indents + 1, dump_text_{memTypeID}{memInheritedConditions}); // BET + dump_text_value(object.{memName}, settings, "{memType}", "{memName}", indents + 1, dump_text_{memTypeID}); // BET }} @end if @end if @if({memPtrLevel} == 1 and '{memLength}' == 'None') - dump_text_pointer(object.{memName}, settings, "{memType}", "{memName}", indents + 1, dump_text_{memTypeID}{memInheritedConditions}); + dump_text_pointer(object.{memName}, settings, "{memType}", "{memName}", indents + 1, dump_text_{memTypeID}); @end if @if({memPtrLevel} == 1 and '{memLength}' != 'None' and not {memLengthIsMember}) - dump_text_array(object.{memName}, {memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_text_{memTypeID}{memInheritedConditions}); // AQA + dump_text_array(object.{memName}, {memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_text_{memTypeID}); // AQA @end if @if({memPtrLevel} == 1 and '{memLength}' != 'None' and {memLengthIsMember} and '{memName}' != 'pCode') @if('{memLength}'[0].isdigit() or '{memLength}'[0].isupper()) - dump_text_array(object.{memName}, {memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_text_{memTypeID}{memInheritedConditions}); // BQA + dump_text_array(object.{memName}, {memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_text_{memTypeID}); // BQA @end if @if(not ('{memLength}'[0].isdigit() or '{memLength}'[0].isupper())) @if('{memLength}' == 'rasterizationSamples') - dump_text_array(object.{memName}, (object.{memLength} + 31) / 32, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_text_{memTypeID}{memInheritedConditions}); // BQB + dump_text_array(object.{memName}, (object.{memLength} + 31) / 32, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_text_{memTypeID}); // BQB @end if @if('{memLength}' != 'rasterizationSamples') - dump_text_array(object.{memName}, object.{memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_text_{memTypeID}{memInheritedConditions}); // BQB + dump_text_array(object.{memName}, object.{memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_text_{memTypeID}); // BQB @end if @end if @end if @@ -819,7 +809,7 @@ @if('{sctName}' == 'VkShaderModuleCreateInfo') @if('{memName}' == 'pCode') if(settings.showShader()) - dump_text_array(object.{memName}, object.{memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_text_{memTypeID}{memInheritedConditions}); // CQA + dump_text_array(object.{memName}, object.{memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_text_{memTypeID}); // CQA else dump_text_special("SHADER DATA", settings, "{memType}", "{memName}", indents + 1); @end if @@ -939,14 +929,17 @@ if(settings.showParams()) {{ @foreach parameter + @if('{prmParameterStorage}' != '') + {prmParameterStorage} + @end if @if({prmPtrLevel} == 0) - dump_text_value({prmName}, settings, "{prmType}", "{prmName}", 1, dump_text_{prmTypeID}{prmInheritedConditions}); // MET + dump_text_value({prmName}, settings, "{prmType}", "{prmName}", 1, dump_text_{prmTypeID}); // MET @end if @if({prmPtrLevel} == 1 and '{prmLength}' == 'None') - dump_text_pointer({prmName}, settings, "{prmType}", "{prmName}", 1, dump_text_{prmTypeID}{prmInheritedConditions}); + dump_text_pointer({prmName}, settings, "{prmType}", "{prmName}", 1, dump_text_{prmTypeID}); @end if @if({prmPtrLevel} == 1 and '{prmLength}' != 'None') - dump_text_array({prmName}, {prmLength}, settings, "{prmType}", "{prmChildType}", "{prmName}", 1, dump_text_{prmTypeID}{prmInheritedConditions}); // HQA + dump_text_array({prmName}, {prmLength}, settings, "{prmType}", "{prmChildType}", "{prmName}", 1, dump_text_{prmTypeID}); // HQA @end if @end parameter }} @@ -994,7 +987,7 @@ #include "api_dump.h" @foreach struct -std::ostream& dump_html_{sctName}(const {sctName}& object, const ApiDumpSettings& settings, int indents{sctConditionVars}); +std::ostream& dump_html_{sctName}(const {sctName}& object, const ApiDumpSettings& settings, int indents); @end struct @foreach union std::ostream& dump_html_{unName}(const {unName}& object, const ApiDumpSettings& settings, int indents); @@ -1010,7 +1003,7 @@ return dump_html_VkAccelerationStructureTypeKHR(object, settings, indents); }} std::ostream& dump_html_VkBuildAccelerationStructureFlagsKHR(VkBuildAccelerationStructureFlagsKHR object, const ApiDumpSettings& settings, int indents); -inline std::ostream& dump_html_VkBuildAccelerationStructureFlagsNV(VkBuildAccelerationStructureFlagsNV object, const ApiDumpSettings& settings, int indents) +std::ostream& dump_html_VkBuildAccelerationStructureFlagsNV(VkBuildAccelerationStructureFlagsNV object, const ApiDumpSettings& settings, int indents) {{ return dump_html_VkBuildAccelerationStructureFlagsKHR(object, settings, indents); }} @@ -1022,7 +1015,7 @@ std::ostream& dump_html_pNext_trampoline(const void* object, const ApiDumpSettings& settings, int indents) {{ switch((int64_t) (static_cast(object)->sType)) {{ - @foreach struct where('{sctName}' not in ['VkPipelineViewportStateCreateInfo', 'VkCommandBufferBeginInfo']) + @foreach struct @if({sctStructureTypeIndex} != -1) case {sctStructureTypeIndex}: dump_html_pNext(static_cast(object), settings, "{sctName}", indents, dump_html_{sctName}); @@ -1048,22 +1041,10 @@ return settings.stream(); }} -inline std::ostream& dump_html_pNext_trampoline(const void* object, const ApiDumpSettings& settings, int indents, bool is_dynamic_viewport, bool is_dynamic_scissor) -{{ - dump_html_pNext(static_cast(object), settings, "VkPipelineViewportStateCreateInfo", indents, dump_html_VkPipelineViewportStateCreateInfo, is_dynamic_viewport, is_dynamic_scissor); - return settings.stream(); -}} - -inline std::ostream& dump_html_pNext_trampoline(const void* object, const ApiDumpSettings& settings, int indents, VkCommandBuffer cmd_buffer) -{{ - dump_html_pNext(static_cast(object), settings, "VkCommandBufferBeginInfo", indents, dump_html_VkCommandBufferBeginInfo, cmd_buffer); - return settings.stream(); -}} - //=========================== Type Implementations ==========================// @foreach type where('{etyName}' != 'void') -inline std::ostream& dump_html_{etyName}({etyName} object, const ApiDumpSettings& settings, int indents) +std::ostream& dump_html_{etyName}({etyName} object, const ApiDumpSettings& settings, int indents) {{ settings.stream() << "
"; @if('{etyName}' != 'uint8_t') @@ -1079,14 +1060,14 @@ //========================= Basetype Implementations ========================// @foreach basetype where(not '{baseName}' in ['ANativeWindow', 'AHardwareBuffer', 'CAMetalLayer']) -inline std::ostream& dump_html_{baseName}({baseName} object, const ApiDumpSettings& settings, int indents) +std::ostream& dump_html_{baseName}({baseName} object, const ApiDumpSettings& settings, int indents) {{ return settings.stream() << "
" << object << "
"; }} @end basetype @foreach basetype where('{baseName}' in ['ANativeWindow', 'AHardwareBuffer']) #if defined(VK_USE_PLATFORM_ANDROID_KHR) -inline std::ostream& dump_html_{baseName}(const {baseName}* object, const ApiDumpSettings& settings, int indents) +std::ostream& dump_html_{baseName}(const {baseName}* object, const ApiDumpSettings& settings, int indents) {{ return settings.stream() << "
" << object << "
"; }} @@ -1094,7 +1075,7 @@ @end basetype @foreach basetype where('{baseName}' in ['CAMetalLayer']) #if defined(VK_USE_PLATFORM_METAL_EXT) -inline std::ostream& dump_html_{baseName}({baseName} object, const ApiDumpSettings& settings, int indents) +std::ostream& dump_html_{baseName}({baseName} object, const ApiDumpSettings& settings, int indents) {{ return settings.stream() << "
" << object << "
"; }} @@ -1104,7 +1085,7 @@ //======================= System Type Implementations =======================// @foreach systype -inline std::ostream& dump_html_{sysName}(const {sysType} object, const ApiDumpSettings& settings, int indents) +std::ostream& dump_html_{sysName}(const {sysType} object, const ApiDumpSettings& settings, int indents) {{ return settings.stream() << "
" << object << "
"; }} @@ -1113,7 +1094,7 @@ //========================== Handle Implementations =========================// @foreach handle -inline std::ostream& dump_html_{hdlName}(const {hdlName} object, const ApiDumpSettings& settings, int indents) +std::ostream& dump_html_{hdlName}(const {hdlName} object, const ApiDumpSettings& settings, int indents) {{ settings.stream() << "
"; if(settings.showAddress()) {{ @@ -1177,13 +1158,13 @@ //=========================== Flag Implementations ==========================// @foreach flag where('{flagEnum}' != 'None') -inline std::ostream& dump_html_{flagName}({flagName} object, const ApiDumpSettings& settings, int indents) +std::ostream& dump_html_{flagName}({flagName} object, const ApiDumpSettings& settings, int indents) {{ return dump_html_{flagEnum}(({flagEnum}) object, settings, indents); }} @end flag @foreach flag where('{flagEnum}' == 'None') -inline std::ostream& dump_html_{flagName}({flagName} object, const ApiDumpSettings& settings, int indents) +std::ostream& dump_html_{flagName}({flagName} object, const ApiDumpSettings& settings, int indents) {{ return settings.stream() << "
" << object << "
"; @@ -1193,7 +1174,7 @@ //======================= Func Pointer Implementations ======================// @foreach funcpointer -inline std::ostream& dump_html_{pfnName}({pfnName} object, const ApiDumpSettings& settings, int indents) +std::ostream& dump_html_{pfnName}({pfnName} object, const ApiDumpSettings& settings, int indents) {{ settings.stream() << "
"; if(settings.showAddress()) @@ -1207,7 +1188,7 @@ //========================== Struct Implementations =========================// @foreach struct where('{sctName}' not in ['VkPhysicalDeviceMemoryProperties' ,'VkPhysicalDeviceGroupProperties']) -std::ostream& dump_html_{sctName}(const {sctName}& object, const ApiDumpSettings& settings, int indents{sctConditionVars}) +std::ostream& dump_html_{sctName}(const {sctName}& object, const ApiDumpSettings& settings, int indents) {{ settings.stream() << "
"; if(settings.showAddress()) @@ -1220,42 +1201,44 @@ @if('{memCondition}' != 'None') if({memCondition}) @end if - + @if('{memParameterStorage}' != '') + {memParameterStorage} + @end if @if({memPtrLevel} == 0) @if('{memName}' != 'pNext') - dump_html_value(object.{memName}, settings, "{memType}", "{memName}", indents + 1, dump_html_{memTypeID}{memInheritedConditions}); + dump_html_value(object.{memName}, settings, "{memType}", "{memName}", indents + 1, dump_html_{memTypeID}); @end if @if('{memName}' == 'pNext') if(object.pNext != nullptr){{ dump_html_pNext_trampoline(object.{memName}, settings, indents + 1); }} else {{ - dump_html_value(object.{memName}, settings, "{memType}", "{memName}", indents + 1, dump_html_{memTypeID}{memInheritedConditions}); + dump_html_value(object.{memName}, settings, "{memType}", "{memName}", indents + 1, dump_html_{memTypeID}); }} @end if @end if @if({memPtrLevel} == 1 and '{memLength}' == 'None') - dump_html_pointer(object.{memName}, settings, "{memType}", "{memName}", indents + 1, dump_html_{memTypeID}{memInheritedConditions}); + dump_html_pointer(object.{memName}, settings, "{memType}", "{memName}", indents + 1, dump_html_{memTypeID}); @end if @if({memPtrLevel} == 1 and '{memLength}' != 'None' and not {memLengthIsMember}) - dump_html_array(object.{memName}, {memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_html_{memTypeID}{memInheritedConditions}); // ZRR + dump_html_array(object.{memName}, {memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_html_{memTypeID}); // ZRR @end if @if({memPtrLevel} == 1 and '{memLength}' != 'None' and {memLengthIsMember} and '{memName}' != 'pCode') @if('{memLength}'[0].isdigit() or '{memLength}'[0].isupper()) - dump_html_array(object.{memName}, {memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_html_{memTypeID}{memInheritedConditions}); // ZRS + dump_html_array(object.{memName}, {memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_html_{memTypeID}); // ZRS @end if @if(not ('{memLength}'[0].isdigit() or '{memLength}'[0].isupper())) @if('{memLength}' == 'rasterizationSamples') - dump_html_array(object.{memName}, (object.{memLength} + 31) / 32, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_html_{memTypeID}{memInheritedConditions}); // ZRT + dump_html_array(object.{memName}, (object.{memLength} + 31) / 32, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_html_{memTypeID}); // ZRT @end if @if('{memLength}' != 'rasterizationSamples') - dump_html_array(object.{memName}, object.{memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_html_{memTypeID}{memInheritedConditions}); // ZRT + dump_html_array(object.{memName}, object.{memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_html_{memTypeID}); // ZRT @end if @end if @end if @if('{sctName}' == 'VkShaderModuleCreateInfo') @if('{memName}' == 'pCode') if(settings.showShader()) - dump_html_array(object.{memName}, object.{memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_html_{memTypeID}{memInheritedConditions}); // ZRU + dump_html_array(object.{memName}, object.{memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_html_{memTypeID}); // ZRU else dump_html_special("SHADER DATA", settings, "{memType}", "{memName}", indents + 1); @end if @@ -1364,14 +1347,17 @@ if(settings.showParams()) {{ @foreach parameter + @if('{prmParameterStorage}' != '') + {prmParameterStorage} + @end if @if({prmPtrLevel} == 0) - dump_html_value({prmName}, settings, "{prmType}", "{prmName}", 1, dump_html_{prmTypeID}{prmInheritedConditions}); + dump_html_value({prmName}, settings, "{prmType}", "{prmName}", 1, dump_html_{prmTypeID}); @end if @if({prmPtrLevel} == 1 and '{prmLength}' == 'None') - dump_html_pointer({prmName}, settings, "{prmType}", "{prmName}", 1, dump_html_{prmTypeID}{prmInheritedConditions}); + dump_html_pointer({prmName}, settings, "{prmType}", "{prmName}", 1, dump_html_{prmTypeID}); @end if @if({prmPtrLevel} == 1 and '{prmLength}' != 'None') - dump_html_array({prmName}, {prmLength}, settings, "{prmType}", "{prmChildType}", "{prmName}", 1, dump_html_{prmTypeID}{prmInheritedConditions}); // ZRZ + dump_html_array({prmName}, {prmLength}, settings, "{prmType}", "{prmChildType}", "{prmName}", 1, dump_html_{prmTypeID}); // ZRZ @end if @end parameter }} @@ -1417,7 +1403,7 @@ #include "api_dump.h" @foreach struct -std::ostream& dump_json_{sctName}(const {sctName}& object, const ApiDumpSettings& settings, int indents{sctConditionVars}); +std::ostream& dump_json_{sctName}(const {sctName}& object, const ApiDumpSettings& settings, int indents); @end struct @foreach union std::ostream& dump_json_{unName}(const {unName}& object, const ApiDumpSettings& settings, int indents); @@ -1433,7 +1419,7 @@ return dump_json_VkAccelerationStructureTypeKHR(object, settings, indents); }} std::ostream& dump_json_VkBuildAccelerationStructureFlagsKHR(VkBuildAccelerationStructureFlagsKHR object, const ApiDumpSettings& settings, int indents); -inline std::ostream& dump_json_VkBuildAccelerationStructureFlagsNV(VkBuildAccelerationStructureFlagsNV object, const ApiDumpSettings& settings, int indents) +std::ostream& dump_json_VkBuildAccelerationStructureFlagsNV(VkBuildAccelerationStructureFlagsNV object, const ApiDumpSettings& settings, int indents) {{ return dump_json_VkBuildAccelerationStructureFlagsKHR(object, settings, indents); }} @@ -1445,7 +1431,7 @@ std::ostream& dump_json_pNext_trampoline(const void* object, const ApiDumpSettings& settings, int indents) {{ switch((int64_t) (static_cast(object)->sType)) {{ - @foreach struct where('{sctName}' not in ['VkPipelineViewportStateCreateInfo', 'VkCommandBufferBeginInfo']) + @foreach struct @if({sctStructureTypeIndex} != -1) case {sctStructureTypeIndex}: dump_json_pNext(static_cast(object), settings, "{sctName}", indents, dump_json_{sctName}); @@ -1475,22 +1461,10 @@ return settings.stream(); }} -inline std::ostream& dump_json_pNext_trampoline(const void* object, const ApiDumpSettings& settings, int indents, bool is_dynamic_viewport, bool is_dynamic_scissor) -{{ - dump_json_pNext(static_cast(object), settings, "VkPipelineViewportStateCreateInfo", indents, dump_json_VkPipelineViewportStateCreateInfo, is_dynamic_viewport, is_dynamic_scissor); - return settings.stream(); -}} - -inline std::ostream& dump_json_pNext_trampoline(const void* object, const ApiDumpSettings& settings, int indents, VkCommandBuffer cmd_buffer) -{{ - dump_json_pNext(static_cast(object), settings, "VkCommandBufferBeginInfo", indents, dump_json_VkCommandBufferBeginInfo, cmd_buffer); - return settings.stream(); -}} - //=========================== Type Implementations ==========================// @foreach type where('{etyName}' != 'void') -inline std::ostream& dump_json_{etyName}({etyName} object, const ApiDumpSettings& settings, int indents) +std::ostream& dump_json_{etyName}({etyName} object, const ApiDumpSettings& settings, int indents) {{ //settings.stream() << settings.indentation(indents); @@ -1506,14 +1480,14 @@ //========================= Basetype Implementations ========================// @foreach basetype where(not '{baseName}' in ['ANativeWindow', 'AHardwareBuffer', 'CAMetalLayer']) -inline std::ostream& dump_json_{baseName}({baseName} object, const ApiDumpSettings& settings, int indents) +std::ostream& dump_json_{baseName}({baseName} object, const ApiDumpSettings& settings, int indents) {{ return settings.stream() << "\\"" << object << "\\""; }} @end basetype @foreach basetype where('{baseName}' in ['ANativeWindow', 'AHardwareBuffer']) #if defined(VK_USE_PLATFORM_ANDROID_KHR) -inline std::ostream& dump_json_{baseName}(const {baseName}* object, const ApiDumpSettings& settings, int indents) +std::ostream& dump_json_{baseName}(const {baseName}* object, const ApiDumpSettings& settings, int indents) {{ return settings.stream() << "\\"" << object << "\\""; }} @@ -1521,7 +1495,7 @@ @end basetype @foreach basetype where('{baseName}' in ['CAMetalLayer']) #if defined(VK_USE_PLATFORM_METAL_EXT) -inline std::ostream& dump_json_{baseName}({baseName} object, const ApiDumpSettings& settings, int indents) +std::ostream& dump_json_{baseName}({baseName} object, const ApiDumpSettings& settings, int indents) {{ return settings.stream() << "\\"" << object << "\\""; }} @@ -1531,7 +1505,7 @@ //======================= System Type Implementations =======================// @foreach systype -inline std::ostream& dump_json_{sysName}(const {sysType} object, const ApiDumpSettings& settings, int indents) +std::ostream& dump_json_{sysName}(const {sysType} object, const ApiDumpSettings& settings, int indents) {{ return settings.stream() << "\\"" << object << "\\""; }} @@ -1540,7 +1514,7 @@ //========================== Handle Implementations =========================// @foreach handle -inline std::ostream& dump_json_{hdlName}(const {hdlName} object, const ApiDumpSettings& settings, int indents) +std::ostream& dump_json_{hdlName}(const {hdlName} object, const ApiDumpSettings& settings, int indents) {{ if(settings.showAddress()) {{ return settings.stream() << "\\"" << object << "\\""; @@ -1598,13 +1572,13 @@ //=========================== Flag Implementations ==========================// @foreach flag where('{flagEnum}' != 'None') -inline std::ostream& dump_json_{flagName}({flagName} object, const ApiDumpSettings& settings, int indents) +std::ostream& dump_json_{flagName}({flagName} object, const ApiDumpSettings& settings, int indents) {{ return dump_json_{flagEnum}(({flagEnum}) object, settings, indents); }} @end flag @foreach flag where('{flagEnum}' == 'None') -inline std::ostream& dump_json_{flagName}({flagName} object, const ApiDumpSettings& settings, int indents) +std::ostream& dump_json_{flagName}({flagName} object, const ApiDumpSettings& settings, int indents) {{ return settings.stream() << '"' << object << "\\""; }} @@ -1613,7 +1587,7 @@ //======================= Func Pointer Implementations ======================// @foreach funcpointer -inline std::ostream& dump_json_{pfnName}({pfnName} object, const ApiDumpSettings& settings, int indents) +std::ostream& dump_json_{pfnName}({pfnName} object, const ApiDumpSettings& settings, int indents) {{ if(settings.showAddress()) settings.stream() << "\\"" << object << "\\""; @@ -1626,7 +1600,7 @@ //========================== Struct Implementations =========================// @foreach struct where('{sctName}' not in ['VkPhysicalDeviceMemoryProperties' ,'VkPhysicalDeviceGroupProperties']) -std::ostream& dump_json_{sctName}(const {sctName}& object, const ApiDumpSettings& settings, int indents{sctConditionVars}) +std::ostream& dump_json_{sctName}(const {sctName}& object, const ApiDumpSettings& settings, int indents) {{ settings.stream() << settings.indentation(indents) << "[\\n"; @@ -1636,42 +1610,44 @@ @if('{memCondition}' != 'None') if({memCondition}) @end if - + @if('{memParameterStorage}' != '') + {memParameterStorage} + @end if @if({memPtrLevel} == 0) @if('{memName}' != 'pNext') - dump_json_value(object.{memName}, NULL, settings, "{memType}", "{memName}", indents + 1, dump_json_{memTypeID}{memInheritedConditions}); + dump_json_value(object.{memName}, NULL, settings, "{memType}", "{memName}", indents + 1, dump_json_{memTypeID}); @end if @if('{memName}' == 'pNext') if(object.pNext != nullptr){{ dump_json_pNext_trampoline(object.{memName}, settings, indents + 1); }} else {{ - dump_json_value(object.{memName}, object.{memName}, settings, "{memType}", "{memName}", indents + 1, dump_json_{memTypeID}{memInheritedConditions}); + dump_json_value(object.{memName}, object.{memName}, settings, "{memType}", "{memName}", indents + 1, dump_json_{memTypeID}); }} @end if @end if @if({memPtrLevel} == 1 and '{memLength}' == 'None') - dump_json_pointer(object.{memName}, settings, "{memType}", "{memName}", indents + 1, dump_json_{memTypeID}{memInheritedConditions}); + dump_json_pointer(object.{memName}, settings, "{memType}", "{memName}", indents + 1, dump_json_{memTypeID}); @end if @if({memPtrLevel} == 1 and '{memLength}' != 'None' and not {memLengthIsMember}) - dump_json_array(object.{memName}, {memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_json_{memTypeID}{memInheritedConditions}); // IQA + dump_json_array(object.{memName}, {memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_json_{memTypeID}); // IQA @end if @if({memPtrLevel} == 1 and '{memLength}' != 'None' and {memLengthIsMember} and '{memName}' != 'pCode') @if('{memLength}'[0].isdigit() or '{memLength}'[0].isupper()) - dump_json_array(object.{memName}, {memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_json_{memTypeID}{memInheritedConditions}); // JQA + dump_json_array(object.{memName}, {memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_json_{memTypeID}); // JQA @end if @if(not ('{memLength}'[0].isdigit() or '{memLength}'[0].isupper())) @if('{memLength}' == 'rasterizationSamples') - dump_json_array(object.{memName}, (object.{memLength} + 31) / 32, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_json_{memTypeID}{memInheritedConditions}); // JQA + dump_json_array(object.{memName}, (object.{memLength} + 31) / 32, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_json_{memTypeID}); // JQA @end if @if('{memLength}' != 'rasterizationSamples') - dump_json_array(object.{memName}, object.{memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_json_{memTypeID}{memInheritedConditions}); // JQA + dump_json_array(object.{memName}, object.{memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_json_{memTypeID}); // JQA @end if @end if @end if @if('{sctName}' == 'VkShaderModuleCreateInfo') @if('{memName}' == 'pCode') if(settings.showShader()) - dump_json_array(object.{memName}, object.{memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_json_{memTypeID}{memInheritedConditions}); // KQA + dump_json_array(object.{memName}, object.{memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_json_{memTypeID}); // KQA else dump_json_special("SHADER DATA", settings, "{memType}", "{memName}", indents + 1); @end if @@ -1841,14 +1817,17 @@ @foreach parameter if (needParameterComma) settings.stream() << ",\\n"; + @if('{prmParameterStorage}' != '') + {prmParameterStorage} + @end if @if({prmPtrLevel} == 0) - dump_json_value({prmName}, NULL, settings, "{prmType}", "{prmName}", 4, dump_json_{prmTypeID}{prmInheritedConditions}); + dump_json_value({prmName}, NULL, settings, "{prmType}", "{prmName}", 4, dump_json_{prmTypeID}); @end if @if({prmPtrLevel} == 1 and '{prmLength}' == 'None') - dump_json_pointer({prmName}, settings, "{prmType}", "{prmName}", 4, dump_json_{prmTypeID}{prmInheritedConditions}); + dump_json_pointer({prmName}, settings, "{prmType}", "{prmName}", 4, dump_json_{prmTypeID}); @end if @if({prmPtrLevel} == 1 and '{prmLength}' != 'None') - dump_json_array({prmName}, {prmLength}, settings, "{prmType}", "{prmChildType}", "{prmName}", 4, dump_json_{prmTypeID}{prmInheritedConditions}); // PQA + dump_json_array({prmName}, {prmLength}, settings, "{prmType}", "{prmChildType}", "{prmName}", 4, dump_json_{prmTypeID}); // PQA @end if needParameterComma = true; @end parameter @@ -1882,30 +1861,32 @@ , } -INHERITED_STATE = { +PARAMETER_STATE = { 'VkPipelineViewportStateCreateInfo': { 'VkGraphicsPipelineCreateInfo': [ { 'name': 'is_dynamic_viewport', 'type': 'bool', - 'expr': + 'stmt': + 'ApiDumpInstance::current().setIsDynamicViewport(' + 'object.pDynamicState && ' + 'std::count(' + 'object.pDynamicState->pDynamicStates, ' + 'object.pDynamicState->pDynamicStates + object.pDynamicState->dynamicStateCount, ' + 'VK_DYNAMIC_STATE_VIEWPORT' + - ')', + ') > 0);', }, { 'name':'is_dynamic_scissor', 'type': 'bool', - 'expr': + 'stmt': + 'ApiDumpInstance::current().setIsDynamicScissor(' + 'object.pDynamicState && ' + 'std::count(' + 'object.pDynamicState->pDynamicStates, ' + 'object.pDynamicState->pDynamicStates + object.pDynamicState->dynamicStateCount, ' + 'VK_DYNAMIC_STATE_SCISSOR' + - ')', + '));', }, ], }, @@ -1914,7 +1895,7 @@ { 'name': 'cmd_buffer', 'type': 'VkCommandBuffer', - 'expr': 'commandBuffer', + 'stmt': 'ApiDumpInstance::current().setCmdBuffer(commandBuffer);', }, ], }, @@ -1926,7 +1907,7 @@ }, 'VkCommandBufferBeginInfo': { # Tracked state ApiDumpInstance, and inherited cmd_buffer - 'pInheritanceInfo': 'ApiDumpInstance::current().getCmdBufferLevel(cmd_buffer) == VK_COMMAND_BUFFER_LEVEL_SECONDARY', + 'pInheritanceInfo': 'ApiDumpInstance::current().getCmdBufferLevel() == VK_COMMAND_BUFFER_LEVEL_SECONDARY', }, 'VkDescriptorSetLayoutBinding': { 'pImmutableSamplers': @@ -1937,8 +1918,8 @@ 'pQueueFamilyIndices': 'object.sharingMode == VK_SHARING_MODE_CONCURRENT', }, 'VkPipelineViewportStateCreateInfo': { - 'pViewports': '!is_dynamic_viewport', # Inherited state variable is_dynamic_viewport - 'pScissors': '!is_dynamic_scissor', # Inherited state variable is_dynamic_scissor + 'pViewports': '!ApiDumpInstance::current().getIsDynamicViewport()', # Inherited state variable is_dynamic_viewport + 'pScissors': '!ApiDumpInstance::current().getIsDynamicScissor()', # Inherited state variable is_dynamic_scissor }, 'VkSwapchainCreateInfoKHR': { 'pQueueFamilyIndices': 'object.imageSharingMode == VK_SHARING_MODE_CONCURRENT', @@ -2418,10 +2399,10 @@ def __init__(self, rootNode, constants, aliases, parentName): self.pointerLevels -= 1 assert(self.pointerLevels >= 0) - self.inheritedConditions = '' - if self.typeID in INHERITED_STATE and parentName in INHERITED_STATE[self.typeID]: - for states in INHERITED_STATE[self.typeID][parentName]: - self.inheritedConditions += ', ' + states['expr'] + self.parameterStorage = '' + if self.typeID in PARAMETER_STATE and parentName in PARAMETER_STATE[self.typeID]: + for states in PARAMETER_STATE[self.typeID][parentName]: + self.parameterStorage += states['stmt'] class VulkanBasetype: @@ -2658,7 +2639,7 @@ def values(self): 'prmChildType': self.childType, 'prmPtrLevel': self.pointerLevels, 'prmLength': self.arrayLength, - 'prmInheritedConditions': self.inheritedConditions, + 'prmParameterStorage': self.parameterStorage, } def __init__(self, rootNode, constants, aliases, extensions): @@ -2760,7 +2741,7 @@ def values(self): 'memLength': self.arrayLength, 'memLengthIsMember': self.lengthMember, 'memCondition': self.condition, - 'memInheritedConditions': self.inheritedConditions, + 'memParameterStorage': self.parameterStorage, } @@ -2770,11 +2751,6 @@ def __init__(self, rootNode, constants, enums): self.members = [] for node in rootNode.findall('member'): self.members.append(VulkanStruct.Member(node, constants, self.name)) - self.conditionVars = '' - if self.name in INHERITED_STATE: - for parent, states in INHERITED_STATE[self.name].items(): - for state in states: - self.conditionVars += ', ' + state['type'] + ' ' + state['name'] self.structureIndex = -1 @@ -2790,7 +2766,6 @@ def __init__(self, rootNode, constants, enums): def values(self): return { 'sctName': self.name, - 'sctConditionVars': self.conditionVars, 'sctStructureTypeIndex': self.structureIndex, } From 74679223027a9c674fe6c4bad859a9ebc248bba7 Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Fri, 18 Nov 2022 20:26:03 -0700 Subject: [PATCH 030/154] apidump: Factor out head & body print functions api_dump.cpp included a lot of redundant functions to print the head and body of the API functions. By creating API function agnostic head printer and moving the logic of the body printer into the parent, many lines of code were removed from the generated file. --- layersvt/api_dump.h | 61 +++- scripts/api_dump_generator.py | 627 ++++++++++++++++++---------------- 2 files changed, 386 insertions(+), 302 deletions(-) diff --git a/layersvt/api_dump.h b/layersvt/api_dump.h index d300d39b1b..57f4cfea5f 100644 --- a/layersvt/api_dump.h +++ b/layersvt/api_dump.h @@ -852,7 +852,7 @@ class ApiDumpInstance { bool conditional_initialized = false; bool should_dump_output = true; - bool first_func_call_on_frame = false; + bool first_func_call_on_frame = true; std::chrono::system_clock::time_point program_start; @@ -889,6 +889,25 @@ ApiDumpInstance ApiDumpInstance::current_instance; //==================================== Text Backend Helpers ======================================// +std::ostream &dump_text_function_head(ApiDumpInstance &dump_inst, const char *funcName, const char *funcReturn) { + const ApiDumpSettings &settings(dump_inst.settings()); + if (settings.showThreadAndFrame()) { + settings.stream() << "Thread " << dump_inst.threadID() << ", Frame " << dump_inst.frameCount(); + } + if (settings.showTimestamp() && settings.showThreadAndFrame()) { + settings.stream() << ", "; + } + if (settings.showTimestamp()) { + settings.stream() << "Time " << dump_inst.current_time_since_start().count() << " us"; + } + if (settings.showTimestamp() || settings.showThreadAndFrame()) { + settings.stream() << ":\n"; + } + settings.stream() << funcName << " returns " << funcReturn; + + return settings.shouldFlush() ? settings.stream() << std::flush : settings.stream(); +} + template void dump_text_array(const T *array, size_t len, const ApiDumpSettings &settings, const char *type_string, const char *child_type, const char *name, int indents, std::ostream &(*dump)(const T, const ApiDumpSettings &, int)) { @@ -1012,6 +1031,18 @@ std::ostream &dump_html_nametype(std::ostream &stream, bool showType, const char return stream; } +std::ostream &dump_html_function_head(ApiDumpInstance &dump_inst, const char *funcName, const char *funcReturn) { + const ApiDumpSettings &settings(dump_inst.settings()); + if (settings.showThreadAndFrame()) { + settings.stream() << "
Thread: " << dump_inst.threadID() << "
"; + } + if (settings.showTimestamp()) + settings.stream() << "
Time: " << dump_inst.current_time_since_start().count() << " us
"; + settings.stream() << "
"; + dump_html_nametype(settings.stream(), settings.showType(), funcName, funcReturn); + return settings.shouldFlush() ? settings.stream() << std::flush : settings.stream(); +} + template void dump_html_array(const T *array, size_t len, const ApiDumpSettings &settings, const char *type_string, const char *child_type, const char *name, int indents, std::ostream &(*dump)(const T, const ApiDumpSettings &, int)) { @@ -1154,6 +1185,34 @@ void dump_html_pNext(const T *object, const ApiDumpSettings &settings, const cha //==================================== Json Backend Helpers ======================================// +std::ostream &dump_json_function_head(ApiDumpInstance &dump_inst, const char *funcName, const char *funcReturn) { + const ApiDumpSettings &settings(dump_inst.settings()); + + if (!dump_inst.firstFunctionCallOnFrame()) settings.stream() << ",\n"; + + // Display api call name + settings.stream() << settings.indentation(2) << "{\n"; + settings.stream() << settings.indentation(3) << "\"name\" : \"" << funcName << "\",\n"; + + // Display thread info + if (settings.showThreadAndFrame()) { + { settings.stream() << settings.indentation(3) << "\"thread\" : \"Thread " << dump_inst.threadID() << "\",\n"; } + } + + // Display elapsed time + if (settings.showTimestamp()) { + { + settings.stream() << settings.indentation(3) << "\"time\" : \"" << dump_inst.current_time_since_start().count() + << " us\",\n"; + } + } + + // Display return value + settings.stream() << settings.indentation(3) << "\"returnType\" : \"" << funcReturn << "\",\n"; + + return settings.shouldFlush() ? settings.stream() << std::flush : settings.stream(); +} + template void dump_json_array(const T *array, size_t len, const ApiDumpSettings &settings, const char *type_string, const char *child_type, const char *name, int indents, std::ostream &(*dump)(const T, const ApiDumpSettings &, int)) { diff --git a/scripts/api_dump_generator.py b/scripts/api_dump_generator.py index 6c0573a00b..b5147fc1af 100644 --- a/scripts/api_dump_generator.py +++ b/scripts/api_dump_generator.py @@ -76,232 +76,118 @@ #include "api_dump_html.h" #include "api_dump_json.h" -//============================= Dump Functions ==============================// - -@foreach function where(not '{funcName}' in ['vkGetDeviceProcAddr', 'vkGetInstanceProcAddr', 'vkDebugMarkerSetObjectNameEXT','vkSetDebugUtilsObjectNameEXT']) -void dump_head_{funcName}(ApiDumpInstance& dump_inst, {funcTypedParams}) -{{ - if (!dump_inst.shouldDumpOutput()) return ; - dump_inst.outputMutex()->lock(); - switch(dump_inst.settings().format()) - {{ - case ApiDumpFormat::Text: - dump_text_head_{funcName}(dump_inst, {funcNamedParams}); - break; - case ApiDumpFormat::Html: - dump_html_head_{funcName}(dump_inst, {funcNamedParams}); - break; - case ApiDumpFormat::Json: - dump_json_head_{funcName}(dump_inst, {funcNamedParams}); - break; - }} - //Keep lock -}} -@end function +// Specifically implemented functions -@foreach function where('{funcReturn}' != 'void' and not '{funcName}' in ['vkGetDeviceProcAddr', 'vkGetInstanceProcAddr', 'vkDebugMarkerSetObjectNameEXT','vkSetDebugUtilsObjectNameEXT']) -void dump_body_{funcName}(ApiDumpInstance& dump_inst, {funcReturn} result, {funcTypedParams}) +VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkCreateInstance(const VkInstanceCreateInfo* pCreateInfo, const VkAllocationCallbacks* pAllocator, VkInstance* pInstance) {{ - if (!dump_inst.shouldDumpOutput()) return; - - //Lock is already held - switch(dump_inst.settings().format()) - {{ - case ApiDumpFormat::Text: - dump_text_body_{funcName}(dump_inst, result, {funcNamedParams}); - break; - case ApiDumpFormat::Html: - dump_html_body_{funcName}(dump_inst, result, {funcNamedParams}); - break; - case ApiDumpFormat::Json: - dump_json_body_{funcName}(dump_inst, result, {funcNamedParams}); - break; + ApiDumpInstance::current().outputMutex()->lock(); + if (ApiDumpInstance::current().shouldDumpOutput()) {{ + switch(ApiDumpInstance::current().settings().format()) + {{ + case ApiDumpFormat::Text: + dump_text_function_head(ApiDumpInstance::current(), \"vkCreateInstance(pCreateInfo, pAllocator, pInstance)\", \"VkResult\"); + break; + case ApiDumpFormat::Html: + dump_html_function_head(ApiDumpInstance::current(), \"vkCreateInstance(pCreateInfo, pAllocator, pInstance)\", \"VkResult\"); + break; + case ApiDumpFormat::Json: + dump_json_function_head(ApiDumpInstance::current(), \"vkCreateInstance\", \"VkResult\"); + break; + }} }} - dump_inst.outputMutex()->unlock(); -}} -@end function -@foreach function where('{funcReturn}' == 'void') -void dump_body_{funcName}(ApiDumpInstance& dump_inst, {funcTypedParams}) -{{ - if (!dump_inst.shouldDumpOutput()) return ; - //Lock is already held - switch(dump_inst.settings().format()) - {{ - case ApiDumpFormat::Text: - dump_text_body_{funcName}(dump_inst, {funcNamedParams}); - break; - case ApiDumpFormat::Html: - dump_html_body_{funcName}(dump_inst, {funcNamedParams}); - break; - case ApiDumpFormat::Json: - dump_json_body_{funcName}(dump_inst, {funcNamedParams}); - break; + // Get the function pointer + VkLayerInstanceCreateInfo* chain_info = get_chain_info(pCreateInfo, VK_LAYER_LINK_INFO); + assert(chain_info->u.pLayerInfo != 0); + PFN_vkGetInstanceProcAddr fpGetInstanceProcAddr = chain_info->u.pLayerInfo->pfnNextGetInstanceProcAddr; + assert(fpGetInstanceProcAddr != 0); + PFN_vkCreateInstance fpCreateInstance = (PFN_vkCreateInstance) fpGetInstanceProcAddr(NULL, "vkCreateInstance"); + if(fpCreateInstance == NULL) {{ + return VK_ERROR_INITIALIZATION_FAILED; }} - dump_inst.outputMutex()->unlock(); -}} -@end function - -@foreach function where('{funcName}' == 'vkDebugMarkerSetObjectNameEXT') -void dump_head_{funcName}(ApiDumpInstance& dump_inst, {funcTypedParams}) -{{ - dump_inst.outputMutex()->lock(); - - if (pNameInfo->pObjectName) - {{ - dump_inst.object_name_map.insert(std::make_pair((uint64_t &&)pNameInfo->object, pNameInfo->pObjectName)); - }} - else - {{ - dump_inst.object_name_map.erase(pNameInfo->object); + // Call the function and create the dispatch table + chain_info->u.pLayerInfo = chain_info->u.pLayerInfo->pNext; + VkResult result = fpCreateInstance(pCreateInfo, pAllocator, pInstance); + if(result == VK_SUCCESS) {{ + initInstanceTable(*pInstance, fpGetInstanceProcAddr); }} - - if (dump_inst.shouldDumpOutput()) {{ - switch(dump_inst.settings().format()) + // Output the API dump + if (ApiDumpInstance::current().shouldDumpOutput()) {{ + switch(ApiDumpInstance::current().settings().format()) {{ - case ApiDumpFormat::Text: - dump_text_head_{funcName}(dump_inst, {funcNamedParams}); - break; - case ApiDumpFormat::Html: - dump_html_head_{funcName}(dump_inst, {funcNamedParams}); - break; - case ApiDumpFormat::Json: - dump_json_head_{funcName}(dump_inst, {funcNamedParams}); - break; + case ApiDumpFormat::Text: + dump_text_vkCreateInstance(ApiDumpInstance::current(), result, pCreateInfo, pAllocator, pInstance); + break; + case ApiDumpFormat::Html: + dump_html_vkCreateInstance(ApiDumpInstance::current(), result, pCreateInfo, pAllocator, pInstance); + break; + case ApiDumpFormat::Json: + dump_json_vkCreateInstance(ApiDumpInstance::current(), result, pCreateInfo, pAllocator, pInstance); + break; }} }} - - //Keep lock + ApiDumpInstance::current().outputMutex()->unlock(); + return result; }} -@end function -@foreach function where('{funcName}' == 'vkDebugMarkerSetObjectNameEXT') -void dump_body_{funcName}(ApiDumpInstance& dump_inst, {funcReturn} result, {funcTypedParams}) +VK_LAYER_EXPORT VKAPI_ATTR void VKAPI_CALL vkDestroyInstance(VkInstance instance, const VkAllocationCallbacks* pAllocator) {{ - //Lock is already held - if (dump_inst.shouldDumpOutput()) {{ - switch(dump_inst.settings().format()) + ApiDumpInstance::current().outputMutex()->lock(); + if (ApiDumpInstance::current().shouldDumpOutput()) {{ + switch(ApiDumpInstance::current().settings().format()) {{ case ApiDumpFormat::Text: - dump_text_body_{funcName}(dump_inst, result, {funcNamedParams}); + dump_text_function_head(ApiDumpInstance::current(), \"vkDestroyInstance(instance, pAllocator)\", \"void\"); break; case ApiDumpFormat::Html: - dump_html_body_{funcName}(dump_inst, result, {funcNamedParams}); + dump_html_function_head(ApiDumpInstance::current(), \"vkDestroyInstance(instance, pAllocator)\", \"void\"); break; case ApiDumpFormat::Json: - dump_json_body_{funcName}(dump_inst, result, {funcNamedParams}); + dump_json_function_head(ApiDumpInstance::current(), \"vkDestroyInstance\", \"void\"); break; }} }} + // Destroy the dispatch table + dispatch_key key = get_dispatch_key(instance); + instance_dispatch_table(instance)->DestroyInstance(instance, pAllocator); + destroy_instance_dispatch_table(key); - dump_inst.outputMutex()->unlock(); -}} -@end function - -@foreach function where('{funcName}' == 'vkSetDebugUtilsObjectNameEXT') -void dump_head_{funcName}(ApiDumpInstance& dump_inst, {funcTypedParams}) -{{ - dump_inst.outputMutex()->lock(); - if (pNameInfo->pObjectName) - {{ - dump_inst.object_name_map.insert(std::make_pair((uint64_t &&)pNameInfo->objectHandle, pNameInfo->pObjectName)); - }} - else - {{ - dump_inst.object_name_map.erase(pNameInfo->objectHandle); - }} - if (dump_inst.shouldDumpOutput()) {{ - switch(dump_inst.settings().format()) + // Output the API dump + if (ApiDumpInstance::current().shouldDumpOutput()) {{ + switch(ApiDumpInstance::current().settings().format()) {{ case ApiDumpFormat::Text: - dump_text_head_{funcName}(dump_inst, {funcNamedParams}); + dump_text_vkDestroyInstance(ApiDumpInstance::current(), instance, pAllocator); break; case ApiDumpFormat::Html: - dump_html_head_{funcName}(dump_inst, {funcNamedParams}); + dump_html_vkDestroyInstance(ApiDumpInstance::current(), instance, pAllocator); break; case ApiDumpFormat::Json: - dump_json_head_{funcName}(dump_inst, {funcNamedParams}); + dump_json_vkDestroyInstance(ApiDumpInstance::current(), instance, pAllocator); break; }} }} - //Keep lock + ApiDumpInstance::current().outputMutex()->unlock(); }} -@end function -@foreach function where('{funcName}' == 'vkSetDebugUtilsObjectNameEXT') -void dump_body_{funcName}(ApiDumpInstance& dump_inst, {funcReturn} result, {funcTypedParams}) +VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkCreateDevice(VkPhysicalDevice physicalDevice, const VkDeviceCreateInfo* pCreateInfo, const VkAllocationCallbacks* pAllocator, VkDevice* pDevice) {{ - //Lock is already held - if (dump_inst.shouldDumpOutput()) {{ - switch(dump_inst.settings().format()) + ApiDumpInstance::current().outputMutex()->lock(); + if (ApiDumpInstance::current().shouldDumpOutput()) {{ + switch(ApiDumpInstance::current().settings().format()) {{ - case ApiDumpFormat::Text: - dump_text_body_{funcName}(dump_inst, result, {funcNamedParams}); - break; - case ApiDumpFormat::Html: - dump_html_body_{funcName}(dump_inst, result, {funcNamedParams}); - break; - case ApiDumpFormat::Json: - dump_json_body_{funcName}(dump_inst, result, {funcNamedParams}); - break; + case ApiDumpFormat::Text: + dump_text_function_head(ApiDumpInstance::current(), \"vkCreateDevice(physicalDevice, pCreateInfo, pAllocator, pDevice)\", \"VkResult\"); + break; + case ApiDumpFormat::Html: + dump_html_function_head(ApiDumpInstance::current(), \"vkCreateDevice(physicalDevice, pCreateInfo, pAllocator, pDevice)\", \"VkResult\"); + break; + case ApiDumpFormat::Json: + dump_json_function_head(ApiDumpInstance::current(), \"vkCreateDevice\", \"VkResult\"); + break; }} }} - dump_inst.outputMutex()->unlock(); -}} -@end function - -//============================= API EntryPoints =============================// - -// Specifically implemented functions - -@foreach function where('{funcName}' == 'vkCreateInstance') -VK_LAYER_EXPORT VKAPI_ATTR {funcReturn} VKAPI_CALL {funcName}({funcTypedParams}) -{{ - dump_head_{funcName}(ApiDumpInstance::current(), {funcNamedParams}); - - // Get the function pointer - VkLayerInstanceCreateInfo* chain_info = get_chain_info(pCreateInfo, VK_LAYER_LINK_INFO); - assert(chain_info->u.pLayerInfo != 0); - PFN_vkGetInstanceProcAddr fpGetInstanceProcAddr = chain_info->u.pLayerInfo->pfnNextGetInstanceProcAddr; - assert(fpGetInstanceProcAddr != 0); - PFN_vkCreateInstance fpCreateInstance = (PFN_vkCreateInstance) fpGetInstanceProcAddr(NULL, "vkCreateInstance"); - if(fpCreateInstance == NULL) {{ - return VK_ERROR_INITIALIZATION_FAILED; - }} - - // Call the function and create the dispatch table - chain_info->u.pLayerInfo = chain_info->u.pLayerInfo->pNext; - {funcReturn} result = fpCreateInstance({funcNamedParams}); - if(result == VK_SUCCESS) {{ - initInstanceTable(*pInstance, fpGetInstanceProcAddr); - }} - {funcStateTrackingCode} - // Output the API dump - dump_body_{funcName}(ApiDumpInstance::current(), result, {funcNamedParams}); - return result; -}} -@end function - -@foreach function where('{funcName}' == 'vkDestroyInstance') -VK_LAYER_EXPORT VKAPI_ATTR {funcReturn} VKAPI_CALL {funcName}({funcTypedParams}) -{{ - dump_head_{funcName}(ApiDumpInstance::current(), {funcNamedParams}); - // Destroy the dispatch table - dispatch_key key = get_dispatch_key({funcDispatchParam}); - instance_dispatch_table({funcDispatchParam})->DestroyInstance({funcNamedParams}); - destroy_instance_dispatch_table(key); - {funcStateTrackingCode} - // Output the API dump - dump_body_{funcName}(ApiDumpInstance::current(), {funcNamedParams}); -}} -@end function - -@foreach function where('{funcName}' == 'vkCreateDevice') -VK_LAYER_EXPORT VKAPI_ATTR {funcReturn} VKAPI_CALL {funcName}({funcTypedParams}) -{{ - dump_head_{funcName}(ApiDumpInstance::current(), {funcNamedParams}); - // Get the function pointer VkLayerDeviceCreateInfo* chain_info = get_chain_info(pCreateInfo, VK_LAYER_LINK_INFO); assert(chain_info->u.pLayerInfo != 0); @@ -315,41 +201,77 @@ // Call the function and create the dispatch table chain_info->u.pLayerInfo = chain_info->u.pLayerInfo->pNext; - {funcReturn} result = fpCreateDevice({funcNamedParams}); + VkResult result = fpCreateDevice(physicalDevice, pCreateInfo, pAllocator, pDevice); if(result == VK_SUCCESS) {{ initDeviceTable(*pDevice, fpGetDeviceProcAddr); }} - {funcStateTrackingCode} + // Output the API dump - dump_body_{funcName}(ApiDumpInstance::current(), result, {funcNamedParams}); + if (ApiDumpInstance::current().shouldDumpOutput()) {{ + switch(ApiDumpInstance::current().settings().format()) + {{ + case ApiDumpFormat::Text: + dump_text_vkCreateDevice(ApiDumpInstance::current(), result, physicalDevice, pCreateInfo, pAllocator, pDevice); + break; + case ApiDumpFormat::Html: + dump_html_vkCreateDevice(ApiDumpInstance::current(), result, physicalDevice, pCreateInfo, pAllocator, pDevice); + break; + case ApiDumpFormat::Json: + dump_json_vkCreateDevice(ApiDumpInstance::current(), result, physicalDevice, pCreateInfo, pAllocator, pDevice); + break; + }} + }} + ApiDumpInstance::current().outputMutex()->unlock(); return result; }} -@end function -@foreach function where('{funcName}' == 'vkDestroyDevice') -VK_LAYER_EXPORT VKAPI_ATTR {funcReturn} VKAPI_CALL {funcName}({funcTypedParams}) +VK_LAYER_EXPORT VKAPI_ATTR void VKAPI_CALL vkDestroyDevice(VkDevice device, const VkAllocationCallbacks* pAllocator) {{ - dump_head_{funcName}(ApiDumpInstance::current(), {funcNamedParams}); + ApiDumpInstance::current().outputMutex()->lock(); + if (ApiDumpInstance::current().shouldDumpOutput()) {{ + switch(ApiDumpInstance::current().settings().format()) + {{ + case ApiDumpFormat::Text: + dump_text_function_head(ApiDumpInstance::current(), \"vkDestroyDevice(device, pAllocator)\", \"void\"); + break; + case ApiDumpFormat::Html: + dump_html_function_head(ApiDumpInstance::current(), \"vkDestroyDevice(device, pAllocator)\", \"void\"); + break; + case ApiDumpFormat::Json: + dump_json_function_head(ApiDumpInstance::current(), \"vkDestroyDevice\", \"void\"); + break; + }} + }} // Destroy the dispatch table - dispatch_key key = get_dispatch_key({funcDispatchParam}); - device_dispatch_table({funcDispatchParam})->DestroyDevice({funcNamedParams}); + dispatch_key key = get_dispatch_key(device); + device_dispatch_table(device)->DestroyDevice(device, pAllocator); destroy_device_dispatch_table(key); - {funcStateTrackingCode} + // Output the API dump - dump_body_{funcName}(ApiDumpInstance::current(), {funcNamedParams}); + if (ApiDumpInstance::current().shouldDumpOutput()) {{ + switch(ApiDumpInstance::current().settings().format()) + {{ + case ApiDumpFormat::Text: + dump_text_vkDestroyDevice(ApiDumpInstance::current(), device, pAllocator); + break; + case ApiDumpFormat::Html: + dump_html_vkDestroyDevice(ApiDumpInstance::current(), device, pAllocator); + break; + case ApiDumpFormat::Json: + dump_json_vkDestroyDevice(ApiDumpInstance::current(), device, pAllocator); + break; + }} + }} + ApiDumpInstance::current().outputMutex()->unlock(); }} -@end function -@foreach function where('{funcName}' == 'vkEnumerateInstanceExtensionProperties') -VK_LAYER_EXPORT VKAPI_ATTR {funcReturn} VKAPI_CALL {funcName}({funcTypedParams}) +VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateInstanceExtensionProperties(const char* pLayerName, uint32_t* pPropertyCount, VkExtensionProperties* pProperties) {{ return util_GetExtensionProperties(0, NULL, pPropertyCount, pProperties); }} -@end function -@foreach function where('{funcName}' == 'vkEnumerateInstanceLayerProperties') -VK_LAYER_EXPORT VKAPI_ATTR {funcReturn} VKAPI_CALL {funcName}({funcTypedParams}) +VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateInstanceLayerProperties(uint32_t* pPropertyCount, VkLayerProperties* pProperties) {{ static const VkLayerProperties layerProperties[] = {{ {{ @@ -362,10 +284,8 @@ return util_GetLayerProperties(ARRAY_SIZE(layerProperties), layerProperties, pPropertyCount, pProperties); }} -@end function -@foreach function where('{funcName}' == 'vkEnumerateDeviceLayerProperties') -VK_LAYER_EXPORT VKAPI_ATTR {funcReturn} VKAPI_CALL {funcName}({funcTypedParams}) +VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateDeviceLayerProperties(VkPhysicalDevice physicalDevice, uint32_t* pPropertyCount, VkLayerProperties* pProperties) {{ static const VkLayerProperties layerProperties[] = {{ {{ @@ -378,30 +298,65 @@ return util_GetLayerProperties(ARRAY_SIZE(layerProperties), layerProperties, pPropertyCount, pProperties); }} -@end function -@foreach function where('{funcName}' == 'vkQueuePresentKHR') -VK_LAYER_EXPORT VKAPI_ATTR {funcReturn} VKAPI_CALL {funcName}({funcTypedParams}) +VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkQueuePresentKHR(VkQueue queue, const VkPresentInfoKHR* pPresentInfo) {{ ApiDumpInstance::current().outputMutex()->lock(); - dump_head_{funcName}(ApiDumpInstance::current(), {funcNamedParams}); - - {funcReturn} result = device_dispatch_table({funcDispatchParam})->{funcShortName}({funcNamedParams}); - {funcStateTrackingCode} - dump_body_{funcName}(ApiDumpInstance::current(), result, {funcNamedParams}); + if (ApiDumpInstance::current().shouldDumpOutput()) {{ + switch(ApiDumpInstance::current().settings().format()) + {{ + case ApiDumpFormat::Text: + dump_text_function_head(ApiDumpInstance::current(), \"vkQueuePresentKHR(queue, pPresentInfo)\", \"vVkResult\"); + break; + case ApiDumpFormat::Html: + dump_html_function_head(ApiDumpInstance::current(), \"vkQueuePresentKHR(queue, pPresentInfo)\", \"vVkResult\"); + break; + case ApiDumpFormat::Json: + dump_json_function_head(ApiDumpInstance::current(), \"vkQueuePresentKHR\", \"vVkResult\"); + break; + }} + }} + VkResult result = device_dispatch_table(queue)->QueuePresentKHR(queue, pPresentInfo); + if (ApiDumpInstance::current().shouldDumpOutput()) {{ + switch(ApiDumpInstance::current().settings().format()) + {{ + case ApiDumpFormat::Text: + dump_text_vkQueuePresentKHR(ApiDumpInstance::current(), result, queue, pPresentInfo); + break; + case ApiDumpFormat::Html: + dump_html_vkQueuePresentKHR(ApiDumpInstance::current(), result, queue, pPresentInfo); + break; + case ApiDumpFormat::Json: + dump_json_vkQueuePresentKHR(ApiDumpInstance::current(), result, queue, pPresentInfo); + break; + }} + }} ApiDumpInstance::current().nextFrame(); ApiDumpInstance::current().outputMutex()->unlock(); return result; }} -@end function // Autogen instance functions @foreach function where('{funcDispatchType}' == 'instance' and '{funcReturn}' != 'void' and '{funcName}' not in ['vkCreateInstance', 'vkDestroyInstance', 'vkCreateDevice', 'vkGetInstanceProcAddr', 'vkEnumerateDeviceExtensionProperties', 'vkEnumerateDeviceLayerProperties','vkGetPhysicalDeviceToolPropertiesEXT']) VK_LAYER_EXPORT VKAPI_ATTR {funcReturn} VKAPI_CALL {funcName}({funcTypedParams}) {{ - dump_head_{funcName}(ApiDumpInstance::current(), {funcNamedParams}); + ApiDumpInstance::current().outputMutex()->lock(); + if (ApiDumpInstance::current().shouldDumpOutput()) {{ + switch(ApiDumpInstance::current().settings().format()) + {{ + case ApiDumpFormat::Text: + dump_text_function_head(ApiDumpInstance::current(), \"{funcName}({funcNamedParams})\", \"{funcReturn}\"); + break; + case ApiDumpFormat::Html: + dump_html_function_head(ApiDumpInstance::current(), \"{funcName}({funcNamedParams})\", \"{funcReturn}\"); + break; + case ApiDumpFormat::Json: + dump_json_function_head(ApiDumpInstance::current(), \"{funcName}\", \"{funcReturn}\"); + break; + }} + }} {funcReturn} result = instance_dispatch_table({funcDispatchParam})->{funcShortName}({funcNamedParams}); {funcStateTrackingCode} @if('{funcName}' == 'vkEnumeratePhysicalDevices') @@ -411,7 +366,22 @@ }} }} @end if - dump_body_{funcName}(ApiDumpInstance::current(), result, {funcNamedParams}); + + if (ApiDumpInstance::current().shouldDumpOutput()) {{ + switch(ApiDumpInstance::current().settings().format()) + {{ + case ApiDumpFormat::Text: + dump_text_{funcName}(ApiDumpInstance::current(), result, {funcNamedParams}); + break; + case ApiDumpFormat::Html: + dump_html_{funcName}(ApiDumpInstance::current(), result, {funcNamedParams}); + break; + case ApiDumpFormat::Json: + dump_json_{funcName}(ApiDumpInstance::current(), result, {funcNamedParams}); + break; + }} + }} + ApiDumpInstance::current().outputMutex()->unlock(); return result; }} @end function @@ -419,10 +389,38 @@ @foreach function where('{funcDispatchType}' == 'instance' and '{funcReturn}' == 'void' and '{funcName}' not in ['vkCreateInstance', 'vkDestroyInstance', 'vkCreateDevice', 'vkGetInstanceProcAddr', 'vkEnumerateDeviceExtensionProperties', 'vkEnumerateDeviceLayerProperties']) VK_LAYER_EXPORT VKAPI_ATTR {funcReturn} VKAPI_CALL {funcName}({funcTypedParams}) {{ - dump_head_{funcName}(ApiDumpInstance::current(), {funcNamedParams}); + ApiDumpInstance::current().outputMutex()->lock(); + if (ApiDumpInstance::current().shouldDumpOutput()) {{ + switch(ApiDumpInstance::current().settings().format()) + {{ + case ApiDumpFormat::Text: + dump_text_function_head(ApiDumpInstance::current(), \"{funcName}({funcNamedParams})\", \"{funcReturn}\"); + break; + case ApiDumpFormat::Html: + dump_html_function_head(ApiDumpInstance::current(), \"{funcName}({funcNamedParams})\", \"{funcReturn}\"); + break; + case ApiDumpFormat::Json: + dump_json_function_head(ApiDumpInstance::current(), \"{funcName}\", \"{funcReturn}\"); + break; + }} + }} instance_dispatch_table({funcDispatchParam})->{funcShortName}({funcNamedParams}); {funcStateTrackingCode} - dump_body_{funcName}(ApiDumpInstance::current(), {funcNamedParams}); + if (ApiDumpInstance::current().shouldDumpOutput()) {{ + switch(ApiDumpInstance::current().settings().format()) + {{ + case ApiDumpFormat::Text: + dump_text_{funcName}(ApiDumpInstance::current(), {funcNamedParams}); + break; + case ApiDumpFormat::Html: + dump_html_{funcName}(ApiDumpInstance::current(), {funcNamedParams}); + break; + case ApiDumpFormat::Json: + dump_json_{funcName}(ApiDumpInstance::current(), {funcNamedParams}); + break; + }} + }} + ApiDumpInstance::current().outputMutex()->unlock(); }} @end function @@ -431,10 +429,50 @@ @foreach function where('{funcDispatchType}' == 'device' and '{funcReturn}' != 'void' and '{funcName}' not in ['vkDestroyDevice', 'vkEnumerateInstanceExtensionProperties', 'vkEnumerateInstanceLayerProperties', 'vkQueuePresentKHR', 'vkGetDeviceProcAddr']) VK_LAYER_EXPORT VKAPI_ATTR {funcReturn} VKAPI_CALL {funcName}({funcTypedParams}) {{ - dump_head_{funcName}(ApiDumpInstance::current(), {funcNamedParams}); + ApiDumpInstance::current().outputMutex()->lock(); + @if('{funcName}' == 'vkDebugMarkerSetObjectNameEXT') + if (pNameInfo->pObjectName) + ApiDumpInstance::current().object_name_map.insert(std::make_pair((uint64_t &&)pNameInfo->object, pNameInfo->pObjectName)); + else + ApiDumpInstance::current().object_name_map.erase(pNameInfo->object); + @end if + @if('{funcName}' == 'vkSetDebugUtilsObjectNameEXT') + if (pNameInfo->pObjectName) + ApiDumpInstance::current().object_name_map.insert(std::make_pair((uint64_t &&)pNameInfo->objectHandle, pNameInfo->pObjectName)); + else + ApiDumpInstance::current().object_name_map.erase(pNameInfo->objectHandle); + @end if + if (ApiDumpInstance::current().shouldDumpOutput()) {{ + switch(ApiDumpInstance::current().settings().format()) + {{ + case ApiDumpFormat::Text: + dump_text_function_head(ApiDumpInstance::current(), \"{funcName}({funcNamedParams})\", \"{funcReturn}\"); + break; + case ApiDumpFormat::Html: + dump_html_function_head(ApiDumpInstance::current(), \"{funcName}({funcNamedParams})\", \"{funcReturn}\"); + break; + case ApiDumpFormat::Json: + dump_json_function_head(ApiDumpInstance::current(), \"{funcName}\", \"{funcReturn}\"); + break; + }} + }} {funcReturn} result = device_dispatch_table({funcDispatchParam})->{funcShortName}({funcNamedParams}); {funcStateTrackingCode} - dump_body_{funcName}(ApiDumpInstance::current(), result, {funcNamedParams}); + if (ApiDumpInstance::current().shouldDumpOutput()) {{ + switch(ApiDumpInstance::current().settings().format()) + {{ + case ApiDumpFormat::Text: + dump_text_{funcName}(ApiDumpInstance::current(), result, {funcNamedParams}); + break; + case ApiDumpFormat::Html: + dump_html_{funcName}(ApiDumpInstance::current(), result, {funcNamedParams}); + break; + case ApiDumpFormat::Json: + dump_json_{funcName}(ApiDumpInstance::current(), result, {funcNamedParams}); + break; + }} + }} + ApiDumpInstance::current().outputMutex()->unlock(); return result; }} @end function @@ -442,16 +480,58 @@ @foreach function where('{funcDispatchType}' == 'device' and '{funcReturn}' == 'void' and '{funcName}' not in ['vkDestroyDevice', 'vkEnumerateInstanceExtensionProperties', 'vkEnumerateInstanceLayerProperties', 'vkGetDeviceProcAddr']) VK_LAYER_EXPORT VKAPI_ATTR {funcReturn} VKAPI_CALL {funcName}({funcTypedParams}) {{ - dump_head_{funcName}(ApiDumpInstance::current(), {funcNamedParams}); + ApiDumpInstance::current().outputMutex()->lock(); + if (ApiDumpInstance::current().shouldDumpOutput()) {{ + switch(ApiDumpInstance::current().settings().format()) + {{ + case ApiDumpFormat::Text: + dump_text_function_head(ApiDumpInstance::current(), \"{funcName}({funcNamedParams})\", \"{funcReturn}\"); + break; + case ApiDumpFormat::Html: + dump_html_function_head(ApiDumpInstance::current(), \"{funcName}({funcNamedParams})\", \"{funcReturn}\"); + break; + case ApiDumpFormat::Json: + dump_json_function_head(ApiDumpInstance::current(), \"{funcName}\", \"{funcReturn}\"); + break; + }} + }} device_dispatch_table({funcDispatchParam})->{funcShortName}({funcNamedParams}); {funcStateTrackingCode} - dump_body_{funcName}(ApiDumpInstance::current(), {funcNamedParams}); + if (ApiDumpInstance::current().shouldDumpOutput()) {{ + switch(ApiDumpInstance::current().settings().format()) + {{ + case ApiDumpFormat::Text: + dump_text_{funcName}(ApiDumpInstance::current(), {funcNamedParams}); + break; + case ApiDumpFormat::Html: + dump_html_{funcName}(ApiDumpInstance::current(), {funcNamedParams}); + break; + case ApiDumpFormat::Json: + dump_json_{funcName}(ApiDumpInstance::current(), {funcNamedParams}); + break; + }} + }} + ApiDumpInstance::current().outputMutex()->unlock(); }} @end function VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkGetPhysicalDeviceToolPropertiesEXT(VkPhysicalDevice physicalDevice, uint32_t *pToolCount, VkPhysicalDeviceToolPropertiesEXT *pToolProperties) {{ - dump_head_vkGetPhysicalDeviceToolPropertiesEXT(ApiDumpInstance::current(), physicalDevice, pToolCount, pToolProperties); + ApiDumpInstance::current().outputMutex()->lock(); + if (ApiDumpInstance::current().shouldDumpOutput()) {{ + switch(ApiDumpInstance::current().settings().format()) + {{ + case ApiDumpFormat::Text: + dump_text_function_head(ApiDumpInstance::current(), \"vkGetPhysicalDeviceToolPropertiesEXT(physicalDevice, pToolCount, pToolProperties)\", \"VkResult\"); + break; + case ApiDumpFormat::Html: + dump_html_function_head(ApiDumpInstance::current(), \"vkGetPhysicalDeviceToolPropertiesEXT(physicalDevice, pToolCount, pToolProperties)\", \"VkResult\"); + break; + case ApiDumpFormat::Json: + dump_json_function_head(ApiDumpInstance::current(), \"vkGetPhysicalDeviceToolPropertiesEXT\", \"VkResult\"); + break; + }} + }} static const VkPhysicalDeviceToolPropertiesEXT api_dump_layer_tool_props = {{ VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_TOOL_PROPERTIES_EXT, nullptr, @@ -476,7 +556,20 @@ }} (*pToolCount)++; - dump_body_vkGetPhysicalDeviceToolPropertiesEXT(ApiDumpInstance::current(), result, physicalDevice, pToolCount, pToolProperties); + if (ApiDumpInstance::current().shouldDumpOutput()) {{ + switch(ApiDumpInstance::current().settings().format()) + {{ + case ApiDumpFormat::Text: + dump_text_vkGetPhysicalDeviceToolPropertiesEXT(ApiDumpInstance::current(), result, physicalDevice, pToolCount, pToolProperties); + break; + case ApiDumpFormat::Html: + dump_html_vkGetPhysicalDeviceToolPropertiesEXT(ApiDumpInstance::current(), result, physicalDevice, pToolCount, pToolProperties); + break; + case ApiDumpFormat::Json: + dump_json_vkGetPhysicalDeviceToolPropertiesEXT(ApiDumpInstance::current(), result, physicalDevice, pToolCount, pToolProperties); + break; + }} + }} return result; }} @@ -889,34 +982,12 @@ //========================= Function Implementations ========================// -@foreach function where('{funcName}' not in ['vkGetDeviceProcAddr', 'vkGetInstanceProcAddr']) -std::ostream& dump_text_head_{funcName}(ApiDumpInstance& dump_inst, {funcTypedParams}) -{{ - const ApiDumpSettings& settings(dump_inst.settings()); - if (settings.showThreadAndFrame()) {{ - settings.stream() << "Thread " << dump_inst.threadID() << ", Frame " << dump_inst.frameCount(); - }} - if(settings.showTimestamp() && settings.showThreadAndFrame()) {{ - settings.stream() << ", "; - }} - if (settings.showTimestamp()) {{ - settings.stream() << "Time " << dump_inst.current_time_since_start().count() << " us"; - }} - if (settings.showTimestamp() || settings.showThreadAndFrame()) {{ - settings.stream() << ":\\n"; - }} - settings.stream() << "{funcName}({funcNamedParams}) returns {funcReturn}"; - - return settings.shouldFlush() ? settings.stream() << std::flush : settings.stream(); -}} -@end function - @foreach function where('{funcName}' not in ['vkGetDeviceProcAddr', 'vkGetInstanceProcAddr']) @if('{funcReturn}' != 'void') -std::ostream& dump_text_body_{funcName}(ApiDumpInstance& dump_inst, {funcReturn} result, {funcTypedParams}) +std::ostream& dump_text_{funcName}(ApiDumpInstance& dump_inst, {funcReturn} result, {funcTypedParams}) @end if @if('{funcReturn}' == 'void') -std::ostream& dump_text_body_{funcName}(ApiDumpInstance& dump_inst, {funcTypedParams}) +std::ostream& dump_text_{funcName}(ApiDumpInstance& dump_inst, {funcTypedParams}) @end if {{ const ApiDumpSettings& settings(dump_inst.settings()); @@ -1313,28 +1384,12 @@ //========================= Function Implementations ========================// -@foreach function where('{funcName}' not in ['vkGetDeviceProcAddr', 'vkGetInstanceProcAddr']) -std::ostream& dump_html_head_{funcName}(ApiDumpInstance& dump_inst, {funcTypedParams}) -{{ - const ApiDumpSettings& settings(dump_inst.settings()); - if (settings.showThreadAndFrame()){{ - settings.stream() << "
Thread: " << dump_inst.threadID() << "
"; - }} - if(settings.showTimestamp()) - settings.stream() << "
Time: " << dump_inst.current_time_since_start().count() << " us
"; - settings.stream() << "
"; - dump_html_nametype(settings.stream(), settings.showType(), "{funcName}({funcNamedParams})", "{funcReturn}"); - - return settings.shouldFlush() ? settings.stream() << std::flush : settings.stream(); -}} -@end function - @foreach function where('{funcName}' not in ['vkGetDeviceProcAddr', 'vkGetInstanceProcAddr']) @if('{funcReturn}' != 'void') -std::ostream& dump_html_body_{funcName}(ApiDumpInstance& dump_inst, {funcReturn} result, {funcTypedParams}) +std::ostream& dump_html_{funcName}(ApiDumpInstance& dump_inst, {funcReturn} result, {funcTypedParams}) @end if @if('{funcReturn}' == 'void') -std::ostream& dump_html_body_{funcName}(ApiDumpInstance& dump_inst, {funcTypedParams}) +std::ostream& dump_html_{funcName}(ApiDumpInstance& dump_inst, {funcTypedParams}) @end if {{ const ApiDumpSettings& settings(dump_inst.settings()); @@ -1758,43 +1813,13 @@ static bool needFuncComma = false; -@foreach function where(not '{funcName}' in ['vkGetDeviceProcAddr', 'vkGetInstanceProcAddr']) -std::ostream& dump_json_head_{funcName}(ApiDumpInstance& dump_inst, {funcTypedParams}) -{{ - const ApiDumpSettings& settings(dump_inst.settings()); - - if(dump_inst.firstFunctionCallOnFrame()) - needFuncComma = false; - - if (needFuncComma) settings.stream() << ",\\n"; - - // Display apicall name - settings.stream() << settings.indentation(2) << "{{\\n"; - settings.stream() << settings.indentation(3) << "\\\"name\\\" : \\\"{funcName}\\\",\\n"; - - // Display thread info - if (settings.showThreadAndFrame()){{ - settings.stream() << settings.indentation(3) << "\\\"thread\\\" : \\\"Thread " << dump_inst.threadID() << "\\\",\\n"; - }} - - // Display elapsed time - if(settings.showTimestamp()) {{ - settings.stream() << settings.indentation(3) << "\\\"time\\\" : \\\""<< dump_inst.current_time_since_start().count() << " us\\\",\\n"; - }} - - // Display return value - settings.stream() << settings.indentation(3) << "\\\"returnType\\\" : " << "\\\"{funcReturn}\\\",\\n"; - - return settings.shouldFlush() ? settings.stream() << std::flush : settings.stream(); -}} -@end function @foreach function where(not '{funcName}' in ['vkGetDeviceProcAddr', 'vkGetInstanceProcAddr']) @if('{funcReturn}' != 'void') -std::ostream& dump_json_body_{funcName}(ApiDumpInstance& dump_inst, {funcReturn} result, {funcTypedParams}) +std::ostream& dump_json_{funcName}(ApiDumpInstance& dump_inst, {funcReturn} result, {funcTypedParams}) @end if @if('{funcReturn}' == 'void') -std::ostream& dump_json_body_{funcName}(ApiDumpInstance& dump_inst, {funcTypedParams}) +std::ostream& dump_json_{funcName}(ApiDumpInstance& dump_inst, {funcTypedParams}) @end if {{ const ApiDumpSettings& settings(dump_inst.settings()); From 0e69686d7004d03e43e1ffd14344709c7bfb0437 Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Fri, 18 Nov 2022 22:44:40 -0700 Subject: [PATCH 031/154] apidump: Remove unsued std::ostream& return type Returning the stream did not serve any purpose as the stream could be easily accessed from the ApiDumpSettings which gets passed into every printing function. This cleans up a lot of the code to be a lot clearer since it is a form of dead code elimination. --- layersvt/api_dump.h | 149 +++++++-------- scripts/api_dump_generator.py | 328 +++++++++++++++------------------- 2 files changed, 211 insertions(+), 266 deletions(-) diff --git a/layersvt/api_dump.h b/layersvt/api_dump.h index 57f4cfea5f..20f7114294 100644 --- a/layersvt/api_dump.h +++ b/layersvt/api_dump.h @@ -522,7 +522,7 @@ class ApiDumpSettings { ApiDumpFormat format() const { return output_format; } - std::ostream &formatNameType(std::ostream &stream, int indents, const char *name, const char *type) const { + void formatNameType(std::ostream &stream, int indents, const char *name, const char *type) const { stream << indentation(indents) << name << ": "; if (use_spaces) stream << std::setw(name_size - (int)strlen(name) - 2) << ""; @@ -537,7 +537,6 @@ class ApiDumpSettings { } else { stream << " = "; } - return stream; } inline const char *indentation(int indents) const { @@ -887,9 +886,20 @@ void OutputAddress(const ApiDumpSettings &settings, const void *addr, bool quote ApiDumpInstance ApiDumpInstance::current_instance; +//===================================== Common Printers ==========================================// + +bool dump_bitmaskOption(const std::string &option, std::ostream &stream, bool isFirst) { + if (isFirst) + stream << " ("; + else + stream << " | "; + stream << option; + return false; +} + //==================================== Text Backend Helpers ======================================// -std::ostream &dump_text_function_head(ApiDumpInstance &dump_inst, const char *funcName, const char *funcReturn) { +void dump_text_function_head(ApiDumpInstance &dump_inst, const char *funcName, const char *funcReturn) { const ApiDumpSettings &settings(dump_inst.settings()); if (settings.showThreadAndFrame()) { settings.stream() << "Thread " << dump_inst.threadID() << ", Frame " << dump_inst.frameCount(); @@ -905,12 +915,12 @@ std::ostream &dump_text_function_head(ApiDumpInstance &dump_inst, const char *fu } settings.stream() << funcName << " returns " << funcReturn; - return settings.shouldFlush() ? settings.stream() << std::flush : settings.stream(); + settings.shouldFlush() ? settings.stream() << std::flush : settings.stream(); } template void dump_text_array(const T *array, size_t len, const ApiDumpSettings &settings, const char *type_string, const char *child_type, - const char *name, int indents, std::ostream &(*dump)(const T, const ApiDumpSettings &, int)) { + const char *name, int indents, void (*dump)(const T, const ApiDumpSettings &, int)) { settings.formatNameType(settings.stream(), indents, name, type_string); if (array == NULL) { settings.stream() << "NULL\n"; @@ -928,7 +938,7 @@ void dump_text_array(const T *array, size_t len, const ApiDumpSettings &settings template void dump_text_array(const T *array, size_t len, const ApiDumpSettings &settings, const char *type_string, const char *child_type, - const char *name, int indents, std::ostream &(*dump)(const T &, const ApiDumpSettings &, int)) { + const char *name, int indents, void (*dump)(const T &, const ApiDumpSettings &, int)) { settings.formatNameType(settings.stream(), indents, name, type_string); if (array == NULL) { settings.stream() << "NULL\n"; @@ -946,7 +956,7 @@ void dump_text_array(const T *array, size_t len, const ApiDumpSettings &settings template void dump_text_pointer(const T *pointer, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents, - std::ostream &(*dump)(const T, const ApiDumpSettings &, int)) { + void (*dump)(const T, const ApiDumpSettings &, int)) { if (pointer == NULL) { settings.formatNameType(settings.stream(), indents, name, type_string); settings.stream() << "NULL\n"; @@ -957,7 +967,7 @@ void dump_text_pointer(const T *pointer, const ApiDumpSettings &settings, const template void dump_text_pointer(const T *pointer, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents, - std::ostream &(*dump)(const T &, const ApiDumpSettings &, int)) { + void (*dump)(const T &, const ApiDumpSettings &, int)) { if (pointer == NULL) { settings.formatNameType(settings.stream(), indents, name, type_string); settings.stream() << "NULL\n"; @@ -968,14 +978,15 @@ void dump_text_pointer(const T *pointer, const ApiDumpSettings &settings, const template void dump_text_value(const T object, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents, - std::ostream &(*dump)(const T, const ApiDumpSettings &, int)) { + void (*dump)(const T, const ApiDumpSettings &, int)) { settings.formatNameType(settings.stream(), indents, name, type_string); - dump(object, settings, indents) << "\n"; + dump(object, settings, indents); + settings.stream() << "\n"; } template void dump_text_value(const T &object, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents, - std::ostream &(*dump)(const T &, const ApiDumpSettings &, int)) { + void (*dump)(const T &, const ApiDumpSettings &, int)) { settings.formatNameType(settings.stream(), indents, name, type_string); dump(object, settings, indents); } @@ -985,33 +996,27 @@ void dump_text_special(const char *text, const ApiDumpSettings &settings, const settings.stream() << text << "\n"; } -bool dump_text_bitmaskOption(const std::string &option, std::ostream &stream, bool isFirst) { - if (isFirst) - stream << " ("; - else - stream << " | "; - stream << option; - return false; -} - -std::ostream &dump_text_cstring(const char *object, const ApiDumpSettings &settings, int indents) { +void dump_text_cstring(const char *object, const ApiDumpSettings &settings, int indents) { if (object == NULL) - return settings.stream() << "NULL"; + settings.stream() << "NULL"; else - return settings.stream() << "\"" << object << "\""; + settings.stream() << "\"" << object << "\""; } -std::ostream &dump_text_void(const void *object, const ApiDumpSettings &settings, int indents) { - if (object == NULL) return settings.stream() << "NULL"; +void dump_text_void(const void *object, const ApiDumpSettings &settings, int indents) { + if (object == NULL) { + settings.stream() << "NULL"; + return; + } OutputAddress(settings, object, false); - return settings.stream(); + settings.stream(); } -std::ostream &dump_text_int(int object, const ApiDumpSettings &settings, int indents) { return settings.stream() << object; } +void dump_text_int(int object, const ApiDumpSettings &settings, int indents) { settings.stream() << object; } template void dump_text_pNext(const T *object, const ApiDumpSettings &settings, const char *type_string, int indents, - std::ostream &(*dump)(const T &, const ApiDumpSettings &, int)) { + void (*dump)(const T &, const ApiDumpSettings &, int)) { if (object == NULL) settings.stream() << "NULL"; else if (settings.showAddress()) { @@ -1023,15 +1028,14 @@ void dump_text_pNext(const T *object, const ApiDumpSettings &settings, const cha //==================================== Html Backend Helpers ======================================// -std::ostream &dump_html_nametype(std::ostream &stream, bool showType, const char *name, const char *type) { +void dump_html_nametype(std::ostream &stream, bool showType, const char *name, const char *type) { stream << "
" << name << "
"; if (showType) { stream << "
" << type << "
"; } - return stream; } -std::ostream &dump_html_function_head(ApiDumpInstance &dump_inst, const char *funcName, const char *funcReturn) { +void dump_html_function_head(ApiDumpInstance &dump_inst, const char *funcName, const char *funcReturn) { const ApiDumpSettings &settings(dump_inst.settings()); if (settings.showThreadAndFrame()) { settings.stream() << "
Thread: " << dump_inst.threadID() << "
"; @@ -1040,17 +1044,16 @@ std::ostream &dump_html_function_head(ApiDumpInstance &dump_inst, const char *fu settings.stream() << "
Time: " << dump_inst.current_time_since_start().count() << " us
"; settings.stream() << "
"; dump_html_nametype(settings.stream(), settings.showType(), funcName, funcReturn); - return settings.shouldFlush() ? settings.stream() << std::flush : settings.stream(); + settings.shouldFlush() ? settings.stream() << std::flush : settings.stream(); } template void dump_html_array(const T *array, size_t len, const ApiDumpSettings &settings, const char *type_string, const char *child_type, - const char *name, int indents, std::ostream &(*dump)(const T, const ApiDumpSettings &, int)) { + const char *name, int indents, void (*dump)(const T, const ApiDumpSettings &, int)) { if (array == NULL) { settings.stream() << "
"; dump_html_nametype(settings.stream(), settings.showType(), name, type_string); - settings.stream() << "
"; - settings.stream() << "NULL
"; + settings.stream() << "
NULL
"; return; } settings.stream() << "
"; @@ -1070,12 +1073,11 @@ void dump_html_array(const T *array, size_t len, const ApiDumpSettings &settings template void dump_html_array(const T *array, size_t len, const ApiDumpSettings &settings, const char *type_string, const char *child_type, - const char *name, int indents, std::ostream &(*dump)(const T &, const ApiDumpSettings &, int)) { + const char *name, int indents, void (*dump)(const T &, const ApiDumpSettings &, int)) { if (array == NULL) { settings.stream() << "
"; dump_html_nametype(settings.stream(), settings.showType(), name, type_string); - settings.stream() << "
"; - settings.stream() << "NULL
"; + settings.stream() << "
NULL
"; return; } settings.stream() << "
"; @@ -1095,7 +1097,7 @@ void dump_html_array(const T *array, size_t len, const ApiDumpSettings &settings template void dump_html_pointer(const T *pointer, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents, - std::ostream &(*dump)(const T, const ApiDumpSettings &, int)) { + void (*dump)(const T, const ApiDumpSettings &, int)) { if (pointer == NULL) { settings.stream() << "
"; dump_html_nametype(settings.stream(), settings.showType(), name, type_string); @@ -1107,7 +1109,7 @@ void dump_html_pointer(const T *pointer, const ApiDumpSettings &settings, const template void dump_html_pointer(const T *pointer, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents, - std::ostream &(*dump)(const T &, const ApiDumpSettings &, int)) { + void (*dump)(const T &, const ApiDumpSettings &, int)) { if (pointer == NULL) { settings.stream() << "
"; dump_html_nametype(settings.stream(), settings.showType(), name, type_string); @@ -1119,7 +1121,7 @@ void dump_html_pointer(const T *pointer, const ApiDumpSettings &settings, const template void dump_html_value(const T object, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents, - std::ostream &(*dump)(const T, const ApiDumpSettings &, int)) { + void (*dump)(const T, const ApiDumpSettings &, int)) { settings.stream() << "
"; dump_html_nametype(settings.stream(), settings.showType(), name, type_string); dump(object, settings, indents); @@ -1128,7 +1130,7 @@ void dump_html_value(const T object, const ApiDumpSettings &settings, const char template void dump_html_value(const T &object, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents, - std::ostream &(*dump)(const T &, const ApiDumpSettings &, int)) { + void (*dump)(const T &, const ApiDumpSettings &, int)) { settings.stream() << "
"; dump_html_nametype(settings.stream(), settings.showType(), name, type_string); dump(object, settings, indents); @@ -1141,39 +1143,30 @@ void dump_html_special(const char *text, const ApiDumpSettings &settings, const settings.stream() << "
" << text << "
"; } -bool dump_html_bitmaskOption(const std::string &option, std::ostream &stream, bool isFirst) { - if (isFirst) - stream << " ("; - else - stream << " | "; - stream << option; - return false; -} - -std::ostream &dump_html_cstring(const char *object, const ApiDumpSettings &settings, int indents) { +void dump_html_cstring(const char *object, const ApiDumpSettings &settings, int indents) { settings.stream() << "
"; if (object == NULL) settings.stream() << "NULL"; else settings.stream() << "\"" << object << "\""; - return settings.stream() << "
"; + settings.stream() << "
"; } -std::ostream &dump_html_void(const void *object, const ApiDumpSettings &settings, int indents) { +void dump_html_void(const void *object, const ApiDumpSettings &settings, int indents) { settings.stream() << "
"; OutputAddress(settings, object, false); - return settings.stream() << "
"; + settings.stream() << "
"; } -std::ostream &dump_html_int(int object, const ApiDumpSettings &settings, int indents) { +void dump_html_int(int object, const ApiDumpSettings &settings, int indents) { settings.stream() << "
"; settings.stream() << object; - return settings.stream() << "
"; + settings.stream() << "
"; } template void dump_html_pNext(const T *object, const ApiDumpSettings &settings, const char *type_string, int indents, - std::ostream &(*dump)(const T &, const ApiDumpSettings &, int)) { + void (*dump)(const T &, const ApiDumpSettings &, int)) { if (object == NULL) { settings.stream() << "
"; dump_html_nametype(settings.stream(), settings.showType(), "pNext", type_string); @@ -1185,7 +1178,7 @@ void dump_html_pNext(const T *object, const ApiDumpSettings &settings, const cha //==================================== Json Backend Helpers ======================================// -std::ostream &dump_json_function_head(ApiDumpInstance &dump_inst, const char *funcName, const char *funcReturn) { +void dump_json_function_head(ApiDumpInstance &dump_inst, const char *funcName, const char *funcReturn) { const ApiDumpSettings &settings(dump_inst.settings()); if (!dump_inst.firstFunctionCallOnFrame()) settings.stream() << ",\n"; @@ -1210,12 +1203,12 @@ std::ostream &dump_json_function_head(ApiDumpInstance &dump_inst, const char *fu // Display return value settings.stream() << settings.indentation(3) << "\"returnType\" : \"" << funcReturn << "\",\n"; - return settings.shouldFlush() ? settings.stream() << std::flush : settings.stream(); + settings.shouldFlush() ? settings.stream() << std::flush : settings.stream(); } template void dump_json_array(const T *array, size_t len, const ApiDumpSettings &settings, const char *type_string, const char *child_type, - const char *name, int indents, std::ostream &(*dump)(const T, const ApiDumpSettings &, int)) { + const char *name, int indents, void (*dump)(const T, const ApiDumpSettings &, int)) { if (len == 0 || array == NULL) { settings.stream() << settings.indentation(indents) << "{\n"; settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << "\",\n"; @@ -1251,7 +1244,7 @@ void dump_json_array(const T *array, size_t len, const ApiDumpSettings &settings template void dump_json_array(const T *array, size_t len, const ApiDumpSettings &settings, const char *type_string, const char *child_type, - const char *name, int indents, std::ostream &(*dump)(const T &, const ApiDumpSettings &, int)) { + const char *name, int indents, void (*dump)(const T &, const ApiDumpSettings &, int)) { if (len == 0 || array == NULL) { settings.stream() << settings.indentation(indents) << "{\n"; settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << "\",\n"; @@ -1286,7 +1279,7 @@ void dump_json_array(const T *array, size_t len, const ApiDumpSettings &settings template void dump_json_pointer(const T *pointer, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents, - std::ostream &(*dump)(const T, const ApiDumpSettings &, int)) { + void (*dump)(const T, const ApiDumpSettings &, int)) { if (pointer == NULL) { settings.stream() << settings.indentation(indents) << "{\n"; settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << "\",\n"; @@ -1302,7 +1295,7 @@ void dump_json_pointer(const T *pointer, const ApiDumpSettings &settings, const template void dump_json_pointer(const T *pointer, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents, - std::ostream &(*dump)(const T &, const ApiDumpSettings &, int)) { + void (*dump)(const T &, const ApiDumpSettings &, int)) { if (pointer == NULL) { settings.stream() << settings.indentation(indents) << "{\n"; settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << "\",\n"; @@ -1321,7 +1314,7 @@ extern bool is_struct(const char *t); template void dump_json_value(const T object, const void *pObject, const ApiDumpSettings &settings, const char *type_string, - const char *name, int indents, std::ostream &(*dump)(const T, const ApiDumpSettings &, int)) { + const char *name, int indents, void (*dump)(const T, const ApiDumpSettings &, int)) { bool isPnext = !strcmp(name, "pNext") | !strcmp(name, "pUserData"); const char *star = (isPnext && !strstr(type_string, "void")) ? "*" : ""; settings.stream() << settings.indentation(indents) << "{\n"; @@ -1349,7 +1342,7 @@ void dump_json_value(const T object, const void *pObject, const ApiDumpSettings template void dump_json_value(const T &object, const void *pObject, const ApiDumpSettings &settings, const char *type_string, - const char *name, int indents, std::ostream &(*dump)(const T &, const ApiDumpSettings &, int)) { + const char *name, int indents, void (*dump)(const T &, const ApiDumpSettings &, int)) { bool isPnext = !strcmp(name, "pNext") | !strcmp(name, "pUserData"); const char *star = (isPnext && !strstr(type_string, "void")) ? "*" : ""; settings.stream() << settings.indentation(indents) << "{\n"; @@ -1387,38 +1380,28 @@ void dump_json_special(const char *text, const ApiDumpSettings &settings, const settings.stream() << settings.indentation(indents) << "}"; } -bool dump_json_bitmaskOption(const std::string &option, std::ostream &stream, bool isFirst) { - if (isFirst) - stream << "("; - else - stream << " | "; - stream << option; - return false; -} - -std::ostream &dump_json_cstring(const char *object, const ApiDumpSettings &settings, int indents) { +void dump_json_cstring(const char *object, const ApiDumpSettings &settings, int indents) { if (object == NULL) settings.stream() << "\"\""; else settings.stream() << "\"" << object << "\""; - return settings.stream(); } -std::ostream &dump_json_void(const void *object, const ApiDumpSettings &settings, int indents) { +void dump_json_void(const void *object, const ApiDumpSettings &settings, int indents) { OutputAddress(settings, object, true); settings.stream() << "\n"; - return settings.stream(); + settings.stream(); } -std::ostream &dump_json_int(int object, const ApiDumpSettings &settings, int indents) { +void dump_json_int(int object, const ApiDumpSettings &settings, int indents) { settings.stream() << settings.indentation(indents) << "\"value\" : "; settings.stream() << '"' << object << "\""; - return settings.stream(); + settings.stream(); } template void dump_json_pNext(const T *object, const ApiDumpSettings &settings, const char *type_string, int indents, - std::ostream &(*dump)(const T, const ApiDumpSettings &, int)) { + void (*dump)(const T, const ApiDumpSettings &, int)) { if (object == NULL) { settings.stream() << settings.indentation(indents) << "{\n"; settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << "*\",\n"; @@ -1436,7 +1419,7 @@ void dump_json_pNext(const T *object, const ApiDumpSettings &settings, const cha template void dump_json_pNext(const T *object, const ApiDumpSettings &settings, const char *type_string, int indents, - std::ostream &(*dump)(const T &, const ApiDumpSettings &, int)) { + void (*dump)(const T &, const ApiDumpSettings &, int)) { if (object == NULL) { settings.stream() << settings.indentation(indents) << "{\n"; settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << "*\",\n"; diff --git a/scripts/api_dump_generator.py b/scripts/api_dump_generator.py index b5147fc1af..acc62dc96e 100644 --- a/scripts/api_dump_generator.py +++ b/scripts/api_dump_generator.py @@ -629,92 +629,94 @@ #include "api_dump.h" @foreach struct -std::ostream& dump_text_{sctName}(const {sctName}& object, const ApiDumpSettings& settings, int indents); +void dump_text_{sctName}(const {sctName}& object, const ApiDumpSettings& settings, int indents); @end struct @foreach union -std::ostream& dump_text_{unName}(const {unName}& object, const ApiDumpSettings& settings, int indents); +void dump_text_{unName}(const {unName}& object, const ApiDumpSettings& settings, int indents); @end union //============================= typedefs ==============================// // Functions for dumping typedef types that the codegen scripting can't handle #if defined(VK_ENABLE_BETA_EXTENSIONS) -std::ostream& dump_text_VkAccelerationStructureTypeKHR(VkAccelerationStructureTypeKHR object, const ApiDumpSettings& settings, int indents); -std::ostream& dump_text_VkAccelerationStructureTypeNV(VkAccelerationStructureTypeNV object, const ApiDumpSettings& settings, int indents) +void dump_text_VkAccelerationStructureTypeKHR(VkAccelerationStructureTypeKHR object, const ApiDumpSettings& settings, int indents); +void dump_text_VkAccelerationStructureTypeNV(VkAccelerationStructureTypeNV object, const ApiDumpSettings& settings, int indents) {{ - return dump_text_VkAccelerationStructureTypeKHR(object, settings, indents); + dump_text_VkAccelerationStructureTypeKHR(object, settings, indents); }} -std::ostream& dump_text_VkBuildAccelerationStructureFlagsKHR(VkBuildAccelerationStructureFlagsKHR object, const ApiDumpSettings& settings, int indents); -std::ostream& dump_text_VkBuildAccelerationStructureFlagsNV(VkBuildAccelerationStructureFlagsNV object, const ApiDumpSettings& settings, int indents) +void dump_text_VkBuildAccelerationStructureFlagsKHR(VkBuildAccelerationStructureFlagsKHR object, const ApiDumpSettings& settings, int indents); +void dump_text_VkBuildAccelerationStructureFlagsNV(VkBuildAccelerationStructureFlagsNV object, const ApiDumpSettings& settings, int indents) {{ - return dump_text_VkBuildAccelerationStructureFlagsKHR(object, settings, indents); + dump_text_VkBuildAccelerationStructureFlagsKHR(object, settings, indents); }} #endif // VK_ENABLE_BETA_EXTENSIONS - //======================== pNext Chain Implementation =======================// -std::ostream& dump_text_pNext_trampoline(const void* object, const ApiDumpSettings& settings, int indents) +void dump_text_pNext_struct_name(const void* object, const ApiDumpSettings& settings, int indents) {{ + if (object == nullptr) {{ + dump_text_value(object, settings, "const void*", "pNext", indents, dump_text_void); + return; + }} + switch((int64_t) (static_cast(object)->sType)) {{ @foreach struct @if({sctStructureTypeIndex} != -1) case {sctStructureTypeIndex}: - dump_text_pNext(static_cast(object), settings, "{sctName}", indents, dump_text_{sctName}); + settings.formatNameType(settings.stream(), indents, "pNext", "const void*"); + settings.stream() << "{sctName}\\n"; break; @end if @end struct case 47: // VK_STRUCTURE_TYPE_LOADER_INSTANCE_CREATE_INFO case 48: // VK_STRUCTURE_TYPE_LOADER_DEVICE_CREATE_INFO - if(static_cast(object)->pNext != nullptr){{ - dump_text_pNext_trampoline(static_cast(static_cast(object)->pNext), settings, indents); - }} else {{ - settings.formatNameType(settings.stream(), indents, "pNext", "const void*"); - settings.stream() << "NULL\\n"; - }} + settings.formatNameType(settings.stream(), indents, "pNext", "const void*"); + settings.stream() << "NULL\\n"; break; default: settings.formatNameType(settings.stream(), indents, "pNext", "const void*"); settings.stream() << "UNKNOWN (" << (int64_t) (static_cast(object)->sType) << ")\\n"; }} - return settings.stream(); }} -std::ostream& dump_text_pNext_struct_name(const void* object, const ApiDumpSettings& settings, int indents) +void dump_text_pNext_trampoline(const void* object, const ApiDumpSettings& settings, int indents) {{ switch((int64_t) (static_cast(object)->sType)) {{ @foreach struct @if({sctStructureTypeIndex} != -1) case {sctStructureTypeIndex}: - settings.formatNameType(settings.stream(), indents, "pNext", "const void*"); - settings.stream() << "{sctName}\\n"; + dump_text_pNext(static_cast(object), settings, "{sctName}", indents, dump_text_{sctName}); break; @end if @end struct case 47: // VK_STRUCTURE_TYPE_LOADER_INSTANCE_CREATE_INFO case 48: // VK_STRUCTURE_TYPE_LOADER_DEVICE_CREATE_INFO - settings.formatNameType(settings.stream(), indents, "pNext", "const void*"); - settings.stream() << "NULL\\n"; + if(static_cast(object)->pNext != nullptr){{ + dump_text_pNext_trampoline(static_cast(static_cast(object)->pNext), settings, indents); + }} else {{ + settings.formatNameType(settings.stream(), indents, "pNext", "const void*"); + settings.stream() << "NULL\\n"; + }} break; default: settings.formatNameType(settings.stream(), indents, "pNext", "const void*"); settings.stream() << "UNKNOWN (" << (int64_t) (static_cast(object)->sType) << ")\\n"; }} - return settings.stream(); }} //=========================== Type Implementations ==========================// @foreach type where('{etyName}' != 'void') -std::ostream& dump_text_{etyName}({etyName} object, const ApiDumpSettings& settings, int indents) +void dump_text_{etyName}({etyName} object, const ApiDumpSettings& settings, int indents) {{ @if('{etyName}' != 'uint8_t') - return settings.stream() << object; + settings.stream() << object; @end if @if('{etyName}' == 'uint8_t') - return settings.stream() << (uint32_t) object; + settings.stream() << (uint32_t) object; @end if }} @end type @@ -722,24 +724,24 @@ //========================= Basetype Implementations ========================// @foreach basetype where(not '{baseName}' in ['ANativeWindow', 'AHardwareBuffer', 'CAMetalLayer']) -std::ostream& dump_text_{baseName}({baseName} object, const ApiDumpSettings& settings, int indents) +void dump_text_{baseName}({baseName} object, const ApiDumpSettings& settings, int indents) {{ - return settings.stream() << object; + settings.stream() << object; }} @end basetype @foreach basetype where('{baseName}' in ['ANativeWindow', 'AHardwareBuffer']) #if defined(VK_USE_PLATFORM_ANDROID_KHR) -std::ostream& dump_text_{baseName}(const {baseName}* object, const ApiDumpSettings& settings, int indents) +void dump_text_{baseName}(const {baseName}* object, const ApiDumpSettings& settings, int indents) {{ - return settings.stream() << object; + settings.stream() << object; }} #endif @end basetype @foreach basetype where('{baseName}' in ['CAMetalLayer']) #if defined(VK_USE_PLATFORM_METAL_EXT) -std::ostream& dump_text_{baseName}({baseName} object, const ApiDumpSettings& settings, int indents) +void dump_text_{baseName}({baseName} object, const ApiDumpSettings& settings, int indents) {{ - return settings.stream() << object; + settings.stream() << object; }} #endif @end basetype @@ -747,16 +749,16 @@ //======================= System Type Implementations =======================// @foreach systype -std::ostream& dump_text_{sysName}(const {sysType} object, const ApiDumpSettings& settings, int indents) +void dump_text_{sysName}(const {sysType} object, const ApiDumpSettings& settings, int indents) {{ - return settings.stream() << object; + settings.stream() << object; }} @end systype //========================== Handle Implementations =========================// @foreach handle -std::ostream& dump_text_{hdlName}(const {hdlName} object, const ApiDumpSettings& settings, int indents) +void dump_text_{hdlName}(const {hdlName} object, const ApiDumpSettings& settings, int indents) {{ if(settings.showAddress()) {{ settings.stream() << object; @@ -768,15 +770,13 @@ }} else {{ settings.stream() << "address"; }} - - return settings.stream(); }} @end handle //=========================== Enum Implementations ==========================// @foreach enum -std::ostream& dump_text_{enumName}({enumName} object, const ApiDumpSettings& settings, int indents) +void dump_text_{enumName}({enumName} object, const ApiDumpSettings& settings, int indents) {{ switch((int64_t) object) {{ @@ -788,7 +788,7 @@ default: settings.stream() << "UNKNOWN ("; }} - return settings.stream() << object << ")"; + settings.stream() << object << ")"; }} @end enum @@ -801,59 +801,58 @@ // only needs to be generated by the first .h file. typedef VkFlags64 {bitName}; @end if -std::ostream& dump_text_{bitName}({bitName} object, const ApiDumpSettings& settings, int indents) +void dump_text_{bitName}({bitName} object, const ApiDumpSettings& settings, int indents) {{ bool is_first = true; //settings.formatNameType(stream, indents, name, type_string) << object; settings.stream() << object; @foreach option @if('{optMultiValue}' != 'None') - if(object == {optValue}) - is_first = dump_text_bitmaskOption("{optName}", settings.stream(), is_first); + if(object == {optValue}) + is_first = dump_bitmaskOption("{optName}", settings.stream(), is_first); @end if @if('{optMultiValue}' == 'None') - if(object & {optValue}) - is_first = dump_text_bitmaskOption("{optName}", settings.stream(), is_first); + if(object & {optValue}) + is_first = dump_bitmaskOption("{optName}", settings.stream(), is_first); @end if @end option if(!is_first) settings.stream() << ")"; - return settings.stream(); }} @end bitmask //=========================== Flag Implementations ==========================// @foreach flag where('{flagEnum}' != 'None') -std::ostream& dump_text_{flagName}({flagName} object, const ApiDumpSettings& settings, int indents) +void dump_text_{flagName}({flagName} object, const ApiDumpSettings& settings, int indents) {{ - return dump_text_{flagEnum}(({flagEnum}) object, settings, indents); + dump_text_{flagEnum}(({flagEnum}) object, settings, indents); }} @end flag @foreach flag where('{flagEnum}' == 'None') -std::ostream& dump_text_{flagName}({flagName} object, const ApiDumpSettings& settings, int indents) +void dump_text_{flagName}({flagName} object, const ApiDumpSettings& settings, int indents) {{ - return settings.stream() << object; + settings.stream() << object; }} @end flag //======================= Func Pointer Implementations ======================// @foreach funcpointer -std::ostream& dump_text_{pfnName}({pfnName} object, const ApiDumpSettings& settings, int indents) +void dump_text_{pfnName}({pfnName} object, const ApiDumpSettings& settings, int indents) {{ if(settings.showAddress()) - return settings.stream() << object; + settings.stream() << object; else - return settings.stream() << "address"; + settings.stream() << "address"; }} @end funcpointer //========================== Struct Implementations =========================// @foreach struct where('{sctName}' not in ['VkPhysicalDeviceMemoryProperties','VkPhysicalDeviceGroupProperties']) -std::ostream& dump_text_{sctName}(const {sctName}& object, const ApiDumpSettings& settings, int indents) +void dump_text_{sctName}(const {sctName}& object, const ApiDumpSettings& settings, int indents) {{ if(settings.showAddress()) settings.stream() << &object << ":\\n"; @@ -872,11 +871,7 @@ dump_text_value(object.{memName}, settings, "{memType}", "{memName}", indents + 1, dump_text_{memTypeID}); // AET @end if @if('{memName}' == 'pNext') - if(object.pNext != nullptr){{ - dump_text_pNext_struct_name(object.{memName}, settings, indents + 1); - }} else {{ - dump_text_value(object.{memName}, settings, "{memType}", "{memName}", indents + 1, dump_text_{memTypeID}); // BET - }} + dump_text_pNext_struct_name(object.{memName}, settings, indents + 1); @end if @end if @if({memPtrLevel} == 1 and '{memLength}' == 'None') @@ -923,11 +918,10 @@ @end if @end if @end member - return settings.stream(); }} @end struct -std::ostream& dump_text_VkPhysicalDeviceMemoryProperties(const VkPhysicalDeviceMemoryProperties& object, const ApiDumpSettings& settings, int indents) +void dump_text_VkPhysicalDeviceMemoryProperties(const VkPhysicalDeviceMemoryProperties& object, const ApiDumpSettings& settings, int indents) {{ if(settings.showAddress()) settings.stream() << &object << ":\\n"; @@ -938,10 +932,9 @@ dump_text_array(object.memoryTypes, object.memoryTypeCount, settings, "VkMemoryType[VK_MAX_MEMORY_TYPES]", "VkMemoryType", "memoryTypes", indents + 1, dump_text_VkMemoryType); // DQA dump_text_value(object.memoryHeapCount, settings, "uint32_t", "memoryHeapCount", indents + 1, dump_text_uint32_t); // GET dump_text_array(object.memoryHeaps, object.memoryHeapCount, settings, "VkMemoryHeap[VK_MAX_MEMORY_HEAPS]", "VkMemoryHeap", "memoryHeaps", indents + 1, dump_text_VkMemoryHeap); // EQA - return settings.stream(); }} -std::ostream& dump_text_VkPhysicalDeviceGroupProperties(const VkPhysicalDeviceGroupProperties& object, const ApiDumpSettings& settings, int indents) +void dump_text_VkPhysicalDeviceGroupProperties(const VkPhysicalDeviceGroupProperties& object, const ApiDumpSettings& settings, int indents) {{ if(settings.showAddress()) settings.stream() << &object << ":\\n"; @@ -952,13 +945,12 @@ dump_text_value(object.physicalDeviceCount, settings, "uint32_t", "physicalDeviceCount", indents + 1, dump_text_uint32_t); // JET dump_text_array(object.physicalDevices, object.physicalDeviceCount, settings, "VkPhysicalDevice[VK_MAX_DEVICE_GROUP_SIZE]", "VkPhysicalDevice", "physicalDevices", indents + 1, dump_text_VkPhysicalDevice); // FQA dump_text_value(object.subsetAllocation, settings, "VkBool32", "subsetAllocation", indents + 1, dump_text_VkBool32); // KET - return settings.stream(); }} //========================== Union Implementations ==========================// @foreach union -std::ostream& dump_text_{unName}(const {unName}& object, const ApiDumpSettings& settings, int indents) +void dump_text_{unName}(const {unName}& object, const ApiDumpSettings& settings, int indents) {{ if(settings.showAddress()) settings.stream() << &object << " (Union):\\n"; @@ -976,7 +968,6 @@ dump_text_array(object.{chcName}, {chcLength}, settings, "{chcType}", "{chcChildType}", "{chcName}", indents + 1, dump_text_{chcTypeID}); // GQA @end if @end choice - return settings.stream(); }} @end union @@ -984,10 +975,10 @@ @foreach function where('{funcName}' not in ['vkGetDeviceProcAddr', 'vkGetInstanceProcAddr']) @if('{funcReturn}' != 'void') -std::ostream& dump_text_{funcName}(ApiDumpInstance& dump_inst, {funcReturn} result, {funcTypedParams}) +void dump_text_{funcName}(ApiDumpInstance& dump_inst, {funcReturn} result, {funcTypedParams}) @end if @if('{funcReturn}' == 'void') -std::ostream& dump_text_{funcName}(ApiDumpInstance& dump_inst, {funcTypedParams}) +void dump_text_{funcName}(ApiDumpInstance& dump_inst, {funcTypedParams}) @end if {{ const ApiDumpSettings& settings(dump_inst.settings()); @@ -1015,8 +1006,6 @@ @end parameter }} settings.shouldFlush() ? settings.stream() << std::endl : settings.stream() << "\\n"; - - return settings.stream(); }} @end function @@ -1058,32 +1047,31 @@ #include "api_dump.h" @foreach struct -std::ostream& dump_html_{sctName}(const {sctName}& object, const ApiDumpSettings& settings, int indents); +void dump_html_{sctName}(const {sctName}& object, const ApiDumpSettings& settings, int indents); @end struct @foreach union -std::ostream& dump_html_{unName}(const {unName}& object, const ApiDumpSettings& settings, int indents); +void dump_html_{unName}(const {unName}& object, const ApiDumpSettings& settings, int indents); @end union //============================= typedefs ==============================// // Functions for dumping typedef types that the codegen scripting can't handle #if defined(VK_ENABLE_BETA_EXTENSIONS) -std::ostream& dump_html_VkAccelerationStructureTypeKHR(VkAccelerationStructureTypeKHR object, const ApiDumpSettings& settings, int indents); -std::ostream& dump_html_VkAccelerationStructureTypeNV(VkAccelerationStructureTypeNV object, const ApiDumpSettings& settings, int indents) +void dump_html_VkAccelerationStructureTypeKHR(VkAccelerationStructureTypeKHR object, const ApiDumpSettings& settings, int indents); +void dump_html_VkAccelerationStructureTypeNV(VkAccelerationStructureTypeNV object, const ApiDumpSettings& settings, int indents) {{ - return dump_html_VkAccelerationStructureTypeKHR(object, settings, indents); + dump_html_VkAccelerationStructureTypeKHR(object, settings, indents); }} -std::ostream& dump_html_VkBuildAccelerationStructureFlagsKHR(VkBuildAccelerationStructureFlagsKHR object, const ApiDumpSettings& settings, int indents); -std::ostream& dump_html_VkBuildAccelerationStructureFlagsNV(VkBuildAccelerationStructureFlagsNV object, const ApiDumpSettings& settings, int indents) +void dump_html_VkBuildAccelerationStructureFlagsKHR(VkBuildAccelerationStructureFlagsKHR object, const ApiDumpSettings& settings, int indents); +void dump_html_VkBuildAccelerationStructureFlagsNV(VkBuildAccelerationStructureFlagsNV object, const ApiDumpSettings& settings, int indents) {{ - return dump_html_VkBuildAccelerationStructureFlagsKHR(object, settings, indents); + dump_html_VkBuildAccelerationStructureFlagsKHR(object, settings, indents); }} #endif // VK_ENABLE_BETA_EXTENSIONS - //======================== pNext Chain Implementation =======================// -std::ostream& dump_html_pNext_trampoline(const void* object, const ApiDumpSettings& settings, int indents) +void dump_html_pNext_trampoline(const void* object, const ApiDumpSettings& settings, int indents) {{ switch((int64_t) (static_cast(object)->sType)) {{ @foreach struct @@ -1109,13 +1097,11 @@ dump_html_nametype(settings.stream(), settings.showType(), "pNext", "const void*"); settings.stream() << "
UNKNOWN (" << (int64_t) (static_cast(object)->sType) <<")
"; }} - return settings.stream(); }} - //=========================== Type Implementations ==========================// @foreach type where('{etyName}' != 'void') -std::ostream& dump_html_{etyName}({etyName} object, const ApiDumpSettings& settings, int indents) +void dump_html_{etyName}({etyName} object, const ApiDumpSettings& settings, int indents) {{ settings.stream() << "
"; @if('{etyName}' != 'uint8_t') @@ -1124,31 +1110,31 @@ @if('{etyName}' == 'uint8_t') settings.stream() << (uint32_t) object; @end if - return settings.stream() << "
"; + settings.stream() << "
"; }} @end type //========================= Basetype Implementations ========================// @foreach basetype where(not '{baseName}' in ['ANativeWindow', 'AHardwareBuffer', 'CAMetalLayer']) -std::ostream& dump_html_{baseName}({baseName} object, const ApiDumpSettings& settings, int indents) +void dump_html_{baseName}({baseName} object, const ApiDumpSettings& settings, int indents) {{ - return settings.stream() << "
" << object << "
"; + settings.stream() << "
" << object << "
"; }} @end basetype @foreach basetype where('{baseName}' in ['ANativeWindow', 'AHardwareBuffer']) #if defined(VK_USE_PLATFORM_ANDROID_KHR) -std::ostream& dump_html_{baseName}(const {baseName}* object, const ApiDumpSettings& settings, int indents) +void dump_html_{baseName}(const {baseName}* object, const ApiDumpSettings& settings, int indents) {{ - return settings.stream() << "
" << object << "
"; + settings.stream() << "
" << object << "
"; }} #endif @end basetype @foreach basetype where('{baseName}' in ['CAMetalLayer']) #if defined(VK_USE_PLATFORM_METAL_EXT) -std::ostream& dump_html_{baseName}({baseName} object, const ApiDumpSettings& settings, int indents) +void dump_html_{baseName}({baseName} object, const ApiDumpSettings& settings, int indents) {{ - return settings.stream() << "
" << object << "
"; + settings.stream() << "
" << object << "
"; }} #endif @end basetype @@ -1156,16 +1142,16 @@ //======================= System Type Implementations =======================// @foreach systype -std::ostream& dump_html_{sysName}(const {sysType} object, const ApiDumpSettings& settings, int indents) +void dump_html_{sysName}(const {sysType} object, const ApiDumpSettings& settings, int indents) {{ - return settings.stream() << "
" << object << "
"; + settings.stream() << "
" << object << "
"; }} @end systype //========================== Handle Implementations =========================// @foreach handle -std::ostream& dump_html_{hdlName}(const {hdlName} object, const ApiDumpSettings& settings, int indents) +void dump_html_{hdlName}(const {hdlName} object, const ApiDumpSettings& settings, int indents) {{ settings.stream() << "
"; if(settings.showAddress()) {{ @@ -1178,14 +1164,14 @@ }} else {{ settings.stream() << "address"; }} - return settings.stream() << "
"; + settings.stream() << ""; }} @end handle //=========================== Enum Implementations ==========================// @foreach enum -std::ostream& dump_html_{enumName}({enumName} object, const ApiDumpSettings& settings, int indents) +void dump_html_{enumName}({enumName} object, const ApiDumpSettings& settings, int indents) {{ settings.stream() << "
"; switch((int64_t) object) @@ -1198,46 +1184,46 @@ default: settings.stream() << "UNKNOWN ("; }} - return settings.stream() << object << ")
"; + settings.stream() << object << ")"; }} @end enum //========================= Bitmask Implementations =========================// @foreach bitmask -std::ostream& dump_html_{bitName}({bitName} object, const ApiDumpSettings& settings, int indents) +void dump_html_{bitName}({bitName} object, const ApiDumpSettings& settings, int indents) {{ settings.stream() << "
"; bool is_first = true; settings.stream() << object; @foreach option @if('{optMultiValue}' != 'None') - if(object == {optValue}) - is_first = dump_html_bitmaskOption("{optName}", settings.stream(), is_first); + if(object == {optValue}) + is_first = dump_bitmaskOption("{optName}", settings.stream(), is_first); @end if @if('{optMultiValue}' == 'None') - if(object & {optValue}) - is_first = dump_html_bitmaskOption("{optName}", settings.stream(), is_first); + if(object & {optValue}) + is_first = dump_bitmaskOption("{optName}", settings.stream(), is_first); @end if @end option if(!is_first) settings.stream() << ")"; - return settings.stream() << "
"; + settings.stream() << ""; }} @end bitmask //=========================== Flag Implementations ==========================// @foreach flag where('{flagEnum}' != 'None') -std::ostream& dump_html_{flagName}({flagName} object, const ApiDumpSettings& settings, int indents) +void dump_html_{flagName}({flagName} object, const ApiDumpSettings& settings, int indents) {{ - return dump_html_{flagEnum}(({flagEnum}) object, settings, indents); + dump_html_{flagEnum}(({flagEnum}) object, settings, indents); }} @end flag @foreach flag where('{flagEnum}' == 'None') -std::ostream& dump_html_{flagName}({flagName} object, const ApiDumpSettings& settings, int indents) +void dump_html_{flagName}({flagName} object, const ApiDumpSettings& settings, int indents) {{ - return settings.stream() << "
" + settings.stream() << "
" << object << "
"; }} @end flag @@ -1245,21 +1231,21 @@ //======================= Func Pointer Implementations ======================// @foreach funcpointer -std::ostream& dump_html_{pfnName}({pfnName} object, const ApiDumpSettings& settings, int indents) +void dump_html_{pfnName}({pfnName} object, const ApiDumpSettings& settings, int indents) {{ settings.stream() << "
"; if(settings.showAddress()) settings.stream() << object; else settings.stream() << "address"; - return settings.stream() << "
"; + settings.stream() << "
"; }} @end funcpointer //========================== Struct Implementations =========================// @foreach struct where('{sctName}' not in ['VkPhysicalDeviceMemoryProperties' ,'VkPhysicalDeviceGroupProperties']) -std::ostream& dump_html_{sctName}(const {sctName}& object, const ApiDumpSettings& settings, int indents) +void dump_html_{sctName}(const {sctName}& object, const ApiDumpSettings& settings, int indents) {{ settings.stream() << "
"; if(settings.showAddress()) @@ -1320,11 +1306,10 @@ dump_html_special("UNUSED", settings, "{memType}", "{memName}", indents + 1); @end if @end member - return settings.stream(); }} @end struct -std::ostream& dump_html_VkPhysicalDeviceMemoryProperties(const VkPhysicalDeviceMemoryProperties& object, const ApiDumpSettings& settings, int indents) +void dump_html_VkPhysicalDeviceMemoryProperties(const VkPhysicalDeviceMemoryProperties& object, const ApiDumpSettings& settings, int indents) {{ settings.stream() << "
"; if(settings.showAddress()) @@ -1336,10 +1321,9 @@ dump_html_array(object.memoryTypes, object.memoryTypeCount, settings, "VkMemoryType[VK_MAX_MEMORY_TYPES]", "VkMemoryType", "memoryTypes", indents + 1, dump_html_VkMemoryType); // ZRV dump_html_value(object.memoryHeapCount, settings, "uint32_t", "memoryHeapCount", indents + 1, dump_html_uint32_t); dump_html_array(object.memoryHeaps, object.memoryHeapCount, settings, "VkMemoryHeap[VK_MAX_MEMORY_HEAPS]", "VkMemoryHeap", "memoryHeaps", indents + 1, dump_html_VkMemoryHeap); // ZRW - return settings.stream(); }} -std::ostream& dump_html_VkPhysicalDeviceGroupProperties(const VkPhysicalDeviceGroupProperties& object, const ApiDumpSettings& settings, int indents) +void dump_html_VkPhysicalDeviceGroupProperties(const VkPhysicalDeviceGroupProperties& object, const ApiDumpSettings& settings, int indents) {{ settings.stream() << "
"; if(settings.showAddress()) @@ -1352,13 +1336,12 @@ dump_html_value(object.physicalDeviceCount, settings, "uint32_t", "physicalDeviceCount", indents + 1, dump_html_uint32_t); dump_html_array(object.physicalDevices, object.physicalDeviceCount, settings, "VkPhysicalDevice[VK_MAX_DEVICE_GROUP_SIZE]", "VkPhysicalDevice", "physicalDevices", indents + 1, dump_html_VkPhysicalDevice); // ZRX dump_html_value(object.subsetAllocation, settings, "VkBool32", "subsetAllocation", indents + 1, dump_html_VkBool32); - return settings.stream(); }} //========================== Union Implementations ==========================// @foreach union -std::ostream& dump_html_{unName}(const {unName}& object, const ApiDumpSettings& settings, int indents) +void dump_html_{unName}(const {unName}& object, const ApiDumpSettings& settings, int indents) {{ settings.stream() << "
"; if(settings.showAddress()) @@ -1378,7 +1361,6 @@ dump_html_array(object.{chcName}, {chcLength}, settings, "{chcType}", "{chcChildType}", "{chcName}", indents + 1, dump_html_{chcTypeID}); // ZRY @end if @end choice - return settings.stream(); }} @end union @@ -1386,10 +1368,10 @@ @foreach function where('{funcName}' not in ['vkGetDeviceProcAddr', 'vkGetInstanceProcAddr']) @if('{funcReturn}' != 'void') -std::ostream& dump_html_{funcName}(ApiDumpInstance& dump_inst, {funcReturn} result, {funcTypedParams}) +void dump_html_{funcName}(ApiDumpInstance& dump_inst, {funcReturn} result, {funcTypedParams}) @end if @if('{funcReturn}' == 'void') -std::ostream& dump_html_{funcName}(ApiDumpInstance& dump_inst, {funcTypedParams}) +void dump_html_{funcName}(ApiDumpInstance& dump_inst, {funcTypedParams}) @end if {{ const ApiDumpSettings& settings(dump_inst.settings()); @@ -1418,7 +1400,7 @@ }} settings.shouldFlush() ? settings.stream() << std::endl : settings.stream() << "\\n"; - return settings.stream() << ""; + settings.stream() << ""; }} @end function """ @@ -1458,32 +1440,31 @@ #include "api_dump.h" @foreach struct -std::ostream& dump_json_{sctName}(const {sctName}& object, const ApiDumpSettings& settings, int indents); +void dump_json_{sctName}(const {sctName}& object, const ApiDumpSettings& settings, int indents); @end struct @foreach union -std::ostream& dump_json_{unName}(const {unName}& object, const ApiDumpSettings& settings, int indents); +void dump_json_{unName}(const {unName}& object, const ApiDumpSettings& settings, int indents); @end union //============================= typedefs ==============================// // Functions for dumping typedef types that the codegen scripting can't handle #if defined(VK_ENABLE_BETA_EXTENSIONS) -std::ostream& dump_json_VkAccelerationStructureTypeKHR(VkAccelerationStructureTypeKHR object, const ApiDumpSettings& settings, int indents); -std::ostream& dump_json_VkAccelerationStructureTypeNV(VkAccelerationStructureTypeNV object, const ApiDumpSettings& settings, int indents) +void dump_json_VkAccelerationStructureTypeKHR(VkAccelerationStructureTypeKHR object, const ApiDumpSettings& settings, int indents); +void dump_json_VkAccelerationStructureTypeNV(VkAccelerationStructureTypeNV object, const ApiDumpSettings& settings, int indents) {{ - return dump_json_VkAccelerationStructureTypeKHR(object, settings, indents); + dump_json_VkAccelerationStructureTypeKHR(object, settings, indents); }} -std::ostream& dump_json_VkBuildAccelerationStructureFlagsKHR(VkBuildAccelerationStructureFlagsKHR object, const ApiDumpSettings& settings, int indents); -std::ostream& dump_json_VkBuildAccelerationStructureFlagsNV(VkBuildAccelerationStructureFlagsNV object, const ApiDumpSettings& settings, int indents) +void dump_json_VkBuildAccelerationStructureFlagsKHR(VkBuildAccelerationStructureFlagsKHR object, const ApiDumpSettings& settings, int indents); +void dump_json_VkBuildAccelerationStructureFlagsNV(VkBuildAccelerationStructureFlagsNV object, const ApiDumpSettings& settings, int indents) {{ - return dump_json_VkBuildAccelerationStructureFlagsKHR(object, settings, indents); + dump_json_VkBuildAccelerationStructureFlagsKHR(object, settings, indents); }} #endif // VK_ENABLE_BETA_EXTENSIONS - //======================== pNext Chain Implementation =======================// -std::ostream& dump_json_pNext_trampoline(const void* object, const ApiDumpSettings& settings, int indents) +void dump_json_pNext_trampoline(const void* object, const ApiDumpSettings& settings, int indents) {{ switch((int64_t) (static_cast(object)->sType)) {{ @foreach struct @@ -1513,21 +1494,20 @@ settings.stream() << settings.indentation(indents + 1) << "\\"value\\" : \\"UNKNOWN (\\"" << (int64_t) (static_cast(object)->sType) << "\\")\\n"; settings.stream() << settings.indentation(indents) << "}}"; }} - return settings.stream(); }} //=========================== Type Implementations ==========================// @foreach type where('{etyName}' != 'void') -std::ostream& dump_json_{etyName}({etyName} object, const ApiDumpSettings& settings, int indents) +void dump_json_{etyName}({etyName} object, const ApiDumpSettings& settings, int indents) {{ //settings.stream() << settings.indentation(indents); @if('{etyName}' != 'uint8_t') - return settings.stream() << "\\"" << object << "\\""; + settings.stream() << "\\"" << object << "\\""; @end if @if('{etyName}' == 'uint8_t') - return settings.stream() << "\\"" << (uint32_t) object << "\\""; + settings.stream() << "\\"" << (uint32_t) object << "\\""; @end if }} @end type @@ -1535,24 +1515,24 @@ //========================= Basetype Implementations ========================// @foreach basetype where(not '{baseName}' in ['ANativeWindow', 'AHardwareBuffer', 'CAMetalLayer']) -std::ostream& dump_json_{baseName}({baseName} object, const ApiDumpSettings& settings, int indents) +void dump_json_{baseName}({baseName} object, const ApiDumpSettings& settings, int indents) {{ - return settings.stream() << "\\"" << object << "\\""; + settings.stream() << "\\"" << object << "\\""; }} @end basetype @foreach basetype where('{baseName}' in ['ANativeWindow', 'AHardwareBuffer']) #if defined(VK_USE_PLATFORM_ANDROID_KHR) -std::ostream& dump_json_{baseName}(const {baseName}* object, const ApiDumpSettings& settings, int indents) +void dump_json_{baseName}(const {baseName}* object, const ApiDumpSettings& settings, int indents) {{ - return settings.stream() << "\\"" << object << "\\""; + settings.stream() << "\\"" << object << "\\""; }} #endif @end basetype @foreach basetype where('{baseName}' in ['CAMetalLayer']) #if defined(VK_USE_PLATFORM_METAL_EXT) -std::ostream& dump_json_{baseName}({baseName} object, const ApiDumpSettings& settings, int indents) +void dump_json_{baseName}({baseName} object, const ApiDumpSettings& settings, int indents) {{ - return settings.stream() << "\\"" << object << "\\""; + settings.stream() << "\\"" << object << "\\""; }} #endif @end basetype @@ -1560,30 +1540,29 @@ //======================= System Type Implementations =======================// @foreach systype -std::ostream& dump_json_{sysName}(const {sysType} object, const ApiDumpSettings& settings, int indents) +void dump_json_{sysName}(const {sysType} object, const ApiDumpSettings& settings, int indents) {{ - return settings.stream() << "\\"" << object << "\\""; + settings.stream() << "\\"" << object << "\\""; }} @end systype //========================== Handle Implementations =========================// @foreach handle -std::ostream& dump_json_{hdlName}(const {hdlName} object, const ApiDumpSettings& settings, int indents) +void dump_json_{hdlName}(const {hdlName} object, const ApiDumpSettings& settings, int indents) {{ if(settings.showAddress()) {{ - return settings.stream() << "\\"" << object << "\\""; + settings.stream() << "\\"" << object << "\\""; }} else {{ - return settings.stream() << "\\"address\\""; + settings.stream() << "\\"address\\""; }} - return settings.stream(); }} @end handle //=========================== Enum Implementations ==========================// @foreach enum -std::ostream& dump_json_{enumName}({enumName} object, const ApiDumpSettings& settings, int indents) +void dump_json_{enumName}({enumName} object, const ApiDumpSettings& settings, int indents) {{ switch((int64_t) object) {{ @@ -1595,14 +1574,13 @@ default: settings.stream() << "\\"UNKNOWN (" << object << ")\\""; }} - return settings.stream(); }} @end enum //========================= Bitmask Implementations =========================// @foreach bitmask -std::ostream& dump_json_{bitName}({bitName} object, const ApiDumpSettings& settings, int indents) +void dump_json_{bitName}({bitName} object, const ApiDumpSettings& settings, int indents) {{ bool is_first = true; settings.stream() << '"' << object; @@ -1610,52 +1588,51 @@ settings.stream() << ' '; @foreach option @if('{optMultiValue}' != 'None') - if(object == {optValue}) - is_first = dump_json_bitmaskOption("{optName}", settings.stream(), is_first); + if(object == {optValue}) + is_first = dump_bitmaskOption("{optName}", settings.stream(), is_first); @end if @if('{optMultiValue}' == 'None') - if(object & {optValue}) - is_first = dump_json_bitmaskOption("{optName}", settings.stream(), is_first); + if(object & {optValue}) + is_first = dump_bitmaskOption("{optName}", settings.stream(), is_first); @end if @end option if(!is_first) settings.stream() << ')'; - return settings.stream() << "\\""; + settings.stream() << "\\""; }} @end bitmask //=========================== Flag Implementations ==========================// @foreach flag where('{flagEnum}' != 'None') -std::ostream& dump_json_{flagName}({flagName} object, const ApiDumpSettings& settings, int indents) +void dump_json_{flagName}({flagName} object, const ApiDumpSettings& settings, int indents) {{ - return dump_json_{flagEnum}(({flagEnum}) object, settings, indents); + dump_json_{flagEnum}(({flagEnum}) object, settings, indents); }} @end flag @foreach flag where('{flagEnum}' == 'None') -std::ostream& dump_json_{flagName}({flagName} object, const ApiDumpSettings& settings, int indents) +void dump_json_{flagName}({flagName} object, const ApiDumpSettings& settings, int indents) {{ - return settings.stream() << '"' << object << "\\""; + settings.stream() << '"' << object << "\\""; }} @end flag //======================= Func Pointer Implementations ======================// @foreach funcpointer -std::ostream& dump_json_{pfnName}({pfnName} object, const ApiDumpSettings& settings, int indents) +void dump_json_{pfnName}({pfnName} object, const ApiDumpSettings& settings, int indents) {{ if(settings.showAddress()) settings.stream() << "\\"" << object << "\\""; else settings.stream() << "\\"address\\""; - return settings.stream(); }} @end funcpointer //========================== Struct Implementations =========================// @foreach struct where('{sctName}' not in ['VkPhysicalDeviceMemoryProperties' ,'VkPhysicalDeviceGroupProperties']) -std::ostream& dump_json_{sctName}(const {sctName}& object, const ApiDumpSettings& settings, int indents) +void dump_json_{sctName}(const {sctName}& object, const ApiDumpSettings& settings, int indents) {{ settings.stream() << settings.indentation(indents) << "[\\n"; @@ -1722,7 +1699,6 @@ needMemberComma = true; @end member settings.stream() << "\\n" << settings.indentation(indents) << "]"; - return settings.stream(); }} @end struct @@ -1738,7 +1714,7 @@ return false; }} -std::ostream& dump_json_VkPhysicalDeviceMemoryProperties(const VkPhysicalDeviceMemoryProperties& object, const ApiDumpSettings& settings, int indents) +void dump_json_VkPhysicalDeviceMemoryProperties(const VkPhysicalDeviceMemoryProperties& object, const ApiDumpSettings& settings, int indents) {{ settings.stream() << settings.indentation(indents) << "[\\n"; @@ -1750,10 +1726,9 @@ settings.stream() << ",\\n"; dump_json_array(object.memoryHeaps, object.memoryHeapCount, settings, "VkMemoryHeap[VK_MAX_MEMORY_HEAPS]", "VkMemoryHeap", "memoryHeaps", indents + 1, dump_json_VkMemoryHeap); // MQA settings.stream() << "\\n" << settings.indentation(indents) << "]"; - return settings.stream(); }} -std::ostream& dump_json_VkPhysicalDeviceGroupProperties(const VkPhysicalDeviceGroupProperties& object, const ApiDumpSettings& settings, int indents) +void dump_json_VkPhysicalDeviceGroupProperties(const VkPhysicalDeviceGroupProperties& object, const ApiDumpSettings& settings, int indents) {{ settings.stream() << settings.indentation(indents) << "[\\n"; @@ -1767,12 +1742,11 @@ settings.stream() << ",\\n"; dump_json_value(object.subsetAllocation, NULL, settings, "VkBool32", "subsetAllocation", indents + 1, dump_json_VkBool32); settings.stream() << "\\n" << settings.indentation(indents) << "]"; - return settings.stream(); }} //========================== Union Implementations ==========================// @foreach union -std::ostream& dump_json_{unName}(const {unName}& object, const ApiDumpSettings& settings, int indents) +void dump_json_{unName}(const {unName}& object, const ApiDumpSettings& settings, int indents) {{ settings.stream() << settings.indentation(indents) << "[\\n"; @@ -1793,7 +1767,6 @@ @end choice settings.stream() << "\\n" << settings.indentation(indents) << "]"; - return settings.stream(); }} @end union @@ -1816,10 +1789,10 @@ @foreach function where(not '{funcName}' in ['vkGetDeviceProcAddr', 'vkGetInstanceProcAddr']) @if('{funcReturn}' != 'void') -std::ostream& dump_json_{funcName}(ApiDumpInstance& dump_inst, {funcReturn} result, {funcTypedParams}) +void dump_json_{funcName}(ApiDumpInstance& dump_inst, {funcReturn} result, {funcTypedParams}) @end if @if('{funcReturn}' == 'void') -std::ostream& dump_json_{funcName}(ApiDumpInstance& dump_inst, {funcTypedParams}) +void dump_json_{funcName}(ApiDumpInstance& dump_inst, {funcTypedParams}) @end if {{ const ApiDumpSettings& settings(dump_inst.settings()); @@ -1862,7 +1835,6 @@ settings.stream() << settings.indentation(2) << "}}"; needFuncComma = true; if (settings.shouldFlush()) settings.stream().flush(); - return settings.stream(); }} @end function """ @@ -2672,15 +2644,11 @@ def __init__(self, rootNode, constants, aliases, extensions): self.returnType = rootNode.find('proto').find('type').text self.parameters = [] - self.namedParams = '' - self.typedParams = '' for node in rootNode.findall('param'): self.parameters.append(VulkanFunction.Parameter(node, constants, aliases, self.name)) - self.namedParams += self.parameters[-1].name + ', ' - self.typedParams += self.parameters[-1].text + ', ' - if len(self.parameters) > 0: - self.namedParams = self.namedParams[0:-2] - self.typedParams = self.typedParams[0:-2] + + self.namedParams = ','.join(p.name for p in self.parameters) + self.typedParams = ','.join(p.text for p in self.parameters) if self.parameters[0].type in ['VkInstance', 'VkPhysicalDevice'] or self.name == 'vkCreateInstance': self.dispatchType = 'instance' @@ -2696,11 +2664,6 @@ def __init__(self, rootNode, constants, aliases, extensions): if self.name in TRACKED_STATE: self.stateTrackingCode = TRACKED_STATE[self.name] - self.safeToPrint = True - for param in self.parameters: - if param.pointerLevels == 1 and param.type.find("const") == -1: - self.safeToPrint = False - def values(self): return { 'funcName': self.name, @@ -2712,7 +2675,6 @@ def values(self): 'funcDispatchParam': self.parameters[0].name, 'funcDispatchType' : self.dispatchType, 'funcStateTrackingCode': self.stateTrackingCode, - 'funcSafeToPrint': self.safeToPrint, } class VulkanFunctionPointer: From 685150ea8a8b491af68d635aaf15b92015dbb99b Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Sat, 19 Nov 2022 16:42:57 -0700 Subject: [PATCH 032/154] apidump: remove dump_bitmaskOption & cleanup OutputAddress dump_bitmaskOption's logic can be easily done in line, removing a ton of potential function calls. Whether OutputAddress should put quotes is purely determined by whether it is being called within the JSON output. --- layersvt/api_dump.h | 59 +++++++++++++---------------------- scripts/api_dump_generator.py | 26 +++++++-------- 2 files changed, 34 insertions(+), 51 deletions(-) diff --git a/layersvt/api_dump.h b/layersvt/api_dump.h index 20f7114294..f89f343285 100644 --- a/layersvt/api_dump.h +++ b/layersvt/api_dump.h @@ -872,8 +872,8 @@ class ApiDumpInstance { // Utility to output an address. // If the quotes arg is true, the address is encloded in quotes. // Used for text, html, and json output. -void OutputAddress(const ApiDumpSettings &settings, const void *addr, bool quotes) { - if (quotes) settings.stream() << "\""; +void OutputAddress(const ApiDumpSettings &settings, const void *addr) { + if (settings.format() == ApiDumpFormat::Json) settings.stream() << "\""; if (settings.showAddress()) if (addr == NULL) settings.stream() << "NULL"; @@ -881,22 +881,11 @@ void OutputAddress(const ApiDumpSettings &settings, const void *addr, bool quote settings.stream() << addr; else settings.stream() << "address"; - if (quotes) settings.stream() << "\""; + if (settings.format() == ApiDumpFormat::Json) settings.stream() << "\""; } ApiDumpInstance ApiDumpInstance::current_instance; -//===================================== Common Printers ==========================================// - -bool dump_bitmaskOption(const std::string &option, std::ostream &stream, bool isFirst) { - if (isFirst) - stream << " ("; - else - stream << " | "; - stream << option; - return false; -} - //==================================== Text Backend Helpers ======================================// void dump_text_function_head(ApiDumpInstance &dump_inst, const char *funcName, const char *funcReturn) { @@ -926,7 +915,7 @@ void dump_text_array(const T *array, size_t len, const ApiDumpSettings &settings settings.stream() << "NULL\n"; return; } - OutputAddress(settings, array, false); + OutputAddress(settings, array); settings.stream() << "\n"; for (size_t i = 0; i < len && array != NULL; ++i) { std::stringstream stream; @@ -944,7 +933,7 @@ void dump_text_array(const T *array, size_t len, const ApiDumpSettings &settings settings.stream() << "NULL\n"; return; } - OutputAddress(settings, array, false); + OutputAddress(settings, array); settings.stream() << "\n"; for (size_t i = 0; i < len && array != NULL; ++i) { std::stringstream stream; @@ -1008,7 +997,7 @@ void dump_text_void(const void *object, const ApiDumpSettings &settings, int ind settings.stream() << "NULL"; return; } - OutputAddress(settings, object, false); + OutputAddress(settings, object); settings.stream(); } @@ -1059,7 +1048,7 @@ void dump_html_array(const T *array, size_t len, const ApiDumpSettings &settings settings.stream() << "
"; dump_html_nametype(settings.stream(), settings.showType(), name, type_string); settings.stream() << "
"; - OutputAddress(settings, array, false); + OutputAddress(settings, array); settings.stream() << "\n"; settings.stream() << "
"; for (size_t i = 0; i < len && array != NULL; ++i) { @@ -1083,7 +1072,7 @@ void dump_html_array(const T *array, size_t len, const ApiDumpSettings &settings settings.stream() << "
"; dump_html_nametype(settings.stream(), settings.showType(), name, type_string); settings.stream() << "
"; - OutputAddress(settings, array, false); + OutputAddress(settings, array); settings.stream() << "\n"; settings.stream() << "
"; for (size_t i = 0; i < len && array != NULL; ++i) { @@ -1154,7 +1143,7 @@ void dump_html_cstring(const char *object, const ApiDumpSettings &settings, int void dump_html_void(const void *object, const ApiDumpSettings &settings, int indents) { settings.stream() << "
"; - OutputAddress(settings, object, false); + OutputAddress(settings, object); settings.stream() << "
"; } @@ -1214,7 +1203,7 @@ void dump_json_array(const T *array, size_t len, const ApiDumpSettings &settings settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << "\",\n"; settings.stream() << settings.indentation(indents + 1) << "\"name\" : \"" << name << "\",\n"; settings.stream() << settings.indentation(indents + 1) << "\"address\" : "; - OutputAddress(settings, array, true); + OutputAddress(settings, array); settings.stream() << "\n"; settings.stream() << settings.indentation(indents) << "}"; return; @@ -1225,7 +1214,7 @@ void dump_json_array(const T *array, size_t len, const ApiDumpSettings &settings settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << "\",\n"; settings.stream() << settings.indentation(indents + 1) << "\"name\" : \"" << name << "\",\n"; settings.stream() << settings.indentation(indents + 1) << "\"address\" : "; - OutputAddress(settings, array, true); + OutputAddress(settings, array); settings.stream() << ",\n"; settings.stream() << settings.indentation(indents + 1) << "\"elements\" :\n"; settings.stream() << settings.indentation(indents + 1) << "[\n"; @@ -1250,7 +1239,7 @@ void dump_json_array(const T *array, size_t len, const ApiDumpSettings &settings settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << "\",\n"; settings.stream() << settings.indentation(indents + 1) << "\"name\" : \"" << name << "\",\n"; settings.stream() << settings.indentation(indents + 1) << "\"address\" : "; - OutputAddress(settings, array, true); + OutputAddress(settings, array); settings.stream() << "\n"; settings.stream() << settings.indentation(indents) << "}"; return; @@ -1260,7 +1249,7 @@ void dump_json_array(const T *array, size_t len, const ApiDumpSettings &settings settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << "\",\n"; settings.stream() << settings.indentation(indents + 1) << "\"name\" : \"" << name << "\",\n"; settings.stream() << settings.indentation(indents + 1) << "\"address\" : "; - OutputAddress(settings, array, true); + OutputAddress(settings, array); settings.stream() << ",\n"; settings.stream() << settings.indentation(indents + 1) << "\"elements\" :\n"; settings.stream() << settings.indentation(indents + 1) << "[\n"; @@ -1285,8 +1274,7 @@ void dump_json_pointer(const T *pointer, const ApiDumpSettings &settings, const settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << "\",\n"; settings.stream() << settings.indentation(indents + 1) << "\"name\" : \"" << name << "\",\n"; settings.stream() << settings.indentation(indents + 1) << "\"address\" : "; - OutputAddress(settings, NULL, true); - settings.stream() << "\n"; + settings.stream() << (settings.showAddress() ? "\"NULL\"" : "\"address\"") << "\n"; settings.stream() << settings.indentation(indents) << "}"; } else { dump_json_value(*pointer, pointer, settings, type_string, name, indents, dump); @@ -1301,8 +1289,7 @@ void dump_json_pointer(const T *pointer, const ApiDumpSettings &settings, const settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << "\",\n"; settings.stream() << settings.indentation(indents + 1) << "\"name\" : \"" << name << "\",\n"; settings.stream() << settings.indentation(indents + 1) << "\"address\" : "; - OutputAddress(settings, NULL, true); - settings.stream() << "\n"; + settings.stream() << (settings.showAddress() ? "\"NULL\"" : "\"address\"") << "\n"; settings.stream() << settings.indentation(indents) << "}"; } else { dump_json_value(*pointer, pointer, settings, type_string, name, indents, dump); @@ -1326,7 +1313,7 @@ void dump_json_value(const T object, const void *pObject, const ApiDumpSettings if (isPnext || (strchr(type_string, '*') && strcmp(type_string, "const char*") && strcmp(type_string, "const char* const"))) { // Print pointers, except for char string pointers settings.stream() << ",\n" << settings.indentation(indents + 1) << "\"address\" : "; - OutputAddress(settings, pObject, true); + OutputAddress(settings, pObject); } if (!isPnext || (isPnext && pObject != nullptr)) { settings.stream() << ",\n"; @@ -1354,7 +1341,7 @@ void dump_json_value(const T &object, const void *pObject, const ApiDumpSettings if (isPnext || (strchr(type_string, '*') && strcmp(type_string, "const char*") && strcmp(type_string, "const char* const"))) { // Print pointers, except for char string pointers settings.stream() << ",\n" << settings.indentation(indents + 1) << "\"address\" : "; - OutputAddress(settings, pObject, true); + OutputAddress(settings, pObject); } if (!isPnext || (isPnext && pObject != nullptr)) { settings.stream() << ",\n"; @@ -1373,7 +1360,7 @@ void dump_json_special(const char *text, const ApiDumpSettings &settings, const settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << "\",\n"; settings.stream() << settings.indentation(indents + 1) << "\"name\" : \"" << name << "\",\n"; settings.stream() << settings.indentation(indents + 1) << "\"address\" : "; - OutputAddress(settings, text, true); + OutputAddress(settings, text); settings.stream() << ",\n"; settings.stream() << settings.indentation(indents + 1) << "\"value\" : "; settings.stream() << "\"" << text << "\"\n"; @@ -1388,15 +1375,13 @@ void dump_json_cstring(const char *object, const ApiDumpSettings &settings, int } void dump_json_void(const void *object, const ApiDumpSettings &settings, int indents) { - OutputAddress(settings, object, true); + OutputAddress(settings, object); settings.stream() << "\n"; - settings.stream(); } void dump_json_int(int object, const ApiDumpSettings &settings, int indents) { - settings.stream() << settings.indentation(indents) << "\"value\" : "; + settings.stream() << settings.indentation(indents) << "\"value\" : " << '"' << object << "\""; settings.stream() << '"' << object << "\""; - settings.stream(); } template @@ -1409,7 +1394,7 @@ void dump_json_pNext(const T *object, const ApiDumpSettings &settings, const cha << "pNext" << "\",\n"; settings.stream() << settings.indentation(indents + 1) << "\"address\" : "; - OutputAddress(settings, NULL, true); + OutputAddress(settings, NULL); settings.stream() << ",\n"; settings.stream() << settings.indentation(indents) << "}"; } else { @@ -1427,7 +1412,7 @@ void dump_json_pNext(const T *object, const ApiDumpSettings &settings, const cha << "pNext" << "\",\n"; settings.stream() << settings.indentation(indents + 1) << "\"address\" : "; - OutputAddress(settings, NULL, true); + OutputAddress(settings, NULL); settings.stream() << ",\n"; settings.stream() << settings.indentation(indents) << "}"; } else { diff --git a/scripts/api_dump_generator.py b/scripts/api_dump_generator.py index acc62dc96e..910027fa8d 100644 --- a/scripts/api_dump_generator.py +++ b/scripts/api_dump_generator.py @@ -804,18 +804,16 @@ void dump_text_{bitName}({bitName} object, const ApiDumpSettings& settings, int indents) {{ bool is_first = true; - //settings.formatNameType(stream, indents, name, type_string) << object; settings.stream() << object; @foreach option @if('{optMultiValue}' != 'None') - if(object == {optValue}) - is_first = dump_bitmaskOption("{optName}", settings.stream(), is_first); + if(object == {optValue}) {{ @end if @if('{optMultiValue}' == 'None') - if(object & {optValue}) - is_first = dump_bitmaskOption("{optName}", settings.stream(), is_first); + if(object & {optValue}) {{ @end if - + settings.stream() << (is_first ? \" (\" : \" | \") << "{optName}"; is_first = false; + }} @end option if(!is_first) settings.stream() << ")"; @@ -1198,13 +1196,13 @@ settings.stream() << object; @foreach option @if('{optMultiValue}' != 'None') - if(object == {optValue}) - is_first = dump_bitmaskOption("{optName}", settings.stream(), is_first); + if(object == {optValue}) {{ @end if @if('{optMultiValue}' == 'None') - if(object & {optValue}) - is_first = dump_bitmaskOption("{optName}", settings.stream(), is_first); + if(object & {optValue}) {{ @end if + settings.stream() << (is_first ? \" (\" : \" | \") << "{optName}"; is_first = false; + }} @end option if(!is_first) settings.stream() << ")"; @@ -1588,13 +1586,13 @@ settings.stream() << ' '; @foreach option @if('{optMultiValue}' != 'None') - if(object == {optValue}) - is_first = dump_bitmaskOption("{optName}", settings.stream(), is_first); + if(object == {optValue}) {{ @end if @if('{optMultiValue}' == 'None') - if(object & {optValue}) - is_first = dump_bitmaskOption("{optName}", settings.stream(), is_first); + if(object & {optValue}) {{ @end if + settings.stream() << (is_first ? \" (\" : \" | \") << "{optName}"; is_first = false; + }} @end option if(!is_first) settings.stream() << ')'; From a293360eeb9e4435fdb640d903387d752a453fb9 Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Sat, 19 Nov 2022 16:49:09 -0700 Subject: [PATCH 033/154] apidump: Refactor generator to use dictionaries This greatly speeds up the time to generate because we can easily check if any thing is in a set without iterating the entire list. Rough estimate of build time improvements is 115 seconds down to 35, or by around a factor of 3x. --- scripts/api_dump_generator.py | 118 +++++++++++++++++----------------- 1 file changed, 60 insertions(+), 58 deletions(-) diff --git a/scripts/api_dump_generator.py b/scripts/api_dump_generator.py index 910027fa8d..607df36005 100644 --- a/scripts/api_dump_generator.py +++ b/scripts/api_dump_generator.py @@ -2007,21 +2007,21 @@ def __init__(self, self.format = None self.constants = {} - self.extensions = set() + self.extensions = {} self.extFuncs = {} self.extTypes = {} self.includes = {} - self.basetypes = set() - self.bitmasks = set() - self.enums = set() - self.externalTypes = set() - self.flags = set() - self.funcPointers = set() - self.functions = set() - self.handles = set() - self.structs = set() - self.unions = set() + self.basetypes = {} + self.bitmasks = {} + self.enums = {} + self.externalTypes = {} + self.flags = {} + self.funcPointers = {} + self.functions = {} + self.handles = {} + self.structs = {} + self.unions = {} self.aliases = {} self.registryFile = registryFile @@ -2039,12 +2039,13 @@ def beginFile(self, genOpts): root = self.registry.reg for node in root.find('extensions').findall('extension'): - ext = VulkanExtension(node) - self.extensions.add(ext) - for item in ext.vktypes: - self.extTypes[item] = ext - for item in ext.vkfuncs: - self.extFuncs[item] = ext + if node.get('supported') == 'vulkan': # dont print unsupported extensions + ext = VulkanExtension(node) + self.extensions[ext.name] = ext + for item in ext.vktypes: + self.extTypes[item] = ext + for item in ext.vkfuncs: + self.extFuncs[item] = ext for node in self.registry.reg.findall('enums'): if node.get('name') == 'API Constants': @@ -2057,27 +2058,28 @@ def beginFile(self, genOpts): def endFile(self): - # Find all of the extensions that use the system types - self.sysTypes = set() + # Find all 'system' types and put it in a set + sysTypeNames = set() for node in self.registry.reg.find('types').findall('type'): if node.get('category') is None and node.get('requires') in self.includes and node.get('requires') != 'vk_platform': - for extension in self.extTypes: - for structName in self.extTypes[extension].vktypes: - for struct in self.structs: - if struct.name == structName: - for member in struct.members: - if node.get('name') == member.baseType or node.get('name') + '*' == member.baseType: - sysType = VulkanSystemType(node.get('name'), self.extTypes[structName]) - if sysType not in self.sysTypes: - self.sysTypes.add(sysType) - for funcName in self.extTypes[extension].vkfuncs: - for func in self.functions: - if func.name == funcName: - for param in func.parameters: - if node.get('name') == param.baseType or node.get('name') + '*' == param.baseType: - sysType = VulkanSystemType(node.get('name'), self.extFuncs[funcName]) - if sysType not in self.sysTypes: - self.sysTypes.add(sysType) + sysTypeNames.add(node.get('name')) + + # Look through the set of sysTypeName to find all of the extensions that use the system types, then add it to sysTypes + self.sysTypes = {} + for sysTypeName in sysTypeNames: + for extension in self.extTypes.values(): + for typeName in extension.vktypes: + if typeName not in self.structs: + continue # not all types are structures nor will be enabled + for member in self.structs[typeName].members: + if sysTypeName == member.baseType or sysTypeName + '*' == member.baseType: + self.sysTypes[sysTypeName] = VulkanSystemType(sysTypeName, extension) + for functionName in extension.vkfuncs: + if functionName not in self.functions: + continue # not all functions will be enabled + for param in self.functions[functionName].parameters: + if sysTypeName == param.baseType or sysTypeName + '*' == param.baseType: + self.sysTypes[sysTypeName] = VulkanSystemType(sysTypeName, extension) # Find every @foreach, @if, and @end forIter = re.finditer('(^\\s*\\@foreach\\s+[a-z]+(\\s+where\\(.*\\))?\\s*^)|(\\@foreach [a-z]+(\\s+where\\(.*\\))?\\b)', self.format, flags=re.MULTILINE) @@ -2164,7 +2166,7 @@ def genCmd(self, cmd, name, alias): if name == "vkEnumerateInstanceVersion": return # TODO: Create exclusion list or metadata to indicate this - self.functions.add(VulkanFunction(cmd.elem, self.constants, self.aliases, self.extFuncs)) + self.functions[cmd.elem.get('name')] = VulkanFunction(cmd.elem, self.constants, self.aliases, self.extFuncs) # These are actually constants def genEnum(self, enuminfo, name, alias): @@ -2183,9 +2185,9 @@ def genGroup(self, groupinfo, groupName, alias): self.trackedTypes.append(trackedName) if groupinfo.elem.get('type') == 'bitmask': - self.bitmasks.add(VulkanBitmask(groupinfo.elem, self.extensions)) + self.bitmasks[groupinfo.elem.get('name')] = VulkanBitmask(groupinfo.elem, self.extensions) elif groupinfo.elem.get('type') == 'enum': - self.enums.add(VulkanEnum(groupinfo.elem, self.extensions)) + self.enums[groupinfo.elem.get('name')] = VulkanEnum(groupinfo.elem, self.extensions) def genType(self, typeinfo, name, alias): gen.OutputGenerator.genType(self, typeinfo, name, alias) @@ -2201,19 +2203,20 @@ def genType(self, typeinfo, name, alias): self.trackedTypes.append(trackedName) if typeinfo.elem.get('category') == 'struct': - self.structs.add(VulkanStruct(typeinfo.elem, self.constants, self.enums)) + self.structs[typeinfo.elem.get('name')] = VulkanStruct(typeinfo.elem, self.constants, self.enums) elif typeinfo.elem.get('category') == 'basetype': - self.basetypes.add(VulkanBasetype(typeinfo.elem)) + self.basetypes[typeinfo.elem.get('name')] = VulkanBasetype(typeinfo.elem) elif typeinfo.elem.get('category') is None and typeinfo.elem.get('requires') == 'vk_platform': - self.externalTypes.add(VulkanExternalType(typeinfo.elem)) + self.externalTypes[typeinfo.elem.get('name')] = VulkanExternalType(typeinfo.elem) elif typeinfo.elem.get('category') == 'handle': - self.handles.add(VulkanHandle(typeinfo.elem)) + self.handles[typeinfo.elem.get('name')] = VulkanHandle(typeinfo.elem) elif typeinfo.elem.get('category') == 'union': - self.unions.add(VulkanUnion(typeinfo.elem, self.constants)) + self.unions[typeinfo.elem.get('name')] = VulkanUnion(typeinfo.elem, self.constants) elif typeinfo.elem.get('category') == 'bitmask': - self.flags.add(VulkanFlags(typeinfo.elem)) + self.flags[typeinfo.elem.get('name')] = VulkanFlags(typeinfo.elem) elif typeinfo.elem.get('category') == 'funcpointer': - self.funcPointers.add(VulkanFunctionPointer(typeinfo.elem)) + func = VulkanFunctionPointer(typeinfo.elem) + self.funcPointers[func.name] = func def expand(self, loop, parents=[]): # Figure out what we're dealing with @@ -2256,6 +2259,10 @@ def expand(self, loop, parents=[]): # Generate the output string out = '' + # turn subjects into a set if it is a dict + if type(subjects) is dict: + subjects = subjects.values() + for item in subjects: # Merge the values and the parent values @@ -2275,8 +2282,8 @@ def expand(self, loop, parents=[]): ext = self.extFuncs[item.name] elif item.name in self.extTypes: ext = self.extTypes[item.name] - elif item in self.sysTypes: - ext = item.ext + elif item.name in self.sysTypes: + ext = self.sysTypes[item.name].ext else: ext = None if ext is not None and ext.guard is not None: @@ -2430,7 +2437,7 @@ def __init__(self, rootNode, extensions): self.options.append(VulkanEnum.Option(childName, childValue, childBitpos, childComment)) - for ext in extensions: + for ext in extensions.values(): if self.name in ext.enumValues: childName, childValue = ext.enumValues[self.name] self.options.append(VulkanEnum.Option(childName, childValue, None, None)) @@ -2518,7 +2525,7 @@ def __init__(self, rootNode, extensions): self.options.append(VulkanEnum.Option(childName, childValue, childBitpos, childComment)) - for ext in extensions: + for ext in extensions.values(): if self.name in ext.enumValues: childName, childValue = ext.enumValues[self.name] duplicate = False @@ -2742,11 +2749,9 @@ def __init__(self, rootNode, constants, enums): if(self.structExtends is not None): for member in self.members: if(member.structValues is not None): - for enum in enums: - if(enum.name == 'VkStructureType'): - for opt in enum.options: - if(member.structValues == opt.name): - self.structureIndex = opt.value + for opt in enums['VkStructureType'].options: + if(member.structValues == opt.name): + self.structureIndex = opt.value def values(self): return { @@ -2761,9 +2766,6 @@ def __init__(self, name, ext): self.type = self.name if name not in POINTER_TYPES else self.name + '*' self.ext = ext - def __eq__(self, that): - return self.name == that.name and self.type == that.type - def __hash__(self): return hash(self.name) | hash(self.type) From 09b3b43b64a53bff2d6a30a86d992100bd7fa680 Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Wed, 23 Nov 2022 15:05:02 -0700 Subject: [PATCH 034/154] apidump: Use correct name of types Previously, the logic assumed that the typename did not contain the name of a member or parameter ofa struct, which is an assumption which doesn't hold across the API. This resulted in the output printing incorrect names for many things where the name of the member/parameter is a substring of the type. For example, 'xcb_connection_t' is the type while 'connection' is the name. API Dump would print the type for 'connection' as 'xcb_'. --- scripts/api_dump_generator.py | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/scripts/api_dump_generator.py b/scripts/api_dump_generator.py index 607df36005..dbb86dc6ea 100644 --- a/scripts/api_dump_generator.py +++ b/scripts/api_dump_generator.py @@ -2352,10 +2352,13 @@ def __init__(self, rootNode, constants, aliases, parentName): continue self.text += node - typeMatch = re.search('.+?(?=' + self.name + ')', self.text) - self.type = typeMatch.string[typeMatch.start():typeMatch.end()] - self.type = ' '.join(self.type.split()) - bracketMatch = re.search('(?<=\\[)[a-zA-Z0-9_]+(?=\\])', self.text) + # Need to get the 'full type', do this by making a list out of the text, remove the name, then put it back together + # We must add spaces around the brackets so they are separate list elements, which is necessary to prune array length declarations + text_list = self.text.replace('[', ' [ ').replace(']', ' ] ').split() + if self.name in text_list: + text_list = text_list[0:text_list.index(self.name)] # remove all elements after the name + self.type = ' '.join(text_list) + bracketMatch = re.search('(?<=\\[)[ a-zA-Z0-9_]+(?=\\])', self.text) if bracketMatch is not None: matchText = bracketMatch.string[bracketMatch.start():bracketMatch.end()] self.childType = self.type @@ -2652,8 +2655,8 @@ def __init__(self, rootNode, constants, aliases, extensions): for node in rootNode.findall('param'): self.parameters.append(VulkanFunction.Parameter(node, constants, aliases, self.name)) - self.namedParams = ','.join(p.name for p in self.parameters) - self.typedParams = ','.join(p.text for p in self.parameters) + self.namedParams = ', '.join(p.name for p in self.parameters) + self.typedParams = ', '.join(p.text for p in self.parameters) if self.parameters[0].type in ['VkInstance', 'VkPhysicalDevice'] or self.name == 'vkCreateInstance': self.dispatchType = 'instance' From a1f4d57ad68ef48af79bc52f338f347ca5ab0b84 Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Wed, 23 Nov 2022 16:50:19 -0700 Subject: [PATCH 035/154] apidump: Remove runtime json comma printing The origina JSON output used a runtime boolean to keep track of whether to print commas between members & parameters in structs and functions. This was done because there was no easy way to print something conditional on the current index. By making the index a part of the member & parameter & union elements, these runtime bools can be done away with. --- scripts/api_dump_generator.py | 48 ++++++++++++++++++++--------------- 1 file changed, 27 insertions(+), 21 deletions(-) diff --git a/scripts/api_dump_generator.py b/scripts/api_dump_generator.py index dbb86dc6ea..13c5b33e57 100644 --- a/scripts/api_dump_generator.py +++ b/scripts/api_dump_generator.py @@ -1634,9 +1634,10 @@ {{ settings.stream() << settings.indentation(indents) << "[\\n"; - bool needMemberComma = false; @foreach member - if (needMemberComma) settings.stream() << ",\\n"; + @if({memIndex} != 0) + settings.stream() << ",\\n"; + @end if @if('{memCondition}' != 'None') if({memCondition}) @end if @@ -1694,7 +1695,6 @@ settings.stream() << settings.indentation(indents+1) << "}}"; }} @end if - needMemberComma = true; @end member settings.stream() << "\\n" << settings.indentation(indents) << "]"; }} @@ -1748,10 +1748,10 @@ {{ settings.stream() << settings.indentation(indents) << "[\\n"; - bool needChoiceComma = false; @foreach choice - if (needChoiceComma) settings.stream() << ",\\n"; - + @if({chcIndex} != 0) + settings.stream() << ",\\n"; + @end if @if({chcPtrLevel} == 0) dump_json_value(object.{chcName}, NULL, settings, "{chcType}", "{chcName}", indents + 2, dump_json_{chcTypeID}); @end if @@ -1761,7 +1761,6 @@ @if({chcPtrLevel} == 1 and '{chcLength}' != 'None') dump_json_array(object.{chcName}, {chcLength}, settings, "{chcType}", "{chcChildType}", "{chcName}", indents + 2, dump_json_{chcTypeID}); // OQA @end if - needChoiceComma = true; @end choice settings.stream() << "\\n" << settings.indentation(indents) << "]"; @@ -1782,9 +1781,6 @@ //========================= Function Implementations ========================// -static bool needFuncComma = false; - - @foreach function where(not '{funcName}' in ['vkGetDeviceProcAddr', 'vkGetInstanceProcAddr']) @if('{funcReturn}' != 'void') void dump_json_{funcName}(ApiDumpInstance& dump_inst, {funcReturn} result, {funcTypedParams}) @@ -1806,13 +1802,13 @@ // Display parameter values if(settings.showParams()) {{ - bool needParameterComma = false; - settings.stream() << settings.indentation(3) << "\\\"args\\\" :\\n"; settings.stream() << settings.indentation(3) << "[\\n"; @foreach parameter - if (needParameterComma) settings.stream() << ",\\n"; + @if({prmIndex} != 0) + settings.stream() << ",\\n"; + @end if @if('{prmParameterStorage}' != '') {prmParameterStorage} @end if @@ -1825,13 +1821,11 @@ @if({prmPtrLevel} == 1 and '{prmLength}' != 'None') dump_json_array({prmName}, {prmLength}, settings, "{prmType}", "{prmChildType}", "{prmName}", 4, dump_json_{prmTypeID}); // PQA @end if - needParameterComma = true; @end parameter settings.stream() << "\\n" << settings.indentation(3) << "]\\n"; }} settings.stream() << settings.indentation(2) << "}}"; - needFuncComma = true; if (settings.shouldFlush()) settings.stream().flush(); }} @end function @@ -2632,8 +2626,9 @@ class VulkanFunction: class Parameter(VulkanVariable): - def __init__(self, rootNode, constants, aliases, parentName): + def __init__(self, rootNode, constants, aliases, parentName, index): VulkanVariable.__init__(self, rootNode, constants, aliases, parentName) + self.index = index def values(self): return { @@ -2645,6 +2640,7 @@ def values(self): 'prmPtrLevel': self.pointerLevels, 'prmLength': self.arrayLength, 'prmParameterStorage': self.parameterStorage, + 'prmIndex': self.index } def __init__(self, rootNode, constants, aliases, extensions): @@ -2652,8 +2648,10 @@ def __init__(self, rootNode, constants, aliases, extensions): self.returnType = rootNode.find('proto').find('type').text self.parameters = [] + index = 0 for node in rootNode.findall('param'): - self.parameters.append(VulkanFunction.Parameter(node, constants, aliases, self.name)) + self.parameters.append(VulkanFunction.Parameter(node, constants, aliases, self.name, index)) + index = index + 1 self.namedParams = ', '.join(p.name for p in self.parameters) self.typedParams = ', '.join(p.text for p in self.parameters) @@ -2716,7 +2714,7 @@ class VulkanStruct: class Member(VulkanVariable): - def __init__(self, rootNode, constants, parentName): + def __init__(self, rootNode, constants, parentName, index): VulkanVariable.__init__(self, rootNode, constants, None, parentName) # Search for a member condition @@ -2724,6 +2722,7 @@ def __init__(self, rootNode, constants, parentName): if rootNode.get('noautovalidity') == 'true' and parentName in VALIDITY_CHECKS and self.name in VALIDITY_CHECKS[parentName]: self.condition = VALIDITY_CHECKS[parentName][self.name] self.structValues = rootNode.get('values') + self.index = index def values(self): return { @@ -2737,6 +2736,7 @@ def values(self): 'memLengthIsMember': self.lengthMember, 'memCondition': self.condition, 'memParameterStorage': self.parameterStorage, + 'memIndex' : self.index } @@ -2744,8 +2744,10 @@ def __init__(self, rootNode, constants, enums): self.name = rootNode.get('name') self.structExtends = rootNode.get('structextends') self.members = [] + index = 0 for node in rootNode.findall('member'): - self.members.append(VulkanStruct.Member(node, constants, self.name)) + self.members.append(VulkanStruct.Member(node, constants, self.name, index)) + index = index + 1 self.structureIndex = -1 @@ -2782,8 +2784,9 @@ class VulkanUnion: class Choice(VulkanVariable): - def __init__(self, rootNode, constants, parentName): + def __init__(self, rootNode, constants, parentName, index): VulkanVariable.__init__(self, rootNode, constants, None, parentName) + self.index = index def values(self): return { @@ -2795,13 +2798,16 @@ def values(self): 'chcPtrLevel': self.pointerLevels, 'chcLength': self.arrayLength, #'chcLengthIsMember': self.lengthMember, + 'chcIndex': self.index, } def __init__(self, rootNode, constants): self.name = rootNode.get('name') self.choices = [] + index = 0 for node in rootNode.findall('member'): - self.choices.append(VulkanUnion.Choice(node, constants, self.name)) + self.choices.append(VulkanUnion.Choice(node, constants, self.name, index)) + index = index + 1 def values(self): return { From 217c847f599a66f4d236d07c52d6f42c12bc0087 Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Wed, 23 Nov 2022 17:09:48 -0700 Subject: [PATCH 036/154] apidump: Correctly quote json in unknown pnext struct When printing pNext chains, correctly print the quotes necessary for the json output to be valid. --- scripts/api_dump_generator.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/api_dump_generator.py b/scripts/api_dump_generator.py index 13c5b33e57..9730fcbb20 100644 --- a/scripts/api_dump_generator.py +++ b/scripts/api_dump_generator.py @@ -1489,7 +1489,7 @@ settings.stream() << settings.indentation(indents) << "{{\\n"; settings.stream() << settings.indentation(indents + 1) << "\\"type\\" : \\"const void*\\",\\n"; settings.stream() << settings.indentation(indents + 1) << "\\"name\\" : \\"pNext\\",\\n"; - settings.stream() << settings.indentation(indents + 1) << "\\"value\\" : \\"UNKNOWN (\\"" << (int64_t) (static_cast(object)->sType) << "\\")\\n"; + settings.stream() << settings.indentation(indents + 1) << "\\"value\\" : \\"UNKNOWN (" << (int64_t) (static_cast(object)->sType) << ")\\"\\n"; settings.stream() << settings.indentation(indents) << "}}"; }} }} From 4c99c82ba21cdc83065974d4b725842ef172aadc Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Fri, 2 Dec 2022 13:43:47 -0700 Subject: [PATCH 037/154] apidump: Use const correctly in pNext printing The pNext chain printer for the text output didn't forward the fact that structs sometimes have void* and other times have const void* for their pNext chain. Forward the information allows for more accurate printing. Also fix issue where vkQueuePresentKHR had a return type 'vVkResult'. --- scripts/api_dump_generator.py | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/scripts/api_dump_generator.py b/scripts/api_dump_generator.py index 9730fcbb20..a0895754f7 100644 --- a/scripts/api_dump_generator.py +++ b/scripts/api_dump_generator.py @@ -306,13 +306,13 @@ switch(ApiDumpInstance::current().settings().format()) {{ case ApiDumpFormat::Text: - dump_text_function_head(ApiDumpInstance::current(), \"vkQueuePresentKHR(queue, pPresentInfo)\", \"vVkResult\"); + dump_text_function_head(ApiDumpInstance::current(), \"vkQueuePresentKHR(queue, pPresentInfo)\", \"VkResult\"); break; case ApiDumpFormat::Html: - dump_html_function_head(ApiDumpInstance::current(), \"vkQueuePresentKHR(queue, pPresentInfo)\", \"vVkResult\"); + dump_html_function_head(ApiDumpInstance::current(), \"vkQueuePresentKHR(queue, pPresentInfo)\", \"VkResult\"); break; case ApiDumpFormat::Json: - dump_json_function_head(ApiDumpInstance::current(), \"vkQueuePresentKHR\", \"vVkResult\"); + dump_json_function_head(ApiDumpInstance::current(), \"vkQueuePresentKHR\", \"VkResult\"); break; }} }} @@ -656,7 +656,7 @@ void dump_text_pNext_struct_name(const void* object, const ApiDumpSettings& settings, int indents) {{ if (object == nullptr) {{ - dump_text_value(object, settings, "const void*", "pNext", indents, dump_text_void); + dump_text_value(object, settings, "void*", "pNext", indents, dump_text_void); return; }} @@ -664,7 +664,12 @@ @foreach struct @if({sctStructureTypeIndex} != -1) case {sctStructureTypeIndex}: + @if({sctIsPNextChainConst} == True) settings.formatNameType(settings.stream(), indents, "pNext", "const void*"); + @end if + @if({sctIsPNextChainConst} == False) + settings.formatNameType(settings.stream(), indents, "pNext", "void*"); + @end if settings.stream() << "{sctName}\\n"; break; @end if @@ -2758,10 +2763,17 @@ def __init__(self, rootNode, constants, enums): if(member.structValues == opt.name): self.structureIndex = opt.value + self.isPNextChainConst = False + for member in self.members: + if member.name == 'pNext' and member.type == "const void*": + self.isPNextChainConst = True + break + def values(self): return { 'sctName': self.name, 'sctStructureTypeIndex': self.structureIndex, + 'sctIsPNextChainConst': self.isPNextChainConst, } class VulkanSystemType: From ab40864cd1176727a01a557d2323445c89524a01 Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Sat, 3 Dec 2022 20:06:33 -0700 Subject: [PATCH 038/154] apidump: Remove unnecessary struct declarations The only thing 'needing' function declarations is the pNext printer, because vk.xml is designed to have all the type dependencies encoded in the order the types appear in the xml. However, since api dump prints unions separately, the unions at least need to be forward declared for the struct printers. By forward declaring the pNext printing functions, it is possible to remove all of the struct forward declarations. --- scripts/api_dump_generator.py | 264 +++++++++++++++++----------------- 1 file changed, 132 insertions(+), 132 deletions(-) diff --git a/scripts/api_dump_generator.py b/scripts/api_dump_generator.py index a0895754f7..84f49d6868 100644 --- a/scripts/api_dump_generator.py +++ b/scripts/api_dump_generator.py @@ -628,9 +628,9 @@ #include "api_dump.h" -@foreach struct -void dump_text_{sctName}(const {sctName}& object, const ApiDumpSettings& settings, int indents); -@end struct +void dump_text_pNext_struct_name(const void* object, const ApiDumpSettings& settings, int indents); +void dump_text_pNext_trampoline(const void* object, const ApiDumpSettings& settings, int indents); + @foreach union void dump_text_{unName}(const {unName}& object, const ApiDumpSettings& settings, int indents); @end union @@ -651,67 +651,6 @@ }} #endif // VK_ENABLE_BETA_EXTENSIONS -//======================== pNext Chain Implementation =======================// - -void dump_text_pNext_struct_name(const void* object, const ApiDumpSettings& settings, int indents) -{{ - if (object == nullptr) {{ - dump_text_value(object, settings, "void*", "pNext", indents, dump_text_void); - return; - }} - - switch((int64_t) (static_cast(object)->sType)) {{ - @foreach struct - @if({sctStructureTypeIndex} != -1) - case {sctStructureTypeIndex}: - @if({sctIsPNextChainConst} == True) - settings.formatNameType(settings.stream(), indents, "pNext", "const void*"); - @end if - @if({sctIsPNextChainConst} == False) - settings.formatNameType(settings.stream(), indents, "pNext", "void*"); - @end if - settings.stream() << "{sctName}\\n"; - break; - @end if - @end struct - - case 47: // VK_STRUCTURE_TYPE_LOADER_INSTANCE_CREATE_INFO - case 48: // VK_STRUCTURE_TYPE_LOADER_DEVICE_CREATE_INFO - settings.formatNameType(settings.stream(), indents, "pNext", "const void*"); - settings.stream() << "NULL\\n"; - break; - default: - settings.formatNameType(settings.stream(), indents, "pNext", "const void*"); - settings.stream() << "UNKNOWN (" << (int64_t) (static_cast(object)->sType) << ")\\n"; - }} -}} - -void dump_text_pNext_trampoline(const void* object, const ApiDumpSettings& settings, int indents) -{{ - switch((int64_t) (static_cast(object)->sType)) {{ - @foreach struct - @if({sctStructureTypeIndex} != -1) - case {sctStructureTypeIndex}: - dump_text_pNext(static_cast(object), settings, "{sctName}", indents, dump_text_{sctName}); - break; - @end if - @end struct - - case 47: // VK_STRUCTURE_TYPE_LOADER_INSTANCE_CREATE_INFO - case 48: // VK_STRUCTURE_TYPE_LOADER_DEVICE_CREATE_INFO - if(static_cast(object)->pNext != nullptr){{ - dump_text_pNext_trampoline(static_cast(static_cast(object)->pNext), settings, indents); - }} else {{ - settings.formatNameType(settings.stream(), indents, "pNext", "const void*"); - settings.stream() << "NULL\\n"; - }} - break; - default: - settings.formatNameType(settings.stream(), indents, "pNext", "const void*"); - settings.stream() << "UNKNOWN (" << (int64_t) (static_cast(object)->sType) << ")\\n"; - }} -}} - //=========================== Type Implementations ==========================// @foreach type where('{etyName}' != 'void') @@ -974,6 +913,67 @@ }} @end union +//======================== pNext Chain Implementation =======================// + +void dump_text_pNext_struct_name(const void* object, const ApiDumpSettings& settings, int indents) +{{ + if (object == nullptr) {{ + dump_text_value(object, settings, "void*", "pNext", indents, dump_text_void); + return; + }} + + switch((int64_t) (static_cast(object)->sType)) {{ + @foreach struct + @if({sctStructureTypeIndex} != -1) + case {sctStructureTypeIndex}: + @if({sctIsPNextChainConst} == True) + settings.formatNameType(settings.stream(), indents, "pNext", "const void*"); + @end if + @if({sctIsPNextChainConst} == False) + settings.formatNameType(settings.stream(), indents, "pNext", "void*"); + @end if + settings.stream() << "{sctName}\\n"; + break; + @end if + @end struct + + case 47: // VK_STRUCTURE_TYPE_LOADER_INSTANCE_CREATE_INFO + case 48: // VK_STRUCTURE_TYPE_LOADER_DEVICE_CREATE_INFO + settings.formatNameType(settings.stream(), indents, "pNext", "const void*"); + settings.stream() << "NULL\\n"; + break; + default: + settings.formatNameType(settings.stream(), indents, "pNext", "const void*"); + settings.stream() << "UNKNOWN (" << (int64_t) (static_cast(object)->sType) << ")\\n"; + }} +}} + +void dump_text_pNext_trampoline(const void* object, const ApiDumpSettings& settings, int indents) +{{ + switch((int64_t) (static_cast(object)->sType)) {{ + @foreach struct + @if({sctStructureTypeIndex} != -1) + case {sctStructureTypeIndex}: + dump_text_pNext(static_cast(object), settings, "{sctName}", indents, dump_text_{sctName}); + break; + @end if + @end struct + + case 47: // VK_STRUCTURE_TYPE_LOADER_INSTANCE_CREATE_INFO + case 48: // VK_STRUCTURE_TYPE_LOADER_DEVICE_CREATE_INFO + if(static_cast(object)->pNext != nullptr){{ + dump_text_pNext_trampoline(static_cast(static_cast(object)->pNext), settings, indents); + }} else {{ + settings.formatNameType(settings.stream(), indents, "pNext", "const void*"); + settings.stream() << "NULL\\n"; + }} + break; + default: + settings.formatNameType(settings.stream(), indents, "pNext", "const void*"); + settings.stream() << "UNKNOWN (" << (int64_t) (static_cast(object)->sType) << ")\\n"; + }} +}} + //========================= Function Implementations ========================// @foreach function where('{funcName}' not in ['vkGetDeviceProcAddr', 'vkGetInstanceProcAddr']) @@ -1049,9 +1049,8 @@ #include "api_dump.h" -@foreach struct -void dump_html_{sctName}(const {sctName}& object, const ApiDumpSettings& settings, int indents); -@end struct +void dump_html_pNext_trampoline(const void* object, const ApiDumpSettings& settings, int indents); + @foreach union void dump_html_{unName}(const {unName}& object, const ApiDumpSettings& settings, int indents); @end union @@ -1072,35 +1071,7 @@ }} #endif // VK_ENABLE_BETA_EXTENSIONS -//======================== pNext Chain Implementation =======================// -void dump_html_pNext_trampoline(const void* object, const ApiDumpSettings& settings, int indents) -{{ - switch((int64_t) (static_cast(object)->sType)) {{ - @foreach struct - @if({sctStructureTypeIndex} != -1) - case {sctStructureTypeIndex}: - dump_html_pNext(static_cast(object), settings, "{sctName}", indents, dump_html_{sctName}); - break; - @end if - @end struct - - case 47: // VK_STRUCTURE_TYPE_LOADER_INSTANCE_CREATE_INFO - case 48: // VK_STRUCTURE_TYPE_LOADER_DEVICE_CREATE_INFO - if(static_cast(object)->pNext != nullptr){{ - dump_html_pNext_trampoline(static_cast(static_cast(object)->pNext), settings, indents); - }} else {{ - settings.stream() << "
"; - dump_html_nametype(settings.stream(), settings.showType(), "pNext", "const void*"); - settings.stream() << "
NULL
"; - }} - break; - default: - settings.stream() << "
"; - dump_html_nametype(settings.stream(), settings.showType(), "pNext", "const void*"); - settings.stream() << "
UNKNOWN (" << (int64_t) (static_cast(object)->sType) <<")
"; - }} -}} //=========================== Type Implementations ==========================// @foreach type where('{etyName}' != 'void') @@ -1367,6 +1338,36 @@ }} @end union +//======================== pNext Chain Implementation =======================// + +void dump_html_pNext_trampoline(const void* object, const ApiDumpSettings& settings, int indents) +{{ + switch((int64_t) (static_cast(object)->sType)) {{ + @foreach struct + @if({sctStructureTypeIndex} != -1) + case {sctStructureTypeIndex}: + dump_html_pNext(static_cast(object), settings, "{sctName}", indents, dump_html_{sctName}); + break; + @end if + @end struct + + case 47: // VK_STRUCTURE_TYPE_LOADER_INSTANCE_CREATE_INFO + case 48: // VK_STRUCTURE_TYPE_LOADER_DEVICE_CREATE_INFO + if(static_cast(object)->pNext != nullptr){{ + dump_html_pNext_trampoline(static_cast(static_cast(object)->pNext), settings, indents); + }} else {{ + settings.stream() << "
"; + dump_html_nametype(settings.stream(), settings.showType(), "pNext", "const void*"); + settings.stream() << "
NULL
"; + }} + break; + default: + settings.stream() << "
"; + dump_html_nametype(settings.stream(), settings.showType(), "pNext", "const void*"); + settings.stream() << "
UNKNOWN (" << (int64_t) (static_cast(object)->sType) <<")
"; + }} +}} + //========================= Function Implementations ========================// @foreach function where('{funcName}' not in ['vkGetDeviceProcAddr', 'vkGetInstanceProcAddr']) @@ -1442,9 +1443,8 @@ #include "api_dump.h" -@foreach struct -void dump_json_{sctName}(const {sctName}& object, const ApiDumpSettings& settings, int indents); -@end struct +void dump_json_pNext_trampoline(const void* object, const ApiDumpSettings& settings, int indents); + @foreach union void dump_json_{unName}(const {unName}& object, const ApiDumpSettings& settings, int indents); @end union @@ -1465,40 +1465,6 @@ }} #endif // VK_ENABLE_BETA_EXTENSIONS -//======================== pNext Chain Implementation =======================// - -void dump_json_pNext_trampoline(const void* object, const ApiDumpSettings& settings, int indents) -{{ - switch((int64_t) (static_cast(object)->sType)) {{ - @foreach struct - @if({sctStructureTypeIndex} != -1) - case {sctStructureTypeIndex}: - dump_json_pNext(static_cast(object), settings, "{sctName}", indents, dump_json_{sctName}); - break; - @end if - @end struct - - case 47: // VK_STRUCTURE_TYPE_LOADER_INSTANCE_CREATE_INFO - case 48: // VK_STRUCTURE_TYPE_LOADER_DEVICE_CREATE_INFO - if(static_cast(object)->pNext != nullptr){{ - dump_json_pNext_trampoline(static_cast(static_cast(object)->pNext), settings, indents); - }} else {{ - settings.stream() << settings.indentation(indents) << "{{\\n"; - settings.stream() << settings.indentation(indents + 1) << "\\"type\\" : \\"const void*\\",\\n"; - settings.stream() << settings.indentation(indents + 1) << "\\"name\\" : \\"pNext\\",\\n"; - settings.stream() << settings.indentation(indents + 1) << "\\"value\\" : \\"NULL\\"\\n"; - settings.stream() << settings.indentation(indents) << "}}"; - }} - break; - default: - settings.stream() << settings.indentation(indents) << "{{\\n"; - settings.stream() << settings.indentation(indents + 1) << "\\"type\\" : \\"const void*\\",\\n"; - settings.stream() << settings.indentation(indents + 1) << "\\"name\\" : \\"pNext\\",\\n"; - settings.stream() << settings.indentation(indents + 1) << "\\"value\\" : \\"UNKNOWN (" << (int64_t) (static_cast(object)->sType) << ")\\"\\n"; - settings.stream() << settings.indentation(indents) << "}}"; - }} -}} - //=========================== Type Implementations ==========================// @foreach type where('{etyName}' != 'void') @@ -1784,6 +1750,40 @@ return false; }} +//======================== pNext Chain Implementation =======================// + +void dump_json_pNext_trampoline(const void* object, const ApiDumpSettings& settings, int indents) +{{ + switch((int64_t) (static_cast(object)->sType)) {{ + @foreach struct + @if({sctStructureTypeIndex} != -1) + case {sctStructureTypeIndex}: + dump_json_pNext(static_cast(object), settings, "{sctName}", indents, dump_json_{sctName}); + break; + @end if + @end struct + + case 47: // VK_STRUCTURE_TYPE_LOADER_INSTANCE_CREATE_INFO + case 48: // VK_STRUCTURE_TYPE_LOADER_DEVICE_CREATE_INFO + if(static_cast(object)->pNext != nullptr){{ + dump_json_pNext_trampoline(static_cast(static_cast(object)->pNext), settings, indents); + }} else {{ + settings.stream() << settings.indentation(indents) << "{{\\n"; + settings.stream() << settings.indentation(indents + 1) << "\\"type\\" : \\"const void*\\",\\n"; + settings.stream() << settings.indentation(indents + 1) << "\\"name\\" : \\"pNext\\",\\n"; + settings.stream() << settings.indentation(indents + 1) << "\\"value\\" : \\"NULL\\"\\n"; + settings.stream() << settings.indentation(indents) << "}}"; + }} + break; + default: + settings.stream() << settings.indentation(indents) << "{{\\n"; + settings.stream() << settings.indentation(indents + 1) << "\\"type\\" : \\"const void*\\",\\n"; + settings.stream() << settings.indentation(indents + 1) << "\\"name\\" : \\"pNext\\",\\n"; + settings.stream() << settings.indentation(indents + 1) << "\\"value\\" : \\"UNKNOWN (" << (int64_t) (static_cast(object)->sType) << ")\\"\\n"; + settings.stream() << settings.indentation(indents) << "}}"; + }} +}} + //========================= Function Implementations ========================// @foreach function where(not '{funcName}' in ['vkGetDeviceProcAddr', 'vkGetInstanceProcAddr']) From cfde94c2f45b4ca17ffc52c7c75e15a5ab6bab8f Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Sat, 3 Dec 2022 20:09:34 -0700 Subject: [PATCH 039/154] apidump: Indent struct generator template Because there are several levels of nested if statements, it became very difficult to read the templating code. Thus, indenting the if statements to their corresponding level visually clarifies the already complex generation logic. --- scripts/api_dump_generator.py | 178 +++++++++++++++++----------------- 1 file changed, 89 insertions(+), 89 deletions(-) diff --git a/scripts/api_dump_generator.py b/scripts/api_dump_generator.py index 84f49d6868..506807cb2e 100644 --- a/scripts/api_dump_generator.py +++ b/scripts/api_dump_generator.py @@ -802,53 +802,53 @@ settings.stream() << "address:\\n"; @foreach member - @if('{memCondition}' != 'None') + @if('{memCondition}' != 'None') if({memCondition}) - @end if - @if('{memParameterStorage}' != '') + @end if + @if('{memParameterStorage}' != '') {memParameterStorage} - @end if - @if({memPtrLevel} == 0) - @if('{memName}' != 'pNext') - dump_text_value(object.{memName}, settings, "{memType}", "{memName}", indents + 1, dump_text_{memTypeID}); // AET @end if - @if('{memName}' == 'pNext') + @if({memPtrLevel} == 0) + @if('{memName}' != 'pNext') + dump_text_value(object.{memName}, settings, "{memType}", "{memName}", indents + 1, dump_text_{memTypeID}); // AET + @end if + @if('{memName}' == 'pNext') dump_text_pNext_struct_name(object.{memName}, settings, indents + 1); + @end if @end if - @end if - @if({memPtrLevel} == 1 and '{memLength}' == 'None') + @if({memPtrLevel} == 1 and '{memLength}' == 'None') dump_text_pointer(object.{memName}, settings, "{memType}", "{memName}", indents + 1, dump_text_{memTypeID}); - @end if - @if({memPtrLevel} == 1 and '{memLength}' != 'None' and not {memLengthIsMember}) + @end if + @if({memPtrLevel} == 1 and '{memLength}' != 'None' and not {memLengthIsMember}) dump_text_array(object.{memName}, {memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_text_{memTypeID}); // AQA - @end if - @if({memPtrLevel} == 1 and '{memLength}' != 'None' and {memLengthIsMember} and '{memName}' != 'pCode') - @if('{memLength}'[0].isdigit() or '{memLength}'[0].isupper()) + @end if + @if({memPtrLevel} == 1 and '{memLength}' != 'None' and {memLengthIsMember} and '{memName}' != 'pCode') + @if('{memLength}'[0].isdigit() or '{memLength}'[0].isupper()) dump_text_array(object.{memName}, {memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_text_{memTypeID}); // BQA - @end if - @if(not ('{memLength}'[0].isdigit() or '{memLength}'[0].isupper())) - @if('{memLength}' == 'rasterizationSamples') + @end if + @if(not ('{memLength}'[0].isdigit() or '{memLength}'[0].isupper())) + @if('{memLength}' == 'rasterizationSamples') dump_text_array(object.{memName}, (object.{memLength} + 31) / 32, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_text_{memTypeID}); // BQB - @end if - @if('{memLength}' != 'rasterizationSamples') + @end if + @if('{memLength}' != 'rasterizationSamples') dump_text_array(object.{memName}, object.{memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_text_{memTypeID}); // BQB - @end if - @end if - @end if + @end if + @end if + @end if - @if('{sctName}' == 'VkShaderModuleCreateInfo') - @if('{memName}' == 'pCode') + @if('{sctName}' == 'VkShaderModuleCreateInfo') + @if('{memName}' == 'pCode') if(settings.showShader()) dump_text_array(object.{memName}, object.{memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_text_{memTypeID}); // CQA else dump_text_special("SHADER DATA", settings, "{memType}", "{memName}", indents + 1); - @end if - @end if + @end if + @end if - @if('{memCondition}' != 'None') + @if('{memCondition}' != 'None') else dump_text_special("UNUSED", settings, "{memType}", "{memName}", indents + 1); - @end if + @end if @end member @foreach member @@ -1229,56 +1229,56 @@ settings.stream() << "
"; @foreach member - @if('{memCondition}' != 'None') + @if('{memCondition}' != 'None') if({memCondition}) - @end if - @if('{memParameterStorage}' != '') + @end if + @if('{memParameterStorage}' != '') {memParameterStorage} - @end if - @if({memPtrLevel} == 0) - @if('{memName}' != 'pNext') - dump_html_value(object.{memName}, settings, "{memType}", "{memName}", indents + 1, dump_html_{memTypeID}); @end if - @if('{memName}' == 'pNext') + @if({memPtrLevel} == 0) + @if('{memName}' != 'pNext') + dump_html_value(object.{memName}, settings, "{memType}", "{memName}", indents + 1, dump_html_{memTypeID}); + @end if + @if('{memName}' == 'pNext') if(object.pNext != nullptr){{ dump_html_pNext_trampoline(object.{memName}, settings, indents + 1); }} else {{ dump_html_value(object.{memName}, settings, "{memType}", "{memName}", indents + 1, dump_html_{memTypeID}); }} + @end if @end if - @end if - @if({memPtrLevel} == 1 and '{memLength}' == 'None') + @if({memPtrLevel} == 1 and '{memLength}' == 'None') dump_html_pointer(object.{memName}, settings, "{memType}", "{memName}", indents + 1, dump_html_{memTypeID}); - @end if - @if({memPtrLevel} == 1 and '{memLength}' != 'None' and not {memLengthIsMember}) + @end if + @if({memPtrLevel} == 1 and '{memLength}' != 'None' and not {memLengthIsMember}) dump_html_array(object.{memName}, {memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_html_{memTypeID}); // ZRR - @end if - @if({memPtrLevel} == 1 and '{memLength}' != 'None' and {memLengthIsMember} and '{memName}' != 'pCode') - @if('{memLength}'[0].isdigit() or '{memLength}'[0].isupper()) + @end if + @if({memPtrLevel} == 1 and '{memLength}' != 'None' and {memLengthIsMember} and '{memName}' != 'pCode') + @if('{memLength}'[0].isdigit() or '{memLength}'[0].isupper()) dump_html_array(object.{memName}, {memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_html_{memTypeID}); // ZRS - @end if - @if(not ('{memLength}'[0].isdigit() or '{memLength}'[0].isupper())) - @if('{memLength}' == 'rasterizationSamples') + @end if + @if(not ('{memLength}'[0].isdigit() or '{memLength}'[0].isupper())) + @if('{memLength}' == 'rasterizationSamples') dump_html_array(object.{memName}, (object.{memLength} + 31) / 32, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_html_{memTypeID}); // ZRT - @end if - @if('{memLength}' != 'rasterizationSamples') + @end if + @if('{memLength}' != 'rasterizationSamples') dump_html_array(object.{memName}, object.{memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_html_{memTypeID}); // ZRT - @end if - @end if - @end if - @if('{sctName}' == 'VkShaderModuleCreateInfo') - @if('{memName}' == 'pCode') + @end if + @end if + @end if + @if('{sctName}' == 'VkShaderModuleCreateInfo') + @if('{memName}' == 'pCode') if(settings.showShader()) dump_html_array(object.{memName}, object.{memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_html_{memTypeID}); // ZRU else dump_html_special("SHADER DATA", settings, "{memType}", "{memName}", indents + 1); - @end if - @end if + @end if + @end if - @if('{memCondition}' != 'None') + @if('{memCondition}' != 'None') else dump_html_special("UNUSED", settings, "{memType}", "{memName}", indents + 1); - @end if + @end if @end member }} @end struct @@ -1606,56 +1606,56 @@ settings.stream() << settings.indentation(indents) << "[\\n"; @foreach member - @if({memIndex} != 0) + @if({memIndex} != 0) settings.stream() << ",\\n"; - @end if - @if('{memCondition}' != 'None') + @end if + @if('{memCondition}' != 'None') if({memCondition}) - @end if - @if('{memParameterStorage}' != '') + @end if + @if('{memParameterStorage}' != '') {memParameterStorage} - @end if - @if({memPtrLevel} == 0) - @if('{memName}' != 'pNext') - dump_json_value(object.{memName}, NULL, settings, "{memType}", "{memName}", indents + 1, dump_json_{memTypeID}); @end if - @if('{memName}' == 'pNext') + @if({memPtrLevel} == 0) + @if('{memName}' != 'pNext') + dump_json_value(object.{memName}, NULL, settings, "{memType}", "{memName}", indents + 1, dump_json_{memTypeID}); + @end if + @if('{memName}' == 'pNext') if(object.pNext != nullptr){{ dump_json_pNext_trampoline(object.{memName}, settings, indents + 1); }} else {{ dump_json_value(object.{memName}, object.{memName}, settings, "{memType}", "{memName}", indents + 1, dump_json_{memTypeID}); }} + @end if @end if - @end if - @if({memPtrLevel} == 1 and '{memLength}' == 'None') + @if({memPtrLevel} == 1 and '{memLength}' == 'None') dump_json_pointer(object.{memName}, settings, "{memType}", "{memName}", indents + 1, dump_json_{memTypeID}); - @end if - @if({memPtrLevel} == 1 and '{memLength}' != 'None' and not {memLengthIsMember}) + @end if + @if({memPtrLevel} == 1 and '{memLength}' != 'None' and not {memLengthIsMember}) dump_json_array(object.{memName}, {memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_json_{memTypeID}); // IQA - @end if - @if({memPtrLevel} == 1 and '{memLength}' != 'None' and {memLengthIsMember} and '{memName}' != 'pCode') - @if('{memLength}'[0].isdigit() or '{memLength}'[0].isupper()) + @end if + @if({memPtrLevel} == 1 and '{memLength}' != 'None' and {memLengthIsMember} and '{memName}' != 'pCode') + @if('{memLength}'[0].isdigit() or '{memLength}'[0].isupper()) dump_json_array(object.{memName}, {memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_json_{memTypeID}); // JQA - @end if - @if(not ('{memLength}'[0].isdigit() or '{memLength}'[0].isupper())) - @if('{memLength}' == 'rasterizationSamples') + @end if + @if(not ('{memLength}'[0].isdigit() or '{memLength}'[0].isupper())) + @if('{memLength}' == 'rasterizationSamples') dump_json_array(object.{memName}, (object.{memLength} + 31) / 32, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_json_{memTypeID}); // JQA - @end if - @if('{memLength}' != 'rasterizationSamples') + @end if + @if('{memLength}' != 'rasterizationSamples') dump_json_array(object.{memName}, object.{memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_json_{memTypeID}); // JQA - @end if - @end if - @end if - @if('{sctName}' == 'VkShaderModuleCreateInfo') - @if('{memName}' == 'pCode') + @end if + @end if + @end if + @if('{sctName}' == 'VkShaderModuleCreateInfo') + @if('{memName}' == 'pCode') if(settings.showShader()) dump_json_array(object.{memName}, object.{memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_json_{memTypeID}); // KQA else dump_json_special("SHADER DATA", settings, "{memType}", "{memName}", indents + 1); - @end if - @end if + @end if + @end if - @if('{memCondition}' != 'None') + @if('{memCondition}' != 'None') else {{ settings.stream() << settings.indentation(indents+1) << "{{\\n"; @@ -1665,7 +1665,7 @@ settings.stream() << settings.indentation(indents+2) << "\\"value\\" : \\"UNUSED\\"\\n"; settings.stream() << settings.indentation(indents+1) << "}}"; }} - @end if + @end if @end member settings.stream() << "\\n" << settings.indentation(indents) << "]"; }} From db28df68f75486d565f6fece96d053aaeaedbdde Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Sat, 3 Dec 2022 20:11:03 -0700 Subject: [PATCH 040/154] apidump: Better handle array member special cases VkPhysicalDeviceMemoryProperties and VkPhysicalDeviceGroupProperties contain fixed length arrays whose actual length is determined by another struct member. Because the vk.xml does not contain the required information, we had to special case the generation for these structs. Now, instead of hardcoding the structs, fix the python data such that the autogen correctly writes out the desired printing logic. --- scripts/api_dump_generator.py | 105 ++++++---------------------------- 1 file changed, 17 insertions(+), 88 deletions(-) diff --git a/scripts/api_dump_generator.py b/scripts/api_dump_generator.py index 506807cb2e..6025ece975 100644 --- a/scripts/api_dump_generator.py +++ b/scripts/api_dump_generator.py @@ -793,7 +793,7 @@ //========================== Struct Implementations =========================// -@foreach struct where('{sctName}' not in ['VkPhysicalDeviceMemoryProperties','VkPhysicalDeviceGroupProperties']) +@foreach struct void dump_text_{sctName}(const {sctName}& object, const ApiDumpSettings& settings, int indents) {{ if(settings.showAddress()) @@ -863,32 +863,6 @@ }} @end struct -void dump_text_VkPhysicalDeviceMemoryProperties(const VkPhysicalDeviceMemoryProperties& object, const ApiDumpSettings& settings, int indents) -{{ - if(settings.showAddress()) - settings.stream() << &object << ":\\n"; - else - settings.stream() << "address:\\n"; - - dump_text_value(object.memoryTypeCount, settings, "uint32_t", "memoryTypeCount", indents + 1, dump_text_uint32_t); // FET - dump_text_array(object.memoryTypes, object.memoryTypeCount, settings, "VkMemoryType[VK_MAX_MEMORY_TYPES]", "VkMemoryType", "memoryTypes", indents + 1, dump_text_VkMemoryType); // DQA - dump_text_value(object.memoryHeapCount, settings, "uint32_t", "memoryHeapCount", indents + 1, dump_text_uint32_t); // GET - dump_text_array(object.memoryHeaps, object.memoryHeapCount, settings, "VkMemoryHeap[VK_MAX_MEMORY_HEAPS]", "VkMemoryHeap", "memoryHeaps", indents + 1, dump_text_VkMemoryHeap); // EQA -}} - -void dump_text_VkPhysicalDeviceGroupProperties(const VkPhysicalDeviceGroupProperties& object, const ApiDumpSettings& settings, int indents) -{{ - if(settings.showAddress()) - settings.stream() << &object << ":\\n"; - else - settings.stream() << "address:\\n"; - dump_text_value(object.sType, settings, "VkStructureType", "sType", indents + 1, dump_text_VkStructureType); // HET - dump_text_value(object.pNext, settings, "void*", "pNext", indents + 1, dump_text_void); // IET - dump_text_value(object.physicalDeviceCount, settings, "uint32_t", "physicalDeviceCount", indents + 1, dump_text_uint32_t); // JET - dump_text_array(object.physicalDevices, object.physicalDeviceCount, settings, "VkPhysicalDevice[VK_MAX_DEVICE_GROUP_SIZE]", "VkPhysicalDevice", "physicalDevices", indents + 1, dump_text_VkPhysicalDevice); // FQA - dump_text_value(object.subsetAllocation, settings, "VkBool32", "subsetAllocation", indents + 1, dump_text_VkBool32); // KET -}} - //========================== Union Implementations ==========================// @foreach union @@ -1218,7 +1192,7 @@ //========================== Struct Implementations =========================// -@foreach struct where('{sctName}' not in ['VkPhysicalDeviceMemoryProperties' ,'VkPhysicalDeviceGroupProperties']) +@foreach struct void dump_html_{sctName}(const {sctName}& object, const ApiDumpSettings& settings, int indents) {{ settings.stream() << "
"; @@ -1283,35 +1257,6 @@ }} @end struct -void dump_html_VkPhysicalDeviceMemoryProperties(const VkPhysicalDeviceMemoryProperties& object, const ApiDumpSettings& settings, int indents) -{{ - settings.stream() << "
"; - if(settings.showAddress()) - settings.stream() << &object << "\\n"; - else - settings.stream() << "address\\n"; - settings.stream() << "
"; - dump_html_value(object.memoryTypeCount, settings, "uint32_t", "memoryTypeCount", indents + 1, dump_html_uint32_t); - dump_html_array(object.memoryTypes, object.memoryTypeCount, settings, "VkMemoryType[VK_MAX_MEMORY_TYPES]", "VkMemoryType", "memoryTypes", indents + 1, dump_html_VkMemoryType); // ZRV - dump_html_value(object.memoryHeapCount, settings, "uint32_t", "memoryHeapCount", indents + 1, dump_html_uint32_t); - dump_html_array(object.memoryHeaps, object.memoryHeapCount, settings, "VkMemoryHeap[VK_MAX_MEMORY_HEAPS]", "VkMemoryHeap", "memoryHeaps", indents + 1, dump_html_VkMemoryHeap); // ZRW -}} - -void dump_html_VkPhysicalDeviceGroupProperties(const VkPhysicalDeviceGroupProperties& object, const ApiDumpSettings& settings, int indents) -{{ - settings.stream() << "
"; - if(settings.showAddress()) - settings.stream() << &object << "\\n"; - else - settings.stream() << "address\\n"; - settings.stream() << "
"; - dump_html_value(object.sType, settings, "VkStructureType", "sType", indents + 1, dump_html_VkStructureType); - dump_html_value(object.pNext, settings, "void*", "pNext", indents + 1, dump_html_void); - dump_html_value(object.physicalDeviceCount, settings, "uint32_t", "physicalDeviceCount", indents + 1, dump_html_uint32_t); - dump_html_array(object.physicalDevices, object.physicalDeviceCount, settings, "VkPhysicalDevice[VK_MAX_DEVICE_GROUP_SIZE]", "VkPhysicalDevice", "physicalDevices", indents + 1, dump_html_VkPhysicalDevice); // ZRX - dump_html_value(object.subsetAllocation, settings, "VkBool32", "subsetAllocation", indents + 1, dump_html_VkBool32); -}} - //========================== Union Implementations ==========================// @foreach union @@ -1600,7 +1545,7 @@ //========================== Struct Implementations =========================// -@foreach struct where('{sctName}' not in ['VkPhysicalDeviceMemoryProperties' ,'VkPhysicalDeviceGroupProperties']) +@foreach struct void dump_json_{sctName}(const {sctName}& object, const ApiDumpSettings& settings, int indents) {{ settings.stream() << settings.indentation(indents) << "[\\n"; @@ -1683,36 +1628,6 @@ return false; }} -void dump_json_VkPhysicalDeviceMemoryProperties(const VkPhysicalDeviceMemoryProperties& object, const ApiDumpSettings& settings, int indents) -{{ - settings.stream() << settings.indentation(indents) << "[\\n"; - - dump_json_value(object.memoryTypeCount, NULL, settings, "uint32_t", "memoryTypeCount", indents + 1, dump_json_uint32_t); - settings.stream() << ",\\n"; - dump_json_array(object.memoryTypes, object.memoryTypeCount, settings, "VkMemoryType[VK_MAX_MEMORY_TYPES]", "VkMemoryType", "memoryTypes", indents + 1, dump_json_VkMemoryType); // LQA - settings.stream() << ",\\n"; - dump_json_value(object.memoryHeapCount, NULL, settings, "uint32_t", "memoryHeapCount", indents + 1, dump_json_uint32_t); - settings.stream() << ",\\n"; - dump_json_array(object.memoryHeaps, object.memoryHeapCount, settings, "VkMemoryHeap[VK_MAX_MEMORY_HEAPS]", "VkMemoryHeap", "memoryHeaps", indents + 1, dump_json_VkMemoryHeap); // MQA - settings.stream() << "\\n" << settings.indentation(indents) << "]"; -}} - -void dump_json_VkPhysicalDeviceGroupProperties(const VkPhysicalDeviceGroupProperties& object, const ApiDumpSettings& settings, int indents) -{{ - settings.stream() << settings.indentation(indents) << "[\\n"; - - dump_json_value(object.sType, NULL, settings, "VkStructureType", "sType", indents + 1, dump_json_VkStructureType); - settings.stream() << ",\\n"; - dump_json_value(object.pNext, object.pNext, settings, "void*", "pNext", indents + 1, dump_json_void); - settings.stream() << ",\\n"; - dump_json_value(object.physicalDeviceCount, NULL, settings, "uint32_t", "physicalDeviceCount", indents + 1, dump_json_uint32_t); - settings.stream() << ",\\n"; - dump_json_array(object.physicalDevices, object.physicalDeviceCount, settings, "VkPhysicalDevice[VK_MAX_DEVICE_GROUP_SIZE]", "VkPhysicalDevice", "physicalDevices", indents + 1, dump_json_VkPhysicalDevice); // NQA - settings.stream() << ",\\n"; - dump_json_value(object.subsetAllocation, NULL, settings, "VkBool32", "subsetAllocation", indents + 1, dump_json_VkBool32); - settings.stream() << "\\n" << settings.indentation(indents) << "]"; -}} - //========================== Union Implementations ==========================// @foreach union void dump_json_{unName}(const {unName}& object, const ApiDumpSettings& settings, int indents) @@ -2769,6 +2684,20 @@ def __init__(self, rootNode, constants, enums): self.isPNextChainConst = True break + # The xml doesn't contain the relevant information here since the struct contains 'fixed' length arrays. + # Thus we have to fix up the variable such that the length member corresponds to the runtime length, not compile time. + if self.name in ['VkPhysicalDeviceMemoryProperties','VkPhysicalDeviceGroupProperties']: + for member in self.members: + if member.name == 'memoryTypes': + member.lengthMember = True + member.arrayLength = 'memoryTypeCount' + if member.name == 'memoryHeaps': + member.lengthMember = True + member.arrayLength = 'memoryHeapCount' + if member.name == 'physicalDevices': + member.lengthMember = True + member.arrayLength = 'physicalDeviceCount' + def values(self): return { 'sctName': self.name, From 4de0adff5db06e8a719d8bc96825bf30ae34a80d Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Sat, 3 Dec 2022 20:50:11 -0700 Subject: [PATCH 041/154] apidump: Consolidate api_dump.cpp template The intent of these changes is to reduce the copy-pasting between the functions which have specific code that needs to be executed. This includes: * Combining void and non-void returning functions * Moving the special bits of the following functions into the common generator: - vkDestroyInstance - vkDestroyDevice - vkQueuePresentKHR - vkGetPhysicalDeviceToolPropertiesEXT * Correctly identifying whether a function is instance, device, or global - This prevents generation of global functions which all have hardcoded implementations This fixes an issue where vkGetPhysicalDeviceToolPropertiesEXT didn't unlock the mutex at the end of the function. Issues like that are why consolidation was done. --- scripts/api_dump_generator.py | 332 ++++++++-------------------------- 1 file changed, 80 insertions(+), 252 deletions(-) diff --git a/scripts/api_dump_generator.py b/scripts/api_dump_generator.py index 6025ece975..79e82809e5 100644 --- a/scripts/api_dump_generator.py +++ b/scripts/api_dump_generator.py @@ -131,46 +131,6 @@ return result; }} -VK_LAYER_EXPORT VKAPI_ATTR void VKAPI_CALL vkDestroyInstance(VkInstance instance, const VkAllocationCallbacks* pAllocator) -{{ - ApiDumpInstance::current().outputMutex()->lock(); - if (ApiDumpInstance::current().shouldDumpOutput()) {{ - switch(ApiDumpInstance::current().settings().format()) - {{ - case ApiDumpFormat::Text: - dump_text_function_head(ApiDumpInstance::current(), \"vkDestroyInstance(instance, pAllocator)\", \"void\"); - break; - case ApiDumpFormat::Html: - dump_html_function_head(ApiDumpInstance::current(), \"vkDestroyInstance(instance, pAllocator)\", \"void\"); - break; - case ApiDumpFormat::Json: - dump_json_function_head(ApiDumpInstance::current(), \"vkDestroyInstance\", \"void\"); - break; - }} - }} - // Destroy the dispatch table - dispatch_key key = get_dispatch_key(instance); - instance_dispatch_table(instance)->DestroyInstance(instance, pAllocator); - destroy_instance_dispatch_table(key); - - // Output the API dump - if (ApiDumpInstance::current().shouldDumpOutput()) {{ - switch(ApiDumpInstance::current().settings().format()) - {{ - case ApiDumpFormat::Text: - dump_text_vkDestroyInstance(ApiDumpInstance::current(), instance, pAllocator); - break; - case ApiDumpFormat::Html: - dump_html_vkDestroyInstance(ApiDumpInstance::current(), instance, pAllocator); - break; - case ApiDumpFormat::Json: - dump_json_vkDestroyInstance(ApiDumpInstance::current(), instance, pAllocator); - break; - }} - }} - ApiDumpInstance::current().outputMutex()->unlock(); -}} - VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkCreateDevice(VkPhysicalDevice physicalDevice, const VkDeviceCreateInfo* pCreateInfo, const VkAllocationCallbacks* pAllocator, VkDevice* pDevice) {{ ApiDumpInstance::current().outputMutex()->lock(); @@ -225,47 +185,6 @@ return result; }} -VK_LAYER_EXPORT VKAPI_ATTR void VKAPI_CALL vkDestroyDevice(VkDevice device, const VkAllocationCallbacks* pAllocator) -{{ - ApiDumpInstance::current().outputMutex()->lock(); - if (ApiDumpInstance::current().shouldDumpOutput()) {{ - switch(ApiDumpInstance::current().settings().format()) - {{ - case ApiDumpFormat::Text: - dump_text_function_head(ApiDumpInstance::current(), \"vkDestroyDevice(device, pAllocator)\", \"void\"); - break; - case ApiDumpFormat::Html: - dump_html_function_head(ApiDumpInstance::current(), \"vkDestroyDevice(device, pAllocator)\", \"void\"); - break; - case ApiDumpFormat::Json: - dump_json_function_head(ApiDumpInstance::current(), \"vkDestroyDevice\", \"void\"); - break; - }} - }} - - // Destroy the dispatch table - dispatch_key key = get_dispatch_key(device); - device_dispatch_table(device)->DestroyDevice(device, pAllocator); - destroy_device_dispatch_table(key); - - // Output the API dump - if (ApiDumpInstance::current().shouldDumpOutput()) {{ - switch(ApiDumpInstance::current().settings().format()) - {{ - case ApiDumpFormat::Text: - dump_text_vkDestroyDevice(ApiDumpInstance::current(), device, pAllocator); - break; - case ApiDumpFormat::Html: - dump_html_vkDestroyDevice(ApiDumpInstance::current(), device, pAllocator); - break; - case ApiDumpFormat::Json: - dump_json_vkDestroyDevice(ApiDumpInstance::current(), device, pAllocator); - break; - }} - }} - ApiDumpInstance::current().outputMutex()->unlock(); -}} - VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateInstanceExtensionProperties(const char* pLayerName, uint32_t* pPropertyCount, VkExtensionProperties* pProperties) {{ return util_GetExtensionProperties(0, NULL, pPropertyCount, pProperties); @@ -299,47 +218,9 @@ return util_GetLayerProperties(ARRAY_SIZE(layerProperties), layerProperties, pPropertyCount, pProperties); }} -VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkQueuePresentKHR(VkQueue queue, const VkPresentInfoKHR* pPresentInfo) -{{ - ApiDumpInstance::current().outputMutex()->lock(); - if (ApiDumpInstance::current().shouldDumpOutput()) {{ - switch(ApiDumpInstance::current().settings().format()) - {{ - case ApiDumpFormat::Text: - dump_text_function_head(ApiDumpInstance::current(), \"vkQueuePresentKHR(queue, pPresentInfo)\", \"VkResult\"); - break; - case ApiDumpFormat::Html: - dump_html_function_head(ApiDumpInstance::current(), \"vkQueuePresentKHR(queue, pPresentInfo)\", \"VkResult\"); - break; - case ApiDumpFormat::Json: - dump_json_function_head(ApiDumpInstance::current(), \"vkQueuePresentKHR\", \"VkResult\"); - break; - }} - }} - - VkResult result = device_dispatch_table(queue)->QueuePresentKHR(queue, pPresentInfo); - if (ApiDumpInstance::current().shouldDumpOutput()) {{ - switch(ApiDumpInstance::current().settings().format()) - {{ - case ApiDumpFormat::Text: - dump_text_vkQueuePresentKHR(ApiDumpInstance::current(), result, queue, pPresentInfo); - break; - case ApiDumpFormat::Html: - dump_html_vkQueuePresentKHR(ApiDumpInstance::current(), result, queue, pPresentInfo); - break; - case ApiDumpFormat::Json: - dump_json_vkQueuePresentKHR(ApiDumpInstance::current(), result, queue, pPresentInfo); - break; - }} - }} - ApiDumpInstance::current().nextFrame(); - ApiDumpInstance::current().outputMutex()->unlock(); - return result; -}} - // Autogen instance functions -@foreach function where('{funcDispatchType}' == 'instance' and '{funcReturn}' != 'void' and '{funcName}' not in ['vkCreateInstance', 'vkDestroyInstance', 'vkCreateDevice', 'vkGetInstanceProcAddr', 'vkEnumerateDeviceExtensionProperties', 'vkEnumerateDeviceLayerProperties','vkGetPhysicalDeviceToolPropertiesEXT']) +@foreach function where('{funcDispatchType}' == 'instance' and '{funcName}' not in ['vkCreateInstance', 'vkCreateDevice', 'vkGetInstanceProcAddr', 'vkEnumerateDeviceExtensionProperties', 'vkEnumerateDeviceLayerProperties']) VK_LAYER_EXPORT VKAPI_ATTR {funcReturn} VKAPI_CALL {funcName}({funcTypedParams}) {{ ApiDumpInstance::current().outputMutex()->lock(); @@ -357,7 +238,31 @@ break; }} }} + + @if('{funcName}' == 'vkGetPhysicalDeviceToolPropertiesEXT') + static const VkPhysicalDeviceToolPropertiesEXT api_dump_layer_tool_props = {{ + VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_TOOL_PROPERTIES_EXT, + nullptr, + "API Dump Layer", + "2", + VK_TOOL_PURPOSE_PROFILING_BIT_EXT | VK_TOOL_PURPOSE_TRACING_BIT_EXT, + "The VK_LAYER_LUNARG_api_dump utility layer prints API calls, parameters, and values to the identified output stream.", + "VK_LAYER_LUNARG_api_dump"}}; + + auto original_pToolProperties = pToolProperties; + if (pToolProperties != nullptr) {{ + *pToolProperties = api_dump_layer_tool_props; + pToolProperties = ((*pToolCount > 1) ? &pToolProperties[1] : nullptr); + (*pToolCount)--; + }} + @end if + + @if('{funcReturn}' != 'void') {funcReturn} result = instance_dispatch_table({funcDispatchParam})->{funcShortName}({funcNamedParams}); + @end if + @if('{funcReturn}' == 'void') + instance_dispatch_table({funcDispatchParam})->{funcShortName}({funcNamedParams}); + @end if {funcStateTrackingCode} @if('{funcName}' == 'vkEnumeratePhysicalDevices') if (pPhysicalDeviceCount != nullptr && pPhysicalDevices != nullptr) {{ @@ -366,10 +271,22 @@ }} }} @end if + @if('{funcName}' == 'vkDestroyInstance') + destroy_instance_dispatch_table(get_dispatch_key(instance)); + @end if + + @if('{funcName}' == 'vkGetPhysicalDeviceToolPropertiesEXT') + if (original_pToolProperties != nullptr) {{ + pToolProperties = original_pToolProperties; + }} + + (*pToolCount)++; + @end if if (ApiDumpInstance::current().shouldDumpOutput()) {{ switch(ApiDumpInstance::current().settings().format()) {{ + @if('{funcReturn}' != 'void') case ApiDumpFormat::Text: dump_text_{funcName}(ApiDumpInstance::current(), result, {funcNamedParams}); break; @@ -379,54 +296,30 @@ case ApiDumpFormat::Json: dump_json_{funcName}(ApiDumpInstance::current(), result, {funcNamedParams}); break; + @end if + @if('{funcReturn}' == 'void') + case ApiDumpFormat::Text: + dump_text_{funcName}(ApiDumpInstance::current(), {funcNamedParams}); + break; + case ApiDumpFormat::Html: + dump_html_{funcName}(ApiDumpInstance::current(), {funcNamedParams}); + break; + case ApiDumpFormat::Json: + dump_json_{funcName}(ApiDumpInstance::current(), {funcNamedParams}); + break; + @end if }} }} ApiDumpInstance::current().outputMutex()->unlock(); + @if('{funcReturn}' != 'void') return result; -}} -@end function - -@foreach function where('{funcDispatchType}' == 'instance' and '{funcReturn}' == 'void' and '{funcName}' not in ['vkCreateInstance', 'vkDestroyInstance', 'vkCreateDevice', 'vkGetInstanceProcAddr', 'vkEnumerateDeviceExtensionProperties', 'vkEnumerateDeviceLayerProperties']) -VK_LAYER_EXPORT VKAPI_ATTR {funcReturn} VKAPI_CALL {funcName}({funcTypedParams}) -{{ - ApiDumpInstance::current().outputMutex()->lock(); - if (ApiDumpInstance::current().shouldDumpOutput()) {{ - switch(ApiDumpInstance::current().settings().format()) - {{ - case ApiDumpFormat::Text: - dump_text_function_head(ApiDumpInstance::current(), \"{funcName}({funcNamedParams})\", \"{funcReturn}\"); - break; - case ApiDumpFormat::Html: - dump_html_function_head(ApiDumpInstance::current(), \"{funcName}({funcNamedParams})\", \"{funcReturn}\"); - break; - case ApiDumpFormat::Json: - dump_json_function_head(ApiDumpInstance::current(), \"{funcName}\", \"{funcReturn}\"); - break; - }} - }} - instance_dispatch_table({funcDispatchParam})->{funcShortName}({funcNamedParams}); - {funcStateTrackingCode} - if (ApiDumpInstance::current().shouldDumpOutput()) {{ - switch(ApiDumpInstance::current().settings().format()) - {{ - case ApiDumpFormat::Text: - dump_text_{funcName}(ApiDumpInstance::current(), {funcNamedParams}); - break; - case ApiDumpFormat::Html: - dump_html_{funcName}(ApiDumpInstance::current(), {funcNamedParams}); - break; - case ApiDumpFormat::Json: - dump_json_{funcName}(ApiDumpInstance::current(), {funcNamedParams}); - break; - }} - }} - ApiDumpInstance::current().outputMutex()->unlock(); + @end if }} @end function // Autogen device functions -@foreach function where('{funcDispatchType}' == 'device' and '{funcReturn}' != 'void' and '{funcName}' not in ['vkDestroyDevice', 'vkEnumerateInstanceExtensionProperties', 'vkEnumerateInstanceLayerProperties', 'vkQueuePresentKHR', 'vkGetDeviceProcAddr']) +@foreach function where('{funcDispatchType}' == 'device' and '{funcName}' not in ['vkGetDeviceProcAddr']) VK_LAYER_EXPORT VKAPI_ATTR {funcReturn} VKAPI_CALL {funcName}({funcTypedParams}) {{ ApiDumpInstance::current().outputMutex()->lock(); @@ -456,11 +349,22 @@ break; }} }} + + @if('{funcReturn}' != 'void') {funcReturn} result = device_dispatch_table({funcDispatchParam})->{funcShortName}({funcNamedParams}); + @end if + @if('{funcReturn}' == 'void') + device_dispatch_table({funcDispatchParam})->{funcShortName}({funcNamedParams}); + @end if {funcStateTrackingCode} + @if('{funcName}' == 'vkDestroyDevice') + destroy_device_dispatch_table(get_dispatch_key(device)); + @end if + if (ApiDumpInstance::current().shouldDumpOutput()) {{ switch(ApiDumpInstance::current().settings().format()) {{ + @if('{funcReturn}' != 'void') case ApiDumpFormat::Text: dump_text_{funcName}(ApiDumpInstance::current(), result, {funcNamedParams}); break; @@ -470,36 +374,8 @@ case ApiDumpFormat::Json: dump_json_{funcName}(ApiDumpInstance::current(), result, {funcNamedParams}); break; - }} - }} - ApiDumpInstance::current().outputMutex()->unlock(); - return result; -}} -@end function - -@foreach function where('{funcDispatchType}' == 'device' and '{funcReturn}' == 'void' and '{funcName}' not in ['vkDestroyDevice', 'vkEnumerateInstanceExtensionProperties', 'vkEnumerateInstanceLayerProperties', 'vkGetDeviceProcAddr']) -VK_LAYER_EXPORT VKAPI_ATTR {funcReturn} VKAPI_CALL {funcName}({funcTypedParams}) -{{ - ApiDumpInstance::current().outputMutex()->lock(); - if (ApiDumpInstance::current().shouldDumpOutput()) {{ - switch(ApiDumpInstance::current().settings().format()) - {{ - case ApiDumpFormat::Text: - dump_text_function_head(ApiDumpInstance::current(), \"{funcName}({funcNamedParams})\", \"{funcReturn}\"); - break; - case ApiDumpFormat::Html: - dump_html_function_head(ApiDumpInstance::current(), \"{funcName}({funcNamedParams})\", \"{funcReturn}\"); - break; - case ApiDumpFormat::Json: - dump_json_function_head(ApiDumpInstance::current(), \"{funcName}\", \"{funcReturn}\"); - break; - }} - }} - device_dispatch_table({funcDispatchParam})->{funcShortName}({funcNamedParams}); - {funcStateTrackingCode} - if (ApiDumpInstance::current().shouldDumpOutput()) {{ - switch(ApiDumpInstance::current().settings().format()) - {{ + @end if + @if('{funcReturn}' == 'void') case ApiDumpFormat::Text: dump_text_{funcName}(ApiDumpInstance::current(), {funcNamedParams}); break; @@ -509,79 +385,29 @@ case ApiDumpFormat::Json: dump_json_{funcName}(ApiDumpInstance::current(), {funcNamedParams}); break; + @end if }} }} ApiDumpInstance::current().outputMutex()->unlock(); -}} -@end function - -VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkGetPhysicalDeviceToolPropertiesEXT(VkPhysicalDevice physicalDevice, uint32_t *pToolCount, VkPhysicalDeviceToolPropertiesEXT *pToolProperties) -{{ - ApiDumpInstance::current().outputMutex()->lock(); - if (ApiDumpInstance::current().shouldDumpOutput()) {{ - switch(ApiDumpInstance::current().settings().format()) - {{ - case ApiDumpFormat::Text: - dump_text_function_head(ApiDumpInstance::current(), \"vkGetPhysicalDeviceToolPropertiesEXT(physicalDevice, pToolCount, pToolProperties)\", \"VkResult\"); - break; - case ApiDumpFormat::Html: - dump_html_function_head(ApiDumpInstance::current(), \"vkGetPhysicalDeviceToolPropertiesEXT(physicalDevice, pToolCount, pToolProperties)\", \"VkResult\"); - break; - case ApiDumpFormat::Json: - dump_json_function_head(ApiDumpInstance::current(), \"vkGetPhysicalDeviceToolPropertiesEXT\", \"VkResult\"); - break; - }} - }} - static const VkPhysicalDeviceToolPropertiesEXT api_dump_layer_tool_props = {{ - VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_TOOL_PROPERTIES_EXT, - nullptr, - "API Dump Layer", - "2", - VK_TOOL_PURPOSE_PROFILING_BIT_EXT | VK_TOOL_PURPOSE_TRACING_BIT_EXT, - "The VK_LAYER_LUNARG_api_dump utility layer prints API calls, parameters, and values to the identified output stream.", - "VK_LAYER_LUNARG_api_dump"}}; - - auto original_pToolProperties = pToolProperties; - if (pToolProperties != nullptr) {{ - *pToolProperties = api_dump_layer_tool_props; - pToolProperties = ((*pToolCount > 1) ? &pToolProperties[1] : nullptr); - (*pToolCount)--; - }} - - VkLayerInstanceDispatchTable *pInstanceTable = instance_dispatch_table(physicalDevice); - VkResult result = pInstanceTable->GetPhysicalDeviceToolPropertiesEXT(physicalDevice, pToolCount, pToolProperties); - - if (original_pToolProperties != nullptr) {{ - pToolProperties = original_pToolProperties; - }} - - (*pToolCount)++; - if (ApiDumpInstance::current().shouldDumpOutput()) {{ - switch(ApiDumpInstance::current().settings().format()) - {{ - case ApiDumpFormat::Text: - dump_text_vkGetPhysicalDeviceToolPropertiesEXT(ApiDumpInstance::current(), result, physicalDevice, pToolCount, pToolProperties); - break; - case ApiDumpFormat::Html: - dump_html_vkGetPhysicalDeviceToolPropertiesEXT(ApiDumpInstance::current(), result, physicalDevice, pToolCount, pToolProperties); - break; - case ApiDumpFormat::Json: - dump_json_vkGetPhysicalDeviceToolPropertiesEXT(ApiDumpInstance::current(), result, physicalDevice, pToolCount, pToolProperties); - break; - }} - }} + @if('{funcName}' == 'vkQueuePresentKHR') + ApiDumpInstance::current().nextFrame(); + @end if + @if('{funcReturn}' != 'void') return result; + @end if }} +@end function VK_LAYER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetInstanceProcAddr(VkInstance instance, const char* pName) {{ - @foreach function where('{funcType}' == 'instance' and '{funcName}' not in [ 'vkEnumerateDeviceExtensionProperties' ]) + @foreach function where('{funcType}' in ['global', 'instance'] and '{funcName}' not in [ 'vkEnumerateDeviceExtensionProperties' ]) if(strcmp(pName, "{funcName}") == 0) return reinterpret_cast({funcName}); @end function + // Haven't created an instance yet, exit now since there is no instance_dispatch_table if(instance_dispatch_table(instance)->GetInstanceProcAddr == NULL) - return NULL; + return nullptr; return instance_dispatch_table(instance)->GetInstanceProcAddr(instance, pName); }} @@ -592,8 +418,9 @@ return reinterpret_cast({funcName}); @end function + // Haven't created a device yet, exit now since there is no device_dispatch_table if(device_dispatch_table(device)->GetDeviceProcAddr == NULL) - return NULL; + return nullptr; return device_dispatch_table(device)->GetDeviceProcAddr(device, pName); }} """ @@ -2576,9 +2403,10 @@ def __init__(self, rootNode, constants, aliases, extensions): self.namedParams = ', '.join(p.name for p in self.parameters) self.typedParams = ', '.join(p.text for p in self.parameters) - if self.parameters[0].type in ['VkInstance', 'VkPhysicalDevice'] or self.name == 'vkCreateInstance': + self.dispatchType = 'global' + if self.parameters[0].type in ['VkInstance', 'VkPhysicalDevice']: self.dispatchType = 'instance' - else: + elif self.parameters[0].type in ['VkDevice', 'VkCommandBuffer', 'VkQueue']: self.dispatchType = 'device' if self.name in extensions and extensions[self.name].type == 'instance': From 473ba6ea75dc79d16af9a78b06b73a1ae41fbb99 Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Thu, 2 Feb 2023 11:25:01 -0700 Subject: [PATCH 042/154] apidump: Clean up stream handling & update copyright The logic for stream() can be simplified by putting it into a single std::ostream object, as well as the ApiDumpSettings can be directly placed inside the ApiDumpInstance class rather than having it be a pointer. Putting the settings object nessecitated making the static object live inside the static current function, so that its construction happened in the first call to current(), rather than at an arbitrary time during initialization. --- layersvt/api_dump.h | 189 ++++++++++++++++------------------ scripts/api_dump_generator.py | 28 ++--- 2 files changed, 100 insertions(+), 117 deletions(-) diff --git a/layersvt/api_dump.h b/layersvt/api_dump.h index f89f343285..df2b21b164 100644 --- a/layersvt/api_dump.h +++ b/layersvt/api_dump.h @@ -1,6 +1,6 @@ -/* Copyright (c) 2015-2019 The Khronos Group Inc. - * Copyright (c) 2015-2019 Valve Corporation - * Copyright (c) 2015-2019 LunarG, Inc. +/* Copyright (c) 2015-2023 The Khronos Group Inc. + * Copyright (c) 2015-2023 Valve Corporation + * Copyright (c) 2015-2023 LunarG, Inc. * Copyright (C) 2015-2016 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -234,7 +234,7 @@ class ConditionalFrameOutput { class ApiDumpSettings { public: - ApiDumpSettings() { + ApiDumpSettings() : output_stream(std::cout.rdbuf()) { std::string filename_string = ""; // If the layer settings file has a flag indicating to output to a file, // do so, to the appropriate filename. @@ -259,15 +259,8 @@ class ApiDumpSettings { } // If one of the above has set a filename, open the file as an output stream. if (!filename_string.empty()) { - use_cout = false; - output_stream.open(filename_string, std::ofstream::out | std::ostream::trunc); - size_t last_slash_idx = filename_string.find_last_of("\\/"); - if (std::string::npos != last_slash_idx) { - output_dir = filename_string.substr(0, last_slash_idx + 1); - } - } else { - // Otherwise, fallback to cout only - use_cout = true; + output_file_stream.open(filename_string, std::ofstream::out | std::ostream::trunc); + output_stream.rdbuf(output_file_stream.rdbuf()); } // Get the remaining settings (some we also want to provide the ability to override @@ -310,6 +303,7 @@ class ApiDumpSettings { } indent_size = std::max(readIntOption("lunarg_api_dump.indent_size", 4), 0); + tab_size = indent_size; show_type = readBoolOption("lunarg_api_dump.show_types", true); name_size = std::max(readIntOption("lunarg_api_dump.name_size", 32), 0); type_size = std::max(readIntOption("lunarg_api_dump.type_size", 0), 0); @@ -334,11 +328,19 @@ class ApiDumpSettings { } } + // Setfill stays active for the duration of the stream. Setting it during construction + // means it doesn't have to be set again whenever setw() is called. + output_stream << std::setfill(use_spaces ? ' ' : '\t'); + + if (!use_spaces) { + indent_size = 1; // setting this allows indentation to not need a branch on use_spaces + } + // Generate HTML heading if specified if (output_format == ApiDumpFormat::Html) { // clang-format off // Insert html heading - stream() << + output_stream << "" "" "" @@ -438,14 +440,9 @@ class ApiDumpSettings { "
"; // clang-format on } else if (output_format == ApiDumpFormat::Json) { - stream() << "[\n"; + output_stream << "[\n"; } - if (use_spaces) - stream() << std::setfill(' '); - else - stream() << std::setfill('\t'); - if (isFrameInRange(0)) { setupInterFrameOutputFormatting(0); } @@ -454,12 +451,11 @@ class ApiDumpSettings { ~ApiDumpSettings() { if (output_format == ApiDumpFormat::Html) { // Close off html - stream() << "
"; + output_stream << "
"; } else if (output_format == ApiDumpFormat::Json) { // Close off json - stream() << "\n]" << std::endl; + output_stream << "\n]" << std::endl; } - if (!use_cout) output_stream.close(); } void setupInterFrameOutputFormatting(uint64_t frame_count) const /*name change? */ @@ -468,34 +464,34 @@ class ApiDumpSettings { switch (format()) { case (ApiDumpFormat::Html): if (frame_count > 0) { - if (condFrameOutput.isFrameInRange(frame_count - 1)) stream() << ""; + if (condFrameOutput.isFrameInRange(frame_count - 1)) output_stream << ""; } if (condFrameOutput.isFrameInRange(frame_count)) { - stream() << "
Frame "; + output_stream << "
Frame "; if (show_thread_and_frame) { - stream() << frame_count; + output_stream << frame_count; } - stream() << ""; + output_stream << "
"; } break; case (ApiDumpFormat::Json): if (frame_count > 0) { - if (condFrameOutput.isFrameInRange(frame_count - 1)) stream() << "\n" << indentation(1) << "]\n}"; + if (condFrameOutput.isFrameInRange(frame_count - 1)) output_stream << "\n" << indentation(1) << "]\n}"; } if (condFrameOutput.isFrameInRange(frame_count)) { if (!hasPrintedAFrame) { hasPrintedAFrame = true; } else { - stream() << ",\n"; + output_stream << ",\n"; } - stream() << "{\n"; + output_stream << "{\n"; if (show_thread_and_frame) { - stream() << indentation(1) << "\"frameNumber\" : \"" << frame_count << "\",\n"; + output_stream << indentation(1) << "\"frameNumber\" : \"" << frame_count << "\",\n"; } - stream() << indentation(1) << "\"apiCalls\" :\n"; - stream() << indentation(1) << "[\n"; + output_stream << indentation(1) << "\"apiCalls\" :\n"; + output_stream << indentation(1) << "[\n"; } break; case (ApiDumpFormat::Text): @@ -508,10 +504,10 @@ class ApiDumpSettings { void closeFrameOutput() const { switch (format()) { case (ApiDumpFormat::Html): - stream() << "
"; + output_stream << ""; break; case (ApiDumpFormat::Json): - stream() << "\n" << indentation(1) << "]\n}"; + output_stream << "\n" << indentation(1) << "]\n}"; break; case (ApiDumpFormat::Text): break; @@ -522,31 +518,28 @@ class ApiDumpSettings { ApiDumpFormat format() const { return output_format; } - void formatNameType(std::ostream &stream, int indents, const char *name, const char *type) const { - stream << indentation(indents) << name << ": "; + void formatNameType(int indents, const char *name, const char *type) const { + output_stream << indentation(indents) << name << ": "; + // We have to 'print' an empty string for the setw to actually add the desired padding. if (use_spaces) - stream << std::setw(name_size - (int)strlen(name) - 2) << ""; + output_stream << std::setw(name_size - (int)strlen(name) - 2) << ""; else - stream << std::setw((name_size - (int)strlen(name) - 3 + indent_size) / indent_size) << ""; + output_stream << std::setw((name_size - (int)strlen(name) - 3 + tab_size) / tab_size) << ""; if (show_type) { if (use_spaces) - stream << type << std::setw(type_size - (int)strlen(type)) << " = "; + output_stream << type << std::setw(type_size - (int)strlen(type)) << " = "; else - stream << type << std::setw((type_size - (int)strlen(type) - 1 + indent_size) / indent_size) << " = "; + output_stream << type << std::setw((type_size - (int)strlen(type) - 1 + tab_size) / tab_size) << " = "; } else { - stream << " = "; + output_stream << " = "; } } inline const char *indentation(int indents) const { - if (use_spaces) { - stream() << std::setfill(' ') << std::setw(indents * indent_size); - return ""; - } else { - stream() << std::setfill('\t') << std::setw(indents); - return ""; - } + // We have to 'print' an empty string for the setw to actually add the desired padding. + output_stream << std::setw(indents * indent_size) << ""; + return ""; } bool shouldFlush() const { return should_flush; } @@ -563,9 +556,9 @@ class ApiDumpSettings { bool showThreadAndFrame() const { return show_thread_and_frame; } - std::ostream &stream() const { return use_cout ? std::cout : *(std::ofstream *)&output_stream; } - - std::string directory() const { return output_dir; } + // The const cast is necessary because everyone who 'writes' to the stream necessarily must be able to modify it. + // Since basically every function in this struct is const, we have to work around that. + std::ostream &stream() const { return output_stream; } bool isFrameInRange(uint64_t frame) const { return condFrameOutput.isFrameInRange(frame); } @@ -659,9 +652,10 @@ class ApiDumpSettings { return default_value; } - bool use_cout; - std::string output_dir = ""; - std::ofstream output_stream; + // The mutable is necessary because everyone who 'writes' to the stream necessarily must be able to modify it. + // Since basically every function in this struct is const, we have to work around that. + mutable std::ostream output_stream; + std::ofstream output_file_stream; ApiDumpFormat output_format; bool show_params; bool show_address; @@ -669,7 +663,7 @@ class ApiDumpSettings { bool show_timestamp; bool show_type; - int indent_size; + int indent_size; // how many indent levels to use - also sets the tab_size int name_size; int type_size; bool use_spaces; @@ -678,13 +672,13 @@ class ApiDumpSettings { bool use_conditional_output = false; ConditionalFrameOutput condFrameOutput; + + int tab_size; // equal to the indent size if using spaces, otherwise is equal to 1 }; class ApiDumpInstance { public: - ApiDumpInstance() noexcept : dump_settings(NULL), frame_count(0), thread_count(0) { - program_start = std::chrono::system_clock::now(); - } + ApiDumpInstance() noexcept : frame_count(0), thread_count(0) { program_start = std::chrono::system_clock::now(); } // Can't copy or move this type ApiDumpInstance(const ApiDumpInstance &) = delete; ApiDumpInstance &operator=(const ApiDumpInstance &) = delete; @@ -692,11 +686,7 @@ class ApiDumpInstance { ApiDumpInstance &operator=(ApiDumpInstance &&) = delete; ~ApiDumpInstance() { - if (!dump_settings) return; - if (!first_func_call_on_frame) settings().closeFrameOutput(); - - delete dump_settings; } uint64_t frameCount() { @@ -732,11 +722,7 @@ class ApiDumpInstance { std::recursive_mutex *outputMutex() { return &output_mutex; } - const ApiDumpSettings &settings() { - if (dump_settings == NULL) dump_settings = new ApiDumpSettings(); - - return *dump_settings; - } + ApiDumpSettings &settings() { return dump_settings; } uint64_t threadID() { if (thread_id != UINT64_MAX) { @@ -821,7 +807,12 @@ class ApiDumpInstance { return std::chrono::duration_cast(now - program_start); } - static ApiDumpInstance ¤t() { return current_instance; } + static ApiDumpInstance ¤t() { + // Because ApiDumpInstance is a static variable in a static function, there will only be one instance of it. + // Additionally, the object will be constructed on the *first* call to current(), rather than at process startup time. + static ApiDumpInstance current_instance; + return current_instance; + } std::unordered_map object_name_map; @@ -832,9 +823,7 @@ class ApiDumpInstance { } private: - static ApiDumpInstance current_instance; - - ApiDumpSettings *dump_settings; + ApiDumpSettings dump_settings; std::recursive_mutex output_mutex; std::recursive_mutex frame_mutex; uint64_t frame_count; @@ -873,7 +862,6 @@ class ApiDumpInstance { // If the quotes arg is true, the address is encloded in quotes. // Used for text, html, and json output. void OutputAddress(const ApiDumpSettings &settings, const void *addr) { - if (settings.format() == ApiDumpFormat::Json) settings.stream() << "\""; if (settings.showAddress()) if (addr == NULL) settings.stream() << "NULL"; @@ -881,10 +869,13 @@ void OutputAddress(const ApiDumpSettings &settings, const void *addr) { settings.stream() << addr; else settings.stream() << "address"; - if (settings.format() == ApiDumpFormat::Json) settings.stream() << "\""; } -ApiDumpInstance ApiDumpInstance::current_instance; +void OutputAddressJSON(const ApiDumpSettings &settings, const void *addr) { + settings.stream() << "\""; + OutputAddress(settings, addr); + settings.stream() << "\""; +} //==================================== Text Backend Helpers ======================================// @@ -910,7 +901,7 @@ void dump_text_function_head(ApiDumpInstance &dump_inst, const char *funcName, c template void dump_text_array(const T *array, size_t len, const ApiDumpSettings &settings, const char *type_string, const char *child_type, const char *name, int indents, void (*dump)(const T, const ApiDumpSettings &, int)) { - settings.formatNameType(settings.stream(), indents, name, type_string); + settings.formatNameType( indents, name, type_string); if (array == NULL) { settings.stream() << "NULL\n"; return; @@ -928,7 +919,7 @@ void dump_text_array(const T *array, size_t len, const ApiDumpSettings &settings template void dump_text_array(const T *array, size_t len, const ApiDumpSettings &settings, const char *type_string, const char *child_type, const char *name, int indents, void (*dump)(const T &, const ApiDumpSettings &, int)) { - settings.formatNameType(settings.stream(), indents, name, type_string); + settings.formatNameType(indents, name, type_string); if (array == NULL) { settings.stream() << "NULL\n"; return; @@ -947,7 +938,7 @@ template void dump_text_pointer(const T *pointer, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents, void (*dump)(const T, const ApiDumpSettings &, int)) { if (pointer == NULL) { - settings.formatNameType(settings.stream(), indents, name, type_string); + settings.formatNameType(indents, name, type_string); settings.stream() << "NULL\n"; } else { dump_text_value(*pointer, settings, type_string, name, indents, dump); @@ -958,7 +949,7 @@ template void dump_text_pointer(const T *pointer, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents, void (*dump)(const T &, const ApiDumpSettings &, int)) { if (pointer == NULL) { - settings.formatNameType(settings.stream(), indents, name, type_string); + settings.formatNameType(indents, name, type_string); settings.stream() << "NULL\n"; } else { dump_text_value(*pointer, settings, type_string, name, indents, dump); @@ -968,7 +959,7 @@ void dump_text_pointer(const T *pointer, const ApiDumpSettings &settings, const template void dump_text_value(const T object, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents, void (*dump)(const T, const ApiDumpSettings &, int)) { - settings.formatNameType(settings.stream(), indents, name, type_string); + settings.formatNameType(indents, name, type_string); dump(object, settings, indents); settings.stream() << "\n"; } @@ -976,12 +967,12 @@ void dump_text_value(const T object, const ApiDumpSettings &settings, const char template void dump_text_value(const T &object, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents, void (*dump)(const T &, const ApiDumpSettings &, int)) { - settings.formatNameType(settings.stream(), indents, name, type_string); + settings.formatNameType(indents, name, type_string); dump(object, settings, indents); } void dump_text_special(const char *text, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents) { - settings.formatNameType(settings.stream(), indents, name, type_string); + settings.formatNameType(indents, name, type_string); settings.stream() << text << "\n"; } @@ -1009,7 +1000,7 @@ void dump_text_pNext(const T *object, const ApiDumpSettings &settings, const cha if (object == NULL) settings.stream() << "NULL"; else if (settings.showAddress()) { - settings.formatNameType(settings.stream(), indents, "pNext", type_string); + settings.formatNameType(indents, "pNext", type_string); dump(*object, settings, indents); } else settings.stream() << "address"; @@ -1203,7 +1194,7 @@ void dump_json_array(const T *array, size_t len, const ApiDumpSettings &settings settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << "\",\n"; settings.stream() << settings.indentation(indents + 1) << "\"name\" : \"" << name << "\",\n"; settings.stream() << settings.indentation(indents + 1) << "\"address\" : "; - OutputAddress(settings, array); + OutputAddressJSON(settings, array); settings.stream() << "\n"; settings.stream() << settings.indentation(indents) << "}"; return; @@ -1214,7 +1205,7 @@ void dump_json_array(const T *array, size_t len, const ApiDumpSettings &settings settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << "\",\n"; settings.stream() << settings.indentation(indents + 1) << "\"name\" : \"" << name << "\",\n"; settings.stream() << settings.indentation(indents + 1) << "\"address\" : "; - OutputAddress(settings, array); + OutputAddressJSON(settings, array); settings.stream() << ",\n"; settings.stream() << settings.indentation(indents + 1) << "\"elements\" :\n"; settings.stream() << settings.indentation(indents + 1) << "[\n"; @@ -1239,7 +1230,7 @@ void dump_json_array(const T *array, size_t len, const ApiDumpSettings &settings settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << "\",\n"; settings.stream() << settings.indentation(indents + 1) << "\"name\" : \"" << name << "\",\n"; settings.stream() << settings.indentation(indents + 1) << "\"address\" : "; - OutputAddress(settings, array); + OutputAddressJSON(settings, array); settings.stream() << "\n"; settings.stream() << settings.indentation(indents) << "}"; return; @@ -1249,7 +1240,7 @@ void dump_json_array(const T *array, size_t len, const ApiDumpSettings &settings settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << "\",\n"; settings.stream() << settings.indentation(indents + 1) << "\"name\" : \"" << name << "\",\n"; settings.stream() << settings.indentation(indents + 1) << "\"address\" : "; - OutputAddress(settings, array); + OutputAddressJSON(settings, array); settings.stream() << ",\n"; settings.stream() << settings.indentation(indents + 1) << "\"elements\" :\n"; settings.stream() << settings.indentation(indents + 1) << "[\n"; @@ -1313,7 +1304,7 @@ void dump_json_value(const T object, const void *pObject, const ApiDumpSettings if (isPnext || (strchr(type_string, '*') && strcmp(type_string, "const char*") && strcmp(type_string, "const char* const"))) { // Print pointers, except for char string pointers settings.stream() << ",\n" << settings.indentation(indents + 1) << "\"address\" : "; - OutputAddress(settings, pObject); + OutputAddressJSON(settings, pObject); } if (!isPnext || (isPnext && pObject != nullptr)) { settings.stream() << ",\n"; @@ -1341,7 +1332,7 @@ void dump_json_value(const T &object, const void *pObject, const ApiDumpSettings if (isPnext || (strchr(type_string, '*') && strcmp(type_string, "const char*") && strcmp(type_string, "const char* const"))) { // Print pointers, except for char string pointers settings.stream() << ",\n" << settings.indentation(indents + 1) << "\"address\" : "; - OutputAddress(settings, pObject); + OutputAddressJSON(settings, pObject); } if (!isPnext || (isPnext && pObject != nullptr)) { settings.stream() << ",\n"; @@ -1360,7 +1351,7 @@ void dump_json_special(const char *text, const ApiDumpSettings &settings, const settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << "\",\n"; settings.stream() << settings.indentation(indents + 1) << "\"name\" : \"" << name << "\",\n"; settings.stream() << settings.indentation(indents + 1) << "\"address\" : "; - OutputAddress(settings, text); + OutputAddressJSON(settings, text); settings.stream() << ",\n"; settings.stream() << settings.indentation(indents + 1) << "\"value\" : "; settings.stream() << "\"" << text << "\"\n"; @@ -1375,7 +1366,7 @@ void dump_json_cstring(const char *object, const ApiDumpSettings &settings, int } void dump_json_void(const void *object, const ApiDumpSettings &settings, int indents) { - OutputAddress(settings, object); + OutputAddressJSON(settings, object); settings.stream() << "\n"; } @@ -1390,12 +1381,8 @@ void dump_json_pNext(const T *object, const ApiDumpSettings &settings, const cha if (object == NULL) { settings.stream() << settings.indentation(indents) << "{\n"; settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << "*\",\n"; - settings.stream() << settings.indentation(indents + 1) << "\"name\" : \"" - << "pNext" - << "\",\n"; - settings.stream() << settings.indentation(indents + 1) << "\"address\" : "; - OutputAddress(settings, NULL); - settings.stream() << ",\n"; + settings.stream() << settings.indentation(indents + 1) << "\"name\" : \"pNext\",\n"; + settings.stream() << settings.indentation(indents + 1) << "\"address\" : \"NULL\",\n"; settings.stream() << settings.indentation(indents) << "}"; } else { dump_json_value(*object, object, settings, type_string, "pNext", indents, dump); @@ -1408,12 +1395,8 @@ void dump_json_pNext(const T *object, const ApiDumpSettings &settings, const cha if (object == NULL) { settings.stream() << settings.indentation(indents) << "{\n"; settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << "*\",\n"; - settings.stream() << settings.indentation(indents + 1) << "\"name\" : \"" - << "pNext" - << "\",\n"; - settings.stream() << settings.indentation(indents + 1) << "\"address\" : "; - OutputAddress(settings, NULL); - settings.stream() << ",\n"; + settings.stream() << settings.indentation(indents + 1) << "\"name\" : \"pNext\",\n"; + settings.stream() << settings.indentation(indents + 1) << "\"address\" : \"NULL\",\n"; settings.stream() << settings.indentation(indents) << "}"; } else { dump_json_value(*object, object, settings, type_string, "pNext", indents, dump); diff --git a/scripts/api_dump_generator.py b/scripts/api_dump_generator.py index 79e82809e5..b520dad389 100644 --- a/scripts/api_dump_generator.py +++ b/scripts/api_dump_generator.py @@ -1,7 +1,7 @@ #!/usr/bin/python3 -i # -# Copyright (c) 2015-2016, 2019, 2021 Valve Corporation -# Copyright (c) 2015-2016, 2019, 2021 LunarG, Inc. +# Copyright (c) 2015-2023 Valve Corporation +# Copyright (c) 2015-2023 LunarG, Inc. # Copyright (c) 2015-2016, 2019, 2021 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); @@ -426,8 +426,8 @@ """ TEXT_CODEGEN = """ -/* Copyright (c) 2015-2016, 2019 Valve Corporation - * Copyright (c) 2015-2016, 2019 LunarG, Inc. +/* Copyright (c) 2015-2023 Valve Corporation + * Copyright (c) 2015-2023 LunarG, Inc. * Copyright (c) 2015-2016, 2019 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -728,10 +728,10 @@ @if({sctStructureTypeIndex} != -1) case {sctStructureTypeIndex}: @if({sctIsPNextChainConst} == True) - settings.formatNameType(settings.stream(), indents, "pNext", "const void*"); + settings.formatNameType(indents, "pNext", "const void*"); @end if @if({sctIsPNextChainConst} == False) - settings.formatNameType(settings.stream(), indents, "pNext", "void*"); + settings.formatNameType(indents, "pNext", "void*"); @end if settings.stream() << "{sctName}\\n"; break; @@ -740,11 +740,11 @@ case 47: // VK_STRUCTURE_TYPE_LOADER_INSTANCE_CREATE_INFO case 48: // VK_STRUCTURE_TYPE_LOADER_DEVICE_CREATE_INFO - settings.formatNameType(settings.stream(), indents, "pNext", "const void*"); + settings.formatNameType(indents, "pNext", "const void*"); settings.stream() << "NULL\\n"; break; default: - settings.formatNameType(settings.stream(), indents, "pNext", "const void*"); + settings.formatNameType(indents, "pNext", "const void*"); settings.stream() << "UNKNOWN (" << (int64_t) (static_cast(object)->sType) << ")\\n"; }} }} @@ -765,12 +765,12 @@ if(static_cast(object)->pNext != nullptr){{ dump_text_pNext_trampoline(static_cast(static_cast(object)->pNext), settings, indents); }} else {{ - settings.formatNameType(settings.stream(), indents, "pNext", "const void*"); + settings.formatNameType(indents, "pNext", "const void*"); settings.stream() << "NULL\\n"; }} break; default: - settings.formatNameType(settings.stream(), indents, "pNext", "const void*"); + settings.formatNameType(indents, "pNext", "const void*"); settings.stream() << "UNKNOWN (" << (int64_t) (static_cast(object)->sType) << ")\\n"; }} }} @@ -820,8 +820,8 @@ # that are opened are closed in another function. See api_dump.h. This may need refactoring. HTML_CODEGEN = """ -/* Copyright (c) 2015-2017, 2019 Valve Corporation - * Copyright (c) 2015-2017, 2019 LunarG, Inc. +/* Copyright (c) 2015-2023 Valve Corporation + * Copyright (c) 2015-2023 LunarG, Inc. * Copyright (c) 2015-2017, 2019 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -1184,8 +1184,8 @@ # This JSON Codegen is essentially copied from the HTML section above. JSON_CODEGEN = """ -/* Copyright (c) 2015-2019, 2019 Valve Corporation - * Copyright (c) 2015-2019, 2019 LunarG, Inc. +/* Copyright (c) 2015-2023 Valve Corporation + * Copyright (c) 2015-2023 LunarG, Inc. * Copyright (c) 2015-2017, 2019 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); From 12464671d3a9e93eb975ca32833f3b12b69d9ef7 Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Thu, 2 Feb 2023 14:58:06 -0700 Subject: [PATCH 043/154] apidump: Cleanup threadID() logic The code used a fixed sized array which obfuscated the logic driving the function. By using an unordered_map, it not only clarifies the behavior by using a map but also may help with contention when there are many threads. --- layersvt/api_dump.h | 23 +++++++---------------- 1 file changed, 7 insertions(+), 16 deletions(-) diff --git a/layersvt/api_dump.h b/layersvt/api_dump.h index df2b21b164..bb8afff4a3 100644 --- a/layersvt/api_dump.h +++ b/layersvt/api_dump.h @@ -678,7 +678,7 @@ class ApiDumpSettings { class ApiDumpInstance { public: - ApiDumpInstance() noexcept : frame_count(0), thread_count(0) { program_start = std::chrono::system_clock::now(); } + ApiDumpInstance() noexcept : frame_count(0) { program_start = std::chrono::system_clock::now(); } // Can't copy or move this type ApiDumpInstance(const ApiDumpInstance &) = delete; ApiDumpInstance &operator=(const ApiDumpInstance &) = delete; @@ -725,22 +725,16 @@ class ApiDumpInstance { ApiDumpSettings &settings() { return dump_settings; } uint64_t threadID() { - if (thread_id != UINT64_MAX) { - return thread_id; - } std::thread::id this_id = std::this_thread::get_id(); std::lock_guard lg(thread_mutex); - for (uint32_t i = 0; i < thread_count; ++i) { - if (thread_map[i] == this_id) { - return i; - } + auto it = thread_map.find(this_id); + if (it != thread_map.end()) { + return it->second; } - uint32_t new_index = thread_count; - thread_map[thread_count++] = this_id; - assert(thread_count < MAX_THREADS); - return new_index; + thread_map.insert({this_id, thread_map.size()}); + return thread_map.size() - 1; } void setCmdBuffer(VkCommandBuffer cmd_buffer) { this->cmd_buffer = cmd_buffer; } @@ -828,11 +822,8 @@ class ApiDumpInstance { std::recursive_mutex frame_mutex; uint64_t frame_count; - static const size_t MAX_THREADS = 513; std::recursive_mutex thread_mutex; - std::thread::id thread_map[MAX_THREADS]; - uint32_t thread_count; - uint64_t thread_id = UINT64_MAX; + std::unordered_map thread_map; std::recursive_mutex cmd_buffer_state_mutex; std::map, std::unordered_set > cmd_buffer_pools; From 007b7a77e97f18f3508e0ce2de3b10c6417e437f Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Tue, 7 Feb 2023 14:14:41 -0700 Subject: [PATCH 044/154] apidump: Use boolean or instead of bitwise While the code ultimately did 'the right thing' using a bitwise operator looks weird in the context of boolean expressions. --- layersvt/api_dump.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/layersvt/api_dump.h b/layersvt/api_dump.h index bb8afff4a3..bc4c895256 100644 --- a/layersvt/api_dump.h +++ b/layersvt/api_dump.h @@ -1284,7 +1284,7 @@ extern bool is_struct(const char *t); template void dump_json_value(const T object, const void *pObject, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents, void (*dump)(const T, const ApiDumpSettings &, int)) { - bool isPnext = !strcmp(name, "pNext") | !strcmp(name, "pUserData"); + bool isPnext = !strcmp(name, "pNext") || !strcmp(name, "pUserData"); const char *star = (isPnext && !strstr(type_string, "void")) ? "*" : ""; settings.stream() << settings.indentation(indents) << "{\n"; if (is_union(type_string)) @@ -1312,7 +1312,7 @@ void dump_json_value(const T object, const void *pObject, const ApiDumpSettings template void dump_json_value(const T &object, const void *pObject, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents, void (*dump)(const T &, const ApiDumpSettings &, int)) { - bool isPnext = !strcmp(name, "pNext") | !strcmp(name, "pUserData"); + bool isPnext = !strcmp(name, "pNext") || !strcmp(name, "pUserData"); const char *star = (isPnext && !strstr(type_string, "void")) ? "*" : ""; settings.stream() << settings.indentation(indents) << "{\n"; if (is_union(type_string)) From b67db99657560da2eadbd7341833872cab4cc111 Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Tue, 7 Feb 2023 14:15:32 -0700 Subject: [PATCH 045/154] apidump: Expand settings file boolean fields Because there are many ways to express 'true', this commit allows users to specify a boolean setting value in a variety of ways. Supported ways are `true`, `on`, and `1`. All are case insensitive. --- layersvt/api_dump.h | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/layersvt/api_dump.h b/layersvt/api_dump.h index bc4c895256..79313bdbec 100644 --- a/layersvt/api_dump.h +++ b/layersvt/api_dump.h @@ -611,7 +611,14 @@ class ApiDumpSettings { // Utility member to convert from string to a boolean bool GetStringBooleanValue(const std::string &value) { - if (ToLowerString(value) == "true") { + auto lower_str = ToLowerString(value); + if (lower_str == "true") { + return true; + } + if (lower_str == "on") { + return true; + } + if (lower_str == "1") { return true; } return false; @@ -892,7 +899,7 @@ void dump_text_function_head(ApiDumpInstance &dump_inst, const char *funcName, c template void dump_text_array(const T *array, size_t len, const ApiDumpSettings &settings, const char *type_string, const char *child_type, const char *name, int indents, void (*dump)(const T, const ApiDumpSettings &, int)) { - settings.formatNameType( indents, name, type_string); + settings.formatNameType(indents, name, type_string); if (array == NULL) { settings.stream() << "NULL\n"; return; From ce93abb29e1cd6bd895f359b5fd9edad72afcd07 Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Tue, 7 Feb 2023 14:17:57 -0700 Subject: [PATCH 046/154] apidump: Remove spaces in json output There were spaces being added accidentally. This commit fixes that. --- scripts/api_dump_generator.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/scripts/api_dump_generator.py b/scripts/api_dump_generator.py index b520dad389..f9ca469643 100644 --- a/scripts/api_dump_generator.py +++ b/scripts/api_dump_generator.py @@ -1325,8 +1325,6 @@ {{ bool is_first = true; settings.stream() << '"' << object; - if (object) - settings.stream() << ' '; @foreach option @if('{optMultiValue}' != 'None') if(object == {optValue}) {{ From 62f5192b0dc9a2f268a05b35de43362ec467ea45 Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Tue, 7 Feb 2023 17:38:40 -0700 Subject: [PATCH 047/154] apidump: Print pNext chain with no_addr set Turns out there was a small logic error which caused all pNext chains to not be printed in the text output mode if no_addr was enabled. --- layersvt/api_dump.h | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/layersvt/api_dump.h b/layersvt/api_dump.h index 79313bdbec..be82a67143 100644 --- a/layersvt/api_dump.h +++ b/layersvt/api_dump.h @@ -995,13 +995,12 @@ void dump_text_int(int object, const ApiDumpSettings &settings, int indents) { s template void dump_text_pNext(const T *object, const ApiDumpSettings &settings, const char *type_string, int indents, void (*dump)(const T &, const ApiDumpSettings &, int)) { - if (object == NULL) + if (object == NULL) { settings.stream() << "NULL"; - else if (settings.showAddress()) { + } else { settings.formatNameType(indents, "pNext", type_string); dump(*object, settings, indents); - } else - settings.stream() << "address"; + } } //==================================== Html Backend Helpers ======================================// From 0bd7d4949fb6bcada7d1fac37bb8198beccc2c2b Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Tue, 7 Feb 2023 17:40:49 -0700 Subject: [PATCH 048/154] apidump: Use correct heapBudgetCount in pNext chain VkPhysicalDeviceMemoryBudgetPropertiesEXT has a fixed size array of heapBudgets and heapUsages but with a dynamic 'actual' length, based on the memoryHeapCount of VkPhysicalDeviceMemoryProperties. This commit adds the necessary logic to allow getting the 'actual' length so that printing this structure yields more correct results. --- layersvt/api_dump.h | 5 +++++ scripts/api_dump_generator.py | 17 ++++++++++++++++- 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/layersvt/api_dump.h b/layersvt/api_dump.h index be82a67143..6d63ebb515 100644 --- a/layersvt/api_dump.h +++ b/layersvt/api_dump.h @@ -802,6 +802,8 @@ class ApiDumpInstance { void setIsDynamicViewport(bool is_dynamic_viewport) { this->is_dynamic_viewport = is_dynamic_viewport; } bool getIsDynamicScissor() const { return is_dynamic_scissor; } bool getIsDynamicViewport() const { return is_dynamic_viewport; } + void setMemoryHeapCount(uint32_t memory_heap_count) { this->memory_heap_count = memory_heap_count; } + uint32_t getMemoryHeapCount() { return memory_heap_count; } std::chrono::microseconds current_time_since_start() { std::chrono::system_clock::time_point now = std::chrono::system_clock::now(); @@ -854,6 +856,9 @@ class ApiDumpInstance { // respective dynamic state is set. bool is_dynamic_scissor; bool is_dynamic_viewport; + + // Storage for VkPhysicalDeviceMemoryBudgetPropertiesEXT which needs the number of heaps from VkPhysicalDeviceMemoryProperties + uint32_t memory_heap_count; }; // Utility to output an address. diff --git a/scripts/api_dump_generator.py b/scripts/api_dump_generator.py index f9ca469643..bb3300db09 100644 --- a/scripts/api_dump_generator.py +++ b/scripts/api_dump_generator.py @@ -1633,6 +1633,15 @@ }, ], }, + 'VkPhysicalDeviceMemoryProperties': { + 'VkPhysicalDeviceMemoryProperties2': [ + { + 'name': 'memoryProperties', + 'type': 'VkPhysicalDeviceMemoryProperties', + 'stmt': 'ApiDumpInstance::current().setMemoryHeapCount(object.memoryProperties.memoryHeapCount);', + }, + ], + }, } VALIDITY_CHECKS = { @@ -2512,7 +2521,7 @@ def __init__(self, rootNode, constants, enums): # The xml doesn't contain the relevant information here since the struct contains 'fixed' length arrays. # Thus we have to fix up the variable such that the length member corresponds to the runtime length, not compile time. - if self.name in ['VkPhysicalDeviceMemoryProperties','VkPhysicalDeviceGroupProperties']: + if self.name in ['VkPhysicalDeviceMemoryProperties','VkPhysicalDeviceGroupProperties', 'VkPhysicalDeviceMemoryBudgetPropertiesEXT']: for member in self.members: if member.name == 'memoryTypes': member.lengthMember = True @@ -2523,6 +2532,12 @@ def __init__(self, rootNode, constants, enums): if member.name == 'physicalDevices': member.lengthMember = True member.arrayLength = 'physicalDeviceCount' + if member.name == 'heapBudget': + member.lengthMember = True + member.arrayLength = 'ApiDumpInstance::current().getMemoryHeapCount()' + if member.name == 'heapUsage': + member.lengthMember = True + member.arrayLength = 'ApiDumpInstance::current().getMemoryHeapCount()' def values(self): return { From a94cd3ee98582a3ff3f3e5f9cd1b286c04802b49 Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Tue, 7 Feb 2023 17:44:48 -0700 Subject: [PATCH 049/154] apidump: Print correct pNext type The pNext type is either a void* or a const void*. In many places apidump was using the incorrect one, either because it was hardcoded, or it was using the type of the child. --- scripts/api_dump_generator.py | 64 +++++++++++++---------------------- 1 file changed, 24 insertions(+), 40 deletions(-) diff --git a/scripts/api_dump_generator.py b/scripts/api_dump_generator.py index bb3300db09..21cddffaf2 100644 --- a/scripts/api_dump_generator.py +++ b/scripts/api_dump_generator.py @@ -455,7 +455,7 @@ #include "api_dump.h" -void dump_text_pNext_struct_name(const void* object, const ApiDumpSettings& settings, int indents); +void dump_text_pNext_struct_name(const void* object, const ApiDumpSettings& settings, int indents, const char* pnext_type); void dump_text_pNext_trampoline(const void* object, const ApiDumpSettings& settings, int indents); @foreach union @@ -640,7 +640,7 @@ dump_text_value(object.{memName}, settings, "{memType}", "{memName}", indents + 1, dump_text_{memTypeID}); // AET @end if @if('{memName}' == 'pNext') - dump_text_pNext_struct_name(object.{memName}, settings, indents + 1); + dump_text_pNext_struct_name(object.{memName}, settings, indents + 1, "{memType}"); @end if @end if @if({memPtrLevel} == 1 and '{memLength}' == 'None') @@ -716,54 +716,46 @@ //======================== pNext Chain Implementation =======================// -void dump_text_pNext_struct_name(const void* object, const ApiDumpSettings& settings, int indents) +void dump_text_pNext_struct_name(const void* object, const ApiDumpSettings& settings, int indents, const char* pnext_type) {{ if (object == nullptr) {{ - dump_text_value(object, settings, "void*", "pNext", indents, dump_text_void); + dump_text_value(object, settings, pnext_type, "pNext", indents, dump_text_void); return; }} - switch((int64_t) (static_cast(object)->sType)) {{ + settings.formatNameType(indents, "pNext", pnext_type); + switch(reinterpret_cast(object)->sType) {{ @foreach struct @if({sctStructureTypeIndex} != -1) - case {sctStructureTypeIndex}: - @if({sctIsPNextChainConst} == True) - settings.formatNameType(indents, "pNext", "const void*"); - @end if - @if({sctIsPNextChainConst} == False) - settings.formatNameType(indents, "pNext", "void*"); - @end if - settings.stream() << "{sctName}\\n"; - break; + case {sctStructureTypeIndex}: + settings.stream() << "{sctName}\\n"; + break; @end if @end struct - - case 47: // VK_STRUCTURE_TYPE_LOADER_INSTANCE_CREATE_INFO - case 48: // VK_STRUCTURE_TYPE_LOADER_DEVICE_CREATE_INFO - settings.formatNameType(indents, "pNext", "const void*"); - settings.stream() << "NULL\\n"; - break; - default: - settings.formatNameType(indents, "pNext", "const void*"); - settings.stream() << "UNKNOWN (" << (int64_t) (static_cast(object)->sType) << ")\\n"; + case 47: // VK_STRUCTURE_TYPE_LOADER_INSTANCE_CREATE_INFO + case 48: // VK_STRUCTURE_TYPE_LOADER_DEVICE_CREATE_INFO + default: + settings.stream() << "NULL\\n"; + break; }} }} void dump_text_pNext_trampoline(const void* object, const ApiDumpSettings& settings, int indents) {{ - switch((int64_t) (static_cast(object)->sType)) {{ + const auto* base_struct = reinterpret_cast(object); + switch(base_struct->sType) {{ @foreach struct @if({sctStructureTypeIndex} != -1) case {sctStructureTypeIndex}: - dump_text_pNext(static_cast(object), settings, "{sctName}", indents, dump_text_{sctName}); + dump_text_pNext(reinterpret_cast(object), settings, "{sctName}", indents, dump_text_{sctName}); break; @end if @end struct case 47: // VK_STRUCTURE_TYPE_LOADER_INSTANCE_CREATE_INFO case 48: // VK_STRUCTURE_TYPE_LOADER_DEVICE_CREATE_INFO - if(static_cast(object)->pNext != nullptr){{ - dump_text_pNext_trampoline(static_cast(static_cast(object)->pNext), settings, indents); + if(base_struct->pNext != nullptr){{ + dump_text_pNext_trampoline(reinterpret_cast(base_struct->pNext), settings, indents); }} else {{ settings.formatNameType(indents, "pNext", "const void*"); settings.stream() << "NULL\\n"; @@ -771,7 +763,7 @@ break; default: settings.formatNameType(indents, "pNext", "const void*"); - settings.stream() << "UNKNOWN (" << (int64_t) (static_cast(object)->sType) << ")\\n"; + settings.stream() << "UNKNOWN (" << (int64_t) (base_struct->sType) << ")\\n"; }} }} @@ -2506,18 +2498,11 @@ def __init__(self, rootNode, constants, enums): self.structureIndex = -1 - if(self.structExtends is not None): - for member in self.members: - if(member.structValues is not None): - for opt in enums['VkStructureType'].options: - if(member.structValues == opt.name): - self.structureIndex = opt.value - - self.isPNextChainConst = False for member in self.members: - if member.name == 'pNext' and member.type == "const void*": - self.isPNextChainConst = True - break + if(member.structValues is not None): + for opt in enums['VkStructureType'].options: + if(member.structValues == opt.name): + self.structureIndex = opt.value # The xml doesn't contain the relevant information here since the struct contains 'fixed' length arrays. # Thus we have to fix up the variable such that the length member corresponds to the runtime length, not compile time. @@ -2543,7 +2528,6 @@ def values(self): return { 'sctName': self.name, 'sctStructureTypeIndex': self.structureIndex, - 'sctIsPNextChainConst': self.isPNextChainConst, } class VulkanSystemType: From 2067cd7aa1b9515aec331646e3427813543587bb Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Wed, 8 Feb 2023 14:27:18 -0700 Subject: [PATCH 050/154] apidump: Print pointer system types correctly Certain system types are pointers but were being printed as if they were values. This was causesing no_address mode to not sanitize the pointer's address. --- layersvt/api_dump.h | 1 - scripts/api_dump_generator.py | 30 +++++++++++++++++++++++++++++- 2 files changed, 29 insertions(+), 2 deletions(-) diff --git a/layersvt/api_dump.h b/layersvt/api_dump.h index 6d63ebb515..a7246f387f 100644 --- a/layersvt/api_dump.h +++ b/layersvt/api_dump.h @@ -992,7 +992,6 @@ void dump_text_void(const void *object, const ApiDumpSettings &settings, int ind return; } OutputAddress(settings, object); - settings.stream(); } void dump_text_int(int object, const ApiDumpSettings &settings, int indents) { settings.stream() << object; } diff --git a/scripts/api_dump_generator.py b/scripts/api_dump_generator.py index 21cddffaf2..1e68c2bc98 100644 --- a/scripts/api_dump_generator.py +++ b/scripts/api_dump_generator.py @@ -522,7 +522,16 @@ @foreach systype void dump_text_{sysName}(const {sysType} object, const ApiDumpSettings& settings, int indents) {{ + @if({sysNeedsPointer} == True) + if (object == NULL) {{ + settings.stream() << "NULL"; + return; + }} + OutputAddress(settings, object); + @end if + @if({sysNeedsPointer} == False) settings.stream() << object; + @end if }} @end systype @@ -911,7 +920,14 @@ @foreach systype void dump_html_{sysName}(const {sysType} object, const ApiDumpSettings& settings, int indents) {{ + @if({sysNeedsPointer} == True) + settings.stream() << "
"; + OutputAddress(settings, object); + settings.stream() << "
"; + @end if + @if({sysNeedsPointer} == False) settings.stream() << "
" << object << "
"; + @end if }} @end systype @@ -1275,7 +1291,13 @@ @foreach systype void dump_json_{sysName}(const {sysType} object, const ApiDumpSettings& settings, int indents) {{ + @if({sysNeedsPointer} == True) + OutputAddressJSON(settings, object); + settings.stream() << "\\n"; + @end if + @if({sysNeedsPointer} == False) settings.stream() << "\\"" << object << "\\""; + @end if }} @end systype @@ -2534,7 +2556,12 @@ class VulkanSystemType: def __init__(self, name, ext): self.name = name - self.type = self.name if name not in POINTER_TYPES else self.name + '*' + if name in POINTER_TYPES: + self.type = self.name + '*' + self.needsPointer = True + else: + self.needsPointer = False + self.type = self.name self.ext = ext def __hash__(self): @@ -2544,6 +2571,7 @@ def values(self): return { 'sysName': self.name, 'sysType': self.type, + 'sysNeedsPointer': self.needsPointer, } class VulkanUnion: From 68455ea7849a4d2f6dc0857f0bde5492cfba692b Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Wed, 8 Feb 2023 14:30:25 -0700 Subject: [PATCH 051/154] apidump: fix queue priorities printing The priorities member of VkQueueFamilyGlobalPriorityPropertiesKHR is a fixed sized array that uses the priorityCount member to determine the 'real' size. Thus, apidump should use the priorities member to determine the real length when printing. --- scripts/api_dump_generator.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/scripts/api_dump_generator.py b/scripts/api_dump_generator.py index 1e68c2bc98..476af965e6 100644 --- a/scripts/api_dump_generator.py +++ b/scripts/api_dump_generator.py @@ -2528,7 +2528,7 @@ def __init__(self, rootNode, constants, enums): # The xml doesn't contain the relevant information here since the struct contains 'fixed' length arrays. # Thus we have to fix up the variable such that the length member corresponds to the runtime length, not compile time. - if self.name in ['VkPhysicalDeviceMemoryProperties','VkPhysicalDeviceGroupProperties', 'VkPhysicalDeviceMemoryBudgetPropertiesEXT']: + if self.name in ['VkPhysicalDeviceMemoryProperties','VkPhysicalDeviceGroupProperties', 'VkPhysicalDeviceMemoryBudgetPropertiesEXT', 'VkQueueFamilyGlobalPriorityPropertiesKHR']: for member in self.members: if member.name == 'memoryTypes': member.lengthMember = True @@ -2545,6 +2545,10 @@ def __init__(self, rootNode, constants, enums): if member.name == 'heapUsage': member.lengthMember = True member.arrayLength = 'ApiDumpInstance::current().getMemoryHeapCount()' + if member.name == 'priorities': + member.lengthMember = True + member.arrayLength = 'priorityCount' + def values(self): return { From 1d64e21d375e542ccad911f5da5fe63bed8abe35 Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Mon, 13 Feb 2023 17:05:31 -0700 Subject: [PATCH 052/154] apidump: Print JSON correctly when detailed is false When the detailed option is set to false, the JSON output would add trailing commas to the returnType regardless of whether there was a following element, which is invalid JSON. Also, the manually generated UNUSED member sections were moved to a function which is cleaner to read. --- layersvt/api_dump.h | 16 +++++++++++++++- scripts/api_dump_generator.py | 9 +-------- 2 files changed, 16 insertions(+), 9 deletions(-) diff --git a/layersvt/api_dump.h b/layersvt/api_dump.h index a7246f387f..422682c16f 100644 --- a/layersvt/api_dump.h +++ b/layersvt/api_dump.h @@ -1182,7 +1182,12 @@ void dump_json_function_head(ApiDumpInstance &dump_inst, const char *funcName, c } // Display return value - settings.stream() << settings.indentation(3) << "\"returnType\" : \"" << funcReturn << "\",\n"; + settings.stream() << settings.indentation(3) << "\"returnType\" : \"" << funcReturn << "\""; + // Add a trailing comma if the return type isn't void or detailed mode is false - JSON doesn't allow trailing commas in object + if (strcmp("void", funcReturn) != 0 || settings.showParams()) { + settings.stream() << ","; + } + settings.stream() << "\n"; settings.shouldFlush() ? settings.stream() << std::flush : settings.stream(); } @@ -1359,6 +1364,15 @@ void dump_json_special(const char *text, const ApiDumpSettings &settings, const settings.stream() << settings.indentation(indents) << "}"; } +void dump_json_UNUSED(const ApiDumpSettings &settings, const char *type_string, const char *name, int indents) { + settings.stream() << settings.indentation(indents) << "{\n"; + settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << "\",\n"; + settings.stream() << settings.indentation(indents + 1) << "\"name\" : \"" << name << "\",\n"; + settings.stream() << settings.indentation(indents + 1) << "\"address\" : \"UNUSED\",\n"; + settings.stream() << settings.indentation(indents + 1) << "\"value\" : \"UNUSED\"\n"; + settings.stream() << settings.indentation(indents) << "}"; +} + void dump_json_cstring(const char *object, const ApiDumpSettings &settings, int indents) { if (object == NULL) settings.stream() << "\"\""; diff --git a/scripts/api_dump_generator.py b/scripts/api_dump_generator.py index 476af965e6..c54a486f7b 100644 --- a/scripts/api_dump_generator.py +++ b/scripts/api_dump_generator.py @@ -1441,14 +1441,7 @@ @if('{memCondition}' != 'None') else - {{ - settings.stream() << settings.indentation(indents+1) << "{{\\n"; - settings.stream() << settings.indentation(indents+2) << "\\"type\\" : \\"{memType}\\",\\n"; - settings.stream() << settings.indentation(indents+2) << "\\"name\\" : \\"{memName}\\",\\n"; - settings.stream() << settings.indentation(indents+2) << "\\"address\\" : \\"UNUSED\\",\\n"; - settings.stream() << settings.indentation(indents+2) << "\\"value\\" : \\"UNUSED\\"\\n"; - settings.stream() << settings.indentation(indents+1) << "}}"; - }} + dump_json_UNUSED(settings, "{memType}", "{memName}", indents + 1); @end if @end member settings.stream() << "\\n" << settings.indentation(indents) << "]"; From c3998bb5ae5b93711722a0bad57f6f2210bdbab4 Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Mon, 13 Feb 2023 17:13:08 -0700 Subject: [PATCH 053/154] apidump: Store data before printing anything Inside of the struct/function printing functions, there may be one member which requires another member's data to produce correct output but may not be accessible within the struct. This means that there are various 'set' calls made to store data used in a pNext chain or in a subobject. The original implementation had each 'set' function right before the data it was relevant to. Unfortunately, there were situations where the data was needed before the set was called. The solution is to move the 'set' to the top of the printing functions before any 'get' has a chance to make use of it. --- scripts/api_dump_generator.py | 35 ++++++++++++++++++++++++++++------- 1 file changed, 28 insertions(+), 7 deletions(-) diff --git a/scripts/api_dump_generator.py b/scripts/api_dump_generator.py index c54a486f7b..f6fc7129bc 100644 --- a/scripts/api_dump_generator.py +++ b/scripts/api_dump_generator.py @@ -638,12 +638,19 @@ settings.stream() << "address:\\n"; @foreach member - @if('{memCondition}' != 'None') + @if('{memParameterStorage}' != '' and '{memCondition}' != 'None') if({memCondition}) + {memParameterStorage} @end if - @if('{memParameterStorage}' != '') + @if('{memParameterStorage}' != '' and '{memCondition}' == 'None') {memParameterStorage} @end if + @end member + + @foreach member + @if('{memCondition}' != 'None') + if({memCondition}) + @end if @if({memPtrLevel} == 0) @if('{memName}' != 'pNext') dump_text_value(object.{memName}, settings, "{memType}", "{memName}", indents + 1, dump_text_{memTypeID}); // AET @@ -1038,12 +1045,19 @@ settings.stream() << "
"; @foreach member - @if('{memCondition}' != 'None') + @if('{memParameterStorage}' != '' and '{memCondition}' != 'None') if({memCondition}) + {memParameterStorage} @end if - @if('{memParameterStorage}' != '') + @if('{memParameterStorage}' != '' and '{memCondition}' == 'None') {memParameterStorage} @end if + @end member + + @foreach member + @if('{memCondition}' != 'None') + if({memCondition}) + @end if @if({memPtrLevel} == 0) @if('{memName}' != 'pNext') dump_html_value(object.{memName}, settings, "{memType}", "{memName}", indents + 1, dump_html_{memTypeID}); @@ -1389,15 +1403,22 @@ {{ settings.stream() << settings.indentation(indents) << "[\\n"; + @foreach member + @if('{memParameterStorage}' != '' and '{memCondition}' != 'None') + if({memCondition}) + {memParameterStorage} + @end if + @if('{memParameterStorage}' != '' and '{memCondition}' == 'None') + {memParameterStorage} + @end if + @end member + @foreach member @if({memIndex} != 0) settings.stream() << ",\\n"; @end if @if('{memCondition}' != 'None') if({memCondition}) - @end if - @if('{memParameterStorage}' != '') - {memParameterStorage} @end if @if({memPtrLevel} == 0) @if('{memName}' != 'pNext') From 0755fd202acaf126c15e612a16ec8b386aa8156c Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Tue, 14 Feb 2023 17:14:01 -0700 Subject: [PATCH 054/154] apidump: Fix type_size being ignored type_size is usually zero but if it wasn't and api dump was outputting with tabs for fill characters, the padding wasn't being applied. Adding a `<< ""` forces the correct mode. When not using tabs for fill, we can use `std::left << std::setw(type_size)` to remove a strlen call. --- layersvt/api_dump.h | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/layersvt/api_dump.h b/layersvt/api_dump.h index 422682c16f..e6b76c44d7 100644 --- a/layersvt/api_dump.h +++ b/layersvt/api_dump.h @@ -528,9 +528,10 @@ class ApiDumpSettings { if (show_type) { if (use_spaces) - output_stream << type << std::setw(type_size - (int)strlen(type)) << " = "; + output_stream << std::left << std::setw(type_size) << type << " = "; else - output_stream << type << std::setw((type_size - (int)strlen(type) - 1 + tab_size) / tab_size) << " = "; + output_stream << type << std::setw((type_size - (int)strlen(type) - 1 + tab_size) / tab_size) << "" + << " = "; } else { output_stream << " = "; } From d587453a01fa45cc44530b6ee89f583e53f4acfb Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Thu, 16 Feb 2023 19:01:51 -0700 Subject: [PATCH 055/154] apidump: Use "address" for appropriate system types Various system types come from external API's and represent data which is address-like. This means from run to run the values are changing, which makes diffing Api Dump output difficult due to spurious changes. This commit treats all system types like a pointer in that "address" will be printed if show_address mode is false. --- scripts/api_dump_generator.py | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/scripts/api_dump_generator.py b/scripts/api_dump_generator.py index f6fc7129bc..dde2bb4ec6 100644 --- a/scripts/api_dump_generator.py +++ b/scripts/api_dump_generator.py @@ -530,7 +530,10 @@ OutputAddress(settings, object); @end if @if({sysNeedsPointer} == False) - settings.stream() << object; + if (settings.showAddress()) + settings.stream() << object; + else + settings.stream() << "address"; @end if }} @end systype @@ -933,7 +936,10 @@ settings.stream() << "
"; @end if @if({sysNeedsPointer} == False) - settings.stream() << "
" << object << "
"; + if (settings.showAddress()) + settings.stream() << "
" << object << "
"; + else + settings.stream() << "
address
"; @end if }} @end systype @@ -1310,7 +1316,10 @@ settings.stream() << "\\n"; @end if @if({sysNeedsPointer} == False) - settings.stream() << "\\"" << object << "\\""; + if (settings.showAddress()) + settings.stream() << "\\"" << object << "\\""; + else + settings.stream() << "\\"address\\""; @end if }} @end systype From 1c1ddc716b81ffc1ed22c479377195b38458f113 Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Tue, 21 Feb 2023 11:26:37 -0700 Subject: [PATCH 056/154] Remove usage of VK_LAYER_EXPORT This PR fixes API Dump, Monitor, Screenshot, and the vk_layer_settings utility to no longer use the VK_LAYER_EXPORT macro which was defined in vk_layer.h. The macro was recently removed thus all the projects using it must be updated. In addition to defining the macro locally to each file, this commit removes function exporting for functions which do not need it. For Example, it was being added to each and every function in API Dump when only ~7 functions in the entire Vulkan interface need to be exported. Additionally, it was entirely removed from the vk_layer_settings utility due to the utility being a static library thus having no effect. --- layersvt/monitor.cpp | 32 +++++++++++++++++++----------- layersvt/screenshot.cpp | 21 ++++++++++++++------ scripts/api_dump_generator.py | 26 +++++++++++++++--------- scripts/layer_factory_generator.py | 24 ++++++++++++++-------- vku/vk_layer_settings.cpp | 18 ++++++++--------- vku/vk_layer_settings.h | 18 ++++++++--------- 6 files changed, 86 insertions(+), 53 deletions(-) diff --git a/layersvt/monitor.cpp b/layersvt/monitor.cpp index 2c6663acc0..8e706b8102 100644 --- a/layersvt/monitor.cpp +++ b/layersvt/monitor.cpp @@ -84,7 +84,7 @@ static std::unordered_map layer_data_map; template monitor_layer_data *GetLayerDataPtr(void *data_key, std::unordered_map &data_map); -VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkCreateDevice(VkPhysicalDevice gpu, const VkDeviceCreateInfo *pCreateInfo, +VKAPI_ATTR VkResult VKAPI_CALL vkCreateDevice(VkPhysicalDevice gpu, const VkDeviceCreateInfo *pCreateInfo, const VkAllocationCallbacks *pAllocator, VkDevice *pDevice) { VkLayerDeviceCreateInfo *chain_info = get_chain_info(pCreateInfo, VK_LAYER_LINK_INFO); @@ -132,7 +132,7 @@ VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkCreateDevice(VkPhysicalDevice g return result; } -VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumeratePhysicalDevices(VkInstance instance, uint32_t *pPhysicalDeviceCount, +VKAPI_ATTR VkResult VKAPI_CALL vkEnumeratePhysicalDevices(VkInstance instance, uint32_t *pPhysicalDeviceCount, VkPhysicalDevice *pPhysicalDevices) { dispatch_key key = get_dispatch_key(instance); monitor_layer_data *my_data = GetLayerDataPtr(key, layer_data_map); @@ -151,7 +151,7 @@ VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumeratePhysicalDevices(VkInst return result; } -VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumeratePhysicalDeviceGroups( +VKAPI_ATTR VkResult VKAPI_CALL vkEnumeratePhysicalDeviceGroups( VkInstance instance, uint32_t *pPhysicalDeviceGroupCount, VkPhysicalDeviceGroupProperties *pPhysicalDeviceGroupProperties) { dispatch_key key = get_dispatch_key(instance); monitor_layer_data *my_data = GetLayerDataPtr(key, layer_data_map); @@ -172,7 +172,7 @@ VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumeratePhysicalDeviceGroups( return result; } -VK_LAYER_EXPORT VKAPI_ATTR void VKAPI_CALL vkDestroyDevice(VkDevice device, const VkAllocationCallbacks *pAllocator) { +VKAPI_ATTR void VKAPI_CALL vkDestroyDevice(VkDevice device, const VkAllocationCallbacks *pAllocator) { dispatch_key key = get_dispatch_key(device); monitor_layer_data *my_data = GetLayerDataPtr(key, layer_data_map); VkLayerDispatchTable *pTable = my_data->device_dispatch_table; @@ -182,7 +182,7 @@ VK_LAYER_EXPORT VKAPI_ATTR void VKAPI_CALL vkDestroyDevice(VkDevice device, cons layer_data_map.erase(key); } -VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkCreateInstance(const VkInstanceCreateInfo *pCreateInfo, +VKAPI_ATTR VkResult VKAPI_CALL vkCreateInstance(const VkInstanceCreateInfo *pCreateInfo, const VkAllocationCallbacks *pAllocator, VkInstance *pInstance) { VkLayerInstanceCreateInfo *chain_info = get_chain_info(pCreateInfo, VK_LAYER_LINK_INFO); @@ -232,7 +232,7 @@ VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkCreateInstance(const VkInstance return result; } -VK_LAYER_EXPORT VKAPI_ATTR void VKAPI_CALL vkDestroyInstance(VkInstance instance, const VkAllocationCallbacks *pAllocator) { +VKAPI_ATTR void VKAPI_CALL vkDestroyInstance(VkInstance instance, const VkAllocationCallbacks *pAllocator) { dispatch_key key = get_dispatch_key(instance); monitor_layer_data *my_data = GetLayerDataPtr(key, layer_data_map); VkLayerInstanceDispatchTable *pTable = my_data->instance_dispatch_table; @@ -241,7 +241,7 @@ VK_LAYER_EXPORT VKAPI_ATTR void VKAPI_CALL vkDestroyInstance(VkInstance instance layer_data_map.erase(key); } -VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkQueuePresentKHR(VkQueue queue, const VkPresentInfoKHR *pPresentInfo) { +VKAPI_ATTR VkResult VKAPI_CALL vkQueuePresentKHR(VkQueue queue, const VkPresentInfoKHR *pPresentInfo) { monitor_layer_data *my_data = GetLayerDataPtr(get_dispatch_key(queue), layer_data_map); time_t now; @@ -274,7 +274,7 @@ VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkQueuePresentKHR(VkQueue queue, return result; } -VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkGetPhysicalDeviceToolPropertiesEXT( +VKAPI_ATTR VkResult VKAPI_CALL vkGetPhysicalDeviceToolPropertiesEXT( VkPhysicalDevice physicalDevice, uint32_t *pToolCount, VkPhysicalDeviceToolPropertiesEXT *pToolProperties) { static const VkPhysicalDeviceToolPropertiesEXT monitor_layer_tool_props = { VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_TOOL_PROPERTIES_EXT, @@ -306,7 +306,7 @@ VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkGetPhysicalDeviceToolProperties } #if defined(VK_USE_PLATFORM_WIN32_KHR) -VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkCreateWin32SurfaceKHR(VkInstance instance, +VKAPI_ATTR VkResult VKAPI_CALL vkCreateWin32SurfaceKHR(VkInstance instance, const VkWin32SurfaceCreateInfoKHR *pCreateInfo, const VkAllocationCallbacks *pAllocator, VkSurfaceKHR *pSurface) { @@ -318,7 +318,7 @@ VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkCreateWin32SurfaceKHR(VkInstanc return result; } #elif defined(VK_USE_PLATFORM_XCB_KHR) -VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkCreateXcbSurfaceKHR(VkInstance instance, +VKAPI_ATTR VkResult VKAPI_CALL vkCreateXcbSurfaceKHR(VkInstance instance, const VkXcbSurfaceCreateInfoKHR *pCreateInfo, const VkAllocationCallbacks *pAllocator, VkSurfaceKHR *pSurface) { @@ -357,7 +357,15 @@ VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkCreateXcbSurfaceKHR(VkInstance } #endif -VK_LAYER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetDeviceProcAddr(VkDevice dev, const char *funcName) { +#if defined(__GNUC__) && __GNUC__ >= 4 +#define EXPORT_FUNCTION __attribute__((visibility("default"))) +#elif defined(__SUNPRO_C) && (__SUNPRO_C >= 0x590) +#define EXPORT_FUNCTION __attribute__((visibility("default"))) +#else +#define EXPORT_FUNCTION +#endif + +EXPORT_FUNCTION VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetDeviceProcAddr(VkDevice dev, const char *funcName) { #define ADD_HOOK(fn) \ if (!strncmp(#fn, funcName, sizeof(#fn))) return (PFN_vkVoidFunction)fn @@ -376,7 +384,7 @@ VK_LAYER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetDeviceProcAddr(VkD return pTable->GetDeviceProcAddr(dev, funcName); } -VK_LAYER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetInstanceProcAddr(VkInstance instance, const char *funcName) { +EXPORT_FUNCTION VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetInstanceProcAddr(VkInstance instance, const char *funcName) { #define ADD_HOOK(fn) \ if (!strncmp(#fn, funcName, sizeof(#fn))) return (PFN_vkVoidFunction)fn diff --git a/layersvt/screenshot.cpp b/layersvt/screenshot.cpp index 4b20dc6d30..feb52a0289 100755 --- a/layersvt/screenshot.cpp +++ b/layersvt/screenshot.cpp @@ -1602,26 +1602,35 @@ static PFN_vkVoidFunction intercept_khr_swapchain_command(const char *name, VkDe } // namespace screenshot +#if defined(__GNUC__) && __GNUC__ >= 4 +#define EXPORT_FUNCTION __attribute__((visibility("default"))) +#elif defined(__SUNPRO_C) && (__SUNPRO_C >= 0x590) +#define EXPORT_FUNCTION __attribute__((visibility("default"))) +#else +#define EXPORT_FUNCTION +#endif + + // loader-layer interface v0, just wrappers since there is only a layer -VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateInstanceLayerProperties(uint32_t *pCount, +EXPORT_FUNCTION VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateInstanceLayerProperties(uint32_t *pCount, VkLayerProperties *pProperties) { return screenshot::EnumerateInstanceLayerProperties(pCount, pProperties); } -VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateDeviceLayerProperties(VkPhysicalDevice physicalDevice, uint32_t *pCount, +EXPORT_FUNCTION VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateDeviceLayerProperties(VkPhysicalDevice physicalDevice, uint32_t *pCount, VkLayerProperties *pProperties) { // the layer command handles VK_NULL_HANDLE just fine internally assert(physicalDevice == VK_NULL_HANDLE); return screenshot::EnumerateDeviceLayerProperties(VK_NULL_HANDLE, pCount, pProperties); } -VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateInstanceExtensionProperties(const char *pLayerName, uint32_t *pCount, +EXPORT_FUNCTION VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateInstanceExtensionProperties(const char *pLayerName, uint32_t *pCount, VkExtensionProperties *pProperties) { return screenshot::EnumerateInstanceExtensionProperties(pLayerName, pCount, pProperties); } -VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateDeviceExtensionProperties(VkPhysicalDevice physicalDevice, +EXPORT_FUNCTION VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateDeviceExtensionProperties(VkPhysicalDevice physicalDevice, const char *pLayerName, uint32_t *pCount, VkExtensionProperties *pProperties) { // the layer command handles VK_NULL_HANDLE just fine internally @@ -1629,10 +1638,10 @@ VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateDeviceExtensionPropert return screenshot::EnumerateDeviceExtensionProperties(VK_NULL_HANDLE, pLayerName, pCount, pProperties); } -VK_LAYER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetDeviceProcAddr(VkDevice dev, const char *funcName) { +EXPORT_FUNCTION VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetDeviceProcAddr(VkDevice dev, const char *funcName) { return screenshot::GetDeviceProcAddr(dev, funcName); } -VK_LAYER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetInstanceProcAddr(VkInstance instance, const char *funcName) { +EXPORT_FUNCTION VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetInstanceProcAddr(VkInstance instance, const char *funcName) { return screenshot::GetInstanceProcAddr(instance, funcName); } diff --git a/scripts/api_dump_generator.py b/scripts/api_dump_generator.py index dde2bb4ec6..a6ecd5492f 100644 --- a/scripts/api_dump_generator.py +++ b/scripts/api_dump_generator.py @@ -78,7 +78,15 @@ // Specifically implemented functions -VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkCreateInstance(const VkInstanceCreateInfo* pCreateInfo, const VkAllocationCallbacks* pAllocator, VkInstance* pInstance) +#if defined(__GNUC__) && __GNUC__ >= 4 +#define EXPORT_FUNCTION __attribute__((visibility("default"))) +#elif defined(__SUNPRO_C) && (__SUNPRO_C >= 0x590) +#define EXPORT_FUNCTION __attribute__((visibility("default"))) +#else +#define EXPORT_FUNCTION +#endif + +VKAPI_ATTR VkResult VKAPI_CALL vkCreateInstance(const VkInstanceCreateInfo* pCreateInfo, const VkAllocationCallbacks* pAllocator, VkInstance* pInstance) {{ ApiDumpInstance::current().outputMutex()->lock(); if (ApiDumpInstance::current().shouldDumpOutput()) {{ @@ -131,7 +139,7 @@ return result; }} -VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkCreateDevice(VkPhysicalDevice physicalDevice, const VkDeviceCreateInfo* pCreateInfo, const VkAllocationCallbacks* pAllocator, VkDevice* pDevice) +VKAPI_ATTR VkResult VKAPI_CALL vkCreateDevice(VkPhysicalDevice physicalDevice, const VkDeviceCreateInfo* pCreateInfo, const VkAllocationCallbacks* pAllocator, VkDevice* pDevice) {{ ApiDumpInstance::current().outputMutex()->lock(); if (ApiDumpInstance::current().shouldDumpOutput()) {{ @@ -185,12 +193,12 @@ return result; }} -VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateInstanceExtensionProperties(const char* pLayerName, uint32_t* pPropertyCount, VkExtensionProperties* pProperties) +EXPORT_FUNCTION VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateInstanceExtensionProperties(const char* pLayerName, uint32_t* pPropertyCount, VkExtensionProperties* pProperties) {{ return util_GetExtensionProperties(0, NULL, pPropertyCount, pProperties); }} -VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateInstanceLayerProperties(uint32_t* pPropertyCount, VkLayerProperties* pProperties) +EXPORT_FUNCTION VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateInstanceLayerProperties(uint32_t* pPropertyCount, VkLayerProperties* pProperties) {{ static const VkLayerProperties layerProperties[] = {{ {{ @@ -204,7 +212,7 @@ return util_GetLayerProperties(ARRAY_SIZE(layerProperties), layerProperties, pPropertyCount, pProperties); }} -VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateDeviceLayerProperties(VkPhysicalDevice physicalDevice, uint32_t* pPropertyCount, VkLayerProperties* pProperties) +EXPORT_FUNCTION VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateDeviceLayerProperties(VkPhysicalDevice physicalDevice, uint32_t* pPropertyCount, VkLayerProperties* pProperties) {{ static const VkLayerProperties layerProperties[] = {{ {{ @@ -221,7 +229,7 @@ // Autogen instance functions @foreach function where('{funcDispatchType}' == 'instance' and '{funcName}' not in ['vkCreateInstance', 'vkCreateDevice', 'vkGetInstanceProcAddr', 'vkEnumerateDeviceExtensionProperties', 'vkEnumerateDeviceLayerProperties']) -VK_LAYER_EXPORT VKAPI_ATTR {funcReturn} VKAPI_CALL {funcName}({funcTypedParams}) +VKAPI_ATTR {funcReturn} VKAPI_CALL {funcName}({funcTypedParams}) {{ ApiDumpInstance::current().outputMutex()->lock(); if (ApiDumpInstance::current().shouldDumpOutput()) {{ @@ -320,7 +328,7 @@ // Autogen device functions @foreach function where('{funcDispatchType}' == 'device' and '{funcName}' not in ['vkGetDeviceProcAddr']) -VK_LAYER_EXPORT VKAPI_ATTR {funcReturn} VKAPI_CALL {funcName}({funcTypedParams}) +VKAPI_ATTR {funcReturn} VKAPI_CALL {funcName}({funcTypedParams}) {{ ApiDumpInstance::current().outputMutex()->lock(); @if('{funcName}' == 'vkDebugMarkerSetObjectNameEXT') @@ -398,7 +406,7 @@ }} @end function -VK_LAYER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetInstanceProcAddr(VkInstance instance, const char* pName) +EXPORT_FUNCTION VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetInstanceProcAddr(VkInstance instance, const char* pName) {{ @foreach function where('{funcType}' in ['global', 'instance'] and '{funcName}' not in [ 'vkEnumerateDeviceExtensionProperties' ]) if(strcmp(pName, "{funcName}") == 0) @@ -411,7 +419,7 @@ return instance_dispatch_table(instance)->GetInstanceProcAddr(instance, pName); }} -VK_LAYER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetDeviceProcAddr(VkDevice device, const char* pName) +EXPORT_FUNCTION VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetDeviceProcAddr(VkDevice device, const char* pName) {{ @foreach function where('{funcType}' == 'device') if(strcmp(pName, "{funcName}") == 0) diff --git a/scripts/layer_factory_generator.py b/scripts/layer_factory_generator.py index b3cdd41d82..8a51dbcc90 100644 --- a/scripts/layer_factory_generator.py +++ b/scripts/layer_factory_generator.py @@ -448,24 +448,32 @@ class layer_factory; inline_custom_source_postamble = """ // loader-layer interface v0, just wrappers since there is only a layer -VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateInstanceExtensionProperties(const char *pLayerName, uint32_t *pCount, +#if defined(__GNUC__) && __GNUC__ >= 4 +#define EXPORT_FUNCTION __attribute__((visibility("default"))) +#elif defined(__SUNPRO_C) && (__SUNPRO_C >= 0x590) +#define EXPORT_FUNCTION __attribute__((visibility("default"))) +#else +#define EXPORT_FUNCTION +#endif + +EXPORT_FUNCTION VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateInstanceExtensionProperties(const char *pLayerName, uint32_t *pCount, VkExtensionProperties *pProperties) { return vulkan_layer_factory::EnumerateInstanceExtensionProperties(pLayerName, pCount, pProperties); } -VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateInstanceLayerProperties(uint32_t *pCount, +EXPORT_FUNCTION VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateInstanceLayerProperties(uint32_t *pCount, VkLayerProperties *pProperties) { return vulkan_layer_factory::EnumerateInstanceLayerProperties(pCount, pProperties); } -VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateDeviceLayerProperties(VkPhysicalDevice physicalDevice, uint32_t *pCount, +EXPORT_FUNCTION VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateDeviceLayerProperties(VkPhysicalDevice physicalDevice, uint32_t *pCount, VkLayerProperties *pProperties) { // the layer command handles VK_NULL_HANDLE just fine internally assert(physicalDevice == VK_NULL_HANDLE); return vulkan_layer_factory::EnumerateDeviceLayerProperties(VK_NULL_HANDLE, pCount, pProperties); } -VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateDeviceExtensionProperties(VkPhysicalDevice physicalDevice, +EXPORT_FUNCTION VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateDeviceExtensionProperties(VkPhysicalDevice physicalDevice, const char *pLayerName, uint32_t *pCount, VkExtensionProperties *pProperties) { // the layer command handles VK_NULL_HANDLE just fine internally @@ -473,20 +481,20 @@ class layer_factory; return vulkan_layer_factory::EnumerateDeviceExtensionProperties(VK_NULL_HANDLE, pLayerName, pCount, pProperties); } -VK_LAYER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetDeviceProcAddr(VkDevice dev, const char *funcName) { +EXPORT_FUNCTION VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetDeviceProcAddr(VkDevice dev, const char *funcName) { return vulkan_layer_factory::GetDeviceProcAddr(dev, funcName); } -VK_LAYER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetInstanceProcAddr(VkInstance instance, const char *funcName) { +EXPORT_FUNCTION VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetInstanceProcAddr(VkInstance instance, const char *funcName) { return vulkan_layer_factory::GetInstanceProcAddr(instance, funcName); } -VK_LAYER_EXPORT VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vk_layerGetPhysicalDeviceProcAddr(VkInstance instance, +VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vk_layerGetPhysicalDeviceProcAddr(VkInstance instance, const char *funcName) { return vulkan_layer_factory::GetPhysicalDeviceProcAddr(instance, funcName); } -VK_LAYER_EXPORT VKAPI_ATTR VkResult VKAPI_CALL vkNegotiateLoaderLayerInterfaceVersion(VkNegotiateLayerInterface *pVersionStruct) { +EXPORT_FUNCTION VKAPI_ATTR VkResult VKAPI_CALL vkNegotiateLoaderLayerInterfaceVersion(VkNegotiateLayerInterface *pVersionStruct) { assert(pVersionStruct != NULL); assert(pVersionStruct->sType == LAYER_NEGOTIATE_INTERFACE_STRUCT); diff --git a/vku/vk_layer_settings.cpp b/vku/vk_layer_settings.cpp index 7e1d72575b..9c03a52879 100644 --- a/vku/vk_layer_settings.cpp +++ b/vku/vk_layer_settings.cpp @@ -270,12 +270,12 @@ static std::string GetEnvVarKey(const char *layer_key, const char *setting_key, return result.str(); } -VK_LAYER_EXPORT void InitLayerSettingsLogCallback(LAYER_SETTING_LOG_CALLBACK callback) { +void InitLayerSettingsLogCallback(LAYER_SETTING_LOG_CALLBACK callback) { vk_layer_settings.SetCallback(callback); return; } -VK_LAYER_EXPORT bool IsLayerSetting(const char *layer_key, const char *setting_key) { +bool IsLayerSetting(const char *layer_key, const char *setting_key) { assert(layer_key); assert(!std::string(layer_key).empty()); assert(setting_key); @@ -299,7 +299,7 @@ static std::string GetLayerSettingData(const char *layer_key, const char *settin return vk_layer_settings.Get(GetSettingKey(layer_key, setting_key).c_str()); } -VK_LAYER_EXPORT bool GetLayerSettingBool(const char *layer_key, const char *setting_key) { +bool GetLayerSettingBool(const char *layer_key, const char *setting_key) { assert(IsLayerSetting(layer_key, setting_key)); bool result = false; // default value @@ -320,7 +320,7 @@ VK_LAYER_EXPORT bool GetLayerSettingBool(const char *layer_key, const char *sett return result; } -VK_LAYER_EXPORT int GetLayerSettingInt(const char *layer_key, const char *setting_key) { +int GetLayerSettingInt(const char *layer_key, const char *setting_key) { assert(IsLayerSetting(layer_key, setting_key)); int result = 0; // default value @@ -339,7 +339,7 @@ VK_LAYER_EXPORT int GetLayerSettingInt(const char *layer_key, const char *settin return result; } -VK_LAYER_EXPORT double GetLayerSettingFloat(const char *layer_key, const char *setting_key) { +double GetLayerSettingFloat(const char *layer_key, const char *setting_key) { assert(IsLayerSetting(layer_key, setting_key)); double result = 0.0; // default value @@ -358,7 +358,7 @@ VK_LAYER_EXPORT double GetLayerSettingFloat(const char *layer_key, const char *s return result; } -VK_LAYER_EXPORT std::string GetLayerSettingString(const char *layer_key, const char *setting_key) { +std::string GetLayerSettingString(const char *layer_key, const char *setting_key) { assert(IsLayerSetting(layer_key, setting_key)); std::string setting = GetLayerSettingData(layer_key, setting_key); @@ -370,7 +370,7 @@ VK_LAYER_EXPORT std::string GetLayerSettingString(const char *layer_key, const c return setting; } -VK_LAYER_EXPORT std::string GetLayerSettingFrames(const char *layer_key, const char *setting_key) { +std::string GetLayerSettingFrames(const char *layer_key, const char *setting_key) { assert(IsLayerSetting(layer_key, setting_key)); std::string setting = GetLayerSettingData(layer_key, setting_key); @@ -403,7 +403,7 @@ static inline std::vector Split(const std::string &value, const std return result; } -VK_LAYER_EXPORT Strings GetLayerSettingStrings(const char *layer_key, const char *setting_key) { +Strings GetLayerSettingStrings(const char *layer_key, const char *setting_key) { assert(IsLayerSetting(layer_key, setting_key)); std::string setting = GetLayerSettingData(layer_key, setting_key); @@ -419,7 +419,7 @@ VK_LAYER_EXPORT Strings GetLayerSettingStrings(const char *layer_key, const char } } -VK_LAYER_EXPORT List GetLayerSettingList(const char *layer_key, const char *setting_key) { +List GetLayerSettingList(const char *layer_key, const char *setting_key) { assert(IsLayerSetting(layer_key, setting_key)); std::vector inputs = GetLayerSettingStrings(layer_key, setting_key); diff --git a/vku/vk_layer_settings.h b/vku/vk_layer_settings.h index 57c6318b69..aa2890d24f 100644 --- a/vku/vk_layer_settings.h +++ b/vku/vk_layer_settings.h @@ -35,29 +35,29 @@ typedef void *(*LAYER_SETTING_LOG_CALLBACK)(const char *setting_key, const char // Initialize the callback function to get error messages. By default the error messages are outputed to stderr. Use nullptr to // return to the default behavior. -VK_LAYER_EXPORT void InitLayerSettingsLogCallback(LAYER_SETTING_LOG_CALLBACK callback); +void InitLayerSettingsLogCallback(LAYER_SETTING_LOG_CALLBACK callback); // Check whether a setting was set either from vk_layer_settings.txt or an environment variable -VK_LAYER_EXPORT bool IsLayerSetting(const char *layer_key, const char *setting_key); +bool IsLayerSetting(const char *layer_key, const char *setting_key); // Query setting data for BOOL setting type in the layer manifest -VK_LAYER_EXPORT bool GetLayerSettingBool(const char *layer_key, const char *setting_key); +bool GetLayerSettingBool(const char *layer_key, const char *setting_key); // Query setting data for INT setting type in the layer manifest -VK_LAYER_EXPORT int GetLayerSettingInt(const char *layer_key, const char *setting_key); +int GetLayerSettingInt(const char *layer_key, const char *setting_key); // Query setting data for FLOAT setting type in the layer manifest -VK_LAYER_EXPORT double GetLayerSettingFloat(const char *layer_key, const char *setting_key); +double GetLayerSettingFloat(const char *layer_key, const char *setting_key); // Query setting data for FRAMES setting type in the layer manifest -VK_LAYER_EXPORT std::string GetLayerSettingFrames(const char *layer_key, const char *setting_key); +std::string GetLayerSettingFrames(const char *layer_key, const char *setting_key); // Query setting data for STRING, ENUM, LOAD_FILE, SAVE_FILE and SAVE_FOLDER setting types in the layer manifest -VK_LAYER_EXPORT std::string GetLayerSettingString(const char *layer_key, const char *setting_key); +std::string GetLayerSettingString(const char *layer_key, const char *setting_key); // Query setting data for FLAGS setting type in the layer manifest -VK_LAYER_EXPORT Strings GetLayerSettingStrings(const char *layer_key, const char *setting_key); +Strings GetLayerSettingStrings(const char *layer_key, const char *setting_key); // Query setting data for LIST setting type in the layer manifest -VK_LAYER_EXPORT List GetLayerSettingList(const char *layer_key, const char *setting_key); +List GetLayerSettingList(const char *layer_key, const char *setting_key); } // namespace vku From 546ebccacad6b5967977edaccdd2c9c6e4838d8f Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Mon, 20 Feb 2023 11:44:34 -0700 Subject: [PATCH 057/154] apidump: Don't lock for functions that may block Originally API dump had no issues with blocking API calls, because it would only take the lock for printing after the function calls returned. But since the change to print the function name before calling down the chain (in case the function crashes) required printing, that meant the lock was taken before calling down the chain. If that function blocks then this stalls EVERY other API call from progressing, which may cause a dead lock. The solution is to manually specify the functions which may block and have those functions revert to the original behavior (not print before calling down). This prevents deadlocks by not holding the lock during blocking Vulkan function calls. --- layersvt/api_dump.h | 44 +++++++++++++++-- scripts/api_dump_generator.py | 90 ++++++++++------------------------- 2 files changed, 64 insertions(+), 70 deletions(-) diff --git a/layersvt/api_dump.h b/layersvt/api_dump.h index e6b76c44d7..ccfaa0964a 100644 --- a/layersvt/api_dump.h +++ b/layersvt/api_dump.h @@ -826,6 +826,19 @@ class ApiDumpInstance { return vk_instance_map.at(phys_dev); } + void update_object_name_map(const VkDebugMarkerObjectNameInfoEXT *pNameInfo) { + if (pNameInfo->pObjectName) + object_name_map.emplace(pNameInfo->object, pNameInfo->pObjectName); + else + object_name_map.erase(pNameInfo->object); + } + void update_object_name_map(const VkDebugUtilsObjectNameInfoEXT *pNameInfo) { + if (pNameInfo->pObjectName) + object_name_map.emplace(pNameInfo->objectHandle, pNameInfo->pObjectName); + else + object_name_map.erase(pNameInfo->objectHandle); + } + private: ApiDumpSettings dump_settings; std::recursive_mutex output_mutex; @@ -883,7 +896,8 @@ void OutputAddressJSON(const ApiDumpSettings &settings, const void *addr) { //==================================== Text Backend Helpers ======================================// -void dump_text_function_head(ApiDumpInstance &dump_inst, const char *funcName, const char *funcReturn) { +void dump_text_function_head(ApiDumpInstance &dump_inst, const char *funcName, const char *funcNamedParams, + const char *funcReturn) { const ApiDumpSettings &settings(dump_inst.settings()); if (settings.showThreadAndFrame()) { settings.stream() << "Thread " << dump_inst.threadID() << ", Frame " << dump_inst.frameCount(); @@ -897,7 +911,7 @@ void dump_text_function_head(ApiDumpInstance &dump_inst, const char *funcName, c if (settings.showTimestamp() || settings.showThreadAndFrame()) { settings.stream() << ":\n"; } - settings.stream() << funcName << " returns " << funcReturn; + settings.stream() << funcName << "(" << funcNamedParams << ") returns " << funcReturn; settings.shouldFlush() ? settings.stream() << std::flush : settings.stream(); } @@ -1017,7 +1031,8 @@ void dump_html_nametype(std::ostream &stream, bool showType, const char *name, c } } -void dump_html_function_head(ApiDumpInstance &dump_inst, const char *funcName, const char *funcReturn) { +void dump_html_function_head(ApiDumpInstance &dump_inst, const char *funcName, const char *funcNamedParams, + const char *funcReturn) { const ApiDumpSettings &settings(dump_inst.settings()); if (settings.showThreadAndFrame()) { settings.stream() << "
Thread: " << dump_inst.threadID() << "
"; @@ -1025,7 +1040,10 @@ void dump_html_function_head(ApiDumpInstance &dump_inst, const char *funcName, c if (settings.showTimestamp()) settings.stream() << "
Time: " << dump_inst.current_time_since_start().count() << " us
"; settings.stream() << "
"; - dump_html_nametype(settings.stream(), settings.showType(), funcName, funcReturn); + settings.stream() << "
" << funcName << "(" << funcNamedParams << ")
"; + if (settings.showType()) { + settings.stream() << "
" << funcReturn << "
"; + } settings.shouldFlush() ? settings.stream() << std::flush : settings.stream(); } @@ -1418,3 +1436,21 @@ void dump_json_pNext(const T *object, const ApiDumpSettings &settings, const cha dump_json_value(*object, object, settings, type_string, "pNext", indents, dump); } } + +//==================================== Common Helpers ======================================// + +void dump_function_head(ApiDumpInstance &dump_inst, const char *funcName, const char *funcNamedParams, const char *funcReturn) { + if (dump_inst.shouldDumpOutput()) { + switch (dump_inst.settings().format()) { + case ApiDumpFormat::Text: + dump_text_function_head(dump_inst, funcName, funcNamedParams, funcReturn); + break; + case ApiDumpFormat::Html: + dump_html_function_head(dump_inst, funcName, funcNamedParams, funcReturn); + break; + case ApiDumpFormat::Json: + dump_json_function_head(dump_inst, funcName, funcReturn); + break; + } + } +} diff --git a/scripts/api_dump_generator.py b/scripts/api_dump_generator.py index a6ecd5492f..c901e3ead6 100644 --- a/scripts/api_dump_generator.py +++ b/scripts/api_dump_generator.py @@ -17,6 +17,7 @@ # limitations under the License. # # Author: Lenny Komow +# Author: Charles Giessen # # The API dump layer works by passing custom format strings to the ApiDumpGenerator. These format # strings are C++ code, with 3-ish exceptions: @@ -46,6 +47,11 @@ from collections import namedtuple from common_codegen import * +BLOCKING_API_CALLS = [ + 'vkWaitForFences', 'vkWaitSemaphores', 'vkQueuePresentKHR', 'vkDeviceWaitIdle', + 'vkQueueWaitIdle', 'vkAcquireNextImageKHR', 'vkGetQueryPoolResults', +] + COMMON_CODEGEN = """ /* Copyright (c) 2015-2016, 2021 Valve Corporation * Copyright (c) 2015-2016, 2021 LunarG, Inc. @@ -89,20 +95,7 @@ VKAPI_ATTR VkResult VKAPI_CALL vkCreateInstance(const VkInstanceCreateInfo* pCreateInfo, const VkAllocationCallbacks* pAllocator, VkInstance* pInstance) {{ ApiDumpInstance::current().outputMutex()->lock(); - if (ApiDumpInstance::current().shouldDumpOutput()) {{ - switch(ApiDumpInstance::current().settings().format()) - {{ - case ApiDumpFormat::Text: - dump_text_function_head(ApiDumpInstance::current(), \"vkCreateInstance(pCreateInfo, pAllocator, pInstance)\", \"VkResult\"); - break; - case ApiDumpFormat::Html: - dump_html_function_head(ApiDumpInstance::current(), \"vkCreateInstance(pCreateInfo, pAllocator, pInstance)\", \"VkResult\"); - break; - case ApiDumpFormat::Json: - dump_json_function_head(ApiDumpInstance::current(), \"vkCreateInstance\", \"VkResult\"); - break; - }} - }} + dump_function_head(ApiDumpInstance::current(), "vkCreateInstance", "pCreateInfo, pAllocator, pInstance", "VkResult"); // Get the function pointer VkLayerInstanceCreateInfo* chain_info = get_chain_info(pCreateInfo, VK_LAYER_LINK_INFO); @@ -142,20 +135,8 @@ VKAPI_ATTR VkResult VKAPI_CALL vkCreateDevice(VkPhysicalDevice physicalDevice, const VkDeviceCreateInfo* pCreateInfo, const VkAllocationCallbacks* pAllocator, VkDevice* pDevice) {{ ApiDumpInstance::current().outputMutex()->lock(); - if (ApiDumpInstance::current().shouldDumpOutput()) {{ - switch(ApiDumpInstance::current().settings().format()) - {{ - case ApiDumpFormat::Text: - dump_text_function_head(ApiDumpInstance::current(), \"vkCreateDevice(physicalDevice, pCreateInfo, pAllocator, pDevice)\", \"VkResult\"); - break; - case ApiDumpFormat::Html: - dump_html_function_head(ApiDumpInstance::current(), \"vkCreateDevice(physicalDevice, pCreateInfo, pAllocator, pDevice)\", \"VkResult\"); - break; - case ApiDumpFormat::Json: - dump_json_function_head(ApiDumpInstance::current(), \"vkCreateDevice\", \"VkResult\"); - break; - }} - }} + dump_function_head(ApiDumpInstance::current(), "vkCreateDevice", "physicalDevice, pCreateInfo, pAllocator, pDevice", "VkResult"); + // Get the function pointer VkLayerDeviceCreateInfo* chain_info = get_chain_info(pCreateInfo, VK_LAYER_LINK_INFO); assert(chain_info->u.pLayerInfo != 0); @@ -231,21 +212,10 @@ @foreach function where('{funcDispatchType}' == 'instance' and '{funcName}' not in ['vkCreateInstance', 'vkCreateDevice', 'vkGetInstanceProcAddr', 'vkEnumerateDeviceExtensionProperties', 'vkEnumerateDeviceLayerProperties']) VKAPI_ATTR {funcReturn} VKAPI_CALL {funcName}({funcTypedParams}) {{ + @if('{funcName}' not in BLOCKING_API_CALLS) ApiDumpInstance::current().outputMutex()->lock(); - if (ApiDumpInstance::current().shouldDumpOutput()) {{ - switch(ApiDumpInstance::current().settings().format()) - {{ - case ApiDumpFormat::Text: - dump_text_function_head(ApiDumpInstance::current(), \"{funcName}({funcNamedParams})\", \"{funcReturn}\"); - break; - case ApiDumpFormat::Html: - dump_html_function_head(ApiDumpInstance::current(), \"{funcName}({funcNamedParams})\", \"{funcReturn}\"); - break; - case ApiDumpFormat::Json: - dump_json_function_head(ApiDumpInstance::current(), \"{funcName}\", \"{funcReturn}\"); - break; - }} - }} + dump_function_head(ApiDumpInstance::current(), "{funcName}", "{funcNamedParams}", "{funcReturn}"); + @end if @if('{funcName}' == 'vkGetPhysicalDeviceToolPropertiesEXT') static const VkPhysicalDeviceToolPropertiesEXT api_dump_layer_tool_props = {{ @@ -271,6 +241,10 @@ @if('{funcReturn}' == 'void') instance_dispatch_table({funcDispatchParam})->{funcShortName}({funcNamedParams}); @end if + @if('{funcName}' in BLOCKING_API_CALLS) + ApiDumpInstance::current().outputMutex()->lock(); + dump_function_head(ApiDumpInstance::current(), "{funcName}", "{funcNamedParams}", "{funcReturn}"); + @end if {funcStateTrackingCode} @if('{funcName}' == 'vkEnumeratePhysicalDevices') if (pPhysicalDeviceCount != nullptr && pPhysicalDevices != nullptr) {{ @@ -330,33 +304,13 @@ @foreach function where('{funcDispatchType}' == 'device' and '{funcName}' not in ['vkGetDeviceProcAddr']) VKAPI_ATTR {funcReturn} VKAPI_CALL {funcName}({funcTypedParams}) {{ + @if('{funcName}' not in BLOCKING_API_CALLS) ApiDumpInstance::current().outputMutex()->lock(); - @if('{funcName}' == 'vkDebugMarkerSetObjectNameEXT') - if (pNameInfo->pObjectName) - ApiDumpInstance::current().object_name_map.insert(std::make_pair((uint64_t &&)pNameInfo->object, pNameInfo->pObjectName)); - else - ApiDumpInstance::current().object_name_map.erase(pNameInfo->object); + @if('{funcName}' in ['vkDebugMarkerSetObjectNameEXT', 'vkSetDebugUtilsObjectNameEXT']) + ApiDumpInstance::current().update_object_name_map(pNameInfo); @end if - @if('{funcName}' == 'vkSetDebugUtilsObjectNameEXT') - if (pNameInfo->pObjectName) - ApiDumpInstance::current().object_name_map.insert(std::make_pair((uint64_t &&)pNameInfo->objectHandle, pNameInfo->pObjectName)); - else - ApiDumpInstance::current().object_name_map.erase(pNameInfo->objectHandle); + dump_function_head(ApiDumpInstance::current(), "{funcName}", "{funcNamedParams}", "{funcReturn}"); @end if - if (ApiDumpInstance::current().shouldDumpOutput()) {{ - switch(ApiDumpInstance::current().settings().format()) - {{ - case ApiDumpFormat::Text: - dump_text_function_head(ApiDumpInstance::current(), \"{funcName}({funcNamedParams})\", \"{funcReturn}\"); - break; - case ApiDumpFormat::Html: - dump_html_function_head(ApiDumpInstance::current(), \"{funcName}({funcNamedParams})\", \"{funcReturn}\"); - break; - case ApiDumpFormat::Json: - dump_json_function_head(ApiDumpInstance::current(), \"{funcName}\", \"{funcReturn}\"); - break; - }} - }} @if('{funcReturn}' != 'void') {funcReturn} result = device_dispatch_table({funcDispatchParam})->{funcShortName}({funcNamedParams}); @@ -364,6 +318,10 @@ @if('{funcReturn}' == 'void') device_dispatch_table({funcDispatchParam})->{funcShortName}({funcNamedParams}); @end if + @if('{funcName}' in BLOCKING_API_CALLS) + ApiDumpInstance::current().outputMutex()->lock(); + dump_function_head(ApiDumpInstance::current(), "{funcName}", "{funcNamedParams}", "{funcReturn}"); + @end if {funcStateTrackingCode} @if('{funcName}' == 'vkDestroyDevice') destroy_device_dispatch_table(get_dispatch_key(device)); From 8ab10687b3358fb84acf3538e673d6a216561bd6 Mon Sep 17 00:00:00 2001 From: Tony-LunarG Date: Wed, 22 Feb 2023 13:48:39 -0700 Subject: [PATCH 058/154] build: Update to 1.3.241 headers --- CMakeLists.txt | 1 + build-android/cmake/layerlib/CMakeLists.txt | 4 ++-- build-android/vulkan-headers_revision_android | 2 +- build-android/vulkan-tools_revision_android | 2 +- .../vulkan-validationlayers_revision_android | 2 +- layer_factory/CMakeLists.txt | 2 +- scripts/known_good.json | 8 ++++---- scripts/layer_factory_generator.py | 11 +++++------ scripts/vlf_makefile_generator.py | 3 ++- 9 files changed, 18 insertions(+), 17 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 2ab5e1094e..9ff7b1251e 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -10,6 +10,7 @@ set(API_NAME "Vulkan" CACHE STRING "API name") add_definitions(-DAPI_NAME="${API_NAME}") add_definitions(-DVK_ENABLE_BETA_EXTENSIONS) +add_definitions(-DXXH_NO_LONG_LONG) set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_CURRENT_SOURCE_DIR}/cmake") diff --git a/build-android/cmake/layerlib/CMakeLists.txt b/build-android/cmake/layerlib/CMakeLists.txt index 9120706da6..46eb9ce5ad 100644 --- a/build-android/cmake/layerlib/CMakeLists.txt +++ b/build-android/cmake/layerlib/CMakeLists.txt @@ -50,7 +50,7 @@ add_library(VkLayer_core_validation SHARED ${SRC_DIR}/layers/descriptor_sets.cpp ${SRC_DIR}/layers/buffer_validation.cpp ${SRC_DIR}/layers/shader_validation.cpp - ${SRC_DIR}/layers/xxhash.c) + ${SRC_DIR}/layers/xxhash.cpp) target_include_directories(VkLayer_core_validation PRIVATE ${SRC_DIR}/include ${SRC_DIR}/layers @@ -58,7 +58,7 @@ target_include_directories(VkLayer_core_validation PRIVATE ${SRC_DIR}/loader) target_link_libraries(VkLayer_core_validation PRIVATE log layer_utils) - +target_compile_definitions(VkLayer_core_validation PUBLIC XXH_NO_LONG_LONG) add_library(VkLayer_parameter_validation SHARED ${COMMON_DIR}/include/parameter_validation.cpp ${SRC_DIR}/layers/parameter_validation_utils.cpp) diff --git a/build-android/vulkan-headers_revision_android b/build-android/vulkan-headers_revision_android index 67d338f60d..bbc54d8553 100644 --- a/build-android/vulkan-headers_revision_android +++ b/build-android/vulkan-headers_revision_android @@ -1 +1 @@ -v1.3.239 +v1.3.241 diff --git a/build-android/vulkan-tools_revision_android b/build-android/vulkan-tools_revision_android index 67d338f60d..bbc54d8553 100644 --- a/build-android/vulkan-tools_revision_android +++ b/build-android/vulkan-tools_revision_android @@ -1 +1 @@ -v1.3.239 +v1.3.241 diff --git a/build-android/vulkan-validationlayers_revision_android b/build-android/vulkan-validationlayers_revision_android index 67d338f60d..bbc54d8553 100644 --- a/build-android/vulkan-validationlayers_revision_android +++ b/build-android/vulkan-validationlayers_revision_android @@ -1 +1 @@ -v1.3.239 +v1.3.241 diff --git a/layer_factory/CMakeLists.txt b/layer_factory/CMakeLists.txt index 7f49fa0394..8c7c9d0d2a 100644 --- a/layer_factory/CMakeLists.txt +++ b/layer_factory/CMakeLists.txt @@ -167,7 +167,7 @@ SUBDIRLIST(ST_SUBDIRS ${CMAKE_LAYER_FACTORY_SOURCE_DIR}) set(dep_chain generate_vlf) FOREACH(subdir ${ST_SUBDIRS}) file(GLOB INTERCEPTOR_SOURCES ${CMAKE_LAYER_FACTORY_SOURCE_DIR}/${subdir}/*.h ${CMAKE_LAYER_FACTORY_SOURCE_DIR}/${subdir}/*.cpp) - add_factory_layer(${subdir} ${CMAKE_LAYER_FACTORY_SOURCE_DIR}/${subdir} layer_factory.cpp layer_factory.h ${Vulkan-ValidationLayers_INCLUDE_DIR}/xxhash.c ${INTERCEPTOR_SOURCES}) + add_factory_layer(${subdir} ${CMAKE_LAYER_FACTORY_SOURCE_DIR}/${subdir} layer_factory.cpp layer_factory.h ${Vulkan-ValidationLayers_INCLUDE_DIR}/xxhash.cpp ${INTERCEPTOR_SOURCES}) add_dependencies(VkLayer_${subdir} ${dep_chain}) set(dep_chain VkLayer_${subdir}) set_target_properties(VkLayer_${subdir} PROPERTIES diff --git a/scripts/known_good.json b/scripts/known_good.json index a8657f4f35..9bdfb2191b 100644 --- a/scripts/known_good.json +++ b/scripts/known_good.json @@ -6,7 +6,7 @@ "sub_dir" : "Vulkan-Headers", "build_dir" : "Vulkan-Headers/build", "install_dir" : "Vulkan-Headers/build/install", - "commit": "v1.3.239" + "commit": "v1.3.241" }, { "name" : "Vulkan-Loader", @@ -14,7 +14,7 @@ "sub_dir" : "Vulkan-Loader", "build_dir" : "Vulkan-Loader/build", "install_dir" : "Vulkan-Loader/build/install", - "commit": "v1.3.239", + "commit": "v1.3.241", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", @@ -35,7 +35,7 @@ "sub_dir" : "Vulkan-Tools", "build_dir" : "Vulkan-Tools/build", "install_dir" : "Vulkan-Tools/build/install", - "commit": "v1.3.239", + "commit": "v1.3.241", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", @@ -60,7 +60,7 @@ "sub_dir" : "Vulkan-ValidationLayers", "build_dir" : "Vulkan-ValidationLayers/build", "install_dir" : "Vulkan-ValidationLayers/build/install", - "commit": "v1.3.239", + "commit": "v1.3.241", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", diff --git a/scripts/layer_factory_generator.py b/scripts/layer_factory_generator.py index 8a51dbcc90..ca8ea99d33 100644 --- a/scripts/layer_factory_generator.py +++ b/scripts/layer_factory_generator.py @@ -320,8 +320,7 @@ class layer_factory; layer_init_instance_dispatch_table(*pInstance, &instance_data->dispatch_table, fpGetInstanceProcAddr); instance_data->report_data = new debug_report_data{}; instance_data->extensions.InitFromInstanceCreateInfo((pCreateInfo->pApplicationInfo ? pCreateInfo->pApplicationInfo->apiVersion : VK_API_VERSION_1_0), pCreateInfo); - layer_debug_report_actions(instance_data->report_data, pAllocator, "lunarg_layer_factory"); - layer_debug_messenger_actions(instance_data->report_data, pAllocator, "lunarg_layer_factory"); + layer_debug_messenger_actions(instance_data->report_data, "lunarg_layer_factory"); vlf_report_data = instance_data->report_data; for (auto intercept : global_interceptor_list) { @@ -347,12 +346,12 @@ class layer_factory; // Clean up logging callback, if any while (instance_data->logging_messenger.size() > 0) { VkDebugUtilsMessengerEXT messenger = instance_data->logging_messenger.back(); - LayerDestroyCallback(instance_data->report_data, messenger, pAllocator); + LayerDestroyCallback(instance_data->report_data, messenger); instance_data->logging_messenger.pop_back(); } while (instance_data->logging_callback.size() > 0) { VkDebugReportCallbackEXT callback = instance_data->logging_callback.back(); - LayerDestroyCallback(instance_data->report_data, callback, pAllocator); + LayerDestroyCallback(instance_data->report_data, callback); instance_data->logging_callback.pop_back(); } LayerDebugUtilsDestroyInstance(instance_data->report_data); @@ -424,7 +423,7 @@ class layer_factory; intercept->PreCallCreateDebugReportCallbackEXT(instance, pCreateInfo, pAllocator, pCallback); } VkResult result = instance_data->dispatch_table.CreateDebugReportCallbackEXT(instance, pCreateInfo, pAllocator, pCallback); - result = LayerCreateReportCallback(instance_data->report_data, false, pCreateInfo, pAllocator, pCallback); + result = LayerCreateReportCallback(instance_data->report_data, false, pCreateInfo, pCallback); for (auto intercept : global_interceptor_list) { intercept->PostCallCreateDebugReportCallbackEXT(instance, pCreateInfo, pAllocator, pCallback, result); } @@ -438,7 +437,7 @@ class layer_factory; intercept->PreCallDestroyDebugReportCallbackEXT(instance, callback, pAllocator); } instance_data->dispatch_table.DestroyDebugReportCallbackEXT(instance, callback, pAllocator); - LayerDestroyCallback(instance_data->report_data, callback, pAllocator); + LayerDestroyCallback(instance_data->report_data, callback); for (auto intercept : global_interceptor_list) { intercept->PostCallDestroyDebugReportCallbackEXT(instance, callback, pAllocator); } diff --git a/scripts/vlf_makefile_generator.py b/scripts/vlf_makefile_generator.py index 0c6f20e9d1..5b9b2e9b2f 100644 --- a/scripts/vlf_makefile_generator.py +++ b/scripts/vlf_makefile_generator.py @@ -76,7 +76,7 @@ contents += 'include $(CLEAR_VARS)\n' contents += 'LOCAL_MODULE := VkLayer_%s\n' % factory_layer contents += 'LOCAL_SRC_FILES += $(LAYER_DIR)/include/layer_factory.cpp\n' - contents += 'LOCAL_SRC_FILES += $(LVL_DIR)/layers/xxhash.c\n' + contents += 'LOCAL_SRC_FILES += $(LVL_DIR)/layers/xxhash.cpp\n' # Add *.cpp files (if any) to makefile dependencies for path, subdirs, files in os.walk(factory_layer): for file in files: @@ -91,6 +91,7 @@ contents += 'LOCAL_STATIC_LIBRARIES += layer_utils\n' contents += 'LOCAL_CPPFLAGS += -std=c++17 -DVK_PROTOTYPES -Wall -Werror -Wno-unused-function -Wno-unused-const-variable\n' contents += 'LOCAL_CPPFLAGS += -DVK_USE_PLATFORM_ANDROID_KHR -DVK_ENABLE_BETA_EXTENSIONS -fvisibility=hidden\n' + contents += 'LOCAL_CPPFLAGS += -DXXH_NO_LONG_LONG\n' contents += 'LOCAL_LDLIBS := -llog\n' contents += 'LOCAL_LDFLAGS += -Wl,-Bsymbolic\n' contents += 'LOCAL_LDFLAGS += -Wl,--exclude-libs,ALL\n' From 956fd012dcfc6c3f7384539b500305b030feb66a Mon Sep 17 00:00:00 2001 From: Tony-LunarG Date: Fri, 24 Feb 2023 11:53:07 -0700 Subject: [PATCH 059/154] build: Remove xxhash dependency from layer factory --- CMakeLists.txt | 1 - layer_factory/CMakeLists.txt | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 9ff7b1251e..2ab5e1094e 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -10,7 +10,6 @@ set(API_NAME "Vulkan" CACHE STRING "API name") add_definitions(-DAPI_NAME="${API_NAME}") add_definitions(-DVK_ENABLE_BETA_EXTENSIONS) -add_definitions(-DXXH_NO_LONG_LONG) set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_CURRENT_SOURCE_DIR}/cmake") diff --git a/layer_factory/CMakeLists.txt b/layer_factory/CMakeLists.txt index 8c7c9d0d2a..6eff5674fa 100644 --- a/layer_factory/CMakeLists.txt +++ b/layer_factory/CMakeLists.txt @@ -167,7 +167,7 @@ SUBDIRLIST(ST_SUBDIRS ${CMAKE_LAYER_FACTORY_SOURCE_DIR}) set(dep_chain generate_vlf) FOREACH(subdir ${ST_SUBDIRS}) file(GLOB INTERCEPTOR_SOURCES ${CMAKE_LAYER_FACTORY_SOURCE_DIR}/${subdir}/*.h ${CMAKE_LAYER_FACTORY_SOURCE_DIR}/${subdir}/*.cpp) - add_factory_layer(${subdir} ${CMAKE_LAYER_FACTORY_SOURCE_DIR}/${subdir} layer_factory.cpp layer_factory.h ${Vulkan-ValidationLayers_INCLUDE_DIR}/xxhash.cpp ${INTERCEPTOR_SOURCES}) + add_factory_layer(${subdir} ${CMAKE_LAYER_FACTORY_SOURCE_DIR}/${subdir} layer_factory.cpp layer_factory.h ${INTERCEPTOR_SOURCES}) add_dependencies(VkLayer_${subdir} ${dep_chain}) set(dep_chain VkLayer_${subdir}) set_target_properties(VkLayer_${subdir} PROPERTIES From 3d80135e3e2991e6d92a3df3bdeaddbadc354217 Mon Sep 17 00:00:00 2001 From: Tony-LunarG Date: Tue, 14 Mar 2023 11:10:45 -0600 Subject: [PATCH 060/154] build: Update to 1.3.243 headers --- build-android/vulkan-headers_revision_android | 2 +- build-android/vulkan-tools_revision_android | 2 +- build-android/vulkan-validationlayers_revision_android | 2 +- scripts/known_good.json | 8 ++++---- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/build-android/vulkan-headers_revision_android b/build-android/vulkan-headers_revision_android index bbc54d8553..916242a8aa 100644 --- a/build-android/vulkan-headers_revision_android +++ b/build-android/vulkan-headers_revision_android @@ -1 +1 @@ -v1.3.241 +v1.3.243 diff --git a/build-android/vulkan-tools_revision_android b/build-android/vulkan-tools_revision_android index bbc54d8553..916242a8aa 100644 --- a/build-android/vulkan-tools_revision_android +++ b/build-android/vulkan-tools_revision_android @@ -1 +1 @@ -v1.3.241 +v1.3.243 diff --git a/build-android/vulkan-validationlayers_revision_android b/build-android/vulkan-validationlayers_revision_android index bbc54d8553..506e28f7dd 100644 --- a/build-android/vulkan-validationlayers_revision_android +++ b/build-android/vulkan-validationlayers_revision_android @@ -1 +1 @@ -v1.3.241 +v1.3.243 \ No newline at end of file diff --git a/scripts/known_good.json b/scripts/known_good.json index 9bdfb2191b..577ec90e70 100644 --- a/scripts/known_good.json +++ b/scripts/known_good.json @@ -6,7 +6,7 @@ "sub_dir" : "Vulkan-Headers", "build_dir" : "Vulkan-Headers/build", "install_dir" : "Vulkan-Headers/build/install", - "commit": "v1.3.241" + "commit": "v1.3.243" }, { "name" : "Vulkan-Loader", @@ -14,7 +14,7 @@ "sub_dir" : "Vulkan-Loader", "build_dir" : "Vulkan-Loader/build", "install_dir" : "Vulkan-Loader/build/install", - "commit": "v1.3.241", + "commit": "v1.3.243", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", @@ -35,7 +35,7 @@ "sub_dir" : "Vulkan-Tools", "build_dir" : "Vulkan-Tools/build", "install_dir" : "Vulkan-Tools/build/install", - "commit": "v1.3.241", + "commit": "v1.3.243", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", @@ -60,7 +60,7 @@ "sub_dir" : "Vulkan-ValidationLayers", "build_dir" : "Vulkan-ValidationLayers/build", "install_dir" : "Vulkan-ValidationLayers/build/install", - "commit": "v1.3.241", + "commit": "v1.3.243", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", From 61a4bff820453484ef72d6e436e6c511869d5c84 Mon Sep 17 00:00:00 2001 From: Christophe Date: Tue, 14 Mar 2023 20:37:41 +0100 Subject: [PATCH 061/154] vkconfig: fix validation layer with generic layer settings Change-Id: I650d507463695f71ad11096392aab7b3c9aeacb6 --- vkconfig/settings_tree.cpp | 19 +++++++++++-------- vkconfig_core/configuration.cpp | 1 + vkconfig_core/parameter.cpp | 1 + vkconfig_core/parameter.h | 10 ++++++++-- 4 files changed, 21 insertions(+), 10 deletions(-) diff --git a/vkconfig/settings_tree.cpp b/vkconfig/settings_tree.cpp index 86bdc42537..2851e69152 100644 --- a/vkconfig/settings_tree.cpp +++ b/vkconfig/settings_tree.cpp @@ -293,14 +293,17 @@ static bool IsBuiltinValidationSetting(const Parameter ¶meter, const std::st std::vector keys; keys.push_back("enables"); keys.push_back("disables"); - keys.push_back("printf_to_stdout"); - keys.push_back("printf_verbose"); - keys.push_back("printf_buffer_size"); - keys.push_back("gpuav_buffer_oob"); - keys.push_back("warn_on_robust_oob"); - keys.push_back("validate_draw_indirect"); - keys.push_back("vma_linear_output"); - keys.push_back("fine_grained_locking"); + + if (parameter.api_version.GetPatch() < 242) { + keys.push_back("printf_to_stdout"); + keys.push_back("printf_verbose"); + keys.push_back("printf_buffer_size"); + keys.push_back("gpuav_buffer_oob"); + keys.push_back("warn_on_robust_oob"); + keys.push_back("validate_draw_indirect"); + keys.push_back("vma_linear_output"); + keys.push_back("fine_grained_locking"); + } return IsStringFound(keys, key); } diff --git a/vkconfig_core/configuration.cpp b/vkconfig_core/configuration.cpp index 7b4742d1b6..ea3110bea6 100644 --- a/vkconfig_core/configuration.cpp +++ b/vkconfig_core/configuration.cpp @@ -104,6 +104,7 @@ bool Configuration::Load2_2(const std::vector& available_layers, const QJ const Layer* layer = FindByKey(available_layers, parameter.key.c_str()); if (layer != nullptr) { + parameter.api_version = layer->api_version; CollectDefaultSettingData(layer->settings, parameter.settings); } diff --git a/vkconfig_core/parameter.cpp b/vkconfig_core/parameter.cpp index 59182042fe..5a052e82ab 100644 --- a/vkconfig_core/parameter.cpp +++ b/vkconfig_core/parameter.cpp @@ -215,6 +215,7 @@ std::vector GatherParameters(const std::vector& parameters Parameter parameter; parameter.key = layer.key; parameter.state = LAYER_STATE_APPLICATION_CONTROLLED; + parameter.api_version = layer.api_version; CollectDefaultSettingData(layer.settings, parameter.settings); gathered_parameters.push_back(parameter); diff --git a/vkconfig_core/parameter.h b/vkconfig_core/parameter.h index 95028bffbb..c965765541 100644 --- a/vkconfig_core/parameter.h +++ b/vkconfig_core/parameter.h @@ -38,9 +38,14 @@ enum ParameterRank { struct Parameter { static const int NO_RANK = -1; - Parameter() : state(LAYER_STATE_APPLICATION_CONTROLLED), platform_flags(PLATFORM_DESKTOP_BIT), overridden_rank(NO_RANK) {} + Parameter() : state(LAYER_STATE_APPLICATION_CONTROLLED), platform_flags(PLATFORM_DESKTOP_BIT), overridden_rank(NO_RANK) { + assert(true); + } + Parameter(const std::string& key, const LayerState state) - : key(key), state(state), platform_flags(PLATFORM_DESKTOP_BIT), overridden_rank(NO_RANK) {} + : key(key), state(state), platform_flags(PLATFORM_DESKTOP_BIT), overridden_rank(NO_RANK) { + assert(true); + } bool ApplyPresetSettings(const LayerPreset& preset); @@ -49,6 +54,7 @@ struct Parameter { int platform_flags; SettingDataSet settings; int overridden_rank; + Version api_version; }; ParameterRank GetParameterOrdering(const std::vector& available_layers, const Parameter& parameter); From 621e34afde6220e7c8d1a1128a430cec08fdc8ba Mon Sep 17 00:00:00 2001 From: Christophe Date: Wed, 15 Mar 2023 15:08:36 +0100 Subject: [PATCH 062/154] vkconfig: updated version Change-Id: I93d129acc53427a02649481582d4397921b233b0 --- vkconfig/CHANGELOG.md | 7 ++++++- vkconfig_core/version.cpp | 2 +- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/vkconfig/CHANGELOG.md b/vkconfig/CHANGELOG.md index 7a0dbc6677..80ee3acfdf 100644 --- a/vkconfig/CHANGELOG.md +++ b/vkconfig/CHANGELOG.md @@ -11,7 +11,12 @@ # Release notes -## [Vulkan Configurator 2.5.2](https://github.com/LunarG/VulkanTools/tree/main) - December 2022 +## [Vulkan Configurator 2.5.3](https://github.com/LunarG/VulkanTools/tree/main) - March 2023 + +### Improvements: +- Enabling fully generic layer settings for the validation layer settings + +## [Vulkan Configurator 2.5.2](https://github.com/LunarG/VulkanTools/tree/sdk-1.3.236.0) - December 2022 ### Improvements: - Add `warn_on_robust_oob` validation layer setting handling diff --git a/vkconfig_core/version.cpp b/vkconfig_core/version.cpp index 997b89fe56..69c3c2ac42 100644 --- a/vkconfig_core/version.cpp +++ b/vkconfig_core/version.cpp @@ -28,7 +28,7 @@ #include #include -const Version Version::VKCONFIG(2, 5, 2); +const Version Version::VKCONFIG(2, 5, 3); const Version Version::LAYER_CONFIG(2, 2, 3); #ifdef VK_HEADER_VERSION_COMPLETE const Version Version::VKHEADER(VK_HEADER_VERSION_COMPLETE); From c6041f49bcd50c65641d23ed25837275ff297cbf Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Fri, 10 Feb 2023 13:40:52 -0700 Subject: [PATCH 063/154] apidump: Support Video Extensions This commit enables API Dump support of the Vulkan Video extensions. The mechanism requires generating 3 new headers, one for each output type of API Dump using the video.xml as the source. Because vk.xml and video.xml use the same schema, most of the generation code works perfectly. A few things needed tweaking, mainly due to duplicate definitions from both xml's providing definitions for the same types (like uint32_t). This commit also modifies the CMake code that handles API Dump to be a little bit cleaner by centralizing calls to add_dependencies and removing unnecessary if blocks. --- CMakeLists.txt | 20 ++++--- build-android/android-generate.bat | 17 ++++-- build-android/android-generate.sh | 15 +++-- layersvt/CMakeLists.txt | 28 ++++----- layersvt/api_dump.h | 9 +++ scripts/api_dump_generator.py | 85 +++++++++++++++++++--------- scripts/vt_genvk.py | 91 ++++++++++++++++++++++++++++++ 7 files changed, 209 insertions(+), 56 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 2ab5e1094e..2bb4514cde 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -213,15 +213,21 @@ if (WIN32) IMPORTED_LOCATION_DEBUG "${JSONCPP_DLIB}") endif() -# Define macro used for building vkxml generated files -macro(run_vulkantools_vk_xml_generate dependency output) +# Define macro used for building vk.xml generated files +function(run_vulkantools_vk_xml_generate dependency output) add_custom_command(OUTPUT ${output} - COMMAND ${PYTHON_CMD} -B ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py -registry ${VULKAN_HEADERS_REGISTRY_DIRECTORY}/vk.xml -scripts ${VULKAN_HEADERS_REGISTRY_DIRECTORY} ${output} - -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_KHR_video_decode_h264 - -removeExtensions VK_KHR_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 - DEPENDS ${VULKAN_HEADERS_REGISTRY_DIRECTORY}/vk.xml ${VULKAN_HEADERS_REGISTRY_DIRECTORY}/generator.py ${VULKANTOOLS_SCRIPTS_DIR}/${dependency} ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py ${VULKAN_HEADERS_REGISTRY_DIRECTORY}/reg.py + COMMAND ${PYTHON_CMD} -B ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py -registry ${VULKAN_HEADERS_REGISTRY_DIRECTORY}/vk.xml -scripts ${VULKAN_HEADERS_REGISTRY_DIRECTORY} ${output} + DEPENDS ${VULKAN_HEADERS_REGISTRY_DIRECTORY}/vk.xml ${VULKAN_HEADERS_REGISTRY_DIRECTORY}/generator.py ${VULKANTOOLS_SCRIPTS_DIR}/${dependency} ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py ${VULKAN_HEADERS_REGISTRY_DIRECTORY}/reg.py ) -endmacro() +endfunction() + +# Define macro used for building video.xml generated files +function(run_vulkantools_video_xml_generate dependency output) + add_custom_command(OUTPUT ${output} + COMMAND ${PYTHON_CMD} -B ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py -registry ${VULKAN_HEADERS_REGISTRY_DIRECTORY}/video.xml -scripts ${VULKAN_HEADERS_REGISTRY_DIRECTORY} ${output} + DEPENDS ${VULKAN_HEADERS_REGISTRY_DIRECTORY}/video.xml ${VULKAN_HEADERS_REGISTRY_DIRECTORY}/generator.py ${VULKANTOOLS_SCRIPTS_DIR}/${dependency} ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py ${VULKAN_HEADERS_REGISTRY_DIRECTORY}/reg.py + ) +endfunction() if(BUILD_TESTS) add_subdirectory(tests) diff --git a/build-android/android-generate.bat b/build-android/android-generate.bat index c4929aac56..86b304cb77 100644 --- a/build-android/android-generate.bat +++ b/build-android/android-generate.bat @@ -34,6 +34,7 @@ set LVL_SCRIPTS=%LVL_BASE%\scripts set VT_SCRIPTS=..\..\..\scripts set REGISTRY_PATH=%~dp0\third_party\Vulkan-Headers\registry set REGISTRY=%REGISTRY_PATH%\vk.xml +set VIDEO_REGISTRY=%REGISTRY_PATH%\video.xml echo Entering Generated/Include Folder echo ******** @@ -49,11 +50,17 @@ py -3 %VT_SCRIPTS%\vlf_makefile_generator.py ..\..\..\layer_factory %REGISTRY_PA REM apidump echo Generating VT apidump header/source files echo ******** -py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% api_dump.cpp -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_KHR_video_decode_h264 -removeExtensions VK_KHR_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 -py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% api_dump_text.h -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_KHR_video_decode_h264 -removeExtensions VK_KHR_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 -py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% api_dump_html.h -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_KHR_video_decode_h264 -removeExtensions VK_KHR_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 -py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% api_dump_json.h -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_KHR_video_decode_h264 -removeExtensions VK_KHR_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265 - +py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% api_dump.cpp +py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% api_dump_text.h +py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% api_dump_html.h +py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% api_dump_json.h + + +py -3 %VT_SCRIPTS%\vt_genvk.py -registry %VIDEO_REGISTRY% -scripts %REGISTRY_PATH% api_dump_video_text.h +py -3 %VT_SCRIPTS%\vt_genvk.py -registry %VIDEO_REGISTRY% -scripts %REGISTRY_PATH% api_dump_video_html.h +py -3 %VT_SCRIPTS%\vt_genvk.py -registry %VIDEO_REGISTRY% -scripts %REGISTRY_PATH% api_dump_video_json.h + + REM Copy over the built source files to LVL. Otherwise, REM cube won't build. echo Entering third_party\Vulkan-ValidationLayers\build-android diff --git a/build-android/android-generate.sh b/build-android/android-generate.sh index e73dd5fc7a..29471e0f14 100755 --- a/build-android/android-generate.sh +++ b/build-android/android-generate.sh @@ -27,6 +27,7 @@ LVL_GENERATED=${LVL_BASE}/layers/generated VT_SCRIPTS=../../../scripts REGISTRY_PATH=$dir/third_party/Vulkan-Headers/registry REGISTRY=${REGISTRY_PATH}/vk.xml +VIDEO_REGISTRY=${REGISTRY_PATH}/video.xml # Check for python 3.6 or greater PYTHON_EXECUTABLE=python3 @@ -49,11 +50,15 @@ echo "Using python: $(which $PYTHON_EXECUTABLE)" ( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vlf_makefile_generator.py ../../../layer_factory ${REGISTRY_PATH}/../include) # apidump -( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump.cpp -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_KHR_video_decode_h264 -removeExtensions VK_KHR_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265) -( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_text.h -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_KHR_video_decode_h264 -removeExtensions VK_KHR_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265) -( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_html.h -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_KHR_video_decode_h264 -removeExtensions VK_KHR_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265) -( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_json.h -removeExtensions VK_KHR_video_queue -removeExtensions VK_KHR_video_decode_queue -removeExtensions VK_KHR_video_encode_queue -removeExtensions VK_KHR_video_decode_h264 -removeExtensions VK_KHR_video_decode_h265 -removeExtensions VK_EXT_video_encode_h264 -removeExtensions VK_EXT_video_encode_h265) - +( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump.cpp) +( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_text.h) +( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_html.h) +( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_json.h) + +( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${VIDEO_REGISTRY} -scripts ${REGISTRY_PATH} api_dump_video_text.h) +( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${VIDEO_REGISTRY} -scripts ${REGISTRY_PATH} api_dump_video_html.h) +( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${VIDEO_REGISTRY} -scripts ${REGISTRY_PATH} api_dump_video_json.h) + ( pushd ${LVL_BASE}/build-android; rm -rf generated; mkdir -p generated/include generated/common; popd ) ( cd generated/include; cp -rf * ${LVL_BASE}/build-android/generated/include ) diff --git a/layersvt/CMakeLists.txt b/layersvt/CMakeLists.txt index 61a48f9f7b..85b1609b06 100644 --- a/layersvt/CMakeLists.txt +++ b/layersvt/CMakeLists.txt @@ -44,11 +44,16 @@ add_definitions(-DVK_ENABLE_BETA_EXTENSIONS) if (BUILD_APIDUMP) add_custom_target( generate_api_cpp DEPENDS api_dump.cpp ) - add_custom_target( generate_api_h DEPENDS api_dump_text.h ) + add_custom_target( generate_api_text_h DEPENDS api_dump_text.h ) add_custom_target( generate_api_html_h DEPENDS api_dump_html.h ) - set_target_properties(generate_api_cpp generate_api_h generate_api_html_h PROPERTIES FOLDER ${VULKANTOOLS_TARGET_FOLDER}) add_custom_target( generate_api_json_h DEPENDS api_dump_json.h ) - set_target_properties(generate_api_cpp generate_api_h generate_api_json_h PROPERTIES FOLDER ${VULKANTOOLS_TARGET_FOLDER}) + add_custom_target( generate_api_video_text_h DEPENDS api_dump_video_text.h ) + add_custom_target( generate_api_video_html_h DEPENDS api_dump_video_html.h ) + add_custom_target( generate_api_video_json_h DEPENDS api_dump_video_json.h ) + + set_target_properties(generate_api_cpp generate_api_text_h generate_api_html_h generate_api_json_h + generate_api_video_text_h generate_api_video_html_h generate_api_video_json_h + PROPERTIES FOLDER ${VULKANTOOLS_TARGET_FOLDER}) endif() if (NOT APPLE) @@ -84,18 +89,12 @@ if (WIN32) CXX_STANDARD_REQUIRED ON CXX_EXTENSIONS OFF ) - if(BUILD_APIDUMP) - add_dependencies(VkLayer_${target} generate_api_cpp generate_api_h generate_api_html_h) - add_dependencies(VkLayer_${target} generate_api_cpp generate_api_h generate_api_json_h) - endif() set_target_properties(copy-${target}-def-file PROPERTIES FOLDER ${VULKANTOOLS_TARGET_FOLDER}) endmacro() else() macro(add_vk_layer target) add_library(VkLayer_${target} SHARED ${ARGN}) target_link_Libraries(VkLayer_${target} Vulkan::Headers ${VkLayer_utils_LIBRARY}) - add_dependencies(VkLayer_${target} generate_api_cpp generate_api_h generate_api_html_h) - add_dependencies(VkLayer_${target} generate_api_cpp generate_api_h generate_api_json_h) if (NOT APPLE) set_target_properties(VkLayer_${target} PROPERTIES LINK_FLAGS "-Wl,-Bsymbolic") endif () @@ -136,6 +135,13 @@ if(BUILD_APIDUMP) run_vulkantools_vk_xml_generate(api_dump_generator.py api_dump_text.h) run_vulkantools_vk_xml_generate(api_dump_generator.py api_dump_html.h) run_vulkantools_vk_xml_generate(api_dump_generator.py api_dump_json.h) + run_vulkantools_video_xml_generate(api_dump_generator.py api_dump_video_text.h) + run_vulkantools_video_xml_generate(api_dump_generator.py api_dump_video_html.h) + run_vulkantools_video_xml_generate(api_dump_generator.py api_dump_video_json.h) + + add_vk_layer(api_dump api_dump.cpp vk_layer_table.cpp ../vku/vk_layer_settings.cpp ../vku/vk_layer_settings.h) + add_dependencies(VkLayer_api_dump generate_api_cpp generate_api_text_h generate_api_html_h generate_api_json_h + generate_api_video_text_h generate_api_video_html_h generate_api_video_json_h) endif () if (NOT APPLE) @@ -147,10 +153,6 @@ if (NOT APPLE) endif () endif () -if(BUILD_APIDUMP) - add_vk_layer(api_dump api_dump.cpp vk_layer_table.cpp ../vku/vk_layer_settings.cpp ../vku/vk_layer_settings.h) -endif () - # json file creation # The output file needs Unix "/" separators or Windows "\" separators diff --git a/layersvt/api_dump.h b/layersvt/api_dump.h index ccfaa0964a..051dde5419 100644 --- a/layersvt/api_dump.h +++ b/layersvt/api_dump.h @@ -33,6 +33,15 @@ #include "vk_layer_extension_utils.h" #include "vk_layer_utils.h" +// Include the video headers so we can print types that come from them +#include "vk_video/vulkan_video_codecs_common.h" +#include "vk_video/vulkan_video_codec_h264std.h" +#include "vk_video/vulkan_video_codec_h264std_decode.h" +#include "vk_video/vulkan_video_codec_h264std_encode.h" +#include "vk_video/vulkan_video_codec_h265std.h" +#include "vk_video/vulkan_video_codec_h265std_decode.h" +#include "vk_video/vulkan_video_codec_h265std_encode.h" + #include #include #include diff --git a/scripts/api_dump_generator.py b/scripts/api_dump_generator.py index c901e3ead6..c66e329a04 100644 --- a/scripts/api_dump_generator.py +++ b/scripts/api_dump_generator.py @@ -420,16 +420,18 @@ #pragma once #include "api_dump.h" - +#include "api_dump_video_text.h" +@if(not {isVideoGeneration}) void dump_text_pNext_struct_name(const void* object, const ApiDumpSettings& settings, int indents, const char* pnext_type); void dump_text_pNext_trampoline(const void* object, const ApiDumpSettings& settings, int indents); - +@end if @foreach union void dump_text_{unName}(const {unName}& object, const ApiDumpSettings& settings, int indents); @end union //============================= typedefs ==============================// +@if(not {isVideoGeneration}) // Functions for dumping typedef types that the codegen scripting can't handle #if defined(VK_ENABLE_BETA_EXTENSIONS) void dump_text_VkAccelerationStructureTypeKHR(VkAccelerationStructureTypeKHR object, const ApiDumpSettings& settings, int indents); @@ -443,18 +445,21 @@ dump_text_VkBuildAccelerationStructureFlagsKHR(object, settings, indents); }} #endif // VK_ENABLE_BETA_EXTENSIONS - +@end if //=========================== Type Implementations ==========================// @foreach type where('{etyName}' != 'void') void dump_text_{etyName}({etyName} object, const ApiDumpSettings& settings, int indents) {{ - @if('{etyName}' != 'uint8_t') + @if('{etyName}' != 'uint8_t' and '{etyName}' != 'int8_t') settings.stream() << object; @end if @if('{etyName}' == 'uint8_t') settings.stream() << (uint32_t) object; @end if + @if('{etyName}' == 'int8_t') + settings.stream() << (int32_t) object; + @end if }} @end type @@ -700,7 +705,7 @@ @end union //======================== pNext Chain Implementation =======================// - +@if(not {isVideoGeneration}) void dump_text_pNext_struct_name(const void* object, const ApiDumpSettings& settings, int indents, const char* pnext_type) {{ if (object == nullptr) {{ @@ -751,7 +756,7 @@ settings.stream() << "UNKNOWN (" << (int64_t) (base_struct->sType) << ")\\n"; }} }} - +@end if //========================= Function Implementations ========================// @foreach function where('{funcName}' not in ['vkGetDeviceProcAddr', 'vkGetInstanceProcAddr']) @@ -826,15 +831,17 @@ #pragma once #include "api_dump.h" - +#include "api_dump_video_html.h" +@if(not {isVideoGeneration}) void dump_html_pNext_trampoline(const void* object, const ApiDumpSettings& settings, int indents); - +@end if @foreach union void dump_html_{unName}(const {unName}& object, const ApiDumpSettings& settings, int indents); @end union //============================= typedefs ==============================// +@if(not {isVideoGeneration}) // Functions for dumping typedef types that the codegen scripting can't handle #if defined(VK_ENABLE_BETA_EXTENSIONS) void dump_html_VkAccelerationStructureTypeKHR(VkAccelerationStructureTypeKHR object, const ApiDumpSettings& settings, int indents); @@ -848,7 +855,7 @@ dump_html_VkBuildAccelerationStructureFlagsKHR(object, settings, indents); }} #endif // VK_ENABLE_BETA_EXTENSIONS - +@end if //=========================== Type Implementations ==========================// @@ -856,12 +863,15 @@ void dump_html_{etyName}({etyName} object, const ApiDumpSettings& settings, int indents) {{ settings.stream() << "
"; - @if('{etyName}' != 'uint8_t') + @if('{etyName}' != 'uint8_t' and '{etyName}' != 'int8_t') settings.stream() << object; @end if @if('{etyName}' == 'uint8_t') settings.stream() << (uint32_t) object; @end if + @if('{etyName}' == 'int8_t') + settings.stream() << (int32_t) object; + @end if settings.stream() << "
"; }} @end type @@ -1105,7 +1115,7 @@ @end union //======================== pNext Chain Implementation =======================// - +@if(not {isVideoGeneration}) void dump_html_pNext_trampoline(const void* object, const ApiDumpSettings& settings, int indents) {{ switch((int64_t) (static_cast(object)->sType)) {{ @@ -1133,7 +1143,7 @@ settings.stream() << "
UNKNOWN (" << (int64_t) (static_cast(object)->sType) <<")
"; }} }} - +@end if //========================= Function Implementations ========================// @foreach function where('{funcName}' not in ['vkGetDeviceProcAddr', 'vkGetInstanceProcAddr']) @@ -1208,15 +1218,17 @@ #pragma once #include "api_dump.h" - +#include "api_dump_video_json.h" +@if(not {isVideoGeneration}) void dump_json_pNext_trampoline(const void* object, const ApiDumpSettings& settings, int indents); - +@end if @foreach union void dump_json_{unName}(const {unName}& object, const ApiDumpSettings& settings, int indents); @end union //============================= typedefs ==============================// +@if(not {isVideoGeneration}) // Functions for dumping typedef types that the codegen scripting can't handle #if defined(VK_ENABLE_BETA_EXTENSIONS) void dump_json_VkAccelerationStructureTypeKHR(VkAccelerationStructureTypeKHR object, const ApiDumpSettings& settings, int indents); @@ -1230,6 +1242,7 @@ dump_json_VkBuildAccelerationStructureFlagsKHR(object, settings, indents); }} #endif // VK_ENABLE_BETA_EXTENSIONS +@end if //=========================== Type Implementations ==========================// @@ -1237,13 +1250,15 @@ void dump_json_{etyName}({etyName} object, const ApiDumpSettings& settings, int indents) {{ - //settings.stream() << settings.indentation(indents); - @if('{etyName}' != 'uint8_t') + @if('{etyName}' != 'uint8_t' and '{etyName}' != 'int8_t') settings.stream() << "\\"" << object << "\\""; @end if @if('{etyName}' == 'uint8_t') settings.stream() << "\\"" << (uint32_t) object << "\\""; @end if + @if('{etyName}' == 'int8_t') + settings.stream() << "\\"" << (int32_t) object << "\\""; + @end if }} @end type @@ -1443,7 +1458,7 @@ settings.stream() << "\\n" << settings.indentation(indents) << "]"; }} @end struct - +@if({isVideoGeneration}) bool is_struct(const char *t) {{ char *tm = (char*)t; @@ -1455,7 +1470,7 @@ @end struct return false; }} - +@end if //========================== Union Implementations ==========================// @foreach union void dump_json_{unName}(const {unName}& object, const ApiDumpSettings& settings, int indents) @@ -1480,7 +1495,7 @@ settings.stream() << "\\n" << settings.indentation(indents) << "]"; }} @end union - +@if({isVideoGeneration}) bool is_union(const char *t) {{ char *tm = (char*)t; @@ -1492,9 +1507,9 @@ @end union return false; }} - +@end if //======================== pNext Chain Implementation =======================// - +@if(not {isVideoGeneration}) void dump_json_pNext_trampoline(const void* object, const ApiDumpSettings& settings, int indents) {{ switch((int64_t) (static_cast(object)->sType)) {{ @@ -1526,7 +1541,7 @@ settings.stream() << settings.indentation(indents) << "}}"; }} }} - +@end if //========================= Function Implementations ========================// @foreach function where(not '{funcName}' in ['vkGetDeviceProcAddr', 'vkGetInstanceProcAddr']) @@ -1688,6 +1703,11 @@ }, } +# These types are defined in both video.xml and vk.xml. Because duplicate functions aren't allowed, +# we have to prevent these from generating twice. This is done by removing the types from the non-video +# outputs +DUPLICATE_TYPES_IN_VIDEO_HEADER = ['uint32_t', 'uint16_t', 'uint8_t', 'int32_t', 'int8_t'] + class ApiDumpGeneratorOptions(GeneratorOptions): def __init__(self, conventions = None, @@ -1717,6 +1737,7 @@ def __init__(self, indentFuncPointer = False, alignFuncParam = 0, expandEnumerants = True, + isVideoGeneration = False, ): GeneratorOptions.__init__(self, conventions = conventions, @@ -1745,6 +1766,7 @@ def __init__(self, self.indentFuncProto = indentFuncProto self.indentFuncPointer = indentFuncPointer self.alignFuncParam = alignFuncParam + self.isVideoGeneration = isVideoGeneration class ApiDumpOutputGenerator(OutputGenerator): @@ -1756,6 +1778,7 @@ def __init__(self, registryFile = None): gen.OutputGenerator.__init__(self, errFile, warnFile, diagFile) self.format = None + self.isVideoGeneration = False self.constants = {} self.extensions = {} @@ -1763,6 +1786,7 @@ def __init__(self, self.extTypes = {} self.includes = {} + self.sysTypes = {} self.basetypes = {} self.bitmasks = {} self.enums = {} @@ -1783,6 +1807,7 @@ def __init__(self, def beginFile(self, genOpts): gen.OutputGenerator.beginFile(self, genOpts) self.format = genOpts.input + self.isVideoGeneration = genOpts.isVideoGeneration if self.registryFile is not None: root = xml.etree.ElementTree.parse(self.registryFile) @@ -1812,7 +1837,8 @@ def endFile(self): # Find all 'system' types and put it in a set sysTypeNames = set() for node in self.registry.reg.find('types').findall('type'): - if node.get('category') is None and node.get('requires') in self.includes and node.get('requires') != 'vk_platform': + if node.get('category') is None and node.get('requires') in self.includes and node.get('requires') not in ['vk_platform', 'stdint'] \ + and "vk_video" not in node.get('requires'): sysTypeNames.add(node.get('name')) # Look through the set of sysTypeName to find all of the extensions that use the system types, then add it to sysTypes @@ -1957,8 +1983,13 @@ def genType(self, typeinfo, name, alias): self.structs[typeinfo.elem.get('name')] = VulkanStruct(typeinfo.elem, self.constants, self.enums) elif typeinfo.elem.get('category') == 'basetype': self.basetypes[typeinfo.elem.get('name')] = VulkanBasetype(typeinfo.elem) - elif typeinfo.elem.get('category') is None and typeinfo.elem.get('requires') == 'vk_platform': - self.externalTypes[typeinfo.elem.get('name')] = VulkanExternalType(typeinfo.elem) + elif typeinfo.elem.get('category') is None and typeinfo.elem.get('requires') in ['vk_platform', 'stdint']: + # only add these types if we are generating the video headers + if typeinfo.elem.get('name') in DUPLICATE_TYPES_IN_VIDEO_HEADER: + if self.isVideoGeneration: + self.externalTypes[typeinfo.elem.get('name')] = VulkanExternalType(typeinfo.elem) + else: + self.externalTypes[typeinfo.elem.get('name')] = VulkanExternalType(typeinfo.elem) elif typeinfo.elem.get('category') == 'handle': self.handles[typeinfo.elem.get('name')] = VulkanHandle(typeinfo.elem) elif typeinfo.elem.get('category') == 'union': @@ -2018,6 +2049,7 @@ def expand(self, loop, parents=[]): # Merge the values and the parent values values = item.values().copy() + values.update({'isVideoGeneration' : str(self.isVideoGeneration)}) for parent in parents: values.update(parent.values()) @@ -2302,7 +2334,8 @@ class VulkanExtension: def __init__(self, rootNode): self.name = rootNode.get('name') - self.number = int(rootNode.get('number')) + # video.xml extensions dont have numbers - just use None in that case + self.number = int(rootNode.get('number')) if rootNode.get('number') else None self.type = rootNode.get('type') self.dependency = rootNode.get('requires') self.guard = GetFeatureProtect(rootNode) diff --git a/scripts/vt_genvk.py b/scripts/vt_genvk.py index 416b287375..c34668da02 100755 --- a/scripts/vt_genvk.py +++ b/scripts/vt_genvk.py @@ -232,6 +232,36 @@ def makeGenOpts(args): expandEnumerants = False) ] + # API dump generator options for api_dump_video_text.h + genOpts['api_dump_video_text.h'] = [ + ApiDumpOutputGenerator, + ApiDumpGeneratorOptions( + conventions = conventions, + input = TEXT_CODEGEN, + filename = 'api_dump_video_text.h', + apiname = 'vulkan', + genpath = None, + profile = None, + versions = featuresPat, + emitversions = featuresPat, + defaultExtensions = 'vulkan', + addExtensions = addExtensionsPat, + removeExtensions = removeExtensionsPat, + emitExtensions = emitExtensionsPat, + prefixText = prefixStrings + vkPrefixStrings, + genFuncPointers = True, + protectFile = protect, + protectFeature = False, + protectProto = None, + protectProtoStr = 'VK_NO_PROTOTYPES', + apicall = 'VKAPI_ATTR ', + apientry = 'VKAPI_CALL ', + apientryp = 'VKAPI_PTR *', + alignFuncParam = 48, + expandEnumerants = False, + isVideoGeneration = True) + ] + # API dump generator options for api_dump_html.h genOpts['api_dump_html.h'] = [ ApiDumpOutputGenerator, @@ -261,6 +291,36 @@ def makeGenOpts(args): expandEnumerants = False) ] + # API dump generator options for api_dump_video_html.h + genOpts['api_dump_video_html.h'] = [ + ApiDumpOutputGenerator, + ApiDumpGeneratorOptions( + conventions = conventions, + input = HTML_CODEGEN, + filename = 'api_dump_video_html.h', + apiname = 'vulkan', + genpath = None, + profile = None, + versions = featuresPat, + emitversions = featuresPat, + defaultExtensions = 'vulkan', + addExtensions = addExtensionsPat, + removeExtensions = removeExtensionsPat, + emitExtensions = emitExtensionsPat, + prefixText = prefixStrings + vkPrefixStrings, + genFuncPointers = True, + protectFile = protect, + protectFeature = False, + protectProto = None, + protectProtoStr = 'VK_NO_PROTOTYPES', + apicall = 'VKAPI_ATTR ', + apientry = 'VKAPI_CALL ', + apientryp = 'VKAPI_PTR *', + alignFuncParam = 48, + expandEnumerants = False, + isVideoGeneration = True) + ] + # API dump generator options for api_dump_json.h genOpts['api_dump_json.h'] = [ ApiDumpOutputGenerator, @@ -290,6 +350,37 @@ def makeGenOpts(args): expandEnumerants = False) ] + # API dump generator options for api_dump_video_json.h + genOpts['api_dump_video_json.h'] = [ + ApiDumpOutputGenerator, + ApiDumpGeneratorOptions( + conventions = conventions, + input = JSON_CODEGEN, + filename = 'api_dump_video_json.h', + apiname = 'vulkan', + genpath = None, + profile = None, + versions = featuresPat, + emitversions = featuresPat, + defaultExtensions = 'vulkan', + addExtensions = addExtensionsPat, + removeExtensions = removeExtensionsPat, + emitExtensions = emitExtensionsPat, + prefixText = prefixStrings + vkPrefixStrings, + genFuncPointers = True, + protectFile = protect, + protectFeature = False, + protectProto = None, + protectProtoStr = 'VK_NO_PROTOTYPES', + apicall = 'VKAPI_ATTR ', + apientry = 'VKAPI_CALL ', + apientryp = 'VKAPI_PTR *', + alignFuncParam = 48, + expandEnumerants = False, + isVideoGeneration = True) + ] + + # Helper file generator options for vk_struct_size_helper.h genOpts['vk_struct_size_helper.h'] = [ ToolHelperFileOutputGenerator, From 1d6505c170460639fc22244a2f68219fc6f4ca20 Mon Sep 17 00:00:00 2001 From: Christophe Date: Mon, 27 Mar 2023 15:23:50 +0200 Subject: [PATCH 064/154] vkconfig: fix copyright Change-Id: I71fba6a6f14728a5378f9559d6277c8ad5adf8dc --- vkconfig/dialog_about.ui | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vkconfig/dialog_about.ui b/vkconfig/dialog_about.ui index 16f172a3a3..f1b485a430 100644 --- a/vkconfig/dialog_about.ui +++ b/vkconfig/dialog_about.ui @@ -74,7 +74,7 @@ Qt::LeftToRight - Copyright (c) 2020-2022 LunarG, Inc. + Copyright (c) 2020-2023 LunarG, Inc. Qt::AlignLeading|Qt::AlignLeft|Qt::AlignVCenter From 6fbbeb13ae7a671be9a8922b830f5e7c2f02f3a0 Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Thu, 30 Mar 2023 18:34:42 -0600 Subject: [PATCH 065/154] apidump: Generate is_struct/is_union logic Move the logic for dertermining if something is a struct or union to be a hardcoded value instead of having to perform a runtime lookup. This is a possibility since whether a type is a struct or union is apart of the Vulkan API. This fixes an issue introduced in the PR to support the video extensions where there is_struct & is_union functions only included the video API types, not the entire API. --- layersvt/api_dump.h | 43 ++++++++-------- scripts/api_dump_generator.py | 92 +++++++++++++++++++---------------- 2 files changed, 72 insertions(+), 63 deletions(-) diff --git a/layersvt/api_dump.h b/layersvt/api_dump.h index 051dde5419..abff6c4890 100644 --- a/layersvt/api_dump.h +++ b/layersvt/api_dump.h @@ -1222,7 +1222,8 @@ void dump_json_function_head(ApiDumpInstance &dump_inst, const char *funcName, c template void dump_json_array(const T *array, size_t len, const ApiDumpSettings &settings, const char *type_string, const char *child_type, - const char *name, int indents, void (*dump)(const T, const ApiDumpSettings &, int)) { + const char *name, bool is_struct, bool is_union, int indents, + void (*dump)(const T, const ApiDumpSettings &, int)) { if (len == 0 || array == NULL) { settings.stream() << settings.indentation(indents) << "{\n"; settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << "\",\n"; @@ -1247,7 +1248,7 @@ void dump_json_array(const T *array, size_t len, const ApiDumpSettings &settings std::stringstream stream; stream << "[" << i << "]"; std::string indexName = stream.str(); - dump_json_value(array[i], &array[i], settings, child_type, indexName.c_str(), indents + 2, dump); + dump_json_value(array[i], &array[i], settings, child_type, indexName.c_str(), is_struct, is_union, indents + 2, dump); if (i < len - 1) settings.stream() << ','; settings.stream() << "\n"; } @@ -1258,7 +1259,8 @@ void dump_json_array(const T *array, size_t len, const ApiDumpSettings &settings template void dump_json_array(const T *array, size_t len, const ApiDumpSettings &settings, const char *type_string, const char *child_type, - const char *name, int indents, void (*dump)(const T &, const ApiDumpSettings &, int)) { + const char *name, bool is_struct, bool is_union, int indents, + void (*dump)(const T &, const ApiDumpSettings &, int)) { if (len == 0 || array == NULL) { settings.stream() << settings.indentation(indents) << "{\n"; settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << "\",\n"; @@ -1282,7 +1284,7 @@ void dump_json_array(const T *array, size_t len, const ApiDumpSettings &settings std::stringstream stream; stream << "[" << i << "]"; std::string indexName = stream.str(); - dump_json_value(array[i], &array[i], settings, child_type, indexName.c_str(), indents + 2, dump); + dump_json_value(array[i], &array[i], settings, child_type, indexName.c_str(), is_struct, is_union, indents + 2, dump); if (i < len - 1) settings.stream() << ','; settings.stream() << "\n"; } @@ -1292,8 +1294,8 @@ void dump_json_array(const T *array, size_t len, const ApiDumpSettings &settings } template -void dump_json_pointer(const T *pointer, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents, - void (*dump)(const T, const ApiDumpSettings &, int)) { +void dump_json_pointer(const T *pointer, const ApiDumpSettings &settings, const char *type_string, const char *name, bool is_struct, + bool is_union, int indents, void (*dump)(const T, const ApiDumpSettings &, int)) { if (pointer == NULL) { settings.stream() << settings.indentation(indents) << "{\n"; settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << "\",\n"; @@ -1302,13 +1304,13 @@ void dump_json_pointer(const T *pointer, const ApiDumpSettings &settings, const settings.stream() << (settings.showAddress() ? "\"NULL\"" : "\"address\"") << "\n"; settings.stream() << settings.indentation(indents) << "}"; } else { - dump_json_value(*pointer, pointer, settings, type_string, name, indents, dump); + dump_json_value(*pointer, pointer, settings, type_string, name, is_struct, is_union, indents, dump); } } template -void dump_json_pointer(const T *pointer, const ApiDumpSettings &settings, const char *type_string, const char *name, int indents, - void (*dump)(const T &, const ApiDumpSettings &, int)) { +void dump_json_pointer(const T *pointer, const ApiDumpSettings &settings, const char *type_string, const char *name, bool is_struct, + bool is_union, int indents, void (*dump)(const T &, const ApiDumpSettings &, int)) { if (pointer == NULL) { settings.stream() << settings.indentation(indents) << "{\n"; settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << "\",\n"; @@ -1317,20 +1319,18 @@ void dump_json_pointer(const T *pointer, const ApiDumpSettings &settings, const settings.stream() << (settings.showAddress() ? "\"NULL\"" : "\"address\"") << "\n"; settings.stream() << settings.indentation(indents) << "}"; } else { - dump_json_value(*pointer, pointer, settings, type_string, name, indents, dump); + dump_json_value(*pointer, pointer, settings, type_string, name, is_struct, is_union, indents, dump); } } -extern bool is_union(const char *t); -extern bool is_struct(const char *t); - template void dump_json_value(const T object, const void *pObject, const ApiDumpSettings &settings, const char *type_string, - const char *name, int indents, void (*dump)(const T, const ApiDumpSettings &, int)) { + const char *name, bool is_struct, bool is_union, int indents, + void (*dump)(const T, const ApiDumpSettings &, int)) { bool isPnext = !strcmp(name, "pNext") || !strcmp(name, "pUserData"); const char *star = (isPnext && !strstr(type_string, "void")) ? "*" : ""; settings.stream() << settings.indentation(indents) << "{\n"; - if (is_union(type_string)) + if (is_union) settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << star << " (Union)\",\n"; else settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << star << "\",\n"; @@ -1342,7 +1342,7 @@ void dump_json_value(const T object, const void *pObject, const ApiDumpSettings } if (!isPnext || (isPnext && pObject != nullptr)) { settings.stream() << ",\n"; - if (is_union(type_string) || is_struct(type_string)) + if (is_struct || is_union) settings.stream() << settings.indentation(indents + 1) << "\"members\" :\n"; else settings.stream() << settings.indentation(indents + 1) << "\"value\" : "; @@ -1354,11 +1354,12 @@ void dump_json_value(const T object, const void *pObject, const ApiDumpSettings template void dump_json_value(const T &object, const void *pObject, const ApiDumpSettings &settings, const char *type_string, - const char *name, int indents, void (*dump)(const T &, const ApiDumpSettings &, int)) { + const char *name, bool is_struct, bool is_union, int indents, + void (*dump)(const T &, const ApiDumpSettings &, int)) { bool isPnext = !strcmp(name, "pNext") || !strcmp(name, "pUserData"); const char *star = (isPnext && !strstr(type_string, "void")) ? "*" : ""; settings.stream() << settings.indentation(indents) << "{\n"; - if (is_union(type_string)) + if (is_union) settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << star << " (Union)\",\n"; else settings.stream() << settings.indentation(indents + 1) << "\"type\" : \"" << type_string << star << "\",\n"; @@ -1370,7 +1371,7 @@ void dump_json_value(const T &object, const void *pObject, const ApiDumpSettings } if (!isPnext || (isPnext && pObject != nullptr)) { settings.stream() << ",\n"; - if (is_union(type_string) || is_struct(type_string)) + if (is_struct || is_union) settings.stream() << settings.indentation(indents + 1) << "\"members\" :\n"; else settings.stream() << settings.indentation(indents + 1) << "\"value\" : "; @@ -1428,7 +1429,7 @@ void dump_json_pNext(const T *object, const ApiDumpSettings &settings, const cha settings.stream() << settings.indentation(indents + 1) << "\"address\" : \"NULL\",\n"; settings.stream() << settings.indentation(indents) << "}"; } else { - dump_json_value(*object, object, settings, type_string, "pNext", indents, dump); + dump_json_value(*object, object, settings, type_string, "pNext", true, false, indents, dump); } } @@ -1442,7 +1443,7 @@ void dump_json_pNext(const T *object, const ApiDumpSettings &settings, const cha settings.stream() << settings.indentation(indents + 1) << "\"address\" : \"NULL\",\n"; settings.stream() << settings.indentation(indents) << "}"; } else { - dump_json_value(*object, object, settings, type_string, "pNext", indents, dump); + dump_json_value(*object, object, settings, type_string, "pNext", true, false, indents, dump); } } diff --git a/scripts/api_dump_generator.py b/scripts/api_dump_generator.py index c66e329a04..80d3bbe18d 100644 --- a/scripts/api_dump_generator.py +++ b/scripts/api_dump_generator.py @@ -1412,39 +1412,39 @@ @end if @if({memPtrLevel} == 0) @if('{memName}' != 'pNext') - dump_json_value(object.{memName}, NULL, settings, "{memType}", "{memName}", indents + 1, dump_json_{memTypeID}); + dump_json_value(object.{memName}, NULL, settings, "{memType}", "{memName}", {memIsStruct}, {memIsUnion}, indents + 1, dump_json_{memTypeID}); @end if @if('{memName}' == 'pNext') if(object.pNext != nullptr){{ dump_json_pNext_trampoline(object.{memName}, settings, indents + 1); }} else {{ - dump_json_value(object.{memName}, object.{memName}, settings, "{memType}", "{memName}", indents + 1, dump_json_{memTypeID}); + dump_json_value(object.{memName}, object.{memName}, settings, "{memType}", "{memName}", {memIsStruct}, {memIsUnion}, indents + 1, dump_json_{memTypeID}); }} @end if @end if @if({memPtrLevel} == 1 and '{memLength}' == 'None') - dump_json_pointer(object.{memName}, settings, "{memType}", "{memName}", indents + 1, dump_json_{memTypeID}); + dump_json_pointer(object.{memName}, settings, "{memType}", "{memName}", {memIsStruct}, {memIsUnion}, indents + 1, dump_json_{memTypeID}); @end if @if({memPtrLevel} == 1 and '{memLength}' != 'None' and not {memLengthIsMember}) - dump_json_array(object.{memName}, {memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_json_{memTypeID}); // IQA + dump_json_array(object.{memName}, {memLength}, settings, "{memType}", "{memChildType}", "{memName}", {memIsStruct}, {memIsUnion}, indents + 1, dump_json_{memTypeID}); // IQA @end if @if({memPtrLevel} == 1 and '{memLength}' != 'None' and {memLengthIsMember} and '{memName}' != 'pCode') @if('{memLength}'[0].isdigit() or '{memLength}'[0].isupper()) - dump_json_array(object.{memName}, {memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_json_{memTypeID}); // JQA + dump_json_array(object.{memName}, {memLength}, settings, "{memType}", "{memChildType}", "{memName}", {memIsStruct}, {memIsUnion}, indents + 1, dump_json_{memTypeID}); // JQA @end if @if(not ('{memLength}'[0].isdigit() or '{memLength}'[0].isupper())) @if('{memLength}' == 'rasterizationSamples') - dump_json_array(object.{memName}, (object.{memLength} + 31) / 32, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_json_{memTypeID}); // JQA + dump_json_array(object.{memName}, (object.{memLength} + 31) / 32, settings, "{memType}", "{memChildType}", "{memName}", {memIsStruct}, {memIsUnion}, indents + 1, dump_json_{memTypeID}); // JQA @end if @if('{memLength}' != 'rasterizationSamples') - dump_json_array(object.{memName}, object.{memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_json_{memTypeID}); // JQA + dump_json_array(object.{memName}, object.{memLength}, settings, "{memType}", "{memChildType}", "{memName}", {memIsStruct}, {memIsUnion}, indents + 1, dump_json_{memTypeID}); // JQA @end if @end if @end if @if('{sctName}' == 'VkShaderModuleCreateInfo') @if('{memName}' == 'pCode') if(settings.showShader()) - dump_json_array(object.{memName}, object.{memLength}, settings, "{memType}", "{memChildType}", "{memName}", indents + 1, dump_json_{memTypeID}); // KQA + dump_json_array(object.{memName}, object.{memLength}, settings, "{memType}", "{memChildType}", "{memName}", {memIsStruct}, {memIsUnion}, indents + 1, dump_json_{memTypeID}); // KQA else dump_json_special("SHADER DATA", settings, "{memType}", "{memName}", indents + 1); @end if @@ -1458,19 +1458,7 @@ settings.stream() << "\\n" << settings.indentation(indents) << "]"; }} @end struct -@if({isVideoGeneration}) -bool is_struct(const char *t) -{{ - char *tm = (char*)t; - size_t tmlen; - if (strncmp(tm, "const ", 6) == 0) tm = tm + 6; - tmlen = strcspn(tm, "[*"); -@foreach struct - if (strncmp("{sctName}", tm, tmlen) == 0 && strlen("{sctName}") == tmlen) return true; -@end struct - return false; -}} -@end if + //========================== Union Implementations ==========================// @foreach union void dump_json_{unName}(const {unName}& object, const ApiDumpSettings& settings, int indents) @@ -1482,32 +1470,20 @@ settings.stream() << ",\\n"; @end if @if({chcPtrLevel} == 0) - dump_json_value(object.{chcName}, NULL, settings, "{chcType}", "{chcName}", indents + 2, dump_json_{chcTypeID}); + dump_json_value(object.{chcName}, NULL, settings, "{chcType}", "{chcName}", {chcIsStruct}, {chcIsUnion}, indents + 2, dump_json_{chcTypeID}); @end if @if({chcPtrLevel} == 1 and '{chcLength}' == 'None') - dump_json_pointer(object.{chcName}, settings, "{chcType}", "{chcName}", indents + 2, dump_json_{chcTypeID}); + dump_json_pointer(object.{chcName}, settings, "{chcType}", "{chcName}", {chcIsStruct}, {chcIsUnion}, indents + 2, dump_json_{chcTypeID}); @end if @if({chcPtrLevel} == 1 and '{chcLength}' != 'None') - dump_json_array(object.{chcName}, {chcLength}, settings, "{chcType}", "{chcChildType}", "{chcName}", indents + 2, dump_json_{chcTypeID}); // OQA + dump_json_array(object.{chcName}, {chcLength}, settings, "{chcType}", "{chcChildType}", "{chcName}", {chcIsStruct}, {chcIsUnion}, indents + 2, dump_json_{chcTypeID}); // OQA @end if @end choice settings.stream() << "\\n" << settings.indentation(indents) << "]"; }} @end union -@if({isVideoGeneration}) -bool is_union(const char *t) -{{ - char *tm = (char*)t; - size_t tmlen; - if (strncmp(tm, "const ", 6) == 0) tm = tm + 6; - tmlen = strcspn(tm, "[*"); -@foreach union - if (strncmp("{unName}", tm, tmlen) == 0 && strlen("{unName}") == tmlen) return true; -@end union - return false; -}} -@end if + //======================== pNext Chain Implementation =======================// @if(not {isVideoGeneration}) void dump_json_pNext_trampoline(const void* object, const ApiDumpSettings& settings, int indents) @@ -1576,13 +1552,13 @@ {prmParameterStorage} @end if @if({prmPtrLevel} == 0) - dump_json_value({prmName}, NULL, settings, "{prmType}", "{prmName}", 4, dump_json_{prmTypeID}); + dump_json_value({prmName}, NULL, settings, "{prmType}", "{prmName}", {prmIsStruct}, {prmIsUnion}, 4, dump_json_{prmTypeID}); @end if @if({prmPtrLevel} == 1 and '{prmLength}' == 'None') - dump_json_pointer({prmName}, settings, "{prmType}", "{prmName}", 4, dump_json_{prmTypeID}); + dump_json_pointer({prmName}, settings, "{prmType}", "{prmName}", {prmIsStruct}, {prmIsUnion}, 4, dump_json_{prmTypeID}); @end if @if({prmPtrLevel} == 1 and '{prmLength}' != 'None') - dump_json_array({prmName}, {prmLength}, settings, "{prmType}", "{prmChildType}", "{prmName}", 4, dump_json_{prmTypeID}); // PQA + dump_json_array({prmName}, {prmLength}, settings, "{prmType}", "{prmChildType}", "{prmName}", {prmIsStruct}, {prmIsUnion}, 4, dump_json_{prmTypeID}); // PQA @end if @end parameter @@ -1858,6 +1834,29 @@ def endFile(self): if sysTypeName == param.baseType or sysTypeName + '*' == param.baseType: self.sysTypes[sysTypeName] = VulkanSystemType(sysTypeName, extension) + + # Fill in the is_struct and is_union member variables of the Variable class so that json output can be correct + + for value in self.functions.values(): + for variable in value.parameters: + if variable.typeID in self.structs: + variable.is_struct = True + if variable.typeID in self.unions: + variable.is_union = True + for value in self.structs.values(): + for variable in value.members: + if variable.typeID in self.structs: + variable.is_struct = True + if variable.typeID in self.unions: + variable.is_union = True + for value in self.unions.values(): + for variable in value.choices: + if variable.typeID in self.structs: + variable.is_struct = True + if variable.typeID in self.unions: + variable.is_union = True + + # Find every @foreach, @if, and @end forIter = re.finditer('(^\\s*\\@foreach\\s+[a-z]+(\\s+where\\(.*\\))?\\s*^)|(\\@foreach [a-z]+(\\s+where\\(.*\\))?\\b)', self.format, flags=re.MULTILINE) ifIter = re.finditer('(^\\s*\\@if\\(.*\\)\\s*^)|(\\@if\\(.*\\))', self.format, flags=re.MULTILINE) @@ -2192,6 +2191,9 @@ def __init__(self, rootNode, constants, aliases, parentName): for states in PARAMETER_STATE[self.typeID][parentName]: self.parameterStorage += states['stmt'] + self.is_struct = False + self.is_union = False + class VulkanBasetype: def __init__(self, rootNode): @@ -2430,7 +2432,9 @@ def values(self): 'prmPtrLevel': self.pointerLevels, 'prmLength': self.arrayLength, 'prmParameterStorage': self.parameterStorage, - 'prmIndex': self.index + 'prmIndex': self.index, + 'prmIsStruct': 'true' if self.is_struct else 'false', + 'prmIsUnion': 'true' if self.is_union else 'false' } def __init__(self, rootNode, constants, aliases, extensions): @@ -2527,7 +2531,9 @@ def values(self): 'memLengthIsMember': self.lengthMember, 'memCondition': self.condition, 'memParameterStorage': self.parameterStorage, - 'memIndex' : self.index + 'memIndex' : self.index, + 'memIsStruct': 'true' if self.is_struct else 'false', + 'memIsUnion': 'true' if self.is_union else 'false', } @@ -2619,6 +2625,8 @@ def values(self): 'chcLength': self.arrayLength, #'chcLengthIsMember': self.lengthMember, 'chcIndex': self.index, + 'chcIsStruct': 'true' if self.is_struct else 'false', + 'chcIsUnion': 'true' if self.is_union else 'false', } def __init__(self, rootNode, constants): From b8117c3ce4458300f50087593cece8b9f2930b26 Mon Sep 17 00:00:00 2001 From: Christophe Date: Wed, 5 Apr 2023 16:04:20 +0200 Subject: [PATCH 066/154] vkconfig: fix link after doc reorganization Change-Id: I4fd2bde8d09a470f541659b1a57f143384c200ee --- vkconfig/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vkconfig/README.md b/vkconfig/README.md index eb151f7a67..c69e2ede94 100644 --- a/vkconfig/README.md +++ b/vkconfig/README.md @@ -9,7 +9,7 @@

-*Vulkan Configurator* allows overriding the [layers configuration](https://github.com/KhronosGroup/Vulkan-Loader/blob/main/loader/LoaderAndLayerInterface.md#layers) used by Vulkan applications at runtime. +*Vulkan Configurator* allows overriding the [layers configuration](https://github.com/KhronosGroup/Vulkan-Loader/blob/main/docs/LoaderInterfaceArchitecture.md#layers) used by Vulkan applications at runtime. A Vulkan application may configure layers when creating a Vulkan Instance. This layers configuration may be overridden using *Vulkan Configurator* globally or for a selected list of Vulkan applications. From d6f20068ef54588fae5cc6c3d65bc1303116a016 Mon Sep 17 00:00:00 2001 From: Christophe Date: Wed, 5 Apr 2023 16:15:49 +0200 Subject: [PATCH 067/154] vkconfig: fix link after doc reorganization Change-Id: Ic9d8760fff8e130d9f8db5ef0f46bc6b7e0b4e8b --- vkconfig/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/vkconfig/README.md b/vkconfig/README.md index c69e2ede94..736035113e 100644 --- a/vkconfig/README.md +++ b/vkconfig/README.md @@ -94,13 +94,13 @@ arguments. -------------- ## Terminology -***[Vulkan Layer](https://github.com/KhronosGroup/Vulkan-Loader/blob/main/loader/LoaderAndLayerInterface.md#layers)***: A layer is an optional library that can intercept Vulkan functions on their way from the Vulkan application down to the Vulkan drivers. Multiple layers can be chained together to use multiple layer functionalities simultaneously. +***[Vulkan Layer](https://github.com/KhronosGroup/Vulkan-Loader/blob/main/docs/LoaderInterfaceArchitecture.md#layers)***: A layer is an optional library that can intercept Vulkan functions on their way from the Vulkan application down to the Vulkan drivers. Multiple layers can be chained together to use multiple layer functionalities simultaneously. ***Vulkan Layers Configuration***: A collection of Vulkan Layers executed in [a specific order](#vulkan-layers-execution-order-overview) with specific settings for each layer. -***[Vulkan Explicit Layers vs Implicit Layer](https://github.com/KhronosGroup/Vulkan-Loader/blob/main/loader/LoaderAndLayerInterface.md#implicit-vs-explicit-layers)***: An explicit layer has to be explicitly activated by the user from source in `vkCreateInstance`, using Vulkan Configurator or `VK_INSTANCE_LAYERS` environment variable. Implicit layers are enabled by their existence on the system by default. +***[Vulkan Explicit Layers vs Implicit Layer](https://github.com/KhronosGroup/Vulkan-Loader/blob/main/docs/LoaderApplicationInterface.md#implicit-vs-explicit-layers)***: An explicit layer has to be explicitly activated by the user from source in `vkCreateInstance`, using Vulkan Configurator or `VK_INSTANCE_LAYERS` environment variable. Implicit layers are enabled by their existence on the system by default. -***[Vulkan Meta-Layer](https://github.com/KhronosGroup/Vulkan-Loader/blob/main/loader/LoaderAndLayerInterface.md#meta-layers)***: Meta-layers are a special kind of layer which is only available through the desktop [Vulkan Loader](https://github.com/KhronosGroup/Vulkan-Loader). While usual layers are associated with one particular library, a meta-layer is actually a collection layer which contains an ordered list of other layers called *component layers*. +***[Vulkan Meta-Layer](https://github.com/KhronosGroup/Vulkan-Loader/blob/main/docs/LoaderLayerInterface.md#override-meta-layer)***: Meta-layers are a special kind of layer which is only available through the desktop [Vulkan Loader](https://github.com/KhronosGroup/Vulkan-Loader). While usual layers are associated with one particular library, a meta-layer is actually a collection layer which contains an ordered list of other layers called *component layers*. ***Vulkan Override Layer***: The Vulkan Override Layer is an implicit meta-layer found on the system with the name `VK_LAYER_LUNARG_override`. It is the mechanism used by *Vulkan Configurator* to override Vulkan applications layers. This layer contains: - The ordered list of layers to activate From f6aebf0aad97400a84fc5fc2036a06e70c8b5662 Mon Sep 17 00:00:00 2001 From: Nathaniel Cesario Date: Fri, 24 Mar 2023 15:52:24 -0600 Subject: [PATCH 068/154] build: Use apksigner for Android --- build-android/build_all.sh | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/build-android/build_all.sh b/build-android/build_all.sh index 6dcbc1d3cf..7eb2d90252 100755 --- a/build-android/build_all.sh +++ b/build-android/build_all.sh @@ -41,7 +41,7 @@ function findtool() { # Check for dependencies findtool aapt findtool zipalign -findtool jarsigner +findtool apksigner set -ev @@ -51,10 +51,10 @@ echo LAYER_BUILD_DIR="${LAYER_BUILD_DIR}" echo CUBE_BUILD_DIR="${CUBE_BUILD_DIR}" function create_APK() { - aapt package -f -M AndroidManifest.xml -I "$ANDROID_SDK_HOME/platforms/android-23/android.jar" -S res -F bin/$1-unaligned.apk bin/libs + aapt package -f -M AndroidManifest.xml -I "$ANDROID_SDK_HOME/platforms/android-26/android.jar" -S res -F bin/$1-unaligned.apk bin/libs # update this logic to detect if key is already there. If so, use it, otherwise create it. - jarsigner -verbose -keystore ~/.android/debug.keystore -storepass android -keypass android bin/$1-unaligned.apk androiddebugkey zipalign -f 4 bin/$1-unaligned.apk bin/$1.apk + apksigner sign --verbose --ks ~/.android/debug.keystore --ks-pass pass:android bin/$1.apk } # From 37f1fb328cff8323c5c83941a582949f05f00656 Mon Sep 17 00:00:00 2001 From: Nathaniel Cesario Date: Fri, 24 Mar 2023 15:53:55 -0600 Subject: [PATCH 069/154] build: Update VVL paths Updates include paths based on VVL refactor. Temporary workaround until the VkLayerUtils library is available. --- build-android/jni/Android.mk | 6 +++--- build-android/vulkan-headers_revision_android | 2 +- build-android/vulkan-tools_revision_android | 2 +- .../vulkan-validationlayers_revision_android | 2 +- build-android/vulkan-validationlayers_url_android | 2 +- layer_factory/demo_layer/demo.h | 2 +- layersvt/api_dump.h | 4 ++-- layersvt/monitor.cpp | 6 +++--- layersvt/screenshot.cpp | 8 ++++---- layersvt/vk_layer_table.cpp | 2 +- layersvt/vk_layer_table.h | 2 +- scripts/known_good.json | 8 ++++---- scripts/layer_factory_generator.py | 12 ++++++------ scripts/vlf_makefile_generator.py | 2 +- 14 files changed, 30 insertions(+), 30 deletions(-) diff --git a/build-android/jni/Android.mk b/build-android/jni/Android.mk index 49625a4e13..895576ca89 100644 --- a/build-android/jni/Android.mk +++ b/build-android/jni/Android.mk @@ -24,9 +24,9 @@ ANDROID_DIR := $(SRC_DIR)/build-android include $(CLEAR_VARS) LOCAL_MODULE := layer_utils LOCAL_SRC_FILES += $(LVL_DIR)/layers/vk_layer_config.cpp -LOCAL_SRC_FILES += $(LVL_DIR)/layers/vk_layer_extension_utils.cpp -LOCAL_SRC_FILES += $(LVL_DIR)/layers/vk_layer_logging.cpp -LOCAL_SRC_FILES += $(LVL_DIR)/layers/vk_layer_utils.cpp +LOCAL_SRC_FILES += $(LVL_DIR)/layers/utils/vk_layer_extension_utils.cpp +LOCAL_SRC_FILES += $(LVL_DIR)/layers/error_message/logging.cpp +LOCAL_SRC_FILES += $(LVL_DIR)/layers/utils/vk_layer_utils.cpp LOCAL_SRC_FILES += $(LVL_DIR)/layers/generated/vk_format_utils.cpp LOCAL_SRC_FILES += $(SRC_DIR)/vku/vk_layer_settings.cpp LOCAL_C_INCLUDES += $(LOCAL_PATH)/$(THIRD_PARTY)/Vulkan-Headers/include \ diff --git a/build-android/vulkan-headers_revision_android b/build-android/vulkan-headers_revision_android index 916242a8aa..605c663054 100644 --- a/build-android/vulkan-headers_revision_android +++ b/build-android/vulkan-headers_revision_android @@ -1 +1 @@ -v1.3.243 +v1.3.246 diff --git a/build-android/vulkan-tools_revision_android b/build-android/vulkan-tools_revision_android index 916242a8aa..605c663054 100644 --- a/build-android/vulkan-tools_revision_android +++ b/build-android/vulkan-tools_revision_android @@ -1 +1 @@ -v1.3.243 +v1.3.246 diff --git a/build-android/vulkan-validationlayers_revision_android b/build-android/vulkan-validationlayers_revision_android index 506e28f7dd..ba2906d066 100644 --- a/build-android/vulkan-validationlayers_revision_android +++ b/build-android/vulkan-validationlayers_revision_android @@ -1 +1 @@ -v1.3.243 \ No newline at end of file +main diff --git a/build-android/vulkan-validationlayers_url_android b/build-android/vulkan-validationlayers_url_android index 93c7902d76..7fd7fccc62 100644 --- a/build-android/vulkan-validationlayers_url_android +++ b/build-android/vulkan-validationlayers_url_android @@ -1 +1 @@ -https://github.com/KhronosGroup/Vulkan-ValidationLayers.git \ No newline at end of file +https://github.com/KhronosGroup/Vulkan-ValidationLayers.git diff --git a/layer_factory/demo_layer/demo.h b/layer_factory/demo_layer/demo.h index a5256461a7..fc7b8383b9 100644 --- a/layer_factory/demo_layer/demo.h +++ b/layer_factory/demo_layer/demo.h @@ -21,7 +21,7 @@ #include #include "vulkan/vulkan.h" -#include "vk_layer_logging.h" +#include "error_message/logging.h" #include "layer_factory.h" class MemDemo : public layer_factory { diff --git a/layersvt/api_dump.h b/layersvt/api_dump.h index abff6c4890..972527ea34 100644 --- a/layersvt/api_dump.h +++ b/layersvt/api_dump.h @@ -30,8 +30,8 @@ #include "vulkan/vk_layer.h" #include "vk_layer_config.h" #include "vk_layer_table.h" -#include "vk_layer_extension_utils.h" -#include "vk_layer_utils.h" +#include "utils/vk_layer_extension_utils.h" +#include "utils/vk_layer_utils.h" // Include the video headers so we can print types that come from them #include "vk_video/vulkan_video_codecs_common.h" diff --git a/layersvt/monitor.cpp b/layersvt/monitor.cpp index 8e706b8102..4462f361a2 100644 --- a/layersvt/monitor.cpp +++ b/layersvt/monitor.cpp @@ -20,15 +20,15 @@ * Author: Chris Forbes * Author: Tony Barbour */ -#include "vk_layer_data.h" -#include "vk_layer_extension_utils.h" +#include "containers/custom_containers.h" +#include "utils/vk_layer_extension_utils.h" #include "vk_layer_table.h" #include #include #include #include #include -#include +#include #include #include diff --git a/layersvt/screenshot.cpp b/layersvt/screenshot.cpp index feb52a0289..b9743371c9 100755 --- a/layersvt/screenshot.cpp +++ b/layersvt/screenshot.cpp @@ -35,12 +35,12 @@ using namespace std; -#include "vk_dispatch_table_helper.h" -#include "vk_enum_string_helper.h" +#include "generated/vk_dispatch_table_helper.h" +#include "generated/vk_enum_string_helper.h" #include "vk_layer_config.h" #include "vk_layer_table.h" -#include "vk_layer_extension_utils.h" -#include "vk_layer_utils.h" +#include "utils/vk_layer_extension_utils.h" +#include "utils/vk_layer_utils.h" #include "screenshot_parsing.h" diff --git a/layersvt/vk_layer_table.cpp b/layersvt/vk_layer_table.cpp index 6b8ac11123..0367989374 100644 --- a/layersvt/vk_layer_table.cpp +++ b/layersvt/vk_layer_table.cpp @@ -19,7 +19,7 @@ */ #include #include -#include "vk_dispatch_table_helper.h" +#include "generated/vk_dispatch_table_helper.h" #include "vulkan/vk_layer.h" #include "vk_layer_table.h" static device_table_map tableMap; diff --git a/layersvt/vk_layer_table.h b/layersvt/vk_layer_table.h index e142c657b0..49d286b81d 100644 --- a/layersvt/vk_layer_table.h +++ b/layersvt/vk_layer_table.h @@ -22,7 +22,7 @@ #include "vulkan/vk_layer.h" #include "vulkan/vulkan.h" #include -#include "vk_layer_utils.h" +#include "utils/vk_layer_utils.h" typedef std::unordered_map device_table_map; typedef std::unordered_map instance_table_map; diff --git a/scripts/known_good.json b/scripts/known_good.json index 577ec90e70..dab2a6eca8 100644 --- a/scripts/known_good.json +++ b/scripts/known_good.json @@ -6,7 +6,7 @@ "sub_dir" : "Vulkan-Headers", "build_dir" : "Vulkan-Headers/build", "install_dir" : "Vulkan-Headers/build/install", - "commit": "v1.3.243" + "commit": "v1.3.246" }, { "name" : "Vulkan-Loader", @@ -14,7 +14,7 @@ "sub_dir" : "Vulkan-Loader", "build_dir" : "Vulkan-Loader/build", "install_dir" : "Vulkan-Loader/build/install", - "commit": "v1.3.243", + "commit": "v1.3.246", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", @@ -35,7 +35,7 @@ "sub_dir" : "Vulkan-Tools", "build_dir" : "Vulkan-Tools/build", "install_dir" : "Vulkan-Tools/build/install", - "commit": "v1.3.243", + "commit": "v1.3.246", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", @@ -60,7 +60,7 @@ "sub_dir" : "Vulkan-ValidationLayers", "build_dir" : "Vulkan-ValidationLayers/build", "install_dir" : "Vulkan-ValidationLayers/build/install", - "commit": "v1.3.243", + "commit": "main", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", diff --git a/scripts/layer_factory_generator.py b/scripts/layer_factory_generator.py index ca8ea99d33..1d6ddf7d42 100644 --- a/scripts/layer_factory_generator.py +++ b/scripts/layer_factory_generator.py @@ -183,12 +183,12 @@ class LayerFactoryOutputGenerator(OutputGenerator): #define VALIDATION_ERROR_MAP_IMPL -#include "vk_dispatch_table_helper.h" -#include "vk_layer_data.h" -#include "vk_layer_extension_utils.h" -#include "vk_layer_logging.h" -#include "vk_extension_helper.h" -#include "vk_layer_utils.h" +#include "generated/vk_dispatch_table_helper.h" +#include "containers/custom_containers.h" +#include "utils/vk_layer_extension_utils.h" +#include "error_message/logging.h" +#include "generated/vk_extension_helper.h" +#include "utils/vk_layer_utils.h" class layer_factory; std::vector global_interceptor_list; diff --git a/scripts/vlf_makefile_generator.py b/scripts/vlf_makefile_generator.py index 5b9b2e9b2f..508e961b21 100644 --- a/scripts/vlf_makefile_generator.py +++ b/scripts/vlf_makefile_generator.py @@ -76,7 +76,7 @@ contents += 'include $(CLEAR_VARS)\n' contents += 'LOCAL_MODULE := VkLayer_%s\n' % factory_layer contents += 'LOCAL_SRC_FILES += $(LAYER_DIR)/include/layer_factory.cpp\n' - contents += 'LOCAL_SRC_FILES += $(LVL_DIR)/layers/xxhash.cpp\n' + contents += 'LOCAL_SRC_FILES += $(LVL_DIR)/layers/external/xxhash.cpp\n' # Add *.cpp files (if any) to makefile dependencies for path, subdirs, files in os.walk(factory_layer): for file in files: From 8af893b52f34488affc39c3fa0d43cf8e564dda2 Mon Sep 17 00:00:00 2001 From: Tony-LunarG Date: Tue, 11 Apr 2023 14:59:34 -0600 Subject: [PATCH 070/154] build: Bump VVL known good for next SDK --- scripts/known_good.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/known_good.json b/scripts/known_good.json index dab2a6eca8..e8166b38a0 100644 --- a/scripts/known_good.json +++ b/scripts/known_good.json @@ -60,7 +60,7 @@ "sub_dir" : "Vulkan-ValidationLayers", "build_dir" : "Vulkan-ValidationLayers/build", "install_dir" : "Vulkan-ValidationLayers/build/install", - "commit": "main", + "commit": "2629e0aa17ec5892d7b6953ab8b322a88f14fb18", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", From de85eb0ae34f82ca5c47d29c54d7992bcd4791ce Mon Sep 17 00:00:00 2001 From: Christophe Date: Mon, 17 Apr 2023 12:56:25 +0200 Subject: [PATCH 071/154] vkconfig: add display of deviceUUID and driverUUID --- vkconfig/CHANGELOG.md | 7 +++- vkconfig/vulkan_util.cpp | 80 ++++++++++++++++++++++++++++++++++----- vkconfig_core/version.cpp | 2 +- 3 files changed, 77 insertions(+), 12 deletions(-) diff --git a/vkconfig/CHANGELOG.md b/vkconfig/CHANGELOG.md index 80ee3acfdf..b3c42e585e 100644 --- a/vkconfig/CHANGELOG.md +++ b/vkconfig/CHANGELOG.md @@ -11,7 +11,12 @@ # Release notes -## [Vulkan Configurator 2.5.3](https://github.com/LunarG/VulkanTools/tree/main) - March 2023 +## [Vulkan Configurator 2.5.4](https://github.com/LunarG/VulkanTools/tree/main) - Mai 2023 + +### Improvements: +- Display `deviceUUID` and `driverUUID` in the "Development Status" when available for each physical device + +## [Vulkan Configurator 2.5.3](https://github.com/LunarG/VulkanTools/tree/sdk-1.3.243.0) - March 2023 ### Improvements: - Enabling fully generic layer settings for the validation layer settings diff --git a/vkconfig/vulkan_util.cpp b/vkconfig/vulkan_util.cpp index 80382c9593..0abf13e721 100644 --- a/vkconfig/vulkan_util.cpp +++ b/vkconfig/vulkan_util.cpp @@ -50,6 +50,16 @@ static const char *GetPhysicalDeviceType(VkPhysicalDeviceType type) { return translation[type]; } +std::string GetUUIDString(const uint8_t deviceUUID[VK_UUID_SIZE]) { + std::string result; + + for (std::size_t i = 0, n = VK_UUID_SIZE; i < n; ++i) { + result += format("%02X", deviceUUID[i]); + } + + return result; +} + Version GetVulkanLoaderVersion() { // Check loader version QLibrary library(GetVulkanLibrary()); @@ -99,14 +109,17 @@ VkResult CreateInstance(QLibrary &library, VkInstance &instance, bool enumerate_ // Handle Portability Enumeration requirements std::vector instance_extensions; -#if VK_KHR_portability_enumeration + for (std::size_t i = 0, n = instance_properties.size(); i < n && enumerate_portability; ++i) { - if (instance_properties[i].extensionName == std::string(VK_KHR_PORTABILITY_ENUMERATION_EXTENSION_NAME)) { + if (instance_properties[i].extensionName == std::string(VK_KHR_EXTERNAL_MEMORY_CAPABILITIES_EXTENSION_NAME)) { + instance_extensions.push_back(VK_KHR_EXTERNAL_MEMORY_CAPABILITIES_EXTENSION_NAME); + } +#if VK_KHR_portability_enumeration + else if (instance_properties[i].extensionName == std::string(VK_KHR_PORTABILITY_ENUMERATION_EXTENSION_NAME)) { instance_extensions.push_back(VK_KHR_PORTABILITY_ENUMERATION_EXTENSION_NAME); - break; } - } #endif + } // Check Vulkan Devices @@ -117,7 +130,7 @@ VkResult CreateInstance(QLibrary &library, VkInstance &instance, bool enumerate_ app.applicationVersion = 0; app.pEngineName = VKCONFIG_SHORT_NAME; app.engineVersion = 0; - app.apiVersion = VK_API_VERSION_1_0; + app.apiVersion = VK_API_VERSION_1_1; VkInstanceCreateInfo inst_info = {}; inst_info.sType = VK_STRUCTURE_TYPE_INSTANCE_CREATE_INFO; @@ -252,11 +265,38 @@ std::string GenerateVulkanStatus() { PFN_vkEnumeratePhysicalDevices vkEnumeratePhysicalDevices = (PFN_vkEnumeratePhysicalDevices)library.resolve("vkEnumeratePhysicalDevices"); + assert(vkEnumeratePhysicalDevices); + + PFN_vkEnumerateInstanceExtensionProperties vkEnumerateInstanceExtensionProperties = + (PFN_vkEnumerateInstanceExtensionProperties)library.resolve("vkEnumerateInstanceExtensionProperties"); + assert(vkEnumerateInstanceExtensionProperties); + + VkResult result = VK_SUCCESS; + + uint32_t instance_extension_count = 0; + result = vkEnumerateInstanceExtensionProperties(nullptr, &instance_extension_count, nullptr); + + std::vector instance_extensions; + if (instance_extension_count > 0) { + instance_extensions.resize(instance_extension_count); + } + result = vkEnumerateInstanceExtensionProperties(nullptr, &instance_extension_count, instance_extensions.data()); + + bool has_device_id = false; + if (result == VK_SUCCESS) { + for (std::size_t i = 0, n = instance_extensions.size(); i < n; ++i) { + if (instance_extensions[i].extensionName == std::string(VK_KHR_EXTERNAL_MEMORY_CAPABILITIES_EXTENSION_NAME)) { + has_device_id = true; + break; + } + } + } uint32_t gpu_count = 0; err = vkEnumeratePhysicalDevices(inst, &gpu_count, NULL); PFN_vkDestroyInstance vkDestroyInstance = (PFN_vkDestroyInstance)library.resolve("vkDestroyInstance"); + assert(vkDestroyInstance); // This can fail on a new Linux setup. Check and fail gracefully rather than crash. if (err != VK_SUCCESS) { @@ -273,16 +313,36 @@ std::string GenerateVulkanStatus() { err = vkEnumeratePhysicalDevices(inst, &gpu_count, &devices[0]); assert(!err); - PFN_vkGetPhysicalDeviceProperties vkGetPhysicalDeviceProperties = + PFN_vkGetPhysicalDeviceProperties pfnGetPhysicalDeviceProperties = (PFN_vkGetPhysicalDeviceProperties)library.resolve("vkGetPhysicalDeviceProperties"); + assert(pfnGetPhysicalDeviceProperties); log += "- Physical Devices:\n"; for (std::size_t i = 0, n = devices.size(); i < n; ++i) { VkPhysicalDeviceProperties properties; - vkGetPhysicalDeviceProperties(devices[i], &properties); - log += format(" - %s (%s) with Vulkan %d.%d.%d\n", properties.deviceName, GetPhysicalDeviceType(properties.deviceType), - VK_VERSION_MAJOR(properties.apiVersion), VK_VERSION_MINOR(properties.apiVersion), - VK_VERSION_PATCH(properties.apiVersion)); + pfnGetPhysicalDeviceProperties(devices[i], &properties); + + const std::string vk_version = format("%d.%d.%d", VK_VERSION_MAJOR(properties.apiVersion), + VK_VERSION_MINOR(properties.apiVersion), VK_VERSION_PATCH(properties.apiVersion)); + + log += format(" - %s with Vulkan %s\n", properties.deviceName, vk_version.c_str()); + + if (has_device_id) { + PFN_vkGetPhysicalDeviceProperties2 pfnGetPhysicalDeviceProperties2 = + (PFN_vkGetPhysicalDeviceProperties2)library.resolve("vkGetPhysicalDeviceProperties2"); + assert(pfnGetPhysicalDeviceProperties2); + + VkPhysicalDeviceIDPropertiesKHR properties_deviceid{VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_ID_PROPERTIES_KHR}; + VkPhysicalDeviceProperties2 properties2{VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_PROPERTIES_2, &properties_deviceid}; + + pfnGetPhysicalDeviceProperties2(devices[i], &properties2); + + const std::string deviceUUID = GetUUIDString(properties_deviceid.deviceUUID); + log += format(" - deviceUUID: %s\n", deviceUUID.c_str()); + + const std::string driverUUID = GetUUIDString(properties_deviceid.driverUUID); + log += format(" - driverUUID: %s\n", driverUUID.c_str()); + } } vkDestroyInstance(inst, NULL); diff --git a/vkconfig_core/version.cpp b/vkconfig_core/version.cpp index 69c3c2ac42..02ecd62e98 100644 --- a/vkconfig_core/version.cpp +++ b/vkconfig_core/version.cpp @@ -28,7 +28,7 @@ #include #include -const Version Version::VKCONFIG(2, 5, 3); +const Version Version::VKCONFIG(2, 5, 4); const Version Version::LAYER_CONFIG(2, 2, 3); #ifdef VK_HEADER_VERSION_COMPLETE const Version Version::VKHEADER(VK_HEADER_VERSION_COMPLETE); From b30383cfa35fa876b16db1176640a54d0552235d Mon Sep 17 00:00:00 2001 From: Christophe Date: Mon, 17 Apr 2023 19:18:29 +0200 Subject: [PATCH 072/154] vkconfig: fix Reload Default when unselected config #1811 Change-Id: I3ba6385ec06392abaa928ef6c3e5d4c40b6ed108 --- vkconfig/mainwindow.cpp | 1 - vkconfig/widget_setting_string.cpp | 7 ++++++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/vkconfig/mainwindow.cpp b/vkconfig/mainwindow.cpp index 144cc39899..b2eda8e8d4 100644 --- a/vkconfig/mainwindow.cpp +++ b/vkconfig/mainwindow.cpp @@ -907,7 +907,6 @@ void MainWindow::ReloadDefaultClicked(ConfigurationListItem *item) { configurator.configurations.ReloadDefaultsConfigurations(configurator.layers.available_layers); LoadConfigurationList(); - _settings_tree_manager.CreateGUI(ui->settings_tree); } } diff --git a/vkconfig/widget_setting_string.cpp b/vkconfig/widget_setting_string.cpp index 3397182004..a7ceb2edac 100644 --- a/vkconfig/widget_setting_string.cpp +++ b/vkconfig/widget_setting_string.cpp @@ -32,7 +32,12 @@ WidgetSettingString::WidgetSettingString(QTreeWidget* tree, QTreeWidgetItem* ite assert(&meta); this->field->setText(this->data().value.c_str()); - this->field->setFont(tree->font()); + QFont font = tree->font(); + if (meta.key == "force_device_uuid") { + font.setFamily("Consolas"); + font.setPointSize(10); + } + this->field->setFont(font); this->field->setToolTip(this->field->text()); this->field->show(); From 87cfd8755b17c92117ba2e81325ac9cdb7178521 Mon Sep 17 00:00:00 2001 From: Christophe Date: Mon, 17 Apr 2023 18:52:44 +0200 Subject: [PATCH 073/154] vkconfig: add built-in variation to list physical devices Change-Id: If5015161ecccc491b77805dde57cbbd9ac8a659d --- vkconfig/configurator.cpp | 2 ++ vkconfig/configurator.h | 3 +++ vkconfig/mainwindow.cpp | 5 +---- vkconfig/vulkan_util.cpp | 5 +++++ vkconfig/widget_setting_enum.cpp | 32 ++++++++++++++++++++++++++++++++ 5 files changed, 43 insertions(+), 4 deletions(-) diff --git a/vkconfig/configurator.cpp b/vkconfig/configurator.cpp index 6400809f8f..7cf7a49e2d 100644 --- a/vkconfig/configurator.cpp +++ b/vkconfig/configurator.cpp @@ -166,3 +166,5 @@ void Configurator::ResetToDefault(bool hard) { this->configurations.RefreshConfiguration(this->layers.available_layers); } + +std::vector Configurator::GetDeviceNames() const { return device_names; } diff --git a/vkconfig/configurator.h b/vkconfig/configurator.h index 25dc68a085..1bcc3fd1c5 100644 --- a/vkconfig/configurator.h +++ b/vkconfig/configurator.h @@ -52,6 +52,8 @@ class Configurator { std::string profile_file; + std::vector GetDeviceNames() const; + private: Configurator(const std::string& VULKAN_SDK); ~Configurator(); @@ -66,5 +68,6 @@ class Configurator { Environment environment; LayerManager layers; ConfigurationManager configurations; + std::vector device_names; bool request_vulkan_status; }; diff --git a/vkconfig/mainwindow.cpp b/vkconfig/mainwindow.cpp index b2eda8e8d4..a7bc1543e8 100644 --- a/vkconfig/mainwindow.cpp +++ b/vkconfig/mainwindow.cpp @@ -321,10 +321,7 @@ void MainWindow::LoadConfigurationList() { ui->configuration_tree->resizeColumnToContents(0); ui->configuration_tree->resizeColumnToContents(1); - if (configurator.configurations.HasActiveConfiguration(configurator.layers.available_layers)) { - _settings_tree_manager.CreateGUI(ui->settings_tree); - } - + configurator.request_vulkan_status = true; this->UpdateUI(); } diff --git a/vkconfig/vulkan_util.cpp b/vkconfig/vulkan_util.cpp index 0abf13e721..d801b247c8 100644 --- a/vkconfig/vulkan_util.cpp +++ b/vkconfig/vulkan_util.cpp @@ -317,6 +317,9 @@ std::string GenerateVulkanStatus() { (PFN_vkGetPhysicalDeviceProperties)library.resolve("vkGetPhysicalDeviceProperties"); assert(pfnGetPhysicalDeviceProperties); + Configurator &configurator_edit = Configurator::Get(); + configurator_edit.device_names.clear(); + log += "- Physical Devices:\n"; for (std::size_t i = 0, n = devices.size(); i < n; ++i) { VkPhysicalDeviceProperties properties; @@ -343,6 +346,8 @@ std::string GenerateVulkanStatus() { const std::string driverUUID = GetUUIDString(properties_deviceid.driverUUID); log += format(" - driverUUID: %s\n", driverUUID.c_str()); } + + configurator_edit.device_names.push_back(properties.deviceName); } vkDestroyInstance(inst, NULL); diff --git a/vkconfig/widget_setting_enum.cpp b/vkconfig/widget_setting_enum.cpp index bca8588370..d0f356fd3c 100644 --- a/vkconfig/widget_setting_enum.cpp +++ b/vkconfig/widget_setting_enum.cpp @@ -86,6 +86,28 @@ void WidgetSettingEnum::Refresh(RefreshAreas refresh_areas) { } this->field->setCurrentIndex(selection); this->field->blockSignals(false); + } else if (meta.default_value == "${VP_PHYSICAL_DEVICES}") { + if (::CheckSettingOverridden(this->meta)) { + this->DisplayOverride(this->field, this->meta); + } + + this->field->blockSignals(true); + this->field->clear(); + this->enum_indexes.clear(); + + const std::vector& devices = Configurator::Get().GetDeviceNames(); + + int selection = 0; + const std::string value = this->data().value; + for (std::size_t i = 0, n = devices.size(); i < n; ++i) { + this->field->addItem(devices[i].c_str()); + if (devices[i] == value) { + selection = static_cast(this->enum_indexes.size()); + } + this->enum_indexes.push_back(i); + } + this->field->setCurrentIndex(selection); + this->field->blockSignals(false); } else if (refresh_areas == REFRESH_ENABLE_AND_STATE) { if (::CheckSettingOverridden(this->meta)) { this->DisplayOverride(this->field, this->meta); @@ -123,6 +145,11 @@ void WidgetSettingEnum::resizeEvent(QResizeEvent* event) { width = std::max(width, HorizontalAdvance(fm, (profiles[i] + "0000").c_str())); } this->item->setHidden(profiles.size() <= 1); + } else if (meta.default_value == "${VP_PHYSICAL_DEVICES}") { + const std::vector& devices = Configurator::Get().GetDeviceNames(); + for (std::size_t i = 0, n = devices.size(); i < n; ++i) { + width = std::max(width, HorizontalAdvance(fm, (devices[i] + "0000").c_str())); + } } else { for (std::size_t i = 0, n = this->meta.enum_values.size(); i < n; ++i) { width = std::max(width, HorizontalAdvance(fm, (this->meta.enum_values[i].label + "0000").c_str())); @@ -140,6 +167,11 @@ void WidgetSettingEnum::OnIndexChanged(int index) { this->data().value = profiles[index]; this->item->setHidden(profiles.size() <= 1); + } else if (meta.default_value == "${VP_PHYSICAL_DEVICES}") { + const std::vector& devices = Configurator::Get().GetDeviceNames(); + assert(index >= 0 && index < static_cast(devices.size())); + + this->data().value = devices[index]; } else { assert(index >= 0 && index < static_cast(this->meta.enum_values.size())); From 766b77520d97505c304b8731dc83b065975a2f53 Mon Sep 17 00:00:00 2001 From: Christophe Date: Tue, 18 Apr 2023 18:29:08 +0200 Subject: [PATCH 074/154] vkconfig: fix force physical device Change-Id: Ic3db8f511a920d747477509010a2ff7a7ca13c49 --- vkconfig/widget_setting_enum.cpp | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/vkconfig/widget_setting_enum.cpp b/vkconfig/widget_setting_enum.cpp index d0f356fd3c..47d4ec61a6 100644 --- a/vkconfig/widget_setting_enum.cpp +++ b/vkconfig/widget_setting_enum.cpp @@ -101,7 +101,8 @@ void WidgetSettingEnum::Refresh(RefreshAreas refresh_areas) { const std::string value = this->data().value; for (std::size_t i = 0, n = devices.size(); i < n; ++i) { this->field->addItem(devices[i].c_str()); - if (devices[i] == value) { + if (devices[i] == value || "${VP_PHYSICAL_DEVICES}" == value) { + this->data().value = devices[i]; selection = static_cast(this->enum_indexes.size()); } this->enum_indexes.push_back(i); From c27c724bc67f72399d757751bca76eef743462aa Mon Sep 17 00:00:00 2001 From: Christophe Date: Wed, 19 Apr 2023 11:57:55 +0200 Subject: [PATCH 075/154] vkconfig: add default physical device selection config Change-Id: I2220f5ef0ba97ecaeb951fcee7484f2ad2d2c374 --- vkconfig/resources.qrc | 1 + .../2.2.2/Physical Device Selection.json | 118 ++++++++++++++++++ 2 files changed, 119 insertions(+) create mode 100644 vkconfig_core/configurations/2.2.2/Physical Device Selection.json diff --git a/vkconfig/resources.qrc b/vkconfig/resources.qrc index 5fac311a0b..c6d067fb93 100644 --- a/vkconfig/resources.qrc +++ b/vkconfig/resources.qrc @@ -7,6 +7,7 @@ ../vkconfig_core/configurations/2.2.2/API dump.json ../vkconfig_core/configurations/2.2.2/Frame Capture.json + ../vkconfig_core/configurations/2.2.2/Physical Device Selection.json ../vkconfig_core/configurations/2.2.2/Portability.json ../vkconfig_core/configurations/2.2.2/Synchronization.json ../vkconfig_core/configurations/2.2.2/Validation.json diff --git a/vkconfig_core/configurations/2.2.2/Physical Device Selection.json b/vkconfig_core/configurations/2.2.2/Physical Device Selection.json new file mode 100644 index 0000000000..556fc10d8c --- /dev/null +++ b/vkconfig_core/configurations/2.2.2/Physical Device Selection.json @@ -0,0 +1,118 @@ +{ + "configuration": { + "description": "Forced Physical Device Selection", + "layers": [ + { + "name": "VK_LAYER_KHRONOS_profiles", + "platforms": [ + "WINDOWS", + "LINUX", + "MACOS" + ], + "rank": 0, + "settings": [ + { + "key": "force_device", + "type": "ENUM", + "value": "FORCE_DEVICE_WITH_NAME" + }, + { + "key": "force_device_uuid", + "type": "STRING", + "value": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" + }, + { + "key": "force_device_name", + "type": "ENUM", + "value": "${VP_PHYSICAL_DEVICES}" + }, + { + "key": "profile_file", + "type": "LOAD_FILE", + "value": "" + }, + { + "key": "profile_name", + "type": "ENUM", + "value": "" + }, + { + "key": "profile_validation", + "type": "BOOL", + "value": false + }, + { + "key": "simulate_capabilities", + "type": "FLAGS", + "value": [ + ] + }, + { + "key": "default_feature_values", + "type": "ENUM", + "value": "DEFAULT_FEATURE_VALUES_DEVICE" + }, + { + "key": "emulate_portability", + "type": "BOOL", + "value": false + }, + { + "key": "exclude_device_extensions", + "type": "LIST", + "value": [ + ] + }, + { + "key": "exclude_formats", + "type": "LIST", + "value": [ + ] + }, + { + "key": "debug_actions", + "type": "FLAGS", + "value": [ + "DEBUG_ACTION_STDOUT_BIT" + ] + }, + { + "key": "debug_filename", + "type": "SAVE_FILE", + "value": "profiles_layer_log.txt" + }, + { + "key": "debug_file_clear", + "type": "BOOL", + "value": true + }, + { + "key": "debug_fail_on_error", + "type": "BOOL", + "value": false + }, + { + "key": "debug_reports", + "type": "FLAGS", + "value": [ + "DEBUG_REPORT_WARNING_BIT", + "DEBUG_REPORT_ERROR_BIT", + "DEBUG_REPORT_NOTIFICATION_BIT" + ] + } + ], + "state": "OVERRIDDEN" + } + ], + "layers_paths": [ + ], + "name": "Physical Device Selection", + "platforms": [ + "WINDOWS", + "LINUX", + "MACOS" + ], + "view_advanced_settings": false + }, + "file_format_version": "2.2.3" +} From 3e68939194e25c4462034ba334c620eebe54a574 Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Fri, 21 Apr 2023 19:22:45 -0600 Subject: [PATCH 076/154] android ci: Use specific validation layer commit During various fixes to this repo, the android CI version was moved to main, which fixed the issues that we were seeing at the time. Now that the dust has settled, its time to move it back to a stable version. The version was chosen corresponding to about where the validation was when this repo was set to main. --- build-android/vulkan-validationlayers_revision_android | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/build-android/vulkan-validationlayers_revision_android b/build-android/vulkan-validationlayers_revision_android index ba2906d066..c91c7fea12 100644 --- a/build-android/vulkan-validationlayers_revision_android +++ b/build-android/vulkan-validationlayers_revision_android @@ -1 +1 @@ -main +c935d1e214006b40743647572144c2ce3882e4aa From 590a64242a87fd15e74b1a940623ad675bbcdfc5 Mon Sep 17 00:00:00 2001 From: David Pinedo Date: Fri, 21 Apr 2023 16:21:43 -0600 Subject: [PATCH 077/154] vkconfig doc: Change output of "Setting Type" & "Setting Default Value" Changed code so these values are displayed on separate lines --- vkconfig_core/doc.cpp | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/vkconfig_core/doc.cpp b/vkconfig_core/doc.cpp index 0dc4b049fd..78db07f0b3 100644 --- a/vkconfig_core/doc.cpp +++ b/vkconfig_core/doc.cpp @@ -155,12 +155,12 @@ static void WriteSettingsDetailsHtml(std::string& text, const Layer& layer, cons text += format("\t
  • Setting Level: %s
    • \n", GetToken(setting->view)); } - text += "\n"; - text += format( - "\t

    Setting Type: %s - Setting Default Value: %s

    \n", + "\t
  • Setting Type: %s
    • \n\t
  • Setting Default Value: %s
    • \n", GetToken(setting->type), setting->Export(EXPORT_MODE_DOC).c_str()); + text += "\n"; + if (IsEnum(setting->type) || IsFlags(setting->type)) { const SettingMetaEnumeration& setting_enum = static_cast(*setting); if (setting_enum.enum_values.size() > 0) { @@ -223,13 +223,13 @@ static void WriteSettingsDetailsMarkdown(std::string& text, const Layer& layer, } else { text += "- Environment Variable: " + setting->env + "\n"; } - text += "- Platforms: " + BuildPlatformsMarkdown(setting->platform_flags) + "\n\n"; + text += "- Platforms: " + BuildPlatformsMarkdown(setting->platform_flags) + "\n"; if (setting->view != SETTING_VIEW_STANDARD) { - text += format("Setting Level: %s\n", GetToken(setting->view)); + text += format("- Setting Level: %s\n", GetToken(setting->view)); } - text += format("Setting Type: %s - Setting Default Value: %s\n", GetToken(setting->type), + text += format("- Setting Type: %s\n- Setting Default Value: %s\n\n", GetToken(setting->type), setting->Export(EXPORT_MODE_DOC).c_str()); if (IsEnum(setting->type) || IsFlags(setting->type)) { From a33f5696dcac7ba42ca76eba1041664bc8665e80 Mon Sep 17 00:00:00 2001 From: Jason Macnak Date: Fri, 21 Apr 2023 15:00:08 -0700 Subject: [PATCH 078/154] Make update_object_name_map() update on name re-assignment The emplace() function will not update the value in the map if it is already present. --- layersvt/api_dump.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/layersvt/api_dump.h b/layersvt/api_dump.h index 972527ea34..6e13b6de33 100644 --- a/layersvt/api_dump.h +++ b/layersvt/api_dump.h @@ -837,13 +837,13 @@ class ApiDumpInstance { void update_object_name_map(const VkDebugMarkerObjectNameInfoEXT *pNameInfo) { if (pNameInfo->pObjectName) - object_name_map.emplace(pNameInfo->object, pNameInfo->pObjectName); + object_name_map[pNameInfo->object] = pNameInfo->pObjectName; else object_name_map.erase(pNameInfo->object); } void update_object_name_map(const VkDebugUtilsObjectNameInfoEXT *pNameInfo) { if (pNameInfo->pObjectName) - object_name_map.emplace(pNameInfo->objectHandle, pNameInfo->pObjectName); + object_name_map[pNameInfo->objectHandle] = pNameInfo->pObjectName; else object_name_map.erase(pNameInfo->objectHandle); } From c8af5963a4030c7c5c9e55b2fb7dc92dcf6008c8 Mon Sep 17 00:00:00 2001 From: Tony-LunarG Date: Mon, 1 May 2023 10:49:06 -0600 Subject: [PATCH 079/154] build: Update to 1.3.249 headers --- build-android/vulkan-headers_revision_android | 2 +- build-android/vulkan-tools_revision_android | 2 +- build-android/vulkan-validationlayers_revision_android | 2 +- scripts/known_good.json | 8 ++++---- scripts/layer_factory_generator.py | 2 +- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/build-android/vulkan-headers_revision_android b/build-android/vulkan-headers_revision_android index 605c663054..56628d7589 100644 --- a/build-android/vulkan-headers_revision_android +++ b/build-android/vulkan-headers_revision_android @@ -1 +1 @@ -v1.3.246 +v1.3.249 diff --git a/build-android/vulkan-tools_revision_android b/build-android/vulkan-tools_revision_android index 605c663054..56628d7589 100644 --- a/build-android/vulkan-tools_revision_android +++ b/build-android/vulkan-tools_revision_android @@ -1 +1 @@ -v1.3.246 +v1.3.249 diff --git a/build-android/vulkan-validationlayers_revision_android b/build-android/vulkan-validationlayers_revision_android index c91c7fea12..56628d7589 100644 --- a/build-android/vulkan-validationlayers_revision_android +++ b/build-android/vulkan-validationlayers_revision_android @@ -1 +1 @@ -c935d1e214006b40743647572144c2ce3882e4aa +v1.3.249 diff --git a/scripts/known_good.json b/scripts/known_good.json index e8166b38a0..b6e8f604de 100644 --- a/scripts/known_good.json +++ b/scripts/known_good.json @@ -6,7 +6,7 @@ "sub_dir" : "Vulkan-Headers", "build_dir" : "Vulkan-Headers/build", "install_dir" : "Vulkan-Headers/build/install", - "commit": "v1.3.246" + "commit": "v1.3.249" }, { "name" : "Vulkan-Loader", @@ -14,7 +14,7 @@ "sub_dir" : "Vulkan-Loader", "build_dir" : "Vulkan-Loader/build", "install_dir" : "Vulkan-Loader/build/install", - "commit": "v1.3.246", + "commit": "v1.3.249", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", @@ -35,7 +35,7 @@ "sub_dir" : "Vulkan-Tools", "build_dir" : "Vulkan-Tools/build", "install_dir" : "Vulkan-Tools/build/install", - "commit": "v1.3.246", + "commit": "v1.3.249", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", @@ -60,7 +60,7 @@ "sub_dir" : "Vulkan-ValidationLayers", "build_dir" : "Vulkan-ValidationLayers/build", "install_dir" : "Vulkan-ValidationLayers/build/install", - "commit": "2629e0aa17ec5892d7b6953ab8b322a88f14fb18", + "commit": "v1.3.249", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", diff --git a/scripts/layer_factory_generator.py b/scripts/layer_factory_generator.py index 1d6ddf7d42..592804db26 100644 --- a/scripts/layer_factory_generator.py +++ b/scripts/layer_factory_generator.py @@ -613,7 +613,7 @@ def beginFile(self, genOpts): self.layer_factory += ' }\n' self.layer_factory += '\n' self.layer_factory += ' bool Error(const std::string &message) {\n' - self.layer_factory += ' return log_msg(vlf_report_data, kDebugBit, VK_OBJECT_TYPE_UNKNOWN, 0,\n' + self.layer_factory += ' return log_msg(vlf_report_data, kVerboseBit, VK_OBJECT_TYPE_UNKNOWN, 0,\n' self.layer_factory += ' layer_name.c_str(), "%s", message.c_str());\n' self.layer_factory += ' }\n' self.layer_factory += '\n' From 8f03e5af278e064b4e96309b752cf217ca9abfcf Mon Sep 17 00:00:00 2001 From: Tony-LunarG Date: Mon, 1 May 2023 13:00:24 -0600 Subject: [PATCH 080/154] build: Use python3 specifically in update scripts --- build-android/update_external_sources_android.bat | 2 +- build-android/update_external_sources_android.sh | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/build-android/update_external_sources_android.bat b/build-android/update_external_sources_android.bat index fb5853adee..f52987bf58 100755 --- a/build-android/update_external_sources_android.bat +++ b/build-android/update_external_sources_android.bat @@ -228,7 +228,7 @@ goto:eof echo. echo Building %JSONCPP_DIR% cd %JSONCPP_DIR% - python amalgamate.py + python3 amalgamate.py if not exist %JSONCPP_DIR%\dist\json\json.h ( echo. diff --git a/build-android/update_external_sources_android.sh b/build-android/update_external_sources_android.sh index 6e0ba85f98..c5e541c3d9 100755 --- a/build-android/update_external_sources_android.sh +++ b/build-android/update_external_sources_android.sh @@ -112,7 +112,7 @@ function update_jsoncpp () { function build_jsoncpp () { echo "Building ${BASEDIR}/jsoncpp" cd ${BASEDIR}/jsoncpp - python amalgamate.py + python3 amalgamate.py } function create_vulkan-headers () { From 40e15167cb09fd919884cb495d849ed400b680f5 Mon Sep 17 00:00:00 2001 From: Mark Young Date: Tue, 9 May 2023 10:58:22 -0600 Subject: [PATCH 081/154] Fix JSON output on Mac M1 The MacOS on the M1 produced a product version that seems to have a tab in it which messes up VkVia. Attempt to fix this. --- via/via_system_macos.cpp | 21 ++++++++------------- 1 file changed, 8 insertions(+), 13 deletions(-) diff --git a/via/via_system_macos.cpp b/via/via_system_macos.cpp index 8fe4837995..87a4d19574 100644 --- a/via/via_system_macos.cpp +++ b/via/via_system_macos.cpp @@ -21,6 +21,7 @@ #ifdef VIA_MACOS_TARGET #include +#include #include #include @@ -124,10 +125,8 @@ ViaSystem::ViaResults ViaSystemMacOS::PrintSystemEnvironmentInfo() { } if (NULL != strstr(path, "ProductName")) { index = strlen("ProductName:"); - while (path[index] == ' ' || path[index] == '\t' || path[index] == '\"') { - index++; - } _os_name = &path[index]; + _os_name.erase(std::remove_if(_os_name.begin(), _os_name.end(), ::isspace), _os_name.end()); PrintBeginTableRow(); PrintTableElement("MacOS"); PrintTableElement(""); @@ -140,10 +139,8 @@ ViaSystem::ViaResults ViaSystemMacOS::PrintSystemEnvironmentInfo() { PrintEndTableRow(); } else if (NULL != strstr(path, "ProductVersion")) { index = strlen("ProductVersion:"); - while (path[index] == ' ' || path[index] == '\t' || path[index] == '\"') { - index++; - } std::string _os_version = &path[index]; + _os_version.erase(std::remove_if(_os_version.begin(), _os_version.end(), ::isspace), _os_version.end()); PrintBeginTableRow(); PrintTableElement(""); PrintTableElement("Product Version"); @@ -151,10 +148,8 @@ ViaSystem::ViaResults ViaSystemMacOS::PrintSystemEnvironmentInfo() { PrintEndTableRow(); } else if (NULL != strstr(path, "BuildVersion")) { index = strlen("BuildVersion:"); - while (path[index] == ' ' || path[index] == '\t' || path[index] == '\"') { - index++; - } std::string _build_version = &path[index]; + _build_version.erase(std::remove_if(_build_version.begin(), _build_version.end(), ::isspace), _build_version.end()); PrintBeginTableRow(); PrintTableElement(""); PrintTableElement("Build Version"); @@ -315,8 +310,8 @@ ViaSystem::ViaResults ViaSystemMacOS::PrintSystemExecutableInfo() { PrintBeginTableRow(); PrintTableElement("Vulkan API Version"); PrintTableElement(std::to_string(VK_API_VERSION_MAJOR(VK_HEADER_VERSION_COMPLETE)) + "." + - std::to_string(VK_API_VERSION_MINOR(VK_HEADER_VERSION_COMPLETE)) + "." + - std::to_string(VK_API_VERSION_PATCH(VK_HEADER_VERSION_COMPLETE))); + std::to_string(VK_API_VERSION_MINOR(VK_HEADER_VERSION_COMPLETE)) + "." + + std::to_string(VK_API_VERSION_PATCH(VK_HEADER_VERSION_COMPLETE))); PrintEndTableRow(); PrintBeginTableRow(); @@ -603,7 +598,7 @@ bool ViaSystemMacOS::ReadDriverJson(std::string cur_driver_json, bool &found_lib return found_json; } -void ViaSystemMacOS::PrintDriverEnvVarInfo(const char* var, bool& found_json, bool& found_lib) { +void ViaSystemMacOS::PrintDriverEnvVarInfo(const char *var, bool &found_json, bool &found_lib) { bool found_this_lib = false; char *env_var_value = getenv(var); if (NULL != env_var_value) { @@ -1179,7 +1174,7 @@ ViaSystem::ViaResults ViaSystemMacOS::PrintSystemImplicitLayerInfo() { return result; } -ViaSystem::ViaResults ViaSystemMacOS::PrintLayerEnvVar(const char* var) { +ViaSystem::ViaResults ViaSystemMacOS::PrintLayerEnvVar(const char *var) { ViaResults result = VIA_SUCCESSFUL; // Look at the environment variable paths if it is set. From 5e7f7188152cdfdb687b622ea78a6f884062d22e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcin=20Zaj=C4=85c?= Date: Thu, 27 Apr 2023 17:43:36 +0200 Subject: [PATCH 082/154] Update version.h Fix for multiple compilation errors on Fedora 38 g++ (GCC) 13.0.1 due to the lack of cstdint include --- vkconfig_core/version.h | 1 + 1 file changed, 1 insertion(+) diff --git a/vkconfig_core/version.h b/vkconfig_core/version.h index 634644ac17..e752795189 100644 --- a/vkconfig_core/version.h +++ b/vkconfig_core/version.h @@ -22,6 +22,7 @@ #pragma once #include +#include #include #define SUPPORT_LAYER_CONFIG_2_2_0 1 From f793437cf844380f030d7f381d01ad460bbe0a06 Mon Sep 17 00:00:00 2001 From: Tony-LunarG Date: Thu, 18 May 2023 14:52:26 -0600 Subject: [PATCH 083/154] build: Update to 1.3.250 headers --- build-android/vulkan-headers_revision_android | 2 +- build-android/vulkan-tools_revision_android | 2 +- build-android/vulkan-validationlayers_revision_android | 2 +- scripts/known_good.json | 8 ++++---- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/build-android/vulkan-headers_revision_android b/build-android/vulkan-headers_revision_android index 56628d7589..6a7aec1145 100644 --- a/build-android/vulkan-headers_revision_android +++ b/build-android/vulkan-headers_revision_android @@ -1 +1 @@ -v1.3.249 +v1.3.250 diff --git a/build-android/vulkan-tools_revision_android b/build-android/vulkan-tools_revision_android index 56628d7589..6a7aec1145 100644 --- a/build-android/vulkan-tools_revision_android +++ b/build-android/vulkan-tools_revision_android @@ -1 +1 @@ -v1.3.249 +v1.3.250 diff --git a/build-android/vulkan-validationlayers_revision_android b/build-android/vulkan-validationlayers_revision_android index 56628d7589..6a7aec1145 100644 --- a/build-android/vulkan-validationlayers_revision_android +++ b/build-android/vulkan-validationlayers_revision_android @@ -1 +1 @@ -v1.3.249 +v1.3.250 diff --git a/scripts/known_good.json b/scripts/known_good.json index b6e8f604de..a4f49ca9cb 100644 --- a/scripts/known_good.json +++ b/scripts/known_good.json @@ -6,7 +6,7 @@ "sub_dir" : "Vulkan-Headers", "build_dir" : "Vulkan-Headers/build", "install_dir" : "Vulkan-Headers/build/install", - "commit": "v1.3.249" + "commit": "v1.3.250" }, { "name" : "Vulkan-Loader", @@ -14,7 +14,7 @@ "sub_dir" : "Vulkan-Loader", "build_dir" : "Vulkan-Loader/build", "install_dir" : "Vulkan-Loader/build/install", - "commit": "v1.3.249", + "commit": "v1.3.250", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", @@ -35,7 +35,7 @@ "sub_dir" : "Vulkan-Tools", "build_dir" : "Vulkan-Tools/build", "install_dir" : "Vulkan-Tools/build/install", - "commit": "v1.3.249", + "commit": "v1.3.250", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", @@ -60,7 +60,7 @@ "sub_dir" : "Vulkan-ValidationLayers", "build_dir" : "Vulkan-ValidationLayers/build", "install_dir" : "Vulkan-ValidationLayers/build/install", - "commit": "v1.3.249", + "commit": "v1.3.250", "deps" : [ { "var_name" : "VULKAN_HEADERS_INSTALL_DIR", From d7e07482428e5b9f26c17654506c2c97e1a0c28d Mon Sep 17 00:00:00 2001 From: Pierre Moreau Date: Sun, 21 May 2023 14:29:41 +0200 Subject: [PATCH 084/154] build: Address typos in BUILD.md --- BUILD.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/BUILD.md b/BUILD.md index 6318f88a76..82a6310d48 100644 --- a/BUILD.md +++ b/BUILD.md @@ -214,7 +214,7 @@ To use, simply push it to the device and run it. The resulting json file will b ## The VulkanTools repository -### Cloning the repository and updaing subcomponents +### Cloning the repository and updating subcomponents To create your local git repository of VulkanTools: ``` From d45474700c9c41608667960c2377bd7ffdbe34b3 Mon Sep 17 00:00:00 2001 From: Pierre Moreau Date: Sun, 21 May 2023 14:30:00 +0200 Subject: [PATCH 085/154] vkconfig: Address typos in CHANGELOG.md --- vkconfig/CHANGELOG.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/vkconfig/CHANGELOG.md b/vkconfig/CHANGELOG.md index b3c42e585e..19b6100892 100644 --- a/vkconfig/CHANGELOG.md +++ b/vkconfig/CHANGELOG.md @@ -11,7 +11,7 @@ # Release notes -## [Vulkan Configurator 2.5.4](https://github.com/LunarG/VulkanTools/tree/main) - Mai 2023 +## [Vulkan Configurator 2.5.4](https://github.com/LunarG/VulkanTools/tree/main) - May 2023 ### Improvements: - Display `deviceUUID` and `driverUUID` in the "Development Status" when available for each physical device @@ -96,7 +96,7 @@ - Discard applied layers configuration to ensure the layers never crash Vulkan Configurator ### Fixes: -- Fix 'Edit Layers' button being enabled when there is no active copnfiguration #1616 +- Fix 'Edit Layers' button being enabled when there is no active configuration #1616 ## [Vulkan Configurator 2.4.1](https://github.com/LunarG/VulkanTools/tree/sdk-1.2.189.0) - September 2021 @@ -132,7 +132,7 @@ - Fix validation layer bool setting written in 'vk_layer-setting.txt' #1551 - Fix upgrade of 'vkcube' path when the path is no longer valid -## [Vulkan Configurator 2.3.0](https://github.com/LunarG/VulkanTools/tree/sdk-1.2.176.0) - Mai 2021 +## [Vulkan Configurator 2.3.0](https://github.com/LunarG/VulkanTools/tree/sdk-1.2.176.0) - May 2021 ### Features: - Add Vulkan loader debug message to application launcher #1372 @@ -223,7 +223,7 @@ ## [Vulkan Configurator 2.0.2](https://github.com/LunarG/VulkanTools/tree/sdk-1.2.154.0) - October 2020 ### Features: -- Add multiple debug actions simulaneously #1119 +- Add multiple debug actions simultaneously #1119 - Add better representation of the layers execution order #1181 ### Improvements: @@ -241,17 +241,17 @@ ### Fixes: - Fix disabled configurations that can't be reenabled or removed - Fix display of custom layer paths #1101 -- Fix inconsistant display of separators in paths #1107 +- Fix inconsistent display of separators in paths #1107 - Fix display of empty entries in the custom path dialog when opening Json files that are not layer json files #1103 - Fix log file default location to `HOME` to ensure write access #1083 - Fix log file not written to #1109 -- Fix `debug_output` setting displayed on Linux and macOS but not avaiable #1086 +- Fix `debug_output` setting displayed on Linux and macOS but not available #1086 - Fix `numeric_bool` setting display #1166 ## [Vulkan Configurator 2.0.1](https://github.com/LunarG/VulkanTools/tree/sdk-1.2.148.1) - August 2020 (revision 1) ### Fixes: -- Fix *Shader Printf* built-in configuration that was setup for *GPU-Assisted* validation isntead +- Fix *Shader Printf* built-in configuration that was setup for *GPU-Assisted* validation instead - Fix layer configurations selection on Linux - Fix debug output setting not working From 936f56b4df7ec07596af02a4be636e46b1269320 Mon Sep 17 00:00:00 2001 From: Christophe Date: Thu, 25 May 2023 11:18:39 +0200 Subject: [PATCH 086/154] vkconfig: fix validation layer settings Change-Id: I5f6434d125b56eb1586471005df9d2cea990aec3 --- vkconfig/dialog_layers.cpp | 4 +++- vkconfig/settings_tree.cpp | 17 +---------------- vkconfig/settings_tree.h | 2 -- vkconfig/widget_setting_filesystem.cpp | 7 ++++++- vkconfig_core/override.cpp | 12 ++++++++++++ vkconfig_core/parameter.cpp | 15 +++++++++++++++ vkconfig_core/parameter.h | 2 ++ vkconfig_core/path.cpp | 11 ++++++++--- vkconfig_core/path.h | 2 ++ vkconfig_core/setting_filesystem.cpp | 9 +++++++-- 10 files changed, 56 insertions(+), 25 deletions(-) diff --git a/vkconfig/dialog_layers.cpp b/vkconfig/dialog_layers.cpp index 428e298848..58f2e2e0cc 100644 --- a/vkconfig/dialog_layers.cpp +++ b/vkconfig/dialog_layers.cpp @@ -88,7 +88,9 @@ static bool IsDLL32Bit(const std::string full_path) { if (full_path.empty()) return false; QFile file(full_path.c_str()); - if (!file.open(QIODevice::ReadOnly)) return false; // punt... + if (!file.open(QIODevice::ReadOnly)) { + return false; // punt... + } // Not gonna lie, just guessed 1024 and it was enough. // This is the minimum page size on any OS (I might be wrong, diff --git a/vkconfig/settings_tree.cpp b/vkconfig/settings_tree.cpp index 2851e69152..fd174334f3 100644 --- a/vkconfig/settings_tree.cpp +++ b/vkconfig/settings_tree.cpp @@ -52,21 +52,6 @@ static const char *TOOLTIP_ORDER = SettingsTreeManager::SettingsTreeManager() : tree(nullptr) {} -bool SettingsTreeManager::UseBuiltinValidationUI(Parameter ¶meter) const { - if (parameter.key != "VK_LAYER_KHRONOS_validation") { - return false; - } - - for (std::size_t j = 0, m = parameter.settings.size(); j < m; ++j) { - const SettingData *setting_data = parameter.settings[j]; - if (setting_data->key == "validation_control") { - return false; - } - } - - return true; -} - void SettingsTreeManager::CreateGUI(QTreeWidget *build_tree) { assert(build_tree); @@ -152,7 +137,7 @@ void SettingsTreeManager::CreateGUI(QTreeWidget *build_tree) { this->connect(presets_combobox, SIGNAL(itemChanged()), this, SLOT(OnPresetChanged())); } - if (UseBuiltinValidationUI(parameter)) { + if (UseBuiltinValidationSettings(parameter)) { BuildValidationTree(layer_item, parameter); } else { BuildGenericTree(layer_item, parameter); diff --git a/vkconfig/settings_tree.h b/vkconfig/settings_tree.h index 9dcf6f62ef..9ae1d9ab95 100644 --- a/vkconfig/settings_tree.h +++ b/vkconfig/settings_tree.h @@ -57,8 +57,6 @@ class SettingsTreeManager : QObject { SettingsTreeManager(const SettingsTreeManager &) = delete; SettingsTreeManager &operator=(const SettingsTreeManager &) = delete; - bool UseBuiltinValidationUI(Parameter ¶meter) const; - void BuildValidationTree(QTreeWidgetItem *parent, Parameter ¶meter); void BuildGenericTree(QTreeWidgetItem *parent, Parameter ¶meter); void BuildTreeItem(QTreeWidgetItem *parent, Parameter ¶meter, const SettingMeta &meta); diff --git a/vkconfig/widget_setting_filesystem.cpp b/vkconfig/widget_setting_filesystem.cpp index 909ec0eeea..0c6d465c7f 100644 --- a/vkconfig/widget_setting_filesystem.cpp +++ b/vkconfig/widget_setting_filesystem.cpp @@ -137,6 +137,10 @@ void WidgetSettingFilesystem::browseButtonClicked() { file = ConvertNativeSeparators(file); LoadFile(file); + if (VKC_ENV == VKC_ENV_WIN32) { + file = ConvertSeparators(file, "/", GetNativeSeparator()); + } + this->data().value = file; field->setText(this->data().value.c_str()); @@ -146,7 +150,8 @@ void WidgetSettingFilesystem::browseButtonClicked() { } void WidgetSettingFilesystem::textFieldChanged(const QString& value) { - this->data().value = value.toStdString(); + std::string file = value.toStdString(); + this->data().value = file; this->field->setToolTip(this->field->text()); emit itemChanged(); diff --git a/vkconfig_core/override.cpp b/vkconfig_core/override.cpp index 028abd8885..5d27ce5bdc 100644 --- a/vkconfig_core/override.cpp +++ b/vkconfig_core/override.cpp @@ -186,6 +186,8 @@ bool WriteSettingsOverride(const std::vector& available_layers, const Con if (parameter.state != LAYER_STATE_OVERRIDDEN) continue; + const bool use_builtin_validation = UseBuiltinValidationSettings(parameter); + stream << "\n"; stream << "# " << layer->key.c_str() << "\n\n"; @@ -199,6 +201,16 @@ bool WriteSettingsOverride(const std::vector& available_layers, const Con continue; } + if (!use_builtin_validation) { + if (setting_data->key == "enables") { + continue; + } + + if (setting_data->key == "disables") { + continue; + } + } + // Skip missing settings const SettingMeta* meta = FindSetting(layer->settings, setting_data->key.c_str()); if (meta == nullptr) { diff --git a/vkconfig_core/parameter.cpp b/vkconfig_core/parameter.cpp index 5a052e82ab..d4ce30dd8c 100644 --- a/vkconfig_core/parameter.cpp +++ b/vkconfig_core/parameter.cpp @@ -225,3 +225,18 @@ std::vector GatherParameters(const std::vector& parameters return gathered_parameters; } + +bool UseBuiltinValidationSettings(const Parameter& parameter) { + if (parameter.key != "VK_LAYER_KHRONOS_validation") { + return false; + } + + for (std::size_t j = 0, m = parameter.settings.size(); j < m; ++j) { + const SettingData* setting_data = parameter.settings[j]; + if (setting_data->key == "validation_control") { + return false; + } + } + + return true; +} diff --git a/vkconfig_core/parameter.h b/vkconfig_core/parameter.h index c965765541..ff5477e493 100644 --- a/vkconfig_core/parameter.h +++ b/vkconfig_core/parameter.h @@ -67,3 +67,5 @@ bool HasMissingLayer(const std::vector& parameters, const std::vector std::size_t CountOverriddenLayers(const std::vector& parameters); std::size_t CountExcludedLayers(const std::vector& parameters, const std::vector& layers); + +bool UseBuiltinValidationSettings(const Parameter& parameter); diff --git a/vkconfig_core/path.cpp b/vkconfig_core/path.cpp index 69c6328f78..ea42738d59 100644 --- a/vkconfig_core/path.cpp +++ b/vkconfig_core/path.cpp @@ -219,10 +219,8 @@ std::string ReplaceBuiltInVariable(const std::string& path) { return path; } -std::string ConvertNativeSeparators(const std::string& path) { - const char* native_separator = GetNativeSeparator(); +std::string ConvertSeparators(const std::string& path, const char* native_separator, const char* alien_separator) { const std::size_t native_separator_size = std::strlen(native_separator); - const char* alien_separator = VKC_ENV != VKC_ENV_WIN32 ? "\\" : "/"; const std::size_t alien_separator_size = std::strlen(alien_separator); std::string current_path = path; @@ -250,6 +248,13 @@ const char* GetNativeSeparator() { return native_separator; } +std::string ConvertNativeSeparators(const std::string& path) { + const char* native_separator = GetNativeSeparator(); + const char* alien_separator = VKC_ENV != VKC_ENV_WIN32 ? "\\" : "/"; + + return ConvertSeparators(path, native_separator, alien_separator); +} + static bool IsPortableChar(char c) { if (c == '\\' || c == '/') return false; if (c == '|' || c == '<' || c == '>') return false; diff --git a/vkconfig_core/path.h b/vkconfig_core/path.h index bfafe2ec85..df1cad0121 100644 --- a/vkconfig_core/path.h +++ b/vkconfig_core/path.h @@ -59,6 +59,8 @@ class Path { std::string data; }; +std::string ConvertSeparators(const std::string& path, const char* native_separator, const char* alien_separator); + std::string ConvertNativeSeparators(const std::string& path); const char* GetNativeSeparator(); diff --git a/vkconfig_core/setting_filesystem.cpp b/vkconfig_core/setting_filesystem.cpp index 7dfa13dd0e..cf715b1e18 100644 --- a/vkconfig_core/setting_filesystem.cpp +++ b/vkconfig_core/setting_filesystem.cpp @@ -66,8 +66,13 @@ std::string SettingDataFilesystem::Export(ExportMode export_mode) const { default: assert(0); return ""; - case EXPORT_MODE_OVERRIDE: - return ReplaceBuiltInVariable(this->value).c_str(); + case EXPORT_MODE_OVERRIDE: { + std::string file = this->value; + if (VKC_ENV == VKC_ENV_WIN32) { + file = ConvertSeparators(file, "/", GetNativeSeparator()); + } + return ReplaceBuiltInVariable(file).c_str(); + } case EXPORT_MODE_DOC: return this->value; } From 27a6735339b03c211d28d5c405147ef195bae728 Mon Sep 17 00:00:00 2001 From: Christophe Date: Thu, 25 May 2023 12:01:56 +0200 Subject: [PATCH 087/154] vkconfig: fix QFSFileEngine::open: No file name specified messages Change-Id: I4ab20ab3094ec15b9704f455af229822669ca1a3 --- vkconfig_core/environment.cpp | 4 +++- vkconfig_core/json_validator.cpp | 1 - vkconfig_core/path.cpp | 4 ++++ 3 files changed, 7 insertions(+), 2 deletions(-) diff --git a/vkconfig_core/environment.cpp b/vkconfig_core/environment.cpp index 498923c5f8..fe3a255f60 100644 --- a/vkconfig_core/environment.cpp +++ b/vkconfig_core/environment.cpp @@ -523,7 +523,9 @@ bool ExactExecutableFromAppBundle(std::string& app_path) { path += "/Contents/"; std::string list_file = path + "Info.plist"; QFile file(list_file.c_str()); - if (!file.open(QIODevice::ReadOnly | QIODevice::Text)) return false; + if (!file.open(QIODevice::ReadOnly | QIODevice::Text)) { + return false; + } QTextStream stream(&file); diff --git a/vkconfig_core/json_validator.cpp b/vkconfig_core/json_validator.cpp index 4291c2ac37..95c9fd5eec 100644 --- a/vkconfig_core/json_validator.cpp +++ b/vkconfig_core/json_validator.cpp @@ -22,7 +22,6 @@ #include "json.h" #include "util.h" -#include #include #include diff --git a/vkconfig_core/path.cpp b/vkconfig_core/path.cpp index ea42738d59..58d6bd1ef3 100644 --- a/vkconfig_core/path.cpp +++ b/vkconfig_core/path.cpp @@ -303,6 +303,10 @@ static std::vector LoadProfiles(const QJsonDocument& doc) { std::vector GetProfileNames(const std::string& profile_path) { const std::string& value = ReplaceBuiltInVariable(profile_path); + if (value.empty()) { + return std::vector(); + } + const QJsonDocument& doc = ParseJsonFile(value.c_str()); if (doc.isNull() || doc.isEmpty()) { From 9423666d808985b2f5738511e1b3e94cdafdc78d Mon Sep 17 00:00:00 2001 From: Christophe Date: Thu, 25 May 2023 15:56:06 +0200 Subject: [PATCH 088/154] vkconfig: fix profile name invalid init Change-Id: I25493632e09a00aff42baf4c8f6ea33f9a497fea --- vkconfig/widget_setting_filesystem.cpp | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/vkconfig/widget_setting_filesystem.cpp b/vkconfig/widget_setting_filesystem.cpp index 0c6d465c7f..1f4c093379 100644 --- a/vkconfig/widget_setting_filesystem.cpp +++ b/vkconfig/widget_setting_filesystem.cpp @@ -103,6 +103,7 @@ void WidgetSettingFilesystem::LoadFile(const std::string& path) { file_setting_data.profile_names = GetProfileNames(path); SettingDataString* enum_setting_data = FindSetting(this->data_set, "profile_name"); + enum_setting_data->value.clear(); if (!file_setting_data.profile_names.empty() && enum_setting_data != nullptr) { enum_setting_data->value = file_setting_data.profile_names[0]; } @@ -135,12 +136,6 @@ void WidgetSettingFilesystem::browseButtonClicked() { if (!file.empty()) { file = ConvertNativeSeparators(file); - LoadFile(file); - - if (VKC_ENV == VKC_ENV_WIN32) { - file = ConvertSeparators(file, "/", GetNativeSeparator()); - } - this->data().value = file; field->setText(this->data().value.c_str()); @@ -151,6 +146,15 @@ void WidgetSettingFilesystem::browseButtonClicked() { void WidgetSettingFilesystem::textFieldChanged(const QString& value) { std::string file = value.toStdString(); + + if (!file.empty()) { + LoadFile(file); + + if (VKC_ENV == VKC_ENV_WIN32) { + file = ConvertSeparators(file, "/", GetNativeSeparator()); + } + } + this->data().value = file; this->field->setToolTip(this->field->text()); From 697dd5b05fd68ca2862d0e46b6609fa46e2aa303 Mon Sep 17 00:00:00 2001 From: Christophe Date: Wed, 31 May 2023 16:49:03 +0200 Subject: [PATCH 089/154] cmake: move jsoncpp to knowngood to simply build steps Change-Id: I49729560d3929a88539b8051c1a60719e1ea76ec --- CMakeLists.txt | 32 +++----------------------------- layersvt/CMakeLists.txt | 2 -- scripts/known_good.json | 18 +++++++++++++++++- via/CMakeLists.txt | 12 ++++-------- 4 files changed, 24 insertions(+), 40 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 2bb4514cde..209f3ec39b 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -139,9 +139,6 @@ endif() set (VULKAN_SDK $ENV{VULKAN_SDK}) -# NOTE: jsoncpp is located in SUBPROJECTS_DIR. -set (SUBPROJECTS_DIR ${CMAKE_CURRENT_SOURCE_DIR}/submodules) - set(VULKANTOOLS_SCRIPTS_DIR ${CMAKE_CURRENT_SOURCE_DIR}/scripts) find_package(VulkanHeaders REQUIRED CONFIG) @@ -157,9 +154,11 @@ if (VULKAN_LOADER_INSTALL_DIR) elseif(ENV{VULKAN_LOADER_INSTALL_DIR}) message(STATUS "VULKAN_LOADER_INSTALL_DIR environment variable specified, using find_package to locate Vulkan") endif() -set(CMAKE_PREFIX_PATH ${CMAKE_PREFIX_PATH};${VULKAN_LOADER_INSTALL_DIR};${VULKAN_HEADERS_INSTALL_DIR};$ENV{VULKAN_LOADER_INSTALL_DIR};$ENV{VULKAN_HEADERS_INSTALL_DIR}) +set(CMAKE_PREFIX_PATH ${CMAKE_PREFIX_PATH};${VULKAN_LOADER_INSTALL_DIR};${VULKAN_HEADERS_INSTALL_DIR};${JSONCPP_INSTALL_DIR};$ENV{VULKAN_LOADER_INSTALL_DIR};$ENV{VULKAN_HEADERS_INSTALL_DIR};$ENV{JSONCPP_INSTALL_DIR}) find_package(Vulkan) +find_package(jsoncpp REQUIRED CONFIG) + if (CMAKE_SYSTEM_NAME STREQUAL "Windows" OR CMAKE_SYSTEM_NAME STREQUAL "Linux" OR CMAKE_SYSTEM_NAME MATCHES "BSD") @@ -188,31 +187,6 @@ elseif (CMAKE_SYSTEM_NAME STREQUAL "Darwin") endif() -find_path(JSONCPP_INCLUDE_DIR json/json.h HINTS "${SUBPROJECTS_DIR}/jsoncpp/dist" - "${SUBPROJECTS_DIR}/JsonCpp/dist" - "${SUBPROJECTS_DIR}/JsonCPP/dist" - "${SUBPROJECTS_DIR}/JSONCPP/dist" - "${CMAKE_SOURCE_DIR}/../jsoncpp/dist" - DOC "Path to jsoncpp/dist/json/json.h") - -find_path(JSONCPP_SOURCE_DIR jsoncpp.cpp HINTS "${SUBPROJECTS_DIR}/jsoncpp/dist" - "${SUBPROJECTS_DIR}/JsonCpp/dist" - "${SUBPROJECTS_DIR}/JsonCPP/dist" - "${SUBPROJECTS_DIR}/JSONCPP/dist" - "${CMAKE_SOURCE_DIR}/../jsoncpp/dist" - DOC "Path to jsoncpp/dist/jsoncpp.cpp") - -find_library(JSONCPP_LIB NAMES jsoncpp HINTS ${JSONCPP_SEARCH_PATH} ) - -if (WIN32) - add_library(jsoncpp STATIC IMPORTED) - find_library(JSONCPP_DLIB NAMES jsoncpp - HINTS ${JSONCPP_DEBUG_SEARCH_PATH} ) - set_target_properties(jsoncpp PROPERTIES - IMPORTED_LOCATION "${JSONCPP_LIB}" - IMPORTED_LOCATION_DEBUG "${JSONCPP_DLIB}") -endif() - # Define macro used for building vk.xml generated files function(run_vulkantools_vk_xml_generate dependency output) add_custom_command(OUTPUT ${output} diff --git a/layersvt/CMakeLists.txt b/layersvt/CMakeLists.txt index 85b1609b06..131db4076c 100644 --- a/layersvt/CMakeLists.txt +++ b/layersvt/CMakeLists.txt @@ -108,7 +108,6 @@ if (APPLE) ${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_BINARY_DIR} ${Vulkan-ValidationLayers_INCLUDE_DIR} - ${JSONCPP_INCLUDE_DIR} ) else () include_directories( @@ -116,7 +115,6 @@ else () ${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_BINARY_DIR} ${Vulkan-ValidationLayers_INCLUDE_DIR} - ${JSONCPP_INCLUDE_DIR} ) endif() diff --git a/scripts/known_good.json b/scripts/known_good.json index a4f49ca9cb..8fa2dd9102 100644 --- a/scripts/known_good.json +++ b/scripts/known_good.json @@ -74,11 +74,27 @@ "cmake_options" : [ "-DBUILD_TESTS=FALSE","-DBUILD_LAYERS=OFF","-DBUILD_LAYER_SUPPORT_FILES=ON","-DUSE_ROBIN_HOOD_HASHING=OFF" ] + }, + { + "name": "jsoncpp", + "url": "https://github.com/open-source-parsers/jsoncpp.git", + "sub_dir": "jsoncpp", + "build_dir": "jsoncpp/build", + "install_dir": "jsoncpp/build/install", + "commit": "1.9.5", + "cmake_options": [ + "-DCMAKE_POSITION_INDEPENDENT_CODE=ON", + "-DJSONCPP_WITH_TESTS=OFF", + "-DJSONCPP_WITH_POST_BUILD_UNITTEST=OFF", + "-DJSONCPP_WITH_WARNING_AS_ERROR=OFF", + "-DJSONCPP_WITH_PKGCONFIG_SUPPORT=OFF" + ] } ], "install_names" : { "Vulkan-Headers" : "VULKAN_HEADERS_INSTALL_DIR", "Vulkan-Loader" : "VULKAN_LOADER_INSTALL_DIR", - "Vulkan-ValidationLayers" : "VULKAN_VALIDATIONLAYERS_INSTALL_DIR" + "Vulkan-ValidationLayers" : "VULKAN_VALIDATIONLAYERS_INSTALL_DIR", + "jsoncpp": "JSONCPP_INSTALL_DIR" } } diff --git a/via/CMakeLists.txt b/via/CMakeLists.txt index 7b35257b54..680fbb2fef 100644 --- a/via/CMakeLists.txt +++ b/via/CMakeLists.txt @@ -48,16 +48,14 @@ add_executable(vkvia via_system.hpp via_system.cpp via_system_windows.hpp - via_system_windows.cpp - ${JSONCPP_SOURCE_DIR}/jsoncpp.cpp) + via_system_windows.cpp) elseif(APPLE) add_executable(vkvia via.cpp via_system.hpp via_system.cpp via_system_macos.hpp - via_system_macos.cpp - ${JSONCPP_SOURCE_DIR}/jsoncpp.cpp) + via_system_macos.cpp) elseif(UNIX) add_executable(vkvia via.cpp @@ -66,12 +64,10 @@ add_executable(vkvia via_system_linux.hpp via_system_linux.cpp via_system_bsd.hpp - via_system_bsd.cpp - ${JSONCPP_SOURCE_DIR}/jsoncpp.cpp) + via_system_bsd.cpp) endif() -target_include_directories(vkvia PUBLIC ${JSONCPP_INCLUDE_DIR}) -target_link_libraries(vkvia Vulkan::Headers Vulkan::Vulkan ${CMAKE_DL_LIBS}) +target_link_libraries(vkvia Vulkan::Headers Vulkan::Vulkan jsoncpp_static ${CMAKE_DL_LIBS}) if(WIN32) target_link_libraries(vkvia version shlwapi Cfgmgr32) endif() From 363ed387111949ee9400608c66228906d5cbe691 Mon Sep 17 00:00:00 2001 From: Christophe Date: Wed, 31 May 2023 17:14:38 +0200 Subject: [PATCH 090/154] cmake: add Vulkan-Utility-Libraries dependence Change-Id: Ifacbef603d46c0fed7e33f026fec65f7ccb30ea1 --- scripts/known_good.json | 196 ++++++++++++++++++++++------------------ 1 file changed, 107 insertions(+), 89 deletions(-) diff --git a/scripts/known_good.json b/scripts/known_good.json index 8fa2dd9102..4141f95429 100644 --- a/scripts/known_good.json +++ b/scripts/known_good.json @@ -1,100 +1,118 @@ { - "repos" : [ - { - "name" : "Vulkan-Headers", - "url" : "https://github.com/KhronosGroup/Vulkan-Headers.git", - "sub_dir" : "Vulkan-Headers", - "build_dir" : "Vulkan-Headers/build", - "install_dir" : "Vulkan-Headers/build/install", - "commit": "v1.3.250" - }, - { - "name" : "Vulkan-Loader", - "url" : "https://github.com/KhronosGroup/Vulkan-Loader.git", - "sub_dir" : "Vulkan-Loader", - "build_dir" : "Vulkan-Loader/build", - "install_dir" : "Vulkan-Loader/build/install", - "commit": "v1.3.250", - "deps" : [ + "repos": [ { - "var_name" : "VULKAN_HEADERS_INSTALL_DIR", - "repo_name" : "Vulkan-Headers" - } - ], - "cmake_options" : [ - "-DBUILD_TESTS=OFF" - ], - "build_platforms" : [ - "linux", - "darwin" - ] - }, - { - "name" : "Vulkan-Tools", - "url" : "https://github.com/KhronosGroup/Vulkan-Tools.git", - "sub_dir" : "Vulkan-Tools", - "build_dir" : "Vulkan-Tools/build", - "install_dir" : "Vulkan-Tools/build/install", - "commit": "v1.3.250", - "deps" : [ + "name": "Vulkan-Headers", + "url": "https://github.com/KhronosGroup/Vulkan-Headers.git", + "sub_dir": "Vulkan-Headers", + "build_dir": "Vulkan-Headers/build", + "install_dir": "Vulkan-Headers/build/install", + "commit": "v1.3.250" + }, { - "var_name" : "VULKAN_HEADERS_INSTALL_DIR", - "repo_name" : "Vulkan-Headers" + "name": "Vulkan-Utility-Libraries", + "url": "https://github.com/KhronosGroup/Vulkan-Utility-Libraries.git", + "sub_dir": "Vulkan-Utility-Libraries", + "build_dir": "Vulkan-Utility-Libraries/build", + "install_dir": "Vulkan-Utility-Libraries/build/install", + "commit": "main", + "deps": [ + { + "var_name": "VULKAN_HEADERS_INSTALL_DIR", + "repo_name": "Vulkan-Headers" + } + ] }, { - "var_name" : "VULKAN_LOADER_INSTALL_DIR", - "repo_name" : "Vulkan-Loader" - } - ], - "cmake_options" : [ - "-DBUILD_CUBE=OFF" - ], - "build_platforms" : [ - "windows", - "linux" - ] - }, - { - "name" : "Vulkan-ValidationLayers", - "url" : "https://github.com/KhronosGroup/Vulkan-ValidationLayers.git", - "sub_dir" : "Vulkan-ValidationLayers", - "build_dir" : "Vulkan-ValidationLayers/build", - "install_dir" : "Vulkan-ValidationLayers/build/install", - "commit": "v1.3.250", - "deps" : [ + "name": "Vulkan-Loader", + "url": "https://github.com/KhronosGroup/Vulkan-Loader.git", + "sub_dir": "Vulkan-Loader", + "build_dir": "Vulkan-Loader/build", + "install_dir": "Vulkan-Loader/build/install", + "commit": "v1.3.250", + "deps": [ + { + "var_name": "VULKAN_HEADERS_INSTALL_DIR", + "repo_name": "Vulkan-Headers" + } + ], + "cmake_options": [ + "-DBUILD_TESTS=OFF" + ], + "build_platforms": [ + "linux", + "darwin" + ] + }, { - "var_name" : "VULKAN_HEADERS_INSTALL_DIR", - "repo_name" : "Vulkan-Headers" + "name": "Vulkan-Tools", + "url": "https://github.com/KhronosGroup/Vulkan-Tools.git", + "sub_dir": "Vulkan-Tools", + "build_dir": "Vulkan-Tools/build", + "install_dir": "Vulkan-Tools/build/install", + "commit": "v1.3.250", + "deps": [ + { + "var_name": "VULKAN_HEADERS_INSTALL_DIR", + "repo_name": "Vulkan-Headers" + }, + { + "var_name": "VULKAN_LOADER_INSTALL_DIR", + "repo_name": "Vulkan-Loader" + } + ], + "cmake_options": [ + "-DBUILD_CUBE=OFF" + ], + "build_platforms": [ + "windows", + "linux" + ] }, { - "var_name" : "VULKAN_LOADER_INSTALL_DIR", - "repo_name" : "Vulkan-Loader" + "name": "Vulkan-ValidationLayers", + "url": "https://github.com/KhronosGroup/Vulkan-ValidationLayers.git", + "sub_dir": "Vulkan-ValidationLayers", + "build_dir": "Vulkan-ValidationLayers/build", + "install_dir": "Vulkan-ValidationLayers/build/install", + "commit": "v1.3.250", + "deps": [ + { + "var_name": "VULKAN_HEADERS_INSTALL_DIR", + "repo_name": "Vulkan-Headers" + }, + { + "var_name": "VULKAN_LOADER_INSTALL_DIR", + "repo_name": "Vulkan-Loader" + } + ], + "cmake_options": [ + "-DBUILD_TESTS=FALSE", + "-DBUILD_LAYERS=OFF", + "-DBUILD_LAYER_SUPPORT_FILES=ON", + "-DUSE_ROBIN_HOOD_HASHING=OFF" + ] + }, + { + "name": "jsoncpp", + "url": "https://github.com/open-source-parsers/jsoncpp.git", + "sub_dir": "jsoncpp", + "build_dir": "jsoncpp/build", + "install_dir": "jsoncpp/build/install", + "commit": "1.9.5", + "cmake_options": [ + "-DCMAKE_POSITION_INDEPENDENT_CODE=ON", + "-DJSONCPP_WITH_TESTS=OFF", + "-DJSONCPP_WITH_POST_BUILD_UNITTEST=OFF", + "-DJSONCPP_WITH_WARNING_AS_ERROR=OFF", + "-DJSONCPP_WITH_PKGCONFIG_SUPPORT=OFF" + ] } - ], - "cmake_options" : [ - "-DBUILD_TESTS=FALSE","-DBUILD_LAYERS=OFF","-DBUILD_LAYER_SUPPORT_FILES=ON","-DUSE_ROBIN_HOOD_HASHING=OFF" - ] - }, - { - "name": "jsoncpp", - "url": "https://github.com/open-source-parsers/jsoncpp.git", - "sub_dir": "jsoncpp", - "build_dir": "jsoncpp/build", - "install_dir": "jsoncpp/build/install", - "commit": "1.9.5", - "cmake_options": [ - "-DCMAKE_POSITION_INDEPENDENT_CODE=ON", - "-DJSONCPP_WITH_TESTS=OFF", - "-DJSONCPP_WITH_POST_BUILD_UNITTEST=OFF", - "-DJSONCPP_WITH_WARNING_AS_ERROR=OFF", - "-DJSONCPP_WITH_PKGCONFIG_SUPPORT=OFF" - ] - } - ], - "install_names" : { - "Vulkan-Headers" : "VULKAN_HEADERS_INSTALL_DIR", - "Vulkan-Loader" : "VULKAN_LOADER_INSTALL_DIR", - "Vulkan-ValidationLayers" : "VULKAN_VALIDATIONLAYERS_INSTALL_DIR", - "jsoncpp": "JSONCPP_INSTALL_DIR" + ], + "install_names": { + "Vulkan-Headers": "VULKAN_HEADERS_INSTALL_DIR", + "Vulkan-Utility-Libraries": "VULKAN_UTILITY_LIBRARIES_INSTALL_DIR", + "Vulkan-Loader": "VULKAN_LOADER_INSTALL_DIR", + "Vulkan-ValidationLayers": "VULKAN_VALIDATIONLAYERS_INSTALL_DIR", + "jsoncpp": "JSONCPP_INSTALL_DIR" } } From 5b5f250086a8f82827d3e07f41d0511c8d84bdb4 Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Wed, 14 Jun 2023 13:07:07 -0600 Subject: [PATCH 091/154] monitor: Fix windows crash when using renderdoc The monitor layer uses GetWindowText to retrieve the title bar text. This function is effectively SendMessage(WM_GETTEXT), and so has all the same threading behavior of SendMessage. That is fine if the thread calling into monitor layer is able to handle it. But in certain circumstances, calling GetWindowText causes a deadlock, such as when the monitor layer is enabled during the replay of a renderdoc capture. The fix is to move the call of GetWindowText to vkQueuePresentKHR, since that does get called from a thread that can handle GetWindowText. A more robust method would be to not use GetWindowText but instead use Windows API calls that have better threading characteristics. --- layersvt/monitor.cpp | 61 ++++++++++++++++++++++++-------------------- 1 file changed, 34 insertions(+), 27 deletions(-) diff --git a/layersvt/monitor.cpp b/layersvt/monitor.cpp index 4462f361a2..eb5d47d9ca 100644 --- a/layersvt/monitor.cpp +++ b/layersvt/monitor.cpp @@ -32,7 +32,7 @@ #include #include -#if defined(__linux__ ) +#if defined(__linux__) #include #endif @@ -43,38 +43,38 @@ #define TITLE_LENGTH 1000 #define FPS_LENGTH 24 struct monitor_layer_data { - VkLayerDispatchTable *device_dispatch_table; - VkLayerInstanceDispatchTable *instance_dispatch_table; + VkLayerDispatchTable *device_dispatch_table{}; + VkLayerInstanceDispatchTable *instance_dispatch_table{}; - PFN_vkQueuePresentKHR pfnQueuePresentKHR; + PFN_vkQueuePresentKHR pfnQueuePresentKHR{}; #if defined(VK_USE_PLATFORM_WIN32_KHR) - HWND hwnd; + HWND hwnd{}; #elif defined(VK_USE_PLATFORM_XCB_KHR) - xcb_connection_t *connection; - xcb_window_t xcb_window; - bool xcb_fps; + xcb_connection_t *connection{}; + xcb_window_t xcb_window{}; + bool xcb_fps{}; #endif - char base_title[TITLE_LENGTH]; - - VkPhysicalDevice gpu; - VkDevice device; - - PFN_vkSetDeviceLoaderData pfn_dev_init; - int lastFrame; - time_t lastTime; - float fps; - int frame; + char base_title[TITLE_LENGTH]{}; + bool got_title = false; + VkPhysicalDevice gpu{}; + VkDevice device{}; + + PFN_vkSetDeviceLoaderData pfn_dev_init{}; + int lastFrame{}; + time_t lastTime{}; + float fps{}; + int frame{}; }; #if defined(VK_USE_PLATFORM_XCB_KHR) static struct { - void *xcbLib; - decltype(xcb_change_property) *change_property; - decltype(xcb_flush) *flush; - decltype(xcb_get_property) *get_property; - decltype(xcb_get_property_reply) *get_property_reply; - decltype(xcb_get_property_value_length) *get_property_value_length; - decltype(xcb_get_property_value) *get_property_value; + void *xcbLib{}; + decltype(xcb_change_property) *change_property{}; + decltype(xcb_flush) *flush{}; + decltype(xcb_get_property) *get_property{}; + decltype(xcb_get_property_reply) *get_property_reply{}; + decltype(xcb_get_property_value_length) *get_property_value_length{}; + decltype(xcb_get_property_value) *get_property_value{}; } xcb = {NULL}; #endif @@ -255,11 +255,19 @@ VKAPI_ATTR VkResult VKAPI_CALL vkQueuePresentKHR(VkQueue queue, const VkPresentI my_data->fps = (my_data->frame - my_data->lastFrame) / seconds; my_data->lastFrame = my_data->frame; my_data->lastTime = now; +#if defined(VK_USE_PLATFORM_WIN32_KHR) + if (IsWindow(my_instance_data->hwnd) && !my_instance_data->got_title) { + GetWindowText(my_instance_data->hwnd, my_instance_data->base_title, TITLE_LENGTH); + my_instance_data->got_title = true; + } +#endif sprintf(fpsstr, " FPS = %.2f", my_data->fps); strcpy(str, my_instance_data->base_title); strcat(str, fpsstr); #if defined(VK_USE_PLATFORM_WIN32_KHR) - SetWindowText(my_instance_data->hwnd, str); + if (IsWindow(my_instance_data->hwnd)) { + SetWindowText(my_instance_data->hwnd, str); + } #elif defined(VK_USE_PLATFORM_XCB_KHR) if (xcb.xcbLib && my_instance_data->xcb_fps && my_instance_data->connection) { xcb.change_property(my_instance_data->connection, XCB_PROP_MODE_REPLACE, my_instance_data->xcb_window, XCB_ATOM_WM_NAME, @@ -312,7 +320,6 @@ VKAPI_ATTR VkResult VKAPI_CALL vkCreateWin32SurfaceKHR(VkInstance instance, VkSurfaceKHR *pSurface) { monitor_layer_data *my_data = GetLayerDataPtr(get_dispatch_key(instance), layer_data_map); my_data->hwnd = pCreateInfo->hwnd; - GetWindowText(my_data->hwnd, my_data->base_title, TITLE_LENGTH); VkResult result = my_data->instance_dispatch_table->CreateWin32SurfaceKHR(instance, pCreateInfo, pAllocator, pSurface); return result; From c11c2f610d0937c9b793b9a1348797306083364c Mon Sep 17 00:00:00 2001 From: Tony Barbour Date: Mon, 10 Jul 2023 12:58:33 -0600 Subject: [PATCH 092/154] build: Update to 1.3.257 headers Also remove VK_NV_cooperative_matrix and VK_QNX_external_memory_screen_buffer from codegen Also update Qt installer version --- .github/workflows/ci_build.yml | 6 +++--- CMakeLists.txt | 8 ++++---- build-android/android-generate.sh | 10 +++++----- build-android/cmake/layerlib/CMakeLists.txt | 3 ++- build-android/jni/Android.mk | 11 +++++++---- build-android/vulkan-headers_revision_android | 2 +- build-android/vulkan-tools_revision_android | 2 +- .../vulkan-validationlayers_revision_android | 2 +- layersvt/screenshot.cpp | 2 ++ scripts/api_dump_generator.py | 2 ++ scripts/known_good.json | 8 ++++---- scripts/vlf_makefile_generator.py | 3 ++- 12 files changed, 34 insertions(+), 25 deletions(-) diff --git a/.github/workflows/ci_build.yml b/.github/workflows/ci_build.yml index 1a493f5a1d..e166c29a74 100644 --- a/.github/workflows/ci_build.yml +++ b/.github/workflows/ci_build.yml @@ -40,7 +40,7 @@ jobs: } steps: - name: Install Qt - uses: jurplel/install-qt-action@v2 + uses: jurplel/install-qt-action@v3 - name: Clone repository uses: actions/checkout@v1 - name: Execute Source Code Format Checking Script @@ -70,7 +70,7 @@ jobs: } steps: - name: Install Qt - uses: jurplel/install-qt-action@v2 + uses: jurplel/install-qt-action@v3 - name: Clone repository uses: actions/checkout@v1 - name: Install build dependencies @@ -94,7 +94,7 @@ jobs: os: [ windows-latest, windows-2019 ] steps: - name: Install Qt - uses: jurplel/install-qt-action@v2 + uses: jurplel/install-qt-action@v3 - uses: actions/checkout@v2 - uses: actions/setup-python@v2 with: diff --git a/CMakeLists.txt b/CMakeLists.txt index 209f3ec39b..950abcd24f 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -190,16 +190,16 @@ endif() # Define macro used for building vk.xml generated files function(run_vulkantools_vk_xml_generate dependency output) add_custom_command(OUTPUT ${output} - COMMAND ${PYTHON_CMD} -B ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py -registry ${VULKAN_HEADERS_REGISTRY_DIRECTORY}/vk.xml -scripts ${VULKAN_HEADERS_REGISTRY_DIRECTORY} ${output} - DEPENDS ${VULKAN_HEADERS_REGISTRY_DIRECTORY}/vk.xml ${VULKAN_HEADERS_REGISTRY_DIRECTORY}/generator.py ${VULKANTOOLS_SCRIPTS_DIR}/${dependency} ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py ${VULKAN_HEADERS_REGISTRY_DIRECTORY}/reg.py + COMMAND ${PYTHON_CMD} -B ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py -registry ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry/vk.xml -scripts ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry ${output} -removeExtensions VK_NV_cooperative_matrix -removeExtensions VK_QNX_external_memory_screen_buffer + DEPENDS ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry/vk.xml ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry/generator.py ${VULKANTOOLS_SCRIPTS_DIR}/${dependency} ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry/reg.py ) endfunction() # Define macro used for building video.xml generated files function(run_vulkantools_video_xml_generate dependency output) add_custom_command(OUTPUT ${output} - COMMAND ${PYTHON_CMD} -B ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py -registry ${VULKAN_HEADERS_REGISTRY_DIRECTORY}/video.xml -scripts ${VULKAN_HEADERS_REGISTRY_DIRECTORY} ${output} - DEPENDS ${VULKAN_HEADERS_REGISTRY_DIRECTORY}/video.xml ${VULKAN_HEADERS_REGISTRY_DIRECTORY}/generator.py ${VULKANTOOLS_SCRIPTS_DIR}/${dependency} ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py ${VULKAN_HEADERS_REGISTRY_DIRECTORY}/reg.py + COMMAND ${PYTHON_CMD} -B ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py -registry ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry/video.xml -scripts ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry ${output} + DEPENDS ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry/video.xml ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry/generator.py ${VULKANTOOLS_SCRIPTS_DIR}/${dependency} ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry/reg.py ) endfunction() diff --git a/build-android/android-generate.sh b/build-android/android-generate.sh index 29471e0f14..04af03fbe8 100755 --- a/build-android/android-generate.sh +++ b/build-android/android-generate.sh @@ -23,7 +23,7 @@ mkdir -p generated/include generated/common LVL_BASE=$dir/third_party/Vulkan-ValidationLayers LVL_SCRIPTS=${LVL_BASE}/scripts -LVL_GENERATED=${LVL_BASE}/layers/generated +LVL_GENERATED=${LVL_BASE}/layers/vulkan/generated VT_SCRIPTS=../../../scripts REGISTRY_PATH=$dir/third_party/Vulkan-Headers/registry REGISTRY=${REGISTRY_PATH}/vk.xml @@ -50,10 +50,10 @@ echo "Using python: $(which $PYTHON_EXECUTABLE)" ( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vlf_makefile_generator.py ../../../layer_factory ${REGISTRY_PATH}/../include) # apidump -( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump.cpp) -( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_text.h) -( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_html.h) -( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_json.h) +( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump.cpp -removeExtensions VK_NV_cooperative_matrix -removeExtensions VK_QNX_external_memory_screen_buffer) +( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_text.h -removeExtensions VK_NV_cooperative_matrix -removeExtensions VK_QNX_external_memory_screen_buffer) +( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_html.h -removeExtensions VK_NV_cooperative_matrix -removeExtensions VK_QNX_external_memory_screen_buffer) +( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_json.h -removeExtensions VK_NV_cooperative_matrix -removeExtensions VK_QNX_external_memory_screen_buffer) ( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${VIDEO_REGISTRY} -scripts ${REGISTRY_PATH} api_dump_video_text.h) ( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${VIDEO_REGISTRY} -scripts ${REGISTRY_PATH} api_dump_video_html.h) diff --git a/build-android/cmake/layerlib/CMakeLists.txt b/build-android/cmake/layerlib/CMakeLists.txt index 46eb9ce5ad..764acf761c 100644 --- a/build-android/cmake/layerlib/CMakeLists.txt +++ b/build-android/cmake/layerlib/CMakeLists.txt @@ -33,12 +33,13 @@ set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DVK_USE_PLATFORM_ANDROID_KHR \ include_directories(${SRC_DIR}/include ${COMMON_DIR}/include ${SRC_DIR}/layers + ${SRC_DIR}/layers/vulkan ${SRC_DIR}/loader) add_library(layer_utils STATIC ${SRC_DIR}/layers/vk_layer_config.cpp ${SRC_DIR}/layers/vk_layer_extension_utils.cpp ${SRC_DIR}/layers/vk_layer_utils.cpp - ${SRC_DIR}/layers/generated/vk_format_utils.cpp) + ${SRC_DIR}/layers/vulkan/generated/vk_format_utils.cpp) set(CMAKE_CXX_FLAGS "${CMAKE_CXX_clone}") # build core_validation layers diff --git a/build-android/jni/Android.mk b/build-android/jni/Android.mk index 895576ca89..abcc5621d1 100644 --- a/build-android/jni/Android.mk +++ b/build-android/jni/Android.mk @@ -27,13 +27,14 @@ LOCAL_SRC_FILES += $(LVL_DIR)/layers/vk_layer_config.cpp LOCAL_SRC_FILES += $(LVL_DIR)/layers/utils/vk_layer_extension_utils.cpp LOCAL_SRC_FILES += $(LVL_DIR)/layers/error_message/logging.cpp LOCAL_SRC_FILES += $(LVL_DIR)/layers/utils/vk_layer_utils.cpp -LOCAL_SRC_FILES += $(LVL_DIR)/layers/generated/vk_format_utils.cpp +LOCAL_SRC_FILES += $(LVL_DIR)/layers/vulkan/generated/vk_format_utils.cpp LOCAL_SRC_FILES += $(SRC_DIR)/vku/vk_layer_settings.cpp LOCAL_C_INCLUDES += $(LOCAL_PATH)/$(THIRD_PARTY)/Vulkan-Headers/include \ $(SRC_DIR)/vku \ $(LOCAL_PATH)/$(LAYER_DIR)/include \ $(LOCAL_PATH)/$(LVL_DIR)/layers \ - $(LOCAL_PATH)/$(LVL_DIR)/layers/generated + $(LOCAL_PATH)/$(LVL_DIR)/layers/vulkan \ + $(LOCAL_PATH)/$(LVL_DIR)/layers/vulkan/generated LOCAL_CPPFLAGS += -std=c++17 -Wall -Werror -Wno-unused-function -Wno-unused-const-variable LOCAL_CPPFLAGS += -DVK_ENABLE_BETA_EXTENSIONS -DVK_USE_PLATFORM_ANDROID_KHR -DVK_PROTOTYPES -fvisibility=hidden include $(BUILD_STATIC_LIBRARY) @@ -47,7 +48,8 @@ LOCAL_SRC_FILES += $(LAYER_DIR)/include/api_dump.cpp LOCAL_SRC_FILES += $(SRC_DIR)/layersvt/vk_layer_table.cpp LOCAL_C_INCLUDES += $(LOCAL_PATH)/$(THIRD_PARTY)/Vulkan-Headers/include \ $(LOCAL_PATH)/$(LVL_DIR)/layers \ - $(LOCAL_PATH)/$(LVL_DIR)/layers/generated \ + $(LOCAL_PATH)/$(LVL_DIR)/layers/vulkan \ + $(LOCAL_PATH)/$(LVL_DIR)/layers/vulkan/generated \ $(LOCAL_PATH)/$(SRC_DIR)/layersvt \ $(LOCAL_PATH)/$(LAYER_DIR)/include LOCAL_STATIC_LIBRARIES += layer_utils @@ -63,7 +65,8 @@ LOCAL_SRC_FILES += $(SRC_DIR)/layersvt/screenshot_parsing.cpp LOCAL_SRC_FILES += $(SRC_DIR)/layersvt/vk_layer_table.cpp LOCAL_C_INCLUDES += $(LOCAL_PATH)/$(THIRD_PARTY)/Vulkan-Headers/include \ $(LOCAL_PATH)/$(LVL_DIR)/layers \ - $(LOCAL_PATH)/$(LVL_DIR)/layers/generated \ + $(LOCAL_PATH)/$(LVL_DIR)/layers/vulkan \ + $(LOCAL_PATH)/$(LVL_DIR)/layers/vulkan/generated \ $(LOCAL_PATH)/$(SRC_DIR)/layersvt \ $(LOCAL_PATH)/$(LAYER_DIR)/include LOCAL_STATIC_LIBRARIES += layer_utils diff --git a/build-android/vulkan-headers_revision_android b/build-android/vulkan-headers_revision_android index 6a7aec1145..e00e07ecbd 100644 --- a/build-android/vulkan-headers_revision_android +++ b/build-android/vulkan-headers_revision_android @@ -1 +1 @@ -v1.3.250 +v1.3.257 diff --git a/build-android/vulkan-tools_revision_android b/build-android/vulkan-tools_revision_android index 6a7aec1145..e00e07ecbd 100644 --- a/build-android/vulkan-tools_revision_android +++ b/build-android/vulkan-tools_revision_android @@ -1 +1 @@ -v1.3.250 +v1.3.257 diff --git a/build-android/vulkan-validationlayers_revision_android b/build-android/vulkan-validationlayers_revision_android index 6a7aec1145..e00e07ecbd 100644 --- a/build-android/vulkan-validationlayers_revision_android +++ b/build-android/vulkan-validationlayers_revision_android @@ -1 +1 @@ -v1.3.250 +v1.3.257 diff --git a/layersvt/screenshot.cpp b/layersvt/screenshot.cpp index b9743371c9..2f363d8bad 100755 --- a/layersvt/screenshot.cpp +++ b/layersvt/screenshot.cpp @@ -111,6 +111,8 @@ static inline char *local_getenv(const char *name) { static inline void local_free_getenv(const char *val) { free((void *)val); } #endif +#define ARRAY_SIZE(a) (sizeof(a) / sizeof(a[0])) + namespace screenshot { std::mutex globalLock; diff --git a/scripts/api_dump_generator.py b/scripts/api_dump_generator.py index 80d3bbe18d..a534a534ea 100644 --- a/scripts/api_dump_generator.py +++ b/scripts/api_dump_generator.py @@ -82,6 +82,8 @@ #include "api_dump_html.h" #include "api_dump_json.h" +#define ARRAY_SIZE(a) (sizeof(a) / sizeof(a[0])) + // Specifically implemented functions #if defined(__GNUC__) && __GNUC__ >= 4 diff --git a/scripts/known_good.json b/scripts/known_good.json index 4141f95429..2b69304653 100644 --- a/scripts/known_good.json +++ b/scripts/known_good.json @@ -6,7 +6,7 @@ "sub_dir": "Vulkan-Headers", "build_dir": "Vulkan-Headers/build", "install_dir": "Vulkan-Headers/build/install", - "commit": "v1.3.250" + "commit": "v1.3.257" }, { "name": "Vulkan-Utility-Libraries", @@ -28,7 +28,7 @@ "sub_dir": "Vulkan-Loader", "build_dir": "Vulkan-Loader/build", "install_dir": "Vulkan-Loader/build/install", - "commit": "v1.3.250", + "commit": "v1.3.257", "deps": [ { "var_name": "VULKAN_HEADERS_INSTALL_DIR", @@ -49,7 +49,7 @@ "sub_dir": "Vulkan-Tools", "build_dir": "Vulkan-Tools/build", "install_dir": "Vulkan-Tools/build/install", - "commit": "v1.3.250", + "commit": "v1.3.257", "deps": [ { "var_name": "VULKAN_HEADERS_INSTALL_DIR", @@ -74,7 +74,7 @@ "sub_dir": "Vulkan-ValidationLayers", "build_dir": "Vulkan-ValidationLayers/build", "install_dir": "Vulkan-ValidationLayers/build/install", - "commit": "v1.3.250", + "commit": "v1.3.257", "deps": [ { "var_name": "VULKAN_HEADERS_INSTALL_DIR", diff --git a/scripts/vlf_makefile_generator.py b/scripts/vlf_makefile_generator.py index 508e961b21..c3d53df364 100644 --- a/scripts/vlf_makefile_generator.py +++ b/scripts/vlf_makefile_generator.py @@ -85,7 +85,8 @@ contents += 'LOCAL_C_INCLUDES += %s\n' % include_dir contents += 'LOCAL_C_INCLUDES += $(LOCAL_PATH)/$(LAYER_DIR)/include\n' contents += 'LOCAL_C_INCLUDES += $(LOCAL_PATH)/$(LVL_DIR)/layers\n' - contents += 'LOCAL_C_INCLUDES += $(LOCAL_PATH)/$(LVL_DIR)/layers/generated\n' + contents += 'LOCAL_C_INCLUDES += $(LOCAL_PATH)/$(LVL_DIR)/layers/vulkan\n' + contents += 'LOCAL_C_INCLUDES += $(LOCAL_PATH)/$(LVL_DIR)/layers/vulkan/generated\n' contents += 'LOCAL_C_INCLUDES += $(LOCAL_PATH)/$(SRC_DIR)/layer_factory/%s\n' % factory_layer contents += 'LOCAL_C_INCLUDES += $(LOCAL_PATH)/$(LVL_DIR)/loader\n' contents += 'LOCAL_STATIC_LIBRARIES += layer_utils\n' From e6b46fe41711209bb40f4f9239c6676e4d727c8a Mon Sep 17 00:00:00 2001 From: Kaiyi Li Date: Sat, 10 Jun 2023 10:53:45 -0700 Subject: [PATCH 093/154] screenshot: Fix Android build error ... unused variable. Without this commit, the build will fail with the following message: ``` make: *** [%LOCAL_APPDATA%/Android/Sdk/ndk/25.2.9519653/build/../build/core/build-binary.mk:424: obj/local/x86/objs/VkLayer_screenshot/__/__/layersvt/screenshot.o] Error 1 [x86_64] Compile++ : layer_utils <= vk_layer_config.cpp [x86_64] Compile++ : VkLayer_screenshot <= screenshot.cpp jni/../../layersvt/screenshot.cpp:518:10: error: variable 'pass' set but not used [-Werror,-Wunused-but-set-variable] bool pass; ^ 1 error generated. ``` --- layersvt/screenshot.cpp | 2 ++ 1 file changed, 2 insertions(+) diff --git a/layersvt/screenshot.cpp b/layersvt/screenshot.cpp index 2f363d8bad..96646b3e30 100755 --- a/layersvt/screenshot.cpp +++ b/layersvt/screenshot.cpp @@ -819,6 +819,7 @@ static bool writePPM(const char *filename, VkImage image1) { need2steps ? VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT : VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT, &memAllocInfo.memoryTypeIndex); assert(pass); + (void)pass; err = pTableDevice->AllocateMemory(device, &memAllocInfo, NULL, &data.mem2); assert(!err); if (VK_SUCCESS != err) return false; @@ -837,6 +838,7 @@ static bool writePPM(const char *filename, VkImage image1) { pass = memory_type_from_properties(&memoryProperties, memRequirements.memoryTypeBits, VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT, &memAllocInfo.memoryTypeIndex); assert(pass); + (void)pass; err = pTableDevice->AllocateMemory(device, &memAllocInfo, NULL, &data.mem3); assert(!err); if (VK_SUCCESS != err) return false; From c2ac4d634db7b3e817ffa6f0a06306ee05ee2700 Mon Sep 17 00:00:00 2001 From: Kaiyi Li Date: Fri, 9 Jun 2023 17:08:46 -0700 Subject: [PATCH 094/154] apidump: Use logcat instead of stdout for Android Make the apidump output to go to logcat instead of stdout on Android. * Implement the AndroidLogcatBuf class that derives from std::streambuf which writes to the Android logcat on a per-line basis. * Modify ApiDumpSettings to hold an instance of AndroidLogcatBuf, and make the output_stream to use that streambuf instead of the iostream one at initialization. --- layersvt/api_dump.h | 92 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 92 insertions(+) diff --git a/layersvt/api_dump.h b/layersvt/api_dump.h index 6e13b6de33..db6d1fc22e 100644 --- a/layersvt/api_dump.h +++ b/layersvt/api_dump.h @@ -61,6 +61,8 @@ #include #ifdef ANDROID +#include +#include #include #include @@ -241,9 +243,96 @@ class ConditionalFrameOutput { } }; +#ifdef __ANDROID__ +template > +class AndroidLogcatBuf final : public std::basic_streambuf { + public: + class LogWriter { + public: + virtual void write(const std::basic_string &data) = 0; + virtual ~LogWriter() {} + }; + + // bufsize should be smaller than 0x400, because `__android_log_print` uses `vsnprintf` with a 1024 buffer size. If bufsize here + // is greater or close to 1024, the log will be truncated. + AndroidLogcatBuf(std::unique_ptr log_writer, size_t bufsize = 0x200) + : buffer_(std::make_unique(bufsize)), bufsize_(bufsize), log_writer_(std::move(log_writer)) { + // We use the last position of buffer_ to store the overflow character. We use 0 as a sentinel element to indicate if this + // overflow slot is in use. + this->setp(buffer_.get(), buffer_.get() + bufsize_ - 1); + } + ~AndroidLogcatBuf() = default; + + private: + using int_type = typename traits::int_type; + int_type overflow(int_type c) override { + // Conform with the C++ standard. Return not eof when called with eof: + // https://en.cppreference.com/w/cpp/io/basic_stringbuf/overflow. + if (c == traits::eof()) { + return traits::not_eof(c); + } + buffer_[bufsize_ - 1] = traits::to_char_type(c); + flushPending(); + buffer_[bufsize_ - 1] = traits::to_char_type(0); + return traits::not_eof(c); + } + + int sync() override { + flushPending(); + if (!pending_content_.empty()) { + // Also write data after the last new line. + log_writer_->write(pending_content_); + pending_content_.clear(); + } + return 0; + } + + // Flush pending_content_ + buffer_ up to the last new line to the log writer, and always move whatever is left in buffer_ to + // pending_content_. + void flushPending() { + auto len = this->pptr() - this->pbase(); + if (this->pptr() == buffer_.get() + bufsize_ - 1 && buffer_[bufsize_ - 1] != traits::to_char_type(0)) { + len++; + } + constexpr size_t npos = std::basic_string_view::npos; + std::basic_string_view buf_content(this->pbase(), len); + std::size_t last_new_line_pos = buf_content.find_last_of(traits::to_char_type('\n')); + if (last_new_line_pos == npos) { + pending_content_.append(buf_content); + this->setp(buffer_.get(), buffer_.get() + bufsize_ - 1); + return; + } + std::basic_string_view before_new_line = buf_content.substr(0, last_new_line_pos); + std::basic_string to_print = std::move(pending_content_); + to_print.append(before_new_line); + if (!to_print.empty()) { + log_writer_->write(to_print); + } + std::basic_string_view after_new_line = buf_content.substr(last_new_line_pos + 1); + pending_content_ = std::basic_string(after_new_line); + this->setp(buffer_.get(), buffer_.get() + bufsize_ - 1); + } + + std::unique_ptr buffer_; + size_t bufsize_; + std::basic_string pending_content_; + std::unique_ptr log_writer_; +}; + +class AndroidLogcatWriter final : public AndroidLogcatBuf<>::LogWriter { + public: + AndroidLogcatWriter() = default; + void write(const std::string &content) override { __android_log_print(ANDROID_LOG_INFO, "api_dump", "%s", content.c_str()); } +}; +#endif + class ApiDumpSettings { public: ApiDumpSettings() : output_stream(std::cout.rdbuf()) { +#ifdef __ANDROID__ + android_logcat_buf = std::make_unique>(std::make_unique()); + output_stream.rdbuf(android_logcat_buf.get()); +#endif std::string filename_string = ""; // If the layer settings file has a flag indicating to output to a file, // do so, to the appropriate filename. @@ -673,6 +762,9 @@ class ApiDumpSettings { // Since basically every function in this struct is const, we have to work around that. mutable std::ostream output_stream; std::ofstream output_file_stream; +#ifdef __ANDROID__ + std::unique_ptr> android_logcat_buf = nullptr; +#endif ApiDumpFormat output_format; bool show_params; bool show_address; From b8c27d974f6797accbed7ab5b6deb4067b694042 Mon Sep 17 00:00:00 2001 From: spencer-lunarg Date: Wed, 12 Jul 2023 10:14:29 +0900 Subject: [PATCH 095/154] layers: Cleanup unused includes and bool expr --- layersvt/screenshot.cpp | 4 ++-- vkconfig/main.cpp | 2 -- vkconfig/main_gui.cpp | 2 +- vku/vk_layer_settings.cpp | 2 -- 4 files changed, 3 insertions(+), 7 deletions(-) diff --git a/layersvt/screenshot.cpp b/layersvt/screenshot.cpp index 96646b3e30..557bbbe0be 100755 --- a/layersvt/screenshot.cpp +++ b/layersvt/screenshot.cpp @@ -746,8 +746,8 @@ static bool writePPM(const char *filename, VkImage image1) { if (destformat == format) { copyOnly = true; } else { - bool const bltLinear = targetFormatProps.linearTilingFeatures & VK_FORMAT_FEATURE_BLIT_DST_BIT ? true : false; - bool const bltOptimal = targetFormatProps.optimalTilingFeatures & VK_FORMAT_FEATURE_BLIT_DST_BIT ? true : false; + bool const bltLinear = targetFormatProps.linearTilingFeatures & VK_FORMAT_FEATURE_BLIT_DST_BIT; + bool const bltOptimal = targetFormatProps.optimalTilingFeatures & VK_FORMAT_FEATURE_BLIT_DST_BIT; if (!bltLinear && !bltOptimal) { // Cannot blit to either target tiling type. It should be pretty // unlikely to have a device that cannot blit to either type. diff --git a/vkconfig/main.cpp b/vkconfig/main.cpp index 6443a56bf1..db3242cf17 100644 --- a/vkconfig/main.cpp +++ b/vkconfig/main.cpp @@ -24,8 +24,6 @@ #include "main_doc.h" #include "main_signal.h" -#include "../vkconfig_core/command_line.h" - #include int main(int argc, char* argv[]) { diff --git a/vkconfig/main_gui.cpp b/vkconfig/main_gui.cpp index f7fa79b6d2..e98a19720c 100644 --- a/vkconfig/main_gui.cpp +++ b/vkconfig/main_gui.cpp @@ -68,7 +68,7 @@ int run_gui(int argc, char* argv[], const CommandLine& command_line) { // We simply cannot run without any layers Configurator& configurator = Configurator::Get(command_line.command_vulkan_sdk); - if (configurator.Init() == false) return -1; + if (!configurator.Init()) return -1; // The main GUI is driven here MainWindow main_window; diff --git a/vku/vk_layer_settings.cpp b/vku/vk_layer_settings.cpp index 9c03a52879..6dca9b84ca 100644 --- a/vku/vk_layer_settings.cpp +++ b/vku/vk_layer_settings.cpp @@ -37,8 +37,6 @@ #include #include -#include - #if defined(_WIN32) #include #include From 3b6674196e5e8dd201b51e2cb51d77952217615b Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Wed, 28 Jun 2023 13:41:40 -0600 Subject: [PATCH 096/154] via: Dont set the MSVC runtime library The update to CMake 3.15+ changes how the MSVC runtime library (as in the CRT) should be set. Instead of modifying C_FLAGS, there is a property per target that must be set. Since nothing in this repo stands to benefit from statically linking the CRT, no additions are needed. Only the removal of the useless CMake foreach loop is necessary. --- via/CMakeLists.txt | 8 -------- 1 file changed, 8 deletions(-) diff --git a/via/CMakeLists.txt b/via/CMakeLists.txt index 680fbb2fef..e596b8bb66 100644 --- a/via/CMakeLists.txt +++ b/via/CMakeLists.txt @@ -5,14 +5,6 @@ file(COPY ${TEXTURES} DESTINATION ${CMAKE_BINARY_DIR}/via/images) if(WIN32) - # Use static MSVCRT libraries - foreach(configuration in CMAKE_C_FLAGS_DEBUG CMAKE_C_FLAGS_MINSIZEREL CMAKE_C_FLAGS_RELEASE CMAKE_C_FLAGS_RELWITHDEBINFO - CMAKE_CXX_FLAGS_DEBUG CMAKE_CXX_FLAGS_MINSIZEREL CMAKE_CXX_FLAGS_RELEASE CMAKE_CXX_FLAGS_RELWITHDEBINFO) - if(${configuration} MATCHES "/MD") - string(REGEX REPLACE "/MD" "/MT" ${configuration} "${${configuration}}") - endif() - endforeach() - set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -D_CRT_SECURE_NO_WARNINGS -D_USE_MATH_DEFINES") set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -D_CRT_SECURE_NO_WARNINGS -D_USE_MATH_DEFINES") add_definitions(-DVIA_WINDOWS_TARGET) From 9990727505de895e3becdabbc6e83892c48a5433 Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Wed, 28 Jun 2023 13:43:15 -0600 Subject: [PATCH 097/154] via: Remove CMakeLists-SDK.txt This was used for old SDK builds but is no longer in use. It is out of date and so should be removed. --- via/CMakeLists-SDK.txt | 115 ----------------------------------------- 1 file changed, 115 deletions(-) delete mode 100644 via/CMakeLists-SDK.txt diff --git a/via/CMakeLists-SDK.txt b/via/CMakeLists-SDK.txt deleted file mode 100644 index c039588851..0000000000 --- a/via/CMakeLists-SDK.txt +++ /dev/null @@ -1,115 +0,0 @@ -cmake_minimum_required(VERSION 3.10.2) - -# Define GNU standard installation directories. -include(GNUInstallDirs) - -if (CMAKE_COMPILER_IS_GNUCC OR CMAKE_C_COMPILER_ID MATCHES "Clang") - set(COMMON_COMPILE_FLAGS "-Wall -Wextra -Wno-unused-parameter -Wno-missing-field-initializers") - set(COMMON_COMPILE_FLAGS "${COMMON_COMPILE_FLAGS} -fno-strict-aliasing -fno-builtin-memcmp") - set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -std=c99 ${COMMON_COMPILE_FLAGS}") - set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${COMMON_COMPILE_FLAGS} -std=c++11 -fno-rtti") - if (UNIX) - set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fvisibility=hidden") - set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fvisibility=hidden") - endif() -endif() - -file(GLOB TEXTURES - "${PROJECT_SOURCE_DIR}/via/images/*" -) -file(COPY ${TEXTURES} DESTINATION ${CMAKE_BINARY_DIR}/via/images) - - -if(WIN32) - set (LIBRARIES "vulkan-1") - - # For Windows, since 32-bit and 64-bit items can co-exist, we build each in its own build directory. - # 32-bit target data goes in build32, and 64-bit target data goes into build. So, include/link the - # appropriate data at build time. - if (CMAKE_CL_64) - set (BUILDTGT_DIR build) - else () - set (BUILDTGT_DIR build32) - endif() - - # Use static MSVCRT libraries - foreach(configuration in CMAKE_C_FLAGS_DEBUG CMAKE_C_FLAGS_MINSIZEREL CMAKE_C_FLAGS_RELEASE CMAKE_C_FLAGS_RELWITHDEBINFO - CMAKE_CXX_FLAGS_DEBUG CMAKE_CXX_FLAGS_MINSIZEREL CMAKE_CXX_FLAGS_RELEASE CMAKE_CXX_FLAGS_RELWITHDEBINFO) - if(${configuration} MATCHES "/MD") - string(REGEX REPLACE "/MD" "/MT" ${configuration} "${${configuration}}") - endif() - endforeach() - - set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -D_CRT_SECURE_NO_WARNINGS -D_USE_MATH_DEFINES") - set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -D_CRT_SECURE_NO_WARNINGS -D_USE_MATH_DEFINES") - -else() - - if(UNIX) - set (LIBRARIES "vulkan") - endif() - - if (BUILD_WSI_XCB_SUPPORT) - find_package(XCB REQUIRED) - - include_directories(${XCB_INCLUDE_DIRS}) - link_libraries(${XCB_LIBRARIES}) - endif() - if (BUILD_WSI_XLIB_SUPPORT) - find_package(X11 REQUIRED) - - include_directories(${X11_INCLUDE_DIRS}) - link_libraries(${X11_LIBRARIES}) - endif() - if (BUILD_WSI_WAYLAND_SUPPORT) - find_package(Wayland REQUIRED) - - include_directories(${WAYLAND_CLIENT_INCLUDE_DIR}) - link_libraries(${WAYLAND_CLIENT_LIBRARIES}) - endif() - - # Disable the RPATH for VIA because we want it to use - # the environment setup by the user - SET(CMAKE_SKIP_BUILD_RPATH TRUE) - - get_filename_component(LIB_DIR "../../x86_64/lib" ABSOLUTE) - link_directories(${LIB_DIR}) - link_libraries(vulkan m dl) - - get_filename_component(VK_INC_DIR "${CMAKE_SOURCE_DIR}/../../x86_64/include" ABSOLUTE) - include_directories(${VK_INC_DIR}) -endif() - - -if(WIN32) -add_definitions(-DVIA_WINDOWS_TARGET) -add_executable(vkvia - via.cpp - via_system.hpp - via_system.cpp - via_system_windows.hpp - via_system_windows.cpp - ${JSONCPP_SOURCE_DIR}/jsoncpp.cpp) -else() -if(CMAKE_SYSTEM_NAME MATCHES "BSD") - add_definitions(-DVIA_BSD_TARGET) -else() - add_definitions(-DVIA_LINUX_TARGET) -endif() -add_executable(vkvia - via.cpp - via_system.hpp - via_system.cpp - via_system_bsd.cpp - via_system_linux.hpp - via_system_linux.cpp - ${JSONCPP_SOURCE_DIR}/jsoncpp.cpp) -endif() -target_include_directories(vkvia PUBLIC ${JSONCPP_INCLUDE_DIR}) -target_link_libraries(vkvia Vulkan::Headers ${LIBRARIES}) -if(WIN32) - target_link_libraries(vkvia version) -endif() -if(UNIX) - install(TARGETS vkvia DESTINATION ${CMAKE_INSTALL_BINDIR}) -endif() From 6a61c42dd3379dc69414d9b41a2b087b64f30f60 Mon Sep 17 00:00:00 2001 From: Tony Barbour Date: Wed, 2 Aug 2023 09:21:56 -0600 Subject: [PATCH 098/154] build: Update to 1.3.260 headers Skip updating Android due to VVL Android cmake build --- scripts/known_good.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/scripts/known_good.json b/scripts/known_good.json index 2b69304653..f60411001f 100644 --- a/scripts/known_good.json +++ b/scripts/known_good.json @@ -6,7 +6,7 @@ "sub_dir": "Vulkan-Headers", "build_dir": "Vulkan-Headers/build", "install_dir": "Vulkan-Headers/build/install", - "commit": "v1.3.257" + "commit": "v1.3.260" }, { "name": "Vulkan-Utility-Libraries", @@ -28,7 +28,7 @@ "sub_dir": "Vulkan-Loader", "build_dir": "Vulkan-Loader/build", "install_dir": "Vulkan-Loader/build/install", - "commit": "v1.3.257", + "commit": "v1.3.260", "deps": [ { "var_name": "VULKAN_HEADERS_INSTALL_DIR", @@ -49,7 +49,7 @@ "sub_dir": "Vulkan-Tools", "build_dir": "Vulkan-Tools/build", "install_dir": "Vulkan-Tools/build/install", - "commit": "v1.3.257", + "commit": "v1.3.260", "deps": [ { "var_name": "VULKAN_HEADERS_INSTALL_DIR", @@ -74,7 +74,7 @@ "sub_dir": "Vulkan-ValidationLayers", "build_dir": "Vulkan-ValidationLayers/build", "install_dir": "Vulkan-ValidationLayers/build/install", - "commit": "v1.3.257", + "commit": "v1.3.260", "deps": [ { "var_name": "VULKAN_HEADERS_INSTALL_DIR", From 0bc310271e6164fba712662ec76f5bfeed022e45 Mon Sep 17 00:00:00 2001 From: Tony Barbour Date: Fri, 11 Aug 2023 11:55:16 -0600 Subject: [PATCH 099/154] build: Update to 1.3.261 headers Had to use a VVL commit that reverted code that prevented building VVL in this repo --- scripts/known_good.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/scripts/known_good.json b/scripts/known_good.json index f60411001f..2cd805b1ed 100644 --- a/scripts/known_good.json +++ b/scripts/known_good.json @@ -6,7 +6,7 @@ "sub_dir": "Vulkan-Headers", "build_dir": "Vulkan-Headers/build", "install_dir": "Vulkan-Headers/build/install", - "commit": "v1.3.260" + "commit": "v1.3.261" }, { "name": "Vulkan-Utility-Libraries", @@ -28,7 +28,7 @@ "sub_dir": "Vulkan-Loader", "build_dir": "Vulkan-Loader/build", "install_dir": "Vulkan-Loader/build/install", - "commit": "v1.3.260", + "commit": "v1.3.261", "deps": [ { "var_name": "VULKAN_HEADERS_INSTALL_DIR", @@ -49,7 +49,7 @@ "sub_dir": "Vulkan-Tools", "build_dir": "Vulkan-Tools/build", "install_dir": "Vulkan-Tools/build/install", - "commit": "v1.3.260", + "commit": "v1.3.261", "deps": [ { "var_name": "VULKAN_HEADERS_INSTALL_DIR", @@ -74,7 +74,7 @@ "sub_dir": "Vulkan-ValidationLayers", "build_dir": "Vulkan-ValidationLayers/build", "install_dir": "Vulkan-ValidationLayers/build/install", - "commit": "v1.3.260", + "commit": "e6bdb8d71409a96a4174589ea195d0dc1e920625", "deps": [ { "var_name": "VULKAN_HEADERS_INSTALL_DIR", From 413b473522c29b00509aa919579aa58ba3a7d980 Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Mon, 14 Aug 2023 16:29:12 -0600 Subject: [PATCH 100/154] repo: Remove Vulkan-Layer-Factory The Vulkan-Layer-Factory project is being moved into its own repo for archival purposes. This commit removes it from this repo as well as documents where the archival repo is. --- CMakeLists.txt | 6 - GOVERNANCE.md | 1 - README.md | 14 +- build-android/android-generate.bat | 7 - build-android/android-generate.sh | 4 - build-android/jni/Android.mk | 3 - layer_factory/CMakeLists.txt | 202 ----- layer_factory/README.md | 168 ---- layer_factory/VkLayer_layer_factory.def | 6 - layer_factory/demo_layer/demo.cpp | 73 -- layer_factory/demo_layer/demo.h | 46 - .../demo_layer/interceptor_objects.h | 20 - layer_factory/layer_factory.json.in | 29 - .../starter_layer/interceptor_objects.h | 20 - .../starter_layer/memory_allocation_stats.h | 70 -- scripts/github_ci_linux.py | 9 +- scripts/github_ci_win.py | 8 +- scripts/layer_factory_generator.py | 853 ------------------ scripts/vlf_makefile_generator.py | 103 --- scripts/vt_genvk.py | 51 -- tests/CMakeLists.txt | 3 - tests/vlf_test.ps1 | 72 -- tests/vlf_test.sh | 79 -- 23 files changed, 16 insertions(+), 1831 deletions(-) delete mode 100644 layer_factory/CMakeLists.txt delete mode 100644 layer_factory/README.md delete mode 100644 layer_factory/VkLayer_layer_factory.def delete mode 100644 layer_factory/demo_layer/demo.cpp delete mode 100644 layer_factory/demo_layer/demo.h delete mode 100644 layer_factory/demo_layer/interceptor_objects.h delete mode 100644 layer_factory/layer_factory.json.in delete mode 100644 layer_factory/starter_layer/interceptor_objects.h delete mode 100644 layer_factory/starter_layer/memory_allocation_stats.h delete mode 100644 scripts/layer_factory_generator.py delete mode 100644 scripts/vlf_makefile_generator.py delete mode 100644 tests/vlf_test.ps1 delete mode 100755 tests/vlf_test.sh diff --git a/CMakeLists.txt b/CMakeLists.txt index 950abcd24f..ab8ac501fc 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -167,7 +167,6 @@ if (CMAKE_SYSTEM_NAME STREQUAL "Windows" OR option(BUILD_APIDUMP "Build api_dump layer" ON) option(BUILD_MONITOR "Build monitor layer" ON) option(BUILD_SCREENSHOT "Build screenshot layer" ON) - option(BUILD_VLF "Build layer_factory" ON) option(BUILD_VIA "Build via" ON) option(BUILD_LAYERMGR "Build Vulkan Configurator" ON) @@ -179,7 +178,6 @@ elseif (CMAKE_SYSTEM_NAME STREQUAL "Darwin") option(BUILD_APIDUMP "Build api_dump layer" ON) option(BUILD_MONITOR "Build monitor layer" ON) option(BUILD_SCREENSHOT "Build screenshot layer" ON) - option(BUILD_VLF OFF) option(BUILD_DEMOS OFF) option(BUILD_VKJSON OFF) option(BUILD_VIA "Build VIA" ON) @@ -207,10 +205,6 @@ if(BUILD_TESTS) add_subdirectory(tests) endif() -if(BUILD_VLF) - add_subdirectory(layer_factory) -endif() - if(BUILD_VIA) add_subdirectory(via) endif() diff --git a/GOVERNANCE.md b/GOVERNANCE.md index f748ff8454..4707efa7cd 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -5,7 +5,6 @@ * Provide tools to aid in the development of Vulkan applications. Current tools include: * via - Vulkan Installation Analyzer * layers: device simulation, api dump, fps monitor, screenshot - * layer factory: framework that facilitates the creation of new layers * Platform support: * Windows * Linux diff --git a/README.md b/README.md index 6c88bae67a..59b565add4 100644 --- a/README.md +++ b/README.md @@ -7,10 +7,14 @@ The repository contains the following Vulkan Tools: These tools have binaries included within the [Vulkan SDK](https://www.lunarg.com/vulkan-sdk/). +## Removed Tools + VkTrace and VkReplay have been deprecated and replaced by [gfxreconstruct](https://github.com/LunarG/gfxreconstruct). Both VkTrace and VkReplay have been removed from VulkanTools and can now be found in the [vktrace](https://github.com/LunarG/vktrace) archive. Both these tools are also no longer part of the [Vulkan SDK](https://www.lunarg.com/vulkan-sdk/). +Vulkan-Layer-Factory is deprecated and has been archived in its own repository which is available [here](https://github.com/LunarG/Vulkan-Layer-Factory). + ## Default branch changed to 'main' 2023-01-17 The default branch of this repository is now 'main'. This change should be largely transparent to repository users, since github rewrites many references to the old 'master' branch to 'main'. However, if you have a checked-out local clone, you may wish to take the following steps as recommended by github: @@ -23,12 +27,12 @@ git remote set-head origin -a ``` ## CI Build Status -| Build Status | -|:------------| -| [![Build Status](https://github.com/LunarG/VulkanTools/actions/workflows/build_windows.yml/badge.svg?branch=main)](https://github.com/LunarG/VulkanTools/actions) | -| [![Build Status](https://github.com/LunarG/VulkanTools/actions/workflows/build_linux.yml/badge.svg?branch=main)](https://github.com/LunarG/VulkanTools/actions) | +| Build Status | +| :----------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [![Build Status](https://github.com/LunarG/VulkanTools/actions/workflows/build_windows.yml/badge.svg?branch=main)](https://github.com/LunarG/VulkanTools/actions) | +| [![Build Status](https://github.com/LunarG/VulkanTools/actions/workflows/build_linux.yml/badge.svg?branch=main)](https://github.com/LunarG/VulkanTools/actions) | | [![Build Status](https://github.com/LunarG/VulkanTools/actions/workflows/build_linux_gn.yml/badge.svg?branch=main)](https://github.com/LunarG/VulkanTools/actions) | -| [![Build Status](https://github.com/LunarG/VulkanTools/actions/workflows/build_android.yml/badge.svg?branch=main)](https://github.com/LunarG/VulkanTools/actions) | +| [![Build Status](https://github.com/LunarG/VulkanTools/actions/workflows/build_android.yml/badge.svg?branch=main)](https://github.com/LunarG/VulkanTools/actions) | ## Contributing diff --git a/build-android/android-generate.bat b/build-android/android-generate.bat index 86b304cb77..555e65b5ff 100644 --- a/build-android/android-generate.bat +++ b/build-android/android-generate.bat @@ -40,13 +40,6 @@ echo Entering Generated/Include Folder echo ******** pushd generated\include -REM layer factory -echo Generating VT layer factory header/source files -echo ******** -py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% layer_factory.h -py -3 %VT_SCRIPTS%\vt_genvk.py -registry %REGISTRY% -scripts %REGISTRY_PATH% layer_factory.cpp -py -3 %VT_SCRIPTS%\vlf_makefile_generator.py ..\..\..\layer_factory %REGISTRY_PATH%\..\include - REM apidump echo Generating VT apidump header/source files echo ******** diff --git a/build-android/android-generate.sh b/build-android/android-generate.sh index 04af03fbe8..c1a37eec6f 100755 --- a/build-android/android-generate.sh +++ b/build-android/android-generate.sh @@ -44,10 +44,6 @@ if [ $PYTHON_MINOR_VERSION -lt "6" ]; then fi echo "Using python: $(which $PYTHON_EXECUTABLE)" -# layer factory -( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} layer_factory.h) -( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} layer_factory.cpp) -( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vlf_makefile_generator.py ../../../layer_factory ${REGISTRY_PATH}/../include) # apidump ( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump.cpp -removeExtensions VK_NV_cooperative_matrix -removeExtensions VK_QNX_external_memory_screen_buffer) diff --git a/build-android/jni/Android.mk b/build-android/jni/Android.mk index abcc5621d1..4a89374b3b 100644 --- a/build-android/jni/Android.mk +++ b/build-android/jni/Android.mk @@ -39,9 +39,6 @@ LOCAL_CPPFLAGS += -std=c++17 -Wall -Werror -Wno-unused-function -Wno-unused-cons LOCAL_CPPFLAGS += -DVK_ENABLE_BETA_EXTENSIONS -DVK_USE_PLATFORM_ANDROID_KHR -DVK_PROTOTYPES -fvisibility=hidden include $(BUILD_STATIC_LIBRARY) -# Pick up VLF layers -include $(LOCAL_PATH)/$(LAYER_DIR)/include/Android.mk - include $(CLEAR_VARS) LOCAL_MODULE := VkLayer_api_dump LOCAL_SRC_FILES += $(LAYER_DIR)/include/api_dump.cpp diff --git a/layer_factory/CMakeLists.txt b/layer_factory/CMakeLists.txt deleted file mode 100644 index 6eff5674fa..0000000000 --- a/layer_factory/CMakeLists.txt +++ /dev/null @@ -1,202 +0,0 @@ -cmake_minimum_required(VERSION 3.10.2) -if(CMAKE_SYSTEM_NAME STREQUAL "Windows") - add_definitions(-DVK_USE_PLATFORM_WIN32_KHR -DVK_USE_PLATFORM_WIN32_KHX -DWIN32_LEAN_AND_MEAN -DNOMINMAX) - set(DisplayServer Win32) -elseif(CMAKE_SYSTEM_NAME STREQUAL "Android") - add_definitions(-DVK_USE_PLATFORM_ANDROID_KHR) -elseif(CMAKE_SYSTEM_NAME STREQUAL "Linux" OR CMAKE_SYSTEM_NAME MATCHES "BSD") - if (BUILD_WSI_XCB_SUPPORT) - add_definitions(-DVK_USE_PLATFORM_XCB_KHR -DVK_USE_PLATFORM_XCB_KHX) - endif() - - if (BUILD_WSI_XLIB_SUPPORT) - add_definitions(-DVK_USE_PLATFORM_XLIB_KHR -DVK_USE_PLATFORM_XLIB_KHX -DVK_USE_PLATFORM_XLIB_XRANDR_EXT) - endif() - - if (BUILD_WSI_WAYLAND_SUPPORT) - add_definitions(-DVK_USE_PLATFORM_WAYLAND_KHR -DVK_USE_PLATFORM_WAYLAND_KHX) - endif() -else() - message(FATAL_ERROR "Unsupported Platform!") -endif() - -# Move binary output location to the standard layers directory -set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/../layers) -set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/../layers) -set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/../layers) - -include_directories( - ${CMAKE_CURRENT_SOURCE_DIR} - ${CMAKE_CURRENT_BINARY_DIR} - ${Vulkan-ValidationLayers_INCLUDE_DIR} -) - -if (WIN32) - set (CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} -D_CRT_SECURE_NO_WARNINGS") - set (CMAKE_C_FLAGS_RELEASE "${CMAKE_C_FLAGS_RELEASE} -D_CRT_SECURE_NO_WARNINGS") - set (CMAKE_CXX_FLAGS_RELWITHDEBINFO "${CMAKE_CXX_FLAGS_RELWITHDEBINFO} -D_CRT_SECURE_NO_WARNINGS") - set (CMAKE_C_FLAGS_RELWITHDEBINFO "${CMAKE_C_FLAGS_RELWITHDEBINFO} -D_CRT_SECURE_NO_WARNINGS") - set (CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -D_CRT_SECURE_NO_WARNINGS /bigobj") - set (CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} -D_CRT_SECURE_NO_WARNINGS /bigobj") - # Turn off transitional "changed behavior" warning message for Visual Studio versions prior to 2015. - # The changed behavior is that constructor initializers are now fixed to clear the struct members. - add_compile_options("$<$,$,19>>:/wd4351>") -else() - set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++17 -Wpointer-arith -Wno-unused-function -Wno-sign-compare") - set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wpointer-arith -Wno-unused-function -Wno-sign-compare") -endif() - -run_vulkantools_vk_xml_generate(layer_factory_generator.py layer_factory.h) -run_vulkantools_vk_xml_generate(layer_factory_generator.py layer_factory.cpp) -add_custom_target(generate_vlf DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/layer_factory.cpp ${CMAKE_CURRENT_BINARY_DIR}/layer_factory.h) -set_target_properties(generate_vlf PROPERTIES FOLDER ${VULKANTOOLS_TARGET_FOLDER}) - -# Generates a list of subdirectories in a directory. Used to pick up factory layers and interceptors -MACRO(SUBDIRLIST result curdir) - FILE(GLOB children RELATIVE ${curdir} ${curdir}/*) - SET(dirlist "") - FOREACH(child ${children}) - IF(IS_DIRECTORY ${curdir}/${child}) - LIST(APPEND dirlist ${child}) - ENDIF() - ENDFOREACH() - SET(${result} ${dirlist}) -ENDMACRO() - -# Paths for the layer factory json template and the destination for factory layer json files -set (JSON_TEMPLATE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/layer_factory.json.in) -if (WIN32) - set (JSON_DEST_PATH ${CMAKE_CURRENT_BINARY_DIR}) -else() - set (JSON_DEST_PATH ${CMAKE_CURRENT_BINARY_DIR}/../layers) -endif() - - - -set (CMAKE_LAYER_FACTORY_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}) -SUBDIRLIST(ST_SUBDIRS ${CMAKE_LAYER_FACTORY_SOURCE_DIR}) - -# json file creation - -# The output file needs Unix "/" separators or Windows "\" separators -# On top of that, Windows separators actually need to be doubled because the json format uses backslash escapes -file(TO_NATIVE_PATH "./" RELATIVE_PATH_PREFIX) -string(REPLACE "\\" "\\\\" RELATIVE_PATH_PREFIX "${RELATIVE_PATH_PREFIX}") - -# Run json.in file through the generator -# We need to create the generator.cmake script so that the generator can be run at compile time, instead of configure time -# Running at compile time lets us use cmake generator expressions (TARGET_FILE_NAME and TARGET_FILE_DIR, specifically) -file(WRITE "${CMAKE_CURRENT_BINARY_DIR}/generator.cmake" "configure_file(\"\${INPUT_FILE}\" \"\${OUTPUT_FILE}\")") -foreach(SUBDIR ${ST_SUBDIRS}) - set(TARGET_NAME VkLayer_${SUBDIR}) - set(CONFIG_DEFINES - -DINPUT_FILE=${JSON_TEMPLATE_PATH} - -DVK_VERSION="${VulkanHeaders_VERSION}" - ) - set(CONFIG_DEFINES ${CONFIG_DEFINES} - -DOUTPUT_FILE="$/${TARGET_NAME}.json" - -DRELATIVE_LAYER_BINARY="${RELATIVE_PATH_PREFIX}$" - -DLAYER_NAME="VK_LAYER_LUNARG_${SUBDIR}" - ) - if(CMAKE_CURRENT_BINARY_DIR MATCHES ".*layer_factory.*") - if(WIN32) - add_custom_target(${TARGET_NAME}-json ALL - COMMAND ${CMAKE_COMMAND} ${CONFIG_DEFINES} -P "${CMAKE_CURRENT_BINARY_DIR}/generator.cmake" - ) - else() - add_custom_target(${TARGET_NAME}-json ALL - COMMAND ${CMAKE_COMMAND} ${CONFIG_DEFINES} -P "${CMAKE_CURRENT_BINARY_DIR}/generator.cmake" - COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_CURRENT_BINARY_DIR}/../layers/staging-json - COMMAND ${CMAKE_COMMAND} -E copy ${JSON_DEST_PATH}/VkLayer_${SUBDIR}.json ${CMAKE_CURRENT_BINARY_DIR}/../layers/staging-json - COMMAND sed -i -e "/library_path.:/s=./libVkLayer=libVkLayer=" ${CMAKE_CURRENT_BINARY_DIR}/../layers/staging-json/VkLayer_${SUBDIR}.json - ) - endif() - endif() - - if (WIN32) - macro(add_factory_layer target subdir) - # Read in def file template, update with new layer name and write to destination - file(READ ${CMAKE_CURRENT_SOURCE_DIR}/VkLayer_layer_factory.def def_file_template) - string(REPLACE "layer_factory" ${target} target_def_file ${def_file_template}) - file(WRITE ${CMAKE_CURRENT_BINARY_DIR}/VkLayer_${target}.def ${target_def_file}) - # Edit json template and copy to build\layers dir at cmake time - file(READ "${JSON_TEMPLATE_PATH}" json_file_template) - string(REPLACE "layer_factory" "${target}" target_json_file "${json_file_template}") - file(TO_NATIVE_PATH ${JSON_DEST_PATH}/VkLayer_${target}.json dst_json) - file(WRITE ${dst_json} ${target_json_file}) - - add_library(VkLayer_${target} SHARED ${ARGN} VkLayer_${target}.def) - target_link_Libraries(VkLayer_${target} Vulkan::Headers ${VkLayer_utils_LIBRARY}) - target_include_directories(VkLayer_${target} PRIVATE ${subdir}) - endmacro() - else() - macro(add_factory_layer target subdir) - # Create custom target for the copies so that json template is copied and edited at compile time - file(READ "${JSON_TEMPLATE_PATH}" json_file_template) - string(REPLACE "layer_factory" "${target}" target_json_file "${json_file_template}") - file(TO_NATIVE_PATH ${JSON_DEST_PATH}/VkLayer_${target}.json dst_json) - file(WRITE ${dst_json} ${target_json_file}) - add_library(VkLayer_${target} SHARED ${ARGN}) - target_link_Libraries(VkLayer_${target} Vulkan::Headers ${VkLayer_utils_LIBRARY}) - target_include_directories(VkLayer_${target} PRIVATE ${subdir}) - set_target_properties(VkLayer_${target} PROPERTIES LINK_FLAGS "-Wl,-Bsymbolic,--exclude-libs,ALL") - endmacro() - endif() - -endforeach() - -# Create the layer_factory_linux.json file -if(UNIX) - set(CONFIG_DEFINES - -DINPUT_FILE=${CMAKE_CURRENT_SOURCE_DIR}/layer_factory.json.in - -DLAYER_NAME="VK_LAYER_LUNARG_layer_factory" - -DRELATIVE_LAYER_BINARY="./libVkLayer_layer_factory.so" - -DVK_VERSION="${VulkanHeaders_VERSION}" - -DOUTPUT_FILE="layer_factory_linux.json" - ) - add_custom_target(layer_factory_linux-json ALL - COMMAND ${CMAKE_COMMAND} ${CONFIG_DEFINES} -P "${CMAKE_CURRENT_BINARY_DIR}/generator.cmake" - ) -endif() - -set (CMAKE_LAYER_FACTORY_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}) -SUBDIRLIST(ST_SUBDIRS ${CMAKE_LAYER_FACTORY_SOURCE_DIR}) - -# Loop through all subdirectories, creating a factory-based layer for each. For each factory layer, create a dependency link on -# the previous layer in order to serialize their builds. -set(dep_chain generate_vlf) -FOREACH(subdir ${ST_SUBDIRS}) - file(GLOB INTERCEPTOR_SOURCES ${CMAKE_LAYER_FACTORY_SOURCE_DIR}/${subdir}/*.h ${CMAKE_LAYER_FACTORY_SOURCE_DIR}/${subdir}/*.cpp) - add_factory_layer(${subdir} ${CMAKE_LAYER_FACTORY_SOURCE_DIR}/${subdir} layer_factory.cpp layer_factory.h ${INTERCEPTOR_SOURCES}) - add_dependencies(VkLayer_${subdir} ${dep_chain}) - set(dep_chain VkLayer_${subdir}) - set_target_properties(VkLayer_${subdir} PROPERTIES - CXX_STANDARD 17 - CXX_STANDARD_REQUIRED ON - CXX_EXTENSIONS OFF - ) -ENDFOREACH() - -# Add targets for JSON file install. Try to follow the same convention as the Khronos Vulkan-ValidationLayers repository to maintain -# a coherent directory topology in the install path. -if(WIN32) - foreach (factory_layer ${ST_SUBDIRS}) - set(config_file VkLayer_${factory_layer}) - install(FILES ${CMAKE_CURRENT_BINARY_DIR}/${config_file}.json DESTINATION ${CMAKE_INSTALL_LIBDIR}) - endforeach(factory_layer) -elseif(UNIX) - foreach (factory_layer ${ST_SUBDIRS}) - set(config_file VkLayer_${factory_layer}) - add_custom_target( - ${config_file}-staging-json ALL - COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_CURRENT_BINARY_DIR}/../layers/staging-json - COMMAND ${CMAKE_COMMAND} -E copy ${JSON_DEST_PATH}/${config_file}.json ${CMAKE_CURRENT_BINARY_DIR}/../layers/staging-json - COMMAND sed -i -e "/.library_path.:/s=./libVkLayer=libVkLayer=" ${CMAKE_CURRENT_BINARY_DIR}/../layers/staging-json/${config_file}.json - VERBATIM - DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/../layers/${config_file}.json - ) - - install(FILES ${CMAKE_CURRENT_BINARY_DIR}/../layers/staging-json/${config_file}.json DESTINATION ${CMAKE_INSTALL_SYSCONFDIR}/vulkan/explicit_layer.d) - install(TARGETS ${config_file} DESTINATION ${CMAKE_INSTALL_LIBDIR}) - endforeach(factory_layer) -endif() diff --git a/layer_factory/README.md b/layer_factory/README.md deleted file mode 100644 index 6dcd649e11..0000000000 --- a/layer_factory/README.md +++ /dev/null @@ -1,168 +0,0 @@ - -

    LunarG

    - -Copyright © 2015-2020 LunarG, Inc. - -[![Creative Commons][3]][4] - -[3]: https://i.creativecommons.org/l/by-nd/4.0/88x31.png "Creative Commons License" -[4]: https://creativecommons.org/licenses/by-nd/4.0/ - -# Vulkan Layer Factory - -## Overview - -The Vulkan Layer Factory is a framework based on the canonical Vulkan layer model that -facilitates the implementation of Vulkan Layers. The layer factory hides the majority of the -loader-layer interface, layer boilerplate, setup and initialization, and complexities -of layer development. - -A complete layer with the attendant support files can be produced by simply creating a -subdirectory in the layer\_factory directory and adding in a simple header file -and then running cmake. This layer can be used just as any other Vulkan layer. - -The Vulkan Layer Factory framework produces 'Factory Layers' comprising one or more -'interceptor' objects. Interceptor objects override functions to be called before (PreCallApiName) -or after (PostCallApiName) each Vulkan entrypoint of interest. Each interceptor is independent -of all others within a Factory Layer, and their call order is not guaranteed. - -### Layer Factory sample code - -The base installation of the layer factory contains some sample layers, including -the Demo layer and the Starter Layer. The Starter Layer in particular is meant to serve as -an example of a very simple layer implementation. - - -### Create a Factory Layer - - -Step 1: Create a subdirectory in the layer\_factory directory using a name that will serve as the base -for the final layer - - For example, a subdirectory named 'starter\_layer' will produce VkLayer\_starter\_layer.dll/libVkLayer\_starter\_layer.so and be loaded as VK_LAYER_LUNARG_starter_layer - -Step 2: Add your state tracker file(s) to the subdirectory. - - This can be a single header file, or multiple header and source files. - -Step 3: Create or copy an 'interceptor\_objects.h' file into your new directory - - This should include the header file for each of the included interceptors: - - #include "whatever_you_called_your_layers_header_file.h" - -Step 4: Run CMake and build. - - CMake will discover all Factory Layer subdirectories in layer_factory each time it is run. - A *.json and *.def file (for Windows) will also be created with your layer binary. - These files end up in the existing layers binary directory, and will be picked up - by the usual VK_LAYERS_PATH environment variable. - - Note that adding or removing a layer_factory subdirectory requires re-running CMake in order to - properly recognize the additions/deletions. - -## Using Layers - -1. Build VK loader using normal steps (cmake and make) -2. Place the layer library (dll or so) in the same directory as your VK test or application - - This is required for the Loader to be able to scan and enumerate your library. - Alternatively, use the `VK_LAYER_PATH` environment variable to specify where the layer libraries reside. - -3. Specify which layers to activate using environment variables. - - `export VK\_INSTANCE\_LAYERS=VK\_LAYER\_KHRONOS\_validation:VK\_LAYER\_LUNARG\_starter\_layer` - - -### Layer Factory Features - -The layer factory provides helper functions for layer authors to simplify layer tasks. These include some -simpler output functions, debug facilities, and simple global intercept functions. - - -Output Helpers: - -Interceptors can use base-class defined output helpers for simpler access to Debug Report Extension output. -These include Information(), Warning(), Performance\_Warning(), and Error(), corresponding to the -VkDebugReportFlagBitsEXT enumerations. Alternatively, the standard layer-provided log\_msg() call can be used -directly, as can printf for standard-out or OutputDebugString for Windows. - -Debug Helpers: - -A BreakPoint() helper can be used in an intercepted function which will generate a break in a Windows or Linux -debugger. - -Global Intercept Helpers: - -There are two global intercept helpers, PreCallApiFunction() and PostCallApiFunction(). Overriding these virtual -functions in your intercepter will result in them being called for EVERY API call. - -### Details - -By creating a child framework object, the factory will generate a full layer and call any overridden functions -in your interceptor. - -Here is a simple, and complete, interceptor (the starter\_layer). This layer intercepts the memory allocate and free -functions, tracking the number and total size of device memory allocations. The QueuePresent() function is also intercepted, and -results are outputted on every 60th frame. Note that the function signatures are identical to those in the specification. - -In this example, there is a single interceptor in which the child object is named 'MemAllocLevel' and is instantiated as -'high\_water\_mark'. An layer can contain many interceptors as long as the instantiated object names are unique within that layer. - - - #pragma once - #include - #include - - static uint32_t display_rate = 60; - - class MemAllocLevel : public layer_factory { - public: - // Constructor for interceptor - MemAllocLevel() : layer_factory(this), number_mem_objects_(0), total_memory_(0), present_count_(0) {}; - - // Intercept memory allocation calls and increment counter - VkResult PostCallAllocateMemory(VkDevice device, const VkMemoryAllocateInfo *pAllocateInfo, - const VkAllocationCallbacks *pAllocator, VkDeviceMemory *pMemory) { - number_mem_objects_++; - total_memory_ += pAllocateInfo->allocationSize; - mem_size_map_[*pMemory] = pAllocateInfo->allocationSize; - return VK_SUCCESS; - }; - - // Intercept free memory calls and update totals - void PreCallFreeMemory(VkDevice device, VkDeviceMemory memory, const VkAllocationCallbacks *pAllocator) { - if (memory != VK_NULL_HANDLE) { - number_mem_objects_--; - VkDeviceSize this_alloc = mem_size_map_[memory]; - total_memory_ -= this_alloc; - } - } - - VkResult PreCallQueuePresentKHR(VkQueue queue, const VkPresentInfoKHR *pPresentInfo) { - present_count_++; - if (present_count_ >= display_rate) { - present_count_ = 0; - std::stringstream message; - message << "Memory Allocation Count: " << number_mem_objects_ << "\n"; - message << "Total Memory Allocation Size: " << total_memory_ << "\n\n"; - Information(message.str()); - } - return VK_SUCCESS; - } - - private: - // Counter for the number of currently active memory allocations - uint32_t number_mem_objects_; - VkDeviceSize total_memory_; - uint32_t present_count_; - std::unordered_map mem_size_map_; - }; - - MemAllocLevel memory_allocation_stats; - -### Current known issues - - * CMake MUST be run to pick up and interpret new or deleted factory layers. - - diff --git a/layer_factory/VkLayer_layer_factory.def b/layer_factory/VkLayer_layer_factory.def deleted file mode 100644 index 0deb7258fc..0000000000 --- a/layer_factory/VkLayer_layer_factory.def +++ /dev/null @@ -1,6 +0,0 @@ -LIBRARY VkLayer_layer_factory -EXPORTS -vkGetInstanceProcAddr -vkGetDeviceProcAddr -vkEnumerateInstanceLayerProperties -vkEnumerateInstanceExtensionProperties diff --git a/layer_factory/demo_layer/demo.cpp b/layer_factory/demo_layer/demo.cpp deleted file mode 100644 index 06a02c429d..0000000000 --- a/layer_factory/demo_layer/demo.cpp +++ /dev/null @@ -1,73 +0,0 @@ -/* - * Copyright (c) 2015-2021 Valve Corporation - * Copyright (c) 2015-2021 LunarG, Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * Author: Mark Lobodzinski - */ - -#include "demo.h" -#include - -static uint32_t display_rate = 60; - -// This function will be called for every API call -void MemDemo::PreCallApiFunction(const char *api_name) { printf("Calling %s\n", api_name); } - -// Intercept the memory allocation calls and increment the counter -VkResult MemDemo::PostCallAllocateMemory(VkDevice device, const VkMemoryAllocateInfo *pAllocateInfo, - const VkAllocationCallbacks *pAllocator, VkDeviceMemory *pMemory, VkResult result) { - number_mem_objects_++; - total_memory_ += pAllocateInfo->allocationSize; - mem_size_map_[*pMemory] = pAllocateInfo->allocationSize; - return VK_SUCCESS; -} - -// Intercept the free memory calls and update totals -void MemDemo::PreCallFreeMemory(VkDevice device, VkDeviceMemory memory, const VkAllocationCallbacks *pAllocator) { - if (memory != VK_NULL_HANDLE) { - number_mem_objects_--; - VkDeviceSize this_alloc = mem_size_map_[memory]; - total_memory_ -= this_alloc; - } -} - -VkResult MemDemo::PreCallQueuePresentKHR(VkQueue queue, const VkPresentInfoKHR *pPresentInfo) { - present_count_++; - if (present_count_ >= display_rate) { - present_count_ = 0; - - std::stringstream message; - message << "Memory Allocation Count: " << number_mem_objects_ << "\n"; - message << "Total Memory Allocation Size: " << total_memory_ << "\n\n"; - - // Various text output options: - // Call through simplified interface - MemDemo::Information(message.str()); - -#ifdef _WIN32 - // On Windows, call OutputDebugString to send output to the MSVC output window or debug out - std::string str = message.str(); - LPCSTR cstr = str.c_str(); - OutputDebugStringA(cstr); -#endif - - // Option 3, use printf to stdout - printf("Demo layer: %s\n", message.str().c_str()); - } - - return VK_SUCCESS; -} - -MemDemo demo_mem_layer; diff --git a/layer_factory/demo_layer/demo.h b/layer_factory/demo_layer/demo.h deleted file mode 100644 index fc7b8383b9..0000000000 --- a/layer_factory/demo_layer/demo.h +++ /dev/null @@ -1,46 +0,0 @@ -/* - * Copyright (c) 2015-2021 Valve Corporation - * Copyright (c) 2015-2021 LunarG, Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * Author: Mark Lobodzinski - */ - -#pragma once - -#include -#include "vulkan/vulkan.h" -#include "error_message/logging.h" -#include "layer_factory.h" - -class MemDemo : public layer_factory { - public: - // Constructor for state_tracker - MemDemo() : number_mem_objects_(0), total_memory_(0), present_count_(0){}; - - void PreCallApiFunction(const char *api_name); - - VkResult PostCallAllocateMemory(VkDevice device, const VkMemoryAllocateInfo *pAllocateInfo, - const VkAllocationCallbacks *pAllocator, VkDeviceMemory *pMemory, VkResult result); - - void PreCallFreeMemory(VkDevice device, VkDeviceMemory memory, const VkAllocationCallbacks *pAllocator); - - VkResult PreCallQueuePresentKHR(VkQueue queue, const VkPresentInfoKHR *pPresentInfo); - - private: - uint32_t number_mem_objects_; - VkDeviceSize total_memory_; - uint32_t present_count_; - std::unordered_map mem_size_map_; -}; diff --git a/layer_factory/demo_layer/interceptor_objects.h b/layer_factory/demo_layer/interceptor_objects.h deleted file mode 100644 index 59a6a15251..0000000000 --- a/layer_factory/demo_layer/interceptor_objects.h +++ /dev/null @@ -1,20 +0,0 @@ -/* - * Copyright (c) 2015-2021 Valve Corporation - * Copyright (c) 2015-2021 LunarG, Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * Author: Mark Lobodzinski - */ - -#include "demo.h" diff --git a/layer_factory/layer_factory.json.in b/layer_factory/layer_factory.json.in deleted file mode 100644 index a7e6ce9eb1..0000000000 --- a/layer_factory/layer_factory.json.in +++ /dev/null @@ -1,29 +0,0 @@ -{ - "file_format_version" : "1.1.0", - "layer" : { - "name": "@LAYER_NAME@", - "type": "GLOBAL", - "library_path": "@RELATIVE_LAYER_BINARY@", - "api_version": "@VK_VERSION@", - "implementation_version": "1", - "description": "LunarG Validation Layer Factory Layer", - "instance_extensions": [ - { - "name": "VK_EXT_debug_report", - "spec_version": "6" - } - ], - "device_extensions": [ - { - "name": "VK_EXT_debug_marker", - "spec_version": "4", - "entrypoints": ["vkDebugMarkerSetObjectTagEXT", - "vkDebugMarkerSetObjectNameEXT", - "vkCmdDebugMarkerBeginEXT", - "vkCmdDebugMarkerEndEXT", - "vkCmdDebugMarkerInsertEXT" - ] - } - ] - } -} diff --git a/layer_factory/starter_layer/interceptor_objects.h b/layer_factory/starter_layer/interceptor_objects.h deleted file mode 100644 index eca1bc15c0..0000000000 --- a/layer_factory/starter_layer/interceptor_objects.h +++ /dev/null @@ -1,20 +0,0 @@ -/* - * Copyright (c) 2015-2021 Valve Corporation - * Copyright (c) 2015-2021 LunarG, Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * Author: Mark Lobodzinski - */ - -#include "memory_allocation_stats.h" diff --git a/layer_factory/starter_layer/memory_allocation_stats.h b/layer_factory/starter_layer/memory_allocation_stats.h deleted file mode 100644 index 039f1ae60a..0000000000 --- a/layer_factory/starter_layer/memory_allocation_stats.h +++ /dev/null @@ -1,70 +0,0 @@ -/* - * Copyright (c) 2015-2021 Valve Corporation - * Copyright (c) 2015-2021 LunarG, Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * Author: Mark Lobodzinski - */ - -#pragma once - -#include -#include - -static uint32_t display_rate = 60; - -class MemAllocLevel : public layer_factory { - public: - // Constructor for interceptor - MemAllocLevel() : number_mem_objects_(0), total_memory_(0), present_count_(0){}; - - // Intercept the memory allocation calls and increment the counter - VkResult PostCallAllocateMemory(VkDevice device, const VkMemoryAllocateInfo *pAllocateInfo, - const VkAllocationCallbacks *pAllocator, VkDeviceMemory *pMemory, VkResult result) { - number_mem_objects_++; - total_memory_ += pAllocateInfo->allocationSize; - mem_size_map_[*pMemory] = pAllocateInfo->allocationSize; - return VK_SUCCESS; - }; - - // Intercept the free memory calls and update totals - void PreCallFreeMemory(VkDevice device, VkDeviceMemory memory, const VkAllocationCallbacks *pAllocator) { - if (memory != VK_NULL_HANDLE) { - number_mem_objects_--; - VkDeviceSize this_alloc = mem_size_map_[memory]; - total_memory_ -= this_alloc; - } - } - - VkResult PreCallQueuePresentKHR(VkQueue queue, const VkPresentInfoKHR *pPresentInfo) { - present_count_++; - if (present_count_ >= display_rate) { - present_count_ = 0; - std::stringstream message; - message << "Memory Allocation Count: " << number_mem_objects_ << "\n"; - message << "Total Memory Allocation Size: " << total_memory_ << "\n\n"; - Information(message.str()); - } - return VK_SUCCESS; - } - - private: - // Counter for the number of currently active memory allocations - uint32_t number_mem_objects_; - VkDeviceSize total_memory_; - uint32_t present_count_; - std::unordered_map mem_size_map_; -}; - -MemAllocLevel memory_allocation_stats; diff --git a/scripts/github_ci_linux.py b/scripts/github_ci_linux.py index 4b0d743457..6ea0718bf6 100644 --- a/scripts/github_ci_linux.py +++ b/scripts/github_ci_linux.py @@ -43,8 +43,8 @@ def RunShellCmd(command, start_dir = PROJECT_ROOT): start_dir = repo_relative(start_dir) cmd_list = command.split(" ") subprocess.check_call(cmd_list, cwd=start_dir) - - + + # TODO: Pass this in as arg, may be useful for running locally EXTERNAL_DIR_NAME = "external" BUILD_DIR_NAME = "build" @@ -70,7 +70,7 @@ def BuildVT(args): print("Run update_external_sources.sh") RunShellCmd('./update_external_sources.sh') - + print("Run update_deps.py for VT Repository") update_cmd = 'python3 scripts/update_deps.py --dir %s --config %s --arch x64' % (EXTERNAL_DIR_NAME, args.configuration) RunShellCmd(update_cmd) @@ -114,13 +114,10 @@ def RunATest(vt_cmd, vt_env): def RunVTTests(args): print("Run VulkanTools Tests using Mock ICD") os.chdir(PROJECT_ROOT) - vt_cmd = '%s/tests/vlf_test.sh -t %s/Vulkan-Tools/%s' % (BUILD_DIR_NAME, EXTERNAL_DIR, BUILD_DIR_NAME) vt_env = dict(os.environ) vt_env['LD_LIBRARY_PATH'] = '%s/Vulkan-Loader/%s/loader' % (EXTERNAL_DIR, BUILD_DIR_NAME) vt_env['VK_LAYER_PATH'] = '%s/%s/layersvt:%s/%s/layers' % (PROJECT_ROOT, BUILD_DIR_NAME, PROJECT_ROOT, BUILD_DIR_NAME) vt_env['VK_ICD_FILENAMES'] = '%s/Vulkan-Tools/%s/icd/VkICD_mock_icd.json' % (EXTERNAL_DIR, BUILD_DIR_NAME) - vt_cmd = '%s/tests/vlf_test.sh -t %s/Vulkan-Tools/%s' % (BUILD_DIR_NAME, EXTERNAL_DIR, BUILD_DIR_NAME) - RunATest(vt_cmd, vt_env) vt_cmd = '%s/tests/apidump_test.sh -t %s/Vulkan-Tools/%s' % (BUILD_DIR_NAME, EXTERNAL_DIR, BUILD_DIR_NAME) RunATest(vt_cmd, vt_env) diff --git a/scripts/github_ci_win.py b/scripts/github_ci_win.py index 12c48b4f8c..75896ddf92 100644 --- a/scripts/github_ci_win.py +++ b/scripts/github_ci_win.py @@ -43,8 +43,8 @@ def RunShellCmd(command, start_dir = PROJECT_ROOT): start_dir = repo_relative(start_dir) cmd_list = command.split(" ") subprocess.check_call(cmd_list, cwd=start_dir) - - + + # TODO: Pass this in as arg, may be useful for running locally EXTERNAL_DIR_NAME = "external" BUILD_DIR_NAME = "build" @@ -69,14 +69,14 @@ def BuildVT(args): print("Run update_external_sources.bat") RunShellCmd('update_external_sources.bat') - + print("Run update_deps.py for VT Repository") update_cmd = 'python3 scripts/update_deps.py --dir %s --config %s --arch %s' % (EXTERNAL_DIR_NAME, args.configuration.lower(), args.arch.lower()) RunShellCmd(update_cmd) CreateBuildDirectory(VT_BUILD_DIR) print("Run CMake") - cmake_cmd = 'cmake -A %s -C ../%s/helper.cmake -DBUILD_VLF=OFF -DUSE_CCACHE=ON ..' % (args.arch, EXTERNAL_DIR_NAME) + cmake_cmd = 'cmake -A %s -C ../%s/helper.cmake -DUSE_CCACHE=ON ..' % (args.arch, EXTERNAL_DIR_NAME) RunShellCmd(cmake_cmd, VT_BUILD_DIR) print("Build Vulkan Tools") diff --git a/scripts/layer_factory_generator.py b/scripts/layer_factory_generator.py deleted file mode 100644 index 592804db26..0000000000 --- a/scripts/layer_factory_generator.py +++ /dev/null @@ -1,853 +0,0 @@ -#!/usr/bin/python3 -i -# -# Copyright (c) 2015-2020 Valve Corporation -# Copyright (c) 2015-2020 LunarG, Inc. -# Copyright (c) 2015-2020 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Author: Tobin Ehlis -# Author: Mark Lobodzinski -# -# This script generates the dispatch portion of a factory layer which intercepts -# all Vulkan functions. The resultant factory layer allows rapid development of -# layers and interceptors. - -import os,re,sys -from generator import * -from common_codegen import * - -# LayerFactoryGeneratorOptions - subclass of GeneratorOptions. -# -# Adds options used by LayerFactoryOutputGenerator objects during factory -# layer generation. -# -# Additional members -# prefixText - list of strings to prefix generated header with -# (usually a copyright statement + calling convention macros). -# protectFile - True if multiple inclusion protection should be -# generated (based on the filename) around the entire header. -# protectFeature - True if #ifndef..#endif protection should be -# generated around a feature interface in the header file. -# genFuncPointers - True if function pointer typedefs should be -# generated -# protectProto - If conditional protection should be generated -# around prototype declarations, set to either '#ifdef' -# to require opt-in (#ifdef protectProtoStr) or '#ifndef' -# to require opt-out (#ifndef protectProtoStr). Otherwise -# set to None. -# protectProtoStr - #ifdef/#ifndef symbol to use around prototype -# declarations, if protectProto is set -# apicall - string to use for the function declaration prefix, -# such as APICALL on Windows. -# apientry - string to use for the calling convention macro, -# in typedefs, such as APIENTRY. -# apientryp - string to use for the calling convention macro -# in function pointer typedefs, such as APIENTRYP. -# indentFuncProto - True if prototype declarations should put each -# parameter on a separate line -# indentFuncPointer - True if typedefed function pointers should put each -# parameter on a separate line -# alignFuncParam - if nonzero and parameters are being put on a -# separate line, align parameter names at the specified column -class LayerFactoryGeneratorOptions(GeneratorOptions): - def __init__(self, - conventions = None, - filename = None, - directory = '.', - genpath = None, - apiname = None, - profile = None, - versions = '.*', - emitversions = '.*', - defaultExtensions = None, - addExtensions = None, - removeExtensions = None, - emitExtensions = None, - sortProcedure = regSortFeatures, - prefixText = "", - genFuncPointers = True, - protectFile = True, - protectFeature = True, - apicall = '', - apientry = '', - apientryp = '', - indentFuncProto = True, - indentFuncPointer = False, - alignFuncParam = 0, - helper_file_type = '', - expandEnumerants = True): - GeneratorOptions.__init__(self, - conventions = conventions, - filename = filename, - directory = directory, - genpath = genpath, - apiname = apiname, - profile = profile, - versions = versions, - emitversions = emitversions, - defaultExtensions = defaultExtensions, - addExtensions = addExtensions, - removeExtensions = removeExtensions, - emitExtensions = emitExtensions, - sortProcedure = sortProcedure) - self.prefixText = prefixText - self.genFuncPointers = genFuncPointers - self.protectFile = protectFile - self.protectFeature = protectFeature - self.apicall = apicall - self.apientry = apientry - self.apientryp = apientryp - self.indentFuncProto = indentFuncProto - self.indentFuncPointer = indentFuncPointer - self.alignFuncParam = alignFuncParam - -# LayerFactoryOutputGenerator - subclass of OutputGenerator. -# Generates a LayerFactory layer that intercepts all API entrypoints -# This is intended to be used as a starting point for creating custom layers -# -# ---- methods ---- -# LayerFactoryOutputGenerator(errFile, warnFile, diagFile) - args as for -# OutputGenerator. Defines additional internal state. -# ---- methods overriding base class ---- -# beginFile(genOpts) -# endFile() -# beginFeature(interface, emit) -# endFeature() -# genType(typeinfo,name) -# genStruct(typeinfo,name) -# genGroup(groupinfo,name) -# genEnum(enuminfo, name) -# genCmd(cmdinfo) -class LayerFactoryOutputGenerator(OutputGenerator): - """Generate specified API interfaces in a specific style, such as a C header""" - # This is an ordered list of sections in the header file. - TYPE_SECTIONS = ['include', 'define', 'basetype', 'handle', 'enum', - 'group', 'bitmask', 'funcpointer', 'struct'] - ALL_SECTIONS = TYPE_SECTIONS + ['command'] - - - - - inline_custom_source_preamble = """ -// This file is ***GENERATED***. Do Not Edit. -// See layer_factory_generator.py for modifications. - -/* Copyright (c) 2015-2022 The Khronos Group Inc. - * Copyright (c) 2015-2022 Valve Corporation - * Copyright (c) 2015-2022 LunarG, Inc. - * Copyright (c) 2015-2022 Google Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * Author: Tobin Ehlis - * Author: Mark Lobodzinski - */ - -#include -#include - -#include - -#if defined(WIN32) -/* Windows-specific common code: */ -// WinBase.h defines CreateSemaphore and synchapi.h defines CreateEvent -// undefine them to avoid conflicts with VkLayerDispatchTable struct members. -#ifdef CreateSemaphore -#undef CreateSemaphore -#endif -#ifdef CreateEvent -#undef CreateEvent -#endif -#endif - -#define VALIDATION_ERROR_MAP_IMPL - -#include "generated/vk_dispatch_table_helper.h" -#include "containers/custom_containers.h" -#include "utils/vk_layer_extension_utils.h" -#include "error_message/logging.h" -#include "generated/vk_extension_helper.h" -#include "utils/vk_layer_utils.h" - -class layer_factory; -std::vector global_interceptor_list; -debug_report_data *vlf_report_data = VK_NULL_HANDLE; - -#include "layer_factory.h" - -struct instance_layer_data { - VkLayerInstanceDispatchTable dispatch_table; - VkInstance instance = VK_NULL_HANDLE; - debug_report_data *report_data = nullptr; - std::vector logging_callback; - std::vector logging_messenger; - InstanceExtensions extensions; -}; - -struct device_layer_data { - debug_report_data *report_data = nullptr; - VkLayerDispatchTable dispatch_table; - DeviceExtensions extensions = {}; - VkDevice device = VK_NULL_HANDLE; - VkPhysicalDevice physical_device = VK_NULL_HANDLE; - instance_layer_data *instance_data = nullptr; -}; - -static std::unordered_map device_layer_data_map; -static std::unordered_map instance_layer_data_map; - -#include "interceptor_objects.h" - -using mutex_t = std::mutex; -using lock_guard_t = std::lock_guard; -using unique_lock_t = std::unique_lock; - -namespace vulkan_layer_factory { - -using std::unordered_map; - -static mutex_t global_lock; - -static const VkLayerProperties global_layer = { - "VK_LAYER_LUNARG_layer_factory", VK_LAYER_API_VERSION, 1, "LunarG Layer Factory Layer", -}; - -static const VkExtensionProperties instance_extensions[] = {{VK_EXT_DEBUG_REPORT_EXTENSION_NAME, VK_EXT_DEBUG_REPORT_SPEC_VERSION}}; - -extern const std::unordered_map name_to_funcptr_map; - - -// Manually written functions - -VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL GetDeviceProcAddr(VkDevice device, const char *funcName) { - assert(device); - device_layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), device_layer_data_map); - const auto &item = name_to_funcptr_map.find(funcName); - if (item != name_to_funcptr_map.end()) { - return reinterpret_cast(item->second); - } - auto &table = device_data->dispatch_table; - if (!table.GetDeviceProcAddr) return nullptr; - return table.GetDeviceProcAddr(device, funcName); -} - -VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL GetInstanceProcAddr(VkInstance instance, const char *funcName) { - instance_layer_data *instance_data; - const auto &item = name_to_funcptr_map.find(funcName); - if (item != name_to_funcptr_map.end()) { - return reinterpret_cast(item->second); - } - instance_data = GetLayerDataPtr(get_dispatch_key(instance), instance_layer_data_map); - auto &table = instance_data->dispatch_table; - if (!table.GetInstanceProcAddr) return nullptr; - return table.GetInstanceProcAddr(instance, funcName); -} - -VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL GetPhysicalDeviceProcAddr(VkInstance instance, const char *funcName) { - instance_layer_data *instance_data = GetLayerDataPtr(get_dispatch_key(instance), instance_layer_data_map); - auto &table = instance_data->dispatch_table; - if (!table.GetPhysicalDeviceProcAddr) return nullptr; - return table.GetPhysicalDeviceProcAddr(instance, funcName); -} - -VKAPI_ATTR VkResult VKAPI_CALL EnumerateInstanceLayerProperties(uint32_t *pCount, VkLayerProperties *pProperties) { - return util_GetLayerProperties(1, &global_layer, pCount, pProperties); -} - -VKAPI_ATTR VkResult VKAPI_CALL EnumerateDeviceLayerProperties(VkPhysicalDevice physicalDevice, uint32_t *pCount, - VkLayerProperties *pProperties) { - return util_GetLayerProperties(1, &global_layer, pCount, pProperties); -} - -VKAPI_ATTR VkResult VKAPI_CALL EnumerateInstanceExtensionProperties(const char *pLayerName, uint32_t *pCount, - VkExtensionProperties *pProperties) { - if (pLayerName && !strcmp(pLayerName, global_layer.layerName)) - return util_GetExtensionProperties(1, instance_extensions, pCount, pProperties); - - return VK_ERROR_LAYER_NOT_PRESENT; -} - -VKAPI_ATTR VkResult VKAPI_CALL EnumerateDeviceExtensionProperties(VkPhysicalDevice physicalDevice, const char *pLayerName, - uint32_t *pCount, VkExtensionProperties *pProperties) { - if (pLayerName && !strcmp(pLayerName, global_layer.layerName)) return util_GetExtensionProperties(0, NULL, pCount, pProperties); - - assert(physicalDevice); - - instance_layer_data *instance_data = GetLayerDataPtr(get_dispatch_key(physicalDevice), instance_layer_data_map); - return instance_data->dispatch_table.EnumerateDeviceExtensionProperties(physicalDevice, NULL, pCount, pProperties); -} - -VKAPI_ATTR VkResult VKAPI_CALL CreateInstance(const VkInstanceCreateInfo *pCreateInfo, const VkAllocationCallbacks *pAllocator, - VkInstance *pInstance) { - VkLayerInstanceCreateInfo *chain_info = get_chain_info(pCreateInfo, VK_LAYER_LINK_INFO); - - assert(chain_info->u.pLayerInfo); - PFN_vkGetInstanceProcAddr fpGetInstanceProcAddr = chain_info->u.pLayerInfo->pfnNextGetInstanceProcAddr; - PFN_vkCreateInstance fpCreateInstance = (PFN_vkCreateInstance)fpGetInstanceProcAddr(NULL, "vkCreateInstance"); - if (fpCreateInstance == NULL) return VK_ERROR_INITIALIZATION_FAILED; - chain_info->u.pLayerInfo = chain_info->u.pLayerInfo->pNext; - - // Init dispatch array and call registration functions - for (auto intercept : global_interceptor_list) { - intercept->PreCallCreateInstance(pCreateInfo, pAllocator, pInstance); - } - - VkResult result = fpCreateInstance(pCreateInfo, pAllocator, pInstance); - - instance_layer_data *instance_data = GetLayerDataPtr(get_dispatch_key(*pInstance), instance_layer_data_map); - instance_data->instance = *pInstance; - layer_init_instance_dispatch_table(*pInstance, &instance_data->dispatch_table, fpGetInstanceProcAddr); - instance_data->report_data = new debug_report_data{}; - instance_data->extensions.InitFromInstanceCreateInfo((pCreateInfo->pApplicationInfo ? pCreateInfo->pApplicationInfo->apiVersion : VK_API_VERSION_1_0), pCreateInfo); - layer_debug_messenger_actions(instance_data->report_data, "lunarg_layer_factory"); - vlf_report_data = instance_data->report_data; - - for (auto intercept : global_interceptor_list) { - intercept->PostCallCreateInstance(pCreateInfo, pAllocator, pInstance, result); - } - - return result; -} - -VKAPI_ATTR void VKAPI_CALL DestroyInstance(VkInstance instance, const VkAllocationCallbacks *pAllocator) { - dispatch_key key = get_dispatch_key(instance); - instance_layer_data *instance_data = GetLayerDataPtr(key, instance_layer_data_map); - for (auto intercept : global_interceptor_list) { - intercept->PreCallDestroyInstance(instance, pAllocator); - } - - instance_data->dispatch_table.DestroyInstance(instance, pAllocator); - - lock_guard_t lock(global_lock); - for (auto intercept : global_interceptor_list) { - intercept->PostCallDestroyInstance(instance, pAllocator); - } - // Clean up logging callback, if any - while (instance_data->logging_messenger.size() > 0) { - VkDebugUtilsMessengerEXT messenger = instance_data->logging_messenger.back(); - LayerDestroyCallback(instance_data->report_data, messenger); - instance_data->logging_messenger.pop_back(); - } - while (instance_data->logging_callback.size() > 0) { - VkDebugReportCallbackEXT callback = instance_data->logging_callback.back(); - LayerDestroyCallback(instance_data->report_data, callback); - instance_data->logging_callback.pop_back(); - } - LayerDebugUtilsDestroyInstance(instance_data->report_data); - FreeLayerDataPtr(key, instance_layer_data_map); -} - -VKAPI_ATTR VkResult VKAPI_CALL CreateDevice(VkPhysicalDevice gpu, const VkDeviceCreateInfo *pCreateInfo, - const VkAllocationCallbacks *pAllocator, VkDevice *pDevice) { - instance_layer_data *instance_data = GetLayerDataPtr(get_dispatch_key(gpu), instance_layer_data_map); - - unique_lock_t lock(global_lock); - VkLayerDeviceCreateInfo *chain_info = get_chain_info(pCreateInfo, VK_LAYER_LINK_INFO); - PFN_vkGetInstanceProcAddr fpGetInstanceProcAddr = chain_info->u.pLayerInfo->pfnNextGetInstanceProcAddr; - PFN_vkGetDeviceProcAddr fpGetDeviceProcAddr = chain_info->u.pLayerInfo->pfnNextGetDeviceProcAddr; - PFN_vkCreateDevice fpCreateDevice = (PFN_vkCreateDevice)fpGetInstanceProcAddr(instance_data->instance, "vkCreateDevice"); - chain_info->u.pLayerInfo = chain_info->u.pLayerInfo->pNext; - - for (auto intercept : global_interceptor_list) { - intercept->PreCallCreateDevice(gpu, pCreateInfo, pAllocator, pDevice); - } - lock.unlock(); - - VkResult result = fpCreateDevice(gpu, pCreateInfo, pAllocator, pDevice); - - lock.lock(); - for (auto intercept : global_interceptor_list) { - intercept->PostCallCreateDevice(gpu, pCreateInfo, pAllocator, pDevice, result); - } - device_layer_data *device_data = GetLayerDataPtr(get_dispatch_key(*pDevice), device_layer_data_map); - device_data->instance_data = instance_data; - layer_init_device_dispatch_table(*pDevice, &device_data->dispatch_table, fpGetDeviceProcAddr); - device_data->device = *pDevice; - device_data->physical_device = gpu; - device_data->report_data = instance_data->report_data; - VkPhysicalDeviceProperties physical_device_properties{}; - instance_data->dispatch_table.GetPhysicalDeviceProperties(gpu, &physical_device_properties); - device_data->extensions.InitFromDeviceCreateInfo(&instance_data->extensions, physical_device_properties.apiVersion, pCreateInfo); - lock.unlock(); - - return result; -} - -VKAPI_ATTR void VKAPI_CALL DestroyDevice(VkDevice device, const VkAllocationCallbacks *pAllocator) { - dispatch_key key = get_dispatch_key(device); - device_layer_data *device_data = GetLayerDataPtr(key, device_layer_data_map); - - unique_lock_t lock(global_lock); - for (auto intercept : global_interceptor_list) { - intercept->PreCallDestroyDevice(device, pAllocator); - } - lock.unlock(); - - device_data->dispatch_table.DestroyDevice(device, pAllocator); - - lock.lock(); - for (auto intercept : global_interceptor_list) { - intercept->PostCallDestroyDevice(device, pAllocator); - } - - FreeLayerDataPtr(key, device_layer_data_map); -} - -VKAPI_ATTR VkResult VKAPI_CALL CreateDebugReportCallbackEXT(VkInstance instance, - const VkDebugReportCallbackCreateInfoEXT *pCreateInfo, - const VkAllocationCallbacks *pAllocator, - VkDebugReportCallbackEXT *pCallback) { - instance_layer_data *instance_data = GetLayerDataPtr(get_dispatch_key(instance), instance_layer_data_map); - for (auto intercept : global_interceptor_list) { - intercept->PreCallCreateDebugReportCallbackEXT(instance, pCreateInfo, pAllocator, pCallback); - } - VkResult result = instance_data->dispatch_table.CreateDebugReportCallbackEXT(instance, pCreateInfo, pAllocator, pCallback); - result = LayerCreateReportCallback(instance_data->report_data, false, pCreateInfo, pCallback); - for (auto intercept : global_interceptor_list) { - intercept->PostCallCreateDebugReportCallbackEXT(instance, pCreateInfo, pAllocator, pCallback, result); - } - return result; -} - -VKAPI_ATTR void VKAPI_CALL DestroyDebugReportCallbackEXT(VkInstance instance, VkDebugReportCallbackEXT callback, - const VkAllocationCallbacks *pAllocator) { - instance_layer_data *instance_data = GetLayerDataPtr(get_dispatch_key(instance), instance_layer_data_map); - for (auto intercept : global_interceptor_list) { - intercept->PreCallDestroyDebugReportCallbackEXT(instance, callback, pAllocator); - } - instance_data->dispatch_table.DestroyDebugReportCallbackEXT(instance, callback, pAllocator); - LayerDestroyCallback(instance_data->report_data, callback); - for (auto intercept : global_interceptor_list) { - intercept->PostCallDestroyDebugReportCallbackEXT(instance, callback, pAllocator); - } -} -""" - - inline_custom_source_postamble = """ -// loader-layer interface v0, just wrappers since there is only a layer - -#if defined(__GNUC__) && __GNUC__ >= 4 -#define EXPORT_FUNCTION __attribute__((visibility("default"))) -#elif defined(__SUNPRO_C) && (__SUNPRO_C >= 0x590) -#define EXPORT_FUNCTION __attribute__((visibility("default"))) -#else -#define EXPORT_FUNCTION -#endif - -EXPORT_FUNCTION VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateInstanceExtensionProperties(const char *pLayerName, uint32_t *pCount, - VkExtensionProperties *pProperties) { - return vulkan_layer_factory::EnumerateInstanceExtensionProperties(pLayerName, pCount, pProperties); -} - -EXPORT_FUNCTION VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateInstanceLayerProperties(uint32_t *pCount, - VkLayerProperties *pProperties) { - return vulkan_layer_factory::EnumerateInstanceLayerProperties(pCount, pProperties); -} - -EXPORT_FUNCTION VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateDeviceLayerProperties(VkPhysicalDevice physicalDevice, uint32_t *pCount, - VkLayerProperties *pProperties) { - // the layer command handles VK_NULL_HANDLE just fine internally - assert(physicalDevice == VK_NULL_HANDLE); - return vulkan_layer_factory::EnumerateDeviceLayerProperties(VK_NULL_HANDLE, pCount, pProperties); -} - -EXPORT_FUNCTION VKAPI_ATTR VkResult VKAPI_CALL vkEnumerateDeviceExtensionProperties(VkPhysicalDevice physicalDevice, - const char *pLayerName, uint32_t *pCount, - VkExtensionProperties *pProperties) { - // the layer command handles VK_NULL_HANDLE just fine internally - assert(physicalDevice == VK_NULL_HANDLE); - return vulkan_layer_factory::EnumerateDeviceExtensionProperties(VK_NULL_HANDLE, pLayerName, pCount, pProperties); -} - -EXPORT_FUNCTION VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetDeviceProcAddr(VkDevice dev, const char *funcName) { - return vulkan_layer_factory::GetDeviceProcAddr(dev, funcName); -} - -EXPORT_FUNCTION VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetInstanceProcAddr(VkInstance instance, const char *funcName) { - return vulkan_layer_factory::GetInstanceProcAddr(instance, funcName); -} - -VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vk_layerGetPhysicalDeviceProcAddr(VkInstance instance, - const char *funcName) { - return vulkan_layer_factory::GetPhysicalDeviceProcAddr(instance, funcName); -} - -EXPORT_FUNCTION VKAPI_ATTR VkResult VKAPI_CALL vkNegotiateLoaderLayerInterfaceVersion(VkNegotiateLayerInterface *pVersionStruct) { - assert(pVersionStruct != NULL); - assert(pVersionStruct->sType == LAYER_NEGOTIATE_INTERFACE_STRUCT); - - // Fill in the function pointers if our version is at least capable of having the structure contain them. - if (pVersionStruct->loaderLayerInterfaceVersion >= 2) { - pVersionStruct->pfnGetInstanceProcAddr = vkGetInstanceProcAddr; - pVersionStruct->pfnGetDeviceProcAddr = vkGetDeviceProcAddr; - pVersionStruct->pfnGetPhysicalDeviceProcAddr = vk_layerGetPhysicalDeviceProcAddr; - } - - return VK_SUCCESS; -}""" - - - - - - def __init__(self, - errFile = sys.stderr, - warnFile = sys.stderr, - diagFile = sys.stdout): - OutputGenerator.__init__(self, errFile, warnFile, diagFile) - # Internal state - accumulators for different inner block text - self.sections = dict([(section, []) for section in self.ALL_SECTIONS]) - self.intercepts = [] - self.layer_factory = '' # String containing base layer factory class definition - - # Check if the parameter passed in is a pointer to an array - def paramIsArray(self, param): - return param.attrib.get('len') is not None - - # Check if the parameter passed in is a pointer - def paramIsPointer(self, param): - ispointer = False - for elem in param: - if elem.tag == 'type' and elem.tail is not None and '*' in elem.tail: - ispointer = True - return ispointer - - # Check if an object is a non-dispatchable handle - def isHandleTypeNonDispatchable(self, handletype): - handle = self.registry.tree.find("types/type/[name='" + handletype + "'][@category='handle']") - if handle is not None and handle.find('type').text == 'VK_DEFINE_NON_DISPATCHABLE_HANDLE': - return True - else: - return False - - # Check if an object is a dispatchable handle - def isHandleTypeDispatchable(self, handletype): - handle = self.registry.tree.find("types/type/[name='" + handletype + "'][@category='handle']") - if handle is not None and handle.find('type').text == 'VK_DEFINE_HANDLE': - return True - else: - return False - - def beginFile(self, genOpts): - OutputGenerator.beginFile(self, genOpts) - # Multiple inclusion protection & C++ namespace. - self.header = False - if (self.genOpts.filename and 'h' == self.genOpts.filename[-1]): - self.header = True - write('#pragma once', file=self.outFile) - self.newline() - # User-supplied prefix text, if any (list of strings) - if self.header: - if (genOpts.prefixText): - for s in genOpts.prefixText: - write(s, file=self.outFile) - write('#include "vulkan/vk_layer.h"', file=self.outFile) - write('#include \n', file=self.outFile) - write('#include \n', file=self.outFile) - write('class layer_factory;', file=self.outFile) - write('extern std::vector global_interceptor_list;', file=self.outFile) - write('extern debug_report_data *vlf_report_data;\n', file=self.outFile) - write('namespace vulkan_layer_factory {\n', file=self.outFile) - else: - write(self.inline_custom_source_preamble, file=self.outFile) - - # Initialize Enum Section - self.layer_factory += '// Layer Factory base class definition\n' - self.layer_factory += 'class layer_factory {\n' - self.layer_factory += ' public:\n' - self.layer_factory += ' layer_factory() {\n' - self.layer_factory += ' global_interceptor_list.emplace_back(this);\n' - self.layer_factory += ' };\n' - self.layer_factory += '\n' - self.layer_factory += ' std::string layer_name = "VLF";\n' - self.layer_factory += '\n' - self.layer_factory += ' bool log_msg(const debug_report_data *debug_data, VkFlags msg_flags, VkObjectType object_type,\n' - self.layer_factory += ' uint64_t src_object, const std::string &vuid_text, const char *format, ...) {\n' - self.layer_factory += ' if (!debug_data) return false;\n' - self.layer_factory += '\n' - self.layer_factory += ' VulkanTypedHandle null_handle{};\n' - self.layer_factory += ' LogObjectList objlist(null_handle);\n' - self.layer_factory += ' va_list argptr;\n' - self.layer_factory += ' va_start(argptr, format);\n' - self.layer_factory += ' const bool result = LogMsg(debug_data, msg_flags, objlist, vuid_text, format, argptr);\n' - self.layer_factory += ' va_end(argptr);\n' - self.layer_factory += '\n' - self.layer_factory += ' return result;\n' - self.layer_factory += ' }\n' - self.layer_factory += '\n' - self.layer_factory += ' // Pre/post hook point declarations\n' - self.layer_factory += ' bool Information(const std::string &message) {\n' - self.layer_factory += ' return log_msg(vlf_report_data, kInformationBit, VK_OBJECT_TYPE_UNKNOWN, 0,\n' - self.layer_factory += ' layer_name.c_str(), "%s", message.c_str());\n' - self.layer_factory += ' }\n' - self.layer_factory += '\n' - self.layer_factory += ' bool PerformanceWarning(const std::string &message) {\n' - self.layer_factory += ' return log_msg(vlf_report_data, kPerformanceWarningBit, VK_OBJECT_TYPE_UNKNOWN,\n' - self.layer_factory += ' 0, layer_name.c_str(), "%s", message.c_str());\n' - self.layer_factory += ' }\n' - self.layer_factory += '\n' - self.layer_factory += ' bool Warning(const std::string &message) {\n' - self.layer_factory += ' return log_msg(vlf_report_data, kWarningBit, VK_OBJECT_TYPE_UNKNOWN, 0,\n' - self.layer_factory += ' layer_name.c_str(), "%s", message.c_str());\n' - self.layer_factory += ' }\n' - self.layer_factory += '\n' - self.layer_factory += ' bool Error(const std::string &message) {\n' - self.layer_factory += ' return log_msg(vlf_report_data, kVerboseBit, VK_OBJECT_TYPE_UNKNOWN, 0,\n' - self.layer_factory += ' layer_name.c_str(), "%s", message.c_str());\n' - self.layer_factory += ' }\n' - self.layer_factory += '\n' - self.layer_factory += ' void Breakpoint(void) {\n' - self.layer_factory += '#ifdef WIN32\n' - self.layer_factory += ' DebugBreak();\n' - self.layer_factory += '#else\n' - self.layer_factory += ' raise(SIGTRAP);\n' - self.layer_factory += '#endif\n' - self.layer_factory += ' }\n' - self.layer_factory += '\n' - self.layer_factory += ' virtual void PreCallApiFunction(const char *api_name) {};\n' - self.layer_factory += ' virtual void PostCallApiFunction(const char *api_name) {};\n' - self.layer_factory += ' virtual void PreCallApiFunction(const char *api_name, VkResult result) {};\n' - self.layer_factory += ' virtual void PostCallApiFunction(const char *api_name, VkResult result) {};\n' - self.layer_factory += '\n' - self.layer_factory += ' // Pre/post hook point declarations\n' - # - def endFile(self): - # Finish C++ namespace and multiple inclusion protection - self.newline() - if not self.header: - # Record intercepted procedures - write('// Map of all APIs to be intercepted by this layer', file=self.outFile) - write('const std::unordered_map name_to_funcptr_map = {', file=self.outFile) - write('\n'.join(self.intercepts), file=self.outFile) - write('};\n', file=self.outFile) - self.newline() - write('} // namespace vulkan_layer_factory', file=self.outFile) - if self.header: - self.newline() - # Output Layer Factory Class Definitions - self.layer_factory += '};\n' - write(self.layer_factory, file=self.outFile) - else: - write(self.inline_custom_source_postamble, file=self.outFile) - # Finish processing in superclass - OutputGenerator.endFile(self) - - def beginFeature(self, interface, emit): - # Start processing in superclass - OutputGenerator.beginFeature(self, interface, emit) - # Get feature extra protect - self.featureExtraProtect = GetFeatureProtect(interface) - # Accumulate includes, defines, types, enums, function pointer typedefs, end function prototypes separately for this - # feature. They're only printed in endFeature(). - self.sections = dict([(section, []) for section in self.ALL_SECTIONS]) - - def endFeature(self): - # Actually write the interface to the output file. - if (self.emit): - self.newline() - # If type declarations are needed by other features based on this one, it may be necessary to suppress the ExtraProtect, - # or move it below the 'for section...' loop. - if (self.featureExtraProtect is not None): - write('#ifdef', self.featureExtraProtect, file=self.outFile) - for section in self.TYPE_SECTIONS: - contents = self.sections[section] - if contents: - write('\n'.join(contents), file=self.outFile) - self.newline() - if (self.sections['command']): - write('\n'.join(self.sections['command']), end=u'', file=self.outFile) - self.newline() - if (self.featureExtraProtect is not None): - write('#endif /*', self.featureExtraProtect, '*/', file=self.outFile) - # Finish processing in superclass - OutputGenerator.endFeature(self) - # - # Append a definition to the specified section - def appendSection(self, section, text): - self.sections[section].append(text) - # - # Type generation - def genType(self, typeinfo, name, alias): - pass - # - # Struct (e.g. C "struct" type) generation. This is a special case of the tag where the contents are - # interpreted as a set of tags instead of freeform C type declarations. The tags are just like - # tags - they are a declaration of a struct or union member. Only simple member declarations are supported (no nested - # structs etc.) - def genStruct(self, typeinfo, typeName): - OutputGenerator.genStruct(self, typeinfo, typeName) - body = 'typedef ' + typeinfo.elem.get('category') + ' ' + typeName + ' {\n' - # paramdecl = self.makeCParamDecl(typeinfo.elem, self.genOpts.alignFuncParam) - for member in typeinfo.elem.findall('.//member'): - body += self.makeCParamDecl(member, self.genOpts.alignFuncParam) - body += ';\n' - body += '} ' + typeName + ';\n' - self.appendSection('struct', body) - # - # Group (e.g. C "enum" type) generation. These are concatenated together with other types. - def genGroup(self, groupinfo, groupName, alias): - pass - # Enumerant generation - # tags may specify their values in several ways, but are usually just integers. - def genEnum(self, enuminfo, name, alias): - pass - # - # Customize Cdecl for layer factory base class - def BaseClassCdecl(self, elem, name): - raw = self.makeCDecls(elem)[1] - # Change initial keyword - result = raw.replace("typedef", "virtual") - # Remove first set of parenthesis - result = result.replace("(", "", 1) - result = result.replace(")", "", 1) - # Add default implementation: This map contains the default function definitions for the return types of Vulkan Commands. - # If any new return types are required, they'll need to be added to this dict. - return_map = { - 'PFN_vkVoidFunction': ' { return nullptr; };', - 'uint32_t': ' { return 0; };', - 'uint64_t': ' { return 0; };', - 'VkBool32': ' { return VK_TRUE; };', - 'VkDeviceAddress': '{ return 0; };', - 'VkResult': ' { return VK_SUCCESS; };', - 'VkDeviceSize': ' { return 0; };', - 'void': ' {};', - } - return_type = result.split(" ")[1] - default_def = return_map[return_type] - result = result.replace(';', default_def, 1) - pre_call = result.replace("VKAPI_PTR *PFN_vk", "PreCall") - pre_call_function = '{ PreCallApiFunction("%s");' % name - pre_call = pre_call.replace("{", pre_call_function) - post_call = pre_call.replace("PreCall", "PostCall") - if return_type == 'VkResult': - post_call = post_call.replace(')', ', VkResult result)', 1) - post_call = post_call.replace(');', ', result);', 1); - return ' %s\n %s\n' % (pre_call, post_call) - # - # Command generation - def genCmd(self, cmdinfo, name, alias): - ignore_functions = [ - 'vkEnumerateInstanceVersion' - ] - - if name in ignore_functions: - return - - if self.header: # In the header declare all intercepts - self.appendSection('command', '') - self.appendSection('command', self.makeCDecls(cmdinfo.elem)[0]) - if (self.featureExtraProtect is not None): - self.intercepts += [ '#ifdef %s' % self.featureExtraProtect ] - self.layer_factory += '#ifdef %s\n' % self.featureExtraProtect - # Update base class with virtual function declarations - self.layer_factory += self.BaseClassCdecl(cmdinfo.elem, name) - # Update function intercepts - self.intercepts += [ ' {"%s", (void*)%s},' % (name,name[2:]) ] - if (self.featureExtraProtect is not None): - self.intercepts += [ '#endif' ] - self.layer_factory += '#endif\n' - return - - manual_functions = [ - # Include functions here to be interecpted w/ manually implemented function bodies - 'vkGetDeviceProcAddr', - 'vkGetInstanceProcAddr', - 'vkGetPhysicalDeviceProcAddr', - 'vkCreateDevice', - 'vkDestroyDevice', - 'vkCreateInstance', - 'vkDestroyInstance', - 'vkCreateDebugReportCallbackEXT', - 'vkDestroyDebugReportCallbackEXT', - 'vkEnumerateInstanceLayerProperties', - 'vkEnumerateInstanceExtensionProperties', - 'vkEnumerateDeviceLayerProperties', - 'vkEnumerateDeviceExtensionProperties', - ] - if name in manual_functions: - ####decls = self.makeCDecls(cmdinfo.elem) - ####self.appendSection('command', '') - ####self.appendSection('command', '// Declare only') - ####self.appendSection('command', decls[0]) - self.intercepts += [ ' {"%s", (void*)%s},' % (name,name[2:]) ] - return - # Record that the function will be intercepted - if (self.featureExtraProtect is not None): - self.intercepts += [ '#ifdef %s' % self.featureExtraProtect ] - self.intercepts += [ ' {"%s", (void*)%s},' % (name,name[2:]) ] - if (self.featureExtraProtect is not None): - self.intercepts += [ '#endif' ] - OutputGenerator.genCmd(self, cmdinfo, name, alias) - # - decls = self.makeCDecls(cmdinfo.elem) - self.appendSection('command', '') - self.appendSection('command', '%s {' % decls[0][:-1]) - # Setup common to call wrappers. First parameter is always dispatchable - dispatchable_type = cmdinfo.elem.find('param/type').text - dispatchable_name = cmdinfo.elem.find('param/name').text - # Default to device - device_or_instance = 'device' - dispatch_table_name = 'VkLayerDispatchTable' - # Set to instance as necessary - if dispatchable_type in ["VkPhysicalDevice", "VkInstance"] or name == 'vkCreateInstance': - device_or_instance = 'instance' - dispatch_table_name = 'VkLayerInstanceDispatchTable' - self.appendSection('command', ' %s_layer_data *%s_data = GetLayerDataPtr(get_dispatch_key(%s), %s_layer_data_map);' % (device_or_instance, device_or_instance, dispatchable_name, device_or_instance)) - api_function_name = cmdinfo.elem.attrib.get('name') - params = cmdinfo.elem.findall('param/name') - paramstext = ', '.join([str(param.text) for param in params]) - API = api_function_name.replace('vk','%s_data->dispatch_table.' % (device_or_instance),1) - - # Generate pre-call object processing source code - self.appendSection('command', ' for (auto intercept : global_interceptor_list) {') - self.appendSection('command', ' intercept->PreCall%s(%s);' % (api_function_name[2:], paramstext)) - self.appendSection('command', ' }') - - # Declare result variable, if any. - resulttype = cmdinfo.elem.find('proto/type') - if (resulttype is not None and resulttype.text == 'void'): - resulttype = None - if (resulttype is not None): - assignresult = resulttype.text + ' result = ' - else: - assignresult = '' - - self.appendSection('command', ' ' + assignresult + API + '(' + paramstext + ');') - - # Generate post-call object processing source code - returnParam = '' - if (resulttype is not None and resulttype.text == 'VkResult'): - returnParam = ', result' - self.appendSection('command', ' for (auto intercept : global_interceptor_list) {') - self.appendSection('command', ' intercept->PostCall%s(%s%s);' % (api_function_name[2:], paramstext, returnParam)) - self.appendSection('command', ' }') - - # Return result variable, if any. - if (resulttype is not None): - self.appendSection('command', ' return result;') - self.appendSection('command', '}') - # - # Override makeProtoName to drop the "vk" prefix - def makeProtoName(self, name, tail): - return self.genOpts.apientry + name[2:] + tail diff --git a/scripts/vlf_makefile_generator.py b/scripts/vlf_makefile_generator.py deleted file mode 100644 index c3d53df364..0000000000 --- a/scripts/vlf_makefile_generator.py +++ /dev/null @@ -1,103 +0,0 @@ -#!/usr/bin/env python3 -# -# Copyright (c) 2015-2017 Valve Corporation -# Copyright (c) 2015-2017 LunarG, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Author: Mark Lobodzinski - -import os -import subprocess -import sys -from glob import glob - -if __name__ == '__main__': - if (len(sys.argv) != 3): - print("Usage: %s temp_output_file - -# Fail if temp file is not present, or if results do not match expectations -if (!(Test-Path temp_output_file)) { - echo 'Output file does not exist' - write-host -background black -foreground red "[ FAILED ] " -nonewline; - $exitstatus = 1 -} else { - # Look for sensible results in output file - $count = (Select-String -Path .\temp_output_file -Pattern "vkGetPhysicalDeviceFormatProperties").length - if ($count -lt 50) { - $exitstatus = 1 - } -} - -# Output pass/fail result -if ($exitstatus -eq 0) { - write-host -background black -foreground green "[ PASSED ] " -nonewline; -} else { - write-host -background black -foreground red "[ FAILED ] " -} - -# Clean up env, files, path -Remove-Item Env:\VK_INSTANCE_LAYERS -Remove-Item Env:\VK_ICD_FILENAMES -Remove-Item Env:\VK_LAYER_PATH - -Remove-Item -Path .\temp_output_file - -cd $current_directory - -exit $exitstatus diff --git a/tests/vlf_test.sh b/tests/vlf_test.sh deleted file mode 100755 index 6453d5e5e7..0000000000 --- a/tests/vlf_test.sh +++ /dev/null @@ -1,79 +0,0 @@ -#!/bin/bash - -# vlf_test.sh -# This script will run the demo vulkaninfo with the demo_layer and capture the output. -# This layer will output all of the API names used by the application, and this script -# will search the output for a certain amount of APIs that are known to be used by this -# demo. If the threshold is met, the test will indicate PASS, else FAILURE. This -# script requires a path to the Vulkan-Tools build directory so that it can locate -# vulkaninfo and the mock ICD. The path can be defined using the environment variable -# VULKAN_TOOLS_BUILD_DIR or using the command-line argument -t or --tools. - -# Track unrecognized arguments. -UNRECOGNIZED=() - -# Parse the command-line arguments. -while [[ $# -gt 0 ]] -do - KEY="$1" - case $KEY in - -t|--tools) - VULKAN_TOOLS_BUILD_DIR="$2" - shift - shift - ;; - *) - UNRECOGNIZED+=("$1") - shift - ;; - esac -done - -# Reject unrecognized arguments. -if [[ ${#UNRECOGNIZED[@]} -ne 0 ]]; then - echo "ERROR: $0:$LINENO" - ehco "Unrecognized command-line arguments: ${UNRECOGNIZED[*]}" - exit 1 -fi - -if [ -z ${VULKAN_TOOLS_BUILD_DIR+x} ]; then - echo "ERROR: $0:$LINENO" - echo "Vulkan-Tools build directory is undefined." - echo "Please set VULKAN_TOOLS_BUILD_DIR or use the -t|--tools command line option." - exit 1 -fi - -if [ -t 1 ] ; then - RED='\033[0;31m' - GREEN='\033[0;32m' - NC='\033[0m' # No Color -else - RED='' - GREEN='' - NC='' -fi - -cd $(dirname "${BASH_SOURCE[0]}") - -VULKANINFO="$VULKAN_TOOLS_BUILD_DIR/install/bin/vulkaninfo" -VK_ICD_FILENAMES="$VULKAN_TOOLS_BUILD_DIR/icd/VkICD_mock_icd.json" \ - VK_INSTANCE_LAYERS=VK_LAYER_LUNARG_demo_layer \ - "$VULKANINFO" --show-formats > file.tmp - -printf "$GREEN[ RUN ]$NC $0\n" -if [ -f file.tmp ] -then - count=$(grep vkGetPhysicalDeviceFormatProperties file.tmp | wc -l) - if [ $count -gt 50 ] - then - printf "$GREEN[ PASSED ]$NC $0\n" - else - printf "$RED[ FAILED ]$NC $0\n" - rm file.tmp - exit 1 - fi -fi - -rm file.tmp - -exit 0 From 02b198fe2aad476707bfe4895b4e965cd3910cea Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Mon, 14 Aug 2023 17:04:48 -0600 Subject: [PATCH 101/154] docs: Update Readme Remove notification of default branch change & CI status badges from the readme. --- README.md | 19 ------------------- 1 file changed, 19 deletions(-) diff --git a/README.md b/README.md index 59b565add4..094812ee78 100644 --- a/README.md +++ b/README.md @@ -15,25 +15,6 @@ Both these tools are also no longer part of the [Vulkan SDK](https://www.lunarg. Vulkan-Layer-Factory is deprecated and has been archived in its own repository which is available [here](https://github.com/LunarG/Vulkan-Layer-Factory). -## Default branch changed to 'main' 2023-01-17 - -The default branch of this repository is now 'main'. This change should be largely transparent to repository users, since github rewrites many references to the old 'master' branch to 'main'. However, if you have a checked-out local clone, you may wish to take the following steps as recommended by github: - -```sh -git branch -m master main -git fetch origin -git branch -u origin/main main -git remote set-head origin -a -``` - -## CI Build Status -| Build Status | -| :----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [![Build Status](https://github.com/LunarG/VulkanTools/actions/workflows/build_windows.yml/badge.svg?branch=main)](https://github.com/LunarG/VulkanTools/actions) | -| [![Build Status](https://github.com/LunarG/VulkanTools/actions/workflows/build_linux.yml/badge.svg?branch=main)](https://github.com/LunarG/VulkanTools/actions) | -| [![Build Status](https://github.com/LunarG/VulkanTools/actions/workflows/build_linux_gn.yml/badge.svg?branch=main)](https://github.com/LunarG/VulkanTools/actions) | -| [![Build Status](https://github.com/LunarG/VulkanTools/actions/workflows/build_android.yml/badge.svg?branch=main)](https://github.com/LunarG/VulkanTools/actions) | - ## Contributing If you intend to contribute, the preferred work flow is for you to develop your contribution From 2e82048dc8e6a0e3b2d1240088d416d21ae27016 Mon Sep 17 00:00:00 2001 From: Juan Ramos Date: Thu, 17 Aug 2023 11:15:48 -0600 Subject: [PATCH 102/154] Remove unused CMake build --- build-android/cmake/README.md | 30 ----- build-android/cmake/layerlib/CMakeLists.txt | 106 ------------------ build-android/cmake/layerlib/build.gradle | 32 ------ .../cmake/layerlib/proguard-rules.pro | 17 --- .../layerlib/src/main/AndroidManifest.xml | 9 -- .../layerlib/src/main/res/values/strings.xml | 3 - 6 files changed, 197 deletions(-) delete mode 100644 build-android/cmake/README.md delete mode 100644 build-android/cmake/layerlib/CMakeLists.txt delete mode 100644 build-android/cmake/layerlib/build.gradle delete mode 100644 build-android/cmake/layerlib/proguard-rules.pro delete mode 100644 build-android/cmake/layerlib/src/main/AndroidManifest.xml delete mode 100644 build-android/cmake/layerlib/src/main/res/values/strings.xml diff --git a/build-android/cmake/README.md b/build-android/cmake/README.md deleted file mode 100644 index d38f5d38b9..0000000000 --- a/build-android/cmake/README.md +++ /dev/null @@ -1,30 +0,0 @@ -Build Validation Layers with Android CMake Plugin -================================================= -Gradle project in this directory builds layers into AAR. -The project could be directly added into application's gradle projects. -[Android Studio 3.0.0+](https://developer.android.com/studio/index.html) -IS required: earlier versions only publish release libs by default. - -Pre-requirements ----------------- -- Building from Github Repo source -1. cd android-build -2. ./update_external_sources_android.sh -3. ./android-generate.sh - -Adding layer module into Android Studio application project --------------------------------------------------------- -1. app's settings.gradle, add -``` - include ':layerLib' - project(':layerLib').projectDir = new File('/path/to/cmake/layerlib') -``` -2. app's build.gradle: -``` -dependencies { - // Android Studio 3.0.0+ is required - implementation project(':layerLib') -} -``` -BUILD_IN_NDK variable in layerlib/CMakeLists.txt could detect whether the source is -from NDK or github repo clone, and would configure the file paths accordingly diff --git a/build-android/cmake/layerlib/CMakeLists.txt b/build-android/cmake/layerlib/CMakeLists.txt deleted file mode 100644 index 764acf761c..0000000000 --- a/build-android/cmake/layerlib/CMakeLists.txt +++ /dev/null @@ -1,106 +0,0 @@ -cmake_minimum_required(VERSION 3.4.1) - -# Validation layers could be built with code from -# github repo OR -# ndk's snapshot -set(BUILD_IN_NDK OFF) -if (CMAKE_CURRENT_SOURCE_DIR MATCHES "sources/third_party/vulkan/src") - set(BUILD_IN_NDK ON) -endif() - -set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++17 -Wall -Werror \ - -Wno-unused-function -Wno-unused-const-variable \ - -Wno-c++98-compat-pedantic -DVK_PROTOTYPES \ - -DVK_USE_PLATFORM_ANDROID_KHR") - -if (BUILD_IN_NDK) - # NDK directory structure: - # $ANDROID_NDK/sources/third_party/ - # vulkan/src - get_filename_component(SRC_DIR - "${ANDROID_NDK}/sources/third_party/vulkan/src" ABSOLUTE) -else () - # github directory structure: - # ${SRC_DIR} - # ${SRC_DIR}/build-android/external - get_filename_component(SRC_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../../.." ABSOLUTE) -endif() -set(COMMON_DIR "${SRC_DIR}/build-android/generated") - -set(CMAKE_CXX_clone "${CMAKE_CXX_FLAGS}") -set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DVK_USE_PLATFORM_ANDROID_KHR \ - -fvisibility=hidden") -include_directories(${SRC_DIR}/include - ${COMMON_DIR}/include - ${SRC_DIR}/layers - ${SRC_DIR}/layers/vulkan - ${SRC_DIR}/loader) -add_library(layer_utils STATIC - ${SRC_DIR}/layers/vk_layer_config.cpp - ${SRC_DIR}/layers/vk_layer_extension_utils.cpp - ${SRC_DIR}/layers/vk_layer_utils.cpp - ${SRC_DIR}/layers/vulkan/generated/vk_format_utils.cpp) -set(CMAKE_CXX_FLAGS "${CMAKE_CXX_clone}") - -# build core_validation layers -set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DVK_USE_PLATFORM_ANDROID_KHR \ - -fvisibility=hidden") -add_library(VkLayer_core_validation SHARED - ${SRC_DIR}/layers/core_validation.cpp - ${SRC_DIR}/layers/convert_to_renderpass2.cpp - ${SRC_DIR}/layers/descriptor_sets.cpp - ${SRC_DIR}/layers/buffer_validation.cpp - ${SRC_DIR}/layers/shader_validation.cpp - ${SRC_DIR}/layers/xxhash.cpp) -target_include_directories(VkLayer_core_validation PRIVATE - ${SRC_DIR}/include - ${SRC_DIR}/layers - ${COMMON_DIR}/include - ${SRC_DIR}/loader) -target_link_libraries(VkLayer_core_validation PRIVATE - log layer_utils) -target_compile_definitions(VkLayer_core_validation PUBLIC XXH_NO_LONG_LONG) -add_library(VkLayer_parameter_validation SHARED - ${COMMON_DIR}/include/parameter_validation.cpp - ${SRC_DIR}/layers/parameter_validation_utils.cpp) -target_include_directories(VkLayer_parameter_validation PRIVATE - ${SRC_DIR}/include - ${COMMON_DIR}/include - ${SRC_DIR}/layers - ${SRC_DIR}/loader) -target_link_libraries(VkLayer_parameter_validation PRIVATE log layer_utils) - -add_library(VkLayer_object_tracker SHARED - ${COMMON_DIR}/include/object_tracker.cpp - ${COMMON_DIR}/include/layer_chassis_dispatch.cpp - ${COMMON_DIR}/include/chassis.cpp - ${SRC_DIR}/layers/object_tracker_utils.cpp) -target_compile_definitions(VkLayer_object_tracker PUBLIC "BUILD_OBJECT_TRACKER") -target_include_directories(VkLayer_object_tracker PRIVATE - ${SRC_DIR}/include - ${SRC_DIR}/layers - ${COMMON_DIR}/include - ${SRC_DIR}/loader) -target_link_libraries(VkLayer_object_tracker PRIVATE log layer_utils) - -add_library(VkLayer_threading SHARED - ${SRC_DIR}/layers/threading.cpp) -target_include_directories(VkLayer_threading PRIVATE - ${SRC_DIR}/include - ${SRC_DIR}/layers - ${COMMON_DIR}/include - ${SRC_DIR}/loader) -target_link_libraries(VkLayer_threading PRIVATE log layer_utils) - -add_library(VkLayer_unique_objects SHARED - ${COMMON_DIR}/include/layer_chassis_dispatch.cpp) - ${COMMON_DIR}/include/chassis.cpp) -target_compile_definitions(VkLayer_object_tracker PUBLIC "LAYER_CHASSIS_CAN_WRAP_HANDLES") -target_include_directories(VkLayer_unique_objects PRIVATE - ${SRC_DIR}/include - ${SRC_DIR}/layers - ${COMMON_DIR}/include - ${SRC_DIR}/loader) -target_link_libraries(VkLayer_unique_objects PRIVATE log layer_utils) - -set(CMAKE_CXX_FLAGS "${CMAKE_CXX_clone}") diff --git a/build-android/cmake/layerlib/build.gradle b/build-android/cmake/layerlib/build.gradle deleted file mode 100644 index 889d23262b..0000000000 --- a/build-android/cmake/layerlib/build.gradle +++ /dev/null @@ -1,32 +0,0 @@ -apply plugin: 'com.android.library' - -android { - /* - * Required: Android Studio 3.0.0+! - */ - compileSdkVersion 25 - - defaultConfig { - minSdkVersion 24 - targetSdkVersion 24 - versionCode 1 - versionName "1.0" - ndk.abiFilters 'armeabi-v7a', 'arm64-v8a', 'x86', 'x86_64' - externalNativeBuild { - cmake.arguments '-DANDROID_TOOLCHAIN=clang', - '-DANDROID_STL=c++_static', - '-DANDROID_PLATFORM=android-24' - } - } - externalNativeBuild { - cmake.path 'CMakeLists.txt' - } - buildTypes { - release { - minifyEnabled false - proguardFiles getDefaultProguardFile('proguard-android.txt'), - 'proguard-rules.pro' - } - } -} - diff --git a/build-android/cmake/layerlib/proguard-rules.pro b/build-android/cmake/layerlib/proguard-rules.pro deleted file mode 100644 index b41fe70c70..0000000000 --- a/build-android/cmake/layerlib/proguard-rules.pro +++ /dev/null @@ -1,17 +0,0 @@ -# Add project specific ProGuard rules here. -# By default, the flags in this file are appended to flags specified -# in ${ANDROID_SDK}/tools/proguard/proguard-android.txt -# You can edit the include path and order by changing the proguardFiles -# directive in build.gradle. -# -# For more details, see -# http://developer.android.com/guide/developing/tools/proguard.html - -# Add any project specific keep options here: - -# If your project uses WebView with JS, uncomment the following -# and specify the fully qualified class name to the JavaScript interface -# class: -#-keepclassmembers class fqcn.of.javascript.interface.for.webview { -# public *; -#} diff --git a/build-android/cmake/layerlib/src/main/AndroidManifest.xml b/build-android/cmake/layerlib/src/main/AndroidManifest.xml deleted file mode 100644 index 78c3704af2..0000000000 --- a/build-android/cmake/layerlib/src/main/AndroidManifest.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - - diff --git a/build-android/cmake/layerlib/src/main/res/values/strings.xml b/build-android/cmake/layerlib/src/main/res/values/strings.xml deleted file mode 100644 index 66f83899b6..0000000000 --- a/build-android/cmake/layerlib/src/main/res/values/strings.xml +++ /dev/null @@ -1,3 +0,0 @@ - - Layer Library - From 31d0dcd9a2cd610abe6e8a3f525599697949ae88 Mon Sep 17 00:00:00 2001 From: Juan Ramos Date: Fri, 18 Aug 2023 13:27:21 -0600 Subject: [PATCH 103/154] Ignore CMakeUserPresets.json --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index fd156764e6..35bc161ba0 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +CMakeUserPresets.json CMakeCache.txt CMakeLists.txt.user CMakeFiles/ From c5b775251af9d72afd78106b3b20664c9df03867 Mon Sep 17 00:00:00 2001 From: Juan Ramos Date: Fri, 18 Aug 2023 13:27:44 -0600 Subject: [PATCH 104/154] Minor CMake cleanup Remove USE_CCACHE Remove CMAKE_OSX_DEPLOYMENT_TARGET Remove FALLBACK_CONFIG_DIRS / FALLBACK_DATA_DIRS Properly set enable_testing() --- CMakeLists.txt | 21 ++------------------- scripts/github_ci_linux.py | 2 +- scripts/github_ci_win.py | 2 +- 3 files changed, 4 insertions(+), 21 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index ab8ac501fc..a2b98de75f 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,10 +1,6 @@ cmake_minimum_required(VERSION 3.17.2) -enable_testing() - -set(CMAKE_OSX_DEPLOYMENT_TARGET "10.12" CACHE STRING "Minimum OS X deployment version") - -project (VULKAN_TOOLS) +project(VULKAN_TOOLS) set(API_NAME "Vulkan" CACHE STRING "API name") add_definitions(-DAPI_NAME="${API_NAME}") @@ -93,22 +89,8 @@ endif() set_property(GLOBAL PROPERTY USE_FOLDERS ON) set(VULKANTOOLS_TARGET_FOLDER vt_cmake_targets) -option(USE_CCACHE "Use ccache" OFF) -if (USE_CCACHE) - find_program(CCACHE_FOUND ccache) - if(CCACHE_FOUND) - set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE ccache) - set_property(GLOBAL PROPERTY RULE_LAUNCH_LINK ccache) - endif(CCACHE_FOUND) -endif() - option(BUILD_WERROR "Treat compiler warnings as errors" ON) if(CMAKE_SYSTEM_NAME STREQUAL "Linux" OR CMAKE_SYSTEM_NAME MATCHES "BSD") - set(FALLBACK_CONFIG_DIRS "/etc/xdg" CACHE STRING - "Search path to use when XDG_CONFIG_DIRS is unset or empty or the current process is SUID/SGID. Default is freedesktop compliant.") - set(FALLBACK_DATA_DIRS "/usr/local/share:/usr/share" CACHE STRING - "Search path to use when XDG_DATA_DIRS is unset or empty or the current process is SUID/SGID. Default is freedesktop compliant.") - if(BUILD_WERROR) if (CMAKE_COMPILER_IS_GNUCC OR CMAKE_C_COMPILER_ID MATCHES "Clang") add_compile_options(-Werror) @@ -202,6 +184,7 @@ function(run_vulkantools_video_xml_generate dependency output) endfunction() if(BUILD_TESTS) + enable_testing() add_subdirectory(tests) endif() diff --git a/scripts/github_ci_linux.py b/scripts/github_ci_linux.py index 6ea0718bf6..db83471c5d 100644 --- a/scripts/github_ci_linux.py +++ b/scripts/github_ci_linux.py @@ -77,7 +77,7 @@ def BuildVT(args): CreateBuildDirectory(VT_BUILD_DIR) print("Run CMake") - cmake_cmd = 'cmake -C ../%s/helper.cmake -DCMAKE_BUILD_TYPE=%s -DUSE_CCACHE=ON ..' % (EXTERNAL_DIR_NAME, args.configuration.capitalize()) + cmake_cmd = 'cmake -C ../%s/helper.cmake -DCMAKE_BUILD_TYPE=%s ..' % (EXTERNAL_DIR_NAME, args.configuration.capitalize()) RunShellCmd(cmake_cmd, VT_BUILD_DIR) print("Build Vulkan Tools") diff --git a/scripts/github_ci_win.py b/scripts/github_ci_win.py index 75896ddf92..7656bebd5c 100644 --- a/scripts/github_ci_win.py +++ b/scripts/github_ci_win.py @@ -76,7 +76,7 @@ def BuildVT(args): CreateBuildDirectory(VT_BUILD_DIR) print("Run CMake") - cmake_cmd = 'cmake -A %s -C ../%s/helper.cmake -DUSE_CCACHE=ON ..' % (args.arch, EXTERNAL_DIR_NAME) + cmake_cmd = 'cmake -A %s -C ../%s/helper.cmake ..' % (args.arch, EXTERNAL_DIR_NAME) RunShellCmd(cmake_cmd, VT_BUILD_DIR) print("Build Vulkan Tools") From c2cb7450232ae90d2e545ddfa9aa1da6c9cd446c Mon Sep 17 00:00:00 2001 From: Juan Ramos Date: Fri, 18 Aug 2023 14:12:38 -0600 Subject: [PATCH 105/154] ci: Cleanup GitHub Actions CI Fixup performance issues Fixup CI warnings --- .github/workflows/{ci_build.yml => ci.yml} | 64 ++++------------------ .github/workflows/format.yml | 32 +++++++++++ CMakeUserPresets.json | 24 ++++++++ scripts/github_ci_android.py | 17 +++--- 4 files changed, 75 insertions(+), 62 deletions(-) rename .github/workflows/{ci_build.yml => ci.yml} (60%) create mode 100644 .github/workflows/format.yml create mode 100644 CMakeUserPresets.json diff --git a/.github/workflows/ci_build.yml b/.github/workflows/ci.yml similarity index 60% rename from .github/workflows/ci_build.yml rename to .github/workflows/ci.yml index e166c29a74..7b1c4795e5 100644 --- a/.github/workflows/ci_build.yml +++ b/.github/workflows/ci.yml @@ -1,7 +1,6 @@ -#!/usr/bin/env python3 -# Copyright (c) 2021 Valve Corporation -# Copyright (c) 2021 LunarG, Inc. - +# Copyright (c) 2023 Valve Corporation +# Copyright (c) 2023 LunarG, Inc. +# # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at @@ -13,11 +12,8 @@ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. -# -# Author: Mark Lobodzinski -# Author: Tony Barbour -name: CI Build +name: ci on: push: @@ -26,27 +22,6 @@ on: - main jobs: - code-format: - name: ${{ matrix.config.name }} - runs-on: ${{ matrix.config.os }} - strategy: - fail-fast: false - matrix: - config: - - { - name: "Source Code Format Testing", - os: ubuntu-latest, - cc: "gcc", cxx: "g++" - } - steps: - - name: Install Qt - uses: jurplel/install-qt-action@v3 - - name: Clone repository - uses: actions/checkout@v1 - - name: Execute Source Code Format Checking Script - run: | - scripts/check_code_format.sh --target-refspec=origin/${{ github.base_ref }} - linux: name: ${{ matrix.config.name }} runs-on: ${{ matrix.config.os }} @@ -72,7 +47,7 @@ jobs: - name: Install Qt uses: jurplel/install-qt-action@v3 - name: Clone repository - uses: actions/checkout@v1 + uses: actions/checkout@v3 - name: Install build dependencies run: | sudo apt-get -qq update @@ -95,34 +70,19 @@ jobs: steps: - name: Install Qt uses: jurplel/install-qt-action@v3 - - uses: actions/checkout@v2 - - uses: actions/setup-python@v2 + - uses: actions/checkout@v3 + - uses: actions/setup-python@v4 with: python-version: '3.7' - name: Build and Test VulkanTools run: python3 scripts/github_ci_win.py --config ${{ matrix.config }} --arch ${{ matrix.arch }} android: - name: ${{ matrix.config.name }} - runs-on: ${{ matrix.config.os }} + runs-on: ubuntu-22.04 strategy: - fail-fast: false matrix: - config: - - { - name: "Android armeabi-v8a", - os: ubuntu-latest, - abi: arm64-v8a, - ndk: r21d, - } - - { - name: "Android armeabi-v7a", - os: ubuntu-latest, - abi: armeabi-v7a, - ndk: r21d, - } + abi: [ arm64-v8a , armeabi-v7a ] steps: - - name: Clone repository - uses: actions/checkout@v1 - - name: Build VulkanTools - run: python3 scripts/github_ci_android.py --abi ${{ matrix.config.abi }} + - uses: actions/checkout@v3 + - name: ndk-build + run: python scripts/github_ci_android.py --abi ${{ matrix.abi }} diff --git a/.github/workflows/format.yml b/.github/workflows/format.yml new file mode 100644 index 0000000000..ce83152d37 --- /dev/null +++ b/.github/workflows/format.yml @@ -0,0 +1,32 @@ +# Copyright (c) 2023 Valve Corporation +# Copyright (c) 2023 LunarG, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +name: format + +on: + push: + pull_request: + branches: + - main + +jobs: + code-format: + name: Source Code Format Testing + runs-on: ubuntu-22.04 + steps: + - uses: actions/checkout@v3 + - name: Execute Source Code Format Checking Script + run: | + scripts/check_code_format.sh --target-refspec=origin/${{ github.base_ref }} diff --git a/CMakeUserPresets.json b/CMakeUserPresets.json new file mode 100644 index 0000000000..0fd1ce54ba --- /dev/null +++ b/CMakeUserPresets.json @@ -0,0 +1,24 @@ +{ + "version": 3, + "cmakeMinimumRequired": { + "major": 3, + "minor": 26, + "patch": 0 + }, + "configurePresets": [ + { + "name": "android", + "displayName": "Generic Developer Preset (Android)", + "description": "Sets common developer flags", + "binaryDir": "${sourceDir}/build/android/", + "toolchainFile": "~/Android/Sdk/ndk/25.2.9519653/build/cmake/android.toolchain.cmake", + "cacheVariables": { + "ANDROID_PLATFORM": "26", + "CMAKE_ANDROID_ARCH_ABI": "arm64-v8a", + "CMAKE_ANDROID_STL_TYPE": "c++_static", + "ANDROID_USE_LEGACY_TOOLCHAIN_FILE": "OFF", + "BUILD_TESTS": "ON" + } + } + ] +} \ No newline at end of file diff --git a/scripts/github_ci_android.py b/scripts/github_ci_android.py index b594122f19..5127af4cb4 100644 --- a/scripts/github_ci_android.py +++ b/scripts/github_ci_android.py @@ -1,6 +1,6 @@ #!/usr/bin/env python3 -# Copyright (c) 2021Valve Corporation -# Copyright (c) 2021 LunarG, Inc. +# Copyright (c) 2021-2023 Valve Corporation +# Copyright (c) 2021-2023 LunarG, Inc. # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -49,15 +49,12 @@ def RunShellCmd(command, start_dir = PROJECT_ROOT): # # Fetch Android components, build Android VVL def BuildAndroid(target_abi): - print("Fetching NDK\n") - wget_cmd = 'wget http://dl.google.com/android/repository/android-ndk-r21d-linux-x86_64.zip' - RunShellCmd(wget_cmd) + # GitHub actions already comes with NDK pre-installed. We should avoid downloading unless we have to. + # https://github.com/actions/runner-images/blob/main/images/linux/Ubuntu2204-Readme.md#environment-variables-2 + if "ANDROID_NDK_HOME" not in os.environ: + print('ANDROID_NDK_HOME not defined!') + sys.exit(1) - print("Extracting NDK components\n") - unzip_cmd = 'unzip -u -q android-ndk-r21d-linux-x86_64.zip' - RunShellCmd(unzip_cmd) - # Add NDK to path - os.environ['ANDROID_NDK_HOME'] = repo_relative('android-ndk-r21d') os.environ['PATH'] = os.environ.get('ANDROID_NDK_HOME') + os.pathsep + os.environ.get('PATH') print("Preparing Android Dependencies\n") From f171a53297a8c8b7e48690bd8dc0b24506ac57ae Mon Sep 17 00:00:00 2001 From: Juan Ramos <114601453+juan-lunarg@users.noreply.github.com> Date: Fri, 18 Aug 2023 15:32:27 -0600 Subject: [PATCH 106/154] Delete CMakeUserPresets.json --- CMakeUserPresets.json | 24 ------------------------ 1 file changed, 24 deletions(-) delete mode 100644 CMakeUserPresets.json diff --git a/CMakeUserPresets.json b/CMakeUserPresets.json deleted file mode 100644 index 0fd1ce54ba..0000000000 --- a/CMakeUserPresets.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "version": 3, - "cmakeMinimumRequired": { - "major": 3, - "minor": 26, - "patch": 0 - }, - "configurePresets": [ - { - "name": "android", - "displayName": "Generic Developer Preset (Android)", - "description": "Sets common developer flags", - "binaryDir": "${sourceDir}/build/android/", - "toolchainFile": "~/Android/Sdk/ndk/25.2.9519653/build/cmake/android.toolchain.cmake", - "cacheVariables": { - "ANDROID_PLATFORM": "26", - "CMAKE_ANDROID_ARCH_ABI": "arm64-v8a", - "CMAKE_ANDROID_STL_TYPE": "c++_static", - "ANDROID_USE_LEGACY_TOOLCHAIN_FILE": "OFF", - "BUILD_TESTS": "ON" - } - } - ] -} \ No newline at end of file From 1cd422ce3854f33873e8dc273e6596d3757e1c66 Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Wed, 14 Jun 2023 17:06:15 -0600 Subject: [PATCH 107/154] apidump: Use correct aliased types VkAccelerationStructureTypeNV and VkBuildAccelerationStructureFlagsNV are aliased types which are explicitly used by the VK_NV_ray_tracing extension. Because apidump didn't know how to keep track of aliases and then fixup uses of aliased types into the real type, those two types had hand written typedefs. This commit is able to remove the hardcoding as well are removes both redundant code (self.trackedTypes) and dead code (str_VkStructureTypeToEnum). --- scripts/api_dump_generator.py | 79 ++++------------------------------- 1 file changed, 8 insertions(+), 71 deletions(-) diff --git a/scripts/api_dump_generator.py b/scripts/api_dump_generator.py index a534a534ea..3e1f51a263 100644 --- a/scripts/api_dump_generator.py +++ b/scripts/api_dump_generator.py @@ -431,23 +431,6 @@ void dump_text_{unName}(const {unName}& object, const ApiDumpSettings& settings, int indents); @end union -//============================= typedefs ==============================// - -@if(not {isVideoGeneration}) -// Functions for dumping typedef types that the codegen scripting can't handle -#if defined(VK_ENABLE_BETA_EXTENSIONS) -void dump_text_VkAccelerationStructureTypeKHR(VkAccelerationStructureTypeKHR object, const ApiDumpSettings& settings, int indents); -void dump_text_VkAccelerationStructureTypeNV(VkAccelerationStructureTypeNV object, const ApiDumpSettings& settings, int indents) -{{ - dump_text_VkAccelerationStructureTypeKHR(object, settings, indents); -}} -void dump_text_VkBuildAccelerationStructureFlagsKHR(VkBuildAccelerationStructureFlagsKHR object, const ApiDumpSettings& settings, int indents); -void dump_text_VkBuildAccelerationStructureFlagsNV(VkBuildAccelerationStructureFlagsNV object, const ApiDumpSettings& settings, int indents) -{{ - dump_text_VkBuildAccelerationStructureFlagsKHR(object, settings, indents); -}} -#endif // VK_ENABLE_BETA_EXTENSIONS -@end if //=========================== Type Implementations ==========================// @foreach type where('{etyName}' != 'void') @@ -841,24 +824,6 @@ void dump_html_{unName}(const {unName}& object, const ApiDumpSettings& settings, int indents); @end union -//============================= typedefs ==============================// - -@if(not {isVideoGeneration}) -// Functions for dumping typedef types that the codegen scripting can't handle -#if defined(VK_ENABLE_BETA_EXTENSIONS) -void dump_html_VkAccelerationStructureTypeKHR(VkAccelerationStructureTypeKHR object, const ApiDumpSettings& settings, int indents); -void dump_html_VkAccelerationStructureTypeNV(VkAccelerationStructureTypeNV object, const ApiDumpSettings& settings, int indents) -{{ - dump_html_VkAccelerationStructureTypeKHR(object, settings, indents); -}} -void dump_html_VkBuildAccelerationStructureFlagsKHR(VkBuildAccelerationStructureFlagsKHR object, const ApiDumpSettings& settings, int indents); -void dump_html_VkBuildAccelerationStructureFlagsNV(VkBuildAccelerationStructureFlagsNV object, const ApiDumpSettings& settings, int indents) -{{ - dump_html_VkBuildAccelerationStructureFlagsKHR(object, settings, indents); -}} -#endif // VK_ENABLE_BETA_EXTENSIONS -@end if - //=========================== Type Implementations ==========================// @foreach type where('{etyName}' != 'void') @@ -1228,24 +1193,6 @@ void dump_json_{unName}(const {unName}& object, const ApiDumpSettings& settings, int indents); @end union -//============================= typedefs ==============================// - -@if(not {isVideoGeneration}) -// Functions for dumping typedef types that the codegen scripting can't handle -#if defined(VK_ENABLE_BETA_EXTENSIONS) -void dump_json_VkAccelerationStructureTypeKHR(VkAccelerationStructureTypeKHR object, const ApiDumpSettings& settings, int indents); -void dump_json_VkAccelerationStructureTypeNV(VkAccelerationStructureTypeNV object, const ApiDumpSettings& settings, int indents) -{{ - dump_json_VkAccelerationStructureTypeKHR(object, settings, indents); -}} -void dump_json_VkBuildAccelerationStructureFlagsKHR(VkBuildAccelerationStructureFlagsKHR object, const ApiDumpSettings& settings, int indents); -void dump_json_VkBuildAccelerationStructureFlagsNV(VkBuildAccelerationStructureFlagsNV object, const ApiDumpSettings& settings, int indents) -{{ - dump_json_VkBuildAccelerationStructureFlagsKHR(object, settings, indents); -}} -#endif // VK_ENABLE_BETA_EXTENSIONS -@end if - //=========================== Type Implementations ==========================// @foreach type where('{etyName}' != 'void') @@ -1779,9 +1726,6 @@ def __init__(self, self.registryFile = registryFile - # Used to track duplications (thanks 1.1 spec) - self.trackedTypes = [] - def beginFile(self, genOpts): gen.OutputGenerator.beginFile(self, genOpts) self.format = genOpts.input @@ -1858,6 +1802,12 @@ def endFile(self): if variable.typeID in self.unions: variable.is_union = True + # Replace any types that are aliases with the non-aliased type + for struct in self.structs.values(): + for member in struct.members: + if member.typeID in self.aliases: + member.typeID = self.aliases[member.typeID] + # Find every @foreach, @if, and @end forIter = re.finditer('(^\\s*\\@foreach\\s+[a-z]+(\\s+where\\(.*\\))?\\s*^)|(\\@foreach [a-z]+(\\s+where\\(.*\\))?\\b)', self.format, flags=re.MULTILINE) @@ -1955,12 +1905,8 @@ def genGroup(self, groupinfo, groupName, alias): gen.OutputGenerator.genGroup(self, groupinfo, groupName, alias) if alias is not None: - trackedName = alias - else: - trackedName = groupName - if trackedName in self.trackedTypes: + self.aliases[groupName] = alias return - self.trackedTypes.append(trackedName) if groupinfo.elem.get('type') == 'bitmask': self.bitmasks[groupinfo.elem.get('name')] = VulkanBitmask(groupinfo.elem, self.extensions) @@ -1971,14 +1917,8 @@ def genType(self, typeinfo, name, alias): gen.OutputGenerator.genType(self, typeinfo, name, alias) if alias is not None: - trackedName = alias - if typeinfo.elem.get('category') == 'struct': - self.aliases[name] = alias - else: - trackedName = name - if trackedName in self.trackedTypes: + self.aliases[name] = alias return - self.trackedTypes.append(trackedName) if typeinfo.elem.get('category') == 'struct': self.structs[typeinfo.elem.get('name')] = VulkanStruct(typeinfo.elem, self.constants, self.enums) @@ -2504,9 +2444,6 @@ def values(self): 'hdlParent': self.parent, } -def str_VkStructureTypeToEnum(structureType): - return structureType.title().replace('_', '').replace('VkStructureType','Vk') - class VulkanStruct: class Member(VulkanVariable): From f68090c259b86b06568bc193e1defd382d3958ef Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Tue, 15 Aug 2023 11:31:56 -0600 Subject: [PATCH 108/154] api_dump: Prevent crash in VkDescriptorDataEXT union The VK_EXT_descriptor_buffer extension adds a union with pointer elements. Because API Dumps union logic is naive, it prints the value of every element in the union regardless of whichever the 'active' element is, as it is not always possible to easily get the active element. VkDescriptorDataEXT contains pointers which are dereferenced resulting in a crash. Fixing it is straightforward because the parent structure VkDescriptorGetInfoEXT contains the type to use, so it is just a matter using the PARAMETER_STATE and VALIDITY_CHECKS functionality to set & get the type when printing out the contents of the union. --- layersvt/api_dump.h | 7 +++++- scripts/api_dump_generator.py | 40 +++++++++++++++++++++++++++++++++-- 2 files changed, 44 insertions(+), 3 deletions(-) diff --git a/layersvt/api_dump.h b/layersvt/api_dump.h index db6d1fc22e..e2a223eb27 100644 --- a/layersvt/api_dump.h +++ b/layersvt/api_dump.h @@ -906,6 +906,8 @@ class ApiDumpInstance { bool getIsDynamicViewport() const { return is_dynamic_viewport; } void setMemoryHeapCount(uint32_t memory_heap_count) { this->memory_heap_count = memory_heap_count; } uint32_t getMemoryHeapCount() { return memory_heap_count; } + void setDescriptorType(VkDescriptorType type) { this->descriptor_type = type; } + VkDescriptorType getDescriptorType() { return this->descriptor_type; } std::chrono::microseconds current_time_since_start() { std::chrono::system_clock::time_point now = std::chrono::system_clock::now(); @@ -950,7 +952,7 @@ class ApiDumpInstance { std::unordered_map thread_map; std::recursive_mutex cmd_buffer_state_mutex; - std::map, std::unordered_set > cmd_buffer_pools; + std::map, std::unordered_set> cmd_buffer_pools; std::unordered_map cmd_buffer_level; bool conditional_initialized = false; @@ -974,6 +976,9 @@ class ApiDumpInstance { // Storage for VkPhysicalDeviceMemoryBudgetPropertiesEXT which needs the number of heaps from VkPhysicalDeviceMemoryProperties uint32_t memory_heap_count; + + // Storage for the VkDescriptorDataEXT union to know what is the active element + VkDescriptorType descriptor_type; }; // Utility to output an address. diff --git a/scripts/api_dump_generator.py b/scripts/api_dump_generator.py index 3e1f51a263..16e6e115da 100644 --- a/scripts/api_dump_generator.py +++ b/scripts/api_dump_generator.py @@ -676,6 +676,9 @@ settings.stream() << "address (Union):\\n"; @foreach choice + @if('{chcCondition}' != 'None') + if({chcCondition}) + @end if @if({chcPtrLevel} == 0) dump_text_value(object.{chcName}, settings, "{chcType}", "{chcName}", indents + 1, dump_text_{chcTypeID}); // LET @end if @@ -1068,6 +1071,9 @@ settings.stream() << "
    "; @foreach choice + @if('{chcCondition}' != 'None') + if({chcCondition}) + @end if @if({chcPtrLevel} == 0) dump_html_value(object.{chcName}, settings, "{chcType}", "{chcName}", indents + 1, dump_html_{chcTypeID}); @end if @@ -1415,8 +1421,11 @@ settings.stream() << settings.indentation(indents) << "[\\n"; @foreach choice - @if({chcIndex} != 0) - settings.stream() << ",\\n"; + @if('{chcCondition}' != 'None') + if({chcCondition}) + @end if + @if({chcIndex} != 0 and '{chcCondition}' == 'None') + settings.stream() << ",\\n"; // Only need commas when more than one field is printed @end if @if({chcPtrLevel} == 0) dump_json_value(object.{chcName}, NULL, settings, "{chcType}", "{chcName}", {chcIsStruct}, {chcIsUnion}, indents + 2, dump_json_{chcTypeID}); @@ -1585,6 +1594,15 @@ }, ], }, + 'VkDescriptorDataEXT': { + 'VkDescriptorGetInfoEXT':[ + { + 'name': 'type', + 'type': 'VkDescriptorType', + 'stmt': 'ApiDumpInstance::current().setDescriptorType(object.type);', + } + ] + } } VALIDITY_CHECKS = { @@ -1626,6 +1644,18 @@ '(object.descriptorType == VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER) || ' + '(object.descriptorType == VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER)', }, + 'VkDescriptorDataEXT':{ + 'pSampler': 'ApiDumpInstance::current().getDescriptorType() == VK_DESCRIPTOR_TYPE_SAMPLER', + 'pCombinedImageSampler': 'ApiDumpInstance::current().getDescriptorType() == VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER', + 'pInputAttachmentImage': 'ApiDumpInstance::current().getDescriptorType() == VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT', + 'pSampledImage': 'ApiDumpInstance::current().getDescriptorType() == VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE', + 'pStorageImage': 'ApiDumpInstance::current().getDescriptorType() == VK_DESCRIPTOR_TYPE_STORAGE_IMAGE', + 'pUniformTexelBuffer': 'ApiDumpInstance::current().getDescriptorType() == VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER', + 'pStorageTexelBuffer': 'ApiDumpInstance::current().getDescriptorType() == VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER', + 'pUniformBuffer': 'ApiDumpInstance::current().getDescriptorType() == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER', + 'pStorageBuffer': 'ApiDumpInstance::current().getDescriptorType() == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER', + 'accelerationStructure': 'ApiDumpInstance::current().getDescriptorType() == VK_DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR', + } } # These types are defined in both video.xml and vk.xml. Because duplicate functions aren't allowed, @@ -2553,6 +2583,11 @@ def __init__(self, rootNode, constants, parentName, index): VulkanVariable.__init__(self, rootNode, constants, None, parentName) self.index = index + # Search for a member condition + self.condition = None + if parentName in VALIDITY_CHECKS and self.name in VALIDITY_CHECKS[parentName]: + self.condition = VALIDITY_CHECKS[parentName][self.name] + def values(self): return { 'chcName': self.name, @@ -2562,6 +2597,7 @@ def values(self): 'chcChildType': self.childType, 'chcPtrLevel': self.pointerLevels, 'chcLength': self.arrayLength, + 'chcCondition': self.condition, #'chcLengthIsMember': self.lengthMember, 'chcIndex': self.index, 'chcIsStruct': 'true' if self.is_struct else 'false', From 50761b5e40af56e12aabf08a7721146abafd8944 Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Fri, 18 Aug 2023 16:19:19 -0600 Subject: [PATCH 109/154] apidump: Query device functions during GetInstanceProcAddr vkGetInstanceProcAddr is able to query device functions, which was not being done by api_dump. This caused debug utils functions to not be intercepted due to changes in how the loader queries those functions. --- scripts/api_dump_generator.py | 32 ++++++++++++++++++++++++++------ 1 file changed, 26 insertions(+), 6 deletions(-) diff --git a/scripts/api_dump_generator.py b/scripts/api_dump_generator.py index 16e6e115da..6731757a54 100644 --- a/scripts/api_dump_generator.py +++ b/scripts/api_dump_generator.py @@ -366,13 +366,35 @@ }} @end function -EXPORT_FUNCTION VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetInstanceProcAddr(VkInstance instance, const char* pName) +VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL api_dump_known_instance_functions(const char* pName) {{ @foreach function where('{funcType}' in ['global', 'instance'] and '{funcName}' not in [ 'vkEnumerateDeviceExtensionProperties' ]) if(strcmp(pName, "{funcName}") == 0) return reinterpret_cast({funcName}); @end function + return nullptr; +}} + +VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL api_dump_known_device_functions(const char* pName) +{{ + @foreach function where('{funcType}' == 'device') + if(strcmp(pName, "{funcName}") == 0) + return reinterpret_cast({funcName}); + @end function + + return nullptr; +}} + +EXPORT_FUNCTION VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetInstanceProcAddr(VkInstance instance, const char* pName) +{{ + auto instance_func = api_dump_known_instance_functions(pName); + if (instance_func) return instance_func; + + // Make sure that device functions queried through GIPA works + auto device_func = api_dump_known_device_functions(pName); + if (device_func) return device_func; + // Haven't created an instance yet, exit now since there is no instance_dispatch_table if(instance_dispatch_table(instance)->GetInstanceProcAddr == NULL) return nullptr; @@ -381,10 +403,8 @@ EXPORT_FUNCTION VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vkGetDeviceProcAddr(VkDevice device, const char* pName) {{ - @foreach function where('{funcType}' == 'device') - if(strcmp(pName, "{funcName}") == 0) - return reinterpret_cast({funcName}); - @end function + auto device_func = api_dump_known_device_functions(pName); + if (device_func) return device_func; // Haven't created a device yet, exit now since there is no device_dispatch_table if(device_dispatch_table(device)->GetDeviceProcAddr == NULL) @@ -1528,7 +1548,7 @@ @end function """ -POINTER_TYPES = ['void', 'xcb_connection_t', 'Display', 'SECURITY_ATTRIBUTES', 'ANativeWindow', 'AHardwareBuffer'] +POINTER_TYPES = ['void', 'xcb_connection_t', 'Display', 'SECURITY_ATTRIBUTES', 'ANativeWindow', 'AHardwareBuffer', 'wl_display'] TRACKED_STATE = { 'vkAllocateCommandBuffers': From bcc89bca30826befb22b39ef3fb04eb0b0510382 Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Fri, 18 Aug 2023 16:32:59 -0600 Subject: [PATCH 110/154] Enable VK_NV_cooperative_matrix The extension was disabled due to issues with the transition from an NV ext to a KHR ext. This required a fix to the autogeneration, which was previously committed. --- CMakeLists.txt | 2 +- build-android/android-generate.sh | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index a2b98de75f..2c145d81c4 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -170,7 +170,7 @@ endif() # Define macro used for building vk.xml generated files function(run_vulkantools_vk_xml_generate dependency output) add_custom_command(OUTPUT ${output} - COMMAND ${PYTHON_CMD} -B ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py -registry ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry/vk.xml -scripts ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry ${output} -removeExtensions VK_NV_cooperative_matrix -removeExtensions VK_QNX_external_memory_screen_buffer + COMMAND ${PYTHON_CMD} -B ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py -registry ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry/vk.xml -scripts ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry ${output} -removeExtensions VK_QNX_external_memory_screen_buffer DEPENDS ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry/vk.xml ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry/generator.py ${VULKANTOOLS_SCRIPTS_DIR}/${dependency} ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry/reg.py ) endfunction() diff --git a/build-android/android-generate.sh b/build-android/android-generate.sh index c1a37eec6f..a5e2c01500 100755 --- a/build-android/android-generate.sh +++ b/build-android/android-generate.sh @@ -46,10 +46,10 @@ echo "Using python: $(which $PYTHON_EXECUTABLE)" # apidump -( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump.cpp -removeExtensions VK_NV_cooperative_matrix -removeExtensions VK_QNX_external_memory_screen_buffer) -( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_text.h -removeExtensions VK_NV_cooperative_matrix -removeExtensions VK_QNX_external_memory_screen_buffer) -( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_html.h -removeExtensions VK_NV_cooperative_matrix -removeExtensions VK_QNX_external_memory_screen_buffer) -( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_json.h -removeExtensions VK_NV_cooperative_matrix -removeExtensions VK_QNX_external_memory_screen_buffer) +( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump.cpp -removeExtensions VK_QNX_external_memory_screen_buffer) +( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_text.h -removeExtensions VK_QNX_external_memory_screen_buffer) +( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_html.h -removeExtensions VK_QNX_external_memory_screen_buffer) +( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_json.h -removeExtensions VK_QNX_external_memory_screen_buffer) ( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${VIDEO_REGISTRY} -scripts ${REGISTRY_PATH} api_dump_video_text.h) ( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${VIDEO_REGISTRY} -scripts ${REGISTRY_PATH} api_dump_video_html.h) From cd363f06e550162b3ea2c3da5b203a1e8765b777 Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Fri, 18 Aug 2023 17:15:13 -0600 Subject: [PATCH 111/154] Enable VK_QNX_external_memory_screen_buffer This extension was disabled due to not working with API dump, to which this commit fixes. The souce of the error was that vulkan safety critical modified vk.xml to change the supported="vulkan" to allow supported="vulkan,vulkansc". ApiDump's generator was only looking for vulkan, causing any extension that worked with both API's to be missed, causing the extension guard to not be added where required. This commit also adds the SCI platform define to the hardcoded list. --- CMakeLists.txt | 2 +- build-android/android-generate.sh | 8 ++++---- scripts/api_dump_generator.py | 2 +- scripts/common_codegen.py | 3 ++- 4 files changed, 8 insertions(+), 7 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 2c145d81c4..fe0a283354 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -170,7 +170,7 @@ endif() # Define macro used for building vk.xml generated files function(run_vulkantools_vk_xml_generate dependency output) add_custom_command(OUTPUT ${output} - COMMAND ${PYTHON_CMD} -B ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py -registry ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry/vk.xml -scripts ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry ${output} -removeExtensions VK_QNX_external_memory_screen_buffer + COMMAND ${PYTHON_CMD} -B ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py -registry ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry/vk.xml -scripts ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry ${output} DEPENDS ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry/vk.xml ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry/generator.py ${VULKANTOOLS_SCRIPTS_DIR}/${dependency} ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry/reg.py ) endfunction() diff --git a/build-android/android-generate.sh b/build-android/android-generate.sh index a5e2c01500..f49adcb919 100755 --- a/build-android/android-generate.sh +++ b/build-android/android-generate.sh @@ -46,10 +46,10 @@ echo "Using python: $(which $PYTHON_EXECUTABLE)" # apidump -( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump.cpp -removeExtensions VK_QNX_external_memory_screen_buffer) -( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_text.h -removeExtensions VK_QNX_external_memory_screen_buffer) -( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_html.h -removeExtensions VK_QNX_external_memory_screen_buffer) -( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_json.h -removeExtensions VK_QNX_external_memory_screen_buffer) +( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump.cpp) +( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_text.h) +( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_html.h) +( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${REGISTRY} -scripts ${REGISTRY_PATH} api_dump_json.h) ( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${VIDEO_REGISTRY} -scripts ${REGISTRY_PATH} api_dump_video_text.h) ( cd generated/include; ${PYTHON_EXECUTABLE} ${VT_SCRIPTS}/vt_genvk.py -registry ${VIDEO_REGISTRY} -scripts ${REGISTRY_PATH} api_dump_video_html.h) diff --git a/scripts/api_dump_generator.py b/scripts/api_dump_generator.py index 6731757a54..d77310af84 100644 --- a/scripts/api_dump_generator.py +++ b/scripts/api_dump_generator.py @@ -1787,7 +1787,7 @@ def beginFile(self, genOpts): root = self.registry.reg for node in root.find('extensions').findall('extension'): - if node.get('supported') == 'vulkan': # dont print unsupported extensions + if 'vulkan' in node.get('supported'): # dont print unsupported extensions ext = VulkanExtension(node) self.extensions[ext.name] = ext for item in ext.vktypes: diff --git a/scripts/common_codegen.py b/scripts/common_codegen.py index e442e2ea8a..0137e54b62 100644 --- a/scripts/common_codegen.py +++ b/scripts/common_codegen.py @@ -50,10 +50,11 @@ platform_dict = { 'android' : 'VK_USE_PLATFORM_ANDROID_KHR', 'fuchsia' : 'VK_USE_PLATFORM_FUCHSIA', - 'ggp': 'VK_USE_PLATFORM_GGP', + 'ggp' : 'VK_USE_PLATFORM_GGP', 'ios' : 'VK_USE_PLATFORM_IOS_MVK', 'macos' : 'VK_USE_PLATFORM_MACOS_MVK', 'metal' : 'VK_USE_PLATFORM_METAL_EXT', + 'sci' : 'VK_USE_PLATFORM_SCI', 'vi' : 'VK_USE_PLATFORM_VI_NN', 'wayland' : 'VK_USE_PLATFORM_WAYLAND_KHR', 'win32' : 'VK_USE_PLATFORM_WIN32_KHR', From ce67c0fb75171142d9ac187e04cfe6218ace44d6 Mon Sep 17 00:00:00 2001 From: Charles Giessen Date: Mon, 21 Aug 2023 15:49:45 -0600 Subject: [PATCH 112/154] build: Use Vulkan-Loader on windows Previously, the vulkan-1.lib file was checked into the tree, so that it wasn't a required build step for windows builds. This means that to use functions in new versions of vulkan, the vulkan-1.lib file would have to be updated, which is annoying. This commit makes the necessary changes to allow linking to the vulkan-1.lib built by Vulkan-Loader directly, as well as adding Vulkan-Loader as a dependency for windows builds. It was previously only built for linux & macOS. With the use of the Vulkan-Loader, the FindVulkan.cmake file could be removed, as well as the checked in vulkan-1.lib files, one each for x86 and x64. --- CMakeLists.txt | 73 +++--------------------------- cmake/FindVulkan.cmake | 81 ---------------------------------- external/x64/lib/vulkan-1.lib | Bin 48602 -> 0 bytes external/x86/lib/vulkan-1.lib | Bin 52334 -> 0 bytes scripts/known_good.json | 8 ---- 5 files changed, 6 insertions(+), 156 deletions(-) delete mode 100644 cmake/FindVulkan.cmake delete mode 100644 external/x64/lib/vulkan-1.lib delete mode 100644 external/x86/lib/vulkan-1.lib diff --git a/CMakeLists.txt b/CMakeLists.txt index fe0a283354..ee0121e641 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -11,58 +11,7 @@ set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_CURRENT_SOURCE_DIR}/cmake") include(GNUInstallDirs) -# Find Vulkan Headers, Loader, and ValidationLayers -# Search order: -# User-supplied CMAKE_PREFIX_PATH containing paths to the header and/or loader install dirs -# CMake options VULKAN_HEADERS_INSTALL_DIR, VULKAN_LOADER_INSTALL_DIR, and/or VULKAN_VALIDATIONLAYERS_INSTALL_DIR -# Env vars VULKAN_HEADERS_INSTALL_DIR, VULKAN_LOADER_INSTALL_DIR, and/or VULKAN_VALIDATIONLAYERS_INSTALL_DIR -# Fallback to FindVulkan operation using SDK install or system installed components. -set(VULKAN_HEADERS_INSTALL_DIR "HEADERS-NOTFOUND" CACHE PATH "Absolute path to a Vulkan-Headers install directory") -set(VULKAN_LOADER_INSTALL_DIR "LOADER-NOTFOUND" CACHE PATH "Absolute path to a Vulkan-Loader install directory") -if(WIN32 AND "${VULKAN_LOADER_INSTALL_DIR}" STREQUAL "LOADER-NOTFOUND") - if(CMAKE_CL_64) - set(VULKAN_LOADER_INSTALL_DIR "${CMAKE_CURRENT_SOURCE_DIR}/external/x64") - else() - set(VULKAN_LOADER_INSTALL_DIR "${CMAKE_CURRENT_SOURCE_DIR}/external/x86") - endif() -endif() - -set(VULKAN_VALIDATIONLAYERS_INSTALL_DIR "VALIDATIONLAYERS-NOTFOUND" CACHE PATH "Absolute path to Vulkan-ValidationLayers directory") -set(CMAKE_PREFIX_PATH ${CMAKE_PREFIX_PATH};${VULKAN_HEADERS_INSTALL_DIR};${VULKAN_LOADER_INSTALL_DIR};${VULKAN_VALIDATIONLAYERS_INSTALL_DIR};$ENV{VULKAN_HEADERS_INSTALL_DIR};$ENV{VULKAN_LOADER_INSTALL_DIR};$ENV{VULKAN_VALIDATIONLAYERS_INSTALL_DIR}) -message(STATUS "Using find_package to locate Vulkan") -find_package(Vulkan) -message(STATUS "Vulkan FOUND = ${Vulkan_FOUND}") -message(STATUS "Vulkan Lib = ${Vulkan_LIBRARY}") - -if(NOT VULKAN_HEADERS_INSTALL_DIR AND NOT DEFINED ENV{VULKAN_HEADERS_INSTALL_DIR}) - message(FATAL_ERROR "Must define location of Vulkan-Headers install -- see BUILD.md") -endif() - -# Cmake command line option overrides environment variable -if(NOT VULKAN_HEADERS_INSTALL_DIR) - set(VULKAN_HEADERS_INSTALL_DIR $ENV{VULKAN_HEADERS_INSTALL_DIR}) -endif() -message(STATUS "Using Vulkan-Headers install located at ${VULKAN_HEADERS_INSTALL_DIR}") - -if(NOT VULKAN_LOADER_INSTALL_DIR AND NOT DEFINED ENV{VULKAN_LOADER_INSTALL_DIR}) - message(FATAL_ERROR "Must define location of Vulkan-Loader install -- see BUILD.md") -endif() - -# Cmake command line option overrides environment variable -if(NOT VULKAN_LOADER_INSTALL_DIR) - set(VULKAN_LOADER_INSTALL_DIR $ENV{VULKAN_LOADER_INSTALL_DIR}) -endif() -message(STATUS "Using Vulkan-Loader install located at ${VULKAN_LOADER_INSTALL_DIR}") - -if(NOT VULKAN_VALIDATIONLAYERS_INSTALL_DIR AND NOT DEFINED ENV{VULKAN_VALIDATIONLAYERS_INSTALL_DIR}) - message(FATAL_ERROR "Must define location of Vulkan-ValidationLayers install -- see BUILD.md") -endif() - -# Cmake command line option overrides environment variable -if(NOT VULKAN_VALIDATIONLAYERS_INSTALL_DIR) - set(VULKAN_VALIDATIONLAYERS_INSTALL_DIR $ENV{VULKAN_VALIDATIONLAYERS_INSTALL_DIR}) -endif() -message(STATUS "Using Vulkan-ValidationLayers install located at ${VULKAN_VALIDATIONLAYERS_INSTALL_DIR}") +set(CMAKE_PREFIX_PATH ${CMAKE_PREFIX_PATH};${VULKAN_HEADERS_INSTALL_DIR};${VULKAN_LOADER_INSTALL_DIR};${VULKAN_VALIDATIONLAYERS_INSTALL_DIR};${JSONCPP_INSTALL_DIR}) file(TO_CMAKE_PATH "${VULKAN_VALIDATIONLAYERS_INSTALL_DIR}" VULKAN_VALIDATIONLAYERS_INSTALL_DIR) set(Vulkan-ValidationLayers_INCLUDE_DIR "${VULKAN_VALIDATIONLAYERS_INSTALL_DIR}/include/vulkan") @@ -119,25 +68,15 @@ elseif(CMAKE_SYSTEM_NAME STREQUAL "Darwin") option(BUILD_METAL_SUPPORT "Build Metal WSI support" OFF) endif() -set (VULKAN_SDK $ENV{VULKAN_SDK}) - set(VULKANTOOLS_SCRIPTS_DIR ${CMAKE_CURRENT_SOURCE_DIR}/scripts) find_package(VulkanHeaders REQUIRED CONFIG) -# The vulkan loader search is: -# User-supplied setting of CMAKE_PREFIX_PATH -# VULKAN_LOADER_INSTALL_DIR defined via cmake option -# VULKAN_LOADER_INSTALL_DIR defined via environment variable -# Default findVulkan operation if the VULKAN_SDK environment variable is defined -set(VULKAN_LOADER_INSTALL_DIR "LOADER-NOTFOUND" CACHE PATH "Absolute path to a Vulkan-Loader install directory") -if (VULKAN_LOADER_INSTALL_DIR) - message(STATUS "VULKAN_LOADER_INSTALL_DIR specified, using find_package to locate Vulkan") -elseif(ENV{VULKAN_LOADER_INSTALL_DIR}) - message(STATUS "VULKAN_LOADER_INSTALL_DIR environment variable specified, using find_package to locate Vulkan") -endif() -set(CMAKE_PREFIX_PATH ${CMAKE_PREFIX_PATH};${VULKAN_LOADER_INSTALL_DIR};${VULKAN_HEADERS_INSTALL_DIR};${JSONCPP_INSTALL_DIR};$ENV{VULKAN_LOADER_INSTALL_DIR};$ENV{VULKAN_HEADERS_INSTALL_DIR};$ENV{JSONCPP_INSTALL_DIR}) -find_package(Vulkan) +find_library(Vulkan_LIBRARY NAMES vulkan vulkan-1) +add_library(Vulkan::Vulkan UNKNOWN IMPORTED) +set_target_properties(Vulkan::Vulkan PROPERTIES + IMPORTED_LOCATION ${Vulkan_LIBRARY}) +target_link_libraries(Vulkan::Vulkan INTERFACE Vulkan::Headers) find_package(jsoncpp REQUIRED CONFIG) diff --git a/cmake/FindVulkan.cmake b/cmake/FindVulkan.cmake deleted file mode 100644 index 41496a63eb..0000000000 --- a/cmake/FindVulkan.cmake +++ /dev/null @@ -1,81 +0,0 @@ -# Distributed under the OSI-approved BSD 3-Clause License. See accompanying -# file Copyright.txt or https://cmake.org/licensing for details. - -#.rst: -# FindVulkan -# ---------- -# -# Try to find Vulkan -# -# IMPORTED Targets -# ^^^^^^^^^^^^^^^^ -# -# This module defines :prop_tgt:`IMPORTED` target ``Vulkan::Vulkan``, if -# Vulkan has been found. -# -# Result Variables -# ^^^^^^^^^^^^^^^^ -# -# This module defines the following variables:: -# -# Vulkan_FOUND - True if Vulkan was found -# Vulkan_INCLUDE_DIRS - include directories for Vulkan -# Vulkan_LIBRARIES - link against this library to use Vulkan -# -# The module will also define two cache variables:: -# -# Vulkan_INCLUDE_DIR - the Vulkan include directory -# Vulkan_LIBRARY - the path to the Vulkan library -# - -if(WIN32) - find_path(Vulkan_INCLUDE_DIR - NAMES vulkan/vulkan.h - PATHS - "$ENV{VULKAN_SDK}/Include" - ) - - if(CMAKE_SIZEOF_VOID_P EQUAL 8) - find_library(Vulkan_LIBRARY - NAMES vulkan-1 - PATHS - "$ENV{VULKAN_SDK}/Lib" - "$ENV{VULKAN_SDK}/Bin" - ) - elseif(CMAKE_SIZEOF_VOID_P EQUAL 4) - find_library(Vulkan_LIBRARY - NAMES vulkan-1 - PATHS - "$ENV{VULKAN_SDK}/Lib32" - "$ENV{VULKAN_SDK}/Bin32" - NO_SYSTEM_ENVIRONMENT_PATH - ) - endif() -else() - find_path(Vulkan_INCLUDE_DIR - NAMES vulkan/vulkan.h - PATHS - "$ENV{VULKAN_SDK}/include") - find_library(Vulkan_LIBRARY - NAMES vulkan - PATHS - "$ENV{VULKAN_SDK}/lib") -endif() - -set(Vulkan_LIBRARIES ${Vulkan_LIBRARY}) -set(Vulkan_INCLUDE_DIRS ${Vulkan_INCLUDE_DIR}) - -#include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake) -include(FindPackageHandleStandardArgs) -find_package_handle_standard_args(Vulkan - DEFAULT_MSG - Vulkan_LIBRARY Vulkan_INCLUDE_DIR) - -mark_as_advanced(Vulkan_INCLUDE_DIR Vulkan_LIBRARY) - -if(Vulkan_FOUND AND NOT TARGET Vulkan::Vulkan) - add_library(Vulkan::Vulkan UNKNOWN IMPORTED) - set_target_properties(Vulkan::Vulkan PROPERTIES - IMPORTED_LOCATION "${Vulkan_LIBRARIES}" - INTERFACE_INCLUDE_DIRECTORIES "${Vulkan_INCLUDE_DIRS}") -endif() diff --git a/external/x64/lib/vulkan-1.lib b/external/x64/lib/vulkan-1.lib deleted file mode 100644 index 3e23a7bcf37126b6cbcb040496c6066e039e3057..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 48602 zcmeHQd6*PMvJVuGWf6Iv>pkA6fQlR*JmnVT5NAeocU_^GX_%It>9OaKLje&%5fSl1 zKtxcHLqt>*L}fkkLLRcHclYkT&4|2)1gn5oFf_+>^$ z9u=8cb9CoKwyfgZW~Uap|Jt1HKHI0$%rB?6Yu8@?KBO5ylj{M7oD4AZQh>7Q02ANU zbju6?qM2`KTC^U3Xz}x!mb?r=wCr+Cj|>7JTDnQo1G4~#=1$Nw{v!aQslRBtb0YxJ z9ft10yhL}FYMT2G%!l+;TSKVpDWuzxM>K4$rdjgTGJeW=Is*`mJyg?_#rTYL-A+x@ zRss+`P^4*M1-2v7EyrlO0e>gDZI-6%djSwl&uV%c>rAwAi>B))qF$u2sGn&1Zkn!N zjrowKf2wJ63#>2FjB_=OLq5^erkci~exjSEX=Y~)(oKhJS~VK=A|*Fzx_b?_Khkj2O?1alO{?}sIiwLM zYZ~({0MTfyJJG0Rnyx~gqO0*I(#Rp2Mo&dKq%nx4256WKp2D9~ceA<4>gO0}LTvHB#jkO;uQSqI3&QRlV^UDbq^R)t3Vh)mCXrZ$mkxN-QT) zdbFminq&EqMq&Ag>RW5NdOhYxs>605N}+v-YS4d(>St-XrZf5`6HOAU!=t)4kXRM3b-9G-E0DE2KHQX}Sjh6ivjRNDsfOsr)MdqVYpCO&yE<4{6Ov zO$(1h`yoBpLesri9-?`#X}W(dj(bQ;`w+fO zVpzEz$(q`1W)u?)a;#*}s=CT#7L^XH7*&%hOQd@w>r-XP8q^(`Wb>Y%taWqs!qU}c zRp#il=-ioXWukUqHdCF<)}|t~1Z5(%^{Gq@PxcCm*N+GlOcspPo4b50HB!Sxb;-J9 zuS8`kJ&K77C6fgs_4ZFzX0i>a49PHU)?2VpWnIh5v*-e7tPq#w(7xiz2Y6Omd#+CO z{MI~L8RMg#ko#<p8MESyhwDR5{knODv>QV>h5NS}3H?ma$)AR5F{pd_j?r zE)5$LWBpVXuzIj9wSaOf-ME}#-O$QZEei1`N8*x1sL+& za;>L0Q8iqRLQyF;XP>J2L^@SYb&#^>Otw0_*3sDAGnHun%48L_L3EnU-7QsB-mPxf zuw>RVL5Rg=)tKjqa*mZmT&}b@d1YNHo1{X~^pGo+X<&-O3ZfE&`Ae!3*&5UO5n3We zm@ap=(m7NS@|h=ciCYZS6Ug#f*!B&^v66Z`?3LuxxPGz{X7sZn&ZCtnPSzxAl?1g2 zf3gzTN-Dji7N=&@Y@A``sGp)0JYDXymC~gyNn&5B$YlKmh|jT-rnr6r^?$V}@mW?@ zYwcODy`4W<36s@|IFD8aYpT+DO*zBLl^8iRnD?tqQx>!+?7^n%vSBOZJe$d+QALnr zB~1~zXozKHvE-f{g4U&N{|a$!4vnfir&kE`Xk`qXC*(d`DXwWyDtT2vn_^j6M}rX# z^Q^Sith$${R6kh>lh=wkk5&e4qtbCg$|h?vb=k5c&VZRZGcHD?+1#uQPUTcKscwFP z=dV7?)ml=KD97vDb;hm2HNjm=8AqEg(PI2Bgc z;rod(hMzH%VDklRfk;7)m2~awIhM$_c>=n;Ofui*(ke?5mDTAat*qT=D`j-}VgZJg z)44IRESsvX&17*P^U4vOW^)^*a`qgFHh&Po847)^if!|R)S65(-{w+7a6qG(=K@@t z!!92EWV8+WOhkgsM+?eO9)W4)FRrHbUMPpiwt2MOdSw%p$)Reo=J^5VS!vWw@9;dy zb7ao6@>+XwvI<9~fr%QwpD>n{HM&`fr<(DsG!6)w+ZDqP*paL1(ur)Ub`%yrGRfxE zrK06*qN?0+6wb5Krd&M9D;Q^5dF3BG!8iwJSy}4V=YW)2RB8*5kbYz`-O?Ccp$Mjy@gJFtue~(GWW(%09wl3v2^Q34 zvpjlEODiEK8d z7m=0T&~BMbUd=h`71B5nO-%ZkN#R_>WV|OPp~~#NifUZ}9+Or>TxqHjS1-8O)zSeT zlO|{NRHIV!?n^BsrLdd>F zszh~JMIu$Dt1B?AylovfgT%Etut7ZaYOL|AFYs-yu4O6+OAe_r>4HgIn*+O7UD8xj zO9wetGUOsOE2a}{ODUq&MY#sGrV~|IF1y>;fa%S`FG!n3%4e$hLXV`n-g}E~K{sOoLEGg928M12RyXgbgD(lU*Gcn#v~2J!dqQ z)C#0DH}@r}sx#U-Bbd$^ z_WW$7u9}8(Pl1?jwS;PE_srX&iX4fN`F-~kHSpv}9l`AnQBznbQlA=Nf;-%z(g?{& z&3ey@S4yy2SSV6oj!hl0ygB6~QD{FoTa_?tW54uLlSj%nsNLIG$qzshZxBQ659Oyn zC~9@no1=b7(CtKa4)eIQn&@0%hh=4H1XZV3RG%D}w7a3Ui)nM`7O}eYdS1&qF#yJ5 zvNUqj+hn&yjd^8rI93u%$V$$4GL5%IrZNrOc!G-PWUHezo2oSHP!o|0a;&6hQPodP z8MOrr$4Z)6LC3d$TQ;-|-|(vHz0oyivejW%OHoR4r&}$m%%Q-znLDftM5a4h=p>Z( zCB2>uPPuwcW-cd-$vVx{7+in`bw-FWo$h>N^c7>^1kW#|BiFy8oYfj!Pqx$R7m;oA z=qAQCGJ6s_NKl%@9S@9@qv0D6uzE}@=TOv;gw-Sj<1b0oRZNV zYAlqeV1s(yb059Un(v$J@=%sl2bb1-UyLh^E#w`GE%mi4!2;lj}052~A zxO^GFpho~U;i=SF58&x`JT>~!cz|D~0&Kh!=?+Z43!oH#{|BbEeG27}{&73N+F^Lw zbQYd~T?x>94M2~(k^cn1-Y7S3IO?hZXf_+5)dGMc@5d9Z%K-*Fi6>SkV0mr^Scj)< zSI@_j&CdXApN!?b4d84{OJiC;=3qe@?pz;EPoN7hwI`V*R#b-S)%0JrHLumgNmB%br-zDX8mklpT$-o051k z7wg{^>pc{0wm0%l9s%&}7{niq{A&_RFeEF5A zA8C0OZGm(^HReOwQi=Mju)Jx2-uSas25p0S2%g68}{-apG6?oDbsq{uXfsFjI zSl=O7$7iwq7B56y4`Tb>hwV8JF|I|z-=D>wThR6|W1bnPXY*Z{j{eqrG4hw8{gxme z`r4p}u};eYPJ0N;x(M3>f3~au_&d`0Ip}j}pYd4d`RF&3W@CAu#yZ@Kw!^ksIs@Ae zW$4)SM5K37*H`6OHuTxC*nT6|033(qYk}q4h$endIyAu>GO!yw4R^q0 za1k5=mqQUOg`?qNxDIZF5s-!iR6;#m17qN7sD-Pb4o1Rc$ii}{fhx$rl~4^6;U<_0 zqhSh6fE!>uTn}Sm7$jjhJObmO9Lk^qu7DH_g;8)VOoEPZCj1t9!2sw7YhYiPjfHOu zCqgOogtOs4p(%8Q-f#vCf(zgYXbtDVT$lm(LMJ#2eg_vqe|QF3!l}>-E{1d9T-XE7 zhi=dZ+QTK#7gj0+z0bvPdEbp0L5@990M!hNmvF?!74Zk zTEKzuIQ$W2!SgT&?uOIgWH=Tch2!7_=nVV7T9^sX!CkNjmcU}z3l_lM@BsV@UWDeb z5LQDoxF3EE55n>A5ZnUO;Z~Ri^PoF)fJ@PD})I>&e>7 zm19FY_%i3`3BCDQ5Xz#aZoW7r zz$}q_pz@X-?Q%tII|aAJSOHX0?p-c_=aJ|0xORsykf?0Vt3dc3HW+dMu z7UGErL^JuL4qA8zTv)lIcC+PO*r>fsbu-IsetXIp(>ZObUxj%L#?68$?wLn7*&oH6 zGj_ojY%;z+D;t$P@Qxl7qgM8vLRE&nE%G_WK(p-$7WsG827E+mRk6YVQuGg709uNl`mDCLR-TeuwK=-lRzGZ<6qbi6S`;9!d>+ct|9|#XUL4#|_tYQNwh7 z)H2y&PHQZasi7 zLSnWh^U`UB^VVuNEJLtvB+TqeHX!BC_zhig%W>W{$02D-3asccKpM3{;WbVU8UGCc zh0s-k=ihCZ-&R~n`Cx1kj5 zvvvMd?BOf6YZE;M3&CElQxXbRkj>@X4l3ds))k8T=1?ad(O@do@N2GdF}50j!)!Iq zYTNQqGWVtk5yx;!CMqr+QWhmBs0>|PVpX!;Uut-_Lz{J%GPA$`8f=Vw@&p=2&f@NC zuo5>Qo>Te1zO@~-my8|3Es%wXwYlx>4@cJ1N;u8yA_un}xXa|0%%M~{W&WB)@f_-P zukqa}y39ez97=O;EQT5^A8=nL2do+jgJ({nD7@@JbaQqq zGyiBeQHQi5{kY+&%5_yE&kkNis?O*56}3LU)2J>SGL6_Ma&QSV>cwgB1`^BctqWBn zId;hF20q^1*Iw?mXRcd~%6}+ksN2}fqxhx^@K#fN^Hl{~XvGVySyg~XUbXTh=fy}R z_{*Vin)^nh#MPMUuK@8?$`y(_6C!;(A>Vy;LC!A$SpuEdlnZa{1&+F!z2+dBtn6R! za|}nv^6a%Q-#S=Ro?seXyrUI9nS>gH@ojs6N%@_x4Sj=gNXUk#vE8$DdCoqw_b$!E ztfArxA!<+9b}FM2v%6twE$Ch;3EhBDLct)k&kTp3b($Aq*5KjWC!UzHhA*Way)d&U zrHn%kj85v`2C!jdo!vf#Ph0h|;bf)Hy@!Np6e~6={Frh$kIV4_#!9CfD%PyPDSpLd z;bHa61H+188_kA6$yK!P8>wFwk6@oy&Tal{0iln4vf>Swxw=UhWk(KbH| zdsOil%%xan08v9IwN|E{J-x}2d_o6Bn} zRVOv1lBeh=7PGRva7fjrc)eETRZot+>?@3?-ukut)q;RE96weF?qH}`Hu_|X6cHTt zlD&A7$Kin{#tel*y)+&Kwaj4n)4P)6ITf}$UD?*p#!80gx|L!2eq!7w#OMAKN(?!W zCt*CuJX>clkJcOPqvH;SX+J8p`2h&&Q$MQGSjYo%Z3AkhidaV z8=e(IfI&?WZ&XZ7*M|Ck_=8^fX3IXcr`-j60fzdR0>!X(^k)P1R;(umd`V)vbAEC# zH596A_z)!m#B7*NHiu;sZsGaZMU2vj+#(#PL<#GIJbG+ zE|Mc4r*z~a?U_{;c7t#^w0eRO3T;$OcQ4;Fw6$DtE329;KT&Ud%`I+&XcDSTGmYaG zDHH$`Oc9h36)C?6N=n5M1x1zGhjUjvC?hHo!)8K7b3^&5B8VDFLP0VCMHCcO=7@1g zmdzn9tCxdeLXpE^uxKG;Y}zI9?}xfh7Y=<1>T(6Ww0J1orPyd*H_)ZHa)?VM3Bj%U z5jn$J_)#t|pe28x%Y3+#1+ff=g|FNXfCfMH>3(g;TL!B)RCmFvSpM{Hmb;2;SEuSh zjXJb4z=f|(2nM3+NAM67K7~KU)bKSA!f*pl(O+M-pJi@ao=(#ZfrkDM@KG=D2# zNVD=uyTeIsTfN=_PeSjFhp6da+j9K=)9~X;^b?-Q#$WItweznFwCvWFzA2hGuANOd z0DoDJ^xuZDJO1nfr>!+|9Ss{#8{;`v#dEm~~s&rIF*;~qWlJ`IJmNP7qyakWs zJO9XA{ykohPs<*GWr_Uwc{A=Q`Sh}OXS%)Yo3#~ReS`?Qon^b_=w%(Op{SQqFXR8Z zKo{G~+FL%!ZMF~QC&@Lwee<#HkywJp^T`e!%>Y(Jf8&IDYWbwr+g|@269sF*3D180!BL2~w}+_SU8E+Ak0)4k!To!DOcwo>gcqnF zuWddSZGTqSqUT+-=O&srnkhWHW2V;6g<4ba&^0erDG&X%gT{l9yaD6ZuS2JB{T}SQ zDDEi$WL2vL_cE8 z%^JUk!ff@~!Owg`v(>&FFR&}hLF3l3y)cFsFX;Tk;fUGN!}PaY3&E0R#>sCUw3TMY z|FBr${ag+i-=>1s9QN}uZxW9uaY(;b6*maf0 zomD5c*+%2e0Uk2j=q?CNT3b!}V*XF$tp|qD?9DB1PN#e3HL?oc`aDe8PTqPD$5fMt zquzPQ2TQ8oi@RU= zRyz(u+(Rs`J+0ta5@KU{uZev2f3xp9G^!pN#L_1t3aXnl>fF8eJulIyb6611KQU1d zW_w{x^+H*zcMe9(!#zwqx>2Yt?H_Yww!E<9z1L|id<4f)b0VD?;nm^~d3mSM`~Ljk zOKWMpf24pW8#6YlFrM!B(8`sbf%Hay0|3myaFRgBwu(wtO!Ugz~RCmm}M`57Y) z7Q5}Fcf)ta{Phj$564+F=L8dni(9u2f;C^BTl584^LUG9*M{ElsDcm$e|hG$mY)?N z;t3w2d-kdjJgN0sUHSelYP}OJ9*=%=u=uSfjGDcRNBux=qOBY>Z~AiwwD^d^*wXc_ zE`Ou3sG4cDGZaHr{i$( zZ7Q_lm(M@cV^`AwE*v3Kh&jND5xE7UWh$nu3>!&nBv}Jf^ zmZD6$4|fO zYZ}`+d1!$ny9FUi@tJ9F&3cvIc+b>`>TIdqwB}&3dxbELK63dUuNNWKSs^TajItm+ z!J1oFJp5O(=GhF-*@EYQvAsp=_nXf<@1N8I&v6k02cc>b5e$F;T8 zUkqvDz8Iq3RqaUobzgeW`V-uI|oyKpT3uw!VeFK+!h3hx|?UhVl=YsBmt##Cn{ z%@Lr2v88p-W#@hO1Fd_yG3>@z_efZ)mM&dOSlt4A zY5mxr;dz%exG`h5pfq|{bv*4O8odXE(Ly&tICx{U+C zbJ4kfq3GB^j^|uz;*fD`D6M&xeck^pTJv1wB8G2Fao|R&>jV9JzeaT}=E%+^91a<` zuF@X-sr}CQnD*dH7-HzM7YB`9PpP+jRsX|(QEw?#sJNc=uZ|TOofF;a9bBM6II^o{Eex`OD#1SK3NgAUa2YxhhGk2w_`_Pls&X>@`IBR z^->u%;`JbIeLD)fE3=P3WYejL{9740*Xu#-noAzMW9HX?BM<(aiywYLh>s@hm^GQ) zM(tPso}&p%=D3!X-h6J^eEM4yDY%Sd2}|aKCcVhdC zex%x6&Jl&BYg{a8SMH$!qdqD^tid6y@URmbPgrBU+H~G#S}6~4@WiESY_F7d;Lm^M z(G7%`;COcNTIe_~tXmg;xcv=Uw+@x?gvD}fn+oI1!r3RjLgQ+ggefhS<6Bl3S8x6F zf?Y+3TFy};mdmkgDa?>d7CowF$Rx*$S}w=0q41V<;60`5=`Cv*M-&&#aqHJnI7@x= z!~uV6gJ{DAw44j(_;nRpv)SV--=x;8aM0x?bKKfW@07niBA3kZ>nM28 z;#uE*NNcPs987knyr4CtRLe0Jobw9Ra)g5zxmb>0OTlZuTs-Cz^4he)r0JeE3e<-; zdDA(gUtZ^A1ixwXo2>GiN`)4_Y|l-~!SliEB-CygwE2cETvZu7=i8s+4g5k%AjN!- zO@H_%#e6eT2|}0q3qkKB*c(b0zE4+Ns$Fz@Bf9Y|AguJB{&?W_)36Lz%4KL&8%R5; zM~|Pifp$`}GQRiqghFgDjnIF&_USKZgsyRM-FvC_(+nIucE6TtJ>tMYs@Ao+&Tq76u+%gxRGC#D5$>Dy8GQJ2YyWJ?s|=jU!pKCr+Q1U(3%Qw#Alq6+D3?1 zd5HeYY2o*K+6$}2cXuEAX7}VS8Y!># z(P=u?f3qI_(CYh!tfet@VovN3bo_b?@A$3z^w>bL#Onjt5g!ZU%^V+Jn5nkT ztJp%T-boGNhpHdf%Q^{BqvVsLU#E-nlO=TdJ4XdsKss-I_9thmySO*lGN{<5{b&-0 zi(6v}?aiN?{x|jF8!eiOZZ-y*6eC}?vdIRDkx#K`?2>Bq;vjB4r9QQ2#Xjq(PuVcYE9=z{@B6{&h<|fl_yt=)=vSrdAKFUu;xxAe z;jeD-s>dErq{v9?eOm3J$jB`ovWWpV(#+UNu=kB`|FrQO#GGz1-8Z*fUkod#{+$Hh zJLrx_Kca7)+#07Wg^#VmThI4XuiiwTZkdt0B;Gg73jdNsC*l3%$z|U>PoMa>EzeSf zOcC2FI|;LFub%(2{wyrT?Q$vXx7YN$lfT?>msRmgBFwkbAOGFfGqEIh#~3T@LXRbG*~UEsL~@-{Y}kchG2cms}S6jk*F`Lz*8SI%=Pf zXnvfT8#ypU$F8$5X1)2#g@2bJYsHsB?uTHZm*DLi)P0i{u9j>_sS)ZztzYcB7RE`hMaNdu-9mYyk9Oyjt^?O6IEQBoGGm5XT5awpZ*ie z@<8me6lxi1#H@Jvbk#x+MwBMv)1ll^Vz-dAXZZHEZ$6~)YGKZD=ov(RZj=`xZo5d9 zc;(fzza(FMC}#;mUp?i;XcSA#Tk)%HWQj#N%V7d4p(S=)OGv%tiu5~wqTaGtEAiQU#q>_h;B|BT_f$A!>{gd{ z4p07c%1^Xk`mn{+r)GkGtBIS`8JhBn4GV8mKX)GWC7nxJW^tvjBRRIp-+5v&7WSRo$ZwhO?}wH*-Ur3 zyYrAwPms=)9(`@iCq;<(WC$^Q%$r*`FFc{=J@?Brb<*l7AJ5R>v^n&oEl}&a^ llg+fUc`gb+;5c!6pfsZGbI-ERX+&GAFx_vrbN$fle*t3e*u4M% diff --git a/external/x86/lib/vulkan-1.lib b/external/x86/lib/vulkan-1.lib deleted file mode 100644 index 3caa7ba045a0aef089104feb0843cb55bd78bf58..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 52334 zcmeHwdED32w*QI{r<1N@I2?yKhRkVrijzEzL`Y@4sBh2nrRVfazR%ELD1;D_5R%M^ zk|~)(r5rluOF6hsC!wq3T<2!YZ>>FiK5OsK`h32h&-3l~y8ql>ujT8r_uA{d_PqAm z!?Rb3*7?ITe8Dxog2LUH~9^xPzu^F9aaEt&OI8I{^^g z(^1pCi|`xip81;QAs^AQshVB|0HV852cklwra5~65G`4v={4jhx__ajC8#gaLw9Rx zcpHGI@fl4Iwgn)1v|7_+^#DXK?xtz!TmYi$hiSTP9qNy?qFmF0@c=}B{z=nxEK8!< zqcmN&27u_cv6>cOo`_Z~(6k(NA)1EiiDq4`>1C8bbaf|9w;T#UboFdax8N_))P89f}&Hf1WLYjtoCc0yWrkBq_Jfx+aHBCJdnQq6HzYG1DFq@0)`Xa{e-4hQ5Mk{ z)QxEJNKIE@8b$5!7im(trpuNC5KY4LL|6P%)0OK06xHG{QZwqHXe$09jTx`$BCK~s zYw#E8;x`SQioZw~?yl(~z<8u_D>aQ@1VA(f@rcHwK13IE)HL~B)EjByEKOrq0T7KF ztZ6Lfi|Ddpnl48^qD!kaU3Dw~(IuB^YC05vXhJ_tmwt?VNLM|h>4Mpai*(6%nws$c zi7sicX#$oF(L~gb=q|)1dI>RzUYx6GaT$Q3=kOQl=3biadJXxJUNLlj8>~m9WqW9P zaw-7P6Js?!G7*4i-Vd6tU611n()>-DuB*g;hji0oO*f-%L@#0a65ZF+&?5XrdTNQL z=NfT5Lt6BLrsoSdt|2}1siqeu0}w6TP193dF&)yvIhq>I!tn*Eae$_|?Er`_KTy+! z*awIfpsqx7@c)Tk+g;Pc({a2+nvQLQ=+3p89z-6ZxzjW~g!n|yeyOP*%Z6wQmIu+T zlQjJquwNlPiEW+e@pYQ!jmL6Bns4Y)ltc9NYed6`4?JP;NkfJW@7I55-ys7B4?Ahd z@aCrK(Ye|~4u|2xPdsJNpeP4Suq>Kk*s-Uac>M5wy@&P2Bvm!_!-qGI?pw&`8uJ5d z8ya)975VbRJA)i(`TOM?8Vhyff&@K?UkJ4P{cD?Q@&$w#JZfA+RYk74U%t7jBHv(; z5~Hn*WAcq|>H(;8Qvro2^u*|R8Fhu4T;t$EU46dLSQRJ~6(;e;N*!2}J1;-LPtsY| zGoCqCKGRp0=`zI1Ik_p{lpm0*sj42wQs~-`6hS<5to#%5HFX6pTGm!#V=`?kLlrA} zS5_8+`j#SCI^D)1siMI)jqU|HzWngAun({x%WE3DiBb8A1Xbrpov3pC5Qp=$Tvg-1%IbW1*MOA=SzfIIkD-B(1~(pNxqDYv z*Hz#!s9U_zSqQZJ0}6SU*9)+GC*uRtLYx1>?ex-}?R!X0$+R8pn z=boD{n4;3-u^7zLsPQ?H#1FM8P*)BzB!7NWRUuEx;$)}lrWgm4#6V<0NesT6q4l{! zgK15UG~F3cEhR0HjmdQ9Vx39}h|GIklr@3!vn8=us+UqNX$;nrD!!qOXrNeTA<**ENP(qhWOr5rPBhGN z>)Z{^V_zOsS3qNp<;`ZtHY%nz}gMmlGW1X*4z1jXl&N7aHsS1rv8uzXs7Y)xp9)YVlx<>rRk6eb&PWKeEyuuX$G3?fjGrfTf> zUDa$87h_Xu{q*4BD93^Y54_d9)ttn(RED9B-vC-2%OXl@A&0L8wi^bqpe1 zJ%eDIMxzWJm8-;grmnIH4G5=$`Vlsr!4eY2#n_Y@ad1_AzPhS5-#1q=%7u)^*pxlgl_FRm9?KYK=TJS5se| zFSyN+g;{Qc<+2NbmS0OphKfQ}ePdk#2WO^(?OAd0R*C_LV+*nw$6)37+C+xXpN zwXUhQ(l#Ego*(X}8j4=8imGa?Q(TIoU!Y;M^)&0EkfTKzr(xfWmEcB->4)Ue51D#03lieI)B|xO8*5soUg(*meuS6qRCG_==5`>}A6#23FN|YJ0;J~O=GDuD& zPhZtgpKGib752-1JVf9OC8?Dc!I%_I3`^O!u6~@Y7Mmw8%;VO}l%V>FISgXFeX7xq zNXrYe45V6ff*5azIIPYHv#nE(^3tj_!|F^%wBH5s0^OV_mR8UDezHg?OEI9Ty4vUW z!Weho>U^%yx30RbpmP;88!5t1r^XaBbV$kNcwb8I#ztHjX+NBvvZ!E4FF%H*#A&0h zx;byELi<^2DkGsR1x^6m5rP;_2;)>!lE>?XF>Z1PDQ5I0s96vtdtr>*&SZUZg+djY z{@MY7Nu&stPEE(keG!fsUKr!XiCFWR#Y|156T&!Ez5=&MC|d|;snjq&tf~fWM_jIi zsf2KriW++Wg#g+E!~3)t%Ong&-*-4G25mJO%+jb*;wGou;b`S~WDaPh2aG`6=C^lL57b0vrW04MRDx90E$RB^~5Hs@1;Wia5`<>lg zlYVGZJsC+PCh#<;VJs%MZ>~N!vI>V%+_nvMjMGBmE{32z*-Ch_<{o1)xq}PnO0I20 z_mI{+S-8Y)5%h{<=$Kr6#i(3WZCDI35jLHz$!Nm37@HEyH-J;)qFX#MaW-}D3bh?V zEnFogh4tVR7h_Xmr)|ocqM%f&vj~BfKhh4!0;tZh&1h9vs+*?gEh@b_SBqNO(*!9X zP?KME9I3rgPC#LeJakVWNL=4%0YWH5@il6NjEjdO1U>sMR|d_RwRY3RV&YvXr&ZN<=^Ueq6lYUMTBc$) z-5}S9CkWW+s=7qh6c#Dic(*(GxU8TP3VQoHDK;X(9o&y8)HT)Hi6@W~%VVWQ@?lT= zbkumg-ixM*MWb^rh1#51gM@jBtAs@UqA0-@X?mczBt@~*E^vAriQQt5 zyFxG0bXD3`B!}}AtPqIkZz_qikAZJ_UuZokYX(xW|ZlO4dcE?Y<-?E6=oxur@`3X}GLJ zEg%$#!^LS;jiUk;wP~7$%Syx+>DGp|Sp!3#m0$+uqVnCvK^l;l6by-3VgfKAT>ock=^mw6nZ!^3z_ z;aY$;w*hpz7og)kcpn0P=i_gid3ZNy84AV=S$*!tdk%O%Vh_CkKzFdF;{AbzD7zp2 z|J@G(yxoBJCK>_SJ_u0#DBe+c3}Ckx@eadMfMM4ItV8+bEAVd10)U_JqQd)l_hHm* zfHl|Q{S}OBgW(G>{_W)$k9Qxgo`pOwqfS=?9C{1hWy0Ut_`4AAKCHYQ^MUgB!#wuF zJRWxwz(**nEvB1s2f#U)t~25uiM&@|1F#QcaC z12A$j#$5r>4yk++-hsLdO_`U8*ynlzZb2FA7(s<+_dlBk{^ybA_KS;Y@h~LID;)1JpttoDcOd39f-D zFdnXkOJOohgv;S#I2ZD89y|gQpb{!z6#NOQU?hx#OW+D9gC1}O41g115IhIl!|iYf z918oxFz63Q!cou~dc(2M1x|(I;7K?bj)qw<4eo^Qa0HwQC&3BuJhX?ypd*|De}rDJ z6&wS7U?6mb)8Kem2!}v9TnjhCZ(%s>06W6J!EfL$xEr>H-^1B31a^bRU~hN|=EEX* z8uo;C@C57xFTri_GR%Zqp%WYkkHR0|71#%Q!mnX5%zzi+7I+XIg1K-HYy5px44vTs zI2;~_-Qfio3J3jP4g9ayz?OJ7t0i~6f*V~$4LP5IY(R3w+G#W4sEE(v*jn1vhVZ5Yx4zcOr(<#SDf*?T}3u>VvYt_SQ3pn!tH0f zi?3XyUbNkwbIQpiP2A>>-%&2I!`bo;Sf+ZoH|-Z^7{fQTy`-wH)IkaT5HGMJs@U~%#13zBx=)zaSxB=1KckVV9t zn)iKPZc>bmp4oO;!igyGo5e9;v1zA~J2s?uTv$g4`IaOZdb^R<&~`t}Q^o8@(yG|o z8FCqgCa1Jio?ihu`7Et`cHTwQ19G(TRCr9?*=-}`pmW99!6UqyAjiknM>s@8bz&OIwnNZe%(lQh-VV6e5QoN$p2le9Z%ykbIUb7CSjW@6*In~BCB z<6w<+rU-}Jn<8w2Z_k!!z^nQbn;=a@v=^9&Xg9DC-WhcdDcZ^yDxSGD<-Zd*m(CSkyjP5T|m#oG!NOE z*fu5FKkm{24?~4<=CKK#oVNZVm+e_U3-+WnJJx`6&z&wxMn7V4NU{{P;l$tH%C^hbjn+~i)Vu!MWibfM;lG&C^p(S=)2DcC#leO)L#R(zGISvow#EcW*Epn+!MY?O8NG zT+IWTUA1p5oO82a!%RCNbdeYvQ(>GrQfR~Y3K;88-7O?cFGs~dY% zbU|oz2S!IZxA|0%c&{vsiM3CqP{C$s3?>p59^HAck>LOnNf$;@`RW&o^yq0f53I*RaEylXgB^w-C|r)y z_%7VFNxJ&tRK2&8U=jR11RE~z9@tnt;P4!(kVrXO2bVd_s|&++vd~3p#o8F51j7!+ zQTbe;CM)BQXOG@k*$Mjq0gL1K3_^X6CyPkFFciIWr`3}@{lOz3%*XGAvC_r%Mz5?y zo3V)q+aqhLkvPAtMi|7#8gN;7EHj;oR>YD3sXZY(lTe+2ClKvoWrJJp_w3wy00Nd9>tB zr_fY>^a!KxG}`NGwWD{d-#N1c@wi;LPg7Sp1U!$H&SR=6$^y0K-Sx6((qj*NFD68zju zsJ8HFaAF>A7LRU}z_-nUvClQ-?Ycl^mNKG3SqX$QV(5)g%OYCxYiSaTnm#>_7M^C0 z6&35TR%)rykvXJQpc)_jKsD;=LX2rCF&tqrDTZX9w8Bs1Gqx*Mg=Q1|&{~Y(fmRW2 zpDf~gPMv~kK#w)3n+y^4Hz!CBm=gqB$FJ_BVcUyS#PX{ePR}0aR~EFlzT&w1tu~&# zHd1oYi=2WnF2|~o$ev?Cs>p4Y|B+hNogpm6xGej8F&+U19;~6DiZ#=i>~-+q{1YAyeNT0xqc{XJ?C`-h6Q<1Hmk zFYDaH{`EZF%Vy2J^{e+0LD#cfZVA1tn=LA8jnvEdKi12-+Hm4~+kTke&0D@{%5)Dz z-h6Gb%ob^f5!(S!4;|F1;=HjxYlz!=1h7nqT%u z+*Ww6O~56)95=T(5@c>eWu2qAqxYNs!GVaog~5&8I&+};N17Z<$nU)~@q0qv(nStu zR-7x9e}aQKC6ETWo4$sO84v4t*8HEp+8dEuyU5yhCZn-5#O~2jZhh_44f`VERvJ;< zQFK5v*KIce^-sqvdxKE7F{o%VaSw~~G?a*17R_t_6GyGs2T`|{QE7$afbx%2H7a2K z>C%6EN0{4&m}+^Yt2CO?%$VJx`K*~S=$k(vW*ZSRlFjTj+9itl(>Jp|pjm!9jcIp; zmBCKV3ZAd*<3l%V$g#fi=T%RAy&od}%0=XU;La{A*C9=PmRW;m~jT}HT8oIh}%BI<;Mz2!xLuKUDmh$fo9f! z3-F{f3l41N@|Ai{pT(yxqn5OTi|d|PQ2BMqLE&oKkH`i%0qOB9bEaw!d0sL?^Utz35y;{Mjbje3Z@Nj-ZH5@vyE z2d{f)PsH9ez_#aZN*@uWQTT*!>ffVLc((|iJ^kYpZ}vP2qtk=!UU-j2r{6^|an1?O z7L|tERj>`Oo_zj){SI+=4{^=OrP8n@d%OOme*a1K_U|1mHK*!xQ4S>kNYz_}-r485 zi+-fF#U2u3Sg>BB&5A6wpvv^GkVs|$twRy(~i0cqu=UF&s$6L z*&hN__aGg|XhA*&#Oc4i=|e)?CqQ(M>6M5mlyfQ&_1=*f{oXRkeB!J#sjv*auL`||t0AYa*0GOlwv+yT#A-ra?r z#{OsA_Y)m<=p~~^kDfa!@Q*a*F8QzyIpofFJD>(fyBert?WOL5N%g$VkZIpiJ(oLp z;bB#EuGCvRX3b}ru)^7G?T+tsLfqa0u5f*XLuPJg!SM#Rn{oEjAG}LeR3DDNxvVI` zYCCyC^{0f_m*WK&5uEI0ZpqSkwdEV1eM;k1KL^jf3fMaXtuitU9m#|<_%&42clx+WFB6#8?lpRyBQ}>_S^-Hpwj&(5Y z#S=Wv<`gUcNHrb_Ysd{pANDh?AqR3q>x>BQuW+OmSmeS;yv_2tFVnbmoP--*j&Xqb zN2>e^wL0aTRja60kLS3dZ=m#+B-k?_pIQA6vS$WyOy;}uK{Mx5=&AMB{p%I7O;6yM z?8XqsXhDq%BmOt{ANL)N_$La8!UJHA0{o+;HGB4_J=F@}BnO{gb>b-5^DON*9$oj& z3i9I(b}+qrR1PfvNRv~^hFbmC+K&E(UVE&6DS*fhT`Yc^=}RdpE%xSpJbJ z&%*rrm$@^)r_%{TIjV4{kz=(Wzd}#?X2d_w;;`-WxwlYp9O?f-k@bY zm(kpQih#J8<{qK{-n;%SbqeED2Q_I4#LK#+^?L4O@B`KBX%1?Ug-GU7E)z!O8(#eD z4~HW1=`qOhOOdSk?k=?F4fEbwLI-Kjh(Ry16vj0d+Xj(?KmpO5LXu z{0Iy7etje1{kwxF8|7KcSjykNQ&+Abyt5oU*(lG9C-k6MzuWsiXkA@0%LuibJ;KGbhHfw{#B+9d{TH%{ zt1T{>4D5zqi8&R<vbBBYc!(pq(o_$-Gx5;$Lcnd^y7EF-|$8c)S%wez`l$T^V9~6orM{i8jp!6F=QpxXk+@eiX@=Y2$;rW!(@-6v!7H)gvw`AEj8*F@b z+$@Z>A3$CCbzu2Nn)WWCe)Pa@8whnwh#D@8)lDt``blO~!7~ewPy2}O{EZD!H`6UG zX`d+HVeSv)H5{+e@ZA7@T`KYt3D02WF{MnHx5qWl{Ex#Be_T=g&0zBjefoo+_gqSS z`ho!8sbXz>v*&i40?0h7bQji-8)q+GLRU^NWE#+Pu3za9AMmVe%$glU*WVM!Gx4Pm@b&v^(Oo1D4QecUg!SZpDXBy4a_sIAr#A zC5(0loHhSF8to<}L3*Z*C$OYkVd<64zB-+M!PFT4dNd3;>eq){WnZm`x3SP$$=iq7aP6|=0Ng~G&z^f z1-|+1h))RdssK@WV>c6`G{3(yb*D|#;;#u1*(K#<^CEL=lXe+SUp?fXw99aHG5nIp zo9@CoeV_XEYw6jEYhCojH`;hTXK!bcg>g#t8OzDSn37J5$N_z>QJR(~?U|m_^Np1> zqh9CfAU!X~@v@hIWXX4%deSRo$zLC$M<1_qVEIRyJogZ4|MS;3zI-&IP7P4qm16SC zcwB?*rO-pLG`rSbvA!4Tb3-P5XcR8lt0C;xtXkA%6}{Cnt%x?kJAIqw9g^k%}bqXw^gTuqV(TcxKhl(tG`>&mHtZkNZtjoMNAEBD zuF;ZDB}((|z6*~3h34G{l67$(;N^wj6i-V_WYP}Xzey!BCs_;Obzeu7>@%LwTIL*Z z{3}!<4<_s4z8&nS!9UWJh_uSf-LU~>5SH1ZqorQQfzzxn3;gbXQ@8of$7UWlG1^YM8`kZXxc>%6IOC
    uANKHA3_rt`+P1Ia(q)TMN@YnOWt`;KmQJ;4yeKk~>CT2PyUAL_K- z2dewbPcpo?!%G}JRsIAkeCbzhU!t>N3pJj40L3{z;G3M8XD4YFZ`tZS)!E9YqNtnY zcCXY=h9BPduhdT#G0bp3TZGM?SHV;C>(^H-r!xyrGhB17yhN)^YOg2k`t|$NUY}uT z$_Eua_>wtyU4^ms@y1)0?v8lRYCJsov6=EFj5s&UxKo|8dro5skLB|o(SrUccpcZA zbI^xWp3iGc? Date: Tue, 22 Aug 2023 15:19:17 -0600 Subject: [PATCH 113/154] cmake: Remove cmake directory We don't use these scripts --- CMakeLists.txt | 2 -- cmake/Copyright_cmake.txt | 56 ------------------------------------ cmake/FindPthreadStubs.cmake | 15 ---------- cmake/FindValgrind.cmake | 23 --------------- cmake/README.txt | 7 ----- 5 files changed, 103 deletions(-) delete mode 100644 cmake/Copyright_cmake.txt delete mode 100644 cmake/FindPthreadStubs.cmake delete mode 100644 cmake/FindValgrind.cmake delete mode 100644 cmake/README.txt diff --git a/CMakeLists.txt b/CMakeLists.txt index ee0121e641..ce0115073a 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -7,8 +7,6 @@ add_definitions(-DAPI_NAME="${API_NAME}") add_definitions(-DVK_ENABLE_BETA_EXTENSIONS) -set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_CURRENT_SOURCE_DIR}/cmake") - include(GNUInstallDirs) set(CMAKE_PREFIX_PATH ${CMAKE_PREFIX_PATH};${VULKAN_HEADERS_INSTALL_DIR};${VULKAN_LOADER_INSTALL_DIR};${VULKAN_VALIDATIONLAYERS_INSTALL_DIR};${JSONCPP_INSTALL_DIR}) diff --git a/cmake/Copyright_cmake.txt b/cmake/Copyright_cmake.txt deleted file mode 100644 index 35f7e4b6ce..0000000000 --- a/cmake/Copyright_cmake.txt +++ /dev/null @@ -1,56 +0,0 @@ -CMake - Cross Platform Makefile Generator -Copyright 2000-2009 Kitware, Inc., Insight Software Consortium -All rights reserved. - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions -are met: - -* Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. - -* Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in the - documentation and/or other materials provided with the distribution. - -* Neither the names of Kitware, Inc., the Insight Software Consortium, - nor the names of their contributors may be used to endorse or promote - products derived from this software without specific prior written - permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - ------------------------------------------------------------------------------- - -The above copyright and license notice applies to distributions of -CMake in source and binary form. Some source files contain additional -notices of original copyright by their contributors; see each source -for details. Third-party software packages supplied with CMake under -compatible licenses provide their own copyright notices documented in -corresponding subdirectories. - ------------------------------------------------------------------------------- - -CMake was initially developed by Kitware with the following sponsorship: - - * National Library of Medicine at the National Institutes of Health - as part of the Insight Segmentation and Registration Toolkit (ITK). - - * US National Labs (Los Alamos, Livermore, Sandia) ASC Parallel - Visualization Initiative. - - * National Alliance for Medical Image Computing (NAMIC) is funded by the - National Institutes of Health through the NIH Roadmap for Medical Research, - Grant U54 EB005149. - - * Kitware, Inc. diff --git a/cmake/FindPthreadStubs.cmake b/cmake/FindPthreadStubs.cmake deleted file mode 100644 index 9fc33d56b3..0000000000 --- a/cmake/FindPthreadStubs.cmake +++ /dev/null @@ -1,15 +0,0 @@ -# - FindPthreadStubs -# -# Copyright (C) 2015-2016 Valve Corporation -# Copyright (C) 2015-2016 LunarG, Inc. - -find_package(PkgConfig) - -pkg_check_modules(PC_PTHREADSTUBS QUIET pthread-stubs) - -include(FindPackageHandleStandardArgs) -find_package_handle_standard_args(PthreadStubs DEFAULT_MSG - PC_PTHREADSTUBS_FOUND) - -set(PTHREADSTUBS_INCLUDE_DIRS "") -set(PTHREADSTUBS_LIBRARIES "") diff --git a/cmake/FindValgrind.cmake b/cmake/FindValgrind.cmake deleted file mode 100644 index fdc4d7a0aa..0000000000 --- a/cmake/FindValgrind.cmake +++ /dev/null @@ -1,23 +0,0 @@ -# - FindValgrind -# -# Copyright (C) 2015-2016 Valve Corporation -# Copyright (C) 2015-2016 LunarG, Inc. - -find_package(PkgConfig) - -pkg_check_modules(PC_VALGRIND QUIET valgrind) - -find_path(VALGRIND_INCLUDE_DIR NAMES valgrind.h memcheck.h - HINTS - ${PC_VALGRIND_INCLUDEDIR} - ${PC_VALGRIND_INCLUDE_DIRS} - ) - -include(FindPackageHandleStandardArgs) -find_package_handle_standard_args(Valgrind DEFAULT_MSG - VALGRIND_INCLUDE_DIR) - -mark_as_advanced(VALGRIND_INCLUDE_DIR) - -set(VALGRIND_INCLUDE_DIRS ${VALGRIND_INCLUDE_DIR}) -set(VALGRIND_LIBRARIES "") diff --git a/cmake/README.txt b/cmake/README.txt deleted file mode 100644 index 59e6285d06..0000000000 --- a/cmake/README.txt +++ /dev/null @@ -1,7 +0,0 @@ -The following files are copied out of CMake 2.8. -- FindImageMagick.cmake - -I have also copied the Copyright.txt file out of cmake and renamed it: -- Copyright_cmake.txt - -All other files are created and/or maintained by either LunarG Inc or Valve Corporation. \ No newline at end of file From 1b73544be49a1a250623a401d544b54fd5c83bdb Mon Sep 17 00:00:00 2001 From: Juan Ramos Date: Tue, 22 Aug 2023 16:16:40 -0600 Subject: [PATCH 114/154] cmake: Cleanup Python Generation Code find_package(PythonInterp) is deprecated. Use find_package(Python3). Move codegen code to layersvt/CMakeLists.txt where it is actually used. Create a VULKAN_REGISTRY variable to reduce code duplication. Remove pointless cmake_minimum_required --- CMakeLists.txt | 34 ---------------------------------- layersvt/CMakeLists.txt | 23 +++++++++++++++++++++-- 2 files changed, 21 insertions(+), 36 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index ce0115073a..bda10d4634 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -16,22 +16,6 @@ set(Vulkan-ValidationLayers_INCLUDE_DIR "${VULKAN_VALIDATIONLAYERS_INSTALL_DIR}/ set(Vulkan-ValidationLayers_LIBRARY_DIR "${VULKAN_VALIDATIONLAYERS_INSTALL_DIR}/lib") find_library(VkLayer_utils_LIBRARY VkLayer_utils HINTS ${Vulkan-ValidationLayers_LIBRARY_DIR}) -# Check for python 3.6 or greater -# Cannot use find_package(PythonInterp 3.6 REQUIRED) because it isn't smart enough to ignore an older /usr/bin/python3 -# Cannot use FindPython3 because it isn't available in CMake 3.10 -# This will go away when we start committing the generated files to this repo -foreach(PYTHON_MIN_VERSION RANGE 6 20) - find_package(PythonInterp "3.${PYTHON_MIN_VERSION}" EXACT) - if(PythonInterp_FOUND) - set (PYTHON_CMD ${PYTHON_EXECUTABLE}) - break() - endif() - unset(PYTHON_EXECUTABLE CACHE) -endforeach(PYTHON_MIN_VERSION) -if(NOT PythonInterp_FOUND) - message(FATAL_ERROR "Could not find Python >= 3.6") -endif() - # Enable cmake folders set_property(GLOBAL PROPERTY USE_FOLDERS ON) set(VULKANTOOLS_TARGET_FOLDER vt_cmake_targets) @@ -66,8 +50,6 @@ elseif(CMAKE_SYSTEM_NAME STREQUAL "Darwin") option(BUILD_METAL_SUPPORT "Build Metal WSI support" OFF) endif() -set(VULKANTOOLS_SCRIPTS_DIR ${CMAKE_CURRENT_SOURCE_DIR}/scripts) - find_package(VulkanHeaders REQUIRED CONFIG) find_library(Vulkan_LIBRARY NAMES vulkan vulkan-1) @@ -104,22 +86,6 @@ elseif (CMAKE_SYSTEM_NAME STREQUAL "Darwin") endif() -# Define macro used for building vk.xml generated files -function(run_vulkantools_vk_xml_generate dependency output) - add_custom_command(OUTPUT ${output} - COMMAND ${PYTHON_CMD} -B ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py -registry ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry/vk.xml -scripts ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry ${output} - DEPENDS ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry/vk.xml ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry/generator.py ${VULKANTOOLS_SCRIPTS_DIR}/${dependency} ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry/reg.py - ) -endfunction() - -# Define macro used for building video.xml generated files -function(run_vulkantools_video_xml_generate dependency output) - add_custom_command(OUTPUT ${output} - COMMAND ${PYTHON_CMD} -B ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py -registry ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry/video.xml -scripts ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry ${output} - DEPENDS ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry/video.xml ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry/generator.py ${VULKANTOOLS_SCRIPTS_DIR}/${dependency} ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py ${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry/reg.py - ) -endfunction() - if(BUILD_TESTS) enable_testing() add_subdirectory(tests) diff --git a/layersvt/CMakeLists.txt b/layersvt/CMakeLists.txt index 131db4076c..03a9f839c2 100644 --- a/layersvt/CMakeLists.txt +++ b/layersvt/CMakeLists.txt @@ -1,5 +1,3 @@ -cmake_minimum_required(VERSION 3.10.2) - file(GLOB IMAGES "${PROJECT_SOURCE_DIR}/layersvt/images/*" ) @@ -127,6 +125,27 @@ else() set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wpointer-arith") endif() +find_package(Python3 REQUIRED) + +set(VULKANTOOLS_SCRIPTS_DIR "${VULKAN_TOOLS_SOURCE_DIR}/scripts") +set(VULKAN_REGISTRY "${VULKAN_HEADERS_INSTALL_DIR}/${CMAKE_INSTALL_DATADIR}/vulkan/registry") + +# Define macro used for building vk.xml generated files +function(run_vulkantools_vk_xml_generate dependency output) + add_custom_command(OUTPUT ${output} + COMMAND Python3::Interpreter -B ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py -registry ${VULKAN_REGISTRY}/vk.xml -scripts ${VULKAN_REGISTRY} ${output} + DEPENDS ${VULKAN_REGISTRY}/vk.xml ${VULKAN_REGISTRY}/generator.py ${VULKANTOOLS_SCRIPTS_DIR}/${dependency} ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py ${VULKAN_REGISTRY}/reg.py + ) +endfunction() + +# Define macro used for building video.xml generated files +function(run_vulkantools_video_xml_generate dependency output) + add_custom_command(OUTPUT ${output} + COMMAND Python3::Interpreter -B ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py -registry ${VULKAN_REGISTRY}/video.xml -scripts ${VULKAN_REGISTRY} ${output} + DEPENDS ${VULKAN_REGISTRY}/video.xml ${VULKAN_REGISTRY}/generator.py ${VULKANTOOLS_SCRIPTS_DIR}/${dependency} ${VULKANTOOLS_SCRIPTS_DIR}/vt_genvk.py ${VULKAN_REGISTRY}/reg.py + ) +endfunction() + #VulkanTools layers if(BUILD_APIDUMP) run_vulkantools_vk_xml_generate(api_dump_generator.py api_dump.cpp) From 71313a8474d96b1db6a71572569e673b7879ee52 Mon Sep 17 00:00:00 2001 From: Juan Ramos Date: Wed, 23 Aug 2023 15:49:48 -0600 Subject: [PATCH 115/154] cmake: Remove excess cmake_minimum_required / project usage --- vkconfig/CMakeLists.txt | 3 --- vkconfig_core/CMakeLists.txt | 3 --- 2 files changed, 6 deletions(-) diff --git a/vkconfig/CMakeLists.txt b/vkconfig/CMakeLists.txt index e7f367e66a..9bde6350ce 100644 --- a/vkconfig/CMakeLists.txt +++ b/vkconfig/CMakeLists.txt @@ -1,6 +1,3 @@ -cmake_minimum_required(VERSION 3.10.2) -project(vkconfig) - set(CMAKE_CXX_STANDARD 11) set(CMAKE_INCLUDE_CURRENT_DIR ON) set(CMAKE_AUTOMOC ON) diff --git a/vkconfig_core/CMakeLists.txt b/vkconfig_core/CMakeLists.txt index b091fe3f72..7bfcbf23d0 100644 --- a/vkconfig_core/CMakeLists.txt +++ b/vkconfig_core/CMakeLists.txt @@ -1,6 +1,3 @@ -cmake_minimum_required(VERSION 3.10.2) -project(vkconfig) - set(CMAKE_CXX_STANDARD 11) set(CMAKE_INCLUDE_CURRENT_DIR ON) find_package(Qt5 COMPONENTS Core Gui Widgets Network QUIET) From 5a427eac233f5baf7686939aea902c56ff56e507 Mon Sep 17 00:00:00 2001 From: Juan Ramos Date: Wed, 23 Aug 2023 16:54:15 -0600 Subject: [PATCH 116/154] Remove external/googletest --- external/googletest/.clang-format | 4 - .../.github/ISSUE_TEMPLATE/00-bug_report.md | 43 - .../ISSUE_TEMPLATE/10-feature_request.md | 24 - .../.github/ISSUE_TEMPLATE/config.yml | 1 - external/googletest/.gitignore | 84 - external/googletest/BUILD.bazel | 190 - external/googletest/CMakeLists.txt | 32 - external/googletest/CONTRIBUTING.md | 130 - external/googletest/CONTRIBUTORS | 63 - external/googletest/LICENSE | 28 - external/googletest/README.md | 140 - external/googletest/WORKSPACE | 24 - external/googletest/ci/linux-presubmit.sh | 126 - external/googletest/ci/macos-presubmit.sh | 73 - external/googletest/docs/_config.yml | 1 - external/googletest/docs/_data/navigation.yml | 43 - .../googletest/docs/_layouts/default.html | 58 - external/googletest/docs/_sass/main.scss | 200 - external/googletest/docs/advanced.md | 2318 ----- .../googletest/docs/assets/css/style.scss | 5 - .../docs/community_created_documentation.md | 7 - external/googletest/docs/faq.md | 693 -- external/googletest/docs/gmock_cheat_sheet.md | 241 - external/googletest/docs/gmock_cook_book.md | 4301 --------- external/googletest/docs/gmock_faq.md | 390 - external/googletest/docs/gmock_for_dummies.md | 700 -- external/googletest/docs/index.md | 22 - external/googletest/docs/pkgconfig.md | 148 - external/googletest/docs/platforms.md | 35 - external/googletest/docs/primer.md | 482 - external/googletest/docs/quickstart-bazel.md | 161 - external/googletest/docs/quickstart-cmake.md | 156 - external/googletest/docs/reference/actions.md | 115 - .../googletest/docs/reference/assertions.md | 633 -- .../googletest/docs/reference/matchers.md | 283 - external/googletest/docs/reference/mocking.md | 587 -- external/googletest/docs/reference/testing.md | 1431 --- external/googletest/docs/samples.md | 22 - external/googletest/googlemock/CMakeLists.txt | 218 - external/googletest/googlemock/README.md | 44 - .../googletest/googlemock/cmake/gmock.pc.in | 10 - .../googlemock/cmake/gmock_main.pc.in | 10 - external/googletest/googlemock/docs/README.md | 4 - .../googlemock/include/gmock/gmock-actions.h | 1690 ---- .../include/gmock/gmock-cardinalities.h | 158 - .../include/gmock/gmock-function-mocker.h | 478 - .../googlemock/include/gmock/gmock-matchers.h | 5367 ----------- .../include/gmock/gmock-more-actions.h | 660 -- .../include/gmock/gmock-more-matchers.h | 90 - .../include/gmock/gmock-nice-strict.h | 260 - .../include/gmock/gmock-spec-builders.h | 2005 ---- .../googlemock/include/gmock/gmock.h | 97 - .../include/gmock/internal/custom/README.md | 16 - .../internal/custom/gmock-generated-actions.h | 6 - .../gmock/internal/custom/gmock-matchers.h | 36 - .../gmock/internal/custom/gmock-port.h | 39 - .../gmock/internal/gmock-internal-utils.h | 460 - .../include/gmock/internal/gmock-port.h | 88 - .../include/gmock/internal/gmock-pp.h | 279 - .../googletest/googlemock/scripts/README.md | 5 - .../googlemock/scripts/fuse_gmock_files.py | 256 - .../googlemock/scripts/generator/LICENSE | 203 - .../googlemock/scripts/generator/README | 34 - .../scripts/generator/README.cppclean | 115 - .../scripts/generator/cpp/__init__.py | 0 .../googlemock/scripts/generator/cpp/ast.py | 1773 ---- .../scripts/generator/cpp/gmock_class.py | 247 - .../scripts/generator/cpp/gmock_class_test.py | 570 -- .../scripts/generator/cpp/keywords.py | 56 - .../scripts/generator/cpp/tokenize.py | 284 - .../googlemock/scripts/generator/cpp/utils.py | 37 - .../googlemock/scripts/generator/gmock_gen.py | 30 - .../googletest/googlemock/src/gmock-all.cc | 46 - .../googlemock/src/gmock-cardinalities.cc | 155 - .../googlemock/src/gmock-internal-utils.cc | 200 - .../googlemock/src/gmock-matchers.cc | 459 - .../googlemock/src/gmock-spec-builders.cc | 903 -- external/googletest/googlemock/src/gmock.cc | 212 - .../googletest/googlemock/src/gmock_main.cc | 72 - .../googletest/googlemock/test/BUILD.bazel | 118 - .../googlemock/test/gmock-actions_test.cc | 1561 --- .../test/gmock-cardinalities_test.cc | 429 - .../test/gmock-function-mocker_test.cc | 967 -- .../test/gmock-internal-utils_test.cc | 719 -- .../googlemock/test/gmock-matchers_test.cc | 8498 ----------------- .../test/gmock-more-actions_test.cc | 1544 --- .../googlemock/test/gmock-nice-strict_test.cc | 539 -- .../googlemock/test/gmock-port_test.cc | 42 - .../googlemock/test/gmock-pp-string_test.cc | 206 - .../googlemock/test/gmock-pp_test.cc | 83 - .../test/gmock-spec-builders_test.cc | 2607 ----- .../googlemock/test/gmock_all_test.cc | 46 - .../googlemock/test/gmock_ex_test.cc | 80 - .../googlemock/test/gmock_leak_test.py | 104 - .../googlemock/test/gmock_leak_test_.cc | 99 - .../googlemock/test/gmock_link2_test.cc | 39 - .../googlemock/test/gmock_link_test.cc | 39 - .../googlemock/test/gmock_link_test.h | 688 -- .../googlemock/test/gmock_output_test.py | 183 - .../googlemock/test/gmock_output_test_.cc | 309 - .../test/gmock_output_test_golden.txt | 317 - .../googlemock/test/gmock_stress_test.cc | 240 - .../googletest/googlemock/test/gmock_test.cc | 181 - .../googlemock/test/gmock_test_utils.py | 108 - external/googletest/googletest/CMakeLists.txt | 323 - external/googletest/googletest/README.md | 215 - .../googletest/cmake/Config.cmake.in | 9 - .../googletest/googletest/cmake/gtest.pc.in | 9 - .../googletest/cmake/gtest_main.pc.in | 10 - .../googletest/cmake/internal_utils.cmake | 344 - .../googletest/cmake/libgtest.la.in | 21 - external/googletest/googletest/docs/README.md | 4 - .../include/gtest/gtest-death-test.h | 345 - .../googletest/include/gtest/gtest-matchers.h | 947 -- .../googletest/include/gtest/gtest-message.h | 217 - .../include/gtest/gtest-param-test.h | 504 - .../googletest/include/gtest/gtest-printers.h | 1026 -- .../googletest/include/gtest/gtest-spi.h | 245 - .../include/gtest/gtest-test-part.h | 186 - .../include/gtest/gtest-typed-test.h | 329 - .../googletest/include/gtest/gtest.h | 2467 ----- .../include/gtest/gtest_pred_impl.h | 277 - .../googletest/include/gtest/gtest_prod.h | 61 - .../include/gtest/internal/custom/README.md | 56 - .../gtest/internal/custom/gtest-port.h | 37 - .../gtest/internal/custom/gtest-printers.h | 42 - .../include/gtest/internal/custom/gtest.h | 37 - .../internal/gtest-death-test-internal.h | 302 - .../include/gtest/internal/gtest-filepath.h | 208 - .../include/gtest/internal/gtest-internal.h | 1568 --- .../include/gtest/internal/gtest-param-util.h | 944 -- .../include/gtest/internal/gtest-port-arch.h | 114 - .../include/gtest/internal/gtest-port.h | 2370 ----- .../include/gtest/internal/gtest-string.h | 175 - .../include/gtest/internal/gtest-type-util.h | 184 - .../googletest/samples/prime_tables.h | 124 - .../googletest/googletest/samples/sample1.cc | 66 - .../googletest/googletest/samples/sample1.h | 41 - .../googletest/samples/sample10_unittest.cc | 139 - .../googletest/samples/sample1_unittest.cc | 151 - .../googletest/googletest/samples/sample2.cc | 54 - .../googletest/googletest/samples/sample2.h | 79 - .../googletest/samples/sample2_unittest.cc | 107 - .../googletest/samples/sample3-inl.h | 171 - .../googletest/samples/sample3_unittest.cc | 149 - .../googletest/googletest/samples/sample4.cc | 54 - .../googletest/googletest/samples/sample4.h | 53 - .../googletest/samples/sample4_unittest.cc | 53 - .../googletest/samples/sample5_unittest.cc | 196 - .../googletest/samples/sample6_unittest.cc | 214 - .../googletest/samples/sample7_unittest.cc | 117 - .../googletest/samples/sample8_unittest.cc | 154 - .../googletest/samples/sample9_unittest.cc | 156 - .../googletest/googletest/scripts/README.md | 5 - .../googletest/googletest/scripts/common.py | 83 - .../googletest/scripts/fuse_gtest_files.py | 253 - .../googletest/scripts/gen_gtest_pred_impl.py | 733 -- .../googletest/scripts/gtest-config.in | 274 - .../googletest/scripts/release_docs.py | 158 - .../googletest/scripts/run_with_path.py | 32 - .../googletest/scripts/test/Makefile | 59 - .../googletest/googletest/scripts/upload.py | 1402 --- .../googletest/scripts/upload_gtest.py | 78 - .../googletest/googletest/src/gtest-all.cc | 48 - .../googletest/src/gtest-death-test.cc | 1619 ---- .../googletest/src/gtest-filepath.cc | 367 - .../googletest/src/gtest-internal-inl.h | 1216 --- .../googletest/src/gtest-matchers.cc | 98 - .../googletest/googletest/src/gtest-port.cc | 1408 --- .../googletest/src/gtest-printers.cc | 508 - .../googletest/src/gtest-test-part.cc | 107 - .../googletest/src/gtest-typed-test.cc | 104 - external/googletest/googletest/src/gtest.cc | 6654 ------------- .../googletest/googletest/src/gtest_main.cc | 53 - .../googletest/googletest/test/BUILD.bazel | 590 -- .../googletest-break-on-failure-unittest.py | 208 - .../googletest-break-on-failure-unittest_.cc | 86 - .../test/googletest-catch-exceptions-test.py | 236 - .../test/googletest-catch-exceptions-test_.cc | 293 - .../googletest/test/googletest-color-test.py | 127 - .../googletest/test/googletest-color-test_.cc | 62 - .../test/googletest-death-test-test.cc | 1542 --- .../test/googletest-death-test_ex_test.cc | 91 - .../test/googletest-env-var-test.py | 120 - .../test/googletest-env-var-test_.cc | 130 - .../test/googletest-failfast-unittest.py | 410 - .../test/googletest-failfast-unittest_.cc | 166 - .../test/googletest-filepath-test.cc | 649 -- .../test/googletest-filter-unittest.py | 639 -- .../test/googletest-filter-unittest_.cc | 137 - .../googletest-global-environment-unittest.py | 72 - ...googletest-global-environment-unittest_.cc | 58 - .../test/googletest-json-outfiles-test.py | 191 - .../test/googletest-json-output-unittest.py | 848 -- .../test/googletest-list-tests-unittest.py | 205 - .../test/googletest-list-tests-unittest_.cc | 156 - .../test/googletest-listener-test.cc | 518 - .../test/googletest-message-test.cc | 158 - .../test/googletest-options-test.cc | 220 - .../googletest-output-test-golden-lin.txt | 1180 --- .../googletest/test/googletest-output-test.py | 346 - .../test/googletest-output-test_.cc | 1047 -- ...oogletest-param-test-invalid-name1-test.py | 63 - ...ogletest-param-test-invalid-name1-test_.cc | 50 - ...oogletest-param-test-invalid-name2-test.py | 62 - ...ogletest-param-test-invalid-name2-test_.cc | 55 - .../test/googletest-param-test-test.cc | 1110 --- .../test/googletest-param-test-test.h | 49 - .../test/googletest-param-test2-test.cc | 61 - .../googletest/test/googletest-port-test.cc | 1271 --- .../test/googletest-printers-test.cc | 1927 ---- .../test/googletest-setuptestsuite-test.py | 54 - .../test/googletest-setuptestsuite-test_.cc | 44 - .../test/googletest-shuffle-test.py | 323 - .../test/googletest-shuffle-test_.cc | 100 - .../test/googletest-test-part-test.cc | 230 - .../test/googletest-throw-on-failure-test.py | 168 - .../test/googletest-throw-on-failure-test_.cc | 71 - .../test/googletest-uninitialized-test.py | 67 - .../test/googletest-uninitialized-test_.cc | 42 - .../googletest/test/gtest-typed-test2_test.cc | 39 - .../googletest/test/gtest-typed-test_test.cc | 422 - .../googletest/test/gtest-typed-test_test.h | 57 - .../test/gtest-unittest-api_test.cc | 328 - .../googletest/test/gtest_all_test.cc | 46 - .../test/gtest_assert_by_exception_test.cc | 116 - .../googletest/test/gtest_environment_test.cc | 188 - .../googletest/test/gtest_help_test.py | 172 - .../googletest/test/gtest_help_test_.cc | 45 - .../googletest/test/gtest_json_test_utils.py | 60 - .../test/gtest_list_output_unittest.py | 286 - .../test/gtest_list_output_unittest_.cc | 77 - .../googletest/test/gtest_main_unittest.cc | 44 - .../googletest/test/gtest_no_test_unittest.cc | 54 - .../test/gtest_pred_impl_unittest.cc | 2072 ---- .../test/gtest_premature_exit_test.cc | 126 - .../googletest/test/gtest_prod_test.cc | 56 - .../googletest/test/gtest_repeat_test.cc | 233 - .../test/gtest_skip_check_output_test.py | 59 - ...test_skip_environment_check_output_test.py | 54 - .../gtest_skip_in_environment_setup_test.cc | 49 - .../googletest/test/gtest_skip_test.cc | 51 - .../googletest/test/gtest_sole_header_test.cc | 56 - .../googletest/test/gtest_stress_test.cc | 248 - .../gtest_test_macro_stack_footprint_test.cc | 89 - .../googletest/test/gtest_test_utils.py | 312 - .../googletest/test/gtest_testbridge_test.py | 63 - .../googletest/test/gtest_testbridge_test_.cc | 43 - .../test/gtest_throw_on_failure_ex_test.cc | 90 - .../googletest/test/gtest_unittest.cc | 7654 --------------- .../test/gtest_xml_outfile1_test_.cc | 43 - .../test/gtest_xml_outfile2_test_.cc | 43 - .../test/gtest_xml_outfiles_test.py | 135 - .../test/gtest_xml_output_unittest.py | 415 - .../test/gtest_xml_output_unittest_.cc | 182 - .../googletest/test/gtest_xml_test_utils.py | 197 - .../googletest/googletest/test/production.cc | 35 - .../googletest/googletest/test/production.h | 55 - external/googletest/library.json | 62 - 259 files changed, 112913 deletions(-) delete mode 100644 external/googletest/.clang-format delete mode 100644 external/googletest/.github/ISSUE_TEMPLATE/00-bug_report.md delete mode 100644 external/googletest/.github/ISSUE_TEMPLATE/10-feature_request.md delete mode 100644 external/googletest/.github/ISSUE_TEMPLATE/config.yml delete mode 100644 external/googletest/.gitignore delete mode 100644 external/googletest/BUILD.bazel delete mode 100644 external/googletest/CMakeLists.txt delete mode 100644 external/googletest/CONTRIBUTING.md delete mode 100644 external/googletest/CONTRIBUTORS delete mode 100644 external/googletest/LICENSE delete mode 100644 external/googletest/README.md delete mode 100644 external/googletest/WORKSPACE delete mode 100644 external/googletest/ci/linux-presubmit.sh delete mode 100644 external/googletest/ci/macos-presubmit.sh delete mode 100644 external/googletest/docs/_config.yml delete mode 100644 external/googletest/docs/_data/navigation.yml delete mode 100644 external/googletest/docs/_layouts/default.html delete mode 100644 external/googletest/docs/_sass/main.scss delete mode 100644 external/googletest/docs/advanced.md delete mode 100644 external/googletest/docs/assets/css/style.scss delete mode 100644 external/googletest/docs/community_created_documentation.md delete mode 100644 external/googletest/docs/faq.md delete mode 100644 external/googletest/docs/gmock_cheat_sheet.md delete mode 100644 external/googletest/docs/gmock_cook_book.md delete mode 100644 external/googletest/docs/gmock_faq.md delete mode 100644 external/googletest/docs/gmock_for_dummies.md delete mode 100644 external/googletest/docs/index.md delete mode 100644 external/googletest/docs/pkgconfig.md delete mode 100644 external/googletest/docs/platforms.md delete mode 100644 external/googletest/docs/primer.md delete mode 100644 external/googletest/docs/quickstart-bazel.md delete mode 100644 external/googletest/docs/quickstart-cmake.md delete mode 100644 external/googletest/docs/reference/actions.md delete mode 100644 external/googletest/docs/reference/assertions.md delete mode 100644 external/googletest/docs/reference/matchers.md delete mode 100644 external/googletest/docs/reference/mocking.md delete mode 100644 external/googletest/docs/reference/testing.md delete mode 100644 external/googletest/docs/samples.md delete mode 100644 external/googletest/googlemock/CMakeLists.txt delete mode 100644 external/googletest/googlemock/README.md delete mode 100644 external/googletest/googlemock/cmake/gmock.pc.in delete mode 100644 external/googletest/googlemock/cmake/gmock_main.pc.in delete mode 100644 external/googletest/googlemock/docs/README.md delete mode 100644 external/googletest/googlemock/include/gmock/gmock-actions.h delete mode 100644 external/googletest/googlemock/include/gmock/gmock-cardinalities.h delete mode 100644 external/googletest/googlemock/include/gmock/gmock-function-mocker.h delete mode 100644 external/googletest/googlemock/include/gmock/gmock-matchers.h delete mode 100644 external/googletest/googlemock/include/gmock/gmock-more-actions.h delete mode 100644 external/googletest/googlemock/include/gmock/gmock-more-matchers.h delete mode 100644 external/googletest/googlemock/include/gmock/gmock-nice-strict.h delete mode 100644 external/googletest/googlemock/include/gmock/gmock-spec-builders.h delete mode 100644 external/googletest/googlemock/include/gmock/gmock.h delete mode 100644 external/googletest/googlemock/include/gmock/internal/custom/README.md delete mode 100644 external/googletest/googlemock/include/gmock/internal/custom/gmock-generated-actions.h delete mode 100644 external/googletest/googlemock/include/gmock/internal/custom/gmock-matchers.h delete mode 100644 external/googletest/googlemock/include/gmock/internal/custom/gmock-port.h delete mode 100644 external/googletest/googlemock/include/gmock/internal/gmock-internal-utils.h delete mode 100644 external/googletest/googlemock/include/gmock/internal/gmock-port.h delete mode 100644 external/googletest/googlemock/include/gmock/internal/gmock-pp.h delete mode 100644 external/googletest/googlemock/scripts/README.md delete mode 100644 external/googletest/googlemock/scripts/fuse_gmock_files.py delete mode 100644 external/googletest/googlemock/scripts/generator/LICENSE delete mode 100644 external/googletest/googlemock/scripts/generator/README delete mode 100644 external/googletest/googlemock/scripts/generator/README.cppclean delete mode 100644 external/googletest/googlemock/scripts/generator/cpp/__init__.py delete mode 100644 external/googletest/googlemock/scripts/generator/cpp/ast.py delete mode 100644 external/googletest/googlemock/scripts/generator/cpp/gmock_class.py delete mode 100644 external/googletest/googlemock/scripts/generator/cpp/gmock_class_test.py delete mode 100644 external/googletest/googlemock/scripts/generator/cpp/keywords.py delete mode 100644 external/googletest/googlemock/scripts/generator/cpp/tokenize.py delete mode 100644 external/googletest/googlemock/scripts/generator/cpp/utils.py delete mode 100644 external/googletest/googlemock/scripts/generator/gmock_gen.py delete mode 100644 external/googletest/googlemock/src/gmock-all.cc delete mode 100644 external/googletest/googlemock/src/gmock-cardinalities.cc delete mode 100644 external/googletest/googlemock/src/gmock-internal-utils.cc delete mode 100644 external/googletest/googlemock/src/gmock-matchers.cc delete mode 100644 external/googletest/googlemock/src/gmock-spec-builders.cc delete mode 100644 external/googletest/googlemock/src/gmock.cc delete mode 100644 external/googletest/googlemock/src/gmock_main.cc delete mode 100644 external/googletest/googlemock/test/BUILD.bazel delete mode 100644 external/googletest/googlemock/test/gmock-actions_test.cc delete mode 100644 external/googletest/googlemock/test/gmock-cardinalities_test.cc delete mode 100644 external/googletest/googlemock/test/gmock-function-mocker_test.cc delete mode 100644 external/googletest/googlemock/test/gmock-internal-utils_test.cc delete mode 100644 external/googletest/googlemock/test/gmock-matchers_test.cc delete mode 100644 external/googletest/googlemock/test/gmock-more-actions_test.cc delete mode 100644 external/googletest/googlemock/test/gmock-nice-strict_test.cc delete mode 100644 external/googletest/googlemock/test/gmock-port_test.cc delete mode 100644 external/googletest/googlemock/test/gmock-pp-string_test.cc delete mode 100644 external/googletest/googlemock/test/gmock-pp_test.cc delete mode 100644 external/googletest/googlemock/test/gmock-spec-builders_test.cc delete mode 100644 external/googletest/googlemock/test/gmock_all_test.cc delete mode 100644 external/googletest/googlemock/test/gmock_ex_test.cc delete mode 100644 external/googletest/googlemock/test/gmock_leak_test.py delete mode 100644 external/googletest/googlemock/test/gmock_leak_test_.cc delete mode 100644 external/googletest/googlemock/test/gmock_link2_test.cc delete mode 100644 external/googletest/googlemock/test/gmock_link_test.cc delete mode 100644 external/googletest/googlemock/test/gmock_link_test.h delete mode 100644 external/googletest/googlemock/test/gmock_output_test.py delete mode 100644 external/googletest/googlemock/test/gmock_output_test_.cc delete mode 100644 external/googletest/googlemock/test/gmock_output_test_golden.txt delete mode 100644 external/googletest/googlemock/test/gmock_stress_test.cc delete mode 100644 external/googletest/googlemock/test/gmock_test.cc delete mode 100644 external/googletest/googlemock/test/gmock_test_utils.py delete mode 100644 external/googletest/googletest/CMakeLists.txt delete mode 100644 external/googletest/googletest/README.md delete mode 100644 external/googletest/googletest/cmake/Config.cmake.in delete mode 100644 external/googletest/googletest/cmake/gtest.pc.in delete mode 100644 external/googletest/googletest/cmake/gtest_main.pc.in delete mode 100644 external/googletest/googletest/cmake/internal_utils.cmake delete mode 100644 external/googletest/googletest/cmake/libgtest.la.in delete mode 100644 external/googletest/googletest/docs/README.md delete mode 100644 external/googletest/googletest/include/gtest/gtest-death-test.h delete mode 100644 external/googletest/googletest/include/gtest/gtest-matchers.h delete mode 100644 external/googletest/googletest/include/gtest/gtest-message.h delete mode 100644 external/googletest/googletest/include/gtest/gtest-param-test.h delete mode 100644 external/googletest/googletest/include/gtest/gtest-printers.h delete mode 100644 external/googletest/googletest/include/gtest/gtest-spi.h delete mode 100644 external/googletest/googletest/include/gtest/gtest-test-part.h delete mode 100644 external/googletest/googletest/include/gtest/gtest-typed-test.h delete mode 100644 external/googletest/googletest/include/gtest/gtest.h delete mode 100644 external/googletest/googletest/include/gtest/gtest_pred_impl.h delete mode 100644 external/googletest/googletest/include/gtest/gtest_prod.h delete mode 100644 external/googletest/googletest/include/gtest/internal/custom/README.md delete mode 100644 external/googletest/googletest/include/gtest/internal/custom/gtest-port.h delete mode 100644 external/googletest/googletest/include/gtest/internal/custom/gtest-printers.h delete mode 100644 external/googletest/googletest/include/gtest/internal/custom/gtest.h delete mode 100644 external/googletest/googletest/include/gtest/internal/gtest-death-test-internal.h delete mode 100644 external/googletest/googletest/include/gtest/internal/gtest-filepath.h delete mode 100644 external/googletest/googletest/include/gtest/internal/gtest-internal.h delete mode 100644 external/googletest/googletest/include/gtest/internal/gtest-param-util.h delete mode 100644 external/googletest/googletest/include/gtest/internal/gtest-port-arch.h delete mode 100644 external/googletest/googletest/include/gtest/internal/gtest-port.h delete mode 100644 external/googletest/googletest/include/gtest/internal/gtest-string.h delete mode 100644 external/googletest/googletest/include/gtest/internal/gtest-type-util.h delete mode 100644 external/googletest/googletest/samples/prime_tables.h delete mode 100644 external/googletest/googletest/samples/sample1.cc delete mode 100644 external/googletest/googletest/samples/sample1.h delete mode 100644 external/googletest/googletest/samples/sample10_unittest.cc delete mode 100644 external/googletest/googletest/samples/sample1_unittest.cc delete mode 100644 external/googletest/googletest/samples/sample2.cc delete mode 100644 external/googletest/googletest/samples/sample2.h delete mode 100644 external/googletest/googletest/samples/sample2_unittest.cc delete mode 100644 external/googletest/googletest/samples/sample3-inl.h delete mode 100644 external/googletest/googletest/samples/sample3_unittest.cc delete mode 100644 external/googletest/googletest/samples/sample4.cc delete mode 100644 external/googletest/googletest/samples/sample4.h delete mode 100644 external/googletest/googletest/samples/sample4_unittest.cc delete mode 100644 external/googletest/googletest/samples/sample5_unittest.cc delete mode 100644 external/googletest/googletest/samples/sample6_unittest.cc delete mode 100644 external/googletest/googletest/samples/sample7_unittest.cc delete mode 100644 external/googletest/googletest/samples/sample8_unittest.cc delete mode 100644 external/googletest/googletest/samples/sample9_unittest.cc delete mode 100644 external/googletest/googletest/scripts/README.md delete mode 100644 external/googletest/googletest/scripts/common.py delete mode 100644 external/googletest/googletest/scripts/fuse_gtest_files.py delete mode 100644 external/googletest/googletest/scripts/gen_gtest_pred_impl.py delete mode 100644 external/googletest/googletest/scripts/gtest-config.in delete mode 100644 external/googletest/googletest/scripts/release_docs.py delete mode 100644 external/googletest/googletest/scripts/run_with_path.py delete mode 100644 external/googletest/googletest/scripts/test/Makefile delete mode 100644 external/googletest/googletest/scripts/upload.py delete mode 100644 external/googletest/googletest/scripts/upload_gtest.py delete mode 100644 external/googletest/googletest/src/gtest-all.cc delete mode 100644 external/googletest/googletest/src/gtest-death-test.cc delete mode 100644 external/googletest/googletest/src/gtest-filepath.cc delete mode 100644 external/googletest/googletest/src/gtest-internal-inl.h delete mode 100644 external/googletest/googletest/src/gtest-matchers.cc delete mode 100644 external/googletest/googletest/src/gtest-port.cc delete mode 100644 external/googletest/googletest/src/gtest-printers.cc delete mode 100644 external/googletest/googletest/src/gtest-test-part.cc delete mode 100644 external/googletest/googletest/src/gtest-typed-test.cc delete mode 100644 external/googletest/googletest/src/gtest.cc delete mode 100644 external/googletest/googletest/src/gtest_main.cc delete mode 100644 external/googletest/googletest/test/BUILD.bazel delete mode 100644 external/googletest/googletest/test/googletest-break-on-failure-unittest.py delete mode 100644 external/googletest/googletest/test/googletest-break-on-failure-unittest_.cc delete mode 100644 external/googletest/googletest/test/googletest-catch-exceptions-test.py delete mode 100644 external/googletest/googletest/test/googletest-catch-exceptions-test_.cc delete mode 100644 external/googletest/googletest/test/googletest-color-test.py delete mode 100644 external/googletest/googletest/test/googletest-color-test_.cc delete mode 100644 external/googletest/googletest/test/googletest-death-test-test.cc delete mode 100644 external/googletest/googletest/test/googletest-death-test_ex_test.cc delete mode 100644 external/googletest/googletest/test/googletest-env-var-test.py delete mode 100644 external/googletest/googletest/test/googletest-env-var-test_.cc delete mode 100644 external/googletest/googletest/test/googletest-failfast-unittest.py delete mode 100644 external/googletest/googletest/test/googletest-failfast-unittest_.cc delete mode 100644 external/googletest/googletest/test/googletest-filepath-test.cc delete mode 100644 external/googletest/googletest/test/googletest-filter-unittest.py delete mode 100644 external/googletest/googletest/test/googletest-filter-unittest_.cc delete mode 100644 external/googletest/googletest/test/googletest-global-environment-unittest.py delete mode 100644 external/googletest/googletest/test/googletest-global-environment-unittest_.cc delete mode 100644 external/googletest/googletest/test/googletest-json-outfiles-test.py delete mode 100644 external/googletest/googletest/test/googletest-json-output-unittest.py delete mode 100644 external/googletest/googletest/test/googletest-list-tests-unittest.py delete mode 100644 external/googletest/googletest/test/googletest-list-tests-unittest_.cc delete mode 100644 external/googletest/googletest/test/googletest-listener-test.cc delete mode 100644 external/googletest/googletest/test/googletest-message-test.cc delete mode 100644 external/googletest/googletest/test/googletest-options-test.cc delete mode 100644 external/googletest/googletest/test/googletest-output-test-golden-lin.txt delete mode 100644 external/googletest/googletest/test/googletest-output-test.py delete mode 100644 external/googletest/googletest/test/googletest-output-test_.cc delete mode 100644 external/googletest/googletest/test/googletest-param-test-invalid-name1-test.py delete mode 100644 external/googletest/googletest/test/googletest-param-test-invalid-name1-test_.cc delete mode 100644 external/googletest/googletest/test/googletest-param-test-invalid-name2-test.py delete mode 100644 external/googletest/googletest/test/googletest-param-test-invalid-name2-test_.cc delete mode 100644 external/googletest/googletest/test/googletest-param-test-test.cc delete mode 100644 external/googletest/googletest/test/googletest-param-test-test.h delete mode 100644 external/googletest/googletest/test/googletest-param-test2-test.cc delete mode 100644 external/googletest/googletest/test/googletest-port-test.cc delete mode 100644 external/googletest/googletest/test/googletest-printers-test.cc delete mode 100644 external/googletest/googletest/test/googletest-setuptestsuite-test.py delete mode 100644 external/googletest/googletest/test/googletest-setuptestsuite-test_.cc delete mode 100644 external/googletest/googletest/test/googletest-shuffle-test.py delete mode 100644 external/googletest/googletest/test/googletest-shuffle-test_.cc delete mode 100644 external/googletest/googletest/test/googletest-test-part-test.cc delete mode 100644 external/googletest/googletest/test/googletest-throw-on-failure-test.py delete mode 100644 external/googletest/googletest/test/googletest-throw-on-failure-test_.cc delete mode 100644 external/googletest/googletest/test/googletest-uninitialized-test.py delete mode 100644 external/googletest/googletest/test/googletest-uninitialized-test_.cc delete mode 100644 external/googletest/googletest/test/gtest-typed-test2_test.cc delete mode 100644 external/googletest/googletest/test/gtest-typed-test_test.cc delete mode 100644 external/googletest/googletest/test/gtest-typed-test_test.h delete mode 100644 external/googletest/googletest/test/gtest-unittest-api_test.cc delete mode 100644 external/googletest/googletest/test/gtest_all_test.cc delete mode 100644 external/googletest/googletest/test/gtest_assert_by_exception_test.cc delete mode 100644 external/googletest/googletest/test/gtest_environment_test.cc delete mode 100644 external/googletest/googletest/test/gtest_help_test.py delete mode 100644 external/googletest/googletest/test/gtest_help_test_.cc delete mode 100644 external/googletest/googletest/test/gtest_json_test_utils.py delete mode 100644 external/googletest/googletest/test/gtest_list_output_unittest.py delete mode 100644 external/googletest/googletest/test/gtest_list_output_unittest_.cc delete mode 100644 external/googletest/googletest/test/gtest_main_unittest.cc delete mode 100644 external/googletest/googletest/test/gtest_no_test_unittest.cc delete mode 100644 external/googletest/googletest/test/gtest_pred_impl_unittest.cc delete mode 100644 external/googletest/googletest/test/gtest_premature_exit_test.cc delete mode 100644 external/googletest/googletest/test/gtest_prod_test.cc delete mode 100644 external/googletest/googletest/test/gtest_repeat_test.cc delete mode 100644 external/googletest/googletest/test/gtest_skip_check_output_test.py delete mode 100644 external/googletest/googletest/test/gtest_skip_environment_check_output_test.py delete mode 100644 external/googletest/googletest/test/gtest_skip_in_environment_setup_test.cc delete mode 100644 external/googletest/googletest/test/gtest_skip_test.cc delete mode 100644 external/googletest/googletest/test/gtest_sole_header_test.cc delete mode 100644 external/googletest/googletest/test/gtest_stress_test.cc delete mode 100644 external/googletest/googletest/test/gtest_test_macro_stack_footprint_test.cc delete mode 100644 external/googletest/googletest/test/gtest_test_utils.py delete mode 100644 external/googletest/googletest/test/gtest_testbridge_test.py delete mode 100644 external/googletest/googletest/test/gtest_testbridge_test_.cc delete mode 100644 external/googletest/googletest/test/gtest_throw_on_failure_ex_test.cc delete mode 100644 external/googletest/googletest/test/gtest_unittest.cc delete mode 100644 external/googletest/googletest/test/gtest_xml_outfile1_test_.cc delete mode 100644 external/googletest/googletest/test/gtest_xml_outfile2_test_.cc delete mode 100644 external/googletest/googletest/test/gtest_xml_outfiles_test.py delete mode 100644 external/googletest/googletest/test/gtest_xml_output_unittest.py delete mode 100644 external/googletest/googletest/test/gtest_xml_output_unittest_.cc delete mode 100644 external/googletest/googletest/test/gtest_xml_test_utils.py delete mode 100644 external/googletest/googletest/test/production.cc delete mode 100644 external/googletest/googletest/test/production.h delete mode 100644 external/googletest/library.json diff --git a/external/googletest/.clang-format b/external/googletest/.clang-format deleted file mode 100644 index 5b9bfe6d22..0000000000 --- a/external/googletest/.clang-format +++ /dev/null @@ -1,4 +0,0 @@ -# Run manually to reformat a file: -# clang-format -i --style=file -Language: Cpp -BasedOnStyle: Google diff --git a/external/googletest/.github/ISSUE_TEMPLATE/00-bug_report.md b/external/googletest/.github/ISSUE_TEMPLATE/00-bug_report.md deleted file mode 100644 index 0f7e8b532f..0000000000 --- a/external/googletest/.github/ISSUE_TEMPLATE/00-bug_report.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: 'bug' -assignees: '' ---- - -**Describe the bug** - -Include a clear and concise description of what the problem is, including what -you expected to happen, and what actually happened. - -**Steps to reproduce the bug** - -It's important that we are able to reproduce the problem that you are -experiencing. Please provide all code and relevant steps to reproduce the -problem, including your `BUILD`/`CMakeLists.txt` file and build commands. Links -to a GitHub branch or [godbolt.org](https://godbolt.org/) that demonstrate the -problem are also helpful. - -**Does the bug persist in the most recent commit?** - -We recommend using the latest commit in the master branch in your projects. - -**What operating system and version are you using?** - -If you are using a Linux distribution please include the name and version of the -distribution as well. - -**What compiler and version are you using?** - -Please include the output of `gcc -v` or `clang -v`, or the equivalent for your -compiler. - -**What build system are you using?** - -Please include the output of `bazel --version` or `cmake --version`, or the -equivalent for your build system. - -**Additional context** - -Add any other context about the problem here. diff --git a/external/googletest/.github/ISSUE_TEMPLATE/10-feature_request.md b/external/googletest/.github/ISSUE_TEMPLATE/10-feature_request.md deleted file mode 100644 index 70a3a2099c..0000000000 --- a/external/googletest/.github/ISSUE_TEMPLATE/10-feature_request.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: Feature request -about: Propose a new feature -title: '' -labels: 'enhancement' -assignees: '' ---- - -**Does the feature exist in the most recent commit?** - -We recommend using the latest commit from GitHub in your projects. - -**Why do we need this feature?** - -Ideally, explain why a combination of existing features cannot be used instead. - -**Describe the proposal** - -Include a detailed description of the feature, with usage examples. - -**Is the feature specific to an operating system, compiler, or build system version?** - -If it is, please specify which versions. - diff --git a/external/googletest/.github/ISSUE_TEMPLATE/config.yml b/external/googletest/.github/ISSUE_TEMPLATE/config.yml deleted file mode 100644 index 3ba13e0cec..0000000000 --- a/external/googletest/.github/ISSUE_TEMPLATE/config.yml +++ /dev/null @@ -1 +0,0 @@ -blank_issues_enabled: false diff --git a/external/googletest/.gitignore b/external/googletest/.gitignore deleted file mode 100644 index f08cb72a33..0000000000 --- a/external/googletest/.gitignore +++ /dev/null @@ -1,84 +0,0 @@ -# Ignore CI build directory -build/ -xcuserdata -cmake-build-debug/ -.idea/ -bazel-bin -bazel-genfiles -bazel-googletest -bazel-out -bazel-testlogs -# python -*.pyc - -# Visual Studio files -.vs -*.sdf -*.opensdf -*.VC.opendb -*.suo -*.user -_ReSharper.Caches/ -Win32-Debug/ -Win32-Release/ -x64-Debug/ -x64-Release/ - -# Ignore autoconf / automake files -Makefile.in -aclocal.m4 -configure -build-aux/ -autom4te.cache/ -googletest/m4/libtool.m4 -googletest/m4/ltoptions.m4 -googletest/m4/ltsugar.m4 -googletest/m4/ltversion.m4 -googletest/m4/lt~obsolete.m4 -googlemock/m4 - -# Ignore generated directories. -googlemock/fused-src/ -googletest/fused-src/ - -# macOS files -.DS_Store -googletest/.DS_Store -googletest/xcode/.DS_Store - -# Ignore cmake generated directories and files. -CMakeFiles -CTestTestfile.cmake -Makefile -cmake_install.cmake -googlemock/CMakeFiles -googlemock/CTestTestfile.cmake -googlemock/Makefile -googlemock/cmake_install.cmake -googlemock/gtest -/bin -/googlemock/gmock.dir -/googlemock/gmock_main.dir -/googlemock/RUN_TESTS.vcxproj.filters -/googlemock/RUN_TESTS.vcxproj -/googlemock/INSTALL.vcxproj.filters -/googlemock/INSTALL.vcxproj -/googlemock/gmock_main.vcxproj.filters -/googlemock/gmock_main.vcxproj -/googlemock/gmock.vcxproj.filters -/googlemock/gmock.vcxproj -/googlemock/gmock.sln -/googlemock/ALL_BUILD.vcxproj.filters -/googlemock/ALL_BUILD.vcxproj -/lib -/Win32 -/ZERO_CHECK.vcxproj.filters -/ZERO_CHECK.vcxproj -/RUN_TESTS.vcxproj.filters -/RUN_TESTS.vcxproj -/INSTALL.vcxproj.filters -/INSTALL.vcxproj -/googletest-distribution.sln -/CMakeCache.txt -/ALL_BUILD.vcxproj.filters -/ALL_BUILD.vcxproj diff --git a/external/googletest/BUILD.bazel b/external/googletest/BUILD.bazel deleted file mode 100644 index 965c518d7a..0000000000 --- a/external/googletest/BUILD.bazel +++ /dev/null @@ -1,190 +0,0 @@ -# Copyright 2017 Google Inc. -# All Rights Reserved. -# -# -# Redistribution and use in source and binary forms, with or without -# modification, are permitted provided that the following conditions are -# met: -# -# * Redistributions of source code must retain the above copyright -# notice, this list of conditions and the following disclaimer. -# * Redistributions in binary form must reproduce the above -# copyright notice, this list of conditions and the following disclaimer -# in the documentation and/or other materials provided with the -# distribution. -# * Neither the name of Google Inc. nor the names of its -# contributors may be used to endorse or promote products derived from -# this software without specific prior written permission. -# -# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -# -# Bazel Build for Google C++ Testing Framework(Google Test) - -load("@rules_cc//cc:defs.bzl", "cc_library", "cc_test") - -package(default_visibility = ["//visibility:public"]) - -licenses(["notice"]) - -exports_files(["LICENSE"]) - -config_setting( - name = "windows", - constraint_values = ["@platforms//os:windows"], -) - -config_setting( - name = "msvc_compiler", - flag_values = { - "@bazel_tools//tools/cpp:compiler": "msvc-cl", - }, - visibility = [":__subpackages__"], -) - -config_setting( - name = "has_absl", - values = {"define": "absl=1"}, -) - -# Library that defines the FRIEND_TEST macro. -cc_library( - name = "gtest_prod", - hdrs = ["googletest/include/gtest/gtest_prod.h"], - includes = ["googletest/include"], -) - -# Google Test including Google Mock -cc_library( - name = "gtest", - srcs = glob( - include = [ - "googletest/src/*.cc", - "googletest/src/*.h", - "googletest/include/gtest/**/*.h", - "googlemock/src/*.cc", - "googlemock/include/gmock/**/*.h", - ], - exclude = [ - "googletest/src/gtest-all.cc", - "googletest/src/gtest_main.cc", - "googlemock/src/gmock-all.cc", - "googlemock/src/gmock_main.cc", - ], - ), - hdrs = glob([ - "googletest/include/gtest/*.h", - "googlemock/include/gmock/*.h", - ]), - copts = select({ - ":windows": [], - "//conditions:default": ["-pthread"], - }), - defines = select({ - ":has_absl": ["GTEST_HAS_ABSL=1"], - "//conditions:default": [], - }), - features = select({ - ":windows": ["windows_export_all_symbols"], - "//conditions:default": [], - }), - includes = [ - "googlemock", - "googlemock/include", - "googletest", - "googletest/include", - ], - linkopts = select({ - ":windows": [], - "//conditions:default": ["-pthread"], - }), - deps = select({ - ":has_absl": [ - "@com_google_absl//absl/debugging:failure_signal_handler", - "@com_google_absl//absl/debugging:stacktrace", - "@com_google_absl//absl/debugging:symbolize", - "@com_google_absl//absl/strings", - "@com_google_absl//absl/types:any", - "@com_google_absl//absl/types:optional", - "@com_google_absl//absl/types:variant", - ], - "//conditions:default": [], - }), -) - -cc_library( - name = "gtest_main", - srcs = ["googlemock/src/gmock_main.cc"], - features = select({ - ":windows": ["windows_export_all_symbols"], - "//conditions:default": [], - }), - deps = [":gtest"], -) - -# The following rules build samples of how to use gTest. -cc_library( - name = "gtest_sample_lib", - srcs = [ - "googletest/samples/sample1.cc", - "googletest/samples/sample2.cc", - "googletest/samples/sample4.cc", - ], - hdrs = [ - "googletest/samples/prime_tables.h", - "googletest/samples/sample1.h", - "googletest/samples/sample2.h", - "googletest/samples/sample3-inl.h", - "googletest/samples/sample4.h", - ], - features = select({ - ":windows": ["windows_export_all_symbols"], - "//conditions:default": [], - }), -) - -cc_test( - name = "gtest_samples", - size = "small", - # All Samples except: - # sample9 (main) - # sample10 (main and takes a command line option and needs to be separate) - srcs = [ - "googletest/samples/sample1_unittest.cc", - "googletest/samples/sample2_unittest.cc", - "googletest/samples/sample3_unittest.cc", - "googletest/samples/sample4_unittest.cc", - "googletest/samples/sample5_unittest.cc", - "googletest/samples/sample6_unittest.cc", - "googletest/samples/sample7_unittest.cc", - "googletest/samples/sample8_unittest.cc", - ], - linkstatic = 0, - deps = [ - "gtest_sample_lib", - ":gtest_main", - ], -) - -cc_test( - name = "sample9_unittest", - size = "small", - srcs = ["googletest/samples/sample9_unittest.cc"], - deps = [":gtest"], -) - -cc_test( - name = "sample10_unittest", - size = "small", - srcs = ["googletest/samples/sample10_unittest.cc"], - deps = [":gtest"], -) diff --git a/external/googletest/CMakeLists.txt b/external/googletest/CMakeLists.txt deleted file mode 100644 index ea81ab1292..0000000000 --- a/external/googletest/CMakeLists.txt +++ /dev/null @@ -1,32 +0,0 @@ -# Note: CMake support is community-based. The maintainers do not use CMake -# internally. - -cmake_minimum_required(VERSION 2.8.12) - -if (POLICY CMP0048) - cmake_policy(SET CMP0048 NEW) -endif (POLICY CMP0048) - -project(googletest-distribution) -set(GOOGLETEST_VERSION 1.11.0) - -if (CMAKE_VERSION VERSION_GREATER "3.0.2") - if(NOT CYGWIN AND NOT MSYS AND NOT ${CMAKE_SYSTEM_NAME} STREQUAL QNX) - set(CMAKE_CXX_EXTENSIONS OFF) - endif() -endif() - -enable_testing() - -include(CMakeDependentOption) -include(GNUInstallDirs) - -#Note that googlemock target already builds googletest -option(BUILD_GMOCK "Builds the googlemock subproject" ON) -option(INSTALL_GTEST "Enable installation of googletest. (Projects embedding googletest may want to turn this OFF.)" ON) - -if(BUILD_GMOCK) - add_subdirectory( googlemock ) -else() - add_subdirectory( googletest ) -endif() diff --git a/external/googletest/CONTRIBUTING.md b/external/googletest/CONTRIBUTING.md deleted file mode 100644 index da45e4450c..0000000000 --- a/external/googletest/CONTRIBUTING.md +++ /dev/null @@ -1,130 +0,0 @@ -# How to become a contributor and submit your own code - -## Contributor License Agreements - -We'd love to accept your patches! Before we can take them, we have to jump a -couple of legal hurdles. - -Please fill out either the individual or corporate Contributor License Agreement -(CLA). - -* If you are an individual writing original source code and you're sure you - own the intellectual property, then you'll need to sign an - [individual CLA](https://developers.google.com/open-source/cla/individual). -* If you work for a company that wants to allow you to contribute your work, - then you'll need to sign a - [corporate CLA](https://developers.google.com/open-source/cla/corporate). - -Follow either of the two links above to access the appropriate CLA and -instructions for how to sign and return it. Once we receive it, we'll be able to -accept your pull requests. - -## Are you a Googler? - -If you are a Googler, please make an attempt to submit an internal change rather -than a GitHub Pull Request. If you are not able to submit an internal change a -PR is acceptable as an alternative. - -## Contributing A Patch - -1. Submit an issue describing your proposed change to the - [issue tracker](https://github.com/google/googletest/issues). -2. Please don't mix more than one logical change per submittal, because it - makes the history hard to follow. If you want to make a change that doesn't - have a corresponding issue in the issue tracker, please create one. -3. Also, coordinate with team members that are listed on the issue in question. - This ensures that work isn't being duplicated and communicating your plan - early also generally leads to better patches. -4. If your proposed change is accepted, and you haven't already done so, sign a - Contributor License Agreement (see details above). -5. Fork the desired repo, develop and test your code changes. -6. Ensure that your code adheres to the existing style in the sample to which - you are contributing. -7. Ensure that your code has an appropriate set of unit tests which all pass. -8. Submit a pull request. - -## The Google Test and Google Mock Communities - -The Google Test community exists primarily through the -[discussion group](http://groups.google.com/group/googletestframework) and the -GitHub repository. Likewise, the Google Mock community exists primarily through -their own [discussion group](http://groups.google.com/group/googlemock). You are -definitely encouraged to contribute to the discussion and you can also help us -to keep the effectiveness of the group high by following and promoting the -guidelines listed here. - -### Please Be Friendly - -Showing courtesy and respect to others is a vital part of the Google culture, -and we strongly encourage everyone participating in Google Test development to -join us in accepting nothing less. Of course, being courteous is not the same as -failing to constructively disagree with each other, but it does mean that we -should be respectful of each other when enumerating the 42 technical reasons -that a particular proposal may not be the best choice. There's never a reason to -be antagonistic or dismissive toward anyone who is sincerely trying to -contribute to a discussion. - -Sure, C++ testing is serious business and all that, but it's also a lot of fun. -Let's keep it that way. Let's strive to be one of the friendliest communities in -all of open source. - -As always, discuss Google Test in the official GoogleTest discussion group. You -don't have to actually submit code in order to sign up. Your participation -itself is a valuable contribution. - -## Style - -To keep the source consistent, readable, diffable and easy to merge, we use a -fairly rigid coding style, as defined by the -[google-styleguide](https://github.com/google/styleguide) project. All patches -will be expected to conform to the style outlined -[here](https://google.github.io/styleguide/cppguide.html). Use -[.clang-format](https://github.com/google/googletest/blob/master/.clang-format) -to check your formatting. - -## Requirements for Contributors - -If you plan to contribute a patch, you need to build Google Test, Google Mock, -and their own tests from a git checkout, which has further requirements: - -* [Python](https://www.python.org/) v2.3 or newer (for running some of the - tests and re-generating certain source files from templates) -* [CMake](https://cmake.org/) v2.8.12 or newer - -## Developing Google Test and Google Mock - -This section discusses how to make your own changes to the Google Test project. - -### Testing Google Test and Google Mock Themselves - -To make sure your changes work as intended and don't break existing -functionality, you'll want to compile and run Google Test and GoogleMock's own -tests. For that you can use CMake: - - mkdir mybuild - cd mybuild - cmake -Dgtest_build_tests=ON -Dgmock_build_tests=ON ${GTEST_REPO_DIR} - -To choose between building only Google Test or Google Mock, you may modify your -cmake command to be one of each - - cmake -Dgtest_build_tests=ON ${GTEST_DIR} # sets up Google Test tests - cmake -Dgmock_build_tests=ON ${GMOCK_DIR} # sets up Google Mock tests - -Make sure you have Python installed, as some of Google Test's tests are written -in Python. If the cmake command complains about not being able to find Python -(`Could NOT find PythonInterp (missing: PYTHON_EXECUTABLE)`), try telling it -explicitly where your Python executable can be found: - - cmake -DPYTHON_EXECUTABLE=path/to/python ... - -Next, you can build Google Test and / or Google Mock and all desired tests. On -\*nix, this is usually done by - - make - -To run the tests, do - - make test - -All tests should pass. diff --git a/external/googletest/CONTRIBUTORS b/external/googletest/CONTRIBUTORS deleted file mode 100644 index 76db0b40ff..0000000000 --- a/external/googletest/CONTRIBUTORS +++ /dev/null @@ -1,63 +0,0 @@ -# This file contains a list of people who've made non-trivial -# contribution to the Google C++ Testing Framework project. People -# who commit code to the project are encouraged to add their names -# here. Please keep the list sorted by first names. - -Ajay Joshi -Balázs Dán -Benoit Sigoure -Bharat Mediratta -Bogdan Piloca -Chandler Carruth -Chris Prince -Chris Taylor -Dan Egnor -Dave MacLachlan -David Anderson -Dean Sturtevant -Eric Roman -Gene Volovich -Hady Zalek -Hal Burch -Jeffrey Yasskin -Jim Keller -Joe Walnes -Jon Wray -Jói Sigurðsson -Keir Mierle -Keith Ray -Kenton Varda -Kostya Serebryany -Krystian Kuzniarek -Lev Makhlis -Manuel Klimek -Mario Tanev -Mark Paskin -Markus Heule -Matthew Simmons -Mika Raento -Mike Bland -Miklós Fazekas -Neal Norwitz -Nermin Ozkiranartli -Owen Carlsen -Paneendra Ba -Pasi Valminen -Patrick Hanna -Patrick Riley -Paul Menage -Peter Kaminski -Piotr Kaminski -Preston Jackson -Rainer Klaffenboeck -Russ Cox -Russ Rufer -Sean Mcafee -Sigurður Ásgeirsson -Sverre Sundsdal -Takeshi Yoshino -Tracy Bialik -Vadim Berman -Vlad Losev -Wolfgang Klier -Zhanyong Wan diff --git a/external/googletest/LICENSE b/external/googletest/LICENSE deleted file mode 100644 index 1941a11f8c..0000000000 --- a/external/googletest/LICENSE +++ /dev/null @@ -1,28 +0,0 @@ -Copyright 2008, Google Inc. -All rights reserved. - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are -met: - - * Redistributions of source code must retain the above copyright -notice, this list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above -copyright notice, this list of conditions and the following disclaimer -in the documentation and/or other materials provided with the -distribution. - * Neither the name of Google Inc. nor the names of its -contributors may be used to endorse or promote products derived from -this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/external/googletest/README.md b/external/googletest/README.md deleted file mode 100644 index 7d872a57ed..0000000000 --- a/external/googletest/README.md +++ /dev/null @@ -1,140 +0,0 @@ -# GoogleTest - -### Announcements - -#### Live at Head - -GoogleTest now follows the -[Abseil Live at Head philosophy](https://abseil.io/about/philosophy#upgrade-support). -We recommend using the latest commit in the `master` branch in your projects. - -#### Documentation Updates - -Our documentation is now live on GitHub Pages at -https://google.github.io/googletest/. We recommend browsing the documentation on -GitHub Pages rather than directly in the repository. - -#### Release 1.10.x - -[Release 1.10.x](https://github.com/google/googletest/releases/tag/release-1.10.0) -is now available. - -#### Coming Soon - -* We are planning to take a dependency on - [Abseil](https://github.com/abseil/abseil-cpp). -* More documentation improvements are planned. - -## Welcome to **GoogleTest**, Google's C++ test framework! - -This repository is a merger of the formerly separate GoogleTest and GoogleMock -projects. These were so closely related that it makes sense to maintain and -release them together. - -### Getting Started - -See the [GoogleTest User's Guide](https://google.github.io/googletest/) for -documentation. We recommend starting with the -[GoogleTest Primer](https://google.github.io/googletest/primer.html). - -More information about building GoogleTest can be found at -[googletest/README.md](googletest/README.md). - -## Features - -* An [xUnit](https://en.wikipedia.org/wiki/XUnit) test framework. -* Test discovery. -* A rich set of assertions. -* User-defined assertions. -* Death tests. -* Fatal and non-fatal failures. -* Value-parameterized tests. -* Type-parameterized tests. -* Various options for running the tests. -* XML test report generation. - -## Supported Platforms - -GoogleTest requires a codebase and compiler compliant with the C++11 standard or -newer. - -The GoogleTest code is officially supported on the following platforms. -Operating systems or tools not listed below are community-supported. For -community-supported platforms, patches that do not complicate the code may be -considered. - -If you notice any problems on your platform, please file an issue on the -[GoogleTest GitHub Issue Tracker](https://github.com/google/googletest/issues). -Pull requests containing fixes are welcome! - -### Operating Systems - -* Linux -* macOS -* Windows - -### Compilers - -* gcc 5.0+ -* clang 5.0+ -* MSVC 2015+ - -**macOS users:** Xcode 9.3+ provides clang 5.0+. - -### Build Systems - -* [Bazel](https://bazel.build/) -* [CMake](https://cmake.org/) - -**Note:** Bazel is the build system used by the team internally and in tests. -CMake is supported on a best-effort basis and by the community. - -## Who Is Using GoogleTest? - -In addition to many internal projects at Google, GoogleTest is also used by the -following notable projects: - -* The [Chromium projects](http://www.chromium.org/) (behind the Chrome browser - and Chrome OS). -* The [LLVM](http://llvm.org/) compiler. -* [Protocol Buffers](https://github.com/google/protobuf), Google's data - interchange format. -* The [OpenCV](http://opencv.org/) computer vision library. - -## Related Open Source Projects - -[GTest Runner](https://github.com/nholthaus/gtest-runner) is a Qt5 based -automated test-runner and Graphical User Interface with powerful features for -Windows and Linux platforms. - -[GoogleTest UI](https://github.com/ospector/gtest-gbar) is a test runner that -runs your test binary, allows you to track its progress via a progress bar, and -displays a list of test failures. Clicking on one shows failure text. Google -Test UI is written in C#. - -[GTest TAP Listener](https://github.com/kinow/gtest-tap-listener) is an event -listener for GoogleTest that implements the -[TAP protocol](https://en.wikipedia.org/wiki/Test_Anything_Protocol) for test -result output. If your test runner understands TAP, you may find it useful. - -[gtest-parallel](https://github.com/google/gtest-parallel) is a test runner that -runs tests from your binary in parallel to provide significant speed-up. - -[GoogleTest Adapter](https://marketplace.visualstudio.com/items?itemName=DavidSchuldenfrei.gtest-adapter) -is a VS Code extension allowing to view GoogleTest in a tree view, and run/debug -your tests. - -[C++ TestMate](https://github.com/matepek/vscode-catch2-test-adapter) is a VS -Code extension allowing to view GoogleTest in a tree view, and run/debug your -tests. - -[Cornichon](https://pypi.org/project/cornichon/) is a small Gherkin DSL parser -that generates stub code for GoogleTest. - -## Contributing Changes - -Please read -[`CONTRIBUTING.md`](https://github.com/google/googletest/blob/master/CONTRIBUTING.md) -for details on how to contribute to this project. - -Happy testing! diff --git a/external/googletest/WORKSPACE b/external/googletest/WORKSPACE deleted file mode 100644 index 614f55778e..0000000000 --- a/external/googletest/WORKSPACE +++ /dev/null @@ -1,24 +0,0 @@ -workspace(name = "com_google_googletest") - -load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive") - -http_archive( - name = "com_google_absl", - urls = ["https://github.com/abseil/abseil-cpp/archive/7971fb358ae376e016d2d4fc9327aad95659b25e.zip"], # 2021-05-20T02:59:16Z - strip_prefix = "abseil-cpp-7971fb358ae376e016d2d4fc9327aad95659b25e", - sha256 = "aeba534f7307e36fe084b452299e49b97420667a8d28102cf9a0daeed340b859", -) - -http_archive( - name = "rules_cc", - urls = ["https://github.com/bazelbuild/rules_cc/archive/68cb652a71e7e7e2858c50593e5a9e3b94e5b9a9.zip"], # 2021-05-14T14:51:14Z - strip_prefix = "rules_cc-68cb652a71e7e7e2858c50593e5a9e3b94e5b9a9", - sha256 = "1e19e9a3bc3d4ee91d7fcad00653485ee6c798efbbf9588d40b34cbfbded143d", -) - -http_archive( - name = "rules_python", - urls = ["https://github.com/bazelbuild/rules_python/archive/ed6cc8f2c3692a6a7f013ff8bc185ba77eb9b4d2.zip"], # 2021-05-17T00:24:16Z - strip_prefix = "rules_python-ed6cc8f2c3692a6a7f013ff8bc185ba77eb9b4d2", - sha256 = "98b3c592faea9636ac8444bfd9de7f3fb4c60590932d6e6ac5946e3f8dbd5ff6", -) diff --git a/external/googletest/ci/linux-presubmit.sh b/external/googletest/ci/linux-presubmit.sh deleted file mode 100644 index 6bea1cde26..0000000000 --- a/external/googletest/ci/linux-presubmit.sh +++ /dev/null @@ -1,126 +0,0 @@ -#!/bin/bash -# -# Copyright 2020, Google Inc. -# All rights reserved. -# -# Redistribution and use in source and binary forms, with or without -# modification, are permitted provided that the following conditions are -# met: -# -# * Redistributions of source code must retain the above copyright -# notice, this list of conditions and the following disclaimer. -# * Redistributions in binary form must reproduce the above -# copyright notice, this list of conditions and the following disclaimer -# in the documentation and/or other materials provided with the -# distribution. -# * Neither the name of Google Inc. nor the names of its -# contributors may be used to endorse or promote products derived from -# this software without specific prior written permission. -# -# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - -set -euox pipefail - -readonly LINUX_LATEST_CONTAINER="gcr.io/google.com/absl-177019/linux_hybrid-latest:20210525" -readonly LINUX_GCC_FLOOR_CONTAINER="gcr.io/google.com/absl-177019/linux_gcc-floor:20201015" - -if [[ -z ${GTEST_ROOT:-} ]]; then - GTEST_ROOT="$(realpath $(dirname ${0})/..)" -fi - -if [[ -z ${STD:-} ]]; then - STD="c++11 c++14 c++17 c++20" -fi - -# Test the CMake build -for cc in /usr/local/bin/gcc /opt/llvm/clang/bin/clang; do - for cmake_off_on in OFF ON; do - time docker run \ - --volume="${GTEST_ROOT}:/src:ro" \ - --tmpfs="/build:exec" \ - --workdir="/build" \ - --rm \ - --env="CC=${cc}" \ - --env="CXX_FLAGS=\"-Werror -Wdeprecated\"" \ - ${LINUX_LATEST_CONTAINER} \ - /bin/bash -c " - cmake /src \ - -DCMAKE_CXX_STANDARD=11 \ - -Dgtest_build_samples=ON \ - -Dgtest_build_tests=ON \ - -Dgmock_build_tests=ON \ - -Dcxx_no_exception=${cmake_off_on} \ - -Dcxx_no_rtti=${cmake_off_on} && \ - make -j$(nproc) && \ - ctest -j$(nproc) --output-on-failure" - done -done - -# Do one test with an older version of GCC -time docker run \ - --volume="${GTEST_ROOT}:/src:ro" \ - --workdir="/src" \ - --rm \ - --env="CC=/usr/local/bin/gcc" \ - ${LINUX_GCC_FLOOR_CONTAINER} \ - /usr/local/bin/bazel test ... \ - --copt="-Wall" \ - --copt="-Werror" \ - --copt="-Wno-error=pragmas" \ - --keep_going \ - --show_timestamps \ - --test_output=errors - -# Test GCC -for std in ${STD}; do - for absl in 0 1; do - time docker run \ - --volume="${GTEST_ROOT}:/src:ro" \ - --workdir="/src" \ - --rm \ - --env="CC=/usr/local/bin/gcc" \ - --env="BAZEL_CXXOPTS=-std=${std}" \ - ${LINUX_LATEST_CONTAINER} \ - /usr/local/bin/bazel test ... \ - --copt="-Wall" \ - --copt="-Werror" \ - --define="absl=${absl}" \ - --distdir="/bazel-distdir" \ - --keep_going \ - --show_timestamps \ - --test_output=errors - done -done - -# Test Clang -for std in ${STD}; do - for absl in 0 1; do - time docker run \ - --volume="${GTEST_ROOT}:/src:ro" \ - --workdir="/src" \ - --rm \ - --env="CC=/opt/llvm/clang/bin/clang" \ - --env="BAZEL_CXXOPTS=-std=${std}" \ - ${LINUX_LATEST_CONTAINER} \ - /usr/local/bin/bazel test ... \ - --copt="--gcc-toolchain=/usr/local" \ - --copt="-Wall" \ - --copt="-Werror" \ - --define="absl=${absl}" \ - --distdir="/bazel-distdir" \ - --keep_going \ - --linkopt="--gcc-toolchain=/usr/local" \ - --show_timestamps \ - --test_output=errors - done -done diff --git a/external/googletest/ci/macos-presubmit.sh b/external/googletest/ci/macos-presubmit.sh deleted file mode 100644 index d6423faacc..0000000000 --- a/external/googletest/ci/macos-presubmit.sh +++ /dev/null @@ -1,73 +0,0 @@ -#!/bin/bash -# -# Copyright 2020, Google Inc. -# All rights reserved. -# -# Redistribution and use in source and binary forms, with or without -# modification, are permitted provided that the following conditions are -# met: -# -# * Redistributions of source code must retain the above copyright -# notice, this list of conditions and the following disclaimer. -# * Redistributions in binary form must reproduce the above -# copyright notice, this list of conditions and the following disclaimer -# in the documentation and/or other materials provided with the -# distribution. -# * Neither the name of Google Inc. nor the names of its -# contributors may be used to endorse or promote products derived from -# this software without specific prior written permission. -# -# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - -set -euox pipefail - -if [[ -z ${GTEST_ROOT:-} ]]; then - GTEST_ROOT="$(realpath $(dirname ${0})/..)" -fi - -# Test the CMake build -for cmake_off_on in OFF ON; do - BUILD_DIR=$(mktemp -d build_dir.XXXXXXXX) - cd ${BUILD_DIR} - time cmake ${GTEST_ROOT} \ - -DCMAKE_CXX_STANDARD=11 \ - -Dgtest_build_samples=ON \ - -Dgtest_build_tests=ON \ - -Dgmock_build_tests=ON \ - -Dcxx_no_exception=${cmake_off_on} \ - -Dcxx_no_rtti=${cmake_off_on} - time make - time ctest -j$(nproc) --output-on-failure -done - -# Test the Bazel build - -# If we are running on Kokoro, check for a versioned Bazel binary. -KOKORO_GFILE_BAZEL_BIN="bazel-3.7.0-darwin-x86_64" -if [[ ${KOKORO_GFILE_DIR:-} ]] && [[ -f ${KOKORO_GFILE_DIR}/${KOKORO_GFILE_BAZEL_BIN} ]]; then - BAZEL_BIN="${KOKORO_GFILE_DIR}/${KOKORO_GFILE_BAZEL_BIN}" - chmod +x ${BAZEL_BIN} -else - BAZEL_BIN="bazel" -fi - -cd ${GTEST_ROOT} -for absl in 0 1; do - ${BAZEL_BIN} test ... \ - --copt="-Wall" \ - --copt="-Werror" \ - --define="absl=${absl}" \ - --keep_going \ - --show_timestamps \ - --test_output=errors -done diff --git a/external/googletest/docs/_config.yml b/external/googletest/docs/_config.yml deleted file mode 100644 index d12867eab6..0000000000 --- a/external/googletest/docs/_config.yml +++ /dev/null @@ -1 +0,0 @@ -title: GoogleTest diff --git a/external/googletest/docs/_data/navigation.yml b/external/googletest/docs/_data/navigation.yml deleted file mode 100644 index 9f3332708e..0000000000 --- a/external/googletest/docs/_data/navigation.yml +++ /dev/null @@ -1,43 +0,0 @@ -nav: -- section: "Get Started" - items: - - title: "Supported Platforms" - url: "/platforms.html" - - title: "Quickstart: Bazel" - url: "/quickstart-bazel.html" - - title: "Quickstart: CMake" - url: "/quickstart-cmake.html" -- section: "Guides" - items: - - title: "GoogleTest Primer" - url: "/primer.html" - - title: "Advanced Topics" - url: "/advanced.html" - - title: "Mocking for Dummies" - url: "/gmock_for_dummies.html" - - title: "Mocking Cookbook" - url: "/gmock_cook_book.html" - - title: "Mocking Cheat Sheet" - url: "/gmock_cheat_sheet.html" -- section: "References" - items: - - title: "Testing Reference" - url: "/reference/testing.html" - - title: "Mocking Reference" - url: "/reference/mocking.html" - - title: "Assertions" - url: "/reference/assertions.html" - - title: "Matchers" - url: "/reference/matchers.html" - - title: "Actions" - url: "/reference/actions.html" - - title: "Testing FAQ" - url: "/faq.html" - - title: "Mocking FAQ" - url: "/gmock_faq.html" - - title: "Code Samples" - url: "/samples.html" - - title: "Using pkg-config" - url: "/pkgconfig.html" - - title: "Community Documentation" - url: "/community_created_documentation.html" diff --git a/external/googletest/docs/_layouts/default.html b/external/googletest/docs/_layouts/default.html deleted file mode 100644 index dcb42d9191..0000000000 --- a/external/googletest/docs/_layouts/default.html +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - -{% seo %} - - - - - -
    -
    -

    {{ site.title | default: "Documentation" }}

    -
    - - - -
    -
    -
    - {{ content }} -
    -
    - GoogleTest · - GitHub Repository · - License · - Privacy Policy -
    -
    - - - - diff --git a/external/googletest/docs/_sass/main.scss b/external/googletest/docs/_sass/main.scss deleted file mode 100644 index 92edc877a5..0000000000 --- a/external/googletest/docs/_sass/main.scss +++ /dev/null @@ -1,200 +0,0 @@ -// Styles for GoogleTest docs website on GitHub Pages. -// Color variables are defined in -// https://github.com/pages-themes/primer/tree/master/_sass/primer-support/lib/variables - -$sidebar-width: 260px; - -body { - display: flex; - margin: 0; -} - -.sidebar { - background: $black; - color: $text-white; - flex-shrink: 0; - height: 100vh; - overflow: auto; - position: sticky; - top: 0; - width: $sidebar-width; -} - -.sidebar h1 { - font-size: 1.5em; -} - -.sidebar h2 { - color: $gray-light; - font-size: 0.8em; - font-weight: normal; - margin-bottom: 0.8em; - padding-left: 2.5em; - text-transform: uppercase; -} - -.sidebar .header { - background: $black; - padding: 2em; - position: sticky; - top: 0; - width: 100%; -} - -.sidebar .header a { - color: $text-white; - text-decoration: none; -} - -.sidebar .nav-toggle { - display: none; -} - -.sidebar .expander { - cursor: pointer; - display: none; - height: 3em; - position: absolute; - right: 1em; - top: 1.5em; - width: 3em; -} - -.sidebar .expander .arrow { - border: solid $white; - border-width: 0 3px 3px 0; - display: block; - height: 0.7em; - margin: 1em auto; - transform: rotate(45deg); - transition: transform 0.5s; - width: 0.7em; -} - -.sidebar nav { - width: 100%; -} - -.sidebar nav ul { - list-style-type: none; - margin-bottom: 1em; - padding: 0; - - &:last-child { - margin-bottom: 2em; - } - - a { - text-decoration: none; - } - - li { - color: $text-white; - padding-left: 2em; - text-decoration: none; - } - - li.active { - background: $border-gray-darker; - font-weight: bold; - } - - li:hover { - background: $border-gray-darker; - } -} - -.main { - background-color: $bg-gray; - width: calc(100% - #{$sidebar-width}); -} - -.main .main-inner { - background-color: $white; - padding: 2em; -} - -.main .footer { - margin: 0; - padding: 2em; -} - -.main table th { - text-align: left; -} - -.main .callout { - border-left: 0.25em solid $white; - padding: 1em; - - a { - text-decoration: underline; - } - - &.important { - background-color: $bg-yellow-light; - border-color: $bg-yellow; - color: $black; - } - - &.note { - background-color: $bg-blue-light; - border-color: $text-blue; - color: $text-blue; - } - - &.tip { - background-color: $green-000; - border-color: $green-700; - color: $green-700; - } - - &.warning { - background-color: $red-000; - border-color: $text-red; - color: $text-red; - } -} - -.main .good pre { - background-color: $bg-green-light; -} - -.main .bad pre { - background-color: $red-000; -} - -@media all and (max-width: 768px) { - body { - flex-direction: column; - } - - .sidebar { - height: auto; - position: relative; - width: 100%; - } - - .sidebar .expander { - display: block; - } - - .sidebar nav { - height: 0; - overflow: hidden; - } - - .sidebar .nav-toggle:checked { - & ~ nav { - height: auto; - } - - & + .expander .arrow { - transform: rotate(-135deg); - } - } - - .main { - width: 100%; - } -} diff --git a/external/googletest/docs/advanced.md b/external/googletest/docs/advanced.md deleted file mode 100644 index 8dff5ba150..0000000000 --- a/external/googletest/docs/advanced.md +++ /dev/null @@ -1,2318 +0,0 @@ -# Advanced googletest Topics - -## Introduction - -Now that you have read the [googletest Primer](primer.md) and learned how to -write tests using googletest, it's time to learn some new tricks. This document -will show you more assertions as well as how to construct complex failure -messages, propagate fatal failures, reuse and speed up your test fixtures, and -use various flags with your tests. - -## More Assertions - -This section covers some less frequently used, but still significant, -assertions. - -### Explicit Success and Failure - -See [Explicit Success and Failure](reference/assertions.md#success-failure) in -the Assertions Reference. - -### Exception Assertions - -See [Exception Assertions](reference/assertions.md#exceptions) in the Assertions -Reference. - -### Predicate Assertions for Better Error Messages - -Even though googletest has a rich set of assertions, they can never be complete, -as it's impossible (nor a good idea) to anticipate all scenarios a user might -run into. Therefore, sometimes a user has to use `EXPECT_TRUE()` to check a -complex expression, for lack of a better macro. This has the problem of not -showing you the values of the parts of the expression, making it hard to -understand what went wrong. As a workaround, some users choose to construct the -failure message by themselves, streaming it into `EXPECT_TRUE()`. However, this -is awkward especially when the expression has side-effects or is expensive to -evaluate. - -googletest gives you three different options to solve this problem: - -#### Using an Existing Boolean Function - -If you already have a function or functor that returns `bool` (or a type that -can be implicitly converted to `bool`), you can use it in a *predicate -assertion* to get the function arguments printed for free. See -[`EXPECT_PRED*`](reference/assertions.md#EXPECT_PRED) in the Assertions -Reference for details. - -#### Using a Function That Returns an AssertionResult - -While `EXPECT_PRED*()` and friends are handy for a quick job, the syntax is not -satisfactory: you have to use different macros for different arities, and it -feels more like Lisp than C++. The `::testing::AssertionResult` class solves -this problem. - -An `AssertionResult` object represents the result of an assertion (whether it's -a success or a failure, and an associated message). You can create an -`AssertionResult` using one of these factory functions: - -```c++ -namespace testing { - -// Returns an AssertionResult object to indicate that an assertion has -// succeeded. -AssertionResult AssertionSuccess(); - -// Returns an AssertionResult object to indicate that an assertion has -// failed. -AssertionResult AssertionFailure(); - -} -``` - -You can then use the `<<` operator to stream messages to the `AssertionResult` -object. - -To provide more readable messages in Boolean assertions (e.g. `EXPECT_TRUE()`), -write a predicate function that returns `AssertionResult` instead of `bool`. For -example, if you define `IsEven()` as: - -```c++ -testing::AssertionResult IsEven(int n) { - if ((n % 2) == 0) - return testing::AssertionSuccess(); - else - return testing::AssertionFailure() << n << " is odd"; -} -``` - -instead of: - -```c++ -bool IsEven(int n) { - return (n % 2) == 0; -} -``` - -the failed assertion `EXPECT_TRUE(IsEven(Fib(4)))` will print: - -```none -Value of: IsEven(Fib(4)) - Actual: false (3 is odd) -Expected: true -``` - -instead of a more opaque - -```none -Value of: IsEven(Fib(4)) - Actual: false -Expected: true -``` - -If you want informative messages in `EXPECT_FALSE` and `ASSERT_FALSE` as well -(one third of Boolean assertions in the Google code base are negative ones), and -are fine with making the predicate slower in the success case, you can supply a -success message: - -```c++ -testing::AssertionResult IsEven(int n) { - if ((n % 2) == 0) - return testing::AssertionSuccess() << n << " is even"; - else - return testing::AssertionFailure() << n << " is odd"; -} -``` - -Then the statement `EXPECT_FALSE(IsEven(Fib(6)))` will print - -```none - Value of: IsEven(Fib(6)) - Actual: true (8 is even) - Expected: false -``` - -#### Using a Predicate-Formatter - -If you find the default message generated by -[`EXPECT_PRED*`](reference/assertions.md#EXPECT_PRED) and -[`EXPECT_TRUE`](reference/assertions.md#EXPECT_TRUE) unsatisfactory, or some -arguments to your predicate do not support streaming to `ostream`, you can -instead use *predicate-formatter assertions* to *fully* customize how the -message is formatted. See -[`EXPECT_PRED_FORMAT*`](reference/assertions.md#EXPECT_PRED_FORMAT) in the -Assertions Reference for details. - -### Floating-Point Comparison - -See [Floating-Point Comparison](reference/assertions.md#floating-point) in the -Assertions Reference. - -#### Floating-Point Predicate-Format Functions - -Some floating-point operations are useful, but not that often used. In order to -avoid an explosion of new macros, we provide them as predicate-format functions -that can be used in the predicate assertion macro -[`EXPECT_PRED_FORMAT2`](reference/assertions.md#EXPECT_PRED_FORMAT), for -example: - -```c++ -EXPECT_PRED_FORMAT2(testing::FloatLE, val1, val2); -EXPECT_PRED_FORMAT2(testing::DoubleLE, val1, val2); -``` - -The above code verifies that `val1` is less than, or approximately equal to, -`val2`. - -### Asserting Using gMock Matchers - -See [`EXPECT_THAT`](reference/assertions.md#EXPECT_THAT) in the Assertions -Reference. - -### More String Assertions - -(Please read the [previous](#asserting-using-gmock-matchers) section first if -you haven't.) - -You can use the gMock [string matchers](reference/matchers.md#string-matchers) -with [`EXPECT_THAT`](reference/assertions.md#EXPECT_THAT) to do more string -comparison tricks (sub-string, prefix, suffix, regular expression, and etc). For -example, - -```c++ -using ::testing::HasSubstr; -using ::testing::MatchesRegex; -... - ASSERT_THAT(foo_string, HasSubstr("needle")); - EXPECT_THAT(bar_string, MatchesRegex("\\w*\\d+")); -``` - -### Windows HRESULT assertions - -See [Windows HRESULT Assertions](reference/assertions.md#HRESULT) in the -Assertions Reference. - -### Type Assertions - -You can call the function - -```c++ -::testing::StaticAssertTypeEq(); -``` - -to assert that types `T1` and `T2` are the same. The function does nothing if -the assertion is satisfied. If the types are different, the function call will -fail to compile, the compiler error message will say that -`T1 and T2 are not the same type` and most likely (depending on the compiler) -show you the actual values of `T1` and `T2`. This is mainly useful inside -template code. - -**Caveat**: When used inside a member function of a class template or a function -template, `StaticAssertTypeEq()` is effective only if the function is -instantiated. For example, given: - -```c++ -template class Foo { - public: - void Bar() { testing::StaticAssertTypeEq(); } -}; -``` - -the code: - -```c++ -void Test1() { Foo foo; } -``` - -will not generate a compiler error, as `Foo::Bar()` is never actually -instantiated. Instead, you need: - -```c++ -void Test2() { Foo foo; foo.Bar(); } -``` - -to cause a compiler error. - -### Assertion Placement - -You can use assertions in any C++ function. In particular, it doesn't have to be -a method of the test fixture class. The one constraint is that assertions that -generate a fatal failure (`FAIL*` and `ASSERT_*`) can only be used in -void-returning functions. This is a consequence of Google's not using -exceptions. By placing it in a non-void function you'll get a confusing compile -error like `"error: void value not ignored as it ought to be"` or `"cannot -initialize return object of type 'bool' with an rvalue of type 'void'"` or -`"error: no viable conversion from 'void' to 'string'"`. - -If you need to use fatal assertions in a function that returns non-void, one -option is to make the function return the value in an out parameter instead. For -example, you can rewrite `T2 Foo(T1 x)` to `void Foo(T1 x, T2* result)`. You -need to make sure that `*result` contains some sensible value even when the -function returns prematurely. As the function now returns `void`, you can use -any assertion inside of it. - -If changing the function's type is not an option, you should just use assertions -that generate non-fatal failures, such as `ADD_FAILURE*` and `EXPECT_*`. - -{: .callout .note} -NOTE: Constructors and destructors are not considered void-returning functions, -according to the C++ language specification, and so you may not use fatal -assertions in them; you'll get a compilation error if you try. Instead, either -call `abort` and crash the entire test executable, or put the fatal assertion in -a `SetUp`/`TearDown` function; see -[constructor/destructor vs. `SetUp`/`TearDown`](faq.md#CtorVsSetUp) - -{: .callout .warning} -WARNING: A fatal assertion in a helper function (private void-returning method) -called from a constructor or destructor does not terminate the current test, as -your intuition might suggest: it merely returns from the constructor or -destructor early, possibly leaving your object in a partially-constructed or -partially-destructed state! You almost certainly want to `abort` or use -`SetUp`/`TearDown` instead. - -## Skipping test execution - -Related to the assertions `SUCCEED()` and `FAIL()`, you can prevent further test -execution at runtime with the `GTEST_SKIP()` macro. This is useful when you need -to check for preconditions of the system under test during runtime and skip -tests in a meaningful way. - -`GTEST_SKIP()` can be used in individual test cases or in the `SetUp()` methods -of classes derived from either `::testing::Environment` or `::testing::Test`. -For example: - -```c++ -TEST(SkipTest, DoesSkip) { - GTEST_SKIP() << "Skipping single test"; - EXPECT_EQ(0, 1); // Won't fail; it won't be executed -} - -class SkipFixture : public ::testing::Test { - protected: - void SetUp() override { - GTEST_SKIP() << "Skipping all tests for this fixture"; - } -}; - -// Tests for SkipFixture won't be executed. -TEST_F(SkipFixture, SkipsOneTest) { - EXPECT_EQ(5, 7); // Won't fail -} -``` - -As with assertion macros, you can stream a custom message into `GTEST_SKIP()`. - -## Teaching googletest How to Print Your Values - -When a test assertion such as `EXPECT_EQ` fails, googletest prints the argument -values to help you debug. It does this using a user-extensible value printer. - -This printer knows how to print built-in C++ types, native arrays, STL -containers, and any type that supports the `<<` operator. For other types, it -prints the raw bytes in the value and hopes that you the user can figure it out. - -As mentioned earlier, the printer is *extensible*. That means you can teach it -to do a better job at printing your particular type than to dump the bytes. To -do that, define `<<` for your type: - -```c++ -#include - -namespace foo { - -class Bar { // We want googletest to be able to print instances of this. -... - // Create a free inline friend function. - friend std::ostream& operator<<(std::ostream& os, const Bar& bar) { - return os << bar.DebugString(); // whatever needed to print bar to os - } -}; - -// If you can't declare the function in the class it's important that the -// << operator is defined in the SAME namespace that defines Bar. C++'s look-up -// rules rely on that. -std::ostream& operator<<(std::ostream& os, const Bar& bar) { - return os << bar.DebugString(); // whatever needed to print bar to os -} - -} // namespace foo -``` - -Sometimes, this might not be an option: your team may consider it bad style to -have a `<<` operator for `Bar`, or `Bar` may already have a `<<` operator that -doesn't do what you want (and you cannot change it). If so, you can instead -define a `PrintTo()` function like this: - -```c++ -#include - -namespace foo { - -class Bar { - ... - friend void PrintTo(const Bar& bar, std::ostream* os) { - *os << bar.DebugString(); // whatever needed to print bar to os - } -}; - -// If you can't declare the function in the class it's important that PrintTo() -// is defined in the SAME namespace that defines Bar. C++'s look-up rules rely -// on that. -void PrintTo(const Bar& bar, std::ostream* os) { - *os << bar.DebugString(); // whatever needed to print bar to os -} - -} // namespace foo -``` - -If you have defined both `<<` and `PrintTo()`, the latter will be used when -googletest is concerned. This allows you to customize how the value appears in -googletest's output without affecting code that relies on the behavior of its -`<<` operator. - -If you want to print a value `x` using googletest's value printer yourself, just -call `::testing::PrintToString(x)`, which returns an `std::string`: - -```c++ -vector > bar_ints = GetBarIntVector(); - -EXPECT_TRUE(IsCorrectBarIntVector(bar_ints)) - << "bar_ints = " << testing::PrintToString(bar_ints); -``` - -## Death Tests - -In many applications, there are assertions that can cause application failure if -a condition is not met. These sanity checks, which ensure that the program is in -a known good state, are there to fail at the earliest possible time after some -program state is corrupted. If the assertion checks the wrong condition, then -the program may proceed in an erroneous state, which could lead to memory -corruption, security holes, or worse. Hence it is vitally important to test that -such assertion statements work as expected. - -Since these precondition checks cause the processes to die, we call such tests -_death tests_. More generally, any test that checks that a program terminates -(except by throwing an exception) in an expected fashion is also a death test. - -Note that if a piece of code throws an exception, we don't consider it "death" -for the purpose of death tests, as the caller of the code could catch the -exception and avoid the crash. If you want to verify exceptions thrown by your -code, see [Exception Assertions](#ExceptionAssertions). - -If you want to test `EXPECT_*()/ASSERT_*()` failures in your test code, see -["Catching" Failures](#catching-failures). - -### How to Write a Death Test - -GoogleTest provides assertion macros to support death tests. See -[Death Assertions](reference/assertions.md#death) in the Assertions Reference -for details. - -To write a death test, simply use one of the macros inside your test function. -For example, - -```c++ -TEST(MyDeathTest, Foo) { - // This death test uses a compound statement. - ASSERT_DEATH({ - int n = 5; - Foo(&n); - }, "Error on line .* of Foo()"); -} - -TEST(MyDeathTest, NormalExit) { - EXPECT_EXIT(NormalExit(), testing::ExitedWithCode(0), "Success"); -} - -TEST(MyDeathTest, KillProcess) { - EXPECT_EXIT(KillProcess(), testing::KilledBySignal(SIGKILL), - "Sending myself unblockable signal"); -} -``` - -verifies that: - -* calling `Foo(5)` causes the process to die with the given error message, -* calling `NormalExit()` causes the process to print `"Success"` to stderr and - exit with exit code 0, and -* calling `KillProcess()` kills the process with signal `SIGKILL`. - -The test function body may contain other assertions and statements as well, if -necessary. - -Note that a death test only cares about three things: - -1. does `statement` abort or exit the process? -2. (in the case of `ASSERT_EXIT` and `EXPECT_EXIT`) does the exit status - satisfy `predicate`? Or (in the case of `ASSERT_DEATH` and `EXPECT_DEATH`) - is the exit status non-zero? And -3. does the stderr output match `matcher`? - -In particular, if `statement` generates an `ASSERT_*` or `EXPECT_*` failure, it -will **not** cause the death test to fail, as googletest assertions don't abort -the process. - -### Death Test Naming - -{: .callout .important} -IMPORTANT: We strongly recommend you to follow the convention of naming your -**test suite** (not test) `*DeathTest` when it contains a death test, as -demonstrated in the above example. The -[Death Tests And Threads](#death-tests-and-threads) section below explains why. - -If a test fixture class is shared by normal tests and death tests, you can use -`using` or `typedef` to introduce an alias for the fixture class and avoid -duplicating its code: - -```c++ -class FooTest : public testing::Test { ... }; - -using FooDeathTest = FooTest; - -TEST_F(FooTest, DoesThis) { - // normal test -} - -TEST_F(FooDeathTest, DoesThat) { - // death test -} -``` - -### Regular Expression Syntax - -On POSIX systems (e.g. Linux, Cygwin, and Mac), googletest uses the -[POSIX extended regular expression](http://www.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap09.html#tag_09_04) -syntax. To learn about this syntax, you may want to read this -[Wikipedia entry](http://en.wikipedia.org/wiki/Regular_expression#POSIX_Extended_Regular_Expressions). - -On Windows, googletest uses its own simple regular expression implementation. It -lacks many features. For example, we don't support union (`"x|y"`), grouping -(`"(xy)"`), brackets (`"[xy]"`), and repetition count (`"x{5,7}"`), among -others. Below is what we do support (`A` denotes a literal character, period -(`.`), or a single `\\ ` escape sequence; `x` and `y` denote regular -expressions.): - -Expression | Meaning ----------- | -------------------------------------------------------------- -`c` | matches any literal character `c` -`\\d` | matches any decimal digit -`\\D` | matches any character that's not a decimal digit -`\\f` | matches `\f` -`\\n` | matches `\n` -`\\r` | matches `\r` -`\\s` | matches any ASCII whitespace, including `\n` -`\\S` | matches any character that's not a whitespace -`\\t` | matches `\t` -`\\v` | matches `\v` -`\\w` | matches any letter, `_`, or decimal digit -`\\W` | matches any character that `\\w` doesn't match -`\\c` | matches any literal character `c`, which must be a punctuation -`.` | matches any single character except `\n` -`A?` | matches 0 or 1 occurrences of `A` -`A*` | matches 0 or many occurrences of `A` -`A+` | matches 1 or many occurrences of `A` -`^` | matches the beginning of a string (not that of each line) -`$` | matches the end of a string (not that of each line) -`xy` | matches `x` followed by `y` - -To help you determine which capability is available on your system, googletest -defines macros to govern which regular expression it is using. The macros are: -`GTEST_USES_SIMPLE_RE=1` or `GTEST_USES_POSIX_RE=1`. If you want your death -tests to work in all cases, you can either `#if` on these macros or use the more -limited syntax only. - -### How It Works - -See [Death Assertions](reference/assertions.md#death) in the Assertions -Reference. - -### Death Tests And Threads - -The reason for the two death test styles has to do with thread safety. Due to -well-known problems with forking in the presence of threads, death tests should -be run in a single-threaded context. Sometimes, however, it isn't feasible to -arrange that kind of environment. For example, statically-initialized modules -may start threads before main is ever reached. Once threads have been created, -it may be difficult or impossible to clean them up. - -googletest has three features intended to raise awareness of threading issues. - -1. A warning is emitted if multiple threads are running when a death test is - encountered. -2. Test suites with a name ending in "DeathTest" are run before all other - tests. -3. It uses `clone()` instead of `fork()` to spawn the child process on Linux - (`clone()` is not available on Cygwin and Mac), as `fork()` is more likely - to cause the child to hang when the parent process has multiple threads. - -It's perfectly fine to create threads inside a death test statement; they are -executed in a separate process and cannot affect the parent. - -### Death Test Styles - -The "threadsafe" death test style was introduced in order to help mitigate the -risks of testing in a possibly multithreaded environment. It trades increased -test execution time (potentially dramatically so) for improved thread safety. - -The automated testing framework does not set the style flag. You can choose a -particular style of death tests by setting the flag programmatically: - -```c++ -testing::FLAGS_gtest_death_test_style="threadsafe" -``` - -You can do this in `main()` to set the style for all death tests in the binary, -or in individual tests. Recall that flags are saved before running each test and -restored afterwards, so you need not do that yourself. For example: - -```c++ -int main(int argc, char** argv) { - testing::InitGoogleTest(&argc, argv); - testing::FLAGS_gtest_death_test_style = "fast"; - return RUN_ALL_TESTS(); -} - -TEST(MyDeathTest, TestOne) { - testing::FLAGS_gtest_death_test_style = "threadsafe"; - // This test is run in the "threadsafe" style: - ASSERT_DEATH(ThisShouldDie(), ""); -} - -TEST(MyDeathTest, TestTwo) { - // This test is run in the "fast" style: - ASSERT_DEATH(ThisShouldDie(), ""); -} -``` - -### Caveats - -The `statement` argument of `ASSERT_EXIT()` can be any valid C++ statement. If -it leaves the current function via a `return` statement or by throwing an -exception, the death test is considered to have failed. Some googletest macros -may return from the current function (e.g. `ASSERT_TRUE()`), so be sure to avoid -them in `statement`. - -Since `statement` runs in the child process, any in-memory side effect (e.g. -modifying a variable, releasing memory, etc) it causes will *not* be observable -in the parent process. In particular, if you release memory in a death test, -your program will fail the heap check as the parent process will never see the -memory reclaimed. To solve this problem, you can - -1. try not to free memory in a death test; -2. free the memory again in the parent process; or -3. do not use the heap checker in your program. - -Due to an implementation detail, you cannot place multiple death test assertions -on the same line; otherwise, compilation will fail with an unobvious error -message. - -Despite the improved thread safety afforded by the "threadsafe" style of death -test, thread problems such as deadlock are still possible in the presence of -handlers registered with `pthread_atfork(3)`. - - -## Using Assertions in Sub-routines - -{: .callout .note} -Note: If you want to put a series of test assertions in a subroutine to check -for a complex condition, consider using -[a custom GMock matcher](gmock_cook_book.md#NewMatchers) -instead. This lets you provide a more readable error message in case of failure -and avoid all of the issues described below. - -### Adding Traces to Assertions - -If a test sub-routine is called from several places, when an assertion inside it -fails, it can be hard to tell which invocation of the sub-routine the failure is -from. You can alleviate this problem using extra logging or custom failure -messages, but that usually clutters up your tests. A better solution is to use -the `SCOPED_TRACE` macro or the `ScopedTrace` utility: - -```c++ -SCOPED_TRACE(message); -``` -```c++ -ScopedTrace trace("file_path", line_number, message); -``` - -where `message` can be anything streamable to `std::ostream`. `SCOPED_TRACE` -macro will cause the current file name, line number, and the given message to be -added in every failure message. `ScopedTrace` accepts explicit file name and -line number in arguments, which is useful for writing test helpers. The effect -will be undone when the control leaves the current lexical scope. - -For example, - -```c++ -10: void Sub1(int n) { -11: EXPECT_EQ(Bar(n), 1); -12: EXPECT_EQ(Bar(n + 1), 2); -13: } -14: -15: TEST(FooTest, Bar) { -16: { -17: SCOPED_TRACE("A"); // This trace point will be included in -18: // every failure in this scope. -19: Sub1(1); -20: } -21: // Now it won't. -22: Sub1(9); -23: } -``` - -could result in messages like these: - -```none -path/to/foo_test.cc:11: Failure -Value of: Bar(n) -Expected: 1 - Actual: 2 -Google Test trace: -path/to/foo_test.cc:17: A - -path/to/foo_test.cc:12: Failure -Value of: Bar(n + 1) -Expected: 2 - Actual: 3 -``` - -Without the trace, it would've been difficult to know which invocation of -`Sub1()` the two failures come from respectively. (You could add an extra -message to each assertion in `Sub1()` to indicate the value of `n`, but that's -tedious.) - -Some tips on using `SCOPED_TRACE`: - -1. With a suitable message, it's often enough to use `SCOPED_TRACE` at the - beginning of a sub-routine, instead of at each call site. -2. When calling sub-routines inside a loop, make the loop iterator part of the - message in `SCOPED_TRACE` such that you can know which iteration the failure - is from. -3. Sometimes the line number of the trace point is enough for identifying the - particular invocation of a sub-routine. In this case, you don't have to - choose a unique message for `SCOPED_TRACE`. You can simply use `""`. -4. You can use `SCOPED_TRACE` in an inner scope when there is one in the outer - scope. In this case, all active trace points will be included in the failure - messages, in reverse order they are encountered. -5. The trace dump is clickable in Emacs - hit `return` on a line number and - you'll be taken to that line in the source file! - -### Propagating Fatal Failures - -A common pitfall when using `ASSERT_*` and `FAIL*` is not understanding that -when they fail they only abort the _current function_, not the entire test. For -example, the following test will segfault: - -```c++ -void Subroutine() { - // Generates a fatal failure and aborts the current function. - ASSERT_EQ(1, 2); - - // The following won't be executed. - ... -} - -TEST(FooTest, Bar) { - Subroutine(); // The intended behavior is for the fatal failure - // in Subroutine() to abort the entire test. - - // The actual behavior: the function goes on after Subroutine() returns. - int* p = nullptr; - *p = 3; // Segfault! -} -``` - -To alleviate this, googletest provides three different solutions. You could use -either exceptions, the `(ASSERT|EXPECT)_NO_FATAL_FAILURE` assertions or the -`HasFatalFailure()` function. They are described in the following two -subsections. - -#### Asserting on Subroutines with an exception - -The following code can turn ASSERT-failure into an exception: - -```c++ -class ThrowListener : public testing::EmptyTestEventListener { - void OnTestPartResult(const testing::TestPartResult& result) override { - if (result.type() == testing::TestPartResult::kFatalFailure) { - throw testing::AssertionException(result); - } - } -}; -int main(int argc, char** argv) { - ... - testing::UnitTest::GetInstance()->listeners().Append(new ThrowListener); - return RUN_ALL_TESTS(); -} -``` - -This listener should be added after other listeners if you have any, otherwise -they won't see failed `OnTestPartResult`. - -#### Asserting on Subroutines - -As shown above, if your test calls a subroutine that has an `ASSERT_*` failure -in it, the test will continue after the subroutine returns. This may not be what -you want. - -Often people want fatal failures to propagate like exceptions. For that -googletest offers the following macros: - -Fatal assertion | Nonfatal assertion | Verifies -------------------------------------- | ------------------------------------- | -------- -`ASSERT_NO_FATAL_FAILURE(statement);` | `EXPECT_NO_FATAL_FAILURE(statement);` | `statement` doesn't generate any new fatal failures in the current thread. - -Only failures in the thread that executes the assertion are checked to determine -the result of this type of assertions. If `statement` creates new threads, -failures in these threads are ignored. - -Examples: - -```c++ -ASSERT_NO_FATAL_FAILURE(Foo()); - -int i; -EXPECT_NO_FATAL_FAILURE({ - i = Bar(); -}); -``` - -Assertions from multiple threads are currently not supported on Windows. - -#### Checking for Failures in the Current Test - -`HasFatalFailure()` in the `::testing::Test` class returns `true` if an -assertion in the current test has suffered a fatal failure. This allows -functions to catch fatal failures in a sub-routine and return early. - -```c++ -class Test { - public: - ... - static bool HasFatalFailure(); -}; -``` - -The typical usage, which basically simulates the behavior of a thrown exception, -is: - -```c++ -TEST(FooTest, Bar) { - Subroutine(); - // Aborts if Subroutine() had a fatal failure. - if (HasFatalFailure()) return; - - // The following won't be executed. - ... -} -``` - -If `HasFatalFailure()` is used outside of `TEST()` , `TEST_F()` , or a test -fixture, you must add the `::testing::Test::` prefix, as in: - -```c++ -if (testing::Test::HasFatalFailure()) return; -``` - -Similarly, `HasNonfatalFailure()` returns `true` if the current test has at -least one non-fatal failure, and `HasFailure()` returns `true` if the current -test has at least one failure of either kind. - -## Logging Additional Information - -In your test code, you can call `RecordProperty("key", value)` to log additional -information, where `value` can be either a string or an `int`. The *last* value -recorded for a key will be emitted to the -[XML output](#generating-an-xml-report) if you specify one. For example, the -test - -```c++ -TEST_F(WidgetUsageTest, MinAndMaxWidgets) { - RecordProperty("MaximumWidgets", ComputeMaxUsage()); - RecordProperty("MinimumWidgets", ComputeMinUsage()); -} -``` - -will output XML like this: - -```xml - ... - - ... -``` - -{: .callout .note} -> NOTE: -> -> * `RecordProperty()` is a static member of the `Test` class. Therefore it -> needs to be prefixed with `::testing::Test::` if used outside of the -> `TEST` body and the test fixture class. -> * *`key`* must be a valid XML attribute name, and cannot conflict with the -> ones already used by googletest (`name`, `status`, `time`, `classname`, -> `type_param`, and `value_param`). -> * Calling `RecordProperty()` outside of the lifespan of a test is allowed. -> If it's called outside of a test but between a test suite's -> `SetUpTestSuite()` and `TearDownTestSuite()` methods, it will be -> attributed to the XML element for the test suite. If it's called outside -> of all test suites (e.g. in a test environment), it will be attributed to -> the top-level XML element. - -## Sharing Resources Between Tests in the Same Test Suite - -googletest creates a new test fixture object for each test in order to make -tests independent and easier to debug. However, sometimes tests use resources -that are expensive to set up, making the one-copy-per-test model prohibitively -expensive. - -If the tests don't change the resource, there's no harm in their sharing a -single resource copy. So, in addition to per-test set-up/tear-down, googletest -also supports per-test-suite set-up/tear-down. To use it: - -1. In your test fixture class (say `FooTest` ), declare as `static` some member - variables to hold the shared resources. -2. Outside your test fixture class (typically just below it), define those - member variables, optionally giving them initial values. -3. In the same test fixture class, define a `static void SetUpTestSuite()` - function (remember not to spell it as **`SetupTestSuite`** with a small - `u`!) to set up the shared resources and a `static void TearDownTestSuite()` - function to tear them down. - -That's it! googletest automatically calls `SetUpTestSuite()` before running the -*first test* in the `FooTest` test suite (i.e. before creating the first -`FooTest` object), and calls `TearDownTestSuite()` after running the *last test* -in it (i.e. after deleting the last `FooTest` object). In between, the tests can -use the shared resources. - -Remember that the test order is undefined, so your code can't depend on a test -preceding or following another. Also, the tests must either not modify the state -of any shared resource, or, if they do modify the state, they must restore the -state to its original value before passing control to the next test. - -Here's an example of per-test-suite set-up and tear-down: - -```c++ -class FooTest : public testing::Test { - protected: - // Per-test-suite set-up. - // Called before the first test in this test suite. - // Can be omitted if not needed. - static void SetUpTestSuite() { - shared_resource_ = new ...; - } - - // Per-test-suite tear-down. - // Called after the last test in this test suite. - // Can be omitted if not needed. - static void TearDownTestSuite() { - delete shared_resource_; - shared_resource_ = nullptr; - } - - // You can define per-test set-up logic as usual. - void SetUp() override { ... } - - // You can define per-test tear-down logic as usual. - void TearDown() override { ... } - - // Some expensive resource shared by all tests. - static T* shared_resource_; -}; - -T* FooTest::shared_resource_ = nullptr; - -TEST_F(FooTest, Test1) { - ... you can refer to shared_resource_ here ... -} - -TEST_F(FooTest, Test2) { - ... you can refer to shared_resource_ here ... -} -``` - -{: .callout .note} -NOTE: Though the above code declares `SetUpTestSuite()` protected, it may -sometimes be necessary to declare it public, such as when using it with -`TEST_P`. - -## Global Set-Up and Tear-Down - -Just as you can do set-up and tear-down at the test level and the test suite -level, you can also do it at the test program level. Here's how. - -First, you subclass the `::testing::Environment` class to define a test -environment, which knows how to set-up and tear-down: - -```c++ -class Environment : public ::testing::Environment { - public: - ~Environment() override {} - - // Override this to define how to set up the environment. - void SetUp() override {} - - // Override this to define how to tear down the environment. - void TearDown() override {} -}; -``` - -Then, you register an instance of your environment class with googletest by -calling the `::testing::AddGlobalTestEnvironment()` function: - -```c++ -Environment* AddGlobalTestEnvironment(Environment* env); -``` - -Now, when `RUN_ALL_TESTS()` is called, it first calls the `SetUp()` method of -each environment object, then runs the tests if none of the environments -reported fatal failures and `GTEST_SKIP()` was not called. `RUN_ALL_TESTS()` -always calls `TearDown()` with each environment object, regardless of whether or -not the tests were run. - -It's OK to register multiple environment objects. In this suite, their `SetUp()` -will be called in the order they are registered, and their `TearDown()` will be -called in the reverse order. - -Note that googletest takes ownership of the registered environment objects. -Therefore **do not delete them** by yourself. - -You should call `AddGlobalTestEnvironment()` before `RUN_ALL_TESTS()` is called, -probably in `main()`. If you use `gtest_main`, you need to call this before -`main()` starts for it to take effect. One way to do this is to define a global -variable like this: - -```c++ -testing::Environment* const foo_env = - testing::AddGlobalTestEnvironment(new FooEnvironment); -``` - -However, we strongly recommend you to write your own `main()` and call -`AddGlobalTestEnvironment()` there, as relying on initialization of global -variables makes the code harder to read and may cause problems when you register -multiple environments from different translation units and the environments have -dependencies among them (remember that the compiler doesn't guarantee the order -in which global variables from different translation units are initialized). - -## Value-Parameterized Tests - -*Value-parameterized tests* allow you to test your code with different -parameters without writing multiple copies of the same test. This is useful in a -number of situations, for example: - -* You have a piece of code whose behavior is affected by one or more - command-line flags. You want to make sure your code performs correctly for - various values of those flags. -* You want to test different implementations of an OO interface. -* You want to test your code over various inputs (a.k.a. data-driven testing). - This feature is easy to abuse, so please exercise your good sense when doing - it! - -### How to Write Value-Parameterized Tests - -To write value-parameterized tests, first you should define a fixture class. It -must be derived from both `testing::Test` and `testing::WithParamInterface` -(the latter is a pure interface), where `T` is the type of your parameter -values. For convenience, you can just derive the fixture class from -`testing::TestWithParam`, which itself is derived from both `testing::Test` -and `testing::WithParamInterface`. `T` can be any copyable type. If it's a -raw pointer, you are responsible for managing the lifespan of the pointed -values. - -{: .callout .note} -NOTE: If your test fixture defines `SetUpTestSuite()` or `TearDownTestSuite()` -they must be declared **public** rather than **protected** in order to use -`TEST_P`. - -```c++ -class FooTest : - public testing::TestWithParam { - // You can implement all the usual fixture class members here. - // To access the test parameter, call GetParam() from class - // TestWithParam. -}; - -// Or, when you want to add parameters to a pre-existing fixture class: -class BaseTest : public testing::Test { - ... -}; -class BarTest : public BaseTest, - public testing::WithParamInterface { - ... -}; -``` - -Then, use the `TEST_P` macro to define as many test patterns using this fixture -as you want. The `_P` suffix is for "parameterized" or "pattern", whichever you -prefer to think. - -```c++ -TEST_P(FooTest, DoesBlah) { - // Inside a test, access the test parameter with the GetParam() method - // of the TestWithParam class: - EXPECT_TRUE(foo.Blah(GetParam())); - ... -} - -TEST_P(FooTest, HasBlahBlah) { - ... -} -``` - -Finally, you can use the `INSTANTIATE_TEST_SUITE_P` macro to instantiate the -test suite with any set of parameters you want. GoogleTest defines a number of -functions for generating test parameters—see details at -[`INSTANTIATE_TEST_SUITE_P`](reference/testing.md#INSTANTIATE_TEST_SUITE_P) in -the Testing Reference. - -For example, the following statement will instantiate tests from the `FooTest` -test suite each with parameter values `"meeny"`, `"miny"`, and `"moe"` using the -[`Values`](reference/testing.md#param-generators) parameter generator: - -```c++ -INSTANTIATE_TEST_SUITE_P(MeenyMinyMoe, - FooTest, - testing::Values("meeny", "miny", "moe")); -``` - -{: .callout .note} -NOTE: The code above must be placed at global or namespace scope, not at -function scope. - -The first argument to `INSTANTIATE_TEST_SUITE_P` is a unique name for the -instantiation of the test suite. The next argument is the name of the test -pattern, and the last is the -[parameter generator](reference/testing.md#param-generators). - -You can instantiate a test pattern more than once, so to distinguish different -instances of the pattern, the instantiation name is added as a prefix to the -actual test suite name. Remember to pick unique prefixes for different -instantiations. The tests from the instantiation above will have these names: - -* `MeenyMinyMoe/FooTest.DoesBlah/0` for `"meeny"` -* `MeenyMinyMoe/FooTest.DoesBlah/1` for `"miny"` -* `MeenyMinyMoe/FooTest.DoesBlah/2` for `"moe"` -* `MeenyMinyMoe/FooTest.HasBlahBlah/0` for `"meeny"` -* `MeenyMinyMoe/FooTest.HasBlahBlah/1` for `"miny"` -* `MeenyMinyMoe/FooTest.HasBlahBlah/2` for `"moe"` - -You can use these names in [`--gtest_filter`](#running-a-subset-of-the-tests). - -The following statement will instantiate all tests from `FooTest` again, each -with parameter values `"cat"` and `"dog"` using the -[`ValuesIn`](reference/testing.md#param-generators) parameter generator: - -```c++ -const char* pets[] = {"cat", "dog"}; -INSTANTIATE_TEST_SUITE_P(Pets, FooTest, testing::ValuesIn(pets)); -``` - -The tests from the instantiation above will have these names: - -* `Pets/FooTest.DoesBlah/0` for `"cat"` -* `Pets/FooTest.DoesBlah/1` for `"dog"` -* `Pets/FooTest.HasBlahBlah/0` for `"cat"` -* `Pets/FooTest.HasBlahBlah/1` for `"dog"` - -Please note that `INSTANTIATE_TEST_SUITE_P` will instantiate *all* tests in the -given test suite, whether their definitions come before or *after* the -`INSTANTIATE_TEST_SUITE_P` statement. - -Additionally, by default, every `TEST_P` without a corresponding -`INSTANTIATE_TEST_SUITE_P` causes a failing test in test suite -`GoogleTestVerification`. If you have a test suite where that omission is not an -error, for example it is in a library that may be linked in for other reasons or -where the list of test cases is dynamic and may be empty, then this check can be -suppressed by tagging the test suite: - -```c++ -GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST(FooTest); -``` - -You can see [sample7_unittest.cc] and [sample8_unittest.cc] for more examples. - -[sample7_unittest.cc]: https://github.com/google/googletest/blob/master/googletest/samples/sample7_unittest.cc "Parameterized Test example" -[sample8_unittest.cc]: https://github.com/google/googletest/blob/master/googletest/samples/sample8_unittest.cc "Parameterized Test example with multiple parameters" - -### Creating Value-Parameterized Abstract Tests - -In the above, we define and instantiate `FooTest` in the *same* source file. -Sometimes you may want to define value-parameterized tests in a library and let -other people instantiate them later. This pattern is known as *abstract tests*. -As an example of its application, when you are designing an interface you can -write a standard suite of abstract tests (perhaps using a factory function as -the test parameter) that all implementations of the interface are expected to -pass. When someone implements the interface, they can instantiate your suite to -get all the interface-conformance tests for free. - -To define abstract tests, you should organize your code like this: - -1. Put the definition of the parameterized test fixture class (e.g. `FooTest`) - in a header file, say `foo_param_test.h`. Think of this as *declaring* your - abstract tests. -2. Put the `TEST_P` definitions in `foo_param_test.cc`, which includes - `foo_param_test.h`. Think of this as *implementing* your abstract tests. - -Once they are defined, you can instantiate them by including `foo_param_test.h`, -invoking `INSTANTIATE_TEST_SUITE_P()`, and depending on the library target that -contains `foo_param_test.cc`. You can instantiate the same abstract test suite -multiple times, possibly in different source files. - -### Specifying Names for Value-Parameterized Test Parameters - -The optional last argument to `INSTANTIATE_TEST_SUITE_P()` allows the user to -specify a function or functor that generates custom test name suffixes based on -the test parameters. The function should accept one argument of type -`testing::TestParamInfo`, and return `std::string`. - -`testing::PrintToStringParamName` is a builtin test suffix generator that -returns the value of `testing::PrintToString(GetParam())`. It does not work for -`std::string` or C strings. - -{: .callout .note} -NOTE: test names must be non-empty, unique, and may only contain ASCII -alphanumeric characters. In particular, they -[should not contain underscores](faq.md#why-should-test-suite-names-and-test-names-not-contain-underscore) - -```c++ -class MyTestSuite : public testing::TestWithParam {}; - -TEST_P(MyTestSuite, MyTest) -{ - std::cout << "Example Test Param: " << GetParam() << std::endl; -} - -INSTANTIATE_TEST_SUITE_P(MyGroup, MyTestSuite, testing::Range(0, 10), - testing::PrintToStringParamName()); -``` - -Providing a custom functor allows for more control over test parameter name -generation, especially for types where the automatic conversion does not -generate helpful parameter names (e.g. strings as demonstrated above). The -following example illustrates this for multiple parameters, an enumeration type -and a string, and also demonstrates how to combine generators. It uses a lambda -for conciseness: - -```c++ -enum class MyType { MY_FOO = 0, MY_BAR = 1 }; - -class MyTestSuite : public testing::TestWithParam> { -}; - -INSTANTIATE_TEST_SUITE_P( - MyGroup, MyTestSuite, - testing::Combine( - testing::Values(MyType::MY_FOO, MyType::MY_BAR), - testing::Values("A", "B")), - [](const testing::TestParamInfo& info) { - std::string name = absl::StrCat( - std::get<0>(info.param) == MyType::MY_FOO ? "Foo" : "Bar", - std::get<1>(info.param)); - absl::c_replace_if(name, [](char c) { return !std::isalnum(c); }, '_'); - return name; - }); -``` - -## Typed Tests - -Suppose you have multiple implementations of the same interface and want to make -sure that all of them satisfy some common requirements. Or, you may have defined -several types that are supposed to conform to the same "concept" and you want to -verify it. In both cases, you want the same test logic repeated for different -types. - -While you can write one `TEST` or `TEST_F` for each type you want to test (and -you may even factor the test logic into a function template that you invoke from -the `TEST`), it's tedious and doesn't scale: if you want `m` tests over `n` -types, you'll end up writing `m*n` `TEST`s. - -*Typed tests* allow you to repeat the same test logic over a list of types. You -only need to write the test logic once, although you must know the type list -when writing typed tests. Here's how you do it: - -First, define a fixture class template. It should be parameterized by a type. -Remember to derive it from `::testing::Test`: - -```c++ -template -class FooTest : public testing::Test { - public: - ... - using List = std::list; - static T shared_; - T value_; -}; -``` - -Next, associate a list of types with the test suite, which will be repeated for -each type in the list: - -```c++ -using MyTypes = ::testing::Types; -TYPED_TEST_SUITE(FooTest, MyTypes); -``` - -The type alias (`using` or `typedef`) is necessary for the `TYPED_TEST_SUITE` -macro to parse correctly. Otherwise the compiler will think that each comma in -the type list introduces a new macro argument. - -Then, use `TYPED_TEST()` instead of `TEST_F()` to define a typed test for this -test suite. You can repeat this as many times as you want: - -```c++ -TYPED_TEST(FooTest, DoesBlah) { - // Inside a test, refer to the special name TypeParam to get the type - // parameter. Since we are inside a derived class template, C++ requires - // us to visit the members of FooTest via 'this'. - TypeParam n = this->value_; - - // To visit static members of the fixture, add the 'TestFixture::' - // prefix. - n += TestFixture::shared_; - - // To refer to typedefs in the fixture, add the 'typename TestFixture::' - // prefix. The 'typename' is required to satisfy the compiler. - typename TestFixture::List values; - - values.push_back(n); - ... -} - -TYPED_TEST(FooTest, HasPropertyA) { ... } -``` - -You can see [sample6_unittest.cc] for a complete example. - -[sample6_unittest.cc]: https://github.com/google/googletest/blob/master/googletest/samples/sample6_unittest.cc "Typed Test example" - -## Type-Parameterized Tests - -*Type-parameterized tests* are like typed tests, except that they don't require -you to know the list of types ahead of time. Instead, you can define the test -logic first and instantiate it with different type lists later. You can even -instantiate it more than once in the same program. - -If you are designing an interface or concept, you can define a suite of -type-parameterized tests to verify properties that any valid implementation of -the interface/concept should have. Then, the author of each implementation can -just instantiate the test suite with their type to verify that it conforms to -the requirements, without having to write similar tests repeatedly. Here's an -example: - -First, define a fixture class template, as we did with typed tests: - -```c++ -template -class FooTest : public testing::Test { - ... -}; -``` - -Next, declare that you will define a type-parameterized test suite: - -```c++ -TYPED_TEST_SUITE_P(FooTest); -``` - -Then, use `TYPED_TEST_P()` to define a type-parameterized test. You can repeat -this as many times as you want: - -```c++ -TYPED_TEST_P(FooTest, DoesBlah) { - // Inside a test, refer to TypeParam to get the type parameter. - TypeParam n = 0; - ... -} - -TYPED_TEST_P(FooTest, HasPropertyA) { ... } -``` - -Now the tricky part: you need to register all test patterns using the -`REGISTER_TYPED_TEST_SUITE_P` macro before you can instantiate them. The first -argument of the macro is the test suite name; the rest are the names of the -tests in this test suite: - -```c++ -REGISTER_TYPED_TEST_SUITE_P(FooTest, - DoesBlah, HasPropertyA); -``` - -Finally, you are free to instantiate the pattern with the types you want. If you -put the above code in a header file, you can `#include` it in multiple C++ -source files and instantiate it multiple times. - -```c++ -using MyTypes = ::testing::Types; -INSTANTIATE_TYPED_TEST_SUITE_P(My, FooTest, MyTypes); -``` - -To distinguish different instances of the pattern, the first argument to the -`INSTANTIATE_TYPED_TEST_SUITE_P` macro is a prefix that will be added to the -actual test suite name. Remember to pick unique prefixes for different -instances. - -In the special case where the type list contains only one type, you can write -that type directly without `::testing::Types<...>`, like this: - -```c++ -INSTANTIATE_TYPED_TEST_SUITE_P(My, FooTest, int); -``` - -You can see [sample6_unittest.cc] for a complete example. - -## Testing Private Code - -If you change your software's internal implementation, your tests should not -break as long as the change is not observable by users. Therefore, **per the -black-box testing principle, most of the time you should test your code through -its public interfaces.** - -**If you still find yourself needing to test internal implementation code, -consider if there's a better design.** The desire to test internal -implementation is often a sign that the class is doing too much. Consider -extracting an implementation class, and testing it. Then use that implementation -class in the original class. - -If you absolutely have to test non-public interface code though, you can. There -are two cases to consider: - -* Static functions ( *not* the same as static member functions!) or unnamed - namespaces, and -* Private or protected class members - -To test them, we use the following special techniques: - -* Both static functions and definitions/declarations in an unnamed namespace - are only visible within the same translation unit. To test them, you can - `#include` the entire `.cc` file being tested in your `*_test.cc` file. - (#including `.cc` files is not a good way to reuse code - you should not do - this in production code!) - - However, a better approach is to move the private code into the - `foo::internal` namespace, where `foo` is the namespace your project - normally uses, and put the private declarations in a `*-internal.h` file. - Your production `.cc` files and your tests are allowed to include this - internal header, but your clients are not. This way, you can fully test your - internal implementation without leaking it to your clients. - -* Private class members are only accessible from within the class or by - friends. To access a class' private members, you can declare your test - fixture as a friend to the class and define accessors in your fixture. Tests - using the fixture can then access the private members of your production - class via the accessors in the fixture. Note that even though your fixture - is a friend to your production class, your tests are not automatically - friends to it, as they are technically defined in sub-classes of the - fixture. - - Another way to test private members is to refactor them into an - implementation class, which is then declared in a `*-internal.h` file. Your - clients aren't allowed to include this header but your tests can. Such is - called the - [Pimpl](https://www.gamedev.net/articles/programming/general-and-gameplay-programming/the-c-pimpl-r1794/) - (Private Implementation) idiom. - - Or, you can declare an individual test as a friend of your class by adding - this line in the class body: - - ```c++ - FRIEND_TEST(TestSuiteName, TestName); - ``` - - For example, - - ```c++ - // foo.h - class Foo { - ... - private: - FRIEND_TEST(FooTest, BarReturnsZeroOnNull); - - int Bar(void* x); - }; - - // foo_test.cc - ... - TEST(FooTest, BarReturnsZeroOnNull) { - Foo foo; - EXPECT_EQ(foo.Bar(NULL), 0); // Uses Foo's private member Bar(). - } - ``` - - Pay special attention when your class is defined in a namespace. If you want - your test fixtures and tests to be friends of your class, then they must be - defined in the exact same namespace (no anonymous or inline namespaces). - - For example, if the code to be tested looks like: - - ```c++ - namespace my_namespace { - - class Foo { - friend class FooTest; - FRIEND_TEST(FooTest, Bar); - FRIEND_TEST(FooTest, Baz); - ... definition of the class Foo ... - }; - - } // namespace my_namespace - ``` - - Your test code should be something like: - - ```c++ - namespace my_namespace { - - class FooTest : public testing::Test { - protected: - ... - }; - - TEST_F(FooTest, Bar) { ... } - TEST_F(FooTest, Baz) { ... } - - } // namespace my_namespace - ``` - -## "Catching" Failures - -If you are building a testing utility on top of googletest, you'll want to test -your utility. What framework would you use to test it? googletest, of course. - -The challenge is to verify that your testing utility reports failures correctly. -In frameworks that report a failure by throwing an exception, you could catch -the exception and assert on it. But googletest doesn't use exceptions, so how do -we test that a piece of code generates an expected failure? - -`"gtest/gtest-spi.h"` contains some constructs to do this. After #including this header, -you can use - -```c++ - EXPECT_FATAL_FAILURE(statement, substring); -``` - -to assert that `statement` generates a fatal (e.g. `ASSERT_*`) failure in the -current thread whose message contains the given `substring`, or use - -```c++ - EXPECT_NONFATAL_FAILURE(statement, substring); -``` - -if you are expecting a non-fatal (e.g. `EXPECT_*`) failure. - -Only failures in the current thread are checked to determine the result of this -type of expectations. If `statement` creates new threads, failures in these -threads are also ignored. If you want to catch failures in other threads as -well, use one of the following macros instead: - -```c++ - EXPECT_FATAL_FAILURE_ON_ALL_THREADS(statement, substring); - EXPECT_NONFATAL_FAILURE_ON_ALL_THREADS(statement, substring); -``` - -{: .callout .note} -NOTE: Assertions from multiple threads are currently not supported on Windows. - -For technical reasons, there are some caveats: - -1. You cannot stream a failure message to either macro. - -2. `statement` in `EXPECT_FATAL_FAILURE{_ON_ALL_THREADS}()` cannot reference - local non-static variables or non-static members of `this` object. - -3. `statement` in `EXPECT_FATAL_FAILURE{_ON_ALL_THREADS}()` cannot return a - value. - -## Registering tests programmatically - -The `TEST` macros handle the vast majority of all use cases, but there are few -where runtime registration logic is required. For those cases, the framework -provides the `::testing::RegisterTest` that allows callers to register arbitrary -tests dynamically. - -This is an advanced API only to be used when the `TEST` macros are insufficient. -The macros should be preferred when possible, as they avoid most of the -complexity of calling this function. - -It provides the following signature: - -```c++ -template -TestInfo* RegisterTest(const char* test_suite_name, const char* test_name, - const char* type_param, const char* value_param, - const char* file, int line, Factory factory); -``` - -The `factory` argument is a factory callable (move-constructible) object or -function pointer that creates a new instance of the Test object. It handles -ownership to the caller. The signature of the callable is `Fixture*()`, where -`Fixture` is the test fixture class for the test. All tests registered with the -same `test_suite_name` must return the same fixture type. This is checked at -runtime. - -The framework will infer the fixture class from the factory and will call the -`SetUpTestSuite` and `TearDownTestSuite` for it. - -Must be called before `RUN_ALL_TESTS()` is invoked, otherwise behavior is -undefined. - -Use case example: - -```c++ -class MyFixture : public testing::Test { - public: - // All of these optional, just like in regular macro usage. - static void SetUpTestSuite() { ... } - static void TearDownTestSuite() { ... } - void SetUp() override { ... } - void TearDown() override { ... } -}; - -class MyTest : public MyFixture { - public: - explicit MyTest(int data) : data_(data) {} - void TestBody() override { ... } - - private: - int data_; -}; - -void RegisterMyTests(const std::vector& values) { - for (int v : values) { - testing::RegisterTest( - "MyFixture", ("Test" + std::to_string(v)).c_str(), nullptr, - std::to_string(v).c_str(), - __FILE__, __LINE__, - // Important to use the fixture type as the return type here. - [=]() -> MyFixture* { return new MyTest(v); }); - } -} -... -int main(int argc, char** argv) { - std::vector values_to_test = LoadValuesFromConfig(); - RegisterMyTests(values_to_test); - ... - return RUN_ALL_TESTS(); -} -``` -## Getting the Current Test's Name - -Sometimes a function may need to know the name of the currently running test. -For example, you may be using the `SetUp()` method of your test fixture to set -the golden file name based on which test is running. The -[`TestInfo`](reference/testing.md#TestInfo) class has this information. - -To obtain a `TestInfo` object for the currently running test, call -`current_test_info()` on the [`UnitTest`](reference/testing.md#UnitTest) -singleton object: - -```c++ - // Gets information about the currently running test. - // Do NOT delete the returned object - it's managed by the UnitTest class. - const testing::TestInfo* const test_info = - testing::UnitTest::GetInstance()->current_test_info(); - - printf("We are in test %s of test suite %s.\n", - test_info->name(), - test_info->test_suite_name()); -``` - -`current_test_info()` returns a null pointer if no test is running. In -particular, you cannot find the test suite name in `SetUpTestSuite()`, -`TearDownTestSuite()` (where you know the test suite name implicitly), or -functions called from them. - -## Extending googletest by Handling Test Events - -googletest provides an **event listener API** to let you receive notifications -about the progress of a test program and test failures. The events you can -listen to include the start and end of the test program, a test suite, or a test -method, among others. You may use this API to augment or replace the standard -console output, replace the XML output, or provide a completely different form -of output, such as a GUI or a database. You can also use test events as -checkpoints to implement a resource leak checker, for example. - -### Defining Event Listeners - -To define a event listener, you subclass either -[`testing::TestEventListener`](reference/testing.md#TestEventListener) or -[`testing::EmptyTestEventListener`](reference/testing.md#EmptyTestEventListener) -The former is an (abstract) interface, where *each pure virtual method can be -overridden to handle a test event* (For example, when a test starts, the -`OnTestStart()` method will be called.). The latter provides an empty -implementation of all methods in the interface, such that a subclass only needs -to override the methods it cares about. - -When an event is fired, its context is passed to the handler function as an -argument. The following argument types are used: - -* UnitTest reflects the state of the entire test program, -* TestSuite has information about a test suite, which can contain one or more - tests, -* TestInfo contains the state of a test, and -* TestPartResult represents the result of a test assertion. - -An event handler function can examine the argument it receives to find out -interesting information about the event and the test program's state. - -Here's an example: - -```c++ - class MinimalistPrinter : public testing::EmptyTestEventListener { - // Called before a test starts. - void OnTestStart(const testing::TestInfo& test_info) override { - printf("*** Test %s.%s starting.\n", - test_info.test_suite_name(), test_info.name()); - } - - // Called after a failed assertion or a SUCCESS(). - void OnTestPartResult(const testing::TestPartResult& test_part_result) override { - printf("%s in %s:%d\n%s\n", - test_part_result.failed() ? "*** Failure" : "Success", - test_part_result.file_name(), - test_part_result.line_number(), - test_part_result.summary()); - } - - // Called after a test ends. - void OnTestEnd(const testing::TestInfo& test_info) override { - printf("*** Test %s.%s ending.\n", - test_info.test_suite_name(), test_info.name()); - } - }; -``` - -### Using Event Listeners - -To use the event listener you have defined, add an instance of it to the -googletest event listener list (represented by class -[`TestEventListeners`](reference/testing.md#TestEventListeners) - note the "s" -at the end of the name) in your `main()` function, before calling -`RUN_ALL_TESTS()`: - -```c++ -int main(int argc, char** argv) { - testing::InitGoogleTest(&argc, argv); - // Gets hold of the event listener list. - testing::TestEventListeners& listeners = - testing::UnitTest::GetInstance()->listeners(); - // Adds a listener to the end. googletest takes the ownership. - listeners.Append(new MinimalistPrinter); - return RUN_ALL_TESTS(); -} -``` - -There's only one problem: the default test result printer is still in effect, so -its output will mingle with the output from your minimalist printer. To suppress -the default printer, just release it from the event listener list and delete it. -You can do so by adding one line: - -```c++ - ... - delete listeners.Release(listeners.default_result_printer()); - listeners.Append(new MinimalistPrinter); - return RUN_ALL_TESTS(); -``` - -Now, sit back and enjoy a completely different output from your tests. For more -details, see [sample9_unittest.cc]. - -[sample9_unittest.cc]: https://github.com/google/googletest/blob/master/googletest/samples/sample9_unittest.cc "Event listener example" - -You may append more than one listener to the list. When an `On*Start()` or -`OnTestPartResult()` event is fired, the listeners will receive it in the order -they appear in the list (since new listeners are added to the end of the list, -the default text printer and the default XML generator will receive the event -first). An `On*End()` event will be received by the listeners in the *reverse* -order. This allows output by listeners added later to be framed by output from -listeners added earlier. - -### Generating Failures in Listeners - -You may use failure-raising macros (`EXPECT_*()`, `ASSERT_*()`, `FAIL()`, etc) -when processing an event. There are some restrictions: - -1. You cannot generate any failure in `OnTestPartResult()` (otherwise it will - cause `OnTestPartResult()` to be called recursively). -2. A listener that handles `OnTestPartResult()` is not allowed to generate any - failure. - -When you add listeners to the listener list, you should put listeners that -handle `OnTestPartResult()` *before* listeners that can generate failures. This -ensures that failures generated by the latter are attributed to the right test -by the former. - -See [sample10_unittest.cc] for an example of a failure-raising listener. - -[sample10_unittest.cc]: https://github.com/google/googletest/blob/master/googletest/samples/sample10_unittest.cc "Failure-raising listener example" - -## Running Test Programs: Advanced Options - -googletest test programs are ordinary executables. Once built, you can run them -directly and affect their behavior via the following environment variables -and/or command line flags. For the flags to work, your programs must call -`::testing::InitGoogleTest()` before calling `RUN_ALL_TESTS()`. - -To see a list of supported flags and their usage, please run your test program -with the `--help` flag. You can also use `-h`, `-?`, or `/?` for short. - -If an option is specified both by an environment variable and by a flag, the -latter takes precedence. - -### Selecting Tests - -#### Listing Test Names - -Sometimes it is necessary to list the available tests in a program before -running them so that a filter may be applied if needed. Including the flag -`--gtest_list_tests` overrides all other flags and lists tests in the following -format: - -```none -TestSuite1. - TestName1 - TestName2 -TestSuite2. - TestName -``` - -None of the tests listed are actually run if the flag is provided. There is no -corresponding environment variable for this flag. - -#### Running a Subset of the Tests - -By default, a googletest program runs all tests the user has defined. Sometimes, -you want to run only a subset of the tests (e.g. for debugging or quickly -verifying a change). If you set the `GTEST_FILTER` environment variable or the -`--gtest_filter` flag to a filter string, googletest will only run the tests -whose full names (in the form of `TestSuiteName.TestName`) match the filter. - -The format of a filter is a '`:`'-separated list of wildcard patterns (called -the *positive patterns*) optionally followed by a '`-`' and another -'`:`'-separated pattern list (called the *negative patterns*). A test matches -the filter if and only if it matches any of the positive patterns but does not -match any of the negative patterns. - -A pattern may contain `'*'` (matches any string) or `'?'` (matches any single -character). For convenience, the filter `'*-NegativePatterns'` can be also -written as `'-NegativePatterns'`. - -For example: - -* `./foo_test` Has no flag, and thus runs all its tests. -* `./foo_test --gtest_filter=*` Also runs everything, due to the single - match-everything `*` value. -* `./foo_test --gtest_filter=FooTest.*` Runs everything in test suite - `FooTest` . -* `./foo_test --gtest_filter=*Null*:*Constructor*` Runs any test whose full - name contains either `"Null"` or `"Constructor"` . -* `./foo_test --gtest_filter=-*DeathTest.*` Runs all non-death tests. -* `./foo_test --gtest_filter=FooTest.*-FooTest.Bar` Runs everything in test - suite `FooTest` except `FooTest.Bar`. -* `./foo_test --gtest_filter=FooTest.*:BarTest.*-FooTest.Bar:BarTest.Foo` Runs - everything in test suite `FooTest` except `FooTest.Bar` and everything in - test suite `BarTest` except `BarTest.Foo`. - -#### Stop test execution upon first failure - -By default, a googletest program runs all tests the user has defined. In some -cases (e.g. iterative test development & execution) it may be desirable stop -test execution upon first failure (trading improved latency for completeness). -If `GTEST_FAIL_FAST` environment variable or `--gtest_fail_fast` flag is set, -the test runner will stop execution as soon as the first test failure is -found. - -#### Temporarily Disabling Tests - -If you have a broken test that you cannot fix right away, you can add the -`DISABLED_` prefix to its name. This will exclude it from execution. This is -better than commenting out the code or using `#if 0`, as disabled tests are -still compiled (and thus won't rot). - -If you need to disable all tests in a test suite, you can either add `DISABLED_` -to the front of the name of each test, or alternatively add it to the front of -the test suite name. - -For example, the following tests won't be run by googletest, even though they -will still be compiled: - -```c++ -// Tests that Foo does Abc. -TEST(FooTest, DISABLED_DoesAbc) { ... } - -class DISABLED_BarTest : public testing::Test { ... }; - -// Tests that Bar does Xyz. -TEST_F(DISABLED_BarTest, DoesXyz) { ... } -``` - -{: .callout .note} -NOTE: This feature should only be used for temporary pain-relief. You still have -to fix the disabled tests at a later date. As a reminder, googletest will print -a banner warning you if a test program contains any disabled tests. - -{: .callout .tip} -TIP: You can easily count the number of disabled tests you have using -`grep`. This number can be used as a metric for -improving your test quality. - -#### Temporarily Enabling Disabled Tests - -To include disabled tests in test execution, just invoke the test program with -the `--gtest_also_run_disabled_tests` flag or set the -`GTEST_ALSO_RUN_DISABLED_TESTS` environment variable to a value other than `0`. -You can combine this with the `--gtest_filter` flag to further select which -disabled tests to run. - -### Repeating the Tests - -Once in a while you'll run into a test whose result is hit-or-miss. Perhaps it -will fail only 1% of the time, making it rather hard to reproduce the bug under -a debugger. This can be a major source of frustration. - -The `--gtest_repeat` flag allows you to repeat all (or selected) test methods in -a program many times. Hopefully, a flaky test will eventually fail and give you -a chance to debug. Here's how to use it: - -```none -$ foo_test --gtest_repeat=1000 -Repeat foo_test 1000 times and don't stop at failures. - -$ foo_test --gtest_repeat=-1 -A negative count means repeating forever. - -$ foo_test --gtest_repeat=1000 --gtest_break_on_failure -Repeat foo_test 1000 times, stopping at the first failure. This -is especially useful when running under a debugger: when the test -fails, it will drop into the debugger and you can then inspect -variables and stacks. - -$ foo_test --gtest_repeat=1000 --gtest_filter=FooBar.* -Repeat the tests whose name matches the filter 1000 times. -``` - -If your test program contains -[global set-up/tear-down](#global-set-up-and-tear-down) code, it will be -repeated in each iteration as well, as the flakiness may be in it. You can also -specify the repeat count by setting the `GTEST_REPEAT` environment variable. - -### Shuffling the Tests - -You can specify the `--gtest_shuffle` flag (or set the `GTEST_SHUFFLE` -environment variable to `1`) to run the tests in a program in a random order. -This helps to reveal bad dependencies between tests. - -By default, googletest uses a random seed calculated from the current time. -Therefore you'll get a different order every time. The console output includes -the random seed value, such that you can reproduce an order-related test failure -later. To specify the random seed explicitly, use the `--gtest_random_seed=SEED` -flag (or set the `GTEST_RANDOM_SEED` environment variable), where `SEED` is an -integer in the range [0, 99999]. The seed value 0 is special: it tells -googletest to do the default behavior of calculating the seed from the current -time. - -If you combine this with `--gtest_repeat=N`, googletest will pick a different -random seed and re-shuffle the tests in each iteration. - -### Controlling Test Output - -#### Colored Terminal Output - -googletest can use colors in its terminal output to make it easier to spot the -important information: - -
    ...
-[----------] 1 test from FooTest
-[ RUN      ] FooTest.DoesAbc
-[       OK ] FooTest.DoesAbc
-[----------] 2 tests from BarTest
-[ RUN      ] BarTest.HasXyzProperty
-[       OK ] BarTest.HasXyzProperty
-[ RUN      ] BarTest.ReturnsTrueOnSuccess
-... some error messages ...
-[   FAILED ] BarTest.ReturnsTrueOnSuccess
-...
-[==========] 30 tests from 14 test suites ran.
-[   PASSED ] 28 tests.
-[   FAILED ] 2 tests, listed below:
-[   FAILED ] BarTest.ReturnsTrueOnSuccess
-[   FAILED ] AnotherTest.DoesXyz
-
- 2 FAILED TESTS
-
    - -You can set the `GTEST_COLOR` environment variable or the `--gtest_color` -command line flag to `yes`, `no`, or `auto` (the default) to enable colors, -disable colors, or let googletest decide. When the value is `auto`, googletest -will use colors if and only if the output goes to a terminal and (on non-Windows -platforms) the `TERM` environment variable is set to `xterm` or `xterm-color`. - -#### Suppressing test passes - -By default, googletest prints 1 line of output for each test, indicating if it -passed or failed. To show only test failures, run the test program with -`--gtest_brief=1`, or set the GTEST_BRIEF environment variable to `1`. - -#### Suppressing the Elapsed Time - -By default, googletest prints the time it takes to run each test. To disable -that, run the test program with the `--gtest_print_time=0` command line flag, or -set the GTEST_PRINT_TIME environment variable to `0`. - -#### Suppressing UTF-8 Text Output - -In case of assertion failures, googletest prints expected and actual values of -type `string` both as hex-encoded strings as well as in readable UTF-8 text if -they contain valid non-ASCII UTF-8 characters. If you want to suppress the UTF-8 -text because, for example, you don't have an UTF-8 compatible output medium, run -the test program with `--gtest_print_utf8=0` or set the `GTEST_PRINT_UTF8` -environment variable to `0`. - - - -#### Generating an XML Report - -googletest can emit a detailed XML report to a file in addition to its normal -textual output. The report contains the duration of each test, and thus can help -you identify slow tests. - -To generate the XML report, set the `GTEST_OUTPUT` environment variable or the -`--gtest_output` flag to the string `"xml:path_to_output_file"`, which will -create the file at the given location. You can also just use the string `"xml"`, -in which case the output can be found in the `test_detail.xml` file in the -current directory. - -If you specify a directory (for example, `"xml:output/directory/"` on Linux or -`"xml:output\directory\"` on Windows), googletest will create the XML file in -that directory, named after the test executable (e.g. `foo_test.xml` for test -program `foo_test` or `foo_test.exe`). If the file already exists (perhaps left -over from a previous run), googletest will pick a different name (e.g. -`foo_test_1.xml`) to avoid overwriting it. - -The report is based on the `junitreport` Ant task. Since that format was -originally intended for Java, a little interpretation is required to make it -apply to googletest tests, as shown here: - -```xml - - - - - - - - - -``` - -* The root `` element corresponds to the entire test program. -* `` elements correspond to googletest test suites. -* `` elements correspond to googletest test functions. - -For instance, the following program - -```c++ -TEST(MathTest, Addition) { ... } -TEST(MathTest, Subtraction) { ... } -TEST(LogicTest, NonContradiction) { ... } -``` - -could generate this report: - -```xml - - - - - ... - ... - - - - - - - - - -``` - -Things to note: - -* The `tests` attribute of a `` or `` element tells how - many test functions the googletest program or test suite contains, while the - `failures` attribute tells how many of them failed. - -* The `time` attribute expresses the duration of the test, test suite, or - entire test program in seconds. - -* The `timestamp` attribute records the local date and time of the test - execution. - -* Each `` element corresponds to a single failed googletest - assertion. - -#### Generating a JSON Report - -googletest can also emit a JSON report as an alternative format to XML. To -generate the JSON report, set the `GTEST_OUTPUT` environment variable or the -`--gtest_output` flag to the string `"json:path_to_output_file"`, which will -create the file at the given location. You can also just use the string -`"json"`, in which case the output can be found in the `test_detail.json` file -in the current directory. - -The report format conforms to the following JSON Schema: - -```json -{ - "$schema": "http://json-schema.org/schema#", - "type": "object", - "definitions": { - "TestCase": { - "type": "object", - "properties": { - "name": { "type": "string" }, - "tests": { "type": "integer" }, - "failures": { "type": "integer" }, - "disabled": { "type": "integer" }, - "time": { "type": "string" }, - "testsuite": { - "type": "array", - "items": { - "$ref": "#/definitions/TestInfo" - } - } - } - }, - "TestInfo": { - "type": "object", - "properties": { - "name": { "type": "string" }, - "status": { - "type": "string", - "enum": ["RUN", "NOTRUN"] - }, - "time": { "type": "string" }, - "classname": { "type": "string" }, - "failures": { - "type": "array", - "items": { - "$ref": "#/definitions/Failure" - } - } - } - }, - "Failure": { - "type": "object", - "properties": { - "failures": { "type": "string" }, - "type": { "type": "string" } - } - } - }, - "properties": { - "tests": { "type": "integer" }, - "failures": { "type": "integer" }, - "disabled": { "type": "integer" }, - "errors": { "type": "integer" }, - "timestamp": { - "type": "string", - "format": "date-time" - }, - "time": { "type": "string" }, - "name": { "type": "string" }, - "testsuites": { - "type": "array", - "items": { - "$ref": "#/definitions/TestCase" - } - } - } -} -``` - -The report uses the format that conforms to the following Proto3 using the -[JSON encoding](https://developers.google.com/protocol-buffers/docs/proto3#json): - -```proto -syntax = "proto3"; - -package googletest; - -import "google/protobuf/timestamp.proto"; -import "google/protobuf/duration.proto"; - -message UnitTest { - int32 tests = 1; - int32 failures = 2; - int32 disabled = 3; - int32 errors = 4; - google.protobuf.Timestamp timestamp = 5; - google.protobuf.Duration time = 6; - string name = 7; - repeated TestCase testsuites = 8; -} - -message TestCase { - string name = 1; - int32 tests = 2; - int32 failures = 3; - int32 disabled = 4; - int32 errors = 5; - google.protobuf.Duration time = 6; - repeated TestInfo testsuite = 7; -} - -message TestInfo { - string name = 1; - enum Status { - RUN = 0; - NOTRUN = 1; - } - Status status = 2; - google.protobuf.Duration time = 3; - string classname = 4; - message Failure { - string failures = 1; - string type = 2; - } - repeated Failure failures = 5; -} -``` - -For instance, the following program - -```c++ -TEST(MathTest, Addition) { ... } -TEST(MathTest, Subtraction) { ... } -TEST(LogicTest, NonContradiction) { ... } -``` - -could generate this report: - -```json -{ - "tests": 3, - "failures": 1, - "errors": 0, - "time": "0.035s", - "timestamp": "2011-10-31T18:52:42Z", - "name": "AllTests", - "testsuites": [ - { - "name": "MathTest", - "tests": 2, - "failures": 1, - "errors": 0, - "time": "0.015s", - "testsuite": [ - { - "name": "Addition", - "status": "RUN", - "time": "0.007s", - "classname": "", - "failures": [ - { - "message": "Value of: add(1, 1)\n Actual: 3\nExpected: 2", - "type": "" - }, - { - "message": "Value of: add(1, -1)\n Actual: 1\nExpected: 0", - "type": "" - } - ] - }, - { - "name": "Subtraction", - "status": "RUN", - "time": "0.005s", - "classname": "" - } - ] - }, - { - "name": "LogicTest", - "tests": 1, - "failures": 0, - "errors": 0, - "time": "0.005s", - "testsuite": [ - { - "name": "NonContradiction", - "status": "RUN", - "time": "0.005s", - "classname": "" - } - ] - } - ] -} -``` - -{: .callout .important} -IMPORTANT: The exact format of the JSON document is subject to change. - -### Controlling How Failures Are Reported - -#### Detecting Test Premature Exit - -Google Test implements the _premature-exit-file_ protocol for test runners -to catch any kind of unexpected exits of test programs. Upon start, -Google Test creates the file which will be automatically deleted after -all work has been finished. Then, the test runner can check if this file -exists. In case the file remains undeleted, the inspected test has exited -prematurely. - -This feature is enabled only if the `TEST_PREMATURE_EXIT_FILE` environment -variable has been set. - -#### Turning Assertion Failures into Break-Points - -When running test programs under a debugger, it's very convenient if the -debugger can catch an assertion failure and automatically drop into interactive -mode. googletest's *break-on-failure* mode supports this behavior. - -To enable it, set the `GTEST_BREAK_ON_FAILURE` environment variable to a value -other than `0`. Alternatively, you can use the `--gtest_break_on_failure` -command line flag. - -#### Disabling Catching Test-Thrown Exceptions - -googletest can be used either with or without exceptions enabled. If a test -throws a C++ exception or (on Windows) a structured exception (SEH), by default -googletest catches it, reports it as a test failure, and continues with the next -test method. This maximizes the coverage of a test run. Also, on Windows an -uncaught exception will cause a pop-up window, so catching the exceptions allows -you to run the tests automatically. - -When debugging the test failures, however, you may instead want the exceptions -to be handled by the debugger, such that you can examine the call stack when an -exception is thrown. To achieve that, set the `GTEST_CATCH_EXCEPTIONS` -environment variable to `0`, or use the `--gtest_catch_exceptions=0` flag when -running the tests. - -### Sanitizer Integration - -The -[Undefined Behavior Sanitizer](https://clang.llvm.org/docs/UndefinedBehaviorSanitizer.html), -[Address Sanitizer](https://github.com/google/sanitizers/wiki/AddressSanitizer), -and -[Thread Sanitizer](https://github.com/google/sanitizers/wiki/ThreadSanitizerCppManual) -all provide weak functions that you can override to trigger explicit failures -when they detect sanitizer errors, such as creating a reference from `nullptr`. -To override these functions, place definitions for them in a source file that -you compile as part of your main binary: - -``` -extern "C" { -void __ubsan_on_report() { - FAIL() << "Encountered an undefined behavior sanitizer error"; -} -void __asan_on_error() { - FAIL() << "Encountered an address sanitizer error"; -} -void __tsan_on_report() { - FAIL() << "Encountered a thread sanitizer error"; -} -} // extern "C" -``` - -After compiling your project with one of the sanitizers enabled, if a particular -test triggers a sanitizer error, googletest will report that it failed. diff --git a/external/googletest/docs/assets/css/style.scss b/external/googletest/docs/assets/css/style.scss deleted file mode 100644 index bb30f418da..0000000000 --- a/external/googletest/docs/assets/css/style.scss +++ /dev/null @@ -1,5 +0,0 @@ ---- ---- - -@import "jekyll-theme-primer"; -@import "main"; diff --git a/external/googletest/docs/community_created_documentation.md b/external/googletest/docs/community_created_documentation.md deleted file mode 100644 index 4569075ff2..0000000000 --- a/external/googletest/docs/community_created_documentation.md +++ /dev/null @@ -1,7 +0,0 @@ -# Community-Created Documentation - -The following is a list, in no particular order, of links to documentation -created by the Googletest community. - -* [Googlemock Insights](https://github.com/ElectricRCAircraftGuy/eRCaGuy_dotfiles/blob/master/googletest/insights.md), - by [ElectricRCAircraftGuy](https://github.com/ElectricRCAircraftGuy) diff --git a/external/googletest/docs/faq.md b/external/googletest/docs/faq.md deleted file mode 100644 index 9042da1efb..0000000000 --- a/external/googletest/docs/faq.md +++ /dev/null @@ -1,693 +0,0 @@ -# Googletest FAQ - -## Why should test suite names and test names not contain underscore? - -{: .callout .note} -Note: Googletest reserves underscore (`_`) for special purpose keywords, such as -[the `DISABLED_` prefix](advanced.md#temporarily-disabling-tests), in addition -to the following rationale. - -Underscore (`_`) is special, as C++ reserves the following to be used by the -compiler and the standard library: - -1. any identifier that starts with an `_` followed by an upper-case letter, and -2. any identifier that contains two consecutive underscores (i.e. `__`) - *anywhere* in its name. - -User code is *prohibited* from using such identifiers. - -Now let's look at what this means for `TEST` and `TEST_F`. - -Currently `TEST(TestSuiteName, TestName)` generates a class named -`TestSuiteName_TestName_Test`. What happens if `TestSuiteName` or `TestName` -contains `_`? - -1. If `TestSuiteName` starts with an `_` followed by an upper-case letter (say, - `_Foo`), we end up with `_Foo_TestName_Test`, which is reserved and thus - invalid. -2. If `TestSuiteName` ends with an `_` (say, `Foo_`), we get - `Foo__TestName_Test`, which is invalid. -3. If `TestName` starts with an `_` (say, `_Bar`), we get - `TestSuiteName__Bar_Test`, which is invalid. -4. If `TestName` ends with an `_` (say, `Bar_`), we get - `TestSuiteName_Bar__Test`, which is invalid. - -So clearly `TestSuiteName` and `TestName` cannot start or end with `_` -(Actually, `TestSuiteName` can start with `_` -- as long as the `_` isn't -followed by an upper-case letter. But that's getting complicated. So for -simplicity we just say that it cannot start with `_`.). - -It may seem fine for `TestSuiteName` and `TestName` to contain `_` in the -middle. However, consider this: - -```c++ -TEST(Time, Flies_Like_An_Arrow) { ... } -TEST(Time_Flies, Like_An_Arrow) { ... } -``` - -Now, the two `TEST`s will both generate the same class -(`Time_Flies_Like_An_Arrow_Test`). That's not good. - -So for simplicity, we just ask the users to avoid `_` in `TestSuiteName` and -`TestName`. The rule is more constraining than necessary, but it's simple and -easy to remember. It also gives googletest some wiggle room in case its -implementation needs to change in the future. - -If you violate the rule, there may not be immediate consequences, but your test -may (just may) break with a new compiler (or a new version of the compiler you -are using) or with a new version of googletest. Therefore it's best to follow -the rule. - -## Why does googletest support `EXPECT_EQ(NULL, ptr)` and `ASSERT_EQ(NULL, ptr)` but not `EXPECT_NE(NULL, ptr)` and `ASSERT_NE(NULL, ptr)`? - -First of all, you can use `nullptr` with each of these macros, e.g. -`EXPECT_EQ(ptr, nullptr)`, `EXPECT_NE(ptr, nullptr)`, `ASSERT_EQ(ptr, nullptr)`, -`ASSERT_NE(ptr, nullptr)`. This is the preferred syntax in the style guide -because `nullptr` does not have the type problems that `NULL` does. - -Due to some peculiarity of C++, it requires some non-trivial template meta -programming tricks to support using `NULL` as an argument of the `EXPECT_XX()` -and `ASSERT_XX()` macros. Therefore we only do it where it's most needed -(otherwise we make the implementation of googletest harder to maintain and more -error-prone than necessary). - -Historically, the `EXPECT_EQ()` macro took the *expected* value as its first -argument and the *actual* value as the second, though this argument order is now -discouraged. It was reasonable that someone wanted -to write `EXPECT_EQ(NULL, some_expression)`, and this indeed was requested -several times. Therefore we implemented it. - -The need for `EXPECT_NE(NULL, ptr)` wasn't nearly as strong. When the assertion -fails, you already know that `ptr` must be `NULL`, so it doesn't add any -information to print `ptr` in this case. That means `EXPECT_TRUE(ptr != NULL)` -works just as well. - -If we were to support `EXPECT_NE(NULL, ptr)`, for consistency we'd have to -support `EXPECT_NE(ptr, NULL)` as well. This means using the template meta -programming tricks twice in the implementation, making it even harder to -understand and maintain. We believe the benefit doesn't justify the cost. - -Finally, with the growth of the gMock matcher library, we are encouraging people -to use the unified `EXPECT_THAT(value, matcher)` syntax more often in tests. One -significant advantage of the matcher approach is that matchers can be easily -combined to form new matchers, while the `EXPECT_NE`, etc, macros cannot be -easily combined. Therefore we want to invest more in the matchers than in the -`EXPECT_XX()` macros. - -## I need to test that different implementations of an interface satisfy some common requirements. Should I use typed tests or value-parameterized tests? - -For testing various implementations of the same interface, either typed tests or -value-parameterized tests can get it done. It's really up to you the user to -decide which is more convenient for you, depending on your particular case. Some -rough guidelines: - -* Typed tests can be easier to write if instances of the different - implementations can be created the same way, modulo the type. For example, - if all these implementations have a public default constructor (such that - you can write `new TypeParam`), or if their factory functions have the same - form (e.g. `CreateInstance()`). -* Value-parameterized tests can be easier to write if you need different code - patterns to create different implementations' instances, e.g. `new Foo` vs - `new Bar(5)`. To accommodate for the differences, you can write factory - function wrappers and pass these function pointers to the tests as their - parameters. -* When a typed test fails, the default output includes the name of the type, - which can help you quickly identify which implementation is wrong. - Value-parameterized tests only show the number of the failed iteration by - default. You will need to define a function that returns the iteration name - and pass it as the third parameter to INSTANTIATE_TEST_SUITE_P to have more - useful output. -* When using typed tests, you need to make sure you are testing against the - interface type, not the concrete types (in other words, you want to make - sure `implicit_cast(my_concrete_impl)` works, not just that - `my_concrete_impl` works). It's less likely to make mistakes in this area - when using value-parameterized tests. - -I hope I didn't confuse you more. :-) If you don't mind, I'd suggest you to give -both approaches a try. Practice is a much better way to grasp the subtle -differences between the two tools. Once you have some concrete experience, you -can much more easily decide which one to use the next time. - -## I got some run-time errors about invalid proto descriptors when using `ProtocolMessageEquals`. Help! - -{: .callout .note} -**Note:** `ProtocolMessageEquals` and `ProtocolMessageEquiv` are *deprecated* -now. Please use `EqualsProto`, etc instead. - -`ProtocolMessageEquals` and `ProtocolMessageEquiv` were redefined recently and -are now less tolerant of invalid protocol buffer definitions. In particular, if -you have a `foo.proto` that doesn't fully qualify the type of a protocol message -it references (e.g. `message` where it should be `message`), you -will now get run-time errors like: - -``` -... descriptor.cc:...] Invalid proto descriptor for file "path/to/foo.proto": -... descriptor.cc:...] blah.MyMessage.my_field: ".Bar" is not defined. -``` - -If you see this, your `.proto` file is broken and needs to be fixed by making -the types fully qualified. The new definition of `ProtocolMessageEquals` and -`ProtocolMessageEquiv` just happen to reveal your bug. - -## My death test modifies some state, but the change seems lost after the death test finishes. Why? - -Death tests (`EXPECT_DEATH`, etc) are executed in a sub-process s.t. the -expected crash won't kill the test program (i.e. the parent process). As a -result, any in-memory side effects they incur are observable in their respective -sub-processes, but not in the parent process. You can think of them as running -in a parallel universe, more or less. - -In particular, if you use mocking and the death test statement invokes some mock -methods, the parent process will think the calls have never occurred. Therefore, -you may want to move your `EXPECT_CALL` statements inside the `EXPECT_DEATH` -macro. - -## EXPECT_EQ(htonl(blah), blah_blah) generates weird compiler errors in opt mode. Is this a googletest bug? - -Actually, the bug is in `htonl()`. - -According to `'man htonl'`, `htonl()` is a *function*, which means it's valid to -use `htonl` as a function pointer. However, in opt mode `htonl()` is defined as -a *macro*, which breaks this usage. - -Worse, the macro definition of `htonl()` uses a `gcc` extension and is *not* -standard C++. That hacky implementation has some ad hoc limitations. In -particular, it prevents you from writing `Foo()`, where `Foo` -is a template that has an integral argument. - -The implementation of `EXPECT_EQ(a, b)` uses `sizeof(... a ...)` inside a -template argument, and thus doesn't compile in opt mode when `a` contains a call -to `htonl()`. It is difficult to make `EXPECT_EQ` bypass the `htonl()` bug, as -the solution must work with different compilers on various platforms. - -## The compiler complains about "undefined references" to some static const member variables, but I did define them in the class body. What's wrong? - -If your class has a static data member: - -```c++ -// foo.h -class Foo { - ... - static const int kBar = 100; -}; -``` - -You also need to define it *outside* of the class body in `foo.cc`: - -```c++ -const int Foo::kBar; // No initializer here. -``` - -Otherwise your code is **invalid C++**, and may break in unexpected ways. In -particular, using it in googletest comparison assertions (`EXPECT_EQ`, etc) will -generate an "undefined reference" linker error. The fact that "it used to work" -doesn't mean it's valid. It just means that you were lucky. :-) - -If the declaration of the static data member is `constexpr` then it is -implicitly an `inline` definition, and a separate definition in `foo.cc` is not -needed: - -```c++ -// foo.h -class Foo { - ... - static constexpr int kBar = 100; // Defines kBar, no need to do it in foo.cc. -}; -``` - -## Can I derive a test fixture from another? - -Yes. - -Each test fixture has a corresponding and same named test suite. This means only -one test suite can use a particular fixture. Sometimes, however, multiple test -cases may want to use the same or slightly different fixtures. For example, you -may want to make sure that all of a GUI library's test suites don't leak -important system resources like fonts and brushes. - -In googletest, you share a fixture among test suites by putting the shared logic -in a base test fixture, then deriving from that base a separate fixture for each -test suite that wants to use this common logic. You then use `TEST_F()` to write -tests using each derived fixture. - -Typically, your code looks like this: - -```c++ -// Defines a base test fixture. -class BaseTest : public ::testing::Test { - protected: - ... -}; - -// Derives a fixture FooTest from BaseTest. -class FooTest : public BaseTest { - protected: - void SetUp() override { - BaseTest::SetUp(); // Sets up the base fixture first. - ... additional set-up work ... - } - - void TearDown() override { - ... clean-up work for FooTest ... - BaseTest::TearDown(); // Remember to tear down the base fixture - // after cleaning up FooTest! - } - - ... functions and variables for FooTest ... -}; - -// Tests that use the fixture FooTest. -TEST_F(FooTest, Bar) { ... } -TEST_F(FooTest, Baz) { ... } - -... additional fixtures derived from BaseTest ... -``` - -If necessary, you can continue to derive test fixtures from a derived fixture. -googletest has no limit on how deep the hierarchy can be. - -For a complete example using derived test fixtures, see -[sample5_unittest.cc](https://github.com/google/googletest/blob/master/googletest/samples/sample5_unittest.cc). - -## My compiler complains "void value not ignored as it ought to be." What does this mean? - -You're probably using an `ASSERT_*()` in a function that doesn't return `void`. -`ASSERT_*()` can only be used in `void` functions, due to exceptions being -disabled by our build system. Please see more details -[here](advanced.md#assertion-placement). - -## My death test hangs (or seg-faults). How do I fix it? - -In googletest, death tests are run in a child process and the way they work is -delicate. To write death tests you really need to understand how they work—see -the details at [Death Assertions](reference/assertions.md#death) in the -Assertions Reference. - -In particular, death tests don't like having multiple threads in the parent -process. So the first thing you can try is to eliminate creating threads outside -of `EXPECT_DEATH()`. For example, you may want to use mocks or fake objects -instead of real ones in your tests. - -Sometimes this is impossible as some library you must use may be creating -threads before `main()` is even reached. In this case, you can try to minimize -the chance of conflicts by either moving as many activities as possible inside -`EXPECT_DEATH()` (in the extreme case, you want to move everything inside), or -leaving as few things as possible in it. Also, you can try to set the death test -style to `"threadsafe"`, which is safer but slower, and see if it helps. - -If you go with thread-safe death tests, remember that they rerun the test -program from the beginning in the child process. Therefore make sure your -program can run side-by-side with itself and is deterministic. - -In the end, this boils down to good concurrent programming. You have to make -sure that there are no race conditions or deadlocks in your program. No silver -bullet - sorry! - -## Should I use the constructor/destructor of the test fixture or SetUp()/TearDown()? {#CtorVsSetUp} - -The first thing to remember is that googletest does **not** reuse the same test -fixture object across multiple tests. For each `TEST_F`, googletest will create -a **fresh** test fixture object, immediately call `SetUp()`, run the test body, -call `TearDown()`, and then delete the test fixture object. - -When you need to write per-test set-up and tear-down logic, you have the choice -between using the test fixture constructor/destructor or `SetUp()/TearDown()`. -The former is usually preferred, as it has the following benefits: - -* By initializing a member variable in the constructor, we have the option to - make it `const`, which helps prevent accidental changes to its value and - makes the tests more obviously correct. -* In case we need to subclass the test fixture class, the subclass' - constructor is guaranteed to call the base class' constructor *first*, and - the subclass' destructor is guaranteed to call the base class' destructor - *afterward*. With `SetUp()/TearDown()`, a subclass may make the mistake of - forgetting to call the base class' `SetUp()/TearDown()` or call them at the - wrong time. - -You may still want to use `SetUp()/TearDown()` in the following cases: - -* C++ does not allow virtual function calls in constructors and destructors. - You can call a method declared as virtual, but it will not use dynamic - dispatch, it will use the definition from the class the constructor of which - is currently executing. This is because calling a virtual method before the - derived class constructor has a chance to run is very dangerous - the - virtual method might operate on uninitialized data. Therefore, if you need - to call a method that will be overridden in a derived class, you have to use - `SetUp()/TearDown()`. -* In the body of a constructor (or destructor), it's not possible to use the - `ASSERT_xx` macros. Therefore, if the set-up operation could cause a fatal - test failure that should prevent the test from running, it's necessary to - use `abort` and abort the whole test - executable, or to use `SetUp()` instead of a constructor. -* If the tear-down operation could throw an exception, you must use - `TearDown()` as opposed to the destructor, as throwing in a destructor leads - to undefined behavior and usually will kill your program right away. Note - that many standard libraries (like STL) may throw when exceptions are - enabled in the compiler. Therefore you should prefer `TearDown()` if you - want to write portable tests that work with or without exceptions. -* The googletest team is considering making the assertion macros throw on - platforms where exceptions are enabled (e.g. Windows, Mac OS, and Linux - client-side), which will eliminate the need for the user to propagate - failures from a subroutine to its caller. Therefore, you shouldn't use - googletest assertions in a destructor if your code could run on such a - platform. - -## The compiler complains "no matching function to call" when I use ASSERT_PRED*. How do I fix it? - -See details for [`EXPECT_PRED*`](reference/assertions.md#EXPECT_PRED) in the -Assertions Reference. - -## My compiler complains about "ignoring return value" when I call RUN_ALL_TESTS(). Why? - -Some people had been ignoring the return value of `RUN_ALL_TESTS()`. That is, -instead of - -```c++ - return RUN_ALL_TESTS(); -``` - -they write - -```c++ - RUN_ALL_TESTS(); -``` - -This is **wrong and dangerous**. The testing services needs to see the return -value of `RUN_ALL_TESTS()` in order to determine if a test has passed. If your -`main()` function ignores it, your test will be considered successful even if it -has a googletest assertion failure. Very bad. - -We have decided to fix this (thanks to Michael Chastain for the idea). Now, your -code will no longer be able to ignore `RUN_ALL_TESTS()` when compiled with -`gcc`. If you do so, you'll get a compiler error. - -If you see the compiler complaining about you ignoring the return value of -`RUN_ALL_TESTS()`, the fix is simple: just make sure its value is used as the -return value of `main()`. - -But how could we introduce a change that breaks existing tests? Well, in this -case, the code was already broken in the first place, so we didn't break it. :-) - -## My compiler complains that a constructor (or destructor) cannot return a value. What's going on? - -Due to a peculiarity of C++, in order to support the syntax for streaming -messages to an `ASSERT_*`, e.g. - -```c++ - ASSERT_EQ(1, Foo()) << "blah blah" << foo; -``` - -we had to give up using `ASSERT*` and `FAIL*` (but not `EXPECT*` and -`ADD_FAILURE*`) in constructors and destructors. The workaround is to move the -content of your constructor/destructor to a private void member function, or -switch to `EXPECT_*()` if that works. This -[section](advanced.md#assertion-placement) in the user's guide explains it. - -## My SetUp() function is not called. Why? - -C++ is case-sensitive. Did you spell it as `Setup()`? - -Similarly, sometimes people spell `SetUpTestSuite()` as `SetupTestSuite()` and -wonder why it's never called. - - -## I have several test suites which share the same test fixture logic, do I have to define a new test fixture class for each of them? This seems pretty tedious. - -You don't have to. Instead of - -```c++ -class FooTest : public BaseTest {}; - -TEST_F(FooTest, Abc) { ... } -TEST_F(FooTest, Def) { ... } - -class BarTest : public BaseTest {}; - -TEST_F(BarTest, Abc) { ... } -TEST_F(BarTest, Def) { ... } -``` - -you can simply `typedef` the test fixtures: - -```c++ -typedef BaseTest FooTest; - -TEST_F(FooTest, Abc) { ... } -TEST_F(FooTest, Def) { ... } - -typedef BaseTest BarTest; - -TEST_F(BarTest, Abc) { ... } -TEST_F(BarTest, Def) { ... } -``` - -## googletest output is buried in a whole bunch of LOG messages. What do I do? - -The googletest output is meant to be a concise and human-friendly report. If -your test generates textual output itself, it will mix with the googletest -output, making it hard to read. However, there is an easy solution to this -problem. - -Since `LOG` messages go to stderr, we decided to let googletest output go to -stdout. This way, you can easily separate the two using redirection. For -example: - -```shell -$ ./my_test > gtest_output.txt -``` - -## Why should I prefer test fixtures over global variables? - -There are several good reasons: - -1. It's likely your test needs to change the states of its global variables. - This makes it difficult to keep side effects from escaping one test and - contaminating others, making debugging difficult. By using fixtures, each - test has a fresh set of variables that's different (but with the same - names). Thus, tests are kept independent of each other. -2. Global variables pollute the global namespace. -3. Test fixtures can be reused via subclassing, which cannot be done easily - with global variables. This is useful if many test suites have something in - common. - -## What can the statement argument in ASSERT_DEATH() be? - -`ASSERT_DEATH(statement, matcher)` (or any death assertion macro) can be used -wherever *`statement`* is valid. So basically *`statement`* can be any C++ -statement that makes sense in the current context. In particular, it can -reference global and/or local variables, and can be: - -* a simple function call (often the case), -* a complex expression, or -* a compound statement. - -Some examples are shown here: - -```c++ -// A death test can be a simple function call. -TEST(MyDeathTest, FunctionCall) { - ASSERT_DEATH(Xyz(5), "Xyz failed"); -} - -// Or a complex expression that references variables and functions. -TEST(MyDeathTest, ComplexExpression) { - const bool c = Condition(); - ASSERT_DEATH((c ? Func1(0) : object2.Method("test")), - "(Func1|Method) failed"); -} - -// Death assertions can be used anywhere in a function. In -// particular, they can be inside a loop. -TEST(MyDeathTest, InsideLoop) { - // Verifies that Foo(0), Foo(1), ..., and Foo(4) all die. - for (int i = 0; i < 5; i++) { - EXPECT_DEATH_M(Foo(i), "Foo has \\d+ errors", - ::testing::Message() << "where i is " << i); - } -} - -// A death assertion can contain a compound statement. -TEST(MyDeathTest, CompoundStatement) { - // Verifies that at lease one of Bar(0), Bar(1), ..., and - // Bar(4) dies. - ASSERT_DEATH({ - for (int i = 0; i < 5; i++) { - Bar(i); - } - }, - "Bar has \\d+ errors"); -} -``` - -## I have a fixture class `FooTest`, but `TEST_F(FooTest, Bar)` gives me error ``"no matching function for call to `FooTest::FooTest()'"``. Why? - -Googletest needs to be able to create objects of your test fixture class, so it -must have a default constructor. Normally the compiler will define one for you. -However, there are cases where you have to define your own: - -* If you explicitly declare a non-default constructor for class `FooTest` - (`DISALLOW_EVIL_CONSTRUCTORS()` does this), then you need to define a - default constructor, even if it would be empty. -* If `FooTest` has a const non-static data member, then you have to define the - default constructor *and* initialize the const member in the initializer - list of the constructor. (Early versions of `gcc` doesn't force you to - initialize the const member. It's a bug that has been fixed in `gcc 4`.) - -## Why does ASSERT_DEATH complain about previous threads that were already joined? - -With the Linux pthread library, there is no turning back once you cross the line -from a single thread to multiple threads. The first time you create a thread, a -manager thread is created in addition, so you get 3, not 2, threads. Later when -the thread you create joins the main thread, the thread count decrements by 1, -but the manager thread will never be killed, so you still have 2 threads, which -means you cannot safely run a death test. - -The new NPTL thread library doesn't suffer from this problem, as it doesn't -create a manager thread. However, if you don't control which machine your test -runs on, you shouldn't depend on this. - -## Why does googletest require the entire test suite, instead of individual tests, to be named *DeathTest when it uses ASSERT_DEATH? - -googletest does not interleave tests from different test suites. That is, it -runs all tests in one test suite first, and then runs all tests in the next test -suite, and so on. googletest does this because it needs to set up a test suite -before the first test in it is run, and tear it down afterwards. Splitting up -the test case would require multiple set-up and tear-down processes, which is -inefficient and makes the semantics unclean. - -If we were to determine the order of tests based on test name instead of test -case name, then we would have a problem with the following situation: - -```c++ -TEST_F(FooTest, AbcDeathTest) { ... } -TEST_F(FooTest, Uvw) { ... } - -TEST_F(BarTest, DefDeathTest) { ... } -TEST_F(BarTest, Xyz) { ... } -``` - -Since `FooTest.AbcDeathTest` needs to run before `BarTest.Xyz`, and we don't -interleave tests from different test suites, we need to run all tests in the -`FooTest` case before running any test in the `BarTest` case. This contradicts -with the requirement to run `BarTest.DefDeathTest` before `FooTest.Uvw`. - -## But I don't like calling my entire test suite \*DeathTest when it contains both death tests and non-death tests. What do I do? - -You don't have to, but if you like, you may split up the test suite into -`FooTest` and `FooDeathTest`, where the names make it clear that they are -related: - -```c++ -class FooTest : public ::testing::Test { ... }; - -TEST_F(FooTest, Abc) { ... } -TEST_F(FooTest, Def) { ... } - -using FooDeathTest = FooTest; - -TEST_F(FooDeathTest, Uvw) { ... EXPECT_DEATH(...) ... } -TEST_F(FooDeathTest, Xyz) { ... ASSERT_DEATH(...) ... } -``` - -## googletest prints the LOG messages in a death test's child process only when the test fails. How can I see the LOG messages when the death test succeeds? - -Printing the LOG messages generated by the statement inside `EXPECT_DEATH()` -makes it harder to search for real problems in the parent's log. Therefore, -googletest only prints them when the death test has failed. - -If you really need to see such LOG messages, a workaround is to temporarily -break the death test (e.g. by changing the regex pattern it is expected to -match). Admittedly, this is a hack. We'll consider a more permanent solution -after the fork-and-exec-style death tests are implemented. - -## The compiler complains about `no match for 'operator<<'` when I use an assertion. What gives? - -If you use a user-defined type `FooType` in an assertion, you must make sure -there is an `std::ostream& operator<<(std::ostream&, const FooType&)` function -defined such that we can print a value of `FooType`. - -In addition, if `FooType` is declared in a name space, the `<<` operator also -needs to be defined in the *same* name space. See -[Tip of the Week #49](http://abseil.io/tips/49) for details. - -## How do I suppress the memory leak messages on Windows? - -Since the statically initialized googletest singleton requires allocations on -the heap, the Visual C++ memory leak detector will report memory leaks at the -end of the program run. The easiest way to avoid this is to use the -`_CrtMemCheckpoint` and `_CrtMemDumpAllObjectsSince` calls to not report any -statically initialized heap objects. See MSDN for more details and additional -heap check/debug routines. - -## How can my code detect if it is running in a test? - -If you write code that sniffs whether it's running in a test and does different -things accordingly, you are leaking test-only logic into production code and -there is no easy way to ensure that the test-only code paths aren't run by -mistake in production. Such cleverness also leads to -[Heisenbugs](https://en.wikipedia.org/wiki/Heisenbug). Therefore we strongly -advise against the practice, and googletest doesn't provide a way to do it. - -In general, the recommended way to cause the code to behave differently under -test is [Dependency Injection](http://en.wikipedia.org/wiki/Dependency_injection). You can inject -different functionality from the test and from the production code. Since your -production code doesn't link in the for-test logic at all (the -[`testonly`](http://docs.bazel.build/versions/master/be/common-definitions.html#common.testonly) attribute for BUILD targets helps to ensure -that), there is no danger in accidentally running it. - -However, if you *really*, *really*, *really* have no choice, and if you follow -the rule of ending your test program names with `_test`, you can use the -*horrible* hack of sniffing your executable name (`argv[0]` in `main()`) to know -whether the code is under test. - -## How do I temporarily disable a test? - -If you have a broken test that you cannot fix right away, you can add the -`DISABLED_` prefix to its name. This will exclude it from execution. This is -better than commenting out the code or using `#if 0`, as disabled tests are -still compiled (and thus won't rot). - -To include disabled tests in test execution, just invoke the test program with -the `--gtest_also_run_disabled_tests` flag. - -## Is it OK if I have two separate `TEST(Foo, Bar)` test methods defined in different namespaces? - -Yes. - -The rule is **all test methods in the same test suite must use the same fixture -class.** This means that the following is **allowed** because both tests use the -same fixture class (`::testing::Test`). - -```c++ -namespace foo { -TEST(CoolTest, DoSomething) { - SUCCEED(); -} -} // namespace foo - -namespace bar { -TEST(CoolTest, DoSomething) { - SUCCEED(); -} -} // namespace bar -``` - -However, the following code is **not allowed** and will produce a runtime error -from googletest because the test methods are using different test fixture -classes with the same test suite name. - -```c++ -namespace foo { -class CoolTest : public ::testing::Test {}; // Fixture foo::CoolTest -TEST_F(CoolTest, DoSomething) { - SUCCEED(); -} -} // namespace foo - -namespace bar { -class CoolTest : public ::testing::Test {}; // Fixture: bar::CoolTest -TEST_F(CoolTest, DoSomething) { - SUCCEED(); -} -} // namespace bar -``` diff --git a/external/googletest/docs/gmock_cheat_sheet.md b/external/googletest/docs/gmock_cheat_sheet.md deleted file mode 100644 index 17ed7a54d8..0000000000 --- a/external/googletest/docs/gmock_cheat_sheet.md +++ /dev/null @@ -1,241 +0,0 @@ -# gMock Cheat Sheet - -## Defining a Mock Class - -### Mocking a Normal Class {#MockClass} - -Given - -```cpp -class Foo { - ... - virtual ~Foo(); - virtual int GetSize() const = 0; - virtual string Describe(const char* name) = 0; - virtual string Describe(int type) = 0; - virtual bool Process(Bar elem, int count) = 0; -}; -``` - -(note that `~Foo()` **must** be virtual) we can define its mock as - -```cpp -#include "gmock/gmock.h" - -class MockFoo : public Foo { - ... - MOCK_METHOD(int, GetSize, (), (const, override)); - MOCK_METHOD(string, Describe, (const char* name), (override)); - MOCK_METHOD(string, Describe, (int type), (override)); - MOCK_METHOD(bool, Process, (Bar elem, int count), (override)); -}; -``` - -To create a "nice" mock, which ignores all uninteresting calls, a "naggy" mock, -which warns on all uninteresting calls, or a "strict" mock, which treats them as -failures: - -```cpp -using ::testing::NiceMock; -using ::testing::NaggyMock; -using ::testing::StrictMock; - -NiceMock nice_foo; // The type is a subclass of MockFoo. -NaggyMock naggy_foo; // The type is a subclass of MockFoo. -StrictMock strict_foo; // The type is a subclass of MockFoo. -``` - -{: .callout .note} -**Note:** A mock object is currently naggy by default. We may make it nice by -default in the future. - -### Mocking a Class Template {#MockTemplate} - -Class templates can be mocked just like any class. - -To mock - -```cpp -template -class StackInterface { - ... - virtual ~StackInterface(); - virtual int GetSize() const = 0; - virtual void Push(const Elem& x) = 0; -}; -``` - -(note that all member functions that are mocked, including `~StackInterface()` -**must** be virtual). - -```cpp -template -class MockStack : public StackInterface { - ... - MOCK_METHOD(int, GetSize, (), (const, override)); - MOCK_METHOD(void, Push, (const Elem& x), (override)); -}; -``` - -### Specifying Calling Conventions for Mock Functions - -If your mock function doesn't use the default calling convention, you can -specify it by adding `Calltype(convention)` to `MOCK_METHOD`'s 4th parameter. -For example, - -```cpp - MOCK_METHOD(bool, Foo, (int n), (Calltype(STDMETHODCALLTYPE))); - MOCK_METHOD(int, Bar, (double x, double y), - (const, Calltype(STDMETHODCALLTYPE))); -``` - -where `STDMETHODCALLTYPE` is defined by `` on Windows. - -## Using Mocks in Tests {#UsingMocks} - -The typical work flow is: - -1. Import the gMock names you need to use. All gMock symbols are in the - `testing` namespace unless they are macros or otherwise noted. -2. Create the mock objects. -3. Optionally, set the default actions of the mock objects. -4. Set your expectations on the mock objects (How will they be called? What - will they do?). -5. Exercise code that uses the mock objects; if necessary, check the result - using googletest assertions. -6. When a mock object is destructed, gMock automatically verifies that all - expectations on it have been satisfied. - -Here's an example: - -```cpp -using ::testing::Return; // #1 - -TEST(BarTest, DoesThis) { - MockFoo foo; // #2 - - ON_CALL(foo, GetSize()) // #3 - .WillByDefault(Return(1)); - // ... other default actions ... - - EXPECT_CALL(foo, Describe(5)) // #4 - .Times(3) - .WillRepeatedly(Return("Category 5")); - // ... other expectations ... - - EXPECT_EQ(MyProductionFunction(&foo), "good"); // #5 -} // #6 -``` - -## Setting Default Actions {#OnCall} - -gMock has a **built-in default action** for any function that returns `void`, -`bool`, a numeric value, or a pointer. In C++11, it will additionally returns -the default-constructed value, if one exists for the given type. - -To customize the default action for functions with return type `T`, use -[`DefaultValue`](reference/mocking.md#DefaultValue). For example: - -```cpp - // Sets the default action for return type std::unique_ptr to - // creating a new Buzz every time. - DefaultValue>::SetFactory( - [] { return MakeUnique(AccessLevel::kInternal); }); - - // When this fires, the default action of MakeBuzz() will run, which - // will return a new Buzz object. - EXPECT_CALL(mock_buzzer_, MakeBuzz("hello")).Times(AnyNumber()); - - auto buzz1 = mock_buzzer_.MakeBuzz("hello"); - auto buzz2 = mock_buzzer_.MakeBuzz("hello"); - EXPECT_NE(buzz1, nullptr); - EXPECT_NE(buzz2, nullptr); - EXPECT_NE(buzz1, buzz2); - - // Resets the default action for return type std::unique_ptr, - // to avoid interfere with other tests. - DefaultValue>::Clear(); -``` - -To customize the default action for a particular method of a specific mock -object, use [`ON_CALL`](reference/mocking.md#ON_CALL). `ON_CALL` has a similar -syntax to `EXPECT_CALL`, but it is used for setting default behaviors when you -do not require that the mock method is called. See -[Knowing When to Expect](gmock_cook_book.md#UseOnCall) for a more detailed -discussion. - -## Setting Expectations {#ExpectCall} - -See [`EXPECT_CALL`](reference/mocking.md#EXPECT_CALL) in the Mocking Reference. - -## Matchers {#MatcherList} - -See the [Matchers Reference](reference/matchers.md). - -## Actions {#ActionList} - -See the [Actions Reference](reference/actions.md). - -## Cardinalities {#CardinalityList} - -See the [`Times` clause](reference/mocking.md#EXPECT_CALL.Times) of -`EXPECT_CALL` in the Mocking Reference. - -## Expectation Order - -By default, expectations can be matched in *any* order. If some or all -expectations must be matched in a given order, you can use the -[`After` clause](reference/mocking.md#EXPECT_CALL.After) or -[`InSequence` clause](reference/mocking.md#EXPECT_CALL.InSequence) of -`EXPECT_CALL`, or use an [`InSequence` object](reference/mocking.md#InSequence). - -## Verifying and Resetting a Mock - -gMock will verify the expectations on a mock object when it is destructed, or -you can do it earlier: - -```cpp -using ::testing::Mock; -... -// Verifies and removes the expectations on mock_obj; -// returns true if and only if successful. -Mock::VerifyAndClearExpectations(&mock_obj); -... -// Verifies and removes the expectations on mock_obj; -// also removes the default actions set by ON_CALL(); -// returns true if and only if successful. -Mock::VerifyAndClear(&mock_obj); -``` - -Do not set new expectations after verifying and clearing a mock after its use. -Setting expectations after code that exercises the mock has undefined behavior. -See [Using Mocks in Tests](gmock_for_dummies.md#using-mocks-in-tests) for more -information. - -You can also tell gMock that a mock object can be leaked and doesn't need to be -verified: - -```cpp -Mock::AllowLeak(&mock_obj); -``` - -## Mock Classes - -gMock defines a convenient mock class template - -```cpp -class MockFunction { - public: - MOCK_METHOD(R, Call, (A1, ..., An)); -}; -``` - -See this [recipe](gmock_cook_book.md#using-check-points) for one application of -it. - -## Flags - -| Flag | Description | -| :----------------------------- | :---------------------------------------- | -| `--gmock_catch_leaked_mocks=0` | Don't report leaked mock objects as failures. | -| `--gmock_verbose=LEVEL` | Sets the default verbosity level (`info`, `warning`, or `error`) of Google Mock messages. | diff --git a/external/googletest/docs/gmock_cook_book.md b/external/googletest/docs/gmock_cook_book.md deleted file mode 100644 index c08958eb16..0000000000 --- a/external/googletest/docs/gmock_cook_book.md +++ /dev/null @@ -1,4301 +0,0 @@ -# gMock Cookbook - -You can find recipes for using gMock here. If you haven't yet, please read -[the dummy guide](gmock_for_dummies.md) first to make sure you understand the -basics. - -{: .callout .note} -**Note:** gMock lives in the `testing` name space. For readability, it is -recommended to write `using ::testing::Foo;` once in your file before using the -name `Foo` defined by gMock. We omit such `using` statements in this section for -brevity, but you should do it in your own code. - -## Creating Mock Classes - -Mock classes are defined as normal classes, using the `MOCK_METHOD` macro to -generate mocked methods. The macro gets 3 or 4 parameters: - -```cpp -class MyMock { - public: - MOCK_METHOD(ReturnType, MethodName, (Args...)); - MOCK_METHOD(ReturnType, MethodName, (Args...), (Specs...)); -}; -``` - -The first 3 parameters are simply the method declaration, split into 3 parts. -The 4th parameter accepts a closed list of qualifiers, which affect the -generated method: - -* **`const`** - Makes the mocked method a `const` method. Required if - overriding a `const` method. -* **`override`** - Marks the method with `override`. Recommended if overriding - a `virtual` method. -* **`noexcept`** - Marks the method with `noexcept`. Required if overriding a - `noexcept` method. -* **`Calltype(...)`** - Sets the call type for the method (e.g. to - `STDMETHODCALLTYPE`), useful in Windows. -* **`ref(...)`** - Marks the method with the reference qualification - specified. Required if overriding a method that has reference - qualifications. Eg `ref(&)` or `ref(&&)`. - -### Dealing with unprotected commas - -Unprotected commas, i.e. commas which are not surrounded by parentheses, prevent -`MOCK_METHOD` from parsing its arguments correctly: - -{: .bad} -```cpp -class MockFoo { - public: - MOCK_METHOD(std::pair, GetPair, ()); // Won't compile! - MOCK_METHOD(bool, CheckMap, (std::map, bool)); // Won't compile! -}; -``` - -Solution 1 - wrap with parentheses: - -{: .good} -```cpp -class MockFoo { - public: - MOCK_METHOD((std::pair), GetPair, ()); - MOCK_METHOD(bool, CheckMap, ((std::map), bool)); -}; -``` - -Note that wrapping a return or argument type with parentheses is, in general, -invalid C++. `MOCK_METHOD` removes the parentheses. - -Solution 2 - define an alias: - -{: .good} -```cpp -class MockFoo { - public: - using BoolAndInt = std::pair; - MOCK_METHOD(BoolAndInt, GetPair, ()); - using MapIntDouble = std::map; - MOCK_METHOD(bool, CheckMap, (MapIntDouble, bool)); -}; -``` - -### Mocking Private or Protected Methods - -You must always put a mock method definition (`MOCK_METHOD`) in a `public:` -section of the mock class, regardless of the method being mocked being `public`, -`protected`, or `private` in the base class. This allows `ON_CALL` and -`EXPECT_CALL` to reference the mock function from outside of the mock class. -(Yes, C++ allows a subclass to change the access level of a virtual function in -the base class.) Example: - -```cpp -class Foo { - public: - ... - virtual bool Transform(Gadget* g) = 0; - - protected: - virtual void Resume(); - - private: - virtual int GetTimeOut(); -}; - -class MockFoo : public Foo { - public: - ... - MOCK_METHOD(bool, Transform, (Gadget* g), (override)); - - // The following must be in the public section, even though the - // methods are protected or private in the base class. - MOCK_METHOD(void, Resume, (), (override)); - MOCK_METHOD(int, GetTimeOut, (), (override)); -}; -``` - -### Mocking Overloaded Methods - -You can mock overloaded functions as usual. No special attention is required: - -```cpp -class Foo { - ... - - // Must be virtual as we'll inherit from Foo. - virtual ~Foo(); - - // Overloaded on the types and/or numbers of arguments. - virtual int Add(Element x); - virtual int Add(int times, Element x); - - // Overloaded on the const-ness of this object. - virtual Bar& GetBar(); - virtual const Bar& GetBar() const; -}; - -class MockFoo : public Foo { - ... - MOCK_METHOD(int, Add, (Element x), (override)); - MOCK_METHOD(int, Add, (int times, Element x), (override)); - - MOCK_METHOD(Bar&, GetBar, (), (override)); - MOCK_METHOD(const Bar&, GetBar, (), (const, override)); -}; -``` - -{: .callout .note} -**Note:** if you don't mock all versions of the overloaded method, the compiler -will give you a warning about some methods in the base class being hidden. To -fix that, use `using` to bring them in scope: - -```cpp -class MockFoo : public Foo { - ... - using Foo::Add; - MOCK_METHOD(int, Add, (Element x), (override)); - // We don't want to mock int Add(int times, Element x); - ... -}; -``` - -### Mocking Class Templates - -You can mock class templates just like any class. - -```cpp -template -class StackInterface { - ... - // Must be virtual as we'll inherit from StackInterface. - virtual ~StackInterface(); - - virtual int GetSize() const = 0; - virtual void Push(const Elem& x) = 0; -}; - -template -class MockStack : public StackInterface { - ... - MOCK_METHOD(int, GetSize, (), (override)); - MOCK_METHOD(void, Push, (const Elem& x), (override)); -}; -``` - -### Mocking Non-virtual Methods {#MockingNonVirtualMethods} - -gMock can mock non-virtual functions to be used in Hi-perf dependency injection. - -In this case, instead of sharing a common base class with the real class, your -mock class will be *unrelated* to the real class, but contain methods with the -same signatures. The syntax for mocking non-virtual methods is the *same* as -mocking virtual methods (just don't add `override`): - -```cpp -// A simple packet stream class. None of its members is virtual. -class ConcretePacketStream { - public: - void AppendPacket(Packet* new_packet); - const Packet* GetPacket(size_t packet_number) const; - size_t NumberOfPackets() const; - ... -}; - -// A mock packet stream class. It inherits from no other, but defines -// GetPacket() and NumberOfPackets(). -class MockPacketStream { - public: - MOCK_METHOD(const Packet*, GetPacket, (size_t packet_number), (const)); - MOCK_METHOD(size_t, NumberOfPackets, (), (const)); - ... -}; -``` - -Note that the mock class doesn't define `AppendPacket()`, unlike the real class. -That's fine as long as the test doesn't need to call it. - -Next, you need a way to say that you want to use `ConcretePacketStream` in -production code, and use `MockPacketStream` in tests. Since the functions are -not virtual and the two classes are unrelated, you must specify your choice at -*compile time* (as opposed to run time). - -One way to do it is to templatize your code that needs to use a packet stream. -More specifically, you will give your code a template type argument for the type -of the packet stream. In production, you will instantiate your template with -`ConcretePacketStream` as the type argument. In tests, you will instantiate the -same template with `MockPacketStream`. For example, you may write: - -```cpp -template -void CreateConnection(PacketStream* stream) { ... } - -template -class PacketReader { - public: - void ReadPackets(PacketStream* stream, size_t packet_num); -}; -``` - -Then you can use `CreateConnection()` and -`PacketReader` in production code, and use -`CreateConnection()` and `PacketReader` in -tests. - -```cpp - MockPacketStream mock_stream; - EXPECT_CALL(mock_stream, ...)...; - .. set more expectations on mock_stream ... - PacketReader reader(&mock_stream); - ... exercise reader ... -``` - -### Mocking Free Functions - -It is not possible to directly mock a free function (i.e. a C-style function or -a static method). If you need to, you can rewrite your code to use an interface -(abstract class). - -Instead of calling a free function (say, `OpenFile`) directly, introduce an -interface for it and have a concrete subclass that calls the free function: - -```cpp -class FileInterface { - public: - ... - virtual bool Open(const char* path, const char* mode) = 0; -}; - -class File : public FileInterface { - public: - ... - bool Open(const char* path, const char* mode) override { - return OpenFile(path, mode); - } -}; -``` - -Your code should talk to `FileInterface` to open a file. Now it's easy to mock -out the function. - -This may seem like a lot of hassle, but in practice you often have multiple -related functions that you can put in the same interface, so the per-function -syntactic overhead will be much lower. - -If you are concerned about the performance overhead incurred by virtual -functions, and profiling confirms your concern, you can combine this with the -recipe for [mocking non-virtual methods](#MockingNonVirtualMethods). - -### Old-Style `MOCK_METHODn` Macros - -Before the generic `MOCK_METHOD` macro -[was introduced in 2018](https://github.com/google/googletest/commit/c5f08bf91944ce1b19bcf414fa1760e69d20afc2), -mocks where created using a family of macros collectively called `MOCK_METHODn`. -These macros are still supported, though migration to the new `MOCK_METHOD` is -recommended. - -The macros in the `MOCK_METHODn` family differ from `MOCK_METHOD`: - -* The general structure is `MOCK_METHODn(MethodName, ReturnType(Args))`, - instead of `MOCK_METHOD(ReturnType, MethodName, (Args))`. -* The number `n` must equal the number of arguments. -* When mocking a const method, one must use `MOCK_CONST_METHODn`. -* When mocking a class template, the macro name must be suffixed with `_T`. -* In order to specify the call type, the macro name must be suffixed with - `_WITH_CALLTYPE`, and the call type is the first macro argument. - -Old macros and their new equivalents: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Simple
    OldMOCK_METHOD1(Foo, bool(int))
    NewMOCK_METHOD(bool, Foo, (int))
    Const Method
    OldMOCK_CONST_METHOD1(Foo, bool(int))
    NewMOCK_METHOD(bool, Foo, (int), (const))
    Method in a Class Template
    OldMOCK_METHOD1_T(Foo, bool(int))
    NewMOCK_METHOD(bool, Foo, (int))
    Const Method in a Class Template
    OldMOCK_CONST_METHOD1_T(Foo, bool(int))
    NewMOCK_METHOD(bool, Foo, (int), (const))
    Method with Call Type
    OldMOCK_METHOD1_WITH_CALLTYPE(STDMETHODCALLTYPE, Foo, bool(int))
    NewMOCK_METHOD(bool, Foo, (int), (Calltype(STDMETHODCALLTYPE)))
    Const Method with Call Type
    OldMOCK_CONST_METHOD1_WITH_CALLTYPE(STDMETHODCALLTYPE, Foo, bool(int))
    NewMOCK_METHOD(bool, Foo, (int), (const, Calltype(STDMETHODCALLTYPE)))
    Method with Call Type in a Class Template
    OldMOCK_METHOD1_T_WITH_CALLTYPE(STDMETHODCALLTYPE, Foo, bool(int))
    NewMOCK_METHOD(bool, Foo, (int), (Calltype(STDMETHODCALLTYPE)))
    Const Method with Call Type in a Class Template
    OldMOCK_CONST_METHOD1_T_WITH_CALLTYPE(STDMETHODCALLTYPE, Foo, bool(int))
    NewMOCK_METHOD(bool, Foo, (int), (const, Calltype(STDMETHODCALLTYPE)))
    - -### The Nice, the Strict, and the Naggy {#NiceStrictNaggy} - -If a mock method has no `EXPECT_CALL` spec but is called, we say that it's an -"uninteresting call", and the default action (which can be specified using -`ON_CALL()`) of the method will be taken. Currently, an uninteresting call will -also by default cause gMock to print a warning. (In the future, we might remove -this warning by default.) - -However, sometimes you may want to ignore these uninteresting calls, and -sometimes you may want to treat them as errors. gMock lets you make the decision -on a per-mock-object basis. - -Suppose your test uses a mock class `MockFoo`: - -```cpp -TEST(...) { - MockFoo mock_foo; - EXPECT_CALL(mock_foo, DoThis()); - ... code that uses mock_foo ... -} -``` - -If a method of `mock_foo` other than `DoThis()` is called, you will get a -warning. However, if you rewrite your test to use `NiceMock` instead, -you can suppress the warning: - -```cpp -using ::testing::NiceMock; - -TEST(...) { - NiceMock mock_foo; - EXPECT_CALL(mock_foo, DoThis()); - ... code that uses mock_foo ... -} -``` - -`NiceMock` is a subclass of `MockFoo`, so it can be used wherever -`MockFoo` is accepted. - -It also works if `MockFoo`'s constructor takes some arguments, as -`NiceMock` "inherits" `MockFoo`'s constructors: - -```cpp -using ::testing::NiceMock; - -TEST(...) { - NiceMock mock_foo(5, "hi"); // Calls MockFoo(5, "hi"). - EXPECT_CALL(mock_foo, DoThis()); - ... code that uses mock_foo ... -} -``` - -The usage of `StrictMock` is similar, except that it makes all uninteresting -calls failures: - -```cpp -using ::testing::StrictMock; - -TEST(...) { - StrictMock mock_foo; - EXPECT_CALL(mock_foo, DoThis()); - ... code that uses mock_foo ... - - // The test will fail if a method of mock_foo other than DoThis() - // is called. -} -``` - -{: .callout .note} -NOTE: `NiceMock` and `StrictMock` only affects *uninteresting* calls (calls of -*methods* with no expectations); they do not affect *unexpected* calls (calls of -methods with expectations, but they don't match). See -[Understanding Uninteresting vs Unexpected Calls](#uninteresting-vs-unexpected). - -There are some caveats though (sadly they are side effects of C++'s -limitations): - -1. `NiceMock` and `StrictMock` only work for mock methods - defined using the `MOCK_METHOD` macro **directly** in the `MockFoo` class. - If a mock method is defined in a **base class** of `MockFoo`, the "nice" or - "strict" modifier may not affect it, depending on the compiler. In - particular, nesting `NiceMock` and `StrictMock` (e.g. - `NiceMock >`) is **not** supported. -2. `NiceMock` and `StrictMock` may not work correctly if the - destructor of `MockFoo` is not virtual. We would like to fix this, but it - requires cleaning up existing tests. - -Finally, you should be **very cautious** about when to use naggy or strict -mocks, as they tend to make tests more brittle and harder to maintain. When you -refactor your code without changing its externally visible behavior, ideally you -shouldn't need to update any tests. If your code interacts with a naggy mock, -however, you may start to get spammed with warnings as the result of your -change. Worse, if your code interacts with a strict mock, your tests may start -to fail and you'll be forced to fix them. Our general recommendation is to use -nice mocks (not yet the default) most of the time, use naggy mocks (the current -default) when developing or debugging tests, and use strict mocks only as the -last resort. - -### Simplifying the Interface without Breaking Existing Code {#SimplerInterfaces} - -Sometimes a method has a long list of arguments that is mostly uninteresting. -For example: - -```cpp -class LogSink { - public: - ... - virtual void send(LogSeverity severity, const char* full_filename, - const char* base_filename, int line, - const struct tm* tm_time, - const char* message, size_t message_len) = 0; -}; -``` - -This method's argument list is lengthy and hard to work with (the `message` -argument is not even 0-terminated). If we mock it as is, using the mock will be -awkward. If, however, we try to simplify this interface, we'll need to fix all -clients depending on it, which is often infeasible. - -The trick is to redispatch the method in the mock class: - -```cpp -class ScopedMockLog : public LogSink { - public: - ... - void send(LogSeverity severity, const char* full_filename, - const char* base_filename, int line, const tm* tm_time, - const char* message, size_t message_len) override { - // We are only interested in the log severity, full file name, and - // log message. - Log(severity, full_filename, std::string(message, message_len)); - } - - // Implements the mock method: - // - // void Log(LogSeverity severity, - // const string& file_path, - // const string& message); - MOCK_METHOD(void, Log, - (LogSeverity severity, const string& file_path, - const string& message)); -}; -``` - -By defining a new mock method with a trimmed argument list, we make the mock -class more user-friendly. - -This technique may also be applied to make overloaded methods more amenable to -mocking. For example, when overloads have been used to implement default -arguments: - -```cpp -class MockTurtleFactory : public TurtleFactory { - public: - Turtle* MakeTurtle(int length, int weight) override { ... } - Turtle* MakeTurtle(int length, int weight, int speed) override { ... } - - // the above methods delegate to this one: - MOCK_METHOD(Turtle*, DoMakeTurtle, ()); -}; -``` - -This allows tests that don't care which overload was invoked to avoid specifying -argument matchers: - -```cpp -ON_CALL(factory, DoMakeTurtle) - .WillByDefault(Return(MakeMockTurtle())); -``` - -### Alternative to Mocking Concrete Classes - -Often you may find yourself using classes that don't implement interfaces. In -order to test your code that uses such a class (let's call it `Concrete`), you -may be tempted to make the methods of `Concrete` virtual and then mock it. - -Try not to do that. - -Making a non-virtual function virtual is a big decision. It creates an extension -point where subclasses can tweak your class' behavior. This weakens your control -on the class because now it's harder to maintain the class invariants. You -should make a function virtual only when there is a valid reason for a subclass -to override it. - -Mocking concrete classes directly is problematic as it creates a tight coupling -between the class and the tests - any small change in the class may invalidate -your tests and make test maintenance a pain. - -To avoid such problems, many programmers have been practicing "coding to -interfaces": instead of talking to the `Concrete` class, your code would define -an interface and talk to it. Then you implement that interface as an adaptor on -top of `Concrete`. In tests, you can easily mock that interface to observe how -your code is doing. - -This technique incurs some overhead: - -* You pay the cost of virtual function calls (usually not a problem). -* There is more abstraction for the programmers to learn. - -However, it can also bring significant benefits in addition to better -testability: - -* `Concrete`'s API may not fit your problem domain very well, as you may not - be the only client it tries to serve. By designing your own interface, you - have a chance to tailor it to your need - you may add higher-level - functionalities, rename stuff, etc instead of just trimming the class. This - allows you to write your code (user of the interface) in a more natural way, - which means it will be more readable, more maintainable, and you'll be more - productive. -* If `Concrete`'s implementation ever has to change, you don't have to rewrite - everywhere it is used. Instead, you can absorb the change in your - implementation of the interface, and your other code and tests will be - insulated from this change. - -Some people worry that if everyone is practicing this technique, they will end -up writing lots of redundant code. This concern is totally understandable. -However, there are two reasons why it may not be the case: - -* Different projects may need to use `Concrete` in different ways, so the best - interfaces for them will be different. Therefore, each of them will have its - own domain-specific interface on top of `Concrete`, and they will not be the - same code. -* If enough projects want to use the same interface, they can always share it, - just like they have been sharing `Concrete`. You can check in the interface - and the adaptor somewhere near `Concrete` (perhaps in a `contrib` - sub-directory) and let many projects use it. - -You need to weigh the pros and cons carefully for your particular problem, but -I'd like to assure you that the Java community has been practicing this for a -long time and it's a proven effective technique applicable in a wide variety of -situations. :-) - -### Delegating Calls to a Fake {#DelegatingToFake} - -Some times you have a non-trivial fake implementation of an interface. For -example: - -```cpp -class Foo { - public: - virtual ~Foo() {} - virtual char DoThis(int n) = 0; - virtual void DoThat(const char* s, int* p) = 0; -}; - -class FakeFoo : public Foo { - public: - char DoThis(int n) override { - return (n > 0) ? '+' : - (n < 0) ? '-' : '0'; - } - - void DoThat(const char* s, int* p) override { - *p = strlen(s); - } -}; -``` - -Now you want to mock this interface such that you can set expectations on it. -However, you also want to use `FakeFoo` for the default behavior, as duplicating -it in the mock object is, well, a lot of work. - -When you define the mock class using gMock, you can have it delegate its default -action to a fake class you already have, using this pattern: - -```cpp -class MockFoo : public Foo { - public: - // Normal mock method definitions using gMock. - MOCK_METHOD(char, DoThis, (int n), (override)); - MOCK_METHOD(void, DoThat, (const char* s, int* p), (override)); - - // Delegates the default actions of the methods to a FakeFoo object. - // This must be called *before* the custom ON_CALL() statements. - void DelegateToFake() { - ON_CALL(*this, DoThis).WillByDefault([this](int n) { - return fake_.DoThis(n); - }); - ON_CALL(*this, DoThat).WillByDefault([this](const char* s, int* p) { - fake_.DoThat(s, p); - }); - } - - private: - FakeFoo fake_; // Keeps an instance of the fake in the mock. -}; -``` - -With that, you can use `MockFoo` in your tests as usual. Just remember that if -you don't explicitly set an action in an `ON_CALL()` or `EXPECT_CALL()`, the -fake will be called upon to do it.: - -```cpp -using ::testing::_; - -TEST(AbcTest, Xyz) { - MockFoo foo; - - foo.DelegateToFake(); // Enables the fake for delegation. - - // Put your ON_CALL(foo, ...)s here, if any. - - // No action specified, meaning to use the default action. - EXPECT_CALL(foo, DoThis(5)); - EXPECT_CALL(foo, DoThat(_, _)); - - int n = 0; - EXPECT_EQ('+', foo.DoThis(5)); // FakeFoo::DoThis() is invoked. - foo.DoThat("Hi", &n); // FakeFoo::DoThat() is invoked. - EXPECT_EQ(2, n); -} -``` - -**Some tips:** - -* If you want, you can still override the default action by providing your own - `ON_CALL()` or using `.WillOnce()` / `.WillRepeatedly()` in `EXPECT_CALL()`. -* In `DelegateToFake()`, you only need to delegate the methods whose fake - implementation you intend to use. - -* The general technique discussed here works for overloaded methods, but - you'll need to tell the compiler which version you mean. To disambiguate a - mock function (the one you specify inside the parentheses of `ON_CALL()`), - use [this technique](#SelectOverload); to disambiguate a fake function (the - one you place inside `Invoke()`), use a `static_cast` to specify the - function's type. For instance, if class `Foo` has methods `char DoThis(int - n)` and `bool DoThis(double x) const`, and you want to invoke the latter, - you need to write `Invoke(&fake_, static_cast(&FakeFoo::DoThis))` instead of `Invoke(&fake_, &FakeFoo::DoThis)` - (The strange-looking thing inside the angled brackets of `static_cast` is - the type of a function pointer to the second `DoThis()` method.). - -* Having to mix a mock and a fake is often a sign of something gone wrong. - Perhaps you haven't got used to the interaction-based way of testing yet. Or - perhaps your interface is taking on too many roles and should be split up. - Therefore, **don't abuse this**. We would only recommend to do it as an - intermediate step when you are refactoring your code. - -Regarding the tip on mixing a mock and a fake, here's an example on why it may -be a bad sign: Suppose you have a class `System` for low-level system -operations. In particular, it does file and I/O operations. And suppose you want -to test how your code uses `System` to do I/O, and you just want the file -operations to work normally. If you mock out the entire `System` class, you'll -have to provide a fake implementation for the file operation part, which -suggests that `System` is taking on too many roles. - -Instead, you can define a `FileOps` interface and an `IOOps` interface and split -`System`'s functionalities into the two. Then you can mock `IOOps` without -mocking `FileOps`. - -### Delegating Calls to a Real Object - -When using testing doubles (mocks, fakes, stubs, and etc), sometimes their -behaviors will differ from those of the real objects. This difference could be -either intentional (as in simulating an error such that you can test the error -handling code) or unintentional. If your mocks have different behaviors than the -real objects by mistake, you could end up with code that passes the tests but -fails in production. - -You can use the *delegating-to-real* technique to ensure that your mock has the -same behavior as the real object while retaining the ability to validate calls. -This technique is very similar to the [delegating-to-fake](#DelegatingToFake) -technique, the difference being that we use a real object instead of a fake. -Here's an example: - -```cpp -using ::testing::AtLeast; - -class MockFoo : public Foo { - public: - MockFoo() { - // By default, all calls are delegated to the real object. - ON_CALL(*this, DoThis).WillByDefault([this](int n) { - return real_.DoThis(n); - }); - ON_CALL(*this, DoThat).WillByDefault([this](const char* s, int* p) { - real_.DoThat(s, p); - }); - ... - } - MOCK_METHOD(char, DoThis, ...); - MOCK_METHOD(void, DoThat, ...); - ... - private: - Foo real_; -}; - -... - MockFoo mock; - EXPECT_CALL(mock, DoThis()) - .Times(3); - EXPECT_CALL(mock, DoThat("Hi")) - .Times(AtLeast(1)); - ... use mock in test ... -``` - -With this, gMock will verify that your code made the right calls (with the right -arguments, in the right order, called the right number of times, etc), and a -real object will answer the calls (so the behavior will be the same as in -production). This gives you the best of both worlds. - -### Delegating Calls to a Parent Class - -Ideally, you should code to interfaces, whose methods are all pure virtual. In -reality, sometimes you do need to mock a virtual method that is not pure (i.e, -it already has an implementation). For example: - -```cpp -class Foo { - public: - virtual ~Foo(); - - virtual void Pure(int n) = 0; - virtual int Concrete(const char* str) { ... } -}; - -class MockFoo : public Foo { - public: - // Mocking a pure method. - MOCK_METHOD(void, Pure, (int n), (override)); - // Mocking a concrete method. Foo::Concrete() is shadowed. - MOCK_METHOD(int, Concrete, (const char* str), (override)); -}; -``` - -Sometimes you may want to call `Foo::Concrete()` instead of -`MockFoo::Concrete()`. Perhaps you want to do it as part of a stub action, or -perhaps your test doesn't need to mock `Concrete()` at all (but it would be -oh-so painful to have to define a new mock class whenever you don't need to mock -one of its methods). - -You can call `Foo::Concrete()` inside an action by: - -```cpp -... - EXPECT_CALL(foo, Concrete).WillOnce([&foo](const char* str) { - return foo.Foo::Concrete(str); - }); -``` - -or tell the mock object that you don't want to mock `Concrete()`: - -```cpp -... - ON_CALL(foo, Concrete).WillByDefault([&foo](const char* str) { - return foo.Foo::Concrete(str); - }); -``` - -(Why don't we just write `{ return foo.Concrete(str); }`? If you do that, -`MockFoo::Concrete()` will be called (and cause an infinite recursion) since -`Foo::Concrete()` is virtual. That's just how C++ works.) - -## Using Matchers - -### Matching Argument Values Exactly - -You can specify exactly which arguments a mock method is expecting: - -```cpp -using ::testing::Return; -... - EXPECT_CALL(foo, DoThis(5)) - .WillOnce(Return('a')); - EXPECT_CALL(foo, DoThat("Hello", bar)); -``` - -### Using Simple Matchers - -You can use matchers to match arguments that have a certain property: - -```cpp -using ::testing::NotNull; -using ::testing::Return; -... - EXPECT_CALL(foo, DoThis(Ge(5))) // The argument must be >= 5. - .WillOnce(Return('a')); - EXPECT_CALL(foo, DoThat("Hello", NotNull())); - // The second argument must not be NULL. -``` - -A frequently used matcher is `_`, which matches anything: - -```cpp - EXPECT_CALL(foo, DoThat(_, NotNull())); -``` - -### Combining Matchers {#CombiningMatchers} - -You can build complex matchers from existing ones using `AllOf()`, -`AllOfArray()`, `AnyOf()`, `AnyOfArray()` and `Not()`: - -```cpp -using ::testing::AllOf; -using ::testing::Gt; -using ::testing::HasSubstr; -using ::testing::Ne; -using ::testing::Not; -... - // The argument must be > 5 and != 10. - EXPECT_CALL(foo, DoThis(AllOf(Gt(5), - Ne(10)))); - - // The first argument must not contain sub-string "blah". - EXPECT_CALL(foo, DoThat(Not(HasSubstr("blah")), - NULL)); -``` - -Matchers are function objects, and parametrized matchers can be composed just -like any other function. However because their types can be long and rarely -provide meaningful information, it can be easier to express them with C++14 -generic lambdas to avoid specifying types. For example, - -```cpp -using ::testing::Contains; -using ::testing::Property; - -inline constexpr auto HasFoo = [](const auto& f) { - return Property(&MyClass::foo, Contains(f)); -}; -... - EXPECT_THAT(x, HasFoo("blah")); -``` - -### Casting Matchers {#SafeMatcherCast} - -gMock matchers are statically typed, meaning that the compiler can catch your -mistake if you use a matcher of the wrong type (for example, if you use `Eq(5)` -to match a `string` argument). Good for you! - -Sometimes, however, you know what you're doing and want the compiler to give you -some slack. One example is that you have a matcher for `long` and the argument -you want to match is `int`. While the two types aren't exactly the same, there -is nothing really wrong with using a `Matcher` to match an `int` - after -all, we can first convert the `int` argument to a `long` losslessly before -giving it to the matcher. - -To support this need, gMock gives you the `SafeMatcherCast(m)` function. It -casts a matcher `m` to type `Matcher`. To ensure safety, gMock checks that -(let `U` be the type `m` accepts : - -1. Type `T` can be *implicitly* cast to type `U`; -2. When both `T` and `U` are built-in arithmetic types (`bool`, integers, and - floating-point numbers), the conversion from `T` to `U` is not lossy (in - other words, any value representable by `T` can also be represented by `U`); - and -3. When `U` is a reference, `T` must also be a reference (as the underlying - matcher may be interested in the address of the `U` value). - -The code won't compile if any of these conditions isn't met. - -Here's one example: - -```cpp -using ::testing::SafeMatcherCast; - -// A base class and a child class. -class Base { ... }; -class Derived : public Base { ... }; - -class MockFoo : public Foo { - public: - MOCK_METHOD(void, DoThis, (Derived* derived), (override)); -}; - -... - MockFoo foo; - // m is a Matcher we got from somewhere. - EXPECT_CALL(foo, DoThis(SafeMatcherCast(m))); -``` - -If you find `SafeMatcherCast(m)` too limiting, you can use a similar function -`MatcherCast(m)`. The difference is that `MatcherCast` works as long as you -can `static_cast` type `T` to type `U`. - -`MatcherCast` essentially lets you bypass C++'s type system (`static_cast` isn't -always safe as it could throw away information, for example), so be careful not -to misuse/abuse it. - -### Selecting Between Overloaded Functions {#SelectOverload} - -If you expect an overloaded function to be called, the compiler may need some -help on which overloaded version it is. - -To disambiguate functions overloaded on the const-ness of this object, use the -`Const()` argument wrapper. - -```cpp -using ::testing::ReturnRef; - -class MockFoo : public Foo { - ... - MOCK_METHOD(Bar&, GetBar, (), (override)); - MOCK_METHOD(const Bar&, GetBar, (), (const, override)); -}; - -... - MockFoo foo; - Bar bar1, bar2; - EXPECT_CALL(foo, GetBar()) // The non-const GetBar(). - .WillOnce(ReturnRef(bar1)); - EXPECT_CALL(Const(foo), GetBar()) // The const GetBar(). - .WillOnce(ReturnRef(bar2)); -``` - -(`Const()` is defined by gMock and returns a `const` reference to its argument.) - -To disambiguate overloaded functions with the same number of arguments but -different argument types, you may need to specify the exact type of a matcher, -either by wrapping your matcher in `Matcher()`, or using a matcher whose -type is fixed (`TypedEq`, `An()`, etc): - -```cpp -using ::testing::An; -using ::testing::Matcher; -using ::testing::TypedEq; - -class MockPrinter : public Printer { - public: - MOCK_METHOD(void, Print, (int n), (override)); - MOCK_METHOD(void, Print, (char c), (override)); -}; - -TEST(PrinterTest, Print) { - MockPrinter printer; - - EXPECT_CALL(printer, Print(An())); // void Print(int); - EXPECT_CALL(printer, Print(Matcher(Lt(5)))); // void Print(int); - EXPECT_CALL(printer, Print(TypedEq('a'))); // void Print(char); - - printer.Print(3); - printer.Print(6); - printer.Print('a'); -} -``` - -### Performing Different Actions Based on the Arguments - -When a mock method is called, the *last* matching expectation that's still -active will be selected (think "newer overrides older"). So, you can make a -method do different things depending on its argument values like this: - -```cpp -using ::testing::_; -using ::testing::Lt; -using ::testing::Return; -... - // The default case. - EXPECT_CALL(foo, DoThis(_)) - .WillRepeatedly(Return('b')); - // The more specific case. - EXPECT_CALL(foo, DoThis(Lt(5))) - .WillRepeatedly(Return('a')); -``` - -Now, if `foo.DoThis()` is called with a value less than 5, `'a'` will be -returned; otherwise `'b'` will be returned. - -### Matching Multiple Arguments as a Whole - -Sometimes it's not enough to match the arguments individually. For example, we -may want to say that the first argument must be less than the second argument. -The `With()` clause allows us to match all arguments of a mock function as a -whole. For example, - -```cpp -using ::testing::_; -using ::testing::Ne; -using ::testing::Lt; -... - EXPECT_CALL(foo, InRange(Ne(0), _)) - .With(Lt()); -``` - -says that the first argument of `InRange()` must not be 0, and must be less than -the second argument. - -The expression inside `With()` must be a matcher of type `Matcher>`, where `A1`, ..., `An` are the types of the function arguments. - -You can also write `AllArgs(m)` instead of `m` inside `.With()`. The two forms -are equivalent, but `.With(AllArgs(Lt()))` is more readable than `.With(Lt())`. - -You can use `Args(m)` to match the `n` selected arguments (as a -tuple) against `m`. For example, - -```cpp -using ::testing::_; -using ::testing::AllOf; -using ::testing::Args; -using ::testing::Lt; -... - EXPECT_CALL(foo, Blah) - .With(AllOf(Args<0, 1>(Lt()), Args<1, 2>(Lt()))); -``` - -says that `Blah` will be called with arguments `x`, `y`, and `z` where `x < y < -z`. Note that in this example, it wasn't necessary specify the positional -matchers. - -As a convenience and example, gMock provides some matchers for 2-tuples, -including the `Lt()` matcher above. See -[Multi-argument Matchers](reference/matchers.md#MultiArgMatchers) for the -complete list. - -Note that if you want to pass the arguments to a predicate of your own (e.g. -`.With(Args<0, 1>(Truly(&MyPredicate)))`), that predicate MUST be written to -take a `std::tuple` as its argument; gMock will pass the `n` selected arguments -as *one* single tuple to the predicate. - -### Using Matchers as Predicates - -Have you noticed that a matcher is just a fancy predicate that also knows how to -describe itself? Many existing algorithms take predicates as arguments (e.g. -those defined in STL's `` header), and it would be a shame if gMock -matchers were not allowed to participate. - -Luckily, you can use a matcher where a unary predicate functor is expected by -wrapping it inside the `Matches()` function. For example, - -```cpp -#include -#include - -using ::testing::Matches; -using ::testing::Ge; - -vector v; -... -// How many elements in v are >= 10? -const int count = count_if(v.begin(), v.end(), Matches(Ge(10))); -``` - -Since you can build complex matchers from simpler ones easily using gMock, this -gives you a way to conveniently construct composite predicates (doing the same -using STL's `` header is just painful). For example, here's a -predicate that's satisfied by any number that is >= 0, <= 100, and != 50: - -```cpp -using testing::AllOf; -using testing::Ge; -using testing::Le; -using testing::Matches; -using testing::Ne; -... -Matches(AllOf(Ge(0), Le(100), Ne(50))) -``` - -### Using Matchers in googletest Assertions - -See [`EXPECT_THAT`](reference/assertions.md#EXPECT_THAT) in the Assertions -Reference. - -### Using Predicates as Matchers - -gMock provides a set of built-in matchers for matching arguments with expected -values—see the [Matchers Reference](reference/matchers.md) for more information. -In case you find the built-in set lacking, you can use an arbitrary unary -predicate function or functor as a matcher - as long as the predicate accepts a -value of the type you want. You do this by wrapping the predicate inside the -`Truly()` function, for example: - -```cpp -using ::testing::Truly; - -int IsEven(int n) { return (n % 2) == 0 ? 1 : 0; } -... - // Bar() must be called with an even number. - EXPECT_CALL(foo, Bar(Truly(IsEven))); -``` - -Note that the predicate function / functor doesn't have to return `bool`. It -works as long as the return value can be used as the condition in in statement -`if (condition) ...`. - -### Matching Arguments that Are Not Copyable - -When you do an `EXPECT_CALL(mock_obj, Foo(bar))`, gMock saves away a copy of -`bar`. When `Foo()` is called later, gMock compares the argument to `Foo()` with -the saved copy of `bar`. This way, you don't need to worry about `bar` being -modified or destroyed after the `EXPECT_CALL()` is executed. The same is true -when you use matchers like `Eq(bar)`, `Le(bar)`, and so on. - -But what if `bar` cannot be copied (i.e. has no copy constructor)? You could -define your own matcher function or callback and use it with `Truly()`, as the -previous couple of recipes have shown. Or, you may be able to get away from it -if you can guarantee that `bar` won't be changed after the `EXPECT_CALL()` is -executed. Just tell gMock that it should save a reference to `bar`, instead of a -copy of it. Here's how: - -```cpp -using ::testing::Eq; -using ::testing::Lt; -... - // Expects that Foo()'s argument == bar. - EXPECT_CALL(mock_obj, Foo(Eq(std::ref(bar)))); - - // Expects that Foo()'s argument < bar. - EXPECT_CALL(mock_obj, Foo(Lt(std::ref(bar)))); -``` - -Remember: if you do this, don't change `bar` after the `EXPECT_CALL()`, or the -result is undefined. - -### Validating a Member of an Object - -Often a mock function takes a reference to object as an argument. When matching -the argument, you may not want to compare the entire object against a fixed -object, as that may be over-specification. Instead, you may need to validate a -certain member variable or the result of a certain getter method of the object. -You can do this with `Field()` and `Property()`. More specifically, - -```cpp -Field(&Foo::bar, m) -``` - -is a matcher that matches a `Foo` object whose `bar` member variable satisfies -matcher `m`. - -```cpp -Property(&Foo::baz, m) -``` - -is a matcher that matches a `Foo` object whose `baz()` method returns a value -that satisfies matcher `m`. - -For example: - -| Expression | Description | -| :--------------------------- | :--------------------------------------- | -| `Field(&Foo::number, Ge(3))` | Matches `x` where `x.number >= 3`. | -| `Property(&Foo::name, StartsWith("John "))` | Matches `x` where `x.name()` starts with `"John "`. | - -Note that in `Property(&Foo::baz, ...)`, method `baz()` must take no argument -and be declared as `const`. Don't use `Property()` against member functions that -you do not own, because taking addresses of functions is fragile and generally -not part of the contract of the function. - -`Field()` and `Property()` can also match plain pointers to objects. For -instance, - -```cpp -using ::testing::Field; -using ::testing::Ge; -... -Field(&Foo::number, Ge(3)) -``` - -matches a plain pointer `p` where `p->number >= 3`. If `p` is `NULL`, the match -will always fail regardless of the inner matcher. - -What if you want to validate more than one members at the same time? Remember -that there are [`AllOf()` and `AllOfArray()`](#CombiningMatchers). - -Finally `Field()` and `Property()` provide overloads that take the field or -property names as the first argument to include it in the error message. This -can be useful when creating combined matchers. - -```cpp -using ::testing::AllOf; -using ::testing::Field; -using ::testing::Matcher; -using ::testing::SafeMatcherCast; - -Matcher IsFoo(const Foo& foo) { - return AllOf(Field("some_field", &Foo::some_field, foo.some_field), - Field("other_field", &Foo::other_field, foo.other_field), - Field("last_field", &Foo::last_field, foo.last_field)); -} -``` - -### Validating the Value Pointed to by a Pointer Argument - -C++ functions often take pointers as arguments. You can use matchers like -`IsNull()`, `NotNull()`, and other comparison matchers to match a pointer, but -what if you want to make sure the value *pointed to* by the pointer, instead of -the pointer itself, has a certain property? Well, you can use the `Pointee(m)` -matcher. - -`Pointee(m)` matches a pointer if and only if `m` matches the value the pointer -points to. For example: - -```cpp -using ::testing::Ge; -using ::testing::Pointee; -... - EXPECT_CALL(foo, Bar(Pointee(Ge(3)))); -``` - -expects `foo.Bar()` to be called with a pointer that points to a value greater -than or equal to 3. - -One nice thing about `Pointee()` is that it treats a `NULL` pointer as a match -failure, so you can write `Pointee(m)` instead of - -```cpp -using ::testing::AllOf; -using ::testing::NotNull; -using ::testing::Pointee; -... - AllOf(NotNull(), Pointee(m)) -``` - -without worrying that a `NULL` pointer will crash your test. - -Also, did we tell you that `Pointee()` works with both raw pointers **and** -smart pointers (`std::unique_ptr`, `std::shared_ptr`, etc)? - -What if you have a pointer to pointer? You guessed it - you can use nested -`Pointee()` to probe deeper inside the value. For example, -`Pointee(Pointee(Lt(3)))` matches a pointer that points to a pointer that points -to a number less than 3 (what a mouthful...). - -### Testing a Certain Property of an Object - -Sometimes you want to specify that an object argument has a certain property, -but there is no existing matcher that does this. If you want good error -messages, you should [define a matcher](#NewMatchers). If you want to do it -quick and dirty, you could get away with writing an ordinary function. - -Let's say you have a mock function that takes an object of type `Foo`, which has -an `int bar()` method and an `int baz()` method, and you want to constrain that -the argument's `bar()` value plus its `baz()` value is a given number. Here's -how you can define a matcher to do it: - -```cpp -using ::testing::Matcher; - -class BarPlusBazEqMatcher { - public: - explicit BarPlusBazEqMatcher(int expected_sum) - : expected_sum_(expected_sum) {} - - bool MatchAndExplain(const Foo& foo, - std::ostream* /* listener */) const { - return (foo.bar() + foo.baz()) == expected_sum_; - } - - void DescribeTo(std::ostream& os) const { - os << "bar() + baz() equals " << expected_sum_; - } - - void DescribeNegationTo(std::ostream& os) const { - os << "bar() + baz() does not equal " << expected_sum_; - } - private: - const int expected_sum_; -}; - -Matcher BarPlusBazEq(int expected_sum) { - return BarPlusBazEqMatcher(expected_sum); -} - -... - EXPECT_CALL(..., DoThis(BarPlusBazEq(5)))...; -``` - -### Matching Containers - -Sometimes an STL container (e.g. list, vector, map, ...) is passed to a mock -function and you may want to validate it. Since most STL containers support the -`==` operator, you can write `Eq(expected_container)` or simply -`expected_container` to match a container exactly. - -Sometimes, though, you may want to be more flexible (for example, the first -element must be an exact match, but the second element can be any positive -number, and so on). Also, containers used in tests often have a small number of -elements, and having to define the expected container out-of-line is a bit of a -hassle. - -You can use the `ElementsAre()` or `UnorderedElementsAre()` matcher in such -cases: - -```cpp -using ::testing::_; -using ::testing::ElementsAre; -using ::testing::Gt; -... - MOCK_METHOD(void, Foo, (const vector& numbers), (override)); -... - EXPECT_CALL(mock, Foo(ElementsAre(1, Gt(0), _, 5))); -``` - -The above matcher says that the container must have 4 elements, which must be 1, -greater than 0, anything, and 5 respectively. - -If you instead write: - -```cpp -using ::testing::_; -using ::testing::Gt; -using ::testing::UnorderedElementsAre; -... - MOCK_METHOD(void, Foo, (const vector& numbers), (override)); -... - EXPECT_CALL(mock, Foo(UnorderedElementsAre(1, Gt(0), _, 5))); -``` - -It means that the container must have 4 elements, which (under some permutation) -must be 1, greater than 0, anything, and 5 respectively. - -As an alternative you can place the arguments in a C-style array and use -`ElementsAreArray()` or `UnorderedElementsAreArray()` instead: - -```cpp -using ::testing::ElementsAreArray; -... - // ElementsAreArray accepts an array of element values. - const int expected_vector1[] = {1, 5, 2, 4, ...}; - EXPECT_CALL(mock, Foo(ElementsAreArray(expected_vector1))); - - // Or, an array of element matchers. - Matcher expected_vector2[] = {1, Gt(2), _, 3, ...}; - EXPECT_CALL(mock, Foo(ElementsAreArray(expected_vector2))); -``` - -In case the array needs to be dynamically created (and therefore the array size -cannot be inferred by the compiler), you can give `ElementsAreArray()` an -additional argument to specify the array size: - -```cpp -using ::testing::ElementsAreArray; -... - int* const expected_vector3 = new int[count]; - ... fill expected_vector3 with values ... - EXPECT_CALL(mock, Foo(ElementsAreArray(expected_vector3, count))); -``` - -Use `Pair` when comparing maps or other associative containers. - -{% raw %} - -```cpp -using testing::ElementsAre; -using testing::Pair; -... - std::map m = {{"a", 1}, {"b", 2}, {"c", 3}}; - EXPECT_THAT(m, ElementsAre(Pair("a", 1), Pair("b", 2), Pair("c", 3))); -``` - -{% endraw %} - -**Tips:** - -* `ElementsAre*()` can be used to match *any* container that implements the - STL iterator pattern (i.e. it has a `const_iterator` type and supports - `begin()/end()`), not just the ones defined in STL. It will even work with - container types yet to be written - as long as they follows the above - pattern. -* You can use nested `ElementsAre*()` to match nested (multi-dimensional) - containers. -* If the container is passed by pointer instead of by reference, just write - `Pointee(ElementsAre*(...))`. -* The order of elements *matters* for `ElementsAre*()`. If you are using it - with containers whose element order are undefined (e.g. `hash_map`) you - should use `WhenSorted` around `ElementsAre`. - -### Sharing Matchers - -Under the hood, a gMock matcher object consists of a pointer to a ref-counted -implementation object. Copying matchers is allowed and very efficient, as only -the pointer is copied. When the last matcher that references the implementation -object dies, the implementation object will be deleted. - -Therefore, if you have some complex matcher that you want to use again and -again, there is no need to build it everytime. Just assign it to a matcher -variable and use that variable repeatedly! For example, - -```cpp -using ::testing::AllOf; -using ::testing::Gt; -using ::testing::Le; -using ::testing::Matcher; -... - Matcher in_range = AllOf(Gt(5), Le(10)); - ... use in_range as a matcher in multiple EXPECT_CALLs ... -``` - -### Matchers must have no side-effects {#PureMatchers} - -{: .callout .warning} -WARNING: gMock does not guarantee when or how many times a matcher will be -invoked. Therefore, all matchers must be *purely functional*: they cannot have -any side effects, and the match result must not depend on anything other than -the matcher's parameters and the value being matched. - -This requirement must be satisfied no matter how a matcher is defined (e.g., if -it is one of the standard matchers, or a custom matcher). In particular, a -matcher can never call a mock function, as that will affect the state of the -mock object and gMock. - -## Setting Expectations - -### Knowing When to Expect {#UseOnCall} - -**`ON_CALL`** is likely the *single most under-utilized construct* in gMock. - -There are basically two constructs for defining the behavior of a mock object: -`ON_CALL` and `EXPECT_CALL`. The difference? `ON_CALL` defines what happens when -a mock method is called, but doesn't imply any expectation on the method -being called. `EXPECT_CALL` not only defines the behavior, but also sets an -expectation that the method will be called with the given arguments, for the -given number of times (and *in the given order* when you specify the order -too). - -Since `EXPECT_CALL` does more, isn't it better than `ON_CALL`? Not really. Every -`EXPECT_CALL` adds a constraint on the behavior of the code under test. Having -more constraints than necessary is *baaad* - even worse than not having enough -constraints. - -This may be counter-intuitive. How could tests that verify more be worse than -tests that verify less? Isn't verification the whole point of tests? - -The answer lies in *what* a test should verify. **A good test verifies the -contract of the code.** If a test over-specifies, it doesn't leave enough -freedom to the implementation. As a result, changing the implementation without -breaking the contract (e.g. refactoring and optimization), which should be -perfectly fine to do, can break such tests. Then you have to spend time fixing -them, only to see them broken again the next time the implementation is changed. - -Keep in mind that one doesn't have to verify more than one property in one test. -In fact, **it's a good style to verify only one thing in one test.** If you do -that, a bug will likely break only one or two tests instead of dozens (which -case would you rather debug?). If you are also in the habit of giving tests -descriptive names that tell what they verify, you can often easily guess what's -wrong just from the test log itself. - -So use `ON_CALL` by default, and only use `EXPECT_CALL` when you actually intend -to verify that the call is made. For example, you may have a bunch of `ON_CALL`s -in your test fixture to set the common mock behavior shared by all tests in the -same group, and write (scarcely) different `EXPECT_CALL`s in different `TEST_F`s -to verify different aspects of the code's behavior. Compared with the style -where each `TEST` has many `EXPECT_CALL`s, this leads to tests that are more -resilient to implementational changes (and thus less likely to require -maintenance) and makes the intent of the tests more obvious (so they are easier -to maintain when you do need to maintain them). - -If you are bothered by the "Uninteresting mock function call" message printed -when a mock method without an `EXPECT_CALL` is called, you may use a `NiceMock` -instead to suppress all such messages for the mock object, or suppress the -message for specific methods by adding `EXPECT_CALL(...).Times(AnyNumber())`. DO -NOT suppress it by blindly adding an `EXPECT_CALL(...)`, or you'll have a test -that's a pain to maintain. - -### Ignoring Uninteresting Calls - -If you are not interested in how a mock method is called, just don't say -anything about it. In this case, if the method is ever called, gMock will -perform its default action to allow the test program to continue. If you are not -happy with the default action taken by gMock, you can override it using -`DefaultValue::Set()` (described [here](#DefaultValue)) or `ON_CALL()`. - -Please note that once you expressed interest in a particular mock method (via -`EXPECT_CALL()`), all invocations to it must match some expectation. If this -function is called but the arguments don't match any `EXPECT_CALL()` statement, -it will be an error. - -### Disallowing Unexpected Calls - -If a mock method shouldn't be called at all, explicitly say so: - -```cpp -using ::testing::_; -... - EXPECT_CALL(foo, Bar(_)) - .Times(0); -``` - -If some calls to the method are allowed, but the rest are not, just list all the -expected calls: - -```cpp -using ::testing::AnyNumber; -using ::testing::Gt; -... - EXPECT_CALL(foo, Bar(5)); - EXPECT_CALL(foo, Bar(Gt(10))) - .Times(AnyNumber()); -``` - -A call to `foo.Bar()` that doesn't match any of the `EXPECT_CALL()` statements -will be an error. - -### Understanding Uninteresting vs Unexpected Calls {#uninteresting-vs-unexpected} - -*Uninteresting* calls and *unexpected* calls are different concepts in gMock. -*Very* different. - -A call `x.Y(...)` is **uninteresting** if there's *not even a single* -`EXPECT_CALL(x, Y(...))` set. In other words, the test isn't interested in the -`x.Y()` method at all, as evident in that the test doesn't care to say anything -about it. - -A call `x.Y(...)` is **unexpected** if there are *some* `EXPECT_CALL(x, -Y(...))`s set, but none of them matches the call. Put another way, the test is -interested in the `x.Y()` method (therefore it explicitly sets some -`EXPECT_CALL` to verify how it's called); however, the verification fails as the -test doesn't expect this particular call to happen. - -**An unexpected call is always an error,** as the code under test doesn't behave -the way the test expects it to behave. - -**By default, an uninteresting call is not an error,** as it violates no -constraint specified by the test. (gMock's philosophy is that saying nothing -means there is no constraint.) However, it leads to a warning, as it *might* -indicate a problem (e.g. the test author might have forgotten to specify a -constraint). - -In gMock, `NiceMock` and `StrictMock` can be used to make a mock class "nice" or -"strict". How does this affect uninteresting calls and unexpected calls? - -A **nice mock** suppresses uninteresting call *warnings*. It is less chatty than -the default mock, but otherwise is the same. If a test fails with a default -mock, it will also fail using a nice mock instead. And vice versa. Don't expect -making a mock nice to change the test's result. - -A **strict mock** turns uninteresting call warnings into errors. So making a -mock strict may change the test's result. - -Let's look at an example: - -```cpp -TEST(...) { - NiceMock mock_registry; - EXPECT_CALL(mock_registry, GetDomainOwner("google.com")) - .WillRepeatedly(Return("Larry Page")); - - // Use mock_registry in code under test. - ... &mock_registry ... -} -``` - -The sole `EXPECT_CALL` here says that all calls to `GetDomainOwner()` must have -`"google.com"` as the argument. If `GetDomainOwner("yahoo.com")` is called, it -will be an unexpected call, and thus an error. *Having a nice mock doesn't -change the severity of an unexpected call.* - -So how do we tell gMock that `GetDomainOwner()` can be called with some other -arguments as well? The standard technique is to add a "catch all" `EXPECT_CALL`: - -```cpp - EXPECT_CALL(mock_registry, GetDomainOwner(_)) - .Times(AnyNumber()); // catches all other calls to this method. - EXPECT_CALL(mock_registry, GetDomainOwner("google.com")) - .WillRepeatedly(Return("Larry Page")); -``` - -Remember that `_` is the wildcard matcher that matches anything. With this, if -`GetDomainOwner("google.com")` is called, it will do what the second -`EXPECT_CALL` says; if it is called with a different argument, it will do what -the first `EXPECT_CALL` says. - -Note that the order of the two `EXPECT_CALL`s is important, as a newer -`EXPECT_CALL` takes precedence over an older one. - -For more on uninteresting calls, nice mocks, and strict mocks, read -["The Nice, the Strict, and the Naggy"](#NiceStrictNaggy). - -### Ignoring Uninteresting Arguments {#ParameterlessExpectations} - -If your test doesn't care about the parameters (it only cares about the number -or order of calls), you can often simply omit the parameter list: - -```cpp - // Expect foo.Bar( ... ) twice with any arguments. - EXPECT_CALL(foo, Bar).Times(2); - - // Delegate to the given method whenever the factory is invoked. - ON_CALL(foo_factory, MakeFoo) - .WillByDefault(&BuildFooForTest); -``` - -This functionality is only available when a method is not overloaded; to prevent -unexpected behavior it is a compilation error to try to set an expectation on a -method where the specific overload is ambiguous. You can work around this by -supplying a [simpler mock interface](#SimplerInterfaces) than the mocked class -provides. - -This pattern is also useful when the arguments are interesting, but match logic -is substantially complex. You can leave the argument list unspecified and use -SaveArg actions to [save the values for later verification](#SaveArgVerify). If -you do that, you can easily differentiate calling the method the wrong number of -times from calling it with the wrong arguments. - -### Expecting Ordered Calls {#OrderedCalls} - -Although an `EXPECT_CALL()` statement defined later takes precedence when gMock -tries to match a function call with an expectation, by default calls don't have -to happen in the order `EXPECT_CALL()` statements are written. For example, if -the arguments match the matchers in the second `EXPECT_CALL()`, but not those in -the first and third, then the second expectation will be used. - -If you would rather have all calls occur in the order of the expectations, put -the `EXPECT_CALL()` statements in a block where you define a variable of type -`InSequence`: - -```cpp -using ::testing::_; -using ::testing::InSequence; - - { - InSequence s; - - EXPECT_CALL(foo, DoThis(5)); - EXPECT_CALL(bar, DoThat(_)) - .Times(2); - EXPECT_CALL(foo, DoThis(6)); - } -``` - -In this example, we expect a call to `foo.DoThis(5)`, followed by two calls to -`bar.DoThat()` where the argument can be anything, which are in turn followed by -a call to `foo.DoThis(6)`. If a call occurred out-of-order, gMock will report an -error. - -### Expecting Partially Ordered Calls {#PartialOrder} - -Sometimes requiring everything to occur in a predetermined order can lead to -brittle tests. For example, we may care about `A` occurring before both `B` and -`C`, but aren't interested in the relative order of `B` and `C`. In this case, -the test should reflect our real intent, instead of being overly constraining. - -gMock allows you to impose an arbitrary DAG (directed acyclic graph) on the -calls. One way to express the DAG is to use the -[`After` clause](reference/mocking.md#EXPECT_CALL.After) of `EXPECT_CALL`. - -Another way is via the `InSequence()` clause (not the same as the `InSequence` -class), which we borrowed from jMock 2. It's less flexible than `After()`, but -more convenient when you have long chains of sequential calls, as it doesn't -require you to come up with different names for the expectations in the chains. -Here's how it works: - -If we view `EXPECT_CALL()` statements as nodes in a graph, and add an edge from -node A to node B wherever A must occur before B, we can get a DAG. We use the -term "sequence" to mean a directed path in this DAG. Now, if we decompose the -DAG into sequences, we just need to know which sequences each `EXPECT_CALL()` -belongs to in order to be able to reconstruct the original DAG. - -So, to specify the partial order on the expectations we need to do two things: -first to define some `Sequence` objects, and then for each `EXPECT_CALL()` say -which `Sequence` objects it is part of. - -Expectations in the same sequence must occur in the order they are written. For -example, - -```cpp -using ::testing::Sequence; -... - Sequence s1, s2; - - EXPECT_CALL(foo, A()) - .InSequence(s1, s2); - EXPECT_CALL(bar, B()) - .InSequence(s1); - EXPECT_CALL(bar, C()) - .InSequence(s2); - EXPECT_CALL(foo, D()) - .InSequence(s2); -``` - -specifies the following DAG (where `s1` is `A -> B`, and `s2` is `A -> C -> D`): - -```text - +---> B - | - A ---| - | - +---> C ---> D -``` - -This means that A must occur before B and C, and C must occur before D. There's -no restriction about the order other than these. - -### Controlling When an Expectation Retires - -When a mock method is called, gMock only considers expectations that are still -active. An expectation is active when created, and becomes inactive (aka -*retires*) when a call that has to occur later has occurred. For example, in - -```cpp -using ::testing::_; -using ::testing::Sequence; -... - Sequence s1, s2; - - EXPECT_CALL(log, Log(WARNING, _, "File too large.")) // #1 - .Times(AnyNumber()) - .InSequence(s1, s2); - EXPECT_CALL(log, Log(WARNING, _, "Data set is empty.")) // #2 - .InSequence(s1); - EXPECT_CALL(log, Log(WARNING, _, "User not found.")) // #3 - .InSequence(s2); -``` - -as soon as either #2 or #3 is matched, #1 will retire. If a warning `"File too -large."` is logged after this, it will be an error. - -Note that an expectation doesn't retire automatically when it's saturated. For -example, - -```cpp -using ::testing::_; -... - EXPECT_CALL(log, Log(WARNING, _, _)); // #1 - EXPECT_CALL(log, Log(WARNING, _, "File too large.")); // #2 -``` - -says that there will be exactly one warning with the message `"File too -large."`. If the second warning contains this message too, #2 will match again -and result in an upper-bound-violated error. - -If this is not what you want, you can ask an expectation to retire as soon as it -becomes saturated: - -```cpp -using ::testing::_; -... - EXPECT_CALL(log, Log(WARNING, _, _)); // #1 - EXPECT_CALL(log, Log(WARNING, _, "File too large.")) // #2 - .RetiresOnSaturation(); -``` - -Here #2 can be used only once, so if you have two warnings with the message -`"File too large."`, the first will match #2 and the second will match #1 - -there will be no error. - -## Using Actions - -### Returning References from Mock Methods - -If a mock function's return type is a reference, you need to use `ReturnRef()` -instead of `Return()` to return a result: - -```cpp -using ::testing::ReturnRef; - -class MockFoo : public Foo { - public: - MOCK_METHOD(Bar&, GetBar, (), (override)); -}; -... - MockFoo foo; - Bar bar; - EXPECT_CALL(foo, GetBar()) - .WillOnce(ReturnRef(bar)); -... -``` - -### Returning Live Values from Mock Methods - -The `Return(x)` action saves a copy of `x` when the action is created, and -always returns the same value whenever it's executed. Sometimes you may want to -instead return the *live* value of `x` (i.e. its value at the time when the -action is *executed*.). Use either `ReturnRef()` or `ReturnPointee()` for this -purpose. - -If the mock function's return type is a reference, you can do it using -`ReturnRef(x)`, as shown in the previous recipe ("Returning References from Mock -Methods"). However, gMock doesn't let you use `ReturnRef()` in a mock function -whose return type is not a reference, as doing that usually indicates a user -error. So, what shall you do? - -Though you may be tempted, DO NOT use `std::ref()`: - -```cpp -using testing::Return; - -class MockFoo : public Foo { - public: - MOCK_METHOD(int, GetValue, (), (override)); -}; -... - int x = 0; - MockFoo foo; - EXPECT_CALL(foo, GetValue()) - .WillRepeatedly(Return(std::ref(x))); // Wrong! - x = 42; - EXPECT_EQ(42, foo.GetValue()); -``` - -Unfortunately, it doesn't work here. The above code will fail with error: - -```text -Value of: foo.GetValue() - Actual: 0 -Expected: 42 -``` - -The reason is that `Return(*value*)` converts `value` to the actual return type -of the mock function at the time when the action is *created*, not when it is -*executed*. (This behavior was chosen for the action to be safe when `value` is -a proxy object that references some temporary objects.) As a result, -`std::ref(x)` is converted to an `int` value (instead of a `const int&`) when -the expectation is set, and `Return(std::ref(x))` will always return 0. - -`ReturnPointee(pointer)` was provided to solve this problem specifically. It -returns the value pointed to by `pointer` at the time the action is *executed*: - -```cpp -using testing::ReturnPointee; -... - int x = 0; - MockFoo foo; - EXPECT_CALL(foo, GetValue()) - .WillRepeatedly(ReturnPointee(&x)); // Note the & here. - x = 42; - EXPECT_EQ(42, foo.GetValue()); // This will succeed now. -``` - -### Combining Actions - -Want to do more than one thing when a function is called? That's fine. `DoAll()` -allow you to do sequence of actions every time. Only the return value of the -last action in the sequence will be used. - -```cpp -using ::testing::_; -using ::testing::DoAll; - -class MockFoo : public Foo { - public: - MOCK_METHOD(bool, Bar, (int n), (override)); -}; -... - EXPECT_CALL(foo, Bar(_)) - .WillOnce(DoAll(action_1, - action_2, - ... - action_n)); -``` - -### Verifying Complex Arguments {#SaveArgVerify} - -If you want to verify that a method is called with a particular argument but the -match criteria is complex, it can be difficult to distinguish between -cardinality failures (calling the method the wrong number of times) and argument -match failures. Similarly, if you are matching multiple parameters, it may not -be easy to distinguishing which argument failed to match. For example: - -```cpp - // Not ideal: this could fail because of a problem with arg1 or arg2, or maybe - // just the method wasn't called. - EXPECT_CALL(foo, SendValues(_, ElementsAre(1, 4, 4, 7), EqualsProto( ... ))); -``` - -You can instead save the arguments and test them individually: - -```cpp - EXPECT_CALL(foo, SendValues) - .WillOnce(DoAll(SaveArg<1>(&actual_array), SaveArg<2>(&actual_proto))); - ... run the test - EXPECT_THAT(actual_array, ElementsAre(1, 4, 4, 7)); - EXPECT_THAT(actual_proto, EqualsProto( ... )); -``` - -### Mocking Side Effects {#MockingSideEffects} - -Sometimes a method exhibits its effect not via returning a value but via side -effects. For example, it may change some global state or modify an output -argument. To mock side effects, in general you can define your own action by -implementing `::testing::ActionInterface`. - -If all you need to do is to change an output argument, the built-in -`SetArgPointee()` action is convenient: - -```cpp -using ::testing::_; -using ::testing::SetArgPointee; - -class MockMutator : public Mutator { - public: - MOCK_METHOD(void, Mutate, (bool mutate, int* value), (override)); - ... -} -... - MockMutator mutator; - EXPECT_CALL(mutator, Mutate(true, _)) - .WillOnce(SetArgPointee<1>(5)); -``` - -In this example, when `mutator.Mutate()` is called, we will assign 5 to the -`int` variable pointed to by argument #1 (0-based). - -`SetArgPointee()` conveniently makes an internal copy of the value you pass to -it, removing the need to keep the value in scope and alive. The implication -however is that the value must have a copy constructor and assignment operator. - -If the mock method also needs to return a value as well, you can chain -`SetArgPointee()` with `Return()` using `DoAll()`, remembering to put the -`Return()` statement last: - -```cpp -using ::testing::_; -using ::testing::Return; -using ::testing::SetArgPointee; - -class MockMutator : public Mutator { - public: - ... - MOCK_METHOD(bool, MutateInt, (int* value), (override)); -} -... - MockMutator mutator; - EXPECT_CALL(mutator, MutateInt(_)) - .WillOnce(DoAll(SetArgPointee<0>(5), - Return(true))); -``` - -Note, however, that if you use the `ReturnOKWith()` method, it will override the -values provided by `SetArgPointee()` in the response parameters of your function -call. - -If the output argument is an array, use the `SetArrayArgument(first, last)` -action instead. It copies the elements in source range `[first, last)` to the -array pointed to by the `N`-th (0-based) argument: - -```cpp -using ::testing::NotNull; -using ::testing::SetArrayArgument; - -class MockArrayMutator : public ArrayMutator { - public: - MOCK_METHOD(void, Mutate, (int* values, int num_values), (override)); - ... -} -... - MockArrayMutator mutator; - int values[5] = {1, 2, 3, 4, 5}; - EXPECT_CALL(mutator, Mutate(NotNull(), 5)) - .WillOnce(SetArrayArgument<0>(values, values + 5)); -``` - -This also works when the argument is an output iterator: - -```cpp -using ::testing::_; -using ::testing::SetArrayArgument; - -class MockRolodex : public Rolodex { - public: - MOCK_METHOD(void, GetNames, (std::back_insert_iterator>), - (override)); - ... -} -... - MockRolodex rolodex; - vector names; - names.push_back("George"); - names.push_back("John"); - names.push_back("Thomas"); - EXPECT_CALL(rolodex, GetNames(_)) - .WillOnce(SetArrayArgument<0>(names.begin(), names.end())); -``` - -### Changing a Mock Object's Behavior Based on the State - -If you expect a call to change the behavior of a mock object, you can use -`::testing::InSequence` to specify different behaviors before and after the -call: - -```cpp -using ::testing::InSequence; -using ::testing::Return; - -... - { - InSequence seq; - EXPECT_CALL(my_mock, IsDirty()) - .WillRepeatedly(Return(true)); - EXPECT_CALL(my_mock, Flush()); - EXPECT_CALL(my_mock, IsDirty()) - .WillRepeatedly(Return(false)); - } - my_mock.FlushIfDirty(); -``` - -This makes `my_mock.IsDirty()` return `true` before `my_mock.Flush()` is called -and return `false` afterwards. - -If the behavior change is more complex, you can store the effects in a variable -and make a mock method get its return value from that variable: - -```cpp -using ::testing::_; -using ::testing::SaveArg; -using ::testing::Return; - -ACTION_P(ReturnPointee, p) { return *p; } -... - int previous_value = 0; - EXPECT_CALL(my_mock, GetPrevValue) - .WillRepeatedly(ReturnPointee(&previous_value)); - EXPECT_CALL(my_mock, UpdateValue) - .WillRepeatedly(SaveArg<0>(&previous_value)); - my_mock.DoSomethingToUpdateValue(); -``` - -Here `my_mock.GetPrevValue()` will always return the argument of the last -`UpdateValue()` call. - -### Setting the Default Value for a Return Type {#DefaultValue} - -If a mock method's return type is a built-in C++ type or pointer, by default it -will return 0 when invoked. Also, in C++ 11 and above, a mock method whose -return type has a default constructor will return a default-constructed value by -default. You only need to specify an action if this default value doesn't work -for you. - -Sometimes, you may want to change this default value, or you may want to specify -a default value for types gMock doesn't know about. You can do this using the -`::testing::DefaultValue` class template: - -```cpp -using ::testing::DefaultValue; - -class MockFoo : public Foo { - public: - MOCK_METHOD(Bar, CalculateBar, (), (override)); -}; - - -... - Bar default_bar; - // Sets the default return value for type Bar. - DefaultValue::Set(default_bar); - - MockFoo foo; - - // We don't need to specify an action here, as the default - // return value works for us. - EXPECT_CALL(foo, CalculateBar()); - - foo.CalculateBar(); // This should return default_bar. - - // Unsets the default return value. - DefaultValue::Clear(); -``` - -Please note that changing the default value for a type can make your tests hard -to understand. We recommend you to use this feature judiciously. For example, -you may want to make sure the `Set()` and `Clear()` calls are right next to the -code that uses your mock. - -### Setting the Default Actions for a Mock Method - -You've learned how to change the default value of a given type. However, this -may be too coarse for your purpose: perhaps you have two mock methods with the -same return type and you want them to have different behaviors. The `ON_CALL()` -macro allows you to customize your mock's behavior at the method level: - -```cpp -using ::testing::_; -using ::testing::AnyNumber; -using ::testing::Gt; -using ::testing::Return; -... - ON_CALL(foo, Sign(_)) - .WillByDefault(Return(-1)); - ON_CALL(foo, Sign(0)) - .WillByDefault(Return(0)); - ON_CALL(foo, Sign(Gt(0))) - .WillByDefault(Return(1)); - - EXPECT_CALL(foo, Sign(_)) - .Times(AnyNumber()); - - foo.Sign(5); // This should return 1. - foo.Sign(-9); // This should return -1. - foo.Sign(0); // This should return 0. -``` - -As you may have guessed, when there are more than one `ON_CALL()` statements, -the newer ones in the order take precedence over the older ones. In other words, -the **last** one that matches the function arguments will be used. This matching -order allows you to set up the common behavior in a mock object's constructor or -the test fixture's set-up phase and specialize the mock's behavior later. - -Note that both `ON_CALL` and `EXPECT_CALL` have the same "later statements take -precedence" rule, but they don't interact. That is, `EXPECT_CALL`s have their -own precedence order distinct from the `ON_CALL` precedence order. - -### Using Functions/Methods/Functors/Lambdas as Actions {#FunctionsAsActions} - -If the built-in actions don't suit you, you can use an existing callable -(function, `std::function`, method, functor, lambda) as an action. - -```cpp -using ::testing::_; using ::testing::Invoke; - -class MockFoo : public Foo { - public: - MOCK_METHOD(int, Sum, (int x, int y), (override)); - MOCK_METHOD(bool, ComplexJob, (int x), (override)); -}; - -int CalculateSum(int x, int y) { return x + y; } -int Sum3(int x, int y, int z) { return x + y + z; } - -class Helper { - public: - bool ComplexJob(int x); -}; - -... - MockFoo foo; - Helper helper; - EXPECT_CALL(foo, Sum(_, _)) - .WillOnce(&CalculateSum) - .WillRepeatedly(Invoke(NewPermanentCallback(Sum3, 1))); - EXPECT_CALL(foo, ComplexJob(_)) - .WillOnce(Invoke(&helper, &Helper::ComplexJob)) - .WillOnce([] { return true; }) - .WillRepeatedly([](int x) { return x > 0; }); - - foo.Sum(5, 6); // Invokes CalculateSum(5, 6). - foo.Sum(2, 3); // Invokes Sum3(1, 2, 3). - foo.ComplexJob(10); // Invokes helper.ComplexJob(10). - foo.ComplexJob(-1); // Invokes the inline lambda. -``` - -The only requirement is that the type of the function, etc must be *compatible* -with the signature of the mock function, meaning that the latter's arguments (if -it takes any) can be implicitly converted to the corresponding arguments of the -former, and the former's return type can be implicitly converted to that of the -latter. So, you can invoke something whose type is *not* exactly the same as the -mock function, as long as it's safe to do so - nice, huh? - -Note that: - -* The action takes ownership of the callback and will delete it when the - action itself is destructed. -* If the type of a callback is derived from a base callback type `C`, you need - to implicitly cast it to `C` to resolve the overloading, e.g. - - ```cpp - using ::testing::Invoke; - ... - ResultCallback* is_ok = ...; - ... Invoke(is_ok) ...; // This works. - - BlockingClosure* done = new BlockingClosure; - ... Invoke(implicit_cast(done)) ...; // The cast is necessary. - ``` - -### Using Functions with Extra Info as Actions - -The function or functor you call using `Invoke()` must have the same number of -arguments as the mock function you use it for. Sometimes you may have a function -that takes more arguments, and you are willing to pass in the extra arguments -yourself to fill the gap. You can do this in gMock using callbacks with -pre-bound arguments. Here's an example: - -```cpp -using ::testing::Invoke; - -class MockFoo : public Foo { - public: - MOCK_METHOD(char, DoThis, (int n), (override)); -}; - -char SignOfSum(int x, int y) { - const int sum = x + y; - return (sum > 0) ? '+' : (sum < 0) ? '-' : '0'; -} - -TEST_F(FooTest, Test) { - MockFoo foo; - - EXPECT_CALL(foo, DoThis(2)) - .WillOnce(Invoke(NewPermanentCallback(SignOfSum, 5))); - EXPECT_EQ('+', foo.DoThis(2)); // Invokes SignOfSum(5, 2). -} -``` - -### Invoking a Function/Method/Functor/Lambda/Callback Without Arguments - -`Invoke()` passes the mock function's arguments to the function, etc being -invoked such that the callee has the full context of the call to work with. If -the invoked function is not interested in some or all of the arguments, it can -simply ignore them. - -Yet, a common pattern is that a test author wants to invoke a function without -the arguments of the mock function. She could do that using a wrapper function -that throws away the arguments before invoking an underlining nullary function. -Needless to say, this can be tedious and obscures the intent of the test. - -There are two solutions to this problem. First, you can pass any callable of -zero args as an action. Alternatively, use `InvokeWithoutArgs()`, which is like -`Invoke()` except that it doesn't pass the mock function's arguments to the -callee. Here's an example of each: - -```cpp -using ::testing::_; -using ::testing::InvokeWithoutArgs; - -class MockFoo : public Foo { - public: - MOCK_METHOD(bool, ComplexJob, (int n), (override)); -}; - -bool Job1() { ... } -bool Job2(int n, char c) { ... } - -... - MockFoo foo; - EXPECT_CALL(foo, ComplexJob(_)) - .WillOnce([] { Job1(); }); - .WillOnce(InvokeWithoutArgs(NewPermanentCallback(Job2, 5, 'a'))); - - foo.ComplexJob(10); // Invokes Job1(). - foo.ComplexJob(20); // Invokes Job2(5, 'a'). -``` - -Note that: - -* The action takes ownership of the callback and will delete it when the - action itself is destructed. -* If the type of a callback is derived from a base callback type `C`, you need - to implicitly cast it to `C` to resolve the overloading, e.g. - - ```cpp - using ::testing::InvokeWithoutArgs; - ... - ResultCallback* is_ok = ...; - ... InvokeWithoutArgs(is_ok) ...; // This works. - - BlockingClosure* done = ...; - ... InvokeWithoutArgs(implicit_cast(done)) ...; - // The cast is necessary. - ``` - -### Invoking an Argument of the Mock Function - -Sometimes a mock function will receive a function pointer, a functor (in other -words, a "callable") as an argument, e.g. - -```cpp -class MockFoo : public Foo { - public: - MOCK_METHOD(bool, DoThis, (int n, (ResultCallback1* callback)), - (override)); -}; -``` - -and you may want to invoke this callable argument: - -```cpp -using ::testing::_; -... - MockFoo foo; - EXPECT_CALL(foo, DoThis(_, _)) - .WillOnce(...); - // Will execute callback->Run(5), where callback is the - // second argument DoThis() receives. -``` - -{: .callout .note} -NOTE: The section below is legacy documentation from before C++ had lambdas: - -Arghh, you need to refer to a mock function argument but C++ has no lambda -(yet), so you have to define your own action. :-( Or do you really? - -Well, gMock has an action to solve *exactly* this problem: - -```cpp -InvokeArgument(arg_1, arg_2, ..., arg_m) -``` - -will invoke the `N`-th (0-based) argument the mock function receives, with -`arg_1`, `arg_2`, ..., and `arg_m`. No matter if the argument is a function -pointer, a functor, or a callback. gMock handles them all. - -With that, you could write: - -```cpp -using ::testing::_; -using ::testing::InvokeArgument; -... - EXPECT_CALL(foo, DoThis(_, _)) - .WillOnce(InvokeArgument<1>(5)); - // Will execute callback->Run(5), where callback is the - // second argument DoThis() receives. -``` - -What if the callable takes an argument by reference? No problem - just wrap it -inside `std::ref()`: - -```cpp - ... - MOCK_METHOD(bool, Bar, - ((ResultCallback2* callback)), - (override)); - ... - using ::testing::_; - using ::testing::InvokeArgument; - ... - MockFoo foo; - Helper helper; - ... - EXPECT_CALL(foo, Bar(_)) - .WillOnce(InvokeArgument<0>(5, std::ref(helper))); - // std::ref(helper) guarantees that a reference to helper, not a copy of - // it, will be passed to the callback. -``` - -What if the callable takes an argument by reference and we do **not** wrap the -argument in `std::ref()`? Then `InvokeArgument()` will *make a copy* of the -argument, and pass a *reference to the copy*, instead of a reference to the -original value, to the callable. This is especially handy when the argument is a -temporary value: - -```cpp - ... - MOCK_METHOD(bool, DoThat, (bool (*f)(const double& x, const string& s)), - (override)); - ... - using ::testing::_; - using ::testing::InvokeArgument; - ... - MockFoo foo; - ... - EXPECT_CALL(foo, DoThat(_)) - .WillOnce(InvokeArgument<0>(5.0, string("Hi"))); - // Will execute (*f)(5.0, string("Hi")), where f is the function pointer - // DoThat() receives. Note that the values 5.0 and string("Hi") are - // temporary and dead once the EXPECT_CALL() statement finishes. Yet - // it's fine to perform this action later, since a copy of the values - // are kept inside the InvokeArgument action. -``` - -### Ignoring an Action's Result - -Sometimes you have an action that returns *something*, but you need an action -that returns `void` (perhaps you want to use it in a mock function that returns -`void`, or perhaps it needs to be used in `DoAll()` and it's not the last in the -list). `IgnoreResult()` lets you do that. For example: - -```cpp -using ::testing::_; -using ::testing::DoAll; -using ::testing::IgnoreResult; -using ::testing::Return; - -int Process(const MyData& data); -string DoSomething(); - -class MockFoo : public Foo { - public: - MOCK_METHOD(void, Abc, (const MyData& data), (override)); - MOCK_METHOD(bool, Xyz, (), (override)); -}; - - ... - MockFoo foo; - EXPECT_CALL(foo, Abc(_)) - // .WillOnce(Invoke(Process)); - // The above line won't compile as Process() returns int but Abc() needs - // to return void. - .WillOnce(IgnoreResult(Process)); - EXPECT_CALL(foo, Xyz()) - .WillOnce(DoAll(IgnoreResult(DoSomething), - // Ignores the string DoSomething() returns. - Return(true))); -``` - -Note that you **cannot** use `IgnoreResult()` on an action that already returns -`void`. Doing so will lead to ugly compiler errors. - -### Selecting an Action's Arguments {#SelectingArgs} - -Say you have a mock function `Foo()` that takes seven arguments, and you have a -custom action that you want to invoke when `Foo()` is called. Trouble is, the -custom action only wants three arguments: - -```cpp -using ::testing::_; -using ::testing::Invoke; -... - MOCK_METHOD(bool, Foo, - (bool visible, const string& name, int x, int y, - (const map>), double& weight, double min_weight, - double max_wight)); -... -bool IsVisibleInQuadrant1(bool visible, int x, int y) { - return visible && x >= 0 && y >= 0; -} -... - EXPECT_CALL(mock, Foo) - .WillOnce(Invoke(IsVisibleInQuadrant1)); // Uh, won't compile. :-( -``` - -To please the compiler God, you need to define an "adaptor" that has the same -signature as `Foo()` and calls the custom action with the right arguments: - -```cpp -using ::testing::_; -using ::testing::Invoke; -... -bool MyIsVisibleInQuadrant1(bool visible, const string& name, int x, int y, - const map, double>& weight, - double min_weight, double max_wight) { - return IsVisibleInQuadrant1(visible, x, y); -} -... - EXPECT_CALL(mock, Foo) - .WillOnce(Invoke(MyIsVisibleInQuadrant1)); // Now it works. -``` - -But isn't this awkward? - -gMock provides a generic *action adaptor*, so you can spend your time minding -more important business than writing your own adaptors. Here's the syntax: - -```cpp -WithArgs(action) -``` - -creates an action that passes the arguments of the mock function at the given -indices (0-based) to the inner `action` and performs it. Using `WithArgs`, our -original example can be written as: - -```cpp -using ::testing::_; -using ::testing::Invoke; -using ::testing::WithArgs; -... - EXPECT_CALL(mock, Foo) - .WillOnce(WithArgs<0, 2, 3>(Invoke(IsVisibleInQuadrant1))); // No need to define your own adaptor. -``` - -For better readability, gMock also gives you: - -* `WithoutArgs(action)` when the inner `action` takes *no* argument, and -* `WithArg(action)` (no `s` after `Arg`) when the inner `action` takes - *one* argument. - -As you may have realized, `InvokeWithoutArgs(...)` is just syntactic sugar for -`WithoutArgs(Invoke(...))`. - -Here are more tips: - -* The inner action used in `WithArgs` and friends does not have to be - `Invoke()` -- it can be anything. -* You can repeat an argument in the argument list if necessary, e.g. - `WithArgs<2, 3, 3, 5>(...)`. -* You can change the order of the arguments, e.g. `WithArgs<3, 2, 1>(...)`. -* The types of the selected arguments do *not* have to match the signature of - the inner action exactly. It works as long as they can be implicitly - converted to the corresponding arguments of the inner action. For example, - if the 4-th argument of the mock function is an `int` and `my_action` takes - a `double`, `WithArg<4>(my_action)` will work. - -### Ignoring Arguments in Action Functions - -The [selecting-an-action's-arguments](#SelectingArgs) recipe showed us one way -to make a mock function and an action with incompatible argument lists fit -together. The downside is that wrapping the action in `WithArgs<...>()` can get -tedious for people writing the tests. - -If you are defining a function (or method, functor, lambda, callback) to be used -with `Invoke*()`, and you are not interested in some of its arguments, an -alternative to `WithArgs` is to declare the uninteresting arguments as `Unused`. -This makes the definition less cluttered and less fragile in case the types of -the uninteresting arguments change. It could also increase the chance the action -function can be reused. For example, given - -```cpp - public: - MOCK_METHOD(double, Foo, double(const string& label, double x, double y), - (override)); - MOCK_METHOD(double, Bar, (int index, double x, double y), (override)); -``` - -instead of - -```cpp -using ::testing::_; -using ::testing::Invoke; - -double DistanceToOriginWithLabel(const string& label, double x, double y) { - return sqrt(x*x + y*y); -} -double DistanceToOriginWithIndex(int index, double x, double y) { - return sqrt(x*x + y*y); -} -... - EXPECT_CALL(mock, Foo("abc", _, _)) - .WillOnce(Invoke(DistanceToOriginWithLabel)); - EXPECT_CALL(mock, Bar(5, _, _)) - .WillOnce(Invoke(DistanceToOriginWithIndex)); -``` - -you could write - -```cpp -using ::testing::_; -using ::testing::Invoke; -using ::testing::Unused; - -double DistanceToOrigin(Unused, double x, double y) { - return sqrt(x*x + y*y); -} -... - EXPECT_CALL(mock, Foo("abc", _, _)) - .WillOnce(Invoke(DistanceToOrigin)); - EXPECT_CALL(mock, Bar(5, _, _)) - .WillOnce(Invoke(DistanceToOrigin)); -``` - -### Sharing Actions - -Just like matchers, a gMock action object consists of a pointer to a ref-counted -implementation object. Therefore copying actions is also allowed and very -efficient. When the last action that references the implementation object dies, -the implementation object will be deleted. - -If you have some complex action that you want to use again and again, you may -not have to build it from scratch everytime. If the action doesn't have an -internal state (i.e. if it always does the same thing no matter how many times -it has been called), you can assign it to an action variable and use that -variable repeatedly. For example: - -```cpp -using ::testing::Action; -using ::testing::DoAll; -using ::testing::Return; -using ::testing::SetArgPointee; -... - Action set_flag = DoAll(SetArgPointee<0>(5), - Return(true)); - ... use set_flag in .WillOnce() and .WillRepeatedly() ... -``` - -However, if the action has its own state, you may be surprised if you share the -action object. Suppose you have an action factory `IncrementCounter(init)` which -creates an action that increments and returns a counter whose initial value is -`init`, using two actions created from the same expression and using a shared -action will exhibit different behaviors. Example: - -```cpp - EXPECT_CALL(foo, DoThis()) - .WillRepeatedly(IncrementCounter(0)); - EXPECT_CALL(foo, DoThat()) - .WillRepeatedly(IncrementCounter(0)); - foo.DoThis(); // Returns 1. - foo.DoThis(); // Returns 2. - foo.DoThat(); // Returns 1 - Blah() uses a different - // counter than Bar()'s. -``` - -versus - -```cpp -using ::testing::Action; -... - Action increment = IncrementCounter(0); - EXPECT_CALL(foo, DoThis()) - .WillRepeatedly(increment); - EXPECT_CALL(foo, DoThat()) - .WillRepeatedly(increment); - foo.DoThis(); // Returns 1. - foo.DoThis(); // Returns 2. - foo.DoThat(); // Returns 3 - the counter is shared. -``` - -### Testing Asynchronous Behavior - -One oft-encountered problem with gMock is that it can be hard to test -asynchronous behavior. Suppose you had a `EventQueue` class that you wanted to -test, and you created a separate `EventDispatcher` interface so that you could -easily mock it out. However, the implementation of the class fired all the -events on a background thread, which made test timings difficult. You could just -insert `sleep()` statements and hope for the best, but that makes your test -behavior nondeterministic. A better way is to use gMock actions and -`Notification` objects to force your asynchronous test to behave synchronously. - -```cpp -class MockEventDispatcher : public EventDispatcher { - MOCK_METHOD(bool, DispatchEvent, (int32), (override)); -}; - -TEST(EventQueueTest, EnqueueEventTest) { - MockEventDispatcher mock_event_dispatcher; - EventQueue event_queue(&mock_event_dispatcher); - - const int32 kEventId = 321; - absl::Notification done; - EXPECT_CALL(mock_event_dispatcher, DispatchEvent(kEventId)) - .WillOnce([&done] { done.Notify(); }); - - event_queue.EnqueueEvent(kEventId); - done.WaitForNotification(); -} -``` - -In the example above, we set our normal gMock expectations, but then add an -additional action to notify the `Notification` object. Now we can just call -`Notification::WaitForNotification()` in the main thread to wait for the -asynchronous call to finish. After that, our test suite is complete and we can -safely exit. - -{: .callout .note} -Note: this example has a downside: namely, if the expectation is not satisfied, -our test will run forever. It will eventually time-out and fail, but it will -take longer and be slightly harder to debug. To alleviate this problem, you can -use `WaitForNotificationWithTimeout(ms)` instead of `WaitForNotification()`. - -## Misc Recipes on Using gMock - -### Mocking Methods That Use Move-Only Types - -C++11 introduced *move-only types*. A move-only-typed value can be moved from -one object to another, but cannot be copied. `std::unique_ptr` is probably -the most commonly used move-only type. - -Mocking a method that takes and/or returns move-only types presents some -challenges, but nothing insurmountable. This recipe shows you how you can do it. -Note that the support for move-only method arguments was only introduced to -gMock in April 2017; in older code, you may find more complex -[workarounds](#LegacyMoveOnly) for lack of this feature. - -Let’s say we are working on a fictional project that lets one post and share -snippets called “buzzes”. Your code uses these types: - -```cpp -enum class AccessLevel { kInternal, kPublic }; - -class Buzz { - public: - explicit Buzz(AccessLevel access) { ... } - ... -}; - -class Buzzer { - public: - virtual ~Buzzer() {} - virtual std::unique_ptr MakeBuzz(StringPiece text) = 0; - virtual bool ShareBuzz(std::unique_ptr buzz, int64_t timestamp) = 0; - ... -}; -``` - -A `Buzz` object represents a snippet being posted. A class that implements the -`Buzzer` interface is capable of creating and sharing `Buzz`es. Methods in -`Buzzer` may return a `unique_ptr` or take a `unique_ptr`. Now we -need to mock `Buzzer` in our tests. - -To mock a method that accepts or returns move-only types, you just use the -familiar `MOCK_METHOD` syntax as usual: - -```cpp -class MockBuzzer : public Buzzer { - public: - MOCK_METHOD(std::unique_ptr, MakeBuzz, (StringPiece text), (override)); - MOCK_METHOD(bool, ShareBuzz, (std::unique_ptr buzz, int64_t timestamp), - (override)); -}; -``` - -Now that we have the mock class defined, we can use it in tests. In the -following code examples, we assume that we have defined a `MockBuzzer` object -named `mock_buzzer_`: - -```cpp - MockBuzzer mock_buzzer_; -``` - -First let’s see how we can set expectations on the `MakeBuzz()` method, which -returns a `unique_ptr`. - -As usual, if you set an expectation without an action (i.e. the `.WillOnce()` or -`.WillRepeatedly()` clause), when that expectation fires, the default action for -that method will be taken. Since `unique_ptr<>` has a default constructor that -returns a null `unique_ptr`, that’s what you’ll get if you don’t specify an -action: - -```cpp - // Use the default action. - EXPECT_CALL(mock_buzzer_, MakeBuzz("hello")); - - // Triggers the previous EXPECT_CALL. - EXPECT_EQ(nullptr, mock_buzzer_.MakeBuzz("hello")); -``` - -If you are not happy with the default action, you can tweak it as usual; see -[Setting Default Actions](#OnCall). - -If you just need to return a pre-defined move-only value, you can use the -`Return(ByMove(...))` action: - -```cpp - // When this fires, the unique_ptr<> specified by ByMove(...) will - // be returned. - EXPECT_CALL(mock_buzzer_, MakeBuzz("world")) - .WillOnce(Return(ByMove(MakeUnique(AccessLevel::kInternal)))); - - EXPECT_NE(nullptr, mock_buzzer_.MakeBuzz("world")); -``` - -Note that `ByMove()` is essential here - if you drop it, the code won’t compile. - -Quiz time! What do you think will happen if a `Return(ByMove(...))` action is -performed more than once (e.g. you write `... -.WillRepeatedly(Return(ByMove(...)));`)? Come think of it, after the first time -the action runs, the source value will be consumed (since it’s a move-only -value), so the next time around, there’s no value to move from -- you’ll get a -run-time error that `Return(ByMove(...))` can only be run once. - -If you need your mock method to do more than just moving a pre-defined value, -remember that you can always use a lambda or a callable object, which can do -pretty much anything you want: - -```cpp - EXPECT_CALL(mock_buzzer_, MakeBuzz("x")) - .WillRepeatedly([](StringPiece text) { - return MakeUnique(AccessLevel::kInternal); - }); - - EXPECT_NE(nullptr, mock_buzzer_.MakeBuzz("x")); - EXPECT_NE(nullptr, mock_buzzer_.MakeBuzz("x")); -``` - -Every time this `EXPECT_CALL` fires, a new `unique_ptr` will be created -and returned. You cannot do this with `Return(ByMove(...))`. - -That covers returning move-only values; but how do we work with methods -accepting move-only arguments? The answer is that they work normally, although -some actions will not compile when any of method's arguments are move-only. You -can always use `Return`, or a [lambda or functor](#FunctionsAsActions): - -```cpp - using ::testing::Unused; - - EXPECT_CALL(mock_buzzer_, ShareBuzz(NotNull(), _)).WillOnce(Return(true)); - EXPECT_TRUE(mock_buzzer_.ShareBuzz(MakeUnique(AccessLevel::kInternal)), - 0); - - EXPECT_CALL(mock_buzzer_, ShareBuzz(_, _)).WillOnce( - [](std::unique_ptr buzz, Unused) { return buzz != nullptr; }); - EXPECT_FALSE(mock_buzzer_.ShareBuzz(nullptr, 0)); -``` - -Many built-in actions (`WithArgs`, `WithoutArgs`,`DeleteArg`, `SaveArg`, ...) -could in principle support move-only arguments, but the support for this is not -implemented yet. If this is blocking you, please file a bug. - -A few actions (e.g. `DoAll`) copy their arguments internally, so they can never -work with non-copyable objects; you'll have to use functors instead. - -#### Legacy workarounds for move-only types {#LegacyMoveOnly} - -Support for move-only function arguments was only introduced to gMock in April -of 2017. In older code, you may encounter the following workaround for the lack -of this feature (it is no longer necessary - we're including it just for -reference): - -```cpp -class MockBuzzer : public Buzzer { - public: - MOCK_METHOD(bool, DoShareBuzz, (Buzz* buzz, Time timestamp)); - bool ShareBuzz(std::unique_ptr buzz, Time timestamp) override { - return DoShareBuzz(buzz.get(), timestamp); - } -}; -``` - -The trick is to delegate the `ShareBuzz()` method to a mock method (let’s call -it `DoShareBuzz()`) that does not take move-only parameters. Then, instead of -setting expectations on `ShareBuzz()`, you set them on the `DoShareBuzz()` mock -method: - -```cpp - MockBuzzer mock_buzzer_; - EXPECT_CALL(mock_buzzer_, DoShareBuzz(NotNull(), _)); - - // When one calls ShareBuzz() on the MockBuzzer like this, the call is - // forwarded to DoShareBuzz(), which is mocked. Therefore this statement - // will trigger the above EXPECT_CALL. - mock_buzzer_.ShareBuzz(MakeUnique(AccessLevel::kInternal), 0); -``` - -### Making the Compilation Faster - -Believe it or not, the *vast majority* of the time spent on compiling a mock -class is in generating its constructor and destructor, as they perform -non-trivial tasks (e.g. verification of the expectations). What's more, mock -methods with different signatures have different types and thus their -constructors/destructors need to be generated by the compiler separately. As a -result, if you mock many different types of methods, compiling your mock class -can get really slow. - -If you are experiencing slow compilation, you can move the definition of your -mock class' constructor and destructor out of the class body and into a `.cc` -file. This way, even if you `#include` your mock class in N files, the compiler -only needs to generate its constructor and destructor once, resulting in a much -faster compilation. - -Let's illustrate the idea using an example. Here's the definition of a mock -class before applying this recipe: - -```cpp -// File mock_foo.h. -... -class MockFoo : public Foo { - public: - // Since we don't declare the constructor or the destructor, - // the compiler will generate them in every translation unit - // where this mock class is used. - - MOCK_METHOD(int, DoThis, (), (override)); - MOCK_METHOD(bool, DoThat, (const char* str), (override)); - ... more mock methods ... -}; -``` - -After the change, it would look like: - -```cpp -// File mock_foo.h. -... -class MockFoo : public Foo { - public: - // The constructor and destructor are declared, but not defined, here. - MockFoo(); - virtual ~MockFoo(); - - MOCK_METHOD(int, DoThis, (), (override)); - MOCK_METHOD(bool, DoThat, (const char* str), (override)); - ... more mock methods ... -}; -``` - -and - -```cpp -// File mock_foo.cc. -#include "path/to/mock_foo.h" - -// The definitions may appear trivial, but the functions actually do a -// lot of things through the constructors/destructors of the member -// variables used to implement the mock methods. -MockFoo::MockFoo() {} -MockFoo::~MockFoo() {} -``` - -### Forcing a Verification - -When it's being destroyed, your friendly mock object will automatically verify -that all expectations on it have been satisfied, and will generate googletest -failures if not. This is convenient as it leaves you with one less thing to -worry about. That is, unless you are not sure if your mock object will be -destroyed. - -How could it be that your mock object won't eventually be destroyed? Well, it -might be created on the heap and owned by the code you are testing. Suppose -there's a bug in that code and it doesn't delete the mock object properly - you -could end up with a passing test when there's actually a bug. - -Using a heap checker is a good idea and can alleviate the concern, but its -implementation is not 100% reliable. So, sometimes you do want to *force* gMock -to verify a mock object before it is (hopefully) destructed. You can do this -with `Mock::VerifyAndClearExpectations(&mock_object)`: - -```cpp -TEST(MyServerTest, ProcessesRequest) { - using ::testing::Mock; - - MockFoo* const foo = new MockFoo; - EXPECT_CALL(*foo, ...)...; - // ... other expectations ... - - // server now owns foo. - MyServer server(foo); - server.ProcessRequest(...); - - // In case that server's destructor will forget to delete foo, - // this will verify the expectations anyway. - Mock::VerifyAndClearExpectations(foo); -} // server is destroyed when it goes out of scope here. -``` - -{: .callout .tip} -**Tip:** The `Mock::VerifyAndClearExpectations()` function returns a `bool` to -indicate whether the verification was successful (`true` for yes), so you can -wrap that function call inside a `ASSERT_TRUE()` if there is no point going -further when the verification has failed. - -Do not set new expectations after verifying and clearing a mock after its use. -Setting expectations after code that exercises the mock has undefined behavior. -See [Using Mocks in Tests](gmock_for_dummies.md#using-mocks-in-tests) for more -information. - -### Using Checkpoints {#UsingCheckPoints} - -Sometimes you might want to test a mock object's behavior in phases whose sizes -are each manageable, or you might want to set more detailed expectations about -which API calls invoke which mock functions. - -A technique you can use is to put the expectations in a sequence and insert -calls to a dummy "checkpoint" function at specific places. Then you can verify -that the mock function calls do happen at the right time. For example, if you -are exercising the code: - -```cpp - Foo(1); - Foo(2); - Foo(3); -``` - -and want to verify that `Foo(1)` and `Foo(3)` both invoke `mock.Bar("a")`, but -`Foo(2)` doesn't invoke anything, you can write: - -```cpp -using ::testing::MockFunction; - -TEST(FooTest, InvokesBarCorrectly) { - MyMock mock; - // Class MockFunction has exactly one mock method. It is named - // Call() and has type F. - MockFunction check; - { - InSequence s; - - EXPECT_CALL(mock, Bar("a")); - EXPECT_CALL(check, Call("1")); - EXPECT_CALL(check, Call("2")); - EXPECT_CALL(mock, Bar("a")); - } - Foo(1); - check.Call("1"); - Foo(2); - check.Call("2"); - Foo(3); -} -``` - -The expectation spec says that the first `Bar("a")` call must happen before -checkpoint "1", the second `Bar("a")` call must happen after checkpoint "2", and -nothing should happen between the two checkpoints. The explicit checkpoints make -it clear which `Bar("a")` is called by which call to `Foo()`. - -### Mocking Destructors - -Sometimes you want to make sure a mock object is destructed at the right time, -e.g. after `bar->A()` is called but before `bar->B()` is called. We already know -that you can specify constraints on the [order](#OrderedCalls) of mock function -calls, so all we need to do is to mock the destructor of the mock function. - -This sounds simple, except for one problem: a destructor is a special function -with special syntax and special semantics, and the `MOCK_METHOD` macro doesn't -work for it: - -```cpp -MOCK_METHOD(void, ~MockFoo, ()); // Won't compile! -``` - -The good news is that you can use a simple pattern to achieve the same effect. -First, add a mock function `Die()` to your mock class and call it in the -destructor, like this: - -```cpp -class MockFoo : public Foo { - ... - // Add the following two lines to the mock class. - MOCK_METHOD(void, Die, ()); - ~MockFoo() override { Die(); } -}; -``` - -(If the name `Die()` clashes with an existing symbol, choose another name.) Now, -we have translated the problem of testing when a `MockFoo` object dies to -testing when its `Die()` method is called: - -```cpp - MockFoo* foo = new MockFoo; - MockBar* bar = new MockBar; - ... - { - InSequence s; - - // Expects *foo to die after bar->A() and before bar->B(). - EXPECT_CALL(*bar, A()); - EXPECT_CALL(*foo, Die()); - EXPECT_CALL(*bar, B()); - } -``` - -And that's that. - -### Using gMock and Threads {#UsingThreads} - -In a **unit** test, it's best if you could isolate and test a piece of code in a -single-threaded context. That avoids race conditions and dead locks, and makes -debugging your test much easier. - -Yet most programs are multi-threaded, and sometimes to test something we need to -pound on it from more than one thread. gMock works for this purpose too. - -Remember the steps for using a mock: - -1. Create a mock object `foo`. -2. Set its default actions and expectations using `ON_CALL()` and - `EXPECT_CALL()`. -3. The code under test calls methods of `foo`. -4. Optionally, verify and reset the mock. -5. Destroy the mock yourself, or let the code under test destroy it. The - destructor will automatically verify it. - -If you follow the following simple rules, your mocks and threads can live -happily together: - -* Execute your *test code* (as opposed to the code being tested) in *one* - thread. This makes your test easy to follow. -* Obviously, you can do step #1 without locking. -* When doing step #2 and #5, make sure no other thread is accessing `foo`. - Obvious too, huh? -* #3 and #4 can be done either in one thread or in multiple threads - anyway - you want. gMock takes care of the locking, so you don't have to do any - - unless required by your test logic. - -If you violate the rules (for example, if you set expectations on a mock while -another thread is calling its methods), you get undefined behavior. That's not -fun, so don't do it. - -gMock guarantees that the action for a mock function is done in the same thread -that called the mock function. For example, in - -```cpp - EXPECT_CALL(mock, Foo(1)) - .WillOnce(action1); - EXPECT_CALL(mock, Foo(2)) - .WillOnce(action2); -``` - -if `Foo(1)` is called in thread 1 and `Foo(2)` is called in thread 2, gMock will -execute `action1` in thread 1 and `action2` in thread 2. - -gMock does *not* impose a sequence on actions performed in different threads -(doing so may create deadlocks as the actions may need to cooperate). This means -that the execution of `action1` and `action2` in the above example *may* -interleave. If this is a problem, you should add proper synchronization logic to -`action1` and `action2` to make the test thread-safe. - -Also, remember that `DefaultValue` is a global resource that potentially -affects *all* living mock objects in your program. Naturally, you won't want to -mess with it from multiple threads or when there still are mocks in action. - -### Controlling How Much Information gMock Prints - -When gMock sees something that has the potential of being an error (e.g. a mock -function with no expectation is called, a.k.a. an uninteresting call, which is -allowed but perhaps you forgot to explicitly ban the call), it prints some -warning messages, including the arguments of the function, the return value, and -the stack trace. Hopefully this will remind you to take a look and see if there -is indeed a problem. - -Sometimes you are confident that your tests are correct and may not appreciate -such friendly messages. Some other times, you are debugging your tests or -learning about the behavior of the code you are testing, and wish you could -observe every mock call that happens (including argument values, the return -value, and the stack trace). Clearly, one size doesn't fit all. - -You can control how much gMock tells you using the `--gmock_verbose=LEVEL` -command-line flag, where `LEVEL` is a string with three possible values: - -* `info`: gMock will print all informational messages, warnings, and errors - (most verbose). At this setting, gMock will also log any calls to the - `ON_CALL/EXPECT_CALL` macros. It will include a stack trace in - "uninteresting call" warnings. -* `warning`: gMock will print both warnings and errors (less verbose); it will - omit the stack traces in "uninteresting call" warnings. This is the default. -* `error`: gMock will print errors only (least verbose). - -Alternatively, you can adjust the value of that flag from within your tests like -so: - -```cpp - ::testing::FLAGS_gmock_verbose = "error"; -``` - -If you find gMock printing too many stack frames with its informational or -warning messages, remember that you can control their amount with the -`--gtest_stack_trace_depth=max_depth` flag. - -Now, judiciously use the right flag to enable gMock serve you better! - -### Gaining Super Vision into Mock Calls - -You have a test using gMock. It fails: gMock tells you some expectations aren't -satisfied. However, you aren't sure why: Is there a typo somewhere in the -matchers? Did you mess up the order of the `EXPECT_CALL`s? Or is the code under -test doing something wrong? How can you find out the cause? - -Won't it be nice if you have X-ray vision and can actually see the trace of all -`EXPECT_CALL`s and mock method calls as they are made? For each call, would you -like to see its actual argument values and which `EXPECT_CALL` gMock thinks it -matches? If you still need some help to figure out who made these calls, how -about being able to see the complete stack trace at each mock call? - -You can unlock this power by running your test with the `--gmock_verbose=info` -flag. For example, given the test program: - -```cpp -#include "gmock/gmock.h" - -using testing::_; -using testing::HasSubstr; -using testing::Return; - -class MockFoo { - public: - MOCK_METHOD(void, F, (const string& x, const string& y)); -}; - -TEST(Foo, Bar) { - MockFoo mock; - EXPECT_CALL(mock, F(_, _)).WillRepeatedly(Return()); - EXPECT_CALL(mock, F("a", "b")); - EXPECT_CALL(mock, F("c", HasSubstr("d"))); - - mock.F("a", "good"); - mock.F("a", "b"); -} -``` - -if you run it with `--gmock_verbose=info`, you will see this output: - -```shell -[ RUN ] Foo.Bar - -foo_test.cc:14: EXPECT_CALL(mock, F(_, _)) invoked -Stack trace: ... - -foo_test.cc:15: EXPECT_CALL(mock, F("a", "b")) invoked -Stack trace: ... - -foo_test.cc:16: EXPECT_CALL(mock, F("c", HasSubstr("d"))) invoked -Stack trace: ... - -foo_test.cc:14: Mock function call matches EXPECT_CALL(mock, F(_, _))... - Function call: F(@0x7fff7c8dad40"a",@0x7fff7c8dad10"good") -Stack trace: ... - -foo_test.cc:15: Mock function call matches EXPECT_CALL(mock, F("a", "b"))... - Function call: F(@0x7fff7c8dada0"a",@0x7fff7c8dad70"b") -Stack trace: ... - -foo_test.cc:16: Failure -Actual function call count doesn't match EXPECT_CALL(mock, F("c", HasSubstr("d")))... - Expected: to be called once - Actual: never called - unsatisfied and active -[ FAILED ] Foo.Bar -``` - -Suppose the bug is that the `"c"` in the third `EXPECT_CALL` is a typo and -should actually be `"a"`. With the above message, you should see that the actual -`F("a", "good")` call is matched by the first `EXPECT_CALL`, not the third as -you thought. From that it should be obvious that the third `EXPECT_CALL` is -written wrong. Case solved. - -If you are interested in the mock call trace but not the stack traces, you can -combine `--gmock_verbose=info` with `--gtest_stack_trace_depth=0` on the test -command line. - -### Running Tests in Emacs - -If you build and run your tests in Emacs using the `M-x google-compile` command -(as many googletest users do), the source file locations of gMock and googletest -errors will be highlighted. Just press `` on one of them and you'll be -taken to the offending line. Or, you can just type `C-x`` to jump to the next -error. - -To make it even easier, you can add the following lines to your `~/.emacs` file: - -```text -(global-set-key "\M-m" 'google-compile) ; m is for make -(global-set-key [M-down] 'next-error) -(global-set-key [M-up] '(lambda () (interactive) (next-error -1))) -``` - -Then you can type `M-m` to start a build (if you want to run the test as well, -just make sure `foo_test.run` or `runtests` is in the build command you supply -after typing `M-m`), or `M-up`/`M-down` to move back and forth between errors. - -## Extending gMock - -### Writing New Matchers Quickly {#NewMatchers} - -{: .callout .warning} -WARNING: gMock does not guarantee when or how many times a matcher will be -invoked. Therefore, all matchers must be functionally pure. See -[this section](#PureMatchers) for more details. - -The `MATCHER*` family of macros can be used to define custom matchers easily. -The syntax: - -```cpp -MATCHER(name, description_string_expression) { statements; } -``` - -will define a matcher with the given name that executes the statements, which -must return a `bool` to indicate if the match succeeds. Inside the statements, -you can refer to the value being matched by `arg`, and refer to its type by -`arg_type`. - -The *description string* is a `string`-typed expression that documents what the -matcher does, and is used to generate the failure message when the match fails. -It can (and should) reference the special `bool` variable `negation`, and should -evaluate to the description of the matcher when `negation` is `false`, or that -of the matcher's negation when `negation` is `true`. - -For convenience, we allow the description string to be empty (`""`), in which -case gMock will use the sequence of words in the matcher name as the -description. - -For example: - -```cpp -MATCHER(IsDivisibleBy7, "") { return (arg % 7) == 0; } -``` - -allows you to write - -```cpp - // Expects mock_foo.Bar(n) to be called where n is divisible by 7. - EXPECT_CALL(mock_foo, Bar(IsDivisibleBy7())); -``` - -or, - -```cpp - using ::testing::Not; - ... - // Verifies that a value is divisible by 7 and the other is not. - EXPECT_THAT(some_expression, IsDivisibleBy7()); - EXPECT_THAT(some_other_expression, Not(IsDivisibleBy7())); -``` - -If the above assertions fail, they will print something like: - -```shell - Value of: some_expression - Expected: is divisible by 7 - Actual: 27 - ... - Value of: some_other_expression - Expected: not (is divisible by 7) - Actual: 21 -``` - -where the descriptions `"is divisible by 7"` and `"not (is divisible by 7)"` are -automatically calculated from the matcher name `IsDivisibleBy7`. - -As you may have noticed, the auto-generated descriptions (especially those for -the negation) may not be so great. You can always override them with a `string` -expression of your own: - -```cpp -MATCHER(IsDivisibleBy7, - absl::StrCat(negation ? "isn't" : "is", " divisible by 7")) { - return (arg % 7) == 0; -} -``` - -Optionally, you can stream additional information to a hidden argument named -`result_listener` to explain the match result. For example, a better definition -of `IsDivisibleBy7` is: - -```cpp -MATCHER(IsDivisibleBy7, "") { - if ((arg % 7) == 0) - return true; - - *result_listener << "the remainder is " << (arg % 7); - return false; -} -``` - -With this definition, the above assertion will give a better message: - -```shell - Value of: some_expression - Expected: is divisible by 7 - Actual: 27 (the remainder is 6) -``` - -You should let `MatchAndExplain()` print *any additional information* that can -help a user understand the match result. Note that it should explain why the -match succeeds in case of a success (unless it's obvious) - this is useful when -the matcher is used inside `Not()`. There is no need to print the argument value -itself, as gMock already prints it for you. - -{: .callout .note} -NOTE: The type of the value being matched (`arg_type`) is determined by the -context in which you use the matcher and is supplied to you by the compiler, so -you don't need to worry about declaring it (nor can you). This allows the -matcher to be polymorphic. For example, `IsDivisibleBy7()` can be used to match -any type where the value of `(arg % 7) == 0` can be implicitly converted to a -`bool`. In the `Bar(IsDivisibleBy7())` example above, if method `Bar()` takes an -`int`, `arg_type` will be `int`; if it takes an `unsigned long`, `arg_type` will -be `unsigned long`; and so on. - -### Writing New Parameterized Matchers Quickly - -Sometimes you'll want to define a matcher that has parameters. For that you can -use the macro: - -```cpp -MATCHER_P(name, param_name, description_string) { statements; } -``` - -where the description string can be either `""` or a `string` expression that -references `negation` and `param_name`. - -For example: - -```cpp -MATCHER_P(HasAbsoluteValue, value, "") { return abs(arg) == value; } -``` - -will allow you to write: - -```cpp - EXPECT_THAT(Blah("a"), HasAbsoluteValue(n)); -``` - -which may lead to this message (assuming `n` is 10): - -```shell - Value of: Blah("a") - Expected: has absolute value 10 - Actual: -9 -``` - -Note that both the matcher description and its parameter are printed, making the -message human-friendly. - -In the matcher definition body, you can write `foo_type` to reference the type -of a parameter named `foo`. For example, in the body of -`MATCHER_P(HasAbsoluteValue, value)` above, you can write `value_type` to refer -to the type of `value`. - -gMock also provides `MATCHER_P2`, `MATCHER_P3`, ..., up to `MATCHER_P10` to -support multi-parameter matchers: - -```cpp -MATCHER_Pk(name, param_1, ..., param_k, description_string) { statements; } -``` - -Please note that the custom description string is for a particular *instance* of -the matcher, where the parameters have been bound to actual values. Therefore -usually you'll want the parameter values to be part of the description. gMock -lets you do that by referencing the matcher parameters in the description string -expression. - -For example, - -```cpp -using ::testing::PrintToString; -MATCHER_P2(InClosedRange, low, hi, - absl::StrFormat("%s in range [%s, %s]", negation ? "isn't" : "is", - PrintToString(low), PrintToString(hi))) { - return low <= arg && arg <= hi; -} -... -EXPECT_THAT(3, InClosedRange(4, 6)); -``` - -would generate a failure that contains the message: - -```shell - Expected: is in range [4, 6] -``` - -If you specify `""` as the description, the failure message will contain the -sequence of words in the matcher name followed by the parameter values printed -as a tuple. For example, - -```cpp - MATCHER_P2(InClosedRange, low, hi, "") { ... } - ... - EXPECT_THAT(3, InClosedRange(4, 6)); -``` - -would generate a failure that contains the text: - -```shell - Expected: in closed range (4, 6) -``` - -For the purpose of typing, you can view - -```cpp -MATCHER_Pk(Foo, p1, ..., pk, description_string) { ... } -``` - -as shorthand for - -```cpp -template -FooMatcherPk -Foo(p1_type p1, ..., pk_type pk) { ... } -``` - -When you write `Foo(v1, ..., vk)`, the compiler infers the types of the -parameters `v1`, ..., and `vk` for you. If you are not happy with the result of -the type inference, you can specify the types by explicitly instantiating the -template, as in `Foo(5, false)`. As said earlier, you don't get to -(or need to) specify `arg_type` as that's determined by the context in which the -matcher is used. - -You can assign the result of expression `Foo(p1, ..., pk)` to a variable of type -`FooMatcherPk`. This can be useful when composing -matchers. Matchers that don't have a parameter or have only one parameter have -special types: you can assign `Foo()` to a `FooMatcher`-typed variable, and -assign `Foo(p)` to a `FooMatcherP`-typed variable. - -While you can instantiate a matcher template with reference types, passing the -parameters by pointer usually makes your code more readable. If, however, you -still want to pass a parameter by reference, be aware that in the failure -message generated by the matcher you will see the value of the referenced object -but not its address. - -You can overload matchers with different numbers of parameters: - -```cpp -MATCHER_P(Blah, a, description_string_1) { ... } -MATCHER_P2(Blah, a, b, description_string_2) { ... } -``` - -While it's tempting to always use the `MATCHER*` macros when defining a new -matcher, you should also consider implementing the matcher interface directly -instead (see the recipes that follow), especially if you need to use the matcher -a lot. While these approaches require more work, they give you more control on -the types of the value being matched and the matcher parameters, which in -general leads to better compiler error messages that pay off in the long run. -They also allow overloading matchers based on parameter types (as opposed to -just based on the number of parameters). - -### Writing New Monomorphic Matchers - -A matcher of argument type `T` implements the matcher interface for `T` and does -two things: it tests whether a value of type `T` matches the matcher, and can -describe what kind of values it matches. The latter ability is used for -generating readable error messages when expectations are violated. - -A matcher of `T` must declare a typedef like: - -```cpp -using is_gtest_matcher = void; -``` - -and supports the following operations: - -```cpp -// Match a value and optionally explain into an ostream. -bool matched = matcher.MatchAndExplain(value, maybe_os); -// where `value` is of type `T` and -// `maybe_os` is of type `std::ostream*`, where it can be null if the caller -// is not interested in there textual explanation. - -matcher.DescribeTo(os); -matcher.DescribeNegationTo(os); -// where `os` is of type `std::ostream*`. -``` - -If you need a custom matcher but `Truly()` is not a good option (for example, -you may not be happy with the way `Truly(predicate)` describes itself, or you -may want your matcher to be polymorphic as `Eq(value)` is), you can define a -matcher to do whatever you want in two steps: first implement the matcher -interface, and then define a factory function to create a matcher instance. The -second step is not strictly needed but it makes the syntax of using the matcher -nicer. - -For example, you can define a matcher to test whether an `int` is divisible by 7 -and then use it like this: - -```cpp -using ::testing::Matcher; - -class DivisibleBy7Matcher { - public: - using is_gtest_matcher = void; - - bool MatchAndExplain(int n, std::ostream*) const { - return (n % 7) == 0; - } - - void DescribeTo(std::ostream* os) const { - *os << "is divisible by 7"; - } - - void DescribeNegationTo(std::ostream* os) const { - *os << "is not divisible by 7"; - } -}; - -Matcher DivisibleBy7() { - return DivisibleBy7Matcher(); -} - -... - EXPECT_CALL(foo, Bar(DivisibleBy7())); -``` - -You may improve the matcher message by streaming additional information to the -`os` argument in `MatchAndExplain()`: - -```cpp -class DivisibleBy7Matcher { - public: - bool MatchAndExplain(int n, std::ostream* os) const { - const int remainder = n % 7; - if (remainder != 0 && os != nullptr) { - *os << "the remainder is " << remainder; - } - return remainder == 0; - } - ... -}; -``` - -Then, `EXPECT_THAT(x, DivisibleBy7());` may generate a message like this: - -```shell -Value of: x -Expected: is divisible by 7 - Actual: 23 (the remainder is 2) -``` - -{: .callout .tip} -Tip: for convenience, `MatchAndExplain()` can take a `MatchResultListener*` -instead of `std::ostream*`. - -### Writing New Polymorphic Matchers - -Expanding what we learned above to *polymorphic* matchers is now just as simple -as adding templates in the right place. - -```cpp - -class NotNullMatcher { - public: - using is_gtest_matcher = void; - - // To implement a polymorphic matcher, we just need to make MatchAndExplain a - // template on its first argument. - - // In this example, we want to use NotNull() with any pointer, so - // MatchAndExplain() accepts a pointer of any type as its first argument. - // In general, you can define MatchAndExplain() as an ordinary method or - // a method template, or even overload it. - template - bool MatchAndExplain(T* p, std::ostream*) const { - return p != nullptr; - } - - // Describes the property of a value matching this matcher. - void DescribeTo(std::ostream* os) const { *os << "is not NULL"; } - - // Describes the property of a value NOT matching this matcher. - void DescribeNegationTo(std::ostream* os) const { *os << "is NULL"; } -}; - -NotNullMatcher NotNull() { - return NotNullMatcher(); -} - -... - - EXPECT_CALL(foo, Bar(NotNull())); // The argument must be a non-NULL pointer. -``` - -### Legacy Matcher Implementation - -Defining matchers used to be somewhat more complicated, in which it required -several supporting classes and virtual functions. To implement a matcher for -type `T` using the legacy API you have to derive from `MatcherInterface` and -call `MakeMatcher` to construct the object. - -The interface looks like this: - -```cpp -class MatchResultListener { - public: - ... - // Streams x to the underlying ostream; does nothing if the ostream - // is NULL. - template - MatchResultListener& operator<<(const T& x); - - // Returns the underlying ostream. - std::ostream* stream(); -}; - -template -class MatcherInterface { - public: - virtual ~MatcherInterface(); - - // Returns true if and only if the matcher matches x; also explains the match - // result to 'listener'. - virtual bool MatchAndExplain(T x, MatchResultListener* listener) const = 0; - - // Describes this matcher to an ostream. - virtual void DescribeTo(std::ostream* os) const = 0; - - // Describes the negation of this matcher to an ostream. - virtual void DescribeNegationTo(std::ostream* os) const; -}; -``` - -Fortunately, most of the time you can define a polymorphic matcher easily with -the help of `MakePolymorphicMatcher()`. Here's how you can define `NotNull()` as -an example: - -```cpp -using ::testing::MakePolymorphicMatcher; -using ::testing::MatchResultListener; -using ::testing::PolymorphicMatcher; - -class NotNullMatcher { - public: - // To implement a polymorphic matcher, first define a COPYABLE class - // that has three members MatchAndExplain(), DescribeTo(), and - // DescribeNegationTo(), like the following. - - // In this example, we want to use NotNull() with any pointer, so - // MatchAndExplain() accepts a pointer of any type as its first argument. - // In general, you can define MatchAndExplain() as an ordinary method or - // a method template, or even overload it. - template - bool MatchAndExplain(T* p, - MatchResultListener* /* listener */) const { - return p != NULL; - } - - // Describes the property of a value matching this matcher. - void DescribeTo(std::ostream* os) const { *os << "is not NULL"; } - - // Describes the property of a value NOT matching this matcher. - void DescribeNegationTo(std::ostream* os) const { *os << "is NULL"; } -}; - -// To construct a polymorphic matcher, pass an instance of the class -// to MakePolymorphicMatcher(). Note the return type. -PolymorphicMatcher NotNull() { - return MakePolymorphicMatcher(NotNullMatcher()); -} - -... - - EXPECT_CALL(foo, Bar(NotNull())); // The argument must be a non-NULL pointer. -``` - -{: .callout .note} -**Note:** Your polymorphic matcher class does **not** need to inherit from -`MatcherInterface` or any other class, and its methods do **not** need to be -virtual. - -Like in a monomorphic matcher, you may explain the match result by streaming -additional information to the `listener` argument in `MatchAndExplain()`. - -### Writing New Cardinalities - -A cardinality is used in `Times()` to tell gMock how many times you expect a -call to occur. It doesn't have to be exact. For example, you can say -`AtLeast(5)` or `Between(2, 4)`. - -If the [built-in set](gmock_cheat_sheet.md#CardinalityList) of cardinalities -doesn't suit you, you are free to define your own by implementing the following -interface (in namespace `testing`): - -```cpp -class CardinalityInterface { - public: - virtual ~CardinalityInterface(); - - // Returns true if and only if call_count calls will satisfy this cardinality. - virtual bool IsSatisfiedByCallCount(int call_count) const = 0; - - // Returns true if and only if call_count calls will saturate this - // cardinality. - virtual bool IsSaturatedByCallCount(int call_count) const = 0; - - // Describes self to an ostream. - virtual void DescribeTo(std::ostream* os) const = 0; -}; -``` - -For example, to specify that a call must occur even number of times, you can -write - -```cpp -using ::testing::Cardinality; -using ::testing::CardinalityInterface; -using ::testing::MakeCardinality; - -class EvenNumberCardinality : public CardinalityInterface { - public: - bool IsSatisfiedByCallCount(int call_count) const override { - return (call_count % 2) == 0; - } - - bool IsSaturatedByCallCount(int call_count) const override { - return false; - } - - void DescribeTo(std::ostream* os) const { - *os << "called even number of times"; - } -}; - -Cardinality EvenNumber() { - return MakeCardinality(new EvenNumberCardinality); -} - -... - EXPECT_CALL(foo, Bar(3)) - .Times(EvenNumber()); -``` - -### Writing New Actions Quickly {#QuickNewActions} - -If the built-in actions don't work for you, you can easily define your own one. -Just define a functor class with a (possibly templated) call operator, matching -the signature of your action. - -```cpp -struct Increment { - template - T operator()(T* arg) { - return ++(*arg); - } -} -``` - -The same approach works with stateful functors (or any callable, really): - -``` -struct MultiplyBy { - template - T operator()(T arg) { return arg * multiplier; } - - int multiplier; -} - -// Then use: -// EXPECT_CALL(...).WillOnce(MultiplyBy{7}); -``` - -#### Legacy macro-based Actions - -Before C++11, the functor-based actions were not supported; the old way of -writing actions was through a set of `ACTION*` macros. We suggest to avoid them -in new code; they hide a lot of logic behind the macro, potentially leading to -harder-to-understand compiler errors. Nevertheless, we cover them here for -completeness. - -By writing - -```cpp -ACTION(name) { statements; } -``` - -in a namespace scope (i.e. not inside a class or function), you will define an -action with the given name that executes the statements. The value returned by -`statements` will be used as the return value of the action. Inside the -statements, you can refer to the K-th (0-based) argument of the mock function as -`argK`. For example: - -```cpp -ACTION(IncrementArg1) { return ++(*arg1); } -``` - -allows you to write - -```cpp -... WillOnce(IncrementArg1()); -``` - -Note that you don't need to specify the types of the mock function arguments. -Rest assured that your code is type-safe though: you'll get a compiler error if -`*arg1` doesn't support the `++` operator, or if the type of `++(*arg1)` isn't -compatible with the mock function's return type. - -Another example: - -```cpp -ACTION(Foo) { - (*arg2)(5); - Blah(); - *arg1 = 0; - return arg0; -} -``` - -defines an action `Foo()` that invokes argument #2 (a function pointer) with 5, -calls function `Blah()`, sets the value pointed to by argument #1 to 0, and -returns argument #0. - -For more convenience and flexibility, you can also use the following pre-defined -symbols in the body of `ACTION`: - -`argK_type` | The type of the K-th (0-based) argument of the mock function -:-------------- | :----------------------------------------------------------- -`args` | All arguments of the mock function as a tuple -`args_type` | The type of all arguments of the mock function as a tuple -`return_type` | The return type of the mock function -`function_type` | The type of the mock function - -For example, when using an `ACTION` as a stub action for mock function: - -```cpp -int DoSomething(bool flag, int* ptr); -``` - -we have: - -Pre-defined Symbol | Is Bound To ------------------- | --------------------------------- -`arg0` | the value of `flag` -`arg0_type` | the type `bool` -`arg1` | the value of `ptr` -`arg1_type` | the type `int*` -`args` | the tuple `(flag, ptr)` -`args_type` | the type `std::tuple` -`return_type` | the type `int` -`function_type` | the type `int(bool, int*)` - -#### Legacy macro-based parameterized Actions - -Sometimes you'll want to parameterize an action you define. For that we have -another macro - -```cpp -ACTION_P(name, param) { statements; } -``` - -For example, - -```cpp -ACTION_P(Add, n) { return arg0 + n; } -``` - -will allow you to write - -```cpp -// Returns argument #0 + 5. -... WillOnce(Add(5)); -``` - -For convenience, we use the term *arguments* for the values used to invoke the -mock function, and the term *parameters* for the values used to instantiate an -action. - -Note that you don't need to provide the type of the parameter either. Suppose -the parameter is named `param`, you can also use the gMock-defined symbol -`param_type` to refer to the type of the parameter as inferred by the compiler. -For example, in the body of `ACTION_P(Add, n)` above, you can write `n_type` for -the type of `n`. - -gMock also provides `ACTION_P2`, `ACTION_P3`, and etc to support multi-parameter -actions. For example, - -```cpp -ACTION_P2(ReturnDistanceTo, x, y) { - double dx = arg0 - x; - double dy = arg1 - y; - return sqrt(dx*dx + dy*dy); -} -``` - -lets you write - -```cpp -... WillOnce(ReturnDistanceTo(5.0, 26.5)); -``` - -You can view `ACTION` as a degenerated parameterized action where the number of -parameters is 0. - -You can also easily define actions overloaded on the number of parameters: - -```cpp -ACTION_P(Plus, a) { ... } -ACTION_P2(Plus, a, b) { ... } -``` - -### Restricting the Type of an Argument or Parameter in an ACTION - -For maximum brevity and reusability, the `ACTION*` macros don't ask you to -provide the types of the mock function arguments and the action parameters. -Instead, we let the compiler infer the types for us. - -Sometimes, however, we may want to be more explicit about the types. There are -several tricks to do that. For example: - -```cpp -ACTION(Foo) { - // Makes sure arg0 can be converted to int. - int n = arg0; - ... use n instead of arg0 here ... -} - -ACTION_P(Bar, param) { - // Makes sure the type of arg1 is const char*. - ::testing::StaticAssertTypeEq(); - - // Makes sure param can be converted to bool. - bool flag = param; -} -``` - -where `StaticAssertTypeEq` is a compile-time assertion in googletest that -verifies two types are the same. - -### Writing New Action Templates Quickly - -Sometimes you want to give an action explicit template parameters that cannot be -inferred from its value parameters. `ACTION_TEMPLATE()` supports that and can be -viewed as an extension to `ACTION()` and `ACTION_P*()`. - -The syntax: - -```cpp -ACTION_TEMPLATE(ActionName, - HAS_m_TEMPLATE_PARAMS(kind1, name1, ..., kind_m, name_m), - AND_n_VALUE_PARAMS(p1, ..., p_n)) { statements; } -``` - -defines an action template that takes *m* explicit template parameters and *n* -value parameters, where *m* is in [1, 10] and *n* is in [0, 10]. `name_i` is the -name of the *i*-th template parameter, and `kind_i` specifies whether it's a -`typename`, an integral constant, or a template. `p_i` is the name of the *i*-th -value parameter. - -Example: - -```cpp -// DuplicateArg(output) converts the k-th argument of the mock -// function to type T and copies it to *output. -ACTION_TEMPLATE(DuplicateArg, - // Note the comma between int and k: - HAS_2_TEMPLATE_PARAMS(int, k, typename, T), - AND_1_VALUE_PARAMS(output)) { - *output = T(std::get(args)); -} -``` - -To create an instance of an action template, write: - -```cpp -ActionName(v1, ..., v_n) -``` - -where the `t`s are the template arguments and the `v`s are the value arguments. -The value argument types are inferred by the compiler. For example: - -```cpp -using ::testing::_; -... - int n; - EXPECT_CALL(mock, Foo).WillOnce(DuplicateArg<1, unsigned char>(&n)); -``` - -If you want to explicitly specify the value argument types, you can provide -additional template arguments: - -```cpp -ActionName(v1, ..., v_n) -``` - -where `u_i` is the desired type of `v_i`. - -`ACTION_TEMPLATE` and `ACTION`/`ACTION_P*` can be overloaded on the number of -value parameters, but not on the number of template parameters. Without the -restriction, the meaning of the following is unclear: - -```cpp - OverloadedAction(x); -``` - -Are we using a single-template-parameter action where `bool` refers to the type -of `x`, or a two-template-parameter action where the compiler is asked to infer -the type of `x`? - -### Using the ACTION Object's Type - -If you are writing a function that returns an `ACTION` object, you'll need to -know its type. The type depends on the macro used to define the action and the -parameter types. The rule is relatively simple: - - -| Given Definition | Expression | Has Type | -| ----------------------------- | ------------------- | --------------------- | -| `ACTION(Foo)` | `Foo()` | `FooAction` | -| `ACTION_TEMPLATE(Foo, HAS_m_TEMPLATE_PARAMS(...), AND_0_VALUE_PARAMS())` | `Foo()` | `FooAction` | -| `ACTION_P(Bar, param)` | `Bar(int_value)` | `BarActionP` | -| `ACTION_TEMPLATE(Bar, HAS_m_TEMPLATE_PARAMS(...), AND_1_VALUE_PARAMS(p1))` | `Bar(int_value)` | `BarActionP` | -| `ACTION_P2(Baz, p1, p2)` | `Baz(bool_value, int_value)` | `BazActionP2` | -| `ACTION_TEMPLATE(Baz, HAS_m_TEMPLATE_PARAMS(...), AND_2_VALUE_PARAMS(p1, p2))` | `Baz(bool_value, int_value)` | `BazActionP2` | -| ... | ... | ... | - - -Note that we have to pick different suffixes (`Action`, `ActionP`, `ActionP2`, -and etc) for actions with different numbers of value parameters, or the action -definitions cannot be overloaded on the number of them. - -### Writing New Monomorphic Actions {#NewMonoActions} - -While the `ACTION*` macros are very convenient, sometimes they are -inappropriate. For example, despite the tricks shown in the previous recipes, -they don't let you directly specify the types of the mock function arguments and -the action parameters, which in general leads to unoptimized compiler error -messages that can baffle unfamiliar users. They also don't allow overloading -actions based on parameter types without jumping through some hoops. - -An alternative to the `ACTION*` macros is to implement -`::testing::ActionInterface`, where `F` is the type of the mock function in -which the action will be used. For example: - -```cpp -template -class ActionInterface { - public: - virtual ~ActionInterface(); - - // Performs the action. Result is the return type of function type - // F, and ArgumentTuple is the tuple of arguments of F. - // - - // For example, if F is int(bool, const string&), then Result would - // be int, and ArgumentTuple would be std::tuple. - virtual Result Perform(const ArgumentTuple& args) = 0; -}; -``` - -```cpp -using ::testing::_; -using ::testing::Action; -using ::testing::ActionInterface; -using ::testing::MakeAction; - -typedef int IncrementMethod(int*); - -class IncrementArgumentAction : public ActionInterface { - public: - int Perform(const std::tuple& args) override { - int* p = std::get<0>(args); // Grabs the first argument. - return *p++; - } -}; - -Action IncrementArgument() { - return MakeAction(new IncrementArgumentAction); -} - -... - EXPECT_CALL(foo, Baz(_)) - .WillOnce(IncrementArgument()); - - int n = 5; - foo.Baz(&n); // Should return 5 and change n to 6. -``` - -### Writing New Polymorphic Actions {#NewPolyActions} - -The previous recipe showed you how to define your own action. This is all good, -except that you need to know the type of the function in which the action will -be used. Sometimes that can be a problem. For example, if you want to use the -action in functions with *different* types (e.g. like `Return()` and -`SetArgPointee()`). - -If an action can be used in several types of mock functions, we say it's -*polymorphic*. The `MakePolymorphicAction()` function template makes it easy to -define such an action: - -```cpp -namespace testing { -template -PolymorphicAction MakePolymorphicAction(const Impl& impl); -} // namespace testing -``` - -As an example, let's define an action that returns the second argument in the -mock function's argument list. The first step is to define an implementation -class: - -```cpp -class ReturnSecondArgumentAction { - public: - template - Result Perform(const ArgumentTuple& args) const { - // To get the i-th (0-based) argument, use std::get(args). - return std::get<1>(args); - } -}; -``` - -This implementation class does *not* need to inherit from any particular class. -What matters is that it must have a `Perform()` method template. This method -template takes the mock function's arguments as a tuple in a **single** -argument, and returns the result of the action. It can be either `const` or not, -but must be invokable with exactly one template argument, which is the result -type. In other words, you must be able to call `Perform(args)` where `R` is -the mock function's return type and `args` is its arguments in a tuple. - -Next, we use `MakePolymorphicAction()` to turn an instance of the implementation -class into the polymorphic action we need. It will be convenient to have a -wrapper for this: - -```cpp -using ::testing::MakePolymorphicAction; -using ::testing::PolymorphicAction; - -PolymorphicAction ReturnSecondArgument() { - return MakePolymorphicAction(ReturnSecondArgumentAction()); -} -``` - -Now, you can use this polymorphic action the same way you use the built-in ones: - -```cpp -using ::testing::_; - -class MockFoo : public Foo { - public: - MOCK_METHOD(int, DoThis, (bool flag, int n), (override)); - MOCK_METHOD(string, DoThat, (int x, const char* str1, const char* str2), - (override)); -}; - - ... - MockFoo foo; - EXPECT_CALL(foo, DoThis).WillOnce(ReturnSecondArgument()); - EXPECT_CALL(foo, DoThat).WillOnce(ReturnSecondArgument()); - ... - foo.DoThis(true, 5); // Will return 5. - foo.DoThat(1, "Hi", "Bye"); // Will return "Hi". -``` - -### Teaching gMock How to Print Your Values - -When an uninteresting or unexpected call occurs, gMock prints the argument -values and the stack trace to help you debug. Assertion macros like -`EXPECT_THAT` and `EXPECT_EQ` also print the values in question when the -assertion fails. gMock and googletest do this using googletest's user-extensible -value printer. - -This printer knows how to print built-in C++ types, native arrays, STL -containers, and any type that supports the `<<` operator. For other types, it -prints the raw bytes in the value and hopes that you the user can figure it out. -[The GoogleTest advanced guide](advanced.md#teaching-googletest-how-to-print-your-values) -explains how to extend the printer to do a better job at printing your -particular type than to dump the bytes. - -## Useful Mocks Created Using gMock - - - - -### Mock std::function {#MockFunction} - -`std::function` is a general function type introduced in C++11. It is a -preferred way of passing callbacks to new interfaces. Functions are copiable, -and are not usually passed around by pointer, which makes them tricky to mock. -But fear not - `MockFunction` can help you with that. - -`MockFunction` has a mock method `Call()` with the signature: - -```cpp - R Call(T1, ..., Tn); -``` - -It also has a `AsStdFunction()` method, which creates a `std::function` proxy -forwarding to Call: - -```cpp - std::function AsStdFunction(); -``` - -To use `MockFunction`, first create `MockFunction` object and set up -expectations on its `Call` method. Then pass proxy obtained from -`AsStdFunction()` to the code you are testing. For example: - -```cpp -TEST(FooTest, RunsCallbackWithBarArgument) { - // 1. Create a mock object. - MockFunction mock_function; - - // 2. Set expectations on Call() method. - EXPECT_CALL(mock_function, Call("bar")).WillOnce(Return(1)); - - // 3. Exercise code that uses std::function. - Foo(mock_function.AsStdFunction()); - // Foo's signature can be either of: - // void Foo(const std::function& fun); - // void Foo(std::function fun); - - // 4. All expectations will be verified when mock_function - // goes out of scope and is destroyed. -} -``` - -Remember that function objects created with `AsStdFunction()` are just -forwarders. If you create multiple of them, they will share the same set of -expectations. - -Although `std::function` supports unlimited number of arguments, `MockFunction` -implementation is limited to ten. If you ever hit that limit... well, your -callback has bigger problems than being mockable. :-) diff --git a/external/googletest/docs/gmock_faq.md b/external/googletest/docs/gmock_faq.md deleted file mode 100644 index 2cd9b3f315..0000000000 --- a/external/googletest/docs/gmock_faq.md +++ /dev/null @@ -1,390 +0,0 @@ -# Legacy gMock FAQ - -### When I call a method on my mock object, the method for the real object is invoked instead. What's the problem? - -In order for a method to be mocked, it must be *virtual*, unless you use the -[high-perf dependency injection technique](gmock_cook_book.md#MockingNonVirtualMethods). - -### Can I mock a variadic function? - -You cannot mock a variadic function (i.e. a function taking ellipsis (`...`) -arguments) directly in gMock. - -The problem is that in general, there is *no way* for a mock object to know how -many arguments are passed to the variadic method, and what the arguments' types -are. Only the *author of the base class* knows the protocol, and we cannot look -into his or her head. - -Therefore, to mock such a function, the *user* must teach the mock object how to -figure out the number of arguments and their types. One way to do it is to -provide overloaded versions of the function. - -Ellipsis arguments are inherited from C and not really a C++ feature. They are -unsafe to use and don't work with arguments that have constructors or -destructors. Therefore we recommend to avoid them in C++ as much as possible. - -### MSVC gives me warning C4301 or C4373 when I define a mock method with a const parameter. Why? - -If you compile this using Microsoft Visual C++ 2005 SP1: - -```cpp -class Foo { - ... - virtual void Bar(const int i) = 0; -}; - -class MockFoo : public Foo { - ... - MOCK_METHOD(void, Bar, (const int i), (override)); -}; -``` - -You may get the following warning: - -```shell -warning C4301: 'MockFoo::Bar': overriding virtual function only differs from 'Foo::Bar' by const/volatile qualifier -``` - -This is a MSVC bug. The same code compiles fine with gcc, for example. If you -use Visual C++ 2008 SP1, you would get the warning: - -```shell -warning C4373: 'MockFoo::Bar': virtual function overrides 'Foo::Bar', previous versions of the compiler did not override when parameters only differed by const/volatile qualifiers -``` - -In C++, if you *declare* a function with a `const` parameter, the `const` -modifier is ignored. Therefore, the `Foo` base class above is equivalent to: - -```cpp -class Foo { - ... - virtual void Bar(int i) = 0; // int or const int? Makes no difference. -}; -``` - -In fact, you can *declare* `Bar()` with an `int` parameter, and define it with a -`const int` parameter. The compiler will still match them up. - -Since making a parameter `const` is meaningless in the method declaration, we -recommend to remove it in both `Foo` and `MockFoo`. That should workaround the -VC bug. - -Note that we are talking about the *top-level* `const` modifier here. If the -function parameter is passed by pointer or reference, declaring the pointee or -referee as `const` is still meaningful. For example, the following two -declarations are *not* equivalent: - -```cpp -void Bar(int* p); // Neither p nor *p is const. -void Bar(const int* p); // p is not const, but *p is. -``` - -### I can't figure out why gMock thinks my expectations are not satisfied. What should I do? - -You might want to run your test with `--gmock_verbose=info`. This flag lets -gMock print a trace of every mock function call it receives. By studying the -trace, you'll gain insights on why the expectations you set are not met. - -If you see the message "The mock function has no default action set, and its -return type has no default value set.", then try -[adding a default action](gmock_cheat_sheet.md#OnCall). Due to a known issue, -unexpected calls on mocks without default actions don't print out a detailed -comparison between the actual arguments and the expected arguments. - -### My program crashed and `ScopedMockLog` spit out tons of messages. Is it a gMock bug? - -gMock and `ScopedMockLog` are likely doing the right thing here. - -When a test crashes, the failure signal handler will try to log a lot of -information (the stack trace, and the address map, for example). The messages -are compounded if you have many threads with depth stacks. When `ScopedMockLog` -intercepts these messages and finds that they don't match any expectations, it -prints an error for each of them. - -You can learn to ignore the errors, or you can rewrite your expectations to make -your test more robust, for example, by adding something like: - -```cpp -using ::testing::AnyNumber; -using ::testing::Not; -... - // Ignores any log not done by us. - EXPECT_CALL(log, Log(_, Not(EndsWith("/my_file.cc")), _)) - .Times(AnyNumber()); -``` - -### How can I assert that a function is NEVER called? - -```cpp -using ::testing::_; -... - EXPECT_CALL(foo, Bar(_)) - .Times(0); -``` - -### I have a failed test where gMock tells me TWICE that a particular expectation is not satisfied. Isn't this redundant? - -When gMock detects a failure, it prints relevant information (the mock function -arguments, the state of relevant expectations, and etc) to help the user debug. -If another failure is detected, gMock will do the same, including printing the -state of relevant expectations. - -Sometimes an expectation's state didn't change between two failures, and you'll -see the same description of the state twice. They are however *not* redundant, -as they refer to *different points in time*. The fact they are the same *is* -interesting information. - -### I get a heapcheck failure when using a mock object, but using a real object is fine. What can be wrong? - -Does the class (hopefully a pure interface) you are mocking have a virtual -destructor? - -Whenever you derive from a base class, make sure its destructor is virtual. -Otherwise Bad Things will happen. Consider the following code: - -```cpp -class Base { - public: - // Not virtual, but should be. - ~Base() { ... } - ... -}; - -class Derived : public Base { - public: - ... - private: - std::string value_; -}; - -... - Base* p = new Derived; - ... - delete p; // Surprise! ~Base() will be called, but ~Derived() will not - // - value_ is leaked. -``` - -By changing `~Base()` to virtual, `~Derived()` will be correctly called when -`delete p` is executed, and the heap checker will be happy. - -### The "newer expectations override older ones" rule makes writing expectations awkward. Why does gMock do that? - -When people complain about this, often they are referring to code like: - -```cpp -using ::testing::Return; -... - // foo.Bar() should be called twice, return 1 the first time, and return - // 2 the second time. However, I have to write the expectations in the - // reverse order. This sucks big time!!! - EXPECT_CALL(foo, Bar()) - .WillOnce(Return(2)) - .RetiresOnSaturation(); - EXPECT_CALL(foo, Bar()) - .WillOnce(Return(1)) - .RetiresOnSaturation(); -``` - -The problem, is that they didn't pick the **best** way to express the test's -intent. - -By default, expectations don't have to be matched in *any* particular order. If -you want them to match in a certain order, you need to be explicit. This is -gMock's (and jMock's) fundamental philosophy: it's easy to accidentally -over-specify your tests, and we want to make it harder to do so. - -There are two better ways to write the test spec. You could either put the -expectations in sequence: - -```cpp -using ::testing::Return; -... - // foo.Bar() should be called twice, return 1 the first time, and return - // 2 the second time. Using a sequence, we can write the expectations - // in their natural order. - { - InSequence s; - EXPECT_CALL(foo, Bar()) - .WillOnce(Return(1)) - .RetiresOnSaturation(); - EXPECT_CALL(foo, Bar()) - .WillOnce(Return(2)) - .RetiresOnSaturation(); - } -``` - -or you can put the sequence of actions in the same expectation: - -```cpp -using ::testing::Return; -... - // foo.Bar() should be called twice, return 1 the first time, and return - // 2 the second time. - EXPECT_CALL(foo, Bar()) - .WillOnce(Return(1)) - .WillOnce(Return(2)) - .RetiresOnSaturation(); -``` - -Back to the original questions: why does gMock search the expectations (and -`ON_CALL`s) from back to front? Because this allows a user to set up a mock's -behavior for the common case early (e.g. in the mock's constructor or the test -fixture's set-up phase) and customize it with more specific rules later. If -gMock searches from front to back, this very useful pattern won't be possible. - -### gMock prints a warning when a function without EXPECT_CALL is called, even if I have set its behavior using ON_CALL. Would it be reasonable not to show the warning in this case? - -When choosing between being neat and being safe, we lean toward the latter. So -the answer is that we think it's better to show the warning. - -Often people write `ON_CALL`s in the mock object's constructor or `SetUp()`, as -the default behavior rarely changes from test to test. Then in the test body -they set the expectations, which are often different for each test. Having an -`ON_CALL` in the set-up part of a test doesn't mean that the calls are expected. -If there's no `EXPECT_CALL` and the method is called, it's possibly an error. If -we quietly let the call go through without notifying the user, bugs may creep in -unnoticed. - -If, however, you are sure that the calls are OK, you can write - -```cpp -using ::testing::_; -... - EXPECT_CALL(foo, Bar(_)) - .WillRepeatedly(...); -``` - -instead of - -```cpp -using ::testing::_; -... - ON_CALL(foo, Bar(_)) - .WillByDefault(...); -``` - -This tells gMock that you do expect the calls and no warning should be printed. - -Also, you can control the verbosity by specifying `--gmock_verbose=error`. Other -values are `info` and `warning`. If you find the output too noisy when -debugging, just choose a less verbose level. - -### How can I delete the mock function's argument in an action? - -If your mock function takes a pointer argument and you want to delete that -argument, you can use testing::DeleteArg() to delete the N'th (zero-indexed) -argument: - -```cpp -using ::testing::_; - ... - MOCK_METHOD(void, Bar, (X* x, const Y& y)); - ... - EXPECT_CALL(mock_foo_, Bar(_, _)) - .WillOnce(testing::DeleteArg<0>())); -``` - -### How can I perform an arbitrary action on a mock function's argument? - -If you find yourself needing to perform some action that's not supported by -gMock directly, remember that you can define your own actions using -[`MakeAction()`](#NewMonoActions) or -[`MakePolymorphicAction()`](#NewPolyActions), or you can write a stub function -and invoke it using [`Invoke()`](#FunctionsAsActions). - -```cpp -using ::testing::_; -using ::testing::Invoke; - ... - MOCK_METHOD(void, Bar, (X* p)); - ... - EXPECT_CALL(mock_foo_, Bar(_)) - .WillOnce(Invoke(MyAction(...))); -``` - -### My code calls a static/global function. Can I mock it? - -You can, but you need to make some changes. - -In general, if you find yourself needing to mock a static function, it's a sign -that your modules are too tightly coupled (and less flexible, less reusable, -less testable, etc). You are probably better off defining a small interface and -call the function through that interface, which then can be easily mocked. It's -a bit of work initially, but usually pays for itself quickly. - -This Google Testing Blog -[post](https://testing.googleblog.com/2008/06/defeat-static-cling.html) says it -excellently. Check it out. - -### My mock object needs to do complex stuff. It's a lot of pain to specify the actions. gMock sucks! - -I know it's not a question, but you get an answer for free any way. :-) - -With gMock, you can create mocks in C++ easily. And people might be tempted to -use them everywhere. Sometimes they work great, and sometimes you may find them, -well, a pain to use. So, what's wrong in the latter case? - -When you write a test without using mocks, you exercise the code and assert that -it returns the correct value or that the system is in an expected state. This is -sometimes called "state-based testing". - -Mocks are great for what some call "interaction-based" testing: instead of -checking the system state at the very end, mock objects verify that they are -invoked the right way and report an error as soon as it arises, giving you a -handle on the precise context in which the error was triggered. This is often -more effective and economical to do than state-based testing. - -If you are doing state-based testing and using a test double just to simulate -the real object, you are probably better off using a fake. Using a mock in this -case causes pain, as it's not a strong point for mocks to perform complex -actions. If you experience this and think that mocks suck, you are just not -using the right tool for your problem. Or, you might be trying to solve the -wrong problem. :-) - -### I got a warning "Uninteresting function call encountered - default action taken.." Should I panic? - -By all means, NO! It's just an FYI. :-) - -What it means is that you have a mock function, you haven't set any expectations -on it (by gMock's rule this means that you are not interested in calls to this -function and therefore it can be called any number of times), and it is called. -That's OK - you didn't say it's not OK to call the function! - -What if you actually meant to disallow this function to be called, but forgot to -write `EXPECT_CALL(foo, Bar()).Times(0)`? While one can argue that it's the -user's fault, gMock tries to be nice and prints you a note. - -So, when you see the message and believe that there shouldn't be any -uninteresting calls, you should investigate what's going on. To make your life -easier, gMock dumps the stack trace when an uninteresting call is encountered. -From that you can figure out which mock function it is, and how it is called. - -### I want to define a custom action. Should I use Invoke() or implement the ActionInterface interface? - -Either way is fine - you want to choose the one that's more convenient for your -circumstance. - -Usually, if your action is for a particular function type, defining it using -`Invoke()` should be easier; if your action can be used in functions of -different types (e.g. if you are defining `Return(*value*)`), -`MakePolymorphicAction()` is easiest. Sometimes you want precise control on what -types of functions the action can be used in, and implementing `ActionInterface` -is the way to go here. See the implementation of `Return()` in -`testing/base/public/gmock-actions.h` for an example. - -### I use SetArgPointee() in WillOnce(), but gcc complains about "conflicting return type specified". What does it mean? - -You got this error as gMock has no idea what value it should return when the -mock method is called. `SetArgPointee()` says what the side effect is, but -doesn't say what the return value should be. You need `DoAll()` to chain a -`SetArgPointee()` with a `Return()` that provides a value appropriate to the API -being mocked. - -See this [recipe](gmock_cook_book.md#mocking-side-effects) for more details and -an example. - -### I have a huge mock class, and Microsoft Visual C++ runs out of memory when compiling it. What can I do? - -We've noticed that when the `/clr` compiler flag is used, Visual C++ uses 5~6 -times as much memory when compiling a mock class. We suggest to avoid `/clr` -when compiling native C++ mocks. diff --git a/external/googletest/docs/gmock_for_dummies.md b/external/googletest/docs/gmock_for_dummies.md deleted file mode 100644 index 1f4cc246c4..0000000000 --- a/external/googletest/docs/gmock_for_dummies.md +++ /dev/null @@ -1,700 +0,0 @@ -# gMock for Dummies - -## What Is gMock? - -When you write a prototype or test, often it's not feasible or wise to rely on -real objects entirely. A **mock object** implements the same interface as a real -object (so it can be used as one), but lets you specify at run time how it will -be used and what it should do (which methods will be called? in which order? how -many times? with what arguments? what will they return? etc). - -It is easy to confuse the term *fake objects* with mock objects. Fakes and mocks -actually mean very different things in the Test-Driven Development (TDD) -community: - -* **Fake** objects have working implementations, but usually take some - shortcut (perhaps to make the operations less expensive), which makes them - not suitable for production. An in-memory file system would be an example of - a fake. -* **Mocks** are objects pre-programmed with *expectations*, which form a - specification of the calls they are expected to receive. - -If all this seems too abstract for you, don't worry - the most important thing -to remember is that a mock allows you to check the *interaction* between itself -and code that uses it. The difference between fakes and mocks shall become much -clearer once you start to use mocks. - -**gMock** is a library (sometimes we also call it a "framework" to make it sound -cool) for creating mock classes and using them. It does to C++ what -jMock/EasyMock does to Java (well, more or less). - -When using gMock, - -1. first, you use some simple macros to describe the interface you want to - mock, and they will expand to the implementation of your mock class; -2. next, you create some mock objects and specify its expectations and behavior - using an intuitive syntax; -3. then you exercise code that uses the mock objects. gMock will catch any - violation to the expectations as soon as it arises. - -## Why gMock? - -While mock objects help you remove unnecessary dependencies in tests and make -them fast and reliable, using mocks manually in C++ is *hard*: - -* Someone has to implement the mocks. The job is usually tedious and - error-prone. No wonder people go great distance to avoid it. -* The quality of those manually written mocks is a bit, uh, unpredictable. You - may see some really polished ones, but you may also see some that were - hacked up in a hurry and have all sorts of ad hoc restrictions. -* The knowledge you gained from using one mock doesn't transfer to the next - one. - -In contrast, Java and Python programmers have some fine mock frameworks (jMock, -EasyMock, etc), which automate the creation of mocks. As a result, mocking is a -proven effective technique and widely adopted practice in those communities. -Having the right tool absolutely makes the difference. - -gMock was built to help C++ programmers. It was inspired by jMock and EasyMock, -but designed with C++'s specifics in mind. It is your friend if any of the -following problems is bothering you: - -* You are stuck with a sub-optimal design and wish you had done more - prototyping before it was too late, but prototyping in C++ is by no means - "rapid". -* Your tests are slow as they depend on too many libraries or use expensive - resources (e.g. a database). -* Your tests are brittle as some resources they use are unreliable (e.g. the - network). -* You want to test how your code handles a failure (e.g. a file checksum - error), but it's not easy to cause one. -* You need to make sure that your module interacts with other modules in the - right way, but it's hard to observe the interaction; therefore you resort to - observing the side effects at the end of the action, but it's awkward at - best. -* You want to "mock out" your dependencies, except that they don't have mock - implementations yet; and, frankly, you aren't thrilled by some of those - hand-written mocks. - -We encourage you to use gMock as - -* a *design* tool, for it lets you experiment with your interface design early - and often. More iterations lead to better designs! -* a *testing* tool to cut your tests' outbound dependencies and probe the - interaction between your module and its collaborators. - -## Getting Started - -gMock is bundled with googletest. - -## A Case for Mock Turtles - -Let's look at an example. Suppose you are developing a graphics program that -relies on a [LOGO](http://en.wikipedia.org/wiki/Logo_programming_language)-like -API for drawing. How would you test that it does the right thing? Well, you can -run it and compare the screen with a golden screen snapshot, but let's admit it: -tests like this are expensive to run and fragile (What if you just upgraded to a -shiny new graphics card that has better anti-aliasing? Suddenly you have to -update all your golden images.). It would be too painful if all your tests are -like this. Fortunately, you learned about -[Dependency Injection](http://en.wikipedia.org/wiki/Dependency_injection) and know the right thing -to do: instead of having your application talk to the system API directly, wrap -the API in an interface (say, `Turtle`) and code to that interface: - -```cpp -class Turtle { - ... - virtual ~Turtle() {} - virtual void PenUp() = 0; - virtual void PenDown() = 0; - virtual void Forward(int distance) = 0; - virtual void Turn(int degrees) = 0; - virtual void GoTo(int x, int y) = 0; - virtual int GetX() const = 0; - virtual int GetY() const = 0; -}; -``` - -(Note that the destructor of `Turtle` **must** be virtual, as is the case for -**all** classes you intend to inherit from - otherwise the destructor of the -derived class will not be called when you delete an object through a base -pointer, and you'll get corrupted program states like memory leaks.) - -You can control whether the turtle's movement will leave a trace using `PenUp()` -and `PenDown()`, and control its movement using `Forward()`, `Turn()`, and -`GoTo()`. Finally, `GetX()` and `GetY()` tell you the current position of the -turtle. - -Your program will normally use a real implementation of this interface. In -tests, you can use a mock implementation instead. This allows you to easily -check what drawing primitives your program is calling, with what arguments, and -in which order. Tests written this way are much more robust (they won't break -because your new machine does anti-aliasing differently), easier to read and -maintain (the intent of a test is expressed in the code, not in some binary -images), and run *much, much faster*. - -## Writing the Mock Class - -If you are lucky, the mocks you need to use have already been implemented by -some nice people. If, however, you find yourself in the position to write a mock -class, relax - gMock turns this task into a fun game! (Well, almost.) - -### How to Define It - -Using the `Turtle` interface as example, here are the simple steps you need to -follow: - -* Derive a class `MockTurtle` from `Turtle`. -* Take a *virtual* function of `Turtle` (while it's possible to - [mock non-virtual methods using templates](gmock_cook_book.md#MockingNonVirtualMethods), - it's much more involved). -* In the `public:` section of the child class, write `MOCK_METHOD();` -* Now comes the fun part: you take the function signature, cut-and-paste it - into the macro, and add two commas - one between the return type and the - name, another between the name and the argument list. -* If you're mocking a const method, add a 4th parameter containing `(const)` - (the parentheses are required). -* Since you're overriding a virtual method, we suggest adding the `override` - keyword. For const methods the 4th parameter becomes `(const, override)`, - for non-const methods just `(override)`. This isn't mandatory. -* Repeat until all virtual functions you want to mock are done. (It goes - without saying that *all* pure virtual methods in your abstract class must - be either mocked or overridden.) - -After the process, you should have something like: - -```cpp -#include "gmock/gmock.h" // Brings in gMock. - -class MockTurtle : public Turtle { - public: - ... - MOCK_METHOD(void, PenUp, (), (override)); - MOCK_METHOD(void, PenDown, (), (override)); - MOCK_METHOD(void, Forward, (int distance), (override)); - MOCK_METHOD(void, Turn, (int degrees), (override)); - MOCK_METHOD(void, GoTo, (int x, int y), (override)); - MOCK_METHOD(int, GetX, (), (const, override)); - MOCK_METHOD(int, GetY, (), (const, override)); -}; -``` - -You don't need to define these mock methods somewhere else - the `MOCK_METHOD` -macro will generate the definitions for you. It's that simple! - -### Where to Put It - -When you define a mock class, you need to decide where to put its definition. -Some people put it in a `_test.cc`. This is fine when the interface being mocked -(say, `Foo`) is owned by the same person or team. Otherwise, when the owner of -`Foo` changes it, your test could break. (You can't really expect `Foo`'s -maintainer to fix every test that uses `Foo`, can you?) - -So, the rule of thumb is: if you need to mock `Foo` and it's owned by others, -define the mock class in `Foo`'s package (better, in a `testing` sub-package -such that you can clearly separate production code and testing utilities), put -it in a `.h` and a `cc_library`. Then everyone can reference them from their -tests. If `Foo` ever changes, there is only one copy of `MockFoo` to change, and -only tests that depend on the changed methods need to be fixed. - -Another way to do it: you can introduce a thin layer `FooAdaptor` on top of -`Foo` and code to this new interface. Since you own `FooAdaptor`, you can absorb -changes in `Foo` much more easily. While this is more work initially, carefully -choosing the adaptor interface can make your code easier to write and more -readable (a net win in the long run), as you can choose `FooAdaptor` to fit your -specific domain much better than `Foo` does. - -## Using Mocks in Tests - -Once you have a mock class, using it is easy. The typical work flow is: - -1. Import the gMock names from the `testing` namespace such that you can use - them unqualified (You only have to do it once per file). Remember that - namespaces are a good idea. -2. Create some mock objects. -3. Specify your expectations on them (How many times will a method be called? - With what arguments? What should it do? etc.). -4. Exercise some code that uses the mocks; optionally, check the result using - googletest assertions. If a mock method is called more than expected or with - wrong arguments, you'll get an error immediately. -5. When a mock is destructed, gMock will automatically check whether all - expectations on it have been satisfied. - -Here's an example: - -```cpp -#include "path/to/mock-turtle.h" -#include "gmock/gmock.h" -#include "gtest/gtest.h" - -using ::testing::AtLeast; // #1 - -TEST(PainterTest, CanDrawSomething) { - MockTurtle turtle; // #2 - EXPECT_CALL(turtle, PenDown()) // #3 - .Times(AtLeast(1)); - - Painter painter(&turtle); // #4 - - EXPECT_TRUE(painter.DrawCircle(0, 0, 10)); // #5 -} -``` - -As you might have guessed, this test checks that `PenDown()` is called at least -once. If the `painter` object didn't call this method, your test will fail with -a message like this: - -```text -path/to/my_test.cc:119: Failure -Actual function call count doesn't match this expectation: -Actually: never called; -Expected: called at least once. -Stack trace: -... -``` - -**Tip 1:** If you run the test from an Emacs buffer, you can hit `` on -the line number to jump right to the failed expectation. - -**Tip 2:** If your mock objects are never deleted, the final verification won't -happen. Therefore it's a good idea to turn on the heap checker in your tests -when you allocate mocks on the heap. You get that automatically if you use the -`gtest_main` library already. - -**Important note:** gMock requires expectations to be set **before** the mock -functions are called, otherwise the behavior is **undefined**. Do not alternate -between calls to `EXPECT_CALL()` and calls to the mock functions, and do not set -any expectations on a mock after passing the mock to an API. - -This means `EXPECT_CALL()` should be read as expecting that a call will occur -*in the future*, not that a call has occurred. Why does gMock work like that? -Well, specifying the expectation beforehand allows gMock to report a violation -as soon as it rises, when the context (stack trace, etc) is still available. -This makes debugging much easier. - -Admittedly, this test is contrived and doesn't do much. You can easily achieve -the same effect without using gMock. However, as we shall reveal soon, gMock -allows you to do *so much more* with the mocks. - -## Setting Expectations - -The key to using a mock object successfully is to set the *right expectations* -on it. If you set the expectations too strict, your test will fail as the result -of unrelated changes. If you set them too loose, bugs can slip through. You want -to do it just right such that your test can catch exactly the kind of bugs you -intend it to catch. gMock provides the necessary means for you to do it "just -right." - -### General Syntax - -In gMock we use the `EXPECT_CALL()` macro to set an expectation on a mock -method. The general syntax is: - -```cpp -EXPECT_CALL(mock_object, method(matchers)) - .Times(cardinality) - .WillOnce(action) - .WillRepeatedly(action); -``` - -The macro has two arguments: first the mock object, and then the method and its -arguments. Note that the two are separated by a comma (`,`), not a period (`.`). -(Why using a comma? The answer is that it was necessary for technical reasons.) -If the method is not overloaded, the macro can also be called without matchers: - -```cpp -EXPECT_CALL(mock_object, non-overloaded-method) - .Times(cardinality) - .WillOnce(action) - .WillRepeatedly(action); -``` - -This syntax allows the test writer to specify "called with any arguments" -without explicitly specifying the number or types of arguments. To avoid -unintended ambiguity, this syntax may only be used for methods that are not -overloaded. - -Either form of the macro can be followed by some optional *clauses* that provide -more information about the expectation. We'll discuss how each clause works in -the coming sections. - -This syntax is designed to make an expectation read like English. For example, -you can probably guess that - -```cpp -using ::testing::Return; -... -EXPECT_CALL(turtle, GetX()) - .Times(5) - .WillOnce(Return(100)) - .WillOnce(Return(150)) - .WillRepeatedly(Return(200)); -``` - -says that the `turtle` object's `GetX()` method will be called five times, it -will return 100 the first time, 150 the second time, and then 200 every time. -Some people like to call this style of syntax a Domain-Specific Language (DSL). - -{: .callout .note} -**Note:** Why do we use a macro to do this? Well it serves two purposes: first -it makes expectations easily identifiable (either by `grep` or by a human -reader), and second it allows gMock to include the source file location of a -failed expectation in messages, making debugging easier. - -### Matchers: What Arguments Do We Expect? - -When a mock function takes arguments, we may specify what arguments we are -expecting, for example: - -```cpp -// Expects the turtle to move forward by 100 units. -EXPECT_CALL(turtle, Forward(100)); -``` - -Oftentimes you do not want to be too specific. Remember that talk about tests -being too rigid? Over specification leads to brittle tests and obscures the -intent of tests. Therefore we encourage you to specify only what's necessary—no -more, no less. If you aren't interested in the value of an argument, write `_` -as the argument, which means "anything goes": - -```cpp -using ::testing::_; -... -// Expects that the turtle jumps to somewhere on the x=50 line. -EXPECT_CALL(turtle, GoTo(50, _)); -``` - -`_` is an instance of what we call **matchers**. A matcher is like a predicate -and can test whether an argument is what we'd expect. You can use a matcher -inside `EXPECT_CALL()` wherever a function argument is expected. `_` is a -convenient way of saying "any value". - -In the above examples, `100` and `50` are also matchers; implicitly, they are -the same as `Eq(100)` and `Eq(50)`, which specify that the argument must be -equal (using `operator==`) to the matcher argument. There are many -[built-in matchers](reference/matchers.md) for common types (as well as -[custom matchers](gmock_cook_book.md#NewMatchers)); for example: - -```cpp -using ::testing::Ge; -... -// Expects the turtle moves forward by at least 100. -EXPECT_CALL(turtle, Forward(Ge(100))); -``` - -If you don't care about *any* arguments, rather than specify `_` for each of -them you may instead omit the parameter list: - -```cpp -// Expects the turtle to move forward. -EXPECT_CALL(turtle, Forward); -// Expects the turtle to jump somewhere. -EXPECT_CALL(turtle, GoTo); -``` - -This works for all non-overloaded methods; if a method is overloaded, you need -to help gMock resolve which overload is expected by specifying the number of -arguments and possibly also the -[types of the arguments](gmock_cook_book.md#SelectOverload). - -### Cardinalities: How Many Times Will It Be Called? - -The first clause we can specify following an `EXPECT_CALL()` is `Times()`. We -call its argument a **cardinality** as it tells *how many times* the call should -occur. It allows us to repeat an expectation many times without actually writing -it as many times. More importantly, a cardinality can be "fuzzy", just like a -matcher can be. This allows a user to express the intent of a test exactly. - -An interesting special case is when we say `Times(0)`. You may have guessed - it -means that the function shouldn't be called with the given arguments at all, and -gMock will report a googletest failure whenever the function is (wrongfully) -called. - -We've seen `AtLeast(n)` as an example of fuzzy cardinalities earlier. For the -list of built-in cardinalities you can use, see -[here](gmock_cheat_sheet.md#CardinalityList). - -The `Times()` clause can be omitted. **If you omit `Times()`, gMock will infer -the cardinality for you.** The rules are easy to remember: - -* If **neither** `WillOnce()` **nor** `WillRepeatedly()` is in the - `EXPECT_CALL()`, the inferred cardinality is `Times(1)`. -* If there are *n* `WillOnce()`'s but **no** `WillRepeatedly()`, where *n* >= - 1, the cardinality is `Times(n)`. -* If there are *n* `WillOnce()`'s and **one** `WillRepeatedly()`, where *n* >= - 0, the cardinality is `Times(AtLeast(n))`. - -**Quick quiz:** what do you think will happen if a function is expected to be -called twice but actually called four times? - -### Actions: What Should It Do? - -Remember that a mock object doesn't really have a working implementation? We as -users have to tell it what to do when a method is invoked. This is easy in -gMock. - -First, if the return type of a mock function is a built-in type or a pointer, -the function has a **default action** (a `void` function will just return, a -`bool` function will return `false`, and other functions will return 0). In -addition, in C++ 11 and above, a mock function whose return type is -default-constructible (i.e. has a default constructor) has a default action of -returning a default-constructed value. If you don't say anything, this behavior -will be used. - -Second, if a mock function doesn't have a default action, or the default action -doesn't suit you, you can specify the action to be taken each time the -expectation matches using a series of `WillOnce()` clauses followed by an -optional `WillRepeatedly()`. For example, - -```cpp -using ::testing::Return; -... -EXPECT_CALL(turtle, GetX()) - .WillOnce(Return(100)) - .WillOnce(Return(200)) - .WillOnce(Return(300)); -``` - -says that `turtle.GetX()` will be called *exactly three times* (gMock inferred -this from how many `WillOnce()` clauses we've written, since we didn't -explicitly write `Times()`), and will return 100, 200, and 300 respectively. - -```cpp -using ::testing::Return; -... -EXPECT_CALL(turtle, GetY()) - .WillOnce(Return(100)) - .WillOnce(Return(200)) - .WillRepeatedly(Return(300)); -``` - -says that `turtle.GetY()` will be called *at least twice* (gMock knows this as -we've written two `WillOnce()` clauses and a `WillRepeatedly()` while having no -explicit `Times()`), will return 100 and 200 respectively the first two times, -and 300 from the third time on. - -Of course, if you explicitly write a `Times()`, gMock will not try to infer the -cardinality itself. What if the number you specified is larger than there are -`WillOnce()` clauses? Well, after all `WillOnce()`s are used up, gMock will do -the *default* action for the function every time (unless, of course, you have a -`WillRepeatedly()`.). - -What can we do inside `WillOnce()` besides `Return()`? You can return a -reference using `ReturnRef(*variable*)`, or invoke a pre-defined function, among -[others](gmock_cook_book.md#using-actions). - -**Important note:** The `EXPECT_CALL()` statement evaluates the action clause -only once, even though the action may be performed many times. Therefore you -must be careful about side effects. The following may not do what you want: - -```cpp -using ::testing::Return; -... -int n = 100; -EXPECT_CALL(turtle, GetX()) - .Times(4) - .WillRepeatedly(Return(n++)); -``` - -Instead of returning 100, 101, 102, ..., consecutively, this mock function will -always return 100 as `n++` is only evaluated once. Similarly, `Return(new Foo)` -will create a new `Foo` object when the `EXPECT_CALL()` is executed, and will -return the same pointer every time. If you want the side effect to happen every -time, you need to define a custom action, which we'll teach in the -[cook book](gmock_cook_book.md). - -Time for another quiz! What do you think the following means? - -```cpp -using ::testing::Return; -... -EXPECT_CALL(turtle, GetY()) - .Times(4) - .WillOnce(Return(100)); -``` - -Obviously `turtle.GetY()` is expected to be called four times. But if you think -it will return 100 every time, think twice! Remember that one `WillOnce()` -clause will be consumed each time the function is invoked and the default action -will be taken afterwards. So the right answer is that `turtle.GetY()` will -return 100 the first time, but **return 0 from the second time on**, as -returning 0 is the default action for `int` functions. - -### Using Multiple Expectations {#MultiExpectations} - -So far we've only shown examples where you have a single expectation. More -realistically, you'll specify expectations on multiple mock methods which may be -from multiple mock objects. - -By default, when a mock method is invoked, gMock will search the expectations in -the **reverse order** they are defined, and stop when an active expectation that -matches the arguments is found (you can think of it as "newer rules override -older ones."). If the matching expectation cannot take any more calls, you will -get an upper-bound-violated failure. Here's an example: - -```cpp -using ::testing::_; -... -EXPECT_CALL(turtle, Forward(_)); // #1 -EXPECT_CALL(turtle, Forward(10)) // #2 - .Times(2); -``` - -If `Forward(10)` is called three times in a row, the third time it will be an -error, as the last matching expectation (#2) has been saturated. If, however, -the third `Forward(10)` call is replaced by `Forward(20)`, then it would be OK, -as now #1 will be the matching expectation. - -{: .callout .note} -**Note:** Why does gMock search for a match in the *reverse* order of the -expectations? The reason is that this allows a user to set up the default -expectations in a mock object's constructor or the test fixture's set-up phase -and then customize the mock by writing more specific expectations in the test -body. So, if you have two expectations on the same method, you want to put the -one with more specific matchers **after** the other, or the more specific rule -would be shadowed by the more general one that comes after it. - -{: .callout .tip} -**Tip:** It is very common to start with a catch-all expectation for a method -and `Times(AnyNumber())` (omitting arguments, or with `_` for all arguments, if -overloaded). This makes any calls to the method expected. This is not necessary -for methods that are not mentioned at all (these are "uninteresting"), but is -useful for methods that have some expectations, but for which other calls are -ok. See -[Understanding Uninteresting vs Unexpected Calls](gmock_cook_book.md#uninteresting-vs-unexpected). - -### Ordered vs Unordered Calls {#OrderedCalls} - -By default, an expectation can match a call even though an earlier expectation -hasn't been satisfied. In other words, the calls don't have to occur in the -order the expectations are specified. - -Sometimes, you may want all the expected calls to occur in a strict order. To -say this in gMock is easy: - -```cpp -using ::testing::InSequence; -... -TEST(FooTest, DrawsLineSegment) { - ... - { - InSequence seq; - - EXPECT_CALL(turtle, PenDown()); - EXPECT_CALL(turtle, Forward(100)); - EXPECT_CALL(turtle, PenUp()); - } - Foo(); -} -``` - -By creating an object of type `InSequence`, all expectations in its scope are -put into a *sequence* and have to occur *sequentially*. Since we are just -relying on the constructor and destructor of this object to do the actual work, -its name is really irrelevant. - -In this example, we test that `Foo()` calls the three expected functions in the -order as written. If a call is made out-of-order, it will be an error. - -(What if you care about the relative order of some of the calls, but not all of -them? Can you specify an arbitrary partial order? The answer is ... yes! The -details can be found [here](gmock_cook_book.md#OrderedCalls).) - -### All Expectations Are Sticky (Unless Said Otherwise) {#StickyExpectations} - -Now let's do a quick quiz to see how well you can use this mock stuff already. -How would you test that the turtle is asked to go to the origin *exactly twice* -(you want to ignore any other instructions it receives)? - -After you've come up with your answer, take a look at ours and compare notes -(solve it yourself first - don't cheat!): - -```cpp -using ::testing::_; -using ::testing::AnyNumber; -... -EXPECT_CALL(turtle, GoTo(_, _)) // #1 - .Times(AnyNumber()); -EXPECT_CALL(turtle, GoTo(0, 0)) // #2 - .Times(2); -``` - -Suppose `turtle.GoTo(0, 0)` is called three times. In the third time, gMock will -see that the arguments match expectation #2 (remember that we always pick the -last matching expectation). Now, since we said that there should be only two -such calls, gMock will report an error immediately. This is basically what we've -told you in the [Using Multiple Expectations](#MultiExpectations) section above. - -This example shows that **expectations in gMock are "sticky" by default**, in -the sense that they remain active even after we have reached their invocation -upper bounds. This is an important rule to remember, as it affects the meaning -of the spec, and is **different** to how it's done in many other mocking -frameworks (Why'd we do that? Because we think our rule makes the common cases -easier to express and understand.). - -Simple? Let's see if you've really understood it: what does the following code -say? - -```cpp -using ::testing::Return; -... -for (int i = n; i > 0; i--) { - EXPECT_CALL(turtle, GetX()) - .WillOnce(Return(10*i)); -} -``` - -If you think it says that `turtle.GetX()` will be called `n` times and will -return 10, 20, 30, ..., consecutively, think twice! The problem is that, as we -said, expectations are sticky. So, the second time `turtle.GetX()` is called, -the last (latest) `EXPECT_CALL()` statement will match, and will immediately -lead to an "upper bound violated" error - this piece of code is not very useful! - -One correct way of saying that `turtle.GetX()` will return 10, 20, 30, ..., is -to explicitly say that the expectations are *not* sticky. In other words, they -should *retire* as soon as they are saturated: - -```cpp -using ::testing::Return; -... -for (int i = n; i > 0; i--) { - EXPECT_CALL(turtle, GetX()) - .WillOnce(Return(10*i)) - .RetiresOnSaturation(); -} -``` - -And, there's a better way to do it: in this case, we expect the calls to occur -in a specific order, and we line up the actions to match the order. Since the -order is important here, we should make it explicit using a sequence: - -```cpp -using ::testing::InSequence; -using ::testing::Return; -... -{ - InSequence s; - - for (int i = 1; i <= n; i++) { - EXPECT_CALL(turtle, GetX()) - .WillOnce(Return(10*i)) - .RetiresOnSaturation(); - } -} -``` - -By the way, the other situation where an expectation may *not* be sticky is when -it's in a sequence - as soon as another expectation that comes after it in the -sequence has been used, it automatically retires (and will never be used to -match any call). - -### Uninteresting Calls - -A mock object may have many methods, and not all of them are that interesting. -For example, in some tests we may not care about how many times `GetX()` and -`GetY()` get called. - -In gMock, if you are not interested in a method, just don't say anything about -it. If a call to this method occurs, you'll see a warning in the test output, -but it won't be a failure. This is called "naggy" behavior; to change, see -[The Nice, the Strict, and the Naggy](gmock_cook_book.md#NiceStrictNaggy). diff --git a/external/googletest/docs/index.md b/external/googletest/docs/index.md deleted file mode 100644 index b162c74011..0000000000 --- a/external/googletest/docs/index.md +++ /dev/null @@ -1,22 +0,0 @@ -# GoogleTest User's Guide - -## Welcome to GoogleTest! - -GoogleTest is Google's C++ testing and mocking framework. This user's guide has -the following contents: - -* [GoogleTest Primer](primer.md) - Teaches you how to write simple tests using - GoogleTest. Read this first if you are new to GoogleTest. -* [GoogleTest Advanced](advanced.md) - Read this when you've finished the - Primer and want to utilize GoogleTest to its full potential. -* [GoogleTest Samples](samples.md) - Describes some GoogleTest samples. -* [GoogleTest FAQ](faq.md) - Have a question? Want some tips? Check here - first. -* [Mocking for Dummies](gmock_for_dummies.md) - Teaches you how to create mock - objects and use them in tests. -* [Mocking Cookbook](gmock_cook_book.md) - Includes tips and approaches to - common mocking use cases. -* [Mocking Cheat Sheet](gmock_cheat_sheet.md) - A handy reference for - matchers, actions, invariants, and more. -* [Mocking FAQ](gmock_faq.md) - Contains answers to some mocking-specific - questions. diff --git a/external/googletest/docs/pkgconfig.md b/external/googletest/docs/pkgconfig.md deleted file mode 100644 index 768e9b4c26..0000000000 --- a/external/googletest/docs/pkgconfig.md +++ /dev/null @@ -1,148 +0,0 @@ -## Using GoogleTest from various build systems - -GoogleTest comes with pkg-config files that can be used to determine all -necessary flags for compiling and linking to GoogleTest (and GoogleMock). -Pkg-config is a standardised plain-text format containing - -* the includedir (-I) path -* necessary macro (-D) definitions -* further required flags (-pthread) -* the library (-L) path -* the library (-l) to link to - -All current build systems support pkg-config in one way or another. For all -examples here we assume you want to compile the sample -`samples/sample3_unittest.cc`. - -### CMake - -Using `pkg-config` in CMake is fairly easy: - -```cmake -cmake_minimum_required(VERSION 3.0) - -cmake_policy(SET CMP0048 NEW) -project(my_gtest_pkgconfig VERSION 0.0.1 LANGUAGES CXX) - -find_package(PkgConfig) -pkg_search_module(GTEST REQUIRED gtest_main) - -add_executable(testapp samples/sample3_unittest.cc) -target_link_libraries(testapp ${GTEST_LDFLAGS}) -target_compile_options(testapp PUBLIC ${GTEST_CFLAGS}) - -include(CTest) -add_test(first_and_only_test testapp) -``` - -It is generally recommended that you use `target_compile_options` + `_CFLAGS` -over `target_include_directories` + `_INCLUDE_DIRS` as the former includes not -just -I flags (GoogleTest might require a macro indicating to internal headers -that all libraries have been compiled with threading enabled. In addition, -GoogleTest might also require `-pthread` in the compiling step, and as such -splitting the pkg-config `Cflags` variable into include dirs and macros for -`target_compile_definitions()` might still miss this). The same recommendation -goes for using `_LDFLAGS` over the more commonplace `_LIBRARIES`, which happens -to discard `-L` flags and `-pthread`. - -### Help! pkg-config can't find GoogleTest! - -Let's say you have a `CMakeLists.txt` along the lines of the one in this -tutorial and you try to run `cmake`. It is very possible that you get a failure -along the lines of: - -``` --- Checking for one of the modules 'gtest_main' -CMake Error at /usr/share/cmake/Modules/FindPkgConfig.cmake:640 (message): - None of the required 'gtest_main' found -``` - -These failures are common if you installed GoogleTest yourself and have not -sourced it from a distro or other package manager. If so, you need to tell -pkg-config where it can find the `.pc` files containing the information. Say you -installed GoogleTest to `/usr/local`, then it might be that the `.pc` files are -installed under `/usr/local/lib64/pkgconfig`. If you set - -``` -export PKG_CONFIG_PATH=/usr/local/lib64/pkgconfig -``` - -pkg-config will also try to look in `PKG_CONFIG_PATH` to find `gtest_main.pc`. - -### Using pkg-config in a cross-compilation setting - -Pkg-config can be used in a cross-compilation setting too. To do this, let's -assume the final prefix of the cross-compiled installation will be `/usr`, and -your sysroot is `/home/MYUSER/sysroot`. Configure and install GTest using - -``` -mkdir build && cmake -DCMAKE_INSTALL_PREFIX=/usr .. -``` - -Install into the sysroot using `DESTDIR`: - -``` -make -j install DESTDIR=/home/MYUSER/sysroot -``` - -Before we continue, it is recommended to **always** define the following two -variables for pkg-config in a cross-compilation setting: - -``` -export PKG_CONFIG_ALLOW_SYSTEM_CFLAGS=yes -export PKG_CONFIG_ALLOW_SYSTEM_LIBS=yes -``` - -otherwise `pkg-config` will filter `-I` and `-L` flags against standard prefixes -such as `/usr` (see https://bugs.freedesktop.org/show_bug.cgi?id=28264#c3 for -reasons why this stripping needs to occur usually). - -If you look at the generated pkg-config file, it will look something like - -``` -libdir=/usr/lib64 -includedir=/usr/include - -Name: gtest -Description: GoogleTest (without main() function) -Version: 1.10.0 -URL: https://github.com/google/googletest -Libs: -L${libdir} -lgtest -lpthread -Cflags: -I${includedir} -DGTEST_HAS_PTHREAD=1 -lpthread -``` - -Notice that the sysroot is not included in `libdir` and `includedir`! If you try -to run `pkg-config` with the correct -`PKG_CONFIG_LIBDIR=/home/MYUSER/sysroot/usr/lib64/pkgconfig` against this `.pc` -file, you will get - -``` -$ pkg-config --cflags gtest --DGTEST_HAS_PTHREAD=1 -lpthread -I/usr/include -$ pkg-config --libs gtest --L/usr/lib64 -lgtest -lpthread -``` - -which is obviously wrong and points to the `CBUILD` and not `CHOST` root. In -order to use this in a cross-compilation setting, we need to tell pkg-config to -inject the actual sysroot into `-I` and `-L` variables. Let us now tell -pkg-config about the actual sysroot - -``` -export PKG_CONFIG_DIR= -export PKG_CONFIG_SYSROOT_DIR=/home/MYUSER/sysroot -export PKG_CONFIG_LIBDIR=${PKG_CONFIG_SYSROOT_DIR}/usr/lib64/pkgconfig -``` - -and running `pkg-config` again we get - -``` -$ pkg-config --cflags gtest --DGTEST_HAS_PTHREAD=1 -lpthread -I/home/MYUSER/sysroot/usr/include -$ pkg-config --libs gtest --L/home/MYUSER/sysroot/usr/lib64 -lgtest -lpthread -``` - -which contains the correct sysroot now. For a more comprehensive guide to also -including `${CHOST}` in build system calls, see the excellent tutorial by Diego -Elio Pettenò: diff --git a/external/googletest/docs/platforms.md b/external/googletest/docs/platforms.md deleted file mode 100644 index eba6ef8056..0000000000 --- a/external/googletest/docs/platforms.md +++ /dev/null @@ -1,35 +0,0 @@ -# Supported Platforms - -GoogleTest requires a codebase and compiler compliant with the C++11 standard or -newer. - -The GoogleTest code is officially supported on the following platforms. -Operating systems or tools not listed below are community-supported. For -community-supported platforms, patches that do not complicate the code may be -considered. - -If you notice any problems on your platform, please file an issue on the -[GoogleTest GitHub Issue Tracker](https://github.com/google/googletest/issues). -Pull requests containing fixes are welcome! - -### Operating systems - -* Linux -* macOS -* Windows - -### Compilers - -* gcc 5.0+ -* clang 5.0+ -* MSVC 2015+ - -**macOS users:** Xcode 9.3+ provides clang 5.0+. - -### Build systems - -* [Bazel](https://bazel.build/) -* [CMake](https://cmake.org/) - -Bazel is the build system used by the team internally and in tests. CMake is -supported on a best-effort basis and by the community. diff --git a/external/googletest/docs/primer.md b/external/googletest/docs/primer.md deleted file mode 100644 index 6d8fdf4439..0000000000 --- a/external/googletest/docs/primer.md +++ /dev/null @@ -1,482 +0,0 @@ -# Googletest Primer - -## Introduction: Why googletest? - -*googletest* helps you write better C++ tests. - -googletest is a testing framework developed by the Testing Technology team with -Google's specific requirements and constraints in mind. Whether you work on -Linux, Windows, or a Mac, if you write C++ code, googletest can help you. And it -supports *any* kind of tests, not just unit tests. - -So what makes a good test, and how does googletest fit in? We believe: - -1. Tests should be *independent* and *repeatable*. It's a pain to debug a test - that succeeds or fails as a result of other tests. googletest isolates the - tests by running each of them on a different object. When a test fails, - googletest allows you to run it in isolation for quick debugging. -2. Tests should be well *organized* and reflect the structure of the tested - code. googletest groups related tests into test suites that can share data - and subroutines. This common pattern is easy to recognize and makes tests - easy to maintain. Such consistency is especially helpful when people switch - projects and start to work on a new code base. -3. Tests should be *portable* and *reusable*. Google has a lot of code that is - platform-neutral; its tests should also be platform-neutral. googletest - works on different OSes, with different compilers, with or without - exceptions, so googletest tests can work with a variety of configurations. -4. When tests fail, they should provide as much *information* about the problem - as possible. googletest doesn't stop at the first test failure. Instead, it - only stops the current test and continues with the next. You can also set up - tests that report non-fatal failures after which the current test continues. - Thus, you can detect and fix multiple bugs in a single run-edit-compile - cycle. -5. The testing framework should liberate test writers from housekeeping chores - and let them focus on the test *content*. googletest automatically keeps - track of all tests defined, and doesn't require the user to enumerate them - in order to run them. -6. Tests should be *fast*. With googletest, you can reuse shared resources - across tests and pay for the set-up/tear-down only once, without making - tests depend on each other. - -Since googletest is based on the popular xUnit architecture, you'll feel right -at home if you've used JUnit or PyUnit before. If not, it will take you about 10 -minutes to learn the basics and get started. So let's go! - -## Beware of the nomenclature - -{: .callout .note} -_Note:_ There might be some confusion arising from different definitions of the -terms _Test_, _Test Case_ and _Test Suite_, so beware of misunderstanding these. - -Historically, googletest started to use the term _Test Case_ for grouping -related tests, whereas current publications, including International Software -Testing Qualifications Board ([ISTQB](http://www.istqb.org/)) materials and -various textbooks on software quality, use the term -_[Test Suite][istqb test suite]_ for this. - -The related term _Test_, as it is used in googletest, corresponds to the term -_[Test Case][istqb test case]_ of ISTQB and others. - -The term _Test_ is commonly of broad enough sense, including ISTQB's definition -of _Test Case_, so it's not much of a problem here. But the term _Test Case_ as -was used in Google Test is of contradictory sense and thus confusing. - -googletest recently started replacing the term _Test Case_ with _Test Suite_. -The preferred API is *TestSuite*. The older TestCase API is being slowly -deprecated and refactored away. - -So please be aware of the different definitions of the terms: - - -Meaning | googletest Term | [ISTQB](http://www.istqb.org/) Term -:----------------------------------------------------------------------------------- | :---------------------- | :---------------------------------- -Exercise a particular program path with specific input values and verify the results | [TEST()](#simple-tests) | [Test Case][istqb test case] - - -[istqb test case]: http://glossary.istqb.org/en/search/test%20case -[istqb test suite]: http://glossary.istqb.org/en/search/test%20suite - -## Basic Concepts - -When using googletest, you start by writing *assertions*, which are statements -that check whether a condition is true. An assertion's result can be *success*, -*nonfatal failure*, or *fatal failure*. If a fatal failure occurs, it aborts the -current function; otherwise the program continues normally. - -*Tests* use assertions to verify the tested code's behavior. If a test crashes -or has a failed assertion, then it *fails*; otherwise it *succeeds*. - -A *test suite* contains one or many tests. You should group your tests into test -suites that reflect the structure of the tested code. When multiple tests in a -test suite need to share common objects and subroutines, you can put them into a -*test fixture* class. - -A *test program* can contain multiple test suites. - -We'll now explain how to write a test program, starting at the individual -assertion level and building up to tests and test suites. - -## Assertions - -googletest assertions are macros that resemble function calls. You test a class -or function by making assertions about its behavior. When an assertion fails, -googletest prints the assertion's source file and line number location, along -with a failure message. You may also supply a custom failure message which will -be appended to googletest's message. - -The assertions come in pairs that test the same thing but have different effects -on the current function. `ASSERT_*` versions generate fatal failures when they -fail, and **abort the current function**. `EXPECT_*` versions generate nonfatal -failures, which don't abort the current function. Usually `EXPECT_*` are -preferred, as they allow more than one failure to be reported in a test. -However, you should use `ASSERT_*` if it doesn't make sense to continue when the -assertion in question fails. - -Since a failed `ASSERT_*` returns from the current function immediately, -possibly skipping clean-up code that comes after it, it may cause a space leak. -Depending on the nature of the leak, it may or may not be worth fixing - so keep -this in mind if you get a heap checker error in addition to assertion errors. - -To provide a custom failure message, simply stream it into the macro using the -`<<` operator or a sequence of such operators. See the following example, using -the [`ASSERT_EQ` and `EXPECT_EQ`](reference/assertions.md#EXPECT_EQ) macros to -verify value equality: - -```c++ -ASSERT_EQ(x.size(), y.size()) << "Vectors x and y are of unequal length"; - -for (int i = 0; i < x.size(); ++i) { - EXPECT_EQ(x[i], y[i]) << "Vectors x and y differ at index " << i; -} -``` - -Anything that can be streamed to an `ostream` can be streamed to an assertion -macro--in particular, C strings and `string` objects. If a wide string -(`wchar_t*`, `TCHAR*` in `UNICODE` mode on Windows, or `std::wstring`) is -streamed to an assertion, it will be translated to UTF-8 when printed. - -GoogleTest provides a collection of assertions for verifying the behavior of -your code in various ways. You can check Boolean conditions, compare values -based on relational operators, verify string values, floating-point values, and -much more. There are even assertions that enable you to verify more complex -states by providing custom predicates. For the complete list of assertions -provided by GoogleTest, see the [Assertions Reference](reference/assertions.md). - -## Simple Tests - -To create a test: - -1. Use the `TEST()` macro to define and name a test function. These are - ordinary C++ functions that don't return a value. -2. In this function, along with any valid C++ statements you want to include, - use the various googletest assertions to check values. -3. The test's result is determined by the assertions; if any assertion in the - test fails (either fatally or non-fatally), or if the test crashes, the - entire test fails. Otherwise, it succeeds. - -```c++ -TEST(TestSuiteName, TestName) { - ... test body ... -} -``` - -`TEST()` arguments go from general to specific. The *first* argument is the name -of the test suite, and the *second* argument is the test's name within the test -suite. Both names must be valid C++ identifiers, and they should not contain -any underscores (`_`). A test's *full name* consists of its containing test suite and -its individual name. Tests from different test suites can have the same -individual name. - -For example, let's take a simple integer function: - -```c++ -int Factorial(int n); // Returns the factorial of n -``` - -A test suite for this function might look like: - -```c++ -// Tests factorial of 0. -TEST(FactorialTest, HandlesZeroInput) { - EXPECT_EQ(Factorial(0), 1); -} - -// Tests factorial of positive numbers. -TEST(FactorialTest, HandlesPositiveInput) { - EXPECT_EQ(Factorial(1), 1); - EXPECT_EQ(Factorial(2), 2); - EXPECT_EQ(Factorial(3), 6); - EXPECT_EQ(Factorial(8), 40320); -} -``` - -googletest groups the test results by test suites, so logically related tests -should be in the same test suite; in other words, the first argument to their -`TEST()` should be the same. In the above example, we have two tests, -`HandlesZeroInput` and `HandlesPositiveInput`, that belong to the same test -suite `FactorialTest`. - -When naming your test suites and tests, you should follow the same convention as -for -[naming functions and classes](https://google.github.io/styleguide/cppguide.html#Function_Names). - -**Availability**: Linux, Windows, Mac. - -## Test Fixtures: Using the Same Data Configuration for Multiple Tests {#same-data-multiple-tests} - -If you find yourself writing two or more tests that operate on similar data, you -can use a *test fixture*. This allows you to reuse the same configuration of -objects for several different tests. - -To create a fixture: - -1. Derive a class from `::testing::Test` . Start its body with `protected:`, as - we'll want to access fixture members from sub-classes. -2. Inside the class, declare any objects you plan to use. -3. If necessary, write a default constructor or `SetUp()` function to prepare - the objects for each test. A common mistake is to spell `SetUp()` as - **`Setup()`** with a small `u` - Use `override` in C++11 to make sure you - spelled it correctly. -4. If necessary, write a destructor or `TearDown()` function to release any - resources you allocated in `SetUp()` . To learn when you should use the - constructor/destructor and when you should use `SetUp()/TearDown()`, read - the [FAQ](faq.md#CtorVsSetUp). -5. If needed, define subroutines for your tests to share. - -When using a fixture, use `TEST_F()` instead of `TEST()` as it allows you to -access objects and subroutines in the test fixture: - -```c++ -TEST_F(TestFixtureName, TestName) { - ... test body ... -} -``` - -Like `TEST()`, the first argument is the test suite name, but for `TEST_F()` -this must be the name of the test fixture class. You've probably guessed: `_F` -is for fixture. - -Unfortunately, the C++ macro system does not allow us to create a single macro -that can handle both types of tests. Using the wrong macro causes a compiler -error. - -Also, you must first define a test fixture class before using it in a -`TEST_F()`, or you'll get the compiler error "`virtual outside class -declaration`". - -For each test defined with `TEST_F()`, googletest will create a *fresh* test -fixture at runtime, immediately initialize it via `SetUp()`, run the test, -clean up by calling `TearDown()`, and then delete the test fixture. Note that -different tests in the same test suite have different test fixture objects, and -googletest always deletes a test fixture before it creates the next one. -googletest does **not** reuse the same test fixture for multiple tests. Any -changes one test makes to the fixture do not affect other tests. - -As an example, let's write tests for a FIFO queue class named `Queue`, which has -the following interface: - -```c++ -template // E is the element type. -class Queue { - public: - Queue(); - void Enqueue(const E& element); - E* Dequeue(); // Returns NULL if the queue is empty. - size_t size() const; - ... -}; -``` - -First, define a fixture class. By convention, you should give it the name -`FooTest` where `Foo` is the class being tested. - -```c++ -class QueueTest : public ::testing::Test { - protected: - void SetUp() override { - q1_.Enqueue(1); - q2_.Enqueue(2); - q2_.Enqueue(3); - } - - // void TearDown() override {} - - Queue q0_; - Queue q1_; - Queue q2_; -}; -``` - -In this case, `TearDown()` is not needed since we don't have to clean up after -each test, other than what's already done by the destructor. - -Now we'll write tests using `TEST_F()` and this fixture. - -```c++ -TEST_F(QueueTest, IsEmptyInitially) { - EXPECT_EQ(q0_.size(), 0); -} - -TEST_F(QueueTest, DequeueWorks) { - int* n = q0_.Dequeue(); - EXPECT_EQ(n, nullptr); - - n = q1_.Dequeue(); - ASSERT_NE(n, nullptr); - EXPECT_EQ(*n, 1); - EXPECT_EQ(q1_.size(), 0); - delete n; - - n = q2_.Dequeue(); - ASSERT_NE(n, nullptr); - EXPECT_EQ(*n, 2); - EXPECT_EQ(q2_.size(), 1); - delete n; -} -``` - -The above uses both `ASSERT_*` and `EXPECT_*` assertions. The rule of thumb is -to use `EXPECT_*` when you want the test to continue to reveal more errors after -the assertion failure, and use `ASSERT_*` when continuing after failure doesn't -make sense. For example, the second assertion in the `Dequeue` test is -`ASSERT_NE(n, nullptr)`, as we need to dereference the pointer `n` later, which -would lead to a segfault when `n` is `NULL`. - -When these tests run, the following happens: - -1. googletest constructs a `QueueTest` object (let's call it `t1`). -2. `t1.SetUp()` initializes `t1`. -3. The first test (`IsEmptyInitially`) runs on `t1`. -4. `t1.TearDown()` cleans up after the test finishes. -5. `t1` is destructed. -6. The above steps are repeated on another `QueueTest` object, this time - running the `DequeueWorks` test. - -**Availability**: Linux, Windows, Mac. - -## Invoking the Tests - -`TEST()` and `TEST_F()` implicitly register their tests with googletest. So, -unlike with many other C++ testing frameworks, you don't have to re-list all -your defined tests in order to run them. - -After defining your tests, you can run them with `RUN_ALL_TESTS()`, which -returns `0` if all the tests are successful, or `1` otherwise. Note that -`RUN_ALL_TESTS()` runs *all tests* in your link unit--they can be from -different test suites, or even different source files. - -When invoked, the `RUN_ALL_TESTS()` macro: - -* Saves the state of all googletest flags. - -* Creates a test fixture object for the first test. - -* Initializes it via `SetUp()`. - -* Runs the test on the fixture object. - -* Cleans up the fixture via `TearDown()`. - -* Deletes the fixture. - -* Restores the state of all googletest flags. - -* Repeats the above steps for the next test, until all tests have run. - -If a fatal failure happens the subsequent steps will be skipped. - -{: .callout .important} -> IMPORTANT: You must **not** ignore the return value of `RUN_ALL_TESTS()`, or -> you will get a compiler error. The rationale for this design is that the -> automated testing service determines whether a test has passed based on its -> exit code, not on its stdout/stderr output; thus your `main()` function must -> return the value of `RUN_ALL_TESTS()`. -> -> Also, you should call `RUN_ALL_TESTS()` only **once**. Calling it more than -> once conflicts with some advanced googletest features (e.g., thread-safe -> [death tests](advanced.md#death-tests)) and thus is not supported. - -**Availability**: Linux, Windows, Mac. - -## Writing the main() Function - -Most users should _not_ need to write their own `main` function and instead link -with `gtest_main` (as opposed to with `gtest`), which defines a suitable entry -point. See the end of this section for details. The remainder of this section -should only apply when you need to do something custom before the tests run that -cannot be expressed within the framework of fixtures and test suites. - -If you write your own `main` function, it should return the value of -`RUN_ALL_TESTS()`. - -You can start from this boilerplate: - -```c++ -#include "this/package/foo.h" - -#include "gtest/gtest.h" - -namespace my { -namespace project { -namespace { - -// The fixture for testing class Foo. -class FooTest : public ::testing::Test { - protected: - // You can remove any or all of the following functions if their bodies would - // be empty. - - FooTest() { - // You can do set-up work for each test here. - } - - ~FooTest() override { - // You can do clean-up work that doesn't throw exceptions here. - } - - // If the constructor and destructor are not enough for setting up - // and cleaning up each test, you can define the following methods: - - void SetUp() override { - // Code here will be called immediately after the constructor (right - // before each test). - } - - void TearDown() override { - // Code here will be called immediately after each test (right - // before the destructor). - } - - // Class members declared here can be used by all tests in the test suite - // for Foo. -}; - -// Tests that the Foo::Bar() method does Abc. -TEST_F(FooTest, MethodBarDoesAbc) { - const std::string input_filepath = "this/package/testdata/myinputfile.dat"; - const std::string output_filepath = "this/package/testdata/myoutputfile.dat"; - Foo f; - EXPECT_EQ(f.Bar(input_filepath, output_filepath), 0); -} - -// Tests that Foo does Xyz. -TEST_F(FooTest, DoesXyz) { - // Exercises the Xyz feature of Foo. -} - -} // namespace -} // namespace project -} // namespace my - -int main(int argc, char **argv) { - ::testing::InitGoogleTest(&argc, argv); - return RUN_ALL_TESTS(); -} -``` - -The `::testing::InitGoogleTest()` function parses the command line for -googletest flags, and removes all recognized flags. This allows the user to -control a test program's behavior via various flags, which we'll cover in -the [AdvancedGuide](advanced.md). You **must** call this function before calling -`RUN_ALL_TESTS()`, or the flags won't be properly initialized. - -On Windows, `InitGoogleTest()` also works with wide strings, so it can be used -in programs compiled in `UNICODE` mode as well. - -But maybe you think that writing all those `main` functions is too much work? We -agree with you completely, and that's why Google Test provides a basic -implementation of main(). If it fits your needs, then just link your test with -the `gtest_main` library and you are good to go. - -{: .callout .note} -NOTE: `ParseGUnitFlags()` is deprecated in favor of `InitGoogleTest()`. - -## Known Limitations - -* Google Test is designed to be thread-safe. The implementation is thread-safe - on systems where the `pthreads` library is available. It is currently - _unsafe_ to use Google Test assertions from two threads concurrently on - other systems (e.g. Windows). In most tests this is not an issue as usually - the assertions are done in the main thread. If you want to help, you can - volunteer to implement the necessary synchronization primitives in - `gtest-port.h` for your platform. diff --git a/external/googletest/docs/quickstart-bazel.md b/external/googletest/docs/quickstart-bazel.md deleted file mode 100644 index 362ee6d050..0000000000 --- a/external/googletest/docs/quickstart-bazel.md +++ /dev/null @@ -1,161 +0,0 @@ -# Quickstart: Building with Bazel - -This tutorial aims to get you up and running with GoogleTest using the Bazel -build system. If you're using GoogleTest for the first time or need a refresher, -we recommend this tutorial as a starting point. - -## Prerequisites - -To complete this tutorial, you'll need: - -* A compatible operating system (e.g. Linux, macOS, Windows). -* A compatible C++ compiler that supports at least C++11. -* [Bazel](https://bazel.build/), the preferred build system used by the - GoogleTest team. - -See [Supported Platforms](platforms.md) for more information about platforms -compatible with GoogleTest. - -If you don't already have Bazel installed, see the -[Bazel installation guide](https://docs.bazel.build/versions/master/install.html). - -{: .callout .note} -Note: The terminal commands in this tutorial show a Unix shell prompt, but the -commands work on the Windows command line as well. - -## Set up a Bazel workspace - -A -[Bazel workspace](https://docs.bazel.build/versions/master/build-ref.html#workspace) -is a directory on your filesystem that you use to manage source files for the -software you want to build. Each workspace directory has a text file named -`WORKSPACE` which may be empty, or may contain references to external -dependencies required to build the outputs. - -First, create a directory for your workspace: - -``` -$ mkdir my_workspace && cd my_workspace -``` - -Next, you’ll create the `WORKSPACE` file to specify dependencies. A common and -recommended way to depend on GoogleTest is to use a -[Bazel external dependency](https://docs.bazel.build/versions/master/external.html) -via the -[`http_archive` rule](https://docs.bazel.build/versions/master/repo/http.html#http_archive). -To do this, in the root directory of your workspace (`my_workspace/`), create a -file named `WORKSPACE` with the following contents: - -``` -load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive") - -http_archive( - name = "com_google_googletest", - urls = ["https://github.com/google/googletest/archive/609281088cfefc76f9d0ce82e1ff6c30cc3591e5.zip"], - strip_prefix = "googletest-609281088cfefc76f9d0ce82e1ff6c30cc3591e5", -) -``` - -The above configuration declares a dependency on GoogleTest which is downloaded -as a ZIP archive from GitHub. In the above example, -`609281088cfefc76f9d0ce82e1ff6c30cc3591e5` is the Git commit hash of the -GoogleTest version to use; we recommend updating the hash often to point to the -latest version. - -Bazel also needs a dependency on the -[`rules_cc` repository](https://github.com/bazelbuild/rules_cc) to build C++ -code, so add the following to the `WORKSPACE` file: - -``` -http_archive( - name = "rules_cc", - urls = ["https://github.com/bazelbuild/rules_cc/archive/40548a2974f1aea06215272d9c2b47a14a24e556.zip"], - strip_prefix = "rules_cc-40548a2974f1aea06215272d9c2b47a14a24e556", -) -``` - -Now you're ready to build C++ code that uses GoogleTest. - -## Create and run a binary - -With your Bazel workspace set up, you can now use GoogleTest code within your -own project. - -As an example, create a file named `hello_test.cc` in your `my_workspace` -directory with the following contents: - -```cpp -#include - -// Demonstrate some basic assertions. -TEST(HelloTest, BasicAssertions) { - // Expect two strings not to be equal. - EXPECT_STRNE("hello", "world"); - // Expect equality. - EXPECT_EQ(7 * 6, 42); -} -``` - -GoogleTest provides [assertions](primer.md#assertions) that you use to test the -behavior of your code. The above sample includes the main GoogleTest header file -and demonstrates some basic assertions. - -To build the code, create a file named `BUILD` in the same directory with the -following contents: - -``` -load("@rules_cc//cc:defs.bzl", "cc_test") - -cc_test( - name = "hello_test", - size = "small", - srcs = ["hello_test.cc"], - deps = ["@com_google_googletest//:gtest_main"], -) -``` - -This `cc_test` rule declares the C++ test binary you want to build, and links to -GoogleTest (`//:gtest_main`) using the prefix you specified in the `WORKSPACE` -file (`@com_google_googletest`). For more information about Bazel `BUILD` files, -see the -[Bazel C++ Tutorial](https://docs.bazel.build/versions/master/tutorial/cpp.html). - -Now you can build and run your test: - -
    -my_workspace$ bazel test --test_output=all //:hello_test
-INFO: Analyzed target //:hello_test (26 packages loaded, 362 targets configured).
-INFO: Found 1 test target...
-INFO: From Testing //:hello_test:
-==================== Test output for //:hello_test:
-Running main() from gmock_main.cc
-[==========] Running 1 test from 1 test suite.
-[----------] Global test environment set-up.
-[----------] 1 test from HelloTest
-[ RUN      ] HelloTest.BasicAssertions
-[       OK ] HelloTest.BasicAssertions (0 ms)
-[----------] 1 test from HelloTest (0 ms total)
-
-[----------] Global test environment tear-down
-[==========] 1 test from 1 test suite ran. (0 ms total)
-[  PASSED  ] 1 test.
-================================================================================
-Target //:hello_test up-to-date:
-  bazel-bin/hello_test
-INFO: Elapsed time: 4.190s, Critical Path: 3.05s
-INFO: 27 processes: 8 internal, 19 linux-sandbox.
-INFO: Build completed successfully, 27 total actions
-//:hello_test                                                     PASSED in 0.1s
-
-INFO: Build completed successfully, 27 total actions
-
    - -Congratulations! You've successfully built and run a test binary using -GoogleTest. - -## Next steps - -* [Check out the Primer](primer.md) to start learning how to write simple - tests. -* [See the code samples](samples.md) for more examples showing how to use a - variety of GoogleTest features. diff --git a/external/googletest/docs/quickstart-cmake.md b/external/googletest/docs/quickstart-cmake.md deleted file mode 100644 index 420f1d3a3c..0000000000 --- a/external/googletest/docs/quickstart-cmake.md +++ /dev/null @@ -1,156 +0,0 @@ -# Quickstart: Building with CMake - -This tutorial aims to get you up and running with GoogleTest using CMake. If -you're using GoogleTest for the first time or need a refresher, we recommend -this tutorial as a starting point. If your project uses Bazel, see the -[Quickstart for Bazel](quickstart-bazel.md) instead. - -## Prerequisites - -To complete this tutorial, you'll need: - -* A compatible operating system (e.g. Linux, macOS, Windows). -* A compatible C++ compiler that supports at least C++11. -* [CMake](https://cmake.org/) and a compatible build tool for building the - project. - * Compatible build tools include - [Make](https://www.gnu.org/software/make/), - [Ninja](https://ninja-build.org/), and others - see - [CMake Generators](https://cmake.org/cmake/help/latest/manual/cmake-generators.7.html) - for more information. - -See [Supported Platforms](platforms.md) for more information about platforms -compatible with GoogleTest. - -If you don't already have CMake installed, see the -[CMake installation guide](https://cmake.org/install). - -{: .callout .note} -Note: The terminal commands in this tutorial show a Unix shell prompt, but the -commands work on the Windows command line as well. - -## Set up a project - -CMake uses a file named `CMakeLists.txt` to configure the build system for a -project. You'll use this file to set up your project and declare a dependency on -GoogleTest. - -First, create a directory for your project: - -``` -$ mkdir my_project && cd my_project -``` - -Next, you'll create the `CMakeLists.txt` file and declare a dependency on -GoogleTest. There are many ways to express dependencies in the CMake ecosystem; -in this quickstart, you'll use the -[`FetchContent` CMake module](https://cmake.org/cmake/help/latest/module/FetchContent.html). -To do this, in your project directory (`my_project`), create a file named -`CMakeLists.txt` with the following contents: - -```cmake -cmake_minimum_required(VERSION 3.14) -project(my_project) - -# GoogleTest requires at least C++11 -set(CMAKE_CXX_STANDARD 11) - -include(FetchContent) -FetchContent_Declare( - googletest - URL https://github.com/google/googletest/archive/609281088cfefc76f9d0ce82e1ff6c30cc3591e5.zip -) -# For Windows: Prevent overriding the parent project's compiler/linker settings -set(gtest_force_shared_crt ON CACHE BOOL "" FORCE) -FetchContent_MakeAvailable(googletest) -``` - -The above configuration declares a dependency on GoogleTest which is downloaded -from GitHub. In the above example, `609281088cfefc76f9d0ce82e1ff6c30cc3591e5` is -the Git commit hash of the GoogleTest version to use; we recommend updating the -hash often to point to the latest version. - -For more information about how to create `CMakeLists.txt` files, see the -[CMake Tutorial](https://cmake.org/cmake/help/latest/guide/tutorial/index.html). - -## Create and run a binary - -With GoogleTest declared as a dependency, you can use GoogleTest code within -your own project. - -As an example, create a file named `hello_test.cc` in your `my_project` -directory with the following contents: - -```cpp -#include - -// Demonstrate some basic assertions. -TEST(HelloTest, BasicAssertions) { - // Expect two strings not to be equal. - EXPECT_STRNE("hello", "world"); - // Expect equality. - EXPECT_EQ(7 * 6, 42); -} -``` - -GoogleTest provides [assertions](primer.md#assertions) that you use to test the -behavior of your code. The above sample includes the main GoogleTest header file -and demonstrates some basic assertions. - -To build the code, add the following to the end of your `CMakeLists.txt` file: - -```cmake -enable_testing() - -add_executable( - hello_test - hello_test.cc -) -target_link_libraries( - hello_test - gtest_main -) - -include(GoogleTest) -gtest_discover_tests(hello_test) -``` - -The above configuration enables testing in CMake, declares the C++ test binary -you want to build (`hello_test`), and links it to GoogleTest (`gtest_main`). The -last two lines enable CMake's test runner to discover the tests included in the -binary, using the -[`GoogleTest` CMake module](https://cmake.org/cmake/help/git-stage/module/GoogleTest.html). - -Now you can build and run your test: - -
    -my_project$ cmake -S . -B build
--- The C compiler identification is GNU 10.2.1
--- The CXX compiler identification is GNU 10.2.1
-...
--- Build files have been written to: .../my_project/build
-
-my_project$ cmake --build build
-Scanning dependencies of target gtest
-...
-[100%] Built target gmock_main
-
-my_project$ cd build && ctest
-Test project .../my_project/build
-    Start 1: HelloTest.BasicAssertions
-1/1 Test #1: HelloTest.BasicAssertions ........   Passed    0.00 sec
-
-100% tests passed, 0 tests failed out of 1
-
-Total Test time (real) =   0.01 sec
-
    - -Congratulations! You've successfully built and run a test binary using -GoogleTest. - -## Next steps - -* [Check out the Primer](primer.md) to start learning how to write simple - tests. -* [See the code samples](samples.md) for more examples showing how to use a - variety of GoogleTest features. diff --git a/external/googletest/docs/reference/actions.md b/external/googletest/docs/reference/actions.md deleted file mode 100644 index 166d2a897a..0000000000 --- a/external/googletest/docs/reference/actions.md +++ /dev/null @@ -1,115 +0,0 @@ -# Actions Reference - -[**Actions**](../gmock_for_dummies.md#actions-what-should-it-do) specify what a -mock function should do when invoked. This page lists the built-in actions -provided by GoogleTest. All actions are defined in the `::testing` namespace. - -## Returning a Value - -| | | -| :-------------------------------- | :-------------------------------------------- | -| `Return()` | Return from a `void` mock function. | -| `Return(value)` | Return `value`. If the type of `value` is different to the mock function's return type, `value` is converted to the latter type at the time the expectation is set, not when the action is executed. | -| `ReturnArg()` | Return the `N`-th (0-based) argument. | -| `ReturnNew(a1, ..., ak)` | Return `new T(a1, ..., ak)`; a different object is created each time. | -| `ReturnNull()` | Return a null pointer. | -| `ReturnPointee(ptr)` | Return the value pointed to by `ptr`. | -| `ReturnRef(variable)` | Return a reference to `variable`. | -| `ReturnRefOfCopy(value)` | Return a reference to a copy of `value`; the copy lives as long as the action. | -| `ReturnRoundRobin({a1, ..., ak})` | Each call will return the next `ai` in the list, starting at the beginning when the end of the list is reached. | - -## Side Effects - -| | | -| :--------------------------------- | :-------------------------------------- | -| `Assign(&variable, value)` | Assign `value` to variable. | -| `DeleteArg()` | Delete the `N`-th (0-based) argument, which must be a pointer. | -| `SaveArg(pointer)` | Save the `N`-th (0-based) argument to `*pointer`. | -| `SaveArgPointee(pointer)` | Save the value pointed to by the `N`-th (0-based) argument to `*pointer`. | -| `SetArgReferee(value)` | Assign `value` to the variable referenced by the `N`-th (0-based) argument. | -| `SetArgPointee(value)` | Assign `value` to the variable pointed by the `N`-th (0-based) argument. | -| `SetArgumentPointee(value)` | Same as `SetArgPointee(value)`. Deprecated. Will be removed in v1.7.0. | -| `SetArrayArgument(first, last)` | Copies the elements in source range [`first`, `last`) to the array pointed to by the `N`-th (0-based) argument, which can be either a pointer or an iterator. The action does not take ownership of the elements in the source range. | -| `SetErrnoAndReturn(error, value)` | Set `errno` to `error` and return `value`. | -| `Throw(exception)` | Throws the given exception, which can be any copyable value. Available since v1.1.0. | - -## Using a Function, Functor, or Lambda as an Action - -In the following, by "callable" we mean a free function, `std::function`, -functor, or lambda. - -| | | -| :---------------------------------- | :------------------------------------- | -| `f` | Invoke f with the arguments passed to the mock function, where f is a callable. | -| `Invoke(f)` | Invoke `f` with the arguments passed to the mock function, where `f` can be a global/static function or a functor. | -| `Invoke(object_pointer, &class::method)` | Invoke the method on the object with the arguments passed to the mock function. | -| `InvokeWithoutArgs(f)` | Invoke `f`, which can be a global/static function or a functor. `f` must take no arguments. | -| `InvokeWithoutArgs(object_pointer, &class::method)` | Invoke the method on the object, which takes no arguments. | -| `InvokeArgument(arg1, arg2, ..., argk)` | Invoke the mock function's `N`-th (0-based) argument, which must be a function or a functor, with the `k` arguments. | - -The return value of the invoked function is used as the return value of the -action. - -When defining a callable to be used with `Invoke*()`, you can declare any unused -parameters as `Unused`: - -```cpp -using ::testing::Invoke; -double Distance(Unused, double x, double y) { return sqrt(x*x + y*y); } -... -EXPECT_CALL(mock, Foo("Hi", _, _)).WillOnce(Invoke(Distance)); -``` - -`Invoke(callback)` and `InvokeWithoutArgs(callback)` take ownership of -`callback`, which must be permanent. The type of `callback` must be a base -callback type instead of a derived one, e.g. - -```cpp - BlockingClosure* done = new BlockingClosure; - ... Invoke(done) ...; // This won't compile! - - Closure* done2 = new BlockingClosure; - ... Invoke(done2) ...; // This works. -``` - -In `InvokeArgument(...)`, if an argument needs to be passed by reference, -wrap it inside `std::ref()`. For example, - -```cpp -using ::testing::InvokeArgument; -... -InvokeArgument<2>(5, string("Hi"), std::ref(foo)) -``` - -calls the mock function's #2 argument, passing to it `5` and `string("Hi")` by -value, and `foo` by reference. - -## Default Action - -| Matcher | Description | -| :------------ | :----------------------------------------------------- | -| `DoDefault()` | Do the default action (specified by `ON_CALL()` or the built-in one). | - -{: .callout .note} -**Note:** due to technical reasons, `DoDefault()` cannot be used inside a -composite action - trying to do so will result in a run-time error. - -## Composite Actions - -| | | -| :----------------------------- | :------------------------------------------ | -| `DoAll(a1, a2, ..., an)` | Do all actions `a1` to `an` and return the result of `an` in each invocation. The first `n - 1` sub-actions must return void and will receive a readonly view of the arguments. | -| `IgnoreResult(a)` | Perform action `a` and ignore its result. `a` must not return void. | -| `WithArg(a)` | Pass the `N`-th (0-based) argument of the mock function to action `a` and perform it. | -| `WithArgs(a)` | Pass the selected (0-based) arguments of the mock function to action `a` and perform it. | -| `WithoutArgs(a)` | Perform action `a` without any arguments. | - -## Defining Actions - -| | | -| :--------------------------------- | :-------------------------------------- | -| `ACTION(Sum) { return arg0 + arg1; }` | Defines an action `Sum()` to return the sum of the mock function's argument #0 and #1. | -| `ACTION_P(Plus, n) { return arg0 + n; }` | Defines an action `Plus(n)` to return the sum of the mock function's argument #0 and `n`. | -| `ACTION_Pk(Foo, p1, ..., pk) { statements; }` | Defines a parameterized action `Foo(p1, ..., pk)` to execute the given `statements`. | - -The `ACTION*` macros cannot be used inside a function or class. diff --git a/external/googletest/docs/reference/assertions.md b/external/googletest/docs/reference/assertions.md deleted file mode 100644 index 7bf03a3dde..0000000000 --- a/external/googletest/docs/reference/assertions.md +++ /dev/null @@ -1,633 +0,0 @@ -# Assertions Reference - -This page lists the assertion macros provided by GoogleTest for verifying code -behavior. To use them, include the header `gtest/gtest.h`. - -The majority of the macros listed below come as a pair with an `EXPECT_` variant -and an `ASSERT_` variant. Upon failure, `EXPECT_` macros generate nonfatal -failures and allow the current function to continue running, while `ASSERT_` -macros generate fatal failures and abort the current function. - -All assertion macros support streaming a custom failure message into them with -the `<<` operator, for example: - -```cpp -EXPECT_TRUE(my_condition) << "My condition is not true"; -``` - -Anything that can be streamed to an `ostream` can be streamed to an assertion -macro—in particular, C strings and string objects. If a wide string (`wchar_t*`, -`TCHAR*` in `UNICODE` mode on Windows, or `std::wstring`) is streamed to an -assertion, it will be translated to UTF-8 when printed. - -## Explicit Success and Failure {#success-failure} - -The assertions in this section generate a success or failure directly instead of -testing a value or expression. These are useful when control flow, rather than a -Boolean expression, determines the test's success or failure, as shown by the -following example: - -```c++ -switch(expression) { - case 1: - ... some checks ... - case 2: - ... some other checks ... - default: - FAIL() << "We shouldn't get here."; -} -``` - -### SUCCEED {#SUCCEED} - -`SUCCEED()` - -Generates a success. This *does not* make the overall test succeed. A test is -considered successful only if none of its assertions fail during its execution. - -The `SUCCEED` assertion is purely documentary and currently doesn't generate any -user-visible output. However, we may add `SUCCEED` messages to GoogleTest output -in the future. - -### FAIL {#FAIL} - -`FAIL()` - -Generates a fatal failure, which returns from the current function. - -Can only be used in functions that return `void`. See -[Assertion Placement](../advanced.md#assertion-placement) for more information. - -### ADD_FAILURE {#ADD_FAILURE} - -`ADD_FAILURE()` - -Generates a nonfatal failure, which allows the current function to continue -running. - -### ADD_FAILURE_AT {#ADD_FAILURE_AT} - -`ADD_FAILURE_AT(`*`file_path`*`,`*`line_number`*`)` - -Generates a nonfatal failure at the file and line number specified. - -## Generalized Assertion {#generalized} - -The following assertion allows [matchers](matchers.md) to be used to verify -values. - -### EXPECT_THAT {#EXPECT_THAT} - -`EXPECT_THAT(`*`value`*`,`*`matcher`*`)` \ -`ASSERT_THAT(`*`value`*`,`*`matcher`*`)` - -Verifies that *`value`* matches the [matcher](matchers.md) *`matcher`*. - -For example, the following code verifies that the string `value1` starts with -`"Hello"`, `value2` matches a regular expression, and `value3` is between 5 and -10: - -```cpp -#include "gmock/gmock.h" - -using ::testing::AllOf; -using ::testing::Gt; -using ::testing::Lt; -using ::testing::MatchesRegex; -using ::testing::StartsWith; - -... -EXPECT_THAT(value1, StartsWith("Hello")); -EXPECT_THAT(value2, MatchesRegex("Line \\d+")); -ASSERT_THAT(value3, AllOf(Gt(5), Lt(10))); -``` - -Matchers enable assertions of this form to read like English and generate -informative failure messages. For example, if the above assertion on `value1` -fails, the resulting message will be similar to the following: - -``` -Value of: value1 - Actual: "Hi, world!" -Expected: starts with "Hello" -``` - -GoogleTest provides a built-in library of matchers—see the -[Matchers Reference](matchers.md). It is also possible to write your own -matchers—see [Writing New Matchers Quickly](../gmock_cook_book.md#NewMatchers). -The use of matchers makes `EXPECT_THAT` a powerful, extensible assertion. - -*The idea for this assertion was borrowed from Joe Walnes' Hamcrest project, -which adds `assertThat()` to JUnit.* - -## Boolean Conditions {#boolean} - -The following assertions test Boolean conditions. - -### EXPECT_TRUE {#EXPECT_TRUE} - -`EXPECT_TRUE(`*`condition`*`)` \ -`ASSERT_TRUE(`*`condition`*`)` - -Verifies that *`condition`* is true. - -### EXPECT_FALSE {#EXPECT_FALSE} - -`EXPECT_FALSE(`*`condition`*`)` \ -`ASSERT_FALSE(`*`condition`*`)` - -Verifies that *`condition`* is false. - -## Binary Comparison {#binary-comparison} - -The following assertions compare two values. The value arguments must be -comparable by the assertion's comparison operator, otherwise a compiler error -will result. - -If an argument supports the `<<` operator, it will be called to print the -argument when the assertion fails. Otherwise, GoogleTest will attempt to print -them in the best way it can—see -[Teaching GoogleTest How to Print Your Values](../advanced.md#teaching-googletest-how-to-print-your-values). - -Arguments are always evaluated exactly once, so it's OK for the arguments to -have side effects. However, the argument evaluation order is undefined and -programs should not depend on any particular argument evaluation order. - -These assertions work with both narrow and wide string objects (`string` and -`wstring`). - -See also the [Floating-Point Comparison](#floating-point) assertions to compare -floating-point numbers and avoid problems caused by rounding. - -### EXPECT_EQ {#EXPECT_EQ} - -`EXPECT_EQ(`*`val1`*`,`*`val2`*`)` \ -`ASSERT_EQ(`*`val1`*`,`*`val2`*`)` - -Verifies that *`val1`*`==`*`val2`*. - -Does pointer equality on pointers. If used on two C strings, it tests if they -are in the same memory location, not if they have the same value. Use -[`EXPECT_STREQ`](#EXPECT_STREQ) to compare C strings (e.g. `const char*`) by -value. - -When comparing a pointer to `NULL`, use `EXPECT_EQ(`*`ptr`*`, nullptr)` instead -of `EXPECT_EQ(`*`ptr`*`, NULL)`. - -### EXPECT_NE {#EXPECT_NE} - -`EXPECT_NE(`*`val1`*`,`*`val2`*`)` \ -`ASSERT_NE(`*`val1`*`,`*`val2`*`)` - -Verifies that *`val1`*`!=`*`val2`*. - -Does pointer equality on pointers. If used on two C strings, it tests if they -are in different memory locations, not if they have different values. Use -[`EXPECT_STRNE`](#EXPECT_STRNE) to compare C strings (e.g. `const char*`) by -value. - -When comparing a pointer to `NULL`, use `EXPECT_NE(`*`ptr`*`, nullptr)` instead -of `EXPECT_NE(`*`ptr`*`, NULL)`. - -### EXPECT_LT {#EXPECT_LT} - -`EXPECT_LT(`*`val1`*`,`*`val2`*`)` \ -`ASSERT_LT(`*`val1`*`,`*`val2`*`)` - -Verifies that *`val1`*`<`*`val2`*. - -### EXPECT_LE {#EXPECT_LE} - -`EXPECT_LE(`*`val1`*`,`*`val2`*`)` \ -`ASSERT_LE(`*`val1`*`,`*`val2`*`)` - -Verifies that *`val1`*`<=`*`val2`*. - -### EXPECT_GT {#EXPECT_GT} - -`EXPECT_GT(`*`val1`*`,`*`val2`*`)` \ -`ASSERT_GT(`*`val1`*`,`*`val2`*`)` - -Verifies that *`val1`*`>`*`val2`*. - -### EXPECT_GE {#EXPECT_GE} - -`EXPECT_GE(`*`val1`*`,`*`val2`*`)` \ -`ASSERT_GE(`*`val1`*`,`*`val2`*`)` - -Verifies that *`val1`*`>=`*`val2`*. - -## String Comparison {#c-strings} - -The following assertions compare two **C strings**. To compare two `string` -objects, use [`EXPECT_EQ`](#EXPECT_EQ) or [`EXPECT_NE`](#EXPECT_NE) instead. - -These assertions also accept wide C strings (`wchar_t*`). If a comparison of two -wide strings fails, their values will be printed as UTF-8 narrow strings. - -To compare a C string with `NULL`, use `EXPECT_EQ(`*`c_string`*`, nullptr)` or -`EXPECT_NE(`*`c_string`*`, nullptr)`. - -### EXPECT_STREQ {#EXPECT_STREQ} - -`EXPECT_STREQ(`*`str1`*`,`*`str2`*`)` \ -`ASSERT_STREQ(`*`str1`*`,`*`str2`*`)` - -Verifies that the two C strings *`str1`* and *`str2`* have the same contents. - -### EXPECT_STRNE {#EXPECT_STRNE} - -`EXPECT_STRNE(`*`str1`*`,`*`str2`*`)` \ -`ASSERT_STRNE(`*`str1`*`,`*`str2`*`)` - -Verifies that the two C strings *`str1`* and *`str2`* have different contents. - -### EXPECT_STRCASEEQ {#EXPECT_STRCASEEQ} - -`EXPECT_STRCASEEQ(`*`str1`*`,`*`str2`*`)` \ -`ASSERT_STRCASEEQ(`*`str1`*`,`*`str2`*`)` - -Verifies that the two C strings *`str1`* and *`str2`* have the same contents, -ignoring case. - -### EXPECT_STRCASENE {#EXPECT_STRCASENE} - -`EXPECT_STRCASENE(`*`str1`*`,`*`str2`*`)` \ -`ASSERT_STRCASENE(`*`str1`*`,`*`str2`*`)` - -Verifies that the two C strings *`str1`* and *`str2`* have different contents, -ignoring case. - -## Floating-Point Comparison {#floating-point} - -The following assertions compare two floating-point values. - -Due to rounding errors, it is very unlikely that two floating-point values will -match exactly, so `EXPECT_EQ` is not suitable. In general, for floating-point -comparison to make sense, the user needs to carefully choose the error bound. - -GoogleTest also provides assertions that use a default error bound based on -Units in the Last Place (ULPs). To learn more about ULPs, see the article -[Comparing Floating Point Numbers](https://randomascii.wordpress.com/2012/02/25/comparing-floating-point-numbers-2012-edition/). - -### EXPECT_FLOAT_EQ {#EXPECT_FLOAT_EQ} - -`EXPECT_FLOAT_EQ(`*`val1`*`,`*`val2`*`)` \ -`ASSERT_FLOAT_EQ(`*`val1`*`,`*`val2`*`)` - -Verifies that the two `float` values *`val1`* and *`val2`* are approximately -equal, to within 4 ULPs from each other. - -### EXPECT_DOUBLE_EQ {#EXPECT_DOUBLE_EQ} - -`EXPECT_DOUBLE_EQ(`*`val1`*`,`*`val2`*`)` \ -`ASSERT_DOUBLE_EQ(`*`val1`*`,`*`val2`*`)` - -Verifies that the two `double` values *`val1`* and *`val2`* are approximately -equal, to within 4 ULPs from each other. - -### EXPECT_NEAR {#EXPECT_NEAR} - -`EXPECT_NEAR(`*`val1`*`,`*`val2`*`,`*`abs_error`*`)` \ -`ASSERT_NEAR(`*`val1`*`,`*`val2`*`,`*`abs_error`*`)` - -Verifies that the difference between *`val1`* and *`val2`* does not exceed the -absolute error bound *`abs_error`*. - -## Exception Assertions {#exceptions} - -The following assertions verify that a piece of code throws, or does not throw, -an exception. Usage requires exceptions to be enabled in the build environment. - -Note that the piece of code under test can be a compound statement, for example: - -```cpp -EXPECT_NO_THROW({ - int n = 5; - DoSomething(&n); -}); -``` - -### EXPECT_THROW {#EXPECT_THROW} - -`EXPECT_THROW(`*`statement`*`,`*`exception_type`*`)` \ -`ASSERT_THROW(`*`statement`*`,`*`exception_type`*`)` - -Verifies that *`statement`* throws an exception of type *`exception_type`*. - -### EXPECT_ANY_THROW {#EXPECT_ANY_THROW} - -`EXPECT_ANY_THROW(`*`statement`*`)` \ -`ASSERT_ANY_THROW(`*`statement`*`)` - -Verifies that *`statement`* throws an exception of any type. - -### EXPECT_NO_THROW {#EXPECT_NO_THROW} - -`EXPECT_NO_THROW(`*`statement`*`)` \ -`ASSERT_NO_THROW(`*`statement`*`)` - -Verifies that *`statement`* does not throw any exception. - -## Predicate Assertions {#predicates} - -The following assertions enable more complex predicates to be verified while -printing a more clear failure message than if `EXPECT_TRUE` were used alone. - -### EXPECT_PRED* {#EXPECT_PRED} - -`EXPECT_PRED1(`*`pred`*`,`*`val1`*`)` \ -`EXPECT_PRED2(`*`pred`*`,`*`val1`*`,`*`val2`*`)` \ -`EXPECT_PRED3(`*`pred`*`,`*`val1`*`,`*`val2`*`,`*`val3`*`)` \ -`EXPECT_PRED4(`*`pred`*`,`*`val1`*`,`*`val2`*`,`*`val3`*`,`*`val4`*`)` \ -`EXPECT_PRED5(`*`pred`*`,`*`val1`*`,`*`val2`*`,`*`val3`*`,`*`val4`*`,`*`val5`*`)` - -`ASSERT_PRED1(`*`pred`*`,`*`val1`*`)` \ -`ASSERT_PRED2(`*`pred`*`,`*`val1`*`,`*`val2`*`)` \ -`ASSERT_PRED3(`*`pred`*`,`*`val1`*`,`*`val2`*`,`*`val3`*`)` \ -`ASSERT_PRED4(`*`pred`*`,`*`val1`*`,`*`val2`*`,`*`val3`*`,`*`val4`*`)` \ -`ASSERT_PRED5(`*`pred`*`,`*`val1`*`,`*`val2`*`,`*`val3`*`,`*`val4`*`,`*`val5`*`)` - -Verifies that the predicate *`pred`* returns `true` when passed the given values -as arguments. - -The parameter *`pred`* is a function or functor that accepts as many arguments -as the corresponding macro accepts values. If *`pred`* returns `true` for the -given arguments, the assertion succeeds, otherwise the assertion fails. - -When the assertion fails, it prints the value of each argument. Arguments are -always evaluated exactly once. - -As an example, see the following code: - -```cpp -// Returns true if m and n have no common divisors except 1. -bool MutuallyPrime(int m, int n) { ... } -... -const int a = 3; -const int b = 4; -const int c = 10; -... -EXPECT_PRED2(MutuallyPrime, a, b); // Succeeds -EXPECT_PRED2(MutuallyPrime, b, c); // Fails -``` - -In the above example, the first assertion succeeds, and the second fails with -the following message: - -``` -MutuallyPrime(b, c) is false, where -b is 4 -c is 10 -``` - -Note that if the given predicate is an overloaded function or a function -template, the assertion macro might not be able to determine which version to -use, and it might be necessary to explicitly specify the type of the function. -For example, for a Boolean function `IsPositive()` overloaded to take either a -single `int` or `double` argument, it would be necessary to write one of the -following: - -```cpp -EXPECT_PRED1(static_cast(IsPositive), 5); -EXPECT_PRED1(static_cast(IsPositive), 3.14); -``` - -Writing simply `EXPECT_PRED1(IsPositive, 5);` would result in a compiler error. -Similarly, to use a template function, specify the template arguments: - -```cpp -template -bool IsNegative(T x) { - return x < 0; -} -... -EXPECT_PRED1(IsNegative, -5); // Must specify type for IsNegative -``` - -If a template has multiple parameters, wrap the predicate in parentheses so the -macro arguments are parsed correctly: - -```cpp -ASSERT_PRED2((MyPredicate), 5, 0); -``` - -### EXPECT_PRED_FORMAT* {#EXPECT_PRED_FORMAT} - -`EXPECT_PRED_FORMAT1(`*`pred_formatter`*`,`*`val1`*`)` \ -`EXPECT_PRED_FORMAT2(`*`pred_formatter`*`,`*`val1`*`,`*`val2`*`)` \ -`EXPECT_PRED_FORMAT3(`*`pred_formatter`*`,`*`val1`*`,`*`val2`*`,`*`val3`*`)` \ -`EXPECT_PRED_FORMAT4(`*`pred_formatter`*`,`*`val1`*`,`*`val2`*`,`*`val3`*`,`*`val4`*`)` -\ -`EXPECT_PRED_FORMAT5(`*`pred_formatter`*`,`*`val1`*`,`*`val2`*`,`*`val3`*`,`*`val4`*`,`*`val5`*`)` - -`ASSERT_PRED_FORMAT1(`*`pred_formatter`*`,`*`val1`*`)` \ -`ASSERT_PRED_FORMAT2(`*`pred_formatter`*`,`*`val1`*`,`*`val2`*`)` \ -`ASSERT_PRED_FORMAT3(`*`pred_formatter`*`,`*`val1`*`,`*`val2`*`,`*`val3`*`)` \ -`ASSERT_PRED_FORMAT4(`*`pred_formatter`*`,`*`val1`*`,`*`val2`*`,`*`val3`*`,`*`val4`*`)` -\ -`ASSERT_PRED_FORMAT5(`*`pred_formatter`*`,`*`val1`*`,`*`val2`*`,`*`val3`*`,`*`val4`*`,`*`val5`*`)` - -Verifies that the predicate *`pred_formatter`* succeeds when passed the given -values as arguments. - -The parameter *`pred_formatter`* is a *predicate-formatter*, which is a function -or functor with the signature: - -```cpp -testing::AssertionResult PredicateFormatter(const char* expr1, - const char* expr2, - ... - const char* exprn, - T1 val1, - T2 val2, - ... - Tn valn); -``` - -where *`val1`*, *`val2`*, ..., *`valn`* are the values of the predicate -arguments, and *`expr1`*, *`expr2`*, ..., *`exprn`* are the corresponding -expressions as they appear in the source code. The types `T1`, `T2`, ..., `Tn` -can be either value types or reference types; if an argument has type `T`, it -can be declared as either `T` or `const T&`, whichever is appropriate. For more -about the return type `testing::AssertionResult`, see -[Using a Function That Returns an AssertionResult](../advanced.md#using-a-function-that-returns-an-assertionresult). - -As an example, see the following code: - -```cpp -// Returns the smallest prime common divisor of m and n, -// or 1 when m and n are mutually prime. -int SmallestPrimeCommonDivisor(int m, int n) { ... } - -// Returns true if m and n have no common divisors except 1. -bool MutuallyPrime(int m, int n) { ... } - -// A predicate-formatter for asserting that two integers are mutually prime. -testing::AssertionResult AssertMutuallyPrime(const char* m_expr, - const char* n_expr, - int m, - int n) { - if (MutuallyPrime(m, n)) return testing::AssertionSuccess(); - - return testing::AssertionFailure() << m_expr << " and " << n_expr - << " (" << m << " and " << n << ") are not mutually prime, " - << "as they have a common divisor " << SmallestPrimeCommonDivisor(m, n); -} - -... -const int a = 3; -const int b = 4; -const int c = 10; -... -EXPECT_PRED_FORMAT2(AssertMutuallyPrime, a, b); // Succeeds -EXPECT_PRED_FORMAT2(AssertMutuallyPrime, b, c); // Fails -``` - -In the above example, the final assertion fails and the predicate-formatter -produces the following failure message: - -``` -b and c (4 and 10) are not mutually prime, as they have a common divisor 2 -``` - -## Windows HRESULT Assertions {#HRESULT} - -The following assertions test for `HRESULT` success or failure. For example: - -```cpp -CComPtr shell; -ASSERT_HRESULT_SUCCEEDED(shell.CoCreateInstance(L"Shell.Application")); -CComVariant empty; -ASSERT_HRESULT_SUCCEEDED(shell->ShellExecute(CComBSTR(url), empty, empty, empty, empty)); -``` - -The generated output contains the human-readable error message associated with -the returned `HRESULT` code. - -### EXPECT_HRESULT_SUCCEEDED {#EXPECT_HRESULT_SUCCEEDED} - -`EXPECT_HRESULT_SUCCEEDED(`*`expression`*`)` \ -`ASSERT_HRESULT_SUCCEEDED(`*`expression`*`)` - -Verifies that *`expression`* is a success `HRESULT`. - -### EXPECT_HRESULT_FAILED {#EXPECT_HRESULT_FAILED} - -`EXPECT_HRESULT_FAILED(`*`expression`*`)` \ -`EXPECT_HRESULT_FAILED(`*`expression`*`)` - -Verifies that *`expression`* is a failure `HRESULT`. - -## Death Assertions {#death} - -The following assertions verify that a piece of code causes the process to -terminate. For context, see [Death Tests](../advanced.md#death-tests). - -These assertions spawn a new process and execute the code under test in that -process. How that happens depends on the platform and the variable -`::testing::GTEST_FLAG(death_test_style)`, which is initialized from the -command-line flag `--gtest_death_test_style`. - -* On POSIX systems, `fork()` (or `clone()` on Linux) is used to spawn the - child, after which: - * If the variable's value is `"fast"`, the death test statement is - immediately executed. - * If the variable's value is `"threadsafe"`, the child process re-executes - the unit test binary just as it was originally invoked, but with some - extra flags to cause just the single death test under consideration to - be run. -* On Windows, the child is spawned using the `CreateProcess()` API, and - re-executes the binary to cause just the single death test under - consideration to be run - much like the `"threadsafe"` mode on POSIX. - -Other values for the variable are illegal and will cause the death test to fail. -Currently, the flag's default value is -**`"fast"`**. - -If the death test statement runs to completion without dying, the child process -will nonetheless terminate, and the assertion fails. - -Note that the piece of code under test can be a compound statement, for example: - -```cpp -EXPECT_DEATH({ - int n = 5; - DoSomething(&n); -}, "Error on line .* of DoSomething()"); -``` - -### EXPECT_DEATH {#EXPECT_DEATH} - -`EXPECT_DEATH(`*`statement`*`,`*`matcher`*`)` \ -`ASSERT_DEATH(`*`statement`*`,`*`matcher`*`)` - -Verifies that *`statement`* causes the process to terminate with a nonzero exit -status and produces `stderr` output that matches *`matcher`*. - -The parameter *`matcher`* is either a [matcher](matchers.md) for a `const -std::string&`, or a regular expression (see -[Regular Expression Syntax](../advanced.md#regular-expression-syntax))—a bare -string *`s`* (with no matcher) is treated as -[`ContainsRegex(s)`](matchers.md#string-matchers), **not** -[`Eq(s)`](matchers.md#generic-comparison). - -For example, the following code verifies that calling `DoSomething(42)` causes -the process to die with an error message that contains the text `My error`: - -```cpp -EXPECT_DEATH(DoSomething(42), "My error"); -``` - -### EXPECT_DEATH_IF_SUPPORTED {#EXPECT_DEATH_IF_SUPPORTED} - -`EXPECT_DEATH_IF_SUPPORTED(`*`statement`*`,`*`matcher`*`)` \ -`ASSERT_DEATH_IF_SUPPORTED(`*`statement`*`,`*`matcher`*`)` - -If death tests are supported, behaves the same as -[`EXPECT_DEATH`](#EXPECT_DEATH). Otherwise, verifies nothing. - -### EXPECT_DEBUG_DEATH {#EXPECT_DEBUG_DEATH} - -`EXPECT_DEBUG_DEATH(`*`statement`*`,`*`matcher`*`)` \ -`ASSERT_DEBUG_DEATH(`*`statement`*`,`*`matcher`*`)` - -In debug mode, behaves the same as [`EXPECT_DEATH`](#EXPECT_DEATH). When not in -debug mode (i.e. `NDEBUG` is defined), just executes *`statement`*. - -### EXPECT_EXIT {#EXPECT_EXIT} - -`EXPECT_EXIT(`*`statement`*`,`*`predicate`*`,`*`matcher`*`)` \ -`ASSERT_EXIT(`*`statement`*`,`*`predicate`*`,`*`matcher`*`)` - -Verifies that *`statement`* causes the process to terminate with an exit status -that satisfies *`predicate`*, and produces `stderr` output that matches -*`matcher`*. - -The parameter *`predicate`* is a function or functor that accepts an `int` exit -status and returns a `bool`. GoogleTest provides two predicates to handle common -cases: - -```cpp -// Returns true if the program exited normally with the given exit status code. -::testing::ExitedWithCode(exit_code); - -// Returns true if the program was killed by the given signal. -// Not available on Windows. -::testing::KilledBySignal(signal_number); -``` - -The parameter *`matcher`* is either a [matcher](matchers.md) for a `const -std::string&`, or a regular expression (see -[Regular Expression Syntax](../advanced.md#regular-expression-syntax))—a bare -string *`s`* (with no matcher) is treated as -[`ContainsRegex(s)`](matchers.md#string-matchers), **not** -[`Eq(s)`](matchers.md#generic-comparison). - -For example, the following code verifies that calling `NormalExit()` causes the -process to print a message containing the text `Success` to `stderr` and exit -with exit status code 0: - -```cpp -EXPECT_EXIT(NormalExit(), testing::ExitedWithCode(0), "Success"); -``` diff --git a/external/googletest/docs/reference/matchers.md b/external/googletest/docs/reference/matchers.md deleted file mode 100644 index 9e40cab704..0000000000 --- a/external/googletest/docs/reference/matchers.md +++ /dev/null @@ -1,283 +0,0 @@ -# Matchers Reference - -A **matcher** matches a *single* argument. You can use it inside `ON_CALL()` or -`EXPECT_CALL()`, or use it to validate a value directly using two macros: - -| Macro | Description | -| :----------------------------------- | :------------------------------------ | -| `EXPECT_THAT(actual_value, matcher)` | Asserts that `actual_value` matches `matcher`. | -| `ASSERT_THAT(actual_value, matcher)` | The same as `EXPECT_THAT(actual_value, matcher)`, except that it generates a **fatal** failure. | - -{: .callout .note} -**Note:** Although equality matching via `EXPECT_THAT(actual_value, -expected_value)` is supported, prefer to make the comparison explicit via -`EXPECT_THAT(actual_value, Eq(expected_value))` or `EXPECT_EQ(actual_value, -expected_value)`. - -Built-in matchers (where `argument` is the function argument, e.g. -`actual_value` in the example above, or when used in the context of -`EXPECT_CALL(mock_object, method(matchers))`, the arguments of `method`) are -divided into several categories. All matchers are defined in the `::testing` -namespace unless otherwise noted. - -## Wildcard - -Matcher | Description -:-------------------------- | :----------------------------------------------- -`_` | `argument` can be any value of the correct type. -`A()` or `An()` | `argument` can be any value of type `type`. - -## Generic Comparison - -| Matcher | Description | -| :--------------------- | :-------------------------------------------------- | -| `Eq(value)` or `value` | `argument == value` | -| `Ge(value)` | `argument >= value` | -| `Gt(value)` | `argument > value` | -| `Le(value)` | `argument <= value` | -| `Lt(value)` | `argument < value` | -| `Ne(value)` | `argument != value` | -| `IsFalse()` | `argument` evaluates to `false` in a Boolean context. | -| `IsTrue()` | `argument` evaluates to `true` in a Boolean context. | -| `IsNull()` | `argument` is a `NULL` pointer (raw or smart). | -| `NotNull()` | `argument` is a non-null pointer (raw or smart). | -| `Optional(m)` | `argument` is `optional<>` that contains a value matching `m`. (For testing whether an `optional<>` is set, check for equality with `nullopt`. You may need to use `Eq(nullopt)` if the inner type doesn't have `==`.)| -| `VariantWith(m)` | `argument` is `variant<>` that holds the alternative of type T with a value matching `m`. | -| `Ref(variable)` | `argument` is a reference to `variable`. | -| `TypedEq(value)` | `argument` has type `type` and is equal to `value`. You may need to use this instead of `Eq(value)` when the mock function is overloaded. | - -Except `Ref()`, these matchers make a *copy* of `value` in case it's modified or -destructed later. If the compiler complains that `value` doesn't have a public -copy constructor, try wrap it in `std::ref()`, e.g. -`Eq(std::ref(non_copyable_value))`. If you do that, make sure -`non_copyable_value` is not changed afterwards, or the meaning of your matcher -will be changed. - -`IsTrue` and `IsFalse` are useful when you need to use a matcher, or for types -that can be explicitly converted to Boolean, but are not implicitly converted to -Boolean. In other cases, you can use the basic -[`EXPECT_TRUE` and `EXPECT_FALSE`](assertions.md#boolean) assertions. - -## Floating-Point Matchers {#FpMatchers} - -| Matcher | Description | -| :------------------------------- | :--------------------------------- | -| `DoubleEq(a_double)` | `argument` is a `double` value approximately equal to `a_double`, treating two NaNs as unequal. | -| `FloatEq(a_float)` | `argument` is a `float` value approximately equal to `a_float`, treating two NaNs as unequal. | -| `NanSensitiveDoubleEq(a_double)` | `argument` is a `double` value approximately equal to `a_double`, treating two NaNs as equal. | -| `NanSensitiveFloatEq(a_float)` | `argument` is a `float` value approximately equal to `a_float`, treating two NaNs as equal. | -| `IsNan()` | `argument` is any floating-point type with a NaN value. | - -The above matchers use ULP-based comparison (the same as used in googletest). -They automatically pick a reasonable error bound based on the absolute value of -the expected value. `DoubleEq()` and `FloatEq()` conform to the IEEE standard, -which requires comparing two NaNs for equality to return false. The -`NanSensitive*` version instead treats two NaNs as equal, which is often what a -user wants. - -| Matcher | Description | -| :------------------------------------------------ | :----------------------- | -| `DoubleNear(a_double, max_abs_error)` | `argument` is a `double` value close to `a_double` (absolute error <= `max_abs_error`), treating two NaNs as unequal. | -| `FloatNear(a_float, max_abs_error)` | `argument` is a `float` value close to `a_float` (absolute error <= `max_abs_error`), treating two NaNs as unequal. | -| `NanSensitiveDoubleNear(a_double, max_abs_error)` | `argument` is a `double` value close to `a_double` (absolute error <= `max_abs_error`), treating two NaNs as equal. | -| `NanSensitiveFloatNear(a_float, max_abs_error)` | `argument` is a `float` value close to `a_float` (absolute error <= `max_abs_error`), treating two NaNs as equal. | - -## String Matchers - -The `argument` can be either a C string or a C++ string object: - -| Matcher | Description | -| :---------------------- | :------------------------------------------------- | -| `ContainsRegex(string)` | `argument` matches the given regular expression. | -| `EndsWith(suffix)` | `argument` ends with string `suffix`. | -| `HasSubstr(string)` | `argument` contains `string` as a sub-string. | -| `IsEmpty()` | `argument` is an empty string. | -| `MatchesRegex(string)` | `argument` matches the given regular expression with the match starting at the first character and ending at the last character. | -| `StartsWith(prefix)` | `argument` starts with string `prefix`. | -| `StrCaseEq(string)` | `argument` is equal to `string`, ignoring case. | -| `StrCaseNe(string)` | `argument` is not equal to `string`, ignoring case. | -| `StrEq(string)` | `argument` is equal to `string`. | -| `StrNe(string)` | `argument` is not equal to `string`. | - -`ContainsRegex()` and `MatchesRegex()` take ownership of the `RE` object. They -use the regular expression syntax defined -[here](../advanced.md#regular-expression-syntax). All of these matchers, except -`ContainsRegex()` and `MatchesRegex()` work for wide strings as well. - -## Container Matchers - -Most STL-style containers support `==`, so you can use `Eq(expected_container)` -or simply `expected_container` to match a container exactly. If you want to -write the elements in-line, match them more flexibly, or get more informative -messages, you can use: - -| Matcher | Description | -| :---------------------------------------- | :------------------------------- | -| `BeginEndDistanceIs(m)` | `argument` is a container whose `begin()` and `end()` iterators are separated by a number of increments matching `m`. E.g. `BeginEndDistanceIs(2)` or `BeginEndDistanceIs(Lt(2))`. For containers that define a `size()` method, `SizeIs(m)` may be more efficient. | -| `ContainerEq(container)` | The same as `Eq(container)` except that the failure message also includes which elements are in one container but not the other. | -| `Contains(e)` | `argument` contains an element that matches `e`, which can be either a value or a matcher. | -| `Each(e)` | `argument` is a container where *every* element matches `e`, which can be either a value or a matcher. | -| `ElementsAre(e0, e1, ..., en)` | `argument` has `n + 1` elements, where the *i*-th element matches `ei`, which can be a value or a matcher. | -| `ElementsAreArray({e0, e1, ..., en})`, `ElementsAreArray(a_container)`, `ElementsAreArray(begin, end)`, `ElementsAreArray(array)`, or `ElementsAreArray(array, count)` | The same as `ElementsAre()` except that the expected element values/matchers come from an initializer list, STL-style container, iterator range, or C-style array. | -| `IsEmpty()` | `argument` is an empty container (`container.empty()`). | -| `IsSubsetOf({e0, e1, ..., en})`, `IsSubsetOf(a_container)`, `IsSubsetOf(begin, end)`, `IsSubsetOf(array)`, or `IsSubsetOf(array, count)` | `argument` matches `UnorderedElementsAre(x0, x1, ..., xk)` for some subset `{x0, x1, ..., xk}` of the expected matchers. | -| `IsSupersetOf({e0, e1, ..., en})`, `IsSupersetOf(a_container)`, `IsSupersetOf(begin, end)`, `IsSupersetOf(array)`, or `IsSupersetOf(array, count)` | Some subset of `argument` matches `UnorderedElementsAre(`expected matchers`)`. | -| `Pointwise(m, container)`, `Pointwise(m, {e0, e1, ..., en})` | `argument` contains the same number of elements as in `container`, and for all i, (the i-th element in `argument`, the i-th element in `container`) match `m`, which is a matcher on 2-tuples. E.g. `Pointwise(Le(), upper_bounds)` verifies that each element in `argument` doesn't exceed the corresponding element in `upper_bounds`. See more detail below. | -| `SizeIs(m)` | `argument` is a container whose size matches `m`. E.g. `SizeIs(2)` or `SizeIs(Lt(2))`. | -| `UnorderedElementsAre(e0, e1, ..., en)` | `argument` has `n + 1` elements, and under *some* permutation of the elements, each element matches an `ei` (for a different `i`), which can be a value or a matcher. | -| `UnorderedElementsAreArray({e0, e1, ..., en})`, `UnorderedElementsAreArray(a_container)`, `UnorderedElementsAreArray(begin, end)`, `UnorderedElementsAreArray(array)`, or `UnorderedElementsAreArray(array, count)` | The same as `UnorderedElementsAre()` except that the expected element values/matchers come from an initializer list, STL-style container, iterator range, or C-style array. | -| `UnorderedPointwise(m, container)`, `UnorderedPointwise(m, {e0, e1, ..., en})` | Like `Pointwise(m, container)`, but ignores the order of elements. | -| `WhenSorted(m)` | When `argument` is sorted using the `<` operator, it matches container matcher `m`. E.g. `WhenSorted(ElementsAre(1, 2, 3))` verifies that `argument` contains elements 1, 2, and 3, ignoring order. | -| `WhenSortedBy(comparator, m)` | The same as `WhenSorted(m)`, except that the given comparator instead of `<` is used to sort `argument`. E.g. `WhenSortedBy(std::greater(), ElementsAre(3, 2, 1))`. | - -**Notes:** - -* These matchers can also match: - 1. a native array passed by reference (e.g. in `Foo(const int (&a)[5])`), - and - 2. an array passed as a pointer and a count (e.g. in `Bar(const T* buffer, - int len)` -- see [Multi-argument Matchers](#MultiArgMatchers)). -* The array being matched may be multi-dimensional (i.e. its elements can be - arrays). -* `m` in `Pointwise(m, ...)` and `UnorderedPointwise(m, ...)` should be a - matcher for `::std::tuple` where `T` and `U` are the element type of - the actual container and the expected container, respectively. For example, - to compare two `Foo` containers where `Foo` doesn't support `operator==`, - one might write: - - ```cpp - using ::std::get; - MATCHER(FooEq, "") { - return std::get<0>(arg).Equals(std::get<1>(arg)); - } - ... - EXPECT_THAT(actual_foos, Pointwise(FooEq(), expected_foos)); - ``` - -## Member Matchers - -| Matcher | Description | -| :------------------------------ | :----------------------------------------- | -| `Field(&class::field, m)` | `argument.field` (or `argument->field` when `argument` is a plain pointer) matches matcher `m`, where `argument` is an object of type _class_. | -| `Field(field_name, &class::field, m)` | The same as the two-parameter version, but provides a better error message. | -| `Key(e)` | `argument.first` matches `e`, which can be either a value or a matcher. E.g. `Contains(Key(Le(5)))` can verify that a `map` contains a key `<= 5`. | -| `Pair(m1, m2)` | `argument` is an `std::pair` whose `first` field matches `m1` and `second` field matches `m2`. | -| `FieldsAre(m...)` | `argument` is a compatible object where each field matches piecewise with the matchers `m...`. A compatible object is any that supports the `std::tuple_size`+`get(obj)` protocol. In C++17 and up this also supports types compatible with structured bindings, like aggregates. | -| `Property(&class::property, m)` | `argument.property()` (or `argument->property()` when `argument` is a plain pointer) matches matcher `m`, where `argument` is an object of type _class_. The method `property()` must take no argument and be declared as `const`. | -| `Property(property_name, &class::property, m)` | The same as the two-parameter version, but provides a better error message. - -**Notes:** - -* You can use `FieldsAre()` to match any type that supports structured - bindings, such as `std::tuple`, `std::pair`, `std::array`, and aggregate - types. For example: - - ```cpp - std::tuple my_tuple{7, "hello world"}; - EXPECT_THAT(my_tuple, FieldsAre(Ge(0), HasSubstr("hello"))); - - struct MyStruct { - int value = 42; - std::string greeting = "aloha"; - }; - MyStruct s; - EXPECT_THAT(s, FieldsAre(42, "aloha")); - ``` - -* Don't use `Property()` against member functions that you do not own, because - taking addresses of functions is fragile and generally not part of the - contract of the function. - -## Matching the Result of a Function, Functor, or Callback - -| Matcher | Description | -| :--------------- | :------------------------------------------------ | -| `ResultOf(f, m)` | `f(argument)` matches matcher `m`, where `f` is a function or functor. | - -## Pointer Matchers - -| Matcher | Description | -| :------------------------ | :---------------------------------------------- | -| `Address(m)` | the result of `std::addressof(argument)` matches `m`. | -| `Pointee(m)` | `argument` (either a smart pointer or a raw pointer) points to a value that matches matcher `m`. | -| `Pointer(m)` | `argument` (either a smart pointer or a raw pointer) contains a pointer that matches `m`. `m` will match against the raw pointer regardless of the type of `argument`. | -| `WhenDynamicCastTo(m)` | when `argument` is passed through `dynamic_cast()`, it matches matcher `m`. | - -## Multi-argument Matchers {#MultiArgMatchers} - -Technically, all matchers match a *single* value. A "multi-argument" matcher is -just one that matches a *tuple*. The following matchers can be used to match a -tuple `(x, y)`: - -Matcher | Description -:------ | :---------- -`Eq()` | `x == y` -`Ge()` | `x >= y` -`Gt()` | `x > y` -`Le()` | `x <= y` -`Lt()` | `x < y` -`Ne()` | `x != y` - -You can use the following selectors to pick a subset of the arguments (or -reorder them) to participate in the matching: - -| Matcher | Description | -| :------------------------- | :---------------------------------------------- | -| `AllArgs(m)` | Equivalent to `m`. Useful as syntactic sugar in `.With(AllArgs(m))`. | -| `Args(m)` | The tuple of the `k` selected (using 0-based indices) arguments matches `m`, e.g. `Args<1, 2>(Eq())`. | - -## Composite Matchers - -You can make a matcher from one or more other matchers: - -| Matcher | Description | -| :------------------------------- | :-------------------------------------- | -| `AllOf(m1, m2, ..., mn)` | `argument` matches all of the matchers `m1` to `mn`. | -| `AllOfArray({m0, m1, ..., mn})`, `AllOfArray(a_container)`, `AllOfArray(begin, end)`, `AllOfArray(array)`, or `AllOfArray(array, count)` | The same as `AllOf()` except that the matchers come from an initializer list, STL-style container, iterator range, or C-style array. | -| `AnyOf(m1, m2, ..., mn)` | `argument` matches at least one of the matchers `m1` to `mn`. | -| `AnyOfArray({m0, m1, ..., mn})`, `AnyOfArray(a_container)`, `AnyOfArray(begin, end)`, `AnyOfArray(array)`, or `AnyOfArray(array, count)` | The same as `AnyOf()` except that the matchers come from an initializer list, STL-style container, iterator range, or C-style array. | -| `Not(m)` | `argument` doesn't match matcher `m`. | - -## Adapters for Matchers - -| Matcher | Description | -| :---------------------- | :------------------------------------ | -| `MatcherCast(m)` | casts matcher `m` to type `Matcher`. | -| `SafeMatcherCast(m)` | [safely casts](../gmock_cook_book.md#SafeMatcherCast) matcher `m` to type `Matcher`. | -| `Truly(predicate)` | `predicate(argument)` returns something considered by C++ to be true, where `predicate` is a function or functor. | - -`AddressSatisfies(callback)` and `Truly(callback)` take ownership of `callback`, -which must be a permanent callback. - -## Using Matchers as Predicates {#MatchersAsPredicatesCheat} - -| Matcher | Description | -| :---------------------------- | :------------------------------------------ | -| `Matches(m)(value)` | evaluates to `true` if `value` matches `m`. You can use `Matches(m)` alone as a unary functor. | -| `ExplainMatchResult(m, value, result_listener)` | evaluates to `true` if `value` matches `m`, explaining the result to `result_listener`. | -| `Value(value, m)` | evaluates to `true` if `value` matches `m`. | - -## Defining Matchers - -| Matcher | Description | -| :----------------------------------- | :------------------------------------ | -| `MATCHER(IsEven, "") { return (arg % 2) == 0; }` | Defines a matcher `IsEven()` to match an even number. | -| `MATCHER_P(IsDivisibleBy, n, "") { *result_listener << "where the remainder is " << (arg % n); return (arg % n) == 0; }` | Defines a matcher `IsDivisibleBy(n)` to match a number divisible by `n`. | -| `MATCHER_P2(IsBetween, a, b, absl::StrCat(negation ? "isn't" : "is", " between ", PrintToString(a), " and ", PrintToString(b))) { return a <= arg && arg <= b; }` | Defines a matcher `IsBetween(a, b)` to match a value in the range [`a`, `b`]. | - -**Notes:** - -1. The `MATCHER*` macros cannot be used inside a function or class. -2. The matcher body must be *purely functional* (i.e. it cannot have any side - effect, and the result must not depend on anything other than the value - being matched and the matcher parameters). -3. You can use `PrintToString(x)` to convert a value `x` of any type to a - string. -4. You can use `ExplainMatchResult()` in a custom matcher to wrap another - matcher, for example: - - ```cpp - MATCHER_P(NestedPropertyMatches, matcher, "") { - return ExplainMatchResult(matcher, arg.nested().property(), result_listener); - } - ``` diff --git a/external/googletest/docs/reference/mocking.md b/external/googletest/docs/reference/mocking.md deleted file mode 100644 index c29f71603f..0000000000 --- a/external/googletest/docs/reference/mocking.md +++ /dev/null @@ -1,587 +0,0 @@ -# Mocking Reference - -This page lists the facilities provided by GoogleTest for creating and working -with mock objects. To use them, include the header -`gmock/gmock.h`. - -## Macros {#macros} - -GoogleTest defines the following macros for working with mocks. - -### MOCK_METHOD {#MOCK_METHOD} - -`MOCK_METHOD(`*`return_type`*`,`*`method_name`*`, (`*`args...`*`));` \ -`MOCK_METHOD(`*`return_type`*`,`*`method_name`*`, (`*`args...`*`), -(`*`specs...`*`));` - -Defines a mock method *`method_name`* with arguments `(`*`args...`*`)` and -return type *`return_type`* within a mock class. - -The parameters of `MOCK_METHOD` mirror the method declaration. The optional -fourth parameter *`specs...`* is a comma-separated list of qualifiers. The -following qualifiers are accepted: - -| Qualifier | Meaning | -| -------------------------- | -------------------------------------------- | -| `const` | Makes the mocked method a `const` method. Required if overriding a `const` method. | -| `override` | Marks the method with `override`. Recommended if overriding a `virtual` method. | -| `noexcept` | Marks the method with `noexcept`. Required if overriding a `noexcept` method. | -| `Calltype(`*`calltype`*`)` | Sets the call type for the method, for example `Calltype(STDMETHODCALLTYPE)`. Useful on Windows. | -| `ref(`*`qualifier`*`)` | Marks the method with the given reference qualifier, for example `ref(&)` or `ref(&&)`. Required if overriding a method that has a reference qualifier. | - -Note that commas in arguments prevent `MOCK_METHOD` from parsing the arguments -correctly if they are not appropriately surrounded by parentheses. See the -following example: - -```cpp -class MyMock { - public: - // The following 2 lines will not compile due to commas in the arguments: - MOCK_METHOD(std::pair, GetPair, ()); // Error! - MOCK_METHOD(bool, CheckMap, (std::map, bool)); // Error! - - // One solution - wrap arguments that contain commas in parentheses: - MOCK_METHOD((std::pair), GetPair, ()); - MOCK_METHOD(bool, CheckMap, ((std::map), bool)); - - // Another solution - use type aliases: - using BoolAndInt = std::pair; - MOCK_METHOD(BoolAndInt, GetPair, ()); - using MapIntDouble = std::map; - MOCK_METHOD(bool, CheckMap, (MapIntDouble, bool)); -}; -``` - -`MOCK_METHOD` must be used in the `public:` section of a mock class definition, -regardless of whether the method being mocked is `public`, `protected`, or -`private` in the base class. - -### EXPECT_CALL {#EXPECT_CALL} - -`EXPECT_CALL(`*`mock_object`*`,`*`method_name`*`(`*`matchers...`*`))` - -Creates an [expectation](../gmock_for_dummies.md#setting-expectations) that the -method *`method_name`* of the object *`mock_object`* is called with arguments -that match the given matchers *`matchers...`*. `EXPECT_CALL` must precede any -code that exercises the mock object. - -The parameter *`matchers...`* is a comma-separated list of -[matchers](../gmock_for_dummies.md#matchers-what-arguments-do-we-expect) that -correspond to each argument of the method *`method_name`*. The expectation will -apply only to calls of *`method_name`* whose arguments match all of the -matchers. If `(`*`matchers...`*`)` is omitted, the expectation behaves as if -each argument's matcher were a [wildcard matcher (`_`)](matchers.md#wildcard). -See the [Matchers Reference](matchers.md) for a list of all built-in matchers. - -The following chainable clauses can be used to modify the expectation, and they -must be used in the following order: - -```cpp -EXPECT_CALL(mock_object, method_name(matchers...)) - .With(multi_argument_matcher) // Can be used at most once - .Times(cardinality) // Can be used at most once - .InSequence(sequences...) // Can be used any number of times - .After(expectations...) // Can be used any number of times - .WillOnce(action) // Can be used any number of times - .WillRepeatedly(action) // Can be used at most once - .RetiresOnSaturation(); // Can be used at most once -``` - -See details for each modifier clause below. - -#### With {#EXPECT_CALL.With} - -`.With(`*`multi_argument_matcher`*`)` - -Restricts the expectation to apply only to mock function calls whose arguments -as a whole match the multi-argument matcher *`multi_argument_matcher`*. - -GoogleTest passes all of the arguments as one tuple into the matcher. The -parameter *`multi_argument_matcher`* must thus be a matcher of type -`Matcher>`, where `A1, ..., An` are the types of the -function arguments. - -For example, the following code sets the expectation that -`my_mock.SetPosition()` is called with any two arguments, the first argument -being less than the second: - -```cpp -using ::testing::_; -using ::testing::Lt; -... -EXPECT_CALL(my_mock, SetPosition(_, _)) - .With(Lt()); -``` - -GoogleTest provides some built-in matchers for 2-tuples, including the `Lt()` -matcher above. See [Multi-argument Matchers](matchers.md#MultiArgMatchers). - -The `With` clause can be used at most once on an expectation and must be the -first clause. - -#### Times {#EXPECT_CALL.Times} - -`.Times(`*`cardinality`*`)` - -Specifies how many times the mock function call is expected. - -The parameter *`cardinality`* represents the number of expected calls and can be -one of the following, all defined in the `::testing` namespace: - -| Cardinality | Meaning | -| ------------------- | --------------------------------------------------- | -| `AnyNumber()` | The function can be called any number of times. | -| `AtLeast(n)` | The function call is expected at least *n* times. | -| `AtMost(n)` | The function call is expected at most *n* times. | -| `Between(m, n)` | The function call is expected between *m* and *n* times, inclusive. | -| `Exactly(n)` or `n` | The function call is expected exactly *n* times. If *n* is 0, the call should never happen. | - -If the `Times` clause is omitted, GoogleTest infers the cardinality as follows: - -* If neither [`WillOnce`](#EXPECT_CALL.WillOnce) nor - [`WillRepeatedly`](#EXPECT_CALL.WillRepeatedly) are specified, the inferred - cardinality is `Times(1)`. -* If there are *n* `WillOnce` clauses and no `WillRepeatedly` clause, where - *n* >= 1, the inferred cardinality is `Times(n)`. -* If there are *n* `WillOnce` clauses and one `WillRepeatedly` clause, where - *n* >= 0, the inferred cardinality is `Times(AtLeast(n))`. - -The `Times` clause can be used at most once on an expectation. - -#### InSequence {#EXPECT_CALL.InSequence} - -`.InSequence(`*`sequences...`*`)` - -Specifies that the mock function call is expected in a certain sequence. - -The parameter *`sequences...`* is any number of [`Sequence`](#Sequence) objects. -Expected calls assigned to the same sequence are expected to occur in the order -the expectations are declared. - -For example, the following code sets the expectation that the `Reset()` method -of `my_mock` is called before both `GetSize()` and `Describe()`, and `GetSize()` -and `Describe()` can occur in any order relative to each other: - -```cpp -using ::testing::Sequence; -Sequence s1, s2; -... -EXPECT_CALL(my_mock, Reset()) - .InSequence(s1, s2); -EXPECT_CALL(my_mock, GetSize()) - .InSequence(s1); -EXPECT_CALL(my_mock, Describe()) - .InSequence(s2); -``` - -The `InSequence` clause can be used any number of times on an expectation. - -See also the [`InSequence` class](#InSequence). - -#### After {#EXPECT_CALL.After} - -`.After(`*`expectations...`*`)` - -Specifies that the mock function call is expected to occur after one or more -other calls. - -The parameter *`expectations...`* can be up to five -[`Expectation`](#Expectation) or [`ExpectationSet`](#ExpectationSet) objects. -The mock function call is expected to occur after all of the given expectations. - -For example, the following code sets the expectation that the `Describe()` -method of `my_mock` is called only after both `InitX()` and `InitY()` have been -called. - -```cpp -using ::testing::Expectation; -... -Expectation init_x = EXPECT_CALL(my_mock, InitX()); -Expectation init_y = EXPECT_CALL(my_mock, InitY()); -EXPECT_CALL(my_mock, Describe()) - .After(init_x, init_y); -``` - -The `ExpectationSet` object is helpful when the number of prerequisites for an -expectation is large or variable, for example: - -```cpp -using ::testing::ExpectationSet; -... -ExpectationSet all_inits; -// Collect all expectations of InitElement() calls -for (int i = 0; i < element_count; i++) { - all_inits += EXPECT_CALL(my_mock, InitElement(i)); -} -EXPECT_CALL(my_mock, Describe()) - .After(all_inits); // Expect Describe() call after all InitElement() calls -``` - -The `After` clause can be used any number of times on an expectation. - -#### WillOnce {#EXPECT_CALL.WillOnce} - -`.WillOnce(`*`action`*`)` - -Specifies the mock function's actual behavior when invoked, for a single -matching function call. - -The parameter *`action`* represents the -[action](../gmock_for_dummies.md#actions-what-should-it-do) that the function -call will perform. See the [Actions Reference](actions.md) for a list of -built-in actions. - -The use of `WillOnce` implicitly sets a cardinality on the expectation when -`Times` is not specified. See [`Times`](#EXPECT_CALL.Times). - -Each matching function call will perform the next action in the order declared. -For example, the following code specifies that `my_mock.GetNumber()` is expected -to be called exactly 3 times and will return `1`, `2`, and `3` respectively on -the first, second, and third calls: - -```cpp -using ::testing::Return; -... -EXPECT_CALL(my_mock, GetNumber()) - .WillOnce(Return(1)) - .WillOnce(Return(2)) - .WillOnce(Return(3)); -``` - -The `WillOnce` clause can be used any number of times on an expectation. - -#### WillRepeatedly {#EXPECT_CALL.WillRepeatedly} - -`.WillRepeatedly(`*`action`*`)` - -Specifies the mock function's actual behavior when invoked, for all subsequent -matching function calls. Takes effect after the actions specified in the -[`WillOnce`](#EXPECT_CALL.WillOnce) clauses, if any, have been performed. - -The parameter *`action`* represents the -[action](../gmock_for_dummies.md#actions-what-should-it-do) that the function -call will perform. See the [Actions Reference](actions.md) for a list of -built-in actions. - -The use of `WillRepeatedly` implicitly sets a cardinality on the expectation -when `Times` is not specified. See [`Times`](#EXPECT_CALL.Times). - -If any `WillOnce` clauses have been specified, matching function calls will -perform those actions before the action specified by `WillRepeatedly`. See the -following example: - -```cpp -using ::testing::Return; -... -EXPECT_CALL(my_mock, GetName()) - .WillRepeatedly(Return("John Doe")); // Return "John Doe" on all calls - -EXPECT_CALL(my_mock, GetNumber()) - .WillOnce(Return(42)) // Return 42 on the first call - .WillRepeatedly(Return(7)); // Return 7 on all subsequent calls -``` - -The `WillRepeatedly` clause can be used at most once on an expectation. - -#### RetiresOnSaturation {#EXPECT_CALL.RetiresOnSaturation} - -`.RetiresOnSaturation()` - -Indicates that the expectation will no longer be active after the expected -number of matching function calls has been reached. - -The `RetiresOnSaturation` clause is only meaningful for expectations with an -upper-bounded cardinality. The expectation will *retire* (no longer match any -function calls) after it has been *saturated* (the upper bound has been -reached). See the following example: - -```cpp -using ::testing::_; -using ::testing::AnyNumber; -... -EXPECT_CALL(my_mock, SetNumber(_)) // Expectation 1 - .Times(AnyNumber()); -EXPECT_CALL(my_mock, SetNumber(7)) // Expectation 2 - .Times(2) - .RetiresOnSaturation(); -``` - -In the above example, the first two calls to `my_mock.SetNumber(7)` match -expectation 2, which then becomes inactive and no longer matches any calls. A -third call to `my_mock.SetNumber(7)` would then match expectation 1. Without -`RetiresOnSaturation()` on expectation 2, a third call to `my_mock.SetNumber(7)` -would match expectation 2 again, producing a failure since the limit of 2 calls -was exceeded. - -The `RetiresOnSaturation` clause can be used at most once on an expectation and -must be the last clause. - -### ON_CALL {#ON_CALL} - -`ON_CALL(`*`mock_object`*`,`*`method_name`*`(`*`matchers...`*`))` - -Defines what happens when the method *`method_name`* of the object -*`mock_object`* is called with arguments that match the given matchers -*`matchers...`*. Requires a modifier clause to specify the method's behavior. -*Does not* set any expectations that the method will be called. - -The parameter *`matchers...`* is a comma-separated list of -[matchers](../gmock_for_dummies.md#matchers-what-arguments-do-we-expect) that -correspond to each argument of the method *`method_name`*. The `ON_CALL` -specification will apply only to calls of *`method_name`* whose arguments match -all of the matchers. If `(`*`matchers...`*`)` is omitted, the behavior is as if -each argument's matcher were a [wildcard matcher (`_`)](matchers.md#wildcard). -See the [Matchers Reference](matchers.md) for a list of all built-in matchers. - -The following chainable clauses can be used to set the method's behavior, and -they must be used in the following order: - -```cpp -ON_CALL(mock_object, method_name(matchers...)) - .With(multi_argument_matcher) // Can be used at most once - .WillByDefault(action); // Required -``` - -See details for each modifier clause below. - -#### With {#ON_CALL.With} - -`.With(`*`multi_argument_matcher`*`)` - -Restricts the specification to only mock function calls whose arguments as a -whole match the multi-argument matcher *`multi_argument_matcher`*. - -GoogleTest passes all of the arguments as one tuple into the matcher. The -parameter *`multi_argument_matcher`* must thus be a matcher of type -`Matcher>`, where `A1, ..., An` are the types of the -function arguments. - -For example, the following code sets the default behavior when -`my_mock.SetPosition()` is called with any two arguments, the first argument -being less than the second: - -```cpp -using ::testing::_; -using ::testing::Lt; -using ::testing::Return; -... -ON_CALL(my_mock, SetPosition(_, _)) - .With(Lt()) - .WillByDefault(Return(true)); -``` - -GoogleTest provides some built-in matchers for 2-tuples, including the `Lt()` -matcher above. See [Multi-argument Matchers](matchers.md#MultiArgMatchers). - -The `With` clause can be used at most once with each `ON_CALL` statement. - -#### WillByDefault {#ON_CALL.WillByDefault} - -`.WillByDefault(`*`action`*`)` - -Specifies the default behavior of a matching mock function call. - -The parameter *`action`* represents the -[action](../gmock_for_dummies.md#actions-what-should-it-do) that the function -call will perform. See the [Actions Reference](actions.md) for a list of -built-in actions. - -For example, the following code specifies that by default, a call to -`my_mock.Greet()` will return `"hello"`: - -```cpp -using ::testing::Return; -... -ON_CALL(my_mock, Greet()) - .WillByDefault(Return("hello")); -``` - -The action specified by `WillByDefault` is superseded by the actions specified -on a matching `EXPECT_CALL` statement, if any. See the -[`WillOnce`](#EXPECT_CALL.WillOnce) and -[`WillRepeatedly`](#EXPECT_CALL.WillRepeatedly) clauses of `EXPECT_CALL`. - -The `WillByDefault` clause must be used exactly once with each `ON_CALL` -statement. - -## Classes {#classes} - -GoogleTest defines the following classes for working with mocks. - -### DefaultValue {#DefaultValue} - -`::testing::DefaultValue` - -Allows a user to specify the default value for a type `T` that is both copyable -and publicly destructible (i.e. anything that can be used as a function return -type). For mock functions with a return type of `T`, this default value is -returned from function calls that do not specify an action. - -Provides the static methods `Set()`, `SetFactory()`, and `Clear()` to manage the -default value: - -```cpp -// Sets the default value to be returned. T must be copy constructible. -DefaultValue::Set(value); - -// Sets a factory. Will be invoked on demand. T must be move constructible. -T MakeT(); -DefaultValue::SetFactory(&MakeT); - -// Unsets the default value. -DefaultValue::Clear(); -``` - -### NiceMock {#NiceMock} - -`::testing::NiceMock` - -Represents a mock object that suppresses warnings on -[uninteresting calls](../gmock_cook_book.md#uninteresting-vs-unexpected). The -template parameter `T` is any mock class, except for another `NiceMock`, -`NaggyMock`, or `StrictMock`. - -Usage of `NiceMock` is analogous to usage of `T`. `NiceMock` is a subclass -of `T`, so it can be used wherever an object of type `T` is accepted. In -addition, `NiceMock` can be constructed with any arguments that a constructor -of `T` accepts. - -For example, the following code suppresses warnings on the mock `my_mock` of -type `MockClass` if a method other than `DoSomething()` is called: - -```cpp -using ::testing::NiceMock; -... -NiceMock my_mock("some", "args"); -EXPECT_CALL(my_mock, DoSomething()); -... code that uses my_mock ... -``` - -`NiceMock` only works for mock methods defined using the `MOCK_METHOD` macro -directly in the definition of class `T`. If a mock method is defined in a base -class of `T`, a warning might still be generated. - -`NiceMock` might not work correctly if the destructor of `T` is not virtual. - -### NaggyMock {#NaggyMock} - -`::testing::NaggyMock` - -Represents a mock object that generates warnings on -[uninteresting calls](../gmock_cook_book.md#uninteresting-vs-unexpected). The -template parameter `T` is any mock class, except for another `NiceMock`, -`NaggyMock`, or `StrictMock`. - -Usage of `NaggyMock` is analogous to usage of `T`. `NaggyMock` is a -subclass of `T`, so it can be used wherever an object of type `T` is accepted. -In addition, `NaggyMock` can be constructed with any arguments that a -constructor of `T` accepts. - -For example, the following code generates warnings on the mock `my_mock` of type -`MockClass` if a method other than `DoSomething()` is called: - -```cpp -using ::testing::NaggyMock; -... -NaggyMock my_mock("some", "args"); -EXPECT_CALL(my_mock, DoSomething()); -... code that uses my_mock ... -``` - -Mock objects of type `T` by default behave the same way as `NaggyMock`. - -### StrictMock {#StrictMock} - -`::testing::StrictMock` - -Represents a mock object that generates test failures on -[uninteresting calls](../gmock_cook_book.md#uninteresting-vs-unexpected). The -template parameter `T` is any mock class, except for another `NiceMock`, -`NaggyMock`, or `StrictMock`. - -Usage of `StrictMock` is analogous to usage of `T`. `StrictMock` is a -subclass of `T`, so it can be used wherever an object of type `T` is accepted. -In addition, `StrictMock` can be constructed with any arguments that a -constructor of `T` accepts. - -For example, the following code generates a test failure on the mock `my_mock` -of type `MockClass` if a method other than `DoSomething()` is called: - -```cpp -using ::testing::StrictMock; -... -StrictMock my_mock("some", "args"); -EXPECT_CALL(my_mock, DoSomething()); -... code that uses my_mock ... -``` - -`StrictMock` only works for mock methods defined using the `MOCK_METHOD` -macro directly in the definition of class `T`. If a mock method is defined in a -base class of `T`, a failure might not be generated. - -`StrictMock` might not work correctly if the destructor of `T` is not -virtual. - -### Sequence {#Sequence} - -`::testing::Sequence` - -Represents a chronological sequence of expectations. See the -[`InSequence`](#EXPECT_CALL.InSequence) clause of `EXPECT_CALL` for usage. - -### InSequence {#InSequence} - -`::testing::InSequence` - -An object of this type causes all expectations encountered in its scope to be -put in an anonymous sequence. - -This allows more convenient expression of multiple expectations in a single -sequence: - -```cpp -using ::testing::InSequence; -{ - InSequence seq; - - // The following are expected to occur in the order declared. - EXPECT_CALL(...); - EXPECT_CALL(...); - ... - EXPECT_CALL(...); -} -``` - -The name of the `InSequence` object does not matter. - -### Expectation {#Expectation} - -`::testing::Expectation` - -Represents a mock function call expectation as created by -[`EXPECT_CALL`](#EXPECT_CALL): - -```cpp -using ::testing::Expectation; -Expectation my_expectation = EXPECT_CALL(...); -``` - -Useful for specifying sequences of expectations; see the -[`After`](#EXPECT_CALL.After) clause of `EXPECT_CALL`. - -### ExpectationSet {#ExpectationSet} - -`::testing::ExpectationSet` - -Represents a set of mock function call expectations. - -Use the `+=` operator to add [`Expectation`](#Expectation) objects to the set: - -```cpp -using ::testing::ExpectationSet; -ExpectationSet my_expectations; -my_expectations += EXPECT_CALL(...); -``` - -Useful for specifying sequences of expectations; see the -[`After`](#EXPECT_CALL.After) clause of `EXPECT_CALL`. diff --git a/external/googletest/docs/reference/testing.md b/external/googletest/docs/reference/testing.md deleted file mode 100644 index 554d6c9584..0000000000 --- a/external/googletest/docs/reference/testing.md +++ /dev/null @@ -1,1431 +0,0 @@ -# Testing Reference - - - -This page lists the facilities provided by GoogleTest for writing test programs. -To use them, include the header `gtest/gtest.h`. - -## Macros - -GoogleTest defines the following macros for writing tests. - -### TEST {#TEST} - -
    -TEST(TestSuiteName, TestName) {
-  ... statements ...
-}
-
    - -Defines an individual test named *`TestName`* in the test suite -*`TestSuiteName`*, consisting of the given statements. - -Both arguments *`TestSuiteName`* and *`TestName`* must be valid C++ identifiers -and must not contain underscores (`_`). Tests in different test suites can have -the same individual name. - -The statements within the test body can be any code under test. -[Assertions](assertions.md) used within the test body determine the outcome of -the test. - -### TEST_F {#TEST_F} - -
    -TEST_F(TestFixtureName, TestName) {
-  ... statements ...
-}
-
    - -Defines an individual test named *`TestName`* that uses the test fixture class -*`TestFixtureName`*. The test suite name is *`TestFixtureName`*. - -Both arguments *`TestFixtureName`* and *`TestName`* must be valid C++ -identifiers and must not contain underscores (`_`). *`TestFixtureName`* must be -the name of a test fixture class—see -[Test Fixtures](../primer.md#same-data-multiple-tests). - -The statements within the test body can be any code under test. -[Assertions](assertions.md) used within the test body determine the outcome of -the test. - -### TEST_P {#TEST_P} - -
    -TEST_P(TestFixtureName, TestName) {
-  ... statements ...
-}
-
    - -Defines an individual value-parameterized test named *`TestName`* that uses the -test fixture class *`TestFixtureName`*. The test suite name is -*`TestFixtureName`*. - -Both arguments *`TestFixtureName`* and *`TestName`* must be valid C++ -identifiers and must not contain underscores (`_`). *`TestFixtureName`* must be -the name of a value-parameterized test fixture class—see -[Value-Parameterized Tests](../advanced.md#value-parameterized-tests). - -The statements within the test body can be any code under test. Within the test -body, the test parameter can be accessed with the `GetParam()` function (see -[`WithParamInterface`](#WithParamInterface)). For example: - -```cpp -TEST_P(MyTestSuite, DoesSomething) { - ... - EXPECT_TRUE(DoSomething(GetParam())); - ... -} -``` - -[Assertions](assertions.md) used within the test body determine the outcome of -the test. - -See also [`INSTANTIATE_TEST_SUITE_P`](#INSTANTIATE_TEST_SUITE_P). - -### INSTANTIATE_TEST_SUITE_P {#INSTANTIATE_TEST_SUITE_P} - -`INSTANTIATE_TEST_SUITE_P(`*`InstantiationName`*`,`*`TestSuiteName`*`,`*`param_generator`*`)` -\ -`INSTANTIATE_TEST_SUITE_P(`*`InstantiationName`*`,`*`TestSuiteName`*`,`*`param_generator`*`,`*`name_generator`*`)` - -Instantiates the value-parameterized test suite *`TestSuiteName`* (defined with -[`TEST_P`](#TEST_P)). - -The argument *`InstantiationName`* is a unique name for the instantiation of the -test suite, to distinguish between multiple instantiations. In test output, the -instantiation name is added as a prefix to the test suite name -*`TestSuiteName`*. - -The argument *`param_generator`* is one of the following GoogleTest-provided -functions that generate the test parameters, all defined in the `::testing` -namespace: - - - -| Parameter Generator | Behavior | -| ------------------- | ---------------------------------------------------- | -| `Range(begin, end [, step])` | Yields values `{begin, begin+step, begin+step+step, ...}`. The values do not include `end`. `step` defaults to 1. | -| `Values(v1, v2, ..., vN)` | Yields values `{v1, v2, ..., vN}`. | -| `ValuesIn(container)` or `ValuesIn(begin,end)` | Yields values from a C-style array, an STL-style container, or an iterator range `[begin, end)`. | -| `Bool()` | Yields sequence `{false, true}`. | -| `Combine(g1, g2, ..., gN)` | Yields as `std::tuple` *n*-tuples all combinations (Cartesian product) of the values generated by the given *n* generators `g1`, `g2`, ..., `gN`. | - -The optional last argument *`name_generator`* is a function or functor that -generates custom test name suffixes based on the test parameters. The function -must accept an argument of type -[`TestParamInfo`](#TestParamInfo) and return a `std::string`. -The test name suffix can only contain alphanumeric characters and underscores. -GoogleTest provides [`PrintToStringParamName`](#PrintToStringParamName), or a -custom function can be used for more control: - -```cpp -INSTANTIATE_TEST_SUITE_P( - MyInstantiation, MyTestSuite, - ::testing::Values(...), - [](const ::testing::TestParamInfo& info) { - // Can use info.param here to generate the test suffix - std::string name = ... - return name; - }); -``` - -For more information, see -[Value-Parameterized Tests](../advanced.md#value-parameterized-tests). - -See also -[`GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST`](#GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST). - -### TYPED_TEST_SUITE {#TYPED_TEST_SUITE} - -`TYPED_TEST_SUITE(`*`TestFixtureName`*`,`*`Types`*`)` - -Defines a typed test suite based on the test fixture *`TestFixtureName`*. The -test suite name is *`TestFixtureName`*. - -The argument *`TestFixtureName`* is a fixture class template, parameterized by a -type, for example: - -```cpp -template -class MyFixture : public ::testing::Test { - public: - ... - using List = std::list; - static T shared_; - T value_; -}; -``` - -The argument *`Types`* is a [`Types`](#Types) object representing the list of -types to run the tests on, for example: - -```cpp -using MyTypes = ::testing::Types; -TYPED_TEST_SUITE(MyFixture, MyTypes); -``` - -The type alias (`using` or `typedef`) is necessary for the `TYPED_TEST_SUITE` -macro to parse correctly. - -See also [`TYPED_TEST`](#TYPED_TEST) and -[Typed Tests](../advanced.md#typed-tests) for more information. - -### TYPED_TEST {#TYPED_TEST} - -
    -TYPED_TEST(TestSuiteName, TestName) {
-  ... statements ...
-}
-
    - -Defines an individual typed test named *`TestName`* in the typed test suite -*`TestSuiteName`*. The test suite must be defined with -[`TYPED_TEST_SUITE`](#TYPED_TEST_SUITE). - -Within the test body, the special name `TypeParam` refers to the type parameter, -and `TestFixture` refers to the fixture class. See the following example: - -```cpp -TYPED_TEST(MyFixture, Example) { - // Inside a test, refer to the special name TypeParam to get the type - // parameter. Since we are inside a derived class template, C++ requires - // us to visit the members of MyFixture via 'this'. - TypeParam n = this->value_; - - // To visit static members of the fixture, add the 'TestFixture::' - // prefix. - n += TestFixture::shared_; - - // To refer to typedefs in the fixture, add the 'typename TestFixture::' - // prefix. The 'typename' is required to satisfy the compiler. - typename TestFixture::List values; - - values.push_back(n); - ... -} -``` - -For more information, see [Typed Tests](../advanced.md#typed-tests). - -### TYPED_TEST_SUITE_P {#TYPED_TEST_SUITE_P} - -`TYPED_TEST_SUITE_P(`*`TestFixtureName`*`)` - -Defines a type-parameterized test suite based on the test fixture -*`TestFixtureName`*. The test suite name is *`TestFixtureName`*. - -The argument *`TestFixtureName`* is a fixture class template, parameterized by a -type. See [`TYPED_TEST_SUITE`](#TYPED_TEST_SUITE) for an example. - -See also [`TYPED_TEST_P`](#TYPED_TEST_P) and -[Type-Parameterized Tests](../advanced.md#type-parameterized-tests) for more -information. - -### TYPED_TEST_P {#TYPED_TEST_P} - -
    -TYPED_TEST_P(TestSuiteName, TestName) {
-  ... statements ...
-}
-
    - -Defines an individual type-parameterized test named *`TestName`* in the -type-parameterized test suite *`TestSuiteName`*. The test suite must be defined -with [`TYPED_TEST_SUITE_P`](#TYPED_TEST_SUITE_P). - -Within the test body, the special name `TypeParam` refers to the type parameter, -and `TestFixture` refers to the fixture class. See [`TYPED_TEST`](#TYPED_TEST) -for an example. - -See also [`REGISTER_TYPED_TEST_SUITE_P`](#REGISTER_TYPED_TEST_SUITE_P) and -[Type-Parameterized Tests](../advanced.md#type-parameterized-tests) for more -information. - -### REGISTER_TYPED_TEST_SUITE_P {#REGISTER_TYPED_TEST_SUITE_P} - -`REGISTER_TYPED_TEST_SUITE_P(`*`TestSuiteName`*`,`*`TestNames...`*`)` - -Registers the type-parameterized tests *`TestNames...`* of the test suite -*`TestSuiteName`*. The test suite and tests must be defined with -[`TYPED_TEST_SUITE_P`](#TYPED_TEST_SUITE_P) and [`TYPED_TEST_P`](#TYPED_TEST_P). - -For example: - -```cpp -// Define the test suite and tests. -TYPED_TEST_SUITE_P(MyFixture); -TYPED_TEST_P(MyFixture, HasPropertyA) { ... } -TYPED_TEST_P(MyFixture, HasPropertyB) { ... } - -// Register the tests in the test suite. -REGISTER_TYPED_TEST_SUITE_P(MyFixture, HasPropertyA, HasPropertyB); -``` - -See also [`INSTANTIATE_TYPED_TEST_SUITE_P`](#INSTANTIATE_TYPED_TEST_SUITE_P) and -[Type-Parameterized Tests](../advanced.md#type-parameterized-tests) for more -information. - -### INSTANTIATE_TYPED_TEST_SUITE_P {#INSTANTIATE_TYPED_TEST_SUITE_P} - -`INSTANTIATE_TYPED_TEST_SUITE_P(`*`InstantiationName`*`,`*`TestSuiteName`*`,`*`Types`*`)` - -Instantiates the type-parameterized test suite *`TestSuiteName`*. The test suite -must be registered with -[`REGISTER_TYPED_TEST_SUITE_P`](#REGISTER_TYPED_TEST_SUITE_P). - -The argument *`InstantiationName`* is a unique name for the instantiation of the -test suite, to distinguish between multiple instantiations. In test output, the -instantiation name is added as a prefix to the test suite name -*`TestSuiteName`*. - -The argument *`Types`* is a [`Types`](#Types) object representing the list of -types to run the tests on, for example: - -```cpp -using MyTypes = ::testing::Types; -INSTANTIATE_TYPED_TEST_SUITE_P(MyInstantiation, MyFixture, MyTypes); -``` - -The type alias (`using` or `typedef`) is necessary for the -`INSTANTIATE_TYPED_TEST_SUITE_P` macro to parse correctly. - -For more information, see -[Type-Parameterized Tests](../advanced.md#type-parameterized-tests). - -### FRIEND_TEST {#FRIEND_TEST} - -`FRIEND_TEST(`*`TestSuiteName`*`,`*`TestName`*`)` - -Within a class body, declares an individual test as a friend of the class, -enabling the test to access private class members. - -If the class is defined in a namespace, then in order to be friends of the -class, test fixtures and tests must be defined in the exact same namespace, -without inline or anonymous namespaces. - -For example, if the class definition looks like the following: - -```cpp -namespace my_namespace { - -class MyClass { - friend class MyClassTest; - FRIEND_TEST(MyClassTest, HasPropertyA); - FRIEND_TEST(MyClassTest, HasPropertyB); - ... definition of class MyClass ... -}; - -} // namespace my_namespace -``` - -Then the test code should look like: - -```cpp -namespace my_namespace { - -class MyClassTest : public ::testing::Test { - ... -}; - -TEST_F(MyClassTest, HasPropertyA) { ... } -TEST_F(MyClassTest, HasPropertyB) { ... } - -} // namespace my_namespace -``` - -See [Testing Private Code](../advanced.md#testing-private-code) for more -information. - -### SCOPED_TRACE {#SCOPED_TRACE} - -`SCOPED_TRACE(`*`message`*`)` - -Causes the current file name, line number, and the given message *`message`* to -be added to the failure message for each assertion failure that occurs in the -scope. - -For more information, see -[Adding Traces to Assertions](../advanced.md#adding-traces-to-assertions). - -See also the [`ScopedTrace` class](#ScopedTrace). - -### GTEST_SKIP {#GTEST_SKIP} - -`GTEST_SKIP()` - -Prevents further test execution at runtime. - -Can be used in individual test cases or in the `SetUp()` methods of test -environments or test fixtures (classes derived from the -[`Environment`](#Environment) or [`Test`](#Test) classes). If used in a global -test environment `SetUp()` method, it skips all tests in the test program. If -used in a test fixture `SetUp()` method, it skips all tests in the corresponding -test suite. - -Similar to assertions, `GTEST_SKIP` allows streaming a custom message into it. - -See [Skipping Test Execution](../advanced.md#skipping-test-execution) for more -information. - -### GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST {#GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST} - -`GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST(`*`TestSuiteName`*`)` - -Allows the value-parameterized test suite *`TestSuiteName`* to be -uninstantiated. - -By default, every [`TEST_P`](#TEST_P) call without a corresponding -[`INSTANTIATE_TEST_SUITE_P`](#INSTANTIATE_TEST_SUITE_P) call causes a failing -test in the test suite `GoogleTestVerification`. -`GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST` suppresses this failure for the -given test suite. - -## Classes and types - -GoogleTest defines the following classes and types to help with writing tests. - -### AssertionResult {#AssertionResult} - -`::testing::AssertionResult` - -A class for indicating whether an assertion was successful. - -When the assertion wasn't successful, the `AssertionResult` object stores a -non-empty failure message that can be retrieved with the object's `message()` -method. - -To create an instance of this class, use one of the factory functions -[`AssertionSuccess()`](#AssertionSuccess) or -[`AssertionFailure()`](#AssertionFailure). - -### AssertionException {#AssertionException} - -`::testing::AssertionException` - -Exception which can be thrown from -[`TestEventListener::OnTestPartResult`](#TestEventListener::OnTestPartResult). - -### EmptyTestEventListener {#EmptyTestEventListener} - -`::testing::EmptyTestEventListener` - -Provides an empty implementation of all methods in the -[`TestEventListener`](#TestEventListener) interface, such that a subclass only -needs to override the methods it cares about. - -### Environment {#Environment} - -`::testing::Environment` - -Represents a global test environment. See -[Global Set-Up and Tear-Down](../advanced.md#global-set-up-and-tear-down). - -#### Protected Methods {#Environment-protected} - -##### SetUp {#Environment::SetUp} - -`virtual void Environment::SetUp()` - -Override this to define how to set up the environment. - -##### TearDown {#Environment::TearDown} - -`virtual void Environment::TearDown()` - -Override this to define how to tear down the environment. - -### ScopedTrace {#ScopedTrace} - -`::testing::ScopedTrace` - -An instance of this class causes a trace to be included in every test failure -message generated by code in the scope of the lifetime of the `ScopedTrace` -instance. The effect is undone with the destruction of the instance. - -The `ScopedTrace` constructor has the following form: - -```cpp -template -ScopedTrace(const char* file, int line, const T& message) -``` - -Example usage: - -```cpp -::testing::ScopedTrace trace("file.cc", 123, "message"); -``` - -The resulting trace includes the given source file path and line number, and the -given message. The `message` argument can be anything streamable to -`std::ostream`. - -See also [`SCOPED_TRACE`](#SCOPED_TRACE). - -### Test {#Test} - -`::testing::Test` - -The abstract class that all tests inherit from. `Test` is not copyable. - -#### Public Methods {#Test-public} - -##### SetUpTestSuite {#Test::SetUpTestSuite} - -`static void Test::SetUpTestSuite()` - -Performs shared setup for all tests in the test suite. GoogleTest calls -`SetUpTestSuite()` before running the first test in the test suite. - -##### TearDownTestSuite {#Test::TearDownTestSuite} - -`static void Test::TearDownTestSuite()` - -Performs shared teardown for all tests in the test suite. GoogleTest calls -`TearDownTestSuite()` after running the last test in the test suite. - -##### HasFatalFailure {#Test::HasFatalFailure} - -`static bool Test::HasFatalFailure()` - -Returns true if and only if the current test has a fatal failure. - -##### HasNonfatalFailure {#Test::HasNonfatalFailure} - -`static bool Test::HasNonfatalFailure()` - -Returns true if and only if the current test has a nonfatal failure. - -##### HasFailure {#Test::HasFailure} - -`static bool Test::HasFailure()` - -Returns true if and only if the current test has any failure, either fatal or -nonfatal. - -##### IsSkipped {#Test::IsSkipped} - -`static bool Test::IsSkipped()` - -Returns true if and only if the current test was skipped. - -##### RecordProperty {#Test::RecordProperty} - -`static void Test::RecordProperty(const std::string& key, const std::string& -value)` \ -`static void Test::RecordProperty(const std::string& key, int value)` - -Logs a property for the current test, test suite, or entire invocation of the -test program. Only the last value for a given key is logged. - -The key must be a valid XML attribute name, and cannot conflict with the ones -already used by GoogleTest (`name`, `status`, `time`, `classname`, `type_param`, -and `value_param`). - -`RecordProperty` is `public static` so it can be called from utility functions -that are not members of the test fixture. - -Calls to `RecordProperty` made during the lifespan of the test (from the moment -its constructor starts to the moment its destructor finishes) are output in XML -as attributes of the `` element. Properties recorded from a fixture's -`SetUpTestSuite` or `TearDownTestSuite` methods are logged as attributes of the -corresponding `` element. Calls to `RecordProperty` made in the -global context (before or after invocation of `RUN_ALL_TESTS` or from the -`SetUp`/`TearDown` methods of registered `Environment` objects) are output as -attributes of the `` element. - -#### Protected Methods {#Test-protected} - -##### SetUp {#Test::SetUp} - -`virtual void Test::SetUp()` - -Override this to perform test fixture setup. GoogleTest calls `SetUp()` before -running each individual test. - -##### TearDown {#Test::TearDown} - -`virtual void Test::TearDown()` - -Override this to perform test fixture teardown. GoogleTest calls `TearDown()` -after running each individual test. - -### TestWithParam {#TestWithParam} - -`::testing::TestWithParam` - -A convenience class which inherits from both [`Test`](#Test) and -[`WithParamInterface`](#WithParamInterface). - -### TestSuite {#TestSuite} - -Represents a test suite. `TestSuite` is not copyable. - -#### Public Methods {#TestSuite-public} - -##### name {#TestSuite::name} - -`const char* TestSuite::name() const` - -Gets the name of the test suite. - -##### type_param {#TestSuite::type_param} - -`const char* TestSuite::type_param() const` - -Returns the name of the parameter type, or `NULL` if this is not a typed or -type-parameterized test suite. See [Typed Tests](../advanced.md#typed-tests) and -[Type-Parameterized Tests](../advanced.md#type-parameterized-tests). - -##### should_run {#TestSuite::should_run} - -`bool TestSuite::should_run() const` - -Returns true if any test in this test suite should run. - -##### successful_test_count {#TestSuite::successful_test_count} - -`int TestSuite::successful_test_count() const` - -Gets the number of successful tests in this test suite. - -##### skipped_test_count {#TestSuite::skipped_test_count} - -`int TestSuite::skipped_test_count() const` - -Gets the number of skipped tests in this test suite. - -##### failed_test_count {#TestSuite::failed_test_count} - -`int TestSuite::failed_test_count() const` - -Gets the number of failed tests in this test suite. - -##### reportable_disabled_test_count {#TestSuite::reportable_disabled_test_count} - -`int TestSuite::reportable_disabled_test_count() const` - -Gets the number of disabled tests that will be reported in the XML report. - -##### disabled_test_count {#TestSuite::disabled_test_count} - -`int TestSuite::disabled_test_count() const` - -Gets the number of disabled tests in this test suite. - -##### reportable_test_count {#TestSuite::reportable_test_count} - -`int TestSuite::reportable_test_count() const` - -Gets the number of tests to be printed in the XML report. - -##### test_to_run_count {#TestSuite::test_to_run_count} - -`int TestSuite::test_to_run_count() const` - -Get the number of tests in this test suite that should run. - -##### total_test_count {#TestSuite::total_test_count} - -`int TestSuite::total_test_count() const` - -Gets the number of all tests in this test suite. - -##### Passed {#TestSuite::Passed} - -`bool TestSuite::Passed() const` - -Returns true if and only if the test suite passed. - -##### Failed {#TestSuite::Failed} - -`bool TestSuite::Failed() const` - -Returns true if and only if the test suite failed. - -##### elapsed_time {#TestSuite::elapsed_time} - -`TimeInMillis TestSuite::elapsed_time() const` - -Returns the elapsed time, in milliseconds. - -##### start_timestamp {#TestSuite::start_timestamp} - -`TimeInMillis TestSuite::start_timestamp() const` - -Gets the time of the test suite start, in ms from the start of the UNIX epoch. - -##### GetTestInfo {#TestSuite::GetTestInfo} - -`const TestInfo* TestSuite::GetTestInfo(int i) const` - -Returns the [`TestInfo`](#TestInfo) for the `i`-th test among all the tests. `i` -can range from 0 to `total_test_count() - 1`. If `i` is not in that range, -returns `NULL`. - -##### ad_hoc_test_result {#TestSuite::ad_hoc_test_result} - -`const TestResult& TestSuite::ad_hoc_test_result() const` - -Returns the [`TestResult`](#TestResult) that holds test properties recorded -during execution of `SetUpTestSuite` and `TearDownTestSuite`. - -### TestInfo {#TestInfo} - -`::testing::TestInfo` - -Stores information about a test. - -#### Public Methods {#TestInfo-public} - -##### test_suite_name {#TestInfo::test_suite_name} - -`const char* TestInfo::test_suite_name() const` - -Returns the test suite name. - -##### name {#TestInfo::name} - -`const char* TestInfo::name() const` - -Returns the test name. - -##### type_param {#TestInfo::type_param} - -`const char* TestInfo::type_param() const` - -Returns the name of the parameter type, or `NULL` if this is not a typed or -type-parameterized test. See [Typed Tests](../advanced.md#typed-tests) and -[Type-Parameterized Tests](../advanced.md#type-parameterized-tests). - -##### value_param {#TestInfo::value_param} - -`const char* TestInfo::value_param() const` - -Returns the text representation of the value parameter, or `NULL` if this is not -a value-parameterized test. See -[Value-Parameterized Tests](../advanced.md#value-parameterized-tests). - -##### file {#TestInfo::file} - -`const char* TestInfo::file() const` - -Returns the file name where this test is defined. - -##### line {#TestInfo::line} - -`int TestInfo::line() const` - -Returns the line where this test is defined. - -##### is_in_another_shard {#TestInfo::is_in_another_shard} - -`bool TestInfo::is_in_another_shard() const` - -Returns true if this test should not be run because it's in another shard. - -##### should_run {#TestInfo::should_run} - -`bool TestInfo::should_run() const` - -Returns true if this test should run, that is if the test is not disabled (or it -is disabled but the `also_run_disabled_tests` flag has been specified) and its -full name matches the user-specified filter. - -GoogleTest allows the user to filter the tests by their full names. Only the -tests that match the filter will run. See -[Running a Subset of the Tests](../advanced.md#running-a-subset-of-the-tests) -for more information. - -##### is_reportable {#TestInfo::is_reportable} - -`bool TestInfo::is_reportable() const` - -Returns true if and only if this test will appear in the XML report. - -##### result {#TestInfo::result} - -`const TestResult* TestInfo::result() const` - -Returns the result of the test. See [`TestResult`](#TestResult). - -### TestParamInfo {#TestParamInfo} - -`::testing::TestParamInfo` - -Describes a parameter to a value-parameterized test. The type `T` is the type of -the parameter. - -Contains the fields `param` and `index` which hold the value of the parameter -and its integer index respectively. - -### UnitTest {#UnitTest} - -`::testing::UnitTest` - -This class contains information about the test program. - -`UnitTest` is a singleton class. The only instance is created when -`UnitTest::GetInstance()` is first called. This instance is never deleted. - -`UnitTest` is not copyable. - -#### Public Methods {#UnitTest-public} - -##### GetInstance {#UnitTest::GetInstance} - -`static UnitTest* UnitTest::GetInstance()` - -Gets the singleton `UnitTest` object. The first time this method is called, a -`UnitTest` object is constructed and returned. Consecutive calls will return the -same object. - -##### original_working_dir {#UnitTest::original_working_dir} - -`const char* UnitTest::original_working_dir() const` - -Returns the working directory when the first [`TEST()`](#TEST) or -[`TEST_F()`](#TEST_F) was executed. The `UnitTest` object owns the string. - -##### current_test_suite {#UnitTest::current_test_suite} - -`const TestSuite* UnitTest::current_test_suite() const` - -Returns the [`TestSuite`](#TestSuite) object for the test that's currently -running, or `NULL` if no test is running. - -##### current_test_info {#UnitTest::current_test_info} - -`const TestInfo* UnitTest::current_test_info() const` - -Returns the [`TestInfo`](#TestInfo) object for the test that's currently -running, or `NULL` if no test is running. - -##### random_seed {#UnitTest::random_seed} - -`int UnitTest::random_seed() const` - -Returns the random seed used at the start of the current test run. - -##### successful_test_suite_count {#UnitTest::successful_test_suite_count} - -`int UnitTest::successful_test_suite_count() const` - -Gets the number of successful test suites. - -##### failed_test_suite_count {#UnitTest::failed_test_suite_count} - -`int UnitTest::failed_test_suite_count() const` - -Gets the number of failed test suites. - -##### total_test_suite_count {#UnitTest::total_test_suite_count} - -`int UnitTest::total_test_suite_count() const` - -Gets the number of all test suites. - -##### test_suite_to_run_count {#UnitTest::test_suite_to_run_count} - -`int UnitTest::test_suite_to_run_count() const` - -Gets the number of all test suites that contain at least one test that should -run. - -##### successful_test_count {#UnitTest::successful_test_count} - -`int UnitTest::successful_test_count() const` - -Gets the number of successful tests. - -##### skipped_test_count {#UnitTest::skipped_test_count} - -`int UnitTest::skipped_test_count() const` - -Gets the number of skipped tests. - -##### failed_test_count {#UnitTest::failed_test_count} - -`int UnitTest::failed_test_count() const` - -Gets the number of failed tests. - -##### reportable_disabled_test_count {#UnitTest::reportable_disabled_test_count} - -`int UnitTest::reportable_disabled_test_count() const` - -Gets the number of disabled tests that will be reported in the XML report. - -##### disabled_test_count {#UnitTest::disabled_test_count} - -`int UnitTest::disabled_test_count() const` - -Gets the number of disabled tests. - -##### reportable_test_count {#UnitTest::reportable_test_count} - -`int UnitTest::reportable_test_count() const` - -Gets the number of tests to be printed in the XML report. - -##### total_test_count {#UnitTest::total_test_count} - -`int UnitTest::total_test_count() const` - -Gets the number of all tests. - -##### test_to_run_count {#UnitTest::test_to_run_count} - -`int UnitTest::test_to_run_count() const` - -Gets the number of tests that should run. - -##### start_timestamp {#UnitTest::start_timestamp} - -`TimeInMillis UnitTest::start_timestamp() const` - -Gets the time of the test program start, in ms from the start of the UNIX epoch. - -##### elapsed_time {#UnitTest::elapsed_time} - -`TimeInMillis UnitTest::elapsed_time() const` - -Gets the elapsed time, in milliseconds. - -##### Passed {#UnitTest::Passed} - -`bool UnitTest::Passed() const` - -Returns true if and only if the unit test passed (i.e. all test suites passed). - -##### Failed {#UnitTest::Failed} - -`bool UnitTest::Failed() const` - -Returns true if and only if the unit test failed (i.e. some test suite failed or -something outside of all tests failed). - -##### GetTestSuite {#UnitTest::GetTestSuite} - -`const TestSuite* UnitTest::GetTestSuite(int i) const` - -Gets the [`TestSuite`](#TestSuite) object for the `i`-th test suite among all -the test suites. `i` can range from 0 to `total_test_suite_count() - 1`. If `i` -is not in that range, returns `NULL`. - -##### ad_hoc_test_result {#UnitTest::ad_hoc_test_result} - -`const TestResult& UnitTest::ad_hoc_test_result() const` - -Returns the [`TestResult`](#TestResult) containing information on test failures -and properties logged outside of individual test suites. - -##### listeners {#UnitTest::listeners} - -`TestEventListeners& UnitTest::listeners()` - -Returns the list of event listeners that can be used to track events inside -GoogleTest. See [`TestEventListeners`](#TestEventListeners). - -### TestEventListener {#TestEventListener} - -`::testing::TestEventListener` - -The interface for tracing execution of tests. The methods below are listed in -the order the corresponding events are fired. - -#### Public Methods {#TestEventListener-public} - -##### OnTestProgramStart {#TestEventListener::OnTestProgramStart} - -`virtual void TestEventListener::OnTestProgramStart(const UnitTest& unit_test)` - -Fired before any test activity starts. - -##### OnTestIterationStart {#TestEventListener::OnTestIterationStart} - -`virtual void TestEventListener::OnTestIterationStart(const UnitTest& unit_test, -int iteration)` - -Fired before each iteration of tests starts. There may be more than one -iteration if `GTEST_FLAG(repeat)` is set. `iteration` is the iteration index, -starting from 0. - -##### OnEnvironmentsSetUpStart {#TestEventListener::OnEnvironmentsSetUpStart} - -`virtual void TestEventListener::OnEnvironmentsSetUpStart(const UnitTest& -unit_test)` - -Fired before environment set-up for each iteration of tests starts. - -##### OnEnvironmentsSetUpEnd {#TestEventListener::OnEnvironmentsSetUpEnd} - -`virtual void TestEventListener::OnEnvironmentsSetUpEnd(const UnitTest& -unit_test)` - -Fired after environment set-up for each iteration of tests ends. - -##### OnTestSuiteStart {#TestEventListener::OnTestSuiteStart} - -`virtual void TestEventListener::OnTestSuiteStart(const TestSuite& test_suite)` - -Fired before the test suite starts. - -##### OnTestStart {#TestEventListener::OnTestStart} - -`virtual void TestEventListener::OnTestStart(const TestInfo& test_info)` - -Fired before the test starts. - -##### OnTestPartResult {#TestEventListener::OnTestPartResult} - -`virtual void TestEventListener::OnTestPartResult(const TestPartResult& -test_part_result)` - -Fired after a failed assertion or a `SUCCEED()` invocation. If you want to throw -an exception from this function to skip to the next test, it must be an -[`AssertionException`](#AssertionException) or inherited from it. - -##### OnTestEnd {#TestEventListener::OnTestEnd} - -`virtual void TestEventListener::OnTestEnd(const TestInfo& test_info)` - -Fired after the test ends. - -##### OnTestSuiteEnd {#TestEventListener::OnTestSuiteEnd} - -`virtual void TestEventListener::OnTestSuiteEnd(const TestSuite& test_suite)` - -Fired after the test suite ends. - -##### OnEnvironmentsTearDownStart {#TestEventListener::OnEnvironmentsTearDownStart} - -`virtual void TestEventListener::OnEnvironmentsTearDownStart(const UnitTest& -unit_test)` - -Fired before environment tear-down for each iteration of tests starts. - -##### OnEnvironmentsTearDownEnd {#TestEventListener::OnEnvironmentsTearDownEnd} - -`virtual void TestEventListener::OnEnvironmentsTearDownEnd(const UnitTest& -unit_test)` - -Fired after environment tear-down for each iteration of tests ends. - -##### OnTestIterationEnd {#TestEventListener::OnTestIterationEnd} - -`virtual void TestEventListener::OnTestIterationEnd(const UnitTest& unit_test, -int iteration)` - -Fired after each iteration of tests finishes. - -##### OnTestProgramEnd {#TestEventListener::OnTestProgramEnd} - -`virtual void TestEventListener::OnTestProgramEnd(const UnitTest& unit_test)` - -Fired after all test activities have ended. - -### TestEventListeners {#TestEventListeners} - -`::testing::TestEventListeners` - -Lets users add listeners to track events in GoogleTest. - -#### Public Methods {#TestEventListeners-public} - -##### Append {#TestEventListeners::Append} - -`void TestEventListeners::Append(TestEventListener* listener)` - -Appends an event listener to the end of the list. GoogleTest assumes ownership -of the listener (i.e. it will delete the listener when the test program -finishes). - -##### Release {#TestEventListeners::Release} - -`TestEventListener* TestEventListeners::Release(TestEventListener* listener)` - -Removes the given event listener from the list and returns it. It then becomes -the caller's responsibility to delete the listener. Returns `NULL` if the -listener is not found in the list. - -##### default_result_printer {#TestEventListeners::default_result_printer} - -`TestEventListener* TestEventListeners::default_result_printer() const` - -Returns the standard listener responsible for the default console output. Can be -removed from the listeners list to shut down default console output. Note that -removing this object from the listener list with -[`Release()`](#TestEventListeners::Release) transfers its ownership to the -caller and makes this function return `NULL` the next time. - -##### default_xml_generator {#TestEventListeners::default_xml_generator} - -`TestEventListener* TestEventListeners::default_xml_generator() const` - -Returns the standard listener responsible for the default XML output controlled -by the `--gtest_output=xml` flag. Can be removed from the listeners list by -users who want to shut down the default XML output controlled by this flag and -substitute it with custom one. Note that removing this object from the listener -list with [`Release()`](#TestEventListeners::Release) transfers its ownership to -the caller and makes this function return `NULL` the next time. - -### TestPartResult {#TestPartResult} - -`::testing::TestPartResult` - -A copyable object representing the result of a test part (i.e. an assertion or -an explicit `FAIL()`, `ADD_FAILURE()`, or `SUCCESS()`). - -#### Public Methods {#TestPartResult-public} - -##### type {#TestPartResult::type} - -`Type TestPartResult::type() const` - -Gets the outcome of the test part. - -The return type `Type` is an enum defined as follows: - -```cpp -enum Type { - kSuccess, // Succeeded. - kNonFatalFailure, // Failed but the test can continue. - kFatalFailure, // Failed and the test should be terminated. - kSkip // Skipped. -}; -``` - -##### file_name {#TestPartResult::file_name} - -`const char* TestPartResult::file_name() const` - -Gets the name of the source file where the test part took place, or `NULL` if -it's unknown. - -##### line_number {#TestPartResult::line_number} - -`int TestPartResult::line_number() const` - -Gets the line in the source file where the test part took place, or `-1` if it's -unknown. - -##### summary {#TestPartResult::summary} - -`const char* TestPartResult::summary() const` - -Gets the summary of the failure message. - -##### message {#TestPartResult::message} - -`const char* TestPartResult::message() const` - -Gets the message associated with the test part. - -##### skipped {#TestPartResult::skipped} - -`bool TestPartResult::skipped() const` - -Returns true if and only if the test part was skipped. - -##### passed {#TestPartResult::passed} - -`bool TestPartResult::passed() const` - -Returns true if and only if the test part passed. - -##### nonfatally_failed {#TestPartResult::nonfatally_failed} - -`bool TestPartResult::nonfatally_failed() const` - -Returns true if and only if the test part non-fatally failed. - -##### fatally_failed {#TestPartResult::fatally_failed} - -`bool TestPartResult::fatally_failed() const` - -Returns true if and only if the test part fatally failed. - -##### failed {#TestPartResult::failed} - -`bool TestPartResult::failed() const` - -Returns true if and only if the test part failed. - -### TestProperty {#TestProperty} - -`::testing::TestProperty` - -A copyable object representing a user-specified test property which can be -output as a key/value string pair. - -#### Public Methods {#TestProperty-public} - -##### key {#key} - -`const char* key() const` - -Gets the user-supplied key. - -##### value {#value} - -`const char* value() const` - -Gets the user-supplied value. - -##### SetValue {#SetValue} - -`void SetValue(const std::string& new_value)` - -Sets a new value, overriding the previous one. - -### TestResult {#TestResult} - -`::testing::TestResult` - -Contains information about the result of a single test. - -`TestResult` is not copyable. - -#### Public Methods {#TestResult-public} - -##### total_part_count {#TestResult::total_part_count} - -`int TestResult::total_part_count() const` - -Gets the number of all test parts. This is the sum of the number of successful -test parts and the number of failed test parts. - -##### test_property_count {#TestResult::test_property_count} - -`int TestResult::test_property_count() const` - -Returns the number of test properties. - -##### Passed {#TestResult::Passed} - -`bool TestResult::Passed() const` - -Returns true if and only if the test passed (i.e. no test part failed). - -##### Skipped {#TestResult::Skipped} - -`bool TestResult::Skipped() const` - -Returns true if and only if the test was skipped. - -##### Failed {#TestResult::Failed} - -`bool TestResult::Failed() const` - -Returns true if and only if the test failed. - -##### HasFatalFailure {#TestResult::HasFatalFailure} - -`bool TestResult::HasFatalFailure() const` - -Returns true if and only if the test fatally failed. - -##### HasNonfatalFailure {#TestResult::HasNonfatalFailure} - -`bool TestResult::HasNonfatalFailure() const` - -Returns true if and only if the test has a non-fatal failure. - -##### elapsed_time {#TestResult::elapsed_time} - -`TimeInMillis TestResult::elapsed_time() const` - -Returns the elapsed time, in milliseconds. - -##### start_timestamp {#TestResult::start_timestamp} - -`TimeInMillis TestResult::start_timestamp() const` - -Gets the time of the test case start, in ms from the start of the UNIX epoch. - -##### GetTestPartResult {#TestResult::GetTestPartResult} - -`const TestPartResult& TestResult::GetTestPartResult(int i) const` - -Returns the [`TestPartResult`](#TestPartResult) for the `i`-th test part result -among all the results. `i` can range from 0 to `total_part_count() - 1`. If `i` -is not in that range, aborts the program. - -##### GetTestProperty {#TestResult::GetTestProperty} - -`const TestProperty& TestResult::GetTestProperty(int i) const` - -Returns the [`TestProperty`](#TestProperty) object for the `i`-th test property. -`i` can range from 0 to `test_property_count() - 1`. If `i` is not in that -range, aborts the program. - -### TimeInMillis {#TimeInMillis} - -`::testing::TimeInMillis` - -An integer type representing time in milliseconds. - -### Types {#Types} - -`::testing::Types` - -Represents a list of types for use in typed tests and type-parameterized tests. - -The template argument `T...` can be any number of types, for example: - -``` -::testing::Types -``` - -See [Typed Tests](../advanced.md#typed-tests) and -[Type-Parameterized Tests](../advanced.md#type-parameterized-tests) for more -information. - -### WithParamInterface {#WithParamInterface} - -`::testing::WithParamInterface` - -The pure interface class that all value-parameterized tests inherit from. - -A value-parameterized test fixture class must inherit from both [`Test`](#Test) -and `WithParamInterface`. In most cases that just means inheriting from -[`TestWithParam`](#TestWithParam), but more complicated test hierarchies may -need to inherit from `Test` and `WithParamInterface` at different levels. - -This interface defines the type alias `ParamType` for the parameter type `T` and -has support for accessing the test parameter value via the `GetParam()` method: - -``` -static const ParamType& GetParam() -``` - -For more information, see -[Value-Parameterized Tests](../advanced.md#value-parameterized-tests). - -## Functions - -GoogleTest defines the following functions to help with writing and running -tests. - -### InitGoogleTest {#InitGoogleTest} - -`void ::testing::InitGoogleTest(int* argc, char** argv)` \ -`void ::testing::InitGoogleTest(int* argc, wchar_t** argv)` \ -`void ::testing::InitGoogleTest()` - -Initializes GoogleTest. This must be called before calling -[`RUN_ALL_TESTS()`](#RUN_ALL_TESTS). In particular, it parses the command line -for the flags that GoogleTest recognizes. Whenever a GoogleTest flag is seen, it -is removed from `argv`, and `*argc` is decremented. - -No value is returned. Instead, the GoogleTest flag variables are updated. - -The `InitGoogleTest(int* argc, wchar_t** argv)` overload can be used in Windows -programs compiled in `UNICODE` mode. - -The argument-less `InitGoogleTest()` overload can be used on Arduino/embedded -platforms where there is no `argc`/`argv`. - -### AddGlobalTestEnvironment {#AddGlobalTestEnvironment} - -`Environment* ::testing::AddGlobalTestEnvironment(Environment* env)` - -Adds a test environment to the test program. Must be called before -[`RUN_ALL_TESTS()`](#RUN_ALL_TESTS) is called. See -[Global Set-Up and Tear-Down](../advanced.md#global-set-up-and-tear-down) for -more information. - -See also [`Environment`](#Environment). - -### RegisterTest {#RegisterTest} - -```cpp -template -TestInfo* ::testing::RegisterTest(const char* test_suite_name, const char* test_name, - const char* type_param, const char* value_param, - const char* file, int line, Factory factory) -``` - -Dynamically registers a test with the framework. - -The `factory` argument is a factory callable (move-constructible) object or -function pointer that creates a new instance of the `Test` object. It handles -ownership to the caller. The signature of the callable is `Fixture*()`, where -`Fixture` is the test fixture class for the test. All tests registered with the -same `test_suite_name` must return the same fixture type. This is checked at -runtime. - -The framework will infer the fixture class from the factory and will call the -`SetUpTestSuite` and `TearDownTestSuite` methods for it. - -Must be called before [`RUN_ALL_TESTS()`](#RUN_ALL_TESTS) is invoked, otherwise -behavior is undefined. - -See -[Registering tests programmatically](../advanced.md#registering-tests-programmatically) -for more information. - -### RUN_ALL_TESTS {#RUN_ALL_TESTS} - -`int RUN_ALL_TESTS()` - -Use this function in `main()` to run all tests. It returns `0` if all tests are -successful, or `1` otherwise. - -`RUN_ALL_TESTS()` should be invoked after the command line has been parsed by -[`InitGoogleTest()`](#InitGoogleTest). - -This function was formerly a macro; thus, it is in the global namespace and has -an all-caps name. - -### AssertionSuccess {#AssertionSuccess} - -`AssertionResult ::testing::AssertionSuccess()` - -Creates a successful assertion result. See -[`AssertionResult`](#AssertionResult). - -### AssertionFailure {#AssertionFailure} - -`AssertionResult ::testing::AssertionFailure()` - -Creates a failed assertion result. Use the `<<` operator to store a failure -message: - -```cpp -::testing::AssertionFailure() << "My failure message"; -``` - -See [`AssertionResult`](#AssertionResult). - -### StaticAssertTypeEq {#StaticAssertTypeEq} - -`::testing::StaticAssertTypeEq()` - -Compile-time assertion for type equality. Compiles if and only if `T1` and `T2` -are the same type. The value it returns is irrelevant. - -See [Type Assertions](../advanced.md#type-assertions) for more information. - -### PrintToString {#PrintToString} - -`std::string ::testing::PrintToString(x)` - -Prints any value `x` using GoogleTest's value printer. - -See -[Teaching GoogleTest How to Print Your Values](../advanced.md#teaching-googletest-how-to-print-your-values) -for more information. - -### PrintToStringParamName {#PrintToStringParamName} - -`std::string ::testing::PrintToStringParamName(TestParamInfo& info)` - -A built-in parameterized test name generator which returns the result of -[`PrintToString`](#PrintToString) called on `info.param`. Does not work when the -test parameter is a `std::string` or C string. See -[Specifying Names for Value-Parameterized Test Parameters](../advanced.md#specifying-names-for-value-parameterized-test-parameters) -for more information. - -See also [`TestParamInfo`](#TestParamInfo) and -[`INSTANTIATE_TEST_SUITE_P`](#INSTANTIATE_TEST_SUITE_P). diff --git a/external/googletest/docs/samples.md b/external/googletest/docs/samples.md deleted file mode 100644 index 2d97ca55b2..0000000000 --- a/external/googletest/docs/samples.md +++ /dev/null @@ -1,22 +0,0 @@ -# Googletest Samples - -If you're like us, you'd like to look at -[googletest samples.](https://github.com/google/googletest/tree/master/googletest/samples) -The sample directory has a number of well-commented samples showing how to use a -variety of googletest features. - -* Sample #1 shows the basic steps of using googletest to test C++ functions. -* Sample #2 shows a more complex unit test for a class with multiple member - functions. -* Sample #3 uses a test fixture. -* Sample #4 teaches you how to use googletest and `googletest.h` together to - get the best of both libraries. -* Sample #5 puts shared testing logic in a base test fixture, and reuses it in - derived fixtures. -* Sample #6 demonstrates type-parameterized tests. -* Sample #7 teaches the basics of value-parameterized tests. -* Sample #8 shows using `Combine()` in value-parameterized tests. -* Sample #9 shows use of the listener API to modify Google Test's console - output and the use of its reflection API to inspect test results. -* Sample #10 shows use of the listener API to implement a primitive memory - leak checker. diff --git a/external/googletest/googlemock/CMakeLists.txt b/external/googletest/googlemock/CMakeLists.txt deleted file mode 100644 index e7df8ec53d..0000000000 --- a/external/googletest/googlemock/CMakeLists.txt +++ /dev/null @@ -1,218 +0,0 @@ -######################################################################## -# Note: CMake support is community-based. The maintainers do not use CMake -# internally. -# -# CMake build script for Google Mock. -# -# To run the tests for Google Mock itself on Linux, use 'make test' or -# ctest. You can select which tests to run using 'ctest -R regex'. -# For more options, run 'ctest --help'. - -option(gmock_build_tests "Build all of Google Mock's own tests." OFF) - -# A directory to find Google Test sources. -if (EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/gtest/CMakeLists.txt") - set(gtest_dir gtest) -else() - set(gtest_dir ../googletest) -endif() - -# Defines pre_project_set_up_hermetic_build() and set_up_hermetic_build(). -include("${gtest_dir}/cmake/hermetic_build.cmake" OPTIONAL) - -if (COMMAND pre_project_set_up_hermetic_build) - # Google Test also calls hermetic setup functions from add_subdirectory, - # although its changes will not affect things at the current scope. - pre_project_set_up_hermetic_build() -endif() - -######################################################################## -# -# Project-wide settings - -# Name of the project. -# -# CMake files in this project can refer to the root source directory -# as ${gmock_SOURCE_DIR} and to the root binary directory as -# ${gmock_BINARY_DIR}. -# Language "C" is required for find_package(Threads). -if (CMAKE_VERSION VERSION_LESS 3.0) - project(gmock CXX C) -else() - cmake_policy(SET CMP0048 NEW) - project(gmock VERSION ${GOOGLETEST_VERSION} LANGUAGES CXX C) -endif() -cmake_minimum_required(VERSION 2.8.12) - -if (COMMAND set_up_hermetic_build) - set_up_hermetic_build() -endif() - -# Instructs CMake to process Google Test's CMakeLists.txt and add its -# targets to the current scope. We are placing Google Test's binary -# directory in a subdirectory of our own as VC compilation may break -# if they are the same (the default). -add_subdirectory("${gtest_dir}" "${gmock_BINARY_DIR}/${gtest_dir}") - - -# These commands only run if this is the main project -if(CMAKE_PROJECT_NAME STREQUAL "gmock" OR CMAKE_PROJECT_NAME STREQUAL "googletest-distribution") - # BUILD_SHARED_LIBS is a standard CMake variable, but we declare it here to - # make it prominent in the GUI. - option(BUILD_SHARED_LIBS "Build shared libraries (DLLs)." OFF) -else() - mark_as_advanced(gmock_build_tests) -endif() - -# Although Google Test's CMakeLists.txt calls this function, the -# changes there don't affect the current scope. Therefore we have to -# call it again here. -config_compiler_and_linker() # from ${gtest_dir}/cmake/internal_utils.cmake - -# Adds Google Mock's and Google Test's header directories to the search path. -set(gmock_build_include_dirs - "${gmock_SOURCE_DIR}/include" - "${gmock_SOURCE_DIR}" - "${gtest_SOURCE_DIR}/include" - # This directory is needed to build directly from Google Test sources. - "${gtest_SOURCE_DIR}") -include_directories(${gmock_build_include_dirs}) - -######################################################################## -# -# Defines the gmock & gmock_main libraries. User tests should link -# with one of them. - -# Google Mock libraries. We build them using more strict warnings than what -# are used for other targets, to ensure that Google Mock can be compiled by -# a user aggressive about warnings. -if (MSVC) - cxx_library(gmock - "${cxx_strict}" - "${gtest_dir}/src/gtest-all.cc" - src/gmock-all.cc) - - cxx_library(gmock_main - "${cxx_strict}" - "${gtest_dir}/src/gtest-all.cc" - src/gmock-all.cc - src/gmock_main.cc) -else() - cxx_library(gmock "${cxx_strict}" src/gmock-all.cc) - target_link_libraries(gmock PUBLIC gtest) - set_target_properties(gmock PROPERTIES VERSION ${GOOGLETEST_VERSION}) - cxx_library(gmock_main "${cxx_strict}" src/gmock_main.cc) - target_link_libraries(gmock_main PUBLIC gmock) - set_target_properties(gmock_main PROPERTIES VERSION ${GOOGLETEST_VERSION}) -endif() -# If the CMake version supports it, attach header directory information -# to the targets for when we are part of a parent build (ie being pulled -# in via add_subdirectory() rather than being a standalone build). -if (DEFINED CMAKE_VERSION AND NOT "${CMAKE_VERSION}" VERSION_LESS "2.8.11") - target_include_directories(gmock SYSTEM INTERFACE - "$" - "$/${CMAKE_INSTALL_INCLUDEDIR}>") - target_include_directories(gmock_main SYSTEM INTERFACE - "$" - "$/${CMAKE_INSTALL_INCLUDEDIR}>") -endif() - -######################################################################## -# -# Install rules -install_project(gmock gmock_main) - -######################################################################## -# -# Google Mock's own tests. -# -# You can skip this section if you aren't interested in testing -# Google Mock itself. -# -# The tests are not built by default. To build them, set the -# gmock_build_tests option to ON. You can do it by running ccmake -# or specifying the -Dgmock_build_tests=ON flag when running cmake. - -if (gmock_build_tests) - # This must be set in the root directory for the tests to be run by - # 'make test' or ctest. - enable_testing() - - if (MINGW OR CYGWIN) - if (CMAKE_VERSION VERSION_LESS "2.8.12") - add_compile_options("-Wa,-mbig-obj") - else() - add_definitions("-Wa,-mbig-obj") - endif() - endif() - - ############################################################ - # C++ tests built with standard compiler flags. - - cxx_test(gmock-actions_test gmock_main) - cxx_test(gmock-cardinalities_test gmock_main) - cxx_test(gmock_ex_test gmock_main) - cxx_test(gmock-function-mocker_test gmock_main) - cxx_test(gmock-internal-utils_test gmock_main) - cxx_test(gmock-matchers_test gmock_main) - cxx_test(gmock-more-actions_test gmock_main) - cxx_test(gmock-nice-strict_test gmock_main) - cxx_test(gmock-port_test gmock_main) - cxx_test(gmock-spec-builders_test gmock_main) - cxx_test(gmock_link_test gmock_main test/gmock_link2_test.cc) - cxx_test(gmock_test gmock_main) - - if (DEFINED GTEST_HAS_PTHREAD) - cxx_test(gmock_stress_test gmock) - endif() - - # gmock_all_test is commented to save time building and running tests. - # Uncomment if necessary. - # cxx_test(gmock_all_test gmock_main) - - ############################################################ - # C++ tests built with non-standard compiler flags. - - if (MSVC) - cxx_library(gmock_main_no_exception "${cxx_no_exception}" - "${gtest_dir}/src/gtest-all.cc" src/gmock-all.cc src/gmock_main.cc) - - cxx_library(gmock_main_no_rtti "${cxx_no_rtti}" - "${gtest_dir}/src/gtest-all.cc" src/gmock-all.cc src/gmock_main.cc) - - else() - cxx_library(gmock_main_no_exception "${cxx_no_exception}" src/gmock_main.cc) - target_link_libraries(gmock_main_no_exception PUBLIC gmock) - - cxx_library(gmock_main_no_rtti "${cxx_no_rtti}" src/gmock_main.cc) - target_link_libraries(gmock_main_no_rtti PUBLIC gmock) - endif() - cxx_test_with_flags(gmock-more-actions_no_exception_test "${cxx_no_exception}" - gmock_main_no_exception test/gmock-more-actions_test.cc) - - cxx_test_with_flags(gmock_no_rtti_test "${cxx_no_rtti}" - gmock_main_no_rtti test/gmock-spec-builders_test.cc) - - cxx_shared_library(shared_gmock_main "${cxx_default}" - "${gtest_dir}/src/gtest-all.cc" src/gmock-all.cc src/gmock_main.cc) - - # Tests that a binary can be built with Google Mock as a shared library. On - # some system configurations, it may not possible to run the binary without - # knowing more details about the system configurations. We do not try to run - # this binary. To get a more robust shared library coverage, configure with - # -DBUILD_SHARED_LIBS=ON. - cxx_executable_with_flags(shared_gmock_test_ "${cxx_default}" - shared_gmock_main test/gmock-spec-builders_test.cc) - set_target_properties(shared_gmock_test_ - PROPERTIES - COMPILE_DEFINITIONS "GTEST_LINKED_AS_SHARED_LIBRARY=1") - - ############################################################ - # Python tests. - - cxx_executable(gmock_leak_test_ test gmock_main) - py_test(gmock_leak_test) - - cxx_executable(gmock_output_test_ test gmock) - py_test(gmock_output_test) -endif() diff --git a/external/googletest/googlemock/README.md b/external/googletest/googlemock/README.md deleted file mode 100644 index ead688325d..0000000000 --- a/external/googletest/googlemock/README.md +++ /dev/null @@ -1,44 +0,0 @@ -# Googletest Mocking (gMock) Framework - -### Overview - -Google's framework for writing and using C++ mock classes. It can help you -derive better designs of your system and write better tests. - -It is inspired by: - -* [jMock](http://www.jmock.org/) -* [EasyMock](http://www.easymock.org/) -* [Hamcrest](http://code.google.com/p/hamcrest/) - -It is designed with C++'s specifics in mind. - -gMock: - -- Provides a declarative syntax for defining mocks. -- Can define partial (hybrid) mocks, which are a cross of real and mock - objects. -- Handles functions of arbitrary types and overloaded functions. -- Comes with a rich set of matchers for validating function arguments. -- Uses an intuitive syntax for controlling the behavior of a mock. -- Does automatic verification of expectations (no record-and-replay needed). -- Allows arbitrary (partial) ordering constraints on function calls to be - expressed. -- Lets a user extend it by defining new matchers and actions. -- Does not use exceptions. -- Is easy to learn and use. - -Details and examples can be found here: - -* [gMock for Dummies](https://google.github.io/googletest/gmock_for_dummies.html) -* [Legacy gMock FAQ](https://google.github.io/googletest/gmock_faq.html) -* [gMock Cookbook](https://google.github.io/googletest/gmock_cook_book.html) -* [gMock Cheat Sheet](https://google.github.io/googletest/gmock_cheat_sheet.html) - -Please note that code under scripts/generator/ is from the -[cppclean project](http://code.google.com/p/cppclean/) and under the Apache -License, which is different from GoogleMock's license. - -GoogleMock is a part of -[GoogleTest C++ testing framework](http://github.com/google/googletest/) and a -subject to the same requirements. diff --git a/external/googletest/googlemock/cmake/gmock.pc.in b/external/googletest/googlemock/cmake/gmock.pc.in deleted file mode 100644 index 23c67b5c88..0000000000 --- a/external/googletest/googlemock/cmake/gmock.pc.in +++ /dev/null @@ -1,10 +0,0 @@ -libdir=@CMAKE_INSTALL_FULL_LIBDIR@ -includedir=@CMAKE_INSTALL_FULL_INCLUDEDIR@ - -Name: gmock -Description: GoogleMock (without main() function) -Version: @PROJECT_VERSION@ -URL: https://github.com/google/googletest -Requires: gtest = @PROJECT_VERSION@ -Libs: -L${libdir} -lgmock @CMAKE_THREAD_LIBS_INIT@ -Cflags: -I${includedir} @GTEST_HAS_PTHREAD_MACRO@ diff --git a/external/googletest/googlemock/cmake/gmock_main.pc.in b/external/googletest/googlemock/cmake/gmock_main.pc.in deleted file mode 100644 index 66ffea7f44..0000000000 --- a/external/googletest/googlemock/cmake/gmock_main.pc.in +++ /dev/null @@ -1,10 +0,0 @@ -libdir=@CMAKE_INSTALL_FULL_LIBDIR@ -includedir=@CMAKE_INSTALL_FULL_INCLUDEDIR@ - -Name: gmock_main -Description: GoogleMock (with main() function) -Version: @PROJECT_VERSION@ -URL: https://github.com/google/googletest -Requires: gmock = @PROJECT_VERSION@ -Libs: -L${libdir} -lgmock_main @CMAKE_THREAD_LIBS_INIT@ -Cflags: -I${includedir} @GTEST_HAS_PTHREAD_MACRO@ diff --git a/external/googletest/googlemock/docs/README.md b/external/googletest/googlemock/docs/README.md deleted file mode 100644 index 1bc57b799c..0000000000 --- a/external/googletest/googlemock/docs/README.md +++ /dev/null @@ -1,4 +0,0 @@ -# Content Moved - -We are working on updates to the GoogleTest documentation, which has moved to -the top-level [docs](../../docs) directory. diff --git a/external/googletest/googlemock/include/gmock/gmock-actions.h b/external/googletest/googlemock/include/gmock/gmock-actions.h deleted file mode 100644 index c1cc858375..0000000000 --- a/external/googletest/googlemock/include/gmock/gmock-actions.h +++ /dev/null @@ -1,1690 +0,0 @@ -// Copyright 2007, Google Inc. -// All rights reserved. -// -// Redistribution and use in source and binary forms, with or without -// modification, are permitted provided that the following conditions are -// met: -// -// * Redistributions of source code must retain the above copyright -// notice, this list of conditions and the following disclaimer. -// * Redistributions in binary form must reproduce the above -// copyright notice, this list of conditions and the following disclaimer -// in the documentation and/or other materials provided with the -// distribution. -// * Neither the name of Google Inc. nor the names of its -// contributors may be used to endorse or promote products derived from -// this software without specific prior written permission. -// -// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - -// Google Mock - a framework for writing C++ mock classes. -// -// The ACTION* family of macros can be used in a namespace scope to -// define custom actions easily. The syntax: -// -// ACTION(name) { statements; } -// -// will define an action with the given name that executes the -// statements. The value returned by the statements will be used as -// the return value of the action. Inside the statements, you can -// refer to the K-th (0-based) argument of the mock function by -// 'argK', and refer to its type by 'argK_type'. For example: -// -// ACTION(IncrementArg1) { -// arg1_type temp = arg1; -// return ++(*temp); -// } -// -// allows you to write -// -// ...WillOnce(IncrementArg1()); -// -// You can also refer to the entire argument tuple and its type by -// 'args' and 'args_type', and refer to the mock function type and its -// return type by 'function_type' and 'return_type'. -// -// Note that you don't need to specify the types of the mock function -// arguments. However rest assured that your code is still type-safe: -// you'll get a compiler error if *arg1 doesn't support the ++ -// operator, or if the type of ++(*arg1) isn't compatible with the -// mock function's return type, for example. -// -// Sometimes you'll want to parameterize the action. For that you can use -// another macro: -// -// ACTION_P(name, param_name) { statements; } -// -// For example: -// -// ACTION_P(Add, n) { return arg0 + n; } -// -// will allow you to write: -// -// ...WillOnce(Add(5)); -// -// Note that you don't need to provide the type of the parameter -// either. If you need to reference the type of a parameter named -// 'foo', you can write 'foo_type'. For example, in the body of -// ACTION_P(Add, n) above, you can write 'n_type' to refer to the type -// of 'n'. -// -// We also provide ACTION_P2, ACTION_P3, ..., up to ACTION_P10 to support -// multi-parameter actions. -// -// For the purpose of typing, you can view -// -// ACTION_Pk(Foo, p1, ..., pk) { ... } -// -// as shorthand for -// -// template -// FooActionPk Foo(p1_type p1, ..., pk_type pk) { ... } -// -// In particular, you can provide the template type arguments -// explicitly when invoking Foo(), as in Foo(5, false); -// although usually you can rely on the compiler to infer the types -// for you automatically. You can assign the result of expression -// Foo(p1, ..., pk) to a variable of type FooActionPk. This can be useful when composing actions. -// -// You can also overload actions with different numbers of parameters: -// -// ACTION_P(Plus, a) { ... } -// ACTION_P2(Plus, a, b) { ... } -// -// While it's tempting to always use the ACTION* macros when defining -// a new action, you should also consider implementing ActionInterface -// or using MakePolymorphicAction() instead, especially if you need to -// use the action a lot. While these approaches require more work, -// they give you more control on the types of the mock function -// arguments and the action parameters, which in general leads to -// better compiler error messages that pay off in the long run. They -// also allow overloading actions based on parameter types (as opposed -// to just based on the number of parameters). -// -// CAVEAT: -// -// ACTION*() can only be used in a namespace scope as templates cannot be -// declared inside of a local class. -// Users can, however, define any local functors (e.g. a lambda) that -// can be used as actions. -// -// MORE INFORMATION: -// -// To learn more about using these macros, please search for 'ACTION' on -// https://github.com/google/googletest/blob/master/docs/gmock_cook_book.md - -// GOOGLETEST_CM0002 DO NOT DELETE - -#ifndef GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_ACTIONS_H_ -#define GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_ACTIONS_H_ - -#ifndef _WIN32_WCE -#include -#endif - -#include -#include -#include -#include -#include -#include -#include - -#include "gmock/internal/gmock-internal-utils.h" -#include "gmock/internal/gmock-port.h" -#include "gmock/internal/gmock-pp.h" - -#ifdef _MSC_VER -#pragma warning(push) -#pragma warning(disable : 4100) -#endif - -namespace testing { - -// To implement an action Foo, define: -// 1. a class FooAction that implements the ActionInterface interface, and -// 2. a factory function that creates an Action object from a -// const FooAction*. -// -// The two-level delegation design follows that of Matcher, providing -// consistency for extension developers. It also eases ownership -// management as Action objects can now be copied like plain values. - -namespace internal { - -// BuiltInDefaultValueGetter::Get() returns a -// default-constructed T value. BuiltInDefaultValueGetter::Get() crashes with an error. -// -// This primary template is used when kDefaultConstructible is true. -template -struct BuiltInDefaultValueGetter { - static T Get() { return T(); } -}; -template -struct BuiltInDefaultValueGetter { - static T Get() { - Assert(false, __FILE__, __LINE__, - "Default action undefined for the function return type."); - return internal::Invalid(); - // The above statement will never be reached, but is required in - // order for this function to compile. - } -}; - -// BuiltInDefaultValue::Get() returns the "built-in" default value -// for type T, which is NULL when T is a raw pointer type, 0 when T is -// a numeric type, false when T is bool, or "" when T is string or -// std::string. In addition, in C++11 and above, it turns a -// default-constructed T value if T is default constructible. For any -// other type T, the built-in default T value is undefined, and the -// function will abort the process. -template -class BuiltInDefaultValue { - public: - // This function returns true if and only if type T has a built-in default - // value. - static bool Exists() { return ::std::is_default_constructible::value; } - - static T Get() { - return BuiltInDefaultValueGetter< - T, ::std::is_default_constructible::value>::Get(); - } -}; - -// This partial specialization says that we use the same built-in -// default value for T and const T. -template -class BuiltInDefaultValue { - public: - static bool Exists() { return BuiltInDefaultValue::Exists(); } - static T Get() { return BuiltInDefaultValue::Get(); } -}; - -// This partial specialization defines the default values for pointer -// types. -template -class BuiltInDefaultValue { - public: - static bool Exists() { return true; } - static T* Get() { return nullptr; } -}; - -// The following specializations define the default values for -// specific types we care about. -#define GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(type, value) \ - template <> \ - class BuiltInDefaultValue { \ - public: \ - static bool Exists() { return true; } \ - static type Get() { return value; } \ - } - -GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(void, ); // NOLINT -GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(::std::string, ""); -GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(bool, false); -GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(unsigned char, '\0'); -GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(signed char, '\0'); -GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(char, '\0'); - -// There's no need for a default action for signed wchar_t, as that -// type is the same as wchar_t for gcc, and invalid for MSVC. -// -// There's also no need for a default action for unsigned wchar_t, as -// that type is the same as unsigned int for gcc, and invalid for -// MSVC. -#if GMOCK_WCHAR_T_IS_NATIVE_ -GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(wchar_t, 0U); // NOLINT -#endif - -GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(unsigned short, 0U); // NOLINT -GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(signed short, 0); // NOLINT -GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(unsigned int, 0U); -GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(signed int, 0); -GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(unsigned long, 0UL); // NOLINT -GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(signed long, 0L); // NOLINT -GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(unsigned long long, 0); // NOLINT -GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(signed long long, 0); // NOLINT -GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(float, 0); -GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(double, 0); - -#undef GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_ - -// Simple two-arg form of std::disjunction. -template -using disjunction = typename ::std::conditional::type; - -} // namespace internal - -// When an unexpected function call is encountered, Google Mock will -// let it return a default value if the user has specified one for its -// return type, or if the return type has a built-in default value; -// otherwise Google Mock won't know what value to return and will have -// to abort the process. -// -// The DefaultValue class allows a user to specify the -// default value for a type T that is both copyable and publicly -// destructible (i.e. anything that can be used as a function return -// type). The usage is: -// -// // Sets the default value for type T to be foo. -// DefaultValue::Set(foo); -template -class DefaultValue { - public: - // Sets the default value for type T; requires T to be - // copy-constructable and have a public destructor. - static void Set(T x) { - delete producer_; - producer_ = new FixedValueProducer(x); - } - - // Provides a factory function to be called to generate the default value. - // This method can be used even if T is only move-constructible, but it is not - // limited to that case. - typedef T (*FactoryFunction)(); - static void SetFactory(FactoryFunction factory) { - delete producer_; - producer_ = new FactoryValueProducer(factory); - } - - // Unsets the default value for type T. - static void Clear() { - delete producer_; - producer_ = nullptr; - } - - // Returns true if and only if the user has set the default value for type T. - static bool IsSet() { return producer_ != nullptr; } - - // Returns true if T has a default return value set by the user or there - // exists a built-in default value. - static bool Exists() { - return IsSet() || internal::BuiltInDefaultValue::Exists(); - } - - // Returns the default value for type T if the user has set one; - // otherwise returns the built-in default value. Requires that Exists() - // is true, which ensures that the return value is well-defined. - static T Get() { - return producer_ == nullptr ? internal::BuiltInDefaultValue::Get() - : producer_->Produce(); - } - - private: - class ValueProducer { - public: - virtual ~ValueProducer() {} - virtual T Produce() = 0; - }; - - class FixedValueProducer : public ValueProducer { - public: - explicit FixedValueProducer(T value) : value_(value) {} - T Produce() override { return value_; } - - private: - const T value_; - GTEST_DISALLOW_COPY_AND_ASSIGN_(FixedValueProducer); - }; - - class FactoryValueProducer : public ValueProducer { - public: - explicit FactoryValueProducer(FactoryFunction factory) - : factory_(factory) {} - T Produce() override { return factory_(); } - - private: - const FactoryFunction factory_; - GTEST_DISALLOW_COPY_AND_ASSIGN_(FactoryValueProducer); - }; - - static ValueProducer* producer_; -}; - -// This partial specialization allows a user to set default values for -// reference types. -template -class DefaultValue { - public: - // Sets the default value for type T&. - static void Set(T& x) { // NOLINT - address_ = &x; - } - - // Unsets the default value for type T&. - static void Clear() { address_ = nullptr; } - - // Returns true if and only if the user has set the default value for type T&. - static bool IsSet() { return address_ != nullptr; } - - // Returns true if T has a default return value set by the user or there - // exists a built-in default value. - static bool Exists() { - return IsSet() || internal::BuiltInDefaultValue::Exists(); - } - - // Returns the default value for type T& if the user has set one; - // otherwise returns the built-in default value if there is one; - // otherwise aborts the process. - static T& Get() { - return address_ == nullptr ? internal::BuiltInDefaultValue::Get() - : *address_; - } - - private: - static T* address_; -}; - -// This specialization allows DefaultValue::Get() to -// compile. -template <> -class DefaultValue { - public: - static bool Exists() { return true; } - static void Get() {} -}; - -// Points to the user-set default value for type T. -template -typename DefaultValue::ValueProducer* DefaultValue::producer_ = nullptr; - -// Points to the user-set default value for type T&. -template -T* DefaultValue::address_ = nullptr; - -// Implement this interface to define an action for function type F. -template -class ActionInterface { - public: - typedef typename internal::Function::Result Result; - typedef typename internal::Function::ArgumentTuple ArgumentTuple; - - ActionInterface() {} - virtual ~ActionInterface() {} - - // Performs the action. This method is not const, as in general an - // action can have side effects and be stateful. For example, a - // get-the-next-element-from-the-collection action will need to - // remember the current element. - virtual Result Perform(const ArgumentTuple& args) = 0; - - private: - GTEST_DISALLOW_COPY_AND_ASSIGN_(ActionInterface); -}; - -// An Action is a copyable and IMMUTABLE (except by assignment) -// object that represents an action to be taken when a mock function -// of type F is called. The implementation of Action is just a -// std::shared_ptr to const ActionInterface. Don't inherit from Action! -// You can view an object implementing ActionInterface as a -// concrete action (including its current state), and an Action -// object as a handle to it. -template -class Action { - // Adapter class to allow constructing Action from a legacy ActionInterface. - // New code should create Actions from functors instead. - struct ActionAdapter { - // Adapter must be copyable to satisfy std::function requirements. - ::std::shared_ptr> impl_; - - template - typename internal::Function::Result operator()(Args&&... args) { - return impl_->Perform( - ::std::forward_as_tuple(::std::forward(args)...)); - } - }; - - template - using IsCompatibleFunctor = std::is_constructible, G>; - - public: - typedef typename internal::Function::Result Result; - typedef typename internal::Function::ArgumentTuple ArgumentTuple; - - // Constructs a null Action. Needed for storing Action objects in - // STL containers. - Action() {} - - // Construct an Action from a specified callable. - // This cannot take std::function directly, because then Action would not be - // directly constructible from lambda (it would require two conversions). - template < - typename G, - typename = typename std::enable_if, std::is_constructible, - G>>::value>::type> - Action(G&& fun) { // NOLINT - Init(::std::forward(fun), IsCompatibleFunctor()); - } - - // Constructs an Action from its implementation. - explicit Action(ActionInterface* impl) - : fun_(ActionAdapter{::std::shared_ptr>(impl)}) {} - - // This constructor allows us to turn an Action object into an - // Action, as long as F's arguments can be implicitly converted - // to Func's and Func's return type can be implicitly converted to F's. - template - explicit Action(const Action& action) : fun_(action.fun_) {} - - // Returns true if and only if this is the DoDefault() action. - bool IsDoDefault() const { return fun_ == nullptr; } - - // Performs the action. Note that this method is const even though - // the corresponding method in ActionInterface is not. The reason - // is that a const Action means that it cannot be re-bound to - // another concrete action, not that the concrete action it binds to - // cannot change state. (Think of the difference between a const - // pointer and a pointer to const.) - Result Perform(ArgumentTuple args) const { - if (IsDoDefault()) { - internal::IllegalDoDefault(__FILE__, __LINE__); - } - return internal::Apply(fun_, ::std::move(args)); - } - - private: - template - friend class Action; - - template - void Init(G&& g, ::std::true_type) { - fun_ = ::std::forward(g); - } - - template - void Init(G&& g, ::std::false_type) { - fun_ = IgnoreArgs::type>{::std::forward(g)}; - } - - template - struct IgnoreArgs { - template - Result operator()(const Args&...) const { - return function_impl(); - } - - FunctionImpl function_impl; - }; - - // fun_ is an empty function if and only if this is the DoDefault() action. - ::std::function fun_; -}; - -// The PolymorphicAction class template makes it easy to implement a -// polymorphic action (i.e. an action that can be used in mock -// functions of than one type, e.g. Return()). -// -// To define a polymorphic action, a user first provides a COPYABLE -// implementation class that has a Perform() method template: -// -// class FooAction { -// public: -// template -// Result Perform(const ArgumentTuple& args) const { -// // Processes the arguments and returns a result, using -// // std::get(args) to get the N-th (0-based) argument in the tuple. -// } -// ... -// }; -// -// Then the user creates the polymorphic action using -// MakePolymorphicAction(object) where object has type FooAction. See -// the definition of Return(void) and SetArgumentPointee(value) for -// complete examples. -template -class PolymorphicAction { - public: - explicit PolymorphicAction(const Impl& impl) : impl_(impl) {} - - template - operator Action() const { - return Action(new MonomorphicImpl(impl_)); - } - - private: - template - class MonomorphicImpl : public ActionInterface { - public: - typedef typename internal::Function::Result Result; - typedef typename internal::Function::ArgumentTuple ArgumentTuple; - - explicit MonomorphicImpl(const Impl& impl) : impl_(impl) {} - - Result Perform(const ArgumentTuple& args) override { - return impl_.template Perform(args); - } - - private: - Impl impl_; - }; - - Impl impl_; -}; - -// Creates an Action from its implementation and returns it. The -// created Action object owns the implementation. -template -Action MakeAction(ActionInterface* impl) { - return Action(impl); -} - -// Creates a polymorphic action from its implementation. This is -// easier to use than the PolymorphicAction constructor as it -// doesn't require you to explicitly write the template argument, e.g. -// -// MakePolymorphicAction(foo); -// vs -// PolymorphicAction(foo); -template -inline PolymorphicAction MakePolymorphicAction(const Impl& impl) { - return PolymorphicAction(impl); -} - -namespace internal { - -// Helper struct to specialize ReturnAction to execute a move instead of a copy -// on return. Useful for move-only types, but could be used on any type. -template -struct ByMoveWrapper { - explicit ByMoveWrapper(T value) : payload(std::move(value)) {} - T payload; -}; - -// Implements the polymorphic Return(x) action, which can be used in -// any function that returns the type of x, regardless of the argument -// types. -// -// Note: The value passed into Return must be converted into -// Function::Result when this action is cast to Action rather than -// when that action is performed. This is important in scenarios like -// -// MOCK_METHOD1(Method, T(U)); -// ... -// { -// Foo foo; -// X x(&foo); -// EXPECT_CALL(mock, Method(_)).WillOnce(Return(x)); -// } -// -// In the example above the variable x holds reference to foo which leaves -// scope and gets destroyed. If copying X just copies a reference to foo, -// that copy will be left with a hanging reference. If conversion to T -// makes a copy of foo, the above code is safe. To support that scenario, we -// need to make sure that the type conversion happens inside the EXPECT_CALL -// statement, and conversion of the result of Return to Action is a -// good place for that. -// -// The real life example of the above scenario happens when an invocation -// of gtl::Container() is passed into Return. -// -template -class ReturnAction { - public: - // Constructs a ReturnAction object from the value to be returned. - // 'value' is passed by value instead of by const reference in order - // to allow Return("string literal") to compile. - explicit ReturnAction(R value) : value_(new R(std::move(value))) {} - - // This template type conversion operator allows Return(x) to be - // used in ANY function that returns x's type. - template - operator Action() const { // NOLINT - // Assert statement belongs here because this is the best place to verify - // conditions on F. It produces the clearest error messages - // in most compilers. - // Impl really belongs in this scope as a local class but can't - // because MSVC produces duplicate symbols in different translation units - // in this case. Until MS fixes that bug we put Impl into the class scope - // and put the typedef both here (for use in assert statement) and - // in the Impl class. But both definitions must be the same. - typedef typename Function::Result Result; - GTEST_COMPILE_ASSERT_( - !std::is_reference::value, - use_ReturnRef_instead_of_Return_to_return_a_reference); - static_assert(!std::is_void::value, - "Can't use Return() on an action expected to return `void`."); - return Action(new Impl(value_)); - } - - private: - // Implements the Return(x) action for a particular function type F. - template - class Impl : public ActionInterface { - public: - typedef typename Function::Result Result; - typedef typename Function::ArgumentTuple ArgumentTuple; - - // The implicit cast is necessary when Result has more than one - // single-argument constructor (e.g. Result is std::vector) and R - // has a type conversion operator template. In that case, value_(value) - // won't compile as the compiler doesn't known which constructor of - // Result to call. ImplicitCast_ forces the compiler to convert R to - // Result without considering explicit constructors, thus resolving the - // ambiguity. value_ is then initialized using its copy constructor. - explicit Impl(const std::shared_ptr& value) - : value_before_cast_(*value), - value_(ImplicitCast_(value_before_cast_)) {} - - Result Perform(const ArgumentTuple&) override { return value_; } - - private: - GTEST_COMPILE_ASSERT_(!std::is_reference::value, - Result_cannot_be_a_reference_type); - // We save the value before casting just in case it is being cast to a - // wrapper type. - R value_before_cast_; - Result value_; - - GTEST_DISALLOW_COPY_AND_ASSIGN_(Impl); - }; - - // Partially specialize for ByMoveWrapper. This version of ReturnAction will - // move its contents instead. - template - class Impl, F> : public ActionInterface { - public: - typedef typename Function::Result Result; - typedef typename Function::ArgumentTuple ArgumentTuple; - - explicit Impl(const std::shared_ptr& wrapper) - : performed_(false), wrapper_(wrapper) {} - - Result Perform(const ArgumentTuple&) override { - GTEST_CHECK_(!performed_) - << "A ByMove() action should only be performed once."; - performed_ = true; - return std::move(wrapper_->payload); - } - - private: - bool performed_; - const std::shared_ptr wrapper_; - }; - - const std::shared_ptr value_; -}; - -// Implements the ReturnNull() action. -class ReturnNullAction { - public: - // Allows ReturnNull() to be used in any pointer-returning function. In C++11 - // this is enforced by returning nullptr, and in non-C++11 by asserting a - // pointer type on compile time. - template - static Result Perform(const ArgumentTuple&) { - return nullptr; - } -}; - -// Implements the Return() action. -class ReturnVoidAction { - public: - // Allows Return() to be used in any void-returning function. - template - static void Perform(const ArgumentTuple&) { - static_assert(std::is_void::value, "Result should be void."); - } -}; - -// Implements the polymorphic ReturnRef(x) action, which can be used -// in any function that returns a reference to the type of x, -// regardless of the argument types. -template -class ReturnRefAction { - public: - // Constructs a ReturnRefAction object from the reference to be returned. - explicit ReturnRefAction(T& ref) : ref_(ref) {} // NOLINT - - // This template type conversion operator allows ReturnRef(x) to be - // used in ANY function that returns a reference to x's type. - template - operator Action() const { - typedef typename Function::Result Result; - // Asserts that the function return type is a reference. This - // catches the user error of using ReturnRef(x) when Return(x) - // should be used, and generates some helpful error message. - GTEST_COMPILE_ASSERT_(std::is_reference::value, - use_Return_instead_of_ReturnRef_to_return_a_value); - return Action(new Impl(ref_)); - } - - private: - // Implements the ReturnRef(x) action for a particular function type F. - template - class Impl : public ActionInterface { - public: - typedef typename Function::Result Result; - typedef typename Function::ArgumentTuple ArgumentTuple; - - explicit Impl(T& ref) : ref_(ref) {} // NOLINT - - Result Perform(const ArgumentTuple&) override { return ref_; } - - private: - T& ref_; - }; - - T& ref_; -}; - -// Implements the polymorphic ReturnRefOfCopy(x) action, which can be -// used in any function that returns a reference to the type of x, -// regardless of the argument types. -template -class ReturnRefOfCopyAction { - public: - // Constructs a ReturnRefOfCopyAction object from the reference to - // be returned. - explicit ReturnRefOfCopyAction(const T& value) : value_(value) {} // NOLINT - - // This template type conversion operator allows ReturnRefOfCopy(x) to be - // used in ANY function that returns a reference to x's type. - template - operator Action() const { - typedef typename Function::Result Result; - // Asserts that the function return type is a reference. This - // catches the user error of using ReturnRefOfCopy(x) when Return(x) - // should be used, and generates some helpful error message. - GTEST_COMPILE_ASSERT_( - std::is_reference::value, - use_Return_instead_of_ReturnRefOfCopy_to_return_a_value); - return Action(new Impl(value_)); - } - - private: - // Implements the ReturnRefOfCopy(x) action for a particular function type F. - template - class Impl : public ActionInterface { - public: - typedef typename Function::Result Result; - typedef typename Function::ArgumentTuple ArgumentTuple; - - explicit Impl(const T& value) : value_(value) {} // NOLINT - - Result Perform(const ArgumentTuple&) override { return value_; } - - private: - T value_; - }; - - const T value_; -}; - -// Implements the polymorphic ReturnRoundRobin(v) action, which can be -// used in any function that returns the element_type of v. -template -class ReturnRoundRobinAction { - public: - explicit ReturnRoundRobinAction(std::vector values) { - GTEST_CHECK_(!values.empty()) - << "ReturnRoundRobin requires at least one element."; - state_->values = std::move(values); - } - - template - T operator()(Args&&...) const { - return state_->Next(); - } - - private: - struct State { - T Next() { - T ret_val = values[i++]; - if (i == values.size()) i = 0; - return ret_val; - } - - std::vector values; - size_t i = 0; - }; - std::shared_ptr state_ = std::make_shared(); -}; - -// Implements the polymorphic DoDefault() action. -class DoDefaultAction { - public: - // This template type conversion operator allows DoDefault() to be - // used in any function. - template - operator Action() const { - return Action(); - } // NOLINT -}; - -// Implements the Assign action to set a given pointer referent to a -// particular value. -template -class AssignAction { - public: - AssignAction(T1* ptr, T2 value) : ptr_(ptr), value_(value) {} - - template - void Perform(const ArgumentTuple& /* args */) const { - *ptr_ = value_; - } - - private: - T1* const ptr_; - const T2 value_; -}; - -#if !GTEST_OS_WINDOWS_MOBILE - -// Implements the SetErrnoAndReturn action to simulate return from -// various system calls and libc functions. -template -class SetErrnoAndReturnAction { - public: - SetErrnoAndReturnAction(int errno_value, T result) - : errno_(errno_value), result_(result) {} - template - Result Perform(const ArgumentTuple& /* args */) const { - errno = errno_; - return result_; - } - - private: - const int errno_; - const T result_; -}; - -#endif // !GTEST_OS_WINDOWS_MOBILE - -// Implements the SetArgumentPointee(x) action for any function -// whose N-th argument (0-based) is a pointer to x's type. -template -struct SetArgumentPointeeAction { - A value; - - template - void operator()(const Args&... args) const { - *::std::get(std::tie(args...)) = value; - } -}; - -// Implements the Invoke(object_ptr, &Class::Method) action. -template -struct InvokeMethodAction { - Class* const obj_ptr; - const MethodPtr method_ptr; - - template - auto operator()(Args&&... args) const - -> decltype((obj_ptr->*method_ptr)(std::forward(args)...)) { - return (obj_ptr->*method_ptr)(std::forward(args)...); - } -}; - -// Implements the InvokeWithoutArgs(f) action. The template argument -// FunctionImpl is the implementation type of f, which can be either a -// function pointer or a functor. InvokeWithoutArgs(f) can be used as an -// Action as long as f's type is compatible with F. -template -struct InvokeWithoutArgsAction { - FunctionImpl function_impl; - - // Allows InvokeWithoutArgs(f) to be used as any action whose type is - // compatible with f. - template - auto operator()(const Args&...) -> decltype(function_impl()) { - return function_impl(); - } -}; - -// Implements the InvokeWithoutArgs(object_ptr, &Class::Method) action. -template -struct InvokeMethodWithoutArgsAction { - Class* const obj_ptr; - const MethodPtr method_ptr; - - using ReturnType = - decltype((std::declval()->*std::declval())()); - - template - ReturnType operator()(const Args&...) const { - return (obj_ptr->*method_ptr)(); - } -}; - -// Implements the IgnoreResult(action) action. -template -class IgnoreResultAction { - public: - explicit IgnoreResultAction(const A& action) : action_(action) {} - - template - operator Action() const { - // Assert statement belongs here because this is the best place to verify - // conditions on F. It produces the clearest error messages - // in most compilers. - // Impl really belongs in this scope as a local class but can't - // because MSVC produces duplicate symbols in different translation units - // in this case. Until MS fixes that bug we put Impl into the class scope - // and put the typedef both here (for use in assert statement) and - // in the Impl class. But both definitions must be the same. - typedef typename internal::Function::Result Result; - - // Asserts at compile time that F returns void. - static_assert(std::is_void::value, "Result type should be void."); - - return Action(new Impl(action_)); - } - - private: - template - class Impl : public ActionInterface { - public: - typedef typename internal::Function::Result Result; - typedef typename internal::Function::ArgumentTuple ArgumentTuple; - - explicit Impl(const A& action) : action_(action) {} - - void Perform(const ArgumentTuple& args) override { - // Performs the action and ignores its result. - action_.Perform(args); - } - - private: - // Type OriginalFunction is the same as F except that its return - // type is IgnoredValue. - typedef - typename internal::Function::MakeResultIgnoredValue OriginalFunction; - - const Action action_; - }; - - const A action_; -}; - -template -struct WithArgsAction { - InnerAction action; - - // The inner action could be anything convertible to Action. - // We use the conversion operator to detect the signature of the inner Action. - template - operator Action() const { // NOLINT - using TupleType = std::tuple; - Action::type...)> converted( - action); - - return [converted](Args... args) -> R { - return converted.Perform(std::forward_as_tuple( - std::get(std::forward_as_tuple(std::forward(args)...))...)); - }; - } -}; - -template -struct DoAllAction { - private: - template - using NonFinalType = - typename std::conditional::value, T, const T&>::type; - - template - std::vector Convert(IndexSequence) const { - return {ActionT(std::get(actions))...}; - } - - public: - std::tuple actions; - - template - operator Action() const { // NOLINT - struct Op { - std::vector...)>> converted; - Action last; - R operator()(Args... args) const { - auto tuple_args = std::forward_as_tuple(std::forward(args)...); - for (auto& a : converted) { - a.Perform(tuple_args); - } - return last.Perform(std::move(tuple_args)); - } - }; - return Op{Convert...)>>( - MakeIndexSequence()), - std::get(actions)}; - } -}; - -template -struct ReturnNewAction { - T* operator()() const { - return internal::Apply( - [](const Params&... unpacked_params) { - return new T(unpacked_params...); - }, - params); - } - std::tuple params; -}; - -template -struct ReturnArgAction { - template - auto operator()(const Args&... args) const -> - typename std::tuple_element>::type { - return std::get(std::tie(args...)); - } -}; - -template -struct SaveArgAction { - Ptr pointer; - - template - void operator()(const Args&... args) const { - *pointer = std::get(std::tie(args...)); - } -}; - -template -struct SaveArgPointeeAction { - Ptr pointer; - - template - void operator()(const Args&... args) const { - *pointer = *std::get(std::tie(args...)); - } -}; - -template -struct SetArgRefereeAction { - T value; - - template - void operator()(Args&&... args) const { - using argk_type = - typename ::std::tuple_element>::type; - static_assert(std::is_lvalue_reference::value, - "Argument must be a reference type."); - std::get(std::tie(args...)) = value; - } -}; - -template -struct SetArrayArgumentAction { - I1 first; - I2 last; - - template - void operator()(const Args&... args) const { - auto value = std::get(std::tie(args...)); - for (auto it = first; it != last; ++it, (void)++value) { - *value = *it; - } - } -}; - -template -struct DeleteArgAction { - template - void operator()(const Args&... args) const { - delete std::get(std::tie(args...)); - } -}; - -template -struct ReturnPointeeAction { - Ptr pointer; - template - auto operator()(const Args&...) const -> decltype(*pointer) { - return *pointer; - } -}; - -#if GTEST_HAS_EXCEPTIONS -template -struct ThrowAction { - T exception; - // We use a conversion operator to adapt to any return type. - template - operator Action() const { // NOLINT - T copy = exception; - return [copy](Args...) -> R { throw copy; }; - } -}; -#endif // GTEST_HAS_EXCEPTIONS - -} // namespace internal - -// An Unused object can be implicitly constructed from ANY value. -// This is handy when defining actions that ignore some or all of the -// mock function arguments. For example, given -// -// MOCK_METHOD3(Foo, double(const string& label, double x, double y)); -// MOCK_METHOD3(Bar, double(int index, double x, double y)); -// -// instead of -// -// double DistanceToOriginWithLabel(const string& label, double x, double y) { -// return sqrt(x*x + y*y); -// } -// double DistanceToOriginWithIndex(int index, double x, double y) { -// return sqrt(x*x + y*y); -// } -// ... -// EXPECT_CALL(mock, Foo("abc", _, _)) -// .WillOnce(Invoke(DistanceToOriginWithLabel)); -// EXPECT_CALL(mock, Bar(5, _, _)) -// .WillOnce(Invoke(DistanceToOriginWithIndex)); -// -// you could write -// -// // We can declare any uninteresting argument as Unused. -// double DistanceToOrigin(Unused, double x, double y) { -// return sqrt(x*x + y*y); -// } -// ... -// EXPECT_CALL(mock, Foo("abc", _, _)).WillOnce(Invoke(DistanceToOrigin)); -// EXPECT_CALL(mock, Bar(5, _, _)).WillOnce(Invoke(DistanceToOrigin)); -typedef internal::IgnoredValue Unused; - -// Creates an action that does actions a1, a2, ..., sequentially in -// each invocation. All but the last action will have a readonly view of the -// arguments. -template -internal::DoAllAction::type...> DoAll( - Action&&... action) { - return {std::forward_as_tuple(std::forward(action)...)}; -} - -// WithArg(an_action) creates an action that passes the k-th -// (0-based) argument of the mock function to an_action and performs -// it. It adapts an action accepting one argument to one that accepts -// multiple arguments. For convenience, we also provide -// WithArgs(an_action) (defined below) as a synonym. -template -internal::WithArgsAction::type, k> WithArg( - InnerAction&& action) { - return {std::forward(action)}; -} - -// WithArgs(an_action) creates an action that passes -// the selected arguments of the mock function to an_action and -// performs it. It serves as an adaptor between actions with -// different argument lists. -template -internal::WithArgsAction::type, k, ks...> -WithArgs(InnerAction&& action) { - return {std::forward(action)}; -} - -// WithoutArgs(inner_action) can be used in a mock function with a -// non-empty argument list to perform inner_action, which takes no -// argument. In other words, it adapts an action accepting no -// argument to one that accepts (and ignores) arguments. -template -internal::WithArgsAction::type> WithoutArgs( - InnerAction&& action) { - return {std::forward(action)}; -} - -// Creates an action that returns 'value'. 'value' is passed by value -// instead of const reference - otherwise Return("string literal") -// will trigger a compiler error about using array as initializer. -template -internal::ReturnAction Return(R value) { - return internal::ReturnAction(std::move(value)); -} - -// Creates an action that returns NULL. -inline PolymorphicAction ReturnNull() { - return MakePolymorphicAction(internal::ReturnNullAction()); -} - -// Creates an action that returns from a void function. -inline PolymorphicAction Return() { - return MakePolymorphicAction(internal::ReturnVoidAction()); -} - -// Creates an action that returns the reference to a variable. -template -inline internal::ReturnRefAction ReturnRef(R& x) { // NOLINT - return internal::ReturnRefAction(x); -} - -// Prevent using ReturnRef on reference to temporary. -template -internal::ReturnRefAction ReturnRef(R&&) = delete; - -// Creates an action that returns the reference to a copy of the -// argument. The copy is created when the action is constructed and -// lives as long as the action. -template -inline internal::ReturnRefOfCopyAction ReturnRefOfCopy(const R& x) { - return internal::ReturnRefOfCopyAction(x); -} - -// Modifies the parent action (a Return() action) to perform a move of the -// argument instead of a copy. -// Return(ByMove()) actions can only be executed once and will assert this -// invariant. -template -internal::ByMoveWrapper ByMove(R x) { - return internal::ByMoveWrapper(std::move(x)); -} - -// Creates an action that returns an element of `vals`. Calling this action will -// repeatedly return the next value from `vals` until it reaches the end and -// will restart from the beginning. -template -internal::ReturnRoundRobinAction ReturnRoundRobin(std::vector vals) { - return internal::ReturnRoundRobinAction(std::move(vals)); -} - -// Creates an action that returns an element of `vals`. Calling this action will -// repeatedly return the next value from `vals` until it reaches the end and -// will restart from the beginning. -template -internal::ReturnRoundRobinAction ReturnRoundRobin( - std::initializer_list vals) { - return internal::ReturnRoundRobinAction(std::vector(vals)); -} - -// Creates an action that does the default action for the give mock function. -inline internal::DoDefaultAction DoDefault() { - return internal::DoDefaultAction(); -} - -// Creates an action that sets the variable pointed by the N-th -// (0-based) function argument to 'value'. -template -internal::SetArgumentPointeeAction SetArgPointee(T value) { - return {std::move(value)}; -} - -// The following version is DEPRECATED. -template -internal::SetArgumentPointeeAction SetArgumentPointee(T value) { - return {std::move(value)}; -} - -// Creates an action that sets a pointer referent to a given value. -template -PolymorphicAction> Assign(T1* ptr, T2 val) { - return MakePolymorphicAction(internal::AssignAction(ptr, val)); -} - -#if !GTEST_OS_WINDOWS_MOBILE - -// Creates an action that sets errno and returns the appropriate error. -template -PolymorphicAction> SetErrnoAndReturn( - int errval, T result) { - return MakePolymorphicAction( - internal::SetErrnoAndReturnAction(errval, result)); -} - -#endif // !GTEST_OS_WINDOWS_MOBILE - -// Various overloads for Invoke(). - -// Legacy function. -// Actions can now be implicitly constructed from callables. No need to create -// wrapper objects. -// This function exists for backwards compatibility. -template -typename std::decay::type Invoke(FunctionImpl&& function_impl) { - return std::forward(function_impl); -} - -// Creates an action that invokes the given method on the given object -// with the mock function's arguments. -template -internal::InvokeMethodAction Invoke(Class* obj_ptr, - MethodPtr method_ptr) { - return {obj_ptr, method_ptr}; -} - -// Creates an action that invokes 'function_impl' with no argument. -template -internal::InvokeWithoutArgsAction::type> -InvokeWithoutArgs(FunctionImpl function_impl) { - return {std::move(function_impl)}; -} - -// Creates an action that invokes the given method on the given object -// with no argument. -template -internal::InvokeMethodWithoutArgsAction InvokeWithoutArgs( - Class* obj_ptr, MethodPtr method_ptr) { - return {obj_ptr, method_ptr}; -} - -// Creates an action that performs an_action and throws away its -// result. In other words, it changes the return type of an_action to -// void. an_action MUST NOT return void, or the code won't compile. -template -inline internal::IgnoreResultAction IgnoreResult(const A& an_action) { - return internal::IgnoreResultAction(an_action); -} - -// Creates a reference wrapper for the given L-value. If necessary, -// you can explicitly specify the type of the reference. For example, -// suppose 'derived' is an object of type Derived, ByRef(derived) -// would wrap a Derived&. If you want to wrap a const Base& instead, -// where Base is a base class of Derived, just write: -// -// ByRef(derived) -// -// N.B. ByRef is redundant with std::ref, std::cref and std::reference_wrapper. -// However, it may still be used for consistency with ByMove(). -template -inline ::std::reference_wrapper ByRef(T& l_value) { // NOLINT - return ::std::reference_wrapper(l_value); -} - -// The ReturnNew(a1, a2, ..., a_k) action returns a pointer to a new -// instance of type T, constructed on the heap with constructor arguments -// a1, a2, ..., and a_k. The caller assumes ownership of the returned value. -template -internal::ReturnNewAction::type...> ReturnNew( - Params&&... params) { - return {std::forward_as_tuple(std::forward(params)...)}; -} - -// Action ReturnArg() returns the k-th argument of the mock function. -template -internal::ReturnArgAction ReturnArg() { - return {}; -} - -// Action SaveArg(pointer) saves the k-th (0-based) argument of the -// mock function to *pointer. -template -internal::SaveArgAction SaveArg(Ptr pointer) { - return {pointer}; -} - -// Action SaveArgPointee(pointer) saves the value pointed to -// by the k-th (0-based) argument of the mock function to *pointer. -template -internal::SaveArgPointeeAction SaveArgPointee(Ptr pointer) { - return {pointer}; -} - -// Action SetArgReferee(value) assigns 'value' to the variable -// referenced by the k-th (0-based) argument of the mock function. -template -internal::SetArgRefereeAction::type> SetArgReferee( - T&& value) { - return {std::forward(value)}; -} - -// Action SetArrayArgument(first, last) copies the elements in -// source range [first, last) to the array pointed to by the k-th -// (0-based) argument, which can be either a pointer or an -// iterator. The action does not take ownership of the elements in the -// source range. -template -internal::SetArrayArgumentAction SetArrayArgument(I1 first, - I2 last) { - return {first, last}; -} - -// Action DeleteArg() deletes the k-th (0-based) argument of the mock -// function. -template -internal::DeleteArgAction DeleteArg() { - return {}; -} - -// This action returns the value pointed to by 'pointer'. -template -internal::ReturnPointeeAction ReturnPointee(Ptr pointer) { - return {pointer}; -} - -// Action Throw(exception) can be used in a mock function of any type -// to throw the given exception. Any copyable value can be thrown. -#if GTEST_HAS_EXCEPTIONS -template -internal::ThrowAction::type> Throw(T&& exception) { - return {std::forward(exception)}; -} -#endif // GTEST_HAS_EXCEPTIONS - -namespace internal { - -// A macro from the ACTION* family (defined later in gmock-generated-actions.h) -// defines an action that can be used in a mock function. Typically, -// these actions only care about a subset of the arguments of the mock -// function. For example, if such an action only uses the second -// argument, it can be used in any mock function that takes >= 2 -// arguments where the type of the second argument is compatible. -// -// Therefore, the action implementation must be prepared to take more -// arguments than it needs. The ExcessiveArg type is used to -// represent those excessive arguments. In order to keep the compiler -// error messages tractable, we define it in the testing namespace -// instead of testing::internal. However, this is an INTERNAL TYPE -// and subject to change without notice, so a user MUST NOT USE THIS -// TYPE DIRECTLY. -struct ExcessiveArg {}; - -// Builds an implementation of an Action<> for some particular signature, using -// a class defined by an ACTION* macro. -template -struct ActionImpl; - -template -struct ImplBase { - struct Holder { - // Allows each copy of the Action<> to get to the Impl. - explicit operator const Impl&() const { return *ptr; } - std::shared_ptr ptr; - }; - using type = typename std::conditional::value, - Impl, Holder>::type; -}; - -template -struct ActionImpl : ImplBase::type { - using Base = typename ImplBase::type; - using function_type = R(Args...); - using args_type = std::tuple; - - ActionImpl() = default; // Only defined if appropriate for Base. - explicit ActionImpl(std::shared_ptr impl) : Base{std::move(impl)} {} - - R operator()(Args&&... arg) const { - static constexpr size_t kMaxArgs = - sizeof...(Args) <= 10 ? sizeof...(Args) : 10; - return Apply(MakeIndexSequence{}, - MakeIndexSequence<10 - kMaxArgs>{}, - args_type{std::forward(arg)...}); - } - - template - R Apply(IndexSequence, IndexSequence, - const args_type& args) const { - // Impl need not be specific to the signature of action being implemented; - // only the implementing function body needs to have all of the specific - // types instantiated. Up to 10 of the args that are provided by the - // args_type get passed, followed by a dummy of unspecified type for the - // remainder up to 10 explicit args. - static constexpr ExcessiveArg kExcessArg{}; - return static_cast(*this) - .template gmock_PerformImpl< - /*function_type=*/function_type, /*return_type=*/R, - /*args_type=*/args_type, - /*argN_type=*/ - typename std::tuple_element::type...>( - /*args=*/args, std::get(args)..., - ((void)excess_id, kExcessArg)...); - } -}; - -// Stores a default-constructed Impl as part of the Action<>'s -// std::function<>. The Impl should be trivial to copy. -template -::testing::Action MakeAction() { - return ::testing::Action(ActionImpl()); -} - -// Stores just the one given instance of Impl. -template -::testing::Action MakeAction(std::shared_ptr impl) { - return ::testing::Action(ActionImpl(std::move(impl))); -} - -#define GMOCK_INTERNAL_ARG_UNUSED(i, data, el) \ - , const arg##i##_type& arg##i GTEST_ATTRIBUTE_UNUSED_ -#define GMOCK_ACTION_ARG_TYPES_AND_NAMES_UNUSED_ \ - const args_type& args GTEST_ATTRIBUTE_UNUSED_ GMOCK_PP_REPEAT( \ - GMOCK_INTERNAL_ARG_UNUSED, , 10) - -#define GMOCK_INTERNAL_ARG(i, data, el) , const arg##i##_type& arg##i -#define GMOCK_ACTION_ARG_TYPES_AND_NAMES_ \ - const args_type& args GMOCK_PP_REPEAT(GMOCK_INTERNAL_ARG, , 10) - -#define GMOCK_INTERNAL_TEMPLATE_ARG(i, data, el) , typename arg##i##_type -#define GMOCK_ACTION_TEMPLATE_ARGS_NAMES_ \ - GMOCK_PP_TAIL(GMOCK_PP_REPEAT(GMOCK_INTERNAL_TEMPLATE_ARG, , 10)) - -#define GMOCK_INTERNAL_TYPENAME_PARAM(i, data, param) , typename param##_type -#define GMOCK_ACTION_TYPENAME_PARAMS_(params) \ - GMOCK_PP_TAIL(GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_TYPENAME_PARAM, , params)) - -#define GMOCK_INTERNAL_TYPE_PARAM(i, data, param) , param##_type -#define GMOCK_ACTION_TYPE_PARAMS_(params) \ - GMOCK_PP_TAIL(GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_TYPE_PARAM, , params)) - -#define GMOCK_INTERNAL_TYPE_GVALUE_PARAM(i, data, param) \ - , param##_type gmock_p##i -#define GMOCK_ACTION_TYPE_GVALUE_PARAMS_(params) \ - GMOCK_PP_TAIL(GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_TYPE_GVALUE_PARAM, , params)) - -#define GMOCK_INTERNAL_GVALUE_PARAM(i, data, param) \ - , std::forward(gmock_p##i) -#define GMOCK_ACTION_GVALUE_PARAMS_(params) \ - GMOCK_PP_TAIL(GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_GVALUE_PARAM, , params)) - -#define GMOCK_INTERNAL_INIT_PARAM(i, data, param) \ - , param(::std::forward(gmock_p##i)) -#define GMOCK_ACTION_INIT_PARAMS_(params) \ - GMOCK_PP_TAIL(GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_INIT_PARAM, , params)) - -#define GMOCK_INTERNAL_FIELD_PARAM(i, data, param) param##_type param; -#define GMOCK_ACTION_FIELD_PARAMS_(params) \ - GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_FIELD_PARAM, , params) - -#define GMOCK_INTERNAL_ACTION(name, full_name, params) \ - template \ - class full_name { \ - public: \ - explicit full_name(GMOCK_ACTION_TYPE_GVALUE_PARAMS_(params)) \ - : impl_(std::make_shared( \ - GMOCK_ACTION_GVALUE_PARAMS_(params))) {} \ - full_name(const full_name&) = default; \ - full_name(full_name&&) noexcept = default; \ - template \ - operator ::testing::Action() const { \ - return ::testing::internal::MakeAction(impl_); \ - } \ - \ - private: \ - class gmock_Impl { \ - public: \ - explicit gmock_Impl(GMOCK_ACTION_TYPE_GVALUE_PARAMS_(params)) \ - : GMOCK_ACTION_INIT_PARAMS_(params) {} \ - template \ - return_type gmock_PerformImpl(GMOCK_ACTION_ARG_TYPES_AND_NAMES_) const; \ - GMOCK_ACTION_FIELD_PARAMS_(params) \ - }; \ - std::shared_ptr impl_; \ - }; \ - template \ - inline full_name name( \ - GMOCK_ACTION_TYPE_GVALUE_PARAMS_(params)) { \ - return full_name( \ - GMOCK_ACTION_GVALUE_PARAMS_(params)); \ - } \ - template \ - template \ - return_type full_name::gmock_Impl:: \ - gmock_PerformImpl(GMOCK_ACTION_ARG_TYPES_AND_NAMES_UNUSED_) const - -} // namespace internal - -// Similar to GMOCK_INTERNAL_ACTION, but no bound parameters are stored. -#define ACTION(name) \ - class name##Action { \ - public: \ - explicit name##Action() noexcept {} \ - name##Action(const name##Action&) noexcept {} \ - template \ - operator ::testing::Action() const { \ - return ::testing::internal::MakeAction(); \ - } \ - \ - private: \ - class gmock_Impl { \ - public: \ - template \ - return_type gmock_PerformImpl(GMOCK_ACTION_ARG_TYPES_AND_NAMES_) const; \ - }; \ - }; \ - inline name##Action name() GTEST_MUST_USE_RESULT_; \ - inline name##Action name() { return name##Action(); } \ - template \ - return_type name##Action::gmock_Impl::gmock_PerformImpl( \ - GMOCK_ACTION_ARG_TYPES_AND_NAMES_UNUSED_) const - -#define ACTION_P(name, ...) \ - GMOCK_INTERNAL_ACTION(name, name##ActionP, (__VA_ARGS__)) - -#define ACTION_P2(name, ...) \ - GMOCK_INTERNAL_ACTION(name, name##ActionP2, (__VA_ARGS__)) - -#define ACTION_P3(name, ...) \ - GMOCK_INTERNAL_ACTION(name, name##ActionP3, (__VA_ARGS__)) - -#define ACTION_P4(name, ...) \ - GMOCK_INTERNAL_ACTION(name, name##ActionP4, (__VA_ARGS__)) - -#define ACTION_P5(name, ...) \ - GMOCK_INTERNAL_ACTION(name, name##ActionP5, (__VA_ARGS__)) - -#define ACTION_P6(name, ...) \ - GMOCK_INTERNAL_ACTION(name, name##ActionP6, (__VA_ARGS__)) - -#define ACTION_P7(name, ...) \ - GMOCK_INTERNAL_ACTION(name, name##ActionP7, (__VA_ARGS__)) - -#define ACTION_P8(name, ...) \ - GMOCK_INTERNAL_ACTION(name, name##ActionP8, (__VA_ARGS__)) - -#define ACTION_P9(name, ...) \ - GMOCK_INTERNAL_ACTION(name, name##ActionP9, (__VA_ARGS__)) - -#define ACTION_P10(name, ...) \ - GMOCK_INTERNAL_ACTION(name, name##ActionP10, (__VA_ARGS__)) - -} // namespace testing - -#ifdef _MSC_VER -#pragma warning(pop) -#endif - -#endif // GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_ACTIONS_H_ diff --git a/external/googletest/googlemock/include/gmock/gmock-cardinalities.h b/external/googletest/googlemock/include/gmock/gmock-cardinalities.h deleted file mode 100644 index 5ab906bd05..0000000000 --- a/external/googletest/googlemock/include/gmock/gmock-cardinalities.h +++ /dev/null @@ -1,158 +0,0 @@ -// Copyright 2007, Google Inc. -// All rights reserved. -// -// Redistribution and use in source and binary forms, with or without -// modification, are permitted provided that the following conditions are -// met: -// -// * Redistributions of source code must retain the above copyright -// notice, this list of conditions and the following disclaimer. -// * Redistributions in binary form must reproduce the above -// copyright notice, this list of conditions and the following disclaimer -// in the documentation and/or other materials provided with the -// distribution. -// * Neither the name of Google Inc. nor the names of its -// contributors may be used to endorse or promote products derived from -// this software without specific prior written permission. -// -// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - -// Google Mock - a framework for writing C++ mock classes. -// -// This file implements some commonly used cardinalities. More -// cardinalities can be defined by the user implementing the -// CardinalityInterface interface if necessary. - -// GOOGLETEST_CM0002 DO NOT DELETE - -#ifndef GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_CARDINALITIES_H_ -#define GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_CARDINALITIES_H_ - -#include - -#include -#include // NOLINT - -#include "gmock/internal/gmock-port.h" -#include "gtest/gtest.h" - -GTEST_DISABLE_MSC_WARNINGS_PUSH_(4251 \ -/* class A needs to have dll-interface to be used by clients of class B */) - -namespace testing { - -// To implement a cardinality Foo, define: -// 1. a class FooCardinality that implements the -// CardinalityInterface interface, and -// 2. a factory function that creates a Cardinality object from a -// const FooCardinality*. -// -// The two-level delegation design follows that of Matcher, providing -// consistency for extension developers. It also eases ownership -// management as Cardinality objects can now be copied like plain values. - -// The implementation of a cardinality. -class CardinalityInterface { - public: - virtual ~CardinalityInterface() {} - - // Conservative estimate on the lower/upper bound of the number of - // calls allowed. - virtual int ConservativeLowerBound() const { return 0; } - virtual int ConservativeUpperBound() const { return INT_MAX; } - - // Returns true if and only if call_count calls will satisfy this - // cardinality. - virtual bool IsSatisfiedByCallCount(int call_count) const = 0; - - // Returns true if and only if call_count calls will saturate this - // cardinality. - virtual bool IsSaturatedByCallCount(int call_count) const = 0; - - // Describes self to an ostream. - virtual void DescribeTo(::std::ostream* os) const = 0; -}; - -// A Cardinality is a copyable and IMMUTABLE (except by assignment) -// object that specifies how many times a mock function is expected to -// be called. The implementation of Cardinality is just a std::shared_ptr -// to const CardinalityInterface. Don't inherit from Cardinality! -class GTEST_API_ Cardinality { - public: - // Constructs a null cardinality. Needed for storing Cardinality - // objects in STL containers. - Cardinality() {} - - // Constructs a Cardinality from its implementation. - explicit Cardinality(const CardinalityInterface* impl) : impl_(impl) {} - - // Conservative estimate on the lower/upper bound of the number of - // calls allowed. - int ConservativeLowerBound() const { return impl_->ConservativeLowerBound(); } - int ConservativeUpperBound() const { return impl_->ConservativeUpperBound(); } - - // Returns true if and only if call_count calls will satisfy this - // cardinality. - bool IsSatisfiedByCallCount(int call_count) const { - return impl_->IsSatisfiedByCallCount(call_count); - } - - // Returns true if and only if call_count calls will saturate this - // cardinality. - bool IsSaturatedByCallCount(int call_count) const { - return impl_->IsSaturatedByCallCount(call_count); - } - - // Returns true if and only if call_count calls will over-saturate this - // cardinality, i.e. exceed the maximum number of allowed calls. - bool IsOverSaturatedByCallCount(int call_count) const { - return impl_->IsSaturatedByCallCount(call_count) && - !impl_->IsSatisfiedByCallCount(call_count); - } - - // Describes self to an ostream - void DescribeTo(::std::ostream* os) const { impl_->DescribeTo(os); } - - // Describes the given actual call count to an ostream. - static void DescribeActualCallCountTo(int actual_call_count, - ::std::ostream* os); - - private: - std::shared_ptr impl_; -}; - -// Creates a cardinality that allows at least n calls. -GTEST_API_ Cardinality AtLeast(int n); - -// Creates a cardinality that allows at most n calls. -GTEST_API_ Cardinality AtMost(int n); - -// Creates a cardinality that allows any number of calls. -GTEST_API_ Cardinality AnyNumber(); - -// Creates a cardinality that allows between min and max calls. -GTEST_API_ Cardinality Between(int min, int max); - -// Creates a cardinality that allows exactly n calls. -GTEST_API_ Cardinality Exactly(int n); - -// Creates a cardinality from its implementation. -inline Cardinality MakeCardinality(const CardinalityInterface* c) { - return Cardinality(c); -} - -} // namespace testing - -GTEST_DISABLE_MSC_WARNINGS_POP_() // 4251 - -#endif // GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_CARDINALITIES_H_ diff --git a/external/googletest/googlemock/include/gmock/gmock-function-mocker.h b/external/googletest/googlemock/include/gmock/gmock-function-mocker.h deleted file mode 100644 index 1d1499f340..0000000000 --- a/external/googletest/googlemock/include/gmock/gmock-function-mocker.h +++ /dev/null @@ -1,478 +0,0 @@ -// Copyright 2007, Google Inc. -// All rights reserved. -// -// Redistribution and use in source and binary forms, with or without -// modification, are permitted provided that the following conditions are -// met: -// -// * Redistributions of source code must retain the above copyright -// notice, this list of conditions and the following disclaimer. -// * Redistributions in binary form must reproduce the above -// copyright notice, this list of conditions and the following disclaimer -// in the documentation and/or other materials provided with the -// distribution. -// * Neither the name of Google Inc. nor the names of its -// contributors may be used to endorse or promote products derived from -// this software without specific prior written permission. -// -// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - -// Google Mock - a framework for writing C++ mock classes. -// -// This file implements MOCK_METHOD. - -// GOOGLETEST_CM0002 DO NOT DELETE - -#ifndef GOOGLEMOCK_INCLUDE_GMOCK_INTERNAL_GMOCK_FUNCTION_MOCKER_H_ // NOLINT -#define GOOGLEMOCK_INCLUDE_GMOCK_INTERNAL_GMOCK_FUNCTION_MOCKER_H_ // NOLINT - -#include // IWYU pragma: keep -#include // IWYU pragma: keep - -#include "gmock/gmock-spec-builders.h" -#include "gmock/internal/gmock-internal-utils.h" -#include "gmock/internal/gmock-pp.h" - -namespace testing { -namespace internal { -template -using identity_t = T; - -template -struct ThisRefAdjuster { - template - using AdjustT = typename std::conditional< - std::is_const::type>::value, - typename std::conditional::value, - const T&, const T&&>::type, - typename std::conditional::value, T&, - T&&>::type>::type; - - template - static AdjustT Adjust(const MockType& mock) { - return static_cast>(const_cast(mock)); - } -}; - -} // namespace internal - -// The style guide prohibits "using" statements in a namespace scope -// inside a header file. However, the FunctionMocker class template -// is meant to be defined in the ::testing namespace. The following -// line is just a trick for working around a bug in MSVC 8.0, which -// cannot handle it if we define FunctionMocker in ::testing. -using internal::FunctionMocker; -} // namespace testing - -#define MOCK_METHOD(...) \ - GMOCK_PP_VARIADIC_CALL(GMOCK_INTERNAL_MOCK_METHOD_ARG_, __VA_ARGS__) - -#define GMOCK_INTERNAL_MOCK_METHOD_ARG_1(...) \ - GMOCK_INTERNAL_WRONG_ARITY(__VA_ARGS__) - -#define GMOCK_INTERNAL_MOCK_METHOD_ARG_2(...) \ - GMOCK_INTERNAL_WRONG_ARITY(__VA_ARGS__) - -#define GMOCK_INTERNAL_MOCK_METHOD_ARG_3(_Ret, _MethodName, _Args) \ - GMOCK_INTERNAL_MOCK_METHOD_ARG_4(_Ret, _MethodName, _Args, ()) - -#define GMOCK_INTERNAL_MOCK_METHOD_ARG_4(_Ret, _MethodName, _Args, _Spec) \ - GMOCK_INTERNAL_ASSERT_PARENTHESIS(_Args); \ - GMOCK_INTERNAL_ASSERT_PARENTHESIS(_Spec); \ - GMOCK_INTERNAL_ASSERT_VALID_SIGNATURE( \ - GMOCK_PP_NARG0 _Args, GMOCK_INTERNAL_SIGNATURE(_Ret, _Args)); \ - GMOCK_INTERNAL_ASSERT_VALID_SPEC(_Spec) \ - GMOCK_INTERNAL_MOCK_METHOD_IMPL( \ - GMOCK_PP_NARG0 _Args, _MethodName, GMOCK_INTERNAL_HAS_CONST(_Spec), \ - GMOCK_INTERNAL_HAS_OVERRIDE(_Spec), GMOCK_INTERNAL_HAS_FINAL(_Spec), \ - GMOCK_INTERNAL_GET_NOEXCEPT_SPEC(_Spec), \ - GMOCK_INTERNAL_GET_CALLTYPE(_Spec), GMOCK_INTERNAL_GET_REF_SPEC(_Spec), \ - (GMOCK_INTERNAL_SIGNATURE(_Ret, _Args))) - -#define GMOCK_INTERNAL_MOCK_METHOD_ARG_5(...) \ - GMOCK_INTERNAL_WRONG_ARITY(__VA_ARGS__) - -#define GMOCK_INTERNAL_MOCK_METHOD_ARG_6(...) \ - GMOCK_INTERNAL_WRONG_ARITY(__VA_ARGS__) - -#define GMOCK_INTERNAL_MOCK_METHOD_ARG_7(...) \ - GMOCK_INTERNAL_WRONG_ARITY(__VA_ARGS__) - -#define GMOCK_INTERNAL_WRONG_ARITY(...) \ - static_assert( \ - false, \ - "MOCK_METHOD must be called with 3 or 4 arguments. _Ret, " \ - "_MethodName, _Args and optionally _Spec. _Args and _Spec must be " \ - "enclosed in parentheses. If _Ret is a type with unprotected commas, " \ - "it must also be enclosed in parentheses.") - -#define GMOCK_INTERNAL_ASSERT_PARENTHESIS(_Tuple) \ - static_assert( \ - GMOCK_PP_IS_ENCLOSED_PARENS(_Tuple), \ - GMOCK_PP_STRINGIZE(_Tuple) " should be enclosed in parentheses.") - -#define GMOCK_INTERNAL_ASSERT_VALID_SIGNATURE(_N, ...) \ - static_assert( \ - std::is_function<__VA_ARGS__>::value, \ - "Signature must be a function type, maybe return type contains " \ - "unprotected comma."); \ - static_assert( \ - ::testing::tuple_size::ArgumentTuple>::value == _N, \ - "This method does not take " GMOCK_PP_STRINGIZE( \ - _N) " arguments. Parenthesize all types with unprotected commas.") - -#define GMOCK_INTERNAL_ASSERT_VALID_SPEC(_Spec) \ - GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_ASSERT_VALID_SPEC_ELEMENT, ~, _Spec) - -#define GMOCK_INTERNAL_MOCK_METHOD_IMPL(_N, _MethodName, _Constness, \ - _Override, _Final, _NoexceptSpec, \ - _CallType, _RefSpec, _Signature) \ - typename ::testing::internal::Function::Result \ - GMOCK_INTERNAL_EXPAND(_CallType) \ - _MethodName(GMOCK_PP_REPEAT(GMOCK_INTERNAL_PARAMETER, _Signature, _N)) \ - GMOCK_PP_IF(_Constness, const, ) _RefSpec _NoexceptSpec \ - GMOCK_PP_IF(_Override, override, ) GMOCK_PP_IF(_Final, final, ) { \ - GMOCK_MOCKER_(_N, _Constness, _MethodName) \ - .SetOwnerAndName(this, #_MethodName); \ - return GMOCK_MOCKER_(_N, _Constness, _MethodName) \ - .Invoke(GMOCK_PP_REPEAT(GMOCK_INTERNAL_FORWARD_ARG, _Signature, _N)); \ - } \ - ::testing::MockSpec gmock_##_MethodName( \ - GMOCK_PP_REPEAT(GMOCK_INTERNAL_MATCHER_PARAMETER, _Signature, _N)) \ - GMOCK_PP_IF(_Constness, const, ) _RefSpec { \ - GMOCK_MOCKER_(_N, _Constness, _MethodName).RegisterOwner(this); \ - return GMOCK_MOCKER_(_N, _Constness, _MethodName) \ - .With(GMOCK_PP_REPEAT(GMOCK_INTERNAL_MATCHER_ARGUMENT, , _N)); \ - } \ - ::testing::MockSpec gmock_##_MethodName( \ - const ::testing::internal::WithoutMatchers&, \ - GMOCK_PP_IF(_Constness, const, )::testing::internal::Function< \ - GMOCK_PP_REMOVE_PARENS(_Signature)>*) const _RefSpec _NoexceptSpec { \ - return ::testing::internal::ThisRefAdjuster::Adjust(*this) \ - .gmock_##_MethodName(GMOCK_PP_REPEAT( \ - GMOCK_INTERNAL_A_MATCHER_ARGUMENT, _Signature, _N)); \ - } \ - mutable ::testing::FunctionMocker \ - GMOCK_MOCKER_(_N, _Constness, _MethodName) - -#define GMOCK_INTERNAL_EXPAND(...) __VA_ARGS__ - -// Five Valid modifiers. -#define GMOCK_INTERNAL_HAS_CONST(_Tuple) \ - GMOCK_PP_HAS_COMMA(GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_DETECT_CONST, ~, _Tuple)) - -#define GMOCK_INTERNAL_HAS_OVERRIDE(_Tuple) \ - GMOCK_PP_HAS_COMMA( \ - GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_DETECT_OVERRIDE, ~, _Tuple)) - -#define GMOCK_INTERNAL_HAS_FINAL(_Tuple) \ - GMOCK_PP_HAS_COMMA(GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_DETECT_FINAL, ~, _Tuple)) - -#define GMOCK_INTERNAL_GET_NOEXCEPT_SPEC(_Tuple) \ - GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_NOEXCEPT_SPEC_IF_NOEXCEPT, ~, _Tuple) - -#define GMOCK_INTERNAL_NOEXCEPT_SPEC_IF_NOEXCEPT(_i, _, _elem) \ - GMOCK_PP_IF( \ - GMOCK_PP_HAS_COMMA(GMOCK_INTERNAL_DETECT_NOEXCEPT(_i, _, _elem)), \ - _elem, ) - -#define GMOCK_INTERNAL_GET_REF_SPEC(_Tuple) \ - GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_REF_SPEC_IF_REF, ~, _Tuple) - -#define GMOCK_INTERNAL_REF_SPEC_IF_REF(_i, _, _elem) \ - GMOCK_PP_IF(GMOCK_PP_HAS_COMMA(GMOCK_INTERNAL_DETECT_REF(_i, _, _elem)), \ - GMOCK_PP_CAT(GMOCK_INTERNAL_UNPACK_, _elem), ) - -#define GMOCK_INTERNAL_GET_CALLTYPE(_Tuple) \ - GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_GET_CALLTYPE_IMPL, ~, _Tuple) - -#define GMOCK_INTERNAL_ASSERT_VALID_SPEC_ELEMENT(_i, _, _elem) \ - static_assert( \ - (GMOCK_PP_HAS_COMMA(GMOCK_INTERNAL_DETECT_CONST(_i, _, _elem)) + \ - GMOCK_PP_HAS_COMMA(GMOCK_INTERNAL_DETECT_OVERRIDE(_i, _, _elem)) + \ - GMOCK_PP_HAS_COMMA(GMOCK_INTERNAL_DETECT_FINAL(_i, _, _elem)) + \ - GMOCK_PP_HAS_COMMA(GMOCK_INTERNAL_DETECT_NOEXCEPT(_i, _, _elem)) + \ - GMOCK_PP_HAS_COMMA(GMOCK_INTERNAL_DETECT_REF(_i, _, _elem)) + \ - GMOCK_INTERNAL_IS_CALLTYPE(_elem)) == 1, \ - GMOCK_PP_STRINGIZE( \ - _elem) " cannot be recognized as a valid specification modifier."); - -// Modifiers implementation. -#define GMOCK_INTERNAL_DETECT_CONST(_i, _, _elem) \ - GMOCK_PP_CAT(GMOCK_INTERNAL_DETECT_CONST_I_, _elem) - -#define GMOCK_INTERNAL_DETECT_CONST_I_const , - -#define GMOCK_INTERNAL_DETECT_OVERRIDE(_i, _, _elem) \ - GMOCK_PP_CAT(GMOCK_INTERNAL_DETECT_OVERRIDE_I_, _elem) - -#define GMOCK_INTERNAL_DETECT_OVERRIDE_I_override , - -#define GMOCK_INTERNAL_DETECT_FINAL(_i, _, _elem) \ - GMOCK_PP_CAT(GMOCK_INTERNAL_DETECT_FINAL_I_, _elem) - -#define GMOCK_INTERNAL_DETECT_FINAL_I_final , - -#define GMOCK_INTERNAL_DETECT_NOEXCEPT(_i, _, _elem) \ - GMOCK_PP_CAT(GMOCK_INTERNAL_DETECT_NOEXCEPT_I_, _elem) - -#define GMOCK_INTERNAL_DETECT_NOEXCEPT_I_noexcept , - -#define GMOCK_INTERNAL_DETECT_REF(_i, _, _elem) \ - GMOCK_PP_CAT(GMOCK_INTERNAL_DETECT_REF_I_, _elem) - -#define GMOCK_INTERNAL_DETECT_REF_I_ref , - -#define GMOCK_INTERNAL_UNPACK_ref(x) x - -#define GMOCK_INTERNAL_GET_CALLTYPE_IMPL(_i, _, _elem) \ - GMOCK_PP_IF(GMOCK_INTERNAL_IS_CALLTYPE(_elem), \ - GMOCK_INTERNAL_GET_VALUE_CALLTYPE, GMOCK_PP_EMPTY) \ - (_elem) - -// TODO(iserna): GMOCK_INTERNAL_IS_CALLTYPE and -// GMOCK_INTERNAL_GET_VALUE_CALLTYPE needed more expansions to work on windows -// maybe they can be simplified somehow. -#define GMOCK_INTERNAL_IS_CALLTYPE(_arg) \ - GMOCK_INTERNAL_IS_CALLTYPE_I( \ - GMOCK_PP_CAT(GMOCK_INTERNAL_IS_CALLTYPE_HELPER_, _arg)) -#define GMOCK_INTERNAL_IS_CALLTYPE_I(_arg) GMOCK_PP_IS_ENCLOSED_PARENS(_arg) - -#define GMOCK_INTERNAL_GET_VALUE_CALLTYPE(_arg) \ - GMOCK_INTERNAL_GET_VALUE_CALLTYPE_I( \ - GMOCK_PP_CAT(GMOCK_INTERNAL_IS_CALLTYPE_HELPER_, _arg)) -#define GMOCK_INTERNAL_GET_VALUE_CALLTYPE_I(_arg) GMOCK_PP_IDENTITY _arg - -#define GMOCK_INTERNAL_IS_CALLTYPE_HELPER_Calltype - -// Note: The use of `identity_t` here allows _Ret to represent return types that -// would normally need to be specified in a different way. For example, a method -// returning a function pointer must be written as -// -// fn_ptr_return_t (*method(method_args_t...))(fn_ptr_args_t...) -// -// But we only support placing the return type at the beginning. To handle this, -// we wrap all calls in identity_t, so that a declaration will be expanded to -// -// identity_t method(method_args_t...) -// -// This allows us to work around the syntactic oddities of function/method -// types. -#define GMOCK_INTERNAL_SIGNATURE(_Ret, _Args) \ - ::testing::internal::identity_t( \ - GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_GET_TYPE, _, _Args)) - -#define GMOCK_INTERNAL_GET_TYPE(_i, _, _elem) \ - GMOCK_PP_COMMA_IF(_i) \ - GMOCK_PP_IF(GMOCK_PP_IS_BEGIN_PARENS(_elem), GMOCK_PP_REMOVE_PARENS, \ - GMOCK_PP_IDENTITY) \ - (_elem) - -#define GMOCK_INTERNAL_PARAMETER(_i, _Signature, _) \ - GMOCK_PP_COMMA_IF(_i) \ - GMOCK_INTERNAL_ARG_O(_i, GMOCK_PP_REMOVE_PARENS(_Signature)) \ - gmock_a##_i - -#define GMOCK_INTERNAL_FORWARD_ARG(_i, _Signature, _) \ - GMOCK_PP_COMMA_IF(_i) \ - ::std::forward(gmock_a##_i) - -#define GMOCK_INTERNAL_MATCHER_PARAMETER(_i, _Signature, _) \ - GMOCK_PP_COMMA_IF(_i) \ - GMOCK_INTERNAL_MATCHER_O(_i, GMOCK_PP_REMOVE_PARENS(_Signature)) \ - gmock_a##_i - -#define GMOCK_INTERNAL_MATCHER_ARGUMENT(_i, _1, _2) \ - GMOCK_PP_COMMA_IF(_i) \ - gmock_a##_i - -#define GMOCK_INTERNAL_A_MATCHER_ARGUMENT(_i, _Signature, _) \ - GMOCK_PP_COMMA_IF(_i) \ - ::testing::A() - -#define GMOCK_INTERNAL_ARG_O(_i, ...) \ - typename ::testing::internal::Function<__VA_ARGS__>::template Arg<_i>::type - -#define GMOCK_INTERNAL_MATCHER_O(_i, ...) \ - const ::testing::Matcher::template Arg<_i>::type>& - -#define MOCK_METHOD0(m, ...) GMOCK_INTERNAL_MOCK_METHODN(, , m, 0, __VA_ARGS__) -#define MOCK_METHOD1(m, ...) GMOCK_INTERNAL_MOCK_METHODN(, , m, 1, __VA_ARGS__) -#define MOCK_METHOD2(m, ...) GMOCK_INTERNAL_MOCK_METHODN(, , m, 2, __VA_ARGS__) -#define MOCK_METHOD3(m, ...) GMOCK_INTERNAL_MOCK_METHODN(, , m, 3, __VA_ARGS__) -#define MOCK_METHOD4(m, ...) GMOCK_INTERNAL_MOCK_METHODN(, , m, 4, __VA_ARGS__) -#define MOCK_METHOD5(m, ...) GMOCK_INTERNAL_MOCK_METHODN(, , m, 5, __VA_ARGS__) -#define MOCK_METHOD6(m, ...) GMOCK_INTERNAL_MOCK_METHODN(, , m, 6, __VA_ARGS__) -#define MOCK_METHOD7(m, ...) GMOCK_INTERNAL_MOCK_METHODN(, , m, 7, __VA_ARGS__) -#define MOCK_METHOD8(m, ...) GMOCK_INTERNAL_MOCK_METHODN(, , m, 8, __VA_ARGS__) -#define MOCK_METHOD9(m, ...) GMOCK_INTERNAL_MOCK_METHODN(, , m, 9, __VA_ARGS__) -#define MOCK_METHOD10(m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(, , m, 10, __VA_ARGS__) - -#define MOCK_CONST_METHOD0(m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(const, , m, 0, __VA_ARGS__) -#define MOCK_CONST_METHOD1(m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(const, , m, 1, __VA_ARGS__) -#define MOCK_CONST_METHOD2(m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(const, , m, 2, __VA_ARGS__) -#define MOCK_CONST_METHOD3(m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(const, , m, 3, __VA_ARGS__) -#define MOCK_CONST_METHOD4(m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(const, , m, 4, __VA_ARGS__) -#define MOCK_CONST_METHOD5(m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(const, , m, 5, __VA_ARGS__) -#define MOCK_CONST_METHOD6(m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(const, , m, 6, __VA_ARGS__) -#define MOCK_CONST_METHOD7(m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(const, , m, 7, __VA_ARGS__) -#define MOCK_CONST_METHOD8(m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(const, , m, 8, __VA_ARGS__) -#define MOCK_CONST_METHOD9(m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(const, , m, 9, __VA_ARGS__) -#define MOCK_CONST_METHOD10(m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(const, , m, 10, __VA_ARGS__) - -#define MOCK_METHOD0_T(m, ...) MOCK_METHOD0(m, __VA_ARGS__) -#define MOCK_METHOD1_T(m, ...) MOCK_METHOD1(m, __VA_ARGS__) -#define MOCK_METHOD2_T(m, ...) MOCK_METHOD2(m, __VA_ARGS__) -#define MOCK_METHOD3_T(m, ...) MOCK_METHOD3(m, __VA_ARGS__) -#define MOCK_METHOD4_T(m, ...) MOCK_METHOD4(m, __VA_ARGS__) -#define MOCK_METHOD5_T(m, ...) MOCK_METHOD5(m, __VA_ARGS__) -#define MOCK_METHOD6_T(m, ...) MOCK_METHOD6(m, __VA_ARGS__) -#define MOCK_METHOD7_T(m, ...) MOCK_METHOD7(m, __VA_ARGS__) -#define MOCK_METHOD8_T(m, ...) MOCK_METHOD8(m, __VA_ARGS__) -#define MOCK_METHOD9_T(m, ...) MOCK_METHOD9(m, __VA_ARGS__) -#define MOCK_METHOD10_T(m, ...) MOCK_METHOD10(m, __VA_ARGS__) - -#define MOCK_CONST_METHOD0_T(m, ...) MOCK_CONST_METHOD0(m, __VA_ARGS__) -#define MOCK_CONST_METHOD1_T(m, ...) MOCK_CONST_METHOD1(m, __VA_ARGS__) -#define MOCK_CONST_METHOD2_T(m, ...) MOCK_CONST_METHOD2(m, __VA_ARGS__) -#define MOCK_CONST_METHOD3_T(m, ...) MOCK_CONST_METHOD3(m, __VA_ARGS__) -#define MOCK_CONST_METHOD4_T(m, ...) MOCK_CONST_METHOD4(m, __VA_ARGS__) -#define MOCK_CONST_METHOD5_T(m, ...) MOCK_CONST_METHOD5(m, __VA_ARGS__) -#define MOCK_CONST_METHOD6_T(m, ...) MOCK_CONST_METHOD6(m, __VA_ARGS__) -#define MOCK_CONST_METHOD7_T(m, ...) MOCK_CONST_METHOD7(m, __VA_ARGS__) -#define MOCK_CONST_METHOD8_T(m, ...) MOCK_CONST_METHOD8(m, __VA_ARGS__) -#define MOCK_CONST_METHOD9_T(m, ...) MOCK_CONST_METHOD9(m, __VA_ARGS__) -#define MOCK_CONST_METHOD10_T(m, ...) MOCK_CONST_METHOD10(m, __VA_ARGS__) - -#define MOCK_METHOD0_WITH_CALLTYPE(ct, m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(, ct, m, 0, __VA_ARGS__) -#define MOCK_METHOD1_WITH_CALLTYPE(ct, m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(, ct, m, 1, __VA_ARGS__) -#define MOCK_METHOD2_WITH_CALLTYPE(ct, m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(, ct, m, 2, __VA_ARGS__) -#define MOCK_METHOD3_WITH_CALLTYPE(ct, m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(, ct, m, 3, __VA_ARGS__) -#define MOCK_METHOD4_WITH_CALLTYPE(ct, m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(, ct, m, 4, __VA_ARGS__) -#define MOCK_METHOD5_WITH_CALLTYPE(ct, m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(, ct, m, 5, __VA_ARGS__) -#define MOCK_METHOD6_WITH_CALLTYPE(ct, m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(, ct, m, 6, __VA_ARGS__) -#define MOCK_METHOD7_WITH_CALLTYPE(ct, m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(, ct, m, 7, __VA_ARGS__) -#define MOCK_METHOD8_WITH_CALLTYPE(ct, m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(, ct, m, 8, __VA_ARGS__) -#define MOCK_METHOD9_WITH_CALLTYPE(ct, m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(, ct, m, 9, __VA_ARGS__) -#define MOCK_METHOD10_WITH_CALLTYPE(ct, m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(, ct, m, 10, __VA_ARGS__) - -#define MOCK_CONST_METHOD0_WITH_CALLTYPE(ct, m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(const, ct, m, 0, __VA_ARGS__) -#define MOCK_CONST_METHOD1_WITH_CALLTYPE(ct, m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(const, ct, m, 1, __VA_ARGS__) -#define MOCK_CONST_METHOD2_WITH_CALLTYPE(ct, m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(const, ct, m, 2, __VA_ARGS__) -#define MOCK_CONST_METHOD3_WITH_CALLTYPE(ct, m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(const, ct, m, 3, __VA_ARGS__) -#define MOCK_CONST_METHOD4_WITH_CALLTYPE(ct, m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(const, ct, m, 4, __VA_ARGS__) -#define MOCK_CONST_METHOD5_WITH_CALLTYPE(ct, m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(const, ct, m, 5, __VA_ARGS__) -#define MOCK_CONST_METHOD6_WITH_CALLTYPE(ct, m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(const, ct, m, 6, __VA_ARGS__) -#define MOCK_CONST_METHOD7_WITH_CALLTYPE(ct, m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(const, ct, m, 7, __VA_ARGS__) -#define MOCK_CONST_METHOD8_WITH_CALLTYPE(ct, m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(const, ct, m, 8, __VA_ARGS__) -#define MOCK_CONST_METHOD9_WITH_CALLTYPE(ct, m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(const, ct, m, 9, __VA_ARGS__) -#define MOCK_CONST_METHOD10_WITH_CALLTYPE(ct, m, ...) \ - GMOCK_INTERNAL_MOCK_METHODN(const, ct, m, 10, __VA_ARGS__) - -#define MOCK_METHOD0_T_WITH_CALLTYPE(ct, m, ...) \ - MOCK_METHOD0_WITH_CALLTYPE(ct, m, __VA_ARGS__) -#define MOCK_METHOD1_T_WITH_CALLTYPE(ct, m, ...) \ - MOCK_METHOD1_WITH_CALLTYPE(ct, m, __VA_ARGS__) -#define MOCK_METHOD2_T_WITH_CALLTYPE(ct, m, ...) \ - MOCK_METHOD2_WITH_CALLTYPE(ct, m, __VA_ARGS__) -#define MOCK_METHOD3_T_WITH_CALLTYPE(ct, m, ...) \ - MOCK_METHOD3_WITH_CALLTYPE(ct, m, __VA_ARGS__) -#define MOCK_METHOD4_T_WITH_CALLTYPE(ct, m, ...) \ - MOCK_METHOD4_WITH_CALLTYPE(ct, m, __VA_ARGS__) -#define MOCK_METHOD5_T_WITH_CALLTYPE(ct, m, ...) \ - MOCK_METHOD5_WITH_CALLTYPE(ct, m, __VA_ARGS__) -#define MOCK_METHOD6_T_WITH_CALLTYPE(ct, m, ...) \ - MOCK_METHOD6_WITH_CALLTYPE(ct, m, __VA_ARGS__) -#define MOCK_METHOD7_T_WITH_CALLTYPE(ct, m, ...) \ - MOCK_METHOD7_WITH_CALLTYPE(ct, m, __VA_ARGS__) -#define MOCK_METHOD8_T_WITH_CALLTYPE(ct, m, ...) \ - MOCK_METHOD8_WITH_CALLTYPE(ct, m, __VA_ARGS__) -#define MOCK_METHOD9_T_WITH_CALLTYPE(ct, m, ...) \ - MOCK_METHOD9_WITH_CALLTYPE(ct, m, __VA_ARGS__) -#define MOCK_METHOD10_T_WITH_CALLTYPE(ct, m, ...) \ - MOCK_METHOD10_WITH_CALLTYPE(ct, m, __VA_ARGS__) - -#define MOCK_CONST_METHOD0_T_WITH_CALLTYPE(ct, m, ...) \ - MOCK_CONST_METHOD0_WITH_CALLTYPE(ct, m, __VA_ARGS__) -#define MOCK_CONST_METHOD1_T_WITH_CALLTYPE(ct, m, ...) \ - MOCK_CONST_METHOD1_WITH_CALLTYPE(ct, m, __VA_ARGS__) -#define MOCK_CONST_METHOD2_T_WITH_CALLTYPE(ct, m, ...) \ - MOCK_CONST_METHOD2_WITH_CALLTYPE(ct, m, __VA_ARGS__) -#define MOCK_CONST_METHOD3_T_WITH_CALLTYPE(ct, m, ...) \ - MOCK_CONST_METHOD3_WITH_CALLTYPE(ct, m, __VA_ARGS__) -#define MOCK_CONST_METHOD4_T_WITH_CALLTYPE(ct, m, ...) \ - MOCK_CONST_METHOD4_WITH_CALLTYPE(ct, m, __VA_ARGS__) -#define MOCK_CONST_METHOD5_T_WITH_CALLTYPE(ct, m, ...) \ - MOCK_CONST_METHOD5_WITH_CALLTYPE(ct, m, __VA_ARGS__) -#define MOCK_CONST_METHOD6_T_WITH_CALLTYPE(ct, m, ...) \ - MOCK_CONST_METHOD6_WITH_CALLTYPE(ct, m, __VA_ARGS__) -#define MOCK_CONST_METHOD7_T_WITH_CALLTYPE(ct, m, ...) \ - MOCK_CONST_METHOD7_WITH_CALLTYPE(ct, m, __VA_ARGS__) -#define MOCK_CONST_METHOD8_T_WITH_CALLTYPE(ct, m, ...) \ - MOCK_CONST_METHOD8_WITH_CALLTYPE(ct, m, __VA_ARGS__) -#define MOCK_CONST_METHOD9_T_WITH_CALLTYPE(ct, m, ...) \ - MOCK_CONST_METHOD9_WITH_CALLTYPE(ct, m, __VA_ARGS__) -#define MOCK_CONST_METHOD10_T_WITH_CALLTYPE(ct, m, ...) \ - MOCK_CONST_METHOD10_WITH_CALLTYPE(ct, m, __VA_ARGS__) - -#define GMOCK_INTERNAL_MOCK_METHODN(constness, ct, Method, args_num, ...) \ - GMOCK_INTERNAL_ASSERT_VALID_SIGNATURE( \ - args_num, ::testing::internal::identity_t<__VA_ARGS__>); \ - GMOCK_INTERNAL_MOCK_METHOD_IMPL( \ - args_num, Method, GMOCK_PP_NARG0(constness), 0, 0, , ct, , \ - (::testing::internal::identity_t<__VA_ARGS__>)) - -#define GMOCK_MOCKER_(arity, constness, Method) \ - GTEST_CONCAT_TOKEN_(gmock##constness##arity##_##Method##_, __LINE__) - -#endif // GOOGLEMOCK_INCLUDE_GMOCK_INTERNAL_GMOCK_FUNCTION_MOCKER_H_ diff --git a/external/googletest/googlemock/include/gmock/gmock-matchers.h b/external/googletest/googlemock/include/gmock/gmock-matchers.h deleted file mode 100644 index befd3007a1..0000000000 --- a/external/googletest/googlemock/include/gmock/gmock-matchers.h +++ /dev/null @@ -1,5367 +0,0 @@ -// Copyright 2007, Google Inc. -// All rights reserved. -// -// Redistribution and use in source and binary forms, with or without -// modification, are permitted provided that the following conditions are -// met: -// -// * Redistributions of source code must retain the above copyright -// notice, this list of conditions and the following disclaimer. -// * Redistributions in binary form must reproduce the above -// copyright notice, this list of conditions and the following disclaimer -// in the documentation and/or other materials provided with the -// distribution. -// * Neither the name of Google Inc. nor the names of its -// contributors may be used to endorse or promote products derived from -// this software without specific prior written permission. -// -// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - -// Google Mock - a framework for writing C++ mock classes. -// -// The MATCHER* family of macros can be used in a namespace scope to -// define custom matchers easily. -// -// Basic Usage -// =========== -// -// The syntax -// -// MATCHER(name, description_string) { statements; } -// -// defines a matcher with the given name that executes the statements, -// which must return a bool to indicate if the match succeeds. Inside -// the statements, you can refer to the value being matched by 'arg', -// and refer to its type by 'arg_type'. -// -// The description string documents what the matcher does, and is used -// to generate the failure message when the match fails. Since a -// MATCHER() is usually defined in a header file shared by multiple -// C++ source files, we require the description to be a C-string -// literal to avoid possible side effects. It can be empty, in which -// case we'll use the sequence of words in the matcher name as the -// description. -// -// For example: -// -// MATCHER(IsEven, "") { return (arg % 2) == 0; } -// -// allows you to write -// -// // Expects mock_foo.Bar(n) to be called where n is even. -// EXPECT_CALL(mock_foo, Bar(IsEven())); -// -// or, -// -// // Verifies that the value of some_expression is even. -// EXPECT_THAT(some_expression, IsEven()); -// -// If the above assertion fails, it will print something like: -// -// Value of: some_expression -// Expected: is even -// Actual: 7 -// -// where the description "is even" is automatically calculated from the -// matcher name IsEven. -// -// Argument Type -// ============= -// -// Note that the type of the value being matched (arg_type) is -// determined by the context in which you use the matcher and is -// supplied to you by the compiler, so you don't need to worry about -// declaring it (nor can you). This allows the matcher to be -// polymorphic. For example, IsEven() can be used to match any type -// where the value of "(arg % 2) == 0" can be implicitly converted to -// a bool. In the "Bar(IsEven())" example above, if method Bar() -// takes an int, 'arg_type' will be int; if it takes an unsigned long, -// 'arg_type' will be unsigned long; and so on. -// -// Parameterizing Matchers -// ======================= -// -// Sometimes you'll want to parameterize the matcher. For that you -// can use another macro: -// -// MATCHER_P(name, param_name, description_string) { statements; } -// -// For example: -// -// MATCHER_P(HasAbsoluteValue, value, "") { return abs(arg) == value; } -// -// will allow you to write: -// -// EXPECT_THAT(Blah("a"), HasAbsoluteValue(n)); -// -// which may lead to this message (assuming n is 10): -// -// Value of: Blah("a") -// Expected: has absolute value 10 -// Actual: -9 -// -// Note that both the matcher description and its parameter are -// printed, making the message human-friendly. -// -// In the matcher definition body, you can write 'foo_type' to -// reference the type of a parameter named 'foo'. For example, in the -// body of MATCHER_P(HasAbsoluteValue, value) above, you can write -// 'value_type' to refer to the type of 'value'. -// -// We also provide MATCHER_P2, MATCHER_P3, ..., up to MATCHER_P$n to -// support multi-parameter matchers. -// -// Describing Parameterized Matchers -// ================================= -// -// The last argument to MATCHER*() is a string-typed expression. The -// expression can reference all of the matcher's parameters and a -// special bool-typed variable named 'negation'. When 'negation' is -// false, the expression should evaluate to the matcher's description; -// otherwise it should evaluate to the description of the negation of -// the matcher. For example, -// -// using testing::PrintToString; -// -// MATCHER_P2(InClosedRange, low, hi, -// std::string(negation ? "is not" : "is") + " in range [" + -// PrintToString(low) + ", " + PrintToString(hi) + "]") { -// return low <= arg && arg <= hi; -// } -// ... -// EXPECT_THAT(3, InClosedRange(4, 6)); -// EXPECT_THAT(3, Not(InClosedRange(2, 4))); -// -// would generate two failures that contain the text: -// -// Expected: is in range [4, 6] -// ... -// Expected: is not in range [2, 4] -// -// If you specify "" as the description, the failure message will -// contain the sequence of words in the matcher name followed by the -// parameter values printed as a tuple. For example, -// -// MATCHER_P2(InClosedRange, low, hi, "") { ... } -// ... -// EXPECT_THAT(3, InClosedRange(4, 6)); -// EXPECT_THAT(3, Not(InClosedRange(2, 4))); -// -// would generate two failures that contain the text: -// -// Expected: in closed range (4, 6) -// ... -// Expected: not (in closed range (2, 4)) -// -// Types of Matcher Parameters -// =========================== -// -// For the purpose of typing, you can view -// -// MATCHER_Pk(Foo, p1, ..., pk, description_string) { ... } -// -// as shorthand for -// -// template -// FooMatcherPk -// Foo(p1_type p1, ..., pk_type pk) { ... } -// -// When you write Foo(v1, ..., vk), the compiler infers the types of -// the parameters v1, ..., and vk for you. If you are not happy with -// the result of the type inference, you can specify the types by -// explicitly instantiating the template, as in Foo(5, -// false). As said earlier, you don't get to (or need to) specify -// 'arg_type' as that's determined by the context in which the matcher -// is used. You can assign the result of expression Foo(p1, ..., pk) -// to a variable of type FooMatcherPk. This -// can be useful when composing matchers. -// -// While you can instantiate a matcher template with reference types, -// passing the parameters by pointer usually makes your code more -// readable. If, however, you still want to pass a parameter by -// reference, be aware that in the failure message generated by the -// matcher you will see the value of the referenced object but not its -// address. -// -// Explaining Match Results -// ======================== -// -// Sometimes the matcher description alone isn't enough to explain why -// the match has failed or succeeded. For example, when expecting a -// long string, it can be very helpful to also print the diff between -// the expected string and the actual one. To achieve that, you can -// optionally stream additional information to a special variable -// named result_listener, whose type is a pointer to class -// MatchResultListener: -// -// MATCHER_P(EqualsLongString, str, "") { -// if (arg == str) return true; -// -// *result_listener << "the difference: " -/// << DiffStrings(str, arg); -// return false; -// } -// -// Overloading Matchers -// ==================== -// -// You can overload matchers with different numbers of parameters: -// -// MATCHER_P(Blah, a, description_string1) { ... } -// MATCHER_P2(Blah, a, b, description_string2) { ... } -// -// Caveats -// ======= -// -// When defining a new matcher, you should also consider implementing -// MatcherInterface or using MakePolymorphicMatcher(). These -// approaches require more work than the MATCHER* macros, but also -// give you more control on the types of the value being matched and -// the matcher parameters, which may leads to better compiler error -// messages when the matcher is used wrong. They also allow -// overloading matchers based on parameter types (as opposed to just -// based on the number of parameters). -// -// MATCHER*() can only be used in a namespace scope as templates cannot be -// declared inside of a local class. -// -// More Information -// ================ -// -// To learn more about using these macros, please search for 'MATCHER' -// on -// https://github.com/google/googletest/blob/master/docs/gmock_cook_book.md -// -// This file also implements some commonly used argument matchers. More -// matchers can be defined by the user implementing the -// MatcherInterface interface if necessary. -// -// See googletest/include/gtest/gtest-matchers.h for the definition of class -// Matcher, class MatcherInterface, and others. - -// GOOGLETEST_CM0002 DO NOT DELETE - -#ifndef GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_MATCHERS_H_ -#define GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_MATCHERS_H_ - -#include -#include -#include -#include -#include -#include -#include // NOLINT -#include -#include -#include -#include -#include - -#include "gmock/internal/gmock-internal-utils.h" -#include "gmock/internal/gmock-port.h" -#include "gmock/internal/gmock-pp.h" -#include "gtest/gtest.h" - -// MSVC warning C5046 is new as of VS2017 version 15.8. -#if defined(_MSC_VER) && _MSC_VER >= 1915 -#define GMOCK_MAYBE_5046_ 5046 -#else -#define GMOCK_MAYBE_5046_ -#endif - -GTEST_DISABLE_MSC_WARNINGS_PUSH_( - 4251 GMOCK_MAYBE_5046_ /* class A needs to have dll-interface to be used by - clients of class B */ - /* Symbol involving type with internal linkage not defined */) - -namespace testing { - -// To implement a matcher Foo for type T, define: -// 1. a class FooMatcherImpl that implements the -// MatcherInterface interface, and -// 2. a factory function that creates a Matcher object from a -// FooMatcherImpl*. -// -// The two-level delegation design makes it possible to allow a user -// to write "v" instead of "Eq(v)" where a Matcher is expected, which -// is impossible if we pass matchers by pointers. It also eases -// ownership management as Matcher objects can now be copied like -// plain values. - -// A match result listener that stores the explanation in a string. -class StringMatchResultListener : public MatchResultListener { - public: - StringMatchResultListener() : MatchResultListener(&ss_) {} - - // Returns the explanation accumulated so far. - std::string str() const { return ss_.str(); } - - // Clears the explanation accumulated so far. - void Clear() { ss_.str(""); } - - private: - ::std::stringstream ss_; - - GTEST_DISALLOW_COPY_AND_ASSIGN_(StringMatchResultListener); -}; - -// Anything inside the 'internal' namespace IS INTERNAL IMPLEMENTATION -// and MUST NOT BE USED IN USER CODE!!! -namespace internal { - -// The MatcherCastImpl class template is a helper for implementing -// MatcherCast(). We need this helper in order to partially -// specialize the implementation of MatcherCast() (C++ allows -// class/struct templates to be partially specialized, but not -// function templates.). - -// This general version is used when MatcherCast()'s argument is a -// polymorphic matcher (i.e. something that can be converted to a -// Matcher but is not one yet; for example, Eq(value)) or a value (for -// example, "hello"). -template -class MatcherCastImpl { - public: - static Matcher Cast(const M& polymorphic_matcher_or_value) { - // M can be a polymorphic matcher, in which case we want to use - // its conversion operator to create Matcher. Or it can be a value - // that should be passed to the Matcher's constructor. - // - // We can't call Matcher(polymorphic_matcher_or_value) when M is a - // polymorphic matcher because it'll be ambiguous if T has an implicit - // constructor from M (this usually happens when T has an implicit - // constructor from any type). - // - // It won't work to unconditionally implicit_cast - // polymorphic_matcher_or_value to Matcher because it won't trigger - // a user-defined conversion from M to T if one exists (assuming M is - // a value). - return CastImpl(polymorphic_matcher_or_value, - std::is_convertible>{}, - std::is_convertible{}); - } - - private: - template - static Matcher CastImpl(const M& polymorphic_matcher_or_value, - std::true_type /* convertible_to_matcher */, - std::integral_constant) { - // M is implicitly convertible to Matcher, which means that either - // M is a polymorphic matcher or Matcher has an implicit constructor - // from M. In both cases using the implicit conversion will produce a - // matcher. - // - // Even if T has an implicit constructor from M, it won't be called because - // creating Matcher would require a chain of two user-defined conversions - // (first to create T from M and then to create Matcher from T). - return polymorphic_matcher_or_value; - } - - // M can't be implicitly converted to Matcher, so M isn't a polymorphic - // matcher. It's a value of a type implicitly convertible to T. Use direct - // initialization to create a matcher. - static Matcher CastImpl(const M& value, - std::false_type /* convertible_to_matcher */, - std::true_type /* convertible_to_T */) { - return Matcher(ImplicitCast_(value)); - } - - // M can't be implicitly converted to either Matcher or T. Attempt to use - // polymorphic matcher Eq(value) in this case. - // - // Note that we first attempt to perform an implicit cast on the value and - // only fall back to the polymorphic Eq() matcher afterwards because the - // latter calls bool operator==(const Lhs& lhs, const Rhs& rhs) in the end - // which might be undefined even when Rhs is implicitly convertible to Lhs - // (e.g. std::pair vs. std::pair). - // - // We don't define this method inline as we need the declaration of Eq(). - static Matcher CastImpl(const M& value, - std::false_type /* convertible_to_matcher */, - std::false_type /* convertible_to_T */); -}; - -// This more specialized version is used when MatcherCast()'s argument -// is already a Matcher. This only compiles when type T can be -// statically converted to type U. -template -class MatcherCastImpl> { - public: - static Matcher Cast(const Matcher& source_matcher) { - return Matcher(new Impl(source_matcher)); - } - - private: - class Impl : public MatcherInterface { - public: - explicit Impl(const Matcher& source_matcher) - : source_matcher_(source_matcher) {} - - // We delegate the matching logic to the source matcher. - bool MatchAndExplain(T x, MatchResultListener* listener) const override { - using FromType = typename std::remove_cv::type>::type>::type; - using ToType = typename std::remove_cv::type>::type>::type; - // Do not allow implicitly converting base*/& to derived*/&. - static_assert( - // Do not trigger if only one of them is a pointer. That implies a - // regular conversion and not a down_cast. - (std::is_pointer::type>::value != - std::is_pointer::type>::value) || - std::is_same::value || - !std::is_base_of::value, - "Can't implicitly convert from to "); - - // Do the cast to `U` explicitly if necessary. - // Otherwise, let implicit conversions do the trick. - using CastType = - typename std::conditional::value, - T&, U>::type; - - return source_matcher_.MatchAndExplain(static_cast(x), - listener); - } - - void DescribeTo(::std::ostream* os) const override { - source_matcher_.DescribeTo(os); - } - - void DescribeNegationTo(::std::ostream* os) const override { - source_matcher_.DescribeNegationTo(os); - } - - private: - const Matcher source_matcher_; - }; -}; - -// This even more specialized version is used for efficiently casting -// a matcher to its own type. -template -class MatcherCastImpl> { - public: - static Matcher Cast(const Matcher& matcher) { return matcher; } -}; - -// Template specialization for parameterless Matcher. -template -class MatcherBaseImpl { - public: - MatcherBaseImpl() = default; - - template - operator ::testing::Matcher() const { // NOLINT(runtime/explicit) - return ::testing::Matcher(new - typename Derived::template gmock_Impl()); - } -}; - -// Template specialization for Matcher with parameters. -template