Completion
API
Generated with
Completion/sbt.internal.util/sbt.internal.util.complete

sbt.internal.util.complete

package sbt.internal.util.complete

Members list

Type members

Classlikes

sealed trait Completion

Represents a completion. The abstract members display and append are best explained with an example.

Represents a completion. The abstract members display and append are best explained with an example.

Assuming space-delimited tokens, processing this: am is are w could produce these Completions: Completion { display = "was"; append = "as" } Completion { display = "were"; append = "ere" } to suggest the tokens "was" and "were".

In this way, two pieces of information are preserved: 1) what needs to be appended to the current input if a completion is selected 2) the full token being completed, which is useful for presenting a user with choices to select

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class DisplayOnly
class Suggestion
class Token
object Completion

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Completion.type
sealed trait Completions

Represents a set of completions. It exists instead of implicitly defined operations on top of Set[Completion] for laziness.

Represents a set of completions. It exists instead of implicitly defined operations on top of Set[Completion] for laziness.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object Completions

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
object DefaultParsers extends Parsers, ParserMain

Provides common Parser implementations and helper methods.

Provides common Parser implementations and helper methods.

Attributes

Supertypes
trait ParserMain
trait Parsers
class Object
trait Matchable
class Any
Self type
final class DisplayOnly(val display: String) extends Completion

Attributes

Supertypes
trait Completion
class Object
trait Matchable
class Any
object EditDistance

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
trait ExampleSource

These sources of examples are used in parsers for user input completion. An example of such a source is the sbt.internal.util.complete.FileExamples class, which provides a list of suggested files to the user as they press the TAB key in the console.

These sources of examples are used in parsers for user input completion. An example of such a source is the sbt.internal.util.complete.FileExamples class, which provides a list of suggested files to the user as they press the TAB key in the console.

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class FileExamples
class FileExamples(base: File, prefix: String) extends ExampleSource

Provides path completion examples based on files in the base directory.

Provides path completion examples based on files in the base directory.

Value parameters

base

the directory within which this class will search for completion examples.

prefix

the part of the path already written by the user.

Attributes

Supertypes
class Object
trait Matchable
class Any
final case class Finite(value: Int) extends UpperBound

Represents a finite upper bound. The maximum allowed value is 'value', inclusive. It must positive.

Represents a finite upper bound. The maximum allowed value is 'value', inclusive. It must positive.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait UpperBound
class Object
trait Matchable
class Any
Show all
sealed case class FixedSetExamples(examples: Iterable[String]) extends ExampleSource

A convenience example source that wraps any collection of strings into a source of examples.

A convenience example source that wraps any collection of strings into a source of examples.

Value parameters

examples

the examples that will be displayed to the user when they press the TAB key.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final class History

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object History

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
History.type
object HistoryCommands

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case object Infinite extends UpperBound

Represents unbounded.

Represents unbounded.

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait UpperBound
class Object
trait Matchable
class Any
Show all
Self type
Infinite.type
object JLineCompletion

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
trait Parser[+A1]

A String parser that provides semi-automatic tab completion. A successful parse results in a value of type A. The methods in this trait are what must be implemented to define a new Parser implementation, but are not typically useful for common usage. Instead, most useful methods for combining smaller parsers into larger parsers are implicitly added by the RichParser type.

A String parser that provides semi-automatic tab completion. A successful parse results in a value of type A. The methods in this trait are what must be implemented to define a new Parser implementation, but are not typically useful for common usage. Instead, most useful methods for combining smaller parsers into larger parsers are implicitly added by the RichParser type.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait ValidParser[T]
object Parser extends ParserMain

Contains Parser implementation helper methods not typically needed for using parsers.

Contains Parser implementation helper methods not typically needed for using parsers.

Attributes

Companion
trait
Supertypes
trait ParserMain
class Object
trait Matchable
class Any
Self type
Parser.type
trait ParserMain

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object DefaultParsers.type
object Parser.type
trait Parsers

Provides standard implementations of commonly useful Parsers.

Provides standard implementations of commonly useful Parsers.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object DefaultParsers.type
object Parsers.type
object Parsers extends Parsers

Provides standard Parser implementations.

Provides standard Parser implementations.

Attributes

Companion
trait
Supertypes
trait Parsers
class Object
trait Matchable
class Any
Self type
Parsers.type
object ProcessError

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait RichParser[A]

Attributes

Supertypes
class Object
trait Matchable
class Any
final class Suggestion(val append: String) extends Completion

Attributes

Supertypes
trait Completion
class Object
trait Matchable
class Any
final class Token(val display: String, val append: String) extends Completion

Attributes

Supertypes
trait Completion
class Object
trait Matchable
class Any
sealed trait TokenCompletions

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object TokenCompletions

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait UpperBound

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Finite
object Infinite.type
object UpperBound

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
UpperBound.type
sealed trait ValidParser[T] extends Parser[T]

Attributes

Supertypes
trait Parser[T]
class Object
trait Matchable
class Any
Generated with