2 * Copyright (C) 2004, 2008, 2009, 2010 Apple Inc. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
13 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 #include "core/editing/Caret.h"
29 #include "core/dom/Document.h"
30 #include "core/editing/VisibleUnits.h"
31 #include "core/editing/htmlediting.h"
32 #include "core/frame/LocalFrame.h"
33 #include "core/frame/Settings.h"
34 #include "core/html/HTMLTextFormControlElement.h"
35 #include "core/rendering/RenderBlock.h"
36 #include "core/rendering/RenderLayer.h"
37 #include "core/rendering/RenderView.h"
38 #include "platform/graphics/GraphicsContext.h"
42 CaretBase::CaretBase(CaretVisibility visibility)
43 : m_caretRectNeedsUpdate(true)
44 , m_caretVisibility(visibility)
48 DragCaretController::DragCaretController()
53 PassOwnPtrWillBeRawPtr<DragCaretController> DragCaretController::create()
55 return adoptPtrWillBeNoop(new DragCaretController);
58 bool DragCaretController::isContentRichlyEditable() const
60 return isRichlyEditablePosition(m_position.deepEquivalent());
63 void DragCaretController::setCaretPosition(const VisiblePosition& position)
65 // for querying RenderLayer::compositingState()
66 // This code is probably correct, since it doesn't occur in a stack that involves updating compositing state.
67 DisableCompositingQueryAsserts disabler;
69 if (Node* node = m_position.deepEquivalent().deprecatedNode())
70 invalidateCaretRect(node);
71 m_position = position;
72 setCaretRectNeedsUpdate();
73 Document* document = 0;
74 if (Node* node = m_position.deepEquivalent().deprecatedNode()) {
75 invalidateCaretRect(node);
76 document = &node->document();
78 if (m_position.isNull() || m_position.isOrphan()) {
81 document->updateRenderTreeIfNeeded();
82 updateCaretRect(document, m_position);
86 static bool removingNodeRemovesPosition(Node& node, const Position& position)
88 if (!position.anchorNode())
91 if (position.anchorNode() == node)
94 if (!node.isElementNode())
97 Element& element = toElement(node);
98 return element.containsIncludingShadowDOM(position.anchorNode());
101 void DragCaretController::nodeWillBeRemoved(Node& node)
103 if (!hasCaret() || !node.inActiveDocument())
106 if (!removingNodeRemovesPosition(node, m_position.deepEquivalent()))
109 m_position.deepEquivalent().document()->renderView()->clearSelection();
113 void DragCaretController::trace(Visitor* visitor)
115 visitor->trace(m_position);
118 void CaretBase::clearCaretRect()
120 m_caretLocalRect = LayoutRect();
123 static inline bool caretRendersInsideNode(Node* node)
125 return node && !isRenderedTableElement(node) && !editingIgnoresContent(node);
128 RenderBlock* CaretBase::caretRenderer(Node* node)
133 RenderObject* renderer = node->renderer();
137 // if caretNode is a block and caret is inside it then caret should be painted by that block
138 bool paintedByBlock = renderer->isRenderBlock() && caretRendersInsideNode(node);
139 return paintedByBlock ? toRenderBlock(renderer) : renderer->containingBlock();
142 bool CaretBase::updateCaretRect(Document* document, const PositionWithAffinity& caretPosition)
144 m_caretLocalRect = LayoutRect();
146 m_caretRectNeedsUpdate = false;
148 if (caretPosition.position().isNull())
151 ASSERT(caretPosition.position().deprecatedNode()->renderer());
153 // First compute a rect local to the renderer at the selection start.
154 RenderObject* renderer;
155 LayoutRect localRect = localCaretRectOfPosition(caretPosition, renderer);
157 // Get the renderer that will be responsible for painting the caret
158 // (which is either the renderer we just found, or one of its containers).
159 RenderBlock* caretPainter = caretRenderer(caretPosition.position().deprecatedNode());
161 // Compute an offset between the renderer and the caretPainter.
162 bool unrooted = false;
163 while (renderer != caretPainter) {
164 RenderObject* containerObject = renderer->container();
165 if (!containerObject) {
169 localRect.move(renderer->offsetFromContainer(containerObject, localRect.location()));
170 renderer = containerObject;
174 m_caretLocalRect = localRect;
179 bool CaretBase::updateCaretRect(Document* document, const VisiblePosition& caretPosition)
181 return updateCaretRect(document, PositionWithAffinity(caretPosition.deepEquivalent(), caretPosition.affinity()));
184 RenderBlock* DragCaretController::caretRenderer() const
186 return CaretBase::caretRenderer(m_position.deepEquivalent().deprecatedNode());
189 IntRect CaretBase::absoluteBoundsForLocalRect(Node* node, const LayoutRect& rect) const
191 RenderBlock* caretPainter = caretRenderer(node);
195 LayoutRect localRect(rect);
196 caretPainter->flipForWritingMode(localRect);
197 return caretPainter->localToAbsoluteQuad(FloatRect(localRect)).enclosingBoundingBox();
200 void CaretBase::invalidateLocalCaretRect(Node* node, const LayoutRect& rect)
202 RenderBlock* caretPainter = caretRenderer(node);
206 // FIXME: Need to over-paint 1 pixel to workaround some rounding problems.
207 // https://bugs.webkit.org/show_bug.cgi?id=108283
208 LayoutRect inflatedRect = rect;
209 inflatedRect.inflate(1);
211 caretPainter->invalidatePaintRectangle(inflatedRect);
214 bool CaretBase::shouldRepaintCaret(const RenderView* view, bool isContentEditable) const
217 bool caretBrowsing = false;
218 if (FrameView* frameView = view->frameView()) {
219 LocalFrame& frame = frameView->frame(); // The frame where the selection started
220 caretBrowsing = frame.settings() && frame.settings()->caretBrowsingEnabled();
222 return (caretBrowsing || isContentEditable);
225 void CaretBase::invalidateCaretRect(Node* node, bool caretRectChanged)
227 // EDIT FIXME: This is an unfortunate hack.
228 // Basically, we can't trust this layout position since we
229 // can't guarantee that the check to see if we are in unrendered
230 // content will work at this point. We may have to wait for
231 // a layout and re-render of the document to happen. So, resetting this
232 // flag will cause another caret layout to happen the first time
233 // that we try to paint the caret after this call. That one will work since
234 // it happens after the document has accounted for any editing
235 // changes which may have been done.
236 // And, we need to leave this layout here so the caret moves right
237 // away after clicking.
238 m_caretRectNeedsUpdate = true;
240 if (caretRectChanged)
243 if (RenderView* view = node->document().renderView()) {
244 if (shouldRepaintCaret(view, node->isContentEditable(Node::UserSelectAllIsAlwaysNonEditable)))
245 invalidateLocalCaretRect(node, localCaretRectWithoutUpdate());
249 void CaretBase::paintCaret(Node* node, GraphicsContext* context, const LayoutPoint& paintOffset, const LayoutRect& clipRect) const
251 if (m_caretVisibility == Hidden)
254 LayoutRect drawingRect = localCaretRectWithoutUpdate();
255 if (RenderBlock* renderer = caretRenderer(node))
256 renderer->flipForWritingMode(drawingRect);
257 drawingRect.moveBy(roundedIntPoint(paintOffset));
258 LayoutRect caret = intersection(drawingRect, clipRect);
262 Color caretColor = Color::black;
265 if (node->isElementNode())
266 element = toElement(node);
268 element = node->parentElement();
270 if (element && element->renderer())
271 caretColor = element->renderer()->resolveColor(CSSPropertyColor);
273 context->fillRect(caret, caretColor);
276 void DragCaretController::paintDragCaret(LocalFrame* frame, GraphicsContext* p, const LayoutPoint& paintOffset, const LayoutRect& clipRect) const
278 if (m_position.deepEquivalent().deprecatedNode()->document().frame() == frame)
279 paintCaret(m_position.deepEquivalent().deprecatedNode(), p, paintOffset, clipRect);