Combinators

Type Members

implicit class CTWithResult[U <: T] extends AnyRef

Part of the 'transform' infrastructure.
Part of the 'transform' infrastructure. transform ca take either a T only or a (T, A). (t, a) is bit cumbersome to write and that is why CTWithResult exists. This allows to write t andCollect a instead of (t, List(a))
abstract class CollectInType[C[_]] extends AnyRef

This is solely use to write collect as def collect[C[_] ] = new CollectInType[C] {..} instead of def collect[C[_] ] = new {} and so to not use reflective calls.
This is solely use to write collect as def collect[C[_] ] = new CollectInType[C] {..} instead of def collect[C[_] ] = new {} and so to not use reflective calls. This as not been benchmarked so I don't really know if it has a real performance impact
trait Collector[C, A, R] extends AnyRef

This trait is part of the infrastructure required to make the collect combinator have a default parameter to List[_].
This trait is part of the infrastructure required to make the collect combinator have a default parameter to List[_]. C is the type of the collection (ex: List[Int]) given by the User (or inferred to Nothing by the compiler) A is the element inside the collection (in List[Int] it would be Int) R is the 'real' collection that will be used i.e if C = Nothing => R = List[A] else R = C
Note: maybe it would be interesting to generate such boilerplaite with a macro annotation. Something like that:

Value Members

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from Combinators[T] to any2stringadd[Combinators[T]] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (Combinators[T], B)

Implicit information
This member is added by an implicit conversion from Combinators[T] to ArrowAssoc[Combinators[T]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def @@[U <: T](implicit arg0: ClassTag[U]): (Combinators.this)#Matcher[U]

Alias for select
object Collector
final def asInstanceOf[T0]: T0

Definition Classes
Any
def bottomUp[A](m: ⇒ (Combinators.this)#Matcher[A])(implicit arg0: Monoid[A]): (Combinators.this)#Matcher[A]

Same as bottomUpBreak, but does not sop when a transformation/traversal has succeeded
def bottomUpBreak[A](m: (Combinators.this)#Matcher[A])(implicit arg0: Monoid[A]): (Combinators.this)#Matcher[A]

Traverse the tree in a BottomUp manner, stop when a transformation/traversal has succeeded
def children[A](f: ⇒ (Combinators.this)#Matcher[A])(implicit arg0: Monoid[A]): (Combinators.this)#Matcher[A]

Traverse the direct children of the tree and apply f to them.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def collect[C[_]]: (Combinators.this)#CollectInType[C]

Same as visit but puts the results into a collection (List by default)
def collect2[V[_, _]]: AnyRef { def apply[A, B](f: PartialFunction[T,(A, B)])(implicit x: scala.reflect.ClassTag[T],implicit y: scala.collection.generic.CanBuildFrom[V[A,B],(A, B),V[A,B]]): Combinators.this.Matcher[V[A,B]] }

same as collect but put the results into a collection of 2 type parameter e.g a Map[K, V]
def ensuring(cond: (Combinators[T]) ⇒ Boolean, msg: ⇒ Any): Combinators[T]

Implicit information
This member is added by an implicit conversion from Combinators[T] to Ensuring[Combinators[T]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (Combinators[T]) ⇒ Boolean): Combinators[T]

Implicit information
This member is added by an implicit conversion from Combinators[T] to Ensuring[Combinators[T]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): Combinators[T]

Implicit information
This member is added by an implicit conversion from Combinators[T] to Ensuring[Combinators[T]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): Combinators[T]

Implicit information
This member is added by an implicit conversion from Combinators[T] to Ensuring[Combinators[T]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
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] )
def fix[A](f: ((Combinators.this)#Matcher[A]) ⇒ (Combinators.this)#Matcher[A]): (Combinators.this)#Matcher[A]

The infamous fix point combinator
macro def focus(f: PartialFunction[T, Boolean]): (Combinators.this)#Matcher[T]

Syntactic sugar for guard combinator so that one doesn't need to type the type parameter
def formatted(fmtstr: String): String

Implicit information
This member is added by an implicit conversion from Combinators[T] to StringFormat[Combinators[T]] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def guard[U <: T](f: PartialFunction[U, Boolean])(implicit arg0: ClassTag[U]): (Combinators.this)#Matcher[U]

Succeed if the partial function f applied on the tree is defined and return true
def hashCode(): Int

Definition Classes
AnyRef → Any
def identity[A](implicit arg0: Monoid[A]): (Combinators.this)#Matcher[A]

Simple Identity combinator.
Simple Identity combinator. a identity = a
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
def oneOfChildren[A](m: ⇒ (Combinators.this)#Matcher[A])(implicit arg0: Monoid[A]): (Combinators.this)#Matcher[A]
def parse[U](implicit convert: Convert[Combinators[T], meta.Input], dialect: Dialect, parse: meta.Parse[U]): U

Implicit information
This member is added by an implicit conversion from Combinators[T] to meta.XtensionInputLike[Combinators[T]] performed by method XtensionInputLike in scala.meta.syntactic.Api.
Definition Classes
XtensionInputLike
def select[U <: T](implicit arg0: ClassTag[U]): (Combinators.this)#Matcher[U]

Alias for focus{case t: U => some((t,t)}
def show[Style[X] <: Show[X]](implicit style: Style[Combinators[T]]): String

Implicit information
This member is added by an implicit conversion from Combinators[T] to meta.XtensionShow[Combinators[T]] performed by method XtensionShow in scala.meta.ui.Api.
Definition Classes
XtensionShow
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def tokens(implicit convert: Convert[Combinators[T], meta.Input], dialect: Dialect): meta.Tokens

Implicit information
This member is added by an implicit conversion from Combinators[T] to meta.XtensionInputLike[Combinators[T]] performed by method XtensionInputLike in scala.meta.syntactic.Api.
Definition Classes
XtensionInputLike
def topDown[A](m: (Combinators.this)#Matcher[A])(implicit arg0: Monoid[A]): (Combinators.this)#Matcher[A]

Same as TopDown, but does not sop when a transformation/traversal has succeeded
def topDownBreak[A](m: (Combinators.this)#Matcher[A])(implicit arg0: Monoid[A]): (Combinators.this)#Matcher[A]

Traverse the tree in a TopDown manner, stop when a transformation/traversal has succeeded
macro def transform(f: PartialFunction[T, Any]): (Combinators.this)#Matcher[Any]

Syntactic sugar for transform combinator so that one doesn't need to type the type parameter
def transformWithResult[I <: T, O <: T, A](f: PartialFunction[I, (O, A)])(implicit arg0: ClassTag[I], x: AllowedTransformation[I, O]): (Combinators.this)#Matcher[A]

Transform a I into a T where both I and O are subtypes of T and where a transformation from I to O is authorized
def tupledUntil[A, B](m1: (Combinators.this)#Matcher[A], m2: (Combinators.this)#Matcher[B])(implicit arg0: Monoid[A], arg1: Monoid[B]): (Combinators.this)#Matcher[(A, B)]
def until[A, B](m1: ⇒ (Combinators.this)#Matcher[A], m2: (Combinators.this)#Matcher[B])(implicit arg0: Monoid[A]): (Combinators.this)#Matcher[A]
def visit[A](f: PartialFunction[T, A])(implicit x: ClassTag[T]): (Combinators.this)#Matcher[A]

Traverse the data structure and return a result
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( ... )
def →[B](y: B): (Combinators[T], B)

Implicit information
This member is added by an implicit conversion from Combinators[T] to ArrowAssoc[Combinators[T]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Combinators[T] to any2stringadd[Combinators[T]]

Inherited by implicit conversion StringFormat from Combinators[T] to StringFormat[Combinators[T]]

Inherited by implicit conversion Ensuring from Combinators[T] to Ensuring[Combinators[T]]

Inherited by implicit conversion ArrowAssoc from Combinators[T] to ArrowAssoc[Combinators[T]]

Inherited by implicit conversion XtensionShow from Combinators[T] to meta.XtensionShow[Combinators[T]]

Inherited by implicit conversion XtensionInputLike from Combinators[T] to meta.XtensionInputLike[Combinators[T]]

Ungrouped

Related Doc: package tql

trait Combinators[T] extends AnyRef

Type Members

implicit class CTWithResult[U <: T] extends AnyRef

abstract class CollectInType[C[_]] extends AnyRef

trait Collector[C, A, R] extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (Combinators[T], B)

final def ==(arg0: Any): Boolean

def @@[U <: T](implicit arg0: ClassTag[U]): (Combinators.this)#Matcher[U]

object Collector

final def asInstanceOf[T0]: T0

def bottomUp[A](m: ⇒ (Combinators.this)#Matcher[A])(implicit arg0: Monoid[A]): (Combinators.this)#Matcher[A]

def bottomUpBreak[A](m: (Combinators.this)#Matcher[A])(implicit arg0: Monoid[A]): (Combinators.this)#Matcher[A]

def children[A](f: ⇒ (Combinators.this)#Matcher[A])(implicit arg0: Monoid[A]): (Combinators.this)#Matcher[A]

def clone(): AnyRef

def collect[C[_]]: (Combinators.this)#CollectInType[C]

def collect2[V[_, _]]: AnyRef { def apply[A, B](f: PartialFunction[T,(A, B)])(implicit x: scala.reflect.ClassTag[T],implicit y: scala.collection.generic.CanBuildFrom[V[A,B],(A, B),V[A,B]]): Combinators.this.Matcher[V[A,B]] }

def ensuring(cond: (Combinators[T]) ⇒ Boolean, msg: ⇒ Any): Combinators[T]

def ensuring(cond: (Combinators[T]) ⇒ Boolean): Combinators[T]

def ensuring(cond: Boolean, msg: ⇒ Any): Combinators[T]

def ensuring(cond: Boolean): Combinators[T]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def fix[A](f: ((Combinators.this)#Matcher[A]) ⇒ (Combinators.this)#Matcher[A]): (Combinators.this)#Matcher[A]

macro def focus(f: PartialFunction[T, Boolean]): (Combinators.this)#Matcher[T]

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def guard[U <: T](f: PartialFunction[U, Boolean])(implicit arg0: ClassTag[U]): (Combinators.this)#Matcher[U]

def hashCode(): Int

def identity[A](implicit arg0: Monoid[A]): (Combinators.this)#Matcher[A]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def oneOfChildren[A](m: ⇒ (Combinators.this)#Matcher[A])(implicit arg0: Monoid[A]): (Combinators.this)#Matcher[A]

def parse[U](implicit convert: Convert[Combinators[T], meta.Input], dialect: Dialect, parse: meta.Parse[U]): U

def select[U <: T](implicit arg0: ClassTag[U]): (Combinators.this)#Matcher[U]

def show[Style[X] <: Show[X]](implicit style: Style[Combinators[T]]): String

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

def toString(): String

def tokens(implicit convert: Convert[Combinators[T], meta.Input], dialect: Dialect): meta.Tokens

def topDown[A](m: (Combinators.this)#Matcher[A])(implicit arg0: Monoid[A]): (Combinators.this)#Matcher[A]

def topDownBreak[A](m: (Combinators.this)#Matcher[A])(implicit arg0: Monoid[A]): (Combinators.this)#Matcher[A]

macro def transform(f: PartialFunction[T, Any]): (Combinators.this)#Matcher[Any]

def transformWithResult[I <: T, O <: T, A](f: PartialFunction[I, (O, A)])(implicit arg0: ClassTag[I], x: AllowedTransformation[I, O]): (Combinators.this)#Matcher[A]

def tupledUntil[A, B](m1: (Combinators.this)#Matcher[A], m2: (Combinators.this)#Matcher[B])(implicit arg0: Monoid[A], arg1: Monoid[B]): (Combinators.this)#Matcher[(A, B)]

def until[A, B](m1: ⇒ (Combinators.this)#Matcher[A], m2: (Combinators.this)#Matcher[B])(implicit arg0: Monoid[A]): (Combinators.this)#Matcher[A]

def visit[A](f: PartialFunction[T, A])(implicit x: ClassTag[T]): (Combinators.this)#Matcher[A]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def →[B](y: B): (Combinators[T], B)

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Combinators[T] to any2stringadd[Combinators[T]]

Inherited by implicit conversion StringFormat from Combinators[T] to StringFormat[Combinators[T]]

Inherited by implicit conversion Ensuring from Combinators[T] to Ensuring[Combinators[T]]

Inherited by implicit conversion ArrowAssoc from Combinators[T] to ArrowAssoc[Combinators[T]]

Inherited by implicit conversion XtensionShow from Combinators[T] to meta.XtensionShow[Combinators[T]]

Inherited by implicit conversion XtensionInputLike from Combinators[T] to meta.XtensionInputLike[Combinators[T]]

Ungrouped