Source code

Revision control

Other Tools

/* -*- 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 "nsXULTooltipListener.h"
#include "nsXULElement.h"
#include "mozilla/dom/Document.h"
#include "nsGkAtoms.h"
#include "nsMenuPopupFrame.h"
#include "nsIDragService.h"
#include "nsIDragSession.h"
#ifdef MOZ_XUL
# include "nsITreeView.h"
#endif
#include "nsIScriptContext.h"
#include "nsPIDOMWindow.h"
#ifdef MOZ_XUL
# include "nsXULPopupManager.h"
#endif
#include "nsIPopupContainer.h"
#include "nsServiceManagerUtils.h"
#include "nsTreeColumns.h"
#include "nsContentUtils.h"
#include "mozilla/ErrorResult.h"
#include "mozilla/LookAndFeel.h"
#include "mozilla/Preferences.h"
#include "mozilla/PresShell.h"
#include "mozilla/ScopeExit.h"
#include "mozilla/dom/Element.h"
#include "mozilla/dom/Event.h" // for Event
#include "mozilla/dom/MouseEvent.h"
#include "mozilla/dom/TreeColumnBinding.h"
#include "mozilla/dom/XULTreeElementBinding.h"
#include "mozilla/TextEvents.h"
using namespace mozilla;
using namespace mozilla::dom;
nsXULTooltipListener* nsXULTooltipListener::sInstance = nullptr;
//////////////////////////////////////////////////////////////////////////
//// nsISupports
nsXULTooltipListener::nsXULTooltipListener()
: mMouseScreenX(0),
mMouseScreenY(0),
mTooltipShownOnce(false)
#ifdef MOZ_XUL
,
mIsSourceTree(false),
mNeedTitletip(false),
mLastTreeRow(-1)
#endif
{
// FIXME(emilio): This can be faster, this should use static prefs.
//
// register the callback so we get notified of updates
Preferences::RegisterCallback(ToolbarTipsPrefChanged,
"browser.chrome.toolbar_tips");
// Call the pref callback to initialize our state.
ToolbarTipsPrefChanged("browser.chrome.toolbar_tips", nullptr);
}
nsXULTooltipListener::~nsXULTooltipListener() {
MOZ_ASSERT(sInstance == this);
sInstance = nullptr;
HideTooltip();
// Unregister our pref observer
Preferences::UnregisterCallback(ToolbarTipsPrefChanged,
"browser.chrome.toolbar_tips");
}
NS_IMPL_ISUPPORTS(nsXULTooltipListener, nsIDOMEventListener)
void nsXULTooltipListener::MouseOut(Event* aEvent) {
// reset flag so that tooltip will display on the next MouseMove
mTooltipShownOnce = false;
// if the timer is running and no tooltip is shown, we
// have to cancel the timer here so that it doesn't
// show the tooltip if we move the mouse out of the window
nsCOMPtr<nsIContent> currentTooltip = do_QueryReferent(mCurrentTooltip);
if (mTooltipTimer && !currentTooltip) {
mTooltipTimer->Cancel();
mTooltipTimer = nullptr;
return;
}
#ifdef DEBUG_crap
if (mNeedTitletip) return;
#endif
#ifdef MOZ_XUL
// check to see if the mouse left the targetNode, and if so,
// hide the tooltip
if (currentTooltip) {
// which node did the mouse leave?
EventTarget* eventTarget = aEvent->GetComposedTarget();
nsCOMPtr<nsIContent> content = do_QueryInterface(eventTarget);
if (content && !content->GetContainingShadow()) {
eventTarget = aEvent->GetTarget();
}
nsCOMPtr<nsINode> targetNode = do_QueryInterface(eventTarget);
nsXULPopupManager* pm = nsXULPopupManager::GetInstance();
if (pm) {
nsCOMPtr<nsINode> tooltipNode =
pm->GetLastTriggerTooltipNode(currentTooltip->GetComposedDoc());
// If the target node is the current tooltip target node, the mouse
// left the node the tooltip appeared on, so close the tooltip. However,
// don't do this if the mouse moved onto the tooltip in case the
// tooltip appears positioned near the mouse.
nsCOMPtr<EventTarget> relatedTarget =
aEvent->AsMouseEvent()->GetRelatedTarget();
nsCOMPtr<nsIContent> relatedContent = do_QueryInterface(relatedTarget);
if (tooltipNode == targetNode && relatedContent != currentTooltip) {
HideTooltip();
// reset special tree tracking
if (mIsSourceTree) {
mLastTreeRow = -1;
mLastTreeCol = nullptr;
}
}
}
}
#endif
}
void nsXULTooltipListener::MouseMove(Event* aEvent) {
if (!sShowTooltips) return;
// stash the coordinates of the event so that we can still get back to it from
// within the timer callback. On win32, we'll get a MouseMove event even when
// a popup goes away -- even when the mouse doesn't change position! To get
// around this, we make sure the mouse has really moved before proceeding.
MouseEvent* mouseEvent = aEvent->AsMouseEvent();
if (!mouseEvent) {
return;
}
int32_t newMouseX = mouseEvent->ScreenX(CallerType::System);
int32_t newMouseY = mouseEvent->ScreenY(CallerType::System);
// filter out false win32 MouseMove event
if (mMouseScreenX == newMouseX && mMouseScreenY == newMouseY) return;
// filter out minor movements due to crappy optical mice and shaky hands
// to prevent tooltips from hiding prematurely.
nsCOMPtr<nsIContent> currentTooltip = do_QueryReferent(mCurrentTooltip);
if ((currentTooltip) &&
(abs(mMouseScreenX - newMouseX) <= kTooltipMouseMoveTolerance) &&
(abs(mMouseScreenY - newMouseY) <= kTooltipMouseMoveTolerance))
return;
mMouseScreenX = newMouseX;
mMouseScreenY = newMouseY;
nsCOMPtr<nsIContent> sourceContent =
do_QueryInterface(aEvent->GetCurrentTarget());
mSourceNode = do_GetWeakReference(sourceContent);
#ifdef MOZ_XUL
mIsSourceTree = sourceContent->IsXULElement(nsGkAtoms::treechildren);
if (mIsSourceTree) CheckTreeBodyMove(mouseEvent);
#endif
// as the mouse moves, we want to make sure we reset the timer to show it,
// so that the delay is from when the mouse stops moving, not when it enters
// the node.
KillTooltipTimer();
// If the mouse moves while the tooltip is up, hide it. If nothing is
// showing and the tooltip hasn't been displayed since the mouse entered
// the node, then start the timer to show the tooltip.
if (!currentTooltip && !mTooltipShownOnce) {
nsCOMPtr<EventTarget> eventTarget = aEvent->GetComposedTarget();
nsCOMPtr<nsIContent> content = do_QueryInterface(eventTarget);
if (content && !content->GetContainingShadow()) {
eventTarget = aEvent->GetTarget();
}
// don't show tooltips attached to elements outside of a menu popup
// when hovering over an element inside it. The popupsinherittooltip
// attribute may be used to disable this behaviour, which is useful for
// large menu hierarchies such as bookmarks.
if (!sourceContent->IsElement() ||
!sourceContent->AsElement()->AttrValueIs(
kNameSpaceID_None, nsGkAtoms::popupsinherittooltip,
nsGkAtoms::_true, eCaseMatters)) {
nsCOMPtr<nsIContent> targetContent = do_QueryInterface(eventTarget);
while (targetContent && targetContent != sourceContent) {
if (targetContent->IsAnyOfXULElements(
nsGkAtoms::menupopup, nsGkAtoms::panel, nsGkAtoms::tooltip)) {
mSourceNode = nullptr;
return;
}
targetContent = targetContent->GetParent();
}
}
mTargetNode = do_GetWeakReference(eventTarget);
if (mTargetNode) {
nsresult rv = NS_NewTimerWithFuncCallback(
getter_AddRefs(mTooltipTimer), sTooltipCallback, this,
LookAndFeel::GetInt(LookAndFeel::IntID::TooltipDelay, 500),
nsITimer::TYPE_ONE_SHOT, "sTooltipCallback",
sourceContent->OwnerDoc()->EventTargetFor(TaskCategory::Other));
if (NS_FAILED(rv)) {
mTargetNode = nullptr;
mSourceNode = nullptr;
}
}
return;
}
#ifdef MOZ_XUL
if (mIsSourceTree) return;
#endif
HideTooltip();
// set a flag so that the tooltip is only displayed once until the mouse
// leaves the node
mTooltipShownOnce = true;
}
NS_IMETHODIMP
nsXULTooltipListener::HandleEvent(Event* aEvent) {
nsAutoString type;
aEvent->GetType(type);
if (type.EqualsLiteral("wheel") || type.EqualsLiteral("mousedown") ||
type.EqualsLiteral("mouseup") || type.EqualsLiteral("dragstart")) {
HideTooltip();
return NS_OK;
}
if (type.EqualsLiteral("keydown")) {
// Hide the tooltip if a non-modifier key is pressed.
WidgetKeyboardEvent* keyEvent = aEvent->WidgetEventPtr()->AsKeyboardEvent();
if (!keyEvent->IsModifierKeyEvent()) {
HideTooltip();
}
return NS_OK;
}
if (type.EqualsLiteral("popuphiding")) {
DestroyTooltip();
return NS_OK;
}
// Note that mousemove, mouseover and mouseout might be
// fired even during dragging due to widget's bug.
nsCOMPtr<nsIDragService> dragService =
do_GetService("@mozilla.org/widget/dragservice;1");
NS_ENSURE_TRUE(dragService, NS_OK);
nsCOMPtr<nsIDragSession> dragSession;
dragService->GetCurrentSession(getter_AddRefs(dragSession));
if (dragSession) {
return NS_OK;
}
// Not dragging.
if (type.EqualsLiteral("mousemove")) {
MouseMove(aEvent);
return NS_OK;
}
if (type.EqualsLiteral("mouseout")) {
MouseOut(aEvent);
return NS_OK;
}
return NS_OK;
}
//////////////////////////////////////////////////////////////////////////
//// nsXULTooltipListener
// static
void nsXULTooltipListener::ToolbarTipsPrefChanged(const char* aPref,
void* aClosure) {
sShowTooltips =
Preferences::GetBool("browser.chrome.toolbar_tips", sShowTooltips);
}
//////////////////////////////////////////////////////////////////////////
//// nsXULTooltipListener
bool nsXULTooltipListener::sShowTooltips = false;
void nsXULTooltipListener::AddTooltipSupport(nsIContent* aNode) {
MOZ_ASSERT(aNode);
MOZ_ASSERT(this == sInstance);
aNode->AddSystemEventListener(u"mouseout"_ns, this, false, false);
aNode->AddSystemEventListener(u"mousemove"_ns, this, false, false);
aNode->AddSystemEventListener(u"mousedown"_ns, this, false, false);
aNode->AddSystemEventListener(u"mouseup"_ns, this, false, false);
aNode->AddSystemEventListener(u"dragstart"_ns, this, true, false);
}
void nsXULTooltipListener::RemoveTooltipSupport(nsIContent* aNode) {
MOZ_ASSERT(aNode);
MOZ_ASSERT(this == sInstance);
// The last reference to us can go after some of these calls.
RefPtr<nsXULTooltipListener> instance = this;
aNode->RemoveSystemEventListener(u"mouseout"_ns, this, false);
aNode->RemoveSystemEventListener(u"mousemove"_ns, this, false);
aNode->RemoveSystemEventListener(u"mousedown"_ns, this, false);
aNode->RemoveSystemEventListener(u"mouseup"_ns, this, false);
aNode->RemoveSystemEventListener(u"dragstart"_ns, this, true);
}
#ifdef MOZ_XUL
void nsXULTooltipListener::CheckTreeBodyMove(MouseEvent* aMouseEvent) {
nsCOMPtr<nsIContent> sourceNode = do_QueryReferent(mSourceNode);
if (!sourceNode) return;
// get the documentElement of the document the tree is in
Document* doc = sourceNode->GetComposedDoc();
RefPtr<XULTreeElement> tree = GetSourceTree();
Element* root = doc ? doc->GetRootElement() : nullptr;
if (root && root->GetPrimaryFrame() && tree) {
int32_t x = aMouseEvent->ScreenX(CallerType::System);
int32_t y = aMouseEvent->ScreenY(CallerType::System);
// subtract off the documentElement's position
CSSIntRect rect = root->GetPrimaryFrame()->GetScreenRect();
x -= rect.x;
y -= rect.y;
ErrorResult rv;
TreeCellInfo cellInfo;
tree->GetCellAt(x, y, cellInfo, rv);
int32_t row = cellInfo.mRow;
RefPtr<nsTreeColumn> col = cellInfo.mCol;
// determine if we are going to need a titletip
// XXX check the disabletitletips attribute on the tree content
mNeedTitletip = false;
if (row >= 0 && cellInfo.mChildElt.EqualsLiteral("text")) {
mNeedTitletip = tree->IsCellCropped(row, col, rv);
}
nsCOMPtr<nsIContent> currentTooltip = do_QueryReferent(mCurrentTooltip);
if (currentTooltip && (row != mLastTreeRow || col != mLastTreeCol)) {
HideTooltip();
}
mLastTreeRow = row;
mLastTreeCol = col;
}
}
#endif
nsresult nsXULTooltipListener::ShowTooltip() {
nsCOMPtr<nsIContent> sourceNode = do_QueryReferent(mSourceNode);
// get the tooltip content designated for the target node
nsCOMPtr<nsIContent> tooltipNode;
GetTooltipFor(sourceNode, getter_AddRefs(tooltipNode));
if (!tooltipNode || sourceNode == tooltipNode)
return NS_ERROR_FAILURE; // the target node doesn't need a tooltip
// set the node in the document that triggered the tooltip and show it
if (tooltipNode->GetComposedDoc() &&
nsContentUtils::IsChromeDoc(tooltipNode->GetComposedDoc())) {
// Make sure the target node is still attached to some document.
// It might have been deleted.
if (sourceNode->IsInComposedDoc()) {
#ifdef MOZ_XUL
if (!mIsSourceTree) {
mLastTreeRow = -1;
mLastTreeCol = nullptr;
}
#endif
mCurrentTooltip = do_GetWeakReference(tooltipNode);
LaunchTooltip();
mTargetNode = nullptr;
nsCOMPtr<nsIContent> currentTooltip = do_QueryReferent(mCurrentTooltip);
if (!currentTooltip) return NS_OK;
// listen for popuphidden on the tooltip node, so that we can
// be sure DestroyPopup is called even if someone else closes the tooltip
currentTooltip->AddSystemEventListener(u"popuphiding"_ns, this, false,
false);
// listen for mousedown, mouseup, keydown, and mouse events at
// document level
Document* doc = sourceNode->GetComposedDoc();
if (doc) {
// Probably, we should listen to untrusted events for hiding tooltips
// on content since tooltips might disturb something of web
// applications. If we don't specify the aWantsUntrusted of
// AddSystemEventListener(), the event target sets it to TRUE if the
// target is in content.
doc->AddSystemEventListener(u"wheel"_ns, this, true);
doc->AddSystemEventListener(u"mousedown"_ns, this, true);
doc->AddSystemEventListener(u"mouseup"_ns, this, true);
#ifndef XP_WIN
// On Windows, key events don't close tooltips.
doc->AddSystemEventListener(u"keydown"_ns, this, true);
#endif
}
mSourceNode = nullptr;
}
}
return NS_OK;
}
#ifdef MOZ_XUL
static void SetTitletipLabel(XULTreeElement* aTree, Element* aTooltip,
int32_t aRow, nsTreeColumn* aCol) {
nsCOMPtr<nsITreeView> view = aTree->GetView();
if (view) {
nsAutoString label;
# ifdef DEBUG
nsresult rv =
# endif
view->GetCellText(aRow, aCol, label);
NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get the cell text!");
aTooltip->SetAttr(kNameSpaceID_None, nsGkAtoms::label, label, true);
}
}
#endif
void nsXULTooltipListener::LaunchTooltip() {
RefPtr<Element> currentTooltip = do_QueryReferent(mCurrentTooltip);
if (!currentTooltip) {
return;
}
#ifdef MOZ_XUL
if (mIsSourceTree && mNeedTitletip) {
RefPtr<XULTreeElement> tree = GetSourceTree();
SetTitletipLabel(tree, currentTooltip, mLastTreeRow, mLastTreeCol);
if (!(currentTooltip = do_QueryReferent(mCurrentTooltip))) {
// Because of mutation events, currentTooltip can be null.
return;
}
currentTooltip->SetAttr(kNameSpaceID_None, nsGkAtoms::titletip, u"true"_ns,
true);
} else {
currentTooltip->UnsetAttr(kNameSpaceID_None, nsGkAtoms::titletip, true);
}
if (!(currentTooltip = do_QueryReferent(mCurrentTooltip))) {
// Because of mutation events, currentTooltip can be null.
return;
}
nsXULPopupManager* pm = nsXULPopupManager::GetInstance();
if (!pm) {
return;
}
auto cleanup = MakeScopeExit([&] {
// Clear the current tooltip if the popup was not opened successfully.
if (!pm->IsPopupOpen(currentTooltip)) {
mCurrentTooltip = nullptr;
}
});
RefPtr<Element> target = do_QueryReferent(mTargetNode);
if (!target) {
return;
}
pm->ShowTooltipAtScreen(currentTooltip, target, mMouseScreenX, mMouseScreenY);
#endif
}
nsresult nsXULTooltipListener::HideTooltip() {
#ifdef MOZ_XUL
nsCOMPtr<nsIContent> currentTooltip = do_QueryReferent(mCurrentTooltip);
if (currentTooltip) {
nsXULPopupManager* pm = nsXULPopupManager::GetInstance();
if (pm) pm->HidePopup(currentTooltip, false, false, false, false);
}
#endif
DestroyTooltip();
return NS_OK;
}
static void GetImmediateChild(nsIContent* aContent, nsAtom* aTag,
nsIContent** aResult) {
*aResult = nullptr;
for (nsCOMPtr<nsIContent> childContent = aContent->GetFirstChild();
childContent; childContent = childContent->GetNextSibling()) {
if (childContent->IsXULElement(aTag)) {
childContent.forget(aResult);
return;
}
}
}
nsresult nsXULTooltipListener::FindTooltip(nsIContent* aTarget,
nsIContent** aTooltip) {
if (!aTarget) return NS_ERROR_NULL_POINTER;
// before we go on, make sure that target node still has a window
Document* document = aTarget->GetComposedDoc();
if (!document) {
NS_WARNING("Unable to retrieve the tooltip node document.");
return NS_ERROR_FAILURE;
}
nsPIDOMWindowOuter* window = document->GetWindow();
if (!window) {
return NS_OK;
}
if (window->Closed()) {
return NS_OK;
}
// non-XUL elements should just use the default tooltip
if (!aTarget->IsXULElement()) {
nsIPopupContainer* popupContainer =
nsIPopupContainer::GetPopupContainer(document->GetPresShell());
NS_ENSURE_STATE(popupContainer);
if (RefPtr<Element> tooltip = popupContainer->GetDefaultTooltip()) {
tooltip.forget(aTooltip);
return NS_OK;
}
return NS_ERROR_FAILURE;
}
nsAutoString tooltipText;
if (aTarget->IsElement()) {
aTarget->AsElement()->GetAttr(kNameSpaceID_None, nsGkAtoms::tooltiptext,
tooltipText);
}
if (!tooltipText.IsEmpty()) {
// specifying tooltiptext means we will always use the default tooltip
nsIPopupContainer* popupContainer =
nsIPopupContainer::GetPopupContainer(document->GetPresShell());
NS_ENSURE_STATE(popupContainer);
if (RefPtr<Element> tooltip = popupContainer->GetDefaultTooltip()) {
tooltip->SetAttr(kNameSpaceID_None, nsGkAtoms::label, tooltipText, true);
tooltip.forget(aTooltip);
}
return NS_OK;
}
nsAutoString tooltipId;
if (aTarget->IsElement()) {
aTarget->AsElement()->GetAttr(kNameSpaceID_None, nsGkAtoms::tooltip,
tooltipId);
}
// if tooltip == _child, look for first <tooltip> child
if (tooltipId.EqualsLiteral("_child")) {
GetImmediateChild(aTarget, nsGkAtoms::tooltip, aTooltip);
return NS_OK;
}
if (!tooltipId.IsEmpty()) {
DocumentOrShadowRoot* documentOrShadowRoot =
aTarget->GetUncomposedDocOrConnectedShadowRoot();
// tooltip must be an id, use getElementById to find it
if (documentOrShadowRoot) {
nsCOMPtr<nsIContent> tooltipEl =
documentOrShadowRoot->GetElementById(tooltipId);
if (tooltipEl) {
#ifdef MOZ_XUL
mNeedTitletip = false;
#endif
tooltipEl.forget(aTooltip);
return NS_OK;
}
}
}
#ifdef MOZ_XUL
// titletips should just use the default tooltip
if (mIsSourceTree && mNeedTitletip) {
nsIPopupContainer* popupContainer =
nsIPopupContainer::GetPopupContainer(document->GetPresShell());
NS_ENSURE_STATE(popupContainer);
NS_IF_ADDREF(*aTooltip = popupContainer->GetDefaultTooltip());
}
#endif
return NS_OK;
}
nsresult nsXULTooltipListener::GetTooltipFor(nsIContent* aTarget,
nsIContent** aTooltip) {
*aTooltip = nullptr;
nsCOMPtr<nsIContent> tooltip;
nsresult rv = FindTooltip(aTarget, getter_AddRefs(tooltip));
if (NS_FAILED(rv) || !tooltip) {
return rv;
}
#ifdef MOZ_XUL
// Submenus can't be used as tooltips, see bug 288763.
nsIContent* parent = tooltip->GetParent();
if (parent) {
nsMenuFrame* menu = do_QueryFrame(parent->GetPrimaryFrame());
if (menu) {
NS_WARNING("Menu cannot be used as a tooltip");
return NS_ERROR_FAILURE;
}
}
#endif
tooltip.swap(*aTooltip);
return rv;
}
nsresult nsXULTooltipListener::DestroyTooltip() {
nsCOMPtr<nsIDOMEventListener> kungFuDeathGrip(this);
nsCOMPtr<nsIContent> currentTooltip = do_QueryReferent(mCurrentTooltip);
if (currentTooltip) {
// release tooltip before removing listener to prevent our destructor from
// being called recursively (bug 120863)
mCurrentTooltip = nullptr;
// clear out the tooltip node on the document
nsCOMPtr<Document> doc = currentTooltip->GetComposedDoc();
if (doc) {
// remove the mousedown and keydown listener from document
doc->RemoveSystemEventListener(u"wheel"_ns, this, true);
doc->RemoveSystemEventListener(u"mousedown"_ns, this, true);
doc->RemoveSystemEventListener(u"mouseup"_ns, this, true);
#ifndef XP_WIN
doc->RemoveSystemEventListener(u"keydown"_ns, this, true);
#endif
}
// remove the popuphidden listener from tooltip
currentTooltip->RemoveSystemEventListener(u"popuphiding"_ns, this, false);
}
// kill any ongoing timers
KillTooltipTimer();
mSourceNode = nullptr;
#ifdef MOZ_XUL
mLastTreeCol = nullptr;
#endif
return NS_OK;
}
void nsXULTooltipListener::KillTooltipTimer() {
if (mTooltipTimer) {
mTooltipTimer->Cancel();
mTooltipTimer = nullptr;
mTargetNode = nullptr;
}
}
void nsXULTooltipListener::sTooltipCallback(nsITimer* aTimer, void* aListener) {
RefPtr<nsXULTooltipListener> instance = sInstance;
if (instance) instance->ShowTooltip();
}
#ifdef MOZ_XUL
XULTreeElement* nsXULTooltipListener::GetSourceTree() {
nsCOMPtr<nsIContent> sourceNode = do_QueryReferent(mSourceNode);
if (mIsSourceTree && sourceNode) {
RefPtr<XULTreeElement> xulEl =
XULTreeElement::FromNodeOrNull(sourceNode->GetParent());
return xulEl;
}
return nullptr;
}
#endif