linenoise.h File Reference

#include <sys/types.h>
#include <unistd.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>

Go to the source code of this file.

Data Structures
struct	linenoiseCompletions

Typedefs
typedef struct linenoiseCompletions	linenoiseCompletions
typedef void()	linenoiseCompletionCallback(const char *, linenoiseCompletions *)
typedef char *()	linenoiseHintsCallback(const char *, int *color, int *bold)
typedef void()	linenoiseFreeHintsCallback(void *)
typedef ssize_t(*	linenoise_read_bytes_fn) (int, void *, size_t)

Functions
void	linenoiseSetCompletionCallback (linenoiseCompletionCallback *)
void	linenoiseSetHintsCallback (linenoiseHintsCallback *)
void	linenoiseSetFreeHintsCallback (linenoiseFreeHintsCallback *)
void	linenoiseAddCompletion (linenoiseCompletions *, const char *)
int	linenoiseProbe (void)
char *	linenoise (const char *prompt)
void	linenoiseFree (void *ptr)
int	linenoiseHistoryAdd (const char *line)
int	linenoiseHistorySetMaxLen (int len)
int	linenoiseHistorySave (const char *filename)
int	linenoiseHistoryLoad (const char *filename)
void	linenoiseHistoryFree (void)
void	linenoiseClearScreen (void)
void	linenoiseSetMultiLine (int ml)
void	linenoiseSetDumbMode (int set)
bool	linenoiseIsDumbMode (void)
void	linenoisePrintKeyCodes (void)
void	linenoiseAllowEmpty (bool)
int	linenoiseSetMaxLineLen (size_t len)
void	linenoiseSetReadFunction (linenoise_read_bytes_fn read_fn)
void	linenoiseSetReadCharacteristics (void)

Typedef Documentation

linenoiseCompletions

typedef struct linenoiseCompletions linenoiseCompletions

linenoiseCompletionCallback

typedef void() linenoiseCompletionCallback(const char *, linenoiseCompletions *)

linenoiseHintsCallback

typedef char *() linenoiseHintsCallback(const char *, int *color, int *bold)

linenoiseFreeHintsCallback

typedef void() linenoiseFreeHintsCallback(void *)

linenoise_read_bytes_fn

typedef ssize_t(* linenoise_read_bytes_fn) (int, void *, size_t)

Function Documentation

linenoiseSetCompletionCallback()

void linenoiseSetCompletionCallback

(

linenoiseCompletionCallback *

fn

)

linenoiseSetHintsCallback()

void linenoiseSetHintsCallback

(

linenoiseHintsCallback *

fn

)

linenoiseSetFreeHintsCallback()

void linenoiseSetFreeHintsCallback

(

linenoiseFreeHintsCallback *

fn

)

linenoiseAddCompletion()

void linenoiseAddCompletion	(	linenoiseCompletions *	lc,
		const char *	str
	)

linenoiseProbe()

int linenoiseProbe

(

void

)

linenoise()

char * linenoise

(

const char *

prompt

)

linenoiseFree()

void linenoiseFree

(

void *

ptr

)

linenoiseHistoryAdd()

int linenoiseHistoryAdd

(

const char *

line

)

linenoiseHistorySetMaxLen()

int linenoiseHistorySetMaxLen

(

int

len

)

linenoiseHistorySave()

int linenoiseHistorySave

(

const char *

filename

)

linenoiseHistoryLoad()

int linenoiseHistoryLoad

(

const char *

filename

)

linenoiseHistoryFree()

void linenoiseHistoryFree

(

void

)

linenoiseClearScreen()

void linenoiseClearScreen

(

void

)

linenoiseSetMultiLine()

void linenoiseSetMultiLine

(

int

ml

)

linenoiseSetDumbMode()

void linenoiseSetDumbMode

(

int

set

)

linenoiseIsDumbMode()

bool linenoiseIsDumbMode

(

void

)

linenoisePrintKeyCodes()

void linenoisePrintKeyCodes

(

void

)

linenoiseAllowEmpty()

void linenoiseAllowEmpty

(

bool

val

)

linenoiseSetMaxLineLen()

int linenoiseSetMaxLineLen

(

size_t

len

)

linenoiseSetReadFunction()

void linenoiseSetReadFunction

(

linenoise_read_bytes_fn

read_fn

)

linenoiseSetReadCharacteristics()

void linenoiseSetReadCharacteristics

(

void

)