css_ast/rules/
keyframes.rs

1use super::prelude::*;
2use crate::Percentage;
3#[cfg(feature = "visitable")]
4use crate::visit::{NodeId, QueryableNode};
5use css_parse::NoBlockAllowed;
6
7// https://drafts.csswg.org/css-animations/#at-ruledef-keyframes
8#[derive(Peek, Parse, ToSpan, ToCursors, SemanticEq, Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
9#[cfg_attr(feature = "serde", derive(serde::Serialize), serde())]
10#[cfg_attr(feature = "visitable", derive(csskit_derives::Visitable), visit, queryable(skip))]
11#[cfg_attr(feature = "css_feature_data", derive(::csskit_derives::ToCSSFeature), css_feature("css.at-rules.keyframes"))]
12#[derive(csskit_derives::NodeWithMetadata)]
13#[metadata(node_kinds = AtRule, used_at_rules = Keyframes, property_kinds = Name)]
14pub struct KeyframesRule<'a> {
15	#[cfg_attr(feature = "visitable", visit(skip))]
16	#[atom(CssAtomSet::Keyframes)]
17	pub name: T![AtKeyword],
18	pub prelude: KeyframesName,
19	#[metadata(delegate)]
20	pub block: KeyframesRuleBlock<'a>,
21}
22
23#[cfg(feature = "visitable")]
24impl<'a> QueryableNode for KeyframesRule<'a> {
25	const NODE_ID: NodeId = NodeId::KeyframesRule;
26
27	fn get_property(&self, kind: PropertyKind) -> Option<Cursor> {
28		match kind {
29			PropertyKind::Name => Some(self.prelude.into()),
30			_ => None,
31		}
32	}
33}
34
35#[derive(Peek, ToCursors, IntoCursor, Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
36#[cfg_attr(feature = "serde", derive(serde::Serialize), serde())]
37#[cfg_attr(feature = "visitable", derive(csskit_derives::Visitable), visit(self))]
38#[derive(csskit_derives::NodeWithMetadata)]
39pub enum KeyframesName {
40	Ident(T![Ident]),
41	String(T![String]),
42}
43
44impl KeyframesName {
45	fn invalid_ident(atom: CssAtomSet) -> bool {
46		matches!(atom, CssAtomSet::Default | CssAtomSet::Initial | CssAtomSet::Unset | CssAtomSet::None)
47	}
48}
49
50// Must use Parse rather than Build so ReservedKeyframeName errors can be emitted
51impl<'a> Parse<'a> for KeyframesName {
52	fn parse<I>(p: &mut Parser<'a, I>) -> ParserResult<Self>
53	where
54		I: Iterator<Item = Cursor> + Clone,
55	{
56		if p.peek::<T![String]>() {
57			return Ok(Self::String(p.parse::<T![String]>()?));
58		}
59		let ident = p.parse::<T![Ident]>()?;
60		if KeyframesName::invalid_ident(p.to_atom::<CssAtomSet>(ident.into())) {
61			Err(Diagnostic::new(ident.into(), Diagnostic::reserved_keyframe_name))?
62		}
63		Ok(Self::Ident(ident))
64	}
65}
66
67#[derive(Parse, Peek, ToSpan, ToCursors, SemanticEq, Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
68#[cfg_attr(feature = "serde", derive(serde::Serialize), serde())]
69#[cfg_attr(feature = "visitable", derive(csskit_derives::Visitable), visit)]
70#[derive(csskit_derives::NodeWithMetadata)]
71pub struct KeyframesRuleBlock<'a>(#[metadata(delegate)] pub RuleList<'a, Keyframe<'a>, CssMetadata>);
72
73#[derive(Parse, Peek, ToSpan, ToCursors, SemanticEq, Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
74#[cfg_attr(feature = "serde", derive(serde::Serialize), serde())]
75#[cfg_attr(feature = "visitable", derive(csskit_derives::Visitable), visit)]
76#[derive(csskit_derives::NodeWithMetadata)]
77pub struct Keyframe<'a>(
78	#[metadata(delegate)]
79	QualifiedRule<'a, KeyframeSelectors<'a>, StyleValue<'a>, NoBlockAllowed<StyleValue<'a>, CssMetadata>, CssMetadata>,
80);
81
82#[derive(Peek, Parse, ToCursors, ToSpan, SemanticEq, Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
83#[cfg_attr(feature = "serde", derive(serde::Serialize), serde())]
84#[cfg_attr(feature = "visitable", derive(csskit_derives::Visitable), visit(children))]
85pub struct KeyframeSelectors<'a>(pub CommaSeparated<'a, KeyframeSelector>);
86
87#[derive(Peek, Parse, ToCursors, IntoCursor, Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
88#[cfg_attr(feature = "serde", derive(serde::Serialize), serde())]
89#[cfg_attr(feature = "visitable", derive(csskit_derives::Visitable), visit(self))]
90#[derive(csskit_derives::NodeWithMetadata)]
91pub enum KeyframeSelector {
92	#[atom(CssAtomSet::From)]
93	From(T![Ident]),
94	#[atom(CssAtomSet::To)]
95	To(T![Ident]),
96	Percent(Percentage),
97}
98
99#[cfg(test)]
100mod tests {
101	use super::*;
102	use crate::CssAtomSet;
103	use css_parse::assert_parse;
104
105	#[test]
106	fn size_test() {
107		assert_eq!(std::mem::size_of::<KeyframesRule>(), 128);
108		assert_eq!(std::mem::size_of::<KeyframeSelector>(), 16);
109		assert_eq!(std::mem::size_of::<KeyframesName>(), 16);
110		assert_eq!(std::mem::size_of::<KeyframesRuleBlock>(), 96);
111	}
112
113	#[test]
114	fn test_writes() {
115		assert_parse!(CssAtomSet::ATOMS, KeyframesRule, "@keyframes foo{}");
116		assert_parse!(CssAtomSet::ATOMS, KeyframesRule, "@keyframes\"include\"{}");
117		assert_parse!(CssAtomSet::ATOMS, KeyframesRule, "@keyframes spin{0%{rotate:0deg}100%{rotate:360deg}}");
118		assert_parse!(CssAtomSet::ATOMS, KeyframesRule, "@keyframes spin{from,0%{rotate:0deg}to,100%{rotate:360deg}}");
119		assert_parse!(CssAtomSet::ATOMS, KeyframesRule, "@keyframes spin{to{rotate:360deg}}");
120		assert_parse!(
121			CssAtomSet::ATOMS,
122			KeyframesRule,
123			"@keyframes x{to{animation-timing-function:cubic-bezier(0,0,0.2,1)}}"
124		);
125	}
126}
css_ast/rules/keyframes.rs

css_ast/rules/
keyframes.rs
