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