cli.h File Reference

#include "cli_config.h"

Include dependency graph for cli.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	msh_command_entry

Macros
#define	msh_command_end    { 0, 0, 0, 0 }
#define	msh_declare_command(name)
#define	msh_define_help(name, desc, usage)
#define	msh_define_command(name)    { #name, cmd_##name, cmd_##name##_desc, cmd_##name##_usage }

Typedefs
typedef struct msh_command_entry	msh_command_entry

Functions
void	msh_set_prompt (char *str)
int	msh_get_cmdline (char *cmdline)
const char *	msh_parse_line (const char *cmdline, char *argvbuf, int *pargc, char **pargv)
int	msh_do_command (const msh_command_entry *cmdp, int argc, const char **argv)
void	msh_print_cmdlist (const msh_command_entry *cmdlist)
const char *	msh_get_command_usage (const msh_command_entry *cmdlist, const char *cmdname)

Variables
const msh_command_entry	msh_builtin_commands []
const msh_command_entry *	msh_user_commands

Macro Definition Documentation

msh_command_end

#define msh_command_end    { 0, 0, 0, 0 }

msh_declare_command

#define msh_declare_command

(

name

)

Value:

    int cmd_##name(int argc, const char **argv); \
    extern const char cmd_##name##_desc[];       \
    extern const char cmd_##name##_usage[];

msh_define_command

#define msh_define_command

(

name

)

{ #name, cmd_##name, cmd_##name##_desc, cmd_##name##_usage }

msh_define_help

#define msh_define_help	(		name,
			desc,
			usage
	)

Value:

    const char cmd_##name##_desc[] = desc; \
    const char cmd_##name##_usage[] = usage;

Typedef Documentation

msh_command_entry

typedef struct msh_command_entry msh_command_entry

Function Documentation

msh_do_command()

int msh_do_command	(	const msh_command_entry *	cmdp,
		int	argc,
		const char **	argv
	)

msh_get_cmdline()

int msh_get_cmdline

(

char *

cmdline

)

msh_get_command_usage()

const char * msh_get_command_usage	(	const msh_command_entry *	cmdlist,
		const char *	cmdname
	)

msh_parse_line()

const char * msh_parse_line	(	const char *	cmdline,
		char *	argvbuf,
		int *	pargc,
		char **	pargv
	)

msh_print_cmdlist()

void msh_print_cmdlist

(

const msh_command_entry *

cmdlist

)

msh_set_prompt()

void msh_set_prompt

(

char *

str

)

Variable Documentation

msh_builtin_commands

const msh_command_entry msh_builtin_commands[]

extern

msh_user_commands

const msh_command_entry* msh_user_commands

extern