package dotty.tools.dotc package core import util.HashSet import Symbols._ import TypeComparers._ import Flags._ import Names._ import StdNames._, NameOps._ import Scopes._ import Constants._ import Contexts._ import Annotations._ import SymDenotations._ import Decorators._ import Denotations._ import Periods._ import TypedTrees.tpd._, TypedTrees.TreeMapper, util.Texts._ import transform.Erasure import scala.util.hashing.{ MurmurHash3 => hashing } import collection.mutable object Types { /** A hash value indicating that the underlying type is not * cached in uniques. */ final val NotCached = 0 /** An alternative value returned from `hash` if the * computed hashCode would be `NotCached`. */ private final val NotCachedAlt = Int.MinValue /** A value that indicates that the hash code is unknown */ private final val HashUnknown = 1234 /** An alternative value if computeHash would otherwise yield HashUnknown */ private final val HashUnknownAlt = 4321 /** The class of types. * The principal subclasses and sub-objects are as follows: * * Type -+- ProxyType --+- NamedType ----+--- TypeRef * | | \ * | +- SingletonType-+-+- TermRef * | | | * | | +--- ThisType * | | +--- SuperType * | | +--- ConstantType * | | +--- MethodParam * | | +--- RefinedThis * | | +--- NoPrefix * | +- PolyParam * | +- RefinedType * | +- TypeBounds * | +- ExprType * | +- AnnotatedType * | * +- GroundType -+- AndType * +- OrType * +- MethodType -----+- ImplicitMethodType * | +- JavaMethodType * +- PolyType * +- ClassInfo * | * +- NoType * +- ErrorType * +- WildcardType */ abstract class Type extends DotClass with Showable { // ----- Tests ----------------------------------------------------- /** Is this type different from NoType? */ def exists: Boolean = true /** This type, if it exists, otherwise `that` type */ def orElse(that: => Type) = if (exists) this else that /** Is this type a value type? */ final def isValueType: Boolean = this.isInstanceOf[ValueType] /** Does this type denote a stable reference (i.e. singleton type)? */ final def isStable(implicit ctx: Context): Boolean = this match { case tp: TermRef => tp.termSymbol.isStable case _: SingletonType => true case _ => false } /** A type T is a legal prefix in a type selection T#A if * T is stable or T contains no uninstantiated type variables. */ final def isLegalPrefix(implicit ctx: Context): Boolean = isStable || memberNames(abstractTypeNameFilter).isEmpty /** Is this type guaranteed not to have `null` as a value? * For the moment this is only true for modules, but it could * be refined later. */ final def isNotNull(implicit ctx: Context): Boolean = widen.typeSymbol is ModuleClass /** Is this type produced as a repair for an error? */ final def isError(implicit ctx: Context): Boolean = (typeSymbol is Erroneous) || (termSymbol is Erroneous) /** Is some part of this type produced as a repair for an error? */ final def isErroneous(implicit ctx: Context): Boolean = existsPart(_.isError) /** A type is volatile if its DNF contains an alternative of the form * {P1, ..., Pn}, {N1, ..., Nk}, where the Pi are parent typerefs and the * Nj are refinement names, and one the 4 following conditions is met: * * 1. At least two of the parents Pi are abstract types. * 2. One of the parents Pi is an abstract type, and one other type Pj, * j != i has an abstract member which has the same name as an * abstract member of the whole type. * 3. One of the parents Pi is an abstract type, and one of the refinement * names Nj refers to an abstract member of the whole type. * 4. One of the parents Pi is an abstract type with a volatile upper bound. * * Lazy values are not allowed to have volatile type, as otherwise * unsoundness can result. */ final def isVolatile(implicit ctx: Context): Boolean = ctx.isVolatile(this) // ----- Higher-order combinators ----------------------------------- /** Returns true if there is a part of this type that satisfies predicate `p`. */ final def existsPart(p: Type => Boolean): Boolean = new ExistsAccumulator(p)(false, this) /** Returns true if all parts of this type that satisfy predicate `p`. */ final def forallParts(p: Type => Boolean): Boolean = !existsPart(!p(_)) /** Map function over elements of an AndType, rebuilding with & */ def mapAnd(f: Type => Type)(implicit ctx: Context): Type = this match { case AndType(tp1, tp2) => tp1.mapAnd(f) & tp2.mapAnd(f) case _ => f(this) } /** Map function over elements of an OrType, rebuilding with | */ final def mapOr(f: Type => Type)(implicit ctx: Context): Type = this match { case OrType(tp1, tp2) => tp1.mapOr(f) | tp2.mapOr(f) case _ => f(this) } // ----- Associated symbols ---------------------------------------------- /** The type symbol associated with the type */ final def typeSymbol(implicit ctx: Context): Symbol = this match { case tp: TypeRef => tp.symbol case tp: ClassInfo => tp.cls case ThisType(cls) => cls case tp: TypeProxy => tp.underlying.typeSymbol case _ => NoSymbol } /** The least non-trait class of which this type is a subtype. NoSymbol is none exists. */ final def classSymbol(implicit ctx: Context): Symbol = this match { case tp: ClassInfo => if (tp.cls is Trait) tp.classParents match { case p :: ps => p.classSymbol case nil => NoSymbol } else tp.cls case tp: TypeProxy => tp.underlying.typeSymbol case AndType(l, r) => val lsym = l.classSymbol val rsym = r.classSymbol if (lsym.isSubClass(rsym)) lsym else if (rsym.isSubClass(lsym)) rsym else NoSymbol case OrType(l, r) => val lsym = l.classSymbol val rsym = r.classSymbol lsym.info.baseClasses.find(rsym.isSubClass).getOrElse(NoSymbol) case _ => NoSymbol } /** The term symbol associated with the type */ final def termSymbol(implicit ctx: Context): Symbol = this match { case tp: TermRef => tp.symbol case tp: TypeProxy => tp.underlying.termSymbol case _ => NoSymbol } /** The base classes of this type as determined by ClassDenotation * in linearization order, with the class itself as first element. * Inherited by all type proxies. `Nil` for all other types. */ final def baseClasses(implicit ctx: Context): List[ClassSymbol] = this match { case tp: TypeProxy => tp.underlying.baseClasses case tp: ClassInfo => tp.cls.baseClasses case _ => Nil } /** The type parameters of this type are: * For a ClassInfo type, the type parameters of its class. * For a typeref referring to a class, the type parameters of the class. * Inherited by type proxies. * Empty list for all other types. */ final def typeParams(implicit ctx: Context): List[TypeSymbol] = this match { case tp: ClassInfo => tp.cls.typeParams case tp: TypeRef => val tsym = tp.typeSymbol if (tsym.isClass) tsym.typeParams else if (tsym.isAliasType) tp.underlying.typeParams else Nil case tp: TypeProxy => tp.underlying.typeParams case _ => Nil } // ----- Member access ------------------------------------------------- /** The scope of all declarations of this type. * Defined by ClassInfo, inherited by type proxies. * Empty scope for all other types. */ final def decls(implicit ctx: Context): Scope = this match { case tp: ClassInfo => tp.decls case tp: TypeProxy => tp.underlying.decls case _ => EmptyScope } /** A denotation containing the declaration(s) in this type with the given name. * The result is either a SymDenotation or a MultiDenotation of SymDenotations. * The info(s) are the original symbol infos, no translation takes place. */ final def decl(name: Name)(implicit ctx: Context): Denotation = findDecl(name, EmptyFlags) /** A denotation containing the non-private declaration(s) in this type with the given name */ final def nonPrivateDecl(name: Name)(implicit ctx: Context): Denotation = findDecl(name, Private) /** A denotation containing the declaration(s) in this type with the given * name, as seen from prefix type `pre`. Declarations that have a flag * in `excluded` are omitted. */ final def findDecl(name: Name, excluded: FlagSet)(implicit ctx: Context): Denotation = this match { case tp: ClassInfo => tp.decls.denotsNamed(name).filterExcluded(excluded).toDenot case tp: TypeProxy => tp.underlying.findDecl(name, excluded) } /** The member of this type with the given name */ final def member(name: Name)(implicit ctx: Context): Denotation = findMember(name, this, EmptyFlags) /** The non-private member of this type with the given name. */ final def nonPrivateMember(name: Name)(implicit ctx: Context): Denotation = findMember(name, this, Flags.Private) /** Find member of this type with given name and * produce a denotation that contains the type of the member * as seen from given prefix `pre`. Exclude all members that have * flags in `excluded` from consideration. */ final def findMember(name: Name, pre: Type, excluded: FlagSet)(implicit ctx: Context): Denotation = this match { case tp: RefinedType => val pdenot = tp.parent.findMember(name, pre, excluded) if (name eq tp.refinedName) pdenot & new JointRefDenotation(NoSymbol, tp.refinedInfo.substThis(tp, pre), Period.allInRun(ctx.runId)) else pdenot case tp: ThisType => val d = tp.underlying.findMember(name, pre, excluded) if (d.exists) d else // There is a special case to handle: // trait Super { this: Sub => private class Inner {} println(this.Inner) } // class Sub extends Super // When resolving Super.this.Inner, the normal logic goes to the self type and // looks for Inner from there. But this fails because Inner is private. // We fix the problem by having the following fallback case, which links up the // member in Super instead of Sub. // As an example of this in the wild, see // loadClassWithPrivateInnerAndSubSelf in ShowClassTests tp.cls.symbolicRef.findMember(name, pre, excluded) orElse d case tp: TypeRef => tp.denot.findMember(name, pre, excluded) case tp: TypeProxy => tp.underlying.findMember(name, pre, excluded) case tp: ClassInfo => tp.cls.findMember(name, pre, excluded) case AndType(l, r) => l.findMember(name, pre, excluded) & r.findMember(name, pre, excluded) case OrType(l, r) => (l.findMember(name, pre, excluded) | r.findMember(name, pre, excluded))(pre) case NoType => NoDenotation } /* !!! DEBUG ensuring { denot => denot.alternatives forall (_.symbol.name == name) }*/ /** The set of names of members of this type that pass the given name filter * when seen as members of `pre`. More precisely, these are all * of members `name` such that `keepOnly(pre, name)` is `true`. */ final def memberNames(keepOnly: NameFilter, pre: Type = this)(implicit ctx: Context): Set[Name] = this match { case tp: ClassInfo => tp.cls.memberNames(keepOnly) filter (keepOnly(pre, _)) case tp: RefinedType => val ns = tp.parent.memberNames(keepOnly, pre) if (keepOnly(pre, tp.refinedName)) ns + tp.refinedName else ns case tp: AndType => tp.tp1.memberNames(keepOnly, pre) | tp.tp2.memberNames(keepOnly, pre) case tp: OrType => tp.tp1.memberNames(keepOnly, pre) & tp.tp2.memberNames(keepOnly, pre) case tp: TypeProxy => tp.underlying.memberNames(keepOnly, pre) case _ => Set() } /** The set of names that denote an abstract member of this type * which is also an abstract member of `pre`. */ final def abstractMemberNames(pre: Type = this)(implicit ctx: Context): Set[Name] = memberNames(abstractTypeNameFilter, pre) | memberNames(abstractTermNameFilter, pre) /** The set of abstract term members of this type. */ final def abstractTermMembers(implicit ctx: Context): Set[SingleDenotation] = memberNames(abstractTermNameFilter) .flatMap(member(_).altsWith(_ is Deferred)) /** The set of abstract type members of this type. */ final def abstractTypeMembers(implicit ctx: Context): Set[SingleDenotation] = memberNames(abstractTypeNameFilter) .map(member(_).asInstanceOf[SingleDenotation]) /** The set of abstract members of this type. */ final def abstractMembers(implicit ctx: Context): Set[SingleDenotation] = abstractTermMembers | abstractTypeMembers /** The info of `sym`, seen as a member of this type. */ final def memberInfo(sym: Symbol)(implicit ctx: Context): Type = { sym.info.asSeenFrom(this, sym.owner) } /** This type seen as if it were the type of a member of prefix type `pre` * declared in class `cls`. */ final def asSeenFrom(pre: Type, cls: Symbol)(implicit ctx: Context): Type = if (!cls.membersNeedAsSeenFrom(pre)) this else ctx.asSeenFrom(this, pre, cls, null) // ----- Subtype-related -------------------------------------------- /** Is this type a subtype of that type? */ final def <:<(that: Type)(implicit ctx: Context): Boolean = ctx.typeComparer.isSubType(this, that) /** Is this type the same as that type? * This is the case iff `this <:< that` and `that <:< this`. */ final def =:=(that: Type)(implicit ctx: Context): Boolean = ctx.typeComparer.isSameType(this, that) /** Is this type close enough to that type so that members * with the two type would override each other? * This means: * - Either both types are polytypes with the same number of * type parameters and their result types match after renaming * corresponding type parameters * - Or both types are (possibly nullary) method types with equivalent type parameter types * and matching result types * - Or both types are equivalent * - Or phase.erasedTypes is false and both types are neither method nor * poly types. */ def matches(that: Type)(implicit ctx: Context): Boolean = ctx.typeComparer.matchesType( this, that, alwaysMatchSimple = !ctx.phase.erasedTypes) /** The basetype of this type with given class symbol */ final def baseType(base: Symbol)(implicit ctx: Context): Type = base.denot match { case classd: ClassDenotation => classd.baseTypeOf(this) case _ => NoType } def & (that: Type)(implicit ctx: Context): Type = ctx.glb(this, that) def | (that: Type)(implicit ctx: Context): Type = ctx.lub(this, that) // ----- Unwrapping types ----------------------------------------------- /** Widen from singleton type to its underlying non-singleton * base type by applying one or more `underlying` dereferences, * Also go from => T to T. * Identity for all other types. Example: * * class Outer { class C ; val x: C } * def o: Outer * .widen = o.C */ final def widen(implicit ctx: Context): Type = this match { case tp: SingletonType => tp.underlying.widen case tp: TypeBounds => tp.hi.widen case tp: ExprType => tp.resultType.widen case _ => this } /** If this is an alias type, its alias, otherwise the type itself */ final def dealias(implicit ctx: Context): Type = this match { case tp: TypeRef if (tp.symbol.isAliasType) => tp.info.bounds.hi case _ => this } /** Widen from constant type to its underlying non-constant * base type. */ final def deconst(implicit ctx: Context): Type = this match { case tp: ConstantType => tp.value.tpe case _ => this } /** If this is a refinement type, the unrefined parent, * else the type itself. */ final def unrefine: Type = this match { case tp @ RefinedType(tycon, _) => tycon.unrefine case _ => this } /** Map references to Object to references to Any; needed for Java interop */ final def objToAny(implicit ctx: Context) = if (typeSymbol == defn.ObjectClass && !ctx.phase.erasedTypes) defn.AnyType else this // ----- Access to parts -------------------------------------------- /** The normalized prefix of this type is: * For an alias type, the normalized prefix of its alias * For all other named type and class infos: the prefix. * Inherited by all other type proxies. * `NoType` for all other types. */ final def normalizedPrefix(implicit ctx: Context): Type = this match { case tp: NamedType => if (tp.symbol.isAliasType) tp.info.normalizedPrefix else tp.prefix case tp: ClassInfo => tp.prefix case tp: TypeProxy => tp.underlying.normalizedPrefix case _ => NoType } /** For a ClassInfo type, its parents, * Inherited by all type proxies. Empty for all other types. * Overwritten in ClassInfo, where parents is cached. */ def parents(implicit ctx: Context): List[TypeRef] = this match { case tp: TypeProxy => tp.underlying.parents case _ => List() } /** The parameter types of a PolyType or MethodType, Empty list for others */ final def paramTypess: List[List[Type]] = this match { case mt: MethodType => mt.paramTypes :: mt.resultType.paramTypess case pt: PolyType => pt.paramTypess case _ => Nil } /** The resultType of a PolyType, MethodType, or ExprType, the type itself for others */ def resultType: Type = this /** This type seen as a TypeBounds */ final def bounds(implicit ctx: Context): TypeBounds = this match { case tp: TypeBounds => tp case ci: ClassInfo => TypeAlias(ci.typeConstructor) case _ => TypeAlias(this) } /** The type parameter with given `name`. This tries first `decls` * in order not to provoke a cylce by forcing the info. If that yields * no symbol it tries `member` as an alternative. */ def typeParamNamed(name: TypeName)(implicit ctx: Context): Symbol = classSymbol.decls.lookup(name) orElse member(name).symbol /** The disjunctive normal form of this type. * This collects a set of alternatives, each alternative consisting * of a set of typerefs and a set of refinement names. Collected are * all type refs reachable by following aliases and type proxies, and * collecting the elements of conjunctions (&) and disjunctions (|). * The set of refinement names in each alternative * are the set of names in refinement types encountered during the collection. */ final def DNF(implicit ctx: Context): Set[(Set[TypeRef], Set[Name])] = this match { case tp: TypeRef => if (tp.symbol.isAliasType) tp.info.bounds.hi.DNF else Set((Set(tp), Set())) case RefinedType(parent, name) => for ((ps, rs) <- parent.DNF) yield (ps, rs + name) case tp: TypeProxy => tp.underlying.DNF case AndType(l, r) => for ((lps, lrs) <- l.DNF; (rps, rrs) <- r.DNF) yield (lps | rps, lrs | rrs) case OrType(l, r) => l.DNF | r.DNF case tp => Set((Set(), Set())) } // ----- Substitutions ----------------------------------------------------- /** Substitute all types that refer in their symbol attribute to * one of the symbols in `from` by the corresponding types in `to`. */ final def subst(from: List[Symbol], to: List[Type])(implicit ctx: Context): Type = if (from.isEmpty) this else { val from1 = from.tail if (from1.isEmpty) ctx.subst1(this, from.head, to.head, null) else { val from2 = from1.tail if (from2.isEmpty) ctx.subst2(this, from.head, to.head, from.tail.head, to.tail.head, null) else ctx.subst(this, from, to, null) } } /** Substitute all types of the form `PolyParam(from, N)` by * `PolyParam(to, N)`. */ final def subst(from: BindingType, to: BindingType)(implicit ctx: Context): Type = ctx.subst(this, from, to, null) /** Substitute all occurrences of `This(cls)` by `tp` */ final def substThis(cls: ClassSymbol, tp: Type)(implicit ctx: Context): Type = ctx.substThis(this, cls, tp, null) /** Substitute all occurrences of `RefinedThis(rt)` by `tp` */ final def substThis(rt: RefinedType, tp: Type)(implicit ctx: Context): Type = ctx.substThis(this, rt, tp, null) /** Substitute all occurrences of symbols in `from` by references to corresponding symbols in `to` */ final def substSym(from: List[Symbol], to: List[Symbol])(implicit ctx: Context): Type = ctx.substSym(this, from, to, null) // ----- Modeling type application -------------------------------- /** Encode the type resulting from applying this type to given arguments */ final def appliedTo(args: List[Type])(implicit ctx: Context): Type = { def recur(tp: Type, tparams: List[TypeSymbol], args: List[Type]): Type = args match { case arg :: args1 => if (tparams.isEmpty) { println(s"applied type mismatch: $this $args, typeParams = $typeParams, tsym = ${this.typeSymbol.debugString}") // !!! DEBUG println(s"precomplete decls = ${typeSymbol.decls.toList.map(_.denot).mkString("\n ")}") } val tparam = tparams.head val tp1 = RefinedType(tp, tparam.name, arg.toRHS(tparam)) recur(tp1, tparams.tail, args1) case nil => tp } def hkApp(tp: Type): Type = tp match { case AndType(l, r) => hkApp(l) orElse hkApp(r) case tp: RefinedType if defn.hkTraits contains tp.typeSymbol => tp case tp: TypeProxy => hkApp(tp.underlying) } def hkRefinement(tp: TypeRef): Type = { val hkArgs = if (tp.symbol.isCompleting) // This can happen if a higher-kinded type appears applied to arguments in its own bounds. // TODO: Catch this case and mark as "proceed at own risk" later. args map (_ => defn.InvariantBetweenClass.typeConstructor) else { if (tp.info == NoType) { println(s"typeless type ref: $tp") debugTrace = true tp.prefix.member(tp.name) } hkApp(tp.info).typeArgs } ((tp: Type) /: hkArgs.zipWithIndex.zip(args)) { case (parent, ((hkArg, idx), arg)) => val vsym = hkArg.typeSymbol val rhs = if (vsym == defn.InvariantBetweenClass) TypeAlias(arg) else if (vsym == defn.CovariantBetweenClass) TypeBounds.upper(arg) else { assert(vsym == defn.ContravariantBetweenClass) TypeBounds.lower(arg) } RefinedType(parent, tpnme.higherKindedParamName(idx), rhs) } } // begin applied type if (args.isEmpty) this else this match { case tp: PolyType => tp.instantiate(args) case tp: TypeRef => val tsym = tp.symbol if (tsym.isClass) recur(tp, tp.typeParams, args) else if (tsym.isAliasType) tp.underlying.appliedTo(args) else hkRefinement(tp) case tp: TypeProxy => tp.underlying.appliedTo(args) case AndType(l, r) => l.appliedTo(args) & r.appliedTo(args) } } final def appliedTo(arg: Type)(implicit ctx: Context): Type = appliedTo(arg :: Nil) final def appliedTo(arg1: Type, arg2: Type)(implicit ctx: Context): Type = appliedTo(arg1 :: arg2 :: Nil) /** Turn this type, which is used as an argument for * type parameter `tparam`, into a TypeBounds RHS */ final def toRHS(tparam: Symbol)(implicit ctx: Context): TypeBounds = { val v = tparam.variance if (v > 0) TypeBounds.upper(this) else if (v < 0) TypeBounds.lower(this) else TypeAlias(this) } /** If this is an encoding of a (partially) applied type, return its arguments, * otherwise return Nil */ final def typeArgs(implicit ctx: Context): List[Type] = { var tparams: List[TypeSymbol] = null def recur(tp: Type, refineCount: Int): mutable.ListBuffer[Type] = tp match { case tp @ RefinedType(tycon, name) => val buf = recur(tycon, refineCount + 1) if (buf == null) null else { if (tparams == null) tparams = tycon.typeParams if (buf.size < tparams.length) { val tparam = tparams(buf.size) if (name == tparam.name) buf += tp.refinedInfo.argType(tparam) else null } else null } case _ => if (refineCount == 0) null else new mutable.ListBuffer[Type] } val buf = recur(this, 0) if (buf == null) Nil else buf.toList } /** If this is the image of a type argument to type parameter `tparam`, * recover the type argument, otherwise NoType. */ final def argType(tparam: Symbol)(implicit ctx: Context): Type = this match { case TypeBounds(lo, hi) => val v = tparam.variance if (v > 0 && lo.typeSymbol == defn.NothingClass) hi else if (v < 0 && hi.typeSymbol == defn.AnyClass) lo else if (v == 0 && (lo eq hi)) lo else NoType case _ => NoType } /** If this type is of the normalized form Array[...[Array[T]...] * return the number of Array wrappers and T. * Otherwise return 0 and the type itself */ final def splitArray(implicit ctx: Context): (Int, Type) = { def recur(n: Int, tp: Type): (Int, Type) = tp match { case RefinedType(tycon, _) if tycon.dealias.typeSymbol == defn.ArrayClass => tp.typeArgs match { case arg :: Nil => recur(n + 1, arg) case _ => (n, tp) } case _ => (n, tp) } recur(0, this) } // ----- misc ----------------------------------------------------------- /** The signature of this type. This is by default NotAMethod, * but is overridden for PolyTypes, MethodTypes, and TermRefWithSignature types. * (the reason why we deviate from the "final-method-with-pattern-match-in-base-class" * pattern is that method signatures use caching, so encapsulation * is improved using an OO scheme). */ def signature(implicit ctx: Context): Signature = NotAMethod def toText(implicit ctx: Context): Text = ctx.toText(this, Printers.GlobalPrec) // ----- hashing ------------------------------------------------------ /** customized hash code of this type. * NotCached for uncached types. Cached types * compute hash and use it as the type's hashCode. */ def hash: Int protected def hashSeed = getClass.hashCode private def finishHash(hashCode: Int, arity: Int): Int = { val h = hashing.finalizeHash(hashCode, arity) if (h == NotCached) NotCachedAlt else h } private def finishHash(seed: Int, arity: Int, tp: Type): Int = { val elemHash = tp.hash if (elemHash == NotCached) return NotCached finishHash(hashing.mix(seed, elemHash), arity + 1) } private def finishHash(seed: Int, arity: Int, tp1: Type, tp2: Type): Int = { val elemHash = tp1.hash if (elemHash == NotCached) return NotCached finishHash(hashing.mix(seed, elemHash), arity + 1, tp2) } private def finishHash(seed: Int, arity: Int, tps: List[Type]): Int = { var h = seed var xs = tps var len = arity while (xs.nonEmpty) { val elemHash = xs.head.hash if (elemHash == NotCached) return NotCached h = hashing.mix(h, elemHash) xs = xs.tail len += 1 } finishHash(h, len) } private def finishHash(seed: Int, arity: Int, tp: Type, tps: List[Type]): Int = { val elemHash = tp.hash if (elemHash == NotCached) return NotCached finishHash(hashing.mix(seed, elemHash), arity + 1, tps) } protected def doHash(x: Any): Int = finishHash(hashing.mix(hashSeed, x.hashCode), 1) protected def doHash(tp: Type): Int = finishHash(hashSeed, 0, tp) protected def doHash(x1: Any, tp2: Type): Int = finishHash(hashing.mix(hashSeed, x1.hashCode), 1, tp2) protected def doHash(tp1: Type, tp2: Type): Int = finishHash(hashSeed, 0, tp1, tp2) protected def doHash(x1: Any, tp2: Type, tp3: Type): Int = finishHash(hashing.mix(hashSeed, x1.hashCode), 1, tp2, tp3) protected def doHash(tp1: Type, tps2: List[Type]): Int = finishHash(hashSeed, 0, tp1, tps2) protected def doHash(x1: Any, tp2: Type, tps3: List[Type]): Int = finishHash(hashing.mix(hashSeed, x1.hashCode), 1, tp2, tps3) } // end Type /** A marker trait for cached types */ trait CachedType extends Type def unique[T <: Type](tp: T)(implicit ctx: Context): T = { if (tp.hash == NotCached) tp else ctx.uniques.findEntryOrUpdate(tp).asInstanceOf[T] } /* !!! DEBUG ensuring ( result => tp.toString == result.toString || { println(s"cache mismatch; tp = $tp, cached = $result") false } ) */ // ----- Type categories ---------------------------------------------- /** A marker trait for type proxies. * Each implementation is expected to redefine the `underlying` method. */ abstract class TypeProxy extends Type { /** The type to which this proxy forwards operations. */ def underlying(implicit ctx: Context): Type } // Every type has to inherit one of the following four abstract type classes., // which determine whether the type is cached, and whether // it is a proxy of some other type. The duplication in their methods // is for efficiency. /** Instances of this class are cached and are not proxies. */ abstract class CachedGroundType extends Type with CachedType { private[this] var _hash = HashUnknown final def hash = { if (_hash == HashUnknown) { _hash = computeHash if (_hash == HashUnknown) _hash = HashUnknownAlt } _hash } override final def hashCode = if (hash == NotCached) System.identityHashCode(this) else hash def computeHash: Int } /** Instances of this class are cached and are proxies. */ abstract class CachedProxyType extends TypeProxy with CachedType { private[this] var _hash = HashUnknown final def hash = { if (_hash == HashUnknown) { _hash = computeHash if (_hash == HashUnknown) _hash = HashUnknownAlt } _hash } override final def hashCode = if (hash == NotCached) System.identityHashCode(this) else hash def computeHash: Int } /** Instances of this class are uncached and are not proxies. */ abstract class UncachedGroundType extends Type { final def hash = NotCached } /** Instances of this class are uncached and are proxies. */ abstract class UncachedProxyType extends TypeProxy { final def hash = NotCached } /** A marker trait for types that apply only to type symbols */ trait TypeType extends Type /** A marker trait for types that apply only to term symbols */ trait TermType extends Type /** A marker trait for types that can be types of values */ trait ValueType extends TermType /** A marker trait for types that are guaranteed to contain only a * single non-null value (they might contain null in addition). */ trait SingletonType extends TypeProxy with ValueType /** A marker trait for types that bind other types that refer to them. * Instances are: PolyType, MethodType, RefinedType. */ trait BindingType extends Type // --- NamedTypes ------------------------------------------------------------------ /** A NamedType of the form Prefix # name */ abstract class NamedType extends CachedProxyType with ValueType { val prefix: Type val name: Name private[this] var lastDenotation: Denotation = null /** The denotation currently denoted by this type */ def denot(implicit ctx: Context): Denotation = { val validPeriods = if (lastDenotation != null) lastDenotation.validFor else Nowhere val thisPeriod = ctx.period if (!(validPeriods contains thisPeriod)) { lastDenotation = if (validPeriods.runId == thisPeriod.runId) { lastDenotation.current } else { val d = loadDenot if (d.exists && !d.symbol.isAliasType && !prefix.isLegalPrefix) { val ex = new MalformedType(prefix, d) if (ctx.checkPrefix) throw ex else ctx.log(ex.getMessage) } if (d.exists || ctx.phaseId == FirstPhaseId) d else // name has changed; try load in earlier phase and make current denot(ctx.fresh.withPhase(ctx.phaseId - 1)).current } } lastDenotation } private[core] final def withDenot(denot: Denotation): this.type = { lastDenotation = denot this } protected def loadDenot(implicit ctx: Context) = prefix.member(name) def isType = name.isTypeName def isTerm = name.isTermName def symbol(implicit ctx: Context): Symbol = denot.symbol def info(implicit ctx: Context): Type = denot.info override def underlying(implicit ctx: Context): Type = info /** Guard against cycles that can arise if given `op` * follows info. The prblematic cases are a type alias to itself or * bounded by itself or a val typed as itself: * * type T <: T * val x: x.type * * These are errors but we have to make sure that operations do * not loop before the error is detected. */ final def controlled[T](op: => T)(implicit ctx: Context): T = try { ctx.underlyingRecursions += 1 if (ctx.underlyingRecursions < LogPendingUnderlyingThreshold) op else if (ctx.pendingUnderlying(this)) throw new CyclicReference(symbol) else try { ctx.pendingUnderlying += this op } finally { ctx.pendingUnderlying -= this } } finally { ctx.underlyingRecursions -= 1 } def derivedNamedType(prefix: Type)(implicit ctx: Context): NamedType = if (prefix eq this.prefix) this else newLikeThis(prefix) /** Create a NamedType of the same kind as this type, if possible, * but with a new prefix. For HasFixedSym instances another such * instance is only created if the symbol's owner is a base class of * the new prefix. If that is not the case, we fall back to a * NamedType or in the case of a TermRef, NamedType with signature. */ protected def newLikeThis(prefix: Type)(implicit ctx: Context): NamedType = NamedType(prefix, name) override def computeHash = doHash(name, prefix) override def equals(that: Any) = that match { case that: HasFixedSym => false case that: TermRefWithSignature => false case that: NamedType => this.prefix == that.prefix && this.name == that.name case _ => false } } abstract case class TermRef(override val prefix: Type, name: TermName) extends NamedType with SingletonType abstract case class TypeRef(override val prefix: Type, name: TypeName) extends NamedType trait HasFixedSym extends NamedType { protected val fixedSym: Symbol override def symbol(implicit ctx: Context): Symbol = fixedSym override def loadDenot(implicit ctx: Context) = { val denot = fixedSym.denot val owner = denot.owner if (owner.isTerm) denot else denot.asSeenFrom(prefix) } override def equals(that: Any) = that match { case that: HasFixedSym => this.prefix == that.prefix && this.fixedSym == that.fixedSym case _ => false } override def computeHash = doHash(fixedSym, prefix) } final class TermRefBySym(prefix: Type, name: TermName, val fixedSym: TermSymbol) extends TermRef(prefix, name) with HasFixedSym final class TermRefWithSignature(prefix: Type, name: TermName, val sig: Signature) extends TermRef(prefix, name) { override def signature(implicit ctx: Context) = sig override def loadDenot(implicit ctx: Context): Denotation = super.loadDenot.atSignature(sig) override def newLikeThis(prefix: Type)(implicit ctx: Context): TermRefWithSignature = TermRef.withSig(prefix, name, sig) override def equals(that: Any) = that match { case that: TermRefWithSignature => this.prefix == that.prefix && this.name == that.name && this.sig == that.sig case _ => false } override def computeHash = doHash((name, sig), prefix) } final class TypeRefBySym(prefix: Type, name: TypeName, val fixedSym: TypeSymbol) extends TypeRef(prefix, name) with HasFixedSym final class CachedTermRef(prefix: Type, name: TermName) extends TermRef(prefix, name) final class CachedTypeRef(prefix: Type, name: TypeName) extends TypeRef(prefix, name) object NamedType { def apply(prefix: Type, name: Name)(implicit ctx: Context) = if (name.isTermName) TermRef(prefix, name.asTermName) else TypeRef(prefix, name.asTypeName) def withSym(prefix: Type, sym: Symbol)(implicit ctx: Context) = if (sym.isTerm) TermRef.withSym(prefix, sym.asTerm) else TypeRef.withSym(prefix, sym.asType) } object TermRef { def apply(prefix: Type, name: TermName)(implicit ctx: Context): TermRef = unique(new CachedTermRef(prefix, name)) def withSym(prefix: Type, sym: TermSymbol)(implicit ctx: Context): TermRefBySym = unique(new TermRefBySym(prefix, sym.name, sym)) def withSig(prefix: Type, name: TermName, sig: Signature)(implicit ctx: Context): TermRefWithSignature = unique(new TermRefWithSignature(prefix, name, sig)) } object TypeRef { def apply(prefix: Type, name: TypeName)(implicit ctx: Context): TypeRef = unique(new CachedTypeRef(prefix, name)) def withSym(prefix: Type, sym: TypeSymbol)(implicit ctx: Context): TypeRefBySym = unique(new TypeRefBySym(prefix, sym.name, sym)) } // --- Other SingletonTypes: ThisType/SuperType/ConstantType --------------------------- /** The type cls.this */ abstract case class ThisType(cls: ClassSymbol) extends CachedProxyType with SingletonType { override def underlying(implicit ctx: Context) = cls.classInfo.selfType override def computeHash = doHash(cls) } final class CachedThisType(cls: ClassSymbol) extends ThisType(cls) object ThisType { def apply(cls: ClassSymbol)(implicit ctx: Context) = unique(new CachedThisType(cls)) } /** The type of a super reference cls.super where * `thistpe` is cls.this and `supertpe` is the type of the value referenced * by `super`. */ abstract case class SuperType(thistpe: Type, supertpe: Type) extends CachedProxyType with SingletonType { override def underlying(implicit ctx: Context) = supertpe def derivedSuperType(thistpe: Type, supertpe: Type)(implicit ctx: Context) = if ((thistpe eq this.thistpe) && (supertpe eq this.supertpe)) this else SuperType(thistpe, supertpe) override def computeHash = doHash(thistpe, supertpe) } final class CachedSuperType(thistpe: Type, supertpe: Type) extends SuperType(thistpe, supertpe) object SuperType { def apply(thistpe: Type, supertpe: Type)(implicit ctx: Context) = unique(new CachedSuperType(thistpe, supertpe)) } /** A constant type with single `value`. */ abstract case class ConstantType(value: Constant) extends CachedProxyType with SingletonType { override def underlying(implicit ctx: Context) = value.tpe override def computeHash = doHash(value) } final class CachedConstantType(value: Constant) extends ConstantType(value) object ConstantType { def apply(value: Constant)(implicit ctx: Context) = unique(new CachedConstantType(value)) } // --- Refined Type --------------------------------------------------------- /** A refined type parent { refinement } * @param refinedName The name of the refinement declaration * @param infoFn: A function that produces the info of the refinement declaration, * given the refined type itself. */ abstract case class RefinedType(parent: Type, refinedName: Name)(infoFn: RefinedType => Type) extends CachedProxyType with BindingType with ValueType { val refinedInfo: Type = infoFn(this) override def underlying(implicit ctx: Context) = parent def derivedRefinedType(parent: Type, refinedName: Name, refinedInfo: Type)(implicit ctx: Context): RefinedType = if ((parent eq this.parent) && (refinedName eq this.refinedName) && (refinedInfo eq this.refinedInfo)) this else if (refinedName.isHkParamName && typeParams.length > refinedName.hkParamIndex) derivedRefinedType( parent, parent.typeParams.apply(refinedName.hkParamIndex).name, refinedInfo) else RefinedType(parent, refinedName, rt => refinedInfo.substThis(this, RefinedThis(rt))) override def equals(that: Any) = that match { case that: RefinedType => this.parent == that.parent && this.refinedName == that.refinedName && this.refinedInfo == that.refinedInfo case _ => false } override def computeHash = doHash(refinedName, refinedInfo, parent) override def toString = s"RefinedType($parent, $refinedName, $refinedInfo | hash = $hashCode)" } class CachedRefinedType(parent: Type, refinedName: Name, infoFn: RefinedType => Type) extends RefinedType(parent, refinedName)(infoFn) object RefinedType { def make(parent: Type, names: List[Name], infoFns: List[RefinedType => Type])(implicit ctx: Context): Type = if (names.isEmpty) parent else make(RefinedType(parent, names.head, infoFns.head), names.tail, infoFns.tail) def apply(parent: Type, name: Name, infoFn: RefinedType => Type)(implicit ctx: Context): RefinedType = unique(new CachedRefinedType(parent, name, infoFn)) def apply(parent: Type, name: Name, info: Type)(implicit ctx: Context): RefinedType = apply(parent, name, scala.Function.const(info): (RefinedType => Type)) } // --- AndType/OrType --------------------------------------------------------------- abstract case class AndType(tp1: Type, tp2: Type) extends CachedGroundType with ValueType { assert(tp1.isInstanceOf[TermType] && tp2.isInstanceOf[TermType], s"$tp1 & $tp2") type This <: AndType def derivedAndType(tp1: Type, tp2: Type)(implicit ctx: Context) = if ((tp1 eq this.tp1) && (tp2 eq this.tp2)) this else AndType(tp1, tp2) override def computeHash = doHash(tp1, tp2) } final class CachedAndType(tp1: Type, tp2: Type) extends AndType(tp1, tp2) object AndType { def apply(tp1: Type, tp2: Type)(implicit ctx: Context) = unique(new CachedAndType(tp1, tp2)) } abstract case class OrType(tp1: Type, tp2: Type) extends CachedGroundType with ValueType { def derivedOrType(tp1: Type, tp2: Type)(implicit ctx: Context) = if ((tp1 eq this.tp1) && (tp2 eq this.tp2)) this else OrType(tp1, tp2) override def computeHash = doHash(tp1, tp2) } final class CachedOrType(tp1: Type, tp2: Type) extends OrType(tp1, tp2) object OrType { def apply(tp1: Type, tp2: Type)(implicit ctx: Context) = unique(new CachedOrType(tp1, tp2)) } // ----- Method types: MethodType/ExprType/PolyType/MethodParam/PolyParam --------------- // Note: method types are cached whereas poly types are not. // The reason is that most poly types are cyclic via poly params, // and therefore two different poly types would never be equal. abstract case class MethodType(paramNames: List[TermName], paramTypes: List[Type]) (resultTypeExp: MethodType => Type) extends CachedGroundType with BindingType with TermType { override lazy val resultType = resultTypeExp(this) def isJava = false def isImplicit = false lazy val isDependent = resultType existsPart { case MethodParam(mt, _) => mt eq this case _ => false } private[this] var _signature: Signature = _ private[this] var signatureRunId: Int = NoRunId override def signature(implicit ctx: Context): Signature = { if (ctx.runId != signatureRunId) { _signature = computeSignature signatureRunId = ctx.runId } _signature } private def computeSignature(implicit ctx: Context): Signature = { val followSig = resultType match { case rtp: MethodType => rtp.signature case _ => Nil } (paramTypes map Erasure.paramSignature) ++ followSig } def derivedMethodType(paramNames: List[TermName], paramTypes: List[Type], restpe: Type)(implicit ctx: Context) = if ((paramNames eq this.paramNames) && (paramTypes eq this.paramTypes) && (restpe eq this.resultType)) this else { val restpeExpr = (x: MethodType) => restpe.subst(this, x) if (isJava) JavaMethodType(paramNames, paramTypes)(restpeExpr) else if (isImplicit) ImplicitMethodType(paramNames, paramTypes)(restpeExpr) else MethodType(paramNames, paramTypes)(restpeExpr) } def instantiate(argTypes: List[Type])(implicit ctx: Context): Type = if (isDependent) new InstMethodMap(this, argTypes) apply resultType else resultType override def equals(that: Any) = that match { case that: MethodType => this.paramNames == that.paramNames && this.paramTypes == that.paramTypes && this.resultType == that.resultType case _ => false } override def computeHash = doHash(paramNames, resultType, paramTypes) protected def prefixString = "MethodType" override def toString = s"$prefixString($paramNames, $paramTypes, $resultType)" } final class CachedMethodType(paramNames: List[TermName], paramTypes: List[Type])(resultTypeExp: MethodType => Type) extends MethodType(paramNames, paramTypes)(resultTypeExp) { override def equals(that: Any) = super.equals(that) && that.isInstanceOf[CachedMethodType] } final class JavaMethodType(paramNames: List[TermName], paramTypes: List[Type])(resultTypeExp: MethodType => Type) extends MethodType(paramNames, paramTypes)(resultTypeExp) { override def isJava = true override def equals(that: Any) = super.equals(that) && that.isInstanceOf[JavaMethodType] override def computeHash = super.computeHash + 1 override protected def prefixString = "JavaMethodType" } final class ImplicitMethodType(paramNames: List[TermName], paramTypes: List[Type])(resultTypeExp: MethodType => Type) extends MethodType(paramNames, paramTypes)(resultTypeExp) { override def isImplicit = true override def equals(that: Any) = super.equals(that) && that.isInstanceOf[ImplicitMethodType] override def computeHash = super.computeHash + 2 override protected def prefixString = "ImplicitMethodType" } abstract class MethodTypeCompanion { def apply(paramNames: List[TermName], paramTypes: List[Type])(resultTypeExp: MethodType => Type)(implicit ctx: Context): MethodType def apply(paramNames: List[TermName], paramTypes: List[Type], resultType: Type)(implicit ctx: Context): MethodType = apply(paramNames, paramTypes)(_ => resultType) def fromSymbols(params: List[Symbol], resultType: Type)(implicit ctx: Context) = { def transformResult(mt: MethodType) = resultType.subst(params, (0 until params.length).toList map (MethodParam(mt, _))) apply(params map (_.name.asTermName), params map (_.info))(transformResult _) } } object MethodType extends MethodTypeCompanion { def apply(paramNames: List[TermName], paramTypes: List[Type])(resultTypeExp: MethodType => Type)(implicit ctx: Context) = unique(new CachedMethodType(paramNames, paramTypes)(resultTypeExp)) } object JavaMethodType extends MethodTypeCompanion { def apply(paramNames: List[TermName], paramTypes: List[Type])(resultTypeExp: MethodType => Type)(implicit ctx: Context) = unique(new JavaMethodType(paramNames, paramTypes)(resultTypeExp)) } object ImplicitMethodType extends MethodTypeCompanion { def apply(paramNames: List[TermName], paramTypes: List[Type])(resultTypeExp: MethodType => Type)(implicit ctx: Context) = unique(new ImplicitMethodType(paramNames, paramTypes)(resultTypeExp)) } abstract case class ExprType(override val resultType: Type) extends CachedProxyType with TermType { override def underlying(implicit ctx: Context): Type = resultType override def signature(implicit ctx: Context): Signature = Nil def derivedExprType(resultType: Type)(implicit ctx: Context) = if (resultType eq this.resultType) this else ExprType(resultType) override def computeHash = doHash(resultType) } final class CachedExprType(resultType: Type) extends ExprType(resultType) object ExprType { def apply(resultType: Type)(implicit ctx: Context) = unique(new CachedExprType(resultType)) } case class PolyType(paramNames: List[TypeName])(paramBoundsExp: PolyType => List[TypeBounds], resultTypeExp: PolyType => Type) extends UncachedGroundType with BindingType with TermType { lazy val paramBounds = paramBoundsExp(this) override lazy val resultType = resultTypeExp(this) override def signature(implicit ctx: Context) = resultType.signature def instantiate(argTypes: List[Type])(implicit ctx: Context): Type = new InstPolyMap(this, argTypes) apply resultType def instantiateBounds(argTypes: List[Type])(implicit ctx: Context): List[TypeBounds] = paramBounds.mapConserve(new InstPolyMap(this, argTypes).apply(_).bounds) def derivedPolyType(paramNames: List[TypeName], paramBounds: List[TypeBounds], restpe: Type)(implicit ctx: Context) = if ((paramNames eq this.paramNames) && (paramBounds eq this.paramBounds) && (restpe eq this.resultType)) this else PolyType(paramNames)( x => paramBounds mapConserve (_.subst(this, x).bounds), x => restpe.subst(this, x)) // need to override hashCode and equals to be object identity // because paramNames by itself is not discriminatory enough override def hashCode = System.identityHashCode(this) override def equals(other: Any) = this eq other.asInstanceOf[AnyRef] override def toString = s"PolyType($paramNames, $paramBounds, $resultType)" } object PolyType { def fromSymbols(tparams: List[Symbol], resultType: Type)(implicit ctx: Context) = { def transform(pt: PolyType, tp: Type) = tp.subst(tparams, (0 until tparams.length).toList map (PolyParam(pt, _))) apply(tparams map (_.name.asTypeName))( pt => tparams map (tparam => transform(pt, tparam.info).bounds), pt => transform(pt, resultType)) } } abstract class BoundType extends UncachedProxyType with ValueType { type BT <: BindingType def binder: BT def copy(bt: BT): Type } case class MethodParam(binder: MethodType, paramNum: Int) extends BoundType with SingletonType { type BT = MethodType override def underlying(implicit ctx: Context) = binder.paramTypes(paramNum) def copy(bt: BT) = MethodParam(bt, paramNum) // need to customize hashCode and equals to prevent infinite recursion for dep meth types. override def hashCode = doHash(System.identityHashCode(binder) + paramNum) override def equals(that: Any) = that match { case that: MethodParam => (this.binder eq that.binder) && this.paramNum == that.paramNum case _ => false } override def toString = s"MethodParam(${binder.paramNames(paramNum)})" } case class PolyParam(binder: PolyType, paramNum: Int) extends BoundType { type BT = PolyType override def underlying(implicit ctx: Context) = binder.paramBounds(paramNum) def copy(bt: BT) = PolyParam(bt, paramNum) // no customized hashCode/equals needed because cycle is broken in PolyType override def toString = s"PolyParam(${binder.paramNames(paramNum)})" } case class RefinedThis(binder: RefinedType) extends BoundType with SingletonType { type BT = RefinedType override def underlying(implicit ctx: Context) = binder.parent def copy(bt: BT) = RefinedThis(bt) // need to customize hashCode and equals to prevent infinite recursion for // refinements that refer to the refinement type via this override def hashCode = doHash(System.identityHashCode(binder)) override def equals(that: Any) = that match { case that: RefinedThis => this.binder eq that.binder case _ => false } override def toString = s"RefinedThis(${binder.hashCode})" } // ------ ClassInfo, Type Bounds ------------------------------------------------------------ /** The info of a class during a period, roughly * @param pre The prefix on which parents, decls, and selfType need to be rebased. * @param cls The class symbol. * @param classParents The parent types of this class. * These are all normalized to be TypeRefs by moving any refinements * to be member definitions of the class itself. * @param decls The symbols defined directly in this class. * @param optSelfType The type of `this` in this class, if explicitly given, NoType otherwise. */ abstract case class ClassInfo( prefix: Type, cls: ClassSymbol, classParents: List[TypeRef], decls: Scope, optSelfType: Type) extends CachedGroundType with TypeType { def selfType(implicit ctx: Context): Type = if (optSelfType.exists) optSelfType else cls.typeConstructor def rebase(tp: Type)(implicit ctx: Context): Type = if (prefix eq cls.owner.thisType) tp else tp.substThis(cls, prefix) def typeConstructor(implicit ctx: Context): Type = if ((cls is PackageClass) || cls.owner.isTerm) TypeRef.withSym(prefix, cls) else TypeRef(prefix, cls.name).withDenot(cls.denot.asSeenFrom(prefix)) // cached because baseType needs parents private var parentsCache: List[TypeRef] = null override def parents(implicit ctx: Context): List[TypeRef] = { if (parentsCache == null) parentsCache = classParents.mapConserve(rebase(_).asInstanceOf[TypeRef]) parentsCache } def derivedClassInfo(prefix: Type)(implicit ctx: Context) = if (prefix eq this.prefix) this else ClassInfo(prefix, cls, classParents, decls, optSelfType) def derivedClassInfo(prefix: Type, classParents: List[TypeRef], optSelfType: Type)(implicit ctx: Context) = if ((prefix eq this.prefix) && (classParents eq this.classParents) && (optSelfType eq this.optSelfType)) this else ClassInfo(prefix, cls, classParents, decls, optSelfType) override def computeHash = doHash(cls, prefix) } final class CachedClassInfo(prefix: Type, cls: ClassSymbol, classParents: List[TypeRef], decls: Scope, optSelfType: Type) extends ClassInfo(prefix, cls, classParents, decls, optSelfType) object ClassInfo { def apply(prefix: Type, cls: ClassSymbol, classParents: List[TypeRef], decls: Scope, optSelfType: Type = NoType)(implicit ctx: Context) = unique(new CachedClassInfo(prefix, cls, classParents, decls, optSelfType)) } /** Type bounds >: lo <: hi */ abstract case class TypeBounds(lo: Type, hi: Type) extends CachedProxyType with TypeType { assert(lo.isInstanceOf[TermType], lo+" "+lo.getClass) assert(hi.isInstanceOf[TermType], hi+" "+hi.getClass) override def underlying(implicit ctx: Context): Type = hi def derivedTypeBounds(lo: Type, hi: Type)(implicit ctx: Context) = if ((lo eq this.lo) && (hi eq this.hi)) this else TypeBounds(lo, hi) def contains(tp: Type)(implicit ctx: Context) = lo <:< tp && tp <:< hi def &(that: TypeBounds)(implicit ctx: Context): TypeBounds = TypeBounds(this.lo | that.lo, this.hi & that.hi) def |(that: TypeBounds)(implicit ctx: Context): TypeBounds = TypeBounds(this.lo & that.lo, this.hi | that.hi) override def & (that: Type)(implicit ctx: Context) = that match { case that: TypeBounds => this & that } override def | (that: Type)(implicit ctx: Context) = that match { case that: TypeBounds => this | that } def map(f: Type => Type)(implicit ctx: Context): TypeBounds = TypeBounds(f(lo), f(hi)) override def computeHash = doHash(lo, hi) override def toString = if (lo eq hi) s"TypeAlias($lo)" else s"TypeBounds($lo, $hi)" } final class CachedTypeBounds(lo: Type, hi: Type) extends TypeBounds(lo, hi) object TypeBounds { def empty(implicit ctx: Context) = apply(defn.NothingType, defn.AnyType) def upper(hi: Type)(implicit ctx: Context) = apply(defn.NothingType, hi) def lower(lo: Type)(implicit ctx: Context) = apply(lo, defn.AnyType) def apply(lo: Type, hi: Type)(implicit ctx: Context) = unique(new CachedTypeBounds(lo, hi)) } object TypeAlias { def apply(tp: Type)(implicit ctx: Context) = TypeBounds(tp, tp) def unapply(tp: Type): Option[Type] = tp match { case TypeBounds(lo, hi) if lo eq hi => Some(lo) case _ => None } } // ----- Annotated and Import types ----------------------------------------------- /** An annotated type tpe @ annot */ case class AnnotatedType(annot: Annotation, tpe: Type) extends UncachedProxyType with ValueType { // todo: cache them? override def underlying(implicit ctx: Context): Type = tpe def derivedAnnotatedType(annot: Annotation, tpe: Type) = if ((annot eq this.annot) && (tpe eq this.tpe)) this else AnnotatedType(annot, tpe) } object AnnotatedType { def make(annots: List[Annotation], underlying: Type) = if (annots.isEmpty) underlying else (underlying /: annots)((tp, ann) => AnnotatedType(ann, tp)) } // Special type objects and classes ----------------------------------------------------- /** The type of an import clause tree */ case class ImportType(expr: SharedTree) extends UncachedGroundType /** Sentinal for "missing type" */ case object NoType extends CachedGroundType { override def exists = false override def computeHash = hashSeed } /** Missing prefix */ case object NoPrefix extends CachedGroundType { override def computeHash = hashSeed } abstract class ErrorType extends UncachedGroundType with ValueType object ErrorType extends ErrorType case object WildcardType extends UncachedGroundType // ----- TypeMaps -------------------------------------------------------------------- abstract class TypeMap(implicit ctx: Context) extends (Type => Type) { thisMap => def apply(tp: Type): Type /** Map this function over given type */ def mapOver(tp: Type): Type = tp match { case tp: NamedType => tp.derivedNamedType(this(tp.prefix)) case _: ThisType | _: BoundType => tp case tp: RefinedType => tp.derivedRefinedType(this(tp.parent), tp.refinedName, this(tp.refinedInfo)) case tp @ MethodType(pnames, ptypes) => tp.derivedMethodType(pnames, ptypes mapConserve this, this(tp.resultType)) case tp @ ExprType(restpe) => tp.derivedExprType(this(restpe)) case tp @ PolyType(pnames) => tp.derivedPolyType( pnames, tp.paramBounds.mapConserve(apply(_).bounds), this(tp.resultType)) case tp @ SuperType(thistp, supertp) => tp.derivedSuperType(this(thistp), this(supertp)) case tp @ TypeBounds(lo, hi) => if (lo eq hi) { val lo1 = this(lo) tp.derivedTypeBounds(lo1, lo1) } else { tp.derivedTypeBounds(this(lo), this(hi)) } case tp @ AnnotatedType(annot, underlying) => tp.derivedAnnotatedType(mapOver(annot), this(underlying)) case _ => tp } def mapOver(syms: List[Symbol]): List[Symbol] = ctx.mapSymbols(syms, this) def mapOver(scope: Scope): Scope = { val elems = scope.toList val elems1 = mapOver(elems) if (elems1 eq elems) scope else newScopeWith(elems1: _*) } def mapOver(annot: Annotation): Annotation = annot.derivedAnnotation(mapOver(annot.tree)) def mapOver(tree: Tree): Tree = new TreeMapper(this).apply(tree) def andThen(f: Type => Type): TypeMap = new TypeMap { def apply(tp: Type) = f(thisMap(tp)) } } object IdentityTypeMap extends TypeMap()(NoContext) { def apply(tp: Type) = tp } class InstMethodMap(mt: MethodType, argtypes: List[Type])(implicit ctx: Context) extends TypeMap { def apply(tp: Type) = tp match { case MethodParam(`mt`, n) => argtypes(n) case _ => mapOver(tp) } } class InstPolyMap(pt: PolyType, argtypes: List[Type])(implicit ctx: Context) extends TypeMap { def apply(tp: Type) = tp match { case PolyParam(`pt`, n) => argtypes(n) case _ => mapOver(tp) } } // ----- TypeAccumulators ---------------------------------------------------- abstract class TypeAccumulator[T] extends ((T, Type) => T) { def apply(x: T, tp: Type): T protected def apply(x: T, annot: Annotation): T = x // don't go into annotations def foldOver(x: T, tp: Type): T = tp match { case tp: NamedType => this(x, tp.prefix) case _: ThisType | _: BoundType => x case tp: RefinedType => this(this(x, tp.parent), tp.refinedInfo) case tp @ MethodType(pnames, ptypes) => this((x /: ptypes)(this), tp.resultType) case ExprType(restpe) => this(x, restpe) case tp @ PolyType(pnames) => this((x /: tp.paramBounds)(this), tp.resultType) case SuperType(thistp, supertp) => this(this(x, thistp), supertp) case TypeBounds(lo, hi) => if (lo eq hi) this(x, lo) else this(this(x, lo), hi) case AnnotatedType(annot, underlying) => this(this(x, annot), underlying) case _ => x } } class ExistsAccumulator(p: Type => Boolean) extends TypeAccumulator[Boolean] { def apply(x: Boolean, tp: Type) = x || p(tp) || foldOver(x, tp) } // ----- Name Filters -------------------------------------------------- /** A name filter selects or discards a member name of a type `pre`. * To enable efficient caching, name filters have to satisfy the * following invariant: If `keep` is a name filter, and `pre` has * class `C` as a base class, then * * keep(pre, name) => keep(C.this, name) */ abstract class NameFilter { def apply(pre: Type, name: Name)(implicit ctx: Context): Boolean } /** A filter for names of abstract types of a given type */ object abstractTypeNameFilter extends NameFilter { def apply(pre: Type, name: Name)(implicit ctx: Context): Boolean = name.isTypeName && ((pre member name).symbol is Deferred) } /** A filter for names of deferred term definitions of a given type */ object abstractTermNameFilter extends NameFilter { def apply(pre: Type, name: Name)(implicit ctx: Context): Boolean = name.isTermName && (pre member name).hasAltWith(_ is Deferred) } object takeAllFilter extends NameFilter { def apply(pre: Type, name: Name)(implicit ctx: Context): Boolean = true } // ----- Exceptions ------------------------------------------------------------- class TypeError(msg: String) extends Exception(msg) class FatalTypeError(msg: String) extends TypeError(msg) class MalformedType(pre: Type, denot: Denotation) extends FatalTypeError(s"malformed type: $pre is not a legal prefix for $denot") class CyclicReference(val denot: SymDenotation) extends FatalTypeError(s"cyclic reference involving $denot") // ----- Misc utilities --------------------------------------------------------- /** True if two lists have the same length. Since calling length on linear sequences * is O(n), it is an inadvisable way to test length equality. */ final def sameLength[T](xs: List[T], ys: List[T]): Boolean = xs match { case _ :: xs1 => ys match { case _ :: ys1 => sameLength(xs1, ys1) case _ => false } case _ => ys.isEmpty } var debugTrace = false }