| // Copyright 2017 The Chromium Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| #include "third_party/blink/renderer/core/animation/scroll_timeline.h" |
| |
| #include "third_party/blink/renderer/core/css/css_calculation_value.h" |
| #include "third_party/blink/renderer/core/css/css_to_length_conversion_data.h" |
| #include "third_party/blink/renderer/core/css/parser/css_tokenizer.h" |
| #include "third_party/blink/renderer/core/css/properties/css_parsing_utils.h" |
| #include "third_party/blink/renderer/core/dom/node_computed_style.h" |
| #include "third_party/blink/renderer/core/layout/layout_box.h" |
| #include "third_party/blink/renderer/core/layout/layout_view.h" |
| #include "third_party/blink/renderer/core/paint/compositing/paint_layer_compositor.h" |
| #include "third_party/blink/renderer/core/paint/paint_layer.h" |
| #include "third_party/blink/renderer/core/paint/paint_layer_scrollable_area.h" |
| #include "third_party/blink/renderer/platform/geometry/length_functions.h" |
| |
| namespace blink { |
| |
| namespace { |
| using ActiveScrollTimelineSet = HeapHashCountedSet<WeakMember<Node>>; |
| ActiveScrollTimelineSet& GetActiveScrollTimelineSet() { |
| DEFINE_STATIC_LOCAL(Persistent<ActiveScrollTimelineSet>, set, |
| (new ActiveScrollTimelineSet)); |
| return *set; |
| } |
| |
| bool StringToScrollDirection(String scroll_direction, |
| ScrollTimeline::ScrollDirection& result) { |
| if (scroll_direction == "block") { |
| result = ScrollTimeline::Block; |
| return true; |
| } |
| if (scroll_direction == "inline") { |
| result = ScrollTimeline::Inline; |
| return true; |
| } |
| if (scroll_direction == "horizontal") { |
| result = ScrollTimeline::Horizontal; |
| return true; |
| } |
| if (scroll_direction == "vertical") { |
| result = ScrollTimeline::Vertical; |
| return true; |
| } |
| return false; |
| } |
| |
| bool StringToScrollOffset(String scroll_offset, CSSPrimitiveValue** result) { |
| CSSTokenizer tokenizer(scroll_offset); |
| const auto tokens = tokenizer.TokenizeToEOF(); |
| CSSParserTokenRange range(tokens); |
| CSSValue* value = css_parsing_utils::ConsumeScrollOffset(range); |
| if (!value) |
| return false; |
| |
| // We support 'auto', but for simplicity just store it as nullptr. |
| *result = value->IsIdentifierValue() ? nullptr : ToCSSPrimitiveValue(value); |
| return true; |
| } |
| |
| // Note that the resolution process may trigger document lifecycle to clean |
| // style and layout. |
| Node* ResolveScrollSource(Element* scroll_source) { |
| // When in quirks mode we need the style to be clean, so we don't use |
| // |ScrollingElementNoLayout|. |
| if (scroll_source && |
| scroll_source == scroll_source->GetDocument().scrollingElement()) { |
| return &scroll_source->GetDocument(); |
| } |
| return scroll_source; |
| } |
| } // namespace |
| |
| ScrollTimeline* ScrollTimeline::Create(Document& document, |
| ScrollTimelineOptions* options, |
| ExceptionState& exception_state) { |
| Element* scroll_source = options->scrollSource() |
| ? options->scrollSource() |
| : document.scrollingElement(); |
| |
| ScrollDirection orientation; |
| if (!StringToScrollDirection(options->orientation(), orientation)) { |
| exception_state.ThrowDOMException(DOMExceptionCode::kNotSupportedError, |
| "Invalid orientation"); |
| return nullptr; |
| } |
| |
| CSSPrimitiveValue* start_scroll_offset = nullptr; |
| if (!StringToScrollOffset(options->startScrollOffset(), |
| &start_scroll_offset)) { |
| exception_state.ThrowTypeError("Invalid startScrollOffset"); |
| return nullptr; |
| } |
| |
| CSSPrimitiveValue* end_scroll_offset = nullptr; |
| if (!StringToScrollOffset(options->endScrollOffset(), &end_scroll_offset)) { |
| exception_state.ThrowTypeError("Invalid endScrollOffset"); |
| return nullptr; |
| } |
| |
| // TODO(smcgruer): Support 'auto' value. |
| if (options->timeRange().IsScrollTimelineAutoKeyword()) { |
| exception_state.ThrowDOMException( |
| DOMExceptionCode::kNotSupportedError, |
| "'auto' value for timeRange not yet supported"); |
| return nullptr; |
| } |
| |
| return MakeGarbageCollected<ScrollTimeline>( |
| scroll_source, orientation, start_scroll_offset, end_scroll_offset, |
| options->timeRange().GetAsDouble()); |
| } |
| |
| ScrollTimeline::ScrollTimeline(Element* scroll_source, |
| ScrollDirection orientation, |
| CSSPrimitiveValue* start_scroll_offset, |
| CSSPrimitiveValue* end_scroll_offset, |
| double time_range) |
| : scroll_source_(scroll_source), |
| resolved_scroll_source_(ResolveScrollSource(scroll_source_)), |
| orientation_(orientation), |
| start_scroll_offset_(start_scroll_offset), |
| end_scroll_offset_(end_scroll_offset), |
| time_range_(time_range) { |
| } |
| |
| double ScrollTimeline::currentTime(bool& is_null) { |
| is_null = true; |
| |
| // 1. If scrollSource is null, does not currently have a CSS layout box, or if |
| // its layout box is not a scroll container, return an unresolved time value. |
| LayoutBox* layout_box = resolved_scroll_source_ |
| ? resolved_scroll_source_->GetLayoutBox() |
| : nullptr; |
| if (!layout_box || !layout_box->HasOverflowClip()) { |
| return std::numeric_limits<double>::quiet_NaN(); |
| } |
| |
| // 2. Otherwise, let current scroll offset be the current scroll offset of |
| // scrollSource in the direction specified by orientation. |
| |
| double current_offset; |
| double max_offset; |
| GetCurrentAndMaxOffset(layout_box, current_offset, max_offset); |
| |
| double resolved_start_scroll_offset = 0; |
| double resolved_end_scroll_offset = max_offset; |
| ResolveScrollStartAndEnd(layout_box, max_offset, resolved_start_scroll_offset, |
| resolved_end_scroll_offset); |
| |
| // 3. If current scroll offset is less than startScrollOffset, return an |
| // unresolved time value if fill is none or forwards, or 0 otherwise. |
| // TODO(smcgruer): Implement |fill|. |
| if (current_offset < resolved_start_scroll_offset) { |
| return std::numeric_limits<double>::quiet_NaN(); |
| } |
| |
| // 4. If current scroll offset is greater than or equal to endScrollOffset, |
| // return an unresolved time value if fill is none or backwards, or the |
| // effective time range otherwise. |
| // |
| // TODO(smcgruer): Implement |fill|. |
| // |
| // Note we deliberately break the spec here by only returning if the current |
| // offset is strictly greater, as that is more in line with the web animation |
| // spec. See https://github.com/WICG/scroll-animations/issues/19 |
| if (current_offset > resolved_end_scroll_offset) { |
| return std::numeric_limits<double>::quiet_NaN(); |
| } |
| |
| // This is not by the spec, but avoids both negative current time and a |
| // divsion by zero issue. See |
| // https://github.com/WICG/scroll-animations/issues/20 and |
| // https://github.com/WICG/scroll-animations/issues/21 |
| if (resolved_start_scroll_offset >= resolved_end_scroll_offset) { |
| return std::numeric_limits<double>::quiet_NaN(); |
| } |
| |
| // 5. Return the result of evaluating the following expression: |
| // ((current scroll offset - startScrollOffset) / |
| // (endScrollOffset - startScrollOffset)) * effective time range |
| is_null = false; |
| return ((current_offset - resolved_start_scroll_offset) / |
| (resolved_end_scroll_offset - resolved_start_scroll_offset)) * |
| time_range_; |
| } |
| |
| Element* ScrollTimeline::scrollSource() { |
| return scroll_source_.Get(); |
| } |
| |
| String ScrollTimeline::orientation() { |
| switch (orientation_) { |
| case Block: |
| return "block"; |
| case Inline: |
| return "inline"; |
| case Horizontal: |
| return "horizontal"; |
| case Vertical: |
| return "vertical"; |
| default: |
| NOTREACHED(); |
| return ""; |
| } |
| } |
| |
| String ScrollTimeline::startScrollOffset() { |
| return start_scroll_offset_ ? start_scroll_offset_->CssText() : "auto"; |
| } |
| |
| String ScrollTimeline::endScrollOffset() { |
| return end_scroll_offset_ ? end_scroll_offset_->CssText() : "auto"; |
| } |
| |
| void ScrollTimeline::timeRange(DoubleOrScrollTimelineAutoKeyword& result) { |
| result.SetDouble(time_range_); |
| } |
| |
| |
| void ScrollTimeline::GetCurrentAndMaxOffset(const LayoutBox* layout_box, |
| double& current_offset, |
| double& max_offset) const { |
| DCHECK(layout_box); |
| |
| // Depending on the writing-mode and direction, the scroll origin shifts and |
| // the scroll offset may be negative. The easiest way to deal with this is to |
| // use only the magnitude of the scroll offset, and compare it to (max_offset |
| // - min_offset). |
| PaintLayerScrollableArea* scrollable_area = layout_box->GetScrollableArea(); |
| if (!scrollable_area) |
| return; |
| // Using the absolute value of the scroll offset only makes sense if either |
| // the max or min scroll offset for a given axis is 0. This should be |
| // guaranteed by the scroll origin code, but these DCHECKs ensure that. |
| DCHECK(scrollable_area->MaximumScrollOffset().Height() == 0 || |
| scrollable_area->MinimumScrollOffset().Height() == 0); |
| DCHECK(scrollable_area->MaximumScrollOffset().Width() == 0 || |
| scrollable_area->MinimumScrollOffset().Width() == 0); |
| ScrollOffset scroll_offset = scrollable_area->GetScrollOffset(); |
| ScrollOffset scroll_dimensions = scrollable_area->MaximumScrollOffset() - |
| scrollable_area->MinimumScrollOffset(); |
| |
| bool is_horizontal = layout_box->IsHorizontalWritingMode(); |
| if (orientation_ == Block) { |
| current_offset = |
| is_horizontal ? scroll_offset.Height() : scroll_offset.Width(); |
| max_offset = |
| is_horizontal ? scroll_dimensions.Height() : scroll_dimensions.Width(); |
| } else if (orientation_ == Inline) { |
| current_offset = |
| is_horizontal ? scroll_offset.Width() : scroll_offset.Height(); |
| max_offset = |
| is_horizontal ? scroll_dimensions.Width() : scroll_dimensions.Height(); |
| } else if (orientation_ == Horizontal) { |
| current_offset = scroll_offset.Width(); |
| max_offset = scroll_dimensions.Width(); |
| } else { |
| DCHECK(orientation_ == Vertical); |
| current_offset = scroll_offset.Height(); |
| max_offset = scroll_dimensions.Height(); |
| } |
| // When using a rtl direction, current_offset grows correctly from 0 to |
| // max_offset, but is negative. Since our offsets are all just deltas along |
| // the orientation direction, we can just take the absolute current_offset and |
| // use that everywhere. |
| current_offset = std::abs(current_offset); |
| } |
| |
| void ScrollTimeline::ResolveScrollStartAndEnd( |
| const LayoutBox* layout_box, |
| double max_offset, |
| double& resolved_start_scroll_offset, |
| double& resolved_end_scroll_offset) const { |
| DCHECK(layout_box); |
| const ComputedStyle& computed_style = layout_box->StyleRef(); |
| Document& document = layout_box->GetDocument(); |
| const ComputedStyle* root_style = |
| document.documentElement() |
| ? document.documentElement()->GetComputedStyle() |
| : document.GetComputedStyle(); |
| CSSToLengthConversionData conversion_data = CSSToLengthConversionData( |
| &computed_style, root_style, document.GetLayoutView(), |
| computed_style.EffectiveZoom()); |
| if (start_scroll_offset_) { |
| resolved_start_scroll_offset = FloatValueForLength( |
| start_scroll_offset_->ConvertToLength(conversion_data), max_offset); |
| } |
| if (end_scroll_offset_) { |
| resolved_end_scroll_offset = FloatValueForLength( |
| end_scroll_offset_->ConvertToLength(conversion_data), max_offset); |
| } |
| } |
| |
| void ScrollTimeline::AttachAnimation() { |
| if (!resolved_scroll_source_) |
| return; |
| |
| GetActiveScrollTimelineSet().insert(resolved_scroll_source_); |
| if (resolved_scroll_source_->IsElementNode()) |
| ToElement(resolved_scroll_source_)->SetNeedsCompositingUpdate(); |
| resolved_scroll_source_->GetDocument() |
| .GetLayoutView() |
| ->Compositor() |
| ->SetNeedsCompositingUpdate(kCompositingUpdateRebuildTree); |
| LayoutBoxModelObject* object = scroll_source_->GetLayoutBoxModelObject(); |
| if (object && object->HasLayer()) |
| object->Layer()->SetNeedsCompositingInputsUpdate(); |
| if (object) |
| object->SetNeedsPaintPropertyUpdate(); |
| } |
| |
| void ScrollTimeline::DetachAnimation() { |
| if (!resolved_scroll_source_) |
| return; |
| |
| GetActiveScrollTimelineSet().erase(resolved_scroll_source_); |
| if (resolved_scroll_source_->IsElementNode()) |
| ToElement(resolved_scroll_source_)->SetNeedsCompositingUpdate(); |
| auto* layout_view = resolved_scroll_source_->GetDocument().GetLayoutView(); |
| if (layout_view && layout_view->Compositor()) { |
| layout_view->Compositor()->SetNeedsCompositingUpdate( |
| kCompositingUpdateRebuildTree); |
| |
| LayoutBoxModelObject* object = scroll_source_->GetLayoutBoxModelObject(); |
| if (object && object->HasLayer()) |
| object->Layer()->SetNeedsCompositingInputsUpdate(); |
| if (object) |
| object->SetNeedsPaintPropertyUpdate(); |
| } |
| } |
| |
| void ScrollTimeline::Trace(blink::Visitor* visitor) { |
| visitor->Trace(scroll_source_); |
| visitor->Trace(resolved_scroll_source_); |
| visitor->Trace(start_scroll_offset_); |
| visitor->Trace(end_scroll_offset_); |
| AnimationTimeline::Trace(visitor); |
| } |
| |
| bool ScrollTimeline::HasActiveScrollTimeline(Node* node) { |
| ActiveScrollTimelineSet& set = GetActiveScrollTimelineSet(); |
| auto it = set.find(node); |
| return it != set.end() && it->value > 0; |
| } |
| |
| } // namespace blink |