Enable ProcessAssertions on iOS Simulator
[WebKit-https.git] / Source / WebKit / UIProcess / ProcessAssertion.h
1 /*
2  * Copyright (C) 2014-2019 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 #pragma once
27
28 #include <wtf/Function.h>
29 #include <wtf/ProcessID.h>
30 #include <wtf/WeakPtr.h>
31 #include <wtf/text/WTFString.h>
32
33 #if !OS(WINDOWS)
34 #include <unistd.h>
35 #endif
36
37 #if PLATFORM(IOS_FAMILY)
38 #include <wtf/RetainPtr.h>
39 OBJC_CLASS BKSProcessAssertion;
40 #endif
41
42 namespace WebKit {
43     
44 enum class AssertionState {
45     Suspended,
46     Background,
47     UnboundedNetworking,
48     Foreground
49 };
50
51 class ProcessAssertion : public CanMakeWeakPtr<ProcessAssertion> {
52     WTF_MAKE_FAST_ALLOCATED;
53 public:
54     class Client {
55     public:
56         virtual ~Client() { }
57         virtual void uiAssertionWillExpireImminently() = 0;
58     };
59
60     ProcessAssertion(ProcessID, const String& reason, AssertionState);
61     virtual ~ProcessAssertion();
62
63     void setClient(Client& client) { m_client = &client; }
64     Client* client() { return m_client; }
65
66     AssertionState state() const { return m_assertionState; }
67     virtual void setState(AssertionState);
68
69 #if PLATFORM(IOS_FAMILY)
70 protected:
71     enum class Validity { No, Yes, Unset };
72     Validity validity() const { return m_validity; }
73
74     virtual void processAssertionWasInvalidated();
75 #endif
76
77 private:
78 #if PLATFORM(IOS_FAMILY)
79     RetainPtr<BKSProcessAssertion> m_assertion;
80     Validity m_validity { Validity::Unset };
81 #endif
82     AssertionState m_assertionState;
83     Client* m_client { nullptr };
84 };
85
86 #if PLATFORM(IOS_FAMILY)
87
88 class ProcessAndUIAssertion final : public ProcessAssertion {
89 public:
90     ProcessAndUIAssertion(ProcessID, const String& reason, AssertionState);
91     ~ProcessAndUIAssertion();
92
93     void setState(AssertionState) final;
94     void uiAssertionWillExpireImminently();
95
96 private:
97     void processAssertionWasInvalidated() final;
98     void updateRunInBackgroundCount();
99
100     bool m_isHoldingBackgroundTask { false };
101 };
102
103 #else
104
105 using ProcessAndUIAssertion = ProcessAssertion;
106
107 #endif // PLATFORM(IOS_FAMILY)
108     
109 } // namespace WebKit