[go: nahoru, domu]
Google Git
Sign in
chromium / chromium / src / refs/tags/123.0.6312.40 / . / pdf / document_layout.h
blob: 002d8d4175461b10399d5cc94472a6849bc560e2 [file] [log] [blame]
Avi Drissmandb497b32022-09-15 19:47:28[diff] [blame]1// Copyright 2019 The Chromium Authors
K Moonbd80ce72019-07-26 19:27:50[diff] [blame]2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#ifndef PDF_DOCUMENT_LAYOUT_H_
6#define PDF_DOCUMENT_LAYOUT_H_
7
K Moonff7ec672019-08-14 19:19:56[diff] [blame]8#include <cstddef>
Jeremy Chinsend6fd27ce2019-08-06 00:40:17[diff] [blame]9#include <vector>
10
Hans Wennborg29adea92020-06-22 16:13:53[diff] [blame]11#include "base/check_op.h"
K. Moone2dda8f22021-10-05 00:37:29[diff] [blame]12#include "base/i18n/rtl.h"
Lei Zhang277b156c2022-04-11 22:58:51[diff] [blame]13#include "base/values.h"
Lei Zhang4906c102019-08-06 00:28:03[diff] [blame]14#include "pdf/draw_utils/coordinates.h"
K Moon9a62bf42019-08-07 20:05:36[diff] [blame]15#include "pdf/page_orientation.h"
Ankit Kumar 🌪️00798692020-08-26 22:57:14[diff] [blame]16#include "ui/gfx/geometry/rect.h"
Ankit Kumar 🌪️e35101152020-07-30 09:57:59[diff] [blame]17#include "ui/gfx/geometry/size.h"
K Moonbd80ce72019-07-26 19:27:50[diff] [blame]18
19namespace chrome_pdf {
20
21// Layout of pages within a PDF document. Pages are placed as rectangles
22// (possibly rotated) in a non-overlapping vertical sequence.
23//
24// All layout units are pixels.
K Mooneb9e0002019-08-06 19:25:32[diff] [blame]25//
Daniel Hosseiniane257d962021-04-23 21:18:35[diff] [blame]26// The `Options` class controls the behavior of the layout, such as the default
K Mooneb9e0002019-08-06 19:25:32[diff] [blame]27// orientation of pages.
K Moonbd80ce72019-07-26 19:27:50[diff] [blame]28class DocumentLayout final {
29 public:
Daniel Hosseinianbe882062021-04-22 01:22:39[diff] [blame]30 // TODO(crbug.com/1144505): Add `kTwoUpEven` page spread support.
31 enum class PageSpread {
32 kOneUp = 0, // One page per spread.
33 kTwoUpOdd = 1, // Two pages per spread, with odd pages first.
34 };
35
K Mooneb9e0002019-08-06 19:25:32[diff] [blame]36 // Options controlling layout behavior.
37 class Options final {
38 public:
39 Options();
40
41 Options(const Options& other);
42 Options& operator=(const Options& other);
43
44 ~Options();
45
Hui Yingst28f9f5c2020-01-16 19:52:56[diff] [blame]46 friend bool operator==(const Options& lhs, const Options& rhs) {
K. Moone2dda8f22021-10-05 00:37:29[diff] [blame]47 return lhs.direction() == rhs.direction() &&
48 lhs.default_page_orientation() == rhs.default_page_orientation() &&
49 lhs.page_spread() == rhs.page_spread();
Hui Yingst28f9f5c2020-01-16 19:52:56[diff] [blame]50 }
51
52 friend bool operator!=(const Options& lhs, const Options& rhs) {
53 return !(lhs == rhs);
54 }
55
Lei Zhang277b156c2022-04-11 22:58:51[diff] [blame]56 // Serializes layout options to a base::Value::Dict.
57 base::Value::Dict ToValue() const;
K Moon23d56442019-10-03 05:06:23[diff] [blame]58
Lei Zhang277b156c2022-04-11 22:58:51[diff] [blame]59 // Deserializes layout options from a base::Value::Dict.
60 void FromValue(const base::Value::Dict& value);
K Moon23d56442019-10-03 05:06:23[diff] [blame]61
K. Moone2dda8f22021-10-05 00:37:29[diff] [blame]62 // Page layout direction. This is tied to the direction of the user's UI,
63 // rather than the direction of individual pages.
64 base::i18n::TextDirection direction() const { return direction_; }
65
66 void set_direction(base::i18n::TextDirection direction) {
67 direction_ = direction;
68 }
69
K Moon9a62bf42019-08-07 20:05:36[diff] [blame]70 PageOrientation default_page_orientation() const {
71 return default_page_orientation_;
72 }
K Mooneb9e0002019-08-06 19:25:32[diff] [blame]73
74 // Rotates default page orientation 90 degrees clockwise.
75 void RotatePagesClockwise();
76
77 // Rotates default page orientation 90 degrees counterclockwise.
78 void RotatePagesCounterclockwise();
79
Daniel Hosseinianbe882062021-04-22 01:22:39[diff] [blame]80 PageSpread page_spread() const { return page_spread_; }
Hui Yingst28f9f5c2020-01-16 19:52:56[diff] [blame]81
82 // Changes two-up view status.
Daniel Hosseinianbe882062021-04-22 01:22:39[diff] [blame]83 void set_page_spread(PageSpread spread) { page_spread_ = spread; }
Hui Yingst28f9f5c2020-01-16 19:52:56[diff] [blame]84
K Mooneb9e0002019-08-06 19:25:32[diff] [blame]85 private:
K. Moone2dda8f22021-10-05 00:37:29[diff] [blame]86 base::i18n::TextDirection direction_ = base::i18n::UNKNOWN_DIRECTION;
K Moon9a62bf42019-08-07 20:05:36[diff] [blame]87 PageOrientation default_page_orientation_ = PageOrientation::kOriginal;
Daniel Hosseinianbe882062021-04-22 01:22:39[diff] [blame]88 PageSpread page_spread_ = PageSpread::kOneUp;
K Mooneb9e0002019-08-06 19:25:32[diff] [blame]89 };
90
Lei Zhang4906c102019-08-06 00:28:03[diff] [blame]91 static const draw_utils::PageInsetSizes kSingleViewInsets;
92 static constexpr int32_t kBottomSeparator = 4;
93 static constexpr int32_t kHorizontalSeparator = 1;
94
K Moonbd80ce72019-07-26 19:27:50[diff] [blame]95 DocumentLayout();
96
K Mooneb9e0002019-08-06 19:25:32[diff] [blame]97 DocumentLayout(const DocumentLayout& other) = delete;
98 DocumentLayout& operator=(const DocumentLayout& other) = delete;
K Moonbd80ce72019-07-26 19:27:50[diff] [blame]99
100 ~DocumentLayout();
101
K Mooneb9e0002019-08-06 19:25:32[diff] [blame]102 // Returns the layout options.
103 const Options& options() const { return options_; }
K Moonbd80ce72019-07-26 19:27:50[diff] [blame]104
K Moon6d326b92019-09-19 22:42:07[diff] [blame]105 // Sets the layout options. If certain options with immediate effect change
106 // (such as the default page orientation), the layout will be marked dirty.
107 //
108 // TODO(kmoon): We shouldn't have layout options that take effect immediately.
109 void SetOptions(const Options& options);
110
111 // Returns true if the layout has been modified since the last call to
112 // clear_dirty(). The initial state is false (clean), which assumes
113 // appropriate default behavior for an initially empty layout.
114 bool dirty() const { return dirty_; }
115
116 // Clears the dirty() state of the layout. This should be called after any
117 // layout changes have been applied.
118 void clear_dirty() { dirty_ = false; }
K Moonbd80ce72019-07-26 19:27:50[diff] [blame]119
120 // Returns the layout's total size.
Ankit Kumar 🌪️e35101152020-07-30 09:57:59[diff] [blame]121 const gfx::Size& size() const { return size_; }
K Moonbd80ce72019-07-26 19:27:50[diff] [blame]122
K Moone4bd7522019-08-23 00:12:56[diff] [blame]123 size_t page_count() const { return page_layouts_.size(); }
Jeremy Chinsen08beb482019-08-07 01:58:54[diff] [blame]124
K Moonff7ec672019-08-14 19:19:56[diff] [blame]125 // Gets the layout rectangle for a page. Only valid after computing a layout.
Ankit Kumar 🌪️00798692020-08-26 22:57:14[diff] [blame]126 const gfx::Rect& page_rect(size_t page_index) const {
K Moonff7ec672019-08-14 19:19:56[diff] [blame]127 DCHECK_LT(page_index, page_count());
K Moone4bd7522019-08-23 00:12:56[diff] [blame]128 return page_layouts_[page_index].outer_rect;
129 }
130
131 // Gets the layout rectangle for a page's bounds (which excludes additional
132 // regions like page shadows). Only valid after computing a layout.
Ankit Kumar 🌪️00798692020-08-26 22:57:14[diff] [blame]133 const gfx::Rect& page_bounds_rect(size_t page_index) const {
K Moone4bd7522019-08-23 00:12:56[diff] [blame]134 DCHECK_LT(page_index, page_count());
135 return page_layouts_[page_index].inner_rect;
K Moonff7ec672019-08-14 19:19:56[diff] [blame]136 }
137
Daniel Hosseiniane257d962021-04-23 21:18:35[diff] [blame]138 // Computes the layout for a given list of `page_sizes` based on `options_`.
Daniel Hosseinianbcbedda2021-04-23 19:09:51[diff] [blame]139 void ComputeLayout(const std::vector<gfx::Size>& page_sizes);
Jeremy Chinsend6fd27ce2019-08-06 00:40:17[diff] [blame]140
K Moonbd80ce72019-07-26 19:27:50[diff] [blame]141 private:
K Moone4bd7522019-08-23 00:12:56[diff] [blame]142 // Layout of a single page.
143 struct PageLayout {
144 // Bounding rectangle for the page with decorations.
Ankit Kumar 🌪️00798692020-08-26 22:57:14[diff] [blame]145 gfx::Rect outer_rect;
K Moone4bd7522019-08-23 00:12:56[diff] [blame]146
147 // Bounding rectangle for the page without decorations.
Ankit Kumar 🌪️00798692020-08-26 22:57:14[diff] [blame]148 gfx::Rect inner_rect;
K Moone4bd7522019-08-23 00:12:56[diff] [blame]149 };
150
Daniel Hosseinianbcbedda2021-04-23 19:09:51[diff] [blame]151 // Helpers for ComputeLayout() handling different page spreads.
152 void ComputeOneUpLayout(const std::vector<gfx::Size>& page_sizes);
153 void ComputeTwoUpOddLayout(const std::vector<gfx::Size>& page_sizes);
154
Daniel Hosseiniane257d962021-04-23 21:18:35[diff] [blame]155 // Copies `source_rect` to `destination_rect`, setting `dirty_` to true if
156 // `destination_rect` is modified as a result.
Ankit Kumar 🌪️00798692020-08-26 22:57:14[diff] [blame]157 void CopyRectIfModified(const gfx::Rect& source_rect,
158 gfx::Rect& destination_rect);
K Moon6d326b92019-09-19 22:42:07[diff] [blame]159
K Mooneb9e0002019-08-06 19:25:32[diff] [blame]160 Options options_;
K Moonbd80ce72019-07-26 19:27:50[diff] [blame]161
K Moon6d326b92019-09-19 22:42:07[diff] [blame]162 // Indicates if the layout has changed in an externally-observable way,
Daniel Hosseiniane257d962021-04-23 21:18:35[diff] [blame]163 // usually as a result of calling `ComputeLayout()` with different inputs.
K Moon6d326b92019-09-19 22:42:07[diff] [blame]164 //
165 // Some operations that may trigger layout changes:
166 // * Changing page sizes
167 // * Adding or removing pages
168 // * Changing page orientations
169 bool dirty_ = false;
170
K Moonbd80ce72019-07-26 19:27:50[diff] [blame]171 // Layout's total size.
Ankit Kumar 🌪️e35101152020-07-30 09:57:59[diff] [blame]172 gfx::Size size_;
K Moonff7ec672019-08-14 19:19:56[diff] [blame]173
K Moone4bd7522019-08-23 00:12:56[diff] [blame]174 std::vector<PageLayout> page_layouts_;
K Moonbd80ce72019-07-26 19:27:50[diff] [blame]175};
176
177} // namespace chrome_pdf
178
179#endif // PDF_DOCUMENT_LAYOUT_H_