Linenoise Functions

Functions
int	Qore::Linenoise::columns ()
	Get terminal width in characters.
list< auto >	Qore::Linenoise::history ()
	Get complete history.
int	Qore::Linenoise::history_add (string line)
	Add string to history.
nothing	Qore::Linenoise::history_free ()
	Clear the history.
int	Qore::Linenoise::history_get_max_len ()
	get size of the history
nothing	Qore::Linenoise::history_load (string filename)
	Load history from file.
nothing	Qore::Linenoise::history_save (string filename)
	Save history to file.
int	Qore::Linenoise::history_set_max_len (int len)
	Set size of the history.
string	Qore::Linenoise::line (string prompt)
	Main function to obtain line value.
nothing	Qore::Linenoise::set_callback (code callback)
	Set auto-completion callback function.

Detailed Description

Function Documentation

columns()

int Qore::Linenoise::columns

(

)

Get terminal width in characters.

Returns

int actual width of terminal window in characters

history()

list< auto > Qore::Linenoise::history

(

)

Get complete history.

Get complete history. History structure is limited by Qore::Linenoise::history_set_max_len()

Returns

list a list with histroy items. 0 index is the oldest.

See also

History Handling

history_add()

int Qore::Linenoise::history_add

(

string

line

)

Add string to history.

It adds new item to history. The history queue is shifted if it hits the maximum history size.

Parameters

line	a string to be added

history_get_max_len()

int Qore::Linenoise::history_get_max_len

(

)

get size of the history

Returns

int with size of history

history_load()

nothing Qore::Linenoise::history_load

(

string

filename

)

Load history from file.

Load history queue from plain-text file.

Parameters

filename

a filename with relative or full path

Exceptions

LINENOISE-HISTORY-LOAD-ERROR

history_save()

nothing Qore::Linenoise::history_save

(

string

filename

)

Save history to file.

Save history queue to plain-text file.

Parameters

filename

a filename with relative or full path

Exceptions

LINENOISE-HISTORY-SAVE-ERROR

history_set_max_len()

int Qore::Linenoise::history_set_max_len

(

int

len

)

Set size of the history.

Parameters

len	a new size

line()

string Qore::Linenoise::line

(

string

prompt

)

Main function to obtain line value.

The function waits for user input confirmed by Enter.

Parameters

prompt

a custom string with prompt

Returns

User input string or Qore::NOTHING if the user sends ^C (Ctrl+C) interrupt signal

Features:

• accept basic user input: regular characters, cursor keys, TAB, ENTER keys
• accept advanced edits: Ctrl+key, Keyboard Shortcuts
• waits until the ENTER is pressed

Example:

while (True) {
    *string line = line("my prompt> ");
    printf("echo: %s\n", line);
}

See also

Basic Usage

set_callback()

nothing Qore::Linenoise::set_callback

(

code

callback

)

Set auto-completion callback function.

Parameters

code	a funnction/method reference or a closure to handle completion callback

See also

Line Completion

Warning

Qore language does not support complex types yet so you can register any code with this function. But if the function/code will not accept the string argument the RUNTIME-OVERLOAD-ERROR exception will be thrown