Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mealet/tpl-lang
Stupid Programming Language based on LLVM in Rust
https://github.com/mealet/tpl-lang
compiler llvm programming-language rust
Last synced: 24 days ago
JSON representation
Stupid Programming Language based on LLVM in Rust
- Host: GitHub
- URL: https://github.com/mealet/tpl-lang
- Owner: mealet
- License: bsd-3-clause
- Created: 2024-08-04T20:40:38.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-09-14T10:07:29.000Z (about 2 months ago)
- Last Synced: 2024-10-01T03:40:55.323Z (about 1 month ago)
- Topics: compiler, llvm, programming-language, rust
- Language: Rust
- Homepage:
- Size: 144 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[Rust]: https://www.rust-lang.org/
[LLVM]: https://llvm.org/
[Inkwell]: https://github.com/TheDan64/inkwell
[Colored]: https://crates.io/crates/colored
## 🧐 What is this?
**Toy Programming Language** - is a simple compiling language, based on LLVM.
Project created to learn and show other people how to create compilers in Rust 🦀
Code separated to 4 modules:
1. `tpl-lexer` - lexical analyzer, which turns code into _tokens_.
2. `tpl-parser` - tool for parsing tokens and creating _AST_.
3. `tpl-ir` - codegen module with simple task: translate _AST_ to _LLVM Module_.
4. `tplc` - main part of all project, which contains such things like: cli tool, config parser, llvm module compiler, object linker and etc.
## 🤖 Tools Used
* Programming Language: [Rust]
* Code Generator: [LLVM]
* LLVM Library: [Inkwell]
* Colored Terminal Library: [Colored]
## 🦛 Building
1. Download or clone this repository to your computer.
2. Install **[Rust]** language.
3. Install **[LLVM]** for your system.
4. Type build command at the main directory:
```sh
cargo build --release
```
4. Binary file of compiler will be at `target/release` directory under the name: _**tplc**_ (or _**tplc.exe**_ on Windows)
## 👾 Example
1. Create file `example.tpl` and open in any code editor
2. Write code:
```c++
int a = 2; // annotation
int b = a * 2; // annotation using other variables
int c = 2 + 2 * 2; // binary operations priority
print(a); // 2
print(b); // 4
print(c); // 6
a = 2 + 2; // assignment
print(a); // 4
bool flag = true; // boolean type
print(flag); // will print "true"
str greeting = "Hello World!"; // string type
print(greeting); // "Hello World!"
// if-else construction
if 1 < 2 {
print("1 is less than 2");
};
if 2 != 2 {
// code
} else {
print("2 = 2");
};
// loops
int a = 0;
while a < 5 {
a += 1;
// or
a++;
print(a);
};
for i in 5 {
print(i);
};
// tests in variables
bool test = 1 + 1 == 2;
// defining functions
define int foo(int a, int b) {
print("hello from foo function!");
return a + b;
};
// calling functions
foo(4, 2);
// calling functions in variables annotation or assignment
int a = foo(4, 2);
a = foo(5, 5);
```
3. Compile it by command:
```sh
tplc example.tpl output
```
4. And run like binary file:
```sh
./output
```
😵 Errors Examples
## 💀 License
Project licensed under the BSD-3 License. More information in [**LICENSE**](https://github.com/mealet/tpl-lang/blob/main/LICENSE) file