Simplify hitTestResultAtPoint and nodesFromRect APIs
[WebKit-https.git] / Source / WebCore / page / TouchDisambiguation.cpp
1 /*
2  * Copyright (C) 2012 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #include "config.h"
32
33 #include "TouchDisambiguation.h"
34
35 #include "Document.h"
36 #include "Element.h"
37 #include "Frame.h"
38 #include "FrameView.h"
39 #include "HTMLNames.h"
40 #include "HitTestResult.h"
41 #include <algorithm>
42 #include <cmath>
43
44 using namespace std;
45
46 namespace WebCore {
47
48 static IntRect boundingBoxForEventNodes(Node* eventNode)
49 {
50     if (!eventNode->document()->view())
51         return IntRect();
52
53     IntRect result;
54     Node* node = eventNode;
55     while (node) {
56         // Skip the whole sub-tree if the node doesn't propagate events.
57         if (node != eventNode && node->willRespondToMouseClickEvents()) {
58             node = node->traverseNextSibling(eventNode);
59             continue;
60         }
61         result.unite(pixelSnappedIntRect(node->getRect()));
62         node = node->traverseNextNode(eventNode);
63     }
64     return eventNode->document()->view()->contentsToWindow(result);
65 }
66
67 static float scoreTouchTarget(IntPoint touchPoint, int padding, IntRect boundingBox)
68 {
69     if (boundingBox.isEmpty())
70         return 0;
71
72     float reciprocalPadding = 1.f / padding;
73     float score = 1;
74
75     IntSize distance = boundingBox.differenceToPoint(touchPoint);
76     score *= max((padding - abs(distance.width())) * reciprocalPadding, 0.f);
77     score *= max((padding - abs(distance.height())) * reciprocalPadding, 0.f);
78
79     return score;
80 }
81
82 struct TouchTargetData {
83     IntRect windowBoundingBox;
84     float score;
85 };
86
87 void findGoodTouchTargets(const IntRect& touchBox, Frame* mainFrame, float pageScaleFactor, Vector<IntRect>& goodTargets)
88 {
89     goodTargets.clear();
90
91     int touchPointPadding = ceil(max(touchBox.width(), touchBox.height()) * 0.5);
92     // FIXME: Rect-based hit test doesn't transform the touch point size.
93     //        We have to pre-apply page scale factor here.
94     int padding = ceil(touchPointPadding / pageScaleFactor);
95
96     IntPoint touchPoint = touchBox.center();
97     IntPoint contentsPoint = mainFrame->view()->windowToContents(touchPoint);
98
99     HitTestResult result = mainFrame->eventHandler()->hitTestResultAtPoint(contentsPoint, HitTestRequest::ReadOnly | HitTestRequest::Active, IntSize(padding, padding));
100     const ListHashSet<RefPtr<Node> >& hitResults = result.rectBasedTestResult();
101
102     HashMap<Node*, TouchTargetData> touchTargets;
103     float bestScore = 0;
104     for (ListHashSet<RefPtr<Node> >::const_iterator it = hitResults.begin(); it != hitResults.end(); ++it) {
105         for (Node* node = it->get(); node; node = node->parentNode()) {
106             if (node->isDocumentNode() || node->hasTagName(HTMLNames::htmlTag) || node->hasTagName(HTMLNames::bodyTag))
107                 break;
108             if (node->willRespondToMouseClickEvents()) {
109                 TouchTargetData& targetData = touchTargets.add(node, TouchTargetData()).iterator->second;
110                 targetData.windowBoundingBox = boundingBoxForEventNodes(node);
111                 targetData.score = scoreTouchTarget(touchPoint, touchPointPadding, targetData.windowBoundingBox);
112                 bestScore = max(bestScore, targetData.score);
113                 break;
114             }
115         }
116     }
117
118     for (HashMap<Node*, TouchTargetData>::iterator it = touchTargets.begin(); it != touchTargets.end(); ++it) {
119         // Currently the scoring function uses the overlap area with the fat point as the score.
120         // We ignore the candidates that has less than 1/2 overlap (we consider not really ambiguous enough) than the best candidate to avoid excessive popups.
121         if (it->second.score < bestScore * 0.5)
122             continue;
123         goodTargets.append(it->second.windowBoundingBox);
124     }
125 }
126
127 } // namespace WebCore