1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
/*
* Copyright (C) 2023 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include "FrameInfoData.h"
#include "WebFrame.h"
#include "WebPage.h"
#include <WebCore/Frame.h>
#include <WebCore/FrameIdentifier.h>
#include <wtf/ObjectIdentifier.h>
#ifdef __OBJC__
#import "WKFrameInfoPrivate.h"
#import "_WKFrameHandle.h"
#endif
namespace WebKit {
struct WebExtensionFrameIdentifierType;
using WebExtensionFrameIdentifier = LegacyNullableObjectIdentifier<WebExtensionFrameIdentifierType>;
namespace WebExtensionFrameConstants {
static constexpr double MainFrame { 0 };
static constexpr double None { -1 };
static constexpr const WebExtensionFrameIdentifier MainFrameIdentifier { std::numeric_limits<uint64_t>::max() - 1 };
static constexpr const WebExtensionFrameIdentifier NoneIdentifier { std::numeric_limits<uint64_t>::max() - 2 };
}
inline bool isMainFrame(WebExtensionFrameIdentifier identifier)
{
return identifier == WebExtensionFrameConstants::MainFrameIdentifier;
}
inline bool isMainFrame(std::optional<WebExtensionFrameIdentifier> identifier)
{
return identifier && isMainFrame(identifier.value());
}
inline bool isNone(WebExtensionFrameIdentifier identifier)
{
return identifier == WebExtensionFrameConstants::NoneIdentifier;
}
inline bool isNone(std::optional<WebExtensionFrameIdentifier> identifier)
{
return identifier && isNone(identifier.value());
}
inline bool isValid(std::optional<WebExtensionFrameIdentifier> identifier)
{
return identifier && !isNone(identifier.value());
}
inline WebCore::FrameIdentifier toWebCoreFrameIdentifier(const WebExtensionFrameIdentifier& identifier, const WebPage& page)
{
if (isMainFrame(identifier))
return page.mainWebFrame().frameID();
WebCore::FrameIdentifier result { LegacyNullableObjectIdentifier<WebCore::FrameIdentifierType> { identifier.toUInt64() }, WebCore::Process::identifier() };
ASSERT(result.object().isValid());
return result;
}
inline bool matchesFrame(const WebExtensionFrameIdentifier& identifier, const WebFrame& frame)
{
if (RefPtr coreFrame = frame.coreFrame(); coreFrame && coreFrame->isMainFrame() && isMainFrame(identifier))
return true;
if (RefPtr page = frame.page(); page && &page->mainWebFrame() == &frame && isMainFrame(identifier))
return true;
return frame.frameID().object().toUInt64() == identifier.toUInt64();
}
inline WebExtensionFrameIdentifier toWebExtensionFrameIdentifier(WebCore::FrameIdentifier frameIdentifier)
{
WebExtensionFrameIdentifier result { frameIdentifier.object().toUInt64() };
if (!result.isValid()) {
ASSERT_NOT_REACHED();
return WebExtensionFrameConstants::NoneIdentifier;
}
return result;
}
inline WebExtensionFrameIdentifier toWebExtensionFrameIdentifier(const WebFrame& frame)
{
if (RefPtr coreFrame = frame.coreFrame(); coreFrame && coreFrame->isMainFrame())
return WebExtensionFrameConstants::MainFrameIdentifier;
if (RefPtr page = frame.page(); page && &page->mainWebFrame() == &frame)
return WebExtensionFrameConstants::MainFrameIdentifier;
return toWebExtensionFrameIdentifier(frame.frameID());
}
inline WebExtensionFrameIdentifier toWebExtensionFrameIdentifier(const FrameInfoData& frameInfoData)
{
if (frameInfoData.isMainFrame)
return WebExtensionFrameConstants::MainFrameIdentifier;
return toWebExtensionFrameIdentifier(frameInfoData.frameID);
}
#ifdef __OBJC__
inline WebExtensionFrameIdentifier toWebExtensionFrameIdentifier(WKFrameInfo *frameInfo)
{
if (frameInfo.isMainFrame)
return WebExtensionFrameConstants::MainFrameIdentifier;
// FIXME: <rdar://117932176> Stop using FrameIdentifier/_WKFrameHandle for WebExtensionFrameIdentifier,
// which needs to be just one number and probably should only be generated in the UI process
// to prevent collisions with numbers generated in different web content processes, especially with site isolation.
ALLOW_DEPRECATED_DECLARATIONS_BEGIN
WebExtensionFrameIdentifier result { frameInfo._handle.frameID };
ALLOW_DEPRECATED_DECLARATIONS_END
if (!result.isValid()) {
ASSERT_NOT_REACHED();
return WebExtensionFrameConstants::NoneIdentifier;
}
return result;
}
#endif // __OBJC__
inline std::optional<WebExtensionFrameIdentifier> toWebExtensionFrameIdentifier(double identifier)
{
if (identifier == WebExtensionFrameConstants::MainFrame)
return WebExtensionFrameConstants::MainFrameIdentifier;
if (identifier == WebExtensionFrameConstants::None)
return WebExtensionFrameConstants::NoneIdentifier;
if (!std::isfinite(identifier) || identifier <= 0 || identifier >= static_cast<double>(WebExtensionFrameConstants::NoneIdentifier.toUInt64()))
return std::nullopt;
double integral;
if (std::modf(identifier, &integral) != 0.0) {
// Only integral numbers can be used.
return std::nullopt;
}
WebExtensionFrameIdentifier result { static_cast<uint64_t>(identifier) };
ASSERT(result.isValid());
return result;
}
inline double toWebAPI(const WebExtensionFrameIdentifier& identifier)
{
ASSERT(identifier.isValid());
if (isMainFrame(identifier))
return WebExtensionFrameConstants::MainFrame;
if (isNone(identifier))
return WebExtensionFrameConstants::None;
return static_cast<double>(identifier.toUInt64());
}
}
|
