Class/Object

ammonite.terminal.filters

HistoryFilter

Related Docs: object HistoryFilter | package filters

Permalink

class HistoryFilter extends DelegateFilter

Provides history navigation up and down, saving the current line, a well as history-search functionality (Ctrl R in bash) letting you quickly find & filter previous commands by entering a sub-string.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HistoryFilter
  2. DelegateFilter
  3. Filter
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new HistoryFilter(history: () ⇒ IndexedSeq[String], commentStartColor: Attrs)

    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. def activeHistory: Boolean

    Permalink
  5. def activeSearch: Boolean

    Permalink
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def backspace(b: Vector[Char], c: Int): (Vector[Char], Int, String)

    Permalink
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def ctrlR(b: Vector[Char], c: Int): (Vector[Char], Int, String)

    Permalink
  10. def down(b: Vector[Char], c: Int): (Vector[Char], Int, String)

    Permalink
  11. val dropHistoryChars: Set[Int]

    Permalink
  12. implicit val enclosing: Enclosing

    Permalink
    Definition Classes
    DelegateFilter
  13. def endHistory(): Unit

    Permalink
  14. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  16. def filter: Filter

    Permalink
    Definition Classes
    HistoryFilterDelegateFilter
  17. def filter0: Filter

    Permalink
  18. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  21. var historyIndex: Int

    Permalink

    -1 means we haven't started looking at history, n >= 0 means we're currently at history command n

  22. def identifier: String

    Permalink

    the .toString of this object, except by making it separate we force the implementer to provide something and stop them from accidentally leaving it as the meaningless default.

    the .toString of this object, except by making it separate we force the implementer to provide something and stop them from accidentally leaving it as the meaningless default.

    Definition Classes
    DelegateFilterFilter
  23. final def isInstanceOf[T0]: Boolean

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

    Permalink
    Definition Classes
    AnyRef
  25. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  27. def op(ti: TermInfo): Option[TermAction]

    Permalink
    Definition Classes
    DelegateFilterFilter
  28. def prelude: Filter

    Permalink
  29. var prevBuffer: Option[Vector[Char]]

    Permalink

    Records the last buffer that the filter has observed while it's in search/history mode.

    Records the last buffer that the filter has observed while it's in search/history mode. If the new buffer differs from this, assume that some other filter modified the buffer and drop out of search/history

  30. def printableChar(char: Char)(b: Vector[Char], c: Int): (Vector[Char], Int, String)

    Permalink
  31. def searchHistory(start: Int, increment: Int, buffer: Vector[Char], skipped: Vector[Char]): (Vector[Char], Int, String)

    Permalink
  32. def searchOrHistoryAnd(cond: Boolean): Boolean

    Permalink

    Predicate to check if either we're searching for a term or if we're in history-browsing mode and some predicate is true.

    Predicate to check if either we're searching for a term or if we're in history-browsing mode and some predicate is true.

    Very often we want to capture keystrokes in search-mode more aggressively than in history-mode, e.g. search-mode drops you out more aggressively than history-mode does, and its up/down keys cycle through history more aggressively on every keystroke while history-mode only cycles when you reach the top/bottom line of the multi-line input.

  33. var searchTerm: Option[Vector[Char]]

    Permalink

    The term we're searching for, if any.

    The term we're searching for, if any.

    - None means we're not searching for anything, e.g. we're just browsing history

    - Some(term) where term is not empty is what it normally looks like when we're searching for something

    - Some(term) where term is empty only really happens when you start searching and delete things, or if you Ctrl-R on an empty prompt

  34. def startHistory(b: Vector[Char], c: Int): (Vector[Char], Int, String)

    Permalink

    Kicks the HistoryFilter from passive-mode into search-history mode

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

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

    Permalink
    Definition Classes
    Filter → AnyRef → Any
  37. def up(b: Vector[Char], c: Int): (Vector[Char], Int, String)

    Permalink
  38. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. def wrap(rest: LazyList[Int], out: (Vector[Char], Int, String)): TermState

    Permalink

Inherited from DelegateFilter

Inherited from Filter

Inherited from AnyRef

Inherited from Any

Ungrouped