mirror of
https://github.com/servo/servo
synced 2026-05-14 10:56:44 +02:00
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>
179 lines
5.4 KiB
Rust
179 lines
5.4 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 std::cell::Cell;
|
|
|
|
use dom_struct::dom_struct;
|
|
use js::jsapi::Heap;
|
|
use js::jsval::JSVal;
|
|
use js::rust::{HandleObject, HandleValue, MutableHandleValue};
|
|
use stylo_atoms::Atom;
|
|
|
|
use crate::dom::bindings::cell::DomRefCell;
|
|
use crate::dom::bindings::codegen::Bindings::ErrorEventBinding;
|
|
use crate::dom::bindings::codegen::Bindings::ErrorEventBinding::ErrorEventMethods;
|
|
use crate::dom::bindings::codegen::Bindings::EventBinding::EventMethods;
|
|
use crate::dom::bindings::error::Fallible;
|
|
use crate::dom::bindings::inheritance::Castable;
|
|
use crate::dom::bindings::reflector::reflect_dom_object_with_proto;
|
|
use crate::dom::bindings::root::DomRoot;
|
|
use crate::dom::bindings::str::DOMString;
|
|
use crate::dom::bindings::trace::RootedTraceableBox;
|
|
use crate::dom::event::{Event, EventBubbles, EventCancelable};
|
|
use crate::dom::globalscope::GlobalScope;
|
|
use crate::script_runtime::{CanGc, JSContext};
|
|
|
|
#[dom_struct]
|
|
pub(crate) struct ErrorEvent {
|
|
event: Event,
|
|
message: DomRefCell<DOMString>,
|
|
filename: DomRefCell<DOMString>,
|
|
lineno: Cell<u32>,
|
|
colno: Cell<u32>,
|
|
#[ignore_malloc_size_of = "Defined in rust-mozjs"]
|
|
error: Heap<JSVal>,
|
|
}
|
|
|
|
impl ErrorEvent {
|
|
fn new_inherited() -> ErrorEvent {
|
|
ErrorEvent {
|
|
event: Event::new_inherited(),
|
|
message: DomRefCell::new(DOMString::new()),
|
|
filename: DomRefCell::new(DOMString::new()),
|
|
lineno: Cell::new(0),
|
|
colno: Cell::new(0),
|
|
error: Heap::default(),
|
|
}
|
|
}
|
|
|
|
fn new_uninitialized(
|
|
global: &GlobalScope,
|
|
proto: Option<HandleObject>,
|
|
can_gc: CanGc,
|
|
) -> DomRoot<ErrorEvent> {
|
|
reflect_dom_object_with_proto(Box::new(ErrorEvent::new_inherited()), global, proto, can_gc)
|
|
}
|
|
|
|
#[allow(clippy::too_many_arguments)]
|
|
pub(crate) fn new(
|
|
global: &GlobalScope,
|
|
type_: Atom,
|
|
bubbles: EventBubbles,
|
|
cancelable: EventCancelable,
|
|
message: DOMString,
|
|
filename: DOMString,
|
|
lineno: u32,
|
|
colno: u32,
|
|
error: HandleValue,
|
|
can_gc: CanGc,
|
|
) -> DomRoot<ErrorEvent> {
|
|
Self::new_with_proto(
|
|
global, None, type_, bubbles, cancelable, message, filename, lineno, colno, error,
|
|
can_gc,
|
|
)
|
|
}
|
|
|
|
#[allow(clippy::too_many_arguments)]
|
|
fn new_with_proto(
|
|
global: &GlobalScope,
|
|
proto: Option<HandleObject>,
|
|
type_: Atom,
|
|
bubbles: EventBubbles,
|
|
cancelable: EventCancelable,
|
|
message: DOMString,
|
|
filename: DOMString,
|
|
lineno: u32,
|
|
colno: u32,
|
|
error: HandleValue,
|
|
can_gc: CanGc,
|
|
) -> DomRoot<ErrorEvent> {
|
|
let ev = ErrorEvent::new_uninitialized(global, proto, can_gc);
|
|
{
|
|
let event = ev.upcast::<Event>();
|
|
event.init_event(type_, bool::from(bubbles), bool::from(cancelable));
|
|
*ev.message.borrow_mut() = message;
|
|
*ev.filename.borrow_mut() = filename;
|
|
ev.lineno.set(lineno);
|
|
ev.colno.set(colno);
|
|
}
|
|
ev.error.set(error.get());
|
|
ev
|
|
}
|
|
}
|
|
|
|
impl ErrorEventMethods<crate::DomTypeHolder> for ErrorEvent {
|
|
/// <https://html.spec.whatwg.org/multipage/#errorevent>
|
|
fn Constructor(
|
|
global: &GlobalScope,
|
|
proto: Option<HandleObject>,
|
|
can_gc: CanGc,
|
|
type_: DOMString,
|
|
init: RootedTraceableBox<ErrorEventBinding::ErrorEventInit>,
|
|
) -> Fallible<DomRoot<ErrorEvent>> {
|
|
let msg = match init.message.as_ref() {
|
|
Some(message) => message.clone(),
|
|
None => DOMString::new(),
|
|
};
|
|
|
|
let file_name = match init.filename.as_ref() {
|
|
Some(filename) => filename.clone(),
|
|
None => DOMString::new(),
|
|
};
|
|
|
|
let line_num = init.lineno.unwrap_or(0);
|
|
|
|
let col_num = init.colno.unwrap_or(0);
|
|
|
|
let bubbles = EventBubbles::from(init.parent.bubbles);
|
|
|
|
let cancelable = EventCancelable::from(init.parent.cancelable);
|
|
|
|
let event = ErrorEvent::new_with_proto(
|
|
global,
|
|
proto,
|
|
Atom::from(type_),
|
|
bubbles,
|
|
cancelable,
|
|
msg,
|
|
file_name,
|
|
line_num,
|
|
col_num,
|
|
init.error.handle(),
|
|
can_gc,
|
|
);
|
|
event.upcast::<Event>().set_composed(init.parent.composed);
|
|
Ok(event)
|
|
}
|
|
|
|
/// <https://html.spec.whatwg.org/multipage/#dom-errorevent-lineno>
|
|
fn Lineno(&self) -> u32 {
|
|
self.lineno.get()
|
|
}
|
|
|
|
/// <https://html.spec.whatwg.org/multipage/#dom-errorevent-colno>
|
|
fn Colno(&self) -> u32 {
|
|
self.colno.get()
|
|
}
|
|
|
|
/// <https://html.spec.whatwg.org/multipage/#dom-errorevent-message>
|
|
fn Message(&self) -> DOMString {
|
|
self.message.borrow().clone()
|
|
}
|
|
|
|
/// <https://html.spec.whatwg.org/multipage/#dom-errorevent-filename>
|
|
fn Filename(&self) -> DOMString {
|
|
self.filename.borrow().clone()
|
|
}
|
|
|
|
/// <https://html.spec.whatwg.org/multipage/#dom-errorevent-error>
|
|
fn Error(&self, _cx: JSContext, mut retval: MutableHandleValue) {
|
|
retval.set(self.error.get());
|
|
}
|
|
|
|
/// <https://dom.spec.whatwg.org/#dom-event-istrusted>
|
|
fn IsTrusted(&self) -> bool {
|
|
self.event.IsTrusted()
|
|
}
|
|
}
|