FactMacros

FactMacros contains two compile-time macros which allow the easy creation of a Fact, without having to explicitly repeat the name of the Fact as an argument. This makes it easier to define Facts for use in a DSL, as the name of the val to which it is assigned, becomes the name of the Fact itself.

Without these macros, you would need to create Facts as follows:

val MyFact = new SingularFact[Int]("MyFact")

This redundancy of the Fact's name is not just a nuisance to type, it actually causes trouble when renaming the Fact, or trying to copy its declaration. In both situations, you *must* also alter the name parameter manually. The compiler and IDE tooling cannot help you track these errors down and so you are bound to find out about them at runtime, with potentially uninformative error messages.

If instead, you use these macros, these troubles will be taken away. Define your Facts like this and have the IDE and compiler warn you about duplicate names etc:

val MyFact = FactMacros.defineFact[Int]("Description")

Linear Supertypes

AnyRef, Any

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
macro def defineFact[A](): SingularFact[A]

Defines a Fact, using the name of the val it is assigned to as the name of the Fact.
Defines a Fact, using the name of the val it is assigned to as the name of the Fact. Note: the value of this macro *must* be assigned to a val, otherwise a compiler error will be raised.
A
the value type of the resulting Fact.
returns
a SingularFact initialized with the name of the val declaration.
def defineFactMacroImpl[A](c: Context)()(implicit arg0: scala.reflect.macros.blackbox.Context.WeakTypeTag[A]): scala.reflect.macros.blackbox.Context.Expr[SingularFact[A]]

Annotations
@compileTimeOnly( ... )
def defineFactMacroWithDescriptionImpl[A](c: Context)(description: scala.reflect.macros.blackbox.Context.Expr[String])(implicit arg0: scala.reflect.macros.blackbox.Context.WeakTypeTag[A]): scala.reflect.macros.blackbox.Context.Expr[SingularFact[A]]

Annotations
@compileTimeOnly( ... )
macro def defineFactWithDescription[A](description: String): SingularFact[A]

Defines a Fact, using the name of the val it is assigned to as the name of the Fact.
Defines a Fact, using the name of the val it is assigned to as the name of the Fact. Note: the value of this macro *must* be assigned to a val, otherwise a compiler error will be raised.
A
the value type of the resulting Fact.
description
description of the Fact, to be passed along to the Fact's constructor.
returns
a SingularFact initialized with the name of the val declaration.
macro def defineListFact[A](): ListFact[A]

Defines a Fact, using the name of the val it is assigned to as the name of the Fact.
Defines a Fact, using the name of the val it is assigned to as the name of the Fact. Note: the value of this macro *must* be assigned to a val, otherwise a compiler error will be raised.
A
the value type of the resulting Fact.
returns
a ListFact initialized with the name of the val declaration.
def defineListFactMacroImpl[A](c: Context)()(implicit arg0: scala.reflect.macros.blackbox.Context.WeakTypeTag[A]): scala.reflect.macros.blackbox.Context.Expr[ListFact[A]]

Annotations
@compileTimeOnly( ... )
def defineListFactMacroWithDescriptionImpl[A](c: Context)(description: scala.reflect.macros.blackbox.Context.Expr[String])(implicit arg0: scala.reflect.macros.blackbox.Context.WeakTypeTag[A]): scala.reflect.macros.blackbox.Context.Expr[ListFact[A]]

Annotations
@compileTimeOnly( ... )
macro def defineListFactWithDescription[A](description: String): ListFact[A]

Defines a Fact, using the name of the val it is assigned to as the name of the Fact.
Defines a Fact, using the name of the val it is assigned to as the name of the Fact. Note: the value of this macro *must* be assigned to a val, otherwise a compiler error will be raised.
A
the value type of the resulting Fact.
description
description of the Fact, to be passed along to the Fact's constructor.
returns
a ListFact initialized with the name of the val declaration.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package utils

object FactMacros

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

macro def defineFact[A](): SingularFact[A]

def defineFactMacroImpl[A](c: Context)()(implicit arg0: scala.reflect.macros.blackbox.Context.WeakTypeTag[A]): scala.reflect.macros.blackbox.Context.Expr[SingularFact[A]]

def defineFactMacroWithDescriptionImpl[A](c: Context)(description: scala.reflect.macros.blackbox.Context.Expr[String])(implicit arg0: scala.reflect.macros.blackbox.Context.WeakTypeTag[A]): scala.reflect.macros.blackbox.Context.Expr[SingularFact[A]]

macro def defineFactWithDescription[A](description: String): SingularFact[A]

macro def defineListFact[A](): ListFact[A]

def defineListFactMacroImpl[A](c: Context)()(implicit arg0: scala.reflect.macros.blackbox.Context.WeakTypeTag[A]): scala.reflect.macros.blackbox.Context.Expr[ListFact[A]]

def defineListFactMacroWithDescriptionImpl[A](c: Context)(description: scala.reflect.macros.blackbox.Context.Expr[String])(implicit arg0: scala.reflect.macros.blackbox.Context.WeakTypeTag[A]): scala.reflect.macros.blackbox.Context.Expr[ListFact[A]]

macro def defineListFactWithDescription[A](description: String): ListFact[A]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped