/////////////////////////////////////////////////////////////////////////////// 
// Copyright (C) 2002-2016, 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 Teigha(R) software pursuant to a license 
//   agreement with Open Design Alliance.
//   Teigha(R) Copyright (C) 2002-2016 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 "DbSystemServices.h"
#include "OdErrorContext.h"

#include "TD_PackPush.h"

/** \details
    This class is the base class for custom classes
    that implement unsigned ByteData storage.
    Library: TD_Db
    <group Other_Classes> 
*/
class FIRSTDLL_EXPORT OdByteData : public OdRxObject
{
public:
  typedef OdUInt32 SizeType;

  ODRX_DECLARE_MEMBERS(OdByteData);
  /** \details
    Copies the specified bytes from this ByteData object to the specified buffer.
    
    \param start [in]  Starting position.
    \param bufferSize [in]  Number of bytes.
    \param buffer [out]  Receives the bytes.
  */
  virtual SizeType readAt(SizeType start, OdUInt8 *buffer, SizeType bufferSize) const = 0;

  /** \details
    Copies the specified bytes from the specified buffer to this ByteData object.
    
bufferSize  
  */
  virtual SizeType writeAt(SizeType start, const OdUInt8 *buffer, SizeType bufferSize) = 0;

  /** \details
    Returns the number of bytes in this ByteData object.
  */
  virtual SizeType size() const = 0;
  /** \details
    Resizes this ByteData object.
    \param bufferSize [in]  Number of bytes.
  */
  virtual void resize(SizeType bufferSize) = 0;

  /** \details
    Empties this ByteData object.
  */
  virtual void flush() = 0;
};

/** \details
    This template class is a specialization of the OdSmartPtr class for OdByteData object pointers.
*/
typedef OdSmartPtr<OdByteData> OdByteDataPtr;


/** \details
    This class implements OdError objects with access to their associated ErrorContext objects.
    
    Library: TD_Db
    <group Error_Classes> 
*/
class OdOleStorageError : public OdError
{
public:
  /** \param pErrorContext [in]  Pointer to the ErrorContext.
  */
  OdOleStorageError(OdErrorContext* pErrorContext) : OdError(pErrorContext) { }
};

class OdOleStorage;
/** \details
    This template class is a specialization of the OdSmartPtr class for OdOleStorage object pointers.
*/
typedef OdSmartPtr<OdOleStorage> OdOleStoragePtr;

/** \details
    This class is the base class for custom classes that implement OLE storage.

    Library: TD_Db
    <group Other_Classes>
*/
class FIRSTDLL_EXPORT OdOleStorage : public OdRxObject
{
public:
  ODRX_DECLARE_MEMBERS(OdOleStorage);

  /** \details
    Initializes this OleStorage object.
    \param pByteData [in]  Pointer to the OdByteData for this OleStorage object.
    \param accessMode [in]   Mode in which to open this OleStorage object.
    
    \remarks
    accessMode must be a combination of one or more of the following:
    
    <table>
    Name                Value          Description
    Oda::kFileRead      0x80000000     Read access.
    Oda::kFileWrite     0x40000000     Write access.
    </table>
  */
  virtual void init(OdByteData* pByteData, int accessMode = Oda::kFileRead) = 0;

  /** \details
    Returns the raw OdByteData for this OleStorage object.
  */
  virtual OdByteDataPtr rawData() const = 0;

  /** \details
    Opens an OdStreamBuf for this OleStorage object. For internal use only.
    
    \param filename [in]  Filename.
    \param accessMode [in]   Mode in which to open this OleStorage object.
    \param createIfNotFound [in]  Controls the creation of the file if it does not exist.
    
    \remarks
    Returns a SmartPointer for the newly created OdStreamBuf object.

    accessMode must be a combination of one or more of the following:
    
    <table>
    Name                Value          Description
    Oda::kFileRead      0x80000000     Read access.
    Oda::kFileWrite     0x40000000     Write access.
    </table>
    
    \note
    createIfNotFound is for Teigha internal use only, and should always be false for Teigha applications.

  */
  virtual OdStreamBufPtr openStream(const OdString &filename,
                                    bool createIfNotFound = false,
                                    int accessMode = Oda::kFileRead) = 0;
                                    
  /** \details
    Creates a service object for this OleStorage object.
    \param pInitData [in]  Pointer to the initial data.
  */
  static OdOleStoragePtr createServiceObject(OdByteData* pInitData);
};

#define ODRX_OLESTORAGE_SERVICE_NAME OdOleStorage::desc()->name()

#include "TD_PackPop.h"

#endif // _ODSTORAGE_INCLUDED_