3f9689bf63b6294a829e94c487ded1041b4920f7
[WebKit-https.git] / Source / WebCore / rendering / ColumnInfo.h
1 /*
2  * Copyright (C) 2010, 2011 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 #ifndef ColumnInfo_h
27 #define ColumnInfo_h
28
29 #include "LayoutUnit.h"
30
31 namespace WebCore {
32
33 class ColumnInfo {
34     WTF_MAKE_NONCOPYABLE(ColumnInfo); WTF_MAKE_FAST_ALLOCATED;
35 public:
36     ColumnInfo()
37         : m_desiredColumnWidth(0)
38         , m_desiredColumnCount(1)
39         , m_progressionIsInline(true)
40         , m_progressionIsReversed(false)
41         , m_columnCount(1)
42         , m_columnHeight(0)
43         , m_minimumColumnHeight(0)
44         , m_forcedBreaks(0)
45         , m_maximumDistanceBetweenForcedBreaks(0)
46         , m_forcedBreakOffset(0)
47         , m_paginationUnit(Column)
48     {
49     }
50
51     LayoutUnit desiredColumnWidth() const { return m_desiredColumnWidth; }
52     void setDesiredColumnWidth(LayoutUnit width) { m_desiredColumnWidth = width; }
53     
54     unsigned desiredColumnCount() const { return m_desiredColumnCount; }
55     void setDesiredColumnCount(unsigned count) { m_desiredColumnCount = count; }
56
57     bool progressionIsInline() const { return m_progressionIsInline; }
58     void setProgressionIsInline(bool progressionIsInline) { m_progressionIsInline = progressionIsInline; }
59
60     bool progressionIsReversed() const { return m_progressionIsReversed; }
61     void setProgressionIsReversed(bool reversed) { m_progressionIsReversed = reversed; }
62
63     unsigned columnCount() const { return m_columnCount; }
64     LayoutUnit columnHeight() const { return m_columnHeight; }
65
66     // Set our count and height.  This is enough info for a RenderBlock to compute page rects
67     // dynamically.
68     void setColumnCountAndHeight(int count, LayoutUnit height)
69     { 
70         m_columnCount = count;
71         m_columnHeight = height;
72     }
73     void setColumnHeight(LayoutUnit height) { m_columnHeight = height; }
74
75     void updateMinimumColumnHeight(LayoutUnit height) { m_minimumColumnHeight = std::max(height, m_minimumColumnHeight); }
76     LayoutUnit minimumColumnHeight() const { return m_minimumColumnHeight; }
77
78     int forcedBreaks() const { return m_forcedBreaks; }
79     LayoutUnit forcedBreakOffset() const { return m_forcedBreakOffset; }
80     LayoutUnit maximumDistanceBetweenForcedBreaks() const { return m_maximumDistanceBetweenForcedBreaks; }
81     void clearForcedBreaks()
82     { 
83         m_forcedBreaks = 0;
84         m_maximumDistanceBetweenForcedBreaks = 0;
85         m_forcedBreakOffset = 0;
86     }
87     void addForcedBreak(LayoutUnit offsetFromFirstPage)
88     { 
89         ASSERT(!m_columnHeight);
90         LayoutUnit distanceFromLastBreak = offsetFromFirstPage - m_forcedBreakOffset;
91         if (!distanceFromLastBreak)
92             return;
93         m_forcedBreaks++;
94         m_maximumDistanceBetweenForcedBreaks = std::max(m_maximumDistanceBetweenForcedBreaks, distanceFromLastBreak);
95         m_forcedBreakOffset = offsetFromFirstPage;
96     }
97
98     enum PaginationUnit { Column, Page };
99     PaginationUnit paginationUnit() const { return m_paginationUnit; }
100     void setPaginationUnit(PaginationUnit paginationUnit) { m_paginationUnit = paginationUnit; }
101
102 private:
103     LayoutUnit m_desiredColumnWidth;
104     unsigned m_desiredColumnCount;
105     bool m_progressionIsInline;
106     bool m_progressionIsReversed;
107
108     unsigned m_columnCount;
109     LayoutUnit m_columnHeight;
110     LayoutUnit m_minimumColumnHeight;
111     int m_forcedBreaks; // FIXME: We will ultimately need to cache more information to balance around forced breaks properly.
112     LayoutUnit m_maximumDistanceBetweenForcedBreaks;
113     LayoutUnit m_forcedBreakOffset;
114     PaginationUnit m_paginationUnit;
115 };
116
117 }
118
119 #endif