juvix/README.org at a24e0379d307c3713d847a8d92d4e3ac2bc956fa

mirror of https://github.com/anoma/juvix.git synced 2024-11-10 15:06:54 +03:00

* [cbackend] Adds an AST for C

This should cover enough C to implement the microjuvix backend.

* [cbackend] Add C serializer using language-c library

We may decide to write our own serializer for the C AST but this
demonstrates that the C AST is sufficient at least.

* [cbackend] Declarations will always be typed

* [cbackend] Add CPP support to AST

* [cbackend] Rename some names for clarity

* [cbackend] Add translation of InductiveDef to C

* [cbackend] Add CLI for C backend

* [cbackend] Add stdbool.h to file header

* [cbackend] Allow Cpp and Verbatim code inline

* [cbackend] Add a newline after printing C

* [cbackend] Support foreign blocks

* [cbackend] Add support for axioms

* [cbackend] Remove code examples

* [cbackend] wip FunctionDef including Expressions

* [parser] Support esacping '}' inside a foreign block

* [cbackend] Add support for patterns in functions

* [cbackend] Add foreign C support to HelloWorld.mjuvix

* hlint fixes

* More hlint fixes not picked up by pre-commit

* [cbackend] Remove CompileStatement from MonoJuvix

* [cbackend] Add support for compile blocks

* [cbackend] Move compileInfo extraction to MonoJuvixResult

* [minihaskell] Fix compile block support

* [chore] Remove ununsed isBackendSupported function

* [chore] Remove unused imports

* [cbackend] Use a Reader for pattern bindings

* [cbackend] Fix compiler warnings

* [cbackend] Add support for nested patterns

* [cbackend] Use functions to instantiate argument names

* [cbackend] Add non-exhaustive pattern error message

* [cbackend] Adds test for c to WASM compile and execution

* [cbackend] Add links to test dependencies in quickstart

* [cbackend] Add test with inductive types and patterns

* [cbackend] Fix indentation

* [cbackend] Remove ExpressionTyped case

https://github.com/heliaxdev/minijuvix/issues/79

* [lexer] Fix lexing of \ inside a foreign block

* [cbackend] PR review fixes

* [chore] Remove unused import

* [cbackend] Rename CJuvix to MiniC

* [cbackend] Rename MonoJuvixToC to MonoJuvixToMiniC

* [cbackend] Add test for polymorphic function

* [cbackend] Add module for string literals

2022-05-05 14:12:17 +01:00

3.8 KiB

Raw Blame History

MiniJuvix
- Description
- Quick Start
- Emacs mode
  - Keybindings
- CLI Auto-completion Scripts
  - Bash
  - Fish
  - ZSH
- Community

MiniJuvix

Description

MiniJuvix is a programming language for writing efficient formally-verified validity predicates, which can be deployed to various distributed ledgers. This is software released for experimentation and research purposes only. No warranty is provided or implied.

MiniJuvix addresses many issues that we have experienced while trying to write and deploy decentralized applications present in the ecosystem of smart-contracts:

the difficulty of adequate program verification,
the ceiling of compositional complexity,
the illegibility of execution costs, and
the lock-in to particular backends.

Quick Start

To install MiniJuvix, you can download its sources using Git from the Github repository. Then, the program can be downloaded and installed with the following commands. You will need to have Stack installed.

   $ git clone https://github.com/heliaxdev/minijuvix.git
   $ cd minijuvix
   $ stack install

If the installation succeeds, you must be able to run the minijuvix command from any location. To get the complete list of commands, please run minijuvix --help.

To test everything works correctly, you can run the following command. You will need to have emscripten and wasmer installed.

  $ stack test

Emacs mode

There is an Emacs mode available for MiniJuvix. Currently, it supports syntax highlighting for well-scoped modules.

To install it add the following lines to your Emacs configuration file:

(push "/path/to/minijuvix/minijuvix-mode/" load-path)
(require 'minijuvix-mode)

Make sure that minijuvix is installed in your PATH.

The MiniJuvix major mode will be activated automatically for .mjuvix files.

Keybindings

Key	Function Name	Description
`C-c C-l`	`minijuvix-load`	Runs the scoper and adds semantic syntax highlighting

CLI Auto-completion Scripts

The MiniJuvix CLI can generate auto-completion scripts. Follow the instructions below for your shell.

NB: You may need to restart your shell after installing the completion script.

Bash

Add the following line to your bash init script (for example ~/.bashrc).

  eval "$(minijuvix --bash-completion-script minijuvix)"

Fish

Run the following command in your shell:

  $ minijuvix --fish-completion-script minijuvix > ~/.config/fish/completions/minijuvix.fish

ZSH