forked from mirrors/gecko-dev
da8dbbfc2f
Ideally we can write a wpt for this case, but it doesn't work due to
bug 1674687 and ClampAndAlignWithPixels [1] in our code. In the wpt we can use
waitForScrollTo [2] to wait for the end of an async scroll operation, say
a scrollBy call with `behavior: smooth`, at some point where it's close to the
final scroll destination APZ reports a fractional scroll offset close to the
destination, it will be clamped and rounded to the final destination value, thus
waitForScrollTo considers it reached to the end of the scroll operation. At the
moment APZ considers the async scroll is still in progress, which mean the snap
target ids haven't yet been reported to back the main-thread unfortunately.
[1] https://searchfox.org/mozilla-central/rev/170f06a720ddabee44c728b05ad30b18b066acca/layout/generic/nsGfxScrollFrame.cpp#2847
[2] https://searchfox.org/mozilla-central/rev/170f06a720ddabee44c728b05ad30b18b066acca/testing/web-platform/tests/css/css-scroll-snap/support/common.js#84
Depends on D149496
Differential Revision: https://phabricator.services.mozilla.com/D149497
140 lines
4.7 KiB
C++
140 lines
4.7 KiB
C++
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
#include "ScrollPositionUpdate.h"
|
|
|
|
#include <ostream>
|
|
|
|
#include "mozilla/Assertions.h"
|
|
|
|
namespace mozilla {
|
|
|
|
static ScrollGenerationCounter sGenerationCounter;
|
|
|
|
ScrollPositionUpdate::ScrollPositionUpdate()
|
|
: mType(ScrollUpdateType::Absolute),
|
|
mScrollMode(ScrollMode::Normal),
|
|
mScrollOrigin(ScrollOrigin::None),
|
|
mTriggeredByScript(ScrollTriggeredByScript::No) {}
|
|
|
|
/*static*/
|
|
ScrollPositionUpdate ScrollPositionUpdate::NewScrollframe(
|
|
nsPoint aInitialPosition) {
|
|
ScrollPositionUpdate ret;
|
|
ret.mScrollGeneration = sGenerationCounter.NewMainThreadGeneration();
|
|
ret.mScrollMode = ScrollMode::Instant;
|
|
ret.mDestination = CSSPoint::FromAppUnits(aInitialPosition);
|
|
return ret;
|
|
}
|
|
|
|
/*static*/
|
|
ScrollPositionUpdate ScrollPositionUpdate::NewScroll(ScrollOrigin aOrigin,
|
|
nsPoint aDestination) {
|
|
MOZ_ASSERT(aOrigin != ScrollOrigin::NotSpecified);
|
|
MOZ_ASSERT(aOrigin != ScrollOrigin::None);
|
|
|
|
ScrollPositionUpdate ret;
|
|
ret.mScrollGeneration = sGenerationCounter.NewMainThreadGeneration();
|
|
ret.mType = ScrollUpdateType::Absolute;
|
|
ret.mScrollMode = ScrollMode::Instant;
|
|
ret.mScrollOrigin = aOrigin;
|
|
ret.mDestination = CSSPoint::FromAppUnits(aDestination);
|
|
return ret;
|
|
}
|
|
|
|
/*static*/
|
|
ScrollPositionUpdate ScrollPositionUpdate::NewRelativeScroll(
|
|
nsPoint aSource, nsPoint aDestination) {
|
|
ScrollPositionUpdate ret;
|
|
ret.mScrollGeneration = sGenerationCounter.NewMainThreadGeneration();
|
|
ret.mType = ScrollUpdateType::Relative;
|
|
ret.mScrollMode = ScrollMode::Instant;
|
|
ret.mScrollOrigin = ScrollOrigin::Relative;
|
|
ret.mDestination = CSSPoint::FromAppUnits(aDestination);
|
|
ret.mSource = CSSPoint::FromAppUnits(aSource);
|
|
return ret;
|
|
}
|
|
|
|
/*static*/
|
|
ScrollPositionUpdate ScrollPositionUpdate::NewSmoothScroll(
|
|
ScrollOrigin aOrigin, nsPoint aDestination,
|
|
ScrollTriggeredByScript aTriggeredByScript,
|
|
UniquePtr<ScrollSnapTargetIds> aSnapTargetIds) {
|
|
MOZ_ASSERT(aOrigin != ScrollOrigin::NotSpecified);
|
|
MOZ_ASSERT(aOrigin != ScrollOrigin::None);
|
|
|
|
ScrollPositionUpdate ret;
|
|
ret.mScrollGeneration = sGenerationCounter.NewMainThreadGeneration();
|
|
ret.mType = ScrollUpdateType::Absolute;
|
|
ret.mScrollMode = ScrollMode::SmoothMsd;
|
|
ret.mScrollOrigin = aOrigin;
|
|
ret.mDestination = CSSPoint::FromAppUnits(aDestination);
|
|
ret.mTriggeredByScript = aTriggeredByScript;
|
|
if (aSnapTargetIds) {
|
|
ret.mSnapTargetIds = *aSnapTargetIds;
|
|
}
|
|
return ret;
|
|
}
|
|
|
|
/*static*/
|
|
ScrollPositionUpdate ScrollPositionUpdate::NewPureRelativeScroll(
|
|
ScrollOrigin aOrigin, ScrollMode aMode, const nsPoint& aDelta) {
|
|
MOZ_ASSERT(aOrigin != ScrollOrigin::NotSpecified);
|
|
MOZ_ASSERT(aOrigin != ScrollOrigin::None);
|
|
|
|
ScrollPositionUpdate ret;
|
|
ret.mScrollGeneration = sGenerationCounter.NewMainThreadGeneration();
|
|
ret.mType = ScrollUpdateType::PureRelative;
|
|
ret.mScrollMode = aMode;
|
|
ret.mScrollOrigin = aOrigin;
|
|
ret.mDelta = CSSPoint::FromAppUnits(aDelta);
|
|
return ret;
|
|
}
|
|
|
|
bool ScrollPositionUpdate::operator==(
|
|
const ScrollPositionUpdate& aOther) const {
|
|
// instances are immutable, and all the fields are set when the generation
|
|
// is set. So if the generation matches, these instances are identical.
|
|
return mScrollGeneration == aOther.mScrollGeneration;
|
|
}
|
|
|
|
MainThreadScrollGeneration ScrollPositionUpdate::GetGeneration() const {
|
|
return mScrollGeneration;
|
|
}
|
|
|
|
ScrollUpdateType ScrollPositionUpdate::GetType() const { return mType; }
|
|
|
|
ScrollMode ScrollPositionUpdate::GetMode() const { return mScrollMode; }
|
|
|
|
ScrollOrigin ScrollPositionUpdate::GetOrigin() const { return mScrollOrigin; }
|
|
|
|
CSSPoint ScrollPositionUpdate::GetDestination() const {
|
|
MOZ_ASSERT(mType == ScrollUpdateType::Absolute ||
|
|
mType == ScrollUpdateType::Relative);
|
|
return mDestination;
|
|
}
|
|
|
|
CSSPoint ScrollPositionUpdate::GetSource() const {
|
|
MOZ_ASSERT(mType == ScrollUpdateType::Relative);
|
|
return mSource;
|
|
}
|
|
|
|
CSSPoint ScrollPositionUpdate::GetDelta() const {
|
|
MOZ_ASSERT(mType == ScrollUpdateType::PureRelative);
|
|
return mDelta;
|
|
}
|
|
|
|
std::ostream& operator<<(std::ostream& aStream,
|
|
const ScrollPositionUpdate& aUpdate) {
|
|
aStream << "{ gen=" << aUpdate.mScrollGeneration
|
|
<< ", type=" << (int)aUpdate.mType
|
|
<< ", mode=" << (int)aUpdate.mScrollMode
|
|
<< ", origin=" << (int)aUpdate.mScrollOrigin
|
|
<< ", dst=" << aUpdate.mDestination << ", src=" << aUpdate.mSource
|
|
<< ", delta=" << aUpdate.mDelta
|
|
<< ", triggered by script=" << aUpdate.WasTriggeredByScript() << " }";
|
|
return aStream;
|
|
}
|
|
|
|
} // namespace mozilla
|