Computing animated style should not require renderers
[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, nullptr, &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 #if ENABLE(CSS_REGIONS)
166     if (element.shouldMoveToFlowThread(newStyle))
167         return true;
168 #endif
169     return false;
170 }
171
172 static const RenderStyle* renderOrDisplayContentsStyle(const Element& element)
173 {
174     if (auto* renderStyle = element.renderStyle())
175         return renderStyle;
176     if (element.hasDisplayContents())
177         return element.existingComputedStyle();
178     return nullptr;
179 }
180
181 ElementUpdate TreeResolver::resolveElement(Element& element)
182 {
183     if (m_didSeePendingStylesheet && !element.renderer() && !m_document.isIgnoringPendingStylesheets()) {
184         m_document.setHasNodesWithMissingStyle();
185         return { };
186     }
187
188     auto newStyle = styleForElement(element, parent().style);
189
190     if (!affectsRenderedSubtree(element, *newStyle))
191         return { };
192
193     auto* existingStyle = renderOrDisplayContentsStyle(element);
194
195     if (m_didSeePendingStylesheet && (!existingStyle || existingStyle->isNotFinal())) {
196         newStyle->setIsNotFinal();
197         m_document.setHasNodesWithNonFinalStyle();
198     }
199
200     auto update = createAnimatedElementUpdate(WTFMove(newStyle), element, parent().change);
201
202     if (&element == m_document.documentElement()) {
203         m_documentElementStyle = RenderStyle::clonePtr(*update.style);
204         scope().styleResolver.setOverrideDocumentElementStyle(m_documentElementStyle.get());
205
206         if (update.change != NoChange && existingStyle && existingStyle->computedFontPixelSize() != update.style->computedFontPixelSize()) {
207             // "rem" units are relative to the document element's font size so we need to recompute everything.
208             // In practice this is rare.
209             scope().styleResolver.invalidateMatchedPropertiesCache();
210             update.change = std::max(update.change, Force);
211         }
212     }
213
214     // This is needed for resolving color:-webkit-text for subsequent elements.
215     // FIXME: We shouldn't mutate document when resolving style.
216     if (&element == m_document.body())
217         m_document.setTextColor(update.style->visitedDependentColor(CSSPropertyColor));
218
219     // FIXME: These elements should not change renderer based on appearance property.
220     if (element.hasTagName(HTMLNames::meterTag) || is<HTMLProgressElement>(element)) {
221         if (existingStyle && update.style->appearance() != existingStyle->appearance())
222             update.change = Detach;
223     }
224
225     return update;
226 }
227
228 const RenderStyle* TreeResolver::parentBoxStyle() const
229 {
230     // 'display: contents' doesn't generate boxes.
231     for (unsigned i = m_parentStack.size(); i; --i) {
232         auto& parent = m_parentStack[i - 1];
233         if (parent.style.display() == NONE)
234             return nullptr;
235         if (parent.style.display() != CONTENTS)
236             return &parent.style;
237     }
238     ASSERT_NOT_REACHED();
239     return nullptr;
240 }
241
242 ElementUpdate TreeResolver::createAnimatedElementUpdate(std::unique_ptr<RenderStyle> newStyle, Element& element, Change parentChange)
243 {
244     auto& animationController = element.document().frame()->animation();
245
246     auto* oldStyle = renderOrDisplayContentsStyle(element);
247     auto animationUpdate = animationController.updateAnimations(element, *newStyle, oldStyle);
248
249     if (animationUpdate.style)
250         newStyle = WTFMove(animationUpdate.style);
251
252     auto change = oldStyle ? determineChange(*oldStyle, *newStyle) : Detach;
253
254     auto validity = element.styleValidity();
255     if (validity >= Validity::SubtreeInvalid)
256         change = std::max(change, validity == Validity::SubtreeAndRenderersInvalid ? Detach : Force);
257     if (parentChange >= Force)
258         change = std::max(change, parentChange);
259
260     bool shouldRecompositeLayer = element.styleResolutionShouldRecompositeLayer() || animationUpdate.stateChanged;
261
262     return { WTFMove(newStyle), change, shouldRecompositeLayer };
263 }
264
265 void TreeResolver::pushParent(Element& element, const RenderStyle& style, Change change)
266 {
267     scope().selectorFilter.pushParent(&element);
268
269     Parent parent(element, style, change);
270
271     if (auto* shadowRoot = element.shadowRoot()) {
272         pushScope(*shadowRoot);
273         parent.didPushScope = true;
274     }
275     else if (is<HTMLSlotElement>(element) && downcast<HTMLSlotElement>(element).assignedNodes()) {
276         pushEnclosingScope();
277         parent.didPushScope = true;
278     }
279
280     m_parentStack.append(WTFMove(parent));
281 }
282
283 void TreeResolver::popParent()
284 {
285     auto& parentElement = *parent().element;
286
287     parentElement.setHasValidStyle();
288     parentElement.clearChildNeedsStyleRecalc();
289
290     if (parent().didPushScope)
291         popScope();
292
293     scope().selectorFilter.popParent();
294
295     m_parentStack.removeLast();
296 }
297
298 void TreeResolver::popParentsToDepth(unsigned depth)
299 {
300     ASSERT(depth);
301     ASSERT(m_parentStack.size() >= depth);
302
303     while (m_parentStack.size() > depth)
304         popParent();
305 }
306
307 static bool shouldResolvePseudoElement(const PseudoElement* pseudoElement)
308 {
309     if (!pseudoElement)
310         return false;
311     return pseudoElement->needsStyleRecalc();
312 }
313
314 static bool shouldResolveElement(const Element& element, Style::Change parentChange)
315 {
316     if (parentChange >= Inherit)
317         return true;
318     if (parentChange == NoInherit) {
319         auto* existingStyle = renderOrDisplayContentsStyle(element);
320         if (existingStyle && existingStyle->hasExplicitlyInheritedProperties())
321             return true;
322     }
323     if (element.needsStyleRecalc())
324         return true;
325     if (shouldResolvePseudoElement(element.beforePseudoElement()))
326         return true;
327     if (shouldResolvePseudoElement(element.afterPseudoElement()))
328         return true;
329
330     return false;
331 }
332
333 static void clearNeedsStyleResolution(Element& element)
334 {
335     element.setHasValidStyle();
336     if (auto* before = element.beforePseudoElement())
337         before->setHasValidStyle();
338     if (auto* after = element.afterPseudoElement())
339         after->setHasValidStyle();
340 }
341
342 static bool hasLoadingStylesheet(const Style::Scope& styleScope, const Element& element, bool checkDescendants)
343 {
344     if (!styleScope.hasPendingSheetsInBody())
345         return false;
346     if (styleScope.hasPendingSheetInBody(element))
347         return true;
348     if (!checkDescendants)
349         return false;
350     for (auto& descendant : descendantsOfType<Element>(element)) {
351         if (styleScope.hasPendingSheetInBody(descendant))
352             return true;
353     };
354     return false;
355 }
356
357 void TreeResolver::resolveComposedTree()
358 {
359     ASSERT(m_parentStack.size() == 1);
360     ASSERT(m_scopeStack.size() == 1);
361
362     auto descendants = composedTreeDescendants(m_document);
363     auto it = descendants.begin();
364     auto end = descendants.end();
365
366     // FIXME: SVG <use> element may cause tree mutations during style recalc.
367     it.dropAssertions();
368
369     while (it != end) {
370         popParentsToDepth(it.depth());
371
372         auto& node = *it;
373         auto& parent = this->parent();
374
375         ASSERT(node.isConnected());
376         ASSERT(node.containingShadowRoot() == scope().shadowRoot);
377         ASSERT(node.parentElement() == parent.element || is<ShadowRoot>(node.parentNode()) || node.parentElement()->shadowRoot());
378
379         if (is<Text>(node)) {
380             auto& text = downcast<Text>(node);
381             if (text.styleValidity() >= Validity::SubtreeAndRenderersInvalid && parent.change != Detach)
382                 m_update->addText(text, parent.element, { });
383
384             text.setHasValidStyle();
385             it.traverseNextSkippingChildren();
386             continue;
387         }
388
389         auto& element = downcast<Element>(node);
390
391         if (it.depth() > Settings::defaultMaximumRenderTreeDepth) {
392             resetStyleForNonRenderedDescendants(element);
393             element.clearChildNeedsStyleRecalc();
394             it.traverseNextSkippingChildren();
395             continue;
396         }
397
398         // FIXME: We should deal with this during style invalidation.
399         bool affectedByPreviousSibling = element.styleIsAffectedByPreviousSibling() && parent.elementNeedingStyleRecalcAffectsNextSiblingElementStyle;
400         if (element.needsStyleRecalc() || parent.elementNeedingStyleRecalcAffectsNextSiblingElementStyle)
401             parent.elementNeedingStyleRecalcAffectsNextSiblingElementStyle = element.affectsNextSiblingElementStyle();
402
403         auto* style = renderOrDisplayContentsStyle(element);
404         auto change = NoChange;
405
406         bool shouldResolve = shouldResolveElement(element, parent.change) || affectedByPreviousSibling;
407         if (shouldResolve) {
408             if (!element.hasDisplayContents())
409                 element.resetComputedStyle();
410             element.resetStyleRelations();
411
412             if (element.hasCustomStyleResolveCallbacks())
413                 element.willRecalcStyle(parent.change);
414
415             auto elementUpdate = resolveElement(element);
416
417             if (element.hasCustomStyleResolveCallbacks())
418                 element.didRecalcStyle(elementUpdate.change);
419
420             style = elementUpdate.style.get();
421             change = elementUpdate.change;
422
423             if (affectedByPreviousSibling && change != Detach)
424                 change = Force;
425
426             if (elementUpdate.style)
427                 m_update->addElement(element, parent.element, WTFMove(elementUpdate));
428
429             clearNeedsStyleResolution(element);
430         }
431
432         if (!style) {
433             resetStyleForNonRenderedDescendants(element);
434             element.clearChildNeedsStyleRecalc();
435         }
436
437         bool shouldIterateChildren = style && (element.childNeedsStyleRecalc() || change != NoChange);
438
439         if (!m_didSeePendingStylesheet)
440             m_didSeePendingStylesheet = hasLoadingStylesheet(m_document.styleScope(), element, !shouldIterateChildren);
441
442         if (!shouldIterateChildren) {
443             it.traverseNextSkippingChildren();
444             continue;
445         }
446
447         pushParent(element, *style, change);
448
449         it.traverseNext();
450     }
451
452     popParentsToDepth(1);
453 }
454
455 std::unique_ptr<Update> TreeResolver::resolve()
456 {
457     auto& renderView = *m_document.renderView();
458
459     Element* documentElement = m_document.documentElement();
460     if (!documentElement) {
461         m_document.styleScope().resolver();
462         return nullptr;
463     }
464     if (!documentElement->childNeedsStyleRecalc() && !documentElement->needsStyleRecalc())
465         return nullptr;
466
467     m_didSeePendingStylesheet = m_document.styleScope().hasPendingSheetsBeforeBody();
468
469     m_update = std::make_unique<Update>(m_document);
470     m_scopeStack.append(adoptRef(*new Scope(m_document)));
471     m_parentStack.append(Parent(m_document));
472
473     // Pseudo element removal and similar may only work with these flags still set. Reset them after the style recalc.
474     renderView.setUsesFirstLineRules(renderView.usesFirstLineRules() || scope().styleResolver.usesFirstLineRules());
475     renderView.setUsesFirstLetterRules(renderView.usesFirstLetterRules() || scope().styleResolver.usesFirstLetterRules());
476
477     resolveComposedTree();
478
479     renderView.setUsesFirstLineRules(scope().styleResolver.usesFirstLineRules());
480     renderView.setUsesFirstLetterRules(scope().styleResolver.usesFirstLetterRules());
481
482     ASSERT(m_scopeStack.size() == 1);
483     ASSERT(m_parentStack.size() == 1);
484     m_parentStack.clear();
485     popScope();
486
487     if (m_update->roots().isEmpty())
488         return { };
489
490     return WTFMove(m_update);
491 }
492
493 static Vector<Function<void ()>>& postResolutionCallbackQueue()
494 {
495     static NeverDestroyed<Vector<Function<void ()>>> vector;
496     return vector;
497 }
498
499 void queuePostResolutionCallback(Function<void ()>&& callback)
500 {
501     postResolutionCallbackQueue().append(WTFMove(callback));
502 }
503
504 static void suspendMemoryCacheClientCalls(Document& document)
505 {
506     Page* page = document.page();
507     if (!page || !page->areMemoryCacheClientCallsEnabled())
508         return;
509
510     page->setMemoryCacheClientCallsEnabled(false);
511
512     postResolutionCallbackQueue().append([protectedMainFrame = Ref<MainFrame>(page->mainFrame())] {
513         if (Page* page = protectedMainFrame->page())
514             page->setMemoryCacheClientCallsEnabled(true);
515     });
516 }
517
518 static unsigned resolutionNestingDepth;
519
520 PostResolutionCallbackDisabler::PostResolutionCallbackDisabler(Document& document)
521 {
522     ++resolutionNestingDepth;
523
524     if (resolutionNestingDepth == 1)
525         platformStrategies()->loaderStrategy()->suspendPendingRequests();
526
527     // FIXME: It's strange to build this into the disabler.
528     suspendMemoryCacheClientCalls(document);
529 }
530
531 PostResolutionCallbackDisabler::~PostResolutionCallbackDisabler()
532 {
533     if (resolutionNestingDepth == 1) {
534         // Get size each time through the loop because a callback can add more callbacks to the end of the queue.
535         auto& queue = postResolutionCallbackQueue();
536         for (size_t i = 0; i < queue.size(); ++i)
537             queue[i]();
538         queue.clear();
539
540         platformStrategies()->loaderStrategy()->resumePendingRequests();
541     }
542
543     --resolutionNestingDepth;
544 }
545
546 bool postResolutionCallbacksAreSuspended()
547 {
548     return resolutionNestingDepth;
549 }
550
551 }
552 }