t

scala.tools.nsc.typechecker

TypeDiagnostics

trait TypeDiagnostics extends AnyRef

An interface to enable higher configurability of diagnostic messages regarding type errors. This is barely a beginning as error messages are distributed far and wide across the codebase. The plan is to partition error messages into some broad groups and provide some mechanism for being more or less verbose on a selective basis. Possible groups include such examples as

arity errors kind errors variance errors ambiguity errors volatility/stability errors implementation restrictions

And more, and there is plenty of overlap, so it'll be a process.

Self Type
Analyzer with StdAttachments
Source
TypeDiagnostics.scala
Version

1.0

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. TypeDiagnostics
  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. All

Type Members

  1. case class TypeDiag(tp: Global.Type, sym: Global.Symbol) extends Ordered[(TypeDiagnostics.this)#TypeDiag] with Product with Serializable
  2. trait TyperDiagnostics extends AnyRef
  3. class checkUnused extends AnyRef

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 TypeDiagnostics toany2stringadd[TypeDiagnostics] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (TypeDiagnostics, B)
    Implicit
    This member is added by an implicit conversion from TypeDiagnostics toArrowAssoc[TypeDiagnostics] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def abstractVarMessage(sym: Global.Symbol): String

    An explanatory note to be added to error messages when there's a problem with abstract var defs

  7. def alternatives(tree: Global.Tree): List[Global.Type]
  8. def alternativesString(tree: Global.Tree): String
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  11. def decodeWithKind(name: Global.Name, owner: Global.Symbol): String
  12. def disambiguate(ss: List[String]): collection.immutable.List[String]
  13. def ensuring(cond: (TypeDiagnostics) => Boolean, msg: => Any): TypeDiagnostics
    Implicit
    This member is added by an implicit conversion from TypeDiagnostics toEnsuring[TypeDiagnostics] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: (TypeDiagnostics) => Boolean): TypeDiagnostics
    Implicit
    This member is added by an implicit conversion from TypeDiagnostics toEnsuring[TypeDiagnostics] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean, msg: => Any): TypeDiagnostics
    Implicit
    This member is added by an implicit conversion from TypeDiagnostics toEnsuring[TypeDiagnostics] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean): TypeDiagnostics
    Implicit
    This member is added by an implicit conversion from TypeDiagnostics toEnsuring[TypeDiagnostics] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  19. final def exampleTuplePattern(names: List[Global.Name]): String

    [a, b, c] => "(a, b, c)" [a, B] => "(param1, param2)" [a, B, c] => "(param1, ..., param2)"

  20. def existentialContext(tp: Global.Type): String
  21. def explainAlias(tp: Global.Type): String
  22. def explainAnyVsAnyRef(found: Global.Type, req: Global.Type): String
  23. def explainVariance(found: Global.Type, req: Global.Type): String

    Look through the base types of the found type for any which might have been valid subtypes if given conformant type arguments.

    Look through the base types of the found type for any which might have been valid subtypes if given conformant type arguments. Examine those for situations where the type error would have been eliminated if the variance were different. In such cases, append an additional explanatory message.

    TODO: handle type aliases better.

  24. def finalOwners(tpe: Global.Type): Boolean
  25. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  26. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from TypeDiagnostics toStringFormat[TypeDiagnostics] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  27. def foundReqMsg(found: Global.Type, req: Global.Type): String
  28. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  29. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  30. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  31. def linePrecedes(t1: Global.Tree, t2: Global.Tree): Boolean
  32. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  35. def posPrecedes(p1: Global.Position, p2: Global.Position): Boolean

    Does the positioned line assigned to t1 precede that of t2?

  36. final def recursivelyFinal(tpe: Global.Type): Boolean
    Annotations
    @tailrec()
  37. def restrictionError(pos: Global.Position, unit: Global.CompilationUnit, msg: String): Unit
  38. def restrictionWarning(pos: Global.Position, unit: Global.CompilationUnit, msg: String): Unit

    For errors which are artifacts of the implementation: such messages indicate that the restriction may be lifted in the future.

  39. def setAddendum(pos: Global.Position, msg: () => String): Unit
  40. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  41. def toString(): String
    Definition Classes
    AnyRef → Any
  42. def treeSymTypeMsg(tree: Global.Tree): String
  43. def typePatternAdvice(sym: Global.Symbol, ptSym: Global.Symbol): String
  44. def typingInPattern[T](body: => T): T

    Devising new ways of communicating error info out of desperation to work on error messages.

    Devising new ways of communicating error info out of desperation to work on error messages. This is used by typedPattern to wrap its business so we can generate a sensible error message when things go south.

  45. def underlyingSymbol(member: Global.Symbol): Global.Symbol

    The symbol which the given accessor represents (possibly in part).

    The symbol which the given accessor represents (possibly in part). This is used for error messages, where we want to speak in terms of the actual declaration or definition, not in terms of the generated setters and getters.

    TODO: is it wise to create new symbols simply to generate error message? is this safe in interactive/resident mode?

  46. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  47. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  48. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  49. def withAddendum(pos: Global.Position): (String) => String
  50. def withDisambiguation[T](locals: List[Global.Symbol], types: Global.Type*)(op: => T): T

    Given any number of types, alters the name information in the symbols until they can be distinguished from one another: then executes the given code.

    Given any number of types, alters the name information in the symbols until they can be distinguished from one another: then executes the given code. The names are restored and the result is returned.

  51. object checkDead

Deprecated Value Members

  1. def →[B](y: B): (TypeDiagnostics, B)
    Implicit
    This member is added by an implicit conversion from TypeDiagnostics toArrowAssoc[TypeDiagnostics] 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 fromTypeDiagnostics to any2stringadd[TypeDiagnostics]

Inherited by implicit conversion StringFormat fromTypeDiagnostics to StringFormat[TypeDiagnostics]

Inherited by implicit conversion Ensuring fromTypeDiagnostics to Ensuring[TypeDiagnostics]

Inherited by implicit conversion ArrowAssoc fromTypeDiagnostics to ArrowAssoc[TypeDiagnostics]

Ungrouped