/*
* This source file is part of RmlUi, the HTML/CSS Interface Middleware
*
* For the latest information, see http://github.com/mikke89/RmlUi
*
* Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
* Copyright (c) 2019-2023 The RmlUi Team, and contributors
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
*/
#include "../Common/TestsInterface.h"
#include "../Common/TestsShell.h"
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
using namespace Rml;
class FilterTest;
struct CompiledTestFilter {
String element_id;
const FilterTest* filter;
};
static Vector compiled_test_filters;
class FilterTest : public Filter {
public:
FilterTest(float value, Unit unit) : value(value), unit(unit) {}
CompiledFilter CompileFilter(Element* element) const override
{
compiled_test_filters.push_back({element->GetId(), this});
return element->GetRenderManager()->CompileFilter("FilterTest", {});
}
float value = 0.f;
Unit unit = Unit::UNKNOWN;
};
class FilterTestInstancer : public FilterInstancer {
public:
enum class ValueType { NumberPercent, Angle };
FilterTestInstancer()
{
id = RegisterProperty("value", "10cm").AddParser("length").GetId();
RegisterShorthand("filter", "value", ShorthandType::FallThrough);
}
SharedPtr InstanceFilter(const String& /*name*/, const PropertyDictionary& properties) override
{
const Property* p_value = properties.GetProperty(id);
if (!p_value)
return nullptr;
CHECK(Any(p_value->unit & Unit::LENGTH));
num_instances += 1;
return MakeShared(p_value->Get(), p_value->unit);
}
int num_instances = 0;
private:
PropertyId id = {};
};
static const String document_filter_rml = R"(
)";
TEST_CASE("filter")
{
compiled_test_filters.clear();
Context* context = TestsShell::GetContext();
REQUIRE(context);
FilterTestInstancer instancer;
Rml::Factory::RegisterFilterInstancer("test", &instancer);
ElementDocument* document = context->LoadDocumentFromMemory(document_filter_rml);
document->Show();
TestsShell::RenderLoop();
struct ExpectedCompiledFilter {
float value;
Unit unit;
};
// Map element ID to its expected filter value and unit.
UnorderedMap expected_compiled_filters = {
{"a", {10.f, Unit::CM}},
{"b", {0.f, Unit::PX}},
{"c", {1.f, Unit::DP}},
{"d", {1.f, Unit::DP}},
};
for (const auto& compiled_filter : compiled_test_filters)
{
INFO("ID #", compiled_filter.element_id);
auto it = expected_compiled_filters.find(compiled_filter.element_id);
const bool id_found = (it != expected_compiled_filters.end());
CHECK(id_found);
if (!id_found)
continue;
const ExpectedCompiledFilter& expected = it->second;
CHECK(compiled_filter.filter->value == expected.value);
CHECK(compiled_filter.filter->unit == expected.unit);
}
// Check that filters are not compiled more than once for each element.
CHECK(compiled_test_filters.size() == expected_compiled_filters.size());
// Filters aren't cached like decorators are, so each element will instance a new decorator even if they refer to
// the same style rule. Thus, here producing 4 instead of 3 unique instances.
CHECK(instancer.num_instances == expected_compiled_filters.size());
auto& counters = TestsShell::GetTestsRenderInterface()->GetCounters();
CHECK(counters.compile_filter == expected_compiled_filters.size());
CHECK(counters.release_filter == 0);
document->Close();
context->Update();
CHECK(counters.compile_filter == expected_compiled_filters.size());
CHECK(counters.release_filter == expected_compiled_filters.size());
TestsShell::ShutdownShell();
}