Scripting::PythonServer Class Reference

#include <pythonserver.h>

Detailed Description

Python backend for the Nebula scripting subsystem.

Copyright

(C) 2018-2020 Individual contributors, see AUTHORS file

Inherits Scripting::ScriptServer.

Public Member Functions
	PythonServer ()
	constructor
virtual	~PythonServer ()
	destructor
bool	Open ()
	open the script server
void	Close ()
	close the script server
void	AddModulePath (const IO::URI &folder)
	add module search path
bool	Eval (const Util::String &str)
	evaluate a script statement in a string
bool	EvalFile (const IO::URI &file)
	evaluate script in file
Public Member Functions inherited from Scripting::ScriptServer
	ScriptServer ()
	constructor
virtual	~ScriptServer ()
	destructor
bool	IsOpen () const
	return true if open
void	SetDebug (const bool b)
	set debugging with the HTTP interface
Public Member Functions inherited from Core::RefCounted
	RefCounted ()
	constructor
int	GetRefCount () const
	get the current refcount
void	AddRef ()
	increment refcount by one
void	Release ()
	decrement refcount and destroy object if refcount is zero
bool	IsInstanceOf (const Rtti &rtti) const
	return true if this object is instance of given class
bool	IsInstanceOf (const Util::String &className) const
	return true if this object is instance of given class by string
bool	IsInstanceOf (const Util::FourCC &classFourCC) const
	return true if this object is instance of given class by fourcc
bool	IsA (const Rtti &rtti) const
	return true if this object is instance of given class, or a derived class
bool	IsA (const Util::String &rttiName) const
	return true if this object is instance of given class, or a derived class, by string
bool	IsA (const Util::FourCC &rttiFourCC) const
	return true if this object is instance of given class, or a derived class, by fourcc
const Util::String &	GetClassName () const
	get the class name
Util::FourCC	GetClassFourCC () const
	get the class FourCC code

Private Member Functions
	__DeclareClass (PythonServer)
	__DeclareSingleton (PythonServer)

Additional Inherited Members
Static Public Member Functions inherited from Scripting::ScriptServer
static void	RegisterModuleInit (const ScriptModuleInit &init)
Static Public Member Functions inherited from Core::RefCounted
static void	DumpRefCountingLeaks ()
	dump refcounting leaks, call at end of application (NEBULA_DEBUG builds only!)
Protected Member Functions inherited from Core::RefCounted
virtual	~RefCounted ()
	destructor (called when refcount reaches zero)
Protected Attributes inherited from Scripting::ScriptServer
bool	isOpen
bool	debug
Static Protected Attributes inherited from Scripting::ScriptServer
static Util::Array< ScriptModuleInit >	initFuncs

Constructor & Destructor Documentation

PythonServer()

Scripting::PythonServer::PythonServer

(

)

constructor

~PythonServer()

Scripting::PythonServer::~PythonServer ( )

virtual

destructor

Member Function Documentation

__DeclareClass()

Scripting::PythonServer::__DeclareClass ( PythonServer )

private

__DeclareSingleton()

Scripting::PythonServer::__DeclareSingleton ( PythonServer )

private

AddModulePath()

void Scripting::PythonServer::AddModulePath ( const IO::URI & folder )

virtual

add module search path

add module path

Reimplemented from Scripting::ScriptServer.

Close()

void Scripting::PythonServer::Close ( )

virtual

close the script server

Reimplemented from Scripting::ScriptServer.

Eval()

bool Scripting::PythonServer::Eval ( const Util::String & str )

virtual

evaluate a script statement in a string

Evaluates a piece of Python code in a string.

Reimplemented from Scripting::ScriptServer.

EvalFile()

bool Scripting::PythonServer::EvalFile ( const IO::URI & file )

virtual

evaluate script in file

Evaluate script in file.

Reimplemented from Scripting::ScriptServer.

Open()

bool Scripting::PythonServer::Open ( )

virtual

open the script server

Reimplemented from Scripting::ScriptServer.

---

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

• /github/workspace/code/addons/scripting/python/pythonserver.h
• /github/workspace/code/addons/scripting/python/pythonserver.cc