AcDbHostApplicationServices.h

Go to the documentation of this file.

#pragma once
 
//
// (C) Copyright 2005-2024 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted,
// provided that the above copyright notice appears in all copies and
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS.
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#include "..\acad\Acad.h"
#include "..\acad\AcadInet.h"
#include "..\acdb17\AcadApp.h"
#include "..\acdb17\AcRxObject.h"
 
class AcDbAbstractClipBoundaryDefinition;
class AcDbAuditInfo;
class AcDbDatabase;
class AcDbGlobals;
class AcDbHostApplicationProgressMeter;
class AcDbLayoutManager;
class AcDbPlotSettingsValidator;
class AcDbTransactionManager;
class AcDbUndoController;
class AcRxClass;
class AcadInternalServices;
class CArchive;
class COleClientItem;
class ClipBoundaryArray;
class AcadInternalServices2;
class AcPwdCache;
struct flagmat;
 
typedef Acad::ErrorStatus(*SELECTFILEPROC)(short *, ACHAR *&, void*, const int, const ACHAR *, const ACHAR *, const ACHAR *,
                                           const ACHAR *, int*, bool*, const ACHAR *, AcStringArray*);
 
typedef Acad::ErrorStatus(*REMAPPROC) (ACHAR *&, const ACHAR *, int, void*);
 
typedef void(*MAPFILENOTIFYPROC) (const ACHAR *, const ACHAR *, int, void*);
 
class ARX_API AcDbHostApplicationServices : public AcRxObject
{
public:
    ACRX_DECLARE_MEMBERS(AcDbHostApplicationServices);
 
    enum PasswordOptions
    {
        kPasswordOptionDefault = 0,
        kPasswordOptionUpperCase = 1,
        kPasswordOptionIsExternalReference = 2
    };
 
    enum FindFileHint
    {
        kDefault = 0,
        kFontFile,
        kCompiledShapeFile,
        kTrueTypeFontFile,
        kEmbeddedImageFile,
        kXRefDrawing,
        kPatternFile,
        kARXApplication,
        kFontMapFile,
        kUnderlayFile,
        kDataLinkFile,
        kPhotometricWebFile,
        kMaterialMapFile,
        kCloudOrProjectFile,
    };
 
    enum RemapFileContext
    {
        kDrawingOpen,
        kXrefResolution,
        kRasterResolution,
        kAfterXrefResolution
    };
 
    enum ModelerFlavor
    {
        kModelerFull = 0,
        kModelerRegionsOnly = 1,
        kModelerObjectsOnly = 2
    };
 
    enum RequiredVersionFlags {
        kNoOpen = 0,
        kReadOnly = 1,
        kWriteAllowed = 2
    };
 
    AcDbHostApplicationServices(int = 1);
    code_page_id  getSystemCodePage(void);
    virtual  ~AcDbHostApplicationServices(void);
    virtual bool  getPassword(wchar_t const *, PasswordOptions, wchar_t *, unsigned int);
    virtual bool  loadApp(wchar_t const *, AcadApp::LoadReasons, bool, bool);
    virtual AcDbAbstractClipBoundaryDefinition *  newClipBoundaryPolygonal(void);
    virtual AcDbAbstractClipBoundaryDefinition *  newClipBoundaryRectangular(void);
    virtual AcDbGlobals *  createWorkingGlobals(void);
    virtual AcDbHostApplicationProgressMeter *  newProgressMeter(void);
    virtual AcDbLayoutManager *  layoutManager(void)const;
    virtual AcDbPlotSettingsValidator *  plotSettingsValidator(void)const;
    virtual ClipBoundaryArray *  newClipBoundaryArray(void);
    virtual Acad::ErrorStatus  getLocalRootFolder(wchar_t const * &);
    virtual Acad::ErrorStatus  getNewOleClientItem(COleClientItem * &);
    virtual Acad::ErrorStatus  getRoamableRootFolder(wchar_t const * &);
    virtual Acad::ErrorStatus  putRemoteFile(wchar_t const *, wchar_t const *)const;
    virtual Acad::ErrorStatus  serializeOleItem(COleClientItem *, CArchive *);
    virtual Acad::ErrorStatus  signingComplete(Acad::ErrorStatus, wchar_t const *, bool *);
    virtual const ProdIdCode prodcode(void);
    virtual int  _entToWorldTransform(double * const, flagmat *);
    virtual int  doFullCRCCheck(void);
    virtual int  getSubstituteFont(wchar_t * *, wchar_t *, int, int);
    virtual int  isURL(wchar_t const *)const;
    virtual Adesk::Boolean  launchBrowserDialog(wchar_t *, wchar_t const *, wchar_t const *, wchar_t const *, wchar_t const *, Adesk::Boolean = Adesk::kFalse)const;
    virtual int  readyToDisplayMessages(void);
    virtual int  releaseMajorVersion(void);
    virtual int  releaseMinorVersion(void);
    virtual int  userBreak(bool = true)const;
    unsigned int  getTempPath(unsigned long, wchar_t *);
    unsigned long  getRegistryProductLCID(void);
    virtual void  alert(wchar_t const *)const;
    virtual void  auditPrintReport(AcDbAuditInfo *, wchar_t const *, int)const;
    virtual void  displayChar(wchar_t)const;
    virtual void  displayString(wchar_t const *, int)const;
    virtual void  drawOleOwnerDrawItem(COleClientItem *, long, long, long, long, long);
    virtual void  enableMessageDisplay(int);
    virtual void  missingCryptoProviderMsg(void);
    virtual void  usedPasswordFromCacheMsg(wchar_t const *);
    virtual wchar_t const *  companyName(void);
    virtual wchar_t const *  getEnv(wchar_t const *);
    virtual wchar_t const *  product(void);
    virtual wchar_t const *  program(void);
    virtual wchar_t const *  releaseMajorMinorString(void);
    virtual wchar_t const *  versionString(void);
    void *  acadInternalGetvar(wchar_t const *);
    void  setDefaultUndoController(AcDbUndoController *);
    void  setSystemCodePage(code_page_id);
    void  setWorkingDatabase(AcDbDatabase *);
    void  setWorkingGlobals(AcDbGlobals *);
    void  setWorkingProgressMeter(AcDbHostApplicationProgressMeter *);
    void  setWorkingTransactionManager(AcDbTransactionManager *);
    AcDbDatabase* workingDatabase();
    virtual AcDbUndoController * defaultUndoController();
    virtual AcDbTransactionManager * workingTransactionManager();
    virtual ACHAR * getAlternateFontName() const;
    virtual ACHAR * getFontMapFileName() const;
    virtual bool cacheSymbolIndices() const;
    Acad::ErrorStatus findFile(AcString&, const ACHAR *, AcDbDatabase * = nullptr, AcDbHostApplicationServices::FindFileHint = AcDbHostApplicationServices::kDefault);
    virtual wchar_t const * getMachineRegistryProductRootKey(void);
    virtual wchar_t const * getUserRegistryProductRootKey(void);
    virtual AcLocale  getProductLocale();
    virtual Acad::ErrorStatus getAllUsersRootFolder(const ACHAR*&);
    virtual Acad::ErrorStatus getGraphicsCacheFolder(const ACHAR *&);
    virtual Acad::ErrorStatus selectFile(short *, ACHAR *&, void*, const int, const ACHAR *, const ACHAR *, const ACHAR *,
        const ACHAR *, int*, bool*, const ACHAR *, AcStringArray*);
    virtual Acad::ErrorStatus registerSelectFileCallback(const ACHAR *, SELECTFILEPROC, bool = false, bool = false);
    virtual const ACHAR *     primaryClientForSelectFileCallback();
    virtual Acad::ErrorStatus getRegisteredSelectFileClients(AcArray<const ACHAR *>&);
    virtual Acad::ErrorStatus   mapFile(ACHAR *&, const ACHAR *, int, void*);
    virtual Acad::ErrorStatus   registerMapFileCallback(const ACHAR *, REMAPPROC, bool = false, bool = false);
    virtual const ACHAR * primaryClientForMapFileCallback();
    virtual bool setMapFlag(bool);
    virtual Acad::ErrorStatus getRegisteredFileMapClients(AcArray<const ACHAR *>&);
    virtual Acad::ErrorStatus   registerMapFileNotification(const ACHAR *, MAPFILENOTIFYPROC, bool = false);
    virtual bool requiredVersionNotAvailable(AcDbHostApplicationServices::RequiredVersionFlags, AcDbDatabase*) const;
    virtual void fatalError(const ACHAR *, ...);
    virtual void reportUnhandledArxException(const ACHAR*, const ACHAR *);
    AcString getTempPath();
    virtual bool notifyCorruptDrawingFoundOnOpen(AcDbObjectId, Acad::ErrorStatus);
    virtual AcadInternalServices2* acadInternalServices2();
    bool getPassword(const ACHAR *, AcDbHostApplicationServices::PasswordOptions, AcString&);
    virtual const ACHAR * getColorBookLocation() const;
    AcPwdCache * getPasswordCache() const;
    virtual short getKeyState(int) const;
    virtual Acad::ErrorStatus getRemoteFile(const ACHAR *, ACHAR *, size_t, bool) const;
    Acad::ErrorStatus getRemoteFile(const ACHAR *, AcString&, bool) const;
    virtual void terminateScript();
    AcDbAppSystemVariables * workingAppSysvars() const;
    void setWorkingAppSysvars(AcDbAppSystemVariables*);
    virtual const ACHAR* releaseMarketVersion();
    virtual bool  supportsMultiRedo() const;
    virtual ModelerFlavor  getModelerFlavor() const;
    virtual AcadInternalServices* acadInternalServices();
    virtual bool isRemoteFile(const ACHAR *, ACHAR *, size_t) const;
    bool isRemoteFile(const ACHAR *, AcString&);
    virtual bool getDefaultPlotCfgInfo(ACHAR *, size_t, ACHAR *, size_t);
    void getDefaultPlotCfgInfo(AcString&, AcString&);
 
protected:
    Acad::ErrorStatus  mapInetStatusToAcadStatus(AcadInet::Status)const;
    void  acadInternalSetvar(wchar_t const *, void *);
 
private:
    AcString m_getMachineRegistryProductRootKey;
    AcString m_getUserRegistryProductRootKey;
    code_page_id m_systemCodePage;
};