MutationOfJB::CommandParser Class Reference

#include <command.h>

Inheritance diagram for MutationOfJB::CommandParser:

Public Member Functions
virtual bool	parse (const Common::String &line, ScriptParseContext &parseCtx, Command *&command)=0
virtual void	transition (ScriptParseContext &parseCtx, Command *oldCommand, Command *newCommand, CommandParser *newCommandParser)
virtual void	finish (ScriptParseContext &parseCtx)

Detailed Description

Base class for command parsers.

The parser's main job is to create a Command instance from input line.

Member Function Documentation

parse()

virtual bool MutationOfJB::CommandParser::parse ( const Common::String &  line, ScriptParseContext &  parseCtx, Command *&  command  )

pure virtual

Parses the specified line and possibly returns a Command instance.

Parameters

line	Line to parse.
parseCtx	Parse context.
command	Output parameter for newly created command.

Returns

True if the line has been successfully parsed by this parser, false otherwise.

Note

You may return true and set command to nullptr. That means the line has been successfully parsed, but no command is needed.

Implemented in MutationOfJB::ChangeSceneCommandParser, MutationOfJB::ChangeStaticCommandParser, MutationOfJB::ChangeDoorCommandParser, MutationOfJB::ChangeObjectCommandParser, MutationOfJB::RandomBlockStartParser, MutationOfJB::EndBlockCommandParser, MutationOfJB::LoadPlayerCommandParser, MutationOfJB::GotoCommandParser, MutationOfJB::CallMacroCommandParser, MutationOfJB::IfItemCommandParser, MutationOfJB::IfPiggyCommandParser, MutationOfJB::NewRoomCommandParser, MutationOfJB::RandomCommandParser, MutationOfJB::TalkCommandParser, MutationOfJB::AddItemCommandParser, MutationOfJB::BitmapVisibilityCommandParser, MutationOfJB::IfCommandParser, MutationOfJB::LabelCommandParser, MutationOfJB::PlayAnimationCommandParser, MutationOfJB::RemoveItemCommandParser, MutationOfJB::SayCommandParser, MutationOfJB::SetObjectFrameCommandParser, MutationOfJB::SwitchPartCommandParser, MutationOfJB::CameFromCommandParser, MutationOfJB::RemoveAllItemsCommandParser, MutationOfJB::SetColorCommandParser, MutationOfJB::RenameCommandParser, MutationOfJB::SpecialShowCommandParser, and MutationOfJB::DefineStructCommandParser.

transition()

virtual void MutationOfJB::CommandParser::transition ( ScriptParseContext &  parseCtx, Command *  oldCommand, Command *  newCommand, CommandParser *  newCommandParser  )

virtual

Called when transitioning parsing between two commands.

For example, cmdParserA->transition(parseCtx, cmdA, cmdB, cmdParserB) is called after command B is done parsing to notify command A parser about the transition from command A to command B. This is useful for sequential commands, because at the time command A is being parsed, we don't have any information about command B, so we cannot set the next pointer. Transition method can be used to set the next pointer after command B is available.

Parameters

parseCtx	Parse context.
oldCommand	Old command (created by this parser).
newCommand	New command (created by newCommandParser).
newCommandParser	Command parser which created the new command.

Reimplemented in MutationOfJB::RandomBlockStartParser, MutationOfJB::EndBlockCommandParser, MutationOfJB::CallMacroCommandParser, MutationOfJB::ConditionalCommandParser, and MutationOfJB::SeqCommandParser.

finish()

virtual void MutationOfJB::CommandParser::finish ( ScriptParseContext &  parseCtx )

virtual

Called after the whole script is parsed.

Can be used for cleanup.

Parameters

parseCtx

Parse context.

Reimplemented in MutationOfJB::EndBlockCommandParser, and MutationOfJB::ConditionalCommandParser.

---

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

• engines/mutationofjb/commands/command.h