[BlackBerry] speed up text selection for large selections
[WebKit-https.git] / Source / WebKit / blackberry / WebKitSupport / SelectionHandler.cpp
1 /*
2  * Copyright (C) 2010, 2011, 2012 Research In Motion Limited. All rights reserved.
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
17  */
18
19 #include "config.h"
20 #include "SelectionHandler.h"
21
22 #include "DOMSupport.h"
23 #include "Document.h"
24 #include "Editor.h"
25 #include "EditorClient.h"
26 #include "FatFingers.h"
27 #include "Frame.h"
28 #include "FrameSelection.h"
29 #include "FrameView.h"
30 #include "HTMLAnchorElement.h"
31 #include "HTMLAreaElement.h"
32 #include "HitTestResult.h"
33 #include "InputHandler.h"
34 #include "IntRect.h"
35 #include "Page.h"
36 #include "RenderPart.h"
37 #include "TextGranularity.h"
38 #include "TouchEventHandler.h"
39 #include "WebPage.h"
40 #include "WebPageClient.h"
41 #include "WebPage_p.h"
42
43 #include "htmlediting.h"
44 #include "visible_units.h"
45
46 #include <BlackBerryPlatformKeyboardEvent.h>
47
48 #include <sys/keycodes.h>
49
50 #define SHOWDEBUG_SELECTIONHANDLER 0
51
52 using namespace BlackBerry::Platform;
53 using namespace WebCore;
54
55 #if SHOWDEBUG_SELECTIONHANDLER
56 #define DEBUG_SELECTION(severity, format, ...) logAlways(severity, format, ## __VA_ARGS__)
57 #else
58 #define DEBUG_SELECTION(severity, format, ...)
59 #endif // SHOWDEBUG_SELECTIONHANDLER
60
61 namespace BlackBerry {
62 namespace WebKit {
63
64 SelectionHandler::SelectionHandler(WebPagePrivate* page)
65     : m_webPage(page)
66     , m_selectionActive(false)
67     , m_caretActive(false)
68     , m_lastUpdatedEndPointIsValid(false)
69 {
70 }
71
72 SelectionHandler::~SelectionHandler()
73 {
74 }
75
76 void SelectionHandler::cancelSelection()
77 {
78     m_selectionActive = false;
79     m_lastSelectionRegion = IntRectRegion();
80
81     DEBUG_SELECTION(LogLevelInfo, "SelectionHandler::cancelSelection");
82
83     if (m_webPage->m_inputHandler->isInputMode())
84         m_webPage->m_inputHandler->cancelSelection();
85     else
86         m_webPage->focusedOrMainFrame()->selection()->clear();
87 }
88
89 WebString SelectionHandler::selectedText() const
90 {
91     return m_webPage->focusedOrMainFrame()->editor()->selectedText();
92 }
93
94 void SelectionHandler::getConsolidatedRegionOfTextQuadsForSelection(const VisibleSelection& selection, IntRectRegion& region) const
95 {
96     ASSERT(region.isEmpty());
97
98     if (!selection.isRange())
99         return;
100
101     ASSERT(selection.firstRange());
102
103     Vector<FloatQuad> quadList;
104     DOMSupport::visibleTextQuads(*(selection.firstRange()), quadList, true /* use selection height */);
105
106     if (!quadList.isEmpty()) {
107         FrameView* frameView = m_webPage->focusedOrMainFrame()->view();
108
109         // frameRect is in frame coordinates.
110         WebCore::IntRect frameRect(WebCore::IntPoint(0, 0), frameView->contentsSize());
111
112         // framePosition is in main frame coordinates.
113         WebCore::IntPoint framePosition = m_webPage->frameOffset(m_webPage->focusedOrMainFrame());
114
115         // Convert the text quads into a more platform friendy
116         // IntRectRegion and adjust for subframes.
117         std::vector<Platform::IntRect> adjustedIntRects;
118         Platform::IntRect selectionBoundingBox;
119         for (unsigned i = 0; i < quadList.size(); i++) {
120             WebCore::IntRect enclosingRect = quadList[i].enclosingBoundingBox();
121             enclosingRect.intersect(frameRect);
122             enclosingRect.move(framePosition.x(), framePosition.y());
123             adjustedIntRects.push_back(enclosingRect);
124             selectionBoundingBox = unionOfRects(enclosingRect, selectionBoundingBox);
125         }
126         region = IntRectRegion(selectionBoundingBox, adjustedIntRects.size(), adjustedIntRects);
127     }
128 }
129
130 static VisiblePosition visiblePositionForPointIgnoringClipping(const Frame& frame, const WebCore::IntPoint& framePoint)
131 {
132     // Frame::visiblePositionAtPoint hard-codes ignoreClipping=false in the
133     // call to hitTestResultAtPoint. This has a bug where some pages (such as
134     // metafilter) will return the wrong VisiblePosition for points that are
135     // outside the visible rect. To work around the bug, this is a copy of
136     // visiblePositionAtPoint which which passes ignoreClipping=true.
137     // See RIM Bug #4315.
138     HitTestResult result = frame.eventHandler()->hitTestResultAtPoint(framePoint, true /* allowShadowContent */, true /* ignoreClipping */);
139
140     Node* node = result.innerNode();
141     if (!node)
142         return VisiblePosition();
143
144     RenderObject* renderer = node->renderer();
145     if (!renderer)
146         return VisiblePosition();
147
148     VisiblePosition visiblePos = renderer->positionForPoint(result.localPoint());
149     if (visiblePos.isNull())
150         visiblePos = VisiblePosition(Position(createLegacyEditingPosition(node, 0)));
151
152     return visiblePos;
153 }
154
155 static unsigned short directionOfPointRelativeToRect(const WebCore::IntPoint& point, const WebCore::IntRect& rect, const bool useTopPadding = true, const bool useBottomPadding = true)
156 {
157     ASSERT(!rect.contains(point));
158
159     // Padding to prevent accidental trigger of up/down when intending to do horizontal movement.
160     const int verticalPadding = 5;
161
162     // Do height movement check first but add padding. We may be off on both x & y axis and only
163     // want to move in one direction at a time.
164     if (point.y() + (useTopPadding ? verticalPadding : 0) < rect.y())
165         return KEYCODE_UP;
166     if (point.y() > rect.maxY() + (useBottomPadding ? verticalPadding : 0))
167         return KEYCODE_DOWN;
168     if (point.x() < rect.location().x())
169         return KEYCODE_LEFT;
170     if (point.x() > rect.maxX())
171         return KEYCODE_RIGHT;
172
173     return 0;
174 }
175
176 bool SelectionHandler::shouldUpdateSelectionOrCaretForPoint(const WebCore::IntPoint& point, const WebCore::IntRect& caretRect, bool startCaret) const
177 {
178     ASSERT(m_webPage->m_inputHandler->isInputMode());
179
180     // If the point isn't valid don't block change as it is not actually changing.
181     if (point == DOMSupport::InvalidPoint)
182         return true;
183
184     VisibleSelection currentSelection = m_webPage->focusedOrMainFrame()->selection()->selection();
185
186     // If the input field is single line or we are on the first or last
187     // line of a multiline input field only horizontal movement is supported.
188     bool aboveCaret = point.y() < caretRect.y();
189     bool belowCaret = point.y() >= caretRect.maxY();
190
191     DEBUG_SELECTION(LogLevelInfo, "SelectionHandler::shouldUpdateSelectionOrCaretForPoint multiline = %s above = %s below = %s first line = %s last line = %s start = %s \n"
192             , m_webPage->m_inputHandler->isMultilineInputMode() ? "true" : "false", aboveCaret ? "true" : "false", belowCaret ? "true" : "false"
193             , inSameLine(currentSelection.visibleStart(), startOfEditableContent(currentSelection.visibleStart())) ? "true" : "false"
194             , inSameLine(currentSelection.visibleEnd(), endOfEditableContent(currentSelection.visibleEnd())) ? "true" : "false"
195             , startCaret ? "true" : "false");
196
197     if (!m_webPage->m_inputHandler->isMultilineInputMode() && (aboveCaret || belowCaret))
198         return false;
199     if (startCaret && inSameLine(currentSelection.visibleStart(), startOfEditableContent(currentSelection.visibleStart())) && aboveCaret)
200         return false;
201     if (!startCaret && inSameLine(currentSelection.visibleEnd(), endOfEditableContent(currentSelection.visibleEnd())) && belowCaret)
202         return false;
203
204     return true;
205 }
206
207 void SelectionHandler::setCaretPosition(const WebCore::IntPoint &position)
208 {
209     if (!m_webPage->m_inputHandler->isInputMode())
210         return;
211
212     m_caretActive = true;
213
214     DEBUG_SELECTION(LogLevelInfo, "SelectionHandler::setCaretPosition requested point %d, %d", position.x(), position.y());
215
216     Frame* focusedFrame = m_webPage->focusedOrMainFrame();
217     FrameSelection* controller = focusedFrame->selection();
218     WebCore::IntPoint relativePoint = DOMSupport::convertPointToFrame(m_webPage->mainFrame(), focusedFrame, position);
219     WebCore::IntRect currentCaretRect = controller->selection().visibleStart().absoluteCaretBounds();
220
221     if (relativePoint == DOMSupport::InvalidPoint || !shouldUpdateSelectionOrCaretForPoint(relativePoint, currentCaretRect)) {
222         selectionPositionChanged();
223         return;
224     }
225
226     VisiblePosition visibleCaretPosition(focusedFrame->visiblePositionForPoint(relativePoint));
227
228     if (!DOMSupport::isPositionInNode(m_webPage->focusedOrMainFrame()->document()->focusedNode(), visibleCaretPosition.deepEquivalent())) {
229         if (unsigned short character = directionOfPointRelativeToRect(relativePoint, currentCaretRect))
230             m_webPage->m_inputHandler->handleKeyboardInput(Platform::KeyboardEvent(character));
231
232         selectionPositionChanged();
233         return;
234     }
235
236     VisibleSelection newSelection(visibleCaretPosition);
237     if (controller->selection() == newSelection) {
238         selectionPositionChanged();
239         return;
240     }
241
242     controller->setSelection(newSelection);
243
244     DEBUG_SELECTION(LogLevelInfo, "SelectionHandler::setCaretPosition point valid, cursor updated");
245 }
246
247 // This function makes sure we are not reducing the selection to a caret selection.
248 static bool shouldExtendSelectionInDirection(const VisibleSelection& selection, unsigned short character)
249 {
250     FrameSelection tempSelection;
251     tempSelection.setSelection(selection);
252     switch (character) {
253     case KEYCODE_LEFT:
254         tempSelection.modify(FrameSelection::AlterationExtend, DirectionLeft, CharacterGranularity);
255         break;
256     case KEYCODE_RIGHT:
257         tempSelection.modify(FrameSelection::AlterationExtend, DirectionRight, CharacterGranularity);
258         break;
259     case KEYCODE_UP:
260         tempSelection.modify(FrameSelection::AlterationExtend, DirectionBackward, LineGranularity);
261         break;
262     case KEYCODE_DOWN:
263         tempSelection.modify(FrameSelection::AlterationExtend, DirectionForward, LineGranularity);
264         break;
265     default:
266         break;
267     }
268
269     if ((character == KEYCODE_LEFT || character == KEYCODE_RIGHT)
270         && (!inSameLine(selection.visibleStart(), tempSelection.selection().visibleStart())
271            || !inSameLine(selection.visibleEnd(), tempSelection.selection().visibleEnd())))
272         return false;
273
274     return tempSelection.selection().selectionType() == VisibleSelection::RangeSelection;
275 }
276
277 static int clamp(const int min, const int value, const int max)
278 {
279     return value < min ? min : std::min(value, max);
280 }
281
282 static VisiblePosition directionalVisiblePositionAtExtentOfBox(Frame* frame, const WebCore::IntRect& boundingBox, unsigned short direction, const WebCore::IntPoint& basePoint)
283 {
284     ASSERT(frame);
285
286     if (!frame)
287         return VisiblePosition();
288
289     switch (direction) {
290     case KEYCODE_LEFT:
291         // Extend x to start and clamp y to the edge of bounding box.
292         return frame->visiblePositionForPoint(WebCore::IntPoint(boundingBox.x(), clamp(boundingBox.y(), basePoint.y(), boundingBox.maxY())));
293     case KEYCODE_RIGHT:
294         // Extend x to end and clamp y to the edge of bounding box.
295         return frame->visiblePositionForPoint(WebCore::IntPoint(boundingBox.maxX(), clamp(boundingBox.y(), basePoint.y(), boundingBox.maxY())));
296     case KEYCODE_UP:
297         // Extend y to top and clamp x to the edge of bounding box.
298         return frame->visiblePositionForPoint(WebCore::IntPoint(clamp(boundingBox.x(), basePoint.x(), boundingBox.maxX()), boundingBox.y()));
299     case KEYCODE_DOWN:
300         // Extend y to bottom and clamp x to the edge of bounding box.
301         return frame->visiblePositionForPoint(WebCore::IntPoint(clamp(boundingBox.x(), basePoint.x(), boundingBox.maxX()), boundingBox.maxY()));
302     default:
303         break;
304     }
305
306     return frame->visiblePositionForPoint(WebCore::IntPoint(basePoint.x(), basePoint.y()));
307 }
308
309 static bool pointIsOutsideOfBoundingBoxInDirection(unsigned direction, const WebCore::IntPoint& selectionPoint, const WebCore::IntRect& boundingBox)
310 {
311     if ((direction == KEYCODE_LEFT && selectionPoint.x() < boundingBox.x())
312         || (direction == KEYCODE_UP && selectionPoint.y() < boundingBox.y())
313         || (direction == KEYCODE_RIGHT && selectionPoint.x() > boundingBox.maxX())
314         || (direction == KEYCODE_DOWN && selectionPoint.y() > boundingBox.maxY()))
315         return true;
316
317     return false;
318 }
319
320 unsigned short SelectionHandler::extendSelectionToFieldBoundary(bool isStartHandle, const WebCore::IntPoint& selectionPoint, VisibleSelection& newSelection)
321 {
322     Frame* focusedFrame = m_webPage->focusedOrMainFrame();
323     if (!focusedFrame->document()->focusedNode() || !focusedFrame->document()->focusedNode()->renderer())
324         return 0;
325
326     FrameSelection* controller = focusedFrame->selection();
327
328     WebCore::IntRect caretRect = isStartHandle ? controller->selection().visibleStart().absoluteCaretBounds()
329                                       : controller->selection().visibleEnd().absoluteCaretBounds();
330
331     WebCore::IntRect nodeBoundingBox = focusedFrame->document()->focusedNode()->renderer()->absoluteBoundingBoxRect();
332     nodeBoundingBox.inflate(-1);
333
334     // Start handle is outside of the field. Treat it as the changed handle and move
335     // relative to the start caret rect.
336     unsigned short character = directionOfPointRelativeToRect(selectionPoint, caretRect, isStartHandle /* useTopPadding */, !isStartHandle /* useBottomPadding */);
337
338     // Prevent incorrect movement, handles can only extend the selection this way
339     // to prevent inversion of the handles.
340     if (isStartHandle && (character == KEYCODE_RIGHT || character == KEYCODE_DOWN)
341         || !isStartHandle && (character == KEYCODE_LEFT || character == KEYCODE_UP))
342         character = 0;
343
344     VisiblePosition newVisiblePosition = isStartHandle ? controller->selection().extent() : controller->selection().base();
345     // Extend the selection to the bounds of the box before doing incremental scroll if the point is outside the node.
346     // Don't extend selection and handle the character at the same time.
347     if (pointIsOutsideOfBoundingBoxInDirection(character, selectionPoint, nodeBoundingBox))
348         newVisiblePosition = directionalVisiblePositionAtExtentOfBox(focusedFrame, nodeBoundingBox, character, selectionPoint);
349
350     if (isStartHandle)
351         newSelection = VisibleSelection(newVisiblePosition, newSelection.extent(), true /* isDirectional */);
352     else
353         newSelection = VisibleSelection(newSelection.base(), newVisiblePosition, true /* isDirectional */);
354
355     // If no selection will be changed, return the character to extend using navigation.
356     if (controller->selection() == newSelection)
357         return character;
358
359     // Selection has been updated.
360     return 0;
361 }
362
363 // Returns true if handled.
364 bool SelectionHandler::updateOrHandleInputSelection(VisibleSelection& newSelection, const WebCore::IntPoint& relativeStart
365                                                     , const WebCore::IntPoint& relativeEnd)
366 {
367     ASSERT(m_webPage->m_inputHandler->isInputMode());
368
369     Frame* focusedFrame = m_webPage->focusedOrMainFrame();
370     Node* focusedNode = focusedFrame->document()->focusedNode();
371     if (!focusedNode || !focusedNode->renderer())
372         return false;
373
374     FrameSelection* controller = focusedFrame->selection();
375
376     WebCore::IntRect currentStartCaretRect = controller->selection().visibleStart().absoluteCaretBounds();
377     WebCore::IntRect currentEndCaretRect = controller->selection().visibleEnd().absoluteCaretBounds();
378
379     // Check if the handle movement is valid.
380     if (!shouldUpdateSelectionOrCaretForPoint(relativeStart, currentStartCaretRect, true /* startCaret */)
381         || !shouldUpdateSelectionOrCaretForPoint(relativeEnd, currentEndCaretRect, false /* startCaret */)) {
382         selectionPositionChanged();
383         return true;
384     }
385
386     WebCore::IntRect nodeBoundingBox = focusedNode->renderer()->absoluteBoundingBoxRect();
387
388     // Only do special handling if one handle is outside of the node.
389     bool startIsOutsideOfField = relativeStart != DOMSupport::InvalidPoint && !nodeBoundingBox.contains(relativeStart);
390     bool endIsOutsideOfField = relativeEnd != DOMSupport::InvalidPoint && !nodeBoundingBox.contains(relativeEnd);
391     if (startIsOutsideOfField && endIsOutsideOfField)
392         return false;
393
394     unsigned short character = 0;
395     if (startIsOutsideOfField) {
396         character = extendSelectionToFieldBoundary(true /* isStartHandle */, relativeStart, newSelection);
397         if (character) {
398             // Invert the selection so that the cursor point is at the beginning.
399             controller->setSelection(VisibleSelection(controller->selection().end(), controller->selection().start(), true /* isDirectional */));
400         }
401     } else if (endIsOutsideOfField) {
402         character = extendSelectionToFieldBoundary(false /* isStartHandle */, relativeEnd, newSelection);
403         if (character) {
404             // Reset the selection so that the end is the edit point.
405             controller->setSelection(VisibleSelection(controller->selection().start(), controller->selection().end(), true /* isDirectional */));
406         }
407     }
408
409     if (!character)
410         return false;
411
412     DEBUG_SELECTION(LogLevelInfo, "SelectionHandler::setSelection making selection change attempt using key event %d", character);
413
414     if (shouldExtendSelectionInDirection(controller->selection(), character))
415         m_webPage->m_inputHandler->handleKeyboardInput(Platform::KeyboardEvent(character, Platform::KeyboardEvent::KeyDown, KEYMOD_SHIFT));
416
417     // Must send the selectionPositionChanged every time, sometimes this will duplicate but an accepted
418     // handleNavigationMove may not make an actual selection change.
419     selectionPositionChanged();
420     return true;
421 }
422
423 void SelectionHandler::setSelection(const WebCore::IntPoint& start, const WebCore::IntPoint& end)
424 {
425     m_selectionActive = true;
426
427     ASSERT(m_webPage);
428     ASSERT(m_webPage->focusedOrMainFrame());
429     ASSERT(m_webPage->focusedOrMainFrame()->selection());
430
431     Frame* focusedFrame = m_webPage->focusedOrMainFrame();
432     FrameSelection* controller = focusedFrame->selection();
433
434     DEBUG_SELECTION(LogLevelInfo, "SelectionHandler::setSelection adjusted points %d, %d, %d, %d", start.x(), start.y(), end.x(), end.y());
435
436     // Note that IntPoint(-1, -1) is being our sentinel so far for
437     // clipped out selection starting or ending location.
438     bool startIsValid = start != DOMSupport::InvalidPoint;
439     m_lastUpdatedEndPointIsValid = end != DOMSupport::InvalidPoint;
440
441     // At least one of the locations must be valid.
442     ASSERT(startIsValid || m_lastUpdatedEndPointIsValid);
443
444     WebCore::IntPoint relativeStart = start;
445     WebCore::IntPoint relativeEnd = end;
446
447     VisibleSelection newSelection(controller->selection());
448
449     // We need the selection to be ordered base then extent.
450     if (!controller->selection().isBaseFirst())
451         controller->setSelection(VisibleSelection(controller->selection().start(), controller->selection().end(), true /* isDirectional */));
452
453     if (startIsValid) {
454         relativeStart = DOMSupport::convertPointToFrame(m_webPage->mainFrame(), focusedFrame, start);
455
456         // Set the selection with validation.
457         newSelection.setBase(visiblePositionForPointIgnoringClipping(*focusedFrame, clipPointToVisibleContainer(start)));
458
459         // Reset the selection using the existing extent without validation.
460         newSelection.setWithoutValidation(newSelection.base(), controller->selection().end());
461     }
462
463     if (m_lastUpdatedEndPointIsValid) {
464         relativeEnd = DOMSupport::convertPointToFrame(m_webPage->mainFrame(), focusedFrame, end);
465
466         // Set the selection with validation.
467         newSelection.setExtent(visiblePositionForPointIgnoringClipping(*focusedFrame, clipPointToVisibleContainer(end)));
468
469         // Reset the selection using the existing base without validation.
470         newSelection.setWithoutValidation(controller->selection().start(), newSelection.extent());
471     }
472
473     newSelection.setIsDirectional(true);
474
475     if (m_webPage->m_inputHandler->isInputMode()) {
476         if (updateOrHandleInputSelection(newSelection, relativeStart, relativeEnd))
477             return;
478     }
479
480     if (controller->selection() == newSelection) {
481         selectionPositionChanged();
482         return;
483     }
484
485     // If the selection size is reduce to less than a character, selection type becomes
486     // Caret. As long as it is still a range, it's a valid selection. Selection cannot
487     // be cancelled through this function.
488     IntRectRegion region;
489     getConsolidatedRegionOfTextQuadsForSelection(newSelection, region);
490     clipRegionToVisibleContainer(region);
491     if (!region.isEmpty()) {
492         // Check if the handles reversed position.
493         if (m_selectionActive && !newSelection.isBaseFirst())
494             m_webPage->m_client->notifySelectionHandlesReversed();
495
496         controller->setSelection(newSelection);
497
498         DEBUG_SELECTION(LogLevelInfo, "SelectionHandler::setSelection selection points valid, selection updated");
499     } else {
500         // Requested selection results in an empty selection, skip this change.
501         selectionPositionChanged();
502
503         DEBUG_SELECTION(LogLevelWarn, "SelectionHandler::setSelection selection points invalid, selection not updated");
504     }
505 }
506
507 // FIXME re-use this in context. Must be updated to include an option to return the href.
508 // This function should be moved to a new unit file. Names suggetions include DOMQueries
509 // and NodeTypes. Functions currently in InputHandler.cpp, SelectionHandler.cpp and WebPage.cpp
510 // can all be moved in.
511 static Node* enclosingLinkEventParentForNode(Node* node)
512 {
513     if (!node)
514         return 0;
515
516     Node* linkNode = node->enclosingLinkEventParentOrSelf();
517     return linkNode && linkNode->isLink() ? linkNode : 0;
518 }
519
520 void SelectionHandler::selectAtPoint(const WebCore::IntPoint& location)
521 {
522     // If point is invalid trigger selection based expansion.
523     if (location == DOMSupport::InvalidPoint) {
524         selectObject(WordGranularity);
525         return;
526     }
527
528     Node* targetNode;
529     WebCore::IntPoint targetPosition;
530     // FIXME: Factory this get right fat finger code into a helper.
531     const FatFingersResult lastFatFingersResult = m_webPage->m_touchEventHandler->lastFatFingersResult();
532     if (lastFatFingersResult.positionWasAdjusted() && lastFatFingersResult.nodeAsElementIfApplicable()) {
533         targetNode = lastFatFingersResult.node(FatFingersResult::ShadowContentNotAllowed);
534         targetPosition = lastFatFingersResult.adjustedPosition();
535     } else {
536         FatFingersResult newFatFingersResult = FatFingers(m_webPage, location, FatFingers::Text).findBestPoint();
537         if (!newFatFingersResult.positionWasAdjusted())
538             return;
539
540         targetPosition = newFatFingersResult.adjustedPosition();
541         targetNode = newFatFingersResult.node(FatFingersResult::ShadowContentNotAllowed);
542     }
543
544     ASSERT(targetNode);
545
546     // If the node at the point is a link, focus on the entire link, not a word.
547     if (Node* link = enclosingLinkEventParentForNode(targetNode)) {
548         selectObject(link);
549         return;
550     }
551
552     // selectAtPoint API currently only supports WordGranularity but may be extended in the future.
553     selectObject(targetPosition, WordGranularity);
554 }
555
556 static bool expandSelectionToGranularity(Frame* frame, VisibleSelection selection, TextGranularity granularity, bool isInputMode)
557 {
558     ASSERT(frame);
559     ASSERT(frame->selection());
560
561     if (!(selection.start().anchorNode() && selection.start().anchorNode()->isTextNode()))
562         return false;
563
564     if (granularity == WordGranularity)
565         selection = DOMSupport::visibleSelectionForClosestActualWordStart(selection);
566
567     selection.expandUsingGranularity(granularity);
568     RefPtr<Range> newRange = selection.toNormalizedRange();
569     RefPtr<Range> oldRange = frame->selection()->selection().toNormalizedRange();
570     EAffinity affinity = frame->selection()->affinity();
571
572     if (isInputMode && !frame->editor()->client()->shouldChangeSelectedRange(oldRange.get(), newRange.get(), affinity, false))
573         return false;
574
575     return frame->selection()->setSelectedRange(newRange.get(), affinity, true);
576 }
577
578 void SelectionHandler::selectObject(const WebCore::IntPoint& location, TextGranularity granularity)
579 {
580     ASSERT(location.x() >= 0 && location.y() >= 0);
581     ASSERT(m_webPage && m_webPage->focusedOrMainFrame() && m_webPage->focusedOrMainFrame()->selection());
582     Frame* focusedFrame = m_webPage->focusedOrMainFrame();
583
584     DEBUG_SELECTION(LogLevelInfo, "SelectionHandler::selectObject adjusted points %d, %d", location.x(), location.y());
585
586     WebCore::IntPoint relativePoint = DOMSupport::convertPointToFrame(m_webPage->mainFrame(), focusedFrame, location);
587     VisiblePosition pointLocation(focusedFrame->visiblePositionForPoint(relativePoint));
588     VisibleSelection selection = VisibleSelection(pointLocation, pointLocation);
589
590     m_selectionActive = expandSelectionToGranularity(focusedFrame, selection, granularity, m_webPage->m_inputHandler->isInputMode());
591 }
592
593 void SelectionHandler::selectObject(TextGranularity granularity)
594 {
595     ASSERT(m_webPage && m_webPage->m_inputHandler);
596     // Using caret location, must be inside an input field.
597     if (!m_webPage->m_inputHandler->isInputMode())
598         return;
599
600     ASSERT(m_webPage->focusedOrMainFrame() && m_webPage->focusedOrMainFrame()->selection());
601     Frame* focusedFrame = m_webPage->focusedOrMainFrame();
602
603     DEBUG_SELECTION(LogLevelInfo, "SelectionHandler::selectObject using current selection");
604
605     // Use the current selection as the selection point.
606     ASSERT(focusedFrame->selection()->selectionType() != VisibleSelection::NoSelection);
607     m_selectionActive = expandSelectionToGranularity(focusedFrame, focusedFrame->selection()->selection(), granularity, true /* isInputMode */);
608 }
609
610 void SelectionHandler::selectObject(Node* node)
611 {
612     if (!node)
613         return;
614
615     m_selectionActive = true;
616
617     ASSERT(m_webPage && m_webPage->focusedOrMainFrame() && m_webPage->focusedOrMainFrame()->selection());
618     Frame* focusedFrame = m_webPage->focusedOrMainFrame();
619
620     DEBUG_SELECTION(LogLevelInfo, "SelectionHandler::selectNode");
621
622     VisibleSelection selection = VisibleSelection::selectionFromContentsOfNode(node);
623     focusedFrame->selection()->setSelection(selection);
624 }
625
626 static TextDirection directionOfEnclosingBlock(FrameSelection* selection)
627 {
628     Node* enclosingBlockNode = enclosingBlock(selection->selection().extent().deprecatedNode());
629     if (!enclosingBlockNode)
630         return LTR;
631
632     if (RenderObject* renderer = enclosingBlockNode->renderer())
633         return renderer->style()->direction();
634
635     return LTR;
636 }
637
638 // Returns > 0 if p1 is "closer" to referencePoint, < 0 if p2 is "closer", 0 if they are equidistant.
639 // Because text is usually arranged in horizontal rows, distance is measured along the y-axis, with x-axis used only to break ties.
640 // If rightGravity is true, the right-most x-coordinate is chosen, otherwise teh left-most coordinate is chosen.
641 static inline int comparePointsToReferencePoint(const WebCore::IntPoint& p1, const WebCore::IntPoint& p2, const WebCore::IntPoint& referencePoint, bool rightGravity)
642 {
643     int dy1 = abs(referencePoint.y() - p1.y());
644     int dy2 = abs(referencePoint.y() - p2.y());
645     if (dy1 != dy2)
646         return dy2 - dy1;
647
648     // Same y-coordinate, choose the farthest right (or left) point.
649     if (p1.x() == p2.x())
650         return 0;
651
652     if (p1.x() > p2.x())
653         return rightGravity ? 1 : -1;
654
655     return rightGravity ? -1 : 1;
656 }
657
658 // NOTE/FIXME: Due to r77286, we are getting off-by-one results in the IntRect class counterpart implementation of the
659 //             methods below. As done in r89803, r77928 and a few others, lets use local method to fix it.
660 //             We should keep our eyes very open on it, since it can affect BackingStore very badly.
661 static WebCore::IntPoint minXMinYCorner(const WebCore::IntRect& rect) { return rect.location(); } // typically topLeft
662 static WebCore::IntPoint maxXMinYCorner(const WebCore::IntRect& rect) { return WebCore::IntPoint(rect.x() + rect.width() - 1, rect.y()); } // typically topRight
663 static WebCore::IntPoint minXMaxYCorner(const WebCore::IntRect& rect) { return WebCore::IntPoint(rect.x(), rect.y() + rect.height() - 1); } // typically bottomLeft
664 static WebCore::IntPoint maxXMaxYCorner(const WebCore::IntRect& rect) { return WebCore::IntPoint(rect.x() + rect.width() - 1, rect.y() + rect.height() - 1); } // typically bottomRight
665
666 // The caret is a one-pixel wide line down either the right or left edge of a
667 // rect, depending on the text direction.
668 static inline bool caretIsOnLeft(bool isStartCaret, bool isRTL)
669 {
670     if (isStartCaret)
671         return !isRTL;
672
673     return isRTL;
674 }
675
676 static inline WebCore::IntPoint caretLocationForRect(const WebCore::IntRect& rect, bool isStartCaret, bool isRTL)
677 {
678     return caretIsOnLeft(isStartCaret, isRTL) ? minXMinYCorner(rect) : maxXMinYCorner(rect);
679 }
680
681 static inline WebCore::IntPoint caretComparisonPointForRect(const WebCore::IntRect& rect, bool isStartCaret, bool isRTL)
682 {
683     if (isStartCaret)
684         return caretIsOnLeft(isStartCaret, isRTL) ? minXMinYCorner(rect) : maxXMinYCorner(rect);
685
686     return caretIsOnLeft(isStartCaret, isRTL) ? minXMaxYCorner(rect) : maxXMaxYCorner(rect);
687 }
688
689 static void adjustCaretRects(WebCore::IntRect& startCaret, bool isStartCaretClippedOut,
690                              WebCore::IntRect& endCaret, bool isEndCaretClippedOut,
691                              const std::vector<Platform::IntRect> rectList,
692                              const WebCore::IntPoint& startReferencePoint,
693                              const WebCore::IntPoint& endReferencePoint,
694                              bool isRTL)
695 {
696     // startReferencePoint is the best guess at the top left of the selection; endReferencePoint is the best guess at the bottom right.
697     if (isStartCaretClippedOut)
698         startCaret.setLocation(DOMSupport::InvalidPoint);
699     else {
700         startCaret = rectList[0];
701         startCaret.setLocation(caretLocationForRect(startCaret, true, isRTL));
702     }
703
704     if (isEndCaretClippedOut)
705         endCaret.setLocation(DOMSupport::InvalidPoint);
706     else {
707         endCaret = rectList[0];
708         endCaret.setLocation(caretLocationForRect(endCaret, false, isRTL));
709     }
710
711     if (isStartCaretClippedOut && isEndCaretClippedOut)
712         return;
713
714     // Reset width to 1 as we are strictly interested in caret location.
715     startCaret.setWidth(1);
716     endCaret.setWidth(1);
717
718     for (unsigned i = 1; i < rectList.size(); i++) {
719         WebCore::IntRect currentRect(rectList[i]);
720
721         // Compare and update the start and end carets with their respective reference points.
722         if (!isStartCaretClippedOut && comparePointsToReferencePoint(
723                     caretComparisonPointForRect(currentRect, true, isRTL),
724                     caretComparisonPointForRect(startCaret, true, isRTL),
725                     startReferencePoint, isRTL) > 0) {
726             startCaret.setLocation(caretLocationForRect(currentRect, true, isRTL));
727             startCaret.setHeight(currentRect.height());
728         }
729
730         if (!isEndCaretClippedOut && comparePointsToReferencePoint(
731                     caretComparisonPointForRect(currentRect, false, isRTL),
732                     caretComparisonPointForRect(endCaret, false, isRTL),
733                     endReferencePoint, !isRTL) > 0) {
734             endCaret.setLocation(caretLocationForRect(currentRect, false, isRTL));
735             endCaret.setHeight(currentRect.height());
736         }
737     }
738 }
739
740 void SelectionHandler::clipRegionToVisibleContainer(IntRectRegion& region)
741 {
742     ASSERT(m_webPage->m_mainFrame && m_webPage->m_mainFrame->view());
743
744     Frame* frame = m_webPage->focusedOrMainFrame();
745
746     // Don't allow the region to extend outside of the all its ancestor frames' visible area.
747     if (frame != m_webPage->mainFrame()) {
748         WebCore::IntRect containingContentRect;
749         containingContentRect = m_webPage->getRecursiveVisibleWindowRect(frame->view(), true /* no clip to main frame window */);
750         containingContentRect = m_webPage->m_mainFrame->view()->windowToContents(containingContentRect);
751         region = intersectRegions(IntRectRegion(containingContentRect), region);
752     }
753
754     // Don't allow the region to extend outside of the input field.
755     if (m_webPage->m_inputHandler->isInputMode()
756         && frame->document()->focusedNode()
757         && frame->document()->focusedNode()->renderer()) {
758
759         // Adjust the bounding box to the frame offset.
760         WebCore::IntRect boundingBox(frame->document()->focusedNode()->renderer()->absoluteBoundingBoxRect());
761         boundingBox = m_webPage->mainFrame()->view()->windowToContents(frame->view()->contentsToWindow(boundingBox));
762
763         region = intersectRegions(IntRectRegion(boundingBox), region);
764     }
765 }
766
767 WebCore::IntPoint SelectionHandler::clipPointToVisibleContainer(const WebCore::IntPoint& point) const
768 {
769     ASSERT(m_webPage->m_mainFrame && m_webPage->m_mainFrame->view());
770
771     Frame* frame = m_webPage->focusedOrMainFrame();
772     WebCore::IntPoint clippedPoint = DOMSupport::convertPointToFrame(m_webPage->mainFrame(), frame, point, true /* clampToTargetFrame */);
773
774     if (m_webPage->m_inputHandler->isInputMode()
775             && frame->document()->focusedNode()
776             && frame->document()->focusedNode()->renderer()) {
777         WebCore::IntRect boundingBox(frame->document()->focusedNode()->renderer()->absoluteBoundingBoxRect());
778         boundingBox.inflate(-1);
779         clippedPoint = WebCore::IntPoint(clamp(boundingBox.x(), clippedPoint.x(), boundingBox.maxX()), clamp(boundingBox.y(), clippedPoint.y(), boundingBox.maxY()));
780     }
781
782     return clippedPoint;
783 }
784
785 static WebCore::IntPoint referencePoint(const VisiblePosition& position, const WebCore::IntRect& boundingRect, const WebCore::IntPoint& framePosition, bool isStartCaret, bool isRTL)
786 {
787     // If one of the carets is invalid (this happens, for instance, if the
788     // selection ends in an empty div) fall back to using the corner of the
789     // entire region (which is already in frame coordinates so doesn't need
790     // adjusting).
791     WebCore::IntRect startCaretBounds(position.absoluteCaretBounds());
792     if (startCaretBounds.isEmpty())
793         startCaretBounds = boundingRect;
794     else
795         startCaretBounds.move(framePosition.x(), framePosition.y());
796
797     return caretComparisonPointForRect(startCaretBounds, isStartCaret, isRTL);
798 }
799
800 // Note: This is the only function in SelectionHandler in which the coordinate
801 // system is not entirely WebKit.
802 void SelectionHandler::selectionPositionChanged(bool visualChangeOnly)
803 {
804     DEBUG_SELECTION(LogLevelInfo, "SelectionHandler::selectionPositionChanged visibleChangeOnly = %s", visualChangeOnly ? "true" : "false");
805
806     // This method can get called during WebPage shutdown process.
807     // If that is the case, just bail out since the client is not
808     // in a safe state of trust to request anything else from it.
809     if (!m_webPage->m_mainFrame)
810         return;
811
812     if (m_webPage->m_inputHandler->isInputMode() && m_webPage->m_inputHandler->processingChange()) {
813         m_webPage->m_client->cancelSelectionVisuals();
814         return;
815     }
816
817     if (m_caretActive || (m_webPage->m_inputHandler->isInputMode() && m_webPage->focusedOrMainFrame()->selection()->isCaret())) {
818         // This may update the caret to no longer be active.
819         caretPositionChanged();
820     }
821
822     // Enter selection mode if selection type is RangeSelection, and disable selection if
823     // selection is active and becomes caret selection.
824     Frame* frame = m_webPage->focusedOrMainFrame();
825     WebCore::IntPoint framePos = m_webPage->frameOffset(frame);
826     if (m_selectionActive && (m_caretActive || frame->selection()->isNone()))
827         m_selectionActive = false;
828     else if (frame->selection()->isRange())
829         m_selectionActive = true;
830     else if (!m_selectionActive)
831         return;
832
833     WebCore::IntRect startCaret;
834     WebCore::IntRect endCaret;
835
836     // Get the text rects from the selections range.
837     IntRectRegion region;
838     getConsolidatedRegionOfTextQuadsForSelection(frame->selection()->selection(), region);
839
840     // If there is no change in selected text and the visual rects
841     // have not changed then don't bother notifying anything.
842     if (visualChangeOnly && m_lastSelectionRegion.isEqual(region))
843         return;
844
845     m_lastSelectionRegion = region;
846
847     if (!region.isEmpty()) {
848         WebCore::IntRect unclippedStartCaret;
849         WebCore::IntRect unclippedEndCaret;
850
851         bool isRTL = directionOfEnclosingBlock(frame->selection()) == RTL;
852
853         std::vector<Platform::IntRect> rectList = region.rects();
854
855         WebCore::IntPoint startCaretReferencePoint = referencePoint(frame->selection()->selection().visibleStart(), region.extents(), framePos, true /* isStartCaret */, isRTL);
856         WebCore::IntPoint endCaretReferencePoint = referencePoint(frame->selection()->selection().visibleEnd(), region.extents(), framePos, false /* isStartCaret */, isRTL);
857
858         adjustCaretRects(unclippedStartCaret, false /* unclipped */, unclippedEndCaret, false /* unclipped */, rectList, startCaretReferencePoint, endCaretReferencePoint, isRTL);
859
860         clipRegionToVisibleContainer(region);
861
862 #if SHOWDEBUG_SELECTIONHANDLER // Don't rely just on DEBUG_SELECTION to avoid loop.
863         for (unsigned int i = 0; i < rectList.size(); i++)
864             DEBUG_SELECTION(LogLevelCritical, "Rect list - Unmodified #%d, (%d, %d) (%d x %d)", i, rectList[i].x(), rectList[i].y(), rectList[i].width(), rectList[i].height());
865         for (unsigned int i = 0; i < region.numRects(); i++)
866             DEBUG_SELECTION(LogLevelCritical, "Rect list  - Consolidated #%d, (%d, %d) (%d x %d)", i, region.rects()[i].x(), region.rects()[i].y(), region.rects()[i].width(), region.rects()[i].height());
867 #endif
868
869         bool shouldCareAboutPossibleClippedOutSelection = frame != m_webPage->mainFrame() || m_webPage->m_inputHandler->isInputMode();
870
871         if (!region.isEmpty() || shouldCareAboutPossibleClippedOutSelection) {
872             // Adjust the handle markers to be at the end of the painted rect. When selecting links
873             // and other elements that may have a larger visible area than needs to be rendered a gap
874             // can exist between the handle and overlay region.
875
876             bool shouldClipStartCaret = !region.isRectInRegion(unclippedStartCaret);
877             bool shouldClipEndCaret = !region.isRectInRegion(unclippedEndCaret);
878
879             // Find the top corner and bottom corner.
880             std::vector<Platform::IntRect> clippedRectList = region.rects();
881             adjustCaretRects(startCaret, shouldClipStartCaret, endCaret, shouldClipEndCaret, clippedRectList, startCaretReferencePoint, endCaretReferencePoint, isRTL);
882
883             // Translate the caret values as they must be in transformed coordinates.
884             if (!shouldClipStartCaret) {
885                 startCaret = m_webPage->mapToTransformed(startCaret);
886                 m_webPage->clipToTransformedContentsRect(startCaret);
887             }
888
889             if (!shouldClipEndCaret) {
890                 endCaret = m_webPage->mapToTransformed(endCaret);
891                 m_webPage->clipToTransformedContentsRect(endCaret);
892             }
893         }
894     }
895
896     DEBUG_SELECTION(BlackBerry::Platform::LogLevelInfo, "SelectionHandler::selectionPositionChanged Start Rect=(%d, %d) (%d x %d) End Rect=(%d, %d) (%d x %d)",
897                     startCaret.x(), startCaret.y(), startCaret.width(), startCaret.height(), endCaret.x(), endCaret.y(), endCaret.width(), endCaret.height());
898
899
900     m_webPage->m_client->notifySelectionDetailsChanged(startCaret, endCaret, region);
901 }
902
903 // NOTE: This function is not in WebKit coordinates.
904 void SelectionHandler::caretPositionChanged()
905 {
906     DEBUG_SELECTION(LogLevelInfo, "SelectionHandler::caretPositionChanged");
907
908     WebCore::IntRect caretLocation;
909     // If the input field is not active, we must be turning off the caret.
910     if (!m_webPage->m_inputHandler->isInputMode() && m_caretActive) {
911         m_caretActive = false;
912         // Send an empty caret change to turn off the caret.
913         m_webPage->m_client->notifyCaretChanged(caretLocation, m_webPage->m_touchEventHandler->lastFatFingersResult().isTextInput() /* userTouchTriggered */);
914         return;
915     }
916
917     ASSERT(m_webPage && m_webPage->focusedOrMainFrame() && m_webPage->focusedOrMainFrame()->selection());
918
919     // This function should only reach this point if input mode is active.
920     ASSERT(m_webPage->m_inputHandler->isInputMode());
921
922     if (m_webPage->focusedOrMainFrame()->selection()->selectionType() == VisibleSelection::CaretSelection) {
923         WebCore::IntPoint frameOffset = m_webPage->frameOffset(m_webPage->focusedOrMainFrame());
924
925         caretLocation = m_webPage->focusedOrMainFrame()->selection()->selection().visibleStart().absoluteCaretBounds();
926         caretLocation.move(frameOffset.x(), frameOffset.y());
927
928         // Clip against the containing frame and node boundaries.
929         IntRectRegion region(caretLocation);
930         clipRegionToVisibleContainer(region);
931         caretLocation = region.extents();
932     }
933
934     m_caretActive = !caretLocation.isEmpty();
935
936     DEBUG_SELECTION(LogLevelInfo, "SelectionHandler::caretPositionChanged caret Rect %d, %d, %dx%d",
937                         caretLocation.x(), caretLocation.y(), caretLocation.width(), caretLocation.height());
938
939     caretLocation = m_webPage->mapToTransformed(caretLocation);
940     m_webPage->clipToTransformedContentsRect(caretLocation);
941
942     m_webPage->m_client->notifyCaretChanged(caretLocation, m_webPage->m_touchEventHandler->lastFatFingersResult().isTextInput() /* userTouchTriggered */);
943 }
944
945 bool SelectionHandler::selectionContains(const WebCore::IntPoint& point)
946 {
947     ASSERT(m_webPage && m_webPage->focusedOrMainFrame() && m_webPage->focusedOrMainFrame()->selection());
948     return m_webPage->focusedOrMainFrame()->selection()->contains(point);
949 }
950
951 }
952 }