ammonite.terminal

Terminal

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
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

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

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

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 calculateHeight(buffer: Vector[Char], width: Int, prompt: String): Seq[Int]

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

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

  9. def clone(): AnyRef

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

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

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

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

    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

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

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

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

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

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

  19. final def notify(): Unit

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

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

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

    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.

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

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

    Definition Classes
    AnyRef
  25. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped