generic_resource_interface.h

Go to the documentation of this file.

#ifndef SDK_BASE_SDK_RESOURCE_INTERFACE_H_
#define SDK_BASE_SDK_RESOURCE_INTERFACE_H_
 
#include <base/inc/base_types.h>
#include <base/inc/sdk_ref_ptr.h>
#include <base/inc/sdk_component_interface.h>
#include <base/inc/interfaces/stream/stream_interface.h>
#include <base/inc/interfaces/properties/named_properties_interface.h>
 
namespace sdk {
namespace base {
 
FWD_DECL_INTERFACE(ISDKResource);
FWD_DECL_INTERFACE(ISDKResourceInfo);
FWD_DECL_INTERFACE(ISDKResourceStorage);
FWD_DECL_INTERFACE(ISDKResourceStorageEnumerator);
FWD_DECL_INTERFACE(ISDKResourceManager);
FWD_DECL_INTERFACE(ISDKMemoryBuffer);
typedef SDKRefPtr<ISDKResource> SDKResourceSP;
typedef SDKRefPtr<ISDKResourceInfo> SDKResourceInfoSP;
typedef SDKRefPtr<ISDKResourceStorage> SDKResourceStorageSP;
typedef SDKRefPtr<ISDKResourceStorageEnumerator> SDKResourceStorageEnumeratorSP;
typedef SDKRefPtr<ISDKResourceManager> SDKResourceManagerSP;
typedef SDKRefPtr<ISDKMemoryBuffer> SDKMemoryBufferSP;
 
typedef enum OpenResourceFlags
{
  kOpenResourceFlags_Read      = 0x01, 
  kOpenResourceFlags_Write     = 0x02, 
  kOpenResourceFlags_Create    = 0x04, 
  kOpenResourceFlags_Append    = 0x08, 
  kOpenResourceFlags_Exclusive = 0x10, 
  kOpenResourceFlags_Text      = 0x20, 
} OpenResourceFlags;
 
class ISDKResource : public ISDKNamedProperties
{
public:
  virtual SDKResult SDK_CALLTYPE GetInfo(SDKResourceInfoSP& info) throw() = 0;
  virtual SDKResult SDK_CALLTYPE OpenStream(SDKUInt64 context,
    SDKStreamSP& stream) throw() = 0;
 
  //ISDKNamedProperties
  //virtual SDKResult SDK_CALLTYPE SetProperty(const SDKString& id, const SDKAny& value) throw();
  //virtual SDKResult SDK_CALLTYPE GetProperty(const SDKString& id, SDKAny& value) const throw();
 
  SDK_IMPLEMENT_IID(ISDKResource)
  SDK_END_INTERFACE(ISDKResource)
};
SDK_DECLARE_IID(ISDKResource)
 
class ISDKResourceInfo : public ISDKNamedProperties
{
public:
  virtual SDKResult SDK_CALLTYPE GetClass(
    SDKString& resource_class) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetType(
    SDKString& resource_type) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetName(
    SDKString& name) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetParentPath(
    SDKString& path) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetFullPath(
    SDKString& path) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetSize(
    SDKUInt64& size) const throw() = 0;
 
  //ISDKNamedProperties
  //virtual SDKResult SDK_CALLTYPE SetProperty(const SDKString& id, const SDKAny& value) throw();
  //virtual SDKResult SDK_CALLTYPE GetProperty(const SDKString& id, SDKAny& value) const throw();
 
  SDK_IMPLEMENT_IID(ISDKResourceInfo)
  SDK_END_INTERFACE(ISDKResourceInfo)
};
SDK_DECLARE_IID(ISDKResourceInfo)
 
class ISDKResourceStorage : public ISDKResource
{
public:
  // ISDKResource
  //virtual SDKResult SDK_CALLTYPE GetInfo(SDKResourceInfoSP& info) throw() = 0;
  //virtual SDKResult SDK_CALLTYPE OpenStream(SDKUInt64 context, SDKStreamSP& stream) throw() = 0;
  //ISDKNamedProperties
  //virtual SDKResult SDK_CALLTYPE SetProperty(const SDKString& id, const SDKAny& value) throw();
  //virtual SDKResult SDK_CALLTYPE GetProperty(const SDKString& id, SDKAny& value) const throw();
  
  virtual SDKResult SDK_CALLTYPE GetResource(const SDKString& name, 
    SDKResourceSP& resource) throw() = 0;
  virtual SDKResult SDK_CALLTYPE EnumResources(
    SDKResourceStorageEnumeratorSP& enumerator) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE CreateResource(const SDKString& resource_type,
    const SDKString& name, SDKResourceSP& resource) throw() = 0;
  virtual SDKResult SDK_CALLTYPE DeleteResource(
    const SDKString& name) throw() = 0;
 
  SDK_IMPLEMENT_IID(ISDKResourceStorage)
  SDK_END_INTERFACE(ISDKResourceStorage)
};
SDK_DECLARE_IID(ISDKResourceStorage)
 
class ISDKResourceStorageEnumerator : public ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE Reset() throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetNext(SDKResourceSP& resource) throw() = 0;
 
  SDK_IMPLEMENT_IID(ISDKResourceStorageEnumerator)
  SDK_END_INTERFACE(ISDKResourceStorageEnumerator)
};
SDK_DECLARE_IID(ISDKResourceStorageEnumerator)
 
class ISDKResourceManager : public ISDKNamedProperties
{
public:
  virtual SDKResult SDK_CALLTYPE Create (const SDKString& resource_type,
    const SDKString& name, SDKResourceSP& resource) = 0;
  virtual SDKResult SDK_CALLTYPE Delete (const SDKString& name) = 0;
  virtual SDKResult SDK_CALLTYPE Copy(const SDKString& name, 
    const SDKString& new_name, SDKResourceSP& new_resource) = 0;
  virtual SDKResult SDK_CALLTYPE Move(const SDKString& name, 
    const SDKString& new_name, SDKResourceSP& new_resource) = 0;
  virtual SDKResult SDK_CALLTYPE IsExist(const SDKString& name) = 0;
  
  //ISDKNamedProperties
  //virtual SDKResult SDK_CALLTYPE SetProperty(const SDKString& id, const SDKAny& value) throw() = 0;
  //virtual SDKResult SDK_CALLTYPE GetProperty(const SDKString& id, SDKAny& value) const throw() = 0;
 
  SDK_IMPLEMENT_IID(ISDKResourceManager)
  SDK_END_INTERFACE(ISDKResourceManager)
};
SDK_DECLARE_IID(ISDKResourceManager)
 
class ISDKMemoryBuffer : public ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE GetRawData(SDKUInt8** buffer, 
    SDKUInt64* size)  throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetSize(SDKUInt64& size)  throw() = 0;
 
  SDK_IMPLEMENT_IID(ISDKMemoryBuffer)
  SDK_END_INTERFACE(ISDKMemoryBuffer)
};
SDK_DECLARE_IID(ISDKMemoryBuffer)
 
} // namespace base
} // namespace sdk 
 
#endif // SDK_BASE_SDK_STORAGE_INTERFACE_H_