summaryrefslogtreecommitdiffstats
path: root/layout/style/TimelineManager.cpp
blob: 4adc03df173f32cbba92f032e4703e53b2998835 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* 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 "TimelineManager.h"

#include "mozilla/ElementAnimationData.h"
#include "mozilla/dom/Element.h"
#include "mozilla/dom/ScrollTimeline.h"
#include "mozilla/dom/ViewTimeline.h"
#include "nsPresContext.h"

namespace mozilla {
using dom::Element;
using dom::ScrollTimeline;
using dom::ViewTimeline;

template <typename TimelineType>
void TryDestroyTimeline(Element* aElement, PseudoStyleType aPseudoType) {
  auto* collection =
      TimelineCollection<TimelineType>::Get(aElement, aPseudoType);
  if (!collection) {
    return;
  }
  collection->Destroy();
}

void TimelineManager::UpdateTimelines(Element* aElement,
                                      PseudoStyleType aPseudoType,
                                      const ComputedStyle* aComputedStyle,
                                      ProgressTimelineType aType) {
  MOZ_ASSERT(
      aElement->IsInComposedDoc(),
      "No need to update timelines that are not attached to the document tree");

  // If we are in a display:none subtree we will have no computed values.
  // However, if we are on the root of display:none subtree, the computed values
  // might not have been cleared yet. In either case, since CSS animations
  // should not run in display:none subtrees, so we don't need timeline, either.
  const bool shouldDestroyTimelines =
      !aComputedStyle ||
      aComputedStyle->StyleDisplay()->mDisplay == StyleDisplay::None;

  switch (aType) {
    case ProgressTimelineType::Scroll:
      if (shouldDestroyTimelines) {
        TryDestroyTimeline<ScrollTimeline>(aElement, aPseudoType);
        return;
      }
      DoUpdateTimelines<StyleScrollTimeline, ScrollTimeline>(
          mPresContext, aElement, aPseudoType,
          aComputedStyle->StyleUIReset()->mScrollTimelines,
          aComputedStyle->StyleUIReset()->mScrollTimelineNameCount);
      break;

    case ProgressTimelineType::View:
      if (shouldDestroyTimelines) {
        TryDestroyTimeline<ViewTimeline>(aElement, aPseudoType);
        return;
      }
      DoUpdateTimelines<StyleViewTimeline, ViewTimeline>(
          mPresContext, aElement, aPseudoType,
          aComputedStyle->StyleUIReset()->mViewTimelines,
          aComputedStyle->StyleUIReset()->mViewTimelineNameCount);
      break;
  }
}

template <typename TimelineType>
static already_AddRefed<TimelineType> PopExistingTimeline(
    nsAtom* aName, TimelineCollection<TimelineType>* aCollection) {
  if (!aCollection) {
    return nullptr;
  }
  return aCollection->Extract(aName);
}

template <typename StyleType, typename TimelineType>
static auto BuildTimelines(nsPresContext* aPresContext, Element* aElement,
                           PseudoStyleType aPseudoType,
                           const nsStyleAutoArray<StyleType>& aTimelines,
                           size_t aTimelineCount,
                           TimelineCollection<TimelineType>* aCollection) {
  typename TimelineCollection<TimelineType>::TimelineMap result;
  // If multiple timelines are attempting to modify the same property, then the
  // timeline closest to the end of the list of names wins.
  // The spec doesn't mention this specifically for scroll-timeline-name and
  // view-timeline-name, so we follow the same rule with animation-name.
  for (size_t idx = 0; idx < aTimelineCount; ++idx) {
    const StyleType& timeline = aTimelines[idx];
    if (timeline.GetName() == nsGkAtoms::_empty) {
      continue;
    }

    RefPtr<TimelineType> dest =
        PopExistingTimeline(timeline.GetName(), aCollection);
    if (dest) {
      dest->ReplacePropertiesWith(aElement, aPseudoType, timeline);
    } else {
      dest = TimelineType::MakeNamed(aPresContext->Document(), aElement,
                                     aPseudoType, timeline);
    }
    MOZ_ASSERT(dest);

    // Override the previous one if it is duplicated.
    Unused << result.InsertOrUpdate(timeline.GetName(), dest);
  }
  return result;
}

template <typename TimelineType>
static TimelineCollection<TimelineType>& EnsureTimelineCollection(
    Element& aElement, PseudoStyleType aPseudoType);

template <>
ScrollTimelineCollection& EnsureTimelineCollection<ScrollTimeline>(
    Element& aElement, PseudoStyleType aPseudoType) {
  return aElement.EnsureAnimationData().EnsureScrollTimelineCollection(
      aElement, aPseudoType);
}

template <>
ViewTimelineCollection& EnsureTimelineCollection<ViewTimeline>(
    Element& aElement, PseudoStyleType aPseudoType) {
  return aElement.EnsureAnimationData().EnsureViewTimelineCollection(
      aElement, aPseudoType);
}

template <typename StyleType, typename TimelineType>
void TimelineManager::DoUpdateTimelines(
    nsPresContext* aPresContext, Element* aElement, PseudoStyleType aPseudoType,
    const nsStyleAutoArray<StyleType>& aStyleTimelines, size_t aTimelineCount) {
  auto* collection =
      TimelineCollection<TimelineType>::Get(aElement, aPseudoType);
  if (!collection && aTimelineCount == 1 &&
      aStyleTimelines[0].GetName() == nsGkAtoms::_empty) {
    return;
  }

  // We create a new timeline list based on its computed style and the existing
  // timelines.
  auto newTimelines = BuildTimelines<StyleType, TimelineType>(
      aPresContext, aElement, aPseudoType, aStyleTimelines, aTimelineCount,
      collection);

  if (newTimelines.IsEmpty()) {
    if (collection) {
      collection->Destroy();
    }
    return;
  }

  if (!collection) {
    collection =
        &EnsureTimelineCollection<TimelineType>(*aElement, aPseudoType);
    if (!collection->isInList()) {
      AddTimelineCollection(collection);
    }
  }

  // Replace unused timeline with new ones.
  collection->Swap(newTimelines);

  // FIXME: Bug 1774060. We may have to restyle the animations which use the
  // dropped timelines. Or rely on restyling the subtree and the following
  // siblings when mutating {scroll|view}-timeline-name.
}

void TimelineManager::UpdateHiddenByContentVisibilityForAnimations() {
  for (auto* scrollTimelineCollection : mScrollTimelineCollections) {
    for (ScrollTimeline* timeline :
         scrollTimelineCollection->Timelines().Values()) {
      timeline->UpdateHiddenByContentVisibility();
    }
  }

  for (auto* viewTimelineCollection : mViewTimelineCollections) {
    for (ViewTimeline* timeline :
         viewTimelineCollection->Timelines().Values()) {
      timeline->UpdateHiddenByContentVisibility();
    }
  }
}

}  // namespace mozilla