polyglot-piranha 0.3.35__tar.gz → 0.4.0__tar.gz

{polyglot_piranha-0.3.35 → polyglot_piranha-0.4.0}/Cargo.lock

@@ -85,9 +85,9 @@ dependencies = [
 
 [[package]]
 name = "autocfg"
-version = "1.4.0"
+version = "1.5.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ace50bade8e6234aa140d9a2f552bbee1db4d353f69b8217bc503490fc1a9f26"
+checksum = "c08606f8c3cbf4ce6ec8e28fb0014a2c086708fe954eaa885384a6165172e7e8"
 
 [[package]]
 name = "bitflags"
@@ -95,6 +95,15 @@ version = "2.9.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "1b8e56985ec62d17e9c1001dc89c88ecd7dc08e47eba5ec7c29c7b5eeecde967"
 
+[[package]]
+name = "block-buffer"
+version = "0.10.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3078c7629b62d3f0439517fa394996acacc5cbc91c5a20d8c658e77abd503a71"
+dependencies = [
+ "generic-array",
+]
+
 [[package]]
 name = "bstr"
 version = "1.12.0"
@@ -155,7 +164,7 @@ dependencies = [
  "heck 0.5.0",
  "proc-macro2",
  "quote",
- "syn 2.0.102",
+ "syn 2.0.104",
 ]
 
 [[package]]
@@ -180,6 +189,15 @@ dependencies = [
  "windows-sys",
 ]
 
+[[package]]
+name = "cpufeatures"
+version = "0.2.17"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "59ed5838eebb26a2bb2e58f6d5b5316989ae9d08bab10e0e6d103e656d1b0280"
+dependencies = [
+ "libc",
+]
+
 [[package]]
 name = "crossbeam"
 version = "0.8.4"
@@ -236,6 +254,16 @@ version = "0.8.21"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "d0a5c400df2834b80a4c3327b3aad3a4c4cd4de0629063962b03235697506a28"
 
+[[package]]
+name = "crypto-common"
+version = "0.1.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1bfb12502f3fc46cca1bb51ac28df9d618d813cdc3d2f25b9fe775a34af26bb3"
+dependencies = [
+ "generic-array",
+ "typenum",
+]
+
 [[package]]
 name = "ctrlc"
 version = "3.4.7"
@@ -318,6 +346,16 @@ version = "0.4.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "6184e33543162437515c2e2b48714794e37845ec9851711914eec9d308f6ebe8"
 
+[[package]]
+name = "digest"
+version = "0.10.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9ed9a281f7bc9b7576e61468ba615a66a5c8cfdff42420a70aa82701a3b1e292"
+dependencies = [
+ "block-buffer",
+ "crypto-common",
+]
+
 [[package]]
 name = "doc-comment"
 version = "0.3.3"
@@ -370,16 +408,26 @@ version = "0.1.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "a06f77d526c1a601b7c4cdd98f54b5eaabffc14d5f2f0296febdc7f357c6d3ba"
 
+[[package]]
+name = "generic-array"
+version = "0.14.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "85649ca51fd72272d7821adaf274ad91c288277713d9c18820d8499a7ff69e9a"
+dependencies = [
+ "typenum",
+ "version_check",
+]
+
 [[package]]
 name = "getset"
-version = "0.1.5"
+version = "0.1.6"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f3586f256131df87204eb733da72e3d3eb4f343c639f4b7be279ac7c48baeafe"
+checksum = "9cf0fc11e47561d47397154977bc219f4cf809b2974facc3ccb3b89e2436f912"
 dependencies = [
  "proc-macro-error2",
  "proc-macro2",
  "quote",
- "syn 2.0.102",
+ "syn 2.0.104",
 ]
 
 [[package]]
@@ -408,9 +456,9 @@ checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
 
 [[package]]
 name = "hermit-abi"
-version = "0.5.1"
+version = "0.5.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f154ce46856750ed433c8649605bf7ed2de3bc35fd9d2a9f30cddd873c80cb08"
+checksum = "fc0fef456e4baa96da950455cd02c081ca953b141298e41db3fc7e36b1da849c"
 
 [[package]]
 name = "humantime"
@@ -426,9 +474,9 @@ checksum = "b9e0384b61958566e926dc50660321d12159025e767c18e043daf26b70104c39"
 
 [[package]]
 name = "indexmap"
-version = "2.9.0"
+version = "2.10.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "cea70ddb795996207ad57735b50c5982d8844f38ba9ee5f1aedcfb708a2aa11e"
+checksum = "fe4cd85333e22411419a0bcae1297d25e58c9443848b11dc6a86fefe8c78a661"
 dependencies = [
  "equivalent",
  "hashbrown",
@@ -496,9 +544,9 @@ checksum = "bbd2bcb4c963f2ddae06a2efc7e9f3591312473c50c6685e1f298068316e66fe"
 
 [[package]]
 name = "libc"
-version = "0.2.172"
+version = "0.2.174"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d750af042f7ef4f724306de029d18836c26c1765a54a6a3f094cbd23a7267ffa"
+checksum = "1171693293099992e19cddea4e8b849964e9846f4acee11b3948bcc337be8776"
 
 [[package]]
 name = "lock_api"
@@ -593,9 +641,53 @@ dependencies = [
  "windows-targets",
 ]
 
+[[package]]
+name = "pest"
+version = "2.8.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1db05f56d34358a8b1066f67cbb203ee3e7ed2ba674a6263a1d5ec6db2204323"
+dependencies = [
+ "memchr",
+ "thiserror",
+ "ucd-trie",
+]
+
+[[package]]
+name = "pest_derive"
+version = "2.8.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "bb056d9e8ea77922845ec74a1c4e8fb17e7c218cc4fc11a15c5d25e189aa40bc"
+dependencies = [
+ "pest",
+ "pest_generator",
+]
+
+[[package]]
+name = "pest_generator"
+version = "2.8.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "87e404e638f781eb3202dc82db6760c8ae8a1eeef7fb3fa8264b2ef280504966"
+dependencies = [
+ "pest",
+ "pest_meta",
+ "proc-macro2",
+ "quote",
+ "syn 2.0.104",
+]
+
+[[package]]
+name = "pest_meta"
+version = "2.8.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "edd1101f170f5903fde0914f899bb503d9ff5271d7ba76bbb70bea63690cc0d5"
+dependencies = [
+ "pest",
+ "sha2",
+]
+
 [[package]]
 name = "piranha"
-version = "0.3.35"
+version = "0.4.0"
 dependencies = [
  "assert_cmd",
  "cc",
@@ -611,6 +703,8 @@ dependencies = [
  "jwalk",
  "lazy_static",
  "log",
+ "pest",
+ "pest_derive",
  "predicates",
  "pyo3",
  "pyo3-log",
@@ -691,7 +785,7 @@ dependencies = [
  "proc-macro-error-attr2",
  "proc-macro2",
  "quote",
- "syn 2.0.102",
+ "syn 2.0.104",
 ]
 
 [[package]]
@@ -761,7 +855,7 @@ dependencies = [
  "proc-macro2",
  "pyo3-macros-backend",
  "quote",
- "syn 2.0.102",
+ "syn 2.0.104",
 ]
 
 [[package]]
@@ -774,7 +868,7 @@ dependencies = [
  "proc-macro2",
  "pyo3-build-config",
  "quote",
- "syn 2.0.102",
+ "syn 2.0.104",
 ]
 
 [[package]]
@@ -845,9 +939,9 @@ dependencies = [
 
 [[package]]
 name = "redox_syscall"
-version = "0.5.12"
+version = "0.5.13"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "928fca9cf2aa042393a8325b9ead81d2f0df4cb12e1e24cef072922ccd99c5af"
+checksum = "0d04b7d0ee6b4a0207a0a7adb104d23ecb0b47d6beae7152d0fa34b692b29fd6"
 dependencies = [
  "bitflags",
 ]
@@ -919,7 +1013,7 @@ checksum = "5b0276cf7f2c73365f7157c8123c21cd9a50fbbd844757af28ca1f5925fc2a00"
 dependencies = [
  "proc-macro2",
  "quote",
- "syn 2.0.102",
+ "syn 2.0.104",
 ]
 
 [[package]]
@@ -943,6 +1037,17 @@ dependencies = [
  "serde",
 ]
 
+[[package]]
+name = "sha2"
+version = "0.10.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a7507d819769d01a365ab707794a4084392c824f54a7a6a7862f8c3d0892b283"
+dependencies = [
+ "cfg-if",
+ "cpufeatures",
+ "digest",
+]
+
 [[package]]
 name = "smallvec"
 version = "1.15.1"
@@ -974,9 +1079,9 @@ dependencies = [
 
 [[package]]
 name = "syn"
-version = "2.0.102"
+version = "2.0.104"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f6397daf94fa90f058bd0fd88429dd9e5738999cca8d701813c80723add80462"
+checksum = "17b6f705963418cdb9927482fa304bc562ece2fdd4f616084c50b7023b435a40"
 dependencies = [
  "proc-macro2",
  "quote",
@@ -1014,6 +1119,26 @@ version = "0.5.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "8f50febec83f5ee1df3015341d8bd429f2d1cc62bcba7ea2076759d315084683"
 
+[[package]]
+name = "thiserror"
+version = "2.0.12"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "567b8a2dae586314f7be2a752ec7474332959c6460e02bde30d702a66d488708"
+dependencies = [
+ "thiserror-impl",
+]
+
+[[package]]
+name = "thiserror-impl"
+version = "2.0.12"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7f7cf42b4507d8ea322120659672cf1b9dbb93f8f2d4ecfd6e51350ff5b17a1d"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn 2.0.104",
+]
+
 [[package]]
 name = "toml"
 version = "0.8.23"
@@ -1190,6 +1315,18 @@ dependencies = [
  "tree-sitter",
 ]
 
+[[package]]
+name = "typenum"
+version = "1.18.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1dccffe3ce07af9386bfd29e80c0ab1a8205a2fc34e4bcd40364df902cfa8f3f"
+
+[[package]]
+name = "ucd-trie"
+version = "0.1.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2896d95c02a80c6d6a5d6e953d479f5ddf2dfdb6a244441010e373ac0fb88971"
+
 [[package]]
 name = "unicode-ident"
 version = "1.0.18"
@@ -1208,6 +1345,12 @@ version = "0.2.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821"
 
+[[package]]
+name = "version_check"
+version = "0.9.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0b928f33d975fc6ad9f86c8f283853ad26bdd5b10b7f1542aa2fa15e2289105a"
+
 [[package]]
 name = "wait-timeout"
 version = "0.2.1"

{polyglot_piranha-0.3.35 → polyglot_piranha-0.4.0}/Cargo.toml

@@ -2,7 +2,7 @@
 authors = ["Uber Technologies Inc."]
 name = "piranha"
 description = "Polyglot Piranha is a library for performing structural find and replace with deep cleanup."
-version = "0.3.35"
+version = "0.4.0"
 edition = "2021"
 include = ["pyproject.toml", "src/"]
 exclude = ["legacy"]
@@ -70,6 +70,8 @@ pyo3 = "0.20.0"
 pyo3-log = "0.9.0"
 glob = "0.3.1"
 lazy_static = "1.4.0"
+pest = "2.8.1"
+pest_derive = "2.8.1"
 
 [features]
 extension-module = ["pyo3/extension-module"]

{polyglot_piranha-0.3.35 → polyglot_piranha-0.4.0}/PKG-INFO

@@ -1,6 +1,8 @@
 Metadata-Version: 2.4
 Name: polyglot_piranha
-Version: 0.3.35
+Version: 0.4.0
+Requires-Dist: pytest>=8.0 ; extra == 'dev'
+Provides-Extra: dev
 License-File: LICENSE
 License-File: NOTICE
 Summary: Polyglot Piranha is a library for performing structural find and replace with deep cleanup.
@@ -114,6 +116,15 @@ A few additional links on Piranha:
 
 If you have any questions on how to use Piranha or find any bugs, please [open a GitHub issue](https://github.com/uber/piranha/issues).
 
+## Piranha Development
+
+Piranha uses several grammar repositories with custom patches to support the transformations. While
+these patches are being upstreamed, there may be discrepancies between the grammars in this 
+repository and the upstream grammars. Therefore, we have built a custom tree-sitter playground
+that can be used to test the grammars and queries for easier development:
+
+https://uber.github.io/piranha/tree-sitter-playground/
+
 ## License
 Piranha is licensed under the Apache 2.0 license.  See the LICENSE file for more information.
 

{polyglot_piranha-0.3.35 → polyglot_piranha-0.4.0}/README.md

@@ -99,6 +99,15 @@ A few additional links on Piranha:
 
 If you have any questions on how to use Piranha or find any bugs, please [open a GitHub issue](https://github.com/uber/piranha/issues).
 
+## Piranha Development
+
+Piranha uses several grammar repositories with custom patches to support the transformations. While
+these patches are being upstreamed, there may be discrepancies between the grammars in this 
+repository and the upstream grammars. Therefore, we have built a custom tree-sitter playground
+that can be used to test the grammars and queries for easier development:
+
+https://uber.github.io/piranha/tree-sitter-playground/
+
 ## License
 Piranha is licensed under the Apache 2.0 license.  See the LICENSE file for more information.
 

{polyglot_piranha-0.3.35 → polyglot_piranha-0.4.0}/pyproject.toml

@@ -20,9 +20,15 @@ documentation = "https://github.com/uber/piranha"
 repository = "https://github.com/uber/piranha"
 
 [build-system]
-requires = ["maturin>=1.4.0,<2.0"]
+# There is a bug with maturin 1.9.0 that incorrectly packages LICENSE file causing a problem.
+# For now we have to pin it to 1.8.7 (last stable version).
+# TODO: remove this check once maturin is fixed.
+requires = ["maturin>=1.4.0,<=1.8.7"]
 build-backend = "maturin"
 
+[project.optional-dependencies]
+dev = ["pytest>=8.0"]
+
 [tool.maturin]
 bindings = "pyo3"
 include = ["LICENSE", "NOTICE", "polyglot_piranha.pyi"]

{polyglot_piranha-0.3.35 → polyglot_piranha-0.4.0}/src/df/utils.rs

@@ -34,6 +34,7 @@ pub fn get_capture_groups_from_matcher(node: &Rule) -> Vec<String> {
   match &node.query().pattern_type() {
     PatternType::Tsq => get_capture_groups_from_tsq(node.query().pattern()),
     PatternType::Regex => get_capture_groups_from_regex(node.query().extract_regex().unwrap()),
+    PatternType::Cs => vec![],
     PatternType::Unknown => vec![],
   }
 }
@@ -47,6 +48,7 @@ pub fn get_capture_group_usage_from_matcher(node: &Rule) -> Vec<String> {
   match &node.query().pattern_type() {
     PatternType::Tsq => get_capture_group_usage_from_tsq(node.query().pattern()),
     PatternType::Regex => get_capture_group_usage_from_regex(node.query().pattern()),
+    PatternType::Cs => vec![],
     PatternType::Unknown => vec![],
   }
 }
@@ -57,7 +59,7 @@ pub fn get_capture_groups_from_regex(re: Regex) -> Vec<String> {
 
   // Check all capture names (i.e., named groups) in the pattern
   for capture_name in re.capture_names().flatten() {
-    let tag = format!("@{}", capture_name);
+    let tag = format!("@{capture_name}");
     tags.push(tag);
   }
   tags
@@ -110,7 +112,7 @@ pub fn get_capture_groups_from_tsq(pattern: String) -> Vec<String> {
     })
     .unwrap_or_default();
 
-  log::debug!("capture_groups: {:?}", capture_groups);
+  log::debug!("capture_groups: {capture_groups:?}");
 
   capture_groups
 }
@@ -164,6 +166,6 @@ pub fn get_capture_group_usage_from_tsq(pattern: String) -> Vec<String> {
     .map(|mat| mat.as_str().to_owned())
     .collect();
 
-  log::debug!("capture_groups: {:?}", capture_groups);
+  log::debug!("capture_groups: {capture_groups:?}");
   capture_groups
 }

{polyglot_piranha-0.3.35 → polyglot_piranha-0.4.0}/src/lib.rs

@@ -21,7 +21,6 @@ use models::{
 extern crate lazy_static;
 pub mod df;
 pub mod models;
-
 #[cfg(test)]
 mod tests;
 pub mod utilities;

{polyglot_piranha-0.3.35 → polyglot_piranha-0.4.0}/src/main.rs

@@ -35,7 +35,7 @@ fn main() {
 
   let args = PiranhaArguments::from_cli();
 
-  debug!("Piranha Arguments are \n{:#?}", args);
+  debug!("Piranha Arguments are \n{args:#?}");
   let piranha_output_summaries = execute_piranha(&args);
 
   if let Some(path) = args.path_to_output_summary() {

{polyglot_piranha-0.3.35 → polyglot_piranha-0.4.0}/src/models/capture_group_patterns.rs

@@ -11,7 +11,8 @@ Copyright (c) 2023 Uber Technologies, Inc.
  limitations under the License.
 */
 
-use crate::models::concrete_syntax::get_all_matches_for_concrete_syntax;
+use crate::models::concrete_syntax::interpreter::get_all_matches_for_concrete_syntax;
+use crate::models::concrete_syntax::parser::ConcreteSyntax;
 use crate::{
   models::Validator,
   utilities::{
@@ -26,8 +27,6 @@ use serde_derive::Deserialize;
 use std::collections::HashMap;
 use tree_sitter::{Node, Query};
 
-#[derive(Debug)]
-pub struct ConcreteSyntax(pub String);
 use super::{
   default_configs::{CONCRETE_SYNTAX_QUERY_PREFIX, REGEX_QUERY_PREFIX},
   matches::Match,
@@ -36,6 +35,7 @@ use super::{
 pub enum PatternType {
   Tsq,
   Regex,
+  Cs,
   Unknown,
 }
 
@@ -59,13 +59,14 @@ impl CGPattern {
 
   pub(crate) fn extract_concrete_syntax(&self) -> ConcreteSyntax {
     let mut _val = &self.pattern()[CONCRETE_SYNTAX_QUERY_PREFIX.len()..];
-    ConcreteSyntax(_val.to_string())
+    ConcreteSyntax::parse(_val).unwrap()
   }
 
   pub(crate) fn pattern_type(&self) -> PatternType {
     match self.0.as_str() {
       pattern if pattern.starts_with("rgx") => PatternType::Regex,
       pattern if pattern.trim().starts_with('(') => PatternType::Tsq,
+      pattern if pattern.trim().starts_with("cs") => PatternType::Cs,
       _ => PatternType::Unknown,
     }
   }
@@ -132,7 +133,6 @@ impl CompiledCGPattern {
     &self, node: &Node, source_code: String, recursive: bool, replace_node: Option<String>,
     replace_node_idx: Option<u8>,
   ) -> Vec<Match> {
-    let code_str = source_code.as_bytes();
     match self {
       CompiledCGPattern::Q(query) => get_all_matches_for_query(
         node,
@@ -146,14 +146,15 @@ impl CompiledCGPattern {
         get_all_matches_for_regex(node, source_code, regex, recursive, replace_node)
       }
       CompiledCGPattern::M(concrete_syntax) => {
-        let matches = get_all_matches_for_concrete_syntax(
+        let source_code_ref = source_code.as_bytes();
+        let resolved_syntax = concrete_syntax.clone().resolve().unwrap();
+        get_all_matches_for_concrete_syntax(
           node,
-          code_str,
-          concrete_syntax,
+          source_code_ref,
+          &resolved_syntax,
           recursive,
           replace_node,
-        );
-        matches.0
+        )
       }
     }
   }

polyglot_piranha-0.4.0/src/models/concrete_syntax/concrete_syntax.pest

@@ -0,0 +1,22 @@
+// Concrete Syntax Grammar for Piranha
+concrete_syntax = { SOI ~ pattern ~ EOI }
+pattern = { (element)+ ~ ("|>" ~ constraints)? }
+
+// An element is either a capture or literal text
+element = _{ capture | literal_text }
+
+// Captures: :[name], :[name+], :[name*], @name
+capture = { (":[" ~ identifier ~ capture_mode? ~ "]") | "@"~identifier } // FIXME: Should remove @ from the grammar, because literals may be parsed incorrectly
+capture_mode = { "+" | "*" }
+identifier = { (ASCII_ALPHA | "_") ~ (ASCII_ALPHANUMERIC | "_")* }
+
+// Literal text - single word/token without whitespace
+literal_text = { (!( ":[" | "|>" | "@" ) ~ ANY)+ }
+WHITESPACE = _{ (" " | "\t" | "\r" | "\n")+ }
+
+// Where constraints (extensible for future constraint types)
+constraints = { constraint ~ ("," ~ constraint)* }
+constraint = { in_constraint }
+in_constraint = { capture ~ "in" ~ "[" ~ list_items? ~ "]" }
+list_items = { quoted_string ~ ("," ~ quoted_string)* }
+quoted_string = { "\"" ~ ( "\\\\" | "\\\"" | (!"\"" ~ ANY) )* ~ "\"" }

polyglot_piranha-0.4.0/src/models/concrete_syntax/constraint_checker.rs

@@ -0,0 +1,29 @@
+/*
+ Copyright (c) 2023 Uber Technologies, Inc.
+
+ <p>Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
+ except in compliance with the License. You may obtain a copy of the License at
+ <p>http://www.apache.org/licenses/LICENSE-2.0
+
+ <p>Unless required by applicable law or agreed to in writing, software distributed under the
+ License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ express or implied. See the License for the specific language governing permissions and
+ limitations under the License.
+*/
+
+use crate::models::concrete_syntax::parser::CsConstraint;
+use crate::models::concrete_syntax::types::CapturedNode;
+
+/// Check if a captured node satisfies a single constraint
+pub(crate) fn check_constraint(node: &CapturedNode, ctr: &CsConstraint) -> bool {
+  match ctr {
+    CsConstraint::In { items, .. } => items.contains(&node.text.to_string()),
+  }
+}
+
+/// Check if a captured node satisfies all constraints
+pub(crate) fn satisfies_constraints(node: &CapturedNode, constraints: &[CsConstraint]) -> bool {
+  constraints
+    .iter()
+    .all(|constraint| check_constraint(node, constraint))
+}

polyglot_piranha-0.4.0/src/models/concrete_syntax/cursor_utils.rs

@@ -0,0 +1,66 @@
+/*
+ Copyright (c) 2023 Uber Technologies, Inc.
+
+ <p>Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
+ except in compliance with the License. You may obtain a copy of the License at
+ <p>http://www.apache.org/licenses/LICENSE-2.0
+
+ <p>Unless required by applicable law or agreed to in writing, software distributed under the
+ License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ express or implied. See the License for the specific language governing permissions and
+ limitations under the License.
+*/
+
+use crate::models::matches::Range;
+use tree_sitter::{Node, TreeCursor};
+
+/// Cursor navigation utilities for tree traversal during pattern matching.
+pub struct CursorNavigator;
+
+impl CursorNavigator {
+  /// Advances the cursor to the next sibling, or if no sibling exists,
+  /// moves up to the parent and tries to find the next sibling at that level.
+  pub fn find_next_sibling_or_ancestor_sibling(cursor: &mut TreeCursor) -> bool {
+    while !cursor.goto_next_sibling() {
+      if !cursor.goto_parent() {
+        return false;
+      }
+    }
+    true
+  }
+
+  /// Skips over comment nodes by advancing the cursor to the next non-comment sibling.
+  /// If the current node is not a comment, the cursor position remains unchanged.
+  pub fn skip_comment_nodes(cursor: &mut TreeCursor) {
+    let mut node = cursor.node();
+    while node.kind().contains("comment") && cursor.goto_next_sibling() {
+      node = cursor.node();
+    }
+  }
+
+  /// Finds the index of a target node among its parent's children.
+  pub fn find_child_index(target_node: &Node, parent_node: &Node) -> Option<usize> {
+    parent_node
+      .children(&mut parent_node.walk())
+      .enumerate()
+      .find(|&(_i, child)| child == *target_node)
+      .map(|(i, _child)| i)
+  }
+
+  /// Creates a range that spans from the start of the first node to the end of the second node.
+  pub fn span_node_ranges(first_node: &Node, last_node: &Node) -> Range {
+    Range::span_ranges(first_node.range(), last_node.range())
+  }
+
+  /// Extracts text from source code within the specified byte range.
+  pub fn get_text_from_range(start_byte: usize, end_byte: usize, source_code: &[u8]) -> String {
+    let text_slice = &source_code[start_byte..end_byte];
+    String::from_utf8_lossy(text_slice).to_string()
+  }
+}
+
+#[cfg(test)]
+mod tests {
+
+  // Tests will be added as we migrate functionality
+}