css_ast/
stylesheet.rs

1use crate::{CssAtomSet, CssMetadata, StyleValue, rules, stylerule::StyleRule};
2use bumpalo::collections::Vec;
3use css_parse::{
4	ComponentValues, Cursor, Diagnostic, NodeWithMetadata, Parse, Parser, QualifiedRule, Result as ParserResult,
5	RuleVariants, StyleSheet as StyleSheetTrait, T, UnknownRuleBlock,
6};
7use csskit_derives::{Parse, Peek, SemanticEq, ToCursors, ToSpan};
8
9// https://drafts.csswg.org/cssom-1/#the-cssstylesheet-interface
10#[derive(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)]
13pub struct StyleSheet<'a> {
14	pub rules: Vec<'a, Rule<'a>>,
15	#[to_cursors(skip)]
16	#[cfg_attr(feature = "serde", serde(skip))]
17	#[cfg_attr(feature = "visitable", visit(skip))]
18	meta: CssMetadata,
19}
20
21impl<'a> NodeWithMetadata<CssMetadata> for StyleSheet<'a> {
22	fn metadata(&self) -> CssMetadata {
23		self.meta
24	}
25}
26
27// A StyleSheet represents the root node of a CSS-like language.
28// The StyleSheet trait represents an abstraction of this, which allows for
29// alternate implementations such as SCSS.
30// AtRules vs QualifiedRules are differentiated by two different functions.
31impl<'a> Parse<'a> for StyleSheet<'a> {
32	fn parse<I>(p: &mut Parser<'a, I>) -> ParserResult<Self>
33	where
34		I: Iterator<Item = Cursor> + Clone,
35	{
36		let (rules, meta) = Self::parse_stylesheet(p)?;
37		Ok(Self { rules, meta })
38	}
39}
40
41impl<'a> StyleSheetTrait<'a, CssMetadata> for StyleSheet<'a> {
42	type Rule = Rule<'a>;
43}
44
45macro_rules! apply_rules {
46	($macro: ident) => {
47		$macro! {
48			Charset(CharsetRule): CssAtomSet::Charset,
49			ColorProfile(ColorProfileRule): CssAtomSet::ColorProfile,
50			Container(ContainerRule<'a>): CssAtomSet::Container,
51			CounterStyle(CounterStyleRule<'a>): CssAtomSet::CounterStyle,
52			FontFace(FontFaceRule<'a>): CssAtomSet::FontFace,
53			FontFeatureValues(FontFeatureValuesRule): CssAtomSet::FontFeatureValues,
54			FontPaletteValues(FontPaletteValuesRule): CssAtomSet::FontPaletteValues,
55			Import(ImportRule<'a>): CssAtomSet::Import,
56			Keyframes(KeyframesRule<'a>): CssAtomSet::Keyframes,
57			Layer(LayerRule<'a>): CssAtomSet::Layer,
58			Media(MediaRule<'a>): CssAtomSet::Media,
59			Namespace(NamespaceRule): CssAtomSet::Namespace,
60			Page(PageRule<'a>): CssAtomSet::Page,
61			Property(PropertyRule<'a>): CssAtomSet::Property,
62			Scope(ScopeRule): CssAtomSet::Scope,
63			StartingStyle(StartingStyleRule<'a>): CssAtomSet::StartingStyle,
64			Supports(SupportsRule<'a>): CssAtomSet::Supports,
65
66			// Deprecated Rules
67			Document(DocumentRule<'a>): CssAtomSet::Document,
68
69			// Vendor Prefixed
70			WebkitKeyframes(WebkitKeyframesRule<'a>): CssAtomSet::_WebkitKeyframes,
71
72			// https://developer.mozilla.org/en-US/docs/Web/CSS/Mozilla_Extensions#at-rules
73			MozDocument(MozDocumentRule<'a>): CssAtomSet::_MozDocument,
74		}
75	};
76}
77
78#[derive(Parse, Peek, ToSpan, ToCursors, SemanticEq, Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
79#[cfg_attr(feature = "serde", derive(serde::Serialize), serde())]
80#[cfg_attr(feature = "visitable", derive(csskit_derives::Visitable), visit(self))]
81#[derive(csskit_derives::NodeWithMetadata)]
82#[metadata(node_kinds = Unknown)]
83pub struct UnknownAtRule<'a> {
84	name: T![AtKeyword],
85	prelude: ComponentValues<'a>,
86	block: ComponentValues<'a>,
87}
88
89#[derive(Parse, Peek, ToSpan, ToCursors, SemanticEq, Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
90#[cfg_attr(feature = "serde", derive(serde::Serialize), serde())]
91#[cfg_attr(feature = "visitable", derive(csskit_derives::Visitable), visit(self))]
92#[derive(csskit_derives::NodeWithMetadata)]
93#[metadata(node_kinds = Unknown)]
94pub struct UnknownQualifiedRule<'a>(
95	#[metadata(delegate)]
96	QualifiedRule<
97		'a,
98		UnknownRuleBlock<'a>,
99		StyleValue<'a>,
100		UnknownRuleBlock<'a, StyleValue<'a>, CssMetadata>,
101		CssMetadata,
102	>,
103);
104
105macro_rules! rule {
106    ( $(
107        $name: ident($ty: ident$(<$a: lifetime>)?): $str: pat,
108    )+ ) => {
109		#[allow(clippy::large_enum_variant)] // TODO: Box?
110		// https://drafts.csswg.org/cssom-1/#the-cssrule-interface
111		#[derive(ToSpan, ToCursors, SemanticEq, Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
112		#[cfg_attr(feature = "visitable", derive(csskit_derives::Visitable))]
113		#[cfg_attr(feature = "serde", derive(serde::Serialize), serde(untagged))]
114		#[derive(csskit_derives::NodeWithMetadata)]
115		#[metadata(delegate)]
116		pub enum Rule<'a> {
117			$(
118				$name(rules::$ty$(<$a>)?),
119			)+
120			UnknownAt(UnknownAtRule<'a>),
121			Style(StyleRule<'a>),
122			Unknown(UnknownQualifiedRule<'a>)
123		}
124	}
125}
126
127apply_rules!(rule);
128
129impl<'a> RuleVariants<'a> for Rule<'a> {
130	type DeclarationValue = StyleValue<'a>;
131	type Metadata = CssMetadata;
132
133	fn parse_at_rule<I>(p: &mut Parser<'a, I>, c: Cursor) -> ParserResult<Self>
134	where
135		I: Iterator<Item = Cursor> + Clone,
136	{
137		macro_rules! parse_rule {
138			( $(
139				$name: ident($ty: ident$(<$a: lifetime>)?): $atoms: pat,
140			)+ ) => {
141				match p.to_atom::<CssAtomSet>(c) {
142					$($atoms => p.parse::<rules::$ty>().map(Self::$name),)+
143					_ => Err(Diagnostic::new(p.next(), Diagnostic::unexpected))?,
144				}
145			}
146		}
147		apply_rules!(parse_rule)
148	}
149
150	fn parse_unknown_at_rule<I>(p: &mut Parser<'a, I>, _name: Cursor) -> ParserResult<Self>
151	where
152		I: Iterator<Item = Cursor> + Clone,
153	{
154		p.parse::<UnknownAtRule>().map(Self::UnknownAt)
155	}
156
157	fn parse_qualified_rule<I>(p: &mut Parser<'a, I>, _name: Cursor) -> ParserResult<Self>
158	where
159		I: Iterator<Item = Cursor> + Clone,
160	{
161		p.parse::<StyleRule>().map(Self::Style)
162	}
163
164	fn parse_unknown_qualified_rule<I>(p: &mut Parser<'a, I>, _name: Cursor) -> ParserResult<Self>
165	where
166		I: Iterator<Item = Cursor> + Clone,
167	{
168		p.parse::<UnknownQualifiedRule>().map(Self::Unknown)
169	}
170}
171
172impl<'a> Parse<'a> for Rule<'a> {
173	fn parse<I>(p: &mut Parser<'a, I>) -> ParserResult<Self>
174	where
175		I: Iterator<Item = Cursor> + Clone,
176	{
177		Self::parse_rule_variants(p)
178	}
179}
180
181#[cfg(test)]
182mod tests {
183	use super::*;
184	use crate::CssAtomSet;
185	use css_parse::assert_parse;
186
187	#[test]
188	fn size_test() {
189		assert_eq!(std::mem::size_of::<StyleSheet>(), 64);
190		assert_eq!(std::mem::size_of::<Rule>(), 752);
191	}
192
193	#[test]
194	fn test_writes() {
195		assert_parse!(CssAtomSet::ATOMS, StyleSheet, "body{}");
196		assert_parse!(CssAtomSet::ATOMS, StyleSheet, "body{color:red;}");
197		assert_parse!(CssAtomSet::ATOMS, StyleSheet, "body,tr:nth-child(n-1){}");
198		assert_parse!(CssAtomSet::ATOMS, StyleSheet, "body{width:1px;}");
199		assert_parse!(CssAtomSet::ATOMS, StyleSheet, "body{width:1px;}.a{width:2px;}");
200		assert_parse!(CssAtomSet::ATOMS, StyleSheet, "one:1;a{two:2}");
201		assert_parse!(CssAtomSet::ATOMS, Rule, "@media screen{}", Rule::Media(_));
202		assert_parse!(CssAtomSet::ATOMS, Rule, "@layer foo{}", Rule::Layer(_));
203	}
204}