e5e3a3b61495febbbaa133e6e1a010f902701733
[WebKit-https.git] / Source / WebKit / UIProcess / ProcessAssertion.h
1 /*
2  * Copyright (C) 2014 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 ProcessAssertion_h
27 #define ProcessAssertion_h
28
29 #include <unistd.h>
30 #include <wtf/Function.h>
31
32 #if PLATFORM(IOS) && !PLATFORM(IOS_SIMULATOR)
33 #include <wtf/RetainPtr.h>
34 #include <wtf/WeakPtr.h>
35 OBJC_CLASS BKSProcessAssertion;
36 #endif
37
38 namespace WebKit {
39     
40 enum class AssertionState {
41     Suspended,
42     Background,
43     Foreground
44 };
45
46 class ProcessAssertionClient {
47 public:
48     virtual ~ProcessAssertionClient() { };
49     virtual void assertionWillExpireImminently() = 0;
50 };
51
52 class ProcessAssertion {
53 public:
54     ProcessAssertion(pid_t, AssertionState, Function<void()>&& invalidationCallback = { });
55     virtual ~ProcessAssertion();
56
57     virtual void setClient(ProcessAssertionClient& client) { m_client = &client; }
58     ProcessAssertionClient* client() { return m_client; }
59
60     AssertionState state() const { return m_assertionState; }
61     virtual void setState(AssertionState);
62
63 #if PLATFORM(IOS) && !PLATFORM(IOS_SIMULATOR)
64 protected:
65     enum class Validity { No, Yes, Unset };
66     Validity validity() const { return m_validity; }
67 #endif
68
69 private:
70 #if PLATFORM(IOS) && !PLATFORM(IOS_SIMULATOR)
71     WeakPtr<ProcessAssertion> createWeakPtr() { return m_weakFactory.createWeakPtr(); }
72     void markAsInvalidated();
73
74     RetainPtr<BKSProcessAssertion> m_assertion;
75     Validity m_validity { Validity::Unset };
76     WeakPtrFactory<ProcessAssertion> m_weakFactory;
77     Function<void()> m_invalidationCallback;
78 #endif
79     AssertionState m_assertionState;
80     ProcessAssertionClient* m_client { nullptr };
81 };
82     
83 class ProcessAndUIAssertion final : public ProcessAssertion {
84 public:
85     ProcessAndUIAssertion(pid_t, AssertionState);
86     ~ProcessAndUIAssertion();
87
88     void setClient(ProcessAssertionClient&) final;
89
90     void setState(AssertionState) final;
91
92 #if PLATFORM(IOS) && !PLATFORM(IOS_SIMULATOR)
93 private:
94     void updateRunInBackgroundCount();
95
96     bool m_isHoldingBackgroundAssertion { false };
97 #endif
98 };
99     
100 }
101
102 #endif // ProcessAssertion_h