How to access parameter list of case class in a dotty macro

Question

I am trying to learn meta-programming in dotty. Specifically compile time code generation. I thought learning by building something would be a good approach. So I decided to make a CSV parser which will parse lines into case classes. I want to use dotty macros to generate decoders

trait Decoder[T]{
  def decode(str:String):Either[ParseError, T]
}

object Decoder {
  inline given stringDec as Decoder[String] = new Decoder[String] {
    override def decode(str: String): Either[ParseError, String] = Right(str)
  }

  inline given intDec as Decoder[Int] = new Decoder[Int] {
    override def decode(str: String): Either[ParseError, Int] =
      str.toIntOption.toRight(ParseError(str, "value is not valid Int"))
  }
  
  inline def forType[T]:Decoder[T] = ${make[T]}

  def make[T:Type](using qctx: QuoteContext):Expr[Decoder[T]] = ???
}

I have provided basic decoders for Int & String, now I looking for guidance for def make[T:Type] method. How to iterate parameter list of a case class T inside this method? Are there any recommended ways or patterns to do this?

user_5249621 · Answer

Using standard type class derivation in Dotty

object TypeClassParser extends App {
  import scala.deriving.*
  import scala.compiletime.*

  case class ParseError(str: String, msg: String)

  trait Decoder[T]{
    def decode(str:String): Either[ParseError, T]
  }

  object Decoder {
    inline given Decoder[String] with {
      override def decode(str: String): Either[ParseError, String] = Right(str)
    }

    inline given Decoder[Int] with {
      override def decode(str: String): Either[ParseError, Int] =
        str.toIntOption.toRight(ParseError(str, "value is not valid Int"))
    }

    inline def derived[T](using m: Mirror.Of[T]): Decoder[T] = {
      val elemInstances = summonAll[m.MirroredElemTypes]
      inline m match {
        case p: Mirror.ProductOf[T] => productDecoder(p, elemInstances)
        case s: Mirror.SumOf[T]     => ???
      }
    }

    inline def summonAll[T <: Tuple]: List[Decoder[_]] = inline erasedValue[T] match {
      case _: EmptyTuple => Nil
      case _: (t *: ts) => summonInline[Decoder[t]] :: summonAll[ts]
    }

    def productDecoder[T](p: Mirror.ProductOf[T], elems: List[Decoder[_]]): Decoder[T] =
      new Decoder[T] {
        def decode(str: String): Either[ParseError, T] = {
          val what = elems.zip(str.split(','))
            .map(_.decode(_).map(_.asInstanceOf[AnyRef]))

          sequence(what)
            .map(ts => p.fromProduct(Tuple.fromArray(ts.toArray)))
        }
      }

    def sequence[E,A](es: List[Either[E,A]]): Either[E,List[A]] =
      traverse(es)(x => x)

    def traverse[E,A,B](es: List[A])(f: A => Either[E, B]): Either[E, List[B]] =
      es.foldRight[Either[E, List[B]]](Right(Nil))((h, tRes) => map2(f(h), tRes)(_ :: _))

    def map2[E, A, B, C](a: Either[E, A], b: Either[E, B])(f: (A, B) => C): Either[E, C] =
      for { a1 <- a; b1 <- b } yield f(a1,b1)
  }

  case class A(i: Int, s: String) derives Decoder

  println(summon[Decoder[A]].decode("10,abc"))//Right(A(10,abc))
  println(summon[Decoder[A]].decode("xxx,abc"))//Left(ParseError(xxx,value is not valid Int))
  // println(summon[Decoder[A]].decode(","))
}

Tested in 3.1.3.

Using Shapeless-3

import shapeless3.deriving.K0
import shapeless3.typeable.Typeable

case class ParseError(str: String, msg: String)

trait Decoder[T]{
  def decode(str:String): Either[ParseError, T]
}

object Decoder {
  inline given stringDec: Decoder[String] = new Decoder[String] {
    override def decode(str: String): Either[ParseError, String] = Right(str)
  }

  inline given intDec: Decoder[Int] = new Decoder[Int] {
    override def decode(str: String): Either[ParseError, Int] =
      str.toIntOption.toRight(ParseError(str, "value is not valid Int"))
  }

  inline def derived[A](using gen: K0.Generic[A]): Decoder[A] =
    gen.derive(productDecoder, null)

  given productDecoder[T](using inst: K0.ProductInstances[Decoder, T], typeable: Typeable[T]): Decoder[T] = new Decoder[T] {
    def decode(str: String): Either[ParseError, T] = {
      type Acc = (List[String], Option[ParseError])
      inst.unfold[Acc](str.split(',').toList, None)([t] => (acc: Acc, dec: Decoder[t]) =>
        acc._1 match {
          case head :: tail => dec.decode(head) match {
            case Right(t) => ((tail, None), Some(t))
            case Left(e)  => ((Nil, Some(e)), None)
          }
          case Nil => (acc, None)
        }
      ) match {
        case ((_, Some(e)), None) => Left(e)
        case ((_, None), None)    => Left(ParseError(str, s"value is not valid ${typeable.describe}"))
        case (_, Some(t))         => Right(t)
      }
    }
  }
}

case class A(i: Int, s: String) derives Decoder

@main def test = {
  println(summon[Decoder[A]].decode("10,abc")) //Right(A(10,abc))
  println(summon[Decoder[A]].decode("xxx,abc")) //Left(ParseError(xxx,value is not valid Int))
  println(summon[Decoder[A]].decode(",")) //Left(ParseError(,,value is not valid A))
}

build.sbt

scalaVersion := "3.1.3"

libraryDependencies += "org.typelevel" %% "shapeless3-deriving" % "3.1.0"
libraryDependencies += "org.typelevel" %% "shapeless3-typeable" % "3.1.0"

Using Dotty macros + TASTy reflection like in dotty-macro-examples/macroTypeclassDerivation (this approach is even more low-level than the one with scala.deriving.Mirror)

import scala.quoted.*

case class ParseError(str: String, msg: String)

trait Decoder[T]{
  def decode(str: String): Either[ParseError, T]
}

object Decoder {
  inline given Decoder[String] with {
    override def decode(str: String): Either[ParseError, String] = Right(str)
  }

  inline given Decoder[Int] with {
    override def decode(str: String): Either[ParseError, Int] =
      str.toIntOption.toRight(ParseError(str, "value is not valid Int"))
  }

  inline def derived[T]: Decoder[T] = ${ derivedImpl[T] }

  def derivedImpl[T](using Quotes, Type[T]): Expr[Decoder[T]] = {
    import quotes.reflect.*
    val tpeSym = TypeRepr.of[T].typeSymbol
    if (tpeSym.flags.is(Flags.Case)) productDecoder[T]
    else if (tpeSym.flags.is(Flags.Trait & Flags.Sealed)) ???
    else sys.error(s"Unsupported combination of flags: ${tpeSym.flags.show}")
  }

  def productDecoder[T](using Quotes, Type[T]): Expr[Decoder[T]] = {
    import quotes.reflect.*
    val fields: List[Symbol]             = TypeRepr.of[T].typeSymbol.caseFields
    val fieldTypeTrees: List[TypeTree]   = fields.map(_.tree.asInstanceOf[ValDef].tpt)
    val decoderTerms: List[Term]         = fieldTypeTrees.map(lookupDecoderFor(_))
    val decoders: Expr[List[Decoder[_]]] = Expr.ofList(decoderTerms.map(_.asExprOf[Decoder[_]]))

    def mkT(fields: Expr[List[_]]): Expr[T] = {
      Apply(
        Select.unique(New(TypeTree.of[T]), ""),
        fieldTypeTrees.zipWithIndex.map((fieldType, i) =>
          TypeApply(
            Select.unique(
              Apply(
                Select.unique(
                  fields.asTerm,
                  "apply"),
                List(Literal(IntConstant(i)))
              ), "asInstanceOf"),
            List(fieldType)
          )
        )
      ).asExprOf[T]
    }

    '{
      new Decoder[T]{
        override def decode(str: String): Either[ParseError, T] = {
          str.split(',').toList.zip($decoders).map((str, decoder) =>
            decoder.decode(str)
          ).sequence.map(fields =>
            ${mkT('fields)}
          )
        }
      }
    }
  }

  def lookupDecoderFor(using Quotes)(t: quotes.reflect.Tree): quotes.reflect.Term = {
    import quotes.reflect.*
    val tpe: TypeTree = Applied(TypeTree.of[Decoder], List(t))
    Implicits.search(tpe.tpe) match {
      case res: ImplicitSearchSuccess => res.tree
    }
  }

  extension[E,A](es: List[Either[E,A]]) {
    def sequence: Either[E,List[A]] = traverse(es)(x => x)
  }

  def traverse[E,A,B](es: List[A])(f: A => Either[E, B]): Either[E, List[B]] =
    es.foldRight[Either[E, List[B]]](Right(Nil))((h, tRes) => map2(f(h), tRes)(_ :: _))

  def map2[E, A, B, C](a: Either[E, A], b: Either[E, B])(f: (A, B) => C): Either[E, C] =
    for { a1 <- a; b1 <- b } yield f(a1,b1)
}

case class A(i: Int, s: String) derives Decoder

@main def test = {
  println(summon[Decoder[A]].decode("10,abc"))//Right(A(10,abc))
  println(summon[Decoder[A]].decode("xxx,abc"))//Left(ParseError(xxx,value is not valid Int))
 // println(summon[Decoder[A]].decode(","))
}

Tested in 3.1.3.

For comparison deriving type classes in Scala 2

Use the lowest subtype in a typeclass?

How to access parameter list of case class in a dotty macro

1 Answers