shell

Documentation

Index

• Variables
• func Critical(err string)
• func Warning(warn string)
• type CommandFunction
• type Shell
  • func New() *Shell
  • func (s *Shell) AddHistory(cmd string)
  • func (s *Shell) Alias(args []string)
  • func (s *Shell) Cd(args []string)
  • func (s *Shell) EnsurePaths()
  • func (s *Shell) Exit(args []string)
  • func (s *Shell) Export(args []string)
  • func (s *Shell) Getwd()
  • func (s *Shell) Help(args []string)
  • func (s *Shell) InitBuiltins()
  • func (s *Shell) InitPath()
  • func (s *Shell) RegisterCommand(key string, value func([]string)) *Shell
  • func (s *Shell) StartRepl()

Variables

var (
	Aliases       map[string]string
	DefaultPrompt string
)

Functions

func Critical

func Critical(err string)

func Warning

func Warning(warn string)

Types

type CommandFunction

type CommandFunction func([]string)

Type for built-in commands.

type Shell

type Shell struct {
	HistoryPath     string
	RcPath          string
	PathFiles       []string
	BuiltinCommands map[string]CommandFunction
	WdFiles         []string
	ExitCode        int
}

func New

func New() *Shell

Creates a new shell and returns a pointer.

func (*Shell) AddHistory

func (s *Shell) AddHistory(cmd string)

func (*Shell) Alias

func (s *Shell) Alias(args []string)

func (*Shell) Cd

func (s *Shell) Cd(args []string)

func (*Shell) EnsurePaths

func (s *Shell) EnsurePaths()

Creates if the history and .midorirc file does not exist.

func (*Shell) Exit

func (s *Shell) Exit(args []string)

func (*Shell) Export

func (s *Shell) Export(args []string)

func (*Shell) Getwd

func (s *Shell) Getwd()

Retrieves the directory where the shell is currently running. It then takes the files inside and puts them in s.WdFiles.

func (*Shell) Help

func (s *Shell) Help(args []string)

func (*Shell) InitBuiltins

func (s *Shell) InitBuiltins()

func (*Shell) InitPath

func (s *Shell) InitPath()

Save files to RAM to prevent Shell from reading the whole PATH variable on EVERY CHARACTER RECEIVED.

func (*Shell) RegisterCommand

func (s *Shell) RegisterCommand(key string, value func([]string)) *Shell

func (*Shell) StartRepl

func (s *Shell) StartRepl()

Starts read - evaluate - print - loop After this function is called, the control of the entire runtime is in this function.