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 js::context::JSContext;
10use script_bindings::reflector::reflect_dom_object_with_cx;
11use servo_arc::Arc;
12use style::shared_lock::{Locked, SharedRwLockReadGuard, ToCssWithGuard};
13use style::stylesheets::keyframes_rule::{Keyframe, KeyframeSelectors, KeyframesRule};
14use style::stylesheets::{CssRuleType, StylesheetInDocument};
15use style::values::KeyframesName;
16
17use super::csskeyframerule::CSSKeyframeRule;
18use super::cssrule::{CSSRule, SpecificCSSRule};
19use super::cssrulelist::{CSSRuleList, RulesSource};
20use super::cssstylesheet::CSSStyleSheet;
21use crate::dom::bindings::codegen::Bindings::CSSKeyframesRuleBinding::CSSKeyframesRuleMethods;
22use crate::dom::bindings::error::ErrorResult;
23use crate::dom::bindings::inheritance::Castable;
24use crate::dom::bindings::reflector::DomGlobal;
25use crate::dom::bindings::root::{DomRoot, MutNullableDom};
26use crate::dom::bindings::str::DOMString;
27use crate::dom::window::Window;
28
29#[dom_struct]
30pub(crate) struct CSSKeyframesRule {
31    css_rule: CSSRule,
32    #[ignore_malloc_size_of = "Stylo"]
33    #[no_trace]
34    keyframes_rule: RefCell<Arc<Locked<KeyframesRule>>>,
35    rule_list: MutNullableDom<CSSRuleList>,
36}
37
38impl CSSKeyframesRule {
39    fn new_inherited(
40        parent_stylesheet: &CSSStyleSheet,
41        keyframesrule: Arc<Locked<KeyframesRule>>,
42    ) -> CSSKeyframesRule {
43        CSSKeyframesRule {
44            css_rule: CSSRule::new_inherited(parent_stylesheet),
45            keyframes_rule: RefCell::new(keyframesrule),
46            rule_list: MutNullableDom::new(None),
47        }
48    }
49
50    pub(crate) fn new(
51        cx: &mut JSContext,
52        window: &Window,
53        parent_stylesheet: &CSSStyleSheet,
54        keyframesrule: Arc<Locked<KeyframesRule>>,
55    ) -> DomRoot<CSSKeyframesRule> {
56        reflect_dom_object_with_cx(
57            Box::new(CSSKeyframesRule::new_inherited(
58                parent_stylesheet,
59                keyframesrule,
60            )),
61            window,
62            cx,
63        )
64    }
65
66    fn rulelist(&self, cx: &mut JSContext) -> DomRoot<CSSRuleList> {
67        self.rule_list.or_init(|| {
68            let parent_stylesheet = &self.upcast::<CSSRule>().parent_stylesheet();
69            CSSRuleList::new(
70                cx,
71                self.global().as_window(),
72                parent_stylesheet,
73                RulesSource::Keyframes(self.keyframes_rule.borrow().clone()),
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) = KeyframeSelectors::parse(&mut input) {
84            let guard = self.css_rule.shared_lock().read();
85            // This finds the *last* element matching a selector
86            // because that's the rule that applies. Thus, rposition
87            self.keyframes_rule
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.rule_list.get() {
104            rulelist.update_rules(RulesSource::Keyframes(keyframesrule.clone()), guard);
105        }
106
107        *self.keyframes_rule.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, cx: &mut JSContext) -> DomRoot<CSSRuleList> {
114        self.rulelist(cx)
115    }
116
117    /// <https://drafts.csswg.org/css-animations/#dom-csskeyframesrule-appendrule>
118    fn AppendRule(&self, rule: DOMString) {
119        let style_stylesheet = self.css_rule.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.css_rule.parent_stylesheet().will_modify();
132            {
133                let mut guard = self.css_rule.shared_lock().write();
134                self.keyframes_rule
135                    .borrow()
136                    .write_with(&mut guard)
137                    .keyframes
138                    .push(rule);
139            }
140
141            if let Some(rulelist) = self.rule_list.get() {
142                rulelist.append_lazy_dom_rule();
143            }
144
145            self.css_rule.parent_stylesheet().notify_invalidations();
146        }
147    }
148
149    /// <https://drafts.csswg.org/css-animations/#dom-csskeyframesrule-deleterule>
150    fn DeleteRule(&self, cx: &mut JSContext, selector: DOMString) {
151        if let Some(idx) = self.find_rule(&selector) {
152            let _ = self.rulelist(cx).remove_rule(cx, idx as u32);
153        }
154    }
155
156    /// <https://drafts.csswg.org/css-animations/#dom-csskeyframesrule-findrule>
157    fn FindRule(
158        &self,
159        cx: &mut JSContext,
160        selector: DOMString,
161    ) -> Option<DomRoot<CSSKeyframeRule>> {
162        self.find_rule(&selector)
163            .and_then(|idx| self.rulelist(cx).item(cx, idx as u32))
164            .and_then(DomRoot::downcast)
165    }
166
167    /// <https://drafts.csswg.org/css-animations/#dom-csskeyframesrule-name>
168    fn Name(&self) -> DOMString {
169        let guard = self.css_rule.shared_lock().read();
170        DOMString::from(
171            &**self
172                .keyframes_rule
173                .borrow()
174                .read_with(&guard)
175                .name
176                .as_atom(),
177        )
178    }
179
180    /// <https://drafts.csswg.org/css-animations/#dom-csskeyframesrule-name>
181    fn SetName(&self, value: DOMString) -> ErrorResult {
182        // Spec deviation: https://github.com/w3c/csswg-drafts/issues/801
183        // Setting this property to a CSS-wide keyword or `none` does not throw,
184        // it stores a value that serializes as a quoted string.
185        self.css_rule.parent_stylesheet().will_modify();
186        let name = KeyframesName::from_ident(&value.str());
187        let mut guard = self.css_rule.shared_lock().write();
188        self.keyframes_rule.borrow().write_with(&mut guard).name = name;
189        self.css_rule.parent_stylesheet().notify_invalidations();
190        Ok(())
191    }
192}
193
194impl SpecificCSSRule for CSSKeyframesRule {
195    fn ty(&self) -> CssRuleType {
196        CssRuleType::Keyframes
197    }
198
199    fn get_css(&self) -> DOMString {
200        let guard = self.css_rule.shared_lock().read();
201        self.keyframes_rule
202            .borrow()
203            .read_with(&guard)
204            .to_css_string(&guard)
205            .into()
206    }
207
208    fn deparent_children(&self) {
209        if let Some(list) = self.rule_list.get() {
210            list.deparent_all()
211        }
212    }
213}
script/dom/css/csskeyframesrule.rs

script/dom/css/
csskeyframesrule.rs
