openMSX
Public Member Functions | List of all members
openmsx::HDCommand Class Referencefinal

#include <HDCommand.hh>

Inheritance diagram for openmsx::HDCommand:
Inheritance graph
[legend]
Collaboration diagram for openmsx::HDCommand:
Collaboration graph
[legend]

Public Member Functions

 HDCommand (CommandController &commandController, StateChangeDistributor &stateChangeDistributor, Scheduler &scheduler, HD &hd, BooleanSetting &powerSetting)
 
void execute (std::span< const TclObject > tokens, TclObject &result, EmuTime::param time) override
 This is like the execute() method of the Command class, it only has an extra time parameter.
 
std::string help (std::span< const TclObject > tokens) const override
 Print help for this command.
 
void tabCompletion (std::vector< std::string > &tokens) const override
 Attempt tab completion for this command.
 
bool needRecord (std::span< const TclObject > tokens) const override
 It's possible that in some cases the command doesn't need to be recorded after all (e.g.
 
- Public Member Functions inherited from openmsx::Command
void setAllowedInEmptyMachine (bool value)
 
bool isAllowedInEmptyMachine () const
 
void setToken (void *token_)
 
void * getToken () const
 
template<typename... Args>
void executeSubCommand (std::string_view subCmd, Args &&... args)
 
- Public Member Functions inherited from openmsx::CommandCompleter
 CommandCompleter (const CommandCompleter &)=delete
 
CommandCompleteroperator= (const CommandCompleter &)=delete
 
CommandControllergetCommandController () const
 
InterpretergetInterpreter () const final
 
- Public Member Functions inherited from openmsx::Completer
 Completer (const Completer &)=delete
 
Completeroperator= (const Completer &)=delete
 
const std::string & getName () const
 
void checkNumArgs (std::span< const TclObject > tokens, unsigned exactly, const char *errMessage) const
 
void checkNumArgs (std::span< const TclObject > tokens, AtLeast atLeast, const char *errMessage) const
 
void checkNumArgs (std::span< const TclObject > tokens, Between between, const char *errMessage) const
 
void checkNumArgs (std::span< const TclObject > tokens, unsigned exactly, Prefix prefix, const char *errMessage) const
 
void checkNumArgs (std::span< const TclObject > tokens, AtLeast atLeast, Prefix prefix, const char *errMessage) const
 
void checkNumArgs (std::span< const TclObject > tokens, Between between, Prefix prefix, const char *errMessage) const
 
template<typename ITER >
NEVER_INLINE std::vector< std::string_view > filter (std::string_view str, ITER begin, ITER end, bool caseSensitive)
 

Additional Inherited Members

- Static Public Member Functions inherited from openmsx::Completer
template<typename ITER >
static void completeString (std::vector< std::string > &tokens, ITER begin, ITER end, bool caseSensitive=true)
 
template<typename RANGE >
static void completeString (std::vector< std::string > &tokens, RANGE &&possibleValues, bool caseSensitive=true)
 
template<typename RANGE >
static void completeFileName (std::vector< std::string > &tokens, const FileContext &context, const RANGE &extra)
 
static void completeFileName (std::vector< std::string > &tokens, const FileContext &context)
 
static std::vector< std::string > formatListInColumns (std::span< const std::string_view > input)
 
static void setOutput (InterpreterOutput *output_)
 
- Protected Member Functions inherited from openmsx::RecordedCommand
 RecordedCommand (CommandController &commandController, StateChangeDistributor &stateChangeDistributor, Scheduler &scheduler, std::string_view name)
 
 ~RecordedCommand ()
 
- Protected Member Functions inherited from openmsx::Command
 Command (CommandController &controller, std::string_view name)
 
 ~Command ()
 
- Protected Member Functions inherited from openmsx::CommandCompleter
 CommandCompleter (CommandController &controller, std::string_view name)
 
 ~CommandCompleter ()
 
GlobalCommandControllergetGlobalCommandController () const
 
CliCommgetCliComm () const
 
- Protected Member Functions inherited from openmsx::Completer
template<typename String >
 Completer (String &&name_)
 
 ~Completer ()=default
 

Detailed Description

Definition at line 17 of file HDCommand.hh.

Constructor & Destructor Documentation

◆ HDCommand()

openmsx::HDCommand::HDCommand ( CommandController commandController,
StateChangeDistributor stateChangeDistributor,
Scheduler scheduler,
HD hd,
BooleanSetting powerSetting 
)

Definition at line 14 of file HDCommand.cc.

Member Function Documentation

◆ execute()

void openmsx::HDCommand::execute ( std::span< const TclObject tokens,
TclObject result,
EmuTime::param  time 
)
overridevirtual

◆ help()

std::string openmsx::HDCommand::help ( std::span< const TclObject tokens) const
overridevirtual

Print help for this command.

Implements openmsx::Completer.

Definition at line 68 of file HDCommand.cc.

References openmsx::HD::getName().

◆ needRecord()

bool openmsx::HDCommand::needRecord ( std::span< const TclObject tokens) const
overridevirtual

It's possible that in some cases the command doesn't need to be recorded after all (e.g.

a query subcommand). In that case you can override this method. Return false iff the command doesn't need to be recorded.

Reimplemented from openmsx::RecordedCommand.

Definition at line 82 of file HDCommand.cc.

◆ tabCompletion()

void openmsx::HDCommand::tabCompletion ( std::vector< std::string > &  tokens) const
overridevirtual

Attempt tab completion for this command.

Default implementation does nothing.

Parameters
tokensTokenized command line; tokens[0] is the command itself. The last token is incomplete, this method tries to complete it.

Reimplemented from openmsx::Command.

Definition at line 73 of file HDCommand.cc.

References openmsx::Completer::completeFileName(), and openmsx::userFileContext().


The documentation for this class was generated from the following files: