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

#include <RomInfoTopic.hh>

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

Public Member Functions

 RomInfoTopic (InfoCommand &openMSXInfoCommand)
 
void execute (span< const TclObject > tokens, TclObject &result) const override
 Show info on this topic. More...
 
std::string help (const std::vector< std::string > &tokens) const override
 Print help for this topic. More...
 
void tabCompletion (std::vector< std::string > &tokens) const override
 Attempt tab completion for this topic. More...
 
- Public Member Functions inherited from openmsx::InfoTopic
InterpretergetInterpreter () const final
 
- Public Member Functions inherited from openmsx::Completer
const std::string & getName () const
 
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)
 

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, 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 inherited from openmsx::InfoTopic
 InfoTopic (InfoCommand &infoCommand, const std::string &name)
 
 ~InfoTopic ()
 
- Protected Member Functions inherited from openmsx::Completer
 Completer (std::string_view name)
 
 ~Completer ()=default
 

Detailed Description

Definition at line 8 of file RomInfoTopic.hh.

Constructor & Destructor Documentation

◆ RomInfoTopic()

openmsx::RomInfoTopic::RomInfoTopic ( InfoCommand openMSXInfoCommand)
explicit

Definition at line 11 of file RomInfoTopic.cc.

Member Function Documentation

◆ execute()

void openmsx::RomInfoTopic::execute ( span< const TclObject tokens,
TclObject result 
) const
overridevirtual

Show info on this topic.

Parameters
tokensTokenized command line; tokens[1] is the topic.
resultThe result of this topic must be assigned to this parameter.
Exceptions
CommandExceptionThrown when there was an error while executing this InfoTopic.

Implements openmsx::InfoTopic.

Definition at line 16 of file RomInfoTopic.cc.

References openmsx::TclObject::addDictKeyValues(), openmsx::TclObject::addListElements(), openmsx::RomInfo::getAllRomTypes(), openmsx::RomInfo::getBlockSize(), openmsx::RomInfo::getDescription(), openmsx::RomInfo::nameToRomType(), openmsx::ROM_UNKNOWN, and span< ElementType, Extent >::size().

◆ help()

string openmsx::RomInfoTopic::help ( const std::vector< std::string > &  tokens) const
overridevirtual

Print help for this topic.

Parameters
tokensTokenized command line; tokens[1] is the topic.

Implements openmsx::InfoTopic.

Definition at line 37 of file RomInfoTopic.cc.

◆ tabCompletion()

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

Attempt tab completion for this topic.

Default implementation does nothing.

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

Reimplemented from openmsx::InfoTopic.

Definition at line 43 of file RomInfoTopic.cc.

References openmsx::Completer::completeString(), and openmsx::RomInfo::getAllRomTypes().


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