IPlugInList.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:
// Manages plug-ins: registering, loading, unloading, dependencies, etc.
// 
//========================================================================================

#ifndef __IPLUGINLIST__
#define __IPLUGINLIST__

#include "IPMUnknown.h"
#include "ShuksanID.h"
#include "IPlugIn.h"

class PMString;
class PlugInData;
class DependencyList;
class IPlugInIterator;
class PluginMetadata;

class IPlugInList : public IPMUnknown {
public:
 enum { kDefaultIID = IID_IPLUGINLIST };

 virtual PluginID GetPluginID(const PMString& name) const = 0;

 virtual const PMString& GetPluginName(PluginID whichPlugIn) const = 0;
 
 virtual bool16 GetPathName(PluginID whichPlugIn, IDFile *path) const = 0;
 
#ifdef MACINTOSH

 virtual bool16 GetCFBundleRef(PluginID whichPlugIn, CFBundleRef& bundleRef) const = 0;
#endif

 virtual int32 GetPluginCount() const = 0;

 virtual PluginID GetNthPlugin(int32 n) const = 0;

 virtual bool16 IsStandardComponent(PluginID whichPlugin) const = 0;
 
 virtual bool16 GetVersionNumber(PluginID whichPlugIn, int32& majorVersion, int32& minorVersion) const = 0;

 virtual const PMString *GetAUMVersionString(PluginID whichPlugin) const = 0;

 virtual bool16 GetLastFormatVersion(PluginID whichPlugin, int32& majorVersion, int32& minorVersion) const = 0;
 virtual bool16 GetAppExpectedVersionNumber(PluginID whichPlugIn, int32& majorVersion, int32& minorVersion) const = 0;

 virtual const DependencyList *GetDependentInfo(PluginID whichPlugIn) const = 0;

 virtual PluginID GetNthComponent(const DependencyList *dependentInfo, int32 n) const = 0;

 virtual bool16 GetNthVersion(const DependencyList *dependentInfo, int32 n, int32& majorVersion, int32& minorVersion) const = 0;

 virtual const PMString *GetErrorString(PluginID whichPlugin) const = 0;

 virtual const PMString *GetRuntimeErrorString(PluginID whichPlugin) const = 0;
 
 virtual const PMString *GetRegistrationErrorString(PluginID whichPlugin) const = 0;

 virtual const PluginMetadata* GetPluginMetadata(PluginID whichPlugin) const = 0;
 
 virtual bool16 IsLoaded(PluginID whichPlugIn) const = 0;

 virtual bool16 LoadFailed(PluginID whichPlugIn) const = 0;
 virtual bool16 HasBeenLoaded(PluginID whichPlugIn) const = 0;

 virtual bool16 MatchCurrentProduct(PluginID whichPlugIn) const = 0;

 virtual bool16 MatchCurrentFeatureSet(PluginID whichPlugIn) const = 0;
 
 virtual IPlugIn *Load(PluginID whichPlugIn) = 0;

 virtual IPlugInIterator *CreateIterator() const = 0;
 
#ifdef DEBUG
 typedef enum UnloadStatus { kUnloadNormal, kUnloadFrequently, kUnloadNever } UnloadStatus;
 virtual void SetUnloadStatus(UnloadStatus status) = 0;
 virtual const PlugInData *GetPlugInData( PluginID pluginID ) const = 0;
 virtual void Unload(PluginID whichPlugIn) = 0; 
 virtual void Register(PluginID whichPlugin) = 0;
 virtual void Unregister(PluginID whichPlugin) = 0;
#endif

 virtual IPlugIn::ThreadingPolicy GetThreadingPolicy(PluginID whichPlugIn) const = 0;
 virtual bool16 ComparePluginListToFileStream(const IDFile& pluginListFile) const = 0;

 virtual ErrorCode StreamPluginListToFile(const IDFile& pluginListFile) const = 0;

 virtual void LoadMultipleThreadPolicyPlugins() const = 0;
};

class IPlugInIterator
{
 public:
 // This object should be deleted when you are all done with it.
 virtual ~IPlugInIterator() {}

 // An iterator iterates over plugins. Next() returns
 // the plug-in ID of the next plug-in, or kInvalidPlugin if there are
 // no more plug-ins.
 virtual PluginID Next() = 0;
};


#endif // __IPLUGINLIST__