OdStreamBuf.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 ODSTREAMBUF_DEFINED
#define ODSTREAMBUF_DEFINED
 
#if !defined( FX_PREVIEW )
#include "RxObject.h"
 
#include "TD_PackPush.h"
 
class OdString;
#else
#include <stdio.h>
#include <string>
#include "OdPlatformSettings.h"
#endif
 
namespace Oda
{
 
 
  enum FileAccessMode   // Access
  {
    kFileRead     = (long)
                    0x80000000,   // Read access. Use kFileRead | kFileWrite for read/write access.
    kFileWrite    = 0x40000000,   // Write access. Use kFileRead | kFileWrite for read/write access.
    kFileTmp      = 0x20000000,   // hint to use FILE_ATTRIBUTE_TEMPORARY  for 'FlagsAndAttributes'
    kFileDelete   = 0x10000000,   // hint to use FILE_FLAG_DELETE_ON_CLOSE for 'FlagsAndAttributes'
    kNoFlushWhenClosed = 0x08000000,        //do NOT call FlushFileBuffers when closing file (tremendously accelerates writing small files)
    kFileReadWrite = kFileRead | kFileWrite // Read/Write access.
  };
 
#if !defined( FX_PREVIEW )
  FileAccessMode FIRSTDLL_EXPORT operator | (const FileAccessMode& a, const FileAccessMode& b);
#else
  FileAccessMode operator | (const FileAccessMode& a, const FileAccessMode& b);
#endif
 
  enum FileShareMode
  {
    kShareDenyReadWrite = 0x10, // deny read/write mode
    kShareDenyWrite     = 0x20, // deny write mode
    kShareDenyRead      = 0x30, // deny read mode
    kShareDenyNo        = 0x40  // deny none mode
  };
 
 
  enum FileCreationDisposition
  {
    kCreateNew        = 1,  // Creates a new file; fails if the specified file already exists.
    kCreateAlways     = 2,  // Creates a new file; overwrites any existing file.
    kOpenExisting     = 3,  // Opens the file; fails if the file does not exist.
    kOpenAlways       = 4,  // Opens the file; creates the file if it does not exist.
    kTruncateExisting = 5   // Truncates the file; fails if the file does not exist. The file must be open at least kFileWrite.
  };
}

namespace OdDb
{
  enum FilerSeekType
  {
    kSeekFromStart   = SEEK_SET, // Start of file.
    kSeekFromCurrent = SEEK_CUR, // Current position of file pointer.
    kSeekFromEnd     = SEEK_END  // End of file.
  };
}

#if !defined( FX_PREVIEW )
class FIRSTDLL_EXPORT OdStreamBuf : public OdRxObject
#else
class OdStreamBuf
#endif
{
protected:
  OdStreamBuf();
public:
#if !defined( FX_PREVIEW )
  ODRX_DECLARE_MEMBERS(OdStreamBuf);
#endif

#if !defined( FX_PREVIEW )
  virtual OdString  fileName();
#else
  virtual std::wstring fileName();
#endif

  virtual bool      isEof();
  virtual OdUInt64  tell();
  virtual OdUInt64  length();

  virtual void      truncate();
  virtual void      rewind();
  virtual OdUInt64  seek(OdInt64 offset, OdDb::FilerSeekType seekType);

  virtual OdUInt8   getByte();
  virtual void      getBytes(void* buffer, OdUInt32 numBytes);

  virtual void      putByte(OdUInt8 value);
  virtual void      putBytes(const void* buffer, OdUInt32 numBytes);

  virtual void      copyDataTo(OdStreamBuf* pDestination, OdUInt64 sourceStart = 0, OdUInt64 sourceEnd = 0);
  virtual OdUInt32  getShareMode();

  virtual Oda::FileShareMode getShareMode() const;
};

#if !defined( FX_PREVIEW )
typedef OdSmartPtr<OdStreamBuf> OdStreamBufPtr;
 
#include "TD_PackPop.h"
#endif
 
#endif //ODSTREAMBUF_DEFINED