IATSProvider.h

Go to the documentation of this file.

//**************************************************************************/
// Copyright (c) 1998-2005 Autodesk, Inc.
// All rights reserved.
// 
// These coded instructions, statements, and computer programs contain
// unpublished proprietary information written by Autodesk, Inc., and are
// protected by Federal copyright law. They may not be disclosed to third
// parties or copied or duplicated in any form, in whole or in part, without
// the prior written consent of Autodesk, Inc.
//**************************************************************************/
// DESCRIPTION: Interface to ATS Providers 
// AUTHOR: Michael Russo - created December 15, 2004
//***************************************************************************/

#pragma once

#include <WTypes.h>
#include <string>
#include <vector>
#include "..\strbasic.h"
#include "..\MaxHeap.h"

#ifndef ATSExport
    #define ATSExport __declspec( dllexport )
#endif

//
// Consts and Typedefs
//

typedef int         ATSResult;
typedef DWORD       ATSStatus;
typedef DWORD       ATSOption;
typedef LONG_PTR    ATSClientPtr;
typedef DWORD       ATSVersion;
typedef std::basic_string<MCHAR> ATSString;

#define IS_ATS_ERROR(res)   ( ((res) <  kATSResSuccess) ? true : false )

#define IS_ATS_SUCCESS(res) ( ((res) >= kATSResSuccess) ? true : false )

namespace ATS {

    //
    // ATS API Version
    //
    const DWORD     kATSAPIVersion              = 200;

    //
    // ATS Result Codes
    //
    const ATSResult kATSResErrorNotSupported    = -2;
    const ATSResult kATSResError                = -1;
    const ATSResult kATSResSuccess              =  0;
    const ATSResult kATSResSuccessReload        =  1;

    //
    // ATS File Status Flags Out
    //
    const ATSStatus kATSStatusUnknown           = 0x00000000;
    const ATSStatus kATSStatusNotControlled     = 0x00000001;
    const ATSStatus kATSStatusControlled        = 0x00000002;
    const ATSStatus kATSStatusCheckedOut        = 0x00000004;
    const ATSStatus kATSStatusCheckedOutOther   = 0x00000008;
    const ATSStatus kATSStatusOutOfDate         = 0x00000010;
    const ATSStatus kATSStatusDeleted           = 0x00000020;
    const ATSStatus kATSStatusMissing           = 0x00000040;
    const ATSStatus kATSStatusModified          = 0x00000080;
    const ATSStatus kATSStatusHidden            = 0x00000100;
    const ATSStatus kATSStatusShareLock         = 0x00000200;

    const ATSStatus kATSStatusCanCheckin        = 0x00010000;
    const ATSStatus kATSStatusCanCheckout       = 0x00020000;
    const ATSStatus kATSStatusCanUndoCheckout   = 0x00040000;
    const ATSStatus kATSStatusCanGetLatest      = 0x00080000;
    const ATSStatus kATSStatusCanAddFile        = 0x00100000;
    const ATSStatus kATSStatusCanShowHistory    = 0x00200000;
    const ATSStatus kATSStatusCanShowProperties = 0x00400000;

    //
    // ATS File Status Flags In/Out
    //
    const ATSStatus kATSStatusSelected          = 0x0001;
    const ATSStatus kATSStatusChecked           = 0x0002;
    const ATSStatus kATSStatusActive            = 0x0004;
    const ATSStatus kATSStatusExcluded          = 0x0008;
    const ATSStatus kATSStatusHide              = 0x0010;

    //
    // ATS Provider Options
    //
    const ATSOption kATSOptNone                 = 0x0000;
    const ATSOption kATSOptKeepCheckedOut       = 0x0001;
    const ATSOption kATSOptReplaceLocalCopy     = 0x0002;
    const ATSOption kATSOptSilent               = 0x0004;
    const ATSOption kATSOptAssocChildren        = 0x0008;
    const ATSOption kATSOptAssocParents         = 0x0010;
    const ATSOption kATSOptAssocRecurse         = 0x0020;

    //
    // ATS Support option flags
    //
    const ATSOption kATSSupportNone             = 0x0000;
    const ATSOption kATSSupportFileAssoc        = 0x0001;
    const ATSOption kATSSupportExploreProvider  = 0x0002;

    //
    // ATS Client Status Text flags
    //
    const ATSStatus kATSStatusTextNone          = 0x0000;
    const ATSStatus kATSStatusTextInfo          = 0x0001;
    const ATSStatus kATSStatusTextWarning       = 0x0002;
    const ATSStatus kATSStatusTextError         = 0x0004;
    const ATSStatus kATSStatusTextPrompt        = 0x0008;

    //
    // ATS Client Option flags
    //
    const ATSOption kATSClientOptNone           = 0x0000;
    const ATSOption kATSClientOptUIAlwaysOnTop  = 0x0001;

};

//
// class ATSFileEntry
//


class ATSFileEntry : public MaxHeapOperators
{
public:
    ATSExport ATSFileEntry();
    ATSExport virtual ~ATSFileEntry();


    ATSExport virtual const MCHAR*  GetFile();

    ATSExport virtual void          SetFile( const MCHAR *szFile );


    ATSExport virtual ATSStatus     GetFlagsIn();

    ATSExport virtual void          SetFlagsIn( ATSStatus dwFlagsIn );


    ATSExport virtual ATSClientPtr  GetClientPtr();

    ATSExport virtual void          SetClientPtr( ATSClientPtr pClientPtr );


    ATSExport virtual ATSStatus     GetFlagsOut();

    ATSExport virtual void          SetFlagsOut( ATSStatus dwFlagsOut );


    ATSExport virtual UINT          AddChild( ATSFileEntry *pEntry );

    ATSExport virtual UINT          NumChildren();

    ATSExport virtual ATSFileEntry* GetChild( UINT iIndex );

    ATSExport virtual bool          RemoveChild( UINT iIndex );

    ATSExport virtual bool          RemoveAllChildren();


    ATSExport virtual UINT          AddAttachment( const MCHAR *szFile, ATSFileEntry *pEntryParent = NULL, ATSStatus dwFlagsIn = ATS::kATSStatusActive, ATSClientPtr pClientPtr = NULL );

    ATSExport virtual UINT          AddAttachment( ATSFileEntry *pEntry );

    ATSExport virtual UINT          NumAttachments();

    ATSExport virtual ATSFileEntry* GetAttachment( UINT iIndex );

    ATSExport virtual bool          RemoveAttachment( UINT iIndex );

    ATSExport virtual bool          RemoveAllAttachments();


    ATSExport virtual void          SetParent( ATSFileEntry *pParent );

    ATSExport virtual ATSFileEntry* GetParent();

protected:
    ATSString                       mFile;
    ATSStatus                       mFlagsIn;
    ATSStatus                       mFlagsOut;
    ATSClientPtr                    mClientPtr;
    std::vector< ATSFileEntry* >    mChildren;
    ATSFileEntry*                   mpParent;
    std::vector< ATSFileEntry* >    mAttachments;
};

//
// class ATSFileList
//


class ATSFileList : public MaxHeapOperators
{
public:
    ATSExport ATSFileList();
    ATSExport virtual ~ATSFileList();

    //
    // Access to all file entries
    //


    ATSExport virtual ATSFileEntry* CreateEntry( const MCHAR *szFile, ATSFileEntry *pEntryParent = NULL, ATSStatus dwFlagsIn = ATS::kATSStatusActive, ATSClientPtr pClientPtr = NULL );

    ATSExport virtual ATSFileEntry* CreateEntry( ATSFileEntry &atsFileEntry );

    ATSExport virtual bool          RemoveEntry( ATSFileEntry *pEntry );

    ATSExport virtual UINT          NumEntries();

    ATSExport virtual bool          RemoveEntry( UINT iIndex );

    ATSExport virtual bool          RemoveAll();

    ATSExport virtual ATSFileEntry* GetFileEntry( UINT iIndex );

    //
    // Access to active file entries
    //


    ATSExport virtual UINT          BuildActiveList( ATSStatus dwFlagsIn = ATS::kATSStatusActive, bool bDepthFirstTraversal = false );

    ATSExport virtual UINT          AddActiveEntry( ATSFileEntry *pEntry );

    ATSExport virtual bool          RemoveActiveEntry( ATSFileEntry *pEntry );

    ATSExport virtual UINT          NumActiveEntries();

    ATSExport virtual ATSFileEntry* GetActiveFileEntry( UINT iIndex );

    //
    // Access to root level entries
    //


    ATSExport virtual UINT          NumRootEntries();

    ATSExport virtual ATSFileEntry* GetRootEntry( UINT iIndex );

protected:
    std::vector<ATSFileEntry*>      mATSFiles;
    std::vector<ATSFileEntry*>      mATSRoots;
    std::vector<ATSFileEntry*>      mATSActiveFiles;
};

//
// class IATSClientAccess
//


class IATSClientAccess : public MaxHeapOperators
{
public:

    virtual bool        SendStatusText( const MCHAR *szText, ATSStatus dwStatus = ATS::kATSStatusTextNone ) = 0;

    virtual HWND        GetParentWindow() = 0;

    virtual DWORD       GetUIColor( int iIndex ) = 0;

    virtual bool        SilentMode() = 0;

    virtual ATSOption   GetClientOptions() = 0;
};


//
// class ATSClientInfo
//


class ATSClientInfo : public MaxHeapOperators
{
public:
    ATSExport ATSClientInfo();
    ATSExport virtual ~ATSClientInfo();


    ATSExport virtual const MCHAR*  GetClientName();

    ATSExport virtual void          SetClientName( const MCHAR *szClientName );


    ATSExport virtual const MCHAR*  GetUserName();

    ATSExport virtual void          SetUserName( const MCHAR *szUserName );


    ATSExport virtual HWND          GetParentWindow();

    ATSExport virtual void          SetParentWindow( HWND hHwnd );


    ATSExport virtual const MCHAR*  GetProviderPluginPath();

    ATSExport virtual void          SetProviderPluginPath( const MCHAR *szPath );


    ATSExport virtual const MCHAR*  GetConfigFilePath();

    ATSExport virtual void          SetConfigFilePath( const MCHAR *szPath );


    ATSExport virtual IATSClientAccess* GetIATSClientAccess();

    ATSExport virtual void          SetIATSClientAccess( IATSClientAccess* pIATSClientAccess );

protected:
    ATSString                   mClientName;
    ATSString                   mUserName;
    ATSString                   mPluginPath;
    ATSString                   mConfigPath;
    HWND                        mHwnd;
    IATSClientAccess*           mpIATSClientAccess;
};

//
// class ATSUserEntry
//


class ATSUserEntry : public MaxHeapOperators
{
public:
    ATSExport ATSUserEntry();
    ATSExport virtual ~ATSUserEntry();


    ATSExport virtual const MCHAR*  GetUserName();

    ATSExport virtual void          SetUserName( const MCHAR *szUserName );


    ATSExport virtual const MCHAR*  GetFirstName();

    ATSExport virtual void          SetFirstName( const MCHAR *szFirstName );


    ATSExport virtual const MCHAR*  GetLastName();

    ATSExport virtual void          SetLastName( const MCHAR *szLastName );


    ATSExport virtual const MCHAR*  GetEmail();

    ATSExport virtual void          SetEmail( const MCHAR *szEmail );

protected:
    ATSString                       mUserName;
    ATSString                       mFirstName;
    ATSString                       mLastName;
    ATSString                       mEmail;
};

//
// class ATSUserList
//


class ATSUserList : public MaxHeapOperators
{
public:
    ATSExport ATSUserList();
    ATSExport virtual ~ATSUserList();


    ATSExport virtual ATSUserEntry* CreateEntry( const MCHAR *szUserName );

    ATSExport virtual ATSUserEntry* CreateEntry( ATSUserEntry &atsUserEntry );

    ATSExport virtual bool          RemoveEntry( ATSUserEntry *pEntry );

    ATSExport virtual UINT          NumEntries();

    ATSExport virtual bool          RemoveEntry( UINT iIndex );

    ATSExport virtual bool          RemoveAll();

    ATSExport virtual ATSUserEntry* GetUserEntry( UINT iIndex );

protected:
    std::vector<ATSUserEntry*>      mATSUsers;
};

//
// class ATSExploreProviderParams
//


class ATSExploreProviderParams : public MaxHeapOperators
{
public:
    ATSExport ATSExploreProviderParams();
    ATSExport virtual ~ATSExploreProviderParams();


    ATSExport virtual const MCHAR*  GetTitle();

    ATSExport virtual void          SetTitle( const MCHAR* szTitle );


    ATSExport virtual bool          GetMultipleSelections();

    ATSExport virtual void          SetMultipleSelections( bool bMultipleSelections );


    ATSExport virtual bool          GetDownloadFiles();

    ATSExport virtual void          SetDownloadFiles( bool bDownload );


    ATSExport virtual UINT          AddFilter( const MCHAR* szName, const MCHAR* szExtensions );

    ATSExport virtual UINT          NumFilters();

    ATSExport virtual const MCHAR*  GetFilterName( UINT iIndex );

    ATSExport virtual const MCHAR*  GetFilterExtensions( UINT iIndex );

protected:
    ATSString                   mTitle;
    DWORD                       mState;
    std::vector< ATSString >    mFilters;
    std::vector< ATSString >    mExtensions;
};

//
// class IATSProvider
//


class IATSProvider : public MaxHeapOperators
{
public:
    virtual ~IATSProvider() {}


    virtual const MCHAR*    GetProviderName() = 0;


    virtual ATSOption       GetSupportOptions() = 0;


    virtual bool            IsInitialized() = 0;

    virtual bool            IsProjectOpen() = 0;


    virtual ATSResult       Initialize( ATSClientInfo &atsClientInfo, ATSOption atsOptions = ATS::kATSOptNone ) = 0;

    virtual ATSResult       Uninitialize( ATSOption atsOptions = ATS::kATSOptNone ) = 0;


    virtual ATSResult       OpenProject( MCHAR *szPath, const MCHAR *szComment, ATSOption atsOptions = ATS::kATSOptNone ) = 0;

    virtual ATSResult       CloseProject( ATSOption atsOptions = ATS::kATSOptNone ) = 0;


    virtual const MCHAR*    GetWorkingFolder() = 0;


    virtual ATSResult       SetWorkingFolder( const MCHAR *szWorkingFolder ) = 0;


    virtual ATSResult       Checkin( ATSFileList &atsFileList, const MCHAR *szComment, ATSOption atsOptions = ATS::kATSOptNone ) = 0;

    virtual ATSResult       Checkout( ATSFileList &atsFileList, const MCHAR *szComment, ATSOption atsOptions = ATS::kATSOptNone ) = 0;

    virtual ATSResult       UndoCheckout( ATSFileList &atsFileList, ATSOption atsOptions = ATS::kATSOptNone ) = 0;

    virtual ATSResult       GetLatest( ATSFileList &atsFileList, ATSOption atsOptions = ATS::kATSOptNone ) = 0;

    virtual ATSResult       GetVersionRange( ATSFileList &atsFileList, ATSVersion &verMin, ATSVersion &verMax, ATSOption atsOptions = ATS::kATSOptNone ) = 0;

    virtual ATSResult       GetVersion( ATSFileList &atsFileList, ATSVersion ver, ATSOption atsOptions = ATS::kATSOptNone ) = 0;

    virtual ATSResult       AddFiles( ATSFileList &atsFileList, const MCHAR *szComment, ATSOption atsOptions = ATS::kATSOptNone ) = 0;


    virtual ATSResult       History( ATSFileList &atsFileList, ATSOption atsOptions = ATS::kATSOptNone ) = 0;

    virtual ATSResult       Properties( ATSFileList &atsFileList, ATSOption atsOptions = ATS::kATSOptNone ) = 0;


    virtual ATSResult       GetFileStatus( ATSFileList &atsFileList, ATSOption atsOptions = ATS::kATSOptNone ) = 0;


    virtual ATSResult       GetLockedFileUserList( ATSFileList &atsFileList, ATSUserList &atsUserList, ATSOption atsOptions = ATS::kATSOptNone ) = 0;


    virtual ATSResult       ExploreProvider( ATSFileList &atsFileList, ATSExploreProviderParams &exploreParams, ATSOption atsOptions = ATS::kATSOptNone ) = 0;


    virtual ATSResult       ShowProviderOptions( ATSOption atsOptions = ATS::kATSOptNone ) = 0;

    virtual ATSResult       LaunchProvider( ATSOption atsOptions = ATS::kATSOptNone ) = 0;


    virtual ATSResult       GetAssociatedFiles( ATSFileList &atsFileList, ATSOption atsOptions = ATS::kATSOptNone ) = 0;


    virtual bool            IsATSMSSCCWrapper() = 0;
};