DbBaseHostAppServices.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 _ODDB_BASEHOSTAPPSERVICES_INCLUDED_
#define _ODDB_BASEHOSTAPPSERVICES_INCLUDED_
 
 
#include "TD_PackPush.h"
 
 
#include "DbRootExport.h"
#include "DbBaseDatabase.h"
#include "DbHostAppProgressMeter.h"
#include "RxObject.h"
#include "SmartPtr.h"
#include "OdFont.h"
#include "BrepBuilder/BrepBuilder.h"
 
class OdGsDevice;
typedef OdSmartPtr<OdGsDevice> OdGsDevicePtr;
 
class OdDbUndoController;
typedef OdSmartPtr<OdDbUndoController> OdDbUndoControllerPtr;
 
class OdAuditInfo;
class OdTtfDescriptor;
 
 
typedef unsigned long LCID;
 
enum OdSDIValues
{
  kMDIEnabled             = 0,
  kSDIUserEnforced        = 1,
  kSDIAppEnforced         = 2,
  kSDIUserAndAppEnforced  = 3
};
 
enum ProdIdCode
{
  kProd_ACAD = 1, // Plain
  kProd_LT   = 2, // Lite
  kProd_OEM  = 3, // OEM
  kProd_OdDb = 4  // ..
};
 

class ODRX_ABSTRACT DBROOT_EXPORT OdDbBaseHostAppServices : public OdRxObject
{
public:
  ODRX_DECLARE_MEMBERS(OdDbBaseHostAppServices);
 
  OdDbBaseHostAppServices();
 
  enum RemapFileContext
  {
    kDrawingOpen        = 0,
    kXrefResolution     = 1,
    kRasterResolution   = 2
  };
 
  enum FindFileHint
  {
    kDefault              = 0,  // Any file.
    kFontFile             = 1,  // Can be either SHX or TTF file.
    kCompiledShapeFile    = 2,  // SHX file.
    kTrueTypeFontFile     = 3,  // TTF file.
    kEmbeddedImageFile    = 4,  // Image file (ISM).
    kXRefDrawing          = 5,  // Drawing template file (DWT).
    kPatternFile          = 6,  // Pattern file (PAT).
    kTXApplication        = 7,  // ODA Xtension file (TX).
    kFontMapFile          = 8,  // FontMap file (FMP).
    kUnderlayFile         = 9,  // Underlay file.
    kTextureMapFile       = 10, // Material texture file.
    kPhotometricWebFile   = 11, // Photometric web file (IES).
    kAssetLibXMLFile      = 12, // ADSK asset library file (XML).
    kTemplateFile         = 13, // Template files of any kinds (HTML, ...)
    kSchemaFile           = 14  // Schema files (EXP, XSD, ...)
  };
 
  enum GsBitmapDeviceFlags
  {
    kUseSoftwareHLR       = (1 << 0), // Enable use of SoftwareHLR on device
    kFor2dExportRender    = (1 << 1), // Device for shaded viewport export
    kFor2dExportRenderHLR = (1 << 2), // Device for HiddenLine viewport export
    kForThumbnail         = (1 << 3)  // Device for thumbnail image generation
  };

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

  virtual OdDbHostAppProgressMeter* newProgressMeter();

  virtual void releaseProgressMeter(
    OdDbHostAppProgressMeter* pProgressMeter);

  virtual const OdString program() = 0;

  virtual const OdString product() = 0;

  virtual const OdString companyName() = 0;

  virtual ProdIdCode prodcode();

  virtual const OdString releaseMajorMinorString();

  virtual int releaseMajorVersion();

  virtual int releaseMinorVersion();

  virtual const OdString versionString();

  virtual void warning(
    const OdString& message);
  
  virtual void warning(
    const char* warnVisGroup,
    const OdString& message);
    
  virtual void warning(
    OdWarning warningOb);
    
  virtual void warning(
    const char* warnVisGroup,
    OdWarning warningOb);
 
  //virtual void warning(
  //  OdWarning warningOb,
  //  OdDbObjectId objectId);

  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 OdDbUndoControllerPtr newUndoController();

  virtual OdStreamBufPtr newUndoStream();

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

  virtual bool ttfFileNameByDescriptor(
    const OdTtfDescriptor& description,
    OdString& filename);

  virtual OdString getAlternateFontName() const = 0;

  virtual OdString getFontMapFileName() const = 0;

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

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

  virtual OdString getSubstituteFontByChar(
    const OdFont& /*pFont*/,
    OdChar /*unicodeChar*/, OdDbBaseDatabase* /*pDb*/) { return OdString::kEmpty; }

  virtual bool getSystemFontFolders(
    OdStringArray& aDirs);

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

  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 OdGsDevicePtr gsBitmapDevice(
    OdRxObject* pViewObj = NULL,
    OdDbBaseDatabase* pDb = NULL,
    OdUInt32 flags = 0);

  virtual OdString getTempPath() const;
 
// ODA_MT_DBIO_BEGIN
  virtual OdInt16 getMtMode() const;

  virtual int numThreads(OdDb::MultiThreadedMode mtMode);
// ODA_MT_DBIO_END

  virtual OdResult brepBuilder(OdBrepBuilder& bbuilder, BrepType bbType);

  virtual OdResult getEnv(const OdString &varName, OdString &value);

  virtual OdResult setEnv(const OdString &varName, const OdString &newValue);

  virtual OdString getAppUserName(Oda::UserNameFormat unFormat = Oda::kUserId);
};
 
typedef OdSmartPtr<OdDbBaseHostAppServices> OdDbBaseHostAppServicesPtr;
 
 
#include "TD_PackPop.h"
 
#endif // _ODDB_BASEHOSTAPPSERVICES_INCLUDED_