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

script/dom/css/
csskeyframesrule.rs
