d4fdf44577c5e4d7cb539b275dab08956e28cf3c
[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&, const RenderRegion*) 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     UChar characterAt(unsigned) const;
81     UChar uncheckedCharacterAt(unsigned) const;
82     UChar operator[](unsigned i) const { return uncheckedCharacterAt(i); }
83     unsigned textLength() const { return m_text.impl()->length(); } // non virtual implementation of length()
84     void positionLineBox(InlineTextBox&);
85
86     virtual float width(unsigned from, unsigned len, const Font&, float xPos, HashSet<const SimpleFontData*>* fallbackFonts = 0, GlyphOverflow* = 0) const;
87     virtual float width(unsigned from, unsigned len, float xPos, bool firstLine = false, HashSet<const SimpleFontData*>* fallbackFonts = 0, GlyphOverflow* = 0) const;
88
89     float minLogicalWidth() const;
90     float maxLogicalWidth() const;
91
92     void trimmedPrefWidths(float leadWidth,
93                            float& beginMinW, bool& beginWS,
94                            float& endMinW, bool& endWS,
95                            bool& hasBreakableChar, bool& hasBreak,
96                            float& beginMaxW, float& endMaxW,
97                            float& minW, float& maxW, bool& stripFrontSpaces);
98
99     virtual IntRect linesBoundingBox() const;
100     LayoutRect linesVisualOverflowBoundingBox() const;
101
102     IntPoint firstRunLocation() const;
103
104     virtual void setText(const String&, bool force = false);
105     void setTextWithOffset(const String&, unsigned offset, unsigned len, bool force = false);
106
107     virtual bool canBeSelectionLeaf() const override { return true; }
108     virtual void setSelectionState(SelectionState) override final;
109     virtual LayoutRect selectionRectForRepaint(const RenderLayerModelObject* repaintContainer, bool clipToVisibleContent = true) override;
110     virtual LayoutRect localCaretRect(InlineBox*, int caretOffset, LayoutUnit* extraWidthToEndOfLine = 0) override;
111
112     LayoutUnit marginLeft() const { return minimumValueForLength(style().marginLeft(), 0); }
113     LayoutUnit marginRight() const { return minimumValueForLength(style().marginRight(), 0); }
114
115     virtual LayoutRect clippedOverflowRectForRepaint(const RenderLayerModelObject* repaintContainer) const override final;
116
117     InlineTextBox* firstTextBox() const { return m_lineBoxes.first(); }
118     InlineTextBox* lastTextBox() const { return m_lineBoxes.last(); }
119
120     virtual int caretMinOffset() const override;
121     virtual int caretMaxOffset() const override;
122     unsigned countRenderedCharacterOffsetsUntil(unsigned) const;
123     bool containsRenderedCharacterOffset(unsigned) const;
124     bool containsCaretOffset(unsigned) const;
125     bool hasRenderedText() const;
126
127     virtual int previousOffset(int current) const override final;
128     virtual int previousOffsetForBackwardDeletion(int current) const override final;
129     virtual int nextOffset(int current) const override final;
130
131     bool containsReversedText() const { return m_containsReversedText; }
132
133     bool isSecure() const { return style().textSecurity() != TSNONE; }
134     void momentarilyRevealLastTypedCharacter(unsigned lastTypedCharacterOffset);
135
136     InlineTextBox* findNextInlineTextBox(int offset, int& pos) const { return m_lineBoxes.findNext(offset, pos); }
137
138     bool isAllCollapsibleWhitespace() const;
139
140     bool canUseSimpleFontCodePath() const { return m_canUseSimpleFontCodePath; }
141
142     void removeAndDestroyTextBoxes();
143
144     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle);
145
146     virtual std::unique_ptr<InlineTextBox> createTextBox(); // Subclassed by RenderSVGInlineText.
147
148 #if ENABLE(IOS_TEXT_AUTOSIZING)
149     float candidateComputedTextSize() const { return m_candidateComputedTextSize; }
150     void setCandidateComputedTextSize(float s) { m_candidateComputedTextSize = s; }
151 #endif
152
153     void ensureLineBoxes();
154     void deleteLineBoxesBeforeSimpleLineLayout();
155     const SimpleLineLayout::Layout* simpleLineLayout() const;
156
157 protected:
158     virtual void computePreferredLogicalWidths(float leadWidth);
159     virtual void willBeDestroyed() override;
160
161     virtual void setRenderedText(const String&);
162     virtual UChar previousCharacter() const;
163
164 private:
165     virtual bool canHaveChildren() const override final { return false; }
166
167     void computePreferredLogicalWidths(float leadWidth, HashSet<const SimpleFontData*>& fallbackFonts, GlyphOverflow&);
168
169     bool computeCanUseSimpleFontCodePath() const;
170     
171     // Make length() private so that callers that have a RenderText*
172     // will use the more efficient textLength() instead, while
173     // callers with a RenderObject* can continue to use length().
174     virtual unsigned length() const override final { return textLength(); }
175
176     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation&, const LayoutPoint&, HitTestAction) override final { ASSERT_NOT_REACHED(); return false; }
177
178     bool containsOnlyWhitespace(unsigned from, unsigned len) const;
179     float widthFromCache(const Font&, int start, int len, float xPos, HashSet<const SimpleFontData*>* fallbackFonts, GlyphOverflow*, const RenderStyle&) const;
180     bool isAllASCII() const { return m_isAllASCII; }
181     bool computeUseBackslashAsYenSymbol() const;
182
183     void secureText(UChar mask);
184
185     void node() const = delete;
186
187     // We put the bitfield first to minimize padding on 64-bit.
188     bool m_hasBreakableChar : 1; // Whether or not we can be broken into multiple lines.
189     bool m_hasBreak : 1; // Whether or not we have a hard break (e.g., <pre> with '\n').
190     bool m_hasTab : 1; // Whether or not we have a variable width tab character (e.g., <pre> with '\t').
191     bool m_hasBeginWS : 1; // Whether or not we begin with WS (only true if we aren't pre)
192     bool m_hasEndWS : 1; // Whether or not we end with WS (only true if we aren't pre)
193     bool m_linesDirty : 1; // This bit indicates that the text run has already dirtied specific
194                            // line boxes, and this hint will enable layoutInlineChildren to avoid
195                            // just dirtying everything when character data is modified (e.g., appended/inserted
196                            // or removed).
197     bool m_containsReversedText : 1;
198     bool m_isAllASCII : 1;
199     bool m_canUseSimpleFontCodePath : 1;
200     mutable bool m_knownToHaveNoOverflowAndNoFallbackFonts : 1;
201     bool m_useBackslashAsYenSymbol : 1;
202     bool m_originalTextDiffersFromRendered : 1;
203
204 #if ENABLE(IOS_TEXT_AUTOSIZING)
205     // FIXME: This should probably be part of the text sizing structures in Document instead. That would save some memory.
206     float m_candidateComputedTextSize;
207 #endif
208     float m_minWidth;
209     float m_maxWidth;
210     float m_beginMinWidth;
211     float m_endMinWidth;
212
213     String m_text;
214
215     RenderTextLineBoxes m_lineBoxes;
216 };
217
218 RENDER_OBJECT_TYPE_CASTS(RenderText, isText())
219
220 inline UChar RenderText::uncheckedCharacterAt(unsigned i) const
221 {
222     ASSERT_WITH_SECURITY_IMPLICATION(i < textLength());
223     return is8Bit() ? characters8()[i] : characters16()[i];
224 }
225
226 inline UChar RenderText::characterAt(unsigned i) const
227 {
228     if (i >= textLength())
229         return 0;
230
231     return uncheckedCharacterAt(i);
232 }
233
234 inline RenderStyle& RenderText::style() const
235 {
236     return parent()->style();
237 }
238
239 inline RenderStyle& RenderText::firstLineStyle() const
240 {
241     return parent()->firstLineStyle();
242 }
243
244 void applyTextTransform(const RenderStyle&, String&, UChar);
245 void makeCapitalized(String*, UChar previous);
246     
247 inline RenderText* Text::renderer() const
248 {
249     return toRenderText(Node::renderer());
250 }
251
252 } // namespace WebCore
253
254 #endif // RenderText_h