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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
content / browser / renderer_host / render_widget_host_view_aura.h [blame]
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CONTENT_BROWSER_RENDERER_HOST_RENDER_WIDGET_HOST_VIEW_AURA_H_
#define CONTENT_BROWSER_RENDERER_HOST_RENDER_WIDGET_HOST_VIEW_AURA_H_
#include <stddef.h>
#include <stdint.h>
#include <map>
#include <memory>
#include <set>
#include <string>
#include <string_view>
#include <vector>
#include "base/functional/callback.h"
#include "base/gtest_prod_util.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/scoped_observation.h"
#include "base/time/time.h"
#include "build/build_config.h"
#include "build/chromeos_buildflags.h"
#include "cc/layers/deadline_policy.h"
#include "components/viz/common/frame_sinks/begin_frame_args.h"
#include "components/viz/common/frame_sinks/begin_frame_source.h"
#include "content/browser/compositor/image_transport_factory.h"
#include "content/browser/device_posture/device_posture_platform_provider.h"
#include "content/browser/renderer_host/render_widget_host_view_base.h"
#include "content/browser/renderer_host/render_widget_host_view_event_handler.h"
#include "content/browser/renderer_host/text_input_manager.h"
#include "content/common/content_export.h"
#include "content/common/cursors/webcursor.h"
#include "content/public/browser/context_menu_params.h"
#include "content/public/browser/visibility.h"
#include "third_party/blink/public/mojom/input/input_handler.mojom-forward.h"
#include "third_party/blink/public/mojom/widget/record_content_to_visible_time_request.mojom-forward.h"
#include "third_party/skia/include/core/SkRegion.h"
#include "ui/accessibility/platform/browser_accessibility_manager.h"
#include "ui/aura/client/cursor_client_observer.h"
#include "ui/aura/client/focus_change_observer.h"
#include "ui/aura/client/window_types.h"
#include "ui/aura/window_delegate.h"
#include "ui/aura/window_tree_host_observer.h"
#include "ui/base/ime/text_input_client.h"
#include "ui/display/display_observer.h"
#include "ui/gfx/geometry/insets.h"
#include "ui/gfx/geometry/rect.h"
#include "ui/gfx/selection_bound.h"
#include "ui/wm/public/activation_delegate.h"
#if BUILDFLAG(IS_WIN)
#include "content/browser/renderer_host/virtual_keyboard_controller_win.h"
#endif
namespace aura_extra {
class WindowPositionInRootMonitor;
}
namespace display {
class Display;
} // namespace display
namespace gfx {
class Point;
class Rect;
}
namespace input {
class CursorManager;
} // namespace input
namespace ui {
enum class DomCode : uint32_t;
class InputMethod;
class LocatedEvent;
}
namespace wm {
class ScopedTooltipDisabler;
}
namespace content {
#if BUILDFLAG(IS_WIN)
class LegacyRenderWidgetHostHWND;
class DirectManipulationBrowserTestBase;
#endif
class DelegatedFrameHost;
class DelegatedFrameHostClient;
class MouseWheelPhaseHandler;
class RenderFrameHostImpl;
class RenderWidgetHostView;
class TouchSelectionControllerClientAura;
// RenderWidgetHostView class hierarchy described in render_widget_host_view.h.
class CONTENT_EXPORT RenderWidgetHostViewAura
: public RenderWidgetHostViewBase,
public RenderWidgetHostViewEventHandler::Delegate,
public RenderFrameMetadataProvider::Observer,
public TextInputManager::Observer,
public ui::TextInputClient,
public display::DisplayObserver,
public aura::WindowTreeHostObserver,
public aura::WindowDelegate,
public wm::ActivationDelegate,
public aura::client::FocusChangeObserver,
public aura::client::CursorClientObserver,
public DevicePosturePlatformProvider::Observer {
public:
explicit RenderWidgetHostViewAura(RenderWidgetHost* host);
RenderWidgetHostViewAura(const RenderWidgetHostViewAura&) = delete;
RenderWidgetHostViewAura& operator=(const RenderWidgetHostViewAura&) = delete;
// RenderWidgetHostView implementation.
void InitAsChild(gfx::NativeView parent_view) override;
void SetSize(const gfx::Size& size) override;
void SetBounds(const gfx::Rect& rect) override;
gfx::NativeView GetNativeView() override;
gfx::NativeViewAccessible GetNativeViewAccessible() override;
ui::TextInputClient* GetTextInputClient() override;
bool HasFocus() override;
void Hide() override;
bool IsShowing() override;
void WasUnOccluded() override;
void WasOccluded() override;
gfx::Rect GetViewBounds() override;
bool IsPointerLocked() override;
gfx::Size GetVisibleViewportSize() override;
void SetInsets(const gfx::Insets& insets) override;
TouchSelectionControllerClientManager*
GetTouchSelectionControllerClientManager() override;
ui::mojom::VirtualKeyboardMode GetVirtualKeyboardMode() override;
void NotifyVirtualKeyboardOverlayRect(
const gfx::Rect& keyboard_rect) override;
bool IsHTMLFormPopup() const override;
void ResetGestureDetection() override;
// Overridden from RenderWidgetHostViewBase:
void InitAsPopup(RenderWidgetHostView* parent_host_view,
const gfx::Rect& pos,
const gfx::Rect& anchor_rect) override;
void Focus() override;
void UpdateCursor(const ui::Cursor& cursor) override;
void DisplayCursor(const ui::Cursor& cursor) override;
input::CursorManager* GetCursorManager() override;
void SetIsLoading(bool is_loading) override;
void RenderProcessGone() override;
void ShowWithVisibility(PageVisibilityState page_visibility) final;
void Destroy() override;
void UpdateTooltipUnderCursor(const std::u16string& tooltip_text) override;
void UpdateTooltip(const std::u16string& tooltip_text) override;
void UpdateTooltipFromKeyboard(const std::u16string& tooltip_text,
const gfx::Rect& bounds) override;
void ClearKeyboardTriggeredTooltip() override;
uint32_t GetCaptureSequenceNumber() const override;
bool IsSurfaceAvailableForCopy() override;
void CopyFromSurface(
const gfx::Rect& src_rect,
const gfx::Size& output_size,
base::OnceCallback<void(const SkBitmap&)> callback) override;
void EnsureSurfaceSynchronizedForWebTest() override;
void TransformPointToRootSurface(gfx::PointF* point) override;
gfx::Rect GetBoundsInRootWindow() override;
void WheelEventAck(const blink::WebMouseWheelEvent& event,
blink::mojom::InputEventResultState ack_result) override;
void GestureEventAck(const blink::WebGestureEvent& event,
blink::mojom::InputEventResultSource ack_source,
blink::mojom::InputEventResultState ack_result) override;
void DidOverscroll(const ui::DidOverscrollParams& params) override;
void ProcessAckedTouchEvent(
const input::TouchEventWithLatencyInfo& touch,
blink::mojom::InputEventResultState ack_result) override;
std::unique_ptr<SyntheticGestureTarget> CreateSyntheticGestureTarget()
override;
blink::mojom::InputEventResultState FilterInputEvent(
const blink::WebInputEvent& input_event) override;
gfx::AcceleratedWidget AccessibilityGetAcceleratedWidget() override;
gfx::NativeViewAccessible AccessibilityGetNativeViewAccessible() override;
void SetMainFrameAXTreeID(ui::AXTreeID id) override;
blink::mojom::PointerLockResult LockPointer(
bool request_unadjusted_movement) override;
blink::mojom::PointerLockResult ChangePointerLock(
bool request_unadjusted_movement) override;
void UnlockPointer() override;
bool GetIsPointerLockedUnadjustedMovementForTesting() override;
bool LockKeyboard(std::optional<base::flat_set<ui::DomCode>> codes) override;
void UnlockKeyboard() override;
bool IsKeyboardLocked() override;
base::flat_map<std::string, std::string> GetKeyboardLayoutMap() override;
void InvalidateLocalSurfaceIdAndAllocationGroup() override;
void ClearFallbackSurfaceForCommitPending() override;
void ResetFallbackToFirstNavigationSurface() override;
bool RequestRepaintForTesting() override;
void DidStopFlinging() override;
void OnOldViewDidNavigatePreCommit() override;
void OnNewViewDidNavigatePostCommit() override;
void DidEnterBackForwardCache() override;
const viz::FrameSinkId& GetFrameSinkId() const override;
const viz::LocalSurfaceId& GetLocalSurfaceId() const override;
bool TransformPointToCoordSpaceForView(
const gfx::PointF& point,
RenderWidgetHostViewInput* target_view,
gfx::PointF* transformed_point) override;
viz::FrameSinkId GetRootFrameSinkId() override;
viz::SurfaceId GetCurrentSurfaceId() const override;
void FocusedNodeChanged(bool is_editable_node,
const gfx::Rect& node_bounds_in_screen) override;
#if BUILDFLAG(IS_WIN)
bool ShouldInitiateStylusWriting() override;
void OnStartStylusWriting() override;
void OnEditElementFocusedForStylusWriting(
blink::mojom::StylusWritingFocusResultPtr focus_result) override;
#endif // BUILDFLAG(IS_WIN)
void OnSynchronizedDisplayPropertiesChanged(bool rotation = false) override;
viz::ScopedSurfaceIdAllocator DidUpdateVisualProperties(
const cc::RenderFrameMetadata& metadata) override;
void DidNavigate() override;
void TakeFallbackContentFrom(RenderWidgetHostView* view) override;
bool CanSynchronizeVisualProperties() override;
// TODO(lanwei): Use TestApi interface to write functions that are used in
// tests and remove FRIEND_TEST_ALL_PREFIXES.
void SetLastPointerType(ui::EventPointerType last_pointer_type) override;
viz::SurfaceId GetFallbackSurfaceIdForTesting() const override;
// Overridden from ui::TextInputClient:
base::WeakPtr<ui::TextInputClient> AsWeakPtr() override;
void SetCompositionText(const ui::CompositionText& composition) override;
size_t ConfirmCompositionText(bool keep_selection) override;
void ClearCompositionText() override;
void InsertText(const std::u16string& text,
InsertTextCursorBehavior cursor_behavior) override;
void InsertChar(const ui::KeyEvent& event) override;
bool CanInsertImage() override;
void InsertImage(const GURL& src) override;
ui::TextInputType GetTextInputType() const override;
ui::TextInputMode GetTextInputMode() const override;
base::i18n::TextDirection GetTextDirection() const override;
int GetTextInputFlags() const override;
bool CanComposeInline() const override;
gfx::Rect GetCaretBounds() const override;
gfx::Rect GetSelectionBoundingBox() const override;
#if BUILDFLAG(IS_WIN)
std::optional<gfx::Rect> GetProximateCharacterBounds(
const gfx::Range& range) const override;
std::optional<size_t> GetProximateCharacterIndexFromPoint(
const gfx::Point& point,
ui::IndexFromPointFlags flags) const override;
#endif // BUILDFLAG(IS_WIN)
bool GetCompositionCharacterBounds(size_t index,
gfx::Rect* rect) const override;
bool HasCompositionText() const override;
ui::TextInputClient::FocusReason GetFocusReason() const override;
bool GetTextRange(gfx::Range* range) const override;
bool GetCompositionTextRange(gfx::Range* range) const override;
bool GetEditableSelectionRange(gfx::Range* range) const override;
bool SetEditableSelectionRange(const gfx::Range& range) override;
bool GetTextFromRange(const gfx::Range& range,
std::u16string* text) const override;
void OnInputMethodChanged() override;
bool ChangeTextDirectionAndLayoutAlignment(
base::i18n::TextDirection direction) override;
void ExtendSelectionAndDelete(size_t before, size_t after) override;
#if BUILDFLAG(IS_CHROMEOS)
void ExtendSelectionAndReplace(size_t before,
size_t after,
std::u16string_view replacement_text) override;
#endif
void EnsureCaretNotInRect(const gfx::Rect& rect) override;
bool IsTextEditCommandEnabled(ui::TextEditCommand command) const override;
void SetTextEditCommandForNextKeyEvent(ui::TextEditCommand command) override;
ukm::SourceId GetClientSourceForMetrics() const override;
bool ShouldDoLearning() override;
#if BUILDFLAG(IS_WIN) || BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS)
bool SetCompositionFromExistingText(
const gfx::Range& range,
const std::vector<ui::ImeTextSpan>& ui_ime_text_spans) override;
#endif
#if BUILDFLAG(IS_CHROMEOS)
gfx::Range GetAutocorrectRange() const override;
gfx::Rect GetAutocorrectCharacterBounds() const override;
bool SetAutocorrectRange(const gfx::Range& range) override;
std::optional<ui::GrammarFragment> GetGrammarFragmentAtCursor()
const override;
bool ClearGrammarFragments(const gfx::Range& range) override;
bool AddGrammarFragments(
const std::vector<ui::GrammarFragment>& fragments) override;
#endif
#if BUILDFLAG(IS_WIN) || BUILDFLAG(IS_CHROMEOS)
// Returns the control and selection bounds of the EditContext or control
// bounds of the active editable element. This is used to report the layout
// bounds of the text input control to TSF on Windows.
void GetActiveTextInputControlLayoutBounds(
std::optional<gfx::Rect>* control_bounds,
std::optional<gfx::Rect>* selection_bounds) override;
#endif
#if BUILDFLAG(IS_WIN)
// API to notify accessibility whether there is an active composition
// from TSF or not.
// It notifies the composition range, composition text and whether the
// composition has been committed or not.
void SetActiveCompositionForAccessibility(
const gfx::Range& range,
const std::u16string& active_composition_text,
bool is_composition_committed) override;
#endif
#if BUILDFLAG(IS_WIN) || BUILDFLAG(IS_CHROMEOS_ASH)
// Returns the editing context of the active web content.
// This is currently used by TSF and ChromeOS to fetch the URL of the active
// web content.
// https://docs.microsoft.com/en-us/windows/win32/tsf/predefined-properties
ui::TextInputClient::EditingContext GetTextEditingContext() override;
#endif
#if BUILDFLAG(IS_WIN)
// Notify TSF (via text store) when URL of the frame in focus changes.
void NotifyOnFrameFocusChanged() override;
#endif
// Overridden from display::DisplayObserver:
void OnDisplayMetricsChanged(const display::Display& display,
uint32_t metrics) override;
// Overridden from aura::WindowDelegate:
gfx::Size GetMinimumSize() const override;
gfx::Size GetMaximumSize() const override;
void OnBoundsChanged(const gfx::Rect& old_bounds,
const gfx::Rect& new_bounds) override;
gfx::NativeCursor GetCursor(const gfx::Point& point) override;
int GetNonClientComponent(const gfx::Point& point) const override;
bool ShouldDescendIntoChildForEventHandling(
aura::Window* child,
const gfx::Point& location) override;
bool CanFocus() override;
void OnCaptureLost() override;
void OnPaint(const ui::PaintContext& context) override;
void OnDeviceScaleFactorChanged(float old_device_scale_factor,
float new_device_scale_factor) override;
void OnWindowDestroying(aura::Window* window) override;
void OnWindowDestroyed(aura::Window* window) override;
void OnWindowTargetVisibilityChanged(bool visible) override;
bool HasHitTestMask() const override;
void GetHitTestMask(SkPath* mask) const override;
bool RequiresDoubleTapGestureEvents() const override;
// Overridden from ui::EventHandler:
void OnKeyEvent(ui::KeyEvent* event) override;
void OnMouseEvent(ui::MouseEvent* event) override;
void OnScrollEvent(ui::ScrollEvent* event) override;
void OnTouchEvent(ui::TouchEvent* event) override;
void OnGestureEvent(ui::GestureEvent* event) override;
std::string_view GetLogContext() const override;
// Overridden from wm::ActivationDelegate:
bool ShouldActivate() const override;
// Overridden from aura::client::CursorClientObserver:
void OnCursorVisibilityChanged(bool is_visible) override;
// Overridden from aura::client::CursorClientObserver:
void OnSystemCursorSizeChanged(const gfx::Size& cursor_size) override;
// Overridden from aura::client::FocusChangeObserver:
void OnWindowFocused(aura::Window* gained_focus,
aura::Window* lost_focus) override;
// Overridden from aura::WindowTreeHostObserver:
void OnHostMovedInPixels(aura::WindowTreeHost* host) override;
// RenderFrameMetadataProvider::Observer implementation.
void OnRenderFrameMetadataChangedBeforeActivation(
const cc::RenderFrameMetadata& metadata) override {}
void OnRenderFrameMetadataChangedAfterActivation(
base::TimeTicks activation_time) override;
void OnRenderFrameSubmission() override {}
void OnLocalSurfaceIdChanged(
const cc::RenderFrameMetadata& metadata) override {}
#if BUILDFLAG(IS_WIN)
// Gets the HWND of the host window.
HWND GetHostWindowHWND() const;
// Updates the cursor clip region. Used for mouse locking.
void UpdateMouseLockRegion();
// Notification that the LegacyRenderWidgetHostHWND was destroyed.
void OnLegacyWindowDestroyed();
#endif
gfx::NativeViewAccessible GetParentNativeViewAccessible();
// Method to indicate if this instance is shutting down or closing.
// TODO(shrikant): Discuss around to see if it makes sense to add this method
// as part of RenderWidgetHostView.
bool IsClosing() const { return in_shutdown_; }
// Sets whether the overscroll controller should be enabled for this page.
void SetOverscrollControllerEnabled(bool enabled);
void SnapToPhysicalPixelBoundary();
// Used in tests to set a mock client for touch selection controller. It will
// create a new touch selection controller for the new client.
void SetSelectionControllerClientForTest(
std::unique_ptr<TouchSelectionControllerClientAura> client);
// RenderWidgetHostViewEventHandler::Delegate:
gfx::Rect ConvertRectToScreen(const gfx::Rect& rect) const override;
void ForwardKeyboardEventWithLatencyInfo(
const input::NativeWebKeyboardEvent& event,
const ui::LatencyInfo& latency,
bool* update_event) override;
RenderFrameHostImpl* GetFocusedFrame() const;
bool NeedsMouseCapture() override;
void SetTooltipsEnabled(bool enable) override;
void Shutdown() override;
bool FocusedFrameHasStickyActivation() const;
RenderWidgetHostViewEventHandler* event_handler() {
return event_handler_.get();
}
void ScrollFocusedEditableNodeIntoView();
ui::EventPointerType GetLastPointerType() const { return last_pointer_type_; }
MouseWheelPhaseHandler* GetMouseWheelPhaseHandler() override;
ui::Compositor* GetCompositor() override;
DelegatedFrameHost* GetDelegatedFrameHostForTesting() const {
return delegated_frame_host_.get();
}
protected:
~RenderWidgetHostViewAura() override;
// Exposed for tests.
aura::Window* window() { return window_; }
DelegatedFrameHost* GetDelegatedFrameHost() const {
return delegated_frame_host_.get();
}
// RenderWidgetHostViewBase:
void UpdateFrameSinkIdRegistration() override;
void UpdateBackgroundColor() override;
bool HasFallbackSurface() const override;
std::optional<DisplayFeature> GetDisplayFeature() override;
void SetDisplayFeatureForTesting(
const DisplayFeature* display_feature) override;
void EnsurePlatformVisibility(PageVisibilityState page_visibility) override;
void NotifyHostAndDelegateOnWasShown(
blink::mojom::RecordContentToVisibleTimeRequestPtr visible_time_request)
final;
void RequestSuccessfulPresentationTimeFromHostOrDelegate(
blink::mojom::RecordContentToVisibleTimeRequestPtr visible_time_request)
final;
void CancelSuccessfulPresentationTimeRequestForHostAndDelegate() final;
// May be overridden in tests.
virtual bool ShouldSkipCursorUpdate() const;
private:
friend class DelegatedFrameHostClientAura;
friend class FakeRenderWidgetHostViewAura;
friend class InputMethodAuraTestBase;
friend class RenderWidgetHostViewAuraTest;
friend class RenderWidgetHostViewAuraBrowserTest;
friend class RenderWidgetHostViewAuraDevtoolsBrowserTest;
friend class RenderWidgetHostViewAuraCopyRequestTest;
friend class TestInputMethodObserver;
#if BUILDFLAG(IS_WIN)
friend class AccessibilityObjectLifetimeWinBrowserTest;
friend class AccessibilityTreeLinkageWinBrowserTest;
friend class DirectManipulationBrowserTestBase;
#endif
FRIEND_TEST_ALL_PREFIXES(InputMethodResultAuraTest,
FinishImeCompositionSession);
FRIEND_TEST_ALL_PREFIXES(PaintHoldingRenderWidgetHostViewBrowserTest,
PaintHoldingOnNavigation);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest,
PopupRetainsCaptureAfterMouseRelease);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest, SetCompositionText);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest, FocusedNodeChanged);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest, TouchEventState);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest,
TouchEventPositionsArentRounded);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest, TouchEventSyncAsync);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest, Resize);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest, SwapNotifiesWindow);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest, MirrorLayers);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest,
SkippedDelegatedFrames);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest,
ResizeAfterReceivingFrame);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest,
ChildGeneratedResizeRoutesLocalSurfaceId);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest, MissingFramesDontLock);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest, OutputSurfaceIdChange);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest,
DiscardDelegatedFrames);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest,
DiscardDelegatedFramesWithLocking);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest, SoftwareDPIChange);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest,
UpdateCursorIfOverSelf);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest,
VisibleViewportTest);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest,
OverscrollResetsOnBlur);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest,
FinishCompositionByMouse);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest,
ForwardsBeginFrameAcks);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest,
VirtualKeyboardFocusEnsureCaretInRect);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest,
DiscardDelegatedFramesWithMemoryPressure);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraInputMethodTest,
OnCaretBoundsChanged);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraInputMethodTest,
OnCaretBoundsChangedInputModeNone);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraInputMethodFocusTest,
OnFocusLost);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraKeyboardTest,
KeyboardObserverDestroyed);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraKeyboardTest,
NoKeyboardObserverForMouseInput);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraKeyboardTest,
KeyboardObserverForOnlyTouchInput);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraKeyboardTest,
KeyboardObserverForFocusedNodeChanged);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraKeyboardTest,
KeyboardObserverForPenInput);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraKeyboardTest,
KeyboardObserverDetachDuringWindowDestroy);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest,
DropFallbackWhenHidden);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest,
CompositorFrameSinkChange);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest, SurfaceChanges);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest,
DeviceScaleFactorChanges);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest, HideThenShow);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest,
DropFallbackIfResizedWhileHidden);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest,
DontDropFallbackIfNotResizedWhileHidden);
FRIEND_TEST_ALL_PREFIXES(SitePerProcessHitTestBrowserTest, PopupMenuTest);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest,
NewContentRenderingTimeout);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest,
AllocateLocalSurfaceIdOnEviction);
FRIEND_TEST_ALL_PREFIXES(WebContentsViewAuraTest,
WebContentsViewReparent);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest, TakeFallbackContent);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest,
TakeFallbackContentForPrerender);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest,
DiscardDelegatedFrames);
FRIEND_TEST_ALL_PREFIXES(SitePerProcessHitTestBrowserTest,
ScrollOOPIFEditableElement);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest, OcclusionHidesTooltip);
FRIEND_TEST_ALL_PREFIXES(RenderWidgetHostViewAuraTest,
UpdateInsetsWithVirtualKeyboardEnabled);
class WindowObserver;
friend class WindowObserver;
friend void VerifyStaleContentOnFrameEviction(
RenderWidgetHostView* render_widget_host_view);
void CreateAuraWindow(aura::client::WindowType type);
// Returns true if a stale frame content needs to be set for the current RWHV.
// This is primarily useful during various CrOS animations to prevent showing
// a white screen and instead showing a snapshot of the frame content that
// was most recently evicted.
bool ShouldShowStaleContentOnEviction();
void CreateDelegatedFrameHostClient();
void UpdateCursorIfOverSelf();
bool SynchronizeVisualProperties(
const cc::DeadlinePolicy& deadline_policy,
const std::optional<viz::LocalSurfaceId>& child_local_surface_id);
void OnDidUpdateVisualPropertiesComplete(
const cc::RenderFrameMetadata& metadata);
// Set the bounds of the window and handle size changes. Assumes the caller
// has already adjusted the origin of |rect| to conform to whatever coordinate
// space is required by the aura::Window.
void InternalSetBounds(const gfx::Rect& rect);
// Update the insets for bounds change when the virtual keyboard is shown.
void UpdateInsetsWithVirtualKeyboardEnabled();
#if BUILDFLAG(IS_WIN)
// Creates and/or updates the legacy dummy window which corresponds to
// the bounds of the webcontents. It is needed for accessibility and
// for scrolling to work in legacy drivers for trackpoints/trackpads, etc.
void UpdateLegacyWin();
#endif
ui::InputMethod* GetInputMethod() const;
// Get the focused view that should be used for retrieving the text selection.
RenderWidgetHostViewBase* GetFocusedViewForTextSelection() const;
// Returns whether the widget needs an input grab to work properly.
bool NeedsInputGrab();
// Sends an IPC to the renderer process to communicate whether or not
// the mouse cursor is visible anywhere on the screen.
void NotifyRendererOfCursorVisibilityState(bool is_visible);
// Called after |window_| is parented to a WindowEventDispatcher.
void AddedToRootWindow();
// Called prior to removing |window_| from a WindowEventDispatcher.
void RemovingFromRootWindow();
// TextInputManager::Observer implementation.
void OnUpdateTextInputStateCalled(TextInputManager* text_input_manager,
RenderWidgetHostViewBase* updated_view,
bool did_update_state) override;
void OnImeCancelComposition(TextInputManager* text_input_manager,
RenderWidgetHostViewBase* updated_view) override;
void OnSelectionBoundsChanged(
TextInputManager* text_input_manager,
RenderWidgetHostViewBase* updated_view) override;
void OnTextSelectionChanged(TextInputManager* text_input_mangager,
RenderWidgetHostViewBase* updated_view) override;
// Detaches |this| from the input method object.
// is_removed flag is true if this is called while the window is
// getting removed/destroyed, false, otherwise.
void DetachFromInputMethod(bool is_removed);
// Dismisses a Web Popup on a mouse or touch press outside the popup and its
// parent.
void ApplyEventObserverForPopupExit(const ui::LocatedEvent& event);
// Converts |rect| from screen coordinate to window coordinate.
gfx::Rect ConvertRectFromScreen(const gfx::Rect& rect) const;
// Called when the bounds of `window_` relative to the root change.
void HandleBoundsInRootChanged();
// Called when the parent window hierarchy for our window changes.
void ParentHierarchyChanged();
// Helper function to create a selection controller.
void CreateSelectionController();
// Used to set the |popup_child_host_view_| on the |popup_parent_host_view_|
// and to notify the |event_handler_|.
void SetPopupChild(RenderWidgetHostViewAura* popup_child_host_view);
// Called when the window title is changed.
void WindowTitleChanged();
void InvalidateLocalSurfaceIdOnEviction();
// Called to process a display metrics change.
void ProcessDisplayMetricsChanged();
void CancelActiveTouches();
// Common part of UnOccluded() and Show().
void ShowImpl(PageVisibilityState page_visibility);
// Common part of Occluded() and Hide().
void HideImpl();
blink::mojom::FrameWidgetInputHandler*
GetFrameWidgetInputHandlerForFocusedWidget();
void SetTooltipText(const std::u16string& tooltip_text);
#if BUILDFLAG(IS_WIN)
// Ensure that we're observing the device posture platform provider to
// get the display feature changes.
void ObserveDevicePosturePlatformProvider();
#endif
// DevicePosturePlatformProvider::Observer.
void OnDisplayFeatureBoundsChanged(
const gfx::Rect& display_feature_bounds) override;
// Provided a list of viewport segments, calculate and set the
// DisplayFeature.
void ComputeDisplayFeature();
#if BUILDFLAG(IS_WIN)
// Forwards `proximate_bounds` to the TextInputManager for caching.
void UpdateProximateCharacterBounds(
blink::mojom::ProximateCharacterRangeBoundsPtr proximate_bounds);
// Invoked on Shell Handwriting API request to update the element's focus
// based on the provided rect and the distance tolerance.
void OnFocusHandwritingTarget(const gfx::Rect& rect_in_screen,
const gfx::Size& distance_tolerance);
#endif // BUILDFLAG(IS_WIN)
raw_ptr<aura::Window> window_;
std::unique_ptr<DelegatedFrameHostClient> delegated_frame_host_client_;
// NOTE: this may be null during destruction.
std::unique_ptr<DelegatedFrameHost> delegated_frame_host_;
std::unique_ptr<WindowObserver> window_observer_;
// Tracks the ancestors of the RWHVA window for window location changes.
std::unique_ptr<aura_extra::WindowPositionInRootMonitor>
position_in_root_observer_;
// Are we in the process of closing? Tracked so we don't try to shutdown
// again while inside shutdown, causing a double-free.
bool in_shutdown_;
// True if in the process of handling a window bounds changed notification.
bool in_bounds_changed_;
// Our parent host view, if this is a popup. NULL otherwise.
raw_ptr<RenderWidgetHostViewAura, DanglingUntriaged> popup_parent_host_view_;
// Our child popup host. NULL if we do not have a child popup.
raw_ptr<RenderWidgetHostViewAura, DanglingUntriaged> popup_child_host_view_;
class EventObserverForPopupExit;
std::unique_ptr<EventObserverForPopupExit> event_observer_for_popup_exit_;
// True when content is being loaded. Used to show an hourglass cursor.
bool is_loading_;
// The cursor for the page. This is passed up from the renderer.
WebCursor current_cursor_;
// Indicates if there is onging composition text.
bool has_composition_text_;
// Current tooltip text.
std::u16string tooltip_;
// Whether or not a frame observer has been added.
bool added_frame_observer_;
// Used to track the last cursor visibility update that was sent to the
// renderer via NotifyRendererOfCursorVisibilityState().
enum CursorVisibilityState {
UNKNOWN,
VISIBLE,
NOT_VISIBLE,
};
CursorVisibilityState cursor_visibility_state_in_renderer_;
#if BUILDFLAG(IS_WIN)
// Provides a dummy HWND for legacy accessibility tools and drivers.
raw_ptr<LegacyRenderWidgetHostHWND> legacy_render_widget_host_HWND_ = nullptr;
// Whether Windows destroyed the legacy HWND, e.g. via browser DestroyWindow.
// Indicates that recreating the HWND instance again would be futile.
bool legacy_window_destroyed_ = false;
// Contains a copy of the last context menu request parameters. Only set when
// we receive a request to show the context menu on a long press.
std::unique_ptr<ContextMenuParams> last_context_menu_params_;
// Handles the showing/hiding of the VK on Windows.
friend class VirtualKeyboardControllerWin;
std::unique_ptr<VirtualKeyboardControllerWin>
virtual_keyboard_controller_win_;
gfx::Point last_mouse_move_location_;
#endif
// The last selection bounds reported to the view.
gfx::SelectionBound selection_start_;
gfx::SelectionBound selection_end_;
// The insets for the window bounds (not for screen) when the window is
// partially occluded.
gfx::Insets insets_;
// Cache the occluded bounds in screen coordinate of the virtual keyboard.
gfx::Rect keyboard_occluded_bounds_;
std::unique_ptr<wm::ScopedTooltipDisabler> tooltip_disabler_;
float device_scale_factor_;
// While this is a ui::EventHandler for targetting, |event_handler_| actually
// provides an implementation, and directs events to |host_|.
std::unique_ptr<RenderWidgetHostViewEventHandler> event_handler_;
// If this object is the main view of a RenderWidgetHostImpl, this value
// equals to the FrameSinkId of that widget.
const viz::FrameSinkId frame_sink_id_;
std::unique_ptr<input::CursorManager> cursor_manager_;
// Latest capture sequence number which is incremented when the caller
// requests surfaces be synchronized via
// EnsureSurfaceSynchronizedForWebTest().
uint32_t latest_capture_sequence_number_ = 0u;
// The pointer type of the most recent gesture/mouse/touch event.
ui::EventPointerType last_pointer_type_ = ui::EventPointerType::kUnknown;
// The pointer type that caused the most recent focus. This value will be
// incorrect if the focus was not triggered by a user gesture.
ui::EventPointerType last_pointer_type_before_focus_ =
ui::EventPointerType::kUnknown;
bool is_first_navigation_ = true;
viz::LocalSurfaceId inset_surface_id_;
// See OnDisplayMetricsChanged() for details.
bool needs_to_update_display_metrics_ = false;
// Saved value of WebPreferences' |double_tap_to_zoom_enabled|.
bool double_tap_to_zoom_enabled_ = false;
// Current visibility state. Initialized based on
// RenderWidgetHostImpl::is_hidden().
Visibility visibility_;
// Represents a feature of the physical display whose offset and mask_length
// are expressed in DIPs relative to the view. See display_feature.h for more
// details.
std::optional<DisplayFeature> display_feature_;
bool display_feature_overridden_for_testing_ = false;
// Display feature bounds returned by the OS.
gfx::Rect display_feature_bounds_;
#if BUILDFLAG(IS_WIN)
base::ScopedObservation<DevicePosturePlatformProvider,
DevicePosturePlatformProvider::Observer>
device_posture_observation_{this};
#endif
std::optional<display::ScopedDisplayObserver> display_observer_;
base::WeakPtrFactory<RenderWidgetHostViewAura> weak_ptr_factory_{this};
};
} // namespace content
#endif // CONTENT_BROWSER_RENDERER_HOST_RENDER_WIDGET_HOST_VIEW_AURA_H_