Add an SPI policy action to allow clients to explicitly ask for a new process on...
[WebKit-https.git] / Source / WebKit / UIProcess / WebFrameListenerProxy.h
1 /*
2  * Copyright (C) 2010 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 "APINavigation.h"
29 #include "APIObject.h"
30 #include <WebCore/FrameLoaderTypes.h>
31 #include <wtf/Ref.h>
32 #include <wtf/RefPtr.h>
33
34 namespace WebKit {
35
36 class WebFrameProxy;
37 class WebsiteDataStore;
38 struct WebsitePoliciesData;
39
40 class WebFrameListenerProxy : public API::Object {
41 public:
42     virtual ~WebFrameListenerProxy();
43
44     void invalidate();
45     uint64_t listenerID() const { return m_listenerID; }
46
47     void setNavigation(Ref<API::Navigation>&& navigation) { m_navigation = WTFMove(navigation); }
48
49     void changeWebsiteDataStore(WebsiteDataStore&);
50
51     void setApplyPolicyInNewProcessIfPossible(bool applyPolicyInNewProcessIfPossible) { m_applyPolicyInNewProcessIfPossible = applyPolicyInNewProcessIfPossible; }
52     bool applyPolicyInNewProcessIfPossible() const { return m_applyPolicyInNewProcessIfPossible; }
53
54     bool isMainFrame() const;
55
56 protected:
57     WebFrameListenerProxy(WebFrameProxy*, uint64_t listenerID);
58
59     void receivedPolicyDecision(WebCore::PolicyAction, std::optional<WebsitePoliciesData>&&);
60
61 private:
62     RefPtr<WebFrameProxy> m_frame;
63     uint64_t m_listenerID;
64     RefPtr<API::Navigation> m_navigation;
65     bool m_applyPolicyInNewProcessIfPossible { false };
66 };
67
68 } // namespace WebKit