PHP で型付のローカル変数を定義するライブラリを作った

# 概要

PHP で型のあるローカル変数を定義するライブラリを作った。

https://github.com/sj-i/typist

誤った型の値を代入しようとすると `\TypeError` を投げる。

型を書ける奴だから TypeWriter か、とも思ったけど、長かったので Typist という名前にした。
PHP 7.4 以降で利用可能。

# インストール
```
composer require sj-i/typist
```

# 基本的な使い方
```php
use function Typist\int;
use function Typist\string;

// int 型と string 型のローカル変数を定義
$_ = [
	int($hoge_id, 1),
	string($hoge_name, 'name'),
];

// 渡した値で初期化される
assert(1 === $hoge_id);
assert('name' === $hoge_name);

// int 型の変数へ文字列を突っ込もうとすると TypeError
$hoge_id = 'a';

// string 型の変数へ int の値を突っ込もうとすると TypeError
$hoge_name = 1;
```

# どうなってんの？
PHP 7.4 で[型付プロパティ](https://www.php.net/manual/ja/migration74.new-features.php#migration74.new-features.core.typed-properties)が導入された。
こいつには面白い性質があって、ある変数が型付プロパティと同じものを参照している間、その変数は同じものを参照する全ての型付プロパティで宣言された型の制約を引き継いで受けることになる。
よって指定した型の型付プロパティを持つオブジェクトを生成し、参照渡し経由で変数を型付プロパティに参照させ、オブジェクトは GC されないよう使わない変数 `$_` でつかまえておくことで、この型付ローカル変数も実現できる。

# なるほど分からん
[型付プロパティの RFC](https://wiki.php.net/rfc/typed_properties_v2#references) に詳しく書いてある。
ピンとこないとしたら、たぶん PHP における参照がどういう意味のものか、がピンとこないのだと思う。俺もこの RFC を見るまでよく分かっていなかった。ので、PHP の参照について簡単に説明しよう。

# PHP の参照

```php
$a = 1;
$b =& $a;
$c =& $b;
```

上記のようなコードについて考えよう。
最初の 1 行目 `$a = 1;` の状態を雑に図示するとこう。

![Untitled Diagram.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/81258/fcb367fe-61ef-386b-c1d2-a29ee4f26f1f.png)

超シンプル。

次に 2 行目の `$b =& $a;` の状態を、同じく雑に図示するとこう。

![Untitled Diagram (3).png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/81258/899a6fe4-85d2-31e9-91f8-d72da84bac58.png)


`$b` は `$a` を指すというより、`$a` が指すものと同じものを指す仲間に加わる感じ。

そしてお察しのとおり、更にその次の `$c =& $b;` の状態はこうなる。

![Untitled Diagram (2).png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/81258/d85c247a-3ebd-ceb6-464c-6b96faa9ec01.png)

`$c` が `$b` を指すように、と数珠つなぎになっていくわけではなく、やはり同じものを指す仲間に加わる感じ。

同じものを指す仲間達をひとまとめにし、（型付プロパティの RFC の言葉を借りて）参照セットとでも呼ぶことにしよう。参照セットにあるどの変数への代入も、同じセット内の他の変数の値へ影響する。同時に一括代入しているようなもの、というとらえ方もできる（実際の実装は異なるが、概念的にはそうもとらえられる）。

# 参照と型付プロパティ

さて、この参照セットのメンバへ、型付プロパティが含まれている場合は何が起きるだろうか？

![Untitled Diagram (4).png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/81258/dc1f5b7c-cf59-cc4a-66e8-25b60a3af549.png)

プロパティだと `$a` とか `$b` のままじゃ不自然なので、オブジェクト `$o` のプロパティだということにしよう。

```php
$o = new class() {
    public int $a = 1;
    public float $b;
};
$o->b =& $o->a;
$c =& $o->b;
```

![Untitled Diagram (5).png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/81258/1f09206c-c4df-777a-c509-29d2c7bdaa62.png)


型付プロパティは、プロパティが宣言された型の値を持つこと、読み込み時に指定した型の値だけが得られることを保証する仕組み。これを実現するには代入時に値の型の検査が必要。

`$o->a` へ何かの値を代入するとする。

```php
$o->a = 1; // 合法
$o->a = 'abc'; // $o->a の型宣言は int なので違法、TypeError
```

分かりやすい。

しかし、次の例ではどうだろう。

```php
$o->b = 1.5; // 合法……？
var_dump($o->a); // $o->a の型宣言は int なのに 1.5 とか出ちゃうの……？
```

あるいはまた、次の例ではどうだろう。

```php
$c = new DateTime(); // 合法……？
var_dump($o->a); // $o->a の型宣言は int なのに現在日時が出ちゃうの……？
```

同じ参照セットに含まれる全ての型付プロパティの型で型検査を行い、すべての型検査に通る値だけが代入に成功するのでなければまずい。型宣言によって得られる筈の保証が台無しになってしまう。そして実際に、PHP はそのように順繰りの型検査を行う。

`1` は `int` の型検査にも `float` の型検査にも通るので代入可能。
`1.5` は `int` の型検査を通らないので代入不可能。
日時型は `int` の型検査にも `float` の型検査にも通らないので代入不可能。

このようにして、型付プロパティと同じ参照セットのメンバであるただのローカル変数 `$c` は、めでたく代入時に型検査の行われる変数になった、というわけだ。

この参照と型付プロパティについての挙動を把握すると、うまくやれば型付ローカル変数を定義するためのライブラリを作れそうな気がしてくる。

# 既存の実装
先に今回とってない実装方針について、他実装を紹介しつつざっくり説明。

型付プロパティの参照を取り出して参照代入でローカル変数へ突っ込めば、その変数は元の型付プロパティと同じ型の検査を受けるローカル変数になる。

[比類なき nikic の人](https://nikic.github.io/)が Poor Man's Typed Variables として紹介してるのはこちらの方針。

- [Typed Properties and more: What's coming in PHP 7.4?](https://www.slideshare.net/nikita_ppv/typed-properties-and-more-whats-coming-in-php-74)

```php
function &int(int $i) {
    $obj = new class { public int $prop; };
    $obj->prop = $i;
    $GLOBALS['huge_memory_leak'][] = $obj;
    return $obj->prop;
}
$i =& int(0);
$i = "foobar";
// Uncaught TypeError: Cannot assign string to
// reference held by property class@anonymous::$prop
// of type int
```

このスライドの実装を見ると分かる通り、型付プロパティを持つオブジェクト（以下型付プロパティオブジェクト）を GC させないよう、refcount[^1] を保つためにグローバル変数へ生成したオブジェクトを突っ込んでる。もちろんめっちゃメモリリークする。

[^1]: （「参照カウント」と呼ぶと紛らわしい話の流れなので refcount 呼ばわり）

[azjezz/typed](https://github.com/azjezz/typed) という、型付プロパティの参照で型付ローカル変数を、というのをやってる別ライブラリがある。こちらもおおむね同じやり方。虚空から欲しい型の値を生成してる感を出すため、各変数について生成する型付プロパティオブジェクトは[グローバルステートへ突っ込み](https://github.com/azjezz/typed/blob/426a075e834d41383010a6fe51b073b848fb7d3c/src/Typed/functions.php#L65)、refcount を維持する。もちろんめっちゃメモリリークするので、[手動のメソッド呼び出しで型付プロパティオブジェクトを開放する方法](https://github.com/azjezz/typed/blob/426a075e834d41383010a6fe51b073b848fb7d3c/src/Typed/functions.php#L284-L322)を提供している。

[らなくあさん](https://qiita.com/rana_kualu)が以前に紹介していたこの手法の例示も、先にオブジェクトを生成し、プロパティの参照代入でローカル変数へ持ってくるというやり方↓。

- [【PHP7.4】PHP7.4では変数に型指定できる & 菱形継承っぽいものができる](https://qiita.com/rana_kualu/items/8337e5ead7d52badf3e1#%E5%A4%89%E6%95%B0%E3%81%AE%E5%9E%8B%E6%8C%87%E5%AE%9A)


これらの実装を見ての感想は↓のような感じ。

- **なんとなく**参照代入の `&` が**かわいくない気がする**
- メモリ管理をそんなに頑張りたくない
- 利用側で謎オブジェクトを生成するのは嫌、なんかそれっぽい関数経由で変数定義したい

# 今回の実装

- `&` が露出しないよう[参照渡し](https://github.com/sj-i/typist/blob/99f1ecfc3fb374ed5e14b63f4b478bd339fe1cf7/src/Typist/Typist.php#L40-L43)を[利用](https://github.com/sj-i/typist/blob/99f1ecfc3fb374ed5e14b63f4b478bd339fe1cf7/src/Typist/IntEnforcer.php#L23-L25)した
	- 型付きプロパティが型を付けたい変数と同じ参照セットに入ればよいのだから、プロパティからの参照代入ではなくプロパティへの参照代入でも同じことができる、というわけだ
	- 型指定で参照渡しした変数は [psalm が別の型による再代入へ警告をくれる](https://psalm.dev/r/110e4397a2)ので、静的解析へも対応
- 参照渡しの利用によって返り値の枠が空いたので、メモリ管理を頑張らないで済むよう型付プロパティオブジェクト（Enforcer）をそのまま return し、ローカル変数で受け取って、呼び出し側でライフタイムを管理する仕組みにした
	- refcount 維持用に持つだけでアクセスの必要はないオブジェクトなので、見た目の存在感が薄めのローカル変数として `$_` という配列を用意し、そこへ突っ込んでいく
	- `$_` は psalm のような静的解析ツールで[未使用変数警告を出さず無視してくれる](https://github.com/vimeo/psalm/issues/540#issuecomment-368156152)名前でもある
- [静的メソッドと通常関数の二通りのインターフェース](https://github.com/sj-i/typist#basic-usage)を用意した
- 今のところスカラ型とクラス / interface、nullable の型指定に対応
	- iterable とか array もやれそう、ただ要素型指定できない奴とか要らない気もする
	- callable はとりあえず諦め

# お前この裏技に否定的じゃなかったっけ？使い道は？
- PHP 7.4 リリース前の[去年 1 月](https://php-genba.shin1x1.com/26)時点でわりと否定的なことを言ってた
- [つい最近](https://twitter.com/sji_ch/status/1282482504130195456)また同様に否定的なことを言う機会があった
- その流れで、PHP 8 の機能を使って何か面白いことやれないかな、とガチャガチャ試す時、そういえばこんなのあったなと[少し書いてみる](https://3v4l.org/hNJnK)のにつながる
- ガチャガチャやってる間にそれっぽいライブラリになってしまったので、一応公開、という形
- ローカル変数の型を実行時に強制するのがそんなに有用か、には引き続き懐疑的姿勢
- PHP 7.4 までの言語の型機能と静的解析ツールの型推論に型アノーテーション、それに加えて [webmozart/assert](https://github.com/webmozart/assert) あたりで用足りるのではないか
	- クラスだのメソッドだの関数だの適度に小分けにコード書いてると、ローカル変数はごく短命となる筈で、引数や返り値のような断続的な型チェックでもわりと用が足りてしまい、こういうハックの有用性は薄れる筈
- ローカル変数の寿命が長く型の動きが不安なコード、であれば、こういうのも多少使う意味があるかもしれない（PHP 7.4 だけど魂はレガシーコード、みたいな奴があれば）
- 静的解析向けの型アノーテーションは油断すると嘘をつく場合もあるので、不安な箇所でランタイムのチェックも足す用、という意味はあるかもしれない

# おまけ
- PHP 8 で[クラス定数に class-string を突っ込んで `A::B::C::D::E` のように延々解決していく](https://wiki.php.net/rfc/variable_syntax_tweaks#class_constant_dereferencability)、という謎の連鎖ができるようになったので、記念に [やや言語内 DSL っぽい雰囲気を感じる書き方](https://github.com/sj-i/typist/tree/99f1ecfc3fb374ed5e14b63f4b478bd339fe1cf7#nullable-types) を PHP8 ではできるようにしてみた。はやく PHP8 も来るといいな！