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