c1fa676824fdca8cadd7356a6c1cebb2e325a086
[WebKit-https.git] / Source / WebCore / page / PageThrottler.h
1 /*
2  * Copyright (C) 2013 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef PageThrottler_h
27 #define PageThrottler_h
28
29 #include "Timer.h"
30
31 #include "UserActivity.h"
32 #include <wtf/HashSet.h>
33 #include <wtf/OwnPtr.h>
34 #include <wtf/PassOwnPtr.h>
35
36 namespace WebCore {
37
38 class Page;
39 class PageActivityAssertionToken;
40
41 class PageThrottler {
42 public:
43     PageThrottler(Page&);
44     ~PageThrottler();
45
46     std::unique_ptr<PageActivityAssertionToken> createActivityToken();
47
48     bool shouldThrottleAnimations() const { return m_throttleState != PageNotThrottledState; }
49     bool shouldThrottleTimers() const { return m_throttleState != PageNotThrottledState; }
50
51     void setIsVisuallyIdle(bool);
52
53     void reportInterestingEvent();
54
55 private:
56     enum PageThrottleState {
57         PageNotThrottledState,
58         PageWaitingToThrottleState,
59         PageThrottledState
60     };
61
62     friend class PageActivityAssertionToken;
63     void addActivityToken(PageActivityAssertionToken&);
64     void removeActivityToken(PageActivityAssertionToken&);
65
66     void startThrottleHysteresisTimer();
67     void stopThrottleHysteresisTimer();
68     void throttleHysteresisTimerFired(Timer<PageThrottler>*);
69
70     void throttlePage();
71     void unthrottlePage();
72
73     Page& m_page;
74     PageThrottleState m_throttleState;
75     Timer<PageThrottler> m_throttleHysteresisTimer;
76     HashSet<PageActivityAssertionToken*> m_activityTokens;
77     UserActivity m_visuallyNonIdle;
78 };
79
80 }
81 #endif