RequestContext.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 __REQUESTCONTEXT__
#define __REQUESTCONTEXT__

#include "FormatID.h"
#include "K2SmartPtr.h"
#include "k2VectorStreaming.h"
#include "PMLocaleId.h" //see also FeatureSets.h and PMLocaleIds.h

class IScriptEngine ;
class IScriptManager ;

namespace ScriptInfo
{

typedef ClassID ScriptClient ;
typedef FormatID ScriptVersion ;
typedef K2Vector<ScriptVersion> ScriptVersionList ;
extern const ScriptVersion kMinimumScriptVersion ;
extern const ScriptVersion kMaximumScriptVersion ;
extern const ScriptVersion kCS1ScriptVersion ;
extern const ScriptVersion kCS2ScriptVersion ;
extern const ScriptVersion kCS3ScriptVersion ;
extern const ScriptVersion kCS4ScriptVersion ;
extern const ScriptVersion kCS5ScriptVersion ;
extern const ScriptVersion kCS5_5ScriptVersion ;
extern const ScriptVersion kCS6ScriptVersion ;
extern const ScriptVersion kCCScriptVersion ;
extern const ScriptVersion kCC10ScriptVersion ;
extern const ScriptVersion kCC10_1ScriptVersion ;
extern const ScriptVersion kCC10_2ScriptVersion ;
extern const ScriptVersion kCC11ScriptVersion ;
extern const ScriptVersion kCC11_2ScriptVersion;
extern const ScriptVersion kCC11_3ScriptVersion;
extern const ScriptVersion kCC11_4ScriptVersion;
extern const ScriptVersion kCC12ScriptVersion;
extern const ScriptVersion kCC12_1ScriptVersion;
extern const ScriptVersion kCC13ScriptVersion;
extern const ScriptVersion kCC13_1ScriptVersion;
extern const ScriptVersion kCC14ScriptVersion;
extern const ScriptVersion kCC15ScriptVersion;
extern const ScriptVersion kCC15_1ScriptVersion;
extern const ScriptVersion kCC16ScriptVersion;
extern const ScriptVersion kCC16_1ScriptVersion;
extern const ScriptVersion kCC16_2ScriptVersion;
extern const ScriptVersion kCC17ScriptVersion;
extern const ScriptVersion kCC18ScriptVersion;
 extern const ScriptVersion kCC18_5ScriptVersion;
extern const ScriptVersion kCC19ScriptVersion;
extern const ScriptVersion kCC19_3ScriptVersion;
extern const ScriptVersion kCC19_4ScriptVersion;
extern const ScriptVersion kCC19_5ScriptVersion;
extern const ScriptVersion kCC20ScriptVersion;
extern const ScriptVersion kCC20_2ScriptVersion;
extern const ScriptVersion kCC20_3ScriptVersion;
extern const ScriptVersion kCC20_4ScriptVersion;


#ifdef ID_DEPRECATED //deprecated in CS5; remove in CS6
#define kDragontailScriptVersion kCS1ScriptVersion
#define kFiredrakeScriptVersion kCS2ScriptVersion
#define kCobaltScriptVersion kCS3ScriptVersion
#define kBasilScriptVersion kCS4ScriptVersion
#endif

//CONVERSION UTILITIES

extern PMString ToString( const ScriptVersion& version ) ;
extern ScriptVersion ToVersion( PMString s, PMString::ConversionError* pError = nil ) ;
extern PMReal ToReal( const ScriptVersion& version ) ;
extern ScriptVersion ToVersion( PMReal r ) ;


class RequestContext
{
 public:
 typedef object_type data_type ;

 RequestContext() {}
 RequestContext( const IScriptManager* client, const ScriptVersion& version, const PMLocaleId& locale ) ;
 RequestContext( const RequestContext& other ) { *this = other ; }
 ~RequestContext() {}

 const PMLocaleId& GetLocale() const { return fLocale ; }
 const ScriptVersion& GetVersion() const { return fVersion ; }
 const ScriptClient& GetClient() const { return fClient ; }

 IScriptManager* QueryScriptManager() const ;

 RequestContext& operator=( const RequestContext& ) ;
 bool16 operator==( const RequestContext& other ) const { return ( fLocale == other.fLocale && fVersion == other.fVersion && fClient == other.fClient ) ; }
 bool16 operator!=( const RequestContext& other ) const { return ( fLocale != other.fLocale || fVersion != other.fVersion || fClient != other.fClient ) ; }

 void ReadWrite( IPMStream* s ) ;

 private:
 PMLocaleId fLocale ; //defined in PMLocaleId.h
 ScriptVersion fVersion ; //min version is 0.0; max version is kMaxInt32.kMaxInt32 (0x7FFFFFFF)
 ScriptClient fClient ; //ClassID of the client's script manager boss

#ifdef ID_ENABLE_DEBUGGING
 public:
 ConstCString WhoAmI() const ;
 mutable scoped_array<char> fWhoAmI ;
#endif
} ;

typedef K2Vector<RequestContext> RequestContextList ;
DEFINEK2READWRITE( RequestContext )


class EngineContext : public RequestContext
{
 public:
 typedef object_type data_type ;

 EngineContext() : fEngine( nil ) {}
 EngineContext( const IScriptManager* client, const ScriptVersion& version, const PMLocaleId& locale, const IScriptEngine* engine = nil ) ;
 EngineContext( const EngineContext& other ) : fEngine( nil ) { *this = other ; }
 ~EngineContext() ;

 IScriptEngine* QueryScriptEngine() const ;

 EngineContext& operator=( const EngineContext& ) ;
 bool16 operator==( const EngineContext& other ) const ;
 bool16 operator!=( const EngineContext& other ) const ;

 private:
 const IScriptEngine* fEngine ;

#ifdef ID_ENABLE_DEBUGGING
 public:
 ConstCString WhoAmI() const ;
#endif
} ;

} // End namespace ScriptInfo

#endif //__REQUESTCONTEXT__