Introduce RenderTreeBuilder
[WebKit-https.git] / Source / WebCore / style / 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     class FirstLetter;
55     class ListItem;
56
57 private:
58     class GeneratedContent;
59     class MultiColumn;
60
61     void updateRenderTree(ContainerNode& root);
62     void updateTextRenderer(Text&, const Style::TextUpdate*);
63     void createTextRenderer(Text&, const Style::TextUpdate*);
64     void updateElementRenderer(Element&, const Style::ElementUpdate&);
65     void createRenderer(Element&, RenderStyle&&);
66     void updateBeforeDescendants(Element&, const Style::ElementUpdates*);
67     void updateAfterDescendants(Element&, const Style::ElementUpdates*);
68     bool textRendererIsNeeded(const Text& textNode);
69     void storePreviousRenderer(Node&);
70
71     struct Parent {
72         Element* element { nullptr };
73         const Style::ElementUpdates* updates { nullptr };
74         std::optional<RenderTreePosition> renderTreePosition;
75
76         bool didCreateOrDestroyChildRenderer { false };
77         RenderObject* previousChildRenderer { nullptr };
78
79         Parent(ContainerNode& root);
80         Parent(Element&, const Style::ElementUpdates*);
81     };
82     Parent& parent() { return m_parentStack.last(); }
83     Parent& renderingParent();
84     RenderTreePosition& renderTreePosition();
85
86     GeneratedContent& generatedContent() { return *m_generatedContent; }
87
88     void pushParent(Element&, const Style::ElementUpdates*);
89     void popParent();
90     void popParentsToDepth(unsigned depth);
91
92     enum class TeardownType { Full, RendererUpdate, RendererUpdateCancelingAnimations };
93     static void tearDownRenderers(Element&, TeardownType);
94     static void tearDownTextRenderer(Text&);
95
96     RenderView& renderView();
97
98     Document& m_document;
99     std::unique_ptr<const Style::Update> m_styleUpdate;
100
101     Vector<Parent> m_parentStack;
102
103     std::unique_ptr<GeneratedContent> m_generatedContent;
104
105     RenderTreeBuilder m_builder;
106 };
107
108 } // namespace WebCore