67b634ba578c380f709b231ca6b31898735694bd
[WebKit-https.git] / Source / WebCore / rendering / InlineTextBox.h
1 /*
2  * (C) 1999 Lars Knoll (knoll@kde.org)
3  * (C) 2000 Dirk Mueller (mueller@kde.org)
4  * Copyright (C) 2004, 2005, 2006, 2009, 2010, 2011, 2014 Apple Inc. All rights reserved.
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public License
17  * along with this library; see the file COPYING.LIB.  If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  *
21  */
22
23 #ifndef InlineTextBox_h
24 #define InlineTextBox_h
25
26 #include "InlineBox.h"
27 #include "RenderText.h"
28 #include "TextRun.h"
29
30 namespace WebCore {
31
32 struct CompositionUnderline;
33 class RenderCombineText;
34 class RenderedDocumentMarker;
35 class TextPainter;
36 struct TextPaintStyle;
37
38 const unsigned short cNoTruncation = USHRT_MAX;
39 const unsigned short cFullTruncation = USHRT_MAX - 1;
40
41 class InlineTextBox : public InlineBox {
42 public:
43     explicit InlineTextBox(RenderText& renderer)
44         : InlineBox(renderer)
45         , m_prevTextBox(nullptr)
46         , m_nextTextBox(nullptr)
47         , m_start(0)
48         , m_len(0)
49         , m_truncation(cNoTruncation)
50     {
51         setBehavesLikeText(true);
52     }
53
54     virtual ~InlineTextBox();
55
56     RenderText& renderer() const { return downcast<RenderText>(InlineBox::renderer()); }
57     const RenderStyle& lineStyle() const { return isFirstLine() ? renderer().firstLineStyle() : renderer().style(); }
58
59     InlineTextBox* prevTextBox() const { return m_prevTextBox; }
60     InlineTextBox* nextTextBox() const { return m_nextTextBox; }
61     void setNextTextBox(InlineTextBox* n) { m_nextTextBox = n; }
62     void setPreviousTextBox(InlineTextBox* p) { m_prevTextBox = p; }
63
64     // FIXME: These accessors should ASSERT(!isDirty()). See https://bugs.webkit.org/show_bug.cgi?id=97264
65     unsigned start() const { return m_start; }
66     unsigned end() const { return m_len ? m_start + m_len - 1 : m_start; }
67     unsigned len() const { return m_len; }
68
69     void setStart(unsigned start) { m_start = start; }
70     void setLen(unsigned len) { m_len = len; }
71
72     void offsetRun(int d) { ASSERT(!isDirty()); m_start += d; }
73
74     unsigned short truncation() const { return m_truncation; }
75
76     void markDirty(bool dirty = true) final;
77
78     using InlineBox::hasHyphen;
79     using InlineBox::setHasHyphen;
80     using InlineBox::canHaveLeadingExpansion;
81     using InlineBox::setCanHaveLeadingExpansion;
82     using InlineBox::canHaveTrailingExpansion;
83     using InlineBox::setCanHaveTrailingExpansion;
84     using InlineBox::forceTrailingExpansion;
85     using InlineBox::setForceTrailingExpansion;
86     using InlineBox::forceLeadingExpansion;
87     using InlineBox::setForceLeadingExpansion;
88
89     static inline bool compareByStart(const InlineTextBox* first, const InlineTextBox* second) { return first->start() < second->start(); }
90
91     int baselinePosition(FontBaseline) const final;
92     LayoutUnit lineHeight() const final;
93
94     bool emphasisMarkExistsAndIsAbove(const RenderStyle&, bool& isAbove) const;
95
96     LayoutRect logicalOverflowRect() const;
97     void setLogicalOverflowRect(const LayoutRect&);
98     LayoutUnit logicalTopVisualOverflow() const { return logicalOverflowRect().y(); }
99     LayoutUnit logicalBottomVisualOverflow() const { return logicalOverflowRect().maxY(); }
100     LayoutUnit logicalLeftVisualOverflow() const { return logicalOverflowRect().x(); }
101     LayoutUnit logicalRightVisualOverflow() const { return logicalOverflowRect().maxX(); }
102
103     virtual void dirtyOwnLineBoxes() { dirtyLineBoxes(); }
104
105 #if ENABLE(TREE_DEBUGGING)
106     void showLineBox(bool mark, int depth) const final;
107     const char* boxName() const final;
108 #endif
109
110 private:
111     LayoutUnit selectionTop() const;
112     LayoutUnit selectionBottom() const;
113     LayoutUnit selectionHeight() const;
114
115     StringView substringToRender(Optional<unsigned> overridingLength = { }) const;
116     String hyphenatedStringForTextRun(const RenderStyle&, Optional<unsigned> alternateLength = { }) const;
117     TextRun constructTextRun(const RenderStyle&, StringView alternateStringToRender = { }, Optional<unsigned> alternateLength = { }) const;
118     TextRun constructTextRun(const RenderStyle&, StringView, unsigned maximumLength) const;
119
120 public:
121     FloatRect calculateBoundaries() const override { return FloatRect(x(), y(), width(), height()); }
122
123     virtual LayoutRect localSelectionRect(int startPos, int endPos) const;
124     bool isSelected(int startPos, int endPos) const;
125     std::pair<int, int> selectionStartEnd() const;
126
127 protected:
128     void paint(PaintInfo&, const LayoutPoint&, LayoutUnit lineTop, LayoutUnit lineBottom) override;
129     bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, LayoutUnit lineTop, LayoutUnit lineBottom, HitTestAction) override;
130
131 private:
132     void deleteLine() final;
133     void extractLine() final;
134     void attachLine() final;
135
136 public:
137     RenderObject::SelectionState selectionState() final;
138
139 private:
140     void clearTruncation() final { m_truncation = cNoTruncation; }
141     float placeEllipsisBox(bool flowIsLTR, float visibleLeftEdge, float visibleRightEdge, float ellipsisWidth, float &truncatedWidth, bool& foundBox) final;
142
143 public:
144     bool isLineBreak() const final;
145
146 private:
147     bool isInlineTextBox() const final { return true; }
148
149 public:
150     int caretMinOffset() const final;
151     int caretMaxOffset() const final;
152
153 private:
154     float textPos() const; // returns the x position relative to the left start of the text line.
155
156 public:
157     virtual int offsetForPosition(float x, bool includePartialGlyphs = true) const;
158     virtual float positionForOffset(int offset) const;
159
160 protected:
161     void paintCompositionBackground(GraphicsContext&, const FloatPoint& boxOrigin, const RenderStyle&, const FontCascade&, int startPos, int endPos);
162     void paintDocumentMarkers(GraphicsContext&, const FloatPoint& boxOrigin, const RenderStyle&, const FontCascade&, bool background);
163     void paintCompositionUnderline(GraphicsContext&, const FloatPoint& boxOrigin, const CompositionUnderline&);
164
165 private:
166     void paintDecoration(GraphicsContext&, const FontCascade&, RenderCombineText*, const TextRun&, const FloatPoint& textOrigin, const FloatRect& boxRect,
167         TextDecoration, TextPaintStyle, const ShadowData*);
168     void paintSelection(GraphicsContext&, const FloatPoint& boxOrigin, const RenderStyle&, const FontCascade&, Color textColor);
169     void paintDocumentMarker(GraphicsContext&, const FloatPoint& boxOrigin, RenderedDocumentMarker&, const RenderStyle&, const FontCascade&, bool grammar);
170     void paintTextMatchMarker(GraphicsContext&, const FloatPoint& boxOrigin, RenderedDocumentMarker&, const RenderStyle&, const FontCascade&);
171
172     ExpansionBehavior expansionBehavior() const;
173
174     void behavesLikeText() const = delete;
175
176     InlineTextBox* m_prevTextBox; // The previous box that also uses our RenderObject
177     InlineTextBox* m_nextTextBox; // The next box that also uses our RenderObject
178
179     int m_start;
180     unsigned short m_len;
181
182     // Where to truncate when text overflow is applied. We use special constants to
183     // denote no truncation (the whole run paints) and full truncation (nothing paints at all).
184     unsigned short m_truncation;
185 };
186
187 } // namespace WebCore
188
189 SPECIALIZE_TYPE_TRAITS_INLINE_BOX(InlineTextBox, isInlineTextBox())
190
191 #endif // InlineTextBox_h