Copy and paste llvm-hs-examples/basic on GitHub to LLVMGen/Expression.hs and configure stack to compile it correctly

README.md

@@ -1,14 +1,26 @@
 # Really Bad Compiler in Haskell
 
-A compiler written in Haskell that is really bad (I do not know what language I am going to compile yet). Built for the Introduction to Compiler Design class at The University of Texas at Dallas.
+A compiler written in Haskell which can currently perform basic arithmetic using the megaparsec and llvm-hs libraries (I do not know what language I am going to compile yet). 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 all of the Haskell tools.
-- Use `stack build` and `stack run <file>` to run the program.
+- 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
 
@@ -18,12 +30,16 @@ Main repo: https://git.sudoer.ch/me/really-bad-compiler-in-haskell
 - 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
+- Libraries: megaparsec, parser-combinators, text, llvm-hs-pure
+- Dependencies: llvm, clang
 - IDE: VSCodium
 - Git platform: Forgejo
 - AI: Phind

app/LLVMGen/Expression.hs

@@ -0,0 +1,51 @@
+module LLVMGen.Expression () where
+
+import qualified Objects.Expression as Expr
+
+import LLVM.AST
+import qualified LLVM.AST as AST
+import LLVM.AST.Global
+import LLVM.Context
+import LLVM.Module
+
+import Data.ByteString.Char8 as BS
+
+int :: Type
+int = IntegerType 32
+
+defAdd :: Definition
+defAdd = GlobalDefinition functionDefaults
+  { name = Name "add"
+  , parameters =
+      ( [ Parameter int (Name "a") []
+        , Parameter int (Name "b") [] ]
+      , False )
+  , returnType = int
+  , basicBlocks = [body]
+  }
+  where
+    body = BasicBlock
+        (Name "entry")
+        [ Name "result" :=
+            Add False  -- no signed wrap
+                False  -- no unsigned wrap
+                (LocalReference int (Name "a"))
+                (LocalReference int (Name "b"))
+                []]
+        (Do $ Ret (Just (LocalReference int (Name "result"))) [])
+
+
+module_ :: AST.Module
+module_ = defaultModule
+  { moduleName = "basic"
+  , moduleDefinitions = [defAdd]
+  }
+
+
+toLLVM :: AST.Module -> IO ()
+toLLVM modul = withContext $ \ctx -> do
+  llvm <- withModuleFromAST ctx modul moduleLLVMAssembly
+  BS.putStrLn llvm
+
+main :: IO ()
+main = toLLVM module_

example/1

@@ -0,0 +1 @@
+5*3+2

example/2

@@ -0,0 +1 @@
+6+8/3

package.yaml

@@ -0,0 +1,30 @@
+name: really-bad-compiler-in-haskell
+version: 0
+author: sudoer777
+dependencies:
+  - base >= 4.14.3 && < 5
+  - megaparsec >= 9.0.1 && < 10
+  - parser-combinators
+  - text
+  - llvm-hs >= 15 && < 16
+  - llvm-hs-pure >= 15 && < 16
+  # - llvm-hs-pretty >= 15 && < 16
+  - bytestring
+tested-with: GHC == 9.2.8
+category: Compilers/Interpreters
+
+ghc-options: -threaded -Wall -j8 +RTS -A64M -RTS -fllvm
+
+# library:
+#   source-dirs: src
+
+executable:
+  source-dirs: app
+  main: Main.hs
+# tests:
+#   testall:
+#     main: Testall.hs
+#     source-dirs: test
+
+default-extensions: OverloadedStrings, LambdaCase
+# flags: -fno-hs-llvm=true

really-bad-compiler-in-haskell.cabal

@@ -1,39 +1,37 @@
-cabal-version:      2.4
+cabal-version: 1.12
+
+-- This file has been generated from package.yaml by hpack version 0.35.1.
+--
+-- see: https://github.com/sol/hpack
+
 name:           really-bad-compiler-in-haskell
-version:            0.1.0.0
-
--- A short (one-line) description of the package.
--- synopsis:
-
--- A longer description of the package.
--- description:
-
--- A URL where users can report bugs.
--- bug-reports:
-
--- The license under which the package is released.
--- license:
+version:        0
+category:       Compilers/Interpreters
 author:         sudoer777
-maintainer:         git@sudoer.ch
-
--- A copyright notice.
--- copyright:
--- category:
-extra-source-files:
-    CHANGELOG.md
-    README.md
+maintainer:     sudoer777
+build-type:     Simple
+tested-with:
+    GHC == 9.2.8
 
 executable really-bad-compiler-in-haskell
   main-is: Main.hs
-
-    -- Modules included in this executable, other than Main.
-    -- other-modules:
-
-    -- LANGUAGE extensions used by modules in this package.
-    -- other-extensions:
-    build-depends:    base ^>=4.16.4.0
-                    , megaparsec >= 9.2.2
+  other-modules:
+      Eval.Expression
+      LLVMGen.Expression
+      Objects.Expression
+      Parser.Expression
+      Paths_really_bad_compiler_in_haskell
+  hs-source-dirs:
+      app
+  default-extensions:
+      OverloadedStrings, LambdaCase
+  ghc-options: -threaded -Wall -j8 +RTS -A64M -RTS -fllvm
+  build-depends:
+      base >=4.14.3 && <5
+    , bytestring
+    , llvm-hs ==15.*
+    , llvm-hs-pure ==15.*
+    , megaparsec >=9.0.1 && <10
     , parser-combinators
     , text
-    hs-source-dirs:   app
   default-language: Haskell2010

stack.yaml

@@ -1,67 +1,17 @@
-# This file was automatically generated by 'stack init'
-#
-# Some commonly used options have been documented as comments in this file.
-# For advanced use and comprehensive documentation of the format, please see:
-# https://docs.haskellstack.org/en/stable/yaml_configuration/
+resolver: lts-20.26
 
-# Resolver to choose a 'specific' stackage snapshot or a compiler version.
-# A snapshot resolver dictates the compiler version and the set of packages
-# to be used for project dependencies. For example:
-#
-# resolver: lts-3.5
-# resolver: nightly-2015-09-21
-# resolver: ghc-7.10.2
-#
-# The location of a snapshot can be provided as a file or url. Stack assumes
-# a snapshot provided as a file might change, whereas a url resource does not.
-#
-# resolver: ./custom-snapshot.yaml
-# resolver: https://example.com/snapshots/2018-01-01.yaml
-resolver:
-  url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/20/26.yaml
-
-# User packages to be built.
-# Various formats can be used as shown in the example below.
-#
-# packages:
-# - some-directory
-# - https://example.com/foo/bar/baz-0.0.2.tar.gz
-#   subdirs:
-#   - auto-update
-#   - wai
 packages:
-- .
-# Dependency packages to be pulled from upstream that are not in the resolver.
-# These entries can reference officially published versions as well as
-# forks / in-progress versions pinned to a git hash. For example:
-#
-# extra-deps:
-# - acme-missiles-0.3
-# - git: https://github.com/commercialhaskell/stack.git
-#   commit: e7b331f14bcffb8367cd58fbfc8b40ec7642100a
-#
-# extra-deps: []
-
-# Override default flag values for local packages and extra-deps
-# flags: {}
-
-# Extra package databases containing global packages
-# extra-package-dbs: []
-
-# Control whether we use the GHC we find on the path
-# system-ghc: true
-#
-# Require a specific version of Stack, using version ranges
-# require-stack-version: -any # Default
-# require-stack-version: ">=2.9"
-#
-# Override the architecture used by Stack, especially useful on Windows
-# arch: i386
-# arch: x86_64
-#
-# Extra directories used by Stack for building
-# extra-include-dirs: [/path/to/dir]
-# extra-lib-dirs: [/path/to/dir]
-#
-# Allow a newer minor version of GHC than the snapshot specifies
-# compiler-check: newer-minor
+  - .
+extra-deps:
+  # - github: hyunsooda/llvm-hs-pretty-15
+  #   commit: 79283942d1667168ecd65237667aff7fed730303
+  - github: llvm-hs/llvm-hs
+    commit: 5bca2c1a2a3aa98ecfb19181e7a5ebbf3e212b76
+    subdirs:
+      - llvm-hs-pure
+      - llvm-hs
+nix:
+  enable: true
+  packages: [llvm_15, clang_15, libxml2]
+system-ghc: true
+install-ghc: true

stack.yaml.lock

@@ -3,11 +3,36 @@
 # For more information, please see the documentation at:
 #   https://docs.haskellstack.org/en/stable/lock_files
 
-packages: []
+packages:
+- completed:
+    name: llvm-hs-pure
+    pantry-tree:
+      sha256: b512f9e5f8f2b3e3a06bad2fa5ff053a83d817798c7efcd47e254e68c842169d
+      size: 2712
+    sha256: 526b67e2da9ce25b3856c221b6772e699a7593dbb5ba38e7ee2436349de70966
+    size: 9802209
+    subdir: llvm-hs-pure
+    url: https://github.com/llvm-hs/llvm-hs/archive/5bca2c1a2a3aa98ecfb19181e7a5ebbf3e212b76.tar.gz
+    version: 15.0.0
+  original:
+    subdir: llvm-hs-pure
+    url: https://github.com/llvm-hs/llvm-hs/archive/5bca2c1a2a3aa98ecfb19181e7a5ebbf3e212b76.tar.gz
+- completed:
+    name: llvm-hs
+    pantry-tree:
+      sha256: 21f74a6f51fae6c0a0fcf3e6620a59f341289ac743998b41ed3276fd1b7d8862
+      size: 12716
+    sha256: 526b67e2da9ce25b3856c221b6772e699a7593dbb5ba38e7ee2436349de70966
+    size: 9802209
+    subdir: llvm-hs
+    url: https://github.com/llvm-hs/llvm-hs/archive/5bca2c1a2a3aa98ecfb19181e7a5ebbf3e212b76.tar.gz
+    version: 15.0.0
+  original:
+    subdir: llvm-hs
+    url: https://github.com/llvm-hs/llvm-hs/archive/5bca2c1a2a3aa98ecfb19181e7a5ebbf3e212b76.tar.gz
 snapshots:
 - completed:
     sha256: 5a59b2a405b3aba3c00188453be172b85893cab8ebc352b1ef58b0eae5d248a2
     size: 650475
     url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/20/26.yaml
-  original:
-    url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/20/26.yaml
+  original: lts-20.26