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