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