cpp
/
RmlUi
mirror of https://github.com/mikke89/RmlUi.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183
							/*
 * 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 <RmlUi/Core/CompiledFilterShader.h>
#include <RmlUi/Core/Context.h>
#include <RmlUi/Core/Element.h>
#include <RmlUi/Core/ElementDocument.h>
#include <RmlUi/Core/Factory.h>
#include <RmlUi/Core/Filter.h>
#include <RmlUi/Core/PropertyDefinition.h>
#include <RmlUi/Core/PropertyDictionary.h>
#include <RmlUi/Core/RenderManager.h>
#include <algorithm>
#include <doctest.h>

using namespace Rml;
class FilterTest;

struct CompiledTestFilter {
	String element_id;
	const FilterTest* filter;
};
static Vector<CompiledTestFilter> 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<Filter> 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<FilterTest>(p_value->Get<float>(), p_value->unit);
	}

	int num_instances = 0;

private:
	PropertyId id = {};
};

static const String document_filter_rml = R"(
<rml>
<head>
	<style>
		body {
			top: 100px;
			left: 200px;
			width: 800px;
			height: 600px;
		}
		div {
			display: block;
			width: 400px;
			height: 300px;
		}
		#a    { filter: test(); }
		#b    { filter: test(0); }
		#c,#d { filter: test(1dp); }
	</style>
</head>

<body>
	<div id="a"/>
	<div id="b"/>
	<div id="c"/>
	<div id="d"/>
</body>
</rml>
)";

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<String, ExpectedCompiledFilter> 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();
}