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.
9 // Internal use of LookupFieldOrMethod: If the obj result is a method
10 // associated with a concrete (non-interface) type, the method's signature
11 // may not be fully set up. Call Checker.objDecl(obj, nil) before accessing
14 // LookupFieldOrMethod looks up a field or method with given package and name
15 // in T and returns the corresponding *Var or *Func, an index sequence, and a
16 // bool indicating if there were any pointer indirections on the path to the
17 // field or method. If addressable is set, T is the type of an addressable
18 // variable (only matters for method lookups).
20 // The last index entry is the field or method index in the (possibly embedded)
21 // type where the entry was found, either:
23 // 1) the list of declared methods of a named type; or
24 // 2) the list of all methods (method set) of an interface type; or
25 // 3) the list of fields of a struct type.
27 // The earlier index entries are the indices of the embedded struct fields
28 // traversed to get to the found entry, starting at depth 0.
30 // If no entry is found, a nil object is returned. In this case, the returned
31 // index and indirect values have the following meaning:
33 // - If index != nil, the index sequence points to an ambiguous entry
34 // (the same name appeared more than once at the same embedding level).
36 // - If indirect is set, a method with a pointer receiver type was found
37 // but there was no pointer on the path from the actual receiver type to
38 // the method's formal receiver base type, nor was the receiver addressable.
40 func LookupFieldOrMethod(T Type, addressable bool, pkg *Package, name string) (obj Object, index []int, indirect bool) {
41 // Methods cannot be associated to a named pointer type
42 // (spec: "The type denoted by T is called the receiver base type;
43 // it must not be a pointer or interface type and it must be declared
44 // in the same package as the method.").
45 // Thus, if we have a named pointer type, proceed with the underlying
46 // pointer type but discard the result if it is a method since we would
47 // not have found it for T (see also issue 8590).
48 if t := asNamed(T); t != nil {
49 if p, _ := t.Underlying().(*Pointer); p != nil {
50 obj, index, indirect = lookupFieldOrMethod(p, false, pkg, name)
51 if _, ok := obj.(*Func); ok {
52 return nil, nil, false
58 return lookupFieldOrMethod(T, addressable, pkg, name)
61 // TODO(gri) The named type consolidation and seen maps below must be
62 // indexed by unique keys for a given type. Verify that named
63 // types always have only one representation (even when imported
64 // indirectly via different packages.)
66 // lookupFieldOrMethod should only be called by LookupFieldOrMethod and missingMethod.
67 func lookupFieldOrMethod(T Type, addressable bool, pkg *Package, name string) (obj Object, index []int, indirect bool) {
68 // WARNING: The code in this function is extremely subtle - do not modify casually!
71 return // blank fields/methods are never found
74 typ, isPtr := deref(T)
76 // *typ where typ is an interface or type parameter has no methods.
77 switch under(typ).(type) {
78 case *Interface, *TypeParam:
84 // Start with typ as single entry at shallowest depth.
85 current := []embeddedType{{typ, nil, isPtr, false}}
87 // Named types that we have seen already, allocated lazily.
88 // Used to avoid endless searches in case of recursive types.
89 // Since only Named types can be used for recursive types, we
90 // only need to track those.
91 // (If we ever allow type aliases to construct recursive types,
92 // we must use type identity rather than pointer equality for
93 // the map key comparison, as we do in consolidateMultiples.)
94 var seen map[*Named]bool
96 // search current depth
97 for len(current) > 0 {
98 var next []embeddedType // embedded types found at current depth
100 // look for (pkg, name) in all types at current depth
101 var tpar *TypeParam // set if obj receiver is a type parameter
102 for _, e := range current {
105 // If we have a named type, we may have associated methods.
106 // Look for those first.
107 if named := asNamed(typ); named != nil {
109 // We have seen this type before, at a more shallow depth
110 // (note that multiples of this type at the current depth
111 // were consolidated before). The type at that depth shadows
112 // this same type at the current depth, so we can ignore
117 seen = make(map[*Named]bool)
121 // look for a matching attached method
123 if i, m := lookupMethod(named.methods, pkg, name); m != nil {
125 // caution: method may not have a proper signature yet
126 index = concat(e.index, i)
127 if obj != nil || e.multiples {
128 return nil, index, false // collision
131 indirect = e.indirect
132 continue // we can't have a matching field or interface method
135 // continue with underlying type, but only if it's not a type parameter
136 // TODO(gri) is this what we want to do for type parameters? (spec question)
138 if asTypeParam(typ) != nil {
144 switch t := typ.(type) {
146 // look for a matching field and collect embedded types
147 for i, f := range t.fields {
148 if f.sameId(pkg, name) {
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 interface method
158 // Collect embedded struct fields for searching the next
159 // lower depth, but only if we have not seen a match yet
160 // (if we have a match it is either the desired field or
161 // we have a name collision on the same depth; in either
162 // case we don't need to look further).
163 // Embedded fields are always of the form T or *T where
164 // T is a type name. If e.typ appeared multiple times at
165 // this depth, f.typ appears multiple times at the next
167 if obj == nil && f.embedded {
168 typ, isPtr := deref(f.typ)
169 // TODO(gri) optimization: ignore types that can't
170 // have fields or methods (only Named, Struct, and
171 // Interface types need to be considered).
172 next = append(next, embeddedType{typ, concat(e.index, i), e.indirect || isPtr, e.multiples})
177 // look for a matching method
178 if i, m := t.typeSet().LookupMethod(pkg, name); m != nil {
180 index = concat(e.index, i)
181 if obj != nil || e.multiples {
182 return nil, index, false // collision
185 indirect = e.indirect
189 if i, m := t.Bound().typeSet().LookupMethod(pkg, name); m != nil {
191 index = concat(e.index, i)
192 if obj != nil || e.multiples {
193 return nil, index, false // collision
197 indirect = e.indirect
200 // At this point we're not (yet) looking into methods
201 // that any underlying type of the types in the type list
203 // TODO(gri) Do we want to specify the language that way?
209 // found a potential match
210 // spec: "A method call x.m() is valid if the method set of (the type of) x
211 // contains m and the argument list can be assigned to the parameter
212 // list of m. If x is addressable and &x's method set contains m, x.m()
213 // is shorthand for (&x).m()".
214 if f, _ := obj.(*Func); f != nil {
215 // determine if method has a pointer receiver
216 hasPtrRecv := tpar == nil && ptrRecv(f)
217 if hasPtrRecv && !indirect && !addressable {
218 return nil, nil, true // pointer/addressable receiver required
224 current = consolidateMultiples(next)
227 return nil, nil, false // not found
230 // embeddedType represents an embedded type
231 type embeddedType struct {
233 index []int // embedded field indices, starting with index at depth 0
234 indirect bool // if set, there was a pointer indirection on the path to this field
235 multiples bool // if set, typ appears multiple times at this depth
238 // consolidateMultiples collects multiple list entries with the same type
239 // into a single entry marked as containing multiples. The result is the
240 // consolidated list.
241 func consolidateMultiples(list []embeddedType) []embeddedType {
243 return list // at most one entry - nothing to do
246 n := 0 // number of entries w/ unique type
247 prev := make(map[Type]int) // index at which type was previously seen
248 for _, e := range list {
249 if i, found := lookupType(prev, e.typ); found {
250 list[i].multiples = true
261 func lookupType(m map[Type]int, typ Type) (int, bool) {
262 // fast path: maybe the types are equal
263 if i, found := m[typ]; found {
267 for t, i := range m {
268 if Identical(t, typ) {
276 // MissingMethod returns (nil, false) if V implements T, otherwise it
277 // returns a missing method required by T and whether it is missing or
278 // just has the wrong type.
280 // For non-interface types V, or if static is set, V implements T if all
281 // methods of T are present in V. Otherwise (V is an interface and static
282 // is not set), MissingMethod only checks that methods of T which are also
283 // present in V have matching types (e.g., for a type assertion x.(T) where
284 // x is of interface type V).
286 func MissingMethod(V Type, T *Interface, static bool) (method *Func, wrongType bool) {
287 m, typ := (*Checker)(nil).missingMethod(V, T, static)
291 // missingMethod is like MissingMethod but accepts a *Checker as
292 // receiver and an addressable flag.
293 // The receiver may be nil if missingMethod is invoked through
294 // an exported API call (such as MissingMethod), i.e., when all
295 // methods have been type-checked.
296 // If the type has the correctly named method, but with the wrong
297 // signature, the existing method is returned as well.
298 // To improve error messages, also report the wrong signature
299 // when the method exists on *V instead of V.
300 func (check *Checker) missingMethod(V Type, T *Interface, static bool) (method, wrongType *Func) {
301 // fast path for common case
306 if ityp := asInterface(V); ityp != nil {
307 // TODO(gri) the methods are sorted - could do this more efficiently
308 for _, m := range T.typeSet().methods {
309 _, f := ityp.typeSet().LookupMethod(m.pkg, m.name)
311 if f == nil && static {
315 // both methods must have the same number of type parameters
316 ftyp := f.typ.(*Signature)
317 mtyp := m.typ.(*Signature)
318 if len(ftyp.tparams) != len(mtyp.tparams) {
321 if !acceptMethodTypeParams && len(ftyp.tparams) > 0 {
322 panic("internal error: method with type parameters")
325 // If the methods have type parameters we don't care whether they
326 // are the same or not, as long as they match up. Use unification
327 // to see if they can be made to match.
328 // TODO(gri) is this always correct? what about type bounds?
329 // (Alternative is to rename/subst type parameters and compare.)
330 u := newUnifier(true)
331 u.x.init(ftyp.tparams)
332 if !u.unify(ftyp, mtyp) {
340 // A concrete type implements T if it implements all methods of T.
343 for _, m := range T.typeSet().methods {
344 // TODO(gri) should this be calling lookupFieldOrMethod instead (and why not)?
345 obj, _, _ := lookupFieldOrMethod(V, false, m.pkg, m.name)
347 // Check if *V implements this method of T.
350 obj, _, _ = lookupFieldOrMethod(ptr, false, m.pkg, m.name)
352 return m, obj.(*Func)
356 // we must have a method (not a field of matching function type)
362 // methods may not have a fully set up signature yet
364 check.objDecl(f, nil)
367 // both methods must have the same number of type parameters
368 ftyp := f.typ.(*Signature)
369 mtyp := m.typ.(*Signature)
370 if len(ftyp.tparams) != len(mtyp.tparams) {
373 if !acceptMethodTypeParams && len(ftyp.tparams) > 0 {
374 panic("internal error: method with type parameters")
377 // If V is a (instantiated) generic type, its methods are still
378 // parameterized using the original (declaration) receiver type
379 // parameters (subst simply copies the existing method list, it
380 // does not instantiate the methods).
381 // In order to compare the signatures, substitute the receiver
382 // type parameters of ftyp with V's instantiation type arguments.
383 // This lazily instantiates the signature of method f.
384 if Vn != nil && len(Vn.TParams()) > 0 {
385 // Be careful: The number of type arguments may not match
386 // the number of receiver parameters. If so, an error was
387 // reported earlier but the length discrepancy is still
388 // here. Exit early in this case to prevent an assertion
389 // failure in makeSubstMap.
390 // TODO(gri) Can we avoid this check by fixing the lengths?
391 if len(ftyp.rparams) != len(Vn.targs) {
394 ftyp = check.subst(nopos, ftyp, makeSubstMap(ftyp.rparams, Vn.targs)).(*Signature)
397 // If the methods have type parameters we don't care whether they
398 // are the same or not, as long as they match up. Use unification
399 // to see if they can be made to match.
400 // TODO(gri) is this always correct? what about type bounds?
401 // (Alternative is to rename/subst type parameters and compare.)
402 u := newUnifier(true)
403 if len(ftyp.tparams) > 0 {
404 // We reach here only if we accept method type parameters.
405 // In this case, unification must consider any receiver
406 // and method type parameters as "free" type parameters.
407 assert(acceptMethodTypeParams)
408 // We don't have a test case for this at the moment since
409 // we can't parse method type parameters. Keeping the
410 // unimplemented call so that we test this code if we
411 // enable method type parameters.
413 u.x.init(append(ftyp.rparams, ftyp.tparams...))
415 u.x.init(ftyp.rparams)
417 if !u.unify(ftyp, mtyp) {
425 // assertableTo reports whether a value of type V can be asserted to have type T.
426 // It returns (nil, false) as affirmative answer. Otherwise it returns a missing
427 // method required by V and whether it is missing or just has the wrong type.
428 // The receiver may be nil if assertableTo is invoked through an exported API call
429 // (such as AssertableTo), i.e., when all methods have been type-checked.
430 // If the global constant forceStrict is set, assertions that are known to fail
431 // are not permitted.
432 func (check *Checker) assertableTo(V *Interface, T Type) (method, wrongType *Func) {
433 // no static check is required if T is an interface
434 // spec: "If T is an interface type, x.(T) asserts that the
435 // dynamic type of x implements the interface T."
436 if asInterface(T) != nil && !forceStrict {
439 return check.missingMethod(T, V, false)
442 // deref dereferences typ if it is a *Pointer and returns its base and true.
443 // Otherwise it returns (typ, false).
444 func deref(typ Type) (Type, bool) {
445 if p, _ := typ.(*Pointer); p != nil {
451 // derefStructPtr dereferences typ if it is a (named or unnamed) pointer to a
452 // (named or unnamed) struct and returns its base. Otherwise it returns typ.
453 func derefStructPtr(typ Type) Type {
454 if p := asPointer(typ); p != nil {
455 if asStruct(p.base) != nil {
462 // concat returns the result of concatenating list and i.
463 // The result does not share its underlying array with list.
464 func concat(list []int, i int) []int {
466 t = append(t, list...)
470 // fieldIndex returns the index for the field with matching package and name, or a value < 0.
471 func fieldIndex(fields []*Var, pkg *Package, name string) int {
473 for i, f := range fields {
474 if f.sameId(pkg, name) {
482 // lookupMethod returns the index of and method with matching package and name, or (-1, nil).
483 func lookupMethod(methods []*Func, pkg *Package, name string) (int, *Func) {
485 for i, m := range methods {
486 if m.sameId(pkg, name) {
494 // ptrRecv reports whether the receiver is of the form *T.
495 func ptrRecv(f *Func) bool {
496 // If a method's receiver type is set, use that as the source of truth for the receiver.
497 // Caution: Checker.funcDecl (decl.go) marks a function by setting its type to an empty
498 // signature. We may reach here before the signature is fully set up: we must explicitly
499 // check if the receiver is set (we cannot just look for non-nil f.typ).
500 if sig, _ := f.typ.(*Signature); sig != nil && sig.recv != nil {
501 _, isPtr := deref(sig.recv.typ)
505 // If a method's type is not set it may be a method/function that is:
506 // 1) client-supplied (via NewFunc with no signature), or
507 // 2) internally created but not yet type-checked.
508 // For case 1) we can't do anything; the client must know what they are doing.
509 // For case 2) we can use the information gathered by the resolver.