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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
|
/*
* Copyright (C) 2010-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(PDF_PLUGIN)
#include "CursorContext.h"
#include "PDFPluginIdentifier.h"
#include "WebFoundTextRange.h"
#include <WebCore/FindOptions.h>
#include <WebCore/PluginViewBase.h>
#include <WebCore/ResourceResponse.h>
#include <WebCore/SharedBuffer.h>
#include <WebCore/TextIndicator.h>
#include <WebCore/Timer.h>
#include <memory>
#include <wtf/CompletionHandler.h>
#include <wtf/RunLoop.h>
OBJC_CLASS NSDictionary;
OBJC_CLASS PDFDocument;
OBJC_CLASS PDFSelection;
namespace WebCore {
class HTMLPlugInElement;
class LocalFrame;
class PlatformMouseEvent;
class RenderEmbeddedObject;
class ShareableBitmap;
class VoidCallback;
enum class TextGranularity : uint8_t;
}
namespace WebKit {
class PDFPluginBase;
class WebFrame;
class WebPage;
enum class SelectionEndpoint : bool;
enum class SelectionWasFlipped : bool;
struct DocumentEditingContextRequest;
struct DocumentEditingContext;
struct EditorState;
struct FrameInfoData;
struct WebHitTestResultData;
class PluginView final : public WebCore::PluginViewBase {
public:
static RefPtr<PluginView> create(WebCore::HTMLPlugInElement&, const URL&, const String& contentType, bool shouldUseManualLoader);
WebCore::LocalFrame* frame() const;
bool isBeingDestroyed() const;
void manualLoadDidReceiveResponse(const WebCore::ResourceResponse&);
void manualLoadDidReceiveData(const WebCore::SharedBuffer&);
void manualLoadDidFinishLoading();
void manualLoadDidFail();
void setDeviceScaleFactor(float);
RetainPtr<PDFDocument> pdfDocumentForPrinting() const;
WebCore::FloatSize pdfDocumentSizeForPrinting() const;
id accessibilityHitTest(const WebCore::IntPoint&) const final;
id accessibilityObject() const final;
id accessibilityAssociatedPluginParentForElement(WebCore::Element*) const final;
void layerHostingStrategyDidChange() final;
WebCore::HTMLPlugInElement& pluginElement() const { return m_pluginElement; }
Ref<WebCore::HTMLPlugInElement> protectedPluginElement() const;
const URL& mainResourceURL() const { return m_mainResourceURL; }
void didBeginMagnificationGesture();
void didEndMagnificationGesture();
void setPageScaleFactor(double, std::optional<WebCore::IntPoint> origin);
double pageScaleFactor() const;
void pluginScaleFactorDidChange();
#if PLATFORM(IOS_FAMILY)
std::pair<URL, WebCore::FloatRect> linkURLAndBoundsAtPoint(WebCore::FloatPoint pointInRootView) const;
std::optional<WebCore::FloatRect> highlightRectForTapAtPoint(WebCore::FloatPoint pointInRootView) const;
void handleSyntheticClick(WebCore::PlatformMouseEvent&&);
void setSelectionRange(WebCore::FloatPoint pointInRootView, WebCore::TextGranularity);
void clearSelection();
SelectionWasFlipped moveSelectionEndpoint(WebCore::FloatPoint pointInRootView, SelectionEndpoint);
SelectionEndpoint extendInitialSelection(WebCore::FloatPoint pointInRootView, WebCore::TextGranularity);
CursorContext cursorContext(WebCore::FloatPoint pointInRootView) const;
DocumentEditingContext documentEditingContext(DocumentEditingContextRequest&&) const;
#endif
bool populateEditorStateIfNeeded(EditorState&) const;
void obscuredContentInsetsDidChange();
void webPageDestroyed();
bool handleEditingCommand(const String& commandName, const String& argument);
bool isEditingCommandEnabled(const String& commandName);
unsigned countFindMatches(const String& target, WebCore::FindOptions, unsigned maxMatchCount);
bool findString(const String& target, WebCore::FindOptions, unsigned maxMatchCount);
Vector<WebCore::FloatRect> rectsForTextMatchesInRect(const WebCore::IntRect&) const;
bool drawsFindOverlay() const;
RefPtr<WebCore::TextIndicator> textIndicatorForCurrentSelection(OptionSet<WebCore::TextIndicatorOption>, WebCore::TextIndicatorPresentationTransition);
Vector<WebFoundTextRange::PDFData> findTextMatches(const String& target, WebCore::FindOptions);
Vector<WebCore::FloatRect> rectsForTextMatch(const WebFoundTextRange::PDFData&);
RefPtr<WebCore::TextIndicator> textIndicatorForTextMatch(const WebFoundTextRange::PDFData&, WebCore::TextIndicatorPresentationTransition);
void scrollToRevealTextMatch(const WebFoundTextRange::PDFData&);
String fullDocumentString() const;
String selectionString() const;
std::pair<String, String> stringsBeforeAndAfterSelection(int characterCount) const;
RefPtr<WebCore::FragmentedSharedBuffer> liveResourceData() const;
bool performDictionaryLookupAtLocation(const WebCore::FloatPoint&);
bool performImmediateActionHitTestAtLocation(const WebCore::FloatPoint&, WebHitTestResultData&) const;
WebCore::FloatRect rectForSelectionInRootView(PDFSelection *) const;
bool isUsingUISideCompositing() const;
void invalidateRect(const WebCore::IntRect&) final;
void didChangeSettings();
void windowActivityDidChange();
void didChangeIsInWindow();
void didSameDocumentNavigationForFrame(WebFrame&);
PDFPluginIdentifier pdfPluginIdentifier() const;
void openWithPreview(CompletionHandler<void(const String&, FrameInfoData&&, std::span<const uint8_t>, const String&)>&&);
void focusPluginElement();
bool pluginHandlesPageScaleFactor() const;
WebCore::FloatRect absoluteBoundingRectForSmartMagnificationAtPoint(WebCore::FloatPoint) const;
private:
PluginView(WebCore::HTMLPlugInElement&, const URL&, const String& contentType, bool shouldUseManualLoader, WebPage&);
virtual ~PluginView();
bool isPluginView() const final { return true; }
void initializePlugin();
Ref<PDFPluginBase> protectedPlugin() const;
void viewGeometryDidChange();
void viewVisibilityDidChange();
WebCore::IntRect clipRectInWindowCoordinates() const;
void pendingResourceRequestTimerFired();
void loadMainResource();
void redeliverManualStream();
bool shouldCreateTransientPaintingSnapshot() const;
void updateDocumentForPluginSizingBehavior();
CheckedPtr<WebCore::RenderEmbeddedObject> checkedRenderer() const;
// WebCore::PluginViewBase
WebCore::PluginLayerHostingStrategy layerHostingStrategy() const final;
PlatformLayer* platformLayer() const final;
WebCore::GraphicsLayer* graphicsLayer() const final;
bool scroll(WebCore::ScrollDirection, WebCore::ScrollGranularity) final;
WebCore::ScrollPosition scrollPositionForTesting() const final;
WebCore::Scrollbar* horizontalScrollbar() final;
WebCore::Scrollbar* verticalScrollbar() final;
bool wantsWheelEvents() final;
bool shouldAllowNavigationFromDrags() const final;
void willDetachRenderer() final;
WebCore::ScrollableArea* scrollableArea() const final;
bool usesAsyncScrolling() const final;
std::optional<WebCore::ScrollingNodeID> scrollingNodeID() const final;
void willAttachScrollingNode() final;
void didAttachScrollingNode() final;
// WebCore::Widget
void setFrameRect(const WebCore::IntRect&) final;
void paint(WebCore::GraphicsContext&, const WebCore::IntRect&, WebCore::Widget::SecurityOriginPaintPolicy, WebCore::RegionContext*) final;
void frameRectsChanged() final;
void setParent(WebCore::ScrollView*) final;
void handleEvent(WebCore::Event&) final;
void notifyWidget(WebCore::WidgetNotification) final;
void show() final;
void hide() final;
void setParentVisible(bool) final;
bool transformsAffectFrameRect() final;
void clipRectChanged() final;
void releaseMemory() final;
RefPtr<WebPage> protectedWebPage() const;
Ref<WebCore::HTMLPlugInElement> m_pluginElement;
Ref<PDFPluginBase> m_plugin;
WeakPtr<WebPage> m_webPage;
URL m_mainResourceURL;
String m_mainResourceContentType;
bool m_shouldUseManualLoader { false };
bool m_isInitialized { false };
// Pending request that the plug-in has made.
std::unique_ptr<const WebCore::ResourceRequest> m_pendingResourceRequest;
RunLoop::Timer m_pendingResourceRequestTimer;
// Stream that the plug-in has requested to load.
class Stream;
RefPtr<Stream> m_stream;
// The manual stream state. We deliver a manual stream to a plug-in when it is initialized.
enum class ManualStreamState { Initial, HasReceivedResponse, Finished, Failed };
ManualStreamState m_manualStreamState { ManualStreamState::Initial };
WebCore::ResourceResponse m_manualStreamResponse;
WebCore::SharedBufferBuilder m_manualStreamData;
// This snapshot is used to avoid side effects should the plugin run JS during painting.
RefPtr<WebCore::ShareableBitmap> m_transientPaintingSnapshot;
bool sendEditingCommandToPDFForTesting(const String& commandName, const String& argument) final;
void setPDFDisplayModeForTesting(const String&) final;
Vector<WebCore::FloatRect> pdfAnnotationRectsForTesting() const override;
void unlockPDFDocumentForTesting(const String& password) final;
void setPDFTextAnnotationValueForTesting(unsigned pageIndex, unsigned annotationIndex, const String& value) final;
void registerPDFTestCallback(RefPtr<WebCore::VoidCallback>&&) final;
};
} // namespace WebKit
SPECIALIZE_TYPE_TRAITS_BEGIN(WebKit::PluginView) \
static bool isType(const WebCore::Widget& widget) { return widget.isPluginView(); } \
SPECIALIZE_TYPE_TRAITS_END()
#endif
|
