82da40b47099b6d20bdd5bb5344bc23551fb0cec
[WebKit-https.git] / Source / WebCore / css / DOMMatrixReadOnly.cpp
1 /*
2  * Copyright (C) 2017 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "DOMMatrixReadOnly.h"
28
29 #include "CSSParser.h"
30 #include "CSSToLengthConversionData.h"
31 #include "DOMMatrix.h"
32 #include "ExceptionCode.h"
33 #include "StyleProperties.h"
34 #include "TransformFunctions.h"
35 #include <JavaScriptCore/GenericTypedArrayViewInlines.h>
36 #include <JavaScriptCore/JSGenericTypedArrayViewInlines.h>
37 #include <heap/HeapInlines.h>
38 #include <wtf/text/StringBuilder.h>
39
40 namespace WebCore {
41
42 DOMMatrixReadOnly::DOMMatrixReadOnly(const TransformationMatrix& matrix, Is2D is2D)
43     : m_matrix(matrix)
44     , m_is2D(is2D == Is2D::Yes)
45 {
46     ASSERT(!m_is2D || m_matrix.isAffine());
47 }
48
49 inline Ref<DOMMatrix> DOMMatrixReadOnly::cloneAsDOMMatrix() const
50 {
51     return DOMMatrix::create(m_matrix, m_is2D ? Is2D::Yes : Is2D::No);
52 }
53
54 // https://drafts.fxtf.org/geometry/#matrix-validate-and-fixup
55 ExceptionOr<void> DOMMatrixReadOnly::validateAndFixup(DOMMatrixInit& init)
56 {
57     if (init.a && init.m11 && init.a.value() != init.m11.value())
58         return Exception { TypeError, ASCIILiteral("init.a and init.m11 do not match") };
59     if (init.b && init.m12 && init.b.value() != init.m12.value())
60         return Exception { TypeError, ASCIILiteral("init.b and init.m12 do not match") };
61     if (init.c && init.m21 && init.c.value() != init.m21.value())
62         return Exception { TypeError, ASCIILiteral("init.c and init.m21 do not match") };
63     if (init.d && init.m22 && init.d.value() != init.m22.value())
64         return Exception { TypeError, ASCIILiteral("init.d and init.m22 do not match") };
65     if (init.e && init.m41 && init.e.value() != init.m41.value())
66         return Exception { TypeError, ASCIILiteral("init.e and init.m41 do not match") };
67     if (init.f && init.m42 && init.f.value() != init.m42.value())
68         return Exception { TypeError, ASCIILiteral("init.f and init.m42 do not match") };
69
70     if (init.is2D && init.is2D.value()) {
71         if (init.m13)
72             return Exception { TypeError, ASCIILiteral("m13 should be 0 for a 2D matrix") };
73         if (init.m14)
74             return Exception { TypeError, ASCIILiteral("m14 should be 0 for a 2D matrix") };
75         if (init.m23)
76             return Exception { TypeError, ASCIILiteral("m23 should be 0 for a 2D matrix") };
77         if (init.m24)
78             return Exception { TypeError, ASCIILiteral("m24 should be 0 for a 2D matrix") };
79         if (init.m31)
80             return Exception { TypeError, ASCIILiteral("m31 should be 0 for a 2D matrix") };
81         if (init.m32)
82             return Exception { TypeError, ASCIILiteral("m32 should be 0 for a 2D matrix") };
83         if (init.m34)
84             return Exception { TypeError, ASCIILiteral("m34 should be 0 for a 2D matrix") };
85         if (init.m43)
86             return Exception { TypeError, ASCIILiteral("m43 should be 0 for a 2D matrix") };
87         if (init.m33 != 1)
88             return Exception { TypeError, ASCIILiteral("m33 should be 1 for a 2D matrix") };
89         if (init.m44 != 1)
90             return Exception { TypeError, ASCIILiteral("m44 should be 1 for a 2D matrix") };
91     }
92
93     if (!init.m11)
94         init.m11 = init.a.value_or(1);
95     if (!init.m12)
96         init.m12 = init.b.value_or(0);
97     if (!init.m21)
98         init.m21 = init.c.value_or(0);
99     if (!init.m22)
100         init.m22 = init.d.value_or(1);
101     if (!init.m41)
102         init.m41 = init.e.value_or(0);
103     if (!init.m42)
104         init.m42 = init.f.value_or(0);
105
106     if (!init.is2D) {
107         if (init.m13 || init.m14 || init.m23 || init.m24 || init.m31 || init.m32 || init.m34 || init.m43 || init.m33 != 1 || init.m44 != 1)
108             init.is2D = false;
109         else
110             init.is2D = true;
111     }
112     return { };
113 }
114
115 ExceptionOr<Ref<DOMMatrixReadOnly>> DOMMatrixReadOnly::fromMatrix(DOMMatrixInit&& init)
116 {
117     return fromMatrixHelper<DOMMatrixReadOnly>(WTFMove(init));
118 }
119
120 ExceptionOr<Ref<DOMMatrixReadOnly>> DOMMatrixReadOnly::fromFloat32Array(Ref<Float32Array>&& array32)
121 {
122     if (array32->length() == 6)
123         return DOMMatrixReadOnly::create(TransformationMatrix(array32->item(0), array32->item(1), array32->item(2), array32->item(3), array32->item(4), array32->item(5)), Is2D::Yes);
124
125     if (array32->length() == 16) {
126         return DOMMatrixReadOnly::create(TransformationMatrix(
127             array32->item(0), array32->item(1), array32->item(2), array32->item(3),
128             array32->item(4), array32->item(5), array32->item(6), array32->item(7),
129             array32->item(8), array32->item(9), array32->item(10), array32->item(11),
130             array32->item(12), array32->item(13), array32->item(14), array32->item(15)
131         ), Is2D::No);
132     }
133
134     return Exception { TypeError };
135 }
136
137 ExceptionOr<Ref<DOMMatrixReadOnly>> DOMMatrixReadOnly::fromFloat64Array(Ref<Float64Array>&& array64)
138 {
139     if (array64->length() == 6)
140         return DOMMatrixReadOnly::create(TransformationMatrix(array64->item(0), array64->item(1), array64->item(2), array64->item(3), array64->item(4), array64->item(5)), Is2D::Yes);
141
142     if (array64->length() == 16) {
143         return DOMMatrixReadOnly::create(TransformationMatrix(
144             array64->item(0), array64->item(1), array64->item(2), array64->item(3),
145             array64->item(4), array64->item(5), array64->item(6), array64->item(7),
146             array64->item(8), array64->item(9), array64->item(10), array64->item(11),
147             array64->item(12), array64->item(13), array64->item(14), array64->item(15)
148         ), Is2D::No);
149     }
150
151     return Exception { TypeError };
152 }
153
154 bool DOMMatrixReadOnly::isIdentity() const
155 {
156     return m_matrix.isIdentity();
157 }
158
159 // https://drafts.fxtf.org/geometry/#dom-dommatrix-setmatrixvalue
160 ExceptionOr<void> DOMMatrixReadOnly::setMatrixValue(const String& string)
161 {
162     if (string.isEmpty())
163         return { };
164
165     auto styleDeclaration = MutableStyleProperties::create();
166     if (CSSParser::parseValue(styleDeclaration, CSSPropertyTransform, string, true, HTMLStandardMode) == CSSParser::ParseResult::Error)
167         return Exception { SYNTAX_ERR };
168
169     // Convert to TransformOperations. This can fail if a property requires style (i.e., param uses 'ems' or 'exs')
170     auto value = styleDeclaration->getPropertyCSSValue(CSSPropertyTransform);
171
172     // Check for a "none" or empty transform. In these cases we can use the default identity matrix.
173     if (!value || (is<CSSPrimitiveValue>(*value) && downcast<CSSPrimitiveValue>(*value).valueID() == CSSValueNone))
174         return { };
175
176     TransformOperations operations;
177     if (!transformsForValue(*value, CSSToLengthConversionData(), operations))
178         return Exception { SYNTAX_ERR };
179
180     m_is2D = true;
181     // Convert transform operations to a TransformationMatrix. This can fail if a parameter has a percentage ('%').
182     TransformationMatrix matrix;
183     for (auto& operation : operations.operations()) {
184         if (operation->apply(matrix, IntSize(0, 0)))
185             return Exception { SYNTAX_ERR };
186         if (operation->is3DOperation())
187             m_is2D = false;
188     }
189     m_matrix = matrix;
190     return { };
191 }
192
193 ExceptionOr<void> DOMMatrixReadOnly::setMatrixValue(const Vector<double>& init)
194 {
195     if (init.size() == 6) {
196         m_matrix = TransformationMatrix { init[0], init[1], init[2], init[3], init[4], init[5] };
197         return { };
198     }
199     if (init.size() == 16) {
200         m_matrix = TransformationMatrix {
201             init[0], init[1], init[2], init[3],
202             init[4], init[5], init[6], init[7],
203             init[8], init[9], init[10], init[11],
204             init[12], init[13], init[14], init[15]
205         };
206         m_is2D = false;
207         return { };
208     }
209     return Exception { TypeError };
210 }
211
212 Ref<DOMMatrix> DOMMatrixReadOnly::translate(double tx, double ty, double tz)
213 {
214     auto matrix = cloneAsDOMMatrix();
215     return matrix->translateSelf(tx, ty, tz);
216 }
217
218 // https://drafts.fxtf.org/geometry/#dom-dommatrixreadonly-flipx
219 Ref<DOMMatrix> DOMMatrixReadOnly::flipX()
220 {
221     auto matrix = cloneAsDOMMatrix();
222     matrix->m_matrix.flipX();
223     return matrix;
224 }
225
226 // https://drafts.fxtf.org/geometry/#dom-dommatrixreadonly-flipy
227 Ref<DOMMatrix> DOMMatrixReadOnly::flipY()
228 {
229     auto matrix = cloneAsDOMMatrix();
230     matrix->m_matrix.flipY();
231     return matrix;
232 }
233
234 ExceptionOr<Ref<DOMMatrix>> DOMMatrixReadOnly::multiply(DOMMatrixInit&& other) const
235 {
236     auto matrix = cloneAsDOMMatrix();
237     return matrix->multiplySelf(WTFMove(other));
238 }
239
240 Ref<DOMMatrix> DOMMatrixReadOnly::scale(double scaleX, std::optional<double> scaleY, double scaleZ, double originX, double originY, double originZ)
241 {
242     auto matrix = cloneAsDOMMatrix();
243     return matrix->scaleSelf(scaleX, scaleY, scaleZ, originX, originY, originZ);
244 }
245
246 Ref<DOMMatrix> DOMMatrixReadOnly::scale3d(double scale, double originX, double originY, double originZ)
247 {
248     auto matrix = cloneAsDOMMatrix();
249     return matrix->scale3dSelf(scale, originX, originY, originZ);
250 }
251
252 Ref<DOMMatrix> DOMMatrixReadOnly::rotate(double rotX, std::optional<double> rotY, std::optional<double> rotZ)
253 {
254     auto matrix = cloneAsDOMMatrix();
255     return matrix->rotateSelf(rotX, rotY, rotZ);
256 }
257
258 Ref<DOMMatrix> DOMMatrixReadOnly::rotateFromVector(double x, double y)
259 {
260     auto matrix = cloneAsDOMMatrix();
261     return matrix->rotateFromVectorSelf(x, y);
262 }
263
264 Ref<DOMMatrix> DOMMatrixReadOnly::rotateAxisAngle(double x, double y, double z, double angle)
265 {
266     auto matrix = cloneAsDOMMatrix();
267     return matrix->rotateAxisAngleSelf(x, y, z, angle);
268 }
269
270 Ref<DOMMatrix> DOMMatrixReadOnly::skewX(double sx)
271 {
272     auto matrix = cloneAsDOMMatrix();
273     return matrix->skewXSelf(sx);
274 }
275
276 Ref<DOMMatrix> DOMMatrixReadOnly::skewY(double sy)
277 {
278     auto matrix = cloneAsDOMMatrix();
279     return matrix->skewYSelf(sy);
280 }
281
282 Ref<DOMMatrix> DOMMatrixReadOnly::inverse() const
283 {
284     auto matrix = cloneAsDOMMatrix();
285     return matrix->invertSelf();
286 }
287
288 ExceptionOr<Ref<Float32Array>> DOMMatrixReadOnly::toFloat32Array() const
289 {
290     auto array32 = Float32Array::createUninitialized(16);
291     if (!array32)
292         return Exception { UnknownError, ASCIILiteral("Out of memory") };
293
294     unsigned index = 0;
295     array32->set(index++, m_matrix.m11());
296     array32->set(index++, m_matrix.m12());
297     array32->set(index++, m_matrix.m13());
298     array32->set(index++, m_matrix.m14());
299     array32->set(index++, m_matrix.m21());
300     array32->set(index++, m_matrix.m22());
301     array32->set(index++, m_matrix.m23());
302     array32->set(index++, m_matrix.m24());
303     array32->set(index++, m_matrix.m31());
304     array32->set(index++, m_matrix.m32());
305     array32->set(index++, m_matrix.m33());
306     array32->set(index++, m_matrix.m34());
307     array32->set(index++, m_matrix.m41());
308     array32->set(index++, m_matrix.m42());
309     array32->set(index++, m_matrix.m43());
310     array32->set(index, m_matrix.m44());
311     return array32.releaseNonNull();
312 }
313
314 ExceptionOr<Ref<Float64Array>> DOMMatrixReadOnly::toFloat64Array() const
315 {
316     auto array64 = Float64Array::createUninitialized(16);
317     if (!array64)
318         return Exception { UnknownError, ASCIILiteral("Out of memory") };
319
320     unsigned index = 0;
321     array64->set(index++, m_matrix.m11());
322     array64->set(index++, m_matrix.m12());
323     array64->set(index++, m_matrix.m13());
324     array64->set(index++, m_matrix.m14());
325     array64->set(index++, m_matrix.m21());
326     array64->set(index++, m_matrix.m22());
327     array64->set(index++, m_matrix.m23());
328     array64->set(index++, m_matrix.m24());
329     array64->set(index++, m_matrix.m31());
330     array64->set(index++, m_matrix.m32());
331     array64->set(index++, m_matrix.m33());
332     array64->set(index++, m_matrix.m34());
333     array64->set(index++, m_matrix.m41());
334     array64->set(index++, m_matrix.m42());
335     array64->set(index++, m_matrix.m43());
336     array64->set(index, m_matrix.m44());
337     return array64.releaseNonNull();
338 }
339
340 // https://drafts.fxtf.org/geometry/#dom-dommatrixreadonly-stringifier
341 ExceptionOr<String> DOMMatrixReadOnly::toString() const
342 {
343     if (!m_matrix.containsOnlyFiniteValues())
344         return Exception { INVALID_STATE_ERR, ASCIILiteral("Matrix contains non-finite values") };
345
346     StringBuilder builder;
347     if (is2D()) {
348         builder.appendLiteral("matrix(");
349         builder.append(String::numberToStringECMAScript(m_matrix.a()));
350         builder.appendLiteral(", ");
351         builder.append(String::numberToStringECMAScript(m_matrix.b()));
352         builder.appendLiteral(", ");
353         builder.append(String::numberToStringECMAScript(m_matrix.c()));
354         builder.appendLiteral(", ");
355         builder.append(String::numberToStringECMAScript(m_matrix.d()));
356         builder.appendLiteral(", ");
357         builder.append(String::numberToStringECMAScript(m_matrix.e()));
358         builder.appendLiteral(", ");
359         builder.append(String::numberToStringECMAScript(m_matrix.f()));
360     } else {
361         builder.appendLiteral("matrix3d(");
362         builder.append(String::numberToStringECMAScript(m_matrix.m11()));
363         builder.appendLiteral(", ");
364         builder.append(String::numberToStringECMAScript(m_matrix.m12()));
365         builder.appendLiteral(", ");
366         builder.append(String::numberToStringECMAScript(m_matrix.m13()));
367         builder.appendLiteral(", ");
368         builder.append(String::numberToStringECMAScript(m_matrix.m14()));
369         builder.appendLiteral(", ");
370         builder.append(String::numberToStringECMAScript(m_matrix.m21()));
371         builder.appendLiteral(", ");
372         builder.append(String::numberToStringECMAScript(m_matrix.m22()));
373         builder.appendLiteral(", ");
374         builder.append(String::numberToStringECMAScript(m_matrix.m23()));
375         builder.appendLiteral(", ");
376         builder.append(String::numberToStringECMAScript(m_matrix.m24()));
377         builder.appendLiteral(", ");
378         builder.append(String::numberToStringECMAScript(m_matrix.m31()));
379         builder.appendLiteral(", ");
380         builder.append(String::numberToStringECMAScript(m_matrix.m32()));
381         builder.appendLiteral(", ");
382         builder.append(String::numberToStringECMAScript(m_matrix.m33()));
383         builder.appendLiteral(", ");
384         builder.append(String::numberToStringECMAScript(m_matrix.m34()));
385         builder.appendLiteral(", ");
386         builder.append(String::numberToStringECMAScript(m_matrix.m41()));
387         builder.appendLiteral(", ");
388         builder.append(String::numberToStringECMAScript(m_matrix.m42()));
389         builder.appendLiteral(", ");
390         builder.append(String::numberToStringECMAScript(m_matrix.m43()));
391         builder.appendLiteral(", ");
392         builder.append(String::numberToStringECMAScript(m_matrix.m44()));
393     }
394     builder.append(')');
395     return builder.toString();
396 }
397
398 } // namespace WebCore