Renegade/Code/Tools/LevelEdit/VSSClass.h

/*
**	Command & Conquer Renegade(tm)
**	Copyright 2025 Electronic Arts Inc.
**
**	This program is free software: you can redistribute it and/or modify
**	it under the terms of the GNU General Public License as published by
**	the Free Software Foundation, either version 3 of the License, or
**	(at your option) any later version.
**
**	This program is distributed in the hope that it will be useful,
**	but WITHOUT ANY WARRANTY; without even the implied warranty of
**	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
**	GNU General Public License for more details.
**
**	You should have received a copy of the GNU General Public License
**	along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

/***********************************************************************************************
 ***              C O N F I D E N T I A L  ---  W E S T W O O D  S T U D I O S               ***
 ***********************************************************************************************
 *                                                                                             *
 *                 Project Name : LevelEdit                                                    *
 *                                                                                             *
 *                     $Archive:: /Commando/Code/Tools/LevelEdit/VSSClass.h                   $*
 *                                                                                             *
 *                       Author:: Patrick Smith                                                *
 *                                                                                             *
 *                     $Modtime:: 1/29/02 3:11p                                               $*
 *                                                                                             *
 *                    $Revision:: 9                                                           $*
 *                                                                                             *
 * - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */



#if defined(_MSC_VER)
#pragma once
#endif

#ifndef __VSSCLASS_H
#define __VSSCLASS_H


#include "wtypes.h"
#include "oaidl.h"
#include "ocidl.h"
#include "vss.h"
#include "utils.h"
#include "assetdatabase.h"


///////////////////////////////////////////////////////////////////////////
//
// VSSClass
//
//	Class definition used to abstract the Visual Source Safe COM interface.
//
///////////////////////////////////////////////////////////////////////////
class VSSClass : public AssetDatabaseClass
{
	public:

		//////////////////////////////////////////////////////////
		//
		//	Public constructors/destructors
		//
		VSSClass (void)
			:	m_pIVSSDatabase (NULL),
				m_bReadOnly (TRUE)				{ ::CoInitialize (NULL); }
		virtual ~VSSClass (void)				{ COM_RELEASE (m_pIVSSDatabase); ::CoUninitialize (); }


		//////////////////////////////////////////////////////////
		//
		//	Public Methods
		//
		
		//
		//	Database methods
		//
		bool						Open_Database (LPCTSTR ini_filename, LPCTSTR username = NULL, LPCTSTR password = NULL);
		
		//
		//	File manipulation methods
		//
		bool						Add_File (LPCTSTR local_filename, LPCTSTR comment = NULL);
		bool						Check_In (LPCTSTR local_filename, LPCTSTR comment = NULL);
		bool						Check_Out (LPCTSTR local_filename, bool get_locally = true);
		bool						Undo_Check_Out (LPCTSTR local_filename);
		bool						Get (LPCTSTR local_filename);
		bool						Get (LPCTSTR local_filename, IVSSItem *pitem);
		void						Get_Recursive (LPCTSTR local_path, IVSSItem *pparent);
		bool						Get_Subproject (LPCTSTR local_filename);		
		bool						Destroy (LPCTSTR local_filename);

		FileClass *				Get_File (LPCTSTR local_filename);

		//
		//	Extended methods which provide UI
		//
		bool						Check_Out_Ex (LPCTSTR local_filename, HWND parent_wnd);
		bool						Check_In_Ex (LPCTSTR local_filename, HWND parent_wnd);

		//
		// Retry methods
		//
		bool						Retry_Check_Out (LPCTSTR local_filename, int iattempts = 1, int idelay = 250);
		bool						Retry_Check_In (LPCTSTR local_filename, int iattempts = 1, int idelay = 250);

		//
		//	Folder (subproject) methods
		//
		bool						Build_Tree (LPCTSTR local_filename);
		
		//
		//	File information methods
		//
		
		VSSFileStatus			Get_File_Status (LPCTSTR local_filename, LPTSTR checked_out_username = NULL, DWORD buffer_size = 0, IVSSItem *item_to_use = NULL);
		FILE_STATUS				Get_File_Status (LPCTSTR local_filename, StringClass *checked_out_user_name);

		long						Get_File_Version (LPCTSTR local_filename);
		bool						Is_File_Different (LPCTSTR local_filename);
		bool						Does_File_Exist (LPCTSTR local_filename);
		bool						Get_File_Date (IVSSItem *pitem, SYSTEMTIME &system_time);
		VSSItemType				Get_Type (LPCTSTR local_filename);

		//
		// User information
		//
		BOOL						Is_Read_Only (void) const	{ return m_bReadOnly; }


	protected:
		
		//////////////////////////////////////////////////////////
		//
		//	Protected methods
		//
		void						Get_VSS_Interface (void);
		IVSSItem *				Get_VSS_Item_From_Local_Path (LPCTSTR local_filename);
		IVSSItem *				Get_VSS_Item (LPCTSTR vss_path);
		LPCTSTR					Get_Error_Description (HRESULT hresult);

		
	private:

		//////////////////////////////////////////////////////////
		//
		//	Private member data
		//
		IVSSDatabase *		m_pIVSSDatabase;
		BOOL					m_bReadOnly;
};

#endif //__VSSCLASS_H