Scala Macros: Making a Map out of fields of a class in Scala

by

Note that this can be done much more elegantly without the toString / c.parse business:

import scala.language.experimental.macros

abstract class Model {
  def toMap[T]: Map[String, Any] = macro Macros.toMap_impl[T]
}

object Macros {
  import scala.reflect.macros.Context

  def toMap_impl[T: c.WeakTypeTag](c: Context) = {
    import c.universe._

    val mapApply = Select(reify(Map).tree, newTermName("apply"))

    val pairs = weakTypeOf[T].declarations.collect {
      case m: MethodSymbol if m.isCaseAccessor =>
        val name = c.literal(m.name.decoded)
        val value = c.Expr(Select(c.resetAllAttrs(c.prefix.tree), m.name))
        reify(name.splice -> value.splice).tree
    }

    c.Expr[Map[String, Any]](Apply(mapApply, pairs.toList))
  }
}

Note also that you need the c.resetAllAttrs bit if you want to be able to write the following:

User("a", 1, Nil).toMap[User]

Without it you’ll get a confusing ClassCastException in this situation.

By the way, here’s a trick that I’ve used to avoid the extra type parameter in e.g. user.toMap[User] when writing macros like this:

import scala.language.experimental.macros

trait Model

object Model {
  implicit class Mappable[M <: Model](val model: M) extends AnyVal {
    def asMap: Map[String, Any] = macro Macros.asMap_impl[M]
  }

  private object Macros {
    import scala.reflect.macros.Context

    def asMap_impl[T: c.WeakTypeTag](c: Context) = {
      import c.universe._

      val mapApply = Select(reify(Map).tree, newTermName("apply"))
      val model = Select(c.prefix.tree, newTermName("model"))

      val pairs = weakTypeOf[T].declarations.collect {
        case m: MethodSymbol if m.isCaseAccessor =>
          val name = c.literal(m.name.decoded)
          val value = c.Expr(Select(model, m.name))
          reify(name.splice -> value.splice).tree
      }

      c.Expr[Map[String, Any]](Apply(mapApply, pairs.toList))
    }
  }
}

Now we can write the following:

scala> println(User("a", 1, Nil).asMap)
Map(name -> a, age -> 1, posts -> List())

And don’t need to specify that we’re talking about a User.

More Related Contents:

  1. “dynamically” creating case classes with macros
  2. Case objects vs Enumerations in Scala
  3. Cleaner way to update nested structures
  4. Iteration over a sealed trait in Scala?
  5. Case class equality in Apache Spark
  6. What is the difference between Scala’s case class and class?
  7. How to define schema for custom type in Spark SQL?
  8. How to override apply in a case class companion
  9. How to get around the Scala case class limit of 22 fields?
  10. Case class to map in Scala
  11. Mixing in a trait dynamically
  12. Weird behavior trying to convert case classes to heterogeneous lists recursively with Shapeless
  13. Easy idiomatic way to define Ordering for a simple case class
  14. What is *so* wrong with case class inheritance?
  15. Scala case class inheritance
  16. Method Override with Scala 3 Macros
  17. How to access parameter list of case class in a dotty macro
  18. Scala macros: What is the difference between typed (aka typechecked) and untyped Trees
  19. Overload constructor for Scala’s Case Classes?
  20. Static return type of Scala macros
  21. Why is parameter in contravariant position?
  22. Creating a method definition tree from a method symbol and a body
  23. Should I use the final modifier when declaring case classes?
  24. Scala 2.10 reflection, how do I extract the field values from a case class, i.e. field list from case class
  25. Howto model named parameters in method invocations with Scala macros?
  26. How is this case class match pattern working?
  27. Getting subclasses of a sealed trait
  28. Scala3: Crafting Types Through Metaprogramming?
  29. Abort early in a fold
  30. ScalaTest in sbt: is there a way to run a single test without tags?

Leave a Comment