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, _ := safeUnderlying(t).(*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.
78 // don't look at under(typ) here - was bug (issue #47747)
79 if _, ok := typ.(*TypeParam); ok {
82 if _, ok := under(typ).(*Interface); ok {
87 // Start with typ as single entry at shallowest depth.
88 current := []embeddedType{{typ, nil, isPtr, false}}
90 // Named types that we have seen already, allocated lazily.
91 // Used to avoid endless searches in case of recursive types.
92 // Since only Named types can be used for recursive types, we
93 // only need to track those.
94 // (If we ever allow type aliases to construct recursive types,
95 // we must use type identity rather than pointer equality for
96 // the map key comparison, as we do in consolidateMultiples.)
97 var seen map[*Named]bool
99 // search current depth
100 for len(current) > 0 {
101 var next []embeddedType // embedded types found at current depth
103 // look for (pkg, name) in all types at current depth
104 var tpar *TypeParam // set if obj receiver is a type parameter
105 for _, e := range current {
108 // If we have a named type, we may have associated methods.
109 // Look for those first.
110 if named := asNamed(typ); named != nil {
112 // We have seen this type before, at a more shallow depth
113 // (note that multiples of this type at the current depth
114 // were consolidated before). The type at that depth shadows
115 // this same type at the current depth, so we can ignore
120 seen = make(map[*Named]bool)
124 // look for a matching attached method
126 if i, m := lookupMethod(named.methods, pkg, name); m != nil {
128 // caution: method may not have a proper signature yet
129 index = concat(e.index, i)
130 if obj != nil || e.multiples {
131 return nil, index, false // collision
134 indirect = e.indirect
135 continue // we can't have a matching field or interface method
138 // continue with underlying type, but only if it's not a type parameter
139 // TODO(gri) is this what we want to do for type parameters? (spec question)
140 // TODO(#45639) the error message produced as a result of skipping an
141 // underlying type parameter should be improved.
143 if asTypeParam(typ) != nil {
149 switch t := typ.(type) {
151 // look for a matching field and collect embedded types
152 for i, f := range t.fields {
153 if f.sameId(pkg, name) {
155 index = concat(e.index, i)
156 if obj != nil || e.multiples {
157 return nil, index, false // collision
160 indirect = e.indirect
161 continue // we can't have a matching interface method
163 // Collect embedded struct fields for searching the next
164 // lower depth, but only if we have not seen a match yet
165 // (if we have a match it is either the desired field or
166 // we have a name collision on the same depth; in either
167 // case we don't need to look further).
168 // Embedded fields are always of the form T or *T where
169 // T is a type name. If e.typ appeared multiple times at
170 // this depth, f.typ appears multiple times at the next
172 if obj == nil && f.embedded {
173 typ, isPtr := deref(f.typ)
174 // TODO(gri) optimization: ignore types that can't
175 // have fields or methods (only Named, Struct, and
176 // Interface types need to be considered).
177 next = append(next, embeddedType{typ, concat(e.index, i), e.indirect || isPtr, e.multiples})
182 // look for a matching method
183 if i, m := t.typeSet().LookupMethod(pkg, name); m != nil {
185 index = concat(e.index, i)
186 if obj != nil || e.multiples {
187 return nil, index, false // collision
190 indirect = e.indirect
194 if i, m := t.iface().typeSet().LookupMethod(pkg, name); m != nil {
196 index = concat(e.index, i)
197 if obj != nil || e.multiples {
198 return nil, index, false // collision
202 indirect = e.indirect
208 // found a potential match
209 // spec: "A method call x.m() is valid if the method set of (the type of) x
210 // contains m and the argument list can be assigned to the parameter
211 // list of m. If x is addressable and &x's method set contains m, x.m()
212 // is shorthand for (&x).m()".
213 if f, _ := obj.(*Func); f != nil {
214 // determine if method has a pointer receiver
215 hasPtrRecv := tpar == nil && ptrRecv(f)
216 if hasPtrRecv && !indirect && !addressable {
217 return nil, nil, true // pointer/addressable receiver required
223 current = consolidateMultiples(next)
226 return nil, nil, false // not found
229 // embeddedType represents an embedded type
230 type embeddedType struct {
232 index []int // embedded field indices, starting with index at depth 0
233 indirect bool // if set, there was a pointer indirection on the path to this field
234 multiples bool // if set, typ appears multiple times at this depth
237 // consolidateMultiples collects multiple list entries with the same type
238 // into a single entry marked as containing multiples. The result is the
239 // consolidated list.
240 func consolidateMultiples(list []embeddedType) []embeddedType {
242 return list // at most one entry - nothing to do
245 n := 0 // number of entries w/ unique type
246 prev := make(map[Type]int) // index at which type was previously seen
247 for _, e := range list {
248 if i, found := lookupType(prev, e.typ); found {
249 list[i].multiples = true
260 func lookupType(m map[Type]int, typ Type) (int, bool) {
261 // fast path: maybe the types are equal
262 if i, found := m[typ]; found {
266 for t, i := range m {
267 if Identical(t, typ) {
275 // MissingMethod returns (nil, false) if V implements T, otherwise it
276 // returns a missing method required by T and whether it is missing or
277 // just has the wrong type.
279 // For non-interface types V, or if static is set, V implements T if all
280 // methods of T are present in V. Otherwise (V is an interface and static
281 // is not set), MissingMethod only checks that methods of T which are also
282 // present in V have matching types (e.g., for a type assertion x.(T) where
283 // x is of interface type V).
285 func MissingMethod(V Type, T *Interface, static bool) (method *Func, wrongType bool) {
286 m, typ := (*Checker)(nil).missingMethod(V, T, static)
290 // missingMethod is like MissingMethod but accepts a *Checker as
291 // receiver and an addressable flag.
292 // The receiver may be nil if missingMethod is invoked through
293 // an exported API call (such as MissingMethod), i.e., when all
294 // methods have been type-checked.
295 // If the type has the correctly named method, but with the wrong
296 // signature, the existing method is returned as well.
297 // To improve error messages, also report the wrong signature
298 // when the method exists on *V instead of V.
299 func (check *Checker) missingMethod(V Type, T *Interface, static bool) (method, wrongType *Func) {
300 // fast path for common case
305 if ityp := asInterface(V); ityp != nil {
306 // TODO(gri) the methods are sorted - could do this more efficiently
307 for _, m := range T.typeSet().methods {
308 _, f := ityp.typeSet().LookupMethod(m.pkg, m.name)
317 // both methods must have the same number of type parameters
318 ftyp := f.typ.(*Signature)
319 mtyp := m.typ.(*Signature)
320 if ftyp.TypeParams().Len() != mtyp.TypeParams().Len() {
323 if ftyp.TypeParams().Len() > 0 {
324 panic("method with type parameters")
327 // If the methods have type parameters we don't care whether they
328 // are the same or not, as long as they match up. Use unification
329 // to see if they can be made to match.
330 // TODO(gri) is this always correct? what about type bounds?
331 // (Alternative is to rename/subst type parameters and compare.)
332 u := newUnifier(true)
333 u.x.init(ftyp.TypeParams().list())
334 if !u.unify(ftyp, mtyp) {
342 // 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 ftyp.TypeParams().Len() != mtyp.TypeParams().Len() {
373 if ftyp.TypeParams().Len() > 0 {
374 panic("method with type parameters")
377 // If the methods have type parameters we don't care whether they
378 // are the same or not, as long as they match up. Use unification
379 // to see if they can be made to match.
380 // TODO(gri) is this always correct? what about type bounds?
381 // (Alternative is to rename/subst type parameters and compare.)
382 u := newUnifier(true)
383 u.x.init(ftyp.RecvTypeParams().list())
384 if !u.unify(ftyp, mtyp) {
392 // assertableTo reports whether a value of type V can be asserted to have type T.
393 // It returns (nil, false) as affirmative answer. Otherwise it returns a missing
394 // method required by V and whether it is missing or just has the wrong type.
395 // The receiver may be nil if assertableTo is invoked through an exported API call
396 // (such as AssertableTo), i.e., when all methods have been type-checked.
397 // If the global constant forceStrict is set, assertions that are known to fail
398 // are not permitted.
399 func (check *Checker) assertableTo(V *Interface, T Type) (method, wrongType *Func) {
400 // no static check is required if T is an interface
401 // spec: "If T is an interface type, x.(T) asserts that the
402 // dynamic type of x implements the interface T."
403 if asInterface(T) != nil && !forceStrict {
406 return check.missingMethod(T, V, false)
409 // deref dereferences typ if it is a *Pointer and returns its base and true.
410 // Otherwise it returns (typ, false).
411 func deref(typ Type) (Type, bool) {
412 if p, _ := typ.(*Pointer); p != nil {
418 // derefStructPtr dereferences typ if it is a (named or unnamed) pointer to a
419 // (named or unnamed) struct and returns its base. Otherwise it returns typ.
420 func derefStructPtr(typ Type) Type {
421 if p := asPointer(typ); p != nil {
422 if asStruct(p.base) != nil {
429 // concat returns the result of concatenating list and i.
430 // The result does not share its underlying array with list.
431 func concat(list []int, i int) []int {
433 t = append(t, list...)
437 // fieldIndex returns the index for the field with matching package and name, or a value < 0.
438 func fieldIndex(fields []*Var, pkg *Package, name string) int {
440 for i, f := range fields {
441 if f.sameId(pkg, name) {
449 // lookupMethod returns the index of and method with matching package and name, or (-1, nil).
450 func lookupMethod(methods []*Func, pkg *Package, name string) (int, *Func) {
452 for i, m := range methods {
453 if m.sameId(pkg, name) {