class Fancyline

• Fancyline
• Reference
• Object

Overview

Readline-esque library with some fancy features.

Quick usage

A simple greeter can be built like this:

require "fancyline"

fancy = Fancyline.new
name = fancy.readline("Name: ")
puts "Hello, #{name}"

Have a look in the samples/ directory for more!

Defined in:

Constant Summary

VERSION = "0.4.1"

Constructors

• .new(input : IO = STDIN, output : IO = STDOUT, tty : Tty | Nil = nil)

Instance Method Summary

• #actions : KeyAction

  Key bindings (or "key map")

• #autocomplete : Middleware_autocomplete

  Returns the autocomplete middleware object.

• #call_autocomplete(ctx : Context, range : Range(Int32, Int32), word : String)

  Calls the final stage of autocomplete directly, without calling any previous stages.

• #call_display(ctx : Context, line : String)

  Calls the final stage of display directly, without calling any previous stages.

• #call_sub_info(ctx : Context)

  Calls the final stage of sub_info directly, without calling any previous stages.

• #context : Context | Nil

  Currently active context, if any

• #display : Middleware_display

  Returns the display middleware object.

• #grab_output(&)

  Grabs the output: If there's a running prompt, clears it from the screen.

• #history : History

  History of previous input

• #input : IO

  Device to read input from

• #output : IO

  Device to write terminal output to

• #raw_from_tc_mode!(fd, mode)

  Copied from IO::FileDescriptor, as this method is sadly private.

• #readline(prompt, rprompt : String | Nil = nil, history = true) : String | Nil

  Reads a line, showing the prompt.

• #sub_info : Middleware_sub_info

  Returns the sub_info middleware object.

• #tty : Tty

  TTY control

• #tty=(tty : Tty)

  TTY control

Constructor Detail

Instance Method Detail

fancyline.actions.set(Fancyline::Key::Control::CtrlC) do |ctx|
  ctx.reject! # Reject input, make `Fancyline#readline` return `nil`
end