Automatically generate isRendererOfType in RENDER_OBJECT_TYPE_CASTS
[WebKit-https.git] / Source / WebCore / rendering / RenderText.h
1 /*
2  * (C) 1999 Lars Knoll (knoll@kde.org)
3  * (C) 2000 Dirk Mueller (mueller@kde.org)
4  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2013 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 RenderText_h
24 #define RenderText_h
25
26 #include "RenderElement.h"
27 #include "RenderTextLineBoxes.h"
28 #include "SimpleLineLayout.h"
29 #include "Text.h"
30 #include <wtf/Forward.h>
31
32 namespace WebCore {
33
34 class InlineTextBox;
35
36 class RenderText : public RenderObject {
37 public:
38     RenderText(Text&, const String&);
39     RenderText(Document&, const String&);
40
41     virtual ~RenderText();
42
43     virtual const char* renderName() const override;
44
45     Text* textNode() const;
46
47     virtual bool isTextFragment() const;
48
49     RenderStyle& style() const;
50     RenderStyle& firstLineStyle() const;
51
52     virtual String originalText() const;
53
54     void extractTextBox(InlineTextBox& box) { m_lineBoxes.extract(box); }
55     void attachTextBox(InlineTextBox& box) { m_lineBoxes.attach(box); }
56     void removeTextBox(InlineTextBox& box) { m_lineBoxes.remove(box); }
57
58     StringImpl* text() const { return m_text.impl(); }
59     String textWithoutConvertingBackslashToYenSymbol() const;
60
61     InlineTextBox* createInlineTextBox() { return m_lineBoxes.createAndAppendLineBox(*this); }
62     void dirtyLineBoxes(bool fullLayout);
63
64     virtual void absoluteRects(Vector<IntRect>&, const LayoutPoint& accumulatedOffset) const override final;
65     Vector<IntRect> absoluteRectsForRange(unsigned startOffset = 0, unsigned endOffset = UINT_MAX, bool useSelectionHeight = false, bool* wasFixed = nullptr) const;
66 #if PLATFORM(IOS)
67     virtual void collectSelectionRects(Vector<SelectionRect>&, unsigned startOffset = 0, unsigned endOffset = std::numeric_limits<unsigned>::max()) override;
68 #endif
69
70     virtual void absoluteQuads(Vector<FloatQuad>&, bool* wasFixed) const override final;
71     Vector<FloatQuad> absoluteQuadsForRange(unsigned startOffset = 0, unsigned endOffset = UINT_MAX, bool useSelectionHeight = false, bool* wasFixed = nullptr) const;
72
73     Vector<FloatQuad> absoluteQuadsClippedToEllipsis() const;
74
75     virtual VisiblePosition positionForPoint(const LayoutPoint&) override;
76
77     bool is8Bit() const { return m_text.impl()->is8Bit(); }
78     const LChar* characters8() const { return m_text.impl()->characters8(); }
79     const UChar* characters16() const { return m_text.impl()->characters16(); }
80     const UChar* deprecatedCharacters() const { return m_text.impl()->deprecatedCharacters(); }
81     UChar characterAt(unsigned) const;
82     UChar uncheckedCharacterAt(unsigned) const;
83     UChar operator[](unsigned i) const { return uncheckedCharacterAt(i); }
84     unsigned textLength() const { return m_text.impl()->length(); } // non virtual implementation of length()
85     void positionLineBox(InlineTextBox&);
86
87     virtual float width(unsigned from, unsigned len, const Font&, float xPos, HashSet<const SimpleFontData*>* fallbackFonts = 0, GlyphOverflow* = 0) const;
88     virtual float width(unsigned from, unsigned len, float xPos, bool firstLine = false, HashSet<const SimpleFontData*>* fallbackFonts = 0, GlyphOverflow* = 0) const;
89
90     float minLogicalWidth() const;
91     float maxLogicalWidth() const;
92
93     void trimmedPrefWidths(float leadWidth,
94                            float& beginMinW, bool& beginWS,
95                            float& endMinW, bool& endWS,
96                            bool& hasBreakableChar, bool& hasBreak,
97                            float& beginMaxW, float& endMaxW,
98                            float& minW, float& maxW, bool& stripFrontSpaces);
99
100     virtual IntRect linesBoundingBox() const;
101     LayoutRect linesVisualOverflowBoundingBox() const;
102
103     FloatPoint firstRunOrigin() const;
104     float firstRunX() const;
105     float firstRunY() const;
106
107     virtual void setText(const String&, bool force = false);
108     void setTextWithOffset(const String&, unsigned offset, unsigned len, bool force = false);
109
110     virtual bool canBeSelectionLeaf() const override { return true; }
111     virtual void setSelectionState(SelectionState) override final;
112     virtual LayoutRect selectionRectForRepaint(const RenderLayerModelObject* repaintContainer, bool clipToVisibleContent = true) override;
113     virtual LayoutRect localCaretRect(InlineBox*, int caretOffset, LayoutUnit* extraWidthToEndOfLine = 0) override;
114
115     LayoutUnit marginLeft() const { return minimumValueForLength(style().marginLeft(), 0); }
116     LayoutUnit marginRight() const { return minimumValueForLength(style().marginRight(), 0); }
117
118     virtual LayoutRect clippedOverflowRectForRepaint(const RenderLayerModelObject* repaintContainer) const override final;
119
120     InlineTextBox* firstTextBox() const { return m_lineBoxes.first(); }
121     InlineTextBox* lastTextBox() const { return m_lineBoxes.last(); }
122
123     virtual int caretMinOffset() const override;
124     virtual int caretMaxOffset() const override;
125     unsigned countRenderedCharacterOffsetsUntil(unsigned) const;
126     bool containsRenderedCharacterOffset(unsigned) const;
127     bool containsCaretOffset(unsigned) const;
128     bool hasRenderedText() const;
129
130     virtual int previousOffset(int current) const override final;
131     virtual int previousOffsetForBackwardDeletion(int current) const override final;
132     virtual int nextOffset(int current) const override final;
133
134     bool containsReversedText() const { return m_containsReversedText; }
135
136     bool isSecure() const { return style().textSecurity() != TSNONE; }
137     void momentarilyRevealLastTypedCharacter(unsigned lastTypedCharacterOffset);
138
139     InlineTextBox* findNextInlineTextBox(int offset, int& pos) const { return m_lineBoxes.findNext(offset, pos); }
140
141     bool isAllCollapsibleWhitespace() const;
142
143     bool canUseSimpleFontCodePath() const { return m_canUseSimpleFontCodePath; }
144
145     void removeAndDestroyTextBoxes();
146
147     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle);
148
149     virtual std::unique_ptr<InlineTextBox> createTextBox(); // Subclassed by RenderSVGInlineText.
150
151 #if ENABLE(IOS_TEXT_AUTOSIZING)
152     float candidateComputedTextSize() const { return m_candidateComputedTextSize; }
153     void setCandidateComputedTextSize(float s) { m_candidateComputedTextSize = s; }
154 #endif
155
156     void ensureLineBoxes();
157     void deleteLineBoxesBeforeSimpleLineLayout();
158     const SimpleLineLayout::Layout* simpleLineLayout() const;
159
160 protected:
161     virtual void computePreferredLogicalWidths(float leadWidth);
162     virtual void willBeDestroyed() override;
163
164     virtual void setTextInternal(const String&);
165     virtual UChar previousCharacter() const;
166
167 private:
168     virtual bool canHaveChildren() const override final { return false; }
169
170     void computePreferredLogicalWidths(float leadWidth, HashSet<const SimpleFontData*>& fallbackFonts, GlyphOverflow&);
171
172     bool computeCanUseSimpleFontCodePath() const;
173     
174     // Make length() private so that callers that have a RenderText*
175     // will use the more efficient textLength() instead, while
176     // callers with a RenderObject* can continue to use length().
177     virtual unsigned length() const override final { return textLength(); }
178
179     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation&, const LayoutPoint&, HitTestAction) override final { ASSERT_NOT_REACHED(); return false; }
180
181     bool containsOnlyWhitespace(unsigned from, unsigned len) const;
182     float widthFromCache(const Font&, int start, int len, float xPos, HashSet<const SimpleFontData*>* fallbackFonts, GlyphOverflow*, const RenderStyle&) const;
183     bool isAllASCII() const { return m_isAllASCII; }
184     bool computeUseBackslashAsYenSymbol() const;
185
186     void secureText(UChar mask);
187
188     void node() const = delete;
189
190     // We put the bitfield first to minimize padding on 64-bit.
191     bool m_hasBreakableChar : 1; // Whether or not we can be broken into multiple lines.
192     bool m_hasBreak : 1; // Whether or not we have a hard break (e.g., <pre> with '\n').
193     bool m_hasTab : 1; // Whether or not we have a variable width tab character (e.g., <pre> with '\t').
194     bool m_hasBeginWS : 1; // Whether or not we begin with WS (only true if we aren't pre)
195     bool m_hasEndWS : 1; // Whether or not we end with WS (only true if we aren't pre)
196     bool m_linesDirty : 1; // This bit indicates that the text run has already dirtied specific
197                            // line boxes, and this hint will enable layoutInlineChildren to avoid
198                            // just dirtying everything when character data is modified (e.g., appended/inserted
199                            // or removed).
200     bool m_containsReversedText : 1;
201     bool m_isAllASCII : 1;
202     bool m_canUseSimpleFontCodePath : 1;
203     mutable bool m_knownToHaveNoOverflowAndNoFallbackFonts : 1;
204     bool m_useBackslashAsYenSymbol : 1;
205     bool m_originalTextDiffersFromRendered : 1;
206
207 #if ENABLE(IOS_TEXT_AUTOSIZING)
208     // FIXME: This should probably be part of the text sizing structures in Document instead. That would save some memory.
209     float m_candidateComputedTextSize;
210 #endif
211     float m_minWidth;
212     float m_maxWidth;
213     float m_beginMinWidth;
214     float m_endMinWidth;
215
216     String m_text;
217
218     RenderTextLineBoxes m_lineBoxes;
219 };
220
221 RENDER_OBJECT_TYPE_CASTS(RenderText, isText())
222
223 inline UChar RenderText::uncheckedCharacterAt(unsigned i) const
224 {
225     ASSERT_WITH_SECURITY_IMPLICATION(i < textLength());
226     return is8Bit() ? characters8()[i] : characters16()[i];
227 }
228
229 inline UChar RenderText::characterAt(unsigned i) const
230 {
231     if (i >= textLength())
232         return 0;
233
234     return uncheckedCharacterAt(i);
235 }
236
237 inline RenderStyle& RenderText::style() const
238 {
239     return parent()->style();
240 }
241
242 inline RenderStyle& RenderText::firstLineStyle() const
243 {
244     return parent()->firstLineStyle();
245 }
246
247 void applyTextTransform(const RenderStyle&, String&, UChar);
248
249 inline RenderText* Text::renderer() const
250 {
251     return toRenderText(Node::renderer());
252 }
253
254 } // namespace WebCore
255
256 #endif // RenderText_h