b3188a8ef3a50760da3431270d17dea212d9b5cf
[WebKit-https.git] / Source / WebCore / rendering / mathml / RenderMathMLBlock.cpp
1 /*
2  * Copyright (C) 2009 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 #include "config.h"
28
29 #if ENABLE(MATHML)
30
31 #include "RenderMathMLBlock.h"
32
33 #include "GraphicsContext.h"
34 #include "LayoutRepainter.h"
35 #include "MathMLNames.h"
36 #include "RenderView.h"
37 #include <wtf/text/StringBuilder.h>
38
39 #if ENABLE(DEBUG_MATH_LAYOUT)
40 #include "PaintInfo.h"
41 #endif
42
43 namespace WebCore {
44
45 using namespace MathMLNames;
46
47 RenderMathMLBlock::RenderMathMLBlock(Element& container, RenderStyle&& style)
48     : RenderBlock(container, WTFMove(style), 0)
49 {
50     setChildrenInline(false); // All of our children must be block-level.
51 }
52
53 RenderMathMLBlock::RenderMathMLBlock(Document& document, RenderStyle&& style)
54     : RenderBlock(document, WTFMove(style), 0)
55 {
56     setChildrenInline(false); // All of our children must be block-level.
57 }
58
59 RenderMathMLBlock::~RenderMathMLBlock()
60 {
61 }
62
63 bool RenderMathMLBlock::isChildAllowed(const RenderObject& child, const RenderStyle&) const
64 {
65     return is<Element>(child.node());
66 }
67
68 LayoutUnit RenderMathMLBlock::mathAxisHeight() const
69 {
70     const auto& primaryFont = style().fontCascade().primaryFont();
71     if (auto* mathData = primaryFont.mathData())
72         return mathData->getMathConstant(primaryFont, OpenTypeMathData::AxisHeight);
73
74     return style().fontMetrics().xHeight() / 2;
75 }
76
77 LayoutUnit RenderMathMLBlock::mirrorIfNeeded(LayoutUnit horizontalOffset, LayoutUnit boxWidth) const
78 {
79     if (style().direction() == RTL)
80         return logicalWidth() - boxWidth - horizontalOffset;
81
82     return horizontalOffset;
83 }
84
85 int RenderMathMLBlock::baselinePosition(FontBaseline baselineType, bool firstLine, LineDirectionMode direction, LinePositionMode linePositionMode) const
86 {
87     // mathml.css sets math { -webkit-line-box-contain: glyphs replaced; line-height: 0; }, so when linePositionMode == PositionOfInteriorLineBoxes we want to
88     // return 0 here to match our line-height. This matters when RootInlineBox::ascentAndDescentForBox is called on a RootInlineBox for an inline-block.
89     if (linePositionMode == PositionOfInteriorLineBoxes)
90         return 0;
91
92     return firstLineBaseline().valueOr(RenderBlock::baselinePosition(baselineType, firstLine, direction, linePositionMode));
93 }
94
95 #if ENABLE(DEBUG_MATH_LAYOUT)
96 void RenderMathMLBlock::paint(PaintInfo& info, const LayoutPoint& paintOffset)
97 {
98     RenderBlock::paint(info, paintOffset);
99
100     if (info.context().paintingDisabled() || info.phase != PaintPhaseForeground)
101         return;
102
103     IntPoint adjustedPaintOffset = roundedIntPoint(paintOffset + location());
104
105     GraphicsContextStateSaver stateSaver(info.context());
106
107     info.context().setStrokeThickness(1.0f);
108     info.context().setStrokeStyle(SolidStroke);
109     info.context().setStrokeColor(Color(0, 0, 255));
110
111     info.context().drawLine(adjustedPaintOffset, IntPoint(adjustedPaintOffset.x() + pixelSnappedOffsetWidth(), adjustedPaintOffset.y()));
112     info.context().drawLine(IntPoint(adjustedPaintOffset.x() + pixelSnappedOffsetWidth(), adjustedPaintOffset.y()), IntPoint(adjustedPaintOffset.x() + pixelSnappedOffsetWidth(), adjustedPaintOffset.y() + pixelSnappedOffsetHeight()));
113     info.context().drawLine(IntPoint(adjustedPaintOffset.x(), adjustedPaintOffset.y() + pixelSnappedOffsetHeight()), IntPoint(adjustedPaintOffset.x() + pixelSnappedOffsetWidth(), adjustedPaintOffset.y() + pixelSnappedOffsetHeight()));
114     info.context().drawLine(adjustedPaintOffset, IntPoint(adjustedPaintOffset.x(), adjustedPaintOffset.y() + pixelSnappedOffsetHeight()));
115
116     int topStart = paddingTop();
117
118     info.context().setStrokeColor(Color(0, 255, 0));
119
120     info.context().drawLine(IntPoint(adjustedPaintOffset.x(), adjustedPaintOffset.y() + topStart), IntPoint(adjustedPaintOffset.x() + pixelSnappedOffsetWidth(), adjustedPaintOffset.y() + topStart));
121
122     int baseline = roundToInt(baselinePosition(AlphabeticBaseline, true, HorizontalLine));
123
124     info.context().setStrokeColor(Color(255, 0, 0));
125
126     info.context().drawLine(IntPoint(adjustedPaintOffset.x(), adjustedPaintOffset.y() + baseline), IntPoint(adjustedPaintOffset.x() + pixelSnappedOffsetWidth(), adjustedPaintOffset.y() + baseline));
127 }
128 #endif // ENABLE(DEBUG_MATH_LAYOUT)
129
130 //
131 // The MathML specification says:
132 // (http://www.w3.org/TR/MathML/chapter2.html#fund.units)
133 //
134 // "Most presentation elements have attributes that accept values representing
135 // lengths to be used for size, spacing or similar properties. The syntax of a
136 // length is specified as
137 //
138 // number | number unit | namedspace
139 //
140 // There should be no space between the number and the unit of a length."
141 //
142 // "A trailing '%' represents a percent of the default value. The default
143 // value, or how it is obtained, is listed in the table of attributes for each
144 // element. [...] A number without a unit is intepreted as a multiple of the
145 // default value."
146 //
147 // "The possible units in MathML are:
148 //
149 // Unit Description
150 // em   an em (font-relative unit traditionally used for horizontal lengths)
151 // ex   an ex (font-relative unit traditionally used for vertical lengths)
152 // px   pixels, or size of a pixel in the current display
153 // in   inches (1 inch = 2.54 centimeters)
154 // cm   centimeters
155 // mm   millimeters
156 // pt   points (1 point = 1/72 inch)
157 // pc   picas (1 pica = 12 points)
158 // %    percentage of default value"
159 //
160 // The numbers are defined that way:
161 // - unsigned-number: "a string of decimal digits with up to one decimal point
162 //   (U+002E), representing a non-negative terminating decimal number (a type of
163 //   rational number)"
164 // - number: "an optional prefix of '-' (U+002D), followed by an unsigned
165 //   number, representing a terminating decimal number (a type of rational
166 //   number)"
167 //
168 bool parseMathMLLength(const String& string, LayoutUnit& lengthValue, const RenderStyle* style, bool allowNegative)
169 {
170     String s = string.simplifyWhiteSpace();
171
172     int stringLength = s.length();
173     if (!stringLength)
174         return false;
175
176     if (parseMathMLNamedSpace(s, lengthValue, style, allowNegative))
177         return true;
178
179     StringBuilder number;
180     String unit;
181
182     // This verifies whether the negative sign is there.
183     int i = 0;
184     UChar c = s[0];
185     if (c == '-') {
186         number.append(c);
187         i++;
188     }
189
190     // This gathers up characters that make up the number.
191     bool gotDot = false;
192     for ( ; i < stringLength; i++) {
193         c = s[i];
194         // The string is invalid if it contains two dots.
195         if (gotDot && c == '.')
196             return false;
197         if (c == '.')
198             gotDot = true;
199         else if (!isASCIIDigit(c)) {
200             unit = s.substring(i, stringLength - i);
201             // Some authors leave blanks before the unit, but that shouldn't
202             // be allowed, so don't simplifyWhitespace on 'unit'.
203             break;
204         }
205         number.append(c);
206     }
207
208     // Convert number to floating point
209     bool ok;
210     float floatValue = number.toString().toFloat(&ok);
211     if (!ok)
212         return false;
213     if (floatValue < 0 && !allowNegative)
214         return false;
215
216     if (unit.isEmpty()) {
217         // no explicit unit, this is a number that will act as a multiplier
218         lengthValue *= floatValue;
219         return true;
220     }
221     if (unit == "%") {
222         lengthValue *= floatValue / 100;
223         return true;
224     }
225     if (unit == "em") {
226         lengthValue = floatValue * style->fontCascade().size();
227         return true;
228     }
229     if (unit == "ex") {
230         lengthValue = floatValue * style->fontMetrics().xHeight();
231         return true;
232     }
233     if (unit == "px") {
234         lengthValue = floatValue;
235         return true;
236     }
237     if (unit == "pt") {
238         lengthValue = 4 * (floatValue / 3);
239         return true;
240     }
241     if (unit == "pc") {
242         lengthValue = 16 * floatValue;
243         return true;
244     }
245     if (unit == "in") {
246         lengthValue = 96 * floatValue;
247         return true;
248     }
249     if (unit == "cm") {
250         lengthValue = 96 * (floatValue / 2.54);
251         return true;
252     }
253     if (unit == "mm") {
254         lengthValue = 96 * (floatValue / 25.4);
255         return true;
256     }
257
258     // unexpected unit
259     return false;
260 }
261
262 bool parseMathMLNamedSpace(const String& string, LayoutUnit& lengthValue, const RenderStyle* style, bool allowNegative)
263 {
264     float length = 0;
265     // See if it is one of the namedspaces (ranging -7/18em, -6/18, ... 7/18em)
266     if (string == "veryverythinmathspace")
267         length = 1;
268     else if (string == "verythinmathspace")
269         length = 2;
270     else if (string == "thinmathspace")
271         length = 3;
272     else if (string == "mediummathspace")
273         length = 4;
274     else if (string == "thickmathspace")
275         length = 5;
276     else if (string == "verythickmathspace")
277         length = 6;
278     else if (string == "veryverythickmathspace")
279         length = 7;
280     else if (allowNegative) {
281         if (string == "negativeveryverythinmathspace")
282             length = -1;
283         else if (string == "negativeverythinmathspace")
284             length = -2;
285         else if (string == "negativethinmathspace")
286             length = -3;
287         else if (string == "negativemediummathspace")
288             length = -4;
289         else if (string == "negativethickmathspace")
290             length = -5;
291         else if (string == "negativeverythickmathspace")
292             length = -6;
293         else if (string == "negativeveryverythickmathspace")
294             length = -7;
295     }
296     if (length) {
297         lengthValue = length * style->fontCascade().size() / 18;
298         return true;
299     }
300     return false;
301 }
302
303 Optional<int> RenderMathMLTable::firstLineBaseline() const
304 {
305     // In legal MathML, we'll have a MathML parent. That RenderFlexibleBox parent will use our firstLineBaseline() for baseline alignment, per
306     // http://dev.w3.org/csswg/css3-flexbox/#flex-baselines. We want to vertically center an <mtable>, such as a matrix. Essentially the whole <mtable> element fits on a
307     // single line, whose baseline gives this centering. This is different than RenderTable::firstLineBoxBaseline, which returns the baseline of the first row of a <table>.
308     return (logicalHeight() + style().fontMetrics().xHeight()) / 2;
309 }
310
311 void RenderMathMLBlock::layoutItems(bool relayoutChildren)
312 {
313     LayoutUnit verticalOffset = borderBefore() + paddingBefore();
314     LayoutUnit horizontalOffset = borderStart() + paddingStart();
315
316     LayoutUnit preferredHorizontalExtent = 0;
317     for (auto* child = firstChildBox(); child; child = child->nextSiblingBox()) {
318         LayoutUnit childHorizontalExtent = child->maxPreferredLogicalWidth() - child->horizontalBorderAndPaddingExtent();
319         LayoutUnit childHorizontalMarginBoxExtent = child->horizontalBorderAndPaddingExtent() + childHorizontalExtent;
320         childHorizontalMarginBoxExtent += child->horizontalMarginExtent();
321
322         preferredHorizontalExtent += childHorizontalMarginBoxExtent;
323     }
324
325     LayoutUnit currentHorizontalExtent = contentLogicalWidth();
326     for (auto* child = firstChildBox(); child; child = child->nextSiblingBox()) {
327         LayoutUnit childSize = child->maxPreferredLogicalWidth() - child->horizontalBorderAndPaddingExtent();
328
329         if (preferredHorizontalExtent > currentHorizontalExtent)
330             childSize = currentHorizontalExtent;
331
332         LayoutUnit childPreferredSize = childSize + child->horizontalBorderAndPaddingExtent();
333
334         if (childPreferredSize != child->width())
335             child->setChildNeedsLayout(MarkOnlyThis);
336
337         updateBlockChildDirtyBitsBeforeLayout(relayoutChildren, *child);
338         child->layoutIfNeeded();
339
340         LayoutUnit childVerticalMarginBoxExtent;
341         childVerticalMarginBoxExtent = child->height() + child->verticalMarginExtent();
342
343         setLogicalHeight(std::max(logicalHeight(), verticalOffset + borderAfter() + paddingAfter() + childVerticalMarginBoxExtent + horizontalScrollbarHeight()));
344
345         horizontalOffset += child->marginStart();
346
347         LayoutUnit childHorizontalExtent = child->width();
348         LayoutPoint childLocation(style().isLeftToRightDirection() ? horizontalOffset : width() - horizontalOffset - childHorizontalExtent,
349             verticalOffset + child->marginBefore());
350
351         child->setLocation(childLocation);
352         horizontalOffset += childHorizontalExtent + child->marginEnd();
353     }
354 }
355
356 void RenderMathMLBlock::layoutBlock(bool relayoutChildren, LayoutUnit)
357 {
358     ASSERT(needsLayout());
359
360     if (!relayoutChildren && simplifiedLayout())
361         return;
362
363     LayoutRepainter repainter(*this, checkForRepaintDuringLayout());
364
365     if (recomputeLogicalWidth())
366         relayoutChildren = true;
367
368     setLogicalHeight(borderAndPaddingLogicalHeight() + scrollbarLogicalHeight());
369
370     layoutItems(relayoutChildren);
371
372     updateLogicalHeight();
373
374     repainter.repaintAfterLayout();
375
376     clearNeedsLayout();
377 }
378
379 }
380
381 #endif