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

css_ast/rules/container/
mod.rs
