https://github.com/aripiprazole/plank

📜 | Functional programming language written in kotlin.
https://github.com/aripiprazole/plank

compiler kotlin llvm parser plank programming-language

Last synced: 1 day ago
JSON representation

📜 | Functional programming language written in kotlin.

• Host: GitHub
• URL: https://github.com/aripiprazole/plank
• Owner: aripiprazole
• License: mit
• Created: 2021-01-08T22:58:14.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-10-20T11:57:47.000Z (about 2 years ago)
• Last Synced: 2024-05-21T08:16:26.383Z (6 months ago)
• Topics: compiler, kotlin, llvm, parser, plank, programming-language
• Language: Kotlin
• Homepage:
• Size: 1.4 MB
• Stars: 56
• Watchers: 3
• Forks: 0
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# PLANK

![GitHub Repo stars](https://img.shields.io/github/stars/plank-lang/plank?color=orange&style=for-the-badge)

![GitHub issues](https://img.shields.io/github/issues/plank-lang/plank?color=orange&style=for-the-badge)

![GitHub last commit](https://img.shields.io/github/last-commit/plank-lang/plank?color=orange&style=for-the-badge)

Plank is a simple language made with LLVM and ANTLR in Kotlin. Need help? contact me

on [Twitter](https://twitter.com/gabrielleeg1) or message me on discord **Gabii#3336**.

### Content

* [Example](#example)

* [Modules](#modules)

* [CLI](#cli)

* [Building](#building)

* [Pull Requests](#pull-requests)

* [Ending](#ending)

* Documentation (WIP)

## Example

Hello world in plank:

```ocaml

use Std.IO;

fun main(argc: Int32, argv: **Char) {

  println("Hello, world");

}

```

You can find more examples [here](samples)

## Modules

| Name                                   | Description                                      |

|----------------------------------------|--------------------------------------------------|

| [cli](modules/cli)                     | All command-line stuff                           | 

| [syntax](modules/syntax)               | AST and Descriptor Mapping                       |

| [parser](modules/parser)               | ANTLR grammar                                    |

| [codegen](modules/codegen)             | The LLVM core that compiles to IR representation |

| [analyzer](modules/analyzer)           | Code analyzing                                   |

| [vscode-plugin](modules/vscode-plugin) | VSCode tooling plugin                            |

| [runtime](runtime)                     | Runtime functions                                |

| [stdlib](stdlib)                       | Language stdlib                                  |

## CLI

```

Usage: plank [OPTIONS] COMMAND [ARGS]...

Options:

  -h, --help  Show this message and exit

Commands:

  jit

  repl

```

## Building

The LLVM 13.0.0 is required, you can either put `llvm-config` in the `$PATH` environment variable, either create a

`local.properties` and put `llvm.config=` in it.

You should execute the following commands:

```shell

$ git clone [email protected]:plank-lang/plank.git

$ cd plank

# if you are in windows

# PS .\gradlew.bat cli:linkPlankReleaseExecutableMingwX64

$ ./gradlew cli:linkPlankReleaseExecutableLinuxX64

```

The binary file `cli/build/bin/linuxX64/plankReleaseExecutable` or if you are in a Windows

machine `cli/build/bin/mingwX64/plankReleaseExecutable` will be created.

## Pull Requests

PRs are welcome as long as they are well explained and only change one feature at a time.  

This doesn't mean I'm going to accept all PRs, it just means I'm going to consider it.

## Ending

If you liked and/or use the language consider leaving a star on the repo and following me on twitter :)