Deprecate ActiveDOMObject::canSuspendForDocumentSuspension()
[WebKit-https.git] / Source / WebCore / dom / ActiveDOMObject.h
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
27 #pragma once
28
29 #include "ContextDestructionObserver.h"
30 #include <wtf/Assertions.h>
31 #include <wtf/Forward.h>
32 #include <wtf/RefCounted.h>
33 #include <wtf/Threading.h>
34
35 namespace WebCore {
36
37 class Document;
38
39 enum class ReasonForSuspension {
40     JavaScriptDebuggerPaused,
41     WillDeferLoading,
42     BackForwardCache,
43     PageWillBeSuspended,
44 };
45
46 class WEBCORE_EXPORT ActiveDOMObject : public ContextDestructionObserver {
47 public:
48     // The suspendIfNeeded must be called exactly once after object construction to update
49     // the suspended state to match that of the ScriptExecutionContext.
50     void suspendIfNeeded();
51     void assertSuspendIfNeededWasCalled() const;
52
53     virtual bool hasPendingActivity() const;
54
55     // However, the suspend function will sometimes be called even if canSuspendForDocumentSuspension() returns false.
56     // That happens in step-by-step JS debugging for example - in this case it would be incorrect
57     // to stop the object. Exact semantics of suspend is up to the object in cases like that.
58
59     virtual const char* activeDOMObjectName() const = 0;
60
61     // These three functions must not have a side effect of creating or destroying
62     // any ActiveDOMObject. That means they must not result in calls to arbitrary JavaScript.
63     virtual bool shouldPreventEnteringBackForwardCache_DEPRECATED() const { return false; } // Please do not add new overrides for this function.
64     virtual void suspend(ReasonForSuspension);
65     virtual void resume();
66
67     // This function must not have a side effect of creating an ActiveDOMObject.
68     // That means it must not result in calls to arbitrary JavaScript.
69     // It can, however, have a side effect of deleting an ActiveDOMObject.
70     virtual void stop();
71
72     template<typename T> void setPendingActivity(T& thisObject)
73     {
74         ASSERT(&thisObject == this);
75         thisObject.ref();
76         ++m_pendingActivityCount;
77     }
78
79     template<typename T> void unsetPendingActivity(T& thisObject)
80     {
81         ASSERT(m_pendingActivityCount > 0);
82         --m_pendingActivityCount;
83         thisObject.deref();
84     }
85
86     template<class T>
87     class PendingActivity : public RefCounted<PendingActivity<T>> {
88     public:
89         explicit PendingActivity(T& thisObject)
90             : m_thisObject(thisObject)
91         {
92             ++(m_thisObject->m_pendingActivityCount);
93         }
94
95         ~PendingActivity()
96         {
97             ASSERT(m_thisObject->m_pendingActivityCount > 0);
98             --(m_thisObject->m_pendingActivityCount);
99         }
100
101     private:
102         Ref<T> m_thisObject;
103     };
104
105     template<class T> Ref<PendingActivity<T>> makePendingActivity(T& thisObject)
106     {
107         ASSERT(&thisObject == this);
108         return adoptRef(*new PendingActivity<T>(thisObject));
109     }
110
111     bool isContextStopped() const;
112
113 protected:
114     explicit ActiveDOMObject(ScriptExecutionContext*);
115     explicit ActiveDOMObject(Document*);
116     explicit ActiveDOMObject(Document&);
117     virtual ~ActiveDOMObject();
118
119 private:
120     enum CheckedScriptExecutionContextType { CheckedScriptExecutionContext };
121     ActiveDOMObject(ScriptExecutionContext*, CheckedScriptExecutionContextType);
122
123     unsigned m_pendingActivityCount { 0 };
124 #if !ASSERT_DISABLED
125     bool m_suspendIfNeededWasCalled { false };
126     Ref<Thread> m_creationThread { Thread::current() };
127 #endif
128 };
129
130 #if ASSERT_DISABLED
131
132 inline void ActiveDOMObject::assertSuspendIfNeededWasCalled() const
133 {
134 }
135
136 #endif
137
138 } // namespace WebCore