pliron 0.1.3

Programming Languages Intermediate RepresentatiON
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

# Programming Languages Intermediate RepresentatiON

[![Status](https://github.com/vaivaswatha/pliron/actions/workflows/ci.yml/badge.svg)](https://github.com/vaivaswatha/pliron/actions/workflows/ci.yml)

`pliron` is an extensible intermediate representation framework for programming languages,
inspired by [MLIR](https://mlir.llvm.org/docs/LangRef/) and written in safe Rust.

## Build and Test
* Install the [rust toolchain](https://www.rust-lang.org/tools/install).
* `cargo build` and `cargo test` should build the compiler and run the testsuite.
* To see a simple IR constructed (from the [const_ret_in_mod](tests/ir_construct.rs) test),
  use the following command:

      cargo test const_ret_in_mod -- --show-output

  It should print something like:
  ```mlir
  builtin.module @bar {
    block_0_0():
      builtin.func @foo() -> (si64,) {
        entry():
          c0 = builtin.constant 0x0: si64
          llvm.return c0
      }
  }
  ```

## Using the Library
`pliron` is currently in a nascent stage and not yet useful for
real-world use. In the future it can be used by just adding
a dependence to the [crate](https://crates.io/crates/pliron)
in your Rust project.

## Documentation
* Some key design decisions are explained in the
  [introductory blog article](https://github.com/vaivaswatha/pliron/wiki/Introducing-pliron).
* Code documentation can be found on
  [docs.rs](https://docs.rs/pliron/0.1.2/pliron/).