Emit version comment on generated files

Closes #72
decompals · Jul 14, 2024 · f494edc · f494edc
1 parent 5d65823
commit f494edc
Show file tree

Hide file tree

Showing 8 changed files with 76 additions and 11 deletions.
diff --git a/slinky-cli/src/main.rs b/slinky-cli/src/main.rs
@@ -26,6 +26,10 @@ struct Cli {
 
     #[arg(short = 'c', long, value_parser = parse_key_val::<String, String>, value_delimiter = ',')]
     custom_options: Vec<(String, String)>,
+
+    /// Disables the version comment emitted on linker scripts
+    #[arg(long)]
+    omit_version_comment: bool,
 }
 
 // Taken from https://github.com/clap-rs/clap/blob/f5965e586292d31b2a2cbd83f19d145180471012/examples/typed-derive.rs#L48
@@ -57,6 +61,8 @@ fn create_runtime_settings(cli: &Cli) -> RuntimeSettings {
 
     rs.add_custom_options(cli.custom_options.iter().cloned());
 
+    rs.set_emit_version_comment(!cli.omit_version_comment);
+
     rs
 }
 

diff --git a/slinky/src/lib.rs b/slinky/src/lib.rs
@@ -23,6 +23,8 @@ mod partial_linker_writer;
 
 mod runtime_settings;
 
+pub mod version;
+
 pub use error::SlinkyError;
 
 pub use linker_symbols_style::LinkerSymbolsStyle;

diff --git a/slinky/src/linker_writer.rs b/slinky/src/linker_writer.rs
@@ -5,7 +5,7 @@ use std::path::PathBuf;
 use std::{io::Write, path::Path};
 
 use crate::{file_kind::FileKind, SlinkyError};
-use crate::{utils, Document, RuntimeSettings, VramClass};
+use crate::{utils, version, Document, RuntimeSettings, VramClass};
 use crate::{FileInfo, Segment};
 
 use crate::script_buffer::ScriptBuffer;
@@ -36,8 +36,20 @@ impl<'a> LinkerWriter<'a> {
             vram_classes.insert(vram_class.name.clone(), vram_class.clone());
         }
 
+        let mut buffer = ScriptBuffer::new();
+
+        if rs.emit_version_comment() {
+            buffer.writeln(&format!(
+                "/* Generated by slinky {}.{}.{} */",
+                version::VERSION_MAJOR,
+                version::VERSION_MINOR,
+                version::VERSION_PATCH
+            ));
+            buffer.write_empty_line();
+        }
+
         Self {
-            buffer: ScriptBuffer::new(),
+            buffer,
 
             files_paths: indexmap::IndexSet::new(),
 
@@ -278,8 +290,6 @@ impl<'a> LinkerWriter<'a> {
     }
 
     pub fn add_single_segment(&mut self, segment: &Segment) -> Result<(), SlinkyError> {
-        assert!(self.buffer.is_empty());
-
         // Make sure this function is called only once
         assert!(!self.single_segment);
         self.single_segment = true;
@@ -348,6 +358,21 @@ impl LinkerWriter<'_> {
         dst: &mut impl Write,
         target_path: &Path,
     ) -> Result<(), SlinkyError> {
+        if self.rs.emit_version_comment() {
+            if let Err(e) = write!(
+                dst,
+                "# Generated by slinky {}.{}.{}\n\n",
+                version::VERSION_MAJOR,
+                version::VERSION_MINOR,
+                version::VERSION_PATCH
+            ) {
+                return Err(SlinkyError::FailedWrite {
+                    description: e.to_string(),
+                    contents: "Version comment".to_string(),
+                });
+            }
+        }
+
         let escaped_target_path = self.rs.escape_path(target_path)?;
         if let Err(e) = write!(dst, "{}:", escaped_target_path.display()) {
             return Err(SlinkyError::FailedWrite {
@@ -415,6 +440,21 @@ impl LinkerWriter<'_> {
 
 impl LinkerWriter<'_> {
     pub fn export_symbol_header(&self, dst: &mut impl Write) -> Result<(), SlinkyError> {
+        if self.rs.emit_version_comment() {
+            if let Err(e) = write!(
+                dst,
+                "/* Generated by slinky {}.{}.{} */\n\n",
+                version::VERSION_MAJOR,
+                version::VERSION_MINOR,
+                version::VERSION_PATCH
+            ) {
+                return Err(SlinkyError::FailedWrite {
+                    description: e.to_string(),
+                    contents: "Version comment".to_string(),
+                });
+            }
+        }
+
         if let Err(e) = write!(
             dst,
             "#ifndef HEADER_SYMBOLS_H\n#define HEADER_SYMBOLS_H\n\n"

diff --git a/slinky/src/runtime_settings.rs b/slinky/src/runtime_settings.rs
@@ -11,6 +11,8 @@ use crate::SlinkyError;
 #[derive(PartialEq, Debug)]
 pub struct RuntimeSettings {
     custom_options: HashMap<String, String>,
+
+    emit_version_comment: bool,
 }
 
 impl Default for RuntimeSettings {
@@ -23,6 +25,8 @@ impl RuntimeSettings {
     pub fn new() -> Self {
         Self {
             custom_options: HashMap::new(),
+
+            emit_version_comment: true,
         }
     }
 
@@ -36,6 +40,14 @@ impl RuntimeSettings {
     {
         self.custom_options.extend(others);
     }
+
+    pub fn emit_version_comment(&self) -> bool {
+        self.emit_version_comment
+    }
+
+    pub fn set_emit_version_comment(&mut self, emit: bool) {
+        self.emit_version_comment = emit;
+    }
 }
 
 impl RuntimeSettings {

diff --git a/slinky/src/script_buffer.rs b/slinky/src/script_buffer.rs
@@ -73,11 +73,6 @@ impl ScriptBuffer {
 }
 
 impl ScriptBuffer {
-    #[must_use]
-    pub fn is_empty(&self) -> bool {
-        self.buffer.is_empty()
-    }
-
     #[must_use]
     pub fn get_buffer(&self) -> &[String] {
         &self.buffer

diff --git a/slinky/src/version.rs b/slinky/src/version.rs
@@ -0,0 +1,8 @@
+/* SPDX-FileCopyrightText: © 2024 decompals */
+/* SPDX-License-Identifier: MIT */
+
+pub static VERSION_MAJOR: u32 = 0;
+pub static VERSION_MINOR: u32 = 1;
+pub static VERSION_PATCH: u32 = 0;
+
+pub static VERSION_TUPLE: (u32, u32, u32) = (VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH);
diff --git a/slinky/tests/integration_test.rs b/slinky/tests/integration_test.rs
@@ -16,6 +16,8 @@ fn create_runtime_settings() -> RuntimeSettings {
         ("compiler".into(), "modern_gcc".into()),
     ]);
 
+    rs.set_emit_version_comment(false);
+
     rs
 }
 

diff --git a/tests/regen_tests.sh b/tests/regen_tests.sh
@@ -13,13 +13,13 @@ for filepath in tests/test_cases/*.yaml; do
     stem="${filename%.*}"
     output=tests/test_cases/$stem.ld
     echo Generating $output
-    cargo run --release -- $filepath -o $output --custom-options version=us -c compiler=modern_gcc
+    cargo run --release -- $filepath -o $output --omit-version-comment --custom-options version=us -c compiler=modern_gcc
 done
 
 for filepath in tests/partial_linking/*.yaml; do
     filename=$(basename -- "$filepath")
     stem="${filename%.*}"
     output=tests/partial_linking/$stem.ld
     echo Generating $output
-    cargo run --release -- $filepath -o $output --partial-linking -c version=us -c compiler=modern_gcc
+    cargo run --release -- $filepath -o $output --omit-version-comment --partial-linking -c version=us -c compiler=modern_gcc
 done
-Original file line number
+Diff line change
@@ Expand Up / @@ -16,6 +16,8 @@ fn create_runtime_settings() -> RuntimeSettings { @@
             ("compiler".into(), "modern_gcc".into()),
         ]);
+        rs.set_emit_version_comment(false);
         rs
     }
@@ Expand Down @@