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
|
/*
* 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
#if ENABLE(UNIFIED_PDF)
#include <WebCore/FloatRect.h>
#include <WebCore/IntDegrees.h>
#include <wtf/RetainPtr.h>
OBJC_CLASS PDFDocument;
OBJC_CLASS PDFPage;
namespace WebCore {
class GraphicsContext;
class IntRect;
}
namespace WebKit {
enum class ShouldUpdateAutoSizeScale : bool { No, Yes };
struct PDFLayoutRow;
class PDFDocumentLayout {
public:
using PageIndex = size_t; // This is a zero-based index.
enum class DisplayMode : uint8_t {
SinglePageDiscrete,
SinglePageContinuous,
TwoUpDiscrete,
TwoUpContinuous,
};
PDFDocumentLayout();
~PDFDocumentLayout();
void setPDFDocument(PDFDocument *document) { m_pdfDocument = document; }
bool hasPDFDocument() const { return !!m_pdfDocument; }
bool hasLaidOutPDFDocument() const { return !m_pageGeometry.isEmpty(); }
size_t pageCount() const;
size_t rowCount() const;
PDFLayoutRow rowForPageIndex(PageIndex) const;
Vector<PDFLayoutRow> rows() const;
unsigned rowIndexForPageIndex(PageIndex) const;
static constexpr WebCore::FloatSize documentMargin { 16, 18 };
static constexpr WebCore::FloatSize pageMargin { 14, 16 };
bool isLeftPageIndex(PageIndex) const;
bool isRightPageIndex(PageIndex) const;
bool isLastPageIndex(PageIndex) const;
PageIndex lastPageIndex() const;
bool isFirstPageOfRow(PageIndex) const;
RetainPtr<PDFPage> pageAtIndex(PageIndex) const;
std::optional<PageIndex> indexForPage(RetainPtr<PDFPage>) const;
PageIndex nearestPageIndexForDocumentPoint(WebCore::FloatPoint, const std::optional<PDFLayoutRow>&) const;
// For the given Y offset, return a page index and page point for the page at this offset. Returns the leftmost
// page if two-up and both pages intersect that offset, otherwise the right page if only it intersects the offset.
// The point is centered horizontally in the given page.
// FIXME: <https://webkit.org/b/276981> Remove or provide row.
std::pair<PageIndex, WebCore::FloatPoint> pageIndexAndPagePointForDocumentYOffset(float) const;
// This is not scaled by scale().
WebCore::FloatRect layoutBoundsForPageAtIndex(PageIndex) const;
// Bounds of the pages in the row, including document margins. Not scaled.
WebCore::FloatRect layoutBoundsForRow(PDFLayoutRow) const;
// Returns 0, 90, 180, 270.
WebCore::IntDegrees rotationForPageAtIndex(PageIndex) const;
WebCore::FloatPoint documentToPDFPage(WebCore::FloatPoint documentPoint, PageIndex) const;
WebCore::FloatRect documentToPDFPage(WebCore::FloatRect documentRect, PageIndex) const;
WebCore::FloatPoint pdfPageToDocument(WebCore::FloatPoint pagePoint, PageIndex) const;
WebCore::FloatRect pdfPageToDocument(WebCore::FloatRect pageRect, PageIndex) const;
// This is the scale that scales the largest page or pair of pages up or down to fit the available width.
float scale() const { return m_scale; }
enum class LayoutUpdateChange : uint8_t {
PageGeometries = 1 << 0,
DocumentBounds = 1 << 1,
};
OptionSet<LayoutUpdateChange> updateLayout(WebCore::IntSize pluginSize, ShouldUpdateAutoSizeScale);
WebCore::FloatSize contentsSize() const;
WebCore::FloatSize scaledContentsSize() const;
void setDisplayMode(DisplayMode displayMode) { m_displayMode = displayMode; }
DisplayMode displayMode() const { return m_displayMode; }
constexpr static bool isSinglePageDisplayMode(DisplayMode mode) { return mode == DisplayMode::SinglePageDiscrete || mode == DisplayMode::SinglePageContinuous; }
constexpr static bool isTwoUpDisplayMode(DisplayMode mode) { return mode == DisplayMode::TwoUpDiscrete || mode == DisplayMode::TwoUpContinuous; }
constexpr static bool isScrollingDisplayMode(DisplayMode mode) { return mode == DisplayMode::SinglePageContinuous || mode == DisplayMode::TwoUpContinuous; }
constexpr static bool isDiscreteDisplayMode(DisplayMode mode) { return mode == DisplayMode::SinglePageDiscrete || mode == DisplayMode::TwoUpDiscrete; }
bool isSinglePageDisplayMode() const { return isSinglePageDisplayMode(m_displayMode); }
bool isTwoUpDisplayMode() const { return isTwoUpDisplayMode(m_displayMode); }
bool isScrollingDisplayMode() const { return isScrollingDisplayMode(m_displayMode); }
bool isDiscreteDisplayMode() const { return isDiscreteDisplayMode(m_displayMode); }
unsigned pagesPerRow() const { return isSinglePageDisplayMode() ? 1 : 2; }
struct PageGeometry {
WebCore::FloatRect cropBox;
WebCore::FloatRect layoutBounds;
WebCore::IntDegrees rotation { 0 };
friend bool operator==(const PageGeometry&, const PageGeometry&) = default;
};
std::optional<PageGeometry> geometryForPage(RetainPtr<PDFPage>) const;
WebCore::AffineTransform toPageTransform(const PageGeometry&) const;
private:
void layoutPages(WebCore::FloatSize availableSize, WebCore::FloatSize maxRowSize, ShouldUpdateAutoSizeScale);
// maxRowSize does not include document margins.
enum class CenterRowVertically : bool { No, Yes };
void layoutContinuousRows(WebCore::FloatSize availableSize, WebCore::FloatSize maxRowSize, CenterRowVertically);
void layoutDiscreteRows(WebCore::FloatSize availableSize, WebCore::FloatSize maxRowSize, CenterRowVertically);
// Returns row rect including page margins.
WebCore::FloatRect layoutRow(const PDFLayoutRow&, WebCore::FloatSize maxRowSize, float rowTop, CenterRowVertically centerVertically);
RetainPtr<PDFDocument> m_pdfDocument;
Vector<PageGeometry> m_pageGeometry;
WebCore::FloatRect m_documentBounds;
float m_scale { 1 };
DisplayMode m_displayMode { DisplayMode::SinglePageContinuous };
};
struct PDFLayoutRow {
Vector<PDFDocumentLayout::PageIndex, 2> pages;
unsigned numPages() const { return pages.size(); }
bool containsPage(PDFDocumentLayout::PageIndex pageIndex) const { return pages.contains(pageIndex); }
};
} // namespace WebKit
#endif // ENABLE(UNIFIED_PDF)
|
