Files
servo/components/script/dom/dompoint.rs
Simon Wülker c4ae451612 Turn all commented links before functions into doccomments (#40331)
Servo has a lot of comments like this:
```rust
// https://example-spec.com/#do-the-thing
fn do_the_thing() {}
```
and I keep turning these into doc comments whenever I'm working close to
one of them. Doing so allows me to hover over a function call in an IDE
and open its specification without having to jump to the function
definition first. This change fixes all of these comments at once.

This was done using `find components -name '*.rs' -exec perl -i -0777
-pe 's|^([ \t]*)// (https?://.*)\n\1(fn )|\1/// <$2>\n\1$3|mg' {} +`.

Note that these comments should be doc comments even within trait `impl`
blocks, because rustdoc will use them as fallback documentation when the
method definition on the trait does not have documentation.

Testing: Comments only, no testing required
Preparation for https://github.com/servo/servo/pull/39552

---------

Signed-off-by: Simon Wülker <simon.wuelker@arcor.de>
2025-11-01 05:32:45 +00:00

174 lines
4.8 KiB
Rust

/* 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 base::id::{DomPointId, DomPointIndex};
use constellation_traits::DomPoint;
use dom_struct::dom_struct;
use js::rust::HandleObject;
use rustc_hash::FxHashMap;
use crate::dom::bindings::codegen::Bindings::DOMPointBinding::{DOMPointInit, DOMPointMethods};
use crate::dom::bindings::codegen::Bindings::DOMPointReadOnlyBinding::DOMPointReadOnlyMethods;
use crate::dom::bindings::error::Fallible;
use crate::dom::bindings::reflector::reflect_dom_object_with_proto;
use crate::dom::bindings::root::DomRoot;
use crate::dom::bindings::serializable::Serializable;
use crate::dom::bindings::structuredclone::StructuredData;
use crate::dom::dompointreadonly::{DOMPointReadOnly, DOMPointWriteMethods};
use crate::dom::globalscope::GlobalScope;
use crate::script_runtime::CanGc;
// http://dev.w3.org/fxtf/geometry/Overview.html#dompoint
#[dom_struct]
pub(crate) struct DOMPoint {
point: DOMPointReadOnly,
}
#[allow(non_snake_case)]
impl DOMPoint {
fn new_inherited(x: f64, y: f64, z: f64, w: f64) -> DOMPoint {
DOMPoint {
point: DOMPointReadOnly::new_inherited(x, y, z, w),
}
}
pub(crate) fn new(
global: &GlobalScope,
x: f64,
y: f64,
z: f64,
w: f64,
can_gc: CanGc,
) -> DomRoot<DOMPoint> {
Self::new_with_proto(global, None, x, y, z, w, can_gc)
}
fn new_with_proto(
global: &GlobalScope,
proto: Option<HandleObject>,
x: f64,
y: f64,
z: f64,
w: f64,
can_gc: CanGc,
) -> DomRoot<DOMPoint> {
reflect_dom_object_with_proto(
Box::new(DOMPoint::new_inherited(x, y, z, w)),
global,
proto,
can_gc,
)
}
pub(crate) fn new_from_init(
global: &GlobalScope,
p: &DOMPointInit,
can_gc: CanGc,
) -> DomRoot<DOMPoint> {
DOMPoint::new(global, p.x, p.y, p.z, p.w, can_gc)
}
}
impl DOMPointMethods<crate::DomTypeHolder> for DOMPoint {
/// <https://drafts.fxtf.org/geometry/#dom-dompointreadonly-dompointreadonly>
fn Constructor(
global: &GlobalScope,
proto: Option<HandleObject>,
can_gc: CanGc,
x: f64,
y: f64,
z: f64,
w: f64,
) -> Fallible<DomRoot<DOMPoint>> {
Ok(DOMPoint::new_with_proto(global, proto, x, y, z, w, can_gc))
}
/// <https://drafts.fxtf.org/geometry/#dom-dompoint-frompoint>
fn FromPoint(global: &GlobalScope, init: &DOMPointInit, can_gc: CanGc) -> DomRoot<Self> {
Self::new_from_init(global, init, can_gc)
}
/// <https://dev.w3.org/fxtf/geometry/Overview.html#dom-dompointreadonly-x>
fn X(&self) -> f64 {
self.point.X()
}
/// <https://dev.w3.org/fxtf/geometry/Overview.html#dom-dompointreadonly-x>
fn SetX(&self, value: f64) {
self.point.SetX(value);
}
/// <https://dev.w3.org/fxtf/geometry/Overview.html#dom-dompointreadonly-y>
fn Y(&self) -> f64 {
self.point.Y()
}
/// <https://dev.w3.org/fxtf/geometry/Overview.html#dom-dompointreadonly-y>
fn SetY(&self, value: f64) {
self.point.SetY(value);
}
/// <https://dev.w3.org/fxtf/geometry/Overview.html#dom-dompointreadonly-z>
fn Z(&self) -> f64 {
self.point.Z()
}
/// <https://dev.w3.org/fxtf/geometry/Overview.html#dom-dompointreadonly-z>
fn SetZ(&self, value: f64) {
self.point.SetZ(value);
}
/// <https://dev.w3.org/fxtf/geometry/Overview.html#dom-dompointreadonly-w>
fn W(&self) -> f64 {
self.point.W()
}
/// <https://dev.w3.org/fxtf/geometry/Overview.html#dom-dompointreadonly-w>
fn SetW(&self, value: f64) {
self.point.SetW(value);
}
}
impl Serializable for DOMPoint {
type Index = DomPointIndex;
type Data = DomPoint;
fn serialize(&self) -> Result<(DomPointId, Self::Data), ()> {
let serialized = DomPoint {
x: self.X(),
y: self.Y(),
z: self.Z(),
w: self.W(),
};
Ok((DomPointId::new(), serialized))
}
fn deserialize(
owner: &GlobalScope,
serialized: Self::Data,
can_gc: CanGc,
) -> Result<DomRoot<Self>, ()>
where
Self: Sized,
{
Ok(Self::new(
owner,
serialized.x,
serialized.y,
serialized.z,
serialized.w,
can_gc,
))
}
fn serialized_storage<'a>(
data: StructuredData<'a, '_>,
) -> &'a mut Option<FxHashMap<DomPointId, Self::Data>> {
match data {
StructuredData::Reader(reader) => &mut reader.points,
StructuredData::Writer(writer) => &mut writer.points,
}
}
}