protected virtual int IncludeInProject()
{
new UIThread().MustBeCalledFromUIThread();
XProjectNode projectNode = this.ProjectMgr as XProjectNode;
if (projectNode == null || projectNode.IsClosed)
{
return((int)OleConstants.OLECMDERR_E_NOTSUPPORTED);
}
else if (!this.IsNonMemberItem)
{
return(VSConstants.S_OK); // do nothing, just ignore it.
}
using (XHelperMethods.NewWaitCursor())
{
// Check out the project file.
if (!projectNode.QueryEditProjectFile(false))
{
throw Marshal.GetExceptionForHR(VSConstants.OLE_E_PROMPTSAVECANCELLED);
}
for (HierarchyNode child = this.FirstChild; child != null; child = child.NextSibling)
{
IProjectSourceNode node = child as IProjectSourceNode;
if (node != null)
{
int result = node.IncludeInProject();
if (result != VSConstants.S_OK)
{
return(result);
}
}
}
// make sure that all parent folders are included in the project
XHelperMethods.EnsureParentFolderIncluded(this);
// now add this node to the project.
this.SetProperty((int)__VSHPROPID.VSHPROPID_IsNonMemberItem, false);
this.ItemNode = projectNode.CreateMsBuildFileProjectElement(this.Url);
this.ProjectMgr.Tracker.OnItemAdded(this.Url, VSADDFILEFLAGS.VSADDFILEFLAGS_NoFlags);
// notify others
////projectNode.OnItemAdded(this.Parent, this);
this.ReDraw(UIHierarchyElement.Icon); // We have to redraw the icon of the node as it is now a member of the project and should be drawn using a different icon.
this.ReDraw(UIHierarchyElement.SccState); // update the SCC state icon.
this.ResetProperties();
this.SetSpecialProperties(); // allows to set generators etc.
// refresh property browser...
XHelperMethods.RefreshPropertyBrowser();
}
return(VSConstants.S_OK);
}
/// <summary>
/// Handles command status on source a node. Should be overridden by descendant nodes.
/// </summary>
/// <param name="node">A HierarchyNode that implements the IProjectSourceNode interface.</param>
/// <param name="guidCmdGroup">A unique identifier of the command group. The pguidCmdGroup parameter can be NULL to specify the standard group.</param>
/// <param name="cmd">The command to query status for.</param>
/// <param name="result">An out parameter specifying the QueryStatusResult of the command.</param>
/// <param name="returnCode">If the method succeeds, it returns S_OK. If it fails, it returns an error code.</param>
/// <returns>Returns true if the status request is handled, false otherwise.</returns>
internal static bool QueryStatusOnProjectSourceNode(HierarchyNode node, Guid guidCmdGroup, uint cmd, ref QueryStatusResult result, out int returnCode)
{
if (guidCmdGroup == VsMenus.guidStandardCommandSet2K)
{
IProjectSourceNode sourceNode = node as IProjectSourceNode;
switch ((VsCommands2K)cmd)
{
case VsCommands2K.SHOWALLFILES:
{
NemerleProjectNode projectNode = node.ProjectMgr as NemerleProjectNode;
result |= QueryStatusResult.SUPPORTED | QueryStatusResult.ENABLED;
if (projectNode != null && projectNode.ShowAllFilesEnabled)
{
result |= QueryStatusResult.LATCHED; // it should be displayed as pressed
}
returnCode = VSConstants.S_OK;
return(true); // handled.
}
case VsCommands2K.INCLUDEINPROJECT:
// if it is a non member item node, the we support "Include In Project" command
if (sourceNode != null && sourceNode.IsNonMemberItem)
{
result |= QueryStatusResult.SUPPORTED | QueryStatusResult.ENABLED;
returnCode = VSConstants.S_OK;
return(true); // handled.
}
break;
case VsCommands2K.EXCLUDEFROMPROJECT:
// if it is a non member item node, then we don't support "Exclude From Project" command
if (sourceNode != null && sourceNode.IsNonMemberItem)
{
returnCode = (int)OleConstants.MSOCMDERR_E_NOTSUPPORTED;
return(true); // handled.
}
break;
case OpenFolderInExplorerCmdId:
result |= QueryStatusResult.SUPPORTED | QueryStatusResult.ENABLED;
returnCode = VSConstants.S_OK;
return(true);
}
}
// just an arbitrary value, it doesn't matter if method hasn't handled the request
returnCode = VSConstants.S_FALSE;
// not handled
return(false);
}
/// <summary>
/// Handle overwriting of an existing item in the hierarchy.
/// </summary>
/// <param name="existingNode">The node that exists.</param>
protected override void OverwriteExistingItem(HierarchyNode existingNode)
{
IProjectSourceNode sourceNode = existingNode as IProjectSourceNode;
if (sourceNode != null && sourceNode.IsNonMemberItem)
{
sourceNode.IncludeInProject();
}
else
{
base.OverwriteExistingItem(existingNode);
}
}
/// <summary>
/// This method helps converting any non member node into the member one.
/// </summary>
/// <param name="node">Node to be added.</param>
/// <returns>Returns the result of the conversion.</returns>
/// <remarks>This method helps including the non-member items into the project when ShowAllFiles option is enabled.
/// Normally, the project ignores "Add Existing Item" command if it is in ShowAllFiles mode and the non-member node
/// exists for the item being added. Overridden to alter this behavior (now it includes the non-member node in the
/// project)</remarks>
protected override VSADDRESULT IncludeExistingNonMemberNode(HierarchyNode node)
{
IProjectSourceNode sourceNode = node as IProjectSourceNode;
if (sourceNode != null && sourceNode.IsNonMemberItem)
{
if (sourceNode.IncludeInProject() == VSConstants.S_OK)
{
return(VSADDRESULT.ADDRESULT_Success);
}
}
return(base.IncludeExistingNonMemberNode(node));
}
/// <summary>
/// Adds the this node to the build system.
/// </summary>
/// <param name="recursive">Flag to indicate if the addition should be recursive.</param>
protected virtual void AddToMSBuild(bool recursive)
{
if (ProjectManager == null || ProjectManager.IsClosed)
{
return; // do nothing
}
this.ItemNode = ProjectManager.AddFileToMSBuild(this.Url);
this.SetProperty((int)__VSHPROPID.VSHPROPID_IsNonMemberItem, false);
if (recursive)
{
for (HierarchyNode node = this.FirstChild; node != null; node = node.NextSibling)
{
IProjectSourceNode sourceNode = node as IProjectSourceNode;
if (sourceNode != null)
{
sourceNode.IncludeInProject(recursive);
}
}
}
}
/// <summary>
/// Adds the this node to the build system.
/// </summary>
/// <param name="recursive">Flag to indicate if the addition should be recursive.</param>
protected virtual void AddToMSBuild(bool recursive)
{
WixProjectNode projectNode = this.ProjectMgr as WixProjectNode;
if (projectNode == null || projectNode.IsClosed)
{
return; // do nothing
}
this.ItemNode = projectNode.CreateMsBuildFolderProjectElement(this.Url);
this.SetProperty((int)__VSHPROPID.VSHPROPID_IsNonMemberItem, false);
if (recursive)
{
for (HierarchyNode node = this.FirstChild; node != null; node = node.NextSibling)
{
IProjectSourceNode sourceNode = node as IProjectSourceNode;
if (sourceNode != null)
{
sourceNode.IncludeInProject(recursive);
}
}
}
}
protected override int ExcludeFromProject()
{
new UIThread().MustBeCalledFromUIThread();
if (this.ProjectMgr == null || this.ProjectMgr.IsClosed)
{
return((int)OleConstants.OLECMDERR_E_NOTSUPPORTED);
}
else if (this.IsNonMemberItem)
{
return(VSConstants.S_OK); // do nothing, just ignore it.
}
using (XHelperMethods.NewWaitCursor())
{
for (HierarchyNode child = this.FirstChild; child != null; child = child.NextSibling)
{
IProjectSourceNode node = child as IProjectSourceNode;
if (node != null)
{
int result = node.ExcludeFromProject();
if (result != VSConstants.S_OK)
{
return(result);
}
}
}
// Ask Document tracker listeners if we can remove the item.
{ // just to limit the scope.
string documentToRemove = this.GetMkDocument();
string[] filesToBeDeleted = new string[1] {
documentToRemove
};
VSQUERYREMOVEFILEFLAGS[] queryRemoveFlags = this.GetQueryRemoveFileFlags(filesToBeDeleted);
if (!this.ProjectMgr.Tracker.CanRemoveItems(filesToBeDeleted, queryRemoveFlags))
{
return((int)OleConstants.OLECMDERR_E_CANCELED);
}
// Close the document if it has a manager.
DocumentManager manager = this.GetDocumentManager();
if (manager != null)
{
if (manager.Close(__FRAMECLOSE.FRAMECLOSE_PromptSave) == VSConstants.E_ABORT)
{
// User cancelled operation in message box.
return(VSConstants.OLE_E_PROMPTSAVECANCELLED);
}
}
// Check out the project file.
if (!this.ProjectMgr.QueryEditProjectFile(false))
{
throw Marshal.GetExceptionForHR(VSConstants.OLE_E_PROMPTSAVECANCELLED);
}
}
// close the document window if open.
this.CloseDocumentWindow(this);
XProjectNode projectNode = this.ProjectMgr as XProjectNode;
projectNode.RemoveURL(this.Url);
if (projectNode != null && projectNode.ShowAllFilesEnabled && File.Exists(this.Url))
{
// need to store before removing the node.
string url = this.Url;
string include = this.ItemNode.GetMetadata(ProjectFileConstants.Include);
this.ItemNode.RemoveFromProjectFile();
this.ProjectMgr.Tracker.OnItemRemoved(url, VSREMOVEFILEFLAGS.VSREMOVEFILEFLAGS_NoFlags);
this.SetProperty((int)__VSHPROPID.VSHPROPID_IsNonMemberItem, true); // Set it as non member item
this.ItemNode = new ProjectElement(this.ProjectMgr, null, true); // now we have to set a new ItemNode to indicate that this is virtual node.
this.ItemNode.Rename(include);
this.ItemNode.SetMetadata(ProjectFileConstants.Name, url);
////this.ProjectMgr.OnItemAdded(this.Parent, this);
this.ReDraw(UIHierarchyElement.Icon); // We have to redraw the icon of the node as it is now not a member of the project and should be drawn using a different icon.
this.ReDraw(UIHierarchyElement.SccState); // update the SCC state icon.
}
else if (this.Parent != null) // the project node has no parentNode
{
// Remove from the Hierarchy
this.OnItemDeleted();
this.Parent.RemoveChild(this);
this.ItemNode.RemoveFromProjectFile();
}
this.ResetProperties();
// refresh property browser...
XHelperMethods.RefreshPropertyBrowser();
}
return(VSConstants.S_OK);
}
int IProjectSourceNode.ExcludeFromProject()
{
WixProjectNode projectNode = this.ProjectMgr as WixProjectNode;
if (projectNode == null || projectNode.IsClosed)
{
return((int)OleConstants.OLECMDERR_E_NOTSUPPORTED);
}
else if (this.IsNonMemberItem)
{
return(VSConstants.S_OK); // do nothing, just ignore it.
}
using (WixHelperMethods.NewWaitCursor())
{
// Check out the project file.
if (!projectNode.QueryEditProjectFile(false))
{
throw Marshal.GetExceptionForHR(VSConstants.OLE_E_PROMPTSAVECANCELLED);
}
// remove children, if any, before removing from the hierarchy
for (HierarchyNode child = this.FirstChild; child != null; child = child.NextSibling)
{
IProjectSourceNode node = child as IProjectSourceNode;
if (node != null)
{
int result = node.ExcludeFromProject();
if (result != VSConstants.S_OK)
{
return(result);
}
}
}
if (projectNode != null && projectNode.ShowAllFilesEnabled && Directory.Exists(this.Url))
{
string url = this.Url;
this.SetProperty((int)__VSHPROPID.VSHPROPID_IsNonMemberItem, true);
this.ItemNode.RemoveFromProjectFile();
this.ItemNode = new ProjectElement(this.ProjectMgr, null, true); // now we have to create a new ItemNode to indicate that this is virtual node.
this.ItemNode.Rename(url);
this.ItemNode.SetMetadata(ProjectFileConstants.Name, this.Url);
this.ReDraw(UIHierarchyElement.Icon); // we have to redraw the icon of the node as it is now not a member of the project and shoul be drawn using a different icon.
}
else if (this.Parent != null) // the project node has no parentNode
{
// this is important to make it non member item. otherwise, the multi-selection scenario would
// not work if it has any parent child relation.
this.SetProperty((int)__VSHPROPID.VSHPROPID_IsNonMemberItem, true);
// remove from the hierarchy
this.OnItemDeleted();
this.Parent.RemoveChild(this);
this.ItemNode.RemoveFromProjectFile();
}
// refresh property browser...
WixHelperMethods.RefreshPropertyBrowser();
}
return(VSConstants.S_OK);
}
