Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Beluga-lang/Beluga

Contextual types meet mechanized metatheory!
https://github.com/Beluga-lang/Beluga

beluga dependent-types hoas lf ocaml

Last synced: 3 months ago
JSON representation

Contextual types meet mechanized metatheory!

Awesome Lists containing this project

README 

        
# [Beluga](http://complogic.cs.mcgill.ca/beluga/ "Beluga home page")  [![Build & Test](https://github.com/Beluga-lang/Beluga/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/Beluga-lang/Beluga/actions/workflows/build-and-test.yml)



[Beluga](http://complogic.cs.mcgill.ca/beluga/ "Beluga home page") is a functional programming language designed for reasoning about formal systems.

It features direct support for object-level binding constructs using higher order abstract syntax and treats contexts as first class objects.



## Getting started



### Prerequisites



Install the OCaml package manager ([opam](http://opam.ocaml.org/)) by following the instructions at .



Optionally, [`rlwrap`](https://github.com/hanslub42/rlwrap) may be installed to greatly improve the Beluga interactive mode user experience.



### Installation from the opam repository



Stable releases of Beluga are published on the opam repository, but they may not have the most recent features and bugfixes.



Beluga may be installed in the current opam switch using:



```bash

# Install `beluga` and `harpoon` in `$OPAM_SWITCH_PREFIX/bin`

opam install beluga



# Add `$OPAM_SWITCH_PREFIX/bin` to the `PATH` environment variable in the current shell

eval $(opam env)

```



Alternatively, to avoid dependency conflicts, an opam switch may be created specifically for Beluga using:



```bash

mkdir Beluga

cd Beluga

opam switch create . --empty

opam install beluga

eval $(opam env)

```



You can now run Beluga programs using the `beluga` or `harpoon` executables:



```bash

beluga path/to/program.bel

harpoon --sig path/to/program.bel

```



Use `opam remove beluga` to uninstall the executables.



### Installation from the source



The latest version of Beluga may be built and installed as follows, without the test dependencies.

With this configuration, the unit and integration tests cannot be run with `make test`.



To build Beluga from the source code and install it in its own opam switch:



```bash

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

cd Beluga

make setup-install

make install

```



You can now run Beluga programs using the `beluga` or `harpoon` executables from the newly created opam switch environment in the `Beluga` directory.

Make sure your shell has the correct opam switch environment variables using `eval $(opam env --switch=. --set-switch)` in the `Beluga` directory.



```bash

beluga path/to/program.bel

harpoon --sig path/to/program.bel

```



Use `make uninstall` to uninstall the executables.



### Development



The latest version of Beluga may be built and installed as follows, with the test dependencies.

With this configuration, the unit and integration tests can be run with `make test`.

If you already have an opam switch for Beluga without the test dependencies installed as above, then you can install them with `opam install ./beluga.opam --locked --deps-only --with-test --with-doc`.

Alternatively, you can remove the existing opam switch with `opam switch remove .`.



To start working on Beluga, clone the repository and run the `make setup-development` command to create an opam switch for Beluga with the necessary dependencies:



```bash

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

cd Beluga

make setup-development

eval $(opam env)

```



Use `make` to compile the production version of Beluga, `make test` to compile and run the tests, and `make clean` to clean the directory of compilation results.

Use `./LINT` to find code style errors.



To build and use any of the compiled executables as if they were installed from opam, use `dune exec [executable]`.

For instance, you can build and run the development version of `beluga` with:



```bash

dune exec beluga path/to/program.bel

```



Likewise, you can build and run the development version of `harpoon` with:



```bash

dune exec harpoon -- --sig path/to/program.bel

```



See the [`Makefile`](./Makefile) for other available development commands.



## Interactive Mode



For interactive proofs, we recommend using [Harpoon](https://beluga-lang.readthedocs.io/en/latest/harpoon/index.html).

A detailed list of commands and tactics is available [here](https://beluga-lang.readthedocs.io/en/latest/harpoon/interactive-reference.html).



## Beluga-mode for GNU Emacs



Beluga includes a major mode for programming in Emacs.

The elisp file is located in the [tools](./tools) directory.

To configure Beluga-mode:



1. Update your `~/.emacs` or `~/.emacs.d/init.el` file with the lines written below.

   XEmacs users must update `~/.emacs` or `~/.xemacs/init.el` with the same text.

   Create any of these files if they do not exist already.

   * You should replace `path/to/beluga` with the actual path of the Beluga directory.

     ```

     (add-to-list 'load-path "path/to/beluga/tools/")

     (load "beluga-mode.el")

     ```

   * NOTE: Feel free to move the beluga-mode.el file to another directory so long as you add its location to the Emacs load-path.



2. Restart Emacs.

   Emacs will now launch in Beluga-mode automatically when you open a Beluga program.