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
|
/*
* Copyright (C) 2010-2020 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
#include "FloatRect.h"
#include "Image.h"
#include <wtf/OptionSet.h>
#include <wtf/RefCounted.h>
#include <wtf/Seconds.h>
#include <wtf/Vector.h>
namespace WebCore {
class GraphicsContext;
class LocalFrame;
struct SimpleRange;
constexpr float dropShadowBlurRadius = 2;
constexpr float rimShadowBlurRadius = 1;
constexpr Seconds bounceAnimationDuration = 0.12_s;
constexpr Seconds timeBeforeFadeStarts = bounceAnimationDuration + 0.2_s;
constexpr float midBounceScale = 1.25;
enum class TextIndicatorLifetime : uint8_t {
// The TextIndicator should indicate the text until dismissed.
Permanent,
// The TextIndicator should briefly indicate the text and then automatically dismiss.
Temporary
};
enum class TextIndicatorDismissalAnimation : uint8_t {
None,
FadeOut
};
// FIXME: Move PresentationTransition to TextIndicatorWindow, because it's about presentation.
enum class TextIndicatorPresentationTransition : uint8_t {
None,
// These animations drive themselves.
Bounce,
BounceAndCrossfade,
// This animation needs to be driven manually via TextIndicatorWindow::setAnimationProgress.
FadeIn,
};
// Make sure to keep these in sync with the ones in Internals.idl.
enum class TextIndicatorOption : uint16_t {
// Use the styled text color instead of forcing black text (the default)
RespectTextColor = 1 << 0,
// Paint backgrounds, even if they're not part of the Range
PaintBackgrounds = 1 << 1,
// Don't restrict painting to the given Range
PaintAllContent = 1 << 2,
// Take two snapshots:
// - one including the selection highlight and ignoring other painting-related options
// - one respecting the other painting-related options
IncludeSnapshotWithSelectionHighlight = 1 << 3,
// Tightly fit the content instead of expanding to cover the bounds of the selection highlight
TightlyFitContent = 1 << 4,
// If there are any non-inline or replaced elements in the Range, indicate the bounding rect
// of the range instead of the individual subrects, and don't restrict painting to the given Range
UseBoundingRectAndPaintAllContentForComplexRanges = 1 << 5,
// By default, TextIndicator removes any margin if the given Range matches the
// selection Range. If this option is set, maintain the margin in any case.
IncludeMarginIfRangeMatchesSelection = 1 << 6,
// By default, TextIndicator clips the indicated rects to the visible content rect.
// If this option is set, expand the clip rect outward so that slightly offscreen content will be included.
ExpandClipBeyondVisibleRect = 1 << 7,
// By default, TextIndicator clips the indicated rects to the visible content rect.
// If this option is set, do not clip to the visible rect.
DoNotClipToVisibleRect = 1 << 8,
// Include an additional snapshot of everything in view, with the exception of nodes within the currently selected range.
IncludeSnapshotOfAllVisibleContentWithoutSelection = 1 << 9,
// By default, TextIndicator uses text rects to size the snapshot. Enabling this flag causes it to use the bounds of the
// selection rects that would enclose the given Range instead.
// Currently, this is only supported on iOS.
UseSelectionRectForSizing = 1 << 10,
// Compute a background color to use when rendering a platter around the content image, falling back to a default if the
// content's background is too complex to be captured by a single color.
ComputeEstimatedBackgroundColor = 1 << 11,
// By default, TextIndicator does not consider the user-select property.
// If this option is set, expand the range to include the highest `user-select: all` ancestor.
UseUserSelectAllCommonAncestor = 1 << 12,
// If this option is set, exclude all content that is replaced by a separate render pass, like images, media, etc.
SkipReplacedContent = 1 << 13,
// If this option is set, perform the snapshot with 3x as the base scale, rather than the device scale factor
SnapshotContentAt3xBaseScale = 1 << 14,
};
struct TextIndicatorData {
FloatRect selectionRectInRootViewCoordinates;
FloatRect textBoundingRectInRootViewCoordinates;
FloatRect contentImageWithoutSelectionRectInRootViewCoordinates;
Vector<FloatRect> textRectsInBoundingRectCoordinates;
float contentImageScaleFactor { 1 };
RefPtr<Image> contentImageWithHighlight;
RefPtr<Image> contentImageWithoutSelection;
RefPtr<Image> contentImage;
Color estimatedBackgroundColor;
TextIndicatorPresentationTransition presentationTransition { TextIndicatorPresentationTransition::None };
OptionSet<TextIndicatorOption> options;
};
class TextIndicator : public RefCounted<TextIndicator> {
public:
// FIXME: These are fairly Mac-specific, and they don't really belong here.
// But they're needed at TextIndicator creation time, so they can't go in TextIndicatorWindow.
// Maybe they can live in some Theme code somewhere?
constexpr static float defaultHorizontalMargin { 2 };
constexpr static float defaultVerticalMargin { 1 };
WEBCORE_EXPORT static Ref<TextIndicator> create(const TextIndicatorData&);
WEBCORE_EXPORT static RefPtr<TextIndicator> createWithSelectionInFrame(LocalFrame&, OptionSet<TextIndicatorOption>, TextIndicatorPresentationTransition, FloatSize margin = FloatSize(defaultHorizontalMargin, defaultVerticalMargin));
WEBCORE_EXPORT static RefPtr<TextIndicator> createWithRange(const SimpleRange&, OptionSet<TextIndicatorOption>, TextIndicatorPresentationTransition, FloatSize margin = FloatSize(defaultHorizontalMargin, defaultVerticalMargin));
WEBCORE_EXPORT ~TextIndicator();
FloatRect selectionRectInRootViewCoordinates() const { return m_data.selectionRectInRootViewCoordinates; }
FloatRect textBoundingRectInRootViewCoordinates() const { return m_data.textBoundingRectInRootViewCoordinates; }
const Vector<FloatRect>& textRectsInBoundingRectCoordinates() const { return m_data.textRectsInBoundingRectCoordinates; }
float contentImageScaleFactor() const { return m_data.contentImageScaleFactor; }
Image* contentImageWithHighlight() const { return m_data.contentImageWithHighlight.get(); }
Image* contentImage() const { return m_data.contentImage.get(); }
RefPtr<Image> protectedContentImage() const { return contentImage(); }
TextIndicatorPresentationTransition presentationTransition() const { return m_data.presentationTransition; }
void setPresentationTransition(TextIndicatorPresentationTransition transition) { m_data.presentationTransition = transition; }
TextIndicatorData data() const { return m_data; }
private:
TextIndicator(const TextIndicatorData&);
TextIndicatorData m_data;
};
} // namespace WebKit
|
