IScriptRunner.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 __IScriptRunner__
#define __IScriptRunner__

#include "ScriptingID.h"
#include "ScriptData.h"

#include "IScriptRequestData.h"

class IScriptCoreFunctor ;
class RunScriptParams ;

class IScriptRunner : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ISCRIPTRUNNER };

 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 ErrorCode EditFile( const IDFile& idFile ) const = 0;
 virtual ErrorCode ShowFile( const IDFile& idFile ) const = 0;
 
 virtual bool16 ScriptHasDescription( const IDFile& idFile ) const = 0;
 virtual PMString GetScriptDescription( const IDFile& idFile ) const = 0;
 
 virtual PMRsrcID GetFileIcon( const IDFile& idFile ) const = 0;

 virtual bool16 CheckForUserCancel() const = 0;

 virtual ErrorCode CancelScriptExecution() const = 0;

 virtual ErrorCode HandleIdleTasks() const = 0;

 virtual ErrorCode ProcessScheduledCmds() const = 0;

 virtual bool16 IsScriptRunning() const = 0;
 virtual ErrorCode GetRunningScriptFile( IDFile& idFile ) const = 0;

 virtual ErrorCode DisplayErrorMessage( ErrorCode errorNumber, const PMString& errorString, 
 int32 lineNumber, const PMString& sourceCode, 
 const PMString& offendingText, const IDFile& scriptFile ) const = 0 ;
};


class RunScriptParams
{
public:
 explicit RunScriptParams( IScriptRunner* scriptRunner ) ;
 RunScriptParams( const RunScriptParams& params, IScriptRunner* scriptRunner ) ;
 ~RunScriptParams() ;

 IScriptRequestData* QueryScriptRequestData() const ;

 ScriptVersion GetVersion() const { return fVersion ; }
 void SetVersion( const ScriptVersion& version ) { fVersion = version ; }

 IScript* QueryTarget() const ;
 void SetTarget( IScript* target ) ;

 bool16 GetShowErrorAlert() const { return fShowErrorAlert ; }
 void SetShowErrorAlert( bool16 showErrorAlert ) { fShowErrorAlert = showErrorAlert ; }
 
 bool16 GetInvokeDebugger() const { return fInvokeDebugger ; }
 void SetInvokeDebugger( bool16 invokeDebugger ) { fInvokeDebugger = invokeDebugger ; }

 enum UndoMode
 {
 kUndoScriptRequest = en_UndoScriptRequest,
 kUndoEntireScript = en_UndoEntireScript,
 kFastUndoEntireScript = en_FastUndoEntireScript,
 kAutoUndoScript = en_AutoUndoScript
 } ; 

 virtual UndoMode GetUndoMode() const { return fUndoMode ; }
 virtual void SetUndoMode( UndoMode undoMode ) { fUndoMode = undoMode ; }

 PMString GetUndoName() const { return fUndoName ; }
 void SetUndoName( const PMString& undoName ) { fUndoName = undoName ; }

private:
 InterfacePtr<IScriptRequestData> fScriptRequestData ;
 InterfacePtr<IScript> fTarget ;
 bool16 fShowErrorAlert ;
 bool16 fInvokeDebugger ;
 UndoMode fUndoMode ;
 PMString fUndoName ;
 ScriptVersion fVersion ;
} ;


#endif // __IScriptRunner__