src/third_party/WebKit/Source/core/editing/VisiblePosition.h

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