今回読むファイル
読んだのは oxc の rev 1aa5ec11ce です。行番号はすべてこのリビジョンのもので、ズレたときに探せるように関数名とセットで書きます。今回おもに開くのはこのあたりです。
crates/oxc_parser/src/ts/types.rs 1,690行 型の再帰下降。今回の主戦場
crates/oxc_parser/src/ts/statement.rs 962行 型エイリアスの宣言。型の世界の入口
crates/oxc_parser/src/js/statement.rs 932行 文の分岐。型の宣言へ渡す側
今回の題材
前回は連載全体の見取り図を出しただけで終わったので、今回から実物を読んでいきます。
題材はこれです。
type A = string | number;
先にオチを書いておきます。型の文法を読む部分は、教科書に出てくるそのままの再帰下降です。優先順位の段ごとに関数が1つあって、上の段が下の段を呼ぶ。本当にそれだけ。面白いのは、優先順位を書いた表がどこにも無いことです。どの関数がどの関数を呼ぶか、それ自体が優先順位になっています。
今回出てくる関数は、ほぼ全部が ts/types.rs に入っています。型の文法はだいたいこの1ファイルで完結します。
型の入口
まず、そこに辿り着くまでの道から。文を1つ読むたびに通るのはこの経路です。
parse_program lib.rs
└ parse_directives_and_statements js/statement.rs:33 文を1つずつ読むループ
└ parse_statement_list_item js/statement.rs:131 現在のトークンで文の種類を分岐
└ parse_ts_declaration_statement ts/statement.rs:612 修飾子を食べる
└ parse_declaration ts/statement.rs:640 もう一度、種類で分岐
└ parse_ts_type_alias_declaration ts/statement.rs:128
分岐が2回あるのが目を引きます。1回目の parse_statement_list_item はこうなっています。
// js/statement.rs:131 parse_statement_list_item
match self.cur_kind() {
// ... if / for / return など、JS の文の腕がひととおり並んだあと
Kind::Interface | Kind::Type | Kind::Module | Kind::Namespace
| Kind::Declare | Kind::Enum
| Kind::Private | Kind::Protected | Kind::Public
| Kind::Abstract | Kind::Accessor | Kind::Static | Kind::Readonly | Kind::Global
if self.is_ts && self.at_start_of_ts_declaration() =>
{
self.parse_ts_declaration_statement(self.cur_start(), stmt_ctx)
}
_ => self.parse_expression_or_labeled_statement(),
}
14種類が1本の腕にまとまっていて、宣言の頭(type interface enum)と修飾子(declare public readonly)が同居しています。なのでこの時点では「TSの宣言が始まるらしい」までしか分かりません。腕が呼んでいる parse_ts_declaration_statement も、名前のわりに種類を決めず、やるのは修飾子を食べ尽くすことだけです。食べ終わってから、2回目の parse_declaration でようやく本体の種類が決まります。
その腕にはガードが付いていて、それが at_start_of_ts_declaration(ts/statement.rs:863)です。type はJSの予約語ではないので変数名に使えます。type = 1; と書けばただの代入で、実際そう読まれます。
// ts/statement.rs:863 at_start_of_ts_declaration
match self.cur_kind() {
// ...
// `interface I` `type T = …`(キーワード + 同じ行の、束縛できる識別子)
Kind::Interface | Kind::Type => {
let next = self.lexer.peek_token();
next.kind().is_binding_identifier() && !next.is_on_new_line()
}
// ...
}
そして parse_ts_type_alias_declaration(ts/statement.rs:128)が、174行で parse_ts_type() を呼びます。ここが型の世界の入口です。
降下のはしご
ここから下は、優先順位の段がそのまま関数の並びになっています。上から順に並べるとこうです。
parse_ts_type ts/types.rs:15 conditional (extends ... ? ... : ...)
└ parse_union_type_or_higher ts/types.rs:245 縦棒
└ parse_intersection_type_or_higher ts/types.rs:241 アンパサンド
└ parse_type_operator_or_higher ts/types.rs:282 前置の keyof / unique / readonly / infer
└ parse_postfix_type_or_higher ts/types.rs:358 後置の配列とインデックスアクセス
└ parse_non_array_type ts/types.rs:411 プライマリ型の大分配器
ここで注意したいのが、これは「順番に処理される段階」ではなく「呼び出しの入れ子」だということです。上の段の関数は、下の段の関数を呼んで結果を待つだけで、自分の判定は結果が返ってきてから行います。なので keyof T | U を読むときは、こういう順で呼び出しが積まれます。
parse_union_type_or_higher まず1個の要素が欲しい。| の有無はまだ見ていない
└ parse_intersection_type_or_higher 同じく、まず1個の要素が欲しい
└ parse_type_operator_or_higher keyof を見つけて食べ、続きをまた自分で読む → "keyof T"
← "keyof T" を1個の要素として受け取る。ここでようやく次のトークン | を見て、union だと分かる
→ 2個目の要素 U を読みに、また同じ経路を降りる
union が「| 区切りの型かどうか」を判定するのは、1個目の要素を読み終えたあとです。要素を読む作業そのものは、intersectionやprefix、postfixに丸投げしています。段ごとに見ていきます。
一番上は conditional を担当している
はしごの先頭にいる parse_ts_type は、中身が30行しかありません。内容をコメントで追記しています。
// ts/types.rs:15
pub(crate) fn parse_ts_type(&mut self) -> TSType<'a> {
// 1. 関数型とコンストラクタ型は、はしごを丸ごとバイパスする
// 判定は < と new なら即決、abstract は次を1つ覗くだけ、( のときだけ投機パース
if self.is_start_of_function_type_or_constructor_type() {
return self.parse_function_or_constructor_type();
}
// 2. 1つ下の段を呼ぶ。はしごの定型部はこの1行だけ
let ty = self.parse_union_type_or_higher();
// 3. extends が続いていたら conditional 型として組み立てる
if !self.ctx.has_disallow_conditional_types()
&& !self.cur_token().is_on_new_line()
&& self.eat(Kind::Extends)
{
let extends_type = self.context_add(DisallowConditionalTypes, Self::parse_ts_type);
self.expect(Kind::Question);
let true_type = self.context_remove(DisallowConditionalTypes, Self::parse_ts_type);
self.expect_conditional_alternative(question_span);
let false_type = self.context_remove(DisallowConditionalTypes, Self::parse_ts_type);
return TSType::new_ts_conditional_type(/* ... */);
}
ty
}
ここで分かるのが、conditionalの判定はunionを読み終えたあとに来る、ということです。コード中の2で下の段の結果を受け取り、3でその結果に対して extends を見ています。つまり A | B extends C ? X : Y は (A | B) extends C ? X : Y と読まれます。合併型のほうが先に読み終わっていて、その結果がまるごと左辺になるからですね。優先順位の表がどこにもないのに、関数の呼び出し順がそのまま優先順位になっている。これが再帰下降パーサーです。
なお conditional は、はしごのどの段にもぶら下がっていません。parse_ts_type が自分で extends の有無を見て、自分で3つの枝を読みます。はしごの外にいる特別扱いです。
結合の向きも、このコードだけで分かります。falseの場合(false_type)を読むときも、呼んでいるのはまた同じ parse_ts_type です。なので T extends A ? X : T extends B ? Y : Z は T extends A ? X : (T extends B ? Y : Z) と読まれます。
もう1つ、conditionalの条件には改行の判定も入っています。
if !self.ctx.has_disallow_conditional_types()
&& !self.cur_token().is_on_new_line() // ここ
&& self.eat(Kind::Extends)
extends の手前に改行があったら、そもそも条件型として読まない、というガードです。TSでは予約語もメンバー名に使えるので、行が終わった直後に extends で始まる行が来ると、conditionalの開始なのか次のメンバーの名前なのか決まらなくなる。改行が来たらメンバー名の側に倒す、という裁定です。本家の parseType(ts-go parser.go:2659)にも !p.hasPrecedingLineBreak() && p.parseOptional(ast.KindExtendsKeyword) という同じ形があります。tscがそう決めている文法を、oxcはそのまま移植しているようです。
代償として、conditionalの extends を行頭に折り返す書き方ができません。フォーマッタをかけたときに T extends が必ず同じ行に残るのは、整形の好みではなく文法上の制約だったわけですね。
中置の2段は同じ関数
unionとintersectionは、構造が完全に同じです。違うのは区切り記号と、1つ下がどの段かという2点だけ。なので本体は parse_union_type_or_intersection_type(252行)の1つにまとめられていて、その2点を引数で受け取ります。
fn parse_intersection_type_or_higher(&mut self) -> TSType<'a> {
self.parse_union_type_or_intersection_type(Kind::Amp, Self::parse_type_operator_or_higher)
}
fn parse_union_type_or_higher(&mut self) -> TSType<'a> {
self.parse_union_type_or_intersection_type(
Kind::Pipe,
Self::parse_intersection_type_or_higher,
)
}
中身が無くて、引数を変えて同じ本体を呼ぶだけ。Self::parse_type_operator_or_higher はメソッドを関数値として渡す書き方です。受け取る側はこうなっています。
// ts/types.rs:252
fn parse_union_type_or_intersection_type<F>(&mut self, kind: Kind, parse_constituent_type: F) -> TSType<'a>
where
F: Fn(&mut Self) -> TSType<'a>,
{
let has_leading_operator = self.eat(kind); // 先頭の区切り記号があれば食べる
let mut ty = parse_constituent_type(self); // 1つ下の段
if self.at(kind) || has_leading_operator {
let mut types = ArenaVec::from_value_in(ty, self);
while self.eat(kind) { // 区切りを食べては次の要素を読む
types.push(parse_constituent_type(self));
}
ty = match kind {
Kind::Pipe => TSType::new_ts_union_type(span, types, self),
Kind::Amp => TSType::new_ts_intersection_type(span, types, self),
_ => unreachable!(),
};
}
ty // 区切りが無ければ、包まずそのまま返る
}
境界が F: Fn(&mut Self) -> TSType<'a> なので、ジェネリクスとして単相化されます。関数ポインタ経由の間接呼び出しにはなりません。
さっき「次にどの関数を呼ぶかがそのまま優先順位だ」と書きましたが、この2段はその配線を引数として外から差し込んでいる形になります。はしごの段そのものを、値として渡している。
前置の段と後置の段
中置の2段(union / intersection)からはしごを2段降りて、parse_type_operator_or_higher(前置演算子。keyof など)と parse_postfix_type_or_higher(後置演算子。! [] など)です。
前置演算子を受け持つのが parse_type_operator_or_higher(282行)です。keyof / unique / readonly / infer の4つを、先頭トークンを見るだけで振り分けます。左端に演算子が来る形なので、先読みも投機も要りません。ただし infer だけは parse_infer_type という別の関数に飛びます。残り3つとだけ共通の実体を持っています。
実体はこうなっています。
// ts/types.rs:295 parse_type_operator
fn parse_type_operator(&mut self, operator: TSTypeOperatorOperator) -> TSType<'a> {
self.bump_any(); // 演算子を1つ食べる
let ty = self.parse_type_operator_or_higher(); // 自分自身を再帰呼び出し(3つとも共通)
if operator == TSTypeOperatorOperator::Readonly
&& !matches!(ty, TSType::TSArrayType(_))
&& !matches!(ty, TSType::TSTupleType(_))
{
self.error(diagnostics::readonly_in_array_or_tuple_type(operator_span));
}
TSType::new_ts_type_operator_type(/* ... */)
}
自分自身を再帰呼び出ししているので、keyof を重ねて書いた型も自然に通ります。前置演算子の段の定石ですね。
ただし readonly だけ、再帰から戻ったあとに事後チェックが付いています。返ってきた型が配列型でもタプル型でもなければエラーです。readonly string[]; は通り、readonly string; はエラーになります。構文としては3つとも同じ道を通りますが、意味の制約は readonly にしかありません。
後置を受け持つのは parse_postfix_type_or_higher(358行)で、以下は構造を抜粋したコードです。
// ts/types.rs:358
fn parse_postfix_type_or_higher(&mut self) -> TSType<'a> {
let mut ty = self.parse_non_array_type(); // 1つ下から型を1個もらう
while !self.cur_token().is_on_new_line() { // 改行を挟まず同じ行にあるときだけ拾う
match self.cur_kind() {
Kind::Bang => { /* T! で包む */ }
Kind::Question => {
// 次が型の始まりなら、これは conditional の `?` なので手を出さない
if self.lookahead(|p| { p.bump_any(); p.is_start_of_type(false) }) {
return ty;
}
/* T? で包む */
}
Kind::LBrack => {
self.bump_any();
if self.is_start_of_type(false) {
let index_type = self.parse_ts_type(); // T[K]
self.expect(Kind::RBrack);
ty = /* indexed access */;
} else {
self.expect(Kind::RBrack); // T[]
ty = /* array */;
}
}
_ => return ty,
}
}
ty
}
ループの条件が地味に効いていて、! ? [ のような後置の記号は、直前の型と改行を挟まずに同じ行に書かれているときだけ拾われます。本家の parsePostfixTypeOrHigher(ts-go parser.go:2767)にも for !p.hasPrecedingLineBreak() という同じループがあって、腕の並び順まで一致しています。tscがそう決めている文法を、oxcはそのまま移植しているようです。
? の腕には1トークンの先読みが入っています。? の次が型の始まりなら、後置の記号ではなく conditional の ? だと判断して、その場で返してしまう。後置の ? はJSDoc由来の書き方なので、TSの本流である conditional のほうに優先権があります。
[ の腕も見どころで、開き括弧を食べたあと次が型の始まりかどうかで、添字アクセスと配列型に分かれます。同じ入口を通っていて、[ の次の1トークンだけで決まる。ループなので string[][] のような入れ子も、2周するだけで自然に扱えます。
一番下は大きな match
はしごの底、parse_non_array_type(411行)まで降りると、あとは現在のトークンで分配するだけの大きな match です。
// ts/types.rs:411 parse_non_array_type
fn parse_non_array_type(&mut self) -> TSType<'a> {
match self.cur_kind() {
Kind::Any | Kind::Unknown | Kind::String | Kind::Number | Kind::BigInt
| Kind::Symbol | Kind::Boolean | Kind::Undefined | Kind::Never
| Kind::Object | Kind::Null => { /* キーワード型 */ }
Kind::Question => self.parse_js_doc_unknown_or_nullable_type(),
Kind::Bang => self.parse_js_doc_non_nullable_type(),
Kind::Str | Kind::True | Kind::False => self.parse_literal_type(),
kind if kind.is_number() => self.parse_literal_type(),
Kind::NoSubstitutionTemplate => { /* テンプレートリテラル型 */ }
Kind::Minus => { /* -1 のような負のリテラル型 */ }
Kind::Void => { /* ... */ }
Kind::This => { /* this / this is T */ }
Kind::Typeof => self.parse_type_query(),
Kind::LCurly => { /* オブジェクト型 or マップ型 */ }
Kind::LBrack => self.parse_tuple_type(),
Kind::LParen => self.parse_parenthesized_type(),
Kind::Import => TSType::TSImportType(self.parse_ts_import_type()),
Kind::Asserts => { /* asserts x is T */ }
Kind::TemplateHead => self.parse_template_type(false),
_ => self.parse_type_reference(), // 17本目。どれにも当たらなければここ
}
}
並びはキーワード型、リテラル型、{、[、(、import、typeof、asserts、テンプレート型で、どれにも当たらなければ最後の _ から parse_type_reference(822行)に行きます。
この match の腕の一覧は、そのまま「型が始まれるトークンの一覧」として読めます。逆に、ここに無いトークンから型は始まらない。
たとえば < の腕がありません。これは「< で始まる型は関数型しかない」ことの裏返しで、そういう型ははしごに降りてくる前に、parse_ts_type(is_start_of_function_type_or_constructor_type の分岐)で拾われています。
はしごは一直線ではない
ここまで一本道のように書きましたが、実際はもう少しグラフに近い形をしています。プライマリ型の中には、別の型が埋まっているものがあるからです。
たとえば括弧型を読む parse_parenthesized_type(1106行)は、括弧の中身を読むのに parse_ts_type を呼びます。つまり一番上に戻る。インデックスアクセスも同じで、[ を食べた後の添字部分で同じ関数を呼んでいます(392行)。タプルの要素、テンプレート型の穴、型引数の中身も同様です。
なので読み方としては、はしごを降りてプライマリを1個読む、その中に型が埋まっていたら一番上からやり直す、の繰り返しになります。結果として、どんな型もかならず15行と411行の2つを通る。この2か所さえ押さえておけば道に迷わない、というのが実際に読んでみての感触です。
実際に追ってみる
ここまでが地図です。実際に type A = string | number; を流してみます。
トークン列は type / A / = / string / | / number / ; ですね。まず type A = まで、TS固有の文の世界(ts/statement.rs)から見ます。A はここでは型ではなく、ただの識別子として読まれます。
parse_statement_list_item 現在のトークンは type
└ at_start_of_ts_declaration 次の A が束縛できる識別子、同じ行 → true
└ parse_ts_declaration_statement
└ parse_declaration
└ parse_ts_type_alias_declaration type A を食べ、= を expect
ここまでで type A = を消費し終わりました。174行で parse_ts_type() を呼びます。ここからが型の世界です。現在のトークンは string になっています。
parse_ts_type 関数型の判定(86行)は false。はしごに降ります
└ parse_union_type_or_higher Kind::Pipe を持って本体(252行)を呼ぶ
先頭に | は無いので has_leading_operator は false
└ parse_constituent_type() を呼ぶ(まず1個目の要素が欲しい)
└ parse_intersection_type_or_higher
└ parse_type_operator_or_higher keyof等ではないので postfix へ素通り
└ parse_postfix_type_or_higher
└ parse_non_array_type match がキーワード型の腕に当たる
└ parse_keyword_type TSStringKeyword ができる
← "TSStringKeyword" を1個目の要素として受け取る
現在のトークンは | → ここで初めて union だと分かる。2個目の要素を読みに、また同じ経路を降りる
└ parse_constituent_type() をもう一度呼ぶ(さっきと同じ経路)→ TSNumberKeyword
← types = [TSStringKeyword, TSNumberKeyword] から TSUnionType を組み立てる(274行)
oxc本体をクローンして、そのリポジトリの中で次のように流すと、実際の出力を確認できます。
echo 'type A = string | number;' > /tmp/check.ts
cargo run -q -p oxc_parser --example parser -- /tmp/check.ts --estree
実際の出力がこれです。
{
"type": "Program",
"body": [
{
"type": "TSTypeAliasDeclaration",
"id": { "type": "Identifier", "name": "A" },
"typeAnnotation": {
"type": "TSUnionType",
"types": [
{ "type": "TSStringKeyword", "start": 9, "end": 15 },
{ "type": "TSNumberKeyword", "start": 18, "end": 24 }
],
"start": 9,
"end": 24
},
"start": 0,
"end": 25
}
]
}
ついでに範囲も見ておくと、ユニオンのノードは9から24で、string の先頭から number の末尾まで。セミコロンは含まれていません。外側の型エイリアス宣言のほうは0から25でそれを包んでいて、ノードの範囲がきれいに入れ子になっているのが分かります。
段を降りても中間ノードは積もらない
いま5段降りたわけですが、できあがった木は2段しかありません。さっきの parse_union_type_or_intersection_type を、条件のところだけ抜き出します。
let has_leading_operator = self.eat(kind); // 先頭に | があったかどうかのフラグ
let mut ty = parse_constituent_type(self); // まず1個読む
if self.at(kind) || has_leading_operator { // ここが効いている
/* ... types に集めて TSUnionType を組み立てる ... */
}
ty // | が1個も無ければ、1個目の型をそのまま返す
確かめてみます。
type A = string;
{
"type": "TSTypeAliasDeclaration",
"typeAnnotation": { "type": "TSStringKeyword", "start": 9, "end": 15 },
"start": 0,
"end": 16
}
typeAnnotation に TSStringKeyword が直に来ます。union も intersection も前置も後置も全部通過しているのに、痕跡が残らない。段の数だけ無駄なノードが積み上がるような作りにはなっていません。
ついでに、この条件にはもう1つ枝があります。has_leading_operator(1行目)が立っていると、後続に区切りが無くても包みます。
type A = | string;
{
"type": "TSTypeAliasDeclaration",
"typeAnnotation": {
"type": "TSUnionType",
"types": [{ "type": "TSStringKeyword", "start": 11, "end": 17 }],
"start": 9,
"end": 17
},
"start": 0,
"end": 18
}
これは要素が1つだけの TSUnionType になりました。tscでも普通に通ります。
先頭の縦棒は、ユニオン型を複数行に分けて書くときの記法です。
type A =
| string
| number
| boolean;
各行の頭を | で揃えておくと、要素が増えたときの変更差分がきれいになります(末尾に | を置く書き方だと、最後の行だけ形が変わって diff が汚れます)。type A = | string; は、この書き方の要素が1個しかない最小ケースというだけです。書いた人が | を書いた時点でユニオンとして扱う、という設計のおかげで、1行でも複数行でも同じルールで成立しています。
まとめ
型エイリアスの右辺は
parse_ts_type(ts/types.rs:15)から始まり、5段のはしごを降りてparse_non_array_type(411行)に着く優先順位の表はどこにも無く、どの関数がどの関数を呼ぶかがそのまま優先順位になっている。前置の段が後置の段を呼んでいるので、後置のほうが先に読み終わる
段を通過しても、自分の演算子が出てこなければノードは作らない。
type A = string;の結果は TSStringKeyword が1個だけ条件型が右結合になるのも同じ理屈で、falseの場合の枝が一番上を呼び直しているだけ
今回は「素直な型は素直に読まれる」という話だけで終わりました。次回はいったん視点を引いて、oxc というリポジトリそのものの地図を広げます。TypeScript 専用のパーサーというものは存在せず、同じ一つのパーサーが is_ts というフラグで枝を切り替えているだけだ、という話をします。