com.avsystem.commons.meta.AdtMetadataCompanion.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of commons-core_2.12 Show documentation

AVSystem commons library for Scala

The newest version!

package com.avsystem.commons
package meta

import com.avsystem.commons.macros.meta.AdtMetadataMacros

/**
  * Base trait for companion objects of ADT metadata classes.
  * ADT means "algebraic data type" which is, in practice, a case class or sealed hierarchy.
  *
  * Metadata class is a generic class that captures some metadata about a particular Scala type, using compile-time
  * reflection. This is done with the `materialize` macro. The macro is steered by various meta-annotations used
  * in the definition of the metadata class, e.g. [[adtParamMetadata]].
  *
  * @tparam M metadata class constructor
  */
trait AdtMetadataCompanion[M[_]] extends MetadataCompanion[M] {
  def materialize[T]: M[T] = macro AdtMetadataMacros.materialize[T]

  def fromApplyUnapplyProvider[T](applyUnapplyProvider: Any): M[T] = macro AdtMetadataMacros.fromApplyUnapplyProvider[T]
}

/**
  * Like [[AdtMetadataCompanion]] but allows the metadata class' type parameter to be bounded.
  *
  * @tparam Hi higher bound of metadata class' type param
  * @tparam Lo lower bound of metadata class' type param
  * @tparam M  metadata class type constructor
  */
// cannot share code with AdtMetadataCompanion because of binary compatibility problems, must copy
trait BoundedAdtMetadataCompanion[Hi, Lo <: Hi, M[_ >: Lo <: Hi]] extends BoundedMetadataCompanion[Hi, Lo, M] {
  def materialize[T >: Lo <: Hi]: M[T] = macro AdtMetadataMacros.materialize[T]

  def fromApplyUnapplyProvider[T >: Lo <: Hi](applyUnapplyProvider: Any): M[T] = macro AdtMetadataMacros.fromApplyUnapplyProvider[T]
}