DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Implementation

Mercurial (0c050b533d10)

VCS Links

Line Code
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
/* -*- Mode: c++; c-basic-offset: 2; tab-width: 20; indent-tabs-mode: nil; -*-
 * vim: set sw=2 ts=4 expandtab:
 * 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/. */

#ifndef NSWINDOW_H_
#define NSWINDOW_H_

#include "nsBaseWidget.h"
#include "gfxPoint.h"
#include "nsIIdleServiceInternal.h"
#include "nsTArray.h"
#include "EventDispatcher.h"
#include "GeneratedJNIWrappers.h"
#include "mozilla/EventForwards.h"
#include "mozilla/Mutex.h"
#include "mozilla/StaticPtr.h"
#include "mozilla/TextRange.h"
#include "mozilla/UniquePtr.h"

struct ANPEvent;

namespace mozilla {
class WidgetTouchEvent;

namespace layers {
class CompositorBridgeChild;
class LayerManager;
class APZCTreeManager;
class UiCompositorControllerChild;
}  // namespace layers

namespace widget {
class GeckoEditableSupport;
}  // namespace widget

namespace ipc {
class Shmem;
}  // namespace ipc

namespace a11y {
class SessionAccessibility;
}
}  // namespace mozilla

class nsWindow final : public nsBaseWidget {
 private:
  virtual ~nsWindow();

 public:
  using nsBaseWidget::GetLayerManager;

  nsWindow();

  NS_INLINE_DECL_REFCOUNTING_INHERITED(nsWindow, nsBaseWidget)

  static void InitNatives();
  void SetScreenId(uint32_t aScreenId) { mScreenId = aScreenId; }
  void OnGeckoViewReady();

 private:
  uint32_t mScreenId;

  // An Event subclass that guards against stale events.
  template <typename Lambda, bool IsStatic = Lambda::isStatic,
            typename InstanceType = typename Lambda::ThisArgType,
            class Impl = typename Lambda::TargetClass>
  class WindowEvent;

 public:
  // Smart pointer for holding a pointer back to the nsWindow inside a native
  // object class. The nsWindow pointer is automatically cleared when the
  // nsWindow is destroyed, and a WindowPtr<Impl>::Locked class is provided
  // for thread-safe access to the nsWindow pointer off of the Gecko thread.
  template <class Impl>
  class WindowPtr;

  // Smart pointer for holding a pointer to a native object class. The
  // pointer is automatically cleared when the object is destroyed.
  template <class Impl>
  class NativePtr final {
    friend WindowPtr<Impl>;
    friend nsWindow;

    static const char sName[];

    WindowPtr<Impl>* mPtr;
    Impl* mImpl;
    mozilla::Mutex mImplLock;

    NativePtr() : mPtr(nullptr), mImpl(nullptr), mImplLock(sName) {}
    ~NativePtr() { MOZ_ASSERT(!mPtr); }

   public:
    class Locked;

    operator Impl*() const {
      MOZ_ASSERT(NS_IsMainThread());
      return mImpl;
    }

    Impl* operator->() const { return operator Impl*(); }

    template <class Cls, typename... Args>
    void Attach(const mozilla::jni::LocalRef<Cls>& aInstance, nsWindow* aWindow,
                Args&&... aArgs);
    template <class Cls, typename T>
    void Detach(const mozilla::jni::Ref<Cls, T>& aInstance);
  };

  template <class Impl>
  class WindowPtr final {
    friend NativePtr<Impl>;

    NativePtr<Impl>* mPtr;
    nsWindow* mWindow;
    mozilla::Mutex mWindowLock;

   public:
    class Locked final : private mozilla::MutexAutoLock {
      nsWindow* const mWindow;

     public:
      explicit Locked(WindowPtr<Impl>& aPtr)
          : mozilla::MutexAutoLock(aPtr.mWindowLock), mWindow(aPtr.mWindow) {}

      operator nsWindow*() const { return mWindow; }
      nsWindow* operator->() const { return mWindow; }
    };

    WindowPtr(NativePtr<Impl>* aPtr, nsWindow* aWindow);

    ~WindowPtr() {
      MOZ_ASSERT(NS_IsMainThread());
      if (!mPtr) {
        return;
      }
      mPtr->mPtr = nullptr;
      mPtr->mImpl = nullptr;
    }

    operator nsWindow*() const {
      MOZ_ASSERT(NS_IsMainThread());
      return mWindow;
    }

    nsWindow* operator->() const { return operator nsWindow*(); }
  };

 private:
  class AndroidView final : public nsIAndroidView {
    virtual ~AndroidView() {}

   public:
    const RefPtr<mozilla::widget::EventDispatcher> mEventDispatcher{
        new mozilla::widget::EventDispatcher()};

    AndroidView() {}

    NS_DECL_ISUPPORTS
    NS_DECL_NSIANDROIDVIEW

    NS_FORWARD_NSIANDROIDEVENTDISPATCHER(mEventDispatcher->)

    mozilla::java::GeckoBundle::GlobalRef mInitData;
  };

  RefPtr<AndroidView> mAndroidView;

  class LayerViewSupport;
  // Object that implements native LayerView calls.
  // Owned by the Java LayerView instance.
  NativePtr<LayerViewSupport> mLayerViewSupport;

  class NPZCSupport;
  // Object that implements native NativePanZoomController calls.
  // Owned by the Java NativePanZoomController instance.
  NativePtr<NPZCSupport> mNPZCSupport;

  // Object that implements native GeckoEditable calls.
  // Strong referenced by the Java instance.
  NativePtr<mozilla::widget::GeckoEditableSupport> mEditableSupport;
  mozilla::jni::Object::GlobalRef mEditableParent;

  // Object that implements native SessionAccessibility calls.
  // Strong referenced by the Java instance.
  NativePtr<mozilla::a11y::SessionAccessibility> mSessionAccessibility;

  class GeckoViewSupport;
  // Object that implements native GeckoView calls and associated states.
  // nullptr for nsWindows that were not opened from GeckoView.
  // Because other objects get destroyed in the mGeckOViewSupport destructor,
  // keep it last in the list, so its destructor is called first.
  mozilla::UniquePtr<GeckoViewSupport> mGeckoViewSupport;

  mozilla::Atomic<bool, mozilla::ReleaseAcquire> mContentDocumentDisplayed;

 public:
  static already_AddRefed<nsWindow> From(nsPIDOMWindowOuter* aDOMWindow);
  static already_AddRefed<nsWindow> From(nsIWidget* aWidget);

  static nsWindow* TopWindow();

  static mozilla::Modifiers GetModifiers(int32_t aMetaState);
  static mozilla::TimeStamp GetEventTimeStamp(int64_t aEventTime);

  void OnSizeChanged(const mozilla::gfx::IntSize& aSize);

  void InitEvent(mozilla::WidgetGUIEvent& event,
                 LayoutDeviceIntPoint* aPoint = 0);

  void UpdateOverscrollVelocity(const float aX, const float aY);
  void UpdateOverscrollOffset(const float aX, const float aY);

  mozilla::widget::EventDispatcher* GetEventDispatcher() const {
    if (mAndroidView) {
      return mAndroidView->mEventDispatcher;
    }
    return nullptr;
  }

  void NotifyDisablingWebRender();

  //
  // nsIWidget
  //

  using nsBaseWidget::Create;  // for Create signature not overridden here
  virtual MOZ_MUST_USE nsresult Create(nsIWidget* aParent,
                                       nsNativeWidget aNativeParent,
                                       const LayoutDeviceIntRect& aRect,
                                       nsWidgetInitData* aInitData) override;
  virtual void Destroy() override;
  virtual nsresult ConfigureChildren(
      const nsTArray<nsIWidget::Configuration>&) override;
  virtual void SetParent(nsIWidget* aNewParent) override;
  virtual nsIWidget* GetParent(void) override;
  virtual float GetDPI() override;
  virtual double GetDefaultScaleInternal() override;
  virtual void Show(bool aState) override;
  virtual bool IsVisible() const override;
  virtual void ConstrainPosition(bool aAllowSlop, int32_t* aX,
                                 int32_t* aY) override;
  virtual void Move(double aX, double aY) override;
  virtual void Resize(double aWidth, double aHeight, bool aRepaint) override;
  virtual void Resize(double aX, double aY, double aWidth, double aHeight,
                      bool aRepaint) override;
  void SetZIndex(int32_t aZIndex) override;
  virtual void SetSizeMode(nsSizeMode aMode) override;
  virtual void Enable(bool aState) override;
  virtual bool IsEnabled() const override;
  virtual void Invalidate(const LayoutDeviceIntRect& aRect) override;
  virtual void SetFocus(Raise) override;
  virtual LayoutDeviceIntRect GetScreenBounds() override;
  virtual LayoutDeviceIntPoint WidgetToScreenOffset() override;
  virtual nsresult DispatchEvent(mozilla::WidgetGUIEvent* aEvent,
                                 nsEventStatus& aStatus) override;
  nsEventStatus DispatchEvent(mozilla::WidgetGUIEvent* aEvent);
  virtual already_AddRefed<nsIScreen> GetWidgetScreen() override;
  virtual nsresult MakeFullScreen(bool aFullScreen,
                                  nsIScreen* aTargetScreen = nullptr) override;
  void SetCursor(nsCursor aDefaultCursor, imgIContainer* aImageCursor,
                 uint32_t aHotspotX, uint32_t aHotspotY) override {}
  void* GetNativeData(uint32_t aDataType) override;
  void SetNativeData(uint32_t aDataType, uintptr_t aVal) override;
  virtual nsresult SetTitle(const nsAString& aTitle) override { return NS_OK; }
  virtual MOZ_MUST_USE nsresult GetAttention(int32_t aCycleCount) override {
    return NS_ERROR_NOT_IMPLEMENTED;
  }

  TextEventDispatcherListener* GetNativeTextEventDispatcherListener() override;
  virtual void SetInputContext(const InputContext& aContext,
                               const InputContextAction& aAction) override;
  virtual InputContext GetInputContext() override;

  LayerManager* GetLayerManager(
      PLayerTransactionChild* aShadowManager = nullptr,
      LayersBackend aBackendHint = mozilla::layers::LayersBackend::LAYERS_NONE,
      LayerManagerPersistence aPersistence = LAYER_MANAGER_CURRENT) override;

  virtual bool NeedsPaint() override;

  virtual bool WidgetPaintsBackground() override;

  virtual uint32_t GetMaxTouchPoints() const override;

  void UpdateZoomConstraints(
      const uint32_t& aPresShellId, const ScrollableLayerGuid::ViewID& aViewId,
      const mozilla::Maybe<ZoomConstraints>& aConstraints) override;

  nsresult SynthesizeNativeTouchPoint(uint32_t aPointerId,
                                      TouchPointerState aPointerState,
                                      LayoutDeviceIntPoint aPoint,
                                      double aPointerPressure,
                                      uint32_t aPointerOrientation,
                                      nsIObserver* aObserver) override;
  nsresult SynthesizeNativeMouseEvent(LayoutDeviceIntPoint aPoint,
                                      uint32_t aNativeMessage,
                                      uint32_t aModifierFlags,
                                      nsIObserver* aObserver) override;
  nsresult SynthesizeNativeMouseMove(LayoutDeviceIntPoint aPoint,
                                     nsIObserver* aObserver) override;

  mozilla::layers::CompositorBridgeChild* GetCompositorBridgeChild() const;

  void SetContentDocumentDisplayed(bool aDisplayed);
  bool IsContentDocumentDisplayed();

  // Call this function when the users activity is the direct cause of an
  // event (like a keypress or mouse click).
  void UserActivity();

  mozilla::jni::Object::Ref& GetEditableParent() { return mEditableParent; }

  mozilla::a11y::SessionAccessibility* GetSessionAccessibility() {
    return mSessionAccessibility;
  }

  void RecvToolbarAnimatorMessageFromCompositor(int32_t aMessage) override;
  void UpdateRootFrameMetrics(const ScreenPoint& aScrollOffset,
                              const CSSToScreenScale& aZoom) override;
  void RecvScreenPixels(mozilla::ipc::Shmem&& aMem,
                        const ScreenIntSize& aSize) override;

  nsresult SetPrefersReducedMotionOverrideForTest(bool aValue) override;
  nsresult ResetPrefersReducedMotionOverrideForTest() override;

 protected:
  void BringToFront();
  nsWindow* FindTopLevel();
  bool IsTopLevel();

  void ConfigureAPZControllerThread() override;
  void DispatchHitTest(const mozilla::WidgetTouchEvent& aEvent);

  already_AddRefed<GeckoContentController> CreateRootContentController()
      override;

  bool mIsVisible;
  nsTArray<nsWindow*> mChildren;
  nsWindow* mParent;

  double mStartDist;
  double mLastDist;

  nsCOMPtr<nsIIdleServiceInternal> mIdleService;

  bool mIsFullScreen;
  bool mIsDisablingWebRender;

  bool UseExternalCompositingSurface() const override { return true; }

  static void DumpWindows();
  static void DumpWindows(const nsTArray<nsWindow*>& wins, int indent = 0);
  static void LogWindow(nsWindow* win, int index, int indent);

 private:
  void CreateLayerManager();
  void RedrawAll();

  mozilla::layers::LayersId GetRootLayerId() const;
  RefPtr<mozilla::layers::UiCompositorControllerChild>
  GetUiCompositorControllerChild();
};

// Explicit template declarations to make clang be quiet.
template <>
const char nsWindow::NativePtr<nsWindow::LayerViewSupport>::sName[];
template <>
const char nsWindow::NativePtr<mozilla::widget::GeckoEditableSupport>::sName[];
template <>
const char nsWindow::NativePtr<mozilla::a11y::SessionAccessibility>::sName[];
template <>
const char nsWindow::NativePtr<nsWindow::NPZCSupport>::sName[];

template <class Impl>
nsWindow::WindowPtr<Impl>::WindowPtr(NativePtr<Impl>* aPtr, nsWindow* aWindow)
    : mPtr(aPtr), mWindow(aWindow), mWindowLock(NativePtr<Impl>::sName) {
  MOZ_ASSERT(NS_IsMainThread());
  if (mPtr) {
    mPtr->mPtr = this;
  }
}

#endif /* NSWINDOW_H_ */