ISession.h

//========================================================================================
// 
// $File$
// 
// Owner: Lonnie Millett
// 
// $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 __ISESSION__
#define __ISESSION__

#include "IPMUnknown.h"
#include "ShuksanID.h"

//----------------------------------------------------------------------------------------
// Forward Declarations
//----------------------------------------------------------------------------------------

class IApplication;
class IActiveContext;
class IChangeManager;
class IWorkspace;
class ICommandProcessor;
class IEventConverter;
class IDataBase;
class GlobalTime;
class IObjectModel;
class VersionNumber;
class IStartupScreen;
class IAutomationManager;
class IUserActionPersonalityManager;
class IINXManager;
class IDocumentList;
class ISession : public IPMUnknown
{
public: 
 virtual IActiveContext* GetActiveContext() = 0;
 
 virtual IChangeManager* GetChangeManager() = 0;
 
 virtual IEventConverter* GetEventConverter() = 0;
 
 virtual IApplication* QueryApplication() = 0;
 
 virtual IWorkspace* QueryWorkspace() = 0;
 
 virtual IPMUnknown* QueryWorkspace(PMIID faceID) = 0;
 
 virtual ICommandProcessor* QueryCommandProcessor() = 0;
 
 virtual IAutomationManager* QueryAutomationMangager() = 0;

 virtual IUserActionPersonalityManager* QueryUserActionPersonalityMangager() = 0;
 
 virtual IINXManager * QueryINXManager() = 0;

 typedef enum SessionStateType
 { kUnknown, kStartingUp, kRunning, kShuttingDown } SessionStateType;

 virtual SessionStateType GetState() = 0;
 



 // Purge handler is called automatically when memory allocation fails.
 virtual bool16 PurgeMemory(int32 level) = 0;
 
 // Get the startup time
 virtual const GlobalTime &GetStartupTime() = 0;
 
 // Is InDesign running without saved data
 virtual const bool16 IsStartupWithoutSavedData (void) = 0;

 // Initialize the session.
 virtual bool16 Init(IDataBase* workSpaceDB = nil, const GlobalTime* const pStartupTime = nil) = 0;
 
 // Shutdown the session.
 virtual void Cleanup() = 0;
 
 // access to the startup screen.
 virtual IStartupScreen *GetStartupScreen() const = 0;

 // This call can be used to insert a proxy command processor, or to remove
 // the proxy and restore the original command processor that will be returned
 // by QueryCommandProcessor(). This will not change the reference count
 // of their command processor boss.
 virtual ICommandProcessor *SetProxyCommandProcessor (ICommandProcessor *proxy) = 0;


 virtual IDocumentList* QueryDocumentList() const = 0;


}; 

 ISession* GetExecutionContextSession();


template <class FACE> 
inline FACE* QuerySessionWorkspace() 
{ 
 IPMUnknown* face = GetExecutionContextSession()->QueryWorkspace(FACE::kDefaultIID);
 
 return static_cast<FACE*>(face);
}


#endif // __ISESSION__