-
Notifications
You must be signed in to change notification settings - Fork 54
/
PuppetWidget.cpp
1479 lines (1274 loc) · 47.9 KB
/
PuppetWidget.cpp
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
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
* vim: sw=2 ts=8 et :
*/
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "base/basictypes.h"
#include "ClientLayerManager.h"
#include "gfxPlatform.h"
#include "mozilla/dom/BrowserChild.h"
#include "mozilla/dom/TabGroup.h"
#include "mozilla/gfx/gfxVars.h"
#include "mozilla/Hal.h"
#include "mozilla/IMEStateManager.h"
#include "mozilla/layers/APZChild.h"
#include "mozilla/layers/PLayerTransactionChild.h"
#include "mozilla/layers/WebRenderLayerManager.h"
#include "mozilla/Preferences.h"
#include "mozilla/PresShell.h"
#include "mozilla/StaticPrefs_browser.h"
#include "mozilla/TextComposition.h"
#include "mozilla/TextEventDispatcher.h"
#include "mozilla/TextEvents.h"
#include "mozilla/Unused.h"
#include "BasicLayers.h"
#include "PuppetWidget.h"
#include "nsContentUtils.h"
#include "nsIWidgetListener.h"
#include "imgIContainer.h"
#include "nsView.h"
#include "nsXPLookAndFeel.h"
#include "nsPrintfCString.h"
using namespace mozilla;
using namespace mozilla::dom;
using namespace mozilla::hal;
using namespace mozilla::gfx;
using namespace mozilla::layers;
using namespace mozilla::widget;
static void InvalidateRegion(nsIWidget* aWidget,
const LayoutDeviceIntRegion& aRegion) {
for (auto iter = aRegion.RectIter(); !iter.Done(); iter.Next()) {
aWidget->Invalidate(iter.Get());
}
}
/*static*/
already_AddRefed<nsIWidget> nsIWidget::CreatePuppetWidget(
BrowserChild* aBrowserChild) {
MOZ_ASSERT(!aBrowserChild || nsIWidget::UsePuppetWidgets(),
"PuppetWidgets not allowed in this configuration");
nsCOMPtr<nsIWidget> widget = new PuppetWidget(aBrowserChild);
return widget.forget();
}
namespace mozilla {
namespace widget {
static bool IsPopup(const nsWidgetInitData* aInitData) {
return aInitData && aInitData->mWindowType == eWindowType_popup;
}
static bool MightNeedIMEFocus(const nsWidgetInitData* aInitData) {
// In the puppet-widget world, popup widgets are just dummies and
// shouldn't try to mess with IME state.
#ifdef MOZ_CROSS_PROCESS_IME
return !IsPopup(aInitData);
#else
return false;
#endif
}
// Arbitrary, fungible.
const size_t PuppetWidget::kMaxDimension = 4000;
NS_IMPL_ISUPPORTS_INHERITED(PuppetWidget, nsBaseWidget,
TextEventDispatcherListener)
PuppetWidget::PuppetWidget(BrowserChild* aBrowserChild)
: mBrowserChild(aBrowserChild),
mMemoryPressureObserver(nullptr),
mDPI(-1),
mRounding(1),
mDefaultScale(-1),
mCursorHotspotX(0),
mCursorHotspotY(0),
mEnabled(false),
mVisible(false),
mNeedIMEStateInit(false),
mIgnoreCompositionEvents(false) {
// Setting 'Unknown' means "not yet cached".
mInputContext.mIMEState.mEnabled = IMEState::UNKNOWN;
}
PuppetWidget::~PuppetWidget() { Destroy(); }
void PuppetWidget::InfallibleCreate(nsIWidget* aParent,
nsNativeWidget aNativeParent,
const LayoutDeviceIntRect& aRect,
nsWidgetInitData* aInitData) {
MOZ_ASSERT(!aNativeParent, "got a non-Puppet native parent");
BaseCreate(nullptr, aInitData);
mBounds = aRect;
mEnabled = true;
mVisible = true;
mDrawTarget = gfxPlatform::GetPlatform()->CreateOffscreenContentDrawTarget(
IntSize(1, 1), SurfaceFormat::B8G8R8A8);
mNeedIMEStateInit = MightNeedIMEFocus(aInitData);
PuppetWidget* parent = static_cast<PuppetWidget*>(aParent);
if (parent) {
parent->SetChild(this);
mLayerManager = parent->GetLayerManager();
} else {
Resize(mBounds.X(), mBounds.Y(), mBounds.Width(), mBounds.Height(), false);
}
mMemoryPressureObserver = MemoryPressureObserver::Create(this);
}
nsresult PuppetWidget::Create(nsIWidget* aParent, nsNativeWidget aNativeParent,
const LayoutDeviceIntRect& aRect,
nsWidgetInitData* aInitData) {
InfallibleCreate(aParent, aNativeParent, aRect, aInitData);
return NS_OK;
}
void PuppetWidget::InitIMEState() {
MOZ_ASSERT(mBrowserChild);
if (mNeedIMEStateInit) {
mContentCache.Clear();
mBrowserChild->SendUpdateContentCache(mContentCache);
mIMENotificationRequestsOfParent = IMENotificationRequests();
mNeedIMEStateInit = false;
}
}
already_AddRefed<nsIWidget> PuppetWidget::CreateChild(
const LayoutDeviceIntRect& aRect, nsWidgetInitData* aInitData,
bool aForceUseIWidgetParent) {
bool isPopup = IsPopup(aInitData);
nsCOMPtr<nsIWidget> widget = nsIWidget::CreatePuppetWidget(mBrowserChild);
return ((widget && NS_SUCCEEDED(widget->Create(isPopup ? nullptr : this,
nullptr, aRect, aInitData)))
? widget.forget()
: nullptr);
}
void PuppetWidget::Destroy() {
if (mOnDestroyCalled) {
return;
}
mOnDestroyCalled = true;
Base::OnDestroy();
Base::Destroy();
mPaintTask.Revoke();
if (mMemoryPressureObserver) {
mMemoryPressureObserver->Unregister();
mMemoryPressureObserver = nullptr;
}
mChild = nullptr;
if (mLayerManager) {
mLayerManager->Destroy();
}
mLayerManager = nullptr;
mBrowserChild = nullptr;
}
void PuppetWidget::Show(bool aState) {
NS_ASSERTION(mEnabled,
"does it make sense to Show()/Hide() a disabled widget?");
bool wasVisible = mVisible;
mVisible = aState;
if (mChild) {
mChild->mVisible = aState;
}
if (!wasVisible && mVisible) {
// The previously attached widget listener is handy if
// we're transitioning from page to page without dropping
// layers (since we'll continue to show the old layers
// associated with that old widget listener). If the
// PuppetWidget was hidden, those layers are dropped,
// so the previously attached widget listener is really
// of no use anymore (and is actually actively harmful - see
// bug 1323586).
mPreviouslyAttachedWidgetListener = nullptr;
Resize(mBounds.Width(), mBounds.Height(), false);
Invalidate(mBounds);
}
}
void PuppetWidget::Resize(double aWidth, double aHeight, bool aRepaint) {
LayoutDeviceIntRect oldBounds = mBounds;
mBounds.SizeTo(
LayoutDeviceIntSize(NSToIntRound(aWidth), NSToIntRound(aHeight)));
if (mChild) {
mChild->Resize(aWidth, aHeight, aRepaint);
return;
}
// XXX: roc says that |aRepaint| dictates whether or not to
// invalidate the expanded area
if (oldBounds.Size() < mBounds.Size() && aRepaint) {
LayoutDeviceIntRegion dirty(mBounds);
dirty.Sub(dirty, oldBounds);
InvalidateRegion(this, dirty);
}
// call WindowResized() on both the current listener, and possibly
// also the previous one if we're in a state where we're drawing that one
// because the current one is paint suppressed
if (!oldBounds.IsEqualEdges(mBounds) && mAttachedWidgetListener) {
if (GetCurrentWidgetListener() &&
GetCurrentWidgetListener() != mAttachedWidgetListener) {
GetCurrentWidgetListener()->WindowResized(this, mBounds.Width(),
mBounds.Height());
}
mAttachedWidgetListener->WindowResized(this, mBounds.Width(),
mBounds.Height());
}
}
nsresult PuppetWidget::ConfigureChildren(
const nsTArray<Configuration>& aConfigurations) {
for (uint32_t i = 0; i < aConfigurations.Length(); ++i) {
const Configuration& configuration = aConfigurations[i];
PuppetWidget* w = static_cast<PuppetWidget*>(configuration.mChild.get());
NS_ASSERTION(w->GetParent() == this, "Configured widget is not a child");
w->SetWindowClipRegion(configuration.mClipRegion, true);
LayoutDeviceIntRect bounds = w->GetBounds();
if (bounds.Size() != configuration.mBounds.Size()) {
w->Resize(configuration.mBounds.X(), configuration.mBounds.Y(),
configuration.mBounds.Width(), configuration.mBounds.Height(),
true);
} else if (bounds.TopLeft() != configuration.mBounds.TopLeft()) {
w->Move(configuration.mBounds.X(), configuration.mBounds.Y());
}
w->SetWindowClipRegion(configuration.mClipRegion, false);
}
return NS_OK;
}
void PuppetWidget::SetFocus(Raise aRaise, CallerType aCallerType) {
if (aRaise == Raise::Yes && mBrowserChild) {
mBrowserChild->SendRequestFocus(true, aCallerType);
}
}
void PuppetWidget::Invalidate(const LayoutDeviceIntRect& aRect) {
#ifdef DEBUG
debug_DumpInvalidate(stderr, this, &aRect, "PuppetWidget", 0);
#endif
if (mChild) {
mChild->Invalidate(aRect);
return;
}
mDirtyRegion.Or(mDirtyRegion, aRect);
if (mBrowserChild && !mDirtyRegion.IsEmpty() && !mPaintTask.IsPending()) {
mPaintTask = new PaintTask(this);
nsCOMPtr<nsIRunnable> event(mPaintTask.get());
mBrowserChild->TabGroup()->Dispatch(TaskCategory::Other, event.forget());
return;
}
}
mozilla::LayoutDeviceToLayoutDeviceMatrix4x4
PuppetWidget::WidgetToTopLevelWidgetTransform() {
if (!GetOwningBrowserChild()) {
NS_WARNING("PuppetWidget without Tab does not have transform information.");
return mozilla::LayoutDeviceToLayoutDeviceMatrix4x4();
}
return GetOwningBrowserChild()->GetChildToParentConversionMatrix();
}
void PuppetWidget::InitEvent(WidgetGUIEvent& aEvent,
LayoutDeviceIntPoint* aPoint) {
if (nullptr == aPoint) {
aEvent.mRefPoint = LayoutDeviceIntPoint(0, 0);
} else {
// use the point override if provided
aEvent.mRefPoint = *aPoint;
}
aEvent.mTime = PR_Now() / 1000;
}
nsresult PuppetWidget::DispatchEvent(WidgetGUIEvent* aEvent,
nsEventStatus& aStatus) {
#ifdef DEBUG
debug_DumpEvent(stdout, aEvent->mWidget, aEvent, "PuppetWidget", 0);
#endif
MOZ_ASSERT(!mChild || mChild->mWindowType == eWindowType_popup,
"Unexpected event dispatch!");
MOZ_ASSERT(!aEvent->AsKeyboardEvent() ||
aEvent->mFlags.mIsSynthesizedForTests ||
aEvent->AsKeyboardEvent()->AreAllEditCommandsInitialized(),
"Non-sysnthesized keyboard events should have edit commands for "
"all types "
"before dispatched");
if (aEvent->mClass == eCompositionEventClass) {
// If we've already requested to commit/cancel the latest composition,
// TextComposition for the old composition has been destroyed. Then,
// the DOM tree needs to listen to next eCompositionStart and its
// following events. So, until we meet new eCompositionStart, let's
// discard all unnecessary composition events here.
if (mIgnoreCompositionEvents) {
if (aEvent->mMessage != eCompositionStart) {
aStatus = nsEventStatus_eIgnore;
return NS_OK;
}
// Now, we receive new eCompositionStart. Let's restart to handle
// composition in this process.
mIgnoreCompositionEvents = false;
}
// Store the latest native IME context of parent process's widget or
// TextEventDispatcher if it's in this process.
WidgetCompositionEvent* compositionEvent = aEvent->AsCompositionEvent();
#ifdef DEBUG
if (mNativeIMEContext.IsValid() &&
mNativeIMEContext != compositionEvent->mNativeIMEContext) {
RefPtr<TextComposition> composition =
IMEStateManager::GetTextCompositionFor(this);
MOZ_ASSERT(
!composition,
"When there is composition caused by old native IME context, "
"composition events caused by different native IME context are not "
"allowed");
}
#endif // #ifdef DEBUG
mNativeIMEContext = compositionEvent->mNativeIMEContext;
}
// If the event is a composition event or a keyboard event, it should be
// dispatched with TextEventDispatcher if we could do that with current
// design. However, we cannot do that without big changes and the behavior
// is not so complicated for now. Therefore, we should just notify it
// of dispatching events and TextEventDispatcher should emulate the state
// with events here.
if (aEvent->mClass == eCompositionEventClass ||
aEvent->mClass == eKeyboardEventClass) {
TextEventDispatcher* dispatcher = GetTextEventDispatcher();
// However, if the event is being dispatched by the text event dispatcher
// or, there is native text event dispatcher listener, that means that
// native text input event handler is in this process like on Android,
// and the event is not synthesized for tests, the event is coming from
// the TextEventDispatcher. In these cases, we shouldn't notify
// TextEventDispatcher of dispatching the event.
if (!dispatcher->IsDispatchingEvent() &&
!(mNativeTextEventDispatcherListener &&
!aEvent->mFlags.mIsSynthesizedForTests)) {
DebugOnly<nsresult> rv =
dispatcher->BeginInputTransactionFor(aEvent, this);
NS_WARNING_ASSERTION(
NS_SUCCEEDED(rv),
"The text event dispatcher should always succeed to start input "
"transaction for the event");
}
}
aStatus = nsEventStatus_eIgnore;
if (GetCurrentWidgetListener()) {
aStatus =
GetCurrentWidgetListener()->HandleEvent(aEvent, mUseAttachedEvents);
}
return NS_OK;
}
nsEventStatus PuppetWidget::DispatchInputEvent(WidgetInputEvent* aEvent) {
if (!AsyncPanZoomEnabled()) {
nsEventStatus status = nsEventStatus_eIgnore;
DispatchEvent(aEvent, status);
return status;
}
if (!mBrowserChild) {
return nsEventStatus_eIgnore;
}
if (PresShell* presShell = mBrowserChild->GetTopLevelPresShell()) {
// Because the root resolution is conceptually at the parent/child process
// boundary, we need to apply that resolution here because we're sending
// the event from the child to the parent process.
LayoutDevicePoint pt(aEvent->mRefPoint);
pt = pt * presShell->GetResolution();
aEvent->mRefPoint = LayoutDeviceIntPoint::Round(pt);
}
switch (aEvent->mClass) {
case eWheelEventClass:
Unused << mBrowserChild->SendDispatchWheelEvent(*aEvent->AsWheelEvent());
break;
case eMouseEventClass:
Unused << mBrowserChild->SendDispatchMouseEvent(*aEvent->AsMouseEvent());
break;
case eKeyboardEventClass:
Unused << mBrowserChild->SendDispatchKeyboardEvent(
*aEvent->AsKeyboardEvent());
break;
default:
MOZ_ASSERT_UNREACHABLE("unsupported event type");
}
return nsEventStatus_eIgnore;
}
nsresult PuppetWidget::SynthesizeNativeKeyEvent(
int32_t aNativeKeyboardLayout, int32_t aNativeKeyCode,
uint32_t aModifierFlags, const nsAString& aCharacters,
const nsAString& aUnmodifiedCharacters, nsIObserver* aObserver) {
AutoObserverNotifier notifier(aObserver, "keyevent");
if (!mBrowserChild) {
return NS_ERROR_FAILURE;
}
mBrowserChild->SendSynthesizeNativeKeyEvent(
aNativeKeyboardLayout, aNativeKeyCode, aModifierFlags,
nsString(aCharacters), nsString(aUnmodifiedCharacters),
notifier.SaveObserver());
return NS_OK;
}
nsresult PuppetWidget::SynthesizeNativeMouseEvent(
mozilla::LayoutDeviceIntPoint aPoint, uint32_t aNativeMessage,
uint32_t aModifierFlags, nsIObserver* aObserver) {
AutoObserverNotifier notifier(aObserver, "mouseevent");
if (!mBrowserChild) {
return NS_ERROR_FAILURE;
}
mBrowserChild->SendSynthesizeNativeMouseEvent(
aPoint, aNativeMessage, aModifierFlags, notifier.SaveObserver());
return NS_OK;
}
nsresult PuppetWidget::SynthesizeNativeMouseMove(
mozilla::LayoutDeviceIntPoint aPoint, nsIObserver* aObserver) {
AutoObserverNotifier notifier(aObserver, "mousemove");
if (!mBrowserChild) {
return NS_ERROR_FAILURE;
}
mBrowserChild->SendSynthesizeNativeMouseMove(aPoint, notifier.SaveObserver());
return NS_OK;
}
nsresult PuppetWidget::SynthesizeNativeMouseScrollEvent(
mozilla::LayoutDeviceIntPoint aPoint, uint32_t aNativeMessage,
double aDeltaX, double aDeltaY, double aDeltaZ, uint32_t aModifierFlags,
uint32_t aAdditionalFlags, nsIObserver* aObserver) {
AutoObserverNotifier notifier(aObserver, "mousescrollevent");
if (!mBrowserChild) {
return NS_ERROR_FAILURE;
}
mBrowserChild->SendSynthesizeNativeMouseScrollEvent(
aPoint, aNativeMessage, aDeltaX, aDeltaY, aDeltaZ, aModifierFlags,
aAdditionalFlags, notifier.SaveObserver());
return NS_OK;
}
nsresult PuppetWidget::SynthesizeNativeTouchPoint(
uint32_t aPointerId, TouchPointerState aPointerState,
LayoutDeviceIntPoint aPoint, double aPointerPressure,
uint32_t aPointerOrientation, nsIObserver* aObserver) {
AutoObserverNotifier notifier(aObserver, "touchpoint");
if (!mBrowserChild) {
return NS_ERROR_FAILURE;
}
mBrowserChild->SendSynthesizeNativeTouchPoint(
aPointerId, aPointerState, aPoint, aPointerPressure, aPointerOrientation,
notifier.SaveObserver());
return NS_OK;
}
nsresult PuppetWidget::SynthesizeNativeTouchTap(LayoutDeviceIntPoint aPoint,
bool aLongTap,
nsIObserver* aObserver) {
AutoObserverNotifier notifier(aObserver, "touchtap");
if (!mBrowserChild) {
return NS_ERROR_FAILURE;
}
mBrowserChild->SendSynthesizeNativeTouchTap(aPoint, aLongTap,
notifier.SaveObserver());
return NS_OK;
}
nsresult PuppetWidget::ClearNativeTouchSequence(nsIObserver* aObserver) {
AutoObserverNotifier notifier(aObserver, "cleartouch");
if (!mBrowserChild) {
return NS_ERROR_FAILURE;
}
mBrowserChild->SendClearNativeTouchSequence(notifier.SaveObserver());
return NS_OK;
}
void PuppetWidget::SetConfirmedTargetAPZC(
uint64_t aInputBlockId,
const nsTArray<SLGuidAndRenderRoot>& aTargets) const {
if (mBrowserChild) {
mBrowserChild->SetTargetAPZC(aInputBlockId, aTargets);
}
}
void PuppetWidget::UpdateZoomConstraints(
const uint32_t& aPresShellId, const ScrollableLayerGuid::ViewID& aViewId,
const Maybe<ZoomConstraints>& aConstraints) {
if (mBrowserChild) {
mBrowserChild->DoUpdateZoomConstraints(aPresShellId, aViewId, aConstraints);
}
}
bool PuppetWidget::AsyncPanZoomEnabled() const {
return mBrowserChild && mBrowserChild->AsyncPanZoomEnabled();
}
bool PuppetWidget::GetEditCommands(NativeKeyBindingsType aType,
const WidgetKeyboardEvent& aEvent,
nsTArray<CommandInt>& aCommands) {
// Validate the arguments.
if (NS_WARN_IF(!nsIWidget::GetEditCommands(aType, aEvent, aCommands))) {
return false;
}
if (NS_WARN_IF(!mBrowserChild)) {
return false;
}
mBrowserChild->RequestEditCommands(aType, aEvent, aCommands);
return true;
}
LayerManager* PuppetWidget::GetLayerManager(
PLayerTransactionChild* aShadowManager, LayersBackend aBackendHint,
LayerManagerPersistence aPersistence) {
if (!mLayerManager) {
if (XRE_IsParentProcess()) {
// On the parent process there is no CompositorBridgeChild which confuses
// some layers code, so we use basic layers instead. Note that we create
// a non-retaining layer manager since we don't care about performance.
mLayerManager = new BasicLayerManager(BasicLayerManager::BLM_OFFSCREEN);
return mLayerManager;
}
// If we know for sure that the parent side of this BrowserChild is not
// connected to the compositor, we don't want to use a "remote" layer
// manager like WebRender or Client. Instead we use a Basic one which
// can do drawing in this process.
MOZ_ASSERT(!mBrowserChild ||
mBrowserChild->IsLayersConnected() != Some(true));
mLayerManager = new BasicLayerManager(this);
}
return mLayerManager;
}
bool PuppetWidget::CreateRemoteLayerManager(
const std::function<bool(LayerManager*)>& aInitializeFunc) {
RefPtr<LayerManager> lm;
MOZ_ASSERT(mBrowserChild);
if (mBrowserChild->GetCompositorOptions().UseWebRender()) {
lm = new WebRenderLayerManager(this);
} else {
lm = new ClientLayerManager(this);
}
if (!aInitializeFunc(lm)) {
return false;
}
// Force the old LM to self destruct, otherwise if the reference dangles we
// could fail to revoke the most recent transaction. We only want to replace
// it if we successfully create its successor because a partially initialized
// layer manager is worse than a fully initialized but shutdown layer manager.
DestroyLayerManager();
mLayerManager = std::move(lm);
return true;
}
nsresult PuppetWidget::RequestIMEToCommitComposition(bool aCancel) {
if (!mBrowserChild) {
return NS_ERROR_FAILURE;
}
MOZ_ASSERT(!Destroyed());
// There must not be composition which is caused by the PuppetWidget instance.
if (NS_WARN_IF(!mNativeIMEContext.IsValid())) {
return NS_OK;
}
// We've already requested to commit/cancel composition.
if (NS_WARN_IF(mIgnoreCompositionEvents)) {
#ifdef DEBUG
RefPtr<TextComposition> composition =
IMEStateManager::GetTextCompositionFor(this);
MOZ_ASSERT(!composition);
#endif // #ifdef DEBUG
return NS_OK;
}
RefPtr<TextComposition> composition =
IMEStateManager::GetTextCompositionFor(this);
// This method shouldn't be called when there is no text composition instance.
if (NS_WARN_IF(!composition)) {
return NS_OK;
}
MOZ_DIAGNOSTIC_ASSERT(
composition->IsRequestingCommitOrCancelComposition(),
"Requesting commit or cancel composition should be requested via "
"TextComposition instance");
bool isCommitted = false;
nsAutoString committedString;
if (NS_WARN_IF(!mBrowserChild->SendRequestIMEToCommitComposition(
aCancel, &isCommitted, &committedString))) {
return NS_ERROR_FAILURE;
}
// If the composition wasn't committed synchronously, we need to wait async
// composition events for destroying the TextComposition instance.
if (!isCommitted) {
return NS_OK;
}
// Dispatch eCompositionCommit event.
WidgetCompositionEvent compositionCommitEvent(true, eCompositionCommit, this);
InitEvent(compositionCommitEvent, nullptr);
compositionCommitEvent.mData = committedString;
nsEventStatus status = nsEventStatus_eIgnore;
DispatchEvent(&compositionCommitEvent, status);
#ifdef DEBUG
RefPtr<TextComposition> currentComposition =
IMEStateManager::GetTextCompositionFor(this);
MOZ_ASSERT(!currentComposition);
#endif // #ifdef DEBUG
// Ignore the following composition events until we receive new
// eCompositionStart event.
mIgnoreCompositionEvents = true;
Unused << mBrowserChild->SendOnEventNeedingAckHandled(
eCompositionCommitRequestHandled);
// NOTE: PuppetWidget might be destroyed already.
return NS_OK;
}
nsresult PuppetWidget::StartPluginIME(const WidgetKeyboardEvent& aKeyboardEvent,
int32_t aPanelX, int32_t aPanelY,
nsString& aCommitted) {
DebugOnly<bool> propagationAlreadyStopped =
aKeyboardEvent.mFlags.mPropagationStopped;
DebugOnly<bool> immediatePropagationAlreadyStopped =
aKeyboardEvent.mFlags.mImmediatePropagationStopped;
if (!mBrowserChild || !mBrowserChild->SendStartPluginIME(
aKeyboardEvent, aPanelX, aPanelY, &aCommitted)) {
return NS_ERROR_FAILURE;
}
// BrowserChild::SendStartPluginIME() sends back the keyboard event to the
// main process synchronously. At this time,
// ParamTraits<WidgetEvent>::Write() marks the event as "posted to remote
// process". However, this is not correct here since the event has been
// handled synchronously in the main process. So, we adjust the cross process
// dispatching state here.
const_cast<WidgetKeyboardEvent&>(aKeyboardEvent)
.ResetCrossProcessDispatchingState();
// Although it shouldn't occur in content process,
// ResetCrossProcessDispatchingState() may reset propagation state too
// if the event was posted to a remote process and we're waiting its
// result. So, if you saw hitting the following assertions, you'd
// need to restore the propagation state too.
MOZ_ASSERT(propagationAlreadyStopped ==
aKeyboardEvent.mFlags.mPropagationStopped);
MOZ_ASSERT(immediatePropagationAlreadyStopped ==
aKeyboardEvent.mFlags.mImmediatePropagationStopped);
return NS_OK;
}
void PuppetWidget::SetPluginFocused(bool& aFocused) {
if (mBrowserChild) {
mBrowserChild->SendSetPluginFocused(aFocused);
}
}
void PuppetWidget::DefaultProcOfPluginEvent(const WidgetPluginEvent& aEvent) {
if (!mBrowserChild) {
return;
}
mBrowserChild->SendDefaultProcOfPluginEvent(aEvent);
}
// When this widget caches input context and currently managed by
// IMEStateManager, the cache is valid.
bool PuppetWidget::HaveValidInputContextCache() const {
return (mInputContext.mIMEState.mEnabled != IMEState::UNKNOWN &&
IMEStateManager::GetWidgetForActiveInputContext() == this);
}
void PuppetWidget::SetInputContext(const InputContext& aContext,
const InputContextAction& aAction) {
mInputContext = aContext;
// Any widget instances cannot cache IME open state because IME open state
// can be changed by user but native IME may not notify us of changing the
// open state on some platforms.
mInputContext.mIMEState.mOpen = IMEState::OPEN_STATE_NOT_SUPPORTED;
if (!mBrowserChild) {
return;
}
mBrowserChild->SendSetInputContext(aContext, aAction);
}
InputContext PuppetWidget::GetInputContext() {
// XXX Currently, we don't support retrieving IME open state from child
// process.
// If the cache of input context is valid, we can avoid to use synchronous
// IPC.
if (HaveValidInputContextCache()) {
return mInputContext;
}
NS_WARNING("PuppetWidget::GetInputContext() needs to retrieve it with IPC");
// Don't cache InputContext here because this process isn't managing IME
// state of the chrome widget. So, we cannot modify mInputContext when
// chrome widget is set to new context.
InputContext context;
if (mBrowserChild) {
mBrowserChild->SendGetInputContext(&context.mIMEState);
}
return context;
}
NativeIMEContext PuppetWidget::GetNativeIMEContext() {
return mNativeIMEContext;
}
nsresult PuppetWidget::NotifyIMEOfFocusChange(
const IMENotification& aIMENotification) {
if (!mBrowserChild) {
return NS_ERROR_FAILURE;
}
bool gotFocus = aIMENotification.mMessage == NOTIFY_IME_OF_FOCUS;
if (gotFocus) {
if (mInputContext.mIMEState.mEnabled != IMEState::PLUGIN) {
// When IME gets focus, we should initalize all information of the
// content.
if (NS_WARN_IF(!mContentCache.CacheAll(this, &aIMENotification))) {
return NS_ERROR_FAILURE;
}
} else {
// However, if a plugin has focus, only the editor rect information is
// available.
if (NS_WARN_IF(!mContentCache.CacheEditorRect(this, &aIMENotification))) {
return NS_ERROR_FAILURE;
}
}
} else {
// When IME loses focus, we don't need to store anything.
mContentCache.Clear();
}
mIMENotificationRequestsOfParent =
IMENotificationRequests(IMENotificationRequests::NOTIFY_ALL);
RefPtr<PuppetWidget> self = this;
mBrowserChild->SendNotifyIMEFocus(mContentCache, aIMENotification)
->Then(
mBrowserChild->TabGroup()->EventTargetFor(TaskCategory::UI), __func__,
[self](IMENotificationRequests&& aRequests) {
self->mIMENotificationRequestsOfParent = aRequests;
if (TextEventDispatcher* dispatcher =
self->GetTextEventDispatcher()) {
dispatcher->OnWidgetChangeIMENotificationRequests(self);
}
},
[self](mozilla::ipc::ResponseRejectReason&& aReason) {
NS_WARNING("SendNotifyIMEFocus got rejected.");
});
return NS_OK;
}
nsresult PuppetWidget::NotifyIMEOfCompositionUpdate(
const IMENotification& aIMENotification) {
if (NS_WARN_IF(!mBrowserChild)) {
return NS_ERROR_FAILURE;
}
if (mInputContext.mIMEState.mEnabled != IMEState::PLUGIN &&
NS_WARN_IF(!mContentCache.CacheSelection(this, &aIMENotification))) {
return NS_ERROR_FAILURE;
}
mBrowserChild->SendNotifyIMECompositionUpdate(mContentCache,
aIMENotification);
return NS_OK;
}
nsresult PuppetWidget::NotifyIMEOfTextChange(
const IMENotification& aIMENotification) {
MOZ_ASSERT(aIMENotification.mMessage == NOTIFY_IME_OF_TEXT_CHANGE,
"Passed wrong notification");
if (!mBrowserChild) {
return NS_ERROR_FAILURE;
}
// While a plugin has focus, text change notification shouldn't be available.
if (NS_WARN_IF(mInputContext.mIMEState.mEnabled == IMEState::PLUGIN)) {
return NS_ERROR_FAILURE;
}
// FYI: text change notification is the first notification after
// a user operation changes the content. So, we need to modify
// the cache as far as possible here.
if (NS_WARN_IF(!mContentCache.CacheText(this, &aIMENotification))) {
return NS_ERROR_FAILURE;
}
// BrowserParent doesn't this this to cache. we don't send the notification
// if parent process doesn't request NOTIFY_TEXT_CHANGE.
if (mIMENotificationRequestsOfParent.WantTextChange()) {
mBrowserChild->SendNotifyIMETextChange(mContentCache, aIMENotification);
} else {
mBrowserChild->SendUpdateContentCache(mContentCache);
}
return NS_OK;
}
nsresult PuppetWidget::NotifyIMEOfSelectionChange(
const IMENotification& aIMENotification) {
MOZ_ASSERT(aIMENotification.mMessage == NOTIFY_IME_OF_SELECTION_CHANGE,
"Passed wrong notification");
if (!mBrowserChild) {
return NS_ERROR_FAILURE;
}
// While a plugin has focus, selection change notification shouldn't be
// available.
if (NS_WARN_IF(mInputContext.mIMEState.mEnabled == IMEState::PLUGIN)) {
return NS_ERROR_FAILURE;
}
// Note that selection change must be notified after text change if it occurs.
// Therefore, we don't need to query text content again here.
mContentCache.SetSelection(
this, aIMENotification.mSelectionChangeData.mOffset,
aIMENotification.mSelectionChangeData.Length(),
aIMENotification.mSelectionChangeData.mReversed,
aIMENotification.mSelectionChangeData.GetWritingMode());
mBrowserChild->SendNotifyIMESelection(mContentCache, aIMENotification);
return NS_OK;
}
nsresult PuppetWidget::NotifyIMEOfMouseButtonEvent(
const IMENotification& aIMENotification) {
if (!mBrowserChild) {
return NS_ERROR_FAILURE;
}
// While a plugin has focus, mouse button event notification shouldn't be
// available.
if (NS_WARN_IF(mInputContext.mIMEState.mEnabled == IMEState::PLUGIN)) {
return NS_ERROR_FAILURE;
}
bool consumedByIME = false;
if (!mBrowserChild->SendNotifyIMEMouseButtonEvent(aIMENotification,
&consumedByIME)) {
return NS_ERROR_FAILURE;
}
return consumedByIME ? NS_SUCCESS_EVENT_CONSUMED : NS_OK;
}
nsresult PuppetWidget::NotifyIMEOfPositionChange(
const IMENotification& aIMENotification) {
if (NS_WARN_IF(!mBrowserChild)) {
return NS_ERROR_FAILURE;
}
if (NS_WARN_IF(!mContentCache.CacheEditorRect(this, &aIMENotification))) {
return NS_ERROR_FAILURE;
}
// While a plugin has focus, selection range isn't available. So, we don't
// need to cache it at that time.
if (mInputContext.mIMEState.mEnabled != IMEState::PLUGIN &&
NS_WARN_IF(!mContentCache.CacheSelection(this, &aIMENotification))) {
return NS_ERROR_FAILURE;
}
if (mIMENotificationRequestsOfParent.WantPositionChanged()) {
mBrowserChild->SendNotifyIMEPositionChange(mContentCache, aIMENotification);
} else {
mBrowserChild->SendUpdateContentCache(mContentCache);
}
return NS_OK;
}
struct CursorSurface {
UniquePtr<char[]> mData;
IntSize mSize;
};
void PuppetWidget::SetCursor(nsCursor aCursor, imgIContainer* aCursorImage,
uint32_t aHotspotX, uint32_t aHotspotY) {
if (!mBrowserChild) {
return;
}
// Don't cache on windows, Windowless flash breaks this via async cursor
// updates.
#if !defined(XP_WIN)
if (!mUpdateCursor && mCursor == aCursor && mCustomCursor == aCursorImage &&
(!aCursorImage ||
(mCursorHotspotX == aHotspotX && mCursorHotspotY == aHotspotY))) {
return;
}
#endif
bool hasCustomCursor = false;
UniquePtr<char[]> customCursorData;
size_t length = 0;
IntSize customCursorSize;
int32_t stride = 0;
auto format = SurfaceFormat::B8G8R8A8;
bool force = mUpdateCursor;
if (aCursorImage) {
RefPtr<SourceSurface> surface = aCursorImage->GetFrame(
imgIContainer::FRAME_CURRENT,
imgIContainer::FLAG_SYNC_DECODE | imgIContainer::FLAG_ASYNC_NOTIFY);
if (surface) {
if (RefPtr<DataSourceSurface> dataSurface = surface->GetDataSurface()) {
hasCustomCursor = true;
customCursorData = nsContentUtils::GetSurfaceData(
WrapNotNull(dataSurface), &length, &stride);
customCursorSize = dataSurface->GetSize();
format = dataSurface->GetFormat();
}
}
}
mCustomCursor = nullptr;
nsDependentCString cursorData(customCursorData ? customCursorData.get() : "",
length);
if (!mBrowserChild->SendSetCursor(aCursor, hasCustomCursor, cursorData,
customCursorSize.width,
customCursorSize.height, stride, format,
aHotspotX, aHotspotY, force)) {
return;
}
mCursor = aCursor;
mCustomCursor = aCursorImage;
mCursorHotspotX = aHotspotX;
mCursorHotspotY = aHotspotY;
mUpdateCursor = false;
}
void PuppetWidget::ClearCachedCursor() {
nsBaseWidget::ClearCachedCursor();
mCustomCursor = nullptr;
}
nsresult PuppetWidget::Paint() {
MOZ_ASSERT(!mDirtyRegion.IsEmpty(), "paint event logic messed up");
if (!GetCurrentWidgetListener()) return NS_OK;
LayoutDeviceIntRegion region = mDirtyRegion;
// reset repaint tracking
mDirtyRegion.SetEmpty();
mPaintTask.Revoke();
RefPtr<PuppetWidget> strongThis(this);
GetCurrentWidgetListener()->WillPaintWindow(this);
if (GetCurrentWidgetListener()) {
#ifdef DEBUG
debug_DumpPaintEvent(stderr, this, region.ToUnknownRegion(), "PuppetWidget",