1 files changed, 324 insertions, 0 deletions
diff --git a/gfx/layers/apz/util/ActiveElementManager.cpp b/gfx/layers/apz/util/ActiveElementManager.cpp
new file mode 100644
index 0000000000..f2d981e9f0
--- /dev/null
+++ b/gfx/layers/apz/util/ActiveElementManager.cpp
@@ -0,0 +1,324 @@
+/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim: set ts=8 sts=2 et sw=2 tw=80: */
+/* 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 "ActiveElementManager.h"
+#include "mozilla/EventStateManager.h"
+#include "mozilla/PresShell.h"
+#include "mozilla/StaticPrefs_ui.h"
+#include "mozilla/dom/Element.h"
+#include "mozilla/dom/Document.h"
+#include "nsITimer.h"
+
+static mozilla::LazyLogModule sApzAemLog("apz.activeelement");
+#define AEM_LOG(...) MOZ_LOG(sApzAemLog, LogLevel::Debug, (__VA_ARGS__))
+
+namespace mozilla {
+namespace layers {
+
+class DelayedClearElementActivation final : public nsITimerCallback,
+                                            public nsINamed {
+ private:
+  explicit DelayedClearElementActivation(nsCOMPtr<dom::Element>& aTarget,
+                                         const nsCOMPtr<nsITimer>& aTimer)
+      : mTarget(aTarget)
+        // Hold the reference count until we are called back.
+        ,
+        mTimer(aTimer),
+        mProcessedSingleTap(false) {}
+
+ public:
+  NS_DECL_ISUPPORTS
+
+  static RefPtr<DelayedClearElementActivation> Create(
+      nsCOMPtr<dom::Element>& aTarget);
+
+  NS_IMETHOD Notify(nsITimer*) override;
+
+  NS_IMETHOD GetName(nsACString& aName) override;
+
+  void MarkSingleTapProcessed();
+
+  bool ProcessedSingleTap() const { return mProcessedSingleTap; }
+
+  void StartTimer();
+
+  /**
+   * Clear the Event State Manager's global active content.
+   */
+  void ClearGlobalActiveContent();
+
+  void ClearTimer() {
+    if (mTimer) {
+      mTimer->Cancel();
+      mTimer = nullptr;
+    }
+  }
+
+ private:
+  ~DelayedClearElementActivation() = default;
+
+  nsCOMPtr<dom::Element> mTarget;
+  nsCOMPtr<nsITimer> mTimer;
+  bool mProcessedSingleTap;
+};
+
+static nsPresContext* GetPresContextFor(nsIContent* aContent) {
+  if (!aContent) {
+    return nullptr;
+  }
+  PresShell* presShell = aContent->OwnerDoc()->GetPresShell();
+  if (!presShell) {
+    return nullptr;
+  }
+  return presShell->GetPresContext();
+}
+
+RefPtr<DelayedClearElementActivation> DelayedClearElementActivation::Create(
+    nsCOMPtr<dom::Element>& aTarget) {
+  nsCOMPtr<nsITimer> timer = NS_NewTimer();
+  if (!timer) {
+    return nullptr;
+  }
+  RefPtr<DelayedClearElementActivation> event =
+      new DelayedClearElementActivation(aTarget, timer);
+  return event;
+}
+
+NS_IMETHODIMP DelayedClearElementActivation::Notify(nsITimer*) {
+  AEM_LOG("DelayedClearElementActivation notification ready=%d",
+          mProcessedSingleTap);
+  // If the single tap has been processed and the timer has expired,
+  // clear the active element state.
+  if (mProcessedSingleTap) {
+    AEM_LOG("DelayedClearElementActivation clearing active content\n");
+    ClearGlobalActiveContent();
+  }
+  mTimer = nullptr;
+  return NS_OK;
+}
+
+NS_IMETHODIMP DelayedClearElementActivation::GetName(nsACString& aName) {
+  aName.AssignLiteral("DelayedClearElementActivation");
+  return NS_OK;
+}
+
+void DelayedClearElementActivation::StartTimer() {
+  MOZ_ASSERT(mTimer);
+  // If the timer is null, active content state has already been cleared.
+  if (!mTimer) {
+    return;
+  }
+  nsresult rv = mTimer->InitWithCallback(
+      this, StaticPrefs::ui_touch_activation_duration_ms(),
+      nsITimer::TYPE_ONE_SHOT);
+  if (NS_FAILED(rv)) {
+    ClearTimer();
+  }
+}
+
+void DelayedClearElementActivation::MarkSingleTapProcessed() {
+  mProcessedSingleTap = true;
+  if (!mTimer) {
+    AEM_LOG("Clear activation immediate!");
+    ClearGlobalActiveContent();
+  }
+}
+
+void DelayedClearElementActivation::ClearGlobalActiveContent() {
+  if (nsPresContext* pc = GetPresContextFor(mTarget)) {
+    EventStateManager::ClearGlobalActiveContent(pc->EventStateManager());
+  }
+  mTarget = nullptr;
+}
+
+NS_IMPL_ISUPPORTS(DelayedClearElementActivation, nsITimerCallback, nsINamed)
+
+ActiveElementManager::ActiveElementManager()
+    : mCanBePan(false), mCanBePanSet(false), mSetActiveTask(nullptr) {}
+
+ActiveElementManager::~ActiveElementManager() = default;
+
+void ActiveElementManager::SetTargetElement(dom::EventTarget* aTarget) {
+  if (mTarget) {
+    // Multiple fingers on screen (since HandleTouchEnd clears mTarget).
+    AEM_LOG("Multiple fingers on-screen, clearing target element\n");
+    CancelTask();
+    ResetActive();
+    ResetTouchBlockState();
+    return;
+  }
+
+  mTarget = dom::Element::FromEventTargetOrNull(aTarget);
+  AEM_LOG("Setting target element to %p\n", mTarget.get());
+  TriggerElementActivation();
+}
+
+void ActiveElementManager::HandleTouchStart(bool aCanBePan) {
+  AEM_LOG("Touch start, aCanBePan: %d\n", aCanBePan);
+  if (mCanBePanSet) {
+    // Multiple fingers on screen (since HandleTouchEnd clears mCanBePanSet).
+    AEM_LOG("Multiple fingers on-screen, clearing touch block state\n");
+    CancelTask();
+    ResetActive();
+    ResetTouchBlockState();
+    return;
+  }
+
+  mCanBePan = aCanBePan;
+  mCanBePanSet = true;
+  TriggerElementActivation();
+}
+
+void ActiveElementManager::TriggerElementActivation() {
+  // Both HandleTouchStart() and SetTargetElement() call this. They can be
+  // called in either order. One will set mCanBePanSet, and the other, mTarget.
+  // We want to actually trigger the activation once both are set.
+  if (!(mTarget && mCanBePanSet)) {
+    return;
+  }
+
+  RefPtr<DelayedClearElementActivation> delayedEvent =
+      DelayedClearElementActivation::Create(mTarget);
+  if (mDelayedClearElementActivation) {
+    mDelayedClearElementActivation->ClearTimer();
+    mDelayedClearElementActivation->ClearGlobalActiveContent();
+  }
+  mDelayedClearElementActivation = delayedEvent;
+
+  // If the touch cannot be a pan, make mTarget :active right away.
+  // Otherwise, wait a bit to see if the user will pan or not.
+  if (!mCanBePan) {
+    SetActive(mTarget);
+
+    if (mDelayedClearElementActivation) {
+      mDelayedClearElementActivation->StartTimer();
+    }
+  } else {
+    CancelTask();  // this is only needed because of bug 1169802. Fixing that
+                   // bug properly should make this unnecessary.
+    MOZ_ASSERT(mSetActiveTask == nullptr);
+
+    RefPtr<CancelableRunnable> task =
+        NewCancelableRunnableMethod<nsCOMPtr<dom::Element>>(
+            "layers::ActiveElementManager::SetActiveTask", this,
+            &ActiveElementManager::SetActiveTask, mTarget);
+    mSetActiveTask = task;
+    NS_GetCurrentThread()->DelayedDispatch(
+        task.forget(), StaticPrefs::ui_touch_activation_delay_ms());
+    AEM_LOG("Scheduling mSetActiveTask %p\n", mSetActiveTask.get());
+  }
+}
+
+void ActiveElementManager::ClearActivation() {
+  AEM_LOG("Clearing element activation\n");
+  CancelTask();
+  ResetActive();
+}
+
+void ActiveElementManager::HandleTouchEndEvent(bool aWasClick) {
+  AEM_LOG("Touch end event, aWasClick: %d\n", aWasClick);
+
+  // If the touch was a click, make mTarget :active right away.
+  // nsEventStateManager will reset the active element when processing
+  // the mouse-down event generated by the click.
+  CancelTask();
+  if (aWasClick) {
+    // Scrollbar thumbs use a different mechanism for their active
+    // highlight (the "active" attribute), so don't set the active state
+    // on them because nothing will clear it.
+    if (!(mTarget && mTarget->IsXULElement(nsGkAtoms::thumb))) {
+      SetActive(mTarget);
+    }
+  } else {
+    // We might reach here if mCanBePan was false on touch-start and
+    // so we set the element active right away. Now it turns out the
+    // action was not a click so we need to reset the active element.
+    ResetActive();
+  }
+
+  ResetTouchBlockState();
+}
+
+void ActiveElementManager::HandleTouchEnd() {
+  AEM_LOG("Touch end, clearing pan state\n");
+  mCanBePanSet = false;
+}
+
+void ActiveElementManager::ProcessSingleTap() {
+  if (!mDelayedClearElementActivation) {
+    return;
+  }
+
+  mDelayedClearElementActivation->MarkSingleTapProcessed();
+
+  if (mCanBePan) {
+    // In the case that we have not started the delayed reset of the element
+    // activation state, start the timer now.
+    mDelayedClearElementActivation->StartTimer();
+  }
+
+  // We don't need to keep a reference to the element activation
+  // clearing, because the event and its timer keep each other alive
+  // until the timer expires
+  mDelayedClearElementActivation = nullptr;
+}
+
+void ActiveElementManager::Destroy() {
+  if (mDelayedClearElementActivation) {
+    mDelayedClearElementActivation->ClearTimer();
+    mDelayedClearElementActivation = nullptr;
+  }
+}
+
+void ActiveElementManager::SetActive(dom::Element* aTarget) {
+  AEM_LOG("Setting active %p\n", aTarget);
+
+  if (nsPresContext* pc = GetPresContextFor(aTarget)) {
+    pc->EventStateManager()->SetContentState(aTarget,
+                                             dom::ElementState::ACTIVE);
+  }
+}
+
+void ActiveElementManager::ResetActive() {
+  AEM_LOG("Resetting active from %p\n", mTarget.get());
+
+  // Clear the :active flag from mTarget by setting it on the document root.
+  if (mTarget) {
+    dom::Element* root = mTarget->OwnerDoc()->GetDocumentElement();
+    if (root) {
+      AEM_LOG("Found root %p, making active\n", root);
+      SetActive(root);
+    }
+  }
+}
+
+void ActiveElementManager::ResetTouchBlockState() {
+  mTarget = nullptr;
+  mCanBePanSet = false;
+}
+
+void ActiveElementManager::SetActiveTask(
+    const nsCOMPtr<dom::Element>& aTarget) {
+  AEM_LOG("mSetActiveTask %p running\n", mSetActiveTask.get());
+
+  // This gets called from mSetActiveTask's Run() method. The message loop
+  // deletes the task right after running it, so we need to null out
+  // mSetActiveTask to make sure we're not left with a dangling pointer.
+  mSetActiveTask = nullptr;
+  SetActive(aTarget);
+}
+
+void ActiveElementManager::CancelTask() {
+  AEM_LOG("Cancelling task %p\n", mSetActiveTask.get());
+
+  if (mSetActiveTask) {
+    mSetActiveTask->Cancel();
+    mSetActiveTask = nullptr;
+  }
+}
+
+}  // namespace layers
+}  // namespace mozilla