#include <WsfExe.hpp>

Inherits UtReferenceTracked.

Collaboration diagram for wizard::WsfExe:

[legend]

Classes
class	GrammarVersion

Public Member Functions
	WsfExe (const UtPath &aExePath)
	WsfExe (std::shared_ptr< WsfParseDefinitions > &aParseDefinition, const std::string &aGrammar)
	WsfExe (const WsfExe &)=delete
	WsfExe (WsfExe &&)=default
WsfExe &	operator= (const WsfExe &)=delete
WsfExe &	operator= (WsfExe &&)=default
virtual	~WsfExe ()
bool	LoadFromDisk ()
bool	IsLoaded () const
const UtPath &	GetPath () const
const std::string &	GetVersion () const
const std::string &	GetApplication () const
const std::string &	GetGrammar ()
std::shared_ptr< WsfParseDefinitions >	GetParseDefinitions ()
std::shared_ptr< GrammarDocumentation >	GetGrammarDocumentation ()
std::shared_ptr< WsfPProxyRegistry >	GetProxyRegistry () const
std::string	GetAlias () const
void	SetAlias (const std::string &aAlias)
std::string	GetDescriptiveName () const
virtual void	ExeTypeToXML (XML_Context &aInput)
WsfScriptTypes *	TakeScriptTypes ()
void	GiveScriptTypes (WsfScriptTypes *aScriptTypesPtr)
WsfStyler *	GetStyler ()
GrammarVersion	GetGrammarVersion () const

Static Public Member Functions
static WsfExe *	FromDisk (const UtPath &aExePath)
static std::string	GetDescriptiveNameFor (const std::string &aApplicationName, const std::string &aVersion)

Static Public Attributes
static UtCallbackListN< void(WsfExe *)>	ExeUpdated

Protected Member Functions
void	BeginBuildDoc ()
void	Cleanup ()
void	ProcessData (const std::string &aBlockName, const std::string &aText)
void	BuildProxyRegistry ()

Protected Attributes
UtPath	mExePath
std::string	mVersion
std::string	mApplication
std::string	mAlias
std::string	mGrammarText
std::shared_ptr< WsfParseDefinitions >	mParseDefinitions
std::vector< WsfScriptTypes * >	mScriptTypesObjects
std::set< WsfScriptTypes * >	mGivenScriptTypes
std::shared_ptr< GrammarDocumentation >	mGrammarDocumentation
bool	mGrammarDocumentationFutureStarted
QFuture< std::shared_ptr< GrammarDocumentation > >	mGrammarDocumentationFuture
WsfStyler *	mWSF_StylerPtr
std::shared_ptr< WsfPProxyRegistry >	mProxyRegistry
GrammarVersion	mGrammarVersion

Constructor & Destructor Documentation

◆ WsfExe() [1/4]

wizard::WsfExe::WsfExe ( const UtPath & aExePath )

explicit

References GetStyler(), mExePath, mGrammarDocumentationFutureStarted, mWSF_StylerPtr, and wizExeMgr.

Referenced by FromDisk(), LoadFromDisk(), operator=(), operator=(), WsfExe(), and WsfExe().

◆ WsfExe() [2/4]

wizard::WsfExe::WsfExe	(	std::shared_ptr< WsfParseDefinitions > &	aParseDefinition,
		const std::string &	aGrammar )

References BeginBuildDoc(), BuildProxyRegistry(), GetStyler(), mAlias, mApplication, mGrammarDocumentationFutureStarted, mGrammarText, mGrammarVersion, mParseDefinitions, mWSF_StylerPtr, and wizExeMgr.

◆ WsfExe() [3/4]

wizard::WsfExe::WsfExe ( const WsfExe & )

delete

References WsfExe().

◆ WsfExe() [4/4]

wizard::WsfExe::WsfExe ( WsfExe && )

default

References WsfExe().

◆ ~WsfExe()

wizard::WsfExe::~WsfExe ( )

virtual

References Cleanup().

Member Function Documentation

◆ BeginBuildDoc()

void wizard::WsfExe::BeginBuildDoc ( )

protected

References BuildDocumentationAsync(), wizard::RunEnvManager::GetDocumentationDir(), mGrammarDocumentationFuture, mGrammarDocumentationFutureStarted, and mParseDefinitions.

Referenced by GetParseDefinitions(), and WsfExe().

◆ BuildProxyRegistry()

void wizard::WsfExe::BuildProxyRegistry ( )

protected

References WsfParseDefinitions::GetRootStruct(), WsfParseDefinitions::mBasicTypes, mParseDefinitions, and mProxyRegistry.

Referenced by GetParseDefinitions(), LoadFromDisk(), and WsfExe().

◆ Cleanup()

void wizard::WsfExe::Cleanup ( )

protected

References mGivenScriptTypes, and mScriptTypesObjects.

Referenced by LoadFromDisk(), and ~WsfExe().

◆ ExeTypeToXML()

void wizard::WsfExe::ExeTypeToXML ( XML_Context & aInput )

virtual

References wizard::XML_Context::GetWriter(), mAlias, mApplication, mExePath, and mVersion.

Referenced by wizard::Project::ToXML().

◆ FromDisk()

wizard::WsfExe * wizard::WsfExe::FromDisk ( const UtPath & aExePath )

static

References wizard::Util::IsExecutable(), LoadFromDisk(), and WsfExe().

Referenced by wizard::WsfExeManager::Add(), operator=(), and wizard::WsfExeManager::Refresh().

◆ GetAlias()

std::string wizard::WsfExe::GetAlias ( ) const

inline

References mAlias.

◆ GetApplication()

const std::string & wizard::WsfExe::GetApplication ( ) const

inline

References mApplication.

◆ GetDescriptiveName()

std::string wizard::WsfExe::GetDescriptiveName ( ) const

References GetDescriptiveNameFor(), mApplication, and mVersion.

Referenced by wizard::WsfExeManager::Add(), and GetParseDefinitions().

◆ GetDescriptiveNameFor()

std::string wizard::WsfExe::GetDescriptiveNameFor	(	const std::string &	aApplicationName,
		const std::string &	aVersion )

static

Referenced by GetDescriptiveName().

◆ GetGrammar()

const std::string & wizard::WsfExe::GetGrammar ( )

References mGrammarText.

◆ GetGrammarDocumentation()

std::shared_ptr< wizard::GrammarDocumentation > wizard::WsfExe::GetGrammarDocumentation ( )

References GetParseDefinitions(), mGrammarDocumentation, mGrammarDocumentationFuture, and mGrammarDocumentationFutureStarted.

Referenced by wizard::DocumentationInterpretter::LookupDocumentationUrl(), wizard::EditAssist_Type2::SetTypeData(), and wizard::EditAssist_Type::SetTypeData().

◆ GetGrammarVersion()

GrammarVersion wizard::WsfExe::GetGrammarVersion ( ) const

inline

References mGrammarVersion.

◆ GetParseDefinitions()

std::shared_ptr< WsfParseDefinitions > wizard::WsfExe::GetParseDefinitions ( )

References BeginBuildDoc(), BuildProxyRegistry(), GetDescriptiveName(), mGrammarText, mGrammarVersion, mParseDefinitions, ok, and wizExeMgr.

Referenced by GetGrammarDocumentation(), LoadFromDisk(), and wizard::ParseWorker::UpdateParseDefinitions().

◆ GetPath()

const UtPath & wizard::WsfExe::GetPath ( ) const

inline

References mExePath.

Referenced by wizard::WsfExecution::NewExecution(), wizard::WsfExeManager::Refresh(), and wizard::Project::SetExe().

◆ GetProxyRegistry()

std::shared_ptr< WsfPProxyRegistry > wizard::WsfExe::GetProxyRegistry ( ) const

inline

References mProxyRegistry.

Referenced by wizard::ParseWorker::UpdateParseDefinitions().

◆ GetStyler()

WsfStyler * wizard::WsfExe::GetStyler ( )

inline

References mWSF_StylerPtr.

Referenced by WsfExe(), and WsfExe().

◆ GetVersion()

const std::string & wizard::WsfExe::GetVersion ( ) const

inline

References mVersion.

◆ GiveScriptTypes()

void wizard::WsfExe::GiveScriptTypes ( WsfScriptTypes * aScriptTypesPtr )

References mGivenScriptTypes, and mScriptTypesObjects.

◆ IsLoaded()

bool wizard::WsfExe::IsLoaded ( ) const

References mGrammarText.

Referenced by operator=().

◆ LoadFromDisk()

bool wizard::WsfExe::LoadFromDisk ( )

References BuildProxyRegistry(), Cleanup(), GetParseDefinitions(), wizard::Util::IsExecutable(), wizard::Util::MakeTempFileName(), mApplication, mExePath, mGrammarDocumentation, mGrammarText, mParseDefinitions, mVersion, ProcessData(), wizExeMgr, and WsfExe().

Referenced by FromDisk(), operator=(), and wizard::WsfExeManager::Refresh().

◆ operator=() [1/2]

WsfExe & wizard::WsfExe::operator= ( const WsfExe & )

delete

References WsfExe().

◆ operator=() [2/2]

WsfExe & wizard::WsfExe::operator= ( WsfExe && )

default

References FromDisk(), IsLoaded(), LoadFromDisk(), and WsfExe().

◆ ProcessData()

void wizard::WsfExe::ProcessData	(	const std::string &	aBlockName,
		const std::string &	aText )

protected

References mApplication, mGrammarText, and mVersion.

Referenced by LoadFromDisk().

◆ SetAlias()

void wizard::WsfExe::SetAlias ( const std::string & aAlias )

inline

References mAlias.

Referenced by wizard::WsfExeManager::Add().

◆ TakeScriptTypes()

wizard::WsfScriptTypes * wizard::WsfExe::TakeScriptTypes ( )

References mGivenScriptTypes, mParseDefinitions, and mScriptTypesObjects.

Referenced by wizard::ParseWorker::UpdateParseDefinitions().

Member Data Documentation

◆ ExeUpdated

UtCallbackListN< void(wizard::WsfExe *)> wizard::WsfExe::ExeUpdated

static

Referenced by wizard::Project::Project().

◆ mAlias

std::string wizard::WsfExe::mAlias

protected

Referenced by ExeTypeToXML(), GetAlias(), SetAlias(), and WsfExe().

◆ mApplication

std::string wizard::WsfExe::mApplication

protected

Referenced by ExeTypeToXML(), GetApplication(), GetDescriptiveName(), LoadFromDisk(), ProcessData(), and WsfExe().

◆ mExePath

UtPath wizard::WsfExe::mExePath

protected

Referenced by ExeTypeToXML(), GetPath(), LoadFromDisk(), and WsfExe().

◆ mGivenScriptTypes

std::set<WsfScriptTypes*> wizard::WsfExe::mGivenScriptTypes

protected

Referenced by Cleanup(), GiveScriptTypes(), and TakeScriptTypes().

◆ mGrammarDocumentation

std::shared_ptr<GrammarDocumentation> wizard::WsfExe::mGrammarDocumentation

protected

Referenced by GetGrammarDocumentation(), and LoadFromDisk().

◆ mGrammarDocumentationFuture

QFuture<std::shared_ptr<GrammarDocumentation> > wizard::WsfExe::mGrammarDocumentationFuture

protected

Referenced by BeginBuildDoc(), and GetGrammarDocumentation().

◆ mGrammarDocumentationFutureStarted

bool wizard::WsfExe::mGrammarDocumentationFutureStarted

protected

Referenced by BeginBuildDoc(), GetGrammarDocumentation(), WsfExe(), and WsfExe().

◆ mGrammarText

std::string wizard::WsfExe::mGrammarText

protected

Referenced by GetGrammar(), GetParseDefinitions(), IsLoaded(), LoadFromDisk(), ProcessData(), and WsfExe().

◆ mGrammarVersion

GrammarVersion wizard::WsfExe::mGrammarVersion

protected

Referenced by GetGrammarVersion(), GetParseDefinitions(), and WsfExe().

◆ mParseDefinitions

std::shared_ptr<WsfParseDefinitions> wizard::WsfExe::mParseDefinitions

protected

Referenced by BeginBuildDoc(), BuildProxyRegistry(), GetParseDefinitions(), LoadFromDisk(), TakeScriptTypes(), and WsfExe().

◆ mProxyRegistry

std::shared_ptr<WsfPProxyRegistry> wizard::WsfExe::mProxyRegistry

protected

Referenced by BuildProxyRegistry(), and GetProxyRegistry().

◆ mScriptTypesObjects

std::vector<WsfScriptTypes*> wizard::WsfExe::mScriptTypesObjects

protected

Referenced by Cleanup(), GiveScriptTypes(), and TakeScriptTypes().

◆ mVersion

std::string wizard::WsfExe::mVersion

protected

Referenced by ExeTypeToXML(), GetDescriptiveName(), GetVersion(), LoadFromDisk(), and ProcessData().

◆ mWSF_StylerPtr

WsfStyler* wizard::WsfExe::mWSF_StylerPtr

protected

Referenced by GetStyler(), WsfExe(), and WsfExe().

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

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ WsfExe() [1/4]

◆ WsfExe() [2/4]

◆ WsfExe() [3/4]

◆ WsfExe() [4/4]

◆ ~WsfExe()

Member Function Documentation

◆ BeginBuildDoc()

◆ BuildProxyRegistry()

◆ Cleanup()

◆ ExeTypeToXML()

◆ FromDisk()

◆ GetAlias()

◆ GetApplication()

◆ GetDescriptiveName()

◆ GetDescriptiveNameFor()

◆ GetGrammar()

◆ GetGrammarDocumentation()

◆ GetGrammarVersion()

◆ GetParseDefinitions()

◆ GetPath()

◆ GetProxyRegistry()

◆ GetStyler()

◆ GetVersion()

◆ GiveScriptTypes()

◆ IsLoaded()

◆ LoadFromDisk()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ ProcessData()

◆ SetAlias()

◆ TakeScriptTypes()

Member Data Documentation

◆ ExeUpdated

◆ mAlias

◆ mApplication

◆ mExePath

◆ mGivenScriptTypes

◆ mGrammarDocumentation

◆ mGrammarDocumentationFuture

◆ mGrammarDocumentationFutureStarted

◆ mGrammarText

◆ mGrammarVersion

◆ mParseDefinitions

◆ mProxyRegistry

◆ mScriptTypesObjects

◆ mVersion

◆ mWSF_StylerPtr