Unix CLI session.
More...
Unix CLI session.
Definition at line 148 of file cli.c.
◆ ansi_capable
u8 unix_cli_file_t::ansi_capable |
Can we do ANSI output?
Definition at line 193 of file cli.c.
◆ clib_file_index
u32 unix_cli_file_t::clib_file_index |
The file index held by unix.c.
Definition at line 151 of file cli.c.
◆ command_history
u8** unix_cli_file_t::command_history |
Array of vectors of commands in the history.
Definition at line 163 of file cli.c.
◆ command_number
u32 unix_cli_file_t::command_number |
Current command line counter.
Definition at line 173 of file cli.c.
◆ crlf_mode
u8 unix_cli_file_t::crlf_mode |
Set if the CRLF mode wants CR + LF.
Definition at line 190 of file cli.c.
◆ current_command
u8* unix_cli_file_t::current_command |
The command currently pointed at by the history cursor.
Definition at line 165 of file cli.c.
◆ cursor
u32 unix_cli_file_t::cursor |
Position of the insert cursor on the current input line.
Definition at line 184 of file cli.c.
◆ cursor_direction
u8 unix_cli_file_t::cursor_direction |
The current direction of cursor travel.
This is important since when advancing left-to-right, at the right hand edge of the console the terminal typically defers wrapping the cursor to the next line until a character is actually displayed. This messes up our heuristic for whether to use ANSI to return the cursor to the end of the line and instead we have to nudge the cursor to the next line. A Value of 0
means we're advancing left-to-right; 1
means the opposite.
Definition at line 242 of file cli.c.
◆ excursion
i32 unix_cli_file_t::excursion |
How far from the end of the history array the user has browsed.
Definition at line 167 of file cli.c.
◆ has_epipe
u8 unix_cli_file_t::has_epipe |
If EPIPE has been detected, prevent further write-related activity on the descriptor.
Definition at line 211 of file cli.c.
◆ has_history
u8 unix_cli_file_t::has_history |
This session has command history.
Definition at line 161 of file cli.c.
◆ height
u32 unix_cli_file_t::height |
Terminal height.
Definition at line 226 of file cli.c.
◆ history_limit
u32 unix_cli_file_t::history_limit |
Maximum number of history entries this session will store.
Definition at line 170 of file cli.c.
◆ input_vector
u8* unix_cli_file_t::input_vector |
Vector of input saved by Unix input node to be processed by CLI process.
Definition at line 158 of file cli.c.
◆ is_interactive
u8 unix_cli_file_t::is_interactive |
Whether the session is interactive or not.
Controls things like initial banner, the CLI prompt etc.
Definition at line 203 of file cli.c.
◆ is_socket
u8 unix_cli_file_t::is_socket |
Whether the session is attached to a socket.
Definition at line 206 of file cli.c.
◆ line_mode
u8 unix_cli_file_t::line_mode |
Line mode or char mode.
Definition at line 187 of file cli.c.
◆ no_pager
u8 unix_cli_file_t::no_pager |
Disable the pager?
Definition at line 199 of file cli.c.
◆ output_vector
u8* unix_cli_file_t::output_vector |
Vector of output pending write to file descriptor.
Definition at line 154 of file cli.c.
◆ pager_index
Index of line fragments in the pager buffer.
Definition at line 217 of file cli.c.
◆ pager_start
u32 unix_cli_file_t::pager_start |
Line number of top of page.
Definition at line 220 of file cli.c.
◆ pager_vector
u8** unix_cli_file_t::pager_vector |
Pager buffer.
Definition at line 214 of file cli.c.
◆ process_node_index
u32 unix_cli_file_t::process_node_index |
Process node identifier.
Definition at line 229 of file cli.c.
◆ search_key
u8* unix_cli_file_t::search_key |
The string being searched for in the history.
Definition at line 176 of file cli.c.
◆ search_mode
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 181 of file cli.c.
◆ started
u8 unix_cli_file_t::started |
Has the session started?
Definition at line 196 of file cli.c.
◆ width
u32 unix_cli_file_t::width |
Terminal width.
Definition at line 223 of file cli.c.
The documentation for this struct was generated from the following file: