[LFC] Implement LayoutContext::createDisplayBox
[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 "LayoutBox.h"
33 #include <wtf/IsoMalloc.h>
34
35 namespace WebCore {
36
37 namespace Display {
38 class Box;
39 }
40
41 namespace Layout {
42
43 class StyleDiff;
44
45 // LayoutContext is the entry point for layout. It takes a (formatting root)container which acts as the root of the layout context.
46 // LayoutContext::layout() generates the display tree for the root container's subtree (it does not run layout on the root though).
47 // 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
48 // subsequent layouts (subtree layout).
49 // LayoutContext also holds the formatting states. They cache formatting context specific data to enable performant incremental layouts.
50 class LayoutContext {
51     WTF_MAKE_ISO_ALLOCATED(LayoutContext);
52 public:
53     LayoutContext(const Box& root);
54
55     void updateLayout();
56
57     Display::Box& createDisplayBox(const Box&);
58     Display::Box* displayBoxForLayoutBox(const Box& layoutBox) const { return m_layoutToDisplayBox.get(&layoutBox); }
59
60     void markNeedsLayout(const Box&, StyleDiff);
61     bool needsLayout(const Box&) const;
62
63     FormattingState& formattingStateForBox(const Box&) const;
64     FormattingState& establishedFormattingState(const Box& formattingContextRoot, const FormattingContext&);
65     std::unique_ptr<FormattingContext> formattingContext(const Box& formattingContextRoot);
66
67 private:
68     WeakPtr<Box> m_root;
69     HashMap<const Box*, std::unique_ptr<FormattingState>> m_formattingStates;
70     HashMap<const Box*, std::unique_ptr<Display::Box>> m_layoutToDisplayBox;
71 };
72
73 }
74 }
75 #endif