Welcome to mirror list, hosted at ThFree Co, Russian Federation.

ISolutionItemFeature.cs « MonoDevelop.Ide.Templates « MonoDevelop.Ide « core « src « main - github.com/mono/monodevelop.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: dcd4ace676b98844db173811be57b88607728a7e (plain)
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
// ISolutionItemFeature.cs
//
// Author:
//   Lluis Sanchez Gual <lluis@novell.com>
//
// Copyright (c) 2007 Novell, Inc (http://www.novell.com)
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//
//


using System;
using System.Collections.Generic;
using MonoDevelop.Projects;
using MonoDevelop.Core;
using Mono.Addins;

namespace MonoDevelop.Ide.Templates
{
	public enum FeatureSupportLevel
	{
		/// <summary>
		/// The feature is not supported
		/// </summary>
		NotSupported,
		
		/// <summary>
		/// The feature is supported and it is currently enabled for the provided solution item
		/// </summary>
		Enabled,
		
		/// <summary>
		/// The feature is supported
		/// </summary>
		Supported,
		
		/// <summary>
		/// The feature is supported and it should be shown in the default list of features for the solution item
		/// </summary>
		SupportedByDefault
	}
	
	public interface ISolutionItemFeature
	{
		/// <summary>
		/// Gets the support level of this feature for the provided project
		/// </summary>
		/// <returns>
		/// The support level.
		/// </returns>
		/// <param name='parentFolder'>
		/// The parent folder of the solution item. It may be null.
		/// </param>
		/// <param name='item'>
		/// The project being checked for the feature
		/// </param>
		/// <remarks>
		/// The provided item, parent folder and parent solution may or may not have a file name, and even if they
		/// have, they may not be saved to disk. parentFolder can be null.
		/// </remarks>
		FeatureSupportLevel GetSupportLevel (SolutionFolder parentFolder, SolutionItem item);
		
		/// <summary>
		/// Short title of the feature
		/// </summary>
		string Title { get; }
		
		/// <summary>
		/// Description of the feature (one or two sentences)
		/// </summary>
		string Description { get; }
		
		/// <summary>
		/// Creates a widget for editing the feature configuration
		/// </summary>
		/// <returns>
		/// The feature editor.
		/// </returns>
		/// <param name='parentFolder'>
		/// The parent folder of the solution item.
		/// </param>
		/// <param name='entry'>
		/// The project being checked for the feature
		/// </param>
		/// <remarks>
		/// The provided item, parent folder and parent solution may or may not have a file name, and even if they
		/// have, they may not be saved to disk.
		/// </remarks>
		Gtk.Widget CreateFeatureEditor (SolutionFolder parentFolder, SolutionItem entry);
		
		/// <summary>
		/// Validates the configuration of the feature
		/// </summary>
		/// <returns>
		/// <c>null</c> if the configuration is correct, or an error message if there is some
		/// error in the configuration parameters specified in the editor
		/// </returns>
		/// <param name='parentFolder'>
		/// The parent folder of the solution item.
		/// </param>
		/// <param name='entry'>
		/// The project being checked for the feature
		/// </param>
		/// <param name='editor'>
		/// The feature editor.
		/// </param>
		/// <remarks>
		/// This method is always called before calling ApplyFeature
		/// </remarks>
		/// <remarks>
		/// The provided item, parent folder and parent solution may or may not have a file name, and even if they
		/// have, they may not be saved to disk.
		/// </remarks>
		string Validate (SolutionFolder parentFolder, SolutionItem entry, Gtk.Widget editor);
		
		/// <summary>
		/// Applies the feature to a project
		/// </summary>
		/// <param name='parentFolder'>
		/// The parent folder of the solution item.
		/// </param>
		/// <param name='entry'>
		/// The project being checked for the feature
		/// </param>
		/// <param name='editor'>
		/// The feature editor.
		/// </param>
		/// <remarks>
		/// The provided item, parent folder and parent solution may or may not have a file name, and even if they
		/// have, they may not be saved to disk.
		/// </remarks>
		void ApplyFeature (SolutionFolder parentFolder, SolutionItem entry, Gtk.Widget editor);
	}
	
	internal class SolutionItemFeatures
	{
		public static ISolutionItemFeature[] GetFeatures (SolutionFolder parentCombine, SolutionItem entry)
		{
			List<ISolutionItemFeature> list = new List<ISolutionItemFeature> ();
			foreach (ISolutionItemFeature e in AddinManager.GetExtensionObjects ("/MonoDevelop/Ide/ProjectFeatures", typeof(ISolutionItemFeature), true)) {
				FeatureSupportLevel level = e.GetSupportLevel (parentCombine, entry);
				if (level == FeatureSupportLevel.Enabled || level == FeatureSupportLevel.SupportedByDefault)
					list.Add (e);
			}
			return list.ToArray ();
		}
	}
}