Use a 1-byte enum class for TextDirection
[WebKit-https.git] / Source / WebCore / dom / ScriptedAnimationController.h
1 /*
2  * Copyright (C) 2011 Google 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. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
14  *  EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
15  *  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
16  *  DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
17  *  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
18  *  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
19  *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20  *  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
22  *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23  *
24  */
25
26 #pragma once
27
28 #include "Timer.h"
29 #include <wtf/OptionSet.h>
30 #include <wtf/RefCounted.h>
31 #include <wtf/RefPtr.h>
32 #include <wtf/Vector.h>
33
34 namespace WebCore {
35
36 class Document;
37 class Page;
38 class RequestAnimationFrameCallback;
39
40 class ScriptedAnimationController : public RefCounted<ScriptedAnimationController>
41 {
42 public:
43     static Ref<ScriptedAnimationController> create(Document& document)
44     {
45         return adoptRef(*new ScriptedAnimationController(document));
46     }
47     ~ScriptedAnimationController();
48     void clearDocumentPointer() { m_document = nullptr; }
49     bool requestAnimationFrameEnabled() const;
50
51     typedef int CallbackId;
52
53     CallbackId registerCallback(Ref<RequestAnimationFrameCallback>&&);
54     void cancelCallback(CallbackId);
55     void serviceScriptedAnimations(double timestamp);
56
57     void suspend();
58     void resume();
59
60     enum class ThrottlingReason {
61         VisuallyIdle                    = 1 << 0,
62         OutsideViewport                 = 1 << 1,
63         LowPowerMode                    = 1 << 2,
64         NonInteractedCrossOriginFrame   = 1 << 3,
65     };
66     void addThrottlingReason(ThrottlingReason);
67     void removeThrottlingReason(ThrottlingReason);
68
69     WEBCORE_EXPORT bool isThrottled() const;
70     WEBCORE_EXPORT Seconds interval() const;
71
72 #if USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
73     void documentAnimationSchedulerDidFire();
74 #endif
75
76 private:
77     ScriptedAnimationController(Document&);
78
79     void scheduleAnimation();
80     void animationTimerFired();
81
82     Page* page() const;
83
84     typedef Vector<RefPtr<RequestAnimationFrameCallback>> CallbackList;
85     CallbackList m_callbacks;
86
87     Document* m_document;
88     CallbackId m_nextCallbackId { 0 };
89     int m_suspendCount { 0 };
90
91     Timer m_animationTimer;
92     double m_lastAnimationFrameTimestamp { 0 };
93
94 #if USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
95     OptionSet<ThrottlingReason> m_throttlingReasons;
96     bool m_isUsingTimer { false };
97 #endif
98 };
99
100 } // namespace WebCore