CScriptRunner.h

//========================================================================================
// 
// $File$
// 
// Owner: Jonathan W. Brown
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __CScriptRunner__
#define __CScriptRunner__

#include "CPMUnknown.h"
#include "IScriptRunner.h"

#include "AcquireModalCursor.h"

class IScriptCoreFunctor ;


class CScriptRunner : public CPMUnknown<IScriptRunner>
{
public:
 CScriptRunner(IPMUnknown *boss);
 virtual ~CScriptRunner() {}

 //edge implementations
 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 ;

 //platform implementations
 virtual ErrorCode EditFile(const IDFile& idFile) const ;
 virtual ErrorCode ShowFile(const IDFile& idFile) const ;
 virtual bool16 CheckForUserCancel() const ;
 virtual ErrorCode HandleIdleTasks() const ;

 //core implementations
 virtual ErrorCode ProcessScheduledCmds() const ;
 virtual bool16 ScriptHasDescription( const IDFile& idFile ) const ;
 virtual void SetScriptRunning( bool16 scriptRunning, const IDFile& runningScript )
 { fScriptRunning = scriptRunning ; fRunningScript = runningScript ; }
 virtual bool16 IsScriptRunning() const { return fScriptRunning ; }
 virtual ErrorCode GetRunningScriptFile(IDFile& idFile) const ;

 virtual ErrorCode DisplayErrorMessage( ErrorCode errorNumber, //must != kSuccess
 const PMString& errorString, //must != "" 
 int32 lineNumber, //1-based index (ignored if == 0)
 const PMString& sourceCode, //ignored if == ""
 const PMString& offendingText, //ignored if == ""
 const IDFile& scriptFile //ignored if empty
 ) const ;

protected:
 virtual ErrorCode AddArguments( void* scriptContext, IScriptRequestData* data ) ;

private:
 bool16 fScriptRunning;
 IDFile fRunningScript;
};

//Stack-based class to SetScriptRunning at beginning and end of running a script
class ScriptRunning
{
public:
 ScriptRunning( CScriptRunner* scriptRunner, const RunScriptParams& params, const IDFile& scriptFile );
 ScriptRunning( CScriptRunner* scriptRunner, const RunScriptParams& params, const PMString& scriptText );
 ScriptRunning( CScriptRunner* scriptRunner, const RunScriptParams& params, const IScriptCoreFunctor* scriptFunc );
 ~ScriptRunning();

private:
 void InitScriptRunning( const RunScriptParams& params, const IDFile& runningScript ) ;

private:
 CScriptRunner* fScriptRunner ;
 bool16 fPreviousRunning ;
 IDFile fPreviousFile ;
 ScriptVersion fPreviousVersion ;
 bool16 fRunningAsSingleUndoStep ;
 AcquireDelayedBusyCursor fWaitCursor ; 
} ;


#endif