openMSX
Public Member Functions | Friends | List of all members
openmsx::GlobalCommandController Class Reference

#include <GlobalCommandController.hh>

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

Public Member Functions

 GlobalCommandController (EventDistributor &eventDistributor, GlobalCliComm &cliComm, Reactor &reactor)
 ~GlobalCommandController ()
InfoCommand & getOpenMSXInfoCommand ()
void source (const std::string &script)
 Executes all defined auto commands.
void registerProxyCommand (const std::string &name)
void unregisterProxyCommand (string_ref name)
void registerProxySetting (Setting &setting)
void unregisterProxySetting (Setting &setting)
void changeSetting (const std::string &name, const std::string &value)
virtual void registerCompleter (CommandCompleter &completer, string_ref str)
virtual void unregisterCompleter (CommandCompleter &completer, string_ref str)
virtual void registerCommand (Command &command, const std::string &str)
virtual void unregisterCommand (Command &command, string_ref str)
virtual bool hasCommand (string_ref command) const
virtual std::string executeCommand (const std::string &command, CliConnection *connection=nullptr)
virtual std::string tabCompletion (string_ref command)
 Complete the given command.
virtual bool isComplete (const std::string &command)
 Returns true iff the command is complete (all braces, quotes etc.
virtual std::vector< std::string > splitList (const std::string &list)
virtual void registerSetting (Setting &setting)
virtual void unregisterSetting (Setting &setting)
virtual Setting * findSetting (string_ref name)
virtual void changeSetting (Setting &setting, const std::string &value)
virtual CliComm & getCliComm ()
virtual Interpreter & getInterpreter ()
virtual SettingsConfig & getSettingsConfig ()
virtual CliConnection * getConnection () const
- Public Member Functions inherited from openmsx::CommandController
virtual void registerCompleter (CommandCompleter &completer, string_ref str)=0
 (Un)register a command completer, used to complete build-in Tcl cmds
virtual void unregisterCompleter (CommandCompleter &completer, string_ref str)=0
virtual void registerCommand (Command &command, const std::string &str)=0
 (Un)register a command
virtual void unregisterCommand (Command &command, string_ref str)=0
virtual bool hasCommand (string_ref command) const =0
 Does a command with this name already exist?
virtual std::string executeCommand (const std::string &command, CliConnection *connection=nullptr)=0
 Execute the given command.
virtual std::vector< std::string > splitList (const std::string &list)=0
virtual void registerSetting (Setting &setting)=0
 TODO.
virtual void unregisterSetting (Setting &setting)=0
virtual Setting * findSetting (string_ref name)=0
virtual void changeSetting (Setting &setting, const std::string &value)=0
virtual CliComm & getCliComm ()=0

Friends

class HelpCmd

Additional Inherited Members

- Protected Member Functions inherited from openmsx::CommandController
 CommandController ()
virtual ~CommandController ()

Detailed Description

Definition at line 28 of file GlobalCommandController.hh.

Constructor & Destructor Documentation

openmsx::GlobalCommandController::GlobalCommandController ( EventDistributor &  eventDistributor,
GlobalCliComm &  cliComm,
Reactor &  reactor 
)

Definition at line 77 of file GlobalCommandController.cc.

openmsx::GlobalCommandController::~GlobalCommandController ( )

Definition at line 120 of file GlobalCommandController.cc.

References StringMapImpl::empty().

Member Function Documentation

void openmsx::GlobalCommandController::changeSetting ( const std::string &  name,
const std::string &  value 
)

Definition at line 277 of file GlobalCommandController.cc.

Referenced by openmsx::MSXCommandController::changeSetting(), changeSetting(), and openmsx::SettingImplBase::syncProxy().

void openmsx::GlobalCommandController::changeSetting ( Setting &  setting,
const std::string &  value 
)
virtual

Definition at line 283 of file GlobalCommandController.cc.

References changeSetting(), and openmsx::Setting::getName().

string openmsx::GlobalCommandController::executeCommand ( const std::string &  command,
CliConnection *  connection = nullptr 
)
virtual

Definition at line 430 of file GlobalCommandController.cc.

Referenced by openmsx::MSXCommandController::executeCommand().

Setting * openmsx::GlobalCommandController::findSetting ( string_ref  name)
virtual

Definition at line 272 of file GlobalCommandController.cc.

References openmsx::SettingsManager::findSetting(), getSettingsConfig(), and openmsx::SettingsConfig::getSettingsManager().

CliComm & openmsx::GlobalCommandController::getCliComm ( )
virtual

Definition at line 195 of file GlobalCommandController.cc.

Referenced by openmsx::HotKey::loadBindings(), and source().

CliConnection * openmsx::GlobalCommandController::getConnection ( ) const
virtual

Definition at line 200 of file GlobalCommandController.cc.

Interpreter & openmsx::GlobalCommandController::getInterpreter ( )
virtual

Definition at line 205 of file GlobalCommandController.cc.

Referenced by openmsx::CommandConsole::CommandConsole(), openmsx::CommandCompleter::getInterpreter(), openmsx::Setting::getInterpreter(), openmsx::MSXCommandController::MSXCommandController(), openmsx::CommandLineParser::parse(), openmsx::SaveStateCLI::parseFileType(), openmsx::LaserdiscPlayerCLI::parseFileType(), openmsx::CassettePlayerCLI::parseFileType(), openmsx::ReplayCLI::parseFileType(), openmsx::CDImageCLI::parseOption(), openmsx::HDImageCLI::parseOption(), registerProxySetting(), openmsx::MSXCommandController::registerSetting(), unregisterProxySetting(), openmsx::MSXCommandController::unregisterSetting(), openmsx::CommandConsole::~CommandConsole(), and openmsx::MSXCommandController::~MSXCommandController().

InfoCommand & openmsx::GlobalCommandController::getOpenMSXInfoCommand ( )

Definition at line 210 of file GlobalCommandController.cc.

SettingsConfig & openmsx::GlobalCommandController::getSettingsConfig ( )
virtual

Definition at line 215 of file GlobalCommandController.cc.

Referenced by findSetting(), openmsx::SettingImplBase::init(), openmsx::CommandLineParser::parse(), openmsx::SettingOption::parseOption(), registerProxySetting(), openmsx::MSXCommandController::registerSetting(), registerSetting(), unregisterProxySetting(), openmsx::MSXCommandController::unregisterSetting(), unregisterSetting(), and openmsx::GlobalSettings::~GlobalSettings().

bool openmsx::GlobalCommandController::hasCommand ( string_ref  command) const
virtual

Definition at line 288 of file GlobalCommandController.cc.

References StringMap< T >::end(), and StringMap< T >::find().

Referenced by openmsx::CassettePlayerCLI::parseFileType(), openmsx::LaserdiscPlayerCLI::parseFileType(), openmsx::HDImageCLI::parseOption(), and openmsx::CDImageCLI::parseOption().

bool openmsx::GlobalCommandController::isComplete ( const std::string &  command)
virtual

Returns true iff the command is complete (all braces, quotes etc.

are balanced).

Definition at line 425 of file GlobalCommandController.cc.

void openmsx::GlobalCommandController::registerCommand ( Command &  command,
const std::string &  str 
)
virtual

Definition at line 223 of file GlobalCommandController.cc.

References StringMap< T >::end(), and StringMap< T >::find().

Referenced by openmsx::MSXCommandController::registerCommand(), and registerProxyCommand().

void openmsx::GlobalCommandController::registerCompleter ( CommandCompleter &  completer,
string_ref  str 
)
virtual

Definition at line 242 of file GlobalCommandController.cc.

References StringMap< T >::end(), and StringMap< T >::find().

Referenced by openmsx::MSXCommandController::registerCompleter(), and registerProxyCommand().

void openmsx::GlobalCommandController::registerProxyCommand ( const std::string &  name)

Definition at line 138 of file GlobalCommandController.cc.

References registerCommand(), and registerCompleter().

Referenced by openmsx::MSXCommandController::registerCommand().

void openmsx::GlobalCommandController::registerProxySetting ( Setting &  setting)

Definition at line 164 of file GlobalCommandController.cc.

References getInterpreter(), openmsx::Setting::getName(), getSettingsConfig(), openmsx::SettingsConfig::getSettingsManager(), openmsx::SettingsManager::registerSetting(), and openmsx::Interpreter::registerSetting().

Referenced by openmsx::MSXCommandController::registerSetting().

void openmsx::GlobalCommandController::registerSetting ( Setting &  setting)
virtual

Definition at line 258 of file GlobalCommandController.cc.

References openmsx::Setting::getName(), getSettingsConfig(), openmsx::SettingsConfig::getSettingsManager(), and openmsx::SettingsManager::registerSetting().

void openmsx::GlobalCommandController::source ( const std::string &  script)

Executes all defined auto commands.

Definition at line 442 of file GlobalCommandController.cc.

References getCliComm(), openmsx::LocalFileReference::getFilename(), openmsx::MSXException::getMessage(), and openmsx::CliComm::printWarning().

vector< string > openmsx::GlobalCommandController::splitList ( const std::string &  list)
virtual

Definition at line 437 of file GlobalCommandController.cc.

Referenced by openmsx::MSXCommandController::splitList().

string openmsx::GlobalCommandController::tabCompletion ( string_ref  command)
virtual

Complete the given command.

Definition at line 453 of file GlobalCommandController.cc.

References TclParser::getLast(), and string_ref::substr().

Referenced by openmsx::TabCompletionCmd::execute(), and openmsx::HelpCmd::tabCompletion().

void openmsx::GlobalCommandController::unregisterCommand ( Command &  command,
string_ref  str 
)
virtual

Definition at line 232 of file GlobalCommandController.cc.

References StringMap< T >::end(), StringMap< T >::erase(), StringMap< T >::find(), and StringMapEntry< T >::second.

Referenced by openmsx::MSXCommandController::unregisterCommand(), and unregisterProxyCommand().

void openmsx::GlobalCommandController::unregisterCompleter ( CommandCompleter &  completer,
string_ref  str 
)
virtual

Definition at line 249 of file GlobalCommandController.cc.

References StringMap< T >::end(), StringMap< T >::erase(), StringMap< T >::find(), and StringMapEntry< T >::second.

Referenced by openmsx::MSXCommandController::unregisterCompleter(), and unregisterProxyCommand().

void openmsx::GlobalCommandController::unregisterProxyCommand ( string_ref  name)

Definition at line 147 of file GlobalCommandController.cc.

References unregisterCommand(), and unregisterCompleter().

Referenced by openmsx::MSXCommandController::unregisterCommand().

void openmsx::GlobalCommandController::unregisterProxySetting ( Setting &  setting)

Definition at line 180 of file GlobalCommandController.cc.

References getInterpreter(), openmsx::Setting::getName(), getSettingsConfig(), openmsx::SettingsConfig::getSettingsManager(), openmsx::SettingsManager::unregisterSetting(), and openmsx::Interpreter::unregisterSetting().

Referenced by openmsx::MSXCommandController::unregisterSetting().

void openmsx::GlobalCommandController::unregisterSetting ( Setting &  setting)
virtual

Definition at line 265 of file GlobalCommandController.cc.

References openmsx::Setting::getName(), getSettingsConfig(), openmsx::SettingsConfig::getSettingsManager(), and openmsx::SettingsManager::unregisterSetting().

Friends And Related Function Documentation

friend class HelpCmd
friend

Definition at line 110 of file GlobalCommandController.hh.

The documentation for this class was generated from the following files:
Generated on Sun May 19 2013 12:18:21 for openMSX by   doxygen 1.8.1.2