semf
semf::esh::Shell::Config Struct Reference

Configuarion parameters of the shell. More...

#include <shell.h>

Collaboration diagram for semf::esh::Shell::Config:
Collaboration graph

Public Attributes

char *const lineBuffer
 
const size_t lineBufferSize
 
char **const argvBuffer
 
const size_t argvBufferSize
 
char * historyBuffer
 
const size_t numberOfEntries
 
bool echo
 
std::string_view prompt
 

Detailed Description

Configuarion parameters of the shell.

Definition at line 39 of file shell.h.

Member Data Documentation

◆ argvBuffer

char** const semf::esh::Shell::Config::argvBuffer

argv buffer. Upper bound is lineBufferSize / 2. Lower bound is 1.

Definition at line 46 of file shell.h.

◆ argvBufferSize

const size_t semf::esh::Shell::Config::argvBufferSize

Length of argvBuffer .

Definition at line 48 of file shell.h.

◆ echo

bool semf::esh::Shell::Config::echo

Enables shell echoing.

Definition at line 54 of file shell.h.

◆ historyBuffer

char* semf::esh::Shell::Config::historyBuffer

Buffer for storing the history. Its size should be numberOfEntries * lineBufferSize .

Definition at line 50 of file shell.h.

◆ lineBuffer

char* const semf::esh::Shell::Config::lineBuffer

Buffer for the command line. Its size indicates the max length of a command.

Definition at line 42 of file shell.h.

◆ lineBufferSize

const size_t semf::esh::Shell::Config::lineBufferSize

Size of lineBuffer .

Definition at line 44 of file shell.h.

◆ numberOfEntries

const size_t semf::esh::Shell::Config::numberOfEntries

Number of history entries.

Definition at line 52 of file shell.h.

◆ prompt

std::string_view semf::esh::Shell::Config::prompt

Prompt string, i.e. "> ".

Definition at line 56 of file shell.h.