Examples¶

Gloat includes over 50 demo programs in both Clojure and YAMLScript. These examples demonstrate the compilation pipeline and showcase what you can build.

All examples are available in the demo/ directory of the repository.

Running Examples¶

# Run a YAMLScript example
make run FILE=demo/yamlscript/fizzbuzz.ys

# Run a Clojure example with arguments
make run FILE=demo/clojure/factorial.clj a='10'

# Compile an example to binary
gloat demo/yamlscript/dragon-curve.ys -o dragon
./dragon

Try Them¶

The best way to explore these examples is through the interactive demo:

Click the Try Live Demo badge
Wait for Codespaces to initialize (1-2 minutes)
Select any example from the dropdown
Click Compile to build to Wasm
Click Run to execute in your browser

Or run them locally:

# Clone the repository
git clone https://github.com/gloathub/gloat
cd gloat
source .rc

# Run the demo server
make demo-server

# Or run individual examples
make run FILE=demo/yamlscript/dragon-curve.ys

Shared Library Bindings¶

Gloat can compile YAMLScript to shared libraries (.so/.dylib/.dll) with auto-generated C header files, enabling FFI (Foreign Function Interface) bindings from 23 programming languages.

The demo/so-bindings/ directory contains working examples for every supported language, all calling the same shared library compiled from a single YAMLScript source file.

Exported Functions¶

The source file demo/so-bindings/example.ys defines 6 exported functions:

Function	Signature
`factorial`	`int → int`
`greet`	`str → str`
`repeat_string`	`str, int → str`
`shout_it`	`str → void`
`maybe`	`→ bool`
`sort_json_array`	`str → str`

Supported Languages¶

Ada, C, C++, C#, Crystal, D, Dart, Delphi, Fortran, Go, Haskell, Java, Julia, Lua, Nim, Node.js, Perl, Python, Raku, Ruby, Rust, V, Zig

Building and Running¶

# Build the shared library and run the standard language bindings
make test-so-bindings

# Include the slow Haskell and Lua bindings
make -C demo/so-bindings test slow=1

# Build and test the bindings with either let-go engine
GLOAT_ENGINE=lgvm make -C demo/so-bindings test
GLOAT_ENGINE=lglvm make -C demo/so-bindings test

# Run a single language binding
make -C demo/so-bindings/python run

The default glj engine and both VM-backed let-go engines support shared libraries. lgvm invokes the bundled bytecode, while lglvm uses native lowered Go functions where possible and falls back to the bundled VM for the rest.

Contributing Examples¶

Have an interesting example to share? Contributions are welcome!

See the GitHub repository to submit examples via pull request.