REGRESSION (r280541): [ BigSur Debug ] accessibility/roles-computedRoleString.html...
[WebKit-https.git] / Source / WebKit / UIProcess / WebNavigationState.h
1 /*
2  * Copyright (C) 2015-2021 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/HashMap.h>
29 #include <wtf/Ref.h>
30
31 namespace API {
32 class Navigation;
33 struct SubstituteData;
34 }
35
36 namespace WebCore {
37 class ResourceRequest;
38
39 enum class FrameLoadType : uint8_t;
40 }
41
42 namespace WebKit {
43
44 class WebPageProxy;
45 class WebBackForwardListItem;
46
47 class WebNavigationState {
48     WTF_MAKE_FAST_ALLOCATED;
49 public:
50     explicit WebNavigationState();
51     ~WebNavigationState();
52
53     Ref<API::Navigation> createBackForwardNavigation(WebBackForwardListItem& targetItem, WebBackForwardListItem* currentItem, WebCore::FrameLoadType);
54     Ref<API::Navigation> createLoadRequestNavigation(WebCore::ResourceRequest&&, WebBackForwardListItem* currentItem);
55     Ref<API::Navigation> createReloadNavigation(WebBackForwardListItem* currentAndTargetItem);
56     Ref<API::Navigation> createLoadDataNavigation(std::unique_ptr<API::SubstituteData>&&);
57     Ref<API::Navigation> createSimulatedLoadWithDataNavigation(WebCore::ResourceRequest&&, std::unique_ptr<API::SubstituteData>&&, WebBackForwardListItem* currentItem);
58
59     bool hasNavigation(uint64_t navigationID) const { return m_navigations.contains(navigationID); }
60     API::Navigation* navigation(uint64_t navigationID);
61     RefPtr<API::Navigation> takeNavigation(uint64_t navigationID);
62     void didDestroyNavigation(uint64_t navigationID);
63     void clearAllNavigations();
64
65     uint64_t generateNavigationID()
66     {
67         return ++m_navigationID;
68     }
69
70     using NavigationMap = HashMap<uint64_t, RefPtr<API::Navigation>>;
71
72 private:
73     NavigationMap m_navigations;
74     uint64_t m_navigationID { 0 };
75 };
76
77 } // namespace WebKit