really-bad-compiler-in-haskell/README.md

Really Bad Compiler in Haskell

A compiler written in Haskell which can currently perform basic arithmetic. Currently using the megaparsec and llvm-hs-* libraries, but I plan to reimplement parsing and llvm generation myself. Built for the Introduction to Compiler Design class at The University of Texas at Dallas.

Main repo: https://git.sudoer.ch/me/really-bad-compiler-in-haskell

Build Instructions

• Install ghcup (for managing Haskell tools) and nix (for managing external dependencies).
• Clone the repo.
• Use ghcup to install stack 2.9.3, HLS 2.2.0.0, GHC 9.2.8, and cabal 3.6.2.0.
• Use stack run <file> to run the program (for example, stack run example/1).

To edit

I recommend using VSCodium, which is preconfigured to have syntax highlighting and (currently broken) debugging features and will automatically suggest the Haskell extensions to install.

Known bugs

Building

• If llvm_16 is in the nix store, stack will use it for some reason and the build will fail. Currently, you may need to run nix-store --delete /nix/store/<llvm16devdirectory> to build it.

File structure

• app - contains the compiler program
• example - contains example programs that can be compiled

Credits

Learning Resources Used

• Introduction to Compiler Design class at The University of Texas at Dallas, taught by Charles Averill
• https://learnyouahaskell.com (for learning Haskell basics)
• https://akashagrawal.me/2017/01/19/beginners-guide-to-megaparsec.html
• https://markkarpov.com/tutorial/megaparsec.html (for help writing a Haskell equation parser using megaparsec)
• https://www.forth.com/starting-forth/1-forth-stacks-dictionary/ (for learning Forth)
• https://blog.josephmorag.com/posts/mcc0/ (Haskell compiler tutorial with megaparsec, llvm-hs, and nix)
• https://gh.sudoer.ch/llvm-hs/llvm-hs-examples (for help writing an llvm code generator using llvm-hs)
• https://danieljharvey.github.io/posts/2023-02-08-llvm-compiler-part-1.html (for help using llvm-hs-pure)
• https://gh.sudoer.ch/danieljharvey/mimsa/blob/trunk/llvm-calc/src/Calc/Compile/ToLLVM.hs (source code for above resource)
• https://9to5tutorial.com/homebrew-compiler-made-with-haskell-llvm-configuration (for help using llvm-hs-pure)

Tools

• Language: Haskell
• Haskell tools: GHCup, Stack, Cabal, GHC 9.2
• Libraries: megaparsec, parser-combinators, text, process, llvm-hs 15, llvm-hs-pure 15,
• Dependencies: llvm 15, clang 15
• IDE: VSCodium
• Git platform: Forgejo
• AI: Phind (GPT-4), ollama (codellama)
• Search: Kagi, Stack Overflow