[LayoutReloaded] Collect out-of-flow positioned boxes for a given formatting context.
[WebKit-https.git] / Tools / LayoutReloaded / LayoutTree / Container.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 Layout.Container = class Container extends Layout.Box {
27     constructor(node, id) {
28         super(node, id);
29         this.m_firstChild = null;
30         this.m_lastChild = null;
31     }
32
33     isContainer() {
34         return true;
35     }
36
37     setFirstChild(firstChild) {
38         this.m_firstChild = firstChild;
39     }
40     
41     setLastChild(lastChild) {
42         this.m_lastChild = lastChild;
43     }
44
45     firstChild() {
46         return this.m_firstChild;
47     }
48
49     firstInFlowChild() {
50         if (!this.hasChild())
51             return null;
52         let firstChild = this.firstChild();
53         if (firstChild.isInFlow())
54             return firstChild;
55         return firstChild.nextInFlowSibling();
56     }
57
58     firstInFlowOrFloatChild() {
59         if (!this.hasChild())
60             return null;
61         let firstChild = this.firstChild();
62         if (firstChild.isInFlow() || firstChild.isFloatingPositioned())
63             return firstChild;
64         return firstChild.nextInFlowOrFloatSibling();
65     }
66
67     lastChild() {
68         return this.m_lastChild;
69     }
70
71     lastInFlowChild() {
72         if (!this.hasChild())
73             return null;
74         let lastChild = this.lastChild();
75         if (lastChild.isInFlow())
76             return lastChild;
77         return lastChild.previousInFlowSibling();
78     }
79
80     hasChild() {
81         return !!this.firstChild();
82     }
83
84     hasInFlowChild() {
85         return !!this.firstInFlowChild();
86     }
87
88     hasInFlowOrFloatChild() {
89         return !!this.firstInFlowOrFloatChild();
90     }
91
92     outOfFlowDescendants() {
93         if (!this.isPositioned())
94             return new Array();
95         let outOfFlowBoxes = new Array();
96         let descendants = new Array();
97         for (let child = this.firstChild(); child; child = child.nextSibling())
98             descendants.push(child);
99         while (descendants.length) {
100             let descendant = descendants.pop();
101             if (descendant.isOutOfFlowPositioned() && descendant.containingBlock() == this)
102                 outOfFlowBoxes.push(descendant);
103             if (!descendant.isContainer())
104                 continue;
105             for (let child = descendant.lastChild(); child; child = child.previousSibling())
106                 descendants.push(child);
107         }
108         return outOfFlowBoxes;
109     }
110
111
112 }