Scala Language
Macro

introduzione

Sintassi

• def x () = macro x_impl // x è una macro, dove x_impl è usato per trasformare il codice
• def macroTransform (annottees: Any *): Any = macro impl // Utilizzare nelle annotazioni per renderli macro

Osservazioni

Annotazione Macro

Questa semplice annotazione macro emette l'elemento annotato così com'è.

import scala.annotation.{compileTimeOnly, StaticAnnotation}
import scala.reflect.macros.whitebox.Context

@compileTimeOnly("enable macro paradise to expand macro annotations")
class noop extends StaticAnnotation {
  def macroTransform(annottees: Any*): Any = macro linkMacro.impl
}

object linkMacro {
  def impl(c: Context)(annottees: c.Expr[Any]*): c.Expr[Any] = {
    import c.universe._

    c.Expr[Any](q"{..$annottees}")
  }
}

L'annotazione @compileTimeOnly genera un errore con un messaggio che indica che il plug-in del compilatore paradise deve essere incluso per utilizzare questa macro. Le istruzioni per includere questo tramite SBT sono qui .

Puoi utilizzare la macro sopra descritta in questo modo:

@noop
case class Foo(a: String, b: Int)

@noop
object Bar {
  def f(): String = "hello"
}

@noop
def g(): Int = 10

Metodo Macro

Quando un metodo è definito come una macro, il compilatore prende il codice che viene passato come argomento e lo trasforma in un AST. Quindi richiama l'implementazione della macro con tale AST e restituisce un nuovo AST che viene quindi ricollegato al suo sito di chiamata.

import reflect.macros.blackbox.Context

object Macros {
  // This macro simply sees if the argument is the result of an addition expression.
  // E.g. isAddition(1+1) and isAddition("a"+1).
  // but !isAddition(1+1-1), as the addition is underneath a subtraction, and also
  // !isAddition(x.+), and !isAddition(x.+(a,b)) as there must be exactly one argument.
  def isAddition(x: Any): Boolean = macro isAddition_impl

  // The signature of the macro implementation is the same as the macro definition,
  // but with a new Context parameter, and everything else is wrapped in an Expr.
  def isAddition_impl(c: Context)(expr: c.Expr[Any]): c.Expr[Boolean] = {
    import c.universe._ // The universe contains all the useful methods and types
    val plusName = TermName("+").encodedName // Take the name + and encode it as $plus
    expr.tree match { // Turn expr into an AST representing the code in isAddition(...)
      case Apply(Select(_, `plusName`), List(_)) => reify(true)
      // Pattern match the AST to see whether we have an addition
      // Above we match this AST
      //             Apply (function application)
      //            /     \
      //         Select  List(_) (exactly one argument)
      // (selection ^ of entity, basically the . in x.y)
      //      /          \
      //    _              \
      //               `plusName` (method named +)
      case _                                     => reify(false)
      // reify is a macro you use when writing macros
      // It takes the code given as its argument and creates an Expr out of it
    }
  }
}

È anche possibile avere macro che accettano Tree s come argomenti. Come la reify viene usata per creare Expr s, l'interpolatore q (per quasi una stringa) ci consente di creare e decostruire l' Tree . Nota che potremmo aver usato q sopra ( expr.tree è, sorpresa, anche un Tree stesso), ma non per scopi dimostrativi.

// No Exprs, just Trees
def isAddition_impl(c: Context)(tree: c.Tree): c.Tree = {
  import c.universe._
  tree match {
    // q is a macro too, so it must be used with string literals.
    // It can destructure and create Trees.
    // Note how there was no need to encode + this time, as q is smart enough to do it itself.
    case q"${_} + ${_}" => q"true"
    case _              => q"false"
  }
}

Errori nelle macro

Le macro possono attivare avvisi ed errori del compilatore attraverso l'uso del loro Context .

Diciamo che siamo particolarmente zelanti quando si tratta di codice errato, e vogliamo contrassegnare ogni istanza di debito tecnico con un messaggio informativo del compilatore (non pensiamo a quanto sia pessima questa idea). Possiamo usare una macro che non fa nulla se non emettere un messaggio del genere.

import reflect.macros.blackbox.Context

def debtMark(message: String): Unit = macro debtMark_impl
def debtMarkImpl(c: Context)(message: c.Tree): c.Tree = {
  message match {
    case Literal(Constant(msg: String)) => c.info(c.enclosingPosition, msg, false)
    // false above means "do not force this message to be shown unless -verbose"
    case _                              => c.abort(c.enclosingPosition, "Message must be a string literal.")
    // Abort causes the compilation to completely fail. It's not even a compile error, where
    // multiple can stack up; this just kills everything.
  }
  q"()" // At runtime this method does nothing, so we return ()
}

Inoltre, invece di usare ??? per contrassegnare il codice non implementato, possiamo creare due macro, !!! e ?!? , che hanno lo stesso scopo, ma emettono avvisi del compilatore. ?!? causerà l'emissione di un avviso e !!! causerà un errore definitivo.

import reflect.macros.blackbox.Context

def ?!? : Nothing = macro impl_?!?
def !!! : Nothing = macro impl_!!!

def impl_?!?(c: Context): c.Tree = {
  import c.universe._
  c.warning(c.enclosingPosition, "Unimplemented!")
  q"${termNames.ROOTPKG}.scala.Predef.???"
  // If someone were to shadow the scala package, scala.Predef.??? would not work, as it
  // would end up referring to the scala that shadows and not the actual scala.
  // ROOTPKG is the very root of the tree, and acts like it is imported anew in every
  // expression. It is actually named _root_, but if someone were to shadow it, every
  // reference to it would be an error. It allows us to safely access ??? and know that
  // it is the one we want.
}

def impl_!!!(c: Context): c.Tree = {
  import c.universe._
  c.error(c.enclosingPosition, "Unimplemented!")
  q"${termNames.ROOTPKG}.scala.Predef.???"
}