1 /* 2 * Copyright (C) 2004 Apple Computer, 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 VisibleSelection_h 27 #define VisibleSelection_h 28 29 #include "core/editing/TextGranularity.h" 30 #include "core/editing/VisiblePosition.h" 31 32 namespace WebCore { 33 34 class LayoutPoint; 35 class Position; 36 37 const EAffinity SEL_DEFAULT_AFFINITY = DOWNSTREAM; 38 enum SelectionDirection { DirectionForward, DirectionBackward, DirectionRight, DirectionLeft }; 39 40 class VisibleSelection { 41 public: 42 enum SelectionType { NoSelection, CaretSelection, RangeSelection }; 43 44 VisibleSelection(); 45 46 VisibleSelection(const Position&, EAffinity, bool isDirectional = false); 47 VisibleSelection(const Position&, const Position&, EAffinity = SEL_DEFAULT_AFFINITY, bool isDirectional = false); 48 49 VisibleSelection(const Range*, EAffinity = SEL_DEFAULT_AFFINITY, bool isDirectional = false); 50 51 VisibleSelection(const VisiblePosition&, bool isDirectional = false); 52 VisibleSelection(const VisiblePosition&, const VisiblePosition&, bool isDirectional = false); 53 54 static VisibleSelection selectionFromContentsOfNode(Node*); 55 56 SelectionType selectionType() const { return m_selectionType; } 57 58 void setAffinity(EAffinity affinity) { m_affinity = affinity; } 59 EAffinity affinity() const { return m_affinity; } 60 61 void setBase(const Position&); 62 void setBase(const VisiblePosition&); 63 void setExtent(const Position&); 64 void setExtent(const VisiblePosition&); 65 66 Position base() const { return m_base; } 67 Position extent() const { return m_extent; } 68 Position start() const { return m_start; } 69 Position end() const { return m_end; } 70 71 VisiblePosition visibleStart() const { return VisiblePosition(m_start, isRange() ? DOWNSTREAM : affinity()); } 72 VisiblePosition visibleEnd() const { return VisiblePosition(m_end, isRange() ? UPSTREAM : affinity()); } 73 VisiblePosition visibleBase() const { return VisiblePosition(m_base, isRange() ? (isBaseFirst() ? UPSTREAM : DOWNSTREAM) : affinity()); } 74 VisiblePosition visibleExtent() const { return VisiblePosition(m_extent, isRange() ? (isBaseFirst() ? DOWNSTREAM : UPSTREAM) : affinity()); } 75 76 bool isNone() const { return selectionType() == NoSelection; } 77 bool isCaret() const { return selectionType() == CaretSelection; } 78 bool isRange() const { return selectionType() == RangeSelection; } 79 bool isCaretOrRange() const { return selectionType() != NoSelection; } 80 bool isNonOrphanedRange() const { return isRange() && !start().isOrphan() && !end().isOrphan(); } 81 bool isNonOrphanedCaretOrRange() const { return isCaretOrRange() && !start().isOrphan() && !end().isOrphan(); } 82 83 bool isBaseFirst() const { return m_baseIsFirst; } 84 bool isDirectional() const { return m_isDirectional; } 85 void setIsDirectional(bool isDirectional) { m_isDirectional = isDirectional; } 86 87 bool isAll(EditingBoundaryCrossingRule) const; 88 89 void appendTrailingWhitespace(); 90 91 bool expandUsingGranularity(TextGranularity granularity); 92 93 // We don't yet support multi-range selections, so we only ever have one range to return. 94 PassRefPtr<Range> firstRange() const; 95 96 // FIXME: Most callers probably don't want this function, but are using it 97 // for historical reasons. toNormalizedRange contracts the range around 98 // text, and moves the caret upstream before returning the range. 99 PassRefPtr<Range> toNormalizedRange() const; 100 101 Element* rootEditableElement() const; 102 bool isContentEditable() const; 103 bool rendererIsEditable() const; 104 bool isContentRichlyEditable() const; 105 // Returns a shadow tree node for legacy shadow trees, a child of the 106 // ShadowRoot node for new shadow trees, or 0 for non-shadow trees. 107 Node* nonBoundaryShadowTreeRootNode() const; 108 109 VisiblePosition visiblePositionRespectingEditingBoundary(const LayoutPoint& localPoint, Node* targetNode) const; 110 111 112 #ifndef NDEBUG 113 void debugPosition() const; 114 void formatForDebugger(char* buffer, unsigned length) const; 115 void showTreeForThis() const; 116 #endif 117 118 void setWithoutValidation(const Position&, const Position&); 119 120 private: 121 void validate(TextGranularity = CharacterGranularity); 122 123 // Support methods for validate() 124 void setBaseAndExtentToDeepEquivalents(); 125 void setStartAndEndFromBaseAndExtentRespectingGranularity(TextGranularity); 126 void adjustSelectionToAvoidCrossingShadowBoundaries(); 127 void adjustSelectionToAvoidCrossingEditingBoundaries(); 128 void updateSelectionType(); 129 130 // We need to store these as Positions because VisibleSelection is 131 // used to store values in editing commands for use when 132 // undoing the command. We need to be able to create a selection that, while currently 133 // invalid, will be valid once the changes are undone. 134 135 Position m_base; // Where the first click happened 136 Position m_extent; // Where the end click happened 137 Position m_start; // Leftmost position when expanded to respect granularity 138 Position m_end; // Rightmost position when expanded to respect granularity 139 140 EAffinity m_affinity; // the upstream/downstream affinity of the caret 141 142 // these are cached, can be recalculated by validate() 143 SelectionType m_selectionType; // None, Caret, Range 144 bool m_baseIsFirst : 1; // True if base is before the extent 145 bool m_isDirectional : 1; // Non-directional ignores m_baseIsFirst and selection always extends on shift + arrow key. 146 }; 147 148 inline bool operator==(const VisibleSelection& a, const VisibleSelection& b) 149 { 150 return a.start() == b.start() && a.end() == b.end() && a.affinity() == b.affinity() && a.isBaseFirst() == b.isBaseFirst() 151 && a.isDirectional() == b.isDirectional(); 152 } 153 154 inline bool operator!=(const VisibleSelection& a, const VisibleSelection& b) 155 { 156 return !(a == b); 157 } 158 159 } // namespace WebCore 160 161 #ifndef NDEBUG 162 // Outside the WebCore namespace for ease of invocation from gdb. 163 void showTree(const WebCore::VisibleSelection&); 164 void showTree(const WebCore::VisibleSelection*); 165 #endif 166 167 #endif // VisibleSelection_h 168
