IExtendScriptUtils.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 __IExtendScriptUtils__
#define __IExtendScriptUtils__

#include "IPMUnknown.h"
#include "JavaScriptID.h"
#include "IScriptRunner.h"
#include "Utils.h"

class IExtendScriptUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IEXTENDSCRIPTUTILS } ;

 virtual ErrorCode CreateExtendScriptEngine( const PMString& engineName, bool16 isResettable, bool16 isDebuggable ) const = 0 ;

 virtual ErrorCode DeleteExtendScriptEngine( const PMString& engineName ) const = 0 ;

 virtual ErrorCode RunFileInEngine( const PMString& engineName, const IDFile& idFile, 
 bool16 showErrorAlert = kTrue, bool16 invokeDebugger = kFalse ) const = 0 ;

 virtual ErrorCode RunScriptInEngine( const PMString& engineName, const PMString& scriptText, 
 bool16 showErrorAlert = kTrue, bool16 invokeDebugger = kFalse ) const = 0 ;

 virtual ErrorCode RunScriptInEngine( const PMString& engineName, const ScriptData& script, 
 const ScriptRecordData& arguments, ScriptData& result, PMString& errorString, 
 bool16 showErrorAlert = kTrue, bool16 invokeDebugger = kFalse, 
 const RunScriptParams::UndoMode undoMode = RunScriptParams::kUndoScriptRequest, 
 const PMString& undoName = PMString() ) const = 0 ;

 virtual ErrorCode AddIncludePathToEngine( const PMString& engineName, IDFile folderPath ) const = 0 ;

 virtual ErrorCode RemoveIncludePathFromEngine( const PMString& engineName, IDFile folderPath ) const = 0 ;

 virtual PMString GetDefaultHBAPIPackageName() const = 0 ;
 
 virtual ErrorCode RunScriptInEngine( const PMString& engineName, const ScriptData& script, bool16 evalStringAsFilePath,
 const ScriptRecordData& arguments, ScriptData& result, PMString& errorString,
 bool16 showErrorAlert = kTrue, bool16 invokeDebugger = kFalse,
 const RunScriptParams::UndoMode undoMode = RunScriptParams::kUndoScriptRequest,
 const PMString& undoName = PMString() ) const = 0 ;
} ;

#endif