(rontolisp) docs

Starlark(実験的)

実験的。 rontolisp は Starlark を読みます。Starlark は Bazel のビルドファイルを書くための Python の方言です。読んだプログラムは Common Lisp と同じ コアフォームに変換されるので、.star のプログラムはどのバックエンドでも動きます。準拠は 設計上部分的で、ここにあるものは互換性の保証ではありません。JVM や WebAssembly 上で Starlark のプログラムを試すために使ってください。ずっと動かし続けたいものは Common Lisp で 書いてください。

.star のファイルは Starlark として読まれます。それ以外のファイルと -e では --source-language starlark で指定します。言語はファイルごとに選ばれます。 --starlark-standard spec を指定すると、既定では緩めているトップレベルと再帰についての 仕様の規則を適用します(仕様との差異)。

rontolisp hello.star                                # interpreter
rontolisp hello.star -o Hello.class && java Hello   # JVM
rontolisp hello.star -o hello.wasm && wasmtime run hello.wasm
rontolisp hello.star -o hello-c.wasm --component && wasmtime run hello-c.wasm
rontolisp -e 'print(1 + 2)' --source-language starlark

--no-gc は拒否されます。そのバックエンドには構造体もハッシュテーブルもクロージャもない からです。

プログラムを与えずに --source-language starlark を指定すると、starlark> をプロンプトと する REPL が始まります。式は repr の形で表示され、None は何も表示されません。def、 if、for は空行で終わります。各入力からは、それより前の入力が定義したものが見えます。

このセクションの例はブラウザ上で実行できます。Run はそれぞれを独立したプログラムとして、 新しいインタプリタで実行します。playground は language で Starlark を選ぶと Starlark を読みます。

examples/starlark/ に、期待される出力付きで実行できるプログラムがあります。

[0, 1, 1, 2, 3, 5, 8, 13, 21, 34] 354224848179261915075
f(1, 2.5, None, x="a", y=[1, (2,)])
["quick", "brown", "jumps"] {"quick": 5, "brown": 5, "jumps": 5}

読めるもの

仕様の文法をすべて読みます:

  • デフォルト値、*args、キーワード専用パラメータ、**kwargs を持つ def。lambda。 外側の変数を読むネストした関数。
  • if / elif / else、break と continue を持つ for、return、pass。
  • 名前、要素(a[i] = v)、ターゲットのタプルやリストへの代入と、累算代入(+=、//=、 <<= など)。
  • リスト内包表記と辞書内包表記、条件式、添字とスライス、and / or / not、比較、in、 算術演算子とビット演算子、文字列への %。
  • load。ほかの Starlark ファイル(モジュール)と、Common Lisp のパッケージの 関数(Common Lisp との混在)を読み込みます。

値は None、True と False、大きさに制限のない整数、浮動小数点数、文字列、bytes、 リスト、タプル、辞書、集合、range、関数です。

組み込み関数

関数返すもの
abs(x)整数または浮動小数点数の絶対値
all(x)、any(x)すべての要素が真か、いずれかの要素が真か
bool(x=False)x の真偽
bytes(x)bytes。x 自身、文字列の UTF-8 符号化、またはイテラブルの 0 から 255 の整数
dict(pairs, **kwargs)新しい辞書。辞書またはペアのイテラブルの項目に、名前付き引数を加えたもの
dir(x)x のメソッド名をソートした新しいリスト
enumerate(x, start=0)(添字, 要素) のタプルのリスト
fail(*args, sep=" ")何も返しません。引数をエラーとしてプログラムを終了します
float(x=0)整数、浮動小数点数、真偽値、文字列("1e3"、"inf"、"nan")から作った浮動小数点数
getattr(x, name, default)x に束縛したメソッド name。なければ default、それもなければエラー
hasattr(x, name)x がメソッド name を持つか
hash(x)文字列または bytes のハッシュ値
int(x, base)整数、浮動小数点数、真偽値、または 2 進から 36 進の文字列から作った整数(base=0 は 0x、0o、0b の接頭辞を読みます)
len(x)文字列、bytes、リスト、タプル、辞書、集合、range の要素数
list(x)、tuple(x)イテラブルの要素からなる新しいリスト、またはタプル
max(*args, key=None)、min(*args, key=None)引数の中、または 1 つだけ渡したイテラブルの中で最大、または最小の要素
print(*args, sep=" ")None。引数の str と改行を標準出力に書きます
range(stop)、range(start, stop, step=1)整数の range
repr(x)、str(x)x を表す文字列。repr は文字列を二重引用符で囲みます
reversed(x)逆順の新しいリスト
set(x)イテラブルの要素をその順に持つ新しい集合。set() は空の集合
sorted(x, key=None, reverse=False)ソートした新しいリスト。等しい要素の順序は保たれます
type(x)x の型の名前
zip(*iterables)タプルのリスト。長さは最も短いイテラブルに合わせます

メソッド

型メソッド
listappend, clear, extend, index, insert, pop, remove
dictclear, get, items, keys, pop, popitem, setdefault, update, values
setadd, clear, difference, difference_update, discard, intersection, intersection_update, isdisjoint, issubset, issuperset, pop, remove, symmetric_difference, symmetric_difference_update, union, update
byteselems
stringcapitalize, codepoint_ords, codepoints, count, elem_ords, elems, endswith, find, format, index, isalnum, isalpha, isdigit, islower, isspace, istitle, isupper, join, lower, lstrip, partition, removeprefix, removesuffix, replace, rfind, rindex, rpartition, rsplit, rstrip, split, splitlines, startswith, strip, title, upper

メソッドはレシーバに対して呼び出すか、レシーバに束縛された値として取り出します:

<built-in method append of list value> ["a"] 2 0

集合は要素を最初に加えた順に保ちます。|、&、-、^ は新しい集合を返し、|=、&=、 -=、^= は左辺の集合を変更します(|= は辞書も変更します)。bytes は 0 から 255 の整数の 変更できない列です。添字は整数を、スライスは bytes を返し、str は UTF-8 として復号します。

set([3, 1, 2]) set([1, 2]) True b"hé" 3 104 é

リスト、辞書、集合は、それを走査するループの実行中には変更できません。ほかのエラーと同じく、 変更しようとするとプログラムが終了します:

$ cat loop.star
xs = [1, 2]
for x in xs:
    xs.append(x)
$ rontolisp loop.star
Unhandled condition: cannot append to list during iteration
  at loop.star:3

代入前の変数を読むことも、ローカル変数かグローバル変数かにかかわらず同じくエラーです。 def より上に書いたその関数の呼び出しもエラーです。

モジュール

load("words.star", "shout", count = "COUNT") はほかのファイルを実行し、そのグローバル変数を 読み込む側のファイルの名前に束縛します。shout はモジュールの shout に、count は モジュールの COUNT に束縛されます。パスは、この文を書いたファイルからの相対パスです。

  • モジュールは、いくつのファイルから読み込まれても、プログラムごとに 1 回だけ実行されます。 実行されるのは、最初の load の位置です。
  • モジュールのグローバル変数はそのモジュールだけのものです。2 つのファイルがどちらも helper を定義できます。
  • アンダースコアで始まる名前は読み込めません。モジュール自身が load で得た名前も 読み込めません。
  • ファイルがない場合、モジュールが定義していない名前を指定した場合、読み込む側のファイルを モジュールが読み込み返す場合は、プログラムの実行前にエラーになります。
  • モジュールはコンパイル時に読まれるので、コンパイルしたプログラムにはモジュールが 含まれます。

ファイルの実行が終わると、その実行中に作られたリスト、辞書、集合は凍結されます。 凍結 された値を変更しようとするとエラーになります。そのファイルの関数があとで呼び出されたときに 作るリスト、辞書、集合は、呼び出した側のものです。凍結されたリストは辞書のキーにできます。

$ cat words.star
print("words runs")
seen = ["start"]
def shout(s):
    return s.upper() + "!"
$ cat main.star
load("words.star", "shout", "seen")
print(shout("hello"), seen, {seen: 1})
seen.append("more")
$ rontolisp main.star
words runs
HELLO! ["start"] {["start"]: 1}
Unhandled condition: cannot append to frozen list
  at main.star:3

このセクション

  • Common Lisp との混在 -- 1 つのプログラムの中で、Common Lisp のファイルと Starlark のファイルが互いにどう見えるか。
  • 仕様との差異 -- このフロントエンドが仕様と異なる点と、まだないもの。