Sync

Eforen · Sep 8, 2023 · 1b78fb3 · 1b78fb3
1 parent b14040d
commit 1b78fb3
Show file tree

Hide file tree

Showing 23 changed files with 736 additions and 120 deletions.
diff --git a/src/Kore.AST/AstNode.cs b/src/Kore.AST/AstNode.cs
@@ -1,5 +1,9 @@
-namespace Kore.AST {
+using System.Text;
+
+namespace Kore.AST {
     public abstract class AstNode {
+        public const int DEBUG_INDENT_COUNT = 4;
+        public const int DEBUG_LINE_NUMBER_LEN = 5;
         public int lineNumber = -1;
         public abstract AstNode CallProcessor(ASTProcessor processor);
 
@@ -14,5 +18,18 @@ public abstract class AstNode {
         public override int GetHashCode() {
             return lineNumber.GetHashCode();
         }
+
+        public string getDebugText() {
+            return getDebugText(0, new StringBuilder()).ToString();
+        }
+        protected StringBuilder addDebugTextHeader(int indentLevel, StringBuilder builder) {
+            return addDebugTextHeader(lineNumber, indentLevel, builder);
+        }
+        protected StringBuilder addDebugTextHeader(int lineNumberOverride, int indentLevel, StringBuilder builder) {
+            if(lineNumberOverride < 0) return builder.Append(' ', DEBUG_LINE_NUMBER_LEN+1).Append(' ', indentLevel * DEBUG_INDENT_COUNT);
+            return builder.Append(lineNumberOverride.ToString().PadLeft(DEBUG_LINE_NUMBER_LEN, '0')).Append(':').Append(' ', indentLevel * DEBUG_INDENT_COUNT);
+        }
+
+        public abstract StringBuilder getDebugText(int indentLevel, StringBuilder builder);
     }
 }
diff --git a/src/Kore.AST/CommentNode.cs b/src/Kore.AST/CommentNode.cs
@@ -1,4 +1,6 @@
-namespace Kore.AST {
+using System.Text;
+
+namespace Kore.AST {
 
     /// <summary>
     /// Node representing a comment in the assembly code.
@@ -29,5 +31,9 @@ public class CommentNode : AstNode {
         public override int GetHashCode() {
             return Text.GetHashCode();
         }
+
+        public override StringBuilder getDebugText(int indentLevel, StringBuilder builder) {
+            return addDebugTextHeader(indentLevel, builder).AppendLine($"COMMENT {Text}");
+        }
     }
 }
diff --git a/src/Kore.AST/DirectiveNode.cs b/src/Kore.AST/DirectiveNode.cs
@@ -39,5 +39,9 @@ public class DirectiveNode : AstNode {
         public override int GetHashCode() {
             return Name.GetHashCode();
         }
+
+        public override StringBuilder getDebugText(int indentLevel, StringBuilder builder) {
+            return addDebugTextHeader(indentLevel, builder).AppendLine($"DIRECTIVE {Name}");
+        }
     }
 }
diff --git a/src/Kore.AST/InlineDirectiveNode.cs b/src/Kore.AST/InlineDirectiveNode.cs
@@ -85,5 +85,9 @@ public enum InlineDirectiveType {
         public override int GetHashCode() {
             return Name.GetHashCode();
         }
+
+        public override StringBuilder getDebugText(int indentLevel, StringBuilder builder) {
+            return addDebugTextHeader(indentLevel, builder).AppendLine($"INLINE DIRECTIVE {Name}");
+        }
     }
 }
diff --git a/src/Kore.AST/InstructionNodeTypeB.cs b/src/Kore.AST/InstructionNodeTypeB.cs
@@ -1,4 +1,5 @@
 using Kore.RiscMeta;
+using System.Text;
 
 namespace Kore.AST {
     /// <summary>
@@ -48,9 +49,14 @@ public InstructionNodeTypeBImmediate(Kore.RiscMeta.Instructions.TypeB op, Regist
                 return hash;
             }
         }
+
+        public override StringBuilder getDebugText(int indentLevel, StringBuilder builder) {
+            return addDebugTextHeader(indentLevel, builder).Append($"TypeB {op} RS1:{rs1} RS2:{rs2} IMM:{imm}");
+        }
     }
     /// <summary>
     /// Represents a B-Type RISC-V instruction.
+    /// TODO: This should likely be changed to the wrapper type of instruction so that we don't have this redundency
     /// </summary>
     public class InstructionNodeTypeBLabel : InstructionNode<Kore.RiscMeta.Instructions.TypeB> {
         /// <summary>
@@ -96,5 +102,9 @@ public InstructionNodeTypeBLabel(Kore.RiscMeta.Instructions.TypeB op, Register r
                 return hash;
             }
         }
+
+        public override StringBuilder getDebugText(int indentLevel, StringBuilder builder) {
+            return addDebugTextHeader(indentLevel, builder).AppendLine($"TypeB {op} RS1:{rs1} RS2:{rs2} LABEL:{label}");
+        }
     }
 }
diff --git a/src/Kore.AST/InstructionNodeTypeI.cs b/src/Kore.AST/InstructionNodeTypeI.cs
@@ -53,5 +53,9 @@ public InstructionNodeTypeI(Kore.RiscMeta.Instructions.TypeI op, Register rd, Re
                 return hash;
             }
         }
+
+        public override StringBuilder getDebugText(int indentLevel, StringBuilder builder) {
+            return addDebugTextHeader(indentLevel, builder).AppendLine($"TypeI {op} RD:{rd} RS:{rs} IMM:{immediate}");
+        }
     }
 }
diff --git a/src/Kore.AST/InstructionNodeTypeJ.cs b/src/Kore.AST/InstructionNodeTypeJ.cs
@@ -1,4 +1,5 @@
 using Kore.RiscMeta;
+using System.Text;
 
 namespace Kore.AST {
     /// <summary>
@@ -40,9 +41,14 @@ public class InstructionNodeTypeJImmediate : InstructionNode<Kore.RiscMeta.Instr
                 return hash;
             }
         }
+
+        public override StringBuilder getDebugText(int indentLevel, StringBuilder builder) {
+            return addDebugTextHeader(indentLevel, builder).Append($"TypeJ {op} RD:{rd} IMM:{imm}");
+        }
     }
     /// <summary>
     /// Represents a J-type instruction in the RISC-V assembly language.
+    /// TODO: This should likely be changed to the wrapper type of instruction so that we don't have this redundency
     /// </summary>
     public class InstructionNodeTypeJLabel : InstructionNode<Kore.RiscMeta.Instructions.TypeJ> {
         /// <summary>
@@ -80,6 +86,10 @@ public class InstructionNodeTypeJLabel : InstructionNode<Kore.RiscMeta.Instructi
                 return hash;
             }
         }
+
+        public override StringBuilder getDebugText(int indentLevel, StringBuilder builder) {
+            return addDebugTextHeader(indentLevel, builder).AppendLine($"TypeJ {op} RD:{rd} LABEL:{label}");
+        }
     }
 }
 
diff --git a/src/Kore.AST/InstructionNodeTypeMisc.cs b/src/Kore.AST/InstructionNodeTypeMisc.cs
@@ -1,4 +1,6 @@
-namespace Kore.AST {
+using System.Text;
+
+namespace Kore.AST {
     /// <summary>
     /// Represents a miscellaneous instruction in the RISC-V assembly language.
     /// </summary>
@@ -20,5 +22,9 @@ public class InstructionNodeTypeMisc : InstructionNode<string> {
         public override int GetHashCode() {
             return op.GetHashCode();
         }
+
+        public override StringBuilder getDebugText(int indentLevel, StringBuilder builder) {
+            return addDebugTextHeader(indentLevel, builder).AppendLine($"TypeMisc {op}");
+        }
     }
 }
diff --git a/src/Kore.AST/InstructionNodeTypeR.cs b/src/Kore.AST/InstructionNodeTypeR.cs
@@ -1,5 +1,6 @@
 using Kore.RiscMeta;
 using Kore.RiscMeta.Instructions;
+using System.Text;
 
 namespace Kore.AST {
     /// <summary>
@@ -48,5 +49,9 @@ public class InstructionNodeTypeR : InstructionNode<Kore.RiscMeta.Instructions.T
                 return hash;
             }
         }
+
+        public override StringBuilder getDebugText(int indentLevel, StringBuilder builder) {
+            return addDebugTextHeader(indentLevel, builder).AppendLine($"TypeR {op} RD:{rd} RS1:{rs1} RS2:{rs2}");
+        }
     }
 }
diff --git a/src/Kore.AST/InstructionNodeTypeS.cs b/src/Kore.AST/InstructionNodeTypeS.cs
@@ -52,5 +52,9 @@ public class InstructionNodeTypeS : InstructionNode<Kore.RiscMeta.Instructions.T
                 return hash;
             }
         }
+
+        public override StringBuilder getDebugText(int indentLevel, StringBuilder builder) {
+            return addDebugTextHeader(indentLevel, builder).AppendLine($"TypeS {op} RS1:{rs1} RS2:{rs2} IMM:{imm}");
+        }
     }
 }
diff --git a/src/Kore.AST/InstructionNodeTypeU.cs b/src/Kore.AST/InstructionNodeTypeU.cs
@@ -45,5 +45,9 @@ public class InstructionNodeTypeU : InstructionNode<Kore.RiscMeta.Instructions.T
                 return hash;
             }
         }
+
+        public override StringBuilder getDebugText(int indentLevel, StringBuilder builder) {
+            return addDebugTextHeader(indentLevel, builder).AppendLine($"TypeB {op} RD:{rd} IMM:{imm}");
+        }
     }
 }
diff --git a/src/Kore.AST/IntDirectiveNode.cs b/src/Kore.AST/IntDirectiveNode.cs
@@ -44,5 +44,9 @@ public class IntDirectiveNode : DirectiveNode {
                 return hash;
             }
         }
+
+        public override StringBuilder getDebugText(int indentLevel, StringBuilder builder) {
+            return addDebugTextHeader(indentLevel, builder).AppendLine($"DIRECTIVE {Name} INT:{Value}");
+        }
     }
 }
diff --git a/src/Kore.AST/LabelNode.cs b/src/Kore.AST/LabelNode.cs
@@ -1,4 +1,6 @@
-namespace Kore.AST {
+using System.Text;
+
+namespace Kore.AST {
 
     /// <summary>
     /// Node representing a label in the assembly code.
@@ -29,5 +31,9 @@ public class LabelNode : AstNode {
         public override int GetHashCode() {
             return Name.GetHashCode();
         }
+
+        public override StringBuilder getDebugText(int indentLevel, StringBuilder builder) {
+            return addDebugTextHeader(indentLevel, builder).AppendLine($"LABEL {Name}");
+        }
     }
 }
diff --git a/src/Kore.AST/LabeledInlineDirectiveNode.cs b/src/Kore.AST/LabeledInlineDirectiveNode.cs
@@ -29,6 +29,10 @@ public class LabeledInlineDirectiveNode : InlineDirectiveNode {
                 return hash;
             }
         }
+
+        public override StringBuilder getDebugText(int indentLevel, StringBuilder builder) {
+            return addDebugTextHeader(indentLevel, builder).Append($"INLINE DIRECTIVE {Name} LABEL:{Label}");
+        }
     }
     public class LabeledInlineDirectiveNode<T> : LabeledInlineDirectiveNode where T : InstructionNode {
         /// <summary>
@@ -54,5 +58,11 @@ public class LabeledInlineDirectiveNode<T> : LabeledInlineDirectiveNode where T
                 return hash;
             }
         }
+
+        public override StringBuilder getDebugText(int indentLevel, StringBuilder builder) {
+            addDebugTextHeader(indentLevel, builder).AppendLine($"INLINE DIRECTIVE {Name} LABEL:{Label} {{");
+            WrappedInstruction.getDebugText(indentLevel + 1, builder);
+            return addDebugTextHeader(indentLevel, builder).AppendLine("}");
+        }
     }
 }
diff --git a/src/Kore.AST/ProgramNode.cs b/src/Kore.AST/ProgramNode.cs
@@ -1,4 +1,6 @@
 using System.Collections.Generic;
+using System.Text;
+
 namespace Kore.AST {
     /// <summary>
     /// The root node of the AST, representing a RISC-V program.
@@ -40,6 +42,14 @@ public class ProgramNode : AstNode {
             Sections.GetHashCode();
             return base.GetHashCode();
         }
+
+        public override StringBuilder getDebugText(int indentLevel, StringBuilder builder) {
+            addDebugTextHeader(indentLevel, builder).AppendLine($"PROGRAM [{Sections.Count}]{{");
+            foreach(var section in Sections) {
+                section.getDebugText(indentLevel+1, builder);
+            }
+            return addDebugTextHeader(indentLevel, builder).AppendLine("}");
+        }
     }
 }
 
diff --git a/src/Kore.AST/SectionNode.cs b/src/Kore.AST/SectionNode.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Text;
 
 namespace Kore.AST {
     /// <summary>
@@ -54,6 +55,14 @@ public class SectionNode : AstNode {
 
             return hash;
         }
+
+        public override StringBuilder getDebugText(int indentLevel, StringBuilder builder) {
+            addDebugTextHeader(indentLevel, builder).AppendLine($"SECTION {Name} [{Contents.Count}]{{");
+            foreach(var node in Contents) {
+                node.getDebugText(indentLevel + 1, builder);
+            }
+            return addDebugTextHeader(indentLevel, builder).AppendLine("}");
+        }
     }
 }
 
diff --git a/src/Kore.AST/StringDirectiveNode.cs b/src/Kore.AST/StringDirectiveNode.cs
@@ -43,5 +43,9 @@ public class StringDirectiveNode : DirectiveNode {
                 return hash;
             }
         }
+
+        public override StringBuilder getDebugText(int indentLevel, StringBuilder builder) {
+            return addDebugTextHeader(indentLevel, builder).AppendLine($"DIRECTIVE {Name} STRING:{Value}");
+        }
     }
 }
diff --git a/src/Kore.Kuick.Tests/Lexer/LexerTests.cs b/src/Kore.Kuick.Tests/Lexer/LexerTests.cs
@@ -699,10 +699,10 @@ public class LexerTests {
         [TestCase("s9", Lexer.Token.REGISTER, "x25")]
         [TestCase("s10", Lexer.Token.REGISTER, "x26")]
         [TestCase("s11", Lexer.Token.REGISTER, "x27")]
-        [TestCase("s12", Lexer.Token.REGISTER, "x28")]
-        [TestCase("t04", Lexer.Token.REGISTER, "x29")]
-        [TestCase("t05", Lexer.Token.REGISTER, "x30")]
-        [TestCase("t06", Lexer.Token.REGISTER, "x31")]
+        [TestCase("t3", Lexer.Token.REGISTER, "x28")]
+        [TestCase("t4", Lexer.Token.REGISTER, "x29")]
+        [TestCase("t5", Lexer.Token.REGISTER, "x30")]
+        [TestCase("t6", Lexer.Token.REGISTER, "x31")]
         [TestCase("s01", Lexer.Token.REGISTER, "x9")]
         [TestCase("a00", Lexer.Token.REGISTER, "x10")]
         [TestCase("a01", Lexer.Token.REGISTER, "x11")]
@@ -720,6 +720,7 @@ public class LexerTests {
         [TestCase("s07", Lexer.Token.REGISTER, "x23")]
         [TestCase("s08", Lexer.Token.REGISTER, "x24")]
         [TestCase("s09", Lexer.Token.REGISTER, "x25")]
+        [TestCase("t03", Lexer.Token.REGISTER, "x28")]
         [TestCase("t04", Lexer.Token.REGISTER, "x29")]
         [TestCase("t05", Lexer.Token.REGISTER, "x30")]
         [TestCase("t06", Lexer.Token.REGISTER, "x31")]