fun/docs/handbook.md

Fun Handbook

Overview

Introduction

Installation

Requirements

A C compiler, a libc and Git.

FreeBSD

• CMake
• Clang

Linux

• CMake
• GCC (Clang should work here too, not tested!)

Windows

This requires Cygwin to be installed and configured. I will not cover this here.

• CMake
• Cygwin using GCC

Build Fun

Linux/UNIX and Cygwin only covered here for now.

Clone repository:

git clone https://git.xw3.org/fun/fun.git

Change directory:

cd fun

Build:

# Note: Every -D flag must be of the form NAME=VALUE (e.g., -DFUN_WITH_REPL=ON)
cmake -S . -B build -DFUN_DEBUG=OFF -DFUN_WITH_PCSC=OFF -DFUN_WITH_REPL=ON -DFUN_WITH_JSON=ON
cmake --build build --target fun

That's it! For testing it, run:

FUN_LIB_DIR="$(pwd)/lib" ./build/fun ./demo.fun

To see what's going on, run:

FUN_LIB_DIR="$(pwd)/lib" ./build/fun --trace ./demo.fun

To switch into the REPL after an error, run:

FUN_LIB_DIR="$(pwd)/lib" ./build/fun --repl-on-error --trace ./demo.fun

Both --repl-on-error and --trace are optional but can always be combined. To get more debug information, you need to build Fun with -DFUN_DEBUG=ON.

To directly run the REPL, you have to run:

FUN_LIB_DIR="$(pwd)/lib" ./build/fun

But be sure to build Fun with -DFUN_WITH_REPL=ON.

CMake options

All CMake options must be passed as -DNAME=VALUE:

• FUN_DEBUG=ON|OFF — verbose debug logging in the VM (default OFF)
• FUN_WITH_REPL=ON|OFF — enable the interactive REPL (default ON)
• FUN_WITH_PCSC=ON|OFF — enable PC/SC smart card support (default OFF)
• FUN_WITH_JSON=ON|OFF — enable JSON support via json-c (default OFF)

If you encounter an error such as:

CMake Error: Parse error in command line argument: FUN_WITH_JSON Should be: VAR:type=value

then a -D option was given without a value. Always use -DNAME=VALUE, for example -DFUN_WITH_JSON=ON.

Install Fun to OS

I do not recommend installing Fun on your system because it is in a very early stage of development, but I can say that I have Fun installed on my system. If you want to do that too, type:

sudo cmake --build build --target install

Now run Fun without prefixed FUN_LIB_DIR="$(pwd)/lib" because libs are installed to the system default lib directory (/usr/share/fun/lib).

Usage

fun ./demo.fun