codec-beam

KO | EN

gitlite — search

#ai #typescript #go #golang #machine-learning #rust #windows #awesome-list #vue #security #pytorch #ios #mcp #openai

(★ 170)

Generate Erlang VM byte code from Haskell

File Explorer

Download Latest Version (.zip)

- example.k
- kaleidoscope.cabal
- Kaleidoscope.hs
- README.md
- - Beam.hs
- Eunit.hs
- Main.hs
.gitignore
.travis.yml
codec-beam.cabal
LICENSE
README.md
stack.yaml

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Build Status](https://travis-ci.org/hkgumbs/codec-beam.svg?branch=master)](https://travis-ci.org/hkgumbs/codec-beam)
[![Erlant/OTP Release](https://img.shields.io/badge/Erlang-OTP--20.3-red.svg)](https://github.com/erlang/otp/releases/tag/OTP-20.3)

Erlang VM byte code assembler for implementing compile-to-beam languages.
The goal is to a provide delightful API for generating BEAM instructions from pure Haskell.

### Usage

This example writes a simple module to a file:

```haskell
{-# LANGUAGE OverloadedStrings #-}
module Main where
import qualified Data.ByteString.Lazy as LBS

import Codec.Beam.Instructions (func_info, label, move, return')
import qualified Codec.Beam as Beam

main :: IO ()
main =
  LBS.writeFile "test_module.beam" $
    Beam.encode "test_module"
      [ Beam.export "tuple_of_one" 0
      ]
      [ label (Beam.Label 1)
      , func_info "tuple_of_one" 0
      , label (Beam.Label 2)
      , move (Beam.Tuple [Beam.Integer 1]) (Beam.X 0)
      , return'
      ]
```

After you run that program, you can load the resulting module from the Erlang shell!

```
$ erl
1> l(test_module).
2> test_module:tuple_of_one().
{1}
```

You can find [a small example on GitHub](https://github.com/hkgumbs/codec-beam/tree/master/example) and a larger one in [my `elm-beam` project](https://github.com/kofigumbs/elm-beam).

### Build

Use [Stack](https://www.haskellstack.org):

```bash
stack build --test
```

### Acknowledgements

Thanks to the following projects, which helped me understand the BEAM file format:

- https://github.com/happi/theBeamBook
 - https://github.com/jerlang/jerlang
 - https://github.com/kolmodin/herl
 - https://github.com/mbrock/HBEAM
 - https://github.com/erlang/otp

codec-beam

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

codec-beam

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README