shell.h File Reference

#include <zrtos/zrtos.h>
#include <zrtos/types.h>
#include <zrtos/str.h>

Include dependency graph for shell.h:

Go to the source code of this file.

Data Structures
struct	zrtos_shell_fn_t
struct	zrtos_shell_fd_array_t
struct	_zrtos_shell_t

Macros
#define	ZRTOS_SHELL__CFG_LINE_BUFFER_LENGTH   80
#define	ZRTOS_SHELL__CFG_MAX_ARG_COUNT   8

Typedefs
typedef struct _zrtos_shell_t	zrtos_shell_t

Enumerations
enum	zrtos_shell_fd_t {   ZRTOS_SHELL_FD__MIN = 0,   ZRTOS_SHELL_FD__STDIN = 0,   ZRTOS_SHELL_FD__STDOUT = 1,   ZRTOS_SHELL_FD__STDERR = 2,   ZRTOS_SHELL_FD__MAX = 2 }

Functions
bool	zrtos_shell__init (zrtos_shell_t *thiz, zrtos_shell_fd_array_t files, zrtos_shell_fn_t **fn, void *data)
zrtos_error_t	zrtos_shell__parse_line (zrtos_shell_t *thiz, size_t *argc, char **argv, char *line)
zrtos_error_t	zrtos_shell__execute (zrtos_shell_t *thiz, size_t argc, char **argv)
zrtos_error_t	zrtos_shell__run (zrtos_shell_t *thiz, char *line)

Macro Definition Documentation

ZRTOS_SHELL__CFG_LINE_BUFFER_LENGTH

#define ZRTOS_SHELL__CFG_LINE_BUFFER_LENGTH   80

Definition at line 19 of file shell.h.

ZRTOS_SHELL__CFG_MAX_ARG_COUNT

#define ZRTOS_SHELL__CFG_MAX_ARG_COUNT   8

Definition at line 22 of file shell.h.

Typedef Documentation

zrtos_shell_t

typedef struct _zrtos_shell_t zrtos_shell_t

Enumeration Type Documentation

zrtos_shell_fd_t

enum zrtos_shell_fd_t

Enumerator
ZRTOS_SHELL_FD__MIN
ZRTOS_SHELL_FD__STDIN
ZRTOS_SHELL_FD__STDOUT
ZRTOS_SHELL_FD__STDERR
ZRTOS_SHELL_FD__MAX

Definition at line 25 of file shell.h.

            {
     ZRTOS_SHELL_FD__MIN    = 0
    ,ZRTOS_SHELL_FD__STDIN  = 0
    ,ZRTOS_SHELL_FD__STDOUT = 1
    ,ZRTOS_SHELL_FD__STDERR = 2
    ,ZRTOS_SHELL_FD__MAX    = 2
}zrtos_shell_fd_t;

Function Documentation

zrtos_shell__execute()

zrtos_error_t zrtos_shell__execute	(	zrtos_shell_t *	thiz,
		size_t	argc,
		char **	argv
	)

Definition at line 96 of file shell.h.

 {
    zrtos_error_t ret = ZRTOS_ERROR__NOSYS;
    zrtos_shell_fn_t **fn = thiz->fn;

    for(;*fn;fn++){
        if(zrtos_str__cmp(argv[0],fn->name) == 0){
            ret = fn->callback(thiz,argc,argv);
            break;
        }
    }

    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_shell__init()

bool zrtos_shell__init	(	zrtos_shell_t *	thiz,
		zrtos_shell_fd_array_t	files,
		zrtos_shell_fn_t **	fn,
		void *	data
	)

Definition at line 51 of file shell.h.

 {
    thiz->files = files;
    thiz->fn = fn;
    thiz->data = data;

    return true;
}

zrtos_shell__parse_line()

zrtos_error_t zrtos_shell__parse_line	(	zrtos_shell_t *	thiz,
		size_t *	argc,
		char **	argv,
		char *	line
	)

Definition at line 64 of file shell.h.

 {
    zrtos_error_t ret = ZRTOS_ERROR__SUCCESS;
    size_t pos = 0;
    char *arg;
    size_t offset;

    line += zrtos_str__spn(line," \t\r\n");
    offset = zrtos_str__cspn(line,"\r\n");
    if(offset){
        line[offset] = 0;
        while((arg = zrtos_str__tok_r(line," \t", &line))){
            if(pos < ZRTOS_SHELL__CFG_MAX_ARG_COUNT){
                argv[pos++] = arg;
                continue;
            }else{
                ret = ZRTOS_ERROR__2BIG;
                break;
            }
        }
        *argc = pos;
    }else{
        *argc = 0;
    }

    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_shell__run()

zrtos_error_t zrtos_shell__run	(	zrtos_shell_t *	thiz,
		char *	line
	)

Definition at line 114 of file shell.h.

 {
    size_t argc;
    char *argv[ZRTOS_SHELL__CFG_MAX_ARG_COUNT];
    zrtos_error_t ret = zrtos_shell__parse_line(
         thiz
        ,&argc
        ,argv
        ,line
    );
    if(zrtos_error__is_success(ret)
    && argc > 0){
        ret = zrtos_shell__execute(thiz,argc,argv);
    }

    return ret;
}

Here is the call graph for this function: