/* 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/. */

#ifndef mozilla_dom_AnimationTimelinesController_h
#define mozilla_dom_AnimationTimelinesController_h

#include "mozilla/LinkedList.h"

namespace mozilla::dom {
class DocumentTimeline;
class ScrollTimeline;

/**
 * The controller which keeps track of all timelines in a document. So basically
 * each document should have its own AnimationTimelinesController.
 */
class AnimationTimelinesController final {
 public:
  AnimationTimelinesController() = default;
  ~AnimationTimelinesController() {
    // We expect the timelines should remove themself from the controller
    // already.
    MOZ_ASSERT(mDocumentTimelines.isEmpty());
    MOZ_ASSERT(mScrollTimelines.isEmpty());
  }

  void AddDocumentTimeline(DocumentTimeline& aTimeline);
  void AddScrollTimeline(ScrollTimeline& aTimeline);

  void WillRefresh();
  bool UpdateStaleTimelines();
  void UpdateLastRefreshDriverTime();
  void TriggerAllPendingAnimationsNow();
  void UpdateHiddenByContentVisibility();

 private:
  LinkedList<DocumentTimeline> mDocumentTimelines;
  // Note: we use a separate linked list for scroll timelines (and
  // view-timelines) because some utility functions don't need to traverse this
  // list for now. If all functions have to check both lists, we should merge
  // them.
  LinkedList<ScrollTimeline> mScrollTimelines;
};

}  // namespace mozilla::dom

#endif  // mozilla_dom_AnimationTimelinesController_h