third_party/WebKit/Source/core/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 "core/CoreExport.h"
  30 #include "core/dom/Range.h"
  31 #include "core/editing/CaretBase.h"
  32 #include "core/editing/EditingStyle.h"
  33 #include "core/editing/EphemeralRange.h"
  34 #include "core/editing/VisiblePosition.h"
  35 #include "core/editing/VisibleSelection.h"
  36 #include "core/layout/ScrollAlignment.h"
  37 #include "platform/Timer.h"
  38 #include "platform/geometry/IntRect.h"
  39 #include "platform/geometry/LayoutRect.h"
  40 #include "platform/heap/Handle.h"
  41 #include "wtf/Noncopyable.h"
  42
  43 namespace blink {
  44
  45 class CharacterData;
  46 class LocalFrame;
  47 class GranularityStrategy;
  48 class GraphicsContext;
  49 class HTMLFormElement;
  50 class SelectionEditor;
  51 class PendingSelection;
  52 class Text;
  53
  54 enum class CursorAlignOnScroll { IfNeeded, Always };
  55
  56 enum EUserTriggered { NotUserTriggered = 0, UserTriggered = 1 };
  57
  58 enum RevealExtentOption {
  59     RevealExtent,
  60     DoNotRevealExtent
  61 };
  62
  63 enum class SelectionDirectionalMode { NonDirectional, Directional };
  64
  65 class CORE_EXPORT FrameSelection final : public NoBaseWillBeGarbageCollectedFinalized<FrameSelection>, private CaretBase {
  66     WTF_MAKE_NONCOPYABLE(FrameSelection);
  67     WTF_MAKE_FAST_ALLOCATED_WILL_BE_REMOVED(FrameSelection);
  68 public:
  69     static PassOwnPtrWillBeRawPtr<FrameSelection> create(LocalFrame* frame = nullptr)
  70     {
  71         return adoptPtrWillBeNoop(new FrameSelection(frame));
  72     }
  73     ~FrameSelection();
  74
  75     enum EAlteration { AlterationMove, AlterationExtend };
  76     enum SetSelectionOption {
  77         // 1 << 0 is reserved for EUserTriggered
  78         CloseTyping = 1 << 1,
  79         ClearTypingStyle = 1 << 2,
  80         SpellCorrectionTriggered = 1 << 3,
  81         DoNotSetFocus = 1 << 4,
  82         DoNotUpdateAppearance = 1 << 5,
  83         DoNotClearStrategy = 1 << 6,
  84     };
  85     typedef unsigned SetSelectionOptions; // Union of values in SetSelectionOption and EUserTriggered
  86     static inline EUserTriggered selectionOptionsToUserTriggered(SetSelectionOptions options)
  87     {
  88         return static_cast<EUserTriggered>(options & UserTriggered);
  89     }
  90
  91     enum ResetCaretBlinkOption {
  92         None,
  93         ResetCaretBlink
  94     };
  95
  96     LocalFrame* frame() const { return m_frame; }
  97     Element* rootEditableElement() const { return selection().rootEditableElement(); }
  98     Element* rootEditableElementOrDocumentElement() const;
  99     ContainerNode* rootEditableElementOrTreeScopeRootNode() const;
 100
 101     bool hasEditableStyle() const { return selection().hasEditableStyle(); }
 102     bool isContentEditable() const { return selection().isContentEditable(); }
 103     bool isContentRichlyEditable() const { return selection().isContentRichlyEditable(); }
 104
 105     void moveTo(const VisiblePosition&, EUserTriggered = NotUserTriggered, CursorAlignOnScroll = CursorAlignOnScroll::IfNeeded);
 106     void moveTo(const VisiblePosition&, const VisiblePosition&, EUserTriggered = NotUserTriggered);
 107     void moveTo(const Position&, TextAffinity, EUserTriggered = NotUserTriggered);
 108
 109     template <typename Strategy>
 110     VisibleSelectionTemplate<Strategy> visibleSelection() const;
 111
 112     const VisibleSelection& selection() const;
 113     void setSelection(const VisibleSelection&, SetSelectionOptions = CloseTyping | ClearTypingStyle, CursorAlignOnScroll = CursorAlignOnScroll::IfNeeded, TextGranularity = CharacterGranularity);
 114     void setSelection(const VisibleSelection& selection, TextGranularity granularity) { setSelection(selection, CloseTyping | ClearTypingStyle, CursorAlignOnScroll::IfNeeded, granularity); }
 115     // TODO(yosin) We should get rid of |Range| version of |setSelectedRagne()|
 116     // for Oilpan.
 117     bool setSelectedRange(Range*, TextAffinity, SelectionDirectionalMode = SelectionDirectionalMode::NonDirectional, SetSelectionOptions = CloseTyping | ClearTypingStyle);
 118     bool setSelectedRange(const EphemeralRange&, TextAffinity, SelectionDirectionalMode = SelectionDirectionalMode::NonDirectional, FrameSelection::SetSelectionOptions = CloseTyping | ClearTypingStyle);
 119     void selectAll();
 120     void clear();
 121     void prepareForDestruction();
 122
 123     // Call this after doing user-triggered selections to make it easy to delete the frame you entirely selected.
 124     void selectFrameElementInParentIfFullySelected();
 125
 126     bool contains(const LayoutPoint&);
 127
 128     SelectionType selectionType() const { return selection().selectionType(); }
 129
 130     TextAffinity affinity() const { return selection().affinity(); }
 131
 132     bool modify(EAlteration, SelectionDirection, TextGranularity, EUserTriggered = NotUserTriggered);
 133     enum VerticalDirection { DirectionUp, DirectionDown };
 134     bool modify(EAlteration, unsigned verticalDistance, VerticalDirection, EUserTriggered = NotUserTriggered, CursorAlignOnScroll = CursorAlignOnScroll::IfNeeded);
 135
 136     // Moves the selection extent based on the selection granularity strategy.
 137     // This function does not allow the selection to collapse. If the new
 138     // extent is resolved to the same position as the current base, this
 139     // function will do nothing.
 140     void moveRangeSelectionExtent(const IntPoint&);
 141     void moveRangeSelection(const VisiblePosition& base, const VisiblePosition& extent, TextGranularity);
 142
 143     TextGranularity granularity() const { return m_granularity; }
 144
 145     void setStart(const VisiblePosition &, EUserTriggered = NotUserTriggered);
 146     void setEnd(const VisiblePosition &, EUserTriggered = NotUserTriggered);
 147
 148     void setBase(const VisiblePosition&, EUserTriggered = NotUserTriggered);
 149     void setExtent(const VisiblePosition&, EUserTriggered = NotUserTriggered);
 150
 151     Position base() const { return selection().base(); }
 152     Position extent() const { return selection().extent(); }
 153     Position start() const { return selection().start(); }
 154     Position end() const { return selection().end(); }
 155
 156     // Return the layoutObject that is responsible for painting the caret (in the selection start node)
 157     LayoutBlock* caretLayoutObject() const;
 158
 159     // Bounds of (possibly transformed) caret in absolute coords
 160     IntRect absoluteCaretBounds();
 161
 162     void didChangeFocus();
 163
 164     bool isNone() const { return selection().isNone(); }
 165     bool isCaret() const { return selection().isCaret(); }
 166     bool isRange() const { return selection().isRange(); }
 167     bool isCaretOrRange() const { return selection().isCaretOrRange(); }
 168     bool isInPasswordField() const;
 169     bool isDirectional() const { return selection().isDirectional(); }
 170
 171     // If this FrameSelection has a logical range which is still valid, this function return its clone. Otherwise,
 172     // the return value from underlying VisibleSelection's firstRange() is returned.
 173     PassRefPtrWillBeRawPtr<Range> firstRange() const;
 174
 175     void nodeWillBeRemoved(Node&);
 176     void didUpdateCharacterData(CharacterData*, unsigned offset, unsigned oldLength, unsigned newLength);
 177     void didMergeTextNodes(const Text& oldNode, unsigned offset);
 178     void didSplitTextNode(const Text& oldNode);
 179
 180     bool isApperanceDirty() const;
 181     void commitAppearanceIfNeeded(LayoutView&);
 182     void updateAppearance(ResetCaretBlinkOption = None);
 183     void setCaretVisible(bool caretIsVisible) { setCaretVisibility(caretIsVisible ? Visible : Hidden); }
 184     bool isCaretBoundsDirty() const { return m_caretRectDirty; }
 185     void setCaretRectNeedsUpdate();
 186     void scheduleVisualUpdate() const;
 187     void invalidateCaretRect();
 188     void paintCaret(GraphicsContext*, const LayoutPoint&, const LayoutRect& clipRect);
 189     bool ShouldPaintCaretForTesting() const { return m_shouldPaintCaret; }
 190
 191     // Used to suspend caret blinking while the mouse is down.
 192     void setCaretBlinkingSuspended(bool suspended) { m_isCaretBlinkingSuspended = suspended; }
 193     bool isCaretBlinkingSuspended() const { return m_isCaretBlinkingSuspended; }
 194
 195     // Focus
 196     void setFocused(bool);
 197     bool isFocused() const { return m_focused; }
 198     bool isFocusedAndActive() const;
 199     void pageActivationChanged();
 200
 201     void updateSecureKeyboardEntryIfActive();
 202
 203     // Returns true if a word is selected.
 204     bool selectWordAroundPosition(const VisiblePosition&);
 205
 206 #ifndef NDEBUG
 207     void formatForDebugger(char* buffer, unsigned length) const;
 208     void showTreeForThis() const;
 209 #endif
 210
 211     enum EndPointsAdjustmentMode { AdjustEndpointsAtBidiBoundary, DoNotAdjsutEndpoints };
 212     void setNonDirectionalSelectionIfNeeded(const VisibleSelection&, TextGranularity, EndPointsAdjustmentMode = DoNotAdjsutEndpoints);
 213     void setFocusedNodeIfNeeded();
 214     void notifyLayoutObjectOfSelectionChange(EUserTriggered);
 215
 216     EditingStyle* typingStyle() const;
 217     void setTypingStyle(PassRefPtrWillBeRawPtr<EditingStyle>);
 218     void clearTypingStyle();
 219
 220     String selectedHTMLForClipboard() const;
 221     String selectedText() const;
 222     String selectedTextForClipboard() const;
 223
 224     // The bounds are clipped to the viewport as this is what callers expect.
 225     LayoutRect bounds() const;
 226     LayoutRect unclippedBounds() const;
 227
 228     HTMLFormElement* currentForm() const;
 229
 230     void revealSelection(const ScrollAlignment& = ScrollAlignment::alignCenterIfNeeded, RevealExtentOption = DoNotRevealExtent);
 231     void setSelectionFromNone();
 232
 233     bool shouldShowBlockCursor() const { return m_shouldShowBlockCursor; }
 234     void setShouldShowBlockCursor(bool);
 235
 236     DECLARE_VIRTUAL_TRACE();
 237
 238 private:
 239     explicit FrameSelection(LocalFrame*);
 240
 241     template <typename Strategy>
 242     VisiblePositionTemplate<Strategy> originalBase() const;
 243     void setOriginalBase(const VisiblePosition& newBase) { m_originalBase = newBase; }
 244     void setOriginalBase(const VisiblePositionInComposedTree&);
 245
 246     template <typename Strategy>
 247     bool containsAlgorithm(const LayoutPoint&);
 248
 249     template <typename Strategy>
 250     void setNonDirectionalSelectionIfNeededAlgorithm(const VisibleSelectionTemplate<Strategy>&, TextGranularity, EndPointsAdjustmentMode);
 251
 252     void respondToNodeModification(Node&, bool baseRemoved, bool extentRemoved, bool startRemoved, bool endRemoved);
 253
 254     void notifyAccessibilityForSelectionChange();
 255     void notifyCompositorForSelectionChange();
 256     void notifyEventHandlerForSelectionChange();
 257
 258     void focusedOrActiveStateChanged();
 259
 260     void caretBlinkTimerFired(Timer<FrameSelection>*);
 261
 262     void setUseSecureKeyboardEntry(bool);
 263
 264     void setCaretVisibility(CaretVisibility);
 265     bool shouldBlinkCaret() const;
 266
 267     void updateSelectionIfNeeded(const Position& base, const Position& extent, const Position& start, const Position& end);
 268
 269     VisibleSelection validateSelection(const VisibleSelection&);
 270
 271     GranularityStrategy* granularityStrategy();
 272
 273     RawPtrWillBeMember<LocalFrame> m_frame;
 274     const OwnPtrWillBeMember<PendingSelection> m_pendingSelection;
 275     const OwnPtrWillBeMember<SelectionEditor> m_selectionEditor;
 276
 277     VisiblePosition m_originalBase; // Used to store base before the adjustment at bidi boundary
 278     TextGranularity m_granularity;
 279
 280     RefPtrWillBeMember<Node> m_previousCaretNode; // The last node which painted the caret. Retained for clearing the old caret when it moves.
 281     LayoutRect m_previousCaretRect;
 282     CaretVisibility m_previousCaretVisibility;
 283
 284     RefPtrWillBeMember<EditingStyle> m_typingStyle;
 285
 286     Timer<FrameSelection> m_caretBlinkTimer;
 287
 288     bool m_caretRectDirty : 1;
 289     bool m_shouldPaintCaret : 1;
 290     bool m_isCaretBlinkingSuspended : 1;
 291     bool m_focused : 1;
 292     bool m_shouldShowBlockCursor : 1;
 293
 294     // Controls text granularity used to adjust the selection's extent in moveRangeSelectionExtent.
 295     OwnPtr<GranularityStrategy> m_granularityStrategy;
 296 };
 297
 298 inline EditingStyle* FrameSelection::typingStyle() const
 299 {
 300     return m_typingStyle.get();
 301 }
 302
 303 inline void FrameSelection::clearTypingStyle()
 304 {
 305     m_typingStyle.clear();
 306 }
 307
 308 inline void FrameSelection::setTypingStyle(PassRefPtrWillBeRawPtr<EditingStyle> style)
 309 {
 310     m_typingStyle = style;
 311 }
 312 } // namespace blink
 313
 314 #ifndef NDEBUG
 315 // Outside the WebCore namespace for ease of invocation from gdb.
 316 void showTree(const blink::FrameSelection&);
 317 void showTree(const blink::FrameSelection*);
 318 #endif
 319
 320 #endif // FrameSelection_h