ScummVM API documentation
Stark::Tools::Command Class Reference

#include <command.h>

Inheritance diagram for Stark::Tools::Command:
Stark::Tools::ASTCommand Stark::Tools::CFGCommand

Classes

struct  SubTypeDesc
 

Public Types

enum  ControlFlowType { kFlowNormal, kFlowBranch, kFlowEnd }
 
typedef Common::Array< Resources::Command::ArgumentArgumentArray
 

Public Member Functions

 Command (Command *command)
 
 Command (Resources::Command *resource)
 
void printCall () const
 
uint16 getIndex () const
 
Resources::Command::SubType getSubType () const
 
bool hasSubtypeDescription () const
 
ArgumentArray getEffectiveArguments () const
 

Protected Member Functions

Common::String describeArguments (DefinitionRegistry *definitions) const
 

Static Protected Member Functions

static const SubTypeDescsearchSubTypeDesc (Resources::Command::SubType subType)
 

Protected Attributes

uint16 _index
 
Resources::Command::SubType _subType
 
const SubTypeDesc_subTypeDesc
 
ArgumentArray _arguments
 

Detailed Description

A base script command for disassembly use

As opposed to the Command class in the Resources namespace, this class is not meant to be executed. It is meant to be used for script disassembly, to store analysis results.

Member Function Documentation

◆ printCall()

void Stark::Tools::Command::printCall ( ) const

Print a call to this command to the debug output

◆ getIndex()

uint16 Stark::Tools::Command::getIndex ( ) const

This command's resource tree index

◆ getEffectiveArguments()

ArgumentArray Stark::Tools::Command::getEffectiveArguments ( ) const

List the command's arguments ignoring the control flow related ones

◆ searchSubTypeDesc()

static const SubTypeDesc* Stark::Tools::Command::searchSubTypeDesc ( Resources::Command::SubType  subType)
staticprotected

Get a description for a command subtype from an internal database

◆ describeArguments()

Common::String Stark::Tools::Command::describeArguments ( DefinitionRegistry definitions) const
protected

List the arguments values as a coma separated string


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