isocline
Options

Functions

void ic_set_prompt_marker (const char *prompt_marker, const char *continuation_prompt_marker)
 Set a prompt marker and a potential marker for extra lines with multiline input. More...
 
const char * ic_get_prompt_marker (void)
 Get the current prompt marker. More...
 
const char * ic_get_continuation_prompt_marker (void)
 Get the current continuation prompt marker. More...
 
bool ic_enable_multiline (bool enable)
 Disable or enable multi-line input (enabled by default). More...
 
bool ic_enable_beep (bool enable)
 Disable or enable sound (enabled by default). More...
 
bool ic_enable_color (bool enable)
 Disable or enable color output (enabled by default). More...
 
bool ic_enable_history_duplicates (bool enable)
 Disable or enable duplicate entries in the history (disabled by default). More...
 
bool ic_enable_auto_tab (bool enable)
 Disable or enable automatic tab completion after a completion to expand as far as possible if the completions are unique. More...
 
bool ic_enable_completion_preview (bool enable)
 Disable or enable preview of a completion selection (enabled by default) Returns the previous setting. More...
 
bool ic_enable_multiline_indent (bool enable)
 Disable or enable automatic identation of continuation lines in multiline input so it aligns with the initial prompt. More...
 
bool ic_enable_inline_help (bool enable)
 Disable or enable display of short help messages for history search etc. More...
 
bool ic_enable_hint (bool enable)
 Disable or enable hinting (enabled by default) Shows a hint inline when there is a single possible completion. More...
 
long ic_set_hint_delay (long delay_ms)
 Set millisecond delay before a hint is displayed. Can be zero. (500ms by default). More...
 
bool ic_enable_highlight (bool enable)
 Disable or enable syntax highlighting (enabled by default). More...
 
void ic_set_tty_esc_delay (long initial_delay_ms, long followup_delay_ms)
 Set millisecond delay for reading escape sequences in order to distinguish a lone ESC from the start of a escape sequence. More...
 
bool ic_enable_brace_matching (bool enable)
 Enable highlighting of matching braces (and error highlight unmatched braces).`. More...
 
void ic_set_matching_braces (const char *brace_pairs)
 Set matching brace pairs. More...
 
bool ic_enable_brace_insertion (bool enable)
 Enable automatic brace insertion (enabled by default). More...
 
void ic_set_insertion_braces (const char *brace_pairs)
 Set matching brace pairs for automatic insertion. More...
 

Detailed Description

Function Documentation

◆ ic_enable_auto_tab()

bool ic_enable_auto_tab ( bool  enable)

Disable or enable automatic tab completion after a completion to expand as far as possible if the completions are unique.

(disabled by default). Returns the previous setting.

◆ ic_enable_beep()

bool ic_enable_beep ( bool  enable)

Disable or enable sound (enabled by default).

A beep is used when tab cannot find any completion for example. Returns the previous setting.

◆ ic_enable_brace_insertion()

bool ic_enable_brace_insertion ( bool  enable)

Enable automatic brace insertion (enabled by default).

◆ ic_enable_brace_matching()

bool ic_enable_brace_matching ( bool  enable)

Enable highlighting of matching braces (and error highlight unmatched braces).`.

◆ ic_enable_color()

bool ic_enable_color ( bool  enable)

Disable or enable color output (enabled by default).

Returns the previous setting.

◆ ic_enable_completion_preview()

bool ic_enable_completion_preview ( bool  enable)

Disable or enable preview of a completion selection (enabled by default) Returns the previous setting.

◆ ic_enable_highlight()

bool ic_enable_highlight ( bool  enable)

Disable or enable syntax highlighting (enabled by default).

This applies regardless whether a syntax highlighter callback was set (ic_set_highlighter) Returns the previous setting.

◆ ic_enable_hint()

bool ic_enable_hint ( bool  enable)

Disable or enable hinting (enabled by default) Shows a hint inline when there is a single possible completion.

Returns
the previous setting.

◆ ic_enable_history_duplicates()

bool ic_enable_history_duplicates ( bool  enable)

Disable or enable duplicate entries in the history (disabled by default).

Returns the previous setting.

◆ ic_enable_inline_help()

bool ic_enable_inline_help ( bool  enable)

Disable or enable display of short help messages for history search etc.

(full help is always dispayed when pressing F1 regardless of this setting)

Returns
the previous setting.

◆ ic_enable_multiline()

bool ic_enable_multiline ( bool  enable)

Disable or enable multi-line input (enabled by default).

Returns the previous setting.

◆ ic_enable_multiline_indent()

bool ic_enable_multiline_indent ( bool  enable)

Disable or enable automatic identation of continuation lines in multiline input so it aligns with the initial prompt.

Returns the previous setting.

◆ ic_get_continuation_prompt_marker()

const char* ic_get_continuation_prompt_marker ( void  )

Get the current continuation prompt marker.

◆ ic_get_prompt_marker()

const char* ic_get_prompt_marker ( void  )

Get the current prompt marker.

◆ ic_set_hint_delay()

long ic_set_hint_delay ( long  delay_ms)

Set millisecond delay before a hint is displayed. Can be zero. (500ms by default).

◆ ic_set_insertion_braces()

void ic_set_insertion_braces ( const char *  brace_pairs)

Set matching brace pairs for automatic insertion.

Pass NULL for the default ‘()[]{}""’'`

◆ ic_set_matching_braces()

void ic_set_matching_braces ( const char *  brace_pairs)

Set matching brace pairs.

Pass NULL for the default "()[]{}".

◆ ic_set_prompt_marker()

void ic_set_prompt_marker ( const char *  prompt_marker,
const char *  continuation_prompt_marker 
)

Set a prompt marker and a potential marker for extra lines with multiline input.

Pass NULL for the prompt_marker for the default marker ("> "). Pass NULL for continuation prompt marker to make it equal to the prompt_marker.

◆ ic_set_tty_esc_delay()

void ic_set_tty_esc_delay ( long  initial_delay_ms,
long  followup_delay_ms 
)

Set millisecond delay for reading escape sequences in order to distinguish a lone ESC from the start of a escape sequence.

The defaults are 100ms and 10ms, but it may be increased if working with very slow terminals.