https://github.com/caoimhebyrne/petal
A language with a compiler written in C, generating binaries using LLVM
https://github.com/caoimhebyrne/petal
c language llvm
Last synced: 15 days ago
JSON representation
A language with a compiler written in C, generating binaries using LLVM
- Host: GitHub
- URL: https://github.com/caoimhebyrne/petal
- Owner: caoimhebyrne
- License: mit
- Created: 2024-12-21T21:05:59.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-02-09T13:02:43.000Z (3 months ago)
- Last Synced: 2025-04-05T17:08:55.313Z (23 days ago)
- Topics: c, language, llvm
- Language: C
- Homepage:
- Size: 451 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## `petal` 🌸
This is a compiler/runtime for my language, called Petal. The plan is for this compiler to provide
enough basic features to build a self-hosted compiler.
This compiler uses LLVM to generate binaries.
```go
// This is the main function, it is called similar to how it would be called in C.
// Petal is linked with libc, meaning `main` is called from the `__start` symbol.
//
// This function expects an `i32` to be returned.
func main() -> i32 {
// This is a variable declaration. Since it is in a function block, it can only
// be accessed from within this function block.
i32 my_variable = 100;
// Values can be returned either by referencing a variable name, or writing the value inline.
return my_variable;
}
```
### Building
1. Clone this git repository.
2. Build the compiler using the [Makefile](./Makefile).
```sh
$ make build
```
3. If you are planning to use `clangd` within your code editor, install [Bear](https://github.com/rizsotto/Bear) and run
the `setup-clangd` target.
```sh
$ make setup-clangd
```
### Installation
You can install the Petal compiler for your user through the `install` target.
```sh
$ make install
```
This will build the Petal compiler, and copy its binary (`petal`) to `$HOME/.local/bin`. This may not be on your `PATH`,
so you might need to add the following line to your shell's init script (`.zshrc`, `.bashrc`, .etc.):
```sh
export PATH="$HOME/.local/bin:$PATH"
```
### License
This project is licensed under the MIT license. See the [LICENSE](./LICENSE) file for more information.