ff79a98b90e9ba68627a0c2737d381a2c10132e1
[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 "LayoutTypes.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 RenderObject;
45 class RenderView;
46 class Settings;
47 class StylePropertySet;
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     IntRect caretRepaintRect(Node*) const;
69     bool shouldRepaintCaret(const RenderView*, bool isContentEditable) const;
70     void paintCaret(Node*, GraphicsContext*, const LayoutPoint&, const LayoutRect& clipRect) const;
71     RenderObject* caretRenderer(Node*) const;
72
73     const LayoutRect& localCaretRectWithoutUpdate() const { return m_caretLocalRect; }
74
75     bool shouldUpdateCaretRect() const { return m_caretRectNeedsUpdate; }
76     void setCaretRectNeedsUpdate() { m_caretRectNeedsUpdate = true; }
77
78     void setCaretVisibility(CaretVisibility visibility) { m_caretVisibility = visibility; }
79     bool caretIsVisible() const { return m_caretVisibility == Visible; }
80     CaretVisibility caretVisibility() const { return m_caretVisibility; }
81
82 private:
83     LayoutRect m_caretLocalRect; // caret rect in coords local to the renderer responsible for painting the caret
84     bool m_caretRectNeedsUpdate; // true if m_caretRect (and m_absCaretBounds in FrameSelection) need to be calculated
85     CaretVisibility m_caretVisibility;
86 };
87
88 class DragCaretController : private CaretBase {
89     WTF_MAKE_NONCOPYABLE(DragCaretController);
90     WTF_MAKE_FAST_ALLOCATED;
91 public:
92     static PassOwnPtr<DragCaretController> create();
93
94     RenderObject* caretRenderer() const;
95     void paintDragCaret(Frame*, GraphicsContext*, const LayoutPoint&, const LayoutRect& clipRect) const;
96
97     bool isContentEditable() const { return m_position.rootEditableElement(); }
98     bool isContentRichlyEditable() const;
99
100     bool hasCaret() const { return m_position.isNotNull(); }
101     const VisiblePosition& caretPosition() { return m_position; }
102     void setCaretPosition(const VisiblePosition&);
103     void clear() { setCaretPosition(VisiblePosition()); }
104
105     void nodeWillBeRemoved(Node*);
106
107 private:
108     DragCaretController();
109
110     VisiblePosition m_position;
111 };
112
113 class FrameSelection : private CaretBase {
114     WTF_MAKE_NONCOPYABLE(FrameSelection);
115     WTF_MAKE_FAST_ALLOCATED;
116 public:
117     enum EAlteration { AlterationMove, AlterationExtend };
118     enum CursorAlignOnScroll { AlignCursorOnScrollIfNeeded,
119                                AlignCursorOnScrollAlways };
120     enum SetSelectionOption {
121         // 1 << 0 is reserved for EUserTriggered
122         CloseTyping = 1 << 1,
123         ClearTypingStyle = 1 << 2,
124         SpellCorrectionTriggered = 1 << 3,
125         DoNotSetFocus = 1 << 4,
126         DictationTriggered = 1 << 5
127     };
128     typedef unsigned SetSelectionOptions; // Union of values in SetSelectionOption and EUserTriggered
129     static inline EUserTriggered selectionOptionsToUserTriggered(SetSelectionOptions options)
130     {
131         return static_cast<EUserTriggered>(options & UserTriggered);
132     }
133
134     explicit FrameSelection(Frame* = 0);
135
136     Element* rootEditableElement() const { return m_selection.rootEditableElement(); }
137     Element* rootEditableElementOrDocumentElement() const;
138     bool rendererIsEditable() const { return m_selection.rendererIsEditable(); }
139     bool isContentEditable() const { return m_selection.isContentEditable(); }
140     bool isContentRichlyEditable() const { return m_selection.isContentRichlyEditable(); }
141      
142     void moveTo(const Range*, EAffinity, EUserTriggered = NotUserTriggered);
143     void moveTo(const VisiblePosition&, EUserTriggered = NotUserTriggered, CursorAlignOnScroll = AlignCursorOnScrollIfNeeded);
144     void moveTo(const VisiblePosition&, const VisiblePosition&, EUserTriggered = NotUserTriggered);
145     void moveTo(const Position&, EAffinity, EUserTriggered = NotUserTriggered);
146     void moveTo(const Position&, const Position&, EAffinity, EUserTriggered = NotUserTriggered);
147
148     const VisibleSelection& selection() const { return m_selection; }
149     void setSelection(const VisibleSelection&, SetSelectionOptions = CloseTyping | ClearTypingStyle, CursorAlignOnScroll = AlignCursorOnScrollIfNeeded, TextGranularity = CharacterGranularity);
150     void setSelection(const VisibleSelection& selection, TextGranularity granularity) { setSelection(selection, CloseTyping | ClearTypingStyle, AlignCursorOnScrollIfNeeded, granularity); }
151     bool setSelectedRange(Range*, EAffinity, bool closeTyping);
152     void selectAll();
153     void clear();
154     
155     // Call this after doing user-triggered selections to make it easy to delete the frame you entirely selected.
156     void selectFrameElementInParentIfFullySelected();
157
158     bool contains(const LayoutPoint&);
159
160     VisibleSelection::SelectionType selectionType() const { return m_selection.selectionType(); }
161
162     EAffinity affinity() const { return m_selection.affinity(); }
163
164     bool modify(EAlteration, SelectionDirection, TextGranularity, EUserTriggered = NotUserTriggered);
165     enum VerticalDirection { DirectionUp, DirectionDown };
166     bool modify(EAlteration, unsigned verticalDistance, VerticalDirection, EUserTriggered = NotUserTriggered, CursorAlignOnScroll = AlignCursorOnScrollIfNeeded);
167
168     TextGranularity granularity() const { return m_granularity; }
169
170     void setStart(const VisiblePosition &, EUserTriggered = NotUserTriggered);
171     void setEnd(const VisiblePosition &, EUserTriggered = NotUserTriggered);
172     
173     void setBase(const VisiblePosition&, EUserTriggered = NotUserTriggered);
174     void setBase(const Position&, EAffinity, EUserTriggered = NotUserTriggered);
175     void setExtent(const VisiblePosition&, EUserTriggered = NotUserTriggered);
176     void setExtent(const Position&, EAffinity, EUserTriggered = NotUserTriggered);
177
178     Position base() const { return m_selection.base(); }
179     Position extent() const { return m_selection.extent(); }
180     Position start() const { return m_selection.start(); }
181     Position end() const { return m_selection.end(); }
182
183     // Return the renderer that is responsible for painting the caret (in the selection start node)
184     RenderObject* caretRenderer() const;
185
186     // Caret rect local to the caret's renderer
187     LayoutRect localCaretRect();
188
189     // Bounds of (possibly transformed) caret in absolute coords
190     IntRect absoluteCaretBounds();
191     void setCaretRectNeedsUpdate() { CaretBase::setCaretRectNeedsUpdate(); }
192
193     void willBeModified(EAlteration, SelectionDirection);
194
195     bool isNone() const { return m_selection.isNone(); }
196     bool isCaret() const { return m_selection.isCaret(); }
197     bool isRange() const { return m_selection.isRange(); }
198     bool isCaretOrRange() const { return m_selection.isCaretOrRange(); }
199     bool isInPasswordField() const;
200     bool isAll(EditingBoundaryCrossingRule rule = CannotCrossEditingBoundary) const { return m_selection.isAll(rule); }
201     
202     PassRefPtr<Range> toNormalizedRange() const { return m_selection.toNormalizedRange(); }
203
204     void debugRenderer(RenderObject*, bool selected) const;
205
206     void nodeWillBeRemoved(Node*);
207     void textWillBeReplaced(CharacterData*, unsigned offset, unsigned oldLength, unsigned newLength);
208
209     void setCaretVisible(bool caretIsVisible) { setCaretVisibility(caretIsVisible ? Visible : Hidden); }
210     void clearCaretRectIfNeeded();
211     bool recomputeCaretRect();
212     void invalidateCaretRect();
213     void paintCaret(GraphicsContext*, const LayoutPoint&, const LayoutRect& clipRect);
214
215     // Used to suspend caret blinking while the mouse is down.
216     void setCaretBlinkingSuspended(bool suspended) { m_isCaretBlinkingSuspended = suspended; }
217     bool isCaretBlinkingSuspended() const { return m_isCaretBlinkingSuspended; }
218
219     // Focus
220     void setFocused(bool);
221     bool isFocused() const { return m_focused; }
222     bool isFocusedAndActive() const;
223     void pageActivationChanged();
224
225     // Painting.
226     void updateAppearance();
227
228     void updateSecureKeyboardEntryIfActive();
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 setFocusedNodeIfNeeded();
240     void notifyRendererOfSelectionChange(EUserTriggered);
241
242     void paintDragCaret(GraphicsContext*, const LayoutPoint&, const LayoutRect& clipRect) const;
243
244     EditingStyle* typingStyle() const;
245     PassRefPtr<StylePropertySet> copyTypingStyle() const;
246     void setTypingStyle(PassRefPtr<EditingStyle>);
247     void clearTypingStyle();
248
249     FloatRect bounds(bool clipToVisibleContent = true) const;
250
251     void getClippedVisibleTextRectangles(Vector<FloatRect>&) const;
252
253     HTMLFormElement* currentForm() const;
254
255     void revealSelection(const ScrollAlignment& = ScrollAlignment::alignCenterIfNeeded, RevealExtentOption = DoNotRevealExtent);
256     void setSelectionFromNone();
257
258 private:
259     enum EPositionType { START, END, BASE, EXTENT };
260
261     void respondToNodeModification(Node*, bool baseRemoved, bool extentRemoved, bool startRemoved, bool endRemoved);
262     TextDirection directionOfEnclosingBlock();
263     TextDirection directionOfSelection();
264
265     VisiblePosition positionForPlatform(bool isGetStart) const;
266     VisiblePosition startForPlatform() const;
267     VisiblePosition endForPlatform() const;
268
269     VisiblePosition modifyExtendingRight(TextGranularity);
270     VisiblePosition modifyExtendingForward(TextGranularity);
271     VisiblePosition modifyMovingRight(TextGranularity);
272     VisiblePosition modifyMovingForward(TextGranularity);
273     VisiblePosition modifyExtendingLeft(TextGranularity);
274     VisiblePosition modifyExtendingBackward(TextGranularity);
275     VisiblePosition modifyMovingLeft(TextGranularity);
276     VisiblePosition modifyMovingBackward(TextGranularity);
277
278     LayoutUnit lineDirectionPointForBlockDirectionNavigation(EPositionType);
279     
280     void notifyAccessibilityForSelectionChange();
281
282     void focusedOrActiveStateChanged();
283
284     void caretBlinkTimerFired(Timer<FrameSelection>*);
285
286     void setUseSecureKeyboardEntry(bool);
287
288     void setCaretVisibility(CaretVisibility);
289
290     bool dispatchSelectStart();
291   
292     bool visualWordMovementEnabled() const;
293
294     Frame* m_frame;
295
296     LayoutUnit m_xPosForVerticalArrowNavigation;
297
298     VisibleSelection m_selection;
299     VisiblePosition m_originalBase; // Used to store base before the adjustment at bidi boundary
300     TextGranularity m_granularity;
301
302     RefPtr<EditingStyle> m_typingStyle;
303
304     Timer<FrameSelection> m_caretBlinkTimer;
305     // The painted bounds of the caret in absolute coordinates
306     IntRect m_absCaretBounds;
307     // Similar to above, but inflated to ensure proper repaint (see https://bugs.webkit.org/show_bug.cgi?id=19086)
308     IntRect m_absoluteCaretRepaintBounds;
309     bool m_absCaretBoundsDirty : 1;
310     bool m_caretPaint : 1;
311     bool m_isCaretBlinkingSuspended : 1;
312     bool m_focused : 1;
313 };
314
315 inline EditingStyle* FrameSelection::typingStyle() const
316 {
317     return m_typingStyle.get();
318 }
319
320 inline void FrameSelection::clearTypingStyle()
321 {
322     m_typingStyle.clear();
323 }
324
325 inline void FrameSelection::setTypingStyle(PassRefPtr<EditingStyle> style)
326 {
327     m_typingStyle = style;
328 }
329
330 #if !(PLATFORM(MAC) || PLATFORM(GTK) || PLATFORM(CHROMIUM))
331 inline void FrameSelection::notifyAccessibilityForSelectionChange()
332 {
333 }
334 #endif
335
336 } // namespace WebCore
337
338 #ifndef NDEBUG
339 // Outside the WebCore namespace for ease of invocation from gdb.
340 void showTree(const WebCore::FrameSelection&);
341 void showTree(const WebCore::FrameSelection*);
342 #endif
343
344 #endif // FrameSelection_h