package lambda-term
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=f99c0c344df569a09599a836692d8475f80ff83a2099859e35fb5b2b9890c290
md5=78180c04ecfc8060b23d7d0014f24196
doc/lambda-term/LTerm_read_line/index.html
Module LTerm_read_line
Source
Interactive line input
For a complete example of usage of this module, look at the shell example (examples/shell.ml) distributed with Lambda-Term.
Exception raised when the user presses Ctrl^D
with an empty input.
Type of prompts.
Type of histories. It is a list of entries from the most recent to the oldest.
Completion
Returns the common prefix of a list of words.
Returns the common prefix of a list of words.
lookup word words
lookup for completion of word
into words
. It returns all words starting with word
.
lookup_assoc word words
does the same as lookup
but works on associative list.
Actions
type action =
| Edit of LTerm_edit.action
(*An edition action.
*)| Interrupt_or_delete_next_char
(*Interrupt if at the beginning of an empty line, or delete the next character.
*)| Complete
(*Complete current input.
*)| Complete_bar_next
(*Go to the next possible completion in the completion bar.
*)| Complete_bar_prev
(*Go to the previous possible completion in the completion bar.
*)| Complete_bar_first
(*Goto the beginning of the completion bar.
*)| Complete_bar_last
(*Goto the end of the completion bar.
*)| Complete_bar
(*Complete current input using the completion bar.
*)| History_prev
(*Go to the previous entry of the history.
*)| History_next
(*Go to the next entry of the history.
*)| History_search_prev
(*Search the previous entry of the history.
*)| History_search_next
(*Search the next entry of the history.
*)| Accept
(*Accept the current input.
*)| Clear_screen
(*Clear the screen.
*)| Prev_search
(*Search backward in the history.
*)| Next_search
(*Search forward in the history.
*)| Cancel_search
(*Cancel search mode.
*)| Break
(*Raise
*)Sys.Break
.| Suspend
(*Suspend the program.
*)| Edit_with_external_editor
(*Launch external editor.
*)
Type of actions.
Bindings.
bind seq actions
associates actions
to the given sequence.
unbind seq
unbinds seq
.
doc_of_action action
returns a short description of the action.
action_of_name str
converts the given action name into an action. Action name are the same as variants name but lowercased and with '_' replaced by '-'. It raises Not_found
if the name does not correspond to an action. It also recognizes edition actions.
The read-line engine
The global macro recorder.
The current read-line mode.
class virtual 'a engine : ?history:history -> ?clipboard:Zed_edit.clipboard -> ?macro:action
Zed_macro.t ->
unit -> object ... end
The read-line engine. If no clipboard is provided, LTerm_edit.clipboard
is used. If no macro recorder is provided, macro
is used.
Predefined classes
Simple read-line engine which returns the result as a string.
Read-line engine for reading a password. The stylise
method default to replacing all characters by '*'
. You can also for example completely disable displaying the password by doing:
type 'a read_keyword_result =
| Rk_value of 'a
(*The user typed a correct keyword and this is its associated value.
*)| Rk_error of Zed_string.t
(*The user did not enter a correct keyword and this is what he typed instead.
*)
The result of reading a keyword.
Read a keyword.