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 "core/dom/Range.h" 30 #include "core/editing/Caret.h" 31 #include "core/editing/EditingStyle.h" 32 #include "core/editing/VisibleSelection.h" 33 #include "core/rendering/ScrollBehavior.h" 34 #include "platform/Timer.h" 35 #include "platform/geometry/IntRect.h" 36 #include "platform/geometry/LayoutRect.h" 37 #include "wtf/Noncopyable.h" 38 39 namespace WebCore { 40 41 class CharacterData; 42 class Frame; 43 class GraphicsContext; 44 class HTMLFormElement; 45 class MutableStylePropertySet; 46 class RenderObject; 47 class RenderView; 48 class Settings; 49 class Text; 50 class VisiblePosition; 51 52 enum EUserTriggered { NotUserTriggered = 0, UserTriggered = 1 }; 53 54 enum RevealExtentOption { 55 RevealExtent, 56 DoNotRevealExtent 57 }; 58 59 class FrameSelection : private CaretBase { 60 WTF_MAKE_NONCOPYABLE(FrameSelection); 61 WTF_MAKE_FAST_ALLOCATED; 62 public: 63 enum EAlteration { AlterationMove, AlterationExtend }; 64 enum CursorAlignOnScroll { AlignCursorOnScrollIfNeeded, 65 AlignCursorOnScrollAlways }; 66 enum SetSelectionOption { 67 // 1 << 0 is reserved for EUserTriggered 68 CloseTyping = 1 << 1, 69 ClearTypingStyle = 1 << 2, 70 SpellCorrectionTriggered = 1 << 3, 71 DoNotSetFocus = 1 << 4, 72 DoNotUpdateAppearance = 1 << 5, 73 }; 74 typedef unsigned SetSelectionOptions; // Union of values in SetSelectionOption and EUserTriggered 75 static inline EUserTriggered selectionOptionsToUserTriggered(SetSelectionOptions options) 76 { 77 return static_cast<EUserTriggered>(options & UserTriggered); 78 } 79 80 explicit FrameSelection(Frame* = 0); 81 82 Element* rootEditableElement() const { return m_selection.rootEditableElement(); } 83 Element* rootEditableElementOrDocumentElement() const; 84 Node* rootEditableElementOrTreeScopeRootNode() const; 85 86 bool rendererIsEditable() const { return m_selection.rendererIsEditable(); } 87 bool isContentEditable() const { return m_selection.isContentEditable(); } 88 bool isContentRichlyEditable() const { return m_selection.isContentRichlyEditable(); } 89 90 void moveTo(const Range*, EAffinity, EUserTriggered = NotUserTriggered); 91 void moveTo(const VisiblePosition&, EUserTriggered = NotUserTriggered, CursorAlignOnScroll = AlignCursorOnScrollIfNeeded); 92 void moveTo(const VisiblePosition&, const VisiblePosition&, EUserTriggered = NotUserTriggered); 93 void moveTo(const Position&, EAffinity, EUserTriggered = NotUserTriggered); 94 void moveTo(const Position&, const Position&, EAffinity, EUserTriggered = NotUserTriggered); 95 96 const VisibleSelection& selection() const { return m_selection; } 97 void setSelection(const VisibleSelection&, SetSelectionOptions = CloseTyping | ClearTypingStyle, CursorAlignOnScroll = AlignCursorOnScrollIfNeeded, TextGranularity = CharacterGranularity); 98 void setSelection(const VisibleSelection& selection, TextGranularity granularity) { setSelection(selection, CloseTyping | ClearTypingStyle, AlignCursorOnScrollIfNeeded, granularity); } 99 bool setSelectedRange(Range*, EAffinity, bool closeTyping); 100 void selectAll(); 101 void clear(); 102 void prepareForDestruction(); 103 104 // Call this after doing user-triggered selections to make it easy to delete the frame you entirely selected. 105 void selectFrameElementInParentIfFullySelected(); 106 107 bool contains(const LayoutPoint&); 108 109 SelectionType selectionType() const { return m_selection.selectionType(); } 110 111 EAffinity affinity() const { return m_selection.affinity(); } 112 113 bool modify(EAlteration, SelectionDirection, TextGranularity, EUserTriggered = NotUserTriggered); 114 enum VerticalDirection { DirectionUp, DirectionDown }; 115 bool modify(EAlteration, unsigned verticalDistance, VerticalDirection, EUserTriggered = NotUserTriggered, CursorAlignOnScroll = AlignCursorOnScrollIfNeeded); 116 117 TextGranularity granularity() const { return m_granularity; } 118 119 void setStart(const VisiblePosition &, EUserTriggered = NotUserTriggered); 120 void setEnd(const VisiblePosition &, EUserTriggered = NotUserTriggered); 121 122 void setBase(const VisiblePosition&, EUserTriggered = NotUserTriggered); 123 void setBase(const Position&, EAffinity, EUserTriggered = NotUserTriggered); 124 void setExtent(const VisiblePosition&, EUserTriggered = NotUserTriggered); 125 void setExtent(const Position&, EAffinity, EUserTriggered = NotUserTriggered); 126 127 Position base() const { return m_selection.base(); } 128 Position extent() const { return m_selection.extent(); } 129 Position start() const { return m_selection.start(); } 130 Position end() const { return m_selection.end(); } 131 132 // Return the renderer that is responsible for painting the caret (in the selection start node) 133 RenderObject* caretRenderer() const; 134 135 // Caret rect local to the caret's renderer 136 LayoutRect localCaretRect(); 137 138 // Bounds of (possibly transformed) caret in absolute coords 139 IntRect absoluteCaretBounds(); 140 void setCaretRectNeedsUpdate() { CaretBase::setCaretRectNeedsUpdate(); } 141 142 void didChangeFocus(); 143 void willBeModified(EAlteration, SelectionDirection); 144 145 bool isNone() const { return m_selection.isNone(); } 146 bool isCaret() const { return m_selection.isCaret(); } 147 bool isRange() const { return m_selection.isRange(); } 148 bool isCaretOrRange() const { return m_selection.isCaretOrRange(); } 149 bool isInPasswordField() const; 150 bool isAll(EditingBoundaryCrossingRule rule = CannotCrossEditingBoundary) const { return m_selection.isAll(rule); } 151 152 PassRefPtr<Range> toNormalizedRange() const { return m_selection.toNormalizedRange(); } 153 154 void nodeWillBeRemoved(Node&); 155 void didUpdateCharacterData(CharacterData*, unsigned offset, unsigned oldLength, unsigned newLength); 156 void didMergeTextNodes(const Text& oldNode, unsigned offset); 157 void didSplitTextNode(const Text& oldNode); 158 159 void setCaretVisible(bool caretIsVisible) { setCaretVisibility(caretIsVisible ? Visible : Hidden); } 160 bool recomputeCaretRect(); 161 void invalidateCaretRect(); 162 void paintCaret(GraphicsContext*, const LayoutPoint&, const LayoutRect& clipRect); 163 164 // Used to suspend caret blinking while the mouse is down. 165 void setCaretBlinkingSuspended(bool suspended) { m_isCaretBlinkingSuspended = suspended; } 166 bool isCaretBlinkingSuspended() const { return m_isCaretBlinkingSuspended; } 167 168 // Focus 169 void setFocused(bool); 170 bool isFocused() const { return m_focused; } 171 bool isFocusedAndActive() const; 172 void pageActivationChanged(); 173 174 // Painting. 175 void updateAppearance(); 176 177 void updateSecureKeyboardEntryIfActive(); 178 179 #ifndef NDEBUG 180 void formatForDebugger(char* buffer, unsigned length) const; 181 void showTreeForThis() const; 182 #endif 183 184 enum EndPointsAdjustmentMode { AdjustEndpointsAtBidiBoundary, DoNotAdjsutEndpoints }; 185 void setNonDirectionalSelectionIfNeeded(const VisibleSelection&, TextGranularity, EndPointsAdjustmentMode = DoNotAdjsutEndpoints); 186 void setFocusedNodeIfNeeded(); 187 void notifyRendererOfSelectionChange(EUserTriggered); 188 189 void paintDragCaret(GraphicsContext*, const LayoutPoint&, const LayoutRect& clipRect) const; 190 191 EditingStyle* typingStyle() const; 192 PassRefPtr<MutableStylePropertySet> copyTypingStyle() const; 193 void setTypingStyle(PassRefPtr<EditingStyle>); 194 void clearTypingStyle(); 195 196 String selectedText() const; 197 String selectedTextForClipboard() const; 198 199 FloatRect bounds(bool clipToVisibleContent = true) const; 200 201 HTMLFormElement* currentForm() const; 202 203 void revealSelection(const ScrollAlignment& = ScrollAlignment::alignCenterIfNeeded, RevealExtentOption = DoNotRevealExtent); 204 void setSelectionFromNone(); 205 206 bool shouldShowBlockCursor() const { return m_shouldShowBlockCursor; } 207 void setShouldShowBlockCursor(bool); 208 209 private: 210 enum EPositionType { START, END, BASE, EXTENT }; 211 212 void respondToNodeModification(Node&, bool baseRemoved, bool extentRemoved, bool startRemoved, bool endRemoved); 213 TextDirection directionOfEnclosingBlock(); 214 TextDirection directionOfSelection(); 215 216 VisiblePosition positionForPlatform(bool isGetStart) const; 217 VisiblePosition startForPlatform() const; 218 VisiblePosition endForPlatform() const; 219 VisiblePosition nextWordPositionForPlatform(const VisiblePosition&); 220 221 VisiblePosition modifyExtendingRight(TextGranularity); 222 VisiblePosition modifyExtendingForward(TextGranularity); 223 VisiblePosition modifyMovingRight(TextGranularity); 224 VisiblePosition modifyMovingForward(TextGranularity); 225 VisiblePosition modifyExtendingLeft(TextGranularity); 226 VisiblePosition modifyExtendingBackward(TextGranularity); 227 VisiblePosition modifyMovingLeft(TextGranularity); 228 VisiblePosition modifyMovingBackward(TextGranularity); 229 230 LayoutUnit lineDirectionPointForBlockDirectionNavigation(EPositionType); 231 232 void notifyAccessibilityForSelectionChange(); 233 234 void focusedOrActiveStateChanged(); 235 236 void caretBlinkTimerFired(Timer<FrameSelection>*); 237 238 void setUseSecureKeyboardEntry(bool); 239 240 void setCaretVisibility(CaretVisibility); 241 bool shouldBlinkCaret() const; 242 243 bool dispatchSelectStart(); 244 245 void updateSelectionIfNeeded(const Position& base, const Position& extent, const Position& start, const Position& end); 246 247 Frame* m_frame; 248 249 LayoutUnit m_xPosForVerticalArrowNavigation; 250 251 VisibleSelection m_selection; 252 VisiblePosition m_originalBase; // Used to store base before the adjustment at bidi boundary 253 TextGranularity m_granularity; 254 255 RefPtr<Node> m_previousCaretNode; // The last node which painted the caret. Retained for clearing the old caret when it moves. 256 257 RefPtr<EditingStyle> m_typingStyle; 258 259 Timer<FrameSelection> m_caretBlinkTimer; 260 // The painted bounds of the caret in absolute coordinates 261 IntRect m_absCaretBounds; 262 bool m_absCaretBoundsDirty : 1; 263 bool m_caretPaint : 1; 264 bool m_isCaretBlinkingSuspended : 1; 265 bool m_focused : 1; 266 bool m_shouldShowBlockCursor : 1; 267 }; 268 269 inline EditingStyle* FrameSelection::typingStyle() const 270 { 271 return m_typingStyle.get(); 272 } 273 274 inline void FrameSelection::clearTypingStyle() 275 { 276 m_typingStyle.clear(); 277 } 278 279 inline void FrameSelection::setTypingStyle(PassRefPtr<EditingStyle> style) 280 { 281 m_typingStyle = style; 282 } 283 } // namespace WebCore 284 285 #ifndef NDEBUG 286 // Outside the WebCore namespace for ease of invocation from gdb. 287 void showTree(const WebCore::FrameSelection&); 288 void showTree(const WebCore::FrameSelection*); 289 #endif 290 291 #endif // FrameSelection_h 292
