WheelEventTestMonitor.cpp [plain text]
#include "config.h"
#include "WheelEventTestMonitor.h"
#include "Logging.h"
#include "Page.h"
#include <wtf/OptionSet.h>
#include <wtf/RunLoop.h>
#include <wtf/text/TextStream.h>
#if !LOG_DISABLED
#include <wtf/text/CString.h>
#include <wtf/text/StringBuilder.h>
#endif
namespace WebCore {
WheelEventTestMonitor::WheelEventTestMonitor(Page& page)
: m_page(page)
{
}
void WheelEventTestMonitor::clearAllTestDeferrals()
{
LockHolder lock(m_mutex);
ASSERT(isMainThread());
m_deferCompletionReasons.clear();
m_completionCallback = nullptr;
m_everHadDeferral = false;
m_receivedWheelEndOrCancel = false;
m_receivedMomentumEnd = false;
LOG_WITH_STREAM(WheelEventTestMonitor, stream << " WheelEventTestMonitor::clearAllTestDeferrals: cleared all test state.");
}
void WheelEventTestMonitor::setTestCallbackAndStartMonitoring(bool expectWheelEndOrCancel, bool expectMomentumEnd, WTF::Function<void()>&& functionCallback)
{
ASSERT(isMainThread());
m_completionCallback = WTFMove(functionCallback);
#if ENABLE(KINETIC_SCROLLING)
m_expectWheelEndOrCancel = expectWheelEndOrCancel;
m_expectMomentumEnd = expectMomentumEnd;
#else
UNUSED_PARAM(expectWheelEndOrCancel);
UNUSED_PARAM(expectMomentumEnd);
#endif
m_page.scheduleRenderingUpdate(RenderingUpdateStep::WheelEventMonitorCallbacks);
LOG_WITH_STREAM(WheelEventTestMonitor, stream << " WheelEventTestMonitor::setTestCallbackAndStartMonitoring - expect end/cancel " << expectWheelEndOrCancel << ", expect momentum end " << expectMomentumEnd);
}
void WheelEventTestMonitor::deferForReason(ScrollableAreaIdentifier identifier, DeferReason reason)
{
LockHolder lock(m_mutex);
m_deferCompletionReasons.ensure(identifier, [] {
return OptionSet<DeferReason>();
}).iterator->value.add(reason);
m_everHadDeferral = true;
LOG_WITH_STREAM(WheelEventTestMonitor, stream << " (=) WheelEventTestMonitor::deferForReason: id=" << identifier << ", reason=" << reason);
}
void WheelEventTestMonitor::removeDeferralForReason(ScrollableAreaIdentifier identifier, DeferReason reason)
{
LockHolder lock(m_mutex);
auto it = m_deferCompletionReasons.find(identifier);
if (it == m_deferCompletionReasons.end()) {
LOG_WITH_STREAM(WheelEventTestMonitor, stream << " (=) WheelEventTestMonitor::removeDeferralForReason: failed to find defer for id=" << identifier << ", reason=" << reason);
return;
}
LOG_WITH_STREAM(WheelEventTestMonitor, stream << " (=) WheelEventTestMonitor::removeDeferralForReason: id=" << identifier << ", reason=" << reason);
it->value.remove(reason);
if (it->value.isEmpty())
m_deferCompletionReasons.remove(it);
scheduleCallbackCheck();
}
void WheelEventTestMonitor::receivedWheelEvent(const PlatformWheelEvent& event)
{
#if ENABLE(KINETIC_SCROLLING)
if (event.phase() == PlatformWheelEventPhase::Ended || event.phase() == PlatformWheelEventPhase::Cancelled)
m_receivedWheelEndOrCancel = true;
if (event.momentumPhase() == PlatformWheelEventPhase::Ended)
m_receivedMomentumEnd = true;
#endif
}
void WheelEventTestMonitor::scheduleCallbackCheck()
{
if (isMainThread()) {
m_page.scheduleRenderingUpdate(RenderingUpdateStep::WheelEventMonitorCallbacks);
return;
}
RunLoop::main().dispatch([weakPage = makeWeakPtr(m_page)] {
if (weakPage)
weakPage->scheduleRenderingUpdate(RenderingUpdateStep::WheelEventMonitorCallbacks);
});
}
void WheelEventTestMonitor::checkShouldFireCallbacks()
{
ASSERT(isMainThread());
{
LockHolder lock(m_mutex);
if (!m_deferCompletionReasons.isEmpty()) {
LOG_WITH_STREAM(WheelEventTestMonitor, stream << " WheelEventTestMonitor::checkShouldFireCallbacks - scrolling still active, reasons " << m_deferCompletionReasons);
return;
}
if (!m_everHadDeferral) {
LOG_WITH_STREAM(WheelEventTestMonitor, stream << " WheelEventTestMonitor::checkShouldFireCallbacks - have not yet seen any deferral reasons");
return;
}
if (m_expectWheelEndOrCancel && !m_receivedWheelEndOrCancel) {
LOG_WITH_STREAM(WheelEventTestMonitor, stream << " WheelEventTestMonitor::checkShouldFireCallbacks - have not seen end of of wheel phase");
return;
}
if (m_expectMomentumEnd && !m_receivedMomentumEnd) {
LOG_WITH_STREAM(WheelEventTestMonitor, stream << " WheelEventTestMonitor::checkShouldFireCallbacks - have not seen end of of momentum phase");
return;
}
}
if (auto functionCallback = WTFMove(m_completionCallback)) {
LOG_WITH_STREAM(WheelEventTestMonitor, stream << " WheelEventTestMonitor::checkShouldFireCallbacks: scrolling is idle, FIRING TEST");
functionCallback();
} else
LOG_WITH_STREAM(WheelEventTestMonitor, stream << " WheelEventTestMonitor::checkShouldFireCallbacks - no callback");
}
TextStream& operator<<(TextStream& ts, WheelEventTestMonitor::DeferReason reason)
{
switch (reason) {
case WheelEventTestMonitor::HandlingWheelEvent: ts << "handling wheel event"; break;
case WheelEventTestMonitor::HandlingWheelEventOnMainThread: ts << "handling wheel event on main thread"; break;
case WheelEventTestMonitor::PostMainThreadWheelEventHandling: ts << "post-main thread event handling"; break;
case WheelEventTestMonitor::RubberbandInProgress: ts << "rubberbanding"; break;
case WheelEventTestMonitor::ScrollSnapInProgress: ts << "scroll-snapping"; break;
case WheelEventTestMonitor::ScrollingThreadSyncNeeded: ts << "scrolling thread sync needed"; break;
case WheelEventTestMonitor::ContentScrollInProgress: ts << "content scrolling"; break;
case WheelEventTestMonitor::RequestedScrollPosition: ts << "requested scroll position"; break;
}
return ts;
}
TextStream& operator<<(TextStream& ts, const WheelEventTestMonitor::ScrollableAreaReasonMap& reasonMap)
{
for (const auto& regionReasonsPair : reasonMap)
ts << " scroll region: " << regionReasonsPair.key << " reasons: " << regionReasonsPair.value;
return ts;
}
}