/***************************************************************************
Copyright (c) Microsoft Corporation. All rights reserved.
This code is licensed under the Visual Studio SDK license terms.
THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF
ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY
IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR
PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.
***************************************************************************/
using System;
using System.Runtime.InteropServices;
using System.Collections.Generic;
using System.IO;
using System.Windows.Forms;
using System.Diagnostics;
using System.Globalization;
using System.Text;
using System.Threading;
using Microsoft.VisualStudio.Shell;
using Microsoft.VisualStudio.Shell.Interop;
using Microsoft.VisualStudio.OLE.Interop;
using OleConstantsMicrosoft.VisualStudio.OLE.Interop.Constants;
using VsCommandsMicrosoft.VisualStudio.VSConstants.VSStd97CmdID;
using VsCommands2KMicrosoft.VisualStudio.VSConstants.VSStd2KCmdID;
using MSBuildMicrosoft.Build.BuildEngine;
using System.Diagnostics.CodeAnalysis;
namespace Microsoft.VisualStudio.Package{
/// <summary>
/// This interface defines the rules for handling build dependency on a project container.
/// </summary>
/// <remarks>Normally this should be an internal interface but since it shouldbe available for the aggregator it must be made public.</remarks>
[ComVisible(true)]
[CLSCompliant(false)]
public interface IBuildDependencyOnProjectContainer
{
/// <summary>
/// Defines whether the nested projects should be build with the parent project.
/// </summary>
bool BuildNestedProjectsOnBuild
{
get;
set;
}
/// <summary>
/// Enumerates the nested hierachies present that will participate in the build dependency update.
/// </summary>
/// <returns>A list of hierrachies.</returns>
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Hierachies")]
IVsHierarchy[] EnumNestedHierachiesForBuildDependency();
}
/// <summary>
/// Interface for manipulating build dependency
/// </summary>
/// <remarks>Normally this should be an internal interface but since it shouldbe available for the aggregator it must be made public.</remarks>
[ComVisible(true)]
[CLSCompliant(false)]
public interface IBuildDependencyUpdate
{
/// <summary>
/// Defines a container for storing BuildDependencies
/// </summary>
IVsBuildDependency[] BuildDependencies
{
get;
}
/// <summary>
/// Adds a BuildDependency to the container
/// </summary>
/// <param name="dependency">The dependency to add</param>
void AddBuildDependency(IVsBuildDependency dependency);
/// <summary>
/// Removes the builddependency from teh container.
/// </summary>
/// <param name="dependency">The dependency to add</param>
void RemoveBuildDependency(IVsBuildDependency dependency);
}
/// <summary>
/// Provides access to the reference data container.
/// </summary>
/// <remarks>Normally this should be an internal interface but since it should be available for
/// the aggregator it must be made public.</remarks>
[ComVisible(true)]
public interface IReferenceContainerProvider
{
IReferenceContainer GetReferenceContainer();
}
/// <summary>
/// Defines a container for manipulating references
/// </summary>
/// <remarks>Normally this should be an internal interface but since it should be available for
/// the aggregator it must be made public.</remarks>
[ComVisible(true)]
public interface IReferenceContainer
{
IList<ReferenceNode> EnumReferences();
ReferenceNode AddReferenceFromSelectorData(VSCOMPONENTSELECTORDATA selectorData);
void LoadReferencesFromBuildProject(MSBuild.Project buildProject);
}
/// <summary>
/// Defines the events that are internally defined for communication with other subsytems.
/// </summary>
[ComVisible(true)]
public interface IProjectEvents
{
/// <summary>
/// Event raised just after the project file opened.
/// </summary>
[SuppressMessage("Microsoft.Naming", "CA1713:EventsShouldNotHaveBeforeOrAfterPrefix")]
event EventHandler<AfterProjectFileOpenedEventArgs> AfterProjectFileOpened;
/// <summary>
/// Event raised before the project file closed.
/// </summary>
[SuppressMessage("Microsoft.Naming", "CA1713:EventsShouldNotHaveBeforeOrAfterPrefix")]
event EventHandler<BeforeProjectFileClosedEventArgs> BeforeProjectFileClosed;
}
/// <summary>
/// Defines the interface that will specify ehethrr the object is a project events listener.
/// </summary>
[ComVisible(true)]
public interface IProjectEventsListener
{
/// <summary>
/// Is the object a project events listener.
/// </summary>
/// <returns></returns>
bool IsProjectEventsListener
{ get; set; }
}
/// <summary>
/// Enable getting and setting the project events provider
/// </summary>
[ComVisible(true)]
public interface IProjectEventsProvider
{
/// <summary>
/// Defines the provider for the project events
/// </summary>
IProjectEvents ProjectEventsProvider
{
get;
set;
}
}
/// <summary>
/// Defines support for single file generator
/// </summary>
public interface ISingleFileGenerator
{
///<summary>
/// Runs the generator on the item represented by the document moniker.
/// </summary>
/// <param name="document"></param>
void RunGenerator(string document);
}
}
|