/// <summary>
/// Asks the environment for permission to remove files.
/// </summary>
/// <param name="files">an array of files to remove</param>
/// <param name="flags">The VSQUERYREMOVEFILEFLAGS associated to the files to be removed.</param>
/// <returns>true if the files can be removed, false if not.</returns>
internal bool CanRemoveItems(string[] files, VSQUERYREMOVEFILEFLAGS[] flags)
{
// If we are silent then we assume that the file can be removed, since we do not want to trigger this event.
if ((this.projectMgr.EventTriggeringFlag & ProjectNode.EventTriggering.DoNotTriggerTrackerEvents) != 0)
{
return(true);
}
if (files == null || files.Length == 0)
{
return(false);
}
int length = files.Length;
VSQUERYREMOVEFILERESULTS[] summary = new VSQUERYREMOVEFILERESULTS[1];
ThreadHelper.ThrowIfNotOnUIThread();
ErrorHandler.ThrowOnFailure(this.GetIVsTrackProjectDocuments2().OnQueryRemoveFiles(this.projectMgr, length, files, flags, summary, null));
if (summary[0] == VSQUERYREMOVEFILERESULTS.VSQUERYREMOVEFILERESULTS_RemoveNotOK)
{
return(false);
}
return(true);
}
/// <summary>
/// Asks the environment for permission to remove files.
/// </summary>
/// <param name="files">an array of files to remove</param>
/// <param name="flags">The VSQUERYREMOVEFILEFLAGS associated to the files to be removed.</param>
/// <returns>true if the files can be removed, false if not.</returns>
internal bool CanRemoveItems(string[] files, VSQUERYREMOVEFILEFLAGS[] flags)
{
// If we are silent then we assume that the file can be removed, since we do not want to trigger this event.
if((this.projectMgr.EventTriggeringFlag & ProjectNode.EventTriggering.DoNotTriggerTrackerEvents) != 0)
{
return true;
}
if(files == null || files.Length == 0)
{
return false;
}
int length = files.Length;
VSQUERYREMOVEFILERESULTS[] summary = new VSQUERYREMOVEFILERESULTS[1];
ErrorHandler.ThrowOnFailure(this.GetIVsTrackProjectDocuments2().OnQueryRemoveFiles(this.projectMgr, length, files, flags, summary, null));
if(summary[0] == VSQUERYREMOVEFILERESULTS.VSQUERYREMOVEFILERESULTS_RemoveNotOK)
{
return false;
}
return true;
}
/// <summary>
/// Asks the environment for permission to remove files.
/// </summary>
/// <param name="files">an array of files to remove</param>
/// <param name="flags">The VSQUERYREMOVEFILEFLAGS associated to the files to be removed.</param>
/// <returns>true if the files can be removed, false if not.</returns>
public virtual bool CanRemoveItems(string[] files, VSQUERYREMOVEFILEFLAGS[] flags)
{
// If we are silent then we assume that the file can be removed, since we do not want to trigger this event.
if ((this.projectMgr.EventTriggeringFlag & SuppressEvents.Tracker) != 0)
{
return(true);
}
if (files == null || files.Length == 0)
{
return(false);
}
int length = files.Length;
VSQUERYREMOVEFILERESULTS[] summary = new VSQUERYREMOVEFILERESULTS[1];
ErrorHandler.ThrowOnFailure(this.GetIVsTrackProjectDocuments2().OnQueryRemoveFiles(this.projectMgr.InteropSafeIVsProject3, length, files, flags, summary, null));
if (summary[0] == VSQUERYREMOVEFILERESULTS.VSQUERYREMOVEFILERESULTS_RemoveNotOK)
{
return(false);
}
return(true);
}
int IVsTrackProjectDocumentsEvents2.OnQueryRemoveFiles(
IVsProject pProject,
int cFiles,
string[] rgpszMkDocuments,
VSQUERYREMOVEFILEFLAGS[] rgFlags,
VSQUERYREMOVEFILERESULTS[] pSummaryResult,
VSQUERYREMOVEFILERESULTS[] rgResults)
{
return VSConstants.S_OK;
}
public virtual int OnQueryRemoveFiles(IVsProject pProject, int cFiles, string[] rgpszMkDocuments, VSQUERYREMOVEFILEFLAGS[] rgFlags, VSQUERYREMOVEFILERESULTS[] pSummaryResult, VSQUERYREMOVEFILERESULTS[] rgResults)
{
return VSConstants.E_NOTIMPL;
}
public int OnQueryRemoveFiles(IVsProject pProject, int cFiles, string[] rgpszMkDocuments,
VSQUERYREMOVEFILEFLAGS[] rgFlags,
VSQUERYREMOVEFILERESULTS[] pSummaryResult,
VSQUERYREMOVEFILERESULTS[] rgResults)
{
return 0;
}
public int OnQueryRemoveFiles(IVsProject pProject, int cFiles, string[] rgpszMkDocuments, VSQUERYREMOVEFILEFLAGS[] rgFlags, VSQUERYREMOVEFILERESULTS[] pSummaryResult, VSQUERYREMOVEFILERESULTS[] rgResults) {
if (pSummaryResult != null) {
pSummaryResult[0] = VSQUERYREMOVEFILERESULTS.VSQUERYREMOVEFILERESULTS_RemoveOK;
}
if (rgResults != null) {
for (int i = 0; i < cFiles; i++) {
rgResults[i] = VSQUERYREMOVEFILERESULTS.VSQUERYREMOVEFILERESULTS_RemoveOK;
}
}
return VSConstants.S_OK;
}
int IVsTrackProjectDocumentsEvents2.OnQueryRemoveFiles(IVsProject pProject, int cFiles, string[] rgpszMkDocuments, VSQUERYREMOVEFILEFLAGS[] rgFlags, VSQUERYREMOVEFILERESULTS[] pSummaryResult, VSQUERYREMOVEFILERESULTS[] rgResults)
{
return NativeMethods.S_OK; // We are not interested in this one
}
public void TestTPDEvents()
{
int result = 0;
SccProviderService target = GetSccProviderServiceInstance;
solution.SolutionFile = Path.GetTempFileName();
MockIVsProject project = new MockIVsProject(Path.GetTempFileName());
solution.AddProject(project);
Hashtable uncontrolled = new Hashtable();
uncontrolled[project as IVsSccProject2] = true;
target.AddProjectsToSourceControl(ref uncontrolled, true);
// In real live, a QueryEdit call on the project file would be necessary to add/rename/delete items
// Add a new item and fire the appropriate events
string pendingAddFile = Path.GetTempFileName();
VSQUERYADDFILERESULTS[] pSummaryResultAdd = new VSQUERYADDFILERESULTS[1];
VSQUERYADDFILERESULTS[] rgResultsAdd = new VSQUERYADDFILERESULTS[1];
result = target.OnQueryAddFiles(project as IVsProject, 1, new string[] { pendingAddFile }, null, pSummaryResultAdd, rgResultsAdd);
Assert.AreEqual <int>(VSConstants.E_NOTIMPL, result);
project.AddItem(pendingAddFile);
result = target.OnAfterAddFilesEx(1, 1, new IVsProject[] { project as IVsProject }, new int[] { 0 }, new string[] { pendingAddFile }, null);
Assert.AreEqual <int>(VSConstants.E_NOTIMPL, result);
Assert.AreEqual(SourceControlStatus.scsUncontrolled, target.GetFileStatus(pendingAddFile), "Incorrect status returned");
// Checkin the pending add file
target.AddFileToSourceControl(pendingAddFile);
// Rename the item and verify the file remains is controlled
string newName = pendingAddFile + ".renamed";
VSQUERYRENAMEFILERESULTS[] pSummaryResultRen = new VSQUERYRENAMEFILERESULTS[1];
VSQUERYRENAMEFILERESULTS[] rgResultsRen = new VSQUERYRENAMEFILERESULTS[1];
result = target.OnQueryRenameFiles(project as IVsProject, 1, new string[] { pendingAddFile }, new string[] { newName }, null, pSummaryResultRen, rgResultsRen);
Assert.AreEqual <int>(VSConstants.E_NOTIMPL, result);
project.RenameItem(pendingAddFile, newName);
result = target.OnAfterRenameFiles(1, 1, new IVsProject[] { project as IVsProject }, new int[] { 0 }, new string[] { pendingAddFile }, new string[] { newName }, new VSRENAMEFILEFLAGS[] { VSRENAMEFILEFLAGS.VSRENAMEFILEFLAGS_NoFlags });
Assert.AreEqual <int>(VSConstants.S_OK, result);
Assert.AreEqual(SourceControlStatus.scsUncontrolled, target.GetFileStatus(pendingAddFile), "Incorrect status returned");
Assert.AreEqual(SourceControlStatus.scsCheckedIn, target.GetFileStatus(newName), "Incorrect status returned");
// Mock the UIShell service to answer Cancel to the dialog invocation
BaseMock mockUIShell = MockUiShellProvider.GetShowMessageBoxCancel();
serviceProvider.AddService(typeof(IVsUIShell), mockUIShell, true);
// Try to delete the file from project; the delete should not be allowed
VSQUERYREMOVEFILERESULTS[] pSummaryResultDel = new VSQUERYREMOVEFILERESULTS[1];
VSQUERYREMOVEFILERESULTS[] rgResultsDel = new VSQUERYREMOVEFILERESULTS[1];
result = target.OnQueryRemoveFiles(project as IVsProject, 1, new string[] { newName }, null, pSummaryResultDel, rgResultsDel);
Assert.AreEqual <int>(VSConstants.S_OK, result);
Assert.AreEqual <VSQUERYREMOVEFILERESULTS>(VSQUERYREMOVEFILERESULTS.VSQUERYREMOVEFILERESULTS_RemoveNotOK, pSummaryResultDel[0]);
// Mock the UIShell service to answer Yes to the dialog invocation
serviceProvider.RemoveService(typeof(IVsUIShell));
mockUIShell = MockUiShellProvider.GetShowMessageBoxYes();
serviceProvider.AddService(typeof(IVsUIShell), mockUIShell, true);
// Try to delete the file from project; the delete should be allowed this time
result = target.OnQueryRemoveFiles(project as IVsProject, 1, new string[] { newName }, null, pSummaryResultDel, rgResultsDel);
Assert.AreEqual <int>(VSConstants.S_OK, result);
Assert.AreEqual <VSQUERYREMOVEFILERESULTS>(VSQUERYREMOVEFILERESULTS.VSQUERYREMOVEFILERESULTS_RemoveOK, pSummaryResultDel[0]);
// Remove the file from project
project.RemoveItem(newName);
result = target.OnAfterRemoveFiles(1, 1, new IVsProject[] { project as IVsProject }, new int[] { 0 }, new string[] { newName }, null);
Assert.AreEqual <int>(VSConstants.E_NOTIMPL, result);
}
public int OnQueryRemoveFiles(IVsProject pProject, int cFiles, string[] rgpszMkDocuments, VSQUERYREMOVEFILEFLAGS[] rgFlags, VSQUERYREMOVEFILERESULTS[] pSummaryResult, VSQUERYREMOVEFILERESULTS[] rgResults)
{
throw new NotImplementedException();
}
public int OnQueryRemoveFiles(
IVsProject pProject, int cFiles, string[] rgpszMkDocuments, VSQUERYREMOVEFILEFLAGS[] rgFlags,
VSQUERYREMOVEFILERESULTS[] pSummaryResult, VSQUERYREMOVEFILERESULTS[] rgResults)
{
var hr = VSConstants.S_OK;
var handler = QueryRemoveFile;
if (handler != null)
{
if (cFiles <= rgpszMkDocuments.Length)
{
for (var fileCount = 0; fileCount < cFiles; fileCount++)
{
var args = new ModelChangeEventArgs();
args.OldFileName = rgpszMkDocuments[fileCount];
args.ProjectObj = VSHelpers.GetProject(pProject as IVsHierarchy);
if (args.ProjectObj == null)
{
continue;
}
hr = handler(this, args);
}
}
}
return hr;
}
public int OnQueryRemoveFiles(IVsProject pProject, int cFiles, string[] rgpszMkDocuments, VSQUERYREMOVEFILEFLAGS[] rgFlags, VSQUERYREMOVEFILERESULTS[] pSummaryResult, VSQUERYREMOVEFILERESULTS[] rgResults)
{
TraceAdviseEvent("OnQueryRemoveFiles", rgpszMkDocuments);
return VSConstants.E_NOTIMPL;
}
public int OnQueryRemoveFiles(IVsProject pProject, int cFiles, string[] rgpszMkDocuments, VSQUERYREMOVEFILEFLAGS[] rgFlags, VSQUERYREMOVEFILERESULTS[] pSummaryResult, VSQUERYREMOVEFILERESULTS[] rgResults) {
foreach (var file in rgpszMkDocuments) {
DocumentEvents.Add("OnQueryRemoveFiles " + file);
CodeDocumentEvents.Add("OnQueryRemoveFiles(" + GetRelativePath(pProject, file) + ")");
}
return VSConstants.S_OK;
}
void IVsTrackProjectDocumentsEvents4.OnQueryRemoveFilesEx(IVsProject pProject, int cFiles, string[] rgpszMkDocuments, uint[] rgFlags, VSQUERYREMOVEFILERESULTS[] pSummaryResult, VSQUERYREMOVEFILERESULTS[] rgResults)
{
}
public void TestTPDEvents()
{
int result = 0;
SccProviderService target = GetSccProviderServiceInstance;
solution.SolutionFile = Path.GetTempFileName();
MockIVsProject project = new MockIVsProject(Path.GetTempFileName());
solution.AddProject(project);
Hashtable uncontrolled = new Hashtable();
uncontrolled[project as IVsSccProject2] = true;
target.AddProjectsToSourceControl(ref uncontrolled, true);
// In real live, a QueryEdit call on the project file would be necessary to add/rename/delete items
// Add a new item and fire the appropriate events
string pendingAddFile = Path.GetTempFileName();
VSQUERYADDFILERESULTS[] pSummaryResultAdd = new VSQUERYADDFILERESULTS[1];
VSQUERYADDFILERESULTS[] rgResultsAdd = new VSQUERYADDFILERESULTS[1];
result = target.OnQueryAddFiles(project as IVsProject, 1, new string[] {pendingAddFile}, null, pSummaryResultAdd, rgResultsAdd);
Assert.AreEqual<int>(VSConstants.E_NOTIMPL, result);
project.AddItem(pendingAddFile);
result = target.OnAfterAddFilesEx(1, 1, new IVsProject[] { project as IVsProject }, new int[] { 0 }, new string[] { pendingAddFile }, null);
Assert.AreEqual<int>(VSConstants.E_NOTIMPL, result);
Assert.AreEqual(SourceControlStatus.scsUncontrolled, target.GetFileStatus(pendingAddFile), "Incorrect status returned");
// Checkin the pending add file
target.AddFileToSourceControl(pendingAddFile);
// Rename the item and verify the file remains is controlled
string newName = pendingAddFile + ".renamed";
VSQUERYRENAMEFILERESULTS[] pSummaryResultRen = new VSQUERYRENAMEFILERESULTS[1];
VSQUERYRENAMEFILERESULTS[] rgResultsRen = new VSQUERYRENAMEFILERESULTS[1];
result = target.OnQueryRenameFiles(project as IVsProject, 1, new string[] { pendingAddFile }, new string[] { newName }, null, pSummaryResultRen, rgResultsRen);
Assert.AreEqual<int>(VSConstants.E_NOTIMPL, result);
project.RenameItem(pendingAddFile, newName);
result = target.OnAfterRenameFiles(1, 1, new IVsProject[] {project as IVsProject}, new int[] {0}, new string[] { pendingAddFile }, new string[] { newName }, new VSRENAMEFILEFLAGS[] {VSRENAMEFILEFLAGS.VSRENAMEFILEFLAGS_NoFlags});
Assert.AreEqual<int>(VSConstants.S_OK, result);
Assert.AreEqual(SourceControlStatus.scsUncontrolled, target.GetFileStatus(pendingAddFile), "Incorrect status returned");
Assert.AreEqual(SourceControlStatus.scsCheckedIn, target.GetFileStatus(newName), "Incorrect status returned");
// Mock the UIShell service to answer Cancel to the dialog invocation
BaseMock mockUIShell = MockUiShellProvider.GetShowMessageBoxCancel();
serviceProvider.AddService(typeof(IVsUIShell), mockUIShell, true);
// Try to delete the file from project; the delete should not be allowed
VSQUERYREMOVEFILERESULTS[] pSummaryResultDel = new VSQUERYREMOVEFILERESULTS[1];
VSQUERYREMOVEFILERESULTS[] rgResultsDel = new VSQUERYREMOVEFILERESULTS[1];
result = target.OnQueryRemoveFiles(project as IVsProject, 1, new string[] { newName }, null, pSummaryResultDel, rgResultsDel);
Assert.AreEqual<int>(VSConstants.S_OK, result);
Assert.AreEqual<VSQUERYREMOVEFILERESULTS>(VSQUERYREMOVEFILERESULTS.VSQUERYREMOVEFILERESULTS_RemoveNotOK, pSummaryResultDel[0]);
// Mock the UIShell service to answer Yes to the dialog invocation
serviceProvider.RemoveService(typeof(IVsUIShell));
mockUIShell = MockUiShellProvider.GetShowMessageBoxYes();
serviceProvider.AddService(typeof(IVsUIShell), mockUIShell, true);
// Try to delete the file from project; the delete should be allowed this time
result = target.OnQueryRemoveFiles(project as IVsProject, 1, new string[] { newName }, null, pSummaryResultDel, rgResultsDel);
Assert.AreEqual<int>(VSConstants.S_OK, result);
Assert.AreEqual<VSQUERYREMOVEFILERESULTS>(VSQUERYREMOVEFILERESULTS.VSQUERYREMOVEFILERESULTS_RemoveOK, pSummaryResultDel[0]);
// Remove the file from project
project.RemoveItem(newName);
result = target.OnAfterRemoveFiles(1, 1, new IVsProject[] { project as IVsProject }, new int[] { 0 }, new string[] { newName }, null);
Assert.AreEqual<int>(VSConstants.E_NOTIMPL, result);
}
