5258aab70cd13ba88639da122b1eacc0f8ac3fcb
[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     {
46         setBehavesLikeText(true);
47     }
48
49     virtual ~InlineTextBox();
50
51     RenderText& renderer() const { return downcast<RenderText>(InlineBox::renderer()); }
52     const RenderStyle& lineStyle() const { return isFirstLine() ? renderer().firstLineStyle() : renderer().style(); }
53
54     InlineTextBox* prevTextBox() const { return m_prevTextBox; }
55     InlineTextBox* nextTextBox() const { return m_nextTextBox; }
56     void setNextTextBox(InlineTextBox* n) { m_nextTextBox = n; }
57     void setPreviousTextBox(InlineTextBox* p) { m_prevTextBox = p; }
58
59     // FIXME: These accessors should ASSERT(!isDirty()). See https://bugs.webkit.org/show_bug.cgi?id=97264
60     unsigned start() const { return m_start; }
61     unsigned end() const { return m_len ? m_start + m_len - 1 : m_start; }
62     unsigned len() const { return m_len; }
63
64     void setStart(unsigned start) { m_start = start; }
65     void setLen(unsigned len) { m_len = len; }
66
67     void offsetRun(int d) { ASSERT(!isDirty()); ASSERT(d > 0 || m_start >= static_cast<unsigned>(-d)); m_start += d; }
68
69     unsigned short truncation() const { return m_truncation; }
70
71     void markDirty(bool dirty = true) final;
72
73     using InlineBox::hasHyphen;
74     using InlineBox::setHasHyphen;
75     using InlineBox::canHaveLeadingExpansion;
76     using InlineBox::setCanHaveLeadingExpansion;
77     using InlineBox::canHaveTrailingExpansion;
78     using InlineBox::setCanHaveTrailingExpansion;
79     using InlineBox::forceTrailingExpansion;
80     using InlineBox::setForceTrailingExpansion;
81     using InlineBox::forceLeadingExpansion;
82     using InlineBox::setForceLeadingExpansion;
83
84     static inline bool compareByStart(const InlineTextBox* first, const InlineTextBox* second) { return first->start() < second->start(); }
85
86     int baselinePosition(FontBaseline) const final;
87     LayoutUnit lineHeight() const final;
88
89     bool emphasisMarkExistsAndIsAbove(const RenderStyle&, bool& isAbove) const;
90
91     LayoutRect logicalOverflowRect() const;
92     void setLogicalOverflowRect(const LayoutRect&);
93     LayoutUnit logicalTopVisualOverflow() const { return logicalOverflowRect().y(); }
94     LayoutUnit logicalBottomVisualOverflow() const { return logicalOverflowRect().maxY(); }
95     LayoutUnit logicalLeftVisualOverflow() const { return logicalOverflowRect().x(); }
96     LayoutUnit logicalRightVisualOverflow() const { return logicalOverflowRect().maxX(); }
97
98     virtual void dirtyOwnLineBoxes() { dirtyLineBoxes(); }
99
100 #if ENABLE(TREE_DEBUGGING)
101     void showLineBox(bool mark, int depth) const final;
102     const char* boxName() const final;
103 #endif
104
105 private:
106     LayoutUnit selectionTop() const;
107     LayoutUnit selectionBottom() const;
108     LayoutUnit selectionHeight() const;
109
110     StringView substringToRender(Optional<unsigned> overridingLength = { }) const;
111     String hyphenatedStringForTextRun(const RenderStyle&, Optional<unsigned> alternateLength = { }) const;
112     TextRun constructTextRun(const RenderStyle&, StringView alternateStringToRender = { }, Optional<unsigned> alternateLength = { }) const;
113     TextRun constructTextRun(const RenderStyle&, StringView, unsigned maximumLength) const;
114
115 public:
116     FloatRect calculateBoundaries() const override { return FloatRect(x(), y(), width(), height()); }
117
118     virtual LayoutRect localSelectionRect(unsigned startPos, unsigned endPos) const;
119     bool isSelected(unsigned startPos, unsigned endPos) const;
120     std::pair<unsigned, unsigned> selectionStartEnd() const;
121
122 protected:
123     void paint(PaintInfo&, const LayoutPoint&, LayoutUnit lineTop, LayoutUnit lineBottom) override;
124     bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, LayoutUnit lineTop, LayoutUnit lineBottom, HitTestAction) override;
125
126 private:
127     void deleteLine() final;
128     void extractLine() final;
129     void attachLine() final;
130
131 public:
132     RenderObject::SelectionState selectionState() final;
133
134 private:
135     void clearTruncation() final { m_truncation = cNoTruncation; }
136     float placeEllipsisBox(bool flowIsLTR, float visibleLeftEdge, float visibleRightEdge, float ellipsisWidth, float &truncatedWidth, bool& foundBox) final;
137
138 public:
139     bool isLineBreak() const final;
140
141 private:
142     bool isInlineTextBox() const final { return true; }
143
144 public:
145     int caretMinOffset() const final;
146     int caretMaxOffset() const final;
147
148 private:
149     float textPos() const; // returns the x position relative to the left start of the text line.
150
151 public:
152     virtual int offsetForPosition(float x, bool includePartialGlyphs = true) const;
153     virtual float positionForOffset(unsigned offset) const;
154
155 protected:
156     void paintCompositionBackground(GraphicsContext&, const FloatPoint& boxOrigin, const RenderStyle&, const FontCascade&, unsigned startPos, unsigned endPos);
157     void paintDocumentMarkers(GraphicsContext&, const FloatPoint& boxOrigin, const RenderStyle&, const FontCascade&, bool background);
158     void paintCompositionUnderline(GraphicsContext&, const FloatPoint& boxOrigin, const CompositionUnderline&);
159     unsigned clampedOffset(unsigned) const;
160
161 private:
162     void paintDecoration(GraphicsContext&, const FontCascade&, RenderCombineText*, const TextRun&, const FloatPoint& textOrigin, const FloatRect& boxRect,
163         TextDecoration, TextPaintStyle, const ShadowData*);
164     void paintSelection(GraphicsContext&, const FloatPoint& boxOrigin, const RenderStyle&, const FontCascade&, const Color& textColor);
165     void paintDocumentMarker(GraphicsContext&, const FloatPoint& boxOrigin, RenderedDocumentMarker&, const RenderStyle&, const FontCascade&, bool grammar);
166     void paintTextMatchMarker(GraphicsContext&, const FloatPoint& boxOrigin, RenderedDocumentMarker&, const RenderStyle&, const FontCascade&);
167
168     ExpansionBehavior expansionBehavior() const;
169
170     void behavesLikeText() const = delete;
171
172     InlineTextBox* m_prevTextBox { nullptr }; // The previous box that also uses our RenderObject
173     InlineTextBox* m_nextTextBox { nullptr }; // The next box that also uses our RenderObject
174
175     unsigned m_start { 0 };
176     unsigned short m_len { 0 };
177
178     // Where to truncate when text overflow is applied. We use special constants to
179     // denote no truncation (the whole run paints) and full truncation (nothing paints at all).
180     unsigned short m_truncation { cNoTruncation };
181 };
182
183 } // namespace WebCore
184
185 SPECIALIZE_TYPE_TRAITS_INLINE_BOX(InlineTextBox, isInlineTextBox())
186
187 #endif // InlineTextBox_h