CScriptRunner Class Reference

#include <CScriptRunner.h>

Inheritance diagram for CScriptRunner:

Public Member Functions
	CScriptRunner (IPMUnknown *boss)
virtual bool16	CanHandleFile (const IDFile &idFile) const =0
virtual ErrorCode	RunFile (const IDFile &idFile, const RunScriptParams &params)=0
virtual ErrorCode	RunScript (const PMString &scriptText, const RunScriptParams &params)=0
virtual ErrorCode	InvokeFunction (const IScriptCoreFunctor *scriptFunction, const RunScriptParams &params)=0
virtual PMString	GetScriptDescription (const IDFile &idFile) const =0
virtual PMRsrcID	GetFileIcon (const IDFile &idFile) const =0
virtual ErrorCode	CancelScriptExecution () const =0
virtual ErrorCode	DefineGlobal (void *scriptContext, const PMString &name, const ScriptData &value)=0
virtual ErrorCode	EditFile (const IDFile &idFile) const
virtual ErrorCode	ShowFile (const IDFile &idFile) const
virtual bool16	CheckForUserCancel () const
virtual ErrorCode	HandleIdleTasks () const
virtual ErrorCode	ProcessScheduledCmds () const
virtual bool16	ScriptHasDescription (const IDFile &idFile) const
virtual void	SetScriptRunning (bool16 scriptRunning, const IDFile &runningScript)
virtual bool16	IsScriptRunning () const
virtual ErrorCode	GetRunningScriptFile (IDFile &idFile) const
virtual ErrorCode	DisplayErrorMessage (ErrorCode errorNumber, const PMString &errorString, int32 lineNumber, const PMString &sourceCode, const PMString &offendingText, const IDFile &scriptFile) const
Public Member Functions inherited from CPMUnknown< IScriptRunner >
IPMUnknown *	QueryInterface (PMIID interfaceID) const
void	AddRef () const
void	Release () const
void	PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
void	PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
	CPMUnknown (const CPMUnknown &)=delete
CPMUnknown &	operator= (const CPMUnknown &)=delete

Protected Member Functions
virtual ErrorCode	AddArguments (void *scriptContext, IScriptRequestData *data)
Protected Member Functions inherited from CPMUnknown< IScriptRunner >
	CPMUnknown (IPMUnknown *boss)

Additional Inherited Members
Public Types inherited from IScriptRunner
enum	{ kDefaultIID = IID_ISCRIPTRUNNER }
Protected Attributes inherited from CPMUnknown< IScriptRunner >
HelperInterface	fHelperInterface

Detailed Description

A base class for script runners

Member Function Documentation

virtual ErrorCode CScriptRunner::CancelScriptExecution ( ) const

pure virtual

Cancel the execution of the currently running script

Implements IScriptRunner.

virtual bool16 CScriptRunner::CanHandleFile ( const IDFile &  idFile ) const

pure virtual

Return kTrue if this runner can execute this file

Parameters

idFile

the script file to check

Implements IScriptRunner.

virtual bool16 CScriptRunner::CheckForUserCancel ( ) const

virtual

Returns

kTrue if user is trying to cancel script execution

Implements IScriptRunner.

virtual ErrorCode CScriptRunner::DefineGlobal ( void *  scriptContext, const PMString &  name, const ScriptData &  value  )

pure virtual

Define a variable in the global name space of the scripting engine. Called by AddArguments to pass arguments to scripts.

Parameters

scriptContext	is client-specific information
name	is the variable name to define
value	is the value to assign the variable

Returns

kSuccess if registered successfully, kFailure otherwise

virtual ErrorCode CScriptRunner::DisplayErrorMessage ( ErrorCode  errorNumber, const PMString &  errorString, int32  lineNumber, const PMString &  sourceCode, const PMString &  offendingText, const IDFile &  scriptFile  ) const

virtual

Display a script error alert

Parameters

errorNumber	- the error number (must != kSuccess)
errorString	- a description of the error (must != "")
lineNumber	- 1-based index of the line of the script on which the error occurred (ignored if == 0)
sourceCode	- the line of the script that contains the error (ignored if == "")
offendingText	- the code snippet that caused the error (ignored if == "")
scriptFile	- the script file that contains the error (ignored if empty)

Returns

kSuccess

Implements IScriptRunner.

virtual ErrorCode CScriptRunner::EditFile ( const IDFile &  idFile ) const

virtual

Edit a script file.

Parameters

idFile

the script file to edit

Implements IScriptRunner.

virtual PMRsrcID CScriptRunner::GetFileIcon ( const IDFile &  idFile ) const

pure virtual

Returns

a file icon for a script.

Parameters

idFile

the script file to get an icon for

Implements IScriptRunner.

virtual ErrorCode CScriptRunner::GetRunningScriptFile ( IDFile &  idFile ) const

virtual

Get the currently running script.

Parameters

idFile

the script file that is currently running

Implements IScriptRunner.

virtual PMString CScriptRunner::GetScriptDescription ( const IDFile &  idFile ) const

pure virtual

Get a script's description.

Parameters

idFile

the script file from which to get a description

Implements IScriptRunner.

virtual ErrorCode CScriptRunner::HandleIdleTasks ( ) const

virtual

Handle any periodic tasks requested by the system

Implements IScriptRunner.

virtual ErrorCode CScriptRunner::InvokeFunction ( const IScriptCoreFunctor *  scriptFunction, const RunScriptParams &  params  )

pure virtual

Invoke a function.

Parameters

scriptFunction	is the function IN
params	contains settings and data for script execution IN/OUT

Returns

is kSuccess or an error code

Implements IScriptRunner.

virtual bool16 CScriptRunner::IsScriptRunning ( ) const

inlinevirtual

Returns

kTrue if a script is currently running

Implements IScriptRunner.

virtual ErrorCode CScriptRunner::ProcessScheduledCmds ( ) const

virtual

Process any commands that were scheduled during a script request

Implements IScriptRunner.

virtual ErrorCode CScriptRunner::RunFile ( const IDFile &  idFile, const RunScriptParams &  params  )

pure virtual

Execute a script file. Should only be called if CanHandleFile returns kTrue.

Parameters

idFile	the script file to execute IN
params	contains settings and data for script execution IN/OUT

Returns

is kSuccess or an error code

Implements IScriptRunner.

virtual ErrorCode CScriptRunner::RunScript ( const PMString &  scriptText, const RunScriptParams &  params  )

pure virtual

Execute a script given the text of the script.

Parameters

scriptText	the script text to execute IN
params	contains settings and data for script execution IN/OUT

Returns

is kSuccess or an error code

Implements IScriptRunner.

virtual bool16 CScriptRunner::ScriptHasDescription ( const IDFile &  idFile ) const

virtual

Return kTrue if a script has a description.

Parameters

idFile

the script file to check for a description

Implements IScriptRunner.

virtual ErrorCode CScriptRunner::ShowFile ( const IDFile &  idFile ) const

virtual

Show a script file in the Mac Finder/Windows shell

Parameters

idFile

the script file to show

Implements IScriptRunner.