IConversionMgr.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.
// 
// 
// Purpose of Interface:
// Manages file format conversions between different versions of plug-ins.
// 
//========================================================================================

#ifndef __IConversionMgr__
#define __IConversionMgr__

// ----- Interfaces -----

#include "IPMUnknown.h"

// ----- Includes -----

#include "FormatNumber.h"
#include "K2Vector.h"

// ----- ID.h files -----

#include "ShuksanID.h"


class FormatID;
class VersionID;
class IDataBase;
class IPMStream;
class IContentMgr;
class IConversionProvider;

class IConversionMgr : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ICONVERSIONMGR };

 enum ConversionStatus
 {
 kUnknownConvert,
 kDontConvert,
 kMustConvert,
 kCantConvert
 };

 virtual ConversionStatus GetStatus(IContentMgr *contentMgr) = 0;

 virtual void GetRemovedPlugins(K2Vector<PluginID> &list) = 0;

 virtual void GetIgnoredPlugins(K2Vector<PluginID> &list) = 0;
 
 virtual void ConvertDocument(IDataBase *dbToConvert) = 0;

 virtual void Open(IContentMgr *contentMgr) = 0;

 virtual void Close() = 0;
 
 virtual ClassID ConvertClass(ClassID inClass, ImplementationID parentContext, IPMStream *inStream, IPMStream *outStream, int32 length) = 0;
 
 virtual bool16 CopyClassData(ClassID inClass, const VersionID &version, bool16 isEmbedded, uint32 inLength, IPMStream *inStream, IPMStream *outStream) = 0;
 
 virtual ImplementationID ConvertTag(ImplementationID inTag, ClassID parentContext, IPMStream *inStream, IPMStream *outStream, int32 length) = 0;
 
 virtual bool16 CopyTagData(ImplementationID inImpl, const VersionID &version, uint32 inLength, IPMStream *inStream, IPMStream *outStream) = 0;
 
 virtual IDataBase *GetConvertingDataBase() = 0;

 virtual UID GetConvertingUID() = 0;

 virtual int32 CountConversionFailures() = 0;

 virtual PluginID GetNthFailedConversion(int32 n) = 0;

 virtual PluginID GetSourcePluginIDForClass(ClassID id) = 0;

 virtual PluginID GetSourcePluginIDForImplementation(ImplementationID id) = 0;

 virtual bool16 GetSourcePluginFormatNumber(PluginID plugin, FormatID &format) const = 0;

 virtual bool16 ReadSourceData(UID uid, ImplementationID implID, const FormatID &format, IPMStream *outStream) = 0;

 virtual PluginID GetTargetPluginIDForClass(ClassID id) = 0;

 virtual PluginID GetTargetPluginIDForImplementation(ImplementationID id) = 0;

 virtual bool16 GetTargetPluginFormatNumber(PluginID plugin, FormatID &format) = 0;

 virtual void RemoveClass(ClassID clsID) = 0;

 virtual void RemoveImplementation(ImplementationID implID) = 0;
 
#if defined(DEBUG)

 virtual void OverrideRunningVersion(const VersionID& substitueVersion) = 0;
#endif
};


#endif // __IConversionMgr__