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 servo_arc::Arc;
11use style::shared_lock::{Locked, SharedRwLockReadGuard, ToCssWithGuard};
12use style::stylesheets::keyframes_rule::{Keyframe, KeyframeSelector, KeyframesRule};
13use style::stylesheets::{CssRuleType, StylesheetInDocument};
14use style::values::KeyframesName;
15
16use super::csskeyframerule::CSSKeyframeRule;
17use super::cssrule::{CSSRule, SpecificCSSRule};
18use super::cssrulelist::{CSSRuleList, RulesSource};
19use super::cssstylesheet::CSSStyleSheet;
20use crate::dom::bindings::codegen::Bindings::CSSKeyframesRuleBinding::CSSKeyframesRuleMethods;
21use crate::dom::bindings::error::ErrorResult;
22use crate::dom::bindings::inheritance::Castable;
23use crate::dom::bindings::reflector::{DomGlobal, reflect_dom_object};
24use crate::dom::bindings::root::{DomRoot, MutNullableDom};
25use crate::dom::bindings::str::DOMString;
26use crate::dom::window::Window;
27use crate::script_runtime::CanGc;
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        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, cx: &mut JSContext) -> DomRoot<CSSRuleList> {
67        self.rule_list.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.keyframes_rule.borrow().clone()),
73                CanGc::from_cx(cx),
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.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, cx: &mut JSContext, 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            let mut guard = self.css_rule.shared_lock().write();
133            self.keyframes_rule
134                .borrow()
135                .write_with(&mut guard)
136                .keyframes
137                .push(rule);
138            self.rulelist(cx).append_lazy_dom_rule();
139            self.css_rule.parent_stylesheet().notify_invalidations();
140        }
141    }
142
143    /// <https://drafts.csswg.org/css-animations/#dom-csskeyframesrule-deleterule>
144    fn DeleteRule(&self, cx: &mut JSContext, selector: DOMString) {
145        if let Some(idx) = self.find_rule(&selector) {
146            let _ = self.rulelist(cx).remove_rule(idx as u32);
147        }
148    }
149
150    /// <https://drafts.csswg.org/css-animations/#dom-csskeyframesrule-findrule>
151    fn FindRule(
152        &self,
153        cx: &mut JSContext,
154        selector: DOMString,
155    ) -> Option<DomRoot<CSSKeyframeRule>> {
156        self.find_rule(&selector)
157            .and_then(|idx| self.rulelist(cx).item(idx as u32, CanGc::from_cx(cx)))
158            .and_then(DomRoot::downcast)
159    }
160
161    /// <https://drafts.csswg.org/css-animations/#dom-csskeyframesrule-name>
162    fn Name(&self) -> DOMString {
163        let guard = self.css_rule.shared_lock().read();
164        DOMString::from(
165            &**self
166                .keyframes_rule
167                .borrow()
168                .read_with(&guard)
169                .name
170                .as_atom(),
171        )
172    }
173
174    /// <https://drafts.csswg.org/css-animations/#dom-csskeyframesrule-name>
175    fn SetName(&self, value: DOMString) -> ErrorResult {
176        // Spec deviation: https://github.com/w3c/csswg-drafts/issues/801
177        // Setting this property to a CSS-wide keyword or `none` does not throw,
178        // it stores a value that serializes as a quoted string.
179        self.css_rule.parent_stylesheet().will_modify();
180        let name = KeyframesName::from_ident(&value.str());
181        let mut guard = self.css_rule.shared_lock().write();
182        self.keyframes_rule.borrow().write_with(&mut guard).name = name;
183        self.css_rule.parent_stylesheet().notify_invalidations();
184        Ok(())
185    }
186}
187
188impl SpecificCSSRule for CSSKeyframesRule {
189    fn ty(&self) -> CssRuleType {
190        CssRuleType::Keyframes
191    }
192
193    fn get_css(&self) -> DOMString {
194        let guard = self.css_rule.shared_lock().read();
195        self.keyframes_rule
196            .borrow()
197            .read_with(&guard)
198            .to_css_string(&guard)
199            .into()
200    }
201
202    fn deparent_children(&self) {
203        if let Some(list) = self.rule_list.get() {
204            list.deparent_all()
205        }
206    }
207}
script/dom/css/csskeyframesrule.rs

script/dom/css/
csskeyframesrule.rs
