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
|
/*
* Copyright (C) 2024 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(UNIFIED_PDF)
#include "PDFDocumentLayout.h"
#include "PDFPageCoverage.h"
#include "UnifiedPDFPlugin.h"
#include <WebCore/GraphicsLayer.h>
#include <WebCore/PlatformLayerIdentifier.h>
#include <wtf/OptionSet.h>
#include <wtf/RefPtr.h>
#include <wtf/RetainPtr.h>
#include <wtf/TZoneMalloc.h>
#include <wtf/ThreadSafeWeakPtr.h>
OBJC_CLASS PDFDocument;
namespace WebCore {
enum class TiledBackingScrollability : uint8_t;
class GraphicsLayerClient;
};
namespace WebKit {
class AsyncPDFRenderer;
class WebKeyboardEvent;
class UnifiedPDFPlugin;
class WebWheelEvent;
enum class RepaintRequirement : uint8_t;
class PDFPresentationController : public ThreadSafeRefCountedAndCanMakeThreadSafeWeakPtr<PDFPresentationController> {
WTF_MAKE_NONCOPYABLE(PDFPresentationController);
WTF_MAKE_TZONE_ALLOCATED(PDFPresentationController);
public:
static RefPtr<PDFPresentationController> createForMode(PDFDocumentLayout::DisplayMode, UnifiedPDFPlugin&);
PDFPresentationController(UnifiedPDFPlugin&);
virtual ~PDFPresentationController();
virtual WebCore::GraphicsLayerClient& graphicsLayerClient() = 0;
// Subclasses must call the base class teardown().
virtual void teardown();
virtual bool supportsDisplayMode(PDFDocumentLayout::DisplayMode) const = 0;
virtual void willChangeDisplayMode(PDFDocumentLayout::DisplayMode newMode) = 0;
// Package up the data needed to paint a set of pages for the given clip, for use by UnifiedPDFPlugin::paintPDFContent and async rendering.
virtual PDFPageCoverage pageCoverageForContentsRect(const WebCore::FloatRect&, std::optional<PDFLayoutRow>) const = 0;
virtual PDFPageCoverageAndScales pageCoverageAndScalesForContentsRect(const WebCore::FloatRect&, std::optional<PDFLayoutRow>, float tilingScaleFactor) const = 0;
virtual WebCore::FloatRect convertFromContentsToPainting(const WebCore::FloatRect&, std::optional<PDFDocumentLayout::PageIndex> = { }) const = 0;
virtual WebCore::FloatRect convertFromPaintingToContents(const WebCore::FloatRect&, std::optional<PDFDocumentLayout::PageIndex> = { }) const = 0;
virtual void deviceOrPageScaleFactorChanged() = 0;
virtual void setupLayers(WebCore::GraphicsLayer&) = 0;
virtual void updateLayersOnLayoutChange(WebCore::FloatSize documentSize, WebCore::FloatSize centeringOffset, double scaleFactor) = 0;
virtual void updateIsInWindow(bool isInWindow) = 0;
virtual void updateDebugBorders(bool showDebugBorders, bool showRepaintCounters) = 0;
virtual void updateForCurrentScrollability(OptionSet<WebCore::TiledBackingScrollability>) = 0;
virtual void didGeneratePreviewForPage(PDFDocumentLayout::PageIndex) = 0;
void setNeedsRepaintForPageCoverage(RepaintRequirements, const PDFPageCoverage&);
virtual std::optional<PDFLayoutRow> visibleRow() const { return { }; }
virtual std::optional<PDFLayoutRow> rowForLayer(const WebCore::GraphicsLayer*) const { return { }; }
struct VisiblePDFPosition {
PDFDocumentLayout::PageIndex pageIndex { 0 };
WebCore::FloatPoint pagePoint;
};
enum class AnchorPoint : uint8_t { TopLeft, Center };
std::optional<VisiblePDFPosition> pdfPositionForCurrentView(AnchorPoint, bool preservePosition = true) const;
WebCore::FloatPoint anchorPointInDocumentSpace(AnchorPoint) const;
virtual std::optional<PDFDocumentLayout::PageIndex> pageIndexForCurrentView(AnchorPoint) const = 0;
virtual void restorePDFPosition(const VisiblePDFPosition&) = 0;
virtual void ensurePageIsVisible(PDFDocumentLayout::PageIndex) = 0;
WebCore::FloatRect layoutBoundsForPageAtIndex(PDFDocumentLayout::PageIndex) const;
PDFDocumentLayout::PageIndex nearestPageIndexForDocumentPoint(const WebCore::FloatPoint&) const;
std::optional<PDFDocumentLayout::PageIndex> pageIndexForDocumentPoint(const WebCore::FloatPoint&) const;
// Event handling.
virtual bool handleKeyboardEvent(const WebKeyboardEvent&) = 0;
virtual bool wantsWheelEvents() const { return false; }
virtual bool handleWheelEvent(const WebWheelEvent&) { return false; }
void releaseMemory();
RetainPtr<PDFDocument> pluginPDFDocument() const;
bool pluginShouldCachePagePreviews() const;
virtual std::optional<WebCore::PlatformLayerIdentifier> contentsLayerIdentifier() const { return std::nullopt; }
float scaleForPagePreviews() const;
protected:
RefPtr<WebCore::GraphicsLayer> createGraphicsLayer(const String&, WebCore::GraphicsLayer::Type);
RefPtr<WebCore::GraphicsLayer> makePageContainerLayer(PDFDocumentLayout::PageIndex);
struct LayerCoverage {
Ref<WebCore::GraphicsLayer> layer;
WebCore::FloatRect bounds;
RepaintRequirements repaintRequirements;
};
virtual Vector<LayerCoverage> layerCoveragesForRepaintPageCoverage(RepaintRequirements, const PDFPageCoverage&) = 0;
static RefPtr<WebCore::GraphicsLayer> pageBackgroundLayerForPageContainerLayer(WebCore::GraphicsLayer&);
Ref<AsyncPDFRenderer> asyncRenderer();
RefPtr<AsyncPDFRenderer> asyncRendererIfExists() const;
void clearAsyncRenderer();
bool shouldUseInProcessBackingStore() const;
Ref<UnifiedPDFPlugin> m_plugin;
RefPtr<AsyncPDFRenderer> m_asyncRenderer;
};
} // namespace WebKit
#endif // ENABLE(UNIFIED_PDF)
|
