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

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

### Tools

- Language: Haskell
- Haskell tools: GHCup, Stack, Cabal
- Libraries: megaparsec, parser-combinators, text, llvm-hs-pure
- Dependencies: llvm, clang
- IDE: VSCodium
- Git platform: Forgejo
- AI: Phind (GPT-4), ollama (codellama)
- Search: Kagi, Stack Overflow
Create initial files 2023-09-07 20:57:58 +00:00			`# Really Bad Compiler in Haskell`
Initial commit 2023-09-07 20:46:17 +00:00
Generate LLVM program that returns 0 when run 2023-09-23 04:59:31 +00:00			`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.`
Create initial files 2023-09-07 20:57:58 +00:00
Remove RTX 2023-09-07 22:15:02 +00:00			`Main repo: https://git.sudoer.ch/me/really-bad-compiler-in-haskell`

Create initial files 2023-09-07 20:57:58 +00:00			`## Build Instructions`

Attempt to install llvm using nix 2023-09-15 06:57:17 +00:00			- Install `ghcup` (for managing Haskell tools) and `nix` (for managing external dependencies).
Create very basic equation parser 2023-09-08 03:57:12 +00:00			`- Clone the repo.`
Copy and paste llvm-hs-examples/basic on GitHub to LLVMGen/Expression.hs and configure stack to compile it correctly 2023-09-18 04:18:55 +00:00			- Use `ghcup` to install `stack 2.9.3`, `HLS 2.2.0.0`, `GHC 9.2.8`, and `cabal 3.6.2.0`.
Attempt to install llvm using nix 2023-09-15 06:57:17 +00:00			- Use `stack run <file>` to run the program (for example, `stack run example/1`).
Create initial files 2023-09-07 20:57:58 +00:00
Copy and paste llvm-hs-examples/basic on GitHub to LLVMGen/Expression.hs and configure stack to compile it correctly 2023-09-18 04:18:55 +00:00			`## 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.

Update README.md 2023-09-11 17:05:44 +00:00			`## File structure`

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

Create initial files 2023-09-07 20:57:58 +00:00			`## Credits`

Create very basic equation parser 2023-09-08 03:57:12 +00:00			`### Learning Resources Used`
Remove RTX 2023-09-07 22:15:02 +00:00
Create initial files 2023-09-07 20:57:58 +00:00			`- Introduction to Compiler Design class at The University of Texas at Dallas, taught by Charles Averill`
Create very basic equation parser 2023-09-08 03:57:12 +00:00			`- 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)`
Switch package data from cabal to stack 2023-09-15 04:06:40 +00:00			`- https://www.forth.com/starting-forth/1-forth-stacks-dictionary/ (for learning Forth)`
Copy and paste llvm-hs-examples/basic on GitHub to LLVMGen/Expression.hs and configure stack to compile it correctly 2023-09-18 04:18:55 +00:00			`- 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)`
Remove RTX 2023-09-07 22:15:02 +00:00
			`### Tools`

			`- Language: Haskell`
Create very basic equation parser 2023-09-08 03:57:12 +00:00			`- Haskell tools: GHCup, Stack, Cabal`
Copy and paste llvm-hs-examples/basic on GitHub to LLVMGen/Expression.hs and configure stack to compile it correctly 2023-09-18 04:18:55 +00:00			`- Libraries: megaparsec, parser-combinators, text, llvm-hs-pure`
Attempt to install llvm using nix 2023-09-15 06:57:17 +00:00			`- Dependencies: llvm, clang`
Remove RTX 2023-09-07 22:15:02 +00:00			`- IDE: VSCodium`
Create very basic equation parser 2023-09-08 03:57:12 +00:00			`- Git platform: Forgejo`
Generate LLVM program that returns 0 when run 2023-09-23 04:59:31 +00:00			`- AI: Phind (GPT-4), ollama (codellama)`
Add solving expressions 2023-09-08 05:53:11 +00:00			`- Search: Kagi, Stack Overflow`