WScriptEngine Class Reference

The script engine. More...

#include <WScriptEngine.h>

Collaboration diagram for WScriptEngine:

Public Member Functions
	WScriptEngine (std::shared_ptr< WModuleContainer > const &rootContainer)
	Constructs a new script engine. More...
virtual	~WScriptEngine ()
	Destructor. More...
std::shared_ptr< WScriptInterpreter >	getInterpreterByFileExtension (std::string const &ext)
	This finds an interpreter suitable for executing script files ending with the given extension. More...
std::shared_ptr< WScriptInterpreter >	getInterpreter (std::string const &name)
	This finds an interpreter by script language name. More...
std::size_t	getNumInterpreters () const
	Get the number of script interpreters available. More...
std::shared_ptr< WScriptInterpreter >	getInterpreter (std::size_t index)
	Get the i'th script interpreter. More...

Private Attributes
std::vector< std::shared_ptr< WScriptInterpreter > >	m_interpreters
	The list of available script interpreters. More...

Detailed Description

The script engine.

Provides all script interpreters available for the OpenWalnut installation. Which interpreters are available depends on the libs available at OpenWalnut build time.

Definition at line 40 of file WScriptEngine.h.

Constructor & Destructor Documentation

WScriptEngine()

WScriptEngine::WScriptEngine ( std::shared_ptr< WModuleContainer > const &  rootContainer )

explicit

Constructs a new script engine.

Parameters

rootContainer

The root module container to use for modules inserted via scripts.

Definition at line 31 of file WScriptEngine.cpp.

References m_interpreters.

~WScriptEngine()

WScriptEngine::~WScriptEngine ( )

virtual

Destructor.

Definition at line 44 of file WScriptEngine.cpp.

Member Function Documentation

getInterpreter() [1/2]

std::shared_ptr< WScriptInterpreter > WScriptEngine::getInterpreter

(

std::size_t

index

)

Get the i'th script interpreter.

Parameters

index

The index of the script interpreter to retrieve, must be in [0,getNumInterpreters()-1].

Returns

The script interpreter or a NULL-pointer if the index was invalid.

Definition at line 77 of file WScriptEngine.cpp.

References m_interpreters.

getInterpreter() [2/2]

std::shared_ptr< WScriptInterpreter > WScriptEngine::getInterpreter

(

std::string const &

name

)

This finds an interpreter by script language name.

Parameters

name	The name of the script language.

Returns

The matching script interpreter or a NULL-pointer, if no such interpreter was available.

Definition at line 60 of file WScriptEngine.cpp.

References m_interpreters.

getInterpreterByFileExtension()

std::shared_ptr< WScriptInterpreter > WScriptEngine::getInterpreterByFileExtension

(

std::string const &

ext

)

This finds an interpreter suitable for executing script files ending with the given extension.

Parameters

ext	The extension of the script file to execute.

Returns

The matching script interpreter or a NULL-pointer, if no such interpreter was available.

Definition at line 48 of file WScriptEngine.cpp.

References m_interpreters.

getNumInterpreters()

std::size_t WScriptEngine::getNumInterpreters

(

)

const

Get the number of script interpreters available.

Returns

The number of available script interpreters.

Definition at line 72 of file WScriptEngine.cpp.

References m_interpreters.

Member Data Documentation

m_interpreters

std::vector< std::shared_ptr< WScriptInterpreter > > WScriptEngine::m_interpreters

private

The list of available script interpreters.

Definition at line 91 of file WScriptEngine.h.

Referenced by getInterpreter(), getInterpreterByFileExtension(), getNumInterpreters(), and WScriptEngine().

---

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

• WScriptEngine.h
• WScriptEngine.cpp