Object

ammonite.terminal

Terminal

Related Doc: package terminal

Permalink

object Terminal

The core logic around a terminal; it defines the base filters API through which anything (including basic cursor-navigation and typing) interacts with the terminal.

Maintains basic invariants, such as "cursor should always be within the buffer", and "ansi terminal should reflect most up to date TermState"

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Terminal
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Action = (Vector[Char], Int) ⇒ (Vector[Char], Int)

    Permalink
  2. type MsgAction = (Vector[Char], Int) ⇒ (Vector[Char], Int, String)

    Permalink

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def calculateHeight(buffer: Vector[Char], width: Int, prompt: String): Seq[Int]

    Permalink
  6. def calculateHeight0(rowLengths: Seq[Int], width: Int): Seq[Int]

    Permalink

    Given a buffer with characters and newlines, calculates how high the buffer is and where the cursor goes inside of it.

  7. def clone(): AnyRef

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. def fragHeight(length: Int, width: Int): Int

    Permalink

    Computes how tall a line of text is when wrapped at width.

    Computes how tall a line of text is when wrapped at width.

    Even 0-character lines still take up one row!

    width = 2 0 -> 1 1 -> 1 2 -> 1 3 -> 2 4 -> 2 5 -> 3

  12. final def getClass(): Class[_]

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

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

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

    Permalink
    Definition Classes
    AnyRef
  16. def noTransform(x: Vector[Char], i: Int): (Str, Int)

    Permalink
  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. def positionCursor(cursor: Int, rowLengths: Seq[Int], fragHeights: Seq[Int], width: Int): (Int, Int)

    Permalink
  20. def readLine(prompt: Prompt, reader: Reader, writer: Writer, filters: Filter, displayTransform: (Vector[Char], Int) ⇒ (Str, Int) = noTransform): Option[String]

    Permalink

    Blockingly reads a line from the given input stream and returns it.

    Blockingly reads a line from the given input stream and returns it.

    prompt

    The prompt to display when requesting input

    reader

    The input-stream where characters come in, e.g. System.in

    writer

    The output-stream where print-outs go, e.g. System.out

    filters

    A set of actions that can be taken depending on the input, to manipulate the internal state of the terminal.

    displayTransform

    code to manipulate the display of the buffer and cursor, without actually changing the logical values inside them.

  21. def splitBuffer(buffer: Vector[Char]): Buffer[Int]

    Permalink
  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped