scoverage.Location.scala Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of scalac-scoverage-plugin_2.13.0-RC1 Show documentation
scalac-scoverage-plugin
The newest version!
package scoverage

import scala.tools.nsc.Global

/**
 * @param packageName the name of the enclosing package
 * @param className the name of the closest enclosing class
 * @param fullClassName the fully qualified name of the closest enclosing class
 */
case class Location(packageName: String,
                    className: String,
                    fullClassName: String,
                    classType: ClassType,
                    method: String,
                    sourcePath: String) extends java.io.Serializable

object Location {

  def apply(global: Global): global.Tree => Option[Location] = { tree =>

    def packageName(s: global.Symbol): String = {
      s.enclosingPackage.fullName
    }

    def className(s: global.Symbol): String = {
      // anon functions are enclosed in proper classes.
      if (s.enclClass.isAnonymousFunction || s.enclClass.isAnonymousClass) className(s.owner)
      else s.enclClass.nameString
    }

    def classType(s: global.Symbol): ClassType = {
      if (s.enclClass.isTrait) ClassType.Trait
      else if (s.enclClass.isModuleOrModuleClass) ClassType.Object
      else ClassType.Class
    }

    def fullClassName(s: global.Symbol): String = {
      // anon functions are enclosed in proper classes.
      if (s.enclClass.isAnonymousFunction || s.enclClass.isAnonymousClass) fullClassName(s.owner)
      else s.enclClass.fullNameString
    }

    def enclosingMethod(s: global.Symbol): String = {
      // check if we are in a proper method and return that, otherwise traverse up
      if (s.enclClass.isAnonymousFunction ) enclosingMethod(s.owner)
      else if (s.enclMethod.isPrimaryConstructor) ""
      else Option(s.enclMethod.nameString).getOrElse("")
    }

    def sourcePath(symbol: global.Symbol): String = {
      Option(symbol.sourceFile).map(_.canonicalPath).getOrElse("")
    }

    Option(tree.symbol) map {
      symbol =>
        Location(
          packageName(symbol),
          className(symbol),
          fullClassName(symbol),
          classType(symbol),
          enclosingMethod(symbol),
          sourcePath(symbol))
    }
  }
}