content/browser/renderer_host/direct_manipulation_helper_win.h

// Copyright 2015 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_DIRECT_MANIPULATION_HELPER_WIN_H_
#define CONTENT_BROWSER_RENDERER_HOST_DIRECT_MANIPULATION_HELPER_WIN_H_

#include <windows.h>

#include <directmanipulation.h>
#include <wrl.h>

#include <memory>
#include <string>

#include "base/gtest_prod_util.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "content/browser/renderer_host/direct_manipulation_event_handler_win.h"
#include "content/common/content_export.h"
#include "ui/aura/window_tree_host.h"
#include "ui/compositor/compositor_animation_observer.h"
#include "ui/gfx/geometry/size.h"

namespace ui {
class Compositor;
class WindowEventTarget;
}  // namespace ui

namespace content {

class DirectManipulationBrowserTestBase;
class DirectManipulationUnitTest;

// Windows 10 provides a new API called Direct Manipulation which generates
// smooth scroll and scale factor via IDirectManipulationViewportEventHandler
// on precision touchpad.
// 1. The foreground window is checked to see if it is a Direct Manipulation
//    consumer.
// 2. Call SetContact in Direct Manipulation takes over the following scrolling
//    when DM_POINTERHITTEST.
// 3. OnViewportStatusChanged will be called when the gesture phase change.
//    OnContentUpdated will be called when the gesture update.
class CONTENT_EXPORT DirectManipulationHelper
    : public ui::CompositorAnimationObserver {
 public:
  // Creates and initializes an instance of this class if Direct Manipulation is
  // enabled on the platform. Returns nullptr if it disabled or failed on
  // initialization.
  static std::unique_ptr<DirectManipulationHelper> CreateInstance(HWND window);

  // Creates and initializes an instance for testing. The given `manager` should
  // implement IDirectManipulationManager::CreateViewport() and
  // IDirectManipulationManager::GetUpdateManager() to return test mocks.
  static std::unique_ptr<DirectManipulationHelper> CreateInstanceForTesting(
      Microsoft::WRL::ComPtr<IDirectManipulationManager> manager);

  DirectManipulationHelper(const DirectManipulationHelper&) = delete;
  DirectManipulationHelper& operator=(const DirectManipulationHelper&) = delete;

  ~DirectManipulationHelper() override;

  // Returns the compositor owned by the WindowTreeHost.
  ui::Compositor* compositor() const {
    return window_tree_host_ ? window_tree_host_->compositor() : nullptr;
  }

  // Returns the event target.
  ui::WindowEventTarget* event_target() const { return event_target_; }

  // Creates a DirectManipulationEventHandler for `event_target`, using the
  // compositor from `window_tree_host`. Replaces any existing event handler.
  void UpdateEventHandler(base::WeakPtr<aura::WindowTreeHost> window_tree_host,
                          ui::WindowEventTarget* event_target);

  // ui::CompositorAnimationObserver
  // CompositorAnimationObserver implements.
  // DirectManipulation needs to poll for new events every frame while finger
  // gesturing on touchpad.
  void OnAnimationStep(base::TimeTicks timestamp) override;
  void OnCompositingShuttingDown(ui::Compositor* notifying_compositor) override;

  // Updates viewport size. Call it when window bounds updated.
  void SetSizeInPixels(const gfx::Size& size_in_pixels);

  // Pass the pointer hit test to Direct Manipulation.
  void OnPointerHitTest(WPARAM w_param);

  // Register this as an AnimationObserver of ui::Compositor.
  void AddAnimationObserver();

  // Unregister this as an AnimationObserver of ui::Compositor.
  void RemoveAnimationObserver();

 private:
  friend class DirectManipulationBrowserTestBase;
  friend class DirectManipulationUnitTest;

  template <typename T>
  using ComPtr = Microsoft::WRL::ComPtr<T>;

  // Shared implementation of CreateInstance and CreateInstanceForTesting.
  // This function instantiates Direct Manipulation and creates a viewport for
  // `window_`. Returns nullptr on failure.
  static std::unique_ptr<DirectManipulationHelper> CreateInstanceImpl(
      ComPtr<IDirectManipulationManager> manager,
      HWND window);

  DirectManipulationHelper(
      ComPtr<IDirectManipulationManager> manager,
      ComPtr<IDirectManipulationUpdateManager> update_manager,
      ComPtr<IDirectManipulationViewport> viewport,
      HWND window);

  void SetDeviceScaleFactorForTesting(float factor);

  void Destroy();

  ComPtr<IDirectManipulationManager> manager_;
  ComPtr<IDirectManipulationUpdateManager> update_manager_;
  ComPtr<IDirectManipulationViewport> viewport_;
  HWND window_;

  // These are only set after UpdateEventHandler() is called, and may change
  // whenever `window_` is reparented.
  ComPtr<DirectManipulationEventHandler> event_handler_;
  base::WeakPtr<aura::WindowTreeHost> window_tree_host_;
  raw_ptr<ui::WindowEventTarget> event_target_ = nullptr;

  DWORD view_port_handler_cookie_ = 0;
  bool has_animation_observer_ = false;
  gfx::Size size_in_pixels_;

  base::WeakPtrFactory<DirectManipulationHelper> weak_factory_{this};
};

}  // namespace content

#endif  // CONTENT_BROWSER_RENDERER_HOST_DIRECT_MANIPULATION_HELPER_WIN_H_