/*
* 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 "../Common/TypesToString.h"
#include
#include
#include
#include
#include
using namespace Rml;
static const String document_decorator_rml = R"(
Test
)";
TEST_CASE("animation.decorator")
{
struct Test {
String from_rule;
String to_rule;
String from;
String to;
String expected_25p; // expected interpolated value at 25% progression
};
Vector tests{
// Only standard declaration
{
"",
"",
"horizontal-gradient(transparent transparent)",
"horizontal-gradient(white white)",
"horizontal-gradient(horizontal #7f7f7f3f #7f7f7f3f)",
},
{
"",
"",
"horizontal-gradient(transparent transparent) border-box",
"horizontal-gradient(white white) border-box",
"horizontal-gradient(horizontal #7f7f7f3f #7f7f7f3f) border-box",
},
{
"",
"",
"none",
"horizontal-gradient(transparent transparent)",
"horizontal-gradient(horizontal #dcdcdcbf #dcdcdcbf)",
},
{
"",
"",
"none",
"horizontal-gradient(transparent transparent), horizontal-gradient(transparent transparent)",
"horizontal-gradient(horizontal #dcdcdcbf #dcdcdcbf), horizontal-gradient(horizontal #dcdcdcbf #dcdcdcbf)",
},
{
"",
"",
"horizontal-gradient(transparent transparent), horizontal-gradient(transparent transparent)",
"none",
"horizontal-gradient(horizontal #7f7f7f3f #7f7f7f3f), horizontal-gradient(horizontal #7f7f7f3f #7f7f7f3f)",
},
/// Only rule declaration
{
"start-color: transparent; stop-color: transparent;",
"start-color: white; stop-color: white;",
"from_rule",
"to_rule",
"horizontal-gradient(horizontal #7f7f7f3f #7f7f7f3f)",
},
{
"",
"start-color: transparent; stop-color: transparent;",
"from_rule",
"to_rule",
"horizontal-gradient(horizontal #dcdcdcbf #dcdcdcbf)",
},
{
"start-color: transparent; stop-color: transparent;",
"",
"from_rule",
"to_rule",
"horizontal-gradient(horizontal #7f7f7f3f #7f7f7f3f)",
},
/// Mix rule and standard declaration
{
"start-color: transparent; stop-color: transparent;",
"",
"from_rule",
"horizontal-gradient(white white)",
"horizontal-gradient(horizontal #7f7f7f3f #7f7f7f3f)",
},
{
"",
"start-color: transparent; stop-color: transparent;",
"none",
"to_rule",
"horizontal-gradient(horizontal #dcdcdcbf #dcdcdcbf)",
},
{
"start-color: transparent; stop-color: transparent;",
"",
"from_rule",
"none",
"horizontal-gradient(horizontal #7f7f7f3f #7f7f7f3f)",
},
{
"",
"",
"from_rule, to_rule",
"horizontal-gradient(transparent transparent), horizontal-gradient(transparent transparent)",
"horizontal-gradient(horizontal #dcdcdcbf #dcdcdcbf), horizontal-gradient(horizontal #dcdcdcbf #dcdcdcbf)",
},
{
"",
"",
"horizontal-gradient(transparent transparent), horizontal-gradient(transparent transparent)",
"from_rule, to_rule",
"horizontal-gradient(horizontal #7f7f7f3f #7f7f7f3f), horizontal-gradient(horizontal #7f7f7f3f #7f7f7f3f)",
},
// Standard declaration of linear gradients (consider string conversion a best-effort for now)
{
"",
"",
"linear-gradient(transparent, transparent)",
"linear-gradient(white, white)",
"linear-gradient(180deg unspecified unspecified unspecified #7d7d7d3f, #7d7d7d3f)",
},
{
"",
"",
"linear-gradient(0deg, transparent, transparent)",
"linear-gradient(180deg, white, white)",
"linear-gradient(45deg unspecified unspecified unspecified #7d7d7d3f, #7d7d7d3f)",
},
{
"",
"",
"linear-gradient(105deg, #000000 0%, #ff0000 100%)",
"linear-gradient(105deg, #ffffff 20%, #00ff00 60%)",
"linear-gradient(105deg unspecified unspecified unspecified #7f7f7f 5%, #dc7f00 90%)",
},
{
"",
"",
"linear-gradient(105deg, #000000 0%, #ff0000 50%, #ff00ff 100%)",
"linear-gradient(105deg, #ffffff 0%, #ffffff 10%, #ffffff 100%)",
"linear-gradient(105deg unspecified unspecified unspecified #7f7f7f 0%, #ff7f7f 40%, #ff7fff 100%)",
},
{
"",
"",
"linear-gradient(to right, transparent, transparent)",
"linear-gradient(270deg, transparent, transparent)",
// We don't really handle mixing direction keywords and angles here, the output will not be what one might expect.
"linear-gradient(202.5deg to right unspecified #00000000, #00000000)",
},
{
"",
"",
"linear-gradient(to right, transparent, transparent)",
"linear-gradient(to left, transparent, transparent)",
// This will effectively evaluate to "to right" with angle being ignored, resulting in discrete interpolation. Not ideal.
"linear-gradient(180deg to right unspecified #00000000, #00000000)",
},
{
"",
"",
"linear-gradient(#000000 0%, #ffffff 100%)",
"repeating-linear-gradient(#000000 0%, #ffffff 100%)",
"linear-gradient(#000000 0%, #ffffff 100%)",
},
};
TestsSystemInterface* system_interface = TestsShell::GetTestsSystemInterface();
Context* context = TestsShell::GetContext();
for (const String property_str : {"decorator", "mask-image"})
{
for (const Test& test : tests)
{
const double t_final = 0.1;
system_interface->SetTime(0.0);
String document_rml = Rml::CreateString(document_decorator_rml.c_str(), test.from_rule.c_str(), test.to_rule.c_str(),
property_str.c_str(), test.from.c_str(), property_str.c_str(), test.to.c_str());
ElementDocument* document = context->LoadDocumentFromMemory(document_rml, "assets/");
Element* element = document->GetChild(0);
document->Show();
TestsShell::RenderLoop();
system_interface->SetTime(0.25 * t_final);
TestsShell::RenderLoop();
CAPTURE(property_str);
CAPTURE(test.from);
CAPTURE(test.to);
CHECK(element->GetProperty(property_str) == test.expected_25p);
document->Close();
}
}
system_interface->SetTime(0.0);
TestsShell::ShutdownShell();
}
static const String document_filter_rml = R"(
Test
)";
TEST_CASE("animation.filter")
{
struct Test {
String from;
String to;
String expected_25p; // expected interpolated value at 25% progression
};
Vector tests{
{
"blur( 0px)",
"blur(40px)",
"blur(10px)",
},
{
"blur(10px)",
"blur(25dp)", // assumes dp-ratio == 2
"blur(20px)",
},
{
"blur(40px)",
"none",
"blur(30px)",
},
{
"none",
"blur(40px)",
"blur(10px)",
},
{
"drop-shadow(#000 30px 20px 0px)",
"drop-shadow(#f00 30px 20px 4px)", // colors interpolated in linear space
"drop-shadow(#7f0000 30px 20px 1px)",
},
{
"opacity(0) brightness(2)",
"none",
"opacity(0.25) brightness(1.75)",
},
{
"opacity(0) brightness(0)",
"opacity(0.5)",
"opacity(0.125) brightness(0.25)",
},
{
"opacity(0.5)",
"opacity(0) brightness(0)",
"opacity(0.375) brightness(0.75)",
},
{
"opacity(0) brightness(0)",
"brightness(1) opacity(0.5)", // discrete interpolation due to non-matching types
"opacity(0) brightness(0)",
},
{
"none", // Test initial values of various filters.
"brightness(2.00) contrast(2.00) grayscale(1.00) hue-rotate(4rad) invert(1.00) opacity(0.00) sepia(1.00) saturate(2.00)",
"brightness(1.25) contrast(1.25) grayscale(0.25) hue-rotate(1rad) invert(0.25) opacity(0.75) sepia(0.25) saturate(1.25)",
},
};
TestsSystemInterface* system_interface = TestsShell::GetTestsSystemInterface();
Context* context = TestsShell::GetContext();
context->SetDensityIndependentPixelRatio(2.0f);
for (const char* property_str : {"filter", "backdrop-filter"})
{
for (const Test& test : tests)
{
const double t_final = 0.1;
system_interface->SetTime(0.0);
String document_rml = Rml::CreateString(document_filter_rml.c_str(), property_str, test.from.c_str(), property_str, test.to.c_str());
ElementDocument* document = context->LoadDocumentFromMemory(document_rml, "assets/");
Element* element = document->GetChild(0);
document->Show();
system_interface->SetTime(0.25 * t_final);
TestsShell::RenderLoop();
CHECK_MESSAGE(element->GetProperty(property_str) == test.expected_25p, property_str, " from: ", test.from, ", to: ", test.to);
document->Close();
}
}
system_interface->SetTime(0.0);
TestsShell::ShutdownShell();
}
TEST_CASE("animation.case_sensitivity")
{
static const String document_rml_template = R"(
Test
)";
TestsSystemInterface* system_interface = TestsShell::GetTestsSystemInterface();
Context* context = TestsShell::GetContext();
struct TestCase {
String keyframe_name;
String animation_name;
bool expected_visible_end;
};
const Vector test_cases = {
// TODO: Make name-lookups case sensitive:
{"mix", "Mix", false},
{"Mix", "mix", false},
{"show", "show", true},
{"Show", "Show", true},
};
for (const auto& test_case : test_cases)
{
system_interface->SetTime(0.0);
INFO("@keyframes: ", test_case.keyframe_name);
INFO("animation: ", test_case.animation_name);
const String document_rml = CreateString(document_rml_template.c_str(), test_case.keyframe_name.c_str(), test_case.animation_name.c_str());
ElementDocument* document = context->LoadDocumentFromMemory(document_rml, "assets/");
Element* element = document->GetChild(0);
document->Show();
REQUIRE(element->IsVisible() == false);
constexpr double t_end = 1.0;
constexpr double dt = 0.1;
double t = 0;
while (t < t_end)
{
t += dt;
system_interface->SetTime(t);
context->Update();
}
CHECK(element->IsVisible() == test_case.expected_visible_end);
document->Close();
}
system_interface->SetTime(0.0);
TestsShell::ShutdownShell();
}
TEST_CASE("animation.case_sensitive_distinct_keyframes")
{
static const String document_rml = R"(
Test
)";
TestsSystemInterface* system_interface = TestsShell::GetTestsSystemInterface();
Context* context = TestsShell::GetContext();
struct TestCase {
String class_name;
float expected_opacity_end;
};
const Vector test_cases = {
{"show-lower", 0.25f},
{"show-upper", 0.5f},
{"show-infinite", 0.75f},
{"show-infinite-upper-keywords", 0.75f},
};
for (const auto& test_case : test_cases)
{
INFO("Class name: ", test_case.class_name);
system_interface->SetTime(0.0);
ElementDocument* document = context->LoadDocumentFromMemory(document_rml, "assets/");
Element* element = document->GetChild(0);
element->SetClass(test_case.class_name, true);
document->Show();
REQUIRE(element->GetProperty("opacity") == 0.f);
constexpr double t_end = 1.0;
constexpr double dt = 0.1;
double t = 0;
while (t < t_end)
{
t += dt;
system_interface->SetTime(t);
context->Update();
}
CHECK(element->GetProperty("opacity") == test_case.expected_opacity_end);
document->Close();
}
system_interface->SetTime(0.0);
TestsShell::ShutdownShell();
}
static const String document_multiple_values_rml = R"(
Test
)";
TEST_CASE("animation.multiple_values")
{
TestsSystemInterface* system_interface = TestsShell::GetTestsSystemInterface();
Context* context = TestsShell::GetContext();
const double dt = 0.1;
const double t_fade_start = 0;
const double t_colorize_start = 1;
const double t_fade_final = 2;
const double t_colorize_final = 5;
struct TestCase {
double time;
float opacity_min;
Colourb background_color;
};
const std::vector tests = {
{t_fade_start, 0.f, {0, 0, 0}},
{t_fade_start + dt, 0.01f, {0, 0, 0}},
{t_colorize_start - dt, 0.4f, {0, 0, 0}},
{t_colorize_start, 0.49f, {0, 0, 0}},
{t_colorize_start + dt, 0.5f, {0xf1, 0x50, 0}},
{t_fade_final - dt, 0.9f, {0x50, 0xf1, 0}},
{t_fade_final, 0.99f, {0, 0xfe, 0x00}},
{t_fade_final + dt, 1.0f, {0, 0xfa, 0x2e}},
{t_colorize_final - dt, 1.0f, {0, 0x2e, 0xfa}},
{t_colorize_final, 1.0f, {0, 0, 0xfe}},
{t_colorize_final + dt, 1.0f, {0, 0, 0}},
};
{
system_interface->SetTime(0.0);
ElementDocument* document = context->LoadDocumentFromMemory(document_multiple_values_rml, "assets/");
Element* element = document->GetChild(0);
document->Show();
double t = 0.f;
for (const auto& test : tests)
{
// Simulate progression in small time steps since animations are constrained to 0.1s maximum step size.
while (t < test.time)
{
t = Math::Min(t + dt, test.time);
system_interface->SetTime(t);
context->Update();
}
INFO("Time: ", test.time);
CHECK(element->GetProperty("opacity") >= test.opacity_min);
CHECK(element->GetProperty("background-color") == test.background_color);
}
document->Close();
}
system_interface->SetTime(0.0);
TestsShell::ShutdownShell();
}
static const String document_animation_multiple_values_rml = R"(
Test
)";
TEST_CASE("animation.multiple_overlapping")
{
TestsSystemInterface* system_interface = TestsShell::GetTestsSystemInterface();
Context* context = TestsShell::GetContext();
const float greater_than_zero = FLT_MIN;
const double dt = 1.0 / 60.0;
const double t0 = 0;
const double t_delta = 0.1;
const double t_fadein_final = 1;
const double t_fadeout_start = 5;
const double t_fadeout_final = 6;
struct TestCase {
double time;
float opacity_min;
bool is_visible;
};
const std::vector tests = {
{t0, 0.f, true},
{t0 + t_delta, greater_than_zero, true},
{t_fadein_final - t_delta, 0.8f, true},
{t_fadein_final, 1.f, true},
{t_fadein_final + t_delta, 1.f, true},
{t_fadeout_start - t_delta, 1.f, true},
{t_fadeout_start, 1.f, true},
{t_fadeout_start + t_delta, 0.8f, true},
{t_fadeout_final - t_delta, greater_than_zero, true},
{t_fadeout_final, 0.f, false},
{t_fadeout_final + t_delta, 0.f, false},
};
// Currently we don't support animating the same property from multiple animations on the same element, see #608.
// This test only checks that we submit warnings to the user. Once we support this feature, we can enable more checks in this test.
{
system_interface->SetNumExpectedWarnings(2);
system_interface->SetTime(0.0);
ElementDocument* document = context->LoadDocumentFromMemory(document_animation_multiple_values_rml, "assets/");
Element* element = document->GetChild(0);
document->Show();
TestsShell::RenderLoop();
double t = 0.f;
for (const auto& test : tests)
{
while (t < test.time)
{
t = Math::Min(t + dt, test.time);
system_interface->SetTime(t);
context->Update();
}
INFO("Time: ", test.time);
(void)(element->GetProperty("opacity") == test.opacity_min);
(void)(element->IsVisible() == test.is_visible);
}
document->Close();
}
system_interface->SetTime(0.0);
TestsShell::ShutdownShell();
}