Unreviewed, rolling out r223500.
[WebKit-https.git] / Source / WebCore / style / StyleTreeResolver.cpp
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2001 Peter Kelly (pmk@post.com)
5  *           (C) 2001 Dirk Mueller (mueller@kde.org)
6  *           (C) 2007 David Smith (catfish.man@gmail.com)
7  * Copyright (C) 2004-2010, 2012-2016 Apple Inc. All rights reserved.
8  *           (C) 2007 Eric Seidel (eric@webkit.org)
9  *
10  * This library is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Library General Public
12  * License as published by the Free Software Foundation; either
13  * version 2 of the License, or (at your option) any later version.
14  *
15  * This library is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * Library General Public License for more details.
19  *
20  * You should have received a copy of the GNU Library General Public License
21  * along with this library; see the file COPYING.LIB.  If not, write to
22  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23  * Boston, MA 02110-1301, USA.
24  */
25
26 #include "config.h"
27 #include "StyleTreeResolver.h"
28
29 #include "CSSAnimationController.h"
30 #include "CSSFontSelector.h"
31 #include "ComposedTreeAncestorIterator.h"
32 #include "ComposedTreeIterator.h"
33 #include "ElementIterator.h"
34 #include "HTMLBodyElement.h"
35 #include "HTMLMeterElement.h"
36 #include "HTMLNames.h"
37 #include "HTMLProgressElement.h"
38 #include "HTMLSlotElement.h"
39 #include "LoaderStrategy.h"
40 #include "MainFrame.h"
41 #include "NodeRenderStyle.h"
42 #include "Page.h"
43 #include "PlatformStrategies.h"
44 #include "RenderElement.h"
45 #include "RenderView.h"
46 #include "Settings.h"
47 #include "ShadowRoot.h"
48 #include "StyleFontSizeFunctions.h"
49 #include "StyleResolver.h"
50 #include "StyleScope.h"
51 #include "Text.h"
52
53 namespace WebCore {
54
55 namespace Style {
56
57 TreeResolver::TreeResolver(Document& document)
58     : m_document(document)
59 {
60 }
61
62 TreeResolver::~TreeResolver()
63 {
64 }
65
66 TreeResolver::Scope::Scope(Document& document)
67     : styleResolver(document.styleScope().resolver())
68     , sharingResolver(document, styleResolver.ruleSets(), selectorFilter)
69 {
70 }
71
72 TreeResolver::Scope::Scope(ShadowRoot& shadowRoot, Scope& enclosingScope)
73     : styleResolver(shadowRoot.styleScope().resolver())
74     , sharingResolver(shadowRoot.documentScope(), styleResolver.ruleSets(), selectorFilter)
75     , shadowRoot(&shadowRoot)
76     , enclosingScope(&enclosingScope)
77 {
78 }
79
80 TreeResolver::Parent::Parent(Document& document)
81     : element(nullptr)
82     , style(*document.renderStyle())
83 {
84 }
85
86 TreeResolver::Parent::Parent(Element& element, const RenderStyle& style, Change change)
87     : element(&element)
88     , style(style)
89     , change(change)
90 {
91 }
92
93 void TreeResolver::pushScope(ShadowRoot& shadowRoot)
94 {
95     m_scopeStack.append(adoptRef(*new Scope(shadowRoot, scope())));
96     scope().styleResolver.setOverrideDocumentElementStyle(m_documentElementStyle.get());
97 }
98
99 void TreeResolver::pushEnclosingScope()
100 {
101     ASSERT(scope().enclosingScope);
102     m_scopeStack.append(*scope().enclosingScope);
103     scope().styleResolver.setOverrideDocumentElementStyle(m_documentElementStyle.get());
104 }
105
106 void TreeResolver::popScope()
107 {
108     scope().styleResolver.setOverrideDocumentElementStyle(nullptr);
109     return m_scopeStack.removeLast();
110 }
111
112 std::unique_ptr<RenderStyle> TreeResolver::styleForElement(Element& element, const RenderStyle& inheritedStyle)
113 {
114     if (element.hasCustomStyleResolveCallbacks()) {
115         RenderStyle* shadowHostStyle = scope().shadowRoot ? m_update->elementStyle(*scope().shadowRoot->host()) : nullptr;
116         if (auto customStyle = element.resolveCustomStyle(inheritedStyle, shadowHostStyle)) {
117             if (customStyle->relations)
118                 commitRelations(WTFMove(customStyle->relations), *m_update);
119
120             return WTFMove(customStyle->renderStyle);
121         }
122     }
123
124     if (auto style = scope().sharingResolver.resolve(element, *m_update))
125         return style;
126
127     auto elementStyle = scope().styleResolver.styleForElement(element, &inheritedStyle, parentBoxStyle(), MatchAllRules, &scope().selectorFilter);
128
129     if (elementStyle.relations)
130         commitRelations(WTFMove(elementStyle.relations), *m_update);
131
132     return WTFMove(elementStyle.renderStyle);
133 }
134
135 static void resetStyleForNonRenderedDescendants(Element& current)
136 {
137     // FIXME: This is not correct with shadow trees. This should be done with ComposedTreeIterator.
138     bool elementNeedingStyleRecalcAffectsNextSiblingElementStyle = false;
139     for (auto& child : childrenOfType<Element>(current)) {
140         bool affectedByPreviousSibling = child.styleIsAffectedByPreviousSibling() && elementNeedingStyleRecalcAffectsNextSiblingElementStyle;
141         if (child.needsStyleRecalc() || elementNeedingStyleRecalcAffectsNextSiblingElementStyle)
142             elementNeedingStyleRecalcAffectsNextSiblingElementStyle = child.affectsNextSiblingElementStyle();
143
144         if (child.needsStyleRecalc() || affectedByPreviousSibling) {
145             child.resetComputedStyle();
146             child.resetStyleRelations();
147             child.setHasValidStyle();
148         }
149
150         if (child.childNeedsStyleRecalc()) {
151             resetStyleForNonRenderedDescendants(child);
152             child.clearChildNeedsStyleRecalc();
153         }
154     }
155 }
156
157 static bool affectsRenderedSubtree(Element& element, const RenderStyle& newStyle)
158 {
159     if (element.renderer())
160         return true;
161     if (newStyle.display() != NONE)
162         return true;
163     if (element.rendererIsNeeded(newStyle))
164         return true;
165     return false;
166 }
167
168 static const RenderStyle* renderOrDisplayContentsStyle(const Element& element)
169 {
170     if (auto* renderStyle = element.renderStyle())
171         return renderStyle;
172     if (element.hasDisplayContents())
173         return element.existingComputedStyle();
174     return nullptr;
175 }
176
177 ElementUpdate TreeResolver::resolveElement(Element& element)
178 {
179     if (m_didSeePendingStylesheet && !element.renderer() && !m_document.isIgnoringPendingStylesheets()) {
180         m_document.setHasNodesWithMissingStyle();
181         return { };
182     }
183
184     auto newStyle = styleForElement(element, parent().style);
185
186     if (!affectsRenderedSubtree(element, *newStyle))
187         return { };
188
189     auto* existingStyle = renderOrDisplayContentsStyle(element);
190
191     if (m_didSeePendingStylesheet && (!existingStyle || existingStyle->isNotFinal())) {
192         newStyle->setIsNotFinal();
193         m_document.setHasNodesWithNonFinalStyle();
194     }
195
196     auto update = createAnimatedElementUpdate(WTFMove(newStyle), element, parent().change);
197
198     if (&element == m_document.documentElement()) {
199         m_documentElementStyle = RenderStyle::clonePtr(*update.style);
200         scope().styleResolver.setOverrideDocumentElementStyle(m_documentElementStyle.get());
201
202         if (update.change != NoChange && existingStyle && existingStyle->computedFontPixelSize() != update.style->computedFontPixelSize()) {
203             // "rem" units are relative to the document element's font size so we need to recompute everything.
204             // In practice this is rare.
205             scope().styleResolver.invalidateMatchedPropertiesCache();
206             update.change = std::max(update.change, Force);
207         }
208     }
209
210     // This is needed for resolving color:-webkit-text for subsequent elements.
211     // FIXME: We shouldn't mutate document when resolving style.
212     if (&element == m_document.body())
213         m_document.setTextColor(update.style->visitedDependentColor(CSSPropertyColor));
214
215     // FIXME: These elements should not change renderer based on appearance property.
216     if (element.hasTagName(HTMLNames::meterTag) || is<HTMLProgressElement>(element)) {
217         if (existingStyle && update.style->appearance() != existingStyle->appearance())
218             update.change = Detach;
219     }
220
221     return update;
222 }
223
224 const RenderStyle* TreeResolver::parentBoxStyle() const
225 {
226     // 'display: contents' doesn't generate boxes.
227     for (unsigned i = m_parentStack.size(); i; --i) {
228         auto& parent = m_parentStack[i - 1];
229         if (parent.style.display() == NONE)
230             return nullptr;
231         if (parent.style.display() != CONTENTS)
232             return &parent.style;
233     }
234     ASSERT_NOT_REACHED();
235     return nullptr;
236 }
237
238 ElementUpdate TreeResolver::createAnimatedElementUpdate(std::unique_ptr<RenderStyle> newStyle, Element& element, Change parentChange)
239 {
240     auto& animationController = element.document().frame()->animation();
241
242     auto* oldStyle = renderOrDisplayContentsStyle(element);
243     auto animationUpdate = animationController.updateAnimations(element, *newStyle, oldStyle);
244
245     if (animationUpdate.style)
246         newStyle = WTFMove(animationUpdate.style);
247
248     auto change = oldStyle ? determineChange(*oldStyle, *newStyle) : Detach;
249
250     auto validity = element.styleValidity();
251     if (validity >= Validity::SubtreeInvalid)
252         change = std::max(change, validity == Validity::SubtreeAndRenderersInvalid ? Detach : Force);
253     if (parentChange >= Force)
254         change = std::max(change, parentChange);
255
256     bool shouldRecompositeLayer = element.styleResolutionShouldRecompositeLayer() || animationUpdate.stateChanged;
257
258     return { WTFMove(newStyle), change, shouldRecompositeLayer };
259 }
260
261 void TreeResolver::pushParent(Element& element, const RenderStyle& style, Change change)
262 {
263     scope().selectorFilter.pushParent(&element);
264
265     Parent parent(element, style, change);
266
267     if (auto* shadowRoot = element.shadowRoot()) {
268         pushScope(*shadowRoot);
269         parent.didPushScope = true;
270     }
271     else if (is<HTMLSlotElement>(element) && downcast<HTMLSlotElement>(element).assignedNodes()) {
272         pushEnclosingScope();
273         parent.didPushScope = true;
274     }
275
276     m_parentStack.append(WTFMove(parent));
277 }
278
279 void TreeResolver::popParent()
280 {
281     auto& parentElement = *parent().element;
282
283     parentElement.setHasValidStyle();
284     parentElement.clearChildNeedsStyleRecalc();
285
286     if (parent().didPushScope)
287         popScope();
288
289     scope().selectorFilter.popParent();
290
291     m_parentStack.removeLast();
292 }
293
294 void TreeResolver::popParentsToDepth(unsigned depth)
295 {
296     ASSERT(depth);
297     ASSERT(m_parentStack.size() >= depth);
298
299     while (m_parentStack.size() > depth)
300         popParent();
301 }
302
303 static bool shouldResolvePseudoElement(const PseudoElement* pseudoElement)
304 {
305     if (!pseudoElement)
306         return false;
307     return pseudoElement->needsStyleRecalc();
308 }
309
310 static bool shouldResolveElement(const Element& element, Style::Change parentChange)
311 {
312     if (parentChange >= Inherit)
313         return true;
314     if (parentChange == NoInherit) {
315         auto* existingStyle = renderOrDisplayContentsStyle(element);
316         if (existingStyle && existingStyle->hasExplicitlyInheritedProperties())
317             return true;
318     }
319     if (element.needsStyleRecalc())
320         return true;
321     if (shouldResolvePseudoElement(element.beforePseudoElement()))
322         return true;
323     if (shouldResolvePseudoElement(element.afterPseudoElement()))
324         return true;
325
326     return false;
327 }
328
329 static void clearNeedsStyleResolution(Element& element)
330 {
331     element.setHasValidStyle();
332     if (auto* before = element.beforePseudoElement())
333         before->setHasValidStyle();
334     if (auto* after = element.afterPseudoElement())
335         after->setHasValidStyle();
336 }
337
338 static bool hasLoadingStylesheet(const Style::Scope& styleScope, const Element& element, bool checkDescendants)
339 {
340     if (!styleScope.hasPendingSheetsInBody())
341         return false;
342     if (styleScope.hasPendingSheetInBody(element))
343         return true;
344     if (!checkDescendants)
345         return false;
346     for (auto& descendant : descendantsOfType<Element>(element)) {
347         if (styleScope.hasPendingSheetInBody(descendant))
348             return true;
349     };
350     return false;
351 }
352
353 static std::unique_ptr<RenderStyle> createInheritedDisplayContentsStyleIfNeeded(const RenderStyle& parentElementStyle, const RenderStyle* parentBoxStyle)
354 {
355     if (parentElementStyle.display() != CONTENTS)
356         return nullptr;
357     if (parentBoxStyle && !parentBoxStyle->inheritedNotEqual(&parentElementStyle))
358         return nullptr;
359     // Compute style for imaginary unstyled <span> around the text node.
360     auto style = RenderStyle::createPtr();
361     style->inheritFrom(parentElementStyle);
362     return style;
363 }
364
365 void TreeResolver::resolveComposedTree()
366 {
367     ASSERT(m_parentStack.size() == 1);
368     ASSERT(m_scopeStack.size() == 1);
369
370     auto descendants = composedTreeDescendants(m_document);
371     auto it = descendants.begin();
372     auto end = descendants.end();
373
374     // FIXME: SVG <use> element may cause tree mutations during style recalc.
375     it.dropAssertions();
376
377     while (it != end) {
378         popParentsToDepth(it.depth());
379
380         auto& node = *it;
381         auto& parent = this->parent();
382
383         ASSERT(node.isConnected());
384         ASSERT(node.containingShadowRoot() == scope().shadowRoot);
385         ASSERT(node.parentElement() == parent.element || is<ShadowRoot>(node.parentNode()) || node.parentElement()->shadowRoot());
386
387         if (is<Text>(node)) {
388             auto& text = downcast<Text>(node);
389             
390             if ((text.styleValidity() >= Validity::SubtreeAndRenderersInvalid && parent.change != Detach) || parent.style.display() == CONTENTS) {
391                 TextUpdate textUpdate;
392                 textUpdate.inheritedDisplayContentsStyle = createInheritedDisplayContentsStyleIfNeeded(parent.style, parentBoxStyle());
393
394                 m_update->addText(text, parent.element, WTFMove(textUpdate));
395             }
396
397             text.setHasValidStyle();
398             it.traverseNextSkippingChildren();
399             continue;
400         }
401
402         auto& element = downcast<Element>(node);
403
404         if (it.depth() > Settings::defaultMaximumRenderTreeDepth) {
405             resetStyleForNonRenderedDescendants(element);
406             element.clearChildNeedsStyleRecalc();
407             it.traverseNextSkippingChildren();
408             continue;
409         }
410
411         // FIXME: We should deal with this during style invalidation.
412         bool affectedByPreviousSibling = element.styleIsAffectedByPreviousSibling() && parent.elementNeedingStyleRecalcAffectsNextSiblingElementStyle;
413         if (element.needsStyleRecalc() || parent.elementNeedingStyleRecalcAffectsNextSiblingElementStyle)
414             parent.elementNeedingStyleRecalcAffectsNextSiblingElementStyle = element.affectsNextSiblingElementStyle();
415
416         auto* style = renderOrDisplayContentsStyle(element);
417         auto change = NoChange;
418
419         bool shouldResolve = shouldResolveElement(element, parent.change) || affectedByPreviousSibling;
420         if (shouldResolve) {
421             if (!element.hasDisplayContents())
422                 element.resetComputedStyle();
423             element.resetStyleRelations();
424
425             if (element.hasCustomStyleResolveCallbacks())
426                 element.willRecalcStyle(parent.change);
427
428             auto elementUpdate = resolveElement(element);
429
430             if (element.hasCustomStyleResolveCallbacks())
431                 element.didRecalcStyle(elementUpdate.change);
432
433             style = elementUpdate.style.get();
434             change = elementUpdate.change;
435
436             if (affectedByPreviousSibling && change != Detach)
437                 change = Force;
438
439             if (elementUpdate.style)
440                 m_update->addElement(element, parent.element, WTFMove(elementUpdate));
441
442             clearNeedsStyleResolution(element);
443         }
444
445         if (!style) {
446             resetStyleForNonRenderedDescendants(element);
447             element.clearChildNeedsStyleRecalc();
448         }
449
450         bool shouldIterateChildren = style && (element.childNeedsStyleRecalc() || change != NoChange);
451
452         if (!m_didSeePendingStylesheet)
453             m_didSeePendingStylesheet = hasLoadingStylesheet(m_document.styleScope(), element, !shouldIterateChildren);
454
455         if (!shouldIterateChildren) {
456             it.traverseNextSkippingChildren();
457             continue;
458         }
459
460         pushParent(element, *style, change);
461
462         it.traverseNext();
463     }
464
465     popParentsToDepth(1);
466 }
467
468 std::unique_ptr<Update> TreeResolver::resolve()
469 {
470     auto& renderView = *m_document.renderView();
471
472     Element* documentElement = m_document.documentElement();
473     if (!documentElement) {
474         m_document.styleScope().resolver();
475         return nullptr;
476     }
477     if (!documentElement->childNeedsStyleRecalc() && !documentElement->needsStyleRecalc())
478         return nullptr;
479
480     m_didSeePendingStylesheet = m_document.styleScope().hasPendingSheetsBeforeBody();
481
482     m_update = std::make_unique<Update>(m_document);
483     m_scopeStack.append(adoptRef(*new Scope(m_document)));
484     m_parentStack.append(Parent(m_document));
485
486     // Pseudo element removal and similar may only work with these flags still set. Reset them after the style recalc.
487     renderView.setUsesFirstLineRules(renderView.usesFirstLineRules() || scope().styleResolver.usesFirstLineRules());
488     renderView.setUsesFirstLetterRules(renderView.usesFirstLetterRules() || scope().styleResolver.usesFirstLetterRules());
489
490     resolveComposedTree();
491
492     renderView.setUsesFirstLineRules(scope().styleResolver.usesFirstLineRules());
493     renderView.setUsesFirstLetterRules(scope().styleResolver.usesFirstLetterRules());
494
495     ASSERT(m_scopeStack.size() == 1);
496     ASSERT(m_parentStack.size() == 1);
497     m_parentStack.clear();
498     popScope();
499
500     if (m_update->roots().isEmpty())
501         return { };
502
503     return WTFMove(m_update);
504 }
505
506 static Vector<Function<void ()>>& postResolutionCallbackQueue()
507 {
508     static NeverDestroyed<Vector<Function<void ()>>> vector;
509     return vector;
510 }
511
512 void queuePostResolutionCallback(Function<void ()>&& callback)
513 {
514     postResolutionCallbackQueue().append(WTFMove(callback));
515 }
516
517 static void suspendMemoryCacheClientCalls(Document& document)
518 {
519     Page* page = document.page();
520     if (!page || !page->areMemoryCacheClientCallsEnabled())
521         return;
522
523     page->setMemoryCacheClientCallsEnabled(false);
524
525     postResolutionCallbackQueue().append([protectedMainFrame = Ref<MainFrame>(page->mainFrame())] {
526         if (Page* page = protectedMainFrame->page())
527             page->setMemoryCacheClientCallsEnabled(true);
528     });
529 }
530
531 static unsigned resolutionNestingDepth;
532
533 PostResolutionCallbackDisabler::PostResolutionCallbackDisabler(Document& document)
534 {
535     ++resolutionNestingDepth;
536
537     if (resolutionNestingDepth == 1)
538         platformStrategies()->loaderStrategy()->suspendPendingRequests();
539
540     // FIXME: It's strange to build this into the disabler.
541     suspendMemoryCacheClientCalls(document);
542 }
543
544 PostResolutionCallbackDisabler::~PostResolutionCallbackDisabler()
545 {
546     if (resolutionNestingDepth == 1) {
547         // Get size each time through the loop because a callback can add more callbacks to the end of the queue.
548         auto& queue = postResolutionCallbackQueue();
549         for (size_t i = 0; i < queue.size(); ++i)
550             queue[i]();
551         queue.clear();
552
553         platformStrategies()->loaderStrategy()->resumePendingRequests();
554     }
555
556     --resolutionNestingDepth;
557 }
558
559 bool postResolutionCallbacksAreSuspended()
560 {
561     return resolutionNestingDepth;
562 }
563
564 }
565 }