Movement

A context dependent, directional movement that can be applied to a SourceWithMarker

Overview

Movements can be combined similar to parser combinators and optionally applied backwards. They are meant to be used to perform minor tweaks in already parsed source code that might be necessary due to compiler bugs or compiler API limitations.

Why not use parser combinators?

We want to conveniently move forward and backward in the source code
The code we are looking at is already parsed; we only want to move to specific points

Examples

scala> import scala.tools.refactoring.util.SourceWithMarker
scala> import scala.tools.refactoring.util.SourceWithMarker._
scala> import scala.tools.refactoring.util.SourceWithMarker.Movements._

scala> val src = SourceWithMarker("private val /*---*/x = 4".toCharArray)
src: scala.tools.refactoring.util.SourceWithMarker =

riv...
scala> val movement = ("private" | "protected") ~ commentsAndSpaces ~ "val" ~ commentsAndSpaces
scala> val srcAtx = src.moveMarker(movement)
srcAtx: scala.tools.refactoring.util.SourceWithMarker = ... <x> = ...
scala> val moveBackToVal = ("al" ~ commentsAndSpaces ~ "x").backward
scala> val srcAtVal = srcAtx.moveMarker(moveBackToVal)
srcAtVal:  scala.tools.refactoring.util.SourceWithMarker = ...te <v>al ...

Self Type: Movement
See also: Movements

Linear Supertypes

SimpleMovement, AnyRef, Any

Known Subclasses

SingleCharMovement

Abstract Value Members

abstract def apply(sourceWithMarker: SourceWithMarker): Option[Int]

Definition Classes
SimpleMovement
abstract def backward: Movement

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

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

Definition Classes
Any
final def ##(): Int

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

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

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
final def atLeastOnce: Movement

Definition Classes
Movement → SimpleMovement
final def atMostNtimes(n: Int): Movement

Definition Classes
Movement → SimpleMovement
final def butNot(mvnt: Movement): Movement
def butNot(other: SimpleMovement): SimpleMovement

Definition Classes
SimpleMovement
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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 nTimes(n: Int): Movement

Definition Classes
Movement → SimpleMovement
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 optional: Movement

Definition Classes
Movement → SimpleMovement
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( ... )
final def zeroOrMore: Movement

Definition Classes
Movement → SimpleMovement
final def |(other: Movement): Movement
final def |(other: SimpleMovement): SimpleMovement

Definition Classes
SimpleMovement
final def ~(other: Movement): Movement
final def ~(other: SimpleMovement): SimpleMovement

Definition Classes
SimpleMovement

trait Movement extends SimpleMovement

Overview

Why not use parser combinators?

Examples

Abstract Value Members

abstract def apply(sourceWithMarker: SourceWithMarker): Option[Int]

abstract def backward: Movement

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

final def atLeastOnce: Movement

final def atMostNtimes(n: Int): Movement

final def butNot(mvnt: Movement): Movement

def butNot(other: SimpleMovement): SimpleMovement

def clone(): AnyRef

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 nTimes(n: Int): Movement

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def optional: Movement

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

final def zeroOrMore: Movement

final def |(other: Movement): Movement

final def |(other: SimpleMovement): SimpleMovement

final def ~(other: Movement): Movement

final def ~(other: SimpleMovement): SimpleMovement

Inherited from SimpleMovement

Inherited from AnyRef

Inherited from Any

Ungrouped