DbHostAppServices.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 _ODDBHOSTAPPLICATIONSERVICES_INCLUDED_
#define _ODDBHOSTAPPLICATIONSERVICES_INCLUDED_
 
 
#include "TD_PackPush.h"
 
#include "SmartPtr.h"
#include "DbBaseHostAppServices.h"
#include "DbLayoutManager.h"
#include "OdStreamBuf.h"
#include "DbDatabase.h"
#include "OdFont.h"
#include "OdBinaryData.h"
#include "DbSecurity.h"
#include "DbPlotSettingsValidator.h"
#include "ModelerGeometryCreator.h"
 
class OdDbKey;
class OdDbAbstractClipBoundaryDefinition;
class ClipBoundaryArray;
class OdHatchPatternManager;
class OdDbPageController;
class OdDbSymbolTableRecord;

typedef OdSmartPtr<OdDbPageController> OdDbPageControllerPtr;
 
#pragma warning (push)
#pragma warning (disable : 4251)
class ODRX_ABSTRACT TOOLKIT_EXPORT OdDbHostAppServices : public OdDbBaseHostAppServices
{
public:
  ODRX_DECLARE_MEMBERS(OdDbHostAppServices);
 
  OdDbHostAppServices();
  virtual ~OdDbHostAppServices();

  virtual OdString findFile(
    const OdString& filename,
    OdDbBaseDatabase* pDb = 0,
    FindFileHint hint = kDefault);

  virtual OdDbHostAppProgressMeter* newProgressMeter();

  virtual void releaseProgressMeter(
    OdDbHostAppProgressMeter* pProgressMeter);

  virtual OdRxClass* databaseClass() const;

  virtual OdDbDatabasePtr createDatabase(
    bool createDefault = true,
    OdDb::MeasurementValue measurement = OdDb::kEnglish) const;

  virtual OdDbDatabasePtr readFile(
    OdStreamBuf* pStreamBuf,
    bool allowCPConversion = false,
    bool partialLoad = false,
    const OdPassword& password = OdPassword());

  virtual OdDbDatabasePtr recoverFile(
    OdStreamBuf* pStreamBuf,
    OdDbAuditInfo *pAuditInfo = 0,
    const OdPassword& password = OdPassword());

  virtual OdDbDatabasePtr readFile(
    const OdString& filename,
    bool allowCPConversion = false,
    bool partialLoad = false,
    Oda::FileShareMode shareMode = Oda::kShareDenyNo,
    const OdPassword& password = OdPassword())
  {
    Oda::FileAccessMode nDesiredAccess = Oda::kFileRead;
    return readFile(odSystemServices()->createFile(filename, nDesiredAccess, shareMode),
      allowCPConversion, partialLoad, password);
  }
 

  virtual const OdString program();

  virtual const OdString product();

  virtual const OdString companyName();

  virtual ProdIdCode prodcode();

  virtual const OdString releaseMajorMinorString();

  virtual int releaseMajorVersion();

  virtual int releaseMinorVersion();

  virtual const OdString versionString();

  TD_USING(OdDbBaseHostAppServices::warning);
  //virtual void warning(
  //  const OdString& message) { odSystemServices()->warning(NULL, message); };
  //virtual void warning(
  //  const char* warnVisGroup,
  //  const OdString& message) { odSystemServices()->warning(warnVisGroup, message); };
  //virtual void warning(
  //  OdWarning warningOb) { warning(NULL, getErrorDescription(warningOb)); }
  //virtual void warning(
  //  const char* warnVisGroup,
  //  OdWarning warningOb) { warning(warnVisGroup, getErrorDescription(warningOb)); }
  
  virtual void warning(
    OdWarning warningOb,
    OdDbObjectId objectId) { warning(NULL, warningOb, objectId); }
  virtual void warning(
    const char* warnVisGroup,
    OdWarning warningOb,
    OdDbObjectId objectId);
  virtual void warning(
    const OdError& err)  { warning(NULL, err.description()); }
  virtual void warning(
    const char* warnVisGroup,
    const OdError& err)  { warning(warnVisGroup, err.description()); }

  virtual OdString getErrorDescription(
    unsigned int errorCode);

  virtual OdString formatMessage(
    unsigned int errorCode,...);
#ifdef ODA_FORMAT
  virtual OdString formatMessage(unsigned int errorCode, long i, const OdString& str) { return formatMessage(errorCode, i, (void*)str.c_str()); }
#endif
 

  virtual bool doFullCRCCheck();

  virtual OdDbUndoControllerPtr newUndoController();

  virtual void auditPrintReport(
    OdAuditInfo* pAuditInfo,
    const OdString& strLine,
    int printDest) const;

  virtual OdDbPlotSettingsValidator* plotSettingsValidator();

/* Moved to OdDbBaseHostAppServices
  virtual bool ttfFileNameByDescriptor(
    const OdTtfDescriptor& description,
    OdString& filename) = 0;
*/
#define REGVAR_DEF(type, name, unused3, unused4, unused5)\
protected:\
 \
  type  m_##name;\
public:\
 \
  SVARS_FUNC_MODIFIER type get##name() const;\
  \
 \
  SVARS_FUNC_MODIFIER void set##name(type val);
 
#include "SysVarDefs.h"
 
#undef REGVAR_DEF
 
 
  virtual OdString getAlternateFontName() const;

  virtual OdString getFontMapFileName() const;

  virtual OdString getPreferableFont(
    const OdString& fontName,
    OdFontType fontType);

  virtual OdString getSubstituteFont(
    const OdString& fontName,
    OdFontType fontType);

  virtual OdString getSubstituteFontByChar(
    const OdFont& pFont,
    OdChar unicodeChar, OdDbBaseDatabase *pDb);

  virtual bool getSystemFontFolders(
     OdStringArray& aDirs);

  virtual void collectFilePathsInDirectory(OdStringArray& res, // out
    const OdString& sPath, // in
    const OdString& sFilter = L"*.*");

  virtual OdHatchPatternManager* patternManager() = 0;

  virtual bool getPassword(
    const OdString& dwgName,
    bool isXref,
    OdPassword& password);
 
  /* { Secret } */
  virtual OdPwdCachePtr getPasswordCache();

  virtual OdDbPageControllerPtr newPageController();

  virtual OdString fileDialog(
    int flags,
    const OdString& dialogCaption = OdString::kEmpty,
    const OdString& defExt = OdString::kEmpty,
    const OdString& defFilename = OdString::kEmpty,
    const OdString& filter = OdString::kEmpty);
 
  virtual OdDbLayoutManagerPtr layoutManager() const;

  virtual OdUInt32 educationalPlotStamp() const;

  virtual OdDbBaseHostAppServices* getDgnHostAppServices() const;

  virtual void getThumbSize(unsigned int& nWidth, unsigned int& nHeight);

  virtual OdGsDevicePtr gsBitmapDevice(
    OdRxObject* pViewObj = NULL,
    OdDbBaseDatabase* pDb = NULL,
    OdUInt32 flags = 0);
 
  virtual OdStreamBufPtr getHistoryFile(OdDbDatabase*);
 
  virtual OdResult brepBuilder(OdBrepBuilder& brepBuilder, BrepType bbType)
  {
    OdRxClassPtr pService(odrxServiceDictionary()->getAt(OD_T("OdModelerGeometryCreator")));
    if (!pService.isNull())
    {
      OdModelerGeometryCreatorPtr pCreator = (OdModelerGeometryCreator*)pService->create().get();
      if (!pCreator.isNull())
      {
        return pCreator->initBrepBuilder(brepBuilder, bbType);
      }
    }
    return eNoInterface;
  }
 
  virtual OdString fixName(const OdDbSymbolTableRecord* pRecord);
 
#ifdef SWIG
  friend class OdDbHostAppServices2;
private:
#endif
  virtual OdDbKey* key() const = 0;
protected:
  OdMutex                       m_LayoutManagerMutex;
  OdMutex                       m_ValidatorMutex;
  OdMutex                       m_PwdCacheMutex;
//  OdMutex                       m_WarningMutex;
  OdDbLayoutManagerPtr          m_pLayoutManager;
  OdDbPlotSettingsValidatorPtr  m_pValidator;
  OdPwdCachePtr                 m_pPwdCache;
};
#pragma warning (pop)

class ODRX_ABSTRACT OdDbHostAppServices2 : public OdDbHostAppServices
{
  virtual OdDbKey* key() const;
protected:
  mutable OdMutex               m_KeyMutex;
};
 
#include "TD_PackPop.h"
 
#endif /* _ODDBHOSTAPPLICATIONSERVICES_INCLUDED_ */