unix_cli_file_t Struct Reference

Unix CLI session. More...

Collaboration diagram for unix_cli_file_t:

Data Fields
u32	unix_file_index
	The file index held by unix.c. More...
u8 *	output_vector
	Vector of output pending write to file descriptor. More...
u8 *	input_vector
	Vector of input saved by Unix input node to be processed by CLI process. More...
u8	has_history
	This session has command history. More...
u8 **	command_history
	Array of vectors of commands in the history. More...
u8 *	current_command
	The command currently pointed at by the history cursor. More...
i32	excursion
	How far from the end of the history array the user has browsed. More...
u32	history_limit
	Maximum number of history entries this session will store. More...
u32	command_number
	Current command line counter. More...
u8 *	search_key
	The string being searched for in the history. More...
int	search_mode
	If non-zero then the CLI is searching in the history array. More...
u32	cursor
	Position of the insert cursor on the current input line. More...
u8	line_mode
	Line mode or char mode. More...
u8	crlf_mode
	Set if the CRLF mode wants CR + LF. More...
u8	ansi_capable
	Can we do ANSI output? More...
u8	started
	Has the session started? More...
u8	no_pager
	Disable the pager? More...
u8 **	pager_vector
	Pager buffer. More...
unix_cli_pager_index_t *	pager_index
	Index of line fragments in the pager buffer. More...
u32	pager_start
	Line number of top of page. More...
u32	width
	Terminal width. More...
u32	height
	Terminal height. More...
u32	process_node_index
	Process node identifier. More...

Detailed Description

Unix CLI session.

Definition at line 138 of file cli.c.

Field Documentation

u8 unix_cli_file_t::ansi_capable

Can we do ANSI output?

Definition at line 183 of file cli.c.

u8** unix_cli_file_t::command_history

Array of vectors of commands in the history.

Definition at line 153 of file cli.c.

u32 unix_cli_file_t::command_number

Current command line counter.

Definition at line 163 of file cli.c.

u8 unix_cli_file_t::crlf_mode

Set if the CRLF mode wants CR + LF.

Definition at line 180 of file cli.c.

u8* unix_cli_file_t::current_command

The command currently pointed at by the history cursor.

Definition at line 155 of file cli.c.

u32 unix_cli_file_t::cursor

Position of the insert cursor on the current input line.

Definition at line 174 of file cli.c.

i32 unix_cli_file_t::excursion

How far from the end of the history array the user has browsed.

Definition at line 157 of file cli.c.

u8 unix_cli_file_t::has_history

This session has command history.

Definition at line 151 of file cli.c.

u32 unix_cli_file_t::height

Terminal height.

Definition at line 204 of file cli.c.

u32 unix_cli_file_t::history_limit

Maximum number of history entries this session will store.

Definition at line 160 of file cli.c.

u8* unix_cli_file_t::input_vector

Vector of input saved by Unix input node to be processed by CLI process.

Definition at line 148 of file cli.c.

u8 unix_cli_file_t::line_mode

Line mode or char mode.

Definition at line 177 of file cli.c.

u8 unix_cli_file_t::no_pager

Disable the pager?

Definition at line 189 of file cli.c.

u8* unix_cli_file_t::output_vector

Vector of output pending write to file descriptor.

Definition at line 144 of file cli.c.

unix_cli_pager_index_t* unix_cli_file_t::pager_index

Index of line fragments in the pager buffer.

Definition at line 195 of file cli.c.

u32 unix_cli_file_t::pager_start

Line number of top of page.

Definition at line 198 of file cli.c.

u8** unix_cli_file_t::pager_vector

Pager buffer.

Definition at line 192 of file cli.c.

u32 unix_cli_file_t::process_node_index

Process node identifier.

Definition at line 207 of file cli.c.

u8* unix_cli_file_t::search_key

The string being searched for in the history.

Definition at line 166 of file cli.c.

int unix_cli_file_t::search_mode

If non-zero then the CLI is searching in the history array.

• -1 means search backwards.
• 1 means search forwards.

Definition at line 171 of file cli.c.

u8 unix_cli_file_t::started

Has the session started?

Definition at line 186 of file cli.c.

u32 unix_cli_file_t::unix_file_index

The file index held by unix.c.

Definition at line 141 of file cli.c.

u32 unix_cli_file_t::width

Terminal width.

Definition at line 201 of file cli.c.

---

The documentation for this struct was generated from the following file:

• vlib/vlib/unix/cli.c