Iteration over a sealed trait in Scala?

by

This is actually in my opinion an appropriate use case for 2.10 macros: you want access to information that you know the compiler has, but isn’t exposing, and macros give you a (reasonably) easy way to peek inside. See my answer here for a related (but now slightly out-of-date) example, or just use something like this:

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

object SealedExample {
  def values[A]: Set[A] = macro values_impl[A]

  def values_impl[A: c.WeakTypeTag](c: Context) = {
    import c.universe._

    val symbol = weakTypeOf[A].typeSymbol

    if (!symbol.isClass) c.abort(
      c.enclosingPosition,
      "Can only enumerate values of a sealed trait or class."
    ) else if (!symbol.asClass.isSealed) c.abort(
      c.enclosingPosition,
      "Can only enumerate values of a sealed trait or class."
    ) else {
      val children = symbol.asClass.knownDirectSubclasses.toList

      if (!children.forall(_.isModuleClass)) c.abort(
        c.enclosingPosition,
        "All children must be objects."
      ) else c.Expr[Set[A]] {
        def sourceModuleRef(sym: Symbol) = Ident(
          sym.asInstanceOf[
            scala.reflect.internal.Symbols#Symbol
          ].sourceModule.asInstanceOf[Symbol]
        )

        Apply(
          Select(
            reify(Set).tree,
            newTermName("apply")
          ),
          children.map(sourceModuleRef(_))
        )
      }
    }
  }
}

Now we can write the following:

scala> val keys: Set[ResizedImageKey] = SealedExample.values[ResizedImageKey]
keys: Set[ResizedImageKey] = Set(Large, Medium, Small)

And this is all perfectly safe—you’ll get a compile-time error if you ask for values of a type that isn’t sealed, has non-object children, etc.

More Related Contents:

  1. Case objects vs Enumerations in Scala
  2. What is a sealed trait?
  3. Weird behavior trying to convert case classes to heterogeneous lists recursively with Shapeless
  4. Scala Macros: Making a Map out of fields of a class in Scala
  5. Method Override with Scala 3 Macros
  6. How to access parameter list of case class in a dotty macro
  7. Scala macros: What is the difference between typed (aka typechecked) and untyped Trees
  8. Static return type of Scala macros
  9. Creating a method definition tree from a method symbol and a body
  10. Howto model named parameters in method invocations with Scala macros?
  11. “dynamically” creating case classes with macros
  12. Getting subclasses of a sealed trait
  13. Scala3: Crafting Types Through Metaprogramming?
  14. What’s the difference between => , ()=>, and Unit=>
  15. How to avoid duplicate columns after join?
  16. Flattening Rows in Spark
  17. How to pattern match on generic type in Scala?
  18. Get companion object instance with new Scala reflection API
  19. By-name parameter vs anonymous function
  20. How to create a Source that can receive elements later via a method call?
  21. Why are scala functions limited to 22 parameters?
  22. Replace missing values with mean – Spark Dataframe
  23. How to calculate the size of dataframe in bytes in Spark?
  24. Why does partition parameter of SparkContext.textFile not take effect?
  25. Can I zip more than two lists together in Scala?
  26. Usages of Null / Nothing / Unit in Scala
  27. Spark-Monotonically increasing id not working as expected in dataframe?
  28. How do I parse command line arguments in Scala? [closed]
  29. Futures / Success race
  30. Why does one select Scala type members with a hash instead of a dot?

Leave a Comment