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, NoGC};
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::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_with_cx(
60            Box::new(CSSKeyframesRule::new_inherited(
61                parent_rule,
62                parent_stylesheet,
63                keyframesrule,
64            )),
65            window,
66            cx,
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 = ParserInput::new(&selector);
87        let mut input = Parser::new(&mut input);
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();
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        DOMString::from(
178            &**self
179                .keyframes_rule
180                .borrow()
181                .read_with(&guard)
182                .name
183                .as_atom(),
184        )
185    }
186
187    /// <https://drafts.csswg.org/css-animations/#dom-csskeyframesrule-name>
188    fn SetName(&self, no_gc: &NoGC, value: DOMString) -> ErrorResult {
189        // Spec deviation: https://github.com/w3c/csswg-drafts/issues/801
190        // Setting this property to a CSS-wide keyword or `none` does not throw,
191        // it stores a value that serializes as a quoted string.
192        self.css_rule.parent_stylesheet().will_modify();
193        let name = KeyframesName::from_ident(&value.str());
194        let mut guard = self.css_rule.shared_lock().write();
195        self.keyframes_rule.borrow().write_with(&mut guard).name = name;
196        self.css_rule
197            .parent_stylesheet()
198            .notify_invalidations(no_gc);
199        Ok(())
200    }
201}
202
203impl SpecificCSSRule for CSSKeyframesRule {
204    fn ty(&self) -> CssRuleType {
205        CssRuleType::Keyframes
206    }
207
208    fn get_css(&self) -> DOMString {
209        let guard = self.css_rule.shared_lock().read();
210        self.keyframes_rule
211            .borrow()
212            .read_with(&guard)
213            .to_css_string(&guard)
214            .into()
215    }
216
217    fn deparent_children(&self) {
218        if let Some(list) = self.rule_list.get() {
219            list.deparent_all()
220        }
221    }
222}
script/dom/css/csskeyframesrule.rs

script/dom/css/
csskeyframesrule.rs
