ScriptIDEnumMap.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.
// 
// 
// ADOBE CONFIDENTIAL
// 
//========================================================================================

#ifndef __ScriptIDEnumMap__
#define __ScriptIDEnumMap__

#include "IScriptErrorUtils.h"
#include "IScriptRequestData.h"

template<class T>
class ScriptIDMap
{
public:
 struct Entry
 {
 T t;
 ScriptID id;
 } ;

 ScriptIDMap( const Entry* firstEntry, size_t tableSize )
 {
 fMappingTable = firstEntry ;
 fNumEntries = (int32)(tableSize / sizeof( Entry )) ;
 }

 bool16 TranslateFromScriptID( T& t, const ScriptID& script_id ) const
 {
 for ( int32 i = 0 ; i < fNumEntries ; ++i )
 {
 if ( fMappingTable[i].id == script_id )
 {
 t = fMappingTable[i].t ;
 return kTrue ;
 }
 }
 return kFalse ;
 }

 bool16 TranslateToScriptID( ScriptID& script_id, const T& t ) const
 {
 for ( int32 i = 0 ; i < fNumEntries ; ++i )
 {
 if ( fMappingTable[i].t == t )
 {
 script_id = fMappingTable[i].id ;
 return kTrue ;
 }
 }
 return kFalse ;
 }

 ErrorCode GetForGetProperty( const IScript* script, IScriptRequestData* data, const ScriptID& propID, const T& t ) const
 {
 ScriptID script_id ;
 if ( !TranslateToScriptID( script_id, t ) )
 {
 ASSERT_FAIL( "ScriptIDMap::TranslateToScriptID failed to find a scripting enum to match the current value of a property" ) ;
 return kFailure ;
 }

 ScriptData scriptData ;
 scriptData.SetEnumeration( script_id ) ;
 data->AppendReturnData( script, propID, scriptData ) ;
 return kSuccess ;
 }

 ErrorCode GetForSetProperty( const IScript* script, IScriptRequestData* data, const ScriptID& propID, T& t ) const
 {
 ScriptData scriptData ;
 ErrorCode err = data->ExtractRequestData( propID, scriptData ) ;
 if ( err != kSuccess ) return err ;

 ScriptID script_id ;
 err = scriptData.GetEnumeration( &script_id ) ;
 if ( err != kSuccess ) return Utils<IScriptErrorUtils>()->SetInvalidParameterErrorData( data, propID ) ;

 if ( !TranslateFromScriptID( t, script_id ) )
 return Utils<IScriptErrorUtils>()->SetInvalidParameterErrorData( data, propID ) ;

 return kSuccess ;
 }

protected:
 const Entry* fMappingTable ;
 int32 fNumEntries ;
} ;

//Here int32 represents any enum value
typedef ScriptIDMap<int32> ScriptIDEnumMap ;
typedef ScriptIDMap<int32>::Entry ScriptIDEnumMapEntry ;

#endif //__ScriptIDEnumMap__