shell.c File Reference

Minimal command shell. More...

#include <stdint.h>
#include <stdlib.h>
#include <stdio.h>
#include <readline/readline.h>
#include <gpxe/command.h>
#include <gpxe/shell.h>

Go to the source code of this file.

Functions
	FILE_LICENCE (GPL2_OR_LATER)
static int	exit_exec (int argc, char **argv __unused)
	"exit" command body
static int	help_exec (int argc __unused, char **argv __unused)
	"help" command body
void	shell (void)
	Start command shell.
Variables
static const char	shell_prompt [] = "gPXE> "
	The shell prompt string.
static int	exit_flag = 0
	Flag set in order to exit shell.
struct command exit_command	__command
	"exit" command definition

---

Detailed Description

Minimal command shell.

Definition in file shell.c.

---

Function Documentation

FILE_LICENCE

(

GPL2_OR_LATER

)

static int exit_exec	(	int	argc,
		char **argv	__unused
	)			[static]

"exit" command body

Definition at line 41 of file shell.c.

References exit_flag, and printf().

                                                        {

        if ( argc == 1 ) {
                exit_flag = 1;
        } else {
                printf ( "Usage: exit\n"
                         "Exits the command shell\n" );
        }

        return 0;
}

static int help_exec	(	int argc	__unused,
		char **argv	__unused
	)			[static]

"help" command body

Definition at line 60 of file shell.c.

References COMMANDS, for_each_table_entry, command::name, and printf().

                                                                 {
        struct command *command;
        unsigned int hpos = 0;

        printf ( "\nAvailable commands:\n\n" );
        for_each_table_entry ( command, COMMANDS ) {
                hpos += printf ( "  %s", command->name );
                if ( hpos > ( 16 * 4 ) ) {
                        printf ( "\n" );
                        hpos = 0;
                } else {
                        while ( hpos % 16 ) {
                                printf ( " " );
                                hpos++;
                        }
                }
        }
        printf ( "\n\nType \"<command> --help\" for further information\n\n" );
        return 0;
}

void shell

(

void

)

Start command shell.

Definition at line 91 of file shell.c.

References exit_flag, free(), readline(), shell_prompt, and system().

Referenced by main().

                    {
        char *line;

        exit_flag = 0;
        while ( ! exit_flag ) {
                line = readline ( shell_prompt );
                if ( line ) {
                        system ( line );
                        free ( line );
                }
        }
}

---

Variable Documentation

const char shell_prompt[] = "gPXE> " [static]

The shell prompt string.

Definition at line 35 of file shell.c.

Referenced by shell().

int exit_flag = 0 [static]

Flag set in order to exit shell.

Definition at line 38 of file shell.c.

Referenced by exit_exec(), and shell().

struct command help_command __command [read]

Initial value:

 {
        .name = "exit",
        .exec = exit_exec,
}

"exit" command definition

"help" command definition

Definition at line 54 of file shell.c.