grizzled.readline

ListCompleter

class ListCompleter extends Completer

A completer that completes from a list of items.

Linear Supertypes
Completer, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. ListCompleter
  2. Completer
  3. AnyRef
  4. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ListCompleter (completions: List[String])

    Version of the constructor that uses a default, no-op convert() function.

    Version of the constructor that uses a default, no-op convert() function.

    completions

    the list of valid completions

  2. new ListCompleter (completions: List[String], convert: (String) ⇒ String)

    completions

    the list of valid completions

    convert

    function to convert both the token to be compared and the candidate completion token, before comparing them (e.g., by converting them to lower case)

Value Members

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

    Attributes
    final
    Definition Classes
    AnyRef

  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any

  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any

  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  5. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any

  6. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any

  7. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  8. def complete (token: String, context: 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

    line

    the current unparsed input line, which includes the token

    returns

    a list of completions, or Nil if there are no matches

    Definition Classes
    ListCompleter → Completer

  9. val completions : List[String]

    the list of valid completions

  10. val convert : (String) ⇒ String

    function to convert both the token to be compared and the candidate completion token, before comparing them (e.

    function to convert both the token to be compared and the candidate completion token, before comparing them (e.g., by converting them to lower case)

  11. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  12. def equals (arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  13. def finalize (): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  14. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef → Any

  15. def hashCode (): Int

    Definition Classes
    AnyRef → Any

  16. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any

  17. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  18. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  19. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  20. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef

  21. def toString (): String

    Definition Classes
    AnyRef → Any

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

    Definition Classes
    Completer

  23. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  24. def wait (arg0: Long, arg1: Int): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  25. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from Completer

Inherited from AnyRef

Inherited from Any