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

script/dom/css/
csskeyframesrule.rs
