forked from mirrors/gecko-dev
d012e4ca2e
Bug 1517241 renamed nsIDocument to mozilla::dom::Document but unfortunately in the process it messed up the ordering of includes which, according to the coding style[1], should be alphabetically sorted. Also, in TimingParams.cpp it didn't add the dom::* prefix so when the unified build chunking changes, if the "using namespace mozilla::dom" declaration disappears from the chunk, it will fail to build. [1] https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Coding_Style#CC_practices Depends on D15902 Differential Revision: https://phabricator.services.mozilla.com/D15903 --HG-- extra : moz-landing-system : lando
111 lines
3.7 KiB
C++
111 lines
3.7 KiB
C++
/* -*- 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/. */
|
|
|
|
#ifndef mozilla_dom_DocumentTimeline_h
|
|
#define mozilla_dom_DocumentTimeline_h
|
|
|
|
#include "mozilla/dom/Document.h"
|
|
#include "mozilla/dom/DocumentTimelineBinding.h"
|
|
#include "mozilla/LinkedList.h"
|
|
#include "mozilla/TimeStamp.h"
|
|
#include "AnimationTimeline.h"
|
|
#include "nsDOMNavigationTiming.h" // for DOMHighResTimeStamp
|
|
#include "nsRefreshDriver.h"
|
|
|
|
struct JSContext;
|
|
|
|
namespace mozilla {
|
|
namespace dom {
|
|
|
|
class DocumentTimeline final : public AnimationTimeline,
|
|
public nsARefreshObserver,
|
|
public nsATimerAdjustmentObserver,
|
|
public LinkedListElement<DocumentTimeline> {
|
|
public:
|
|
DocumentTimeline(Document* aDocument, const TimeDuration& aOriginTime)
|
|
: AnimationTimeline(aDocument->GetParentObject()),
|
|
mDocument(aDocument),
|
|
mIsObservingRefreshDriver(false),
|
|
mOriginTime(aOriginTime) {
|
|
if (mDocument) {
|
|
mDocument->Timelines().insertBack(this);
|
|
}
|
|
}
|
|
|
|
protected:
|
|
virtual ~DocumentTimeline() {
|
|
MOZ_ASSERT(!mIsObservingRefreshDriver,
|
|
"Timeline should have disassociated"
|
|
" from the refresh driver before being destroyed");
|
|
if (isInList()) {
|
|
remove();
|
|
}
|
|
}
|
|
|
|
public:
|
|
NS_DECL_ISUPPORTS_INHERITED
|
|
NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS_INHERITED(DocumentTimeline,
|
|
AnimationTimeline)
|
|
|
|
virtual JSObject* WrapObject(JSContext* aCx,
|
|
JS::Handle<JSObject*> aGivenProto) override;
|
|
|
|
static already_AddRefed<DocumentTimeline> Constructor(
|
|
const GlobalObject& aGlobal, const DocumentTimelineOptions& aOptions,
|
|
ErrorResult& aRv);
|
|
|
|
// AnimationTimeline methods
|
|
|
|
// This is deliberately _not_ called GetCurrentTime since that would clash
|
|
// with a macro defined in winbase.h
|
|
virtual Nullable<TimeDuration> GetCurrentTimeAsDuration() const override;
|
|
|
|
bool TracksWallclockTime() const override {
|
|
nsRefreshDriver* refreshDriver = GetRefreshDriver();
|
|
return !refreshDriver ||
|
|
!refreshDriver->IsTestControllingRefreshesEnabled();
|
|
}
|
|
Nullable<TimeDuration> ToTimelineTime(
|
|
const TimeStamp& aTimeStamp) const override;
|
|
TimeStamp ToTimeStamp(const TimeDuration& aTimelineTime) const override;
|
|
|
|
void NotifyAnimationUpdated(Animation& aAnimation) override;
|
|
|
|
void RemoveAnimation(Animation* aAnimation) override;
|
|
|
|
// nsARefreshObserver methods
|
|
void WillRefresh(TimeStamp aTime) override;
|
|
// nsATimerAdjustmentObserver methods
|
|
void NotifyTimerAdjusted(TimeStamp aTime) override;
|
|
|
|
void NotifyRefreshDriverCreated(nsRefreshDriver* aDriver);
|
|
void NotifyRefreshDriverDestroying(nsRefreshDriver* aDriver);
|
|
|
|
Document* GetDocument() const override { return mDocument; }
|
|
|
|
protected:
|
|
TimeStamp GetCurrentTimeStamp() const;
|
|
nsRefreshDriver* GetRefreshDriver() const;
|
|
void UnregisterFromRefreshDriver();
|
|
void MostRecentRefreshTimeUpdated();
|
|
void ObserveRefreshDriver(nsRefreshDriver* aDriver);
|
|
void DisconnectRefreshDriver(nsRefreshDriver* aDriver);
|
|
|
|
RefPtr<Document> mDocument;
|
|
|
|
// The most recently used refresh driver time. This is used in cases where
|
|
// we don't have a refresh driver (e.g. because we are in a display:none
|
|
// iframe).
|
|
mutable TimeStamp mLastRefreshDriverTime;
|
|
bool mIsObservingRefreshDriver;
|
|
|
|
TimeDuration mOriginTime;
|
|
};
|
|
|
|
} // namespace dom
|
|
} // namespace mozilla
|
|
|
|
#endif // mozilla_dom_DocumentTimeline_h
|