SymDenotation

The class or term symbol up to which this symbol is accessible, or RootClass if it is public. As java protected statics are otherwise completely inaccessible in scala, they are treated as public.

The field accessed by this getter or setter, or if it does not exist, the getter

Add given annotation to the annotations of this denotation

Add the given annotation without parameters to the annotations of this denotation

Add all given annotations to this symbol

All symbols overridden by this denotation.

The annotations of this denotation

The annotations without ensuring that the symbol is completed. Used for diagnostics where we don't want to force symbols.

Update the annotations of this denotation

The typeRef applied to its own type parameters

Cast to class denotation

The fully qualified name on the JVM of the class corresponding to this symbol.

If false, this symbol cannot possibly participate in an override, either as overrider or overridee.

If this is a sealed class, its known children in the order of textual occurrence

The class with the same (type-) name as this module or module class, and which is also defined in the same scope and compilation unit. NoSymbol if this class does not exist.

The module object with the same (term-) name as this class or module class, and which is also defined in the same scope and compilation unit. NoSymbol if this module does not exist.

If this denotation is not completed, run the completer. The resulting info might be another completer.

The completer of this denotation. @pre: Denotation is not yet completed

Is this symbol a module that contains opaque aliases?

Copy mamberNames and baseData caches from given denotation, provided they are valid at given phase.

Copy this denotation, overriding selective fields

The current declaration in this symbol's class owner that has the same name as this one, and, if there are several, also has the same signature.

Is this a subclass of base, and is the denoting symbol also different from Null or Nothing?

The name, except

• if this is a module class, strip the module class suffix
• if this is a companion object with a clash-avoiding name, strip the "avoid clash" suffix

The owner, skipping package objects and non-lazy valdefs.

The class containing this denotation. If this denotation is already a class, return itself Definitions flagged with JavaStatic are treated specially. Their enclosing class is not the lexically enclosing class, but in turn the enclosing class of the latter. This reflects the context created by Context#superCallContext, Context#thisCallArgContext for these definitions.

Note, that as packages have ClassSymbols, top level classes will have an enclosingClass with Package flag set.

The class containing this denotation which has the given effective name.

The closest enclosing extension method containing this definition, including methods outside the current class.

The closest enclosing method containing this definition. A local dummy owner is mapped to the primary constructor of the class.

The package class containing this denotation

The class that encloses the owner of the current context and that is a subclass of this class. NoSymbol if no such class exists.

Make sure this denotation is fully completed.

If denotation is private, remove the Private flag and expand the name if necessary

The expanded name of this denotation.

Returns all matching symbols defined in parents of the selftype.

The extension parameter of this extension method

Keep only those annotations that satisfy p

The flag set

Update the flag set

The encoded flat name of this denotation, where joined names are separated by separator characters.

fullName where `.' is the separator character

The encoded full path name of this denotation, where outer names and inner names are separated by separator strings as indicated by the given name kind. Drops package objects. Represents each term in the owner chain by a simple _$.

The encoded full path name of this denotation (separated by prefixKind), followed by the separator implied by kind and the given name. Drops package objects. Represents each term in the owner chain by a simple _$.

Optionally, the annotation matching the given class symbol

Does this denotation have an annotation matching the given class symbol?

Does this symbol have defined or inherited default parameters? Default parameters are recognized until erasure.

Denotation points to unique symbol; false for overloaded denotations and JointRef denotations.

The type info, or, if symbol is not yet completed, the completer

The version of this SingleDenotation that was valid in the first phase of this run.

Install this denotation as the result of the given denotation transformer.

Has this denotation one of given flag set?

Has this denotation the given flag set, whereas none of the flags in butNot are set?

Is symbol known to not exist?

Is this symbol an abstract or alias type?

Is this symbol an abstract type or type parameter?

Is this symbol an abstract type?

Is this definition accessible as a member of tree with type pre?

Is this symbol an alias type?

Has this denotation all of the flags in fs set?

Has this denotation all of the flags in fs set, whereas none of the flags in butNot are set?

Is this a Scala or Java annotation ?

Is this symbol an anonymous class?

Is this symbol concrete, or that symbol deferred?

Is this denotation a class?

Is this the constructor of a class?

Do this symbol and cls represent a pair of a given or implicit method and its associated class that were defined by a single definition? This can mean one of two things:

• the method and class are defined in a structural given instance, or
• the class is an implicit class and the method is its implicit conversion.

Is this denotation defined in the same scope and compilation unit as that symbol?

The denotation is completed: info is not a lazy type and attributes have defined values

The denotation is in train of being completed

Is this the constructor of a trait or a class

Is this definition contained in boundary? Same as ownersIterator contains boundary but more efficient.

Is this symbol the empty package class or its companion object?

An erased value or an erased inline method or field

A symbol is effectively final if it cannot be overridden in a subclass

A class is effectively sealed if has the final or sealed modifier, or it is defined in Scala 3 and is neither abstract nor open.

Is this symbol the empty package class or its companion object?

is this symbol the result of an erroneous definition?

A class is extensible if it is not final, nor a module class, nor an anonymous class.

Is this a getter?

Is this a symbol representing an import?

A member of class base is incomplete if (1) it is declared deferred or (2) it is abstract override and its super symbol in base is nonexistent or incomplete.

Is this symbol the same or a linked class of sym?

Is this a local template dummmy?

Is this a denotation of a real class that does not have - either direct or inherited - initialization code?

Is symbol a class for which no runtime representation exists?

Is this symbol a class of which null is a value?

Is this symbol a class of which null is a value after erasure? For example, if -Yexplicit-nulls is set, String is not nullable before erasure, but it becomes nullable after erasure.

Is symbol a primitive numeric value class?

Has this denotation one of the flags in fs set?

Has this denotation one of the flags in fs set, whereas none of the flags in butNot are set?

Is this symbol a user-defined opaque alias type?

Is this symbol a package object or its module class?

Does this symbol denote the primary constructor of its enclosing class?

Is symbol a primitive value class?

Is this denotation a non-trait class?

Is this a "real" method? A real method is a method which is:

• not an accessor
• not an anonymous function

Is this symbol a class representing a refinement? These classes are used only temporarily in Typer and Unpickler as an intermediate step for creating Refinement types.

Does this method or field need to be retained at runtime

Does this method need to be retained at runtime

Is this symbol the root class or its companion object?

Is this a Scala 2 macro

Is this a Scala 2 macro defined

Is this the denotation of a self symbol of some class? This is the case if one of two conditions holds:

1. It is the symbol referred to in the selfInfo part of the ClassInfo which is the type of this symbol's owner.
2. This symbol is owned by a class, it's selfInfo field refers to a type (indicating the self definition does not introduce a name), and the symbol's name is "_". TODO: Find a more robust way to characterize self symbols, maybe by spending a Flag on them?

Is this symbol a class that extends java.io.Serializable ?

Is this a setter?

Is this a denotation of a stable term (or an arbitrary type)? Terms are stable if they are idempotent (as in TreeInfo.Idempotent): that is, they always return the same value, if any.

A member is stable, basically, if it behaves like a field projection: that is, it projects a constant result out of its owner.

However, a stable member might not yet be initialized (if it is an object or anyhow lazy). So the first call to a stable member might fail and/or produce side effects.

Is this denotation static (i.e. with no outer instance)?

Does this symbol denote the static constructor of its enclosing class?

Is this a package class or module class that defines static symbols?

Is this a subclass of the given class base?

Is this symbol a class that extends AnyVal? Overridden in ClassDenotation

Is this a synthetic method that represents conversions between representations of a value class These methods are generated in ExtensionMethods and used in ElimErasedValueType.

Symbol is an owner that would be skipped by effectiveOwner. Skipped are

• package objects
• non-lazy valdefs

Is this symbol a toplevel definition in a package object?

A class that in source code would be lexically enclosing

If this is a class, the module class of its companion object. If this is a module class, its companion class. NoSymbol otherwise.

Make denotation not exist.

()T and => T types should be treated as equivalent for this symbol. Note: For the moment, we treat Scala-2 compiled symbols as loose matching, because the Scala library does not always follow the right conventions. Examples are: isWhole(), toInt(), toDouble() in BigDecimal, Numeric, RichInt, ScalaNumberProxy.

The non-private symbol whose name and type matches the type of this symbol in the given class.

The non-private member of site whose name and type matches the type of this symbol

If false, this class member cannot possibly participate in an override, either as overrider or overridee.

Do members of this symbol need translation via asSeenFrom when accessed via prefix pre?

If this a module, return the corresponding class, if this is a module, return itself, otherwise NoSymbol

The NamedType representing this denotation at its original location. Same as either typeRef or termRef depending whether this denotes a type or not.

Equivalent to allOverriddenSymbols.headOption.getOrElse(NoSymbol) but more efficient.

The alias of an opaque type alias that's stored in the self type of the containing object.

If this is an opaque alias, replace the right hand side info by appropriate bounds and store info in the refinement of the self type of the enclosing class. Otherwise return info

The effective name with which the denoting symbol was created

The owner with which the denoting symbol was created.

The symbol, in class inClass, that is overridden by this denotation in class siteClass.

The symbol overriding this symbol in given subclass inClass.

The owner of the symbol; overridden in NoDenotation

The chain of owners of this denotation, starting with the denoting symbol itself

The symbols of each type parameter list and value parameter list of this method, or Nil if this isn't a method.

Makes use of rawParamss when present, or constructs fresh parameter symbols otherwise. This method can be allocation-heavy.

The primary constructor of a class or trait, NoSymbol if not applicable.

The privateWithin boundary, NoSymbol if no boundary is given.

If this is a method, the parameter symbols, by section. Both type and value parameters are included. Empty sections are skipped.

Like termRef, but objects in the prefix are represented by their singleton type, this means we output pre.O.member rather than pre.O$.this.member.

This is required to avoid owner crash in ExplicitOuter. See tests/pos/i10769.scala

Like thisType, but objects in the type are represented by their singleton type, this means we output pre.O.member rather than pre.O$.this.member.

Like typeRef, but objects in the prefix are represented by their singleton type, this means we output pre.O.member rather than pre.O$.this.member.

This is required to avoid owner crash in ExplicitOuter. See tests/pos/i10769.scala

Register target as a companion; overridden in ClassDenotation

The registered companion; overridden in ClassDenotation

Remove annotation with given class from this denotation

Unset given flags(s) of this denotation

Same as sealedStrictDescendants but prepends this symbol as well.

Recursively assemble all children of this symbol, Preserves order of insertion.

Set given flags(s) of this denotation

Set flag flags in current phase and in all phases that follow

Set applicable flags in {NoInits, PureInterface}

Skips symbol that are not owned by a class

If this is a weak owner, its owner, otherwise the denoting symbol.

If this a module class, return the corresponding module, if this is a module, return itself, otherwise NoSymbol

The symbol accessed by a super in the definition of this symbol when seen from class base. This symbol is always concrete. pre: this.owner is in the base class sequence of base.

The name given in a @targetName annotation if one is present, name otherwise

The type This(cls), where cls is this class, NoPrefix for all other symbols

Returns a string representation of the object.

The default representation is platform dependent.

The top-level class containing this denotation, except for a toplevel module, where its module class is returned.

Apply a transformation f to all denotations in this group that start at or after given phase. Denotations are replaced while keeping the same validity periods.

Apply transform f to all annotations of this denotation

The flags to be used for a type parameter owned by this symbol. Overridden by ClassDenotation.

The type parameters of a class symbol, Nil for all other symbols

The field accessed by a getter or setter, or if it does not exists, the getter of a setter, or if that does not exist the symbol itself.

The same as getAnnotation, but without ensuring that the symbol carrying the annotation is completed

The symbols defined in this class or object. Careful! This does not force the type, so is compilation order dependent. This method should be used only in the following circumstances:

1. When accessing type parameters or type parameter accessors (both are entered before completion).
2. When obtaining the current scope in order to enter, rename or delete something there.
3. When playing it safe in order not to raise CylicReferences, e.g. for printing things or taking more efficient shortcuts (e.g. the stillValid test).

Optionally, the info if it is completed

Remove any annotations with same class as annot, and add annot

The variance of this type parameter or type member as a subset of {Covariant, Contravariant}

The denotation made up from the alternatives of this denotation that are accessible from prefix pre, or NoDenotation if no accessible alternative exists.

Map f over all single denotations and aggregate the results with g.

The set of alternative single-denotations making up this denotation

The alternatives of this denotation that satisfy the predicate p.

The denotation with info(s) as seen from prefix type

Resolve overloaded denotation to pick the ones with the given signature when seen from prefix site.

If this is a SingleDenotation, return it, otherwise throw a TypeError

Group contains a denotation that refers to given symbol

The period (interval of phases) for which there exists a valid denotation in this flock.

Produce a denotation that is valid for the given context. Usually called when !(validFor contains ctx.period) (even though this is not a precondition). If the runId of the context is the same as runId of this denotation, the right flock member is located, or, if it does not exist yet, created by invoking a transformer (@See Transformers). If the runId's differ, but this denotation is a SymDenotation and its toplevel owner class or module is still a member of its enclosing package, then the whole flock is brought forward to be valid in the new runId. Otherwise the symbol is stale, which constitutes an internal error.

If this denotation is overloaded, filter with given predicate. If result is still overloaded throw a TypeError. Note: disambiguate is slightly different from suchThat in that single-denotations that do not satisfy the predicate are left alone (whereas suchThat would map them to NoDenotation).

Is this denotation different from NoDenotation or an ErrorDenotation?

A fallback text representation, if the pattern matching in Printers does not have a case for this showable element

Keep only those denotations in this group which have a signature that's not already defined by denots.

Keep only those denotations in this group that have all of the flags in required, but none of the flags in excluded.

Keep only those denotations in this group which satisfy predicate p.

Find member of this denotation with given name, all required flags and no excluded flag, and produce a denotation that contains the type of the member as seen from given prefix pre.

First/last denotation in the group

Does this denotation have an alternative that satisfies the predicate p?

The type info. The info is an instance of TypeType iff this is a type denotation Uncompleted denotations set myInfo to a LazyType.

Invalidate all caches and fields that depend on base classes and their contents

Is this denotation overloaded?

True if the info of this denotation comes from a refinement.

Is this a reference to a term symbol?

A denotation with the info of this denotation transformed using f

Keep only those inherited members M of this predenotation for which the following is true

• M is not marked Private
• If M has a unique symbol, it does not appear in prevDenots.
• M's signature as seen from prefix pre does not appear in ownDenots Return the denotation as seen from pre. Called from SymDenotations.computeMember. There, ownDenots are the denotations found in the base class, which shadow any inherited denotations with the same signature. prevDenots are the denotations that are defined in the class or inherited from a base type which comes earlier in the linearization.

Group contains a denotation with the same signature as other

matches without a target name check.

For definitions coming from different languages, we pick a common language to compute their signatures. This allows us for example to override some Java definitions from Scala even if they have a different erasure (see i8615b, i9109b), Erasure takes care of adding any necessary bridge to make this work at runtime.

The alternative of this denotation that has a type matching targetType when seen as a member of type site and that has a target name matching targetName, or NoDenotation if none exists.

Form a denotation by conjoining with denotation that.

NoDenotations are dropped. MultiDenotations are handled by merging parts with same signatures. SingleDenotations with equal signatures are joined by following this sequence of steps:

1. If exactly one the denotations has an inaccessible symbol, pick the other one.
2. Otherwise, if one of the infos overrides the other one, and the associated symbol does not score strictly lower than the other one, pick the associated denotation.
3. Otherwise, if the two infos can be combined with infoMeet, pick that as result info, and pick the symbol that scores higher as result symbol, or pick sym1 as a tie breaker. The picked info and symbol are combined in a JointDenotation.
4. Otherwise, if one of the two symbols scores strongly higher than the other one, pick the associated denotation.
5. Otherwise return a multi-denotation consisting of both denotations.

Symbol scoring is determined according to the following ranking where earlier criteria trump later ones. Cases marked with (*) give a strong score advantage, the others a weak one.

1. The symbol exists, and the other one does not. (*)
2. The symbol is not a bridge, but the other one is. (*)
3. The symbol is concrete, and the other one is deferred
4. The symbol appears before the other in the linearization of pre
5. The symbol's visibility is strictly greater than the other one's.
6. The symbol is a method, but the other one is not.

The name of the denotation

If this denotation does not exist, fallback to alternative

For SymDenotation, this is NoPrefix. For other denotations this is the prefix under which the denotation was constructed.

Note that asSeenFrom might return a SymDenotation and therefore in general one cannot rely on prefix being set, see Config.reuseSymDenotations for details.

Return symbol in this denotation that satisfies the given predicate. if generateStubs is specified, return a stubsymbol if denotation is a missing ref. Throw a TypeError if predicate fails to disambiguate symbol or no alternative matches.

The string representation of this showable element.

Show declaration string; useful for showing declarations as seen from subclasses.

The string representation with each line after the first one indented by the given given margin (in spaces).

The summarized string representation of this showable element. Recursion depth is limited to some smallish value. Default is Config.summarizeDepth.

Overload of signature which lets the caller pick the language used to compute the signature of the info. Useful to match denotations defined in different classes (see matchesLoosely).

For SymDenotations, the language-specific signature of the info, depending on where the symbol is defined. For non-SymDenotations, the Scala 3 signature.

Invariants:

• Before erasure, the signature of a denotation is always equal to the signature of its corresponding initial denotation.
• Two distinct overloads will have SymDenotations with distinct signatures (the SELECTin tag in Tasty relies on this to refer to an overload unambiguously). Note that this only applies to SymDenotations, in general we cannot assume that distinct SingleDenotations will have distinct signatures (cf #9050).

Skip any denotations that have been removed by an installAfter or that are otherwise undefined.

The unique alternative of this denotation that satisfies the predicate p, or NoDenotation if no satisfying alternative exists.

Convert to full denotation by &-ing all elements

The text representation of this showable element. This normally dispatches to a pattern matching method in Printers.

The union of two groups.

The next SingleDenotation in this run, with wrap-around from last to first.

There may be several SingleDenotations with different validity representing the same underlying definition at different phases. These are called a "flock". Flock members are generated by