gecko-dev/dom/smil/nsSMILInstanceTime.h
Robert O'Callahan 260b32ab87 Bug 946065. Part 3: Move content/smil to dom/smil. r=Ms2ger
--HG--
rename : content/smil/SMILBoolType.cpp => dom/smil/SMILBoolType.cpp
rename : content/smil/SMILBoolType.h => dom/smil/SMILBoolType.h
rename : content/smil/SMILEnumType.cpp => dom/smil/SMILEnumType.cpp
rename : content/smil/SMILEnumType.h => dom/smil/SMILEnumType.h
rename : content/smil/SMILIntegerType.cpp => dom/smil/SMILIntegerType.cpp
rename : content/smil/SMILIntegerType.h => dom/smil/SMILIntegerType.h
rename : content/smil/SMILStringType.cpp => dom/smil/SMILStringType.cpp
rename : content/smil/SMILStringType.h => dom/smil/SMILStringType.h
rename : content/smil/crashtests/483584-1.svg => dom/smil/crashtests/483584-1.svg
rename : content/smil/crashtests/483584-2.svg => dom/smil/crashtests/483584-2.svg
rename : content/smil/crashtests/523188-1.svg => dom/smil/crashtests/523188-1.svg
rename : content/smil/crashtests/525099-1.svg => dom/smil/crashtests/525099-1.svg
rename : content/smil/crashtests/526536-1.svg => dom/smil/crashtests/526536-1.svg
rename : content/smil/crashtests/526875-1.svg => dom/smil/crashtests/526875-1.svg
rename : content/smil/crashtests/526875-2.svg => dom/smil/crashtests/526875-2.svg
rename : content/smil/crashtests/529387-1-helper.svg => dom/smil/crashtests/529387-1-helper.svg
rename : content/smil/crashtests/529387-1.xhtml => dom/smil/crashtests/529387-1.xhtml
rename : content/smil/crashtests/531550-1.svg => dom/smil/crashtests/531550-1.svg
rename : content/smil/crashtests/537157-1.svg => dom/smil/crashtests/537157-1.svg
rename : content/smil/crashtests/541297-1.svg => dom/smil/crashtests/541297-1.svg
rename : content/smil/crashtests/547333-1.svg => dom/smil/crashtests/547333-1.svg
rename : content/smil/crashtests/548899-1.svg => dom/smil/crashtests/548899-1.svg
rename : content/smil/crashtests/551620-1.svg => dom/smil/crashtests/551620-1.svg
rename : content/smil/crashtests/554141-1.svg => dom/smil/crashtests/554141-1.svg
rename : content/smil/crashtests/554202-1.svg => dom/smil/crashtests/554202-1.svg
rename : content/smil/crashtests/554202-2.svg => dom/smil/crashtests/554202-2.svg
rename : content/smil/crashtests/555026-1.svg => dom/smil/crashtests/555026-1.svg
rename : content/smil/crashtests/556841-1.svg => dom/smil/crashtests/556841-1.svg
rename : content/smil/crashtests/572938-1.svg => dom/smil/crashtests/572938-1.svg
rename : content/smil/crashtests/572938-2.svg => dom/smil/crashtests/572938-2.svg
rename : content/smil/crashtests/572938-3.svg => dom/smil/crashtests/572938-3.svg
rename : content/smil/crashtests/572938-4.svg => dom/smil/crashtests/572938-4.svg
rename : content/smil/crashtests/588287-1.svg => dom/smil/crashtests/588287-1.svg
rename : content/smil/crashtests/588287-2.svg => dom/smil/crashtests/588287-2.svg
rename : content/smil/crashtests/590425-1.html => dom/smil/crashtests/590425-1.html
rename : content/smil/crashtests/592477-1.xhtml => dom/smil/crashtests/592477-1.xhtml
rename : content/smil/crashtests/594653-1.svg => dom/smil/crashtests/594653-1.svg
rename : content/smil/crashtests/596796-1.svg => dom/smil/crashtests/596796-1.svg
rename : content/smil/crashtests/605345-1.svg => dom/smil/crashtests/605345-1.svg
rename : content/smil/crashtests/606101-1.svg => dom/smil/crashtests/606101-1.svg
rename : content/smil/crashtests/608295-1.html => dom/smil/crashtests/608295-1.html
rename : content/smil/crashtests/608549-1.svg => dom/smil/crashtests/608549-1.svg
rename : content/smil/crashtests/611927-1.svg => dom/smil/crashtests/611927-1.svg
rename : content/smil/crashtests/615002-1.svg => dom/smil/crashtests/615002-1.svg
rename : content/smil/crashtests/615872-1.svg => dom/smil/crashtests/615872-1.svg
rename : content/smil/crashtests/641388-1.html => dom/smil/crashtests/641388-1.html
rename : content/smil/crashtests/641388-2.html => dom/smil/crashtests/641388-2.html
rename : content/smil/crashtests/650732-1.svg => dom/smil/crashtests/650732-1.svg
rename : content/smil/crashtests/665334-1.svg => dom/smil/crashtests/665334-1.svg
rename : content/smil/crashtests/669225-1.svg => dom/smil/crashtests/669225-1.svg
rename : content/smil/crashtests/669225-2.svg => dom/smil/crashtests/669225-2.svg
rename : content/smil/crashtests/670313-1.svg => dom/smil/crashtests/670313-1.svg
rename : content/smil/crashtests/678822-1.svg => dom/smil/crashtests/678822-1.svg
rename : content/smil/crashtests/678847-1.svg => dom/smil/crashtests/678847-1.svg
rename : content/smil/crashtests/678938-1.svg => dom/smil/crashtests/678938-1.svg
rename : content/smil/crashtests/690994-1.svg => dom/smil/crashtests/690994-1.svg
rename : content/smil/crashtests/691337-1.svg => dom/smil/crashtests/691337-1.svg
rename : content/smil/crashtests/691337-2.svg => dom/smil/crashtests/691337-2.svg
rename : content/smil/crashtests/697640-1.svg => dom/smil/crashtests/697640-1.svg
rename : content/smil/crashtests/699325-1.svg => dom/smil/crashtests/699325-1.svg
rename : content/smil/crashtests/709907-1.svg => dom/smil/crashtests/709907-1.svg
rename : content/smil/crashtests/720103-1.svg => dom/smil/crashtests/720103-1.svg
rename : content/smil/crashtests/crashtests.list => dom/smil/crashtests/crashtests.list
rename : content/smil/moz.build => dom/smil/moz.build
rename : content/smil/nsDOMTimeEvent.cpp => dom/smil/nsDOMTimeEvent.cpp
rename : content/smil/nsDOMTimeEvent.h => dom/smil/nsDOMTimeEvent.h
rename : content/smil/nsISMILAttr.h => dom/smil/nsISMILAttr.h
rename : content/smil/nsISMILType.h => dom/smil/nsISMILType.h
rename : content/smil/nsSMILAnimationController.cpp => dom/smil/nsSMILAnimationController.cpp
rename : content/smil/nsSMILAnimationController.h => dom/smil/nsSMILAnimationController.h
rename : content/smil/nsSMILAnimationFunction.cpp => dom/smil/nsSMILAnimationFunction.cpp
rename : content/smil/nsSMILAnimationFunction.h => dom/smil/nsSMILAnimationFunction.h
rename : content/smil/nsSMILCSSProperty.cpp => dom/smil/nsSMILCSSProperty.cpp
rename : content/smil/nsSMILCSSProperty.h => dom/smil/nsSMILCSSProperty.h
rename : content/smil/nsSMILCSSValueType.cpp => dom/smil/nsSMILCSSValueType.cpp
rename : content/smil/nsSMILCSSValueType.h => dom/smil/nsSMILCSSValueType.h
rename : content/smil/nsSMILCompositor.cpp => dom/smil/nsSMILCompositor.cpp
rename : content/smil/nsSMILCompositor.h => dom/smil/nsSMILCompositor.h
rename : content/smil/nsSMILCompositorTable.h => dom/smil/nsSMILCompositorTable.h
rename : content/smil/nsSMILFloatType.cpp => dom/smil/nsSMILFloatType.cpp
rename : content/smil/nsSMILFloatType.h => dom/smil/nsSMILFloatType.h
rename : content/smil/nsSMILInstanceTime.cpp => dom/smil/nsSMILInstanceTime.cpp
rename : content/smil/nsSMILInstanceTime.h => dom/smil/nsSMILInstanceTime.h
rename : content/smil/nsSMILInterval.cpp => dom/smil/nsSMILInterval.cpp
rename : content/smil/nsSMILInterval.h => dom/smil/nsSMILInterval.h
rename : content/smil/nsSMILKeySpline.cpp => dom/smil/nsSMILKeySpline.cpp
rename : content/smil/nsSMILKeySpline.h => dom/smil/nsSMILKeySpline.h
rename : content/smil/nsSMILMappedAttribute.cpp => dom/smil/nsSMILMappedAttribute.cpp
rename : content/smil/nsSMILMappedAttribute.h => dom/smil/nsSMILMappedAttribute.h
rename : content/smil/nsSMILMilestone.h => dom/smil/nsSMILMilestone.h
rename : content/smil/nsSMILNullType.cpp => dom/smil/nsSMILNullType.cpp
rename : content/smil/nsSMILNullType.h => dom/smil/nsSMILNullType.h
rename : content/smil/nsSMILParserUtils.cpp => dom/smil/nsSMILParserUtils.cpp
rename : content/smil/nsSMILParserUtils.h => dom/smil/nsSMILParserUtils.h
rename : content/smil/nsSMILRepeatCount.cpp => dom/smil/nsSMILRepeatCount.cpp
rename : content/smil/nsSMILRepeatCount.h => dom/smil/nsSMILRepeatCount.h
rename : content/smil/nsSMILSetAnimationFunction.cpp => dom/smil/nsSMILSetAnimationFunction.cpp
rename : content/smil/nsSMILSetAnimationFunction.h => dom/smil/nsSMILSetAnimationFunction.h
rename : content/smil/nsSMILTargetIdentifier.h => dom/smil/nsSMILTargetIdentifier.h
rename : content/smil/nsSMILTimeContainer.cpp => dom/smil/nsSMILTimeContainer.cpp
rename : content/smil/nsSMILTimeContainer.h => dom/smil/nsSMILTimeContainer.h
rename : content/smil/nsSMILTimeValue.cpp => dom/smil/nsSMILTimeValue.cpp
rename : content/smil/nsSMILTimeValue.h => dom/smil/nsSMILTimeValue.h
rename : content/smil/nsSMILTimeValueSpec.cpp => dom/smil/nsSMILTimeValueSpec.cpp
rename : content/smil/nsSMILTimeValueSpec.h => dom/smil/nsSMILTimeValueSpec.h
rename : content/smil/nsSMILTimeValueSpecParams.h => dom/smil/nsSMILTimeValueSpecParams.h
rename : content/smil/nsSMILTimedElement.cpp => dom/smil/nsSMILTimedElement.cpp
rename : content/smil/nsSMILTimedElement.h => dom/smil/nsSMILTimedElement.h
rename : content/smil/nsSMILTypes.h => dom/smil/nsSMILTypes.h
rename : content/smil/nsSMILValue.cpp => dom/smil/nsSMILValue.cpp
rename : content/smil/nsSMILValue.h => dom/smil/nsSMILValue.h
rename : content/smil/test/db_smilAnimateMotion.js => dom/smil/test/db_smilAnimateMotion.js
rename : content/smil/test/db_smilCSSFromBy.js => dom/smil/test/db_smilCSSFromBy.js
rename : content/smil/test/db_smilCSSFromTo.js => dom/smil/test/db_smilCSSFromTo.js
rename : content/smil/test/db_smilCSSPaced.js => dom/smil/test/db_smilCSSPaced.js
rename : content/smil/test/db_smilCSSPropertyList.js => dom/smil/test/db_smilCSSPropertyList.js
rename : content/smil/test/db_smilMappedAttrList.js => dom/smil/test/db_smilMappedAttrList.js
rename : content/smil/test/mochitest.ini => dom/smil/test/mochitest.ini
rename : content/smil/test/moz.build => dom/smil/test/moz.build
rename : content/smil/test/smilAnimateMotionValueLists.js => dom/smil/test/smilAnimateMotionValueLists.js
rename : content/smil/test/smilExtDoc_helper.svg => dom/smil/test/smilExtDoc_helper.svg
rename : content/smil/test/smilTestUtils.js => dom/smil/test/smilTestUtils.js
rename : content/smil/test/smilXHR_helper.svg => dom/smil/test/smilXHR_helper.svg
rename : content/smil/test/test_smilAccessKey.xhtml => dom/smil/test/test_smilAccessKey.xhtml
rename : content/smil/test/test_smilAnimateMotion.xhtml => dom/smil/test/test_smilAnimateMotion.xhtml
rename : content/smil/test/test_smilAnimateMotionInvalidValues.xhtml => dom/smil/test/test_smilAnimateMotionInvalidValues.xhtml
rename : content/smil/test/test_smilAnimateMotionOverrideRules.xhtml => dom/smil/test/test_smilAnimateMotionOverrideRules.xhtml
rename : content/smil/test/test_smilBackwardsSeeking.xhtml => dom/smil/test/test_smilBackwardsSeeking.xhtml
rename : content/smil/test/test_smilCSSFontStretchRelative.xhtml => dom/smil/test/test_smilCSSFontStretchRelative.xhtml
rename : content/smil/test/test_smilCSSFromBy.xhtml => dom/smil/test/test_smilCSSFromBy.xhtml
rename : content/smil/test/test_smilCSSFromTo.xhtml => dom/smil/test/test_smilCSSFromTo.xhtml
rename : content/smil/test/test_smilCSSInherit.xhtml => dom/smil/test/test_smilCSSInherit.xhtml
rename : content/smil/test/test_smilCSSInvalidValues.xhtml => dom/smil/test/test_smilCSSInvalidValues.xhtml
rename : content/smil/test/test_smilCSSPaced.xhtml => dom/smil/test/test_smilCSSPaced.xhtml
rename : content/smil/test/test_smilChangeAfterFrozen.xhtml => dom/smil/test/test_smilChangeAfterFrozen.xhtml
rename : content/smil/test/test_smilContainerBinding.xhtml => dom/smil/test/test_smilContainerBinding.xhtml
rename : content/smil/test/test_smilCrossContainer.xhtml => dom/smil/test/test_smilCrossContainer.xhtml
rename : content/smil/test/test_smilDynamicDelayedBeginElement.xhtml => dom/smil/test/test_smilDynamicDelayedBeginElement.xhtml
rename : content/smil/test/test_smilExtDoc.xhtml => dom/smil/test/test_smilExtDoc.xhtml
rename : content/smil/test/test_smilFillMode.xhtml => dom/smil/test/test_smilFillMode.xhtml
rename : content/smil/test/test_smilGetSimpleDuration.xhtml => dom/smil/test/test_smilGetSimpleDuration.xhtml
rename : content/smil/test/test_smilGetStartTime.xhtml => dom/smil/test/test_smilGetStartTime.xhtml
rename : content/smil/test/test_smilHyperlinking.xhtml => dom/smil/test/test_smilHyperlinking.xhtml
rename : content/smil/test/test_smilInvalidValues.html => dom/smil/test/test_smilInvalidValues.html
rename : content/smil/test/test_smilKeySplines.xhtml => dom/smil/test/test_smilKeySplines.xhtml
rename : content/smil/test/test_smilKeyTimes.xhtml => dom/smil/test/test_smilKeyTimes.xhtml
rename : content/smil/test/test_smilKeyTimesPacedMode.xhtml => dom/smil/test/test_smilKeyTimesPacedMode.xhtml
rename : content/smil/test/test_smilMappedAttrFromBy.xhtml => dom/smil/test/test_smilMappedAttrFromBy.xhtml
rename : content/smil/test/test_smilMappedAttrFromTo.xhtml => dom/smil/test/test_smilMappedAttrFromTo.xhtml
rename : content/smil/test/test_smilMappedAttrPaced.xhtml => dom/smil/test/test_smilMappedAttrPaced.xhtml
rename : content/smil/test/test_smilMinTiming.html => dom/smil/test/test_smilMinTiming.html
rename : content/smil/test/test_smilRepeatDuration.html => dom/smil/test/test_smilRepeatDuration.html
rename : content/smil/test/test_smilRepeatTiming.xhtml => dom/smil/test/test_smilRepeatTiming.xhtml
rename : content/smil/test/test_smilReset.xhtml => dom/smil/test/test_smilReset.xhtml
rename : content/smil/test/test_smilRestart.xhtml => dom/smil/test/test_smilRestart.xhtml
rename : content/smil/test/test_smilSetCurrentTime.xhtml => dom/smil/test/test_smilSetCurrentTime.xhtml
rename : content/smil/test/test_smilSync.xhtml => dom/smil/test/test_smilSync.xhtml
rename : content/smil/test/test_smilSyncTransform.xhtml => dom/smil/test/test_smilSyncTransform.xhtml
rename : content/smil/test/test_smilSyncbaseTarget.xhtml => dom/smil/test/test_smilSyncbaseTarget.xhtml
rename : content/smil/test/test_smilTextZoom.xhtml => dom/smil/test/test_smilTextZoom.xhtml
rename : content/smil/test/test_smilTimeEvents.xhtml => dom/smil/test/test_smilTimeEvents.xhtml
rename : content/smil/test/test_smilTiming.xhtml => dom/smil/test/test_smilTiming.xhtml
rename : content/smil/test/test_smilTimingZeroIntervals.xhtml => dom/smil/test/test_smilTimingZeroIntervals.xhtml
rename : content/smil/test/test_smilUpdatedInterval.xhtml => dom/smil/test/test_smilUpdatedInterval.xhtml
rename : content/smil/test/test_smilValues.xhtml => dom/smil/test/test_smilValues.xhtml
rename : content/smil/test/test_smilXHR.xhtml => dom/smil/test/test_smilXHR.xhtml
extra : rebase_source : 4038f574b020b79d3725efd91eeef457d9d6a0b0
2014-01-03 14:49:22 +13:00

164 lines
6.5 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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 NS_SMILINSTANCETIME_H_
#define NS_SMILINSTANCETIME_H_
#include "nsSMILTimeValue.h"
#include "nsAutoPtr.h"
class nsSMILInterval;
class nsSMILTimeContainer;
class nsSMILTimeValueSpec;
//----------------------------------------------------------------------
// nsSMILInstanceTime
//
// An instant in document simple time that may be used in creating a new
// interval.
//
// For an overview of how this class is related to other SMIL time classes see
// the documentation in nsSMILTimeValue.h
//
// These objects are owned by an nsSMILTimedElement but MAY also be referenced
// by:
//
// a) nsSMILIntervals that belong to the same nsSMILTimedElement and which refer
// to the nsSMILInstanceTimes which form the interval endpoints; and/or
// b) nsSMILIntervals that belong to other nsSMILTimedElements but which need to
// update dependent instance times when they change or are deleted.
// E.g. for begin='a.begin', 'a' needs to inform dependent
// nsSMILInstanceTimes if its begin time changes. This notification is
// performed by the nsSMILInterval.
class nsSMILInstanceTime
{
public:
// Instance time source. Times generated by events, syncbase relationships,
// and DOM calls behave differently in some circumstances such as when a timed
// element is reset.
enum nsSMILInstanceTimeSource {
// No particularly significant source, e.g. offset time, 'indefinite'
SOURCE_NONE,
// Generated by a DOM call such as beginElement
SOURCE_DOM,
// Generated by a syncbase relationship
SOURCE_SYNCBASE,
// Generated by an event
SOURCE_EVENT
};
nsSMILInstanceTime(const nsSMILTimeValue& aTime,
nsSMILInstanceTimeSource aSource = SOURCE_NONE,
nsSMILTimeValueSpec* aCreator = nullptr,
nsSMILInterval* aBaseInterval = nullptr);
~nsSMILInstanceTime();
void Unlink();
void HandleChangedInterval(const nsSMILTimeContainer* aSrcContainer,
bool aBeginObjectChanged,
bool aEndObjectChanged);
void HandleDeletedInterval();
void HandleFilteredInterval();
const nsSMILTimeValue& Time() const { return mTime; }
const nsSMILTimeValueSpec* GetCreator() const { return mCreator; }
bool IsDynamic() const { return !!(mFlags & kDynamic); }
bool IsFixedTime() const { return !(mFlags & kMayUpdate); }
bool FromDOM() const { return !!(mFlags & kFromDOM); }
bool ShouldPreserve() const;
void UnmarkShouldPreserve();
void AddRefFixedEndpoint();
void ReleaseFixedEndpoint();
void DependentUpdate(const nsSMILTimeValue& aNewTime)
{
NS_ABORT_IF_FALSE(!IsFixedTime(),
"Updating an instance time that is not expected to be updated");
mTime = aNewTime;
}
bool IsDependent() const { return !!mBaseInterval; }
bool IsDependentOn(const nsSMILInstanceTime& aOther) const;
const nsSMILInterval* GetBaseInterval() const { return mBaseInterval; }
const nsSMILInstanceTime* GetBaseTime() const;
bool SameTimeAndBase(const nsSMILInstanceTime& aOther) const
{
return mTime == aOther.mTime && GetBaseTime() == aOther.GetBaseTime();
}
// Get and set a serial number which may be used by a containing class to
// control the sort order of otherwise similar instance times.
uint32_t Serial() const { return mSerial; }
void SetSerial(uint32_t aIndex) { mSerial = aIndex; }
NS_INLINE_DECL_REFCOUNTING(nsSMILInstanceTime)
protected:
void SetBaseInterval(nsSMILInterval* aBaseInterval);
nsSMILTimeValue mTime;
// Internal flags used to represent the behaviour of different instance times
enum {
// Indicates that this instance time was generated by an event or a DOM
// call. Such instance times require special handling when (i) the owning
// element is reset, (ii) when they are to be added as a new end instance
// times (as per SMIL's event sensitivity contraints), and (iii) when
// a backwards seek is performed and the timing model is reconstructed.
kDynamic = 1,
// Indicates that this instance time is referred to by an
// nsSMILTimeValueSpec and as such may be updated. Such instance time should
// not be filtered out by the nsSMILTimedElement even if they appear to be
// in the past as they may be updated to a future time.
kMayUpdate = 2,
// Indicates that this instance time was generated from the DOM as opposed
// to an nsSMILTimeValueSpec. When a 'begin' or 'end' attribute is set or
// reset we should clear all the instance times that have been generated by
// that attribute (and hence an nsSMILTimeValueSpec), but not those from the
// DOM.
kFromDOM = 4,
// Indicates that this instance time was used as the endpoint of an interval
// that has been filtered or removed. However, since it is a dynamic time it
// should be preserved and not filtered.
kWasDynamicEndpoint = 8
};
uint8_t mFlags; // Combination of kDynamic, kMayUpdate, etc.
mutable bool mVisited; // Cycle tracking
// Additional reference count to determine if this instance time is currently
// used as a fixed endpoint in any intervals. Instance times that are used in
// this way should not be removed when the owning nsSMILTimedElement removes
// instance times in response to a restart or in an attempt to free up memory
// by filtering out old instance times.
//
// Instance times are only shared in a few cases, namely:
// a) early ends,
// b) zero-duration intervals,
// c) momentarily whilst establishing new intervals and updating the current
// interval, and
// d) trimmed intervals
// Hence the limited range of a uint16_t should be more than adequate.
uint16_t mFixedEndpointRefCnt;
uint32_t mSerial; // A serial number used by the containing class to
// specify the sort order for instance times with the
// same mTime.
nsSMILTimeValueSpec* mCreator; // The nsSMILTimeValueSpec object that created
// us. (currently only needed for syncbase
// instance times.)
nsSMILInterval* mBaseInterval; // Interval from which this time is derived
// (only used for syncbase instance times)
};
#endif // NS_SMILINSTANCETIME_H_