openMSX
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
openmsx::Completer Class Referenceabstract

#include <Completer.hh>

Inheritance diagram for openmsx::Completer:
Inheritance graph
[legend]

Classes

struct  AtLeast
 
struct  Between
 
struct  Prefix
 

Public Member Functions

const std::string & getName () const
 
virtual std::string help (const std::vector< std::string > &tokens) const =0
 Print help for this command. More...
 
virtual void tabCompletion (std::vector< std::string > &tokens) const =0
 Attempt tab completion for this command. More...
 
virtual Interpreter & getInterpreter () const =0
 
void checkNumArgs (span< const TclObject > tokens, unsigned exactly, const char *errMessage) const
 
void checkNumArgs (span< const TclObject > tokens, AtLeast atLeast, const char *errMessage) const
 
void checkNumArgs (span< const TclObject > tokens, Between between, const char *errMessage) const
 
void checkNumArgs (span< const TclObject > tokens, unsigned exactly, Prefix prefix, const char *errMessage) const
 
void checkNumArgs (span< const TclObject > tokens, AtLeast atLeast, Prefix prefix, const char *errMessage) const
 
void checkNumArgs (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)
 

Static Public Member Functions

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, const 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 (const std::vector< std::string_view > &input)
 
static void setOutput (InterpreterOutput *output_)
 

Protected Member Functions

 Completer (std::string_view name)
 
 ~Completer ()=default
 

Detailed Description

Definition at line 17 of file Completer.hh.

Constructor & Destructor Documentation

◆ Completer()

openmsx::Completer::Completer ( std::string_view  name)
explicitprotected

Definition at line 21 of file Completer.cc.

References detail::append(), gl::max(), utf8::unchecked::size(), spaces(), and strAppend().

Referenced by setOutput().

◆ ~Completer()

openmsx::Completer::~Completer ( )
protecteddefault

Referenced by setOutput().

Member Function Documentation

◆ checkNumArgs() [1/6]

void openmsx::Completer::checkNumArgs ( span< const TclObject >  tokens,
unsigned  exactly,
const char *  errMessage 
) const

Definition at line 178 of file Completer.cc.

Referenced by checkNumArgs(), openmsx::MessageCommand::execute(), openmsx::AfterCommand::execute(), openmsx::Sha1SumCommand::execute(), openmsx::ExitCommand::execute(), openmsx::MachineCommand::execute(), openmsx::LoadMachineCmd::execute(), openmsx::TestMachineCommand::execute(), openmsx::CreateMachineCommand::execute(), openmsx::RemoveExtCmd::execute(), openmsx::DeleteMachineCommand::execute(), openmsx::ActivateMachineCommand::execute(), openmsx::DeviceInfo::execute(), openmsx::StoreMachineCommand::execute(), openmsx::RestoreMachineCommand::execute(), openmsx::GetClipboardCommand::execute(), openmsx::SetClipboardCommand::execute(), and openmsx::ExtCmd::execute().

◆ checkNumArgs() [2/6]

void openmsx::Completer::checkNumArgs ( span< const TclObject >  tokens,
AtLeast  atLeast,
const char *  errMessage 
) const

Definition at line 183 of file Completer.cc.

References checkNumArgs(), and openmsx::Completer::AtLeast::min.

◆ checkNumArgs() [3/6]

void openmsx::Completer::checkNumArgs ( span< const TclObject >  tokens,
Between  between,
const char *  errMessage 
) const

Definition at line 188 of file Completer.cc.

References checkNumArgs(), and openmsx::Completer::Between::min.

◆ checkNumArgs() [4/6]

void openmsx::Completer::checkNumArgs ( span< const TclObject >  tokens,
unsigned  exactly,
Prefix  prefix,
const char *  errMessage 
) const

Definition at line 193 of file Completer.cc.

References getInterpreter(), openmsx::Completer::Prefix::n, and openmsx::Interpreter::wrongNumArgs().

◆ checkNumArgs() [5/6]

void openmsx::Completer::checkNumArgs ( span< const TclObject >  tokens,
AtLeast  atLeast,
Prefix  prefix,
const char *  errMessage 
) const

Definition at line 199 of file Completer.cc.

References getInterpreter(), openmsx::Completer::AtLeast::min, openmsx::Completer::Prefix::n, and openmsx::Interpreter::wrongNumArgs().

◆ checkNumArgs() [6/6]

void openmsx::Completer::checkNumArgs ( span< const TclObject >  tokens,
Between  between,
Prefix  prefix,
const char *  errMessage 
) const

Definition at line 205 of file Completer.cc.

References getInterpreter(), openmsx::Completer::Between::max, openmsx::Completer::Between::min, openmsx::Completer::Prefix::n, and openmsx::Interpreter::wrongNumArgs().

◆ completeFileName() [1/2]

template<typename RANGE >
void openmsx::Completer::completeFileName ( std::vector< std::string > &  tokens,
const FileContext &  context,
const RANGE &  extra 
)
static

Definition at line 139 of file Completer.hh.

Referenced by getName(), openmsx::FilenameSetting::tabCompletion(), openmsx::NowindCommand::tabCompletion(), openmsx::HDCommand::tabCompletion(), openmsx::CDXCommand::tabCompletion(), openmsx::Sha1SumCommand::tabCompletion(), openmsx::DiskCommand::tabCompletion(), openmsx::LSXCommand::tabCompletion(), openmsx::RestoreMachineCommand::tabCompletion(), and openmsx::DiskManipulator::unregisterDrive().

◆ completeFileName() [2/2]

void openmsx::Completer::completeFileName ( std::vector< std::string > &  tokens,
const FileContext &  context 
)
static

Definition at line 130 of file Completer.cc.

References detail::append(), gl::context, openmsx::FileOperations::exists(), openmsx::FileOperations::expandCurrentDirFromDrive(), openmsx::FileOperations::expandTilde(), openmsx::filename, openmsx::FileOperations::getConventionalPath(), openmsx::FileOperations::getDirName(), openmsx::ReadDir::getEntry(), openmsx::FileOperations::getNativePath(), openmsx::FileContext::getPaths(), openmsx::FileOperations::isAbsolutePath(), openmsx::FileOperations::isDirectory(), openmsx::FileOperations::join(), and t.

◆ completeString() [1/2]

template<typename ITER >
void openmsx::Completer::completeString ( std::vector< std::string > &  tokens,
ITER  begin,
ITER  end,
bool  caseSensitive = true 
)
static

Definition at line 125 of file Completer.hh.

Referenced by getName(), openmsx::GlobalCommandController::source(), openmsx::BooleanSetting::tabCompletion(), openmsx::RomInfoTopic::tabCompletion(), openmsx::MessageCommand::tabCompletion(), openmsx::VideoSourceSetting::tabCompletion(), openmsx::AfterCommand::tabCompletion(), openmsx::MachineCommand::tabCompletion(), openmsx::LoadMachineCmd::tabCompletion(), openmsx::TestMachineCommand::tabCompletion(), openmsx::RemoveExtCmd::tabCompletion(), openmsx::DeleteMachineCommand::tabCompletion(), openmsx::ActivateMachineCommand::tabCompletion(), openmsx::DeviceInfo::tabCompletion(), openmsx::StoreMachineCommand::tabCompletion(), openmsx::ConfigInfo::tabCompletion(), openmsx::ExtCmd::tabCompletion(), openmsx::EnumSettingBase::tabCompletionBase(), openmsx::DiskManipulator::unregisterDrive(), and openmsx::InfoCommand::unregisterTopic().

◆ completeString() [2/2]

template<typename RANGE >
void openmsx::Completer::completeString ( std::vector< std::string > &  tokens,
const RANGE &  possibleValues,
bool  caseSensitive = true 
)
static

Definition at line 111 of file Completer.hh.

◆ filter()

template<typename ITER >
NEVER_INLINE std::vector<std::string_view> openmsx::Completer::filter ( std::string_view  str,
ITER  begin,
ITER  end,
bool  caseSensitive 
)

Definition at line 91 of file Completer.hh.

◆ formatListInColumns()

vector< string > openmsx::Completer::formatListInColumns ( const std::vector< std::string_view > &  input)
static

Definition at line 59 of file Completer.cc.

References ranges::all_of(), openmsx::InterpreterOutput::getOutputColumns(), utf8::unchecked::next(), openmsx::InterpreterOutput::output(), ranges::sort(), and ranges::unique().

Referenced by getName().

◆ getInterpreter()

virtual Interpreter& openmsx::Completer::getInterpreter ( ) const
pure virtual

Implemented in openmsx::InfoTopic, and openmsx::CommandCompleter.

Referenced by checkNumArgs(), and getName().

◆ getName()

const std::string& openmsx::Completer::getName ( ) const
inline

Definition at line 20 of file Completer.hh.

References completeFileName(), completeString(), gl::context, formatListInColumns(), getInterpreter(), help(), and tabCompletion().

Referenced by openmsx::Command::Command(), openmsx::CommandCompleter::CommandCompleter(), openmsx::GlobalCommandController::getConnection(), openmsx::MSXCommandController::getPrefix(), openmsx::ProxyCmd::help(), openmsx::RecordedCommand::needRecord(), openmsx::ProxyCmd::ProxyCmd(), openmsx::MSXCommandController::registerCommand(), openmsx::InfoCommand::registerTopic(), openmsx::MSXCommandController::unregisterCommand(), openmsx::InfoCommand::unregisterTopic(), openmsx::Command::~Command(), and openmsx::CommandCompleter::~CommandCompleter().

◆ help()

virtual std::string openmsx::Completer::help ( const std::vector< std::string > &  tokens) const
pure virtual

Print help for this command.

Implemented in openmsx::ExtCmd, openmsx::SoftwareInfoTopic, openmsx::RealTimeInfo, openmsx::ConfigInfo, openmsx::SetClipboardCommand, openmsx::GetClipboardCommand, openmsx::RestoreMachineCommand, openmsx::StoreMachineCommand, openmsx::DeviceInfo, openmsx::ActivateMachineCommand, openmsx::MachineTypeInfo, openmsx::ListMachinesCommand, openmsx::MachineNameInfo, openmsx::DeleteMachineCommand, openmsx::RemoveExtCmd, openmsx::CreateMachineCommand, openmsx::ListExtCmd, openmsx::LSXCommand, openmsx::TestMachineCommand, openmsx::LoadMachineCmd, openmsx::MachineCommand, openmsx::ResetCmd, openmsx::ExitCommand, openmsx::DiskCommand, openmsx::InfoTopic, openmsx::Sha1SumCommand, openmsx::CDXCommand, openmsx::AfterCommand, openmsx::HDCommand, openmsx::NowindCommand, openmsx::ProxyCmd, openmsx::MessageCommand, and openmsx::RomInfoTopic.

Referenced by getName().

◆ setOutput()

static void openmsx::Completer::setOutput ( InterpreterOutput *  output_)
inlinestatic

Definition at line 65 of file Completer.hh.

References Completer(), and ~Completer().

Referenced by openmsx::CommandConsole::CommandConsole(), and openmsx::CommandConsole::~CommandConsole().

◆ tabCompletion()

virtual void openmsx::Completer::tabCompletion ( std::vector< std::string > &  tokens) const
pure virtual

Attempt tab completion for this command.

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

Implemented in openmsx::ExtCmd, openmsx::ConfigInfo, openmsx::RestoreMachineCommand, openmsx::StoreMachineCommand, openmsx::DeviceInfo, openmsx::ActivateMachineCommand, openmsx::DeleteMachineCommand, openmsx::RemoveExtCmd, openmsx::LSXCommand, openmsx::TestMachineCommand, openmsx::LoadMachineCmd, openmsx::MachineCommand, openmsx::Command, openmsx::DiskCommand, openmsx::InfoTopic, openmsx::Sha1SumCommand, openmsx::CDXCommand, openmsx::AfterCommand, openmsx::HDCommand, openmsx::NowindCommand, openmsx::ProxyCmd, openmsx::MessageCommand, and openmsx::RomInfoTopic.

Referenced by getName().

The documentation for this class was generated from the following files:
Generated on Sun Nov 10 2019 00:13:37 for openMSX by   doxygen 1.8.13