Introduce RenderTreeBuilder
[WebKit-https.git] / Source / WebCore / rendering / RenderRubyRun.cpp
1 /*
2  * Copyright (C) 2009 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #include "config.h"
32
33 #include "RenderRubyRun.h"
34
35 #include "RenderRuby.h"
36 #include "RenderRubyBase.h"
37 #include "RenderRubyText.h"
38 #include "RenderText.h"
39 #include "RenderView.h"
40 #include "StyleInheritedData.h"
41 #include <wtf/IsoMallocInlines.h>
42 #include <wtf/StackStats.h>
43
44 namespace WebCore {
45
46 using namespace std;
47
48 WTF_MAKE_ISO_ALLOCATED_IMPL(RenderRubyRun);
49
50 RenderRubyRun::RenderRubyRun(Document& document, RenderStyle&& style)
51     : RenderBlockFlow(document, WTFMove(style))
52     , m_lastCharacter(0)
53     , m_secondToLastCharacter(0)
54 {
55     setReplaced(true);
56     setInline(true);
57 }
58
59 RenderRubyRun::~RenderRubyRun() = default;
60
61 bool RenderRubyRun::hasRubyText() const
62 {
63     // The only place where a ruby text can be is in the first position
64     // Note: As anonymous blocks, ruby runs do not have ':before' or ':after' content themselves.
65     return firstChild() && firstChild()->isRubyText();
66 }
67
68 bool RenderRubyRun::hasRubyBase() const
69 {
70     // The only place where a ruby base can be is in the last position
71     // Note: As anonymous blocks, ruby runs do not have ':before' or ':after' content themselves.
72     return lastChild() && lastChild()->isRubyBase();
73 }
74
75 RenderRubyText* RenderRubyRun::rubyText() const
76 {
77     RenderObject* child = firstChild();
78     // If in future it becomes necessary to support floating or positioned ruby text,
79     // layout will have to be changed to handle them properly.
80     ASSERT(!child || !child->isRubyText() || !child->isFloatingOrOutOfFlowPositioned());
81     return child && child->isRubyText() ? static_cast<RenderRubyText*>(child) : 0;
82 }
83
84 RenderRubyBase* RenderRubyRun::rubyBase() const
85 {
86     RenderObject* child = lastChild();
87     return child && child->isRubyBase() ? static_cast<RenderRubyBase*>(child) : 0;
88 }
89
90 RenderRubyBase* RenderRubyRun::rubyBaseSafe()
91 {
92     RenderRubyBase* base = rubyBase();
93     if (!base) {
94         auto newBase = createRubyBase();
95         base = newBase.get();
96         RenderBlockFlow::addChild(*RenderTreeBuilder::current(), WTFMove(newBase));
97     }
98     return base;
99 }
100
101 RenderBlock* RenderRubyRun::firstLineBlock() const
102 {
103     return 0;
104 }
105
106 bool RenderRubyRun::isChildAllowed(const RenderObject& child, const RenderStyle&) const
107 {
108     return child.isInline() || child.isRubyText();
109 }
110
111 RenderPtr<RenderObject> RenderRubyRun::takeChild(RenderObject& child)
112 {
113     // If the child is a ruby text, then merge the ruby base with the base of
114     // the right sibling run, if possible.
115     if (!beingDestroyed() && !renderTreeBeingDestroyed() && child.isRubyText()) {
116         RenderRubyBase* base = rubyBase();
117         RenderObject* rightNeighbour = nextSibling();
118         if (base && is<RenderRubyRun>(rightNeighbour)) {
119             // Ruby run without a base can happen only at the first run.
120             RenderRubyRun& rightRun = downcast<RenderRubyRun>(*rightNeighbour);
121             if (rightRun.hasRubyBase()) {
122                 RenderRubyBase* rightBase = rightRun.rubyBaseSafe();
123                 // Collect all children in a single base, then swap the bases.
124                 rightBase->mergeChildrenWithBase(*base);
125                 moveChildTo(&rightRun, base, RenderBoxModelObject::NormalizeAfterInsertion::No);
126                 rightRun.moveChildTo(this, rightBase, RenderBoxModelObject::NormalizeAfterInsertion::No);
127                 // The now empty ruby base will be removed below.
128                 ASSERT(!rubyBase()->firstChild());
129             }
130         }
131     }
132
133     auto takenChild = RenderBlockFlow::takeChild(child);
134
135     if (!beingDestroyed() && !renderTreeBeingDestroyed()) {
136         // Check if our base (if any) is now empty. If so, destroy it.
137         RenderBlock* base = rubyBase();
138         if (base && !base->firstChild()) {
139             auto takenBase = RenderBlockFlow::takeChild(*base);
140             base->deleteLines();
141         }
142     }
143
144     return takenChild;
145 }
146
147 RenderPtr<RenderRubyBase> RenderRubyRun::createRubyBase() const
148 {
149     auto newStyle = RenderStyle::createAnonymousStyleWithDisplay(style(), BLOCK);
150     newStyle.setTextAlign(CENTER); // FIXME: use WEBKIT_CENTER?
151     auto renderer = createRenderer<RenderRubyBase>(document(), WTFMove(newStyle));
152     renderer->initializeStyle();
153     return renderer;
154 }
155
156 RenderPtr<RenderRubyRun> RenderRubyRun::staticCreateRubyRun(const RenderObject* parentRuby)
157 {
158     ASSERT(isRuby(parentRuby));
159     auto renderer = createRenderer<RenderRubyRun>(parentRuby->document(), RenderStyle::createAnonymousStyleWithDisplay(parentRuby->style(), INLINE_BLOCK));
160     renderer->initializeStyle();
161     return renderer;
162 }
163
164 void RenderRubyRun::layoutExcludedChildren(bool relayoutChildren)
165 {
166     RenderBlockFlow::layoutExcludedChildren(relayoutChildren);
167
168     StackStats::LayoutCheckPoint layoutCheckPoint;
169     // Don't bother positioning the RenderRubyRun yet.
170     RenderRubyText* rt = rubyText();
171     if (!rt)
172         return;
173     rt->setIsExcludedFromNormalLayout(true);
174     if (relayoutChildren)
175         rt->setChildNeedsLayout(MarkOnlyThis);
176     rt->layoutIfNeeded();
177 }
178
179 void RenderRubyRun::layout()
180 {
181     if (RenderRubyBase* base = rubyBase())
182         base->reset();
183     RenderBlockFlow::layout();
184 }
185
186 void RenderRubyRun::layoutBlock(bool relayoutChildren, LayoutUnit pageHeight)
187 {
188     if (!relayoutChildren) {
189         // Since the extra relayout in RenderBlockFlow::updateRubyForJustifiedText() causes the size of the RenderRubyText/RenderRubyBase
190         // dependent on the line's current expansion, whenever we relayout the RenderRubyRun, we need to relayout the RenderRubyBase/RenderRubyText as well.
191         // FIXME: We should take the expansion opportunities into account if possible.
192         relayoutChildren = style().textAlign() == JUSTIFY;
193     }
194
195     RenderBlockFlow::layoutBlock(relayoutChildren, pageHeight);
196
197     RenderRubyText* rt = rubyText();
198     if (!rt)
199         return;
200
201     rt->setLogicalLeft(0);
202
203     // Place the RenderRubyText such that its bottom is flush with the lineTop of the first line of the RenderRubyBase.
204     LayoutUnit lastLineRubyTextBottom = rt->logicalHeight();
205     LayoutUnit firstLineRubyTextTop = 0;
206     RootInlineBox* rootBox = rt->lastRootBox();
207     if (rootBox) {
208         // In order to align, we have to ignore negative leading.
209         firstLineRubyTextTop = rt->firstRootBox()->logicalTopLayoutOverflow();
210         lastLineRubyTextBottom = rootBox->logicalBottomLayoutOverflow();
211     }
212     
213     if (isHorizontalWritingMode() && rt->style().rubyPosition() == RubyPositionInterCharacter) {
214         // Bopomofo. We need to move the RenderRubyText over to the right side and center it
215         // vertically relative to the base.
216         const FontCascade& font = style().fontCascade();
217         float distanceBetweenBase = max(font.letterSpacing(), 2.0f * rt->style().fontCascade().fontMetrics().height());
218         setWidth(width() + distanceBetweenBase - font.letterSpacing());
219         if (RenderRubyBase* rb = rubyBase()) {
220             LayoutUnit firstLineTop = 0;
221             LayoutUnit lastLineBottom = logicalHeight();
222             RootInlineBox* rootBox = rb->firstRootBox();
223             if (rootBox)
224                 firstLineTop = rootBox->logicalTopLayoutOverflow();
225             firstLineTop += rb->logicalTop();
226             if (rootBox)
227                 lastLineBottom = rootBox->logicalBottomLayoutOverflow();
228             lastLineBottom += rb->logicalTop();
229             rt->setX(rb->x() + rb->width() - font.letterSpacing());
230             LayoutUnit extent = lastLineBottom - firstLineTop;
231             rt->setY(firstLineTop + (extent - rt->height()) / 2);
232         }
233     } else if (style().isFlippedLinesWritingMode() == (style().rubyPosition() == RubyPositionAfter)) {
234         LayoutUnit firstLineTop = 0;
235         if (RenderRubyBase* rb = rubyBase()) {
236             RootInlineBox* rootBox = rb->firstRootBox();
237             if (rootBox)
238                 firstLineTop = rootBox->logicalTopLayoutOverflow();
239             firstLineTop += rb->logicalTop();
240         }
241         
242         rt->setLogicalTop(-lastLineRubyTextBottom + firstLineTop);
243     } else {
244         LayoutUnit lastLineBottom = logicalHeight();
245         if (RenderRubyBase* rb = rubyBase()) {
246             RootInlineBox* rootBox = rb->lastRootBox();
247             if (rootBox)
248                 lastLineBottom = rootBox->logicalBottomLayoutOverflow();
249             lastLineBottom += rb->logicalTop();
250         }
251
252         rt->setLogicalTop(-firstLineRubyTextTop + lastLineBottom);
253     }
254
255     // Update our overflow to account for the new RenderRubyText position.
256     computeOverflow(clientLogicalBottom());
257 }
258
259 static bool shouldOverhang(bool firstLine, const RenderObject* renderer, const RenderRubyBase& rubyBase)
260 {
261     if (!renderer || !renderer->isText())
262         return false;
263     const RenderStyle& rubyBaseStyle = firstLine ? rubyBase.firstLineStyle() : rubyBase.style();
264     const RenderStyle& style = firstLine ? renderer->firstLineStyle() : renderer->style();
265     return style.computedFontPixelSize() <= rubyBaseStyle.computedFontPixelSize();
266 }
267
268 void RenderRubyRun::getOverhang(bool firstLine, RenderObject* startRenderer, RenderObject* endRenderer, float& startOverhang, float& endOverhang) const
269 {
270     ASSERT(!needsLayout());
271
272     startOverhang = 0;
273     endOverhang = 0;
274
275     RenderRubyBase* rubyBase = this->rubyBase();
276     RenderRubyText* rubyText = this->rubyText();
277
278     if (!rubyBase || !rubyText)
279         return;
280
281     if (!rubyBase->firstRootBox())
282         return;
283
284     LayoutUnit logicalWidth = this->logicalWidth();
285     float logicalLeftOverhang = std::numeric_limits<float>::max();
286     float logicalRightOverhang = std::numeric_limits<float>::max();
287     for (RootInlineBox* rootInlineBox = rubyBase->firstRootBox(); rootInlineBox; rootInlineBox = rootInlineBox->nextRootBox()) {
288         logicalLeftOverhang = std::min<float>(logicalLeftOverhang, rootInlineBox->logicalLeft());
289         logicalRightOverhang = std::min<float>(logicalRightOverhang, logicalWidth - rootInlineBox->logicalRight());
290     }
291
292     startOverhang = style().isLeftToRightDirection() ? logicalLeftOverhang : logicalRightOverhang;
293     endOverhang = style().isLeftToRightDirection() ? logicalRightOverhang : logicalLeftOverhang;
294
295     if (!shouldOverhang(firstLine, startRenderer, *rubyBase))
296         startOverhang = 0;
297     if (!shouldOverhang(firstLine, endRenderer, *rubyBase))
298         endOverhang = 0;
299
300     // We overhang a ruby only if the neighboring render object is a text.
301     // We can overhang the ruby by no more than half the width of the neighboring text
302     // and no more than half the font size.
303     const RenderStyle& rubyTextStyle = firstLine ? rubyText->firstLineStyle() : rubyText->style();
304     float halfWidthOfFontSize = rubyTextStyle.computedFontPixelSize() / 2.;
305     if (startOverhang)
306         startOverhang = std::min(startOverhang, std::min(downcast<RenderText>(*startRenderer).minLogicalWidth(), halfWidthOfFontSize));
307     if (endOverhang)
308         endOverhang = std::min(endOverhang, std::min(downcast<RenderText>(*endRenderer).minLogicalWidth(), halfWidthOfFontSize));
309 }
310
311 void RenderRubyRun::updatePriorContextFromCachedBreakIterator(LazyLineBreakIterator& iterator) const
312 {
313     iterator.setPriorContext(m_lastCharacter, m_secondToLastCharacter);
314 }
315
316 bool RenderRubyRun::canBreakBefore(const LazyLineBreakIterator& iterator) const
317 {
318     RenderRubyText* rubyText = this->rubyText();
319     if (!rubyText)
320         return true;
321     return rubyText->canBreakBefore(iterator);
322 }
323
324 } // namespace WebCore