将 scalac 插件拆分为多个文件

Question

我想将我的 scalac 插件拆分为多个文件。这听起来很容易，但由于 import global._ 行产生的路径相关类型问题，我还没有成功实现它。

这是 Lex Spoon 的示例插件：

package localhost

import scala.tools.nsc
import nsc.Global
import nsc.Phase
import nsc.plugins.Plugin
import nsc.plugins.PluginComponent

class DivByZero(val global: Global) extends Plugin {
  import global._

  val name = "divbyzero"
  val description = "checks for division by zero"
  val components = List[PluginComponent](Component)

  private object Component extends PluginComponent {
    val global: DivByZero.this.global.type = DivByZero.this.global
    val runsAfter = "refchecks"
    // Using the Scala Compiler 2.8.x the runsAfter should be written as below
    // val runsAfter = List[String]("refchecks");
    val phaseName = DivByZero.this.name
    def newPhase(_prev: Phase) = new DivByZeroPhase(_prev)    

    class DivByZeroPhase(prev: Phase) extends StdPhase(prev) {
      override def name = DivByZero.this.name
      def apply(unit: CompilationUnit) {
        for ( tree @ Apply(Select(rcvr, nme.DIV), List(Literal(Constant(0)))) <- unit.body;
             if rcvr.tpe <:< definitions.IntClass.tpe) 
          {
            unit.error(tree.pos, "definitely division by zero")
          }
      }
    }
  }
}

如何将 Component 和 DivByZeroPhase 放入它们自己的文件中，而不将 import global._ 纳入范围内？

Answer 1

这是一个非常古老的项目，我做了同样的事情：

https://github.com/jsuereth/osgi-scalac-plugin/blob/master/src/main/scala/scala/osgi/compiler/OsgiPlugin.scala

如果您不需要从全局传递路径相关类型，则不必担心尝试保持其相关的“this.global”部分。

Answer 2

在 Scala 重构库中，我通过使用 CompilerAccess 特征解决了这个问题：

trait CompilerAccess { 
  val global: tools.nsc.Global
}

现在需要访问 global 的所有其他特征只需将 CompilerAccess 声明为依赖项：

trait TreeTraverser {
  this: CompilerAccess =>
  import global._

  ...
}

然后有一个混合所有这些特征并提供全局实例的类：

trait SomeRefactoring extends TreeTraverser with OtherTrait with MoreTraits {
  val global = //wherever you get your global from
}

这个方案对我来说效果很好。

Answer 3

您可以为您的组件创建一个单独的类并将全局传递给：

class TemplateComponent(val global: Global) extends PluginComponent {

  import global._

  val runsAfter = List[String]("refchecks")

  val phaseName = "plugintemplate"

  def newPhase(prev: Phase) = new StdPhase(prev) {

    override def name = phaseName

    def apply(unit:CompilationUnit) = {
    }    
  }
}