StreamUtil.h

//========================================================================================
// 
// $File$
// 
// Owner: Robin_Briggs
// 
// $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 __StreamUtil__
#define __StreamUtil__

#include "ShuksanID.h"
#include "IPMStream.h"
#include "IBoolData.h"

#define ID_FORWARD_DECLARE(_X) \
 class _X; \
 using _X##Ptr = std::shared_ptr<_X>;\
 using Const##_X##Ptr = std::shared_ptr<const _X>;\
 using _X##WeakPtr = std::weak_ptr<_X>;\
 using Const##_X##WeakPtr = std::weak_ptr<const _X>;\
 using _X##UniquePtr = std::unique_ptr<_X>;\

namespace AdobeDCX{
ID_FORWARD_DECLARE(Composite);
}

class IXferBytes;
class IDataBase;
class RsrcSpec;

class StreamUtil {
 public:

 // Database stream access

 static IPMStream *CreateDBStreamRead(IDataBase *db, UID id);

 static IPMStream *CreateDBStreamWrite(IDataBase *db, UID id);
 
 
 static IPMStream* CreateCloudDBStreamRead(IDataBase* db, UID uid);
 
 
 static IPMStream* CreateCloudDBStreamWrite(IDataBase* db, UID uid);
 
 static IPMStream *CreateCopyStream(IDataBase *src, IDataBase *dest, IXferBytes *xfer = nil);
 
 static IPMStream *CreateDBStreamCopy(IDataBase *src, IDataBase *dest, UID id, IPMUnknown* pmobject = nil);

 // File access
 
 static IPMStream *CreateFileStreamRead(const IDFile& sysFile, uint32 mode = kOpenIn, OSType fileType = 0x3f3f3f3f, OSType creator = 0x3f3f3f3f);

 static IPMStream *CreateFileStreamWrite(const IDFile& sysFile, uint32 mode = kOpenOut, OSType fileType = 0x3f3f3f3f, OSType creator = 0x3f3f3f3f);

 static IPMStream *CreateFileStreamReadLazy(const IDFile& sysFile, uint32 mode = kOpenIn, OSType fileType = 0x3f3f3f3f, OSType creator = 0x3f3f3f3f);

 static IPMStream *CreateFileStreamWriteLazy(const IDFile& sysFile, uint32 mode = kOpenOut | kOpenTrunc, OSType fileType = 0x3f3f3f3f, OSType creator = 0x3f3f3f3f);

 static IPMStream *CreateObjectTextFileStreamWrite(IDataBase* db, const IDFile& sysFile, uint32 mode = kOpenOut, OSType fileType = 0x3f3f3f3f, OSType creator = 0x3f3f3f3f);
 

 
 static IPMStream *CreateManagedFileStreamRead(const IDFile& sysFile, uint32 mode = kOpenIn, OSType fileType = 0x3f3f3f3f, OSType creator = 0x3f3f3f3f);

 static IPMStream *CreateManagedFileStreamReadLazy(const IDFile& sysFile, uint32 mode = kOpenIn, OSType fileType = 0x3f3f3f3f, OSType creator = 0x3f3f3f3f);




 static IPMStream *CreatePointerStreamRead(char *buffer, size_t len);

 static IPMStream *CreatePointerStreamWrite(char *buffer, size_t len);
 
 static IPMStream *CreateMemoryStreamRead(IXferBytes* underlyingXferBytes, bool16 takeOwnership = kFalse, bool16 recycleBoss = kTrue);

 static IPMStream *CreateMemoryStreamWrite(IXferBytes* underlyingXferBytes, bool16 takeOwnership = kFalse, bool16 recycleBoss = kTrue);


 static IPMStream *CreateResourceStreamRead(const RsrcSpec& spec, bool16 useLocaleIndexResource = kTrue);

 // For Internal Use Only.
 static IPMStream *CreateObjectResourceStreamRead(const RsrcSpec& spec, IDataBase* db);
 
#if defined(DEBUG)

 static void ResetStreamContentsChanged(IPMStream *s)
 {
 InterfacePtr<IBoolData> sBool(s, IID_IBOOLDATA);
 if (sBool != nil)
 sBool->Set(kFalse);
 }
 static void SetStreamContentsChanged(IPMStream *s)
 {
 InterfacePtr<IBoolData> sBool(s, IID_IBOOLDATA);
 if (sBool != nil)
 sBool->Set(kTrue);
 }
 static bool16 StreamContentsChanged(IPMStream *s)
 {
 InterfacePtr<IBoolData> sBool(s, IID_IBOOLDATA);
 if (sBool == nil)
 return kFalse;
 else
 return sBool->GetBool();
 }
#else

 static void ResetStreamContentsChanged(IPMStream *)
 {}
 static void SetStreamContentsChanged(IPMStream *)
 {}
 static bool16 StreamContentsChanged(IPMStream *)
 {return kFalse;}

#endif
 /*
 Internal Use Only.
 Used to copy data from source db to destination database.
 @param source source database
 @param sourceUID the UID from source database
 @param target target database
 @param targetUID the UID from target database
 */
 
 static IPMStream* CreateCustomDBStreamWrite(IDataBase* source, UID sourceUID, IDataBase* target, UID targetUID);
 /*
 Internal Use Only.
 Wrapper stream for composite type files. Cannot actually perform read write directly. 
 Can be used to access the composite pointer.
 */
 static IPMStream* CreateDCXCompositeStream(ClassID clsID,const AdobeDCX::CompositePtr compositePtr);

};

#endif // __StreamUtil__