IConversionProvider.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 __IConversionProvider__
#define __IConversionProvider__

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

#include "IPMUnknown.h"

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

#include "ShuksanID.h"


class FormatID;
class VersionID;


class IConversionProvider : public IPMUnknown
{
public:
 virtual int32 CountConversions() const = 0;

 virtual void GetNthConversion(int32 i, VersionID *fromVersion, VersionID *toVersion) const = 0;

 virtual int32 CountRemovedPlugins(const VersionID &fromVersion, const VersionID &toVersion) const = 0;

 virtual PluginID GetNthRemovedPlugin(const VersionID &fromVersion, const VersionID &toVersion, int32 n) const = 0;

 virtual int32 CountIgnoredPlugins(const VersionID &fromVersion, const VersionID &toVersion) const = 0;

 virtual PluginID GetNthIgnoredPlugin(const VersionID &fromVersion, const VersionID &toVersion, int32 n) const = 0;

 virtual int32 CountClassAliases() const = 0;

 virtual int32 CountImplementationAliases() const = 0;
 
 virtual void GetNthClassAlias(int32 n, ClassID &fromID, VersionID &fromVersion, ClassID &toID, VersionID &toVersion) const = 0;
 
 virtual void GetNthImplementationAlias(int32 n, ImplementationID &fromID, VersionID &fromVersion, ImplementationID &toID, VersionID &toVersion) const = 0;

 virtual int32 CountPlugins() const = 0;
 
 virtual PluginID GetNthPlugin(int32 n) const = 0;

 virtual bool16 DoesConversionRenumberClass(int32 conversionIndex) const = 0;

 virtual bool16 DoesConversionRenumberImplementation(int32 conversionIndex) const = 0;

 enum ConversionStatus
 {
 kNothingToConvert,
 kMustConvert,
 kMustRemove,
 kCantConvert
 };

 virtual ConversionStatus ShouldConvertImplementation(ImplementationID tag, ClassID context, int32 conversionIndex) const = 0;

 virtual ConversionStatus ShouldConvertClass(ClassID clsID, ImplementationID context, int32 conversionIndex) const = 0;

 enum IterationStatus
 {
 kFirstIteration,
 kMiddleIteration,
 kLastIteration
 }; 

 virtual ImplementationID ConvertTag(ImplementationID tag, ClassID forClass, int32 conversionIndex,
 int32 inLength, IPMStream *inStream, IPMStream *outStream, IterationStatus whichIteration) = 0;

 virtual ClassID ConvertClass(ClassID clsID, ImplementationID embeddedContext, int32 conversionIndex,
 int32 inLength, IPMStream *inStream, IPMStream *outStream, IterationStatus whichIteration) = 0;
};


#endif // __IConversionProvider__