DbFiler.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 FILER_INCLUDED
#define FILER_INCLUDED
 
#include <float.h>
#include "RxObject.h"
#include "OdStreamBuf.h"
#include "DbObjectId.h"
#include <NextCodeDefs.h>
 
class OdString;
class OdGeScale3d;
class OdBinaryData;
class OdDbFilerController;
class OdDbDatabase;
class OdResBuf;
typedef OdSmartPtr<OdResBuf> OdResBufPtr;
class OdDbObjectId;
class OdGePoint2d;
class OdGePoint3d;
class OdGeVector2d;
class OdGeVector3d;
class OdDbAuditInfo;
 
#include "TD_PackPush.h"

class TOOLKIT_EXPORT OdDbFiler : public OdRxObject
{
public:
  OdDbFiler() {}
 
  ODRX_DECLARE_MEMBERS(OdDbFiler);

  virtual OdResult filerStatus() const;

  virtual void resetFilerStatus();
 
  enum FilerType
  {
    kFileFiler         = 0, // .dwg and .dxf files
    kCopyFiler         = 1,
    kUndoFiler         = 2,  
    kBagFiler          = 3,
    kIdXlateFiler      = 4,
    kPageFiler         = 5,
    kDeepCloneFiler    = 6,
    kIdFiler           = 7,
    kPurgeFiler        = 8,
    kWblockCloneFiler  = 9
  };

  virtual FilerType filerType() const = 0;

  virtual OdDbDatabase* database() const;

  virtual OdDb::DwgVersion dwgVersion(
    OdDb::MaintReleaseVer* pMaintReleaseVer = 0) const;

  OdDbAuditInfo * getAuditInfo() const;

  virtual void setController(
    OdDbFilerController * pFilerController);

  virtual OdDbFilerController* controller() const;
};


class TOOLKIT_EXPORT OdDxfCode
{
public:
  typedef enum
  {
    Unknown         = 0,
    Name            = 1,
    String          = 2,
    Bool            = 3,
    Integer8        = 4,
    Integer16       = 5,
    Integer32       = 6,
    Double          = 7,
    Angle           = 8,
    Point           = 9,
    BinaryChunk     = 10,
    LayerName       = 11,
    Handle          = 12,
    ObjectId        = 13,
    SoftPointerId   = 14,
    HardPointerId   = 15,
    SoftOwnershipId = 16,
    HardOwnershipId = 17,
    Integer64       = 18
  } Type;

  static Type _getType( int code );
};

class TOOLKIT_EXPORT OdDbDxfFiler : public OdDbFiler
{
public:
  ODRX_DECLARE_MEMBERS(OdDbDxfFiler);
  OdDbDxfFiler() {}

  virtual void seek(
    OdInt64 offset, 
    OdDb::FilerSeekType seekType);
  
  virtual OdUInt64 tell() const;

  virtual int precision() const;

  virtual void setPrecision(
    int decimalDigits);

  enum 
  { 
    kDfltPrec = -1, 
    kMaxPrec = DBL_DIG + 1 
  };

  virtual void writeXDataStart();
  
    virtual bool includesDefaultValues() const;

  virtual bool atEOF();
  
  virtual bool atEndOfObject();
  
  virtual bool atExtendedData();

  virtual bool atSubclassData(
    const OdString& subClassName);

  virtual bool atEmbeddedObjectStart();

  virtual int nextItem();
  
  virtual OdResBufPtr nextRb();
  
  virtual void writeRb(
    const OdResBuf* pRb);

    virtual void pushBackItem();
  
  OdString rdString();
  virtual void rdString(
    OdString &value) = 0;

  virtual bool rdBool() = 0;

  virtual OdInt8 rdInt8() = 0;

  virtual OdInt16 rdInt16() = 0;

  virtual OdInt32 rdInt32() = 0;
  
  virtual OdInt64 rdInt64() = 0;

  virtual OdUInt8 rdUInt8() = 0;
  
  virtual OdUInt16 rdUInt16() = 0;
  
  virtual OdUInt32 rdUInt32() = 0;
  
  virtual OdUInt64 rdUInt64() = 0;

  virtual OdDbHandle rdHandle() = 0;
  
  virtual OdDbObjectId rdObjectId() = 0;

  virtual double rdAngle() = 0;

  virtual double rdDouble() = 0;
 
  virtual void rdPoint2d(
    OdGePoint2d& value) = 0;
    
  virtual void rdPoint3d(
    OdGePoint3d& value) = 0;

  virtual void rdVector2d(
    OdGeVector2d& value) = 0;

  virtual void rdVector3d(
    OdGeVector3d& value) = 0;
  
  virtual void rdScale3d(
    OdGeScale3d& value) = 0;
    
  virtual void rdBinaryChunk(
    OdBinaryData& value) = 0;

  virtual void copyItem(
    OdDbDxfFiler * pSource);

  virtual void wrName(
    int groupCode,
    const OdString& value) = 0;
    
    virtual void wrString(
    int groupCode, 
    const OdString& value) = 0;
    
    void wrStringOpt(
    int groupCode, 
    const OdString& value);

    void wrSubclassMarker(
    const OdString &value);

    void wrEmbeddedObjectStart();

    virtual void wrBool(
    int groupCode, 
    bool value) = 0;
    
  void wrBoolOpt(
    int groupCode, 
    bool value, 
    bool defaultValue);

    virtual void wrInt8(
    int groupCode, 
    OdInt8 value) = 0;
    
  void wrInt8Opt(
    int groupCode, 
    OdInt8 value, 
    OdInt8 defaultValue);

    virtual void wrUInt8(
    int groupCode, 
    OdUInt8 value) = 0;
  void wrUInt8Opt(
    int groupCode, 
    OdUInt8 value, 
    OdUInt8 defaultValue);

    virtual void wrInt16(
    int groupCode, 
    OdInt16 value) = 0;
    
  void wrInt16Opt(
    int groupCode, 
    OdInt16 value, 
    OdInt16 defaultValue);

    virtual void wrUInt16(
    int groupCode, 
    OdUInt16 value) = 0;
    
  void wrUInt16Opt(
    int groupCode, 
    OdUInt16 value, 
    OdUInt16 defaultValue);

    virtual void wrInt32(
    int groupCode, 
    OdInt32 value) = 0;
    
  void wrInt32Opt(
    int groupCode, 
    OdInt32 value, 
    OdInt32 defaultValue);

    virtual void wrUInt32(
    int groupCode, 
    OdUInt32 value) = 0;
    
  void wrUInt32Opt(
    int groupCode, 
    OdUInt32 value, 
    OdUInt32 defaultValue);

    virtual void wrInt64(
    int groupCode, 
    OdInt64 value) = 0;

  void wrInt64Opt(
    int groupCode, 
    OdInt64 value, 
    OdInt64 defaultValue);

    virtual void wrUInt64(
    int groupCode, 
    OdUInt64 value) = 0;

  void wrUInt64Opt(
    int groupCode, 
    OdUInt64 value, 
    OdUInt64 defaultValue);

    virtual void wrHandle(
    int groupCode, 
    OdDbHandle value) = 0;

    virtual void wrObjectId(
    int groupCode, 
    OdDbObjectId value) = 0;
    
  void wrObjectIdOpt(
    int groupCode, 
    OdDbObjectId value);

    virtual void wrAngle(
    int groupCode, 
    double value, 
    int precision = kDfltPrec) = 0;
    
  void wrAngleOpt(
    int groupCode, 
    double value, 
    double defaultValue = 0., 
    int precision = kDfltPrec);

    virtual void wrDouble(
    int groupCode, 
    double value, 
    int precision = kDfltPrec) = 0;
    
  void wrDoubleOpt(
    int groupCode, 
    double value, 
    double defaultValue = 0., 
    int precision = kDfltPrec);

    virtual void wrPoint2d(
    int groupCode, 
    const OdGePoint2d& value, 
    int precision = kDfltPrec) = 0;
    
  void wrPoint2dOpt(
    int groupCode, 
    const OdGePoint2d& value, 
    const OdGePoint2d& defaultValue, 
    int precision = kDfltPrec);

    virtual void wrPoint3d(
    int groupCode, 
    const OdGePoint3d& value, 
    int precision = kDfltPrec) = 0;
    
  void wrPoint3dOpt(
    int groupCode, 
    const OdGePoint3d& value, 
    const OdGePoint3d& defaultValue, 
    int precision = kDfltPrec);

    virtual void wrVector2d(
    int groupCode, 
    const OdGeVector2d& value, 
    int precision = kDfltPrec) = 0;
    
  void wrVector2dOpt(
    int groupCode, 
    const OdGeVector2d& value, 
    const OdGeVector2d& defaultValue, 
    int precision = kDfltPrec);

    virtual void wrVector3d(
    int groupCode, 
    const OdGeVector3d& value, 
    int precision = kDfltPrec) = 0;
    
  void wrVector3dOpt(
    int groupCode, 
    const OdGeVector3d& value, 
    const OdGeVector3d& defaultValue, 
    int precision = kDfltPrec);

    virtual void wrScale3d(
    int groupCode, 
    const OdGeScale3d& value, 
    int precision = kDfltPrec) = 0;

    virtual void wrBinaryChunk(
    int groupCode, 
    const OdUInt8* buffer, 
    OdUInt32 numBytes) = 0;
     
  void wrBinaryChunk(
    int groupCode, 
    const OdBinaryData& value);
};

typedef OdSmartPtr<OdDbDxfFiler> OdDbDxfFilerPtr;

class TOOLKIT_EXPORT OdError_DwgObjectImproperlyRead : public OdError
{
public:
  OdError_DwgObjectImproperlyRead() : OdError(eDwgObjectImproperlyRead){}
};

class TOOLKIT_EXPORT OdDbDwgFiler : public OdDbFiler
{
public:
  OdDbDwgFiler() {}
 
  ODRX_DECLARE_MEMBERS(OdDbDwgFiler);

  virtual void seek(
    OdInt64 offset, 
    OdDb::FilerSeekType seekType) = 0;

  virtual OdUInt64 tell() const = 0;

  virtual bool rdBool() = 0;

  virtual OdString rdString() = 0;
 
  
  virtual void rdBytes(
    void* buffer, 
    OdUInt32 numBytes) = 0;
 

  virtual OdInt8 rdInt8() = 0;
  
  virtual OdUInt8 rdUInt8() = 0;

  virtual OdInt16 rdInt16() = 0;

  virtual OdInt32 rdInt32() = 0;

  virtual OdInt64 rdInt64() = 0;

  virtual void* rdAddress();

  virtual double rdDouble() = 0;

  virtual double rdDoubleNoCheck();

  virtual OdDbHandle rdDbHandle() = 0;

  virtual OdDbObjectId rdSoftOwnershipId() = 0;

  virtual OdDbObjectId rdHardOwnershipId() = 0;

  virtual OdDbObjectId rdHardPointerId() = 0;

  virtual OdDbObjectId rdSoftPointerId() = 0;

  virtual OdGePoint2d rdPoint2d() = 0;
    
  virtual OdGePoint3d rdPoint3d() = 0;

  virtual OdGeVector2d rdVector2d() = 0;

  virtual OdGeVector3d rdVector3d() = 0;
  
  virtual OdGeScale3d rdScale3d() = 0;

  virtual double rdThickness();

  virtual OdGeVector3d rdExtrusion();
 

    virtual void wrBool(
    bool value) = 0;

    virtual void wrString(
    const OdString &value) = 0;
    
  virtual void wrBytes(
    const void* buffer, 
    OdUInt32 numBytes) = 0;

    virtual void wrInt8(
    OdInt8 value) = 0;
    
    virtual void wrUInt8(
    OdUInt8 value) = 0;

    virtual void wrInt16(
    OdInt16 value) = 0;
    
    virtual void wrInt32(
    OdInt32 value) = 0;

    virtual void wrInt64(
    OdInt64 value) = 0;

    virtual void wrAddress(
    const void* value);
    
    virtual void wrDouble(double value) = 0;

    virtual void wrDbHandle(
    const OdDbHandle& value) = 0;

    virtual void wrSoftOwnershipId(
    const OdDbObjectId& value) = 0;
    
    virtual void wrHardOwnershipId(
    const OdDbObjectId& value) = 0;

    virtual void wrSoftPointerId(
    const OdDbObjectId& value) = 0;

    virtual void wrHardPointerId(
    const OdDbObjectId& value) = 0;

    virtual void wrPoint2d(
    const OdGePoint2d& value) = 0;

    virtual void wrPoint3d(
    const OdGePoint3d& value) = 0;
  
    virtual void wrVector2d(
    const OdGeVector2d& value) = 0;
  
    virtual void wrVector3d(
    const OdGeVector3d& value) = 0;
  
    virtual void wrScale3d(
    const OdGeScale3d& value) = 0;

  virtual void wrThickness(double value);

  virtual void wrExtrusion(const OdGeVector3d& value);

  virtual bool usesReferences() const;
  
  virtual void addReference(OdDbObjectId id, OdDb::ReferenceType rt);

  virtual bool isPersistentMode() const;
};

typedef OdSmartPtr<OdDbDwgFiler> OdDbDwgFilerPtr;
 

class TOOLKIT_EXPORT OdIdFiler : public OdDbDwgFiler
{
public:
  OdIdFiler() : m_pController(NULL) {}
 
  void seek(
    OdInt64 offset, 
    OdDb::FilerSeekType seekType);
  
  OdUInt64 tell() const;
  
  OdResult filerStatus() const;
  
  void resetFilerStatus();
  
  FilerType filerType() const;
  
  OdDb::DwgVersion dwgVersion(
    OdDb::MaintReleaseVer* pMaintReleaseVer = 0) const;
    
  bool rdBool();
  
  OdString rdString();
  
  void rdBytes(
    void* buffer, 
    OdUInt32 numBytes);
 
  OdInt8 rdInt8();
  OdUInt8 rdUInt8();
  OdInt16 rdInt16();
  OdInt32 rdInt32();
  OdInt64 rdInt64();
  double rdDouble();
  OdDbHandle rdDbHandle();
 
  OdDbObjectId rdSoftOwnershipId();
  OdDbObjectId rdHardOwnershipId();
  OdDbObjectId rdHardPointerId();
  OdDbObjectId rdSoftPointerId();
 
  OdGePoint2d rdPoint2d();
  OdGePoint3d rdPoint3d();
  OdGeVector3d rdVector3d();
  OdGeVector2d rdVector2d();
  OdGeScale3d rdScale3d();
 
  void wrBool(
    bool value);
 
  void wrString(
    const OdString &value);
    
  void wrBytes(
    const void* buffer, 
    OdUInt32 numBytes);
 
  void wrInt8(
    OdInt8 value);
  void wrUInt8(
    OdUInt8 value);
  void wrInt16(
    OdInt16 value);
  void wrInt32(
    OdInt32 value);
  void wrInt64(
    OdInt64 value);
  void wrDouble(
    double value);
  void wrDbHandle(
    const OdDbHandle& value);
 
  void wrPoint2d(
    const OdGePoint2d& value);
  void wrPoint3d(
    const OdGePoint3d& value);
  void wrVector2d(
    const OdGeVector2d& value);
  void wrVector3d(
    const OdGeVector3d& value);
  void wrScale3d(
    const OdGeScale3d& value);
 
  void setController(
    OdDbFilerController* pFilerController) { m_pController = pFilerController; }
  OdDbFilerController* controller() const { return m_pController; }
private:
  OdDbFilerController* m_pController;
};
 
#include "TD_PackPop.h"
 
#endif  // FILER_INCLUDED