mun_runtime 0.2.0

A runtime for hot reloading and invoking Mun from Rust
Documentation

Mun

Build Status Crates.io docs master docs v0.2 MIT/Apache Join us on Discord codecov Lines of Code

Mun is a programming language empowering creation through iteration.

Features

  • Ahead of time compilation - Mun is compiled ahead of time (AOT), as opposed to being interpreted or compiled just in time (JIT). By detecting errors in the code during AOT compilation, an entire class of runtime errors is eliminated. This allows developers to stay within the comfort of their IDE instead of having to switch between the IDE and target application to debug runtime errors.

  • Statically typed - Mun resolves types at compilation time instead of at runtime, resulting in immediate feedback when writing code and opening the door for powerful refactoring tools.

  • First class hot-reloading - Every aspect of Mun is designed with hot reloading in mind. Hot reloading is the process of changing code and resources of a live application, removing the need to start, stop and recompile an application whenever a function or value is changed.

  • Performance - AOT compilation combined with static typing ensure that Mun is compiled to machine code that can be natively executed on any target platform. LLVM is used for compilation and optimization, guaranteeing the best possible performance. Hot reloading does introduce a slight runtime overhead, but it can be disabled for production builds to ensure the best possible runtime performance.

  • Cross compilation - The Mun compiler is able to compile to all supported target platforms from any supported compiler platform.

  • Powerful IDE integration not implemented yet - The Mun language and compiler framework are designed to support source code queries, allowing for powerful IDE integrations such as code completion and refactoring tools.

Example

Documentation

The Mun Programming Language Book is hosted on netlify.

Pre-Built Binaries

[NOTE] We do not provide support for milestone releases

[NOTE] None of the binaries are currently signed

Download pre-built binaries of milestone releases for macOS, Linux, and Windows (64-bit only).

Building from Source

Installing dependencies

Make sure you have the following dependencies installed on you machine:

Rust

Install the latest stable version of Rust, e.g. using rustup.

LLVM

Mun targets LLVM 7.1.0. Installing LLVM is platform dependant and as such can be a pain. The following steps are how we install LLVM on our CI runners:

  • *nix: Package managers of recent *nix distros can install binary versions of LLVM, e.g.: 
    # Ubuntu 18.04
sudo apt install llvm-7 llvm-7-* liblld-7*
  • Arch Linux The binary version of LLVM can currently only be installed using an AUR helper, such as yay: 
    yay -Syu lld7-headers lld7-libs-static
    It is also possible to perform a manual package installation as follows: 
    # NOTE: this installs all of the lld7 packages
cd /tmp
git clone https://aur.archlinux.org/lld7.git
cd lld7
makepkg -si
    When running llvm-config, an error can occur signalling that /usr/lib/libtinfo.so.5 is missing. If a newer version is present, create a symlink; e.g. ln -s /usr/lib/libtinfo.so.6 /usr/lib/libtinfo.so.5), otherwise download the library.
  • macOS: Brew contains a binary distribution of LLVM 7.1.0. However, as it's not the latest version, it won't be added to the path. We are using llvm-sys to manage version, but another option is to export the LLVM_SYS_70_PREFIX variable, which will not clutter your PATH. To install: 
    brew install llvm@7
# Export LLVM_SYS_PREFIX to not clubber PATH
export LLVM_SYS_PREFIX=$(brew --prefix llvm@7)
  • windows: Binary distrubutions are available for Windows on the LLVM website, but they do not contain a number of libraries that are required by Mun. To avoid having to go to the trouble of compiling LLVM yourself, we created a repository that automatically compiles the required binaries. It also contains a release that you can download and extract to your machine. Once downloaded and extracted, add the <extract_dir>/bin folder to the PATH environment variable.

Clone source

git clone https://github.com/mun-lang/mun.git

git submodule update --init --recursive

Compiling

cargo build --release

Building Documentation

Building the book requires mdBook, ideally version 0.3.x. To install it, run:

$ cargo install mdbook --vers [version-num]

The Mun book uses a custom version of Highlight.js to enable highlighting of Mun code. The build version of Highlight.js is required by mdbook in the theme/ folder but it is not distributed with the source. Instead, it can be build by invoking the build script:

cd book
./ci/build-highlight-js

Every time you change something in the custom version of highlight.js you have to call the above script to ensure you locally use the latest version.

After generating the custom minified Highlight.js, to build the book, type:

$ mdbook build

The output will be in the book subdirectory. To view the book, open it in your web browser.

For local development use mdbook serve instead of mdbook build. This will start a local webserver on port 3000 that serves the book and rebuilds the content when changes are detected.

All of the above is also combined in a single shell script that can be invoked by simply running:

./ci/build

To test the rust source code in the book, run:

mdbook test -L path/to/target/debug/deps

For this to work, there can only be one libmun_runtime-{HASH}.rlib file in the provided library path.

License

The Mun Runtime is licensed under either of

at your option.