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
|
/*
* Copyright (C) 2004, 2008, 2009, 2010 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 COMPUTER, INC. ``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 COMPUTER, INC. OR
* 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.
*/
#ifndef THIRD_PARTY_BLINK_RENDERER_CORE_EDITING_FRAME_CARET_H_
#define THIRD_PARTY_BLINK_RENDERER_CORE_EDITING_FRAME_CARET_H_
#include "base/task/single_thread_task_runner.h"
#include "third_party/blink/renderer/core/core_export.h"
#include "third_party/blink/renderer/core/editing/forward.h"
#include "third_party/blink/renderer/platform/geometry/physical_offset.h"
#include "third_party/blink/renderer/platform/graphics/paint/effect_paint_property_node.h"
#include "third_party/blink/renderer/platform/graphics/paint_invalidation_reason.h"
#include "third_party/blink/renderer/platform/heap/disallow_new_wrapper.h"
#include "third_party/blink/renderer/platform/heap/garbage_collected.h"
#include "third_party/blink/renderer/platform/heap/member.h"
#include "third_party/blink/renderer/platform/timer.h"
#include "third_party/blink/renderer/platform/wtf/bit_field.h"
namespace blink {
class CaretDisplayItemClient;
class EffectPaintPropertyNode;
class FrameCaret;
class GraphicsContext;
class LayoutBlock;
class LocalFrame;
class PhysicalBoxFragment;
class SelectionEditor;
struct PaintInvalidatorContext;
class CORE_EXPORT FrameCaret final : public GarbageCollected<FrameCaret> {
public:
FrameCaret(LocalFrame&, const SelectionEditor&);
FrameCaret(const FrameCaret&) = delete;
FrameCaret& operator=(const FrameCaret&) = delete;
~FrameCaret();
bool IsActive() const;
void ScheduleVisualUpdateForPaintInvalidationIfNeeded();
// Used to suspend caret blinking while the mouse is down.
void SetCaretBlinkingSuspended(bool suspended) {
caret_status_bits_.set<CaretBlinkingSuspendedFlag>(suspended);
}
bool IsCaretBlinkingSuspended() const {
return caret_status_bits_.get<CaretBlinkingSuspendedFlag>();
}
void StopCaretBlinkTimer();
void StartBlinkCaret();
void SetCaretEnabled(bool);
gfx::Rect AbsoluteCaretBounds() const;
// Paint invalidation methods delegating to DisplayItemClient.
void LayoutBlockWillBeDestroyed(const LayoutBlock&);
void UpdateStyleAndLayoutIfNeeded();
void InvalidatePaint(const LayoutBlock&, const PaintInvalidatorContext&);
void EnsureInvalidationOfPreviousLayoutBlock();
bool ShouldPaintCaret(const LayoutBlock&) const;
bool ShouldPaintCaret(const PhysicalBoxFragment&) const;
void PaintCaret(GraphicsContext&, const PhysicalOffset&) const;
const EffectPaintPropertyNode& CaretEffectNode() const { return *effect_; }
// For unit tests.
void RecreateCaretBlinkTimerForTesting(
scoped_refptr<base::SingleThreadTaskRunner>,
const base::TickClock* tick_clock);
void Trace(Visitor*) const;
private:
friend class FrameCaretTest;
friend class FrameSelectionTest;
friend class CaretDisplayItemClientTest;
using BitField = WTF::SingleThreadedBitField<uint8_t>;
using CaretEnabledFlag = BitField::DefineFirstValue<bool, 1>;
using ShouldShowCaretFlag = CaretEnabledFlag::DefineNextValue<bool, 1>;
using CaretBlinkingSuspendedFlag =
ShouldShowCaretFlag::DefineNextValue<bool, 1>;
using CaretBlinkingDisabledFlag =
CaretBlinkingSuspendedFlag::DefineNextValue<bool, 1>;
EffectPaintPropertyNode::State CaretEffectNodeState(
bool visible,
const TransformPaintPropertyNodeOrAlias& local_transform_space) const;
const PositionWithAffinity CaretPosition() const;
bool IsCaretEnabled() const {
return caret_status_bits_.get<CaretEnabledFlag>();
}
bool ShouldShowCaret() const;
bool IsCaretShown() const {
return caret_status_bits_.get<ShouldShowCaretFlag>();
}
void SetCaretShown(bool show_caret) {
caret_status_bits_.set<ShouldShowCaretFlag>(show_caret);
}
void CaretBlinkTimerFired(TimerBase*);
PositionWithAffinity UpdateAppearance();
void SetVisibleIfActive(bool visible);
bool IsVisibleIfActive() const { return effect_->Opacity() == 1.f; }
void SetBlinkingDisabled(bool disabled) {
caret_status_bits_.set<CaretBlinkingDisabledFlag>(disabled);
}
bool IsBlinkingDisabled() const {
return caret_status_bits_.get<CaretBlinkingDisabledFlag>();
}
const Member<const SelectionEditor> selection_editor_;
const Member<LocalFrame> frame_;
const Member<CaretDisplayItemClient> display_item_client_;
// TODO(https://crbug.com/1123630): Consider moving the timer into the
// compositor thread.
HeapTaskRunnerTimer<FrameCaret> caret_blink_timer_;
BitField caret_status_bits_;
// Controls visibility of caret with opacity when the caret is blinking.
const Member<EffectPaintPropertyNode> effect_;
};
} // namespace blink
#endif // THIRD_PARTY_BLINK_RENDERER_CORE_EDITING_FRAME_CARET_H_
|
