InterpolatorScope

A completion to convert a string literal into a string literal, example "Hello $na@@".

When converting a string literal into an interpolator we need to ensure a few cases:

- escape existing $ characters into $$, which are printed as $$ in order to escape the TextMate snippet syntax. - wrap completed name in curly braces s"Hello ${name}_ when the trailing character can be treated as an identifier part. - insert the leading s interpolator. - place the cursor at the end of the completed name using TextMate $0 snippet syntax.

lit: The string literal, includes an instrumented _CURSOR_ that we need to handle.
pos: The offset position of the cursor, right below @@_CURSOR_.
interpolator: Metadata about this interpolation, the location of the leading dollar character and whether the completed name needs to be wrapped in curly braces.
text: The text of the original source code without the instrumented _CURSOR_.

Linear Supertypes

Serializable, java.io.Serializable, Product, Equals, MetalsGlobal.CompletionPosition, AnyRef, Any

Instance Constructors

new InterpolatorScope(lit: MetalsGlobal.Literal, pos: MetalsGlobal.Position, interpolator: MetalsGlobal.InterpolationSplice, text: String)

lit
The string literal, includes an instrumented _CURSOR_ that we need to handle.
pos
The offset position of the cursor, right below @@_CURSOR_.
interpolator
Metadata about this interpolation, the location of the leading dollar character and whether the completed name needs to be wrapped in curly braces.
text
The text of the original source code without the instrumented _CURSOR_.

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
def additionalEdits(): List[TextEdit]
final def asInstanceOf[T0]: T0

Definition Classes
Any
final lazy val cache: Map[MetalsGlobal.Symbol, Boolean]

Definition Classes
CompletionPosition
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def compare(o1: MetalsGlobal.Member, o2: MetalsGlobal.Member): Int

Returns ordering between two candidate completions.
Returns ordering between two candidate completions.
- negative number if o1 member should be sorted before o2 - positive number if o2 member should be sorted before o1 - zero 0 if o1 and o2 are equal

Definition Classes
CompletionPosition
def contribute: List[MetalsGlobal.Member]

Returns true if this member should be sorted at the top of completion items.
Returns true if this member should be sorted at the top of completion items.

Definition Classes
InterpolatorScope → CompletionPosition
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val filter: String
def finalize(): Unit

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

Definition Classes
AnyRef → Any
val hasClosingBrace: Boolean
val hasOpeningBrace: Boolean
val interpolator: MetalsGlobal.InterpolationSplice

Metadata about this interpolation, the location of the leading dollar character and whether the completed name needs to be wrapped in curly braces.
def isCandidate(member: MetalsGlobal.Member): Boolean

Returns false if this member should be excluded from completion items.
Returns false if this member should be excluded from completion items.

Definition Classes
CompletionPosition
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isNew: Boolean

Definition Classes
CompletionPosition
def isPrioritized(m: MetalsGlobal.Member): Boolean

Definition Classes
CompletionPosition
final def isPrioritizedCached(m: MetalsGlobal.Member): Boolean

Definition Classes
CompletionPosition
def isType: Boolean

Definition Classes
CompletionPosition
val lit: MetalsGlobal.Literal

The string literal, includes an instrumented _CURSOR_ that we need to handle.
val nameRange: org.eclipse.lsp4j.Range
val nameStart: reflect.internal.util.Position
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def newText(sym: MetalsGlobal.Symbol): String
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val offset: Int
val pos: MetalsGlobal.Position

The offset position of the cursor, right below @@_CURSOR_.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val text: String

The text of the original source code without the instrumented _CURSOR_.
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 CompletionPosition

case class InterpolatorScope(lit: MetalsGlobal.Literal, pos: MetalsGlobal.Position, interpolator: MetalsGlobal.InterpolationSplice, text: String) extends MetalsGlobal.CompletionPosition with Product with Serializable

Instance Constructors

new InterpolatorScope(lit: MetalsGlobal.Literal, pos: MetalsGlobal.Position, interpolator: MetalsGlobal.InterpolationSplice, text: String)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def additionalEdits(): List[TextEdit]

final def asInstanceOf[T0]: T0

final lazy val cache: Map[MetalsGlobal.Symbol, Boolean]

def clone(): AnyRef

def compare(o1: MetalsGlobal.Member, o2: MetalsGlobal.Member): Int

def contribute: List[MetalsGlobal.Member]

final def eq(arg0: AnyRef): Boolean

val filter: String

def finalize(): Unit

final def getClass(): Class[_]

val hasClosingBrace: Boolean

val hasOpeningBrace: Boolean

val interpolator: MetalsGlobal.InterpolationSplice

def isCandidate(member: MetalsGlobal.Member): Boolean

final def isInstanceOf[T0]: Boolean

def isNew: Boolean

def isPrioritized(m: MetalsGlobal.Member): Boolean

final def isPrioritizedCached(m: MetalsGlobal.Member): Boolean

def isType: Boolean

val lit: MetalsGlobal.Literal

val nameRange: org.eclipse.lsp4j.Range

val nameStart: reflect.internal.util.Position

final def ne(arg0: AnyRef): Boolean

def newText(sym: MetalsGlobal.Symbol): String

final def notify(): Unit

final def notifyAll(): Unit

val offset: Int

val pos: MetalsGlobal.Position

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

val text: String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from java.io.Serializable

Inherited from Product

Inherited from Equals

Inherited from MetalsGlobal.CompletionPosition

Inherited from AnyRef

Inherited from Any

Ungrouped