Completer

Abstract Value Members

abstract def complete(token: String, allTokens: List[CompletionToken], line: String): List[String]

Get all completions for a token.
Get all completions for a token. The context argument bears some explaining. It's designed to allow the completer to locate the cursor (and the nearest token) via Scala pattern matching, and it consists of a stream of abstract tokens:
- LineToken is a token parsed from the line, in an object that's similar to Some: LineToken.value returns the token's string. - Cursor indicates the location of the cursor - Delim indicates the presence of a token delimiter (typically white space)
The input line is broken into these tokens, which can then be matched. For example, consider the following input lines, with the cursor where the caret is:
Line: ^ (empty) Tokens: Cursor
Line: cm^ Tokens: LineToken("cm") Cursor
Line: cmd ^ Tokens: LineToken("cmd") Delim Cursor Line: `cmd arg1^` Tokens: `LineToken("cmd") Delim Token("arg1") Cursor` Line: `cmd arg1^` Tokens: `LineToken("cmd") Delim Token("arg1") Delim Cursor` Line: `cmd^ arg1` Tokens: `LineToken("cmd") Cursor Delim Token("arg1")` Line: `cm^d arg1` Tokens: `LineToken("cmd") Cursor Delim Token("arg1")`
token
the token being completed
allTokens
all the tokens in the line, broken out, with the cursor inserted (i.e., the token context)
line
the current unparsed input line, which includes the token
returns
a list of completions, or Nil if there are no matches

Concrete 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( ... )
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
def tokenDelimiters: String

Get the delimiters that should be used to break a line into tokens.
Get the delimiters that should be used to break a line into tokens. The default is white space.
returns
the delimiters
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 readline

trait Completer extends AnyRef

Abstract Value Members

abstract def complete(token: String, allTokens: List[CompletionToken], line: String): List[String]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

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 ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

def tokenDelimiters: 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