431 lines
12 KiB
C#
431 lines
12 KiB
C#
|
/* ****************************************************************************
|
||
|
|
*
|
||
|
|
* Copyright (c) Microsoft Corporation.
|
||
|
|
*
|
||
|
|
* This source code is subject to terms and conditions of the Apache License, Version 2.0. A
|
||
|
|
* copy of the license can be found in the License.html file at the root of this distribution. If
|
||
|
|
* you cannot locate the Apache License, Version 2.0, please send an email to
|
||
|
|
* vspython@microsoft.com. By using this source code in any fashion, you are agreeing to be bound
|
||
|
|
* by the terms of the Apache License, Version 2.0.
|
||
|
|
*
|
||
|
|
* You must not remove this notice, or any other, from this software.
|
||
|
|
*
|
||
|
|
* ***************************************************************************/
|
||
|
|
|
||
|
|
using System;
|
||
|
|
using System.Diagnostics.CodeAnalysis;
|
||
|
|
using System.Runtime.InteropServices;
|
||
|
|
using Microsoft.VisualStudio.Shell.Interop;
|
||
|
|
|
||
|
|
namespace Microsoft.VisualStudio.Project
|
||
|
|
{
|
||
|
|
#region structures
|
||
|
|
[StructLayoutAttribute(LayoutKind.Sequential)]
|
||
|
|
public struct _DROPFILES
|
||
|
|
{
|
||
|
|
public Int32 pFiles;
|
||
|
|
public Int32 X;
|
||
|
|
public Int32 Y;
|
||
|
|
public Int32 fNC;
|
||
|
|
public Int32 fWide;
|
||
|
|
}
|
||
|
|
#endregion
|
||
|
|
|
||
|
|
#region enums
|
||
|
|
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Defines the currect state of a property page.
|
||
|
|
/// </summary>
|
||
|
|
[Flags]
|
||
|
|
public enum PropPageStatus
|
||
|
|
{
|
||
|
|
|
||
|
|
Dirty = 0x1,
|
||
|
|
|
||
|
|
Validate = 0x2,
|
||
|
|
|
||
|
|
Clean = 0x4
|
||
|
|
}
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Defines the status of the command being queried
|
||
|
|
/// </summary>
|
||
|
|
[Flags]
|
||
|
|
[SuppressMessage("Microsoft.Naming", "CA1714:FlagsEnumsShouldHavePluralNames")]
|
||
|
|
[SuppressMessage("Microsoft.Design", "CA1008:EnumsShouldHaveZeroValue")]
|
||
|
|
public enum QueryStatusResult
|
||
|
|
{
|
||
|
|
/// <summary>
|
||
|
|
/// The command is not supported.
|
||
|
|
/// </summary>
|
||
|
|
[SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", MessageId = "NOTSUPPORTED")]
|
||
|
|
NOTSUPPORTED = 0,
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// The command is supported
|
||
|
|
/// </summary>
|
||
|
|
[SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", MessageId = "SUPPORTED")]
|
||
|
|
SUPPORTED = 1,
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// The command is enabled
|
||
|
|
/// </summary>
|
||
|
|
[SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", MessageId = "ENABLED")]
|
||
|
|
ENABLED = 2,
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// The command is toggled on
|
||
|
|
/// </summary>
|
||
|
|
[SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", MessageId = "LATCHED")]
|
||
|
|
LATCHED = 4,
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// The command is toggled off (the opposite of LATCHED).
|
||
|
|
/// </summary>
|
||
|
|
[SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", MessageId = "NINCHED")]
|
||
|
|
NINCHED = 8,
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// The command is invisible.
|
||
|
|
/// </summary>
|
||
|
|
[SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", MessageId = "INVISIBLE")]
|
||
|
|
INVISIBLE = 16
|
||
|
|
}
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Defines the type of item to be added to the hierarchy.
|
||
|
|
/// </summary>
|
||
|
|
public enum HierarchyAddType
|
||
|
|
{
|
||
|
|
AddNewItem,
|
||
|
|
AddExistingItem
|
||
|
|
}
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Defines the component from which a command was issued.
|
||
|
|
/// </summary>
|
||
|
|
public enum CommandOrigin
|
||
|
|
{
|
||
|
|
[SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", MessageId = "Ui")]
|
||
|
|
UiHierarchy,
|
||
|
|
OleCommandTarget
|
||
|
|
}
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Defines the current status of the build process.
|
||
|
|
/// </summary>
|
||
|
|
public enum MSBuildResult
|
||
|
|
{
|
||
|
|
/// <summary>
|
||
|
|
/// The build is currently suspended.
|
||
|
|
/// </summary>
|
||
|
|
Suspended,
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// The build has been restarted.
|
||
|
|
/// </summary>
|
||
|
|
Resumed,
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// The build failed.
|
||
|
|
/// </summary>
|
||
|
|
Failed,
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// The build was successful.
|
||
|
|
/// </summary>
|
||
|
|
Successful,
|
||
|
|
}
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Defines the type of action to be taken in showing the window frame.
|
||
|
|
/// </summary>
|
||
|
|
public enum WindowFrameShowAction
|
||
|
|
{
|
||
|
|
DoNotShow,
|
||
|
|
Show,
|
||
|
|
ShowNoActivate,
|
||
|
|
Hide,
|
||
|
|
}
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Defines drop types
|
||
|
|
/// </summary>
|
||
|
|
public enum DropDataType
|
||
|
|
{
|
||
|
|
None,
|
||
|
|
Shell,
|
||
|
|
VsStg,
|
||
|
|
VsRef
|
||
|
|
}
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Used by the hierarchy node to decide which element to redraw.
|
||
|
|
/// </summary>
|
||
|
|
[Flags]
|
||
|
|
[SuppressMessage("Microsoft.Naming", "CA1714:FlagsEnumsShouldHavePluralNames")]
|
||
|
|
public enum UIHierarchyElement
|
||
|
|
{
|
||
|
|
None = 0,
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// This will be translated to VSHPROPID_IconIndex
|
||
|
|
/// </summary>
|
||
|
|
Icon = 1,
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// This will be translated to VSHPROPID_StateIconIndex
|
||
|
|
/// </summary>
|
||
|
|
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Scc")]
|
||
|
|
SccState = 2,
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// This will be translated to VSHPROPID_Caption
|
||
|
|
/// </summary>
|
||
|
|
Caption = 4,
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// This will be translated to VSHPROPID_OverlayIconIndex
|
||
|
|
/// </summary>
|
||
|
|
OverlayIcon = 8
|
||
|
|
}
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Defines the global propeties used by the msbuild project.
|
||
|
|
/// </summary>
|
||
|
|
public enum GlobalProperty
|
||
|
|
{
|
||
|
|
/// <summary>
|
||
|
|
/// Property specifying that we are building inside VS.
|
||
|
|
/// </summary>
|
||
|
|
BuildingInsideVisualStudio,
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// The VS installation directory. This is the same as the $(DevEnvDir) macro.
|
||
|
|
/// </summary>
|
||
|
|
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Env")]
|
||
|
|
DevEnvDir,
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// The name of the solution the project is created. This is the same as the $(SolutionName) macro.
|
||
|
|
/// </summary>
|
||
|
|
SolutionName,
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// The file name of the solution. This is the same as $(SolutionFileName) macro.
|
||
|
|
/// </summary>
|
||
|
|
SolutionFileName,
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// The full path of the solution. This is the same as the $(SolutionPath) macro.
|
||
|
|
/// </summary>
|
||
|
|
SolutionPath,
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// The directory of the solution. This is the same as the $(SolutionDir) macro.
|
||
|
|
/// </summary>
|
||
|
|
SolutionDir,
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// The extension of teh directory. This is the same as the $(SolutionExt) macro.
|
||
|
|
/// </summary>
|
||
|
|
SolutionExt,
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// The fxcop installation directory.
|
||
|
|
/// </summary>
|
||
|
|
FxCopDir,
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// The ResolvedNonMSBuildProjectOutputs msbuild property
|
||
|
|
/// </summary>
|
||
|
|
[SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", MessageId = "VSIDE")]
|
||
|
|
VSIDEResolvedNonMSBuildProjectOutputs,
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// The Configuartion property.
|
||
|
|
/// </summary>
|
||
|
|
Configuration,
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// The platform property.
|
||
|
|
/// </summary>
|
||
|
|
Platform,
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// The RunCodeAnalysisOnce property
|
||
|
|
/// </summary>
|
||
|
|
RunCodeAnalysisOnce,
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// The VisualStudioStyleErrors property
|
||
|
|
/// </summary>
|
||
|
|
VisualStudioStyleErrors,
|
||
|
|
}
|
||
|
|
#endregion
|
||
|
|
|
||
|
|
public class AfterProjectFileOpenedEventArgs : EventArgs
|
||
|
|
{
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
public class BeforeProjectFileClosedEventArgs : EventArgs
|
||
|
|
{
|
||
|
|
#region fields
|
||
|
|
private bool _removed;
|
||
|
|
private IVsHierarchy _hierarchy;
|
||
|
|
#endregion
|
||
|
|
|
||
|
|
#region properties
|
||
|
|
/// <summary>
|
||
|
|
/// true if the project was removed from the solution before the solution was closed. false if the project was removed from the solution while the solution was being closed.
|
||
|
|
/// </summary>
|
||
|
|
[SuppressMessage("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")]
|
||
|
|
public bool Removed
|
||
|
|
{
|
||
|
|
get { return _removed; }
|
||
|
|
}
|
||
|
|
|
||
|
|
public IVsHierarchy Hierarchy
|
||
|
|
{
|
||
|
|
get
|
||
|
|
{
|
||
|
|
return _hierarchy;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
#endregion
|
||
|
|
|
||
|
|
#region ctor
|
||
|
|
public BeforeProjectFileClosedEventArgs(IVsHierarchy hierarchy, bool removed)
|
||
|
|
{
|
||
|
|
this._removed = removed;
|
||
|
|
_hierarchy = hierarchy;
|
||
|
|
}
|
||
|
|
#endregion
|
||
|
|
}
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Argument of the event raised when a project property is changed.
|
||
|
|
/// </summary>
|
||
|
|
[SuppressMessage("Microsoft.Naming", "CA1710:IdentifiersShouldHaveCorrectSuffix")]
|
||
|
|
public class ProjectPropertyChangedArgs : EventArgs
|
||
|
|
{
|
||
|
|
private string propertyName;
|
||
|
|
private string oldValue;
|
||
|
|
private string newValue;
|
||
|
|
|
||
|
|
public ProjectPropertyChangedArgs(string propertyName, string oldValue, string newValue)
|
||
|
|
{
|
||
|
|
this.propertyName = propertyName;
|
||
|
|
this.oldValue = oldValue;
|
||
|
|
this.newValue = newValue;
|
||
|
|
}
|
||
|
|
|
||
|
|
public string NewValue
|
||
|
|
{
|
||
|
|
get { return newValue; }
|
||
|
|
}
|
||
|
|
|
||
|
|
public string OldValue
|
||
|
|
{
|
||
|
|
get { return oldValue; }
|
||
|
|
}
|
||
|
|
|
||
|
|
public string PropertyName
|
||
|
|
{
|
||
|
|
get { return propertyName; }
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// This class is used for the events raised by a HierarchyNode object.
|
||
|
|
/// </summary>
|
||
|
|
public class HierarchyNodeEventArgs : EventArgs
|
||
|
|
{
|
||
|
|
private HierarchyNode child;
|
||
|
|
|
||
|
|
public HierarchyNodeEventArgs(HierarchyNode child)
|
||
|
|
{
|
||
|
|
this.child = child;
|
||
|
|
}
|
||
|
|
|
||
|
|
public HierarchyNode Child
|
||
|
|
{
|
||
|
|
get { return this.child; }
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Event args class for triggering file change event arguments.
|
||
|
|
/// </summary>
|
||
|
|
public class FileChangedOnDiskEventArgs : EventArgs
|
||
|
|
{
|
||
|
|
#region Private fields
|
||
|
|
/// <summary>
|
||
|
|
/// File name that was changed on disk.
|
||
|
|
/// </summary>
|
||
|
|
private string fileName;
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// The item ide of the file that has changed.
|
||
|
|
/// </summary>
|
||
|
|
private uint itemID;
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// The reason the file has changed on disk.
|
||
|
|
/// </summary>
|
||
|
|
private _VSFILECHANGEFLAGS fileChangeFlag;
|
||
|
|
#endregion
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Constructs a new event args.
|
||
|
|
/// </summary>
|
||
|
|
/// <param name="fileName">File name that was changed on disk.</param>
|
||
|
|
/// <param name="id">The item id of the file that was changed on disk.</param>
|
||
|
|
public FileChangedOnDiskEventArgs(string fileName, uint id, _VSFILECHANGEFLAGS flag)
|
||
|
|
{
|
||
|
|
this.fileName = fileName;
|
||
|
|
this.itemID = id;
|
||
|
|
this.fileChangeFlag = flag;
|
||
|
|
}
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Gets the file name that was changed on disk.
|
||
|
|
/// </summary>
|
||
|
|
/// <value>The file that was changed on disk.</value>
|
||
|
|
public string FileName
|
||
|
|
{
|
||
|
|
get
|
||
|
|
{
|
||
|
|
return this.fileName;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Gets item id of the file that has changed
|
||
|
|
/// </summary>
|
||
|
|
/// <value>The file that was changed on disk.</value>
|
||
|
|
public uint ItemID
|
||
|
|
{
|
||
|
|
get
|
||
|
|
{
|
||
|
|
return this.itemID;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// The reason while the file has chnaged on disk.
|
||
|
|
/// </summary>
|
||
|
|
/// <value>The reason while the file has chnaged on disk.</value>
|
||
|
|
public _VSFILECHANGEFLAGS FileChangeFlag
|
||
|
|
{
|
||
|
|
get
|
||
|
|
{
|
||
|
|
return this.fileChangeFlag;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|