fluorite-8　実装の軌跡　Part 1　背景とPEG.jsの基礎


# 背景

## fluorite-7について

[fluorite-7](https://qiita.com/MirrgieRiana/items/a0906c72ebfb46693ab5)は、2020年2月あたりから実装および公開が進められている創作プログラミング言語です。

## fluorite-7の文書化が進んでいない

fluorite-7の始まりはTwitterのネタであったため、かなり長い間、非公開の場で開発が進められていました。

fluorite-7はのちに公開状態となりましたが、公開前に作られた機能の大半は文書化されていません。そして、文書化は実装に比べて地道で大変な作業となるので、あまり行われていません。

fluorite-7の現行バージョン（2020年11月1日）には、ソースコードにだけ書かれた機能が多数存在します。

## 臭いものに蓋

fluorite-7は次のような問題を抱えており、フルオライト財団はfluorite-7の文書化に苦戦しています。

- ソースファイルが5000行以上あり、非常に読みづらい。
- 後付けの機能によって参照関係がごちゃごちゃでリファクタリングが難しい。
- 後方互換性のために不条理な仕様を維持しなければならない。

フルオライト財団は、fluorite言語シリーズを世に広めるためにfluorite-7の開発と公開を行っている今考えた架空の組織です。

文書化ができないと公開を進めていくうえで困る。そこで、フルオライト財団はfluorite-8（fl8）の開発に乗り出しました。

fluorite-8は初期段階から実装過程を解説することで、積極的にfluorite言語シリーズというミームの種を蒔いていこうという方針で、この記事が作られました。

また、この実装の軌跡がインターネット上でアクセスできる「小規模なプログラミング言語の実装過程の具体例」として残り、そこからなんかなれば幸いです。

# 回の一覧

- [Part 1　背景とPEG.jsの基礎](https://qiita.com/MirrgieRiana/items/56244fee4cdde1b1c7b0)
- [Part 2　中間言語と四則演算](https://qiita.com/MirrgieRiana/items/a32460ae38fe0af71778)
- [Part 3　構文木の経由と符号](https://qiita.com/MirrgieRiana/items/50bbbf62dfb8dbfdb9ea)
- [Part 4　関数と識別子名管理](https://qiita.com/MirrgieRiana/items/f1c10f60ba23ca2f5205)
- [Part 5　変数の宣言と参照](https://qiita.com/MirrgieRiana/items/1da3c5f0613bbdcb77b7)
- [Part 6　代入文と文脈](https://qiita.com/MirrgieRiana/items/3f725acb5bbec2021cc8)
- [Part 7　エラー発生位置の出力](https://qiita.com/MirrgieRiana/items/1da9faf84e2a77cec299)
- [Part 8　配列と文脈リダイレクション](https://qiita.com/MirrgieRiana/items/3853b6c195cb0c8b201b)
- [Part 9　文字列と実行時ライブラリ](https://qiita.com/MirrgieRiana/items/630fefc25aef83a0a401)
- [Part 10　静的型と静的オーバーロード](https://qiita.com/MirrgieRiana/items/c22d9fc6ff7ed977ac74)

# 開発環境

- PEG.js 0.10.0

## PEG.js

Web上で自作の文法を表現できます。

暫くこのオンライン版を使います。

- https://pegjs.org/online

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/280627/3c066c93-2dc7-69c0-c6cf-63129a76ae43.png)

# PEG.jsの使い方

## PEGは正規表現みたいなやつのちょっと違うやつ

[PEG](https://ja.wikipedia.org/wiki/Parsing_Expression_Grammar)とは、正規表現みたいなやつのちょっと違うやつです。

専門的なことはともかく、Perlの正規表現みたいなことができます。

例えば、

```perl:
"100-1234" =~ /^[0-9][0-9][0-9]-[0-9][0-9][0-9][0-9]$/
```

というPerl正規表現があった場合、PEG.jsでは、

```perl:
郵便番号 = [0-9] [0-9] [0-9] "-" [0-9] [0-9] [0-9] [0-9]
```

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/280627/7fdac87a-b12e-66f4-b556-fcd2361b368c.png)

のように記述できます。

文法に違反した文字列を与えた場合は次のようになります。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/280627/c67e2acc-71e0-caf0-0771-8d4e30ccef92.png)

`郵便番号`という文法は3文字と4文字の数字の部分に別れていますが、`100-12345`という入力は後半が5文字あり、想定された「文字列の終端」が存在しなかったため、構文エラーになりました。

**文法にマッチした場合、右の中段の部分が薄緑になります。**

## ルールの一部分を分離・再利用できる

```perl:
郵便番号 = [0-9] [0-9] [0-9] "-" [0-9] [0-9] [0-9] [0-9]
```

というルールは、`[0-9]`という文字列が何度も出てきて少々冗長です。あとから16進数に変えたくなった場合に、

```perl:
郵便番号 = [0-9A-Fa-f] [0-9A-Fa-f] [0-9A-Fa-f] "-" [0-9A-Fa-f] [0-9A-Fa-f] [0-9A-Fa-f] [0-9A-Fa-f]
```

のように7か所も改変しなければなりません。

そこで、

```perl:
郵便番号 = Number Number Number "-" Number Number Number Number
Number = [0-9]
```

のように書くことで、`[0-9]`という文字列を1か所に分離できました。これで後から16進数にしたい場合もコピペ地獄に悩まされずに済みます。

**オンライン版PEG.jsでは、一番上に書かれたルールが主要なルールとして使われます。**

## 入れ子括弧

次の文法を見てみましょう。

```perl:
Formula  = Integer / Brackets
Integer  = [0-9]+
Brackets = "(" Formula ")"
```

`Formula`は式です。式は整数と括弧のどちらかです。
`Integer`は1文字以上の数字の塊、つまり整数です。
`Brackets`は括弧です。括弧の中には式が入ります。

この文法は0組以上の丸括弧で囲われた整数にマッチします。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/280627/80b044fd-96f3-277b-ffb2-14ff29305054.png)

### キャッシュの使用をオンに

ここで再帰的にルールをループするようなコードが書けるようになりましたが、そのようなコードはキャッシュを使わなければ構文解析が劇的に重くなります。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/280627/0be93edc-e271-15b4-deaf-9434a75b1836.png)

以降、オンライン版PEG.jsは`Use results cache`をオンにして使用してください。

## 足し算

前節の文法に足し算を追加してみましょう。

```perl:
Formula  = Term ("+" Term)*
Term     = Integer / Brackets
Integer  = [0-9]+
Brackets = "(" Formula ")"
```

`Term`は項です。項は整数か括弧です。
`Formula`（式）が変わりました。式は1個の項の後に、0個以上の項が`+`記号により連結されたものです。

この文法は`((1+2+345)+((67)))+89`のようなごく単純な数式にマッチします。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/280627/0717666e-8962-4304-a773-f42ac29bc284.png)

## 計算の結果を出したい！

折角数式が入力できるようになったので、計算をしてみたいと思います。

このOutput欄には現在構文木が見えていますが、PEG.jsではこの部分の挙動を自由に実装できます。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/280627/47bb0d20-2139-2537-f4de-0f18a0852da4.png)

### 数字の配列を数値にする

今は`500`という整数ですら、数字が3個集まった配列として処理されています。それは、`Integer  = [0-9]+`の`[0-9]`の部分が数字1個の文字列を表し、`+`がそれが1個以上集まった配列を表すからです。`[0-9]+`は文字列の配列です。

PEG.jsでは、文法要素の左に`名前:`を付け、文法要素列の右端に`{ return 式; }`と書くことで、データを加工することができます。例えば、各数字で構成された配列ではなく、各数字を`|`で結合した文字列を返すようにするには、次のようにします。

```perl:
Formula  = Term ("+" Term)*
Term     = Integer / Brackets
Integer  = main:[0-9]+ {
             return main.join("|");
           }
Brackets = "(" Formula ")"
```

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/280627/db23c0fb-ed22-3746-ca7b-039235266132.png)

`[0-9]+`は「「1文字の数字で出来た文字列」の配列」ですが、それを`main`という名前に割り当てました。式中でその文字列の配列を`main`という名前で受け取り、演算を行って、`main:[0-9]+`部分が表す値として返すことができます。`Integer`のデータ型は、文字列の配列から文字列に変わりました。

----

数値化という特殊な計算を行うには、この式部分を少し変えれば良いわけです。

```perl:
Formula  = Term ("+" Term)*
Term     = Integer / Brackets
Integer  = main:[0-9]+ {
             return parseInt(main.join(""), 10);
           }
Brackets = "(" Formula ")"
```

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/280627/3a105d64-4923-95e1-2c8c-cc3931744ca7.png)

----

また、joinするのが面倒なので、代わりに`main:$[0-9]+`とすることで代用できます。これは`main:($([0-9]+))`と同じ意味です。前置`$`は、付けられた文法要素のデータをその文法要素にマッチした部分の文字列にします。

```perl:
Formula  = Term ("+" Term)*
Term     = Integer / Brackets
Integer  = main:$[0-9]+ {
             return parseInt(main, 10);
           }
Brackets = "(" Formula ")"
```

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/280627/d86f26cc-430b-8995-4df5-c474a56d7978.png)

### 括弧を無機能化する

括弧のルール`Brackets = "(" Formula ")"`を見ると、文法要素が3個並んでいます。このままでは次のように3要素の配列になります。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/280627/f433926c-5ea7-abe9-9b18-1e2428371fcd.png)

欲しいのは中央部だけなので、中央部に名前を付けて取り出してみましょう。

```perl:
Formula  = Term ("+" Term)*
Term     = Integer / Brackets
Integer  = main:$[0-9]+ {
             return parseInt(main, 10);
           }
Brackets = "(" main:Formula ")" {
             return main;
           }
```

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/280627/64b91f99-b704-9ff1-af3e-e1d5ea666c36.png)

見事、括弧が無視されるようになりました。

### 足し算を行う

`Formula  = Term ("+" Term)*`の部分の話です。

ここでは、

```perl:
Formula  = head:Term tail:("+" Term)* {
             何か
           }
```

に何かを入れて各`Term`の和を返したいです。しかし、困ったことに`Term`は数値が来るとは限りません。`Term     = Integer / Brackets`が示すように、`Integer`もしくは`Brackets`のどちらかのデータがやってきます。`Integer`は必ず数値を返すのでいいですが、`Brackets`の値は`Formula`に対応しています。

逆に言うと、`Formula`が常に数値を返すならば、`Term`も常に数値を返すのです！

```perl:
Formula  = head:Term tail:("+" Term)* {
             return 0;
           }
Term     = Integer
         / Brackets
Integer  = main:$[0-9]+ {
             return parseInt(main, 10);
           }
Brackets = "(" main:Formula ")" {
             return main;
           }
```

これで`Term`は何があっても数値だけがやってきます。`Formula`の右辺にある`head`も数値です。`tail:("+" Term)*`は、次のようなデータ構造になっています。

```json:
[
  [
    "+",
    数値
  ],
  ...
]
```

ということは、`head`をまず変数に格納して、その変数に`tail`の各要素の添え字1の要素をすべて加算していけば、その変数は最終的に和を表すことになります。

```perl:
Formula  = head:Term tail:("+" Term)* {
             let result = head;
             for (let i = 0; i < tail.length; i++) {
               result = result + tail[i][1];
             }
             return result;
           }
Term     = Integer
         / Brackets
Integer  = main:$[0-9]+ {
             return parseInt(main, 10);
           }
Brackets = "(" main:Formula ")" {
             return main;
           }
```

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/280627/e310dfee-53f7-7d6c-e750-efcf3eb7c782.png)

見事計算が出来ました！同じ式をGoogle検索に突っ込むと同じ値が帰ってきます。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/280627/d23ec2bd-5429-b016-dc39-7b0989639061.png)

## スペースを許容したい！

スペースを入れられるということは、トークンとトークンの間に「任意個の空白系文字」を追加してもよいという規則になります。「任意個の空白系文字」はPEG.jsの記法で表すと`_ = [ \t\r\n]*`のようになります。これを、「トークンとトークンの間」に1個1個差し込んでいきましょう。

ここでいうトークンは物理的に存在する概念ではなく、人間が「この文字の塊は1個のトークンにしたいなぁ」と思ったら、それがトークンです。

```perl:
Root     = _ main:Formula _ {
             return main;
           }
Formula  = head:Term tail:(_ "+" _ Term)* {
             let result = head;
             for (let i = 0; i < tail.length; i++) {
               result = result + tail[i][3];
             }
             return result;
           }
Term     = Integer
         / Brackets
Integer  = main:$[0-9]+ {
             return parseInt(main, 10);
           }
Brackets = "(" _ main:Formula _ ")" {
             return main;
           }
_        = [ \t\r\n]*
```

`Formula`は`Term+Term+Term`のようなルールです。`+`演算子と`Term`の間にはスペースが入ってもよいため、ここに`_`を追加します。**これにより、`tail`のデータ構造が変わり、`result = result + tail[i][3]`に添え字部分が変わりました。**

`Term`はそれ自体のルール中にトークンが連続する構造がないため、スペースを入れる場所はありません。`/`はどちらでもよいという意味なので、`/`の片側に注目する際は他方の項を無視して考えます。

`Integer`はそれ全体で一つのトークンと解釈したいので、数字と数字の間にスペースは許容（するようにもできるけど）しません。

`Brackets`は左右括弧という2個のトークンがあり、`main`部分とはトークンが分裂しています。なのでその間に`_`を入れます。

更に、`Root`というルールを一番上に追加し、式全体の前後にも空白を許容するようにしました。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/280627/bc3a70cd-56ca-789a-7b3a-ea141b40c1f5.png)

これで、自由にスペースや改行が入れられるようになりました。

## この章のまとめ

ここまでで、オンライン版PEG.jsのデフォルト画面に出ているサンプル文法から減算・乗算・除算を除いたものと同等の文法が出来ました。

- https://pegjs.org/online

# まとめ

- [前作fluorite-7](https://qiita.com/MirrgieRiana/items/a0906c72ebfb46693ab5)は拡張の限界が見えてきた
- fluorite-8は実装の軌跡も資料として公開していきたい
- PEG.jsの基礎的な使い方を解説した
- fluorite-8の実装の話はまだ出てきてない

[次回→](https://qiita.com/MirrgieRiana/items/a32460ae38fe0af71778)