56e3cde695103ef254644731411be67ed21cd0a5
[WebKit-https.git] / Source / WebCore / rendering / RenderMultiColumnBlock.h
1 /*
2  * Copyright (C) 2012 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 COMPUTER, 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
27 #ifndef RenderMultiColumnBlock_h
28 #define RenderMultiColumnBlock_h
29
30 #include "RenderBlockFlow.h"
31
32 namespace WebCore {
33
34 class RenderMultiColumnFlowThread;
35
36 class RenderMultiColumnBlock FINAL : public RenderBlockFlow {
37 public:
38     explicit RenderMultiColumnBlock(Element&);
39     Element& existingElement() const { return *RenderBlockFlow::element(); }
40
41     LayoutUnit columnHeightAvailable() const { return m_columnHeightAvailable; }
42
43     LayoutUnit columnWidth() const { return m_columnWidth; }
44     unsigned columnCount() const { return m_columnCount; }
45
46     RenderMultiColumnFlowThread* flowThread() const { return m_flowThread; }
47
48     bool requiresBalancing() const { return !m_columnHeightAvailable; }
49
50 private:
51     void element() const WTF_DELETED_FUNCTION;
52
53     virtual bool isRenderMultiColumnBlock() const { return true; }
54     virtual const char* renderName() const;
55
56     virtual RenderObject* layoutSpecialExcludedChild(bool relayoutChildren) OVERRIDE;
57
58     virtual void styleDidChange(StyleDifference, const RenderStyle*) OVERRIDE;
59     
60     virtual bool updateLogicalWidthAndColumnWidth() OVERRIDE;
61     virtual void checkForPaginationLogicalHeightChange(LayoutUnit& pageLogicalHeight, bool& pageLogicalHeightChanged, bool& hasSpecifiedPageLogicalHeight) OVERRIDE;
62     virtual bool relayoutForPagination(bool hasSpecifiedPageLogicalHeight, LayoutUnit pageLogicalHeight, LayoutStateMaintainer&) OVERRIDE;
63
64     virtual void addChild(RenderObject* newChild, RenderObject* beforeChild = 0) OVERRIDE;
65
66     void computeColumnCountAndWidth();
67
68     void ensureColumnSets();
69
70     RenderMultiColumnFlowThread* m_flowThread;
71     unsigned m_columnCount;   // The default column count/width that are based off our containing block width. These values represent only the default,
72     LayoutUnit m_columnWidth; // since a multi-column block that is split across variable width pages or regions will have different column counts and widths in each.
73                               // These values will be cached (eventually) for multi-column blocks.
74     LayoutUnit m_columnHeightAvailable; // Total height available to columns, or 0 if auto.
75     bool m_inBalancingPass; // Set when relayouting for column balancing.
76 };
77
78 inline RenderMultiColumnBlock* toRenderMultiColumnBlock(RenderObject* object)
79 {
80     ASSERT_WITH_SECURITY_IMPLICATION(!object || object->isRenderMultiColumnBlock());
81     return static_cast<RenderMultiColumnBlock*>(object);
82 }
83
84 inline const RenderMultiColumnBlock* toRenderMultiColumnBlock(const RenderObject* object)
85 {
86     ASSERT_WITH_SECURITY_IMPLICATION(!object || object->isRenderMultiColumnBlock());
87     return static_cast<const RenderMultiColumnBlock*>(object);
88 }
89
90 // This will catch anyone doing an unnecessary cast.
91 void toRenderMultiColumnBlock(const RenderMultiColumnBlock*);
92
93 } // namespace WebCore
94
95 #endif // RenderMultiColumnBlock_h
96