Scala Compiler 2.13.16 - scala.tools.nsc.typechecker.StdAttachments
Keywords: Scala Compiler 2.13.16 scala.tools.nsc.typechecker.StdAttachments

Scala Compiler2.13.16 < Back


# Packages

-  package root

  The Scala compiler and reflection APIs.

  The Scala compiler and reflection APIs.

  Definition Classes
    root
-  package scala
  Definition Classes
    root
-  package tools
  Definition Classes
    scala
-  package nsc
  Definition Classes
    tools
-  package typechecker
  Definition Classes
    nsc
-  package splain
  Definition Classes
    typechecker
- Adaptations
- Analyzer
- AnalyzerPlugins
- Checkable
- ConstantFolder
- ContextErrors
- ContextMode
- Contexts
- DestructureTypes
- Duplicators
- EtaExpansion
- Fingerprint
- Implicits
- ImplicitsStats
- ImportTracking
- Infer
- MacroAnnotationAttachments
- MacroAnnotationNamers
- Macros
- MacrosStats
- MethodSynthesis
- Namers
- NamesDefaults
- PatternTypers
- RefChecks
- StdAttachments
- StructuredTypeStrings
- SuperAccessors
- SyntheticMethods
- Tags
- TreeCheckers
- TypeDiagnostics
- TypeStrings
- Typers
- TypersStats
- TypersTracking
- Unapplies

t

scala.tools.nsc.typechecker

# StdAttachments

###

#### trait StdAttachments extends AnyRef

Self Type
  Analyzer
Source
  StdAttachments.scala

Linear Supertypes
AnyRef, Any
Known Subclasses
erasure, treeChecker, ScaladocAnalyzer, InteractiveAnalyzer, Erasure, Duplicator, SpecializationDuplicator, Analyzer, Duplicators, TreeCheckers
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. StdAttachments
2. AnyRef
3. Any

Implicitly

1. by any2stringadd
2. by StringFormat
3. by Ensuring
4. by ArrowAssoc

1. Hide All
2. Show All

Visibility

1. Public
2. Protected

### Type Members

1.  type MacroContext = Analyzer.UnaffiliatedMacroContext { val universe: StdAttachments.this.global.type }
2.  case class MacroExpanderAttachment(original: Global.Tree, desugared: Global.Tree) extends Product with Serializable

   Scratchpad for the macro expander, which is used to store all intermediate data except the details about the runtime.

3.  case class MacroExpansionAttachment(expandee: Global.Tree, expanded: Any) extends Product with Serializable

   Is added by the macro engine to originals and results of macro expansions.

   Is added by the macro engine to originals and results of macro expansions. Stores the original expandee as it entered the `macroExpand` function.

4.  case class MacroRuntimeAttachment(delayed: Boolean, typerContext: Analyzer.Context, macroContext: Option[Analyzer.MacroContext]) extends Product with Serializable
5.  case class OriginalTreeAttachment(original: Global.Tree) extends Product with Serializable

   Marks a tree that has been adapted by typer and sets the original tree that was in place before.

   Marks a tree that has been adapted by typer and sets the original tree that was in place before.

   Keeping track of the original trees were is an important feature for some compiler plugins (like Scalameta) and the incremental compiler (Zinc). In both cases, adapting trees loses information in some sense and do not allow external tools to capture some information stored in user-defined trees that are optimized away by early phases (mostly, typer).

   See how the absence of this attachment blocks Zinc: https://github.com/sbt/zinc/issues/227. Related: https://github.com/scala/scala-dev/issues/340.

   This attachment is, at the moment, only used to keep track of constant-folded constants. It has a generic wording in the hope that in the future can be reused in the same context to keep track of other adapted trees.

6.  case class SuperArgsAttachment(argss: List[List[Global.Tree]]) extends Product with Serializable

   After being synthesized by the parser, primary constructors aren't fully baked yet.

   After being synthesized by the parser, primary constructors aren't fully baked yet. A call to super in such constructors is just a fill-me-in-later dummy resolved later by `parentTypes`. This attachment coordinates `parentTypes` and `typedTemplate` and allows them to complete the synthesis.

7.  type UnaffiliatedMacroContext = Context

   Carries information necessary to expand the host tree.

   Carries information necessary to expand the host tree. At times we need to store this info, because macro expansion can be delayed until its targs are inferred. After a macro application has been successfully expanded, this attachment is destroyed.

### Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##: Int
   Definition Classes
     AnyRef → Any
3.  def +(other: String): String
   Implicit
     This member is added by an implicit conversion from StdAttachments toany2stringadd[StdAttachments] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (StdAttachments, B)
   Implicit
     This member is added by an implicit conversion from StdAttachments toArrowAssoc[StdAttachments] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
5.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
6.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
7.  def clone(): AnyRef
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws(classOf[java.lang.CloneNotSupportedException]) @native()
8.  def ensuring(cond: (StdAttachments) => Boolean, msg: => Any): StdAttachments
   Implicit
     This member is added by an implicit conversion from StdAttachments toEnsuring[StdAttachments] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
9.  def ensuring(cond: (StdAttachments) => Boolean): StdAttachments
   Implicit
     This member is added by an implicit conversion from StdAttachments toEnsuring[StdAttachments] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
10.  def ensuring(cond: Boolean, msg: => Any): StdAttachments
    Implicit
      This member is added by an implicit conversion from StdAttachments toEnsuring[StdAttachments] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
11.  def ensuring(cond: Boolean): StdAttachments
    Implicit
      This member is added by an implicit conversion from StdAttachments toEnsuring[StdAttachments] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
12.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
13.  def equals(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef → Any
14.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
15.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
16.  def hasMacroExpansionAttachment(any: Any): Boolean

    Determines whether the target is either an original or a result of a macro expansion.

    Determines whether the target is either an original or a result of a macro expansion. The parameter is of type `Any`, because macros can expand both into trees and into annotations.

17.  def hasSuperArgs(tree: Global.Tree): Boolean

    Determines whether the given tree has an associated SuperArgsAttachment.

18.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
19.  def isDynamicRewrite(tree: Global.Tree): Boolean
20.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
21.  def isMacroExpansionSuppressed(tree: Global.Tree): Boolean

    Determines whether a tree should not be expanded, because someone has put SuppressMacroExpansionAttachment on it or one of its children.

22.  def isMacroImplRef(tree: Global.Tree): Boolean

    Determines whether a tree should or should not be adapted, because someone has put MacroImplRefAttachment on it.

23.  def linkExpandeeAndDesugared(expandee: Global.Tree, desugared: Global.Tree): Unit

    After macro expansion is completed, links the expandee and the expansion result by annotating them both with a `MacroExpansionAttachment`.

24.  def linkExpandeeAndExpanded(expandee: Global.Tree, expanded: Any): Unit

    After macro expansion is completed, links the expandee and the expansion result by annotating them both with a `MacroExpansionAttachment`.

    After macro expansion is completed, links the expandee and the expansion result by annotating them both with a `MacroExpansionAttachment`. The `expanded` parameter is of type `Any`, because macros can expand both into trees and into annotations.

25.  def macroExpandee(tree: Global.Tree): Global.Tree

    Returns the original tree of the macro expansion if the argument is a macro expansion or EmptyTree otherwise.

26.  def macroExpanderAttachment(tree: Global.Tree): Analyzer.MacroExpanderAttachment

    Loads underlying MacroExpanderAttachment from a macro expandee or returns a default value for that attachment.

27.  def markDynamicRewrite(tree: Global.Tree): Global.Tree
28.  def markMacroImplRef(tree: Global.Tree): Global.Tree

    Marks the tree as a macro impl reference, which is a naked reference to a method.

    Marks the tree as a macro impl reference, which is a naked reference to a method.

    This is necessary for typechecking macro impl references (see `DefaultMacroCompiler.defaultResolveMacroImpl`), because otherwise typing a naked reference will result in the "follow this method with `_` if you want to treat it as a partially applied function" errors.

    This mark suppresses adapt except for when the annottee is a macro application.

29.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
30.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
31.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
32.  def superArgs(tree: Global.Tree): Option[List[List[Global.Tree]]]

    Convenience method for `SuperArgsAttachment`.

    Convenience method for `SuperArgsAttachment`. Compared with `MacroRuntimeAttachment` this attachment has different a usage pattern, so it really benefits from a dedicated extractor.

33.  def suppressMacroExpansion(tree: Global.Tree): tree.type

    Suppresses macro expansion of the tree by putting SuppressMacroExpansionAttachment on it.

34.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
35.  def toString(): String
    Definition Classes
      AnyRef → Any
36.  def unmarkDynamicRewrite(tree: Global.Tree): Global.Tree
37.  def unmarkMacroImplRef(tree: Global.Tree): Global.Tree

    Unmarks the tree as a macro impl reference (see `markMacroImplRef` for more information).

    Unmarks the tree as a macro impl reference (see `markMacroImplRef` for more information).

    This is necessary when a tree that was previously deemed to be a macro impl reference, typechecks to be a macro application. Then we need to unmark it, expand it and try to treat its expansion as a macro impl reference.

38.  def unsuppressMacroExpansion(tree: Global.Tree): tree.type

    Unsuppresses macro expansion of the tree by removing SuppressMacroExpansionAttachment from it and its children.

39.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
40.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
41.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()
42.  case object DynamicRewriteAttachment extends Product with Serializable

    Since mkInvoke, the applyDynamic/selectDynamic/etc desugarer, is disconnected from typedNamedApply, the applyDynamicNamed argument rewriter, the latter doesn’t know whether it needs to apply the rewriting because the application has just been desugared or it needs to hold on because it’s already performed a desugaring on this tree.

    Since mkInvoke, the applyDynamic/selectDynamic/etc desugarer, is disconnected from typedNamedApply, the applyDynamicNamed argument rewriter, the latter doesn’t know whether it needs to apply the rewriting because the application has just been desugared or it needs to hold on because it’s already performed a desugaring on this tree. This has led to scala/bug#8006.

    This attachment solves the problem by providing a means of communication between the two Dynamic desugarers, which solves the aforementioned issue.

43.  case object MacroImplRefAttachment extends Product with Serializable

    See also

      markMacroImplRef

44.  case object SuppressMacroExpansionAttachment extends Product with Serializable

    When present, suppresses macro expansion for the host.

    When present, suppresses macro expansion for the host. This is occasionally necessary, e.g. to prohibit eta-expansion of macros.

    Does not affect expandability of child nodes, there's context.withMacrosDisabled for that (but think thrice before using that API - see the discussion at https://github.com/scala/scala/pull/1639).

### Deprecated Value Members

1.  def formatted(fmtstr: String): String
   Implicit
     This member is added by an implicit conversion from StdAttachments toStringFormat[StdAttachments] performed by method StringFormat in scala.Predef.
   Definition Classes
     StringFormat
   Annotations
     @deprecated @inline()
   Deprecated

     (Since version 2.12.16) Use `formatString.format(value)` instead of `value.formatted(formatString)`, or use the `f""` string interpolator. In Java 15 and later, `formatted` resolves to the new method in String which has reversed parameters.

2.  def →[B](y: B): (StdAttachments, B)
   Implicit
     This member is added by an implicit conversion from StdAttachments toArrowAssoc[StdAttachments] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @deprecated
   Deprecated

     (Since version 2.13.0) Use `->` instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd fromStdAttachments to any2stringadd[StdAttachments]

### Inherited by implicit conversion StringFormat fromStdAttachments to StringFormat[StdAttachments]

### Inherited by implicit conversion Ensuring fromStdAttachments to Ensuring[StdAttachments]

### Inherited by implicit conversion ArrowAssoc fromStdAttachments to ArrowAssoc[StdAttachments]

### Ungrouped