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
|
/*
* Copyright (C) 2022 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
#if ENABLE(WK_WEB_EXTENSIONS)
#include "JSWebExtensionWrappable.h"
#include "JSWebExtensionWrapper.h"
#include "WebExtensionContentWorldType.h"
#include "WebExtensionContextProxy.h"
#include <wtf/Forward.h>
#include <wtf/Ref.h>
#include <wtf/text/MakeString.h>
namespace WebKit {
class WebExtensionAPIRuntime;
class WebExtensionAPIWebPageRuntime;
class WebExtensionAPIObject {
public:
WebExtensionAPIObject(WebExtensionContentWorldType contentWorldType)
: m_contentWorldType(contentWorldType)
{
// This should only be called when creating a namespace object for web pages.
ASSERT(contentWorldType == WebExtensionContentWorldType::WebPage);
}
WebExtensionAPIObject(WebExtensionContentWorldType contentWorldType, WebExtensionContextProxy& context)
: m_contentWorldType(contentWorldType)
, m_extensionContext(&context)
{
}
WebExtensionAPIObject(WebExtensionContentWorldType contentWorldType, WebExtensionAPIRuntimeBase& runtime, WebExtensionContextProxy& context)
: m_contentWorldType(contentWorldType)
, m_runtime(&runtime)
, m_extensionContext(&context)
{
}
WebExtensionAPIObject(const WebExtensionAPIObject& parentObject)
: m_contentWorldType(parentObject.contentWorldType())
, m_runtime(&parentObject.runtime())
, m_extensionContext(parentObject.m_extensionContext) // Using parentObject.extensionContext() is not safe for APIWebPage objects.
{
}
virtual ~WebExtensionAPIObject() = default;
bool isForMainWorld() const { return m_contentWorldType == WebExtensionContentWorldType::Main; }
WebExtensionContentWorldType contentWorldType() const { return m_contentWorldType; }
virtual WebExtensionAPIRuntimeBase& runtime() const { return *m_runtime; }
WebExtensionContextProxy& extensionContext() const { return *m_extensionContext; }
bool hasExtensionContext() const { return !!m_extensionContext; }
const String& propertyPath() const { return m_propertyPath; }
void setPropertyPath(const String& propertyName, const WebExtensionAPIObject* parentObject = nullptr)
{
ASSERT(!propertyName.isEmpty());
if (parentObject && !parentObject->propertyPath().isEmpty())
m_propertyPath = makeString(parentObject->propertyPath(), '.', propertyName);
else
m_propertyPath = propertyName;
}
private:
WebExtensionContentWorldType m_contentWorldType { WebExtensionContentWorldType::Main };
RefPtr<WebExtensionAPIRuntimeBase> m_runtime;
RefPtr<WebExtensionContextProxy> m_extensionContext;
String m_propertyPath;
};
} // namespace WebKit
#define WEB_EXTENSION_DECLARE_JS_WRAPPER_CLASS(ImplClass, ScriptClass, PropertyName) \
public: \
template<typename... Args> \
static Ref<ImplClass> create(Args&&... args) \
{ \
return adoptRef(*new ImplClass(std::forward<Args>(args)...)); \
} \
\
private: \
explicit ImplClass(WebExtensionContentWorldType contentWorldType) \
: WebExtensionAPIObject(contentWorldType) \
{ \
setPropertyPath(#PropertyName##_s); \
} \
\
explicit ImplClass(WebExtensionContentWorldType contentWorldType, WebExtensionContextProxy& context) \
: WebExtensionAPIObject(contentWorldType, context) \
{ \
setPropertyPath(#PropertyName##_s); \
} \
\
explicit ImplClass(WebExtensionContentWorldType contentWorldType, WebExtensionAPIRuntimeBase& runtime, WebExtensionContextProxy& context) \
: WebExtensionAPIObject(contentWorldType, runtime, context) \
{ \
setPropertyPath(#PropertyName##_s); \
} \
\
explicit ImplClass(const WebExtensionAPIObject& parentObject) \
: WebExtensionAPIObject(parentObject) \
{ \
setPropertyPath(#PropertyName##_s, &parentObject); \
} \
\
JSClassRef wrapperClass() final { return JS##ImplClass::ScriptClass##Class(); } \
\
using __thisIsHereToForceASemicolonAfterThisMacro UNUSED_TYPE_ALIAS = int
// End of macro.
// Needs to be at the end to allow WebExtensionAPIRuntime.h to include this header
// and avoid having all APIs need to include it.
#include "WebExtensionAPIRuntime.h"
#endif // ENABLE(WK_WEB_EXTENSIONS)
|
