FocusController::setFocusedNode() should be setFocusedElement().
[WebKit-https.git] / Source / WebCore / editing / FrameSelection.h
1 /*
2  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
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.
12  *
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. 
24  */
25
26 #ifndef FrameSelection_h
27 #define FrameSelection_h
28
29 #include "EditingStyle.h"
30 #include "IntRect.h"
31 #include "LayoutRect.h"
32 #include "Range.h"
33 #include "ScrollBehavior.h"
34 #include "Timer.h"
35 #include "VisibleSelection.h"
36 #include <wtf/Noncopyable.h>
37
38 namespace WebCore {
39
40 class CharacterData;
41 class Frame;
42 class GraphicsContext;
43 class HTMLFormElement;
44 class MutableStylePropertySet;
45 class RenderObject;
46 class RenderView;
47 class Settings;
48 class VisiblePosition;
49
50 enum EUserTriggered { NotUserTriggered = 0, UserTriggered = 1 };
51
52 enum RevealExtentOption {
53     RevealExtent,
54     DoNotRevealExtent
55 };
56
57 class CaretBase {
58     WTF_MAKE_NONCOPYABLE(CaretBase);
59     WTF_MAKE_FAST_ALLOCATED;
60 protected:
61     enum CaretVisibility { Visible, Hidden };
62     explicit CaretBase(CaretVisibility = Hidden);
63
64     void invalidateCaretRect(Node*, bool caretRectChanged = false);
65     void clearCaretRect();
66     bool updateCaretRect(Document*, const VisiblePosition& caretPosition);
67     IntRect absoluteBoundsForLocalRect(Node*, const LayoutRect&) const;
68     bool shouldRepaintCaret(const RenderView*, bool isContentEditable) const;
69     void paintCaret(Node*, GraphicsContext*, const LayoutPoint&, const LayoutRect& clipRect) const;
70
71     const LayoutRect& localCaretRectWithoutUpdate() const { return m_caretLocalRect; }
72
73     bool shouldUpdateCaretRect() const { return m_caretRectNeedsUpdate; }
74     void setCaretRectNeedsUpdate() { m_caretRectNeedsUpdate = true; }
75
76     void setCaretVisibility(CaretVisibility visibility) { m_caretVisibility = visibility; }
77     bool caretIsVisible() const { return m_caretVisibility == Visible; }
78     CaretVisibility caretVisibility() const { return m_caretVisibility; }
79
80 private:
81     LayoutRect m_caretLocalRect; // caret rect in coords local to the renderer responsible for painting the caret
82     bool m_caretRectNeedsUpdate; // true if m_caretRect (and m_absCaretBounds in FrameSelection) need to be calculated
83     CaretVisibility m_caretVisibility;
84 };
85
86 class DragCaretController : private CaretBase {
87     WTF_MAKE_NONCOPYABLE(DragCaretController);
88     WTF_MAKE_FAST_ALLOCATED;
89 public:
90     static PassOwnPtr<DragCaretController> create();
91
92     RenderObject* caretRenderer() const;
93     void paintDragCaret(Frame*, GraphicsContext*, const LayoutPoint&, const LayoutRect& clipRect) const;
94
95     bool isContentEditable() const { return m_position.rootEditableElement(); }
96     bool isContentRichlyEditable() const;
97
98     bool hasCaret() const { return m_position.isNotNull(); }
99     const VisiblePosition& caretPosition() { return m_position; }
100     void setCaretPosition(const VisiblePosition&);
101     void clear() { setCaretPosition(VisiblePosition()); }
102
103     void nodeWillBeRemoved(Node*);
104
105 private:
106     DragCaretController();
107
108     VisiblePosition m_position;
109 };
110
111 class FrameSelection : private CaretBase {
112     WTF_MAKE_NONCOPYABLE(FrameSelection);
113     WTF_MAKE_FAST_ALLOCATED;
114 public:
115     enum EAlteration { AlterationMove, AlterationExtend };
116     enum CursorAlignOnScroll { AlignCursorOnScrollIfNeeded,
117                                AlignCursorOnScrollAlways };
118     enum SetSelectionOption {
119         // 1 << 0 is reserved for EUserTriggered
120         CloseTyping = 1 << 1,
121         ClearTypingStyle = 1 << 2,
122         SpellCorrectionTriggered = 1 << 3,
123         DoNotSetFocus = 1 << 4,
124         DictationTriggered = 1 << 5,
125         DoNotUpdateAppearance = 1 << 6,
126     };
127     typedef unsigned SetSelectionOptions; // Union of values in SetSelectionOption and EUserTriggered
128     static inline EUserTriggered selectionOptionsToUserTriggered(SetSelectionOptions options)
129     {
130         return static_cast<EUserTriggered>(options & UserTriggered);
131     }
132
133     explicit FrameSelection(Frame* = 0);
134
135     Element* rootEditableElement() const { return m_selection.rootEditableElement(); }
136     Element* rootEditableElementOrDocumentElement() const;
137     Node* rootEditableElementOrTreeScopeRootNode() const;
138     Element* rootEditableElementRespectingShadowTree() const;
139
140     bool rendererIsEditable() const { return m_selection.rendererIsEditable(); }
141     bool isContentEditable() const { return m_selection.isContentEditable(); }
142     bool isContentRichlyEditable() const { return m_selection.isContentRichlyEditable(); }
143      
144     void moveTo(const Range*, EAffinity, EUserTriggered = NotUserTriggered);
145     void moveTo(const VisiblePosition&, EUserTriggered = NotUserTriggered, CursorAlignOnScroll = AlignCursorOnScrollIfNeeded);
146     void moveTo(const VisiblePosition&, const VisiblePosition&, EUserTriggered = NotUserTriggered);
147     void moveTo(const Position&, EAffinity, EUserTriggered = NotUserTriggered);
148     void moveTo(const Position&, const Position&, EAffinity, EUserTriggered = NotUserTriggered);
149
150     const VisibleSelection& selection() const { return m_selection; }
151     void setSelection(const VisibleSelection&, SetSelectionOptions = CloseTyping | ClearTypingStyle, CursorAlignOnScroll = AlignCursorOnScrollIfNeeded, TextGranularity = CharacterGranularity);
152     void setSelection(const VisibleSelection& selection, TextGranularity granularity) { setSelection(selection, CloseTyping | ClearTypingStyle, AlignCursorOnScrollIfNeeded, granularity); }
153     bool setSelectedRange(Range*, EAffinity, bool closeTyping);
154     void selectAll();
155     void clear();
156     void prepareForDestruction();
157
158     // Call this after doing user-triggered selections to make it easy to delete the frame you entirely selected.
159     void selectFrameElementInParentIfFullySelected();
160
161     bool contains(const LayoutPoint&);
162
163     VisibleSelection::SelectionType selectionType() const { return m_selection.selectionType(); }
164
165     EAffinity affinity() const { return m_selection.affinity(); }
166
167     bool modify(EAlteration, SelectionDirection, TextGranularity, EUserTriggered = NotUserTriggered);
168     enum VerticalDirection { DirectionUp, DirectionDown };
169     bool modify(EAlteration, unsigned verticalDistance, VerticalDirection, EUserTriggered = NotUserTriggered, CursorAlignOnScroll = AlignCursorOnScrollIfNeeded);
170
171     TextGranularity granularity() const { return m_granularity; }
172
173     void setStart(const VisiblePosition &, EUserTriggered = NotUserTriggered);
174     void setEnd(const VisiblePosition &, EUserTriggered = NotUserTriggered);
175     
176     void setBase(const VisiblePosition&, EUserTriggered = NotUserTriggered);
177     void setBase(const Position&, EAffinity, EUserTriggered = NotUserTriggered);
178     void setExtent(const VisiblePosition&, EUserTriggered = NotUserTriggered);
179     void setExtent(const Position&, EAffinity, EUserTriggered = NotUserTriggered);
180
181     Position base() const { return m_selection.base(); }
182     Position extent() const { return m_selection.extent(); }
183     Position start() const { return m_selection.start(); }
184     Position end() const { return m_selection.end(); }
185
186     // Return the renderer that is responsible for painting the caret (in the selection start node)
187     RenderObject* caretRenderer() const;
188
189     // Caret rect local to the caret's renderer
190     LayoutRect localCaretRect();
191
192     // Bounds of (possibly transformed) caret in absolute coords
193     IntRect absoluteCaretBounds();
194     void setCaretRectNeedsUpdate() { CaretBase::setCaretRectNeedsUpdate(); }
195
196     void willBeModified(EAlteration, SelectionDirection);
197
198     bool isNone() const { return m_selection.isNone(); }
199     bool isCaret() const { return m_selection.isCaret(); }
200     bool isRange() const { return m_selection.isRange(); }
201     bool isCaretOrRange() const { return m_selection.isCaretOrRange(); }
202     bool isInPasswordField() const;
203     bool isAll(EditingBoundaryCrossingRule rule = CannotCrossEditingBoundary) const { return m_selection.isAll(rule); }
204     
205     PassRefPtr<Range> toNormalizedRange() const { return m_selection.toNormalizedRange(); }
206
207     void debugRenderer(RenderObject*, bool selected) const;
208
209     void nodeWillBeRemoved(Node*);
210     void textWasReplaced(CharacterData*, unsigned offset, unsigned oldLength, unsigned newLength);
211
212     void setCaretVisible(bool caretIsVisible) { setCaretVisibility(caretIsVisible ? Visible : Hidden); }
213     bool recomputeCaretRect();
214     void invalidateCaretRect();
215     void paintCaret(GraphicsContext*, const LayoutPoint&, const LayoutRect& clipRect);
216
217     // Used to suspend caret blinking while the mouse is down.
218     void setCaretBlinkingSuspended(bool suspended) { m_isCaretBlinkingSuspended = suspended; }
219     bool isCaretBlinkingSuspended() const { return m_isCaretBlinkingSuspended; }
220
221     // Focus
222     void setFocused(bool);
223     bool isFocused() const { return m_focused; }
224     bool isFocusedAndActive() const;
225     void pageActivationChanged();
226
227     // Painting.
228     void updateAppearance();
229
230 #ifndef NDEBUG
231     void formatForDebugger(char* buffer, unsigned length) const;
232     void showTreeForThis() const;
233 #endif
234
235     bool shouldChangeSelection(const VisibleSelection&) const;
236     bool shouldDeleteSelection(const VisibleSelection&) const;
237     enum EndPointsAdjustmentMode { AdjustEndpointsAtBidiBoundary, DoNotAdjsutEndpoints };
238     void setNonDirectionalSelectionIfNeeded(const VisibleSelection&, TextGranularity, EndPointsAdjustmentMode = DoNotAdjsutEndpoints);
239     void notifyRendererOfSelectionChange(EUserTriggered);
240
241     void paintDragCaret(GraphicsContext*, const LayoutPoint&, const LayoutRect& clipRect) const;
242
243     EditingStyle* typingStyle() const;
244     PassRefPtr<MutableStylePropertySet> copyTypingStyle() const;
245     void setTypingStyle(PassRefPtr<EditingStyle>);
246     void clearTypingStyle();
247
248     FloatRect bounds(bool clipToVisibleContent = true) const;
249
250     void getClippedVisibleTextRectangles(Vector<FloatRect>&) const;
251
252     HTMLFormElement* currentForm() const;
253
254     void revealSelection(const ScrollAlignment& = ScrollAlignment::alignCenterIfNeeded, RevealExtentOption = DoNotRevealExtent);
255     void setSelectionFromNone();
256
257     bool shouldShowBlockCursor() const { return m_shouldShowBlockCursor; }
258     void setShouldShowBlockCursor(bool);
259
260 private:
261     enum EPositionType { START, END, BASE, EXTENT };
262
263     void respondToNodeModification(Node*, bool baseRemoved, bool extentRemoved, bool startRemoved, bool endRemoved);
264     TextDirection directionOfEnclosingBlock();
265     TextDirection directionOfSelection();
266
267     VisiblePosition positionForPlatform(bool isGetStart) const;
268     VisiblePosition startForPlatform() const;
269     VisiblePosition endForPlatform() const;
270     VisiblePosition nextWordPositionForPlatform(const VisiblePosition&);
271
272     VisiblePosition modifyExtendingRight(TextGranularity);
273     VisiblePosition modifyExtendingForward(TextGranularity);
274     VisiblePosition modifyMovingRight(TextGranularity);
275     VisiblePosition modifyMovingForward(TextGranularity);
276     VisiblePosition modifyExtendingLeft(TextGranularity);
277     VisiblePosition modifyExtendingBackward(TextGranularity);
278     VisiblePosition modifyMovingLeft(TextGranularity);
279     VisiblePosition modifyMovingBackward(TextGranularity);
280
281     LayoutUnit lineDirectionPointForBlockDirectionNavigation(EPositionType);
282
283 #if HAVE(ACCESSIBILITY)
284     void notifyAccessibilityForSelectionChange();
285 #endif
286
287     void setFocusedElementIfNeeded();
288     void focusedOrActiveStateChanged();
289
290     void caretBlinkTimerFired(Timer<FrameSelection>*);
291
292     void setCaretVisibility(CaretVisibility);
293
294     bool dispatchSelectStart();
295   
296     bool visualWordMovementEnabled() const;
297
298     Frame* m_frame;
299
300     LayoutUnit m_xPosForVerticalArrowNavigation;
301
302     VisibleSelection m_selection;
303     VisiblePosition m_originalBase; // Used to store base before the adjustment at bidi boundary
304     TextGranularity m_granularity;
305
306     RefPtr<Node> m_previousCaretNode; // The last node which painted the caret. Retained for clearing the old caret when it moves.
307
308     RefPtr<EditingStyle> m_typingStyle;
309
310     Timer<FrameSelection> m_caretBlinkTimer;
311     // The painted bounds of the caret in absolute coordinates
312     IntRect m_absCaretBounds;
313     bool m_absCaretBoundsDirty : 1;
314     bool m_caretPaint : 1;
315     bool m_isCaretBlinkingSuspended : 1;
316     bool m_focused : 1;
317     bool m_shouldShowBlockCursor : 1;
318 };
319
320 inline EditingStyle* FrameSelection::typingStyle() const
321 {
322     return m_typingStyle.get();
323 }
324
325 inline void FrameSelection::clearTypingStyle()
326 {
327     m_typingStyle.clear();
328 }
329
330 inline void FrameSelection::setTypingStyle(PassRefPtr<EditingStyle> style)
331 {
332     m_typingStyle = style;
333 }
334
335 #if !(PLATFORM(MAC) || PLATFORM(GTK) || PLATFORM(EFL))
336 #if HAVE(ACCESSIBILITY)
337 inline void FrameSelection::notifyAccessibilityForSelectionChange()
338 {
339 }
340 #endif
341 #endif
342
343 } // namespace WebCore
344
345 #ifndef NDEBUG
346 // Outside the WebCore namespace for ease of invocation from gdb.
347 void showTree(const WebCore::FrameSelection&);
348 void showTree(const WebCore::FrameSelection*);
349 #endif
350
351 #endif // FrameSelection_h