2 * Copyright (C) 2004, 2008 Apple 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 VisiblePosition_h
27 #define VisiblePosition_h
29 #include "core/dom/Position.h"
30 #include "core/editing/EditingBoundary.h"
31 #include "platform/text/TextDirection.h"
35 // VisiblePosition default affinity is downstream because
36 // the callers do not really care (they just want the
37 // deep position without regard to line position), and this
38 // is cheaper than UPSTREAM
39 #define VP_DEFAULT_AFFINITY DOWNSTREAM
41 // Callers who do not know where on the line the position is,
42 // but would like UPSTREAM if at a line break or DOWNSTREAM
43 // otherwise, need a clear way to specify that. The
44 // constructors auto-correct UPSTREAM to DOWNSTREAM if the
45 // position is not at a line break.
46 #define VP_UPSTREAM_IF_POSSIBLE UPSTREAM
51 class VisiblePosition {
53 // NOTE: UPSTREAM affinity will be used only if pos is at end of a wrapped line,
54 // otherwise it will be converted to DOWNSTREAM
55 VisiblePosition() : m_affinity(VP_DEFAULT_AFFINITY) { }
56 explicit VisiblePosition(const Position&, EAffinity = VP_DEFAULT_AFFINITY);
57 explicit VisiblePosition(const PositionWithAffinity&);
59 void clear() { m_deepPosition.clear(); }
61 bool isNull() const { return m_deepPosition.isNull(); }
62 bool isNotNull() const { return m_deepPosition.isNotNull(); }
63 bool isOrphan() const { return m_deepPosition.isOrphan(); }
65 Position deepEquivalent() const { return m_deepPosition; }
66 EAffinity affinity() const { ASSERT(m_affinity == UPSTREAM || m_affinity == DOWNSTREAM); return m_affinity; }
67 void setAffinity(EAffinity affinity) { m_affinity = affinity; }
69 // FIXME: Change the following functions' parameter from a boolean to StayInEditableContent.
71 // next() and previous() will increment/decrement by a character cluster.
72 VisiblePosition next(EditingBoundaryCrossingRule = CanCrossEditingBoundary) const;
73 VisiblePosition previous(EditingBoundaryCrossingRule = CanCrossEditingBoundary) const;
74 VisiblePosition honorEditingBoundaryAtOrBefore(const VisiblePosition&) const;
75 VisiblePosition honorEditingBoundaryAtOrAfter(const VisiblePosition&) const;
76 VisiblePosition skipToStartOfEditingBoundary(const VisiblePosition&) const;
77 VisiblePosition skipToEndOfEditingBoundary(const VisiblePosition&) const;
79 VisiblePosition left(bool stayInEditableContent = false) const;
80 VisiblePosition right(bool stayInEditableContent = false) const;
82 UChar32 characterAfter() const;
83 UChar32 characterBefore() const { return previous().characterAfter(); }
85 // FIXME: This does not handle [table, 0] correctly.
86 Element* rootEditableElement() const { return m_deepPosition.isNotNull() ? m_deepPosition.deprecatedNode()->rootEditableElement() : 0; }
88 void getInlineBoxAndOffset(InlineBox*& inlineBox, int& caretOffset) const
90 m_deepPosition.getInlineBoxAndOffset(m_affinity, inlineBox, caretOffset);
93 // Rect is local to the returned renderer
94 LayoutRect localCaretRect(RenderObject*&) const;
95 // Bounds of (possibly transformed) caret in absolute coords
96 IntRect absoluteCaretBounds() const;
97 // Abs x/y position of the caret ignoring transforms.
98 // FIXME: navigation with transforms should be smarter.
99 int lineDirectionPointForBlockDirectionNavigation() const;
102 void debugPosition(const char* msg = "") const;
103 void formatForDebugger(char* buffer, unsigned length) const;
104 void showTreeForThis() const;
108 void init(const Position&, EAffinity);
109 Position canonicalPosition(const Position&);
111 Position leftVisuallyDistinctCandidate() const;
112 Position rightVisuallyDistinctCandidate() const;
114 Position m_deepPosition;
115 EAffinity m_affinity;
118 // FIXME: This shouldn't ignore affinity.
119 inline bool operator==(const VisiblePosition& a, const VisiblePosition& b)
121 return a.deepEquivalent() == b.deepEquivalent();
124 inline bool operator!=(const VisiblePosition& a, const VisiblePosition& b)
129 PassRefPtr<Range> makeRange(const VisiblePosition&, const VisiblePosition&);
130 bool setStart(Range*, const VisiblePosition&);
131 bool setEnd(Range*, const VisiblePosition&);
132 VisiblePosition startVisiblePosition(const Range*, EAffinity);
134 Element* enclosingBlockFlowElement(const VisiblePosition&);
136 bool isFirstVisiblePositionInNode(const VisiblePosition&, const Node*);
137 bool isLastVisiblePositionInNode(const VisiblePosition&, const Node*);
139 } // namespace WebCore
142 // Outside the WebCore namespace for ease of invocation from gdb.
143 void showTree(const WebCore::VisiblePosition*);
144 void showTree(const WebCore::VisiblePosition&);
147 #endif // VisiblePosition_h