[LayoutReloaded] Decouple formatting state and context lifetime.
[WebKit-https.git] / Tools / LayoutReloaded / FormattingState / FormattingState.js
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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 class FormattingState {
27     constructor(layoutState, formattingRoot) {
28         this.m_layoutState = layoutState;
29         this.m_formattingRoot = formattingRoot;
30         this.m_floatingState = null;
31         this.m_displayToLayout = new Map();
32     }
33
34     formattingRoot() {
35         return this.m_formattingRoot;
36     }
37
38     layoutState() {
39         return this.m_layoutState;
40     }
41
42     floatingState() {
43         return this.m_floatingState;
44     }
45
46     createDisplayBox(layoutBox) {
47         let displayBox = new Display.Box(layoutBox.node());
48         this.m_displayToLayout.set(layoutBox, displayBox);
49     }
50
51     displayBoxMap() {
52         return this.m_displayToLayout;
53     }
54
55     displayBox(layoutBox) {
56         ASSERT(layoutBox);
57         // 1. Normally we only need to access boxes within the same formatting context
58         // 2. In some cases we need size information about the root container -which is in the parent formatting context
59         // 3. In rare cases (statically positioned out-of-flow box), we need position information on sibling formatting context
60         // but in all cases it needs to be a descendant of the root container (or the container itself)
61         ASSERT(layoutBox == this.formattingRoot() || layoutBox.isDescendantOf(this.formattingRoot()));
62         let displayBox = this.m_displayToLayout.get(layoutBox);
63         if (displayBox)
64             return displayBox;
65
66         let formattingStates = this.layoutState().formattingStates();
67         for (let formattingState of formattingStates) {
68             let displayBox = formattingState[1].displayBoxMap().get(layoutBox);
69             if (displayBox)
70                 return displayBox;
71         }
72         // It must be the ICB.
73         ASSERT(!layoutBox.parent());
74         return this.layoutState().initialDisplayBox();
75     }
76 }