7d05a963b626b9f91ec4147e1726da7e7aba0c68
[WebKit-https.git] / Source / WebCore / rendering / updating / RenderTreeUpdater.h
1 /*
2  * Copyright (C) 2016-2017 Apple 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "RenderTreeBuilder.h"
29 #include "RenderTreePosition.h"
30 #include "StyleChange.h"
31 #include "StyleUpdate.h"
32 #include <wtf/HashSet.h>
33 #include <wtf/Vector.h>
34
35 namespace WebCore {
36
37 class ContainerNode;
38 class Document;
39 class Element;
40 class Node;
41 class RenderStyle;
42 class Text;
43
44 class RenderTreeUpdater {
45 public:
46     RenderTreeUpdater(Document&);
47     ~RenderTreeUpdater();
48
49     void commit(std::unique_ptr<const Style::Update>);
50
51     static void tearDownRenderers(Element&);
52     static void tearDownRenderer(Text&);
53
54 private:
55     class GeneratedContent;
56
57     void updateRenderTree(ContainerNode& root);
58     void updateTextRenderer(Text&, const Style::TextUpdate*);
59     void createTextRenderer(Text&, const Style::TextUpdate*);
60     void updateElementRenderer(Element&, const Style::ElementUpdate&);
61     void createRenderer(Element&, RenderStyle&&);
62     void updateBeforeDescendants(Element&, const Style::ElementUpdates*);
63     void updateAfterDescendants(Element&, const Style::ElementUpdates*);
64     bool textRendererIsNeeded(const Text& textNode);
65     void storePreviousRenderer(Node&);
66
67     struct Parent {
68         Element* element { nullptr };
69         const Style::ElementUpdates* updates { nullptr };
70         std::optional<RenderTreePosition> renderTreePosition;
71
72         bool didCreateOrDestroyChildRenderer { false };
73         RenderObject* previousChildRenderer { nullptr };
74
75         Parent(ContainerNode& root);
76         Parent(Element&, const Style::ElementUpdates*);
77     };
78     Parent& parent() { return m_parentStack.last(); }
79     Parent& renderingParent();
80     RenderTreePosition& renderTreePosition();
81
82     GeneratedContent& generatedContent() { return *m_generatedContent; }
83
84     void pushParent(Element&, const Style::ElementUpdates*);
85     void popParent();
86     void popParentsToDepth(unsigned depth);
87
88     enum class TeardownType { Full, RendererUpdate, RendererUpdateCancelingAnimations };
89     static void tearDownRenderers(Element&, TeardownType);
90     static void tearDownTextRenderer(Text&);
91     static void tearDownLeftoverShadowHostChildren(Element&);
92     static void tearDownLeftoverPaginationRenderersIfNeeded(Element&);
93
94     RenderView& renderView();
95
96     Document& m_document;
97     std::unique_ptr<const Style::Update> m_styleUpdate;
98
99     Vector<Parent> m_parentStack;
100
101     std::unique_ptr<GeneratedContent> m_generatedContent;
102
103     RenderTreeBuilder m_builder;
104 };
105
106 } // namespace WebCore