Apply FINAL to the RenderObject hierarchy.
[WebKit-https.git] / Source / WebCore / rendering / mathml / RenderMathMLBlock.h
1 /*
2  * Copyright (C) 2010 Alex Milowski (alex@milowski.com). All rights reserved.
3  * Copyright (C) 2012 David Barton (dbarton@mathscribe.com). All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
15  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
16  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
17  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
18  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
19  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
20  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #ifndef RenderMathMLBlock_h
28 #define RenderMathMLBlock_h
29
30 #if ENABLE(MATHML)
31
32 #include "RenderFlexibleBox.h"
33 #include "RenderTable.h"
34 #include "StyleInheritedData.h"
35
36 #define ENABLE_DEBUG_MATH_LAYOUT 0
37
38 namespace WebCore {
39     
40 class RenderMathMLOperator;
41
42 class RenderMathMLBlock : public RenderFlexibleBox {
43 public:
44     RenderMathMLBlock(Element* container);
45
46     virtual bool isChildAllowed(RenderObject*, RenderStyle*) const;
47     
48     virtual bool isRenderMathMLBlock() const { return true; }
49     virtual bool isRenderMathMLOperator() const { return false; }
50     virtual bool isRenderMathMLRow() const { return false; }
51     virtual bool isRenderMathMLMath() const { return false; }
52     virtual bool isRenderMathMLFenced() const { return false; }
53     virtual bool isRenderMathMLFraction() const { return false; }
54     virtual bool isRenderMathMLRoot() const { return false; }
55     virtual bool isRenderMathMLSpace() const { return false; }
56     virtual bool isRenderMathMLSquareRoot() const { return false; }
57     virtual bool isRenderMathMLSubSup() const { return false; }
58     virtual bool isRenderMathMLUnderOver() const { return false; }
59     
60     // MathML defines an "embellished operator" as roughly an <mo> that may have subscripts,
61     // superscripts, underscripts, overscripts, or a denominator (as in d/dx, where "d" is some
62     // differential operator). The padding, precedence, and stretchiness of the base <mo> should
63     // apply to the embellished operator as a whole. unembellishedOperator() checks for being an
64     // embellished operator, and omits any embellishments.
65     // FIXME: We don't yet handle all the cases in the MathML spec. See
66     // https://bugs.webkit.org/show_bug.cgi?id=78617.
67     virtual RenderMathMLOperator* unembellishedOperator() { return 0; }
68     
69     // A MathML element's preferred logical widths often depend on its children's preferred heights, not just their widths.
70     // This is due to operator stretching and other layout fine tuning. We define an element's preferred height to be its
71     // actual height after layout inside a very wide parent.
72     bool isPreferredLogicalHeightDirty() const { return preferredLogicalWidthsDirty() || m_preferredLogicalHeight < 0; }
73     // The caller must ensure !isPreferredLogicalHeightDirty().
74     LayoutUnit preferredLogicalHeight() const { ASSERT(!isPreferredLogicalHeightDirty()); return m_preferredLogicalHeight; }
75     static const int preferredLogicalHeightUnset = -1;
76     void setPreferredLogicalHeight(LayoutUnit logicalHeight) { m_preferredLogicalHeight = logicalHeight; }
77     // computePreferredLogicalWidths() in derived classes must ensure m_preferredLogicalHeight is set to < 0 or its correct value.
78     virtual void computePreferredLogicalWidths() OVERRIDE;
79     
80     virtual int baselinePosition(FontBaseline, bool firstLine, LineDirectionMode, LinePositionMode = PositionOnContainingLine) const OVERRIDE;
81     
82 #if ENABLE(DEBUG_MATH_LAYOUT)
83     virtual void paint(PaintInfo&, const LayoutPoint&);
84 #endif
85     
86     // Create a new RenderMathMLBlock, with a new style inheriting from this->style().
87     RenderMathMLBlock* createAnonymousMathMLBlock(EDisplay = FLEX);
88     
89     void setIgnoreInAccessibilityTree(bool flag) { m_ignoreInAccessibilityTree = flag; }
90     bool ignoreInAccessibilityTree() const { return m_ignoreInAccessibilityTree; }
91     
92 private:
93     virtual const char* renderName() const OVERRIDE;
94     bool m_ignoreInAccessibilityTree;
95     
96 protected:
97     // Set our logical width to a large value, and compute our children's preferred logical heights.
98     void computeChildrenPreferredLogicalHeights();
99     // This can only be called after children have been sized by computeChildrenPreferredLogicalHeights().
100     static LayoutUnit preferredLogicalHeightAfterSizing(RenderObject* child);
101     
102     // m_preferredLogicalHeight is dirty if it's < 0 or preferredLogicalWidthsDirty().
103     LayoutUnit m_preferredLogicalHeight;
104 };
105
106 inline RenderMathMLBlock* toRenderMathMLBlock(RenderObject* object)
107
108     ASSERT_WITH_SECURITY_IMPLICATION(!object || object->isRenderMathMLBlock());
109     return static_cast<RenderMathMLBlock*>(object);
110 }
111
112 inline const RenderMathMLBlock* toRenderMathMLBlock(const RenderObject* object)
113
114     ASSERT_WITH_SECURITY_IMPLICATION(!object || object->isRenderMathMLBlock());
115     return static_cast<const RenderMathMLBlock*>(object);
116 }
117
118 // This will catch anyone doing an unnecessary cast.
119 void toRenderMathMLBlock(const RenderMathMLBlock*);
120
121 class RenderMathMLTable FINAL : public RenderTable {
122 public:
123     explicit RenderMathMLTable(Element* element) : RenderTable(element) { }
124     
125     virtual int firstLineBoxBaseline() const OVERRIDE;
126     
127 private:
128     virtual const char* renderName() const OVERRIDE { return "RenderMathMLTable"; }
129 };
130
131 // Parsing functions for MathML Length values
132 bool parseMathMLLength(const String&, LayoutUnit&, const RenderStyle*, bool allowNegative = true);
133 bool parseMathMLNamedSpace(const String&, LayoutUnit&, const RenderStyle*, bool allowNegative = true);
134 }
135
136 #endif // ENABLE(MATHML)
137 #endif // RenderMathMLBlock_h