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