blob: 4fe7aea2018e6ed187e3dab23d28002cf750dcf8 [file] [log] [blame]
/*
* Copyright (C) 2008 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include "SMILTime.h"
#include "SVGElement.h"
#include <wtf/HashSet.h>
namespace WebCore {
class ConditionEventListener;
class SMILTimeContainer;
class SVGSMILElement;
template<typename T> class EventSender;
using SMILEventSender = EventSender<SVGSMILElement>;
// This class implements SMIL interval timing model as needed for SVG animation.
class SVGSMILElement : public SVGElement {
WTF_MAKE_ISO_ALLOCATED(SVGSMILElement);
public:
SVGSMILElement(const QualifiedName&, Document&);
virtual ~SVGSMILElement();
void parseAttribute(const QualifiedName&, const AtomString&) override;
void svgAttributeChanged(const QualifiedName&) override;
InsertedIntoAncestorResult insertedIntoAncestor(InsertionType, ContainerNode&) override;
void removedFromAncestor(RemovalType, ContainerNode&) override;
virtual bool hasValidAttributeType() const = 0;
virtual bool hasValidAttributeName() const;
virtual void animationAttributeChanged() = 0;
SMILTimeContainer* timeContainer() { return m_timeContainer.get(); }
SVGElement* targetElement() const { return m_targetElement; }
const QualifiedName& attributeName() const { return m_attributeName; }
void beginByLinkActivation();
enum Restart { RestartAlways, RestartWhenNotActive, RestartNever };
Restart restart() const;
enum FillMode { FillRemove, FillFreeze };
FillMode fill() const;
SMILTime dur() const;
SMILTime repeatDur() const;
SMILTime repeatCount() const;
SMILTime maxValue() const;
SMILTime minValue() const;
SMILTime elapsed() const;
SMILTime intervalBegin() const { return m_intervalBegin; }
SMILTime intervalEnd() const { return m_intervalEnd; }
SMILTime previousIntervalBegin() const { return m_previousIntervalBegin; }
SMILTime simpleDuration() const;
void seekToIntervalCorrespondingToTime(SMILTime elapsed);
bool progress(SMILTime elapsed, SVGSMILElement& firstAnimation, bool seekToTime);
SMILTime nextProgressTime() const;
void reset();
static SMILTime parseClockValue(StringView);
static SMILTime parseOffsetValue(StringView);
bool isContributing(SMILTime elapsed) const;
bool isInactive() const;
bool isFrozen() const;
unsigned documentOrderIndex() const { return m_documentOrderIndex; }
void setDocumentOrderIndex(unsigned index) { m_documentOrderIndex = index; }
virtual bool isAdditive() const = 0;
virtual void startAnimation() = 0;
virtual void stopAnimation(SVGElement* targetElement) = 0;
virtual void applyResultsToTarget() = 0;
void connectConditions();
bool hasConditionsConnected() const { return m_conditionsConnected; }
void dispatchPendingEvent(SMILEventSender*);
protected:
void addBeginTime(SMILTime eventTime, SMILTime endTime, SMILTimeWithOrigin::Origin = SMILTimeWithOrigin::ParserOrigin);
void addEndTime(SMILTime eventTime, SMILTime endTime, SMILTimeWithOrigin::Origin = SMILTimeWithOrigin::ParserOrigin);
void setInactive() { m_activeState = Inactive; }
bool rendererIsNeeded(const RenderStyle&) override { return false; }
// Sub-classes may need to take action when the target is changed.
virtual void setTargetElement(SVGElement*);
virtual void setAttributeName(const QualifiedName&);
void didFinishInsertingNode() override;
private:
void buildPendingResource() override;
void clearResourceReferences();
void clearTarget() override;
virtual void startedActiveInterval() = 0;
void endedActiveInterval();
virtual void updateAnimation(float percent, unsigned repeat) = 0;
static bool isSupportedAttribute(const QualifiedName&);
QualifiedName constructAttributeName() const;
void updateAttributeName();
enum BeginOrEnd { Begin, End };
SMILTime findInstanceTime(BeginOrEnd, SMILTime minimumTime, bool equalsMinimumOK) const;
void resolveFirstInterval();
void resolveNextInterval(bool notifyDependents);
void resolveInterval(bool first, SMILTime& beginResult, SMILTime& endResult) const;
SMILTime resolveActiveEnd(SMILTime resolvedBegin, SMILTime resolvedEnd) const;
SMILTime repeatingDuration() const;
void checkRestart(SMILTime elapsed);
void beginListChanged(SMILTime eventTime);
void endListChanged(SMILTime eventTime);
// This represents conditions on elements begin or end list that need to be resolved on runtime
// for example <animate begin="otherElement.begin + 8s; button.click" ... />
struct Condition {
enum Type { EventBase, Syncbase, AccessKey };
Condition(Type, BeginOrEnd, const String& baseID, const AtomString& name, SMILTime offset, int repeats = -1);
Type m_type;
BeginOrEnd m_beginOrEnd;
String m_baseID;
AtomString m_name;
SMILTime m_offset;
int m_repeats { -1 };
RefPtr<Element> m_syncbase;
RefPtr<ConditionEventListener> m_eventListener;
};
bool parseCondition(StringView, BeginOrEnd);
void parseBeginOrEnd(StringView, BeginOrEnd);
Element* eventBaseFor(const Condition&);
void disconnectConditions();
// Event base timing
void handleConditionEvent(Condition*);
// Syncbase timing
enum NewOrExistingInterval { NewInterval, ExistingInterval };
void notifyDependentsIntervalChanged(NewOrExistingInterval);
void createInstanceTimesFromSyncbase(SVGSMILElement* syncbase, NewOrExistingInterval);
void addTimeDependent(SVGSMILElement*);
void removeTimeDependent(SVGSMILElement*);
enum ActiveState { Inactive, Active, Frozen };
ActiveState determineActiveState(SMILTime elapsed) const;
float calculateAnimationPercentAndRepeat(SMILTime elapsed, unsigned& repeat) const;
SMILTime calculateNextProgressTime(SMILTime elapsed) const;
bool isSMILElement() const final { return true; }
QualifiedName m_attributeName;
SVGElement* m_targetElement;
Vector<Condition> m_conditions;
bool m_conditionsConnected;
bool m_hasEndEventConditions;
bool m_isWaitingForFirstInterval;
HashSet<SVGSMILElement*> m_timeDependents;
// Instance time lists
Vector<SMILTimeWithOrigin> m_beginTimes;
Vector<SMILTimeWithOrigin> m_endTimes;
// This is the upcoming or current interval
SMILTime m_intervalBegin;
SMILTime m_intervalEnd;
SMILTime m_previousIntervalBegin;
ActiveState m_activeState;
float m_lastPercent;
unsigned m_lastRepeat;
SMILTime m_nextProgressTime;
RefPtr<SMILTimeContainer> m_timeContainer;
unsigned m_documentOrderIndex;
mutable SMILTime m_cachedDur;
mutable SMILTime m_cachedRepeatDur;
mutable SMILTime m_cachedRepeatCount;
mutable SMILTime m_cachedMin;
mutable SMILTime m_cachedMax;
friend class ConditionEventListener;
};
} // namespace WebCore
SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::SVGSMILElement)
static bool isType(const WebCore::SVGElement& element) { return element.isSMILElement(); }
static bool isType(const WebCore::Node& node) { return is<WebCore::SVGElement>(node) && isType(downcast<WebCore::SVGElement>(node)); }
SPECIALIZE_TYPE_TRAITS_END()