1 // Copyright 2013 The Go Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style
3 // license that can be found in the LICENSE file.
5 // This file implements various field and method lookup functions.
13 // Internal use of LookupFieldOrMethod: If the obj result is a method
14 // associated with a concrete (non-interface) type, the method's signature
15 // may not be fully set up. Call Checker.objDecl(obj, nil) before accessing
18 // LookupFieldOrMethod looks up a field or method with given package and name
19 // in T and returns the corresponding *Var or *Func, an index sequence, and a
20 // bool indicating if there were any pointer indirections on the path to the
21 // field or method. If addressable is set, T is the type of an addressable
22 // variable (only matters for method lookups). T must not be nil.
24 // The last index entry is the field or method index in the (possibly embedded)
25 // type where the entry was found, either:
27 // 1) the list of declared methods of a named type; or
28 // 2) the list of all methods (method set) of an interface type; or
29 // 3) the list of fields of a struct type.
31 // The earlier index entries are the indices of the embedded struct fields
32 // traversed to get to the found entry, starting at depth 0.
34 // If no entry is found, a nil object is returned. In this case, the returned
35 // index and indirect values have the following meaning:
37 // - If index != nil, the index sequence points to an ambiguous entry
38 // (the same name appeared more than once at the same embedding level).
40 // - If indirect is set, a method with a pointer receiver type was found
41 // but there was no pointer on the path from the actual receiver type to
42 // the method's formal receiver base type, nor was the receiver addressable.
44 func LookupFieldOrMethod(T Type, addressable bool, pkg *Package, name string) (obj Object, index []int, indirect bool) {
46 panic("LookupFieldOrMethod on nil type")
49 // Methods cannot be associated to a named pointer type.
50 // (spec: "The type denoted by T is called the receiver base type;
51 // it must not be a pointer or interface type and it must be declared
52 // in the same package as the method.").
53 // Thus, if we have a named pointer type, proceed with the underlying
54 // pointer type but discard the result if it is a method since we would
55 // not have found it for T (see also issue 8590).
56 if t, _ := T.(*Named); t != nil {
57 if p, _ := t.Underlying().(*Pointer); p != nil {
58 obj, index, indirect = lookupFieldOrMethod(p, false, false, pkg, name)
59 if _, ok := obj.(*Func); ok {
60 return nil, nil, false
66 obj, index, indirect = lookupFieldOrMethod(T, addressable, false, pkg, name)
68 // If we didn't find anything and if we have a type parameter with a structural constraint,
69 // see if there is a matching field (but not a method, those need to be declared explicitly
70 // in the constraint). If the structural constraint is a named pointer type (see above), we
71 // are ok here because only fields are accepted as results.
72 if obj == nil && isTypeParam(T) {
73 if t := structuralType(T); t != nil {
74 obj, index, indirect = lookupFieldOrMethod(t, addressable, false, pkg, name)
75 if _, ok := obj.(*Var); !ok {
76 obj, index, indirect = nil, nil, false // accept fields (variables) only
83 // TODO(gri) The named type consolidation and seen maps below must be
84 // indexed by unique keys for a given type. Verify that named
85 // types always have only one representation (even when imported
86 // indirectly via different packages.)
88 // lookupFieldOrMethod should only be called by LookupFieldOrMethod and missingMethod.
89 // If checkFold is true, the lookup for methods will include looking for any method
90 // which case-folds to the same as 'name' (used for giving helpful error messages).
92 // The resulting object may not be fully type-checked.
93 func lookupFieldOrMethod(T Type, addressable, checkFold bool, pkg *Package, name string) (obj Object, index []int, indirect bool) {
94 // WARNING: The code in this function is extremely subtle - do not modify casually!
97 return // blank fields/methods are never found
100 typ, isPtr := deref(T)
102 // *typ where typ is an interface (incl. a type parameter) has no methods.
104 if _, ok := under(typ).(*Interface); ok {
109 // Start with typ as single entry at shallowest depth.
110 current := []embeddedType{{typ, nil, isPtr, false}}
112 // Named types that we have seen already, allocated lazily.
113 // Used to avoid endless searches in case of recursive types.
114 // Since only Named types can be used for recursive types, we
115 // only need to track those.
116 // (If we ever allow type aliases to construct recursive types,
117 // we must use type identity rather than pointer equality for
118 // the map key comparison, as we do in consolidateMultiples.)
119 var seen map[*Named]bool
121 // search current depth
122 for len(current) > 0 {
123 var next []embeddedType // embedded types found at current depth
125 // look for (pkg, name) in all types at current depth
126 for _, e := range current {
129 // If we have a named type, we may have associated methods.
130 // Look for those first.
131 if named, _ := typ.(*Named); named != nil {
133 // We have seen this type before, at a more shallow depth
134 // (note that multiples of this type at the current depth
135 // were consolidated before). The type at that depth shadows
136 // this same type at the current depth, so we can ignore
141 seen = make(map[*Named]bool)
145 // look for a matching attached method
147 if i, m := named.lookupMethodFold(pkg, name, checkFold); m != nil {
149 // caution: method may not have a proper signature yet
150 index = concat(e.index, i)
151 if obj != nil || e.multiples {
152 return nil, index, false // collision
155 indirect = e.indirect
156 continue // we can't have a matching field or interface method
160 switch t := under(typ).(type) {
162 // look for a matching field and collect embedded types
163 for i, f := range t.fields {
164 if f.sameId(pkg, name) {
166 index = concat(e.index, i)
167 if obj != nil || e.multiples {
168 return nil, index, false // collision
171 indirect = e.indirect
172 continue // we can't have a matching interface method
174 // Collect embedded struct fields for searching the next
175 // lower depth, but only if we have not seen a match yet
176 // (if we have a match it is either the desired field or
177 // we have a name collision on the same depth; in either
178 // case we don't need to look further).
179 // Embedded fields are always of the form T or *T where
180 // T is a type name. If e.typ appeared multiple times at
181 // this depth, f.typ appears multiple times at the next
183 if obj == nil && f.embedded {
184 typ, isPtr := deref(f.typ)
185 // TODO(gri) optimization: ignore types that can't
186 // have fields or methods (only Named, Struct, and
187 // Interface types need to be considered).
188 next = append(next, embeddedType{typ, concat(e.index, i), e.indirect || isPtr, e.multiples})
193 // look for a matching method (interface may be a type parameter)
194 if i, m := lookupMethodFold(t.typeSet().methods, pkg, name, checkFold); m != nil {
196 index = concat(e.index, i)
197 if obj != nil || e.multiples {
198 return nil, index, false // collision
201 indirect = e.indirect
207 // found a potential match
208 // spec: "A method call x.m() is valid if the method set of (the type of) x
209 // contains m and the argument list can be assigned to the parameter
210 // list of m. If x is addressable and &x's method set contains m, x.m()
211 // is shorthand for (&x).m()".
212 if f, _ := obj.(*Func); f != nil {
213 // determine if method has a pointer receiver
214 if f.hasPtrRecv() && !indirect && !addressable {
215 return nil, nil, true // pointer/addressable receiver required
221 current = consolidateMultiples(next)
224 return nil, nil, false // not found
227 // embeddedType represents an embedded type
228 type embeddedType struct {
230 index []int // embedded field indices, starting with index at depth 0
231 indirect bool // if set, there was a pointer indirection on the path to this field
232 multiples bool // if set, typ appears multiple times at this depth
235 // consolidateMultiples collects multiple list entries with the same type
236 // into a single entry marked as containing multiples. The result is the
237 // consolidated list.
238 func consolidateMultiples(list []embeddedType) []embeddedType {
240 return list // at most one entry - nothing to do
243 n := 0 // number of entries w/ unique type
244 prev := make(map[Type]int) // index at which type was previously seen
245 for _, e := range list {
246 if i, found := lookupType(prev, e.typ); found {
247 list[i].multiples = true
258 func lookupType(m map[Type]int, typ Type) (int, bool) {
259 // fast path: maybe the types are equal
260 if i, found := m[typ]; found {
264 for t, i := range m {
265 if Identical(t, typ) {
273 // MissingMethod returns (nil, false) if V implements T, otherwise it
274 // returns a missing method required by T and whether it is missing or
275 // just has the wrong type.
277 // For non-interface types V, or if static is set, V implements T if all
278 // methods of T are present in V. Otherwise (V is an interface and static
279 // is not set), MissingMethod only checks that methods of T which are also
280 // present in V have matching types (e.g., for a type assertion x.(T) where
281 // x is of interface type V).
283 func MissingMethod(V Type, T *Interface, static bool) (method *Func, wrongType bool) {
284 m, typ := (*Checker)(nil).missingMethod(V, T, static)
288 // If we accept type parameters for methods, (at least) the code
289 // guarded with this constant will need to be adjusted when such
290 // methods are used (not just parsed).
291 const acceptMethodTypeParams = false
293 // missingMethod is like MissingMethod but accepts a *Checker as
294 // receiver and an addressable flag.
295 // The receiver may be nil if missingMethod is invoked through
296 // an exported API call (such as MissingMethod), i.e., when all
297 // methods have been type-checked.
298 // If the type has the correctly named method, but with the wrong
299 // signature, the existing method is returned as well.
300 // To improve error messages, also report the wrong signature
301 // when the method exists on *V instead of V.
302 func (check *Checker) missingMethod(V Type, T *Interface, static bool) (method, wrongType *Func) {
303 // fast path for common case
308 if ityp, _ := under(V).(*Interface); ityp != nil {
309 // TODO(gri) the methods are sorted - could do this more efficiently
310 for _, m := range T.typeSet().methods {
311 _, f := ityp.typeSet().LookupMethod(m.pkg, m.name)
317 // We don't do any case-fold check if V is an interface.
321 // both methods must have the same number of type parameters
322 ftyp := f.typ.(*Signature)
323 mtyp := m.typ.(*Signature)
324 if ftyp.TypeParams().Len() != mtyp.TypeParams().Len() {
327 if !acceptMethodTypeParams && ftyp.TypeParams().Len() > 0 {
328 panic("method with type parameters")
331 if !Identical(ftyp, mtyp) {
339 // A concrete type implements T if it implements all methods of T.
340 for _, m := range T.typeSet().methods {
341 // TODO(gri) should this be calling LookupFieldOrMethod instead (and why not)?
342 obj, _, _ := lookupFieldOrMethod(V, false, false, m.pkg, m.name)
344 // Check if *V implements this method of T.
347 obj, _, _ = lookupFieldOrMethod(ptr, false, false, m.pkg, m.name)
349 // If we didn't find the exact method (even with pointer
350 // receiver), look to see if there is a method that
351 // matches m.name with case-folding.
352 obj, _, _ = lookupFieldOrMethod(V, false, true, m.pkg, m.name)
355 // methods may not have a fully set up signature yet
357 check.objDecl(obj, nil)
359 return m, obj.(*Func)
363 // we must have a method (not a field of matching function type)
369 // methods may not have a fully set up signature yet
371 check.objDecl(f, nil)
374 // both methods must have the same number of type parameters
375 ftyp := f.typ.(*Signature)
376 mtyp := m.typ.(*Signature)
377 if ftyp.TypeParams().Len() != mtyp.TypeParams().Len() {
380 if !acceptMethodTypeParams && ftyp.TypeParams().Len() > 0 {
381 panic("method with type parameters")
384 if !Identical(ftyp, mtyp) {
392 // missingMethodReason returns a string giving the detailed reason for a missing method m,
393 // where m is missing from V, but required by T. It puts the reason in parentheses,
394 // and may include more have/want info after that. If non-nil, wrongType is a relevant
395 // method that matches in some way. It may have the correct name, but wrong type, or
396 // it may have a pointer receiver, or it may have the correct name except wrong case.
397 func (check *Checker) missingMethodReason(V, T Type, m, wrongType *Func) string {
400 if check.conf.CompilerErrorMessages {
401 mname = m.Name() + " method"
403 mname = "method " + m.Name()
405 if wrongType != nil {
406 if Identical(m.typ, wrongType.typ) {
407 if m.Name() == wrongType.Name() {
408 r = check.sprintf("(%s has pointer receiver) at %s", mname, wrongType.Pos())
410 r = check.sprintf("(missing %s)\n\t\thave %s^^%s at %s\n\t\twant %s^^%s",
411 mname, wrongType.Name(), wrongType.typ, wrongType.Pos(), m.Name(), m.typ)
414 if check.conf.CompilerErrorMessages {
415 r = check.sprintf("(wrong type for %s)\n\t\thave %s^^%s at %s\n\t\twant %s^^%s",
416 mname, wrongType.Name(), wrongType.typ, wrongType.Pos(), m.Name(), m.typ)
418 r = check.sprintf("(wrong type for %s)\n\thave %s at %s\n\twant %s",
419 mname, wrongType.typ, wrongType.Pos(), m.typ)
422 // This is a hack to print the function type without the leading
423 // 'func' keyword in the have/want printouts. We could change to have
424 // an extra formatting option for types2.Type that doesn't print out
426 r = strings.Replace(r, "^^func", "", -1)
427 } else if IsInterface(T) {
428 if isInterfacePtr(V) {
429 r = "(" + check.interfacePtrError(V) + ")"
431 } else if isInterfacePtr(T) {
432 r = "(" + check.interfacePtrError(T) + ")"
435 r = check.sprintf("(missing %s)", mname)
440 func isInterfacePtr(T Type) bool {
441 p, _ := under(T).(*Pointer)
442 return p != nil && IsInterface(p.base)
445 func (check *Checker) interfacePtrError(T Type) string {
446 assert(isInterfacePtr(T))
447 if p, _ := under(T).(*Pointer); isTypeParam(p.base) {
448 return check.sprintf("type %s is pointer to type parameter, not type parameter", T)
450 return check.sprintf("type %s is pointer to interface, not interface", T)
453 // assertableTo reports whether a value of type V can be asserted to have type T.
454 // It returns (nil, false) as affirmative answer. Otherwise it returns a missing
455 // method required by V and whether it is missing or just has the wrong type.
456 // The receiver may be nil if assertableTo is invoked through an exported API call
457 // (such as AssertableTo), i.e., when all methods have been type-checked.
458 // If the global constant forceStrict is set, assertions that are known to fail
459 // are not permitted.
460 func (check *Checker) assertableTo(V *Interface, T Type) (method, wrongType *Func) {
461 // no static check is required if T is an interface
462 // spec: "If T is an interface type, x.(T) asserts that the
463 // dynamic type of x implements the interface T."
464 if IsInterface(T) && !forceStrict {
467 return check.missingMethod(T, V, false)
470 // deref dereferences typ if it is a *Pointer and returns its base and true.
471 // Otherwise it returns (typ, false).
472 func deref(typ Type) (Type, bool) {
473 if p, _ := typ.(*Pointer); p != nil {
474 // p.base should never be nil, but be conservative
477 panic("pointer with nil base type (possibly due to an invalid cyclic declaration)")
479 return Typ[Invalid], true
486 // derefStructPtr dereferences typ if it is a (named or unnamed) pointer to a
487 // (named or unnamed) struct and returns its base. Otherwise it returns typ.
488 func derefStructPtr(typ Type) Type {
489 if p, _ := under(typ).(*Pointer); p != nil {
490 if _, ok := under(p.base).(*Struct); ok {
497 // concat returns the result of concatenating list and i.
498 // The result does not share its underlying array with list.
499 func concat(list []int, i int) []int {
501 t = append(t, list...)
505 // fieldIndex returns the index for the field with matching package and name, or a value < 0.
506 func fieldIndex(fields []*Var, pkg *Package, name string) int {
508 for i, f := range fields {
509 if f.sameId(pkg, name) {
517 // lookupMethod returns the index of and method with matching package and name, or (-1, nil).
518 func lookupMethod(methods []*Func, pkg *Package, name string) (int, *Func) {
520 for i, m := range methods {
521 if m.sameId(pkg, name) {
529 // lookupMethodFold is like lookupMethod, but if checkFold is true, it matches a method
530 // name if the names are equal with case folding.
531 func lookupMethodFold(methods []*Func, pkg *Package, name string, checkFold bool) (int, *Func) {
533 for i, m := range methods {
534 if m.name != name && !(checkFold && strings.EqualFold(m.name, name)) {
537 // Use m.name, since we've already checked that m.name and
538 // name are equal with folding.
539 if m.sameId(pkg, m.name) {