/* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at https://mozilla.org/MPL/2.0/. */ use canvas_traits::canvas::{Canvas2dMsg, CanvasId, CanvasMsg}; use dom_struct::dom_struct; use euclid::default::{Point2D, Rect, Size2D}; use ipc_channel::ipc::IpcSender; use servo_url::ServoUrl; use crate::canvas_state::CanvasState; use crate::dom::bindings::codegen::Bindings::CanvasRenderingContext2DBinding::{ CanvasDirection, CanvasFillRule, CanvasImageSource, CanvasLineCap, CanvasLineJoin, CanvasRenderingContext2DMethods, CanvasTextAlign, CanvasTextBaseline, }; use crate::dom::bindings::codegen::UnionTypes::StringOrCanvasGradientOrCanvasPattern; use crate::dom::bindings::error::{ErrorResult, Fallible}; use crate::dom::bindings::num::Finite; use crate::dom::bindings::reflector::{reflect_dom_object, DomObject, Reflector}; use crate::dom::bindings::root::{Dom, DomRoot, LayoutDom}; use crate::dom::bindings::str::DOMString; use crate::dom::canvasgradient::CanvasGradient; use crate::dom::canvaspattern::CanvasPattern; use crate::dom::dommatrix::DOMMatrix; use crate::dom::globalscope::GlobalScope; use crate::dom::htmlcanvaselement::HTMLCanvasElement; use crate::dom::imagedata::ImageData; use crate::dom::textmetrics::TextMetrics; // https://html.spec.whatwg.org/multipage/#canvasrenderingcontext2d #[dom_struct] pub struct CanvasRenderingContext2D { reflector_: Reflector, /// For rendering contexts created by an HTML canvas element, this is Some, /// for ones created by a paint worklet, this is None. canvas: Option>, canvas_state: CanvasState, } impl CanvasRenderingContext2D { pub fn new_inherited( global: &GlobalScope, canvas: Option<&HTMLCanvasElement>, size: Size2D, ) -> CanvasRenderingContext2D { CanvasRenderingContext2D { reflector_: Reflector::new(), canvas: canvas.map(Dom::from_ref), canvas_state: CanvasState::new( global, Size2D::new(size.width as u64, size.height as u64), ), } } pub fn new( global: &GlobalScope, canvas: &HTMLCanvasElement, size: Size2D, ) -> DomRoot { let boxed = Box::new(CanvasRenderingContext2D::new_inherited( global, Some(canvas), size, )); reflect_dom_object(boxed, global) } // https://html.spec.whatwg.org/multipage/#concept-canvas-set-bitmap-dimensions pub fn set_bitmap_dimensions(&self, size: Size2D) { self.reset_to_initial_state(); self.canvas_state .get_ipc_renderer() .send(CanvasMsg::Recreate( Some(size.to_u64()), self.canvas_state.get_canvas_id(), )) .unwrap(); } // https://html.spec.whatwg.org/multipage/#reset-the-rendering-context-to-its-default-state fn reset_to_initial_state(&self) { self.canvas_state.reset_to_initial_state(); } pub fn set_canvas_bitmap_dimensions(&self, size: Size2D) { self.canvas_state.set_bitmap_dimensions(size); } pub fn mark_as_dirty(&self) { self.canvas_state.mark_as_dirty(self.canvas.as_deref()) } pub fn take_missing_image_urls(&self) -> Vec { std::mem::take(&mut self.canvas_state.get_missing_image_urls().borrow_mut()) } pub fn get_canvas_id(&self) -> CanvasId { self.canvas_state.get_canvas_id() } pub fn send_canvas_2d_msg(&self, msg: Canvas2dMsg) { self.canvas_state.send_canvas_2d_msg(msg) } // TODO: Remove this pub fn get_ipc_renderer(&self) -> IpcSender { self.canvas_state.get_ipc_renderer().clone() } pub fn origin_is_clean(&self) -> bool { self.canvas_state.origin_is_clean() } pub fn get_rect(&self, rect: Rect) -> Vec { let rect = Rect::new( Point2D::new(rect.origin.x as u64, rect.origin.y as u64), Size2D::new(rect.size.width as u64, rect.size.height as u64), ); self.canvas_state.get_rect( self.canvas .as_ref() .map_or(Size2D::zero(), |c| c.get_size().to_u64()), rect, ) } } pub trait LayoutCanvasRenderingContext2DHelpers { fn get_ipc_renderer(self) -> IpcSender; fn get_canvas_id(self) -> CanvasId; } impl LayoutCanvasRenderingContext2DHelpers for LayoutDom<'_, CanvasRenderingContext2D> { fn get_ipc_renderer(self) -> IpcSender { (self.unsafe_get()).canvas_state.get_ipc_renderer().clone() } fn get_canvas_id(self) -> CanvasId { // FIXME(nox): This relies on the fact that CanvasState::get_canvas_id // does nothing fancy but it would be easier to trust a // LayoutDom<_>-like type that would wrap the &CanvasState. self.unsafe_get().canvas_state.get_canvas_id() } } // We add a guard to each of methods by the spec: // http://www.w3.org/html/wg/drafts/2dcontext/html5_canvas_CR/ // // > Except where otherwise specified, for the 2D context interface, // > any method call with a numeric argument whose value is infinite or a NaN value must be ignored. // // Restricted values are guarded in glue code. Therefore we need not add a guard. // // FIXME: this behavior should might be generated by some annotattions to idl. impl CanvasRenderingContext2DMethods for CanvasRenderingContext2D { // https://html.spec.whatwg.org/multipage/#dom-context-2d-canvas fn Canvas(&self) -> DomRoot { // This method is not called from a paint worklet rendering context, // so it's OK to panic if self.canvas is None. DomRoot::from_ref(self.canvas.as_ref().expect("No canvas.")) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-save fn Save(&self) { self.canvas_state.save() } #[allow(crown::unrooted_must_root)] // https://html.spec.whatwg.org/multipage/#dom-context-2d-restore fn Restore(&self) { self.canvas_state.restore() } /// fn Reset(&self) { self.canvas_state.reset() } // https://html.spec.whatwg.org/multipage/#dom-context-2d-scale fn Scale(&self, x: f64, y: f64) { self.canvas_state.scale(x, y) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-rotate fn Rotate(&self, angle: f64) { self.canvas_state.rotate(angle) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-translate fn Translate(&self, x: f64, y: f64) { self.canvas_state.translate(x, y) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-transform fn Transform(&self, a: f64, b: f64, c: f64, d: f64, e: f64, f: f64) { self.canvas_state.transform(a, b, c, d, e, f) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-gettransform fn GetTransform(&self) -> DomRoot { self.canvas_state.get_transform(&self.global()) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-settransform fn SetTransform(&self, a: f64, b: f64, c: f64, d: f64, e: f64, f: f64) { self.canvas_state.set_transform(a, b, c, d, e, f) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-resettransform fn ResetTransform(&self) { self.canvas_state.reset_transform() } // https://html.spec.whatwg.org/multipage/#dom-context-2d-globalalpha fn GlobalAlpha(&self) -> f64 { self.canvas_state.global_alpha() } // https://html.spec.whatwg.org/multipage/#dom-context-2d-globalalpha fn SetGlobalAlpha(&self, alpha: f64) { self.canvas_state.set_global_alpha(alpha) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-globalcompositeoperation fn GlobalCompositeOperation(&self) -> DOMString { self.canvas_state.global_composite_operation() } // https://html.spec.whatwg.org/multipage/#dom-context-2d-globalcompositeoperation fn SetGlobalCompositeOperation(&self, op_str: DOMString) { self.canvas_state.set_global_composite_operation(op_str) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-fillrect fn FillRect(&self, x: f64, y: f64, width: f64, height: f64) { self.canvas_state.fill_rect(x, y, width, height); self.mark_as_dirty(); } // https://html.spec.whatwg.org/multipage/#dom-context-2d-clearrect fn ClearRect(&self, x: f64, y: f64, width: f64, height: f64) { self.canvas_state.clear_rect(x, y, width, height); self.mark_as_dirty(); } // https://html.spec.whatwg.org/multipage/#dom-context-2d-strokerect fn StrokeRect(&self, x: f64, y: f64, width: f64, height: f64) { self.canvas_state.stroke_rect(x, y, width, height); self.mark_as_dirty(); } // https://html.spec.whatwg.org/multipage/#dom-context-2d-beginpath fn BeginPath(&self) { self.canvas_state.begin_path() } // https://html.spec.whatwg.org/multipage/#dom-context-2d-closepath fn ClosePath(&self) { self.canvas_state.close_path() } // https://html.spec.whatwg.org/multipage/#dom-context-2d-fill fn Fill(&self, fill_rule: CanvasFillRule) { self.canvas_state.fill(fill_rule); self.mark_as_dirty(); } // https://html.spec.whatwg.org/multipage/#dom-context-2d-stroke fn Stroke(&self) { self.canvas_state.stroke(); self.mark_as_dirty(); } // https://html.spec.whatwg.org/multipage/#dom-context-2d-clip fn Clip(&self, fill_rule: CanvasFillRule) { self.canvas_state.clip(fill_rule) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-ispointinpath fn IsPointInPath(&self, x: f64, y: f64, fill_rule: CanvasFillRule) -> bool { self.canvas_state .is_point_in_path(&self.global(), x, y, fill_rule) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-filltext fn FillText(&self, text: DOMString, x: f64, y: f64, max_width: Option) { self.canvas_state .fill_text(self.canvas.as_deref(), text, x, y, max_width); self.mark_as_dirty(); } // https://html.spec.whatwg.org/multipage/#textmetrics fn MeasureText(&self, text: DOMString) -> DomRoot { self.canvas_state.measure_text(&self.global(), text) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-font fn Font(&self) -> DOMString { self.canvas_state.font() } // https://html.spec.whatwg.org/multipage/#dom-context-2d-font fn SetFont(&self, value: DOMString) { self.canvas_state.set_font(self.canvas.as_deref(), value) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-textalign fn TextAlign(&self) -> CanvasTextAlign { self.canvas_state.text_align() } // https://html.spec.whatwg.org/multipage/#dom-context-2d-textalign fn SetTextAlign(&self, value: CanvasTextAlign) { self.canvas_state.set_text_align(value) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-textbaseline fn TextBaseline(&self) -> CanvasTextBaseline { self.canvas_state.text_baseline() } // https://html.spec.whatwg.org/multipage/#dom-context-2d-textbaseline fn SetTextBaseline(&self, value: CanvasTextBaseline) { self.canvas_state.set_text_baseline(value) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-direction fn Direction(&self) -> CanvasDirection { self.canvas_state.direction() } // https://html.spec.whatwg.org/multipage/#dom-context-2d-direction fn SetDirection(&self, value: CanvasDirection) { self.canvas_state.set_direction(value) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-drawimage fn DrawImage(&self, image: CanvasImageSource, dx: f64, dy: f64) -> ErrorResult { self.canvas_state .draw_image(self.canvas.as_deref(), image, dx, dy) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-drawimage fn DrawImage_( &self, image: CanvasImageSource, dx: f64, dy: f64, dw: f64, dh: f64, ) -> ErrorResult { self.canvas_state .draw_image_(self.canvas.as_deref(), image, dx, dy, dw, dh) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-drawimage fn DrawImage__( &self, image: CanvasImageSource, sx: f64, sy: f64, sw: f64, sh: f64, dx: f64, dy: f64, dw: f64, dh: f64, ) -> ErrorResult { self.canvas_state.draw_image__( self.canvas.as_deref(), image, sx, sy, sw, sh, dx, dy, dw, dh, ) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-moveto fn MoveTo(&self, x: f64, y: f64) { self.canvas_state.move_to(x, y) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-lineto fn LineTo(&self, x: f64, y: f64) { self.canvas_state.line_to(x, y) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-rect fn Rect(&self, x: f64, y: f64, width: f64, height: f64) { self.canvas_state.rect(x, y, width, height) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-quadraticcurveto fn QuadraticCurveTo(&self, cpx: f64, cpy: f64, x: f64, y: f64) { self.canvas_state.quadratic_curve_to(cpx, cpy, x, y) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-beziercurveto fn BezierCurveTo(&self, cp1x: f64, cp1y: f64, cp2x: f64, cp2y: f64, x: f64, y: f64) { self.canvas_state .bezier_curve_to(cp1x, cp1y, cp2x, cp2y, x, y) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-arc fn Arc(&self, x: f64, y: f64, r: f64, start: f64, end: f64, ccw: bool) -> ErrorResult { self.canvas_state.arc(x, y, r, start, end, ccw) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-arcto fn ArcTo(&self, cp1x: f64, cp1y: f64, cp2x: f64, cp2y: f64, r: f64) -> ErrorResult { self.canvas_state.arc_to(cp1x, cp1y, cp2x, cp2y, r) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-ellipse fn Ellipse( &self, x: f64, y: f64, rx: f64, ry: f64, rotation: f64, start: f64, end: f64, ccw: bool, ) -> ErrorResult { self.canvas_state .ellipse(x, y, rx, ry, rotation, start, end, ccw) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-imagesmoothingenabled fn ImageSmoothingEnabled(&self) -> bool { self.canvas_state.image_smoothing_enabled() } // https://html.spec.whatwg.org/multipage/#dom-context-2d-imagesmoothingenabled fn SetImageSmoothingEnabled(&self, value: bool) { self.canvas_state.set_image_smoothing_enabled(value) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-strokestyle fn StrokeStyle(&self) -> StringOrCanvasGradientOrCanvasPattern { self.canvas_state.stroke_style() } // https://html.spec.whatwg.org/multipage/#dom-context-2d-strokestyle fn SetStrokeStyle(&self, value: StringOrCanvasGradientOrCanvasPattern) { self.canvas_state .set_stroke_style(self.canvas.as_deref(), value) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-strokestyle fn FillStyle(&self) -> StringOrCanvasGradientOrCanvasPattern { self.canvas_state.fill_style() } // https://html.spec.whatwg.org/multipage/#dom-context-2d-strokestyle fn SetFillStyle(&self, value: StringOrCanvasGradientOrCanvasPattern) { self.canvas_state .set_fill_style(self.canvas.as_deref(), value) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-createimagedata fn CreateImageData(&self, sw: i32, sh: i32) -> Fallible> { self.canvas_state.create_image_data(&self.global(), sw, sh) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-createimagedata fn CreateImageData_(&self, imagedata: &ImageData) -> Fallible> { self.canvas_state .create_image_data_(&self.global(), imagedata) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-getimagedata fn GetImageData(&self, sx: i32, sy: i32, sw: i32, sh: i32) -> Fallible> { self.canvas_state.get_image_data( self.canvas .as_ref() .map_or(Size2D::zero(), |c| c.get_size().to_u64()), &self.global(), sx, sy, sw, sh, ) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-putimagedata fn PutImageData(&self, imagedata: &ImageData, dx: i32, dy: i32) { self.canvas_state.put_image_data( self.canvas .as_ref() .map_or(Size2D::zero(), |c| c.get_size().to_u64()), imagedata, dx, dy, ) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-putimagedata #[allow(unsafe_code)] fn PutImageData_( &self, imagedata: &ImageData, dx: i32, dy: i32, dirty_x: i32, dirty_y: i32, dirty_width: i32, dirty_height: i32, ) { self.canvas_state.put_image_data_( self.canvas .as_ref() .map_or(Size2D::zero(), |c| c.get_size().to_u64()), imagedata, dx, dy, dirty_x, dirty_y, dirty_width, dirty_height, ); self.mark_as_dirty(); } // https://html.spec.whatwg.org/multipage/#dom-context-2d-createlineargradient fn CreateLinearGradient( &self, x0: Finite, y0: Finite, x1: Finite, y1: Finite, ) -> DomRoot { self.canvas_state .create_linear_gradient(&self.global(), x0, y0, x1, y1) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-createradialgradient fn CreateRadialGradient( &self, x0: Finite, y0: Finite, r0: Finite, x1: Finite, y1: Finite, r1: Finite, ) -> Fallible> { self.canvas_state .create_radial_gradient(&self.global(), x0, y0, r0, x1, y1, r1) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-createpattern fn CreatePattern( &self, image: CanvasImageSource, repetition: DOMString, ) -> Fallible>> { self.canvas_state .create_pattern(&self.global(), image, repetition) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-linewidth fn LineWidth(&self) -> f64 { self.canvas_state.line_width() } // https://html.spec.whatwg.org/multipage/#dom-context-2d-linewidth fn SetLineWidth(&self, width: f64) { self.canvas_state.set_line_width(width) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-linecap fn LineCap(&self) -> CanvasLineCap { self.canvas_state.line_cap() } // https://html.spec.whatwg.org/multipage/#dom-context-2d-linecap fn SetLineCap(&self, cap: CanvasLineCap) { self.canvas_state.set_line_cap(cap) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-linejoin fn LineJoin(&self) -> CanvasLineJoin { self.canvas_state.line_join() } // https://html.spec.whatwg.org/multipage/#dom-context-2d-linejoin fn SetLineJoin(&self, join: CanvasLineJoin) { self.canvas_state.set_line_join(join) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-miterlimit fn MiterLimit(&self) -> f64 { self.canvas_state.miter_limit() } // https://html.spec.whatwg.org/multipage/#dom-context-2d-miterlimit fn SetMiterLimit(&self, limit: f64) { self.canvas_state.set_miter_limit(limit) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-shadowoffsetx fn ShadowOffsetX(&self) -> f64 { self.canvas_state.shadow_offset_x() } // https://html.spec.whatwg.org/multipage/#dom-context-2d-shadowoffsetx fn SetShadowOffsetX(&self, value: f64) { self.canvas_state.set_shadow_offset_x(value) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-shadowoffsety fn ShadowOffsetY(&self) -> f64 { self.canvas_state.shadow_offset_y() } // https://html.spec.whatwg.org/multipage/#dom-context-2d-shadowoffsety fn SetShadowOffsetY(&self, value: f64) { self.canvas_state.set_shadow_offset_y(value) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-shadowblur fn ShadowBlur(&self) -> f64 { self.canvas_state.shadow_blur() } // https://html.spec.whatwg.org/multipage/#dom-context-2d-shadowblur fn SetShadowBlur(&self, value: f64) { self.canvas_state.set_shadow_blur(value) } // https://html.spec.whatwg.org/multipage/#dom-context-2d-shadowcolor fn ShadowColor(&self) -> DOMString { self.canvas_state.shadow_color() } // https://html.spec.whatwg.org/multipage/#dom-context-2d-shadowcolor fn SetShadowColor(&self, value: DOMString) { self.canvas_state .set_shadow_color(self.canvas.as_deref(), value) } } impl Drop for CanvasRenderingContext2D { fn drop(&mut self) { if let Err(err) = self .canvas_state .get_ipc_renderer() .send(CanvasMsg::Close(self.canvas_state.get_canvas_id())) { warn!("Could not close canvas: {}", err) } } }