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