記錄Scala 2.10宏


Answers

Question

我將從一個例子開始。 這裡有一個相當於List.fill的元組作為Scala 2.10中的一個宏:

import scala.language.experimental.macros
import scala.reflect.macros.Context

object TupleExample {
  def fill[A](arity: Int)(a: A): Product = macro fill_impl[A]

  def fill_impl[A](c: Context)(arity: c.Expr[Int])(a: c.Expr[A]) = {
    import c.universe._

    arity.tree match {
      case Literal(Constant(n: Int)) if n < 23 => c.Expr(
        Apply(
          Select(Ident("Tuple" + n.toString), "apply"),
          List.fill(n)(a.tree)
        )
      )
      case _ => c.abort(
        c.enclosingPosition,
        "Desired arity must be a compile-time constant less than 23!"
      )
    }
  }
}

我們可以使用這個方法如下:

scala> TupleExample.fill(3)("hello")
res0: (String, String, String) = (hello,hello,hello)

這傢伙在幾個方面是一隻奇怪的鳥。 首先, arity參數必須是一個整數,因為我們需要在編譯時使用它。 在以前的Scala版本中,對於一個方法來說,沒有辦法(據我所知)甚至不知道它的一個參數是否是編譯時的文字。

其次, Product返回類型是一個謊言 - 靜態返回類型將包含由參數確定的特定元素和元素類型,如上所示。

那麼我將如何記錄這件事? 在這一點上,我並不期待Scaladoc的支持,但是我希望有一個約定或者最佳實踐的意義(除了確保編譯時錯誤信息是清晰的),這將使得運行在宏觀方法上潛在的離奇的需求 - 對於Scala 2.10庫的用戶而言更不令人意外。

新的宏觀系統(例如, ScalaMockSlick這裡列出的其他系統)的最成熟的演示在方法層面上還是相對沒有文檔的。 任何示例或指針將不勝感激,包括來自其他語言與類似的宏系統。