package inquire

  1. Overview
  2. Docs
An OCaml library to create beautiful interactive CLIs

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (5)

Authors

  1. Thibaut Mattio

Maintainers

  1. Thibaut Mattio

Sources

inquire-0.2.1.tbz
sha256=0b88d89e24d4cbc0560a7c8d8ec51388990e1b27f24685029997afa52a7c720f
sha512=8b62860a8d15e41528a404a6f1b9968c3d79755607b5ea319af2e3e45516e672a785361d278279910928db4054e1800e87bcee0210ff3eabfb330713b368c827

doc/inquire.lambda-term/LTerm_read_line/class-engine/index.html

Class LTerm_read_line.engine

The read-line engine. If no clipboard is provided, LTerm_edit.clipboard is used. If no macro recorder is provided, macro is used.

Result
method virtual eval : 'a

Evaluates the contents of the engine.

Actions
method insert : Uchar.t -> unit

Inserts the given character. Note that is it also possible to manipulate directly the edition context.

method send_action : action -> unit

Evolves according to the given action.

State
method edit : unit Zed_edit.t

The edition engine used by this read-line engine.

method context : unit Zed_edit.context

The context for the edition engine.

method clipboard : Zed_edit.clipboard

The clipboard used by the edition engine.

method macro : action Zed_macro.t

The macro recorder.

method input_prev : Zed_rope.t

The input before the cursor.

method input_next : Zed_rope.t

The input after the cursor.

method mode : mode React.signal

The current mode.

method stylise : bool -> LTerm_text.t * int

Returns the stylised input and the position of the cursor. The argument is true if this is for the last drawing or false otherwise.

method history : (Zed_string.t list * Zed_string.t list) React.signal

The history zipper.

method message : LTerm_text.t option React.signal

A message to display in the completion box. When None the completion should be displayed, and when Some msg msg should be displayed.

method interrupt : exn Lwt_mvar.t

To notify an interrupt singal

Completion
method completion_words : (Zed_string.t * Zed_string.t) list React.signal

Current possible completions. Each completion is of the form (word, suffix) where word is the completion itself and suffix is a suffix to add if the completion is choosen.

method completion_index : int React.signal

The position in the completion bar.

method set_completion : ?index:int -> int -> (Zed_string.t * Zed_string.t) list -> unit

set_completion ?index start words sets the current completions. start is the position of the beginning of the word being completed and words is the list of possible completions with their suffixes. index is the position in the completion bar, default to 0. The result is made available through the completion_words signal.

method completion : unit

Ask for computing completion for current input. This method should call set_completion.

method complete : unit

Complete current input. This is the method called when the user presses Tab.

method show_box : bool

Whether to show the box or not. It default to true.