A simple compiler project written in Go, demonstrating the process of tokenizing, parsing, and generating code for a minimal language. This project is educational and showcases the basics of building a compiler pipeline. 🛠️

Do not use this, it is only tested with the example.in file and doesn't even generate completely correct code there!

• Tokenization: Converts source code into tokens. 🏷️
• Parsing: Builds an abstract representation (operations) from tokens. 🌳
• Code Generation: Outputs code in SSA and QBE formats. ⚙️
• Command-line Options: Control output and execution via flags. 🖥️
• Example Input: See example.in for a sample program. 📄

• 📦 cmd/cubit/main.go - Entry point, handles CLI flags and orchestrates compilation.
• 📁 lexer/ - Contains the lexer package:
  • 📄 tokenizer.go - Tokenizes the input source code.
  • 📄 scanner.go - Reads and manages input data for tokenization.
• 📁 parser/ - Contains the parser package:
  • 📄 parser.go - Parses tokens into AST.
• 📁 codegen/ - Contains code generation logic:
  • 📄 generator.go - Generates code (ASM/Executable) from QBE IR code.
  • 📄 ssa_visitor.go - Generate QBE IR from the AST using visitor pattern.
• 📁 ast/ - Contains the AST package:
  • 📄 ast.go - AST structures and attribute logic.
• 📁 examples/ - Contains various example programs.
• 📄 go.mod / go.sum - Go module files and dependencies.

The provided example.in:

package main

// Declare an external function
@(extern)
printf :: func(msg: string, arg: int)

// Define a function that calls printf
hello :: func(arg: int) {
  printf("Hello from compiler-%d!\n", arg)
}

// Export the main function
@(export)
main :: func() -> int {
  // Type of count is inferred as int
  count := 11 + 22

  hello(count)

  return 0
}

go run ./cmd/cubit [options]

• -tok : Write tokens to file (out/example.tok)
• -ssa : Write SSA code to file (out/example.ssa)
• -run : Run the compiled code
• -help : Show help message

• Go 1.24
• C-compiler (cc) to compile the generated assembly

1. Clone the repository.
2. Run go mod tidy to install dependencies.
3. Use go run ./cmd/cubit -run to compile and run the example file.
4. Use ./test.sh to run the unit tests and example programs.

Happy compiling! 🎉