CodeFactory/src/CodeFactoryVisualStudio/CodeFactory.VisualStudio/IVsActions.cs at main · CodeFactoryLLC/CodeFactory · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
//*****************************************************************************
//* Code Factory SDK
//* Copyright (c) 2020-2023 CodeFactory, LLC
//*****************************************************************************
using System.Threading.Tasks;
using CodeFactory.DotNet.CSharp;
using CodeFactory.VisualStudio.UI;

namespace CodeFactory.VisualStudio
{
    /// <summary>
    /// Code factory commands that are globally used in Visual Studio.
    /// </summary>
    public interface IVsActions
    {

        /// <summary>
        /// Gets the most current model of the solution.
        /// </summary>
        /// <returns>The solution model.</returns>
        Task<VsSolution> GetSolutionAsync();

        /// <summary>
        /// Gets the hosting project for the <see cref="CsSource"/> model.
        /// </summary>
        /// <param name="sourceCode">The source code to get the project from.</param>
        /// <returns>The target project or null if the project is not defined for the source code.</returns>
        Task<VsProject> GetProjectFromSourceAsync(CsSource sourceCode);

        /// <summary>
        /// Gets the hosting C# source project file from for the <see cref="CsSource"/> model.
        /// </summary>
        /// <param name="sourceCode">The source code to get the C# source from.</param>
        /// <returns>The target c# source project file or null if the project is not defined for the source code.</returns>
        Task<VsCSharpSource> GetCSharpProjectFileFromSourceAsync(CsSource sourceCode);

        /// <summary>
        /// Gets the hosting C# source project file from for the <see cref="CsSource"/> model.
        /// </summary>
        /// <param name="sourceCode">The source code to get the C# source from.</param>
        /// <returns>The target project file or null if the project is not defined for the source code.</returns>
        Task<VsDocument> GetProjectFileFromSourceAsync(CsSource sourceCode);

        /// <summary>
        /// Visual Studio actions that directly interact with Visual Studio itself.
        /// </summary>
        IVsEnvironmentActions EnvironmentActions { get; }

        /// <summary>
        /// Visual Studio actions that work with the <see cref="IVsSolution"/> model.
        /// </summary>
        IVsSolutionActions SolutionActions { get;}

        /// <summary>
        /// Visual Studio actions that work with the <see cref="IVsSolutionFolder"/> model.
        /// </summary>
        IVsSolutionFolderActions SolutionFolderActions { get; }

        /// <summary>
        /// Visual Studio actions that work with the <see cref="IVsProject"/> model.
        /// </summary>
        IVsProjectActions ProjectActions { get; }

        /// <summary>
        /// Visual Studio actions that work with the <see cref="IVsReference"/> model.
        /// </summary>
        IVsReferenceActions ProjectReferenceActions { get; }

        /// <summary>
        /// Visual Studio actions that work with the <see cref="IVsProjectFolder"/> model.
        /// </summary>
        IVsProjectFolderActions ProjectFolderActions { get; }

        /// <summary>
        /// Visual Studio actions that work with the <see cref="IVsDocument"/> model.
        /// </summary>
        IVsDocumentActions DocumentActions { get; }

        /// <summary>
        /// Visual Studio actions that work the the Visual Studio user interface.
        /// </summary>
        IVsUIActions UserInterfaceActions { get; }

        /// <summary>
        /// Visual Studio actions that work with source models.
        /// </summary>
        IVsSourceActions SourceActions { get; }


    }
}