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
|
/*
* 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 "PDFPresentationController.h"
#include <WebCore/GraphicsLayerClient.h>
#include <wtf/TZoneMalloc.h>
namespace WebCore {
class PlatformWheelEvent;
}
namespace WebKit {
class UnifiedPDFPlugin;
enum class PageTransitionState : uint8_t {
Idle,
DeterminingStretchAxis,
Stretching,
Settling,
StartingAnimationFromStationary,
StartingAnimationFromMomentum,
Animating
};
class PDFDiscretePresentationController final : public PDFPresentationController, public WebCore::GraphicsLayerClient {
WTF_MAKE_TZONE_ALLOCATED(PDFDiscretePresentationController);
WTF_MAKE_NONCOPYABLE(PDFDiscretePresentationController);
public:
PDFDiscretePresentationController(UnifiedPDFPlugin&);
private:
bool supportsDisplayMode(PDFDocumentLayout::DisplayMode) const override;
void willChangeDisplayMode(PDFDocumentLayout::DisplayMode) override;
void teardown() override;
PDFPageCoverage pageCoverageForContentsRect(const WebCore::FloatRect&, std::optional<PDFLayoutRow>) const override;
PDFPageCoverageAndScales pageCoverageAndScalesForContentsRect(const WebCore::FloatRect&, std::optional<PDFLayoutRow>, float tilingScaleFactor) const override;
WebCore::FloatRect convertFromContentsToPainting(const WebCore::FloatRect&, std::optional<PDFDocumentLayout::PageIndex>) const override;
WebCore::FloatRect convertFromPaintingToContents(const WebCore::FloatRect&, std::optional<PDFDocumentLayout::PageIndex>) const override;
void deviceOrPageScaleFactorChanged() override;
void setupLayers(WebCore::GraphicsLayer& scrolledContentsLayer) override;
void updateLayersOnLayoutChange(WebCore::FloatSize documentSize, WebCore::FloatSize centeringOffset, double scaleFactor) override;
void updateIsInWindow(bool isInWindow) override;
void updateDebugBorders(bool showDebugBorders, bool showRepaintCounters) override;
void updateForCurrentScrollability(OptionSet<TiledBackingScrollability>) override;
Vector<LayerCoverage> layerCoveragesForRepaintPageCoverage(RepaintRequirements, const PDFPageCoverage&) override;
void didGeneratePreviewForPage(PDFDocumentLayout::PageIndex) override;
WebCore::GraphicsLayerClient& graphicsLayerClient() override { return *this; }
std::optional<PDFLayoutRow> visibleRow() const override;
std::optional<PDFLayoutRow> rowForLayer(const WebCore::GraphicsLayer*) const override;
WebCore::FloatSize contentsOffsetForPage(PDFDocumentLayout::PageIndex) const;
bool handleKeyboardEvent(const WebKeyboardEvent&) override;
bool handleKeyboardCommand(const WebKeyboardEvent&);
bool handleKeyboardEventForPageNavigation(const WebKeyboardEvent&);
bool wantsWheelEvents() const override { return true; }
bool handleWheelEvent(const WebWheelEvent&) override;
bool handleBeginEvent(const WebCore::PlatformWheelEvent&);
bool handleChangedEvent(const WebCore::PlatformWheelEvent&);
bool handleEndedEvent(const WebCore::PlatformWheelEvent&);
bool handleCancelledEvent(const WebCore::PlatformWheelEvent&);
bool handleDiscreteWheelEvent(const WebCore::PlatformWheelEvent&);
bool eventCanStartPageTransition(const PlatformWheelEvent&) const;
bool canTransitionOnSide(WebCore::BoxSide) const;
// Transition state
enum class TransitionDirection : uint8_t {
PreviousHorizontal,
PreviousVertical,
NextHorizontal,
NextVertical
};
static constexpr bool isPreviousDirection(TransitionDirection direction)
{
return direction == TransitionDirection::PreviousHorizontal || direction == TransitionDirection::PreviousVertical;
}
static constexpr bool isNextDirection(TransitionDirection direction)
{
return direction == TransitionDirection::NextHorizontal || direction == TransitionDirection::NextVertical;
}
bool canTransitionInDirection(TransitionDirection) const;
void startOrStopAnimationTimerIfNecessary();
void animationTimerFired();
void animateRubberBand(MonotonicTime);
void startTransitionAnimation(PageTransitionState);
void transitionEndTimerFired();
void maybeEndGesture();
void gestureEndTimerFired();
void startPageTransitionOrSettle();
void updateState(PageTransitionState);
void updateLayerVisibilityForTransitionState(PageTransitionState previousState);
void updateLayersForTransitionState();
void applyWheelEventDelta(FloatSize);
std::optional<PDFDocumentLayout::PageIndex> pageIndexForCurrentView(AnchorPoint) const override;
void restorePDFPosition(const VisiblePDFPosition&) override;
void ensurePageIsVisible(PDFDocumentLayout::PageIndex) override;
// GraphicsLayerClient
void notifyFlushRequired(const WebCore::GraphicsLayer*) override;
float pageScaleFactor() const override;
float deviceScaleFactor() const override;
std::optional<float> customContentsScale(const WebCore::GraphicsLayer*) const override;
void tiledBackingUsageChanged(const WebCore::GraphicsLayer*, bool /*usingTiledBacking*/) override;
void paintContents(const WebCore::GraphicsLayer*, WebCore::GraphicsContext&, const WebCore::FloatRect&, OptionSet<WebCore::GraphicsLayerPaintBehavior>) override;
void paintPDFSelection(const WebCore::GraphicsLayer*, WebCore::GraphicsContext&, const WebCore::FloatRect& clipRect, std::optional<PDFLayoutRow> = { });
void paintBackgroundLayerForRow(const WebCore::GraphicsLayer*, WebCore::GraphicsContext&, const WebCore::FloatRect& clipRect, unsigned rowIndex);
void buildRows();
bool canGoToNextRow() const;
bool canGoToPreviousRow() const;
enum class Animated : bool { No, Yes };
void goToNextRow(Animated);
void goToPreviousRow(Animated);
void goToRowIndex(unsigned rowIndex, Animated);
void setVisibleRow(unsigned);
void updateLayersAfterChangeInVisibleRow(std::optional<unsigned> additionalVisibleRowIndex = { });
std::optional<unsigned> additionalVisibleRowIndexForDirection(TransitionDirection) const;
// First index is layer, second index is start/end.
static constexpr size_t topLayerIndex = 0;
static constexpr size_t bottomLayerIndex = 1;
static constexpr size_t startIndex = 0;
static constexpr size_t endIndex = 1;
std::array<std::array<float, 2>, 2> layerOpacitiesForStretchOffset(TransitionDirection, WebCore::FloatSize layerOffset, WebCore::FloatSize rowSize) const;
WebCore::FloatSize layerOffsetForStretch(TransitionDirection, WebCore::FloatSize stretchDistance, WebCore::FloatSize rowSize) const;
static float relevantAxisForDirection(TransitionDirection, WebCore::FloatSize);
static void setRelevantAxisForDirection(TransitionDirection, WebCore::FloatSize&, float value);
struct RowData {
PDFLayoutRow pages;
WebCore::FloatSize contentsOffset;
RefPtr<WebCore::GraphicsLayer> containerLayer;
RefPtr<WebCore::GraphicsLayer> leftPageContainerLayer;
RefPtr<WebCore::GraphicsLayer> rightPageContainerLayer;
RefPtr<WebCore::GraphicsLayer> contentsLayer;
RefPtr<WebCore::GraphicsLayer> selectionLayer;
bool isPageBackgroundLayer(const GraphicsLayer*) const;
RefPtr<WebCore::GraphicsLayer> leftPageBackgroundLayer() const;
RefPtr<WebCore::GraphicsLayer> rightPageBackgroundLayer() const;
RefPtr<WebCore::GraphicsLayer> backgroundLayerForPageIndex(PDFDocumentLayout::PageIndex) const;
RefPtr<WebCore::GraphicsLayer> protectedContainerLayer() const { return containerLayer; }
RefPtr<WebCore::GraphicsLayer> protectedLeftPageContainerLayer() const { return leftPageContainerLayer; }
RefPtr<WebCore::GraphicsLayer> protectedRightPageContainerLayer() const { return rightPageContainerLayer; }
RefPtr<WebCore::GraphicsLayer> protectedContentsLayer() const { return contentsLayer; }
RefPtr<WebCore::GraphicsLayer> protectedSelectionLayer() const { return selectionLayer; }
};
const RowData* rowDataForLayer(const WebCore::GraphicsLayer*) const;
WebCore::FloatPoint positionForRowContainerLayer(const PDFLayoutRow&) const;
WebCore::FloatSize rowContainerSize(const PDFLayoutRow&) const;
RefPtr<WebCore::GraphicsLayer> protectedRowsContainerLayer() const { return m_rowsContainerLayer; }
RefPtr<WebCore::GraphicsLayer> m_rowsContainerLayer;
Vector<RowData> m_rows;
HashMap<const WebCore::GraphicsLayer*, unsigned> m_layerToRowIndexMap;
std::optional<PDFDocumentLayout::DisplayMode> m_displayModeAtLastLayerSetup;
unsigned m_visibleRowIndex { 0 };
// Gesture state
WebCore::Timer m_gestureEndTimer { *this, &PDFDiscretePresentationController::gestureEndTimerFired };
WebCore::Timer m_animationTimer { *this, &PDFDiscretePresentationController::animationTimerFired };
WebCore::Timer m_transitionEndTimer { *this, &PDFDiscretePresentationController::transitionEndTimerFired };
MonotonicTime m_animationStartTime;
WebCore::FloatSize m_unappliedStretchDelta;
WebCore::FloatSize m_stretchDistance;
std::optional<WebCore::FloatSize> m_momentumVelocity;
float m_animationStartDistance { 0 };
PageTransitionState m_transitionState { PageTransitionState::Idle };
std::optional<TransitionDirection> m_transitionDirection;
};
} // namespace WebKit
#endif // ENABLE(UNIFIED_PDF)
|
