grizzled.readline

Completer

trait Completer extends AnyRef

Models a completer: An object that, given a line of input and a token within that line, finds possible completions for the token.

Deprecated

Use JLine <https://github.com/jline/jline2>

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Completer
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. 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

  1. final def !=(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  3. final def ##(): Int

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

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

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

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

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

    Definition Classes
    AnyRef
  15. final def notify(): Unit

    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit

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

    Definition Classes
    AnyRef
  18. def toString(): String

    Definition Classes
    AnyRef → Any
  19. 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

  20. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped