Files
Toy/README.md
Kayne Ruse 5a0012d73a Tweaked README
...because I'm still not feeling like coding, thanks to this damn flu.
2025-03-01 12:30:53 +11:00

119 lines
3.4 KiB
Markdown

<p align="center">
<image src="toylogo.png" />
</p>
# Toy v2.x
The Toy Programming Language is an imperative, bytecode-interpreted, embeddable scripting language. Rather than functioning independently, it serves as part of another program, the "host". This design allows for straightforward customization by both the host's developers and end users, achieved by exposing program logic through text files.
This repository holds the reference implementation for Toy version 2.x, written in C.
# Nifty Features
* Simple C-like/JS-like syntax
* Intermediate AST representation
* Strong, but optional type system
* First-class functions and closures
* Extensible with importable native code
* Can re-direct output, error and assert failure messages
* Open-Source under the zlib license
# Syntax
The following examples aren't fully functional yet - see the ['features' label in the issue tracker](https://github.com/krgamestudios/Toy/issues?q=is%3Aissue%20state%3Aopen%20label%3Afeature) for more information.
```toy
//fizzbuzz example
for (var counter: int = 1; counter <= 100; i++) {
var result: string = "";
if (counter % 3 == 0) {
result = result .. "fizz";
}
if (counter % 5 == 0) {
result = result .. "buzz";
}
if (result != "") {
print result;
}
else {
print counter;
}
}
```
```toy
//find the nth fibonacci number
fn fib(n: int) {
if (n < 2) return n;
return fib(n-1) + fib(n-2);
}
for (var i = 1; i <= 10; i++) {
print i.toString() .. ":" .. fib(i).toString();
}
```
```toy
//closures!
fn makeCounter() {
var count = 0;
fn next() {
return ++count;
}
return next;
}
var tally = makeCounter();
print tally(); //1
print tally(); //2
print tally(); //3
```
# Building
Supported platforms are: `linux-latest`, `windows-latest`, `macos-latest`, using [GitHub's standard runners](https://docs.github.com/en/actions/using-github-hosted-runners/using-github-hosted-runners/about-github-hosted-runners#standard-github-hosted-runners-for-public-repositories).
Support for NetBSD is present, but not guaranteed.
To build the shared library, run `make source`.
To build the shared library and repl, run `make repl`.
To build and run the test suites, run `make tests` (`make tests-gdb` and `make tests-valgrind` options are also available).
# Tools
Information about the tools can be found in the [issue tracker](https://github.com/krgamestudios/Toy/issues?q=is%3Aissue%20state%3Aopen%20label%3Atooling).
# Documentation
See [https://toylang.com/](https://toylang.com/) for Toy's documentation.
Further information about the documentation can be found in the [issue tracker](https://github.com/krgamestudios/Toy/issues?q=is%3Aissue%20state%3Aopen%20label%3Adocumentation).
# License
This source code is covered by the Zlib license (see [LICENSE.md](LICENSE.md)).
# Contributors and Special Thanks
@NishiOwO - Unofficial NetBSD support
@Gipson62 - v1 docs spell checking
@8051Enthusiast - `fixAlignment()` trick
@hiperiondev - v1 Disassembler, v1 porting support and feedback
@add00 - v1 Library support
@gruelingpine185 - Unofficial v1 MacOS support
@solar-mist - v1 Minor bugfixes
Various Anons - Feedback
@munificent - For [writing the book](http://craftinginterpreters.com/) that sparked my interest in langdev
# Patreon Supporters
* Seth A. Robinson
You can show your support and be listed here by joining my [Patreon](https://patreon.com/krgamestudios).