DocumentManager.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once

#include    <Mstn/Mdlapi/filelist.h>
#include    <RmgrTools/Tools/msstrlst.h>
#include    <Mstn/MicroStationApiErrors.r.h>
#include    <Bentley/WString.h>
#include    <DgnPlatform\DgnDocumentManager.h>
#include    <DgnPlatform\DgnFile.h>
#include    <ECObjects\ECInstance.h>
#include    <vector>



MSTNPLATFORM_TYPEDEFS(DgnFileDocAppData)

BEGIN_BENTLEY_NAMESPACE

typedef RefCountedPtr<MstnPlatform::DgnDocumentList>        DgnDocumentListPtr;
typedef RefCountedPtr<MstnPlatform::MSFolderList>           MSFolderListPtr;

typedef bvector<DgnFilePtr>         T_DgnFilePtrVector;
typedef bvector<DgnFilePtr> const*  T_DgnFilePtrVectorCP;
typedef bvector<DgnFilePtr> const&  T_DgnFilePtrVectorCR;
typedef bvector<DgnFilePtr>&        T_DgnFilePtrVectorR;

END_BENTLEY_NAMESPACE

BEGIN_BENTLEY_MSTNPLATFORM_NAMESPACE

struct  ISessionMgr;


/*=================================================================================**/
struct MSDocumentOpenDialogParams
{
private:
    FileOpenParams      m_params;

public:
    MSCORE_EXPORT MSDocumentOpenDialogParams();

    void SetRscFileHandle (RscFileHandle h)         {m_params.dialogRscH = h;}
    void SetDialogId (RscId dialogid)               {m_params.dialogId = dialogid;}
    void SetOpenCreate (int openCreate)             {m_params.openCreate = openCreate;}
    void SetSuggestedFileName (WCharCP name)        {m_params.suggestedFileNameP =  name;}
    void SetDefaultFilter (WCharCP filter)          {m_params.defaultFilterP = filter;}
    void SetFilterInfoString (WCharCP info)         {m_params.filterInfoStrP = info;}
    void SetDefaultDir (WCharCP dir)                {m_params.defaultDirP = dir;}
    void SetDirCfgVar (WCharCP var)                 {m_params.dirCfgVarP = var;}
    void SetDialogTitle (WCharCP title)             {m_params.titleP = title;}
    void SetDefFileId (int id)                      {m_params.defFileId = id;}
    void SetDefRscFileHandle (RscFileHandle h)      {m_params.defFileRscH = h;}
    void SetDialogOwnerMD (MdlDesc* owner)          {m_params.dialogOwnerMD = owner;}
    void SetDefSeedFileName (WCharP name)           {m_params.defSeedFileNameP = name;}
    void SetDefSeedDir (WCharP dir)                 {m_params.defSeedDirP = dir;}
    void SetDefSeedFilter (WCharP filter)           {m_params.defSeedFilterP = filter;}
    void SetDefSeedFileId (int fileId)              {m_params.defSeedFileId = fileId;}
    void SetRequiredRights (UInt32  rights)         {m_params.requiredRights = rights;}
    void SetFilterStringListId (int id)             {m_params.filterStringListId = id;}
    void SetFilterRscFileHandle (RscFileHandle h)   {m_params.filterStringHandle =h;}
    void SetPreIncludeCADFileOpenFilters (bool on)  {m_params.filterFlags.preIncludeCADFileOpenFilters = on;}
    void SetPostIncludeCADFileOpenFilters (bool on) {m_params.filterFlags.postIncludeCADFileOpenFilters = on;}
    void SetWorkSetName (WCharCP workSetName)       {m_params.workSetNameP = workSetName;}
    void SetWorkSpaceName (WCharCP workSpaceName)   {m_params.workSpaceNameP = workSpaceName; }

    FileOpenParams const& GetFileOpenParams() const {return m_params;}
    FileOpenParams&       GetFileOpenParamsR()      {return m_params;}

    RscFileHandle GetRscFileHandle()          const {return m_params.dialogRscH;}
    RscId         GetDialogId()               const {return m_params.dialogId;}
    int           GetOpenCreate()             const {return m_params.openCreate;}
    WCharCP       GetSuggestedFileName()      const {return m_params.suggestedFileNameP;}
    WCharCP       GetDefaultFilter()          const {return m_params.defaultFilterP;}
    WCharCP       GetFilterInfoString()       const {return m_params.filterInfoStrP;}
    WCharCP       GetDefaultDir()             const {return m_params.defaultDirP;}
    WCharCP       GetDirCfgVar()              const {return m_params.dirCfgVarP;}
    WCharCP       GetDialogTitle()            const {return m_params.titleP;}
    RscId         GetDefFileId()              const {return m_params.defFileId;}
    RscFileHandle GetDefRscFileHandle()       const {return m_params.defFileRscH;}
    MdlDesc*      GetDialogOwnerMD()          const {return m_params.dialogOwnerMD;}
    WCharCP       GetDefSeedFileName()        const {return m_params.defSeedFileNameP;}
    WCharCP       GetDefSeedDir()             const {return m_params.defSeedDirP;}
    WCharCP       GetDefSeedFilter()          const {return m_params.defSeedFilterP;}
    int           GetDefSeedFileId()          const {return m_params.defSeedFileId;}
    UInt32        GetRequiredRights()         const {return m_params.requiredRights;}
    RscId         GetFilterStringListId()     const {return m_params.filterStringListId;}
    RscFileHandle GetFilterRscFileHandle()    const {return m_params.filterStringHandle;}
    bool          GetPreIncludeCADFileOpenFilters()  const {return (0 != m_params.filterFlags.preIncludeCADFileOpenFilters);}
    bool          GetPostIncludeCADFileOpenFilters() const {return (0 != m_params.filterFlags.postIncludeCADFileOpenFilters);}
    WCharCP       GetWorkSetName ()          const {return m_params.workSetNameP;}
    WCharCP       GetWorkSpaceName ()          const {return m_params.workSpaceNameP; }
};

/*=================================================================================**/
struct MSWorkspaceInfo
    {
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    WString     m_workspaceRoot;    
    WString     m_userCfgFilePath;  
    WString     m_projectCfgPath;   
    WString     m_fullCommandLine;  
    WString     m_extraCommandLine; 
    };

/*=================================================================================**/
struct MSDocumentManager : DgnPlatform::DgnDocumentManager
    {
private:
    virtual void MakeClassAbstract() = 0;
public:
public:


    MSCORE_EXPORT DgnDocumentPtr OpenDocumentDialog(DgnPlatform::DgnFileStatus& status, MSDocumentOpenDialogParams& params, int attributes, DgnPlatform::DgnDocument::FetchMode openMode);

    MSCORE_EXPORT DgnDocumentPtr CreateNewDocumentDialog(DgnPlatform::DgnFileStatus& status, MSDocumentOpenDialogParams& params, DgnPlatform::DgnDocument::OverwriteMode overwriteMode);

    MSCORE_EXPORT DgnDocumentMonikerListPtr CreateMonikerList ();
    MSCORE_EXPORT DgnFolderMonikerListPtr   CreateFolderMonikerList ();
    MSCORE_EXPORT DgnBaseMonikerListPtr     CreateDgnBaseMonikerList ();

    MSCORE_EXPORT StatusInt                 PutDocumentList(DgnDocumentListCR docs, DgnPlatform::DgnDocument::PutAction, DgnPlatform::DgnDocument::PutOptions, WCharCP comment = NULL);

    MSCORE_EXPORT DgnDocumentListPtr        OpenDocumentListEditDialog(StatusInt&, MSDocumentOpenDialogParams&, FileListInfo*, int attributes, WCharCP listLabel, WCharCP basePath, DgnPlatform::DgnDocument::FetchMode);


    MSCORE_EXPORT DgnFolderMonikerPtr       OpenFolderDialog(StatusInt &, MSDocumentOpenDialogParams &, int attributes, WCharCP basePath, DgnPlatform::DgnDocument::FetchMode);


    MSCORE_EXPORT   StatusInt               CompareDocumentWorkspaces(bool & profilesEqual, DgnDocumentMonikerCR document1, DgnDocumentMonikerCR document2, WCharCP generatorArgs);


    MSCORE_EXPORT StatusInt                 GetDocumentWorkspace(bool* workspaceAssigned, MSWorkspaceInfo* workspaceInfo, DgnDocumentMonikerCR documentMoniker, WCharCP generatorArgs);


    MSCORE_EXPORT static MSDocumentManagerR GetManager();
    };

typedef bvector<DgnDocumentPtr> T_DocumentPtrVec;
/*=================================================================================**/
struct DgnDocumentList : RefCountedBase, T_DocumentPtrVec
    {
private:
    virtual void MakeClassAbstract() = 0;
public:
    };

END_BENTLEY_MSTNPLATFORM_NAMESPACE