typeset.go

Documentation: go/types

     1  // Copyright 2021 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.
     4  
     5  package types
     6  
     7  import (
     8  	"go/token"
     9  	. "internal/types/errors"
    10  	"sort"
    11  	"strings"
    12  )
    13  
    14  // ----------------------------------------------------------------------------
    15  // API
    16  
    17  // A _TypeSet represents the type set of an interface.
    18  // Because of existing language restrictions, methods can be "factored out"
    19  // from the terms. The actual type set is the intersection of the type set
    20  // implied by the methods and the type set described by the terms and the
    21  // comparable bit. To test whether a type is included in a type set
    22  // ("implements" relation), the type must implement all methods _and_ be
    23  // an element of the type set described by the terms and the comparable bit.
    24  // If the term list describes the set of all types and comparable is true,
    25  // only comparable types are meant; in all other cases comparable is false.
    26  type _TypeSet struct {
    27  	methods    []*Func  // all methods of the interface; sorted by unique ID
    28  	terms      termlist // type terms of the type set
    29  	comparable bool     // invariant: !comparable || terms.isAll()
    30  }
    31  
    32  // IsEmpty reports whether type set s is the empty set.
    33  func (s *_TypeSet) IsEmpty() bool { return s.terms.isEmpty() }
    34  
    35  // IsAll reports whether type set s is the set of all types (corresponding to the empty interface).
    36  func (s *_TypeSet) IsAll() bool { return s.IsMethodSet() && len(s.methods) == 0 }
    37  
    38  // IsMethodSet reports whether the interface t is fully described by its method set.
    39  func (s *_TypeSet) IsMethodSet() bool { return !s.comparable && s.terms.isAll() }
    40  
    41  // IsComparable reports whether each type in the set is comparable.
    42  func (s *_TypeSet) IsComparable(seen map[Type]bool) bool {
    43  	if s.terms.isAll() {
    44  		return s.comparable
    45  	}
    46  	return s.is(func(t *term) bool {
    47  		return t != nil && comparable(t.typ, false, seen, nil)
    48  	})
    49  }
    50  
    51  // NumMethods returns the number of methods available.
    52  func (s *_TypeSet) NumMethods() int { return len(s.methods) }
    53  
    54  // Method returns the i'th method of type set s for 0 <= i < s.NumMethods().
    55  // The methods are ordered by their unique ID.
    56  func (s *_TypeSet) Method(i int) *Func { return s.methods[i] }
    57  
    58  // LookupMethod returns the index of and method with matching package and name, or (-1, nil).
    59  func (s *_TypeSet) LookupMethod(pkg *Package, name string, foldCase bool) (int, *Func) {
    60  	return lookupMethod(s.methods, pkg, name, foldCase)
    61  }
    62  
    63  func (s *_TypeSet) String() string {
    64  	switch {
    65  	case s.IsEmpty():
    66  		return "∅"
    67  	case s.IsAll():
    68  		return "𝓤"
    69  	}
    70  
    71  	hasMethods := len(s.methods) > 0
    72  	hasTerms := s.hasTerms()
    73  
    74  	var buf strings.Builder
    75  	buf.WriteByte('{')
    76  	if s.comparable {
    77  		buf.WriteString("comparable")
    78  		if hasMethods || hasTerms {
    79  			buf.WriteString("; ")
    80  		}
    81  	}
    82  	for i, m := range s.methods {
    83  		if i > 0 {
    84  			buf.WriteString("; ")
    85  		}
    86  		buf.WriteString(m.String())
    87  	}
    88  	if hasMethods && hasTerms {
    89  		buf.WriteString("; ")
    90  	}
    91  	if hasTerms {
    92  		buf.WriteString(s.terms.String())
    93  	}
    94  	buf.WriteString("}")
    95  	return buf.String()
    96  }
    97  
    98  // ----------------------------------------------------------------------------
    99  // Implementation
   100  
   101  // hasTerms reports whether the type set has specific type terms.
   102  func (s *_TypeSet) hasTerms() bool { return !s.terms.isEmpty() && !s.terms.isAll() }
   103  
   104  // subsetOf reports whether s1 ⊆ s2.
   105  func (s1 *_TypeSet) subsetOf(s2 *_TypeSet) bool { return s1.terms.subsetOf(s2.terms) }
   106  
   107  // TODO(gri) TypeSet.is and TypeSet.underIs should probably also go into termlist.go
   108  
   109  // is calls f with the specific type terms of s and reports whether
   110  // all calls to f returned true. If there are no specific terms, is
   111  // returns the result of f(nil).
   112  func (s *_TypeSet) is(f func(*term) bool) bool {
   113  	if !s.hasTerms() {
   114  		return f(nil)
   115  	}
   116  	for _, t := range s.terms {
   117  		assert(t.typ != nil)
   118  		if !f(t) {
   119  			return false
   120  		}
   121  	}
   122  	return true
   123  }
   124  
   125  // underIs calls f with the underlying types of the specific type terms
   126  // of s and reports whether all calls to f returned true. If there are
   127  // no specific terms, underIs returns the result of f(nil).
   128  func (s *_TypeSet) underIs(f func(Type) bool) bool {
   129  	if !s.hasTerms() {
   130  		return f(nil)
   131  	}
   132  	for _, t := range s.terms {
   133  		assert(t.typ != nil)
   134  		// x == under(x) for ~x terms
   135  		u := t.typ
   136  		if !t.tilde {
   137  			u = under(u)
   138  		}
   139  		if debug {
   140  			assert(Identical(u, under(u)))
   141  		}
   142  		if !f(u) {
   143  			return false
   144  		}
   145  	}
   146  	return true
   147  }
   148  
   149  // topTypeSet may be used as type set for the empty interface.
   150  var topTypeSet = _TypeSet{terms: allTermlist}
   151  
   152  // computeInterfaceTypeSet may be called with check == nil.
   153  func computeInterfaceTypeSet(check *Checker, pos token.Pos, ityp *Interface) *_TypeSet {
   154  	if ityp.tset != nil {
   155  		return ityp.tset
   156  	}
   157  
   158  	// If the interface is not fully set up yet, the type set will
   159  	// not be complete, which may lead to errors when using the
   160  	// type set (e.g. missing method). Don't compute a partial type
   161  	// set (and don't store it!), so that we still compute the full
   162  	// type set eventually. Instead, return the top type set and
   163  	// let any follow-on errors play out.
   164  	//
   165  	// TODO(gri) Consider recording when this happens and reporting
   166  	// it as an error (but only if there were no other errors so to
   167  	// to not have unnecessary follow-on errors).
   168  	if !ityp.complete {
   169  		return &topTypeSet
   170  	}
   171  
   172  	if check != nil && check.conf._Trace {
   173  		// Types don't generally have position information.
   174  		// If we don't have a valid pos provided, try to use
   175  		// one close enough.
   176  		if !pos.IsValid() && len(ityp.methods) > 0 {
   177  			pos = ityp.methods[0].pos
   178  		}
   179  
   180  		check.trace(pos, "-- type set for %s", ityp)
   181  		check.indent++
   182  		defer func() {
   183  			check.indent--
   184  			check.trace(pos, "=> %s ", ityp.typeSet())
   185  		}()
   186  	}
   187  
   188  	// An infinitely expanding interface (due to a cycle) is detected
   189  	// elsewhere (Checker.validType), so here we simply assume we only
   190  	// have valid interfaces. Mark the interface as complete to avoid
   191  	// infinite recursion if the validType check occurs later for some
   192  	// reason.
   193  	ityp.tset = &_TypeSet{terms: allTermlist} // TODO(gri) is this sufficient?
   194  
   195  	var unionSets map[*Union]*_TypeSet
   196  	if check != nil {
   197  		if check.unionTypeSets == nil {
   198  			check.unionTypeSets = make(map[*Union]*_TypeSet)
   199  		}
   200  		unionSets = check.unionTypeSets
   201  	} else {
   202  		unionSets = make(map[*Union]*_TypeSet)
   203  	}
   204  
   205  	// Methods of embedded interfaces are collected unchanged; i.e., the identity
   206  	// of a method I.m's Func Object of an interface I is the same as that of
   207  	// the method m in an interface that embeds interface I. On the other hand,
   208  	// if a method is embedded via multiple overlapping embedded interfaces, we
   209  	// don't provide a guarantee which "original m" got chosen for the embedding
   210  	// interface. See also go.dev/issue/34421.
   211  	//
   212  	// If we don't care to provide this identity guarantee anymore, instead of
   213  	// reusing the original method in embeddings, we can clone the method's Func
   214  	// Object and give it the position of a corresponding embedded interface. Then
   215  	// we can get rid of the mpos map below and simply use the cloned method's
   216  	// position.
   217  
   218  	var seen objset
   219  	var allMethods []*Func
   220  	mpos := make(map[*Func]token.Pos) // method specification or method embedding position, for good error messages
   221  	addMethod := func(pos token.Pos, m *Func, explicit bool) {
   222  		switch other := seen.insert(m); {
   223  		case other == nil:
   224  			allMethods = append(allMethods, m)
   225  			mpos[m] = pos
   226  		case explicit:
   227  			if check != nil {
   228  				check.errorf(atPos(pos), DuplicateDecl, "duplicate method %s", m.name)
   229  				check.errorf(atPos(mpos[other.(*Func)]), DuplicateDecl, "\tother declaration of %s", m.name) // secondary error, \t indented
   230  			}
   231  		default:
   232  			// We have a duplicate method name in an embedded (not explicitly declared) method.
   233  			// Check method signatures after all types are computed (go.dev/issue/33656).
   234  			// If we're pre-go1.14 (overlapping embeddings are not permitted), report that
   235  			// error here as well (even though we could do it eagerly) because it's the same
   236  			// error message.
   237  			if check != nil {
   238  				check.later(func() {
   239  					if !check.allowVersion(m.pkg, atPos(pos), go1_14) || !Identical(m.typ, other.Type()) {
   240  						check.errorf(atPos(pos), DuplicateDecl, "duplicate method %s", m.name)
   241  						check.errorf(atPos(mpos[other.(*Func)]), DuplicateDecl, "\tother declaration of %s", m.name) // secondary error, \t indented
   242  					}
   243  				}).describef(atPos(pos), "duplicate method check for %s", m.name)
   244  			}
   245  		}
   246  	}
   247  
   248  	for _, m := range ityp.methods {
   249  		addMethod(m.pos, m, true)
   250  	}
   251  
   252  	// collect embedded elements
   253  	allTerms := allTermlist
   254  	allComparable := false
   255  	for i, typ := range ityp.embeddeds {
   256  		// The embedding position is nil for imported interfaces
   257  		// and also for interface copies after substitution (but
   258  		// in that case we don't need to report errors again).
   259  		var pos token.Pos // embedding position
   260  		if ityp.embedPos != nil {
   261  			pos = (*ityp.embedPos)[i]
   262  		}
   263  		var comparable bool
   264  		var terms termlist
   265  		switch u := under(typ).(type) {
   266  		case *Interface:
   267  			// For now we don't permit type parameters as constraints.
   268  			assert(!isTypeParam(typ))
   269  			tset := computeInterfaceTypeSet(check, pos, u)
   270  			// If typ is local, an error was already reported where typ is specified/defined.
   271  			if check != nil && check.isImportedConstraint(typ) && !check.verifyVersionf(atPos(pos), go1_18, "embedding constraint interface %s", typ) {
   272  				continue
   273  			}
   274  			comparable = tset.comparable
   275  			for _, m := range tset.methods {
   276  				addMethod(pos, m, false) // use embedding position pos rather than m.pos
   277  			}
   278  			terms = tset.terms
   279  		case *Union:
   280  			if check != nil && !check.verifyVersionf(atPos(pos), go1_18, "embedding interface element %s", u) {
   281  				continue
   282  			}
   283  			tset := computeUnionTypeSet(check, unionSets, pos, u)
   284  			if tset == &invalidTypeSet {
   285  				continue // ignore invalid unions
   286  			}
   287  			assert(!tset.comparable)
   288  			assert(len(tset.methods) == 0)
   289  			terms = tset.terms
   290  		default:
   291  			if !isValid(u) {
   292  				continue
   293  			}
   294  			if check != nil && !check.verifyVersionf(atPos(pos), go1_18, "embedding non-interface type %s", typ) {
   295  				continue
   296  			}
   297  			terms = termlist{{false, typ}}
   298  		}
   299  
   300  		// The type set of an interface is the intersection of the type sets of all its elements.
   301  		// Due to language restrictions, only embedded interfaces can add methods, they are handled
   302  		// separately. Here we only need to intersect the term lists and comparable bits.
   303  		allTerms, allComparable = intersectTermLists(allTerms, allComparable, terms, comparable)
   304  	}
   305  
   306  	ityp.tset.comparable = allComparable
   307  	if len(allMethods) != 0 {
   308  		sortMethods(allMethods)
   309  		ityp.tset.methods = allMethods
   310  	}
   311  	ityp.tset.terms = allTerms
   312  
   313  	return ityp.tset
   314  }
   315  
   316  // TODO(gri) The intersectTermLists function belongs to the termlist implementation.
   317  //           The comparable type set may also be best represented as a term (using
   318  //           a special type).
   319  
   320  // intersectTermLists computes the intersection of two term lists and respective comparable bits.
   321  // xcomp, ycomp are valid only if xterms.isAll() and yterms.isAll() respectively.
   322  func intersectTermLists(xterms termlist, xcomp bool, yterms termlist, ycomp bool) (termlist, bool) {
   323  	terms := xterms.intersect(yterms)
   324  	// If one of xterms or yterms is marked as comparable,
   325  	// the result must only include comparable types.
   326  	comp := xcomp || ycomp
   327  	if comp && !terms.isAll() {
   328  		// only keep comparable terms
   329  		i := 0
   330  		for _, t := range terms {
   331  			assert(t.typ != nil)
   332  			if comparable(t.typ, false /* strictly comparable */, nil, nil) {
   333  				terms[i] = t
   334  				i++
   335  			}
   336  		}
   337  		terms = terms[:i]
   338  		if !terms.isAll() {
   339  			comp = false
   340  		}
   341  	}
   342  	assert(!comp || terms.isAll()) // comparable invariant
   343  	return terms, comp
   344  }
   345  
   346  func sortMethods(list []*Func) {
   347  	sort.Sort(byUniqueMethodName(list))
   348  }
   349  
   350  func assertSortedMethods(list []*Func) {
   351  	if !debug {
   352  		panic("assertSortedMethods called outside debug mode")
   353  	}
   354  	if !sort.IsSorted(byUniqueMethodName(list)) {
   355  		panic("methods not sorted")
   356  	}
   357  }
   358  
   359  // byUniqueMethodName method lists can be sorted by their unique method names.
   360  type byUniqueMethodName []*Func
   361  
   362  func (a byUniqueMethodName) Len() int           { return len(a) }
   363  func (a byUniqueMethodName) Less(i, j int) bool { return a[i].less(&a[j].object) }
   364  func (a byUniqueMethodName) Swap(i, j int)      { a[i], a[j] = a[j], a[i] }
   365  
   366  // invalidTypeSet is a singleton type set to signal an invalid type set
   367  // due to an error. It's also a valid empty type set, so consumers of
   368  // type sets may choose to ignore it.
   369  var invalidTypeSet _TypeSet
   370  
   371  // computeUnionTypeSet may be called with check == nil.
   372  // The result is &invalidTypeSet if the union overflows.
   373  func computeUnionTypeSet(check *Checker, unionSets map[*Union]*_TypeSet, pos token.Pos, utyp *Union) *_TypeSet {
   374  	if tset, _ := unionSets[utyp]; tset != nil {
   375  		return tset
   376  	}
   377  
   378  	// avoid infinite recursion (see also computeInterfaceTypeSet)
   379  	unionSets[utyp] = new(_TypeSet)
   380  
   381  	var allTerms termlist
   382  	for _, t := range utyp.terms {
   383  		var terms termlist
   384  		u := under(t.typ)
   385  		if ui, _ := u.(*Interface); ui != nil {
   386  			// For now we don't permit type parameters as constraints.
   387  			assert(!isTypeParam(t.typ))
   388  			terms = computeInterfaceTypeSet(check, pos, ui).terms
   389  		} else if !isValid(u) {
   390  			continue
   391  		} else {
   392  			if t.tilde && !Identical(t.typ, u) {
   393  				// There is no underlying type which is t.typ.
   394  				// The corresponding type set is empty.
   395  				t = nil // ∅ term
   396  			}
   397  			terms = termlist{(*term)(t)}
   398  		}
   399  		// The type set of a union expression is the union
   400  		// of the type sets of each term.
   401  		allTerms = allTerms.union(terms)
   402  		if len(allTerms) > maxTermCount {
   403  			if check != nil {
   404  				check.errorf(atPos(pos), InvalidUnion, "cannot handle more than %d union terms (implementation limitation)", maxTermCount)
   405  			}
   406  			unionSets[utyp] = &invalidTypeSet
   407  			return unionSets[utyp]
   408  		}
   409  	}
   410  	unionSets[utyp].terms = allTerms
   411  
   412  	return unionSets[utyp]
   413  }
   414
View as plain text