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 blink {
38
39 class GraphicsLayer;
40 class LayoutUnit;
41 class Position;
42 class RenderObject;
43 class VisiblePosition;
44 struct CompositedSelectionBound;
45
46 class RenderedPosition {
47 public:
48 RenderedPosition();
49 explicit RenderedPosition(const VisiblePosition&);
50 explicit RenderedPosition(const Position&, EAffinity);
51 bool isEquivalent(const RenderedPosition&) const;
52
isNull()53 bool isNull() const { return !m_renderer; }
rootBox()54 RootInlineBox* rootBox() { return m_inlineBox ? &m_inlineBox->root() : 0; }
55
56 unsigned char bidiLevelOnLeft() const;
57 unsigned char bidiLevelOnRight() const;
58 RenderedPosition leftBoundaryOfBidiRun(unsigned char bidiLevelOfRun);
59 RenderedPosition rightBoundaryOfBidiRun(unsigned char bidiLevelOfRun);
60
61 enum ShouldMatchBidiLevel { MatchBidiLevel, IgnoreBidiLevel };
atLeftBoundaryOfBidiRun()62 bool atLeftBoundaryOfBidiRun() const { return atLeftBoundaryOfBidiRun(IgnoreBidiLevel, 0); }
atRightBoundaryOfBidiRun()63 bool atRightBoundaryOfBidiRun() const { return atRightBoundaryOfBidiRun(IgnoreBidiLevel, 0); }
64 // The following two functions return true only if the current position is at the end of the bidi run
65 // of the specified bidi embedding level.
atLeftBoundaryOfBidiRun(unsigned char bidiLevelOfRun)66 bool atLeftBoundaryOfBidiRun(unsigned char bidiLevelOfRun) const { return atLeftBoundaryOfBidiRun(MatchBidiLevel, bidiLevelOfRun); }
atRightBoundaryOfBidiRun(unsigned char bidiLevelOfRun)67 bool atRightBoundaryOfBidiRun(unsigned char bidiLevelOfRun) const { return atRightBoundaryOfBidiRun(MatchBidiLevel, bidiLevelOfRun); }
68
69 Position positionAtLeftBoundaryOfBiDiRun() const;
70 Position positionAtRightBoundaryOfBiDiRun() const;
71
72 IntRect absoluteRect(LayoutUnit* extraWidthToEndOfLine = 0) const;
73 void positionInGraphicsLayerBacking(CompositedSelectionBound&) const;
74
75 private:
76 bool operator==(const RenderedPosition&) const { return false; }
77 explicit RenderedPosition(RenderObject*, InlineBox*, int offset);
78
79 InlineBox* prevLeafChild() const;
80 InlineBox* nextLeafChild() const;
atLeftmostOffsetInBox()81 bool atLeftmostOffsetInBox() const { return m_inlineBox && m_offset == m_inlineBox->caretLeftmostOffset(); }
atRightmostOffsetInBox()82 bool atRightmostOffsetInBox() const { return m_inlineBox && m_offset == m_inlineBox->caretRightmostOffset(); }
83 bool atLeftBoundaryOfBidiRun(ShouldMatchBidiLevel, unsigned char bidiLevelOfRun) const;
84 bool atRightBoundaryOfBidiRun(ShouldMatchBidiLevel, unsigned char bidiLevelOfRun) const;
85
86 RenderObject* m_renderer;
87 InlineBox* m_inlineBox;
88 int m_offset;
89
uncachedInlineBox()90 static InlineBox* uncachedInlineBox() { return reinterpret_cast<InlineBox*>(1); }
91 // Needs to be different form 0 so pick 1 because it's also on the null page.
92
93 mutable InlineBox* m_prevLeafChild;
94 mutable InlineBox* m_nextLeafChild;
95 };
96
RenderedPosition()97 inline RenderedPosition::RenderedPosition()
98 : m_renderer(0)
99 , m_inlineBox(0)
100 , m_offset(0)
101 , m_prevLeafChild(uncachedInlineBox())
102 , m_nextLeafChild(uncachedInlineBox())
103 {
104 }
105
RenderedPosition(RenderObject * renderer,InlineBox * box,int offset)106 inline RenderedPosition::RenderedPosition(RenderObject* renderer, InlineBox* box, int offset)
107 : m_renderer(renderer)
108 , m_inlineBox(box)
109 , m_offset(offset)
110 , m_prevLeafChild(uncachedInlineBox())
111 , m_nextLeafChild(uncachedInlineBox())
112 {
113 }
114
115 bool renderObjectContainsPosition(RenderObject*, const Position&);
116
117 };
118
119 #endif // RenderedPosition_h
120