Shell

Australis shell interface for user interaction with the system via terminal command line. More...

Data Structures
struct	ShellProgramHandle_t
	Struct definition for shell program handle. More...

Functions
void	vShellProcess (void *argument)
bool	Shell_run (char *programName)
	Executes a shell program by name.
bool	Shell_sigint ()
	Exit any running task and clear to new line.

Detailed Description

Australis shell interface for user interaction with the system via terminal command line.

---

Data Structure Documentation

ShellProgramHandle_t

struct ShellProgramHandle_t

Struct definition for shell program handle.

Provides the interface for shell programs.

All handles must have a name (case-sensitive) that represents the program as it will be called from the shell interface.

Additionally, the handle must initialise the exec function pointer. This defines the program's entry point and is called by the shell.

Definition at line 60 of file shell.h.

Data Fields
char	name[SHELL_PROGRAM_NAME_LENGTH]	Program name as referenced by the shell.
void(*)(UART_t *, char *)	exec	Program entry point function pointer.
void(*)(UART_t *)	help	Program help-string print function.

Function Documentation

vShellProcess()

void vShellProcess

(

void *

argument

)

Parameters

argument

Pointer to the task parameters .

Returns

void

---

Definition at line 64 of file shell.c.

Shell_run()

bool Shell_run

(

char *

programName

)

Executes a shell program by name.

Parses the program name and flags, then finds and runs the corresponding shell program.

Parameters

shell	Pointer to the Shell structure containing registered programs.
programName	Name of the program to execute, with optional flags.

Returns

void

---

Definition at line 167 of file shell.c.

Shell_sigint()

bool Shell_sigint

(

)

Exit any running task and clear to new line.

---

Definition at line 206 of file shell.c.