2 * Copyright (C) 2004 Apple Computer, Inc. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
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.
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.
26 #ifndef VisibleSelection_h
27 #define VisibleSelection_h
29 #include "TextGranularity.h"
30 #include "VisiblePosition.h"
36 const EAffinity SEL_DEFAULT_AFFINITY = DOWNSTREAM;
38 class VisibleSelection {
40 enum SelectionType { NoSelection, CaretSelection, RangeSelection };
44 VisibleSelection(const Position&, EAffinity);
45 VisibleSelection(const Position&, const Position&, EAffinity = SEL_DEFAULT_AFFINITY);
47 VisibleSelection(const Range*, EAffinity = SEL_DEFAULT_AFFINITY);
49 VisibleSelection(const VisiblePosition&);
50 VisibleSelection(const VisiblePosition&, const VisiblePosition&);
52 static VisibleSelection selectionFromContentsOfNode(Node*);
54 SelectionType selectionType() const { return m_selectionType; }
56 void setAffinity(EAffinity affinity) { m_affinity = affinity; }
57 EAffinity affinity() const { return m_affinity; }
59 void setBase(const Position&);
60 void setBase(const VisiblePosition&);
61 void setExtent(const Position&);
62 void setExtent(const VisiblePosition&);
64 Position base() const { return m_base; }
65 Position extent() const { return m_extent; }
66 Position start() const { return m_start; }
67 Position end() const { return m_end; }
69 VisiblePosition visibleStart() const { return VisiblePosition(m_start, isRange() ? DOWNSTREAM : affinity()); }
70 VisiblePosition visibleEnd() const { return VisiblePosition(m_end, isRange() ? UPSTREAM : affinity()); }
72 bool isNone() const { return selectionType() == NoSelection; }
73 bool isCaret() const { return selectionType() == CaretSelection; }
74 bool isRange() const { return selectionType() == RangeSelection; }
75 bool isCaretOrRange() const { return selectionType() != NoSelection; }
76 bool isNonOrphanedRange() const { return isRange() && !start().isOrphan() && !end().isOrphan(); }
77 bool isNonOrphanedCaretOrRange() const { return isCaretOrRange() && !start().isOrphan() && !end().isOrphan(); }
79 bool isBaseFirst() const { return m_baseIsFirst; }
81 bool isAll(StayInEditableContent) const;
83 void appendTrailingWhitespace();
85 bool expandUsingGranularity(TextGranularity granularity);
87 // We don't yet support multi-range selections, so we only ever have one range to return.
88 PassRefPtr<Range> firstRange() const;
90 // FIXME: Most callers probably don't want this function, but are using it
91 // for historical reasons. toNormalizedRange contracts the range around
92 // text, and moves the caret upstream before returning the range.
93 PassRefPtr<Range> toNormalizedRange() const;
95 Element* rootEditableElement() const;
96 bool isContentEditable() const;
97 bool isContentRichlyEditable() const;
98 Node* shadowTreeRootNode() const;
100 void debugPosition() const;
103 void formatForDebugger(char* buffer, unsigned length) const;
104 void showTreeForThis() const;
107 void setWithoutValidation(const Position&, const Position&);
110 void validate(TextGranularity = CharacterGranularity);
112 // Support methods for validate()
113 void setBaseAndExtentToDeepEquivalents();
114 void setStartAndEndFromBaseAndExtentRespectingGranularity(TextGranularity);
115 void adjustSelectionToAvoidCrossingEditingBoundaries();
116 void updateSelectionType();
118 // We need to store these as Positions because VisibleSelection is
119 // used to store values in editing commands for use when
120 // undoing the command. We need to be able to create a selection that, while currently
121 // invalid, will be valid once the changes are undone.
123 Position m_base; // Where the first click happened
124 Position m_extent; // Where the end click happened
125 Position m_start; // Leftmost position when expanded to respect granularity
126 Position m_end; // Rightmost position when expanded to respect granularity
128 EAffinity m_affinity; // the upstream/downstream affinity of the caret
130 // these are cached, can be recalculated by validate()
131 SelectionType m_selectionType; // None, Caret, Range
132 bool m_baseIsFirst; // true if base is before the extent
135 inline bool operator==(const VisibleSelection& a, const VisibleSelection& b)
137 return a.start() == b.start() && a.end() == b.end() && a.affinity() == b.affinity() && a.isBaseFirst() == b.isBaseFirst();
140 inline bool operator!=(const VisibleSelection& a, const VisibleSelection& b)
145 } // namespace WebCore
148 // Outside the WebCore namespace for ease of invocation from gdb.
149 void showTree(const WebCore::VisibleSelection&);
150 void showTree(const WebCore::VisibleSelection*);
153 #endif // VisibleSelection_h