IDResourceShell.h

//========================================================================================
// 
// $File$
// 
// Owner: Vadim Tkachev
// 
// $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 __IDResourceShell_h__
#define __IDResourceShell_h__

#include "LocaleSetting.h"
#include <boost/function.hpp>
#include "RsrcSpec.h"

class PlugInData;


namespace IDBaseResourceShell {
 
 bool GetPathToPluginResourcesDirectory(const PluginID & pluginID, IDFile & resourcesDir, const PlugInData* pluginData = nil);
 
} //namespace IDBaseResourceShell

class IDResourcePrivateWrapper; //forward declaration of private wrapper, this is a private implementation

struct IDResource
{
 typedef base_type data_type; //simple shallow copies are sufficient
 
 IDResource(IDResourcePrivateWrapper* resource);
 
 virtual ~IDResource() {}
 
 void* Get() const;
 
 size_t Length() const;
 
 bool16 IsValid() const;
 
private:
 boost::shared_ptr<IDResourcePrivateWrapper> fImpl;
};

namespace IDResourceShell
{
 RsrcID GetLocalizedResourceID(const PluginID pluginId, const RsrcID resourceId);

 IDResource Get(const RsrcSpec & spec);
 
 IDResource GetLocalized(const RsrcSpec & spec);
 
 typedef boost::function<bool (IDResource r, void* userData, RsrcSpec spec)> ResourceEnumerationCallback;
 
 void EnumerateResourcesByType(const PluginID & pluginId, const RsrcType & resType, ResourceEnumerationCallback enumerate_callback, void* userData = nil);
 
 void EnumerateLocalizedResourcesByType(const PluginID & pluginId, const RsrcType & resType, ResourceEnumerationCallback enumerate_callback, 
 void* userData = nil, const PMLocaleId & localeId = LocaleSetting::GetLocale());
 
} //namespace IDResourceShell


#endif // __IDResourceShell_h__