OleStorage.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
 
#ifndef _ODSTORAGE_INCLUDED_
#define _ODSTORAGE_INCLUDED_
 
#include "RxObject.h"
#include "OdStreamBuf.h"
#include "OdErrorContext.h"
 
#include "TD_PackPush.h"

class FIRSTDLL_EXPORT OdByteData : public OdRxObject
{
public:
  typedef OdUInt32 SizeType;
 
  ODRX_DECLARE_MEMBERS(OdByteData);
  virtual SizeType readAt(SizeType start, OdUInt8 *buffer, SizeType bufferSize) const = 0;

  virtual SizeType writeAt(SizeType start, const OdUInt8 *buffer, SizeType bufferSize) = 0;

  virtual SizeType size() const = 0;
  virtual void resize(SizeType bufferSize) = 0;

  virtual void flush() = 0;
};

typedef OdSmartPtr<OdByteData> OdByteDataPtr;
 

class OdOleStorageError : public OdError
{
public:
  OdOleStorageError(OdErrorContext* pErrorContext) : OdError(pErrorContext) { }
};
 
class OdOleStorage;
typedef OdSmartPtr<OdOleStorage> OdOleStoragePtr;

class FIRSTDLL_EXPORT OdOleStorage : public OdRxObject
{
public:
  ODRX_DECLARE_MEMBERS(OdOleStorage);

  virtual void init(OdByteData* pByteData, int accessMode = Oda::kFileRead) = 0;

  virtual OdByteDataPtr rawData() const = 0;

  virtual OdStreamBufPtr openStream(const OdString &filename,
                                    bool createIfNotFound = false,
                                    int accessMode = Oda::kFileRead) = 0;
                                    
  static OdOleStoragePtr createServiceObject(OdByteData* pInitData);
};
 
#define ODRX_OLESTORAGE_SERVICE_NAME OdOleStorage::desc()->name()
 
#include "TD_PackPop.h"
 
#endif // _ODSTORAGE_INCLUDED_