IScriptUtils.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 __IScriptUtils__
#define __IScriptUtils__

#include "IPMUnknown.h"
#include "IScriptLabel.h"
#include "IScriptPreferences.h"
#include "IScriptRunner.h"

#include "ScriptInfo.h"
#include "Utils.h"

class ICommand ;
class IDocument ;
class IScript ;
class IScriptEvent ;
class IScriptManager ;
class IScriptRequestData ;
class IScriptInfoManager ;
class IScriptRequestHandler ;
class ScriptObject ;

#define keyStringPrefix "$ID/"
// The wide char version
#define keyStringPrefixW L"$ID/"

typedef K2Vector< InterfacePtr<IScriptManager> > ScriptManagerList ;

namespace ScriptInfo
{
class ObjectScriptElement ;
}

using namespace ScriptInfo ;


class IScriptUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ISCRIPTUTILS };

 virtual IScript* QueryApplicationScript() const = 0;

 virtual IScriptInfoManager* QueryScriptInfoManager( const RequestContext& context ) const = 0 ;

 virtual IScriptRequestHandler* QueryScriptRequestHandler( const RequestContext& context ) const = 0 ;

 virtual void GetScriptManagers( ScriptManagerList& mgrs ) const = 0 ;

 virtual IScriptManager* QueryScriptManager( ClassID boss ) const = 0 ;

 virtual IScriptRunner* QueryScriptRunner( const IDFile& ) const = 0 ;

 virtual bool16 IsScriptActive() = 0 ;

 virtual bool16 IsINX( const RequestContext& context ) = 0 ;
 virtual bool16 IsINX() = 0 ;

 virtual bool16 IsINXTraditional( const RequestContext& context ) = 0 ;

 virtual bool16 IsINXExpanded( const RequestContext& context ) = 0 ;

 virtual bool16 IsINXExport( const RequestContext& context ) = 0 ;

 virtual PMString GetScriptID( const ScriptID& scriptID ) = 0;

 virtual IScript* CreateProxyScriptObject( const RequestContext& context, const ClassID& classID, const ScriptID& objectID, const IPMUnknown* parent, int32 index = 0 ) = 0 ;

 virtual void ReleaseAllObjectsInDatabase( IDataBase* db ) const = 0;
 
 virtual IWorkspace* QueryWorkspaceFromScript( const IScript* script, const RequestContext& context ) = 0 ;

 virtual IDocument* QueryDocumentFromScript( const IScript* script, const RequestContext& context ) = 0 ;

 virtual ErrorCode ExtractInsertionLocation( IScript* inScript, IScriptRequestData* inData, const ScriptID& objectType, ScriptID& outLocation, InterfacePtr<IScript>& outScript ) = 0 ;

 virtual ErrorCode GetMoveLocation( const IScriptRequestData* inData, ScriptID& outLocation, InterfacePtr<IScript>& outScript ) = 0 ;

 virtual bool16 IsNothing( const ScriptData& scriptData ) = 0 ;

 virtual ErrorCode GenerateSpecifier( const EngineContext& context, const IScript* object, PMString& specifier, SpecifierForm form = kFormDefault ) = 0 ;

 virtual ErrorCode GenerateSpecifier( const EngineContext& context, const IScript* object, PMString& workSpaceSpecifier, PMString& objectSpecifier, SpecifierForm form = kFormDefault ) = 0 ;

 virtual ErrorCode GenerateListSpecifier( const EngineContext& context, const ScriptList& objects, PMString& specifier, SpecifierForm form = kFormDefault ) = 0 ;

 virtual ErrorCode GenerateRangeSpecifier( const EngineContext& context, const PMString& fromSpecifier, const PMString& toSpecifier, PMString& specifier ) = 0 ;

 virtual ErrorCode AppendSpecifier( const EngineContext& context, const ScriptInfo::ObjectScriptElement* objectScriptElement, const ScriptObject& scriptObject, PMString& specifier ) = 0 ;

 virtual ErrorCode ResolveSpecifier( const EngineContext& context, const PMString& specifier, ScriptList& resolvedObjects ) = 0 ;

 virtual ErrorCode ResolveSpecifier( const EngineContext& context, const PMString& workSpaceSpecifier, const PMString& objectSpecifier, ScriptList& resolvedObjects ) = 0 ;

 /*
 Find a common base object for two types of objects.
 @param si1 is the first type of object
 @param si2 is the second type of object
 @return the object info for their common base object or nil if there isn't one
 */
 virtual const ObjectScriptElement* GetCommonBaseInfo( const ObjectScriptElement* si1, const ObjectScriptElement* si2 ) const = 0 ;

 virtual ErrorCode GetScriptingSupportFolder( const RequestContext& context, IDFile& outFolder ) const = 0 ;

 virtual void AppendDirectoryForDOMVersion( const RequestContext& context, IDFile& sysFile ) const = 0 ;

 virtual ErrorCode SetScriptingTag( const ScriptList& scriptList, const EngineContext& context, 
 const IScriptLabel::ScriptLabelValue& label, 
 const IScriptLabel::ScriptLabelKey& key = IScriptLabel::kDefaultScriptLabelKey ) const = 0 ;
 virtual ErrorCode SetScriptingTags( const ScriptList& scriptList, const EngineContext& context, 
 const IScriptLabel::ScriptLabelKeyValueList& labels,
 bool16 replaceExistingLabels = kFalse ) const = 0 ;

 virtual ErrorCode GetScriptsFolder( IDFile& scriptsFolder, bool16 resolveAlias ) const = 0 ;

 virtual ErrorCode ExtractVersion( IScriptRequestData* data, ScriptVersion& internalVersion ) const = 0 ;

 virtual ErrorCode DispatchScriptRunner( IScriptRunner* scriptRunner, const ScriptData& script, 
 const ScriptRecordData& arguments, ScriptData& result, 
 PMString& errorString, const bool16 showErrorAlert,
 const bool16 invokeDebugger = kFalse,
 const RunScriptParams::UndoMode undoMode = RunScriptParams::kUndoScriptRequest, 
 const PMString& undoName = PMString(),
 const ScriptVersion& domVersion = ScriptVersion() ) const = 0 ;

 virtual void ClearScriptProviders() const = 0 ;

 virtual ErrorCode SetAppScriptPrefs( bool16 redraw ) const = 0 ;

 virtual bool16 TranslateKeyStringFromScriptClient( PMString& s ) const = 0 ;

 virtual void DisableIdleProcessingDuringScripts() = 0 ;

 virtual void EnableIdleProcessingDuringScripts() = 0 ;

 virtual bool16 IsIdleProcessingEnabledDuringScripts() const = 0 ;
 
 virtual ErrorCode DispatchScriptRunner( IScriptRunner* scriptRunner, const ScriptData& script, bool16 evalStringAsFilePath,
 const ScriptRecordData& arguments, ScriptData& result,
 PMString& errorString, const bool16 showErrorAlert,
 const bool16 invokeDebugger = kFalse,
 const RunScriptParams::UndoMode undoMode = RunScriptParams::kUndoScriptRequest,
 const PMString& undoName = PMString(),
 const ScriptVersion& domVersion = ScriptVersion() ) const = 0 ;
};

class DisableIdleProcessingDuringScripts
{
public:
 DisableIdleProcessingDuringScripts()
 {
 Utils<IScriptUtils>()->DisableIdleProcessingDuringScripts() ;
 }
 ~DisableIdleProcessingDuringScripts()
 {
 Utils<IScriptUtils>()->EnableIdleProcessingDuringScripts() ;
 }
} ;

#endif // __IScriptUtils__