Skip to content

Commit

Permalink
go/types, types2: better error message when using *interface instead …
Browse files Browse the repository at this point in the history
…of interface

- detect *interface case and report specific error
- replaced switch with sequence of if's for more clarity
- fixed isInterfacePtr: it applies to all interfaces, incl.
  type parameters
- reviewed/fixed all uses of isInterfacePtr
- adjusted error messages to be consistently of the format
  "type %s is pointer to interface, not interface"

Fixes #48312.

Change-Id: Ic3c8cfcf93ad57ecdb60f6a727cce9e1aa4afb5d
Reviewed-on: https://go-review.googlesource.com/c/go/+/376914
Trust: Robert Griesemer <gri@golang.org>
Reviewed-by: Robert Findley <rfindley@google.com>
  • Loading branch information
griesemer committed Jan 10, 2022
1 parent 1f411e9 commit 6019a52
Show file tree
Hide file tree
Showing 14 changed files with 145 additions and 83 deletions.
64 changes: 37 additions & 27 deletions src/cmd/compile/internal/types2/call.go
Original file line number Diff line number Diff line change
Expand Up @@ -531,41 +531,51 @@ func (check *Checker) selector(x *operand, e *syntax.SelectorExpr) {

obj, index, indirect = LookupFieldOrMethod(x.typ, x.mode == variable, check.pkg, sel)
if obj == nil {
switch {
case index != nil:
if index != nil {
// TODO(gri) should provide actual type where the conflict happens
check.errorf(e.Sel, "ambiguous selector %s.%s", x.expr, sel)
case indirect:
goto Error
}

if indirect {
check.errorf(e.Sel, "cannot call pointer method %s on %s", sel, x.typ)
default:
var why string
if tpar, _ := x.typ.(*TypeParam); tpar != nil {
// Type parameter bounds don't specify fields, so don't mention "field".
if tname := tpar.iface().obj; tname != nil {
why = check.sprintf("interface %s has no method %s", tname.name, sel)
} else {
why = check.sprintf("type bound for %s has no method %s", x.typ, sel)
}
goto Error
}

if isInterfacePtr(x.typ) {
check.errorf(e.Sel, "%s.%s undefined (type %s is pointer to interface, not interface)", x.expr, sel, x.typ)
goto Error
}

var why string
if tpar, _ := x.typ.(*TypeParam); tpar != nil {
// Type parameter bounds don't specify fields, so don't mention "field".
// TODO(gri) Type constraints may have accessible fields now. Revisit this.
if tname := tpar.iface().obj; tname != nil {
why = check.sprintf("interface %s has no method %s", tname.name, sel)
} else {
why = check.sprintf("type %s has no field or method %s", x.typ, sel)
why = check.sprintf("type bound for %s has no method %s", x.typ, sel)
}
} else {
why = check.sprintf("type %s has no field or method %s", x.typ, sel)
}

// Check if capitalization of sel matters and provide better error message in that case.
if len(sel) > 0 {
var changeCase string
if r := rune(sel[0]); unicode.IsUpper(r) {
changeCase = string(unicode.ToLower(r)) + sel[1:]
} else {
changeCase = string(unicode.ToUpper(r)) + sel[1:]
}
if obj, _, _ = LookupFieldOrMethod(x.typ, x.mode == variable, check.pkg, changeCase); obj != nil {
why += ", but does have " + changeCase
}
// Check if capitalization of sel matters and provide better error message in that case.
// TODO(gri) This code only looks at the first character but LookupFieldOrMethod has an
// (internal) mechanism for case-insensitive lookup. Should use that instead.
if len(sel) > 0 {
var changeCase string
if r := rune(sel[0]); unicode.IsUpper(r) {
changeCase = string(unicode.ToLower(r)) + sel[1:]
} else {
changeCase = string(unicode.ToUpper(r)) + sel[1:]
}
if obj, _, _ = LookupFieldOrMethod(x.typ, x.mode == variable, check.pkg, changeCase); obj != nil {
why += ", but does have " + changeCase
}

check.errorf(e.Sel, "%s.%s undefined (%s)", x.expr, sel, why)

}

check.errorf(e.Sel, "%s.%s undefined (%s)", x.expr, sel, why)
goto Error
}

Expand Down
10 changes: 5 additions & 5 deletions src/cmd/compile/internal/types2/lookup.go
Original file line number Diff line number Diff line change
Expand Up @@ -448,12 +448,12 @@ func (check *Checker) missingMethodReason(V, T Type, m, wrongType *Func) string
// an extra formatting option for types2.Type that doesn't print out
// 'func'.
r = strings.Replace(r, "^^func", "", -1)
} else if IsInterface(T) && !isTypeParam(T) {
} else if IsInterface(T) {
if isInterfacePtr(V) {
r = fmt.Sprintf("(%s is pointer to interface, not interface)", V)
r = fmt.Sprintf("(type %s is pointer to interface, not interface)", V)
}
} else if isInterfacePtr(T) && !isTypeParam(T) {
r = fmt.Sprintf("(%s is pointer to interface, not interface)", T)
} else if isInterfacePtr(T) {
r = fmt.Sprintf("(type %s is pointer to interface, not interface)", T)
}
if r == "" {
r = fmt.Sprintf("(missing %s)", mname)
Expand All @@ -463,7 +463,7 @@ func (check *Checker) missingMethodReason(V, T Type, m, wrongType *Func) string

func isInterfacePtr(T Type) bool {
p, _ := under(T).(*Pointer)
return p != nil && IsInterface(p.base) && !isTypeParam(p.base)
return p != nil && IsInterface(p.base)
}

// assertableTo reports whether a value of type V can be asserted to have type T.
Expand Down
2 changes: 1 addition & 1 deletion src/cmd/compile/internal/types2/operand.go
Original file line number Diff line number Diff line change
Expand Up @@ -317,7 +317,7 @@ func (x *operand) assignableTo(check *Checker, T Type, reason *string) (bool, er
if check != nil && check.conf.CompilerErrorMessages {
if isInterfacePtr(Tu) {
if reason != nil {
*reason = check.sprintf("%s does not implement %s (%s is pointer to interface, not interface)", x.typ, T, T)
*reason = check.sprintf("%s does not implement %s (type %s is pointer to interface, not interface)", x.typ, T, T)
}
return false, _InvalidIfaceAssign
}
Expand Down
12 changes: 6 additions & 6 deletions src/cmd/compile/internal/types2/testdata/check/methodsets.src
Original file line number Diff line number Diff line change
Expand Up @@ -196,9 +196,9 @@ func issue5918() {
_ func(error) string = error.Error

perr = &err
_ = perr.Error /* ERROR "no field or method" */ ()
_ func() string = perr.Error /* ERROR "no field or method" */
_ func(*error) string = (*error).Error /* ERROR "no field or method" */
_ = perr.Error /* ERROR "type \*error is pointer to interface, not interface" */ ()
_ func() string = perr.Error /* ERROR "type \*error is pointer to interface, not interface" */
_ func(*error) string = (*error).Error /* ERROR "type \*error is pointer to interface, not interface" */
)

type T *interface{ m() int }
Expand All @@ -207,8 +207,8 @@ func issue5918() {
_ = (*x).m()
_ = (*x).m

_ = x.m /* ERROR "no field or method" */ ()
_ = x.m /* ERROR "no field or method" */
_ = T.m /* ERROR "no field or method" */
_ = x.m /* ERROR "type T is pointer to interface, not interface" */ ()
_ = x.m /* ERROR "type T is pointer to interface, not interface" */
_ = T.m /* ERROR "type T is pointer to interface, not interface" */
)
}
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ func _[P interface{ m() }](x P) {
x.m()
// (&x).m doesn't exist because &x is of type *P
// and pointers to type parameters don't have methods
(&x).m /* ERROR \*P has no field or method m */ ()
(&x).m /* ERROR type \*P is pointer to interface, not interface */ ()
}


Expand All @@ -29,7 +29,7 @@ type T2 interface{ m() }
func _(x *T2) {
// x.m doesn't exists because x is of type *T2
// and pointers to interfaces don't have methods
x.m /* ERROR \*T2 has no field or method m */()
x.m /* ERROR type \*T2 is pointer to interface, not interface */()
}

// Test case 1 from issue
Expand Down
20 changes: 20 additions & 0 deletions src/cmd/compile/internal/types2/testdata/fixedbugs/issue48312.go2
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
// Copyright 2022 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package p

type T interface{ m() }
type P *T

func _(p *T) {
p.m /* ERROR type \*T is pointer to interface, not interface */ ()
}

func _(p P) {
p.m /* ERROR type P is pointer to interface, not interface */ ()
}

func _[P T](p *P) {
p.m /* ERROR type \*P is pointer to interface, not interface */ ()
}
64 changes: 38 additions & 26 deletions src/go/types/call.go
Original file line number Diff line number Diff line change
Expand Up @@ -533,40 +533,52 @@ func (check *Checker) selector(x *operand, e *ast.SelectorExpr) {

obj, index, indirect = LookupFieldOrMethod(x.typ, x.mode == variable, check.pkg, sel)
if obj == nil {
switch {
case index != nil:
if index != nil {
// TODO(gri) should provide actual type where the conflict happens
check.errorf(e.Sel, _AmbiguousSelector, "ambiguous selector %s.%s", x.expr, sel)
case indirect:
goto Error
}

if indirect {
check.errorf(e.Sel, _InvalidMethodExpr, "cannot call pointer method %s on %s", sel, x.typ)
default:
var why string
if tpar, _ := x.typ.(*TypeParam); tpar != nil {
// Type parameter bounds don't specify fields, so don't mention "field".
if tname := tpar.iface().obj; tname != nil {
why = check.sprintf("interface %s has no method %s", tname.name, sel)
} else {
why = check.sprintf("type bound for %s has no method %s", x.typ, sel)
}
goto Error
}

if isInterfacePtr(x.typ) {
check.errorf(e.Sel, _InvalidMethodExpr, "%s.%s undefined (type %s is pointer to interface, not interface)", x.expr, sel, x.typ)
goto Error
}

var why string
if tpar, _ := x.typ.(*TypeParam); tpar != nil {
// Type parameter bounds don't specify fields, so don't mention "field".
// TODO(gri) Type constraints may have accessible fields now. Revisit this.
if tname := tpar.iface().obj; tname != nil {
why = check.sprintf("interface %s has no method %s", tname.name, sel)
} else {
why = check.sprintf("type %s has no field or method %s", x.typ, sel)
why = check.sprintf("type bound for %s has no method %s", x.typ, sel)
}
} else {
why = check.sprintf("type %s has no field or method %s", x.typ, sel)
}

// Check if capitalization of sel matters and provide better error message in that case.
if len(sel) > 0 {
var changeCase string
if r := rune(sel[0]); unicode.IsUpper(r) {
changeCase = string(unicode.ToLower(r)) + sel[1:]
} else {
changeCase = string(unicode.ToUpper(r)) + sel[1:]
}
if obj, _, _ = LookupFieldOrMethod(x.typ, x.mode == variable, check.pkg, changeCase); obj != nil {
why += ", but does have " + changeCase
}
// Check if capitalization of sel matters and provide better error message in that case.
// TODO(gri) This code only looks at the first character but LookupFieldOrMethod should
// have an (internal) mechanism for case-insensitive lookup that we should use
// instead (see types2).
if len(sel) > 0 {
var changeCase string
if r := rune(sel[0]); unicode.IsUpper(r) {
changeCase = string(unicode.ToLower(r)) + sel[1:]
} else {
changeCase = string(unicode.ToUpper(r)) + sel[1:]
}
if obj, _, _ = LookupFieldOrMethod(x.typ, x.mode == variable, check.pkg, changeCase); obj != nil {
why += ", but does have " + changeCase
}

check.errorf(e.Sel, _MissingFieldOrMethod, "%s.%s undefined (%s)", x.expr, sel, why)
}

check.errorf(e.Sel, _MissingFieldOrMethod, "%s.%s undefined (%s)", x.expr, sel, why)
goto Error
}

Expand Down
10 changes: 5 additions & 5 deletions src/go/types/lookup.go
Original file line number Diff line number Diff line change
Expand Up @@ -422,12 +422,12 @@ func (check *Checker) missingMethodReason(V, T Type, m, wrongType *Func) string
// an extra formatting option for types2.Type that doesn't print out
// 'func'.
r = strings.Replace(r, "^^func", "", -1)
} else if IsInterface(T) && !isTypeParam(T) {
} else if IsInterface(T) {
if isInterfacePtr(V) {
r = fmt.Sprintf("(%s is pointer to interface, not interface)", V)
r = fmt.Sprintf("(type %s is pointer to interface, not interface)", V)
}
} else if isInterfacePtr(T) && !isTypeParam(T) {
r = fmt.Sprintf("(%s is pointer to interface, not interface)", T)
} else if isInterfacePtr(T) {
r = fmt.Sprintf("(type %s is pointer to interface, not interface)", T)
}
if r == "" {
r = fmt.Sprintf("(missing %s)", mname)
Expand All @@ -437,7 +437,7 @@ func (check *Checker) missingMethodReason(V, T Type, m, wrongType *Func) string

func isInterfacePtr(T Type) bool {
p, _ := under(T).(*Pointer)
return p != nil && IsInterface(p.base) && !isTypeParam(T)
return p != nil && IsInterface(p.base)
}

// assertableTo reports whether a value of type V can be asserted to have type T.
Expand Down
2 changes: 1 addition & 1 deletion src/go/types/operand.go
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ func (x *operand) assignableTo(check *Checker, T Type, reason *string) (bool, er
if check != nil && compilerErrorMessages {
if isInterfacePtr(Tu) {
if reason != nil {
*reason = check.sprintf("%s does not implement %s (%s is pointer to interface, not interface)", x.typ, T, T)
*reason = check.sprintf("%s does not implement %s (type %s is pointer to interface, not interface)", x.typ, T, T)
}
return false, _InvalidIfaceAssign
}
Expand Down
12 changes: 6 additions & 6 deletions src/go/types/testdata/check/methodsets.src
Original file line number Diff line number Diff line change
Expand Up @@ -196,9 +196,9 @@ func issue5918() {
_ func(error) string = error.Error

perr = &err
_ = perr.Error /* ERROR "no field or method" */ ()
_ func() string = perr.Error /* ERROR "no field or method" */
_ func(*error) string = (*error).Error /* ERROR "no field or method" */
_ = perr.Error /* ERROR "type \*error is pointer to interface, not interface" */ ()
_ func() string = perr.Error /* ERROR "type \*error is pointer to interface, not interface" */
_ func(*error) string = (*error).Error /* ERROR "type \*error is pointer to interface, not interface" */
)

type T *interface{ m() int }
Expand All @@ -207,8 +207,8 @@ func issue5918() {
_ = (*x).m()
_ = (*x).m

_ = x.m /* ERROR "no field or method" */ ()
_ = x.m /* ERROR "no field or method" */
_ = T.m /* ERROR "no field or method" */
_ = x.m /* ERROR "type T is pointer to interface, not interface" */ ()
_ = x.m /* ERROR "type T is pointer to interface, not interface" */
_ = T.m /* ERROR "type T is pointer to interface, not interface" */
)
}
4 changes: 2 additions & 2 deletions src/go/types/testdata/fixedbugs/issue47747.go2
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ func _[P interface{ m() }](x P) {
x.m()
// (&x).m doesn't exist because &x is of type *P
// and pointers to type parameters don't have methods
(&x).m /* ERROR \*P has no field or method m */ ()
(&x).m /* ERROR type \*P is pointer to interface, not interface */ ()
}


Expand All @@ -29,7 +29,7 @@ type T2 interface{ m() }
func _(x *T2) {
// x.m doesn't exists because x is of type *T2
// and pointers to interfaces don't have methods
x.m /* ERROR \*T2 has no field or method m */()
x.m /* ERROR type \*T2 is pointer to interface, not interface */()
}

// Test case 1 from issue
Expand Down
20 changes: 20 additions & 0 deletions src/go/types/testdata/fixedbugs/issue48312.go2
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
// Copyright 2022 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package p

type T interface{ m() }
type P *T

func _(p *T) {
p.m /* ERROR type \*T is pointer to interface, not interface */ ()
}

func _(p P) {
p.m /* ERROR type P is pointer to interface, not interface */ ()
}

func _[P T](p *P) {
p.m /* ERROR type \*P is pointer to interface, not interface */ ()
}
2 changes: 1 addition & 1 deletion test/fixedbugs/issue48471.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ func g() {
i = new(T2) // ERROR "cannot use new\(T2\) \(.*type \*T2\) as type I in assignment:\n\t\*T2 does not implement I \(missing M method\)\n\t\thave m\(int\)\n\t\twant M\(int\)"
i = new(T3) // ERROR "cannot use new\(T3\) \(.*type \*T3\) as type I in assignment:\n\t\*T3 does not implement I \(wrong type for M method\)\n\t\thave M\(string\)\n\t\twant M\(int\)"
i = T4{} // ERROR "cannot use T4\{\} \(.*type T4\) as type I in assignment:\n\tT4 does not implement I \(M method has pointer receiver\)"
i = new(I) // ERROR "cannot use new\(I\) \(.*type \*I\) as type I in assignment:\n\t\*I does not implement I \(\*I is pointer to interface, not interface\)"
i = new(I) // ERROR "cannot use new\(I\) \(.*type \*I\) as type I in assignment:\n\t\*I does not implement I \(type \*I is pointer to interface, not interface\)"
_ = i.(*T2) // ERROR "impossible type assertion: i.\(\*T2\)\n\t\*T2 does not implement I \(missing M method\)\n\t\thave m\(int\)\n\t\twant M\(int\)"
_ = i.(*T3) // ERROR "impossible type assertion: i.\(\*T3\)\n\t\*T3 does not implement I \(wrong type for M method\)\n\t\thave M\(string\)\n\t\twant M\(int\)"
var t *T4
Expand Down
2 changes: 1 addition & 1 deletion test/method2.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ type Val interface {
val() int
}

var _ = (*Val).val // ERROR "method"
var _ = (*Val).val // ERROR "method|type \*Val is pointer to interface, not interface"

var v Val
var pv = &v
Expand Down

0 comments on commit 6019a52

Please sign in to comment.