Console

Documentation

Index

• Constants
• type CommandInfo
  • func MakeHelpCommand(console *Console) (*CommandInfo, error)
  • func NewCommandInfo(name string, description []string, fn ConsoleFunc, args ...*Flag) *CommandInfo
  • func (inf *CommandInfo) FString(trav *fsp.Traversor) error
  • func (inf *CommandInfo) GetName() string
  • func (inf *CommandInfo) ParseArgs(args []string) (map[string]any, error)
• type Console
  • func NewConsole(name string) *Console
  • func (c *Console) AddCommand(info *CommandInfo)
  • func (c *Console) ParseArgs(args []string) (*ParsedCommand, error)
• type ConsoleFunc
• type ErrArgumentNotRecognized
  • func NewErrArgumentNotRecognized(value string) *ErrArgumentNotRecognized
  • func (e *ErrArgumentNotRecognized) Error() string
• type ErrMissingArgument
  • func NewErrMissingArgument(name string) *ErrMissingArgument
  • func (e *ErrMissingArgument) Error() string
• type Flag
  • func NewFlag(name string, parsingFunc FlagParsingFunc) *Flag
  • func (f *Flag) FString(trav *ffs.Traversor) error
  • func (f *Flag) String() string
• type FlagParsingFunc
• type ParsedCommand
  • func NewParsedCommand(command string, flagMap map[string]any, fn ConsoleFunc) *ParsedCommand
  • func (pc *ParsedCommand) Execute() (any, error)
  • func (pc *ParsedCommand) GetCommand() string

Constants

const (
	// HelpOpcode is the opcode for the help command.
	HelpOpcode string = "help"
)

Types

type CommandInfo

type CommandInfo struct {
	// contains filtered or unexported fields
}

CommandInfo represents a console command.

func MakeHelpCommand

func MakeHelpCommand(console *Console) (*CommandInfo, error)

MakeHelpCommand is a function that creates a help command for a console.

The help command, when run, returns as the first value a slice of []*ContentBox.MultilineText representing the list of available commands according to FString formatting.

Parameters:

• flagMap: A map of string keys to any values representing the arguments passed to the command.

Returns:

• *CommandInfo: The help command.
• error: An error of type *Errors.ErrInvalidParameter if the console is nil.

func NewCommandInfo

func NewCommandInfo(name string, description []string, fn ConsoleFunc, args ...*Flag) *CommandInfo

NewCommandInfo is a function that creates a new command info.

Parameters:

• name: The name of the command.
• description: The description of the command.
• fn: The function to call when the command is executed.
• args: A slice of Flag representing the arguments accepted by the command.

Returns:

• *CommandInfo: The new command info.

func (*CommandInfo) FString

func (inf *CommandInfo) FString(trav *fsp.Traversor) error

FString generates a formatted string representation of a CommandInfo.

Format:

<description>

Arguments: <arg 1> <arg 2> ...

or:

<description>

Arguments: [No arguments available]

Parameters:

• trav: The traversor to use for the CommandInfo.

Returns:

• error: An error if the printing fails.

Behaviors:

• <description> is printed according to the DocumentPrinter.
• If trav is nil, the function will do nothing.

func (*CommandInfo) GetName

func (inf *CommandInfo) GetName() string

GetName returns the name of the command.

Returns:

• string: The name of the command.

func (*CommandInfo) ParseArgs

func (inf *CommandInfo) ParseArgs(args []string) (map[string]any, error)

ParseArgs is a function that parses the arguments for a command.

Parameters:

• args: A slice of strings representing the arguments passed to the command.

Returns:

• map[string]any: A map of string keys to any values representing the arguments parsed by the command.
• error: An error if the command fails.

Errors:

• *ErrMissingArgument: If an argument is missing.
• *ErrArgumentNotRecognized: If an argument is not recognized.

type Console

type Console struct {
	// contains filtered or unexported fields
}

CommandInfo represents a console command.

func NewConsole

func NewConsole(name string) *Console

NewConsole is a function that creates a new console.

Parameters:

• name: The name of the console.

Returns:

• *Console: The new console.

func (*Console) AddCommand

func (c *Console) AddCommand(info *CommandInfo)

AddCommand adds a command to the console.

Parameters:

• info: The information about the command.

func (*Console) ParseArgs

func (c *Console) ParseArgs(args []string) (*ParsedCommand, error)

ParseArgs parses the arguments for a command.

Parameters:

• args: A slice of strings representing the arguments passed to the command.

Returns:

• *ParsedCommand: The parsed command.
• error: An error if the command fails.

type ConsoleFunc

type ConsoleFunc func(flagMap map[string]any) (any, error)

ConsoleFunc is a function type that represents a callback function for a console command.

Parameters:

• flagMap: A map of string keys to any values representing the arguments passed to the command.

Returns:

• any: The result of the command. (if any)
• error: An error if the command fails.

type ErrArgumentNotRecognized

type ErrArgumentNotRecognized struct {
	// Value is the value of the unrecognized argument.
	Value string
}

ErrArgumentNotRecognized is an error that is returned when an argument is not recognized.

func NewErrArgumentNotRecognized

func NewErrArgumentNotRecognized(value string) *ErrArgumentNotRecognized

NewErrArgumentNotRecognized creates a new ErrArgumentNotRecognized.

Parameters:

• value: The value of the unrecognized argument.

Returns:

• *ErrArgumentNotRecognized: The new ErrArgumentNotRecognized.

func (*ErrArgumentNotRecognized) Error

func (e *ErrArgumentNotRecognized) Error() string

Error returns the error message: "argument <value> is not recognized".

Returns:

• string: The error message.

type ErrMissingArgument

type ErrMissingArgument struct {
	// Name is the name of the missing argument.
	Name string
}

ErrMissingArgument is an error that is returned when a required argument is missing.

func NewErrMissingArgument

func NewErrMissingArgument(name string) *ErrMissingArgument

NewErrMissingArgument creates a new ErrMissingArgument.

Parameters:

• name: The name of the missing argument.

Returns:

• *ErrMissingArgument: The new ErrMissingArgument.

func (*ErrMissingArgument) Error

func (e *ErrMissingArgument) Error() string

Error returns the error message: "argument <name> is required".

Returns:

• string: The error message.

type Flag

type Flag struct {
	// contains filtered or unexported fields
}

Flag represents a flag for a command.

func NewFlag

func NewFlag(name string, parsingFunc FlagParsingFunc) *Flag

NewFlag creates a new flag with the specified name and parsing function.

Parameters:

• name: The name of the flag.
• parsingFunc: The function used to parse the flag.

Returns:

• *Flag: The new flag.

Behaviors:

• If the parsing function is nil, the flag uses the default parsing function, which returns the string as is.

func (*Flag) FString

func (f *Flag) FString(trav *ffs.Traversor) error

FString implements the FStringer interface.

func (*Flag) String

func (f *Flag) String() string

String implements the fmt.Stringer interface.

type FlagParsingFunc

type FlagParsingFunc func(str string) (any, error)

FlagParsingFunc is a function that parses a string into a value.

Parameters:

• str: The string to parse.

Returns:

• any: The parsed value.
• error: An error if the parsing fails.

type ParsedCommand

type ParsedCommand struct {
	// contains filtered or unexported fields
}

ParsedCommand represents a parsed command.

func NewParsedCommand

func NewParsedCommand(command string, flagMap map[string]any, fn ConsoleFunc) *ParsedCommand

NewParsedCommand creates a new ParsedCommand.

Parameters:

• command: The name of the command.
• flagMap: A map of flags and their values.
• fn: The function to execute.

Returns:

• *ParsedCommand: The new ParsedCommand.

func (*ParsedCommand) Execute

func (pc *ParsedCommand) Execute() (any, error)

Execute executes the command with the given flags.

Returns:

• error: An error if the command failed to execute.

func (*ParsedCommand) GetCommand

func (pc *ParsedCommand) GetCommand() string

GetCommand returns the name of the command.

Returns:

• string: The name of the command.