Manage scripting in Stellarium.

#include <StelScriptMgr.hpp>

Public Slots
QString	getHtmlDescription (const QString &s, bool generateDocumentTags=true) const
	Returns a HTML description of the specified script. More...

QString	getName (const QString &s) const
	Gets a single line name of the script. More...

QString	getAuthor (const QString &s) const
	Gets the name of the script Author. More...

QString	getLicense (const QString &s) const
	Gets the licensing terms for the script. More...

QString	getVersion (const QString &s) const
	Gets the version of the script. More...

QString	getDescription (const QString &s) const
	Gets a description of the script. More...

QString	getShortcut (const QString &s) const
	Gets the default shortcut of the script. More...

bool	runScript (const QString &fileName, const QString &includePath="")
	Run the script located in the given file. More...

bool	runScriptDirect (const QString &scriptCode, const QString &includePath=QString())
	Runs the script code given. More...

bool	runPreprocessedScript (const QString &preprocessedScript, const QString &scriptId)
	Runs preprocessed script code which has been generated using runPreprocessedScript(). More...

bool	prepareScript (QString &script, const QString &fileName, const QString &includePath="")
	Loads a script file and does all preparatory steps except for actually executing the script in the engine. More...

void	stopScript ()
	Stops any running script. More...

void	setScriptRate (float r)
	Changes the rate at which the script executes as a multiple of real time. More...

double	getScriptRate () const
	Get the rate at which the script is running as a multiple of the normal execution rate. More...

void	debug (const QString &msg)
	cause the emission of the scriptDebug signal. More...

void	output (const QString &msg)
	cause the emission of the scriptOutput signal. More...

void	resetOutput (void)
	Reset output file and cause the emission of an (empty) scriptOutput signal.

void	saveOutputAs (const QString &filename)
	Save output file to new file. More...

void	pauseScript ()
	Pause a running script.

void	resumeScript ()
	Resume a paused script.

Signals
void	runningScriptIdChanged (const QString &id)
	Emitted when the running script id changes (also on start/stop)

void	scriptRunning ()
	Notification when a script starts running.

void	scriptStopped ()
	Notification when a script has stopped running.

void	scriptDebug (const QString &) const
	Notification of a script event - warnings, current execution line etc.

void	scriptOutput (const QString &) const
	Notification of a script event - output line.

Public Member Functions
	StelScriptMgr (QObject *parent=Q_NULLPTR)

QStringList	getScriptList () const

bool	scriptIsRunning () const
	Find out if a script is running. More...

QString	runningScriptId () const
	Get the ID (usually filename) of the currently running script. More...

bool	preprocessScript (const QString &input, QString &output, const QString &scriptDir)
	Preprocess script, esp. More...

bool	preprocessScript (QFile &input, QString &output, const QString &scriptDir)

void	addModules ()
	Add all the StelModules into the script engine.

Properties
QString	runningScriptId

Member Function Documentation

◆ debug

void StelScriptMgr::debug ( const QString & msg )

slot

This is so that functions in StelMainScriptAPI can explicitly send information to the ScriptConsole

◆ getAuthor

QString StelScriptMgr::getAuthor ( const QString & s ) const

slot

Parameters

s	the file name of the script whose name is to be returned.

Returns: text following a comment with Author: at the start. If no such comment is found, "" is returned. If the file is not found or cannot be opened for some reason, an Empty string will be returned.

◆ getDescription

QString StelScriptMgr::getDescription ( const QString & s ) const

slot

Parameters

s	the file name of the script whose name is to be returned.

Returns: text following a comment with Description: at the start. The description is considered to be over when a line with no comment is found. If no such comment is found, QString("") is returned. If the file is not found or cannot be opened for some reason, an Empty string will be returned.

◆ getHtmlDescription

QString StelScriptMgr::getHtmlDescription	(	const QString &	s,
		bool	generateDocumentTags = `true`
	)		const

slot

Includes name, author, description...

Parameters

s	the file name of the script whose HTML description is to be returned.
generateDocumentTags	if true, the main wrapping document tags (<html><body>...</body></html>) are also generated

◆ getLicense

QString StelScriptMgr::getLicense ( const QString & s ) const

slot

Parameters

s	the file name of the script whose name is to be returned.

Returns: text following a comment with License: at the start. If no such comment is found, "" is returned. If the file is not found or cannot be opened for some reason, an Empty string will be returned.

◆ getName

QString StelScriptMgr::getName ( const QString & s ) const

slot

Parameters

s	the file name of the script whose name is to be returned.

Returns: text following a comment with Name: at the start. If no such comment is found, the file name will be returned. If the file is not found or cannot be opened for some reason, an Empty string will be returned.

◆ getScriptRate

double StelScriptMgr::getScriptRate ( ) const

slot

◆ getShortcut

QString StelScriptMgr::getShortcut ( const QString & s ) const

slot

Parameters

s	the file name of the script whose name is to be returned.

Returns: text following a comment with Shortcut: at the start. If no such comment is found, QString("") is returned. If the file is not found or cannot be opened for some reason, an Empty string will be returned.

◆ getVersion

QString StelScriptMgr::getVersion ( const QString & s ) const

slot

Parameters

s	the file name of the script whose name is to be returned.

Returns: text following a comment with Version: at the start. If no such comment is found, "" is returned. If the file is not found or cannot be opened for some reason, an Empty string will be returned.

◆ output

void StelScriptMgr::output ( const QString & msg )

slot

This is so that functions in StelMainScriptAPI can explicitly send information to the ScriptConsole

◆ prepareScript

bool StelScriptMgr::prepareScript	(	QString &	script,
		const QString &	fileName,
		const QString &	includePath = `""`
	)

slot

Use runPreprocessedScript to execute the script. It should be safe to call this method from another thread.

Parameters

script	returns the preprocessed script text
fileName	the location of the file containing the script.
includePath	the directory to use when searching for include files in the SSC preprocessor. Usually this will be the same as the script file itself, but if you're running a generated script from a temp directory, but want to include a file from elsewhere, it can be usetul to set it to something else (e.g. in ScriptConsole).

Returns: false if the named script could not be prepared, true otherwise

◆ preprocessScript()

bool StelScriptMgr::preprocessScript	(	const QString &	input,
		QString &	output,
		const QString &	scriptDir
	)

process include instructions. if the command line option –verbose has been given, this dumps the preprocessed script with line numbers attached to log. This helps to understand the line number given by the usual error message.

◆ runningScriptId()

QString StelScriptMgr::runningScriptId ( ) const

Returns: Empty string if no script is running, else the ID of the script which is running.

◆ runPreprocessedScript

bool StelScriptMgr::runPreprocessedScript	(	const QString &	preprocessedScript,
		const QString &	scriptId
	)

slot

In general, you do not want to use this method, use runScript() or runScriptDirect() instead.

Note: This is a blocking call! The event queue is held up by calls of QCoreApplication::processEvents().

Parameters

preprocessedScript	the string containing the preprocessed script.
scriptId	The name of the script. Usually should correspond to the file name.

Returns: false if the given script code could not be run, true otherwise

◆ runScript

bool StelScriptMgr::runScript	(	const QString &	fileName,
		const QString &	includePath = `""`
	)

slot

In essence, this calls prepareScript and runPreprocessedScript.

Note: This is a blocking call! The event queue is held up by calls of QCoreApplication::processEvents().

Parameters

fileName	the location of the file containing the script.
includePath	the directory to use when searching for include files in the SSC preprocessor. If empty, this will be the same as the directory where the script file resides. If you're running a generated script from a temp directory, but want to include a file from elsewhere, it can be usetul to set it to something else (e.g. in ScriptConsole).

Returns: false if the named script could not be prepared or run, true otherwise

◆ runScriptDirect

bool StelScriptMgr::runScriptDirect	(	const QString &	scriptCode,
		const QString &	includePath = `QString()`
	)

slot

This can be used for quick script executions, without having to create a temporary file first.

Note: This is a blocking call! The event queue is held up by calls of QCoreApplication::processEvents().

Parameters

scriptCode	The script to execute
includePath	If a null string (the default), no pre-processing is done. If an empty string, the default script directories are used (script/ in both user and install directory). Otherwise, the given directory is used.

Returns: false if the named script code could not be prepared or run, true otherwise

◆ saveOutputAs

void StelScriptMgr::saveOutputAs ( const QString & filename )

slot

This is required to allow reading with other program on Windows while output.txt is still open.

Parameters

filename new filename. If this is not an absolute path, it will be created in the same directory as output.txt

Note: For storing to absolute path names, set [scripts]/flag_script_allow_write_absolute_path=true.

◆ scriptIsRunning()

bool StelScriptMgr::scriptIsRunning ( ) const

Returns: true if a script is running, else false

◆ setScriptRate

void StelScriptMgr::setScriptRate ( float r )

slot

Note that this is not the same as the rate at which simulation time passes because the script running at normal rate might set the simulation time rate to be non-real time.

Parameters

r	rate, e.g. 2.0 = script runs at twice the normal rate

◆ stopScript

void StelScriptMgr::stopScript ( )

slot

Returns: false if no script was running, true otherwise.

Public Slots

Signals

Public Member Functions

Properties

Member Function Documentation

◆ debug

◆ getAuthor

◆ getDescription

◆ getHtmlDescription

◆ getLicense

◆ getName

◆ getScriptRate

◆ getShortcut

◆ getVersion

◆ output

◆ prepareScript

◆ preprocessScript()

◆ runningScriptId()

◆ runPreprocessedScript

◆ runScript

◆ runScriptDirect

◆ saveOutputAs

◆ scriptIsRunning()

◆ setScriptRate

◆ stopScript