PianodInterpreter Class Reference

Interpreter class based on Parsnip template, customized base for pianod interpreters with the addition of help support. More...

#include <interpreter.h>

Inheritance diagram for PianodInterpreter:

Collaboration diagram for PianodInterpreter:

Public Types
using	HelpList = PianodDispatcher::HelpList

Public Member Functions
virtual void	registerInterpreter (PianodDispatcher &dispatcher)
	Register the interpreter with a dispatcher. More...
const HelpList	getHelp (const std::vector< std::string > &search, std::set< std::string > *option_parsers)
	Search the interpreter's definitions for any definitions matching search criteria. More...

Static Public Member Functions
static bool	optionIs (const Parsnip::Data &options, const char *name, const char *expected)
	Check if a string value exists and is case-blind equal to a particular value. More...
template<typename ValueType , typename LookupType >
static ValueType	optionalValue (const Parsnip::Data &options, const char *name, const LookupType &lookup, const ValueType default_value)
	Retrieve the ID of a string value. More...

Protected Types
using	StringVector = std::vector< std::string >

Protected Member Functions
virtual bool	authorizedCommand (Parsnip::Parser::CommandId command_id, PianodConnection &context)=0
	Check whether a command is authorized. More...
virtual ResponseCollector	handleCommand (Parsnip::Parser::CommandId command_id, const Parsnip::Data &parameters, PianodConnection &context)=0
	Command handler. More...
virtual const Parsnip::Parser::Definitions &	getParserDefinitions ()=0
	Retrieve the parser definitions handled by the interpreter. More...

Static Protected Attributes
static const Parsnip::Data	EmptyDictionary {Parsnip::Data::Dictionary}
	An empty dictionary, often used as a default with Parsnip::Data::getOr. More...
static const StringVector	EmptyStringVector
	An empty string vector, often used as a default with Parsnip::Data::getOr. More...

Private Member Functions
virtual ResponseCollector	interpret (Parsnip::Parser::CommandId command_id, const Parsnip::Data &parameters, PianodConnection &context) override final
	Authorize and execute a command. More...

Private Attributes
friend	PianodDispatcher

Detailed Description

Interpreter class based on Parsnip template, customized base for pianod interpreters with the addition of help support.

Member Typedef Documentation

HelpList

using PianodInterpreter::HelpList = PianodDispatcher::HelpList

StringVector

using PianodInterpreter::StringVector = std::vector <std::string>

protected

Member Function Documentation

authorizedCommand()

virtual bool PianodInterpreter::authorizedCommand ( Parsnip::Parser::CommandId  command_id, PianodConnection &  context  )

protectedpure virtual

Check whether a command is authorized.

Parameters

command_id	The command requesting execution.
context	Connection details, including authentication state and privileges.

Returns

True if allowed, false otherwise.

Implemented in UserManager, ToneGeneratorCommands, PandoraCommands, FilesystemCommands, Tuner::Tuner, ServiceManager, Media::Manager, and AudioEngine.

Here is the caller graph for this function:

getHelp()

const std::vector< std::string > PianodInterpreter::getHelp	(	const std::vector< std::string > &	search,
		std::set< std::string > *	option_parsers
	)

Search the interpreter's definitions for any definitions matching search criteria.

Parameters

search	The search criteria. If empty, returns all.
option_parsers	Any option parsers used by matching statements are added to this set.

Returns

Matching definitions, ready for presentation as help.

Here is the call graph for this function:

getParserDefinitions()

virtual const Parsnip::Parser::Definitions& PianodInterpreter::getParserDefinitions ( )

protectedpure virtual

Retrieve the parser definitions handled by the interpreter.

Returns

Parser definitions.

Implemented in UserManager, Tuner::Tuner, ServiceManager, ToneGeneratorCommands, PandoraCommands, Media::Manager, FilesystemCommands, and AudioEngine.

Here is the caller graph for this function:

handleCommand()

virtual ResponseCollector PianodInterpreter::handleCommand ( Parsnip::Parser::CommandId  command_id, const Parsnip::Data &  parameters, PianodConnection &  context  )

protectedpure virtual

Command handler.

Parameters

command_id	Command to execute.
parameters	Command parameters.
context	Connection details, including authentication state and privileges.

Returns

Data or success/failure indications.

Exceptions

CommandError

or other exception if an error occurs.

Implemented in UserManager, ToneGeneratorCommands, PandoraCommands, FilesystemCommands, Tuner::Tuner, ServiceManager, Media::Manager, and AudioEngine.

Here is the caller graph for this function:

interpret()

ResponseCollector PianodInterpreter::interpret ( Parsnip::Parser::CommandId  command_id, const Parsnip::Data &  parameters, PianodConnection &  context  )

finaloverrideprivatevirtual

Authorize and execute a command.

Parameters

command_id	The command to execute.
parameters	Options for the command.
context	The connection and context executing the command.

Returns

Data or success/failure indications.

Exceptions

CommandError

or any other exception.

Implements Parsnip::Interpreter< ResponseCollector, PianodConnection & >.

Here is the call graph for this function:

optionalValue()

template<typename ValueType , typename LookupType >

static ValueType PianodInterpreter::optionalValue ( const Parsnip::Data &  options, const char *  name, const LookupType &  lookup, const ValueType  default_value  )

inlinestatic

Retrieve the ID of a string value.

Parameters

options	Where to look for the value.
name	The name of the value.
lookup	The lookup table for the value.
default_value	The default value, if not specified.

Returns

The ID value from the lookup table, or default.

Exceptions

If	the value is not in the table.

Here is the call graph for this function:

Here is the caller graph for this function:

optionIs()

bool PianodInterpreter::optionIs ( const Parsnip::Data &  options, const char *  name, const char *  expected  )

static

Check if a string value exists and is case-blind equal to a particular value.

Parameters

options	The options dictionary to look in.
name	The name of the value to check
expected	The expected value.

Returns

True if the options value exists and has the expected value.

Exceptions

If	the value has the wrong type.

Here is the call graph for this function:

Here is the caller graph for this function:

registerInterpreter()

void PianodInterpreter::registerInterpreter ( PianodDispatcher &  dispatcher )

virtual

Register the interpreter with a dispatcher.

Parameters

dispatcher

The dispatcher with which to register.

Reimplemented in AudioEngine.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

EmptyDictionary

const Parsnip::Data PianodInterpreter::EmptyDictionary {Parsnip::Data::Dictionary}

staticprotected

An empty dictionary, often used as a default with Parsnip::Data::getOr.

EmptyStringVector

const PianodInterpreter::StringVector PianodInterpreter::EmptyStringVector

staticprotected

An empty string vector, often used as a default with Parsnip::Data::getOr.

PianodDispatcher

friend PianodInterpreter::PianodDispatcher

private

---

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

• common/interpreter.h
• common/interpreter.cpp