linenoise.c File Reference

#include <unistd.h>
#include <stdlib.h>
#include <stdint.h>
#include <stdio.h>
#include <stddef.h>
#include <errno.h>
#include <string.h>
#include <ctype.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <fcntl.h>
#include <sys/time.h>
#include <sys/param.h>
#include <assert.h>
#include "linenoise.h"

Data Structures
struct	linenoiseState
struct	abuf

Macros
#define	LINENOISE_DEFAULT_HISTORY_MAX_LEN   100
#define	LINENOISE_DEFAULT_MAX_LINE   4096
#define	LINENOISE_MINIMAL_MAX_LINE   64
#define	LINENOISE_COMMAND_MAX_LEN   32
#define	LINENOISE_PASTE_KEY_DELAY   30 /* Delay, in milliseconds, between two characters being pasted from clipboard */
#define	lndebug(fmt, ...)
#define	LINENOISE_HISTORY_NEXT   0
#define	LINENOISE_HISTORY_PREV   1

Enumerations
enum	KEY_ACTION {   KEY_NULL = 0 ,   CTRL_A = 1 ,   CTRL_B = 2 ,   CTRL_C = 3 ,   CTRL_D = 4 ,   CTRL_E = 5 ,   CTRL_F = 6 ,   CTRL_H = 8 ,   TAB = 9 ,   CTRL_K = 11 ,   CTRL_L = 12 ,   ENTER = 10 ,   CTRL_N = 14 ,   CTRL_P = 16 ,   CTRL_T = 20 ,   CTRL_U = 21 ,   CTRL_W = 23 ,   ESC = 27 ,   UNIT_SEP = 31 ,   BACKSPACE = 127 }

Functions
int	linenoiseHistoryAdd (const char *line)
void	linenoiseSetMultiLine (int ml)
void	linenoiseSetDumbMode (int set)
bool	linenoiseIsDumbMode (void)
void	linenoiseSetReadFunction (linenoise_read_bytes_fn read_fn)
	__attribute__ ((weak))
void	linenoiseClearScreen (void)
void	linenoiseSetCompletionCallback (linenoiseCompletionCallback *fn)
void	linenoiseSetHintsCallback (linenoiseHintsCallback *fn)
void	linenoiseSetFreeHintsCallback (linenoiseFreeHintsCallback *fn)
void	linenoiseAddCompletion (linenoiseCompletions *lc, const char *str)
void	refreshShowHints (struct abuf *ab, struct linenoiseState *l, int plen)
int	linenoiseEditInsert (struct linenoiseState *l, char c)
int	linenoiseInsertPastedChar (struct linenoiseState *l, char c)
void	linenoiseEditMoveLeft (struct linenoiseState *l)
void	linenoiseEditMoveRight (struct linenoiseState *l)
void	linenoiseEditMoveHome (struct linenoiseState *l)
void	linenoiseEditMoveEnd (struct linenoiseState *l)
void	linenoiseEditHistoryNext (struct linenoiseState *l, int dir)
void	linenoiseEditDelete (struct linenoiseState *l)
void	linenoiseEditBackspace (struct linenoiseState *l)
void	linenoiseEditDeletePrevWord (struct linenoiseState *l)
uint32_t	getMillis (void)
void	linenoiseAllowEmpty (bool val)
int	linenoiseProbe (void)
char *	linenoise (const char *prompt)
void	linenoiseFree (void *ptr)
void	linenoiseHistoryFree (void)
int	linenoiseHistorySetMaxLen (int len)
int	linenoiseHistorySave (const char *filename)
int	linenoiseHistoryLoad (const char *filename)
int	linenoiseSetMaxLineLen (size_t len)

Macro Definition Documentation

LINENOISE_DEFAULT_HISTORY_MAX_LEN

#define LINENOISE_DEFAULT_HISTORY_MAX_LEN   100

LINENOISE_DEFAULT_MAX_LINE

#define LINENOISE_DEFAULT_MAX_LINE   4096

LINENOISE_MINIMAL_MAX_LINE

#define LINENOISE_MINIMAL_MAX_LINE   64

LINENOISE_COMMAND_MAX_LEN

#define LINENOISE_COMMAND_MAX_LEN   32

LINENOISE_PASTE_KEY_DELAY

#define LINENOISE_PASTE_KEY_DELAY   30 /* Delay, in milliseconds, between two characters being pasted from clipboard */

lndebug

#define lndebug	(		fmt,
			...
	)

LINENOISE_HISTORY_NEXT

#define LINENOISE_HISTORY_NEXT   0

LINENOISE_HISTORY_PREV

#define LINENOISE_HISTORY_PREV   1

Enumeration Type Documentation

KEY_ACTION

enum KEY_ACTION

Enumerator
KEY_NULL
CTRL_A
CTRL_B
CTRL_C
CTRL_D
CTRL_E
CTRL_F
CTRL_H
TAB
CTRL_K
CTRL_L
ENTER
CTRL_N
CTRL_P
CTRL_T
CTRL_U
CTRL_W
ESC
UNIT_SEP
BACKSPACE

Function Documentation

linenoiseHistoryAdd()

int linenoiseHistoryAdd

(

const char *

line

)

linenoiseSetMultiLine()

void linenoiseSetMultiLine

(

int

ml

)

linenoiseSetDumbMode()

void linenoiseSetDumbMode

(

int

set

)

linenoiseIsDumbMode()

bool linenoiseIsDumbMode

(

void

)

linenoiseSetReadFunction()

void linenoiseSetReadFunction

(

linenoise_read_bytes_fn

read_fn

)

__attribute__()

__attribute__

(

(weak)

)

linenoiseClearScreen()

void linenoiseClearScreen

(

void

)

linenoiseSetCompletionCallback()

void linenoiseSetCompletionCallback

(

linenoiseCompletionCallback *

fn

)

linenoiseSetHintsCallback()

void linenoiseSetHintsCallback

(

linenoiseHintsCallback *

fn

)

linenoiseSetFreeHintsCallback()

void linenoiseSetFreeHintsCallback

(

linenoiseFreeHintsCallback *

fn

)

linenoiseAddCompletion()

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

refreshShowHints()

void refreshShowHints	(	struct abuf *	ab,
		struct linenoiseState *	l,
		int	plen
	)

linenoiseEditInsert()

int linenoiseEditInsert	(	struct linenoiseState *	l,
		char	c
	)

linenoiseInsertPastedChar()

int linenoiseInsertPastedChar	(	struct linenoiseState *	l,
		char	c
	)

linenoiseEditMoveLeft()

void linenoiseEditMoveLeft

(

struct linenoiseState *

l

)

linenoiseEditMoveRight()

void linenoiseEditMoveRight

(

struct linenoiseState *

l

)

linenoiseEditMoveHome()

void linenoiseEditMoveHome

(

struct linenoiseState *

l

)

linenoiseEditMoveEnd()

void linenoiseEditMoveEnd

(

struct linenoiseState *

l

)

linenoiseEditHistoryNext()

void linenoiseEditHistoryNext	(	struct linenoiseState *	l,
		int	dir
	)

linenoiseEditDelete()

void linenoiseEditDelete

(

struct linenoiseState *

l

)

linenoiseEditBackspace()

void linenoiseEditBackspace

(

struct linenoiseState *

l

)

linenoiseEditDeletePrevWord()

void linenoiseEditDeletePrevWord

(

struct linenoiseState *

l

)

getMillis()

uint32_t getMillis

(

void

)

linenoiseAllowEmpty()

void linenoiseAllowEmpty

(

bool

val

)

linenoiseProbe()

int linenoiseProbe

(

void

)

linenoise()

char * linenoise

(

const char *

prompt

)

linenoiseFree()

void linenoiseFree

(

void *

ptr

)

linenoiseHistoryFree()

void linenoiseHistoryFree

(

void

)

linenoiseHistorySetMaxLen()

int linenoiseHistorySetMaxLen

(

int

len

)

linenoiseHistorySave()

int linenoiseHistorySave

(

const char *

filename

)

linenoiseHistoryLoad()

int linenoiseHistoryLoad

(

const char *

filename

)

linenoiseSetMaxLineLen()

int linenoiseSetMaxLineLen

(

size_t

len

)