1/*
2 * Copyright (C) 2008 Apple Inc. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 *    notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 *    notice, this list of conditions and the following disclaimer in the
11 *    documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#ifndef SMILTimeContainer_h
27#define SMILTimeContainer_h
28
29#if ENABLE(SVG)
30
31#include "QualifiedName.h"
32#include "PlatformString.h"
33#include "SMILTime.h"
34#include "Timer.h"
35#include <wtf/HashMap.h>
36#include <wtf/HashSet.h>
37#include <wtf/PassRefPtr.h>
38#include <wtf/RefCounted.h>
39#include <wtf/text/StringHash.h>
40
41namespace WebCore {
42
43class SVGElement;
44class SVGSMILElement;
45class SVGSVGElement;
46
47class SMILTimeContainer : public RefCounted<SMILTimeContainer>  {
48public:
49    static PassRefPtr<SMILTimeContainer> create(SVGSVGElement* owner) { return adoptRef(new SMILTimeContainer(owner)); }
50
51    void schedule(SVGSMILElement*);
52    void unschedule(SVGSMILElement*);
53
54    SMILTime elapsed() const;
55
56    bool isActive() const;
57    bool isPaused() const;
58
59    void begin();
60    void pause();
61    void resume();
62
63    void setDocumentOrderIndexesDirty() { m_documentOrderIndexesDirty = true; }
64
65    // Move to a specific time. Only used for DRT testing purposes.
66    void sampleAnimationAtTime(const String& elementId, double seconds);
67
68private:
69    SMILTimeContainer(SVGSVGElement* owner);
70
71    void timerFired(Timer<SMILTimeContainer>*);
72    void startTimer(SMILTime fireTime, SMILTime minimumDelay = 0);
73    void updateAnimations(SMILTime elapsed);
74
75    void updateDocumentOrderIndexes();
76    void sortByPriority(Vector<SVGSMILElement*>& smilElements, SMILTime elapsed);
77
78    typedef pair<SVGElement*, QualifiedName> ElementAttributePair;
79    String baseValueFor(ElementAttributePair);
80
81    double m_beginTime;
82    double m_pauseTime;
83    double m_accumulatedPauseTime;
84    double m_nextManualSampleTime;
85    String m_nextSamplingTarget;
86
87    bool m_documentOrderIndexesDirty;
88
89    Timer<SMILTimeContainer> m_timer;
90
91    typedef HashSet<SVGSMILElement*> TimingElementSet;
92    TimingElementSet m_scheduledAnimations;
93
94    typedef HashMap<ElementAttributePair, String> BaseValueMap;
95    BaseValueMap m_savedBaseValues;
96
97    SVGSVGElement* m_ownerSVGElement;
98};
99}
100
101#endif // ENABLE(SVG)
102#endif // SMILTimeContainer_h
103