Cleanup Symbol.isXYZ methods and add docs

Author: nicolasstucki

compiler/src/dotty/tools/dotc/tastyreflect/ReflectionCompilerInterface.scala

@@ -1516,15 +1516,6 @@ class ReflectionCompilerInterface(val rootContext: core.Contexts.Context) extend
   def Symbol_isAbstractType(self: Symbol)(given Context): Boolean = self.isAbstractType
   def Symbol_isClassConstructor(self: Symbol)(given Context): Boolean = self.isClassConstructor
 
-  def Symbol_isPackageDefSymbol(symbol: Symbol)(given Context): Boolean =
-    symbol.is(core.Flags.Package)
-
-  def Symbol_isTypeSymbol(symbol: Symbol)(given Context): Boolean =
-    symbol.isType
-
-  def Symbol_isClassDefSymbol(symbol: Symbol)(given Context): Boolean =
-    symbol.isClass
-
   def Symbol_fields(self: Symbol)(given Context): List[Symbol] =
     self.unforcedDecls.filter(isField)
 
@@ -1572,20 +1563,33 @@ class ReflectionCompilerInterface(val rootContext: core.Contexts.Context) extend
   def Symbol_isTypeParam(self: Symbol)(given Context): Boolean =
     self.isTypeParam
 
-  def Symbol_isTypeBindSymbol(symbol: Symbol)(given Context): Boolean =
-    symbol.isType && symbol.is(core.Flags.Case)
+  def Symbol_isType(symbol: Symbol)(given Context): Boolean =
+    symbol.isType
 
-  def Symbol_isTermSymbol(symbol: Symbol)(given Context): Boolean =
+  def Symbol_isTerm(symbol: Symbol)(given Context): Boolean =
     symbol.isTerm
 
-  def Symbol_isDefDefSymbol(symbol: Symbol)(given Context): Boolean =
-    symbol.isTerm && symbol.is(core.Flags.Method)
+  def Symbol_isPackageDef(symbol: Symbol)(given ctx: Context): Boolean =
+    symbol.is(Flags.Package)
+
+  def Symbol_isClassDef(symbol: Symbol)(given Context): Boolean =
+    symbol.isClass
+
+  def Symbol_isTypeDef(symbol: Symbol)(given ctx: Context): Boolean =
+    symbol.isType && !symbol.isClass && !symbol.is(Flags.Case)
+
+  def Symbol_isValDef(symbol: Symbol)(given Context): Boolean =
+    symbol.isTerm && !symbol.is(core.Flags.Method) && !symbol.is(core.Flags.Case)
+
+  def Symbol_isDefDef(symbol: Symbol)(given Context): Boolean =
+    symbol.is(core.Flags.Method)
+
+  def Symbol_isBind(symbol: Symbol)(given Context): Boolean =
+    symbol.is(core.Flags.Case, butNot = Enum | Module) && !symbol.isClass
 
   def Symbol_signature(self: Symbol)(given Context): Signature =
     self.signature
 
-  def Symbol_isValDefSymbol(symbol: Symbol)(given Context): Boolean =
-    symbol.isTerm && !symbol.is(core.Flags.Method) && !symbol.is(core.Flags.Case)
 
   def Symbol_moduleClass(self: Symbol)(given Context): Symbol = self.moduleClass
 

library/src/scala/tasty/reflect/CompilerInterface.scala

@@ -1239,12 +1239,6 @@ trait CompilerInterface {
 
   def Symbol_isDefinedInCurrentRun(self: Symbol)(given ctx: Context): Boolean
 
-  def Symbol_isPackageDefSymbol(symbol: Symbol)(given ctx: Context): Boolean
-
-  def Symbol_isTypeSymbol(symbol: Symbol)(given ctx: Context): Boolean
-
-  def Symbol_isClassDefSymbol(symbol: Symbol)(given ctx: Context): Boolean
-
   /** Fields directly declared in the class */
   def Symbol_fields(self: Symbol)(given ctx: Context): List[Symbol]
 
@@ -1270,17 +1264,32 @@ trait CompilerInterface {
 
   def Symbol_isTypeParam(self: Symbol)(given ctx: Context): Boolean
 
-  def Symbol_isTypeBindSymbol(symbol: Symbol)(given ctx: Context): Boolean
+  def Symbol_isPackageDef(symbol: Symbol)(given ctx: Context): Boolean
+
+  /** Is this the definition of a type? */
+  def Symbol_isType(symbol: Symbol)(given ctx: Context): Boolean
+
+  /** Is this the definition of a term? */
+  def Symbol_isTerm(symbol: Symbol)(given ctx: Context): Boolean
 
-  def Symbol_isTermSymbol(symbol: Symbol)(given ctx: Context): Boolean
+  /** Is this the definition of a ClassDef tree? */
+  def Symbol_isClassDef(symbol: Symbol)(given ctx: Context): Boolean
 
-  def Symbol_isDefDefSymbol(symbol: Symbol)(given ctx: Context): Boolean
+  /** Is this the definition of a TypeDef tree? */
+  def Symbol_isTypeDef(symbol: Symbol)(given ctx: Context): Boolean
+
+  /** Is this the definition of a DefDef tree? */
+  def Symbol_isDefDef(symbol: Symbol)(given ctx: Context): Boolean
+
+  /** Is this the definition of a ValDef tree? */
+  def Symbol_isValDef(symbol: Symbol)(given ctx: Context): Boolean
+
+  /** Is this the definition of a Bind pattern? */
+  def Symbol_isBind(symbol: Symbol)(given ctx: Context): Boolean
 
   /** Signature of this definition */
   def Symbol_signature(self: Symbol)(given ctx: Context): Signature
 
-  def Symbol_isValDefSymbol(symbol: Symbol)(given ctx: Context): Boolean
-
   /** The class symbol of the companion module class */
   def Symbol_moduleClass(self: Symbol)(given ctx: Context): Symbol
 

library/src/scala/tasty/reflect/SymbolOps.scala

@@ -63,17 +63,36 @@ trait SymbolOps extends Core { selfSymbolOps: FlagsOps =>
     def isAbstractType(given ctx: Context): Boolean = internal.Symbol_isAbstractType(self)
     def isClassConstructor(given ctx: Context): Boolean = internal.Symbol_isClassConstructor(self)
 
-    def isType(given ctx: Context): Boolean = internal.Symbol_isTypeSymbol(self)
-    def isTerm(given ctx: Context): Boolean = internal.Symbol_isTermSymbol(self)
-    def isValDef(given ctx: Context): Boolean = internal.Symbol_isValDefSymbol(self)
-    def isDefDef(given ctx: Context): Boolean = internal.Symbol_isDefDefSymbol(self)
-    def isTypeDef(given ctx: Context): Boolean = self.isType && !self.flags.is(Flags.Case)
-    def isClassDef(given ctx: Context): Boolean = internal.Symbol_isClassDefSymbol(self)
-    def isBind(given ctx: Context): Boolean = self.isTerm && self.flags.is(Flags.Case)
-    def isTypeBind(given ctx: Context): Boolean = self.isType && self.flags.is(Flags.Case)
-    def isPackageDef(given ctx: Context): Boolean = internal.Symbol_isPackageDefSymbol(self)
+    /** Is this the definition of a type? */
+    def isType(given ctx: Context): Boolean = internal.Symbol_isType(self)
+
+    /** Is this the definition of a term? */
+    def isTerm(given ctx: Context): Boolean = internal.Symbol_isTerm(self)
+
+    /** Is this the definition of a PackageDef tree? */
+    def isPackageDef(given ctx: Context): Boolean = internal.Symbol_isPackageDef(self)
+
+    /** Is this the definition of a ClassDef tree? */
+    def isClassDef(given ctx: Context): Boolean = internal.Symbol_isClassDef(self)
+
+    /** Is this the definition of a TypeDef tree */
+    def isTypeDef(given ctx: Context): Boolean = internal.Symbol_isTypeDef(self)
+
+    /** Is this the definition of a ValDef tree? */
+    def isValDef(given ctx: Context): Boolean = internal.Symbol_isValDef(self)
+
+    /** Is this the definition of a DefDef tree? */
+    def isDefDef(given ctx: Context): Boolean = internal.Symbol_isDefDef(self)
+
+    /** Is this the definition of a Bind pattern? */
+    def isBind(given ctx: Context): Boolean = internal.Symbol_isBind(self)
+
+    /** Does this symbol represent a no definition? */
     def isNoSymbol(given ctx: Context): Boolean = self == Symbol.noSymbol
 
+    /** Does this symbol represent a definition? */
+    def exists(given ctx: Context): Boolean = self != Symbol.noSymbol
+
     /** Fields directly declared in the class */
     def fields(given ctx: Context): List[Symbol] =
       internal.Symbol_fields(self)