Scala Language
Makra

Wprowadzenie

Składnia

• def x () = makro x_impl // x to makro, w którym x_impl służy do transformacji kodu
• def macroTransform (annottees: Any *): Any = macro impl // Użyj w adnotacjach, aby były makrami

Uwagi

Adnotacja Makro

Ta prosta adnotacja makra wyświetla adnotowany element w niezmienionej postaci.

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}")
  }
}

Adnotacja @compileTimeOnly generuje błąd z komunikatem wskazującym, że aby skorzystać z tego makra, należy dołączyć wtyczkę kompilatora paradise . Instrukcje dołączania tego za pośrednictwem SBT są tutaj .

Możesz użyć zdefiniowanego powyżej makra w następujący sposób:

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

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

@noop
def g(): Int = 10

Makra metod

Gdy metoda jest zdefiniowana jako makro, kompilator pobiera kod, który jest przekazywany jako argument, i przekształca go w AST. Następnie wywołuje implementację makr z tym AST i zwraca nowy AST, który jest następnie łączony z powrotem na stronie wywoływania.

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
    }
  }
}

Możliwe jest także posiadanie makr, które przyjmują argumenty Tree . Jak jak reify służy do tworzenia Expr s, na q (dla quasiquote) ciąg interpolator pozwala nam tworzyć i Deconstruct Tree s. Zauważ, że moglibyśmy użyć q powyżej ( expr.tree , co zaskakujące, samo Tree ), ale nie w celach demonstracyjnych.

// 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"
  }
}

Błędy w makrach

Makra mogą wyzwalać ostrzeżenia i błędy kompilatora za pomocą ich Context .

Powiedzmy, że jesteśmy szczególnie nadgorliwi, jeśli chodzi o zły kod i chcemy oznaczyć każdy przypadek długu technicznego komunikatem informacyjnym kompilatora (nie myślmy o tym, jak zły jest ten pomysł). Możemy użyć makra, które nic nie robi oprócz emitowania takiej wiadomości.

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 ()
}

Dodatkowo zamiast używać ??? aby zaznaczyć niezaimplementowany kod, możemy utworzyć dwa makra !!! i ?!? , które służą temu samemu celowi, ale emitują ostrzeżenia kompilatora. ?!? spowoduje wyświetlenie ostrzeżenia i !!! spowoduje całkowity błąd.

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.???"
}