[LFC] Set the invalidation root as the result of style change.
[WebKit-https.git] / Source / WebCore / layout / LayoutContext.h
1 /*
2  * Copyright (C) 2018 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 #if ENABLE(LAYOUT_FORMATTING_CONTEXT)
29
30 #include "FormattingContext.h"
31 #include "FormattingState.h"
32 #include <wtf/HashSet.h>
33 #include <wtf/IsoMalloc.h>
34 #include <wtf/OptionSet.h>
35
36 namespace WebCore {
37
38 namespace Display {
39 class Box;
40 }
41
42 namespace Layout {
43
44 enum class StyleDiff;
45 class Box;
46 class Container;
47
48 // LayoutContext is the entry point for layout. It takes a (formatting root)container which acts as the root of the layout context.
49 // LayoutContext::layout() generates the display tree for the root container's subtree (it does not run layout on the root though).
50 // Note, while the root container is suppposed to be the entry point for the initial layout, it does not necessarily need to be the entry point of any
51 // subsequent layouts (subtree layout). A non-initial, subtree layout could be initiated on multiple formatting contexts.
52 // Each formatting context has an entry point for layout, which potenitally means multiple entry points per layout frame.
53 // LayoutContext also holds the formatting states. They cache formatting context specific data to enable performant incremental layouts.
54 class LayoutContext {
55     WTF_MAKE_ISO_ALLOCATED(LayoutContext);
56 public:
57     LayoutContext(const Box& root);
58
59     void updateLayout();
60
61     Display::Box& createDisplayBox(const Box&);
62     Display::Box* displayBoxForLayoutBox(const Box& layoutBox) const { return m_layoutToDisplayBox.get(&layoutBox); }
63
64     void styleChanged(const Box&, StyleDiff);
65
66     enum class UpdateType {
67         Overflow = 1 << 0,
68         Position = 1 << 1,
69         Size     = 1 << 2,
70         All      = Overflow | Position | Size
71     };
72     void markNeedsUpdate(const Box&, OptionSet<UpdateType>);
73     bool needsUpdate(const Box&) const;
74
75     FormattingState& formattingStateForBox(const Box&) const;
76     FormattingState& establishedFormattingState(const Box& formattingContextRoot, const FormattingContext&);
77     std::unique_ptr<FormattingContext> formattingContext(const Box& formattingContextRoot);
78
79 private:
80     WeakPtr<Box> m_root;
81     HashSet<const Container*> m_formattingContextRootListForLayout;
82     HashMap<const Box*, std::unique_ptr<FormattingState>> m_formattingStates;
83     HashMap<const Box*, std::unique_ptr<Display::Box>> m_layoutToDisplayBox;
84 };
85
86 }
87 }
88 #endif