tsuki

A programming language that focuses on being fun to program in, and aiding developers in writing more robust software, all while maintaining high performance.

The compiler is still in its infancy, and it'll probably take me a while before it's actually usable. In the meantime, you can check out the spec, which lays out the general feature set and vision of the language.

Compiling

Right now compiling tsuki isn't exactly the most trivial of tasks, and Windows is not yet supported.

Step 0. Install a C (and C++) compiler.

tsuki depends on libc and uses whatever C compiler is available on the system as cc to link executables. This can be overridden using the $TSUKI_CC or $CC environment variables, in that order of priority. The C++ compiler is necessary to build LLVM.

Step 1. Compile LLVM 12.

The best way to get LLVM for tsuki is to build it manually. I had pretty bad experiences with using repository LLVM, with problems ranging from missing static libraries on Ubuntu, no llvm-config on Windows, to random SIGILLs after a month of hiatus on Arch.

So here's uncle Liquid's method of obtaining LLVM:

# This is where we're going to install LLVM, so change this to some sensible path.
# bash - in this case you also need to add this to .bashrc
export LLVM_SYS_120_PREFIX=$HOME/llvm
# fish
set -Ux LLVM_SYS_120_PREFIX ~/llvm

# Now it's time to get LLVM. We'll use their GitHub releases for that.
mkdir -p ~/llvm
wget https://github.com/llvm/llvm-project/releases/download/llvmorg-12.0.1/llvm-12.0.1.src.tar.xz
tar xJf llvm-12.0.1.src.tar.xz

# Now let's get the build going.
cd llvm-12.0.1.src
mkdir -p build
cd build
# If doing a release build, remove LLVM_ENABLE_ASSERTIONS, and set CMAKE_BUILD_TYPE to Release.
# Also, if compiling for other platforms such as aarch64, change the target in LLVM_TARGETS_TO_BUILD.
# You can find a list of all available targets, as well as some other build options, here:
# https://llvm.org/docs/GettingStarted.html#local-llvm-configuration
cmake .. \
   -D CMAKE_INSTALL_PREFIX=$LLVM_SYS_120_PREFIX \
   -D CMAKE_BUILD_TYPE=Debug \
   -D LLVM_ENABLE_ASSERTIONS=1 \
   -D LLVM_TARGETS_TO_BUILD=X86 \
   -G Ninja
# To reduce memory usage during the process of compiling LLVM, clang with the mold linker can be
# used. Grab mold here:
# https://github.com/rui314/mold
# And add the flags:
# -D CMAKE_C_COMPILER=clang
# -D CMAKE_CXX_COMPILER=clang++
# -D CMAKE_CXX_LINK_FLAGS=-fuse-ld=mold
# As far as I know it's not possible to use mold with gcc.

# IMPORTANT:
# When not using clang+mold, open a task manager or system monitor. You're going to want to look
# after your memory usage. If it starts growing rapidly, cancel the build and use --parallel 1.
# Linking with GNU ld uses up a lot of memory, so it's better to let it run a single linker at a
# time.
cmake --build . --target install --parallel 8

Maybe someday I'll make a dedicated script for this, but today is not that day.

Step 2. Compile and run.

With all that, running tsuki should be as simple as:

cargo run

Using the compiler

While still in its early stages, the compiler is able to compile arbitrary user code into a working executable. The most basic usage of the compiler would be:

$ tsuki --package-name main --package-root src --main-file src/main.tsu
# or, abbreviated:
$ tsuki -p main -r src -m src/main.tsu

package_name specifies the name of the output file, and is also used for mangling.

Refer to the code examples in code to see what's currently implemented or being worked on.