040031cfb90e1125eca7cb9bb03513ab4d0516a1
[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 "DocumentTimeline.h"
34 #include "ElementIterator.h"
35 #include "Frame.h"
36 #include "HTMLBodyElement.h"
37 #include "HTMLMeterElement.h"
38 #include "HTMLNames.h"
39 #include "HTMLProgressElement.h"
40 #include "HTMLSlotElement.h"
41 #include "LoaderStrategy.h"
42 #include "NodeRenderStyle.h"
43 #include "Page.h"
44 #include "PlatformStrategies.h"
45 #include "RenderElement.h"
46 #include "RenderView.h"
47 #include "RuntimeEnabledFeatures.h"
48 #include "Settings.h"
49 #include "ShadowRoot.h"
50 #include "StyleFontSizeFunctions.h"
51 #include "StyleResolver.h"
52 #include "StyleScope.h"
53 #include "Text.h"
54
55 namespace WebCore {
56
57 namespace Style {
58
59 TreeResolver::TreeResolver(Document& document)
60     : m_document(document)
61 {
62 }
63
64 TreeResolver::~TreeResolver() = default;
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     styleResolver.setOverrideDocumentElementStyle(enclosingScope.styleResolver.overrideDocumentElementStyle());
79 }
80
81 TreeResolver::Scope::~Scope()
82 {
83     styleResolver.setOverrideDocumentElementStyle(nullptr);
84 }
85
86 TreeResolver::Parent::Parent(Document& document)
87     : element(nullptr)
88     , style(*document.renderStyle())
89 {
90 }
91
92 TreeResolver::Parent::Parent(Element& element, const RenderStyle& style, Change change, DescendantsToResolve descendantsToResolve)
93     : element(&element)
94     , style(style)
95     , change(change)
96     , descendantsToResolve(descendantsToResolve)
97 {
98 }
99
100 void TreeResolver::pushScope(ShadowRoot& shadowRoot)
101 {
102     m_scopeStack.append(adoptRef(*new Scope(shadowRoot, scope())));
103 }
104
105 void TreeResolver::pushEnclosingScope()
106 {
107     ASSERT(scope().enclosingScope);
108     m_scopeStack.append(*scope().enclosingScope);
109 }
110
111 void TreeResolver::popScope()
112 {
113     return m_scopeStack.removeLast();
114 }
115
116 std::unique_ptr<RenderStyle> TreeResolver::styleForElement(Element& element, const RenderStyle& inheritedStyle)
117 {
118     if (element.hasCustomStyleResolveCallbacks()) {
119         RenderStyle* shadowHostStyle = scope().shadowRoot ? m_update->elementStyle(*scope().shadowRoot->host()) : nullptr;
120         if (auto customStyle = element.resolveCustomStyle(inheritedStyle, shadowHostStyle)) {
121             if (customStyle->relations)
122                 commitRelations(WTFMove(customStyle->relations), *m_update);
123
124             return WTFMove(customStyle->renderStyle);
125         }
126     }
127
128     if (auto style = scope().sharingResolver.resolve(element, *m_update))
129         return style;
130
131     auto elementStyle = scope().styleResolver.styleForElement(element, &inheritedStyle, parentBoxStyle(), MatchAllRules, &scope().selectorFilter);
132
133     if (elementStyle.relations)
134         commitRelations(WTFMove(elementStyle.relations), *m_update);
135
136     return WTFMove(elementStyle.renderStyle);
137 }
138
139 static void resetStyleForNonRenderedDescendants(Element& current)
140 {
141     for (auto& child : childrenOfType<Element>(current)) {
142         if (child.needsStyleRecalc()) {
143             child.resetComputedStyle();
144             child.resetStyleRelations();
145             child.setHasValidStyle();
146         }
147
148         if (child.childNeedsStyleRecalc()) {
149             resetStyleForNonRenderedDescendants(child);
150             child.clearChildNeedsStyleRecalc();
151         }
152     }
153 }
154
155 static bool affectsRenderedSubtree(Element& element, const RenderStyle& newStyle)
156 {
157     if (element.renderer())
158         return true;
159     if (newStyle.display() != NONE)
160         return true;
161     if (element.rendererIsNeeded(newStyle))
162         return true;
163     return false;
164 }
165
166 static const RenderStyle* renderOrDisplayContentsStyle(const Element& element)
167 {
168     if (auto* renderStyle = element.renderStyle())
169         return renderStyle;
170     if (element.hasDisplayContents())
171         return element.existingComputedStyle();
172     return nullptr;
173 }
174
175 static DescendantsToResolve computeDescendantsToResolve(Change change, Validity validity, DescendantsToResolve parentDescendantsToResolve)
176 {
177     if (parentDescendantsToResolve == DescendantsToResolve::All)
178         return DescendantsToResolve::All;
179     if (validity >= Validity::SubtreeInvalid)
180         return DescendantsToResolve::All;
181     switch (change) {
182     case NoChange:
183         return DescendantsToResolve::None;
184     case NoInherit:
185         return DescendantsToResolve::ChildrenWithExplicitInherit;
186     case Inherit:
187         return DescendantsToResolve::Children;
188     case Detach:
189         return DescendantsToResolve::All;
190     };
191     ASSERT_NOT_REACHED();
192     return DescendantsToResolve::None;
193 };
194
195 ElementUpdates TreeResolver::resolveElement(Element& element)
196 {
197     if (m_didSeePendingStylesheet && !element.renderer() && !m_document.isIgnoringPendingStylesheets()) {
198         m_document.setHasNodesWithMissingStyle();
199         return { };
200     }
201
202     auto newStyle = styleForElement(element, parent().style);
203
204     if (!affectsRenderedSubtree(element, *newStyle))
205         return { };
206
207     auto* existingStyle = renderOrDisplayContentsStyle(element);
208
209     if (m_didSeePendingStylesheet && (!existingStyle || existingStyle->isNotFinal())) {
210         newStyle->setIsNotFinal();
211         m_document.setHasNodesWithNonFinalStyle();
212     }
213
214     auto update = createAnimatedElementUpdate(WTFMove(newStyle), element, parent().change);
215     auto descendantsToResolve = computeDescendantsToResolve(update.change, element.styleValidity(), parent().descendantsToResolve);
216
217     if (&element == m_document.documentElement()) {
218         m_documentElementStyle = RenderStyle::clonePtr(*update.style);
219         scope().styleResolver.setOverrideDocumentElementStyle(m_documentElementStyle.get());
220
221         if (update.change != NoChange && existingStyle && existingStyle->computedFontPixelSize() != update.style->computedFontPixelSize()) {
222             // "rem" units are relative to the document element's font size so we need to recompute everything.
223             // In practice this is rare.
224             scope().styleResolver.invalidateMatchedPropertiesCache();
225             descendantsToResolve = DescendantsToResolve::All;
226         }
227     }
228
229     // This is needed for resolving color:-webkit-text for subsequent elements.
230     // FIXME: We shouldn't mutate document when resolving style.
231     if (&element == m_document.body())
232         m_document.setTextColor(update.style->visitedDependentColor(CSSPropertyColor));
233
234     // FIXME: These elements should not change renderer based on appearance property.
235     if (element.hasTagName(HTMLNames::meterTag) || is<HTMLProgressElement>(element)) {
236         if (existingStyle && update.style->appearance() != existingStyle->appearance()) {
237             update.change = Detach;
238             descendantsToResolve = DescendantsToResolve::All;
239         }
240     }
241
242     auto beforeUpdate = resolvePseudoStyle(element, update, BEFORE);
243     auto afterUpdate = resolvePseudoStyle(element, update, AFTER);
244
245     return { WTFMove(update), descendantsToResolve, WTFMove(beforeUpdate), WTFMove(afterUpdate) };
246 }
247
248 ElementUpdate TreeResolver::resolvePseudoStyle(Element& element, const ElementUpdate& elementUpdate, PseudoId pseudoId)
249 {
250     if (elementUpdate.style->display() == NONE)
251         return { };
252     if (!elementUpdate.style->hasPseudoStyle(pseudoId))
253         return { };
254
255     auto pseudoStyle = scope().styleResolver.pseudoStyleForElement(element, { pseudoId }, *elementUpdate.style, &scope().selectorFilter);
256     if (!pseudoStyle)
257         return { };
258
259     PseudoElement* pseudoElement = pseudoId == BEFORE ? element.beforePseudoElement() : element.afterPseudoElement();
260     if (!pseudoElement) {
261         auto newPseudoElement = PseudoElement::create(element, pseudoId);
262         pseudoElement = newPseudoElement.ptr();
263         if (pseudoId == BEFORE)
264             element.setBeforePseudoElement(WTFMove(newPseudoElement));
265         else
266             element.setAfterPseudoElement(WTFMove(newPseudoElement));
267     }
268
269     return createAnimatedElementUpdate(WTFMove(pseudoStyle), *pseudoElement, elementUpdate.change);
270 }
271
272 const RenderStyle* TreeResolver::parentBoxStyle() const
273 {
274     // 'display: contents' doesn't generate boxes.
275     for (unsigned i = m_parentStack.size(); i; --i) {
276         auto& parent = m_parentStack[i - 1];
277         if (parent.style.display() == NONE)
278             return nullptr;
279         if (parent.style.display() != CONTENTS)
280             return &parent.style;
281     }
282     ASSERT_NOT_REACHED();
283     return nullptr;
284 }
285
286 ElementUpdate TreeResolver::createAnimatedElementUpdate(std::unique_ptr<RenderStyle> newStyle, Element& element, Change parentChange)
287 {
288     auto* oldStyle = renderOrDisplayContentsStyle(element);
289
290     // New code path for CSS Animations and CSS Transitions.
291     if (RuntimeEnabledFeatures::sharedFeatures().cssAnimationsAndCSSTransitionsBackedByWebAnimationsEnabled()) {
292         // First, we need to make sure that any new CSS animation occuring on this element has a matching WebAnimation
293         // on the document timeline. Note that we get timeline() on the Document here because we need a timeline created
294         // in case no Web Animations have been created through the JS API.
295         if ((oldStyle && oldStyle->hasTransitions()) || newStyle->hasTransitions())
296             m_document.timeline().updateCSSTransitionsForElement(element, *newStyle, oldStyle);
297
298         if ((oldStyle && oldStyle->hasAnimations()) || newStyle->hasAnimations())
299             m_document.timeline().updateCSSAnimationsForElement(element, *newStyle, oldStyle);
300     }
301
302     if (auto timeline = m_document.existingTimeline()) {
303         // Now we can update all Web animations, which will include CSS Animations as well
304         // as animations created via the JS API.
305         auto webAnimations = timeline->animationsForElement(element);
306         if (!webAnimations.isEmpty()) {
307             auto animatedStyle = RenderStyle::clonePtr(*newStyle);
308             for (const auto& animation : webAnimations)
309                 animation->resolve(*animatedStyle);
310             newStyle = WTFMove(animatedStyle);
311         }
312     }
313
314     bool shouldRecompositeLayer = false;
315
316     // Old code path for CSS Animations and CSS Transitions.
317     if (!RuntimeEnabledFeatures::sharedFeatures().cssAnimationsAndCSSTransitionsBackedByWebAnimationsEnabled()) {
318         auto& animationController = m_document.frame()->animation();
319
320         auto animationUpdate = animationController.updateAnimations(element, *newStyle, oldStyle);
321         shouldRecompositeLayer = animationUpdate.stateChanged;
322
323         if (animationUpdate.style)
324             newStyle = WTFMove(animationUpdate.style);
325     }
326
327     auto change = oldStyle ? determineChange(*oldStyle, *newStyle) : Detach;
328
329     auto validity = element.styleValidity();
330     if (validity >= Validity::SubtreeAndRenderersInvalid || parentChange == Detach)
331         change = Detach;
332
333     shouldRecompositeLayer |= element.styleResolutionShouldRecompositeLayer();
334
335     return { WTFMove(newStyle), change, shouldRecompositeLayer };
336 }
337
338 void TreeResolver::pushParent(Element& element, const RenderStyle& style, Change change, DescendantsToResolve descendantsToResolve)
339 {
340     scope().selectorFilter.pushParent(&element);
341
342     Parent parent(element, style, change, descendantsToResolve);
343
344     if (auto* shadowRoot = element.shadowRoot()) {
345         pushScope(*shadowRoot);
346         parent.didPushScope = true;
347     }
348     else if (is<HTMLSlotElement>(element) && downcast<HTMLSlotElement>(element).assignedNodes()) {
349         pushEnclosingScope();
350         parent.didPushScope = true;
351     }
352
353     m_parentStack.append(WTFMove(parent));
354 }
355
356 void TreeResolver::popParent()
357 {
358     auto& parentElement = *parent().element;
359
360     parentElement.setHasValidStyle();
361     parentElement.clearChildNeedsStyleRecalc();
362
363     if (parent().didPushScope)
364         popScope();
365
366     scope().selectorFilter.popParent();
367
368     m_parentStack.removeLast();
369 }
370
371 void TreeResolver::popParentsToDepth(unsigned depth)
372 {
373     ASSERT(depth);
374     ASSERT(m_parentStack.size() >= depth);
375
376     while (m_parentStack.size() > depth)
377         popParent();
378 }
379
380 static bool shouldResolvePseudoElement(const PseudoElement* pseudoElement)
381 {
382     if (!pseudoElement)
383         return false;
384     return pseudoElement->needsStyleRecalc();
385 }
386
387 static bool shouldResolveElement(const Element& element, DescendantsToResolve parentDescendantsToResolve)
388 {
389     if (element.styleValidity() != Validity::Valid)
390         return true;
391     if (shouldResolvePseudoElement(element.beforePseudoElement()))
392         return true;
393     if (shouldResolvePseudoElement(element.afterPseudoElement()))
394         return true;
395
396     switch (parentDescendantsToResolve) {
397     case DescendantsToResolve::None:
398         return false;
399     case DescendantsToResolve::Children:
400     case DescendantsToResolve::All:
401         return true;
402     case DescendantsToResolve::ChildrenWithExplicitInherit:
403         auto* existingStyle = renderOrDisplayContentsStyle(element);
404         return existingStyle && existingStyle->hasExplicitlyInheritedProperties();
405     };
406     ASSERT_NOT_REACHED();
407     return false;
408 }
409
410 static void clearNeedsStyleResolution(Element& element)
411 {
412     element.setHasValidStyle();
413     if (auto* before = element.beforePseudoElement())
414         before->setHasValidStyle();
415     if (auto* after = element.afterPseudoElement())
416         after->setHasValidStyle();
417 }
418
419 static bool hasLoadingStylesheet(const Style::Scope& styleScope, const Element& element, bool checkDescendants)
420 {
421     if (!styleScope.hasPendingSheetsInBody())
422         return false;
423     if (styleScope.hasPendingSheetInBody(element))
424         return true;
425     if (!checkDescendants)
426         return false;
427     for (auto& descendant : descendantsOfType<Element>(element)) {
428         if (styleScope.hasPendingSheetInBody(descendant))
429             return true;
430     };
431     return false;
432 }
433
434 static std::unique_ptr<RenderStyle> createInheritedDisplayContentsStyleIfNeeded(const RenderStyle& parentElementStyle, const RenderStyle* parentBoxStyle)
435 {
436     if (parentElementStyle.display() != CONTENTS)
437         return nullptr;
438     if (parentBoxStyle && !parentBoxStyle->inheritedNotEqual(&parentElementStyle))
439         return nullptr;
440     // Compute style for imaginary unstyled <span> around the text node.
441     auto style = RenderStyle::createPtr();
442     style->inheritFrom(parentElementStyle);
443     return style;
444 }
445
446 void TreeResolver::resolveComposedTree()
447 {
448     ASSERT(m_parentStack.size() == 1);
449     ASSERT(m_scopeStack.size() == 1);
450
451     auto descendants = composedTreeDescendants(m_document);
452     auto it = descendants.begin();
453     auto end = descendants.end();
454
455     while (it != end) {
456         popParentsToDepth(it.depth());
457
458         auto& node = *it;
459         auto& parent = this->parent();
460
461         ASSERT(node.isConnected());
462         ASSERT(node.containingShadowRoot() == scope().shadowRoot);
463         ASSERT(node.parentElement() == parent.element || is<ShadowRoot>(node.parentNode()) || node.parentElement()->shadowRoot());
464
465         if (is<Text>(node)) {
466             auto& text = downcast<Text>(node);
467             
468             if ((text.styleValidity() >= Validity::SubtreeAndRenderersInvalid && parent.change != Detach) || parent.style.display() == CONTENTS) {
469                 TextUpdate textUpdate;
470                 textUpdate.inheritedDisplayContentsStyle = createInheritedDisplayContentsStyleIfNeeded(parent.style, parentBoxStyle());
471
472                 m_update->addText(text, parent.element, WTFMove(textUpdate));
473             }
474
475             text.setHasValidStyle();
476             it.traverseNextSkippingChildren();
477             continue;
478         }
479
480         auto& element = downcast<Element>(node);
481
482         if (it.depth() > Settings::defaultMaximumRenderTreeDepth) {
483             resetStyleForNonRenderedDescendants(element);
484             element.clearChildNeedsStyleRecalc();
485             it.traverseNextSkippingChildren();
486             continue;
487         }
488
489         auto* style = renderOrDisplayContentsStyle(element);
490         auto change = NoChange;
491         auto descendantsToResolve = DescendantsToResolve::None;
492
493         bool shouldResolve = shouldResolveElement(element, parent.descendantsToResolve);
494         if (shouldResolve) {
495             if (!element.hasDisplayContents())
496                 element.resetComputedStyle();
497             element.resetStyleRelations();
498
499             if (element.hasCustomStyleResolveCallbacks())
500                 element.willRecalcStyle(parent.change);
501
502             auto elementUpdates = resolveElement(element);
503
504             if (element.hasCustomStyleResolveCallbacks())
505                 element.didRecalcStyle(elementUpdates.update.change);
506
507             style = elementUpdates.update.style.get();
508             change = elementUpdates.update.change;
509             descendantsToResolve = elementUpdates.descendantsToResolve;
510
511             if (elementUpdates.update.style)
512                 m_update->addElement(element, parent.element, WTFMove(elementUpdates));
513
514             clearNeedsStyleResolution(element);
515         }
516
517         if (!style) {
518             resetStyleForNonRenderedDescendants(element);
519             element.clearChildNeedsStyleRecalc();
520         }
521
522         bool shouldIterateChildren = style && (element.childNeedsStyleRecalc() || descendantsToResolve != DescendantsToResolve::None);
523
524         if (!m_didSeePendingStylesheet)
525             m_didSeePendingStylesheet = hasLoadingStylesheet(m_document.styleScope(), element, !shouldIterateChildren);
526
527         if (!shouldIterateChildren) {
528             it.traverseNextSkippingChildren();
529             continue;
530         }
531
532         pushParent(element, *style, change, descendantsToResolve);
533
534         it.traverseNext();
535     }
536
537     popParentsToDepth(1);
538 }
539
540 std::unique_ptr<Update> TreeResolver::resolve()
541 {
542     auto& renderView = *m_document.renderView();
543
544     Element* documentElement = m_document.documentElement();
545     if (!documentElement) {
546         m_document.styleScope().resolver();
547         return nullptr;
548     }
549     if (!documentElement->childNeedsStyleRecalc() && !documentElement->needsStyleRecalc())
550         return nullptr;
551
552     m_didSeePendingStylesheet = m_document.styleScope().hasPendingSheetsBeforeBody();
553
554     m_update = std::make_unique<Update>(m_document);
555     m_scopeStack.append(adoptRef(*new Scope(m_document)));
556     m_parentStack.append(Parent(m_document));
557
558     // Pseudo element removal and similar may only work with these flags still set. Reset them after the style recalc.
559     renderView.setUsesFirstLineRules(renderView.usesFirstLineRules() || scope().styleResolver.usesFirstLineRules());
560     renderView.setUsesFirstLetterRules(renderView.usesFirstLetterRules() || scope().styleResolver.usesFirstLetterRules());
561
562     resolveComposedTree();
563
564     renderView.setUsesFirstLineRules(scope().styleResolver.usesFirstLineRules());
565     renderView.setUsesFirstLetterRules(scope().styleResolver.usesFirstLetterRules());
566
567     ASSERT(m_scopeStack.size() == 1);
568     ASSERT(m_parentStack.size() == 1);
569     m_parentStack.clear();
570     popScope();
571
572     if (m_update->roots().isEmpty())
573         return { };
574
575     return WTFMove(m_update);
576 }
577
578 static Vector<Function<void ()>>& postResolutionCallbackQueue()
579 {
580     static NeverDestroyed<Vector<Function<void ()>>> vector;
581     return vector;
582 }
583
584 void queuePostResolutionCallback(Function<void ()>&& callback)
585 {
586     postResolutionCallbackQueue().append(WTFMove(callback));
587 }
588
589 static void suspendMemoryCacheClientCalls(Document& document)
590 {
591     Page* page = document.page();
592     if (!page || !page->areMemoryCacheClientCallsEnabled())
593         return;
594
595     page->setMemoryCacheClientCallsEnabled(false);
596
597     postResolutionCallbackQueue().append([protectedMainFrame = makeRef(page->mainFrame())] {
598         if (Page* page = protectedMainFrame->page())
599             page->setMemoryCacheClientCallsEnabled(true);
600     });
601 }
602
603 static unsigned resolutionNestingDepth;
604
605 PostResolutionCallbackDisabler::PostResolutionCallbackDisabler(Document& document)
606 {
607     ++resolutionNestingDepth;
608
609     if (resolutionNestingDepth == 1)
610         platformStrategies()->loaderStrategy()->suspendPendingRequests();
611
612     // FIXME: It's strange to build this into the disabler.
613     suspendMemoryCacheClientCalls(document);
614 }
615
616 PostResolutionCallbackDisabler::~PostResolutionCallbackDisabler()
617 {
618     if (resolutionNestingDepth == 1) {
619         // Get size each time through the loop because a callback can add more callbacks to the end of the queue.
620         auto& queue = postResolutionCallbackQueue();
621         for (size_t i = 0; i < queue.size(); ++i)
622             queue[i]();
623         queue.clear();
624
625         platformStrategies()->loaderStrategy()->resumePendingRequests();
626     }
627
628     --resolutionNestingDepth;
629 }
630
631 bool postResolutionCallbacksAreSuspended()
632 {
633     return resolutionNestingDepth;
634 }
635
636 }
637 }