pickling.RuntimePickler.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scala-pickling_2.10 Show documentation
scala-pickling
The newest version!
package scala.pickling

import java.lang.reflect.Field

import scala.reflect.runtime.{universe => ru}
import ir._

import internal._


class RuntimeTypeInfo(classLoader: ClassLoader, clazz: Class[_], share: refs.Share) {
  import ru._
  import definitions._

  // debug(s"Initializing runtime type info for class '${clazz.getName}'...")

  val mirror: ru.Mirror =
    ru.runtimeMirror(classLoader)

  val sym =
    if (clazz != null) mirror.classSymbol(clazz) else NullClass
  // debug(s"sym: $sym")

  val tpe = {
    val elemClass: Class[_] =
      if (clazz != null) clazz.getComponentType() else null

    if (elemClass != null) // assume it's an array
      appliedType(ArrayClass.toType, List(mirror.classSymbol(elemClass).asType.toType))
    else
      sym.asType.toType
  }
  // debug(s"tpe: ${tpe.key}")

  val irs = new IRs[ru.type](ru)
  val cir = irs.newClassIR(tpe)
  // debug(s"CIR: ${cir.fields.mkString(",")}")

  val tag = FastTypeTag(mirror, tpe, tpe.key)
  // debug(s"tag: $tag")

  val shareAnalyzer = new ShareAnalyzer[ru.type](ru) {
    def shareEverything = share.isInstanceOf[refs.ShareEverything]
    def shareNothing = share.isInstanceOf[refs.ShareNothing]
  }
  def shouldBotherAboutSharing(tpe: Type) = shareAnalyzer.shouldBotherAboutSharing(tpe)
  def shouldBotherAboutLooping(tpe: Type) = shareAnalyzer.shouldBotherAboutLooping(tpe)
}

class RuntimePickler(classLoader: ClassLoader, clazz: Class[_])(implicit share: refs.Share) extends RuntimeTypeInfo(classLoader, clazz, share) {
  import ru._

  sealed abstract class Logic(fir: irs.FieldIR, isEffFinal: Boolean) {
    // debug(s"creating Logic for ${fir.name}")
    def run(builder: PBuilder, picklee: Any, im: ru.InstanceMirror): Unit = {
      val fldValue: Any = if (fir.accessor.nonEmpty) {
        val getterMirror = im.reflectMethod(fir.accessor.get)
        getterMirror()
      } else {
        val fldMirror = im.reflectField(fir.field.get)
        fldMirror.get
      }
      val fldClass = if (fldValue != null) fldValue.getClass else null

      //debug(s"pickling field of type: ${fir.tpe.toString}")
      //debug(s"isEffFinal: $isEffFinal")
      //debug(s"field value: $fldValue")
      //debug(s"field class: ${fldClass.getName}")

      // idea: picklers for all fields could be created and cached once and for all.
      // however, it depends on whether the type of the field is effectively final or not.
      // essentially, we have to emulate the behavior of generated picklers, which make
      // the same decision.
      // println(s"creating runtime pickler to pickle $fldClass field of class ${picklee.getClass.getName}")
      val fldTag = FastTypeTag.mkRaw(fldClass, mirror)
      // debug(s"!!! finding pickler for field with class ${fldClass.getName}")
      val fldPickler = SPickler.genPickler(classLoader, fldClass, fldTag).asInstanceOf[SPickler[Any]]
      //debug(s"looked up field pickler: $fldPickler")

      builder.putField(fir.name, b => {
        pickleLogic(fldClass, fldValue, b, fldPickler, fldTag)
      })
    }

    def pickleLogic(fieldClass: Class[_], fieldValue: Any, builder: PBuilder, pickler: SPickler[Any], fieldTag: FastTypeTag[_]): Unit
  }

  final class DefaultLogic(fir: irs.FieldIR) extends Logic(fir, false) {
    // debug(s"creating DefaultLogic for ${fir.name}")
    val staticClass = mirror.runtimeClass(fir.tpe.erasure)
    def pickleLogic(fldClass: Class[_], fldValue: Any, b: PBuilder, fldPickler: SPickler[Any], fldTag: FastTypeTag[_]): Unit = {
      if (fldValue == null || fldValue.getClass == staticClass) b.hintDynamicallyElidedType()
      pickleInto(fldClass, fldValue, b, fldPickler, fldTag)
    }
  }

  final class EffectivelyFinalLogic(fir: irs.FieldIR) extends Logic(fir, true) {
    // debug(s"creating EffectivelyFinalLogic for ${fir.name}")
    def pickleLogic(fldClass: Class[_], fldValue: Any, b: PBuilder, fldPickler: SPickler[Any], fldTag: FastTypeTag[_]): Unit = {
      b.hintStaticallyElidedType()
      pickleInto(fldClass, fldValue, b, fldPickler, fldTag)
    }
  }

  final class AbstractLogic(fir: irs.FieldIR) extends Logic(fir, false) {
    // debug(s"creating AbstractLogic for ${fir.name}")
    def pickleLogic(fldClass: Class[_], fldValue: Any, b: PBuilder, fldPickler: SPickler[Any], fldTag: FastTypeTag[_]): Unit = {
      pickleInto(fldClass, fldValue, b, fldPickler, fldTag)
    }
  }

  sealed class PrivateJavaFieldLogic(fir: irs.FieldIR, field: Field) extends Logic(fir, false) {
    // debug(s"creating PrivateJavaFieldLogic for ${fir.name}")
    override def run(builder: PBuilder, picklee: Any, im: ru.InstanceMirror): Unit = {
      field.setAccessible(true)
      val fldValue = field.get(picklee)
      val fldClass = if (fldValue != null) fldValue.getClass else null

      //debug(s"pickling field of type: ${fir.tpe.toString}")
      //debug(s"isEffFinal: $isEffFinal")
      //debug(s"field value: $fldValue")
      //debug(s"field class: ${fldClass.getName}")

      // idea: picklers for all fields could be created and cached once and for all.
      // however, it depends on whether the type of the field is effectively final or not.
      // essentially, we have to emulate the behavior of generated picklers, which make
      // the same decision.
      // debug(s"creating tag for field of class ${fldClass.getName}")
      val fldTag = FastTypeTag.mkRaw(fldClass, mirror)
      val fldPickler = SPickler.genPickler(classLoader, fldClass, fldTag).asInstanceOf[SPickler[Any]]
      // debug(s"looked up field pickler: $fldPickler")

      builder.putField(field.getName, b => {
        pickleLogic(fldClass, fldValue, b, fldPickler, fldTag)
      })
    }

    def pickleLogic(fldClass: Class[_], fldValue: Any, b: PBuilder, fldPickler: SPickler[Any], fldTag: FastTypeTag[_]): Unit = {
      pickleInto(fldClass, fldValue, b, fldPickler, fldTag)
    }
  }

  final class PrivateEffectivelyFinalJavaFieldLogic(fir: irs.FieldIR, field: Field) extends PrivateJavaFieldLogic(fir, field) {
    // debug(s"creating PrivateEffectivelyFinalJavaFieldLogic for ${fir.name}")
    override def pickleLogic(fldClass: Class[_], fldValue: Any, b: PBuilder, fldPickler: SPickler[Any], fldTag: FastTypeTag[_]): Unit = {
      b.hintStaticallyElidedType()
      pickleInto(fldClass, fldValue, b, fldPickler, fldTag)
    }
  }

  // difference to old runtime pickler: create tag based on fieldClass instead of fir.tpe
  def pickleInto(fieldClass: Class[_], fieldValue: Any, builder: PBuilder, pickler: SPickler[Any], fieldTag: FastTypeTag[_]): Unit = {
    //debug(s"fieldTag for pickleInto: ${fieldTag.key}")
    builder.hintTag(fieldTag)

    val fieldTpe = fieldTag.tpe
    if (shouldBotherAboutSharing(fieldTpe))
      fieldValue match {
        case null => pickler.asInstanceOf[SPickler[Null]].pickle(null, builder)
        case _ =>
          val oid = scala.pickling.internal.lookupPicklee(fieldValue)
          builder.hintOid(oid)
          if (oid == -1) {
            pickler.pickle(fieldValue, builder)
          } else {
            builder.beginEntry(fieldValue)
            builder.endEntry()
          }
      }
    else
      pickler.pickle(fieldValue, builder)
  }

  def mkPickler: SPickler[_] = {
    new SPickler[Any] {
      val fields: List[Logic] = cir.fields.flatMap { fir =>
        if (fir.accessor.nonEmpty)
          List(
            if (fir.tpe.typeSymbol.isEffectivelyFinal) new EffectivelyFinalLogic(fir)
            else if (fir.tpe.typeSymbol.asType.isAbstractType) new AbstractLogic(fir)
            else new DefaultLogic(fir)
          )
        else
          try {
            val javaField = clazz.getDeclaredField(fir.name)
            List(
              if (fir.tpe.typeSymbol.isEffectivelyFinal) new PrivateEffectivelyFinalJavaFieldLogic(fir, javaField)
              else new PrivateJavaFieldLogic(fir, javaField)
            )
          } catch {
            case e: java.lang.NoSuchFieldException => List()
          }
      }

      def putFields(picklee: Any, builder: PBuilder): Unit = {
        val im = mirror.reflect(picklee)
        fields.foreach(_.run(builder, picklee, im))
      }

      def pickle(picklee: Any, builder: PBuilder): Unit = {
        //debug(s"pickling object of type: ${tag.key}")
        builder.beginEntry(picklee)
        putFields(picklee, builder)
        builder.endEntry()
      }
    }
  }

}