Kodi Documentation  18.0
Kodi is an open source media player and entertainment hub.
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CPythonInvoker Class Reference

#include <PythonInvoker.h>

Inheritance diagram for CPythonInvoker:
ILanguageInvoker CAddonPythonInvoker CHTTPPythonInvoker CContextItemAddonInvoker CHTTPPythonWsgiInvoker

Public Types

typedef void(* PythonModuleInitialization) ()
 

Public Member Functions

 CPythonInvoker (ILanguageInvocationHandler *invocationHandler)
 
 ~CPythonInvoker () override
 
bool Execute (const std::string &script, const std::vector< std::string > &arguments=std::vector< std::string >()) override
 
bool IsStopping () const override
 
- Public Member Functions inherited from ILanguageInvoker
 ILanguageInvoker (ILanguageInvocationHandler *invocationHandler)
 
virtual ~ILanguageInvoker ()
 
virtual bool Stop (bool abort=false)
 
void SetId (int id)
 
int GetId () const
 
const ADDON::AddonPtr & GetAddon () const
 
void SetAddon (const ADDON::AddonPtr &addon)
 
InvokerState GetState () const
 
bool IsActive () const
 
bool IsRunning () const
 
void Reset ()
 

Protected Member Functions

bool execute (const std::string &script, const std::vector< std::string > &arguments) override
 
virtual void executeScript (void *fp, const std::string &script, void *module, void *moduleDict)
 
bool stop (bool abort) override
 
void onExecutionDone () override
 
void onExecutionFailed () override
 
virtual std::map< std::string, PythonModuleInitialization > getModules () const
 
virtual const char * getInitializationScript () const
 
virtual void onInitialization ()
 
virtual void onPythonModuleInitialization (void *moduleDict)
 
virtual void onDeinitialization ()
 
virtual void onSuccess ()
 
virtual void onAbort ()
 
virtual void onError (const std::string &exceptionType="", const std::string &exceptionValue="", const std::string &exceptionTraceback="")
 
- Protected Member Functions inherited from ILanguageInvoker
virtual void pulseGlobalEvent ()
 
virtual bool onExecutionInitialized ()
 
virtual void onAbortRequested ()
 
virtual void onExecutionFinalized ()
 
void setState (InvokerState state)
 

Protected Attributes

std::string m_sourceFile
 
CCriticalSection m_critical
 
- Protected Attributes inherited from ILanguageInvoker
ADDON::AddonPtr m_addon
 

Member Typedef Documentation

§ PythonModuleInitialization

typedef void(* CPythonInvoker::PythonModuleInitialization) ()

Constructor & Destructor Documentation

§ CPythonInvoker()

CPythonInvoker::CPythonInvoker ( ILanguageInvocationHandler *  invocationHandler)
explicit

§ ~CPythonInvoker()

CPythonInvoker::~CPythonInvoker ( )
override

Member Function Documentation

§ Execute()

bool CPythonInvoker::Execute ( const std::string &  script,
const std::vector< std::string > &  arguments = std::vector<std::string>() 
)
overridevirtual

Reimplemented from ILanguageInvoker.

§ execute()

bool CPythonInvoker::execute ( const std::string &  script,
const std::vector< std::string > &  arguments 
)
overrideprotectedvirtual
Bug:
libpython < 3.0 isn't const correct
Bug:
libpython isn't const correct

Implements ILanguageInvoker.

§ executeScript()

void CPythonInvoker::executeScript ( void *  fp,
const std::string &  script,
void *  module,
void *  moduleDict 
)
protectedvirtual

Reimplemented in CHTTPPythonWsgiInvoker.

§ getInitializationScript()

const char * CPythonInvoker::getInitializationScript ( ) const
protectedvirtual

Reimplemented in CHTTPPythonWsgiInvoker, and CAddonPythonInvoker.

§ getModules()

std::map< std::string, CPythonInvoker::PythonModuleInitialization > CPythonInvoker::getModules ( ) const
protectedvirtual

Reimplemented in CHTTPPythonWsgiInvoker, and CAddonPythonInvoker.

§ IsStopping()

bool CPythonInvoker::IsStopping ( ) const
inlineoverridevirtual

Reimplemented from ILanguageInvoker.

§ onAbort()

virtual void CPythonInvoker::onAbort ( )
inlineprotectedvirtual

Reimplemented in CHTTPPythonInvoker.

§ onDeinitialization()

void CPythonInvoker::onDeinitialization ( )
protectedvirtual

§ onError()

void CPythonInvoker::onError ( const std::string &  exceptionType = "",
const std::string &  exceptionValue = "",
const std::string &  exceptionTraceback = "" 
)
protectedvirtual

Reimplemented in CHTTPPythonInvoker.

§ onExecutionDone()

void CPythonInvoker::onExecutionDone ( )
overrideprotectedvirtual

Reimplemented from ILanguageInvoker.

§ onExecutionFailed()

void CPythonInvoker::onExecutionFailed ( )
overrideprotectedvirtual

Reimplemented from ILanguageInvoker.

§ onInitialization()

void CPythonInvoker::onInitialization ( )
protectedvirtual

§ onPythonModuleInitialization()

void CPythonInvoker::onPythonModuleInitialization ( void *  moduleDict)
protectedvirtual

Reimplemented in CContextItemAddonInvoker.

§ onSuccess()

virtual void CPythonInvoker::onSuccess ( )
inlineprotectedvirtual

§ stop()

bool CPythonInvoker::stop ( bool  abort)
overrideprotectedvirtual

Implements ILanguageInvoker.

Member Data Documentation

§ m_critical

CCriticalSection CPythonInvoker::m_critical
protected

§ m_sourceFile

std::string CPythonInvoker::m_sourceFile
protected
The documentation for this class was generated from the following files: