script/dom/css/
csskeyframesrule.rs

1/* This Source Code Form is subject to the terms of the Mozilla Public
2 * License, v. 2.0. If a copy of the MPL was not distributed with this
3 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
4
5use std::cell::RefCell;
6
7use cssparser::{Parser, ParserInput};
8use dom_struct::dom_struct;
9use servo_arc::Arc;
10use style::shared_lock::{Locked, SharedRwLockReadGuard, ToCssWithGuard};
11use style::stylesheets::keyframes_rule::{Keyframe, KeyframeSelector, KeyframesRule};
12use style::stylesheets::{CssRuleType, StylesheetInDocument};
13use style::values::KeyframesName;
14
15use super::csskeyframerule::CSSKeyframeRule;
16use super::cssrule::{CSSRule, SpecificCSSRule};
17use super::cssrulelist::{CSSRuleList, RulesSource};
18use super::cssstylesheet::CSSStyleSheet;
19use crate::dom::bindings::codegen::Bindings::CSSKeyframesRuleBinding::CSSKeyframesRuleMethods;
20use crate::dom::bindings::error::ErrorResult;
21use crate::dom::bindings::inheritance::Castable;
22use crate::dom::bindings::reflector::{DomGlobal, reflect_dom_object};
23use crate::dom::bindings::root::{DomRoot, MutNullableDom};
24use crate::dom::bindings::str::DOMString;
25use crate::dom::window::Window;
26use crate::script_runtime::CanGc;
27
28#[dom_struct]
29pub(crate) struct CSSKeyframesRule {
30    cssrule: CSSRule,
31    #[ignore_malloc_size_of = "Stylo"]
32    #[no_trace]
33    keyframesrule: RefCell<Arc<Locked<KeyframesRule>>>,
34    rulelist: MutNullableDom<CSSRuleList>,
35}
36
37impl CSSKeyframesRule {
38    fn new_inherited(
39        parent_stylesheet: &CSSStyleSheet,
40        keyframesrule: Arc<Locked<KeyframesRule>>,
41    ) -> CSSKeyframesRule {
42        CSSKeyframesRule {
43            cssrule: CSSRule::new_inherited(parent_stylesheet),
44            keyframesrule: RefCell::new(keyframesrule),
45            rulelist: MutNullableDom::new(None),
46        }
47    }
48
49    #[cfg_attr(crown, allow(crown::unrooted_must_root))]
50    pub(crate) fn new(
51        window: &Window,
52        parent_stylesheet: &CSSStyleSheet,
53        keyframesrule: Arc<Locked<KeyframesRule>>,
54        can_gc: CanGc,
55    ) -> DomRoot<CSSKeyframesRule> {
56        reflect_dom_object(
57            Box::new(CSSKeyframesRule::new_inherited(
58                parent_stylesheet,
59                keyframesrule,
60            )),
61            window,
62            can_gc,
63        )
64    }
65
66    fn rulelist(&self, can_gc: CanGc) -> DomRoot<CSSRuleList> {
67        self.rulelist.or_init(|| {
68            let parent_stylesheet = &self.upcast::<CSSRule>().parent_stylesheet();
69            CSSRuleList::new(
70                self.global().as_window(),
71                parent_stylesheet,
72                RulesSource::Keyframes(self.keyframesrule.borrow().clone()),
73                can_gc,
74            )
75        })
76    }
77
78    /// Given a keyframe selector, finds the index of the first corresponding rule if any
79    fn find_rule(&self, selector: &DOMString) -> Option<usize> {
80        let selector = selector.str();
81        let mut input = ParserInput::new(&selector);
82        let mut input = Parser::new(&mut input);
83        if let Ok(sel) = KeyframeSelector::parse(&mut input) {
84            let guard = self.cssrule.shared_lock().read();
85            // This finds the *last* element matching a selector
86            // because that's the rule that applies. Thus, rposition
87            self.keyframesrule
88                .borrow()
89                .read_with(&guard)
90                .keyframes
91                .iter()
92                .rposition(|frame| frame.read_with(&guard).selector == sel)
93        } else {
94            None
95        }
96    }
97
98    pub(crate) fn update_rule(
99        &self,
100        keyframesrule: Arc<Locked<KeyframesRule>>,
101        guard: &SharedRwLockReadGuard,
102    ) {
103        if let Some(rulelist) = self.rulelist.get() {
104            rulelist.update_rules(RulesSource::Keyframes(keyframesrule.clone()), guard);
105        }
106
107        *self.keyframesrule.borrow_mut() = keyframesrule;
108    }
109}
110
111impl CSSKeyframesRuleMethods<crate::DomTypeHolder> for CSSKeyframesRule {
112    /// <https://drafts.csswg.org/css-animations/#dom-csskeyframesrule-cssrules>
113    fn CssRules(&self, can_gc: CanGc) -> DomRoot<CSSRuleList> {
114        self.rulelist(can_gc)
115    }
116
117    /// <https://drafts.csswg.org/css-animations/#dom-csskeyframesrule-appendrule>
118    fn AppendRule(&self, rule: DOMString, can_gc: CanGc) {
119        let style_stylesheet = self.cssrule.parent_stylesheet().style_stylesheet();
120        let rule = rule.str();
121        let rule = {
122            let guard = style_stylesheet.shared_lock.read();
123            Keyframe::parse(
124                &rule,
125                style_stylesheet.contents(&guard),
126                &style_stylesheet.shared_lock,
127            )
128        };
129
130        if let Ok(rule) = rule {
131            self.cssrule.parent_stylesheet().will_modify();
132            let mut guard = self.cssrule.shared_lock().write();
133            self.keyframesrule
134                .borrow()
135                .write_with(&mut guard)
136                .keyframes
137                .push(rule);
138            self.rulelist(can_gc).append_lazy_dom_rule();
139            self.cssrule.parent_stylesheet().notify_invalidations();
140        }
141    }
142
143    /// <https://drafts.csswg.org/css-animations/#dom-csskeyframesrule-deleterule>
144    fn DeleteRule(&self, selector: DOMString, can_gc: CanGc) {
145        if let Some(idx) = self.find_rule(&selector) {
146            let _ = self.rulelist(can_gc).remove_rule(idx as u32);
147        }
148    }
149
150    /// <https://drafts.csswg.org/css-animations/#dom-csskeyframesrule-findrule>
151    fn FindRule(&self, selector: DOMString, can_gc: CanGc) -> Option<DomRoot<CSSKeyframeRule>> {
152        self.find_rule(&selector)
153            .and_then(|idx| self.rulelist(can_gc).item(idx as u32, can_gc))
154            .and_then(DomRoot::downcast)
155    }
156
157    /// <https://drafts.csswg.org/css-animations/#dom-csskeyframesrule-name>
158    fn Name(&self) -> DOMString {
159        let guard = self.cssrule.shared_lock().read();
160        DOMString::from(&**self.keyframesrule.borrow().read_with(&guard).name.as_atom())
161    }
162
163    /// <https://drafts.csswg.org/css-animations/#dom-csskeyframesrule-name>
164    fn SetName(&self, value: DOMString) -> ErrorResult {
165        // Spec deviation: https://github.com/w3c/csswg-drafts/issues/801
166        // Setting this property to a CSS-wide keyword or `none` does not throw,
167        // it stores a value that serializes as a quoted string.
168        self.cssrule.parent_stylesheet().will_modify();
169        let name = KeyframesName::from_ident(&value.str());
170        let mut guard = self.cssrule.shared_lock().write();
171        self.keyframesrule.borrow().write_with(&mut guard).name = name;
172        self.cssrule.parent_stylesheet().notify_invalidations();
173        Ok(())
174    }
175}
176
177impl SpecificCSSRule for CSSKeyframesRule {
178    fn ty(&self) -> CssRuleType {
179        CssRuleType::Keyframes
180    }
181
182    fn get_css(&self) -> DOMString {
183        let guard = self.cssrule.shared_lock().read();
184        self.keyframesrule
185            .borrow()
186            .read_with(&guard)
187            .to_css_string(&guard)
188            .into()
189    }
190
191    fn deparent_children(&self) {
192        if let Some(list) = self.rulelist.get() {
193            list.deparent_all()
194        }
195    }
196}
script/dom/css/csskeyframesrule.rs

script/dom/css/
csskeyframesrule.rs
