widget/PuppetWidget.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  * vim: sw=2 ts=8 et :
   3  */
   4 /* This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   7
   8 /**
   9  * This "puppet widget" isn't really a platform widget.  It's intended
  10  * to be used in widgetless rendering contexts, such as sandboxed
  11  * content processes.  If any "real" widgetry is needed, the request
  12  * is forwarded to and/or data received from elsewhere.
  13  */
  14
  15 #ifndef mozilla_widget_PuppetWidget_h__
  16 #define mozilla_widget_PuppetWidget_h__
  17
  18 #include "mozilla/gfx/2D.h"
  19 #include "mozilla/RefPtr.h"
  20 #include "nsBaseScreen.h"
  21 #include "nsBaseWidget.h"
  22 #include "nsCOMArray.h"
  23 #include "nsIScreenManager.h"
  24 #include "nsThreadUtils.h"
  25 #include "mozilla/Attributes.h"
  26 #include "mozilla/ContentCache.h"
  27 #include "mozilla/EventForwards.h"
  28 #include "mozilla/TextEventDispatcherListener.h"
  29 #include "mozilla/layers/MemoryPressureObserver.h"
  30
  31 namespace mozilla {
  32
  33 namespace dom {
  34 class BrowserChild;
  35 }  // namespace dom
  36
  37 namespace widget {
  38
  39 struct AutoCacheNativeKeyCommands;
  40
  41 class PuppetWidget : public nsBaseWidget,
  42                      public TextEventDispatcherListener,
  43                      public layers::MemoryPressureListener {
  44   typedef mozilla::CSSRect CSSRect;
  45   typedef mozilla::dom::BrowserChild BrowserChild;
  46   typedef mozilla::gfx::DrawTarget DrawTarget;
  47
  48   // Avoiding to make compiler confused between mozilla::widget and nsIWidget.
  49   typedef mozilla::widget::TextEventDispatcher TextEventDispatcher;
  50   typedef mozilla::widget::TextEventDispatcherListener
  51       TextEventDispatcherListener;
  52
  53   typedef nsBaseWidget Base;
  54
  55   // The width and height of the "widget" are clamped to this.
  56   static const size_t kMaxDimension;
  57
  58  public:
  59   explicit PuppetWidget(BrowserChild* aBrowserChild);
  60
  61  protected:
  62   virtual ~PuppetWidget();
  63
  64  public:
  65   NS_DECL_ISUPPORTS_INHERITED
  66
  67   // PuppetWidget creation is infallible, hence InfallibleCreate(), which
  68   // Create() calls.
  69   using nsBaseWidget::Create;  // for Create signature not overridden here
  70   virtual nsresult Create(nsIWidget* aParent, nsNativeWidget aNativeParent,
  71                           const LayoutDeviceIntRect& aRect,
  72                           nsWidgetInitData* aInitData = nullptr) override;
  73   void InfallibleCreate(nsIWidget* aParent, nsNativeWidget aNativeParent,
  74                         const LayoutDeviceIntRect& aRect,
  75                         nsWidgetInitData* aInitData = nullptr);
  76
  77   void InitIMEState();
  78
  79   virtual already_AddRefed<nsIWidget> CreateChild(
  80       const LayoutDeviceIntRect& aRect, nsWidgetInitData* aInitData = nullptr,
  81       bool aForceUseIWidgetParent = false) override;
  82
  83   virtual void Destroy() override;
  84
  85   virtual void Show(bool aState) override;
  86
  87   virtual bool IsVisible() const override { return mVisible; }
  88
  89   virtual void ConstrainPosition(bool /*ignored aAllowSlop*/, int32_t* aX,
  90                                  int32_t* aY) override {
  91     *aX = kMaxDimension;
  92     *aY = kMaxDimension;
  93   }
  94
  95   // Widget position is controlled by the parent process via BrowserChild.
  96   virtual void Move(double aX, double aY) override {}
  97
  98   virtual void Resize(double aWidth, double aHeight, bool aRepaint) override;
  99   virtual void Resize(double aX, double aY, double aWidth, double aHeight,
 100                       bool aRepaint) override {
 101     if (!mBounds.IsEqualXY(aX, aY)) {
 102       NotifyWindowMoved(aX, aY);
 103     }
 104     mBounds.MoveTo(aX, aY);
 105     return Resize(aWidth, aHeight, aRepaint);
 106   }
 107
 108   // XXX/cjones: copying gtk behavior here; unclear what disabling a
 109   // widget is supposed to entail
 110   virtual void Enable(bool aState) override { mEnabled = aState; }
 111   virtual bool IsEnabled() const override { return mEnabled; }
 112
 113   virtual void SetFocus(Raise, mozilla::dom::CallerType aCallerType) override;
 114
 115   virtual nsresult ConfigureChildren(
 116       const nsTArray<Configuration>& aConfigurations) override;
 117
 118   virtual void Invalidate(const LayoutDeviceIntRect& aRect) override;
 119
 120   // PuppetWidgets don't have native data, as they're purely nonnative.
 121   virtual void* GetNativeData(uint32_t aDataType) override;
 122 #if defined(XP_WIN)
 123   void SetNativeData(uint32_t aDataType, uintptr_t aVal) override;
 124 #endif
 125
 126   // PuppetWidgets don't have any concept of titles.
 127   virtual nsresult SetTitle(const nsAString& aTitle) override {
 128     return NS_ERROR_UNEXPECTED;
 129   }
 130
 131   virtual mozilla::LayoutDeviceToLayoutDeviceMatrix4x4
 132   WidgetToTopLevelWidgetTransform() override;
 133
 134   virtual LayoutDeviceIntPoint WidgetToScreenOffset() override;
 135
 136   virtual LayoutDeviceIntPoint TopLevelWidgetToScreenOffset() override {
 137     return GetWindowPosition();
 138   }
 139
 140   int32_t RoundsWidgetCoordinatesTo() override;
 141
 142   void InitEvent(WidgetGUIEvent& aEvent,
 143                  LayoutDeviceIntPoint* aPoint = nullptr);
 144
 145   virtual nsresult DispatchEvent(WidgetGUIEvent* aEvent,
 146                                  nsEventStatus& aStatus) override;
 147   nsEventStatus DispatchInputEvent(WidgetInputEvent* aEvent) override;
 148   void SetConfirmedTargetAPZC(
 149       uint64_t aInputBlockId,
 150       const nsTArray<ScrollableLayerGuid>& aTargets) const override;
 151   void UpdateZoomConstraints(
 152       const uint32_t& aPresShellId, const ScrollableLayerGuid::ViewID& aViewId,
 153       const mozilla::Maybe<ZoomConstraints>& aConstraints) override;
 154   bool AsyncPanZoomEnabled() const override;
 155
 156   MOZ_CAN_RUN_SCRIPT virtual bool GetEditCommands(
 157       NativeKeyBindingsType aType, const mozilla::WidgetKeyboardEvent& aEvent,
 158       nsTArray<mozilla::CommandInt>& aCommands) override;
 159
 160   friend struct AutoCacheNativeKeyCommands;
 161
 162   //
 163   // nsBaseWidget methods we override
 164   //
 165
 166   // Documents loaded in child processes are always subdocuments of
 167   // other docs in an ancestor process.  To ensure that the
 168   // backgrounds of those documents are painted like those of
 169   // same-process subdocuments, we force the widget here to be
 170   // transparent, which in turn will cause layout to use a transparent
 171   // backstop background color.
 172   virtual nsTransparencyMode GetTransparencyMode() override {
 173     return eTransparencyTransparent;
 174   }
 175
 176   virtual LayerManager* GetLayerManager(
 177       PLayerTransactionChild* aShadowManager = nullptr,
 178       LayersBackend aBackendHint = mozilla::layers::LayersBackend::LAYERS_NONE,
 179       LayerManagerPersistence aPersistence = LAYER_MANAGER_CURRENT) override;
 180
 181   // This is used for creating remote layer managers and for re-creating
 182   // them after a compositor reset. The lambda aInitializeFunc is used to
 183   // perform any caller-required initialization for the newly created layer
 184   // manager; in the event of a failure, return false and it will destroy the
 185   // new layer manager without changing the state of the widget.
 186   bool CreateRemoteLayerManager(
 187       const std::function<bool(LayerManager*)>& aInitializeFunc);
 188
 189   bool HasLayerManager() { return !!mLayerManager; }
 190
 191   virtual void SetInputContext(const InputContext& aContext,
 192                                const InputContextAction& aAction) override;
 193   virtual InputContext GetInputContext() override;
 194   virtual NativeIMEContext GetNativeIMEContext() override;
 195   TextEventDispatcherListener* GetNativeTextEventDispatcherListener() override {
 196     return mNativeTextEventDispatcherListener
 197                ? mNativeTextEventDispatcherListener.get()
 198                : this;
 199   }
 200   void SetNativeTextEventDispatcherListener(
 201       TextEventDispatcherListener* aListener) {
 202     mNativeTextEventDispatcherListener = aListener;
 203   }
 204
 205   virtual void SetCursor(nsCursor aDefaultCursor, imgIContainer* aCustomCursor,
 206                          uint32_t aHotspotX, uint32_t aHotspotY) override;
 207
 208   virtual void ClearCachedCursor() override;
 209
 210   // Gets the DPI of the screen corresponding to this widget.
 211   // Contacts the parent process which gets the DPI from the
 212   // proper widget there. TODO: Handle DPI changes that happen
 213   // later on.
 214   virtual float GetDPI() override;
 215   virtual double GetDefaultScaleInternal() override;
 216
 217   virtual bool NeedsPaint() override;
 218
 219   // Paint the widget immediately if any paints are queued up.
 220   void PaintNowIfNeeded();
 221
 222   virtual BrowserChild* GetOwningBrowserChild() override {
 223     return mBrowserChild;
 224   }
 225
 226   void UpdateBackingScaleCache(float aDpi, int32_t aRounding, double aScale) {
 227     mDPI = aDpi;
 228     mRounding = aRounding;
 229     mDefaultScale = aScale;
 230   }
 231
 232   nsIntSize GetScreenDimensions();
 233
 234   // safe area insets support
 235   virtual ScreenIntMargin GetSafeAreaInsets() const override;
 236   void UpdateSafeAreaInsets(const ScreenIntMargin& aSafeAreaInsets);
 237
 238   // Get the offset to the chrome of the window that this tab belongs to.
 239   //
 240   // NOTE: In OOP iframes this value is zero. You should use
 241   // WidgetToTopLevelWidgetTransform instead which is already including the
 242   // chrome offset.
 243   LayoutDeviceIntPoint GetChromeOffset();
 244
 245   // Get the screen position of the application window.
 246   LayoutDeviceIntPoint GetWindowPosition();
 247
 248   virtual LayoutDeviceIntRect GetScreenBounds() override;
 249
 250   virtual nsresult SynthesizeNativeKeyEvent(
 251       int32_t aNativeKeyboardLayout, int32_t aNativeKeyCode,
 252       uint32_t aModifierFlags, const nsAString& aCharacters,
 253       const nsAString& aUnmodifiedCharacters, nsIObserver* aObserver) override;
 254   virtual nsresult SynthesizeNativeMouseEvent(
 255       LayoutDeviceIntPoint aPoint, NativeMouseMessage aNativeMessage,
 256       MouseButton aButton, nsIWidget::Modifiers aModifierFlags,
 257       nsIObserver* aObserver) override;
 258   virtual nsresult SynthesizeNativeMouseMove(LayoutDeviceIntPoint aPoint,
 259                                              nsIObserver* aObserver) override;
 260   virtual nsresult SynthesizeNativeMouseScrollEvent(
 261       LayoutDeviceIntPoint aPoint, uint32_t aNativeMessage, double aDeltaX,
 262       double aDeltaY, double aDeltaZ, uint32_t aModifierFlags,
 263       uint32_t aAdditionalFlags, nsIObserver* aObserver) override;
 264   virtual nsresult SynthesizeNativeTouchPoint(uint32_t aPointerId,
 265                                               TouchPointerState aPointerState,
 266                                               LayoutDeviceIntPoint aPoint,
 267                                               double aPointerPressure,
 268                                               uint32_t aPointerOrientation,
 269                                               nsIObserver* aObserver) override;
 270   virtual nsresult SynthesizeNativeTouchPadPinch(
 271       TouchpadPinchPhase aEventPhase, float aScale, LayoutDeviceIntPoint aPoint,
 272       int32_t aModifierFlags) override;
 273   virtual nsresult SynthesizeNativeTouchTap(LayoutDeviceIntPoint aPoint,
 274                                             bool aLongTap,
 275                                             nsIObserver* aObserver) override;
 276   virtual nsresult ClearNativeTouchSequence(nsIObserver* aObserver) override;
 277   virtual uint32_t GetMaxTouchPoints() const override;
 278   virtual nsresult SynthesizeNativePenInput(
 279       uint32_t aPointerId, TouchPointerState aPointerState,
 280       LayoutDeviceIntPoint aPoint, double aPressure, uint32_t aRotation,
 281       int32_t aTiltX, int32_t aTiltY, nsIObserver* aObserver) override;
 282
 283   virtual nsresult SynthesizeNativeTouchpadDoubleTap(
 284       LayoutDeviceIntPoint aPoint, uint32_t aModifierFlags) override;
 285
 286   virtual void StartAsyncScrollbarDrag(
 287       const AsyncDragMetrics& aDragMetrics) override;
 288
 289   virtual void ZoomToRect(const uint32_t& aPresShellId,
 290                           const ScrollableLayerGuid::ViewID& aViewId,
 291                           const CSSRect& aRect,
 292                           const uint32_t& aFlags) override;
 293
 294   virtual bool HasPendingInputEvent() override;
 295
 296   virtual void LookUpDictionary(
 297       const nsAString& aText,
 298       const nsTArray<mozilla::FontRange>& aFontRangeArray,
 299       const bool aIsVertical, const LayoutDeviceIntPoint& aPoint) override;
 300
 301   nsresult SetSystemFont(const nsCString& aFontName) override;
 302   nsresult GetSystemFont(nsCString& aFontName) override;
 303
 304   // TextEventDispatcherListener
 305   using nsBaseWidget::NotifyIME;
 306   NS_IMETHOD NotifyIME(TextEventDispatcher* aTextEventDispatcher,
 307                        const IMENotification& aNotification) override;
 308   NS_IMETHOD_(IMENotificationRequests) GetIMENotificationRequests() override;
 309   NS_IMETHOD_(void)
 310   OnRemovedFrom(TextEventDispatcher* aTextEventDispatcher) override;
 311   NS_IMETHOD_(void)
 312   WillDispatchKeyboardEvent(TextEventDispatcher* aTextEventDispatcher,
 313                             WidgetKeyboardEvent& aKeyboardEvent,
 314                             uint32_t aIndexOfKeypress, void* aData) override;
 315
 316   virtual void OnMemoryPressure(layers::MemoryPressureReason aWhy) override;
 317
 318  private:
 319   void Paint();
 320
 321   void SetChild(PuppetWidget* aChild);
 322
 323   nsresult RequestIMEToCommitComposition(bool aCancel);
 324   nsresult NotifyIMEOfFocusChange(const IMENotification& aIMENotification);
 325   nsresult NotifyIMEOfSelectionChange(const IMENotification& aIMENotification);
 326   nsresult NotifyIMEOfCompositionUpdate(
 327       const IMENotification& aIMENotification);
 328   nsresult NotifyIMEOfTextChange(const IMENotification& aIMENotification);
 329   nsresult NotifyIMEOfMouseButtonEvent(const IMENotification& aIMENotification);
 330   nsresult NotifyIMEOfPositionChange(const IMENotification& aIMENotification);
 331
 332   bool CacheEditorRect();
 333   bool CacheCompositionRects(uint32_t& aStartOffset,
 334                              nsTArray<LayoutDeviceIntRect>& aRectArray,
 335                              uint32_t& aTargetCauseOffset);
 336   bool GetCaretRect(LayoutDeviceIntRect& aCaretRect, uint32_t aCaretOffset);
 337   uint32_t GetCaretOffset();
 338
 339   nsIWidgetListener* GetCurrentWidgetListener();
 340
 341   // When this widget caches input context and currently managed by
 342   // IMEStateManager, the cache is valid.
 343   bool HaveValidInputContextCache() const;
 344
 345   class WidgetPaintTask : public Runnable {
 346    public:
 347     NS_DECL_NSIRUNNABLE
 348     explicit WidgetPaintTask(PuppetWidget* widget)
 349         : Runnable("PuppetWidget::WidgetPaintTask"), mWidget(widget) {}
 350     void Revoke() { mWidget = nullptr; }
 351
 352    private:
 353     PuppetWidget* mWidget;
 354   };
 355
 356   nsRefreshDriver* GetTopLevelRefreshDriver() const;
 357
 358   // BrowserChild normally holds a strong reference to this PuppetWidget
 359   // or its root ancestor, but each PuppetWidget also needs a
 360   // reference back to BrowserChild (e.g. to delegate nsIWidget IME calls
 361   // to chrome) So we hold a weak reference to BrowserChild here.  Since
 362   // it's possible for BrowserChild to outlive the PuppetWidget, we clear
 363   // this weak reference in Destroy()
 364   BrowserChild* mBrowserChild;
 365   // The "widget" to which we delegate events if we don't have an
 366   // event handler.
 367   RefPtr<PuppetWidget> mChild;
 368   nsRevocableEventPtr<WidgetPaintTask> mWidgetPaintTask;
 369   RefPtr<layers::MemoryPressureObserver> mMemoryPressureObserver;
 370   // XXX/cjones: keeping this around until we teach LayerManager to do
 371   // retained-content-only transactions
 372   RefPtr<DrawTarget> mDrawTarget;
 373   // IME
 374   IMENotificationRequests mIMENotificationRequestsOfParent;
 375   InputContext mInputContext;
 376   // mNativeIMEContext is initialized when this dispatches every composition
 377   // event both from parent process's widget and TextEventDispatcher in same
 378   // process.  If it hasn't been started composition yet, this isn't necessary
 379   // for XP code since there is no TextComposition instance which is caused by
 380   // the PuppetWidget instance.
 381   NativeIMEContext mNativeIMEContext;
 382   ContentCacheInChild mContentCache;
 383
 384   // The DPI of the screen corresponding to this widget
 385   float mDPI;
 386   int32_t mRounding;
 387   double mDefaultScale;
 388
 389   nsCOMPtr<imgIContainer> mCustomCursor;
 390   uint32_t mCursorHotspotX, mCursorHotspotY;
 391
 392   ScreenIntMargin mSafeAreaInsets;
 393
 394   RefPtr<TextEventDispatcherListener> mNativeTextEventDispatcherListener;
 395
 396  protected:
 397   bool mEnabled;
 398   bool mVisible;
 399
 400  private:
 401   bool mNeedIMEStateInit;
 402   // When remote process requests to commit/cancel a composition, the
 403   // composition may have already been committed in the main process.  In such
 404   // case, this will receive remaining composition events for the old
 405   // composition even after requesting to commit/cancel the old composition
 406   // but the TextComposition for the old composition has already been
 407   // destroyed. So, until this meets new eCompositionStart, following
 408   // composition events should be ignored if this is set to true.
 409   bool mIgnoreCompositionEvents;
 410 };
 411
 412 class PuppetScreen : public nsBaseScreen {
 413  public:
 414   explicit PuppetScreen(void* nativeScreen);
 415   ~PuppetScreen();
 416
 417   NS_IMETHOD GetRect(int32_t* aLeft, int32_t* aTop, int32_t* aWidth,
 418                      int32_t* aHeight) override;
 419   NS_IMETHOD GetAvailRect(int32_t* aLeft, int32_t* aTop, int32_t* aWidth,
 420                           int32_t* aHeight) override;
 421   NS_IMETHOD GetPixelDepth(int32_t* aPixelDepth) override;
 422   NS_IMETHOD GetColorDepth(int32_t* aColorDepth) override;
 423 };
 424
 425 class PuppetScreenManager final : public nsIScreenManager {
 426   ~PuppetScreenManager();
 427
 428  public:
 429   PuppetScreenManager();
 430
 431   NS_DECL_ISUPPORTS
 432   NS_DECL_NSISCREENMANAGER
 433
 434  protected:
 435   nsCOMPtr<nsIScreen> mOneScreen;
 436 };
 437
 438 }  // namespace widget
 439 }  // namespace mozilla
 440
 441 #endif  // mozilla_widget_PuppetWidget_h__