https://github.com/rainingcomputers/shnootalk
ShnooTalk is a new programming language
https://github.com/rainingcomputers/shnootalk
bytecode compiler-construction compiler-design compilers language llvm programming-language
Last synced: 10 months ago
JSON representation
ShnooTalk is a new programming language
- Host: GitHub
- URL: https://github.com/rainingcomputers/shnootalk
- Owner: RainingComputers
- License: mit
- Created: 2021-01-23T13:56:43.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-01-11T11:50:41.000Z (about 1 year ago)
- Last Synced: 2025-02-27T08:19:35.209Z (11 months ago)
- Topics: bytecode, compiler-construction, compiler-design, compilers, language, llvm, programming-language
- Language: C++
- Homepage:
- Size: 3.82 MB
- Stars: 20
- Watchers: 3
- Forks: 4
- Open Issues: 60
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
**[Language guide](docs/LanguageGuide.md) | [Try now in browser](https://rainingcomputers.github.io/shnootalk-playground/) | [Install](#install) | [Changelog](CHANGELOG.md)**
# ShnooTalk
ShnooTalk is a programming language implemented in C++ using the LLVM compiler framework. ShnooTalk works by being compiled to a custom IR format and then translating that to LLVM IR. It is possible to run ShnooTalk on any runtime that supports the clang compiler. ShnooTalk links against standard C libraries/runtime.
See the tests directory for examples, try out the language in your browser on [ShnooTalk Playground](https://rainingcomputers.github.io/shnootalk-playground/).
🛠️ Project under construction, some things may not be fully polished yet 🛠️
## Install
### Linux (Ubuntu / Arch / Debian / Fedora / RaspberryPi)
```
curl -sf -L https://raw.githubusercontent.com/RainingComputers/ShnooTalk/main/install.sh | sudo sh
```
### MacOS
```
curl -sf -L https://raw.githubusercontent.com/RainingComputers/ShnooTalk/main/install.sh | sh
```
### Linux x86_64 AppImage
Download app image from [releases](https://github.com/RainingComputers/ShnooTalk/releases) page
### Installing from source (Ubuntu)
Download the source from latest [release](https://github.com/RainingComputers/ShnooTalk/releases)
```
./ci/Linux/build.sh llvmorg-12.0.1/clang+llvm-12.0.1-x86_64-linux-gnu-ubuntu-16.04.tar.xz
sudo make install
```
### Installing from source (MacOS)
Download the source from latest [release](https://github.com/RainingComputers/ShnooTalk/releases)
```
brew install llvm@12
make build
sudo make install
```
### VS Code syntax highlight extension
Install the extension from [here](https://marketplace.visualstudio.com/items?itemName=RainingComputers.shnootalk-vscode)
## Uninstall
Uninstallation is straightforward and easy
```
rm -f /usr/local/bin/shtkc
rm -f /usr/local/bin/shtkc-
rm -rf /usr/local/lib/shnootalk-
```
## Getting started
**app.shtk**
```
fn main() -> int
{
println("Hello world")
return 0
}
```
**Compile and run**
```
shtkc app.shtk -c
clang app.o -o app
./app
```
(You can also use gcc instead of clang)
## Running compiler tests
These are end to end tests which can be used to test an implementation of ShnooTalk. The `tests_runner` python application is used to run the tests.
### Directories
#### compiler/tests/parser/
This is meant to test the AST generated from the parser.
#### compiler/tests/compiler/
Test the output executable produced by the compiler and the generated ShnooTalk icode (not the entire IR just the generated function IR instructions only, see `-icode-all` option).
#### compiler/tests/ir/
This is meant to test the overall structure of the generated IR (i.e the parts that were not tested in compiler/tests/compiler/ tests).
#### stdlib/stdlib/tests/
Tests for the standard library
### When to add a test?
- When you discover a compiler bug
- When you add a new grammar or syntax
- If you make changes to existing syntax, you will most probably just have to fix failing tests
- When you make changes to the IR or the IR builder
- Avoid making changes to the pretty printer or modifying syntax of existing IR
instructions, but if you do, you may have to change a lot of test cases, re-generate the test cases,
and do careful review using `git diff`
### Where to add the test?
- If you made changes to the parser, add test to the parser/ directory
- If you have made changes to the icode (IR instructions) or added a new IR instruction, add test to the compiler/ directory
- If you have fixed a compiler bug, add a test to compiler/ directory
- If you have made changes to the IR but not icode (IR instructions), add test to the ir/ directory
### How to add a test?
- Create a .shtk files in appropriate test directory, add print statements for asserting
- After adding the test, run `make gen FILTERS='--file '`
- Check generated files
- Run `make test` to run all tests
### How to run the tests?
- To run all tests, run `make test` or `make coverage`
- To run a single file, run `make test FILTERS='--file '`
- To run only a group of tests, run `make test FILTERS='--group '`
### How to generate the test cases?
- Run `make gen` to generate all test cases
- Run `make gen FILTERS='--file '` to generate for a particular test file
- Carefully review the changes using `git diff`
## Project status
For more detailed status see github [project](https://github.com/users/RainingComputers/projects/1/views/1) or github [issues](https://github.com/RainingComputers/ShnooTalk/issues)