Home | History | Annotate | Download | only in editing 
      1 /*
      2  * Copyright (C) 2011 Google 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 are
      6  * met:
      7  *
      8  *     * Redistributions of source code must retain the above copyright
      9  * notice, this list of conditions and the following disclaimer.
     10  *     * Redistributions in binary form must reproduce the above
     11  * copyright notice, this list of conditions and the following disclaimer
     12  * in the documentation and/or other materials provided with the
     13  * distribution.
     14  *     * Neither the name of Google Inc. nor the names of its
     15  * contributors may be used to endorse or promote products derived from
     16  * this software without specific prior written permission.
     17  *
     18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     29  */
     30 
     31 #ifndef RenderedPosition_h
     32 #define RenderedPosition_h
     33 
     34 #include "core/editing/TextAffinity.h"
     35 #include "core/rendering/InlineBox.h"
     36 
     37 namespace WebCore {
     38 
     39 class LayoutUnit;
     40 class Position;
     41 class RenderObject;
     42 class VisiblePosition;
     43 
     44 class RenderedPosition {
     45 public:
     46     RenderedPosition();
     47     explicit RenderedPosition(const VisiblePosition&);
     48     explicit RenderedPosition(const Position&, EAffinity);
     49     bool isEquivalent(const RenderedPosition&) const;
     50 
     51     bool isNull() const { return !m_renderer; }
     52     RootInlineBox* rootBox() { return m_inlineBox ? m_inlineBox->root() : 0; }
     53 
     54     unsigned char bidiLevelOnLeft() const;
     55     unsigned char bidiLevelOnRight() const;
     56     RenderedPosition leftBoundaryOfBidiRun(unsigned char bidiLevelOfRun);
     57     RenderedPosition rightBoundaryOfBidiRun(unsigned char bidiLevelOfRun);
     58 
     59     enum ShouldMatchBidiLevel { MatchBidiLevel, IgnoreBidiLevel };
     60     bool atLeftBoundaryOfBidiRun() const { return atLeftBoundaryOfBidiRun(IgnoreBidiLevel, 0); }
     61     bool atRightBoundaryOfBidiRun() const { return atRightBoundaryOfBidiRun(IgnoreBidiLevel, 0); }
     62     // The following two functions return true only if the current position is at the end of the bidi run
     63     // of the specified bidi embedding level.
     64     bool atLeftBoundaryOfBidiRun(unsigned char bidiLevelOfRun) const { return atLeftBoundaryOfBidiRun(MatchBidiLevel, bidiLevelOfRun); }
     65     bool atRightBoundaryOfBidiRun(unsigned char bidiLevelOfRun) const { return atRightBoundaryOfBidiRun(MatchBidiLevel, bidiLevelOfRun); }
     66 
     67     Position positionAtLeftBoundaryOfBiDiRun() const;
     68     Position positionAtRightBoundaryOfBiDiRun() const;
     69 
     70     IntRect absoluteRect(LayoutUnit* extraWidthToEndOfLine = 0) const;
     71 
     72 private:
     73     bool operator==(const RenderedPosition&) const { return false; }
     74     explicit RenderedPosition(RenderObject*, InlineBox*, int offset);
     75 
     76     InlineBox* prevLeafChild() const;
     77     InlineBox* nextLeafChild() const;
     78     bool atLeftmostOffsetInBox() const { return m_inlineBox && m_offset == m_inlineBox->caretLeftmostOffset(); }
     79     bool atRightmostOffsetInBox() const { return m_inlineBox && m_offset == m_inlineBox->caretRightmostOffset(); }
     80     bool atLeftBoundaryOfBidiRun(ShouldMatchBidiLevel, unsigned char bidiLevelOfRun) const;
     81     bool atRightBoundaryOfBidiRun(ShouldMatchBidiLevel, unsigned char bidiLevelOfRun) const;
     82 
     83     RenderObject* m_renderer;
     84     InlineBox* m_inlineBox;
     85     int m_offset;
     86 
     87     static InlineBox* uncachedInlineBox() { return reinterpret_cast<InlineBox*>(1); }
     88     // Needs to be different form 0 so pick 1 because it's also on the null page.
     89 
     90     mutable InlineBox* m_prevLeafChild;
     91     mutable InlineBox* m_nextLeafChild;
     92 };
     93 
     94 inline RenderedPosition::RenderedPosition()
     95     : m_renderer(0)
     96     , m_inlineBox(0)
     97     , m_offset(0)
     98     , m_prevLeafChild(uncachedInlineBox())
     99     , m_nextLeafChild(uncachedInlineBox())
    100 {
    101 }
    102 
    103 inline RenderedPosition::RenderedPosition(RenderObject* renderer, InlineBox* box, int offset)
    104     : m_renderer(renderer)
    105     , m_inlineBox(box)
    106     , m_offset(offset)
    107     , m_prevLeafChild(uncachedInlineBox())
    108     , m_nextLeafChild(uncachedInlineBox())
    109 {
    110 }
    111 
    112 bool renderObjectContainsPosition(RenderObject*, const Position&);
    113 
    114 };
    115 
    116 #endif // RenderedPosition_h
    117