mirror of https://github.com/OpenTTD/OpenTTD.git
98 lines
3.5 KiB
C++
98 lines
3.5 KiB
C++
/*
|
|
* This file is part of OpenTTD.
|
|
* OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
|
|
* OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|
* See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/** @file test_window_desc.cpp Test WindowDescs for valid widget parts. */
|
|
|
|
#include "../stdafx.h"
|
|
|
|
#include "../3rdparty/catch2/catch.hpp"
|
|
|
|
#include "mock_environment.h"
|
|
|
|
#include "../window_gui.h"
|
|
|
|
/**
|
|
* List of WindowDescs. Defined in window.cpp but not exposed as this unit-test is the only other place that needs it.
|
|
* WindowDesc is a self-registering class so all WindowDescs will be included in the list.
|
|
*/
|
|
extern std::vector<WindowDesc*> *_window_descs;
|
|
|
|
|
|
class WindowDescTestsFixture {
|
|
private:
|
|
MockEnvironment &mock = MockEnvironment::Instance();
|
|
};
|
|
|
|
|
|
TEST_CASE("WindowDesc - ini_key uniqueness")
|
|
{
|
|
std::set<std::string> seen;
|
|
|
|
for (const WindowDesc *window_desc : *_window_descs) {
|
|
|
|
if (window_desc->ini_key == nullptr) continue;
|
|
|
|
CAPTURE(window_desc->ini_key);
|
|
CHECK((seen.find(window_desc->ini_key) == std::end(seen)));
|
|
|
|
seen.insert(window_desc->ini_key);
|
|
}
|
|
}
|
|
|
|
TEST_CASE("WindowDesc - ini_key validity")
|
|
{
|
|
const WindowDesc *window_desc = GENERATE(from_range(std::begin(*_window_descs), std::end(*_window_descs)));
|
|
|
|
bool has_inikey = window_desc->ini_key != nullptr;
|
|
bool has_widget = std::any_of(window_desc->nwid_begin, window_desc->nwid_end, [](const NWidgetPart &part) { return part.type == WWT_DEFSIZEBOX || part.type == WWT_STICKYBOX; });
|
|
|
|
INFO(fmt::format("{}:{}", window_desc->source_location.file_name(), window_desc->source_location.line()));
|
|
CAPTURE(has_inikey);
|
|
CAPTURE(has_widget);
|
|
|
|
CHECK((has_widget == has_inikey));
|
|
}
|
|
|
|
/**
|
|
* Test if a NWidgetTree is properly closed, meaning the number of container-type parts matches the number of
|
|
* EndContainer() parts.
|
|
* @param nwid_begin Pointer to beginning of nested widget parts.
|
|
* @param nwid_end Pointer to ending of nested widget parts.
|
|
* @return True iff nested tree is properly closed.
|
|
*/
|
|
static bool IsNWidgetTreeClosed(const NWidgetPart *nwid_begin, const NWidgetPart *nwid_end)
|
|
{
|
|
int depth = 0;
|
|
for (; nwid_begin < nwid_end; ++nwid_begin) {
|
|
if (IsContainerWidgetType(nwid_begin->type)) ++depth;
|
|
if (nwid_begin->type == WPT_ENDCONTAINER) --depth;
|
|
}
|
|
return depth == 0;
|
|
}
|
|
|
|
TEST_CASE("WindowDesc - NWidgetParts properly closed")
|
|
{
|
|
const WindowDesc *window_desc = GENERATE(from_range(std::begin(*_window_descs), std::end(*_window_descs)));
|
|
|
|
INFO(fmt::format("{}:{}", window_desc->source_location.file_name(), window_desc->source_location.line()));
|
|
|
|
CHECK(IsNWidgetTreeClosed(window_desc->nwid_begin, window_desc->nwid_end));
|
|
}
|
|
|
|
TEST_CASE_METHOD(WindowDescTestsFixture, "WindowDesc - NWidgetPart validity")
|
|
{
|
|
const WindowDesc *window_desc = GENERATE(from_range(std::begin(*_window_descs), std::end(*_window_descs)));
|
|
|
|
INFO(fmt::format("{}:{}", window_desc->source_location.file_name(), window_desc->source_location.line()));
|
|
|
|
NWidgetStacked *shade_select = nullptr;
|
|
std::unique_ptr<NWidgetBase> root = nullptr;
|
|
|
|
REQUIRE_NOTHROW(root = MakeWindowNWidgetTree(window_desc->nwid_begin, window_desc->nwid_end, &shade_select));
|
|
CHECK((root != nullptr));
|
|
}
|