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    pub(crate) fn new(
50        window: &Window,
51        parent_stylesheet: &CSSStyleSheet,
52        keyframesrule: Arc<Locked<KeyframesRule>>,
53        can_gc: CanGc,
54    ) -> DomRoot<CSSKeyframesRule> {
55        reflect_dom_object(
56            Box::new(CSSKeyframesRule::new_inherited(
57                parent_stylesheet,
58                keyframesrule,
59            )),
60            window,
61            can_gc,
62        )
63    }
64
65    fn rulelist(&self, can_gc: CanGc) -> DomRoot<CSSRuleList> {
66        self.rulelist.or_init(|| {
67            let parent_stylesheet = &self.upcast::<CSSRule>().parent_stylesheet();
68            CSSRuleList::new(
69                self.global().as_window(),
70                parent_stylesheet,
71                RulesSource::Keyframes(self.keyframesrule.borrow().clone()),
72                can_gc,
73            )
74        })
75    }
76
77    /// Given a keyframe selector, finds the index of the first corresponding rule if any
78    fn find_rule(&self, selector: &DOMString) -> Option<usize> {
79        let selector = selector.str();
80        let mut input = ParserInput::new(&selector);
81        let mut input = Parser::new(&mut input);
82        if let Ok(sel) = KeyframeSelector::parse(&mut input) {
83            let guard = self.cssrule.shared_lock().read();
84            // This finds the *last* element matching a selector
85            // because that's the rule that applies. Thus, rposition
86            self.keyframesrule
87                .borrow()
88                .read_with(&guard)
89                .keyframes
90                .iter()
91                .rposition(|frame| frame.read_with(&guard).selector == sel)
92        } else {
93            None
94        }
95    }
96
97    pub(crate) fn update_rule(
98        &self,
99        keyframesrule: Arc<Locked<KeyframesRule>>,
100        guard: &SharedRwLockReadGuard,
101    ) {
102        if let Some(rulelist) = self.rulelist.get() {
103            rulelist.update_rules(RulesSource::Keyframes(keyframesrule.clone()), guard);
104        }
105
106        *self.keyframesrule.borrow_mut() = keyframesrule;
107    }
108}
109
110impl CSSKeyframesRuleMethods<crate::DomTypeHolder> for CSSKeyframesRule {
111    /// <https://drafts.csswg.org/css-animations/#dom-csskeyframesrule-cssrules>
112    fn CssRules(&self, can_gc: CanGc) -> DomRoot<CSSRuleList> {
113        self.rulelist(can_gc)
114    }
115
116    /// <https://drafts.csswg.org/css-animations/#dom-csskeyframesrule-appendrule>
117    fn AppendRule(&self, rule: DOMString, can_gc: CanGc) {
118        let style_stylesheet = self.cssrule.parent_stylesheet().style_stylesheet();
119        let rule = rule.str();
120        let rule = {
121            let guard = style_stylesheet.shared_lock.read();
122            Keyframe::parse(
123                &rule,
124                style_stylesheet.contents(&guard),
125                &style_stylesheet.shared_lock,
126            )
127        };
128
129        if let Ok(rule) = rule {
130            self.cssrule.parent_stylesheet().will_modify();
131            let mut guard = self.cssrule.shared_lock().write();
132            self.keyframesrule
133                .borrow()
134                .write_with(&mut guard)
135                .keyframes
136                .push(rule);
137            self.rulelist(can_gc).append_lazy_dom_rule();
138            self.cssrule.parent_stylesheet().notify_invalidations();
139        }
140    }
141
142    /// <https://drafts.csswg.org/css-animations/#dom-csskeyframesrule-deleterule>
143    fn DeleteRule(&self, selector: DOMString, can_gc: CanGc) {
144        if let Some(idx) = self.find_rule(&selector) {
145            let _ = self.rulelist(can_gc).remove_rule(idx as u32);
146        }
147    }
148
149    /// <https://drafts.csswg.org/css-animations/#dom-csskeyframesrule-findrule>
150    fn FindRule(&self, selector: DOMString, can_gc: CanGc) -> Option<DomRoot<CSSKeyframeRule>> {
151        self.find_rule(&selector)
152            .and_then(|idx| self.rulelist(can_gc).item(idx as u32, can_gc))
153            .and_then(DomRoot::downcast)
154    }
155
156    /// <https://drafts.csswg.org/css-animations/#dom-csskeyframesrule-name>
157    fn Name(&self) -> DOMString {
158        let guard = self.cssrule.shared_lock().read();
159        DOMString::from(&**self.keyframesrule.borrow().read_with(&guard).name.as_atom())
160    }
161
162    /// <https://drafts.csswg.org/css-animations/#dom-csskeyframesrule-name>
163    fn SetName(&self, value: DOMString) -> ErrorResult {
164        // Spec deviation: https://github.com/w3c/csswg-drafts/issues/801
165        // Setting this property to a CSS-wide keyword or `none` does not throw,
166        // it stores a value that serializes as a quoted string.
167        self.cssrule.parent_stylesheet().will_modify();
168        let name = KeyframesName::from_ident(&value.str());
169        let mut guard = self.cssrule.shared_lock().write();
170        self.keyframesrule.borrow().write_with(&mut guard).name = name;
171        self.cssrule.parent_stylesheet().notify_invalidations();
172        Ok(())
173    }
174}
175
176impl SpecificCSSRule for CSSKeyframesRule {
177    fn ty(&self) -> CssRuleType {
178        CssRuleType::Keyframes
179    }
180
181    fn get_css(&self) -> DOMString {
182        let guard = self.cssrule.shared_lock().read();
183        self.keyframesrule
184            .borrow()
185            .read_with(&guard)
186            .to_css_string(&guard)
187            .into()
188    }
189
190    fn deparent_children(&self) {
191        if let Some(list) = self.rulelist.get() {
192            list.deparent_all()
193        }
194    }
195}
script/dom/css/csskeyframesrule.rs

script/dom/css/
csskeyframesrule.rs
