From 3ee8980dbe82587285e4920420687ab7ac7c5cdf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Donny/=EA=B0=95=EB=8F=99=EC=9C=A4?= Date: Wed, 21 Aug 2024 08:29:24 +0900 Subject: [PATCH] feat(visit): Add experimental traverse APIs (#9464) --- .changeset/shaggy-cats-promise.md | 9 ++++++ crates/swc_css_visit/src/generated.rs | 21 ++++++++++++- crates/swc_ecma_visit/src/generated.rs | 21 ++++++++++++- crates/swc_ecma_visit/tests/main.rs | 31 +++++++++++++++++-- crates/swc_html_visit/src/generated.rs | 21 ++++++++++++- crates/swc_xml_visit/src/generated.rs | 21 ++++++++++++- tools/generate-code/src/generators/visitor.rs | 27 +++++++++++++++- 7 files changed, 144 insertions(+), 7 deletions(-) create mode 100644 .changeset/shaggy-cats-promise.md diff --git a/.changeset/shaggy-cats-promise.md b/.changeset/shaggy-cats-promise.md new file mode 100644 index 000000000000..e48a5e93ac2c --- /dev/null +++ b/.changeset/shaggy-cats-promise.md @@ -0,0 +1,9 @@ +--- +swc_css_visit: patch +swc_html_visit: patch +swc_xml_visit: patch +swc_ecma_visit: patch +swc_core: patch +--- + +feat(visit): Add experimental traverse APIs diff --git a/crates/swc_css_visit/src/generated.rs b/crates/swc_css_visit/src/generated.rs index 7cb3ad7e6285..4e3932221a28 100644 --- a/crates/swc_css_visit/src/generated.rs +++ b/crates/swc_css_visit/src/generated.rs @@ -113036,8 +113036,9 @@ pub enum NodeRef<'ast> { WqName(&'ast WqName), } impl<'ast> NodeRef<'ast> { + #[doc = r" This is not a part of semver-stable API. It is experimental and subject to change."] #[allow(unreachable_patterns)] - pub fn raw_children(&'ast self) -> Box>> { + pub fn experimental_raw_children<'a>(&'a self) -> Box>> { match self { NodeRef::AbsoluteColorBase(node) => match node { AbsoluteColorBase::HexColor(v0) => { @@ -114614,5 +114615,23 @@ impl<'ast> NodeRef<'ast> { } } } +impl<'ast> NodeRef<'ast> { + #[doc = r" Visit all nodes in self in preorder."] + #[doc = r""] + #[doc = r" This is not a part of semver-stable API. It is"] + #[doc = r" experimental and subject to change."] + pub fn experimental_traverse(&'ast self) -> Box>> { + let mut queue = std::collections::VecDeque::>::new(); + queue.push_back(*self); + Box::new(std::iter::from_fn(move || { + let node: NodeRef<'ast> = queue.pop_front()?; + { + let children = node.experimental_raw_children(); + queue.extend(children); + } + Some(node) + })) + } +} #[cfg(any(docsrs, feature = "path"))] pub use self::fields::{AstParentKind, AstParentNodeRef}; diff --git a/crates/swc_ecma_visit/src/generated.rs b/crates/swc_ecma_visit/src/generated.rs index 249cde5aa785..d65a92315ca3 100644 --- a/crates/swc_ecma_visit/src/generated.rs +++ b/crates/swc_ecma_visit/src/generated.rs @@ -143163,8 +143163,9 @@ pub enum NodeRef<'ast> { YieldExpr(&'ast YieldExpr), } impl<'ast> NodeRef<'ast> { + #[doc = r" This is not a part of semver-stable API. It is experimental and subject to change."] #[allow(unreachable_patterns)] - pub fn raw_children(&'ast self) -> Box>> { + pub fn experimental_raw_children<'a>(&'a self) -> Box>> { match self { NodeRef::Accessibility(node) => match node { _ => Box::new(::std::iter::empty::>()), @@ -145509,5 +145510,23 @@ impl<'ast> NodeRef<'ast> { } } } +impl<'ast> NodeRef<'ast> { + #[doc = r" Visit all nodes in self in preorder."] + #[doc = r""] + #[doc = r" This is not a part of semver-stable API. It is"] + #[doc = r" experimental and subject to change."] + pub fn experimental_traverse(&'ast self) -> Box>> { + let mut queue = std::collections::VecDeque::>::new(); + queue.push_back(*self); + Box::new(std::iter::from_fn(move || { + let node: NodeRef<'ast> = queue.pop_front()?; + { + let children = node.experimental_raw_children(); + queue.extend(children); + } + Some(node) + })) + } +} #[cfg(any(docsrs, feature = "path"))] pub use self::fields::{AstParentKind, AstParentNodeRef}; diff --git a/crates/swc_ecma_visit/tests/main.rs b/crates/swc_ecma_visit/tests/main.rs index cfd78bb62f18..b5cfb56c3530 100644 --- a/crates/swc_ecma_visit/tests/main.rs +++ b/crates/swc_ecma_visit/tests/main.rs @@ -1,6 +1,6 @@ use swc_common::{chain, DUMMY_SP}; -use swc_ecma_ast::{Module, Program}; -use swc_ecma_visit::{Visit, VisitWith}; +use swc_ecma_ast::*; +use swc_ecma_visit::{NodeRef, Visit, VisitWith}; #[test] fn should_visit_program() { @@ -29,3 +29,30 @@ fn should_visit_program() { assert_eq!(counter, 1); } + +#[test] +fn traverse_lookup() { + let node = Expr::Call(CallExpr { + span: DUMMY_SP, + callee: Callee::Expr( + AwaitExpr { + span: DUMMY_SP, + arg: Ident::new_no_ctxt("foo".into(), DUMMY_SP).into(), + } + .into(), + ), + args: Vec::new(), + ..Default::default() + }); + + let node_ref = NodeRef::from(&node); + let iter = node_ref.experimental_traverse(); + + let mut has_await = false; + + for node in iter { + has_await |= matches!(node, NodeRef::AwaitExpr(..)); + } + + assert!(has_await); +} diff --git a/crates/swc_html_visit/src/generated.rs b/crates/swc_html_visit/src/generated.rs index 8054a4075ee6..759070f8e6cd 100644 --- a/crates/swc_html_visit/src/generated.rs +++ b/crates/swc_html_visit/src/generated.rs @@ -11289,8 +11289,9 @@ pub enum NodeRef<'ast> { TokenAndSpan(&'ast TokenAndSpan), } impl<'ast> NodeRef<'ast> { + #[doc = r" This is not a part of semver-stable API. It is experimental and subject to change."] #[allow(unreachable_patterns)] - pub fn raw_children(&'ast self) -> Box>> { + pub fn experimental_raw_children<'a>(&'a self) -> Box>> { match self { NodeRef::Attribute(node) => { let iterator = ::std::iter::empty::>().chain( @@ -11381,5 +11382,23 @@ impl<'ast> NodeRef<'ast> { } } } +impl<'ast> NodeRef<'ast> { + #[doc = r" Visit all nodes in self in preorder."] + #[doc = r""] + #[doc = r" This is not a part of semver-stable API. It is"] + #[doc = r" experimental and subject to change."] + pub fn experimental_traverse(&'ast self) -> Box>> { + let mut queue = std::collections::VecDeque::>::new(); + queue.push_back(*self); + Box::new(std::iter::from_fn(move || { + let node: NodeRef<'ast> = queue.pop_front()?; + { + let children = node.experimental_raw_children(); + queue.extend(children); + } + Some(node) + })) + } +} #[cfg(any(docsrs, feature = "path"))] pub use self::fields::{AstParentKind, AstParentNodeRef}; diff --git a/crates/swc_xml_visit/src/generated.rs b/crates/swc_xml_visit/src/generated.rs index 237deb6c6537..58b53f2775f2 100644 --- a/crates/swc_xml_visit/src/generated.rs +++ b/crates/swc_xml_visit/src/generated.rs @@ -10857,8 +10857,9 @@ pub enum NodeRef<'ast> { TokenAndSpan(&'ast TokenAndSpan), } impl<'ast> NodeRef<'ast> { + #[doc = r" This is not a part of semver-stable API. It is experimental and subject to change."] #[allow(unreachable_patterns)] - pub fn raw_children(&'ast self) -> Box>> { + pub fn experimental_raw_children<'a>(&'a self) -> Box>> { match self { NodeRef::Attribute(node) => { let iterator = ::std::iter::empty::>().chain( @@ -10942,5 +10943,23 @@ impl<'ast> NodeRef<'ast> { } } } +impl<'ast> NodeRef<'ast> { + #[doc = r" Visit all nodes in self in preorder."] + #[doc = r""] + #[doc = r" This is not a part of semver-stable API. It is"] + #[doc = r" experimental and subject to change."] + pub fn experimental_traverse(&'ast self) -> Box>> { + let mut queue = std::collections::VecDeque::>::new(); + queue.push_back(*self); + Box::new(std::iter::from_fn(move || { + let node: NodeRef<'ast> = queue.pop_front()?; + { + let children = node.experimental_raw_children(); + queue.extend(children); + } + Some(node) + })) + } +} #[cfg(any(docsrs, feature = "path"))] pub use self::fields::{AstParentKind, AstParentNodeRef}; diff --git a/tools/generate-code/src/generators/visitor.rs b/tools/generate-code/src/generators/visitor.rs index 898328376063..6f74be02d19b 100644 --- a/tools/generate-code/src/generators/visitor.rs +++ b/tools/generate-code/src/generators/visitor.rs @@ -1599,14 +1599,39 @@ fn define_fields(crate_name: &Ident, node_types: &[&Item]) -> Vec { )); items.push(parse_quote!( impl<'ast> NodeRef<'ast> { + /// This is not a part of semver-stable API. It is experimental and subject to change. #[allow(unreachable_patterns)] - pub fn raw_children(&'ast self) -> Box>> { + pub fn experimental_raw_children<'a>(&'a self) -> Box>> { match self { #(#node_ref_iter_next_arms)* } } } )); + + items.push(parse_quote!( + impl<'ast> NodeRef<'ast> { + /// Visit all nodes in self in preorder. + /// + /// This is not a part of semver-stable API. It is + /// experimental and subject to change. + pub fn experimental_traverse( + &'ast self, + ) -> Box>> { + let mut queue = std::collections::VecDeque::>::new(); + queue.push_back(*self); + + Box::new(std::iter::from_fn(move || { + let node: NodeRef<'ast> = queue.pop_front()?; + { + let children = node.experimental_raw_children(); + queue.extend(children); + } + Some(node) + })) + } + } + )); } items.insert(