[インデックス 11344] ファイルの概要

本コミットは、Goコンパイラ（gc）におけるエラーメッセージの改善を目的としています。具体的には、曖昧なセレクタ（フィールドまたはメソッド）参照に関するエラーメッセージにおいて、「DOT reference」という表現をより明確な「selector」または具体的な状況説明に修正しています。これにより、開発者がエラーの原因をより正確に理解しやすくなります。

コミット

commit bf0c190343c094d80e4f675863ab506c3456962f
Author: Russ Cox <rsc@golang.org>
Date:   Mon Jan 23 15:10:53 2012 -0500

    gc: avoid DOT in error messages
    
    R=ken2
    CC=golang-dev
    https://golang.org/cl/5573047

GitHub上でのコミットページへのリンク

https://github.com/golang/go/commit/bf0c190343c094d80e4f675863ab506c3456962f

元コミット内容

gc: avoid DOT in error messages

R=ken2
CC=golang-dev
https://golang.org/cl/5573047

変更の背景

この変更の背景には、Goコンパイラが生成するエラーメッセージの明確性向上という目的があります。Go言語では、構造体のフィールドやインターフェースのメソッドにアクセスする際にドット（.）演算子を使用します。これを「セレクタ」と呼びます。しかし、特定の状況下で、コンパイラがどのフィールドまたはメソッドを指しているのかを特定できない「曖昧な参照」が発生することがあります。

以前のエラーメッセージでは、このような曖昧な状況を「ambiguous DOT reference」と表現していました。しかし、「DOT reference」という言葉は、Go言語の仕様や一般的なプログラミング用語において、必ずしも明確な専門用語ではありませんでした。より正確で理解しやすいエラーメッセージを提供することで、開発者がコンパイルエラーに遭遇した際に、その原因を迅速に特定し、コードを修正する手助けとなることが期待されます。

このコミットは、Go言語の初期段階におけるコンパイラのエラー報告の洗練化の一環として行われました。よりユーザーフレンドリーな開発体験を提供するためには、エラーメッセージの質が非常に重要であるという認識に基づいています。

前提知識の解説

Goコンパイラ (gc)

gcは、Go言語の公式コンパイラです。Goのソースコードを機械語に変換する役割を担っています。コンパイルの過程で、構文解析、型チェック、最適化、コード生成など、様々な段階を経て実行可能ファイルを生成します。エラーメッセージは、このコンパイル過程で検出された問題点を開発者に伝えるための重要なインターフェースです。

セレクタ (Selector)

Go言語において、セレクタとは、構造体のフィールドやインターフェースのメソッドにアクセスするために使用されるドット（.）演算子に続く識別子のことです。例えば、myStruct.myField の myField や myInterface.myMethod() の myMethod がセレクタにあたります。

曖昧なセレクタ参照 (Ambiguous Selector Reference)

Go言語では、埋め込みフィールド（embedded fields）やインターフェースの実装などにより、複数の型が同じ名前のフィールドやメソッドを持つことがあります。このような状況で、コンパイラがどのフィールドまたはメソッドを指しているのかを明確に判断できない場合、「曖昧なセレクタ参照」としてエラーが報告されます。例えば、ある構造体が、異なる2つの埋め込み構造体から同じ名前のフィールドを継承している場合などが該当します。

yyerror 関数

yyerrorは、Goコンパイラ（gc）の内部で使用されるエラー報告関数です。コンパイル中に構文エラーや型エラーなどの問題が検出された際に、この関数を呼び出してエラーメッセージを標準エラー出力に出力します。yyerrorはC言語で書かれたコンパイラの慣習的なエラー報告メカニズムであり、フォーマット文字列と可変引数を受け取ってエラーメッセージを生成します。

src/cmd/gc/subr.c および src/cmd/gc/typecheck.c

これらはGoコンパイラのソースコードの一部です。

• src/cmd/gc/subr.c: コンパイラの様々なユーティリティ関数や補助ルーチンが含まれています。このファイルには、型システムやシンボル解決に関連する一部のロジックも含まれることがあります。
• src/cmd/gc/typecheck.c: Goコンパイラの型チェックフェーズを担当する主要なファイルです。Go言語の型システムに従って、式の型が正しいか、変数への代入が適切か、関数呼び出しの引数が正しいかなどを検証します。セレクタの解決（どのフィールドやメソッドが参照されているかを決定するプロセス）もこのフェーズで行われます。曖昧なセレクタ参照の検出は、主にこのファイル内のロジックによって行われます。

技術的詳細

このコミットの技術的詳細は、Goコンパイラの型チェックフェーズにおけるエラーメッセージの生成ロジックに焦点を当てています。

Goコンパイラは、ソースコードを解析し、抽象構文木（AST）を構築した後、型チェックを行います。型チェックの過程で、ドット（.）演算子によるセレクタ参照が解決されます。この解決プロセスでは、指定された型（T）が、指定されたシンボル（S、つまりフィールド名やメソッド名）を持つかどうか、そしてそのシンボルが曖昧でないかを判断します。

以前の実装では、曖昧なセレクタ参照が検出された際に、yyerror関数を用いて「ambiguous DOT reference %T.%S」という形式のエラーメッセージを出力していました。ここで、%Tは型、%Sはシンボル（フィールド名またはメソッド名）を表します。

このコミットでは、このエラーメッセージの文言が変更されました。

1. src/cmd/gc/subr.c の adddot 関数内:

   • yyerror("ambiguous DOT reference %T.%S", t, s); が
   • yyerror("ambiguous selector %T.%S", t, s); に変更されました。 これは、一般的な「DOT reference」という表現を、Go言語の文脈でより正確な「selector」という用語に置き換えるものです。

2. src/cmd/gc/typecheck.c の lookdot1 関数内:

   • yyerror("ambiguous DOT reference %T.%S", t, s); が
   • yyerror("ambiguous selector %T.%S", t, s); に変更されました。 これも同様に、「DOT reference」を「selector」に置き換える変更です。lookdot1関数は、型tとシンボルsに対して、ドット参照を解決しようとする際に使用されます。

3. src/cmd/gc/typecheck.c の lookdot 関数内:

   • yyerror("ambiguous DOT reference %S as both field and method", n->right->sym); が
   • yyerror("%S is both field and method", n->right->sym); に変更されました。 この変更はさらに踏み込んでおり、「ambiguous DOT reference」という冗長な表現を完全に削除し、エラーの具体的な原因（「%Sがフィールドとメソッドの両方である」）を直接的に伝えるメッセージに修正しています。lookdot関数は、あるシンボルがフィールドとしてもメソッドとしても存在し、どちらを指しているか曖昧な場合にこのエラーを報告します。

これらの変更は、コンパイラのエラーメッセージが、単に問題があることを示すだけでなく、その問題が具体的に何であり、どのように解決すべきかを示唆するものであるべきだという設計思想に基づいています。より正確な用語を使用し、冗長な表現を避けることで、開発者のデバッグ体験が向上します。

コアとなるコードの変更箇所

本コミットでは、以下の2つのファイルが変更されています。

1. src/cmd/gc/subr.c
2. src/cmd/gc/typecheck.c

具体的な変更行は以下の通りです。

diff --git a/src/cmd/gc/subr.c b/src/cmd/gc/subr.c
index 4e9f9e05fd..9c31dace4c 100644
--- a/src/cmd/gc/subr.c
+++ b/src/cmd/gc/subr.c
@@ -2156,7 +2156,7 @@ adddot(Node *n)
 
 out:
  	if(c > 1)
- 		yyerror("ambiguous DOT reference %T.%S", t, s);
+ 		yyerror("ambiguous selector %T.%S", t, s);
 
  	// rebuild elided dots
  	for(c=d-1; c>=0; c--)
diff --git a/src/cmd/gc/typecheck.c b/src/cmd/gc/typecheck.c
index 1092608dc9..f9f0d8b301 100644
--- a/src/cmd/gc/typecheck.c
+++ b/src/cmd/gc/typecheck.c
@@ -1564,7 +1564,7 @@ lookdot1(Sym *s, Type *t, Type *f, int dostrcmp)
  		if(f->sym != s)
  			continue;
  		if(r != T) {
- 			yyerror("ambiguous DOT reference %T.%S", t, s);
+ 			yyerror("ambiguous selector %T.%S", t, s);
  			break;
  		}
  		r = f;
@@ -1656,7 +1656,7 @@ lookdot(Node *n, Type *t, int dostrcmp)
 
  	if(f1 != T) {
  		if(f2 != T)
- 			yyerror("ambiguous DOT reference %S as both field and method",
+ 			yyerror("%S is both field and method",
  			 			n->right->sym);
  		if(f1->width == BADWIDTH)
  			fatal("lookdot badwidth %T %p", f1, f1);

コアとなるコードの解説

変更された各行は、Goコンパイラが曖昧なセレクタ参照を検出した際に表示するエラーメッセージの文字列を修正しています。

1. src/cmd/gc/subr.c の adddot 関数内:

   • 変更前: yyerror("ambiguous DOT reference %T.%S", t, s);
   • 変更後: yyerror("ambiguous selector %T.%S", t, s); adddot関数は、ドット演算子による参照を処理する際に呼び出される可能性があります。ここで、複数の候補が見つかり曖昧であると判断された場合、エラーが報告されます。「DOT reference」という一般的な表現を、Go言語の文脈でより適切な「selector」という用語に置き換えることで、メッセージの専門性と正確性が向上しています。%Tは型、%Sはシンボル（フィールド名やメソッド名）のプレースホルダーです。

2. src/cmd/gc/typecheck.c の lookdot1 関数内:

   • 変更前: yyerror("ambiguous DOT reference %T.%S", t, s);
   • 変更後: yyerror("ambiguous selector %T.%S", t, s); lookdot1関数は、特定のシンボルsが型tのフィールドまたはメソッドとして存在するかどうかを検索し、その解決を試みます。複数の有効な候補が見つかり、どちらを指すべきか曖昧な場合にこのエラーが報告されます。ここでも同様に、「DOT reference」から「selector」への変更が行われ、エラーメッセージの明確化が図られています。

3. src/cmd/gc/typecheck.c の lookdot 関数内:

   • 変更前: yyerror("ambiguous DOT reference %S as both field and method", n->right->sym);
   • 変更後: yyerror("%S is both field and method", n->right->sym); lookdot関数は、あるシンボルが、同じ型内でフィールドとしてもメソッドとしても定義されている場合に、その参照が曖昧であると判断します。この場合、以前は「ambiguous DOT reference %S as both field and method」というメッセージでした。この変更では、「ambiguous DOT reference」という冗長な前置きを削除し、直接的に「%S is both field and method」（%Sはフィールドとメソッドの両方である）と伝えることで、エラーの原因をより簡潔かつ明確に示しています。n->right->symは、曖昧な参照を引き起こしているシンボル（名前）を指します。

これらの変更は、Goコンパイラのエラーメッセージが、開発者にとってより理解しやすく、デバッグの助けとなるようにするための細かな、しかし重要な改善です。

関連リンク

• Go Change List (CL) 5573047: https://golang.org/cl/5573047

参考にした情報源リンク

• Go言語の公式ドキュメント (セレクタ、型システム、埋め込みフィールドに関する情報): https://go.dev/doc/
• Goコンパイラのソースコード (特に src/cmd/gc ディレクトリ): https://github.com/golang/go/tree/master/src/cmd/compile
• Go言語の仕様 (セレクタの定義): https://go.dev/ref/spec#Selectors
• Go言語におけるエラーメッセージの重要性に関する一般的な議論 (Web検索による): "Go compiler error message clarity" など