Move GDScript templating logic to repo-tweak, too

Author: Bromeon

itest/repo-tweak/Cargo.toml

@@ -2,6 +2,8 @@
 name = "repo-tweak"
 version = "0.1.0"
 edition = "2021"
+rust-version = "1.78"
+license = "MPL-2.0"
 publish = false
 
-[dependencies]
+# Note: this acts as both library and binary.

itest/repo-tweak/src/lib.rs

@@ -0,0 +1,96 @@
+/*
+ * Copyright (c) godot-rust; Bromeon and contributors.
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
+
+use std::collections::HashMap;
+
+#[derive(Debug)]
+pub struct Match {
+    /// Position before pattern start marker.
+    pub before_start: usize,
+
+    /// Position at the beginning of the repetition (after marker + keys).
+    pub start: usize,
+
+    /// Position 1 past the end of the repetition.
+    pub end: usize,
+
+    /// Position after the end pattern marker.
+    pub after_end: usize,
+
+    /// Extra keys following the start pattern marker.
+    pub key_values: HashMap<String, String>,
+}
+
+pub fn find_repeated_ranges(
+    entire: &str,
+    start_pat: &str,
+    end_pat: &str,
+    keys: &[&str],
+    retain_end_pat: bool,
+) -> Vec<Match> {
+    let mut search_start = 0;
+    let mut found = vec![];
+
+    while let Some(start) = entire[search_start..].find(start_pat) {
+        let before_start = search_start + start;
+        let start = before_start + start_pat.len();
+
+        let mut key_values = HashMap::new();
+
+        let Some(end) = entire[start..].find(end_pat) else {
+            panic!("unmatched start pattern '{start_pat}' without end");
+        };
+
+        let end = start + end;
+        let end = if retain_end_pat {
+            // Rewind until previous newline.
+            entire[..end + 1].rfind('\n').unwrap_or(end)
+        } else {
+            end
+        };
+
+        let after_end = end + end_pat.len();
+
+        let within = &entire[start..end];
+        println!("Within: <<{within}>>");
+
+        let mut after_keys = start;
+        for key in keys {
+            let key_fmt = format!("[{key}] ");
+
+            println!("  Find '{key_fmt}' -> {:?}", within.find(&key_fmt));
+
+            let Some(pos) = within.find(&key_fmt) else {
+                continue;
+            };
+
+            let pos = pos + key_fmt.len();
+
+            // Read until end of line -> that's the value.
+            let eol = within[pos..]
+                .find(['\n', '\r'])
+                .expect("unterminated line for key");
+
+            let value = &within[pos..pos + eol];
+            key_values.insert(key.to_string(), value.to_string());
+
+            after_keys = after_keys.max(start + pos + eol);
+        }
+
+        println!("Found {start}..{end}");
+        found.push(Match {
+            before_start,
+            start: after_keys,
+            end,
+            after_end,
+            key_values,
+        });
+        search_start = after_end;
+    }
+
+    found
+}

itest/repo-tweak/src/main.rs

@@ -10,6 +10,7 @@ use std::fs::File;
 use std::io::Write;
 use std::path::Path;
 
+// Manual input.
 #[rustfmt::skip]
 pub const GODOT_LATEST_PATCH_VERSIONS: &[&str] = &[
     "4.0.4",
@@ -20,6 +21,11 @@ pub const GODOT_LATEST_PATCH_VERSIONS: &[&str] = &[
 
 // ----------------------------------------------------------------------------------------------------------------------------------------------
 
+// Use lib.rs as module; so we don't need another crate just for that.
+// Lint #[allow(special_module_name)] is broken, thus rename.
+#[path = "lib.rs"]
+mod library;
+
 fn main() {
     let workspace_dir = Path::new(concat!(env!("CARGO_MANIFEST_DIR"), "/../.."));
     sync_versions_recursive(workspace_dir, true);
@@ -55,7 +61,8 @@ fn sync_versions_recursive(parent_dir: &Path, top_level: bool) {
             let content = std::fs::read_to_string(&path).expect("read file");
 
             let keys = ["repeat", "fmt", "pre", "post"];
-            let ranges = find_repeated_ranges(&content, "[version-sync] [[", "]]", &keys);
+            let ranges =
+                library::find_repeated_ranges(&content, "[version-sync] [[", "]]", &keys, true);
 
             let mut last_pos = 0;
             if !ranges.is_empty() {
@@ -173,78 +180,8 @@ fn substitute_template(
 }
 
 fn apply_char_substitutions(s: &str) -> String {
-    s.replace("\\t", "\t").replace("\\n", "\n")
-}
-
-fn find_repeated_ranges(entire: &str, start_pat: &str, end_pat: &str, keys: &[&str]) -> Vec<Match> {
-    let mut search_start = 0;
-    let mut found = vec![];
-
-    while let Some(start) = entire[search_start..].find(start_pat) {
-        let before_start = search_start + start;
-        let start = before_start + start_pat.len();
-
-        let mut key_values = HashMap::new();
-
-        let Some(end) = entire[start..].find(end_pat) else {
-            panic!("unmatched start pattern '{start_pat}' without end");
-        };
-
-        let end = start + end;
-        // Rewind until previous newline.
-        let end = entire[..end].rfind('\n').unwrap_or(end);
-        let after_end = end + end_pat.len();
-        let within = &entire[start..end];
-
-        let mut after_keys = start;
-        for key in keys {
-            let key_fmt = format!("[{key}] ");
-
-            println!("  Find '{key_fmt}' -> {:?}", within.find(&key_fmt));
-
-            let Some(pos) = within.find(&key_fmt) else {
-                continue;
-            };
-
-            let pos = pos + key_fmt.len();
-
-            // Read until end of line -> that's the value.
-            let eol = within[pos..]
-                .find(&['\n', '\r'])
-                .expect("unterminated line for key");
-
-            let value = &within[pos..pos + eol];
-            key_values.insert(key.to_string(), value.to_string());
-
-            after_keys = after_keys.max(start + pos + eol);
-        }
-
-        println!("Found {start}..{end}");
-        found.push(Match {
-            before_start,
-            start: after_keys,
-            end,
-            after_end,
-            key_values,
-        });
-        search_start = after_end;
-    }
-
-    found
-}
-
-#[derive(Debug)]
-struct Match {
-    /// Position before pattern start marker.
-    before_start: usize,
-    /// Position at the beginning of the repetition (after marker + keys).
-    start: usize,
-    /// Position 1 past the end of the repetition.
-    end: usize,
-    /// Position after the end pattern marker.
-    after_end: usize,
-    /// Extra keys following the start pattern marker.
-    key_values: HashMap<String, String>,
+    s.replace("\\t", "    ") // Not \t due to rustfmt.
+        .replace("\\n", "\n")
 }
 
 fn latest_patch_versions() -> Vec<(u8, u8)> {

itest/rust/Cargo.toml

@@ -25,6 +25,8 @@ serde_json = { version = "1.0", optional = true }
 
 [build-dependencies]
 godot-bindings = { path = "../../godot-bindings" } # emit_godot_version_cfg
+repo-tweak = { path = "../repo-tweak" }
+
 # Minimum versions compatible with -Zminimal-versions
 proc-macro2 = "1.0.63"
 quote = "1.0.29"

itest/rust/build.rs

@@ -7,7 +7,6 @@
 
 use proc_macro2::TokenStream;
 use quote::{format_ident, quote};
-use std::collections::HashMap;
 use std::io::Write;
 use std::path::Path;
 
@@ -561,7 +560,7 @@ fn write_gdscript_code(
     // let (mut last_start, mut prev_end) = (0, 0);
     let mut last = 0;
 
-    let ranges = find_repeated_ranges(&template, "#(", "#)", &[]);
+    let ranges = repo_tweak::find_repeated_ranges(&template, "#(", "#)", &[], false);
     for m in ranges {
         file.write_all(template[last..m.before_start].as_bytes())?;
 
@@ -600,80 +599,3 @@ fn replace_parts(
 
     Ok(())
 }
-
-// FIXME deduplicate
-fn find_repeated_ranges(entire: &str, start_pat: &str, end_pat: &str, keys: &[&str]) -> Vec<Match> {
-    let mut search_start = 0;
-    let mut found = vec![];
-
-    while let Some(start) = entire[search_start..].find(start_pat) {
-        let before_start = search_start + start;
-        let start = before_start + start_pat.len();
-
-        let mut key_values = HashMap::new();
-
-        let Some(end) = entire[start..].find(end_pat) else {
-            panic!("unmatched start pattern '{start_pat}' without end");
-        };
-
-        let end = start + end;
-        // Rewind until previous newline.
-        let end = entire[..end].rfind('\n').unwrap_or(end);
-
-        let after_end = end + end_pat.len();
-
-        let within = &entire[start..end];
-        println!("Within: <<{within}>>");
-
-        let mut after_keys = start;
-        for key in keys {
-            let key_fmt = format!("[{key}] ");
-
-            println!("  Find '{key_fmt}' -> {:?}", within.find(&key_fmt));
-
-            let Some(pos) = within.find(&key_fmt) else {
-                continue;
-            };
-
-            let pos = pos + key_fmt.len();
-
-            // Read until end of line -> that's the value.
-            let eol = within[pos..]
-                .find(&['\n', '\r'])
-                .expect("unterminated line for key");
-
-            let value = &within[pos..pos + eol];
-            key_values.insert(key.to_string(), value.to_string());
-
-            after_keys = after_keys.max(start + pos + eol);
-        }
-
-        println!("Found {start}..{end}");
-        found.push(Match {
-            before_start,
-            start: after_keys,
-            end,
-            after_end,
-            key_values,
-        });
-        search_start = after_end;
-    }
-
-    found
-}
-
-// FIXME deduplicate
-#[derive(Debug)]
-struct Match {
-    /// Position before pattern start marker.
-    before_start: usize,
-    /// Position at the beginning of the repetition (after marker + keys).
-    start: usize,
-    /// Position 1 past the end of the repetition.
-    end: usize,
-    /// Position after the end pattern marker.
-    after_end: usize,
-    /// Extra keys following the start pattern marker.
-    #[allow(dead_code)]
-    key_values: HashMap<String, String>,
-}