[feature] added fixed-body-comment-indent for lc3fmt

Author: robcholz

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "lc3-toolchain"
-version = "0.3.0"
+version = "0.3.1"
 edition = "2024"
 description = "Toolchain for LC-3 Assembly Code, designed for ECE109 Spring 2025"
 authors = ["Finn Sheng@NCState Class of 2028"]

Cargo.toml

@@ -1,6 +1,6 @@
 # lc3-toolchain
 
-![Version](https://img.shields.io/badge/version-0.3.0-blue)
+![Version](https://img.shields.io/badge/version-0.3.1-blue)
 ![Edition](https://img.shields.io/badge/edition-2024-orange)
 
 LC-3 Assembly Toolchain, designed for ECE109 Spring 2025.

README.md

@@ -58,4 +58,5 @@ space-comment-stick-to-body = 0
 space-from-label-block = 1
 space-from-start-end-block = 1
 colon-after-label = true
+fixed-body-comment-indent = true
 ```

src/bin/fmt.md

@@ -166,6 +166,7 @@ const DEFAULT_STYLE: FormatStyle = FormatStyle {
     space_from_label_block: 1,
     space_from_start_end_block: 1,
     colon_after_label: true,
+    fixed_body_comment_indent: true,
 };
 
 const CONFIG_FILENAME: &str = "lc3-format.toml";
@@ -271,6 +272,7 @@ pub struct ConfigFormatStyle {
     pub space_from_label_block: Option<u8>,
     pub space_from_start_end_block: Option<u8>,
     pub colon_after_label: Option<bool>,
+    pub fixed_body_comment_indent: Option<bool>,
 }
 
 fn read_style(filepath_opt: Option<PathBuf>) -> FormatStyle {
@@ -344,6 +346,9 @@ fn config_format_style_to_format_style(
         colon_after_label: config_format_style
             .colon_after_label
             .unwrap_or(default.colon_after_label),
+        fixed_body_comment_indent: config_format_style
+            .fixed_body_comment_indent
+            .unwrap_or(default.fixed_body_comment_indent),
     }
 }
 

src/bin/fmt.rs

@@ -22,6 +22,7 @@ pub struct FormatStyle {
     pub space_from_label_block: u8,        // vertical //done
     pub space_from_start_end_block: u8,    // vertical  // done
     pub colon_after_label: bool,
+    pub fixed_body_comment_indent: bool,
 }
 
 pub struct Formatter<'a> {
@@ -65,7 +66,12 @@ impl<'a> Formatter<'a> {
                 .for_each(|e| label.push_str(e.as_str()));
             self.buffer.append(&mut label.into_bytes());
             self.buffer.append(&mut body.into_bytes());
-            self.add_indent(missing_indent);
+            self.add_indent(
+                self.style
+                    .fixed_body_comment_indent
+                    .then_some(missing_indent)
+                    .unwrap_or(1), // default indent between block and comment
+            );
             match comment {
                 None => {}
                 Some(comment) => {

src/fmt/formatter.rs

@@ -0,0 +1,26 @@
+;LC-3 Assembly Test File 
+;This program adds two numbers stored in memory 
+.ORIG x3000 
+
+    LD R1, NUM1 ;Load first number into R1
+    LD R2, NUM2 ;Load second number into R2
+    ADD R3, R1, R2 ;Add R1 and R2, store in R3
+    ST R3, RESULT ;Store result in memory
+    HALT ;Stop execution
+
+input:
+   .FILL x0005 ;First number (5)
+in_asd:
+   .FILL x0003 ;Second number (3)
+br_:
+   .FILL x0003 ;Second number (3)
+brnzp_:
+   .FILL x0003 ;Second number (3)
+br1:
+   .FILL x0003 ;Second number (3)
+l:
+   .BLKW 1 ;Reserve space for result
+b1:
+   .BLKW 1 ;Reserve space for result
+
+.END 

test/data/expected/fmt/flexible_comment_indent.asm

@@ -0,0 +1,26 @@
+;LC-3 Assembly Test File
+;This program adds two numbers stored in memory
+.ORIG x3000
+
+    LD R1, NUM1                                 ;Load first number into R1
+    LD R2, NUM2                                 ;Load second number into R2
+    ADD R3, R1, R2                              ;Add R1 and R2, store in R3
+    ST R3, RESULT                               ;Store result in memory
+    HALT                                        ;Stop execution
+
+input:
+   .FILL x0005                                  ;First number (5)
+in_asd:
+   .FILL x0003                                  ;Second number (3)
+br_:
+   .FILL x0003                                  ;Second number (3)
+brnzp_:
+   .FILL x0003                                  ;Second number (3)
+br1:
+   .FILL x0003                                  ;Second number (3)
+l:
+   .BLKW 1                                      ;Reserve space for result
+b1:
+   .BLKW 1                                      ;Reserve space for result
+
+.END

test/data/source/fmt/flexible_comment_indent.asm

@@ -19,6 +19,7 @@ mod test_fmt {
         space_from_label_block: 1,
         space_from_start_end_block: 1,
         colon_after_label: true,
+        fixed_body_comment_indent: true,
     };
 
     const NO_COLON_STYLE: FormatStyle = FormatStyle {
@@ -31,6 +32,20 @@ mod test_fmt {
         space_from_label_block: 1,
         space_from_start_end_block: 1,
         colon_after_label: false,
+        fixed_body_comment_indent: true,
+    };
+
+    const FLEXIBLE_BODY_COMMENT_INDENT: FormatStyle = FormatStyle {
+        indent_directive: 3,
+        indent_instruction: 4,
+        indent_label: 0,
+        indent_min_comment_from_block: 1,
+        space_block_to_comment: 1,
+        space_comment_stick_to_body: 0,
+        space_from_label_block: 1,
+        space_from_start_end_block: 1,
+        colon_after_label: true,
+        fixed_body_comment_indent: false,
     };
 
     fn assert_true(style: &FormatStyle, path: &'static str) {
@@ -108,4 +123,12 @@ mod test_fmt {
     fn test_no_colon_labels() {
         assert_true(&NO_COLON_STYLE, "fmt/no_colon_labels.asm")
     }
+
+    #[test]
+    fn test_flexible_block_comment_indent() {
+        assert_true(
+            &FLEXIBLE_BODY_COMMENT_INDENT,
+            "fmt/flexible_comment_indent.asm",
+        )
+    }
 }