README

概要

• Erlangの項(のバイナリ表現)とCommon Lispのオブジェクトの相互変換を行う
• Common LispとErlangのポート経由(open_port)での通信時の利用を想定

注意事項

• 文字列を扱う場合、使用するCommon Lispの処理系がユニコード(UTF-32)に対応していないと文字化けが生じる可能性がある

  • Erlangと文字列をやりとりする場合に、常に文字列をバイナリ(UTF-8)として扱うようにすれば、一応回避はできるはず

• DestributionHeader,ATOM_CACHE_REF及び圧縮形式には未対応

  • 上記のいずれもポート経由で通信を行う場合は不要なので、今回は実装から外している

インストール方法

* (require :asdf)
* (require :asdf-install)
* (asdf-install:install "erlterm-0.0.1.tar.gz")

変換ルール

• Erlang <=> Common Lisp
• 数値 <=> 数値
• 文字列 <=> ユニコード値のリスト
  • Erlangの文字列の文字のコード値が全て0x100の場合で、かつ長さが0x10000未満の場合は、Common Lisp側でも文字列に変換される
  • Common LispからErlangへの変換時には文字列は文字列に変換される
• アトム <=> キーワード
  • 相互変換の際には名前の大文字小文字が入れ替わる
  • Common LispからErlangへの変換時には通常のシンボルもアトムに変換される
• リスト <=> リスト
• タプル <=> 配列
• バイナリ <=> バイト配列:(vector (unsigned-byte 8))
• ビットバイナリ <=> ビット配列:bit-vector
• 参照 <=> erlterm::reference or erlterm::new-reference
• ポート <=> erlterm::port
• PID <=> erlterm::pid
• 関数 <=> erlterm::fun or erlterm::new-fun
• エクスポート <=> erlterm::erl-export

API

Package# erlterm

メインパッケージ

Function# decode-term (binary-input-stream &key (packet nil)) => term

Erlang項のバイナリエンコーディングをCommon Lispのオブジェクトにデコードする。

binary-intput-stream: 入力元のバイナリストリーム  
packet: バイナリデータ本体の前に、受信するバイトの長さが付与されている場合は、そのサイズデータのバイト長を指定する。  
          サイズデータが付与されていない場合はnilを指定する。  
          (member nil 1 2 4)  
          ※ 現バージョンでは、このサイズデータは単に読み捨てられている。  
term: デコードされたCommon Lispオブジェクト

Function# encode-term (term binary-output-stream &key (packet nil) (minor-version 0)) => t

Common LispのオブジェクトをErlang項のバイナリフォーマットにエンコードする

term: エンコード対象となるオブジェクト  
binary-output-stream: バイナリデータ出力先のストリーム  
packet: バイナリデータ本体の前に、出力バイト数を付与する場合は、そのサイズデータに用いるバイト長を指定する。  
        サイズデータを付与しない場合はnilを指定する。
        (member nil 1 2 4)
minor-version: バイナリフォーマットのマイナーバージョン。
               0 or 1。
               1の場合は浮動小数点数のエンコーディングに、新しいフォーマットが使用される。

参照

• Erlang項のバイナリフォーマット
  • http://www.erlang.org/doc/apps/erts/erl_ext_dist.html

使用例

ポートを使った通信例:

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;; Common Lisp側# リストの反転を行う
;;;; ファイル名: reverse.lisp
;;;;
;;;; 処理系: sbcl-1.0.40  
;;;;         ※ 標準入出力に対してバイナリ操作が行えるのは(おそらく)SBCLの拡張
(require :asdf)
(require :erlterm)

(defvar *in* *standard-input*)
(defvar *out* *standard-output*)

(handler-case
  (loop
    (let ((list (erlterm:decode-term *in* :packet 2)))      ; リストを受け取る
      (erlterm:encode-term (reverse list) *out* :packet 2)  ; 反転して返す
      (force-output *out*)))
  (end-of-file ()
    'done))

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%% Erlang側(補助モジュール)# ポート関連の操作をラップ
%%%% ファイル名: port_rpc.erl
-module(port_rpc).
-export([open/1,close/1,call/2]).

open(Command) ->
    open_port({spawn, Command}, [{packet, 2},binary]).

close(Port) ->
    Port ! {self(), close}.

call(Port, Message) ->
    Port ! {self(), {command, term_to_binary(Message)}},
    receive 
        {Port, {data, Data}} -> binary_to_term(Data)
    end.

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%% Erlang側(shell)# Common Lispとの通信
> c(port_rpc). % コンパイル & ロード

> Port = port_rpc:open("sbcl --script reverse.lisp").     % ポートオープン

> port_rpc:call(Port, [first, {1, "middle", 3.2}, last]). % Common Lisp呼び出し
  => [last, {1, "middle", 3.2}, first]                    % => 反転されたリストが返る

> port_rpc:close(Port).                                   % ポートクローズ

TODO

• 全体的な最適化
• コード整理
• 包括的なテスト
• 未実装機能の実装
• 適切なエラー処理