Archived

A HEAR (C-like) compiler written in Haskell

This repository has been archived on 2024-04-05. You can view files and clone it, but cannot push or open issues/pull-requests.

Go to file

Ethan Reece 9f9642347b Start new LLVM generator using IRBuilder		2023-09-23 23:15:11 -05:00
example	Add example programs	2023-09-11 12:04:36 -05:00
main	Start new LLVM generator using IRBuilder	2023-09-23 23:15:11 -05:00
.gitignore	Cabal init	2023-09-07 17:24:45 -05:00
CHANGELOG.md	Cabal init	2023-09-07 17:24:45 -05:00
README.md	Start new LLVM generator using IRBuilder	2023-09-23 23:15:11 -05:00
package.yaml	Start new LLVM generator using IRBuilder	2023-09-23 23:15:11 -05:00
really-bad-compiler-in-haskell.cabal	Start new LLVM generator using IRBuilder	2023-09-23 23:15:11 -05:00
stack.yaml	Start new LLVM generator using IRBuilder	2023-09-23 23:15:11 -05:00
stack.yaml.lock	Start new LLVM generator using IRBuilder	2023-09-23 23:15:11 -05:00

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).

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, llvm-hs-pure 15, llvm-hs-pretty-15
Dependencies: llvm 15, clang 15
IDE: VSCodium
Git platform: Forgejo
AI: Phind (GPT-4), ollama (codellama)
Search: Kagi, Stack Overflow