mirror of
https://github.com/servo/servo
synced 2026-04-26 01:25:32 +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>
171 lines
6.0 KiB
Rust
171 lines
6.0 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::RefCell;
|
|
use std::mem;
|
|
|
|
use cssparser::{Parser as CssParser, ParserInput as CssParserInput, ToCss};
|
|
use dom_struct::dom_struct;
|
|
use selectors::parser::{ParseRelative, SelectorList};
|
|
use servo_arc::Arc;
|
|
use style::selector_parser::SelectorParser;
|
|
use style::shared_lock::{Locked, SharedRwLockReadGuard, ToCssWithGuard};
|
|
use style::stylesheets::{CssRuleType, CssRules, Origin, StyleRule, StylesheetInDocument};
|
|
|
|
use super::cssgroupingrule::CSSGroupingRule;
|
|
use super::cssrule::SpecificCSSRule;
|
|
use super::cssstyledeclaration::{CSSModificationAccess, CSSStyleDeclaration, CSSStyleOwner};
|
|
use super::cssstylesheet::CSSStyleSheet;
|
|
use crate::dom::bindings::codegen::Bindings::CSSStyleRuleBinding::CSSStyleRuleMethods;
|
|
use crate::dom::bindings::inheritance::Castable;
|
|
use crate::dom::bindings::reflector::{DomGlobal, reflect_dom_object};
|
|
use crate::dom::bindings::root::{Dom, DomRoot, MutNullableDom};
|
|
use crate::dom::bindings::str::DOMString;
|
|
use crate::dom::window::Window;
|
|
use crate::script_runtime::CanGc;
|
|
|
|
#[dom_struct]
|
|
pub(crate) struct CSSStyleRule {
|
|
cssgroupingrule: CSSGroupingRule,
|
|
#[ignore_malloc_size_of = "Stylo"]
|
|
#[no_trace]
|
|
stylerule: RefCell<Arc<Locked<StyleRule>>>,
|
|
style_decl: MutNullableDom<CSSStyleDeclaration>,
|
|
}
|
|
|
|
impl CSSStyleRule {
|
|
fn new_inherited(
|
|
parent_stylesheet: &CSSStyleSheet,
|
|
stylerule: Arc<Locked<StyleRule>>,
|
|
) -> CSSStyleRule {
|
|
CSSStyleRule {
|
|
cssgroupingrule: CSSGroupingRule::new_inherited(parent_stylesheet),
|
|
stylerule: RefCell::new(stylerule),
|
|
style_decl: Default::default(),
|
|
}
|
|
}
|
|
|
|
#[cfg_attr(crown, allow(crown::unrooted_must_root))]
|
|
pub(crate) fn new(
|
|
window: &Window,
|
|
parent_stylesheet: &CSSStyleSheet,
|
|
stylerule: Arc<Locked<StyleRule>>,
|
|
can_gc: CanGc,
|
|
) -> DomRoot<CSSStyleRule> {
|
|
reflect_dom_object(
|
|
Box::new(CSSStyleRule::new_inherited(parent_stylesheet, stylerule)),
|
|
window,
|
|
can_gc,
|
|
)
|
|
}
|
|
|
|
pub(crate) fn ensure_rules(&self) -> Arc<Locked<CssRules>> {
|
|
let lock = self.cssgroupingrule.shared_lock();
|
|
let mut guard = lock.write();
|
|
self.stylerule
|
|
.borrow()
|
|
.write_with(&mut guard)
|
|
.rules
|
|
.get_or_insert_with(|| CssRules::new(vec![], lock))
|
|
.clone()
|
|
}
|
|
|
|
pub(crate) fn update_rule(
|
|
&self,
|
|
stylerule: Arc<Locked<StyleRule>>,
|
|
guard: &SharedRwLockReadGuard,
|
|
) {
|
|
if let Some(ref rules) = stylerule.read_with(guard).rules {
|
|
self.cssgroupingrule.update_rules(rules, guard);
|
|
}
|
|
|
|
if let Some(ref style_decl) = self.style_decl.get() {
|
|
style_decl.update_property_declaration_block(&stylerule.read_with(guard).block);
|
|
}
|
|
|
|
*self.stylerule.borrow_mut() = stylerule;
|
|
}
|
|
}
|
|
|
|
impl SpecificCSSRule for CSSStyleRule {
|
|
fn ty(&self) -> CssRuleType {
|
|
CssRuleType::Style
|
|
}
|
|
|
|
fn get_css(&self) -> DOMString {
|
|
let guard = self.cssgroupingrule.shared_lock().read();
|
|
self.stylerule
|
|
.borrow()
|
|
.read_with(&guard)
|
|
.to_css_string(&guard)
|
|
.into()
|
|
}
|
|
}
|
|
|
|
impl CSSStyleRuleMethods<crate::DomTypeHolder> for CSSStyleRule {
|
|
/// <https://drafts.csswg.org/cssom/#dom-cssstylerule-style>
|
|
fn Style(&self, can_gc: CanGc) -> DomRoot<CSSStyleDeclaration> {
|
|
self.style_decl.or_init(|| {
|
|
let guard = self.cssgroupingrule.shared_lock().read();
|
|
CSSStyleDeclaration::new(
|
|
self.global().as_window(),
|
|
CSSStyleOwner::CSSRule(
|
|
Dom::from_ref(self.upcast()),
|
|
RefCell::new(self.stylerule.borrow().read_with(&guard).block.clone()),
|
|
),
|
|
None,
|
|
CSSModificationAccess::ReadWrite,
|
|
can_gc,
|
|
)
|
|
})
|
|
}
|
|
|
|
/// <https://drafts.csswg.org/cssom/#dom-cssstylerule-selectortext>
|
|
fn SelectorText(&self) -> DOMString {
|
|
let guard = self.cssgroupingrule.shared_lock().read();
|
|
DOMString::from_string(
|
|
self.stylerule
|
|
.borrow()
|
|
.read_with(&guard)
|
|
.selectors
|
|
.to_css_string(),
|
|
)
|
|
}
|
|
|
|
/// <https://drafts.csswg.org/cssom/#dom-cssstylerule-selectortext>
|
|
fn SetSelectorText(&self, value: DOMString) {
|
|
let value = value.str();
|
|
let Ok(mut selector) = ({
|
|
let guard = self.cssgroupingrule.shared_lock().read();
|
|
let sheet = self.cssgroupingrule.parent_stylesheet().style_stylesheet();
|
|
let contents = sheet.contents(&guard);
|
|
// It's not clear from the spec if we should use the stylesheet's namespaces.
|
|
// https://github.com/w3c/csswg-drafts/issues/1511
|
|
let parser = SelectorParser {
|
|
stylesheet_origin: Origin::Author,
|
|
namespaces: &contents.namespaces,
|
|
url_data: &contents.url_data,
|
|
for_supports_rule: false,
|
|
};
|
|
let mut css_parser = CssParserInput::new(&value);
|
|
let mut css_parser = CssParser::new(&mut css_parser);
|
|
// TODO: Maybe allow setting relative selectors from the OM, if we're in a nested style
|
|
// rule?
|
|
SelectorList::parse(&parser, &mut css_parser, ParseRelative::No)
|
|
}) else {
|
|
return;
|
|
};
|
|
self.cssgroupingrule.parent_stylesheet().will_modify();
|
|
// This mirrors what we do in CSSStyleOwner::mutate_associated_block.
|
|
let mut guard = self.cssgroupingrule.shared_lock().write();
|
|
mem::swap(
|
|
&mut self.stylerule.borrow().write_with(&mut guard).selectors,
|
|
&mut selector,
|
|
);
|
|
self.cssgroupingrule
|
|
.parent_stylesheet()
|
|
.notify_invalidations();
|
|
}
|
|
}
|