#include <libmythfreemheg/Engine.h>

Inheritance diagram for MHEngine:

Collaboration diagram for MHEngine:

Public Member Functions
	MHEngine (MHContext *context)

	~MHEngine () override

void	SetBooting () override

void	DrawDisplay (const QRegion &toDraw) override

void	BootApplication (const char *fileName)

void	TransitionToScene (const MHObjectRef &target)

bool	Launch (const MHObjectRef &target, bool fIsSpawn=false)

void	Spawn (const MHObjectRef &target)

void	Quit ()

MHRoot *	FindObject (const MHObjectRef &oRef, bool failOnNotFound=true)

void	EventTriggered (MHRoot *pSource, enum EventType ev)

void	EventTriggered (MHRoot *pSource, enum EventType ev, const MHUnion &evData)

void	AddActions (const MHActionSequence &actions)

void	AddToDisplayStack (MHVisible *pVis)

void	RemoveFromDisplayStack (MHVisible *pVis)

void	Redraw (const QRegion &region)

void	BringToFront (const MHRoot *pVis)

void	SendToBack (const MHRoot *pVis)

void	PutBefore (const MHRoot pVis, const MHRoot pRef)

void	PutBehind (const MHRoot pVis, const MHRoot pRef)

void	LockScreen ()

void	UnlockScreen ()

std::chrono::milliseconds	RunAll (void) override

void	RunActions ()

void	GenerateUserAction (int nCode) override

void	EngineEvent (int nCode) override

void	StreamStarted (MHStream *stream, bool bStarted) override

void	RequestExternalContent (MHIngredient *pRequester)

void	CancelExternalContentRequest (MHIngredient *pRequester)

bool	LoadStorePersistent (bool fIsLoad, const MHOctetString &fileName, const MHSequence< MHObjectRef * > &variables)

void	AddLink (MHLink *pLink)

void	RemoveLink (MHLink *pLink)

bool	InTransition () const

bool	GetEngineSupport (const MHOctetString &feature)

int	GetDefaultCharSet ()

void	GetDefaultBGColour (MHColour &colour)

void	GetDefaultTextColour (MHColour &colour)

void	GetDefaultButtonRefColour (MHColour &colour)

void	GetDefaultHighlightRefColour (MHColour &colour)

void	GetDefaultSliderRefColour (MHColour &colour)

int	GetDefaultTextCHook ()

int	GetDefaultStreamCHook ()

int	GetDefaultBitmapCHook ()

void	GetDefaultFontAttrs (MHOctetString &str)

void	SetInputRegister (int nReg)

MHOctetString &	GetGroupId ()

MHContext *	GetContext ()

QString	GetPathName (const MHOctetString &str)

MHInteractible *	GetInteraction (void)

void	SetInteraction (MHInteractible *p)

int	GetTuneInfo ()

void	SetTuneInfo (int tuneinfo)

Public Member Functions inherited from MHEG
virtual	~MHEG ()=default

virtual void	SetBooting ()=0

virtual void	DrawDisplay (const QRegion &toDraw)=0

virtual std::chrono::milliseconds	RunAll (void)=0

virtual void	GenerateUserAction (int nCode)=0

virtual void	EngineEvent (int)=0

virtual void	StreamStarted (MHStream *, bool bStarted=true)=0

Static Public Attributes
static const char *	MHEGEngineProviderIdString = "MHGGNU001"

Protected Member Functions
void	CheckLinks (const MHObjectRef &sourceRef, enum EventType ev, const MHUnion &un)

MHGroup *	ParseProgram (QByteArray &text)

void	DrawRegion (const QRegion &toDraw, int nStackPos)

MHApplication *	CurrentApp ()

MHScene *	CurrentScene ()

void	CheckContentRequests ()

Protected Attributes
QRegion	m_redrawRegion

QStack< MHApplication * >	m_applicationStack

QStack< MHElemAction * >	m_actionStack

QQueue< MHAsynchEvent * >	m_eventQueue

QList< MHLink * >	m_linkTable

QList< MHExternContent * >	m_externContentTable

MHOwnPtrSequence< MHPSEntry >	m_persistentStore

bool	m_fInTransition {false}

MHOctetString	m_currentGroupId

MHContext *	m_context {nullptr}

bool	m_fBooting {true}

MHInteractible *	m_interacting {nullptr}

Detailed Description

Definition at line 72 of file Engine.h.

Constructor & Destructor Documentation

◆ MHEngine()

MHEngine::MHEngine ( MHContext * context )

explicit

Definition at line 49 of file Engine.cpp.

◆ ~MHEngine()

MHEngine::~MHEngine ( )

override

Definition at line 60 of file Engine.cpp.

Member Function Documentation

◆ AddActions()

void MHEngine::AddActions ( const MHActionSequence & actions )

Definition at line 729 of file Engine.cpp.

Referenced by MHGroup::Activation(), MHApplication::Activation(), MHTokenGroup::CallActionSlot(), MHGroup::Deactivation(), Launch(), and MHLink::MatchEvent().

◆ AddLink()

void MHEngine::AddLink ( MHLink * pLink )

Definition at line 718 of file Engine.cpp.

Referenced by MHLink::Activation().

◆ AddToDisplayStack()

void MHEngine::AddToDisplayStack ( MHVisible * pVis )

Definition at line 739 of file Engine.cpp.

Referenced by MHVisible::Preparation().

◆ BootApplication()

void MHEngine::BootApplication ( const char * fileName )

◆ BringToFront()

void MHEngine::BringToFront ( const MHRoot * pVis )

Definition at line 771 of file Engine.cpp.

Referenced by MHVisible::BringToFront().

◆ CancelExternalContentRequest()

void MHEngine::CancelExternalContentRequest ( MHIngredient * pRequester )

Definition at line 1064 of file Engine.cpp.

Referenced by MHIngredient::ContentPreparation(), MHIngredient::Destruction(), and RequestExternalContent().

◆ CheckContentRequests()

void MHEngine::CheckContentRequests ( )

protected

Definition at line 1085 of file Engine.cpp.

Referenced by RunAll().

◆ CheckLinks()

void MHEngine::CheckLinks	(	const MHObjectRef &	sourceRef,
		enum EventType	ev,
		const MHUnion &	un
	)

protected

Definition at line 711 of file Engine.cpp.

Referenced by EventTriggered(), and RunAll().

◆ CurrentApp()

MHApplication * MHEngine::CurrentApp ( )

inlineprotected

◆ CurrentScene()

MHScene * MHEngine::CurrentScene ( )

inlineprotected

Definition at line 181 of file Engine.h.

Referenced by FindObject(), GenerateUserAction(), Launch(), Quit(), RunAll(), and TransitionToScene().

◆ DrawDisplay()

void MHEngine::DrawDisplay ( const QRegion & toDraw )

overridevirtual

Implements MHEG.

Definition at line 912 of file Engine.cpp.

◆ DrawRegion()

void MHEngine::DrawRegion	(	const QRegion &	toDraw,
		int	nStackPos
	)

protected

Definition at line 875 of file Engine.cpp.

Referenced by DrawDisplay(), and DrawRegion().

◆ EngineEvent()

void MHEngine::EngineEvent ( int nCode )

overridevirtual

Implements MHEG.

Definition at line 985 of file Engine.cpp.

Referenced by CheckContentRequests(), GenerateUserAction(), Launch(), RequestExternalContent(), and TransitionToScene().

◆ EventTriggered() [1/2]

void MHEngine::EventTriggered	(	MHRoot *	pSource,
		enum EventType	ev
	)

inline

Definition at line 94 of file Engine.h.

Referenced by MHScene::Activation(), MHApplication::Activation(), MHLink::Activation(), MHProgram::Activation(), MHStream::Activation(), MHAudio::Activation(), MHTokenGroup::Activation(), MHVariable::Activation(), MHVisible::Activation(), MHStream::BeginPlaying(), MHResidentProgram::CallProgram(), MHGroup::CheckTimers(), MHBitmap::ContentArrived(), MHText::ContentArrived(), MHIngredient::ContentPreparation(), MHStream::ContentPreparation(), MHVideo::ContentPreparation(), MHRoot::Deactivation(), MHTokenGroup::Deactivation(), MHSlider::Decrement(), MHListGroup::Deselect(), MHRoot::Destruction(), EngineEvent(), EventTriggered(), GenerateUserAction(), MHSlider::Increment(), MHInteractible::InteractSetHighlightStatus(), MHInteractible::InteractSetInteractionStatus(), MHSlider::KeyEvent(), MHSendEvent::Perform(), MHRoot::Preparation(), MHListGroup::Select(), MHSlider::SetPortion(), MHSlider::SetSliderParameters(), MHSlider::SetSliderValue(), MHSlider::Step(), MHStream::StopPlaying(), StreamStarted(), MHBooleanVar::TestVariable(), MHOctetStrVar::TestVariable(), MHObjectRefVar::TestVariable(), MHContentRefVar::TestVariable(), MHIntegerVar::TestVariable(), MHTokenGroup::TransferToken(), and MHListGroup::Update().

◆ EventTriggered() [2/2]

void MHEngine::EventTriggered	(	MHRoot *	pSource,
		enum EventType	ev,
		const MHUnion &	evData
	)

Definition at line 645 of file Engine.cpp.

◆ FindObject()

MHRoot * MHEngine::FindObject	(	const MHObjectRef &	oRef,
		bool	failOnNotFound = `true`
	)

Definition at line 574 of file Engine.cpp.

Referenced by MHTokenGroup::Activation(), MHClone::CallAction(), MHResidentProgram::CallProgram(), MHListGroup::GetCellItem(), MHListGroup::GetItemStatus(), MHListGroup::GetListItem(), MHGenericContentRef::GetValue(), MHGenericBoolean::GetValue(), MHGenericInteger::GetValue(), MHGenericObjectRef::GetValue(), MHGenericOctetString::GetValue(), LoadStorePersistent(), MHActionObjectRef::Perform(), MHActionObjectRef2::Perform(), MHActionGenericObjectRef::Perform(), MHSendEvent::Perform(), MHPersistent::Perform(), MHGetEngineSupport::Perform(), MHSetData::Perform(), MHGetAvailabilityStatus::Perform(), MHActionGenericObjectRefFix::Perform(), MHAddItem::Perform(), MHSetVariable::Perform(), MHTestVariable::Perform(), MHIntegerAction::Perform(), MHAppend::Perform(), MHListGroup::Preparation(), SetSuccessFlag(), and MHElemAction::Target().

◆ GenerateUserAction()

void MHEngine::GenerateUserAction ( int nCode )

overridevirtual

Implements MHEG.

Definition at line 945 of file Engine.cpp.

◆ GetContext()

◆ GetDefaultBGColour()

void MHEngine::GetDefaultBGColour ( MHColour & colour )

Definition at line 1402 of file Engine.cpp.

Referenced by MHText::Preparation().

◆ GetDefaultBitmapCHook()

int MHEngine::GetDefaultBitmapCHook ( )

Definition at line 1494 of file Engine.cpp.

Referenced by MHBitmap::CreateContent().

◆ GetDefaultButtonRefColour()

void MHEngine::GetDefaultButtonRefColour ( MHColour & colour )

Definition at line 1430 of file Engine.cpp.

◆ GetDefaultCharSet()

int MHEngine::GetDefaultCharSet ( )

Definition at line 1391 of file Engine.cpp.

◆ GetDefaultFontAttrs()

void MHEngine::GetDefaultFontAttrs ( MHOctetString & str )

Definition at line 1505 of file Engine.cpp.

Referenced by MHText::Preparation().

◆ GetDefaultHighlightRefColour()

void MHEngine::GetDefaultHighlightRefColour ( MHColour & colour )

Definition at line 1444 of file Engine.cpp.

Referenced by MHInteractible::Initialise().

◆ GetDefaultSliderRefColour()

void MHEngine::GetDefaultSliderRefColour ( MHColour & colour )

Definition at line 1458 of file Engine.cpp.

Referenced by MHSlider::Initialise().

◆ GetDefaultStreamCHook()

int MHEngine::GetDefaultStreamCHook ( )

Definition at line 1483 of file Engine.cpp.

◆ GetDefaultTextCHook()

int MHEngine::GetDefaultTextCHook ( )

Definition at line 1472 of file Engine.cpp.

◆ GetDefaultTextColour()

void MHEngine::GetDefaultTextColour ( MHColour & colour )

Definition at line 1416 of file Engine.cpp.

Referenced by MHText::Preparation().

◆ GetEngineSupport()

bool MHEngine::GetEngineSupport ( const MHOctetString & feature )

Definition at line 1234 of file Engine.cpp.

Referenced by MHGetEngineSupport::Perform().

◆ GetGroupId()

MHOctetString & MHEngine::GetGroupId ( )

inline

Definition at line 153 of file Engine.h.

Referenced by MHObjectRef::Initialise(), and MHGroup::Initialise().

◆ GetInteraction()

MHInteractible * MHEngine::GetInteraction ( void )

inline

Definition at line 161 of file Engine.h.

Referenced by MHInteractible::InteractSetInteractionStatus().

◆ GetPathName()

QString MHEngine::GetPathName ( const MHOctetString & str )

Definition at line 523 of file Engine.cpp.

Referenced by MHResidentProgram::CallProgram(), MHContentRef::Equal(), MHObjectRef::Equal(), FindObject(), Launch(), RequestExternalContent(), and TransitionToScene().

◆ GetTuneInfo()

int MHEngine::GetTuneInfo ( )

inline

Definition at line 164 of file Engine.h.

Referenced by MHResidentProgram::CallProgram().

◆ InTransition()

bool MHEngine::InTransition ( ) const

inline

Definition at line 135 of file Engine.h.

◆ Launch()

bool MHEngine::Launch	(	const MHObjectRef &	target,
		bool	fIsSpawn = `false`
	)

Definition at line 263 of file Engine.cpp.

Referenced by MHLaunch::Perform(), RunAll(), and Spawn().

◆ LoadStorePersistent()

bool MHEngine::LoadStorePersistent	(	bool	fIsLoad,
		const MHOctetString &	fileName,
		const MHSequence< MHObjectRef * > &	variables
	)

Definition at line 1152 of file Engine.cpp.

Referenced by MHPersistent::Perform().

◆ LockScreen()

void MHEngine::LockScreen ( )

inline

Definition at line 110 of file Engine.h.

Referenced by MHLockScreen::Perform().

◆ ParseProgram()

MHGroup * MHEngine::ParseProgram ( QByteArray & text )

protected

Definition at line 198 of file Engine.cpp.

Referenced by Launch(), and TransitionToScene().

◆ PutBefore()

void MHEngine::PutBefore	(	const MHRoot *	pVis,
		const MHRoot *	pRef
	)

Definition at line 807 of file Engine.cpp.

Referenced by MHVisible::PutBefore().

◆ PutBehind()

void MHEngine::PutBehind	(	const MHRoot *	pVis,
		const MHRoot *	pRef
	)

Definition at line 841 of file Engine.cpp.

Referenced by MHVisible::PutBehind().

◆ Quit()

void MHEngine::Quit ( )

Definition at line 367 of file Engine.cpp.

Referenced by MHQuit::Perform().

◆ Redraw()

void MHEngine::Redraw ( const QRegion & region )

Definition at line 926 of file Engine.cpp.

Referenced by MHVisible::Activation(), AddToDisplayStack(), BringToFront(), MHBitmap::CreateContent(), MHText::CreateContent(), MHVisible::Deactivation(), MHSlider::Decrement(), MHDynamicLineArt::DrawArcSector(), MHDynamicLineArt::DrawLine(), MHDynamicLineArt::DrawOval(), MHDynamicLineArt::DrawPoly(), MHDynamicLineArt::DrawRectangle(), MHSlider::Increment(), MHSlider::InteractionCompleted(), MHInteractible::InteractSetHighlightStatus(), PutBefore(), PutBehind(), RemoveFromDisplayStack(), MHBitmap::ScaleBitmap(), MHVideo::ScaleVideo(), SendToBack(), MHText::SetBackgroundColour(), MHBitmap::SetBitmapDecodeOffset(), MHVisible::SetBoxSize(), MHLineArt::SetFillColour(), MHText::SetFontAttributes(), MHLineArt::SetLineColour(), MHLineArt::SetLineStyle(), MHLineArt::SetLineWidth(), MHVisible::SetPaletteRef(), MHSlider::SetPortion(), MHVisible::SetPosition(), MHSlider::SetSliderParameters(), MHSlider::SetSliderValue(), MHText::SetTextColour(), MHVideo::SetVideoDecodeOffset(), and MHSlider::Step().

◆ RemoveFromDisplayStack()

void MHEngine::RemoveFromDisplayStack ( MHVisible * pVis )

Definition at line 754 of file Engine.cpp.

Referenced by MHVisible::Destruction().

◆ RemoveLink()

void MHEngine::RemoveLink ( MHLink * pLink )

Definition at line 723 of file Engine.cpp.

Referenced by MHLink::Deactivation().

◆ RequestExternalContent()

void MHEngine::RequestExternalContent ( MHIngredient * pRequester )

Definition at line 999 of file Engine.cpp.

Referenced by MHIngredient::ContentPreparation().

◆ RunActions()

void MHEngine::RunActions ( )

Definition at line 614 of file Engine.cpp.

Referenced by MHGroup::Activation(), MHApplication::Activation(), MHGroup::Deactivation(), Launch(), and RunAll().

◆ RunAll()

std::chrono::milliseconds MHEngine::RunAll ( void )

overridevirtual

Implements MHEG.

Definition at line 82 of file Engine.cpp.

◆ SendToBack()

void MHEngine::SendToBack ( const MHRoot * pVis )

Definition at line 789 of file Engine.cpp.

Referenced by MHVisible::SendToBack().

◆ SetBooting()

void MHEngine::SetBooting ( )

inlineoverridevirtual

Implements MHEG.

Definition at line 77 of file Engine.h.

◆ SetInputRegister()

void MHEngine::SetInputRegister ( int nReg )

Definition at line 517 of file Engine.cpp.

Referenced by MHScene::SetInputRegister(), and TransitionToScene().

◆ SetInteraction()

void MHEngine::SetInteraction ( MHInteractible * p )

inline

Definition at line 162 of file Engine.h.

Referenced by MHInteractible::Interaction(), MHInteractible::InteractSetInteractionStatus(), and MHSlider::KeyEvent().

◆ SetTuneInfo()

void MHEngine::SetTuneInfo ( int tuneinfo )

inline

Definition at line 165 of file Engine.h.

Referenced by MHResidentProgram::CallProgram().

◆ Spawn()

void MHEngine::Spawn ( const MHObjectRef & target )

inline

Definition at line 85 of file Engine.h.

Referenced by MHSpawn::Perform().

◆ StreamStarted()

void MHEngine::StreamStarted	(	MHStream *	stream,
		bool	bStarted
	)

overridevirtual

Implements MHEG.

Definition at line 993 of file Engine.cpp.

◆ TransitionToScene()

void MHEngine::TransitionToScene ( const MHObjectRef & target )

Definition at line 409 of file Engine.cpp.

Referenced by MHTransitionTo::Perform().

◆ UnlockScreen()

void MHEngine::UnlockScreen ( )

Definition at line 932 of file Engine.cpp.

Referenced by MHUnlockScreen::Perform().

Member Data Documentation

◆ m_actionStack

QStack<MHElemAction*> MHEngine::m_actionStack

protected

Definition at line 189 of file Engine.h.

Referenced by AddActions(), Launch(), RunActions(), RunAll(), and TransitionToScene().

◆ m_applicationStack

QStack<MHApplication*> MHEngine::m_applicationStack

protected

Definition at line 175 of file Engine.h.

Referenced by CurrentApp(), Launch(), Quit(), RunAll(), and ~MHEngine().

◆ m_context

MHContext* MHEngine::m_context {nullptr}

protected

Definition at line 211 of file Engine.h.

Referenced by CheckContentRequests(), DrawRegion(), GetContext(), GetEngineSupport(), Launch(), RequestExternalContent(), RunAll(), SetInputRegister(), and TransitionToScene().

◆ m_currentGroupId

MHOctetString MHEngine::m_currentGroupId

protected

Definition at line 209 of file Engine.h.

Referenced by GetGroupId().

◆ m_eventQueue

QQueue<MHAsynchEvent*> MHEngine::m_eventQueue

protected

Definition at line 193 of file Engine.h.

Referenced by EventTriggered(), Launch(), Quit(), RunAll(), TransitionToScene(), and ~MHEngine().

◆ m_externContentTable

QList<MHExternContent*> MHEngine::m_externContentTable

protected

Definition at line 200 of file Engine.h.

Referenced by CancelExternalContentRequest(), CheckContentRequests(), RequestExternalContent(), RunAll(), and ~MHEngine().

◆ m_fBooting

bool MHEngine::m_fBooting {true}

protected

Definition at line 212 of file Engine.h.

Referenced by DrawDisplay(), EngineEvent(), Launch(), Quit(), RunAll(), and SetBooting().

◆ m_fInTransition

bool MHEngine::m_fInTransition {false}

protected

Definition at line 205 of file Engine.h.

Referenced by InTransition(), Launch(), Quit(), and TransitionToScene().

◆ m_interacting

MHInteractible* MHEngine::m_interacting {nullptr}

protected

Definition at line 214 of file Engine.h.

Referenced by GenerateUserAction(), GetInteraction(), SetInteraction(), and TransitionToScene().

◆ m_linkTable

QList<MHLink*> MHEngine::m_linkTable

protected

Definition at line 196 of file Engine.h.

Referenced by AddLink(), CheckLinks(), RemoveLink(), and RunAll().

◆ m_persistentStore

MHOwnPtrSequence<MHPSEntry> MHEngine::m_persistentStore

protected

Definition at line 203 of file Engine.h.

Referenced by LoadStorePersistent(), and MHEngine().

◆ m_redrawRegion

QRegion MHEngine::m_redrawRegion

protected

Definition at line 172 of file Engine.h.

Referenced by Redraw(), RunAll(), and TransitionToScene().

◆ MHEGEngineProviderIdString

const char * MHEngine::MHEGEngineProviderIdString = "MHGGNU001"

static

Definition at line 158 of file Engine.h.

Referenced by MHResidentProgram::CallProgram(), and GetEngineSupport().

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

mythtv/libs/libmythfreemheg/Engine.h
mythtv/libs/libmythfreemheg/Engine.cpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MHEngine()

◆ ~MHEngine()

Member Function Documentation

◆ AddActions()

◆ AddLink()

◆ AddToDisplayStack()

◆ BootApplication()

◆ BringToFront()

◆ CancelExternalContentRequest()

◆ CheckContentRequests()

◆ CheckLinks()

◆ CurrentApp()

◆ CurrentScene()

◆ DrawDisplay()

◆ DrawRegion()

◆ EngineEvent()

◆ EventTriggered() [1/2]

◆ EventTriggered() [2/2]

◆ FindObject()

◆ GenerateUserAction()

◆ GetContext()

◆ GetDefaultBGColour()

◆ GetDefaultBitmapCHook()

◆ GetDefaultButtonRefColour()

◆ GetDefaultCharSet()

◆ GetDefaultFontAttrs()

◆ GetDefaultHighlightRefColour()

◆ GetDefaultSliderRefColour()

◆ GetDefaultStreamCHook()

◆ GetDefaultTextCHook()

◆ GetDefaultTextColour()

◆ GetEngineSupport()

◆ GetGroupId()

◆ GetInteraction()

◆ GetPathName()

◆ GetTuneInfo()

◆ InTransition()

◆ Launch()

◆ LoadStorePersistent()

◆ LockScreen()

◆ ParseProgram()

◆ PutBefore()

◆ PutBehind()

◆ Quit()

◆ Redraw()

◆ RemoveFromDisplayStack()

◆ RemoveLink()

◆ RequestExternalContent()

◆ RunActions()

◆ RunAll()

◆ SendToBack()

◆ SetBooting()

◆ SetInputRegister()

◆ SetInteraction()

◆ SetTuneInfo()

◆ Spawn()

◆ StreamStarted()

◆ TransitionToScene()

◆ UnlockScreen()

Member Data Documentation

◆ m_actionStack

◆ m_applicationStack

◆ m_context

◆ m_currentGroupId

◆ m_eventQueue

◆ m_externContentTable

◆ m_fBooting

◆ m_fInTransition

◆ m_interacting

◆ m_linkTable

◆ m_persistentStore

◆ m_redrawRegion

◆ MHEGEngineProviderIdString