css_ast/rules/container/
mod.rs

1#[cfg(feature = "visitable")]
2use crate::visit::{NodeId, QueryableNode};
3
4use super::prelude::*;
5
6mod features;
7pub use features::*;
8
9// https://drafts.csswg.org/css-contain-3/#container-rule
10#[derive(Parse, Peek, ToCursors, ToSpan, SemanticEq, Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
11#[cfg_attr(feature = "serde", derive(serde::Serialize), serde())]
12#[cfg_attr(feature = "visitable", derive(csskit_derives::Visitable), visit, queryable(skip))]
13#[cfg_attr(feature = "css_feature_data", derive(::csskit_derives::ToCSSFeature), css_feature("css.at-rules.container"))]
14#[derive(csskit_derives::NodeWithMetadata)]
15#[metadata(node_kinds = AtRule, used_at_rules = Container)]
16pub struct ContainerRule<'a> {
17	#[cfg_attr(feature = "visitable", visit(skip))]
18	#[atom(CssAtomSet::Container)]
19	pub name: T![AtKeyword],
20	pub prelude: ContainerConditionList<'a>,
21	#[metadata(delegate)]
22	pub block: ContainerRulesBlock<'a>,
23}
24
25#[cfg(feature = "visitable")]
26impl<'a> QueryableNode for ContainerRule<'a> {
27	const NODE_ID: NodeId = NodeId::ContainerRule;
28}
29
30#[derive(Parse, ToSpan, ToCursors, SemanticEq, Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
31#[cfg_attr(feature = "serde", derive(serde::Serialize), serde())]
32#[cfg_attr(feature = "visitable", derive(csskit_derives::Visitable))]
33#[derive(csskit_derives::NodeWithMetadata)]
34pub struct ContainerRulesBlock<'a>(#[metadata(delegate)] pub RuleList<'a, Rule<'a>, CssMetadata>);
35
36#[derive(Peek, Parse, ToCursors, ToSpan, SemanticEq, Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
37#[cfg_attr(feature = "serde", derive(serde::Serialize), serde())]
38#[cfg_attr(feature = "visitable", derive(csskit_derives::Visitable))]
39pub struct ContainerConditionList<'a>(pub CommaSeparated<'a, ContainerCondition<'a>, 1>);
40
41#[derive(ToCursors, ToSpan, SemanticEq, Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
42#[cfg_attr(feature = "serde", derive(serde::Serialize), serde())]
43#[cfg_attr(feature = "visitable", derive(csskit_derives::Visitable))]
44pub struct ContainerCondition<'a> {
45	#[cfg_attr(feature = "visitable", visit(skip))]
46	pub name: Option<T![Ident]>,
47	pub condition: Option<ContainerQuery<'a>>,
48}
49
50impl<'a> Peek<'a> for ContainerCondition<'a> {
51	const PEEK_KINDSET: KindSet = KindSet::new(&[Kind::Ident, Kind::LeftParen, Kind::Function]);
52}
53
54impl<'a> Parse<'a> for ContainerCondition<'a> {
55	fn parse<I>(p: &mut Parser<'a, I>) -> ParserResult<Self>
56	where
57		I: Iterator<Item = Cursor> + Clone,
58	{
59		let mut name = None;
60		let c = p.peek_n(1);
61		if c == Kind::Ident {
62			match p.to_atom::<CssAtomSet>(c) {
63				CssAtomSet::None | CssAtomSet::And | CssAtomSet::Not | CssAtomSet::Or => {}
64				_ => {
65					name = Some(p.parse::<T![Ident]>()?);
66				}
67			}
68		}
69		let condition =
70			if name.is_none() { Some(p.parse::<ContainerQuery>()?) } else { p.parse_if_peek::<ContainerQuery>()? };
71		Ok(Self { name, condition })
72	}
73}
74
75#[derive(ToCursors, ToSpan, SemanticEq, Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
76#[cfg_attr(feature = "serde", derive(serde::Serialize), serde())]
77#[cfg_attr(feature = "visitable", derive(csskit_derives::Visitable), visit)]
78#[derive(csskit_derives::NodeWithMetadata)]
79pub enum ContainerQuery<'a> {
80	Is(ContainerFeature<'a>),
81	Not(T![Ident], ContainerFeature<'a>),
82	And(Vec<'a, (ContainerFeature<'a>, Option<T![Ident]>)>),
83	Or(Vec<'a, (ContainerFeature<'a>, Option<T![Ident]>)>),
84}
85
86impl<'a> Peek<'a> for ContainerQuery<'a> {
87	fn peek<I>(p: &Parser<'a, I>, c: Cursor) -> bool
88	where
89		I: Iterator<Item = Cursor> + Clone,
90	{
91		<ContainerFeature>::peek(p, c) || (<T![Ident]>::peek(p, c) && p.to_atom::<CssAtomSet>(c) == CssAtomSet::Not)
92	}
93}
94
95impl<'a> Parse<'a> for ContainerQuery<'a> {
96	fn parse<I>(p: &mut Parser<'a, I>) -> ParserResult<Self>
97	where
98		I: Iterator<Item = Cursor> + Clone,
99	{
100		Self::parse_condition(p)
101	}
102}
103
104impl<'a> FeatureConditionList<'a> for ContainerQuery<'a> {
105	type FeatureCondition = ContainerFeature<'a>;
106	fn keyword_is_not<I>(p: &Parser<'a, I>, c: Cursor) -> bool
107	where
108		I: Iterator<Item = Cursor> + Clone,
109	{
110		p.equals_atom(c, &CssAtomSet::Not)
111	}
112	fn keyword_is_and<I>(p: &Parser<'a, I>, c: Cursor) -> bool
113	where
114		I: Iterator<Item = Cursor> + Clone,
115	{
116		p.equals_atom(c, &CssAtomSet::And)
117	}
118	fn keyword_is_or<I>(p: &Parser<'a, I>, c: Cursor) -> bool
119	where
120		I: Iterator<Item = Cursor> + Clone,
121	{
122		p.equals_atom(c, &CssAtomSet::Or)
123	}
124	fn build_is(feature: ContainerFeature<'a>) -> Self {
125		Self::Is(feature)
126	}
127	fn build_not(keyword: T![Ident], feature: ContainerFeature<'a>) -> Self {
128		Self::Not(keyword, feature)
129	}
130	fn build_and(feature: Vec<'a, (ContainerFeature<'a>, Option<T![Ident]>)>) -> Self {
131		Self::And(feature)
132	}
133	fn build_or(feature: Vec<'a, (ContainerFeature<'a>, Option<T![Ident]>)>) -> Self {
134		Self::Or(feature)
135	}
136}
137
138macro_rules! container_feature {
139	( $($name: ident($typ: ident))+ ) => {
140		#[derive(ToCursors, ToSpan, SemanticEq, Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
141		#[cfg_attr(feature = "serde", derive(serde::Serialize), serde())]
142		#[cfg_attr(feature = "visitable", derive(csskit_derives::Visitable), visit)]
143		#[derive(csskit_derives::NodeWithMetadata)]
144		pub enum ContainerFeature<'a> {
145			$($name($typ),)+
146			Style(
147				#[cfg_attr(feature = "visitable", visit(skip))] T![Function],
148				StyleQuery<'a>,
149				#[cfg_attr(feature = "visitable", visit(skip))] T![')'],
150			),
151			ScrollState(
152				#[cfg_attr(feature = "visitable", visit(skip))] T![Function],
153				ScrollStateQuery<'a>,
154				#[cfg_attr(feature = "visitable", visit(skip))] T![')'],
155			),
156		}
157	}
158}
159
160apply_container_features!(container_feature);
161
162impl<'a> Peek<'a> for ContainerFeature<'a> {
163	fn peek<I>(p: &Parser<'a, I>, c: Cursor) -> bool
164	where
165		I: Iterator<Item = Cursor> + Clone,
166	{
167		let c2 = p.peek_n(2);
168		(c == Kind::LeftParen && c2 == KindSet::new(&[Kind::Ident, Kind::Dimension]))
169			|| (c == Kind::Function
170				&& matches!(p.to_atom::<CssAtomSet>(c), CssAtomSet::Style | CssAtomSet::ScrollState))
171	}
172}
173
174impl<'a> Parse<'a> for ContainerFeature<'a> {
175	fn parse<I>(p: &mut Parser<'a, I>) -> ParserResult<Self>
176	where
177		I: Iterator<Item = Cursor> + Clone,
178	{
179		if p.peek::<T![Function]>() {
180			let function = p.parse::<T![Function]>()?;
181			return match p.to_atom::<CssAtomSet>(function.into()) {
182				CssAtomSet::Style => {
183					let query = p.parse::<StyleQuery>()?;
184					let close = p.parse::<T![')']>()?;
185					Ok(Self::Style(function, query, close))
186				}
187				CssAtomSet::ScrollState => {
188					let query = p.parse::<ScrollStateQuery>()?;
189					let close = p.parse::<T![')']>()?;
190					Ok(Self::ScrollState(function, query, close))
191				}
192				_ => Err(Diagnostic::new(function.into(), Diagnostic::unexpected_function))?,
193			};
194		}
195		let mut c = p.peek_n(2);
196		macro_rules! match_feature {
197			( $($name: ident($typ: ident))+ ) => {
198				// Only peek at the token as the underlying media feature parser needs to parse the leading keyword.
199				{
200					match p.to_atom::<CssAtomSet>(c) {
201						$(CssAtomSet::$name => {
202							let value = $typ::parse(p)?;
203							Self::$name(value)
204						},)+
205						_ => Err(Diagnostic::new(c, Diagnostic::unexpected))?
206					}
207				}
208			}
209		}
210		if c == Kind::Ident {
211			Ok(apply_container_features!(match_feature))
212		} else {
213			// Styles like (1em < width < 1em) or (1em <= width <= 1em)
214			c = p.peek_n(3);
215			if c != Kind::Ident {
216				c = p.peek_n(4)
217			}
218			Ok(apply_container_features!(match_feature))
219		}
220	}
221}
222
223macro_rules! apply_container_features {
224	($macro: ident) => {
225		$macro! {
226			// https://drafts.csswg.org/css-conditional-5/#container-features
227			Width(WidthContainerFeature)
228			Height(HeightContainerFeature)
229			InlineSize(InlineSizeContainerFeature)
230			BlockSize(BlockSizeContainerFeature)
231			AspectRatio(AspectRatioContainerFeature)
232			Orientation(OrientationContainerFeature)
233		}
234	};
235}
236use apply_container_features;
237
238#[cfg(test)]
239mod tests {
240	use super::*;
241	use crate::CssAtomSet;
242	use css_parse::assert_parse;
243
244	#[test]
245	fn size_test() {
246		assert_eq!(std::mem::size_of::<ContainerRule>(), 144);
247		assert_eq!(std::mem::size_of::<ContainerConditionList>(), 32);
248		assert_eq!(std::mem::size_of::<ContainerCondition>(), 216);
249		assert_eq!(std::mem::size_of::<ContainerQuery>(), 200);
250	}
251
252	#[test]
253	fn test_writes() {
254		assert_parse!(CssAtomSet::ATOMS, ContainerQuery, "(width:2px)");
255		assert_parse!(CssAtomSet::ATOMS, ContainerCondition, "(width:2px)");
256		assert_parse!(CssAtomSet::ATOMS, ContainerCondition, "(inline-size>30em)");
257		assert_parse!(CssAtomSet::ATOMS, ContainerCondition, "(1em<width<1em)");
258		assert_parse!(CssAtomSet::ATOMS, ContainerCondition, "(width > 400px)");
259		assert_parse!(CssAtomSet::ATOMS, ContainerCondition, "--container");
260		assert_parse!(CssAtomSet::ATOMS, ContainerCondition, "--container (width > 400px)");
261		assert_parse!(CssAtomSet::ATOMS, ContainerConditionList, "(width > 400px), --container (width > 400px)");
262		assert_parse!(CssAtomSet::ATOMS, ContainerRule, "@container foo{}");
263		assert_parse!(CssAtomSet::ATOMS, ContainerRule, "@container foo (width:2px){}");
264		assert_parse!(CssAtomSet::ATOMS, ContainerRule, "@container foo (10em<width<10em){}");
265		assert_parse!(CssAtomSet::ATOMS, ContainerRule, "@container foo (width:2px){body{color:black}}");
266		// Style queries
267		assert_parse!(CssAtomSet::ATOMS, ContainerFeature, "style(--x:10px)");
268		assert_parse!(CssAtomSet::ATOMS, ContainerFeature, "style(--x: 10px)");
269		assert_parse!(CssAtomSet::ATOMS, ContainerFeature, "style(--x)");
270		assert_parse!(CssAtomSet::ATOMS, ContainerQuery, "style(--x:10px)");
271		assert_parse!(CssAtomSet::ATOMS, ContainerQuery, "style(--x)");
272		assert_parse!(CssAtomSet::ATOMS, ContainerCondition, "style(--x:10px)");
273		assert_parse!(CssAtomSet::ATOMS, ContainerCondition, "style(--x: 10px)");
274		assert_parse!(CssAtomSet::ATOMS, ContainerCondition, "style(--x)");
275		assert_parse!(CssAtomSet::ATOMS, ContainerRule, "@container style(--x:10px){}");
276		assert_parse!(CssAtomSet::ATOMS, ContainerRule, "@container style(--x: 10px){}");
277		assert_parse!(CssAtomSet::ATOMS, ContainerRule, "@container style(--x){}");
278		assert_parse!(CssAtomSet::ATOMS, ContainerRule, "@container style(--x:10px){body{color:green}}");
279		assert_parse!(CssAtomSet::ATOMS, ContainerRule, "@container style(--x: 10px){body{color:green}}");
280		assert_parse!(CssAtomSet::ATOMS, ContainerRule, "@container foo style(--x:10px){}");
281		// Scroll-state queries
282		assert_parse!(CssAtomSet::ATOMS, ContainerFeature, "scroll-state(stuck:top)");
283		assert_parse!(CssAtomSet::ATOMS, ContainerFeature, "scroll-state(scrollable:y and snapped:block)");
284		assert_parse!(CssAtomSet::ATOMS, ContainerRule, "@container sticky scroll-state(stuck: top){}");
285	}
286
287	#[test]
288	fn test_style_queries() {
289		// Basic style query
290		assert_parse!(CssAtomSet::ATOMS, ContainerFeature, "style(color:red)");
291		assert_parse!(CssAtomSet::ATOMS, ContainerFeature, "style(--my-var:10px)");
292		// Style query in container condition
293		assert_parse!(CssAtomSet::ATOMS, ContainerCondition, "style(color:red)");
294		assert_parse!(CssAtomSet::ATOMS, ContainerCondition, "style(--my-var:10px)");
295		// Style query in full container rule
296		assert_parse!(CssAtomSet::ATOMS, ContainerRule, "@container style(color:red){}");
297		assert_parse!(CssAtomSet::ATOMS, ContainerRule, "@container style(--my-var:10px){}");
298		// Named container with style query
299		assert_parse!(CssAtomSet::ATOMS, ContainerRule, "@container card style(color:red){}");
300		// Style query with rules inside
301		assert_parse!(CssAtomSet::ATOMS, ContainerRule, "@container style(color:red){body{color:black}}");
302	}
303
304	#[test]
305	fn test_scroll_state_queries() {
306		// Basic scroll-state query
307		assert_parse!(CssAtomSet::ATOMS, ContainerFeature, "scroll-state(scrollable:top)");
308		assert_parse!(CssAtomSet::ATOMS, ContainerFeature, "scroll-state(snapped:x)");
309		assert_parse!(CssAtomSet::ATOMS, ContainerFeature, "scroll-state(stuck:top)");
310		// Scroll-state query in container condition
311		assert_parse!(CssAtomSet::ATOMS, ContainerCondition, "scroll-state(stuck:top)");
312		// Scroll-state query in full container rule
313		assert_parse!(CssAtomSet::ATOMS, ContainerRule, "@container scroll-state(stuck:top){}");
314		assert_parse!(CssAtomSet::ATOMS, ContainerRule, "@container scroll-state(snapped:x){}");
315		// Named container with scroll-state query
316		assert_parse!(CssAtomSet::ATOMS, ContainerRule, "@container nav scroll-state(stuck:top){}");
317		// Scroll-state query with rules inside
318		assert_parse!(CssAtomSet::ATOMS, ContainerRule, "@container scroll-state(stuck:top){.item{opacity:0.5}}");
319	}
320}
css_ast/rules/container/mod.rs

css_ast/rules/container/
mod.rs
