Introduce RenderTreeBuilder
[WebKit-https.git] / Source / WebCore / style / RenderTreeUpdaterFirstLetter.cpp
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2007 David Smith (catfish.man@gmail.com)
5  * Copyright (C) 2003-2011, 2017 Apple Inc. All rights reserved.
6  * Copyright (C) Research In Motion Limited 2010. All rights reserved.
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public License
19  * along with this library; see the file COPYING.LIB.  If not, write to
20  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  */
23
24 #include "config.h"
25 #include "RenderTreeUpdaterFirstLetter.h"
26
27 #include "FontCascade.h"
28 #include "RenderBlock.h"
29 #include "RenderButton.h"
30 #include "RenderInline.h"
31 #include "RenderRubyRun.h"
32 #include "RenderSVGText.h"
33 #include "RenderStyle.h"
34 #include "RenderTable.h"
35 #include "RenderTextFragment.h"
36 #include "RenderTreeBuilder.h"
37
38 namespace WebCore {
39
40 static RenderStyle styleForFirstLetter(const RenderBlock& firstLetterBlock, const RenderObject& firstLetterContainer)
41 {
42     auto* containerFirstLetterStyle = firstLetterBlock.getCachedPseudoStyle(FIRST_LETTER, &firstLetterContainer.firstLineStyle());
43     // FIXME: There appears to be some path where we have a first letter renderer without first letter style.
44     ASSERT(containerFirstLetterStyle);
45     auto firstLetterStyle = RenderStyle::clone(containerFirstLetterStyle ? *containerFirstLetterStyle : firstLetterContainer.firstLineStyle());
46
47     // If we have an initial letter drop that is >= 1, then we need to force floating to be on.
48     if (firstLetterStyle.initialLetterDrop() >= 1 && !firstLetterStyle.isFloating())
49         firstLetterStyle.setFloating(firstLetterStyle.isLeftToRightDirection() ? LeftFloat : RightFloat);
50
51     // We have to compute the correct font-size for the first-letter if it has an initial letter height set.
52     auto* paragraph = firstLetterContainer.isRenderBlockFlow() ? &firstLetterContainer : firstLetterContainer.containingBlock();
53     if (firstLetterStyle.initialLetterHeight() >= 1 && firstLetterStyle.fontMetrics().hasCapHeight() && paragraph->style().fontMetrics().hasCapHeight()) {
54         // FIXME: For ideographic baselines, we want to go from line edge to line edge. This is equivalent to (N-1)*line-height + the font height.
55         // We don't yet support ideographic baselines.
56         // For an N-line first-letter and for alphabetic baselines, the cap-height of the first letter needs to equal (N-1)*line-height of paragraph lines + cap-height of the paragraph
57         // Mathematically we can't rely on font-size, since font().height() doesn't necessarily match. For reliability, the best approach is simply to
58         // compare the final measured cap-heights of the two fonts in order to get to the closest possible value.
59         firstLetterStyle.setLineBoxContain(LineBoxContainInitialLetter);
60         int lineHeight = paragraph->style().computedLineHeight();
61
62         // Set the font to be one line too big and then ratchet back to get to a precise fit. We can't just set the desired font size based off font height metrics
63         // because many fonts bake ascent into the font metrics. Therefore we have to look at actual measured cap height values in order to know when we have a good fit.
64         auto newFontDescription = firstLetterStyle.fontDescription();
65         float capRatio = firstLetterStyle.fontMetrics().floatCapHeight() / firstLetterStyle.computedFontPixelSize();
66         float startingFontSize = ((firstLetterStyle.initialLetterHeight() - 1) * lineHeight + paragraph->style().fontMetrics().capHeight()) / capRatio;
67         newFontDescription.setSpecifiedSize(startingFontSize);
68         newFontDescription.setComputedSize(startingFontSize);
69         firstLetterStyle.setFontDescription(newFontDescription);
70         firstLetterStyle.fontCascade().update(firstLetterStyle.fontCascade().fontSelector());
71
72         int desiredCapHeight = (firstLetterStyle.initialLetterHeight() - 1) * lineHeight + paragraph->style().fontMetrics().capHeight();
73         int actualCapHeight = firstLetterStyle.fontMetrics().capHeight();
74         while (actualCapHeight > desiredCapHeight) {
75             auto newFontDescription = firstLetterStyle.fontDescription();
76             newFontDescription.setSpecifiedSize(newFontDescription.specifiedSize() - 1);
77             newFontDescription.setComputedSize(newFontDescription.computedSize() -1);
78             firstLetterStyle.setFontDescription(newFontDescription);
79             firstLetterStyle.fontCascade().update(firstLetterStyle.fontCascade().fontSelector());
80             actualCapHeight = firstLetterStyle.fontMetrics().capHeight();
81         }
82     }
83
84     // Force inline display (except for floating first-letters).
85     firstLetterStyle.setDisplay(firstLetterStyle.isFloating() ? BLOCK : INLINE);
86     // CSS2 says first-letter can't be positioned.
87     firstLetterStyle.setPosition(StaticPosition);
88     return firstLetterStyle;
89 }
90
91 // CSS 2.1 http://www.w3.org/TR/CSS21/selector.html#first-letter
92 // "Punctuation (i.e, characters defined in Unicode [UNICODE] in the "open" (Ps), "close" (Pe),
93 // "initial" (Pi). "final" (Pf) and "other" (Po) punctuation classes), that precedes or follows the first letter should be included"
94 static inline bool isPunctuationForFirstLetter(UChar c)
95 {
96     return U_GET_GC_MASK(c) & (U_GC_PS_MASK | U_GC_PE_MASK | U_GC_PI_MASK | U_GC_PF_MASK | U_GC_PO_MASK);
97 }
98
99 static inline bool shouldSkipForFirstLetter(UChar c)
100 {
101     return isSpaceOrNewline(c) || c == noBreakSpace || isPunctuationForFirstLetter(c);
102 }
103
104 static void updateFirstLetterStyle(RenderBlock& firstLetterBlock, RenderObject& currentChild)
105 {
106     RenderElement* firstLetter = currentChild.parent();
107     ASSERT(firstLetter->isFirstLetter());
108
109     RenderElement* firstLetterContainer = firstLetter->parent();
110     auto pseudoStyle = styleForFirstLetter(firstLetterBlock, *firstLetterContainer);
111     ASSERT(firstLetter->isFloating() || firstLetter->isInline());
112
113     if (Style::determineChange(firstLetter->style(), pseudoStyle) == Style::Detach) {
114         // The first-letter renderer needs to be replaced. Create a new renderer of the right type.
115         RenderPtr<RenderBoxModelObject> newFirstLetter;
116         if (pseudoStyle.display() == INLINE)
117             newFirstLetter = createRenderer<RenderInline>(firstLetterBlock.document(), WTFMove(pseudoStyle));
118         else
119             newFirstLetter = createRenderer<RenderBlockFlow>(firstLetterBlock.document(), WTFMove(pseudoStyle));
120         newFirstLetter->initializeStyle();
121         newFirstLetter->setIsFirstLetter();
122
123         // Move the first letter into the new renderer.
124         while (RenderObject* child = firstLetter->firstChild()) {
125             if (is<RenderText>(*child))
126                 downcast<RenderText>(*child).removeAndDestroyTextBoxes();
127             auto toMove = firstLetter->takeChild(*child);
128             RenderTreeBuilder::current()->insertChild(*newFirstLetter, WTFMove(toMove));
129         }
130
131         RenderObject* nextSibling = firstLetter->nextSibling();
132         if (RenderTextFragment* remainingText = downcast<RenderBoxModelObject>(*firstLetter).firstLetterRemainingText()) {
133             ASSERT(remainingText->isAnonymous() || remainingText->textNode()->renderer() == remainingText);
134             // Replace the old renderer with the new one.
135             remainingText->setFirstLetter(*newFirstLetter);
136             newFirstLetter->setFirstLetterRemainingText(*remainingText);
137         }
138         firstLetterContainer->removeAndDestroyChild(*firstLetter);
139         RenderTreeBuilder::current()->insertChild(*firstLetterContainer, WTFMove(newFirstLetter), nextSibling);
140     } else
141         firstLetter->setStyle(WTFMove(pseudoStyle));
142 }
143
144 static void createFirstLetterRenderer(RenderBlock& firstLetterBlock, RenderText& currentTextChild)
145 {
146     RenderElement* firstLetterContainer = currentTextChild.parent();
147     auto pseudoStyle = styleForFirstLetter(firstLetterBlock, *firstLetterContainer);
148     RenderPtr<RenderBoxModelObject> newFirstLetter;
149     if (pseudoStyle.display() == INLINE)
150         newFirstLetter = createRenderer<RenderInline>(firstLetterBlock.document(), WTFMove(pseudoStyle));
151     else
152         newFirstLetter = createRenderer<RenderBlockFlow>(firstLetterBlock.document(), WTFMove(pseudoStyle));
153     newFirstLetter->initializeStyle();
154     newFirstLetter->setIsFirstLetter();
155
156     auto& firstLetter = *newFirstLetter;
157     RenderTreeBuilder::current()->insertChild(*firstLetterContainer, WTFMove(newFirstLetter), &currentTextChild);
158
159     // The original string is going to be either a generated content string or a DOM node's
160     // string. We want the original string before it got transformed in case first-letter has
161     // no text-transform or a different text-transform applied to it.
162     String oldText = currentTextChild.originalText();
163     ASSERT(!oldText.isNull());
164
165     if (!oldText.isEmpty()) {
166         unsigned length = 0;
167
168         // Account for leading spaces and punctuation.
169         while (length < oldText.length() && shouldSkipForFirstLetter(oldText[length]))
170             length++;
171
172         // Account for first grapheme cluster.
173         length += numCharactersInGraphemeClusters(StringView(oldText).substring(length), 1);
174
175         // Keep looking for whitespace and allowed punctuation, but avoid
176         // accumulating just whitespace into the :first-letter.
177         for (unsigned scanLength = length; scanLength < oldText.length(); ++scanLength) {
178             UChar c = oldText[scanLength];
179
180             if (!shouldSkipForFirstLetter(c))
181                 break;
182
183             if (isPunctuationForFirstLetter(c))
184                 length = scanLength + 1;
185         }
186
187         auto* textNode = currentTextChild.textNode();
188         auto* beforeChild = currentTextChild.nextSibling();
189         firstLetterContainer->removeAndDestroyChild(currentTextChild);
190
191         // Construct a text fragment for the text after the first letter.
192         // This text fragment might be empty.
193         RenderPtr<RenderTextFragment> newRemainingText;
194         if (textNode) {
195             newRemainingText = createRenderer<RenderTextFragment>(*textNode, oldText, length, oldText.length() - length);
196             textNode->setRenderer(newRemainingText.get());
197         } else
198             newRemainingText = createRenderer<RenderTextFragment>(firstLetterBlock.document(), oldText, length, oldText.length() - length);
199
200         RenderTextFragment& remainingText = *newRemainingText;
201         RenderTreeBuilder::current()->insertChild(*firstLetterContainer, WTFMove(newRemainingText), beforeChild);
202         remainingText.setFirstLetter(firstLetter);
203         firstLetter.setFirstLetterRemainingText(remainingText);
204
205         // construct text fragment for the first letter
206         auto letter = createRenderer<RenderTextFragment>(firstLetterBlock.document(), oldText, 0, length);
207
208         RenderTreeBuilder::current()->insertChild(firstLetter, WTFMove(letter));
209     }
210 }
211
212 static bool supportsFirstLetter(RenderBlock& block)
213 {
214     if (is<RenderButton>(block))
215         return true;
216     if (!is<RenderBlockFlow>(block))
217         return false;
218     if (is<RenderSVGText>(block))
219         return false;
220     if (is<RenderRubyRun>(block))
221         return false;
222     return block.canHaveGeneratedChildren();
223 }
224
225 void RenderTreeUpdater::FirstLetter::update(RenderBlock& block)
226 {
227     if (!block.style().hasPseudoStyle(FIRST_LETTER))
228         return;
229     if (!supportsFirstLetter(block))
230         return;
231
232     // FIXME: This should be refactored, firstLetterContainer is not needed.
233     RenderObject* firstLetterRenderer;
234     RenderElement* firstLetterContainer;
235     block.getFirstLetter(firstLetterRenderer, firstLetterContainer);
236
237     if (!firstLetterRenderer)
238         return;
239
240     // Other containers are handled when updating their renderers.
241     if (&block != firstLetterContainer)
242         return;
243
244     // If the child already has style, then it has already been created, so we just want
245     // to update it.
246     if (firstLetterRenderer->parent()->style().styleType() == FIRST_LETTER) {
247         updateFirstLetterStyle(block, *firstLetterRenderer);
248         return;
249     }
250
251     if (!is<RenderText>(firstLetterRenderer))
252         return;
253
254     createFirstLetterRenderer(block, downcast<RenderText>(*firstLetterRenderer));
255 }
256
257 };