widget/android/nsWindow.h

   1 /* -*- Mode: c++; c-basic-offset: 2; tab-width: 20; indent-tabs-mode: nil; -*-
   2  * vim: set sw=2 ts=4 expandtab:
   3  * This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef NSWINDOW_H_
   8 #define NSWINDOW_H_
   9
  10 #include "nsBaseWidget.h"
  11 #include "gfxPoint.h"
  12 #include "nsIUserIdleServiceInternal.h"
  13 #include "nsTArray.h"
  14 #include "EventDispatcher.h"
  15 #include "mozilla/EventForwards.h"
  16 #include "mozilla/java/GeckoSessionNatives.h"
  17 #include "mozilla/java/WebResponseWrappers.h"
  18 #include "mozilla/MozPromise.h"
  19 #include "mozilla/Mutex.h"
  20 #include "mozilla/StaticPtr.h"
  21 #include "mozilla/TextRange.h"
  22 #include "mozilla/UniquePtr.h"
  23
  24 struct ANPEvent;
  25
  26 namespace mozilla {
  27 class WidgetTouchEvent;
  28
  29 namespace layers {
  30 class CompositorBridgeChild;
  31 class LayerManager;
  32 class APZCTreeManager;
  33 class UiCompositorControllerChild;
  34 }  // namespace layers
  35
  36 namespace widget {
  37 class AndroidView;
  38 class GeckoEditableSupport;
  39 class GeckoViewSupport;
  40 class LayerViewSupport;
  41 class NPZCSupport;
  42 class PlatformCompositorWidgetDelegate;
  43 }  // namespace widget
  44
  45 namespace ipc {
  46 class Shmem;
  47 }  // namespace ipc
  48
  49 namespace a11y {
  50 class SessionAccessibility;
  51 }  // namespace a11y
  52 }  // namespace mozilla
  53
  54 class nsWindow final : public nsBaseWidget {
  55  private:
  56   virtual ~nsWindow();
  57
  58  public:
  59   using nsBaseWidget::GetWindowRenderer;
  60
  61   nsWindow();
  62
  63   NS_INLINE_DECL_REFCOUNTING_INHERITED(nsWindow, nsBaseWidget)
  64
  65   static void InitNatives();
  66   void OnGeckoViewReady();
  67   RefPtr<mozilla::MozPromise<bool, bool, false>> OnLoadRequest(
  68       nsIURI* aUri, int32_t aWindowType, int32_t aFlags,
  69       nsIPrincipal* aTriggeringPrincipal, bool aHasUserGesture,
  70       bool aIsTopLevel);
  71
  72   void OnUpdateSessionStore(mozilla::jni::Object::Param aBundle);
  73
  74  private:
  75   // Unique ID given to each widget, used to map Surfaces to widgets
  76   // in the CompositorSurfaceManager.
  77   int32_t mWidgetId;
  78
  79  private:
  80   RefPtr<mozilla::widget::AndroidView> mAndroidView;
  81
  82   // Object that implements native LayerView calls.
  83   // Owned by the Java Compositor instance.
  84   mozilla::jni::NativeWeakPtr<mozilla::widget::LayerViewSupport>
  85       mLayerViewSupport;
  86
  87   // Object that implements native NativePanZoomController calls.
  88   // Owned by the Java NativePanZoomController instance.
  89   mozilla::jni::NativeWeakPtr<mozilla::widget::NPZCSupport> mNPZCSupport;
  90
  91   // Object that implements native GeckoEditable calls.
  92   // Strong referenced by the Java instance.
  93   mozilla::jni::NativeWeakPtr<mozilla::widget::GeckoEditableSupport>
  94       mEditableSupport;
  95   mozilla::jni::Object::GlobalRef mEditableParent;
  96
  97   // Object that implements native SessionAccessibility calls.
  98   // Strong referenced by the Java instance.
  99   mozilla::jni::NativeWeakPtr<mozilla::a11y::SessionAccessibility>
 100       mSessionAccessibility;
 101
 102   // Object that implements native GeckoView calls and associated states.
 103   // nullptr for nsWindows that were not opened from GeckoView.
 104   mozilla::jni::NativeWeakPtr<mozilla::widget::GeckoViewSupport>
 105       mGeckoViewSupport;
 106
 107   mozilla::Atomic<bool, mozilla::ReleaseAcquire> mContentDocumentDisplayed;
 108
 109  public:
 110   static already_AddRefed<nsWindow> From(nsPIDOMWindowOuter* aDOMWindow);
 111   static already_AddRefed<nsWindow> From(nsIWidget* aWidget);
 112
 113   static nsWindow* TopWindow();
 114
 115   static mozilla::Modifiers GetModifiers(int32_t aMetaState);
 116   static mozilla::TimeStamp GetEventTimeStamp(int64_t aEventTime);
 117
 118   void InitEvent(mozilla::WidgetGUIEvent& event,
 119                  LayoutDeviceIntPoint* aPoint = 0);
 120
 121   void UpdateOverscrollVelocity(const float aX, const float aY);
 122   void UpdateOverscrollOffset(const float aX, const float aY);
 123
 124   mozilla::widget::EventDispatcher* GetEventDispatcher() const;
 125
 126   void PassExternalResponse(mozilla::java::WebResponse::Param aResponse);
 127
 128   void ShowDynamicToolbar();
 129
 130   void DetachNatives();
 131
 132   mozilla::Mutex& GetDestroyMutex() { return mDestroyMutex; }
 133
 134   //
 135   // nsIWidget
 136   //
 137
 138   using nsBaseWidget::Create;  // for Create signature not overridden here
 139   [[nodiscard]] virtual nsresult Create(nsIWidget* aParent,
 140                                         nsNativeWidget aNativeParent,
 141                                         const LayoutDeviceIntRect& aRect,
 142                                         InitData* aInitData) override;
 143   virtual void Destroy() override;
 144   virtual void SetParent(nsIWidget* aNewParent) override;
 145   virtual nsIWidget* GetParent(void) override;
 146   virtual float GetDPI() override;
 147   virtual double GetDefaultScaleInternal() override;
 148   virtual void Show(bool aState) override;
 149   virtual bool IsVisible() const override;
 150   virtual void ConstrainPosition(DesktopIntPoint&) override;
 151   virtual void Move(double aX, double aY) override;
 152   virtual void Resize(double aWidth, double aHeight, bool aRepaint) override;
 153   virtual void Resize(double aX, double aY, double aWidth, double aHeight,
 154                       bool aRepaint) override;
 155   void SetZIndex(int32_t aZIndex) override;
 156   virtual nsSizeMode SizeMode() override { return mSizeMode; }
 157   virtual void SetSizeMode(nsSizeMode aMode) override;
 158   virtual void Enable(bool aState) override;
 159   virtual bool IsEnabled() const override;
 160   virtual void Invalidate(const LayoutDeviceIntRect& aRect) override;
 161   virtual void SetFocus(Raise, mozilla::dom::CallerType aCallerType) override;
 162   virtual LayoutDeviceIntRect GetScreenBounds() override;
 163   virtual LayoutDeviceIntPoint WidgetToScreenOffset() override;
 164   virtual nsresult DispatchEvent(mozilla::WidgetGUIEvent* aEvent,
 165                                  nsEventStatus& aStatus) override;
 166   nsEventStatus DispatchEvent(mozilla::WidgetGUIEvent* aEvent);
 167   virtual nsresult MakeFullScreen(bool aFullScreen) override;
 168   void SetCursor(const Cursor& aDefaultCursor) override;
 169   void* GetNativeData(uint32_t aDataType) override;
 170   virtual nsresult SetTitle(const nsAString& aTitle) override { return NS_OK; }
 171   [[nodiscard]] virtual nsresult GetAttention(int32_t aCycleCount) override {
 172     return NS_ERROR_NOT_IMPLEMENTED;
 173   }
 174
 175   TextEventDispatcherListener* GetNativeTextEventDispatcherListener() override;
 176   virtual void SetInputContext(const InputContext& aContext,
 177                                const InputContextAction& aAction) override;
 178   virtual InputContext GetInputContext() override;
 179
 180   WindowRenderer* GetWindowRenderer() override;
 181
 182   void NotifyCompositorSessionLost(
 183       mozilla::layers::CompositorSession* aSession) override;
 184
 185   virtual bool NeedsPaint() override;
 186
 187   virtual bool WidgetPaintsBackground() override;
 188
 189   virtual uint32_t GetMaxTouchPoints() const override;
 190
 191   void UpdateZoomConstraints(
 192       const uint32_t& aPresShellId, const ScrollableLayerGuid::ViewID& aViewId,
 193       const mozilla::Maybe<ZoomConstraints>& aConstraints) override;
 194
 195   nsresult SynthesizeNativeTouchPoint(uint32_t aPointerId,
 196                                       TouchPointerState aPointerState,
 197                                       LayoutDeviceIntPoint aPoint,
 198                                       double aPointerPressure,
 199                                       uint32_t aPointerOrientation,
 200                                       nsIObserver* aObserver) override;
 201   nsresult SynthesizeNativeMouseEvent(LayoutDeviceIntPoint aPoint,
 202                                       NativeMouseMessage aNativeMessage,
 203                                       mozilla::MouseButton aButton,
 204                                       nsIWidget::Modifiers aModifierFlags,
 205                                       nsIObserver* aObserver) override;
 206   nsresult SynthesizeNativeMouseMove(LayoutDeviceIntPoint aPoint,
 207                                      nsIObserver* aObserver) override;
 208
 209   void SetCompositorWidgetDelegate(CompositorWidgetDelegate* delegate) override;
 210
 211   virtual void GetCompositorWidgetInitData(
 212       mozilla::widget::CompositorWidgetInitData* aInitData) override;
 213
 214   mozilla::layers::CompositorBridgeChild* GetCompositorBridgeChild() const;
 215
 216   void SetContentDocumentDisplayed(bool aDisplayed);
 217   bool IsContentDocumentDisplayed();
 218
 219   // Call this function when the users activity is the direct cause of an
 220   // event (like a keypress or mouse click).
 221   void UserActivity();
 222
 223   mozilla::jni::Object::Ref& GetEditableParent() { return mEditableParent; }
 224
 225   RefPtr<mozilla::a11y::SessionAccessibility> GetSessionAccessibility();
 226
 227   void RecvToolbarAnimatorMessageFromCompositor(int32_t aMessage) override;
 228   void UpdateRootFrameMetrics(const ScreenPoint& aScrollOffset,
 229                               const CSSToScreenScale& aZoom) override;
 230   void RecvScreenPixels(mozilla::ipc::Shmem&& aMem, const ScreenIntSize& aSize,
 231                         bool aNeedsYFlip) override;
 232   void UpdateDynamicToolbarMaxHeight(mozilla::ScreenIntCoord aHeight) override;
 233   mozilla::ScreenIntCoord GetDynamicToolbarMaxHeight() const override {
 234     return mDynamicToolbarMaxHeight;
 235   }
 236
 237   void UpdateDynamicToolbarOffset(mozilla::ScreenIntCoord aOffset);
 238
 239   virtual mozilla::ScreenIntMargin GetSafeAreaInsets() const override;
 240   void UpdateSafeAreaInsets(const mozilla::ScreenIntMargin& aSafeAreaInsets);
 241
 242   mozilla::jni::NativeWeakPtr<mozilla::widget::NPZCSupport>
 243   GetNPZCSupportWeakPtr();
 244
 245  protected:
 246   void BringToFront();
 247   nsWindow* FindTopLevel();
 248   bool IsTopLevel();
 249
 250   void ConfigureAPZControllerThread() override;
 251   void DispatchHitTest(const mozilla::WidgetTouchEvent& aEvent);
 252
 253   already_AddRefed<GeckoContentController> CreateRootContentController()
 254       override;
 255
 256   bool mIsVisible;
 257   nsTArray<nsWindow*> mChildren;
 258   nsWindow* mParent;
 259
 260   nsCOMPtr<nsIUserIdleServiceInternal> mIdleService;
 261   mozilla::ScreenIntCoord mDynamicToolbarMaxHeight;
 262   mozilla::ScreenIntMargin mSafeAreaInsets;
 263
 264   nsSizeMode mSizeMode;
 265   bool mIsFullScreen;
 266
 267   bool UseExternalCompositingSurface() const override { return true; }
 268
 269   static void DumpWindows();
 270   static void DumpWindows(const nsTArray<nsWindow*>& wins, int indent = 0);
 271   static void LogWindow(nsWindow* win, int index, int indent);
 272
 273  private:
 274   void CreateLayerManager();
 275   void RedrawAll();
 276
 277   void OnSizeChanged(const mozilla::gfx::IntSize& aSize);
 278
 279   mozilla::layers::LayersId GetRootLayerId() const;
 280   RefPtr<mozilla::layers::UiCompositorControllerChild>
 281   GetUiCompositorControllerChild();
 282
 283   mozilla::widget::PlatformCompositorWidgetDelegate* mCompositorWidgetDelegate;
 284
 285   mozilla::Mutex mDestroyMutex;
 286
 287   friend class mozilla::widget::GeckoViewSupport;
 288   friend class mozilla::widget::LayerViewSupport;
 289   friend class mozilla::widget::NPZCSupport;
 290 };
 291
 292 #endif /* NSWINDOW_H_ */