ScriptReturnData.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 __ScriptReturnData__
#define __ScriptReturnData__

#include "ScriptData.h"

class ScriptReturnData
{
public:
 typedef object_type data_type ;

 explicit ScriptReturnData();
 explicit ScriptReturnData( const ScriptID requestID ) ;
 ScriptReturnData( const ScriptID requestID, ScriptData returnValue ) ;
 
 ScriptReturnData( const ScriptID requestID, const ErrorCode errorCode ) ;
 ~ScriptReturnData() {}

 ScriptID GetRequestID() const { return fRequestID ; }

 ScriptData GetReturnValue() const { return fReturnValue ; }

 ErrorCode GetErrorCode() const { return fErrorCode ; }

 PMString GetErrorString() const ;

 void SetErrorString( PMString errorString ) { swap( fErrorString, errorString ) ; }
 
 friend inline void swap( ScriptReturnData& left, ScriptReturnData& right )
 {
 std::swap(left.fRequestID, right.fRequestID);
 swap(left.fReturnValue, right.fReturnValue);
 std::swap(left.fErrorCode, right.fErrorCode);
 swap(left.fErrorString, right.fErrorString);
 std::swap(left.fErrorInfo, right.fErrorInfo);
 }
 
 ScriptReturnData(const ScriptReturnData& other)
 : fRequestID(other.fRequestID), fReturnValue(other.fReturnValue),
 fErrorCode(other.fErrorCode), fErrorString(other.fErrorString), fErrorInfo(other.fErrorInfo)
 {
 }
 
 ScriptReturnData(adobe::move_from<ScriptReturnData> other)
 : fRequestID(other.source.fRequestID), fReturnValue(adobe::move(other.source.fReturnValue)),
 fErrorCode(other.source.fErrorCode), fErrorString(adobe::move(other.source.fErrorString))
 {
 std::swap(fErrorInfo, other.source.fErrorInfo);
 }
 
 ScriptReturnData& operator=(ScriptReturnData other)
 { swap(*this, other); return *this; }

protected:
 void CheckGlobalErrorCode() ;

private:
 ScriptID fRequestID ;
 ScriptData fReturnValue ;
 ErrorCode fErrorCode ;
 mutable PMString fErrorString ;
 InterfacePtr<IPMUnknown> fErrorInfo ;
} ;

typedef adobe::vector<ScriptReturnData> ScriptReturnDataList ;

#ifdef ID_ENABLE_DEBUGGING

 PMString GetAsString( const ScriptReturnData& srd, const RequestContext& context ) ;
 PMString GetAsString( const ScriptReturnDataList& srdl, const RequestContext& context ) ;

#endif

#endif