Shell

Simple shell interpreter. More...

Detailed Description

Simple shell interpreter.

Files
file	shell.h
	Shell interface definition.

Data Structures
struct	shell_command_t
	A single command in the list of the supported commands. More...

Macros
#define	SHELL_DEFAULT_BUFSIZE   (128)
	Default shell buffer size (maximum line length shell can handle)

Typedefs
typedef int(*	shell_command_handler_t) (int argc, char **argv)
	Protype of a shell callback handler. More...
typedef struct shell_command_t	shell_command_t
	A single command in the list of the supported commands. More...

Functions
void	shell_run (const shell_command_t *commands, char *line_buf, int len) NORETURN
	Start a shell. More...

Typedef Documentation

shell_command_handler_t

typedef int(* shell_command_handler_t) (int argc, char **argv)

Protype of a shell callback handler.

The functions supplied to shell_run() must use this signature. The argument list is terminated with a NULL, i.e argv[argc] == NULL`. argv[0]`` is the function name.

Escape sequences are removed before the function is called.

The called function may edit argv and the contained strings, but it must be taken care of not to leave the boundaries of the array. This functionality can be used by getopt() or a similar function.

Parameters

[in]	argc	Number of arguments supplied to the function invocation.
[in]	argv	The supplied argument list.

Returns

0 on success

Anything else on failure

Definition at line 53 of file shell.h.

shell_command_t

typedef struct shell_command_t shell_command_t

A single command in the list of the supported commands.

The list of commands is NULL terminated, i.e. the last element must be { NULL, NULL, NULL }.

Function Documentation

shell_run()

void shell_run	(	const shell_command_t *	commands,
		char *	line_buf,
		int	len
	)

Start a shell.

Parameters

[in]	commands	ptr to array of command structs
[in]	line_buf	Buffer that will be used for reading a line
[in]	len	nr of bytes that fit in line_buf

Returns

This function does not return.